Skip to content

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

GDGT-2910: Rename Model caching log to Model persistence log (#78787)

Stas Gavrylovf3f72896b785
diff --git a/e2e/test/scenarios/monitor/tools/tools.cy.spec.ts b/e2e/test/scenarios/monitor/tools/tools.cy.spec.ts
index f41a54bdabe..d18a91af068 100644
--- a/e2e/test/scenarios/monitor/tools/tools.cy.spec.ts
+++ b/e2e/test/scenarios/monitor/tools/tools.cy.spec.ts
@@ -523,10 +523,10 @@ describe("monitor > tools", () => {
name: "Erroring questions",
}).should("be.visible");
- cy.log("We should be able to switch to the model caching page");
+ cy.log("We should be able to switch to the model persistence log page");
- cy.findByTestId("monitor-nav").findByText("Model caching log").click();
- cy.location("pathname").should("eq", "/monitor/model-caching");
+ cy.findByTestId("monitor-nav").findByText("Model persistence log").click();
+ cy.location("pathname").should("eq", "/monitor/model-persistence-log");
cy.log(
"Once the audit_app feature flag is gone, tools should display an upsell",
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.tsx b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.tsx
index a87226af62e..bf627df7af3 100644
--- a/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.tsx
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.tsx
@@ -41,7 +41,7 @@ function getActiveSection(pathname: string): MonitorSection | null {
.with(P.string.startsWith(Urls.monitorJobs()), () => "jobs")
.with(P.string.startsWith(Urls.monitorLogs()), () => "logs")
.with(
- P.string.startsWith(Urls.monitorModelCaching()),
+ P.string.startsWith(Urls.monitorModelPersistenceLog()),
() => "model-caching",
)
.otherwise(() => null);
@@ -140,9 +140,9 @@ export function MonitorLayout() {
onClick={() => trackMonitorSectionClicked("logs")}
/>
<AreaTab
- label={t`Model caching log`}
+ label={t`Model persistence log`}
icon="bolt"
- to={Urls.monitorModelCaching()}
+ to={Urls.monitorModelPersistenceLog()}
isSelected={activeSection === "model-caching"}
showLabel={isNavbarOpened}
onClick={() => trackMonitorSectionClicked("model-caching")}
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.unit.spec.tsx b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.unit.spec.tsx
index fdd0fd078c8..e39a792acb2 100644
--- a/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.unit.spec.tsx
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.unit.spec.tsx
@@ -146,7 +146,7 @@ describe("MonitorLayout", () => {
["Background tasks", Urls.monitorTasks()],
["Scheduled jobs", Urls.monitorJobs()],
["Application logs", Urls.monitorLogs()],
- ["Model caching log", Urls.monitorModelCaching()],
+ ["Model persistence log", Urls.monitorModelPersistenceLog()],
];
expectedTabs.forEach(([name, href]) => {
@@ -186,8 +186,8 @@ describe("MonitorLayout", () => {
section: "logs",
},
{
- label: "Model caching log",
- route: Urls.monitorModelCaching(),
+ label: "Model persistence log",
+ route: Urls.monitorModelPersistenceLog(),
section: "model-caching",
},
] as const;
@@ -246,7 +246,7 @@ describe("MonitorLayout", () => {
"Scheduled jobs",
"Application logs",
"Erroring questions",
- "Model caching log",
+ "Model persistence log",
"Alerts management",
].forEach((name) => {
expect(screen.queryByRole("link", { name })).not.toBeInTheDocument();
@@ -273,7 +273,7 @@ describe("MonitorLayout", () => {
"Background tasks",
"Scheduled jobs",
"Application logs",
- "Model caching log",
+ "Model persistence log",
].forEach((name) => {
expect(screen.getByRole("link", { name })).toBeInTheDocument();
});
diff --git a/frontend/src/metabase/monitor/routes.tsx b/frontend/src/metabase/monitor/routes.tsx
index ccc02dcb5ce..27641e6e4d6 100644
--- a/frontend/src/metabase/monitor/routes.tsx
+++ b/frontend/src/metabase/monitor/routes.tsx
@@ -9,9 +9,9 @@ import { JobInfoApp } from "metabase/monitor/tools/components/JobInfoApp";
import { LogLevelsModal } from "metabase/monitor/tools/components/LogLevelsModal";
import { Logs } from "metabase/monitor/tools/components/Logs";
import {
- ModelCachePage,
- ModelCacheRefreshJobModal,
-} from "metabase/monitor/tools/components/ModelCacheRefreshJobs";
+ ModelPersistenceLogJobModal,
+ ModelPersistenceLogPage,
+} from "metabase/monitor/tools/components/ModelPersistenceLogJobs";
import { MonitorUpsell } from "metabase/monitor/tools/components/MonitorUpsell";
import {
getNotificationsRoutes,
@@ -72,8 +72,11 @@ export function getMonitorRoutes() {
PLUGIN_MONITOR_TOOLS.COMPONENT || MonitorUpsell,
)}
/>
- <Route path="model-caching" element={<ModelCachePage />}>
- {modalRoute(":jobId", ModelCacheRefreshJobModal)}
+ <Route
+ path="model-persistence-log"
+ element={<ModelPersistenceLogPage />}
+ >
+ {modalRoute(":jobId", ModelPersistenceLogJobModal)}
</Route>
</Route>
@@ -137,11 +140,11 @@ export function getMonitorRedirects() {
/>
<Route
path="/admin/tools/model-caching"
- element={redirect(Urls.monitorModelCaching())}
+ element={redirect(Urls.monitorModelPersistenceLog())}
/>
<Route
path="/admin/tools/model-caching/*"
- element={redirect(`${Urls.monitorModelCaching()}/*`)}
+ element={redirect(`${Urls.monitorModelPersistenceLog()}/*`)}
/>
<Route
path="/admin/tools/notifications"
diff --git a/frontend/src/metabase/monitor/routes.unit.spec.tsx b/frontend/src/metabase/monitor/routes.unit.spec.tsx
index 77742e4c094..ad8028bf093 100644
--- a/frontend/src/metabase/monitor/routes.unit.spec.tsx
+++ b/frontend/src/metabase/monitor/routes.unit.spec.tsx
@@ -81,11 +81,13 @@ jest.mock("metabase/monitor/tools/components/Logs", () => {
jest.mock("metabase/monitor/tools/components/JobInfoApp", () => ({
JobInfoApp: () => <div data-testid="jobs-page">{"Jobs"}</div>,
}));
-jest.mock("metabase/monitor/tools/components/ModelCacheRefreshJobs", () => ({
- ModelCachePage: () => (
- <div data-testid="model-caching-page">{"Model caching log"}</div>
+jest.mock("metabase/monitor/tools/components/ModelPersistenceLogJobs", () => ({
+ ModelPersistenceLogPage: () => (
+ <div data-testid="model-persistence-log-page">
+ {"Model persistence log"}
+ </div>
),
- ModelCacheRefreshJobModal: () => null,
+ ModelPersistenceLogJobModal: () => null,
}));
jest.mock("metabase/monitor/tools/components/LogLevelsModal", () => ({
LogLevelsModal: () => null,
@@ -285,11 +287,11 @@ describe("monitor routes", () => {
expect(await screen.findByTestId("jobs-page")).toBeInTheDocument();
});
- it("renders the Model caching log section at /monitor/model-caching", async () => {
- setup({ initialRoute: "/monitor/model-caching" });
+ it("renders the Model persistence log section at /monitor/model-persistence-log", async () => {
+ setup({ initialRoute: "/monitor/model-persistence-log" });
expect(
- await screen.findByTestId("model-caching-page"),
+ await screen.findByTestId("model-persistence-log-page"),
).toBeInTheDocument();
});
@@ -339,8 +341,8 @@ describe("monitor routes", () => {
["/admin/tools/logs", "logs-page"],
["/admin/tools/logs/levels", "logs-page"],
["/admin/tools/errors", "errors-upsell"],
- ["/admin/tools/model-caching", "model-caching-page"],
- ["/admin/tools/model-caching/9", "model-caching-page"],
+ ["/admin/tools/model-caching", "model-persistence-log-page"],
+ ["/admin/tools/model-caching/9", "model-persistence-log-page"],
["/admin/tools/notifications", "notifications-page"],
["/admin/tools/notifications/13", "notifications-page"],
])("redirects %s into the Monitor space", async (route, testId) => {
diff --git a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/index.ts b/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/index.ts
deleted file mode 100644
index 9ba9db227b6..00000000000
--- a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/index.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-export * from "./ModelCacheRefreshJobs";
-export * from "./ModelCacheRefreshJobModal";
diff --git a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobModal.tsx b/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobModal.tsx
similarity index 94%
rename from frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobModal.tsx
rename to frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobModal.tsx
index 3e79f34af43..9b8075086ad 100644
--- a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobModal.tsx
+++ b/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobModal.tsx
@@ -14,9 +14,9 @@ import ButtonsS from "metabase/css/components/buttons.module.css";
import { Box, Button } from "metabase/ui";
import { parseNumberParam } from "metabase/urls";
-import S from "./ModelCacheRefreshJobs.module.css";
+import S from "./ModelPersistenceLogJobs.module.css";
-export function ModelCacheRefreshJobModal({
+export function ModelPersistenceLogJobModal({
params,
onClose,
}: ModalComponentProps) {
diff --git a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.module.css b/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobs.module.css
similarity index 100%
rename from frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.module.css
rename to frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobs.module.css
diff --git a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.tsx b/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobs.tsx
similarity index 94%
rename from frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.tsx
rename to frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobs.tsx
index 3018f2cd710..14e93e6aabf 100644
--- a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.tsx
+++ b/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobs.tsx
@@ -41,7 +41,7 @@ const PAGE_SIZE = 20;
const COLUMN_WIDTHS = [0.22, 0.16, 0.28, 0.14, 0.14, 0.06];
-export function ModelCacheRefreshJobs() {
+export function ModelPersistenceLogJobs() {
const dispatch = useDispatch();
const [refreshModelCache] = useRefreshModelCacheMutation();
const { page, handleNextPage, handlePreviousPage } = usePagination();
@@ -97,7 +97,7 @@ export function ModelCacheRefreshJobs() {
mih={0}
p={0}
withBorder
- data-testid="model-cache-logs"
+ data-testid="model-persistence-log-jobs"
>
{isLoading ? (
<TreeTableSkeleton columnWidths={COLUMN_WIDTHS} />
@@ -105,9 +105,11 @@ export function ModelCacheRefreshJobs() {
<TreeTable
instance={treeTableInstance}
hierarchical={false}
- ariaLabel={t`Model caching log`}
+ ariaLabel={t`Model persistence log`}
emptyState={<MonitorEmptyState label={t`No log entries`} />}
- getRowProps={() => ({ "data-testid": "model-cache-log-row" })}
+ getRowProps={() => ({
+ "data-testid": "model-persistence-log-job-row",
+ })}
onRowClick={handleRowActivate}
/>
)}
@@ -130,12 +132,12 @@ export function ModelCacheRefreshJobs() {
);
}
-export function ModelCachePage() {
+export function ModelPersistenceLogPage() {
return (
<Flex h="100%" wrap="nowrap">
<MonitorMain>
- <MonitorHeaderTitle mb="sm">{t`Model caching log`}</MonitorHeaderTitle>
- <ModelCacheRefreshJobs />
+ <MonitorHeaderTitle mb="sm">{t`Model persistence log`}</MonitorHeaderTitle>
+ <ModelPersistenceLogJobs />
</MonitorMain>
<Outlet /> {/* refresh modal */}
</Flex>
diff --git a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.unit.spec.tsx b/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobs.unit.spec.tsx
similarity index 85%
rename from frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.unit.spec.tsx
rename to frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobs.unit.spec.tsx
index 9b3dc91847a..6da87d045cd 100644
--- a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.unit.spec.tsx
+++ b/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/ModelPersistenceLogJobs.unit.spec.tsx
@@ -9,22 +9,24 @@ import {
import type { ModelCacheRefreshStatus } from "metabase-types/api";
import { getMockModelCacheInfo } from "metabase-types/api/mocks/models";
-import { ModelCacheRefreshJobs } from "./ModelCacheRefreshJobs";
+import { ModelPersistenceLogJobs } from "./ModelPersistenceLogJobs";
async function setup({ logs = [] }: { logs?: ModelCacheRefreshStatus[] } = {}) {
mockGetBoundingClientRect({ width: 100, height: 100 });
setupModelPersistenceEndpoints(logs);
- renderWithProviders(<ModelCacheRefreshJobs />);
+ renderWithProviders(<ModelPersistenceLogJobs />);
- await screen.findByTestId("model-cache-logs");
+ await screen.findByTestId("model-persistence-log-jobs");
}
-describe("ModelCacheRefreshJobs", () => {
+describe("ModelPersistenceLogJobs", () => {
it("shows empty state when there are no cache logs", async () => {
await setup({ logs: [] });
expect(await screen.findByText("No log entries")).toBeInTheDocument();
- expect(screen.queryByTestId("model-cache-log-row")).not.toBeInTheDocument();
+ expect(
+ screen.queryByTestId("model-persistence-log-job-row"),
+ ).not.toBeInTheDocument();
});
it("shows empty state when all logs are in 'deletable' state", async () => {
@@ -35,7 +37,9 @@ describe("ModelCacheRefreshJobs", () => {
],
});
expect(await screen.findByText("No log entries")).toBeInTheDocument();
- expect(screen.queryByTestId("model-cache-log-row")).not.toBeInTheDocument();
+ expect(
+ screen.queryByTestId("model-persistence-log-job-row"),
+ ).not.toBeInTheDocument();
});
it("shows model and collection names", async () => {
@@ -72,7 +76,7 @@ describe("ModelCacheRefreshJobs", () => {
],
});
expect(
- await screen.findByTestId("model-cache-log-row"),
+ await screen.findByTestId("model-persistence-log-job-row"),
).toBeInTheDocument();
expect(screen.queryByText("DELETABLE")).not.toBeInTheDocument();
});
@@ -117,8 +121,9 @@ describe("ModelCacheRefreshJobs", () => {
],
});
- const getRows = () => screen.getAllByTestId("model-cache-log-row");
- await screen.findAllByTestId("model-cache-log-row");
+ const getRows = () =>
+ screen.getAllByTestId("model-persistence-log-job-row");
+ await screen.findAllByTestId("model-persistence-log-job-row");
expect(getRows()[0]).toHaveTextContent("Zebra");
expect(getRows()[1]).toHaveTextContent("Apple");
@@ -136,8 +141,9 @@ describe("ModelCacheRefreshJobs", () => {
],
});
- const getRows = () => screen.getAllByTestId("model-cache-log-row");
- await screen.findAllByTestId("model-cache-log-row");
+ const getRows = () =>
+ screen.getAllByTestId("model-persistence-log-job-row");
+ await screen.findAllByTestId("model-persistence-log-job-row");
expect(getRows()[0]).toHaveTextContent("Zeta");
expect(getRows()[1]).toHaveTextContent("Alpha");
diff --git a/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/index.ts b/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/index.ts
new file mode 100644
index 00000000000..2b5665b1106
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/ModelPersistenceLogJobs/index.ts
@@ -0,0 +1,2 @@
+export * from "./ModelPersistenceLogJobs";
+export * from "./ModelPersistenceLogJobModal";
diff --git a/frontend/src/metabase/urls/monitor.ts b/frontend/src/metabase/urls/monitor.ts
index 107c130ce86..b63cd8b0b42 100644
--- a/frontend/src/metabase/urls/monitor.ts
+++ b/frontend/src/metabase/urls/monitor.ts
@@ -73,12 +73,12 @@ export function monitorErroringQuestions() {
return `${ROOT_URL}/errors`;
}
-export function monitorModelCaching() {
- return `${ROOT_URL}/model-caching`;
+export function monitorModelPersistenceLog() {
+ return `${ROOT_URL}/model-persistence-log`;
}
export function monitorModelCacheRefreshJob(jobId: number) {
- return `${monitorModelCaching()}/${jobId}`;
+ return `${monitorModelPersistenceLog()}/${jobId}`;
}
export function monitorNotifications() {
diff --git a/src/metabase/channel/urls.clj b/src/metabase/channel/urls.clj
index b16de1ff6ca..2f7037bfa54 100644
--- a/src/metabase/channel/urls.clj
+++ b/src/metabase/channel/urls.clj
@@ -122,7 +122,7 @@
(defn tools-caching-details-url
"Return an appropriate URL for linking to caching log details."
[^Integer persisted-info-id]
- (format "%s/monitor/model-caching/%d" (site-url) persisted-info-id))
+ (format "%s/monitor/model-persistence-log/%d" (site-url) persisted-info-id))
(defn transform-job-url
"URL for a transform job."
diff --git a/test/metabase/channel/urls_test.clj b/test/metabase/channel/urls_test.clj
index ffafabd443a..f46f55b7843 100644
--- a/test/metabase/channel/urls_test.clj
+++ b/test/metabase/channel/urls_test.clj
@@ -38,7 +38,7 @@
(deftest tools-caching-details-url-test
(mt/with-temporary-setting-values [site-url "https://metabase.com"]
- (is (= "https://metabase.com/monitor/model-caching/42"
+ (is (= "https://metabase.com/monitor/model-persistence-log/42"
(urls/tools-caching-details-url 42)))))
(deftest dashcard-url-test