feat(profiling): allow collecting of profiles that started before sentry had loaded

Author: JonasBa

packages/browser/src/profiling/hubextensions.ts

@@ -174,7 +174,7 @@ export function wrapTransactionWithProfiling(transaction: Transaction): Transact
 
     return profiler
       .stop()
-      .then((p: JSSelfProfile): null => {
+      .then((profile: JSSelfProfile): null => {
         if (maxDurationTimeoutID) {
           WINDOW.clearTimeout(maxDurationTimeoutID);
           maxDurationTimeoutID = undefined;
@@ -185,7 +185,7 @@ export function wrapTransactionWithProfiling(transaction: Transaction): Transact
         }
 
         // In case of an overlapping transaction, stopProfiling may return null and silently ignore the overlapping profile.
-        if (!p) {
+        if (!profile) {
           if (__DEBUG_BUILD__) {
             logger.log(
               `[Profiling] profiler returned null profile for: ${transaction.name || transaction.description}`,
@@ -195,7 +195,7 @@ export function wrapTransactionWithProfiling(transaction: Transaction): Transact
           return null;
         }
 
-        addProfileToMap(profileId, p);
+        addProfileToMap(profileId, profile);
         return null;
       })
       .catch(error => {

packages/browser/src/profiling/integration.ts

@@ -53,23 +53,33 @@ export class BrowserProfilingIntegration implements Integration {
       // automated page load profile id so that it will get picked up by the beforeEnvelope hook.
       const pageLoadProfile = getAutomatedPageLoadProfile(carrier);
       if (pageLoadProfile) {
+        // @TODO JonasB: remove finishTransaction listener if carrier.profiles is empty
         client.on('finishTransaction', (transaction: Transaction) => {
           if (!isAutomatedPageLoadTransaction(transaction)) {
             return;
           }
 
+          if (pageLoadProfile.stopped) {
+            __DEBUG_BUILD__ &&
+              logger.log(
+                `[Profiling] automated page load transaction already stopped, not stopping again: ${transaction.name ||
+                  transaction.description}`,
+              );
+            return;
+          }
+
           transaction.setContext('profile', { profile_id: AUTOMATED_PAGELOAD_PROFILE_ID });
           pageLoadProfile
             .stop()
-            .then((p: JSSelfProfile): null => {
+            .then((profile: JSSelfProfile): null => {
               if (__DEBUG_BUILD__) {
                 logger.log(
                   `[Profiling] stopped profiling of transaction: ${transaction.name || transaction.description}`,
                 );
               }
 
               // In case of an overlapping transaction, stopProfiling may return null and silently ignore the overlapping profile.
-              if (!p) {
+              if (!profile) {
                 if (__DEBUG_BUILD__) {
                   logger.log(
                     `[Profiling] profiler returned null profile for: ${transaction.name || transaction.description}`,
@@ -79,7 +89,7 @@ export class BrowserProfilingIntegration implements Integration {
                 return null;
               }
 
-              addProfileToMap(AUTOMATED_PAGELOAD_PROFILE_ID, p);
+              addProfileToMap(AUTOMATED_PAGELOAD_PROFILE_ID, profile);
               return null;
             })
             .catch(error => {

packages/browser/src/profiling/jsSelfProfiling.ts

@@ -26,14 +26,13 @@ export type JSSelfProfile = {
   samples: JSSelfProfileSample[];
 };
 
-type BufferFullCallback = (trace: JSSelfProfile) => void;
 
 export interface JSSelfProfiler {
   sampleInterval: number;
   stopped: boolean;
 
   stop: () => Promise<JSSelfProfile>;
-  addEventListener(event: 'samplebufferfull', callback: BufferFullCallback): void;
+  addEventListener(event: 'samplebufferfull', callback: (trace: JSSelfProfile) => void): void;
 }
 
 export declare const JSSelfProfilerConstructor: {

packages/browser/src/profiling/utils.ts

@@ -6,9 +6,8 @@ import type { Profile, ThreadCpuProfile } from '@sentry/types/src/profiling';
 import { browserPerformanceTimeOrigin, forEachEnvelopeItem, GLOBAL_OBJ, logger, uuid4 } from '@sentry/utils';
 
 import { WINDOW } from '../helpers';
-import type { JSSelfProfile, JSSelfProfileStack } from './jsSelfProfiling';
+import type { JSSelfProfile, JSSelfProfileStack, JSSelfProfiler } from './jsSelfProfiling';
 import type { Transaction } from '@sentry/types';
-import { JSSelfProfiler } from '../../build/npm/types/profiling/jsSelfProfiling';
 
 const MS_TO_NS = 1e6;
 // Use 0 as main thread id which is identical to threadId in node:worker_threads
@@ -192,6 +191,9 @@ export function isProfiledTransactionEvent(event: Event): event is ProfiledEvent
   return !!(event.sdkProcessingMetadata && event.sdkProcessingMetadata['profile']);
 }
 
+/**
+ *  Returns the automated page load profile from the carrier if it exists and removes the reference to it.
+ */
 export function getAutomatedPageLoadProfile(carrier: Carrier): JSSelfProfiler | undefined {
   const __SENTRY__ = carrier.__SENTRY__;
   if (
@@ -211,7 +213,6 @@ export function getAutomatedPageLoadProfile(carrier: Carrier): JSSelfProfiler |
   See packages/tracing-internal/src/browser/router.ts
 */
 export function isAutomatedPageLoadTransaction(transaction: Transaction): boolean {
-  // @ts-expect-error origin seems untyped
   return transaction.op === 'pageload' && transaction.origin === AUTOMATED_PAGELOAD_PROFILE_ID
 }
 

packages/core/src/hub.ts

@@ -25,7 +25,6 @@ import { consoleSandbox, dateTimestampInSeconds, getGlobalSingleton, GLOBAL_OBJ,
 import { DEFAULT_ENVIRONMENT } from './constants';
 import { Scope } from './scope';
 import { closeSession, makeSession, updateSession } from './session';
-import type { JSSelfProfiler } from '@sentry/browser';
 
 /**
  * API compatibility version of this hub.
@@ -91,7 +90,10 @@ export interface Carrier {
       [key: string]: Function;
     };
     profiling?: {
-      profiles?: Record<"auto.pageload.browser", JSSelfProfiler>;
+      /*
+       * Stores profile started before SDK was initialized
+      */
+      profiles?: Record<"auto.pageload.browser", any>;
     }
   };
 }