Skip to content

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

UXW-2341 Add Caching tab for metrics in Data Studio (#66513)

Brad Andersonc8b6f7457850
diff --git a/e2e/support/helpers/e2e-data-studio-helpers.ts b/e2e/support/helpers/e2e-data-studio-helpers.ts
index de86e797915..fbc0a716d91 100644
--- a/e2e/support/helpers/e2e-data-studio-helpers.ts
+++ b/e2e/support/helpers/e2e-data-studio-helpers.ts
@@ -62,6 +62,7 @@ export const DataStudio = {
definitionTab: () => DataStudio.Metrics.header().findByText("Definition"),
dependenciesTab: () =>
DataStudio.Metrics.header().findByText("Dependencies"),
+ cachingTab: () => DataStudio.Metrics.header().findByText("Caching"),
},
Tables: {
overviewPage: () => cy.findByTestId("table-overview-page"),
diff --git a/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts b/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts
index d4c65d38a30..f34075a8658 100644
--- a/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts
@@ -345,4 +345,28 @@ describe("scenarios > data studio > library > metrics", () => {
.findByText("Trusted Orders Metric")
.should("not.exist");
});
+
+ describe("caching", () => {
+ it("should allow changing metric caching settings", () => {
+ cy.log("Navigate to Data Studio Library");
+ cy.visit("/data-studio/library");
+
+ cy.log("Click on the metric from the collection view");
+ H.DataStudio.Library.metricItem("Trusted Orders Metric").click();
+
+ cy.log("Navigate to caching tab");
+ H.DataStudio.Metrics.cachingTab().click();
+
+ cy.log("Change the setting and save");
+ cy.findByRole("radio", { name: /Use default/ }).should("be.checked");
+ cy.findByRole("radio", { name: /Duration/ }).click();
+ cy.findByRole("button", { name: "Save" }).click();
+ cy.findByRole("button", { name: /Saved/ }).should("exist");
+
+ cy.log("Navigate away and come back to verify the change is persisted");
+ H.DataStudio.Metrics.overviewTab().click();
+ H.DataStudio.Metrics.cachingTab().click();
+ cy.findByRole("radio", { name: /Duration/ }).should("be.checked");
+ });
+ });
});
diff --git a/enterprise/frontend/src/metabase-enterprise/caching/index.tsx b/enterprise/frontend/src/metabase-enterprise/caching/index.tsx
index d31912aa2f2..7fc6dbdc954 100644
--- a/enterprise/frontend/src/metabase-enterprise/caching/index.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/caching/index.tsx
@@ -1,4 +1,5 @@
import { PLUGIN_CACHING } from "metabase/plugins";
+import { MetricCachingPage } from "metabase-enterprise/data-studio/metrics/pages/MetricCachingPage";
import { hasPremiumFeature } from "metabase-enterprise/settings";
import { DashboardAndQuestionCachingTab } from "./components/DashboardAndQuestionCachingTab";
@@ -40,6 +41,7 @@ export function initializePlugin() {
PLUGIN_CACHING.StrategyEditorForQuestionsAndDashboards =
StrategyEditorForQuestionsAndDashboards;
PLUGIN_CACHING.getTabMetadata = getEnterprisePerformanceTabMetadata;
+ PLUGIN_CACHING.MetricCachingPage = MetricCachingPage;
}
if (hasPremiumFeature("cache_preemptive")) {
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/components/MetricHeader/MetricTabs/MetricTabs.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/components/MetricHeader/MetricTabs/MetricTabs.tsx
index 0c3e4b9bd33..2bd236cf4ff 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/components/MetricHeader/MetricTabs/MetricTabs.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/components/MetricHeader/MetricTabs/MetricTabs.tsx
@@ -2,13 +2,14 @@ import { t } from "ttag";
import { useSelector } from "metabase/lib/redux";
import * as Urls from "metabase/lib/urls";
-import { PLUGIN_DEPENDENCIES } from "metabase/plugins";
+import { PLUGIN_CACHING, PLUGIN_DEPENDENCIES } from "metabase/plugins";
import { getMetadata } from "metabase/selectors/metadata";
import {
type PaneHeaderTab,
PaneHeaderTabs,
} from "metabase-enterprise/data-studio/common/components/PaneHeader";
import * as Lib from "metabase-lib";
+import Question from "metabase-lib/v1/Question";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type { Card } from "metabase-types/api";
@@ -46,5 +47,16 @@ function getTabs(card: Card, metadata: Metadata): PaneHeaderTab[] {
});
}
+ const isCacheableQuestion =
+ PLUGIN_CACHING.isGranularCachingEnabled() &&
+ PLUGIN_CACHING.hasQuestionCacheSection(new Question(card));
+
+ if (isCacheableQuestion) {
+ tabs.push({
+ label: t`Caching`,
+ to: Urls.dataStudioMetricCaching(card.id),
+ });
+ }
+
return tabs;
}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/pages/MetricCachingPage/MetricCachingPage.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/pages/MetricCachingPage/MetricCachingPage.tsx
new file mode 100644
index 00000000000..6af21fc0e8b
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/pages/MetricCachingPage/MetricCachingPage.tsx
@@ -0,0 +1,89 @@
+import { useMemo } from "react";
+import { t } from "ttag";
+import _ from "underscore";
+
+import { StrategyForm } from "metabase/admin/performance/components/StrategyForm";
+import { useCacheConfigs } from "metabase/admin/performance/hooks/useCacheConfigs";
+import { useConfirmIfFormIsDirty } from "metabase/admin/performance/hooks/useConfirmIfFormIsDirty";
+import { useSaveStrategy } from "metabase/admin/performance/hooks/useSaveStrategy";
+import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
+import CS from "metabase/css/core/index.css";
+import * as Urls from "metabase/lib/urls";
+import type { MetricSettingsPageProps } from "metabase/plugins/oss/caching";
+import { Card, Center } from "metabase/ui";
+import { getItemName } from "metabase-enterprise/caching/components/utils";
+import { PageContainer } from "metabase-enterprise/data-studio/common/components/PageContainer";
+import { useLoadCardWithMetadata } from "metabase-enterprise/data-studio/common/hooks/use-load-card-with-metadata";
+import Question from "metabase-lib/v1/Question";
+import type { CacheableModel } from "metabase-types/api";
+
+import { MetricHeader } from "../../components/MetricHeader";
+
+const configurableModels: CacheableModel[] = ["question"];
+
+export function MetricCachingPage({ params }: MetricSettingsPageProps) {
+ const cardId = Urls.extractEntityId(params.cardId);
+ const {
+ card,
+ isLoading: isLoadingCard,
+ error: cardError,
+ } = useLoadCardWithMetadata(cardId);
+ const question = useMemo(() => card && new Question(card), [card]);
+
+ const {
+ configs,
+ setConfigs,
+ loading: isLoadingConfigs,
+ error: configsError,
+ } = useCacheConfigs({
+ configurableModels,
+ id: cardId,
+ });
+
+ const { savedStrategy, filteredConfigs } = useMemo(() => {
+ const targetConfig = _.findWhere(configs, { model_id: cardId });
+ const savedStrategy = targetConfig?.strategy;
+ const filteredConfigs = _.compact([targetConfig]);
+ return { savedStrategy, filteredConfigs };
+ }, [configs, cardId]);
+
+ const saveStrategy = useSaveStrategy(
+ cardId ?? null,
+ filteredConfigs,
+ setConfigs,
+ "question",
+ );
+
+ const { confirmationModal, setIsStrategyFormDirty } =
+ useConfirmIfFormIsDirty();
+
+ const isLoading = isLoadingCard || isLoadingConfigs;
+ const error = cardError || configsError;
+
+ return (
+ <PageContainer pos="relative" data-testid="metric-caching" gap="xl">
+ {card && <MetricHeader card={card} />}
+ {isLoading || error != null ? (
+ <Center h="100%">
+ <LoadingAndErrorWrapper loading={isLoading} error={error} />
+ </Center>
+ ) : question ? (
+ <Card withBorder flex={1} p={0}>
+ <StrategyForm
+ targetId={question.id()}
+ targetModel="question"
+ targetName={getItemName("question", question)}
+ setIsDirty={setIsStrategyFormDirty}
+ saveStrategy={saveStrategy}
+ savedStrategy={savedStrategy}
+ shouldAllowInvalidation
+ shouldShowName={false}
+ buttonLabels={{ save: t`Save`, discard: t`Cancel` }}
+ classNames={{ formBox: CS.pt4 }}
+ />
+ {confirmationModal}
+ </Card>
+ ) : null}
+ </PageContainer>
+ );
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/pages/MetricCachingPage/index.ts b/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/pages/MetricCachingPage/index.ts
new file mode 100644
index 00000000000..d0da7e1096b
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/pages/MetricCachingPage/index.ts
@@ -0,0 +1 @@
+export { MetricCachingPage } from "./MetricCachingPage";
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/routes.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/routes.tsx
index b682a4bb5ab..874382fb774 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/routes.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/metrics/routes.tsx
@@ -1,6 +1,6 @@
import { IndexRoute, Route } from "react-router";
-import { PLUGIN_DEPENDENCIES } from "metabase/plugins";
+import { PLUGIN_CACHING, PLUGIN_DEPENDENCIES } from "metabase/plugins";
import { MetricDependenciesPage } from "./pages/MetricDependenciesPage";
import { MetricOverviewPage } from "./pages/MetricOverviewPage";
@@ -18,6 +18,12 @@ export function getDataStudioMetricRoutes() {
<IndexRoute component={PLUGIN_DEPENDENCIES.DependencyGraphPage} />
</Route>
)}
+ {PLUGIN_CACHING.isGranularCachingEnabled() && (
+ <Route
+ path=":cardId/caching"
+ component={PLUGIN_CACHING.MetricCachingPage}
+ />
+ )}
</Route>
);
}
diff --git a/frontend/src/metabase/admin/performance/components/StrategyForm.tsx b/frontend/src/metabase/admin/performance/components/StrategyForm.tsx
index da64fe95ad7..71835161e4e 100644
--- a/frontend/src/metabase/admin/performance/components/StrategyForm.tsx
+++ b/frontend/src/metabase/admin/performance/components/StrategyForm.tsx
@@ -73,6 +73,7 @@ export const StrategyForm = ({
shouldShowName = true,
onReset,
isInSidebar = false,
+ classNames,
buttonLabels = isInSidebar
? {
save: t`Save`,
@@ -94,6 +95,7 @@ export const StrategyForm = ({
onReset?: () => void;
buttonLabels?: ButtonLabels;
isInSidebar?: boolean;
+ classNames?: { formBox?: string };
}) => {
const defaultStrategy: CacheStrategy = useMemo(
() => ({
@@ -123,6 +125,7 @@ export const StrategyForm = ({
buttonLabels={buttonLabels}
isInSidebar={isInSidebar}
strategyType={initialValues.type}
+ classNames={classNames}
/>
</FormProvider>
);
@@ -163,6 +166,7 @@ const StrategyFormBody = ({
shouldShowName = true,
buttonLabels,
isInSidebar,
+ classNames,
}: {
targetId: number | null;
targetModel: CacheableModel;
@@ -173,6 +177,7 @@ const StrategyFormBody = ({
shouldShowName?: boolean;
buttonLabels: ButtonLabels;
isInSidebar?: boolean;
+ classNames?: { formBox?: string };
}) => {
const { values, initialValues, setFieldValue } =
useFormikContext<CacheStrategy>();
@@ -229,7 +234,7 @@ const StrategyFormBody = ({
data-testid={`strategy-form-for-${targetModel}-${targetId}`}
>
<Box
- className={cx(Styles.FormBox, {
+ className={cx(Styles.FormBox, classNames?.formBox, {
[Styles.FormBoxSidebar]: isInSidebar,
})}
>
diff --git a/frontend/src/metabase/lib/urls/data-studio.ts b/frontend/src/metabase/lib/urls/data-studio.ts
index e9967e77105..45ad7fac448 100644
--- a/frontend/src/metabase/lib/urls/data-studio.ts
+++ b/frontend/src/metabase/lib/urls/data-studio.ts
@@ -281,6 +281,10 @@ export function dataStudioMetricDependencies(cardId: CardId) {
return `${dataStudioMetric(cardId)}/dependencies`;
}
+export function dataStudioMetricCaching(cardId: CardId) {
+ return `${dataStudioMetric(cardId)}/caching`;
+}
+
export function dataStudioGlossary() {
return `${dataStudio()}/glossary`;
}
diff --git a/frontend/src/metabase/plugins/oss/caching.ts b/frontend/src/metabase/plugins/oss/caching.ts
index 148dd7a7efa..52dc4163810 100644
--- a/frontend/src/metabase/plugins/oss/caching.ts
+++ b/frontend/src/metabase/plugins/oss/caching.ts
@@ -37,6 +37,10 @@ export type PreemptiveCachingSwitchProps = {
handleSwitchToggle: () => void;
};
+export type MetricSettingsPageProps = {
+ params: { cardId: string };
+};
+
const getDefaultPluginCaching = () => ({
isGranularCachingEnabled: () => false,
StrategyFormLauncherPanel: PluginPlaceholder as any,
@@ -54,6 +58,8 @@ const getDefaultPluginCaching = () => ({
getTabMetadata: getPerformanceTabMetadata,
PreemptiveCachingSwitch:
PluginPlaceholder as ComponentType<PreemptiveCachingSwitchProps>,
+ MetricCachingPage:
+ PluginPlaceholder as ComponentType<MetricSettingsPageProps>,
});
export const PLUGIN_CACHING = getDefaultPluginCaching();