@xylabs/threads 4.6.4 → 4.7.0

package/test/transferables.test.ts

@@ -1,71 +0,0 @@
-/* eslint-disable import-x/no-internal-modules */
-/* eslint-disable @typescript-eslint/no-unnecessary-type-constraint */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import { expect, test } from 'vitest'
-
-import {
-  spawn, Thread, Transfer, Worker,
-} from '../src/index'
-import type { XorBuffer } from './workers/arraybuffer-xor.ts'
-
-type SpyInit<Args extends any[], OriginalReturn, NewReturn> = (originalFn: (...args: Args) => OriginalReturn) => (...args: Args) => NewReturn
-
-const arrayBufferPlaceholder = Symbol('ArrayBufferPlaceholder')
-
-function spyOn<Args extends any[], OriginalReturn, NewReturn>(
-  target: (...args: Args) => OriginalReturn,
-  spy: SpyInit<Args, OriginalReturn, NewReturn>,
-): (...args: Args) => NewReturn {
-  return spy(target)
-}
-
-function replaceArrayBufferWithPlaceholder<In extends any>(
-  obj: In,
-  arrayBuffer: ArrayBufferLike,
-): In extends ArrayBufferLike ? In | typeof arrayBufferPlaceholder : In {
-  if ((obj as any) === arrayBuffer) {
-    return arrayBufferPlaceholder as any
-  } else if (Array.isArray(obj)) {
-    return (obj as any[]).map(element => replaceArrayBufferWithPlaceholder(element, arrayBuffer)) as any
-  } else if (obj && typeof obj === 'object') {
-    const result: In = Object.create(Object.getPrototypeOf(obj))
-
-    for (const key of Object.getOwnPropertyNames(obj)) {
-      (result as any)[key] = replaceArrayBufferWithPlaceholder((obj as any)[key], arrayBuffer)
-    }
-    return result as any
-  } else {
-    return obj as any
-  }
-}
-
-test('can pass transferable objects on thread call', async () => {
-  const testData = new ArrayBuffer(64)
-
-  const worker = new Worker('./workers/arraybuffer-xor.ts')
-  const postMessageCalls: Array<any[]> = []
-
-  worker.postMessage = spyOn(worker.postMessage.bind(worker), postMessage => (...args) => {
-    postMessageCalls.push(replaceArrayBufferWithPlaceholder(args, testData))
-    return postMessage(...args)
-  })
-
-  const xorBuffer = await spawn<XorBuffer>(worker)
-  const returnedBuffer = await xorBuffer(Transfer(testData), 15)
-
-  expect(returnedBuffer.byteLength).toBe(64)
-  expect(postMessageCalls.length).toBe(1)
-  expect(postMessageCalls[0].length).toBe(2)
-  expect(postMessageCalls[0][0]).toEqual({
-    args: [arrayBufferPlaceholder, 15],
-    method: undefined,
-    type: 'run',
-    uid: postMessageCalls[0][0].uid,
-  })
-  expect(postMessageCalls[0][1]).toEqual([arrayBufferPlaceholder])
-
-  await Thread.terminate(xorBuffer)
-})
-
-test.todo('can pass transferable objects as observable values')

package/test/workers/arraybuffer-xor.ts

@@ -1,10 +0,0 @@
-import { expose, Transfer } from '../../src/worker'
-
-function xor(buffer: ArrayBufferLike, value: number) {
-  const view = new Uint8Array(buffer)
-  for (const [offset, byte] of view.entries()) view.set([byte ^ value], offset)
-  return Transfer(buffer)
-}
-
-expose(xor)
-export type XorBuffer = typeof xor

package/test/workers/count-to-five.ts

@@ -1,12 +0,0 @@
-import { Observable } from 'observable-fns'
-
-import { expose } from '../../src/worker'
-
-expose(function countToFive() {
-  return new Observable((observer) => {
-    for (let counter = 1; counter <= 5; counter++) {
-      observer.next(counter)
-    }
-    observer.complete()
-  })
-})

package/test/workers/counter.ts

@@ -1,19 +0,0 @@
-import { expose } from '../../src/worker'
-
-let currentCount = 0
-
-const counter = {
-  decrement() {
-    return --currentCount
-  },
-  getCount() {
-    return currentCount
-  },
-  increment() {
-    return ++currentCount
-  },
-}
-
-expose(counter)
-
-export type Counter = typeof counter

package/test/workers/faulty-function.ts

@@ -1,5 +0,0 @@
-import { expose } from '../../src/worker'
-
-expose(function fail() {
-  throw new Error('I am supposed to fail.')
-})

package/test/workers/hello-world.ts

@@ -1,5 +0,0 @@
-import { expose } from '../../src/worker'
-
-expose(function helloWorld() {
-  return 'Hello World'
-})

package/test/workers/increment.ts

@@ -1,8 +0,0 @@
-import { expose } from '../../src/worker'
-
-let counter = 0
-
-expose(function increment(by: number = 1) {
-  counter += by
-  return counter
-})

package/test/workers/minmax.ts

@@ -1,25 +0,0 @@
-// eslint-disable-next-line import-x/no-internal-modules
-import { Observable, Subject } from '../../src/observable'
-import { expose } from '../../src/worker'
-
-let max = Number.NEGATIVE_INFINITY
-let min = Number.POSITIVE_INFINITY
-
-let subject = new Subject()
-
-const minmax = {
-  finish() {
-    subject.complete()
-    subject = new Subject()
-  },
-  push(value) {
-    max = Math.max(max, value)
-    min = Math.min(min, value)
-    subject.next({ max, min })
-  },
-  values() {
-    return Observable.from(subject)
-  },
-}
-
-expose(minmax)

package/test/workers/serialization.ts

@@ -1,13 +0,0 @@
-/* eslint-disable import-x/no-internal-modules */
-/* eslint-disable require-await */
-
-import { expose, registerSerializer } from '../../src/worker'
-import { Foo, fooSerializer } from '../lib/serialization'
-
-registerSerializer(fooSerializer)
-
-async function run(foo: Foo<string>) {
-  return new Foo(foo.getValue() + foo.getValue())
-}
-
-expose(run)

package/test/workers/top-level-throw.ts

@@ -1 +0,0 @@
-throw new Error('Top-level worker error')

package/test-tooling/rollup/app.js

@@ -1,21 +0,0 @@
-/* eslint-disable no-restricted-imports */
-import {
-  spawn, Thread, Worker,
-} from '../..'
-
-async function run() {
-  const add = await spawn(new Worker('./worker.js'))
-  const result = await add(2, 3)
-  await Thread.terminate(add)
-  return result
-}
-
-run()
-  .then((result) => {
-    console.log(`Result: ${result}`)
-    puppet.exit(0)
-  })
-  .catch((error) => {
-    console.error(error)
-    puppet.exit(1)
-  })

package/test-tooling/rollup/rollup.config.ts

@@ -1,14 +0,0 @@
-import commonjs from '@rollup/plugin-commonjs'
-import { nodeResolve } from '@rollup/plugin-node-resolve'
-
-export default {
-  plugins: [
-    nodeResolve({
-      browser: true,
-      mainFields: ['module', 'main'],
-      preferBuiltins: true,
-    }),
-
-    commonjs(),
-  ],
-}

package/test-tooling/rollup/worker.js

@@ -1,7 +0,0 @@
-/* eslint-disable require-await */
-
-import { expose } from '../../dist/esm/worker'
-
-expose(async function add(a, b) {
-  return a + b
-})

package/test-tooling/tsconfig/minimal.ts

@@ -1,12 +0,0 @@
-/* eslint-disable no-restricted-imports */
-/* eslint-disable @typescript-eslint/no-floating-promises */
-import {
-  spawn, Thread, Worker,
-} from '../..'
-
-async function main() {
-  const helloWorld = await spawn(new Worker('./workers/hello-world.ts'))
-  await Thread.terminate(helloWorld)
-}
-
-main()

package/test-tooling/webpack/addition-worker.ts

@@ -1,9 +0,0 @@
-import { expose, isWorkerRuntime } from '../../src/worker'
-
-if (!isWorkerRuntime()) {
-  throw new Error('isWorkerRuntime() says we are not in a worker.')
-}
-
-expose(function add(a: number, b: number) {
-  return a + b
-})

package/test-tooling/webpack/app-with-inlined-worker.ts

@@ -1,28 +0,0 @@
-/* eslint-disable import-x/no-unresolved */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-/// <reference types="./raw-loader" />
-
-import AdditionWorkerNodeBundle from 'raw-loader!./dist/addition-worker.node/worker.js'
-import AdditionWorkerWebBundle from 'raw-loader!./dist/addition-worker.web/worker.js'
-
-import { BlobWorker, spawn } from '../../src/index'
-
-const AdditionWorkerBundle = (process as any).browser ? AdditionWorkerWebBundle : AdditionWorkerNodeBundle
-type AdditionWorker = (a: number, b: number) => number
-
-async function test() {
-  // We also want to test if referencing multiple different workers in a module
-  // built using webpack works
-
-  const add = await spawn<AdditionWorker>(BlobWorker.fromText(AdditionWorkerBundle))
-  const result = await add(2, 3)
-
-  if (result !== 5) {
-    throw new Error('Unexpected result returned by addition worker: ' + result)
-  }
-
-  return 'test succeeded'
-}
-
-export default test

package/test-tooling/webpack/app.ts

@@ -1,61 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import {
-  isWorkerRuntime, Pool, spawn, Worker,
-} from '../../src/index'
-
-type AdditionWorker = (a: number, b: number) => number
-type HelloWorker = (text: string) => string
-
-async function test() {
-  const pool = Pool(() => spawn<HelloWorker>(new Worker('./pool-worker')))
-  const results = await Promise.all([
-    pool.queue(hello => hello('World')),
-    pool.queue(hello => hello('World')),
-    pool.queue(hello => hello('World')),
-    pool.queue(hello => hello('World')),
-  ])
-  await pool.terminate()
-
-  for (const result of results) {
-    if (result !== 'Hello, World') {
-      throw new Error('Unexpected result returned by pool worker: ' + result)
-    }
-  }
-}
-
-async function test2() {
-  // We also want to test if referencing multiple different workers in a module
-  // built using webpack works
-
-  const add = await spawn<AdditionWorker>(new Worker('./addition-worker'))
-  const result = await add(2, 3)
-
-  if (result !== 5) {
-    throw new Error('Unexpected result returned by addition worker: ' + result)
-  }
-}
-
-async function test3() {
-  if (!(process as any).browser) {
-    // Running workers from remote URLs is disabled in node.js
-    return
-  }
-
-  const hello = await spawn<HelloWorker>(new Worker('https://infallible-turing-115958.netlify.com/hello-worker.js'))
-  const result = await hello('World')
-
-  if (result !== 'Hello, World') {
-    throw new Error('Unexpected result returned by hello worker: ' + result)
-  }
-}
-
-function test4() {
-  if (isWorkerRuntime() !== false) {
-    throw new Error('Expected isWorkerRuntime() to return false. Got: ' + isWorkerRuntime())
-  }
-}
-
-const testAll = () => Promise.all([test(), test2(), test3(), test4()])
-
-export default testAll

package/test-tooling/webpack/pool-worker.ts

@@ -1,5 +0,0 @@
-import { expose } from '../../src/worker'
-
-expose(function hello(text: string) {
-  return `Hello, ${text}`
-})

package/test-tooling/webpack/raw-loader.d.ts

@@ -1,4 +0,0 @@
-declare module 'raw-loader!*' {
-  const content: string
-  export = content
-}

package/test-tooling/webpack/webpack.chromium.mocha.ts

@@ -1,21 +0,0 @@
-/* eslint-disable @typescript-eslint/no-require-imports */
-// NOTE:
-// We are gonna test the bundles previously built by the AVA tests (see webpack.test.ts)
-
-describe('threads webpack browser bundle', function () {
-  this.timeout(80_000)
-
-  it('works fine', async function () {
-    const bundle = require('./dist/app.web/main')
-    await bundle.test()
-  })
-})
-
-describe('threads webpack browser bundle with inlined worker', function () {
-  this.timeout(80_000)
-
-  it('works fine', async function () {
-    const bundle = require('./dist/app-inlined.web/main')
-    await bundle.test()
-  })
-})

package/test-tooling/webpack/webpack.node.config.js

@@ -1,29 +0,0 @@
-/* eslint-disable @typescript-eslint/no-require-imports */
-const path = require('node:path')
-const ThreadsPlugin = require('threads-plugin')
-
-module.exports = {
-  context: __dirname,
-  devtool: false,
-  entry: require.resolve('./app.ts'),
-  externals: { 'tiny-worker': 'tiny-worker' },
-  mode: 'development',
-  module: {
-    rules: [
-      {
-        loader: 'ts-loader',
-        options: { compilerOptions: { module: 'esnext' } },
-        test: /\.ts$/,
-      },
-    ],
-  },
-  output: {
-    library: 'test',
-    libraryExport: 'default',
-    libraryTarget: 'commonjs',
-    path: path.resolve(__dirname, './dist/app.node'),
-  },
-  plugins: [new ThreadsPlugin()],
-  resolve: { extensions: ['.js', '.ts'] },
-  target: 'node',
-}

package/test-tooling/webpack/webpack.web.config.js

@@ -1,28 +0,0 @@
-/* eslint-disable @typescript-eslint/no-require-imports */
-const path = require('node:path')
-const ThreadsPlugin = require('threads-plugin')
-
-module.exports = {
-  context: __dirname,
-  devtool: false,
-  entry: require.resolve('./app.ts'),
-  mode: 'development',
-  module: {
-    rules: [
-      {
-        loader: 'ts-loader',
-        options: { compilerOptions: { module: 'esnext' } },
-        test: /\.ts$/,
-      },
-    ],
-  },
-  output: {
-    library: 'test',
-    libraryExport: 'default',
-    libraryTarget: 'commonjs',
-    path: path.resolve(__dirname, './dist/app.web'),
-  },
-  plugins: [new ThreadsPlugin()],
-  resolve: { extensions: ['.js', '.ts'] },
-  target: 'web',
-}

package/types/webworker.d.ts

@@ -1,9 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/// <reference no-default-lib="true"/>
-/// <reference lib="webworker" />
-
-interface WorkerGlobalScope {
-  addEventListener(eventName: string, listener: (event: Event) => void): void
-  postMessage(message: any, transferables?: any[]): void
-  removeEventListener(eventName: string, listener: (event: Event) => void): void
-}

package/worker.d.ts

@@ -1,2 +0,0 @@
-/* eslint-disable import-x/no-internal-modules */
-export * from './dist/worker/index'

package/worker.js

@@ -1,2 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-module.exports = require('./dist/worker/index')

package/worker.mjs

@@ -1,6 +0,0 @@
-import * as WorkerContext from './dist/worker/index.js'
-
-export const expose = WorkerContext.expose
-export const registerSerializer = WorkerContext.registerSerializer
-export const Transfer = WorkerContext.Transfer
-export const isWorkerRuntime = WorkerContext.isWorkerRuntime