feat(ecr): allow fromLookup method to return dummy repository without error if target repository was not found

[go-to-k]

Issue # (if applicable)

Closes #34031

Reason for this change

The fromLookup method causes an error if the target repository was not found. However it would be also good not to cause an error and to return dummy value in that case.

Now, with the PR merged in aws-cdk-cli ([email protected]), we can ignore errors and return dummy value with mustExist option in CC API Provider.

Description of changes

• Added the mustExist option in RepositoryLookupOptions.
  • Pass it to mustExist for ContextProvider.getValue
• Added the static isLookupDummy method to check whether the repository is dummy.

ref PR:

• feat(kms): allow fromLookup method to return dummy key if target key was not found #31676
  • This uses key provider not cc-api provider, but the PR includes the isLookupDummy method.
• feat(iam): support Role.fromLookup() method #33603
  • This lookup method uses cc-api provider and includes the isLookupDummy method too.
  • I decided not to introduce the method yet in this PR.

Describe any new or updated permissions being added

Description of how you validated changes

Both unit and integ tests.

Checklist

• My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

---

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.98%. Comparing base (0923b5e) to head (74d3939).
Report is 13 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #34030   +/-   ##
=======================================
  Coverage   83.98%   83.98%           
=======================================
  Files         120      120           
  Lines        6976     6976           
  Branches     1178     1178           
=======================================
  Hits         5859     5859           
  Misses       1005     1005           
  Partials      112      112           

Flag	Coverage Δ
suite.unit	83.98% <ø> (ø)

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

Components	Coverage Δ
packages/aws-cdk	∅ <ø> (∅)
packages/aws-cdk-lib/core	83.98% <ø> (ø)

🚀 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.

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 74d3939
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[rix0rrr]

(my concerns are summarized below)

[rix0rrr]

I think I'd rather have a new lookup function that returns IRepository | undefined.

---

That new lookup function would also be a perfect place to attach disclaimers that I'm 99% sure most users will not expect, such as:

• The result of this lookup is cached in context at the time of synth. Therefore:
  • You must have access to all environments you want to deploy this to at synth time
  • The lookup does not run at deploy time, so if the repository gets created/deleted between synth time and deploy time, the behavior will be not what you expect.
  • After one successful synth, if a user regrets the decision and want to change it (i.e., externally delete/create the resource), the user has clear the context entry before trying again.

I'm sure there's more that I can't think of right now.

Are we 100% confident offering this feature will lead to a good user experience? Because I'm concerned it will end up being a footgun.

[go-to-k]

Hmmm... You have a point, maybe we can't be 100% sure...
I'll drop this PR for now. If I get another good idea I might reopen it.

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.