feat(cli): CcApi context provider can be configured to fail if listing does not find a specific count of resources #251

Tietew · 2025-03-19T08:27:28Z

Fixes #257

As described in the issue, CcApiContextProviderPlugin should have the way to ensure the result has exact one resource.

This PR adds the expectedMatchCount option to restrict the length of results in listResources().

Unit tests are added and modified ensure the changes.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

mrgrain

@rix0rrr this looks okay to me, but you were more involved with the original version of this

rix0rrr

I agree with you that persisting a 0-length array may make it harder to recover from problems in the future.

But I don't agree that a >=1 length array is automatically a failure. It is up the lookup method to reject >=1 element if it is expecting exactly one. It is not up to the provider to say "I will never support looking up more than one resource". For example, securitygroups associated with another resource are a perfectly legit resource to look up.

For your issue:

It is the job of PrefixList.fromLookup() to handle the >=1 case.
As for the 0 results case: we can fail the provider, that's an easy way of making sure that the 0-length array is not persisted. To achieve that, we should add an additional field into the query that indicates that a 0-element list should be considered an error.

packages/aws-cdk/test/context-providers/cc-api-provider.test.ts

Tietew · 2025-03-21T04:16:20Z

@rix0rrr Thank you for clarification.

I've pushed following updates:

reverted the test I changed
added allowEmptyResult and exactResult options to CcApiContextQuery (requires to bump schema version)
updated tests to ensure above options

Current PRs using CC API Context Provider, except for my PrefixList, use exactIdentifier and is not affected by this change.
For my PrefixList.fromLookup(), specifying exactResult: true could ensure to expect 1 resources.

packages/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/context-queries.ts

codecov-commenter · 2025-03-22T12:27:38Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.40%. Comparing base (cd35a1c) to head (76bc207).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #251      +/-   ##
==========================================
+ Coverage   85.24%   85.40%   +0.15%     
==========================================
  Files         222      222              
  Lines       36898    36926      +28     
  Branches     4438     4454      +16     
==========================================
+ Hits        31455    31535      +80     
+ Misses       5348     5296      -52     
  Partials       95       95

Flag	Coverage Δ
suite.unit	`85.40% <100.00%> (+0.15%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

rix0rrr · 2025-03-24T12:57:44Z

I'm going to wait for #211 to be in, then refactor this PR a bit on top of that other one.

They're too uncomfortably close for me so I'm taking the reins to make them play nicely together.

Tietew · 2025-03-25T01:45:32Z

Ok, thanks for adjustment!

…g does not find a specific count of resources (#251) Fixes #257 As described in the issue, `CcApiContextProviderPlugin` should have the way to ensure the result has exact one resource. This PR adds the `expectedMatchCount` option to restrict the length of results in `listResources()`. Unit tests are added and modified ensure the changes. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license --------- Co-authored-by: Rico Huijbers <[email protected]>

…m CcApi context provider has exactly one resource (#34199) ### Issue # (if applicable) Follow-up to #33619. ### Reason for this change CcApi context provider now can expect the matched count of resources: aws/aws-cdk-cli#251. `PrefixList.fromLookup()` is needed to be updated using this feature not to persist invalid results in `cdk.context.json`. See also aws/aws-cdk-cli#257. ### Description of changes - Bumped `@aws-cdk/cloud-assembly-schema` to latest ^43.6.0. - Specify `expectedMatchCount: 'exactly-one'` to expect exactly one prefix list id is returned. - Updated validation to check unexpected result. Actual error will be returned from the context provider. ### Describe any new or updated permissions being added N/A ### Description of how you validated changes Updated integ tests. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

…m CcApi context provider has exactly one resource (#34565) Re-creation of #34199 A jsii related issue #34199 (comment) should be fixed before merging this PR. ### Issue # (if applicable) Follow-up to #33619. ### Reason for this change CcApi context provider now can expect the matched count of resources: aws/aws-cdk-cli#251. `PrefixList.fromLookup()` is needed to be updated using this feature not to persist invalid results in `cdk.context.json`. See also aws/aws-cdk-cli#257. ### Description of changes - Bumped `@aws-cdk/cloud-assembly-schema` to latest ^44.1.0. - Specify `expectedMatchCount: 'exactly-one'` to expect exactly one prefix list id is returned. - Updated validation to check unexpected result. Actual error will be returned from the context provider. ### Describe any new or updated permissions being added N/A ### Description of how you validated changes Updated integ tests. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

ensure exact one result in listResources

1d57e28

Tietew had a problem deploying to integ-approval March 19, 2025 08:27 — with GitHub Actions Failure

github-actions bot added the p2 label Mar 19, 2025

aws-cdk-automation enabled auto-merge March 19, 2025 08:27

Tietew mentioned this pull request Mar 19, 2025

feat(ec2): support PrefixList.fromLookup() aws/aws-cdk#33619

Merged

1 task

aws-cdk-automation requested a review from a team March 19, 2025 08:28

throw ConttextProviderError

20ac19f

auto-merge was automatically disabled March 19, 2025 12:11
Head branch was pushed to by a user without write access

Tietew had a problem deploying to integ-approval March 19, 2025 12:11 — with GitHub Actions Failure

pahud mentioned this pull request Mar 19, 2025

contextprovider: CC API context provider should have the way to ensure the result has exact one value #257

Closed

1 task

mrgrain reviewed Mar 19, 2025

View reviewed changes

rix0rrr requested changes Mar 19, 2025

View reviewed changes

rix0rrr reviewed Mar 19, 2025

View reviewed changes

packages/aws-cdk/test/context-providers/cc-api-provider.test.ts Outdated Show resolved Hide resolved

Tietew added 2 commits March 21, 2025 13:05

options to restrict results

9a4ca37

Merge branch 'main' into cc-api-single-result

fcdc9bd

Tietew had a problem deploying to integ-approval March 21, 2025 04:06 — with GitHub Actions Failure

Tietew changed the title ~~fix(cli): ensure exact one result in CcApiContextProviderPlugin~~ fix(cli): no way to ensure exact one result in CcApiContextProviderPlugin Mar 21, 2025

github-actions bot added the bug label Mar 21, 2025

rix0rrr requested changes Mar 22, 2025

View reviewed changes

packages/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/context-queries.ts Outdated Show resolved Hide resolved

Tietew added 2 commits March 23, 2025 01:05

Merge branch 'main' into cc-api-single-result

b3142ba

expectedMatchCount

636cdec

Tietew had a problem deploying to integ-approval March 22, 2025 16:06 — with GitHub Actions Failure

fix docstrings

089dc6a

Tietew had a problem deploying to integ-approval March 24, 2025 01:58 — with GitHub Actions Failure

Tietew requested a review from rix0rrr March 24, 2025 08:41

Merge remote-tracking branch 'origin/main' into pr/Tietew/251

e191783

rix0rrr temporarily deployed to run-tests March 27, 2025 13:56 — with GitHub Actions Inactive

rix0rrr added 2 commits April 1, 2025 12:01

Merge remote-tracking branch 'origin/main' into pr/Tietew/251

9647211

Update build packages

76bc207

rix0rrr temporarily deployed to integ-approval April 1, 2025 12:10 — with GitHub Actions Inactive

rix0rrr temporarily deployed to run-tests April 1, 2025 12:22 — with GitHub Actions Inactive

rix0rrr added this pull request to the merge queue Apr 1, 2025

Merged via the queue into aws:main with commit a1d5af9 Apr 1, 2025
20 checks passed

Tietew deleted the cc-api-single-result branch April 2, 2025 02:01

Tietew mentioned this pull request Apr 18, 2025

chore(ec2): update PrefixList.fromLookup() to expect the result from CcApi context provider has exactly one resource aws/aws-cdk#34199

Merged

1 task

Tietew mentioned this pull request May 28, 2025

chore(ec2): update PrefixList.fromLookup() to expect the result from CcApi context provider has exactly one resource aws/aws-cdk#34565

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(cli): CcApi context provider can be configured to fail if listing does not find a specific count of resources #251

feat(cli): CcApi context provider can be configured to fail if listing does not find a specific count of resources #251

Uh oh!

Tietew commented Mar 19, 2025 •

edited

Loading

Uh oh!

mrgrain left a comment

Uh oh!

rix0rrr left a comment

Uh oh!

Uh oh!

Tietew commented Mar 21, 2025 •

edited

Loading

Uh oh!

Uh oh!

codecov-commenter commented Mar 22, 2025 •

edited

Loading

Uh oh!

rix0rrr commented Mar 24, 2025

Uh oh!

Tietew commented Mar 25, 2025

Uh oh!

Uh oh!

Uh oh!

feat(cli): CcApi context provider can be configured to fail if listing does not find a specific count of resources #251

feat(cli): CcApi context provider can be configured to fail if listing does not find a specific count of resources #251

Uh oh!

Conversation

Tietew commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mrgrain left a comment

Choose a reason for hiding this comment

Uh oh!

rix0rrr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Tietew commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Mar 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

rix0rrr commented Mar 24, 2025

Uh oh!

Tietew commented Mar 25, 2025

Uh oh!

Uh oh!

Uh oh!

Tietew commented Mar 19, 2025 •

edited

Loading

Tietew commented Mar 21, 2025 •

edited

Loading

codecov-commenter commented Mar 22, 2025 •

edited

Loading