feat(node): Populate event.contexts for Node.js (#5512)

timfish · web-flow · commit e8c78c48ef01 · 2022-08-29T19:15:28.000Z
### Problem Statement Expand default context set by the Node SDK: https://develop.sentry.dev/sdk/event-payloads/contexts/#device-context ### `device` - `boot_time` - `arch` - `memory_size` - `free_memory` - `processor_count` - `cpu_description` - `processor_frequency` ### `os` - `version` - `build` - `kernel_version` ### `app` - `app_start_time` - `app_memory` ### `culture` - `locale` - `timezone`
diff --git a/packages/node-integration-tests/package.json b/packages/node-integration-tests/package.json
@@ -12,6 +12,9 @@
     "lint": "run-s lint:prettier lint:eslint",
     "lint:eslint": "eslint . --cache --cache-location '../../eslintcache/' --format stylish",
     "lint:prettier": "prettier --check \"{suites,utils}/**/*.ts\"",
+    "fix": "run-s fix:eslint fix:prettier",
+    "fix:eslint": "eslint . --format stylish --fix",
+    "fix:prettier": "prettier --write \"{suites,utils}/**/*.ts\"",
     "type-check": "tsc",
     "pretest": "run-s --silent prisma:init",
     "test": "jest --runInBand --forceExit",
diff --git a/packages/node-integration-tests/suites/public-api/addBreadcrumb/multiple_breadcrumbs/test.ts b/packages/node-integration-tests/suites/public-api/addBreadcrumb/multiple_breadcrumbs/test.ts
@@ -1,10 +1,10 @@
-import { assertSentryEvent, getMultipleEnvelopeRequest, runServer } from '../../../../utils';
+import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../utils';
 
 test('should add multiple breadcrumbs', async () => {
   const config = await runServer(__dirname);
-  const events = await getMultipleEnvelopeRequest(config, { count: 1 });
+  const events = await getEnvelopeRequest(config);
 
-  assertSentryEvent(events[0][2], {
+  assertSentryEvent(events[2], {
     message: 'test_multi_breadcrumbs',
     breadcrumbs: [
       {
diff --git a/packages/node-integration-tests/suites/public-api/captureException/catched-error/test.ts b/packages/node-integration-tests/suites/public-api/captureException/catched-error/test.ts
@@ -1,10 +1,10 @@
-import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../utils';
+import { assertSentryEvent, getMultipleEnvelopeRequest, runServer } from '../../../../utils';
 
 test('should work inside catch block', async () => {
   const config = await runServer(__dirname);
-  const event = await getEnvelopeRequest(config);
+  const events = await getMultipleEnvelopeRequest(config, { count: 1 });
 
-  assertSentryEvent(event[2], {
+  assertSentryEvent(events[0][2], {
     exception: {
       values: [
         {
diff --git a/packages/node-integration-tests/suites/public-api/captureException/empty-obj/test.ts b/packages/node-integration-tests/suites/public-api/captureException/empty-obj/test.ts
@@ -2,9 +2,9 @@ import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../ut
 
 test('should capture an empty object', async () => {
   const config = await runServer(__dirname);
-  const event = await getEnvelopeRequest(config);
+  const events = await getEnvelopeRequest(config);
 
-  assertSentryEvent(event[2], {
+  assertSentryEvent(events[2], {
     exception: {
       values: [
         {
diff --git a/packages/node-integration-tests/suites/public-api/captureException/simple-error/test.ts b/packages/node-integration-tests/suites/public-api/captureException/simple-error/test.ts
@@ -2,9 +2,9 @@ import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../ut
 
 test('should capture a simple error with message', async () => {
   const config = await runServer(__dirname);
-  const envelope = await getEnvelopeRequest(config);
+  const events = await getEnvelopeRequest(config);
 
-  assertSentryEvent(envelope[2], {
+  assertSentryEvent(events[2], {
     exception: {
       values: [
         {
diff --git a/packages/node-integration-tests/suites/public-api/captureMessage/simple_message/test.ts b/packages/node-integration-tests/suites/public-api/captureMessage/simple_message/test.ts
@@ -2,9 +2,9 @@ import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../ut
 
 test('should capture a simple message string', async () => {
   const config = await runServer(__dirname);
-  const event = await getEnvelopeRequest(config);
+  const events = await getEnvelopeRequest(config);
 
-  assertSentryEvent(event[2], {
+  assertSentryEvent(events[2], {
     message: 'Message',
     level: 'info',
   });
diff --git a/packages/node-integration-tests/suites/public-api/setContext/multiple-contexts/test.ts b/packages/node-integration-tests/suites/public-api/setContext/multiple-contexts/test.ts
@@ -4,9 +4,9 @@ import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../ut
 
 test('should record multiple contexts', async () => {
   const config = await runServer(__dirname);
-  const envelope = await getEnvelopeRequest(config, { count: 1 });
+  const events = await getEnvelopeRequest(config);
 
-  assertSentryEvent(envelope[2], {
+  assertSentryEvent(events[2], {
     message: 'multiple_contexts',
     contexts: {
       context_1: {
@@ -17,5 +17,5 @@ test('should record multiple contexts', async () => {
     },
   });
 
-  expect((envelope[2] as Event).contexts?.context_3).not.toBeDefined();
+  expect((events[0] as Event).contexts?.context_3).not.toBeDefined();
 });
diff --git a/packages/node-integration-tests/suites/public-api/setContext/non-serializable-context/test.ts b/packages/node-integration-tests/suites/public-api/setContext/non-serializable-context/test.ts
@@ -4,12 +4,12 @@ import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../ut
 
 test('should normalize non-serializable context', async () => {
   const config = await runServer(__dirname);
-  const event = await getEnvelopeRequest(config);
+  const events = await getEnvelopeRequest(config);
 
-  assertSentryEvent(event[2], {
+  assertSentryEvent(events[2], {
     message: 'non_serializable',
     contexts: {},
   });
 
-  expect((event as Event).contexts?.context_3).not.toBeDefined();
+  expect((events[0] as Event).contexts?.context_3).not.toBeDefined();
 });
diff --git a/packages/node-integration-tests/suites/public-api/setContext/simple-context/test.ts b/packages/node-integration-tests/suites/public-api/setContext/simple-context/test.ts
@@ -1,12 +1,12 @@
 import { Event } from '@sentry/node';
 
-import { assertSentryEvent, getMultipleEnvelopeRequest, runServer } from '../../../../utils';
+import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../utils';
 
 test('should set a simple context', async () => {
   const config = await runServer(__dirname);
-  const envelopes = await getMultipleEnvelopeRequest(config, { count: 1 });
+  const envelopes = await getEnvelopeRequest(config);
 
-  assertSentryEvent(envelopes[0][2], {
+  assertSentryEvent(envelopes[2], {
     message: 'simple_context_object',
     contexts: {
       foo: {
@@ -15,5 +15,5 @@ test('should set a simple context', async () => {
     },
   });
 
-  expect((envelopes[0][2] as Event).contexts?.context_3).not.toBeDefined();
+  expect((envelopes[2] as Event).contexts?.context_3).not.toBeDefined();
 });
diff --git a/packages/node-integration-tests/suites/public-api/setExtra/multiple-extras/test.ts b/packages/node-integration-tests/suites/public-api/setExtra/multiple-extras/test.ts
@@ -2,9 +2,9 @@ import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../ut
 
 test('should record multiple extras of different types', async () => {
   const config = await runServer(__dirname);
-  const event = await getEnvelopeRequest(config);
+  const events = await getEnvelopeRequest(config);
 
-  assertSentryEvent(event[2], {
+  assertSentryEvent(events[2], {
     message: 'multiple_extras',
     extra: {
       extra_1: { foo: 'bar', baz: { qux: 'quux' } },
diff --git a/packages/node-integration-tests/suites/public-api/setExtra/non-serializable-extra/test.ts b/packages/node-integration-tests/suites/public-api/setExtra/non-serializable-extra/test.ts
@@ -2,9 +2,9 @@ import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../ut
 
 test('should normalize non-serializable extra', async () => {
   const config = await runServer(__dirname);
-  const event = await getEnvelopeRequest(config);
+  const events = await getEnvelopeRequest(config);
 
-  assertSentryEvent(event[2], {
+  assertSentryEvent(events[2], {
     message: 'non_serializable',
     extra: {},
   });
diff --git a/packages/node-integration-tests/suites/public-api/setExtra/simple-extra/test.ts b/packages/node-integration-tests/suites/public-api/setExtra/simple-extra/test.ts
@@ -2,9 +2,9 @@ import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../ut
 
 test('should set a simple extra', async () => {
   const config = await runServer(__dirname);
-  const event = await getEnvelopeRequest(config);
+  const events = await getEnvelopeRequest(config);
 
-  assertSentryEvent(event[2], {
+  assertSentryEvent(events[2], {
     message: 'simple_extra',
     extra: {
       foo: {
diff --git a/packages/node-integration-tests/suites/public-api/setExtras/consecutive-calls/test.ts b/packages/node-integration-tests/suites/public-api/setExtras/consecutive-calls/test.ts
@@ -1,10 +1,10 @@
-import { assertSentryEvent, getMultipleEnvelopeRequest, runServer } from '../../../../utils';
+import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../utils';
 
 test('should set extras from multiple consecutive calls', async () => {
   const config = await runServer(__dirname);
-  const envelopes = await getMultipleEnvelopeRequest(config, { count: 1 });
+  const envelopes = await getEnvelopeRequest(config);
 
-  assertSentryEvent(envelopes[0][2], {
+  assertSentryEvent(envelopes[2], {
     message: 'consecutive_calls',
     extra: { extra: [], Infinity: 2, null: 0, obj: { foo: ['bar', 'baz', 1] } },
   });
diff --git a/packages/node-integration-tests/suites/public-api/setExtras/multiple-extras/test.ts b/packages/node-integration-tests/suites/public-api/setExtras/multiple-extras/test.ts
@@ -1,10 +1,10 @@
-import { assertSentryEvent, getMultipleEnvelopeRequest, runServer } from '../../../../utils';
+import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../utils';
 
 test('should record an extras object', async () => {
   const config = await runServer(__dirname);
-  const events = await getMultipleEnvelopeRequest(config, { count: 1 });
+  const events = await getEnvelopeRequest(config);
 
-  assertSentryEvent(events[0][2], {
+  assertSentryEvent(events[2], {
     message: 'multiple_extras',
     extra: {
       extra_1: [1, ['foo'], 'bar'],
diff --git a/packages/node-integration-tests/suites/public-api/setTag/with-primitives/test.ts b/packages/node-integration-tests/suites/public-api/setTag/with-primitives/test.ts
@@ -2,9 +2,9 @@ import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../ut
 
 test('should set primitive tags', async () => {
   const config = await runServer(__dirname);
-  const event = await getEnvelopeRequest(config);
+  const events = await getEnvelopeRequest(config);
 
-  assertSentryEvent(event[2], {
+  assertSentryEvent(events[2], {
     message: 'primitive_tags',
     tags: {
       tag_1: 'foo',
diff --git a/packages/node-integration-tests/suites/public-api/setTags/with-primitives/test.ts b/packages/node-integration-tests/suites/public-api/setTags/with-primitives/test.ts
@@ -2,9 +2,9 @@ import { assertSentryEvent, getEnvelopeRequest, runServer } from '../../../../ut
 
 test('should set primitive tags', async () => {
   const config = await runServer(__dirname);
-  const event = await getEnvelopeRequest(config);
+  const events = await getEnvelopeRequest(config);
 
-  assertSentryEvent(event[2], {
+  assertSentryEvent(events[2], {
     message: 'primitive_tags',
     tags: {
       tag_1: 'foo',
diff --git a/packages/node-integration-tests/suites/public-api/setUser/unset_user/test.ts b/packages/node-integration-tests/suites/public-api/setUser/unset_user/test.ts
@@ -10,7 +10,7 @@ test('should unset user', async () => {
     message: 'no_user',
   });
 
-  expect((events[0][2] as Event).user).not.toBeDefined();
+  expect((events[0] as Event).user).not.toBeDefined();
 
   assertSentryEvent(events[1][2], {
     message: 'user',
@@ -25,5 +25,5 @@ test('should unset user', async () => {
     message: 'unset_user',
   });
 
-  expect((events[2][2] as Event).user).not.toBeDefined();
+  expect((events[2] as Event).user).not.toBeDefined();
 });
diff --git a/packages/node-integration-tests/suites/public-api/withScope/nested-scopes/test.ts b/packages/node-integration-tests/suites/public-api/withScope/nested-scopes/test.ts
@@ -31,7 +31,7 @@ test('should allow nested scoping', async () => {
     },
   });
 
-  expect((events[2][2] as Event).user).toBeUndefined();
+  expect((events[2] as Event).user).toBeUndefined();
 
   assertSentryEvent(events[3][2], {
     message: 'outer_after',
diff --git a/packages/node-integration-tests/suites/tracing/auto-instrument/mongodb/test.ts b/packages/node-integration-tests/suites/tracing/auto-instrument/mongodb/test.ts
@@ -14,7 +14,9 @@ conditionalTest({ min: 12 })('MongoDB Test', () => {
   }, 10000);
 
   afterAll(async () => {
-    await mongoServer.stop();
+    if (mongoServer) {
+      await mongoServer.stop();
+    }
   });
 
   test('should auto-instrument `mongodb` package.', async () => {
diff --git a/packages/node/src/integrations/context.ts b/packages/node/src/integrations/context.ts
diff --git a/packages/node/src/integrations/index.ts b/packages/node/src/integrations/index.ts
diff --git a/packages/node/src/sdk.ts b/packages/node/src/sdk.ts
diff --git a/packages/types/src/context.ts b/packages/types/src/context.ts
diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
