Add feature to concurrently update/delete AWS API Gateway method settings

[saurabh-hirani]

This PR fixes the error encountered while updating/deleting aws_api_gateway_method_settings resources concurrently. Right now we get the following error if parallelism is > 1 and we try to update/delete > 1 method_settings

Error: Updating API Gateway Stage failed: ConflictException: Unable to complete operation due to concurrent modification. Please try again later.

This issue was highlighted in a comment - #483 (comment) - which suggested using daisy chaining to resolve it. But when using for_each we cannot use daisy chaining as per this discussion - https://discuss.hashicorp.com/t/is-there-a-way-to-daisy-chain-depends-on-for-resources-created-using-count-or-for-each/8467

There is no other workaround except for using parallelism value 1 which slows down the entire deployment as API Gateway is just one part of many resources created/updated.

Community Note

• Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

Relates #483

Release note for CHANGELOG:

NONE

Output from acceptance testing:

$ make testacc TESTARGS='-run=TestAccAWSAPIGatewayRestApi'

=== RUN   TestAccAWSAPIGatewayRestApi_basic
=== PAUSE TestAccAWSAPIGatewayRestApi_basic
=== RUN   TestAccAWSAPIGatewayRestApi_tags
=== PAUSE TestAccAWSAPIGatewayRestApi_tags
=== RUN   TestAccAWSAPIGatewayRestApi_disappears
=== PAUSE TestAccAWSAPIGatewayRestApi_disappears
=== RUN   TestAccAWSAPIGatewayRestApi_EndpointConfiguration
=== PAUSE TestAccAWSAPIGatewayRestApi_EndpointConfiguration
=== RUN   TestAccAWSAPIGatewayRestApi_EndpointConfiguration_Private
=== PAUSE TestAccAWSAPIGatewayRestApi_EndpointConfiguration_Private
=== RUN   TestAccAWSAPIGatewayRestApi_EndpointConfiguration_VPCEndpoint
=== PAUSE TestAccAWSAPIGatewayRestApi_EndpointConfiguration_VPCEndpoint
=== RUN   TestAccAWSAPIGatewayRestApi_api_key_source
=== PAUSE TestAccAWSAPIGatewayRestApi_api_key_source
=== RUN   TestAccAWSAPIGatewayRestApi_policy
=== PAUSE TestAccAWSAPIGatewayRestApi_policy
=== RUN   TestAccAWSAPIGatewayRestApi_openapi
=== PAUSE TestAccAWSAPIGatewayRestApi_openapi
=== CONT  TestAccAWSAPIGatewayRestApi_basic
=== CONT  TestAccAWSAPIGatewayRestApi_EndpointConfiguration_VPCEndpoint
=== CONT  TestAccAWSAPIGatewayRestApi_EndpointConfiguration
=== CONT  TestAccAWSAPIGatewayRestApi_EndpointConfiguration_Private
=== CONT  TestAccAWSAPIGatewayRestApi_openapi
=== CONT  TestAccAWSAPIGatewayRestApi_disappears
=== CONT  TestAccAWSAPIGatewayRestApi_api_key_source
=== CONT  TestAccAWSAPIGatewayRestApi_policy
=== CONT  TestAccAWSAPIGatewayRestApi_tags
--- PASS: TestAccAWSAPIGatewayRestApi_disappears (58.28s)
--- PASS: TestAccAWSAPIGatewayRestApi_EndpointConfiguration_Private (78.31s)
--- PASS: TestAccAWSAPIGatewayRestApi_policy (114.82s)
--- PASS: TestAccAWSAPIGatewayRestApi_EndpointConfiguration (134.65s)
--- PASS: TestAccAWSAPIGatewayRestApi_api_key_source (158.21s)
--- PASS: TestAccAWSAPIGatewayRestApi_basic (195.04s)

[saurabh-hirani]

Can someone please review and provide feedback? Doing parallelism=1 workaround leads to unwanted delay in infra deployments.

[bflad]

Hi folks 👋 After creating some additional testing for this resource that included concurrent aws_api_gateway_methods_settings resources, I was able to reproduce what appears to be the problem here. To speed things up in the future for the maintainers and get bug fixes in, it is helpful to ensure there is an open GitHub issue, per Terraform resource, that describes the problem including a reproducing configuration and typically debug logging.

In this case, we'll be taking a slightly different approach instead of a mutex where we introduce the retry logic directly into the AWS Go SDK service client since it will yield the simplest fix. Thank you @saurabh-hirani for contributing this and the service client implementation will be refactored on top of this commit along with the covering testing. 👍

[saurabh-hirani]

Thanks @bflad 👍

[ghost]

This has been released in version 3.24.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks!

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!