feat: add node v20 support (#105)

simone-sanfratello · web-flow · commit 0ebf98011b38 · 2025-08-19T23:17:52.000+02:00
* feat: node v20 support

* test: remove coverage check on v20

* test: ci

* test: ci

* test: remove coverage check on v20

* fix: ci

* fix: ci

* fix: ci

* fix: ci
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,7 +11,8 @@ jobs:
   ci:
     strategy:
       matrix:
-        node-version: [22, 24]
+        # Using the latest LTS versions for CI
+        node-version: [20, 22, 24]
         os: [ubuntu-latest]
         # Support for 3.6.0 is not available in CI since the Docker image has issues with option management in regard of SASL/OAUTHBEARER.
         kafka-version: ['3.5.0', '3.7.0', '3.8.0', '3.9.0', '4.0.0']
@@ -40,6 +41,11 @@ jobs:
         env:
           KAFKA_VERSION: ${{ matrix.kafka-version }}
       - name: Run Tests
-        run: pnpm run ci
+        run: |
+          if [ "${{ matrix.node-version }}" = "20" ]; then
+            pnpm run test:ci:v20
+          else
+            pnpm run ci
+          fi
         env:
           KAFKA_VERSION: ${{ matrix.kafka-version }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -41,7 +41,7 @@ jobs:
       - name: Install dependencies
         run: pnpm install
       - name: Bump Version
-        run: node --experimental-strip-types --disable-warning=ExperimentalWarning scripts/bump-version.ts "${{ inputs.version }}" "${{ github.actor }}"
+        run: node scripts/bump-version.ts "${{ inputs.version }}" "${{ github.actor }}"
         env:
           GITHUB_ACTIONS: 'true'
       - name: Push changes
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ external/
 node_modules
 coverage
 .eslintcache
+.env
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -32,4 +32,4 @@ npm run lint
 
 ## Node Requirements
 
-- Node.js >= 22.14.0
+- Node.js >= 20.19.4 or >= 22.18.0 or >= 24.6.0
diff --git a/README.md b/README.md
@@ -281,7 +281,28 @@ Many of the methods accept the same options as the client's constructors. The co
 
 ## Requirements
 
-- Node.js >= 22.14.0
+Node.js LTS versions: 
+
+- `20.19.4` or above
+- `22.18.0` or above
+- `24.6.0` or above
+
+## Testing
+
+To setup the local environment for testing
+
+```bash
+cd docker
+cp .env.sample .env
+```
+
+Edit .env file as needed, enabling or not `JAVA_OPTIONS`
+
+Start Kafka cluster locally
+
+```bash
+docker compose -f compose-local.yml up -d
+```
 
 ## License
 
diff --git a/benchmarks/consumer.ts b/benchmarks/consumer.ts
@@ -2,13 +2,13 @@ import RDKafka from '@platformatic/rdkafka'
 import { printResults, Tracker, type Result } from 'cronometro'
 import { Kafka as KafkaJS, logLevel } from 'kafkajs'
 import { randomUUID } from 'node:crypto'
-import { Consumer, MessagesStreamModes } from '../src/index.ts'
+import { Consumer, MessagesStreamModes, PromiseWithResolvers } from '../src/index.ts'
 import { brokers, topic } from './utils/definitions.ts'
 
 const iterations = 10000
 
 function rdkafkaEvented (): Promise<Result> {
-  const { promise, resolve, reject } = Promise.withResolvers<Result>()
+  const { promise, resolve, reject } = PromiseWithResolvers<Result>()
   const tracker = new Tracker()
 
   const consumer = new RDKafka.KafkaConsumer(
@@ -68,7 +68,7 @@ function rdkafkaEvented (): Promise<Result> {
 }
 
 function rdkafkaStream (): Promise<Result> {
-  const { promise, resolve, reject } = Promise.withResolvers<Result>()
+  const { promise, resolve, reject } = PromiseWithResolvers<Result>()
   const tracker = new Tracker()
 
   const stream = RDKafka.KafkaConsumer.createReadStream(
@@ -107,7 +107,7 @@ function rdkafkaStream (): Promise<Result> {
 }
 
 async function kafkajs (): Promise<Result> {
-  const { promise, resolve, reject } = Promise.withResolvers<Result>()
+  const { promise, resolve, reject } = PromiseWithResolvers<Result>()
   const tracker = new Tracker()
 
   const client = new KafkaJS({ clientId: 'benchmarks', brokers, logLevel: logLevel.ERROR })
@@ -140,7 +140,7 @@ async function kafkajs (): Promise<Result> {
 }
 
 async function platformaticKafka (): Promise<Result> {
-  const { promise, resolve, reject } = Promise.withResolvers<Result>()
+  const { promise, resolve, reject } = PromiseWithResolvers<Result>()
   const tracker = new Tracker()
 
   const consumer = new Consumer({
diff --git a/benchmarks/producer.ts b/benchmarks/producer.ts
@@ -1,14 +1,14 @@
 import RDKafka from '@platformatic/rdkafka'
 import { printResults, Tracker, type Result } from 'cronometro'
 import { Kafka as KafkaJS } from 'kafkajs'
-import { ProduceAcks, Producer, stringSerializers } from '../src/index.ts'
+import { ProduceAcks, Producer, PromiseWithResolvers, stringSerializers } from '../src/index.ts'
 import { brokers, topic } from './utils/definitions.ts'
 
 const iterations = 10000
 const batchSize = Math.max(iterations / 100, 1)
 
 function rdkafka (): Promise<Result> {
-  const { promise, resolve, reject } = Promise.withResolvers<Result>()
+  const { promise, resolve, reject } = PromiseWithResolvers<Result>()
   const tracker = new Tracker()
 
   const producer = new RDKafka.Producer(
diff --git a/docker/.env.sample b/docker/.env.sample
@@ -0,0 +1,6 @@
+# See supported versions in .github/workflows/ci.yml
+KAFKA_VERSION=3.7
+
+# Needed for Docker on Apple Silicon
+# Disable if not needed, for example in Ubuntu
+# JAVA_OPTIONS='-XX:UseSVE=0'
diff --git a/docker/compose-local.yml b/docker/compose-local.yml
@@ -34,8 +34,7 @@ services:
       # Consumer group options
       KAFKA_CFG_GROUP_COORDINATOR_REBALANCE_PROTOCOLS: 'classic,consumer'
       KAFKA_CFG_GROUP_INITIAL_REBALANCE_DELAY_MS: '0'
-      # Do not use this in GitHub CI - Needed for Docker on Apple Silicon
-      _JAVA_OPTIONS: '-XX:UseSVE=0'
+      _JAVA_OPTIONS: ${JAVA_OPTIONS}
 
   broker-cluster-2:
     image: bitnami/kafka:${KAFKA_VERSION}
diff --git a/package.json b/package.json
@@ -26,7 +26,7 @@
   "types": "./dist/index.d.ts",
   "scripts": {
     "build": "rm -rf dist && tsc -p tsconfig.base.json",
-    "postbuild": "node --experimental-strip-types scripts/postbuild.ts",
+    "postbuild": "node scripts/postbuild.ts",
     "lint": "eslint --cache",
     "typecheck": "tsc -p . --noEmit",
     "format": "prettier -w benchmarks playground src test",
@@ -37,9 +37,13 @@
     "ci": "npm run build && npm run lint && npm run test:ci",
     "prepublishOnly": "npm run build && npm run lint",
     "postpublish": "git push origin && git push origin -f --tags",
-    "generate:apis": "node --experimental-strip-types scripts/generate-apis.ts",
-    "generate:errors": "node --experimental-strip-types scripts/generate-errors.ts",
-    "create:api": "node --experimental-strip-types scripts/create-api.ts"
+    "generate:apis": "node scripts/generate-apis.ts",
+    "generate:errors": "node scripts/generate-errors.ts",
+    "create:api": "node scripts/create-api.ts",
+    "build:v20": "rm -rf dist && tsc -p tsconfig.json",
+    "postbuild:v20": "cp package.json dist/package.json && node dist/scripts/postbuild.js",
+    "test:v20": "npm run build:v20 && cp -R test/fixtures dist/test/fixtures && node --env-file=test/config/env --no-warnings --test --test-timeout=300000 dist/test/**/*.test.js",
+    "test:ci:v20": "npm run build:v20 && cp -R test/fixtures dist/test/fixtures && node --env-file=test/config/env --no-warnings --test --test-timeout=300000 dist/test/**/*.test.js"
   },
   "dependencies": {
     "ajv": "^8.17.1",
@@ -55,7 +59,7 @@
   "devDependencies": {
     "@platformatic/rdkafka": "^4.0.0",
     "@types/debug": "^4.1.12",
-    "@types/node": "^22.13.5",
+    "@types/node": "^22.17.2",
     "@types/semver": "^7.7.0",
     "@watchable/unpromise": "^1.0.2",
     "avsc": "^5.7.7",
@@ -78,6 +82,6 @@
     "typescript": "^5.7.3"
   },
   "engines": {
-    "node": ">= 22.14.0"
+    "node": ">= 20.19.4 || >= 22.18.0 || >= 24.6.0"
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/bump-version.ts b/scripts/bump-version.ts
@@ -1,4 +1,4 @@
-#!/usr/bin/env -S node --experimental-strip-types --disable-warning=ExperimentalWarning
+#!/usr/bin/env -S node
 
 import { execSync } from 'node:child_process'
 import { readFile, writeFile } from 'node:fs/promises'
diff --git a/scripts/docker.ts b/scripts/docker.ts
@@ -1,4 +1,4 @@
-#!/usr/bin/env -S node --experimental-strip-types --disable-warning=ExperimentalWarning
+#!/usr/bin/env -S node
 
 import { execSync } from 'node:child_process'
 import { resolve } from 'node:path'
diff --git a/scripts/postbuild.ts b/scripts/postbuild.ts
@@ -1,11 +1,15 @@
-#!/usr/bin/env -S node --experimental-strip-types --disable-warning=ExperimentalWarning
+#!/usr/bin/env -S node
 
 import { writeFile } from 'node:fs/promises'
 import { name, version } from '../src/version.ts'
 
+const file = import.meta.url.endsWith('/dist/scripts/postbuild.js')
+  ? new URL('version.js', import.meta.url)
+  : new URL('../dist/version.js', import.meta.url)
+
 // To address https://github.com/platformatic/kafka/issues/91
 await writeFile(
-  new URL('../dist/version.js', import.meta.url),
+  file,
   `export const name = "${name}";\nexport const version = "${version}";\n`,
   'utf-8'
 )
diff --git a/src/apis/callbacks.ts b/src/apis/callbacks.ts
@@ -1,4 +1,5 @@
 import { MultipleErrors } from '../errors.ts'
+import { PromiseWithResolvers } from '../utils.ts'
 import { type Callback } from './definitions.ts'
 
 export const kCallbackPromise = Symbol('plt.kafka.callbackPromise')
@@ -13,7 +14,7 @@ export const noopCallback: CallbackWithPromise<any> = () => {
 export type CallbackWithPromise<ReturnType> = Callback<ReturnType> & { [kCallbackPromise]?: Promise<ReturnType> }
 
 export function createPromisifiedCallback<ReturnType> (): CallbackWithPromise<ReturnType> {
-  const { promise, resolve, reject } = Promise.withResolvers<ReturnType>()
+  const { promise, resolve, reject } = PromiseWithResolvers<ReturnType>()
 
   function callback (error?: Error | null, payload?: ReturnType): void {
     if (error) {
diff --git a/src/protocol/compression.ts b/src/protocol/compression.ts
@@ -5,7 +5,6 @@ import { DynamicBuffer } from './dynamic-buffer.ts'
 
 const require = createRequire(import.meta.url)
 
-// @ts-ignore - Added in Node.js 22.15.0
 const { zstdCompressSync, zstdDecompressSync, gzipSync, gunzipSync } = zlib
 
 export type SyncCompressionPhase = (data: Buffer | DynamicBuffer) => Buffer
diff --git a/src/utils.ts b/src/utils.ts
@@ -21,6 +21,20 @@ export type DebugDumpLogger = (...args: any[]) => void
 
 export { setTimeout as sleep } from 'node:timers/promises'
 
+function PromiseWithResolversPolyfill<T> (): PromiseWithResolvers<T> {
+  let resolve: (value: T | PromiseLike<T>) => void
+  let reject: (reason?: any) => void
+
+  const promise = new Promise<T>((_resolve, _reject) => {
+    resolve = _resolve
+    reject = _reject
+  })
+  // @ts-expect-error - resolve and reject are assigned in the promise constructor
+  return { promise, resolve, reject }
+}
+
+export const PromiseWithResolvers = Promise.withResolvers ? Promise.withResolvers.bind(Promise) : PromiseWithResolversPolyfill
+
 export const ajv = new Ajv2020({ allErrors: true, coerceTypes: false, strict: true })
 
 export const loggers: Record<string, debug.Debugger> = {
diff --git a/test/clients/consumer/messages-stream.test.ts b/test/clients/consumer/messages-stream.test.ts
@@ -24,6 +24,7 @@ import {
   ProduceAcks,
   Producer,
   type ProducerOptions,
+  PromiseWithResolvers,
   type Serializers,
   sleep,
   type StreamOptions,
@@ -153,7 +154,7 @@ async function consumeMessages<K = string, V = string, HK = string, HV = string>
   })
 
   const messages: Message<K, V, HK, HV>[] = []
-  const { promise, resolve, reject } = Promise.withResolvers<void>()
+  const { promise, resolve, reject } = PromiseWithResolvers<void>()
 
   function onData (message: Message<K, V, HK, HV>) {
     messages.push(message)
@@ -430,7 +431,7 @@ test('should consume messages with LATEST mode', async t => {
   // Verify no messages are returned initially
   strictEqual(messages.length, 0, 'Should consume 0 messages')
 
-  const { promise, resolve } = Promise.withResolvers<void>()
+  const { promise, resolve } = PromiseWithResolvers<void>()
   function onData (message: Message<string, string, string, string>) {
     messages.push(message)
 
diff --git a/test/config/env b/test/config/env
@@ -1 +1 @@
-NODE_OPTIONS="--experimental-strip-types --test-reporter=cleaner-spec-reporter --disable-warning=ExperimentalWarning"
+NODE_OPTIONS="--test-reporter=cleaner-spec-reporter"
diff --git a/test/network/connection-pool.test.ts b/test/network/connection-pool.test.ts
@@ -9,7 +9,8 @@ import {
   type ConnectionPoolDiagnosticEvent,
   connectionsPoolGetsChannel,
   ConnectionStatuses,
-  instancesChannel
+  instancesChannel,
+  PromiseWithResolvers
 } from '../../src/index.ts'
 import {
   createCreationChannelVerifier,
@@ -21,7 +22,7 @@ import {
 
 function createServer (t: TestContext): Promise<{ server: Server; port: number }> {
   const server = createNetworkServer()
-  const { promise, resolve, reject } = Promise.withResolvers<{ server: Server; port: number }>()
+  const { promise, resolve, reject } = PromiseWithResolvers<{ server: Server; port: number }>()
   const sockets: Socket[] = []
 
   server.once('listening', () => resolve({ server, port: (server.address() as AddressInfo).port }))
diff --git a/test/network/connection.test.ts b/test/network/connection.test.ts
diff --git a/test/protocol/sasl/scram-sha.test.ts b/test/protocol/sasl/scram-sha.test.ts
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -32,4 +32,4 @@ npm run lint`
`32`	`32`
`33`	`33`	`## Node Requirements`
`34`	`34`
`35`		`-- Node.js >= 22.14.0`
	`35`	`+- Node.js >= 20.19.4 or >= 22.18.0 or >= 24.6.0`