thread-stream 2.0.0 → 2.2.0

package/.husky/pre-commit

@@ -1,4 +1,4 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
 
 npm test

package/.taprc

@@ -1,3 +1,4 @@
 jobs: 1
 check-coverage: false
-timeout: 60000
+# in seconds
+timeout: 60

package/README.md

@@ -84,6 +84,31 @@ stream.end()
 
 This module works with `yarn` in PnP (plug'n play) mode too!
 
+### Emit events
+
+You can emit events on the ThreadStream from your worker using [`worker.parentPort.postMessage()`](https://nodejs.org/api/worker_threads.html#workerparentport).
+The message (JSON object) must have the following data structure:
+
+```js
+parentPort.postMessage({
+  code: 'EVENT',
+  name: 'eventName',
+  args: ['list', 'of', 'args', 123, new Error('Boom')]
+})
+```
+
+On your ThreadStream, you can add a listener function for this event name:
+
+```js
+const stream = new ThreadStream({
+  filename: join(__dirname, 'worker.js'),
+  workerData: {},
+})
+stream.on('eventName', function (a, b, c, n, err) {
+  console.log('received:', a, b, c, n, err) // received: list of args 123 Error: Boom
+})
+```
+
 ## License
 
 MIT

package/index.js

@@ -1,5 +1,6 @@
 'use strict'
 
+const { version } = require('./package.json')
 const { EventEmitter } = require('events')
 const { Worker } = require('worker_threads')
 const { join } = require('path')
@@ -29,6 +30,7 @@ class FakeWeakRef {
 
 const FinalizationRegistry = global.FinalizationRegistry || class FakeFinalizationRegistry {
   register () {}
+
   unregister () {}
 }
 
@@ -55,7 +57,12 @@ function createWorker (stream, opts) {
         : pathToFileURL(filename).href,
       dataBuf: stream[kImpl].dataBuf,
       stateBuf: stream[kImpl].stateBuf,
-      workerData
+      workerData: {
+        $context: {
+          threadStreamVersion: version
+        },
+        ...workerData
+      }
     }
   })
 
@@ -163,6 +170,13 @@ function onWorkerMessage (msg) {
     case 'ERROR':
       destroy(stream, msg.err)
       break
+    case 'EVENT':
+      if (Array.isArray(msg.args)) {
+        stream.emit(msg.name, ...msg.args)
+      } else {
+        stream.emit(msg.name, msg.args)
+      }
+      break
     default:
       destroy(stream, new Error('this should not happen: ' + msg.code))
   }

package/lib/worker.js

@@ -17,7 +17,7 @@ const state = new Int32Array(stateBuf)
 const data = Buffer.from(dataBuf)
 
 async function start () {
-  let fn
+  let worker
   try {
     if (filename.endsWith('.ts') || filename.endsWith('.cts')) {
       // TODO: add support for the TSM modules loader ( https://github.com/lukeed/tsm ).
@@ -28,9 +28,9 @@ async function start () {
       }
       // TODO: Support ES imports once tsc, tap & ts-node provide better compatibility guarantees.
       // Remove extra forwardslash on Windows
-      fn = realRequire(decodeURIComponent(filename.replace(process.platform === 'win32' ? 'file:///' : 'file://', '')))
+      worker = realRequire(decodeURIComponent(filename.replace(process.platform === 'win32' ? 'file:///' : 'file://', '')))
     } else {
-      fn = (await realImport(filename))
+      worker = (await realImport(filename))
     }
   } catch (error) {
     // A yarn user that tries to start a ThreadStream for an external module
@@ -43,7 +43,10 @@ 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') &&
      filename.startsWith('file://')) {
-      fn = realRequire(decodeURIComponent(filename.replace('file://', '')))
+      worker = realRequire(decodeURIComponent(filename.replace('file://', '')))
+    } else if (error.code === undefined) {
+      // When bundled with pkg, an undefined error is thrown when called with realImport
+      worker = realRequire(decodeURIComponent(filename.replace(process.platform === 'win32' ? 'file:///' : 'file://', '')))
     } else {
       throw error
     }
@@ -52,10 +55,10 @@ async function start () {
   // Depending on how the default export is performed, and on how the code is
   // transpiled, we may find cases of two nested "default" objects.
   // See https://github.com/pinojs/pino/issues/1243#issuecomment-982774762
-  if (typeof fn === 'object') fn = fn.default
-  if (typeof fn === 'object') fn = fn.default
+  if (typeof worker === 'object') worker = worker.default
+  if (typeof worker === 'object') worker = worker.default
 
-  destination = await fn(workerData.workerData)
+  destination = await worker(workerData.workerData)
 
   destination.on('error', function (err) {
     Atomics.store(state, WRITE_INDEX, -2)

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "thread-stream",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "A streaming way to send data to a Node.js Worker Thread",
   "main": "index.js",
   "types": "index.d.ts",
   "dependencies": {
-    "real-require": "^0.1.0"
+    "real-require": "^0.2.0"
   },
   "devDependencies": {
     "@types/node": "^18.0.0",

package/test/bundlers.test.js

@@ -5,7 +5,7 @@ const { join } = require('path')
 const { file } = require('./helper')
 const ThreadStream = require('..')
 
-test('bundlers support', function (t) {
+test('bundlers support with .js file', function (t) {
   t.plan(1)
 
   globalThis.__bundlerPathsOverrides = {
@@ -31,3 +31,30 @@ test('bundlers support', function (t) {
 
   stream.end()
 })
+
+test('bundlers support with .mjs 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.mjs'),
+    workerData: { dest },
+    sync: true
+  })
+
+  stream.worker.removeAllListeners('message')
+  stream.worker.once('message', message => {
+    t.equal(message.code, 'CUSTOM-WORKER-CALLED')
+  })
+
+  stream.end()
+})

package/test/context.test.js

@@ -0,0 +1,21 @@
+'use strict'
+
+const { test } = require('tap')
+const { join } = require('path')
+const ThreadStream = require('..')
+const { version } = require('../package.json')
+require('why-is-node-running')
+
+test('get context', (t) => {
+  const stream = new ThreadStream({
+    filename: join(__dirname, 'get-context.js'),
+    workerData: {},
+    sync: true
+  })
+  t.on('end', () => stream.end())
+  stream.on('context', (ctx) => {
+    t.same(ctx.threadStreamVersion, version)
+    t.end()
+  })
+  stream.write('hello')
+})

package/test/emit-event.js

@@ -0,0 +1,22 @@
+'use strict'
+
+const { Writable } = require('stream')
+const parentPort = require('worker_threads').parentPort
+
+async function run () {
+  return new Writable({
+    autoDestroy: true,
+    write (chunk, enc, cb) {
+      if (parentPort) {
+        parentPort.postMessage({
+          code: 'EVENT',
+          name: 'socketError',
+          args: ['list', 'of', 'args', 123, new Error('unable to write data to the TCP socket')]
+        })
+      }
+      cb()
+    }
+  })
+}
+
+module.exports = run

package/test/event.test.js

@@ -0,0 +1,24 @@
+'use strict'
+
+const { test } = require('tap')
+const { join } = require('path')
+const ThreadStream = require('..')
+require('why-is-node-running')
+
+test('event propagate', (t) => {
+  const stream = new ThreadStream({
+    filename: join(__dirname, 'emit-event.js'),
+    workerData: {},
+    sync: true
+  })
+  t.on('end', () => stream.end())
+  stream.on('socketError', function (a, b, c, n, error) {
+    t.same(a, 'list')
+    t.same(b, 'of')
+    t.same(c, 'args')
+    t.same(n, 123)
+    t.same(error, new Error('unable to write data to the TCP socket'))
+    t.end()
+  })
+  stream.write('hello')
+})

package/test/get-context.js

@@ -0,0 +1,22 @@
+'use strict'
+
+const { Writable } = require('stream')
+const parentPort = require('worker_threads').parentPort
+
+async function run (opts) {
+  return new Writable({
+    autoDestroy: true,
+    write (chunk, enc, cb) {
+      if (parentPort) {
+        parentPort.postMessage({
+          code: 'EVENT',
+          name: 'context',
+          args: opts.$context
+        })
+      }
+      cb()
+    }
+  })
+}
+
+module.exports = run

package/test/{indexes.js → indexes.test.js}

@@ -1,6 +1,6 @@
 'use strict'
 
-const test = require('tape')
+const { test } = require('tap')
 const indexes = require('../lib/indexes')
 
 for (const index of Object.keys(indexes)) {