chore(replay): Align and clean up tsconfig.jsons (#6308)

Align and clean up the `tsconfig.json` files in the replay package. In preparations to applying the monorepo's rollup and sucrase configs, we first align the tsconfigs. 

* Decouple `tsconfig.core.json` and `tsconfig.worker.json`. For now we can first focus on the core build and later on revisit the worker build config.
* Remove nesting of tsconfigs
* Move all tsconfigs to the package-level. Eventually, the config directory will be removed (after aligning the rollup configs)
* Extend the core tsconfig from the monorepo's base tsconfig 
* Remove thereby redundant compiler options and entries
* Tmp-fixe type errors after using the monorepo's base config
* Modify Jest configs to work with the monorepo's tsconfig layout (`tsconfig.test.json`)
* **Imortant**: This changes the target from es5 to es6. I think this is fine as all Sentry JS SDKs are transpiled to ES6 by default. We can discuss providing ES5 CDN bundles like we do for our other CDN bundles.

Author: Lms24

packages/replay/.eslintrc.js

@@ -25,7 +25,7 @@ module.exports = {
       files: ['worker/**/*.ts'],
       parserOptions: {
         // TODO: figure out if we need a worker-specific tsconfig
-        project: ['config/tsconfig.worker.json'],
+        project: ['tsconfig.worker.json'],
       },
     },
     {
@@ -66,18 +66,17 @@ module.exports = {
       },
     },
     {
-      files: ['jest.setup.ts'],
+      files: ['jest.setup.ts', 'jest.config.ts'],
+      parserOptions: {
+        project: ['tsconfig.test.json'],
+      },
       rules: {
         'no-console': 'off',
       },
     },
     {
       files: ['test/**/*.ts'],
-      parserOptions: {
-        // TODO: remove this parserOptions object after we added a tsconfig.test.json
-        // Replay previously didn't have a tsconfig.test.json, so for now we just the regular one.
-        project: ['tsconfig.json'],
-      },
+
       rules: {
         // TODO: decide if we want to keep our '@test' import paths
         'import/no-unresolved': 'off',

packages/replay/config/rollup.config.core.ts

@@ -22,7 +22,7 @@ const config = defineConfig({
   external: [...Object.keys(pkg.dependencies || {}), ...Object.keys(pkg.peerDependencies || {})],
   plugins: [
     typescript({
-      tsconfig: IS_PRODUCTION ? './config/tsconfig.core.json' : './tsconfig.json',
+      tsconfig: './tsconfig.json',
     }),
     replace({
       // __SENTRY_DEBUG__ should be save to replace in any case, so no checks for assignments necessary

packages/replay/config/rollup.config.worker.ts

@@ -12,7 +12,7 @@ const config = defineConfig({
     format: 'esm',
   },
   plugins: [
-    typescript({ tsconfig: './config/tsconfig.worker.json' }),
+    typescript({ tsconfig: './tsconfig.worker.json' }),
     resolve(),
     terser({
       mangle: {

packages/replay/config/tsconfig.core.json

@@ -1,23 +1,24 @@
 import type { Config } from '@jest/types';
 import { pathsToModuleNameMapper } from 'ts-jest';
+import { jsWithTs as jsWithTsPreset } from 'ts-jest/presets';
 
-import { compilerOptions } from './tsconfig.json';
+import { compilerOptions } from './tsconfig.test.json';
 
 export default async (): Promise<Config.InitialOptions> => {
   return {
+    ...jsWithTsPreset,
     verbose: true,
-    preset: 'ts-jest/presets/js-with-ts', // needed when import worker.js
+    globals: {
+      'ts-jest': {
+        tsconfig: '<rootDir>/tsconfig.test.json',
+      },
+      __DEBUG_BUILD__: true,
+    },
     moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, {
       prefix: '<rootDir>/',
     }),
     setupFilesAfterEnv: ['./jest.setup.ts'],
     testEnvironment: 'jsdom',
     testMatch: ['<rootDir>/test/**/*(*.)@(spec|test).ts'],
-    globals: {
-      'ts-jest': {
-        tsconfig: '<rootDir>/tsconfig.json',
-      },
-      __DEBUG_BUILD__: true,
-    },
   };
 };

packages/replay/config/tsconfig.worker.json

@@ -39,10 +39,14 @@ interface MemoryInfo {
 }
 
 // Map entryType -> function to normalize data for event
+// @ts-ignore TODO: entry type does not fit the create* functions entry type
 const ENTRY_TYPES: Record<string, (entry: AllPerformanceEntry) => null | ReplayPerformanceEntry> = {
+  // @ts-ignore TODO: entry type does not fit the create* functions entry type
   resource: createResourceEntry,
   paint: createPaintEntry,
+  // @ts-ignore TODO: entry type does not fit the create* functions entry type
   navigation: createNavigationEntry,
+  // @ts-ignore TODO: entry type does not fit the create* functions entry type
   ['largest-contentful-paint']: createLargestContentfulPaint,
 };
 

packages/replay/jest.config.ts

@@ -66,7 +66,7 @@ export class Replay implements Integration {
    */
   public name: string = Replay.id;
 
-  public eventBuffer: IEventBuffer | null;
+  public eventBuffer: IEventBuffer | null = null;
 
   /**
    * List of PerformanceEntry from PerformanceObserver

packages/replay/src/createPerformanceEntry.ts

@@ -5,7 +5,7 @@ import { isInternal } from './isInternal';
 /**
  * Captures exceptions to Sentry only when it occurs on sentry.io
  */
-export function captureInternalException(err: Error): string | undefined {
+export function captureInternalException(err: Error): void {
   if (!isInternal()) {
     return;
   }

packages/replay/src/index.ts

@@ -0,0 +1,8 @@
+// TODO Once https://github.com/microsoft/TypeScript/issues/33094 is done (if it ever is), this file can disappear, as
+// it's purely a placeholder to satisfy VSCode.
+
+{
+  "extends": "../tsconfig.test.json",
+
+  "include": ["./**/*"]
+}

packages/replay/src/session/types.ts

@@ -1,7 +1,7 @@
 import { isSampled } from '../../../src/util/isSampled';
 
 // Note Math.random generates a value from 0 (inclusive) to <1 (1 exclusive).
-const cases = [
+const cases: [number, number, boolean][] = [
   [1.0, 0.9999, true],
   [1.0, 0.0, true],
   [1.0, 0.5, true],

packages/replay/src/util/captureInternalException.ts

@@ -1,12 +1,25 @@
 {
-  "extends": "./config/tsconfig.core.json",
+  "extends": "../../tsconfig.json",
   "compilerOptions": {
     "paths": {
       "@test": ["./test"],
       "@test/*": ["./test/*"]
     },
-    "types": ["node", "jest"]
+    "baseUrl": ".",
+    "rootDir": ".",
+    "types": ["node", "jest"],
+    "module": "esnext",
+    "noImplicitAny": true,
+    "noEmitOnError": false,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "allowJs": true,
+    "declaration": true,
+    "declarationMap": true,
+    "declarationDir": "./types",
+    "strictNullChecks": true,
+    "outDir": "./build/npm/dist"
   },
-  "include": ["src/**/*.ts", "test/**/*.ts", "rollup.config.ts", "jest.config.ts", "jest.setup.ts"],
+  "include": ["src/**/*.ts"],
   "exclude": ["node_modules"]
 }

packages/replay/src/worker/worker.js

@@ -0,0 +1,20 @@
+{
+  "extends": "./tsconfig.json",
+
+  "include": ["test/**/*.ts", "jest.config.ts", "jest.setup.ts"],
+
+  "compilerOptions": {
+    "paths": {
+      "@test": ["./test"],
+      "@test/*": ["./test/*"]
+    },
+    "baseUrl": ".",
+    "rootDir": ".",
+    "types": ["node", "jest"],
+    "noImplicitAny": false,
+    "noImplicitThis": false,
+    "strictPropertyInitialization": false,
+    "resolveJsonModule": true,
+    "allowJs": true
+  }
+}

packages/replay/test/unit/tsconfig.json

@@ -7,7 +7,13 @@
     "esModuleInterop": true,
     "resolveJsonModule": true,
     "skipLibCheck": true,
-    "target": "es5"
+    "target": "es6",
+    "declaration": false,
+    "lib": ["webworker", "scripthost"],
+    "baseUrl": "worker/src",
+    "rootDir": "worker/src",
+    "outDir": "src/worker"
   },
+  "include": ["worker/src/worker.ts", "src/types.ts"],
   "exclude": ["node_modules"]
 }

packages/replay/test/unit/util/isSampled.test.ts

@@ -9,7 +9,7 @@ export class Compressor {
   /**
    * Number of added events
    */
-  public added: number;
+  public added: number = 0;
 
   public constructor() {
     this.init();