Skip to content

Commit e0120cf

Browse files
committed
chore: remove returned versions from collator.Collate
Nothing was using the returned value so there is no point returning it. Makes the surface area a bit smaller so it is easier to reason about.
1 parent 8b7e951 commit e0120cf

File tree

5 files changed

+13
-20
lines changed

5 files changed

+13
-20
lines changed

vervet-underground/internal/storage/collator.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ func (c *Collator) Add(service string, revision ContentRevision) {
9898
}
9999

100100
// Collate processes added service revisions to collate unified versions and OpenAPI specs for each version.
101-
func (c *Collator) Collate() (vervet.VersionSlice, map[vervet.Version]openapi3.T, error) {
101+
func (c *Collator) Collate() (map[vervet.Version]openapi3.T, error) {
102102
specs := make(map[vervet.Version]openapi3.T)
103103
sort.Sort(c.uniqueVersions)
104104

@@ -120,23 +120,23 @@ func (c *Collator) Collate() (vervet.VersionSlice, map[vervet.Version]openapi3.T
120120
if err != nil {
121121
log.Error().Err(err).Msgf("could not merge revision for version %s", version)
122122
collatorMergeError.WithLabelValues(version.String()).Inc()
123-
return nil, nil, err
123+
return nil, err
124124
}
125125
if err := vervet.RemoveElements(spec, c.excludePatterns); err != nil {
126126
log.Error().Err(err).Msgf("could not merge revision for version %s", version)
127127
collatorMergeError.WithLabelValues(version.String()).Inc()
128-
return nil, nil, err
128+
return nil, err
129129
}
130130
if err := c.applyOverlay(spec); err != nil {
131131
log.Error().Err(err).Msgf("failed to merge overlay for version %s", version)
132132
collatorMergeError.WithLabelValues(version.String()).Inc()
133-
return nil, nil, err
133+
return nil, err
134134
}
135135
specs[version] = *spec
136136
}
137137
}
138138

139-
return c.uniqueVersions, specs, nil
139+
return specs, nil
140140
}
141141

142142
func mergeRevisions(revisions ContentRevisions) (*openapi3.T, error) {

vervet-underground/internal/storage/collator_test.go

+5-12
Original file line numberDiff line numberDiff line change
@@ -137,12 +137,8 @@ func TestCollator_Collate(t *testing.T) {
137137
Blob: []byte(serviceBSpec),
138138
})
139139

140-
versions, specs, err := collator.Collate()
140+
specs, err := collator.Collate()
141141
c.Assert(err, qt.IsNil)
142-
c.Assert(len(versions), qt.Equals, 3)
143-
c.Assert(versions[0], qt.Equals, v20220201_beta)
144-
c.Assert(versions[1], qt.Equals, v20220301_ga)
145-
c.Assert(versions[2], qt.Equals, v20220401_ga)
146142

147143
c.Assert(specs[v20220201_beta].Paths.Find("/test"), qt.IsNotNil)
148144
c.Assert(specs[v20220201_beta].Paths.Find("/example"), qt.IsNil)
@@ -181,11 +177,8 @@ func TestCollator_Collate_MigratingEndpoints(t *testing.T) {
181177
Blob: []byte(serviceCSpec),
182178
})
183179

184-
versions, specs, err := collator.Collate()
180+
specs, err := collator.Collate()
185181
c.Assert(err, qt.IsNil)
186-
c.Assert(len(versions), qt.Equals, 2)
187-
c.Assert(versions[0], qt.Equals, v20220201_exp)
188-
c.Assert(versions[1], qt.Equals, v20230314_exp)
189182

190183
c.Assert(specs[v20220201_exp].Paths.Find("/test"), qt.IsNotNil)
191184
c.Assert(specs[v20230314_exp].Paths.Find("/test"), qt.IsNotNil)
@@ -222,7 +215,7 @@ func TestCollator_Collate_ExcludePatterns(t *testing.T) {
222215
Version: v20220401_ga,
223216
Blob: []byte(serviceBSpec),
224217
})
225-
_, specs, err := collator.Collate()
218+
specs, err := collator.Collate()
226219
c.Assert(err, qt.IsNil)
227220

228221
c.Assert(specs[v20220401_ga].Paths["/example"].Post.Extensions["x-other-internal"], qt.IsNil)
@@ -256,7 +249,7 @@ func TestCollator_Collate_Conflict(t *testing.T) {
256249
Timestamp: time.Date(2021, 6, 15, 0, 0, 0, 0, time.UTC),
257250
})
258251

259-
_, specs, err := collator.Collate()
252+
specs, err := collator.Collate()
260253
c.Assert(err, qt.IsNil)
261254
// First path wins
262255
c.Assert(specs[vervet.MustParseVersion("2021-06-15")].Paths["/examples/hello-world"].Post.Description,
@@ -304,7 +297,7 @@ func TestCollator_Collate_Overlay(t *testing.T) {
304297
Version: v20220401_ga,
305298
Blob: []byte(serviceBSpec),
306299
})
307-
_, specs, err := collator.Collate()
300+
specs, err := collator.Collate()
308301
c.Assert(err, qt.IsNil)
309302

310303
c.Assert(specs[v20220401_ga].Servers[0].URL, qt.Equals, "https://awesome.snyk.io/rest")

vervet-underground/internal/storage/disk/disk.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ func (s *Storage) CollateVersions(ctx context.Context, serviceFilter map[string]
115115
}
116116
aggregate.Add(service, revision)
117117
}
118-
_, specs, err := aggregate.Collate()
118+
specs, err := aggregate.Collate()
119119
if err != nil {
120120
return err
121121
}

vervet-underground/internal/storage/gcs/client.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ func (s *Storage) CollateVersions(ctx context.Context, serviceFilter map[string]
156156
}
157157
aggregate.Add(service, revision)
158158
}
159-
_, specs, err := aggregate.Collate()
159+
specs, err := aggregate.Collate()
160160
if err != nil {
161161
return err
162162
}

vervet-underground/internal/storage/s3/client.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ func (s *Storage) CollateVersions(ctx context.Context, serviceFilter map[string]
269269
}
270270
aggregate.Add(service, revision)
271271
}
272-
_, specs, err := aggregate.Collate()
272+
specs, err := aggregate.Collate()
273273
if err != nil {
274274
return err
275275
}

0 commit comments

Comments
 (0)