thread-stream 2.6.0 → 3.0.0

package/.github/workflows/ci.yml

@@ -38,11 +38,11 @@ jobs:
       contents: read
     strategy:
       matrix:
-        node-version: [14, 16, 18]
+        node-version: [18, 20, 22]
         os: [macos-latest, ubuntu-latest, windows-latest]
         exclude:
           - os: windows-latest
-            node-version: 14
+            node-version: 22
 
     steps:
       - name: Check out repo

package/lib/worker.js

@@ -44,8 +44,10 @@ async function start () {
     if ((error.code === 'ENOTDIR' || error.code === 'ERR_MODULE_NOT_FOUND') &&
      filename.startsWith('file://')) {
       worker = realRequire(decodeURIComponent(filename.replace('file://', '')))
-    } else if (error.code === undefined) {
+    } else if (error.code === undefined || error.code === 'ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING') {
       // When bundled with pkg, an undefined error is thrown when called with realImport
+      // When bundled with pkg and using node v20, an ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING error is thrown when called with realImport
+      // More info at: https://github.com/pinojs/thread-stream/issues/143
       worker = realRequire(decodeURIComponent(filename.replace(process.platform === 'win32' ? 'file:///' : 'file://', '')))
     } else {
       throw error
@@ -157,7 +159,6 @@ process.once('exit', exitCode => {
     process.exit(exitCode)
     return
   }
-
   if (destination?.writableNeedDrain && !destination?.writableEnded) {
     parentPort.postMessage({
       code: 'WARNING',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "thread-stream",
-  "version": "2.6.0",
+  "version": "3.0.0",
   "description": "A streaming way to send data to a Node.js Worker Thread",
   "main": "index.js",
   "types": "index.d.ts",
@@ -10,6 +10,7 @@
   "devDependencies": {
     "@types/node": "^20.1.0",
     "@types/tap": "^15.0.0",
+    "@yao-pkg/pkg": "^5.11.5",
     "desm": "^1.3.0",
     "fastbench": "^1.0.1",
     "husky": "^9.0.6",
@@ -22,9 +23,9 @@
     "why-is-node-running": "^2.2.2"
   },
   "scripts": {
-    "test": "standard && npm run transpile && tap test/*.test.*js && tap --ts test/*.test.*ts",
+    "test": "standard && npm run transpile && tap \"test/**/*.test.*js\" && tap --ts test/*.test.*ts",
     "test:ci": "standard && npm run transpile && npm run test:ci:js && npm run test:ci:ts",
-    "test:ci:js": "tap --no-check-coverage --coverage-report=lcovonly \"test/**/*.test.*js\"",
+    "test:ci:js": "tap --no-check-coverage --timeout=120 --coverage-report=lcovonly \"test/**/*.test.*js\"",
     "test:ci:ts": "tap --ts --no-check-coverage --coverage-report=lcovonly \"test/**/*.test.*ts\"",
     "test:yarn": "npm run transpile && tap \"test/**/*.test.js\" --no-check-coverage",
     "transpile": "sh ./test/ts/transpile.sh",

package/test/never-drain.test.js

@@ -22,7 +22,9 @@ function retryUntilTimeout (fn, timeout) {
   })
 }
 
-test('emit warning when the worker gracefully exit without the stream ended', async function (t) {
+const isNode18 = process.version.indexOf('v18') === 0
+
+test('emit warning when the worker gracefully exit without the stream ended', { skip: !isNode18 }, async function (t) {
   const expectedWarning = 'ThreadStream: process exited before destination stream was drained. this may indicate that the destination stream try to write to a another missing stream'
   const stream = new ThreadStream({
     filename: join(__dirname, 'to-next.js')

package/test/pkg/index.js

@@ -0,0 +1,37 @@
+'use strict'
+
+/**
+ * This file is packaged using pkg in order to test if worker.js works in that context
+ */
+
+const { test } = require('tap')
+const { join } = require('path')
+const { file } = require('../helper')
+const ThreadStream = require('../..')
+
+test('bundlers support with .js file', function (t) {
+  t.plan(1)
+
+  globalThis.__bundlerPathsOverrides = {
+    'thread-stream-worker': join(__dirname, '..', 'custom-worker.js')
+  }
+
+  const dest = file()
+
+  process.on('uncaughtException', (error) => {
+    console.log(error)
+  })
+
+  const stream = new ThreadStream({
+    filename: join(__dirname, '..', 'to-file.js'),
+    workerData: { dest },
+    sync: true
+  })
+
+  stream.worker.removeAllListeners('message')
+  stream.worker.once('message', (message) => {
+    t.equal(message.code, 'CUSTOM-WORKER-CALLED')
+  })
+
+  stream.end()
+})

package/test/pkg/pkg.config.json

@@ -0,0 +1,15 @@
+{
+    "pkg": {
+        "assets": [
+            "../custom-worker.js",
+            "../to-file.js"
+        ],
+        "targets": [
+            "node14",
+            "node16",
+            "node18",
+            "node20"
+        ],
+        "outputPath": "test/pkg"
+    }
+}

package/test/pkg/pkg.test.js

@@ -0,0 +1,46 @@
+'use strict'
+
+const { test } = require('tap')
+const config = require('./pkg.config.json')
+const { promisify } = require('util')
+const { unlink } = require('fs/promises')
+const { join } = require('path')
+const { platform } = require('process')
+const exec = promisify(require('child_process').exec)
+
+test('worker test when packaged into executable using pkg', async (t) => {
+  const packageName = 'index'
+
+  // package the app into several node versions, check config for more info
+  const filePath = `${join(__dirname, packageName)}.js`
+  const configPath = join(__dirname, 'pkg.config.json')
+  process.env.NODE_OPTIONS ||= ''
+  process.env.NODE_OPTIONS = '--no-warnings'
+  const { stderr } = await exec(`npx pkg ${filePath} --config ${configPath}`)
+
+  // there should be no error when packaging
+  t.equal(stderr, '')
+
+  // pkg outputs files in the following format by default: {filename}-{node version}
+  for (const target of config.pkg.targets) {
+    // execute the packaged test
+    let executablePath = `${join(config.pkg.outputPath, packageName)}-${target}`
+
+    // when on windows, we need the .exe extension
+    if (platform === 'win32') {
+      executablePath = `${executablePath}.exe`
+    } else {
+      executablePath = `./${executablePath}`
+    }
+
+    const { stderr } = await exec(executablePath)
+
+    // check if there were no errors
+    t.equal(stderr, '')
+
+    // clean up afterwards
+    await unlink(executablePath)
+  }
+
+  t.end()
+})

package/.github/workflows/package-manager-ci.yml

@@ -1,62 +0,0 @@
-name: package-manager-ci
-on:
-  push:
-    paths-ignore:
-      - 'docs/**'
-      - '*.md'
-  pull_request:
-    paths-ignore:
-      - 'docs/**'
-      - '*.md'
-jobs:
-  pnpm:
-    name: pnpm package manager on ${{ matrix.node-version }} ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        node-version: [14, 16, 18]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Use pnpm
-        uses: pnpm/action-setup@v3.0.0
-        with:
-          version: ^6.0.0
-      - name: Install dependancies
-        run: pnpm install
-      - name: Tests
-        shell: bash
-        run: pnpm run test:ci
-
-  yarn-pnp:
-    name: yarn-pnp package manager on ${{ matrix.node-version }} ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        node-version: [14, 16, 18]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Use yarn
-        run: |
-          npm install -g yarn
-          yarn set version berry
-          cat test/yarnrc.yml >> .yarnrc.yml
-          yarn add -D pino-elasticsearch@^6.0.0
-          yarn install
-        env:
-          # needed due the yarn.lock file in repository's .gitignore
-          YARN_ENABLE_IMMUTABLE_INSTALLS: 'false'
-      - name: Tests
-        shell: bash
-        run: yarn run test:yarn
-        env:
-          SKIP_PROCESS_EXIT_CHECK: 'true'