feat(explore): Keep or reset chart config after datasource change (#18215)

* feat(explore): Keep or reset chart config after datasource change

* Update copy

* Remove useDispatch

* fix test

* Fix bugs

* Remove ts ignore

* Scroll top when datasource changes

* Fix crashing when switching viz type

superset-frontend/src/explore/controlUtils/getControlValuesCompatibleWithDatasource.ts

@@ -0,0 +1,99 @@
+/**
+ * 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 {
+  ControlState,
+  DatasourceMeta,
+  Metric,
+} from '@superset-ui/chart-controls';
+import {
+  Column,
+  isAdhocMetricSimple,
+  isSavedMetric,
+  isSimpleAdhocFilter,
+  JsonValue,
+  SimpleAdhocFilter,
+} from '@superset-ui/core';
+import AdhocMetric from 'src/explore/components/controls/MetricControl/AdhocMetric';
+
+const isControlValueCompatibleWithDatasource = (
+  datasource: DatasourceMeta,
+  controlState: ControlState,
+  value: any,
+) => {
+  if (controlState.options && typeof value === 'string') {
+    if (
+      (Array.isArray(controlState.options) &&
+        controlState.options.some(
+          (option: [string | number, string]) => option[0] === value,
+        )) ||
+      value in controlState.options
+    ) {
+      return datasource.columns.some(column => column.column_name === value);
+    }
+  }
+  if (
+    controlState.savedMetrics &&
+    isSavedMetric(value) &&
+    controlState.savedMetrics.some(
+      (savedMetric: Metric) => savedMetric.metric_name === value,
+    )
+  ) {
+    return datasource.metrics.some(
+      (metric: Metric) => metric.metric_name === value,
+    );
+  }
+  if (
+    controlState.columns &&
+    (isAdhocMetricSimple(value) || isSimpleAdhocFilter(value)) &&
+    controlState.columns.some(
+      (column: Column) =>
+        column.column_name === (value as AdhocMetric).column?.column_name ||
+        column.column_name === (value as SimpleAdhocFilter).subject,
+    )
+  ) {
+    return datasource.columns.some(
+      (column: Column) =>
+        column.column_name === (value as AdhocMetric).column?.column_name ||
+        column.column_name === (value as SimpleAdhocFilter).subject,
+    );
+  }
+  return false;
+};
+
+export const getControlValuesCompatibleWithDatasource = (
+  datasource: DatasourceMeta,
+  controlState: ControlState,
+  value: JsonValue,
+) => {
+  if (value === undefined || value === null) {
+    return undefined;
+  }
+  if (Array.isArray(value)) {
+    const compatibleValues = value.filter(val =>
+      isControlValueCompatibleWithDatasource(datasource, controlState, val),
+    );
+    return compatibleValues.length > 0
+      ? compatibleValues
+      : controlState.default;
+  }
+  return isControlValueCompatibleWithDatasource(datasource, controlState, value)
+    ? value
+    : controlState.default;
+};