feat!: Require Node >=18 as minimum supported version (#14749)

We decided to require node 18+ in v9. This is to align with the upcoming changes in OpenTelemetry. We also believe it is a reasonable version requirement - Node 16 is EOL for some time now. This will also allow us to update a bunch of dev tooling (vitest, ...) properly and streamline some processes. For users requiring Node 14/16, they can remain on v8 (which will be continued to be supported with bug fixes for some time). ref #14257
getsentry · Dec 18, 2024 · 2853845 · 2853845
1 parent 786c5ca
commit 2853845
Show file tree

Hide file tree

Showing 112 changed files with 203 additions and 302 deletions.
diff --git a/.github/ISSUE_TEMPLATE/flaky.yml b/.github/ISSUE_TEMPLATE/flaky.yml
@@ -19,7 +19,7 @@ body:
     id: job-name
     attributes:
       label: Name of Job
-      placeholder: "CI: Build & Test / Nextjs (Node 14) Tests"
+      placeholder: "CI: Build & Test / Nextjs (Node 18) Tests"
       description: name of job as reported in the status report
     validations:
       required: true

diff --git a/.github/actions/restore-cache/action.yml b/.github/actions/restore-cache/action.yml
@@ -5,9 +5,6 @@ inputs:
   dependency_cache_key:
     description: "The dependency cache key"
     required: true
-  node_version:
-    description: "If set, temporarily set node version to default one before installing, then revert to this version after."
-    required: false
 
 runs:
   using: "composite"
@@ -24,19 +21,7 @@ runs:
         with:
           name: build-output
 
-      - name: Use default node version for install
-        if: inputs.node_version && steps.dep-cache.outputs.cache-hit != 'true'
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: 'package.json'
-
       - name: Install dependencies
         if: steps.dep-cache.outputs.cache-hit != 'true'
         run: yarn install --ignore-engines --frozen-lockfile
         shell: bash
-
-      - name: Revert node version to ${{ inputs.node_version }}
-        if: inputs.node_version && steps.dep-cache.outputs.cache-hit != 'true'
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ inputs.node_version }}
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -459,7 +459,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [14, 16, 18, 20, 22]
+        node: [18, 20, 22]
     steps:
       - name: Check out base commit (${{ github.event.pull_request.base.sha }})
         uses: actions/checkout@v4
@@ -478,7 +478,6 @@ jobs:
         uses: ./.github/actions/restore-cache
         with:
           dependency_cache_key: ${{ needs.job_build.outputs.dependency_cache_key }}
-          node_version: ${{ matrix.node == 14 && '14' || '' }}
 
       - name: Run affected tests
         run: yarn test:pr:node --base=${{ github.event.pull_request.base.sha }}
@@ -715,7 +714,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [14, 16, 18, 20, 22]
+        node: [18, 20, 22]
         typescript:
           - false
         include:
@@ -735,17 +734,13 @@ jobs:
         uses: ./.github/actions/restore-cache
         with:
           dependency_cache_key: ${{ needs.job_build.outputs.dependency_cache_key }}
-          node_version: ${{ matrix.node == 14 && '14' || '' }}
 
       - name: Overwrite typescript version
-        if: matrix.typescript
-        run: node ./scripts/use-ts-version.js ${{ matrix.typescript }}
+        if: matrix.typescript == '3.8'
+        run: node ./scripts/use-ts-3_8.js
         working-directory: dev-packages/node-integration-tests
 
       - name: Run integration tests
-        env:
-          NODE_VERSION: ${{ matrix.node }}
-          TS_VERSION: ${{ matrix.typescript }}
         working-directory: dev-packages/node-integration-tests
         run: yarn test
 
@@ -760,10 +755,6 @@ jobs:
       matrix:
         node: [18, 20, 22]
         remix: [1, 2]
-        # Remix v2 only supports Node 18+, so run 16 tests separately
-        include:
-          - node: 16
-            remix: 1
     steps:
       - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }})
         uses: actions/checkout@v4
@@ -1243,24 +1234,22 @@ jobs:
           echo "One of the dependent jobs have failed. You may need to re-run it." && exit 1
 
   job_compile_bindings_profiling_node:
-    name: Compile & Test Profiling Bindings (v${{ matrix.node }}) ${{ matrix.target_platform || matrix.os }}, ${{ matrix.node || matrix.container }}, ${{ matrix.arch || matrix.container }}, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc'  }}
+    name: Compile profiling-node (v${{ matrix.node }}) ${{ matrix.target_platform || matrix.os }}, ${{ matrix.arch || matrix.container }}, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc'  }}
     needs: [job_get_metadata, job_build]
     # Compiling bindings can be very slow (especially on windows), so only run precompile
     # Skip precompile unless we are on a release branch as precompile slows down CI times.
     if: |
       (needs.job_get_metadata.outputs.changed_profiling_node == 'true') ||
       (needs.job_get_metadata.outputs.is_release == 'true')
     runs-on: ${{ matrix.os }}
-    container: ${{ matrix.container }}
+    container:
+      image: ${{ matrix.container }}
     timeout-minutes: 30
     strategy:
       fail-fast: false
       matrix:
         include:
             # x64 glibc
-          - os: ubuntu-20.04
-            node: 16
-            binary: linux-x64-glibc-93
           - os: ubuntu-20.04
             node: 18
             binary: linux-x64-glibc-108
@@ -1272,10 +1261,6 @@ jobs:
             binary: linux-x64-glibc-127
 
             # x64 musl
-          - os: ubuntu-20.04
-            container: node:16-alpine3.16
-            binary: linux-x64-musl-93
-            node: 16
           - os: ubuntu-20.04
             container: node:18-alpine3.17
             node: 18
@@ -1290,10 +1275,6 @@ jobs:
             binary: linux-x64-musl-127
 
             # arm64 glibc
-          - os: ubuntu-20.04
-            arch: arm64
-            node: 16
-            binary: linux-arm64-glibc-93
           - os: ubuntu-20.04
             arch: arm64
             node: 18
@@ -1308,11 +1289,6 @@ jobs:
             binary: linux-arm64-glibc-127
 
             # arm64 musl
-          - os: ubuntu-20.04
-            container: node:16-alpine3.16
-            arch: arm64
-            node: 16
-            binary: linux-arm64-musl-93
           - os: ubuntu-20.04
             arch: arm64
             container: node:18-alpine3.17
@@ -1330,10 +1306,6 @@ jobs:
             binary: linux-arm64-musl-127
 
             # macos x64
-          - os: macos-13
-            node: 16
-            arch: x64
-            binary: darwin-x64-93
           - os: macos-13
             node: 18
             arch: x64
@@ -1348,11 +1320,6 @@ jobs:
             binary: darwin-x64-127
 
             # macos arm64
-          - os: macos-13
-            arch: arm64
-            node: 16
-            target_platform: darwin
-            binary: darwin-arm64-93
           - os: macos-13
             arch: arm64
             node: 18
@@ -1370,10 +1337,6 @@ jobs:
             binary: darwin-arm64-127
 
             # windows x64
-          - os: windows-2022
-            node: 16
-            arch: x64
-            binary: win32-x64-93
           - os: windows-2022
             node: 18
             arch: x64
@@ -1399,8 +1362,13 @@ jobs:
         with:
           ref: ${{ env.HEAD_COMMIT }}
 
+      # Note: On alpine images, this does nothing
+      # The node version will be the one that is installed in the image
+      # If you want to change the node version, you need to change the image
+      # For non-alpine imgages, this will install the correct version of node
       - name: Setup Node
         uses: actions/setup-node@v4
+        if: contains(matrix.container, 'alpine') == false
         with:
           node-version: ${{ matrix.node }}
 
@@ -1417,10 +1385,10 @@ jobs:
         run: yarn config set network-timeout 600000 -g
 
       - name: Install dependencies
-        env:
-          SKIP_PLAYWRIGHT_BROWSER_INSTALL: "1"
         if: steps.restore-dependencies.outputs.cache-hit != 'true'
         run: yarn install --ignore-engines --frozen-lockfile
+        env:
+          SKIP_PLAYWRIGHT_BROWSER_INSTALL: "1"
 
       - name: Configure safe directory
         run: |
@@ -1498,8 +1466,7 @@ jobs:
           BUILD_ARCH=arm64 \
           yarn build:bindings:arm64
 
-      - name: Build Monorepo
-        if: steps.restore-build.outputs.cache-hit != 'true'
+      - name: Build profiling-node & its dependencies
         run: yarn build --scope @sentry/profiling-node
 
       - name: Test Bindings

diff --git a/README.md b/README.md
@@ -79,6 +79,8 @@ package. Please refer to the README and instructions of those SDKs for more deta
 The current version of the SDK is 8.x. Version 7.x of the SDK will continue to receive critical bugfixes until end
 of 2024.
 
+All SDKs require Node v18+ to run. ESM-only SDKs require Node v18.19.1+ to run.
+
 ## Installation and Usage
 
 To install a SDK, simply add the high-level package, for example:

diff --git a/dev-packages/browser-integration-tests/package.json b/dev-packages/browser-integration-tests/package.json
@@ -4,12 +4,12 @@
   "main": "index.js",
   "license": "MIT",
   "engines": {
-    "node": ">=14.18"
+    "node": ">=18"
   },
   "private": true,
   "scripts": {
     "clean": "rimraf -g suites/**/dist loader-suites/**/dist tmp",
-    "install-browsers": "[[ -z \"$SKIP_PLAYWRIGHT_BROWSER_INSTALL\" ]] && yarn npx playwright install --with-deps || echo 'Skipping browser installation'",
+    "install-browsers": "[[ -z \"$SKIP_PLAYWRIGHT_BROWSER_INSTALL\" ]] && npx playwright install --with-deps || echo 'Skipping browser installation'",
     "lint": "eslint . --format stylish",
     "fix": "eslint . --format stylish --fix",
     "type-check": "tsc",
@@ -52,7 +52,7 @@
   },
   "devDependencies": {
     "@types/glob": "8.0.0",
-    "@types/node": "^14.18.0",
+    "@types/node": "^18.19.1",
     "@types/pako": "^2.0.0",
     "glob": "8.0.3"
   },

diff --git a/dev-packages/e2e-tests/package.json b/dev-packages/e2e-tests/package.json
@@ -21,7 +21,7 @@
   },
   "devDependencies": {
     "@types/glob": "8.0.0",
-    "@types/node": "^18.0.0",
+    "@types/node": "^18.19.1",
     "dotenv": "16.0.3",
     "esbuild": "0.20.0",
     "glob": "8.0.3",

diff --git a/dev-packages/e2e-tests/test-applications/create-next-app/package.json b/dev-packages/e2e-tests/test-applications/create-next-app/package.json
@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@sentry/nextjs": "latest || *",
-    "@types/node": "18.11.17",
+    "@types/node": "^18.19.1",
     "@types/react": "18.0.26",
     "@types/react-dom": "18.0.9",
     "next": "14.0.0",

diff --git a/dev-packages/e2e-tests/test-applications/create-react-app/package.json b/dev-packages/e2e-tests/test-applications/create-react-app/package.json
@@ -4,7 +4,7 @@
   "private": true,
   "dependencies": {
     "@sentry/react": "latest || *",
-    "@types/node": "16.7.13",
+    "@types/node": "^18.19.1",
     "@types/react": "18.0.0",
     "@types/react-dom": "18.0.0",
     "react": "18.2.0",

diff --git a/dev-packages/e2e-tests/test-applications/default-browser/package.json b/dev-packages/e2e-tests/test-applications/default-browser/package.json
@@ -4,7 +4,7 @@
   "private": true,
   "dependencies": {
     "@sentry/browser": "latest || *",
-    "@types/node": "16.7.13",
+    "@types/node": "^18.19.1",
     "typescript": "4.9.5"
   },
   "scripts": {

diff --git a/dev-packages/e2e-tests/test-applications/ember-classic/package.json b/dev-packages/e2e-tests/test-applications/ember-classic/package.json
@@ -48,7 +48,7 @@
     "@types/ember__string": "~3.0.15",
     "@types/ember__template": "~4.0.7",
     "@types/ember__utils": "~4.0.7",
-    "@types/node": "18.18.0",
+    "@types/node": "^18.19.1",
     "@types/rsvp": "~4.0.9",
     "broccoli-asset-rev": "~3.0.0",
     "ember-auto-import": "~2.4.3",
@@ -72,7 +72,7 @@
     "webpack": "~5.97.0"
   },
   "engines": {
-    "node": "14.* || 16.* || >= 18"
+    "node": ">=18"
   },
   "resolutions": {
     "@babel/traverse": "~7.25.9"

diff --git a/dev-packages/e2e-tests/test-applications/ember-embroider/package.json b/dev-packages/e2e-tests/test-applications/ember-embroider/package.json
@@ -54,14 +54,14 @@
     "@sentry/ember": "latest || *",
     "@sentry-internal/test-utils": "link:../../../test-utils",
     "@tsconfig/ember": "^3.0.6",
-    "@types/node": "18.18.0",
+    "@types/node": "^18.19.1",
     "@tsconfig/node18": "18.2.4",
     "@types/rsvp": "^4.0.9",
     "ts-node": "10.9.1",
     "typescript": "^5.4.5"
   },
   "engines": {
-    "node": ">= 18"
+    "node": ">=18"
   },
   "ember": {
     "edition": "octane"

diff --git a/dev-packages/e2e-tests/test-applications/generic-ts3.8/package.json b/dev-packages/e2e-tests/test-applications/generic-ts3.8/package.json
@@ -11,7 +11,7 @@
   },
   "devDependencies": {
     "typescript": "3.8.3",
-    "@types/node": "^14.18.0"
+    "@types/node": "^14.0.0"
   },
   "dependencies": {
     "@sentry/browser": "latest || *",

diff --git a/dev-packages/e2e-tests/test-applications/nestjs-8/package.json b/dev-packages/e2e-tests/test-applications/nestjs-8/package.json
@@ -31,7 +31,7 @@
     "@nestjs/schematics": "^10.0.0",
     "@nestjs/testing": "^10.0.0",
     "@types/express": "^4.17.17",
-    "@types/node": "18.15.1",
+    "@types/node": "^18.19.1",
     "@types/supertest": "^6.0.0",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",

diff --git a/dev-packages/e2e-tests/test-applications/nestjs-basic-with-graphql/package.json b/dev-packages/e2e-tests/test-applications/nestjs-basic-with-graphql/package.json
@@ -33,7 +33,7 @@
     "@nestjs/schematics": "^10.0.0",
     "@nestjs/testing": "^10.0.0",
     "@types/express": "^4.17.17",
-    "@types/node": "18.15.1",
+    "@types/node": "^18.19.1",
     "@types/supertest": "^6.0.0",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",

diff --git a/dev-packages/e2e-tests/test-applications/nestjs-basic/package.json b/dev-packages/e2e-tests/test-applications/nestjs-basic/package.json
@@ -31,7 +31,7 @@
     "@nestjs/schematics": "^10.0.0",
     "@nestjs/testing": "^10.0.0",
     "@types/express": "^4.17.17",
-    "@types/node": "18.15.1",
+    "@types/node": "^18.19.1",
     "@types/supertest": "^6.0.0",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",

diff --git a/dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/package.json b/dev-packages/e2e-tests/test-applications/nestjs-distributed-tracing/package.json
@@ -30,7 +30,7 @@
     "@nestjs/schematics": "^10.0.0",
     "@nestjs/testing": "^10.0.0",
     "@types/express": "^4.17.17",
-    "@types/node": "18.15.1",
+    "@types/node": "^18.19.1",
     "@types/supertest": "^6.0.0",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",

diff --git a/dev-packages/e2e-tests/test-applications/nestjs-fastify/package.json b/dev-packages/e2e-tests/test-applications/nestjs-fastify/package.json
@@ -31,7 +31,7 @@
     "@nestjs/cli": "^10.0.0",
     "@nestjs/schematics": "^10.0.0",
     "@nestjs/testing": "^10.0.0",
-    "@types/node": "18.15.1",
+    "@types/node": "^18.19.1",
     "@types/supertest": "^6.0.0",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",

diff --git a/dev-packages/e2e-tests/test-applications/nestjs-graphql/package.json b/dev-packages/e2e-tests/test-applications/nestjs-graphql/package.json
@@ -33,7 +33,7 @@
     "@nestjs/schematics": "^10.0.0",
     "@nestjs/testing": "^10.0.0",
     "@types/express": "^4.17.17",
-    "@types/node": "18.15.1",
+    "@types/node": "^18.19.1",
     "@types/supertest": "^6.0.0",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",