feat(Table): Add infrastructure to override time shifts (apache#33947)

Author: msyavuz

superset-frontend/packages/superset-ui-core/src/query/constants.ts

@@ -48,6 +48,7 @@ export const EXTRA_FORM_DATA_OVERRIDE_REGULAR_MAPPINGS: Record<
   time_column: 'time_column',
   time_grain: 'time_grain',
   time_range: 'time_range',
+  time_compare: 'time_compare',
 };
 
 export const EXTRA_FORM_DATA_OVERRIDE_REGULAR_KEYS = Object.keys(

superset-frontend/packages/superset-ui-core/src/query/extractExtras.ts

@@ -31,6 +31,7 @@ type ExtraFilterQueryField = {
   granularity_sqla?: string;
   time_grain_sqla?: TimeGranularity;
   granularity?: string;
+  time_compare?: string;
 };
 
 type ExtractedExtra = ExtraFilterQueryField & {
@@ -57,6 +58,7 @@ export default function extractExtras(formData: QueryFormData): ExtractedExtra {
     __time_col: 'granularity_sqla',
     __time_grain: 'time_grain_sqla',
     __granularity: 'granularity',
+    __time_compare: 'time_compare',
   };
 
   (formData.extra_filters || []).forEach(filter => {

superset-frontend/packages/superset-ui-core/src/query/types/Query.ts

@@ -71,6 +71,8 @@ export type QueryObjectExtras = Partial<{
   where?: string;
   /** Instant Time Comparison */
   instant_time_comparison_range?: string;
+
+  time_compare?: string;
 }>;
 
 export type ResidualQueryObjectData = {

superset-frontend/packages/superset-ui-core/src/query/types/QueryFormData.ts

@@ -122,7 +122,7 @@ export type ExtraFormDataAppend = {
  * filter clauses can't be overridden */
 export type ExtraFormDataOverrideExtras = Pick<
   QueryObjectExtras,
-  'relative_start' | 'relative_end' | 'time_grain_sqla'
+  'relative_start' | 'relative_end' | 'time_grain_sqla' | 'time_compare'
 >;
 
 /** These parameters override those already present in the form data/query object */
@@ -131,7 +131,7 @@ export type ExtraFormDataOverrideRegular = Partial<
 > &
   Partial<Pick<SqlaFormData, 'granularity'>> &
   Partial<Pick<BaseFormData, 'time_range'>> &
-  Partial<Pick<QueryObject, 'time_column' | 'time_grain'>>;
+  Partial<Pick<QueryObject, 'time_column' | 'time_grain' | 'time_compare'>>;
 
 /** These parameters override those already present in the form data/query object */
 export type ExtraFormDataOverride = ExtraFormDataOverrideRegular &

superset-frontend/packages/superset-ui-core/src/query/types/Time.ts

@@ -30,7 +30,8 @@ export type TimeColumnConfigKey =
   | '__time_col'
   | '__time_grain'
   | '__time_range'
-  | '__granularity';
+  | '__granularity'
+  | '__time_compare';
 
 export type AppliedTimeExtras = Partial<
   Record<TimeColumnConfigKey, keyof QueryObject>

superset-frontend/plugins/plugin-chart-table/src/buildQuery.ts

@@ -115,6 +115,13 @@ const buildQuery: BuildQuery<TableChartFormData> = (
       }
     }
 
+    if (
+      extra_form_data?.time_compare &&
+      !timeOffsets.includes(extra_form_data.time_compare)
+    ) {
+      timeOffsets = [extra_form_data.time_compare];
+    }
+
     let temporalColumnAdded = false;
     let temporalColumn = null;