Add support for getStaticProps tracing

Author: Luca Forstner

packages/nextjs/src/performance/client.ts

@@ -29,6 +29,13 @@ interface SentryEnhancedNextData extends NextData {
     pageProps?: {
       _sentryGetServerSidePropsTraceData?: string; // trace parent info, if injected by server-side `getServerSideProps`
       _sentryGetServerSidePropsBaggage?: string; // baggage, if injected by server-side `getServerSideProps`
+
+      // The following two values are only injected in a very special case with the following conditions:
+      // 1. The page's `getStaticPaths` method must have returned `fallback: 'blocking'`.
+      // 2. The requested page must be a "miss" in terms of "Incremental Static Regeneration", meaning the requested page has not been generated before.
+      // In this case, a page is requested and only served when `getStaticProps` is done. There is not even a fallback page or similar.
+      _sentryGetStaticPropsTraceData?: string; // trace parent info, if injected by server-side `getStaticProps`
+      _sentryGetStaticPropsBaggage?: string; // baggage, if injected by server-side `getStaticProps`
     };
   };
 }
@@ -81,16 +88,18 @@ function extractNextDataTagInformation(): NextDataTagInfo {
 
     const getInitialPropsBaggage = props._sentryGetInitialPropsBaggage;
     const getServerSidePropsBaggage = pageProps && pageProps._sentryGetServerSidePropsBaggage;
-    // Ordering of the following shouldn't matter but `getInitialProps` generally runs before `getServerSideProps` so we give it priority.
-    const baggage = getInitialPropsBaggage || getServerSidePropsBaggage;
+    const getStaticPropsBaggage = pageProps && pageProps._sentryGetStaticPropsBaggage;
+    // Ordering of the following shouldn't matter but `getInitialProps` generally runs before `getServerSideProps` or `getStaticProps` so we give it priority.
+    const baggage = getInitialPropsBaggage || getServerSidePropsBaggage || getStaticPropsBaggage;
     if (baggage) {
       nextDataTagInfo.baggage = baggage;
     }
 
     const getInitialPropsTraceData = props._sentryGetInitialPropsTraceData;
     const getServerSidePropsTraceData = pageProps && pageProps._sentryGetServerSidePropsTraceData;
-    // Ordering of the following shouldn't matter but `getInitialProps` generally runs before `getServerSideProps` so we give it priority.
-    const traceData = getInitialPropsTraceData || getServerSidePropsTraceData;
+    const getStaticPropsTraceData = pageProps && pageProps._sentryGetStaticPropsTraceData;
+    // Ordering of the following shouldn't matter but `getInitialProps` generally runs before `getServerSideProps` or `getStaticProps` so we give it priority.
+    const traceData = getInitialPropsTraceData || getServerSidePropsTraceData || getStaticPropsTraceData;
     if (traceData) {
       nextDataTagInfo.traceParentData = extractTraceparentData(traceData);
     }

packages/nextjs/test/performance/client.test.ts

@@ -107,8 +107,8 @@ describe('client', () => {
         },
       ],
       [
-        'https://example.com/static',
-        '/static',
+        'https://example.com/dynamic',
+        '/dynamic',
         {},
         {
           pageProps: {
@@ -118,6 +118,33 @@ describe('client', () => {
           },
         },
         true,
+        {
+          name: '/dynamic',
+          op: 'pageload',
+          tags: {
+            'routing.instrumentation': 'next-router',
+          },
+          metadata: {
+            source: 'route',
+            baggage: [{ environment: 'myEnv', release: '2.1.0' }, '', true],
+          },
+          traceId: 'c82b8554881b4d28ad977de04a4fb40a',
+          parentSpanId: 'a755953cd3394d5f',
+          parentSampled: true,
+        },
+      ],
+      [
+        'https://example.com/static',
+        '/static',
+        {},
+        {
+          pageProps: {
+            _sentryGetStaticPropsTraceData: 'c82b8554881b4d28ad977de04a4fb40a-a755953cd3394d5f-1',
+            _sentryGetStaticPropsBaggage:
+              'other=vendor,foo=bar,third=party,last=item,sentry-release=2.1.0,sentry-environment=myEnv',
+          },
+        },
+        true,
         {
           name: '/static',
           op: 'pageload',