Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Extract convertParametersToMbql and inline VARIABLE_ICONS (#73502)

Fraser9d4f8bffedf6
diff --git a/frontend/src/metabase-lib/v1/Question.ts b/frontend/src/metabase-lib/v1/Question.ts
index a0da59710fd..814e4131217 100644
--- a/frontend/src/metabase-lib/v1/Question.ts
+++ b/frontend/src/metabase-lib/v1/Question.ts
@@ -4,7 +4,6 @@ import { assoc, assocIn, chain, dissoc, getIn } from "icepick";
import slugg from "slugg";
import _ from "underscore";
-import { applyParameter } from "metabase/querying/parameters/utils/query";
import * as Lib from "metabase-lib";
import type Database from "metabase-lib/v1/metadata/Database";
import Metadata from "metabase-lib/v1/metadata/Metadata";
@@ -29,7 +28,6 @@ import type {
DatasetQuery,
Field,
LastEditInfo,
- ParameterDimensionTarget,
ParameterId,
Parameter as ParameterObject,
ParameterValuesMap,
@@ -38,7 +36,6 @@ import type {
VisualizationDisplay,
VisualizationSettings,
} from "metabase-types/api";
-import { isDimensionTarget } from "metabase-types/guards";
import type { Query } from "../query/types";
@@ -692,51 +689,6 @@ class Question {
return res;
}
- _convertParametersToMbql({ isComposed }: { isComposed: boolean }): Question {
- const query = this.query();
- const { isNative } = Lib.queryDisplayInfo(query);
-
- if (isNative) {
- return this;
- }
-
- // If the query is composed (models or metrics) we cannot add filters to the underlying query since that query is used for data source.
- // Pivot tables cannot work when there is an extra stage added on top of breakouts and aggregations.
- const queryWithExtraStage =
- !isComposed && this.display() !== "pivot"
- ? Lib.ensureFilterStage(query)
- : query;
- const queryWithFilters = this.parameters().reduce((newQuery, parameter) => {
- const stageIndex =
- isDimensionTarget(parameter.target) && !isComposed
- ? getParameterDimensionTargetStageIndex(parameter.target)
- : -1;
- return applyParameter(
- newQuery,
- stageIndex,
- parameter.type,
- parameter.target,
- parameter.value,
- );
- }, queryWithExtraStage);
- const queryWithFiltersWithoutExtraStage =
- Lib.dropEmptyStages(queryWithFilters);
-
- const newQuestion = this.setQuery(queryWithFiltersWithoutExtraStage)
- .setParameters(undefined)
- .setParameterValues(undefined);
-
- const hasQueryBeenAltered = queryWithExtraStage !== queryWithFilters;
- return hasQueryBeenAltered ? newQuestion.markDirty() : newQuestion;
-
- function getParameterDimensionTargetStageIndex(
- target: ParameterDimensionTarget,
- ) {
- const [_type, _variableTarget, options] = target;
- return options?.["stage-number"] ?? -1;
- }
- }
-
query(): Query {
if (InternalQuery.isDatasetQueryType(this.datasetQuery())) {
throw new Error("Internal query is not supported by Lib");
diff --git a/frontend/src/metabase-lib/v1/Question.unit.spec.js b/frontend/src/metabase-lib/v1/Question.unit.spec.js
index 79719b89e3a..c04dbd4a448 100644
--- a/frontend/src/metabase-lib/v1/Question.unit.spec.js
+++ b/frontend/src/metabase-lib/v1/Question.unit.spec.js
@@ -1,4 +1,5 @@
import { createMockMetadata } from "__support__/metadata";
+import { convertParametersToMbql } from "metabase/querying/parameters/utils/query";
import * as Lib from "metabase-lib";
import {
createMockColumn,
@@ -744,10 +745,10 @@ describe("Question", () => {
});
});
- describe("Question.prototype.convertParametersToMbql", () => {
+ describe("convertParametersToMbql", () => {
it("should do nothing to a native question", () => {
expect(
- native_orders_count_question._convertParametersToMbql({
+ convertParametersToMbql(native_orders_count_question, {
isComposed: false,
}),
).toBe(native_orders_count_question);
@@ -775,7 +776,7 @@ describe("Question", () => {
foo_id: "abc",
});
- const questionWithFilters = question._convertParametersToMbql({
+ const questionWithFilters = convertParametersToMbql(question, {
isComposed: false,
});
diff --git a/frontend/src/metabase-lib/v1/variables/TemplateTagVariable/TemplateTagVariable.ts b/frontend/src/metabase-lib/v1/variables/TemplateTagVariable/TemplateTagVariable.ts
index 69a897f1755..1ea99844f1f 100644
--- a/frontend/src/metabase-lib/v1/variables/TemplateTagVariable/TemplateTagVariable.ts
+++ b/frontend/src/metabase-lib/v1/variables/TemplateTagVariable/TemplateTagVariable.ts
@@ -2,8 +2,6 @@ import NativeQuery from "metabase-lib/v1/queries/NativeQuery";
import Variable from "metabase-lib/v1/variables/Variable";
import type { TemplateTag, VariableTarget } from "metabase-types/api";
-import { VARIABLE_ICONS } from "./constants";
-
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default class TemplateTagVariable extends Variable {
tag(): TemplateTag | null | undefined {
@@ -17,11 +15,6 @@ export default class TemplateTagVariable extends Variable {
return tag && (tag["display-name"] || tag.name);
}
- icon(): string | null | undefined {
- const tag = this.tag();
- return tag && VARIABLE_ICONS[tag.type];
- }
-
mbql(): VariableTarget {
return ["template-tag", this._args[0]];
}
diff --git a/frontend/src/metabase-lib/v1/variables/TemplateTagVariable/constants.ts b/frontend/src/metabase-lib/v1/variables/TemplateTagVariable/constants.ts
deleted file mode 100644
index e1e7de96fe7..00000000000
--- a/frontend/src/metabase-lib/v1/variables/TemplateTagVariable/constants.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-// TODO: migrate icons away from metabase-lib
-// eslint-disable-next-line no-restricted-imports
-import type { IconName } from "metabase/ui";
-import type { TemplateTagType } from "metabase-types/api";
-
-export const VARIABLE_ICONS: Record<TemplateTagType, IconName | null> = {
- text: "string",
- number: "int",
- date: "calendar",
- boolean: "io",
- dimension: null,
- "temporal-unit": "clock",
- card: null,
- snippet: null,
- table: null,
-};
diff --git a/frontend/src/metabase/dashboard/utils/question-url.ts b/frontend/src/metabase/dashboard/utils/question-url.ts
index e65a95f6489..15dbc494695 100644
--- a/frontend/src/metabase/dashboard/utils/question-url.ts
+++ b/frontend/src/metabase/dashboard/utils/question-url.ts
@@ -1,3 +1,4 @@
+import { convertParametersToMbql } from "metabase/querying/parameters/utils/query";
import * as Urls from "metabase/urls";
import * as Lib from "metabase-lib";
import type Question from "metabase-lib/v1/Question";
@@ -32,9 +33,10 @@ export function getStructuredQuestionUrlWithParameters(
const composed = needsComposing
? question.composeQuestionAdhoc().setParameters(parameters)
: questionWithParameters;
- const withMbqlFilters = composed
- .setParameterValues(parameterValues)
- ._convertParametersToMbql({ isComposed: needsComposing });
+ const withMbqlFilters = convertParametersToMbql(
+ composed.setParameterValues(parameterValues),
+ { isComposed: needsComposing },
+ );
return Urls.question(withMbqlFilters, {
originalQuestion,
diff --git a/frontend/src/metabase/parameters/utils/mapping-options.ts b/frontend/src/metabase/parameters/utils/mapping-options.ts
index 54495954251..685c691d583 100644
--- a/frontend/src/metabase/parameters/utils/mapping-options.ts
+++ b/frontend/src/metabase/parameters/utils/mapping-options.ts
@@ -5,6 +5,7 @@ import { tag_names } from "cljs/metabase.parameters.shared";
import { getColumnIcon } from "metabase/common/utils/columns";
import { getAllowedIframeAttributes } from "metabase/dashboard/visualizations/IFrameViz/utils";
import { getGroupName } from "metabase/querying/filters/utils/groups";
+import type { IconName } from "metabase/ui";
import {
isActionDashCard,
isQuestionDashCard,
@@ -36,11 +37,24 @@ import type {
ParameterTarget,
ParameterVariableTarget,
StructuredParameterDimensionTarget,
+ TemplateTagType,
VirtualCard,
WritebackParameter,
} from "metabase-types/api";
import { isStructuredDimensionTarget } from "metabase-types/guards";
+const VARIABLE_ICONS: Record<TemplateTagType, IconName | null> = {
+ text: "string",
+ number: "int",
+ date: "calendar",
+ boolean: "io",
+ dimension: null,
+ "temporal-unit": "clock",
+ card: null,
+ snippet: null,
+ table: null,
+};
+
export type StructuredQuerySectionOption = {
sectionName: string;
name: string;
@@ -89,9 +103,10 @@ function buildNativeQuerySectionOptions(
function buildVariableOption(
variable: TemplateTagVariable,
): NativeParameterMappingOption {
+ const tag = variable.tag();
return {
name: variable.displayName() ?? "",
- icon: variable.icon() ?? "",
+ icon: (tag && VARIABLE_ICONS[tag.type]) ?? "",
isForeign: false,
target: buildTemplateTagVariableTarget(variable),
};
diff --git a/frontend/src/metabase/querying/parameters/utils/query.ts b/frontend/src/metabase/querying/parameters/utils/query.ts
index 5ad57a0c98a..3cbc28947b4 100644
--- a/frontend/src/metabase/querying/parameters/utils/query.ts
+++ b/frontend/src/metabase/querying/parameters/utils/query.ts
@@ -3,14 +3,19 @@ import { P, match } from "ts-pattern";
import { getDateFilterClause } from "metabase/querying/filters/utils/dates";
import { isNotNull } from "metabase/utils/types";
import * as Lib from "metabase-lib";
+import type Question from "metabase-lib/v1/Question";
import { isTemporalUnitParameter } from "metabase-lib/v1/parameters/utils/parameter-type";
import type {
+ ParameterDimensionTarget,
ParameterTarget,
ParameterType,
ParameterValueOrArray,
StructuredParameterDimensionTarget,
} from "metabase-types/api";
-import { isStructuredDimensionTarget } from "metabase-types/guards";
+import {
+ isDimensionTarget,
+ isStructuredDimensionTarget,
+} from "metabase-types/guards";
import {
deserializeBooleanParameterValue,
@@ -243,3 +248,54 @@ function applyTemporalUnitParameter(
const columnWithBucket = Lib.withTemporalBucket(column, bucket);
return Lib.replaceClause(query, stageIndex, breakout, columnWithBucket);
}
+
+export function convertParametersToMbql(
+ question: Question,
+ { isComposed }: { isComposed: boolean },
+): Question {
+ const query = question.query();
+ const { isNative } = Lib.queryDisplayInfo(query);
+
+ if (isNative) {
+ return question;
+ }
+
+ // If the query is composed (models or metrics) we cannot add filters to the underlying query since that query is used for data source.
+ // Pivot tables cannot work when there is an extra stage added on top of breakouts and aggregations.
+ const queryWithExtraStage =
+ !isComposed && question.display() !== "pivot"
+ ? Lib.ensureFilterStage(query)
+ : query;
+ const queryWithFilters = question
+ .parameters()
+ .reduce((newQuery, parameter) => {
+ const stageIndex =
+ isDimensionTarget(parameter.target) && !isComposed
+ ? getParameterDimensionTargetStageIndex(parameter.target)
+ : -1;
+ return applyParameter(
+ newQuery,
+ stageIndex,
+ parameter.type,
+ parameter.target ?? null,
+ parameter.value ?? null,
+ );
+ }, queryWithExtraStage);
+ const queryWithFiltersWithoutExtraStage =
+ Lib.dropEmptyStages(queryWithFilters);
+
+ const newQuestion = question
+ .setQuery(queryWithFiltersWithoutExtraStage)
+ .setParameters(undefined)
+ .setParameterValues(undefined);
+
+ const hasQueryBeenAltered = queryWithExtraStage !== queryWithFilters;
+ return hasQueryBeenAltered ? newQuestion.markDirty() : newQuestion;
+}
+
+function getParameterDimensionTargetStageIndex(
+ target: ParameterDimensionTarget,
+) {
+ const [_type, _variableTarget, options] = target;
+ return options?.["stage-number"] ?? -1;
+}