Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -626,6 +626,80 @@ Affected SDKs: `@sentry/cloudflare`.
+ import { wrapRequestHandler } from '@sentry/cloudflare/request';
```

### `@sentry/ember` is now a v2 addon with manual setup

Affected SDKs: `@sentry/ember`.

`@sentry/ember` is now a [v2 (Embroider) addon](https://rfcs.emberjs.com/id/0507-embroider-v2-package-format/), so it builds cleanly under Embroider and Vite in addition to classic builds. Because v2 addons cannot auto-configure the host app, Sentry is no longer wired up from `config/environment.js` and no longer registers its own initializer. You now call `Sentry.init()` yourself and opt into performance instrumentation explicitly. A full walkthrough lives in [`packages/ember/UPGRADE.md`](./packages/ember/UPGRADE.md).

**1. Initialize Sentry in `app/app.ts` instead of `config/environment.js`.** Remove the `'@sentry/ember'` block from `config/environment.js` and call `init()` before your `Application` class:

```ts
// config/environment.js
ENV.sentryDsn = process.env.E2E_TEST_DSN;
```

```typescript
// app/app.ts
import Application from '@ember/application';
import Resolver from 'ember-resolver';
import loadInitializers from 'ember-load-initializers';
import config from 'my-app/config/environment';
import * as Sentry from '@sentry/ember';

Sentry.init({
dsn: config.sentryDsn,
tracesSampleRate: 1.0,
// all @sentry/browser options are supported
});

export default class App extends Application {
modulePrefix = config.modulePrefix;
podModulePrefix = config.podModulePrefix;
Resolver = Resolver;
}

loadInitializers(App, config.modulePrefix);
```

The former `@sentry/ember` config keys map onto arguments you now pass directly: `sentry` options become `Sentry.init()` options, and the `disable*` performance flags move to `instrumentAppInstancePerformance()` (see below). `disablePerformance` no longer exists as a single switch — omit the instance-initializer entirely to disable performance instrumentation.

**2. Opt into performance instrumentation with an instance-initializer.** Automatic performance instrumentation is gone; add it yourself:

```typescript
// app/instance-initializers/sentry-performance.ts
import type ApplicationInstance from '@ember/application/instance';
import { instrumentAppInstancePerformance } from '@sentry/ember';

export function initialize(appInstance: ApplicationInstance): void {
instrumentAppInstancePerformance(appInstance, {
// former config/environment flags live here now, e.g.:
// disableRunloopPerformance: false,
// disableInstrumentComponents: false,
});
}

export default { initialize };
```

FastBoot is detected automatically, so client-side instrumentation is skipped during server rendering with no extra configuration.

**3. `instrumentRoutePerformance` is unchanged.** Wrapping individual routes works exactly as before:

```typescript
// app/routes/posts.ts
import Route from '@ember/routing/route';
import { instrumentRoutePerformance } from '@sentry/ember';

class PostsRoute extends Route {
async model() {
return this.store.findAll('post');
}
}

export default instrumentRoutePerformance(PostsRoute);
```

## 3. Removed APIs

### `@sentry/core` / All SDKs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@ import Resolver from 'ember-resolver';
import config from './config/environment';

Sentry.init({
dsn: config.sentryDsn,
traceLifecycle: 'static',
tracesSampleRate: 1,
replaysSessionSampleRate: 1,
replaysOnErrorSampleRate: 1,
tracePropagationTargets: ['localhost', 'doesntexist.example'],
tunnel: `http://localhost:3031/`, // proxy server
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ declare const config: {
podModulePrefix: string;
locationType: 'history' | 'hash' | 'none' | 'auto';
rootURL: string;
sentryDsn: string;
APP: Record<string, unknown>;
};

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import type ApplicationInstance from '@ember/application/instance';
import { instrumentAppInstancePerformance } from '@sentry/ember';

export function initialize(appInstance: ApplicationInstance): void {
instrumentAppInstancePerformance(appInstance, {
minimumRunloopQueueDuration: 0,
minimumComponentRenderDuration: 0,
});
}

export default {
initialize,
};
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,7 @@ module.exports = function (environment) {
},
};

ENV['@sentry/ember'] = {
sentry: {
tracesSampleRate: 1,
dsn: process.env.E2E_TEST_DSN,
tracePropagationTargets: ['localhost', 'doesntexist.example'],
browserTracingOptions: {
_experiments: {
// This lead to some flaky tests, as that is sometimes logged
enableLongTask: false,
},
},
},
ignoreEmberOnErrorWarning: true,
minimumRunloopQueueDuration: 0,
minimumComponentRenderDuration: 0,
};
ENV.sentryDsn = process.env.E2E_TEST_DSN;

if (environment === 'development') {
// ENV.APP.LOG_RESOLVER = true;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ test('sends an error', async ({ page }) => {

test('assigns the correct transaction value after a navigation', async ({ page }) => {
const pageloadTxnPromise = waitForTransaction('ember-classic', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const errorPromise = waitForError('ember-classic', async errorEvent => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload transaction with a parameterized URL', async ({ page }) => {
const transactionPromise = waitForTransaction('ember-classic', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

await page.goto(`/`);
Expand Down Expand Up @@ -33,11 +33,11 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
const pageloadTxnPromise = waitForTransaction('ember-classic', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const navigationTxnPromise = waitForTransaction('ember-classic', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
});

await page.goto(`/`);
Expand Down Expand Up @@ -68,11 +68,11 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })

test('sends a navigation transaction even if the pageload span is still active', async ({ page }) => {
const pageloadTxnPromise = waitForTransaction('ember-classic', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const navigationTxnPromise = waitForTransaction('ember-classic', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
});

await page.goto(`/`);
Expand Down Expand Up @@ -127,11 +127,11 @@ test('sends a navigation transaction even if the pageload span is still active',

test('captures correct spans for navigation', async ({ page }) => {
const pageloadTxnPromise = waitForTransaction('ember-classic', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const navigationTxnPromise = waitForTransaction('ember-classic', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
});

await page.goto(`/tracing`);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@ import loadInitializers from 'ember-load-initializers';
import Resolver from 'ember-resolver';

Sentry.init({
dsn: config.sentryDsn,
traceLifecycle: 'static',
tracesSampleRate: 1,
replaysSessionSampleRate: 1,
replaysOnErrorSampleRate: 1,
tracePropagationTargets: ['localhost', 'doesntexist.example'],
tunnel: `http://localhost:3031/`, // proxy server
});
export default class App extends Application {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ declare const config: {
podModulePrefix: string;
locationType: 'history' | 'hash' | 'none' | 'auto';
rootURL: string;
sentryDsn: string;
APP: Record<string, unknown>;
};

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import type ApplicationInstance from '@ember/application/instance';
import { instrumentAppInstancePerformance } from '@sentry/ember';

export function initialize(appInstance: ApplicationInstance): void {
instrumentAppInstancePerformance(appInstance, {
minimumRunloopQueueDuration: 0,
minimumComponentRenderDuration: 0,
});
}

export default {
initialize,
};
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,7 @@ module.exports = function (environment) {
},
};

ENV['@sentry/ember'] = {
sentry: {
tracesSampleRate: 1,
dsn: process.env.E2E_TEST_DSN,
tracePropagationTargets: ['localhost', 'doesntexist.example'],
browserTracingOptions: {
_experiments: {
// This lead to some flaky tests, as that is sometimes logged
enableLongTask: false,
},
},
},
ignoreEmberOnErrorWarning: true,
minimumRunloopQueueDuration: 0,
minimumComponentRenderDuration: 0,
};
ENV.sentryDsn = process.env.E2E_TEST_DSN;

if (environment === 'development') {
// ENV.APP.LOG_RESOLVER = true;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ test('sends an error', async ({ page }) => {

test('assigns the correct transaction value after a navigation', async ({ page }) => {
const pageloadTxnPromise = waitForTransaction('ember-embroider', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const errorPromise = waitForError('ember-embroider', async errorEvent => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload transaction with a parameterized URL', async ({ page }) => {
const transactionPromise = waitForTransaction('ember-embroider', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

await page.goto(`/`);
Expand Down Expand Up @@ -33,11 +33,11 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
const pageloadTxnPromise = waitForTransaction('ember-embroider', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const navigationTxnPromise = waitForTransaction('ember-embroider', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
});

await page.goto(`/`);
Expand Down Expand Up @@ -68,11 +68,11 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })

test('sends a navigation transaction even if the pageload span is still active', async ({ page }) => {
const pageloadTxnPromise = waitForTransaction('ember-embroider', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const navigationTxnPromise = waitForTransaction('ember-embroider', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
});

await page.goto(`/`);
Expand Down Expand Up @@ -127,11 +127,11 @@ test('sends a navigation transaction even if the pageload span is still active',

test('captures correct spans for navigation', async ({ page }) => {
const pageloadTxnPromise = waitForTransaction('ember-embroider', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const navigationTxnPromise = waitForTransaction('ember-embroider', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
return !!transactionEvent.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
});

await page.goto(`/tracing`);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/test-results
/dist
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/**
* This babel config is used for local tests in the e2e app.
*/
const { buildMacros } = require('@embroider/macros/babel');

const macros = buildMacros();

module.exports = {
plugins: [
[
'@babel/plugin-transform-typescript',
{
allExtensions: true,
allowDeclareFields: true,
onlyRemoveTypeImports: true,
},
],
[
'babel-plugin-ember-template-compilation',
{
transforms: [...macros.templateMacros],
},
],
[
'module:decorator-transforms',
{
runtime: {
import: require.resolve('decorator-transforms/runtime-esm'),
},
},
],
...macros.babelMacros,
],
generatorOpts: {
compact: false,
},
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!doctype html>
<html lang="en-us">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Demo App</title>
<meta name="description" content="" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="stylesheet" href="./src/styles.css" />
</head>

<body>
<script type="module">
import { App } from './src/app';

App.create({});
</script>
</body>
</html>
Loading
Loading