refactor: adapt fixed queue

piscinajs · May 20, 2024 · b56e61c · b56e61c
1 parent 83027aa
commit b56e61c
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 204 deletions.
diff --git a/src/fixed-queue.ts b/src/fixed-queue.ts
diff --git a/src/index.ts b/src/index.ts
@@ -24,6 +24,7 @@ import {
   TaskQueue,
   isTaskQueue,
   ArrayTaskQueue,
+  FixedQueue,
   TaskInfo,
   PiscinaTask,
   TransferList,
@@ -49,7 +50,6 @@ import {
   toHistogramIntegerNano,
   maybeFileURLToPath
 } from './common';
-import FixedQueue from './fixed-queue';
 
 const { version } = JSON.parse(
   readFileSync(
@@ -922,6 +922,14 @@ export default class Piscina<T = any, R = any> extends EventEmitterAsyncResource
     return Piscina;
   }
 
+  static get FixedQueue () {
+    return FixedQueue;
+  }
+
+  static get ArrayTaskQueue () {
+    return ArrayTaskQueue;
+  }
+
   static move (val : Transferable | TransferListItem | ArrayBufferView | ArrayBuffer | MessagePort) {
     if (val != null && typeof val === 'object' && typeof val !== 'function') {
       if (!isTransferable(val)) {
@@ -946,11 +954,6 @@ export default class Piscina<T = any, R = any> extends EventEmitterAsyncResource
 export const move = Piscina.move;
 export const isWorkerThread = Piscina.isWorkerThread;
 export const workerData = Piscina.workerData;
-// Mutate Piscina class to allow named import in commonjs
-// @ts-expect-error
-Piscina.FixedQueue = FixedQueue;
-// @ts-expect-error
-Piscina.ArrayTaskQueue = ArrayTaskQueue;
 
 export {
   Piscina,

diff --git a/src/task_queue/index.ts b/src/task_queue/index.ts
@@ -10,6 +10,7 @@ import { kTransferable, kValue, kQueueOptions } from '../symbols';
 import type { Task, TaskQueue, PiscinaTask } from './common';
 
 export { ArrayTaskQueue } from './array_queue';
+export { FixedQueue } from './fixed_queue';
 
 export type TaskCallback = (err: Error, result: any) => void
 // Grab the type of `transferList` off `MessagePort`. At the time of writing,

diff --git a/test/fixed-queue.ts b/test/fixed-queue.ts
@@ -1,9 +1,9 @@
 import { test } from 'tap';
-import { Task } from '../dist/types';
 import { kQueueOptions } from '../dist/symbols';
-import { Piscina, FixedQueue } from '..';
+import { Piscina, FixedQueue, PiscinaTask as Task } from '..';
 import { resolve } from 'node:path';
 
+// @ts-expect-error
 class QueueTask implements Task {
   get [kQueueOptions] () {
     return null;

diff --git a/test/task-queue.ts b/test/task-queue.ts
@@ -1,7 +1,6 @@
-import Piscina from '..';
+import Piscina, { PiscinaTask, TaskQueue } from '..';
 import { test } from 'tap';
 import { resolve } from 'path';
-import { TaskQueue, Task } from '../dist/task_queue/index';
 
 test('will put items into a task queue until they can run', async ({ equal }) => {
   const pool = new Piscina({
@@ -221,19 +220,19 @@ test('custom task queue works', async ({ equal, ok }) => {
   let pushCalled : boolean = false;
 
   class CustomTaskPool implements TaskQueue {
-    tasks: Task[] = [];
+    tasks: PiscinaTask[] = [];
 
     get size () : number {
       sizeCalled = true;
       return this.tasks.length;
     }
 
-    shift () : Task | null {
+    shift () : PiscinaTask | null {
       shiftCalled = true;
-      return this.tasks.length > 0 ? this.tasks.shift() as Task : null;
+      return this.tasks.length > 0 ? this.tasks.shift() as PiscinaTask : null;
     }
 
-    push (task : Task) : void {
+    push (task : PiscinaTask) : void {
       pushCalled = true;
       this.tasks.push(task);
 
@@ -246,7 +245,7 @@ test('custom task queue works', async ({ equal, ok }) => {
       }
     }
 
-    remove (task : Task) : void {
+    remove (task : PiscinaTask) : void {
       const index = this.tasks.indexOf(task);
       this.tasks.splice(index, 1);
     }