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
Merge `metabase-lib/v1/utils/card` and `metabase/utils/card` into `metabase/common/utils/card` (#72609)
Romeo Van Snickc795da13e07f
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkAdHocQuestion/SdkAdHocQuestion.tsx b/frontend/src/embedding-sdk-bundle/components/private/SdkAdHocQuestion/SdkAdHocQuestion.tsxindex 4aa403c30e0..b61be7561c9 100644--- a/frontend/src/embedding-sdk-bundle/components/private/SdkAdHocQuestion/SdkAdHocQuestion.tsx+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkAdHocQuestion/SdkAdHocQuestion.tsx@@ -2,7 +2,7 @@ import { useMemo } from "react";import type { SdkQuestionProps } from "embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion";import { SdkQuestion } from "embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion";-import { deserializeCard, parseHash } from "metabase/utils/card";+import { deserializeCard, parseHash } from "metabase/common/utils/card";import * as Urls from "metabase/utils/urls";import type { QuestionMockLocationParameters } from "../SdkQuestion/context";diff --git a/frontend/src/embedding-sdk-bundle/lib/sdk-question/run-question-on-navigate.ts b/frontend/src/embedding-sdk-bundle/lib/sdk-question/run-question-on-navigate.tsindex ce8cc24e9ec..eafa66a8f0f 100644--- a/frontend/src/embedding-sdk-bundle/lib/sdk-question/run-question-on-navigate.ts+++ b/frontend/src/embedding-sdk-bundle/lib/sdk-question/run-question-on-navigate.ts@@ -3,13 +3,13 @@ import type {NavigateToNewCardParams,SdkQuestionState,} from "embedding-sdk-bundle/types/question";+import { cardIsEquivalent } from "metabase/common/utils/card";import { loadCard } from "metabase/query_builder/actions/core/card";import { loadMetadataForCard } from "metabase/questions/actions";import type { Dispatch, GetState } from "metabase/redux/store";import { getMetadata } from "metabase/selectors/metadata";import { getCardAfterVisualizationClick } from "metabase/visualizations/lib/utils";import Question from "metabase-lib/v1/Question";-import { cardIsEquivalent } from "metabase-lib/v1/queries/utils/card";import type { ParameterValuesMap } from "metabase-types/api";import type { EntityToken } from "metabase-types/api/entity";diff --git a/frontend/src/metabase-lib/v1/Question.ts b/frontend/src/metabase-lib/v1/Question.tsindex 52c78e66170..013dbd050af 100644--- a/frontend/src/metabase-lib/v1/Question.ts+++ b/frontend/src/metabase-lib/v1/Question.ts@@ -5,11 +5,11 @@ import slugg from "slugg";import _ from "underscore";/* eslint-disable no-restricted-imports */-import { applyParameter } from "metabase/querying/parameters/utils/query";import {type SerializeCardOptions,serializeCardForUrl,-} from "metabase/utils/card";+} from "metabase/common/utils/card";+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";@@ -21,7 +21,6 @@ import NativeQuery, {NATIVE_QUERY_TEMPLATE,} from "metabase-lib/v1/queries/NativeQuery";import { STRUCTURED_QUERY_TEMPLATE } from "metabase-lib/v1/queries/StructuredQuery";-import { isTransientId } from "metabase-lib/v1/queries/utils/card";import type {Card,CardDisplayType,@@ -154,10 +153,10 @@ class Question {const card = question.card();const { id, original_card_id } = card;- if (isTransientId(id)) {+ if (isTransientCardId(id)) {question = question.setCard(_.omit(question.card(), "id"));}- if (isTransientId(original_card_id)) {+ if (isTransientCardId(original_card_id)) {question = question.setCard(_.omit(question.card(), "original_card_id"));}@@ -871,5 +870,9 @@ class Question {}}+export function isTransientCardId(id: CardId | string | null | undefined) {+ return id != null && typeof id === "string" && isNaN(parseInt(id));+}+// eslint-disable-next-line import/no-default-export -- deprecated usageexport default Question;diff --git a/frontend/src/metabase-lib/v1/queries/utils/card.js b/frontend/src/metabase-lib/v1/queries/utils/card.jsindex 559a02da41b..e69de29bb2d 100644--- a/frontend/src/metabase-lib/v1/queries/utils/card.js+++ b/frontend/src/metabase-lib/v1/queries/utils/card.js@@ -1,111 +0,0 @@-import { updateIn } from "icepick";-import _ from "underscore";--import { clone } from "metabase/utils/clone";-import * as Lib from "metabase-lib";-import Question from "metabase-lib/v1/Question";-import { deriveFieldOperatorFromParameter } from "metabase-lib/v1/parameters/utils/operators";-import { normalizeParameterValue } from "metabase-lib/v1/parameters/utils/parameter-values";--export function isNative(card) {- if (!card) {- return false;- }- const question = Question.create({ dataset_query: card.dataset_query });- return question.isNative();-}--function cardVisualizationIsEquivalent(cardA, cardB) {- return _.isEqual(- _.pick(cardA, "display", "visualization_settings"),- _.pick(cardB, "display", "visualization_settings"),- );-}--export function cardQueryIsEquivalent(cardA, cardB) {- cardA = updateIn(cardA, ["dataset_query", "parameters"], (p) => p || []);- cardB = updateIn(cardB, ["dataset_query", "parameters"], (p) => p || []);- return Lib.areLegacyQueriesEqual(- _.pick(cardA, "dataset_query"),- _.pick(cardB, "dataset_query"),- );-}--export function cardParametersAreEquivalent(cardA, cardB) {- return _.isEqual(cardA.parameters || [], cardB.parameters || []);-}--export function cardIsEquivalent(cardA, cardB) {- return (- cardQueryIsEquivalent(cardA, cardB) &&- cardVisualizationIsEquivalent(cardA, cardB)- );-}--// NOTE Atte Keinänen 7/5/17: Still used in dashboards and public questions.-// Query builder uses `Question.getResults` which contains similar logic.-export function applyParameters(- card,- parameters,- parameterValues = {},- parameterMappings = [],- { sparse = false } = {},-) {- const datasetQuery = clone(card.dataset_query);- datasetQuery.parameters = [];- for (const parameter of parameters || []) {- const value = parameterValues[parameter.id];-- const cardId = card.id || card.original_card_id;- const mapping = _.findWhere(- parameterMappings,- cardId != null- ? {- card_id: cardId,- parameter_id: parameter.id,- }- : // NOTE: this supports transient dashboards where cards don't have ids- // BUT will not work correctly with multiseries dashcards since- // there's no way to identify which card the mapping applies to.- {- parameter_id: parameter.id,- },- );-- const type = parameter.type;- const options =- deriveFieldOperatorFromParameter(parameter)?.optionsDefaults;-- const queryParameter = {- type,- value: normalizeParameterValue(type, value),- id: parameter.id,- };-- if (options) {- queryParameter.options = options;- }-- if (mapping) {- // mapped target, e.x. on a dashboard- queryParameter.target = mapping.target;- datasetQuery.parameters.push(queryParameter);- } else if (parameter.target) {- // inline target, e.x. on a card- queryParameter.target = parameter.target;- datasetQuery.parameters.push(queryParameter);- }-- if (sparse) {- // These items will be backfilled by the API- delete queryParameter.type;- delete queryParameter.target;- }- }-- return datasetQuery;-}--export function isTransientId(id) {- return id != null && typeof id === "string" && isNaN(parseInt(id));-}diff --git a/frontend/src/metabase-lib/v1/urls.ts b/frontend/src/metabase-lib/v1/urls.tsindex 31ddf386b4d..891538625a5 100644--- a/frontend/src/metabase-lib/v1/urls.ts+++ b/frontend/src/metabase-lib/v1/urls.ts@@ -1,10 +1,10 @@import { utf8_to_b64url } from "metabase/utils/encoding";import * as Urls from "metabase/utils/urls";import * as Lib from "metabase-lib";+import { isTransientCardId } from "metabase-lib/v1/Question";import type { ParameterWithTarget } from "metabase-lib/v1/parameters/types";import { getParameterValuesBySlug } from "metabase-lib/v1/parameters/utils/parameter-values";import { remapParameterValuesToTemplateTags } from "metabase-lib/v1/parameters/utils/template-tags";-import { isTransientId } from "metabase-lib/v1/queries/utils/card";import type { ParameterId, ParameterValueOrArray } from "metabase-types/api";import type Question from "./Question";@@ -106,7 +106,7 @@ export function getAutomaticDashboardUrl(: "";const query = question.datasetQuery();- if (questionId != null && !isTransientId(questionId)) {+ if (questionId != null && !isTransientCardId(questionId)) {return `auto/dashboard/question/${questionId}${cellQuery}`;} else {const adHocQuery = utf8_to_b64url(JSON.stringify(query));@@ -127,7 +127,7 @@ export function getComparisonDashboardUrl(: "";const query = question.datasetQuery();- if (questionId != null && !isTransientId(questionId)) {+ if (questionId != null && !isTransientCardId(questionId)) {return `auto/dashboard/question/${questionId}${cellQuery}/compare/table/${tableId}`;} else {const adHocQuery = utf8_to_b64url(JSON.stringify(query));diff --git a/frontend/src/metabase/common/components/AdHocQuestionLoader.tsx b/frontend/src/metabase/common/components/AdHocQuestionLoader.tsxindex 188c1f07c43..c348ba53324 100644--- a/frontend/src/metabase/common/components/AdHocQuestionLoader.tsx+++ b/frontend/src/metabase/common/components/AdHocQuestionLoader.tsx@@ -1,9 +1,9 @@import type { ReactNode } from "react";import { useCallback, useEffect, useRef, useState } from "react";+import { deserializeCardFromUrl } from "metabase/common/utils/card";import { loadMetadataForCard } from "metabase/questions/actions";import { getMetadata } from "metabase/selectors/metadata";-import { deserializeCardFromUrl } from "metabase/utils/card";import { useDispatch, useSelector } from "metabase/utils/redux";import Question from "metabase-lib/v1/Question";import type Metadata from "metabase-lib/v1/metadata/Metadata";diff --git a/frontend/src/metabase/common/components/AdHocQuestionLoader.unit.spec.tsx b/frontend/src/metabase/common/components/AdHocQuestionLoader.unit.spec.tsxindex 95bec3939e6..cc32080d2d6 100644--- a/frontend/src/metabase/common/components/AdHocQuestionLoader.unit.spec.tsx+++ b/frontend/src/metabase/common/components/AdHocQuestionLoader.unit.spec.tsx@@ -1,6 +1,6 @@import { render } from "__support__/ui";import { delay } from "__support__/utils";-import * as Card from "metabase/utils/card";+import * as Card from "metabase/common/utils/card";import * as Lib from "metabase-lib";import {DEFAULT_TEST_QUERY,diff --git a/frontend/src/metabase/common/components/QuestionLoader.tsx b/frontend/src/metabase/common/components/QuestionLoader.tsxindex 110f579a7c6..9e1186b7e90 100644--- a/frontend/src/metabase/common/components/QuestionLoader.tsx+++ b/frontend/src/metabase/common/components/QuestionLoader.tsx@@ -2,8 +2,8 @@ import type { ReactNode } from "react";import { AdHocQuestionLoader } from "metabase/common/components/AdHocQuestionLoader";import { SavedQuestionLoader } from "metabase/common/components/SavedQuestionLoader";+import { serializeCardForUrl } from "metabase/common/utils/card";import renderPropToHOC from "metabase/hoc/RenderPropToHOC";-import { serializeCardForUrl } from "metabase/utils/card";import type Question from "metabase-lib/v1/Question";import type { CardId, UnsavedCard } from "metabase-types/api";diff --git a/frontend/src/metabase/common/utils/card.ts b/frontend/src/metabase/common/utils/card.tsnew file mode 100644index 00000000000..fb9b0dcdc8f--- /dev/null+++ b/frontend/src/metabase/common/utils/card.ts@@ -0,0 +1,251 @@+import querystring from "querystring";++import _ from "underscore";++import { clone } from "metabase/utils/clone";+import { b64hash_to_utf8, utf8_to_b64url } from "metabase/utils/encoding";+import { stableStringify } from "metabase/utils/objects";+import * as Lib from "metabase-lib";+import Question from "metabase-lib/v1/Question";+import type { UiParameter } from "metabase-lib/v1/parameters/types";+import { deriveFieldOperatorFromParameter } from "metabase-lib/v1/parameters/utils/operators";+import { normalizeParameterValue } from "metabase-lib/v1/parameters/utils/parameter-values";+import { normalize } from "metabase-lib/v1/queries/utils/normalize";+import type {+ ActionParametersMapping,+ Card,+ DashboardParameterMapping,+ DatasetQuery,+ LegacyDatasetQuery,+ Parameter,+ ParameterValuesMap,+ UnsavedCard,+ VirtualDashCardParameterMapping,+} from "metabase-types/api";++export type SerializeCardOptions = {+ includeDatasetQuery?: boolean;+ includeOriginalCardId?: boolean;+ includeDisplayIsLocked?: boolean;+ creationType?: string;+ parameterValues?: ParameterValuesMap;+};++function getCleanCard(+ card: Card | UnsavedCard,+ {+ includeDatasetQuery = true,+ includeOriginalCardId = true,+ includeDisplayIsLocked = false,+ creationType,+ parameterValues,+ }: SerializeCardOptions = {},+) {+ const value = { ...card, creationType, parameterValues };+ const keysToInclude = [+ "collection_id",+ "dashboard_id",+ "dashboardId",+ "dashcardId",+ "description",+ "display",+ "name",+ "parameters",+ "type",+ "visualization_settings",+ ];++ if (includeDatasetQuery) {+ keysToInclude.push("dataset_query");+ }+ if (includeOriginalCardId) {+ keysToInclude.push("original_card_id");+ }+ if (includeDisplayIsLocked) {+ keysToInclude.push("displayIsLocked");+ }+ if (creationType) {+ keysToInclude.push("creationType");+ }+ if (parameterValues) {+ keysToInclude.push("parameterValues");+ }++ type Key = keyof typeof value;++ const res: { [key in Key]?: unknown } = {};+ for (const key of keysToInclude) {+ // coerce to undefined to omit+ res[key as Key] = value[key as Key] ?? undefined;+ }++ return res;+}++export function isEqualCard(card1?: Card | null, card2?: Card | null) {+ if (card1 && card2) {+ return _.isEqual(getCleanCard(card1), getCleanCard(card2));+ } else {+ return false;+ }+}++// TODO Atte Keinänen 5/31/17 Deprecated, we should move tests to Questions.spec.js+export function serializeCardForUrl(+ card: Card | UnsavedCard,+ options: SerializeCardOptions = {},+) {+ return utf8_to_b64url(stableStringify(getCleanCard(card, options)));+}++export function deserializeCardFromUrl(serialized: string): Card {+ return JSON.parse(b64hash_to_utf8(serialized));+}++export function deserializeCard(serializedCard: string) {+ const card = deserializeCardFromUrl(serializedCard);+ if (card.dataset_query.database != null) {+ card.dataset_query = normalize(card.dataset_query);+ }+ return card;+}++type HashOptions = {+ db?: string;+ table?: string;+ segment?: string;+};++export function parseHash(hash?: string) {+ let options: HashOptions = {};+ let serializedCard;++ // hash can contain either query params starting with ? or a base64 serialized card+ if (hash) {+ const cleanHash = hash.replace(/^#/, "");+ if (cleanHash.charAt(0) === "?") {+ options = querystring.parse(cleanHash.substring(1));+ } else {+ serializedCard = cleanHash;+ }+ }++ return { options, serializedCard };+}++export function isNative(card?: Card | null | undefined) {+ if (!card) {+ return false;+ }+ const question = Question.create({ dataset_query: card.dataset_query });+ return question.isNative();+}++function cardVisualizationIsEquivalent(cardA: Card, cardB: Card) {+ return _.isEqual(+ _.pick(cardA, "display", "visualization_settings"),+ _.pick(cardB, "display", "visualization_settings"),+ );+}++function isLegacyDatasetQuery(+ datasetQuery: DatasetQuery,+): datasetQuery is LegacyDatasetQuery {+ return (+ "type" in datasetQuery &&+ (datasetQuery.type === "query" || datasetQuery.type === "native")+ );+}++function datasetQueryForComparison(datasetQuery: DatasetQuery): DatasetQuery {+ const res = clone(datasetQuery);++ if (isLegacyDatasetQuery(res)) {+ res.parameters ??= [];+ }++ return res;+}++export function cardQueryIsEquivalent(cardA: Card, cardB: Card) {+ const datasetQueryA = datasetQueryForComparison(cardA.dataset_query);+ const datasetQueryB = datasetQueryForComparison(cardB.dataset_query);+ return Lib.areLegacyQueriesEqual(datasetQueryA, datasetQueryB);+}++export function cardParametersAreEquivalent(cardA: Card, cardB: Card) {+ return _.isEqual(cardA.parameters || [], cardB.parameters || []);+}++export function cardIsEquivalent(cardA: Card, cardB: Card) {+ return (+ cardQueryIsEquivalent(cardA, cardB) &&+ cardVisualizationIsEquivalent(cardA, cardB)+ );+}++// NOTE Atte Keinänen 7/5/17: Still used in dashboards and public questions.+// Query builder uses `Question.getResults` which contains similar logic.+export function applyParameters(+ card: Card,+ parameters: Parameter[] | null | undefined,+ parameterValues: ParameterValuesMap = {},+ parameterMappings:+ | ActionParametersMapping[]+ | DashboardParameterMapping[]+ | VirtualDashCardParameterMapping[] = [],+ { sparse = false }: { sparse?: boolean } = {},+) {+ // TODO(romeovs): This cast is a hack, this function only works with LegacyDatasetQuery+ const datasetQuery = clone(card.dataset_query) as LegacyDatasetQuery;+ datasetQuery.parameters = [];+ for (const parameter of parameters || []) {+ const value = parameterValues[parameter.id];++ const cardId = card.id || card.original_card_id;+ const mapping = _.findWhere(+ parameterMappings,+ cardId != null+ ? {+ card_id: cardId,+ parameter_id: parameter.id,+ }+ : // NOTE: this supports transient dashboards where cards don't have ids+ // BUT will not work correctly with multiseries dashcards since+ // there's no way to identify which card the mapping applies to.+ {+ parameter_id: parameter.id,+ },+ );++ const queryParameter: Partial<UiParameter> = {+ type: parameter.type,+ value: normalizeParameterValue(parameter.type, value),+ id: parameter.id,+ };++ const options =+ deriveFieldOperatorFromParameter(parameter)?.optionsDefaults;++ if (options) {+ queryParameter.options = options;+ }++ if (mapping) {+ // mapped target, e.x. on a dashboard+ queryParameter.target = mapping.target;+ datasetQuery.parameters.push(queryParameter as UiParameter);+ } else if (parameter.target) {+ // inline target, e.x. on a card+ queryParameter.target = parameter.target;+ datasetQuery.parameters.push(queryParameter as UiParameter);+ }++ if (sparse) {+ delete queryParameter.type;+ delete queryParameter.target;+ }+ }++ return datasetQuery;+}diff --git a/frontend/src/metabase/dashboard/actions/data-fetching.ts b/frontend/src/metabase/dashboard/actions/data-fetching.tsindex 066310ab992..c2af515d6c6 100644--- a/frontend/src/metabase/dashboard/actions/data-fetching.ts+++ b/frontend/src/metabase/dashboard/actions/data-fetching.ts@@ -5,6 +5,7 @@ import { t } from "ttag";import _ from "underscore";import { automagicDashboardsApi, dashboardApi } from "metabase/api";+import { applyParameters } from "metabase/common/utils/card";import { showAutoApplyFiltersToast } from "metabase/dashboard/actions/parameters";import { DASHBOARD_SLOW_TIMEOUT } from "metabase/dashboard/constants";import {@@ -50,7 +51,6 @@ import { isVisualizerDashboardCard } from "metabase/visualizer/utils";import type { UiParameter } from "metabase-lib/v1/parameters/types";import { getParameterValuesByIdFromQueryParams } from "metabase-lib/v1/parameters/utils/parameter-parsing";import { getParameterValuesBySlug } from "metabase-lib/v1/parameters/utils/parameter-values";-import { applyParameters } from "metabase-lib/v1/queries/utils/card";import type {Card,CardId,@@ -320,18 +320,7 @@ export const fetchCardDataAction = createAsyncThunk<cancelled: deferred.promise,};- // make the actual request- if (datasetQuery.type === "endpoint") {- result = await fetchDataOrError(- MetabaseApi.datasetEndpoint(- {- endpoint: datasetQuery.endpoint,- parameters: datasetQuery.parameters,- },- queryOptions,- ),- );- } else if (dashboardType === "public") {+ if (dashboardType === "public") {result = (await fetchDataOrError(maybeUsePivotEndpoint(PublicApi.dashboardCardQuery,diff --git a/frontend/src/metabase/dashboard/components/DashboardLeaveConfirmationModal/utils.ts b/frontend/src/metabase/dashboard/components/DashboardLeaveConfirmationModal/utils.tsindex a25c6d64124..49bea96c5b2 100644--- a/frontend/src/metabase/dashboard/components/DashboardLeaveConfirmationModal/utils.ts+++ b/frontend/src/metabase/dashboard/components/DashboardLeaveConfirmationModal/utils.ts@@ -1,6 +1,6 @@import type { Location } from "history";-import { deserializeCard, parseHash } from "metabase/utils/card";+import { deserializeCard, parseHash } from "metabase/common/utils/card";export const isNavigatingToCreateADashboardQuestion = (nextLocation?: Location,diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion.tsxindex 64d8f62ad5d..2790456fa23 100644--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion.tsx+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestion.tsx@@ -2,6 +2,7 @@ import type { Location } from "history";import { useCallback, useEffect, useState } from "react";import { useLatest, useMount } from "react-use";+import { applyParameters } from "metabase/common/utils/card";import { fetchDataOrError } from "metabase/dashboard/utils";import { EmbeddingEntityContextProvider } from "metabase/embedding/context";import { LocaleProvider } from "metabase/public/LocaleProvider";@@ -18,7 +19,6 @@ import { getCardUiParameters } from "metabase-lib/v1/parameters/utils/cards";import { getParameterValuesByIdFromQueryParams } from "metabase-lib/v1/parameters/utils/parameter-parsing";import { getParameterValuesBySlug } from "metabase-lib/v1/parameters/utils/parameter-values";import { getParametersFromCard } from "metabase-lib/v1/parameters/utils/template-tags";-import { applyParameters } from "metabase-lib/v1/queries/utils/card";import type {Card,Dataset,diff --git a/frontend/src/metabase/query_builder/actions/core/core.ts b/frontend/src/metabase/query_builder/actions/core/core.tsindex c15f09147bc..463c1616ac1 100644--- a/frontend/src/metabase/query_builder/actions/core/core.ts+++ b/frontend/src/metabase/query_builder/actions/core/core.ts@@ -1,6 +1,10 @@import _ from "underscore";import { invalidateNotificationsApiCache, revisionApi } from "metabase/api";+import {+ cardIsEquivalent,+ cardQueryIsEquivalent,+} from "metabase/common/utils/card";import { Databases } from "metabase/entities/databases";import { updateModelIndexes } from "metabase/entities/model-indexes/actions";import { Questions } from "metabase/entities/questions";@@ -28,10 +32,6 @@ import * as Lib from "metabase-lib";import Question from "metabase-lib/v1/Question";import { isAdHocModelOrMetricQuestion } from "metabase-lib/v1/metadata/utils/models";import NativeQuery from "metabase-lib/v1/queries/NativeQuery";-import {- cardIsEquivalent,- cardQueryIsEquivalent,-} from "metabase-lib/v1/queries/utils/card";import type {Card,DashboardTabId,diff --git a/frontend/src/metabase/query_builder/actions/core/initializeQB.ts b/frontend/src/metabase/query_builder/actions/core/initializeQB.tsindex 75e3ebf213b..9a37470c531 100644--- a/frontend/src/metabase/query_builder/actions/core/initializeQB.ts+++ b/frontend/src/metabase/query_builder/actions/core/initializeQB.ts@@ -1,6 +1,11 @@import type { LocationDescriptorObject } from "history";import { replace } from "react-router-redux";+import {+ cardIsEquivalent,+ deserializeCard,+ parseHash,+} from "metabase/common/utils/card";import { Questions } from "metabase/entities/questions";import { Snippets } from "metabase/entities/snippets";import {@@ -18,7 +23,6 @@ import type {} from "metabase/redux/store";import { getMetadata } from "metabase/selectors/metadata";import { canUserCreateQueries, getUser } from "metabase/selectors/user";-import { deserializeCard, parseHash } from "metabase/utils/card";import { isNotNull } from "metabase/utils/types";import * as Urls from "metabase/utils/urls";import * as Lib from "metabase-lib";@@ -26,7 +30,6 @@ import Question from "metabase-lib/v1/Question";import type Metadata from "metabase-lib/v1/metadata/Metadata";import type NativeQuery from "metabase-lib/v1/queries/NativeQuery";import { updateCardTemplateTagNames } from "metabase-lib/v1/queries/NativeQuery";-import { cardIsEquivalent } from "metabase-lib/v1/queries/utils/card";import type { Card, SegmentId } from "metabase-types/api";import type { EntityToken } from "metabase-types/api/entity";import { isSavedCard } from "metabase-types/guards";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 7381c1e4365..ce35754f169 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@@ -2,6 +2,7 @@ import fetchMock from "fetch-mock";import type { LocationDescriptorObject } from "history";import { createMockEntitiesState } from "__support__/store";+import * as CardLib from "metabase/common/utils/card";import { Databases } from "metabase/entities/databases";import { Snippets } from "metabase/entities/snippets";import * as questionActions from "metabase/questions/actions";@@ -9,7 +10,6 @@ import { setErrorPage } from "metabase/redux/app";import * as sharedQB from "metabase/redux/query-builder";import { createMockState } from "metabase/redux/store/mocks";import { getMetadata } from "metabase/selectors/metadata";-import * as CardLib from "metabase/utils/card";import { checkNotNull } from "metabase/utils/types";import * as Urls from "metabase/utils/urls";import * as Lib from "metabase-lib";diff --git a/frontend/src/metabase/query_builder/actions/core/parameterUtils.ts b/frontend/src/metabase/query_builder/actions/core/parameterUtils.tsindex cda6e48619e..d42e2391521 100644--- a/frontend/src/metabase/query_builder/actions/core/parameterUtils.ts+++ b/frontend/src/metabase/query_builder/actions/core/parameterUtils.ts@@ -1,3 +1,7 @@+import {+ cardIsEquivalent,+ cardParametersAreEquivalent,+} from "metabase/common/utils/card";import { hasMatchingParameters } from "metabase/parameters/utils/dashboards";import { setErrorPage } from "metabase/redux/app";import type { Dispatch } from "metabase/redux/store";@@ -5,10 +9,6 @@ import { DashboardApi } from "metabase/services";import type Metadata from "metabase-lib/v1/metadata/Metadata";import { getCardUiParameters } from "metabase-lib/v1/parameters/utils/cards";import { getParameterValuesByIdFromQueryParams } from "metabase-lib/v1/parameters/utils/parameter-parsing";-import {- cardIsEquivalent,- cardParametersAreEquivalent,-} from "metabase-lib/v1/queries/utils/card";import type { Card, Parameter } from "metabase-types/api";type BlankQueryOptions = {diff --git a/frontend/src/metabase/query_builder/actions/url.ts b/frontend/src/metabase/query_builder/actions/url.tsindex b79b442a9d0..8f4ef93a085 100644--- a/frontend/src/metabase/query_builder/actions/url.ts+++ b/frontend/src/metabase/query_builder/actions/url.ts@@ -3,7 +3,7 @@ import { parse as parseUrl } from "url";import type { LocationDescriptor } from "history";import { push, replace } from "react-router-redux";-import { isEqualCard } from "metabase/utils/card";+import { isEqualCard } from "metabase/common/utils/card";import { createThunkAction } from "metabase/utils/redux";import * as Lib from "metabase-lib";import type Question from "metabase-lib/v1/Question";diff --git a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionDataSource/QuestionDataSource.unit.spec.js b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionDataSource/QuestionDataSource.unit.spec.jsindex d77f8c792b7..5589b41e52a 100644--- a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionDataSource/QuestionDataSource.unit.spec.js+++ b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionDataSource/QuestionDataSource.unit.spec.js@@ -7,7 +7,7 @@ import {setupTableEndpoints,} from "__support__/server-mocks";import { getIcon, renderWithProviders, screen } from "__support__/ui";-import { deserializeCardFromUrl } from "metabase/utils/card";+import { deserializeCardFromUrl } from "metabase/common/utils/card";import * as Urls from "metabase/utils/urls";import * as Lib from "metabase-lib";import { SAMPLE_METADATA } from "metabase-lib/test-helpers";diff --git a/frontend/src/metabase/query_builder/containers/QueryBuilder.unsaved-changes-warning.unit.spec.tsx b/frontend/src/metabase/query_builder/containers/QueryBuilder.unsaved-changes-warning.unit.spec.tsxindex 9d148ddd733..84535d193dc 100644--- a/frontend/src/metabase/query_builder/containers/QueryBuilder.unsaved-changes-warning.unit.spec.tsx+++ b/frontend/src/metabase/query_builder/containers/QueryBuilder.unsaved-changes-warning.unit.spec.tsx@@ -15,7 +15,7 @@ import {waitForLoaderToBeRemoved,within,} from "__support__/ui";-import { serializeCardForUrl } from "metabase/utils/card";+import { serializeCardForUrl } from "metabase/common/utils/card";import registerVisualizations from "metabase/visualizations/register";import {createMockCardQueryMetadata,diff --git a/frontend/src/metabase/query_builder/containers/test-utils.tsx b/frontend/src/metabase/query_builder/containers/test-utils.tsxindex 30ef33023b5..f8f1f989768 100644--- a/frontend/src/metabase/query_builder/containers/test-utils.tsx+++ b/frontend/src/metabase/query_builder/containers/test-utils.tsx@@ -35,10 +35,10 @@ import {} from "__support__/ui";import { NewItemMenu } from "metabase/common/components/NewItemMenu";import { LOAD_COMPLETE_FAVICON } from "metabase/common/hooks/constants";+import { serializeCardForUrl } from "metabase/common/utils/card";import NewModelOptions from "metabase/models/containers/NewModelOptions";import type { RequestState, State } from "metabase/redux/store";import { createMockState } from "metabase/redux/store/mocks";-import { serializeCardForUrl } from "metabase/utils/card";import { checkNotNull } from "metabase/utils/types";import type { Card, Dataset, UnsavedCard } from "metabase-types/api";import {diff --git a/frontend/src/metabase/query_builder/utils/index.ts b/frontend/src/metabase/query_builder/utils/index.tsindex e497bdb0bd6..e241d4412c1 100644--- a/frontend/src/metabase/query_builder/utils/index.ts+++ b/frontend/src/metabase/query_builder/utils/index.ts@@ -3,8 +3,8 @@ import querystring from "querystring";import type { Location } from "history";import _ from "underscore";+import { serializeCardForUrl } from "metabase/common/utils/card";import type { DatasetEditorTab, QueryBuilderMode } from "metabase/redux/store";-import { serializeCardForUrl } from "metabase/utils/card";import * as Urls from "metabase/utils/urls";import * as Lib from "metabase-lib";import type Question from "metabase-lib/v1/Question";diff --git a/frontend/src/metabase/query_builder/utils/utils.unit.spec.ts b/frontend/src/metabase/query_builder/utils/utils.unit.spec.tsindex d6d27513789..0e6ca43ee39 100644--- a/frontend/src/metabase/query_builder/utils/utils.unit.spec.ts+++ b/frontend/src/metabase/query_builder/utils/utils.unit.spec.ts@@ -1,7 +1,7 @@import { createMockMetadata } from "__support__/metadata";import { getNextId } from "__support__/utils";+import { serializeCardForUrl } from "metabase/common/utils/card";import { createMockLocation } from "metabase/redux/store/mocks";-import { serializeCardForUrl } from "metabase/utils/card";import { checkNotNull } from "metabase/utils/types";import type Question from "metabase-lib/v1/Question";import type { Card } from "metabase-types/api";diff --git a/frontend/src/metabase/services.js b/frontend/src/metabase/services.jsindex ab89d9fc140..3108e59f477 100644--- a/frontend/src/metabase/services.js+++ b/frontend/src/metabase/services.js@@ -1,8 +1,8 @@+import { isNative } from "metabase/common/utils/card";import { isEmbedPreview } from "metabase/embedding/config";import api, { DELETE, GET, POST, PUT } from "metabase/utils/api";import Question from "metabase-lib/v1/Question";import { normalizeParameters } from "metabase-lib/v1/parameters/utils/parameter-values";-import { isNative } from "metabase-lib/v1/queries/utils/card";import { getPivotOptions } from "metabase-lib/v1/queries/utils/pivot";export const internalBase = "/api";diff --git a/frontend/src/metabase/utils/card.ts b/frontend/src/metabase/utils/card.tsdeleted file mode 100644index 067fc73415a..00000000000--- a/frontend/src/metabase/utils/card.ts+++ /dev/null@@ -1,118 +0,0 @@-import querystring from "querystring";--import _ from "underscore";--import { b64hash_to_utf8, utf8_to_b64url } from "metabase/utils/encoding";-import { stableStringify } from "metabase/utils/objects";-import { normalize } from "metabase-lib/v1/queries/utils/normalize";-import type { Card, ParameterValuesMap, UnsavedCard } from "metabase-types/api";--export type SerializeCardOptions = {- includeDatasetQuery?: boolean;- includeOriginalCardId?: boolean;- includeDisplayIsLocked?: boolean;- creationType?: string;- parameterValues?: ParameterValuesMap;-};--function getCleanCard(- card: Card | UnsavedCard,- {- includeDatasetQuery = true,- includeOriginalCardId = true,- includeDisplayIsLocked = false,- creationType,- parameterValues,- }: SerializeCardOptions = {},-) {- const value = { ...card, creationType, parameterValues };- const keysToInclude = [- "collection_id",- "dashboard_id",- "dashboardId",- "dashcardId",- "description",- "display",- "name",- "parameters",- "type",- "visualization_settings",- ];-- if (includeDatasetQuery) {- keysToInclude.push("dataset_query");- }- if (includeOriginalCardId) {- keysToInclude.push("original_card_id");- }- if (includeDisplayIsLocked) {- keysToInclude.push("displayIsLocked");- }- if (creationType) {- keysToInclude.push("creationType");- }- if (parameterValues) {- keysToInclude.push("parameterValues");- }-- type Key = keyof typeof value;-- const res: { [key in Key]?: unknown } = {};- for (const key of keysToInclude) {- // coerce to undefined to omit- res[key as Key] = value[key as Key] ?? undefined;- }-- return res;-}--export function isEqualCard(card1?: Card | null, card2?: Card | null) {- if (card1 && card2) {- return _.isEqual(getCleanCard(card1), getCleanCard(card2));- } else {- return false;- }-}--// TODO Atte Keinänen 5/31/17 Deprecated, we should move tests to Questions.spec.js-export function serializeCardForUrl(- card: Card | UnsavedCard,- options: SerializeCardOptions = {},-) {- return utf8_to_b64url(stableStringify(getCleanCard(card, options)));-}--export function deserializeCardFromUrl(serialized: string): Card {- return JSON.parse(b64hash_to_utf8(serialized));-}--export function deserializeCard(serializedCard: string) {- const card = deserializeCardFromUrl(serializedCard);- if (card.dataset_query.database != null) {- card.dataset_query = normalize(card.dataset_query);- }- return card;-}--type HashOptions = {- db?: string;- table?: string;- segment?: string;-};--export function parseHash(hash?: string) {- let options: HashOptions = {};- let serializedCard;-- // hash can contain either query params starting with ? or a base64 serialized card- if (hash) {- const cleanHash = hash.replace(/^#/, "");- if (cleanHash.charAt(0) === "?") {- options = querystring.parse(cleanHash.substring(1));- } else {- serializedCard = cleanHash;- }- }-- return { options, serializedCard };-}diff --git a/frontend/src/metabase/utils/card.unit.spec.ts b/frontend/src/metabase/utils/card.unit.spec.tsdeleted file mode 100644index d6cc5bed920..00000000000--- a/frontend/src/metabase/utils/card.unit.spec.ts+++ /dev/null@@ -1,108 +0,0 @@-import {- deserializeCardFromUrl,- serializeCardForUrl,-} from "metabase/utils/card";-import {- b64_to_utf8,- b64url_to_utf8,- utf8_to_b64,- utf8_to_b64url,-} from "metabase/utils/encoding";-import type {- Card,- StructuredDatasetQuery,- UnsavedCard,- VisualizationDisplay,-} from "metabase-types/api";--const CARD_ID = 31;--// TODO Atte Keinänen 8/5/17: Create a reusable version `getCard` for reducing test code duplication-const getCard = ({- newCard = false,- hasOriginalCard = false,- isNative = false,- database = 1,- display = "table",- queryFields = {},- table,-}: {- newCard?: boolean;- hasOriginalCard?: boolean;- isNative?: boolean;- database?: number;- display?: VisualizationDisplay;- queryFields?: StructuredDatasetQuery["query"];- table?: number;-} = {}): Card | UnsavedCard => {- const savedCardFields = {- name: "Example Saved Question",- description: "For satisfying your craving for information",- created_at: "2017-04-20T16:52:55.353Z",- id: CARD_ID,- };-- const datasetQuery = isNative- ? {- database,- type: "native" as const,- native: { query: "SELECT * FROM ORDERS" },- }- : {- database,- type: "query" as const,- query: {- ...(table ? { "source-table": table } : {}),- ...queryFields,- },- };-- return {- name: null,- display,- visualization_settings: {},- dataset_query: datasetQuery,- ...(newCard ? {} : savedCardFields),- ...(hasOriginalCard ? { original_card_id: CARD_ID } : {}),- };-};--describe("lib/card", () => {- describe("utf8_to_b64", () => {- it("should encode with non-URL-safe characters", () => {- expect(utf8_to_b64(" ?").indexOf("/")).toEqual(3);- expect(utf8_to_b64(" ?")).toEqual("ICA/");- });- });-- describe("b64_to_utf8", () => {- it("should decode correctly", () => {- expect(b64_to_utf8("ICA/")).toEqual(" ?");- });- });-- describe("utf8_to_b64url", () => {- it("should encode with URL-safe characters", () => {- expect(utf8_to_b64url(" ?").indexOf("/")).toEqual(-1);- expect(utf8_to_b64url(" ?")).toEqual("ICA_");- });- });-- describe("b64url_to_utf8", () => {- it("should decode correctly", () => {- expect(b64url_to_utf8("ICA_")).toEqual(" ?");- });- });-- describe("serializeCardForUrl", () => {- it("should include `original_card_id` property to the serialized URL", () => {- const cardAfterSerialization = deserializeCardFromUrl(- serializeCardForUrl(getCard({ hasOriginalCard: true })),- );- expect(cardAfterSerialization).toHaveProperty(- "original_card_id",- CARD_ID,- );- });- });-});diff --git a/frontend/src/metabase/utils/urls/questions.ts b/frontend/src/metabase/utils/urls/questions.tsindex 276671319df..4e2d670ac1c 100644--- a/frontend/src/metabase/utils/urls/questions.ts+++ b/frontend/src/metabase/utils/urls/questions.ts@@ -1,6 +1,6 @@import slugg from "slugg";-import { serializeCardForUrl } from "metabase/utils/card";+import { serializeCardForUrl } from "metabase/common/utils/card";import MetabaseSettings from "metabase/utils/settings";import type { QuestionCreatorOpts } from "metabase-lib/v1/Question";import Question from "metabase-lib/v1/Question";diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.tsindex f147ea193d6..671b095b33d 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.ts@@ -1,6 +1,7 @@import { t } from "ttag";import _ from "underscore";+import { isNative } from "metabase/common/utils/card";import { formatPercent } from "metabase/static-viz/lib/numbers";import { NULL_DISPLAY_VALUE } from "metabase/utils/constants";import { formatChangeWithSign } from "metabase/utils/formatting";@@ -64,7 +65,6 @@ import type { ClickObject, ClickObjectDimension } from "metabase-lib";import * as Lib from "metabase-lib";import Question from "metabase-lib/v1/Question";import type Metadata from "metabase-lib/v1/metadata/Metadata";-import { isNative } from "metabase-lib/v1/queries/utils/card";import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";import { isDate } from "metabase-lib/v1/types/utils/isa";import type {diff --git a/frontend/src/metabase/visualizations/visualizations/Table/Table.tsx b/frontend/src/metabase/visualizations/visualizations/Table/Table.tsxindex 0654e81798e..69c0d94337e 100644--- a/frontend/src/metabase/visualizations/visualizations/Table/Table.tsx+++ b/frontend/src/metabase/visualizations/visualizations/Table/Table.tsx@@ -3,6 +3,7 @@ import { Component } from "react";import { t } from "ttag";import _ from "underscore";+import { isNative } from "metabase/common/utils/card";import CS from "metabase/css/core/index.css";import { displayNameForColumn } from "metabase/utils/formatting";import type { OptionsType } from "metabase/utils/formatting/types";@@ -29,7 +30,6 @@ import {} from "metabase/visualizations/shared/utils/sizes";import * as Lib from "metabase-lib";import Question from "metabase-lib/v1/Question";-import { isNative } from "metabase-lib/v1/queries/utils/card";import { findColumnIndexesForColumnSettings } from "metabase-lib/v1/queries/utils/dataset";import {isAvatarURL,diff --git a/frontend/test/metabase-lib/lib/Question.unit.spec.js b/frontend/test/metabase-lib/lib/Question.unit.spec.jsindex 213224af596..44d98d62428 100644--- a/frontend/test/metabase-lib/lib/Question.unit.spec.js+++ b/frontend/test/metabase-lib/lib/Question.unit.spec.js@@ -3,7 +3,7 @@ import { parse } from "url";import { assoc, dissoc } from "icepick";import { createMockMetadata } from "__support__/metadata";-import { deserializeCardFromUrl } from "metabase/utils/card";+import { deserializeCardFromUrl } from "metabase/common/utils/card";import * as Lib from "metabase-lib";import Question from "metabase-lib/v1/Question";import NativeQuery from "metabase-lib/v1/queries/NativeQuery";