Mask timeslider (#102046)

* [Maps] timeslider feature mask * create mask * include timeField in documntes pulled from es * fix edge case where timerange is different then timeslice * tslint * fix can_skip_fetch jest tests * simplify source mock * fix functional tests * fix docvalue_fields functional test * review feedback * do not add method to IVectorLayer interface * fix merge artifact * review feedback * review feedback Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
elastic · Jun 23, 2021 · 81fe541 · 81fe541
1 parent 3dc59a3
commit 81fe541
Show file tree

Hide file tree

Showing 17 changed files with 369 additions and 134 deletions.
diff --git a/x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts b/x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts
@@ -66,6 +66,7 @@ export type VectorSourceRequestMeta = MapFilters & {
   applyGlobalTime: boolean;
   fieldNames: string[];
   geogridPrecision?: number;
+  timesiceMaskField?: string;
   sourceQuery?: MapQuery;
   sourceMeta: VectorSourceSyncMeta;
 };
@@ -84,6 +85,9 @@ export type VectorStyleRequestMeta = MapFilters & {
 export type ESSearchSourceResponseMeta = {
   areResultsTrimmed?: boolean;
   resultsCount?: number;
+  // results time extent, either Kibana time range or timeslider time slice
+  timeExtent?: Timeslice;
+  isTimeExtentForTimeslice?: boolean;
 
   // top hits meta
   areEntitiesTrimmed?: boolean;

diff --git a/x-pack/plugins/maps/public/classes/layers/blended_vector_layer/blended_vector_layer.ts b/x-pack/plugins/maps/public/classes/layers/blended_vector_layer/blended_vector_layer.ts
@@ -22,7 +22,6 @@ import {
   LAYER_STYLE_TYPE,
   FIELD_ORIGIN,
 } from '../../../../common/constants';
-import { isTotalHitsGreaterThan, TotalHits } from '../../../../common/elasticsearch_util';
 import { ESGeoGridSource } from '../../sources/es_geo_grid_source/es_geo_grid_source';
 import { canSkipSourceUpdate } from '../../util/can_skip_fetch';
 import { IESSource } from '../../sources/es_source';
@@ -35,6 +34,7 @@ import {
   DynamicStylePropertyOptions,
   StylePropertyOptions,
   LayerDescriptor,
+  Timeslice,
   VectorLayerDescriptor,
   VectorSourceRequestMeta,
   VectorStylePropertiesDescriptor,
@@ -46,10 +46,6 @@ import { isSearchSourceAbortError } from '../../sources/es_source/es_source';
 
 const ACTIVE_COUNT_DATA_ID = 'ACTIVE_COUNT_DATA_ID';
 
-interface CountData {
-  isSyncClustered: boolean;
-}
-
 function getAggType(
   dynamicProperty: IDynamicStyleProperty<DynamicStylePropertyOptions>
 ): AGG_TYPE.AVG | AGG_TYPE.TERMS {
@@ -216,7 +212,7 @@ export class BlendedVectorLayer extends VectorLayer implements IVectorLayer {
     let isClustered = false;
     const countDataRequest = this.getDataRequest(ACTIVE_COUNT_DATA_ID);
     if (countDataRequest) {
-      const requestData = countDataRequest.getData() as CountData;
+      const requestData = countDataRequest.getData() as { isSyncClustered: boolean };
       if (requestData && requestData.isSyncClustered) {
         isClustered = true;
       }
@@ -294,7 +290,7 @@ export class BlendedVectorLayer extends VectorLayer implements IVectorLayer {
   async syncData(syncContext: DataRequestContext) {
     const dataRequestId = ACTIVE_COUNT_DATA_ID;
     const requestToken = Symbol(`layer-active-count:${this.getId()}`);
-    const searchFilters: VectorSourceRequestMeta = this._getSearchFilters(
+    const searchFilters: VectorSourceRequestMeta = await this._getSearchFilters(
       syncContext.dataFilters,
       this.getSource(),
       this.getCurrentStyle()
@@ -305,6 +301,9 @@ export class BlendedVectorLayer extends VectorLayer implements IVectorLayer {
       prevDataRequest: this.getDataRequest(dataRequestId),
       nextMeta: searchFilters,
       extentAware: source.isFilterByMapBounds(),
+      getUpdateDueToTimeslice: (timeslice?: Timeslice) => {
+        return this._getUpdateDueToTimesliceFromSourceRequestMeta(source, timeslice);
+      },
     });
 
     let activeSource;
@@ -322,22 +321,11 @@ export class BlendedVectorLayer extends VectorLayer implements IVectorLayer {
       let isSyncClustered;
       try {
         syncContext.startLoading(dataRequestId, requestToken, searchFilters);
-        const abortController = new AbortController();
-        syncContext.registerCancelCallback(requestToken, () => abortController.abort());
-        const maxResultWindow = await this._documentSource.getMaxResultWindow();
-        const searchSource = await this._documentSource.makeSearchSource(searchFilters, 0);
-        searchSource.setField('trackTotalHits', maxResultWindow + 1);
-        const resp = await searchSource.fetch({
-          abortSignal: abortController.signal,
-          sessionId: syncContext.dataFilters.searchSessionId,
-          legacyHitsTotal: false,
-        });
-        isSyncClustered = isTotalHitsGreaterThan(
-          (resp.hits.total as unknown) as TotalHits,
-          maxResultWindow
-        );
-        const countData = { isSyncClustered } as CountData;
-        syncContext.stopLoading(dataRequestId, requestToken, countData, searchFilters);
+        isSyncClustered = !(await this._documentSource.canLoadAllDocuments(
+          searchFilters,
+          syncContext.registerCancelCallback.bind(null, requestToken)
+        ));
+        syncContext.stopLoading(dataRequestId, requestToken, { isSyncClustered }, searchFilters);
       } catch (error) {
         if (!(error instanceof DataRequestAbortError) || !isSearchSourceAbortError(error)) {
           syncContext.onLoadError(dataRequestId, requestToken, error.message);

diff --git a/x-pack/plugins/maps/public/classes/layers/heatmap_layer/heatmap_layer.ts b/x-pack/plugins/maps/public/classes/layers/heatmap_layer/heatmap_layer.ts
@@ -111,6 +111,9 @@ export class HeatmapLayer extends AbstractLayer {
         },
         syncContext,
         source: this.getSource(),
+        getUpdateDueToTimeslice: () => {
+          return true;
+        },
       });
     } catch (error) {
       if (!(error instanceof DataRequestAbortError)) {

diff --git a/x-pack/plugins/maps/public/classes/layers/layer.tsx b/x-pack/plugins/maps/public/classes/layers/layer.tsx
@@ -36,6 +36,7 @@ import {
   LayerDescriptor,
   MapExtent,
   StyleDescriptor,
+  Timeslice,
 } from '../../../common/descriptor_types';
 import { ImmutableSourceProperty, ISource, SourceEditorArgs } from '../sources/source';
 import { DataRequestContext } from '../../actions';
@@ -78,7 +79,7 @@ export interface ILayer {
   getMbLayerIds(): string[];
   ownsMbLayerId(mbLayerId: string): boolean;
   ownsMbSourceId(mbSourceId: string): boolean;
-  syncLayerWithMB(mbMap: MbMap): void;
+  syncLayerWithMB(mbMap: MbMap, timeslice?: Timeslice): void;
   getLayerTypeIconName(): string;
   isInitialDataLoadComplete(): boolean;
   getIndexPatternIds(): string[];

diff --git a/x-pack/plugins/maps/public/classes/layers/tiled_vector_layer/tiled_vector_layer.tsx b/x-pack/plugins/maps/public/classes/layers/tiled_vector_layer/tiled_vector_layer.tsx
@@ -21,6 +21,7 @@ import { VectorLayer, VectorLayerArguments } from '../vector_layer';
 import { ITiledSingleLayerVectorSource } from '../../sources/tiled_single_layer_vector_source';
 import { DataRequestContext } from '../../../actions';
 import {
+  Timeslice,
   VectorLayerDescriptor,
   VectorSourceRequestMeta,
 } from '../../../../common/descriptor_types';
@@ -66,7 +67,7 @@ export class TiledVectorLayer extends VectorLayer {
     dataFilters,
   }: DataRequestContext) {
     const requestToken: symbol = Symbol(`layer-${this.getId()}-${SOURCE_DATA_REQUEST_ID}`);
-    const searchFilters: VectorSourceRequestMeta = this._getSearchFilters(
+    const searchFilters: VectorSourceRequestMeta = await this._getSearchFilters(
       dataFilters,
       this.getSource(),
       this._style as IVectorStyle
@@ -84,6 +85,10 @@ export class TiledVectorLayer extends VectorLayer {
           source: this.getSource(),
           prevDataRequest,
           nextMeta: searchFilters,
+          getUpdateDueToTimeslice: (timeslice?: Timeslice) => {
+            // TODO use meta features to determine if tiles already contain features for timeslice.
+            return true;
+          },
         });
         const canSkip = noChangesInSourceState && noChangesInSearchState;
         if (canSkip) {

diff --git a/x-pack/plugins/maps/public/classes/layers/vector_layer/utils.tsx b/x-pack/plugins/maps/public/classes/layers/vector_layer/utils.tsx
@@ -13,7 +13,13 @@ import {
   SOURCE_DATA_REQUEST_ID,
   VECTOR_SHAPE_TYPE,
 } from '../../../../common/constants';
-import { MapExtent, MapQuery, VectorSourceRequestMeta } from '../../../../common/descriptor_types';
+import {
+  DataMeta,
+  MapExtent,
+  MapQuery,
+  Timeslice,
+  VectorSourceRequestMeta,
+} from '../../../../common/descriptor_types';
 import { DataRequestContext } from '../../../actions';
 import { IVectorSource } from '../../sources/vector_source';
 import { DataRequestAbortError } from '../../util/data_request';
@@ -52,13 +58,15 @@ export async function syncVectorSource({
   requestMeta,
   syncContext,
   source,
+  getUpdateDueToTimeslice,
 }: {
   layerId: string;
   layerName: string;
   prevDataRequest: DataRequest | undefined;
   requestMeta: VectorSourceRequestMeta;
   syncContext: DataRequestContext;
   source: IVectorSource;
+  getUpdateDueToTimeslice: (timeslice?: Timeslice) => boolean;
 }): Promise<{ refreshed: boolean; featureCollection: FeatureCollection }> {
   const {
     startLoading,
@@ -76,6 +84,7 @@ export async function syncVectorSource({
         prevDataRequest,
         nextMeta: requestMeta,
         extentAware: source.isFilterByMapBounds(),
+        getUpdateDueToTimeslice,
       });
   if (canSkipFetch) {
     return {
@@ -104,7 +113,14 @@ export async function syncVectorSource({
     ) {
       layerFeatureCollection.features.push(...getCentroidFeatures(layerFeatureCollection));
     }
-    stopLoading(dataRequestId, requestToken, layerFeatureCollection, meta);
+    const responseMeta: DataMeta = meta ? { ...meta } : {};
+    if (requestMeta.applyGlobalTime && (await source.isTimeAware())) {
+      const timesiceMaskField = await source.getTimesliceMaskFieldName();
+      if (timesiceMaskField) {
+        responseMeta.timesiceMaskField = timesiceMaskField;
+      }
+    }
+    stopLoading(dataRequestId, requestToken, layerFeatureCollection, responseMeta);
     return {
       refreshed: true,
       featureCollection: layerFeatureCollection,