The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Deprecate fields in Question.create that are used to manipulate raw MBQL (#64715)
Alexander Polyankin0cf0d8642118
diff --git a/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/use-adhoc-table-query.ts b/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/use-adhoc-table-query.tsindex 6491bccfb53..2636ebfbd55 100644--- a/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/use-adhoc-table-query.ts+++ b/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/use-adhoc-table-query.ts@@ -8,6 +8,7 @@ import { loadMetadataForTable } from "metabase/questions/actions";import { getMetadata } from "metabase/selectors/metadata";import * as Lib from "metabase-lib";import Question from "metabase-lib/v1/Question";+import type { OpaqueDatasetQuery } from "metabase-types/api";type UseAdHocTableQueryProps = {tableId: number;@@ -26,7 +27,7 @@ export const useAdHocTableQuery = ({const queryParam = useMemo(() =>location.query?.query- ? JSON.parse(b64url_to_utf8(location.query.query))+ ? deserializeQueryFromUrl(location.query.query): null,[location.query.query],);@@ -70,10 +71,7 @@ export const useAdHocTableQuery = ({// don't set the query string param if there are no filters or sortingif (newFilters.length > 0 || newOrderBys.length > 0) {const searchParams = new URLSearchParams();- searchParams.set(- "query",- utf8_to_b64url(JSON.stringify(Lib.toJsQuery(newQuery))),- );+ searchParams.set("query", serializeQueryToUrl(Lib.toJsQuery(newQuery)));dispatch(push(`${window.location.pathname}?${searchParams.toString()}`),);@@ -96,3 +94,11 @@ export const useAdHocTableQuery = ({handleTableQuestionChange,};};++function serializeQueryToUrl(query: OpaqueDatasetQuery) {+ return utf8_to_b64url(JSON.stringify(query));+}++function deserializeQueryFromUrl(query: string): OpaqueDatasetQuery {+ return JSON.parse(b64url_to_utf8(query));+}diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/NewTransformPage/utils.ts b/enterprise/frontend/src/metabase-enterprise/transforms/pages/NewTransformPage/utils.tsindex e21e05790e9..d4f0da959b6 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/NewTransformPage/utils.ts+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/NewTransformPage/utils.ts@@ -8,7 +8,7 @@ export function getInitialQueryTransformSource(const query =card != null? card.dataset_query- : Question.create({ type }).datasetQuery();+ : Question.create({ DEPRECATED_RAW_MBQL_type: type }).datasetQuery();return { type: "query" as const, query };}diff --git a/frontend/src/metabase-lib/v1/Question.ts b/frontend/src/metabase-lib/v1/Question.tsindex 7e6a101c37f..0968050b2de 100644--- a/frontend/src/metabase-lib/v1/Question.ts+++ b/frontend/src/metabase-lib/v1/Question.ts@@ -52,18 +52,18 @@ import { isDimensionTarget } from "metabase-types/guards";import type { Query } from "../types";export type QuestionCreatorOpts = {- databaseId?: DatabaseId;cardType?: CardType;- tableId?: TableId;collectionId?: CollectionId;dashboardId?: DashboardId;metadata?: Metadata;parameterValues?: ParameterValuesMap;- type?: "query" | "native";name?: string;display?: CardDisplayType;visualization_settings?: VisualizationSettings;dataset_query?: DatasetQuery;+ DEPRECATED_RAW_MBQL_type?: "query" | "native";+ DEPRECATED_RAW_MBQL_databaseId?: DatabaseId;+ DEPRECATED_RAW_MBQL_tableId?: TableId;};export type QuestionDashboardProps = {@@ -460,9 +460,11 @@ class Question {return this;}const query = this.composeQuestion().query();- return Question.create({ metadata: this.metadata(), ...options }).setQuery(- query,- );+ return Question.create({+ metadata: this.metadata(),+ dataset_query: Lib.toJsQuery(query),+ ...options,+ });}/**@@ -911,13 +913,13 @@ class Question {* but it would require changing the constructor signature so that `card` is an optional parameter and has a default value*/static create({- databaseId,- tableId,+ DEPRECATED_RAW_MBQL_type: type = "query",+ DEPRECATED_RAW_MBQL_databaseId: databaseId,+ DEPRECATED_RAW_MBQL_tableId: tableId,collectionId,dashboardId,metadata,parameterValues,- type = "query",name,display = "table",visualization_settings = {},diff --git a/frontend/src/metabase-lib/v1/metadata/Table.ts b/frontend/src/metabase-lib/v1/metadata/Table.tsindex fbbfa5528cf..3c6cadb5d05 100644--- a/frontend/src/metabase-lib/v1/metadata/Table.ts+++ b/frontend/src/metabase-lib/v1/metadata/Table.ts@@ -64,8 +64,8 @@ class Table {question() {return Question.create({- databaseId: this.db && this.db.id,- tableId: this.id,+ DEPRECATED_RAW_MBQL_databaseId: this.db && this.db.id,+ DEPRECATED_RAW_MBQL_tableId: this.id,metadata: this.metadata,});}diff --git a/frontend/src/metabase/common/components/NewItemMenu/NewItemMenuView.tsx b/frontend/src/metabase/common/components/NewItemMenu/NewItemMenuView.tsxindex 6a38e2cabeb..2275a3f71b6 100644--- a/frontend/src/metabase/common/components/NewItemMenu/NewItemMenuView.tsx+++ b/frontend/src/metabase/common/components/NewItemMenu/NewItemMenuView.tsx@@ -65,11 +65,11 @@ const NewItemMenuView = ({key="native"component={ForwardRefLink}to={Urls.newQuestion({- type: "native",+ DEPRECATED_RAW_MBQL_type: "native",creationType: "native_question",collectionId,cardType: "question",- databaseId: lastUsedDatabaseId || undefined,+ DEPRECATED_RAW_MBQL_databaseId: lastUsedDatabaseId || undefined,})}leftSection={<Icon name="sql" />}>diff --git a/frontend/src/metabase/dashboard/components/QuestionPicker/actions.ts b/frontend/src/metabase/dashboard/components/QuestionPicker/actions.tsindex 613f388fd40..76b39361c28 100644--- a/frontend/src/metabase/dashboard/components/QuestionPicker/actions.ts+++ b/frontend/src/metabase/dashboard/components/QuestionPicker/actions.ts@@ -22,7 +22,7 @@ export const getNewQuestionUrl = ({} as const): ({mode: "query",- type: "native",+ DEPRECATED_RAW_MBQL_type: "native",creationType: "native_question",} as const);diff --git a/frontend/src/metabase/home/components/Onboarding/Onboarding.tsx b/frontend/src/metabase/home/components/Onboarding/Onboarding.tsxindex 0b4696f8fc3..f9c3aacab9a 100644--- a/frontend/src/metabase/home/components/Onboarding/Onboarding.tsx+++ b/frontend/src/metabase/home/components/Onboarding/Onboarding.tsx@@ -98,11 +98,11 @@ export const Onboarding = () => {);const newNativeQuestionUrl = Urls.newQuestion({- type: "native",+ DEPRECATED_RAW_MBQL_type: "native",creationType: "native_question",collectionId: "root",cardType: "question",- databaseId: lastUsedDatabaseId || undefined,+ DEPRECATED_RAW_MBQL_databaseId: lastUsedDatabaseId || undefined,});const [lastItemOpened, setLastItemOpened] = useTempStorage(diff --git a/frontend/src/metabase/models/containers/NewModelOptions/NewModelOptions.tsx b/frontend/src/metabase/models/containers/NewModelOptions/NewModelOptions.tsxindex 4df064e8a66..e47501ab943 100644--- a/frontend/src/metabase/models/containers/NewModelOptions/NewModelOptions.tsx+++ b/frontend/src/metabase/models/containers/NewModelOptions/NewModelOptions.tsx@@ -88,11 +88,11 @@ const NewModelOptions = ({ location }: NewModelOptionsProps) => {description={t`You can always fall back to a SQL or native query, which is a bit more manual.`}to={Urls.newQuestion({mode: "query",- type: "native",+ DEPRECATED_RAW_MBQL_type: "native",creationType: "native_question",cardType: "model",collectionId,- databaseId: lastUsedDatabaseId || undefined,+ DEPRECATED_RAW_MBQL_databaseId: lastUsedDatabaseId || undefined,})}width={180}/>diff --git a/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx b/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsxindex a71d6ce741b..dbd298072d2 100644--- a/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx+++ b/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx@@ -103,7 +103,7 @@ export const useCommandPaletteBasicActions = ({dispatch(push(Urls.newQuestion({- type: "native",+ DEPRECATED_RAW_MBQL_type: "native",creationType: "native_question",cardType: "question",}),diff --git a/frontend/src/metabase/query_builder/actions/core/initializeQB.ts b/frontend/src/metabase/query_builder/actions/core/initializeQB.tsindex e7233a76e7b..7feb7f317d0 100644--- a/frontend/src/metabase/query_builder/actions/core/initializeQB.ts+++ b/frontend/src/metabase/query_builder/actions/core/initializeQB.ts@@ -79,7 +79,11 @@ function getCardForBlankQuestion(const tableId = options.table ? parseInt(options.table) : undefined;const segmentId = options.segment ? parseInt(options.segment) : undefined;- let question = Question.create({ databaseId, tableId, metadata });+ let question = Question.create({+ DEPRECATED_RAW_MBQL_databaseId: databaseId,+ DEPRECATED_RAW_MBQL_tableId: tableId,+ metadata,+ });if (databaseId && tableId) {if (typeof segmentId === "number") {diff --git a/frontend/src/metabase/query_builder/actions/core/initializeQB.unit.spec.ts b/frontend/src/metabase/query_builder/actions/core/initializeQB.unit.spec.tsindex d91822e5d64..77ec7a1982f 100644--- a/frontend/src/metabase/query_builder/actions/core/initializeQB.unit.spec.ts+++ b/frontend/src/metabase/query_builder/actions/core/initializeQB.unit.spec.ts@@ -711,7 +711,7 @@ describe("QB Actions > initializeQB", () => {it("constructs a card based on provided 'db' param", async () => {const expectedCard = Question.create({- databaseId: SAMPLE_DB_ID,+ DEPRECATED_RAW_MBQL_databaseId: SAMPLE_DB_ID,}).card();const { result, metadata } = await setupBlank({ db: SAMPLE_DB_ID });diff --git a/frontend/src/metabase/query_builder/actions/object-detail.ts b/frontend/src/metabase/query_builder/actions/object-detail.tsindex 93c246dfdd0..57bb61de322 100644--- a/frontend/src/metabase/query_builder/actions/object-detail.ts+++ b/frontend/src/metabase/query_builder/actions/object-detail.ts@@ -86,9 +86,10 @@ export const followForeignKey = createThunkAction(table,);const query = filterByFk(baseQuery, fk.origin, objectId);- const finalCard = Question.create({ databaseId, metadata })- .setQuery(query)- .card();+ const finalCard = Question.create({+ dataset_query: Lib.toJsQuery(query),+ metadata,+ }).card();dispatch(resetRowZoom());dispatch(setCardAndRun(finalCard));@@ -140,9 +141,10 @@ export const loadObjectDetailFKReferences = createThunkAction();const aggregatedQuery = Lib.aggregateByCount(baseQuery, -1);const query = filterByFk(aggregatedQuery, fk.origin, objectId);- const finalCard = Question.create({ databaseId, metadata })- .setQuery(query)- .datasetQuery();+ const finalCard = Question.create({+ dataset_query: Lib.toJsQuery(query),+ metadata,+ }).datasetQuery();const info: FKInfo = {status: 0,diff --git a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionFiltersHeader/QuestionFiltersHeader.unit.spec.tsx b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionFiltersHeader/QuestionFiltersHeader.unit.spec.tsxindex e8dff8eb08b..7945bd69133 100644--- a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionFiltersHeader/QuestionFiltersHeader.unit.spec.tsx+++ b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionFiltersHeader/QuestionFiltersHeader.unit.spec.tsx@@ -46,7 +46,6 @@ function setup({const question = Question.create({metadata,- type: "query",dataset_query: Lib.toJsQuery(query),});diff --git a/frontend/src/metabase/querying/notebook/components/DataStep/tests/common.unit.spec.tsx b/frontend/src/metabase/querying/notebook/components/DataStep/tests/common.unit.spec.tsxindex 911e0682d6b..b47d807d1da 100644--- a/frontend/src/metabase/querying/notebook/components/DataStep/tests/common.unit.spec.tsx+++ b/frontend/src/metabase/querying/notebook/components/DataStep/tests/common.unit.spec.tsx@@ -53,7 +53,9 @@ function setup(opts: SetupOpts = {}) {}const setupEmptyQuery = () => {- const question = Question.create({ databaseId: SAMPLE_DB_ID });+ const question = Question.create({+ DEPRECATED_RAW_MBQL_databaseId: SAMPLE_DB_ID,+ });const query = question.query();return setup({ step: createMockNotebookStep({ query }) });};diff --git a/frontend/src/metabase/querying/notebook/components/NotebookStep/NotebookStepPreview/NotebookStepPreview.jsx b/frontend/src/metabase/querying/notebook/components/NotebookStep/NotebookStepPreview/NotebookStepPreview.jsxindex 7394d527085..db3d4fbfee8 100644--- a/frontend/src/metabase/querying/notebook/components/NotebookStep/NotebookStepPreview/NotebookStepPreview.jsx+++ b/frontend/src/metabase/querying/notebook/components/NotebookStep/NotebookStepPreview/NotebookStepPreview.jsx@@ -22,8 +22,7 @@ const getPreviewQuestion = (step) => {? previewQuery: Lib.limit(previewQuery, stageIndex, PREVIEW_ROWS_LIMIT);- return Question.create()- .setQuery(queryWithLimit)+ return Question.create({ dataset_query: Lib.toJsQuery(queryWithLimit) }).setDisplay("table").setSettings({ "table.pivot": false });};diff --git a/frontend/src/metabase/querying/notebook/utils/steps.unit.spec.ts b/frontend/src/metabase/querying/notebook/utils/steps.unit.spec.tsindex da5fc77adf1..7863f11733f 100644--- a/frontend/src/metabase/querying/notebook/utils/steps.unit.spec.ts+++ b/frontend/src/metabase/querying/notebook/utils/steps.unit.spec.ts@@ -291,13 +291,11 @@ describe("aggregated query without breakout", () => {aggregations: [{ operatorName: "count" }],});- const baseQuestion = Question.create({- databaseId: SAMPLE_DB_ID,+ const question = Question.create({+ dataset_query: Lib.toJsQuery(query),metadata,});- const question = baseQuestion.setQuery(query);-const steps = getQuestionSteps(question, metadata, {});expect(diff --git a/frontend/src/metabase/reference/utils.js b/frontend/src/metabase/reference/utils.jsindex 1b29bbcc624..fe60f162b4a 100644--- a/frontend/src/metabase/reference/utils.js+++ b/frontend/src/metabase/reference/utils.js@@ -31,26 +31,24 @@ export const getQuestion = ({}) => {const metadataProvider = Lib.metadataProvider(databaseId, metadata);const table = Lib.tableOrCardMetadata(metadataProvider, tableId);- let question = Question.create({ databaseId, metadata });-- if (table) {- let query = Lib.queryFromTableOrCardMetadata(metadataProvider, table);-- if (getCount) {- query = Lib.aggregateByCount(query, -1);- }+ if (table == null) {+ return;+ }- if (fieldId) {- query = breakoutWithDefaultTemporalBucket(query, metadata, fieldId);- }+ let query = Lib.queryFromTableOrCardMetadata(metadataProvider, table);+ if (getCount) {+ query = Lib.aggregateByCount(query, -1);+ }- if (segmentId) {- query = filterBySegmentId(query, segmentId);- }+ if (fieldId) {+ query = breakoutWithDefaultTemporalBucket(query, metadata, fieldId);+ }- question = question.setQuery(query);+ if (segmentId) {+ query = filterBySegmentId(query, segmentId);}+ let question = Question.create({ dataset_query: Lib.toJsQuery(query) });if (visualization) {question = question.setDisplay(visualization);}diff --git a/frontend/test/metabase-lib/lib/Question.unit.spec.js b/frontend/test/metabase-lib/lib/Question.unit.spec.jsindex 7c2fbe37db3..a70acbb4f7d 100644--- a/frontend/test/metabase-lib/lib/Question.unit.spec.js+++ b/frontend/test/metabase-lib/lib/Question.unit.spec.js@@ -291,8 +291,8 @@ describe("Question", () => {describe("Question.create(...)", () => {const question = Question.create({metadata,- databaseId: SAMPLE_DB_ID,- tableId: ORDERS_ID,+ DEPRECATED_RAW_MBQL_databaseId: SAMPLE_DB_ID,+ DEPRECATED_RAW_MBQL_tableId: ORDERS_ID,});it("defaults to table display", () => {@@ -563,24 +563,24 @@ describe("Question", () => {it("questions that differ only by randomized idents are considered equal", () => {const question1 = Question.create({- databaseId: SAMPLE_DB_ID,- tableId: ORDERS_ID,+ DEPRECATED_RAW_MBQL_databaseId: SAMPLE_DB_ID,+ DEPRECATED_RAW_MBQL_tableId: ORDERS_ID,});const question2 = Question.create({- databaseId: SAMPLE_DB_ID,- tableId: ORDERS_ID,+ DEPRECATED_RAW_MBQL_databaseId: SAMPLE_DB_ID,+ DEPRECATED_RAW_MBQL_tableId: ORDERS_ID,});expect(question1.isDirtyComparedTo(question2)).toBe(false);});it("questions that differ by query only are not considered equal", () => {const question1 = Question.create({- databaseId: SAMPLE_DB_ID,- tableId: PRODUCTS_ID,+ DEPRECATED_RAW_MBQL_databaseId: SAMPLE_DB_ID,+ DEPRECATED_RAW_MBQL_tableId: PRODUCTS_ID,});const question2 = Question.create({- databaseId: SAMPLE_DB_ID,- tableId: ORDERS_ID,+ DEPRECATED_RAW_MBQL_databaseId: SAMPLE_DB_ID,+ DEPRECATED_RAW_MBQL_tableId: ORDERS_ID,});expect(question1.isDirtyComparedTo(question2)).toBe(true);});diff --git a/frontend/test/metabase-lib/lib/queries/NativeQuery.unit.spec.js b/frontend/test/metabase-lib/lib/queries/NativeQuery.unit.spec.jsindex 7bf11ea3c32..cd637babe97 100644--- a/frontend/test/metabase-lib/lib/queries/NativeQuery.unit.spec.js+++ b/frontend/test/metabase-lib/lib/queries/NativeQuery.unit.spec.js@@ -53,14 +53,14 @@ function makeDatasetQuery(queryText, templateTags, databaseId) {function makeQuery(query, templateTags, metadata = METADATA) {return new NativeQuery(- Question.create({ type: "native", metadata }),+ Question.create({ DEPRECATED_RAW_MBQL_type: "native", metadata }),makeDatasetQuery(query, templateTags, SAMPLE_DB_ID),);}function makeMongoQuery(query, templateTags, metadata = METADATA) {return new NativeQuery(- Question.create({ type: "native", metadata }),+ Question.create({ DEPRECATED_RAW_MBQL_type: "native", metadata }),makeDatasetQuery(query, templateTags, MONGO_DB_ID),);}