build: Update typescript from 3.8.3 to 4.9.5 (#8255)

This updates the TS version we use from 3.8.3 to 4.9.5. This allows us to use newer TS features, as well as as improves compatibility with newer @types/xxx packages that use newer features, which leads to issues when transitive dependencies are used etc. We use [downlevel-dts](https://www.npmjs.com/package/downlevel-dts) to generate a 3.8 compatible types output _in addition_, so this should be fully backwards compatible. TS provides a built-in way to tell it to use a certain types output for a certain version, so this should work with no breaking change. The main changes necessary here are small tweaks to types which are required in 4.9.x.
getsentry · Jun 28, 2023 · c89c54a · c89c54a
1 parent da295ff
commit c89c54a
Show file tree

Hide file tree

Showing 77 changed files with 271 additions and 138 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -655,7 +655,9 @@ jobs:
           yarn test:package
 
   job_node_integration_tests:
-    name: Node (${{ matrix.node }}) Integration Tests
+    name:
+      Node (${{ matrix.node }})${{ (matrix.typescript && format(' (TS {0})', matrix.typescript)) || '' }} Integration
+      Tests
     needs: [job_get_metadata, job_build]
     if: needs.job_get_metadata.outputs.changed_node == 'true' || github.event_name != 'pull_request'
     runs-on: ubuntu-20.04
@@ -664,6 +666,12 @@ jobs:
       fail-fast: false
       matrix:
         node: [10, 12, 14, 16, 18, 20]
+        typescript:
+          - false
+        include:
+          # Only check typescript for latest version (to streamline CI)
+          - node: 20
+            typescript: '3.8'
     steps:
       - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }})
         uses: actions/checkout@v3
@@ -677,6 +685,11 @@ jobs:
         uses: ./.github/actions/restore-cache
         env:
           DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }}
+
+      - name: Overwrite typescript version
+        if: matrix.typescript
+        run: yarn add --dev --ignore-workspace-root-check typescript@${{ matrix.typescript }}
+
       - name: Run integration tests
         env:
           NODE_VERSION: ${{ matrix.node }}
@@ -717,7 +730,7 @@ jobs:
           yarn test:integration:ci
 
   job_e2e_tests:
-    name: E2E Tests (Shard ${{ matrix.shard }})
+    name: E2E (Shard ${{ matrix.shard }}) Tests
     # We only run E2E tests for non-fork PRs because the E2E tests require secrets to work and they can't be accessed from forks
     # Dependabot PRs sadly also don't have access to secrets, so we skip them as well
     if:
@@ -730,6 +743,7 @@ jobs:
       fail-fast: false
       matrix:
         shard: [1, 2, 3]
+
     steps:
       - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }})
         uses: actions/checkout@v3
@@ -746,6 +760,7 @@ jobs:
         uses: ./.github/actions/restore-cache
         env:
           DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }}
+
       - name: Get node version
         id: versions
         run: |

diff --git a/nx.json b/nx.json
@@ -64,7 +64,9 @@
       ],
       "outputs": [
         "{projectRoot}/build/types",
-        "{projectRoot}/build/npm/types"
+        "{projectRoot}/build/types-ts3.8",
+        "{projectRoot}/build/npm/types",
+        "{projectRoot}/build/npm/types-ts3.8"
       ]
     },
     "lint:eslint": {

diff --git a/package.json b/package.json
@@ -90,6 +90,7 @@
     "chai": "^4.1.2",
     "codecov": "^3.6.5",
     "deepmerge": "^4.2.2",
+    "downlevel-dts": "~0.11.0",
     "es-check": "7.1.0",
     "eslint": "7.32.0",
     "jest": "^27.5.1",
@@ -114,9 +115,9 @@
     "size-limit": "^4.5.5",
     "ts-jest": "^27.1.4",
     "ts-node": "10.9.1",
-    "tslib": "^2.3.1",
+    "tslib": "2.4.1",
     "typedoc": "^0.18.0",
-    "typescript": "3.8.3",
+    "typescript": "4.9.5",
     "vitest": "^0.29.2",
     "yalc": "^1.0.0-pre.53"
   },

diff --git a/packages/angular-ivy/package.json b/packages/angular-ivy/package.json
@@ -24,7 +24,7 @@
     "@sentry/browser": "7.56.0",
     "@sentry/types": "7.56.0",
     "@sentry/utils": "7.56.0",
-    "tslib": "^2.3.0"
+    "tslib": "^2.4.1"
   },
   "devDependencies": {
     "@angular-devkit/build-angular": "~12.2.18",
@@ -37,7 +37,6 @@
     "@angular/platform-browser-dynamic": "~12.2.0",
     "@angular/router": "~12.2.0",
     "ng-packagr": "^12.1.1",
-    "typescript": "~4.3.5",
     "zone.js": "~0.11.4"
   },
   "scripts": {

diff --git a/packages/angular/package.json b/packages/angular/package.json
@@ -24,7 +24,7 @@
     "@sentry/browser": "7.56.0",
     "@sentry/types": "7.56.0",
     "@sentry/utils": "7.56.0",
-    "tslib": "^2.0.0"
+    "tslib": "^2.4.1"
   },
   "devDependencies": {
     "@angular-devkit/build-angular": "~0.1002.4",
@@ -38,7 +38,7 @@
     "@angular/router": "~10.2.5",
     "ng-packagr": "^10.1.0",
     "rxjs": "6.5.5",
-    "typescript": "~4.0.2",
+    "typescript": "4.0.2",
     "zone.js": "^0.11.8"
   },
   "scripts": {

diff --git a/packages/angular/src/errorhandler.ts b/packages/angular/src/errorhandler.ts
@@ -2,7 +2,7 @@ import { HttpErrorResponse } from '@angular/common/http';
 import type { ErrorHandler as AngularErrorHandler } from '@angular/core';
 import { Inject, Injectable } from '@angular/core';
 import * as Sentry from '@sentry/browser';
-import { captureException } from '@sentry/browser';
+import type { Event, Scope } from '@sentry/types';
 import { addExceptionMechanism, isString } from '@sentry/utils';
 
 import { runOutsideAngular } from './zone';
@@ -101,7 +101,7 @@ class SentryErrorHandler implements AngularErrorHandler {
 
     // Capture handled exception and send it to Sentry.
     const eventId = runOutsideAngular(() =>
-      captureException(extractedError, scope => {
+      Sentry.captureException(extractedError, (scope: Scope) => {
         scope.addEventProcessor(event => {
           addExceptionMechanism(event, {
             type: 'angular',
@@ -126,7 +126,7 @@ class SentryErrorHandler implements AngularErrorHandler {
       const client = Sentry.getCurrentHub().getClient();
 
       if (client && client.on && !this._registeredAfterSendEventHandler) {
-        client.on('afterSendEvent', event => {
+        client.on('afterSendEvent', (event: Event) => {
           if (!event.type) {
             Sentry.showReportDialog({ ...this._options.dialogOptions, eventId: event.event_id });
           }

diff --git a/packages/angular/test/errorhandler.test.ts b/packages/angular/test/errorhandler.test.ts
@@ -57,7 +57,7 @@ describe('SentryErrorHandler', () => {
   describe('handleError method', () => {
     it('handleError method assigns the correct mechanism', () => {
       const addEventProcessorSpy = jest.spyOn(FakeScope, 'addEventProcessor').mockImplementationOnce(callback => {
-        void callback({}, { event_id: 'fake-event-id' });
+        void (callback as (event: any, hint: any) => void)({}, { event_id: 'fake-event-id' });
         return FakeScope;
       });
 

diff --git a/packages/browser-integration-tests/package.json b/packages/browser-integration-tests/package.json
@@ -53,7 +53,6 @@
     "html-webpack-plugin": "^5.5.0",
     "pako": "^2.1.0",
     "playwright": "^1.31.1",
-    "typescript": "^4.5.2",
     "webpack": "^5.52.0"
   },
   "devDependencies": {

diff --git a/packages/browser/package.json b/packages/browser/package.json
@@ -12,6 +12,9 @@
   "main": "build/npm/cjs/index.js",
   "module": "build/npm/esm/index.js",
   "types": "build/npm/types/index.d.ts",
+  "typesVersions": {
+    "<4.9": { "build/npm/types/index.d.ts": ["build/npm/types-ts3.8/index.d.ts"] }
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -21,7 +24,7 @@
     "@sentry/replay": "7.56.0",
     "@sentry/types": "7.56.0",
     "@sentry/utils": "7.56.0",
-    "tslib": "^1.9.3"
+    "tslib": "^2.4.1 || ^1.9.3"
   },
   "devDependencies": {
     "@sentry-internal/integration-shims": "7.56.0",
@@ -53,7 +56,9 @@
     "build:bundle:es5": "JS_VERSION=es5 rollup -c rollup.bundle.config.js",
     "build:bundle:es6": "JS_VERSION=es6 rollup -c rollup.bundle.config.js",
     "build:transpile": "rollup -c rollup.npm.config.js",
-    "build:types": "tsc -p tsconfig.types.json",
+    "build:types": "run-s build:types:core build:types:downlevel",
+    "build:types:core": "tsc -p tsconfig.types.json",
+    "build:types:downlevel": "yarn downlevel-dts build/npm/types build/npm/types-ts3.8 --to ts3.8",
     "build:watch": "run-p build:transpile:watch build:bundle:watch build:types:watch",
     "build:dev:watch": "yarn build:watch",
     "build:bundle:watch": "rollup -c rollup.bundle.config.js --watch",

diff --git a/packages/browser/src/eventbuilder.ts b/packages/browser/src/eventbuilder.ts
@@ -208,7 +208,7 @@ export function eventFromUnknownInput(
   // https://developer.mozilla.org/en-US/docs/Web/API/DOMError
   // https://developer.mozilla.org/en-US/docs/Web/API/DOMException
   // https://webidl.spec.whatwg.org/#es-DOMException-specialness
-  if (isDOMError(exception as DOMError) || isDOMException(exception as DOMException)) {
+  if (isDOMError(exception) || isDOMException(exception as DOMException)) {
     const domException = exception as DOMException;
 
     if ('stack' in (exception as Error)) {
@@ -220,6 +220,7 @@ export function eventFromUnknownInput(
       addExceptionTypeValue(event, message);
     }
     if ('code' in domException) {
+      // eslint-disable-next-line deprecation/deprecation
       event.tags = { ...event.tags, 'DOMException.code': `${domException.code}` };
     }
 

diff --git a/packages/browser/src/integrations/breadcrumbs.ts b/packages/browser/src/integrations/breadcrumbs.ts
@@ -348,5 +348,5 @@ function _historyBreadcrumb(handlerData: HandlerData & { from: string; to: strin
 }
 
 function _isEvent(event: unknown): event is Event {
-  return event && !!(event as Record<string, unknown>).target;
+  return !!event && !!(event as Record<string, unknown>).target;
 }
diff --git a/packages/browser/test/unit/integrations/helpers.test.ts b/packages/browser/test/unit/integrations/helpers.test.ts
@@ -157,7 +157,7 @@ describe('internal wrap()', () => {
     try {
       wrapped();
     } catch (error) {
-      expect(error.message).toBe('boom');
+      expect((error as Error).message).toBe('boom');
     }
   });
 

diff --git a/packages/browser/test/unit/transports/offline.test.ts b/packages/browser/test/unit/transports/offline.test.ts
@@ -47,7 +47,7 @@ export const createTestTransport = (...sendResults: MockResult<TransportMakeRequ
             reject(next);
           } else {
             sendCount += 1;
-            resolve(next as TransportMakeRequestResponse | undefined);
+            resolve(next as TransportMakeRequestResponse);
           }
         });
       }),

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -12,19 +12,24 @@
   "main": "build/cjs/index.js",
   "module": "build/esm/index.js",
   "types": "build/types/index.d.ts",
+  "typesVersions": {
+    "<4.9": { "build/types/index.d.ts": ["build/types-ts3.8/index.d.ts"] }
+  },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
     "@sentry/types": "7.56.0",
     "@sentry/utils": "7.56.0",
-    "tslib": "^1.9.3"
+    "tslib": "^2.4.1 || ^1.9.3"
   },
   "scripts": {
     "build": "run-p build:transpile build:types",
     "build:dev": "yarn build",
     "build:transpile": "rollup -c rollup.npm.config.js",
-    "build:types": "tsc -p tsconfig.types.json",
+    "build:types": "run-s build:types:core build:types:downlevel",
+    "build:types:core": "tsc -p tsconfig.types.json",
+    "build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
     "build:watch": "run-p build:transpile:watch build:types:watch",
     "build:dev:watch": "yarn build:watch",
     "build:transpile:watch": "rollup -c rollup.npm.config.js --watch",

diff --git a/packages/core/src/transports/offline.ts b/packages/core/src/transports/offline.ts
@@ -131,10 +131,10 @@ export function makeOfflineTransport<TO>(
         retryDelay = START_DELAY;
         return result;
       } catch (e) {
-        if (store && (await shouldQueue(envelope, e, retryDelay))) {
+        if (store && (await shouldQueue(envelope, e as Error, retryDelay))) {
           await store.insert(envelope);
           flushWithBackOff();
-          log('Error sending. Event queued', e);
+          log('Error sending. Event queued', e as Error);
           return {};
         } else {
           throw e;

diff --git a/packages/core/test/lib/hint.test.ts b/packages/core/test/lib/hint.test.ts
@@ -16,6 +16,7 @@ describe('Hint', () => {
 
   afterEach(() => {
     jest.clearAllMocks();
+    // @ts-ignore for testing
     delete GLOBAL_OBJ.__SENTRY__;
   });
 

diff --git a/packages/core/test/lib/transports/offline.test.ts b/packages/core/test/lib/transports/offline.test.ts
@@ -98,7 +98,7 @@ const createTestTransport = (
             reject(next);
           } else {
             sendCount += 1;
-            resolve(next as TransportMakeRequestResponse | undefined);
+            resolve(next as TransportMakeRequestResponse);
           }
         });
       }),

diff --git a/packages/e2e-tests/package.json b/packages/e2e-tests/package.json
@@ -26,7 +26,6 @@
     "fs-extra": "11.1.0",
     "glob": "8.0.3",
     "ts-node": "10.9.1",
-    "typescript": "3.8.3",
     "yaml": "2.2.2"
   },
   "volta": {

diff --git a/packages/e2e-tests/test-applications/create-next-app/package.json b/packages/e2e-tests/test-applications/create-next-app/package.json
@@ -16,7 +16,7 @@
     "next": "13.0.7",
     "react": "18.2.0",
     "react-dom": "18.2.0",
-    "typescript": "4.9.4"
+    "typescript": "4.9.5"
   },
   "devDependencies": {
     "@playwright/test": "^1.27.1"

diff --git a/packages/e2e-tests/test-applications/create-react-app/package.json b/packages/e2e-tests/test-applications/create-react-app/package.json
@@ -15,7 +15,7 @@
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "react-scripts": "5.0.1",
-    "typescript": "4.4.2",
+    "typescript": "4.9.5",
     "web-vitals": "2.1.0"
   },
   "scripts": {

diff --git a/packages/e2e-tests/test-applications/create-react-app/test-recipe.json b/packages/e2e-tests/test-applications/create-react-app/test-recipe.json
@@ -3,6 +3,13 @@
   "testApplicationName": "create-react-app",
   "buildCommand": "pnpm install && pnpm build",
   "tests": [],
+  "versions": [
+    {
+      "dependencyOverrides": {
+        "typescript": "3.8.3"
+      }
+    }
+  ],
   "canaryVersions": [
     {
       "dependencyOverrides": {

diff --git a/packages/e2e-tests/test-applications/nextjs-app-dir/package.json b/packages/e2e-tests/test-applications/nextjs-app-dir/package.json
@@ -16,7 +16,7 @@
     "next": "13.2.4",
     "react": "18.2.0",
     "react-dom": "18.2.0",
-    "typescript": "4.9.4",
+    "typescript": "4.9.5",
     "wait-port": "1.0.4",
     "ts-node": "10.9.1",
     "@playwright/test": "^1.27.1"

diff --git a/packages/e2e-tests/test-applications/standard-frontend-react-tracing-import/package.json b/packages/e2e-tests/test-applications/standard-frontend-react-tracing-import/package.json
@@ -16,7 +16,7 @@
     "react-dom": "18.2.0",
     "react-router-dom": "^6.4.1",
     "react-scripts": "5.0.1",
-    "typescript": "4.4.2",
+    "typescript": "4.9.5",
     "web-vitals": "2.1.0"
   },
   "scripts": {

diff --git a/packages/e2e-tests/test-applications/standard-frontend-react/package.json b/packages/e2e-tests/test-applications/standard-frontend-react/package.json
@@ -15,7 +15,7 @@
     "react-dom": "18.2.0",
     "react-router-dom": "^6.4.1",
     "react-scripts": "5.0.1",
-    "typescript": "4.4.2",
+    "typescript": "4.9.5",
     "web-vitals": "2.1.0"
   },
   "scripts": {

diff --git a/packages/e2e-tests/test-applications/standard-frontend-react/test-recipe.json b/packages/e2e-tests/test-applications/standard-frontend-react/test-recipe.json
@@ -8,6 +8,13 @@
       "testCommand": "pnpm test"
     }
   ],
+  "versions": [
+    {
+      "dependencyOverrides": {
+        "typescript": "3.8.3"
+      }
+    }
+  ],
   "canaryVersions": [
     {
       "dependencyOverrides": {

diff --git a/packages/e2e-tests/test-applications/sveltekit/package.json b/packages/e2e-tests/test-applications/sveltekit/package.json
@@ -22,7 +22,7 @@
     "svelte": "^3.54.0",
     "svelte-check": "^3.0.1",
     "ts-node": "10.9.1",
-    "tslib": "^2.4.1",
+    "tslib": "2.4.1",
     "typescript": "^5.0.0",
     "vite": "^4.2.0",
     "wait-port": "1.0.4"

diff --git a/packages/ember/package.json b/packages/ember/package.json
@@ -75,7 +75,6 @@
     "loader.js": "~4.7.0",
     "qunit": "~2.19.2",
     "qunit-dom": "~2.0.0",
-    "typescript": "~4.5.2",
     "webpack": "~5.74.0"
   },
   "engines": {