@carto/api-client 0.5.0-alpha.8 → 0.5.0

package/src/widget-sources/widget-tileset-source.ts

@@ -55,21 +55,26 @@ export type WidgetTilesetSourceResult = {widgetSource: WidgetTilesetSource};
  * const { widgetSource } = await data;
  * ```
  */
-export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps> {
+export class WidgetTilesetSource<
+  Props extends WidgetTilesetSourceProps = WidgetTilesetSourceProps,
+> extends WidgetSource<Props> {
   protected _localImpl: WidgetTilesetSourceImpl | null = null;
 
   protected _workerImpl: Worker | null = null;
   protected _workerEnabled: boolean;
   protected _workerNextRequestId = 1;
 
-  constructor(props: WidgetTilesetSourceProps) {
+  constructor(props: Props) {
     super(props);
 
     this._workerEnabled =
-      (props.widgetSourceWorker ?? true) && TSUP_FORMAT !== 'cjs';
-    this._localImpl = this._workerEnabled
-      ? null
-      : new WidgetTilesetSourceImpl(this.props);
+      (props.widgetWorker ?? true) &&
+      TSUP_FORMAT !== 'cjs' &&
+      typeof Worker !== 'undefined';
+
+    if (!this._workerEnabled) {
+      this._localImpl = new WidgetTilesetSourceImpl(this.props);
+    }
   }
 
   destroy() {
@@ -89,28 +94,25 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
    * Returns an initialized Worker, to be reused for the lifecycle of this
    * source instance.
    */
-  protected _getWorker(): Worker | null {
-    if (this._workerImpl || this._localImpl) {
+  protected _getWorker(): Worker {
+    if (this._workerImpl) {
       return this._workerImpl;
     }
 
-    try {
-      this._workerImpl = new Worker(new URL('worker.js', import.meta.url), {
+    this._workerImpl = new Worker(
+      new URL('@carto/api-client/worker', import.meta.url),
+      {
         type: 'module',
         name: 'cartowidgettileset',
-      });
+      }
+    );
 
-      this._workerImpl.postMessage({
-        method: Method.INIT,
-        params: [this.props],
-      } as WorkerRequest);
+    this._workerImpl.postMessage({
+      method: Method.INIT,
+      params: [this.props],
+    } as WorkerRequest);
 
-      return this._workerImpl;
-    } catch {
-      this._workerEnabled = false;
-      this._localImpl = new WidgetTilesetSourceImpl(this.props);
-      return null;
-    }
+    return this._workerImpl;
   }
 
   /** Executes a given method on the worker. */
@@ -119,23 +121,14 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
     params: unknown[],
     signal?: AbortSignal
   ): Promise<T> {
-    const worker = this._getWorker();
-    if (!worker) {
+    if (!this._workerEnabled) {
       // @ts-expect-error No type-checking dynamic method name.
       return this._localImpl[method](...params);
     }
 
+    const worker = this._getWorker();
     const requestId = this._workerNextRequestId++;
 
-    // TODO: ViewState may contain non-serializable data, which we do not need.
-    // Remove this sanitization after sc-469614 is fixed.
-    const options = params[0] as any;
-    if (options?.spatialIndexReferenceViewState) {
-      const {zoom, latitude, longitude} =
-        options.spatialIndexReferenceViewState;
-      options.spatialIndexReferenceViewState = {zoom, latitude, longitude};
-    }
-
     let resolve: ((value: T) => void) | null = null;
     let reject: ((reason: any) => void) | null = null;
 
@@ -145,10 +138,9 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
     function onMessage(e: MessageEvent) {
       const response = e.data as WorkerResponse;
       if (response.requestId !== requestId) return;
+      if (signal?.aborted) return; // handled by 'abort' listener
 
-      if (signal?.aborted) {
-        reject!(new Error(signal.reason));
-      } else if (response.ok) {
+      if (response.ok) {
         resolve!(response.result as T);
       } else {
         reject!(new Error(response.error));
@@ -193,16 +185,28 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
    * before computing statistics on the tiles.
    */
   loadTiles(tiles: unknown[]) {
-    const worker = this._getWorker();
-    if (!worker) {
+    if (!this._workerEnabled) {
       return this._localImpl!.loadTiles(tiles);
     }
 
-    tiles = (tiles as Tile[]).map(({id, bbox, data}) => ({
-      id,
-      bbox,
-      data,
-    }));
+    const worker = this._getWorker();
+
+    // We cannot pass an instance of Tile2DHeader to a Web Worker, and must
+    // extract properties required for widget calculations. Note that the
+    // `tile: Tile = {...}` assignment is structured so TS will warn if any
+    // types required by the internal 'Tile' type are missing.
+    tiles = (tiles as Tile[]).map(
+      ({id, index, bbox, isVisible, data}: Tile) => {
+        const tile: Tile = {
+          id,
+          index,
+          isVisible,
+          data,
+          bbox,
+        };
+        return tile;
+      }
+    );
 
     worker.postMessage({
       method: Method.LOAD_TILES,
@@ -212,13 +216,14 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
 
   /** Configures options used to extract features from tiles. */
   setTileFeatureExtractOptions(options: TileFeatureExtractOptions) {
-    const worker = this._getWorker();
-    if (!worker) {
+    if (!this._workerEnabled) {
       return this._localImpl?.setTileFeatureExtractOptions(options);
     }
 
+    const worker = this._getWorker();
+
     worker.postMessage({
-      type: Method.SET_TILE_FEATURE_EXTRACT_OPTIONS,
+      method: Method.SET_TILE_FEATURE_EXTRACT_OPTIONS,
       params: [options],
     });
   }
@@ -235,11 +240,12 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
     geojson: FeatureCollection;
     spatialFilter: SpatialFilter;
   }) {
-    const worker = this._getWorker();
-    if (!worker) {
+    if (!this._workerEnabled) {
       return this._localImpl!.loadGeoJSON({geojson, spatialFilter});
     }
 
+    const worker = this._getWorker();
+
     worker.postMessage({
       method: Method.LOAD_GEOJSON,
       params: [{geojson, spatialFilter}],

package/src/workers/widget-tileset-worker.ts

@@ -1,7 +1,5 @@
-import {
-  WidgetTilesetSource,
-  type WidgetTilesetSourceProps,
-} from '../widget-sources/widget-tileset-source.js';
+import {WidgetTilesetSourceImpl} from '../widget-sources/widget-tileset-source-impl.js';
+import {type WidgetTilesetSourceProps} from '../widget-sources/widget-tileset-source.js';
 import {Method} from './constants.js';
 import type {WorkerRequest, WorkerResponse} from './types.js';
 
@@ -12,15 +10,15 @@ import type {WorkerRequest, WorkerResponse} from './types.js';
  * representing and executing calculations on a single datasource.
  */
 
-let source: WidgetTilesetSource;
+let source: WidgetTilesetSourceImpl;
 
 addEventListener('message', (e) => {
   const {method, params, requestId} = e.data as WorkerRequest;
 
   if (method === Method.INIT) {
-    source = new WidgetTilesetSource({
+    source = new WidgetTilesetSourceImpl({
       ...(params[0] as WidgetTilesetSourceProps),
-      widgetSourceWorker: false,
+      widgetWorker: false,
     });
     return;
   }