Merge pull request #1780 from merico-dev/preset-metric

feat(metrics): Add isPreset and semanticKey to metric type

Author: ZeekoZhu

.yarn/plugins/@yarnpkg/plugin-version.cjs

@@ -0,0 +1,3 @@
+undecided:
+  - "@devtable/root"
+  - "@devtable/dashboard"

.yarn/versions/34a1b820.yml

@@ -1,3 +1,7 @@
 nodeLinker: node-modules
 
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-version.cjs
+    spec: '@yarnpkg/plugin-version'
+
 yarnPath: .yarn/releases/yarn-3.6.1.cjs

.yarnrc.yml

@@ -1,6 +1,6 @@
 {
   "name": "@devtable/dashboard",
-  "version": "14.57.2",
+  "version": "14.57.3",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public",

dashboard/package.json

@@ -12,6 +12,8 @@ export type MetricBriefInfo = {
   name: string;
   description: string;
   type: 'derived' | 'combined';
+  isPreset: boolean;
+  semanticKey: string;
 };
 
 export const MetricsModel = types

dashboard/src/dashboard-editor/model/datasources/mm-info/metrics.ts

@@ -71,6 +71,8 @@ export const SelectMetric = observer(({ queryModel }: Props) => {
       value: d.id,
       description: d.description,
       type: d.type,
+      semanticKey: d.semanticKey,
+      isPreset: d.isPreset,
     }));
   }, [metrics.data]);
 
@@ -83,6 +85,9 @@ export const SelectMetric = observer(({ queryModel }: Props) => {
       mmInfo.selectMetric(id);
       config.setID(id);
       config.setType(option.type);
+      if (option.isPreset) {
+        config.setSemanticKey(option.semanticKey);
+      }
     },
     [mmInfo, config],
   );

dashboard/src/dashboard-editor/ui/settings/content/edit-query/merico-metric-query-editor-form/select-metric.tsx

@@ -118,6 +118,10 @@ export const MericoMetricQueryMeta = types
     }),
     useDefaultValues: types.optional(types.boolean, false),
     extraCalculations: types.optional(types.array(types.string), []),
+    /**
+     * If the metric is preset, this field will be set to the semantic key of the metric.
+     */
+    semanticKey: types.optional(types.string, ''),
   })
   .views((self) => ({
     get query() {
@@ -127,7 +131,18 @@ export const MericoMetricQueryMeta = types
       return !!self.id;
     },
     get json() {
-      const { id, type, filters, groupBys, timeQuery, useDefaultValues, extraCalculations, _type, sqlVariables } = self;
+      const {
+        id,
+        type,
+        filters,
+        groupBys,
+        timeQuery,
+        useDefaultValues,
+        extraCalculations,
+        _type,
+        sqlVariables,
+        semanticKey,
+      } = self;
       return shallowToJS({
         id,
         type,
@@ -137,6 +152,7 @@ export const MericoMetricQueryMeta = types
         useDefaultValues,
         extraCalculations,
         sqlVariables,
+        semanticKey,
         _type,
       });
     },
@@ -170,6 +186,7 @@ export const MericoMetricQueryMeta = types
       self.useDefaultValues = false;
       self.extraCalculations.length = 0;
       self.sqlVariables.length = 0;
+      self.semanticKey = '';
       if ('data' in self.query) {
         self.query.setData([]);
         self.query.setError(null);
@@ -181,6 +198,9 @@ export const MericoMetricQueryMeta = types
       }
       self.id = v;
     },
+    setSemanticKey(v: string) {
+      self.semanticKey = v;
+    },
     setType(type: string) {
       if (type !== 'derived' && type !== 'combined' && type !== 'sql') {
         return;
@@ -259,6 +279,7 @@ export interface IMericoMetricQueryMeta {
   };
   useDefaultValues: boolean;
   extraCalculations: IObservableArray<string>;
+  semanticKey: string;
 
   // Views
   readonly query: IQueryRenderModel;
@@ -281,6 +302,7 @@ export interface IMericoMetricQueryMeta {
     sqlVariables: IObservableArray<ISqlMetricVariableMeta>;
     useDefaultValues: boolean;
     extraCalculations: IObservableArray<string>;
+    semanticKey: string;
     _type: DataSourceType.MericoMetricSystem;
   };
   readonly usedFilterDimensionKeys: Set<string>;
@@ -303,6 +325,7 @@ export interface IMericoMetricQueryMeta {
   setExtraCalculations(v: string[]): void;
   addSqlVariable(sqlVar: string, variable: string): void;
   removeSqlVariable(sqlVariable: ISqlMetricVariableMeta): void;
+  setSemanticKey(v: string): void;
 }
 
 typeAssert.shouldExtends<IMericoMetricQueryMeta, MericoMetricQueryMetaInstance>();

dashboard/src/model/meta-model/dashboard/content/query/merico-metric-query.ts

@@ -32,6 +32,7 @@ type MetricQueryPayload = {
   };
   useDefaultValues?: boolean;
   extraCalculations?: string[];
+  semanticKey?: string;
 };
 
 // Helper function to format date range for timeQuery
@@ -345,6 +346,7 @@ export const MuteQueryModel = QueryMeta.views((self) => ({
       filters,
       groupBys: config.groupBys,
       variables,
+      semanticKey: config.semanticKey,
     };
 
     // sql metric time query

dashboard/src/model/render-model/dashboard/content/queries/mute-query.ts

@@ -1,6 +1,6 @@
 {
   "name": "@devtable/settings-form",
-  "version": "14.57.2",
+  "version": "14.57.3",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public",