fix(tests): Fix node integration test linting and type errors (#5070)

This fixes a number of linting and type errors in our node integration tests.

Included changes:
- Fix eslint config so it's clear which tsconfig file applies to which code files
- Use ESM import for `path`.
- Create `TestAPIResponse` type.
- Remove redundant `await` on returned promise.
- Use `unknown` in place of `any`.

Author: lobsterkatie

packages/node-integration-tests/.eslintrc.js

@@ -4,7 +4,20 @@ module.exports = {
     jest: true,
   },
   extends: ['../../.eslintrc.js'],
-  parserOptions: {
-    sourceType: 'module',
-  },
+  overrides: [
+    {
+      files: ['utils/**/*.ts'],
+      parserOptions: {
+        project: ['tsconfig.json'],
+        sourceType: 'module',
+      },
+    },
+    {
+      files: ['suites/**/*.ts'],
+      parserOptions: {
+        project: ['tsconfig.test.json'],
+        sourceType: 'module',
+      },
+    },
+  ],
 };

packages/node-integration-tests/jest.config.js

@@ -1,7 +1,7 @@
 const baseConfig = require('../../jest/jest.config.js');
 
 module.exports = {
-  globalSetup: '<rootDir>/setup-tests.ts',
+  globalSetup: '<rootDir>/utils/setup-tests.ts',
   ...baseConfig,
   testMatch: ['**/test.ts'],
 };

packages/node-integration-tests/suites/express/sentry-trace/server.ts

@@ -6,6 +6,8 @@ import http from 'http';
 
 const app = express();
 
+export type TestAPIResponse = { test_data: { host: string; 'sentry-trace': string } };
+
 Sentry.init({
   dsn: 'https://public@dsn.ingest.sentry.io/1337',
   release: '1.0',

packages/node-integration-tests/suites/express/sentry-trace/trace-header-assign/test.ts

@@ -1,14 +1,15 @@
 import { TRACEPARENT_REGEXP } from '@sentry/utils';
+import * as path from 'path';
 
 import { getAPIResponse, runServer } from '../../../../utils/index';
-import path = require('path');
+import { TestAPIResponse } from '../server';
 
 test('Should assign `sentry-trace` header which sets parent trace id of an outgoing request.', async () => {
   const url = await runServer(__dirname, `${path.resolve(__dirname, '..')}/server.ts`);
 
-  const response = await getAPIResponse(new URL(`${url}/express`), {
+  const response = (await getAPIResponse(new URL(`${url}/express`), {
     'sentry-trace': '12312012123120121231201212312012-1121201211212012-0',
-  });
+  })) as TestAPIResponse;
 
   expect(response).toBeDefined();
   expect(response).toMatchObject({

packages/node-integration-tests/suites/express/sentry-trace/trace-header-out/test.ts

@@ -1,12 +1,13 @@
 import { TRACEPARENT_REGEXP } from '@sentry/utils';
+import * as path from 'path';
 
 import { getAPIResponse, runServer } from '../../../../utils/index';
-import path = require('path');
+import { TestAPIResponse } from '../server';
 
 test('should attach a `sentry-trace` header to an outgoing request.', async () => {
   const url = await runServer(__dirname, `${path.resolve(__dirname, '..')}/server.ts`);
 
-  const response = await getAPIResponse(new URL(`${url}/express`));
+  const response = (await getAPIResponse(new URL(`${url}/express`))) as TestAPIResponse;
 
   expect(response).toBeDefined();
   expect(response).toMatchObject({

packages/node-integration-tests/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "extends": "../../tsconfig.json",
 
-  "include": ["**/*.ts"],
+  "include": ["utils/**/*.ts"],
 
   "compilerOptions": {
     // package-specific options

packages/node-integration-tests/tsconfig.test.json

@@ -1,7 +1,7 @@
 {
   "extends": "./tsconfig.json",
 
-  "include": ["**/*.ts"],
+  "include": ["suites/**/*.ts"],
 
   "compilerOptions": {
     // should include all types from `./tsconfig.json` plus types for all test frameworks used

packages/node-integration-tests/utils/index.ts

@@ -103,8 +103,8 @@ export const getMultipleEnvelopeRequest = async (url: string, count: number): Pr
  * @param {Record<string, string>} [headers]
  * @return {*}  {Promise<any>}
  */
-export const getAPIResponse = async (url: URL, headers?: Record<string, string>): Promise<any> => {
-  return await new Promise(resolve => {
+export const getAPIResponse = async (url: URL, headers?: Record<string, string>): Promise<unknown> => {
+  return new Promise(resolve => {
     http.get(
       headers
         ? ({