make it work with legacy stuff...

Author: mydea

packages/ember/addon/instance-initializers/sentry-performance.ts

@@ -29,12 +29,11 @@ export function initialize(appInstance: ApplicationInstance): void {
   if (config['disablePerformance']) {
     return;
   }
-  const performancePromise = instrumentForPerformance(appInstance);
-  if (macroCondition(isTesting())) {
-    (window as typeof window & { _sentryPerformanceLoad?: Promise<void> })._sentryPerformanceLoad = performancePromise;
-  }
+  instrumentForPerformance(appInstance);
+
 }
 
 export default {
   initialize,
+  name: 'sentry-performance',
 };

packages/ember/addon/utils/browserTracingIntegration.ts

@@ -1,14 +1,45 @@
-import { browserTracingIntegration as originalBrowserTracingIntegration } from '@sentry/browser';
+import {
+  browserTracingIntegration as originalBrowserTracingIntegration,
+  startBrowserTracingNavigationSpan,
+  startBrowserTracingPageLoadSpan,
+} from '@sentry/browser';
 import type { Integration } from '@sentry/core';
 import type ApplicationInstance from '@ember/application/instance';
+import { instrumentEmberAppInstanceForPerformance } from './performance';
 
 type EmberBrowserTracingIntegrationOptions = Parameters<typeof originalBrowserTracingIntegration>[0] & {
   appInstance: ApplicationInstance;
 };
 
 export function browserTracingIntegration(options: EmberBrowserTracingIntegrationOptions): Integration {
-  return originalBrowserTracingIntegration({
+  const { appInstance } = options;
+
+  const instrumentNavigation = options.instrumentNavigation ?? true;
+  const instrumentPageLoad = options.instrumentPageLoad ?? true;
+
+  const integration = originalBrowserTracingIntegration({
     ...options,
     instrumentNavigation: false,
+    instrumentPageLoad: false,
   });
+
+  const config = {
+    disableRunloopPerformance: false,
+    instrumentPageLoad,
+    instrumentNavigation
+  };
+
+  return {
+    ...integration,
+    afterAllSetup(client) {
+      integration.afterAllSetup(client);
+
+      instrumentEmberAppInstanceForPerformance(
+        appInstance,
+        config,
+        startBrowserTracingPageLoadSpan,
+        startBrowserTracingNavigationSpan,
+      );
+    },
+  };
 }

packages/ember/addon/utils/performance.ts

@@ -5,7 +5,7 @@ import type Transition from '@ember/routing/-private/transition';
 import type RouterService from '@ember/routing/router-service';
 import { _backburner, run, scheduleOnce } from '@ember/runloop';
 import type { EmberRunQueues } from '@ember/runloop/-private/types';
-import { getOwnConfig, isTesting, macroCondition } from '@embroider/macros';
+import { getOwnConfig, importSync, isTesting, macroCondition } from '@embroider/macros';
 import type {
   BrowserClient,
   startBrowserTracingNavigationSpan as startBrowserTracingNavigationSpanType,
@@ -22,6 +22,7 @@ import type { Span } from '@sentry/core';
 import { addIntegration, browserPerformanceTimeOrigin, GLOBAL_OBJ, timestampInSeconds } from '@sentry/core';
 import type { ExtendedBackburner } from '@sentry/ember/runloop';
 import type { EmberRouterMain, EmberSentryConfig, GlobalConfig, OwnConfig } from '../types';
+import type { browserTracingIntegration as browserTracingIntegrationType } from './browserTracingIntegration';
 
 function getSentryConfig(): EmberSentryConfig {
   const _global = GLOBAL_OBJ as typeof GLOBAL_OBJ & GlobalConfig;
@@ -84,17 +85,15 @@ export function _getLocationURL(location: EmberRouterMain['location']): string {
 export function _instrumentEmberRouter(
   routerService: RouterService,
   routerMain: EmberRouterMain,
-  config: EmberSentryConfig,
+  config: { disableRunloopPerformance?: boolean; instrumentPageLoad?: boolean; instrumentNavigation?: boolean },
   startBrowserTracingPageLoadSpan: typeof startBrowserTracingPageLoadSpanType,
   startBrowserTracingNavigationSpan: typeof startBrowserTracingNavigationSpanType,
 ): void {
-  const { disableRunloopPerformance } = config;
+  const { disableRunloopPerformance, instrumentPageLoad, instrumentNavigation } = config;
   const location = routerMain.location;
   let activeRootSpan: Span | undefined;
   let transitionSpan: Span | undefined;
 
-  // Maintaining backwards compatibility with config.browserTracingOptions, but passing it with Sentry options is preferred.
-  const browserTracingOptions = config.browserTracingOptions || config.sentry.browserTracingOptions || {};
   const url = _getLocationURL(location);
 
   const client = getClient<BrowserClient>();
@@ -103,7 +102,7 @@ export function _instrumentEmberRouter(
     return;
   }
 
-  if (url && browserTracingOptions.instrumentPageLoad !== false) {
+  if (url && instrumentPageLoad !== false) {
     const routeInfo = routerService.recognize(url);
     activeRootSpan = startBrowserTracingPageLoadSpan(client, {
       name: `route:${routeInfo.name}`,
@@ -124,7 +123,7 @@ export function _instrumentEmberRouter(
     getBackburner().off('end', finishActiveTransaction);
   };
 
-  if (browserTracingOptions.instrumentNavigation === false) {
+  if (instrumentNavigation === false) {
     return;
   }
 
@@ -407,32 +406,31 @@ function _hasPerformanceSupport(): { HAS_PERFORMANCE: boolean; HAS_PERFORMANCE_T
   };
 }
 
-export async function instrumentForPerformance(appInstance: ApplicationInstance): Promise<void> {
+export function instrumentForPerformance(appInstance: ApplicationInstance): void {
   const config = getSentryConfig();
   // Maintaining backwards compatibility with config.browserTracingOptions, but passing it with Sentry options is preferred.
   const browserTracingOptions = config.browserTracingOptions || config.sentry.browserTracingOptions || {};
 
-  const { browserTracingIntegration, startBrowserTracingNavigationSpan, startBrowserTracingPageLoadSpan } =
-    await import('@sentry/browser');
+  const { browserTracingIntegration } = importSync('./browserTracingIntegration') as {
+    browserTracingIntegration: typeof browserTracingIntegrationType;
+  };
 
   const idleTimeout = config.transitionTimeout || 5000;
 
   const browserTracing = browserTracingIntegration({
+    appInstance,
     idleTimeout,
     ...browserTracingOptions,
-    instrumentNavigation: false,
-    instrumentPageLoad: false,
   });
 
   const client = getClient<BrowserClient>();
-  const isAlreadyInitialized = macroCondition(isTesting()) ? !!client?.getIntegrationByName('BrowserTracing') : false;
+  const isAlreadyInitialized = macroCondition(isTesting()) && client?.getIntegrationByName('BrowserTracing');
   addIntegration(browserTracing);
 
-  // We _always_ call this, as it triggers the page load & navigation spans
-  _instrumentNavigation(appInstance, config, startBrowserTracingPageLoadSpan, startBrowserTracingNavigationSpan);
-
   // Skip instrumenting the stuff below again in tests, as these are not reset between tests
-  if (isAlreadyInitialized) {
+  if (isAlreadyInitialized && client) {
+    // Ensure this is re-run in tests even if the integration is already initialized
+    browserTracing.afterAllSetup?.(client);
     return;
   }
 
@@ -441,9 +439,9 @@ export async function instrumentForPerformance(appInstance: ApplicationInstance)
   _instrumentInitialLoad(config);
 }
 
-function _instrumentNavigation(
+export function instrumentEmberAppInstanceForPerformance(
   appInstance: ApplicationInstance,
-  config: EmberSentryConfig,
+  config: { disableRunloopPerformance?: boolean; instrumentPageLoad?: boolean; instrumentNavigation?: boolean },
   startBrowserTracingPageLoadSpan: typeof startBrowserTracingPageLoadSpanType,
   startBrowserTracingNavigationSpan: typeof startBrowserTracingNavigationSpanType,
 ): void {

packages/ember/app/instance-initializers/sentry-performance.js

@@ -1 +1 @@
-export { default, initialize } from '@sentry/ember/utils/performance';
+export { default, initialize } from '@sentry/ember/instance-initializers/sentry-performance';

packages/ember/tests/helpers/setup-sentry.ts

@@ -10,8 +10,7 @@ export type SentryTestContext = TestContext & {
 };
 
 export function setupSentryTest(hooks: NestedHooks): void {
-  hooks.beforeEach(async function (this: SentryTestContext) {
-    await window._sentryPerformanceLoad;
+  hooks.beforeEach(function (this: SentryTestContext) {
     window._sentryTestEvents = [];
     const errorMessages: string[] = [];
     this.errorMessages = errorMessages;

packages/ember/tests/test-helper.ts

@@ -9,7 +9,6 @@ import setupSinon from 'ember-sinon-qunit';
 declare global {
   interface Window {
     _sentryTestEvents: Sentry.Event[];
-    _sentryPerformanceLoad?: Promise<void>;
   }
 }