fix: handle profiles warehouse schemaName #204

ybr · 2025-09-25T13:15:22Z

Only send schemaName to API if it differs from the remote state

This prevents API failures when the schema name already exists in the warehouse. The Segment API fails if we send a schemaName that matches the current configuration, even though it should be a no-op

Only send schemaName to API if it differs from the remote state This prevents API failures when the schema name already exists in the warehouse. The Segment API fails if we send a schemaName that matches the current configuration, even though it should be a no-op

deanhuynh · 2025-10-01T20:44:51Z

Hi thanks for contributing! What error are you seeing here exactly? And do you have reproduction steps? I would like to check if this is something we can fix on the backend.

ybr · 2025-10-02T13:50:05Z

Hi thanks for contributing! What error are you seeing here exactly? And do you have reproduction steps? I would like to check if this is something we can fix on the backend.

Hello Dean,

Sure. I had a case opened with Segment Support 575344.

Anytime the Segment API is called to update a profiles warehouse with the schemaName field, it fails with the below error. Even if the schemaName is the one already set in Segment for the same profiles warehouse (which looks like a no-op to me).
The Segment provider sends this schemaName field whatever what, even if unspecified or in ignore_changes.

Reproduction steps:

Create a space through Segment UI
Create a source through Segment UI
Connect the source to the Space
Create using terraform a segment_profiles_warehouse for the space with a Snowflake warehouse.
Send an event to source, wait for the next sync of the profiles. This will create the schema, tables and columns in the warehouse.
Make terraform to update the profiles warehouse, like by changing the secret to connect with the warehouse (in the settings of the resource)

Error :

│ 400 Bad Request
│ {
│ "errors": [
│ {
│ "type": "bad-request",
│ "message": "Could not validate schema name. Error: schema found in the warehouse. Please check and try again."
│ }
│ ]
│ }

This error appears anytime the profiles warehouse requires an update of any kind.

The real use case we had:

A space was setup with its profiles warehouse manually through the Segment UI
We want to terraform Segment resources, so we use import and segment_profiles_warehouse terraform instructions to have them imported and managed by Segment.

Same error as above. The import works fine, but the definition not being exactly the same between manually created Segment resource and how it is defined in terraform code, terraform tries to update it.

I have been investigating the behavior of the Segment API using curl, you can PATCH the profiles warehouse but as soon as you send the schemaName field, the API fails.

I have been told by the support it is not workable to change the API so I volunteered to create this PR.

Hope this helps.

Copilot

Pull Request Overview

This PR fixes a bug in profiles warehouse schema name handling to prevent API failures when the schema name already exists in the warehouse configuration. The Segment API fails when receiving a schema name that matches the current configuration, even though it should be a no-op.

Implements conditional schema name sending based on state comparison
Adds comprehensive test coverage for schema name handling scenarios
Updates comments to follow proper formatting conventions

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
internal/provider/profiles_warehouse_resource.go	Adds `determineSchemaNameForUpdate` function and modifies update logic to only send schema name when it differs from remote state
internal/provider/profiles_warehouse_resource_test.go	Adds new test function and unit tests to verify schema name handling behavior, plus minor comment formatting fixes

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

internal/provider/profiles_warehouse_resource.go

Copilot · 2025-10-06T22:12:56Z

internal/provider/profiles_warehouse_resource_test.go

+			name:            "plan_null_state_has_value",
+			planSchemaName:  types.StringNull(),
+			stateSchemaName: types.StringValue("my-schema"),
+			expectedResult:  nil, // null pointer, not the actual value


The comment 'null pointer, not the actual value' is confusing and incorrect. This should clarify that nil means the schemaName should not be sent to the API, consistent with other test descriptions.

Suggested change

expectedResult: nil, // null pointer, not the actual value

expectedResult: nil, // should not send schemaName to API (prevents API failure)

Copilot · 2025-10-06T22:12:56Z

internal/provider/profiles_warehouse_resource_test.go

+			name:            "plan_unknown_state_has_value",
+			planSchemaName:  types.StringUnknown(),
+			stateSchemaName: types.StringValue("my-schema"),
+			expectedResult:  nil, // unknown becomes null pointer


The comment 'unknown becomes null pointer' is misleading. This should clarify that nil means the schemaName should not be sent to the API, consistent with the function's behavior and other test descriptions.

Suggested change

expectedResult: nil, // unknown becomes null pointer

expectedResult: nil, // should not send schemaName to API (prevents API failure)

deanhuynh · 2025-10-06T22:36:21Z

Going to add a few changes after testing.

deanhuynh · 2025-10-06T22:45:59Z

I'm unable to reproduce the issue on my end so far. I set up a Postgres profiles warehouse and set the schemaName. Then I fired off an update request to change another field, while still sending in the same schemaName. It was successful. Can you send specific commands that caused it to fail? Is there a particular warehouse you were using? I want to ensure it all works on my end before merging.

ybr · 2025-10-07T07:59:47Z

I'm unable to reproduce the issue on my end so far. I set up a Postgres profiles warehouse and set the schemaName. Then I fired off an update request to change another field, while still sending in the same schemaName. It was successful. Can you send specific commands that caused it to fail? Is there a particular warehouse you were using? I want to ensure it all works on my end before merging.

Hello Dean,
Sure, I forgot to mention that you need to send an event to source conencted to the space so that it will sync the event with the warehouse. Doing so Segment will create the schema as configured in the profiles warehouse, create tables and columns to fit your event. Creating manually the schema manually was not enough. I am going to change my previous message. Thank you.

ybr requested a review from a team as a code owner September 25, 2025 13:15

ybr-sanofi added 7 commits September 30, 2025 22:42

lint

8fe8bc1

lint

b22cee2

fmt

f8d16c5

remove documentation from md

4c0ba59

fix test

1f04964

lint

c8d9e7c

fix test

8270780

deanhuynh added 2 commits October 3, 2025 13:58

Merge branch 'main' into profiles-warehouse-schemaName

87f954f

Merge branch 'main' into profiles-warehouse-schemaName

6bbcf51

deanhuynh requested a review from Copilot October 6, 2025 22:12

Copilot AI reviewed Oct 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: handle profiles warehouse schemaName #204

fix: handle profiles warehouse schemaName #204

ybr commented Sep 25, 2025

Uh oh!

deanhuynh commented Oct 1, 2025

Uh oh!

ybr commented Oct 2, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI Oct 6, 2025

Uh oh!

Copilot AI Oct 6, 2025

Uh oh!

deanhuynh commented Oct 6, 2025

Uh oh!

deanhuynh commented Oct 6, 2025

Uh oh!

ybr commented Oct 7, 2025

Uh oh!

Uh oh!

	expectedResult: nil, // null pointer, not the actual value
	expectedResult: nil, // should not send schemaName to API (prevents API failure)

	expectedResult: nil, // unknown becomes null pointer
	expectedResult: nil, // should not send schemaName to API (prevents API failure)

fix: handle profiles warehouse schemaName #204

Are you sure you want to change the base?

fix: handle profiles warehouse schemaName #204

Conversation

ybr commented Sep 25, 2025

Uh oh!

deanhuynh commented Oct 1, 2025

Uh oh!

ybr commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

deanhuynh commented Oct 6, 2025

Uh oh!

deanhuynh commented Oct 6, 2025

Uh oh!

ybr commented Oct 7, 2025

Uh oh!

Uh oh!

ybr commented Oct 2, 2025 •

edited

Loading