Skip to content

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

Make getMetadata private to the metadata store (#82551)

Romeo Van Snick0a441968d1b5
diff --git a/frontend/src/metabase/common/components/MetadataInfo/QueryColumnFingerprintInfo/QueryColumnFingerprintInfo.unit.spec.tsx b/frontend/src/metabase/common/components/MetadataInfo/QueryColumnFingerprintInfo/QueryColumnFingerprintInfo.unit.spec.tsx
index 543105d8aad..7a529474764 100644
--- a/frontend/src/metabase/common/components/MetadataInfo/QueryColumnFingerprintInfo/QueryColumnFingerprintInfo.unit.spec.tsx
+++ b/frontend/src/metabase/common/components/MetadataInfo/QueryColumnFingerprintInfo/QueryColumnFingerprintInfo.unit.spec.tsx
@@ -1,4 +1,7 @@
-import { createMockMetadata } from "__support__/metadata";
+import {
+ createMockMetadata,
+ createMockMetadataFromState,
+} from "__support__/metadata";
import {
setupFieldEndpoints,
setupFieldValuesEndpoint,
@@ -7,7 +10,6 @@ import {
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen, waitFor } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { checkNotNull } from "metabase/utils/types";
import * as Lib from "metabase-lib";
import { columnFinder } from "metabase-lib/test-helpers";
@@ -90,7 +92,10 @@ const setup = ({ columnName, fingerprint, timezone }: SetupOpts) => {
entities: createMockEntitiesState({ databases: [database] }),
});
- const provider = Lib.metadataProvider(SAMPLE_DB_ID, getMetadata(state));
+ const provider = Lib.metadataProvider(
+ SAMPLE_DB_ID,
+ createMockMetadataFromState(state),
+ );
const tableMetadata = Lib.tableOrCardMetadata(provider, PRODUCTS_ID);
const query = Lib.queryFromTableOrCardMetadata(
provider,
diff --git a/frontend/src/metabase/common/components/MetadataInfo/SemanticTypeLabel/SemanticTypeLabel.unit.spec.tsx b/frontend/src/metabase/common/components/MetadataInfo/SemanticTypeLabel/SemanticTypeLabel.unit.spec.tsx
index 3e4175f1f5f..5f15c2e0d42 100644
--- a/frontend/src/metabase/common/components/MetadataInfo/SemanticTypeLabel/SemanticTypeLabel.unit.spec.tsx
+++ b/frontend/src/metabase/common/components/MetadataInfo/SemanticTypeLabel/SemanticTypeLabel.unit.spec.tsx
@@ -1,7 +1,7 @@
+import { createMockMetadataFromState } from "__support__/metadata";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { getIcon, renderWithProviders, screen } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import {
ORDERS,
PRODUCTS,
@@ -15,7 +15,7 @@ const state = createMockState({
databases: [createSampleDatabase()],
}),
});
-const metadata = getMetadata(state);
+const metadata = createMockMetadataFromState(state);
function setup(semanticType: string | null | undefined) {
return renderWithProviders(<SemanticTypeLabel semanticType={semanticType} />);
diff --git a/frontend/src/metabase/common/components/MetadataInfo/TableInfo/ConnectedTables.unit.spec.tsx b/frontend/src/metabase/common/components/MetadataInfo/TableInfo/ConnectedTables.unit.spec.tsx
index a30ac2c20d4..c97f3cb86a3 100644
--- a/frontend/src/metabase/common/components/MetadataInfo/TableInfo/ConnectedTables.unit.spec.tsx
+++ b/frontend/src/metabase/common/components/MetadataInfo/TableInfo/ConnectedTables.unit.spec.tsx
@@ -1,7 +1,7 @@
+import { createMockMetadataFromState } from "__support__/metadata";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import * as Urls from "metabase/urls";
import { checkNotNull } from "metabase/utils/types";
import { createMockTable } from "metabase-types/api/mocks";
@@ -62,7 +62,7 @@ describe("ConnectedTables", () => {
it("should link each table to a new question on it", () => {
const { state } = setup({ tables: [createProductsTable()] });
const newQuestion = checkNotNull(
- getMetadata(state).table(PRODUCTS_ID),
+ createMockMetadataFromState(state).table(PRODUCTS_ID),
).newQuestion();
expect(screen.getByRole("link", { name: /Products/ })).toHaveAttribute(
diff --git a/frontend/src/metabase/common/components/MetadataInfo/TableLabel/TableLabel.unit.spec.tsx b/frontend/src/metabase/common/components/MetadataInfo/TableLabel/TableLabel.unit.spec.tsx
index c58ad8d4d0e..7d485972f43 100644
--- a/frontend/src/metabase/common/components/MetadataInfo/TableLabel/TableLabel.unit.spec.tsx
+++ b/frontend/src/metabase/common/components/MetadataInfo/TableLabel/TableLabel.unit.spec.tsx
@@ -1,7 +1,7 @@
+import { createMockMetadataFromState } from "__support__/metadata";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { checkNotNull } from "metabase/utils/types";
import type { Table } from "metabase-types/api";
import { createMockTable } from "metabase-types/api/mocks";
@@ -19,7 +19,7 @@ const setup = ({ table }: SetupOpts) => {
}),
});
- const metadata = getMetadata(state);
+ const metadata = createMockMetadataFromState(state);
renderWithProviders(
<TableLabel table={checkNotNull(metadata.table(table.id))} />,
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardMenu/DashCardMenu.unit.spec.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardMenu/DashCardMenu.unit.spec.tsx
index 1ca8560527e..2b8928689bf 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardMenu/DashCardMenu.unit.spec.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardMenu/DashCardMenu.unit.spec.tsx
@@ -1,5 +1,6 @@
import userEvent from "@testing-library/user-event";
+import { createMockMetadataFromState } from "__support__/metadata";
import {
setupCardQueryDownloadEndpoint,
setupLastDownloadFormatEndpoints,
@@ -12,7 +13,6 @@ import {
import { createMockEntitiesState } from "__support__/store";
import { getIcon, renderWithProviders, screen } from "__support__/ui";
import { MockDashboardContext } from "metabase/dashboard/context/mock-context";
-import { getMetadata } from "metabase/metadata-store";
import { Route } from "metabase/router";
import { checkNotNull } from "metabase/utils/types";
import type { Card, Dataset } from "metabase-types/api";
@@ -133,7 +133,7 @@ const setup = ({
}),
});
- const metadata = getMetadata(storeInitialState);
+ const metadata = createMockMetadataFromState(storeInitialState);
const question = checkNotNull(metadata.question(card.id));
const dashcard = createMockDashboardCard({
...card,
@@ -329,7 +329,7 @@ describe("DashCardMenu", () => {
describe("DashCardMenu.shouldRender", () => {
const dashboard = createMockDashboard();
- const metadata = getMetadata(
+ const metadata = createMockMetadataFromState(
createMockState({
entities: createMockEntitiesState({
databases: [createSampleDatabase()],
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.unit.spec.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.unit.spec.tsx
index 040606893cf..eea8791f9a5 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.unit.spec.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.unit.spec.tsx
@@ -1,5 +1,6 @@
import userEvent from "@testing-library/user-event";
+import { createMockMetadataFromState } from "__support__/metadata";
import { setupMetricDimensionsEndpoints } from "__support__/server-mocks";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
@@ -9,7 +10,6 @@ import {
renderWithProviders,
screen,
} from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import type { ParameterMappingOption } from "metabase/parameters/utils/mapping-options";
import Question from "metabase-lib/v1/Question";
import type { Card, VirtualCard } from "metabase-types/api";
@@ -42,7 +42,7 @@ const state = createMockState({
}),
});
-const metadata = getMetadata(state); // metabase-lib Metadata instance
+const metadata = createMockMetadataFromState(state); // metabase-lib Metadata instance
type MapperProps = React.ComponentProps<typeof DashCardCardParameterMapper>;
type SetupOptions = Partial<MapperProps>;
diff --git a/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.unit.spec.tsx b/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.unit.spec.tsx
index 68779939d60..1cab73476c9 100644
--- a/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.unit.spec.tsx
@@ -3,6 +3,7 @@ jest.unmock("@uiw/react-codemirror");
import userEvent from "@testing-library/user-event";
import { setupEnterprisePlugins } from "__support__/enterprise";
+import { createMockMetadataFromState } from "__support__/metadata";
import {
setupCollectionsEndpoints,
setupNativeQuerySnippetEndpoints,
@@ -13,7 +14,6 @@ import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen, waitFor } from "__support__/ui";
import { MetabotProvider } from "metabase/metabot/context";
-import { getMetadata } from "metabase/metadata-store";
import { NativeQueryEditor } from "metabase/querying/components/NativeQueryEditor/NativeQueryEditor";
import { NATIVE_EDITOR_ICON_SIZE } from "metabase/querying/components/NativeQueryEditor/NativeQueryEditorActionButtons/NativeQueryEditorActionButtons";
import { checkNotNull } from "metabase/utils/types";
@@ -94,7 +94,9 @@ function setup({ isMetabotEnabled = true } = {}) {
questions: [TEST_CARD],
}),
});
- const question = checkNotNull(getMetadata(state).question(TEST_CARD.id));
+ const question = checkNotNull(
+ createMockMetadataFromState(state).question(TEST_CARD.id),
+ );
renderWithProviders(
<MetabotProvider>
diff --git a/frontend/src/metabase/metabot/tests/query-builder-code-edit.unit.spec.tsx b/frontend/src/metabase/metabot/tests/query-builder-code-edit.unit.spec.tsx
index ef4ab4c7ce1..838e2f1ba0a 100644
--- a/frontend/src/metabase/metabot/tests/query-builder-code-edit.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/tests/query-builder-code-edit.unit.spec.tsx
@@ -4,6 +4,7 @@ import fetchMock from "fetch-mock";
import { assocIn } from "icepick";
import { setupEnterprisePlugins } from "__support__/enterprise";
+import { createMockMetadataFromState } from "__support__/metadata";
import { mockSettings } from "__support__/settings";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
@@ -15,7 +16,6 @@ import {
import { Messages } from "metabase/metabot/components/MetabotChat/MetabotChatMessage";
import { useInlineSQLPrompt } from "metabase/metabot/components/MetabotInlineSQLPrompt";
import { useMetabotAgent } from "metabase/metabot/hooks";
-import { getMetadata } from "metabase/metadata-store";
import type { State } from "metabase/redux/store";
import { checkNotNull } from "metabase/utils/types";
import * as Lib from "metabase-lib";
@@ -150,7 +150,7 @@ describe("query builder code edits from omnibot", () => {
),
} as any);
- const metadata = getMetadata(storeInitialState);
+ const metadata = createMockMetadataFromState(storeInitialState);
const question = checkNotNull(metadata.question(TEST_NATIVE_CARD.id));
const { store } = renderWithProviders(
diff --git a/frontend/src/metabase/metadata-store/index.ts b/frontend/src/metabase/metadata-store/index.ts
index c39e497b417..b35047c5852 100644
--- a/frontend/src/metabase/metadata-store/index.ts
+++ b/frontend/src/metabase/metadata-store/index.ts
@@ -1,8 +1,5 @@
export {
getFieldRemappings,
- getMetadata,
- getMetadataUnfiltered,
- getMetadataWithHiddenTables,
getRemappedFieldValue,
getShallowDatabases,
getShallowDatabaseSchemas,
diff --git a/frontend/src/metabase/metadata-store/selectors.ts b/frontend/src/metabase/metadata-store/selectors.ts
index b4a007fe416..f19849b814d 100644
--- a/frontend/src/metabase/metadata-store/selectors.ts
+++ b/frontend/src/metabase/metadata-store/selectors.ts
@@ -390,13 +390,6 @@ const UNFILTERED_OPTS: MetadataSelectorOpts = {
export const getMetadataUnfiltered = (state: State) =>
getMetadata(state, UNFILTERED_OPTS);
-export const getMetadataWithHiddenTables = (
- state: State,
- props?: TableSelectorOpts,
-) => {
- return getMetadata(state, { ...props, includeHiddenTables: true });
-};
-
// Utils
function isNotNull<T>(value: T | null | undefined): value is T {
diff --git a/frontend/src/metabase/notifications/HasResultsAlertPrompt/HasResultsAlertPrompt.unit.spec.tsx b/frontend/src/metabase/notifications/HasResultsAlertPrompt/HasResultsAlertPrompt.unit.spec.tsx
index 01df2625004..263983b278c 100644
--- a/frontend/src/metabase/notifications/HasResultsAlertPrompt/HasResultsAlertPrompt.unit.spec.tsx
+++ b/frontend/src/metabase/notifications/HasResultsAlertPrompt/HasResultsAlertPrompt.unit.spec.tsx
@@ -1,5 +1,6 @@
import userEvent from "@testing-library/user-event";
+import { createMockMetadataFromState } from "__support__/metadata";
import {
setupNotificationChannelsEndpoints,
setupUserRecipientsEndpoint,
@@ -9,7 +10,6 @@ import { setupWebhookChannelsEndpoint } from "__support__/server-mocks/channel";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { checkNotNull } from "metabase/utils/types";
import type { Card } from "metabase-types/api";
import { createMockCard, createMockUser } from "metabase-types/api/mocks";
@@ -32,7 +32,7 @@ function setup(cardOpts: Partial<Card> = {}) {
}),
});
const question = checkNotNull(
- getMetadata(storeInitialState).question(card.id),
+ createMockMetadataFromState(storeInitialState).question(card.id),
);
renderWithProviders(<HasResultsAlertPrompt question={question} />, {
diff --git a/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.unit.spec.tsx b/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.unit.spec.tsx
index 563af8b6b47..84d30b4391f 100644
--- a/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.unit.spec.tsx
+++ b/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.unit.spec.tsx
@@ -2,6 +2,7 @@ import userEvent from "@testing-library/user-event";
import fetchMock from "fetch-mock";
import { setupEnterpriseOnlyPlugin } from "__support__/enterprise";
+import { createMockMetadataFromState } from "__support__/metadata";
import {
setupNotificationChannelsEndpoints,
setupUserRecipientsEndpoint,
@@ -12,7 +13,6 @@ import { mockSettings } from "__support__/settings";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen, waitFor, within } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { CreateOrEditQuestionAlertModal } from "metabase/notifications/modals";
import { checkNotNull } from "metabase/utils/types";
import type {
@@ -724,7 +724,7 @@ function setup({
});
const storeConfig = { storeInitialState };
- const metadata = getMetadata(storeInitialState);
+ const metadata = createMockMetadataFromState(storeInitialState);
// The modal takes `question` as a prop. In production it comes from the `getQuestion` selector
// which composes metrics and models into runnable ad-hoc questions.
// Matching that behavior here.
diff --git a/frontend/src/metabase/parameters/components/TagEditor/TagEditorParam.unit.spec.tsx b/frontend/src/metabase/parameters/components/TagEditor/TagEditorParam.unit.spec.tsx
index 537097225c5..d7364b7bafe 100644
--- a/frontend/src/metabase/parameters/components/TagEditor/TagEditorParam.unit.spec.tsx
+++ b/frontend/src/metabase/parameters/components/TagEditor/TagEditorParam.unit.spec.tsx
@@ -1,6 +1,7 @@
import userEvent from "@testing-library/user-event";
import fetchMock from "fetch-mock";
+import { createMockMetadataFromState } from "__support__/metadata";
import {
setupDatabasesEndpoints,
setupParameterValuesEndpoints,
@@ -12,7 +13,6 @@ import {
} from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen, waitFor } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { checkNotNull } from "metabase/utils/types";
import Question from "metabase-lib/v1/Question";
import { getTemplateTagParameter } from "metabase-lib/v1/parameters/utils/template-tags";
@@ -65,7 +65,7 @@ const setup = ({
}),
});
- const metadata = getMetadata(state);
+ const metadata = createMockMetadataFromState(state);
const databaseMetadata = checkNotNull(metadata.database(database.id));
diff --git a/frontend/src/metabase/parameters/components/TagEditor/TagEditorSidebar.unit.spec.tsx b/frontend/src/metabase/parameters/components/TagEditor/TagEditorSidebar.unit.spec.tsx
index a203a2f8083..4c827771ed8 100644
--- a/frontend/src/metabase/parameters/components/TagEditor/TagEditorSidebar.unit.spec.tsx
+++ b/frontend/src/metabase/parameters/components/TagEditor/TagEditorSidebar.unit.spec.tsx
@@ -1,3 +1,4 @@
+import { createMockMetadataFromState } from "__support__/metadata";
import {
setupDatabasesEndpoints,
setupParameterValuesEndpoints,
@@ -6,7 +7,6 @@ import {
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { checkNotNull } from "metabase/utils/types";
import Question from "metabase-lib/v1/Question";
import type { TemplateTag } from "metabase-types/api";
@@ -35,7 +35,7 @@ const setup = ({ query, templateTags = {} }: SetupOpts) => {
const state = createMockState({
entities: createMockEntitiesState({ databases: [database] }),
});
- const metadata = getMetadata(state);
+ const metadata = createMockMetadataFromState(state);
const question = new Question(card, metadata);
setupDatabasesEndpoints([database]);
diff --git a/frontend/src/metabase/parameters/components/TemplateTagsSidebar.unit.spec.tsx b/frontend/src/metabase/parameters/components/TemplateTagsSidebar.unit.spec.tsx
index c397a9e6515..08129f9a1c0 100644
--- a/frontend/src/metabase/parameters/components/TemplateTagsSidebar.unit.spec.tsx
+++ b/frontend/src/metabase/parameters/components/TemplateTagsSidebar.unit.spec.tsx
@@ -1,5 +1,6 @@
import userEvent from "@testing-library/user-event";
+import { createMockMetadataFromState } from "__support__/metadata";
import {
setupDatabasesEndpoints,
setupParameterValuesEndpoints,
@@ -8,7 +9,6 @@ import {
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import Question from "metabase-lib/v1/Question";
import {
createMockCard,
@@ -56,7 +56,7 @@ const setup = ({ canUseSampleDatabase }: SetupOpts = {}) => {
databases: [sampleDatabase, writableDatabase],
}),
});
- const metadata = getMetadata(state);
+ const metadata = createMockMetadataFromState(state);
const question = new Question(card, metadata);
setupDatabasesEndpoints([sampleDatabase, writableDatabase]);
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidget.unit.spec.tsx b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidget.unit.spec.tsx
index 0a34605a3a1..17e9591459b 100644
--- a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidget.unit.spec.tsx
+++ b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidget.unit.spec.tsx
@@ -1,5 +1,6 @@
import userEvent from "@testing-library/user-event";
+import { createMockMetadataFromState } from "__support__/metadata";
import {
setupParameterSearchValuesEndpoint,
setupParameterValuesEndpoints,
@@ -7,7 +8,6 @@ import {
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import type Field from "metabase-lib/v1/metadata/Field";
import { createMockUiParameter } from "metabase-lib/v1/parameters/mock";
import type { UiParameter } from "metabase-lib/v1/parameters/types";
@@ -66,7 +66,7 @@ function setup({
}),
});
- const metadata = getMetadata(storeInitialState);
+ const metadata = createMockMetadataFromState(storeInitialState);
const field = metadata.field(FIELD_ID);
const fieldsToUse = field ? [field] : fields;
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.ts
index 88ef5954168..cd53041f145 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
@@ -1,11 +1,11 @@
import fetchMock from "fetch-mock";
+import { createMockMetadataFromState } from "__support__/metadata";
import { createMockLocation, createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { databaseApi, snippetApi } from "metabase/api";
import * as rtkEndpointUtils from "metabase/api/utils/run-rtk-endpoint";
import * as CardLib from "metabase/common/utils/card";
-import { getMetadata } from "metabase/metadata-store";
import * as questionActions from "metabase/questions/actions";
import { setErrorPage } from "metabase/redux/app";
import * as sharedQB from "metabase/redux/query-builder";
@@ -82,7 +82,7 @@ async function baseSetup({
: user,
});
- const metadata = getMetadata(state);
+ const metadata = createMockMetadataFromState(state);
const getState = () => state;
// Pass actions through verbatim so callers that capture the result of
diff --git a/frontend/src/metabase/query_builder/actions/core/updateQuestion.unit.spec.ts b/frontend/src/metabase/query_builder/actions/core/updateQuestion.unit.spec.ts
index c7fc9893fc2..fc1fc5ffb53 100644
--- a/frontend/src/metabase/query_builder/actions/core/updateQuestion.unit.spec.ts
+++ b/frontend/src/metabase/query_builder/actions/core/updateQuestion.unit.spec.ts
@@ -1,10 +1,10 @@
+import { createMockMetadataFromState } from "__support__/metadata";
import {
createMockQueryBuilderState,
createMockQueryBuilderUIControlsState,
createMockState,
} from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
-import { getMetadata } from "metabase/metadata-store";
import * as questionActions from "metabase/questions/actions";
import type { QueryBuilderMode } from "metabase/redux/store";
import { checkNotNull } from "metabase/utils/types";
@@ -138,7 +138,9 @@ async function setup({
questions: cards,
});
- const metadata = getMetadata(createMockState({ entities: entitiesState }));
+ const metadata = createMockMetadataFromState(
+ createMockState({ entities: entitiesState }),
+ );
const ordersTable = createOrdersTable();
const ordersFields = ordersTable.fields ?? [];
const question = isSavedCard
diff --git a/frontend/src/metabase/query_builder/actions/url.unit.spec.ts b/frontend/src/metabase/query_builder/actions/url.unit.spec.ts
index 298b7008006..70d9ad96131 100644
--- a/frontend/src/metabase/query_builder/actions/url.unit.spec.ts
+++ b/frontend/src/metabase/query_builder/actions/url.unit.spec.ts
@@ -5,13 +5,13 @@
// on it. Complementary to router/navigate-contract.unit.spec.tsx, which pins the
// other side: how `navigate` drives the router.
+import { createMockMetadataFromState } from "__support__/metadata";
import {
createMockQueryBuilderState,
createMockQueryBuilderUIControlsState,
createMockState,
} from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
-import { getMetadata } from "metabase/metadata-store";
import {
type NavigateOptions,
type To,
@@ -49,7 +49,7 @@ function buildSavedQuestion(card: Card): Question {
databases: [createSampleDatabase()],
questions: [card],
});
- const metadata = getMetadata(createMockState({ entities }));
+ const metadata = createMockMetadataFromState(createMockState({ entities }));
return checkNotNull(metadata.question(card.id));
}
@@ -57,7 +57,7 @@ function buildPristineTableQuestion(): Question {
const entities = createMockEntitiesState({
databases: [createSampleDatabase()],
});
- const metadata = getMetadata(createMockState({ entities }));
+ const metadata = createMockMetadataFromState(createMockState({ entities }));
return checkNotNull(metadata.table(ORDERS_ID)).newQuestion();
}
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetQueryEditor.unit.spec.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetQueryEditor.unit.spec.tsx
index 2bca93a95fd..9ac6e2ace76 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetQueryEditor.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetQueryEditor.unit.spec.tsx
@@ -1,5 +1,6 @@
import _ from "underscore";
+import { createMockMetadataFromState } from "__support__/metadata";
import {
setupCollectionsEndpoints,
setupDatabasesEndpoints,
@@ -14,7 +15,6 @@ import {
waitFor,
waitForLoaderToBeRemoved,
} from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { checkNotNull } from "metabase/utils/types";
import type { Card } from "metabase-types/api";
import {
@@ -71,7 +71,7 @@ const setup = async ({
questions: [card],
}),
});
- const metadata = getMetadata(storeInitialState);
+ const metadata = createMockMetadataFromState(storeInitialState);
const question = checkNotNull(metadata.question(card.id));
const query = checkNotNull(question.legacyNativeQuery());
const onSetDatabaseId = jest.fn();
diff --git a/frontend/src/metabase/query_builder/components/QuestionDownloadPopover/QuestionDownloadPopover.unit.spec.tsx b/frontend/src/metabase/query_builder/components/QuestionDownloadPopover/QuestionDownloadPopover.unit.spec.tsx
index bd1a0316622..c0a01cb7a5c 100644
--- a/frontend/src/metabase/query_builder/components/QuestionDownloadPopover/QuestionDownloadPopover.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/QuestionDownloadPopover/QuestionDownloadPopover.unit.spec.tsx
@@ -1,5 +1,6 @@
import userEvent from "@testing-library/user-event";
+import { createMockMetadataFromState } from "__support__/metadata";
import {
setupCardQueryDownloadEndpoint,
setupLastDownloadFormatEndpoints,
@@ -7,7 +8,6 @@ import {
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { getIcon, renderWithProviders, screen } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { checkNotNull } from "metabase/utils/types";
import type { Card, Dataset } from "metabase-types/api";
import {
@@ -42,7 +42,7 @@ const setup = ({ card = TEST_CARD, result = TEST_RESULT }: SetupOpts = {}) => {
}),
});
- const metadata = getMetadata(state);
+ const metadata = createMockMetadataFromState(state);
const question = checkNotNull(metadata.question(card.id));
setupCardQueryDownloadEndpoint(card, "json");
diff --git a/frontend/src/metabase/query_builder/components/QuestionDownloadWidget/QuestionDownloadWidget.unit.spec.tsx b/frontend/src/metabase/query_builder/components/QuestionDownloadWidget/QuestionDownloadWidget.unit.spec.tsx
index 685aaf1dcaf..79edc8c179b 100644
--- a/frontend/src/metabase/query_builder/components/QuestionDownloadWidget/QuestionDownloadWidget.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/QuestionDownloadWidget/QuestionDownloadWidget.unit.spec.tsx
@@ -1,6 +1,7 @@
import userEvent from "@testing-library/user-event";
import fetchMock from "fetch-mock";
+import { createMockMetadataFromState } from "__support__/metadata";
import {
setupCardQueryDownloadEndpoint,
setupLastDownloadFormatEndpoints,
@@ -10,7 +11,6 @@ import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen, waitFor } from "__support__/ui";
import { QuestionDownloadWidget } from "metabase/common/components/QuestionDownloadWidget";
-import { getMetadata } from "metabase/metadata-store";
import { checkNotNull } from "metabase/utils/types";
import { registerVisualizations } from "metabase/visualizations/register";
import type { Card, Dataset } from "metabase-types/api";
@@ -54,7 +54,7 @@ const setup = ({
settings: mockSettings(settings),
});
- const metadata = getMetadata(state);
+ const metadata = createMockMetadataFromState(state);
const question = checkNotNull(metadata.question(card.id));
setupCardQueryDownloadEndpoint(card, "json");
diff --git a/frontend/src/metabase/query_builder/components/view/ViewHeader/ViewTitleHeader.unit.spec.tsx b/frontend/src/metabase/query_builder/components/view/ViewHeader/ViewTitleHeader.unit.spec.tsx
index 2c8484a73bb..f391ac06213 100644
--- a/frontend/src/metabase/query_builder/components/view/ViewHeader/ViewTitleHeader.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/view/ViewHeader/ViewTitleHeader.unit.spec.tsx
@@ -3,6 +3,7 @@ import fetchMock from "fetch-mock";
import type { ComponentProps } from "react";
import _ from "underscore";
+import { createMockMetadataFromState } from "__support__/metadata";
import {
setupListDatabaseSchemasEndpoint,
setupTableEndpoints,
@@ -11,7 +12,6 @@ import { setupGetUserKeyValueEndpoint } from "__support__/server-mocks/user-key-
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { fireEvent, renderWithProviders, screen } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { Route } from "metabase/router";
import MetabaseSettings from "metabase/utils/settings";
import { checkNotNull } from "metabase/utils/types";
@@ -184,7 +184,7 @@ function setup({
}),
});
- const metadata = getMetadata(storeInitialState);
+ const metadata = createMockMetadataFromState(storeInitialState);
const question =
"id" in card
? checkNotNull(metadata.question(card.id))
diff --git a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionActions.unit.spec.tsx b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionActions.unit.spec.tsx
index 76026febc1c..36bd94195ae 100644
--- a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionActions.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionActions.unit.spec.tsx
@@ -1,6 +1,7 @@
import userEvent from "@testing-library/user-event";
import fetchMock from "fetch-mock";
+import { createMockMetadataFromState } from "__support__/metadata";
import { setupCardsForTableEndpoint } from "__support__/server-mocks";
import { setupListNotificationEndpoints } from "__support__/server-mocks/notification";
import { setupGetUserKeyValueEndpoint } from "__support__/server-mocks/user-key-value";
@@ -17,7 +18,6 @@ import {
waitFor,
within,
} from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { MODAL_TYPES } from "metabase/querying/constants";
import type Question from "metabase-lib/v1/Question";
import type { Card } from "metabase-types/api";
@@ -92,7 +92,7 @@ function setup({
}),
});
- const metadata = getMetadata(state);
+ const metadata = createMockMetadataFromState(state);
// Unjustified type cast. FIXME
const question = metadata.question(card.id) as Question;
const onOpenModal = jest.fn();
diff --git a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/SavedQuestionLeftSide/ViewOnly.unit.spec.tsx b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/SavedQuestionLeftSide/ViewOnly.unit.spec.tsx
index 528e92e9081..6613a5fcb8e 100644
--- a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/SavedQuestionLeftSide/ViewOnly.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/SavedQuestionLeftSide/ViewOnly.unit.spec.tsx
@@ -1,9 +1,9 @@
import userEvent from "@testing-library/user-event";
+import { createMockMetadataFromState } from "__support__/metadata";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import * as Lib from "metabase-lib";
import { DEFAULT_TEST_QUERY, SAMPLE_PROVIDER } from "metabase-lib/test-helpers";
import Question from "metabase-lib/v1/Question";
@@ -45,7 +45,7 @@ function setup({
}),
});
- const metadata = getMetadata(storeInitialState);
+ const metadata = createMockMetadataFromState(storeInitialState);
const isSaved = card.id != null;
const question = isSaved
? metadata.question(card.id)
diff --git a/frontend/src/metabase/query_builder/components/view/sidebars/QuestionInfoSidebar/QuestionPublicLinkPopover/QuestionPublicLinkPopover.unit.spec.tsx b/frontend/src/metabase/query_builder/components/view/sidebars/QuestionInfoSidebar/QuestionPublicLinkPopover/QuestionPublicLinkPopover.unit.spec.tsx
index 1fb5335e121..4a505a71911 100644
--- a/frontend/src/metabase/query_builder/components/view/sidebars/QuestionInfoSidebar/QuestionPublicLinkPopover/QuestionPublicLinkPopover.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/view/sidebars/QuestionInfoSidebar/QuestionPublicLinkPopover/QuestionPublicLinkPopover.unit.spec.tsx
@@ -2,12 +2,12 @@ import userEvent from "@testing-library/user-event";
import fetchMock from "fetch-mock";
import { useState } from "react";
+import { createMockMetadataFromState } from "__support__/metadata";
import { setupCardPublicLinkEndpoints } from "__support__/server-mocks";
import { mockSettings } from "__support__/settings";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { checkNotNull } from "metabase/utils/types";
import type Question from "metabase-lib/v1/Question";
import { createMockCard, createMockUser } from "metabase-types/api/mocks";
@@ -65,7 +65,7 @@ const setup = async ({
}),
});
- const metadata = getMetadata(state);
+ const metadata = createMockMetadataFromState(state);
const question = checkNotNull(metadata.question(TEST_CARD_ID));
const onClose = jest.fn();
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabasePicker/DataSelectorDatabasePicker.unit.spec.tsx b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabasePicker/DataSelectorDatabasePicker.unit.spec.tsx
index 8666256c5ac..2b0bf878571 100644
--- a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabasePicker/DataSelectorDatabasePicker.unit.spec.tsx
+++ b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabasePicker/DataSelectorDatabasePicker.unit.spec.tsx
@@ -1,9 +1,9 @@
import userEvent from "@testing-library/user-event";
+import { createMockMetadataFromState } from "__support__/metadata";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { checkNotNull } from "metabase/utils/types";
import { createMockDatabase } from "metabase-types/api/mocks";
@@ -17,7 +17,7 @@ const setup = (mockDatabases = [TEST_DATABASE]) => {
databases: mockDatabases,
}),
});
- const metadata = getMetadata(state);
+ const metadata = createMockMetadataFromState(state);
const databases = mockDatabases.map((db) =>
checkNotNull(metadata.database(db.id)),
);
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.unit.spec.tsx b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.unit.spec.tsx
index 3b29fd4de75..d1ca66d555d 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.unit.spec.tsx
+++ b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.unit.spec.tsx
@@ -1,5 +1,6 @@
import userEvent from "@testing-library/user-event";
+import { createMockMetadataFromState } from "__support__/metadata";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import {
@@ -8,7 +9,6 @@ import {
screen,
within,
} from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { registerVisualizations } from "metabase/visualizations/register";
import { loadVisualizationComponents } from "metabase/viz-core";
import Question from "metabase-lib/v1/Question";
@@ -45,7 +45,7 @@ const state = createMockState({
databases: [createSampleDatabase()],
}),
});
-const metadata = getMetadata(state);
+const metadata = createMockMetadataFromState(state);
const setup = (props: Partial<QueryVisualizationProps> = {}) => {
const question = new Question(
diff --git a/frontend/src/metabase/querying/run-query.unit.spec.ts b/frontend/src/metabase/querying/run-query.unit.spec.ts
index b936e45fe78..fec1f60c954 100644
--- a/frontend/src/metabase/querying/run-query.unit.spec.ts
+++ b/frontend/src/metabase/querying/run-query.unit.spec.ts
@@ -1,10 +1,10 @@
import fetchMock from "fetch-mock";
import { getMainStore } from "__support__/entities-store";
+import { createMockMetadataFromState } from "__support__/metadata";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
import { waitFor } from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import Question from "metabase-lib/v1/Question";
import type {
Card,
@@ -41,7 +41,7 @@ function createMockMetadata(card?: Card) {
questions: card ? [card] : [],
}),
});
- return getMetadata(state);
+ return createMockMetadataFromState(state);
}
type DashboardAwareCard = Card & {
diff --git a/frontend/src/metabase/redux/tables.unit.spec.ts b/frontend/src/metabase/redux/tables.unit.spec.ts
index 3f1e24ba773..822aad93fb9 100644
--- a/frontend/src/metabase/redux/tables.unit.spec.ts
+++ b/frontend/src/metabase/redux/tables.unit.spec.ts
@@ -1,11 +1,11 @@
import fetchMock from "fetch-mock";
import { getMainStore } from "__support__/entities-store";
+import { createMockMetadataFromState } from "__support__/metadata";
import {
setupTableQueryMetadataEndpoint,
setupUnauthorizedFieldEndpoint,
} from "__support__/server-mocks";
-import { getMetadata } from "metabase/metadata-store";
import { createMockField, createMockTable } from "metabase-types/api/mocks";
import { fetchTableMetadataAndForeignKeys } from "./tables";
@@ -64,7 +64,7 @@ describe("fetchTableMetadataAndForeignKeys", () => {
fetchMock.callHistory.called(`path:/api/field/${FK_TARGET_FIELD_ID}`),
).toBe(true);
- const table = getMetadata(store.getState()).table(TABLE_ID);
+ const table = createMockMetadataFromState(store.getState()).table(TABLE_ID);
expect(table).toBeDefined();
});
@@ -85,6 +85,8 @@ describe("fetchTableMetadataAndForeignKeys", () => {
expect(
fetchMock.callHistory.called(`path:/api/field/${LINKED_FIELD_ID}`),
).toBe(false);
- expect(getMetadata(store.getState()).table(LINKED_TABLE_ID)).toBeDefined();
+ expect(
+ createMockMetadataFromState(store.getState()).table(LINKED_TABLE_ID),
+ ).toBeDefined();
});
});
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx
index 0096ab23ae4..91acfc2f574 100644
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx
@@ -1,3 +1,4 @@
+import { createMockMetadataFromState } from "__support__/metadata";
import { setupTableEndpoints } from "__support__/server-mocks";
import {
createMockQueryBuilderState,
@@ -10,7 +11,6 @@ import {
screen,
waitForLoaderToBeRemoved,
} from "__support__/ui";
-import { getMetadata } from "metabase/metadata-store";
import { checkNotNull } from "metabase/utils/types";
import { ObjectDetail } from "metabase/visualizations/components/ObjectDetail/ObjectDetail";
import type { ObjectDetailProps } from "metabase/visualizations/components/ObjectDetail/types";
@@ -49,7 +49,7 @@ async function setup(options?: Partial<ObjectDetailProps>) {
}),
qb: createMockQueryBuilderState({ card: MOCK_CARD }),
});
- const metadata = getMetadata(state);
+ const metadata = createMockMetadataFromState(state);
const question = checkNotNull(metadata.question(MOCK_CARD.id));
const table = checkNotNull(metadata.table(MOCK_TABLE.id));
diff --git a/frontend/test/__support__/metadata.ts b/frontend/test/__support__/metadata.ts
index d0268edce23..554a19fe703 100644
--- a/frontend/test/__support__/metadata.ts
+++ b/frontend/test/__support__/metadata.ts
@@ -1,6 +1,11 @@
import { createMockSettingsState, createMockState } from "__support__/state";
import type { MetadataSelectorOpts } from "metabase/metadata-store";
-import { getMetadata } from "metabase/metadata-store";
+// Reaches past the barrel on purpose. `getMetadata` is private to the module,
+// and this file is the only door left to it: the v1 `Question` still takes a
+// `Metadata` in its constructor, so specs that build one need this. See
+// DEV-3382.
+import { getMetadata } from "metabase/metadata-store/selectors";
+import type { State } from "metabase/redux/store";
import type { Settings } from "metabase-types/api";
import type { EntitiesStateOpts } from "./store";
@@ -18,3 +23,14 @@ export function createMockMetadata(
return getMetadata(state, metadataOpts);
}
+
+/**
+ * The v1 `Metadata` for a state a test has already built, for specs that
+ * render with that same state.
+ */
+export function createMockMetadataFromState(
+ state: State,
+ metadataOpts?: MetadataSelectorOpts,
+) {
+ return getMetadata(state, metadataOpts);
+}