Improve and typescriptify update status (#20546)

* [tslint] use exitCode 1 when linter errors

* fix typo

* Improve getUpdateStatus

* Fix accessing timeRange

* Extract comparison functions

* Switch parameter order

* Revert "[tslint] use exitCode 1 when linter errors"

This reverts commit 0ca23a4.

* Revert "fix typo"

This reverts commit e4e8091.

Author: timroes

src/ui/public/vis/lib/calculate_object_hash.d.ts

@@ -0,0 +1,20 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export function calculateObjectHash(obj: object): string;

src/ui/public/vis/update_status.js

@@ -28,7 +28,7 @@ const changeFunctions = {
   [Status.DATA]: ($scope) => $scope.visData = { foo: 'new' },
   [Status.PARAMS]: ($scope) => $scope.vis.params = { foo: 'new' },
   [Status.RESIZE]: ($scope) => $scope.vis.size = [50, 50],
-  [Status.TIME]: ($scope) => $scope.vis.API.timeFilter.getBounds = () => [100, 100],
+  [Status.TIME]: ($scope) => $scope.vis.filters.timeRange = { from: 'now-7d', to: 'now' },
   [Status.UI_STATE]: ($scope) => $scope.uiState = { foo: 'new' },
 };
 
@@ -41,11 +41,7 @@ describe('getUpdateStatus', () => {
         size: [100, 100],
         params: {
         },
-        API: {
-          timeFilter: {
-            getBounds: () => [50, 50]
-          }
-        }
+        filters: {}
       },
       uiState: {},
       visData: {}

src/ui/public/vis/update_status.test.js

@@ -0,0 +1,116 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { calculateObjectHash } from './lib/calculate_object_hash';
+import { Vis } from './vis';
+
+enum Status {
+  AGGS = 'aggs',
+  DATA = 'data',
+  PARAMS = 'params',
+  RESIZE = 'resize',
+  TIME = 'time',
+  UI_STATE = 'uiState',
+}
+
+/**
+ * Checks whether the hash of a specific key in the given oldStatus has changed
+ * compared to the new valueHash passed.
+ */
+function hasHashChanged<T extends string>(
+  valueHash: string,
+  oldStatus: { [key in T]?: string },
+  name: T
+): boolean {
+  const oldHash = oldStatus[name];
+  return oldHash !== valueHash;
+}
+
+interface Size {
+  width: number;
+  height: number;
+}
+
+function hasSizeChanged(size: Size, oldSize?: Size): boolean {
+  if (!oldSize) {
+    return true;
+  }
+  return oldSize.width !== size.width || oldSize.height !== size.height;
+}
+
+function getUpdateStatus<T extends Status>(
+  requiresUpdateStatus: T[] = [],
+  obj: any,
+  param: { vis: Vis; visData: any; uiState: any }
+): { [reqStats in T]: boolean } {
+  const status = {} as { [reqStats in T]: boolean };
+
+  // If the vis type doesn't need update status, skip all calculations
+  if (requiresUpdateStatus.length === 0) {
+    return status;
+  }
+
+  if (!obj._oldStatus) {
+    obj._oldStatus = {};
+  }
+
+  for (const requiredStatus of requiresUpdateStatus) {
+    let hash;
+    // Calculate all required status updates for this visualization
+    switch (requiredStatus) {
+      case Status.AGGS:
+        hash = calculateObjectHash(param.vis.aggs);
+        status.aggs = hasHashChanged(hash, obj._oldStatus, 'aggs');
+        obj._oldStatus.aggs = hash;
+        break;
+      case Status.DATA:
+        hash = calculateObjectHash(param.visData);
+        status.data = hasHashChanged(hash, obj._oldStatus, 'data');
+        obj._oldStatus.data = hash;
+        break;
+      case Status.PARAMS:
+        hash = calculateObjectHash(param.vis.params);
+        status.params = hasHashChanged(hash, obj._oldStatus, 'param');
+        obj._oldStatus.param = hash;
+        break;
+      case Status.RESIZE:
+        const width: number = param.vis.size ? param.vis.size[0] : 0;
+        const height: number = param.vis.size ? param.vis.size[1] : 0;
+        const size = { width, height };
+        status.resize = hasSizeChanged(size, obj._oldStatus.resize);
+        obj._oldStatus.resize = size;
+        break;
+      case Status.TIME:
+        const timeRange = param.vis.filters && param.vis.filters.timeRange;
+        hash = calculateObjectHash(timeRange);
+        status.time = hasHashChanged(hash, obj._oldStatus, 'time');
+        obj._oldStatus.time = hash;
+        break;
+      case Status.UI_STATE:
+        hash = calculateObjectHash(param.uiState);
+        status.uiState = hasHashChanged(hash, obj._oldStatus, 'uiState');
+        obj._oldStatus.uiState = hash;
+        break;
+    }
+  }
+
+  return status;
+}
+
+export { getUpdateStatus, Status };