Skip to content

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

Read the query's database from the API, not the entities mirror (#80267)

Romeo Van Snickebe7663ba384
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.tsx
index b9a768ff425..418596006ca 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
@@ -2,7 +2,10 @@ import userEvent from "@testing-library/user-event";
import { useState } from "react";
import { createMockMetadata } from "__support__/metadata";
-import { setupFieldValuesEndpoint } from "__support__/server-mocks";
+import {
+ setupDatabaseEndpoints,
+ setupFieldValuesEndpoint,
+} from "__support__/server-mocks";
import { renderWithProviders, screen, within } from "__support__/ui";
import { checkNotNull } from "metabase/utils/types";
import * as Lib from "metabase-lib";
@@ -34,6 +37,8 @@ function setup({
}: SetupOpts = {}) {
const onChange = jest.fn();
+ setupDatabaseEndpoints(createSampleDatabase());
+
if (fieldValues) {
setupFieldValuesEndpoint(fieldValues);
}
diff --git a/frontend/src/metabase/query_builder/components/view/sidebars/SummarizeSidebar/SummarizeSidebar.unit.spec.tsx b/frontend/src/metabase/query_builder/components/view/sidebars/SummarizeSidebar/SummarizeSidebar.unit.spec.tsx
index fd8fe4d5c95..a5b266d3433 100644
--- a/frontend/src/metabase/query_builder/components/view/sidebars/SummarizeSidebar/SummarizeSidebar.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/view/sidebars/SummarizeSidebar/SummarizeSidebar.unit.spec.tsx
@@ -1,6 +1,7 @@
import userEvent from "@testing-library/user-event";
import { useState } from "react";
+import { setupDatabaseEndpoints } from "__support__/server-mocks";
import { renderWithProviders, screen, waitFor, within } from "__support__/ui";
import {
createMockQueryBuilderState,
@@ -9,7 +10,10 @@ import {
import * as Lib from "metabase-lib";
import { DEFAULT_TEST_QUERY, SAMPLE_PROVIDER } from "metabase-lib/test-helpers";
import { createMockCard } from "metabase-types/api/mocks";
-import { ORDERS_ID } from "metabase-types/api/mocks/presets";
+import {
+ ORDERS_ID,
+ createSampleDatabase,
+} from "metabase-types/api/mocks/presets";
import { SummarizeSidebar } from "./SummarizeSidebar";
@@ -83,6 +87,8 @@ async function setup({
const onQueryChange = jest.fn();
const onClose = jest.fn();
+ setupDatabaseEndpoints(createSampleDatabase());
+
function Wrapper() {
const [query, setQuery] = useState(initialQuery);
diff --git a/frontend/src/metabase/querying/common/components/AggregationPicker/AggregationPicker.tsx b/frontend/src/metabase/querying/common/components/AggregationPicker/AggregationPicker.tsx
index d467b49d2e2..fb4d1a30755 100644
--- a/frontend/src/metabase/querying/common/components/AggregationPicker/AggregationPicker.tsx
+++ b/frontend/src/metabase/querying/common/components/AggregationPicker/AggregationPicker.tsx
@@ -8,6 +8,7 @@ import {
} from "react";
import { t } from "ttag";
+import { skipToken, useGetDatabaseQuery } from "metabase/api";
import {
AccordionList,
type Section as BaseSection,
@@ -32,8 +33,6 @@ import {
clausesForMode,
getClauseDefinition,
} from "metabase/querying/expressions";
-import { useSelector } from "metabase/redux";
-import { getMetadata } from "metabase/selectors/metadata";
import { Box, Flex, Icon, Text } from "metabase/ui";
import * as Lib from "metabase-lib";
@@ -105,7 +104,10 @@ export function AggregationPicker({
readOnly,
}: AggregationPickerProps) {
const tc = useTranslateContent();
- const metadata = useSelector(getMetadata);
+ const databaseId = Lib.databaseID(query);
+ const { data: database } = useGetDatabaseQuery(
+ databaseId != null ? { id: databaseId } : skipToken,
+ );
const displayInfo = clause
? Lib.displayInfo(query, stageIndex, clause)
: undefined;
@@ -172,8 +174,6 @@ export function AggregationPicker({
const sections: Section[] = [];
const measures = Lib.availableMeasures(query, stageIndex);
- const databaseId = Lib.databaseID(query);
- const database = metadata.database(databaseId);
const supportsCustomExpressions =
database != null && hasFeature(database, "expression-aggregations");
@@ -234,7 +234,7 @@ export function AggregationPicker({
return sections;
}, [
- metadata,
+ database,
query,
stageIndex,
clauseIndex,
diff --git a/frontend/src/metabase/querying/common/components/AggregationPicker/AggregationPicker.unit.spec.tsx b/frontend/src/metabase/querying/common/components/AggregationPicker/AggregationPicker.unit.spec.tsx
index 607ab9e8aeb..44bec76a9a7 100644
--- a/frontend/src/metabase/querying/common/components/AggregationPicker/AggregationPicker.unit.spec.tsx
+++ b/frontend/src/metabase/querying/common/components/AggregationPicker/AggregationPicker.unit.spec.tsx
@@ -2,8 +2,9 @@ import userEvent from "@testing-library/user-event";
import _ from "underscore";
import { createMockMetadata } from "__support__/metadata";
+import { setupDatabaseEndpoints } from "__support__/server-mocks";
import { createMockEntitiesState } from "__support__/store";
-import { renderWithProviders, screen } from "__support__/ui";
+import { renderWithProviders, screen, waitFor } from "__support__/ui";
import type { State } from "metabase/redux/store";
import {
createMockQueryBuilderState,
@@ -12,6 +13,7 @@ import {
import * as Lib from "metabase-lib";
import { DEFAULT_TEST_QUERY, SAMPLE_PROVIDER } from "metabase-lib/test-helpers";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { Database } from "metabase-types/api";
import {
COMMON_DATABASE_FEATURES,
createMockCard,
@@ -127,6 +129,7 @@ function createMetadata({
}
type SetupOpts = {
+ database?: Database;
state?: State;
metadata?: Metadata;
query?: Lib.Query;
@@ -134,18 +137,21 @@ type SetupOpts = {
};
function setup({
- state = createMockState({
- entities: createMockEntitiesState({
- databases: [createSampleDatabase()],
- }),
- qb: createMockQueryBuilderState({
- card: createMockCard(),
- }),
- }),
+ database = createSampleDatabase(),
+ state,
metadata = createMetadata(),
query = Lib.createTestQuery(SAMPLE_PROVIDER, DEFAULT_TEST_QUERY),
allowCustomExpressions,
}: SetupOpts = {}) {
+ setupDatabaseEndpoints(database);
+
+ const storeState =
+ state ??
+ createMockState({
+ entities: createMockEntitiesState({ databases: [database] }),
+ qb: createMockQueryBuilderState({ card: createMockCard() }),
+ });
+
const stageIndex = 0;
const clause = Lib.aggregations(query, stageIndex)[0];
@@ -165,7 +171,7 @@ function setup({
allowCustomExpressions={allowCustomExpressions}
onQueryChange={onQueryChange}
/>,
- { storeInitialState: state },
+ { storeInitialState: storeState },
);
function getRecentClause(index: number = -1): Lib.Clause | undefined {
@@ -343,7 +349,7 @@ describe("AggregationPicker", () => {
const expression = "count() + 1";
const expressionName = "My expression";
- await userEvent.click(screen.getByText("Custom Expression"));
+ await userEvent.click(await screen.findByText("Custom Expression"));
await userEvent.type(
await screen.findByTestId("custom-expression-query-editor"),
expression,
@@ -359,7 +365,7 @@ describe("AggregationPicker", () => {
it("should open the editor when a named expression without operator is used", async () => {
setup({ query: createQueryWithInlineExpression() });
- expect(screen.getByText("Custom Expression")).toBeInTheDocument();
+ expect(await screen.findByText("Custom Expression")).toBeInTheDocument();
expect(screen.getByDisplayValue("Avg Q")).toBeInTheDocument();
});
@@ -370,27 +376,20 @@ describe("AggregationPicker", () => {
expect(screen.getByDisplayValue("My count")).toBeInTheDocument();
});
- it("shouldn't be available if database doesn't support custom expressions", () => {
+ it("shouldn't be available if database doesn't support custom expressions", async () => {
setup({
- state: createMockState({
- entities: createMockEntitiesState({
- databases: [
- {
- ...createSampleDatabase(),
- features: _.without(
- COMMON_DATABASE_FEATURES,
- "expression-aggregations",
- ),
- },
- ],
- }),
- qb: createMockQueryBuilderState({
- card: createMockCard(),
- }),
+ database: createSampleDatabase({
+ features: _.without(
+ COMMON_DATABASE_FEATURES,
+ "expression-aggregations",
+ ),
}),
metadata: createMetadata({ allowCustomExpressions: false }),
});
- expect(screen.queryByText("Custom Expression")).not.toBeInTheDocument();
+
+ await waitFor(() =>
+ expect(screen.queryByText("Custom Expression")).not.toBeInTheDocument(),
+ );
});
it("shouldn't be shown if `allowCustomExpressions` prop is false", () => {
diff --git a/frontend/src/metabase/querying/components/expressions/FunctionBrowser/FunctionBrowser.tsx b/frontend/src/metabase/querying/components/expressions/FunctionBrowser/FunctionBrowser.tsx
index 4b2bd2a2237..3bc075bf9e2 100644
--- a/frontend/src/metabase/querying/components/expressions/FunctionBrowser/FunctionBrowser.tsx
+++ b/frontend/src/metabase/querying/components/expressions/FunctionBrowser/FunctionBrowser.tsx
@@ -9,18 +9,17 @@ import {
} from "react";
import { t } from "ttag";
+import { skipToken, useGetDatabaseQuery } from "metabase/api";
import { EmptyState } from "metabase/common/components/EmptyState";
import { Markdown } from "metabase/common/components/Markdown";
import type { HelpText } from "metabase/querying/expressions";
-import { useSelector } from "metabase/redux";
-import { getMetadata } from "metabase/selectors/metadata";
import { Box, Flex, Icon, Input, Text } from "metabase/ui";
-import type * as Lib from "metabase-lib";
+import * as Lib from "metabase-lib";
import { HighlightExpressionSource } from "../HighlightExpression";
import S from "./FunctionBrowser.module.css";
-import { getDatabase, getFilteredClauses, getSearchPlaceholder } from "./utils";
+import { getFilteredClauses, getSearchPlaceholder } from "./utils";
const components = {
code(props: { children: ReactNode }) {
@@ -46,8 +45,10 @@ export function FunctionBrowser({
reportTimezone?: string;
onClauseClick?: (name: string) => void;
}) {
- const metadata = useSelector(getMetadata);
- const database = getDatabase(query, metadata);
+ const databaseId = Lib.databaseID(query);
+ const { data: database, isLoading } = useGetDatabaseQuery(
+ databaseId != null ? { id: databaseId } : skipToken,
+ );
const [filter, setFilter] = useState("");
const handleFilterChange = useCallback(
@@ -61,7 +62,9 @@ export function FunctionBrowser({
[filter, expressionMode, database, reportTimezone],
);
- const isEmpty = filteredClauses.length === 0;
+ // Until the database answers, the clause list is empty because no feature is
+ // known yet. Saying "no results" then would be false, so hold the message.
+ const isEmpty = !isLoading && filteredClauses.length === 0;
return (
<Flex
diff --git a/frontend/src/metabase/querying/components/expressions/FunctionBrowser/utils.ts b/frontend/src/metabase/querying/components/expressions/FunctionBrowser/utils.ts
index 842e96136d5..26029845324 100644
--- a/frontend/src/metabase/querying/components/expressions/FunctionBrowser/utils.ts
+++ b/frontend/src/metabase/querying/components/expressions/FunctionBrowser/utils.ts
@@ -6,9 +6,8 @@ import {
getSupportedClauses,
} from "metabase/querying/expressions";
import { isNotNull } from "metabase/utils/types";
-import * as Lib from "metabase-lib";
-import type Database from "metabase-lib/v1/metadata/Database";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type * as Lib from "metabase-lib";
+import type { Database } from "metabase-types/api";
export function getSearchPlaceholder(expressionMode: Lib.ExpressionMode) {
if (expressionMode === "expression" || expressionMode === "filter") {
@@ -46,7 +45,7 @@ export function getFilteredClauses({
}: {
expressionMode: Lib.ExpressionMode;
filter: string;
- database: Database | null;
+ database: Pick<Database, "engine" | "features"> | undefined;
reportTimezone?: string;
}) {
const filteredClauses = getSupportedClauses({ expressionMode, database })
@@ -78,8 +77,3 @@ export function getFilteredClauses({
function byName(a: HelpText, b: HelpText) {
return a.displayName.localeCompare(b.displayName);
}
-
-export function getDatabase(query: Lib.Query, metadata: Metadata) {
- const databaseId = Lib.databaseID(query);
- return metadata.database(databaseId);
-}
diff --git a/frontend/src/metabase/querying/expressions/clause.ts b/frontend/src/metabase/querying/expressions/clause.ts
index b2784845514..42a7cf19f8d 100644
--- a/frontend/src/metabase/querying/expressions/clause.ts
+++ b/frontend/src/metabase/querying/expressions/clause.ts
@@ -10,7 +10,7 @@ import {
type MBQLClauseFunctionConfig,
MBQL_CLAUSES,
} from "metabase-lib";
-import type Database from "metabase-lib/v1/metadata/Database";
+import type { Database } from "metabase-types/api";
export function isDefinedClause(name: string): name is Lib.DefinedClauseName {
return name in MBQL_CLAUSES;
@@ -85,7 +85,7 @@ export function getSupportedClauses({
database,
}: {
expressionMode: Lib.ExpressionMode;
- database?: Database | null;
+ database?: Pick<Database, "features"> | null;
}) {
return clausesForMode(expressionMode)
.filter(
diff --git a/frontend/src/metabase/querying/expressions/help-text.ts b/frontend/src/metabase/querying/expressions/help-text.ts
index 49f5a4bad4a..f216bfe1705 100644
--- a/frontend/src/metabase/querying/expressions/help-text.ts
+++ b/frontend/src/metabase/querying/expressions/help-text.ts
@@ -1,6 +1,6 @@
import { isNotNull } from "metabase/utils/types";
import type * as Lib from "metabase-lib";
-import type Database from "metabase-lib/v1/metadata/Database";
+import type { Database } from "metabase-types/api";
import { getClauseDefinition } from "./clause";
@@ -16,7 +16,7 @@ export type HelpText = {
export function getHelpText(
name: string,
- database: Database,
+ database: Pick<Database, "engine" | "features">,
reportTimezone?: string,
): HelpText | null {
const clause = getClauseDefinition(name);
diff --git a/frontend/src/metabase/querying/filters/components/FilterPicker/FilterPicker.unit.spec.tsx b/frontend/src/metabase/querying/filters/components/FilterPicker/FilterPicker.unit.spec.tsx
index 688d7562d90..c1f22a73625 100644
--- a/frontend/src/metabase/querying/filters/components/FilterPicker/FilterPicker.unit.spec.tsx
+++ b/frontend/src/metabase/querying/filters/components/FilterPicker/FilterPicker.unit.spec.tsx
@@ -1,6 +1,9 @@
import userEvent from "@testing-library/user-event";
-import { setupFieldsValuesEndpoints } from "__support__/server-mocks";
+import {
+ setupDatabaseEndpoints,
+ setupFieldsValuesEndpoints,
+} from "__support__/server-mocks";
import {
renderWithProviders,
screen,
@@ -13,6 +16,7 @@ import * as Lib from "metabase-lib";
import {
PRODUCT_CATEGORY_VALUES,
PRODUCT_VENDOR_VALUES,
+ createSampleDatabase,
} from "metabase-types/api/mocks/presets";
import { FilterPicker } from "./FilterPicker";
@@ -153,6 +157,7 @@ function setup({ query = createQuery(), filter }: SetupOpts = {}) {
const onSelect = jest.fn();
setupFieldsValuesEndpoints([PRODUCT_CATEGORY_VALUES, PRODUCT_VENDOR_VALUES]);
+ setupDatabaseEndpoints(createSampleDatabase());
renderWithProviders(
<FilterPicker
diff --git a/frontend/src/metabase/querying/filters/components/FilterPicker/FilterPickerBody/FilterPickerBody.unit.spec.tsx b/frontend/src/metabase/querying/filters/components/FilterPicker/FilterPickerBody/FilterPickerBody.unit.spec.tsx
index 2a816270067..6d547989aa9 100644
--- a/frontend/src/metabase/querying/filters/components/FilterPicker/FilterPickerBody/FilterPickerBody.unit.spec.tsx
+++ b/frontend/src/metabase/querying/filters/components/FilterPicker/FilterPickerBody/FilterPickerBody.unit.spec.tsx
@@ -1,4 +1,5 @@
import { createMockMetadata } from "__support__/metadata";
+import { setupDatabaseEndpoints } from "__support__/server-mocks";
import { renderWithProviders, screen } from "__support__/ui";
import { checkNotNull } from "metabase/utils/types";
import * as Lib from "metabase-lib";
@@ -115,6 +116,8 @@ function setup({
const onChange = jest.fn();
const onBack = jest.fn();
+ setupDatabaseEndpoints(DATABASE);
+
renderWithProviders(
<FilterPickerBody
query={query}
diff --git a/frontend/src/metabase/querying/filters/components/FilterPicker/StringFilterPicker/StringFilterPicker.tsx b/frontend/src/metabase/querying/filters/components/FilterPicker/StringFilterPicker/StringFilterPicker.tsx
index b295f46bcc2..425fc766932 100644
--- a/frontend/src/metabase/querying/filters/components/FilterPicker/StringFilterPicker/StringFilterPicker.tsx
+++ b/frontend/src/metabase/querying/filters/components/FilterPicker/StringFilterPicker/StringFilterPicker.tsx
@@ -2,10 +2,9 @@ import type { FormEvent } from "react";
import { useMemo } from "react";
import { t } from "ttag";
+import { skipToken, useGetDatabaseQuery } from "metabase/api";
import { MultiAutocompleteWithTranslation } from "metabase/common/components/MultiAutocomplete";
import { hasFeature } from "metabase/databases";
-import { useSelector } from "metabase/redux";
-import { getMetadata } from "metabase/selectors/metadata";
import { Box, Checkbox, Flex } from "metabase/ui";
import * as Lib from "metabase-lib";
@@ -37,12 +36,15 @@ export function StringFilterPicker({
[query, stageIndex, column],
);
- const metadata = useSelector(getMetadata);
- const database = metadata.database(Lib.databaseID(query));
+ const databaseId = Lib.databaseID(query);
+ const { data: database } = useGetDatabaseQuery(
+ databaseId != null ? { id: databaseId } : skipToken,
+ );
+ // An unknown database keeps the option available rather than hiding a
+ // control the database probably supports.
const supportsCaseSensitivity =
- (database != null &&
- hasFeature(database, "case-sensitivity-string-filter-options")) ||
- database == null;
+ database == null ||
+ hasFeature(database, "case-sensitivity-string-filter-options");
const {
type,
diff --git a/frontend/src/metabase/querying/filters/components/FilterPicker/StringFilterPicker/StringFilterPicker.unit.spec.tsx b/frontend/src/metabase/querying/filters/components/FilterPicker/StringFilterPicker/StringFilterPicker.unit.spec.tsx
index f599e151668..1203d596055 100644
--- a/frontend/src/metabase/querying/filters/components/FilterPicker/StringFilterPicker/StringFilterPicker.unit.spec.tsx
+++ b/frontend/src/metabase/querying/filters/components/FilterPicker/StringFilterPicker/StringFilterPicker.unit.spec.tsx
@@ -1,6 +1,7 @@
import userEvent from "@testing-library/user-event";
import {
+ setupDatabaseEndpoints,
setupFieldSearchValuesEndpoint,
setupFieldsValuesEndpoints,
} from "__support__/server-mocks";
@@ -62,6 +63,7 @@ function setup({
const onBack = jest.fn();
setupFieldsValuesEndpoints([PRODUCT_CATEGORY_VALUES, PRODUCT_VENDOR_VALUES]);
+ setupDatabaseEndpoints(database);
const state = createMockState({
entities: createMockEntitiesState({ databases: [database] }),
@@ -254,7 +256,11 @@ describe("StringFilterPicker", () => {
});
await setOperator("Contains");
- expect(screen.queryByLabelText("Case sensitive")).not.toBeInTheDocument();
+ await waitFor(() =>
+ expect(
+ screen.queryByLabelText("Case sensitive"),
+ ).not.toBeInTheDocument(),
+ );
});
it("should add a filter with multiple values", async () => {
diff --git a/frontend/src/metabase/querying/notebook/components/AggregateStep/AggregateStep.unit.spec.tsx b/frontend/src/metabase/querying/notebook/components/AggregateStep/AggregateStep.unit.spec.tsx
index 8eb08cbabcc..3abb9171b59 100644
--- a/frontend/src/metabase/querying/notebook/components/AggregateStep/AggregateStep.unit.spec.tsx
+++ b/frontend/src/metabase/querying/notebook/components/AggregateStep/AggregateStep.unit.spec.tsx
@@ -1,5 +1,6 @@
import userEvent from "@testing-library/user-event";
+import { setupDatabaseEndpoints } from "__support__/server-mocks";
import {
getIcon,
queryIcon,
@@ -13,7 +14,10 @@ import {
import * as Lib from "metabase-lib";
import { SAMPLE_PROVIDER } from "metabase-lib/test-helpers";
import { createMockCard } from "metabase-types/api/mocks";
-import { ORDERS_ID } from "metabase-types/api/mocks/presets";
+import {
+ ORDERS_ID,
+ createSampleDatabase,
+} from "metabase-types/api/mocks/presets";
import { DEFAULT_QUESTION, createMockNotebookStep } from "../../test-utils";
import type { NotebookStep } from "../../types";
@@ -47,6 +51,8 @@ interface SetupOpts {
function setup({ step = createMockNotebookStep() }: SetupOpts = {}) {
const updateQuery = jest.fn();
+ setupDatabaseEndpoints(createSampleDatabase());
+
renderWithProviders(
<AggregateStep
step={step}