feat(node): Add context info for missing instrumentation (#12639)

Adds context to the global scope for missing instrumentation of node
frameworks.

Fixes #12346

Author: chargome

dev-packages/e2e-tests/test-applications/node-express-incorrect-instrumentation/.gitignore

@@ -0,0 +1 @@
+dist

dev-packages/e2e-tests/test-applications/node-express-incorrect-instrumentation/.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-express-incorrect-instrumentation/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "node-express-incorrect-instrumentation",
+  "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": {
+    "@sentry/core": "latest || *",
+    "@sentry/node": "latest || *",
+    "@sentry/types": "latest || *",
+    "@trpc/server": "10.45.2",
+    "@trpc/client": "10.45.2",
+    "@types/express": "4.17.17",
+    "@types/node": "18.15.1",
+    "express": "4.19.2",
+    "typescript": "4.9.5",
+    "zod": "~3.22.4"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.44.1",
+    "@sentry-internal/test-utils": "link:../../../test-utils"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  }
+}

dev-packages/e2e-tests/test-applications/node-express-incorrect-instrumentation/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-express-incorrect-instrumentation/src/app.ts

@@ -0,0 +1,39 @@
+declare global {
+  namespace globalThis {
+    var transactionIds: string[];
+  }
+}
+
+import express from 'express';
+
+const app = express();
+const port = 3030;
+
+// import and init sentry last for missing instrumentation
+import * as Sentry from '@sentry/node';
+Sentry.init({
+  environment: 'qa', // dynamic sampling bias to keep transactions
+  dsn: process.env.E2E_TEST_DSN,
+  includeLocalVariables: true,
+  debug: !!process.env.DEBUG,
+  tunnel: `http://localhost:3031/`, // proxy server
+  tracesSampleRate: 1,
+});
+
+app.get('/test-exception/:id', function (req, _res) {
+  throw new Error(`This is an exception with id ${req.params.id}`);
+});
+
+Sentry.setupExpressErrorHandler(app);
+
+// @ts-ignore
+app.use(function onError(err, req, res, next) {
+  // 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(`Example app listening on port ${port}`);
+});

dev-packages/e2e-tests/test-applications/node-express-incorrect-instrumentation/start-event-proxy.mjs

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

dev-packages/e2e-tests/test-applications/node-express-incorrect-instrumentation/tests/instrumentation.test.ts

@@ -0,0 +1,20 @@
+import { expect, test } from '@playwright/test';
+import { waitForError } from '@sentry-internal/test-utils';
+
+test('Sends correct context when instrumentation was set up incorrectly', async ({ baseURL }) => {
+  const errorEventPromise = waitForError('node-express', 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.contexts?.missing_instrumentation).toEqual({
+    package: 'express',
+    'javascript.is_cjs': true,
+  });
+});

dev-packages/e2e-tests/test-applications/node-express-incorrect-instrumentation/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "types": ["node"],
+    "esModuleInterop": true,
+    "lib": ["es2018"],
+    "strict": true,
+    "outDir": "dist"
+  },
+  "include": ["src/**/*.ts"]
+}

packages/node/src/utils/createMissingInstrumentationContext.ts

@@ -0,0 +1,7 @@
+import type { MissingInstrumentationContext } from '@sentry/types';
+import { isCjs } from './commonjs';
+
+export const createMissingInstrumentationContext = (pkg: string): MissingInstrumentationContext => ({
+  package: pkg,
+  'javascript.is_cjs': isCjs(),
+});

packages/node/src/utils/ensureIsWrapped.ts

@@ -1,7 +1,8 @@
 import { isWrapped } from '@opentelemetry/core';
-import { hasTracingEnabled, isEnabled } from '@sentry/core';
+import { getGlobalScope, hasTracingEnabled, isEnabled } from '@sentry/core';
 import { consoleSandbox } from '@sentry/utils';
 import { isCjs } from './commonjs';
+import { createMissingInstrumentationContext } from './createMissingInstrumentationContext';
 
 /**
  * Checks and warns if a framework isn't wrapped by opentelemetry.
@@ -24,5 +25,7 @@ export function ensureIsWrapped(
         );
       }
     });
+
+    getGlobalScope().setContext('missing_instrumentation', createMissingInstrumentationContext(name));
   }
 }

packages/types/src/context.ts

@@ -119,3 +119,8 @@ export interface CloudResourceContext extends Record<string, unknown> {
 export interface ProfileContext extends Record<string, unknown> {
   profile_id: string;
 }
+
+export interface MissingInstrumentationContext extends Record<string, unknown> {
+  package: string;
+  ['javascript.is_cjs']?: boolean;
+}

packages/types/src/index.ts

@@ -18,6 +18,7 @@ export type {
   CultureContext,
   TraceContext,
   CloudResourceContext,
+  MissingInstrumentationContext,
 } from './context';
 export type { DataCategory } from './datacategory';
 export type { DsnComponents, DsnLike, DsnProtocol } from './dsn';