msyavuz commented on code in PR #42898:
URL: https://github.com/apache/superset/pull/42898#discussion_r3797639584
##########
superset-frontend/src/dashboard/components/nativeFilters/FiltersConfigModal/transformers/filterTransformer.ts:
##########
@@ -67,7 +67,16 @@ function isDividerType(
function isFormInput(
formInputs: NativeFilterFormOrSaved,
): formInputs is NativeFiltersFormItem {
- return 'dataset' in formInputs;
+ // Values reaching this transform come either from the modal form
+ // (`NativeFiltersFormItem`) or from the already-saved filter config map
+ // (`Filter`). A saved filter always carries a serialized `targets` array,
+ // while a form item never does. Keying the discriminator off `dataset`
+ // misclassified filter types with no dataset control (e.g. `filter_time`)
+ // as saved filters, so their raw form state was persisted verbatim —
+ // dropping serialized keys such as `targets`, `defaultDataMask`, and
+ // `cascadeParentIds`, and leaking form-only keys such as
+ // `defaultValueQueriesData` and `requiredFirst`.
+ return !('targets' in formInputs);
Review Comment:
`customizationTransformer.ts:72` keeps the `'dataset' in formInputs`
discriminator, so `DeckglLayerVisibility` (`datasourceCount: 0`,
`chartCustomizations/components/DeckglLayerVisibility/index.ts:35`) hits this
identically the moment it's added to `CHART_CUSTOMIZATION_SUPPORTED_TYPES`.
Worth fixing in the same PR.
##########
superset-frontend/src/dashboard/components/nativeFilters/FiltersConfigModal/transformers/filterTransformer.test.ts:
##########
@@ -0,0 +1,118 @@
+/**
+ * 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 { Filter, NativeFilterType } from '@superset-ui/core';
+import { NativeFiltersFormItem } from '../types';
+import { transformFilterForSave } from './filterTransformer';
+
+const baseFormItem = {
+ type: NativeFilterType.NativeFilter,
+ scope: { rootPath: ['ROOT_ID'], excluded: [] },
+ controlValues: {},
+ requiredFirst: {},
+ defaultValue: null,
+ defaultDataMask: { filterState: {}, extraFormData: {} },
+ sortMetric: null,
+ description: '',
+ // form-only fields that must never leak into the saved filter
+ defaultValueQueriesData: null,
+} as unknown as NativeFiltersFormItem;
+
+test('serializes a dataset-less filter (filter_time) into a full Filter', ()
=> {
+ // A ``filter_time`` filter has no dataset/column controls, so its form item
+ // carries neither a ``dataset`` nor a ``targets`` key. It must still be
+ // transformed like any other native filter rather than persisted verbatim.
+ const formItem: NativeFiltersFormItem = {
+ ...baseFormItem,
+ name: 'Time Range',
+ filterType: 'filter_time',
+ dependencies: ['NATIVE_FILTER-parent'],
+ };
+
+ const result = transformFilterForSave(
+ 'NATIVE_FILTER-abc',
+ formItem,
+ ) as Filter;
+
+ // Keys the bug used to strip are present and well-formed.
+ expect(result.targets).toEqual([{}]);
+ expect(result.defaultDataMask).toBeDefined();
+ expect(result.cascadeParentIds).toEqual(['NATIVE_FILTER-parent']);
+
+ // Form-only keys must not leak into the persisted config.
+ expect(result).not.toHaveProperty('defaultValueQueriesData');
+ expect(result).not.toHaveProperty('dependencies');
+ // Empty requiredFirst collapses to undefined instead of the raw form object.
+ expect(result.requiredFirst).toBeUndefined();
+
+ expect(result.name).toBe('Time Range');
+ expect(result.filterType).toBe('filter_time');
+});
+
+test('serializes a dataset-backed filter (filter_select) into a full Filter',
() => {
+ const formItem: NativeFiltersFormItem = {
+ ...baseFormItem,
+ name: 'Region',
+ filterType: 'filter_select',
+ dataset: { value: 42, label: 'sales' },
+ column: 'region',
+ dependencies: [],
+ };
+
+ const result = transformFilterForSave(
+ 'NATIVE_FILTER-def',
+ formItem,
+ ) as Filter;
+
+ expect(result.targets).toEqual([
+ { datasetId: 42, column: { name: 'region' } },
+ ]);
+ expect(result.defaultDataMask).toBeDefined();
+ expect(result.cascadeParentIds).toEqual([]);
+ expect(result).not.toHaveProperty('defaultValueQueriesData');
+});
+
+test('passes an already-saved Filter through untouched (aside from trimming)',
() => {
Review Comment:
Missing the one input where old and new behavior diverge: a saved filter
with no `targets` — every `filter_time` already stripped by this bug — now
takes the form-item path, where `cascadeParentIds` reads `dependencies` (line
123) and collapses to `[]`.
##########
superset-frontend/src/dashboard/components/nativeFilters/FiltersConfigModal/transformers/filterTransformer.ts:
##########
@@ -67,7 +67,16 @@ function isDividerType(
function isFormInput(
formInputs: NativeFilterFormOrSaved,
): formInputs is NativeFiltersFormItem {
- return 'dataset' in formInputs;
+ // Values reaching this transform come either from the modal form
+ // (`NativeFiltersFormItem`) or from the already-saved filter config map
+ // (`Filter`). A saved filter always carries a serialized `targets` array,
+ // while a form item never does. Keying the discriminator off `dataset`
+ // misclassified filter types with no dataset control (e.g. `filter_time`)
+ // as saved filters, so their raw form state was persisted verbatim —
+ // dropping serialized keys such as `targets`, `defaultDataMask`, and
+ // `cascadeParentIds`, and leaking form-only keys such as
+ // `defaultValueQueriesData` and `requiredFirst`.
Review Comment:
Two lines carry this: saved filters always have `targets`, form items never
do.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
