thread-stream 0.13.0 → 0.14.0

package/.github/dependabot.yml

@@ -1,12 +1,13 @@
 version: 2
 updates:
-- package-ecosystem: github-actions
-  directory: '/'
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-- package-ecosystem: npm
-  directory: '/'
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10

package/.github/workflows/ci.yml

@@ -19,10 +19,10 @@ jobs:
 
     steps:
 
-      - uses: actions/checkout@v2.4.0
+      - uses: actions/checkout@v3
 
       - name: Use Node.js
-        uses: actions/setup-node@v2.4.1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -55,6 +55,6 @@ jobs:
     needs: test
     runs-on: ubuntu-latest
     steps:
-      - uses: fastify/github-action-merge-dependabot@v2.5.0
+      - uses: fastify/github-action-merge-dependabot@v2.7.1
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}

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

@@ -17,13 +17,13 @@ jobs:
         os: [macOS-latest, windows-latest]
         node-version: [12, 14, 16]
     steps:
-      - uses: actions/checkout@v2.4.0
+      - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2.4.1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
       - name: Use pnpm
-        uses: pnpm/action-setup@v2.0.1
+        uses: pnpm/action-setup@v2.2.1
         with:
           version: ^6.0.0
       - name: Install dependancies
@@ -39,9 +39,9 @@ jobs:
         os: [macOS-latest]
         node-version: [12, 14, 16]
     steps:
-      - uses: actions/checkout@v2.4.0
+      - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2.4.1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
       - name: Use yarn

package/.taprc

@@ -1,2 +1,3 @@
 jobs: 1
 check-coverage: false
+timeout: 60000

package/index.js

@@ -104,13 +104,18 @@ function nextFlush (stream) {
     } else {
       // multi-byte utf-8
       stream.flush(() => {
+        // err is already handled in flush()
+        if (stream.destroyed) {
+          return
+        }
+
         Atomics.store(stream[kImpl].state, READ_INDEX, 0)
         Atomics.store(stream[kImpl].state, WRITE_INDEX, 0)
 
         // Find a toWrite length that fits the buffer
         // it must exists as the buffer is at least 4 bytes length
         // and the max utf-8 length for a char is 4 bytes.
-        while (toWriteBytes > stream[kImpl].buf.length) {
+        while (toWriteBytes > stream[kImpl].data.length) {
           leftover = leftover / 2
           toWrite = stream[kImpl].buf.slice(0, leftover)
           toWriteBytes = Buffer.byteLength(toWrite)
@@ -255,7 +260,10 @@ class ThreadStream extends EventEmitter {
 
   flush (cb) {
     if (this[kImpl].destroyed) {
-      throw new Error('the worker has exited')
+      if (typeof cb === 'function') {
+        process.nextTick(cb, new Error('the worker has exited'))
+      }
+      return
     }
 
     // TODO write all .buf

package/lib/worker.js

@@ -30,7 +30,7 @@ async function start () {
     // The error codes may change based on the node.js version (ENOTDIR > 12, ERR_MODULE_NOT_FOUND <= 12 )
     if ((error.code === 'ENOTDIR' || error.code === 'ERR_MODULE_NOT_FOUND') &&
      workerData.filename.startsWith('file://')) {
-      fn = realRequire(workerData.filename.replace('file://', ''))
+      fn = realRequire(decodeURIComponent(workerData.filename.replace('file://', '')))
     } else {
       throw error
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "thread-stream",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "A streaming way to send data to a Node.js Worker Thread",
   "main": "index.js",
   "dependencies": {
@@ -12,7 +12,7 @@
     "husky": "^7.0.0",
     "sonic-boom": "^2.0.1",
     "standard": "^16.0.3",
-    "tap": "^15.0.0",
+    "tap": "^16.0.0",
     "why-is-node-running": "^2.2.0"
   },
   "scripts": {

package/test/base.test.js

@@ -246,3 +246,26 @@ test('pass down MessagePorts', async function (t) {
 
   t.equal(strings, 'hello world\nsomething else\n')
 })
+
+test('destroy does not error', function (t) {
+  t.plan(3)
+
+  const dest = file()
+  const stream = new ThreadStream({
+    filename: join(__dirname, 'to-file.js'),
+    workerData: { dest },
+    sync: false
+  })
+
+  stream.on('ready', () => {
+    t.pass('ready emitted')
+    stream.worker.terminate()
+  })
+
+  stream.on('error', (err) => {
+    t.equal(err.message, 'The worker thread exited')
+    stream.flush((err) => {
+      t.equal(err.message, 'the worker has exited')
+    })
+  })
+})

package/test/commonjs-fallback.test.js

@@ -1,6 +1,9 @@
 'use strict'
 
 const { test } = require('tap')
+const { join } = require('path')
+const { MessageChannel } = require('worker_threads')
+const { once } = require('events')
 const ThreadStream = require('..')
 
 const isYarnPnp = process.versions.pnp !== undefined
@@ -27,3 +30,27 @@ test('yarn module resolution', { skip: !isYarnPnp }, t => {
   t.ok(stream.writable)
   stream.end()
 })
+
+test('yarn module resolution for directories with special characters', { skip: !isYarnPnp }, async t => {
+  t.plan(3)
+
+  const { port1, port2 } = new MessageChannel()
+  const stream = new ThreadStream({
+    filename: join(__dirname, 'dir with spaces', 'test-package.zip', 'worker.js'),
+    workerData: { port: port1 },
+    workerOpts: {
+      transferList: [port1]
+    },
+    sync: false
+  })
+  t.teardown(() => {
+    stream.end()
+  })
+
+  t.ok(stream.write('hello world\n'))
+  t.ok(stream.write('something else\n'))
+
+  const [strings] = await once(port2, 'message')
+
+  t.equal(strings, 'hello world\nsomething else\n')
+})

package/test/multibyte-chars.test.mjs

@@ -49,3 +49,26 @@ test('break up utf8 multibyte (async)', (t) => {
   stream.write(longString)
   stream.end()
 })
+
+test('break up utf8 multibyte several times bigger than write buffer', (t) => {
+  t.plan(2)
+  const longString = '\u03A3'.repeat(32)
+
+  const dest = file()
+  const stream = new ThreadStream({
+    bufferSize: 15, // this must be odd
+    filename: join(import.meta.url, 'to-file.js'),
+    workerData: { dest },
+    sync: false
+  })
+
+  stream.on('finish', () => {
+    readFile(dest, 'utf8', (err, data) => {
+      t.error(err)
+      t.equal(data, longString)
+    })
+  })
+
+  stream.write(longString)
+  stream.end()
+})

package/test/string-limit-2.test.js

@@ -0,0 +1,35 @@
+'use strict'
+
+const t = require('tap')
+const { join } = require('path')
+const { file } = require('./helper')
+const { createReadStream } = require('fs')
+const ThreadStream = require('..')
+const buffer = require('buffer')
+
+const MAX_STRING = buffer.constants.MAX_STRING_LENGTH
+
+t.plan(1)
+
+const dest = file()
+const stream = new ThreadStream({
+  filename: join(__dirname, 'to-file.js'),
+  workerData: { dest },
+  sync: false
+})
+
+stream.on('close', async () => {
+  t.comment('close emitted')
+  let buf
+  for await (const chunk of createReadStream(dest)) {
+    buf = chunk
+  }
+  t.equal('asd', buf.toString().slice(-3))
+})
+
+stream.on('ready', () => {
+  t.comment('open emitted')
+  stream.write('a'.repeat(MAX_STRING - 2))
+  stream.write('asd')
+  stream.end()
+})