Added trace state data header extraction from GCP function requests and injection into transaction logic + test changes

Author: ahmedetefy

packages/serverless/src/gcpfunction/http.ts

@@ -1,5 +1,5 @@
 import { captureException, flush, getCurrentHub, Handlers, startTransaction } from '@sentry/node';
-import { extractTraceparentData } from '@sentry/tracing';
+import { extractSentrytraceData, extractTracestateData } from '@sentry/tracing';
 import { isString, logger, stripUrlQueryAndFragment } from '@sentry/utils';
 
 import { domainify, getActiveDomain, proxyFunction } from './../utils';
@@ -50,15 +50,22 @@ function _wrapHttpFunction(fn: HttpFunction, wrapOptions: Partial<HttpFunctionWr
     const reqUrl = stripUrlQueryAndFragment(req.originalUrl || req.url || '');
 
     // Applying `sentry-trace` to context
-    let traceparentData;
+    let traceparentData, tracestateData;
     const reqWithHeaders = req as { headers?: { [key: string]: string } };
     if (reqWithHeaders.headers && isString(reqWithHeaders.headers['sentry-trace'])) {
-      traceparentData = extractTraceparentData(reqWithHeaders.headers['sentry-trace'] as string);
+      traceparentData = extractSentrytraceData(reqWithHeaders.headers['sentry-trace'] as string);
     }
+    if (reqWithHeaders.headers?.tracestate) {
+      tracestateData = extractTracestateData(reqWithHeaders.headers.tracestate as string);
+    }
+
     const transaction = startTransaction({
       name: `${reqMethod} ${reqUrl}`,
       op: 'gcp.function.http',
       ...traceparentData,
+      // ToDo check with Katie if this should be here even if undefined
+      // metadata: { tracestate: tracestateData },
+      ...(tracestateData && { metadata: { tracestate: tracestateData } }),
     });
 
     // getCurrentHub() is expected to use current active domain as a carrier

packages/serverless/test/gcpfunction.test.ts

@@ -131,6 +131,7 @@ describe('GCPFunction', () => {
 
       const trace_headers: { [key: string]: string } = {
         'sentry-trace': '12312012123120121231201212312012-1121201211212012-0',
+        tracestate: 'sentry=doGsaREgReaT,maisey=silly,charlie=goofy',
       };
 
       await handleHttp(wrappedHandler, trace_headers);
@@ -140,6 +141,12 @@ describe('GCPFunction', () => {
         traceId: '12312012123120121231201212312012',
         parentSpanId: '1121201211212012',
         parentSampled: false,
+        metadata: {
+          tracestate: {
+            sentry: 'sentry=doGsaREgReaT',
+            thirdparty: 'maisey=silly,charlie=goofy',
+          },
+        },
       });
       // @ts-ignore see "Why @ts-ignore" note
       expect(Sentry.fakeScope.setSpan).toBeCalledWith(Sentry.fakeTransaction);