[incubator-superset] branch master updated: Adding custom control overrides (#6956)

[mi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

michellet pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-superset.git


The following commit(s) were added to refs/heads/master by this push:
     new e619405  Adding custom control overrides (#6956)
e619405 is described below

commit e6194051f486e42922dc4e34a861f4490c1062fc
Author: michellethomas <mi...@gmail.com>
AuthorDate: Wed Mar 6 15:04:04 2019 -0800

    Adding custom control overrides (#6956)
    
    * Adding extraOverrides to line chart
    
    * Updating extraOverrides to fit with more cases
    
    * Moving extraOverrides to index.js
    
    * Removing webpack-merge in package.json
    
    * Fixing metrics control clearing metric
---
 .../explore/components/controls/MetricsControl.jsx | 31 +++++++++++++++++++---
 .../src/explore/controlPanels/extraOverrides.js    | 22 +++++++++++++++
 superset/assets/src/explore/controlPanels/index.js |  5 ++--
 3 files changed, 52 insertions(+), 6 deletions(-)

diff --git a/superset/assets/src/explore/components/controls/MetricsControl.jsx b/superset/assets/src/explore/components/controls/MetricsControl.jsx
index 02078ff..b42cc81 100644
--- a/superset/assets/src/explore/components/controls/MetricsControl.jsx
+++ b/superset/assets/src/explore/components/controls/MetricsControl.jsx
@@ -60,6 +60,21 @@ function isDictionaryForAdhocMetric(value) {
   return value && !(value instanceof AdhocMetric) && value.expressionType;
 }
 
+function columnsContainAllMetrics(value, nextProps) {
+  const columnNames = new Set(
+    [...nextProps.columns, ...nextProps.savedMetrics]
+    // eslint-disable-next-line camelcase
+      .map(({ column_name, metric_name }) => (column_name || metric_name)),
+  );
+
+  return (Array.isArray(value) ? value : [value])
+    .filter(metric => metric)
+    // find column names
+    .map(metric => metric.column ? metric.column.column_name : metric.column_name || metric)
+    .filter(name => name)
+    .every(name => columnNames.has(name));
+}
+
 // adhoc metrics are stored as dictionaries in URL params. We convert them back into the
 // AdhocMetric class for typechecking, consistency and instance method access.
 function coerceAdhocMetrics(value) {
@@ -135,14 +150,22 @@ export default class MetricsControl extends React.PureComponent {
   }
 
   componentWillReceiveProps(nextProps) {
+    const { value } = this.props;
     if (
-      isEqual(this.props.columns) !== isEqual(nextProps.columns) ||
-      isEqual(this.props.savedMetrics) !== isEqual(nextProps.savedMetrics)
+      !isEqual(this.props.columns, nextProps.columns) ||
+      !isEqual(this.props.savedMetrics, nextProps.savedMetrics)
     ) {
+
       this.setState({ options: this.optionsForSelect(nextProps) });
-      this.props.onChange([]);
+
+      // Remove metrics if selected value no longer a column
+      const containsAllMetrics = columnsContainAllMetrics(value, nextProps);
+
+      if (!containsAllMetrics) {
+        this.props.onChange([]);
+      }
     }
-    if (this.props.value !== nextProps.value) {
+    if (value !== nextProps.value) {
       this.setState({ value: coerceAdhocMetrics(nextProps.value) });
     }
   }
diff --git a/superset/assets/src/explore/controlPanels/extraOverrides.js b/superset/assets/src/explore/controlPanels/extraOverrides.js
new file mode 100644
index 0000000..c4b3182
--- /dev/null
+++ b/superset/assets/src/explore/controlPanels/extraOverrides.js
@@ -0,0 +1,22 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF 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.
+ */
+// For individual deployments to add custom overrides
+export default function extraOverrides(controlPanelConfigs) {
+  return controlPanelConfigs;
+}
diff --git a/superset/assets/src/explore/controlPanels/index.js b/superset/assets/src/explore/controlPanels/index.js
index 7034e51..221c5cf 100644
--- a/superset/assets/src/explore/controlPanels/index.js
+++ b/superset/assets/src/explore/controlPanels/index.js
@@ -22,6 +22,7 @@
  */
 import { isFeatureEnabled, FeatureFlag } from 'src/featureFlags';
 import * as sections from './sections';
+import extraOverrides from './extraOverrides';
 
 import Area from './Area';
 import Bar from './Bar';
@@ -72,7 +73,7 @@ import DeckPolygon from './DeckPolygon';
 import DeckScatter from './DeckScatter';
 import DeckScreengrid from './DeckScreengrid';
 
-export const controlPanelConfigs = {
+export const controlPanelConfigs = extraOverrides({
   area: Area,
   bar: Bar,
   big_number: BigNumber,
@@ -122,7 +123,7 @@ export const controlPanelConfigs = {
   deck_scatter: DeckScatter,
   deck_screengrid: DeckScreengrid,
 
-};
+});
 
 export default controlPanelConfigs;