(aws-apigateway): race condition between Stage and CfnAccount on SpecRestApi #18925
Description
What is the problem?
When cloudWatchRole is enabled, a CfnAccount is created for it. Since there is no explicit dependency between the the stages and the account, CloudFormation may deploy them in the wrong order, causing the deployment to fail.
Add an explicit dependency between Stages (whether defined by the user or created automatically) and the CloudWatch CfnAccount, if it exists.
This PR solved it for the RestApi #18011 but not entirely for the SpecRestApi.
Currently when we instantiate a SpecRestApi the class will first create the Deployment and the Stage
aws-cdk/packages/@aws-cdk/aws-apigateway/lib/restapi.ts
Lines 651 to 660 in 5dd8e50
then attach the Stage to the API
aws-cdk/packages/@aws-cdk/aws-apigateway/lib/restapi.ts
Lines 560 to 565 in 5dd8e50
The problem is that when calling the _attachStage the cloudwatchAccount does not exist yet, so it does not create the dependency between each other (as in RestApi)
aws-cdk/packages/@aws-cdk/aws-apigateway/lib/stage.ts
Lines 258 to 263 in 5dd8e50
If my understanding is correct, we would just need to swap the calls, first create the cloudwatchAccount then create the deployment and stage.
Reproduction Steps
Create a SpecRestApi and deploy the stack all at once.
What did you expect to happen?
Deployment to complete.
What actually happened?
When creating a SpecRestApi the race condition still happens
CDK CLI Version
1.142.0 (build 5dd8e50)
Framework Version
1.142.0
Node.js Version
17.3.0
OS
macOS
Language
Typescript
Language Version
No response
Other information
No response