Add comment clarifying the purpose of the _next-trace-data- prefix

vercel · Apr 18, 2024 · 2c463e7 · 2c463e7
1 parent 28f7a33
commit 2c463e7
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/next/src/server/app-render/make-get-server-inserted-html.tsx b/packages/next/src/server/app-render/make-get-server-inserted-html.tsx
@@ -85,6 +85,9 @@ export function makeGetServerInsertedHTML({
             })
         }
         {traceData.map(({ key, value }) => {
+          // The meta-tag name is prefixed with "_next-trace-data-" for mainly two reasons:
+          // - Avoid collisions with meta tags created by the user
+          // - Allow clients that want to propagate _all_ trace data to explicitly query for meta tags prefixed with "_next-trace-data-"
           return (
             <meta key={key} name={`_next-trace-data-${key}`} content={value} />
           )