Fix custom raster developer example (#142664)

elastic · Oct 4, 2022 · fc8407d · fc8407d
1 parent 7f3541c
commit fc8407d
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 2 deletions.
diff --git a/x-pack/examples/third_party_maps_source_example/public/classes/custom_raster_source.tsx b/x-pack/examples/third_party_maps_source_example/public/classes/custom_raster_source.tsx
@@ -5,6 +5,7 @@
  * 2.0.
  */
 
+import _ from 'lodash';
 import { ReactElement } from 'react';
 import { calculateBounds } from '@kbn/data-plugin/common';
 import { FieldFormatter, MIN_ZOOM, MAX_ZOOM } from '@kbn/maps-plugin/common';
@@ -16,15 +17,18 @@ import type {
   Timeslice,
 } from '@kbn/maps-plugin/common/descriptor_types';
 import type {
+  DataRequest,
   IField,
   ImmutableSourceProperty,
-  ITMSSource,
+  IRasterSource,
   SourceEditorArgs,
 } from '@kbn/maps-plugin/public';
+import { RasterTileSourceData } from '@kbn/maps-plugin/public/classes/sources/raster_source';
+import { RasterTileSource } from 'maplibre-gl';
 
 type CustomRasterSourceDescriptor = AbstractSourceDescriptor;
 
-export class CustomRasterSource implements ITMSSource {
+export class CustomRasterSource implements IRasterSource {
   static type = 'CUSTOM_RASTER';
 
   readonly _descriptor: CustomRasterSourceDescriptor;
@@ -39,6 +43,25 @@ export class CustomRasterSource implements ITMSSource {
     this._descriptor = sourceDescriptor;
   }
 
+  async canSkipSourceUpdate(
+    dataRequest: DataRequest,
+    nextRequestMeta: DataRequestMeta
+  ): Promise<boolean> {
+    const prevMeta = dataRequest.getMeta();
+    if (!prevMeta) {
+      return Promise.resolve(false);
+    }
+
+    return Promise.resolve(_.isEqual(prevMeta.timeslice, nextRequestMeta.timeslice));
+  }
+
+  isSourceStale(mbSource: RasterTileSource, sourceData: RasterTileSourceData): boolean {
+    if (!sourceData.url) {
+      return false;
+    }
+    return mbSource.tiles?.[0] !== sourceData.url;
+  }
+
   cloneDescriptor(): CustomRasterSourceDescriptor {
     return {
       type: this._descriptor.type,

diff --git a/x-pack/plugins/maps/public/classes/sources/kibana_tilemap_source/kibana_tilemap_source.js b/x-pack/plugins/maps/public/classes/sources/kibana_tilemap_source/kibana_tilemap_source.js
@@ -41,15 +41,18 @@ export class KibanaTilemapSource extends AbstractSource {
       },
     ];
   }
+
   isSourceStale(mbSource, sourceData) {
     if (!sourceData.url) {
       return false;
     }
     return mbSource.tiles?.[0] !== sourceData.url;
   }
+
   async canSkipSourceUpdate() {
     return false;
   }
+
   async getUrlTemplate() {
     const tilemap = getKibanaTileMap();
     if (!tilemap.url) {

diff --git a/x-pack/plugins/maps/public/classes/sources/wms_source/wms_source.js b/x-pack/plugins/maps/public/classes/sources/wms_source/wms_source.js
@@ -27,15 +27,18 @@ export class WMSSource extends AbstractSource {
       styles,
     };
   }
+
   isSourceStale(mbSource, sourceData) {
     if (!sourceData.url) {
       return false;
     }
     return mbSource.tiles?.[0] !== sourceData.url;
   }
+
   async canSkipSourceUpdate() {
     return false;
   }
+
   async getImmutableProperties() {
     return [
       { label: getDataSourceLabel(), value: sourceTitle },

diff --git a/x-pack/plugins/maps/public/index.ts b/x-pack/plugins/maps/public/index.ts
@@ -35,6 +35,7 @@ export type { MapEmbeddable, MapEmbeddableInput, MapEmbeddableOutput } from './e
 export type { EMSTermJoinConfig, SampleValuesConfig } from './ems_autosuggest';
 
 export type { ITMSSource } from './classes/sources/tms_source';
+export type { IRasterSource } from './classes/sources/raster_source';
 
 export type {
   GetFeatureActionsArgs,