test: Add e2e for node with custom otel sampler (#13034)

Author: chargome

.github/workflows/build.yml

@@ -990,6 +990,7 @@ jobs:
             'node-express-esm-without-loader',
             'node-express-cjs-preload',
             'node-otel-sdk-node',
+            'node-otel-custom-sampler',
             'ember-classic',
             'ember-embroider',
             'nextjs-app-dir',

dev-packages/e2e-tests/test-applications/node-otel-custom-sampler/.gitignore

@@ -0,0 +1,2 @@
+dist
+.vscode

dev-packages/e2e-tests/test-applications/node-otel-custom-sampler/.npmrc

@@ -0,0 +1,2 @@
+@sentry:registry=http://127.0.0.1:4873
+@sentry-internal:registry=http://127.0.0.1:4873

dev-packages/e2e-tests/test-applications/node-otel-custom-sampler/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "node-otel-custom-sampler",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/app.js",
+    "test": "playwright test",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
+    "test:build": "pnpm install && pnpm build",
+    "test:assert": "pnpm test"
+  },
+  "dependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/sdk-trace-node": "^1.25.1",
+    "@sentry/node": "latest || *",
+    "@sentry/opentelemetry": "latest || *",
+    "@sentry/types": "latest || *",
+    "@types/express": "4.17.17",
+    "@types/node": "18.15.1",
+    "express": "4.19.2",
+    "typescript": "4.9.5"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.44.1",
+    "@sentry-internal/test-utils": "link:../../../test-utils"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  }
+}

dev-packages/e2e-tests/test-applications/node-otel-custom-sampler/playwright.config.mjs

@@ -0,0 +1,7 @@
+import { getPlaywrightConfig } from '@sentry-internal/test-utils';
+
+const config = getPlaywrightConfig({
+  startCommand: `pnpm start`,
+});
+
+export default config;

dev-packages/e2e-tests/test-applications/node-otel-custom-sampler/src/app.ts

@@ -0,0 +1,50 @@
+import './instrument';
+
+import * as Sentry from '@sentry/node';
+import express from 'express';
+
+const PORT = 3030;
+const app = express();
+
+const wait = (duration: number) => {
+  return new Promise<void>(res => {
+    setTimeout(() => res(), duration);
+  });
+};
+
+app.get('/task', async (_req, res) => {
+  await Sentry.startSpan({ name: 'Long task', op: 'custom.op' }, async () => {
+    await wait(200);
+  });
+  res.send('ok');
+});
+
+app.get('/unsampled/task', async (_req, res) => {
+  await wait(200);
+  res.send('ok');
+});
+
+app.get('/test-error', async function (req, res) {
+  const exceptionId = Sentry.captureException(new Error('This is an error'));
+
+  await Sentry.flush(2000);
+
+  res.send({ exceptionId });
+});
+
+app.get('/test-exception/:id', function (req, _res) {
+  throw new Error(`This is an exception with id ${req.params.id}`);
+});
+
+Sentry.setupExpressErrorHandler(app);
+
+app.use(function onError(err: unknown, req: any, res: any, next: any) {
+  // The error id is attached to `res.sentry` to be returned
+  // and optionally displayed to the user for support.
+  res.statusCode = 500;
+  res.end(res.sentry + '\n');
+});
+
+app.listen(PORT, () => {
+  console.log('App listening on ', PORT);
+});

dev-packages/e2e-tests/test-applications/node-otel-custom-sampler/src/custom-sampler.ts

@@ -0,0 +1,31 @@
+import { Attributes, Context, Link, SpanKind } from '@opentelemetry/api';
+import { Sampler, SamplingResult } from '@opentelemetry/sdk-trace-node';
+import { wrapSamplingDecision } from '@sentry/opentelemetry';
+
+export class CustomSampler implements Sampler {
+  public shouldSample(
+    context: Context,
+    _traceId: string,
+    _spanName: string,
+    _spanKind: SpanKind,
+    attributes: Attributes,
+    _links: Link[],
+  ): SamplingResult {
+    const route = attributes['http.route'];
+    const target = attributes['http.target'];
+    const decision =
+      (typeof route === 'string' && route.includes('/unsampled')) ||
+      (typeof target === 'string' && target.includes('/unsampled'))
+        ? 0
+        : 1;
+    return wrapSamplingDecision({
+      decision,
+      context,
+      spanAttributes: attributes,
+    });
+  }
+
+  public toString(): string {
+    return CustomSampler.name;
+  }
+}

dev-packages/e2e-tests/test-applications/node-otel-custom-sampler/src/instrument.ts

@@ -0,0 +1,30 @@
+import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
+import * as Sentry from '@sentry/node';
+import { SentryPropagator, SentrySpanProcessor } from '@sentry/opentelemetry';
+import { CustomSampler } from './custom-sampler';
+
+Sentry.init({
+  environment: 'qa', // dynamic sampling bias to keep transactions
+  dsn:
+    process.env.E2E_TEST_DSN ||
+    'https://3b6c388182fb435097f41d181be2b2ba@o4504321058471936.ingest.sentry.io/4504321066008576',
+  includeLocalVariables: true,
+  debug: !!process.env.DEBUG,
+  tunnel: `http://localhost:3031/`, // proxy server
+  skipOpenTelemetrySetup: true,
+  // By defining _any_ sample rate, tracing intergations will be added by default
+  tracesSampleRate: 0,
+});
+
+const provider = new NodeTracerProvider({
+  sampler: new CustomSampler(),
+});
+
+provider.addSpanProcessor(new SentrySpanProcessor());
+
+provider.register({
+  propagator: new SentryPropagator(),
+  contextManager: new Sentry.SentryContextManager(),
+});
+
+Sentry.validateOpenTelemetrySetup();

dev-packages/e2e-tests/test-applications/node-otel-custom-sampler/start-event-proxy.mjs

@@ -0,0 +1,6 @@
+import { startEventProxyServer } from '@sentry-internal/test-utils';
+
+startEventProxyServer({
+  port: 3031,
+  proxyServerName: 'node-otel-custom-sampler',
+});

dev-packages/e2e-tests/test-applications/node-otel-custom-sampler/tests/errors.test.ts

@@ -0,0 +1,29 @@
+import { expect, test } from '@playwright/test';
+import { waitForError } from '@sentry-internal/test-utils';
+
+test('Sends correct error event', async ({ baseURL }) => {
+  const errorEventPromise = waitForError('node-otel-custom-sampler', event => {
+    return !event.type && event.exception?.values?.[0]?.value === 'This is an exception with id 123';
+  });
+
+  await fetch(`${baseURL}/test-exception/123`);
+
+  const errorEvent = await errorEventPromise;
+
+  expect(errorEvent.exception?.values).toHaveLength(1);
+  expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an exception with id 123');
+
+  expect(errorEvent.request).toEqual({
+    method: 'GET',
+    cookies: {},
+    headers: expect.any(Object),
+    url: 'http://localhost:3030/test-exception/123',
+  });
+
+  expect(errorEvent.transaction).toEqual('GET /test-exception/:id');
+
+  expect(errorEvent.contexts?.trace).toEqual({
+    trace_id: expect.any(String),
+    span_id: expect.any(String),
+  });
+});