Skip to content

Commit

Permalink
chore: remove returned versions from collator.Collate
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jgresty committed Apr 26, 2024
1 parent 8b7e951 commit e0120cf
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 20 deletions.
10 changes: 5 additions & 5 deletions vervet-underground/internal/storage/collator.go
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ func (c *Collator) Add(service string, revision ContentRevision) {
}

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

Expand All @@ -120,23 +120,23 @@ func (c *Collator) Collate() (vervet.VersionSlice, map[vervet.Version]openapi3.T
if err != nil {
log.Error().Err(err).Msgf("could not merge revision for version %s", version)
collatorMergeError.WithLabelValues(version.String()).Inc()
return nil, nil, err
return nil, err
}
if err := vervet.RemoveElements(spec, c.excludePatterns); err != nil {
log.Error().Err(err).Msgf("could not merge revision for version %s", version)
collatorMergeError.WithLabelValues(version.String()).Inc()
return nil, nil, err
return nil, err
}
if err := c.applyOverlay(spec); err != nil {
log.Error().Err(err).Msgf("failed to merge overlay for version %s", version)
collatorMergeError.WithLabelValues(version.String()).Inc()
return nil, nil, err
return nil, err
}
specs[version] = *spec
}
}

return c.uniqueVersions, specs, nil
return specs, nil
}

func mergeRevisions(revisions ContentRevisions) (*openapi3.T, error) {
Expand Down
17 changes: 5 additions & 12 deletions vervet-underground/internal/storage/collator_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,8 @@ func TestCollator_Collate(t *testing.T) {
Blob: []byte(serviceBSpec),
})

versions, specs, err := collator.Collate()
specs, err := collator.Collate()
c.Assert(err, qt.IsNil)
c.Assert(len(versions), qt.Equals, 3)
c.Assert(versions[0], qt.Equals, v20220201_beta)
c.Assert(versions[1], qt.Equals, v20220301_ga)
c.Assert(versions[2], qt.Equals, v20220401_ga)

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

versions, specs, err := collator.Collate()
specs, err := collator.Collate()
c.Assert(err, qt.IsNil)
c.Assert(len(versions), qt.Equals, 2)
c.Assert(versions[0], qt.Equals, v20220201_exp)
c.Assert(versions[1], qt.Equals, v20230314_exp)

c.Assert(specs[v20220201_exp].Paths.Find("/test"), qt.IsNotNil)
c.Assert(specs[v20230314_exp].Paths.Find("/test"), qt.IsNotNil)
Expand Down Expand Up @@ -222,7 +215,7 @@ func TestCollator_Collate_ExcludePatterns(t *testing.T) {
Version: v20220401_ga,
Blob: []byte(serviceBSpec),
})
_, specs, err := collator.Collate()
specs, err := collator.Collate()
c.Assert(err, qt.IsNil)

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

_, specs, err := collator.Collate()
specs, err := collator.Collate()
c.Assert(err, qt.IsNil)
// First path wins
c.Assert(specs[vervet.MustParseVersion("2021-06-15")].Paths["/examples/hello-world"].Post.Description,
Expand Down Expand Up @@ -304,7 +297,7 @@ func TestCollator_Collate_Overlay(t *testing.T) {
Version: v20220401_ga,
Blob: []byte(serviceBSpec),
})
_, specs, err := collator.Collate()
specs, err := collator.Collate()
c.Assert(err, qt.IsNil)

c.Assert(specs[v20220401_ga].Servers[0].URL, qt.Equals, "https://awesome.snyk.io/rest")
Expand Down
2 changes: 1 addition & 1 deletion vervet-underground/internal/storage/disk/disk.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ func (s *Storage) CollateVersions(ctx context.Context, serviceFilter map[string]
}
aggregate.Add(service, revision)
}
_, specs, err := aggregate.Collate()
specs, err := aggregate.Collate()
if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion vervet-underground/internal/storage/gcs/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ func (s *Storage) CollateVersions(ctx context.Context, serviceFilter map[string]
}
aggregate.Add(service, revision)
}
_, specs, err := aggregate.Collate()
specs, err := aggregate.Collate()
if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion vervet-underground/internal/storage/s3/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ func (s *Storage) CollateVersions(ctx context.Context, serviceFilter map[string]
}
aggregate.Add(service, revision)
}
_, specs, err := aggregate.Collate()
specs, err := aggregate.Collate()
if err != nil {
return err
}
Expand Down

0 comments on commit e0120cf

Please sign in to comment.