diff --git a/.craft.yml b/.craft.yml index f0db51dc1582..27ff96e235d9 100644 --- a/.craft.yml +++ b/.craft.yml @@ -20,11 +20,11 @@ targets: - name: npm id: '@sentry-internal/tracing' includeNames: /^sentry-internal-tracing-\d.*\.tgz$/ - ## 1.5 Replay package (browser only) + ## 1.5 Replay Internal package (browser only) - name: npm - id: '@sentry/replay' - includeNames: /^sentry-replay-\d.*\.tgz$/ - ## 1.6. OpenTelemetry package + id: '@sentry-internal/replay' + includeNames: /^sentry-internal-replay-\d.*\.tgz$/ + ## 1.6 OpenTelemetry package - name: npm id: '@sentry/opentelemetry' includeNames: /^sentry-opentelemetry-\d.*\.tgz$/ diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3d8562473837..7a0d64822d13 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -271,6 +271,9 @@ jobs: ${{needs.job_get_metadata.outputs.is_develop == 'false' && env.NX_CACHE_RESTORE_KEYS || 'nx-never-restore'}} - name: Build packages + # Set the CODECOV_TOKEN for Bundle Analysis + env: + CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} run: yarn build outputs: # this needs to be passed on, because the `needs` context only looks at direct ancestors (so steps which depend on @@ -1048,7 +1051,8 @@ jobs: # TODO(v8): Re-enable hapi tests # 'node-hapi-app', 'node-exports-test-app', - 'vue-3' + 'vue-3', + 'webpack-5' ] build-command: - false diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ce787aa60f3..3cbab31ee270 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,51 @@ - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott +## 8.0.0-alpha.6 + +This is the sixth alpha release of Sentry JavaScript SDK v8, which includes a variety of breaking changes. + +Read the [in-depth migration guide](./MIGRATION.md) to find out how to address any breaking changes in your code. + +### Important Changes + +- **feat(nextjs): Use OpenTelemetry for performance monitoring and tracing (#11016)** + +We now use OpenTelemetry under the hood to power performance monitoring and tracing in the Next.js SDK. + +### Removal/Refactoring of deprecated functionality + +- feat(v8): Remove addGlobalEventProcessor (#11255) +- feat(v8): Remove deprecated span id fields (#11180) +- feat(v8): Remove makeMain export (#11278) +- feat(v8/core): Remove deprecated span.sampled (#11274) +- feat(v8/core): Remove getActiveTransaction (#11280) +- feat(v8/core): Remove spanMetadata field (#11271) +- feat(v8/ember): Remove deprecated StartTransactionFunction (#11270) +- feat(v8/replay): Remove deprecated replay options (#11268) +- feat(v8/svelte): Remove deprecated componentTrackingPreprocessor export (#11277) +- ref: Remove more usages of getCurrentHub in the codebase (#11281) +- ref(core): Remove `scope.setSpan()` and `scope.getSpan()` methods (#11051) +- ref(profiling-node): Remove usage of getCurrentHub (#11275) +- ref(v8): change integration.setupOnce signature (#11238) + +### Other Changes + +- feat(feedback): Make "required" text for input elements configurable (#11152) (#11153) +- feat(feedback): Update user feedback screenshot and cropping to align with designs (#11227) +- feat(nextjs): Remove `runtime` and `vercel` tags (#11291) +- feat(node): Add scope to ANR events (#11256) +- feat(node): Do not include `prismaIntegration` by default (#11265) +- feat(node): Ensure `tracePropagationTargets` are respected (#11285) +- feat(node): Simplify `SentrySpanProcessor` (#11273) +- feat(profiling): Use OTEL powered node package (#11239) +- feat(utils): Allow text encoder/decoder polyfill from global **SENTRY** (#11283) +- fix(nextjs): Show misconfiguration warning (no `instrumentation.ts`) (#11266) +- fix(node): Add logs when node-fetch cannot be instrumented (#11289) +- fix(node): Skip capturing Hapi Boom error responses. (#11151) +- fix(node): Use `suppressTracing` to avoid capturing otel spans (#11288) +- fix(opentelemetry): Do not stomp span status when `startSpan` callback throws (#11170) + ## 8.0.0-alpha.5 This is the fifth alpha release of Sentry JavaScript SDK v8, which includes a variety of breaking changes. @@ -23,6 +68,12 @@ files. Instead, please initialize the Sentry Next.js SDK for the serverside in a In addition, the Next.js SDK now requires a minimum Next.js version of `13.2.0`. +- **feat(v8/angular): Merge angular and angular-ivy packages and start Angular support at v14 (#11091)** + +The `@sentry/angular-ivy` package has been removed. The `@sentry/angular` package now supports Ivy by default and +requires at least Angular 14. See the [Migration Guide](./MIGRATION.md#removal-of-sentryangular-ivy-package) for more +details. + ### Removal/Refactoring of deprecated functionality - feat(aws-serverless): Remove deprecated `rethrowAfterCapture` option (#11126) @@ -455,6 +506,25 @@ We have also removed or updated a variety of deprecated APIs. - ref: Remove usage of span tags (#10808) - ref: Remove user segment (#10575) +## 7.108.0 + +This release fixes issues with Time to First Byte (TTFB) calculation in the SDK that was introduced with `7.95.0`. It +also fixes some bugs with Interaction to First Paint (INP) instrumentation. This may impact your Sentry Performance +Score calculation. + +- feat(serverless): Add Node.js 20 to compatible runtimes (#11104) +- feat(core): Backport `ResizeObserver` and `googletag` default filters (#11210) +- feat(webvitals): Adds event entry names for INP handler. Also guard against empty metric value +- fix(metrics): use correct statsd data category (#11187) +- fix(node): Record local variables with falsy values (v7) (#11190) +- fix(node): Use unique variable for ANR context transfer (v7) (#11162) +- fix(node): Time zone handling for `cron` (#11225) +- fix(tracing): use web-vitals ttfb calculation (#11231) +- fix(types): Fix incorrect `sampled` type on `Transaction` (#11146) +- fix(webvitals): Fix mapping not being maintained properly and sometimes not sending INP spans (#11183) + +Work in this release contributed by @quisido and @joshkel. Thank you for your contributions! + ## 7.107.0 This release fixes issues with INP instrumentation with the Next.js SDK and adds support for the `enableInp` option in diff --git a/LICENSE b/LICENSE index 293314012679..63e7eb28e19c 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 Functional Software, Inc. dba Sentry +Copyright (c) 2024 Functional Software, Inc. dba Sentry Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/MIGRATION.md b/MIGRATION.md index 1daf6c3d5c8d..6a29b7122953 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -24,18 +24,18 @@ stable release of `8.x` comes out). to `@sentry/node` and all of our node-based server-side sdks (`@sentry/nextjs`, `@sentry/serverless`, etc.). We no longer test against Node 8, 10, or 12 and cannot guarantee that the SDK will work as expected on these versions. -**Browser**: Our browser SDKs (`@sentry/browser`, `@sentry/react`, `@sentry/vue`, etc.) now require ES2017+ compatible +**Browser**: Our browser SDKs (`@sentry/browser`, `@sentry/react`, `@sentry/vue`, etc.) now require ES2018+ compatible browsers. This means that we no longer support IE11 (end of an era). This also means that the Browser SDK requires the fetch API to be available in the environment. New minimum supported browsers: -- Chrome 58 -- Edge 15 -- Safari/iOS Safari 11 -- Firefox 54 -- Opera 45 -- Samsung Internet 7.2 +- Chrome 63 +- Edge 79 +- Safari/iOS Safari 12 +- Firefox 58 +- Opera 50 +- Samsung Internet 8.2 For IE11 support please transpile your code to ES5 using babel or similar and add required polyfills. @@ -49,6 +49,7 @@ We've removed the following packages: - [@sentry/tracing](./MIGRATION.md#sentrytracing) - [@sentry/integrations](./MIGRATION.md#sentryintegrations) - [@sentry/serverless](./MIGRATION.md#sentryserverless) +- [@sentry/replay](./MIGRATION.md#sentryreplay) #### @sentry/hub @@ -217,6 +218,20 @@ Sentry.init({ }); ``` +#### @sentry/replay + +`@sentry/replay` has been removed and will no longer be published. You can import replay functionality and the replay +integration directly from the Browser SDK or browser framework-specific packages like `@sentry/react`. + +```js +// v7 +import { Replay } from '@sentry/replay'; +``` + +```js +import { replayIntegration } from '@sentry/browser'; +``` + ## 3. Performance Monitoring Changes - [Initializing the SDK in v8](./MIGRATION.md/#initializing-the-node-sdk) @@ -350,12 +365,13 @@ To make sure these integrations work properly you'll have to change how you - [Astro SDK](./MIGRATION.md#astro-sdk) - [AWS Serverless SDK](./MIGRATION.md#aws-serverless-sdk) - [Ember SDK](./MIGRATION.md#ember-sdk) +- [Svelte SDK](./MIGRATION.md#svelte-sdk) ### General Removed top-level exports: `tracingOrigins`, `MetricsAggregator`, `metricsAggregatorIntegration`, `Severity`, `Sentry.configureScope`, `Span`, `spanStatusfromHttpCode`, `makeMain`, `lastEventId`, `pushScope`, `popScope`, -`addGlobalEventProcessor`, `timestampWithMs`, `addExtensionMethods` +`addGlobalEventProcessor`, `timestampWithMs`, `addExtensionMethods`, `addGlobalEventProcessor`, `getActiveTransaction` Removed `@sentry/utils` exports: `timestampWithMs`, `addOrUpdateIntegration`, `tracingContextFromHeaders`, `walk` @@ -370,6 +386,7 @@ Removed `@sentry/utils` exports: `timestampWithMs`, `addOrUpdateIntegration`, `t - [Removal of `addGlobalEventProcessor` in favour of `addEventProcessor`](./MIGRATION.md#removal-of-addglobaleventprocessor-in-favour-of-addeventprocessor) - [Removal of `lastEventId()` method](./MIGRATION.md#deprecate-lasteventid) - [Remove `void` from transport return types](./MIGRATION.md#remove-void-from-transport-return-types) +- [Remove `addGlobalEventProcessor` in favor of `addEventProcessor`](./MIGRATION.md#remove-addglobaleventprocessor-in-favor-of-addeventprocessor) #### Deprecation of `Hub` and `getCurrentHub()` @@ -540,7 +557,7 @@ addGlobalEventProcessor(event => { ```js // v8 -addEventProcessor(event => { +Sentry.getGlobalScope().addEventProcessor(event => { delete event.extra; return event; }); @@ -569,6 +586,26 @@ interface Transport { } ``` +#### Remove `addGlobalEventProcessor` in favor of `addEventProcessor` + +In v8, we are removing the `addGlobalEventProcessor` function in favor of `addEventProcessor`. + +```js +// v7 +addGlobalEventProcessor(event => { + delete event.extra; + return event; +}); +``` + +```js +// v8 +addEventProcessor(event => { + delete event.extra; + return event; +}); +``` + ### Browser SDK (Browser, React, Vue, Angular, Ember, etc.) Removed top-level exports: `Offline`, `makeXHRTransport`, `BrowserTracing`, `wrap` @@ -577,6 +614,8 @@ Removed top-level exports: `Offline`, `makeXHRTransport`, `BrowserTracing`, `wra - [Removal of Offline integration](./MIGRATION.md#removal-of-the-offline-integration) - [Removal of `makeXHRTransport` transport](./MIGRATION.md#removal-of-makexhrtransport-transport) - [Removal of `wrap` method](./MIGRATION.md#removal-of-wrap-method) +- [Removal of `@sentry/angular-ivy` package](./MIGRATION.md#removal-of-sentryangular-ivy-package) +- [Removal of `@sentry/replay` package](./MIGRATION.md#removal-of-sentryreplay-package) #### Removal of the `BrowserTracing` integration @@ -605,6 +644,10 @@ requires at least Angular 14. If you are using Angular 13 or lower, we suggest u migrating to v8. If you can't upgrade your Angular version to at least Angular 14, you can also continue using the `@sentry/angular-ivy@7` SDK. However, v7 of the SDKs will no longer be fully supported going forward. +#### Removal of `@sentry/replay` package + +You can import from `@sentry/browser` (or from a respective SDK package like `@sentry/react` or `@sentry/vue`). + ### Server-side SDKs (Node, Deno, Bun, etc.) Removed top-level exports: `enableAnrDetection`, `Anr`, `deepReadDirSync` @@ -891,7 +934,7 @@ replacement API. ### Ember SDK -Removed top-level exports: `InitSentryForEmber` +Removed top-level exports: `InitSentryForEmber`, `StartTransactionFunction` - [Removal of `InitSentryForEmber` export](./MIGRATION.md#removal-of-initsentryforember-export) @@ -900,6 +943,42 @@ Removed top-level exports: `InitSentryForEmber` The `InitSentryForEmber` export has been removed. Instead, you should use the `Sentry.init` method to initialize the SDK. +### Svelte SDK + +Removed top-level exports: `componentTrackingPreprocessor` + +#### Removal of `componentTrackingPreprocessor` export + +The `componentTrackingPreprocessor` export has been removed. You should instead use `withSentryConfig` to configure +component tracking. + +```js +// v7 - svelte.config.js +import { componentTrackingPreprocessor } from '@sentry/svelte'; + +const config = { + preprocess: [ + componentTrackingPreprocessor(), + // ... + ], + // ... +}; + +export default config; +``` + +```js +// v8 - svelte.config.js +import { withSentryConfig } from "@sentry/svelte"; + +const config = { + // Your svelte config + compilerOptions: {...}, +}; + +export default withSentryConfig(config); +``` + ## 5. Behaviour Changes - [Updated behaviour of `tracePropagationTargets` in the browser](./MIGRATION.md#updated-behaviour-of-tracepropagationtargets-in-the-browser-http-tracing-headers--cors) @@ -907,6 +986,8 @@ SDK. - [Updated behaviour of `transactionContext` passed to `tracesSampler`](./MIGRATION.md#transactioncontext-no-longer-passed-to-tracessampler) - [Updated behaviour of `getClient()`](./MIGRATION.md#getclient-always-returns-a-client) - [Removal of Client-Side health check transaction filters](./MIGRATION.md#removal-of-client-side-health-check-transaction-filters) +- [Change of Replay default options (`unblock` and `unmask`)](./MIGRATION.md#change-of-replay-default-options-unblock-and-unmask) +- [Angular Tracing Decorator renaming](./MIGRATION.md#angular-tracing-decorator-renaming) #### Updated behaviour of `tracePropagationTargets` in the browser (HTTP tracing headers & CORS) @@ -1593,7 +1674,7 @@ Sentry.init({ ## Replay options changed (since 7.35.0) - #6645 Some options for replay have been deprecated in favor of new APIs. See -[Replay Migration docs](./packages/replay/MIGRATION.md#upgrading-replay-from-7340-to-7350) for details. +[Replay Migration docs](./docs/migration/replay.md#upgrading-replay-from-7340-to-7350---6645) for details. ## Renaming of Next.js wrapper methods (since 7.31.0) - #6790 @@ -1631,4 +1712,4 @@ This release deprecates `@sentry/hub` and all of it's exports. All of the `@sent # Upgrading Sentry Replay (beta, 7.24.0) For details on upgrading Replay in its beta phase, please view the -[dedicated Replay MIGRATION docs](./packages/replay/MIGRATION.md). +[dedicated Replay MIGRATION docs](./docs/migration/replay.md). diff --git a/README.md b/README.md index ff367a2018d5..101b712ced0b 100644 --- a/README.md +++ b/README.md @@ -93,8 +93,8 @@ Besides the high-level SDKs, this repository contains shared packages, helpers a development. If you're thinking about contributing to or creating a JavaScript-based SDK, have a look at the resources below: -- [`@sentry/replay`](https://github.com/getsentry/sentry-javascript/tree/master/packages/replay): Provides the - integration for Session Replay. +- [`@sentry-internal/replay`](https://github.com/getsentry/sentry-javascript/tree/master/packages/replay-internal): + Provides the integration for Session Replay. - [`@sentry/core`](https://github.com/getsentry/sentry-javascript/tree/master/packages/core): The base for all JavaScript SDKs with interfaces, type definitions and base classes. - [`@sentry/utils`](https://github.com/getsentry/sentry-javascript/tree/master/packages/utils): A set of helpers and diff --git a/dev-packages/browser-integration-tests/package.json b/dev-packages/browser-integration-tests/package.json index b424b26acf70..2463a941f825 100644 --- a/dev-packages/browser-integration-tests/package.json +++ b/dev-packages/browser-integration-tests/package.json @@ -49,7 +49,7 @@ }, "devDependencies": { "@types/glob": "8.0.0", - "@types/node": "^14.6.4", + "@types/node": "^14.18.0", "@types/pako": "^2.0.0", "glob": "8.0.3" }, diff --git a/dev-packages/browser-integration-tests/suites/replay/bufferMode/test.ts b/dev-packages/browser-integration-tests/suites/replay/bufferMode/test.ts index 9c10b6777d67..09fc602d92b7 100644 --- a/dev-packages/browser-integration-tests/suites/replay/bufferMode/test.ts +++ b/dev-packages/browser-integration-tests/suites/replay/bufferMode/test.ts @@ -1,6 +1,6 @@ import { expect } from '@playwright/test'; -import type { replayIntegration as actualReplayIntegration } from '@sentry/replay'; -import type { ReplayContainer } from '@sentry/replay/build/npm/types/types'; +import type { replayIntegration as actualReplayIntegration } from '@sentry-internal/replay'; +import type { ReplayContainer } from '@sentry-internal/replay/build/npm/types/types'; import { sentryTest } from '../../../utils/fixtures'; import { envelopeRequestParser, waitForErrorRequest } from '../../../utils/helpers'; diff --git a/dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/init.js b/dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/init.js index f71ddfdaaa9b..659e7b4618b2 100644 --- a/dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/init.js +++ b/dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/init.js @@ -1,5 +1,5 @@ +import { replayIntegration } from '@sentry-internal/replay'; import * as Sentry from '@sentry/browser'; -import { replayIntegration } from '@sentry/replay'; window.Sentry = Sentry; window.Replay = replayIntegration({ diff --git a/dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts b/dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts index 2235853ab5cc..58260c4c577f 100644 --- a/dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts +++ b/dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts @@ -4,7 +4,7 @@ import { SDK_VERSION } from '@sentry/browser'; import { sentryTest } from '../../../utils/fixtures'; import { getReplayEvent, shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers'; -sentryTest('should capture replays (@sentry/replay export)', async ({ getLocalTestPath, page }) => { +sentryTest('should capture replays (@sentry-internal/replay export)', async ({ getLocalTestPath, page }) => { if (shouldSkipReplayTest()) { sentryTest.skip(); } diff --git a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/init.js b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/init.js index 147a4aa26bfb..635210f2252c 100644 --- a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/init.js +++ b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/init.js @@ -4,6 +4,12 @@ window.Sentry = Sentry; Sentry.init({ dsn: 'https://public@dsn.ingest.sentry.io/1337', - integrations: [Sentry.browserTracingIntegration({ idleTimeout: 9000, instrumentPageLoad: false })], + integrations: [ + Sentry.browserTracingIntegration({ + idleTimeout: 9000, + instrumentPageLoad: false, + instrumentNavigation: false, + }), + ], tracesSampleRate: 1, }); diff --git a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/subject.js b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/subject.js index e40426fdbe26..0ccb8f15d8bf 100644 --- a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/subject.js +++ b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/subject.js @@ -6,9 +6,8 @@ document.getElementById('go-background').addEventListener('click', () => { }); document.getElementById('start-span').addEventListener('click', () => { - const span = Sentry.startInactiveSpan({ name: 'test-span' }); + const span = Sentry.startBrowserTracingNavigationSpan(Sentry.getClient(), { name: 'test-span' }); window.span = span; - Sentry.getCurrentScope().setSpan(span); }); window.getSpanJson = () => { diff --git a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/test.ts b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/test.ts index fad37e85d6b4..1e56b405f579 100644 --- a/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/test.ts +++ b/dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/test.ts @@ -10,7 +10,7 @@ sentryTest('should finish a custom transaction when the page goes background', a } const url = await getLocalTestPath({ testDir: __dirname }); - page.goto(url); + await page.goto(url); await page.locator('#start-span').click(); const spanJsonBefore: SpanJSON = await page.evaluate('window.getSpanJson()'); diff --git a/dev-packages/browser-integration-tests/utils/generatePlugin.ts b/dev-packages/browser-integration-tests/utils/generatePlugin.ts index f3875c561e74..d2907ae47af1 100644 --- a/dev-packages/browser-integration-tests/utils/generatePlugin.ts +++ b/dev-packages/browser-integration-tests/utils/generatePlugin.ts @@ -162,7 +162,7 @@ class SentryScenarioGenerationPlugin { ? { // To help Webpack resolve Sentry modules in `import` statements in cases where they're provided in bundles rather than in `node_modules` '@sentry/browser': 'Sentry', - '@sentry/replay': 'Sentry', + '@sentry-internal/replay': 'Sentry', '@sentry/wasm': 'Sentry', } : {}; diff --git a/dev-packages/browser-integration-tests/utils/replayHelpers.ts b/dev-packages/browser-integration-tests/utils/replayHelpers.ts index f0015d2dfb7f..36727664dce3 100644 --- a/dev-packages/browser-integration-tests/utils/replayHelpers.ts +++ b/dev-packages/browser-integration-tests/utils/replayHelpers.ts @@ -1,16 +1,16 @@ import type { Page, Request, Response } from '@playwright/test'; /* eslint-disable max-lines */ import type { ReplayCanvasIntegrationOptions } from '@sentry-internal/replay-canvas'; -import type { fullSnapshotEvent, incrementalSnapshotEvent } from '@sentry-internal/rrweb'; -import { EventType } from '@sentry-internal/rrweb'; -import type { ReplayEventWithTime } from '@sentry/browser'; import type { InternalEventContext, RecordingEvent, ReplayContainer, ReplayPluginOptions, Session, -} from '@sentry/replay/build/npm/types/types'; +} from '@sentry-internal/replay/build/npm/types/types'; +import type { fullSnapshotEvent, incrementalSnapshotEvent } from '@sentry-internal/rrweb'; +import { EventType } from '@sentry-internal/rrweb'; +import type { ReplayEventWithTime } from '@sentry/browser'; import type { Breadcrumb, Event, ReplayEvent, ReplayRecordingMode } from '@sentry/types'; import pako from 'pako'; diff --git a/dev-packages/e2e-tests/Dockerfile.publish-packages b/dev-packages/e2e-tests/Dockerfile.publish-packages index 907f6655ca3d..4d5b2ba3abf3 100644 --- a/dev-packages/e2e-tests/Dockerfile.publish-packages +++ b/dev-packages/e2e-tests/Dockerfile.publish-packages @@ -1,5 +1,5 @@ # This Dockerfile exists for the purpose of using a specific node/npm version (ie. the same we use in CI) to run npm publish with -ARG NODE_VERSION=18.17.1 +ARG NODE_VERSION=18.18.0 FROM node:${NODE_VERSION} WORKDIR /sentry-javascript/dev-packages/e2e-tests diff --git a/dev-packages/e2e-tests/package.json b/dev-packages/e2e-tests/package.json index fe582ce20418..34c3a95881b2 100644 --- a/dev-packages/e2e-tests/package.json +++ b/dev-packages/e2e-tests/package.json @@ -18,15 +18,17 @@ }, "devDependencies": { "@types/glob": "8.0.0", - "@types/node": "^14.6.4", + "@types/node": "^14.18.0", "dotenv": "16.0.3", "esbuild": "0.20.0", "glob": "8.0.3", "ts-node": "10.9.1", - "yaml": "2.2.2" + "yaml": "2.2.2", + "rimraf": "^3.0.2" }, "volta": { - "node": "18.17.1", - "yarn": "1.22.19" + "node": "18.18.0", + "yarn": "1.22.19", + "pnpm": "8.15.5" } } diff --git a/dev-packages/e2e-tests/test-applications/create-next-app/tsconfig.json b/dev-packages/e2e-tests/test-applications/create-next-app/tsconfig.json index 1fd2e9a8d510..73c09112c46a 100644 --- a/dev-packages/e2e-tests/test-applications/create-next-app/tsconfig.json +++ b/dev-packages/e2e-tests/test-applications/create-next-app/tsconfig.json @@ -1,6 +1,6 @@ { "compilerOptions": { - "target": "es2017", + "target": "es2018", "lib": ["dom", "dom.iterable", "esnext"], "allowJs": true, "skipLibCheck": true, diff --git a/dev-packages/e2e-tests/test-applications/create-react-app/tsconfig.json b/dev-packages/e2e-tests/test-applications/create-react-app/tsconfig.json index bd19e4f07fc7..0e8eacbd8d09 100644 --- a/dev-packages/e2e-tests/test-applications/create-react-app/tsconfig.json +++ b/dev-packages/e2e-tests/test-applications/create-react-app/tsconfig.json @@ -1,6 +1,6 @@ { "compilerOptions": { - "target": "es2017", + "target": "es2018", "lib": ["dom", "dom.iterable", "esnext"], "allowJs": true, "skipLibCheck": true, diff --git a/dev-packages/e2e-tests/test-applications/generic-ts3.8/index.ts b/dev-packages/e2e-tests/test-applications/generic-ts3.8/index.ts index 241d82f715a0..0a78073e88ae 100644 --- a/dev-packages/e2e-tests/test-applications/generic-ts3.8/index.ts +++ b/dev-packages/e2e-tests/test-applications/generic-ts3.8/index.ts @@ -1,3 +1,5 @@ +// biome-ignore lint/nursery/noUnusedImports: +import * as _SentryReplay from '@sentry-internal/replay'; // biome-ignore lint/nursery/noUnusedImports: we need to import the SDK to ensure tsc check the types import * as _SentryBrowser from '@sentry/browser'; // biome-ignore lint/nursery/noUnusedImports: @@ -5,8 +7,6 @@ import * as _SentryCore from '@sentry/core'; // biome-ignore lint/nursery/noUnusedImports: import * as _SentryNode from '@sentry/node'; // biome-ignore lint/nursery/noUnusedImports: -import * as _SentryReplay from '@sentry/replay'; -// biome-ignore lint/nursery/noUnusedImports: import * as _SentryTypes from '@sentry/types'; // biome-ignore lint/nursery/noUnusedImports: import * as _SentryUtils from '@sentry/utils'; diff --git a/dev-packages/e2e-tests/test-applications/generic-ts3.8/package.json b/dev-packages/e2e-tests/test-applications/generic-ts3.8/package.json index acaa0a116ac0..d13bf86e7c64 100644 --- a/dev-packages/e2e-tests/test-applications/generic-ts3.8/package.json +++ b/dev-packages/e2e-tests/test-applications/generic-ts3.8/package.json @@ -16,7 +16,7 @@ "@sentry/browser": "latest || *", "@sentry/core": "latest || *", "@sentry/node": "latest || *", - "@sentry/replay": "latest || *", + "@sentry-internal/replay": "latest || *", "@sentry/types": "latest || *", "@sentry/utils": "latest || *", "@sentry/wasm": "latest || *" diff --git a/dev-packages/e2e-tests/test-applications/generic-ts3.8/tsconfig.json b/dev-packages/e2e-tests/test-applications/generic-ts3.8/tsconfig.json index ef27756e97d9..95de9c93fc38 100644 --- a/dev-packages/e2e-tests/test-applications/generic-ts3.8/tsconfig.json +++ b/dev-packages/e2e-tests/test-applications/generic-ts3.8/tsconfig.json @@ -1,11 +1,11 @@ { "include": ["index.ts"], "compilerOptions": { - "lib": ["es2017", "DOM"], + "lib": ["es2018", "DOM"], "skipLibCheck": false, "noEmit": true, "types": [], - "target": "es2017", + "target": "es2018", "moduleResolution": "node" } } diff --git a/dev-packages/e2e-tests/test-applications/nextjs-14/app/request-instrumentation/page.tsx b/dev-packages/e2e-tests/test-applications/nextjs-14/app/request-instrumentation/page.tsx index a1092a7fa618..7e59ffbe0a91 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-14/app/request-instrumentation/page.tsx +++ b/dev-packages/e2e-tests/test-applications/nextjs-14/app/request-instrumentation/page.tsx @@ -5,8 +5,12 @@ export const dynamic = 'force-dynamic'; export default async function Page() { await fetch('http://example.com/', { cache: 'no-cache' }); await new Promise(resolve => { - http.get('http://example.com/', () => { - resolve(); + http.get('http://example.com/', res => { + res.on('data', () => { + // Noop consuming some data so that request can close :) + }); + + res.on('close', resolve); }); }); return

Hello World!

; diff --git a/dev-packages/e2e-tests/test-applications/nextjs-14/instrumentation.ts b/dev-packages/e2e-tests/test-applications/nextjs-14/instrumentation.ts index 6ede827b556a..cd269ab160e7 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-14/instrumentation.ts +++ b/dev-packages/e2e-tests/test-applications/nextjs-14/instrumentation.ts @@ -8,6 +8,10 @@ export function register() { tunnel: `http://localhost:3031/`, // proxy server tracesSampleRate: 1.0, sendDefaultPii: true, + transportOptions: { + // We are doing a lot of events at once in this test + bufferSize: 1000, + }, }); } } diff --git a/dev-packages/e2e-tests/test-applications/nextjs-14/next.config.js b/dev-packages/e2e-tests/test-applications/nextjs-14/next.config.js index 4beb4fc356f4..1098c2ce5a4f 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-14/next.config.js +++ b/dev-packages/e2e-tests/test-applications/nextjs-14/next.config.js @@ -1,30 +1,8 @@ -// This file sets a custom webpack configuration to use your Next.js app -// with Sentry. -// https://nextjs.org/docs/api-reference/next.config.js/introduction -// https://docs.sentry.io/platforms/javascript/guides/nextjs/ - const { withSentryConfig } = require('@sentry/nextjs'); /** @type {import('next').NextConfig} */ -const moduleExports = {}; - -const sentryWebpackPluginOptions = { - // Additional config options for the Sentry Webpack plugin. Keep in mind that - // the following options are set automatically, and overriding them is not - // recommended: - // release, url, org, project, authToken, configFile, stripPrefix, - // urlPrefix, include, ignore - - silent: true, // Suppresses all logs - // For all available options, see: - // https://github.com/getsentry/sentry-webpack-plugin#options. - - // We're not testing source map uploads at the moment. - dryRun: true, -}; +const nextConfig = {}; -// Make sure adding Sentry options is the last code to run before exporting, to -// ensure that your source maps include changes from all other Webpack plugins -module.exports = withSentryConfig(moduleExports, sentryWebpackPluginOptions, { - hideSourceMaps: true, +module.exports = withSentryConfig(nextConfig, { + silent: true, }); diff --git a/dev-packages/e2e-tests/test-applications/nextjs-14/package.json b/dev-packages/e2e-tests/test-applications/nextjs-14/package.json index f2a1fb3d8a68..d0c41456d260 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-14/package.json +++ b/dev-packages/e2e-tests/test-applications/nextjs-14/package.json @@ -3,7 +3,7 @@ "version": "0.1.0", "private": true, "scripts": { - "build": "next build > .tmp_build_stdout 2> .tmp_build_stderr", + "build": "next build > .tmp_build_stdout 2> .tmp_build_stderr || (cat .tmp_build_stdout && cat .tmp_build_stderr && exit 1)", "clean": "npx rimraf node_modules,pnpm-lock.yaml", "test:prod": "TEST_ENV=production playwright test", "test:dev": "TEST_ENV=development playwright test", @@ -26,8 +26,19 @@ "wait-port": "1.0.4" }, "devDependencies": { + "@sentry-internal/feedback": "latest || *", + "@sentry-internal/replay-canvas": "latest || *", + "@sentry-internal/tracing": "latest || *", + "@sentry/browser": "latest || *", + "@sentry/core": "latest || *", + "@sentry/nextjs": "latest || *", + "@sentry/node": "latest || *", + "@sentry/opentelemetry": "latest || *", + "@sentry/react": "latest || *", + "@sentry-internal/replay": "latest || *", "@sentry/types": "latest || *", - "@sentry/utils": "latest || *" + "@sentry/utils": "latest || *", + "@sentry/vercel-edge": "latest || *" }, "volta": { "extends": "../../package.json" diff --git a/dev-packages/e2e-tests/test-applications/nextjs-14/playwright.config.ts b/dev-packages/e2e-tests/test-applications/nextjs-14/playwright.config.ts index d855e4918ce5..af4d9046b2fa 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-14/playwright.config.ts +++ b/dev-packages/e2e-tests/test-applications/nextjs-14/playwright.config.ts @@ -73,6 +73,8 @@ const config: PlaywrightTestConfig = { ? `pnpm wait-port ${eventProxyPort} && pnpm next dev -p ${nextPort}` : `pnpm wait-port ${eventProxyPort} && pnpm next start -p ${nextPort}`, port: nextPort, + stdout: 'pipe', + stderr: 'pipe', }, ], }; diff --git a/dev-packages/e2e-tests/test-applications/nextjs-14/tests/request-instrumentation.test.ts b/dev-packages/e2e-tests/test-applications/nextjs-14/tests/request-instrumentation.test.ts index ce17f725cf79..cba6fd0f8699 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-14/tests/request-instrumentation.test.ts +++ b/dev-packages/e2e-tests/test-applications/nextjs-14/tests/request-instrumentation.test.ts @@ -13,7 +13,7 @@ test('Should send a transaction with a fetch span', async ({ page }) => { data: expect.objectContaining({ 'http.method': 'GET', 'sentry.op': 'http.client', - 'sentry.origin': 'auto.http.node.undici', + 'next.span_type': 'AppRender.fetch', // This span is created by Next.js own fetch instrumentation }), description: 'GET http://example.com/', }), @@ -24,7 +24,7 @@ test('Should send a transaction with a fetch span', async ({ page }) => { data: expect.objectContaining({ 'http.method': 'GET', 'sentry.op': 'http.client', - 'sentry.origin': 'auto.http.node.http', + 'sentry.origin': 'auto.http.otel.http', }), description: 'GET http://example.com/', }), diff --git a/dev-packages/e2e-tests/test-applications/nextjs-14/tsconfig.json b/dev-packages/e2e-tests/test-applications/nextjs-14/tsconfig.json index 6b81123d463c..bd69196a9ca4 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-14/tsconfig.json +++ b/dev-packages/e2e-tests/test-applications/nextjs-14/tsconfig.json @@ -1,6 +1,6 @@ { "compilerOptions": { - "target": "es2017", + "target": "es2018", "lib": ["dom", "dom.iterable", "esnext"], "allowJs": true, "skipLibCheck": true, @@ -21,7 +21,7 @@ "incremental": true }, "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", "next.config.js", ".next/types/**/*.ts"], - "exclude": ["node_modules"], + "exclude": ["node_modules", "playwright.config.ts"], "ts-node": { "compilerOptions": { "module": "CommonJS" diff --git a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/assert-build.ts b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/assert-build.ts index 935eda2e3c14..b556662266f0 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/assert-build.ts +++ b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/assert-build.ts @@ -8,9 +8,24 @@ const buildStdout = fs.readFileSync('.tmp_build_stdout', 'utf-8'); const buildStderr = fs.readFileSync('.tmp_build_stderr', 'utf-8'); // Assert that there was no funky build time warning when we are on a stable (pinned) version -if (nextjsVersion !== 'latest' && nextjsVersion !== 'canary') { - assert.doesNotMatch(buildStderr, /Import trace for requested module/); // This is Next.js/Webpack speech for "something is off" -} +// if (nextjsVersion !== 'latest' && nextjsVersion !== 'canary') { +// assert.doesNotMatch(buildStderr, /Import trace for requested module/); // This is Next.js/Webpack speech for "something is off" +// } +// Note(lforst): I disabled this for the time being to figure out OTEL + Next.js - Next.js is currently complaining about a critical import in the @opentelemetry/instrumentation package. E.g: +// --- Start logs --- +// ./node_modules/@prisma/instrumentation/node_modules/@opentelemetry/instrumentation/build/esm/platform/node/instrumentation.js +// ./node_modules/@opentelemetry/instrumentation/build/esm/platform/node/instrumentation.js +// Critical dependency: the request of a dependency is an expression +// Import trace for requested module: +// ./node_modules/@opentelemetry/instrumentation/build/esm/platform/node/instrumentation.js +// ./node_modules/@opentelemetry/instrumentation/build/esm/platform/node/index.js +// ./node_modules/@opentelemetry/instrumentation/build/esm/platform/index.js +// ./node_modules/@opentelemetry/instrumentation/build/esm/index.js +// ./node_modules/@sentry/node/cjs/index.js +// ./node_modules/@sentry/nextjs/cjs/server/index.js +// ./node_modules/@sentry/nextjs/cjs/index.server.js +// ./app/page.tsx +// --- End logs --- // Assert that all static components stay static and all dynamic components stay dynamic assert.match(buildStdout, /○ \/client-component/); diff --git a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/components/span-context.tsx b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/components/span-context.tsx index 3ecd84019471..81a6f404d0f4 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/components/span-context.tsx +++ b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/components/span-context.tsx @@ -1,6 +1,6 @@ 'use client'; -import { getCurrentScope, startInactiveSpan } from '@sentry/nextjs'; +import { startInactiveSpan } from '@sentry/nextjs'; import { Span } from '@sentry/types'; import { PropsWithChildren, createContext, useState } from 'react'; @@ -29,7 +29,6 @@ export function SpanContextProvider({ children }: PropsWithChildren) { spanActive: false, start: (spanName: string) => { const span = startInactiveSpan({ name: spanName }); - getCurrentScope().setSpan(span); setSpan(span); }, } diff --git a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/event-proxy-server.ts b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/event-proxy-server.ts index d14ca5cb5e72..9d839e6c197b 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/event-proxy-server.ts +++ b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/event-proxy-server.ts @@ -147,7 +147,7 @@ export async function waitForRequest( const eventCallbackServerPort = await retrieveCallbackServerPort(proxyServerName); return new Promise((resolve, reject) => { - const request = http.request(`http://localhost:${eventCallbackServerPort}/`, {}, response => { + const request = http.request(`http://127.0.0.1:${eventCallbackServerPort}/`, {}, response => { let eventContents = ''; response.on('error', err => { diff --git a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/instrumentation.ts b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/instrumentation.ts index 6ede827b556a..cd269ab160e7 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/instrumentation.ts +++ b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/instrumentation.ts @@ -8,6 +8,10 @@ export function register() { tunnel: `http://localhost:3031/`, // proxy server tracesSampleRate: 1.0, sendDefaultPii: true, + transportOptions: { + // We are doing a lot of events at once in this test + bufferSize: 1000, + }, }); } } diff --git a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/next.config.js b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/next.config.js index 2c0d391e87dc..b8bf26536292 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/next.config.js +++ b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/next.config.js @@ -1,34 +1,13 @@ -// This file sets a custom webpack configuration to use your Next.js app -// with Sentry. -// https://nextjs.org/docs/api-reference/next.config.js/introduction -// https://docs.sentry.io/platforms/javascript/guides/nextjs/ - const { withSentryConfig } = require('@sentry/nextjs'); -const moduleExports = { +/** @type {import('next').NextConfig} */ +const nextConfig = { experimental: { appDir: true, serverActions: true, }, }; -const sentryWebpackPluginOptions = { - // Additional config options for the Sentry Webpack plugin. Keep in mind that - // the following options are set automatically, and overriding them is not - // recommended: - // release, url, org, project, authToken, configFile, stripPrefix, - // urlPrefix, include, ignore - - silent: true, // Suppresses all logs - // For all available options, see: - // https://github.com/getsentry/sentry-webpack-plugin#options. - - // We're not testing source map uploads at the moment. - dryRun: true, -}; - -// Make sure adding Sentry options is the last code to run before exporting, to -// ensure that your source maps include changes from all other Webpack plugins -module.exports = withSentryConfig(moduleExports, sentryWebpackPluginOptions, { - hideSourceMaps: true, +module.exports = withSentryConfig(nextConfig, { + silent: true, }); diff --git a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/package.json b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/package.json index e3f22e443bf7..2a9377a52319 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/package.json +++ b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/package.json @@ -3,7 +3,7 @@ "version": "0.1.0", "private": true, "scripts": { - "build": "next build > .tmp_build_stdout 2> .tmp_build_stderr", + "build": "next build > .tmp_build_stdout 2> .tmp_build_stderr || (cat .tmp_build_stdout && cat .tmp_build_stderr && exit 1)", "clean": "npx rimraf node_modules,pnpm-lock.yaml", "test:prod": "TEST_ENV=production playwright test", "test:dev": "TEST_ENV=development playwright test", @@ -29,8 +29,19 @@ "@playwright/test": "^1.27.1" }, "devDependencies": { + "@sentry-internal/feedback": "latest || *", + "@sentry-internal/replay-canvas": "latest || *", + "@sentry-internal/tracing": "latest || *", + "@sentry/browser": "latest || *", + "@sentry/core": "latest || *", + "@sentry/nextjs": "latest || *", + "@sentry/node": "latest || *", + "@sentry/opentelemetry": "latest || *", + "@sentry/react": "latest || *", + "@sentry-internal/replay": "latest || *", "@sentry/types": "latest || *", - "@sentry/utils": "latest || *" + "@sentry/utils": "latest || *", + "@sentry/vercel-edge": "latest || *" }, "volta": { "extends": "../../package.json" diff --git a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/pages/api/request-instrumentation.ts b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/pages/api/request-instrumentation.ts new file mode 100644 index 000000000000..044731530152 --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/pages/api/request-instrumentation.ts @@ -0,0 +1,17 @@ +import { get } from 'http'; +import { NextApiRequest, NextApiResponse } from 'next'; + +export default (_req: NextApiRequest, res: NextApiResponse) => { + // make an outgoing request in order to test that the `Http` integration creates a span + get('http://example.com/', message => { + message.on('data', () => { + // Noop consuming some data so that request can close :) + }); + + message.on('end', () => { + setTimeout(() => { + res.status(200).json({ message: 'Hello from Next.js!' }); + }, 500); + }); + }); +}; diff --git a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/playwright.config.ts b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/playwright.config.ts index 599afc629b87..4691dd5fd6c9 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/playwright.config.ts +++ b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/playwright.config.ts @@ -73,6 +73,8 @@ const config: PlaywrightTestConfig = { ? `pnpm wait-port ${eventProxyPort} && pnpm next dev -p ${nextPort}` : `pnpm wait-port ${eventProxyPort} && pnpm next start -p ${nextPort}`, port: nextPort, + stdout: 'pipe', + stderr: 'pipe', }, ], }; diff --git a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/request-instrumentation.test.ts b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/request-instrumentation.test.ts new file mode 100644 index 000000000000..6ee318fe8e91 --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/request-instrumentation.test.ts @@ -0,0 +1,24 @@ +import { expect, test } from '@playwright/test'; +import { waitForTransaction } from '../event-proxy-server'; + +// Note(lforst): I officially declare bancruptcy on this test. I tried a million ways to make it work but it kept flaking. +// Sometimes the request span was included in the handler span, more often it wasn't. I have no idea why. Maybe one day we will +// figure it out. Today is not that day. +test.skip('Should send a transaction with a http span', async ({ request }) => { + const transactionPromise = waitForTransaction('nextjs-13-app-dir', async transactionEvent => { + return transactionEvent?.transaction === 'GET /api/request-instrumentation'; + }); + + await request.get('/api/request-instrumentation'); + + expect((await transactionPromise).spans).toContainEqual( + expect.objectContaining({ + data: expect.objectContaining({ + 'http.method': 'GET', + 'sentry.op': 'http.client', + 'sentry.origin': 'auto.http.otel.http', + }), + description: 'GET http://example.com/', + }), + ); +}); diff --git a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/route-handlers.test.ts b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/route-handlers.test.ts index 41f8d897d97b..9bb784c39271 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/route-handlers.test.ts +++ b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/route-handlers.test.ts @@ -48,7 +48,7 @@ test('Should record exceptions and transactions for faulty route handlers', asyn const routehandlerTransaction = await routehandlerTransactionPromise; const routehandlerError = await errorEventPromise; - expect(routehandlerTransaction.contexts?.trace?.status).toBe('internal_error'); + expect(routehandlerTransaction.contexts?.trace?.status).toBe('unknown_error'); expect(routehandlerTransaction.contexts?.trace?.op).toBe('http.server'); expect(routehandlerError.exception?.values?.[0].value).toBe('route-handler-error'); diff --git a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/tsconfig.json b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/tsconfig.json index 6b81123d463c..bd69196a9ca4 100644 --- a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/tsconfig.json +++ b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/tsconfig.json @@ -1,6 +1,6 @@ { "compilerOptions": { - "target": "es2017", + "target": "es2018", "lib": ["dom", "dom.iterable", "esnext"], "allowJs": true, "skipLibCheck": true, @@ -21,7 +21,7 @@ "incremental": true }, "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", "next.config.js", ".next/types/**/*.ts"], - "exclude": ["node_modules"], + "exclude": ["node_modules", "playwright.config.ts"], "ts-node": { "compilerOptions": { "module": "CommonJS" diff --git a/dev-packages/e2e-tests/test-applications/node-exports-test-app/scripts/consistentExports.ts b/dev-packages/e2e-tests/test-applications/node-exports-test-app/scripts/consistentExports.ts index 8c3f3ee0242d..899cffb979a4 100644 --- a/dev-packages/e2e-tests/test-applications/node-exports-test-app/scripts/consistentExports.ts +++ b/dev-packages/e2e-tests/test-applications/node-exports-test-app/scripts/consistentExports.ts @@ -58,13 +58,11 @@ const DEPENDENTS: Dependent[] = [ ignoreExports: [ // not supported in bun: 'NodeClient', - // legacy, to be removed... - 'makeMain', ], }, { package: '@sentry/nextjs', - compareWith: nodeExperimentalExports, + compareWith: nodeExports, // Next.js doesn't require explicit exports, so we can just merge top level and `default` exports: // @ts-expect-error: `default` is not in the type definition but it's defined exports: Object.keys({ ...SentryNextJs, ...SentryNextJs.default }), @@ -79,8 +77,6 @@ const DEPENDENTS: Dependent[] = [ compareWith: nodeExports, exports: Object.keys(SentryAWS), ignoreExports: [ - // legacy, to be removed... - 'makeMain', // Not needed for Serverless 'setupFastifyErrorHandler', ], @@ -90,8 +86,6 @@ const DEPENDENTS: Dependent[] = [ compareWith: nodeExports, exports: Object.keys(SentryGoogleCloud), ignoreExports: [ - // legacy, to be removed... - 'makeMain', // Not needed for Serverless 'setupFastifyErrorHandler', ], diff --git a/dev-packages/e2e-tests/test-applications/node-exports-test-app/tsconfig.json b/dev-packages/e2e-tests/test-applications/node-exports-test-app/tsconfig.json index 6f37f0817c4a..e1f37178feb7 100644 --- a/dev-packages/e2e-tests/test-applications/node-exports-test-app/tsconfig.json +++ b/dev-packages/e2e-tests/test-applications/node-exports-test-app/tsconfig.json @@ -2,7 +2,7 @@ "compilerOptions": { "types": ["node"], "esModuleInterop": true, - "lib": ["es2017"], + "lib": ["es2018"], "strict": true, "outDir": "dist", "target": "ESNext", diff --git a/dev-packages/e2e-tests/test-applications/node-express-app/package.json b/dev-packages/e2e-tests/test-applications/node-express-app/package.json index 2ccd7ab35f76..9bd84e0e91a2 100644 --- a/dev-packages/e2e-tests/test-applications/node-express-app/package.json +++ b/dev-packages/e2e-tests/test-applications/node-express-app/package.json @@ -13,7 +13,7 @@ "dependencies": { "@sentry/node": "latest || *", "@sentry/types": "latest || *", - "express": "4.18.2", + "express": "4.19.2", "@types/express": "4.17.17", "@types/node": "18.15.1", "typescript": "4.9.5" diff --git a/dev-packages/e2e-tests/test-applications/node-express-app/tsconfig.json b/dev-packages/e2e-tests/test-applications/node-express-app/tsconfig.json index d46ae8103211..8cb64e989ed9 100644 --- a/dev-packages/e2e-tests/test-applications/node-express-app/tsconfig.json +++ b/dev-packages/e2e-tests/test-applications/node-express-app/tsconfig.json @@ -2,7 +2,7 @@ "compilerOptions": { "types": ["node"], "esModuleInterop": true, - "lib": ["es2017"], + "lib": ["es2018"], "strict": true, "outDir": "dist" }, diff --git a/dev-packages/e2e-tests/test-applications/node-fastify-app/src/app.js b/dev-packages/e2e-tests/test-applications/node-fastify-app/src/app.js index 7135fb33d91a..ded1a2de7fcb 100644 --- a/dev-packages/e2e-tests/test-applications/node-fastify-app/src/app.js +++ b/dev-packages/e2e-tests/test-applications/node-fastify-app/src/app.js @@ -6,6 +6,7 @@ const http = require('http'); const app = fastify(); const port = 3030; +const port2 = 3040; Sentry.setupFastifyErrorHandler(app); @@ -17,20 +18,22 @@ app.get('/test-param/:param', function (req, res) { res.send({ paramWas: req.params.param }); }); -app.get('/test-inbound-headers', function (req, res) { +app.get('/test-inbound-headers/:id', function (req, res) { const headers = req.headers; - res.send({ headers }); + res.send({ headers, id: req.params.id }); }); -app.get('/test-outgoing-http', async function (req, res) { - const data = await makeHttpRequest('http://localhost:3030/test-inbound-headers'); +app.get('/test-outgoing-http/:id', async function (req, res) { + const id = req.params.id; + const data = await makeHttpRequest(`http://localhost:3030/test-inbound-headers/${id}`); res.send(data); }); -app.get('/test-outgoing-fetch', async function (req, res) { - const response = await fetch('http://localhost:3030/test-inbound-headers'); +app.get('/test-outgoing-fetch/:id', async function (req, res) { + const id = req.params.id; + const response = await fetch(`http://localhost:3030/test-inbound-headers/${id}`); const data = await response.json(); res.send(data); @@ -56,8 +59,48 @@ app.get('/test-exception', async function (req, res) { throw new Error('This is an exception'); }); +app.get('/test-outgoing-fetch-external-allowed', async function (req, res) { + const fetchResponse = await fetch(`http://localhost:${port2}/external-allowed`); + const data = await fetchResponse.json(); + + res.send(data); +}); + +app.get('/test-outgoing-fetch-external-disallowed', async function (req, res) { + const fetchResponse = await fetch(`http://localhost:${port2}/external-disallowed`); + const data = await fetchResponse.json(); + + res.send(data); +}); + +app.get('/test-outgoing-http-external-allowed', async function (req, res) { + const data = await makeHttpRequest(`http://localhost:${port2}/external-allowed`); + res.send(data); +}); + +app.get('/test-outgoing-http-external-disallowed', async function (req, res) { + const data = await makeHttpRequest(`http://localhost:${port2}/external-disallowed`); + res.send(data); +}); + app.listen({ port: port }); +// A second app so we can test header propagation between external URLs +const app2 = fastify(); +app2.get('/external-allowed', function (req, res) { + const headers = req.headers; + + res.send({ headers, route: '/external-allowed' }); +}); + +app2.get('/external-disallowed', function (req, res) { + const headers = req.headers; + + res.send({ headers, route: '/external-disallowed' }); +}); + +app2.listen({ port: port2 }); + function makeHttpRequest(url) { return new Promise(resolve => { const data = []; @@ -67,9 +110,16 @@ function makeHttpRequest(url) { httpRes.on('data', chunk => { data.push(chunk); }); + httpRes.on('error', error => { + resolve({ error: error.message, url }); + }); httpRes.on('end', () => { - const json = JSON.parse(Buffer.concat(data).toString()); - resolve(json); + try { + const json = JSON.parse(Buffer.concat(data).toString()); + resolve(json); + } catch { + resolve({ data: Buffer.concat(data).toString(), url }); + } }); }) .end(); diff --git a/dev-packages/e2e-tests/test-applications/node-fastify-app/src/tracing.js b/dev-packages/e2e-tests/test-applications/node-fastify-app/src/tracing.js index 4cf352cda681..136b401cbd73 100644 --- a/dev-packages/e2e-tests/test-applications/node-fastify-app/src/tracing.js +++ b/dev-packages/e2e-tests/test-applications/node-fastify-app/src/tracing.js @@ -6,4 +6,5 @@ Sentry.init({ integrations: [], tracesSampleRate: 1, tunnel: 'http://localhost:3031/', // proxy server + tracePropagationTargets: ['http://localhost:3030', '/external-allowed'], }); diff --git a/dev-packages/e2e-tests/test-applications/node-fastify-app/tests/propagation.test.ts b/dev-packages/e2e-tests/test-applications/node-fastify-app/tests/propagation.test.ts index 89a6320f725a..411863f54cfb 100644 --- a/dev-packages/e2e-tests/test-applications/node-fastify-app/tests/propagation.test.ts +++ b/dev-packages/e2e-tests/test-applications/node-fastify-app/tests/propagation.test.ts @@ -1,32 +1,33 @@ +import crypto from 'crypto'; import { expect, test } from '@playwright/test'; -import { Span } from '@sentry/types'; +import { SpanJSON } from '@sentry/types'; import axios from 'axios'; import { waitForTransaction } from '../event-proxy-server'; test('Propagates trace for outgoing http requests', async ({ baseURL }) => { + const id = crypto.randomUUID(); + const inboundTransactionPromise = waitForTransaction('node-fastify-app', transactionEvent => { return ( - transactionEvent?.contexts?.trace?.op === 'http.server' && - transactionEvent?.transaction === 'GET /test-inbound-headers' + transactionEvent.contexts?.trace?.op === 'http.server' && + transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-inbound-headers/${id}` ); }); const outboundTransactionPromise = waitForTransaction('node-fastify-app', transactionEvent => { return ( - transactionEvent?.contexts?.trace?.op === 'http.server' && - transactionEvent?.transaction === 'GET /test-outgoing-http' + transactionEvent.contexts?.trace?.op === 'http.server' && + transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-outgoing-http/${id}` ); }); - const { data } = await axios.get(`${baseURL}/test-outgoing-http`); + const { data } = await axios.get(`${baseURL}/test-outgoing-http/${id}`); const inboundTransaction = await inboundTransactionPromise; const outboundTransaction = await outboundTransactionPromise; const traceId = outboundTransaction?.contexts?.trace?.trace_id; - const outgoingHttpSpan = outboundTransaction?.spans?.find(span => span.op === 'http.client') as - | ReturnType - | undefined; + const outgoingHttpSpan = outboundTransaction?.spans?.find(span => span.op === 'http.client') as SpanJSON | undefined; expect(outgoingHttpSpan).toBeDefined(); @@ -56,15 +57,15 @@ test('Propagates trace for outgoing http requests', async ({ baseURL }) => { 'sentry.origin': 'auto.http.otel.http', 'sentry.op': 'http.server', 'sentry.sample_rate': 1, - url: 'http://localhost:3030/test-outgoing-http', + url: `http://localhost:3030/test-outgoing-http/${id}`, 'otel.kind': 'SERVER', 'http.response.status_code': 200, - 'http.url': 'http://localhost:3030/test-outgoing-http', + 'http.url': `http://localhost:3030/test-outgoing-http/${id}`, 'http.host': 'localhost:3030', 'net.host.name': 'localhost', 'http.method': 'GET', 'http.scheme': 'http', - 'http.target': '/test-outgoing-http', + 'http.target': `/test-outgoing-http/${id}`, 'http.user_agent': 'axios/1.6.7', 'http.flavor': '1.1', 'net.transport': 'ip_tcp', @@ -74,7 +75,7 @@ test('Propagates trace for outgoing http requests', async ({ baseURL }) => { 'net.peer.port': expect.any(Number), 'http.status_code': 200, 'http.status_text': 'OK', - 'http.route': '/test-outgoing-http', + 'http.route': '/test-outgoing-http/:id', }, op: 'http.server', span_id: expect.any(String), @@ -89,15 +90,15 @@ test('Propagates trace for outgoing http requests', async ({ baseURL }) => { 'sentry.origin': 'auto.http.otel.http', 'sentry.op': 'http.server', 'sentry.sample_rate': 1, - url: 'http://localhost:3030/test-inbound-headers', + url: `http://localhost:3030/test-inbound-headers/${id}`, 'otel.kind': 'SERVER', 'http.response.status_code': 200, - 'http.url': 'http://localhost:3030/test-inbound-headers', + 'http.url': `http://localhost:3030/test-inbound-headers/${id}`, 'http.host': 'localhost:3030', 'net.host.name': 'localhost', 'http.method': 'GET', 'http.scheme': 'http', - 'http.target': '/test-inbound-headers', + 'http.target': `/test-inbound-headers/${id}`, 'http.flavor': '1.1', 'net.transport': 'ip_tcp', 'net.host.ip': expect.any(String), @@ -106,7 +107,7 @@ test('Propagates trace for outgoing http requests', async ({ baseURL }) => { 'net.peer.port': expect.any(Number), 'http.status_code': 200, 'http.status_text': 'OK', - 'http.route': '/test-inbound-headers', + 'http.route': '/test-inbound-headers/:id', }, op: 'http.server', parent_span_id: outgoingHttpSpanId, @@ -118,29 +119,29 @@ test('Propagates trace for outgoing http requests', async ({ baseURL }) => { }); test('Propagates trace for outgoing fetch requests', async ({ baseURL }) => { + const id = crypto.randomUUID(); + const inboundTransactionPromise = waitForTransaction('node-fastify-app', transactionEvent => { return ( transactionEvent?.contexts?.trace?.op === 'http.server' && - transactionEvent?.transaction === 'GET /test-inbound-headers' + transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-inbound-headers/${id}` ); }); const outboundTransactionPromise = waitForTransaction('node-fastify-app', transactionEvent => { return ( transactionEvent?.contexts?.trace?.op === 'http.server' && - transactionEvent?.transaction === 'GET /test-outgoing-fetch' + transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-outgoing-fetch/${id}` ); }); - const { data } = await axios.get(`${baseURL}/test-outgoing-fetch`); + const { data } = await axios.get(`${baseURL}/test-outgoing-fetch/${id}`); const inboundTransaction = await inboundTransactionPromise; const outboundTransaction = await outboundTransactionPromise; const traceId = outboundTransaction?.contexts?.trace?.trace_id; - const outgoingHttpSpan = outboundTransaction?.spans?.find(span => span.op === 'http.client') as - | ReturnType - | undefined; + const outgoingHttpSpan = outboundTransaction?.spans?.find(span => span.op === 'http.client') as SpanJSON | undefined; expect(outgoingHttpSpan).toBeDefined(); @@ -170,15 +171,15 @@ test('Propagates trace for outgoing fetch requests', async ({ baseURL }) => { 'sentry.origin': 'auto.http.otel.http', 'sentry.op': 'http.server', 'sentry.sample_rate': 1, - url: 'http://localhost:3030/test-outgoing-fetch', + url: `http://localhost:3030/test-outgoing-fetch/${id}`, 'otel.kind': 'SERVER', 'http.response.status_code': 200, - 'http.url': 'http://localhost:3030/test-outgoing-fetch', + 'http.url': `http://localhost:3030/test-outgoing-fetch/${id}`, 'http.host': 'localhost:3030', 'net.host.name': 'localhost', 'http.method': 'GET', 'http.scheme': 'http', - 'http.target': '/test-outgoing-fetch', + 'http.target': `/test-outgoing-fetch/${id}`, 'http.user_agent': 'axios/1.6.7', 'http.flavor': '1.1', 'net.transport': 'ip_tcp', @@ -188,7 +189,7 @@ test('Propagates trace for outgoing fetch requests', async ({ baseURL }) => { 'net.peer.port': expect.any(Number), 'http.status_code': 200, 'http.status_text': 'OK', - 'http.route': '/test-outgoing-fetch', + 'http.route': '/test-outgoing-fetch/:id', }, op: 'http.server', span_id: expect.any(String), @@ -203,15 +204,15 @@ test('Propagates trace for outgoing fetch requests', async ({ baseURL }) => { 'sentry.origin': 'auto.http.otel.http', 'sentry.op': 'http.server', 'sentry.sample_rate': 1, - url: 'http://localhost:3030/test-inbound-headers', + url: `http://localhost:3030/test-inbound-headers/${id}`, 'otel.kind': 'SERVER', 'http.response.status_code': 200, - 'http.url': 'http://localhost:3030/test-inbound-headers', + 'http.url': `http://localhost:3030/test-inbound-headers/${id}`, 'http.host': 'localhost:3030', 'net.host.name': 'localhost', 'http.method': 'GET', 'http.scheme': 'http', - 'http.target': '/test-inbound-headers', + 'http.target': `/test-inbound-headers/${id}`, 'http.flavor': '1.1', 'net.transport': 'ip_tcp', 'net.host.ip': expect.any(String), @@ -220,7 +221,7 @@ test('Propagates trace for outgoing fetch requests', async ({ baseURL }) => { 'net.peer.port': expect.any(Number), 'http.status_code': 200, 'http.status_text': 'OK', - 'http.route': '/test-inbound-headers', + 'http.route': '/test-inbound-headers/:id', }), op: 'http.server', parent_span_id: outgoingHttpSpanId, @@ -230,3 +231,121 @@ test('Propagates trace for outgoing fetch requests', async ({ baseURL }) => { origin: 'auto.http.otel.http', }); }); + +test('Propagates trace for outgoing external http requests', async ({ baseURL }) => { + const inboundTransactionPromise = waitForTransaction('node-fastify-app', transactionEvent => { + return ( + transactionEvent?.contexts?.trace?.op === 'http.server' && + transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-outgoing-http-external-allowed` + ); + }); + + const { data } = await axios.get(`${baseURL}/test-outgoing-http-external-allowed`); + + const inboundTransaction = await inboundTransactionPromise; + + const traceId = inboundTransaction?.contexts?.trace?.trace_id; + const spanId = inboundTransaction?.spans?.find(span => span.op === 'http.client')?.span_id; + + expect(traceId).toEqual(expect.any(String)); + expect(spanId).toEqual(expect.any(String)); + + expect(data).toEqual({ + route: '/external-allowed', + headers: expect.objectContaining({ + 'sentry-trace': `${traceId}-${spanId}-1`, + baggage: expect.any(String), + }), + }); + + const baggage = (data.headers.baggage || '').split(','); + expect(baggage).toEqual( + expect.arrayContaining([ + 'sentry-environment=qa', + `sentry-trace_id=${traceId}`, + expect.stringMatching(/sentry-public_key=/), + ]), + ); +}); + +test('Does not propagate outgoing http requests not covered by tracePropagationTargets', async ({ baseURL }) => { + const inboundTransactionPromise = waitForTransaction('node-fastify-app', transactionEvent => { + return ( + transactionEvent?.contexts?.trace?.op === 'http.server' && + transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-outgoing-http-external-disallowed` + ); + }); + + const { data } = await axios.get(`${baseURL}/test-outgoing-http-external-disallowed`); + + const inboundTransaction = await inboundTransactionPromise; + + const traceId = inboundTransaction?.contexts?.trace?.trace_id; + const spanId = inboundTransaction?.spans?.find(span => span.op === 'http.client')?.span_id; + + expect(traceId).toEqual(expect.any(String)); + expect(spanId).toEqual(expect.any(String)); + + expect(data.route).toBe('/external-disallowed'); + expect(data.headers?.['sentry-trace']).toBeUndefined(); + expect(data.headers?.baggage).toBeUndefined(); +}); + +test('Propagates trace for outgoing external fetch requests', async ({ baseURL }) => { + const inboundTransactionPromise = waitForTransaction('node-fastify-app', transactionEvent => { + return ( + transactionEvent?.contexts?.trace?.op === 'http.server' && + transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-outgoing-fetch-external-allowed` + ); + }); + + const { data } = await axios.get(`${baseURL}/test-outgoing-fetch-external-allowed`); + + const inboundTransaction = await inboundTransactionPromise; + + const traceId = inboundTransaction?.contexts?.trace?.trace_id; + const spanId = inboundTransaction?.spans?.find(span => span.op === 'http.client')?.span_id; + + expect(traceId).toEqual(expect.any(String)); + expect(spanId).toEqual(expect.any(String)); + + expect(data).toEqual({ + route: '/external-allowed', + headers: expect.objectContaining({ + 'sentry-trace': `${traceId}-${spanId}-1`, + baggage: expect.any(String), + }), + }); + + const baggage = (data.headers.baggage || '').split(','); + expect(baggage).toEqual( + expect.arrayContaining([ + 'sentry-environment=qa', + `sentry-trace_id=${traceId}`, + expect.stringMatching(/sentry-public_key=/), + ]), + ); +}); + +test('Does not propagate outgoing fetch requests not covered by tracePropagationTargets', async ({ baseURL }) => { + const inboundTransactionPromise = waitForTransaction('node-fastify-app', transactionEvent => { + return ( + transactionEvent?.contexts?.trace?.op === 'http.server' && + transactionEvent.contexts?.trace?.data?.['http.target'] === `/test-outgoing-fetch-external-disallowed` + ); + }); + + const { data } = await axios.get(`${baseURL}/test-outgoing-fetch-external-disallowed`); + + const inboundTransaction = await inboundTransactionPromise; + + const traceId = inboundTransaction?.contexts?.trace?.trace_id; + const spanId = inboundTransaction?.spans?.find(span => span.op === 'http.client')?.span_id; + + expect(traceId).toEqual(expect.any(String)); + expect(spanId).toEqual(expect.any(String)); + + expect(data.route).toBe('/external-disallowed'); + expect(data.headers?.['sentry-trace']).toBeUndefined(); + expect(data.headers?.baggage).toBeUndefined(); +}); diff --git a/dev-packages/e2e-tests/test-applications/react-create-hash-router/tsconfig.json b/dev-packages/e2e-tests/test-applications/react-create-hash-router/tsconfig.json index 75ae036f46b0..4cc95dc2689a 100644 --- a/dev-packages/e2e-tests/test-applications/react-create-hash-router/tsconfig.json +++ b/dev-packages/e2e-tests/test-applications/react-create-hash-router/tsconfig.json @@ -1,6 +1,6 @@ { "compilerOptions": { - "target": "es2017", + "target": "es2018", "lib": ["dom", "dom.iterable", "esnext"], "allowJs": true, "skipLibCheck": true, diff --git a/dev-packages/e2e-tests/test-applications/react-router-6-use-routes/tsconfig.json b/dev-packages/e2e-tests/test-applications/react-router-6-use-routes/tsconfig.json index 75ae036f46b0..4cc95dc2689a 100644 --- a/dev-packages/e2e-tests/test-applications/react-router-6-use-routes/tsconfig.json +++ b/dev-packages/e2e-tests/test-applications/react-router-6-use-routes/tsconfig.json @@ -1,6 +1,6 @@ { "compilerOptions": { - "target": "es2017", + "target": "es2018", "lib": ["dom", "dom.iterable", "esnext"], "allowJs": true, "skipLibCheck": true, diff --git a/dev-packages/e2e-tests/test-applications/standard-frontend-react/tsconfig.json b/dev-packages/e2e-tests/test-applications/standard-frontend-react/tsconfig.json index 75ae036f46b0..4cc95dc2689a 100644 --- a/dev-packages/e2e-tests/test-applications/standard-frontend-react/tsconfig.json +++ b/dev-packages/e2e-tests/test-applications/standard-frontend-react/tsconfig.json @@ -1,6 +1,6 @@ { "compilerOptions": { - "target": "es2017", + "target": "es2018", "lib": ["dom", "dom.iterable", "esnext"], "allowJs": true, "skipLibCheck": true, diff --git a/dev-packages/e2e-tests/test-applications/sveltekit-2/src/routes/+page.svelte b/dev-packages/e2e-tests/test-applications/sveltekit-2/src/routes/+page.svelte index 29ce9ec693a8..d8175182884a 100644 --- a/dev-packages/e2e-tests/test-applications/sveltekit-2/src/routes/+page.svelte +++ b/dev-packages/e2e-tests/test-applications/sveltekit-2/src/routes/+page.svelte @@ -26,4 +26,7 @@
  • Redirect
    • +
  • + Route with nested fetch in server load +
    • diff --git a/dev-packages/e2e-tests/test-applications/sveltekit-2/src/routes/server-load-fetch/+page.server.ts b/dev-packages/e2e-tests/test-applications/sveltekit-2/src/routes/server-load-fetch/+page.server.ts new file mode 100644 index 000000000000..709e52bcf351 --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/sveltekit-2/src/routes/server-load-fetch/+page.server.ts @@ -0,0 +1,5 @@ +export const load = async ({ fetch }) => { + const res = await fetch('/api/users'); + const data = await res.json(); + return { data }; +}; diff --git a/dev-packages/e2e-tests/test-applications/sveltekit-2/src/routes/server-load-fetch/+page.svelte b/dev-packages/e2e-tests/test-applications/sveltekit-2/src/routes/server-load-fetch/+page.svelte new file mode 100644 index 000000000000..f7f814d31b4d --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/sveltekit-2/src/routes/server-load-fetch/+page.svelte @@ -0,0 +1,8 @@ + + +
    +

    Server Load Fetch

    +

    {JSON.stringify(data, null, 2)}

    +
    diff --git a/dev-packages/e2e-tests/test-applications/sveltekit-2/test/performance.server.test.ts b/dev-packages/e2e-tests/test-applications/sveltekit-2/test/performance.server.test.ts new file mode 100644 index 000000000000..7aec23b30d7a --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/sveltekit-2/test/performance.server.test.ts @@ -0,0 +1,35 @@ +import { expect, test } from '@playwright/test'; +import { waitForTransaction } from '../event-proxy-server'; + +test('server pageload request span has nested request span for sub request', async ({ page }) => { + const serverTxnEventPromise = waitForTransaction('sveltekit-2', txnEvent => { + return txnEvent?.transaction === 'GET /server-load-fetch'; + }); + + await page.goto('/server-load-fetch'); + + const serverTxnEvent = await serverTxnEventPromise; + const spans = serverTxnEvent.spans; + + expect(serverTxnEvent).toMatchObject({ + transaction: 'GET /server-load-fetch', + tags: { runtime: 'node' }, + transaction_info: { source: 'route' }, + type: 'transaction', + contexts: { + trace: { + op: 'http.server', + origin: 'auto.http.sveltekit', + }, + }, + }); + + expect(spans).toEqual( + expect.arrayContaining([ + // load span where the server load function initiates the sub request: + expect.objectContaining({ op: 'function.sveltekit.server.load', description: '/server-load-fetch' }), + // sub request span: + expect.objectContaining({ op: 'http.server', description: 'GET /api/users' }), + ]), + ); +}); diff --git a/dev-packages/e2e-tests/test-applications/sveltekit/package.json b/dev-packages/e2e-tests/test-applications/sveltekit/package.json index c1ed602844c1..5a6b2d4d083c 100644 --- a/dev-packages/e2e-tests/test-applications/sveltekit/package.json +++ b/dev-packages/e2e-tests/test-applications/sveltekit/package.json @@ -22,7 +22,7 @@ "@sentry/utils": "latest || *", "@sveltejs/adapter-auto": "^2.0.0", "@sveltejs/adapter-node": "^1.2.4", - "@sveltejs/kit": "^1.30.3", + "@sveltejs/kit": "1.20.5", "svelte": "^3.54.0", "svelte-check": "^3.0.1", "ts-node": "10.9.1", diff --git a/dev-packages/e2e-tests/test-applications/sveltekit/src/routes/+page.svelte b/dev-packages/e2e-tests/test-applications/sveltekit/src/routes/+page.svelte index aeb12d58603f..62dbf7856ab7 100644 --- a/dev-packages/e2e-tests/test-applications/sveltekit/src/routes/+page.svelte +++ b/dev-packages/e2e-tests/test-applications/sveltekit/src/routes/+page.svelte @@ -23,4 +23,7 @@
  • Route with fetch in universal load
    • +
  • + Route with nested fetch in server load +
    • diff --git a/dev-packages/e2e-tests/test-applications/sveltekit/src/routes/server-load-fetch/+page.server.ts b/dev-packages/e2e-tests/test-applications/sveltekit/src/routes/server-load-fetch/+page.server.ts new file mode 100644 index 000000000000..709e52bcf351 --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/sveltekit/src/routes/server-load-fetch/+page.server.ts @@ -0,0 +1,5 @@ +export const load = async ({ fetch }) => { + const res = await fetch('/api/users'); + const data = await res.json(); + return { data }; +}; diff --git a/dev-packages/e2e-tests/test-applications/sveltekit/src/routes/server-load-fetch/+page.svelte b/dev-packages/e2e-tests/test-applications/sveltekit/src/routes/server-load-fetch/+page.svelte new file mode 100644 index 000000000000..f7f814d31b4d --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/sveltekit/src/routes/server-load-fetch/+page.svelte @@ -0,0 +1,8 @@ + + +
    +

    Server Load Fetch

    +

    {JSON.stringify(data, null, 2)}

    +
    diff --git a/dev-packages/e2e-tests/test-applications/sveltekit/test/performance.server.test.ts b/dev-packages/e2e-tests/test-applications/sveltekit/test/performance.server.test.ts new file mode 100644 index 000000000000..49fde5f01045 --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/sveltekit/test/performance.server.test.ts @@ -0,0 +1,35 @@ +import { expect, test } from '@playwright/test'; +import { waitForTransaction } from '../event-proxy-server'; + +test('server pageload request span has nested request span for sub request', async ({ page }) => { + const serverTxnEventPromise = waitForTransaction('sveltekit', txnEvent => { + return txnEvent?.transaction === 'GET /server-load-fetch'; + }); + + await page.goto('/server-load-fetch'); + + const serverTxnEvent = await serverTxnEventPromise; + const spans = serverTxnEvent.spans; + + expect(serverTxnEvent).toMatchObject({ + transaction: 'GET /server-load-fetch', + tags: { runtime: 'node' }, + transaction_info: { source: 'route' }, + type: 'transaction', + contexts: { + trace: { + op: 'http.server', + origin: 'auto.http.sveltekit', + }, + }, + }); + + expect(spans).toEqual( + expect.arrayContaining([ + // load span where the server load function initiates the sub request: + expect.objectContaining({ op: 'function.sveltekit.server.load', description: '/server-load-fetch' }), + // sub request span: + expect.objectContaining({ op: 'http.server', description: 'GET /api/users' }), + ]), + ); +}); diff --git a/dev-packages/e2e-tests/test-applications/webpack-5/.npmrc b/dev-packages/e2e-tests/test-applications/webpack-5/.npmrc new file mode 100644 index 000000000000..070f80f05092 --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/webpack-5/.npmrc @@ -0,0 +1,2 @@ +@sentry:registry=http://127.0.0.1:4873 +@sentry-internal:registry=http://127.0.0.1:4873 diff --git a/dev-packages/e2e-tests/test-applications/webpack-5/build.mjs b/dev-packages/e2e-tests/test-applications/webpack-5/build.mjs new file mode 100644 index 000000000000..11874cb62374 --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/webpack-5/build.mjs @@ -0,0 +1,44 @@ +import * as path from 'path'; +import * as url from 'url'; +import HtmlWebpackPlugin from 'html-webpack-plugin'; +import TerserPlugin from 'terser-webpack-plugin'; +import webpack from 'webpack'; + +const __dirname = path.dirname(url.fileURLToPath(import.meta.url)); + +webpack( + { + entry: path.join(__dirname, 'entry.js'), + output: { + path: path.join(__dirname, 'build'), + filename: 'app.js', + }, + optimization: { + minimize: true, + minimizer: [new TerserPlugin()], + }, + plugins: [new HtmlWebpackPlugin(), new webpack.EnvironmentPlugin(['E2E_TEST_DSN'])], + mode: 'production', + }, + (err, stats) => { + if (err) { + console.error(err.stack || err); + if (err.details) { + console.error(err.details); + } + return; + } + + const info = stats.toJson(); + + if (stats.hasErrors()) { + console.error(info.errors); + process.exit(1); + } + + if (stats.hasWarnings()) { + console.warn(info.warnings); + process.exit(1); + } + }, +); diff --git a/dev-packages/e2e-tests/test-applications/webpack-5/entry.js b/dev-packages/e2e-tests/test-applications/webpack-5/entry.js new file mode 100644 index 000000000000..4fd9cd67e7e3 --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/webpack-5/entry.js @@ -0,0 +1,11 @@ +import { browserTracingIntegration, captureException, init } from '@sentry/browser'; + +init({ + dsn: process.env.E2E_TEST_DSN, + integrations: [browserTracingIntegration()], +}); + +setTimeout(() => { + const eventId = captureException(new Error('I am an error!')); + window.capturedExceptionId = eventId; +}, 2000); diff --git a/dev-packages/e2e-tests/test-applications/webpack-5/package.json b/dev-packages/e2e-tests/test-applications/webpack-5/package.json new file mode 100644 index 000000000000..871e43589971 --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/webpack-5/package.json @@ -0,0 +1,18 @@ +{ + "name": "webpack-5-test", + "version": "1.0.0", + "scripts": { + "start": "serve -s build", + "build": "node build.mjs", + "test:build": "pnpm install && npx playwright install && pnpm build", + "test:assert": "playwright test" + }, + "devDependencies": { + "@playwright/test": "^1.42.1", + "@sentry/browser": "latest || *", + "webpack": "^5.91.0", + "terser-webpack-plugin": "^5.3.10", + "html-webpack-plugin": "^5.6.0", + "serve": "^14.2.1" + } +} diff --git a/dev-packages/e2e-tests/test-applications/webpack-5/playwright.config.ts b/dev-packages/e2e-tests/test-applications/webpack-5/playwright.config.ts new file mode 100644 index 000000000000..5f93f826ebf0 --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/webpack-5/playwright.config.ts @@ -0,0 +1,70 @@ +import type { PlaywrightTestConfig } from '@playwright/test'; +import { devices } from '@playwright/test'; + +/** + * See https://playwright.dev/docs/test-configuration. + */ +const config: PlaywrightTestConfig = { + testDir: './tests', + /* Maximum time one test can run for. */ + timeout: 150_000, + expect: { + /** + * Maximum time expect() should wait for the condition to be met. + * For example in `await expect(locator).toHaveText();` + */ + timeout: 5000, + }, + /* Run tests in files in parallel */ + fullyParallel: true, + /* Fail the build on CI if you accidentally left test.only in the source code. */ + forbidOnly: !!process.env.CI, + /* Retry on CI only */ + retries: 0, + /* Opt out of parallel tests on CI. */ + workers: 1, + /* Reporter to use. See https://playwright.dev/docs/test-reporters */ + reporter: 'list', + /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */ + use: { + /* Maximum time each action such as `click()` can take. Defaults to 0 (no limit). */ + actionTimeout: 0, + + /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */ + trace: 'on-first-retry', + }, + + /* Configure projects for major browsers */ + projects: [ + { + name: 'chromium', + use: { + ...devices['Desktop Chrome'], + }, + }, + // For now we only test Chrome! + // { + // name: 'firefox', + // use: { + // ...devices['Desktop Firefox'], + // }, + // }, + // { + // name: 'webkit', + // use: { + // ...devices['Desktop Safari'], + // }, + // }, + ], + + /* Run your local dev server before starting the tests */ + webServer: { + command: 'pnpm start', + port: 3030, + env: { + PORT: '3030', + }, + }, +}; + +export default config; diff --git a/dev-packages/e2e-tests/test-applications/webpack-5/tests/behaviour-test.spec.ts b/dev-packages/e2e-tests/test-applications/webpack-5/tests/behaviour-test.spec.ts new file mode 100644 index 000000000000..4f762a4028d4 --- /dev/null +++ b/dev-packages/e2e-tests/test-applications/webpack-5/tests/behaviour-test.spec.ts @@ -0,0 +1,44 @@ +import { expect, test } from '@playwright/test'; +import axios, { AxiosError } from 'axios'; + +const EVENT_POLLING_TIMEOUT = 90_000; + +const authToken = process.env.E2E_TEST_AUTH_TOKEN; +const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG; +const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT; + +test('Sends an exception to Sentry', async ({ page }) => { + await page.goto('/'); + + const exceptionIdHandle = await page.waitForFunction(() => window.capturedExceptionId); + const exceptionEventId = await exceptionIdHandle.jsonValue(); + + console.log(`Polling for error eventId: ${exceptionEventId}`); + + await expect + .poll( + async () => { + try { + const response = await axios.get( + `https://sentry.io/api/0/projects/${sentryTestOrgSlug}/${sentryTestProject}/events/${exceptionEventId}/`, + { headers: { Authorization: `Bearer ${authToken}` } }, + ); + return response.status; + } catch (e) { + if (e instanceof AxiosError && e.response) { + if (e.response.status !== 404) { + throw e; + } else { + return e.response.status; + } + } else { + throw e; + } + } + }, + { + timeout: EVENT_POLLING_TIMEOUT, + }, + ) + .toBe(200); +}); diff --git a/dev-packages/e2e-tests/verdaccio-config/config.yaml b/dev-packages/e2e-tests/verdaccio-config/config.yaml index 0fb3e645d81f..2cb28f875977 100644 --- a/dev-packages/e2e-tests/verdaccio-config/config.yaml +++ b/dev-packages/e2e-tests/verdaccio-config/config.yaml @@ -122,12 +122,6 @@ packages: unpublish: $all # proxy: npmjs # Don't proxy for E2E tests! - '@sentry/replay': - access: $all - publish: $all - unpublish: $all - # proxy: npmjs # Don't proxy for E2E tests! - '@sentry/aws-serverless': access: $all publish: $all diff --git a/dev-packages/node-integration-tests/suites/anr/basic-session.js b/dev-packages/node-integration-tests/suites/anr/basic-session.js index 153acf83f16f..5661e08b850b 100644 --- a/dev-packages/node-integration-tests/suites/anr/basic-session.js +++ b/dev-packages/node-integration-tests/suites/anr/basic-session.js @@ -15,6 +15,9 @@ Sentry.init({ autoSessionTracking: true, }); +Sentry.setUser({ email: 'person@home.com' }); +Sentry.addBreadcrumb({ message: 'important message!' }); + function longWork() { for (let i = 0; i < 20; i++) { const salt = crypto.randomBytes(128).toString('base64'); diff --git a/dev-packages/node-integration-tests/suites/anr/basic.js b/dev-packages/node-integration-tests/suites/anr/basic.js index 712e0e26a3f8..d98b18216703 100644 --- a/dev-packages/node-integration-tests/suites/anr/basic.js +++ b/dev-packages/node-integration-tests/suites/anr/basic.js @@ -15,6 +15,9 @@ Sentry.init({ integrations: [Sentry.anrIntegration({ captureStackTrace: true, anrThreshold: 100 })], }); +Sentry.setUser({ email: 'person@home.com' }); +Sentry.addBreadcrumb({ message: 'important message!' }); + function longWork() { for (let i = 0; i < 20; i++) { const salt = crypto.randomBytes(128).toString('base64'); diff --git a/dev-packages/node-integration-tests/suites/anr/basic.mjs b/dev-packages/node-integration-tests/suites/anr/basic.mjs index 0184ca9583f7..77bb9ae3626d 100644 --- a/dev-packages/node-integration-tests/suites/anr/basic.mjs +++ b/dev-packages/node-integration-tests/suites/anr/basic.mjs @@ -15,6 +15,9 @@ Sentry.init({ integrations: [Sentry.anrIntegration({ captureStackTrace: true, anrThreshold: 100 })], }); +Sentry.setUser({ email: 'person@home.com' }); +Sentry.addBreadcrumb({ message: 'important message!' }); + function longWork() { for (let i = 0; i < 20; i++) { const salt = crypto.randomBytes(128).toString('base64'); diff --git a/dev-packages/node-integration-tests/suites/anr/forked.js b/dev-packages/node-integration-tests/suites/anr/forked.js index 0db282eacb07..06529096cca5 100644 --- a/dev-packages/node-integration-tests/suites/anr/forked.js +++ b/dev-packages/node-integration-tests/suites/anr/forked.js @@ -15,6 +15,9 @@ Sentry.init({ integrations: [Sentry.anrIntegration({ captureStackTrace: true, anrThreshold: 100 })], }); +Sentry.setUser({ email: 'person@home.com' }); +Sentry.addBreadcrumb({ message: 'important message!' }); + function longWork() { for (let i = 0; i < 20; i++) { const salt = crypto.randomBytes(128).toString('base64'); diff --git a/dev-packages/node-integration-tests/suites/anr/isolated.mjs b/dev-packages/node-integration-tests/suites/anr/isolated.mjs new file mode 100644 index 000000000000..d9b179c63e71 --- /dev/null +++ b/dev-packages/node-integration-tests/suites/anr/isolated.mjs @@ -0,0 +1,53 @@ +import * as assert from 'assert'; +import * as crypto from 'crypto'; + +import * as Sentry from '@sentry/node'; + +setTimeout(() => { + process.exit(); +}, 10000); + +Sentry.init({ + dsn: 'https://public@dsn.ingest.sentry.io/1337', + release: '1.0', + debug: true, + autoSessionTracking: false, + integrations: [Sentry.anrIntegration({ captureStackTrace: true, anrThreshold: 100 })], +}); + +async function longWork() { + await new Promise(resolve => setTimeout(resolve, 1000)); + + for (let i = 0; i < 20; i++) { + const salt = crypto.randomBytes(128).toString('base64'); + const hash = crypto.pbkdf2Sync('myPassword', salt, 10000, 512, 'sha512'); + assert.ok(hash); + } +} + +function neverResolve() { + return new Promise(() => { + // + }); +} + +const fns = [ + neverResolve, + neverResolve, + neverResolve, + neverResolve, + neverResolve, + longWork, // [5] + neverResolve, + neverResolve, + neverResolve, + neverResolve, +]; + +for (let id = 0; id < 10; id++) { + Sentry.withIsolationScope(async () => { + Sentry.setUser({ id }); + + await fns[id](); + }); +} diff --git a/dev-packages/node-integration-tests/suites/anr/stop-and-start.js b/dev-packages/node-integration-tests/suites/anr/stop-and-start.js index 9de453abf23d..4f9fc9bc64db 100644 --- a/dev-packages/node-integration-tests/suites/anr/stop-and-start.js +++ b/dev-packages/node-integration-tests/suites/anr/stop-and-start.js @@ -17,6 +17,9 @@ Sentry.init({ integrations: [anr], }); +Sentry.setUser({ email: 'person@home.com' }); +Sentry.addBreadcrumb({ message: 'important message!' }); + function longWorkIgnored() { for (let i = 0; i < 20; i++) { const salt = crypto.randomBytes(128).toString('base64'); diff --git a/dev-packages/node-integration-tests/suites/anr/test.ts b/dev-packages/node-integration-tests/suites/anr/test.ts index 7ace974d6170..b0299f4a038d 100644 --- a/dev-packages/node-integration-tests/suites/anr/test.ts +++ b/dev-packages/node-integration-tests/suites/anr/test.ts @@ -21,6 +21,15 @@ const EXPECTED_ANR_EVENT = { timezone: expect.any(String), }, }, + user: { + email: 'person@home.com', + }, + breadcrumbs: [ + { + timestamp: expect.any(Number), + message: 'important message!', + }, + ], // and an exception that is our ANR exception: { values: [ @@ -105,4 +114,34 @@ conditionalTest({ min: 16 })('should report ANR when event loop blocked', () => test('worker can be stopped and restarted', done => { createRunner(__dirname, 'stop-and-start.js').expect({ event: EXPECTED_ANR_EVENT }).start(done); }); + + const EXPECTED_ISOLATED_EVENT = { + user: { + id: 5, + }, + exception: { + values: [ + { + type: 'ApplicationNotResponding', + value: 'Application Not Responding for at least 100 ms', + mechanism: { type: 'ANR' }, + stacktrace: { + frames: expect.arrayContaining([ + { + colno: expect.any(Number), + lineno: expect.any(Number), + filename: expect.stringMatching(/isolated.mjs$/), + function: 'longWork', + in_app: true, + }, + ]), + }, + }, + ], + }, + }; + + test('fetches correct isolated scope', done => { + createRunner(__dirname, 'isolated.mjs').expect({ event: EXPECTED_ISOLATED_EVENT }).start(done); + }); }); diff --git a/dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-header-out/server.ts b/dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-header-out/server.ts index 64f697ca086c..e849eca7b9f2 100644 --- a/dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-header-out/server.ts +++ b/dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-header-out/server.ts @@ -28,12 +28,11 @@ app.use(cors()); app.get('/test/express', (_req, res) => { // eslint-disable-next-line deprecation/deprecation const transaction = Sentry.getCurrentScope().getTransaction(); - if (transaction) { - // eslint-disable-next-line deprecation/deprecation - transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd'; - } + const traceId = transaction?.spanContext().traceId; const headers = http.get('http://somewhere.not.sentry/').getHeaders(); - + if (traceId) { + headers['baggage'] = (headers['baggage'] as string).replace(traceId, '__SENTRY_TRACE_ID__'); + } // Responding with the headers outgoing request headers back to the assertions. res.send({ test_data: headers }); }); diff --git a/dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-header-out/test.ts b/dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-header-out/test.ts index 3cd2e9984685..c3add50d89cd 100644 --- a/dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-header-out/test.ts +++ b/dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-header-out/test.ts @@ -16,7 +16,7 @@ test('should attach a baggage header to an outgoing request.', async () => { host: 'somewhere.not.sentry', baggage: 'sentry-environment=prod,sentry-release=1.0,sentry-public_key=public' + - ',sentry-trace_id=86f39e84263a4de99c326acab3bfe3bd,sentry-sample_rate=1,sentry-transaction=GET%20%2Ftest%2Fexpress' + + ',sentry-trace_id=__SENTRY_TRACE_ID__,sentry-sample_rate=1,sentry-transaction=GET%20%2Ftest%2Fexpress' + ',sentry-sampled=true', }, }); diff --git a/dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts b/dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts index 8616908dd6d5..2e5cfedb8046 100644 --- a/dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts +++ b/dev-packages/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts @@ -32,13 +32,9 @@ app.use(cors()); app.get('/test/express', (_req, res) => { // eslint-disable-next-line deprecation/deprecation const transaction = Sentry.getCurrentScope().getTransaction(); - if (transaction) { - // eslint-disable-next-line deprecation/deprecation - transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd'; - transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route'); - } - const headers = http.get('http://somewhere.not.sentry/').getHeaders(); + transaction?.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route'); + const headers = http.get('http://somewhere.not.sentry/').getHeaders(); // Responding with the headers outgoing request headers back to the assertions. res.send({ test_data: headers }); }); diff --git a/dev-packages/node-integration-tests/suites/public-api/LocalVariables/local-variables-caught.mjs b/dev-packages/node-integration-tests/suites/public-api/LocalVariables/local-variables-caught.mjs index a7427ac60157..8fec9dbb1dad 100644 --- a/dev-packages/node-integration-tests/suites/public-api/LocalVariables/local-variables-caught.mjs +++ b/dev-packages/node-integration-tests/suites/public-api/LocalVariables/local-variables-caught.mjs @@ -9,12 +9,14 @@ Sentry.init({ }); class Some { - two(name) { - throw new Error('Enough!'); + async two(name) { + return new Promise((_, reject) => { + reject(new Error('Enough!')); + }); } } -function one(name) { +async function one(name) { const arr = [1, '2', null]; const obj = { name, @@ -30,12 +32,12 @@ function one(name) { const ty = new Some(); - ty.two(name); + await ty.two(name); } -setTimeout(() => { +setTimeout(async () => { try { - one('some name'); + await one('some name'); } catch (e) { Sentry.captureException(e); } diff --git a/dev-packages/node-integration-tests/suites/public-api/LocalVariables/test.ts b/dev-packages/node-integration-tests/suites/public-api/LocalVariables/test.ts index 3a8d904de3c9..e2aa6c405773 100644 --- a/dev-packages/node-integration-tests/suites/public-api/LocalVariables/test.ts +++ b/dev-packages/node-integration-tests/suites/public-api/LocalVariables/test.ts @@ -84,7 +84,7 @@ conditionalTest({ min: 18 })('LocalVariables integration', () => { child.on('message', msg => { reportedCount++; - const rssMb = msg.memUsage.rss / 1024 / 1024; + const rssMb = (msg as { memUsage: { rss: number } }).memUsage.rss / 1024 / 1024; // We shouldn't use more than 120MB of memory expect(rssMb).toBeLessThan(120); }); diff --git a/dev-packages/node-integration-tests/suites/tracing-experimental/hapi/scenario.js b/dev-packages/node-integration-tests/suites/tracing-experimental/hapi/scenario.js index 9a00fa36957d..69443559e9a8 100644 --- a/dev-packages/node-integration-tests/suites/tracing-experimental/hapi/scenario.js +++ b/dev-packages/node-integration-tests/suites/tracing-experimental/hapi/scenario.js @@ -9,6 +9,7 @@ Sentry.init({ }); const Hapi = require('@hapi/hapi'); +const Boom = require('@hapi/boom'); const port = 5999; @@ -26,6 +27,30 @@ const init = async () => { }, }); + server.route({ + method: 'GET', + path: '/error', + handler: (_request, _h) => { + return new Error('Sentry Test Error'); + }, + }); + + server.route({ + method: 'GET', + path: '/boom-error', + handler: (_request, _h) => { + return new Boom.Boom('Sentry Test Error'); + }, + }); + + server.route({ + method: 'GET', + path: '/promise-error', + handler: async (_request, _h) => { + return Promise.reject(new Error('Sentry Test Error')); + }, + }); + await Sentry.setupHapiErrorHandler(server); await server.start(); diff --git a/dev-packages/node-integration-tests/suites/tracing-experimental/hapi/test.ts b/dev-packages/node-integration-tests/suites/tracing-experimental/hapi/test.ts index 93e3203f6470..e5903c536a95 100644 --- a/dev-packages/node-integration-tests/suites/tracing-experimental/hapi/test.ts +++ b/dev-packages/node-integration-tests/suites/tracing-experimental/hapi/test.ts @@ -25,10 +25,60 @@ describe('hapi auto-instrumentation', () => { ]), }; + const EXPECTED_ERROR_EVENT = { + exception: { + values: [ + { + type: 'Error', + value: 'Sentry Test Error', + }, + ], + }, + }; + test('CJS - should auto-instrument `@hapi/hapi` package.', done => { createRunner(__dirname, 'scenario.js') .expect({ transaction: EXPECTED_TRANSACTION }) .start(done) .makeRequest('get', '/'); }); + + test('CJS - should handle returned plain errors in routes.', done => { + createRunner(__dirname, 'scenario.js') + .expect({ + transaction: { + transaction: 'GET /error', + }, + }) + .expect({ event: EXPECTED_ERROR_EVENT }) + .expectError() + .start(done) + .makeRequest('get', '/error'); + }); + + test('CJS - should handle returned Boom errors in routes.', done => { + createRunner(__dirname, 'scenario.js') + .expect({ + transaction: { + transaction: 'GET /boom-error', + }, + }) + .expect({ event: EXPECTED_ERROR_EVENT }) + .expectError() + .start(done) + .makeRequest('get', '/boom-error'); + }); + + test('CJS - should handle promise rejections in routes.', done => { + createRunner(__dirname, 'scenario.js') + .expect({ + transaction: { + transaction: 'GET /promise-error', + }, + }) + .expect({ event: EXPECTED_ERROR_EVENT }) + .expectError() + .start(done) + .makeRequest('get', '/promise-error'); + }); }); diff --git a/dev-packages/node-integration-tests/suites/tracing-experimental/mysql/scenario-withoutCallback.js b/dev-packages/node-integration-tests/suites/tracing-experimental/mysql/scenario-withoutCallback.js index 00049bd31b92..f80514b7ada1 100644 --- a/dev-packages/node-integration-tests/suites/tracing-experimental/mysql/scenario-withoutCallback.js +++ b/dev-packages/node-integration-tests/suites/tracing-experimental/mysql/scenario-withoutCallback.js @@ -24,7 +24,7 @@ connection.connect(function (err) { } }); -Sentry.startSpan( +Sentry.startSpanManual( { op: 'transaction', name: 'Test Transaction', diff --git a/dev-packages/node-integration-tests/suites/tracing-experimental/prisma-orm/scenario.js b/dev-packages/node-integration-tests/suites/tracing-experimental/prisma-orm/scenario.js index 58b46ac1cf3a..7f291290bea2 100644 --- a/dev-packages/node-integration-tests/suites/tracing-experimental/prisma-orm/scenario.js +++ b/dev-packages/node-integration-tests/suites/tracing-experimental/prisma-orm/scenario.js @@ -9,6 +9,7 @@ Sentry.init({ release: '1.0', tracesSampleRate: 1.0, transport: loggingTransport, + integrations: [Sentry.prismaIntegration()], }); // Stop the process from exiting before the transaction is sent diff --git a/dev-packages/node-integration-tests/suites/tracing/tracePropagationTargetsDisabled/scenario.ts b/dev-packages/node-integration-tests/suites/tracing/tracePropagationTargetsDisabled/scenario.ts deleted file mode 100644 index cfad7894d2b8..000000000000 --- a/dev-packages/node-integration-tests/suites/tracing/tracePropagationTargetsDisabled/scenario.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as http from 'http'; -import * as Sentry from '@sentry/node-experimental'; - -Sentry.init({ - dsn: 'https://public@dsn.ingest.sentry.io/1337', - release: '1.0', - tracesSampleRate: 1.0, - tracePropagationTargets: [/\/v0/, 'v1'], - integrations: [Sentry.httpIntegration({ tracing: true })], -}); - -Sentry.startSpan({ name: 'test_transaction' }, () => { - http.get('http://match-this-url.com/api/v0'); - http.get('http://match-this-url.com/api/v1'); - http.get('http://dont-match-this-url.com/api/v2'); - http.get('http://dont-match-this-url.com/api/v3'); -}); diff --git a/dev-packages/node-integration-tests/suites/tracing/tracePropagationTargetsDisabled/test.ts b/dev-packages/node-integration-tests/suites/tracing/tracePropagationTargetsDisabled/test.ts deleted file mode 100644 index 6fa28a13c5e1..000000000000 --- a/dev-packages/node-integration-tests/suites/tracing/tracePropagationTargetsDisabled/test.ts +++ /dev/null @@ -1,42 +0,0 @@ -import nock from 'nock'; - -import { TestEnv, runScenario } from '../../../utils'; - -test('httpIntegration should not instrument when tracing is enabled', async () => { - const match1 = nock('http://match-this-url.com') - .get('/api/v0') - .matchHeader('baggage', val => val === undefined) - .matchHeader('sentry-trace', val => val === undefined) - .reply(200); - - const match2 = nock('http://match-this-url.com') - .get('/api/v1') - .matchHeader('baggage', val => val === undefined) - .matchHeader('sentry-trace', val => val === undefined) - .reply(200); - - const match3 = nock('http://dont-match-this-url.com') - .get('/api/v2') - .matchHeader('baggage', val => val === undefined) - .matchHeader('sentry-trace', val => val === undefined) - .reply(200); - - const match4 = nock('http://dont-match-this-url.com') - .get('/api/v3') - .matchHeader('baggage', val => val === undefined) - .matchHeader('sentry-trace', val => val === undefined) - .reply(200); - - const env = await TestEnv.init(__dirname); - await runScenario(env.url); - - env.server.close(); - nock.cleanAll(); - - await new Promise(resolve => env.server.close(resolve)); - - expect(match1.isDone()).toBe(true); - expect(match2.isDone()).toBe(true); - expect(match3.isDone()).toBe(true); - expect(match4.isDone()).toBe(true); -}); diff --git a/dev-packages/node-integration-tests/utils/index.ts b/dev-packages/node-integration-tests/utils/index.ts index b2b81361c0ea..ac0bbf997d0b 100644 --- a/dev-packages/node-integration-tests/utils/index.ts +++ b/dev-packages/node-integration-tests/utils/index.ts @@ -1,4 +1,4 @@ -import type * as http from 'http'; +import * as http from 'http'; import type { AddressInfo } from 'net'; import * as path from 'path'; /* eslint-disable @typescript-eslint/no-unsafe-member-access */ @@ -212,7 +212,11 @@ export class TestEnv { endServer: boolean = true, ): Promise { try { - const { data } = await axios.get(url || this.url, { headers }); + const { data } = await axios.get(url || this.url, { + headers, + // KeepAlive false to work around a Node 20 bug with ECONNRESET: https://github.com/axios/axios/issues/5929 + httpAgent: new http.Agent({ keepAlive: false }), + }); return data; } finally { await Sentry.flush(); diff --git a/dev-packages/node-integration-tests/utils/runner.ts b/dev-packages/node-integration-tests/utils/runner.ts index 515a2627acf8..a9f3a94d4e3d 100644 --- a/dev-packages/node-integration-tests/utils/runner.ts +++ b/dev-packages/node-integration-tests/utils/runner.ts @@ -126,6 +126,7 @@ export function createRunner(...paths: string[]) { let withSentryServer = false; let dockerOptions: DockerOptions | undefined; let ensureNoErrorOutput = false; + let expectError = false; if (testPath.endsWith('.ts')) { flags.push('-r', 'ts-node/register'); @@ -136,6 +137,10 @@ export function createRunner(...paths: string[]) { expectedEnvelopes.push(expected); return this; }, + expectError: function () { + expectError = true; + return this; + }, withFlags: function (...args: string[]) { flags.push(...args); return this; @@ -268,7 +273,7 @@ export function createRunner(...paths: string[]) { }); if (ensureNoErrorOutput) { - child.stderr.on('data', (data: Buffer) => { + child.stderr?.on('data', (data: Buffer) => { const output = data.toString(); complete(new Error(`Expected no error output but got: '${output}'`)); }); @@ -314,7 +319,7 @@ export function createRunner(...paths: string[]) { } let buffer = Buffer.alloc(0); - child.stdout.on('data', (data: Buffer) => { + child.stdout?.on('data', (data: Buffer) => { // This is horribly memory inefficient but it's only for tests buffer = Buffer.concat([buffer, data]); @@ -347,7 +352,18 @@ export function createRunner(...paths: string[]) { } const url = `http://localhost:${scenarioServerPort}${path}`; - if (method === 'get') { + if (expectError) { + try { + if (method === 'get') { + await axios.get(url, { headers }); + } else { + await axios.post(url, { headers }); + } + } catch (e) { + return; + } + return; + } else if (method === 'get') { return (await axios.get(url, { headers })).data; } else { return (await axios.post(url, { headers })).data; diff --git a/dev-packages/rollup-utils/npmHelpers.mjs b/dev-packages/rollup-utils/npmHelpers.mjs index 58bb4d75edf7..86941fc8db29 100644 --- a/dev-packages/rollup-utils/npmHelpers.mjs +++ b/dev-packages/rollup-utils/npmHelpers.mjs @@ -10,6 +10,7 @@ import deepMerge from 'deepmerge'; import { makeCleanupPlugin, + makeCodeCovPlugin, makeDebugBuildStatementReplacePlugin, makeExtractPolyfillsPlugin, makeNodeResolvePlugin, @@ -43,6 +44,8 @@ export function makeBaseNPMConfig(options = {}) { excludeIframe: undefined, }); + const codecovPlugin = makeCodeCovPlugin(); + const defaultBaseConfig = { input: entrypoints, @@ -59,7 +62,7 @@ export function makeBaseNPMConfig(options = {}) { // output individual files rather than one big bundle preserveModules: true, - // Allow wrappers or helper functions generated by rollup to use any ES6 features except symbols. (Symbols in + // Allow wrappers or helper functions generated by rollup to use any ES2015 features except symbols. (Symbols in // general are fine, but the `[Symbol.toStringTag]: 'Module'` which Rollup adds alongside `__esModule: // true` in CJS modules makes it so that Jest <= 29.2.2 crashes when trying to mock generated `@sentry/xxx` // packages. See https://github.com/getsentry/sentry-javascript/pull/6043.) @@ -103,6 +106,7 @@ export function makeBaseNPMConfig(options = {}) { debugBuildStatementReplacePlugin, rrwebBuildPlugin, cleanupPlugin, + codecovPlugin, ], // don't include imported modules from outside the package in the final output diff --git a/dev-packages/rollup-utils/plugins/bundlePlugins.mjs b/dev-packages/rollup-utils/plugins/bundlePlugins.mjs index 80dbc4422ea4..38c7811f3d1a 100644 --- a/dev-packages/rollup-utils/plugins/bundlePlugins.mjs +++ b/dev-packages/rollup-utils/plugins/bundlePlugins.mjs @@ -124,9 +124,12 @@ export function makeTerserPlugin() { // For v7 backwards-compatibility we need to access txn._frozenDynamicSamplingContext // TODO (v8): Remove this reserved word '_frozenDynamicSamplingContext', - // These are used to keep span relationships + // These are used to keep span & scope relationships '_sentryRootSpan', '_sentryChildSpans', + '_sentrySpan', + '_sentryScope', + '_sentryIsolationScope', ], }, }, diff --git a/dev-packages/rollup-utils/plugins/npmPlugins.mjs b/dev-packages/rollup-utils/plugins/npmPlugins.mjs index 7138964a919b..1c6f929c751c 100644 --- a/dev-packages/rollup-utils/plugins/npmPlugins.mjs +++ b/dev-packages/rollup-utils/plugins/npmPlugins.mjs @@ -7,6 +7,10 @@ * Sucrase plugin docs: https://github.com/rollup/plugins/tree/master/packages/sucrase */ +import * as fs from 'fs'; +import * as path from 'path'; + +import { codecovRollupPlugin } from '@codecov/rollup-plugin'; import json from '@rollup/plugin-json'; import replace from '@rollup/plugin-replace'; import sucrase from '@rollup/plugin-sucrase'; @@ -138,4 +142,19 @@ export function makeRrwebBuildPlugin({ excludeShadowDom, excludeIframe } = {}) { }); } +/** + * Plugin that uploads bundle analysis to codecov. + * + * @param type The type of bundle being uploaded. + * @param prefix The prefix for the codecov bundle name. Defaults to 'npm'. + */ +export function makeCodeCovPlugin() { + const packageJson = JSON.parse(fs.readFileSync(path.resolve(process.cwd(), './package.json'), { encoding: 'utf8' })); + return codecovRollupPlugin({ + enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined, + bundleName: packageJson.name, + uploadToken: process.env.CODECOV_TOKEN, + }); +} + export { makeExtractPolyfillsPlugin } from './extractPolyfillsPlugin.mjs'; diff --git a/dev-packages/size-limit-gh-action/index.mjs b/dev-packages/size-limit-gh-action/index.mjs index a270adc727d4..c42e9c523e94 100644 --- a/dev-packages/size-limit-gh-action/index.mjs +++ b/dev-packages/size-limit-gh-action/index.mjs @@ -1,3 +1,4 @@ +/* eslint-disable max-lines */ import { promises as fs } from 'node:fs'; import path from 'node:path'; import { fileURLToPath } from 'node:url'; @@ -7,11 +8,10 @@ import * as core from '@actions/core'; import { exec } from '@actions/exec'; import { context, getOctokit } from '@actions/github'; import * as glob from '@actions/glob'; +import * as io from '@actions/io'; import bytes from 'bytes'; import { markdownTable } from 'markdown-table'; -import download from 'github-fetch-workflow-artifact'; - const SIZE_LIMIT_HEADING = '## size-limit report 📦 '; const ARTIFACT_NAME = 'size-limit-action'; const RESULTS_FILE = 'size-limit-results.json'; @@ -229,20 +229,28 @@ async function run() { let current; try { - // Ignore failures here as it is likely that this only happens when introducing size-limit - // and this has not been run on the main branch yet - await download(octokit, { + const artifacts = await getArtifactsForBranchAndWorkflow(octokit, { ...repo, artifactName: ARTIFACT_NAME, branch: comparisonBranch, - downloadPath: __dirname, - workflowEvent: 'push', workflowName: `${process.env.GITHUB_WORKFLOW || ''}`, }); + + if (!artifacts) { + throw new Error('No artifacts found'); + } + + await downloadOtherWorkflowArtifact(octokit, { + ...repo, + artifactName: ARTIFACT_NAME, + artifactId: artifacts.artifact.id, + downloadPath: __dirname, + }); + base = JSON.parse(await fs.readFile(resultsFilePath, { encoding: 'utf8' })); } catch (error) { core.startGroup('Warning, unable to find base results'); - core.debug(error); + core.error(error); core.endGroup(); } @@ -295,4 +303,169 @@ async function run() { } } +// max pages of workflows to pagination through +const DEFAULT_MAX_PAGES = 50; +// max results per page +const DEFAULT_PAGE_LIMIT = 10; + +/** + * Fetch artifacts from a workflow run from a branch + * + * This is a bit hacky since GitHub Actions currently does not directly + * support downloading artifacts from other workflows + */ +/** + * Fetch artifacts from a workflow run from a branch + * + * This is a bit hacky since GitHub Actions currently does not directly + * support downloading artifacts from other workflows + */ +export async function getArtifactsForBranchAndWorkflow(octokit, { owner, repo, workflowName, branch, artifactName }) { + core.startGroup(`getArtifactsForBranchAndWorkflow - workflow:"${workflowName}", branch:"${branch}"`); + + let repositoryWorkflow = null; + + // For debugging + const allWorkflows = []; + + // + // Find workflow id from `workflowName` + // + for await (const response of octokit.paginate.iterator(octokit.rest.actions.listRepoWorkflows, { + owner, + repo, + })) { + const targetWorkflow = response.data.find(({ name }) => name === workflowName); + + allWorkflows.push(...response.data.map(({ name }) => name)); + + // If not found in responses, continue to search on next page + if (!targetWorkflow) { + continue; + } + + repositoryWorkflow = targetWorkflow; + break; + } + + if (!repositoryWorkflow) { + core.info( + `Unable to find workflow with name "${workflowName}" in the repository. Found workflows: ${allWorkflows.join( + ', ', + )}`, + ); + core.endGroup(); + return null; + } + + const workflow_id = repositoryWorkflow.id; + + let currentPage = 0; + const completedWorkflowRuns = []; + + for await (const response of octokit.paginate.iterator(octokit.rest.actions.listWorkflowRuns, { + owner, + repo, + workflow_id, + branch, + status: 'completed', + per_page: DEFAULT_PAGE_LIMIT, + event: 'push', + })) { + if (!response.data.length) { + core.warning(`Workflow ${workflow_id} not found in branch ${branch}`); + core.endGroup(); + return null; + } + + // Do not allow downloading artifacts from a fork. + completedWorkflowRuns.push( + ...response.data.filter(workflowRun => workflowRun.head_repository.full_name === `${owner}/${repo}`), + ); + + if (completedWorkflowRuns.length) { + break; + } + + if (currentPage > DEFAULT_MAX_PAGES) { + core.warning(`Workflow ${workflow_id} not found in branch: ${branch}`); + core.endGroup(); + return null; + } + + currentPage++; + } + + // Search through workflow artifacts until we find a workflow run w/ artifact name that we are looking for + for (const workflowRun of completedWorkflowRuns) { + core.info(`Checking artifacts for workflow run: ${workflowRun.html_url}`); + + const { + data: { artifacts }, + } = await octokit.rest.actions.listWorkflowRunArtifacts({ + owner, + repo, + run_id: workflowRun.id, + }); + + if (!artifacts) { + core.warning( + `Unable to fetch artifacts for branch: ${branch}, workflow: ${workflow_id}, workflowRunId: ${workflowRun.id}`, + ); + } else { + const foundArtifact = artifacts.find(({ name }) => name === artifactName); + if (foundArtifact) { + core.info(`Found suitable artifact: ${foundArtifact.url}`); + return { + artifact: foundArtifact, + workflowRun, + }; + } + } + } + + core.warning(`Artifact not found: ${artifactName}`); + core.endGroup(); + return null; +} + run(); + +/** + * Use GitHub API to fetch artifact download url, then + * download and extract artifact to `downloadPath` + */ +async function downloadOtherWorkflowArtifact(octokit, { owner, repo, artifactId, artifactName, downloadPath }) { + const artifact = await octokit.rest.actions.downloadArtifact({ + owner, + repo, + artifact_id: artifactId, + archive_format: 'zip', + }); + + // Make sure output path exists + try { + await io.mkdirP(downloadPath); + } catch { + // ignore errors + } + + const downloadFile = path.resolve(downloadPath, `${artifactName}.zip`); + + await exec('wget', [ + '-nv', + '--retry-connrefused', + '--waitretry=1', + '--read-timeout=20', + '--timeout=15', + '-t', + '0', + '-O', + downloadFile, + artifact.url, + ]); + + await exec('unzip', ['-q', '-d', downloadPath, downloadFile], { + silent: true, + }); +} diff --git a/dev-packages/size-limit-gh-action/package.json b/dev-packages/size-limit-gh-action/package.json index fa6b7e8aab45..32f5f7251503 100644 --- a/dev-packages/size-limit-gh-action/package.json +++ b/dev-packages/size-limit-gh-action/package.json @@ -17,10 +17,10 @@ "@actions/artifact": "1.1.2", "@actions/core": "1.10.1", "@actions/exec": "1.1.1", - "@actions/github": "6.0.0", + "@actions/io": "1.1.3", + "@actions/github": "^5.0.0", "@actions/glob": "0.4.0", "bytes": "3.1.2", - "github-fetch-workflow-artifact": "2.0.0", "markdown-table": "3.0.3" }, "volta": { diff --git a/packages/replay/MIGRATION.md b/docs/migration/replay.md similarity index 98% rename from packages/replay/MIGRATION.md rename to docs/migration/replay.md index d61689499d7d..0fe6160cc56d 100644 --- a/packages/replay/MIGRATION.md +++ b/docs/migration/replay.md @@ -1,6 +1,6 @@ # End of Replay Beta -> For further migration changes please refer to the [general SDK migration notes](../../MIGRATION.md). +Sentry Replay is now out of Beta. This means that the usual stability guarantees apply. Because of experimentation and rapid iteration, during the Beta period some bugs and problems came up which have since been fixed/improved. We **strongly** recommend anyone using Replay in a version before 7.39.0 to update to 7.39.0 or diff --git a/package.json b/package.json index 3bb2bd8b6c12..5c1f37ca4c33 100644 --- a/package.json +++ b/package.json @@ -40,7 +40,7 @@ "yalc:publish": "lerna run yalc:publish" }, "volta": { - "node": "18.17.0", + "node": "18.18.0", "yarn": "1.22.19" }, "workspaces": [ @@ -65,7 +65,7 @@ "packages/profiling-node", "packages/react", "packages/remix", - "packages/replay", + "packages/replay-internal", "packages/replay-canvas", "packages/replay-worker", "packages/svelte", @@ -86,6 +86,7 @@ ], "devDependencies": { "@biomejs/biome": "^1.4.0", + "@codecov/rollup-plugin": "0.0.1-beta.5", "@rollup/plugin-commonjs": "^25.0.7", "@rollup/plugin-esm-shim": "^0.1.5", "@rollup/plugin-json": "^6.1.0", @@ -100,7 +101,7 @@ "@types/chai": "^4.1.3", "@types/jest": "^27.4.1", "@types/jsdom": "^16.2.3", - "@types/node": "~10.17.0", + "@types/node": "^14.18.0", "@types/rimraf": "^3.0.2", "@types/sinon": "^7.0.11", "@vitest/coverage-c8": "^0.29.2", diff --git a/packages/angular/tsconfig.ngc.json b/packages/angular/tsconfig.ngc.json index 096ced563bba..e915bd8cc32c 100644 --- a/packages/angular/tsconfig.ngc.json +++ b/packages/angular/tsconfig.ngc.json @@ -5,9 +5,9 @@ { "extends": "./tsconfig.json", "compilerOptions": { - "target": "es2017", + "target": "es2018", "declarationMap": false, - "lib": ["dom", "es2017"], + "lib": ["dom", "es2018"], "baseUrl": "./" }, "angularCompilerOptions": { diff --git a/packages/astro/src/index.types.ts b/packages/astro/src/index.types.ts index dad62a288d53..e5fe8fd965b4 100644 --- a/packages/astro/src/index.types.ts +++ b/packages/astro/src/index.types.ts @@ -22,8 +22,6 @@ export declare const defaultStackParser: StackParser; export declare function close(timeout?: number | undefined): PromiseLike; export declare function flush(timeout?: number | undefined): PromiseLike; -// eslint-disable-next-line deprecation/deprecation -export declare const makeMain: typeof clientSdk.makeMain; // eslint-disable-next-line deprecation/deprecation export declare const getCurrentHub: typeof clientSdk.getCurrentHub; export declare const getClient: typeof clientSdk.getClient; diff --git a/packages/astro/src/server/sdk.ts b/packages/astro/src/server/sdk.ts index a34a33cad31d..c2398c7d019f 100644 --- a/packages/astro/src/server/sdk.ts +++ b/packages/astro/src/server/sdk.ts @@ -1,6 +1,5 @@ import { applySdkMetadata } from '@sentry/core'; import type { NodeOptions } from '@sentry/node'; -import { getDefaultIntegrations } from '@sentry/node'; import { init as initNodeSdk, setTag } from '@sentry/node'; /** @@ -10,9 +9,6 @@ import { init as initNodeSdk, setTag } from '@sentry/node'; export function init(options: NodeOptions): void { const opts = { ...options, - // TODO v8: For now, we disable the Prisma integration, because that has weird esm-cjs interop issues - // We should figure these out and fix these before v8 goes stable. - defaultIntegrations: getDefaultIntegrations(options).filter(integration => integration.name !== 'Prisma'), }; applySdkMetadata(opts, 'astro', ['astro', 'node']); diff --git a/packages/aws-serverless/package.json b/packages/aws-serverless/package.json index d8fe3c56544f..8a1c250337b9 100644 --- a/packages/aws-serverless/package.json +++ b/packages/aws-serverless/package.json @@ -44,7 +44,7 @@ "@types/express": "^4.17.14" }, "devDependencies": { - "@types/node": "^14.6.4", + "@types/node": "^14.18.0", "aws-sdk": "^2.765.0", "find-up": "^5.0.0", "nock": "^13.0.4", diff --git a/packages/aws-serverless/src/index.ts b/packages/aws-serverless/src/index.ts index 747b4b80f1ab..0cc875d29338 100644 --- a/packages/aws-serverless/src/index.ts +++ b/packages/aws-serverless/src/index.ts @@ -89,6 +89,7 @@ export { setupHapiErrorHandler, spotlightIntegration, initOpenTelemetry, + spanToJSON, } from '@sentry/node'; export { diff --git a/packages/browser/package.json b/packages/browser/package.json index 41da4ae0575b..8db34bcff3b5 100644 --- a/packages/browser/package.json +++ b/packages/browser/package.json @@ -43,10 +43,10 @@ }, "dependencies": { "@sentry-internal/feedback": "8.0.0-alpha.5", + "@sentry-internal/replay": "8.0.0-alpha.5", "@sentry-internal/replay-canvas": "8.0.0-alpha.5", "@sentry-internal/tracing": "8.0.0-alpha.5", "@sentry/core": "8.0.0-alpha.5", - "@sentry/replay": "8.0.0-alpha.5", "@sentry/types": "8.0.0-alpha.5", "@sentry/utils": "8.0.0-alpha.5" }, diff --git a/packages/browser/rollup.bundle.config.mjs b/packages/browser/rollup.bundle.config.mjs index 7ebddd4e2f04..16c769582050 100644 --- a/packages/browser/rollup.bundle.config.mjs +++ b/packages/browser/rollup.bundle.config.mjs @@ -52,7 +52,7 @@ const tracingBaseBundleConfig = makeBaseBundleConfig({ const replayBaseBundleConfig = makeBaseBundleConfig({ bundleType: 'standalone', entrypoints: ['src/index.bundle.replay.ts'], - licenseTitle: '@sentry/browser & @sentry/replay', + licenseTitle: '@sentry/browser (Replay)', outputFileBase: () => 'bundles/bundle.replay', }); diff --git a/packages/browser/src/exports.ts b/packages/browser/src/exports.ts index a4b10d5b6988..8d581eaeda21 100644 --- a/packages/browser/src/exports.ts +++ b/packages/browser/src/exports.ts @@ -20,8 +20,6 @@ export type { BrowserOptions } from './client'; export type { ReportDialogOptions } from './sdk'; export { - // eslint-disable-next-line deprecation/deprecation - addGlobalEventProcessor, addEventProcessor, addBreadcrumb, addIntegration, @@ -39,8 +37,6 @@ export { getIsolationScope, getGlobalScope, Hub, - // eslint-disable-next-line deprecation/deprecation - makeMain, setCurrentClient, Scope, continueTrace, diff --git a/packages/browser/src/index.bundle.replay.ts b/packages/browser/src/index.bundle.replay.ts index 29bf0b320dea..ec0a50c92905 100644 --- a/packages/browser/src/index.bundle.replay.ts +++ b/packages/browser/src/index.bundle.replay.ts @@ -4,7 +4,7 @@ import { browserTracingIntegrationShim, feedbackIntegrationShim, } from '@sentry-internal/integration-shims'; -import { replayIntegration } from '@sentry/replay'; +import { replayIntegration } from '@sentry-internal/replay'; export * from './index.bundle.base'; export { diff --git a/packages/browser/src/index.bundle.tracing.replay.feedback.ts b/packages/browser/src/index.bundle.tracing.replay.feedback.ts index 1fe669f2393f..41db6a7cb5f7 100644 --- a/packages/browser/src/index.bundle.tracing.replay.feedback.ts +++ b/packages/browser/src/index.bundle.tracing.replay.feedback.ts @@ -1,7 +1,11 @@ import { feedbackIntegration } from '@sentry-internal/feedback'; -import { browserTracingIntegration } from '@sentry-internal/tracing'; +import { replayIntegration } from '@sentry-internal/replay'; +import { + browserTracingIntegration, + startBrowserTracingNavigationSpan, + startBrowserTracingPageLoadSpan, +} from '@sentry-internal/tracing'; import { addTracingExtensions } from '@sentry/core'; -import { replayIntegration } from '@sentry/replay'; // We are patching the global object with our hub extension methods addTracingExtensions(); @@ -16,6 +20,13 @@ export { getSpanDescendants, } from '@sentry/core'; -export { feedbackIntegration, replayIntegration, browserTracingIntegration, addTracingExtensions }; +export { + feedbackIntegration, + replayIntegration, + browserTracingIntegration, + addTracingExtensions, + startBrowserTracingNavigationSpan, + startBrowserTracingPageLoadSpan, +}; export * from './index.bundle.base'; diff --git a/packages/browser/src/index.bundle.tracing.replay.ts b/packages/browser/src/index.bundle.tracing.replay.ts index 7b09054540b8..7373fc8e5040 100644 --- a/packages/browser/src/index.bundle.tracing.replay.ts +++ b/packages/browser/src/index.bundle.tracing.replay.ts @@ -1,7 +1,11 @@ import { feedbackIntegrationShim } from '@sentry-internal/integration-shims'; -import { browserTracingIntegration } from '@sentry-internal/tracing'; +import { replayIntegration } from '@sentry-internal/replay'; +import { + browserTracingIntegration, + startBrowserTracingNavigationSpan, + startBrowserTracingPageLoadSpan, +} from '@sentry-internal/tracing'; import { addTracingExtensions } from '@sentry/core'; -import { replayIntegration } from '@sentry/replay'; // We are patching the global object with our hub extension methods addTracingExtensions(); @@ -21,6 +25,8 @@ export { feedbackIntegrationShim as feedbackIntegration, browserTracingIntegration, addTracingExtensions, + startBrowserTracingNavigationSpan, + startBrowserTracingPageLoadSpan, }; export * from './index.bundle.base'; diff --git a/packages/browser/src/index.bundle.tracing.ts b/packages/browser/src/index.bundle.tracing.ts index 23c424fd7337..fcbc43974a91 100644 --- a/packages/browser/src/index.bundle.tracing.ts +++ b/packages/browser/src/index.bundle.tracing.ts @@ -1,6 +1,10 @@ // This is exported so the loader does not fail when switching off Replay import { feedbackIntegrationShim, replayIntegrationShim } from '@sentry-internal/integration-shims'; -import { browserTracingIntegration } from '@sentry-internal/tracing'; +import { + browserTracingIntegration, + startBrowserTracingNavigationSpan, + startBrowserTracingPageLoadSpan, +} from '@sentry-internal/tracing'; import { addTracingExtensions } from '@sentry/core'; // We are patching the global object with our hub extension methods @@ -21,6 +25,8 @@ export { replayIntegrationShim as replayIntegration, browserTracingIntegration, addTracingExtensions, + startBrowserTracingPageLoadSpan, + startBrowserTracingNavigationSpan, }; export * from './index.bundle.base'; diff --git a/packages/browser/src/index.ts b/packages/browser/src/index.ts index 4b5248f91683..3108dc603d42 100644 --- a/packages/browser/src/index.ts +++ b/packages/browser/src/index.ts @@ -32,7 +32,7 @@ export { export { replayIntegration, getReplay, -} from '@sentry/replay'; +} from '@sentry-internal/replay'; export type { ReplayEventType, ReplayEventWithTime, @@ -43,7 +43,7 @@ export type { ReplayFrameEvent, ReplaySpanFrame, ReplaySpanFrameEvent, -} from '@sentry/replay'; +} from '@sentry-internal/replay'; export { replayCanvasIntegration } from '@sentry-internal/replay-canvas'; @@ -70,8 +70,6 @@ export { withActiveSpan, getSpanDescendants, setMeasurement, - // eslint-disable-next-line deprecation/deprecation - getActiveTransaction, getSpanStatusFromHttpCode, setHttpStatus, makeMultiplexedTransport, diff --git a/packages/browser/test/unit/profiling/utils.test.ts b/packages/browser/test/unit/profiling/utils.test.ts index a3141dfcb327..42a747f1aaa9 100644 --- a/packages/browser/test/unit/profiling/utils.test.ts +++ b/packages/browser/test/unit/profiling/utils.test.ts @@ -1,5 +1,4 @@ import { TextDecoder, TextEncoder } from 'util'; -// @ts-expect-error patch the encoder on the window, else importing JSDOM fails (deleted in afterAll) const patchedEncoder = (!global.window.TextEncoder && (global.window.TextEncoder = TextEncoder)) || true; // @ts-expect-error patch the encoder on the window, else importing JSDOM fails (deleted in afterAll) const patchedDecoder = (!global.window.TextDecoder && (global.window.TextDecoder = TextDecoder)) || true; @@ -19,31 +18,23 @@ const makeJSProfile = (partial: Partial = {}): JSSelfProfile => { }; }; -// @ts-expect-error store a reference so we can reset it later const globalDocument = global.document; -// @ts-expect-error store a reference so we can reset it later const globalWindow = global.window; -// @ts-expect-error store a reference so we can reset it later const globalLocation = global.location; describe('convertJSSelfProfileToSampledFormat', () => { beforeEach(() => { const dom = new JSDOM(); - // @ts-expect-error need to override global document global.document = dom.window.document; // @ts-expect-error need to override global document global.window = dom.window; - // @ts-expect-error need to override global document global.location = dom.window.location; }); // Reset back to previous values afterEach(() => { - // @ts-expect-error need to override global document global.document = globalDocument; - // @ts-expect-error need to override global document global.window = globalWindow; - // @ts-expect-error need to override global document global.location = globalLocation; }); diff --git a/packages/bun/src/index.ts b/packages/bun/src/index.ts index 5d7c8fcfcafb..ae09717c34b4 100644 --- a/packages/bun/src/index.ts +++ b/packages/bun/src/index.ts @@ -110,6 +110,7 @@ export { setupHapiErrorHandler, spotlightIntegration, initOpenTelemetry, + spanToJSON, } from '@sentry/node'; export { diff --git a/packages/core/src/eventProcessors.ts b/packages/core/src/eventProcessors.ts index 0f5e0f0202fa..2f648ba608e2 100644 --- a/packages/core/src/eventProcessors.ts +++ b/packages/core/src/eventProcessors.ts @@ -1,25 +1,8 @@ import type { Event, EventHint, EventProcessor } from '@sentry/types'; -import { SyncPromise, getGlobalSingleton, isThenable, logger } from '@sentry/utils'; +import { SyncPromise, isThenable, logger } from '@sentry/utils'; import { DEBUG_BUILD } from './debug-build'; -/** - * Returns the global event processors. - * @deprecated Global event processors will be removed in v8. - */ -export function getGlobalEventProcessors(): EventProcessor[] { - return getGlobalSingleton('globalEventProcessors', () => []); -} - -/** - * Add a EventProcessor to be kept globally. - * @deprecated Use `addEventProcessor` instead. Global event processors will be removed in v8. - */ -export function addGlobalEventProcessor(callback: EventProcessor): void { - // eslint-disable-next-line deprecation/deprecation - getGlobalEventProcessors().push(callback); -} - /** * Process an array of event processors, returning the processed event (or `null` if the event was dropped). */ diff --git a/packages/core/src/fetch.ts b/packages/core/src/fetch.ts index 5255e7fa206d..8002d9280297 100644 --- a/packages/core/src/fetch.ts +++ b/packages/core/src/fetch.ts @@ -127,11 +127,8 @@ export function addTracingHeadersToFetchRequest( } | PolymorphicRequestHeaders; }, - requestSpan?: Span, + span?: Span, ): PolymorphicRequestHeaders | undefined { - // eslint-disable-next-line deprecation/deprecation - const span = requestSpan || scope.getSpan(); - const isolationScope = getIsolationScope(); const { traceId, spanId, sampled, dsc } = { diff --git a/packages/core/src/hub.ts b/packages/core/src/hub.ts index 39e9f7de1ec1..4c6cecf6858b 100644 --- a/packages/core/src/hub.ts +++ b/packages/core/src/hub.ts @@ -529,18 +529,6 @@ export class Hub implements HubInterface { } } -/** - * Replaces the current main hub with the passed one on the global object - * - * @returns The old replaced hub - * - * @deprecated Use `setCurrentClient()` instead. - */ -export function makeMain(hub: HubInterface): HubInterface { - // noop! - return hub; -} - /** * Returns the default hub instance. * diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts index 217ae7273422..3a5cab6986b3 100644 --- a/packages/core/src/index.ts +++ b/packages/core/src/index.ts @@ -33,8 +33,6 @@ export { // eslint-disable-next-line deprecation/deprecation getCurrentHub, Hub, - // eslint-disable-next-line deprecation/deprecation - makeMain, getGlobalHub, getDefaultCurrentScope, getDefaultIsolationScope, @@ -54,11 +52,7 @@ export { export { makeSession, closeSession, updateSession } from './session'; export { SessionFlusher } from './sessionflusher'; export { Scope } from './scope'; -export { - notifyEventProcessors, - // eslint-disable-next-line deprecation/deprecation - addGlobalEventProcessor, -} from './eventProcessors'; +export { notifyEventProcessors } from './eventProcessors'; export { getEnvelopeEndpointWithUrlEncodedAuth, getReportDialogEndpoint } from './api'; export { BaseClient } from './baseclient'; export { ServerRuntimeClient } from './server-runtime-client'; diff --git a/packages/core/src/integration.ts b/packages/core/src/integration.ts index ccf1f86cff18..237a086b92bb 100644 --- a/packages/core/src/integration.ts +++ b/packages/core/src/integration.ts @@ -1,19 +1,8 @@ -import type { - Client, - Event, - EventHint, - Integration, - IntegrationClass, - IntegrationFn, - IntegrationFnResult, - Options, -} from '@sentry/types'; +import type { Client, Event, EventHint, Integration, IntegrationClass, IntegrationFn, Options } from '@sentry/types'; import { arrayify, logger } from '@sentry/utils'; import { getClient } from './currentScopes'; import { DEBUG_BUILD } from './debug-build'; -import { addGlobalEventProcessor } from './eventProcessors'; -import { getCurrentHub } from './hub'; declare module '@sentry/types' { interface Integration { @@ -130,8 +119,7 @@ export function setupIntegration(client: Client, integration: Integration, integ // `setupOnce` is only called the first time if (installedIntegrations.indexOf(integration.name) === -1 && typeof integration.setupOnce === 'function') { - // eslint-disable-next-line deprecation/deprecation - integration.setupOnce(addGlobalEventProcessor, getCurrentHub); + integration.setupOnce(); installedIntegrations.push(integration.name); } @@ -203,6 +191,6 @@ export function convertIntegrationFnToClass( * Define an integration function that can be used to create an integration instance. * Note that this by design hides the implementation details of the integration, as they are considered internal. */ -export function defineIntegration(fn: Fn): (...args: Parameters) => IntegrationFnResult { +export function defineIntegration(fn: Fn): (...args: Parameters) => Integration { return fn; } diff --git a/packages/core/src/scope.ts b/packages/core/src/scope.ts index 90961cc48bd0..a86bbfafcc8f 100644 --- a/packages/core/src/scope.ts +++ b/packages/core/src/scope.ts @@ -19,7 +19,6 @@ import type { ScopeData, Session, SeverityLevel, - Span, Transaction, User, } from '@sentry/types'; @@ -27,6 +26,7 @@ import { dateTimestampInSeconds, isPlainObject, logger, uuid4 } from '@sentry/ut import { updateSession } from './session'; import type { SentrySpan } from './tracing/sentrySpan'; +import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope'; /** * Default value for maximum number of breadcrumbs added to an event. @@ -87,9 +87,6 @@ export class Scope implements ScopeInterface { */ protected _transactionName?: string; - /** Span */ - protected _span?: Span; - /** Session */ protected _session?: Session; @@ -134,7 +131,6 @@ export class Scope implements ScopeInterface { newScope._contexts = { ...this._contexts }; newScope._user = this._user; newScope._level = this._level; - newScope._span = this._span; newScope._session = this._session; newScope._transactionName = this._transactionName; newScope._fingerprint = this._fingerprint; @@ -145,6 +141,8 @@ export class Scope implements ScopeInterface { newScope._propagationContext = { ...this._propagationContext }; newScope._client = this._client; + _setSpanForScope(newScope, _getSpanForScope(this)); + return newScope; } @@ -304,25 +302,6 @@ export class Scope implements ScopeInterface { return this; } - /** - * Sets the Span on the scope. - * @param span Span - * @deprecated Instead of setting a span on a scope, use `startSpan()`/`startSpanManual()` instead. - */ - public setSpan(span?: Span): this { - this._span = span; - this._notifyScopeListeners(); - return this; - } - - /** - * Returns the `Span` if there is one. - * @deprecated Use `getActiveSpan()` instead. - */ - public getSpan(): Span | undefined { - return this._span; - } - /** * Returns the `Transaction` attached to the scope (if there is one). * @deprecated You should not rely on the transaction, but just use `startSpan()` APIs instead. @@ -330,7 +309,7 @@ export class Scope implements ScopeInterface { public getTransaction(): Transaction | undefined { // Often, this span (if it exists at all) will be a transaction, but it's not guaranteed to be. Regardless, it will // have a pointer to the currently-active transaction. - const span = this._span; + const span = _getSpanForScope(this); // Cannot replace with getRootSpan because getRootSpan returns a span, not a transaction // Also, this method will be removed anyway. @@ -432,11 +411,12 @@ export class Scope implements ScopeInterface { this._transactionName = undefined; this._fingerprint = undefined; this._requestSession = undefined; - this._span = undefined; this._session = undefined; - this._notifyScopeListeners(); + _setSpanForScope(this, undefined); this._attachments = []; this._propagationContext = generatePropagationContext(); + + this._notifyScopeListeners(); return this; } @@ -522,7 +502,6 @@ export class Scope implements ScopeInterface { _propagationContext, _sdkProcessingMetadata, _transactionName, - _span, } = this; return { @@ -538,7 +517,7 @@ export class Scope implements ScopeInterface { propagationContext: _propagationContext, sdkProcessingMetadata: _sdkProcessingMetadata, transactionName: _transactionName, - span: _span, + span: _getSpanForScope(this), }; } diff --git a/packages/core/src/server-runtime-client.ts b/packages/core/src/server-runtime-client.ts index de88e6f3706e..9cd05374ddd3 100644 --- a/packages/core/src/server-runtime-client.ts +++ b/packages/core/src/server-runtime-client.ts @@ -24,6 +24,7 @@ import { getDynamicSamplingContextFromClient, getDynamicSamplingContextFromSpan, } from './tracing'; +import { _getSpanForScope } from './utils/spanOnScope'; import { getRootSpan, spanToTraceContext } from './utils/spanUtils'; export interface ServerRuntimeClientOptions extends ClientOptions { @@ -252,8 +253,7 @@ export class ServerRuntimeClient< return [undefined, undefined]; } - // eslint-disable-next-line deprecation/deprecation - const span = scope.getSpan(); + const span = _getSpanForScope(scope); if (span) { const rootSpan = getRootSpan(span); const samplingContext = getDynamicSamplingContextFromSpan(rootSpan); diff --git a/packages/core/src/tracing/idleSpan.ts b/packages/core/src/tracing/idleSpan.ts index 36d1474b39f2..8dc61426f6dd 100644 --- a/packages/core/src/tracing/idleSpan.ts +++ b/packages/core/src/tracing/idleSpan.ts @@ -5,6 +5,7 @@ import { getClient, getCurrentScope } from '../currentScopes'; import { DEBUG_BUILD } from '../debug-build'; import { SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON } from '../semanticAttributes'; import { hasTracingEnabled } from '../utils/hasTracingEnabled'; +import { _setSpanForScope } from '../utils/spanOnScope'; import { getActiveSpan, getSpanDescendants, @@ -232,8 +233,7 @@ export function startIdleSpan(startSpanOptions: StartSpanOptions, options: Parti beforeSpanEnd(span); } - // eslint-disable-next-line deprecation/deprecation - scope.setSpan(previousActiveSpan); + _setSpanForScope(scope, previousActiveSpan); const spanJSON = spanToJSON(span); @@ -347,8 +347,7 @@ export function startIdleSpan(startSpanOptions: StartSpanOptions, options: Parti function _startIdleSpan(options: StartSpanOptions): Span { const span = startInactiveSpan(options); - // eslint-disable-next-line deprecation/deprecation - getCurrentScope().setSpan(span); + _setSpanForScope(getCurrentScope(), span); DEBUG_BUILD && logger.log(`Setting idle span on scope. Span ID: ${span.spanContext().spanId}`); diff --git a/packages/core/src/tracing/index.ts b/packages/core/src/tracing/index.ts index e6f17a9f8911..c8e38bd9095a 100644 --- a/packages/core/src/tracing/index.ts +++ b/packages/core/src/tracing/index.ts @@ -3,8 +3,6 @@ export { startIdleSpan, TRACING_DEFAULTS } from './idleSpan'; export { SentrySpan } from './sentrySpan'; export { SentryNonRecordingSpan } from './sentryNonRecordingSpan'; export { Transaction } from './transaction'; -// eslint-disable-next-line deprecation/deprecation -export { getActiveTransaction } from './utils'; export { setHttpStatus, getSpanStatusFromHttpCode, diff --git a/packages/core/src/tracing/sampling.ts b/packages/core/src/tracing/sampling.ts index 1670d38b740d..ce269e55a27d 100644 --- a/packages/core/src/tracing/sampling.ts +++ b/packages/core/src/tracing/sampling.ts @@ -1,11 +1,8 @@ -import type { Options, SamplingContext } from '@sentry/types'; +import type { Options, SamplingContext, TransactionContext } from '@sentry/types'; import { isNaN, logger } from '@sentry/utils'; import { DEBUG_BUILD } from '../debug-build'; -import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE } from '../semanticAttributes'; import { hasTracingEnabled } from '../utils/hasTracingEnabled'; -import { spanToJSON } from '../utils/spanUtils'; -import type { Transaction } from './transaction'; /** * Makes a sampling decision for the given transaction and stores it on the transaction. @@ -16,24 +13,21 @@ import type { Transaction } from './transaction'; * This method muttes the given `transaction` and will set the `sampled` value on it. * It returns the same transaction, for convenience. */ -export function sampleTransaction( - transaction: T, +export function sampleTransaction( + transactionContext: TransactionContext, options: Pick, samplingContext: SamplingContext, -): T { +): [sampled: boolean, sampleRate?: number] { // nothing to do if tracing is not enabled if (!hasTracingEnabled(options)) { - // eslint-disable-next-line deprecation/deprecation - transaction.sampled = false; - return transaction; + return [false]; } - // if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that - // eslint-disable-next-line deprecation/deprecation - if (transaction.sampled !== undefined) { - // eslint-disable-next-line deprecation/deprecation - transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(transaction.sampled)); - return transaction; + const transactionContextSampled = transactionContext.sampled; + // if the user has forced a sampling decision by passing a `sampled` value in + // their transaction context, go with that. + if (transactionContextSampled !== undefined) { + return [transactionContextSampled, Number(transactionContextSampled)]; } // we would have bailed already if neither `tracesSampler` nor `tracesSampleRate` nor `enableTracing` were defined, so one of these should @@ -41,25 +35,20 @@ export function sampleTransaction( let sampleRate; if (typeof options.tracesSampler === 'function') { sampleRate = options.tracesSampler(samplingContext); - transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate)); } else if (samplingContext.parentSampled !== undefined) { sampleRate = samplingContext.parentSampled; } else if (typeof options.tracesSampleRate !== 'undefined') { sampleRate = options.tracesSampleRate; - transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate)); } else { // When `enableTracing === true`, we use a sample rate of 100% sampleRate = 1; - transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, sampleRate); } // Since this is coming from the user (or from a function provided by the user), who knows what we might get. (The // only valid values are booleans or numbers between 0 and 1.) if (!isValidSampleRate(sampleRate)) { DEBUG_BUILD && logger.warn('[Tracing] Discarding transaction because of invalid sample rate.'); - // eslint-disable-next-line deprecation/deprecation - transaction.sampled = false; - return transaction; + return [false]; } // if the function returned 0 (or false), or if `tracesSampleRate` is 0, it's a sign the transaction should be dropped @@ -72,40 +61,31 @@ export function sampleTransaction( : 'a negative sampling decision was inherited or tracesSampleRate is set to 0' }`, ); - // eslint-disable-next-line deprecation/deprecation - transaction.sampled = false; - return transaction; + return [false, Number(sampleRate)]; } // Now we roll the dice. Math.random is inclusive of 0, but not of 1, so strict < is safe here. In case sampleRate is // a boolean, the < comparison will cause it to be automatically cast to 1 if it's true and 0 if it's false. - // eslint-disable-next-line deprecation/deprecation - transaction.sampled = Math.random() < (sampleRate as number | boolean); + const shouldSample = Math.random() < sampleRate; // if we're not going to keep it, we're done - // eslint-disable-next-line deprecation/deprecation - if (!transaction.sampled) { + if (!shouldSample) { DEBUG_BUILD && logger.log( `[Tracing] Discarding transaction because it's not included in the random sample (sampling rate = ${Number( sampleRate, )})`, ); - return transaction; + return [false, Number(sampleRate)]; } - if (DEBUG_BUILD) { - const { op, description } = spanToJSON(transaction); - logger.log(`[Tracing] starting ${op} transaction - ${description}`); - } - - return transaction; + return [true, Number(sampleRate)]; } /** * Checks the given sample rate to make sure it is valid type and value (a boolean, or a number between 0 and 1). */ -function isValidSampleRate(rate: unknown): boolean { +function isValidSampleRate(rate: unknown): rate is number | boolean { // we need to check NaN explicitly because it's of type 'number' and therefore wouldn't get caught by this typecheck if (isNaN(rate) || !(typeof rate === 'number' || typeof rate === 'boolean')) { DEBUG_BUILD && diff --git a/packages/core/src/tracing/sentrySpan.ts b/packages/core/src/tracing/sentrySpan.ts index 87b57d729960..2eceafafa953 100644 --- a/packages/core/src/tracing/sentrySpan.ts +++ b/packages/core/src/tracing/sentrySpan.ts @@ -97,72 +97,6 @@ export class SentrySpan implements Span { // This rule conflicts with another eslint rule :( /* eslint-disable @typescript-eslint/member-ordering */ - /** - * The ID of the trace. - * @deprecated Use `spanContext().traceId` instead. - */ - public get traceId(): string { - return this._traceId; - } - - /** - * The ID of the trace. - * @deprecated You cannot update the traceId of a span after span creation. - */ - public set traceId(traceId: string) { - this._traceId = traceId; - } - - /** - * The ID of the span. - * @deprecated Use `spanContext().spanId` instead. - */ - public get spanId(): string { - return this._spanId; - } - - /** - * The ID of the span. - * @deprecated You cannot update the spanId of a span after span creation. - */ - public set spanId(spanId: string) { - this._spanId = spanId; - } - - /** - * @inheritDoc - * - * @deprecated Use `startSpan` functions instead. - */ - public set parentSpanId(string) { - this._parentSpanId = string; - } - - /** - * @inheritDoc - * - * @deprecated Use `spanToJSON(span).parent_span_id` instead. - */ - public get parentSpanId(): string | undefined { - return this._parentSpanId; - } - - /** - * Was this span chosen to be sent as part of the sample? - * @deprecated Use `isRecording()` instead. - */ - public get sampled(): boolean | undefined { - return this._sampled; - } - - /** - * Was this span chosen to be sent as part of the sample? - * @deprecated You cannot update the sampling decision of a span after span creation. - */ - public set sampled(sampled: boolean | undefined) { - this._sampled = sampled; - } - /** * Attributes for the span. * @deprecated Use `spanToJSON(span).atttributes` instead. diff --git a/packages/core/src/tracing/trace.ts b/packages/core/src/tracing/trace.ts index 2548d94fd60e..e4102b610cc1 100644 --- a/packages/core/src/tracing/trace.ts +++ b/packages/core/src/tracing/trace.ts @@ -1,12 +1,4 @@ -import type { - ClientOptions, - Hub, - Scope, - Span, - SpanTimeInput, - StartSpanOptions, - TransactionContext, -} from '@sentry/types'; +import type { ClientOptions, Scope, Span, SpanTimeInput, StartSpanOptions, TransactionContext } from '@sentry/types'; import { propagationContextFromHeaders } from '@sentry/utils'; import type { AsyncContextStrategy } from '../asyncContext'; @@ -14,8 +6,10 @@ import { getMainCarrier } from '../asyncContext'; import { getClient, getCurrentScope, getIsolationScope, withScope } from '../currentScopes'; import { getAsyncContextStrategy, getCurrentHub } from '../hub'; +import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE } from '../semanticAttributes'; import { handleCallbackErrors } from '../utils/handleCallbackErrors'; import { hasTracingEnabled } from '../utils/hasTracingEnabled'; +import { _getSpanForScope, _setSpanForScope } from '../utils/spanOnScope'; import { addChildSpanToSpan, getActiveSpan, @@ -34,13 +28,12 @@ import { setCapturedScopesOnSpan } from './utils'; /** * Wraps a function with a transaction/span and finishes the span after the function is done. * The created span is the active span and will be used as parent by other spans created inside the function - * and can be accessed via `Sentry.getSpan()`, as long as the function is executed while the scope is active. + * and can be accessed via `Sentry.getActiveSpan()`, as long as the function is executed while the scope is active. * * If you want to create a span that is not set as active, use {@link startInactiveSpan}. * - * Note that if you have not enabled tracing extensions via `addTracingExtensions` - * or you didn't set `tracesSampleRate`, this function will not generate spans - * and the `span` returned from the callback will be undefined. + * You'll always get a span passed to the callback, + * it may just be a non-recording span if the span is not sampled or if tracing is disabled. */ export function startSpan(context: StartSpanOptions, callback: (span: Span) => T): T { const acs = getAcs(); @@ -51,23 +44,19 @@ export function startSpan(context: StartSpanOptions, callback: (span: Span) = const spanContext = normalizeContext(context); return withScope(context.scope, scope => { - // eslint-disable-next-line deprecation/deprecation - const hub = getCurrentHub(); - // eslint-disable-next-line deprecation/deprecation - const parentSpan = scope.getSpan() as SentrySpan | undefined; + const parentSpan = _getSpanForScope(scope) as SentrySpan | undefined; const shouldSkipSpan = context.onlyIfParent && !parentSpan; const activeSpan = shouldSkipSpan ? new SentryNonRecordingSpan() - : createChildSpanOrTransaction(hub, { + : createChildSpanOrTransaction({ parentSpan, spanContext, forceTransaction: context.forceTransaction, scope, }); - // eslint-disable-next-line deprecation/deprecation - scope.setSpan(activeSpan); + _setSpanForScope(scope, activeSpan); return handleCallbackErrors( () => callback(activeSpan), @@ -90,9 +79,8 @@ export function startSpan(context: StartSpanOptions, callback: (span: Span) = * The created span is the active span and will be used as parent by other spans created inside the function * and can be accessed via `Sentry.getActiveSpan()`, as long as the function is executed while the scope is active. * - * Note that if you have not enabled tracing extensions via `addTracingExtensions` - * or you didn't set `tracesSampleRate`, this function will not generate spans - * and the `span` returned from the callback will be undefined. + * You'll always get a span passed to the callback, + * it may just be a non-recording span if the span is not sampled or if tracing is disabled. */ export function startSpanManual(context: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T { const acs = getAcs(); @@ -103,23 +91,19 @@ export function startSpanManual(context: StartSpanOptions, callback: (span: S const spanContext = normalizeContext(context); return withScope(context.scope, scope => { - // eslint-disable-next-line deprecation/deprecation - const hub = getCurrentHub(); - // eslint-disable-next-line deprecation/deprecation - const parentSpan = scope.getSpan() as SentrySpan | undefined; + const parentSpan = _getSpanForScope(scope) as SentrySpan | undefined; const shouldSkipSpan = context.onlyIfParent && !parentSpan; const activeSpan = shouldSkipSpan ? new SentryNonRecordingSpan() - : createChildSpanOrTransaction(hub, { + : createChildSpanOrTransaction({ parentSpan, spanContext, forceTransaction: context.forceTransaction, scope, }); - // eslint-disable-next-line deprecation/deprecation - scope.setSpan(activeSpan); + _setSpanForScope(scope, activeSpan); function finishAndSetSpan(): void { activeSpan.end(); @@ -140,13 +124,12 @@ export function startSpanManual(context: StartSpanOptions, callback: (span: S /** * Creates a span. This span is not set as active, so will not get automatic instrumentation spans - * as children or be able to be accessed via `Sentry.getSpan()`. + * as children or be able to be accessed via `Sentry.getActiveSpan()`. * * If you want to create a span that is set as active, use {@link startSpan}. * - * Note that if you have not enabled tracing extensions via `addTracingExtensions` - * or you didn't set `tracesSampleRate` or `tracesSampler`, this function will not generate spans - * and the `span` returned from the callback will be undefined. + * This function will always return a span, + * it may just be a non-recording span if the span is not sampled or if tracing is disabled. */ export function startInactiveSpan(context: StartSpanOptions): Span { const acs = getAcs(); @@ -155,11 +138,8 @@ export function startInactiveSpan(context: StartSpanOptions): Span { } const spanContext = normalizeContext(context); - // eslint-disable-next-line deprecation/deprecation - const hub = getCurrentHub(); const parentSpan = context.scope - ? // eslint-disable-next-line deprecation/deprecation - (context.scope.getSpan() as SentrySpan | undefined) + ? (_getSpanForScope(context.scope) as SentrySpan | undefined) : (getActiveSpan() as SentrySpan | undefined); const shouldSkipSpan = context.onlyIfParent && !parentSpan; @@ -170,7 +150,7 @@ export function startInactiveSpan(context: StartSpanOptions): Span { const scope = context.scope || getCurrentScope(); - return createChildSpanOrTransaction(hub, { + return createChildSpanOrTransaction({ parentSpan, spanContext, forceTransaction: context.forceTransaction, @@ -219,26 +199,22 @@ export function withActiveSpan(span: Span | null, callback: (scope: Scope) => } return withScope(scope => { - // eslint-disable-next-line deprecation/deprecation - scope.setSpan(span || undefined); + _setSpanForScope(scope, span || undefined); return callback(scope); }); } -function createChildSpanOrTransaction( - hub: Hub, - { - parentSpan, - spanContext, - forceTransaction, - scope, - }: { - parentSpan: SentrySpan | undefined; - spanContext: TransactionContext; - forceTransaction?: boolean; - scope: Scope; - }, -): Span { +function createChildSpanOrTransaction({ + parentSpan, + spanContext, + forceTransaction, + scope, +}: { + parentSpan: SentrySpan | undefined; + spanContext: TransactionContext; + forceTransaction?: boolean; + scope: Scope; +}): Span { if (!hasTracingEnabled()) { return new SentryNonRecordingSpan(); } @@ -325,9 +301,7 @@ function _startTransaction(transactionContext: TransactionContext): Transaction const client = getClient(); const options: Partial = (client && client.getOptions()) || {}; - // eslint-disable-next-line deprecation/deprecation - let transaction = new Transaction(transactionContext, getCurrentHub()); - transaction = sampleTransaction(transaction, options, { + const [sampled, sampleRate] = sampleTransaction(transactionContext, options, { name: transactionContext.name, parentSampled: transactionContext.parentSampled, transactionContext, @@ -337,8 +311,16 @@ function _startTransaction(transactionContext: TransactionContext): Transaction ...transactionContext.attributes, }, }); + + // eslint-disable-next-line deprecation/deprecation + const transaction = new Transaction({ ...transactionContext, sampled }, getCurrentHub()); + if (sampleRate !== undefined) { + transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, sampleRate); + } + if (client) { client.emit('spanStart', transaction); } + return transaction; } diff --git a/packages/core/src/tracing/transaction.ts b/packages/core/src/tracing/transaction.ts index a95fe7c394f9..2469594ad687 100644 --- a/packages/core/src/tracing/transaction.ts +++ b/packages/core/src/tracing/transaction.ts @@ -97,9 +97,6 @@ export class Transaction extends SentrySpan implements TransactionInterface { public get metadata(): TransactionMetadata { // We merge attributes in for backwards compatibility return { - // Defaults - spanMetadata: {}, - // Legacy metadata ...this._metadata, diff --git a/packages/core/src/tracing/utils.ts b/packages/core/src/tracing/utils.ts index c22940508138..28ba9fb271eb 100644 --- a/packages/core/src/tracing/utils.ts +++ b/packages/core/src/tracing/utils.ts @@ -1,24 +1,7 @@ -import type { Span, Transaction } from '@sentry/types'; +import type { Span } from '@sentry/types'; import type { Scope } from '@sentry/types'; import { addNonEnumerableProperty } from '@sentry/utils'; -import type { Hub } from '../hub'; -import { getCurrentHub } from '../hub'; - -/** - * Grabs active transaction off scope. - * - * @deprecated You should not rely on the transaction, but just use `startSpan()` APIs instead. - */ -export function getActiveTransaction(maybeHub?: Hub): T | undefined { - // eslint-disable-next-line deprecation/deprecation - const hub = maybeHub || getCurrentHub(); - // eslint-disable-next-line deprecation/deprecation - const scope = hub.getScope(); - // eslint-disable-next-line deprecation/deprecation - return scope.getTransaction() as T | undefined; -} - // so it can be used in manual instrumentation without necessitating a hard dependency on @sentry/utils export { stripUrlQueryAndFragment } from '@sentry/utils'; diff --git a/packages/core/src/utils/prepareEvent.ts b/packages/core/src/utils/prepareEvent.ts index 92cc5ffa65fa..6bc21cadbffa 100644 --- a/packages/core/src/utils/prepareEvent.ts +++ b/packages/core/src/utils/prepareEvent.ts @@ -13,7 +13,7 @@ import { GLOBAL_OBJ, addExceptionMechanism, dateTimestampInSeconds, normalize, t import { DEFAULT_ENVIRONMENT } from '../constants'; import { getGlobalScope } from '../currentScopes'; -import { getGlobalEventProcessors, notifyEventProcessors } from '../eventProcessors'; +import { notifyEventProcessors } from '../eventProcessors'; import { Scope } from '../scope'; import { applyScopeDataToEvent, mergeScopeData } from './applyScopeDataToEvent'; @@ -35,8 +35,6 @@ export type ExclusiveEventHintOrCaptureContext = * Information that is already present in the event is never overwritten. For * nested objects, such as the context, keys are merged. * - * Note: This also triggers callbacks for `addGlobalEventProcessor`, but not `beforeSend`. - * * @param event The original event. * @param hint May contain additional information about the original exception. * @param scope A scope containing event metadata. @@ -99,11 +97,8 @@ export function prepareEvent( applyScopeDataToEvent(prepared, data); - // TODO (v8): Update this order to be: Global > Client > Scope const eventProcessors = [ ...clientEventProcessors, - // eslint-disable-next-line deprecation/deprecation - ...getGlobalEventProcessors(), // Run scope event processors _after_ all other processors ...data.eventProcessors, ]; diff --git a/packages/core/src/utils/spanOnScope.ts b/packages/core/src/utils/spanOnScope.ts new file mode 100644 index 000000000000..f6403b57b1b4 --- /dev/null +++ b/packages/core/src/utils/spanOnScope.ts @@ -0,0 +1,29 @@ +import type { Scope, Span } from '@sentry/types'; +import { addNonEnumerableProperty } from '@sentry/utils'; + +const SCOPE_SPAN_FIELD = '_sentrySpan'; + +type ScopeWithMaybeSpan = Scope & { + [SCOPE_SPAN_FIELD]?: Span; +}; + +/** + * Set the active span for a given scope. + * NOTE: This should NOT be used directly, but is only used internally by the trace methods. + */ +export function _setSpanForScope(scope: Scope, span: Span | undefined): void { + if (span) { + addNonEnumerableProperty(scope as ScopeWithMaybeSpan, SCOPE_SPAN_FIELD, span); + } else { + // eslint-disable-next-line @typescript-eslint/no-dynamic-delete + delete (scope as ScopeWithMaybeSpan)[SCOPE_SPAN_FIELD]; + } +} + +/** + * Get the active span for a given scope. + * NOTE: This should NOT be used directly, but is only used internally by the trace methods. + */ +export function _getSpanForScope(scope: ScopeWithMaybeSpan): Span | undefined { + return scope[SCOPE_SPAN_FIELD]; +} diff --git a/packages/core/src/utils/spanUtils.ts b/packages/core/src/utils/spanUtils.ts index 094f6674121c..3d06aa0d3204 100644 --- a/packages/core/src/utils/spanUtils.ts +++ b/packages/core/src/utils/spanUtils.ts @@ -23,6 +23,7 @@ import type { MetricType } from '../metrics/types'; import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '../semanticAttributes'; import type { SentrySpan } from '../tracing/sentrySpan'; import { SPAN_STATUS_OK, SPAN_STATUS_UNSET } from '../tracing/spanstatus'; +import { _getSpanForScope } from './spanOnScope'; // These are aligned with OpenTelemetry trace flags export const TRACE_FLAG_NONE = 0x0; @@ -85,12 +86,10 @@ function ensureTimestampInSeconds(timestamp: number): number { /** * Convert a span to a JSON representation. - * Note that all fields returned here are optional and need to be guarded against. - * - * Note: Because of this, we currently have a circular type dependency (which we opted out of in package.json). - * This is not avoidable as we need `spanToJSON` in `spanUtils.ts`, which in turn is needed by `span.ts` for backwards compatibility. - * And `spanToJSON` needs the Span class from `span.ts` to check here. */ +// Note: Because of this, we currently have a circular type dependency (which we opted out of in package.json). +// This is not avoidable as we need `spanToJSON` in `spanUtils.ts`, which in turn is needed by `span.ts` for backwards compatibility. +// And `spanToJSON` needs the Span class from `span.ts` to check here. export function spanToJSON(span: Span): Partial { if (spanIsSentrySpan(span)) { return span.getSpanJSON(); @@ -253,8 +252,7 @@ export function getActiveSpan(): Span | undefined { return acs.getActiveSpan(); } - // eslint-disable-next-line deprecation/deprecation - return getCurrentScope().getSpan(); + return _getSpanForScope(getCurrentScope()); } /** diff --git a/packages/core/test/lib/scope.test.ts b/packages/core/test/lib/scope.test.ts index 978ebde52c9f..267053e6a9b0 100644 --- a/packages/core/test/lib/scope.test.ts +++ b/packages/core/test/lib/scope.test.ts @@ -203,23 +203,6 @@ describe('Scope', () => { expect(scope['_user']).toEqual({}); }); - test('setSpan', () => { - const scope = new Scope(); - const span = { fake: 'span' } as any; - // eslint-disable-next-line deprecation/deprecation - scope.setSpan(span); - expect(scope['_span']).toEqual(span); - }); - - test('setSpan with no value unsets it', () => { - const scope = new Scope(); - // eslint-disable-next-line deprecation/deprecation - scope.setSpan({ fake: 'span' } as any); - // eslint-disable-next-line deprecation/deprecation - scope.setSpan(); - expect(scope['_span']).toEqual(undefined); - }); - test('setProcessingMetadata', () => { const scope = new Scope(); scope.setSDKProcessingMetadata({ dogs: 'are great!' }); diff --git a/packages/core/test/lib/sdk.test.ts b/packages/core/test/lib/sdk.test.ts index 0117585d05ab..ecc7d18483e5 100644 --- a/packages/core/test/lib/sdk.test.ts +++ b/packages/core/test/lib/sdk.test.ts @@ -1,4 +1,4 @@ -import type { Client, Integration, IntegrationFnResult } from '@sentry/types'; +import type { Client, Integration } from '@sentry/types'; import { captureCheckIn, getCurrentScope, setCurrentClient } from '../../src'; import { installedIntegrations } from '../../src/integration'; @@ -43,20 +43,20 @@ describe('SDK', () => { name: 'integration1', setupOnce: jest.fn(() => list.push('setupOnce1')), afterAllSetup: jest.fn(() => list.push('afterAllSetup1')), - } satisfies IntegrationFnResult; + } satisfies Integration; const integration2 = { name: 'integration2', setupOnce: jest.fn(() => list.push('setupOnce2')), setup: jest.fn(() => list.push('setup2')), afterAllSetup: jest.fn(() => list.push('afterAllSetup2')), - } satisfies IntegrationFnResult; + } satisfies Integration; const integration3 = { name: 'integration3', setupOnce: jest.fn(() => list.push('setupOnce3')), setup: jest.fn(() => list.push('setup3')), - } satisfies IntegrationFnResult; + } satisfies Integration; const integrations: Integration[] = [integration1, integration2, integration3]; const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN, integrations }); diff --git a/packages/core/test/lib/tracing/sentrySpan.test.ts b/packages/core/test/lib/tracing/sentrySpan.test.ts index e065aeff33aa..e7a971d0bdcf 100644 --- a/packages/core/test/lib/tracing/sentrySpan.test.ts +++ b/packages/core/test/lib/tracing/sentrySpan.test.ts @@ -1,7 +1,13 @@ import { timestampInSeconds } from '@sentry/utils'; import { SentrySpan } from '../../../src/tracing/sentrySpan'; import { SPAN_STATUS_ERROR } from '../../../src/tracing/spanstatus'; -import { TRACE_FLAG_NONE, TRACE_FLAG_SAMPLED, spanToJSON, spanToTraceContext } from '../../../src/utils/spanUtils'; +import { + TRACE_FLAG_NONE, + TRACE_FLAG_SAMPLED, + spanIsSampled, + spanToJSON, + spanToTraceContext, +} from '../../../src/utils/spanUtils'; describe('SentrySpan', () => { describe('name', () => { @@ -25,9 +31,9 @@ describe('SentrySpan', () => { const span = new SentrySpan({ sampled: true }); // eslint-disable-next-line deprecation/deprecation const span2 = span.startChild(); - expect((span2 as any).parentSpanId).toBe((span as any).spanId); - expect((span2 as any).traceId).toBe((span as any).traceId); - expect((span2 as any).sampled).toBe((span as any).sampled); + expect(spanToJSON(span2).parent_span_id).toBe(span.spanContext().spanId); + expect(span.spanContext().traceId).toBe(span.spanContext().traceId); + expect(spanIsSampled(span2)).toBe(spanIsSampled(span)); }); }); @@ -58,8 +64,13 @@ describe('SentrySpan', () => { }); test('with parent', () => { - const spanA = new SentrySpan({ traceId: 'a', spanId: 'b' }) as any; - const spanB = new SentrySpan({ traceId: 'c', spanId: 'd', sampled: false, parentSpanId: spanA.spanId }); + const spanA = new SentrySpan({ traceId: 'a', spanId: 'b' }); + const spanB = new SentrySpan({ + traceId: 'c', + spanId: 'd', + sampled: false, + parentSpanId: spanA.spanContext().spanId, + }); const serialized = spanToJSON(spanB); expect(serialized).toHaveProperty('parent_span_id', 'b'); expect(serialized).toHaveProperty('span_id', 'd'); @@ -67,9 +78,9 @@ describe('SentrySpan', () => { }); test('should drop all `undefined` values', () => { - const spanA = new SentrySpan({ traceId: 'a', spanId: 'b' }) as any; + const spanA = new SentrySpan({ traceId: 'a', spanId: 'b' }); const spanB = new SentrySpan({ - parentSpanId: spanA.spanId, + parentSpanId: spanA.spanContext().spanId, spanId: 'd', traceId: 'c', }); diff --git a/packages/core/test/lib/tracing/trace.test.ts b/packages/core/test/lib/tracing/trace.test.ts index b937b20338d1..58fc5623f587 100644 --- a/packages/core/test/lib/tracing/trace.test.ts +++ b/packages/core/test/lib/tracing/trace.test.ts @@ -23,6 +23,7 @@ import { withActiveSpan, } from '../../../src/tracing'; import { SentryNonRecordingSpan } from '../../../src/tracing/sentryNonRecordingSpan'; +import { _setSpanForScope } from '../../../src/utils/spanOnScope'; import { getActiveSpan, getRootSpan, getSpanDescendants } from '../../../src/utils/spanUtils'; import { TestClient, getDefaultTestClientOptions } from '../../mocks/client'; @@ -259,8 +260,7 @@ describe('startSpan', () => { const manualScope = initialScope.clone(); const parentSpan = new SentrySpan({ spanId: 'parent-span-id' }); - // eslint-disable-next-line deprecation/deprecation - manualScope.setSpan(parentSpan); + _setSpanForScope(manualScope, parentSpan); startSpan({ name: 'GET users/[id]', scope: manualScope }, span => { expect(getCurrentScope()).not.toBe(initialScope); @@ -354,6 +354,7 @@ describe('startSpan', () => { trace: { data: { 'sentry.source': 'custom', + 'sentry.sample_rate': 1, 'sentry.origin': 'manual', }, parent_span_id: innerParentSpanId, @@ -575,8 +576,7 @@ describe('startSpanManual', () => { const manualScope = initialScope.clone(); const parentSpan = new SentrySpan({ spanId: 'parent-span-id' }); - // eslint-disable-next-line deprecation/deprecation - manualScope.setSpan(parentSpan); + _setSpanForScope(manualScope, parentSpan); startSpanManual({ name: 'GET users/[id]', scope: manualScope }, (span, finish) => { expect(getCurrentScope()).not.toBe(initialScope); @@ -679,6 +679,7 @@ describe('startSpanManual', () => { trace: { data: { 'sentry.source': 'custom', + 'sentry.sample_rate': 1, 'sentry.origin': 'manual', }, parent_span_id: innerParentSpanId, @@ -840,8 +841,7 @@ describe('startInactiveSpan', () => { const manualScope = initialScope.clone(); const parentSpan = new SentrySpan({ spanId: 'parent-span-id' }); - // eslint-disable-next-line deprecation/deprecation - manualScope.setSpan(parentSpan); + _setSpanForScope(manualScope, parentSpan); const span = startInactiveSpan({ name: 'GET users/[id]', scope: manualScope }); @@ -932,6 +932,7 @@ describe('startInactiveSpan', () => { trace: { data: { 'sentry.source': 'custom', + 'sentry.sample_rate': 1, 'sentry.origin': 'manual', }, parent_span_id: innerParentSpanId, @@ -1206,11 +1207,11 @@ describe('getActiveSpan', () => { it('works with an active span on the scope', () => { const activeSpan = new SentrySpan({ spanId: 'aha' }); - // eslint-disable-next-line deprecation/deprecation - getCurrentScope().setSpan(activeSpan); - const span = getActiveSpan(); - expect(span).toBe(activeSpan); + withActiveSpan(activeSpan, () => { + const span = getActiveSpan(); + expect(span).toBe(activeSpan); + }); }); it('uses implementation from ACS, if it exists', () => { diff --git a/packages/core/test/lib/tracing/transaction.test.ts b/packages/core/test/lib/tracing/transaction.test.ts index 781b9bdc1472..aebdc7933fed 100644 --- a/packages/core/test/lib/tracing/transaction.test.ts +++ b/packages/core/test/lib/tracing/transaction.test.ts @@ -32,15 +32,12 @@ describe('transaction', () => { /* eslint-disable deprecation/deprecation */ it('works with defaults', () => { const transaction = new Transaction({ name: 'span name' }); - expect(transaction.metadata).toEqual({ - spanMetadata: {}, - }); + expect(transaction.metadata).toEqual({}); }); it('allows to set metadata in constructor', () => { const transaction = new Transaction({ name: 'span name', metadata: { request: {} } }); expect(transaction.metadata).toEqual({ - spanMetadata: {}, request: {}, }); }); @@ -57,7 +54,6 @@ describe('transaction', () => { expect(transaction.metadata).toEqual({ sampleRate: 0.5, - spanMetadata: {}, request: {}, }); @@ -74,7 +70,6 @@ describe('transaction', () => { transaction.setMetadata({ request: {} }); expect(transaction.metadata).toEqual({ - spanMetadata: {}, request: {}, }); }); diff --git a/packages/core/test/mocks/integration.ts b/packages/core/test/mocks/integration.ts index dbee06380d1c..ce012923030e 100644 --- a/packages/core/test/mocks/integration.ts +++ b/packages/core/test/mocks/integration.ts @@ -1,4 +1,4 @@ -import type { Event, EventProcessor, Integration } from '@sentry/types'; +import type { Client, Event, EventProcessor, Integration } from '@sentry/types'; import { getClient, getCurrentScope } from '../../src'; @@ -27,8 +27,8 @@ export class AddAttachmentTestIntegration implements Integration { public name: string = 'AddAttachmentTestIntegration'; - public setupOnce(addGlobalEventProcessor: (callback: EventProcessor) => void): void { - addGlobalEventProcessor((event, hint) => { + public setup(client: Client): void { + client.addEventProcessor((event, hint) => { hint.attachments = [...(hint.attachments || []), { filename: 'integration.file', data: 'great content!' }]; return event; }); diff --git a/packages/ember/addon/types.ts b/packages/ember/addon/types.ts index 1b6825442be1..468cde6c310f 100644 --- a/packages/ember/addon/types.ts +++ b/packages/ember/addon/types.ts @@ -1,5 +1,4 @@ import type { BrowserOptions, browserTracingIntegration } from '@sentry/browser'; -import type { Transaction, TransactionContext } from '@sentry/types'; type BrowserTracingOptions = Parameters[0]; @@ -31,8 +30,6 @@ export interface EmberRouterMain { rootURL: string; }; } -/** @deprecated This will be removed in v8. */ -export type StartTransactionFunction = (context: TransactionContext) => Transaction | undefined; export type GlobalConfig = { __sentryEmberConfig: EmberSentryConfig['sentry']; diff --git a/packages/feedback/src/constants/index.ts b/packages/feedback/src/constants/index.ts index 9804fdedf431..fe4683b5ee17 100644 --- a/packages/feedback/src/constants/index.ts +++ b/packages/feedback/src/constants/index.ts @@ -20,8 +20,11 @@ export const MESSAGE_LABEL = 'Description'; export const NAME_PLACEHOLDER = 'Your Name'; export const NAME_LABEL = 'Name'; export const SUCCESS_MESSAGE_TEXT = 'Thank you for your report!'; +export const IS_REQUIRED_TEXT = '(required)'; export const FEEDBACK_WIDGET_SOURCE = 'widget'; export const FEEDBACK_API_SOURCE = 'api'; export const SUCCESS_MESSAGE_TIMEOUT = 5000; + +export const CROP_COLOR = '#ffffff'; diff --git a/packages/feedback/src/core/integration.ts b/packages/feedback/src/core/integration.ts index 489bfd32728d..a37aec267730 100644 --- a/packages/feedback/src/core/integration.ts +++ b/packages/feedback/src/core/integration.ts @@ -1,5 +1,5 @@ import { defineIntegration, getClient } from '@sentry/core'; -import type { IntegrationFn, IntegrationFnResult } from '@sentry/types'; +import type { Integration, IntegrationFn } from '@sentry/types'; import { isBrowser, logger } from '@sentry/utils'; import { ACTOR_LABEL, @@ -9,6 +9,7 @@ import { EMAIL_LABEL, EMAIL_PLACEHOLDER, FORM_TITLE, + IS_REQUIRED_TEXT, MESSAGE_LABEL, MESSAGE_PLACEHOLDER, NAME_LABEL, @@ -42,7 +43,7 @@ interface PublicFeedbackIntegration { closeDialog: () => void; removeWidget: () => void; } -export type IFeedbackIntegration = IntegrationFnResult & PublicFeedbackIntegration; +export type IFeedbackIntegration = Integration & PublicFeedbackIntegration; export const _feedbackIntegration = (({ // FeedbackGeneralConfiguration @@ -76,6 +77,7 @@ export const _feedbackIntegration = (({ nameLabel = NAME_LABEL, namePlaceholder = NAME_PLACEHOLDER, successMessageText = SUCCESS_MESSAGE_TEXT, + isRequiredText = IS_REQUIRED_TEXT, // FeedbackCallbacks onFormOpen, @@ -116,6 +118,7 @@ export const _feedbackIntegration = (({ nameLabel, namePlaceholder, successMessageText, + isRequiredText, onFormClose, onFormOpen, diff --git a/packages/feedback/src/modal/components/Form.tsx b/packages/feedback/src/modal/components/Form.tsx index 0b2b1bb98fb1..960b4c3d9038 100644 --- a/packages/feedback/src/modal/components/Form.tsx +++ b/packages/feedback/src/modal/components/Form.tsx @@ -29,6 +29,7 @@ export interface Props | 'showEmail' | 'showName' | 'submitButtonLabel' + | 'isRequiredText' > { defaultEmail: string; defaultName: string; @@ -66,6 +67,7 @@ export function Form({ showEmail, showName, submitButtonLabel, + isRequiredText, screenshotInput, }: Props): VNode { // TODO: set a ref on the form, and whenever an input changes call proceessForm() and setError() @@ -145,7 +147,7 @@ export function Form({ {showName ? (