@travetto/worker 2.1.3 → 2.2.0

package/README.md

@@ -1,7 +1,7 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
 <!-- Please modify https://github.com/travetto/travetto/tree/main/module/worker/doc.ts and execute "npx trv doc" to rebuild -->
 # Worker
-## Process management utilties, with a focus on inter-process communication
+## Process management utilities, with a focus on inter-process communication
 
 **Install: @travetto/worker**
 ```bash
@@ -26,21 +26,21 @@ class ImageProcessor implements Worker<string> {
   active = false;
   proc: ExecutionState;
 
-  get id() {
+  get id(): number | undefined {
     return this.proc.process.pid;
   }
 
-  async destroy() {
+  async destroy(): Promise<void> {
     this.proc.process.kill();
   }
 
-  async execute(path: string) {
+  async execute(path: string): Promise<void> {
     this.active = true;
     try {
       this.proc = ExecUtil.spawn('convert images', [path]);
       await this.proc;
-    } catch (e) {
-
+    } catch {
+      // Do nothing
     }
     this.active = false;
   }
@@ -54,11 +54,11 @@ export class ImageCompressor extends WorkPool<string, ImageProcessor> {
     super(async () => new ImageProcessor());
   }
 
-  begin() {
+  begin(): void {
     this.process(new IterableWorkSet(this.pendingImages));
   }
 
-  convert(...images: string[]) {
+  convert(...images: string[]): void {
     this.pendingImages.add(images);
   }
 }
@@ -83,7 +83,7 @@ import { Worker } from './pool';
 type Simple<V> = (ch: ParentCommChannel<V>) => Promise<unknown | void>;
 type Param<V, X> = (ch: ParentCommChannel<V>, input: X) => Promise<unknown | void>;
 
-const empty = async () => { };
+const empty = async (): Promise<void> => { };
 
 /**
  * Spawned worker
@@ -99,11 +99,11 @@ export class WorkUtil {
     destroy: Simple<V> = empty): Worker<X> {
     const channel = new ParentCommChannel<V>(worker());
     return {
-      get id() { return channel.id; },
-      get active() { return channel.active; },
+      get id(): number | undefined { return channel.id; },
+      get active(): boolean { return channel.active; },
       init: () => init(channel),
       execute: inp => execute(channel, inp),
-      async destroy() {
+      async destroy(): Promise<void> {
         await destroy(channel);
         await channel.destroy();
       },
@@ -119,7 +119,7 @@ When creating your work, via process spawning, you will need to provide the scri
 import { WorkPool, WorkUtil, IterableWorkSet } from '@travetto/worker';
 import { ExecUtil, PathUtil } from '@travetto/boot';
 
-export function main() {
+export async function main(): Promise<void> {
   const pool = new WorkPool(() =>
     WorkUtil.spawnedWorker<{ data: string }, string>(
       () => ExecUtil.forkMain(PathUtil.resolveUnix(__dirname, 'spawned.ts')),
@@ -139,7 +139,7 @@ export function main() {
     )
   );
 
-  return pool.process(new IterableWorkSet([1, 2, 3, 4, 5])).then(x => pool.shutdown());
+  await pool.process(new IterableWorkSet([1, 2, 3, 4, 5])).then(x => pool.shutdown());
 }
 ```
 
@@ -147,7 +147,7 @@ export function main() {
 ```typescript
 import { ChildCommChannel } from '@travetto/worker';
 
-export async function main() {
+export async function main(): Promise<void> {
   const exec = new ChildCommChannel<{ data: string }>();
 
   exec.on('request', data =>
@@ -155,7 +155,7 @@ export async function main() {
 
   exec.send('ready'); // Indicate the child is ready to receive requests
 
-  const heartbeat = () => setTimeout(heartbeat, 5000); // Keep-alive
+  const heartbeat = (): void => { setTimeout(heartbeat, 5000); }; // Keep-alive
   heartbeat();
 }
 ```

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@travetto/worker",
   "displayName": "Worker",
-  "version": "2.1.3",
-  "description": "Process management utilties, with a focus on inter-process communication",
+  "version": "2.2.0",
+  "description": "Process management utilities, with a focus on inter-process communication",
   "keywords": [
     "exec",
     "child-process",
@@ -26,7 +26,7 @@
     "directory": "module/worker"
   },
   "dependencies": {
-    "@travetto/base": "^2.1.3",
+    "@travetto/base": "^2.2.0",
     "@types/generic-pool": "^3.1.11",
     "generic-pool": "^3.8.2"
   },

package/src/comm/channel.ts

@@ -17,17 +17,17 @@ export class ProcessCommChannel<T extends NodeJS.Process | ChildProcess, V = unk
     this.#proc.on('message', this.#handleMessage.bind(this));
   }
 
-  get #parentId() {
+  get #parentId(): number {
     return process.pid;
   }
 
-  #handleMessage(ev: { type: string }) {
+  #handleMessage(ev: { type: string }): void {
     console.debug('Received', { pid: this.#parentId, id: this.id, type: ev.type });
     this.#emitter.emit(ev.type, ev);
     this.#emitter.emit('*', ev);
   }
 
-  get proc() {
+  get proc(): T | undefined {
     return this.#proc;
   }
 
@@ -38,21 +38,21 @@ export class ProcessCommChannel<T extends NodeJS.Process | ChildProcess, V = unk
   /**
    * Gets channel unique identifier
    */
-  get id() {
+  get id(): number | undefined {
     return this.#proc && this.#proc.pid;
   }
 
   /**
    * Determines if channel is active
    */
-  get active() {
+  get active(): boolean {
     return !!this.#proc;
   }
 
   /**
    * Send data to the parent
    */
-  send(eventType: string, data?: Record<string, unknown>) {
+  send(eventType: string, data?: Record<string, unknown>): void {
     console.debug('Sending', { pid: this.#parentId, id: this.id, eventType });
     if (!this.#proc) {
       throw new Error('this.proc was not defined');
@@ -66,7 +66,7 @@ export class ProcessCommChannel<T extends NodeJS.Process | ChildProcess, V = unk
   /**
    * Listen for a specific message type
    */
-  on(eventType: string, callback: (e: U) => unknown | void) {
+  on(eventType: string, callback: (e: U) => unknown | void): () => void {
     this.#emitter.on(eventType, callback);
     return () => this.off(eventType, callback);
   }
@@ -74,21 +74,21 @@ export class ProcessCommChannel<T extends NodeJS.Process | ChildProcess, V = unk
   /**
    * Remove event listener
    */
-  off(eventType: string, callback: (e: U) => unknown | void) {
+  off(eventType: string, callback: (e: U) => unknown | void): void {
     this.#emitter.off(eventType, callback);
   }
 
   /**
    * Listen for a specific message type, once
    */
-  once(eventType: string) {
+  once(eventType: string): Promise<U> {
     return new Promise<U>(res => this.#emitter.once(eventType, res));
   }
 
   /**
    * Destroy self
    */
-  async destroy() {
+  async destroy(): Promise<void> {
     if (this.#proc) {
       console.debug('Killing', { pid: this.#parentId, id: this.id });
       if (this.#proc !== process) {
@@ -102,7 +102,7 @@ export class ProcessCommChannel<T extends NodeJS.Process | ChildProcess, V = unk
   /**
    * Remove all listeners, but do not destroy
    */
-  release() {
+  release(): void {
     console.debug('Released', { pid: this.#parentId, id: this.id });
     this.#emitter.removeAllListeners();
   }

package/src/comm/parent.ts

@@ -22,7 +22,7 @@ export class ParentCommChannel<U = unknown> extends ProcessCommChannel<ChildProc
   /**
    * Kill self and child
    */
-  override async destroy() {
+  override async destroy(): Promise<void> {
     const res = super.destroy();
     await this.#complete;
     return await res;

package/src/input/async-iterator.ts

@@ -19,7 +19,7 @@ export class ManualAsyncIterator<X> implements AsyncIterator<X> {
   /**
    * Wait for next event to fire
    */
-  async next() {
+  async next(): Promise<IteratorResult<X>> {
     if (!this.#done && !this.#queue.length) {
       await this.#ready;
       this.#ready = Util.resolvablePromise();
@@ -31,7 +31,7 @@ export class ManualAsyncIterator<X> implements AsyncIterator<X> {
    * Queue next event to fire
    * @param {boolean} immediate Determines if item(s) should be append or prepended to the queue
    */
-  add(item: X | X[], immediate = false) {
+  add(item: X | X[], immediate = false): void {
     item = Array.isArray(item) ? item : [item];
     if (!immediate) {
       this.#queue.push(...item);
@@ -44,7 +44,7 @@ export class ManualAsyncIterator<X> implements AsyncIterator<X> {
   /**
    * Close the iterator
    */
-  close() {
+  close(): void {
     this.#done = true;
     this.#ready.resolve();
   }

package/src/input/iterable.ts

@@ -2,8 +2,8 @@ import { WorkSet } from './types';
 
 type Itr<T> = Iterator<T> | AsyncIterator<T>;
 
-const hasAsyncItr = (o: unknown): o is AsyncIterable<unknown> => !!o && Symbol.asyncIterator in (o as object);
-const hasItr = (o: unknown): o is Iterable<unknown> => !!o && Symbol.iterator in (o as object);
+const hasAsyncItr = (o: unknown): o is AsyncIterable<unknown> => !!o && typeof o === 'object' && Symbol.asyncIterator in o;
+const hasItr = (o: unknown): o is Iterable<unknown> => !!o && typeof o === 'object' && Symbol.iterator in o;
 
 /**
  * Basic input source given an iterable input
@@ -31,7 +31,7 @@ export class IterableWorkSet<X> implements WorkSet<X> {
   /**
    * Fetch next item from the iterable
    */
-  async #primeNext() {
+  async #primeNext(): Promise<void> {
     const res = await this.#src.next();
     this.#done = !!res.done;
     this.#ondeck = res.value;
@@ -40,7 +40,7 @@ export class IterableWorkSet<X> implements WorkSet<X> {
   /**
    * Determine if the iterable has more data
    */
-  async hasNext() {
+  async hasNext(): Promise<boolean> {
     if (this.#ondeck === undefined) {
       await this.#primeNext();
     }
@@ -50,7 +50,7 @@ export class IterableWorkSet<X> implements WorkSet<X> {
   /**
    * Fetch next item
    */
-  async next() {
+  async next(): Promise<X> {
     await this.hasNext();
 
     const out = this.#ondeck!;

package/src/pool.ts

@@ -68,7 +68,7 @@ export class WorkPool<X, T extends Worker<X>> {
   /**
    * Creates and tracks new worker
    */
-  async #createAndTrack(getWorker: () => Promise<T> | T, opts: gp.Options) {
+  async #createAndTrack(getWorker: () => Promise<T> | T, opts: gp.Options): Promise<T> {
     try {
       this.#pendingAcquires += 1;
       const res = await getWorker();
@@ -80,12 +80,12 @@ export class WorkPool<X, T extends Worker<X>> {
       this.#createErrors = 0; // Reset errors on success
 
       return res;
-    } catch (e) {
+    } catch (err) {
       if (this.#createErrors++ > opts.max!) { // If error count is bigger than pool size, we broke
-        console.error('Failed in creating pool', { error: e });
+        console.error('Failed in creating pool', { error: err });
         process.exit(1);
       }
-      throw e;
+      throw err;
     } finally {
       this.#pendingAcquires -= 1;
     }
@@ -94,7 +94,7 @@ export class WorkPool<X, T extends Worker<X>> {
   /**
    * Destroy the worker
    */
-  async destroy(worker: T) {
+  async destroy(worker: T): Promise<void> {
     console.debug('Destroying', { pid: process.pid, worker: worker.id });
     return worker.destroy();
   }
@@ -102,7 +102,7 @@ export class WorkPool<X, T extends Worker<X>> {
   /**
    * Free worker on completion
    */
-  async release(worker: T) {
+  async release(worker: T): Promise<void> {
     console.debug('Releasing', { pid: process.pid, worker: worker.id });
     try {
       if (worker.active) {
@@ -121,7 +121,7 @@ export class WorkPool<X, T extends Worker<X>> {
   /**
    * Process a given input source
    */
-  async process(src: WorkSet<X>) {
+  async process(src: WorkSet<X>): Promise<void> {
     const pending = new Set<Promise<unknown>>();
 
     while (await src.hasNext()) {
@@ -148,7 +148,7 @@ export class WorkPool<X, T extends Worker<X>> {
   /**
    * Shutdown pool
    */
-  async shutdown() {
+  async shutdown(): Promise<void> {
     while (this.#pendingAcquires) {
       await Util.wait(10);
     }

package/src/support/barrier.ts

@@ -2,6 +2,7 @@ import { Util, ShutdownManager, TimeSpan } from '@travetto/base';
 import { Timeout } from './timeout';
 
 function canCancel(o: unknown): o is { cancel(): unknown } {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
   return !!o && 'cancel' in (o as object);
 }
 
@@ -9,7 +10,7 @@ function canCancel(o: unknown): o is { cancel(): unknown } {
  * Build an execution barrier to handle various limitations
  */
 export class Barrier {
-  #support = [] as string[];
+  #support: string[] = [];
   #barriers = new Map<string, Promise<unknown>>([]);
 
   constructor(
@@ -27,7 +28,7 @@ export class Barrier {
   /**
    * Add a new barrier
    */
-  add(p: (() => Promise<unknown>) | Promise<unknown>, support = false) {
+  add(p: (() => Promise<unknown>) | Promise<unknown>, support = false): this {
     if (!('then' in p)) {
       p = p();
     }
@@ -49,7 +50,7 @@ export class Barrier {
   /**
    * Clean up, and cancel all cancellable barriers
    */
-  cleanup() {
+  cleanup(): void {
     for (const k of this.#support) {
       const el = this.#barriers.get(k);
       if (canCancel(el)) {
@@ -63,11 +64,11 @@ export class Barrier {
    * Wait for all barriers to clear out
    */
   async wait(): Promise<Error | undefined> {
-    let err: Error | undefined;
+    let capturedError: Error | undefined;
     // Wait for all barriers to be satisfied
     while (this.#barriers.size) {
-      await Promise.race(this.#barriers.values()).catch(e => err ??= e);
+      await Promise.race(this.#barriers.values()).catch(err => capturedError ??= err);
     }
-    return err;
+    return capturedError;
   }
 }

package/src/support/timeout.ts

@@ -18,7 +18,7 @@ export class Timeout extends ExecutionError {
   /**
    * Stop timeout from firing
    */
-  cancel() {
+  cancel(): void {
     if (this.#id) {
       clearTimeout(this.#id);
       this.#promise.resolve();
@@ -29,7 +29,7 @@ export class Timeout extends ExecutionError {
   /**
    * Wait for timeout as a promise
    */
-  wait() {
+  wait(): Promise<void> {
     if (!this.#id) {
       this.#id = setTimeout(() => this.#promise.reject(this), this.#duration);
       this.#id.unref();

package/src/util.ts

@@ -6,7 +6,7 @@ import { Worker } from './pool';
 type Simple<V> = (ch: ParentCommChannel<V>) => Promise<unknown | void>;
 type Param<V, X> = (ch: ParentCommChannel<V>, input: X) => Promise<unknown | void>;
 
-const empty = async () => { };
+const empty = async (): Promise<void> => { };
 
 /**
  * Spawned worker
@@ -22,11 +22,11 @@ export class WorkUtil {
     destroy: Simple<V> = empty): Worker<X> {
     const channel = new ParentCommChannel<V>(worker());
     return {
-      get id() { return channel.id; },
-      get active() { return channel.active; },
+      get id(): number | undefined { return channel.id; },
+      get active(): boolean { return channel.active; },
       init: () => init(channel),
       execute: inp => execute(channel, inp),
-      async destroy() {
+      async destroy(): Promise<void> {
         await destroy(channel);
         await channel.destroy();
       },