feat: Long-running operation improvements for `mongodbatlas_encryption_at_rest_private_endpoint` resource #3561

oarbusi · 2025-08-06T10:45:03Z

Description

Implements long-running operation improvements for mongodbatlas_encryption_at_rest_private_endpoint resource, adding proper timeout support and delete_on_create_timeout functionality.

Changes

Added timeout support: mongodbatlas_encryption_at_rest_private_endpoint Create and Delete operations now respect configured timeouts block
Added delete_on_create_timeout: New optional field (defaults to true) that automatically deletes cluster if creation times out
Added timeout testing: New acceptance test validates timeout and cleanup functionality

Link to any related issue(s): CLOUDP-334357

Type of change:

Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
This change requires a documentation update
Documentation fix/enhancement

Required Checklist:

I have signed the MongoDB CLA
I have read the contributing guides
I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
I have added any necessary documentation (if appropriate)
I have run make fmt and formatted my code
If changes include deprecations or removals I have added appropriate changelog entries.
If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

oarbusi · 2025-08-06T12:10:17Z

internal/service/flexcluster/resource_test.go

@@ -48,6 +48,7 @@ func TestAccFlexClusterRS_createTimeoutWithDeleteOnCreateFlex(t *testing.T) {
 }

 func TestAccFlexClusterRS_updateDeleteTimeout(t *testing.T) {
+	acc.SkipTestForCI(t) // Update is consistently too fast and it does not time out, making the test flaky


didn't notice this until now, but it does fail quite consistently due to the step 2 of the test not having the expected failure because it does not time out on the update

can modifying the region in the second make the update operation longer and ensure 1s will always timeout?

region is not updatable, the cluster would need to be recreated to change the region

…O_PRIVATE_ENDPOINTS

oarbusi · 2025-08-11T06:20:17Z

encryption tests failing due to back clean up

github-actions · 2025-08-11T06:21:10Z

APIx bot: a message has been sent to Docs Slack channel

Copilot

Pull Request Overview

This PR implements long-running operation improvements for the mongodbatlas_encryption_at_rest_private_endpoint resource by adding proper timeout support and delete_on_create_timeout functionality. These changes align with the provider's pattern for handling long-running operations and provide better control over resource creation timeouts.

Added timeouts block support for Create and Delete operations
Added delete_on_create_timeout attribute (defaults to true) for automatic cleanup on creation timeout
Updated state transition functions to accept timeout parameters

Reviewed Changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
internal/service/encryptionatrestprivateendpoint/resource_schema.go	Added timeouts and delete_on_create_timeout attributes to resource schema
internal/service/encryptionatrestprivateendpoint/resource.go	Integrated timeout handling and cleanup logic into Create/Delete operations
internal/service/encryptionatrestprivateendpoint/state_transition.go	Updated state transition functions to accept timeout parameters
internal/service/encryptionatrestprivateendpoint/model.go	Added separate data source model type and helper function
internal/service/encryptionatrestprivateendpoint/data_source_schema.go	Created separate data source model without timeout fields
internal/service/encryptionatrestprivateendpoint/resource_test.go	Added timeout test and cleanup handling
internal/testutil/acc/encryption_at_rest.go	Added encryption at rest test utility functions
internal/testutil/acc/shared_resource.go	Added encryption at rest cleanup support
internal/service/flexcluster/resource.go	Moved common timeout resolution function to shared cleanup package
docs/resources/encryption_at_rest_private_endpoint.md	Updated documentation with new timeout attributes

.changelog/3561.txt

Co-authored-by: Copilot <[email protected]>

marcosuma · 2025-08-11T06:41:23Z

docs/resources/encryption_at_rest_private_endpoint.md

 ### Read-Only

 - `error_message` (String) Error message for failures associated with the Encryption At Rest private endpoint.
 - `id` (String) Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.
 - `private_endpoint_connection_name` (String) Connection name of the Azure Private Endpoint.
 - `status` (String) State of the Encryption At Rest private endpoint.

+<a id="nestedatt--timeouts"></a>
+### Nested Schema for `timeouts`


@oarbusi I think we should leave a short why the update is not there, thoughts?

The update does not have timeout because the update operation is not supported in this resource. Considering that there's a note in the resource doc stating that update is not supported, I think it's not necessary to mention why there's no timeout for the update

AgustinBettati · 2025-08-11T08:58:50Z

internal/service/encryptionatrestprivateendpoint/resource.go

+		if validate.StatusNotFound(cleanResp) {
+			return nil
+		}


q: I see in some resources (e.g. networkpeering) the sanity check of seeing if delete return 404 is not being made. For consistency, would it make sense to move this check into cleanup.HandleCreateTimeout, and have cleanup only call the DELETE operation?

IMO HandleCreateTimeout should only handle the delete on create logic, and avoid doing the 404 case, to keep the method focused and clear

In that case would consider that privatelinkendpointservice, privatelinkendpoint, onlinearchive, networkpeering, and cloudbackupsnapshot do not have this check in their cleanup function. Not certain if we want to keep this as a general practice.

I think this is unrelated to long-running operations, but we could create a CLOUDP to investigate and unify behavior on 404 across the resources you mentioned?

i suppose we could keep the code simple here, e.g.:

err = cleanup.HandleCreateTimeout(cleanup.ResolveDeleteOnCreateTimeout(earPrivateEndpointPlan.DeleteOnCreateTimeout), err, func(ctxCleanup context.Context) error { _, cleanErr := connV2.EncryptionAtRestUsingCustomerKeyManagementApi.RequestEncryptionAtRestPrivateEndpointDeletion(ctxCleanup, projectID, cloudProvider, createResp.GetId()).Execute() return cleanErr })

and in HandleCreateTimeout don't raise error if cleanup funcs return 404 error, if we expect this will happen with most of the resources

AgustinBettati · 2025-08-11T09:03:34Z

internal/testutil/acc/encryption_at_rest.go

+// EncryptionAtRestExecution creates an encryption at rest configuration for test execution.
+func EncryptionAtRestExecution(tb testing.TB) string {


can be good to clarify it uses a fixed project and what env variables are leveraged. Potentially passing values as parameter to the function also makes it more explicit.

lantoli · 2025-08-11T13:09:26Z

internal/service/encryptionatrestprivateendpoint/resource_test.go

+	// 3. Other tests share the same project and attempt to disable encryption at rest during cleanup
+	// 4. MongoDB Atlas returns "CANNOT_DISABLE_ENCRYPTION_AT_REST_REQUIRE_PRIVATE_NETWORKING_WHILE_PRIVATE_ENDPOINTS_EXIST"
+	//    because the private endpoint from this test is still being deleted
+	// This race condition occurs even when tests don't run in parallel due to the async nature of private endpoint deletion.


would it work if using a different project?

no, project needs some set up in order to make this work.

oarbusi added 3 commits August 6, 2025 12:13

implement timeout for create and delete

cddcf57

implement delete_on_create_timeout

5d6e1f9

implement test

df219b9

github-actions bot added the enhancement label Aug 6, 2025

data sources fix

695283b

oarbusi changed the base branch from master to CLOUDP-320243-dev-2.0.0 August 6, 2025 10:49

oarbusi added 3 commits August 6, 2025 13:03

docs and changelog

4344479

fix unit test

5858275

test fixes

37c287e

oarbusi commented Aug 6, 2025

View reviewed changes

oarbusi added 5 commits August 7, 2025 08:46

fix test

72aca36

use shared resources to avoid CANNOT_DISABLE_ENCRYPTION_AT_REST_DUE_T…

d77b328

…O_PRIVATE_ENDPOINTS

non parallel test

6fe7345

try new project for ear

90bb920

create project

26b8dc7

oarbusi force-pushed the CLOUDP-334357 branch from 1c1b0ad to 26b8dc7 Compare August 7, 2025 10:13

oarbusi added 7 commits August 7, 2025 12:13

Merge branch 'CLOUDP-320243-dev-2.0.0' into CLOUDP-334357

8c61292

change description

06aad46

use configured project

4aa5b41

use correct projectn

622b1a1

Merge branch 'CLOUDP-320243-dev-2.0.0' into CLOUDP-334357

dcade6f

clean up shared resources

bf15a87

skip test

7547e48

oarbusi marked this pull request as ready for review August 11, 2025 06:20

Copilot AI review requested due to automatic review settings August 11, 2025 06:20

oarbusi requested review from a team as code owners August 11, 2025 06:20

Copilot AI reviewed Aug 11, 2025

View reviewed changes

.changelog/3561.txt Outdated Show resolved Hide resolved

Update .changelog/3561.txt

c246282

Co-authored-by: Copilot <[email protected]>

marcosuma approved these changes Aug 11, 2025

View reviewed changes

oarbusi force-pushed the CLOUDP-334357 branch from fe6f758 to c246282 Compare August 11, 2025 08:17

oarbusi added 2 commits August 11, 2025 10:17

Merge branch 'CLOUDP-320243-dev-2.0.0' into CLOUDP-334357

d73d690

changes from dev

bb81f45

AgustinBettati approved these changes Aug 11, 2025

View reviewed changes

lantoli reviewed Aug 11, 2025

View reviewed changes

jwilliams-mongo approved these changes Aug 11, 2025

View reviewed changes

oarbusi merged commit 002163b into CLOUDP-320243-dev-2.0.0 Aug 12, 2025
41 of 42 checks passed

oarbusi deleted the CLOUDP-334357 branch August 12, 2025 07:34

		// EncryptionAtRestExecution creates an encryption at rest configuration for test execution.
		func EncryptionAtRestExecution(tb testing.TB) string {

feat: Long-running operation improvements for mongodbatlas_encryption_at_rest_private_endpoint resource #3561

feat: Long-running operation improvements for mongodbatlas_encryption_at_rest_private_endpoint resource #3561

Uh oh!

Conversation

oarbusi commented Aug 6, 2025

Description

Changes

Type of change:

Required Checklist:

Further comments

Uh oh!

oarbusi Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oarbusi commented Aug 11, 2025

Uh oh!

github-actions bot commented Aug 11, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lantoli Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

feat: Long-running operation improvements for `mongodbatlas_encryption_at_rest_private_endpoint` resource #3561

feat: Long-running operation improvements for `mongodbatlas_encryption_at_rest_private_endpoint` resource #3561

oarbusi Aug 6, 2025 •

edited

Loading

lantoli Aug 12, 2025 •

edited

Loading