Refactor getWorkerSource interface

GitOrigin-RevId: 2e96d1ddf677f0db069280fa021786713f7c7d16

Author: stepankuzmin

src/source/worker.ts

@@ -20,20 +20,10 @@ import type {TaskMetadata} from '../util/scheduler';
 import type {RtlTextPlugin} from './rtl_text_plugin';
 import type {RasterizedImageMap} from '../render/image_manager';
 import type {ActorMessage, ActorMessages} from '../util/actor_messages';
-import type {WorkerSource, WorkerSourceConstructor} from './worker_source';
+import type {WorkerSourceType, WorkerSource, WorkerSourceConstructor, WorkerSourceRequest} from './worker_source';
 import type {StyleModelMap} from '../style/style_mode';
 import type {Callback} from '../types/callback';
 
-/**
- * Source types that can instantiate a {@link WorkerSource} in {@link MapWorker}.
- */
-type WorkerSourceType =
-    | 'vector'
-    | 'geojson'
-    | 'raster-dem'
-    | 'raster-array'
-    | 'batched-model';
-
 /**
  * Generic type for grouping items by mapId and style scope.
  */
@@ -232,27 +222,27 @@ export default class MapWorker {
     loadTile(mapId: number, params: ActorMessages['loadTile']['params'], callback: ActorMessages['loadTile']['callback']) {
         assert(params.type);
         params.projection = this.projections[mapId] || this.defaultProjection;
-        this.getWorkerSource(mapId, params.type, params.source, params.scope).loadTile(params, callback);
+        this.getWorkerSource(mapId, params).loadTile(params, callback);
     }
 
     decodeRasterArray(mapId: number, params: ActorMessages['decodeRasterArray']['params'], callback: ActorMessages['decodeRasterArray']['callback']) {
-        (this.getWorkerSource(mapId, params.type, params.source, params.scope) as RasterArrayTileWorkerSource).decodeRasterArray(params, callback);
+        (this.getWorkerSource(mapId, params) as RasterArrayTileWorkerSource).decodeRasterArray(params, callback);
     }
 
     reloadTile(mapId: number, params: ActorMessages['reloadTile']['params'], callback: ActorMessages['reloadTile']['callback']) {
         assert(params.type);
         params.projection = this.projections[mapId] || this.defaultProjection;
-        this.getWorkerSource(mapId, params.type, params.source, params.scope).reloadTile(params, callback);
+        this.getWorkerSource(mapId, params).reloadTile(params, callback);
     }
 
     abortTile(mapId: number, params: ActorMessages['abortTile']['params'], callback: ActorMessages['abortTile']['callback']) {
         assert(params.type);
-        this.getWorkerSource(mapId, params.type, params.source, params.scope).abortTile(params, callback);
+        this.getWorkerSource(mapId, params).abortTile(params, callback);
     }
 
     removeTile(mapId: number, params: ActorMessages['removeTile']['params'], callback: ActorMessages['removeTile']['callback']) {
         assert(params.type);
-        this.getWorkerSource(mapId, params.type, params.source, params.scope).removeTile(params, callback);
+        this.getWorkerSource(mapId, params).removeTile(params, callback);
     }
 
     removeSource(mapId: number, params: ActorMessages['removeSource']['params'], callback: ActorMessages['removeSource']['callback']) {
@@ -374,7 +364,8 @@ export default class MapWorker {
         return layerIndex;
     }
 
-    getWorkerSource(mapId: number, type: string, source: string, scope: string): WorkerSource {
+    getWorkerSource(mapId: number, params: WorkerSourceRequest): WorkerSource {
+        const {type, source, scope} = params;
         const workerSources = this.workerSources;
 
         if (!workerSources[mapId])

src/source/worker_source.ts

@@ -27,6 +27,16 @@ import type {StyleModelMap} from '../style/style_mode';
 import type {IndoorTileOptions} from '../style/indoor_data.js';
 import type {Cancelable} from '../types/cancelable';
 
+/**
+ * Source types that can instantiate a {@link WorkerSource} in {@link MapWorker}.
+ */
+export type WorkerSourceType =
+    | 'vector'
+    | 'geojson'
+    | 'raster-dem'
+    | 'raster-array'
+    | 'batched-model';
+
 /**
  * The parameters passed to the {@link MapWorker#getWorkerSource}.
  */

src/types/worker.ts

@@ -1,13 +1,13 @@
 import type MapWorker from '../source/worker';
 import type {RtlTextPlugin} from '../source/rtl_text_plugin';
-import type {WorkerSourceConstructor, WorkerSource} from '../source/worker_source';
+import type {WorkerSourceConstructor, WorkerSource, WorkerSourceRequest} from '../source/worker_source';
 
 // Extends Worker interface in a browser environment
 declare global {
     interface Worker {
         worker: MapWorker;
         registerWorkerSource?: (name: string, WorkerSource: WorkerSourceConstructor) => void;
-        getWorkerSource?: (mapId: number, type: string, source: string, scope: string) => WorkerSource;
+        getWorkerSource?: (mapId: number, params: WorkerSourceRequest) => WorkerSource;
         registerRTLTextPlugin?: (rtlTextPlugin?: RtlTextPlugin) => void;
 
         importScripts: (...urls: string[]) => void;

src/util/actor.ts

@@ -186,7 +186,7 @@ class Actor {
                 // task.type == sourcetype.method
                 const keys = task.type.split('.');
                 const {source, scope} = params as {source: string; scope: string};
-                const workerSource = this.parent.getWorkerSource(task.sourceMapId, keys[0], source, scope);
+                const workerSource = this.parent.getWorkerSource(task.sourceMapId, {type: keys[0], source, scope, uid: 0});
                 // eslint-disable-next-line @typescript-eslint/no-unsafe-call
                 workerSource[keys[1]](params, done);
             } else {

test/unit/source/worker.test.ts

@@ -67,8 +67,8 @@ test('worker sources should be scoped', () => {
 
     _self.registerWorkerSource('sourceType', function () {} as unknown as WorkerSourceConstructor);
 
-    const a = worker.getWorkerSource(999, 'sourceType', 'sourceId', 'scope1');
-    const b = worker.getWorkerSource(999, 'sourceType', 'sourceId', 'scope2');
+    const a = worker.getWorkerSource(999, {type: 'sourceType', source: 'sourceId', scope: 'scope1', uid: 0});
+    const b = worker.getWorkerSource(999, {type: 'sourceType', source: 'sourceId', scope: 'scope2', uid: 0});
 
     expect(a).not.toBe(b);
 });