Skip to content

refactor(cli): rename "trace id" to "correlation id"#2962

Merged
matthewvolk merged 1 commit intoalphafrom
TRAC-309-correlation-id
Mar 30, 2026
Merged

refactor(cli): rename "trace id" to "correlation id"#2962
matthewvolk merged 1 commit intoalphafrom
TRAC-309-correlation-id

Conversation

@matthewvolk
Copy link
Copy Markdown
Contributor

@matthewvolk matthewvolk commented Mar 30, 2026

What/Why?

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 user-facing error output ("Trace ID" → "Correlation ID")
  • Update Segment event property name (sessionIdcorrelationId)
  • 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 sessionIdcorrelationId in create-catalyst's Telemetry class for consistency. If the team considers that out of scope, those changes can be reverted — let me know.

Internal docs update for bigcommerce/documentation is in a separate PR: https://github.com/bigcommerce/documentation/pull/2370

Testing

  • All 126 existing tests pass (pnpm --filter @bigcommerce/catalyst test)
  • Grepped both packages for any remaining sessionId or Trace ID references — none found
  • X-Correlation-Id HTTP header name is unchanged

Migration

No migration needed. This is a rename of internal property names and user-facing strings only.

@matthewvolk matthewvolk requested a review from a team as a code owner March 30, 2026 18:51
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 30, 2026

⚠️ No Changeset found

Latest commit: a9217a0

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

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 30, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
catalyst Ready Ready Preview, Comment Mar 30, 2026 6:53pm

Request Review

@github-actions
Copy link
Copy Markdown
Contributor

Bundle Size Report

Comparing against baseline from 4870221 (2026-03-30).

No bundle size changes detected.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 30, 2026

Unlighthouse Performance Comparison — Vercel

Comparing PR preview deployment Unlighthouse scores vs production Unlighthouse scores.

Summary Score

Aggregate score across all categories as reported by Unlighthouse.

Prod Desktop Prod Mobile Preview Desktop Preview Mobile
Score 92 93 91 94

Category Scores

Category Prod Desktop Prod Mobile Preview Desktop Preview Mobile
Performance 73 88 77 99
Accessibility 95 91 95 98
Best Practices 100 100 95 100
SEO 100 88 100 100

Core Web Vitals

Metric Prod Desktop Prod Mobile Preview Desktop Preview Mobile
LCP 5.0 s 3.9 s 3.5 s 1.8 s
CLS 0.037 0.001 0 0
FCP 1.1 s 1.1 s 1.2 s 1.2 s
TBT 0 ms 10 ms 0 ms 20 ms
Max Potential FID 50 ms 80 ms 50 ms 80 ms
Time to Interactive 5.0 s 4.4 s 3.6 s 2.8 s

Full Unlighthouse report →

@matthewvolk matthewvolk merged commit 07c94b7 into alpha Mar 30, 2026
16 checks passed
@matthewvolk matthewvolk deleted the TRAC-309-correlation-id branch March 30, 2026 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants