thread-stream 2.2.0 → 2.4.0

package/.github/workflows/ci.yml

@@ -29,7 +29,7 @@ jobs:
           persist-credentials: false
 
       - name: Dependency review
-        uses: actions/dependency-review-action@v2
+        uses: actions/dependency-review-action@v3
 
   test:
     name: Test
@@ -40,6 +40,10 @@ jobs:
       matrix:
         node-version: [14, 16, 18]
         os: [macos-latest, ubuntu-latest, windows-latest]
+        exclude:
+          - os: windows-latest
+            node-version: 14
+
     steps:
       - name: Check out repo
         uses: actions/checkout@v3

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

@@ -2,12 +2,12 @@ name: package-manager-ci
 on:
   push:
     paths-ignore:
-        - 'docs/**'
-        - '*.md'
+      - 'docs/**'
+      - '*.md'
   pull_request:
     paths-ignore:
-        - 'docs/**'
-        - '*.md'
+      - 'docs/**'
+      - '*.md'
 jobs:
   pnpm:
     name: pnpm package manager on ${{ matrix.node-version }} ${{ matrix.os }}
@@ -23,7 +23,7 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - name: Use pnpm
-        uses: pnpm/action-setup@v2.2.2
+        uses: pnpm/action-setup@v2.2.4
         with:
           version: ^6.0.0
       - name: Install dependancies
@@ -49,14 +49,14 @@ jobs:
         run: |
           npm install -g yarn
           yarn set version berry
-          echo "nodeLinker: pnp" >> .yarnrc.yml
-          echo "pnpMode: loose" >> .yarnrc.yml
-          echo "pnpEnableEsmLoader: false" >> .yarnrc.yml
+          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
+          YARN_ENABLE_IMMUTABLE_INSTALLS: 'false'
       - name: Tests
         shell: bash
         run: yarn run test:yarn
+        env:
+          SKIP_PROCESS_EXIT_CHECK: 'true'

package/bench.js

@@ -30,7 +30,7 @@ const MAX = 10000
 
 let str = ''
 
-for (let i = 0; i < 10; i++) {
+for (let i = 0; i < 100; i++) {
   str += 'hello'
 }
 

package/index.js

@@ -51,6 +51,7 @@ function createWorker (stream, opts) {
 
   const worker = new Worker(toExecute, {
     ...opts.workerOpts,
+    trackUnmanagedFds: false,
     workerData: {
       filename: filename.indexOf('file://') === 0
         ? filename
@@ -177,6 +178,9 @@ function onWorkerMessage (msg) {
         stream.emit(msg.name, msg.args)
       }
       break
+    case 'WARNING':
+      process.emitWarning(msg.err)
+      break
     default:
       destroy(stream, new Error('this should not happen: ' + msg.code))
   }

package/lib/worker.js

@@ -151,3 +151,19 @@ process.on('uncaughtException', function (err) {
   })
   process.exit(1)
 })
+
+process.once('exit', exitCode => {
+  if (exitCode !== 0) {
+    process.exit(exitCode)
+    return
+  }
+
+  if (destination?.writableNeedDrain && !destination?.writableEnded) {
+    parentPort.postMessage({
+      code: 'WARNING',
+      err: new Error('ThreadStream: process exited before destination stream was drained. this may indicate that the destination stream try to write to a another missing stream')
+    })
+  }
+
+  process.exit(0)
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "thread-stream",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "description": "A streaming way to send data to a Node.js Worker Thread",
   "main": "index.js",
   "types": "index.d.ts",
@@ -8,11 +8,12 @@
     "real-require": "^0.2.0"
   },
   "devDependencies": {
-    "@types/node": "^18.0.0",
+    "@types/node": "^20.1.0",
     "@types/tap": "^15.0.0",
     "desm": "^1.3.0",
     "fastbench": "^1.0.1",
     "husky": "^8.0.1",
+    "pino-elasticsearch": "^6.0.0",
     "sonic-boom": "^3.0.0",
     "standard": "^17.0.0",
     "tap": "^16.2.0",
@@ -29,7 +30,11 @@
     "transpile": "sh ./test/ts/transpile.sh",
     "prepare": "husky install"
   },
-  "standard": { "ignore": ["test/ts/**/*"] },
+  "standard": {
+    "ignore": [
+      "test/ts/**/*"
+    ]
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mcollina/thread-stream.git"

package/test/event.test.js

@@ -3,9 +3,8 @@
 const { test } = require('tap')
 const { join } = require('path')
 const ThreadStream = require('..')
-require('why-is-node-running')
 
-test('event propagate', (t) => {
+test('event propagate', t => {
   const stream = new ThreadStream({
     filename: join(__dirname, 'emit-event.js'),
     workerData: {},

package/test/helper.js

@@ -3,7 +3,6 @@
 const { join } = require('path')
 const { tmpdir } = require('os')
 const { unlinkSync } = require('fs')
-const why = require('why-is-node-running')
 const t = require('tap')
 
 const files = []
@@ -30,4 +29,7 @@ process.on('beforeExit', () => {
 
 module.exports.file = file
 
-setInterval(why, 10000).unref()
+if (process.env.SKIP_PROCESS_EXIT_CHECK !== 'true') {
+  const why = require('why-is-node-running')
+  setInterval(why, 10000).unref()
+}

package/test/never-drain.test.js

@@ -0,0 +1,55 @@
+const { test } = require('tap')
+const ThreadStream = require('../index')
+const { join } = require('path')
+
+function retryUntilTimeout (fn, timeout) {
+  const start = Date.now()
+  return new Promise((resolve, reject) => {
+    async function run () {
+      if (fn()) {
+        resolve()
+        return
+      }
+
+      if (Date.now() - start >= timeout) {
+        reject(new Error('timeout'))
+        return
+      }
+      setTimeout(run, 10)
+    }
+
+    run()
+  })
+}
+
+test('emit warning when the worker gracefully exit without the stream ended', 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')
+  })
+  stream.unref()
+
+  let streamWarning
+  function saveWarning (e) {
+    if (e.message === expectedWarning) {
+      streamWarning = e
+    }
+  }
+  process.on('warning', saveWarning)
+
+  const data = 'hello'.repeat(10)
+  for (let i = 0; i < 1000; i++) {
+    if (streamWarning?.message === expectedWarning) {
+      break
+    }
+    stream.write(data)
+    await new Promise((resolve) => {
+      setTimeout(resolve, 1)
+    })
+  }
+
+  process.off('warning', saveWarning)
+  t.equal(streamWarning?.message, expectedWarning)
+
+  await retryUntilTimeout(() => stream.worker.exited === true, 3000)
+})

package/test/to-next.js

@@ -0,0 +1,9 @@
+'use strict'
+
+const { PassThrough } = require('stream')
+
+async function run (opts) {
+  return new PassThrough({})
+}
+
+module.exports = run

package/test/ts/transpile.sh

@@ -10,10 +10,10 @@ else
   export RUNNER="npx";
 fi
 
-test ./to-file.ts -ot ./to-file.es5.cjs    || ("${RUNNER}" tsc --target es5                      ./to-file.ts && mv ./to-file.js ./to-file.es5.cjs);
-test ./to-file.ts -ot ./to-file.es6.mjs    || ("${RUNNER}" tsc --target es6                      ./to-file.ts && mv ./to-file.js ./to-file.es6.mjs);
-test ./to-file.ts -ot ./to-file.es6.cjs    || ("${RUNNER}" tsc --target es6    --module commonjs ./to-file.ts && mv ./to-file.js ./to-file.es6.cjs);
-test ./to-file.ts -ot ./to-file.es2017.mjs || ("${RUNNER}" tsc --target es2017                   ./to-file.ts && mv ./to-file.js ./to-file.es2017.mjs);
-test ./to-file.ts -ot ./to-file.es2017.cjs || ("${RUNNER}" tsc --target es2017 --module commonjs ./to-file.ts && mv ./to-file.js ./to-file.es2017.cjs);
-test ./to-file.ts -ot ./to-file.esnext.mjs || ("${RUNNER}" tsc --target esnext --module esnext   ./to-file.ts && mv ./to-file.js ./to-file.esnext.mjs);
-test ./to-file.ts -ot ./to-file.esnext.cjs || ("${RUNNER}" tsc --target esnext --module commonjs ./to-file.ts && mv ./to-file.js ./to-file.esnext.cjs);
+test ./to-file.ts -ot ./to-file.es5.cjs    || ("${RUNNER}" tsc --skipLibCheck --target es5                      ./to-file.ts && mv ./to-file.js ./to-file.es5.cjs);
+test ./to-file.ts -ot ./to-file.es6.mjs    || ("${RUNNER}" tsc --skipLibCheck --target es6                      ./to-file.ts && mv ./to-file.js ./to-file.es6.mjs);
+test ./to-file.ts -ot ./to-file.es6.cjs    || ("${RUNNER}" tsc --skipLibCheck --target es6    --module commonjs ./to-file.ts && mv ./to-file.js ./to-file.es6.cjs);
+test ./to-file.ts -ot ./to-file.es2017.mjs || ("${RUNNER}" tsc --skipLibCheck --target es2017                   ./to-file.ts && mv ./to-file.js ./to-file.es2017.mjs);
+test ./to-file.ts -ot ./to-file.es2017.cjs || ("${RUNNER}" tsc --skipLibCheck --target es2017 --module commonjs ./to-file.ts && mv ./to-file.js ./to-file.es2017.cjs);
+test ./to-file.ts -ot ./to-file.esnext.mjs || ("${RUNNER}" tsc --skipLibCheck --target esnext --module esnext   ./to-file.ts && mv ./to-file.js ./to-file.esnext.mjs);
+test ./to-file.ts -ot ./to-file.esnext.cjs || ("${RUNNER}" tsc --skipLibCheck --target esnext --module commonjs ./to-file.ts && mv ./to-file.js ./to-file.esnext.cjs);

package/test/yarnrc.yml

@@ -0,0 +1,7 @@
+nodeLinker: pnp
+pnpMode: loose
+pnpEnableEsmLoader: false
+packageExtensions:
+  debug@*:
+    dependencies:
+      supports-color: '*'