From 4bf7ac1e76461eb41152382d2fa729a8148548b2 Mon Sep 17 00:00:00 2001
From: Lukas Stracke <lukas.stracke@sentry.io>
Date: Fri, 26 Jul 2024 09:38:49 +0200
Subject: [PATCH] use own perofrmance observer to decouple from replay

---
 .../src/metrics/browserMetrics.ts             | 33 +++++++++++--------
 .../browser-utils/src/metrics/instrument.ts   |  4 ++-
 2 files changed, 23 insertions(+), 14 deletions(-)

diff --git a/packages/browser-utils/src/metrics/browserMetrics.ts b/packages/browser-utils/src/metrics/browserMetrics.ts
index 787091523a48..ad63fa731a37 100644
--- a/packages/browser-utils/src/metrics/browserMetrics.ts
+++ b/packages/browser-utils/src/metrics/browserMetrics.ts
@@ -38,6 +38,7 @@ import {
   startAndEndSpan,
   startStandaloneWebVitalSpan,
 } from './utils';
+import { onCLS } from './web-vitals/getCLS';
 import { getNavigationEntry } from './web-vitals/lib/getNavigationEntry';
 import { getVisibilityWatcher } from './web-vitals/lib/getVisibilityWatcher';
 import type { Metric } from './web-vitals/types';
@@ -242,29 +243,35 @@ export { startTrackingINP, registerInpInteractionListener } from './inp';
 
 /** Starts tracking the Cumulative Layout Shift on the current page. */
 function _trackCLS(sendAsStandaloneSpan: boolean): () => void {
+  if (sendAsStandaloneSpan) {
+    let sentSpan = false;
+    onCLS(metric => {
+      if (sentSpan) {
+        return;
+      }
+      const entry = metric.entries[metric.entries.length - 1];
+      if (!entry) {
+        return;
+      }
+      sendStandaloneClsSpan(metric, entry);
+      sentSpan = true;
+    });
+  }
+
   const cleanupClsCallback = addClsInstrumentationHandler(({ metric }) => {
     const entry = metric.entries[metric.entries.length - 1] as LayoutShift | undefined;
     if (!entry) {
       return;
     }
 
-    if (sendAsStandaloneSpan) {
-      sendStandaloneClsSpan(metric, entry);
-      // For now, we only emit one CLS span for the initial page load.
-      // Once we send this, we don't need to track CLS anymore.
-      setTimeout(() => {
-        cleanupClsCallback();
-      }, 0);
-    } else if (!sendAsStandaloneSpan) {
-      DEBUG_BUILD && logger.log(`[Measurements] Adding CLS ${metric.value}`);
-      _measurements['cls'] = { value: metric.value, unit: '' };
-      _clsEntry = entry as LayoutShift;
-    }
+    DEBUG_BUILD && logger.log(`[Measurements] Adding CLS ${metric.value}`);
+    _measurements['cls'] = { value: metric.value, unit: '' };
+    _clsEntry = entry as LayoutShift;
   }, true);
 
   return sendAsStandaloneSpan
     ? () => {
-        /* cleanup is already taken care of when sending a standalone span, so we just return a noop */
+        /* Cleanup for standalone span mode is handled in this function; returning a no-op */
       }
     : cleanupClsCallback;
 }
diff --git a/packages/browser-utils/src/metrics/instrument.ts b/packages/browser-utils/src/metrics/instrument.ts
index 8249c1ad8ba9..39292fb19b83 100644
--- a/packages/browser-utils/src/metrics/instrument.ts
+++ b/packages/browser-utils/src/metrics/instrument.ts
@@ -226,7 +226,9 @@ function instrumentCls(): StopListening {
       });
       _previousCls = metric;
     },
-    { reportAllChanges: false },
+    // We want the callback to be called whenever the CLS value updates.
+    // By default, the callback is only called when the tab goes to the background.
+    { reportAllChanges: true },
   );
 }