feat(core): add custom_params to form_data (#929)

* feat(core): add custom_params to form_data * Update packages/superset-ui-chart-controls/src/sections.tsx Co-authored-by: Jesse Yang <jesse.yang@airbnb.com> * Update packages/superset-ui-chart-controls/src/sections.tsx Co-authored-by: Jesse Yang <jesse.yang@airbnb.com> Co-authored-by: Jesse Yang <jesse.yang@airbnb.com>
apache · Nov 26, 2021 · b45cc00 · b45cc00
1 parent 90e6a6f
commit b45cc00
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 1 deletion.
diff --git a/...nd/temporary_superset_ui/superset-ui/packages/superset-ui-chart-controls/src/sections.tsx b/...nd/temporary_superset_ui/superset-ui/packages/superset-ui-chart-controls/src/sections.tsx
@@ -75,7 +75,18 @@ export const datasourceAndVizType: ControlPanelSectionConfig = {
           type: 'HiddenControl',
           label: t('URL Parameters'),
           hidden: true,
-          description: t('Extra parameters for use in jinja templated queries'),
+          description: t('Extra url parameters for use in Jinja templated queries'),
+        },
+      },
+      {
+        name: 'custom_params',
+        config: {
+          type: 'HiddenControl',
+          label: t('Extra Parameters'),
+          hidden: true,
+          description: t(
+            'Extra parameters that any plugins can choose to set for use in Jinja templated queries',
+          ),
         },
       },
       {

diff --git a/...temporary_superset_ui/superset-ui/packages/superset-ui-core/src/query/buildQueryObject.ts b/...temporary_superset_ui/superset-ui/packages/superset-ui-core/src/query/buildQueryObject.ts
@@ -32,6 +32,7 @@ export default function buildQueryObject<T extends QueryFormData>(
     timeseries_limit_metric,
     granularity,
     url_params = {},
+    custom_params = {},
     ...residualFormData
   } = formData;
   const { append_form_data = {}, override_form_data = {} } = extra_form_data;
@@ -65,6 +66,7 @@ export default function buildQueryObject<T extends QueryFormData>(
     timeseries_limit_metric: timeseries_limit_metric || undefined,
     order_desc: typeof order_desc === 'undefined' ? true : order_desc,
     url_params: url_params || undefined,
+    custom_params,
   };
   // append and override extra form data used by native filters
   queryObject = appendExtraFormData(queryObject, append_form_data);

diff --git a/...tend/temporary_superset_ui/superset-ui/packages/superset-ui-core/src/query/types/Query.ts b/...tend/temporary_superset_ui/superset-ui/packages/superset-ui-core/src/query/types/Query.ts
@@ -116,6 +116,8 @@ export interface QueryObject extends QueryFields, TimeRange, ResidualQueryObject
 
   url_params?: Record<string, string>;
 
+  custom_params?: Record<string, string>;
+
   /** Free-form WHERE SQL: multiple clauses are concatenated by AND */
   where?: string;
 }

diff --git a/...porary_superset_ui/superset-ui/packages/superset-ui-core/src/query/types/QueryFormData.ts b/...porary_superset_ui/superset-ui/packages/superset-ui-core/src/query/types/QueryFormData.ts
@@ -143,6 +143,7 @@ export interface BaseFormData extends TimeRange, FormDataResidual {
   time_range_endpoints?: TimeRangeEndpoints;
   annotation_layers?: AnnotationLayer[];
   url_params?: Record<string, string>;
+  custom_params?: Record<string, string>;
 }
 
 /**

diff --git a/...ary_superset_ui/superset-ui/packages/superset-ui-core/test/query/buildQueryObject.test.ts b/...ary_superset_ui/superset-ui/packages/superset-ui-core/test/query/buildQueryObject.test.ts
@@ -218,4 +218,15 @@ describe('buildQueryObject', () => {
       }).url_params,
     ).toBeUndefined();
   });
+
+  it('should populate custom_params', () => {
+    const customParams = { customObject: { id: 137, name: 'C-137' } };
+    query = buildQueryObject({
+      datasource: '5__table',
+      granularity_sqla: 'ds',
+      viz_type: 'table',
+      custom_params: customParams,
+    });
+    expect(query.custom_params).toEqual(customParams);
+  });
 });