You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Renames all references to "Trace ID" in the Native Hosting CLI to "Correlation ID" for consistency with the X-Correlation-Id HTTP header already used in API requests.
Changes span both @bigcommerce/catalyst and create-catalyst:
Rename sessionId property to correlationId in both Telemetry classes
Update Segment event property name (sessionId → correlationId)
Update tests and in-repo documentation (CHANGELOG, changeset)
Discussion point: The Jira ticket scopes this to the "Native Hosting CLI" (@bigcommerce/catalyst), but this PR also renames sessionId → correlationId in create-catalyst's Telemetry class for consistency. If the team considers that out of scope, those changes can be reverted — let me know.
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What/Why?
Renames all references to "Trace ID" in the Native Hosting CLI to "Correlation ID" for consistency with the
X-Correlation-IdHTTP header already used in API requests.Changes span both
@bigcommerce/catalystandcreate-catalyst:sessionIdproperty tocorrelationIdin both Telemetry classessessionId→correlationId)Internal docs update for
bigcommerce/documentationis in a separate PR: https://github.com/bigcommerce/documentation/pull/2370Testing
pnpm --filter @bigcommerce/catalyst test)sessionIdorTrace IDreferences — none foundX-Correlation-IdHTTP header name is unchangedMigration
No migration needed. This is a rename of internal property names and user-facing strings only.