From 46441387be1e08ef264a6bf35767ad6bf14027cb Mon Sep 17 00:00:00 2001
From: Jiachi Liu <inbox@huozhi.im>
Date: Thu, 13 Jun 2024 21:58:01 +0200
Subject: [PATCH] Fix: only inject clientTraceMetadata into html page once
 (#66763)

---
 .../make-get-server-inserted-html.tsx         | 35 +++++++++----------
 .../app/suspense/client.tsx                   | 12 +++++++
 .../app/suspense/page.tsx                     | 26 ++++++++++++++
 .../client-trace-metadata.test.ts             |  6 ++++
 4 files changed, 61 insertions(+), 18 deletions(-)
 create mode 100644 test/e2e/opentelemetry/client-trace-metadata/app/suspense/client.tsx
 create mode 100644 test/e2e/opentelemetry/client-trace-metadata/app/suspense/page.tsx

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
index 566db4b517..fa6e1b8b2d 100644
--- 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
@@ -33,7 +33,12 @@ export function makeGetServerInsertedHTML({
   basePath: string
 }) {
   let flushedErrorMetaTagsUntilIndex = 0
-  let hasUnflushedPolyfills = polyfills.length !== 0
+  // flag for static content that only needs to be flushed once
+  let hasFlushedInitially = false
+
+  const polyfillTags = polyfills.map((polyfill) => {
+    return <script key={polyfill.src} {...polyfill} />
+  })
 
   return async function getServerInsertedHTML() {
     // Loop through all the errors that have been captured but not yet
@@ -71,11 +76,18 @@ export function makeGetServerInsertedHTML({
       }
     }
 
+    const traceMetaTags = (tracingMetadata || []).map(
+      ({ key, value }, index) => (
+        <meta key={`next-trace-data-${index}`} name={key} content={value} />
+      )
+    )
+
     const serverInsertedHTML = renderServerInsertedHTML()
 
     // Skip React rendering if we know the content is empty.
     if (
-      !hasUnflushedPolyfills &&
+      polyfillTags.length === 0 &&
+      traceMetaTags.length === 0 &&
       errorMetaTags.length === 0 &&
       Array.isArray(serverInsertedHTML) &&
       serverInsertedHTML.length === 0
@@ -87,23 +99,10 @@ export function makeGetServerInsertedHTML({
       <>
         {
           /* Insert the polyfills if they haven't been flushed yet. */
-          hasUnflushedPolyfills &&
-            polyfills.map((polyfill) => {
-              return <script key={polyfill.src} {...polyfill} />
-            })
+          hasFlushedInitially ? null : polyfillTags
         }
         {serverInsertedHTML}
-        {tracingMetadata
-          ? tracingMetadata.map(({ key, value }) => {
-              return (
-                <meta
-                  key={`next-trace-data-${key}:${value}`}
-                  name={key}
-                  content={value}
-                />
-              )
-            })
-          : null}
+        {hasFlushedInitially ? null : traceMetaTags}
         {errorMetaTags}
       </>,
       {
@@ -113,7 +112,7 @@ export function makeGetServerInsertedHTML({
       }
     )
 
-    hasUnflushedPolyfills = false
+    hasFlushedInitially = true
 
     // There's no need to wait for the stream to be ready
     // e.g. calling `await stream.allReady` because `streamToString` will
diff --git a/test/e2e/opentelemetry/client-trace-metadata/app/suspense/client.tsx b/test/e2e/opentelemetry/client-trace-metadata/app/suspense/client.tsx
new file mode 100644
index 0000000000..b4c99d7f1f
--- /dev/null
+++ b/test/e2e/opentelemetry/client-trace-metadata/app/suspense/client.tsx
@@ -0,0 +1,12 @@
+'use client'
+
+import { useServerInsertedHTML } from 'next/navigation'
+
+export function Client() {
+  useServerInsertedHTML(() => (
+    <>
+      <meta name="client-inserted-key" content="client-inserted-value" />
+    </>
+  ))
+  return null
+}
diff --git a/test/e2e/opentelemetry/client-trace-metadata/app/suspense/page.tsx b/test/e2e/opentelemetry/client-trace-metadata/app/suspense/page.tsx
new file mode 100644
index 0000000000..7a34e06829
--- /dev/null
+++ b/test/e2e/opentelemetry/client-trace-metadata/app/suspense/page.tsx
@@ -0,0 +1,26 @@
+import React, { Suspense } from 'react'
+import { Client } from './client'
+
+async function Component() {
+  await new Promise((resolve) => setTimeout(resolve, 200))
+  return (
+    <div>
+      <h1>Component</h1>
+      <Client />
+    </div>
+  )
+}
+
+function Suspensey() {
+  return (
+    <Suspense fallback={<div>Loading...</div>}>
+      <Component />
+    </Suspense>
+  )
+}
+
+export default function Page() {
+  return <Suspensey />
+}
+
+export const dynamic = 'force-dynamic'
diff --git a/test/e2e/opentelemetry/client-trace-metadata/client-trace-metadata.test.ts b/test/e2e/opentelemetry/client-trace-metadata/client-trace-metadata.test.ts
index 0300ba638e..8fb392f9c9 100644
--- a/test/e2e/opentelemetry/client-trace-metadata/client-trace-metadata.test.ts
+++ b/test/e2e/opentelemetry/client-trace-metadata/client-trace-metadata.test.ts
@@ -37,6 +37,12 @@ describe('clientTraceMetadata', () => {
     expect(firstLoadSpanIdContent).not.toBe(secondLoadSpanIdContent)
   })
 
+  it('should only insert the client trace metadata once', async () => {
+    const html = await next.render('/suspense')
+    const matches = html.match(/meta name="my-test-key-1"/g)
+    expect(matches.length).toBe(1)
+  })
+
   if (isNextDev) {
     describe('next dev only', () => {
       it('should inject propagation data for a statically server-side-rendered page', async () => {