fix: Sets default value for WithDefaultAlertsSettings during state import #3105

EspenAlbert · 2025-02-25T09:55:48Z

Description

Link to any related issue(s): CLOUDP-302586 & #3103

User impact:

During Update

State Value	User Config Action	Outcome
true	Add `with_default_alerts_settings = true`	No plan change
true	Add/Change `with_default_alerts_settings = false`	Error (see below)
true	Remove `with_default_alerts_settings`	No plan change (UseStateForUnknown)

Error message Update:

│ Error: with_default_alerts_settings cannot be updated or set after import, remove it from the configuration or use state value.
│ 
│   with mongodbatlas_project.project,
│   on main.tf line 22, in resource "mongodbatlas_project" "project":
│   22: resource "mongodbatlas_project" "project" {
│ 
│ The current state value is true

During Import

Import works, but the user will always get an error if with_default_alerts_settings is defined in their config and they run terraform plan for example:

resource "mongodbatlas_project" "project" {
  name                          = "testAtlasImport"
  org_id                        = var.org_id
  with_default_alerts_settings  = false
}

Error message:

mongodbatlas_project.project: Preparing import... [id=67bd8d6dbd053c5a1ee1a28c]
mongodbatlas_project.project: Refreshing state... [id=67bd8d6dbd053c5a1ee1a28c]

│ Error: with_default_alerts_settings cannot be updated or set after import, remove it from the configuration or use state value.
│ 
│   with mongodbatlas_project.project,
│   on main.tf line 22, in resource "mongodbatlas_project" "project":
│   22: resource "mongodbatlas_project" "project" {
│ 
│ The current state value is <null>

Is this a breaking change?

Arguments for Yes:

Users could update the configuration before without getting an error, although it had no effect on the API.

Arguments for No:

Users upgrading their provider version will see no plan changes. The previous implementation always stored the same value as the one set in the config. (It is impossible for us to know if this value match the one set during Create)

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

…port

github-actions · 2025-02-25T10:18:42Z

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

internal/service/project/resource_project.go

.changelog/3105.txt

…ore in project tests when it is not set to `false` in earlier steps

EspenAlbert · 2025-02-25T10:31:56Z

internal/service/project/resource_project.go

-	// we need to reset defaults from what was previously in the state:
-	// https://discuss.hashicorp.com/t/boolean-optional-default-value-migration-to-framework/55932
-	projectPlanNewPtr.WithDefaultAlertsSettings = projectPlan.WithDefaultAlertsSettings
+	// After import the state&plan will be null so we set to true (default value)


The user will still get a plan change after import if they have set with_default_alert_settings=false in their config. But we don't have access to that information in the import

Since this is still a possibility, I'm thinking if we should even implement this fix. This sounds like it should be expected behavior that WithDefaultAlertsSettings will not be set during import and maybe something we can call out in our documentation instead.

I'd find it harder to explain to users why import shows an update if with_default_alert_settings=false in their config but works when it's true.

internal/service/project/resource_project.go

marcosuma · 2025-02-25T12:25:56Z

internal/service/project/resource_project.go

+	if projectPlanNewPtr.WithDefaultAlertsSettings.IsNull() && projectPlan.WithDefaultAlertsSettings.IsNull() {
+		projectPlanNewPtr.WithDefaultAlertsSettings = types.BoolValue(true)
+	} else {
+		// Force value from plan as this is not returned from the API to avoid inconsistent result errors


it just feels a workaround from an API limitation, have we reached out to the team owning this feature?

I understand is a create-only parameter that has a side effect of creating alert settings, but I'll check with upstream. Api Docs

marcosuma · 2025-02-25T12:26:46Z

@EspenAlbert nit: can we have a why in the summary section to explain the change? also let's hold this merge until we have a conversation with the upstream team (if we did, we should connect the CLOUDPs and understand the why on their side)

kanchana-mongodb

LGTM

…ibute handling to support multiple planmodifiers

…ibutePlanModifier in resource schemas

EspenAlbert · 2025-03-03T16:14:21Z

Will get back to this on Wednesday

maastha · 2025-03-06T10:20:25Z

internal/common/customplanmodifier/create_only.go

+	planmodifier.Bool
+}
+
+func CreateOnlyAttributePlanModifier() Modifier {


Can we add a comment on what this plan modifier does & why it's needed?

github-actions · 2025-03-12T00:26:47Z

This PR has gone 7 days without any activity and meets the project’s definition of "stale". This will be auto-closed if there is no new activity over the next 7 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!

…or_with_default_alert_settings

…support and refactor IsKnown utility function

…e plan

EspenAlbert · 2025-03-13T10:06:14Z

internal/service/project/resource_project_test.go

+		orgID              = os.Getenv("MONGODB_ATLAS_ORG_ID")
+		projectOwnerID     = os.Getenv("MONGODB_ATLAS_PROJECT_OWNER_ID")
+		projectName        = acc.RandomProjectName()
+		importResourceName = resourceName + "2"


This test case is a bit different than usual, I tried to add comments, but let me know if anything is unclear.

marcosuma

@EspenAlbert let's hold on this one. I am not too convinced we are doing the right thing in adding more complexity to handle something like this. Let's chat in today's tech sync.

fix: Sets default value for WithDefaultAlertsSettings during state im…

53de463

…port

github-actions bot added the bug label Feb 25, 2025

chore: Adds release note

26f7353

EspenAlbert marked this pull request as ready for review February 25, 2025 10:18

EspenAlbert requested review from a team as code owners February 25, 2025 10:18

EspenAlbert mentioned this pull request Feb 25, 2025

[Bug]: imported project has a wrong configuration and unusable #3103

Open

2 tasks

oarbusi reviewed Feb 25, 2025

View reviewed changes

internal/service/project/resource_project.go Outdated Show resolved Hide resolved

EspenAlbert commented Feb 25, 2025

View reviewed changes

.changelog/3105.txt Outdated Show resolved Hide resolved

fix: Removes 'with_default_alerts_settings' from ImportStateVerifyIgn…

5e67e14

…ore in project tests when it is not set to `false` in earlier steps

oarbusi approved these changes Feb 25, 2025

View reviewed changes

EspenAlbert commented Feb 25, 2025

View reviewed changes

lantoli approved these changes Feb 25, 2025

View reviewed changes

marcosuma reviewed Feb 25, 2025

View reviewed changes

internal/service/project/resource_project.go Outdated Show resolved Hide resolved

marcosuma reviewed Feb 25, 2025

View reviewed changes

kanchana-mongodb approved these changes Feb 25, 2025

View reviewed changes

EspenAlbert added 6 commits February 25, 2025 15:10

doc: update changelog message

57ddae6

doc: Add back reference based on comments

7bc763e

revert changes of old implementation

de2589d

refactor: Introduce Modifier interface and enhance non-updatable attr…

7934ad0

…ibute handling to support multiple planmodifiers

refactor: Mark with_default_alerts_settings as NonUpdateable

af84e38

refactor:Rename NonUpdatableAttributePlanModifier with CreateOnlyAttr…

66e55e9

…ibutePlanModifier in resource schemas

maastha reviewed Mar 6, 2025

View reviewed changes

github-actions bot added the stale label Mar 12, 2025

EspenAlbert added the not_stale Not stale issue or PR label Mar 12, 2025

Merge branch 'master' into CLOUDP-302586_fix_project_no_plan_change_f…

e11fc3f

…or_with_default_alert_settings

EspenAlbert added 4 commits March 12, 2025 14:46

feat: Implement CreateOnlyAttributePlanModifier with default boolean …

bd76a93

…support and refactor IsKnown utility function

chore: small fix to planModifier using state value when Unknown in th…

d0cb772

…e plan

test: Support testing plan error after importing

57f8e64

doc: Update error message in addDiags to clarify import restrictions

4ae2ccc

EspenAlbert commented Mar 13, 2025

View reviewed changes

EspenAlbert mentioned this pull request Mar 13, 2025

fix: Avoid error when removing read only spec in region config that does not define electable specs #3162

Merged

13 tasks

marcosuma requested changes Mar 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Sets default value for WithDefaultAlertsSettings during state import #3105

fix: Sets default value for WithDefaultAlertsSettings during state import #3105

EspenAlbert commented Feb 25, 2025 •

edited

Loading

github-actions bot commented Feb 25, 2025

EspenAlbert Feb 25, 2025

maastha Feb 25, 2025

marcosuma Feb 25, 2025

EspenAlbert Feb 25, 2025

marcosuma commented Feb 25, 2025

kanchana-mongodb left a comment

EspenAlbert commented Mar 3, 2025

maastha Mar 6, 2025

github-actions bot commented Mar 12, 2025

EspenAlbert Mar 13, 2025

marcosuma left a comment

fix: Sets default value for WithDefaultAlertsSettings during state import #3105

Are you sure you want to change the base?

fix: Sets default value for WithDefaultAlertsSettings during state import #3105

Conversation

EspenAlbert commented Feb 25, 2025 • edited Loading

Description

During Update

Error message Update:

During Import

Is this a breaking change?

Type of change:

Required Checklist:

Further comments

github-actions bot commented Feb 25, 2025

EspenAlbert Feb 25, 2025

Choose a reason for hiding this comment

maastha Feb 25, 2025

Choose a reason for hiding this comment

marcosuma Feb 25, 2025

Choose a reason for hiding this comment

EspenAlbert Feb 25, 2025

Choose a reason for hiding this comment

marcosuma commented Feb 25, 2025

kanchana-mongodb left a comment

Choose a reason for hiding this comment

EspenAlbert commented Mar 3, 2025

maastha Mar 6, 2025

Choose a reason for hiding this comment

github-actions bot commented Mar 12, 2025

EspenAlbert Mar 13, 2025

Choose a reason for hiding this comment

marcosuma left a comment

Choose a reason for hiding this comment

EspenAlbert commented Feb 25, 2025 •

edited

Loading