fix(cli): release outdir lock when synth fails

[misterjoshua]

Issue # (if applicable)

Closes #27864

Reason for this change

When using cdk watch mode, a synth failure causes the CDK CLI to no longer deploy changes. The CDK CLI must be restarted to resume watch mode. The cause of the issue is that CDK CLI never releases the outdir write lock if synthing fails, so subsequent attempts to exec the user's app cannot acquire the outdir writer lock.

Description of changes

I added a try/catch that releases the outdir writer lock & rethrows the error when a synth fails.

Description of how you validated changes

I added a unit test. I also ran the modified cdk cli on a project of my own and simulated the failure of a synth to see whether the issue was resolved, and it is.

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

[aws-cdk-automation]

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

[scanlonp]

This makes good sense. Let me know when it's ready for review, and we can run it through the pipeline.

[misterjoshua]

@scanlonp Thanks for checking in. I've marked it ready now. I'll keep an eye out for feedback. TY

[scanlonp]

Can look at our testing for cdk watch, but not sure we have the infrastructure for integ testing this type of change. Going to put the integ test exempt label for now.

I can also pull this down and test it out; I assume this fixed watch hanging on your side @misterjoshua?

[misterjoshua]

@scanlonp

Can look at our testing for cdk watch, but not sure we have the infrastructure for integ testing this type of change. Going to put the integ test exempt label for now.

Sounds good. I wasn't sure about that part and had been asking around. 😂

I can also pull this down and test it out; I assume this fixed watch hanging on your side @misterjoshua?

Yep. Works great for me!

[scanlonp]

@Mergifyio update

[mergify]

update

❌ Mergify doesn't have permission to update

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/close-stale-prs.yml without workflows permission

[aws-cdk-automation]

➡️ PR build request submitted to test-main-pipeline ⬅️

A maintainer must now check the pipeline and add the pr-linter/cli-integ-tested label once the pipeline succeeds.

[scanlonp]

Worked clean in the pipeline. Adding labels.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

[misterjoshua]

@scanlonp Hey. Do I need to do anything with the code to move this PR forward? I saw that the CodeQL action failed, but its failure appears to be an out-of-space condition not necessarily related to this change.

[scanlonp]

Hey @misterjoshua, I think the code is in a good spot. I want to test this out myself just to double check (even though I 100% believe your local testing results!). I'll make it a goal to have it in by the next release.

Also I believe the CodeQL is not concerning for this PR. We have been seeing that out-of-space failure consistently.

[misterjoshua]

@scanlonp

Hey @misterjoshua, I think the code is in a good spot. I want to test this out myself just to double check (even though I 100% believe your local testing results!). I'll make it a goal to have it in by the next release.

Hey Parker. Sorry to bug, but how likely do you see this PR making it into the next release? Thanks.

[aws-cdk-automation]

AWS CodeBuild CI Report

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

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

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

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