refactor(web): Rename (Default)Worker to WebWorker and NodeWorker

Addresses code review comment: `Worker` is a generic and semi-reserved
name that we should not be stepping on.

This renames it to `WebWorker` instead of the suggested `LMWorker` or
`PredictiveTextWorker`. `WebWorker` is a name that was already used
in a few places and seems to better match: there is a corresponding
class for running with node. Naming it `WebWorker` makes it clearer
that this is the corresponding class when running in the browser.

The corresponding class for running under node was renamed to `NodeWorker`.

Test-bot: skip

Author: ermshiperete

web/src/app/browser/src/release-main.ts

@@ -1,5 +1,5 @@
 import { KeymanEngine } from './keymanEngine.js'
-import { Worker } from '@keymanapp/lexical-model-layer/web'
+import { WebWorker } from '@keymanapp/lexical-model-layer/web'
 
 /**
 * Determine path and protocol of executing script, setting them as
@@ -9,4 +9,4 @@ const ss = (document.currentScript as HTMLScriptElement)?.src;
 const sPath = ss ? ss.substring(0, ss.lastIndexOf('/') + 1) : './';
 
 // @ts-ignore
-window['keyman'] = new KeymanEngine(Worker, sPath);
+window['keyman'] = new KeymanEngine(WebWorker, sPath);

web/src/app/webview/src/release-main.ts

@@ -1,5 +1,5 @@
 import { KeymanEngine } from './keymanEngine.js'
-import { Worker } from '@keymanapp/lexical-model-layer/web'
+import { WebWorker } from '@keymanapp/lexical-model-layer/web'
 
 /**
 * Determine path and protocol of executing script, setting them as
@@ -9,4 +9,4 @@ const ss = (document.currentScript as HTMLScriptElement)?.src;
 const sPath = ss ? ss.substring(0, ss.lastIndexOf('/') + 1) : './';
 
 // @ts-ignore
-window['keyman'] = new KeymanEngine(Worker, sPath);
+window['keyman'] = new KeymanEngine(WebWorker, sPath);

web/src/engine/predictive-text/worker-main/src/index.ts

@@ -1,6 +1,6 @@
-export { default as LMLayer } from './lmlayer.js';
-export { default as NodeWorker } from './node/worker.js';
-export { default as WebWorker } from './web/worker.js';
+export { LMLayer } from './lmlayer.js';
+export { NodeWorker } from './node/node-worker.js';
+export { WebWorker } from './web/web-worker.js';
 
 export interface WorkerFactory {
   constructInstance(): Worker

web/src/engine/predictive-text/worker-main/src/node/index.ts

@@ -1,5 +1,5 @@
 export { LMLayer } from '../lmlayer.js';
-export { Worker } from './worker.js';
+export { NodeWorker } from './node-worker.js';
 export { SourcemappedWorker } from './sourcemappedWorker.js';
 
 export interface WorkerFactory {

…tive-text/worker-main/src/node/worker.ts …text/worker-main/src/node/node-worker.tsweb/src/engine/predictive-text/worker-main/src/node/worker.ts renamed to web/src/engine/predictive-text/worker-main/src/node/node-worker.ts web/src/engine/predictive-text/worker-main/src/node/worker.ts renamed to web/src/engine/predictive-text/worker-main/src/node/node-worker.ts

@@ -1,9 +1,12 @@
+/*
+ * Keyman is copyright (C) SIL Global. MIT License.
+ */
 import { MappedWorker } from "./mappedWorker.js";
 import { unwrap } from '../unwrap.js';
 
 import { LMLayerWorkerCode, LMLayerWorkerSourcemapComment } from "@keymanapp/lm-worker/worker-main.wrapped.min.js";
 
-export class Worker {
+export class NodeWorker {
   static constructInstance(): Worker {
     let scriptStr = unwrap(LMLayerWorkerCode);
     const srcMapUrlIndex = scriptStr.indexOf("//# sourceMappingURL")
@@ -12,8 +15,6 @@ export class Worker {
     }
 
     scriptStr += '\n' + LMLayerWorkerSourcemapComment;
-    let worker = new MappedWorker(scriptStr);
-
-    return worker as any as Worker;
+    return new MappedWorker(scriptStr);
   }
 }

web/src/engine/predictive-text/worker-main/src/web/index.ts

@@ -1,5 +1,5 @@
 export { LMLayer } from '../lmlayer.js';
-export { Worker } from './worker.js';
+export { WebWorker } from './web-worker.js';
 export { SourcemappedWorker } from './sourcemappedWorker.js';
 
 export interface WorkerFactory {

web/src/engine/predictive-text/worker-main/src/web/sourcemappedWorker.ts

@@ -2,7 +2,7 @@ import { unwrap } from '../unwrap.js';
 import { LMLayerWorkerCode, LMLayerWorkerSourcemapComment } from "@keymanapp/lm-worker/worker-main.wrapped.js";
 
 export class SourcemappedWorker {
-  // the only difference to DefaultWorker is that this class uses
+  // the only difference to WebWorker is that this class uses
   // the unminified LM* blobs
 
   static constructInstance(): Worker {

…ctive-text/worker-main/src/web/worker.ts …e-text/worker-main/src/web/web-worker.tsweb/src/engine/predictive-text/worker-main/src/web/worker.ts renamed to web/src/engine/predictive-text/worker-main/src/web/web-worker.ts web/src/engine/predictive-text/worker-main/src/web/worker.ts renamed to web/src/engine/predictive-text/worker-main/src/web/web-worker.ts

@@ -1,9 +1,12 @@
+/*
+ * Keyman is copyright (C) SIL Global. MIT License.
+ */
 import { unwrap } from '../unwrap.js';
 import { LMLayerWorkerCode, LMLayerWorkerSourcemapComment } from "@keymanapp/lm-worker/worker-main.wrapped.min.js";
 
-export class Worker {
+export class WebWorker {
   static constructInstance(): Worker {
-    return new globalThis.Worker(this.asBlobURI(LMLayerWorkerCode));
+    return new Worker(this.asBlobURI(LMLayerWorkerCode));
   }
 
   /**

web/src/engine/predictive-text/worker-main/unit_tests/in_browser/cases/top-level-lmlayer.tests.ts

@@ -1,6 +1,6 @@
 import { assert } from 'chai';
 
-import { LMLayer, Worker as WorkerBuilder }  from "@keymanapp/lexical-model-layer/web";
+import { LMLayer, WebWorker }  from "@keymanapp/lexical-model-layer/web";
 
 import { DEFAULT_BROWSER_TIMEOUT } from '@keymanapp/common-test-resources/test-timeouts.mjs';
 import { defaultCapabilities } from '../helpers.mjs';
@@ -10,7 +10,7 @@ describe('LMLayer', function () {
 
   describe('[[constructor]]', function () {
     it('should construct with a single argument', function () {
-      let lmLayer = new LMLayer(defaultCapabilities, WorkerBuilder.constructInstance(), true);
+      let lmLayer = new LMLayer(defaultCapabilities, WebWorker.constructInstance(), true);
       assert.instanceOf(lmLayer, LMLayer);
       lmLayer.shutdown();
     });
@@ -31,7 +31,7 @@ describe('LMLayer', function () {
       // Note:  the full declaration exists; the code we want is wrapped within the func.
       // So... let's just call the func.
       const workerSrc = dummyHandler.toString() + "\ndummyHandler()";
-      let uri = WorkerBuilder.asBlobURI(workerSrc);
+      let uri = WebWorker.asBlobURI(workerSrc);
       assert.match(uri, /^blob:/);
 
       let worker = new Worker(uri);

web/src/engine/predictive-text/worker-main/unit_tests/in_browser/cases/worker-dummy-integration.tests.ts

@@ -1,6 +1,6 @@
 import { assert } from 'chai';
 
-import { LMLayer, Worker }   from "@keymanapp/lexical-model-layer/web";
+import { LMLayer, WebWorker }   from "@keymanapp/lexical-model-layer/web";
 
 import { DEFAULT_BROWSER_TIMEOUT } from '@keymanapp/common-test-resources/test-timeouts.mjs';
 import { defaultCapabilities } from '../helpers.mjs';
@@ -52,7 +52,7 @@ describe('LMLayer using dummy model', function () {
 
   describe('Prediction', function () {
     it('will predict future suggestions', function () {
-      var lmLayer = new LMLayer(defaultCapabilities, Worker.constructInstance(), true);
+      var lmLayer = new LMLayer(defaultCapabilities, WebWorker.constructInstance(), true);
 
       var stripIDs = function(suggestions) {
         suggestions.forEach(function(suggestion) {
@@ -93,7 +93,7 @@ describe('LMLayer using dummy model', function () {
 
   describe('Wordbreaking', function () {
     it('will perform (default) wordbreaking and return word at caret', function () {
-      var lmLayer = new LMLayer(defaultCapabilities, Worker.constructInstance());
+      var lmLayer = new LMLayer(defaultCapabilities, WebWorker.constructInstance());
 
       // We're testing many as asynchronous messages in a row.
       // this would be cleaner using async/await syntax, but