feat(core): add X-Correlation-ID header to all GraphQL requests (bigcommerce#2976)

* feat(core): add X-Correlation-ID header to all GraphQL requests

Each page render gets a stable UUID (via React.cache) that persists
across all fetches within the same render, enabling easier request
tracing in server logs.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(core): wrap correlation-id import in try/catch for config resolution

The dynamic import of correlation-id.ts fails during next.config.ts
resolution because React.cache is unavailable in that context. Wrap
in try/catch to match the existing pattern for next-intl/server.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* chore: change correlation-id changeset to patch

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: jorgemoya

.changeset/correlation-id-header.md

@@ -0,0 +1,5 @@
+---
+"@bigcommerce/catalyst-core": patch
+---
+
+Add X-Correlation-ID header to all GraphQL requests. Each page render gets a stable UUID that persists across all fetches within the same render, enabling easier request tracing in server logs.

core/client/correlation-id.ts

@@ -0,0 +1,3 @@
+import { cache } from 'react';
+
+export const getCorrelationId = cache(() => crypto.randomUUID());

core/client/index.ts

@@ -52,6 +52,14 @@ export const client = createClient({
     const requestHeaders: Record<string, string> = {};
     const locale = await getLocale();
 
+    try {
+      const { getCorrelationId } = await import('./correlation-id');
+
+      requestHeaders['X-Correlation-ID'] = getCorrelationId();
+    } catch {
+      // correlation-id imports React.cache which is unavailable during next.config.ts resolution
+    }
+
     if (fetchOptions?.cache && ['no-store', 'no-cache'].includes(fetchOptions.cache)) {
       const { headers } = await import('next/headers');
       const ipAddress = (await headers()).get('X-Forwarded-For');