feat: Add workspace_name field in stream_connection resource and datasource #3610

kpatel71716 · 2025-08-21T19:58:32Z

Description

JIRA: CLOUDP-339895, following the plan discussed with APIx team in CLOUDP-336156

As part of an ongoing effort to rename stream instances to stream workspaces, we will support a workspace_name field for the stream_connection resource and datasource that will function identically to 1instance_name`. To avoid confusion, only one of instance_name or workspace name will be allowed to be set

In a future major version of terraform, we will remove the instance_name field

Link to any related issue(s):

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

github-actions · 2025-09-25T12:42:44Z

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

.changelog/3610.txt

docs/data-sources/stream_connection.md

docs/resources/stream_connection.md

examples/mongodbatlas_stream_connection/main.tf

internal/service/streamconnection/data_source_stream_connection.go

marcosuma · 2025-09-25T14:05:37Z

internal/service/streamconnection/data_source_stream_connection.go

 	resp.Schema = conversion.DataSourceSchemaFromResource(ResourceSchema(ctx), &conversion.DataSourceSchemaRequest{
-		RequiredFields: []string{"project_id", "instance_name", "connection_name"},
+		RequiredFields: []string{"project_id", "connection_name"},
+		OverridenFields: map[string]dsschema.Attribute{


what do we mean here with overridden?

This was unnecessary. I removed it

Actually looks like we still need this so that terraform can use the workspace_name field in place of the instance name field. Without this we get errors due to terraform thinking that the datasource is being modified due to the mapping of the instance_name and workspace_name fields

marcosuma · 2025-09-25T14:06:42Z

internal/service/streamconnection/data_source_stream_connection.go

 	connV2 := d.Client.AtlasV2
 	projectID := streamConnectionConfig.ProjectID.ValueString()
-	instanceName := streamConnectionConfig.InstanceName.ValueString()
+	effectiveWorkspaceName := getEffectiveWorkspaceName(&streamConnectionConfig)


will this now fail if they pass instanceSize only?

The check below will error if workspace_name and instance_name are both undefined. If both are defined, then there will also be an error in NewTFStreamConnectionWithInstanceName

So one of workspace_name and instance_name is essentially required

ah ok, so for whoever continues to use instance_name there will be no impact, right?

yep, that's correct!

.changelog/3610.txt

internal/service/streamconnection/resource_schema.go

lantoli · 2025-09-26T09:15:27Z

internal/service/streamconnection/resource_schema.go

+			"workspace_name": schema.StringAttribute{
+				Optional: true,
+				PlanModifiers: []planmodifier.String{
+					stringplanmodifier.RequiresReplace(),


this means that if user changes workspace_name, Delete and Create will be called instead of Update.

qq: is this the behavior we want? there are 3 main alternatives:

Destroy and create a new resource (current approach)

Handle workspace_name changes in Update

Raise an error that workspace_name can't be updated

Double checked and discussed with our team. This is intentional behavior. The same happens with the equivalent instance_name attribute today

internal/service/streamconnection/resource_stream_connection_test.go

lantoli · 2025-09-26T09:30:18Z

tf-validate PR check fail will probably get fixed if you bring latest from master to this branch, there was a fix here: #3713

carriecwk

lgtm

github-actions bot added enhancement stale labels Aug 21, 2025

github-actions bot closed this Aug 30, 2025

kpatel71716 reopened this Sep 23, 2025

github-actions bot removed the stale label Sep 24, 2025

kpatel71716 added 3 commits September 24, 2025 11:15

doc: update stream_connection docs for workspace_name nomenclature

31304ee

feat: add workspace_name to stream connection schema and models

4d06c1e

feat: add workspace_name to stream connection resource and datasource

4530ef5

kpatel71716 force-pushed the CLOUDP-339895 branch from 6777bf6 to 4530ef5 Compare September 25, 2025 11:19

fix ds schema and model tests

bdeb3ef

kpatel71716 marked this pull request as ready for review September 25, 2025 12:42

kpatel71716 requested review from a team as code owners September 25, 2025 12:42

doc: add changelog and fix example

096bc32

kpatel71716 force-pushed the CLOUDP-339895 branch from 86df792 to 096bc32 Compare September 25, 2025 13:09

marcosuma reviewed Sep 25, 2025

View reviewed changes

doc: clean up documentation

d04b471

lantoli reviewed Sep 26, 2025

View reviewed changes

.changelog/3610.txt Outdated Show resolved Hide resolved

lantoli reviewed Sep 26, 2025

View reviewed changes

internal/service/streamconnection/resource_schema.go Show resolved Hide resolved

lantoli reviewed Sep 26, 2025

View reviewed changes

internal/service/streamconnection/resource_stream_connection_test.go Outdated Show resolved Hide resolved

lantoli approved these changes Sep 26, 2025

View reviewed changes

carriecwk approved these changes Sep 26, 2025

View reviewed changes

Merge remote-tracking branch 'upstream' into CLOUDP-339895

4254b34

github-actions bot added the stale label Oct 2, 2025

address PR feedback

77e7b9e

mongodb deleted a comment from github-actions bot Oct 2, 2025

add deprecation message and add overriddden fields

f5f3d27

github-actions bot removed the stale label Oct 3, 2025

kpatel71716 added 2 commits October 3, 2025 02:16

fix examples and tests

0ff807b

add missing legacy InstanceName field in model

7b9bd5a

kpatel71716 requested a review from marcosuma October 3, 2025 07:34

feat: Add workspace_name field in stream_connection resource and datasource #3610

Are you sure you want to change the base?

feat: Add workspace_name field in stream_connection resource and datasource #3610

Uh oh!

Conversation

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

Uh oh!

Description

Type of change:

Required Checklist:

Further comments

Uh oh!

github-actions bot commented Sep 25, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lantoli Sep 26, 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!

Uh oh!

lantoli commented Sep 26, 2025

Uh oh!

carriecwk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kpatel71716 commented Aug 21, 2025 •

edited

Loading

lantoli Sep 26, 2025 •

edited

Loading