resource/aws_subnet: Handle read-after-create eventual consistency by bflad · Pull Request #18392 · hashicorp/terraform-provider-aws

bflad · 2021-03-24T20:59:14Z

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

Closes #12829
Reference: #16796

Output from acceptance testing in AWS Commercial:

--- PASS: TestAccAWSSubnet_availabilityZoneId (53.74s)
--- PASS: TestAccAWSSubnet_basic (52.50s)
--- PASS: TestAccAWSSubnet_defaultAndIgnoreTags (80.26s)
--- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_duplicateTag (6.45s)
--- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_nonOverlappingTag (84.84s)
--- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_overlappingTag (86.61s)
--- PASS: TestAccAWSSubnet_defaultTags_providerOnly (87.99s)
--- PASS: TestAccAWSSubnet_defaultTags_updateToProviderOnly (69.48s)
--- PASS: TestAccAWSSubnet_defaultTags_updateToResourceOnly (72.12s)
--- PASS: TestAccAWSSubnet_disappears (41.08s)
--- PASS: TestAccAWSSubnet_enableIpv6 (109.36s)
--- PASS: TestAccAWSSubnet_ignoreTags (81.13s)
--- PASS: TestAccAWSSubnet_ipv6 (118.69s)
--- PASS: TestAccAWSSubnet_MapPublicIpOnLaunch (118.55s)
--- PASS: TestAccAWSSubnet_tags (106.25s)
--- SKIP: TestAccAWSSubnet_CustomerOwnedIpv4Pool (1.44s)
--- SKIP: TestAccAWSSubnet_MapCustomerOwnedIpOnLaunch (1.40s)
--- SKIP: TestAccAWSSubnet_outpost (1.70s)

Output from acceptance testing in AWS GovCloud (US):

--- PASS: TestAccAWSSubnet_availabilityZoneId (55.41s)
--- PASS: TestAccAWSSubnet_basic (55.46s)
--- PASS: TestAccAWSSubnet_defaultAndIgnoreTags (85.95s)
--- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_duplicateTag (6.64s)
--- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_nonOverlappingTag (82.23s)
--- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_overlappingTag (84.95s)
--- PASS: TestAccAWSSubnet_defaultTags_providerOnly (86.26s)
--- PASS: TestAccAWSSubnet_defaultTags_updateToProviderOnly (69.05s)
--- PASS: TestAccAWSSubnet_defaultTags_updateToResourceOnly (73.74s)
--- PASS: TestAccAWSSubnet_disappears (42.78s)
--- PASS: TestAccAWSSubnet_enableIpv6 (117.40s)
--- PASS: TestAccAWSSubnet_ignoreTags (83.74s)
--- PASS: TestAccAWSSubnet_ipv6 (126.25s)
--- PASS: TestAccAWSSubnet_MapPublicIpOnLaunch (124.27s)
--- PASS: TestAccAWSSubnet_tags (115.31s)
--- SKIP: TestAccAWSSubnet_CustomerOwnedIpv4Pool (6.95s)
--- SKIP: TestAccAWSSubnet_MapCustomerOwnedIpOnLaunch (2.60s)
--- SKIP: TestAccAWSSubnet_outpost (2.14s)

Reference: #12829 Reference: #16796 Output from acceptance testing in AWS Commercial: ``` --- PASS: TestAccAWSSubnet_availabilityZoneId (53.74s) --- PASS: TestAccAWSSubnet_basic (52.50s) --- PASS: TestAccAWSSubnet_defaultAndIgnoreTags (80.26s) --- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_duplicateTag (6.45s) --- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_nonOverlappingTag (84.84s) --- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_overlappingTag (86.61s) --- PASS: TestAccAWSSubnet_defaultTags_providerOnly (87.99s) --- PASS: TestAccAWSSubnet_defaultTags_updateToProviderOnly (69.48s) --- PASS: TestAccAWSSubnet_defaultTags_updateToResourceOnly (72.12s) --- PASS: TestAccAWSSubnet_disappears (41.08s) --- PASS: TestAccAWSSubnet_enableIpv6 (109.36s) --- PASS: TestAccAWSSubnet_ignoreTags (81.13s) --- PASS: TestAccAWSSubnet_ipv6 (118.69s) --- PASS: TestAccAWSSubnet_MapPublicIpOnLaunch (118.55s) --- PASS: TestAccAWSSubnet_tags (106.25s) --- SKIP: TestAccAWSSubnet_CustomerOwnedIpv4Pool (1.44s) --- SKIP: TestAccAWSSubnet_MapCustomerOwnedIpOnLaunch (1.40s) --- SKIP: TestAccAWSSubnet_outpost (1.70s) ``` Output from acceptance testing in AWS GovCloud (US): ``` --- PASS: TestAccAWSSubnet_availabilityZoneId (55.41s) --- PASS: TestAccAWSSubnet_basic (55.46s) --- PASS: TestAccAWSSubnet_defaultAndIgnoreTags (85.95s) --- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_duplicateTag (6.64s) --- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_nonOverlappingTag (82.23s) --- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_overlappingTag (84.95s) --- PASS: TestAccAWSSubnet_defaultTags_providerOnly (86.26s) --- PASS: TestAccAWSSubnet_defaultTags_updateToProviderOnly (69.05s) --- PASS: TestAccAWSSubnet_defaultTags_updateToResourceOnly (73.74s) --- PASS: TestAccAWSSubnet_disappears (42.78s) --- PASS: TestAccAWSSubnet_enableIpv6 (117.40s) --- PASS: TestAccAWSSubnet_ignoreTags (83.74s) --- PASS: TestAccAWSSubnet_ipv6 (126.25s) --- PASS: TestAccAWSSubnet_MapPublicIpOnLaunch (124.27s) --- PASS: TestAccAWSSubnet_tags (115.31s) --- SKIP: TestAccAWSSubnet_CustomerOwnedIpv4Pool (6.95s) --- SKIP: TestAccAWSSubnet_MapCustomerOwnedIpOnLaunch (2.60s) --- SKIP: TestAccAWSSubnet_outpost (2.14s) ```

gdavison

One comment on where to handle not found cases, otherwise LGTM 🚀

--- SKIP: TestAccAWSSubnet_outpost (1.17s)
--- SKIP: TestAccAWSSubnet_MapCustomerOwnedIpOnLaunch (1.29s)
--- SKIP: TestAccAWSSubnet_CustomerOwnedIpv4Pool (6.13s)
--- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_duplicateTag (9.25s)
--- PASS: TestAccAWSSubnet_disappears (46.97s)
--- PASS: TestAccAWSSubnet_availabilityZoneId (55.93s)
--- PASS: TestAccAWSSubnet_basic (56.90s)
--- PASS: TestAccAWSSubnet_defaultTags_updateToProviderOnly (75.08s)
--- PASS: TestAccAWSSubnet_defaultTags_updateToResourceOnly (78.74s)
--- PASS: TestAccAWSSubnet_defaultAndIgnoreTags (85.26s)
--- PASS: TestAccAWSSubnet_ignoreTags (85.50s)
--- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_nonOverlappingTag (89.09s)
--- PASS: TestAccAWSSubnet_defaultTags_providerOnly (90.52s)
--- PASS: TestAccAWSSubnet_defaultTags_providerAndResource_overlappingTag (89.93s)
--- PASS: TestAccAWSSubnet_enableIpv6 (100.95s)
--- PASS: TestAccAWSSubnet_tags (101.94s)
--- PASS: TestAccAWSSubnet_ipv6 (102.25s)
--- PASS: TestAccAWSSubnet_MapPublicIpOnLaunch (111.12s)

gdavison · 2021-03-25T18:10:21Z

+		if d.IsNewResource() && tfawserr.ErrCodeEquals(err, "InvalidSubnetID.NotFound") {
+			return resource.RetryableError(err)
 		}
-		return err
+
+		if err != nil {
+			return resource.NonRetryableError(err)
+		}
+
+		if d.IsNewResource() && subnet == nil {
+			return resource.RetryableError(&resource.NotFoundError{
+				LastError: fmt.Errorf("EC2 Subnet (%s) not found", d.Id()),
+			})
+		}
+
+		return nil
+	})
+
+	if tfresource.TimedOut(err) {
+		subnet, err = finder.SubnetByID(conn, d.Id())
 	}
-	if resp == nil {
+
+	if !d.IsNewResource() && tfawserr.ErrCodeEquals(err, "InvalidSubnetID.NotFound") {
+		log.Printf("[WARN] EC2 Subnet (%s) not found, removing from state", d.Id())
+		d.SetId("")
 		return nil
 	}

-	subnet := resp.Subnets[0]
+	if err != nil {
+		return fmt.Errorf("error reading EC2 Subnet (%s): %w", d.Id(), err)
+	}
+
+	if subnet == nil {
+		if d.IsNewResource() {
+			return fmt.Errorf("error reading EC2 Subnet (%s): not found after creation", d.Id())
+		}
+
+		log.Printf("[WARN] EC2 Subnet (%s) not found, removing from state", d.Id())
+		d.SetId("")
+		return nil
+	}


If finder.SubnetByID() returns a resource.NotFoundError when the subnet is not found, we'd have to do a lot less checking for different not found cases at this level.

In general, this is likely a good move, but it is not the current standard, I am not immediately sure of all the implications, and I don't feel comfortable implementing it my own without discussing it first. I have created two tracking issues for following up to this:

Add Contribution Guide Documentation for Service finder Packages #18417

Implement Consistent Error Types and Handling in Service finder Packages #18418

ghost · 2021-03-26T00:46:55Z

This has been released in version 3.34.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 · 2021-04-25T17:14:19Z

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!

bflad added the bug Addresses a defect in current functionality. label Mar 24, 2021

bflad requested a review from a team as a code owner March 24, 2021 20:59

ghost added size/S Managed by automation to categorize the size of a PR. service/ec2 Issues and PRs that pertain to the ec2 service. labels Mar 24, 2021

Update CHANGELOG for #18392

5b3cc68

gdavison self-assigned this Mar 25, 2021

gdavison approved these changes Mar 25, 2021

View reviewed changes

bflad merged commit 0016fc8 into main Mar 25, 2021

bflad deleted the b-aws_subnet-d.IsNewResource branch March 25, 2021 21:38

github-actions Bot added this to the v3.34.0 milestone Mar 25, 2021

github-actions Bot pushed a commit that referenced this pull request Mar 25, 2021

Update CHANGELOG.md for #18392

c103c41

ghost locked as resolved and limited conversation to collaborators Apr 25, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

resource/aws_subnet: Handle read-after-create eventual consistency#18392

resource/aws_subnet: Handle read-after-create eventual consistency#18392
bflad merged 2 commits into
mainfrom
b-aws_subnet-d.IsNewResource

bflad commented Mar 24, 2021

Uh oh!

gdavison left a comment

Uh oh!

gdavison Mar 25, 2021

Uh oh!

bflad Mar 25, 2021

Uh oh!

ghost commented Mar 26, 2021

Uh oh!

ghost commented Apr 25, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

bflad commented Mar 24, 2021

Community Note

Uh oh!

gdavison left a comment

Choose a reason for hiding this comment

Uh oh!

gdavison Mar 25, 2021

Choose a reason for hiding this comment

Uh oh!

bflad Mar 25, 2021

Choose a reason for hiding this comment

Uh oh!

ghost commented Mar 26, 2021

Uh oh!

ghost commented Apr 25, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants