Skip to content

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

Move `DashboardApi` to RTK hooks and update all callers (#75677)

Romeo Van Snickc3590b13b0bd
diff --git a/frontend/src/metabase-types/api/dashboard.ts b/frontend/src/metabase-types/api/dashboard.ts
index a9825a46dca..2b99ba40453 100644
--- a/frontend/src/metabase-types/api/dashboard.ts
+++ b/frontend/src/metabase-types/api/dashboard.ts
@@ -299,8 +299,20 @@ export type ListDashboardsResponse = Omit<
export type GetDashboardRequest = {
id: DashboardId;
ignore_error?: boolean;
+ dashboard_load_id?: string;
+};
+
+export type DashboardParameterValuesRequest = {
+ dashId?: DashboardId | EntityToken;
+ entityIdentifier?: EntityUuid | EntityToken | null;
+ paramId: ParameterId;
};
+export type SearchDashboardParameterValuesRequest =
+ DashboardParameterValuesRequest & {
+ query: string;
+ };
+
export type CreateDashboardRequest = {
name: string;
description?: string | null;
diff --git a/frontend/src/metabase/api/dashboard.ts b/frontend/src/metabase/api/dashboard.ts
index e0060d1f931..fb57518cdf1 100644
--- a/frontend/src/metabase/api/dashboard.ts
+++ b/frontend/src/metabase/api/dashboard.ts
@@ -6,6 +6,7 @@ import type {
Dashboard,
DashboardCardQueryRequest,
DashboardId,
+ DashboardParameterValuesRequest,
DashboardQueryMetadata,
Dataset,
FieldId,
@@ -20,7 +21,9 @@ import type {
ListCollectionItemsResponse,
ListDashboardsRequest,
ListDashboardsResponse,
+ ParameterValues,
SaveDashboardRequest,
+ SearchDashboardParameterValuesRequest,
UpdateDashboardPropertyRequest,
UpdateDashboardRequest,
} from "metabase-types/api";
@@ -76,9 +79,10 @@ export const dashboardApi = Api.injectEndpoints({
onQueryStarted: hydrateMetadataStore([DashboardSchema]),
}),
getDashboard: builder.query<Dashboard, GetDashboardRequest>({
- query: ({ id, ignore_error }) => ({
+ query: ({ id, ignore_error, ...params }) => ({
method: "GET",
url: `/api/dashboard/${id}`,
+ params,
noEvent: ignore_error,
}),
providesTags: (dashboard) =>
@@ -151,6 +155,30 @@ export const dashboardApi = Api.injectEndpoints({
providesTags: (_response, _error, { parameter_id }) =>
provideParameterValuesTags(parameter_id),
}),
+ getDashboardParameterValues: builder.query<
+ ParameterValues,
+ DashboardParameterValuesRequest
+ >({
+ query: (params) => ({
+ method: "GET",
+ url: "/api/dashboard/:dashId/params/:paramId/values",
+ params,
+ }),
+ providesTags: (_response, _error, { paramId }) =>
+ provideParameterValuesTags(paramId),
+ }),
+ searchDashboardParameterValues: builder.query<
+ ParameterValues,
+ SearchDashboardParameterValuesRequest
+ >({
+ query: (params) => ({
+ method: "GET",
+ url: "/api/dashboard/:dashId/params/:paramId/search/:query",
+ params,
+ }),
+ providesTags: (_response, _error, { paramId }) =>
+ provideParameterValuesTags(paramId),
+ }),
listDashboardItems: builder.query<
ListCollectionItemsResponse,
Omit<ListCollectionItemsRequest, "id"> & { id: DashboardId }
@@ -309,6 +337,8 @@ export const {
useListDashboardsQuery,
useListDashboardItemsQuery,
useGetRemappedDashboardParameterValueQuery,
+ useGetDashboardParameterValuesQuery,
+ useSearchDashboardParameterValuesQuery,
useGetValidDashboardFilterFieldsQuery,
useCreateDashboardMutation,
useUpdateDashboardMutation,
@@ -323,6 +353,8 @@ export const {
useUpdateDashboardEmbeddingParamsMutation,
endpoints: {
getDashboard,
+ getDashboardParameterValues,
+ searchDashboardParameterValues,
deleteDashboardPublicLink,
createDashboard,
createDashboardPublicLink,
diff --git a/frontend/src/metabase/api/utils/run-rtk-endpoint.ts b/frontend/src/metabase/api/utils/run-rtk-endpoint.ts
index 405a4fa6644..17b123f1cea 100644
--- a/frontend/src/metabase/api/utils/run-rtk-endpoint.ts
+++ b/frontend/src/metabase/api/utils/run-rtk-endpoint.ts
@@ -23,6 +23,10 @@ type RunRtkEndpointOptions = {
* the subscription. Use this when you need an endpoint's data inside a thunk
* or other non-component code path, where the `useFooQuery` hook isn't an
* option.
+ *
+ * Pass a `signal` to cancel the in-flight request: it's wired to RTK Query's
+ * `.abort()`, so aborts surface as the standard `DOMException` AbortError and
+ * callers can `isAbortError`-check them.
*/
export async function runRtkEndpoint(
request: unknown,
diff --git a/frontend/src/metabase/common/components/ErrorPages/utils.ts b/frontend/src/metabase/common/components/ErrorPages/utils.ts
index 6f6d5a0c95e..10d689bc0ed 100644
--- a/frontend/src/metabase/common/components/ErrorPages/utils.ts
+++ b/frontend/src/metabase/common/components/ErrorPages/utils.ts
@@ -1,8 +1,9 @@
import Bowser from "bowser";
-import { cardApi } from "metabase/api";
+import { cardApi, dashboardApi } from "metabase/api";
+import { runRtkEndpoint } from "metabase/api/utils/run-rtk-endpoint";
import type { DispatchFn } from "metabase/redux";
-import { CollectionsApi, DashboardApi } from "metabase/services";
+import { CollectionsApi } from "metabase/services";
import { b64url_to_utf8 } from "metabase/utils/encoding";
import type { ReportableEntityName } from "./types";
@@ -34,11 +35,15 @@ export const getEntityDetails = ({
return Promise.resolve("unable to decode ad-hoc question");
}
}
- return dispatch(cardApi.endpoints.getCard.initiate({ id }))
- .unwrap()
- .catch(nullOnCatch);
+ return runRtkEndpoint({ id }, dispatch, cardApi.endpoints.getCard).catch(
+ nullOnCatch,
+ );
case "dashboard":
- return DashboardApi.get({ id }).catch(nullOnCatch);
+ return runRtkEndpoint(
+ { id },
+ dispatch,
+ dashboardApi.endpoints.getDashboard,
+ ).catch(nullOnCatch);
case "collection":
return CollectionsApi.get({ id }).catch(nullOnCatch);
default:
diff --git a/frontend/src/metabase/dashboard/actions/actions.unit.spec.ts b/frontend/src/metabase/dashboard/actions/actions.unit.spec.ts
index eda4446b18c..d7d10928f10 100644
--- a/frontend/src/metabase/dashboard/actions/actions.unit.spec.ts
+++ b/frontend/src/metabase/dashboard/actions/actions.unit.spec.ts
@@ -6,7 +6,6 @@ import {
createMockState,
createMockStoreDashboard,
} from "metabase/redux/store/mocks";
-import { DashboardApi } from "metabase/services";
import {
createMockDashboard,
createMockDashboardCard,
@@ -30,9 +29,6 @@ import {
updateDashboardAndCards,
} from "./";
-DashboardApi.parameterSearch = jest.fn();
-DashboardApi.parameterValues = jest.fn();
-
describe("dashboard actions", () => {
let dispatch: jest.MockedFunction<Dispatch>;
let getState: GetState;
diff --git a/frontend/src/metabase/dashboard/actions/data-fetching.ts b/frontend/src/metabase/dashboard/actions/data-fetching.ts
index 2dff94e4499..693f4706916 100644
--- a/frontend/src/metabase/dashboard/actions/data-fetching.ts
+++ b/frontend/src/metabase/dashboard/actions/data-fetching.ts
@@ -41,7 +41,7 @@ import type { Dispatch, GetState } from "metabase/redux/store";
import { createAsyncThunk, createThunkAction } from "metabase/redux/utils";
import { FieldSchema } from "metabase/schema";
import { getMetadata } from "metabase/selectors/metadata";
-import { DashboardApi, EmbedApi, PublicApi } from "metabase/services";
+import { EmbedApi, PublicApi } from "metabase/services";
import {
getDashboardType,
isQuestionDashCard,
@@ -772,8 +772,10 @@ export const fetchDashboard = createAsyncThunk(
dashId = result.id = String(dashId);
} else {
const [response] = await Promise.all([
- DashboardApi.get(
- { dashId: dashId, dashboard_load_id: dashboardLoadId },
+ runRtkEndpoint(
+ { id: dashId, dashboard_load_id: dashboardLoadId },
+ dispatch,
+ dashboardApi.endpoints.getDashboard,
{ signal: fetchDashboardCancellation.signal },
),
runRtkEndpoint(
@@ -790,15 +792,24 @@ export const fetchDashboard = createAsyncThunk(
const isUsingCachedResults = entities != null;
if (!isUsingCachedResults) {
- // copy over any virtual cards from the dashcard to the underlying card/question
- result.dashcards.forEach((card: DashboardCard) => {
- if (card.visualization_settings?.virtual_card) {
- card.card = Object.assign(
- card.card || {},
- card.visualization_settings.virtual_card,
- );
- }
- });
+ // Copy over any virtual cards from the dashcard to the underlying
+ // card/question. The result can come straight from RTK Query, whose
+ // responses are deeply frozen, so build new objects rather than
+ // mutating in place.
+ result = {
+ ...result,
+ dashcards: result.dashcards.map((card: DashboardCard) =>
+ card.visualization_settings?.virtual_card
+ ? {
+ ...card,
+ card: {
+ ...(card.card ?? {}),
+ ...card.visualization_settings.virtual_card,
+ },
+ }
+ : card,
+ ),
+ };
}
if (result.param_fields) {
diff --git a/frontend/src/metabase/parameters/actions.ts b/frontend/src/metabase/parameters/actions.ts
index 3288be2bbf6..235998279ea 100644
--- a/frontend/src/metabase/parameters/actions.ts
+++ b/frontend/src/metabase/parameters/actions.ts
@@ -1,21 +1,22 @@
-import { cardApi } from "metabase/api";
+import { cardApi, dashboardApi } from "metabase/api";
import type {
CardParameterValuesRequest,
SearchCardParameterValuesRequest,
} from "metabase/api/card";
import type { DispatchFn } from "metabase/redux";
import type { GetState } from "metabase/redux/store";
-import { DashboardApi, ParameterApi } from "metabase/services";
+import { ParameterApi } from "metabase/services";
import { stableStringify } from "metabase/utils/objects";
import { getNonVirtualFields } from "metabase-lib/v1/parameters/utils/parameter-fields";
import { normalizeParameter } from "metabase-lib/v1/parameters/utils/parameter-values";
import type {
CardId,
DashboardId,
+ DashboardParameterValuesRequest,
FieldId,
Parameter,
- ParameterId,
ParameterValues,
+ SearchDashboardParameterValuesRequest,
} from "metabase-types/api";
import type { EntityToken, EntityUuid } from "metabase-types/api/entity";
@@ -104,12 +105,16 @@ export const fetchDashboardParameterValues =
query,
}: FetchDashboardParameterValuesOpts) =>
(dispatch: DispatchFn, getState: GetState) => {
- const request: DashboardParameterValuesRequest = {
+ const baseRequest: DashboardParameterValuesRequest = {
...(entityIdentifier ? { entityIdentifier } : { dashId: dashboardId }),
paramId: parameter.id,
- query,
...getFilteringParameterValuesMap(parameter, parameters),
};
+ const request:
+ | DashboardParameterValuesRequest
+ | SearchDashboardParameterValuesRequest = query
+ ? { ...baseRequest, query }
+ : baseRequest;
return fetchParameterValuesWithCache(
request,
@@ -165,24 +170,34 @@ const loadCardParameterValues = async (
}
};
-interface DashboardParameterValuesRequest {
- dashId?: DashboardId;
- entityIdentifier?: EntityUuid | EntityToken | null;
- paramId: ParameterId;
- query?: string;
-}
-
const loadDashboardParameterValues = async (
- request: DashboardParameterValuesRequest,
+ request:
+ | DashboardParameterValuesRequest
+ | SearchDashboardParameterValuesRequest,
+ dispatch: DispatchFn,
) => {
- const { values, has_more_values } = request.query
- ? await DashboardApi.parameterSearch(request)
- : await DashboardApi.parameterValues(request);
-
- return {
- values: values,
- has_more_values: request.query ? true : has_more_values,
- };
+ const isSearch = "query" in request && request.query;
+ // `fetchParameterValuesWithCache` already provides caching keyed on the full
+ // request; bypass RTK's own cache so a refetch actually hits the network.
+ const queryAction = dispatch(
+ isSearch
+ ? dashboardApi.endpoints.searchDashboardParameterValues.initiate(
+ request as SearchDashboardParameterValuesRequest,
+ { forceRefetch: true },
+ )
+ : dashboardApi.endpoints.getDashboardParameterValues.initiate(request, {
+ forceRefetch: true,
+ }),
+ );
+ try {
+ const { values, has_more_values } = await queryAction.unwrap();
+ return {
+ values,
+ has_more_values: isSearch ? true : has_more_values,
+ };
+ } finally {
+ queryAction.unsubscribe?.();
+ }
};
const fetchParameterValuesWithCache = async <T>(
diff --git a/frontend/src/metabase/query_builder/actions/core/parameterUtils.ts b/frontend/src/metabase/query_builder/actions/core/parameterUtils.ts
index 18ae296c5ab..3ab4bffbb55 100644
--- a/frontend/src/metabase/query_builder/actions/core/parameterUtils.ts
+++ b/frontend/src/metabase/query_builder/actions/core/parameterUtils.ts
@@ -1,3 +1,5 @@
+import { dashboardApi } from "metabase/api";
+import { runRtkEndpoint } from "metabase/api/utils/run-rtk-endpoint";
import {
cardIsEquivalent,
cardParametersAreEquivalent,
@@ -6,7 +8,6 @@ import { hasMatchingParameters } from "metabase/parameters/utils/dashboards";
import { getParameterValuesByIdFromQueryParams } from "metabase/parameters/utils/parameter-parsing";
import { setErrorPage } from "metabase/redux/app";
import type { Dispatch } from "metabase/redux/store";
-import { DashboardApi } from "metabase/services";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import { getCardUiParameters } from "metabase-lib/v1/parameters/utils/cards";
import type { Card, Parameter } from "metabase-types/api";
@@ -60,7 +61,11 @@ async function verifyMatchingDashcardAndParameters({
parameters: Parameter[];
}) {
try {
- const dashboard = await DashboardApi.get({ dashId: dashboardId });
+ const dashboard = await runRtkEndpoint(
+ { id: dashboardId },
+ dispatch,
+ dashboardApi.endpoints.getDashboard,
+ );
if (
!hasMatchingParameters({
dashboard,
diff --git a/frontend/src/metabase/services.js b/frontend/src/metabase/services.js
index 3f4efbf7f40..16df290a16d 100644
--- a/frontend/src/metabase/services.js
+++ b/frontend/src/metabase/services.js
@@ -11,13 +11,6 @@ export const StoreApi = {
tokenStatus: GET("/api/premium-features/token/status"),
};
-export const DashboardApi = {
- get: GET("/api/dashboard/:dashId"),
- parameterValues: GET("/api/dashboard/:dashId/params/:paramId/values"),
- parameterSearch: GET("/api/dashboard/:dashId/params/:paramId/search/:query"),
- validFilterFields: GET("/api/dashboard/params/valid-filter-fields"),
-};
-
export const CollectionsApi = {
get: GET("/api/collection/:id"),
graph: GET("/api/collection/graph"),