Add information for cross-major-version aliases #3881

danielrbradley · 2025-01-23T12:28:10Z

Track where each definition (resource or invoke) has come from (source path).
Track the resource URI in the default versions file so we can compare between major versions where a rename has happened and add an alias.
Track the Azure resource provider namespace and use it when checking if a RP version is active rather than using the module name which might not align to the RP name (and might not be prefixed Microsoft.).

github-actions · 2025-01-23T12:33:09Z

Does the PR have any schema changes?

Looking good! No breaking changes found.

New resources:

network.DnssecConfig
network.NetworkVirtualApplianceConnection

New functions:

network.getDnssecConfig
network.getNetworkVirtualApplianceConnection

thomas11

Looks like a great improvement. Especially v2.yaml!

Only suggestion in addition to the comments: there are a lot of new map accesses without an , ok guard. Also one slice[0] without length check. Even if the existence of these elements is an invariant, I'd feel better about checking and asserting the invariant instead of failing in hard-to-debug ways later.

provider/pkg/openapi/discover.go

thomas11 · 2025-01-23T14:16:57Z

provider/pkg/openapi/discover.go

@@ -191,13 +191,31 @@ func NewVersionResources() VersionResources {

 type ModuleVersionList = map[ModuleName][]ApiVersion

+// Can only by "Resource" or "Invoke"
+type DefinitionType string


I'm not loving the name "definition" yet because the spec also has type definitions but these are not represented here. Don't have a better idea ATM though.

Endpoint? URI? Maybe it's just a Resource, but invokes are like read-only resources?

provider/pkg/providerlist/providerlist.go

provider/pkg/versioning/defaultVersion.go

thomas11

I'd still recommend some checks when accessing maps but otherwise LGTM

provider/pkg/util/data_structures.go

codecov · 2025-01-24T12:13:04Z

Codecov Report

Attention: Patch coverage is 64.08451% with 51 lines in your changes missing coverage. Please review.

Project coverage is 57.26%. Comparing base (86f5987) to head (5e22fa1).
Report is 14 commits behind head on master.

Files with missing lines	Patch %	Lines
provider/pkg/versioning/defaultVersion.go	76.78%	8 Missing and 5 partials ⚠️
provider/pkg/versioning/specs.go	13.33%	13 Missing ⚠️
provider/pkg/openapi/discover.go	45.45%	10 Missing and 2 partials ⚠️
provider/pkg/versioning/build_schema.go	0.00%	8 Missing ⚠️
provider/pkg/gen/examples.go	71.42%	2 Missing ⚠️
provider/pkg/pcl/pcl.go	0.00%	2 Missing ⚠️
provider/pkg/squeeze/squeeze.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3881      +/-   ##
==========================================
- Coverage   57.38%   57.26%   -0.13%     
==========================================
  Files          79       78       -1     
  Lines       12456    12438      -18     
==========================================
- Hits         7148     7122      -26     
- Misses       4765     4769       +4     
- Partials      543      547       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Instead of mapping to the version string, map to a struct containing the version as well as provenance information.

- Replace the list of resource names (which could also be invoke names) to a map of definition names to the definition's source information. - Change all existing slice iterations with iterating over the sorted keys from the map. - Fix bug where we added empty versions for versions without any definitions. Instead, skip versions with no definitions found.

- Use the original Azure resource provider namespace rather that our adjusted module names which might not match. Add Rp namespace to unit tests This field is now required for active version checking. It's always populated during a real run so we need to add it to tests which hit this path.

DnssecConfig "2018-05-01" and NetworkVirtualApplianceConnection "2023-02-01" don't exist any more, so pick the next closest version that still exists.

- Validate the requested spec additions actually exist. - Avoid duplicating structs and just assign the whole object. Remove unused DefinitionType

- This should never happen in reality, but better to be safe. - Update tests to include resources and the field accessed in the code.

- Use preview-aware sorting. - Pass sets around instead of converting to and from arrays.

- Remove unused `collections.OrderedKeys`. - Utilise `UnsortedKeys` in `SortedKeys`. - Add new `MapOrdered` function to returns an iterator with both the key and value so we can reduce some noise.

- Add a few extra map existence checks too.

- Use util.MapOrdered where possible, or otherwise util.SortedKeys which is generic.

- Add unit test to catch this faster next time.

pulumi-bot · 2025-01-30T12:16:01Z

This PR has been shipped in release v2.85.0.

danielrbradley self-assigned this Jan 23, 2025

danielrbradley force-pushed the default-version-context branch from 67dd6b3 to cb4bfaf Compare January 23, 2025 12:41

danielrbradley marked this pull request as ready for review January 23, 2025 12:44

danielrbradley requested a review from thomas11 January 23, 2025 12:45

danielrbradley temporarily deployed to env-ci January 23, 2025 13:23 — with GitHub Actions Inactive

danielrbradley had a problem deploying to env-ci January 23, 2025 13:23 — with GitHub Actions Failure

danielrbradley temporarily deployed to env-ci January 23, 2025 13:23 — with GitHub Actions Inactive

thomas11 reviewed Jan 23, 2025

View reviewed changes

danielrbradley requested a review from thomas11 January 23, 2025 16:51

danielrbradley temporarily deployed to env-ci January 23, 2025 17:10 — with GitHub Actions Inactive

danielrbradley had a problem deploying to env-ci January 23, 2025 17:10 — with GitHub Actions Failure

danielrbradley temporarily deployed to env-ci January 23, 2025 17:10 — with GitHub Actions Inactive

thomas11 approved these changes Jan 23, 2025

View reviewed changes

provider/pkg/util/data_structures.go Show resolved Hide resolved

danielrbradley force-pushed the default-version-context branch from 5f58886 to 60136e6 Compare January 24, 2025 10:12

danielrbradley enabled auto-merge January 24, 2025 10:13

danielrbradley force-pushed the default-version-context branch from 60136e6 to cb8ffeb Compare January 24, 2025 10:58

danielrbradley temporarily deployed to env-ci January 24, 2025 11:20 — with GitHub Actions Inactive

danielrbradley had a problem deploying to env-ci January 24, 2025 11:20 — with GitHub Actions Failure

danielrbradley temporarily deployed to env-ci January 24, 2025 11:20 — with GitHub Actions Inactive

danielrbradley force-pushed the default-version-context branch from cb8ffeb to 252c003 Compare January 24, 2025 11:59

danielrbradley temporarily deployed to env-ci January 24, 2025 12:20 — with GitHub Actions Inactive

danielrbradley had a problem deploying to env-ci January 24, 2025 12:20 — with GitHub Actions Failure

danielrbradley temporarily deployed to env-ci January 24, 2025 12:20 — with GitHub Actions Inactive

danielrbradley added 13 commits January 24, 2025 12:39

Re-copy the default versions if the schema is re-generated

032224a

Add fields to default version entries

db413a2

Instead of mapping to the version string, map to a struct containing the version as well as provenance information.

Fix missing addition resource versions

240b65e

DnssecConfig "2018-05-01" and NetworkVirtualApplianceConnection "2023-02-01" don't exist any more, so pick the next closest version that still exists.

Remove unused fields

5da5975

- Validate the requested spec additions actually exist. - Avoid duplicating structs and just assign the whole object. Remove unused DefinitionType

Check definitions length before access

763d812

- This should never happen in reality, but better to be safe. - Update tests to include resources and the field accessed in the code.

Sort ApiVersions semantically

456ea4c

- Use preview-aware sorting. - Pass sets around instead of converting to and from arrays.

Tidy up collections utils

ac8839b

- Remove unused `collections.OrderedKeys`. - Utilise `UnsortedKeys` in `SortedKeys`. - Add new `MapOrdered` function to returns an iterator with both the key and value so we can reduce some noise.

Use ordered map iterator

2dd1263

- Add a few extra map existence checks too.

Replace codegen.SortedKeys

7ba2149

- Use util.MapOrdered where possible, or otherwise util.SortedKeys which is generic.

Remove local keys helper

4259363

Fix parsing of versionLookup

5e22fa1

- Add unit test to catch this faster next time.

danielrbradley force-pushed the default-version-context branch from 252c003 to 5e22fa1 Compare January 24, 2025 13:36

danielrbradley temporarily deployed to env-ci January 24, 2025 13:57 — with GitHub Actions Inactive

danielrbradley merged commit 58661c2 into master Jan 24, 2025
23 checks passed

danielrbradley deleted the default-version-context branch January 24, 2025 14:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add information for cross-major-version aliases #3881

Add information for cross-major-version aliases #3881

danielrbradley commented Jan 23, 2025 •

edited

Loading

github-actions bot commented Jan 23, 2025 •

edited

Loading

thomas11 left a comment

thomas11 Jan 23, 2025

danielrbradley Jan 23, 2025

thomas11 left a comment

codecov bot commented Jan 24, 2025 •

edited

Loading

pulumi-bot commented Jan 30, 2025

Add information for cross-major-version aliases #3881

Add information for cross-major-version aliases #3881

Conversation

danielrbradley commented Jan 23, 2025 • edited Loading

github-actions bot commented Jan 23, 2025 • edited Loading

Does the PR have any schema changes?

New resources:

New functions:

thomas11 left a comment

Choose a reason for hiding this comment

thomas11 Jan 23, 2025

Choose a reason for hiding this comment

danielrbradley Jan 23, 2025

Choose a reason for hiding this comment

thomas11 left a comment

Choose a reason for hiding this comment

codecov bot commented Jan 24, 2025 • edited Loading

Codecov Report

pulumi-bot commented Jan 30, 2025

danielrbradley commented Jan 23, 2025 •

edited

Loading

github-actions bot commented Jan 23, 2025 •

edited

Loading

codecov bot commented Jan 24, 2025 •

edited

Loading