@sentry/ember 11.0.0-alpha.0 → 11.0.0-alpha.2

package/addon/index.ts

@@ -1,117 +0,0 @@
-// import/export got a false positive, and affects most of our index barrel files
-// can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703
-/* eslint-disable import/export */
-import { assert } from '@ember/debug';
-import type Route from '@ember/routing/route';
-import { getOwnConfig } from '@embroider/macros';
-import { CODE_FUNCTION_NAME, SENTRY_OP } from '@sentry/conventions/attributes';
-import { GENERAL_FUNCTION_SPAN_OP } from '@sentry/conventions/op';
-import type { BrowserOptions } from '@sentry/browser';
-import { startSpan } from '@sentry/browser';
-import * as Sentry from '@sentry/browser';
-import type { Client, TransactionSource } from '@sentry/core';
-import {
-  applySdkMetadata,
-  GLOBAL_OBJ,
-  SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
-  SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
-} from '@sentry/core';
-import type { EmberSentryConfig, GlobalConfig, OwnConfig } from './types';
-
-function _getSentryInitConfig(): EmberSentryConfig['sentry'] {
-  const _global = GLOBAL_OBJ as typeof GLOBAL_OBJ & GlobalConfig;
-  _global.__sentryEmberConfig = _global.__sentryEmberConfig ?? {};
-  return _global.__sentryEmberConfig;
-}
-
-/**
- * Initialize the Sentry SDK for Ember.
- */
-export function init(_runtimeConfig?: BrowserOptions): Client | undefined {
-  const environmentConfig = getOwnConfig<OwnConfig>().sentryConfig;
-
-  assert('Missing configuration.', environmentConfig);
-  assert('Missing configuration for Sentry.', environmentConfig.sentry || _runtimeConfig);
-
-  if (!environmentConfig.sentry) {
-    // If environment config is not specified but the above assertion passes, use runtime config.
-    environmentConfig.sentry = { ..._runtimeConfig };
-  }
-
-  // Merge runtime config into environment config, preferring runtime.
-  Object.assign(environmentConfig.sentry, _runtimeConfig || {});
-  const initConfig = Object.assign({}, environmentConfig.sentry);
-
-  applySdkMetadata(initConfig, 'ember');
-
-  // Persist Sentry init options so they are identical when performance initializers call init again.
-  const sentryInitConfig = _getSentryInitConfig();
-  Object.assign(sentryInitConfig, initConfig);
-
-  return Sentry.init(initConfig);
-}
-
-type RouteConstructor = new (...args: ConstructorParameters<typeof Route>) => Route;
-
-export const instrumentRoutePerformance = <T extends RouteConstructor>(BaseRoute: T): T => {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const instrumentFunction = async <X extends (...args: unknown[]) => any>(
-    hookName: string,
-    name: string,
-    fn: X,
-    args: Parameters<X>,
-    source: TransactionSource,
-  ): Promise<ReturnType<X>> => {
-    return startSpan(
-      {
-        attributes: {
-          [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: source,
-          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.ember',
-          [SENTRY_OP]: GENERAL_FUNCTION_SPAN_OP,
-          [CODE_FUNCTION_NAME]: hookName,
-        },
-        name,
-        onlyIfParent: true,
-      },
-      () => {
-        return fn(...args);
-      },
-    );
-  };
-
-  const routeName = BaseRoute.name;
-
-  return {
-    // @ts-expect-error TS2545 We do not need to redefine a constructor here
-    [routeName]: class extends BaseRoute {
-      public beforeModel(...args: unknown[]): void | Promise<unknown> {
-        return instrumentFunction('beforeModel', this.fullRouteName, super.beforeModel.bind(this), args, 'custom');
-      }
-
-      public async model(...args: unknown[]): Promise<unknown> {
-        return instrumentFunction('model', this.fullRouteName, super.model.bind(this), args, 'custom');
-      }
-
-      public afterModel(...args: unknown[]): void | Promise<unknown> {
-        return instrumentFunction('afterModel', this.fullRouteName, super.afterModel.bind(this), args, 'custom');
-      }
-
-      public setupController(...args: unknown[]): void | Promise<unknown> {
-        return instrumentFunction(
-          'setupController',
-          this.fullRouteName,
-          super.setupController.bind(this),
-          args,
-          'custom',
-        );
-      }
-    },
-  }[routeName] as T;
-};
-
-export * from '@sentry/browser';
-
-/**
- *  Ember-specific browser tracing integration
- */
-export { browserTracingIntegration } from './utils/browserTracingIntegration';

package/addon/instance-initializers/sentry-performance.ts

@@ -1,23 +0,0 @@
-import type ApplicationInstance from '@ember/application/instance';
-import { instrumentForPerformance, getSentryConfig } from '../utils/performance';
-
-export function initialize(appInstance: ApplicationInstance): void {
-  // Disable in fastboot - we only want to run Sentry client-side
-  const fastboot = appInstance.lookup('service:fastboot') as unknown as { isFastBoot: boolean } | undefined;
-  if (fastboot?.isFastBoot) {
-    return;
-  }
-
-  const config = getSentryConfig();
-  if (config['disablePerformance']) {
-    return;
-  }
-
-  // Run this in the next tick to ensure the ember router etc. is properly initialized
-  instrumentForPerformance(appInstance);
-}
-
-export default {
-  initialize,
-  name: 'sentry-performance',
-};

package/addon/runloop.d.ts

@@ -1,19 +0,0 @@
-import type { Backburner } from '@ember/runloop/-private/backburner';
-
-/**
- * Backburner needs to be extended as it's missing the 'off' method.
- */
-interface ExtendedBackburner extends Backburner {
-  off(...args: unknown[]): void;
-}
-
-/**
- * Runloop needs to be extended to expose backburner as suggested here:
- * https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/ember__runloop/ember__runloop-tests.ts#L9
- */
-declare module '@ember/runloop' {
-  interface RunNamespace {
-    backburner?: ExtendedBackburner;
-  }
-  export const _backburner: ExtendedBackburner; // Ember 4.0
-}

package/addon/types.ts

@@ -1,39 +0,0 @@
-import type { BrowserOptions, browserTracingIntegration } from '@sentry/browser';
-
-type BrowserTracingOptions = Parameters<typeof browserTracingIntegration>[0];
-
-export type EmberSentryConfig = {
-  sentry: BrowserOptions & { browserTracingOptions?: BrowserTracingOptions };
-  transitionTimeout: number;
-  /**
-   * @deprecated This option is no longer used and will be removed in the next major version.
-   */
-  ignoreEmberOnErrorWarning: boolean;
-  disableInstrumentComponents: boolean;
-  disablePerformance: boolean;
-  disablePostTransitionRender: boolean;
-  disableRunloopPerformance: boolean;
-  disableInitialLoadInstrumentation: boolean;
-  enableComponentDefinitions: boolean;
-  minimumRunloopQueueDuration: number;
-  minimumComponentRenderDuration: number;
-  browserTracingOptions: BrowserTracingOptions;
-};
-
-export type OwnConfig = {
-  sentryConfig: EmberSentryConfig;
-};
-
-// This is private in Ember and not really exported, so we "mock" these types here.
-export interface EmberRouterMain {
-  location: {
-    getURL?: () => string;
-    formatURL?: (url: string) => string;
-    implementation?: string;
-    rootURL: string;
-  };
-}
-
-export type GlobalConfig = {
-  __sentryEmberConfig: EmberSentryConfig['sentry'];
-};

package/addon/utils/performance.ts

@@ -1,80 +0,0 @@
-import type ApplicationInstance from '@ember/application/instance';
-import { _backburner, run } from '@ember/runloop';
-import { getOwnConfig, importSync, isTesting, macroCondition } from '@embroider/macros';
-import { getClient } from '@sentry/browser';
-import { addIntegration, GLOBAL_OBJ } from '@sentry/core';
-import type { ExtendedBackburner } from '@sentry/ember/runloop';
-import type { EmberSentryConfig, GlobalConfig, OwnConfig } from '../types';
-import type { browserTracingIntegration as browserTracingIntegrationType } from './browserTracingIntegration';
-
-export function getSentryConfig(): EmberSentryConfig {
-  const _global = GLOBAL_OBJ as typeof GLOBAL_OBJ & GlobalConfig;
-  _global.__sentryEmberConfig = _global.__sentryEmberConfig ?? {};
-  const environmentConfig = getOwnConfig<OwnConfig>().sentryConfig;
-  if (!environmentConfig.sentry) {
-    environmentConfig.sentry = {
-      browserTracingOptions: {},
-    };
-  }
-  Object.assign(environmentConfig.sentry, _global.__sentryEmberConfig);
-  return environmentConfig;
-}
-
-export function getBackburner(): Pick<ExtendedBackburner, 'on' | 'off'> {
-  if (_backburner) {
-    return _backburner;
-  }
-
-  if ((run as unknown as { backburner?: Pick<ExtendedBackburner, 'on' | 'off'> }).backburner) {
-    return (run as unknown as { backburner: Pick<ExtendedBackburner, 'on' | 'off'> }).backburner;
-  }
-
-  return {
-    on() {
-      // noop
-    },
-    off() {
-      // noop
-    },
-  };
-}
-
-/**
- * Utility to register the browser tracing integration and instrument the app instance for performance.
- */
-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 } = importSync('./browserTracingIntegration') as {
-    browserTracingIntegration: typeof browserTracingIntegrationType;
-  };
-
-  const idleTimeout = config.transitionTimeout || 5000;
-
-  const emberSpecificConfig = {
-    minimumRunloopQueueDuration: config.minimumRunloopQueueDuration,
-    minimumComponentRenderDuration: config.minimumComponentRenderDuration,
-    enableComponentDefinitions: config.enableComponentDefinitions,
-    disableInitialLoadInstrumentation: config.disableInitialLoadInstrumentation,
-    disableRunloopPerformance: config.disableRunloopPerformance,
-    disableInstrumentComponents: config.disableInstrumentComponents,
-  };
-
-  const browserTracing = browserTracingIntegration({
-    appInstance,
-    idleTimeout,
-    ...browserTracingOptions,
-    ...emberSpecificConfig,
-  });
-
-  const client = getClient();
-  const isAlreadyInitialized = macroCondition(isTesting()) ? client?.getIntegrationByName('BrowserTracing') : false;
-  addIntegration(browserTracing);
-
-  // Ensure this is re-run in tests even if the integration is already initialized
-  if (isAlreadyInitialized && client) {
-    browserTracing.afterAllSetup?.(client);
-  }
-}

package/app/instance-initializers/sentry-performance.js

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

package/config/environment.js

@@ -1,5 +0,0 @@
-'use strict';
-
-module.exports = function (/* environment, appConfig */) {
-  return {};
-};

package/index.d.ts

@@ -1,14 +0,0 @@
-import type Route from '@ember/routing/route';
-import type { BrowserOptions } from '@sentry/browser';
-import type { Client } from '@sentry/core';
-/**
- * Initialize the Sentry SDK for Ember.
- */
-export declare function init(_runtimeConfig?: BrowserOptions): Client | undefined;
-type RouteConstructor = new (...args: ConstructorParameters<typeof Route>) => Route;
-export declare const instrumentRoutePerformance: <T extends RouteConstructor>(BaseRoute: T) => T;
-export * from '@sentry/browser';
-/**
- *  Ember-specific browser tracing integration
- */
-export { browserTracingIntegration } from './utils/browserTracingIntegration';

package/index.js

@@ -1,115 +0,0 @@
-'use strict';
-const fs = require('fs');
-const crypto = require('crypto');
-
-function readSnippet(fileName) {
-  return fs.readFileSync(`${__dirname}/vendor/${fileName}`, 'utf8');
-}
-
-function hashSha256base64(string) {
-  return crypto.createHash('sha256').update(string).digest('base64');
-}
-
-const initialLoadHeadSnippet = readSnippet('initial-load-head.js');
-const initialLoadBodySnippet = readSnippet('initial-load-body.js');
-
-const initialLoadHeadSnippetHash = hashSha256base64(initialLoadHeadSnippet);
-const initialLoadBodySnippetHash = hashSha256base64(initialLoadBodySnippet);
-
-module.exports = {
-  name: require('./package').name,
-  options: {
-    babel: {
-      plugins: [require.resolve('ember-auto-import/babel-plugin')],
-    },
-    '@embroider/macros': {
-      setOwnConfig: {},
-    },
-  },
-
-  included() {
-    const app = this._findHost();
-    const config = app.project.config(app.env);
-    const addonConfig = dropUndefinedKeys(config['@sentry/ember'] || {});
-
-    if (!isSerializable(addonConfig)) {
-      // eslint-disable-next-line no-console
-      console.warn(
-        `Warning: You passed a non-serializable config to \`ENV['@sentry/ember'].sentry\`.
-Non-serializable config (e.g. RegExp, ...) can only be passed directly to \`Sentry.init()\`, which is usually defined in app/app.js.
-The reason for this is that @embroider/macros, which is used under the hood to handle environment config, requires serializable configuration.`,
-      );
-    }
-
-    this.options['@embroider/macros'].setOwnConfig.sentryConfig = addonConfig;
-
-    this._super.included.apply(this, arguments);
-  },
-
-  contentFor(type, config) {
-    const addonConfig = config['@sentry/ember'] || {};
-    const { disablePerformance, disableInitialLoadInstrumentation } = addonConfig;
-
-    if (disablePerformance || disableInitialLoadInstrumentation) {
-      return;
-    }
-
-    if (type === 'head') {
-      return `<script type="text/javascript">${initialLoadHeadSnippet}</script>`;
-    } else if (type === 'body-footer') {
-      return `<script type="text/javascript">${initialLoadBodySnippet}</script>`;
-    }
-  },
-
-  injectedScriptHashes: [initialLoadHeadSnippetHash, initialLoadBodySnippetHash],
-};
-
-function isSerializable(obj) {
-  if (isScalar(obj)) {
-    return true;
-  }
-
-  if (Array.isArray(obj)) {
-    return !obj.some(arrayItem => !isSerializable(arrayItem));
-  }
-
-  if (isPlainObject(obj)) {
-    // eslint-disable-next-line guard-for-in
-    for (let property in obj) {
-      let value = obj[property];
-      if (!isSerializable(value)) {
-        return false;
-      }
-    }
-
-    return true;
-  }
-
-  return false;
-}
-
-function isScalar(val) {
-  return (
-    typeof val === 'undefined' ||
-    typeof val === 'string' ||
-    typeof val === 'boolean' ||
-    typeof val === 'number' ||
-    val === null
-  );
-}
-
-function isPlainObject(obj) {
-  return typeof obj === 'object' && obj.constructor === Object && obj.toString() === '[object Object]';
-}
-
-function dropUndefinedKeys(obj) {
-  const newObj = {};
-
-  for (const key in obj) {
-    if (obj[key] !== undefined) {
-      newObj[key] = obj[key];
-    }
-  }
-
-  return newObj;
-}

package/instance-initializers/sentry-performance.d.ts

@@ -1,7 +0,0 @@
-import type ApplicationInstance from '@ember/application/instance';
-export declare function initialize(appInstance: ApplicationInstance): void;
-declare const _default: {
-    initialize: typeof initialize;
-    name: string;
-};
-export default _default;

package/runloop.d.ts

@@ -1,19 +0,0 @@
-import type { Backburner } from '@ember/runloop/-private/backburner';
-
-/**
- * Backburner needs to be extended as it's missing the 'off' method.
- */
-interface ExtendedBackburner extends Backburner {
-  off(...args: unknown[]): void;
-}
-
-/**
- * Runloop needs to be extended to expose backburner as suggested here:
- * https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/ember__runloop/ember__runloop-tests.ts#L9
- */
-declare module '@ember/runloop' {
-  interface RunNamespace {
-    backburner?: ExtendedBackburner;
-  }
-  export const _backburner: ExtendedBackburner; // Ember 4.0
-}

package/tsconfig.json

@@ -1,25 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "target": "es2022",
-    "lib": ["DOM", "ES2022"],
-    "allowJs": true,
-    "allowSyntheticDefaultImports": true,
-    "alwaysStrict": true,
-    "strictNullChecks": true,
-    "strictPropertyInitialization": true,
-    "noEmitOnError": false,
-    "noEmit": true,
-    "experimentalDecorators": true,
-    "paths": {
-      "dummy/tests/*": ["./tests/*"],
-      "dummy/*": ["./tests/dummy/app/*", "./app/*"],
-      "@sentry/ember": ["./addon"],
-      "@sentry/ember/*": ["./addon/*"],
-      "@sentry/ember/test-support": ["./addon-test-support"],
-      "@sentry/ember/test-support/*": ["./addon-test-support/*"],
-      "*": ["./types/*"]
-    }
-  },
-  "include": ["app/**/*", "addon/**/*", "tests/**/*", "types/**/*", "test-support/**/*", "addon-test-support/**/*"]
-}

package/types/global.d.ts

@@ -1,15 +0,0 @@
-// Types for compiled templates
-declare module '@sentry/ember/templates/*' {
-  import type { TemplateFactory } from 'htmlbars-inline-precompile';
-  const tmpl: TemplateFactory;
-  export default tmpl;
-}
-
-/**
- * This is private as of now.
- * See https://github.com/emberjs/ember.js/blob/master/packages/@ember/instrumentation/index.ts
- */
-declare module '@ember/instrumentation' {
-  // oxlint-disable-next-line typescript/no-explicit-any
-  export function subscribe(pattern: string, object: {}): any;
-}

package/types.d.ts

@@ -1,36 +0,0 @@
-import type { BrowserOptions, browserTracingIntegration } from '@sentry/browser';
-type BrowserTracingOptions = Parameters<typeof browserTracingIntegration>[0];
-export type EmberSentryConfig = {
-    sentry: BrowserOptions & {
-        browserTracingOptions?: BrowserTracingOptions;
-    };
-    transitionTimeout: number;
-    /**
-     * @deprecated This option is no longer used and will be removed in the next major version.
-     */
-    ignoreEmberOnErrorWarning: boolean;
-    disableInstrumentComponents: boolean;
-    disablePerformance: boolean;
-    disablePostTransitionRender: boolean;
-    disableRunloopPerformance: boolean;
-    disableInitialLoadInstrumentation: boolean;
-    enableComponentDefinitions: boolean;
-    minimumRunloopQueueDuration: number;
-    minimumComponentRenderDuration: number;
-    browserTracingOptions: BrowserTracingOptions;
-};
-export type OwnConfig = {
-    sentryConfig: EmberSentryConfig;
-};
-export interface EmberRouterMain {
-    location: {
-        getURL?: () => string;
-        formatURL?: (url: string) => string;
-        implementation?: string;
-        rootURL: string;
-    };
-}
-export type GlobalConfig = {
-    __sentryEmberConfig: EmberSentryConfig['sentry'];
-};
-export {};

package/utils/instrumentEmberGlobals.d.ts

@@ -1,9 +0,0 @@
-/** This is global, so should only be run once in tests! */
-export declare function instrumentGlobalsForPerformance(config: {
-    disableRunloopPerformance?: boolean;
-    minimumRunloopQueueDuration?: number;
-    disableInstrumentComponents?: boolean;
-    minimumComponentRenderDuration?: number;
-    enableComponentDefinitions?: boolean;
-    disableInitialLoadInstrumentation?: boolean;
-}): void;

package/utils/performance.d.ts

@@ -1,9 +0,0 @@
-import type ApplicationInstance from '@ember/application/instance';
-import type { ExtendedBackburner } from '@sentry/ember/runloop';
-import type { EmberSentryConfig } from '../types';
-export declare function getSentryConfig(): EmberSentryConfig;
-export declare function getBackburner(): Pick<ExtendedBackburner, 'on' | 'off'>;
-/**
- * Utility to register the browser tracing integration and instrument the app instance for performance.
- */
-export declare function instrumentForPerformance(appInstance: ApplicationInstance): void;

package/vendor/initial-load-body.js

@@ -1,3 +0,0 @@
-if (window.performance && window.performance.mark) {
-  window.performance.mark('@sentry/ember:initial-load-end');
-}

package/vendor/initial-load-head.js

@@ -1,3 +0,0 @@
-if (window.performance && window.performance.mark) {
-  window.performance.mark('@sentry/ember:initial-load-start');
-}