Refactor out controlUtils.js module + unit tests (#7350)

* [WiP]refactor out a controlUtils.js file

* unit tests

* add missing license

* Addressing comments

superset/assets/spec/javascripts/explore/components/ControlPanelsContainer_spec.jsx

@@ -18,7 +18,8 @@
  */
 import React from 'react';
 import { shallow } from 'enzyme';
-import { getFormDataFromControls, defaultControls } from 'src/explore/store';
+import { defaultControls } from 'src/explore/store';
+import { getFormDataFromControls } from 'src/explore/controlUtils';
 import { ControlPanelsContainer } from 'src/explore/components/ControlPanelsContainer';
 import ControlPanelSection from 'src/explore/components/ControlPanelSection';
 import * as featureFlags from 'src/featureFlags';

superset/assets/spec/javascripts/explore/controlUtils_spec.jsx

@@ -0,0 +1,164 @@
+/**
+ * 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.
+ */
+import {
+  getControlConfig,
+  getControlState,
+  getControlKeys,
+  applyMapStateToPropsToControl,
+} from '../../../src/explore/controlUtils';
+
+describe('controlUtils', () => {
+  const state = {
+    datasource: {
+      columns: [
+        'a', 'b', 'c',
+      ],
+      metrics: [
+        { metric_name: 'first' },
+        { metric_name: 'second' },
+      ],
+    },
+  };
+
+  describe('getControlConfig', () => {
+    it('returns a valid spatial controlConfig', () => {
+      const spatialControl = getControlConfig('spatial', 'deck_grid');
+      expect(spatialControl.type).toEqual('SpatialControl');
+      expect(spatialControl.validators).toHaveLength(1);
+    });
+    it('overrides according to vizType', () => {
+      let control = getControlConfig('metric', 'line');
+      expect(control.type).toEqual('MetricsControl');
+      expect(control.validators).toHaveLength(1);
+
+      // deck_polygon overrides and removes validators
+      control = getControlConfig('metric', 'deck_polygon');
+      expect(control.type).toEqual('MetricsControl');
+      expect(control.validators).toHaveLength(0);
+    });
+  });
+
+  describe('getControlKeys', () => {
+
+    window.featureFlags = {
+      SCOPED_FILTER: false,
+    };
+
+    it('gets only strings, even when React components are in conf', () => {
+      const keys = getControlKeys('filter_box');
+      expect(keys.every(k => typeof k === 'string')).toEqual(true);
+      expect(keys).toHaveLength(16);
+    });
+    it('gets the right set of controlKeys for filter_box', () => {
+      const keys = getControlKeys('filter_box');
+      expect(keys.sort()).toEqual([
+        'adhoc_filters',
+        'cache_timeout',
+        'datasource',
+        'date_filter',
+        'druid_time_origin',
+        'filter_configs',
+        'granularity',
+        'instant_filtering',
+        'show_druid_time_granularity',
+        'show_druid_time_origin',
+        'show_sqla_time_column',
+        'show_sqla_time_granularity',
+        'slice_id',
+        'time_range',
+        'url_params',
+        'viz_type',
+      ]);
+    });
+  });
+
+  describe('applyMapStateToPropsToControl,', () => {
+    it('applies state to props as expected', () => {
+      let control = getControlConfig('all_columns', 'table');
+      control = applyMapStateToPropsToControl(control, state);
+      expect(control.options).toEqual(['a', 'b', 'c']);
+    });
+
+    it('removes the mapStateToProps key from the object', () => {
+      let control = getControlConfig('all_columns', 'table');
+      control = applyMapStateToPropsToControl(control, state);
+      expect(control.mapStateToProps).toBe(undefined);
+    });
+
+  });
+
+  describe('getControlState', () => {
+
+    it('to be function free', () => {
+      const control = getControlState('all_columns', 'table', state, ['a']);
+      expect(control.mapStateToProps).toBe(undefined);
+      expect(control.validators).toBe(undefined);
+    });
+
+    it('to fix multi with non-array values', () => {
+      const control = getControlState('all_columns', 'table', state, 'a');
+      expect(control.value).toEqual(['a']);
+    });
+
+    it('removes missing/invalid choice', () => {
+      let control = getControlState('stacked_style', 'area', state, 'stack');
+      expect(control.value).toBe('stack');
+
+      control = getControlState('stacked_style', 'area', state, 'FOO');
+      expect(control.value).toBe(null);
+    });
+
+    it('applies the default function for metrics', () => {
+      const control = getControlState('metrics', 'table', state);
+      expect(control.default).toEqual(['first']);
+    });
+
+    it('applies the default function for metric', () => {
+      const control = getControlState('metric', 'table', state);
+      expect(control.default).toEqual('first');
+    });
+
+    it('applies the default function, prefers count if it exists', () => {
+      const stateWithCount = {
+        ...state,
+        datasource: {
+          ...state.datasource,
+          metrics: [
+            { metric_name: 'first' },
+            { metric_name: 'second' },
+            { metric_name: 'count' },
+          ],
+        },
+      };
+      const control = getControlState('metrics', 'table', stateWithCount);
+      expect(control.default).toEqual(['count']);
+    });
+
+  });
+
+  describe('validateControl', () => {
+
+    it('validates the control, returns an error if empty', () => {
+      const control = getControlState('metric', 'table', state, null);
+      expect(control.validationErrors).toEqual(['cannot be empty']);
+    });
+
+  });
+
+});

superset/assets/spec/javascripts/explore/store_spec.jsx

@@ -0,0 +1,66 @@
+/**
+ * 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.
+ */
+import { applyDefaultFormData } from '../../../src/explore/store';
+
+describe('store', () => {
+
+  describe('applyDefaultFormData', () => {
+
+    window.featureFlags = {
+      SCOPED_FILTER: false,
+    };
+
+    it('applies default to formData if the key is missing', () => {
+      const inputFormData = {
+        datasource: '11_table',
+        viz_type: 'table',
+      };
+      let outputFormData = applyDefaultFormData(inputFormData);
+      expect(outputFormData.row_limit).toEqual(10000);
+
+      const inputWithRowLimit = {
+        ...inputFormData,
+        row_limit: 888,
+      };
+      outputFormData = applyDefaultFormData(inputWithRowLimit);
+      expect(outputFormData.row_limit).toEqual(888);
+    });
+
+    it('keeps null if key is defined with null', () => {
+      const inputFormData = {
+        datasource: '11_table',
+        viz_type: 'table',
+        row_limit: null,
+      };
+      const outputFormData = applyDefaultFormData(inputFormData);
+      expect(outputFormData.row_limit).toBe(null);
+    });
+
+    it('removes out of scope, or deprecated keys', () => {
+      const inputFormData = {
+        datasource: '11_table',
+        viz_type: 'table',
+        this_should_no_be_here: true,
+      };
+      const outputFormData = applyDefaultFormData(inputFormData);
+      expect(outputFormData.this_should_no_be_here).toBe(undefined);
+    });
+
+  });
+});

superset/assets/src/explore/components/ExploreViewContainer.jsx

@@ -29,7 +29,7 @@ import SaveModal from './SaveModal';
 import QueryAndSaveBtns from './QueryAndSaveBtns';
 import { getExploreUrlAndPayload, getExploreLongUrl } from '../exploreUtils';
 import { areObjectsEqual } from '../../reduxUtils';
-import { getFormDataFromControls } from '../store';
+import { getFormDataFromControls } from '../controlUtils';
 import { chartPropShape } from '../../dashboard/util/propShapes';
 import * as exploreActions from '../actions/exploreActions';
 import * as saveModalActions from '../actions/saveModalActions';

superset/assets/src/explore/controlUtils.js

@@ -0,0 +1,124 @@
+/**
+ * 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.
+ */
+import controlPanelConfigs, { sectionsToRender } from './controlPanels';
+import controls from './controls';
+
+export function getFormDataFromControls(controlsState) {
+  const formData = {};
+  Object.keys(controlsState).forEach((controlName) => {
+    formData[controlName] = controlsState[controlName].value;
+  });
+  return formData;
+}
+
+export function validateControl(control) {
+  const validators = control.validators;
+  if (validators && validators.length > 0) {
+    const validatedControl = { ...control };
+    const validationErrors = [];
+    validators.forEach((f) => {
+      const v = f(control.value);
+      if (v) {
+        validationErrors.push(v);
+      }
+    });
+    delete validatedControl.validators;
+    return { ...validatedControl, validationErrors };
+  }
+  return control;
+}
+
+export function getControlKeys(vizType, datasourceType) {
+  const controlKeys = [];
+  sectionsToRender(vizType, datasourceType).forEach(
+    section => section.controlSetRows.forEach(
+      fieldsetRow => fieldsetRow.forEach(
+        (field) => {
+          if (typeof field === 'string') {
+            controlKeys.push(field);
+          }
+        })));
+  return controlKeys;
+}
+
+export function getControlConfig(controlKey, vizType) {
+  // Gets the control definition, applies overrides, and executes
+  // the mapStatetoProps
+  const vizConf = controlPanelConfigs[vizType] || {};
+  const controlOverrides = vizConf.controlOverrides || {};
+  const control = {
+    ...controls[controlKey],
+    ...controlOverrides[controlKey],
+  };
+  return control;
+}
+
+export function applyMapStateToPropsToControl(control, state) {
+  if (control.mapStateToProps) {
+    const appliedControl = { ...control };
+    if (state) {
+      Object.assign(appliedControl, control.mapStateToProps(state, control));
+    }
+    delete appliedControl.mapStateToProps;
+    return appliedControl;
+  }
+  return control;
+}
+
+function handleMissingChoice(controlKey, control) {
+  // If the value is not valid anymore based on choices, clear it
+  const value = control.value;
+  if (
+    control.type === 'SelectControl' &&
+    !control.freeForm &&
+    control.choices &&
+    value
+  ) {
+    const alteredControl = { ...control };
+    const choiceValues = control.choices.map(c => c[0]);
+    if (control.multi && value.length > 0) {
+      alteredControl.value = value.filter(el => choiceValues.indexOf(el) > -1);
+      return alteredControl;
+    } else if (!control.multi && choiceValues.indexOf(value) < 0) {
+      alteredControl.value = null;
+      return alteredControl;
+    }
+  }
+  return control;
+}
+
+export function getControlState(controlKey, vizType, state, value) {
+  let controlValue = value;
+  const controlConfig = getControlConfig(controlKey, vizType);
+  let controlState = { ...controlConfig };
+  controlState = applyMapStateToPropsToControl(controlState, state);
+
+  // If default is a function, evaluate it
+  if (typeof controlState.default === 'function') {
+    controlState.default = controlState.default(controlState);
+  }
+
+  // If a choice control went from multi=false to true, wrap value in array
+  if (controlConfig.multi && value && !Array.isArray(value)) {
+    controlValue = [value];
+  }
+  controlState.value = controlValue === undefined ? controlState.default : controlValue;
+  controlState = handleMissingChoice(controlKey, controlState);
+  return validateControl(controlState);
+}