Merge branch 'develop' into abhi-remove-sentry-tracing

Author: AbhiPrasad

.craft.yml

@@ -131,7 +131,12 @@ targets:
     id: '@sentry-internal/eslint-config-sdk'
     includeNames: /^sentry-internal-eslint-config-sdk-\d.*\.tgz$/
 
-  ## 8. Experimental packages
+  ## 8. Deprecated packages we still release (but no packages depend on them anymore)
+  - name: npm
+    id: '@sentry/hub'
+    includeNames: /^sentry-hub-\d.*\.tgz$/
+
+  ## 9. Experimental packages
   - name: npm
     id: '@sentry/node-experimental'
     includeNames: /^sentry-node-experimental-\d.*\.tgz$/

.github/CANARY_FAILURE_TEMPLATE.md

@@ -1,5 +1,5 @@
 ---
 title: '{{ env.TITLE }}'
-labels: 'Type: Tests'
+labels: 'Type: Tests, Waiting for: Product Owner'
 ---
 Canary tests failed: {{ env.RUN_LINK }}

.github/workflows/build.yml

@@ -899,6 +899,7 @@ jobs:
       - name: Run integration tests
         env:
           NODE_VERSION: ${{ matrix.node }}
+          TS_VERSION: ${{ matrix.typescript }}
         run: |
           cd dev-packages/node-integration-tests
           yarn test
@@ -1042,9 +1043,8 @@ jobs:
             'node-express-app',
             'create-react-app',
             'create-next-app',
-            # disabling remix e2e tests because of flakes
-            # 'create-remix-app',
-            # 'create-remix-app-v2',
+            'create-remix-app',
+            'create-remix-app-v2',
             'debug-id-sourcemaps',
             'nextjs-app-dir',
             'nextjs-14',
@@ -1056,7 +1056,8 @@ jobs:
             'sveltekit-2',
             'generic-ts3.8',
             'node-experimental-fastify-app',
-            'node-hapi-app',
+            # TODO(v8): Re-enable hapi tests
+            # 'node-hapi-app',
             'node-exports-test-app',
             'vue-3'
           ]

CODEOWNERS

@@ -1,3 +1,5 @@
-packages/replay                                   @getsentry/replay-sdk
-packages/replay-worker                            @getsentry/replay-sdk
-dev-packages/browser-integration-tests/suites/replay  @getsentry/replay-sdk
+packages/replay                                   @getsentry/replay-sdk-web
+packages/replay-worker                            @getsentry/replay-sdk-web
+packages/replay-canvas                            @getsentry/replay-sdk-web
+packages/feedback                                 @getsentry/replay-sdk-web
+dev-packages/browser-integration-tests/suites/replay  @getsentry/replay-sdk-web

MIGRATION.md

@@ -1,5 +1,37 @@
 # Upgrading from 7.x to 8.x
 
+## Removal of the `MetricsAggregator` integration class and `metricsAggregatorIntegration`
+
+The SDKs now support metrics features without any additional configuration.
+
+## Updated behaviour of `tracePropagationTargets` in the browser (HTTP tracing headers & CORS)
+
+We updated the behaviour of the SDKs when no `tracePropagationTargets` option was defined. As a reminder, you can
+provide a list of strings or RegExes that will be matched against URLs to tell the SDK, to which outgoing requests
+tracing HTTP headers should be attached to. These tracing headers are used for distributed tracing.
+
+Previously, on the browser, when `tracePropagationTargets` were not defined, they defaulted to the following:
+`['localhost', /^\/(?!\/)/]`. This meant that all request targets to that had "localhost" in the URL, or started with a
+`/` were equipped with tracing headers. This default was chosen to prevent CORS errors in your browser applications.
+However, this default had a few flaws.
+
+Going forward, when the `tracePropagationTargets` option is not set, tracing headers will be attached to all outgoing
+requests on the same origin. For example, if you're on `https://example.com/` and you send a request to
+`https://example.com/api`, the request will be traced (ie. will have trace headers attached). Requests to
+`https://api.example.com/` will not, because it is on a different origin. The same goes for all applications running on
+`localhost`.
+
+When you provide a `tracePropagationTargets` option, all of the entries you defined will now be matched be matched
+against the full URL of the outgoing request. Previously, it was only matched against what you called request APIs with.
+For example, if you made a request like `fetch("/api/posts")`, the provided `tracePropagationTargets` were only compared
+against `"/api/posts"`. Going forward they will be matched against the entire URL, for example, if you were on the page
+`https://example.com/` and you made the same request, it would be matched against `"https://example.com/api/posts"`.
+
+But that is not all. Because it would be annoying having to create matchers for the entire URL, if the request is a
+same-origin request, we also match the `tracePropagationTargets` against the resolved `pathname` of the request.
+Meaning, a matcher like `/^\/api/` would match a request call like `fetch('/api/posts')`, or
+`fetch('https://same-origin.com/api/posts')` but not `fetch('https://different-origin.com/api/posts')`.
+
 ## Removal of the `tracingOrigins` option
 
 After its deprecation in v7 the `tracingOrigins` option is now removed in favor of the `tracePropagationTargets` option.
@@ -27,6 +59,11 @@ The following previously deprecated API has been removed from the `@sentry/nextj
 - `IS_BUILD`
 - `isBuild`
 
+## Removal of `Span` class export from SDK packages
+
+In v8, we are no longer exporting the `Span` class from SDK packages (e.g. `@sentry/browser` or `@sentry/node`).
+Internally, this class is now called `SentrySpan`, and it is no longer meant to be used by users directly.
+
 ## Removal of Severity Enum
 
 In v7 we deprecated the `Severity` enum in favor of using the `SeverityLevel` type. In v8 we removed the `Severity`
@@ -59,6 +96,11 @@ to access and mutate the current scope.
 `@sentry/tracing` has been removed. All exports from `@sentry/tracing` should be available in `@sentry/core` or in
 `@sentry/browser` and `@sentry/node`.
 
+## Removal of `makeXHRTransport` transport (#10703)
+
+The `makeXHRTransport` transport has been removed. Only `makeFetchTransport` is available now. This means that the
+Sentry SDK requires the fetch API to be available in the environment.
+
 ## General API Changes
 
 - The minumum supported Node version for all the SDK packages is Node 14 (#10527)

dev-packages/browser-integration-tests/package.json

@@ -48,7 +48,7 @@
     "@playwright/test": "^1.40.1",
     "@sentry-internal/rrweb": "2.11.0",
     "@sentry/browser": "7.100.0",
-    "axios": "1.6.0",
+    "axios": "1.6.7",
     "babel-loader": "^8.2.2",
     "html-webpack-plugin": "^5.5.0",
     "pako": "^2.1.0",

dev-packages/browser-integration-tests/suites/feedback/captureFeedback/test.ts

@@ -44,6 +44,7 @@ sentryTest('should capture feedback (@sentry-internal/feedback import)', async (
   const feedbackEvent = envelopeRequestParser((await feedbackRequestPromise).request());
   expect(feedbackEvent).toEqual({
     type: 'feedback',
+    breadcrumbs: expect.any(Array),
     contexts: {
       feedback: {
         contact_email: '[email protected]',

dev-packages/browser-integration-tests/suites/feedback/captureFeedbackAndReplay/test.ts

@@ -50,15 +50,16 @@ sentryTest('should capture feedback (@sentry-internal/feedback import)', async (
 
   expect(breadcrumbs).toEqual(
     expect.arrayContaining([
-      {
+      expect.objectContaining({
         category: 'sentry.feedback',
         data: { feedbackId: expect.any(String) },
-      },
+      }),
     ]),
   );
 
   expect(feedbackEvent).toEqual({
     type: 'feedback',
+    breadcrumbs: expect.any(Array),
     contexts: {
       feedback: {
         contact_email: '[email protected]',

dev-packages/browser-integration-tests/suites/integrations/Breadcrumbs/dom/click/test.ts

@@ -78,9 +78,8 @@ sentryTest(
 
     await page.goto(url);
     await page.locator('#annotated-button').click();
-    await page.evaluate('Sentry.captureException("test exception")');
 
-    const eventData = await promise;
+    const [eventData] = await Promise.all([promise, page.evaluate('Sentry.captureException("test exception")')]);
 
     expect(eventData.breadcrumbs).toEqual([
       {

dev-packages/browser-integration-tests/suites/integrations/httpclient/fetch/simple/test.ts

@@ -4,6 +4,8 @@ import type { Event } from '@sentry/types';
 import { sentryTest } from '../../../../../utils/fixtures';
 import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';
 
+// This test rarely flakes with timeouts. The reason might be:
+// https://github.com/microsoft/playwright/issues/10376
 sentryTest(
   'should assign request and response context from a failed 500 fetch request',
   async ({ getLocalTestPath, page }) => {

dev-packages/browser-integration-tests/suites/metrics/init.js

@@ -0,0 +1,16 @@
+import * as Sentry from '@sentry/browser';
+
+window.Sentry = Sentry;
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+});
+
+Sentry.metrics.increment('increment');
+Sentry.metrics.increment('increment');
+Sentry.metrics.distribution('distribution', 42);
+Sentry.metrics.distribution('distribution', 45);
+Sentry.metrics.gauge('gauge', 5);
+Sentry.metrics.gauge('gauge', 15);
+Sentry.metrics.set('set', 'nope');
+Sentry.metrics.set('set', 'another');

dev-packages/browser-integration-tests/suites/metrics/test.ts

@@ -0,0 +1,17 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../utils/fixtures';
+import { getFirstSentryEnvelopeRequest, properEnvelopeRequestParser } from '../../utils/helpers';
+
+sentryTest('collects metrics', async ({ getLocalTestUrl, page }) => {
+  const url = await getLocalTestUrl({ testDir: __dirname });
+
+  const statsdBuffer = await getFirstSentryEnvelopeRequest<Uint8Array>(page, url, properEnvelopeRequestParser);
+  const statsdString = new TextDecoder().decode(statsdBuffer);
+  // Replace all the Txxxxxx to remove the timestamps
+  const normalisedStatsdString = statsdString.replace(/T\d+\n?/g, 'T000000');
+
+  expect(normalisedStatsdString).toEqual(
+    'increment@none:2|c|T000000distribution@none:42:45|d|T000000gauge@none:15:5:15:20:2|g|T000000set@none:3387254:3443787523|s|T000000',
+  );
+});

dev-packages/browser-integration-tests/suites/public-api/debug/test.ts

@@ -25,7 +25,7 @@ sentryTest('logs debug messages correctly', async ({ getLocalTestUrl, page }) =>
       ? [
           'Sentry Logger [log]: Integration installed: InboundFilters',
           'Sentry Logger [log]: Integration installed: FunctionToString',
-          'Sentry Logger [log]: Integration installed: TryCatch',
+          'Sentry Logger [log]: Integration installed: BrowserApiErrors',
           'Sentry Logger [log]: Integration installed: Breadcrumbs',
           'Sentry Logger [log]: Global Handler attached: onerror',
           'Sentry Logger [log]: Global Handler attached: onunhandledrejection',

dev-packages/browser-integration-tests/suites/public-api/startSpan/basic/subject.js

@@ -6,4 +6,6 @@ async function run() {
   });
 }
 
-run();
+(async () => {
+  await run();
+})();

dev-packages/browser-integration-tests/suites/public-api/startTransaction/basic_usage/subject.js

@@ -1,35 +1,23 @@
-async function run() {
-  const transaction = Sentry.startTransaction({ name: 'test_transaction_1' });
-  const span_1 = transaction.startChild({
-    op: 'span_1',
-    data: {
-      foo: 'bar',
-      baz: [1, 2, 3],
+Sentry.startSpan({ name: 'root_span' }, () => {
+  Sentry.startSpan(
+    {
+      name: 'span_1',
+      data: {
+        foo: 'bar',
+        baz: [1, 2, 3],
+      },
     },
-  });
-
-  await new Promise(resolve => setTimeout(resolve, 1));
-
-  // span_1 finishes
-  span_1.end();
+    () => undefined,
+  );
 
   // span_2 doesn't finish
-  const span_2 = transaction.startChild({ op: 'span_2' });
-  await new Promise(resolve => setTimeout(resolve, 1));
-
-  const span_3 = transaction.startChild({ op: 'span_3' });
-  await new Promise(resolve => setTimeout(resolve, 1));
+  Sentry.startInactiveSpan({ name: 'span_2' });
 
-  // span_4 is the child of span_3 but doesn't finish.
-  const span_4 = span_3.startChild({ op: 'span_4', data: { qux: 'quux' } });
+  Sentry.startSpan({ name: 'span_3' }, () => {
+    // span_4 is the child of span_3 but doesn't finish.
+    Sentry.startInactiveSpan({ name: 'span_4', data: { qux: 'quux' } });
 
-  // span_5 is another child of span_3 but finishes.
-  const span_5 = span_3.startChild({ op: 'span_5' }).end();
-
-  // span_3 also finishes
-  span_3.end();
-
-  transaction.end();
-}
-
-run();
+    // span_5 is another child of span_3 but finishes.
+    Sentry.startInactiveSpan({ name: 'span_5' }).end();
+  });
+});

dev-packages/browser-integration-tests/suites/public-api/startTransaction/basic_usage/test.ts

@@ -12,11 +12,11 @@ sentryTest('should report a transaction in an envelope', async ({ getLocalTestPa
   const url = await getLocalTestPath({ testDir: __dirname });
   const transaction = await getFirstSentryEnvelopeRequest<SerializedEvent>(page, url);
 
-  expect(transaction.transaction).toBe('test_transaction_1');
+  expect(transaction.transaction).toBe('root_span');
   expect(transaction.spans).toBeDefined();
 });
 
-sentryTest('should report finished spans as children of the root transaction', async ({ getLocalTestPath, page }) => {
+sentryTest('should report finished spans as children of the root span', async ({ getLocalTestPath, page }) => {
   if (shouldSkipTracingTest()) {
     sentryTest.skip();
   }
@@ -31,17 +31,17 @@ sentryTest('should report finished spans as children of the root transaction', a
   const span_1 = transaction.spans?.[0];
 
   expect(span_1).toBeDefined();
-  expect(span_1!.op).toBe('span_1');
+  expect(span_1!.description).toBe('span_1');
   expect(span_1!.parent_span_id).toEqual(rootSpanId);
   expect(span_1!.data).toMatchObject({ foo: 'bar', baz: [1, 2, 3] });
 
   const span_3 = transaction.spans?.[1];
   expect(span_3).toBeDefined();
-  expect(span_3!.op).toBe('span_3');
+  expect(span_3!.description).toBe('span_3');
   expect(span_3!.parent_span_id).toEqual(rootSpanId);
 
   const span_5 = transaction.spans?.[2];
   expect(span_5).toBeDefined();
-  expect(span_5!.op).toBe('span_5');
+  expect(span_5!.description).toBe('span_5');
   expect(span_5!.parent_span_id).toEqual(span_3!.span_id);
 });

dev-packages/browser-integration-tests/suites/public-api/startTransaction/circular_data/subject.js

@@ -2,8 +2,6 @@ const chicken = {};
 const egg = { contains: chicken };
 chicken.lays = egg;
 
-const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: { chicken } });
-const span = transaction.startChild({ op: 'circular_object_test_span', data: { chicken } });
-
-span.end();
-transaction.end();
+Sentry.startSpan({ name: 'circular_object_test_transaction', data: { chicken } }, () => {
+  Sentry.startSpan({ op: 'circular_object_test_span', data: { chicken } }, () => undefined);
+});

dev-packages/browser-integration-tests/suites/replay/captureReplay/test.ts

@@ -45,7 +45,7 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
       integrations: [
         'InboundFilters',
         'FunctionToString',
-        'TryCatch',
+        'BrowserApiErrors',
         'Breadcrumbs',
         'GlobalHandlers',
         'LinkedErrors',
@@ -82,7 +82,7 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
       integrations: [
         'InboundFilters',
         'FunctionToString',
-        'TryCatch',
+        'BrowserApiErrors',
         'Breadcrumbs',
         'GlobalHandlers',
         'LinkedErrors',

dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts

@@ -45,7 +45,7 @@ sentryTest('should capture replays (@sentry/replay export)', async ({ getLocalTe
       integrations: [
         'InboundFilters',
         'FunctionToString',
-        'TryCatch',
+        'BrowserApiErrors',
         'Breadcrumbs',
         'GlobalHandlers',
         'LinkedErrors',
@@ -82,7 +82,7 @@ sentryTest('should capture replays (@sentry/replay export)', async ({ getLocalTe
       integrations: [
         'InboundFilters',
         'FunctionToString',
-        'TryCatch',
+        'BrowserApiErrors',
         'Breadcrumbs',
         'GlobalHandlers',
         'LinkedErrors',

dev-packages/browser-integration-tests/suites/replay/errorResponse/test.ts

@@ -23,9 +23,8 @@ sentryTest('should stop recording after receiving an error response', async ({ g
   });
 
   const url = await getLocalTestPath({ testDir: __dirname });
-  await page.goto(url);
+  await Promise.all([page.goto(url), waitForReplayRequest(page)]);
 
-  await waitForReplayRequest(page);
   await page.locator('button').click();
 
   expect(called).toBe(1);

dev-packages/browser-integration-tests/suites/replay/errors/errorModeCustomTransport/init.js

@@ -14,7 +14,7 @@ Sentry.init({
   replaysOnErrorSampleRate: 1.0,
   integrations: [window.Replay],
   transport: options => {
-    const transport = new Sentry.makeXHRTransport(options);
+    const transport = new Sentry.makeFetchTransport(options);
 
     delete transport.send.__sentry__baseTransport__;
 

dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/backgroundtab-custom/init.js

@@ -4,6 +4,6 @@ window.Sentry = Sentry;
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
-  integrations: [Sentry.browserTracingIntegration({ idleTimeout: 9000 })],
+  integrations: [Sentry.browserTracingIntegration({ idleTimeout: 9000, instrumentPageLoad: false })],
   tracesSampleRate: 1,
 });