test(node): All integration tests now use the new runner (#11341)

This PR converts the remaining tests to using the newer child process
runner.

Because the test scenarios are now completely isolated, Jest can be used
to run them rather than the custom script.

Author: timfish

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

@@ -21,13 +21,12 @@
     "fix": "eslint . --format stylish --fix",
     "type-check": "tsc",
     "pretest": "run-s --silent prisma:init",
-    "test": "ts-node ./utils/run-tests.ts",
-    "jest": "jest --config ./jest.config.js",
+    "test": "jest --config ./jest.config.js",
     "test:watch": "yarn test --watch"
   },
   "dependencies": {
     "@hapi/hapi": "^20.3.0",
-    "@nestjs/common": "^10.3.3",
+    "@nestjs/common": "^10.3.7",
     "@nestjs/core": "^10.3.3",
     "@nestjs/platform-express": "^10.3.3",
     "@prisma/client": "5.9.1",

dev-packages/node-integration-tests/suites/public-api/addBreadcrumb/empty-obj/scenario.ts

@@ -1,8 +1,10 @@
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
   release: '1.0',
+  transport: loggingTransport,
 });
 
 Sentry.addBreadcrumb({});

dev-packages/node-integration-tests/suites/public-api/addBreadcrumb/empty-obj/test.ts

@@ -1,12 +1,15 @@
-import { TestEnv, assertSentryEvent } from '../../../../utils';
+import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';
 
-test('should add an empty breadcrumb, when an empty object is given', async () => {
-  const env = await TestEnv.init(__dirname);
-  const envelope = await env.getEnvelopeRequest();
-
-  expect(envelope).toHaveLength(3);
+afterAll(() => {
+  cleanupChildProcesses();
+});
 
-  assertSentryEvent(envelope[2], {
-    message: 'test-empty-obj',
-  });
+test('should add an empty breadcrumb, when an empty object is given', done => {
+  createRunner(__dirname, 'scenario.ts')
+    .expect({
+      event: {
+        message: 'test-empty-obj',
+      },
+    })
+    .start(done);
 });

dev-packages/node-integration-tests/suites/public-api/addBreadcrumb/multiple_breadcrumbs/scenario.ts

@@ -1,8 +1,10 @@
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
   release: '1.0',
+  transport: loggingTransport,
 });
 
 Sentry.addBreadcrumb({

dev-packages/node-integration-tests/suites/public-api/addBreadcrumb/multiple_breadcrumbs/test.ts

@@ -1,20 +1,25 @@
-import { TestEnv, assertSentryEvent } from '../../../../utils';
+import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';
 
-test('should add multiple breadcrumbs', async () => {
-  const env = await TestEnv.init(__dirname);
-  const events = await env.getEnvelopeRequest();
+afterAll(() => {
+  cleanupChildProcesses();
+});
 
-  assertSentryEvent(events[2], {
-    message: 'test_multi_breadcrumbs',
-    breadcrumbs: [
-      {
-        category: 'foo',
-        message: 'bar',
-        level: 'fatal',
-      },
-      {
-        category: 'qux',
+test('should add multiple breadcrumbs', done => {
+  createRunner(__dirname, 'scenario.ts')
+    .expect({
+      event: {
+        message: 'test_multi_breadcrumbs',
+        breadcrumbs: [
+          {
+            category: 'foo',
+            message: 'bar',
+            level: 'fatal',
+          },
+          {
+            category: 'qux',
+          },
+        ],
       },
-    ],
-  });
+    })
+    .start(done);
 });

dev-packages/node-integration-tests/suites/public-api/addBreadcrumb/simple_breadcrumb/scenario.ts

@@ -1,8 +1,10 @@
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
   release: '1.0',
+  transport: loggingTransport,
 });
 
 Sentry.addBreadcrumb({

dev-packages/node-integration-tests/suites/public-api/addBreadcrumb/simple_breadcrumb/test.ts

@@ -1,17 +1,18 @@
-import { TestEnv, assertSentryEvent } from '../../../../utils';
+import { createRunner } from '../../../../utils/runner';
 
-test('should add a simple breadcrumb', async () => {
-  const env = await TestEnv.init(__dirname);
-  const event = await env.getEnvelopeRequest();
-
-  assertSentryEvent(event[2], {
-    message: 'test_simple',
-    breadcrumbs: [
-      {
-        category: 'foo',
-        message: 'bar',
-        level: 'fatal',
+test('should add a simple breadcrumb', done => {
+  createRunner(__dirname, 'scenario.ts')
+    .expect({
+      event: {
+        message: 'test_simple',
+        breadcrumbs: [
+          {
+            category: 'foo',
+            message: 'bar',
+            level: 'fatal',
+          },
+        ],
       },
-    ],
-  });
+    })
+    .start(done);
 });

dev-packages/node-integration-tests/suites/public-api/captureException/catched-error/scenario.ts

@@ -1,8 +1,10 @@
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
   release: '1.0',
+  transport: loggingTransport,
 });
 
 try {

dev-packages/node-integration-tests/suites/public-api/captureException/catched-error/test.ts

@@ -1,38 +1,43 @@
-import { TestEnv, assertSentryEvent } from '../../../../utils';
+import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';
 
-test('should work inside catch block', async () => {
-  const env = await TestEnv.init(__dirname);
-  const event = await env.getEnvelopeRequest();
+afterAll(() => {
+  cleanupChildProcesses();
+});
 
-  assertSentryEvent(event[2], {
-    exception: {
-      values: [
-        {
-          type: 'Error',
-          value: 'catched_error',
-          mechanism: {
-            type: 'generic',
-            handled: true,
-          },
-          stacktrace: {
-            frames: expect.arrayContaining([
-              expect.objectContaining({
-                context_line: "  throw new Error('catched_error');",
-                pre_context: [
-                  '',
-                  'Sentry.init({',
-                  "  dsn: 'https://[email protected]/1337',",
-                  "  release: '1.0',",
-                  '});',
-                  '',
-                  'try {',
-                ],
-                post_context: ['} catch (err) {', '  Sentry.captureException(err);', '}', ''],
-              }),
-            ]),
-          },
+test('should work inside catch block', done => {
+  createRunner(__dirname, 'scenario.ts')
+    .expect({
+      event: {
+        exception: {
+          values: [
+            {
+              type: 'Error',
+              value: 'catched_error',
+              mechanism: {
+                type: 'generic',
+                handled: true,
+              },
+              stacktrace: {
+                frames: expect.arrayContaining([
+                  expect.objectContaining({
+                    context_line: "  throw new Error('catched_error');",
+                    pre_context: [
+                      'Sentry.init({',
+                      "  dsn: 'https://[email protected]/1337',",
+                      "  release: '1.0',",
+                      '  transport: loggingTransport,',
+                      '});',
+                      '',
+                      'try {',
+                    ],
+                    post_context: ['} catch (err) {', '  Sentry.captureException(err);', '}', ''],
+                  }),
+                ]),
+              },
+            },
+          ],
         },
-      ],
-    },
-  });
+      },
+    })
+    .start(done);
 });

dev-packages/node-integration-tests/suites/public-api/captureException/empty-obj/scenario.ts

@@ -1,8 +1,10 @@
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
   release: '1.0',
+  transport: loggingTransport,
 });
 
 Sentry.captureException({});

dev-packages/node-integration-tests/suites/public-api/captureException/empty-obj/test.ts

@@ -1,21 +1,26 @@
-import { TestEnv, assertSentryEvent } from '../../../../utils';
+import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';
 
-test('should capture an empty object', async () => {
-  const env = await TestEnv.init(__dirname);
-  const event = await env.getEnvelopeRequest();
+afterAll(() => {
+  cleanupChildProcesses();
+});
 
-  assertSentryEvent(event[2], {
-    exception: {
-      values: [
-        {
-          type: 'Error',
-          value: 'Object captured as exception with keys: [object has no keys]',
-          mechanism: {
-            type: 'generic',
-            handled: true,
-          },
+test('should capture an empty object', done => {
+  createRunner(__dirname, 'scenario.ts')
+    .expect({
+      event: {
+        exception: {
+          values: [
+            {
+              type: 'Error',
+              value: 'Object captured as exception with keys: [object has no keys]',
+              mechanism: {
+                type: 'generic',
+                handled: true,
+              },
+            },
+          ],
         },
-      ],
-    },
-  });
+      },
+    })
+    .start(done);
 });

dev-packages/node-integration-tests/suites/public-api/captureException/simple-error/scenario.ts

@@ -1,8 +1,10 @@
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
   release: '1.0',
+  transport: loggingTransport,
 });
 
 Sentry.captureException(new Error('test_simple_error'));

dev-packages/node-integration-tests/suites/public-api/captureException/simple-error/test.ts

@@ -1,24 +1,29 @@
-import { TestEnv, assertSentryEvent } from '../../../../utils';
+import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';
 
-test('should capture a simple error with message', async () => {
-  const env = await TestEnv.init(__dirname);
-  const envelope = await env.getEnvelopeRequest();
+afterAll(() => {
+  cleanupChildProcesses();
+});
 
-  assertSentryEvent(envelope[2], {
-    exception: {
-      values: [
-        {
-          type: 'Error',
-          value: 'test_simple_error',
-          mechanism: {
-            type: 'generic',
-            handled: true,
-          },
-          stacktrace: {
-            frames: expect.any(Array),
-          },
+test('should capture a simple error with message', done => {
+  createRunner(__dirname, 'scenario.ts')
+    .expect({
+      event: {
+        exception: {
+          values: [
+            {
+              type: 'Error',
+              value: 'test_simple_error',
+              mechanism: {
+                type: 'generic',
+                handled: true,
+              },
+              stacktrace: {
+                frames: expect.any(Array),
+              },
+            },
+          ],
         },
-      ],
-    },
-  });
+      },
+    })
+    .start(done);
 });

dev-packages/node-integration-tests/suites/public-api/captureMessage/parameterized_message/scenario.ts

@@ -1,8 +1,10 @@
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
   release: '1.0',
+  transport: loggingTransport,
 });
 
 const x = 'first';

dev-packages/node-integration-tests/suites/public-api/captureMessage/parameterized_message/test.ts

@@ -1,13 +1,18 @@
-import { TestEnv, assertSentryEvent } from '../../../../utils';
+import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';
 
-test('should capture a parameterized representation of the message', async () => {
-  const env = await TestEnv.init(__dirname);
-  const event = await env.getEnvelopeRequest();
+afterAll(() => {
+  cleanupChildProcesses();
+});
 
-  assertSentryEvent(event[2], {
-    logentry: {
-      message: 'This is a log statement with %s and %s params',
-      params: ['first', 'second'],
-    },
-  });
+test('should capture a parameterized representation of the message', done => {
+  createRunner(__dirname, 'scenario.ts')
+    .expect({
+      event: {
+        logentry: {
+          message: 'This is a log statement with %s and %s params',
+          params: ['first', 'second'],
+        },
+      },
+    })
+    .start(done);
 });