Remove redundant separate data flags

Author: Luca Forstner

packages/nextjs/src/config/wrappers/withSentryGetServerSideProps.ts

@@ -44,14 +44,14 @@ export function withSentryGetServerSideProps(
       if ('props' in serverSideProps) {
         const requestTransaction = getTransactionFromRequest(req);
         if (requestTransaction) {
-          serverSideProps.props._sentryGetServerSidePropsTraceData = requestTransaction.toTraceparent();
-          serverSideProps.props._sentryGetServerSidePropsBaggage = serializeBaggage(requestTransaction.getBaggage());
+          serverSideProps.props._sentryTraceData = requestTransaction.toTraceparent();
+          serverSideProps.props._sentryBaggage = serializeBaggage(requestTransaction.getBaggage());
         }
       }
 
       return serverSideProps;
     } else {
-      return origGetServerSideProps(...getServerSidePropsArguments);
+      return errorWrappedGetServerSideProps(...getServerSidePropsArguments);
     }
   };
 }

packages/nextjs/src/config/wrappers/withSentryServerSideAppGetInitialProps.ts

@@ -33,8 +33,8 @@ export function withSentryServerSideAppGetInitialProps(origAppGetInitialProps: A
       // `res` are always defined: https://nextjs.org/docs/api-reference/data-fetching/get-initial-props#context-object
       const appGetInitialProps: {
         pageProps: {
-          _sentryGetInitialPropsTraceData?: string;
-          _sentryGetInitialPropsBaggage?: string;
+          _sentryTraceData?: string;
+          _sentryBaggage?: string;
         };
       } = await callTracedServerSideDataFetcher(
         errorWrappedAppGetInitialProps,
@@ -50,8 +50,8 @@ export function withSentryServerSideAppGetInitialProps(origAppGetInitialProps: A
 
       const requestTransaction = getTransactionFromRequest(req!);
       if (requestTransaction) {
-        appGetInitialProps.pageProps._sentryGetInitialPropsTraceData = requestTransaction.toTraceparent();
-        appGetInitialProps.pageProps._sentryGetInitialPropsBaggage = serializeBaggage(requestTransaction.getBaggage());
+        appGetInitialProps.pageProps._sentryTraceData = requestTransaction.toTraceparent();
+        appGetInitialProps.pageProps._sentryBaggage = serializeBaggage(requestTransaction.getBaggage());
       }
 
       return appGetInitialProps;

packages/nextjs/src/config/wrappers/withSentryServerSideErrorGetInitialProps.ts

@@ -35,8 +35,8 @@ export function withSentryServerSideErrorGetInitialProps(
       // Since this wrapper is only applied to `getInitialProps` running on the server, we can assert that `req` and
       // `res` are always defined: https://nextjs.org/docs/api-reference/data-fetching/get-initial-props#context-object
       const errorGetInitialProps: ErrorProps & {
-        _sentryGetInitialPropsTraceData?: string;
-        _sentryGetInitialPropsBaggage?: string;
+        _sentryTraceData?: string;
+        _sentryBaggage?: string;
       } = await callTracedServerSideDataFetcher(
         errorWrappedGetInitialProps,
         errorGetInitialPropsArguments,
@@ -51,8 +51,8 @@ export function withSentryServerSideErrorGetInitialProps(
 
       const requestTransaction = getTransactionFromRequest(req!);
       if (requestTransaction) {
-        errorGetInitialProps._sentryGetInitialPropsTraceData = requestTransaction.toTraceparent();
-        errorGetInitialProps._sentryGetInitialPropsBaggage = serializeBaggage(requestTransaction.getBaggage());
+        errorGetInitialProps._sentryTraceData = requestTransaction.toTraceparent();
+        errorGetInitialProps._sentryBaggage = serializeBaggage(requestTransaction.getBaggage());
       }
 
       return errorGetInitialProps;

packages/nextjs/src/config/wrappers/withSentryServerSideGetInitialProps.ts

@@ -31,8 +31,8 @@ export function withSentryServerSideGetInitialProps(origGetInitialProps: GetInit
       // Since this wrapper is only applied to `getInitialProps` running on the server, we can assert that `req` and
       // `res` are always defined: https://nextjs.org/docs/api-reference/data-fetching/get-initial-props#context-object
       const initialProps: {
-        _sentryGetInitialPropsTraceData?: string;
-        _sentryGetInitialPropsBaggage?: string;
+        _sentryTraceData?: string;
+        _sentryBaggage?: string;
       } = await callTracedServerSideDataFetcher(errorWrappedGetInitialProps, getInitialPropsArguments, req!, res!, {
         dataFetcherRouteName: context.pathname,
         requestedRouteName: context.pathname,
@@ -41,8 +41,8 @@ export function withSentryServerSideGetInitialProps(origGetInitialProps: GetInit
 
       const requestTransaction = getTransactionFromRequest(req!);
       if (requestTransaction) {
-        initialProps._sentryGetInitialPropsTraceData = requestTransaction.toTraceparent();
-        initialProps._sentryGetInitialPropsBaggage = serializeBaggage(requestTransaction.getBaggage());
+        initialProps._sentryTraceData = requestTransaction.toTraceparent();
+        initialProps._sentryBaggage = serializeBaggage(requestTransaction.getBaggage());
       }
 
       return initialProps;

packages/nextjs/src/performance/client.ts

@@ -24,17 +24,12 @@ type StartTransactionCb = (context: TransactionContext) => Transaction | undefin
 interface SentryEnhancedNextData extends NextData {
   props: {
     pageProps?: {
-      _sentryGetInitialPropsTraceData?: string; // trace parent info, if injected by server-side `getInitialProps`
-      _sentryGetInitialPropsBaggage?: string; // baggage, if injected by server-side `getInitialProps`
-      _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:
+      _sentryTraceData?: string; // trace parent info, if injected by a data-fetcher
+      _sentryBaggage?: string; // baggage, if injected by a data-fetcher
+      // These two values are only injected by `getStaticProps` 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`
     };
   };
 }
@@ -85,24 +80,12 @@ function extractNextDataTagInformation(): NextDataTagInfo {
   nextDataTagInfo.params = query;
 
   if (props && props.pageProps) {
-    const pageProps = props.pageProps;
-    const getInitialPropsBaggage = pageProps._sentryGetInitialPropsBaggage;
-    const getServerSidePropsBaggage = pageProps._sentryGetServerSidePropsBaggage;
-    const getStaticPropsBaggage = 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;
+    if (props.pageProps._sentryBaggage) {
+      nextDataTagInfo.baggage = props.pageProps._sentryBaggage;
     }
 
-    const getInitialPropsTraceData = pageProps._sentryGetInitialPropsTraceData;
-    const getServerSidePropsTraceData = pageProps._sentryGetServerSidePropsTraceData;
-    const getStaticPropsTraceData = 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);
+    if (props.pageProps._sentryTraceData) {
+      nextDataTagInfo.traceParentData = extractTraceparentData(props.pageProps._sentryTraceData);
     }
   }
 

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

@@ -90,9 +90,8 @@ describe('client', () => {
         { user: 'lforst', id: '1337', q: '42' },
         {
           pageProps: {
-            _sentryGetInitialPropsTraceData: 'c82b8554881b4d28ad977de04a4fb40a-a755953cd3394d5f-1',
-            _sentryGetInitialPropsBaggage:
-              'other=vendor,foo=bar,third=party,last=item,sentry-release=2.1.0,sentry-environment=myEnv',
+            _sentryTraceData: 'c82b8554881b4d28ad977de04a4fb40a-a755953cd3394d5f-1',
+            _sentryBaggage: 'other=vendor,foo=bar,third=party,last=item,sentry-release=2.1.0,sentry-environment=myEnv',
           },
         },
         true,
@@ -112,46 +111,18 @@ describe('client', () => {
         },
       ],
       [
-        'https://example.com/dynamic',
-        '/dynamic',
+        'https://example.com/some-page',
+        '/some-page',
         {},
         {
           pageProps: {
-            _sentryGetServerSidePropsTraceData: 'c82b8554881b4d28ad977de04a4fb40a-a755953cd3394d5f-1',
-            _sentryGetServerSidePropsBaggage:
-              'other=vendor,foo=bar,third=party,last=item,sentry-release=2.1.0,sentry-environment=myEnv',
+            _sentryTraceData: 'c82b8554881b4d28ad977de04a4fb40a-a755953cd3394d5f-1',
+            _sentryBaggage: 'other=vendor,foo=bar,third=party,last=item,sentry-release=2.1.0,sentry-environment=myEnv',
           },
         },
         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',
+          name: '/some-page',
           op: 'pageload',
           tags: {
             'routing.instrumentation': 'next-router',