[TSVB] Fixing memory leak (elastic#64918)

legrego · May 4, 2020 · 42d92d0 · 42d92d0
1 parent 4bb4534
commit 42d92d0
Show file tree

Hide file tree

Showing 21 changed files with 120 additions and 82 deletions.
diff --git a/src/plugins/vis_type_timeseries/server/lib/vis_data/helpers/index.js b/src/plugins/vis_type_timeseries/server/lib/vis_data/helpers/index.js
@@ -29,6 +29,8 @@ import { getTimerange } from './get_timerange';
 import { mapBucket } from './map_bucket';
 import { parseSettings } from './parse_settings';
 
+export { overwrite } from './overwrite';
+
 export const helpers = {
   bucketTransform,
   getAggValue,

diff --git a/src/plugins/vis_type_timeseries/server/lib/vis_data/helpers/overwrite.js b/src/plugins/vis_type_timeseries/server/lib/vis_data/helpers/overwrite.js
@@ -0,0 +1,31 @@
+/*
+ * 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 set from 'set-value';
+
+/**
+ * Set path in obj. Behaves like lodash `set`
+ * @param obj The object to mutate
+ * @param path The path of the sub-property to set
+ * @param val The value to set the sub-property to
+ */
+export function overwrite(obj, path, val) {
+  set(obj, path, undefined);
+  set(obj, path, val);
+}
diff --git a/.../vis_type_timeseries/server/lib/vis_data/request_processors/annotations/date_histogram.js b/.../vis_type_timeseries/server/lib/vis_data/request_processors/annotations/date_histogram.js
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import _ from 'lodash';
+import { overwrite } from '../../helpers';
 import { getBucketSize } from '../../helpers/get_bucket_size';
 import { getTimerange } from '../../helpers/get_timerange';
 import { search } from '../../../../../../../plugins/data/server';
@@ -37,7 +37,7 @@ export function dateHistogram(
     const { from, to } = getTimerange(req);
     const timezone = capabilities.searchTimezone;
 
-    _.set(doc, `aggs.${annotation.id}.date_histogram`, {
+    overwrite(doc, `aggs.${annotation.id}.date_histogram`, {
       field: timeField,
       min_doc_count: 0,
       time_zone: timezone,

diff --git a/...lugins/vis_type_timeseries/server/lib/vis_data/request_processors/annotations/top_hits.js b/...lugins/vis_type_timeseries/server/lib/vis_data/request_processors/annotations/top_hits.js
@@ -17,13 +17,13 @@
  * under the License.
  */
 
-import _ from 'lodash';
+import { overwrite } from '../../helpers';
 
 export function topHits(req, panel, annotation) {
   return next => doc => {
     const fields = (annotation.fields && annotation.fields.split(/[,\s]+/)) || [];
     const timeField = annotation.time_field;
-    _.set(doc, `aggs.${annotation.id}.aggs.hits.top_hits`, {
+    overwrite(doc, `aggs.${annotation.id}.aggs.hits.top_hits`, {
       sort: [
         {
           [timeField]: { order: 'desc' },

diff --git a/...ugins/vis_type_timeseries/server/lib/vis_data/request_processors/series/date_histogram.js b/...ugins/vis_type_timeseries/server/lib/vis_data/request_processors/series/date_histogram.js
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { set } from 'lodash';
+import { overwrite } from '../../helpers';
 import { getBucketSize } from '../../helpers/get_bucket_size';
 import { offsetTime } from '../../offset_time';
 import { getIntervalAndTimefield } from '../../get_interval_and_timefield';
@@ -34,7 +34,7 @@ export function dateHistogram(req, panel, series, esQueryConfig, indexPatternObj
       const { from, to } = offsetTime(req, series.offset_time);
       const timezone = capabilities.searchTimezone;
 
-      set(doc, `aggs.${series.id}.aggs.timeseries.date_histogram`, {
+      overwrite(doc, `aggs.${series.id}.aggs.timeseries.date_histogram`, {
         field: timeField,
         min_doc_count: 0,
         time_zone: timezone,
@@ -47,7 +47,7 @@ export function dateHistogram(req, panel, series, esQueryConfig, indexPatternObj
     };
 
     const getDateHistogramForEntireTimerangeMode = () =>
-      set(doc, `aggs.${series.id}.aggs.timeseries.auto_date_histogram`, {
+      overwrite(doc, `aggs.${series.id}.aggs.timeseries.auto_date_histogram`, {
         field: timeField,
         buckets: 1,
       });
@@ -58,7 +58,7 @@ export function dateHistogram(req, panel, series, esQueryConfig, indexPatternObj
 
     // master
 
-    set(doc, `aggs.${series.id}.meta`, {
+    overwrite(doc, `aggs.${series.id}.meta`, {
       timeField,
       intervalString,
       bucketSize,

diff --git a/...lugins/vis_type_timeseries/server/lib/vis_data/request_processors/series/filter_ratios.js b/...lugins/vis_type_timeseries/server/lib/vis_data/request_processors/series/filter_ratios.js
@@ -19,16 +19,16 @@
 
 const filter = metric => metric.type === 'filter_ratio';
 import { bucketTransform } from '../../helpers/bucket_transform';
-import _ from 'lodash';
+import { overwrite } from '../../helpers';
 
 export function ratios(req, panel, series) {
   return next => doc => {
     if (series.metrics.some(filter)) {
       series.metrics.filter(filter).forEach(metric => {
-        _.set(doc, `aggs.${series.id}.aggs.timeseries.aggs.${metric.id}-numerator.filter`, {
+        overwrite(doc, `aggs.${series.id}.aggs.timeseries.aggs.${metric.id}-numerator.filter`, {
           query_string: { query: metric.numerator || '*', analyze_wildcard: true },
         });
-        _.set(doc, `aggs.${series.id}.aggs.timeseries.aggs.${metric.id}-denominator.filter`, {
+        overwrite(doc, `aggs.${series.id}.aggs.timeseries.aggs.${metric.id}-denominator.filter`, {
           query_string: { query: metric.denominator || '*', analyze_wildcard: true },
         });
 
@@ -46,8 +46,12 @@ export function ratios(req, panel, series) {
             metricAgg = {};
           }
           const aggBody = { metric: metricAgg };
-          _.set(doc, `aggs.${series.id}.aggs.timeseries.aggs.${metric.id}-numerator.aggs`, aggBody);
-          _.set(
+          overwrite(
+            doc,
+            `aggs.${series.id}.aggs.timeseries.aggs.${metric.id}-numerator.aggs`,
+            aggBody
+          );
+          overwrite(
             doc,
             `aggs.${series.id}.aggs.timeseries.aggs.${metric.id}-denominator.aggs`,
             aggBody
@@ -56,7 +60,7 @@ export function ratios(req, panel, series) {
           denominatorPath = `${metric.id}-denominator>metric`;
         }
 
-        _.set(doc, `aggs.${series.id}.aggs.timeseries.aggs.${metric.id}`, {
+        overwrite(doc, `aggs.${series.id}.aggs.timeseries.aggs.${metric.id}`, {
           bucket_script: {
             buckets_path: {
               numerator: numeratorPath,

diff --git a/...ugins/vis_type_timeseries/server/lib/vis_data/request_processors/series/metric_buckets.js b/...ugins/vis_type_timeseries/server/lib/vis_data/request_processors/series/metric_buckets.js
@@ -16,8 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
-import _ from 'lodash';
+import { overwrite } from '../../helpers';
 import { getBucketSize } from '../../helpers/get_bucket_size';
 import { bucketTransform } from '../../helpers/bucket_transform';
 import { getIntervalAndTimefield } from '../../get_interval_and_timefield';
@@ -33,7 +32,7 @@ export function metricBuckets(req, panel, series, esQueryConfig, indexPatternObj
         if (fn) {
           try {
             const bucket = fn(metric, series.metrics, intervalString);
-            _.set(doc, `aggs.${series.id}.aggs.timeseries.aggs.${metric.id}`, bucket);
+            overwrite(doc, `aggs.${series.id}.aggs.timeseries.aggs.${metric.id}`, bucket);
           } catch (e) {
             // meh
           }

diff --git a/...gins/vis_type_timeseries/server/lib/vis_data/request_processors/series/normalize_query.js b/...gins/vis_type_timeseries/server/lib/vis_data/request_processors/series/normalize_query.js
@@ -16,9 +16,10 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-const { set, get, isEmpty } = require('lodash');
+import { overwrite } from '../../helpers';
+import _ from 'lodash';
 
-const isEmptyFilter = (filter = {}) => Boolean(filter.match_all) && isEmpty(filter.match_all);
+const isEmptyFilter = (filter = {}) => Boolean(filter.match_all) && _.isEmpty(filter.match_all);
 const hasSiblingPipelineAggregation = (aggs = {}) => Object.keys(aggs).length > 1;
 
 /* For grouping by the 'Everything', the splitByEverything request processor
@@ -30,12 +31,12 @@ const hasSiblingPipelineAggregation = (aggs = {}) => Object.keys(aggs).length >
  *
  */
 function removeEmptyTopLevelAggregation(doc, series) {
-  const filter = get(doc, `aggs.${series.id}.filter`);
+  const filter = _.get(doc, `aggs.${series.id}.filter`);
 
   if (isEmptyFilter(filter) && !hasSiblingPipelineAggregation(doc.aggs[series.id].aggs)) {
-    const meta = get(doc, `aggs.${series.id}.meta`);
-    set(doc, `aggs`, doc.aggs[series.id].aggs);
-    set(doc, `aggs.timeseries.meta`, meta);
+    const meta = _.get(doc, `aggs.${series.id}.meta`);
+    overwrite(doc, `aggs`, doc.aggs[series.id].aggs);
+    overwrite(doc, `aggs.timeseries.meta`, meta);
   }
 
   return doc;

diff --git a/...gins/vis_type_timeseries/server/lib/vis_data/request_processors/series/sibling_buckets.js b/...gins/vis_type_timeseries/server/lib/vis_data/request_processors/series/sibling_buckets.js
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import _ from 'lodash';
+import { overwrite } from '../../helpers';
 import { getBucketSize } from '../../helpers/get_bucket_size';
 import { bucketTransform } from '../../helpers/bucket_transform';
 import { getIntervalAndTimefield } from '../../get_interval_and_timefield';
@@ -40,7 +40,7 @@ export function siblingBuckets(
         if (fn) {
           try {
             const bucket = fn(metric, series.metrics, bucketSize);
-            _.set(doc, `aggs.${series.id}.aggs.${metric.id}`, bucket);
+            overwrite(doc, `aggs.${series.id}.aggs.${metric.id}`, bucket);
           } catch (e) {
             // meh
           }

diff --git a/.../vis_type_timeseries/server/lib/vis_data/request_processors/series/split_by_everything.js b/.../vis_type_timeseries/server/lib/vis_data/request_processors/series/split_by_everything.js
@@ -17,15 +17,15 @@
  * under the License.
  */
 
-import _ from 'lodash';
+import { overwrite } from '../../helpers';
 
 export function splitByEverything(req, panel, series) {
   return next => doc => {
     if (
       series.split_mode === 'everything' ||
       (series.split_mode === 'terms' && !series.terms_field)
     ) {
-      _.set(doc, `aggs.${series.id}.filter.match_all`, {});
+      overwrite(doc, `aggs.${series.id}.filter.match_all`, {});
     }
     return next(doc);
   };

diff --git a/...gins/vis_type_timeseries/server/lib/vis_data/request_processors/series/split_by_filter.js b/...gins/vis_type_timeseries/server/lib/vis_data/request_processors/series/split_by_filter.js
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { set } from 'lodash';
+import { overwrite } from '../../helpers';
 import { esQuery } from '../../../../../../data/server';
 
 export function splitByFilter(req, panel, series, esQueryConfig, indexPattern) {
@@ -26,7 +26,7 @@ export function splitByFilter(req, panel, series, esQueryConfig, indexPattern) {
       return next(doc);
     }
 
-    set(
+    overwrite(
       doc,
       `aggs.${series.id}.filter`,
       esQuery.buildEsQuery(indexPattern, [series.filter], [], esQueryConfig)

diff --git a/...ins/vis_type_timeseries/server/lib/vis_data/request_processors/series/split_by_filters.js b/...ins/vis_type_timeseries/server/lib/vis_data/request_processors/series/split_by_filters.js
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { set } from 'lodash';
+import { overwrite } from '../../helpers';
 import { esQuery } from '../../../../../../data/server';
 
 export function splitByFilters(req, panel, series, esQueryConfig, indexPattern) {
@@ -26,7 +26,7 @@ export function splitByFilters(req, panel, series, esQueryConfig, indexPattern)
       series.split_filters.forEach(filter => {
         const builtEsQuery = esQuery.buildEsQuery(indexPattern, [filter.filter], [], esQueryConfig);
 
-        set(doc, `aggs.${series.id}.filters.filters.${filter.id}`, builtEsQuery);
+        overwrite(doc, `aggs.${series.id}.filters.filters.${filter.id}`, builtEsQuery);
       });
     }
     return next(doc);

diff --git a/...ugins/vis_type_timeseries/server/lib/vis_data/request_processors/series/split_by_terms.js b/...ugins/vis_type_timeseries/server/lib/vis_data/request_processors/series/split_by_terms.js
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { set } from 'lodash';
+import { overwrite } from '../../helpers';
 import { basicAggs } from '../../../../../common/basic_aggs';
 import { getBucketsPath } from '../../helpers/get_buckets_path';
 import { bucketTransform } from '../../helpers/bucket_transform';
@@ -27,13 +27,13 @@ export function splitByTerms(req, panel, series) {
     if (series.split_mode === 'terms' && series.terms_field) {
       const direction = series.terms_direction || 'desc';
       const metric = series.metrics.find(item => item.id === series.terms_order_by);
-      set(doc, `aggs.${series.id}.terms.field`, series.terms_field);
-      set(doc, `aggs.${series.id}.terms.size`, series.terms_size);
+      overwrite(doc, `aggs.${series.id}.terms.field`, series.terms_field);
+      overwrite(doc, `aggs.${series.id}.terms.size`, series.terms_size);
       if (series.terms_include) {
-        set(doc, `aggs.${series.id}.terms.include`, series.terms_include);
+        overwrite(doc, `aggs.${series.id}.terms.include`, series.terms_include);
       }
       if (series.terms_exclude) {
-        set(doc, `aggs.${series.id}.terms.exclude`, series.terms_exclude);
+        overwrite(doc, `aggs.${series.id}.terms.exclude`, series.terms_exclude);
       }
       if (metric && metric.type !== 'count' && ~basicAggs.indexOf(metric.type)) {
         const sortAggKey = `${series.terms_order_by}-SORT`;
@@ -42,12 +42,12 @@ export function splitByTerms(req, panel, series) {
           series.terms_order_by,
           sortAggKey
         );
-        set(doc, `aggs.${series.id}.terms.order`, { [bucketPath]: direction });
-        set(doc, `aggs.${series.id}.aggs`, { [sortAggKey]: fn(metric) });
+        overwrite(doc, `aggs.${series.id}.terms.order`, { [bucketPath]: direction });
+        overwrite(doc, `aggs.${series.id}.aggs`, { [sortAggKey]: fn(metric) });
       } else if (['_key', '_count'].includes(series.terms_order_by)) {
-        set(doc, `aggs.${series.id}.terms.order`, { [series.terms_order_by]: direction });
+        overwrite(doc, `aggs.${series.id}.terms.order`, { [series.terms_order_by]: direction });
       } else {
-        set(doc, `aggs.${series.id}.terms.order`, { _count: direction });
+        overwrite(doc, `aggs.${series.id}.terms.order`, { _count: direction });
       }
     }
     return next(doc);

diff --git a/...lugins/vis_type_timeseries/server/lib/vis_data/request_processors/table/date_histogram.js b/...lugins/vis_type_timeseries/server/lib/vis_data/request_processors/table/date_histogram.js
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { set } from 'lodash';
+import { overwrite } from '../../helpers';
 import { getBucketSize } from '../../helpers/get_bucket_size';
 import { isLastValueTimerangeMode } from '../../helpers/get_timerange_mode';
 import { getIntervalAndTimefield } from '../../get_interval_and_timefield';
@@ -41,7 +41,7 @@ export function dateHistogram(req, panel, esQueryConfig, indexPatternObject, cap
       panel.series.forEach(column => {
         const aggRoot = calculateAggRoot(doc, column);
 
-        set(doc, `${aggRoot}.timeseries.date_histogram`, {
+        overwrite(doc, `${aggRoot}.timeseries.date_histogram`, {
           field: timeField,
           min_doc_count: 0,
           time_zone: timezone,
@@ -52,7 +52,7 @@ export function dateHistogram(req, panel, esQueryConfig, indexPatternObject, cap
           ...dateHistogramInterval(intervalString),
         });
 
-        set(doc, aggRoot.replace(/\.aggs$/, '.meta'), {
+        overwrite(doc, aggRoot.replace(/\.aggs$/, '.meta'), {
           timeField,
           intervalString,
           bucketSize,
@@ -64,12 +64,12 @@ export function dateHistogram(req, panel, esQueryConfig, indexPatternObject, cap
       panel.series.forEach(column => {
         const aggRoot = calculateAggRoot(doc, column);
 
-        set(doc, `${aggRoot}.timeseries.auto_date_histogram`, {
+        overwrite(doc, `${aggRoot}.timeseries.auto_date_histogram`, {
           field: timeField,
           buckets: 1,
         });
 
-        set(doc, aggRoot.replace(/\.aggs$/, '.meta'), meta);
+        overwrite(doc, aggRoot.replace(/\.aggs$/, '.meta'), meta);
       });
     };