Adding support of default_comparison (#3346)

* Adding support of default_comparison

* Adding E2E tests

* PR comments

* Adding unit tests

* Handling empty dimension string

* PR comments

* Fix non timestamp case

proto/gen/rill/runtime/v1/runtime.swagger.yaml

@@ -2359,6 +2359,14 @@ definitions:
           type: object
           $ref: '#/definitions/SecurityFieldCondition'
     title: Security for the metrics view
+  MetricsViewSpecComparisonMode:
+    type: string
+    enum:
+      - COMPARISON_MODE_UNSPECIFIED
+      - COMPARISON_MODE_NONE
+      - COMPARISON_MODE_TIME
+      - COMPARISON_MODE_DIMENSION
+    default: COMPARISON_MODE_UNSPECIFIED
   MetricsViewSpecDimensionV2:
     type: object
     properties:
@@ -3589,6 +3597,12 @@ definitions:
         type: integer
         format: int64
         description: Month number to use as the base for time aggregations by year. Defaults to 1 (January).
+      defaultComparisonMode:
+        $ref: '#/definitions/MetricsViewSpecComparisonMode'
+        description: Selected default comparison mode.
+      defaultComparisonDimension:
+        type: string
+        title: If comparison mode is dimension then this determines which is the default dimension
   v1MetricsViewState:
     type: object
     properties:

proto/rill/runtime/v1/resources.proto

@@ -154,6 +154,12 @@ message MetricsViewSpec {
     repeated FieldConditionV2 include = 3;
     repeated FieldConditionV2 exclude = 4;
   }
+  enum ComparisonMode {
+    COMPARISON_MODE_UNSPECIFIED = 0;
+    COMPARISON_MODE_NONE = 1;
+    COMPARISON_MODE_TIME = 2;
+    COMPARISON_MODE_DIMENSION = 3;
+  }
   // Connector containing the table
   string connector = 1;
   // Name of the table the metrics view is based on
@@ -180,6 +186,10 @@ message MetricsViewSpec {
   uint32 first_day_of_week = 12;
   // Month number to use as the base for time aggregations by year. Defaults to 1 (January).
   uint32 first_month_of_year = 13;
+  // Selected default comparison mode.
+  ComparisonMode default_comparison_mode = 14;
+  // If comparison mode is dimension then this determines which is the default dimension
+  string default_comparison_dimension = 15;
 }
 
 message MetricsViewState {

runtime/compilers/rillv1/parse_metrics_view.go

@@ -60,8 +60,20 @@ type MetricsViewYAML struct {
 			Condition string `yaml:"if"`
 		}
 	}
+	DefaultComparison struct {
+		Mode      string `yaml:"mode"`
+		Dimension string `yaml:"dimension"`
+	} `yaml:"default_comparison"`
 }
 
+var comparisonModesMap = map[string]runtimev1.MetricsViewSpec_ComparisonMode{
+	"":          runtimev1.MetricsViewSpec_COMPARISON_MODE_UNSPECIFIED,
+	"none":      runtimev1.MetricsViewSpec_COMPARISON_MODE_NONE,
+	"time":      runtimev1.MetricsViewSpec_COMPARISON_MODE_TIME,
+	"dimension": runtimev1.MetricsViewSpec_COMPARISON_MODE_DIMENSION,
+}
+var validComparisonModes = []string{"none", "time", "dimension"}
+
 // parseMetricsView parses a metrics view (dashboard) definition and adds the resulting resource to p.Resources.
 func (p *Parser) parseMetricsView(ctx context.Context, node *Node) error {
 	// Parse YAML
@@ -181,6 +193,16 @@ func (p *Parser) parseMetricsView(ctx context.Context, node *Node) error {
 		return fmt.Errorf("must define at least one measure")
 	}
 
+	tmp.DefaultComparison.Mode = strings.ToLower(tmp.DefaultComparison.Mode)
+	if _, ok := comparisonModesMap[tmp.DefaultComparison.Mode]; !ok {
+		return fmt.Errorf("invalid mode: %q. allowed values: %s", tmp.DefaultComparison.Mode, strings.Join(validComparisonModes, ","))
+	}
+	if tmp.DefaultComparison.Dimension != "" {
+		if ok := names[tmp.DefaultComparison.Dimension]; !ok {
+			return fmt.Errorf("default comparison dimension %q doesn't exist", tmp.DefaultComparison.Dimension)
+		}
+	}
+
 	if tmp.Security != nil {
 		templateData := TemplateData{User: map[string]interface{}{
 			"name":   "dummy",
@@ -313,6 +335,11 @@ func (p *Parser) parseMetricsView(ctx context.Context, node *Node) error {
 		})
 	}
 
+	spec.DefaultComparisonMode = comparisonModesMap[tmp.DefaultComparison.Mode]
+	if tmp.DefaultComparison.Dimension != "" {
+		spec.DefaultComparisonDimension = tmp.DefaultComparison.Dimension
+	}
+
 	if tmp.Security != nil {
 		if spec.Security == nil {
 			spec.Security = &runtimev1.MetricsViewSpec_SecurityV2{}

web-common/src/features/dashboards/proto-state/toProto.ts

@@ -82,7 +82,8 @@ export function getProtoFromDashboardState(
   if (metrics.expandedMeasureName) {
     state.expandedMeasure = metrics.expandedMeasureName;
   }
-  if (metrics.selectedDimensionName) {
+  if (metrics.selectedDimensionName && !state.showTimeComparison) {
+    // TODO: we need an enum to decide what is being selected for comparison. This should be reflected in proto as well.
     state.selectedDimension = metrics.selectedDimensionName;
   }
 

web-common/src/features/dashboards/stores/dashboard-store-defaults.ts

@@ -13,12 +13,13 @@ import { isoDurationToFullTimeRange } from "@rilldata/web-common/lib/time/ranges
 import type { TimeComparisonOption } from "@rilldata/web-common/lib/time/types";
 import type {
   V1ColumnTimeRangeResponse,
-  V1MetricsView,
+  V1MetricsViewSpec,
 } from "@rilldata/web-common/runtime-client";
+import { MetricsViewSpecComparisonMode } from "@rilldata/web-common/runtime-client";
 import { get } from "svelte/store";
 
 export function setDefaultTimeRange(
-  metricsView: V1MetricsView,
+  metricsView: V1MetricsViewSpec,
   metricsExplorer: MetricsExplorerEntity,
   fullTimeRange: V1ColumnTimeRangeResponse | undefined
 ) {
@@ -42,14 +43,39 @@ export function setDefaultTimeRange(
   // TODO: refactor all sub methods and call setSelectedScrubRange here
   metricsExplorer.selectedScrubRange = undefined;
   metricsExplorer.lastDefinedScrubRange = undefined;
-  setDefaultComparisonTimeRange(metricsView, metricsExplorer, fullTimeRange);
+}
+
+function setDefaultComparison(
+  metricsView: V1MetricsViewSpec,
+  metricsExplorer: MetricsExplorerEntity,
+  fullTimeRange: V1ColumnTimeRangeResponse | undefined
+) {
+  switch (metricsView.defaultComparisonMode) {
+    case MetricsViewSpecComparisonMode.COMPARISON_MODE_DIMENSION:
+      metricsExplorer.selectedComparisonDimension =
+        metricsView.defaultComparisonDimension ||
+        metricsView.dimensions?.[0]?.name;
+      break;
+
+    // if default_comparison is not specified it defaults to time comparison
+    case MetricsViewSpecComparisonMode.COMPARISON_MODE_UNSPECIFIED:
+    case MetricsViewSpecComparisonMode.COMPARISON_MODE_TIME:
+      setDefaultComparisonTimeRange(
+        metricsView,
+        metricsExplorer,
+        fullTimeRange
+      );
+      break;
+  }
 }
 
 function setDefaultComparisonTimeRange(
-  metricsView: V1MetricsView,
+  metricsView: V1MetricsViewSpec,
   metricsExplorer: MetricsExplorerEntity,
   fullTimeRange: V1ColumnTimeRangeResponse | undefined
 ) {
+  if (!fullTimeRange) return;
+
   const preset = ISODurationToTimePreset(metricsView.defaultTimeRange, true);
   const comparisonOption = DEFAULT_TIME_RANGES[preset]
     ?.defaultComparison as TimeComparisonOption;
@@ -78,7 +104,7 @@ function setDefaultComparisonTimeRange(
 
 export function getDefaultMetricsExplorerEntity(
   name: string,
-  metricsView: V1MetricsView,
+  metricsView: V1MetricsViewSpec,
   fullTimeRange: V1ColumnTimeRangeResponse | undefined
 ) {
   const metricsExplorer: MetricsExplorerEntity = {
@@ -108,5 +134,6 @@ export function getDefaultMetricsExplorerEntity(
   };
   // set time range related stuff
   setDefaultTimeRange(metricsView, metricsExplorer, fullTimeRange);
+  setDefaultComparison(metricsView, metricsExplorer, fullTimeRange);
   return metricsExplorer;
 }

web-common/src/features/dashboards/stores/dashboard-stores.spec.ts

@@ -24,8 +24,10 @@ import {
   TestTimeOffsetConstants,
 } from "@rilldata/web-common/features/dashboards/stores/dashboard-stores-test-data";
 import { initLocalUserPreferenceStore } from "@rilldata/web-common/features/dashboards/user-preferences";
-import { TimeRangePreset } from "@rilldata/web-common/lib/time/types";
-import { V1TimeGrain } from "@rilldata/web-common/runtime-client";
+import {
+  MetricsViewSpecComparisonMode,
+  V1TimeGrain,
+} from "@rilldata/web-common/runtime-client";
 import { get } from "svelte/store";
 import { beforeAll, beforeEach, describe, expect, it } from "vitest";
 
@@ -217,6 +219,8 @@ describe("dashboard-stores", () => {
       {
         ...AD_BIDS_INIT,
         defaultTimeRange: "PT6H",
+        defaultComparisonMode:
+          MetricsViewSpecComparisonMode.COMPARISON_MODE_UNSPECIFIED,
       },
       {
         timeRangeSummary: {
@@ -227,13 +231,8 @@ describe("dashboard-stores", () => {
       }
     );
 
-    assertMetricsView(AD_BIDS_NAME, undefined, {
-      name: TimeRangePreset.LAST_SIX_HOURS,
-      interval: V1TimeGrain.TIME_GRAIN_HOUR,
-      start: TestTimeOffsetConstants.LAST_6_HOURS,
-      end: TestTimeOffsetConstants.NOW,
-    });
-    const metrics = get(metricsExplorerStore).entities[AD_BIDS_NAME];
+    let metrics = get(metricsExplorerStore).entities[AD_BIDS_NAME];
+    // unspecified mode will default to time comparison
     expect(metrics.showTimeComparison).toBeTruthy();
     expect(metrics.selectedComparisonTimeRange.name).toBe("CONTIGUOUS");
     expect(metrics.selectedComparisonTimeRange.start).toEqual(
@@ -242,6 +241,52 @@ describe("dashboard-stores", () => {
     expect(metrics.selectedComparisonTimeRange.end).toEqual(
       TestTimeOffsetConstants.LAST_6_HOURS
     );
+    expect(metrics.selectedComparisonDimension).toBeUndefined();
+
+    metricsExplorerStore.remove(AD_BIDS_NAME);
+    metricsExplorerStore.init(
+      AD_BIDS_NAME,
+      {
+        ...AD_BIDS_INIT,
+        defaultTimeRange: "PT6H",
+        defaultComparisonMode:
+          MetricsViewSpecComparisonMode.COMPARISON_MODE_DIMENSION,
+      },
+      {
+        timeRangeSummary: {
+          min: TestTimeConstants.LAST_DAY.toISOString(),
+          max: TestTimeConstants.NOW.toISOString(),
+          interval: V1TimeGrain.TIME_GRAIN_MINUTE as any,
+        },
+      }
+    );
+    metrics = get(metricsExplorerStore).entities[AD_BIDS_NAME];
+    expect(metrics.showTimeComparison).toBeFalsy();
+    // defaults to 1st dimension
+    expect(metrics.selectedComparisonDimension).toBe(
+      AD_BIDS_PUBLISHER_DIMENSION
+    );
+
+    metricsExplorerStore.remove(AD_BIDS_NAME);
+    metricsExplorerStore.init(
+      AD_BIDS_NAME,
+      {
+        ...AD_BIDS_INIT,
+        defaultTimeRange: "PT6H",
+        defaultComparisonMode:
+          MetricsViewSpecComparisonMode.COMPARISON_MODE_DIMENSION,
+        defaultComparisonDimension: AD_BIDS_DOMAIN_DIMENSION,
+      },
+      {
+        timeRangeSummary: {
+          min: TestTimeConstants.LAST_DAY.toISOString(),
+          max: TestTimeConstants.NOW.toISOString(),
+          interval: V1TimeGrain.TIME_GRAIN_MINUTE as any,
+        },
+      }
+    );
+    metrics = get(metricsExplorerStore).entities[AD_BIDS_NAME];
+    expect(metrics.selectedComparisonDimension).toBe(AD_BIDS_DOMAIN_DIMENSION);
   });
 
   describe("Restore invalid state", () => {

web-common/src/features/dashboards/stores/dashboard-stores.ts

@@ -19,6 +19,7 @@ import type {
   V1ColumnTimeRangeResponse,
   V1MetricsView,
   V1MetricsViewFilter,
+  V1MetricsViewSpec,
   V1TimeGrain,
 } from "@rilldata/web-common/runtime-client";
 import { derived, Readable, writable } from "svelte/store";
@@ -163,7 +164,7 @@ function syncDimensions(
 const metricViewReducers = {
   init(
     name: string,
-    metricsView: V1MetricsView,
+    metricsView: V1MetricsViewSpec,
     fullTimeRange: V1ColumnTimeRangeResponse | undefined
   ) {
     update((state) => {
@@ -191,6 +192,14 @@ const metricViewReducers = {
       for (const key in partial) {
         metricsExplorer[key] = partial[key];
       }
+      // this hack is needed since what is shown for comparison is not a single source
+      // TODO: use an enum and get rid of this
+      if (!partial.showTimeComparison) {
+        metricsExplorer.showTimeComparison = false;
+      }
+      if (!partial.selectedComparisonDimension) {
+        metricsExplorer.selectedComparisonDimension = undefined;
+      }
       metricsExplorer.dimensionFilterExcludeMode =
         includeExcludeModeFromFilters(partial.filters);
     });

web-common/src/proto/gen/rill/runtime/v1/resources_pb.ts

@@ -942,6 +942,20 @@ export class MetricsViewSpec extends Message<MetricsViewSpec> {
    */
   firstMonthOfYear = 0;
 
+  /**
+   * Selected default comparison mode.
+   *
+   * @generated from field: rill.runtime.v1.MetricsViewSpec.ComparisonMode default_comparison_mode = 14;
+   */
+  defaultComparisonMode = MetricsViewSpec_ComparisonMode.UNSPECIFIED;
+
+  /**
+   * If comparison mode is dimension then this determines which is the default dimension
+   *
+   * @generated from field: string default_comparison_dimension = 15;
+   */
+  defaultComparisonDimension = "";
+
   constructor(data?: PartialMessage<MetricsViewSpec>) {
     super();
     proto3.util.initPartial(data, this);
@@ -963,6 +977,8 @@ export class MetricsViewSpec extends Message<MetricsViewSpec> {
     { no: 11, name: "security", kind: "message", T: MetricsViewSpec_SecurityV2 },
     { no: 12, name: "first_day_of_week", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
     { no: 13, name: "first_month_of_year", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+    { no: 14, name: "default_comparison_mode", kind: "enum", T: proto3.getEnumType(MetricsViewSpec_ComparisonMode) },
+    { no: 15, name: "default_comparison_dimension", kind: "scalar", T: 9 /* ScalarType.STRING */ },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MetricsViewSpec {
@@ -982,6 +998,38 @@ export class MetricsViewSpec extends Message<MetricsViewSpec> {
   }
 }
 
+/**
+ * @generated from enum rill.runtime.v1.MetricsViewSpec.ComparisonMode
+ */
+export enum MetricsViewSpec_ComparisonMode {
+  /**
+   * @generated from enum value: COMPARISON_MODE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * @generated from enum value: COMPARISON_MODE_NONE = 1;
+   */
+  NONE = 1,
+
+  /**
+   * @generated from enum value: COMPARISON_MODE_TIME = 2;
+   */
+  TIME = 2,
+
+  /**
+   * @generated from enum value: COMPARISON_MODE_DIMENSION = 3;
+   */
+  DIMENSION = 3,
+}
+// Retrieve enum metadata with: proto3.getEnumType(MetricsViewSpec_ComparisonMode)
+proto3.util.setEnumType(MetricsViewSpec_ComparisonMode, "rill.runtime.v1.MetricsViewSpec.ComparisonMode", [
+  { no: 0, name: "COMPARISON_MODE_UNSPECIFIED" },
+  { no: 1, name: "COMPARISON_MODE_NONE" },
+  { no: 2, name: "COMPARISON_MODE_TIME" },
+  { no: 3, name: "COMPARISON_MODE_DIMENSION" },
+]);
+
 /**
  * Dimensions are columns to filter and group by
  *

web-common/src/proto/gen/rill/ui/v1/dashboard_pb.ts

@@ -232,7 +232,7 @@ proto3.util.setEnumType(DashboardState_LeaderboardSortDirection, "rill.ui.v1.Das
 ]);
 
 /**
- * *
+ *
  * SortType is used to determine how to sort the leaderboard
  * and dimension detail table, as well as where to place the
  * sort arrow.