thread-stream 0.13.1 → 0.15.0

package/.github/dependabot.yml

@@ -1,16 +1,13 @@
 version: 2
 updates:
-- package-ecosystem: github-actions
-  directory: '/'
-  ignore:
-      - dependency-name: 'actions/*'
-        update-types:
-            ['version-update:semver-minor', 'version-update:semver-patch']
-  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
+      - uses: actions/checkout@v3
 
       - name: Use Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -31,6 +31,7 @@ jobs:
           npm install --ignore-scripts
 
       - name: Run tests
+        shell: bash
         run: |
           npm run test:ci
 

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

@@ -17,18 +17,19 @@ jobs:
         os: [macOS-latest, windows-latest]
         node-version: [12, 14, 16]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        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
         run: pnpm install
       - name: Tests
+        shell: bash
         run: pnpm run test:ci
 
   yarn-pnp:
@@ -39,9 +40,9 @@ jobs:
         os: [macOS-latest]
         node-version: [12, 14, 16]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
       - name: Use yarn
@@ -56,4 +57,5 @@ jobs:
           # needed due the yarn.lock file in repository's .gitignore
           YARN_ENABLE_IMMUTABLE_INSTALLS: false
       - name: Tests
+        shell: bash
         run: yarn run test:yarn

package/.taprc

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

package/index.d.ts

@@ -0,0 +1,9 @@
+import { EventEmitter } from 'events'
+
+declare class ThreadStream extends EventEmitter {
+  constructor(opts: {})
+  write (data: string): boolean
+  end (): void
+}
+
+export = ThreadStream;

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

@@ -7,6 +7,7 @@ const { waitDiff } = require('./wait')
 
 const {
   dataBuf,
+  filename,
   stateBuf
 } = workerData
 
@@ -18,7 +19,25 @@ const data = Buffer.from(dataBuf)
 async function start () {
   let fn
   try {
-    fn = (await realImport(workerData.filename)).default
+    // TODO: fix loading .ts files in Windows. See: ../test/ts.test.ts
+    if (filename.endsWith('.ts') || filename.endsWith('.cts')) {
+      // TODO: add support for the TSM modules loader ( https://github.com/lukeed/tsm ).
+      if (process[Symbol.for('ts-node.register.instance')]) {
+        realRequire('ts-node/register')
+      } else if (process.env.TS_NODE_DEV) {
+        realRequire('ts-node-dev')
+      }
+      // TODO: Support ES imports once tsc, tap & ts-node provide better compatibility guarantees.
+      fn = realRequire(decodeURIComponent(filename.replace('file://', '')))
+    } else {
+      fn = (await realImport(filename))
+    }
+
+    // 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
   } catch (error) {
     // A yarn user that tries to start a ThreadStream for an external module
     // provides a filename pointing to a zip file.
@@ -29,8 +48,8 @@ async function start () {
     // More details at https://github.com/pinojs/pino/pull/1113
     // 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(decodeURIComponent(workerData.filename.replace('file://', '')))
+     filename.startsWith('file://')) {
+      fn = realRequire(decodeURIComponent(filename.replace('file://', '')))
     } else {
       throw error
     }

package/package.json

@@ -1,26 +1,34 @@
 {
   "name": "thread-stream",
-  "version": "0.13.1",
+  "version": "0.15.0",
   "description": "A streaming way to send data to a Node.js Worker Thread",
   "main": "index.js",
   "dependencies": {
     "real-require": "^0.1.0"
   },
   "devDependencies": {
+    "@types/node": "^12.0.0",
+    "@types/tap": "^15.0.0",
     "desm": "^1.1.0",
     "fastbench": "^1.0.1",
     "husky": "^7.0.0",
     "sonic-boom": "^2.0.1",
     "standard": "^16.0.3",
-    "tap": "^15.0.0",
+    "tap": "^16.0.0",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.0",
     "why-is-node-running": "^2.2.0"
   },
   "scripts": {
-    "test": "standard && tap test/*.test.*js",
-    "test:ci": "standard && tap \"test/**/*.test.*js\" --no-check-coverage --coverage-report=lcovonly",
-    "test:yarn": "tap \"test/**/*.test.js\" --no-check-coverage",
+    "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: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",
     "prepare": "husky install"
   },
+  "standard": { "ignore": ["test/ts/**/*"] },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mcollina/thread-stream.git"

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/esm.test.mjs

@@ -36,3 +36,12 @@ function basic (text, filename) {
 
 basic('esm with path', join(import.meta.url, 'to-file.mjs'))
 basic('esm with file URL', pathToFileURL(join(import.meta.url, 'to-file.mjs')).href)
+
+basic('(ts -> es6) esm with path', join(import.meta.url, 'ts', 'to-file.es6.mjs'))
+basic('(ts -> es6) esm with file URL', pathToFileURL(join(import.meta.url, 'ts', 'to-file.es6.mjs')).href)
+
+basic('(ts -> es2017) esm with path', join(import.meta.url, 'ts', 'to-file.es2017.mjs'))
+basic('(ts -> es2017) esm with file URL', pathToFileURL(join(import.meta.url, 'ts', 'to-file.es2017.mjs')).href)
+
+basic('(ts -> esnext) esm with path', join(import.meta.url, 'ts', 'to-file.esnext.mjs'))
+basic('(ts -> esnext) esm with file URL', pathToFileURL(join(import.meta.url, 'ts', 'to-file.esnext.mjs')).href)

package/test/helper.d.ts

@@ -0,0 +1 @@
+export declare function file(): string

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()
+})

package/test/transpiled.test.js

@@ -0,0 +1,30 @@
+'use strict'
+
+const { test } = require('tap')
+const { join } = require('path')
+const { file } = require('./helper')
+const ThreadStream = require('..')
+
+function basic (esVersion) {
+  test(`transpiled-ts-to-${esVersion}`, function (t) {
+    t.plan(2)
+
+    const dest = file()
+    const stream = new ThreadStream({
+      filename: join(__dirname, 'ts', `to-file.${esVersion}.cjs`),
+      workerData: { dest },
+      sync: true
+    })
+
+    // There are arbitrary checks, the important aspect of this test is to ensure
+    // that we can properly load the transpiled file into our worker thread.
+    t.same(stream.writableEnded, false)
+    stream.end()
+    t.same(stream.writableEnded, true)
+  })
+}
+
+basic('es5')
+basic('es6')
+basic('es2017')
+basic('esnext')

package/test/ts/to-file.ts

@@ -0,0 +1,10 @@
+import { type PathLike, type WriteStream, createWriteStream } from 'fs'
+import { once } from 'events'
+
+export default async function run (
+  opts: { dest: PathLike },
+): Promise<WriteStream> {
+  const stream = createWriteStream(opts.dest)
+  await once(stream, 'open')
+  return stream
+}

package/test/ts/transpile.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+set -e
+
+cd ./test/ts;
+
+if (echo "${npm_config_user_agent}" | grep "yarn"); then
+  export RUNNER="yarn";
+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);

package/test/ts.test.ts

@@ -0,0 +1,39 @@
+import { test } from 'tap'
+import { readFile } from 'fs'
+import ThreadStream from '../index.js'
+import { join } from 'path'
+import { file } from './helper.js'
+
+
+test('typescript module', function (t) {
+  if (process.platform === 'win32') {
+    // TODO: Implement .ts files loading support for Windows
+    t.plan(0)
+    return
+  }
+
+  t.plan(5)
+
+  const dest = file()
+  const stream = new ThreadStream({
+    filename: join(__dirname, 'ts', 'to-file.ts'),
+    workerData: { dest },
+    sync: true
+  })
+
+  stream.on('finish', () => {
+    readFile(dest, 'utf8', (err, data) => {
+      t.error(err)
+      t.equal(data, 'hello world\nsomething else\n')
+    })
+  })
+
+  stream.on('close', () => {
+    t.pass('close emitted')
+  })
+
+  t.ok(stream.write('hello world\n'))
+  t.ok(stream.write('something else\n'))
+
+  stream.end()
+})