chore(client): Drop Node 16 support and add Node 22 support (#1378)

Node 16 has been [dead for a while](https://nodejs.org/en/blog/announcements/nodejs16-eol) and we are not testing more modern Node LTS versions. Most prominently, the better-sqlite3 we were using in the client does not support Node v22 as raised by @robacourt and others (electric-sql/electric#1301) I've updated the CI workflows to use Node v22 and the matrices to test v18 v20 and v22
electric-sql · Jun 18, 2024 · 26b3a87 · 26b3a87
1 parent 8cddaaf
commit 26b3a87
Show file tree

Hide file tree

Showing 13 changed files with 57 additions and 49 deletions.
diff --git a/.github/workflows/changesets_release.yml b/.github/workflows/changesets_release.yml
@@ -21,7 +21,7 @@ jobs:
           version: 8
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 22
           cache: pnpm
       - run: pnpm install --frozen-lockfile
       - name: Create Release Pull Request or Publish
@@ -33,4 +33,4 @@ jobs:
           title: Publish new package versions
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.github/workflows/clients_typescript_tests.yml b/.github/workflows/clients_typescript_tests.yml
@@ -30,7 +30,7 @@ jobs:
           version: 8
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 22
           cache: pnpm
       - run: make deps
       - run: pnpm run check-styleguide
@@ -44,7 +44,7 @@ jobs:
           version: 8
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 22
           cache: pnpm
       - run: make deps
       - run: pnpm run typecheck
@@ -53,7 +53,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [16, 18, 20]
+        node-version: [18, 20, 22]
     steps:
       - uses: actions/checkout@v3
       - uses: pnpm/action-setup@v2

diff --git a/.github/workflows/examples_e2e.yml b/.github/workflows/examples_e2e.yml
@@ -34,7 +34,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22
           cache: npm
           cache-dependency-path: |
             ${{ matrix.example_dir }}/package-lock.json
@@ -62,7 +62,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22
           cache: yarn
           cache-dependency-path: examples/introduction/yarn.lock
       - name: Install dependencies

diff --git a/.github/workflows/generator_tests.yml b/.github/workflows/generator_tests.yml
@@ -24,7 +24,7 @@ jobs:
           version: 8
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 22
           cache: pnpm
       - run: make deps
       - run: pnpm run check-styleguide
@@ -38,7 +38,7 @@ jobs:
           version: 8
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 22
           cache: pnpm
       - run: make deps
       - run: pnpm run build
@@ -47,7 +47,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [16, 18, 20]
+        node-version: [18, 20, 22]
     steps:
       - uses: actions/checkout@v3
       - uses: pnpm/action-setup@v2

diff --git a/.github/workflows/satellite_proto.yml b/.github/workflows/satellite_proto.yml
@@ -4,15 +4,15 @@ on:
     branches:
       - main
     paths:
-      - "protocol/**"
+      - 'protocol/**'
   pull_request:
     paths:
-      - "protocol/**"
+      - 'protocol/**'
   workflow_dispatch:
 
 env:
-  OTP_VERSION: "27.0"
-  ELIXIR_VERSION: "1.17.0-otp-27"
+  OTP_VERSION: '27.0'
+  ELIXIR_VERSION: '1.17.0-otp-27'
 
 jobs:
   verify_proto:
@@ -29,13 +29,13 @@ jobs:
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           # keep this in sync with the version pinned in .tool-versions
-          version: "26.1"
+          version: '26.1'
       - uses: pnpm/action-setup@v2
         with:
           version: 8
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 22
           cache: pnpm
       - uses: erlef/setup-beam@v1
         with:

diff --git a/.github/workflows/toolbar_tests.yml b/.github/workflows/toolbar_tests.yml
@@ -24,7 +24,7 @@ jobs:
           version: 8
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 22
           cache: pnpm
       - run: make deps
       - run: make check_styleguide
@@ -38,7 +38,7 @@ jobs:
           version: 8
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 22
           cache: pnpm
       - run: make deps
       - run: make check_types
@@ -47,7 +47,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [16, 18, 20]
+        node-version: [18, 20, 22]
     steps:
       - uses: actions/checkout@v3
       - uses: pnpm/action-setup@v2
@@ -77,4 +77,3 @@ jobs:
       - run: make deps
       - run: pnpm config set '//registry.npmjs.org/:_authToken' "${{ secrets.NPM_TOKEN }}"
       - run: make publish-canary
-
diff --git a/clients/typescript/package.json b/clients/typescript/package.json
@@ -181,7 +181,7 @@
     "@prisma/client": "4.8.1",
     "async-mutex": "^0.4.0",
     "base-64": "^1.0.0",
-    "better-sqlite3": "^8.4.0",
+    "better-sqlite3": "^11.0.0",
     "commander": "^11.1.0",
     "cross-fetch": "^3.1.5",
     "decompress": "^4.2.1",
@@ -221,7 +221,7 @@
     "@tauri-apps/plugin-sql": "2.0.0-alpha.5",
     "@testing-library/react": "^13.4.0",
     "@types/base-64": "^1.0.0",
-    "@types/better-sqlite3": "7.6.3",
+    "@types/better-sqlite3": "7.6.10",
     "@types/decompress": "^4.2.4",
     "@types/lodash.flow": "^3.5.7",
     "@types/lodash.groupby": "^4.6.7",

diff --git a/clients/typescript/src/drivers/better-sqlite3/adapter.ts b/clients/typescript/src/drivers/better-sqlite3/adapter.ts
@@ -73,7 +73,7 @@ export class DatabaseAdapter
   // This `query` function does not enforce that the query is read-only
   async _query({ sql, args }: DbStatement): Promise<Row[]> {
     const stmt = this.db.prepare(sql)
-    return stmt.all(...wrapBindParams(args))
+    return stmt.all(...wrapBindParams(args)) as Row[]
   }
 
   async _runExclusively<T>(
@@ -161,7 +161,7 @@ class WrappedTx implements Tx {
   ): void {
     try {
       const stmt = this.db.prepare(sql)
-      const rows = stmt.all(...wrapBindParams(args))
+      const rows = stmt.all(...wrapBindParams(args)) as Row[]
       successCallback(this, rows)
     } catch (err) {
       if (typeof errorCallback !== 'undefined') errorCallback(err)

diff --git a/clients/typescript/src/drivers/better-sqlite3/database.ts b/clients/typescript/src/drivers/better-sqlite3/database.ts
@@ -21,8 +21,8 @@ export interface Database
 export type StatementBindParams<T = BindParams> = T extends any[] ? T : [T]
 
 // The relevant subset of the Better-SQLite3 prepared statement.
-type BoundStatement<T extends any[]> = Omit<
-  OriginalStatement<T>,
+type BoundStatement<T extends unknown[], Result = unknown> = Omit<
+  OriginalStatement<T, Result>,
   'run' | 'get' | 'all' | 'iterate'
 > & {
   run: (...params: T) => RunResult
@@ -31,6 +31,7 @@ type BoundStatement<T extends any[]> = Omit<
   iterate: (...params: T) => IterableIterator<Row>
 }
 
-export type Statement<T extends BindParams = []> = T extends any[]
-  ? BoundStatement<T>
-  : BoundStatement<[T]>
+export type Statement<
+  T extends BindParams = [],
+  Result = unknown
+> = T extends any[] ? BoundStatement<T, Result> : BoundStatement<[T], Result>
diff --git a/clients/typescript/src/drivers/better-sqlite3/mock.ts b/clients/typescript/src/drivers/better-sqlite3/mock.ts
@@ -1,5 +1,6 @@
 import { BindParams, DbName, Row, SqlValue } from '../../util/types'
 import { Database, Statement, Transaction } from './database'
+import type { Statement as OriginalStatement } from 'better-sqlite3'
 
 type MockStatement<T extends BindParams = []> = Pick<
   Statement<T>,
@@ -20,8 +21,8 @@ export class MockDatabase implements Database {
     return this
   }
 
-  prepare<T extends BindParams = []>(_sql: string): Statement<T> {
-    const mockStatement: MockStatement<T> = {
+  prepare<T extends unknown[] | {}, R>(_sql: string) {
+    const mockStatement: MockStatement = {
       database: this as any,
       readonly: false,
       source: _sql,
@@ -42,13 +43,13 @@ export class MockDatabase implements Database {
     }
 
     // Valid only for mocking since we don't expect to need to mock full interface
-    return mockStatement as Statement<T>
+    return mockStatement as unknown as OriginalStatement<T, R>
   }
 
   transaction<T extends (...args: any[]) => any>(fn: T): Transaction<T> {
     const self = this
 
-    const baseFn = (...args: Parameters<T>): ReturnType<T> => {
+    const baseFn = (...args: unknown[]): ReturnType<T> => {
       self.inTransaction = true
 
       const retval = fn(...args)
@@ -58,7 +59,8 @@ export class MockDatabase implements Database {
       return retval
     }
 
-    const txFn = <Transaction<T>>baseFn
+    const txFn = baseFn as unknown as Transaction<T>
+    txFn.default = baseFn
     txFn.deferred = baseFn
     txFn.immediate = baseFn
     txFn.exclusive = baseFn

diff --git a/components/toolbar/package.json b/components/toolbar/package.json
@@ -39,7 +39,7 @@
     "@typescript-eslint/eslint-plugin": "^7.8.0",
     "@typescript-eslint/parser": "^7.8.0",
     "@vitejs/plugin-react": "^4.2.1",
-    "better-sqlite3": "^8.4.0",
+    "better-sqlite3": "^11.0.0",
     "electric-sql": "workspace:*",
     "eslint": "^8.22.0",
     "eslint-plugin-react": "^7.34.1",

diff --git a/e2e/satellite_client/package.json b/e2e/satellite_client/package.json
@@ -17,7 +17,7 @@
     "lint": "eslint src --fix"
   },
   "dependencies": {
-    "better-sqlite3": "^8.4.0",
+    "better-sqlite3": "^11.0.0",
     "electric-sql": "workspace:*",
     "jsonwebtoken": "^9.0.0",
     "pg": "^8.11.3",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml