Merge pull request #2 from MatrixAI/errorsandasyncinit

Integrated @matrixai/errors and setup error chaining and async init
MatrixAI · Apr 5, 2022 · 17e7ece · 17e7ece
2 parents fc9073d + 83da2d0
commit 17e7ece
Show file tree

Hide file tree

Showing 20 changed files with 455 additions and 235 deletions.
diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js
diff --git a/docs/classes/WorkerManager.default.html b/docs/classes/WorkerManager.default.html
diff --git a/docs/classes/errors.ErrorWorkerManager.html b/docs/classes/errors.ErrorWorkerManager.html
diff --git a/.../errors.ErrorWorkerManagerNotRunning.html → ...s/errors.ErrorWorkerManagerDestroyed.html b/.../errors.ErrorWorkerManagerNotRunning.html → ...s/errors.ErrorWorkerManagerDestroyed.html
diff --git a/docs/index.html b/docs/index.html
@@ -180,11 +180,10 @@ <h2>Legend</h2>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
+				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/interfaces/WorkerManagerInterface.default.html b/docs/interfaces/WorkerManagerInterface.default.html
@@ -177,7 +177,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
 					<a name="destroy" class="tsd-anchor"></a>
 					<h3>destroy</h3>
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
-						<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
+						<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
 					</ul>
 					<ul class="tsd-descriptions">
 						<li class="tsd-description">
@@ -186,6 +186,17 @@ <h3>destroy</h3>
 									<li>Defined in <a href="https://github.com/MatrixAI/js-workers/blob/master/src/WorkerManagerInterface.ts#L6">src/WorkerManagerInterface.ts:6</a></li>
 								</ul>
 							</aside>
+							<h4 class="tsd-parameters-title">Parameters</h4>
+							<ul class="tsd-parameters">
+								<li>
+									<h5>options: <span class="tsd-signature-symbol">{ </span>force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
+									<ul class="tsd-parameters">
+										<li class="tsd-parameter">
+											<h5><span class="tsd-flag ts-flagOptional">Optional</span> force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
+										</li>
+									</ul>
+								</li>
+							</ul>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
 						</li>
 					</ul>
@@ -326,7 +337,6 @@ <h2>Legend</h2>
 				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
 				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
 			</ul>
 		</div>

diff --git a/docs/modules.html b/docs/modules.html
@@ -118,11 +118,10 @@ <h2>Legend</h2>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
+				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/modules/WorkerManager.html b/docs/modules/WorkerManager.html
@@ -124,11 +124,10 @@ <h2>Legend</h2>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
+				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/modules/WorkerManagerInterface.html b/docs/modules/WorkerManagerInterface.html
@@ -124,11 +124,10 @@ <h2>Legend</h2>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
+				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/modules/errors.html b/docs/modules/errors.html
@@ -72,8 +72,8 @@ <h2>Index</h2>
 						<section class="tsd-index-section ">
 							<h3>Classes</h3>
 							<ul class="tsd-index-list">
-								<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/errors.ErrorWorkerManager.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager</a></li>
-								<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/errors.ErrorWorkerManagerNotRunning.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Not<wbr>Running</a></li>
+								<li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/errors.ErrorWorkerManager.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager</a></li>
+								<li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/errors.ErrorWorkerManagerDestroyed.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Destroyed</a></li>
 							</ul>
 						</section>
 					</div>
@@ -108,11 +108,11 @@ <h3>Classes</h3>
 			</nav>
 			<nav class="tsd-navigation secondary menu-sticky">
 				<ul class="before-current">
-					<li class=" tsd-kind-class tsd-parent-kind-module">
+					<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
 						<a href="../classes/errors.ErrorWorkerManager.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager</a>
 					</li>
-					<li class=" tsd-kind-class tsd-parent-kind-module">
-						<a href="../classes/errors.ErrorWorkerManagerNotRunning.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Not<wbr>Running</a>
+					<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
+						<a href="../classes/errors.ErrorWorkerManagerDestroyed.html" class="tsd-kind-icon">Error<wbr>Worker<wbr>Manager<wbr>Destroyed</a>
 					</li>
 				</ul>
 			</nav>
@@ -128,11 +128,10 @@ <h2>Legend</h2>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
+				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/modules/index.html b/docs/modules/index.html
@@ -168,11 +168,10 @@ <h2>Legend</h2>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
+				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/modules/worker.html b/docs/modules/worker.html
@@ -132,11 +132,10 @@ <h2>Legend</h2>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
+				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/modules/workerModule.html b/docs/modules/workerModule.html
@@ -251,11 +251,10 @@ <h2>Legend</h2>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
-				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
+				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -20,9 +20,10 @@
     "bench": "ts-node -r tsconfig-paths/register ./benches"
   },
   "dependencies": {
+    "@matrixai/async-init": "^1.7.0",
     "@matrixai/logger": "^2.1.0",
-    "threads": "^1.6.5",
-    "ts-custom-error": "^3.2.0"
+    "@matrixai/errors": "^1.0.1",
+    "threads": "^1.6.5"
   },
   "devDependencies": {
     "@types/jest": "^26.0.20",

diff --git a/src/WorkerManager.ts b/src/WorkerManager.ts
@@ -1,12 +1,13 @@
 import type { ModuleThread } from 'threads';
 import type { ModuleMethods } from 'threads/dist/types/master';
 import type { QueuedTask } from 'threads/dist/master/pool-types';
-
 import { Pool } from 'threads';
 import Logger from '@matrixai/logger';
+import { CreateDestroy, ready } from '@matrixai/async-init/dist/CreateDestroy';
 import WorkerManagerInterface from './WorkerManagerInterface';
 import * as errors from './errors';
 
+@CreateDestroy()
 class WorkerManager<W extends ModuleMethods>
   implements WorkerManagerInterface<W>
 {
@@ -43,10 +44,8 @@ class WorkerManager<W extends ModuleMethods>
 
   protected pool: Pool<ModuleThread<W>>;
   protected logger: Logger;
-  protected _running: boolean = false;
-  protected _destroyed: boolean = false;
 
-  protected constructor({
+  public constructor({
     workerFactory,
     cores,
     logger,
@@ -57,57 +56,35 @@ class WorkerManager<W extends ModuleMethods>
   }) {
     this.logger = logger;
     this.pool = Pool(workerFactory, cores);
-    this._running = true;
-  }
-
-  get running(): boolean {
-    return this._running;
-  }
-
-  get destroyed(): boolean {
-    return this._destroyed;
   }
 
   public async destroy({
     force = false,
   }: { force?: boolean } = {}): Promise<void> {
-    if (this._destroyed) {
-      return;
-    }
     this.logger.info('Destroying WorkerManager');
     await this.pool.terminate(force);
-    this._running = false;
-    this._destroyed = true;
     this.logger.info('Destroyed WorkerManager');
   }
 
+  @ready(new errors.ErrorWorkerManagerDestroyed())
   public async call<T>(f: (worker: ModuleThread<W>) => Promise<T>): Promise<T> {
-    if (!this._running) {
-      throw new errors.ErrorWorkerManagerNotRunning();
-    }
     return await this.pool.queue(f);
   }
 
+  @ready(new errors.ErrorWorkerManagerDestroyed())
   public queue<T>(
     f: (worker: ModuleThread<W>) => Promise<T>,
   ): QueuedTask<ModuleThread<W>, T> {
-    if (!this._running) {
-      throw new errors.ErrorWorkerManagerNotRunning();
-    }
     return this.pool.queue(f);
   }
 
+  @ready(new errors.ErrorWorkerManagerDestroyed())
   public async completed(): Promise<void> {
-    if (!this._running) {
-      throw new errors.ErrorWorkerManagerNotRunning();
-    }
     return await this.pool.completed();
   }
 
+  @ready(new errors.ErrorWorkerManagerDestroyed())
   public async settled() {
-    if (!this._running) {
-      throw new errors.ErrorWorkerManagerNotRunning();
-    }
     return await this.pool.settled();
   }
 }

diff --git a/src/WorkerManagerInterface.ts b/src/WorkerManagerInterface.ts
@@ -3,7 +3,7 @@ import type { ModuleMethods } from 'threads/dist/types/master';
 import type { QueuedTask } from 'threads/dist/master/pool-types';
 
 interface WorkerManagerInterface<W extends ModuleMethods> {
-  destroy(): Promise<void>;
+  destroy(options: { force?: boolean }): Promise<void>;
   call<T>(f: (worker: ModuleThread<W>) => Promise<T>): Promise<T>;
   queue<T>(
     f: (worker: ModuleThread<W>) => Promise<T>,

diff --git a/src/errors.ts b/src/errors.ts
@@ -1,7 +1,11 @@
-import { CustomError } from 'ts-custom-error';
+import { AbstractError } from '@matrixai/errors';
 
-class ErrorWorkerManager extends CustomError {}
+class ErrorWorkerManager<T> extends AbstractError<T> {
+  static description = 'WorkerManager error';
+}
 
-class ErrorWorkerManagerNotRunning extends ErrorWorkerManager {}
+class ErrorWorkerManagerDestroyed<T> extends ErrorWorkerManager<T> {
+  static description = 'WorkerManager is destroyed';
+}
 
-export { ErrorWorkerManager, ErrorWorkerManagerNotRunning };
+export { ErrorWorkerManager, ErrorWorkerManagerDestroyed };
diff --git a/tests/WorkerManager.test.ts b/tests/WorkerManager.test.ts
@@ -1,6 +1,7 @@
 import type { WorkerModule } from '@/worker';
 import { spawn, Worker, Transfer } from 'threads';
 import Logger, { LogLevel, StreamHandler } from '@matrixai/logger';
+import { destroyed } from '@matrixai/async-init';
 import WorkerManager from '@/WorkerManager';
 import * as errors from '@/errors';
 import * as testUtils from './utils';
@@ -16,14 +17,12 @@ describe('WorkerManager', () => {
         logger,
       },
     );
-    expect(workerManager.running).toBe(true);
-    expect(workerManager.destroyed).toBe(false);
+    expect(workerManager[destroyed]).toBe(false);
     expect(await workerManager.call(async () => 1)).toBe(1);
     await workerManager.destroy();
-    expect(workerManager.running).toBe(false);
-    expect(workerManager.destroyed).toBe(true);
+    expect(workerManager[destroyed]).toBe(true);
     expect(workerManager.call(async () => 1)).rejects.toThrow(
-      errors.ErrorWorkerManagerNotRunning,
+      errors.ErrorWorkerManagerDestroyed,
     );
   });
   test('starting with 0 worker cores is useless', async () => {

diff --git a/tsconfig.json b/tsconfig.json
@@ -6,6 +6,7 @@
     "allowJs": true,
     "strictNullChecks": true,
     "noImplicitAny": false,
+    "experimentalDecorators": true,
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
     "resolveJsonModule": true,