Update version to 4.0.0

- Some naming adjustments
kaisalmen · Oct 1, 2024 · 85f4a4d · 85f4a4d
1 parent c81982c
commit 85f4a4d
Show file tree

Hide file tree

Showing 11 changed files with 54 additions and 51 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Changelog
 
-## 3.1.0 - 2024-10-01
+## 4.0.0 - 2024-10-01
 
 - ComChannelEndpoint has been extracted from WorkerTask
   - Now Worker, MessageChannel or DedicatedWorkerGlobalScope can be channel endpoints. Both ends of the communication channel can use the same implementation to send message and await responses if needed.

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/examples/package.json b/packages/examples/package.json
@@ -19,8 +19,8 @@
   "dependencies": {
     "lil-gui": "~0.19.2",
     "three": "~0.169.0",
-    "wtd-core": "~3.1.0",
-    "wtd-three-ext": "~3.1.0",
+    "wtd-core": "~4.0.0",
+    "wtd-three-ext": "~4.0.0",
     "wwobjloader2": "6.2.1"
   },
   "devDependencies": {

diff --git a/packages/examples/src/com/WorkerCom.ts b/packages/examples/src/com/WorkerCom.ts
@@ -36,8 +36,8 @@ class HelloWorldStandardWorkerExample {
             endpointName: 'Com1Worker',
             endpointId: 1,
             endpointConfig: {
-                $type: 'WorkerConfigDirect',
-                worker: com1Worker
+                $type: 'DirectImplConfig',
+                impl: com1Worker
             },
             verbose: true
         });
@@ -49,8 +49,8 @@ class HelloWorldStandardWorkerExample {
             endpointName: 'Com2Worker',
             endpointId: 2,
             endpointConfig: {
-                $type: 'WorkerConfigDirect',
-                worker: com2Worker
+                $type: 'DirectImplConfig',
+                impl: com2Worker
             },
             verbose: true
         });

diff --git a/packages/examples/src/worker/HelloWorldComChannelEndpointWorker.ts b/packages/examples/src/worker/HelloWorldComChannelEndpointWorker.ts
@@ -33,8 +33,8 @@ class ExampleComRouterWorker implements ComRouter {
 new ComChannelEndpoint({
     endpointId: 2000,
     endpointConfig: {
-        $type: 'WorkerConfigDirect',
-        worker: self
+        $type: 'DirectImplConfig',
+        impl: self
     },
     verbose: true,
     endpointName: 'HelloWorldComChannelEndpointWorker'

diff --git a/packages/wtd-core/README.md b/packages/wtd-core/README.md
@@ -15,6 +15,7 @@ Build applications with workers with less boiler plate code.
 
 There are multiple examples available demonstarting the features described above (listed from simpler to more advanced):
 
+- **ComChannelEndpoint: Hello World**: [html](https://github.com/kaisalmen/wtd/blob/main/packages/examples/helloWorldComChannelEndpoint.html), [ts](https://github.com/kaisalmen/wtd/blob/main/packages/examples/src/helloWorld/HelloWorldComChannelEndpoint.ts), [worker](https://github.com/kaisalmen/wtd/blob/main/packages/examples/src/worker/HelloWorldComChannelEndpointWorker.ts)
 - **WorkerTask: Hello World**: [html](https://github.com/kaisalmen/wtd/blob/main/packages/examples/helloWorldWorkerTask.html), [ts](https://github.com/kaisalmen/wtd/blob/main/packages/examples/src/helloWorld/HelloWorldWorkerTask.ts), [worker](https://github.com/kaisalmen/wtd/blob/main/packages/examples/src/worker/HelloWorldWorker.ts)
 - **WorkerTaskDirector: Hello World**: [html](https://github.com/kaisalmen/wtd/blob/main/packages/examples/helloWorldWorkerTaskDirector.html), [ts](https://github.com/kaisalmen/wtd/blob/main/packages/examples/src/helloWorld/helloWorldWorkerTaskDirector.ts), [worker](https://github.com/kaisalmen/wtd/blob/main/packages/examples/src/worker/HelloWorldWorker.ts)
 - **WorkerTask: Inter-Worker Communication**: [html](https://github.com/kaisalmen/wtd/blob/main/packages/examples/workerCom.html), [ts](https://github.com/kaisalmen/wtd/blob/main/packages/examples/src/com/WorkerCom.ts), **Worker**: [1](https://github.com/kaisalmen/wtd/blob/main/packages/examples/src/worker/Com1Worker.ts) and [2](https://github.com/kaisalmen/wtd/blob/main/packages/examples/src/worker/Com2Worker.ts)
@@ -28,9 +29,9 @@ This shall give you an idea how you can use module worker with `WorkerTask` (der
 ```js
 // let WorkerTask create the worker
 const workerTask = new WorkerTask({
-    taskName,
-    workerId: 1,
-    workerConfig: {
+    endpointName,
+    endpointId: 1,
+    endpointConfig: {
         $type: 'WorkerConfigParams',
         url: new URL('./HelloWorldWorker.js', import.meta.url),
         workerType: 'module',

diff --git a/packages/wtd-core/package.json b/packages/wtd-core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "wtd-core",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "license": "MIT",
   "type": "module",
   "main": "./dist/index.js",

diff --git a/packages/wtd-core/src/ComChannelEndpoint.ts b/packages/wtd-core/src/ComChannelEndpoint.ts
@@ -9,8 +9,8 @@ export interface WorkerConfig {
 }
 
 export interface EndpointConfigDirect {
-    $type: 'WorkerConfigDirect';
-    worker: Worker | MessagePort | DedicatedWorkerGlobalScope;
+    $type: 'DirectImplConfig';
+    impl: Worker | MessagePort | DedicatedWorkerGlobalScope;
 }
 
 export interface AwaitHandler {
@@ -47,7 +47,7 @@ export class ComChannelEndpoint {
     protected endpointConfig: WorkerConfig | EndpointConfigDirect;
     protected verbose = false;
 
-    protected worker?: Worker | MessagePort | DedicatedWorkerGlobalScope;
+    protected impl?: Worker | MessagePort | DedicatedWorkerGlobalScope;
     protected executionCounter = 0;
     protected awaitAnswers = new Map<string, AwaitHandler[]>();
 
@@ -58,47 +58,47 @@ export class ComChannelEndpoint {
         this.endpointName = config.endpointName;
     }
 
-    getWorker() {
-        return this.worker;
+    getImpl() {
+        return this.impl;
     }
 
     connect(comRoutingHandler?: ComRouter) {
-        if (this.worker) {
+        if (this.impl) {
             throw new Error('Worker already created. Aborting...');
         }
-        if (this.endpointConfig.$type === 'WorkerConfigDirect') {
-            this.worker = this.endpointConfig.worker;
+        if (this.endpointConfig.$type === 'DirectImplConfig') {
+            this.impl = this.endpointConfig.impl;
         } else {
             if (this.endpointConfig.url !== undefined) {
                 if (this.endpointConfig.blob === true) {
-                    this.worker = new Worker(this.endpointConfig.url);
+                    this.impl = new Worker(this.endpointConfig.url);
                 }
                 else {
-                    this.worker = new Worker((this.endpointConfig.url as URL).href, {
+                    this.impl = new Worker((this.endpointConfig.url as URL).href, {
                         type: this.endpointConfig.workerType
                     });
                 }
             }
         }
 
-        if (!this.worker) {
+        if (!this.impl) {
             throw new Error('No valid worker configuration was supplied. Aborting...');
         }
 
-        this.worker.onmessage = (async (message) => {
+        this.impl.onmessage = (async (message) => {
             if (comRoutingHandler !== undefined) {
                 comRoutingHandler.setComChannelEndpoint(this);
                 comRouting(comRoutingHandler, message);
             }
             this.processAwaitHandlerRemoval(message);
         });
-        this.worker.onmessageerror = (async (msg) => {
+        this.impl.onmessageerror = (async (msg) => {
             console.log(`Received errornuous message: ${msg}`);
             Promise.reject(msg);
         });
 
-        if (Object.hasOwn(this.worker ?? {}, 'onerror')) {
-            (this.worker as Worker).onerror = (async (message) => {
+        if (Object.hasOwn(this.impl ?? {}, 'onerror')) {
+            (this.impl as Worker).onerror = (async (message) => {
                 console.log(`Execution Aborted: ${message.error}`);
                 Promise.reject(message);
             });
@@ -109,7 +109,7 @@ export class ComChannelEndpoint {
      * This is only possible if the worker is available.
      */
     sentMessage(def: WorkerMessageDef): Promise<WorkerMessage> {
-        if (this.worker === undefined) {
+        if (this.impl === undefined) {
             return Promise.reject(new Error('No worker is available. Aborting...'));
         }
 
@@ -135,7 +135,7 @@ export class ComChannelEndpoint {
                         log: this.verbose
                     }]);
                 }
-                this.worker?.postMessage(message, transferablesToWorker);
+                this.impl?.postMessage(message, transferablesToWorker);
 
                 if (def.awaitAnswer === false) {
                     resolve(WorkerMessage.createEmpty());
@@ -210,19 +210,21 @@ export class ComChannelEndpoint {
     }
 
     protected checkWorker(reject: (error: Error) => void) {
-        if (!this.worker) {
+        if (!this.impl) {
             reject(new Error('No worker is available. Aborting...'));
             return false;
         }
         return true;
     }
 
     dispose() {
-        if (this.worker !== undefined) {
-            if (Object.hasOwn(this.worker, 'terminate')) {
-                (this.worker as Worker).terminate();
+        if (this.impl !== undefined) {
+            if (Object.hasOwn(this.impl, 'terminate')) {
+                (this.impl as Worker).terminate();
+            } else if (Object.hasOwn(this.impl, 'start')) {
+                (this.impl as MessagePort).close();
             } else {
-                (this.worker as MessagePort).close();
+                (this.impl as DedicatedWorkerGlobalScope).close();
             }
         }
     }

diff --git a/packages/wtd-core/src/WorkerTask.ts b/packages/wtd-core/src/WorkerTask.ts
@@ -29,8 +29,8 @@ export class WorkerTask extends ComChannelEndpoint {
     connect() {
         super.connect();
 
-        if (this.worker !== undefined && Object.hasOwn(this.worker ?? {}, 'onerror')) {
-            (this.worker as Worker).onerror = (async (answer) => {
+        if (this.impl !== undefined && Object.hasOwn(this.impl ?? {}, 'onerror')) {
+            (this.impl as Worker).onerror = (async (answer) => {
                 console.log(`Execution Aborted: ${answer.error}`);
                 Promise.reject(answer);
                 this.markExecuting(false);
@@ -40,7 +40,7 @@ export class WorkerTask extends ComChannelEndpoint {
 
     async initWorker(def: WorkerMessageDef): Promise<WorkerMessage> {
         return new Promise((resolve, reject) => {
-            if (!this.worker) {
+            if (!this.impl) {
                 reject(new Error('No worker is available. Aborting...'));
                 this.markExecuting(false);
             } else {
@@ -59,14 +59,14 @@ export class WorkerTask extends ComChannelEndpoint {
                     remove: true,
                     log: this.verbose,
                 }]);
-                this.worker.postMessage(message, transferablesToWorker);
+                this.impl.postMessage(message, transferablesToWorker);
             }
         });
     }
 
     async executeWorker(def: WorkerExecutionDef): Promise<WorkerMessage> {
         return new Promise((resolve, reject) => {
-            if (!this.worker) {
+            if (!this.impl) {
                 reject(new Error('No worker is available. Aborting...'));
                 this.markExecuting(false);
             } else {
@@ -100,7 +100,7 @@ export class WorkerTask extends ComChannelEndpoint {
                     });
                 }
                 this.updateAwaitHandlers(message, awaitHandlers);
-                this.worker.postMessage(message, transferablesToWorker);
+                this.impl.postMessage(message, transferablesToWorker);
             }
         });
     }

diff --git a/packages/wtd-three-ext/README.md b/packages/wtd-three-ext/README.md
@@ -28,9 +28,9 @@ This shall give you an idea how you can use module worker with `WorkerTask` (der
 ```js
 // let WorkerTask create the worker
 const workerTask = new WorkerTask({
-    taskName,
-    workerId: 1,
-    workerConfig: {
+    endpointName,
+    endpointId: 1,
+    endpointConfig: {
         $type: 'WorkerConfigParams',
         url: new URL('./HelloWorldWorker.js', import.meta.url),
         workerType: 'module',

diff --git a/packages/wtd-three-ext/package.json b/packages/wtd-three-ext/package.json
@@ -1,6 +1,6 @@
 {
   "name": "wtd-three-ext",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "license": "MIT",
   "type": "module",
   "main": "./dist/index.js",
@@ -45,7 +45,7 @@
     "npm": "10.8.3"
   },
   "dependencies": {
-    "wtd-core": "~3.1.0",
+    "wtd-core": "~4.0.0",
     "three": "~0.169.0"
   },
   "devDependencies": {