Merge remote-tracking branch 'origin/develop' into rm-browsertracing

Author: Luca Forstner

MIGRATION.md

@@ -1,5 +1,9 @@
 # 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

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

@@ -49,7 +49,7 @@
     "@sentry-internal/rrweb": "2.11.0",
     "@sentry/browser": "7.100.0",
     "@sentry/tracing": "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/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/utils/helpers.ts

@@ -1,5 +1,6 @@
 import type { Page, Request } from '@playwright/test';
-import type { EnvelopeItemType, Event, EventEnvelopeHeaders } from '@sentry/types';
+import type { EnvelopeItem, EnvelopeItemType, Event, EventEnvelopeHeaders } from '@sentry/types';
+import { parseEnvelope } from '@sentry/utils';
 
 export const envelopeUrlRegex = /\.sentry\.io\/api\/\d+\/envelope\//;
 
@@ -21,6 +22,27 @@ export const envelopeRequestParser = <T = Event>(request: Request | null, envelo
   return envelopeParser(request)[envelopeIndex] as T;
 };
 
+/**
+ * The above envelope parser does not follow the envelope spec...
+ * ...but modifying it to follow the spec breaks a lot of the test which rely on the current indexing behavior.
+ *
+ * This parser is a temporary solution to allow us to test metrics with statsd envelopes.
+ *
+ * Eventually, all the tests should be migrated to use this 'proper' envelope parser!
+ */
+export const properEnvelopeParser = (request: Request | null): EnvelopeItem[] => {
+  // https://develop.sentry.dev/sdk/envelopes/
+  const envelope = request?.postData() || '';
+
+  const [, items] = parseEnvelope(envelope);
+
+  return items;
+};
+
+export const properEnvelopeRequestParser = <T = Event>(request: Request | null, envelopeIndex = 1): T => {
+  return properEnvelopeParser(request)[0][envelopeIndex] as T;
+};
+
 export const envelopeHeaderRequestParser = (request: Request | null): EventEnvelopeHeaders => {
   // https://develop.sentry.dev/sdk/envelopes/
   const envelope = request?.postData() || '';

dev-packages/e2e-tests/test-applications/angular-17/event-proxy-server.ts

@@ -79,7 +79,7 @@ export async function startEventProxyServer(options: EventProxyServerOptions): P
               const rawSentryResponseBody = Buffer.concat(sentryResponseChunks).toString();
 
               const data: SentryRequestCallbackData = {
-                envelope: parseEnvelope(proxyRequestBody, new TextEncoder(), new TextDecoder()),
+                envelope: parseEnvelope(proxyRequestBody),
                 rawProxyRequestBody: proxyRequestBody,
                 rawSentryResponseBody,
                 sentryResponseStatusCode: sentryResponse.statusCode,

dev-packages/e2e-tests/test-applications/nextjs-14/event-proxy-server.ts

@@ -79,7 +79,7 @@ export async function startEventProxyServer(options: EventProxyServerOptions): P
               const rawSentryResponseBody = Buffer.concat(sentryResponseChunks).toString();
 
               const data: SentryRequestCallbackData = {
-                envelope: parseEnvelope(proxyRequestBody, new TextEncoder(), new TextDecoder()),
+                envelope: parseEnvelope(proxyRequestBody),
                 rawProxyRequestBody: proxyRequestBody,
                 rawSentryResponseBody,
                 sentryResponseStatusCode: sentryResponse.statusCode,

dev-packages/e2e-tests/test-applications/nextjs-app-dir/event-proxy-server.ts

@@ -79,7 +79,7 @@ export async function startEventProxyServer(options: EventProxyServerOptions): P
               const rawSentryResponseBody = Buffer.concat(sentryResponseChunks).toString();
 
               const data: SentryRequestCallbackData = {
-                envelope: parseEnvelope(proxyRequestBody, new TextEncoder(), new TextDecoder()),
+                envelope: parseEnvelope(proxyRequestBody),
                 rawProxyRequestBody: proxyRequestBody,
                 rawSentryResponseBody,
                 sentryResponseStatusCode: sentryResponse.statusCode,