Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce locked versions for top-level resources #634

Merged
merged 2 commits into from
Mar 5, 2021
Merged

Introduce locked versions for top-level resources #634

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d159367
Introduce locked versions for top-level resources
mikhailshilkov Mar 5, 2021
3e1d1e6
Wording
mikhailshilkov Mar 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion provider/pkg/openapi/versioner.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,21 @@ func newVersioner() (*versioner, error) {
return &versioner{lookup: result}, nil
}

// A manually-maintained list of stable versions where we want to promote a later preview version to be used for
// A manually-maintained list of stable versions that we want to promote a later preview version to be used for
// the top-level resource. These versions are "known" to be outdated but no newer stable versions were released yet.
// However, there's no formal way to derive this from Open API specs, so we have to maintain this manual map.
var deprecatedProviderVersions = map[string][]string{
"Authorization": {"v20150701"},
"Sql": {"v20140401", "v20150501"},
}

// A manually-maintained list of versions where we want to use for the top-level resource. The primary goal is to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// A manually-maintained list of versions where we want to use for the top-level resource. The primary goal is to
// A manually-maintained list of versions that we want to use for the top-level resource. The primary goal is to

// avoid breaking changes within a single major version of the provider that could come with new API versions.
// We reset this map every time we release a new major version (or a new 0.x minor version).
// Currently populated for 0.7.* series.
var lockedTypeVersions = map[string]string{
}

// calculateLatestVersions builds a map of latest versions per API paths from a map of all versions of a resource
// provider. The result is a map from a resource type name to resource specs.
func (c *versioner) calculateLatestVersions(provider string, versionMap ProviderVersions, invokes,
Expand Down Expand Up @@ -113,6 +120,11 @@ func (c *versioner) calculateLatestVersions(provider string, versionMap Provider
}

for typeName, r := range res {
if lockedVersion, ok := lockedTypeVersions[typeName]; ok && lockedVersion != version {
// If we have a locked version for this resource, ignore all other versions.
continue
}

normalizedPath := normalizePath(r.Path)
isKnown := c.isKnown(provider, r.Path, version)
if !isKnown && knownResources.Has(normalizedPath) {
Expand Down