Skip to content

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

Monitor (#76806)

Stas Gavrylovb5849c994477
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index 02142d89c8e..580fa96f28b 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -10,6 +10,7 @@ src/metabase/query_processor @metabase/core-backend-querying-platform
src/metabase/graph @metabase/graphy
enterprise/backend/src/metabase_enterprise/dependencies @metabase/graphy
enterprise/frontend/src/metabase-enterprise/dependencies @metabase/graphy
+enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics @metabase/graphy
# @metabase/embedding
@@ -49,5 +50,5 @@ docs/installation-and-operation/commands.md # auto-generated
src/metabase/analytics/prometheus.clj @metabase/cloud-ops
# @metabase/metabot-frontend
-enterprise/frontend/src/metabase-enterprise/metabot @metabase/metabot-frontend
+enterprise/frontend/src/metabase-enterprise/metabot @metabase/metabot-frontend
frontend/src/metabase/metabot @metabase/metabot-frontend
diff --git a/e2e/support/helpers/e2e-dependency-helpers.ts b/e2e/support/helpers/e2e-dependency-helpers.ts
index 04f39db9b80..8cd21457cb7 100644
--- a/e2e/support/helpers/e2e-dependency-helpers.ts
+++ b/e2e/support/helpers/e2e-dependency-helpers.ts
@@ -17,12 +17,12 @@ export const DependencyGraph = {
export const DependencyDiagnostics = {
visitBrokenDependencies: () =>
- cy.visit("/data-studio/dependency-diagnostics/broken"),
+ cy.visit("/monitor/dependency-diagnostics/broken"),
visitUnreferencedEntities: () => {
cy.intercept("GET", "/api/ee/dependencies/graph/unreferenced*").as(
"unreferencedEntities",
);
- cy.visit("/data-studio/dependency-diagnostics/unreferenced");
+ cy.visit("/monitor/dependency-diagnostics/unreferenced");
cy.wait("@unreferencedEntities");
DependencyDiagnostics.list().should("be.visible");
},
diff --git a/e2e/support/timings.json b/e2e/support/timings.json
index 20a8b30a5d8..83d918d100a 100644
--- a/e2e/support/timings.json
+++ b/e2e/support/timings.json
@@ -137,12 +137,12 @@
"duration": 2679
},
{
- "spec": "../test/scenarios/admin/tools/help.cy.spec.ts",
- "duration": 13763
+ "spec": "../test/scenarios/admin/help.cy.spec.ts",
+ "duration": 13587
},
{
- "spec": "../test/scenarios/admin/tools/tools.cy.spec.ts",
- "duration": 47236
+ "spec": "../test/scenarios/monitor/tools/tools.cy.spec.ts",
+ "duration": 47954
},
{
"spec": "../test/scenarios/binning/binning-options.cy.spec.js",
diff --git a/e2e/test/scenarios/admin/tools/help.cy.spec.ts b/e2e/test/scenarios/admin/help.cy.spec.ts
similarity index 91%
rename from e2e/test/scenarios/admin/tools/help.cy.spec.ts
rename to e2e/test/scenarios/admin/help.cy.spec.ts
index 4bd59136b22..4fddb94639b 100644
--- a/e2e/test/scenarios/admin/tools/help.cy.spec.ts
+++ b/e2e/test/scenarios/admin/help.cy.spec.ts
@@ -2,14 +2,14 @@ import dayjs from "dayjs";
const { H } = cy;
-describe("scenarios > admin > tools > help", { tags: "@OSS" }, () => {
+describe("scenarios > admin > help", { tags: "@OSS" }, () => {
beforeEach(() => {
H.restore();
cy.signInAsAdmin();
});
it("should link `Get help` to help", () => {
- cy.visit("/admin/tools/help");
+ cy.visit("/admin/help");
// eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
cy.findByText("Metabase Admin");
@@ -24,7 +24,7 @@ describe("scenarios > admin > tools > help", { tags: "@OSS" }, () => {
});
});
-describe("scenarios > admin > tools > help (EE)", () => {
+describe("scenarios > admin > help (EE)", () => {
beforeEach(() => {
H.restore();
cy.signInAsAdmin();
@@ -32,7 +32,7 @@ describe("scenarios > admin > tools > help (EE)", () => {
});
it("should link `Get Help` to help-premium", () => {
- cy.visit("/admin/tools/help");
+ cy.visit("/admin/help");
cy.findByTestId("admin-layout-content")
.findByText("Get help")
@@ -45,7 +45,7 @@ describe("scenarios > admin > tools > help (EE)", () => {
});
});
-describe("scenarios > admin > tools > help > helping hand", () => {
+describe("scenarios > admin > help > helping hand", () => {
const executeCreateGrantAccessFlow = (
durationOption?: "96 hours" | "48 hours" | "24 hours",
ticket?: string,
@@ -90,7 +90,7 @@ describe("scenarios > admin > tools > help > helping hand", () => {
});
it("should only display the `Helping hand` section for cloud customers", () => {
- cy.visit("/admin/tools/help");
+ cy.visit("/admin/help");
cy.findByRole("heading", { name: "Helping hand" }).should("not.exist");
H.activateToken("pro-self-hosted");
@@ -108,7 +108,7 @@ describe("scenarios > admin > tools > help > helping hand", () => {
it("should allow creating a new access grant", () => {
H.activateToken("pro-cloud");
- cy.visit("/admin/tools/help");
+ cy.visit("/admin/help");
cy.findByTestId("access-grant-list-table").should("not.exist");
@@ -122,7 +122,7 @@ describe("scenarios > admin > tools > help > helping hand", () => {
it("allow creating an access grant with a ticket number and custom notes", () => {
H.activateToken("pro-cloud");
- cy.visit("/admin/tools/help");
+ cy.visit("/admin/help");
executeCreateGrantAccessFlow("48 hours", "TICKET-999", "Custom notes");
@@ -138,7 +138,7 @@ describe("scenarios > admin > tools > help > helping hand", () => {
it("should disallow more than one active access grant", () => {
H.activateToken("pro-cloud");
- cy.visit("/admin/tools/help");
+ cy.visit("/admin/help");
executeCreateGrantAccessFlow();
@@ -151,7 +151,7 @@ describe("scenarios > admin > tools > help > helping hand", () => {
it("can revoke an access grant", () => {
H.activateToken("pro-cloud");
- cy.visit("/admin/tools/help");
+ cy.visit("/admin/help");
executeCreateGrantAccessFlow();
cy.button("Request a helping hand").should("be.disabled");
diff --git a/e2e/test/scenarios/admin/tools/tools.cy.spec.ts b/e2e/test/scenarios/monitor/tools/tools.cy.spec.ts
similarity index 84%
rename from e2e/test/scenarios/admin/tools/tools.cy.spec.ts
rename to e2e/test/scenarios/monitor/tools/tools.cy.spec.ts
index f7a41122dee..f41a54bdabe 100644
--- a/e2e/test/scenarios/admin/tools/tools.cy.spec.ts
+++ b/e2e/test/scenarios/monitor/tools/tools.cy.spec.ts
@@ -79,13 +79,12 @@ describe("issue 14636", () => {
});
it("pagination should work (metabase#14636)", () => {
- cy.visit("/admin/tools/tasks/list");
+ cy.visit("/monitor/tasks/list");
cy.wait("@first");
cy.location("search").should("eq", "");
- // eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
- cy.findByText("Troubleshooting logs");
+ cy.findByRole("heading", { name: "Background tasks" }).should("be.visible");
cy.findByLabelText("pagination").findByText("1 - 50").should("be.visible");
// eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
@@ -115,14 +114,14 @@ describe("issue 14636", () => {
cy.log("pagination should affect browser history");
cy.go("back");
- cy.location("pathname").should("eq", "/admin/tools/tasks/list");
+ cy.location("pathname").should("eq", "/monitor/tasks/list");
cy.location("search").should("eq", "?page=1");
cy.go("back");
- cy.location("pathname").should("eq", "/admin/tools/tasks/list");
+ cy.location("pathname").should("eq", "/monitor/tasks/list");
cy.location("search").should("eq", "");
cy.log("it should respect page query param on page load");
- cy.visit("/admin/tools/tasks/list?page=1");
+ cy.visit("/monitor/tasks/list?page=1");
cy.wait("@second");
cy.findByLabelText("pagination")
@@ -131,9 +130,8 @@ describe("issue 14636", () => {
});
it("filtering should work", () => {
- cy.visit(
- "/admin/tools/tasks/list?status=success&task=field+values+scanning",
- );
+ const total = 57;
+ cy.visit("/monitor/tasks/list?status=success&task=field+values+scanning");
cy.findByPlaceholderText("Filter by task").should(
"have.value",
@@ -153,10 +151,7 @@ describe("issue 14636", () => {
"?status=failed&task=field+values+scanning",
);
cy.findAllByTestId("task").should("have.length", 0);
- cy.findByTestId("admin-layout-content").should(
- "contain.text",
- "No results",
- );
+ cy.findByTestId("monitor-main").should("contain.text", "No results");
getFilterByStatus().parent().findByLabelText("Clear").click();
cy.location("search").should("eq", "?task=field+values+scanning");
@@ -173,23 +168,25 @@ describe("issue 14636", () => {
.click();
cy.location("search").should("eq", "");
cy.wait("@first");
- cy.findAllByTestId("task").should("have.length", 50);
cy.findByLabelText("pagination").findByText("1 - 50").should("be.visible");
+ cy.visit("/monitor/tasks/list?page=1");
+ cy.findByLabelText("pagination")
+ .findByText(`51 - ${total}`)
+ .should("be.visible");
cy.log("should reset pagination when changing filters");
- cy.visit("/admin/tools/tasks/list?page=1");
getFilterByStatus().click();
H.popover().findByText("Success").click();
cy.location("search").should("eq", "?status=success");
cy.log("should remove invalid query params");
- cy.visit("/admin/tools/tasks/list?status=foobar");
+ cy.visit("/monitor/tasks/list?status=foobar");
cy.location("search").should("eq", "");
getFilterByStatus().should("have.value", "");
});
});
-describe("scenarios > admin > tools > tasks", () => {
+describe("scenarios > monitor > tools > tasks", () => {
const task = createMockTask({
task_details: {
useful: {
@@ -219,12 +216,12 @@ describe("scenarios > admin > tools > tasks", () => {
});
it("shows task details page", () => {
- cy.visit("/admin/tools/tasks/list");
+ cy.visit("/monitor/tasks/list");
cy.wait("@getTasks");
cy.findByTestId("tasks-table").findByText("A task").click();
cy.wait("@getTask");
- cy.location("pathname").should("eq", `/admin/tools/tasks/list/${task.id}`);
+ cy.location("pathname").should("eq", `/monitor/tasks/list/${task.id}`);
cy.log("task details");
cy.get(".cm-content").should("be.visible").get(".cm-line").as("lines");
@@ -280,7 +277,7 @@ describe("scenarios > admin > tools > tasks", () => {
body: taskWithLogs,
}).as("getTaskWithLogs");
- cy.visit(`/admin/tools/tasks/list/${task.id}`);
+ cy.visit(`/monitor/tasks/list/${task.id}`);
cy.wait("@getTaskWithLogs");
cy.findByTestId("task-logs").scrollIntoView().should("be.visible");
@@ -300,17 +297,17 @@ describe("scenarios > admin > tools > tasks", () => {
body: taskWithoutLogs,
}).as("getTaskWithoutLogs");
- cy.visit(`/admin/tools/tasks/list/${task.id}`);
+ cy.visit(`/monitor/tasks/list/${task.id}`);
cy.wait("@getTaskWithoutLogs");
cy.findByTestId("task-logs").should("not.exist");
- cy.findByTestId("admin-layout-content")
+ cy.findByTestId("monitor-main")
.findByText("There are no captured logs")
.should("be.visible");
});
});
-describe("scenarios > admin > tools > logs", () => {
+describe("scenarios > monitor > tools > logs", () => {
const log1 = {
timestamp: "2024-01-10T21:21:58.597Z",
level: "DEBUG",
@@ -334,7 +331,7 @@ describe("scenarios > admin > tools > logs", () => {
H.restore();
cy.signInAsAdmin();
- cy.visit("/admin/tools/logs");
+ cy.visit("/monitor/logs");
cy.wait("@getLogs");
});
@@ -367,8 +364,8 @@ describe("scenarios > admin > tools > logs", () => {
}
});
-describe("admin > tools > erroring questions ", () => {
- const TOOLS_ERRORS_URL = "/admin/tools/errors";
+describe("monitor > tools > erroring questions ", () => {
+ const TOOLS_ERRORS_URL = "/monitor/errors";
// The filter is required but doesn't have a default value set
const brokenQuestionDetails = {
name: "Broken SQL",
@@ -388,7 +385,14 @@ describe("admin > tools > erroring questions ", () => {
};
function fixQuestion(name: string) {
- cy.findByTestId("visualization-root").findByText(name).click();
+ // the row opens in a new tab, which Cypress can't follow with a click,
+ // so navigating directly
+ cy.findByTestId("erroring-questions-table")
+ .findByText(name)
+ .closest("a")
+ .invoke("attr", "href")
+ // the row link always carries an href; narrow string | undefined for cy.visit
+ .then((href) => cy.visit(href as string));
cy.findByText("Open Editor").click();
@@ -404,7 +408,7 @@ describe("admin > tools > erroring questions ", () => {
function selectQuestion(name: string) {
cy.findByText(name)
- .closest("tr")
+ .closest('[data-testid="erroring-question"]')
.within(() => {
cy.findByRole("checkbox").click().should("be.checked");
});
@@ -420,22 +424,24 @@ describe("admin > tools > erroring questions ", () => {
});
describe("without broken questions", () => {
- it('should render the "Tools" tab and navigate to the "Erroring Questions" by clicking on it', () => {
- // The sidebar has been taken out, because it looks awkward when there's only one elem on it: put it back in when there's more than one
- cy.visit("/admin");
+ it("should render the Monitor nav and navigate to Erroring questions by clicking on it", () => {
+ cy.visit("/monitor");
- cy.get("nav").contains("Tools").click();
-
- cy.findByRole("link", { name: /Erroring questions/ }).click();
+ cy.findByTestId("monitor-nav")
+ .findByRole("link", { name: /Erroring questions/ })
+ .click();
cy.location("pathname").should("eq", TOOLS_ERRORS_URL);
cy.log("test no results state");
- cy.findByTestId("visualization-root").findByText("No results");
- cy.button("Rerun Selected").should("be.disabled");
- cy.findByPlaceholderText("Error contents").should("be.disabled");
- cy.findByPlaceholderText("DB name").should("be.disabled");
- cy.findByPlaceholderText("Collection name").should("be.disabled");
+ cy.findByTestId("erroring-questions-table")
+ .findByText("No results")
+ .should("be.visible");
+ // nothing selected -> the bulk action bar (and its button) is hidden
+ cy.button("Rerun selected").should("not.exist");
+ cy.findByPlaceholderText(
+ "Search by question, error, database, or collection",
+ ).should("be.enabled");
});
});
@@ -454,27 +460,32 @@ describe("admin > tools > erroring questions ", () => {
selectQuestion(brokenQuestionDetails.name);
- cy.button("Rerun Selected").should("not.be.disabled").click();
+ cy.button("Rerun selected").should("not.be.disabled").click();
cy.wait("@dataset");
// The question is still there because we didn't fix it
- cy.findByTestId("visualization-root").findByText(
+ cy.findByTestId("erroring-questions-table").findByText(
brokenQuestionDetails.name,
);
- cy.button("Rerun Selected").should("be.disabled");
+ // rerunning clears the selection, so the bulk action bar closes
+ cy.button("Rerun selected").should("not.exist");
- cy.findByPlaceholderText("Error contents").should("not.be.disabled");
- cy.findByPlaceholderText("DB name").should("not.be.disabled");
- cy.findByPlaceholderText("Collection name")
- .should("not.be.disabled")
+ cy.findByPlaceholderText(
+ "Search by question, error, database, or collection",
+ )
+ .should("be.enabled")
.type("foo");
cy.wait("@dataset");
- cy.findByTestId("visualization-root").findByText("No results");
+ cy.findByTestId("erroring-questions-table")
+ .findByText("No results")
+ .should("be.visible");
- cy.findByPlaceholderText("Collection name").clear();
+ cy.findByPlaceholderText(
+ "Search by question, error, database, or collection",
+ ).clear();
fixQuestion(brokenQuestionDetails.name);
@@ -482,17 +493,19 @@ describe("admin > tools > erroring questions ", () => {
selectQuestion(brokenQuestionDetails.name);
- cy.button("Rerun Selected").should("not.be.disabled").click();
+ cy.button("Rerun selected").should("not.be.disabled").click();
cy.wait("@dataset");
- cy.findByTestId("visualization-root").findByText("No results");
+ cy.findByTestId("erroring-questions-table")
+ .findByText("No results")
+ .should("be.visible");
});
});
});
});
-describe("admin > tools", () => {
+describe("monitor > tools", () => {
beforeEach(() => {
H.restore();
cy.signInAsAdmin();
@@ -504,41 +517,39 @@ describe("admin > tools", () => {
"Enable model persistence in order to have multiple tabs/routes in tools",
);
cy.request("POST", "/api/persist/enable");
- cy.visit("/admin/tools/errors");
+ cy.visit("/monitor/errors");
cy.findByRole("heading", {
- name: "Questions that errored when last run",
+ name: "Erroring questions",
}).should("be.visible");
cy.log("We should be able to switch to the model caching page");
- cy.findByTestId("admin-layout-sidebar")
- .findByText("Model cache log")
- .click();
- cy.location("pathname").should("eq", "/admin/tools/model-caching");
+ cy.findByTestId("monitor-nav").findByText("Model caching log").click();
+ cy.location("pathname").should("eq", "/monitor/model-caching");
cy.log(
"Once the audit_app feature flag is gone, tools should display an upsell",
);
H.deleteToken();
- cy.visit("/admin/tools/errors");
+ cy.visit("/monitor/errors");
cy.findByRole("heading", {
name: "Troubleshoot faster",
}).should("be.visible");
- cy.findByRole("button", { name: "Try for free" });
+ cy.findByRole("link", { name: "Upgrade to Pro" });
});
describe("issue 57113", () => {
- it("should navigate to /admin/tools/tasks/list when clicking Back to Tasks even with no browser history", () => {
- cy.visit("/admin/tools/tasks/list");
+ it("should navigate to /monitor/tasks/list when clicking Back to Tasks even with no browser history", () => {
+ cy.visit("/monitor/tasks/list");
cy.log("Pick an existing task url");
cy.findAllByTestId("task").should("be.visible").first().click();
cy.location("pathname")
- .should("match", /\/admin\/tools\/tasks\/list\/[0-9]+$/)
+ .should("match", /\/monitor\/tasks\/list\/[0-9]+$/)
.then((pathname) => {
// Clear all history and navigate to the task detail page
cy.window().then((window) => {
@@ -549,13 +560,13 @@ describe("admin > tools", () => {
cy.visit(pathname);
cy.findByText("Back to Tasks").click();
- cy.location("pathname").should("eq", "/admin/tools/tasks/list");
+ cy.location("pathname").should("eq", "/monitor/tasks/list");
});
});
});
});
-describe("scenarios > admin > tools > task runs", () => {
+describe("scenarios > monitor > tools > task runs", () => {
const taskRun = {
id: 1,
run_type: "sync",
@@ -633,21 +644,21 @@ describe("scenarios > admin > tools > task runs", () => {
});
it("should switch between Tasks and Runs tabs", () => {
- cy.visit("/admin/tools/tasks/list");
+ cy.visit("/monitor/tasks/list");
cy.findByTestId("tasks-table").should("be.visible");
cy.findByRole("tab", { name: /Runs/i }).click();
- cy.location("pathname").should("eq", "/admin/tools/tasks/runs");
+ cy.location("pathname").should("eq", "/monitor/tasks/runs");
cy.findByTestId("task-runs-table").should("be.visible");
cy.findByRole("tab", { name: /Tasks/i }).click();
- cy.location("pathname").should("eq", "/admin/tools/tasks/list");
+ cy.location("pathname").should("eq", "/monitor/tasks/list");
cy.findByTestId("tasks-table").should("be.visible");
});
it("should navigate to task run details and show associated tasks", () => {
- cy.visit("/admin/tools/tasks/runs");
+ cy.visit("/monitor/tasks/runs");
cy.wait("@getTaskRuns");
cy.findByTestId("task-runs-table")
@@ -656,12 +667,9 @@ describe("scenarios > admin > tools > task runs", () => {
.click();
cy.wait("@getTaskRun");
- cy.location("pathname").should(
- "eq",
- `/admin/tools/tasks/runs/${taskRun.id}`,
- );
+ cy.location("pathname").should("eq", `/monitor/tasks/runs/${taskRun.id}`);
- cy.findByTestId("admin-layout-content").within(() => {
+ cy.findByTestId("monitor-main").within(() => {
cy.findByText("Run type").should("be.visible");
cy.findByText("Entity").should("be.visible");
cy.findByText("Sample Database").should("be.visible");
@@ -672,15 +680,15 @@ describe("scenarios > admin > tools > task runs", () => {
});
it("should navigate back to runs list from run details", () => {
- cy.visit(`/admin/tools/tasks/runs/${taskRun.id}`);
+ cy.visit(`/monitor/tasks/runs/${taskRun.id}`);
cy.wait("@getTaskRun");
cy.findByRole("link", { name: /Back to Runs/i }).click();
- cy.location("pathname").should("eq", "/admin/tools/tasks/runs");
+ cy.location("pathname").should("eq", "/monitor/tasks/runs");
});
it("should have clickable entity link in task run details", () => {
- cy.visit(`/admin/tools/tasks/runs/${taskRun.id}`);
+ cy.visit(`/monitor/tasks/runs/${taskRun.id}`);
cy.wait("@getTaskRun");
cy.findByRole("link", { name: /Sample Database/i }).click();
@@ -688,7 +696,7 @@ describe("scenarios > admin > tools > task runs", () => {
});
it("should navigate to task details from task run details", () => {
- cy.visit(`/admin/tools/tasks/runs/${taskRun.id}`);
+ cy.visit(`/monitor/tasks/runs/${taskRun.id}`);
cy.wait("@getTaskRun");
cy.findByTestId("task-run-tasks-table")
@@ -698,12 +706,12 @@ describe("scenarios > admin > tools > task runs", () => {
cy.location("pathname").should(
"eq",
- `/admin/tools/tasks/list/${taskRunExtended.tasks[0].id}`,
+ `/monitor/tasks/list/${taskRunExtended.tasks[0].id}`,
);
});
});
-describe("scenarios > admin > tools > task runs pagination", () => {
+describe("scenarios > monitor > tools > task runs pagination", () => {
const total = 57;
const limit = 50;
@@ -716,7 +724,7 @@ describe("scenarios > admin > tools > task runs pagination", () => {
}) {
const offset = page * limit;
- cy.intercept("GET", `/api/task/runs?limit=${limit}&offset=${offset}`, {
+ cy.intercept("GET", `/api/task/runs?limit=${limit}&offset=${offset}*`, {
status: 200,
body: {
data: stubRunsPageRows(page),
@@ -762,7 +770,7 @@ describe("scenarios > admin > tools > task runs pagination", () => {
});
it("pagination should work for task runs", () => {
- cy.visit("/admin/tools/tasks/runs");
+ cy.visit("/monitor/tasks/runs");
cy.wait("@firstRunsPage");
cy.location("search").should("eq", "");
@@ -789,7 +797,7 @@ describe("scenarios > admin > tools > task runs pagination", () => {
});
});
-describe("scenarios > admin > tools > task runs filtering", () => {
+describe("scenarios > monitor > tools > task runs filtering", () => {
beforeEach(() => {
H.restore();
cy.signInAsAdmin();
@@ -824,7 +832,7 @@ describe("scenarios > admin > tools > task runs filtering", () => {
});
it("filtering should work for task runs", () => {
- cy.visit("/admin/tools/tasks/runs");
+ cy.visit("/monitor/tasks/runs");
cy.wait("@getTaskRuns");
cy.log("Filter by run type");
@@ -859,7 +867,7 @@ describe("scenarios > admin > tools > task runs filtering", () => {
});
it("entity picker should be disabled/enabled based on run type, started at and entities availability", () => {
- cy.visit("/admin/tools/tasks/runs");
+ cy.visit("/monitor/tasks/runs");
cy.wait("@getTaskRuns");
cy.intercept("GET", "/api/task/runs/entities?*", {
body: [
diff --git a/e2e/test/scenarios/onboarding/command-palette.cy.spec.js b/e2e/test/scenarios/onboarding/command-palette.cy.spec.js
index e7e5ce3d78c..b8ebdc119d2 100644
--- a/e2e/test/scenarios/onboarding/command-palette.cy.spec.js
+++ b/e2e/test/scenarios/onboarding/command-palette.cy.spec.js
@@ -289,7 +289,7 @@ describe("command palette", () => {
H.commandPaletteAction("Performance").should("not.exist");
H.commandPaletteInput().clear();
- // Tools
+ // Monitor tools live outside the Admin command-palette links
H.commandPaletteInput().clear().type("tool");
H.commandPaletteAction("Tools").should("not.exist");
H.commandPaletteInput().clear();
@@ -348,9 +348,9 @@ describe("command palette", () => {
H.commandPaletteAction("Settings - General").should("exist");
H.commandPaletteInput().clear();
- // Tools
+ // Monitor tools live outside the Admin command-palette links
H.commandPaletteInput().clear().type("tool");
- H.commandPaletteAction("Tools").should("exist");
+ H.commandPaletteAction("Tools").should("not.exist");
H.commandPaletteInput().clear();
//Database and table metadata
@@ -629,7 +629,7 @@ describe("shortcuts", { tags: ["@actions"] }, () => {
cy.realPress("5");
cy.location("pathname").should("contain", "/admin/datamodel");
cy.realPress("9");
- cy.location("pathname").should("contain", "/admin/tools");
+ cy.location("pathname").should("contain", "/admin/help");
});
it("should not navigate to data studio via shortcut for non-admin users", () => {
diff --git a/e2e/test/scenarios/permissions/application-permissions.cy.spec.js b/e2e/test/scenarios/permissions/application-permissions.cy.spec.js
index 1b2ab6612c5..fea05d85bb7 100644
--- a/e2e/test/scenarios/permissions/application-permissions.cy.spec.js
+++ b/e2e/test/scenarios/permissions/application-permissions.cy.spec.js
@@ -126,21 +126,18 @@ describe("scenarios > admin > permissions > application", () => {
it("allows accessing tools for non-admins", () => {
cy.visit("/");
- H.goToAdmin();
+ H.getProfileLink().click();
+ H.popover().findByText("Monitor").click();
- cy.log("Tools smoke test");
- cy.location("pathname").should("eq", "/admin/tools/help");
+ cy.log("Monitor tools smoke test");
+ cy.location("pathname").should("contain", "/monitor/tasks");
cy.findByRole("heading", {
- name: "Help",
+ name: "Background tasks",
});
- cy.findByTestId("admin-layout-sidebar")
- .findByText("Erroring questions")
- .click();
- cy.location("pathname").should("eq", "/admin/tools/errors");
- cy.findByTestId("admin-layout-content").findByText(
- "Questions that errored when last run",
- );
+ cy.findByTestId("monitor-nav").findByText("Erroring questions").click();
+ cy.location("pathname").should("eq", "/monitor/errors");
+ cy.findByTestId("monitor-main").findByText("Erroring questions");
});
});
@@ -152,10 +149,10 @@ describe("scenarios > admin > permissions > application", () => {
H.popover().findByText(adminAppLinkText).should("not.exist");
- cy.visit("/admin/tools/errors");
+ cy.visit("/monitor/errors");
H.main().findByText("Sorry, you don’t have permission to see that.");
- cy.visit("/admin/tools/help");
+ cy.visit("/monitor");
H.main().findByText("Sorry, you don’t have permission to see that.");
});
});
diff --git a/enterprise/backend/src/metabase_enterprise/audit_app/pages/common.clj b/enterprise/backend/src/metabase_enterprise/audit_app/pages/common.clj
index 464e8216d90..cdd882d6a81 100644
--- a/enterprise/backend/src/metabase_enterprise/audit_app/pages/common.clj
+++ b/enterprise/backend/src/metabase_enterprise/audit_app/pages/common.clj
@@ -8,6 +8,7 @@
[metabase-enterprise.audit-app.query-processor.middleware.handle-audit-queries
:as qp.middleware.audit]
[metabase.app-db.core :as mdb]
+ [metabase.driver :as driver]
[metabase.driver.sql-jdbc.execute :as sql-jdbc.execute]
[metabase.driver.sql-jdbc.sync :as sql-jdbc.sync]
[metabase.query-processor.schema :as qp.schema]
@@ -106,8 +107,10 @@
(let [driver (mdb/db-type)
[sql & params] (compile-honeysql driver honeysql-query)]
;; MySQL driver normalizies timestamps. Setting `*results-timezone-id-override*` is a shortcut
- ;; instead of mocking up a chunk of regular QP pipeline.
- (binding [qp.timezone/*results-timezone-id-override* (application-db-default-timezone)]
+ ;; instead of mocking up a chunk of regular QP pipeline. `*driver*` must be bound too: the MySQL
+ ;; timestamp reader calls `results-timezone-id`, whose `:keyword` driver arg is validated in tests.
+ (binding [driver/*driver* driver
+ qp.timezone/*results-timezone-id-override* (application-db-default-timezone)]
(try
(with-open [conn (.getConnection (mdb/app-db))
stmt (sql-jdbc.execute/prepared-statement driver conn sql params)
diff --git a/enterprise/backend/src/metabase_enterprise/audit_app/pages/common/cards.clj b/enterprise/backend/src/metabase_enterprise/audit_app/pages/common/cards.clj
index 6c1530bc3d9..cb88672d4a6 100644
--- a/enterprise/backend/src/metabase_enterprise/audit_app/pages/common/cards.clj
+++ b/enterprise/backend/src/metabase_enterprise/audit_app/pages/common/cards.clj
@@ -4,10 +4,13 @@
"HoneySQL for a CTE to get latest QueryExecution for a Card."
[:latest_qe {:select [:query_execution.card_id :error :query_execution.started_at]
:from [:query_execution]
+ ;; Join on BOTH card_id and started_at, because some cards share the same timestamp.
:join [[{:select [:card_id [:%max.started_at :started_at]]
:from [:query_execution]
:group-by [:card_id]} :inner_qe]
- [:= :query_execution.started_at :inner_qe.started_at]]}])
+ [:and
+ [:= :query_execution.card_id :inner_qe.card_id]
+ [:= :query_execution.started_at :inner_qe.started_at]]]}])
(def query-runs
"HoneySQL for a CTE to include the total number of queries for each Card forever."
diff --git a/enterprise/backend/src/metabase_enterprise/audit_app/pages/queries.clj b/enterprise/backend/src/metabase_enterprise/audit_app/pages/queries.clj
index ef18f476e7c..8db4b6e800c 100644
--- a/enterprise/backend/src/metabase_enterprise/audit_app/pages/queries.clj
+++ b/enterprise/backend/src/metabase_enterprise/audit_app/pages/queries.clj
@@ -9,74 +9,81 @@
;; List of all failing questions
(defmethod audit.i/internal-query ::bad-table
([_]
- (audit.i/internal-query ::bad-table nil nil nil nil nil))
+ (audit.i/internal-query ::bad-table nil nil nil))
([_
- error-filter
- db-filter
- collection-filter
+ search-term
sort-column
sort-direction]
- {:metadata [[:card_id {:display_name "Card ID", :base_type :type/Integer :remapped_to :card_name}]
- [:card_name {:display_name "Question", :base_type :type/Text :remapped_from :card_id}]
- [:error_substr {:display_name "Error", :base_type :type/Text :code true}]
- [:collection_id {:display_name "Collection ID", :base_type :type/Integer :remapped_to :collection_name}]
- [:collection_name {:display_name "Collection", :base_type :type/Text :remapped_from :collection_id}]
- [:database_id {:display_name "Database ID", :base_type :type/Integer :remapped_to :database_name}]
- [:database_name {:display_name "Database", :base_type :type/Text :remapped_from :database_id}]
- [:schema_name {:display_name "Schema", :base_type :type/Text}]
- [:table_id {:display_name "Table ID", :base_type :type/Integer :remapped_to :table_name}]
- [:table_name {:display_name "Table", :base_type :type/Text :remapped_from :table_id}]
- [:last_run_at {:display_name "Last run at", :base_type :type/DateTime}]
- [:total_runs {:display_name "Total runs", :base_type :type/Integer}]
- ;; if it appears a billion times each in 2 dashboards, that's 2 billion appearances
- [:num_dashboards {:display_name "Dashboards it's in", :base_type :type/Integer}]
- [:user_id {:display_name "Created By ID", :base_type :type/Integer :remapped_to :user_name}]
- [:user_name {:display_name "Created By", :base_type :type/Text :remapped_from :user_id}]
- [:updated_at {:display_name "Updated At", :base_type :type/DateTime}]]
- :results (common/reducible-query
- (let [coll-name [:coalesce :coll.name "Our Analytics"]
- error-substr [:concat
- [:substring
- :latest_qe.error
- [:inline (if (= (mdb/db-type) :mysql) 1 0)]
- [:inline 60]]
- "..."]
- dash-count [:coalesce :dash_card.count [:inline 0]]]
- (->
- {:with [cards/query-runs
- cards/latest-qe
- cards/dashboards-count]
- :select [[:card.id :card_id]
- [:card.name :card_name]
- [error-substr :error_substr]
- [:card.collection_id :collection_id]
- [coll-name :collection_name]
- :card.database_id
- [:db.name :database_name]
- [:t.schema :schema_name]
- :card.table_id
- [:t.name :table_name]
- [:latest_qe.started_at :last_run_at]
- [:query_runs.count :total_runs]
- [dash-count :num_dashboards]
- [:card.creator_id :user_id]
- [(common/user-full-name :u) :user_name]
- [:card.updated_at :updated_at]]
- :from [[:report_card :card]]
- :left-join [[:collection :coll] [:= :card.collection_id :coll.id]
- [:metabase_database :db] [:= :card.database_id :db.id]
- [:metabase_table :t] [:= :card.table_id :t.id]
- [:core_user :u] [:= :card.creator_id :u.id]
- :latest_qe [:= :card.id :latest_qe.card_id]
- :query_runs [:= :card.id :query_runs.card_id]
- :dash_card [:= :card.id :dash_card.card_id]]
- :where [:and
- [:= :card.archived false]
- [:<> :latest_qe.error nil]
- [:not= :card.database_id audit/audit-db-id]]}
- (common/add-search-clause error-filter :latest_qe.error)
- (common/add-search-clause db-filter :db.name)
- (common/add-search-clause collection-filter coll-name)
- (common/add-sort-clause
- (or sort-column "card.name")
- (or sort-direction "asc")))))}))
+ (let [total-count (volatile! nil)]
+ {:metadata
+ [[:card_id {:display_name "Card ID", :base_type :type/Integer, :remapped_to :card_name}]
+ [:card_name {:display_name "Question", :base_type :type/Text, :remapped_from :card_id}]
+ [:error_substr {:display_name "Error", :base_type :type/Text, :code true}]
+ [:collection_id {:display_name "Collection ID", :base_type :type/Integer, :remapped_to :collection_name}]
+ [:collection_name {:display_name "Collection", :base_type :type/Text, :remapped_from :collection_id}]
+ [:database_id {:display_name "Database ID", :base_type :type/Integer, :remapped_to :database_name}]
+ [:database_name {:display_name "Database", :base_type :type/Text, :remapped_from :database_id}]
+ [:schema_name {:display_name "Schema", :base_type :type/Text}]
+ [:table_id {:display_name "Table ID", :base_type :type/Integer, :remapped_to :table_name}]
+ [:table_name {:display_name "Table", :base_type :type/Text, :remapped_from :table_id}]
+ [:last_run_at {:display_name "Last run at", :base_type :type/DateTime}]
+ [:total_runs {:display_name "Total runs", :base_type :type/Integer}]
+ ;; if it appears a billion times each in 2 dashboards, that's 2 billion appearances
+ [:num_dashboards {:display_name "Dashboards it's in", :base_type :type/Integer}]
+ [:user_id {:display_name "Created By ID", :base_type :type/Integer, :remapped_to :user_name}]
+ [:user_name {:display_name "Created By", :base_type :type/Text, :remapped_from :user_id}]
+ [:updated_at {:display_name "Updated At", :base_type :type/DateTime}]]
+ :xform (fn [rf]
+ (fn
+ ([] (rf))
+ ([result] (rf (assoc result :total_count (or @total-count 0))))
+ ([result row]
+ (vreset! total-count (last row))
+ (rf result (vec (butlast row))))))
+ :results (common/reducible-query
+ (let [coll-name [:coalesce :coll.name "Our Analytics"]
+ error-substr [:concat
+ [:substring
+ :latest_qe.error
+ [:inline (if (= (mdb/db-type) :mysql) 1 0)]
+ [:inline 60]]
+ "..."]
+ dash-count [:coalesce :dash_card.count [:inline 0]]]
+ (->
+ {:with [cards/query-runs
+ cards/latest-qe
+ cards/dashboards-count]
+ :select [[:card.id :card_id]
+ [:card.name :card_name]
+ [error-substr :error_substr]
+ [:card.collection_id :collection_id]
+ [coll-name :collection_name]
+ :card.database_id
+ [:db.name :database_name]
+ [:t.schema :schema_name]
+ :card.table_id
+ [:t.name :table_name]
+ [:latest_qe.started_at :last_run_at]
+ [:query_runs.count :total_runs]
+ [dash-count :num_dashboards]
+ [:card.creator_id :user_id]
+ [(common/user-full-name :u) :user_name]
+ [:card.updated_at :updated_at]
+ ;; Keep this last: the streaming xform strips it positionally and hoists it to the root.
+ [[:over [[:count :*] {} :total_count]]]]
+ :from [[:report_card :card]]
+ :left-join [[:collection :coll] [:= :card.collection_id :coll.id]
+ [:metabase_database :db] [:= :card.database_id :db.id]
+ [:metabase_table :t] [:= :card.table_id :t.id]
+ [:core_user :u] [:= :card.creator_id :u.id]
+ :latest_qe [:= :card.id :latest_qe.card_id]
+ :query_runs [:= :card.id :query_runs.card_id]
+ :dash_card [:= :card.id :dash_card.card_id]]
+ :where [:and
+ [:= :card.archived false]
+ [:<> :latest_qe.error nil]
+ [:not= :card.database_id audit/audit-db-id]]}
+ (common/add-search-clause search-term :card.name :latest_qe.error :db.name coll-name)
+ (common/add-sort-clause
+ (or sort-column "card.name")
+ (or sort-direction "asc")))))})))
diff --git a/enterprise/backend/src/metabase_enterprise/dependencies/events.clj b/enterprise/backend/src/metabase_enterprise/dependencies/events.clj
index 1727e54e0d1..729a6e8352d 100644
--- a/enterprise/backend/src/metabase_enterprise/dependencies/events.clj
+++ b/enterprise/backend/src/metabase_enterprise/dependencies/events.clj
@@ -344,7 +344,7 @@
;; ### Database Deletion (orphans transforms)
;; Transforms whose `source_database_id` matches the database being deleted survive the delete
;; but their existing `analysis_finding` rows still say "OK". Mark them stale here so the entity-check
-;; job re-runs and surfaces them on `/data-studio/dependency-diagnostics/broken`.
+;; job re-runs and surfaces them on `/monitor/dependency-diagnostics/broken`.
(defenterprise mark-transforms-stale-on-database-delete!
"Enterprise implementation: mark all transforms whose source database is being deleted as stale
for dependency re-analysis. See the OSS declaration in `metabase.warehouses.models.database`."
diff --git a/enterprise/backend/test/metabase_enterprise/audit_app/pages/queries_test.clj b/enterprise/backend/test/metabase_enterprise/audit_app/pages/queries_test.clj
new file mode 100644
index 00000000000..27c666b1709
--- /dev/null
+++ b/enterprise/backend/test/metabase_enterprise/audit_app/pages/queries_test.clj
@@ -0,0 +1,118 @@
+(ns metabase-enterprise.audit-app.pages.queries-test
+ (:require
+ [clojure.test :refer :all]
+ [metabase-enterprise.audit-app.pages.queries :as queries]
+ [metabase.query-processor.test :as qp]
+ [metabase.query-processor.util :as qp.util]
+ [metabase.test :as mt]
+ [metabase.util :as u]))
+
+(def ^:private query-execution-defaults
+ {:hash (qp.util/query-hash {})
+ :result_rows 0
+ :running_time 0
+ :native false
+ :started_at #t "2026-01-01T10:00:00Z"
+ :context :ad-hoc})
+
+(defn- run-query
+ [query-type & {:as additional-query-params}]
+ (mt/with-test-user :crowberto
+ (mt/with-premium-features #{:audit-app}
+ (qp/process-query (merge {:type :internal
+ :fn (u/qualified-name query-type)}
+ additional-query-params)))))
+
+(defn- bad-table-total
+ "The `COUNT(*) OVER ()` total, surfaced as a top-level `:total_count` on the
+ bad-table response (0 when the filtered set is empty)."
+ [& args]
+ (:total_count (run-query ::queries/bad-table :args (vec args))))
+
+(deftest bad-table-total-count-test
+ (testing "bad-table carries a total_count matching the filtered set"
+ (mt/test-helpers-set-global-values!
+ (mt/with-temp [:model/Card {bad-card-id :id} {:name "Toucan card"}
+ :model/Card {ok-card-id :id} {:name "Sparrow card"}
+ :model/QueryExecution _ (merge query-execution-defaults
+ {:card_id bad-card-id
+ :executor_id (mt/user->id :crowberto)
+ :error "unique-broken-table-xyz not found"})
+ :model/QueryExecution _ (merge query-execution-defaults
+ {:card_id ok-card-id
+ :executor_id (mt/user->id :crowberto)
+ :started_at #t "2026-01-01T11:00:00Z"})]
+ (testing "an error filter matching only the erroring card"
+ (is (= 1 (bad-table-total "unique-broken-table-xyz" nil nil))))
+ (testing "an error filter matching nothing -> no rows -> total 0"
+ (is (= 0 (bad-table-total "no-such-error-substring-abc" nil nil))))
+ (testing "the total matches the number of returned rows"
+ (is (= (count (mt/rows (run-query ::queries/bad-table
+ :args ["unique-broken-table-xyz" nil nil])))
+ (bad-table-total "unique-broken-table-xyz" nil nil))))))))
+
+(deftest bad-table-search-term-matches-any-field-test
+ (testing "the single search term matches against question name, error text, db name, or collection name (OR, not AND)"
+ (mt/test-helpers-set-global-values!
+ (mt/with-temp [:model/Database {db-a :id} {:name "kingfisher-db-alpha"}
+ :model/Database {db-b :id} {:name "kingfisher-db-beta"}
+ :model/Collection {coll-a :id} {:name "Heron Collection Alpha"}
+ ;; two erroring cards sharing a unique error marker (so they can be
+ ;; isolated from any other erroring cards in the app DB) but living in
+ ;; different databases/collections
+ :model/Card {card-a :id} {:name "Sparrow Card Name Alpha"
+ :database_id db-a
+ :collection_id coll-a}
+ ;; null collection -> "Our Analytics" fallback, different database
+ :model/Card {card-b :id} {:name "Wren card B"
+ :database_id db-b}
+ :model/QueryExecution _ (merge query-execution-defaults
+ {:card_id card-a
+ :executor_id (mt/user->id :crowberto)
+ :error "shared-filter-marker-qq"})
+ :model/QueryExecution _ (merge query-execution-defaults
+ {:card_id card-b
+ :executor_id (mt/user->id :crowberto)
+ :started_at #t "2026-03-03T13:00:00Z"
+ :error "shared-filter-marker-qq"})]
+ (testing "a term matching the shared error text matches both cards"
+ (is (= 2 (bad-table-total "shared-filter-marker-qq" nil nil))))
+ (testing "a term matching only a question name reaches that field, not just error text"
+ (is (= 1 (bad-table-total "Sparrow Card Name Alpha" nil nil))))
+ (testing "a term matching only a db name reaches that field, not just error text"
+ (is (= 1 (bad-table-total "kingfisher-db-alpha" nil nil))))
+ (testing "a term matching only a collection name reaches that field too"
+ (is (= 1 (bad-table-total "Heron Collection Alpha" nil nil))))
+ (testing "the null-collection card is reachable via the Our Analytics fallback name"
+ ;; "Our Analytics" is a common fallback shared by every uncollected card in the
+ ;; app db, so unlike the other terms above this can't be isolated to an exact
+ ;; total; assert card-b is included in the results instead.
+ (let [rows (mt/rows (run-query ::queries/bad-table
+ :args ["Our Analytics" nil nil]))]
+ (is (contains? (set (map first rows)) card-b))))
+ (testing "a term shared by both db names matches both cards via the db-name field"
+ (is (= 2 (bad-table-total "kingfisher-db" nil nil))))))))
+
+(deftest bad-table-no-duplicate-cards-test
+ (testing "cards aren't duplicated when executions across cards share a started_at (latest_qe joins on card_id, not timestamp alone)"
+ (mt/test-helpers-set-global-values!
+ (let [shared-ts #t "2026-02-02T12:00:00Z"]
+ (mt/with-temp [:model/Card {erroring-id :id} {:name "Magpie collision card"}
+ :model/Card {healthy-id :id} {:name "Finch collision card"}
+ ;; both cards' latest run is at the SAME timestamp; only one errored
+ :model/QueryExecution _ (merge query-execution-defaults
+ {:card_id erroring-id
+ :executor_id (mt/user->id :crowberto)
+ :started_at shared-ts
+ :error "collision-error-marker-abc"})
+ :model/QueryExecution _ (merge query-execution-defaults
+ {:card_id healthy-id
+ :executor_id (mt/user->id :crowberto)
+ :started_at shared-ts})]
+ (let [rows (mt/rows (run-query ::queries/bad-table
+ :args ["collision-error-marker-abc" nil nil]))]
+ (testing "exactly one row, for the erroring card only (buggy join returns two)"
+ (is (= 1 (count rows)))
+ (is (= [erroring-id] (map first rows))))
+ (testing "and the total_count agrees"
+ (is (= 1 (bad-table-total "collision-error-marker-abc" nil nil))))))))))
diff --git a/enterprise/backend/test/metabase_enterprise/audit_app/pages_test.clj b/enterprise/backend/test/metabase_enterprise/audit_app/pages_test.clj
index 6e0a474d559..238879d2454 100644
--- a/enterprise/backend/test/metabase_enterprise/audit_app/pages_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/audit_app/pages_test.clj
@@ -108,9 +108,7 @@
:query-hash (codec/base64-encode (qp.util/query-hash {:database 1, :type :native}))
:query-string "toucans"
:question-filter "bird sales"
- :collection-filter "coin collection"
- :error-filter "a"
- :db-filter "PU"
+ :search-term "toucans"
:sort-column "card.id"
:sort-direction "desc"
:dashboard-name "wow"
@@ -152,9 +150,35 @@
{:limit 1
:type :internal,
:fn "metabase-enterprise.audit-app.pages.queries/bad-table",
- :args [nil nil nil "last_run_at" "desc"],
+ :args [nil "last_run_at" "desc"],
:offset 0,
:parameters []})]
(is (=? {:status "completed"
:row_count integer?}
response))))))
+
+(deftest bad-table-total-count-over-dataset-api-test
+ (testing "the bad-table :total_count survives the real streaming path over POST /api/dataset"
+ (mt/test-helpers-set-global-values!
+ (mt/with-premium-features #{:audit-app}
+ (mt/with-temp [:model/Card {bad-id :id} {:name "Toucan dataset card"}
+ :model/QueryExecution _ {:card_id bad-id
+ :executor_id (mt/user->id :crowberto)
+ :hash (qp.util/query-hash {})
+ :result_rows 0
+ :running_time 0
+ :native false
+ :started_at #t "2026-05-05T10:00:00Z"
+ :context :ad-hoc
+ :error "dataset-total-marker-uvw not found"}]
+ ;; a unique error marker isolates exactly one erroring card, so total_count is deterministic
+ (let [response (mt/user-http-request :crowberto :post 202
+ "dataset"
+ {:type :internal
+ :fn "metabase-enterprise.audit-app.pages.queries/bad-table"
+ :args ["dataset-total-marker-uvw" "last_run_at" "desc"]
+ :parameters []})]
+ (is (=? {:status "completed"
+ :row_count 1
+ :total_count 1}
+ response))))))))
diff --git a/enterprise/frontend/src/metabase-enterprise/api/advanced-permissions.ts b/enterprise/frontend/src/metabase-enterprise/api/advanced-permissions.ts
index 7ce770bb6b6..7175b0c1504 100644
--- a/enterprise/frontend/src/metabase-enterprise/api/advanced-permissions.ts
+++ b/enterprise/frontend/src/metabase-enterprise/api/advanced-permissions.ts
@@ -2,10 +2,10 @@ import type { DatabaseId, GroupId, Impersonation } from "metabase-types/api";
import { EnterpriseApi } from "./api";
-interface GetImpersonationRequest {
+type GetImpersonationRequest = {
db_id: DatabaseId;
group_id: GroupId;
-}
+};
export const advancedPermissionsApi = EnterpriseApi.injectEndpoints({
endpoints: (builder) => ({
diff --git a/enterprise/frontend/src/metabase-enterprise/api/dependencies.ts b/enterprise/frontend/src/metabase-enterprise/api/dependencies.ts
index a97f46b8bdd..4de3d88b00a 100644
--- a/enterprise/frontend/src/metabase-enterprise/api/dependencies.ts
+++ b/enterprise/frontend/src/metabase-enterprise/api/dependencies.ts
@@ -84,6 +84,9 @@ export const {
useGetDependencyGraphQuery,
useListNodeDependentsQuery,
useListBreakingGraphNodesQuery,
+ useLazyListBreakingGraphNodesQuery,
useListBrokenGraphNodesQuery,
+ useLazyListBrokenGraphNodesQuery,
useListUnreferencedGraphNodesQuery,
+ useLazyListUnreferencedGraphNodesQuery,
} = dependencyApi;
diff --git a/enterprise/frontend/src/metabase-enterprise/application_permissions/utils.ts b/enterprise/frontend/src/metabase-enterprise/application_permissions/utils.ts
index dbf2ce11620..7eb6c65da1b 100644
--- a/enterprise/frontend/src/metabase-enterprise/application_permissions/utils.ts
+++ b/enterprise/frontend/src/metabase-enterprise/application_permissions/utils.ts
@@ -9,7 +9,7 @@ const canAccessSettings = (user?: User) =>
export const monitoringPermissionAllowedPathGetter = (
user?: User,
-): AdminPathKey[] => (canAccessMonitoringItems(user) ? ["tools"] : []);
+): AdminPathKey[] => (canAccessMonitoringItems(user) ? ["help"] : []);
export const settingsPermissionAllowedPathGetter = (
user?: User,
diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/components/AuditParameters.jsx b/enterprise/frontend/src/metabase-enterprise/audit_app/components/AuditParameters.jsx
deleted file mode 100644
index 66135b8e808..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/audit_app/components/AuditParameters.jsx
+++ /dev/null
@@ -1,94 +0,0 @@
-import PropTypes from "prop-types";
-import { Component } from "react";
-import _ from "underscore";
-
-import { Box, Button, Group, Input, ScrollArea } from "metabase/ui";
-
-const DEBOUNCE_PERIOD = 300;
-
-const propTypes = {
- parameters: PropTypes.arrayOf(
- PropTypes.shape({
- key: PropTypes.string.isRequired,
- placeholder: PropTypes.string.isRequired,
- }),
- ),
- buttons: PropTypes.arrayOf(
- PropTypes.shape({
- key: PropTypes.string.isRequired,
- onClick: PropTypes.func.isRequired,
- label: PropTypes.string.isRequired,
- }),
- ),
- children: PropTypes.func,
- hasResults: PropTypes.bool,
-};
-
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default class AuditParameters extends Component {
- constructor(props) {
- super(props);
- this.state = {
- inputValues: {},
- committedValues: {},
- };
- }
-
- changeValue = (key, value) => {
- this.setState({
- inputValues: { ...this.state.inputValues, [key]: value },
- });
- this.commitValueDebounced(key, value);
- };
-
- commitValueDebounced = _.debounce((key, value) => {
- this.setState({
- committedValues: { ...this.state.committedValues, [key]: value },
- });
- }, DEBOUNCE_PERIOD);
-
- render() {
- const { parameters, children, buttons, hasResults } = this.props;
- const { inputValues, committedValues } = this.state;
-
- const isEmpty =
- hasResults === false &&
- inputValues &&
- Object.values(inputValues).every((v) => v === "");
-
- return (
- <Box>
- <div>
- <Group grow>
- {parameters.map(({ key, placeholder, icon, disabled }) => (
- <Input
- key={key}
- type="text"
- value={inputValues[key] || ""}
- placeholder={placeholder}
- disabled={isEmpty || disabled}
- onChange={(e) => {
- this.changeValue(key, e.target.value);
- }}
- icon={icon}
- />
- ))}
- {buttons?.map(({ key, label, disabled, onClick }) => (
- <Button
- key={key}
- variant="filled"
- disabled={isEmpty || disabled}
- onClick={onClick}
- >
- {label}
- </Button>
- ))}
- </Group>
- </div>
- <ScrollArea>{children && children(committedValues)}</ScrollArea>
- </Box>
- );
- }
-}
-
-AuditParameters.propTypes = propTypes;
diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/components/AuditTableVisualization/AuditTableVisualization.module.css b/enterprise/frontend/src/metabase-enterprise/audit_app/components/AuditTableVisualization/AuditTableVisualization.module.css
deleted file mode 100644
index e72f04192bb..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/audit_app/components/AuditTableVisualization/AuditTableVisualization.module.css
+++ /dev/null
@@ -1,24 +0,0 @@
-.headerCell {
- white-space: nowrap;
-}
-
-.sortable {
- cursor: pointer;
-
- &:hover {
- color: var(--mb-color-core-brand);
- }
-}
-
-.sortedByColumn {
- color: var(--mb-color-core-brand);
-}
-
-.rightAligned {
- text-align: right;
-}
-
-.clickable {
- color: var(--mb-color-core-brand);
- cursor: pointer;
-}
diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/components/AuditTableVisualization/index.ts b/enterprise/frontend/src/metabase-enterprise/audit_app/components/AuditTableVisualization/index.ts
deleted file mode 100644
index 051f85a144c..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/audit_app/components/AuditTableVisualization/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export * from "./AuditTableVisualization";
diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/containers/AuditTable.jsx b/enterprise/frontend/src/metabase-enterprise/audit_app/containers/AuditTable.jsx
deleted file mode 100644
index 161cb277156..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/audit_app/containers/AuditTable.jsx
+++ /dev/null
@@ -1,103 +0,0 @@
-import "../components/AuditTableVisualization";
-
-import { chain } from "icepick";
-import PropTypes from "prop-types";
-import { useState } from "react";
-import _ from "underscore";
-
-import { PaginationControls } from "metabase/common/components/PaginationControls";
-import { usePagination } from "metabase/common/hooks/use-pagination";
-import CS from "metabase/css/core/index.css";
-import { connect } from "metabase/redux";
-import { push } from "metabase/router";
-import { getMetadata } from "metabase/selectors/metadata";
-import { Flex } from "metabase/ui";
-import Question from "metabase-lib/v1/Question";
-
-import { AuditMode } from "../lib/mode";
-
-import S from "./AuditTable.module.css";
-import QuestionLoadAndDisplay from "./QuestionLoadAndDisplay";
-
-const mapStateToProps = (state) => ({
- metadata: getMetadata(state),
-});
-
-const DEFAULT_PAGE_SIZE = 100;
-
-AuditTable.propTypes = {
- metadata: PropTypes.object.isRequired,
- table: PropTypes.object.isRequired,
- pageSize: PropTypes.number.isRequired,
- reload: PropTypes.bool,
- children: PropTypes.node,
- dispatch: PropTypes.func.isRequired,
- onLoad: PropTypes.func,
- mode: PropTypes.shape({
- name: PropTypes.string.isRequired,
- drills: PropTypes.func.isRequired,
- }),
-};
-
-function AuditTable({
- metadata,
- table,
- pageSize = DEFAULT_PAGE_SIZE,
- mode = AuditMode,
- children,
- dispatch,
- onLoad,
- ...rest
-}) {
- const [loadedCount, setLoadedCount] = useState(0);
- const { handleNextPage, handlePreviousPage, page } = usePagination();
-
- const handleOnLoad = (results) => {
- setLoadedCount(results[0].row_count);
- onLoad?.(results);
- };
-
- const card = chain(table.card)
- .assoc("display", "audit-table")
- .assocIn(["dataset_query", "limit"], pageSize)
- .assocIn(["dataset_query", "offset"], pageSize * page)
- .value();
-
- const question = new Question(card, metadata);
- const shouldShowPagination = page > 0 || loadedCount === pageSize;
- const handleChangeLocation = (url) => dispatch(push(url));
-
- return (
- <div>
- <QuestionLoadAndDisplay
- keepPreviousWhileLoading
- className={CS.mt3}
- question={question}
- metadata={metadata}
- mode={mode}
- onChangeLocation={handleChangeLocation}
- onChangeCardAndRun={() => {}}
- onLoad={handleOnLoad}
- dispatch={dispatch}
- {...rest}
- />
-
- {shouldShowPagination && (
- <Flex justify="flex-end" pt="md" className={S.paginationControls}>
- <PaginationControls
- page={page}
- pageSize={pageSize}
- itemsLength={loadedCount}
- onNextPage={loadedCount === pageSize ? handleNextPage : null}
- onPreviousPage={handlePreviousPage}
- />
- </Flex>
- )}
-
- {children}
- </div>
- );
-}
-
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default _.compose(connect(mapStateToProps))(AuditTable);
diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/containers/AuditTable.module.css b/enterprise/frontend/src/metabase-enterprise/audit_app/containers/AuditTable.module.css
deleted file mode 100644
index 436c9784cf7..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/audit_app/containers/AuditTable.module.css
+++ /dev/null
@@ -1,3 +0,0 @@
-.paginationControls {
- border-top: 1px solid var(--mb-color-border-neutral);
-}
diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/containers/QuestionLoadAndDisplay.jsx b/enterprise/frontend/src/metabase-enterprise/audit_app/containers/QuestionLoadAndDisplay.jsx
deleted file mode 100644
index 294d060c680..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/audit_app/containers/QuestionLoadAndDisplay.jsx
+++ /dev/null
@@ -1,59 +0,0 @@
-import PropTypes from "prop-types";
-import { useEffect, useImperativeHandle, useRef } from "react";
-
-import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import { QuestionResultLoader } from "metabase/common/components/QuestionResultLoader";
-import Visualization from "metabase/visualizations/components/Visualization";
-
-const propTypes = {
- question: PropTypes.object,
- keepPreviousWhileLoading: PropTypes.bool,
- reload: PropTypes.bool,
- onLoad: PropTypes.func,
- reloadRef: PropTypes.shape({ current: PropTypes.func }),
-};
-
-const QuestionLoadAndDisplay = ({
- question,
- keepPreviousWhileLoading,
- reload,
- onLoad,
- reloadRef,
- ...props
-}) => {
- const reloadFnRef = useRef(null);
-
- useImperativeHandle(reloadRef, () => () => reloadFnRef.current?.());
-
- useEffect(() => {
- reload && reloadFnRef.current?.();
- }, [reload]);
-
- return (
- <QuestionResultLoader
- question={question}
- keepPreviousWhileLoading={keepPreviousWhileLoading}
- onLoad={onLoad}
- >
- {({ loading, error, reload, ...resultProps }) => {
- const shouldShowLoader = loading && resultProps.results == null;
- reloadFnRef.current = reload;
-
- return (
- <LoadingAndErrorWrapper
- loading={shouldShowLoader}
- error={error || resultProps?.result?.error}
- noWrapper
- >
- <Visualization {...props} {...resultProps} />
- </LoadingAndErrorWrapper>
- );
- }}
- </QuestionResultLoader>
- );
-};
-
-QuestionLoadAndDisplay.propTypes = propTypes;
-
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default QuestionLoadAndDisplay;
diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/lib/cards/queries.js b/enterprise/frontend/src/metabase-enterprise/audit_app/lib/cards/queries.js
deleted file mode 100644
index 07c76cebf80..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/audit_app/lib/cards/queries.js
+++ /dev/null
@@ -1,38 +0,0 @@
-export const bad_table = (
- errorFilter,
- dbFilter,
- collectionFilter,
- sortColumn,
- sortDirection,
-) => ({
- card: {
- name: "Failing Questions",
- display: "table",
- dataset_query: {
- type: "internal",
- fn: "metabase-enterprise.audit-app.pages.queries/bad-table",
- args: [
- errorFilter,
- dbFilter,
- collectionFilter,
- sortColumn,
- sortDirection,
- ],
- },
- visualization_settings: {
- "table.columns": [
- { name: "card_id", enabled: true },
- { name: "error_substr", enabled: true },
- { name: "collection_id", enabled: true },
- { name: "database_id", enabled: true },
- { name: "schema", enabled: true },
- { name: "table_id", enabled: true },
- { name: "last_run_at", enabled: true },
- { name: "total_runs", enabled: true },
- { name: "num_dashboards", enabled: true },
- { name: "user_id", enabled: true },
- { name: "updated_at", enabled: true },
- ],
- },
- },
-});
diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/lib/mode.js b/enterprise/frontend/src/metabase-enterprise/audit_app/lib/mode.js
deleted file mode 100644
index 77c8e1193b3..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/audit_app/lib/mode.js
+++ /dev/null
@@ -1,86 +0,0 @@
-import _ from "underscore";
-
-import { push } from "metabase/router";
-
-const getColumnName = (column) => column.remapped_to || column.name;
-
-const columnNameToUrl = {
- // No admin page for collections but still want to link to it
- collection_id: (value) => `/collection/${value}`,
- user_id: (value) => `/admin/audit/member/${value}`,
- creator_id: (value) => `/admin/audit/member/${value}`,
- viewed_by_id: (value) => `/admin/audit/member/${value}`,
- saved_by_id: (value) => `/admin/audit/member/${value}`,
- dashboard_id: (value) => `/admin/audit/dashboard/${value}`,
- card_id: (value) => `/admin/audit/question/${value}`,
- database_id: (value) => `/admin/audit/database/${value}`,
- // NOTE: disable schema links until schema detail is implemented
- // schema: value => `/admin/audit/schema/${value}`,
- table_id: (value) => `/admin/audit/table/${value}`,
- // NOTE: query_hash uses standard Base64 encoding which isn't URL safe so make sure to escape it
- query_hash: (value) =>
- `/admin/audit/query/${encodeURIComponent(String(value))}`,
- recipients: (_, clicked) => {
- const pulseIdIndex = clicked.origin.cols.findIndex(
- (col) => getColumnName(col) === "pulse_id",
- );
- const pulseId = clicked.origin.row[pulseIdIndex];
-
- return clicked.extraData.type === "subscription"
- ? `/admin/audit/subscriptions/subscriptions/${pulseId}/edit`
- : `/admin/audit/subscriptions/alerts/${pulseId}/edit`;
- },
-};
-
-const AuditDrill = ({ question, clicked }) => {
- if (!clicked) {
- return [];
- }
- const metricAndDimensions = [clicked].concat(clicked.dimensions || []);
-
- for (const { column, value } of metricAndDimensions) {
- if (column && columnNameToUrl[column.name] != null && value != null) {
- return [
- {
- name: "detail",
- title: `View this`,
- default: true,
- action() {
- const url = columnNameToUrl[column.name](value, clicked);
- return push(url);
- },
- },
- ];
- }
- }
-
- // NOTE: special case for showing query detail links for ad-hoc queries in the card id column
- const { column, origin } = clicked;
- if (origin && column && column.name === "card_id") {
- const queryHashColIndex = _.findIndex(
- origin.cols,
- (col) => col.name === "query_hash",
- );
- const value = origin.row[queryHashColIndex];
- if (value) {
- return [
- {
- name: "detail",
- title: `View this`,
- default: true,
- action() {
- return push(
- `/admin/audit/query/${encodeURIComponent(String(value))}`,
- );
- },
- },
- ];
- }
- }
- return [];
-};
-
-export const AuditMode = {
- name: "audit",
- clickActions: [AuditDrill],
-};
diff --git a/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/utils.ts b/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/utils.ts
index 89cfc279383..39f53fdd6ea 100644
--- a/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/utils.ts
+++ b/enterprise/frontend/src/metabase-enterprise/audit_app/metabot-analytics/components/ConversationsPage/utils.ts
@@ -1,7 +1,8 @@
import {
- type QueryParam,
type UrlStateConfig,
- getFirstParamValue,
+ parsePage,
+ parseSortColumn,
+ parseSortDirection,
} from "metabase/common/hooks/use-url-state";
import type { SortDirection } from "metabase-types/api";
@@ -31,8 +32,15 @@ export type UrlState = FilterUrlState & PageUrlState;
const pageUrlStateConfig: UrlStateConfig<PageUrlState> = {
parse: (query) => ({
page: parsePage(query.page),
- sort_column: parseSortColumn(query.sort_column),
- sort_direction: parseSortDirection(query.sort_direction),
+ sort_column: parseSortColumn(
+ query.sort_column,
+ CONVERSATION_SORT_COLUMNS,
+ DEFAULT_SORT_COLUMN,
+ ),
+ sort_direction: parseSortDirection(
+ query.sort_direction,
+ DEFAULT_SORT_DIRECTION,
+ ),
}),
serialize: ({ page, sort_column, sort_direction }) => ({
page: page === 0 ? undefined : String(page),
@@ -46,23 +54,3 @@ export const urlStateConfig: UrlStateConfig<UrlState> = mergeUrlStateConfig(
filterUrlStateConfig,
pageUrlStateConfig,
);
-
-function parsePage(param: QueryParam): number {
- const value = getFirstParamValue(param);
- const parsed = parseInt(value || "0", 10);
- return Number.isFinite(parsed) && parsed >= 0 ? parsed : 0;
-}
-
-function parseSortColumn(param: QueryParam): ConversationSortColumn {
- const value = getFirstParamValue(param);
- return value && isSortColumn(value) ? value : DEFAULT_SORT_COLUMN;
-}
-
-function isSortColumn(value: string): value is ConversationSortColumn {
- return CONVERSATION_SORT_COLUMNS.some((col) => col === value);
-}
-
-function parseSortDirection(param: QueryParam): SortDirection {
- const value = getFirstParamValue(param);
- return value === "asc" ? "asc" : DEFAULT_SORT_DIRECTION;
-}
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/index.ts b/enterprise/frontend/src/metabase-enterprise/dependencies/index.ts
index 023b8b3f6f2..0d2968b156c 100644
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/index.ts
+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/index.ts
@@ -4,10 +4,7 @@ import { hasPremiumFeature } from "metabase-enterprise/settings";
import { useGetDependenciesCount } from "./hooks/use-get-dependencies-count";
import { DependencyGraphPage } from "./pages/DependencyGraphPage";
-import {
- getDataStudioDependencyDiagnosticsRoutes,
- getDataStudioDependencyRoutes,
-} from "./routes";
+import { getDataStudioDependencyRoutes } from "./routes";
/**
* Initialize dependencies plugin features that depend on hasPremiumFeature.
@@ -17,8 +14,6 @@ export function initializePlugin() {
PLUGIN_DEPENDENCIES.isEnabled = true;
PLUGIN_DEPENDENCIES.getDataStudioDependencyRoutes =
getDataStudioDependencyRoutes;
- PLUGIN_DEPENDENCIES.getDataStudioDependencyDiagnosticsRoutes =
- getDataStudioDependencyDiagnosticsRoutes;
PLUGIN_DEPENDENCIES.DependencyGraphPage =
withRouteProps(DependencyGraphPage);
PLUGIN_DEPENDENCIES.useGetDependenciesCount = useGetDependenciesCount;
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/routes.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/routes.tsx
index 46d6a86089f..929d0017b2b 100644
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/routes.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/routes.tsx
@@ -1,35 +1,9 @@
-import { Route, redirect, withRouteProps } from "metabase/router";
-import {
- BrokenDependencyDiagnosticsPage,
- UnreferencedDependencyDiagnosticsPage,
-} from "metabase-enterprise/monitor/dependency-diagnostics/pages";
+import { Route, withRouteProps } from "metabase/router";
import { DependencyGraphPage } from "./pages/DependencyGraphPage";
const RoutedDependencyGraphPage = withRouteProps(DependencyGraphPage);
-const RoutedBrokenDependencyDiagnosticsPage = withRouteProps(
- BrokenDependencyDiagnosticsPage,
-);
-const RoutedUnreferencedDependencyDiagnosticsPage = withRouteProps(
- UnreferencedDependencyDiagnosticsPage,
-);
export function getDataStudioDependencyRoutes() {
return <Route index element={<RoutedDependencyGraphPage />} />;
}
-
-export function getDataStudioDependencyDiagnosticsRoutes() {
- return (
- <>
- <Route index element={redirect("broken")} />
- <Route
- path="broken"
- element={<RoutedBrokenDependencyDiagnosticsPage />}
- />
- <Route
- path="unreferenced"
- element={<RoutedUnreferencedDependencyDiagnosticsPage />}
- />
- </>
- );
-}
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DependencyDiagnostics.module.css b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DependencyDiagnostics.module.css
deleted file mode 100644
index 5780d690fe1..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DependencyDiagnostics.module.css
+++ /dev/null
@@ -1,7 +0,0 @@
-.main {
- overflow: hidden;
-}
-
-.resizing {
- user-select: none;
-}
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DependencyDiagnostics.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DependencyDiagnostics.tsx
index 1cf52cb0722..59534999b6a 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DependencyDiagnostics.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DependencyDiagnostics.tsx
@@ -1,14 +1,16 @@
-import { useDisclosure, useElementSize } from "@mantine/hooks";
-import cx from "classnames";
+import { useElementSize } from "@mantine/hooks";
import { useLayoutEffect, useState } from "react";
import { DelayedLoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper/DelayedLoadingAndErrorWrapper";
import { trackDependencyDiagnosticsEntitySelected } from "metabase/common/data-studio/analytics";
-import { Center, Flex, Stack } from "metabase/ui";
+import { useAbortableQuery } from "metabase/common/hooks/use-abortable-query";
+import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
+import { Sidebar } from "metabase/monitor/components/MonitorLayout/Sidebar";
+import { Center, Flex } from "metabase/ui";
import type * as Urls from "metabase/urls";
import {
- useListBreakingGraphNodesQuery,
- useListUnreferencedGraphNodesQuery,
+ useLazyListBreakingGraphNodesQuery,
+ useLazyListUnreferencedGraphNodesQuery,
} from "metabase-enterprise/api";
import { DEFAULT_INCLUDE_PERSONAL_COLLECTIONS } from "metabase-enterprise/dependencies/constants";
import type {
@@ -22,7 +24,6 @@ import {
} from "metabase-enterprise/dependencies/utils";
import type { DependencyEntry } from "metabase-types/api";
-import S from "./DependencyDiagnostics.module.css";
import { DiagnosticsFilterBar } from "./DiagnosticsFilterBar";
import { DiagnosticsHeader } from "./DiagnosticsHeader";
import { DiagnosticsPagination } from "./DiagnosticsPagination";
@@ -57,14 +58,12 @@ export function DependencyDiagnostics({
onParamsChange,
}: DependencyDiagnosticsProps) {
const { ref: containerRef, width: containerWidth } = useElementSize();
- const [isResizing, { open: startResizing, close: stopResizing }] =
- useDisclosure();
const [selectedEntry, setSelectedEntry] = useState<DependencyEntry>();
- const useListGraphNodesQuery =
+ const useLazyListGraphNodesQuery =
mode === "broken"
- ? useListBreakingGraphNodesQuery
- : useListUnreferencedGraphNodesQuery;
+ ? useLazyListBreakingGraphNodesQuery
+ : useLazyListUnreferencedGraphNodesQuery;
const {
page = 0,
@@ -80,7 +79,8 @@ export function DependencyDiagnostics({
isFetching: isFetchingNodes,
isLoading: isLoadingNodes,
error,
- } = useListGraphNodesQuery(
+ } = useAbortableQuery(
+ useLazyListGraphNodesQuery,
{
types: getDependencyTypes(groupTypes),
"card-types": getCardTypes(groupTypes),
@@ -166,13 +166,8 @@ export function DependencyDiagnostics({
};
return (
- <Flex
- className={cx({ [S.resizing]: isResizing })}
- ref={containerRef}
- h="100%"
- wrap="nowrap"
- >
- <Stack className={S.main} flex={1} px="3.5rem" pb="md" gap="md">
+ <Flex ref={containerRef} h="100%" wrap="nowrap">
+ <MonitorMain>
<DiagnosticsHeader />
<DiagnosticsFilterBar
mode={mode}
@@ -191,7 +186,9 @@ export function DependencyDiagnostics({
<DiagnosticsTable
nodes={nodes}
mode={mode}
+ page={page}
sortOptions={getSortOptions(params)}
+ isFetching={isFetching}
isLoading={isLoading}
onSelect={onRowClick}
onSortOptionsChange={handleSortOptionsChange}
@@ -205,16 +202,15 @@ export function DependencyDiagnostics({
onPageChange={handlePageChange}
/>
)}
- </Stack>
+ </MonitorMain>
{selectedNode != null && (
- <DiagnosticsSidebar
- node={selectedNode}
- mode={mode}
- containerWidth={containerWidth}
- onResizeStart={startResizing}
- onResizeStop={stopResizing}
- onClose={() => setSelectedEntry(undefined)}
- />
+ <Sidebar containerWidth={containerWidth}>
+ <DiagnosticsSidebar
+ node={selectedNode}
+ mode={mode}
+ onClose={() => setSelectedEntry(undefined)}
+ />
+ </Sidebar>
)}
</Flex>
);
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsHeader/DiagnosticsHeader.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsHeader/DiagnosticsHeader.tsx
index a79935749e0..394f22b38ad 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsHeader/DiagnosticsHeader.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsHeader/DiagnosticsHeader.tsx
@@ -1,16 +1,16 @@
import { memo } from "react";
import { t } from "ttag";
-import { DataStudioBreadcrumbs } from "metabase/common/data-studio/components/DataStudioBreadcrumbs";
import {
- PaneHeader,
- type PaneHeaderTab,
- PaneHeaderTabs,
-} from "metabase/common/data-studio/components/PaneHeader";
+ type MonitorHeaderTab,
+ MonitorHeaderTabs,
+} from "metabase/monitor/components/MonitorHeaderTabs";
+import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
+import { Stack } from "metabase/ui";
import * as Urls from "metabase/urls";
export const DiagnosticsHeader = memo(function DiagnosticsHeader() {
- const tabs: PaneHeaderTab[] = [
+ const tabs: MonitorHeaderTab[] = [
{
label: t`Broken dependencies`,
to: Urls.brokenDependencies(),
@@ -24,12 +24,9 @@ export const DiagnosticsHeader = memo(function DiagnosticsHeader() {
];
return (
- <PaneHeader
- breadcrumbs={
- <DataStudioBreadcrumbs>{t`Dependency diagnostics`}</DataStudioBreadcrumbs>
- }
- tabs={<PaneHeaderTabs tabs={tabs} />}
- py={0}
- />
+ <Stack gap="lg">
+ <MonitorHeaderTitle>{t`Dependency diagnostics`}</MonitorHeaderTitle>
+ <MonitorHeaderTabs tabs={tabs} />
+ </Stack>
);
});
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/BrokenDependentsSection/BrokenDependentsSection.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/BrokenDependentsSection/BrokenDependentsSection.tsx
index da4e7aa46c2..b74b355d2b9 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/BrokenDependentsSection/BrokenDependentsSection.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/BrokenDependentsSection/BrokenDependentsSection.tsx
@@ -1,8 +1,9 @@
import { useState } from "react";
import { trackDependencyEntitySelected } from "metabase/common/data-studio/analytics";
+import { useAbortableQuery } from "metabase/common/hooks/use-abortable-query";
import { Badge, Group, Loader, Stack, Title } from "metabase/ui";
-import { useListBrokenGraphNodesQuery } from "metabase-enterprise/api";
+import { useLazyListBrokenGraphNodesQuery } from "metabase-enterprise/api";
import { DependencyList } from "metabase-enterprise/dependencies/components/DependencyList";
import { FilterOptionsPicker } from "metabase-enterprise/dependencies/components/FilterOptionsPicker";
import { SortOptionsPicker } from "metabase-enterprise/dependencies/components/SortOptionsPicker";
@@ -48,7 +49,8 @@ export function BrokenDependentsSection({
getDefaultFilterOptions(),
);
- const { data: dependents = [], isFetching } = useListBrokenGraphNodesQuery(
+ const { data: dependents = [], isFetching } = useAbortableQuery(
+ useLazyListBrokenGraphNodesQuery,
getListRequest(node, filterOptions, sortOptions),
{
skip: count === 0,
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/DiagnosticsSidebar.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/DiagnosticsSidebar.tsx
index 24adbe4d982..9eca530bdb4 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/DiagnosticsSidebar.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/DiagnosticsSidebar.tsx
@@ -12,47 +12,34 @@ import { FieldsSection } from "./FieldsSection";
import { InfoSection } from "./InfoSection";
import { LocationSection } from "./LocationSection";
import { SidebarHeader } from "./SidebarHeader";
-import { SidebarResizableBox } from "./SidebarResizableBox";
type DiagnosticsSidebarProps = {
node: DependencyNode;
mode: DependencyDiagnosticsMode;
- containerWidth: number;
- onResizeStart: () => void;
- onResizeStop: () => void;
onClose: () => void;
};
export const DiagnosticsSidebar = memo(function DiagnosticsSidebar({
node,
mode,
- containerWidth,
- onResizeStart,
- onResizeStop,
onClose,
}: DiagnosticsSidebarProps) {
return (
- <SidebarResizableBox
- containerWidth={containerWidth}
- onResizeStart={onResizeStart}
- onResizeStop={onResizeStop}
+ <Stack
+ className={S.sidebar}
+ p="lg"
+ gap="xl"
+ bg="background_page-primary"
+ data-testid="dependency-list-sidebar"
>
- <Stack
- className={S.sidebar}
- p="lg"
- gap="xl"
- bg="background_page-primary"
- data-testid="dependency-list-sidebar"
- >
- <Stack gap="lg">
- <SidebarHeader node={node} onClose={onClose} mode={mode} />
- <LocationSection node={node} />
- <InfoSection node={node} />
- </Stack>
- {mode === "broken" && <ErrorsSection node={node} />}
- {mode === "broken" && <BrokenDependentsSection node={node} />}
- {mode === "unreferenced" && <FieldsSection node={node} />}
+ <Stack gap="lg">
+ <SidebarHeader node={node} onClose={onClose} mode={mode} />
+ <LocationSection node={node} />
+ <InfoSection node={node} />
</Stack>
- </SidebarResizableBox>
+ {mode === "broken" && <ErrorsSection node={node} />}
+ {mode === "broken" && <BrokenDependentsSection node={node} />}
+ {mode === "unreferenced" && <FieldsSection node={node} />}
+ </Stack>
);
});
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/DiagnosticsSidebar.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/DiagnosticsSidebar.unit.spec.tsx
index bbe16e40091..b4087ec81c7 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/DiagnosticsSidebar.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/DiagnosticsSidebar.unit.spec.tsx
@@ -23,29 +23,18 @@ function setup({
node = createMockCardDependencyNode(),
mode = "broken",
}: SetupOpts = {}) {
- const onResizeStart = jest.fn();
- const onResizeStop = jest.fn();
const onClose = jest.fn();
setupListBrokenGraphNodesEndpoint([]);
renderWithProviders(
<Route
path="/"
- element={
- <DiagnosticsSidebar
- node={node}
- mode={mode}
- containerWidth={1000}
- onResizeStart={onResizeStart}
- onResizeStop={onResizeStop}
- onClose={onClose}
- />
- }
+ element={<DiagnosticsSidebar node={node} mode={mode} onClose={onClose} />}
/>,
{ withRouter: true, initialRoute: "/" },
);
- return { onResizeStart, onResizeStop, onClose };
+ return { onClose };
}
describe("DiagnosticsSidebar", () => {
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsTable/DiagnosticsTable.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsTable/DiagnosticsTable.tsx
index 398c1f64996..28bfdc681da 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsTable/DiagnosticsTable.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsTable/DiagnosticsTable.tsx
@@ -1,31 +1,35 @@
import type { Row, SortingState, Updater } from "@tanstack/react-table";
import { useCallback, useMemo } from "react";
+import { useScrollToTop } from "metabase/common/hooks";
import {
Card,
TreeTable,
TreeTableSkeleton,
useTreeTableInstance,
} from "metabase/ui";
+import {
+ getNextOptionalSorting,
+ getSortingState,
+} from "metabase/utils/sorting";
import type { DependencySortOptions } from "metabase-enterprise/dependencies/types";
import { getNodeId } from "metabase-enterprise/dependencies/utils";
-import type { DependencyNode } from "metabase-types/api";
+import {
+ DEPENDENCY_SORT_COLUMNS,
+ type DependencyNode,
+} from "metabase-types/api";
import { DiagnosticsEmptyState } from "../DiagnosticsEmptyState";
import type { DependencyDiagnosticsMode } from "../types";
-import {
- getColumnWidths,
- getColumns,
- getNotFoundMessage,
- getSortingOptions,
- getSortingState,
-} from "./utils";
+import { getColumnWidths, getColumns, getNotFoundMessage } from "./utils";
type DiagnosticsTableProps = {
nodes: DependencyNode[];
mode: DependencyDiagnosticsMode;
+ page: number;
sortOptions: DependencySortOptions | undefined;
+ isFetching?: boolean;
isLoading?: boolean;
onSelect: (node: DependencyNode) => void;
onSortOptionsChange: (sortOptions: DependencySortOptions | undefined) => void;
@@ -34,7 +38,9 @@ type DiagnosticsTableProps = {
export const DiagnosticsTable = function DiagnosticsTable({
nodes,
mode,
+ page,
sortOptions,
+ isFetching = false,
isLoading = false,
onSelect,
onSortOptionsChange,
@@ -54,7 +60,9 @@ export const DiagnosticsTable = function DiagnosticsTable({
(updater: Updater<SortingState>) => {
const newSortingState =
typeof updater === "function" ? updater(sortingState) : updater;
- onSortOptionsChange(getSortingOptions(newSortingState));
+ onSortOptionsChange(
+ getNextOptionalSorting(newSortingState, DEPENDENCY_SORT_COLUMNS),
+ );
},
[sortingState, onSortOptionsChange],
);
@@ -69,6 +77,12 @@ export const DiagnosticsTable = function DiagnosticsTable({
onSortingChange: handleSortingChange,
});
+ useScrollToTop({
+ ref: treeTableInstance.containerRef,
+ keys: [page, sortOptions],
+ skip: isFetching,
+ });
+
return (
<Card
flex="0 1 auto"
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsTable/utils.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsTable/utils.tsx
index 68a9d0eb30f..79ae85ce7fa 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsTable/utils.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsTable/utils.tsx
@@ -1,4 +1,3 @@
-import type { SortingState } from "@tanstack/react-table";
import { t } from "ttag";
import {
@@ -7,8 +6,6 @@ import {
getLocationColumn,
getNameColumn,
} from "metabase-enterprise/dependencies/components/DependencyTable";
-import type { DependencySortOptions } from "metabase-enterprise/dependencies/types";
-import { DEPENDENCY_SORT_COLUMNS } from "metabase-types/api";
import type { DependencyDiagnosticsMode } from "../types";
@@ -29,33 +26,6 @@ export function getColumnWidths(mode: DependencyDiagnosticsMode): number[] {
}
}
-export function getSortingState(
- sortOptions: DependencySortOptions | undefined,
-): SortingState {
- return sortOptions?.column != null
- ? [{ id: sortOptions.column, desc: sortOptions.direction === "desc" }]
- : [];
-}
-
-export function getSortingOptions(
- sortingState: SortingState,
-): DependencySortOptions | undefined {
- if (sortingState.length === 0) {
- return undefined;
- }
-
- const { id, desc } = sortingState[0];
- const column = DEPENDENCY_SORT_COLUMNS.find((column) => column === id);
- if (column == null) {
- return undefined;
- }
-
- return {
- column,
- direction: desc ? "desc" : "asc",
- };
-}
-
export function getNotFoundMessage(mode: DependencyDiagnosticsMode) {
return mode === "broken"
? t`No broken dependencies found`
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/index.ts b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/index.ts
new file mode 100644
index 00000000000..bacecb68e32
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/index.ts
@@ -0,0 +1,12 @@
+import { PLUGIN_MONITOR } from "metabase/plugins";
+import { hasPremiumFeature } from "metabase-enterprise/settings";
+
+import { getDependencyDiagnosticsRoutes } from "./routes";
+
+export function initializePlugin() {
+ if (hasPremiumFeature("dependencies")) {
+ PLUGIN_MONITOR.isDependencyDiagnosticsEnabled = true;
+ PLUGIN_MONITOR.getDependencyDiagnosticsRoutes =
+ getDependencyDiagnosticsRoutes;
+ }
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/index.unit.spec.ts b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/index.unit.spec.ts
new file mode 100644
index 00000000000..be583c59be1
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/index.unit.spec.ts
@@ -0,0 +1,61 @@
+import { PLUGIN_MONITOR, reinitialize } from "metabase/plugins";
+import { hasPremiumFeature } from "metabase-enterprise/settings";
+
+import { getDependencyDiagnosticsRoutes } from "./routes";
+
+import { initializePlugin } from "./index";
+
+jest.mock("metabase-enterprise/settings", () => ({
+ hasPremiumFeature: jest.fn(),
+}));
+
+// jest.mock replaces the module factory; retype the import as its mock
+const mockHasPremiumFeature = hasPremiumFeature as jest.MockedFunction<
+ typeof hasPremiumFeature
+>;
+
+const mockDependenciesFeature = (enabled: boolean) => {
+ mockHasPremiumFeature.mockImplementation((feature) =>
+ feature === "dependencies" ? enabled : false,
+ );
+};
+
+describe("metabase-enterprise/monitor/dependency-diagnostics initializePlugin", () => {
+ afterEach(() => {
+ jest.clearAllMocks();
+ reinitialize();
+ });
+
+ it("enables dependency diagnostics when the dependencies feature is present", () => {
+ mockDependenciesFeature(true);
+
+ initializePlugin();
+
+ expect(PLUGIN_MONITOR.isDependencyDiagnosticsEnabled).toBe(true);
+ expect(PLUGIN_MONITOR.getDependencyDiagnosticsRoutes).toBe(
+ getDependencyDiagnosticsRoutes,
+ );
+ expect(PLUGIN_MONITOR.getDependencyDiagnosticsRoutes()).not.toBeNull();
+ });
+
+ it("leaves the OSS defaults when the dependencies feature is absent", () => {
+ mockDependenciesFeature(false);
+
+ initializePlugin();
+
+ expect(PLUGIN_MONITOR.isDependencyDiagnosticsEnabled).toBe(false);
+ expect(PLUGIN_MONITOR.getDependencyDiagnosticsRoutes()).toBeNull();
+ });
+
+ it("resets dependency diagnostics state on reinitialize()", () => {
+ mockDependenciesFeature(true);
+ initializePlugin();
+
+ expect(PLUGIN_MONITOR.isDependencyDiagnosticsEnabled).toBe(true);
+
+ reinitialize();
+
+ expect(PLUGIN_MONITOR.isDependencyDiagnosticsEnabled).toBe(false);
+ expect(PLUGIN_MONITOR.getDependencyDiagnosticsRoutes()).toBeNull();
+ });
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/pages/DependencyDiagnosticsPage.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/pages/DependencyDiagnosticsPage.unit.spec.tsx
index 9c238732f95..5b5172e2bb0 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/pages/DependencyDiagnosticsPage.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/pages/DependencyDiagnosticsPage.unit.spec.tsx
@@ -11,6 +11,7 @@ import {
screen,
within,
} from "__support__/ui";
+import { MonitorContent } from "metabase/monitor/components/MonitorLayout/MonitorContent";
import { Route, withRouteProps } from "metabase/router";
import type * as Urls from "metabase/urls";
import type { DependencyDiagnosticsMode } from "metabase-enterprise/monitor/dependency-diagnostics/components/types";
@@ -89,7 +90,14 @@ function setup({
);
const { history } = renderWithProviders(
- <Route path={getPageUrl(mode, {})} element={<PageComponent />} />,
+ <Route
+ path={getPageUrl(mode, {})}
+ element={
+ <MonitorContent>
+ <PageComponent />
+ </MonitorContent>
+ }
+ />,
{
withRouter: true,
initialRoute: getPageUrl(mode, urlParams),
@@ -127,6 +135,16 @@ describe("DependencyDiagnosticsPage", () => {
expect(await within(list).findByText("Question 1")).toBeInTheDocument();
expect(await within(list).findByText("Question 2")).toBeInTheDocument();
});
+
+ it("renders selected row details in the Monitor sidebar outlet", async () => {
+ setup({ nodes: CARD_NODES });
+
+ const list = await screen.findByRole("treegrid");
+ await userEvent.click(await within(list).findByText("Question 1"));
+
+ const sidebarRegion = await screen.findByTestId("monitor-sidebar-region");
+ expect(sidebarRegion).toHaveTextContent("Question 1");
+ });
});
describe("URL parameters", () => {
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/routes.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/routes.tsx
new file mode 100644
index 00000000000..ff85298f94f
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/routes.tsx
@@ -0,0 +1,29 @@
+import { Route, redirect, withRouteProps } from "metabase/router";
+
+import {
+ BrokenDependencyDiagnosticsPage,
+ UnreferencedDependencyDiagnosticsPage,
+} from "./pages";
+
+const RoutedBrokenDependencyDiagnosticsPage = withRouteProps(
+ BrokenDependencyDiagnosticsPage,
+);
+const RoutedUnreferencedDependencyDiagnosticsPage = withRouteProps(
+ UnreferencedDependencyDiagnosticsPage,
+);
+
+export function getDependencyDiagnosticsRoutes() {
+ return (
+ <>
+ <Route index element={redirect("broken")} />
+ <Route
+ path="broken"
+ element={<RoutedBrokenDependencyDiagnosticsPage />}
+ />
+ <Route
+ path="unreferenced"
+ element={<RoutedUnreferencedDependencyDiagnosticsPage />}
+ />
+ </>
+ );
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview.tsx
deleted file mode 100644
index 46135f939de..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview.tsx
+++ /dev/null
@@ -1,145 +0,0 @@
-import { useRef, useState } from "react";
-import { t } from "ttag";
-
-import {
- SettingsPageWrapper,
- SettingsSection,
-} from "metabase/admin/components/SettingsSection";
-import { useLazyGetCardQueryQuery } from "metabase/api";
-import CS from "metabase/css/core/index.css";
-import { fetchDataOrError } from "metabase/dashboard/utils";
-import AuditParameters from "metabase-enterprise/audit_app/components/AuditParameters";
-import AuditTable from "metabase-enterprise/audit_app/containers/AuditTable";
-import * as Queries from "metabase-enterprise/audit_app/lib/cards/queries";
-
-import { ErrorMode } from "./mode";
-
-type Sorting = {
- column: string;
- isAscending: boolean;
-};
-
-type AuditFilters = {
- errorFilter: string;
- dbFilter: string;
- collectionFilter: string;
-};
-
-type AllSelectEvent = {
- rows: unknown[][];
-};
-
-type RowSelectEvent = {
- row: unknown[];
-};
-
-type AuditResult = { row_count: number }[];
-
-const getSortOrder = (isAscending: boolean) => (isAscending ? "asc" : "desc");
-
-const CARD_ID_COL = 0;
-
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default function ErrorOverview(props: Record<string, unknown>) {
- const [runCardQuery] = useLazyGetCardQueryQuery();
- const reloadRef = useRef<(() => void) | null>(null);
- // TODO: use isReloading to display a loading overlay
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
- const [isReloading, setIsReloading] = useState(false);
- const [hasResults, setHasResults] = useState(false);
- const [sorting, setSorting] = useState<Sorting>({
- column: "last_run_at",
- isAscending: false,
- });
-
- const [rowChecked, setRowChecked] = useState<Record<string, boolean>>({});
-
- const handleAllSelectClick = (e: AllSelectEvent) => {
- const newRowChecked = { ...rowChecked };
- const noRowChecked = Object.values(rowChecked).every((v) => !v);
- for (const row of e.rows) {
- const cardIndex = String(row[CARD_ID_COL]);
- newRowChecked[cardIndex] = noRowChecked;
- }
- setRowChecked(newRowChecked);
- };
-
- const handleRowSelectClick = (e: RowSelectEvent) => {
- const newRowChecked = { ...rowChecked };
- const cardIndex = String(e.row[CARD_ID_COL]);
- newRowChecked[cardIndex] = !rowChecked[cardIndex];
- setRowChecked(newRowChecked);
- };
-
- const handleReloadSelected = async () => {
- const checkedCardIds = Object.keys(rowChecked).filter(
- (id) => rowChecked[id],
- );
-
- await Promise.all(
- checkedCardIds.map((member) =>
- fetchDataOrError(runCardQuery({ cardId: Number(member) }).unwrap()),
- ),
- );
- setRowChecked({});
- setIsReloading(true);
- reloadRef.current?.();
- };
-
- const handleSortingChange = (sorting: Sorting) => setSorting(sorting);
-
- const handleLoad = (result: AuditResult) => {
- setHasResults(result[0].row_count !== 0);
- setIsReloading(false);
- };
-
- return (
- <SettingsPageWrapper title={t`Questions that errored when last run`}>
- <SettingsSection>
- <AuditParameters
- parameters={[
- { key: "errorFilter", placeholder: t`Error contents` },
- { key: "dbFilter", placeholder: t`DB name` },
- { key: "collectionFilter", placeholder: t`Collection name` },
- ]}
- buttons={[
- {
- key: "reloadSelected",
- label: t`Rerun Selected`,
- disabled: Object.values(rowChecked).every(
- (isChecked) => !isChecked,
- ),
- onClick: handleReloadSelected,
- },
- ]}
- hasResults={hasResults}
- >
- {({ errorFilter, dbFilter, collectionFilter }: AuditFilters) => (
- <AuditTable
- {...props}
- reloadRef={reloadRef}
- pageSize={50}
- isSortable
- isSelectable
- rowChecked={rowChecked}
- sorting={sorting}
- onSortingChange={handleSortingChange}
- onAllSelectClick={handleAllSelectClick}
- onRowSelectClick={handleRowSelectClick}
- onLoad={handleLoad}
- mode={ErrorMode}
- table={Queries.bad_table(
- errorFilter,
- dbFilter,
- collectionFilter,
- sorting.column,
- getSortOrder(sorting.isAscending),
- )}
- className={CS.mt2}
- />
- )}
- </AuditParameters>
- </SettingsSection>
- </SettingsPageWrapper>
- );
-}
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErrorOverview.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErrorOverview.tsx
new file mode 100644
index 00000000000..beb46702255
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErrorOverview.tsx
@@ -0,0 +1,197 @@
+import type { RowSelectionState } from "@tanstack/react-table";
+import { useEffect, useMemo, useRef, useState } from "react";
+import { msgid, ngettext, t } from "ttag";
+
+import {
+ useLazyGetAdhocQueryQuery,
+ useLazyGetCardQueryQuery,
+} from "metabase/api";
+import {
+ BulkActionBar,
+ BulkActionButton,
+} from "metabase/common/components/BulkActionBar";
+import { DelayedLoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper/DelayedLoadingAndErrorWrapper";
+import { PaginationControls } from "metabase/common/components/PaginationControls";
+import { useAbortableQuery } from "metabase/common/hooks/use-abortable-query";
+import { useUrlState } from "metabase/common/hooks/use-url-state";
+import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
+import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
+import { useRouter } from "metabase/router";
+import { Center, Flex } from "metabase/ui";
+import type { CardId } from "metabase-types/api";
+
+import { ErroringQuestionsSearch } from "./ErroringQuestionsSearch";
+import { ErroringQuestionsTable } from "./ErroringQuestionsTable";
+import type {
+ ErroringQuestionsFilters,
+ ErroringQuestionsSorting,
+} from "./types";
+import {
+ DEFAULT_FILTERS,
+ DEFAULT_SORTING,
+ PAGE_SIZE,
+ getErroringQuestions,
+ getErroringQuestionsQuery,
+ urlStateConfig,
+} from "./utils";
+
+export const ErrorOverview = () => {
+ const { location } = useRouter();
+ const [{ page }, { patchUrlState }] = useUrlState(location, urlStateConfig);
+ const [filters, setFilters] =
+ useState<ErroringQuestionsFilters>(DEFAULT_FILTERS);
+ const [sorting, setSorting] =
+ useState<ErroringQuestionsSorting>(DEFAULT_SORTING);
+ const [rowSelection, setRowSelection] = useState<RowSelectionState>({});
+ const [rerunningCardIds, setRerunningCardIds] = useState<Set<CardId>>(
+ () => new Set(),
+ );
+
+ const query = useMemo(
+ () => getErroringQuestionsQuery(filters, sorting, page),
+ [filters, sorting, page],
+ );
+ const { data, error, isFetching, isLoading, refetch } = useAbortableQuery(
+ useLazyGetAdhocQueryQuery,
+ query,
+ );
+ const [runCardQuery] = useLazyGetCardQueryQuery();
+
+ const cards = useMemo(
+ () => (data == null ? [] : getErroringQuestions(data)),
+ [data],
+ );
+ const total = data?.total_count ?? 0;
+ const pageError = error ?? data?.error;
+
+ const selectedCardIds = Object.entries(rowSelection)
+ .filter(([, isSelected]) => isSelected)
+ .map(([cardId]) => Number(cardId));
+
+ const handleFiltersChange = (
+ newFilters: Partial<ErroringQuestionsFilters>,
+ ) => {
+ setFilters((filters) => ({ ...filters, ...newFilters }));
+ setRowSelection({});
+ patchUrlState({ page: 0 });
+ };
+
+ const handleSortingChange = (newSorting: ErroringQuestionsSorting) => {
+ setSorting(newSorting);
+ setRowSelection({});
+ patchUrlState({ page: 0 });
+ };
+
+ const handlePageChange = (nextPage: number) => {
+ setRowSelection({});
+ patchUrlState({ page: nextPage });
+ };
+
+ // A stale/shrunk `?page=N` can point past the result set: the backend returns
+ // no rows and a total of 0, which hides the pagination controls and strands
+ // the user on an empty page. Once the query settles, recover to the first page.
+ const isStrandedPage =
+ !isFetching && pageError == null && cards.length === 0 && page > 0;
+ useEffect(() => {
+ if (isStrandedPage) {
+ patchUrlState({ page: 0 });
+ }
+ }, [isStrandedPage, patchUrlState]);
+
+ // Refresh the list once the last queued rerun settles: questions that now
+ // succeed drop off, ones that still error stay.
+ const wasRerunningRef = useRef(false);
+ useEffect(() => {
+ const isRerunning = rerunningCardIds.size > 0;
+ if (wasRerunningRef.current && !isRerunning) {
+ refetch();
+ }
+ wasRerunningRef.current = isRerunning;
+ }, [rerunningCardIds, refetch]);
+
+ const handleRerunSelected = () => {
+ const cardIds = selectedCardIds;
+ setRerunningCardIds((prev) => new Set([...prev, ...cardIds]));
+ // Close the bulk bar immediately and don't block: reruns proceed in the
+ // background so other questions can be queued while slow ones run.
+ setRowSelection({});
+ cardIds.forEach((cardId) => {
+ runCardQuery({ cardId })
+ .unwrap()
+ // a failed rerun is reflected by the question staying in the list
+ .catch(() => undefined)
+ .finally(() => {
+ setRerunningCardIds((prev) => {
+ const next = new Set(prev);
+ next.delete(cardId);
+ return next;
+ });
+ });
+ });
+ };
+
+ return (
+ <>
+ <Flex h="100%" wrap="nowrap">
+ <MonitorMain>
+ <MonitorHeaderTitle mb="sm">{t`Erroring questions`}</MonitorHeaderTitle>
+
+ <ErroringQuestionsSearch
+ hasLoader={isFetching && !isLoading}
+ onFiltersChange={handleFiltersChange}
+ />
+
+ {pageError != null ? (
+ <Center flex={1}>
+ <DelayedLoadingAndErrorWrapper
+ loading={isFetching}
+ error={pageError}
+ />
+ </Center>
+ ) : (
+ <>
+ <ErroringQuestionsTable
+ cards={cards}
+ isFetching={isFetching}
+ isLoading={isLoading}
+ page={page}
+ sorting={sorting}
+ rowSelection={rowSelection}
+ rerunningCardIds={rerunningCardIds}
+ onSortingChange={handleSortingChange}
+ onRowSelectionChange={setRowSelection}
+ />
+
+ {!isLoading && (
+ <Flex justify="end">
+ <PaginationControls
+ page={page}
+ pageSize={PAGE_SIZE}
+ itemsLength={cards.length}
+ total={total}
+ showTotal
+ onPreviousPage={() => handlePageChange(page - 1)}
+ onNextPage={() => handlePageChange(page + 1)}
+ />
+ </Flex>
+ )}
+ </>
+ )}
+ </MonitorMain>
+ </Flex>
+
+ <BulkActionBar
+ opened={selectedCardIds.length > 0}
+ message={ngettext(
+ msgid`${selectedCardIds.length} question selected`,
+ `${selectedCardIds.length} questions selected`,
+ selectedCardIds.length,
+ )}
+ >
+ <BulkActionButton
+ onClick={handleRerunSelected}
+ >{t`Rerun selected`}</BulkActionButton>
+ </BulkActionBar>
+ </>
+ );
+};
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErrorOverview.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErrorOverview.unit.spec.tsx
new file mode 100644
index 00000000000..b51eeda83cf
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErrorOverview.unit.spec.tsx
@@ -0,0 +1,649 @@
+import userEvent from "@testing-library/user-event";
+import fetchMock from "fetch-mock";
+
+import {
+ act,
+ fireEvent,
+ mockGetBoundingClientRect,
+ renderWithProviders,
+ screen,
+ waitFor,
+ within,
+} from "__support__/ui";
+import { URL_UPDATE_DEBOUNCE_DELAY } from "metabase/common/hooks/use-url-state";
+import { Route } from "metabase/router";
+import type { RowValue } from "metabase-types/api";
+import {
+ createMockColumn,
+ createMockDataset,
+ createMockDatasetData,
+} from "metabase-types/api/mocks";
+
+import { ErrorOverview } from "./ErrorOverview";
+import { createMockErroringCard } from "./mocks";
+import { type ErroringCard, SORT_COLUMNS } from "./types";
+import { PAGE_SIZE } from "./utils";
+
+const COLUMN_NAMES = ["card_id", ...SORT_COLUMNS];
+const SEARCH_PLACEHOLDER = "Search by question, error, database, or collection";
+
+function createDatasetResponse(cards: Partial<ErroringCard>[], total?: number) {
+ const fullCards = cards.map(createMockErroringCard);
+ const rows: RowValue[][] = fullCards.map((card) => [
+ card.id,
+ card.card_name,
+ card.error_substr,
+ card.collection_name,
+ card.database_name,
+ card.schema_name,
+ card.table_name,
+ card.last_run_at,
+ card.total_runs,
+ card.num_dashboards,
+ card.user_name,
+ card.updated_at,
+ ]);
+
+ return {
+ ...createMockDataset({
+ data: createMockDatasetData({
+ cols: COLUMN_NAMES.map((name) => createMockColumn({ name })),
+ rows,
+ }),
+ row_count: rows.length,
+ }),
+ total_count: total ?? cards.length,
+ };
+}
+
+const getDatasetCalls = () => fetchMock.callHistory.calls("path:/api/dataset");
+
+async function getLastDatasetQuery() {
+ const calls = getDatasetCalls();
+ const call = calls[calls.length - 1];
+ return JSON.parse(String(await call.options.body));
+}
+
+type SetupOpts = {
+ cards?: Partial<ErroringCard>[];
+ total?: number;
+ error?: boolean;
+ initialRoute?: string;
+ deferResponse?: boolean;
+};
+
+async function setup({
+ cards = [{ id: 1 }],
+ total,
+ error,
+ initialRoute = "/",
+ deferResponse = false,
+}: SetupOpts = {}) {
+ mockGetBoundingClientRect({ width: 100, height: 100 });
+
+ let resolveResponse:
+ | ((response: ReturnType<typeof createDatasetResponse>) => void)
+ | undefined;
+ if (error) {
+ fetchMock.post("path:/api/dataset", {
+ status: 500,
+ body: { message: "Audit query failed" },
+ });
+ } else if (deferResponse) {
+ const response = new Promise<ReturnType<typeof createDatasetResponse>>(
+ (resolve) => {
+ resolveResponse = resolve;
+ },
+ );
+ fetchMock.post("path:/api/dataset", () => response);
+ } else {
+ fetchMock.post("path:/api/dataset", createDatasetResponse(cards, total));
+ }
+
+ const utils = renderWithProviders(
+ <Route path="/" element={<ErrorOverview />} />,
+ { withRouter: true, initialRoute },
+ );
+
+ if (!error) {
+ await waitFor(() => {
+ expect(getDatasetCalls().length).toBeGreaterThan(0);
+ });
+ }
+
+ return {
+ ...utils,
+ resolveResponse: () =>
+ resolveResponse?.(createDatasetResponse(cards, total)),
+ };
+}
+
+describe("ErrorOverview", () => {
+ it("fetches the audit bad-table query with default sorting and renders the results", async () => {
+ await setup({
+ cards: [
+ {
+ id: 1,
+ card_name: "Broken question",
+ error_substr: "Table not found...",
+ },
+ ],
+ });
+
+ const query = await getLastDatasetQuery();
+ expect(query.type).toBe("internal");
+ expect(query.fn).toBe(
+ "metabase-enterprise.audit-app.pages.queries/bad-table",
+ );
+ expect(query.args).toEqual(["", "last_run_at", "desc"]);
+ expect(query.limit).toBe(PAGE_SIZE);
+ expect(query.offset).toBe(0);
+ // the QP schema rejects an explicit null database; the key must be absent
+ expect("database" in query).toBe(false);
+
+ const row = await screen.findByTestId("erroring-question");
+ expect(within(row).getByText("Broken question")).toBeInTheDocument();
+ expect(within(row).getByText("Table not found...")).toBeInTheDocument();
+ expect(within(row).getByText("Our Analytics")).toBeInTheDocument();
+ expect(within(row).getByText("Sample Database")).toBeInTheDocument();
+
+ expect(getDatasetCalls()).toHaveLength(1);
+ expect(
+ screen.queryByRole("navigation", { name: "pagination" }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("shows an empty state when there are no erroring questions", async () => {
+ await setup({ cards: [] });
+
+ expect(await screen.findByText("No results")).toBeInTheDocument();
+ });
+
+ it("shows the error message when the audit query fails, keeping the search mounted", async () => {
+ await setup({ error: true });
+
+ expect(await screen.findByText("Audit query failed")).toBeInTheDocument();
+ expect(screen.getByPlaceholderText(SEARCH_PLACEHOLDER)).toBeInTheDocument();
+ expect(
+ screen.queryByTestId("erroring-questions-table"),
+ ).not.toBeInTheDocument();
+ });
+
+ it("recovers from an error when the search changes and the retry succeeds", async () => {
+ mockGetBoundingClientRect({ width: 100, height: 100 });
+
+ let shouldFail = true;
+ fetchMock.post("path:/api/dataset", () =>
+ shouldFail
+ ? { status: 500, body: { message: "Audit query failed" } }
+ : createDatasetResponse([{ id: 1, card_name: "Recovered question" }]),
+ );
+
+ renderWithProviders(<Route path="/" element={<ErrorOverview />} />, {
+ withRouter: true,
+ });
+
+ expect(await screen.findByText("Audit query failed")).toBeInTheDocument();
+ const search = screen.getByPlaceholderText(SEARCH_PLACEHOLDER);
+
+ // changing the query is the only way to clear RTK's error and refire
+ shouldFail = false;
+ await userEvent.type(search, "recovered");
+
+ expect(await screen.findByText("Recovered question")).toBeInTheDocument();
+ expect(screen.queryByText("Audit query failed")).not.toBeInTheDocument();
+ });
+
+ it("surfaces an internal-query error returned in the dataset body", async () => {
+ mockGetBoundingClientRect({ width: 100, height: 100 });
+ // the /api/dataset call succeeds at the HTTP layer but the internal audit
+ // query failed - dataset.error is present.
+ fetchMock.post(
+ "path:/api/dataset",
+ createMockDataset({
+ status: "failed",
+ error: "Internal audit query blew up",
+ }),
+ );
+
+ renderWithProviders(<Route path="/" element={<ErrorOverview />} />, {
+ withRouter: true,
+ });
+
+ expect(
+ await screen.findByText("Internal audit query blew up"),
+ ).toBeInTheDocument();
+ // the search stays mounted so the user has a recovery path
+ expect(screen.getByPlaceholderText(SEARCH_PLACEHOLDER)).toBeInTheDocument();
+ expect(
+ screen.queryByTestId("erroring-questions-table"),
+ ).not.toBeInTheDocument();
+ });
+
+ it("passes filter values to the query and resets to the first page", async () => {
+ const { history } = await setup({
+ cards: Array.from({ length: PAGE_SIZE }, (_, index) => ({
+ id: index + 1,
+ })),
+ total: 120,
+ initialRoute: "/?page=2",
+ });
+
+ await waitFor(async () => {
+ const query = await getLastDatasetQuery();
+ expect(query.offset).toBe(PAGE_SIZE * 2);
+ });
+
+ const rows = await screen.findAllByTestId("erroring-question");
+ await userEvent.click(within(rows[0]).getByLabelText("Select row"));
+ expect(await screen.findByText("1 question selected")).toBeInTheDocument();
+
+ await userEvent.type(
+ await screen.findByPlaceholderText(SEARCH_PLACEHOLDER),
+ "timeout",
+ );
+ await waitFor(async () => {
+ const query = await getLastDatasetQuery();
+ expect(query.args).toEqual(["timeout", "last_run_at", "desc"]);
+ });
+
+ await waitFor(async () => {
+ const query = await getLastDatasetQuery();
+ expect(query.offset).toBe(0);
+ });
+ await waitFor(() => {
+ expect(history?.getCurrentLocation().search).toBe("");
+ });
+ expect(screen.queryByText("1 question selected")).not.toBeInTheDocument();
+ });
+
+ it("sorts by column with asc/desc toggle, reverting to the default sort on the 3rd click", async () => {
+ await setup();
+ const row = await screen.findByTestId("erroring-question");
+
+ // a selection must not survive a sort change
+ await userEvent.click(within(row).getByLabelText("Select row"));
+ expect(await screen.findByText("1 question selected")).toBeInTheDocument();
+
+ await userEvent.click(
+ screen.getByRole("columnheader", { name: /Question/ }),
+ );
+ await waitFor(() => {
+ expect(screen.queryByText("1 question selected")).not.toBeInTheDocument();
+ });
+ await waitFor(async () => {
+ const query = await getLastDatasetQuery();
+ expect(query.args.slice(1)).toEqual(["card_name", "asc"]);
+ });
+
+ await userEvent.click(
+ screen.getByRole("columnheader", { name: /Question/ }),
+ );
+ await waitFor(async () => {
+ const query = await getLastDatasetQuery();
+ expect(query.args.slice(1)).toEqual(["card_name", "desc"]);
+ });
+
+ await userEvent.click(
+ screen.getByRole("columnheader", { name: /Question/ }),
+ );
+ await waitFor(async () => {
+ const query = await getLastDatasetQuery();
+ expect(query.args.slice(1)).toEqual(["last_run_at", "desc"]);
+ });
+ });
+
+ it("reruns the selected questions from the bulk action bar and clears the selection", async () => {
+ fetchMock.post("express:/api/card/:cardId/query", createMockDataset());
+ await setup({ cards: [{ id: 7 }, { id: 8 }] });
+
+ const rows = await screen.findAllByTestId("erroring-question");
+ await userEvent.click(within(rows[0]).getByLabelText("Select row"));
+ expect(await screen.findByText("1 question selected")).toBeInTheDocument();
+
+ await userEvent.click(screen.getByLabelText("Select all"));
+ expect(await screen.findByText("2 questions selected")).toBeInTheDocument();
+
+ const datasetCallsBefore = getDatasetCalls().length;
+ await userEvent.click(
+ screen.getByRole("button", { name: "Rerun selected" }),
+ );
+
+ await waitFor(() => {
+ const rerunCalls = fetchMock.callHistory.calls(
+ "express:/api/card/:cardId/query",
+ );
+ expect(rerunCalls).toHaveLength(2);
+ });
+ const rerunUrls = fetchMock.callHistory
+ .calls("express:/api/card/:cardId/query")
+ .map((call) => call.url);
+ expect(rerunUrls.some((url) => url.includes("/api/card/7/query"))).toBe(
+ true,
+ );
+ expect(rerunUrls.some((url) => url.includes("/api/card/8/query"))).toBe(
+ true,
+ );
+
+ await waitFor(() => {
+ expect(
+ screen.queryByText("2 questions selected"),
+ ).not.toBeInTheDocument();
+ });
+ // the list is refetched exactly once after both reruns settle
+ await waitFor(() => {
+ expect(getDatasetCalls().length).toBe(datasetCallsBefore + 1);
+ });
+ });
+
+ it("recovers when one of the bulk rerun requests fails", async () => {
+ mockGetBoundingClientRect({ width: 100, height: 100 });
+ fetchMock.post("express:/api/card/7/query", {
+ status: 500,
+ body: { message: "rerun failed" },
+ });
+ fetchMock.post("express:/api/card/8/query", createMockDataset());
+
+ // the list reflects backend state: both cards error at first, but after the
+ // reruns card 8 succeeds (drops off bad-table) while card 7 fails (stays).
+ let rerunsAttempted = false;
+ fetchMock.post("path:/api/dataset", () =>
+ createDatasetResponse(
+ rerunsAttempted ? [{ id: 7 }] : [{ id: 7 }, { id: 8 }],
+ ),
+ );
+
+ renderWithProviders(<Route path="/" element={<ErrorOverview />} />, {
+ withRouter: true,
+ });
+
+ expect(await screen.findAllByTestId("erroring-question")).toHaveLength(2);
+ await userEvent.click(screen.getByLabelText("Select all"));
+ expect(await screen.findByText("2 questions selected")).toBeInTheDocument();
+
+ // from here on the refetch should see card 8 healthy
+ rerunsAttempted = true;
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Rerun selected" }),
+ );
+
+ // both endpoints are attempted even though one fails
+ await waitFor(() => {
+ const rerunCalls = fetchMock.callHistory.calls(
+ "express:/api/card/:cardId/query",
+ );
+ expect(rerunCalls).toHaveLength(2);
+ });
+
+ // the bulk actions bar tears down: selection clears and the button disappears
+ // rather than staying stuck disabled
+ await waitFor(() => {
+ expect(
+ screen.queryByText("2 questions selected"),
+ ).not.toBeInTheDocument();
+ });
+ expect(
+ screen.queryByRole("button", { name: "Rerun selected" }),
+ ).not.toBeInTheDocument();
+
+ // and the refetched table reflects reality: the successfully-rerun question
+ // (8) drops off, the one whose rerun failed (7) remains
+ await waitFor(() => {
+ expect(screen.queryByText("Question 8")).not.toBeInTheDocument();
+ });
+ expect(screen.getByText("Question 7")).toBeInTheDocument();
+ expect(screen.getAllByTestId("erroring-question")).toHaveLength(1);
+ });
+
+ it("shows a per-row loader while a rerun runs, freeing the bar to queue more", async () => {
+ mockGetBoundingClientRect({ width: 100, height: 100 });
+
+ const deferred = () => {
+ let resolve!: () => void;
+ const promise = new Promise<void>((res) => {
+ resolve = res;
+ });
+ return { promise, resolve };
+ };
+ const card7 = deferred();
+ const card8 = deferred();
+ fetchMock.post("express:/api/card/7/query", () =>
+ card7.promise.then(() => createMockDataset()),
+ );
+ fetchMock.post("express:/api/card/8/query", () =>
+ card8.promise.then(() => createMockDataset()),
+ );
+
+ await setup({ cards: [{ id: 7 }, { id: 8 }] });
+
+ const rowAt = (index: number) =>
+ screen.getAllByTestId("erroring-question")[index];
+
+ // rerun question 7 only
+ await userEvent.click(within(rowAt(0)).getByLabelText("Select row"));
+ await userEvent.click(
+ screen.getByRole("button", { name: "Rerun selected" }),
+ );
+
+ // the bulk bar closes immediately, even though 7's request is still pending
+ await waitFor(() => {
+ expect(screen.queryByText("1 question selected")).not.toBeInTheDocument();
+ });
+
+ // 7 shows a loader in place of its checkbox; 8 is untouched
+ await waitFor(() => {
+ expect(within(rowAt(0)).getByLabelText("Loading")).toBeInTheDocument();
+ });
+ expect(
+ within(rowAt(0)).queryByLabelText("Select row"),
+ ).not.toBeInTheDocument();
+ expect(within(rowAt(1)).getByLabelText("Select row")).toBeInTheDocument();
+
+ // the bar is free: question 8 can be queued while 7 is still running
+ await userEvent.click(within(rowAt(1)).getByLabelText("Select row"));
+ await userEvent.click(
+ screen.getByRole("button", { name: "Rerun selected" }),
+ );
+ await waitFor(() => {
+ expect(within(rowAt(1)).getByLabelText("Loading")).toBeInTheDocument();
+ });
+
+ // resolving 7 clears only its loader; 8 keeps running
+ card7.resolve();
+ await waitFor(() => {
+ expect(
+ within(rowAt(0)).queryByLabelText("Loading"),
+ ).not.toBeInTheDocument();
+ });
+ expect(within(rowAt(1)).getByLabelText("Loading")).toBeInTheDocument();
+
+ card8.resolve();
+ await waitFor(() => {
+ expect(
+ within(rowAt(1)).queryByLabelText("Loading"),
+ ).not.toBeInTheDocument();
+ });
+ });
+
+ it("excludes rerunning rows from select all", async () => {
+ mockGetBoundingClientRect({ width: 100, height: 100 });
+
+ let resolveCard7!: () => void;
+ const card7 = new Promise<void>((resolve) => {
+ resolveCard7 = resolve;
+ });
+ fetchMock.post("express:/api/card/7/query", () =>
+ card7.then(() => createMockDataset()),
+ );
+
+ await setup({ cards: [{ id: 7 }, { id: 8 }, { id: 9 }] });
+
+ const rowAt = (index: number) =>
+ screen.getAllByTestId("erroring-question")[index];
+
+ // rerun question 7 -> it starts loading and is no longer selectable
+ await userEvent.click(within(rowAt(0)).getByLabelText("Select row"));
+ await userEvent.click(
+ screen.getByRole("button", { name: "Rerun selected" }),
+ );
+ await waitFor(() => {
+ expect(within(rowAt(0)).getByLabelText("Loading")).toBeInTheDocument();
+ });
+
+ // select all picks the two idle rows, skipping the rerunning one
+ await userEvent.click(screen.getByLabelText("Select all"));
+ expect(await screen.findByText("2 questions selected")).toBeInTheDocument();
+
+ resolveCard7();
+ await waitFor(() => {
+ expect(
+ within(rowAt(0)).queryByLabelText("Loading"),
+ ).not.toBeInTheDocument();
+ });
+ });
+
+ it("paginates showing the total count and syncs the page to the URL", async () => {
+ const { history } = await setup({
+ cards: Array.from({ length: PAGE_SIZE }, (_, index) => ({
+ id: index + 1,
+ })),
+ total: 120,
+ });
+
+ expect(await screen.findByTestId("pagination-total")).toHaveTextContent(
+ "120",
+ );
+ const rows = await screen.findAllByTestId("erroring-question");
+
+ // a selection must not survive a page change
+ await userEvent.click(within(rows[0]).getByLabelText("Select row"));
+ expect(await screen.findByText("1 question selected")).toBeInTheDocument();
+
+ const nextButton = await screen.findByLabelText("Next page");
+ await userEvent.click(nextButton);
+
+ await waitFor(() => {
+ expect(screen.queryByText("1 question selected")).not.toBeInTheDocument();
+ });
+ await waitFor(async () => {
+ const query = await getLastDatasetQuery();
+ expect(query.offset).toBe(PAGE_SIZE);
+ });
+ await waitFor(() => {
+ expect(history?.getCurrentLocation().search).toBe("?page=1");
+ });
+ });
+
+ it("reads the initial page from the URL", async () => {
+ await setup({
+ cards: Array.from({ length: PAGE_SIZE }, (_, index) => ({
+ id: index + 1,
+ })),
+ total: 120,
+ initialRoute: "/?page=2",
+ });
+
+ await waitFor(async () => {
+ const query = await getLastDatasetQuery();
+ expect(query.offset).toBe(PAGE_SIZE * 2);
+ });
+ });
+
+ it("waits for the empty response before recovering from a stranded page", async () => {
+ jest.useFakeTimers({ advanceTimers: true });
+ try {
+ const { history, resolveResponse } = await setup({
+ cards: [],
+ total: 0,
+ initialRoute: "/?page=2",
+ deferResponse: true,
+ });
+
+ expect((await getLastDatasetQuery()).offset).toBe(2 * PAGE_SIZE);
+ act(() => {
+ jest.advanceTimersByTime(URL_UPDATE_DEBOUNCE_DELAY + 50);
+ });
+ expect(history?.getCurrentLocation().search).toBe("?page=2");
+
+ act(() => {
+ resolveResponse();
+ });
+
+ await waitFor(async () => {
+ const query = await getLastDatasetQuery();
+ expect(query.offset).toBe(0);
+ });
+ await waitFor(() => {
+ expect(history?.getCurrentLocation().search).toBe("");
+ });
+ } finally {
+ jest.useRealTimers();
+ }
+ });
+
+ it("links each row to the question and navigates there on click", async () => {
+ const { history } = await setup({ cards: [{ id: 42 }] });
+
+ await screen.findByTestId("erroring-question");
+ const link = screen.getByRole("link");
+ expect(link).toHaveAttribute("href", "/question/42");
+
+ await userEvent.click(link);
+ await waitFor(() => {
+ expect(history?.getCurrentLocation().pathname).toBe("/question/42");
+ });
+ });
+
+ it("does not navigate in the current tab on cmd/shift-click, leaving it to the native link", async () => {
+ const { history } = await setup({ cards: [{ id: 42 }] });
+
+ await screen.findByTestId("erroring-question");
+ const link = screen.getByRole("link");
+ const startingPathname = history?.getCurrentLocation().pathname;
+
+ fireEvent.click(link, { metaKey: true });
+ fireEvent.click(link, { shiftKey: true });
+
+ expect(history?.getCurrentLocation().pathname).toBe(startingPathname);
+ });
+
+ it("navigates to the question when activated from the keyboard", async () => {
+ const { history } = await setup({ cards: [{ id: 42 }] });
+
+ await screen.findByTestId("erroring-question");
+ screen.getByRole("treegrid", { name: "Erroring questions" }).focus();
+ await userEvent.keyboard("{ArrowDown}{Enter}");
+
+ await waitFor(() => {
+ expect(history?.getCurrentLocation().pathname).toBe("/question/42");
+ });
+ });
+
+ it("selects the focused checkbox's row via space, even when a different row is keyboard-highlighted", async () => {
+ await setup({ cards: [{ id: 1 }, { id: 2 }] });
+ const rows = await screen.findAllByTestId("erroring-question");
+
+ // highlight the first row via arrow-key
+ screen.getByRole("treegrid", { name: "Erroring questions" }).focus();
+ await userEvent.keyboard("{ArrowDown}");
+
+ //focus the second row's checkbox directly
+ within(rows[1]).getByLabelText("Select row").focus();
+ await userEvent.keyboard(" ");
+
+ expect(await screen.findByText("1 question selected")).toBeInTheDocument();
+ expect(within(rows[1]).getByLabelText("Deselect row")).toBeChecked();
+ });
+
+ it("selects the keyboard-highlighted row via space when no checkbox is focused", async () => {
+ await setup({ cards: [{ id: 42 }] });
+ const row = await screen.findByTestId("erroring-question");
+
+ screen.getByRole("treegrid", { name: "Erroring questions" }).focus();
+ await userEvent.keyboard("{ArrowDown} ");
+
+ expect(await screen.findByText("1 question selected")).toBeInTheDocument();
+ expect(within(row).getByLabelText("Deselect row")).toBeChecked();
+ });
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErroringQuestionsSearch.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErroringQuestionsSearch.tsx
new file mode 100644
index 00000000000..ac758a50340
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErroringQuestionsSearch.tsx
@@ -0,0 +1,43 @@
+import { useDebouncedCallback } from "@mantine/hooks";
+import { type ChangeEvent, useState } from "react";
+import { t } from "ttag";
+
+import { FixedSizeIcon, Loader, TextInput } from "metabase/ui";
+import { SEARCH_DEBOUNCE_DURATION } from "metabase/utils/constants";
+
+import type { ErroringQuestionsFilters } from "./types";
+
+type ErroringQuestionsSearchProps = {
+ hasLoader: boolean;
+ onFiltersChange: (filters: Partial<ErroringQuestionsFilters>) => void;
+};
+
+export function ErroringQuestionsSearch({
+ hasLoader,
+ onFiltersChange,
+}: ErroringQuestionsSearchProps) {
+ const [value, setValue] = useState("");
+ const handleChangeDebounced = useDebouncedCallback(
+ (search: string) => onFiltersChange({ search }),
+ SEARCH_DEBOUNCE_DURATION,
+ );
+
+ const handleChange = (event: ChangeEvent<HTMLInputElement>) => {
+ setValue(event.target.value);
+ handleChangeDebounced(event.target.value);
+ };
+
+ const searchLabel = t`Search by question, error, database, or collection`;
+
+ return (
+ <TextInput
+ value={value}
+ aria-label={searchLabel}
+ placeholder={searchLabel}
+ w="100%"
+ leftSection={<FixedSizeIcon name="search" />}
+ rightSection={hasLoader ? <Loader size="sm" /> : undefined}
+ onChange={handleChange}
+ />
+ );
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErroringQuestionsTable.tsx b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErroringQuestionsTable.tsx
new file mode 100644
index 00000000000..e0c2fd9e48a
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/ErroringQuestionsTable.tsx
@@ -0,0 +1,328 @@
+import type {
+ OnChangeFn,
+ Row,
+ RowSelectionState,
+ SortingState,
+ Updater,
+} from "@tanstack/react-table";
+import { type MouseEvent, useCallback, useMemo } from "react";
+import { t } from "ttag";
+
+import { DateTime } from "metabase/common/components/DateTime";
+import { useScrollToTop } from "metabase/common/hooks";
+import { MonitorEmptyState } from "metabase/monitor/components/MonitorEmptyState";
+import { useDispatch } from "metabase/redux";
+import { push } from "metabase/router";
+import {
+ Card,
+ Ellipsified,
+ TreeTable,
+ type TreeTableColumnDef,
+ TreeTableSkeleton,
+ useTreeTableInstance,
+} from "metabase/ui";
+import * as Urls from "metabase/urls";
+import { EMPTY_CELL_PLACEHOLDER } from "metabase/utils/constants";
+import {
+ getNextOptionalSorting,
+ getSortingState,
+} from "metabase/utils/sorting";
+import type { CardId } from "metabase-types/api";
+
+import {
+ type ErroringCard,
+ type ErroringQuestionsSorting,
+ SORT_COLUMNS,
+} from "./types";
+import { DEFAULT_SORTING } from "./utils";
+
+const COLUMN_WIDTHS = [
+ 0.14, 0.16, 0.1, 0.08, 0.06, 0.08, 0.09, 0.06, 0.06, 0.09, 0.08,
+];
+
+type ErroringQuestionsTableProps = {
+ cards: ErroringCard[];
+ isFetching: boolean;
+ isLoading: boolean;
+ page: number;
+ sorting: ErroringQuestionsSorting;
+ rowSelection: RowSelectionState;
+ rerunningCardIds: Set<CardId>;
+ onSortingChange: (sorting: ErroringQuestionsSorting) => void;
+ onRowSelectionChange: OnChangeFn<RowSelectionState>;
+};
+
+export const ErroringQuestionsTable = ({
+ cards,
+ isFetching,
+ isLoading,
+ page,
+ sorting,
+ rowSelection,
+ rerunningCardIds,
+ onSortingChange,
+ onRowSelectionChange,
+}: ErroringQuestionsTableProps) => {
+ const dispatch = useDispatch();
+
+ const columns = useMemo(() => getColumns(), []);
+ const sortingState = useMemo(() => getSortingState(sorting), [sorting]);
+
+ // A rerunning card can't be selected, so "select all" skips it too.
+ const isRowSelectable = useCallback(
+ (row: Row<ErroringCard>) => !rerunningCardIds.has(row.original.id),
+ [rerunningCardIds],
+ );
+
+ const getRowHref = useCallback(
+ (row: Row<ErroringCard>) => Urls.card({ id: row.original.id }),
+ [],
+ );
+
+ const handleRowActivate = useCallback(
+ (row: Row<ErroringCard>) => {
+ dispatch(push(Urls.card({ id: row.original.id })));
+ },
+ [dispatch],
+ );
+
+ const handleRowClick = useCallback(
+ (row: Row<ErroringCard>, event: MouseEvent) => {
+ const isModifiedClick = event.metaKey || event.shiftKey;
+ if (!isModifiedClick) {
+ handleRowActivate(row);
+ }
+ },
+ [handleRowActivate],
+ );
+
+ const handleSortingChange = useCallback(
+ (updater: Updater<SortingState>) => {
+ const newSortingState =
+ typeof updater === "function" ? updater(sortingState) : updater;
+ onSortingChange(
+ getNextOptionalSorting(newSortingState, SORT_COLUMNS) ??
+ DEFAULT_SORTING,
+ );
+ },
+ [sortingState, onSortingChange],
+ );
+
+ const treeTableInstance = useTreeTableInstance<ErroringCard>({
+ data: cards,
+ columns,
+ sorting: sortingState,
+ manualSorting: true,
+ getNodeId: (card) => String(card.id),
+ enableRowSelection: isRowSelectable,
+ rowSelection,
+ onRowSelectionChange,
+ onRowActivate: handleRowActivate,
+ onSortingChange: handleSortingChange,
+ });
+
+ useScrollToTop({
+ ref: treeTableInstance.containerRef,
+ keys: [page, sorting],
+ skip: isFetching,
+ });
+
+ return (
+ <Card
+ flex="0 1 auto"
+ mih={0}
+ p={0}
+ withBorder
+ data-testid="erroring-questions-table"
+ >
+ {isLoading ? (
+ <TreeTableSkeleton showCheckboxes columnWidths={COLUMN_WIDTHS} />
+ ) : (
+ <TreeTable
+ instance={treeTableInstance}
+ hierarchical={false}
+ showCheckboxes
+ onHeaderCheckboxClick={() =>
+ treeTableInstance.table.toggleAllRowsSelected()
+ }
+ headerCheckboxAriaLabel={t`Select all`}
+ ariaLabel={t`Erroring questions`}
+ isRowLoading={(row) => rerunningCardIds.has(row.original.id)}
+ emptyState={<MonitorEmptyState label={t`No results`} />}
+ getRowProps={() => ({ "data-testid": "erroring-question" })}
+ getRowHref={getRowHref}
+ onRowClick={handleRowClick}
+ />
+ )}
+ </Card>
+ );
+};
+
+function getColumns(): TreeTableColumnDef<ErroringCard>[] {
+ return [
+ {
+ id: "card_name",
+ header: t`Question`,
+ width: "auto",
+ minWidth: 150,
+ maxAutoWidth: 300,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (card) => card.card_name,
+ cell: ({ row }) => <Ellipsified>{row.original.card_name}</Ellipsified>,
+ },
+ {
+ id: "error_substr",
+ header: t`Error`,
+ width: "auto",
+ minWidth: 200,
+ maxAutoWidth: 400,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (card) => card.error_substr,
+ cell: ({ row }) => (
+ <Ellipsified ff="monospace">{row.original.error_substr}</Ellipsified>
+ ),
+ },
+ {
+ id: "collection_name",
+ header: t`Collection`,
+ width: "auto",
+ minWidth: 120,
+ maxAutoWidth: 240,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (card) => card.collection_name,
+ cell: ({ row }) =>
+ row.original.collection_name != null ? (
+ <Ellipsified>{row.original.collection_name}</Ellipsified>
+ ) : (
+ EMPTY_CELL_PLACEHOLDER
+ ),
+ },
+ {
+ id: "database_name",
+ header: t`Database`,
+ width: "auto",
+ minWidth: 100,
+ maxAutoWidth: 200,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (card) => card.database_name,
+ cell: ({ row }) =>
+ row.original.database_name != null ? (
+ <Ellipsified>{row.original.database_name}</Ellipsified>
+ ) : (
+ EMPTY_CELL_PLACEHOLDER
+ ),
+ },
+ {
+ id: "schema_name",
+ header: t`Schema`,
+ width: "auto",
+ minWidth: 90,
+ maxAutoWidth: 160,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (card) => card.schema_name,
+ cell: ({ row }) =>
+ row.original.schema_name != null ? (
+ <Ellipsified>{row.original.schema_name}</Ellipsified>
+ ) : (
+ EMPTY_CELL_PLACEHOLDER
+ ),
+ },
+ {
+ id: "table_name",
+ header: t`Table`,
+ width: "auto",
+ minWidth: 100,
+ maxAutoWidth: 200,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (card) => card.table_name,
+ cell: ({ row }) =>
+ row.original.table_name != null ? (
+ <Ellipsified>{row.original.table_name}</Ellipsified>
+ ) : (
+ EMPTY_CELL_PLACEHOLDER
+ ),
+ },
+ {
+ id: "last_run_at",
+ header: t`Last run at`,
+ width: "auto",
+ minWidth: 130,
+ enableSorting: true,
+ sortDescFirst: true,
+ accessorFn: (card) => card.last_run_at,
+ cell: ({ row }) =>
+ row.original.last_run_at != null ? (
+ <Ellipsified alwaysShowTooltip tooltip={row.original.last_run_at}>
+ <DateTime
+ value={row.original.last_run_at}
+ unit="minute"
+ data-testid="last-run-at"
+ />
+ </Ellipsified>
+ ) : (
+ EMPTY_CELL_PLACEHOLDER
+ ),
+ },
+ {
+ id: "total_runs",
+ header: t`Total runs`,
+ width: "auto",
+ minWidth: 90,
+ maxAutoWidth: 120,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (card) => card.total_runs,
+ cell: ({ row }) => row.original.total_runs ?? EMPTY_CELL_PLACEHOLDER,
+ },
+ {
+ id: "num_dashboards",
+ header: t`Dashboards it's in`,
+ width: "auto",
+ minWidth: 100,
+ maxAutoWidth: 140,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (card) => card.num_dashboards,
+ cell: ({ row }) => row.original.num_dashboards ?? EMPTY_CELL_PLACEHOLDER,
+ },
+ {
+ id: "user_name",
+ header: t`Created by`,
+ width: "auto",
+ minWidth: 110,
+ maxAutoWidth: 200,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (card) => card.user_name,
+ cell: ({ row }) =>
+ row.original.user_name != null ? (
+ <Ellipsified>{row.original.user_name}</Ellipsified>
+ ) : (
+ EMPTY_CELL_PLACEHOLDER
+ ),
+ },
+ {
+ id: "updated_at",
+ header: t`Updated at`,
+ width: "auto",
+ minWidth: 130,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (card) => card.updated_at,
+ cell: ({ row }) =>
+ row.original.updated_at != null ? (
+ <Ellipsified alwaysShowTooltip tooltip={row.original.updated_at}>
+ <DateTime value={row.original.updated_at} unit="minute" />
+ </Ellipsified>
+ ) : (
+ EMPTY_CELL_PLACEHOLDER
+ ),
+ },
+ ];
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/index.ts b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/index.ts
new file mode 100644
index 00000000000..37c92e6fa53
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/index.ts
@@ -0,0 +1 @@
+export { ErrorOverview } from "./ErrorOverview";
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/mocks.ts b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/mocks.ts
new file mode 100644
index 00000000000..758454b5cd5
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/mocks.ts
@@ -0,0 +1,22 @@
+import type { ErroringCard } from "./types";
+
+export function createMockErroringCard(
+ card: Partial<ErroringCard> = {},
+): ErroringCard {
+ const id = card.id ?? 1;
+ return {
+ id,
+ card_name: `Question ${id}`,
+ error_substr: "Syntax error...",
+ collection_name: "Our Analytics",
+ database_name: "Sample Database",
+ schema_name: "PUBLIC",
+ table_name: "ORDERS",
+ last_run_at: "2026-07-01T10:00:00Z",
+ total_runs: 10,
+ num_dashboards: 2,
+ user_name: "John Doe",
+ updated_at: "2026-06-30T10:00:00Z",
+ ...card,
+ };
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/types.ts b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/types.ts
new file mode 100644
index 00000000000..9ea52970133
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/types.ts
@@ -0,0 +1,39 @@
+import type { Sorting } from "metabase/utils/sorting";
+import type { CardId } from "metabase-types/api";
+
+export type ErroringCard = {
+ id: CardId;
+ card_name: string;
+ error_substr: string;
+ collection_name: string | null;
+ database_name: string | null;
+ schema_name: string | null;
+ table_name: string | null;
+ last_run_at: string | null;
+ total_runs: number | null;
+ num_dashboards: number | null;
+ user_name: string | null;
+ updated_at: string | null;
+};
+
+export type ErroringQuestionsFilters = {
+ search: string;
+};
+
+export const SORT_COLUMNS = [
+ "card_name",
+ "error_substr",
+ "collection_name",
+ "database_name",
+ "schema_name",
+ "table_name",
+ "last_run_at",
+ "total_runs",
+ "num_dashboards",
+ "user_name",
+ "updated_at",
+] as const;
+
+export type ErroringQuestionsSortColumn = (typeof SORT_COLUMNS)[number];
+
+export type ErroringQuestionsSorting = Sorting<ErroringQuestionsSortColumn>;
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/utils.ts b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/utils.ts
new file mode 100644
index 00000000000..db9e409ff2d
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/tools/ErrorOverview/utils.ts
@@ -0,0 +1,94 @@
+import {
+ type QueryParam,
+ type UrlStateConfig,
+ getFirstParamValue,
+} from "metabase/common/hooks/use-url-state";
+import type {
+ Dataset,
+ InternalDatasetQuery,
+ RowValue,
+} from "metabase-types/api";
+
+import type {
+ ErroringCard,
+ ErroringQuestionsFilters,
+ ErroringQuestionsSorting,
+} from "./types";
+
+export const PAGE_SIZE = 50;
+
+type UrlState = {
+ page: number;
+};
+
+export const urlStateConfig: UrlStateConfig<UrlState> = {
+ parse: (query) => ({ page: parsePage(query.page) }),
+ serialize: ({ page }) => ({ page: page === 0 ? undefined : String(page) }),
+};
+
+function parsePage(param: QueryParam): number {
+ const value = getFirstParamValue(param);
+ const parsed = parseInt(value || "0", 10);
+ return Number.isFinite(parsed) && parsed >= 0 ? parsed : 0;
+}
+
+export const DEFAULT_FILTERS: ErroringQuestionsFilters = {
+ search: "",
+};
+
+export const DEFAULT_SORTING: ErroringQuestionsSorting = {
+ column: "last_run_at",
+ direction: "desc",
+};
+
+export function getErroringQuestionsQuery(
+ { search }: ErroringQuestionsFilters,
+ { column, direction }: ErroringQuestionsSorting,
+ page: number,
+): InternalDatasetQuery {
+ return {
+ type: "internal",
+ fn: "metabase-enterprise.audit-app.pages.queries/bad-table",
+ args: [search, column, direction],
+ limit: PAGE_SIZE,
+ offset: PAGE_SIZE * page,
+ };
+}
+
+export function getErroringQuestions(dataset: Dataset): ErroringCard[] {
+ const { cols, rows } = dataset.data;
+ const indexByName: Record<string, number> = {};
+ cols.forEach((col, index) => {
+ indexByName[col.name] = index;
+ });
+
+ return rows.flatMap((row) => {
+ const value = (name: string) => row[indexByName[name]];
+ const id = asCount(value("card_id"));
+ if (id == null) {
+ return [];
+ }
+ return {
+ id,
+ card_name: asText(value("card_name")) ?? "",
+ error_substr: asText(value("error_substr")) ?? "",
+ collection_name: asText(value("collection_name")),
+ database_name: asText(value("database_name")),
+ schema_name: asText(value("schema_name")),
+ table_name: asText(value("table_name")),
+ last_run_at: asText(value("last_run_at")),
+ total_runs: asCount(value("total_runs")),
+ num_dashboards: asCount(value("num_dashboards")),
+ user_name: asText(value("user_name")),
+ updated_at: asText(value("updated_at")),
+ };
+ });
+}
+
+function asText(value: RowValue | undefined): string | null {
+ return typeof value === "string" ? value : null;
+}
+
+function asCount(value: RowValue | undefined): number | null {
+ return typeof value === "number" ? value : null;
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/tools/index.ts b/enterprise/frontend/src/metabase-enterprise/monitor/tools/index.ts
index 958f288024c..e5bab8f4181 100644
--- a/enterprise/frontend/src/metabase-enterprise/monitor/tools/index.ts
+++ b/enterprise/frontend/src/metabase-enterprise/monitor/tools/index.ts
@@ -1,13 +1,13 @@
-import { PLUGIN_ADMIN_TOOLS } from "metabase/plugins";
+import { PLUGIN_MONITOR_TOOLS } from "metabase/plugins";
import { hasPremiumFeature } from "metabase-enterprise/settings";
-import ErrorOverview from "./ErrorOverview";
+import { ErrorOverview } from "./ErrorOverview";
/**
* Initialize tools plugin features that depend on hasPremiumFeature.
*/
export function initializePlugin() {
if (hasPremiumFeature("audit_app")) {
- PLUGIN_ADMIN_TOOLS.COMPONENT = ErrorOverview;
+ PLUGIN_MONITOR_TOOLS.COMPONENT = ErrorOverview;
}
}
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/tools/mode.ts b/enterprise/frontend/src/metabase-enterprise/monitor/tools/mode.ts
deleted file mode 100644
index 36d3d248f33..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/monitor/tools/mode.ts
+++ /dev/null
@@ -1,35 +0,0 @@
-import { t } from "ttag";
-
-import { push } from "metabase/router";
-import { card } from "metabase/urls";
-import type { ClickObject } from "metabase-lib/v1/queries/drills/types";
-
-const CARD_ID_ROW_IDX = 0;
-
-type ErrorDrillProps = {
- clicked?: ClickObject;
-};
-
-const ErrorDrill = ({ clicked }: ErrorDrillProps) => {
- if (!clicked?.origin) {
- return [];
- }
-
- const cardId = Number(clicked.origin.row[CARD_ID_ROW_IDX]);
-
- return [
- {
- name: "detail",
- title: t`View this`,
- default: true,
- action() {
- return push(card({ id: cardId }));
- },
- },
- ];
-};
-
-export const ErrorMode = {
- name: "error",
- fallback: (props: ErrorDrillProps) => ErrorDrill(props),
-};
diff --git a/enterprise/frontend/src/metabase-enterprise/plugins.ts b/enterprise/frontend/src/metabase-enterprise/plugins.ts
index 9c21bc4e651..abfaae163d0 100644
--- a/enterprise/frontend/src/metabase-enterprise/plugins.ts
+++ b/enterprise/frontend/src/metabase-enterprise/plugins.ts
@@ -34,6 +34,7 @@ import { initializePlugin as initializeGroupManagers } from "./group_managers";
import { initializePlugin as initializeMetabot } from "./metabot";
import { initializePlugin as initializeModelPersistence } from "./model_persistence";
import { initializePlugin as initializeModeration } from "./moderation";
+import { initializePlugin as initializeMonitorDependencyDiagnostics } from "./monitor/dependency-diagnostics";
import { initializePlugin as initializeTools } from "./monitor/tools";
import { initializePlugin as initializeMultiFactorAuth } from "./multi_factor_auth";
import { initializePlugin as initializeRemoteSync } from "./remote_sync";
@@ -61,54 +62,56 @@ import { initializePlugin as initializeWritableConnection } from "./writable_con
/**
* Initialize all enterprise plugins that use hasPremiumFeature.
* Must be called after token features are available.
+ * (Let's try to keep the list sorted alphabetically).
*/
export function initializePlugins() {
- initializeTools();
- initializeSandboxes();
+ initializeAdvancedPermissions();
+ initializeAiControls();
+ initializeApplicationPermissions();
+ initializeAuditApp();
initializeAuth();
initializeCaching();
+ initializeCleanUp();
initializeCollections();
initializeContentTranslation();
initializeContentVerification();
initializeCustomViz();
initializeDataApps();
+ initializeDatabaseReplication();
initializeDatabaseRouting();
- initializeRemoteSync();
- initializeReplacement();
- initializeWhitelabel();
+ initializeDependencies();
initializeEmbedding();
- initializeEmbeddingSdk();
initializeEmbeddingIframeSdk();
initializeEmbeddingIframeSdkSetup();
- initializeSnippets();
- initializeSmtpOverride();
- initializeSharing();
- initializeModeration();
- initializeAdvancedPermissions();
- initializeAuditApp();
- initializeMetabot();
- initializeModelPersistence();
- initializeMultiFactorAuth();
+ initializeEmbeddingSdk();
initializeFeatureLevelPermissions();
- initializeApplicationPermissions();
initializeGroupManagers();
initializeLibrary();
- initializeUploadManagement();
+ initializeMetabot();
+ initializeModelPersistence();
+ initializeModeration();
+ initializeMonitorDependencyDiagnostics();
+ initializeMultiFactorAuth();
+ initializeRemoteSync();
+ initializeReplacement();
initializeResourceDownloads();
- initializeUserProvisioning();
- initializeCleanUp();
- initializeDatabaseReplication();
- initializeTableEditing();
- initializeDependencies();
+ initializeSandboxes();
initializeSchemaViewer();
initializeSecurityCenter();
initializeSemanticSearch();
+ initializeSharing();
+ initializeSmtpOverride();
+ initializeSnippets();
+ initializeSupport();
+ initializeTableEditing();
+ initializeTenants?.();
+ initializeTools();
initializeTransforms();
initializeTransformsInspector();
initializeTransformsPython();
- initializeSupport();
- initializeTenants?.();
- initializeWritableConnection();
+ initializeUploadManagement();
+ initializeUserProvisioning();
+ initializeWhitelabel();
initializeWorkspaces();
- initializeAiControls();
+ initializeWritableConnection();
}
diff --git a/enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/ModelSidebar.tsx b/enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/ModelSidebar.tsx
index 847ae116091..ef8773e39ef 100644
--- a/enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/ModelSidebar.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/ModelSidebar.tsx
@@ -3,7 +3,6 @@ import { memo } from "react";
import { skipToken, useGetCardQuery, useGetDatabaseQuery } from "metabase/api";
import { DelayedLoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper/DelayedLoadingAndErrorWrapper";
import { Box, Center, Stack } from "metabase/ui";
-import { SidebarResizableBox } from "metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/SidebarResizableBox";
import type { CardId } from "metabase-types/api";
import { ActionSection } from "./ActionSection";
@@ -12,6 +11,7 @@ import { InfoSection } from "./InfoSection";
import { LocationSection } from "./LocationSection";
import S from "./ModelSidebar.module.css";
import { SidebarHeader } from "./SidebarHeader";
+import { SidebarResizableBox } from "./SidebarResizableBox";
type ModelSidebarProps = {
cardId: CardId;
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/SidebarResizableBox/SidebarResizableBox.module.css b/enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/SidebarResizableBox/SidebarResizableBox.module.css
similarity index 100%
rename from enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/SidebarResizableBox/SidebarResizableBox.module.css
rename to enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/SidebarResizableBox/SidebarResizableBox.module.css
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/SidebarResizableBox/SidebarResizableBox.tsx b/enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/SidebarResizableBox/SidebarResizableBox.tsx
similarity index 100%
rename from enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/SidebarResizableBox/SidebarResizableBox.tsx
rename to enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/SidebarResizableBox/SidebarResizableBox.tsx
diff --git a/enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/SidebarResizableBox/index.ts b/enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/SidebarResizableBox/index.ts
similarity index 100%
rename from enterprise/frontend/src/metabase-enterprise/monitor/dependency-diagnostics/components/DiagnosticsSidebar/SidebarResizableBox/index.ts
rename to enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/SidebarResizableBox/index.ts
diff --git a/enterprise/frontend/src/metabase-enterprise/support/components/SupportSettingsSection/SupportSettingsSection.tsx b/enterprise/frontend/src/metabase-enterprise/support/components/SupportSettingsSection/SupportSettingsSection.tsx
index 2f1e500e040..f32f385e6b6 100644
--- a/enterprise/frontend/src/metabase-enterprise/support/components/SupportSettingsSection/SupportSettingsSection.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/support/components/SupportSettingsSection/SupportSettingsSection.tsx
@@ -6,7 +6,7 @@ import { PaginationControls } from "metabase/common/components/PaginationControl
import { useDispatch } from "metabase/redux";
import { push } from "metabase/router";
import { Box, Button, Flex, LoadingOverlay, Text, Title } from "metabase/ui";
-import { adminToolsGrantAccess } from "metabase/urls";
+import { adminHelpGrantAccess } from "metabase/urls";
import { useAccessGrantsQuery } from "../../hooks/useAccessGrantsQuery";
@@ -50,7 +50,7 @@ export function SupportSettingsSection() {
<Box pb="lg">
<Button
disabled={!!currentAccessGrant}
- onClick={() => dispatch(push(adminToolsGrantAccess()))}
+ onClick={() => dispatch(push(adminHelpGrantAccess()))}
variant="filled"
title={
currentAccessGrant
diff --git a/enterprise/frontend/src/metabase-enterprise/support/components/SupportSettingsSection/SupportSettingsSection.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/support/components/SupportSettingsSection/SupportSettingsSection.unit.spec.tsx
index 780318ffbcd..92991255f1e 100644
--- a/enterprise/frontend/src/metabase-enterprise/support/components/SupportSettingsSection/SupportSettingsSection.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/support/components/SupportSettingsSection/SupportSettingsSection.unit.spec.tsx
@@ -16,13 +16,13 @@ import { SupportSettingsSection } from "./SupportSettingsSection";
const setup = () => {
return renderWithProviders(
<>
- <Route path="/admin/tools/help" element={<SupportSettingsSection />} />
+ <Route path="/admin/help" element={<SupportSettingsSection />} />
<Route
- path="/admin/tools/help/grant-access"
+ path="/admin/help/grant-access"
element={<GrantAccessModal onClose={jest.fn()} />}
/>
</>,
- { withRouter: true, initialRoute: "/admin/tools/help" },
+ { withRouter: true, initialRoute: "/admin/help" },
);
};
diff --git a/frontend/lint/module-boundaries.mjs b/frontend/lint/module-boundaries.mjs
index 45ed494e844..006ea538cae 100644
--- a/frontend/lint/module-boundaries.mjs
+++ b/frontend/lint/module-boundaries.mjs
@@ -384,17 +384,6 @@ const rules = [
from: ["app/*"],
allow: ["lib/*", "basic/*", "shared/*", "feature/*", "app/*"],
},
- // TEMP(content-optimizer): the Monitor space is mid-migration — source files are
- // being relocated here from admin/ and data-studio/ before their routes and
- // dependencies are moved, so monitor currently imports heavily from feature
- // modules (admin, etc.). We allow it to import from anywhere until the migration
- // is complete.
- // TODO (@stasgavrylov 24/06/26): remove this rule and give monitor proper boundaries once the
- // Monitor migration is complete.
- {
- from: ["shared/monitor"],
- allow: ["lib/*", "basic/*", "shared/*", "feature/*", "app/*"],
- },
// Whitelisted cross-tier edges. Keep this list short; every entry should
// eventually be removed.
// Window-bridge ABI: the payload shapes are owned by the bundle.
diff --git a/frontend/src/metabase-types/analytics/event.ts b/frontend/src/metabase-types/analytics/event.ts
index 7a4e92d55c2..a4dbfb65cd4 100644
--- a/frontend/src/metabase-types/analytics/event.ts
+++ b/frontend/src/metabase-types/analytics/event.ts
@@ -60,3 +60,20 @@ export type InviteToViewOpenedEvent = ValidateEvent<{
triggered_from: "dashboard" | "question";
target_id: number | null;
}>;
+
+export type MonitorOpenedEvent = ValidateEvent<{
+ event: "monitor_opened";
+ triggered_from: "nav_menu";
+}>;
+
+export type MonitorSectionClickedEvent = ValidateEvent<{
+ event: "monitor_section_clicked";
+ event_detail:
+ | "diagnostics"
+ | "erroring-questions"
+ | "alerts"
+ | "tasks"
+ | "jobs"
+ | "logs"
+ | "model-caching";
+}>;
diff --git a/frontend/src/metabase-types/api/actions.ts b/frontend/src/metabase-types/api/actions.ts
index 50ce2a4262b..a0a3066ca29 100644
--- a/frontend/src/metabase-types/api/actions.ts
+++ b/frontend/src/metabase-types/api/actions.ts
@@ -6,9 +6,9 @@ import type { Parameter, ParameterId, ParameterTarget } from "./parameters";
import type { NativeDatasetQuery } from "./query";
import type { UserId, UserInfo } from "./user";
-export interface ListActionsRequest {
+export type ListActionsRequest = {
"model-id"?: CardId;
-}
+};
export interface CreateActionRequest {
database_id?: DatabaseId;
diff --git a/frontend/src/metabase-types/api/card.ts b/frontend/src/metabase-types/api/card.ts
index b5f9cbda740..5aa7867096f 100644
--- a/frontend/src/metabase-types/api/card.ts
+++ b/frontend/src/metabase-types/api/card.ts
@@ -568,10 +568,10 @@ export type CardQueryMetadata = {
fields: Field[];
};
-export interface ListCardsRequest {
+export type ListCardsRequest = {
f?: CardFilterOption;
model_id?: CardId;
-}
+};
export interface GetCardRequest {
id: CardId | EntityToken;
diff --git a/frontend/src/metabase-types/api/collection.ts b/frontend/src/metabase-types/api/collection.ts
index 1c3ae5069bd..9fe9a80a40c 100644
--- a/frontend/src/metabase-types/api/collection.ts
+++ b/frontend/src/metabase-types/api/collection.ts
@@ -204,14 +204,14 @@ export interface CreateCollectionRequest {
is_shared_tenant_collection?: boolean;
}
-export interface ListCollectionsRequest {
+export type ListCollectionsRequest = {
archived?: boolean;
namespace?: CollectionNamespace;
"personal-only"?: boolean;
"exclude-other-user-collections"?: boolean;
collection_type?: CollectionType;
-}
-export interface ListCollectionsTreeRequest {
+};
+export type ListCollectionsTreeRequest = {
"exclude-archived"?: boolean;
"exclude-other-user-collections"?: boolean;
"include-library"?: boolean;
@@ -221,7 +221,7 @@ export interface ListCollectionsTreeRequest {
"collection-id"?: RegularCollectionId | null;
collection_type?: CollectionType;
"include-tenant-collections"?: boolean;
-}
+};
export interface DeleteCollectionRequest {
id: RegularCollectionId;
diff --git a/frontend/src/metabase-types/api/comments.ts b/frontend/src/metabase-types/api/comments.ts
index 556188f4303..be6b54ee357 100644
--- a/frontend/src/metabase-types/api/comments.ts
+++ b/frontend/src/metabase-types/api/comments.ts
@@ -42,10 +42,10 @@ export type MentionableUser = Pick<
/** request types below */
-export interface ListCommentsRequest {
+export type ListCommentsRequest = {
target_type: CommentEntityType;
target_id: EntityId;
-}
+};
export interface CreateCommentRequest {
target_id: EntityId;
@@ -70,6 +70,6 @@ export interface DeleteReactionRequest {
id: CommentId;
}
-export interface ListMentionsRequest {
+export type ListMentionsRequest = {
limit: number;
-}
+};
diff --git a/frontend/src/metabase-types/api/database.ts b/frontend/src/metabase-types/api/database.ts
index b9dd5ed8fcb..9cb37b8ad1a 100644
--- a/frontend/src/metabase-types/api/database.ts
+++ b/frontend/src/metabase-types/api/database.ts
@@ -156,7 +156,7 @@ export type GetDatabaseHealthResponse =
| { status: "ok" }
| { status: "error"; message: string; errors: unknown };
-export interface ListDatabasesRequest {
+export type ListDatabasesRequest = {
include?: "tables" | "schemas";
saved?: boolean;
include_editable_data_model?: boolean;
@@ -166,7 +166,7 @@ export interface ListDatabasesRequest {
router_database_id?: DatabaseId;
"can-query"?: boolean;
"can-write-metadata"?: boolean;
-}
+};
export interface ListDatabasesResponse {
data: Database[];
diff --git a/frontend/src/metabase-types/api/dataset.ts b/frontend/src/metabase-types/api/dataset.ts
index 1b61cfabc8b..b09c2239edc 100644
--- a/frontend/src/metabase-types/api/dataset.ts
+++ b/frontend/src/metabase-types/api/dataset.ts
@@ -134,6 +134,7 @@ export interface Dataset {
data: DatasetData;
database_id: DatabaseId;
row_count: number;
+ total_count?: number;
running_time: number;
json_query?: JsonQuery;
error?: DatasetError;
diff --git a/frontend/src/metabase-types/api/mocks/task.ts b/frontend/src/metabase-types/api/mocks/task.ts
index e1a937d8626..0ddf9729744 100644
--- a/frontend/src/metabase-types/api/mocks/task.ts
+++ b/frontend/src/metabase-types/api/mocks/task.ts
@@ -1,4 +1,11 @@
-import type { Task, TaskRun, TaskRunExtended } from "metabase-types/api";
+import type {
+ Job,
+ Task,
+ TaskInfo,
+ TaskRun,
+ TaskRunExtended,
+ Trigger,
+} from "metabase-types/api";
export const createMockTask = (task?: Partial<Task>): Task => ({
id: 1,
@@ -35,3 +42,38 @@ export const createMockTaskRunExtended = (
...createMockTaskRun(taskRunExtended),
tasks: taskRunExtended?.tasks ?? [],
});
+
+export const createMockTrigger = (trigger?: Partial<Trigger>): Trigger => ({
+ key: "a-trigger-key",
+ description: "A trigger description",
+ schedule: "0 0 * * * ?",
+ timezone: "UTC",
+ "previous-fire-time": "2023-03-04T01:45:00Z",
+ "next-fire-time": "2023-03-05T01:45:00Z",
+ "start-time": "2023-03-01T00:00:00Z",
+ "end-time": null,
+ "final-fire-time": null,
+ state: "WAITING",
+ priority: 5,
+ "misfire-instruction": "DO_NOTHING",
+ "may-fire-again?": true,
+ data: {},
+ ...trigger,
+});
+
+export const createMockJob = (job?: Partial<Job>): Job => ({
+ key: "a-job-key",
+ class: "org.quartz.jobs.AJobClass",
+ description: "A job description",
+ "concurrent-execution-disallowed?": false,
+ "durable?": true,
+ "requests-recovery?": false,
+ triggers: [],
+ ...job,
+});
+
+export const createMockTaskInfo = (taskInfo?: Partial<TaskInfo>): TaskInfo => ({
+ scheduler: ["A scheduler line"],
+ jobs: [createMockJob()],
+ ...taskInfo,
+});
diff --git a/frontend/src/metabase-types/api/notification.ts b/frontend/src/metabase-types/api/notification.ts
index 95ef2f77756..45f1192c685 100644
--- a/frontend/src/metabase-types/api/notification.ts
+++ b/frontend/src/metabase-types/api/notification.ts
@@ -125,14 +125,14 @@ export type NotificationCronSubscription = {
updated_at?: string;
};
-export interface ListNotificationsRequest extends PaginationRequest {
+export type ListNotificationsRequest = PaginationRequest & {
include_inactive?: boolean;
creator_id?: UserId;
recipient_id?: UserId;
creator_or_recipient_id?: UserId;
card_id?: CardId;
permission_group_id?: number;
-}
+};
export type CreateAlertNotificationRequest = NotificationCardData & {
handlers: NotificationHandler[];
diff --git a/frontend/src/metabase-types/api/pagination.ts b/frontend/src/metabase-types/api/pagination.ts
index 8e635ccb343..9e0e5786108 100644
--- a/frontend/src/metabase-types/api/pagination.ts
+++ b/frontend/src/metabase-types/api/pagination.ts
@@ -1,10 +1,10 @@
-export interface PaginationRequest {
+export type PaginationRequest = {
limit?: number | null;
offset?: number | null;
-}
+};
-export interface PaginationResponse {
+export type PaginationResponse = {
limit: number | null;
offset: number | null;
total: number;
-}
+};
diff --git a/frontend/src/metabase-types/api/performance.ts b/frontend/src/metabase-types/api/performance.ts
index bdd6917fe48..aad614c9b0d 100644
--- a/frontend/src/metabase-types/api/performance.ts
+++ b/frontend/src/metabase-types/api/performance.ts
@@ -75,7 +75,7 @@ export interface CacheConfig {
export type CacheSortColumn = "name" | "collection" | "policy";
-export interface ListCacheConfigsRequest {
+export type ListCacheConfigsRequest = {
model?: CacheableModel[];
collection?: number;
id?: number;
@@ -83,7 +83,7 @@ export interface ListCacheConfigsRequest {
offset?: number;
sort_column?: CacheSortColumn;
sort_direction?: SortDirection;
-}
+};
/** Cache config with hydrated name and collection data */
export interface CacheConfigWithDetails extends CacheConfig {
diff --git a/frontend/src/metabase-types/api/query.ts b/frontend/src/metabase-types/api/query.ts
index 4bbc3d936d3..f77d479ee39 100644
--- a/frontend/src/metabase-types/api/query.ts
+++ b/frontend/src/metabase-types/api/query.ts
@@ -38,6 +38,16 @@ export type DatasetQuery = OpaqueDatasetQuery | LegacyDatasetQuery;
export type LegacyDatasetQuery = StructuredDatasetQuery | NativeDatasetQuery;
+// Audit-only query shape accepted by /api/dataset.
+// `fn` names a backend function.
+export interface InternalDatasetQuery {
+ type: "internal";
+ fn: string;
+ args: string[];
+ limit?: number;
+ offset?: number;
+}
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars -- used for types
declare const OpaqueDatasetQuerySymbol: unique symbol;
export type OpaqueDatasetQuery = unknown & {
diff --git a/frontend/src/metabase-types/api/revision.ts b/frontend/src/metabase-types/api/revision.ts
index c97c2cd5ffb..2b8758a5624 100644
--- a/frontend/src/metabase-types/api/revision.ts
+++ b/frontend/src/metabase-types/api/revision.ts
@@ -54,10 +54,10 @@ export type RevisionEntityType =
| "document"
| "transform";
-export interface ListRevisionRequest {
+export type ListRevisionRequest = {
entity: RevisionEntityType;
id: number | string;
-}
+};
export interface RevertRevisionRequest {
entity: RevisionEntityType;
diff --git a/frontend/src/metabase-types/api/snippets.ts b/frontend/src/metabase-types/api/snippets.ts
index 321a3ede2e5..64efc5f2696 100644
--- a/frontend/src/metabase-types/api/snippets.ts
+++ b/frontend/src/metabase-types/api/snippets.ts
@@ -22,9 +22,9 @@ export interface NativeQuerySnippet {
collection?: Collection;
}
-export interface ListSnippetsParams {
+export type ListSnippetsParams = {
archived?: boolean;
-}
+};
export interface CreateSnippetRequest {
name: string;
diff --git a/frontend/src/metabase-types/api/subscription.ts b/frontend/src/metabase-types/api/subscription.ts
index e553c3ae992..e385ce96b1c 100644
--- a/frontend/src/metabase-types/api/subscription.ts
+++ b/frontend/src/metabase-types/api/subscription.ts
@@ -6,11 +6,11 @@ import type { Channel } from "./notification-channels";
import type { Parameter } from "./parameters";
import type { User } from "./user";
-export interface ListSubscriptionsRequest {
+export type ListSubscriptionsRequest = {
archived?: boolean;
dashboard_id?: DashboardId;
creator_or_recipient?: boolean;
-}
+};
export interface DashboardSubscription {
archived: boolean;
diff --git a/frontend/src/metabase-types/api/support-access-grants.ts b/frontend/src/metabase-types/api/support-access-grants.ts
index c8bb72ef4d2..34c56a62b32 100644
--- a/frontend/src/metabase-types/api/support-access-grants.ts
+++ b/frontend/src/metabase-types/api/support-access-grants.ts
@@ -19,13 +19,13 @@ export interface CreateSupportAccessGrantRequest {
ticket_number: string | null;
}
-export interface ListSupportAccessGrantsRequest {
+export type ListSupportAccessGrantsRequest = {
"ticket-number"?: string;
"user-id"?: number;
"include-revoked"?: boolean;
limit?: number;
offset?: number;
-}
+};
export interface ListSupportAccessGrantsResponse {
data: SupportAccessGrant[];
diff --git a/frontend/src/metabase-types/api/table.ts b/frontend/src/metabase-types/api/table.ts
index 5d99a56e0c8..e531b772de6 100644
--- a/frontend/src/metabase-types/api/table.ts
+++ b/frontend/src/metabase-types/api/table.ts
@@ -107,7 +107,7 @@ export interface TableMetadataQuery {
include_editable_data_model?: boolean;
}
-export interface TableListQuery {
+export type TableListQuery = {
dbId?: DatabaseId;
schemaName?: string;
include_hidden?: boolean;
@@ -124,7 +124,7 @@ export interface TableListQuery {
"unused-only"?: boolean | null;
"orphan-only"?: boolean;
"published-only"?: boolean | null;
-}
+};
export interface ForeignKey {
origin?: Field;
diff --git a/frontend/src/metabase-types/api/task.ts b/frontend/src/metabase-types/api/task.ts
index 6cb75490a39..355d02aa201 100644
--- a/frontend/src/metabase-types/api/task.ts
+++ b/frontend/src/metabase-types/api/task.ts
@@ -2,7 +2,7 @@ import type { Log } from "metabase-types/api/util";
import type { DatabaseId } from "./database";
import type { PaginationRequest, PaginationResponse } from "./pagination";
-import type { SortingOptions } from "./sorting";
+import type { SortDirection, SortingOptions } from "./sorting";
// "unknown" status is only expected for historical tasks (before Task['status'] was introduced)
export type TaskStatus = "success" | "started" | "failed" | "unknown";
@@ -20,7 +20,14 @@ export interface Task {
run_id: number | null;
}
-export type ListTasksSortColumn = "started_at" | "ended_at" | "duration";
+export type ListTasksSortColumn =
+ | "started_at"
+ | "ended_at"
+ | "duration"
+ | "task"
+ | "status"
+ | "db_name"
+ | "db_engine";
export type ListTasksRequest = {
status?: TaskStatus;
@@ -85,7 +92,7 @@ export interface TaskRun {
started_at: string;
ended_at: string | null;
status: TaskRunStatus;
- entity_name?: string;
+ entity_name: string | null;
task_count: number;
success_count: number;
failed_count: number;
@@ -98,19 +105,29 @@ export interface TaskRunExtended extends TaskRun {
export interface RunEntity {
entity_type: TaskRunEntityType;
entity_id: number;
- entity_name?: string;
+ entity_name: string | null;
}
export type TaskRunStartedAtParam =
| TaskRunDateFilterOption
| `${TaskRunDateFilterOption}~`;
+export type ListTaskRunsSortColumn =
+ | "started_at"
+ | "ended_at"
+ | "run_type"
+ | "status"
+ | "entity_name"
+ | "task_count";
+
export type ListTaskRunsRequest = {
"run-type"?: TaskRunType;
"entity-type"?: TaskRunEntityType;
"entity-id"?: number;
status?: TaskRunStatus;
"started-at"?: TaskRunStartedAtParam;
+ "sort-column"?: ListTaskRunsSortColumn;
+ "sort-direction"?: SortDirection;
} & PaginationRequest;
export type ListTaskRunsResponse = {
diff --git a/frontend/src/metabase-types/api/timeline.ts b/frontend/src/metabase-types/api/timeline.ts
index 13ed27e4031..5d6ff7e0869 100644
--- a/frontend/src/metabase-types/api/timeline.ts
+++ b/frontend/src/metabase-types/api/timeline.ts
@@ -59,10 +59,10 @@ export interface TimelineEventData {
question_id?: CardId;
}
-export interface ListTimelinesRequest {
+export type ListTimelinesRequest = {
include?: "events";
archived?: boolean;
-}
+};
export interface ListCollectionTimelinesRequest {
id: CollectionId;
diff --git a/frontend/src/metabase-types/api/user.ts b/frontend/src/metabase-types/api/user.ts
index e848906ca9d..7853159d5d9 100644
--- a/frontend/src/metabase-types/api/user.ts
+++ b/frontend/src/metabase-types/api/user.ts
@@ -199,6 +199,11 @@ export type UserKeyValue =
key: string;
value: boolean;
}
+ | {
+ namespace: "monitor";
+ key: "isNavbarOpened";
+ value: boolean;
+ }
| {
namespace: "dependency_diagnostics";
key: string;
diff --git a/frontend/src/metabase-types/api/util.ts b/frontend/src/metabase-types/api/util.ts
index 32a602d2332..bb28422a126 100644
--- a/frontend/src/metabase-types/api/util.ts
+++ b/frontend/src/metabase-types/api/util.ts
@@ -4,7 +4,7 @@ export interface Log {
fqns: string;
msg: string;
level: string;
- exception: any;
+ exception: string[] | null;
}
export interface MetabaseInfo {
diff --git a/frontend/src/metabase/AppComponent.tsx b/frontend/src/metabase/AppComponent.tsx
index b97475d07be..dc08f9d10b3 100644
--- a/frontend/src/metabase/AppComponent.tsx
+++ b/frontend/src/metabase/AppComponent.tsx
@@ -7,6 +7,7 @@ import {
getIsAppBarVisible,
getIsDataApp,
getIsDataStudioApp,
+ getIsMonitorApp,
getIsNavBarEnabled,
} from "metabase/app/selectors";
import { AppBanner } from "metabase/common/components/AppBanner";
@@ -61,6 +62,7 @@ interface AppStateProps {
errorPage: AppErrorDescriptor | null;
isAdminApp: boolean;
isDataStudioApp: boolean;
+ isMonitorApp: boolean;
isDataApp: boolean;
bannerMessageDescriptor?: string;
isAppBarVisible: boolean;
@@ -84,6 +86,7 @@ const mapStateToProps = (
errorPage: getErrorPage(state),
isAdminApp: getIsAdminApp(state, props),
isDataStudioApp: getIsDataStudioApp(state, props),
+ isMonitorApp: getIsMonitorApp(state, props),
isDataApp: getIsDataApp(state, props),
isAppBarVisible: getIsAppBarVisible(state, props),
isNavBarEnabled: getIsNavBarEnabled(state, props),
@@ -97,6 +100,7 @@ function App({
errorPage,
isAdminApp,
isDataStudioApp,
+ isMonitorApp,
isDataApp,
isAppBarVisible,
isNavBarEnabled,
@@ -137,7 +141,11 @@ function App({
<UndoListing />
<StatusListing />
<NewModals />
- <Metabot hide={isAdminApp || isDataStudioApp || isDataApp} />
+ <Metabot
+ hide={
+ isAdminApp || isDataStudioApp || isMonitorApp || isDataApp
+ }
+ />
</AppContentContainer>
</AppContainer>
<Palette />
diff --git a/frontend/src/metabase/admin/app/reducers.ts b/frontend/src/metabase/admin/app/reducers.ts
index 35d08ea9e6b..97feb8abdee 100644
--- a/frontend/src/metabase/admin/app/reducers.ts
+++ b/frontend/src/metabase/admin/app/reducers.ts
@@ -50,9 +50,9 @@ export const getAdminPaths: () => AdminPath[] = () => {
key: "performance",
},
{
- name: t`Tools`,
- path: "/admin/tools",
- key: "tools",
+ name: t`Help`,
+ path: "/admin/help",
+ key: "help",
},
];
diff --git a/frontend/src/metabase/monitor/tools/components/Help/Help.tsx b/frontend/src/metabase/admin/help/Help.tsx
similarity index 67%
rename from frontend/src/metabase/monitor/tools/components/Help/Help.tsx
rename to frontend/src/metabase/admin/help/Help.tsx
index d18c09e3078..95ae933e33e 100644
--- a/frontend/src/metabase/monitor/tools/components/Help/Help.tsx
+++ b/frontend/src/metabase/admin/help/Help.tsx
@@ -3,6 +3,7 @@ import { useMemo } from "react";
import { t } from "ttag";
import _ from "underscore";
+import { AdminSettingsLayout } from "metabase/admin/components/AdminLayout/AdminSettingsLayout";
import {
SettingsPageWrapper,
SettingsSection,
@@ -114,46 +115,48 @@ export const Help = () => {
const compactDetailStringForUrl = encodeURIComponent(JSON.stringify(details));
return (
- <SettingsPageWrapper title={t`Help`}>
- <Group grow>
- <HelpLink
- title={t`Get help`}
- description={t`Resources and support`}
- link={
- isPaidPlan
- ? `https://www.metabase.com/help-premium?utm_source=in-product&utm_medium=troubleshooting&utm_campaign=help&instance_version=${tag}&diag=${compactDetailStringForUrl}`
- : `https://www.metabase.com/help?utm_source=in-product&utm_medium=troubleshooting&utm_campaign=help&instance_version=${tag}`
- }
- />
- <HelpLink
- title={t`Report an issue`}
- description={t`Create a GitHub issue (includes the diagnostic info below)`}
- link={githubIssueLink(detailString)}
- />
- </Group>
-
- <UpsellBetterSupport location="settings-troubleshooting" />
-
- {PLUGIN_SUPPORT.isEnabled && <PLUGIN_SUPPORT.SupportSettings />}
-
- <SettingsSection
- title={t`Diagnostic info`}
- description={t`Please include these details in support requests. Thank you!`}
- >
- <InfoBlock>{detailString}</InfoBlock>
- </SettingsSection>
- <SettingsSection
- title={t`Advanced details`}
- description={t`Click to download`}
- >
- <HelpLink
- title={t`Connection Pool Details`}
- description={t`Information about active and idle connections for all pools`}
- link={getConnectionPoolDetailsUrl()}
- />
- </SettingsSection>
- {/* render the outlet so that the child modal routes can show up */}
- <Outlet />
- </SettingsPageWrapper>
+ <AdminSettingsLayout maw="50rem">
+ <SettingsPageWrapper title={t`Help`}>
+ <Group grow>
+ <HelpLink
+ title={t`Get help`}
+ description={t`Resources and support`}
+ link={
+ isPaidPlan
+ ? `https://www.metabase.com/help-premium?utm_source=in-product&utm_medium=troubleshooting&utm_campaign=help&instance_version=${tag}&diag=${compactDetailStringForUrl}`
+ : `https://www.metabase.com/help?utm_source=in-product&utm_medium=troubleshooting&utm_campaign=help&instance_version=${tag}`
+ }
+ />
+ <HelpLink
+ title={t`Report an issue`}
+ description={t`Create a GitHub issue (includes the diagnostic info below)`}
+ link={githubIssueLink(detailString)}
+ />
+ </Group>
+
+ <UpsellBetterSupport location="settings-troubleshooting" />
+
+ {PLUGIN_SUPPORT.isEnabled && <PLUGIN_SUPPORT.SupportSettings />}
+
+ <SettingsSection
+ title={t`Diagnostic info`}
+ description={t`Please include these details in support requests. Thank you!`}
+ >
+ <InfoBlock>{detailString}</InfoBlock>
+ </SettingsSection>
+ <SettingsSection
+ title={t`Advanced details`}
+ description={t`Click to download`}
+ >
+ <HelpLink
+ title={t`Connection Pool Details`}
+ description={t`Information about active and idle connections for all pools`}
+ link={getConnectionPoolDetailsUrl()}
+ />
+ </SettingsSection>
+ {/* render the outlet so that the child modal routes can show up */}
+ <Outlet />
+ </SettingsPageWrapper>
+ </AdminSettingsLayout>
);
};
diff --git a/frontend/src/metabase/monitor/tools/components/Help/help.module.css b/frontend/src/metabase/admin/help/help.module.css
similarity index 100%
rename from frontend/src/metabase/monitor/tools/components/Help/help.module.css
rename to frontend/src/metabase/admin/help/help.module.css
diff --git a/frontend/src/metabase/monitor/tools/components/Help/index.ts b/frontend/src/metabase/admin/help/index.ts
similarity index 100%
rename from frontend/src/metabase/monitor/tools/components/Help/index.ts
rename to frontend/src/metabase/admin/help/index.ts
diff --git a/frontend/src/metabase/admin/routes.tsx b/frontend/src/metabase/admin/routes.tsx
index 3c5c0f7cb60..50203d67f2d 100644
--- a/frontend/src/metabase/admin/routes.tsx
+++ b/frontend/src/metabase/admin/routes.tsx
@@ -12,6 +12,7 @@ import { EmbeddingThemeEditorApp } from "metabase/admin/embedding/components/The
import { EmbeddingThemeListingApp } from "metabase/admin/embedding/components/ThemeListing";
import { AdminEmbeddingApp } from "metabase/admin/embedding/containers/AdminEmbeddingApp";
import { EmbeddingHubAdminSettingsPage } from "metabase/admin/embedding/embedding-hub";
+import { Help } from "metabase/admin/help";
import { AdminPeopleApp } from "metabase/admin/people/containers/AdminPeopleApp";
import { EditUserModal } from "metabase/admin/people/containers/EditUserModal";
import { GroupDetailApp } from "metabase/admin/people/containers/GroupDetailApp";
@@ -34,29 +35,12 @@ import {
SetupSsoPage,
} from "metabase/embedding/embedding-hub";
import { DataModelV1 } from "metabase/metadata/pages/DataModelV1";
-import { Help } from "metabase/monitor/tools/components/Help";
-import { JobInfoApp } from "metabase/monitor/tools/components/JobInfoApp";
-import { JobTriggersModal } from "metabase/monitor/tools/components/JobTriggersModal";
-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";
-import { ToolsApp } from "metabase/monitor/tools/components/ToolsApp";
-import { ToolsUpsell } from "metabase/monitor/tools/components/ToolsUpsell";
-import {
- getNotificationsRoutes,
- getTasksRoutes,
-} from "metabase/monitor/tools/routes";
-import {
- PLUGIN_ADMIN_TOOLS,
PLUGIN_ADMIN_USER_MENU_ROUTES,
PLUGIN_AI_CONTROLS,
PLUGIN_AUDIT,
PLUGIN_CACHING,
PLUGIN_DB_ROUTING,
- PLUGIN_DEPENDENCIES,
PLUGIN_SECURITY_CENTER,
PLUGIN_SUPPORT,
PLUGIN_TENANTS,
@@ -99,7 +83,6 @@ const RoutedRevisionHistoryApp = withRouteProps(RevisionHistoryApp);
const RoutedGroupDetailApp = withRouteProps(GroupDetailApp);
const RoutedAdminEmbeddingApp = withRouteProps(AdminEmbeddingApp);
const RoutedEmbeddingThemeEditorApp = withRouteProps(EmbeddingThemeEditorApp);
-const RoutedToolsApp = withRouteProps(ToolsApp);
const RoutedOAuthAuthorizationsPage = withRouteProps(OAuthAuthorizationsPage);
export const getRoutes = (
@@ -371,44 +354,10 @@ export const getRoutes = (
/>
)}
- <Route
- path="tools"
- element={createElement(createAdminRouteGuard("tools"))}
- >
- <Route element={<RoutedToolsApp />}>
- <Route index element={redirect("help")} />
- <Route
- key="error-overview"
- path="errors"
- // If the audit_app feature flag is present, our enterprise plugin system kicks in and we render the
- // appropriate enterprise component. The upsell component is shown in all other cases.
- element={createElement(
- PLUGIN_ADMIN_TOOLS.COMPONENT || ToolsUpsell,
- )}
- />
- <Route path="model-caching" element={<ModelCachePage />}>
- {modalRoute(":jobId", ModelCacheRefreshJobModal)}
- </Route>
- <Route path="help" element={<Help />}>
- {PLUGIN_SUPPORT.isEnabled &&
- modalRoute("grant-access", PLUGIN_SUPPORT.GrantAccessModal)}
- </Route>
- <Route path="tasks">{getTasksRoutes()}</Route>
- <Route path="notifications">{getNotificationsRoutes()}</Route>
- <Route path="jobs" element={<JobInfoApp />}>
- {modalRoute(":jobKey", JobTriggersModal, {
- modalProps: { size: "85%" },
- })}
- </Route>
- <Route path="logs" element={<Logs />}>
- {modalRoute("levels", LogLevelsModal)}
- </Route>
- {PLUGIN_DEPENDENCIES.isEnabled && (
- <Route
- path="dependencies"
- element={<PLUGIN_DEPENDENCIES.DependencyGraphPage />}
- />
- )}
+ <Route element={createElement(createAdminRouteGuard("help"))}>
+ <Route path="help" element={<Help />}>
+ {PLUGIN_SUPPORT.isEnabled &&
+ modalRoute("grant-access", PLUGIN_SUPPORT.GrantAccessModal)}
</Route>
</Route>
</Route>
diff --git a/frontend/src/metabase/admin/upsells/UpsellPerformanceTools.tsx b/frontend/src/metabase/admin/upsells/UpsellPerformanceTools.tsx
deleted file mode 100644
index 069f6c62408..00000000000
--- a/frontend/src/metabase/admin/upsells/UpsellPerformanceTools.tsx
+++ /dev/null
@@ -1,33 +0,0 @@
-import { t } from "ttag";
-
-import { UpsellBigCard } from "metabase/common/components/upsells/components";
-import { UPGRADE_URL } from "metabase/common/components/upsells/constants";
-import { useHasTokenFeature } from "metabase/common/hooks";
-import { PLUGIN_ADMIN_SETTINGS } from "metabase/plugins";
-
-export const UpsellPerformanceTools = ({ source }: { source: string }) => {
- const hasAuditEnabled = useHasTokenFeature("audit_app");
- const campaign = "audit-tools";
- const { triggerUpsellFlow } = PLUGIN_ADMIN_SETTINGS.useUpsellFlow({
- campaign,
- location: source,
- });
-
- if (hasAuditEnabled) {
- return null;
- }
-
- return (
- <UpsellBigCard
- title={t`Troubleshoot faster`}
- campaign={campaign}
- buttonText={t`Try for free`}
- buttonLink={UPGRADE_URL}
- source={source}
- illustrationSrc="app/assets/img/upsell-performance-tools.png"
- onClick={triggerUpsellFlow}
- >
- {t`Find and fix issues fast, with an overview of all errors and model caching logs.`}
- </UpsellBigCard>
- );
-};
diff --git a/frontend/src/metabase/admin/upsells/index.ts b/frontend/src/metabase/admin/upsells/index.ts
index f4dfac0a57e..ad699e4efbc 100644
--- a/frontend/src/metabase/admin/upsells/index.ts
+++ b/frontend/src/metabase/admin/upsells/index.ts
@@ -6,7 +6,6 @@ export * from "./UpsellDataApps";
export * from "./UpsellEmailWhitelabel";
export * from "./UpsellEmbeddingTheme";
export * from "./UpsellHosting";
-export * from "./UpsellPerformanceTools";
export * from "./UpsellPermissions";
export * from "./UpsellRemoteSync";
export * from "./UpsellSSO";
diff --git a/frontend/src/metabase/api/api.ts b/frontend/src/metabase/api/api.ts
index f79cc5b38f7..5bd62fd43d8 100644
--- a/frontend/src/metabase/api/api.ts
+++ b/frontend/src/metabase/api/api.ts
@@ -16,17 +16,77 @@ import { metabaseReduxContext } from "metabase/redux";
import { TAG_TYPES } from "./tags";
+// Extra cache-key that callers can mix into a query arg to get a
+// dedicated RTK cache entry and an independent abort scope per
+// subscriber.
+export const RTK_CACHE_KEY_PARAM = "__rtkCacheKey";
+
+export type RtkCacheKeyed = { [RTK_CACHE_KEY_PARAM]?: unknown };
+
+type WithoutRtkCacheKey<T> = T extends object
+ ? Omit<T, typeof RTK_CACHE_KEY_PARAM>
+ : T;
+
+function omitRtkCacheKey<T>(value: T): WithoutRtkCacheKey<T>;
+function omitRtkCacheKey(value: unknown): unknown {
+ if (
+ value == null ||
+ typeof value !== "object" ||
+ !(RTK_CACHE_KEY_PARAM in value)
+ ) {
+ return value;
+ }
+ const { [RTK_CACHE_KEY_PARAM]: _omitted, ...rest } = value;
+ return rest;
+}
+
+function stripRtkCacheKey<T extends { params?: unknown; body?: unknown }>(
+ requestArgs: T,
+): T {
+ const params = omitRtkCacheKey(requestArgs.params);
+ const body = omitRtkCacheKey(requestArgs.body);
+ if (params === requestArgs.params && body === requestArgs.body) {
+ return requestArgs;
+ }
+ return {
+ ...requestArgs,
+ ...(params !== requestArgs.params ? { params } : null),
+ ...(body !== requestArgs.body ? { body } : null),
+ };
+}
+
+type ApiRequestArgs = Parameters<typeof api.request>[0];
+type BaseQueryArgs =
+ | string
+ | (Omit<ApiRequestArgs, "method" | "params" | "url"> & {
+ method?: ApiRequestArgs["method"];
+ params?: Record<string, unknown> | null | void;
+ url: ApiRequestArgs["url"] | null;
+ });
+
// Adapts our legacy API client to RTK Query's `BaseQueryFn` contract: pull the
// abort signal off the query lifecycle context and turn the client's
// resolve/throw into RTK's `{ data } | { error }` shape. All request-shaping and
// validation lives in the client itself.
-export const baseQuery: BaseQueryFn = async (args, ctx, extraOptions) => {
- const requestArgs = typeof args === "string" ? { url: args } : args;
+export const baseQuery: BaseQueryFn<BaseQueryArgs, unknown, unknown> = async (
+ args,
+ ctx,
+ extraOptions,
+) => {
+ const requestArgs = stripRtkCacheKey(
+ typeof args === "string" ? { url: args } : args,
+ );
+ const { url } = requestArgs;
+ if (url === null) {
+ return { error: new Error("API request URL is not configured") };
+ }
try {
const method = requestArgs.method ?? "GET";
const data = await api.request({
method: "GET",
...requestArgs,
+ url,
+ params: requestArgs.params == null ? undefined : requestArgs.params,
retry: method === "GET" || method === "POST",
signal: ctx.signal,
...extraOptions,
diff --git a/frontend/src/metabase/api/api.unit.spec.ts b/frontend/src/metabase/api/api.unit.spec.ts
index aa9601392fe..e5dba86ecfe 100644
--- a/frontend/src/metabase/api/api.unit.spec.ts
+++ b/frontend/src/metabase/api/api.unit.spec.ts
@@ -19,7 +19,7 @@ describe("baseQuery (RTK Query adapter)", () => {
{ method: "POST", retry: true },
{ method: "PUT", retry: false },
{ method: "DELETE", retry: false },
- ])("passes retry=$retry for $method", async ({ method, retry }) => {
+ ] as const)("passes retry=$retry for $method", async ({ method, retry }) => {
const requestSpy = jest.spyOn(api, "request").mockResolvedValue({});
await baseQuery({ method, url: "/api/thing" }, ctx, {});
@@ -43,6 +43,17 @@ describe("baseQuery (RTK Query adapter)", () => {
);
});
+ it("returns an error when the URL is not configured", async () => {
+ const requestSpy = jest.spyOn(api, "request").mockResolvedValue({});
+
+ const result = await baseQuery({ url: null }, ctx, {});
+
+ expect(result).toEqual({
+ error: new Error("API request URL is not configured"),
+ });
+ expect(requestSpy).not.toHaveBeenCalled();
+ });
+
it("forwards the lifecycle abort signal to the client", async () => {
const requestSpy = jest.spyOn(api, "request").mockResolvedValue({});
diff --git a/frontend/src/metabase/api/card.ts b/frontend/src/metabase/api/card.ts
index 0185f14cb37..5e124ca4f29 100644
--- a/frontend/src/metabase/api/card.ts
+++ b/frontend/src/metabase/api/card.ts
@@ -22,7 +22,7 @@ import type {
} from "metabase-types/api";
import type { EntityToken, EntityUuid } from "metabase-types/api/entity";
-import { Api } from "./api";
+import { Api, type RtkCacheKeyed } from "./api";
import {
idTag,
invalidateTags,
@@ -98,13 +98,8 @@ export const cardApi = Api.injectEndpoints({
metadata ? provideCardQueryMetadataTags(id, metadata) : [],
onQueryStarted: hydrateMetadataStore(QueryMetadataSchema),
}),
- getCardQuery: builder.query<
- Dataset,
- CardQueryRequest & { _refetchDeps?: unknown }
- >({
- // `_refetchDeps` is part of the RTK cache key (so imperative runners can
- // force a unique key per call) but must not be sent to the server.
- query: ({ cardId, _refetchDeps, ...body }) => ({
+ getCardQuery: builder.query<Dataset, CardQueryRequest & RtkCacheKeyed>({
+ query: ({ cardId, ...body }) => ({
method: "POST",
url: `/api/card/${cardId}/query`,
body,
@@ -114,9 +109,9 @@ export const cardApi = Api.injectEndpoints({
}),
getCardQueryPivot: builder.query<
Dataset,
- CardQueryRequest & { _refetchDeps?: unknown }
+ CardQueryRequest & RtkCacheKeyed
>({
- query: ({ cardId, _refetchDeps, ...body }) => ({
+ query: ({ cardId, ...body }) => ({
method: "POST",
url: `/api/card/pivot/${cardId}/query`,
body,
diff --git a/frontend/src/metabase/api/dashboard.ts b/frontend/src/metabase/api/dashboard.ts
index 405fdbbd3d1..94436d8762a 100644
--- a/frontend/src/metabase/api/dashboard.ts
+++ b/frontend/src/metabase/api/dashboard.ts
@@ -27,7 +27,7 @@ import type {
UpdateDashboardRequest,
} from "metabase-types/api";
-import { Api } from "./api";
+import { Api, type RtkCacheKeyed } from "./api";
import {
idTag,
invalidateTags,
@@ -103,17 +103,9 @@ export const dashboardApi = Api.injectEndpoints({
}),
getDashboardCardQuery: builder.query<
Dataset,
- DashboardCardQueryRequest & { _refetchDeps?: unknown }
+ DashboardCardQueryRequest & RtkCacheKeyed
>({
- // `_refetchDeps` is part of the RTK cache key (so imperative runners can
- // force a unique key per call) but must not be sent to the server.
- query: ({
- dashboardId,
- dashcardId,
- cardId,
- _refetchDeps,
- ...body
- }) => ({
+ query: ({ dashboardId, dashcardId, cardId, ...body }) => ({
method: "POST",
url: `/api/dashboard/${dashboardId}/dashcard/${dashcardId}/card/${cardId}/query`,
body,
@@ -123,15 +115,9 @@ export const dashboardApi = Api.injectEndpoints({
}),
getDashboardCardQueryPivot: builder.query<
Dataset,
- DashboardCardQueryRequest & { _refetchDeps?: unknown }
+ DashboardCardQueryRequest & RtkCacheKeyed
>({
- query: ({
- dashboardId,
- dashcardId,
- cardId,
- _refetchDeps,
- ...body
- }) => ({
+ query: ({ dashboardId, dashcardId, cardId, ...body }) => ({
method: "POST",
url: `/api/dashboard/pivot/${dashboardId}/dashcard/${dashcardId}/card/${cardId}/query`,
body,
diff --git a/frontend/src/metabase/api/dataset.ts b/frontend/src/metabase/api/dataset.ts
index b33a899379b..53acefddd4e 100644
--- a/frontend/src/metabase/api/dataset.ts
+++ b/frontend/src/metabase/api/dataset.ts
@@ -6,10 +6,11 @@ import type {
DatasetQuery,
FieldValue,
GetRemappedParameterValueRequest,
+ InternalDatasetQuery,
NativeDatasetResponse,
} from "metabase-types/api";
-import { Api } from "./api";
+import { Api, type RtkCacheKeyed } from "./api";
import {
provideAdhocDatasetTags,
provideAdhocQueryMetadataTags,
@@ -17,14 +18,6 @@ import {
} from "./tags";
import { handleQueryFulfilled } from "./utils/lifecycle";
-interface RefetchDeps {
- /**
- * This attribute won't be a part of the API request and can be used to invalidate
- * the cache of a given RTK query using its built-in caching mechanism.
- */
- _refetchDeps?: unknown;
-}
-
interface IgnorableError {
ignore_error?: boolean;
}
@@ -63,9 +56,9 @@ export const datasetApi = Api.injectEndpoints({
}),
getAdhocQuery: builder.query<
Dataset,
- DatasetQuery & RefetchDeps & IgnorableError
+ (DatasetQuery | InternalDatasetQuery) & RtkCacheKeyed & IgnorableError
>({
- query: ({ _refetchDeps, ignore_error, ...body }) => ({
+ query: ({ ignore_error, ...body }) => ({
method: "POST",
url: "/api/dataset",
body,
@@ -85,10 +78,10 @@ export const datasetApi = Api.injectEndpoints({
pivot_cols?: number[];
show_row_totals?: boolean;
show_column_totals?: boolean;
- } & RefetchDeps &
+ } & RtkCacheKeyed &
IgnorableError
>({
- query: ({ _refetchDeps, ignore_error, ...body }) => ({
+ query: ({ ignore_error, ...body }) => ({
method: "POST",
url: "/api/dataset/pivot",
body,
diff --git a/frontend/src/metabase/api/notification.ts b/frontend/src/metabase/api/notification.ts
index eaaa8d76505..aceda51daba 100644
--- a/frontend/src/metabase/api/notification.ts
+++ b/frontend/src/metabase/api/notification.ts
@@ -177,6 +177,7 @@ export const {
useUnsubscribeFromNotificationMutation,
useSendUnsavedNotificationMutation,
useAdminListNotificationsQuery,
+ useLazyAdminListNotificationsQuery,
useBulkNotificationActionMutation,
useAdminNotificationDetailQuery,
useUnsubscribeFromNotificationByEmailMutation,
diff --git a/frontend/src/metabase/api/persist.ts b/frontend/src/metabase/api/persist.ts
index dd3fb751bfb..d42ec6d0ba0 100644
--- a/frontend/src/metabase/api/persist.ts
+++ b/frontend/src/metabase/api/persist.ts
@@ -74,6 +74,7 @@ export const persistApi = Api.injectEndpoints({
export const {
useListPersistedInfoQuery,
+ useLazyListPersistedInfoQuery,
useGetPersistedInfoQuery,
useGetPersistedInfoByCardQuery,
useEnablePersistMutation,
diff --git a/frontend/src/metabase/api/task.ts b/frontend/src/metabase/api/task.ts
index a4d54aad9c7..b654e9558a6 100644
--- a/frontend/src/metabase/api/task.ts
+++ b/frontend/src/metabase/api/task.ts
@@ -84,10 +84,13 @@ export const taskApi = Api.injectEndpoints({
export const {
useListTasksQuery,
+ useLazyListTasksQuery,
useListUniqueTasksQuery,
useGetTaskQuery,
useGetTasksInfoQuery,
useListTaskRunsQuery,
+ useLazyListTaskRunsQuery,
useGetTaskRunQuery,
useListTaskRunEntitiesQuery,
+ useLazyListTaskRunEntitiesQuery,
} = taskApi;
diff --git a/frontend/src/metabase/app/selectors.ts b/frontend/src/metabase/app/selectors.ts
index 23f9118fda4..b81ae6d0790 100644
--- a/frontend/src/metabase/app/selectors.ts
+++ b/frontend/src/metabase/app/selectors.ts
@@ -35,6 +35,10 @@ export const getIsDataStudioApp = createSelector([getRouterPath], (path) => {
return path.startsWith("/data-studio");
});
+export const getIsMonitorApp = createSelector([getRouterPath], (path) => {
+ return path.startsWith("/monitor");
+});
+
export const getIsDataApp = createSelector([getRouterPath], (path) => {
return path.startsWith(`${Urls.DATA_APP_ROOT_URL}/`);
});
@@ -73,6 +77,7 @@ const PATHS_WITHOUT_NAVBAR = [
/^\/setup/,
/^\/auth/,
/^\/data-studio/,
+ /^\/monitor/,
// Data apps run full-page with their own custom chrome (a hover-down panel),
// so neither the left navbar nor the top app bar should be shown.
new RegExp(`^${Urls.DATA_APP_ROOT_URL}/`),
@@ -192,6 +197,7 @@ export const getIsAppBarVisible = createSelector(
getRouterHash,
getIsAdminApp,
getIsDataStudioApp,
+ getIsMonitorApp,
getIsEditingDashboard,
getIsEmbeddingIframe,
getIsEmbeddedAppBarVisible,
@@ -202,6 +208,7 @@ export const getIsAppBarVisible = createSelector(
hash,
isAdminApp,
isDataStudioApp,
+ isMonitorApp,
isEditingDashboard,
isEmbedded,
isEmbeddedAppBarVisible,
@@ -213,6 +220,7 @@ export const getIsAppBarVisible = createSelector(
(isEmbedded && !isEmbeddedAppBarVisible) ||
isAdminApp ||
isDataStudioApp ||
+ isMonitorApp ||
isEditingDashboard ||
isFullscreen
) {
diff --git a/frontend/src/metabase/app/selectors.unit.spec.ts b/frontend/src/metabase/app/selectors.unit.spec.ts
index 29c9c146606..6e4e6b4b37e 100644
--- a/frontend/src/metabase/app/selectors.unit.spec.ts
+++ b/frontend/src/metabase/app/selectors.unit.spec.ts
@@ -1,8 +1,13 @@
import { createMockState } from "metabase/redux/store/mocks";
import type { Location } from "metabase/router";
import type { RouterProps } from "metabase/selectors/app";
+import { createMockUser } from "metabase-types/api/mocks";
-import { getIsCollectionPathVisible } from "./selectors";
+import {
+ getIsAppBarVisible,
+ getIsCollectionPathVisible,
+ getIsNavBarEnabled,
+} from "./selectors";
const createLocation = (pathname: string): Location =>
// Unjustified type cast. FIXME
@@ -42,3 +47,37 @@ describe("getIsCollectionPathVisible", () => {
expect(getIsCollectionPathVisible(state, props)).toBe(false);
});
});
+
+describe("NavBar / AppBar visibility", () => {
+ const stateWithUser = () =>
+ createMockState({ currentUser: createMockUser() });
+
+ it("hides the navbar and app bar within Monitor, Data Studio", () => {
+ const state = stateWithUser();
+
+ expect(getIsNavBarEnabled(state, createRouterProps("/monitor"))).toBe(
+ false,
+ );
+ expect(getIsNavBarEnabled(state, createRouterProps("/data-studio"))).toBe(
+ false,
+ );
+
+ expect(getIsAppBarVisible(state, createRouterProps("/monitor"))).toBe(
+ false,
+ );
+ expect(getIsAppBarVisible(state, createRouterProps("/data-studio"))).toBe(
+ false,
+ );
+ });
+
+ it("keeps the navbar and app bar on a regular page", () => {
+ const state = stateWithUser();
+
+ expect(
+ getIsNavBarEnabled(state, createRouterProps("/browse/databases")),
+ ).toBe(true);
+ expect(
+ getIsAppBarVisible(state, createRouterProps("/browse/databases")),
+ ).toBe(true);
+ });
+});
diff --git a/frontend/src/metabase/common/components/ErrorPages/ErrorDiagnosticModal.unit.spec.tsx b/frontend/src/metabase/common/components/ErrorPages/ErrorDiagnosticModal.unit.spec.tsx
index 0be98b74172..9a40f78291f 100644
--- a/frontend/src/metabase/common/components/ErrorPages/ErrorDiagnosticModal.unit.spec.tsx
+++ b/frontend/src/metabase/common/components/ErrorPages/ErrorDiagnosticModal.unit.spec.tsx
@@ -27,7 +27,7 @@ const defaultErrorPayload: ErrorPayload = {
process_uuid: "123",
fqns: "metabase.query-processor.middleware.catch-exceptions",
msg: "Backend error 1",
- exception: "Backend error 1 stacktrace",
+ exception: ["Backend error 1 stacktrace"],
},
],
userLogs: [
@@ -37,7 +37,7 @@ const defaultErrorPayload: ErrorPayload = {
process_uuid: "123",
fqns: "metabase.query-processor.middleware.catch-exceptions",
msg: "Backend error 1",
- exception: "Backend error 1 stacktrace",
+ exception: ["Backend error 1 stacktrace"],
},
],
logs: [
@@ -47,7 +47,7 @@ const defaultErrorPayload: ErrorPayload = {
process_uuid: "123",
fqns: "metabase.query-processor.middleware.catch-exceptions",
msg: "Backend error 1",
- exception: "Backend error 1 stacktrace",
+ exception: ["Backend error 1 stacktrace"],
},
],
entityName: "question",
diff --git a/frontend/src/metabase/common/components/LinkTab/LinkTab.tsx b/frontend/src/metabase/common/components/LinkTab/LinkTab.tsx
new file mode 100644
index 00000000000..4fbac99dde8
--- /dev/null
+++ b/frontend/src/metabase/common/components/LinkTab/LinkTab.tsx
@@ -0,0 +1,24 @@
+import type { FC } from "react";
+
+import { Link } from "metabase/router";
+import { Tabs, type TabsTabProps } from "metabase/ui";
+
+/**
+ * Mantine's `Tabs.Tab` is built with the non-polymorphic `factory`, so
+ * `component`/`to` aren't in its prop types. However it still accepts the
+ * prop and it works as expected, thus type casting.
+ */
+const TabsTabAsLink = Tabs.Tab as FC<
+ TabsTabProps & { component: typeof Link; to: string }
+>;
+
+type LinkTabProps = TabsTabProps & {
+ to: string;
+};
+
+/**
+ * Mantine tab that navigates as a react-router link.
+ */
+export function LinkTab(props: LinkTabProps) {
+ return <TabsTabAsLink {...props} component={Link} />;
+}
diff --git a/frontend/src/metabase/common/components/LinkTab/index.ts b/frontend/src/metabase/common/components/LinkTab/index.ts
new file mode 100644
index 00000000000..d2a47fe6104
--- /dev/null
+++ b/frontend/src/metabase/common/components/LinkTab/index.ts
@@ -0,0 +1 @@
+export * from "./LinkTab";
diff --git a/frontend/src/metabase/common/components/PaginationControls/PaginationControls.tsx b/frontend/src/metabase/common/components/PaginationControls/PaginationControls.tsx
index b1c076d489a..f58b44c40c2 100644
--- a/frontend/src/metabase/common/components/PaginationControls/PaginationControls.tsx
+++ b/frontend/src/metabase/common/components/PaginationControls/PaginationControls.tsx
@@ -35,6 +35,12 @@ export const PaginationControls = ({
const isNextDisabled =
total != null ? isLastPage(page, pageSize, total) : !onNextPage;
+ const rangeStart = page * pageSize + 1;
+ const rangeEnd =
+ total != null
+ ? Math.min(page * pageSize + itemsLength, total)
+ : page * pageSize + itemsLength;
+
return (
<Group
align="center"
@@ -44,7 +50,7 @@ export const PaginationControls = ({
{...props}
>
<Text component="span" mr="sm">
- {page * pageSize + 1} - {page * pageSize + itemsLength}
+ {rangeStart} - {rangeEnd}
{showTotal && (
<>
<Text component="span" c="text-disabled">
diff --git a/frontend/src/metabase/common/components/PaginationControls/PaginationControls.unit.spec.tsx b/frontend/src/metabase/common/components/PaginationControls/PaginationControls.unit.spec.tsx
index b310a072434..d945076cc0d 100644
--- a/frontend/src/metabase/common/components/PaginationControls/PaginationControls.unit.spec.tsx
+++ b/frontend/src/metabase/common/components/PaginationControls/PaginationControls.unit.spec.tsx
@@ -107,4 +107,18 @@ describe("PaginationControls", () => {
const container = screen.getByTestId("test-container");
expect(container).toHaveTextContent("251 - 275");
});
+
+ it("should clamp the item range to the total when stale items from the previous page overshoot it", () => {
+ setup({
+ page: 2,
+ pageSize: 25,
+ itemsLength: 25,
+ total: 53,
+ showTotal: true,
+ onNextPage: () => {},
+ onPreviousPage: () => {},
+ });
+ const container = screen.getByTestId("test-container");
+ expect(container).toHaveTextContent("51 - 53 of 53");
+ });
});
diff --git a/frontend/src/metabase/common/components/upsells/constants.ts b/frontend/src/metabase/common/components/upsells/constants.ts
index e8a9c3e7785..f355c60dc5d 100644
--- a/frontend/src/metabase/common/components/upsells/constants.ts
+++ b/frontend/src/metabase/common/components/upsells/constants.ts
@@ -1,2 +1,3 @@
export const UPGRADE_URL = "https://www.metabase.com/upgrade";
export const DATA_STUDIO_UPGRADE_URL = `${UPGRADE_URL}/data-studio`;
+export const MONITOR_UPGRADE_URL = `${UPGRADE_URL}/monitor`;
diff --git a/frontend/src/metabase/common/data-studio/components/PaneHeader/PaneHeader.tsx b/frontend/src/metabase/common/data-studio/components/PaneHeader/PaneHeader.tsx
index 7036f6a67fe..b730c6d6da6 100644
--- a/frontend/src/metabase/common/data-studio/components/PaneHeader/PaneHeader.tsx
+++ b/frontend/src/metabase/common/data-studio/components/PaneHeader/PaneHeader.tsx
@@ -1,12 +1,12 @@
-import type { FC, ReactNode } from "react";
+import type { ReactNode } from "react";
import { t } from "ttag";
import { EditableText } from "metabase/common/components/EditableText";
+import { LinkTab } from "metabase/common/components/LinkTab";
import { UpsellGem } from "metabase/common/components/upsells/components/UpsellGem";
import { MetabotDataStudioButton } from "metabase/metabot/components/MetabotDataStudioButton";
import { AppSwitcher } from "metabase/nav/components/AppSwitcher";
import { useSelector } from "metabase/redux";
-import { Link } from "metabase/router";
import { getLocation } from "metabase/selectors/routing";
import {
Box,
@@ -17,7 +17,6 @@ import {
Stack,
type StackProps,
Tabs,
- type TabsTabProps,
Tooltip,
} from "metabase/ui";
import type { IconName } from "metabase-types/api";
@@ -138,15 +137,6 @@ type PaneHeaderTabsProps = {
tabs: PaneHeaderTab[];
};
-/**
- * Mantine's `Tabs.Tab` is built with the non-polymorphic `factory`, so
- * `component`/`to` aren't in its prop types. However it still accepts the
- * prop and it works as expected, thus type casting.
- */
-const LinkTab = Tabs.Tab as FC<
- TabsTabProps & { component: typeof Link; to: string }
->;
-
function isTabSelected(tab: PaneHeaderTab, pathname: string) {
const { to, isSelected } = tab;
return typeof isSelected === "function"
@@ -165,7 +155,6 @@ export function PaneHeaderTabs({ tabs }: PaneHeaderTabsProps) {
<LinkTab
key={label}
value={to}
- component={Link}
to={to}
leftSection={icon != null ? <FixedSizeIcon name={icon} /> : null}
rightSection={isGated ? <UpsellGem.New size={14} /> : null}
diff --git a/frontend/src/metabase/common/hooks/index.ts b/frontend/src/metabase/common/hooks/index.ts
index 16c32d3f8ec..de81bc88a7c 100644
--- a/frontend/src/metabase/common/hooks/index.ts
+++ b/frontend/src/metabase/common/hooks/index.ts
@@ -1,4 +1,5 @@
export * from "./entity-framework";
+export * from "./use-abortable-query";
export * from "./use-confirmation";
export * from "./use-dnd-sensors";
export * from "./use-docs-url";
@@ -6,8 +7,10 @@ export * from "./use-get-personal-collection";
export * from "./use-has-token-feature";
export * from "./use-locale";
export * from "./use-notification-channels";
+export * from "./use-scroll-to-top";
export * from "./use-set-collection-preview";
export * from "./use-setting";
+export * from "./use-sorting-state-change";
export * from "./use-temp-storage";
export * from "./use-temporary-state";
export * from "./use-toast";
diff --git a/frontend/src/metabase/common/hooks/use-abortable-query.ts b/frontend/src/metabase/common/hooks/use-abortable-query.ts
new file mode 100644
index 00000000000..612c475586c
--- /dev/null
+++ b/frontend/src/metabase/common/hooks/use-abortable-query.ts
@@ -0,0 +1,108 @@
+import { skipToken } from "@reduxjs/toolkit/query";
+import { useCallback, useEffect, useRef } from "react";
+import _ from "underscore";
+
+import { RTK_CACHE_KEY_PARAM } from "metabase/api/api";
+import { isAbortError } from "metabase/api/client";
+import { useUniqueId } from "metabase/common/hooks/use-unique-id";
+
+type LazyQueryResult = {
+ error?: unknown;
+ isLoading: boolean;
+ isFetching: boolean;
+ isUninitialized: boolean;
+};
+
+type LazyQueryRequest = {
+ abort: () => void;
+ unsubscribe: () => void;
+};
+
+type UseAbortableQueryOptions = {
+ skip?: boolean;
+ // Same as in `useQuery`, but without `number` support, since we work with lazy queries.
+ refetchOnMountOrArgChange?: boolean;
+};
+
+/**
+ * Runs an RTK lazy query and aborts the previous in-flight request whenever the
+ * arg changes, on unmount, or when the query becomes skipped.
+ *
+ * Caching mirrors `useQuery`: cache-first by default.
+ *
+ * Each hook instance gets its own RTK cache entry, so aborting is safe.
+ * The trade-off is that instances don't share cached responses and
+ * identical concurrent requests aren't deduplicated.
+ *
+ * Skipping: pass `skipToken` as the arg, or set `{ skip: true }`.
+ */
+export function useAbortableQuery<
+ Arg extends object,
+ TResult extends LazyQueryResult,
+>(
+ useLazyQueryHook: () => readonly [
+ (arg: Arg, preferCacheValue?: boolean) => LazyQueryRequest,
+ TResult,
+ ...unknown[],
+ ],
+ arg: Arg | typeof skipToken,
+ {
+ skip: skipOption = false,
+ refetchOnMountOrArgChange = false,
+ }: UseAbortableQueryOptions = {},
+): TResult & { refetch: () => void } {
+ const [trigger, result] = useLazyQueryHook();
+ const requestRef = useRef<LazyQueryRequest | null>(null);
+ const instanceKey = useUniqueId("abortable-query");
+
+ const skip = skipOption || arg === skipToken;
+
+ const argRef = useRef(arg);
+ if (arg !== skipToken && !_.isEqual(argRef.current, arg)) {
+ argRef.current = arg;
+ }
+ const stableArg = argRef.current;
+
+ const run = useCallback(
+ (preferCache: boolean) => {
+ if (stableArg === skipToken) {
+ return null;
+ }
+ requestRef.current?.abort();
+ const request = trigger(
+ { ...stableArg, [RTK_CACHE_KEY_PARAM]: instanceKey },
+ preferCache,
+ );
+ requestRef.current = request;
+ return request;
+ },
+ [trigger, stableArg, instanceKey],
+ );
+
+ const refetch = useCallback(() => {
+ if (!skip) {
+ run(false);
+ }
+ }, [run, skip]);
+
+ useEffect(() => {
+ if (skip) {
+ // Unsubscribing to prevent the query from being re-fetched when the component is re-mounted, since the query is skipped.
+ requestRef.current?.abort();
+ requestRef.current?.unsubscribe();
+ requestRef.current = null;
+ return;
+ }
+ run(!refetchOnMountOrArgChange);
+ return () => requestRef.current?.abort();
+ }, [run, skip, refetchOnMountOrArgChange]);
+
+ return {
+ ...result,
+ // Aborted cancellation error is dropped to avoid flashing the error view.
+ error: isAbortError(result.error) ? undefined : result.error,
+ isLoading: !skip && (result.isLoading || result.isUninitialized),
+ isFetching: !skip && (result.isFetching || result.isUninitialized),
+ refetch,
+ };
+}
diff --git a/frontend/src/metabase/common/hooks/use-abortable-query.unit.spec.tsx b/frontend/src/metabase/common/hooks/use-abortable-query.unit.spec.tsx
new file mode 100644
index 00000000000..5cdea403b92
--- /dev/null
+++ b/frontend/src/metabase/common/hooks/use-abortable-query.unit.spec.tsx
@@ -0,0 +1,474 @@
+import { QueryStatus, skipToken } from "@reduxjs/toolkit/query";
+import fetchMock from "fetch-mock";
+
+import { act, renderHookWithProviders, waitFor } from "__support__/ui";
+import { Api, useLazyListTasksQuery } from "metabase/api";
+import { listTag } from "metabase/api/tags";
+import type { ListTasksRequest, ListTasksResponse } from "metabase-types/api";
+import { createMockTask } from "metabase-types/api/mocks";
+
+import { useAbortableQuery } from "./use-abortable-query";
+
+const PAGE_0_TASK_ID = 1;
+const PAGE_1_TASK_ID = 2;
+
+function makeResponse(taskId: number): ListTasksResponse {
+ return {
+ data: [createMockTask({ id: taskId })],
+ limit: 50,
+ offset: 0,
+ total: 2,
+ };
+}
+
+function setup({
+ arg = { limit: 50, offset: 0 },
+ skip = false,
+ refetchOnMountOrArgChange = false,
+}: {
+ arg?: ListTasksRequest;
+ skip?: boolean;
+ refetchOnMountOrArgChange?: boolean;
+} = {}) {
+ return renderHookWithProviders(
+ ({ arg, skip }: { arg: ListTasksRequest; skip: boolean }) =>
+ useAbortableQuery(useLazyListTasksQuery, arg, {
+ skip,
+ refetchOnMountOrArgChange,
+ }),
+ { initialProps: { arg, skip } },
+ );
+}
+
+const getTaskCalls = () => fetchMock.callHistory.calls("path:/api/task");
+
+const getCallsForOffset = (offset: string) =>
+ getTaskCalls().filter((call) => call.url.includes(`offset=${offset}`));
+
+describe("useAbortableQuery", () => {
+ it("aborts the previous in-flight request when the arg changes and only the latest response lands", async () => {
+ fetchMock.get({
+ url: "path:/api/task",
+ query: { offset: "0" },
+ name: "page-0",
+ response: makeResponse(PAGE_0_TASK_ID),
+ delay: 200,
+ });
+ fetchMock.get({
+ url: "path:/api/task",
+ query: { offset: "50" },
+ name: "page-1",
+ response: makeResponse(PAGE_1_TASK_ID),
+ delay: 10,
+ });
+
+ const { result, rerender } = setup({ arg: { limit: 50, offset: 0 } });
+
+ const getPage0Call = () =>
+ getTaskCalls().find((call) => call.url.includes("offset=0"));
+ await waitFor(() => expect(getPage0Call()).toBeDefined());
+
+ rerender({ arg: { limit: 50, offset: 50 }, skip: false });
+
+ await waitFor(() => {
+ expect(result.current.data?.data[0].id).toBe(PAGE_1_TASK_ID);
+ });
+
+ expect(getPage0Call()?.request?.signal.aborted).toBe(true);
+
+ expect(result.current.error).toBeUndefined();
+ });
+
+ it("never surfaces the abort error", async () => {
+ fetchMock.get({
+ url: "path:/api/task",
+ query: { offset: "0" },
+ name: "page-0",
+ response: makeResponse(PAGE_0_TASK_ID),
+ delay: 50,
+ });
+ fetchMock.get({
+ url: "path:/api/task",
+ query: { offset: "50" },
+ name: "page-1",
+ response: makeResponse(PAGE_1_TASK_ID),
+ delay: 300,
+ });
+
+ const { result, rerender } = setup({ arg: { limit: 50, offset: 0 } });
+
+ const getPage0Call = () =>
+ getTaskCalls().find((call) => call.url.includes("offset=0"));
+ await waitFor(() => expect(getPage0Call()).toBeDefined());
+
+ rerender({ arg: { limit: 50, offset: 50 }, skip: false });
+
+ await waitFor(() =>
+ expect(getPage0Call()?.request?.signal.aborted).toBe(true),
+ );
+
+ expect(result.current.error).toBeUndefined();
+ expect(result.current.isFetching).toBe(true);
+
+ await waitFor(() => {
+ expect(result.current.data?.data[0].id).toBe(PAGE_1_TASK_ID);
+ });
+ expect(result.current.error).toBeUndefined();
+ });
+
+ it("does not re-trigger or abort when a referentially new but deeply-equal arg is passed, and refetch is triggered exactly once", async () => {
+ fetchMock.get("path:/api/task", makeResponse(PAGE_0_TASK_ID));
+
+ const { result, rerender } = setup({ arg: { limit: 50, offset: 0 } });
+
+ await waitFor(() => expect(getTaskCalls()).toHaveLength(1));
+
+ rerender({ arg: { limit: 50, offset: 0 }, skip: false });
+
+ expect(getTaskCalls()).toHaveLength(1);
+ expect(getTaskCalls()[0]?.request?.signal.aborted).toBe(false);
+
+ act(() => {
+ result.current.refetch();
+ });
+
+ await waitFor(() => expect(getTaskCalls()).toHaveLength(2));
+ });
+
+ it("serves a cache hit without a network request by default, while refetch still hits the network", async () => {
+ fetchMock.get("path:/api/task", makeResponse(PAGE_0_TASK_ID));
+
+ const { result, rerender } = setup({ arg: { limit: 50, offset: 0 } });
+ await waitFor(() =>
+ expect(result.current.data?.data[0].id).toBe(PAGE_0_TASK_ID),
+ );
+ expect(getTaskCalls()).toHaveLength(1);
+
+ rerender({ arg: { limit: 50, offset: 0 }, skip: true });
+ rerender({ arg: { limit: 50, offset: 0 }, skip: false });
+ await waitFor(() =>
+ expect(result.current.data?.data[0].id).toBe(PAGE_0_TASK_ID),
+ );
+ expect(getTaskCalls()).toHaveLength(1);
+
+ act(() => {
+ result.current.refetch();
+ });
+ await waitFor(() => expect(getTaskCalls()).toHaveLength(2));
+ });
+
+ it("refetches a live cache entry when refetchOnMountOrArgChange is set", async () => {
+ fetchMock.get("path:/api/task", makeResponse(PAGE_0_TASK_ID));
+
+ const { result, rerender } = setup({
+ arg: { limit: 50, offset: 0 },
+ refetchOnMountOrArgChange: true,
+ });
+ await waitFor(() =>
+ expect(result.current.data?.data[0].id).toBe(PAGE_0_TASK_ID),
+ );
+ expect(getTaskCalls()).toHaveLength(1);
+
+ rerender({ arg: { limit: 50, offset: 0 }, skip: true });
+ rerender({ arg: { limit: 50, offset: 0 }, skip: false });
+ await waitFor(() => expect(getTaskCalls()).toHaveLength(2));
+ });
+
+ it("aborts the in-flight request on unmount", async () => {
+ fetchMock.get({
+ url: "path:/api/task",
+ response: makeResponse(PAGE_0_TASK_ID),
+ delay: 200,
+ });
+
+ const { unmount } = setup({ arg: { limit: 50, offset: 0 } });
+
+ const getCall = () => getTaskCalls()[0];
+ await waitFor(() => expect(getCall()).toBeDefined());
+
+ unmount();
+
+ expect(getCall()?.request?.signal.aborted).toBe(true);
+ });
+
+ it("aborts the in-flight request when the query becomes skipped, and refetches when unskipped", async () => {
+ fetchMock.get({
+ url: "path:/api/task",
+ response: makeResponse(PAGE_0_TASK_ID),
+ delay: 200,
+ });
+
+ const { result, store, rerender } = setup({
+ arg: { limit: 50, offset: 0 },
+ });
+
+ await waitFor(() => expect(getTaskCalls()).toHaveLength(1));
+
+ rerender({ arg: { limit: 50, offset: 0 }, skip: true });
+ expect(getTaskCalls()[0]?.request?.signal.aborted).toBe(true);
+ expect(result.current.error).toBeUndefined();
+
+ const hasPendingQuery = () =>
+ Object.values(store.getState()[Api.reducerPath].queries).some(
+ (query) => query?.status === QueryStatus.pending,
+ );
+ await waitFor(() => expect(hasPendingQuery()).toBe(false));
+
+ rerender({ arg: { limit: 50, offset: 0 }, skip: false });
+ await waitFor(() => expect(getTaskCalls()).toHaveLength(2));
+ });
+
+ it("issues no request while skipped", () => {
+ fetchMock.get("path:/api/task", makeResponse(PAGE_0_TASK_ID));
+
+ const { result } = setup({ arg: { limit: 50, offset: 0 }, skip: true });
+
+ expect(getTaskCalls()).toHaveLength(0);
+ expect(result.current.isLoading).toBe(false);
+ expect(result.current.isFetching).toBe(false);
+ expect(result.current.data).toBeUndefined();
+ });
+
+ it("refetches the subscribed list when its tag is invalidated", async () => {
+ fetchMock.get("path:/api/task", makeResponse(PAGE_0_TASK_ID));
+
+ const { result, store } = setup({ arg: { limit: 50, offset: 0 } });
+
+ await waitFor(() =>
+ expect(result.current.data?.data[0].id).toBe(PAGE_0_TASK_ID),
+ );
+ expect(getTaskCalls()).toHaveLength(1);
+
+ act(() => {
+ store.dispatch(Api.util.invalidateTags([listTag("task")]));
+ });
+
+ await waitFor(() => expect(getTaskCalls()).toHaveLength(2));
+ });
+
+ it("does not refetch a superseded arg when its tag is invalidated", async () => {
+ fetchMock.get({
+ url: "path:/api/task",
+ query: { offset: "0" },
+ name: "page-0",
+ response: makeResponse(PAGE_0_TASK_ID),
+ });
+ fetchMock.get({
+ url: "path:/api/task",
+ query: { offset: "50" },
+ name: "page-1",
+ response: makeResponse(PAGE_1_TASK_ID),
+ });
+
+ const { result, store, rerender } = setup({
+ arg: { limit: 50, offset: 0 },
+ });
+ await waitFor(() =>
+ expect(result.current.data?.data[0].id).toBe(PAGE_0_TASK_ID),
+ );
+
+ rerender({ arg: { limit: 50, offset: 50 }, skip: false });
+ await waitFor(() =>
+ expect(result.current.data?.data[0].id).toBe(PAGE_1_TASK_ID),
+ );
+
+ act(() => {
+ store.dispatch(Api.util.invalidateTags([listTag("task")]));
+ });
+
+ await waitFor(() => expect(getCallsForOffset("50")).toHaveLength(2));
+ expect(getCallsForOffset("0")).toHaveLength(1);
+ });
+
+ it("does not refetch a skipped query when its tag is invalidated", async () => {
+ fetchMock.get("path:/api/task", makeResponse(PAGE_0_TASK_ID));
+
+ const { result, store, rerender } = setup({
+ arg: { limit: 50, offset: 0 },
+ });
+
+ await waitFor(() =>
+ expect(result.current.data?.data[0].id).toBe(PAGE_0_TASK_ID),
+ );
+ expect(getTaskCalls()).toHaveLength(1);
+
+ rerender({ arg: { limit: 50, offset: 0 }, skip: true });
+
+ act(() => {
+ store.dispatch(Api.util.invalidateTags([listTag("task")]));
+ });
+
+ expect(getTaskCalls()).toHaveLength(1);
+ });
+
+ it("scopes the abort to its own hook instance, leaving a co-subscriber with the same arg unaffected", async () => {
+ fetchMock.get({
+ url: "path:/api/task",
+ query: { offset: "0" },
+ name: "page-0",
+ response: makeResponse(PAGE_0_TASK_ID),
+ delay: 200,
+ });
+ fetchMock.get({
+ url: "path:/api/task",
+ query: { offset: "50" },
+ name: "page-1",
+ response: makeResponse(PAGE_1_TASK_ID),
+ delay: 10,
+ });
+
+ const { result, rerender } = renderHookWithProviders(
+ ({ argA, argB }: { argA: ListTasksRequest; argB: ListTasksRequest }) => ({
+ a: useAbortableQuery(useLazyListTasksQuery, argA),
+ b: useAbortableQuery(useLazyListTasksQuery, argB),
+ }),
+ {
+ initialProps: {
+ argA: { limit: 50, offset: 0 },
+ argB: { limit: 50, offset: 0 },
+ },
+ },
+ );
+
+ // each instance has its own cache entry, so the identical arg is fetched twice
+ await waitFor(() => expect(getCallsForOffset("0")).toHaveLength(2));
+
+ rerender({
+ argA: { limit: 50, offset: 50 },
+ argB: { limit: 50, offset: 0 },
+ });
+
+ await waitFor(() => {
+ expect(result.current.a.data?.data[0].id).toBe(PAGE_1_TASK_ID);
+ });
+
+ const [callA, callB] = getCallsForOffset("0");
+ expect(callA?.request?.signal.aborted).toBe(true);
+ expect(callB?.request?.signal.aborted).toBe(false);
+
+ await waitFor(() => {
+ expect(result.current.b.data?.data[0].id).toBe(PAGE_0_TASK_ID);
+ });
+ expect(result.current.b.error).toBeUndefined();
+ });
+
+ it("does not send the per-instance cache key to the server", async () => {
+ fetchMock.get("path:/api/task", makeResponse(PAGE_0_TASK_ID));
+
+ const { result } = setup({ arg: { limit: 50, offset: 0 } });
+
+ await waitFor(() =>
+ expect(result.current.data?.data[0].id).toBe(PAGE_0_TASK_ID),
+ );
+ expect(getTaskCalls()[0]?.url).not.toContain("rtkCacheKey");
+ });
+
+ it("surfaces real errors", async () => {
+ fetchMock.get("path:/api/task", { status: 500 });
+
+ const { result } = setup({ arg: { limit: 50, offset: 0 } });
+
+ await waitFor(() => {
+ expect(result.current.error).toBeDefined();
+ });
+ });
+
+ it("does not fire a request when refetch is called while skipped", async () => {
+ fetchMock.get("path:/api/task", makeResponse(PAGE_0_TASK_ID));
+
+ const { result } = setup({ arg: { limit: 50, offset: 0 }, skip: true });
+
+ expect(getTaskCalls()).toHaveLength(0);
+
+ act(() => {
+ result.current.refetch();
+ });
+
+ await Promise.resolve();
+ expect(getTaskCalls()).toHaveLength(0);
+ });
+
+ describe("skipToken arg", () => {
+ function setupWithToken(initialArg: ListTasksRequest | typeof skipToken) {
+ return renderHookWithProviders(
+ ({ arg }: { arg: ListTasksRequest | typeof skipToken }) =>
+ useAbortableQuery(useLazyListTasksQuery, arg),
+ { initialProps: { arg: initialArg } },
+ );
+ }
+
+ it("issues no request while the arg is skipToken", async () => {
+ fetchMock.get("path:/api/task", makeResponse(PAGE_0_TASK_ID));
+
+ const { result } = setupWithToken(skipToken);
+
+ await Promise.resolve();
+ expect(getTaskCalls()).toHaveLength(0);
+ expect(result.current.isLoading).toBe(false);
+ expect(result.current.isFetching).toBe(false);
+ expect(result.current.data).toBeUndefined();
+ });
+
+ it("does not fire a request when refetch is called while the arg is skipToken", async () => {
+ fetchMock.get("path:/api/task", makeResponse(PAGE_0_TASK_ID));
+
+ const { result } = setupWithToken(skipToken);
+
+ act(() => {
+ result.current.refetch();
+ });
+
+ await Promise.resolve();
+ expect(getTaskCalls()).toHaveLength(0);
+ });
+
+ it("fires exactly one request when transitioning from skipToken to a real arg", async () => {
+ fetchMock.get("path:/api/task", makeResponse(PAGE_0_TASK_ID));
+
+ const { result, rerender } = setupWithToken(skipToken);
+
+ expect(getTaskCalls()).toHaveLength(0);
+
+ rerender({ arg: { limit: 50, offset: 0 } });
+
+ await waitFor(() =>
+ expect(result.current.data?.data[0].id).toBe(PAGE_0_TASK_ID),
+ );
+ expect(getTaskCalls()).toHaveLength(1);
+ });
+
+ it("preserves abort semantics after transitioning from skipToken to a real arg", async () => {
+ fetchMock.get({
+ url: "path:/api/task",
+ query: { offset: "0" },
+ name: "page-0",
+ response: makeResponse(PAGE_0_TASK_ID),
+ delay: 200,
+ });
+ fetchMock.get({
+ url: "path:/api/task",
+ query: { offset: "50" },
+ name: "page-1",
+ response: makeResponse(PAGE_1_TASK_ID),
+ delay: 10,
+ });
+
+ const { result, rerender } = setupWithToken(skipToken);
+
+ rerender({ arg: { limit: 50, offset: 0 } });
+
+ const getPage0Call = () =>
+ getTaskCalls().find((call) => call.url.includes("offset=0"));
+ await waitFor(() => expect(getPage0Call()).toBeDefined());
+
+ rerender({ arg: { limit: 50, offset: 50 } });
+
+ await waitFor(() => {
+ expect(result.current.data?.data[0].id).toBe(PAGE_1_TASK_ID);
+ });
+
+ expect(getPage0Call()?.request?.signal.aborted).toBe(true);
+ expect(result.current.error).toBeUndefined();
+ });
+ });
+});
diff --git a/frontend/src/metabase/common/hooks/use-scroll-to-top.ts b/frontend/src/metabase/common/hooks/use-scroll-to-top.ts
new file mode 100644
index 00000000000..cacbfa4c29d
--- /dev/null
+++ b/frontend/src/metabase/common/hooks/use-scroll-to-top.ts
@@ -0,0 +1,40 @@
+import { type RefObject, useLayoutEffect, useRef } from "react";
+import _ from "underscore";
+
+type UseScrollToTopProps = {
+ ref: RefObject<HTMLElement>;
+ keys: unknown[];
+ skip?: boolean;
+};
+
+/**
+ * Scrolls the element back to the top when `keys` change, e.g. after
+ * paginating or sorting.
+ *
+ * The scroll is deferred until `skip` is false.
+ */
+export function useScrollToTop({
+ ref,
+ keys,
+ skip = false,
+}: UseScrollToTopProps) {
+ const previousKeysRef = useRef(keys);
+ const keysVersionRef = useRef(0);
+ const isResetPendingRef = useRef(false);
+
+ if (!_.isEqual(previousKeysRef.current, keys)) {
+ previousKeysRef.current = keys;
+ keysVersionRef.current += 1;
+ isResetPendingRef.current = true;
+ }
+
+ const keysVersion = keysVersionRef.current;
+ useLayoutEffect(() => {
+ if (!skip && isResetPendingRef.current) {
+ isResetPendingRef.current = false;
+ if (ref.current) {
+ ref.current.scrollTop = 0;
+ }
+ }
+ }, [ref, skip, keysVersion]);
+}
diff --git a/frontend/src/metabase/common/hooks/use-scroll-to-top.unit.spec.tsx b/frontend/src/metabase/common/hooks/use-scroll-to-top.unit.spec.tsx
new file mode 100644
index 00000000000..3a44e7461f2
--- /dev/null
+++ b/frontend/src/metabase/common/hooks/use-scroll-to-top.unit.spec.tsx
@@ -0,0 +1,111 @@
+import { renderHook } from "@testing-library/react";
+import type { RefObject } from "react";
+
+import { useScrollToTop } from "./use-scroll-to-top";
+
+type Props = {
+ keys: unknown[];
+ skip: boolean;
+};
+
+function setup(initialProps: Props) {
+ const element = document.createElement("div");
+ const ref: RefObject<HTMLElement> = { current: element };
+ element.scrollTop = 100;
+
+ const view = renderHook(
+ ({ keys, skip }: Props) => useScrollToTop({ ref, keys, skip }),
+ { initialProps },
+ );
+
+ return { ...view, element };
+}
+
+describe("useScrollToTop", () => {
+ it("does not scroll on mount", () => {
+ const { element } = setup({ keys: [0], skip: false });
+ expect(element.scrollTop).toBe(100);
+ });
+
+ it("scrolls to top on a keys change while not skipped (cache-hit path)", () => {
+ const { rerender, element } = setup({ keys: [0], skip: false });
+ expect(element.scrollTop).toBe(100);
+
+ rerender({ keys: [1], skip: false });
+ expect(element.scrollTop).toBe(0);
+ });
+
+ it("defers the scroll until skip becomes false, then scrolls exactly once", () => {
+ const { rerender, element } = setup({ keys: [0], skip: false });
+
+ // Keys change while skipped (fetching): no scroll yet.
+ rerender({ keys: [1], skip: true });
+ expect(element.scrollTop).toBe(100);
+
+ // Fetch finishes: scroll now.
+ rerender({ keys: [1], skip: false });
+ expect(element.scrollTop).toBe(0);
+
+ // Reset the scroll position and toggle skip again: no further scroll,
+ // because the pending reset was already consumed.
+ element.scrollTop = 100;
+ rerender({ keys: [1], skip: true });
+ rerender({ keys: [1], skip: false });
+ expect(element.scrollTop).toBe(100);
+ });
+
+ it("does not scroll when skip toggles with unchanged keys", () => {
+ const { rerender, element } = setup({ keys: [0], skip: false });
+
+ rerender({ keys: [0], skip: true });
+ expect(element.scrollTop).toBe(100);
+
+ rerender({ keys: [0], skip: false });
+ expect(element.scrollTop).toBe(100);
+
+ rerender({ keys: [0], skip: true });
+ rerender({ keys: [0], skip: false });
+ expect(element.scrollTop).toBe(100);
+ });
+
+ it("scrolls on each distinct keys change", () => {
+ const { rerender, element } = setup({ keys: [0], skip: false });
+
+ rerender({ keys: [1], skip: false });
+ expect(element.scrollTop).toBe(0);
+
+ element.scrollTop = 100;
+ rerender({ keys: [2], skip: false });
+ expect(element.scrollTop).toBe(0);
+ });
+
+ it("treats deeply-equal object keys as unchanged", () => {
+ const { rerender, element } = setup({
+ keys: [1, { sortColumn: "name", sortDirection: "asc" }],
+ skip: false,
+ });
+
+ rerender({
+ keys: [1, { sortColumn: "name", sortDirection: "asc" }],
+ skip: false,
+ });
+ expect(element.scrollTop).toBe(100);
+
+ rerender({
+ keys: [1, { sortColumn: "name", sortDirection: "desc" }],
+ skip: false,
+ });
+ expect(element.scrollTop).toBe(0);
+ });
+
+ it("distinguishes key values that serialize identically", () => {
+ const { rerender, element } = setup({
+ keys: [undefined],
+ skip: false,
+ });
+
+ rerender({ keys: [null], skip: false });
+
+ expect(element.scrollTop).toBe(0);
+ });
+});
diff --git a/frontend/src/metabase/common/hooks/use-sorting-state-change.ts b/frontend/src/metabase/common/hooks/use-sorting-state-change.ts
new file mode 100644
index 00000000000..f47eda95ff7
--- /dev/null
+++ b/frontend/src/metabase/common/hooks/use-sorting-state-change.ts
@@ -0,0 +1,50 @@
+import type { SortingState, Updater } from "@tanstack/react-table";
+import { useCallback, useMemo } from "react";
+
+import {
+ getNextOptionalSorting,
+ getSortingState,
+ toSorting,
+ toSortingOptions,
+} from "metabase/utils/sorting";
+import type { SortingOptions } from "metabase-types/api";
+
+type UseSortingStateChangeProps<TColumn extends string> = {
+ sortingOptions: SortingOptions<TColumn>;
+ columns: readonly TColumn[];
+ defaultSorting: SortingOptions<TColumn>;
+ onSortingOptionsChange: (sortingOptions: SortingOptions<TColumn>) => void;
+};
+
+/**
+ * Adapter between TanStack Table sorting state and API's `SortingOptions` for
+ * manually-sorted tables.
+ * Falls back to `defaultSorting` when TanStack cycles to the unsorted state.
+ */
+export function useSortingStateChange<TColumn extends string>({
+ sortingOptions,
+ columns,
+ defaultSorting,
+ onSortingOptionsChange,
+}: UseSortingStateChangeProps<TColumn>) {
+ const sortingState = useMemo(
+ () => getSortingState(toSorting(sortingOptions)),
+ [sortingOptions],
+ );
+
+ const onSortingChange = useCallback(
+ (updater: Updater<SortingState>) => {
+ const newSortingState =
+ typeof updater === "function" ? updater(sortingState) : updater;
+
+ const nextOptionalSorting =
+ getNextOptionalSorting(newSortingState, columns) ??
+ toSorting(defaultSorting);
+
+ onSortingOptionsChange(toSortingOptions(nextOptionalSorting));
+ },
+ [sortingState, columns, defaultSorting, onSortingOptionsChange],
+ );
+
+ return { sortingState, onSortingChange };
+}
diff --git a/frontend/src/metabase/common/hooks/use-url-state/utils.ts b/frontend/src/metabase/common/hooks/use-url-state/utils.ts
index 2f6d93592a9..a766a90de18 100644
--- a/frontend/src/metabase/common/hooks/use-url-state/utils.ts
+++ b/frontend/src/metabase/common/hooks/use-url-state/utils.ts
@@ -1,3 +1,6 @@
+import { isSortColumn } from "metabase/utils/sorting";
+import type { SortDirection } from "metabase-types/api";
+
import type { QueryParam } from "./types";
export function getFirstParamValue(param: QueryParam) {
@@ -10,3 +13,26 @@ export const getAllParamValues = (param: QueryParam): string[] => {
}
return typeof param === "string" ? [param] : [];
};
+
+export function parsePage(param: QueryParam): number {
+ const value = getFirstParamValue(param);
+ const parsed = parseInt(value || "0", 10);
+ return Number.isFinite(parsed) && parsed >= 0 ? parsed : 0;
+}
+
+export function parseSortColumn<TColumn extends string>(
+ param: QueryParam,
+ columns: readonly TColumn[],
+ defaultColumn: TColumn,
+): TColumn {
+ const value = getFirstParamValue(param);
+ return value && isSortColumn(value, columns) ? value : defaultColumn;
+}
+
+export function parseSortDirection(
+ param: QueryParam,
+ defaultDirection: SortDirection,
+): SortDirection {
+ const value = getFirstParamValue(param);
+ return value === "asc" || value === "desc" ? value : defaultDirection;
+}
diff --git a/frontend/src/metabase/common/monitor/analytics.ts b/frontend/src/metabase/common/monitor/analytics.ts
new file mode 100644
index 00000000000..bfbb918f444
--- /dev/null
+++ b/frontend/src/metabase/common/monitor/analytics.ts
@@ -0,0 +1,21 @@
+import { trackSimpleEvent } from "metabase/analytics";
+import type {
+ MonitorOpenedEvent,
+ MonitorSectionClickedEvent,
+} from "metabase-types/analytics/event";
+
+export type MonitorSection = MonitorSectionClickedEvent["event_detail"];
+
+export const trackMonitorOpened = () => {
+ trackSimpleEvent({
+ event: "monitor_opened",
+ triggered_from: "nav_menu",
+ } satisfies MonitorOpenedEvent);
+};
+
+export const trackMonitorSectionClicked = (section: MonitorSection) => {
+ trackSimpleEvent({
+ event: "monitor_section_clicked",
+ event_detail: section,
+ } satisfies MonitorSectionClickedEvent);
+};
diff --git a/frontend/src/metabase/common/monitor/selectors.ts b/frontend/src/metabase/common/monitor/selectors.ts
new file mode 100644
index 00000000000..3f4a132b5bd
--- /dev/null
+++ b/frontend/src/metabase/common/monitor/selectors.ts
@@ -0,0 +1,35 @@
+import type { State } from "metabase/redux/store";
+import { getIsEmbeddingIframe } from "metabase/selectors/embed";
+import {
+ getUser,
+ getUserIsAdmin,
+ getUserIsAnalyst,
+} from "metabase/selectors/user";
+
+export function canAccessMonitorDiagnostics(state: State) {
+ if (getIsEmbeddingIframe(state)) {
+ return false;
+ }
+ return getUserIsAdmin(state) || getUserIsAnalyst(state);
+}
+
+export function canAccessMonitoringTools(state: State) {
+ if (getIsEmbeddingIframe(state)) {
+ return false;
+ }
+ return (
+ getUserIsAdmin(state) ||
+ (getUser(state)?.permissions?.can_access_monitoring ?? false)
+ );
+}
+
+export function canAccessAlertsManagement(state: State) {
+ if (getIsEmbeddingIframe(state)) {
+ return false;
+ }
+ return getUserIsAdmin(state);
+}
+
+export function canAccessMonitor(state: State) {
+ return canAccessMonitorDiagnostics(state) || canAccessMonitoringTools(state);
+}
diff --git a/frontend/src/metabase/common/monitor/selectors.unit.spec.ts b/frontend/src/metabase/common/monitor/selectors.unit.spec.ts
new file mode 100644
index 00000000000..dd7ec629a6e
--- /dev/null
+++ b/frontend/src/metabase/common/monitor/selectors.unit.spec.ts
@@ -0,0 +1,217 @@
+import { createMockState } from "metabase/redux/store/mocks";
+import { createMockUser } from "metabase-types/api/mocks";
+
+import {
+ canAccessAlertsManagement,
+ canAccessMonitor,
+ canAccessMonitorDiagnostics,
+ canAccessMonitoringTools,
+} from "./selectors";
+
+jest.mock("metabase/selectors/embed", () => ({
+ getIsEmbeddingIframe: jest.fn(() => false),
+}));
+
+const { getIsEmbeddingIframe } = jest.requireMock("metabase/selectors/embed");
+
+describe("canAccessMonitor", () => {
+ beforeEach(() => {
+ jest.clearAllMocks();
+ getIsEmbeddingIframe.mockReturnValue(false);
+ });
+
+ it("returns false when in embedding iframe", () => {
+ getIsEmbeddingIframe.mockReturnValue(true);
+ const state = createMockState({
+ currentUser: createMockUser({ is_superuser: true }),
+ });
+
+ expect(canAccessMonitor(state)).toBe(false);
+ });
+
+ it("returns true when user is admin", () => {
+ const state = createMockState({
+ currentUser: createMockUser({
+ is_superuser: true,
+ is_data_analyst: false,
+ }),
+ });
+
+ expect(canAccessMonitor(state)).toBe(true);
+ });
+
+ it("returns true when user is analyst", () => {
+ const state = createMockState({
+ currentUser: createMockUser({
+ is_superuser: false,
+ is_data_analyst: true,
+ }),
+ });
+
+ expect(canAccessMonitor(state)).toBe(true);
+ });
+
+ it("returns true for a monitoring-only user (tools access)", () => {
+ const state = createMockState({
+ currentUser: createMockUser({
+ is_superuser: false,
+ is_data_analyst: false,
+ permissions: { can_access_monitoring: true },
+ }),
+ });
+
+ expect(canAccessMonitor(state)).toBe(true);
+ });
+
+ it("returns false when the user has no monitor section access", () => {
+ const state = createMockState({
+ currentUser: createMockUser({
+ is_superuser: false,
+ is_data_analyst: false,
+ permissions: { can_access_monitoring: false },
+ }),
+ });
+
+ expect(canAccessMonitor(state)).toBe(false);
+ });
+});
+
+describe("canAccessMonitorDiagnostics", () => {
+ beforeEach(() => {
+ jest.clearAllMocks();
+ getIsEmbeddingIframe.mockReturnValue(false);
+ });
+
+ it("returns false when in embedding iframe", () => {
+ getIsEmbeddingIframe.mockReturnValue(true);
+ const state = createMockState({
+ currentUser: createMockUser({ is_superuser: true }),
+ });
+
+ expect(canAccessMonitorDiagnostics(state)).toBe(false);
+ });
+
+ it("returns true when user is admin", () => {
+ const state = createMockState({
+ currentUser: createMockUser({ is_superuser: true }),
+ });
+
+ expect(canAccessMonitorDiagnostics(state)).toBe(true);
+ });
+
+ it("returns true when user is analyst", () => {
+ const state = createMockState({
+ currentUser: createMockUser({
+ is_superuser: false,
+ is_data_analyst: true,
+ }),
+ });
+
+ expect(canAccessMonitorDiagnostics(state)).toBe(true);
+ });
+
+ it("returns false for a monitoring-only user (no diagnostics access)", () => {
+ const state = createMockState({
+ currentUser: createMockUser({
+ is_superuser: false,
+ is_data_analyst: false,
+ permissions: { can_access_monitoring: true },
+ }),
+ });
+
+ expect(canAccessMonitorDiagnostics(state)).toBe(false);
+ });
+});
+
+describe("canAccessMonitoringTools", () => {
+ beforeEach(() => {
+ jest.clearAllMocks();
+ getIsEmbeddingIframe.mockReturnValue(false);
+ });
+
+ it("returns false when in embedding iframe", () => {
+ getIsEmbeddingIframe.mockReturnValue(true);
+ const state = createMockState({
+ currentUser: createMockUser({ is_superuser: true }),
+ });
+
+ expect(canAccessMonitoringTools(state)).toBe(false);
+ });
+
+ it("returns true when user is admin", () => {
+ const state = createMockState({
+ currentUser: createMockUser({ is_superuser: true }),
+ });
+
+ expect(canAccessMonitoringTools(state)).toBe(true);
+ });
+
+ it("returns true for a non-admin with the monitoring application permission", () => {
+ const state = createMockState({
+ currentUser: createMockUser({
+ is_superuser: false,
+ permissions: { can_access_monitoring: true },
+ }),
+ });
+
+ expect(canAccessMonitoringTools(state)).toBe(true);
+ });
+
+ it("returns false for an analyst without the monitoring permission", () => {
+ const state = createMockState({
+ currentUser: createMockUser({
+ is_superuser: false,
+ is_data_analyst: true,
+ permissions: { can_access_monitoring: false },
+ }),
+ });
+
+ expect(canAccessMonitoringTools(state)).toBe(false);
+ });
+});
+
+describe("canAccessAlertsManagement", () => {
+ beforeEach(() => {
+ jest.clearAllMocks();
+ getIsEmbeddingIframe.mockReturnValue(false);
+ });
+
+ it("returns false when in embedding iframe", () => {
+ getIsEmbeddingIframe.mockReturnValue(true);
+ const state = createMockState({
+ currentUser: createMockUser({ is_superuser: true }),
+ });
+
+ expect(canAccessAlertsManagement(state)).toBe(false);
+ });
+
+ it("returns true when user is admin", () => {
+ const state = createMockState({
+ currentUser: createMockUser({ is_superuser: true }),
+ });
+
+ expect(canAccessAlertsManagement(state)).toBe(true);
+ });
+
+ it("returns false for an analyst without admin", () => {
+ const state = createMockState({
+ currentUser: createMockUser({
+ is_superuser: false,
+ is_data_analyst: true,
+ }),
+ });
+
+ expect(canAccessAlertsManagement(state)).toBe(false);
+ });
+
+ it("returns false for a non-admin with the monitoring application permission", () => {
+ const state = createMockState({
+ currentUser: createMockUser({
+ is_superuser: false,
+ permissions: { can_access_monitoring: true },
+ }),
+ });
+
+ expect(canAccessAlertsManagement(state)).toBe(false);
+ });
+});
diff --git a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/DataStudioLayout.tsx b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/DataStudioLayout.tsx
index 9d97c0a953d..d2745708aab 100644
--- a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/DataStudioLayout.tsx
+++ b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/DataStudioLayout.tsx
@@ -1,14 +1,11 @@
-import cx from "classnames";
-import { type ReactNode, useState } from "react";
+import { useState } from "react";
import { t } from "ttag";
import DataStudioLogo from "assets/img/data-studio-logo.svg";
-import { ForwardRefLink } from "metabase/common/components/Link";
-import { UpsellGem } from "metabase/common/components/upsells/components/UpsellGem";
import { useHasTokenFeature, useSetting } from "metabase/common/hooks";
import { useUserKeyValue } from "metabase/common/hooks/use-user-key-value";
import { useDataStudioSettings } from "metabase/data-studio/settings/hooks";
-import { useRegisterShortcut } from "metabase/palette/hooks/useRegisterShortcut";
+import { AreaLayout, AreaTab } from "metabase/nav/components/AreaLayout";
import {
PLUGIN_FEATURE_LEVEL_PERMISSIONS,
PLUGIN_REMOTE_SYNC,
@@ -18,23 +15,8 @@ import { useSelector } from "metabase/redux";
import { Outlet } from "metabase/router";
import { getLocation } from "metabase/selectors/routing";
import { canAccessTransforms as canAccessTransformsSelector } from "metabase/transforms/selectors";
-import {
- ActionIcon,
- Box,
- Center,
- FixedSizeIcon,
- Flex,
- Group,
- Loader,
- Stack,
- Text,
- Tooltip,
-} from "metabase/ui";
import * as Urls from "metabase/urls";
-import { isMac } from "metabase/utils/browser";
-import type { IconName } from "metabase-types/api";
-import S from "./DataStudioLayout.module.css";
import { getCurrentTab } from "./utils";
export function DataStudioLayout() {
@@ -48,39 +30,6 @@ export function DataStudioLayout() {
});
const isNavbarOpened = _isNavbarOpened !== false;
- useRegisterShortcut(
- [
- {
- id: "toggle-navbar",
- perform: () => setIsNavbarOpened(!isNavbarOpened),
- },
- ],
- [isNavbarOpened],
- );
-
- return isLoadingNavbarKey ? (
- <Center h="100%">
- <Loader />
- </Center>
- ) : (
- <Flex h="100%">
- <DataStudioNav
- isNavbarOpened={isNavbarOpened}
- onNavbarToggle={setIsNavbarOpened}
- />
- <Box h="100%" flex={1} miw={0}>
- <Outlet />
- </Box>
- </Flex>
- );
-}
-
-type DataStudioNavProps = {
- isNavbarOpened: boolean;
- onNavbarToggle: (isOpened: boolean) => void;
-};
-
-function DataStudioNav({ isNavbarOpened, onNavbarToggle }: DataStudioNavProps) {
const { pathname } = useSelector(getLocation);
const canAccessDataModel = useSelector(
PLUGIN_FEATURE_LEVEL_PERMISSIONS.canAccessDataModel,
@@ -110,276 +59,153 @@ function DataStudioNav({ isNavbarOpened, onNavbarToggle }: DataStudioNavProps) {
const currentTab = getCurrentTab(pathname);
- return (
+ const upperNav = (
<>
- <Stack
- className={cx(S.nav, { [S.opened]: isNavbarOpened })}
- h="100%"
- p="0.75rem"
- justify="space-between"
- data-testid="data-studio-nav"
- >
- <Stack gap="0.75rem" flex={1} mih={0} className={S.upperGroup}>
- <DataStudioNavbarToggle
- isNavbarOpened={isNavbarOpened}
- onNavbarToggle={onNavbarToggle}
- />
- <DataStudioTab
- label={t`Library`}
- icon="repository"
- to={Urls.dataStudioLibrary()}
- isSelected={currentTab === "library"}
- showLabel={isNavbarOpened}
- isGated={!hasLibraryFeature}
- rightSection={
- hasDirtyChanges &&
- PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge ? (
- <PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge />
- ) : null
- }
- />
-
- {canAccessDataModel && (
- <DataStudioTab
- label={t`Tables`}
- icon="open_folder"
- to={Urls.dataStudioData()}
- isSelected={currentTab === "data"}
- showLabel={isNavbarOpened}
- />
- )}
- <DataStudioTab
- label={t`Schema viewer`}
- icon="network"
- to={Urls.dataStudioSchemaViewer()}
- isSelected={currentTab === "schema-viewer"}
- showLabel={isNavbarOpened}
- isGated={!hasSchemaViewerFeature}
- />
- <DataStudioTab
- label={t`Dependency graph`}
- icon="dependencies"
- to={Urls.dependencyGraph()}
- isSelected={currentTab === "dependencies"}
- showLabel={isNavbarOpened}
- isGated={!hasDependenciesFeature}
- />
- <DataStudioTab
- label={t`Dependency diagnostics`}
- icon="search_check"
- to={Urls.dependencyDiagnostics()}
- isSelected={currentTab === "dependency-diagnostics"}
- showLabel={isNavbarOpened}
- isGated={!hasDependenciesFeature}
- />
- {shouldShowTransforms && (
- <DataStudioTab
- label={t`Transforms`}
- icon="transform"
- to={Urls.transformList()}
- isSelected={currentTab === "transforms"}
- showLabel={isNavbarOpened}
- rightSection={
- hasTransformDirtyChanges &&
- PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge ? (
- <PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge />
- ) : null
- }
- />
- )}
- <DataStudioTab
- label={t`Glossary`}
- icon="glossary"
- to={Urls.dataStudioGlossary()}
- isSelected={currentTab === "glossary"}
- showLabel={isNavbarOpened}
- />
- </Stack>
- <Stack gap="0.75rem">
- {hasRemoteSyncFeature ? (
- <PLUGIN_REMOTE_SYNC.GitSyncSetupMenuItem
- isNavbarOpened={isNavbarOpened}
- onClick={() => setIsGitSettingsOpen(true)}
- />
- ) : (
- <DataStudioTab
- label={t`Set up remote sync`}
- icon="gear"
- to={Urls.dataStudioGitSync()}
- isSelected={currentTab === "git-sync"}
- showLabel={isNavbarOpened}
- isGated
- />
- )}
- {canManageWorkspaces && (
- <DataStudioTab
- label={t`Workspaces`}
- icon="workspace"
- to={Urls.workspaces()}
- isSelected={currentTab === "workspaces"}
- showLabel={isNavbarOpened}
- />
- )}
- {canUseTransforms && (
- <DataStudioTab
- label={t`Jobs`}
- icon="clock"
- to={Urls.transformJobList()}
- isSelected={currentTab === "jobs"}
- showLabel={isNavbarOpened}
- />
- )}
- {canUseTransforms && (
- <DataStudioTab
- label={t`Runs`}
- icon="play_outlined"
- to={Urls.transformGraphRunList()}
- isSelected={currentTab === "runs"}
- showLabel={isNavbarOpened}
- />
- )}
- {settings.length > 0 && (
- <DataStudioTab
- label={t`Settings`}
- icon="gear"
- to={Urls.dataStudioSettings()}
- isSelected={currentTab === "settings"}
- showLabel={isNavbarOpened}
- />
- )}
- </Stack>
- <PLUGIN_REMOTE_SYNC.GitSettingsModal
- isOpen={isGitSettingsOpen}
- onClose={() => setIsGitSettingsOpen(false)}
+ <AreaTab
+ label={t`Library`}
+ icon="repository"
+ to={Urls.dataStudioLibrary()}
+ isSelected={currentTab === "library"}
+ showLabel={isNavbarOpened}
+ isGated={!hasLibraryFeature}
+ rightSection={
+ hasDirtyChanges && PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge ? (
+ <PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge />
+ ) : null
+ }
+ />
+ {canAccessDataModel && (
+ <AreaTab
+ label={t`Tables`}
+ icon="open_folder"
+ to={Urls.dataStudioData()}
+ isSelected={currentTab === "data"}
+ showLabel={isNavbarOpened}
/>
- </Stack>
+ )}
+ <AreaTab
+ label={t`Schema viewer`}
+ icon="network"
+ to={Urls.dataStudioSchemaViewer()}
+ isSelected={currentTab === "schema-viewer"}
+ showLabel={isNavbarOpened}
+ isGated={!hasSchemaViewerFeature}
+ />
+ <AreaTab
+ label={t`Dependency graph`}
+ icon="dependencies"
+ to={Urls.dependencyGraph()}
+ isSelected={currentTab === "dependencies"}
+ showLabel={isNavbarOpened}
+ isGated={!hasDependenciesFeature}
+ />
+ {shouldShowTransforms && (
+ <AreaTab
+ label={t`Transforms`}
+ icon="transform"
+ to={Urls.transformList()}
+ isSelected={currentTab === "transforms"}
+ showLabel={isNavbarOpened}
+ rightSection={
+ hasTransformDirtyChanges &&
+ PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge ? (
+ <PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge />
+ ) : null
+ }
+ />
+ )}
+ <AreaTab
+ label={t`Glossary`}
+ icon="glossary"
+ to={Urls.dataStudioGlossary()}
+ isSelected={currentTab === "glossary"}
+ showLabel={isNavbarOpened}
+ />
</>
);
-}
-
-type DataStudioTabProps = {
- label: string;
- icon: IconName;
- to: string;
- isSelected?: boolean;
- showLabel: boolean;
- rightSection?: ReactNode;
- isGated?: boolean;
-};
-
-const TOOLTIP_OPEN_DELAY = 1000;
-
-function DataStudioTab({
- label,
- icon,
- to,
- isSelected,
- showLabel,
- rightSection,
- isGated,
-}: DataStudioTabProps) {
- const upsellGem = isGated ? <UpsellGem.New size={14} /> : null;
- const effectiveRightSection = rightSection ?? upsellGem;
-
- return (
- <Tooltip
- label={label}
- position="right"
- openDelay={TOOLTIP_OPEN_DELAY}
- disabled={showLabel}
- >
- <Flex
- className={cx(S.tab, { [S.selected]: isSelected })}
- component={ForwardRefLink}
- to={to}
- p="sm"
- gap="sm"
- bdrs="md"
- aria-label={label}
- justify={showLabel ? "start" : "center"}
- >
- <FixedSizeIcon name={icon} display="block" className={S.icon} />
- {showLabel && <Text lh="sm">{label}</Text>}
- {effectiveRightSection && (
- <Box
- className={showLabel ? undefined : S.badgeOverlay}
- ml={showLabel ? "auto" : undefined}
- >
- {effectiveRightSection}
- </Box>
- )}
- </Flex>
- </Tooltip>
- );
-}
-
-const getSidebarTooltipLabel = (isNavbarOpened: boolean) => {
- const message = isNavbarOpened ? t`Close sidebar` : t`Open sidebar`;
- const shortcut = isMac() ? "(⌘ + .)" : "(Ctrl + .)";
- return `${message} ${shortcut}`;
-};
-type DataStudioNavbarToggleProps = {
- isNavbarOpened: boolean;
- onNavbarToggle: (isOpened: boolean) => void;
-};
-
-function DataStudioNavbarToggle({
- isNavbarOpened,
- onNavbarToggle,
-}: DataStudioNavbarToggleProps) {
- return (
- <Flex
- align="center"
- justify={isNavbarOpened ? "space-between" : "center"}
- mb="0.75rem"
- mt="sm"
- >
- <Group gap="sm">
- <Box
- className={cx(S.logoWrapper, { [S.navbarClosed]: !isNavbarOpened })}
- >
- <img
- alt={t`Data Studio Logo`}
- className={S.logo}
- src={DataStudioLogo}
+ const lowerNav = (
+ <>
+ {hasRemoteSyncFeature ? (
+ <>
+ <PLUGIN_REMOTE_SYNC.GitSyncSetupMenuItem
+ isNavbarOpened={isNavbarOpened}
+ onClick={() => setIsGitSettingsOpen(true)}
+ />
+ <PLUGIN_REMOTE_SYNC.GitSettingsModal
+ isOpen={isGitSettingsOpen}
+ onClose={() => setIsGitSettingsOpen(false)}
/>
- {!isNavbarOpened && (
- <ToggleActionIcon
- isNavbarOpened={isNavbarOpened}
- onNavbarToggle={onNavbarToggle}
- />
- )}
- </Box>
- {isNavbarOpened && <PLUGIN_REMOTE_SYNC.GitSyncAppBarControls />}
- </Group>
- {isNavbarOpened && (
- <ToggleActionIcon isNavbarOpened onNavbarToggle={onNavbarToggle} />
+ </>
+ ) : (
+ <AreaTab
+ label={t`Set up remote sync`}
+ icon="gear"
+ to={Urls.dataStudioGitSync()}
+ isSelected={currentTab === "git-sync"}
+ showLabel={isNavbarOpened}
+ isGated
+ />
)}
- </Flex>
+ {canManageWorkspaces && (
+ <AreaTab
+ label={t`Workspaces`}
+ icon="workspace"
+ to={Urls.workspaces()}
+ isSelected={currentTab === "workspaces"}
+ showLabel={isNavbarOpened}
+ />
+ )}
+ {canUseTransforms && (
+ <AreaTab
+ label={t`Jobs`}
+ icon="clock"
+ to={Urls.transformJobList()}
+ isSelected={currentTab === "jobs"}
+ showLabel={isNavbarOpened}
+ />
+ )}
+ {canUseTransforms && (
+ <AreaTab
+ label={t`Runs`}
+ icon="play_outlined"
+ to={Urls.transformGraphRunList()}
+ isSelected={currentTab === "runs"}
+ showLabel={isNavbarOpened}
+ />
+ )}
+ {settings.length > 0 && (
+ <AreaTab
+ label={t`Settings`}
+ icon="gear"
+ to={Urls.dataStudioSettings()}
+ isSelected={currentTab === "settings"}
+ showLabel={isNavbarOpened}
+ />
+ )}
+ </>
);
-}
-
-type ToggleActionIconProps = DataStudioNavbarToggleProps & {
- className?: string;
-};
-
-function ToggleActionIcon(props: ToggleActionIconProps) {
- const { isNavbarOpened, onNavbarToggle } = props;
- const label = getSidebarTooltipLabel(isNavbarOpened);
return (
- <Tooltip label={label} openDelay={1000}>
- <ActionIcon
- aria-label={label}
- className={S.toggle}
- onClick={() => onNavbarToggle(!isNavbarOpened)}
- >
- <FixedSizeIcon
- name={isNavbarOpened ? "sidebar_closed" : "sidebar_open"}
- c="text-secondary"
+ <AreaLayout
+ logo={
+ <img
+ alt={t`Data Studio Logo`}
+ src={DataStudioLogo}
+ width={32}
+ height={32}
+ style={{ display: "block" }}
/>
- </ActionIcon>
- </Tooltip>
+ }
+ testId="data-studio-nav"
+ isLoading={isLoadingNavbarKey}
+ isNavbarOpened={isNavbarOpened}
+ onNavbarToggle={setIsNavbarOpened}
+ headerControls={<PLUGIN_REMOTE_SYNC.GitSyncAppBarControls />}
+ upperNav={upperNav}
+ lowerNav={lowerNav}
+ >
+ <Outlet />
+ </AreaLayout>
);
}
diff --git a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.ts b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.ts
index ee52532f714..e18c5bd9e64 100644
--- a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.ts
+++ b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.ts
@@ -7,7 +7,6 @@ type TabName =
| "jobs"
| "runs"
| "dependencies"
- | "dependency-diagnostics"
| "schema-viewer"
| "glossary"
| "git-sync"
@@ -26,8 +25,6 @@ export const getCurrentTab = (pathname: string): TabName => {
return "jobs";
case pathname.startsWith(Urls.dependencyGraph()):
return "dependencies";
- case pathname.startsWith(Urls.dependencyDiagnostics()):
- return "dependency-diagnostics";
case pathname.startsWith(Urls.dataStudioSchemaViewer()):
return "schema-viewer";
case pathname.startsWith(Urls.dataStudioLibrary()):
diff --git a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.unit.spec.ts b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.unit.spec.ts
index fdec0a2ea3a..70825d733d4 100644
--- a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.unit.spec.ts
+++ b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.unit.spec.ts
@@ -2,29 +2,26 @@ import { getCurrentTab } from "./utils";
describe("getCurrentTab", () => {
it.each`
- pathname | expectedTab
- ${"/data-studio/glossary"} | ${"glossary"}
- ${"/data-studio/glossary/some-path"} | ${"glossary"}
- ${"/data-studio/transforms/jobs"} | ${"jobs"}
- ${"/data-studio/transforms/jobs/123"} | ${"jobs"}
- ${"/data-studio/transforms/jobs/new"} | ${"jobs"}
- ${"/data-studio/dependencies"} | ${"dependencies"}
- ${"/data-studio/dependencies?id=1&type=card"} | ${"dependencies"}
- ${"/data-studio/dependency-diagnostics"} | ${"dependency-diagnostics"}
- ${"/data-studio/dependency-diagnostics/breaking"} | ${"dependency-diagnostics"}
- ${"/data-studio/dependency-diagnostics/unreferenced"} | ${"dependency-diagnostics"}
- ${"/data-studio/library"} | ${"library"}
- ${"/data-studio/library/collections/123"} | ${"library"}
- ${"/data-studio/library/metrics/456"} | ${"library"}
- ${"/data-studio/transforms/runs"} | ${"runs"}
- ${"/data-studio/transforms/runs?page=2"} | ${"runs"}
- ${"/data-studio/transforms"} | ${"transforms"}
- ${"/data-studio/transforms/123"} | ${"transforms"}
- ${"/data-studio/transforms/new/query"} | ${"transforms"}
- ${"/data-studio/data"} | ${"data"}
- ${"/data-studio/data/database/1"} | ${"data"}
- ${"/data-studio/settings"} | ${"settings"}
- ${"/data-studio"} | ${"data"}
+ pathname | expectedTab
+ ${"/data-studio/glossary"} | ${"glossary"}
+ ${"/data-studio/glossary/some-path"} | ${"glossary"}
+ ${"/data-studio/transforms/jobs"} | ${"jobs"}
+ ${"/data-studio/transforms/jobs/123"} | ${"jobs"}
+ ${"/data-studio/transforms/jobs/new"} | ${"jobs"}
+ ${"/data-studio/dependencies"} | ${"dependencies"}
+ ${"/data-studio/dependencies?id=1&type=card"} | ${"dependencies"}
+ ${"/data-studio/library"} | ${"library"}
+ ${"/data-studio/library/collections/123"} | ${"library"}
+ ${"/data-studio/library/metrics/456"} | ${"library"}
+ ${"/data-studio/transforms/runs"} | ${"runs"}
+ ${"/data-studio/transforms/runs?page=2"} | ${"runs"}
+ ${"/data-studio/transforms"} | ${"transforms"}
+ ${"/data-studio/transforms/123"} | ${"transforms"}
+ ${"/data-studio/transforms/new/query"} | ${"transforms"}
+ ${"/data-studio/data"} | ${"data"}
+ ${"/data-studio/data/database/1"} | ${"data"}
+ ${"/data-studio/settings"} | ${"settings"}
+ ${"/data-studio"} | ${"data"}
`(
"should return '$expectedTab' for pathname '$pathname'",
({ pathname, expectedTab }) => {
diff --git a/frontend/src/metabase/data-studio/routes.tsx b/frontend/src/metabase/data-studio/routes.tsx
index 9d937516d89..9e79aca3a35 100644
--- a/frontend/src/metabase/data-studio/routes.tsx
+++ b/frontend/src/metabase/data-studio/routes.tsx
@@ -1,5 +1,4 @@
-import { DependencyDiagnosticsSectionLayout } from "metabase/monitor/dependency-diagnostics/DependencyDiagnosticsSectionLayout";
-import { DependencyDiagnosticsUpsellPage } from "metabase/monitor/dependency-diagnostics/DependencyDiagnosticsUpsellPage";
+import { NotFound } from "metabase/common/components/ErrorPages";
import {
PLUGIN_DEPENDENCIES,
PLUGIN_FEATURE_LEVEL_PERMISSIONS,
@@ -13,6 +12,7 @@ import {
Navigate,
Route,
type RouteComponent,
+ redirect,
withRouteProps,
} from "metabase/router";
import { getDataStudioTransformRoutes } from "metabase/transforms/routes";
@@ -42,57 +42,73 @@ export function getDataStudioRoutes(
IsAdmin: RouteComponent,
) {
return (
- <Route element={<CanAccessDataStudio />}>
- <Route path="data-studio" element={<DataStudioLayout />}>
- <Route index element={<DataStudioIndexRedirect />} />
- <Route path="data" element={<CanAccessDataModel />}>
- <Route element={<DataSectionLayout />}>
- {getDataStudioMetadataRoutes(IsAdmin)}
- </Route>
- </Route>
- <Route path="transforms" element={<RoutedTransformsSectionLayout />}>
- {getDataStudioTransformRoutes()}
- </Route>
- <Route element={<WorkspacesSectionLayout />}>
- {PLUGIN_WORKSPACES.getDataStudioRoutes()}
- </Route>
- {getDataStudioGlossaryRoutes()}
- {getDataStudioSettingsRoutes()}
- {PLUGIN_LIBRARY.isEnabled ? (
- PLUGIN_LIBRARY.getDataStudioLibraryRoutes(IsAdmin)
- ) : (
- <Route path="library" element={<LibraryUpsellPage />} />
- )}
- {PLUGIN_DEPENDENCIES.isEnabled ? (
- <Route path="dependencies" element={<DependenciesSectionLayout />}>
- {PLUGIN_DEPENDENCIES.getDataStudioDependencyRoutes()}
+ <>
+ {/* These redirects sit
+ * OUTSIDE the CanAccessDataStudio guard — users without Data Studio access must
+ * still be forwarded —
+ * and are declared BEFORE the guarded subtree so they win over its `path="*"`
+ * catch-all
+ */}
+
+ {getDataStudioDependencyDiagnosticsRedirects()}
+ <Route element={<CanAccessDataStudio />}>
+ <Route path="data-studio" element={<DataStudioLayout />}>
+ <Route index element={<DataStudioIndexRedirect />} />
+ <Route path="data" element={<CanAccessDataModel />}>
+ <Route element={<DataSectionLayout />}>
+ {getDataStudioMetadataRoutes(IsAdmin)}
+ </Route>
</Route>
- ) : (
- <Route path="dependencies" element={<DependenciesUpsellPage />} />
- )}
- {PLUGIN_DEPENDENCIES.isEnabled ? (
- <Route
- path="dependency-diagnostics"
- element={<DependencyDiagnosticsSectionLayout />}
- >
- {PLUGIN_DEPENDENCIES.getDataStudioDependencyDiagnosticsRoutes()}
+ <Route path="transforms" element={<RoutedTransformsSectionLayout />}>
+ {getDataStudioTransformRoutes()}
</Route>
- ) : (
- <Route
- path="dependency-diagnostics"
- element={<DependencyDiagnosticsUpsellPage />}
- />
- )}
- {PLUGIN_SCHEMA_VIEWER.isEnabled ? (
- <Route path="schema-viewer">
- {PLUGIN_SCHEMA_VIEWER.getDataStudioSchemaViewerRoutes()}
+ <Route element={<WorkspacesSectionLayout />}>
+ {PLUGIN_WORKSPACES.getDataStudioRoutes()}
</Route>
- ) : (
- <Route path="schema-viewer" element={<SchemaViewerUpsellPage />} />
- )}
- <Route path="git-sync" element={<GitSyncSectionLayout />} />
+ {getDataStudioGlossaryRoutes()}
+ {getDataStudioSettingsRoutes()}
+ {PLUGIN_LIBRARY.isEnabled ? (
+ PLUGIN_LIBRARY.getDataStudioLibraryRoutes(IsAdmin)
+ ) : (
+ <Route path="library" element={<LibraryUpsellPage />} />
+ )}
+ {PLUGIN_DEPENDENCIES.isEnabled ? (
+ <Route path="dependencies" element={<DependenciesSectionLayout />}>
+ {PLUGIN_DEPENDENCIES.getDataStudioDependencyRoutes()}
+ </Route>
+ ) : (
+ <Route path="dependencies" element={<DependenciesUpsellPage />} />
+ )}
+ {PLUGIN_SCHEMA_VIEWER.isEnabled ? (
+ <Route path="schema-viewer">
+ {PLUGIN_SCHEMA_VIEWER.getDataStudioSchemaViewerRoutes()}
+ </Route>
+ ) : (
+ <Route path="schema-viewer" element={<SchemaViewerUpsellPage />} />
+ )}
+ <Route path="git-sync" element={<GitSyncSectionLayout />} />
+
+ <Route path="*" element={<NotFound />} />
+ </Route>
</Route>
- </Route>
+ </>
+ );
+}
+
+/**
+ * Dependency Diagnostics moved from Data Studio to Monitor. */
+export function getDataStudioDependencyDiagnosticsRedirects() {
+ return (
+ <>
+ <Route
+ path="data-studio/dependency-diagnostics"
+ element={redirect(Urls.dependencyDiagnostics())}
+ />
+ <Route
+ path="data-studio/dependency-diagnostics/*"
+ element={redirect(`${Urls.dependencyDiagnostics()}/*`)}
+ />
+ </>
);
}
diff --git a/frontend/src/metabase/data-studio/routes.unit.spec.tsx b/frontend/src/metabase/data-studio/routes.unit.spec.tsx
new file mode 100644
index 00000000000..a668e22014e
--- /dev/null
+++ b/frontend/src/metabase/data-studio/routes.unit.spec.tsx
@@ -0,0 +1,52 @@
+import { renderWithProviders, screen } from "__support__/ui";
+import { Outlet, Route } from "metabase/router";
+
+import { getDataStudioRoutes } from "./routes";
+
+const DenyingDataStudioGuard = () => (
+ <div data-testid="data-studio-access-denied" />
+);
+const AllowingGuard = () => <Outlet />;
+
+function setup(initialRoute: string) {
+ renderWithProviders(
+ <Route path="/">
+ {getDataStudioRoutes(
+ DenyingDataStudioGuard,
+ AllowingGuard,
+ AllowingGuard,
+ )}
+ <Route
+ path="monitor/dependency-diagnostics"
+ element={<div data-testid="diagnostics-index" />}
+ />
+ <Route
+ path="monitor/dependency-diagnostics/unreferenced"
+ element={<div data-testid="diagnostics-unreferenced" />}
+ />
+ </Route>,
+ { initialRoute, withRouter: true },
+ );
+}
+
+describe("Data Studio routes", () => {
+ it("redirects the legacy Dependency Diagnostics index outside the Data Studio access guard", async () => {
+ setup("/data-studio/dependency-diagnostics");
+
+ expect(await screen.findByTestId("diagnostics-index")).toBeInTheDocument();
+ expect(
+ screen.queryByTestId("data-studio-access-denied"),
+ ).not.toBeInTheDocument();
+ });
+
+ it("preserves the child path instead of matching the Data Studio catch-all", async () => {
+ setup("/data-studio/dependency-diagnostics/unreferenced");
+
+ expect(
+ await screen.findByTestId("diagnostics-unreferenced"),
+ ).toBeInTheDocument();
+ expect(
+ screen.queryByTestId("data-studio-access-denied"),
+ ).not.toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/metadata/components/PreviewSection/ObjectDetailPreview.tsx b/frontend/src/metabase/metadata/components/PreviewSection/ObjectDetailPreview.tsx
index ac0b4f67620..7c9a756ec6f 100644
--- a/frontend/src/metabase/metadata/components/PreviewSection/ObjectDetailPreview.tsx
+++ b/frontend/src/metabase/metadata/components/PreviewSection/ObjectDetailPreview.tsx
@@ -1,7 +1,11 @@
import { memo, useMemo, useRef } from "react";
import { t } from "ttag";
-import { skipToken, useGetAdhocQueryQuery } from "metabase/api";
+import {
+ RTK_CACHE_KEY_PARAM,
+ skipToken,
+ useGetAdhocQueryQuery,
+} from "metabase/api";
import { getErrorMessage } from "metabase/api/utils";
import { EmptyState } from "metabase/common/components/EmptyState";
import { DetailsGroup, Header } from "metabase/detail-view/components";
@@ -142,7 +146,7 @@ function useDataSample({ databaseId, field, fieldId, tableId }: Props) {
? {
...Lib.toJsQuery(query),
ignore_error: true,
- _refetchDeps: field,
+ [RTK_CACHE_KEY_PARAM]: field,
}
: skipToken,
);
diff --git a/frontend/src/metabase/metadata/components/PreviewSection/TablePreview.tsx b/frontend/src/metabase/metadata/components/PreviewSection/TablePreview.tsx
index 8968b2eb712..4c954f6e287 100644
--- a/frontend/src/metabase/metadata/components/PreviewSection/TablePreview.tsx
+++ b/frontend/src/metabase/metadata/components/PreviewSection/TablePreview.tsx
@@ -2,7 +2,11 @@ import { memo, useMemo, useRef } from "react";
import { t } from "ttag";
import _ from "underscore";
-import { skipToken, useGetAdhocQueryQuery } from "metabase/api";
+import {
+ RTK_CACHE_KEY_PARAM,
+ skipToken,
+ useGetAdhocQueryQuery,
+} from "metabase/api";
import { getErrorMessage } from "metabase/api/utils";
import { EmptyState } from "metabase/common/components/EmptyState";
import { useSelector } from "metabase/redux";
@@ -106,7 +110,7 @@ function useDataSample({
: {
...Lib.toJsQuery(query),
ignore_error: true,
- _refetchDeps: field,
+ [RTK_CACHE_KEY_PARAM]: field,
},
);
const base = {
diff --git a/frontend/src/metabase/monitor/components/LogsViewer/LogsViewer.module.css b/frontend/src/metabase/monitor/components/LogsViewer/LogsViewer.module.css
new file mode 100644
index 00000000000..ad96eb7f7d4
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/LogsViewer/LogsViewer.module.css
@@ -0,0 +1,18 @@
+.logsViewer {
+ height: 100%;
+ min-height: 0;
+ flex: 0 1 auto;
+ overflow: auto;
+ padding: var(--mantine-spacing-md);
+ border: 1px solid var(--mb-color-border-neutral);
+ border-radius: 0.5rem;
+ background-color: var(--mb-color-background_page-secondary);
+ font-family: "Lucida Console", Monaco, monospace;
+ font-size: 0.825rem;
+ white-space: pre;
+}
+
+.logsViewer:focus-visible {
+ outline: 2px solid var(--mb-color-focus);
+ outline-offset: -2px;
+}
diff --git a/frontend/src/metabase/monitor/components/LogsViewer/LogsViewer.tsx b/frontend/src/metabase/monitor/components/LogsViewer/LogsViewer.tsx
new file mode 100644
index 00000000000..43a2382ba18
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/LogsViewer/LogsViewer.tsx
@@ -0,0 +1,51 @@
+import cx from "classnames";
+import { type ComponentPropsWithoutRef, forwardRef, useMemo } from "react";
+import { t } from "ttag";
+
+import { AnsiLogs } from "metabase/common/components/AnsiLogs";
+import type { Log } from "metabase-types/api";
+
+import S from "./LogsViewer.module.css";
+import { createLogFormatter, getAllProcessUUIDs } from "./utils";
+
+type LogsViewerProps = ComponentPropsWithoutRef<"div"> & {
+ logs: Log[];
+ processUUID?: string;
+ processUUIDs?: string[];
+ emptyMessage?: string;
+};
+
+export const LogsViewer = forwardRef<HTMLDivElement, LogsViewerProps>(
+ function LogsViewer(
+ {
+ logs,
+ processUUID = "ALL",
+ processUUIDs,
+ emptyMessage,
+ className,
+ ...rest
+ },
+ ref,
+ ) {
+ const logText = useMemo(() => {
+ const formatLog = createLogFormatter(
+ processUUID,
+ processUUIDs ?? getAllProcessUUIDs(logs),
+ );
+ return logs.flatMap(formatLog).join("\n");
+ }, [logs, processUUID, processUUIDs]);
+
+ return (
+ <AnsiLogs
+ ref={ref}
+ className={cx(S.logsViewer, className)}
+ role="region"
+ aria-label={t`Logs`}
+ tabIndex={0}
+ {...rest}
+ >
+ {logText || emptyMessage}
+ </AnsiLogs>
+ );
+ },
+);
diff --git a/frontend/src/metabase/monitor/components/LogsViewer/LogsViewer.unit.spec.tsx b/frontend/src/metabase/monitor/components/LogsViewer/LogsViewer.unit.spec.tsx
new file mode 100644
index 00000000000..8304d3beeb1
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/LogsViewer/LogsViewer.unit.spec.tsx
@@ -0,0 +1,123 @@
+import { createRef } from "react";
+
+import { render, screen } from "__support__/ui";
+import type { Log } from "metabase-types/api";
+
+import { LogsViewer } from "./LogsViewer";
+
+const createLog = (log: Partial<Log> = {}): Log => ({
+ timestamp: "2024-01-10T21:21:58.597Z",
+ level: "DEBUG",
+ fqns: "metabase.server.middleware.log",
+ msg: "GET /api/collection/root 200",
+ exception: null,
+ process_uuid: "uuid-1",
+ ...log,
+});
+
+describe("LogsViewer", () => {
+ it("renders each log line (level, namespace, message)", () => {
+ render(<LogsViewer logs={[createLog({ msg: "hello world" })]} />);
+
+ const region = screen.getByRole("region");
+ expect(region).toHaveTextContent("DEBUG");
+ expect(region).toHaveTextContent("metabase.server.middleware.log");
+ expect(region).toHaveTextContent("hello world");
+ });
+
+ it("appends exception stack frames after the message", () => {
+ render(
+ <LogsViewer
+ logs={[
+ createLog({
+ msg: "boom",
+ exception: [
+ "java.lang.NullPointerException",
+ " at Foo.bar(Foo.java:1)",
+ ],
+ }),
+ ]}
+ />,
+ );
+
+ const region = screen.getByRole("region");
+ expect(region).toHaveTextContent(
+ "boom java.lang.NullPointerException at Foo.bar(Foo.java:1)",
+ );
+ });
+
+ it("prefixes each line with its process UUID when there are multiple processes (default process = ALL)", () => {
+ render(
+ <LogsViewer
+ logs={[
+ createLog({ process_uuid: "uuid-1", msg: "from one" }),
+ createLog({ process_uuid: "uuid-2", msg: "from two" }),
+ ]}
+ />,
+ );
+
+ const region = screen.getByRole("region");
+ expect(region).toHaveTextContent("[uuid-1]");
+ expect(region).toHaveTextContent("[uuid-2]");
+ });
+
+ it("does not prefix the process UUID when only one process is present", () => {
+ render(<LogsViewer logs={[createLog({ process_uuid: "uuid-1" })]} />);
+
+ expect(screen.getByRole("region")).not.toHaveTextContent("[uuid-1]");
+ });
+
+ it("shows logs only for the selected process without prefixing", () => {
+ render(
+ <LogsViewer
+ processUUID="uuid-1"
+ logs={[createLog({ process_uuid: "uuid-1", msg: "kept" })]}
+ processUUIDs={["uuid-1", "uuid-2"]}
+ />,
+ );
+
+ const region = screen.getByRole("region");
+ expect(region).toHaveTextContent("kept");
+ expect(region).not.toHaveTextContent("[uuid-1]");
+ });
+
+ it("uses the processUUIDs override to decide prefixing rather than the UUIDs present in logs", () => {
+ render(
+ <LogsViewer
+ logs={[createLog({ process_uuid: "uuid-1", msg: "solo" })]}
+ processUUIDs={["uuid-1", "uuid-2"]}
+ />,
+ );
+
+ expect(screen.getByRole("region")).toHaveTextContent("[uuid-1]");
+ });
+
+ it("falls back to emptyMessage when there are no logs", () => {
+ render(<LogsViewer logs={[]} emptyMessage="Nothing here" />);
+
+ expect(screen.getByRole("region")).toHaveTextContent("Nothing here");
+ });
+
+ it("exposes a focusable, named region and merges className / rest props", () => {
+ render(
+ <LogsViewer
+ logs={[createLog()]}
+ className="custom-class"
+ aria-label="Logs output"
+ data-testid="logs-viewer"
+ />,
+ );
+
+ const region = screen.getByRole("region", { name: "Logs output" });
+ expect(region).toHaveAttribute("tabindex", "0");
+ expect(region).toHaveClass("custom-class");
+ expect(region).toHaveAttribute("data-testid", "logs-viewer");
+ });
+
+ it("forwards the ref to the scrollable region element", () => {
+ const ref = createRef<HTMLDivElement>();
+ render(<LogsViewer ref={ref} logs={[createLog()]} />);
+
+ expect(ref.current).toBe(screen.getByRole("region"));
+ });
+});
diff --git a/frontend/src/metabase/monitor/components/LogsViewer/index.ts b/frontend/src/metabase/monitor/components/LogsViewer/index.ts
new file mode 100644
index 00000000000..21c5bc2724d
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/LogsViewer/index.ts
@@ -0,0 +1,2 @@
+export * from "./LogsViewer";
+export * from "./utils";
diff --git a/frontend/src/metabase/monitor/components/LogsViewer/utils.ts b/frontend/src/metabase/monitor/components/LogsViewer/utils.ts
new file mode 100644
index 00000000000..c1f636aa24d
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/LogsViewer/utils.ts
@@ -0,0 +1,28 @@
+import dayjs from "dayjs";
+import _ from "underscore";
+
+import type { Log } from "metabase-types/api";
+
+export function getAllProcessUUIDs(logs: Log[]) {
+ const uuids = new Set<string>();
+ logs.forEach((log) => uuids.add(log.process_uuid));
+ return [...uuids].filter(Boolean).sort();
+}
+
+// date formatting is expensive for megabytes of logs
+const formatTs = (ts: string) => dayjs(ts).format();
+const memoedFormatTs = _.memoize(formatTs);
+
+export const createLogFormatter =
+ (process: string, processUUIDs: string[]) =>
+ (log: Log): string[] => {
+ const timestamp = memoedFormatTs(log.timestamp);
+ const uuid =
+ process === "ALL" && processUUIDs.length > 1
+ ? `[${log.process_uuid}]`
+ : undefined;
+ return [
+ [uuid, timestamp, log.level, log.fqns, log.msg].filter(Boolean).join(" "),
+ ...(log.exception ?? []),
+ ];
+ };
diff --git a/frontend/src/metabase/monitor/components/MonitorEmptyState/MonitorEmptyState.tsx b/frontend/src/metabase/monitor/components/MonitorEmptyState/MonitorEmptyState.tsx
new file mode 100644
index 00000000000..4bade54f373
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorEmptyState/MonitorEmptyState.tsx
@@ -0,0 +1,22 @@
+import { t } from "ttag";
+
+import EmptyDashboardBot from "assets/img/dashboard-empty.svg";
+import { Stack, Text } from "metabase/ui";
+
+type MonitorEmptyStateProps = {
+ label: string;
+};
+
+export function MonitorEmptyState({ label }: MonitorEmptyStateProps) {
+ return (
+ <Stack p="xl" align="center">
+ <img
+ src={EmptyDashboardBot}
+ alt={t`Empty list`}
+ width={100}
+ height={100}
+ />
+ <Text c="text-secondary">{label}</Text>
+ </Stack>
+ );
+}
diff --git a/frontend/src/metabase/monitor/components/MonitorEmptyState/index.ts b/frontend/src/metabase/monitor/components/MonitorEmptyState/index.ts
new file mode 100644
index 00000000000..6f531adf799
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorEmptyState/index.ts
@@ -0,0 +1 @@
+export * from "./MonitorEmptyState";
diff --git a/frontend/src/metabase/monitor/components/MonitorHeaderTabs/MonitorHeaderTabs.tsx b/frontend/src/metabase/monitor/components/MonitorHeaderTabs/MonitorHeaderTabs.tsx
new file mode 100644
index 00000000000..ea7d707a4b3
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorHeaderTabs/MonitorHeaderTabs.tsx
@@ -0,0 +1,50 @@
+import { LinkTab } from "metabase/common/components/LinkTab";
+import { UpsellGem } from "metabase/common/components/upsells/components/UpsellGem";
+import { useSelector } from "metabase/redux";
+import { getLocation } from "metabase/selectors/routing";
+import { FixedSizeIcon, Tabs } from "metabase/ui";
+import type { IconName } from "metabase-types/api";
+
+export type MonitorHeaderTab = {
+ label: string;
+ to: string;
+ icon?: IconName;
+ isGated?: boolean;
+ isSelected?: boolean | ((pathname: string) => boolean);
+};
+
+type MonitorHeaderTabsProps = {
+ tabs: MonitorHeaderTab[];
+};
+
+function isTabSelected(tab: MonitorHeaderTab, pathname: string) {
+ const { to, isSelected } = tab;
+ return typeof isSelected === "function"
+ ? isSelected(pathname)
+ : (isSelected ?? to === pathname);
+}
+
+export function MonitorHeaderTabs({ tabs }: MonitorHeaderTabsProps) {
+ const { pathname } = useSelector(getLocation);
+ const activeTab = tabs.find((tab) => isTabSelected(tab, pathname));
+
+ return (
+ <Tabs variant="pills" value={activeTab?.to ?? null}>
+ <Tabs.List>
+ {tabs.map(({ label, to, icon, isGated }) => (
+ <LinkTab
+ key={label}
+ value={to}
+ to={to}
+ leftSection={
+ icon !== undefined ? <FixedSizeIcon name={icon} /> : null
+ }
+ rightSection={isGated ? <UpsellGem.New size={14} /> : null}
+ >
+ {label}
+ </LinkTab>
+ ))}
+ </Tabs.List>
+ </Tabs>
+ );
+}
diff --git a/frontend/src/metabase/monitor/components/MonitorHeaderTabs/index.ts b/frontend/src/metabase/monitor/components/MonitorHeaderTabs/index.ts
new file mode 100644
index 00000000000..de090a42bee
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorHeaderTabs/index.ts
@@ -0,0 +1 @@
+export * from "./MonitorHeaderTabs";
diff --git a/frontend/src/metabase/monitor/components/MonitorHeaderTitle/MonitorHeaderTitle.tsx b/frontend/src/metabase/monitor/components/MonitorHeaderTitle/MonitorHeaderTitle.tsx
new file mode 100644
index 00000000000..4ead0401441
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorHeaderTitle/MonitorHeaderTitle.tsx
@@ -0,0 +1,5 @@
+import { Title, type TitleProps } from "metabase/ui";
+
+export function MonitorHeaderTitle(props: TitleProps) {
+ return <Title {...props} order={2} fz="sm" fw="normal" c="text-secondary" />;
+}
diff --git a/frontend/src/metabase/monitor/components/MonitorHeaderTitle/index.ts b/frontend/src/metabase/monitor/components/MonitorHeaderTitle/index.ts
new file mode 100644
index 00000000000..8d52c45e332
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorHeaderTitle/index.ts
@@ -0,0 +1 @@
+export * from "./MonitorHeaderTitle";
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/MonitorContent.tsx b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorContent.tsx
new file mode 100644
index 00000000000..b8647059ca6
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorContent.tsx
@@ -0,0 +1,79 @@
+import {
+ type ReactNode,
+ createContext,
+ useContext,
+ useMemo,
+ useState,
+} from "react";
+
+import { AppSwitcher } from "metabase/nav/components/AppSwitcher";
+import {
+ AreaContent,
+ CONTENT_PADDING_X,
+} from "metabase/nav/components/AreaLayout";
+import { Box } from "metabase/ui";
+
+type MonitorContentProps = {
+ children?: ReactNode;
+};
+
+type MonitorSidebarContextValue = {
+ sidebarNode: HTMLDivElement | null;
+};
+
+const MonitorSidebarContext = createContext<MonitorSidebarContextValue | null>(
+ null,
+);
+
+export function useMonitorSidebarContext() {
+ const context = useContext(MonitorSidebarContext);
+
+ if (context == null) {
+ throw new Error("Sidebar must be used within MonitorContent");
+ }
+
+ return context;
+}
+
+export function MonitorContent({ children }: MonitorContentProps) {
+ const [sidebarNode, setSidebarNode] = useState<HTMLDivElement | null>(null);
+ const contextValue = useMemo(() => ({ sidebarNode }), [sidebarNode]);
+
+ return (
+ <MonitorSidebarContext.Provider value={contextValue}>
+ <Box
+ h="100%"
+ bg="background_page-secondary"
+ display="flex"
+ style={{ overflow: "hidden" }}
+ >
+ <Box
+ data-testid="monitor-main"
+ h="100%"
+ pos="relative"
+ flex="1 1 auto"
+ miw={0}
+ >
+ <Box
+ pos="absolute"
+ top="1.5rem"
+ right={CONTENT_PADDING_X}
+ bg="background_page-secondary"
+ bdrs="50%"
+ style={{ zIndex: 10 }}
+ >
+ <AppSwitcher />
+ </Box>
+ <AreaContent>{children}</AreaContent>
+ </Box>
+ <Box
+ data-testid="monitor-sidebar-region"
+ ref={setSidebarNode}
+ h="100%"
+ display="flex"
+ flex="0 0 auto"
+ />
+ </Box>
+ </MonitorSidebarContext.Provider>
+ );
+}
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.tsx b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.tsx
new file mode 100644
index 00000000000..a87226af62e
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.tsx
@@ -0,0 +1,180 @@
+import { P, match } from "ts-pattern";
+import { t } from "ttag";
+
+import { useHasTokenFeature } from "metabase/common/hooks";
+import { useUserKeyValue } from "metabase/common/hooks/use-user-key-value";
+import {
+ type MonitorSection,
+ trackMonitorSectionClicked,
+} from "metabase/common/monitor/analytics";
+import {
+ canAccessAlertsManagement,
+ canAccessMonitorDiagnostics,
+ canAccessMonitoringTools,
+} from "metabase/common/monitor/selectors";
+import {
+ AreaLayout,
+ AreaTab,
+ AreaTabGroup,
+} from "metabase/nav/components/AreaLayout";
+import { useSelector } from "metabase/redux";
+import { Outlet } from "metabase/router";
+import { getLocation } from "metabase/selectors/routing";
+import { FixedSizeIcon, Flex } from "metabase/ui";
+import * as Urls from "metabase/urls";
+
+import { MonitorContent } from "./MonitorContent";
+
+function getActiveSection(pathname: string): MonitorSection | null {
+ return match(pathname)
+ .returnType<MonitorSection | null>()
+ .with(
+ P.string.startsWith(Urls.dependencyDiagnostics()),
+ () => "diagnostics",
+ )
+ .with(
+ P.string.startsWith(Urls.monitorErroringQuestions()),
+ () => "erroring-questions",
+ )
+ .with(P.string.startsWith(Urls.monitorNotifications()), () => "alerts")
+ .with(P.string.startsWith(Urls.monitorTasks()), () => "tasks")
+ .with(P.string.startsWith(Urls.monitorJobs()), () => "jobs")
+ .with(P.string.startsWith(Urls.monitorLogs()), () => "logs")
+ .with(
+ P.string.startsWith(Urls.monitorModelCaching()),
+ () => "model-caching",
+ )
+ .otherwise(() => null);
+}
+
+export function MonitorLayout() {
+ const {
+ value: _isNavbarOpened,
+ setValue: setIsNavbarOpened,
+ isLoading: isLoadingNavbarKey,
+ } = useUserKeyValue({
+ namespace: "monitor",
+ key: "isNavbarOpened",
+ });
+ const isNavbarOpened = _isNavbarOpened !== false;
+
+ const { pathname } = useSelector(getLocation);
+ const hasDependenciesFeature = useHasTokenFeature("dependencies");
+ const hasAuditAppFeature = useHasTokenFeature("audit_app");
+ const canAccessDiagnostics = useSelector(canAccessMonitorDiagnostics);
+ const canAccessTools = useSelector(canAccessMonitoringTools);
+ const canAccessAlerts = useSelector(canAccessAlertsManagement);
+
+ const activeSection = getActiveSection(pathname);
+
+ const hasContentManagement =
+ canAccessDiagnostics || canAccessTools || canAccessAlerts;
+ const hasLogsAndActivity = canAccessTools;
+
+ const upperNav = (
+ <>
+ {hasContentManagement && (
+ <AreaTabGroup
+ label={t`Content management`}
+ showLabel={isNavbarOpened}
+ mb="md"
+ >
+ {canAccessDiagnostics && (
+ <AreaTab
+ label={t`Dependency diagnostics`}
+ icon="search_check"
+ to={Urls.dependencyDiagnostics()}
+ isSelected={activeSection === "diagnostics"}
+ showLabel={isNavbarOpened}
+ isGated={!hasDependenciesFeature}
+ onClick={() => trackMonitorSectionClicked("diagnostics")}
+ />
+ )}
+ {canAccessTools && (
+ <AreaTab
+ label={t`Erroring questions`}
+ icon="warning_round"
+ to={Urls.monitorErroringQuestions()}
+ isSelected={activeSection === "erroring-questions"}
+ showLabel={isNavbarOpened}
+ isGated={!hasAuditAppFeature}
+ onClick={() => trackMonitorSectionClicked("erroring-questions")}
+ />
+ )}
+ {canAccessAlerts && (
+ <AreaTab
+ label={t`Alerts management`}
+ icon="bell"
+ to={Urls.monitorNotifications()}
+ isSelected={activeSection === "alerts"}
+ showLabel={isNavbarOpened}
+ onClick={() => trackMonitorSectionClicked("alerts")}
+ />
+ )}
+ </AreaTabGroup>
+ )}
+ {hasLogsAndActivity && (
+ <AreaTabGroup label={t`Logs and activity`} showLabel={isNavbarOpened}>
+ <AreaTab
+ label={t`Background tasks`}
+ icon="clipboard"
+ to={Urls.monitorTasks()}
+ isSelected={activeSection === "tasks"}
+ showLabel={isNavbarOpened}
+ onClick={() => trackMonitorSectionClicked("tasks")}
+ />
+ <AreaTab
+ label={t`Scheduled jobs`}
+ icon="clock"
+ to={Urls.monitorJobs()}
+ isSelected={activeSection === "jobs"}
+ showLabel={isNavbarOpened}
+ onClick={() => trackMonitorSectionClicked("jobs")}
+ />
+ <AreaTab
+ label={t`Application logs`}
+ icon="audit"
+ to={Urls.monitorLogs()}
+ isSelected={activeSection === "logs"}
+ showLabel={isNavbarOpened}
+ onClick={() => trackMonitorSectionClicked("logs")}
+ />
+ <AreaTab
+ label={t`Model caching log`}
+ icon="bolt"
+ to={Urls.monitorModelCaching()}
+ isSelected={activeSection === "model-caching"}
+ showLabel={isNavbarOpened}
+ onClick={() => trackMonitorSectionClicked("model-caching")}
+ />
+ </AreaTabGroup>
+ )}
+ </>
+ );
+
+ return (
+ <AreaLayout
+ logo={
+ <Flex
+ bdrs="50%"
+ bg="background_surface-brand-subtle"
+ w="2rem"
+ h="2rem"
+ align="center"
+ justify="center"
+ >
+ <FixedSizeIcon name="pulse" size={14} c="brand" />
+ </Flex>
+ }
+ testId="monitor-nav"
+ isLoading={isLoadingNavbarKey}
+ isNavbarOpened={isNavbarOpened}
+ onNavbarToggle={setIsNavbarOpened}
+ upperNav={upperNav}
+ >
+ <MonitorContent>
+ <Outlet />
+ </MonitorContent>
+ </AreaLayout>
+ );
+}
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.unit.spec.tsx b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.unit.spec.tsx
new file mode 100644
index 00000000000..fdd0fd078c8
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorLayout.unit.spec.tsx
@@ -0,0 +1,396 @@
+import userEvent from "@testing-library/user-event";
+import { type ReactNode, memo, useState } from "react";
+
+import {
+ setupPropertiesEndpoints,
+ setupSettingsEndpoints,
+ setupUserKeyValueEndpoints,
+} from "__support__/server-mocks";
+import { mockSettings } from "__support__/settings";
+import { renderWithProviders, screen, waitFor, within } from "__support__/ui";
+import {
+ createMockLocation,
+ createMockRoutingState,
+ createMockState,
+} from "metabase/redux/store/mocks";
+import { Route } from "metabase/router";
+import * as Urls from "metabase/urls";
+import type { TokenFeatures } from "metabase-types/api";
+import {
+ createMockSettings,
+ createMockTokenFeatures,
+ createMockUser,
+} from "metabase-types/api/mocks";
+
+import { MonitorLayout } from "./MonitorLayout";
+import { Sidebar } from "./Sidebar";
+
+jest.mock("metabase/common/monitor/analytics", () => ({
+ trackMonitorSectionClicked: jest.fn(),
+}));
+
+const { trackMonitorSectionClicked } = jest.requireMock(
+ "metabase/common/monitor/analytics",
+);
+
+interface SetupOpts {
+ isNavbarOpened?: boolean;
+ tokenFeatures?: Partial<TokenFeatures>;
+ initialRoute?: string;
+ user?: ReturnType<typeof createMockUser>;
+ children?: ReactNode;
+}
+
+function TestSidebarSetter() {
+ return (
+ <>
+ <div data-testid="content">{"Content"}</div>
+ <Sidebar containerWidth={1000}>
+ <aside data-testid="monitor-sidebar">{"Sidebar"}</aside>
+ </Sidebar>
+ </>
+ );
+}
+
+const TestMainContent = memo(function TestMainContent({
+ onRender,
+}: {
+ onRender: () => void;
+}) {
+ onRender();
+
+ return <div data-testid="content">{"Content"}</div>;
+});
+
+function TestSidebarToggle({ onRender }: { onRender: () => void }) {
+ const [isOpen, setIsOpen] = useState(false);
+
+ return (
+ <>
+ <TestMainContent onRender={onRender} />
+ <button onClick={() => setIsOpen(true)}>{"Open sidebar"}</button>
+ {isOpen && (
+ <Sidebar containerWidth={1000}>
+ <aside data-testid="monitor-sidebar">{"Sidebar"}</aside>
+ </Sidebar>
+ )}
+ </>
+ );
+}
+
+const setup = ({
+ isNavbarOpened = true,
+ tokenFeatures,
+ initialRoute = "/monitor",
+ user = createMockUser({ is_superuser: true }),
+ children = <div data-testid="content">{"Content"}</div>,
+}: SetupOpts = {}) => {
+ const settings = mockSettings({
+ "token-features": createMockTokenFeatures(tokenFeatures),
+ });
+
+ setupSettingsEndpoints([]);
+ setupPropertiesEndpoints(
+ createMockSettings({
+ "token-features": createMockTokenFeatures(tokenFeatures),
+ }),
+ );
+ setupUserKeyValueEndpoints({
+ namespace: "monitor",
+ key: "isNavbarOpened",
+ value: isNavbarOpened,
+ });
+
+ const state = createMockState({
+ currentUser: user,
+ routing: createMockRoutingState({
+ locationBeforeTransitions: createMockLocation({ pathname: initialRoute }),
+ }),
+ settings,
+ });
+
+ renderWithProviders(
+ <Route element={<MonitorLayout />}>
+ <Route path="*" element={children} />
+ </Route>,
+ {
+ initialRoute,
+ storeInitialState: state,
+ withRouter: true,
+ },
+ );
+};
+
+const CONTENT_MANAGEMENT_GROUP = "Content management";
+const LOGS_AND_ACTIVITY_GROUP = "Logs and activity";
+
+describe("MonitorLayout", () => {
+ it("groups the sections under static headings with a link for each Monitor section", async () => {
+ setup();
+
+ await waitFor(() => {
+ expect(screen.getByTestId("monitor-nav")).toBeInTheDocument();
+ });
+
+ expect(
+ screen.getByRole("heading", { name: CONTENT_MANAGEMENT_GROUP }),
+ ).toBeInTheDocument();
+ expect(
+ screen.getByRole("heading", { name: LOGS_AND_ACTIVITY_GROUP }),
+ ).toBeInTheDocument();
+
+ const expectedTabs: [string, string][] = [
+ ["Dependency diagnostics", Urls.dependencyDiagnostics()],
+ ["Erroring questions", Urls.monitorErroringQuestions()],
+ ["Alerts management", Urls.monitorNotifications()],
+ ["Background tasks", Urls.monitorTasks()],
+ ["Scheduled jobs", Urls.monitorJobs()],
+ ["Application logs", Urls.monitorLogs()],
+ ["Model caching log", Urls.monitorModelCaching()],
+ ];
+
+ expectedTabs.forEach(([name, href]) => {
+ expect(screen.getByRole("link", { name })).toHaveAttribute("href", href);
+ });
+ });
+
+ const SECTION_CASES = [
+ {
+ label: "Dependency diagnostics",
+ route: Urls.dependencyDiagnostics(),
+ section: "diagnostics",
+ },
+ {
+ label: "Erroring questions",
+ route: Urls.monitorErroringQuestions(),
+ section: "erroring-questions",
+ },
+ {
+ label: "Alerts management",
+ route: Urls.monitorNotifications(),
+ section: "alerts",
+ },
+ {
+ label: "Background tasks",
+ route: Urls.monitorTasks(),
+ section: "tasks",
+ },
+ {
+ label: "Scheduled jobs",
+ route: Urls.monitorJobs(),
+ section: "jobs",
+ },
+ {
+ label: "Application logs",
+ route: Urls.monitorLogs(),
+ section: "logs",
+ },
+ {
+ label: "Model caching log",
+ route: Urls.monitorModelCaching(),
+ section: "model-caching",
+ },
+ ] as const;
+
+ it.each(SECTION_CASES)(
+ "marks $label as the current page for its route",
+ async ({ label, route }) => {
+ setup({ initialRoute: route });
+
+ await waitFor(() => {
+ expect(screen.getByTestId("monitor-nav")).toBeInTheDocument();
+ });
+
+ const activeLink = screen.getByRole("link", { name: label });
+ expect(activeLink).toHaveAttribute("aria-current", "page");
+ expect(screen.getAllByRole("link", { current: "page" })).toEqual([
+ activeLink,
+ ]);
+ },
+ );
+
+ it.each(SECTION_CASES)(
+ "tracks opening the $label section",
+ async ({ label, section }) => {
+ trackMonitorSectionClicked.mockClear();
+ setup();
+
+ await userEvent.click(await screen.findByRole("link", { name: label }));
+
+ expect(trackMonitorSectionClicked).toHaveBeenCalledWith(section);
+ },
+ );
+
+ it("hides the migrated Tools tabs for an analyst without the monitoring permission", async () => {
+ setup({
+ user: createMockUser({
+ is_superuser: false,
+ is_data_analyst: true,
+ permissions: { can_access_monitoring: false },
+ }),
+ });
+
+ await waitFor(() => {
+ expect(screen.getByTestId("monitor-nav")).toBeInTheDocument();
+ });
+
+ expect(
+ screen.queryByRole("heading", { name: LOGS_AND_ACTIVITY_GROUP }),
+ ).not.toBeInTheDocument();
+
+ expect(
+ screen.getByRole("link", { name: "Dependency diagnostics" }),
+ ).toBeInTheDocument();
+ [
+ "Background tasks",
+ "Scheduled jobs",
+ "Application logs",
+ "Erroring questions",
+ "Model caching log",
+ "Alerts management",
+ ].forEach((name) => {
+ expect(screen.queryByRole("link", { name })).not.toBeInTheDocument();
+ });
+ });
+
+ it("hides Dependency diagnostics for a monitoring-only user, and hides Alerts management (admin-only)", async () => {
+ setup({
+ user: createMockUser({
+ is_superuser: false,
+ is_data_analyst: false,
+ permissions: { can_access_monitoring: true },
+ }),
+ });
+
+ await waitFor(() => {
+ expect(screen.getByTestId("monitor-nav")).toBeInTheDocument();
+ });
+
+ expect(
+ screen.queryByRole("link", { name: "Dependency diagnostics" }),
+ ).not.toBeInTheDocument();
+ [
+ "Background tasks",
+ "Scheduled jobs",
+ "Application logs",
+ "Model caching log",
+ ].forEach((name) => {
+ expect(screen.getByRole("link", { name })).toBeInTheDocument();
+ });
+ expect(
+ screen.queryByRole("link", { name: "Alerts management" }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("hides Alerts management for an analyst even with the monitoring permission", async () => {
+ setup({
+ user: createMockUser({
+ is_superuser: false,
+ is_data_analyst: true,
+ permissions: { can_access_monitoring: true },
+ }),
+ });
+
+ await waitFor(() => {
+ expect(screen.getByTestId("monitor-nav")).toBeInTheDocument();
+ });
+
+ expect(
+ screen.getByRole("link", { name: "Erroring questions" }),
+ ).toBeInTheDocument();
+ expect(
+ screen.queryByRole("link", { name: "Alerts management" }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("renders the content area", async () => {
+ setup();
+
+ await waitFor(() => {
+ expect(screen.getByTestId("monitor-nav")).toBeInTheDocument();
+ });
+
+ expect(screen.getByTestId("content")).toBeInTheDocument();
+ });
+
+ it("renders the AppSwitcher in Monitor view", async () => {
+ setup();
+
+ await waitFor(() => {
+ expect(screen.getByTestId("monitor-nav")).toBeInTheDocument();
+ });
+
+ expect(screen.getByTestId("monitor-main")).toContainElement(
+ screen.getByTestId("app-switcher-target"),
+ );
+ });
+
+ it("renders monitor sidebar outside the padded main content area", async () => {
+ setup({ children: <TestSidebarSetter /> });
+
+ await waitFor(() => {
+ expect(screen.getByTestId("monitor-sidebar")).toBeInTheDocument();
+ });
+
+ expect(screen.getByTestId("monitor-main")).toContainElement(
+ screen.getByTestId("content"),
+ );
+ expect(screen.getByTestId("monitor-main")).not.toContainElement(
+ screen.getByTestId("monitor-sidebar"),
+ );
+ expect(screen.getByTestId("monitor-sidebar-region")).toContainElement(
+ screen.getByTestId("monitor-sidebar"),
+ );
+ });
+
+ it("does not rerender main content when the sidebar is toggled", async () => {
+ const onRender = jest.fn();
+ setup({ children: <TestSidebarToggle onRender={onRender} /> });
+
+ await waitFor(() => {
+ expect(screen.getByTestId("monitor-nav")).toBeInTheDocument();
+ });
+ const renderCount = onRender.mock.calls.length;
+
+ await userEvent.click(screen.getByRole("button", { name: "Open sidebar" }));
+
+ expect(screen.getByTestId("monitor-sidebar")).toBeInTheDocument();
+ expect(onRender).toHaveBeenCalledTimes(renderCount);
+ });
+
+ const getTabGem = (name: string) =>
+ within(screen.getByRole("link", { name })).queryByTestId("upsell-gem");
+
+ it("gates only Erroring questions when audit_app is unavailable", async () => {
+ setup({ tokenFeatures: { dependencies: true, audit_app: false } });
+
+ await waitFor(() => {
+ expect(screen.getByTestId("monitor-nav")).toBeInTheDocument();
+ });
+
+ expect(getTabGem("Erroring questions")).toBeInTheDocument();
+ expect(getTabGem("Dependency diagnostics")).not.toBeInTheDocument();
+ });
+
+ it("gates only Dependency diagnostics when dependencies is unavailable", async () => {
+ setup({ tokenFeatures: { dependencies: false, audit_app: true } });
+
+ await waitFor(() => {
+ expect(screen.getByTestId("monitor-nav")).toBeInTheDocument();
+ });
+
+ expect(getTabGem("Dependency diagnostics")).toBeInTheDocument();
+ expect(getTabGem("Erroring questions")).not.toBeInTheDocument();
+ });
+
+ it("gates neither when both features are available", async () => {
+ setup({ tokenFeatures: { dependencies: true, audit_app: true } });
+
+ await waitFor(() => {
+ expect(screen.getByTestId("monitor-nav")).toBeInTheDocument();
+ });
+
+ expect(getTabGem("Dependency diagnostics")).not.toBeInTheDocument();
+ expect(getTabGem("Erroring questions")).not.toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/MonitorMain.module.css b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorMain.module.css
new file mode 100644
index 00000000000..474a05c8987
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorMain.module.css
@@ -0,0 +1,7 @@
+.main {
+ overflow: hidden;
+
+ /* extra spacing so that focus outlines at the container edge are not clipped */
+ padding: 4px;
+ margin: -4px;
+}
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/MonitorMain.tsx b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorMain.tsx
new file mode 100644
index 00000000000..08311c60846
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/MonitorMain.tsx
@@ -0,0 +1,26 @@
+import cx from "classnames";
+import type { ReactNode } from "react";
+
+import { Stack, type StackProps } from "metabase/ui";
+
+import S from "./MonitorMain.module.css";
+
+type MonitorMainProps = {
+ children?: ReactNode;
+} & StackProps;
+
+/**
+ * The main content column of a Monitor view: fills the available space and
+ * clips overflowing children, so tables can scroll internally.
+ */
+export function MonitorMain({
+ children,
+ className,
+ ...stackProps
+}: MonitorMainProps) {
+ return (
+ <Stack className={cx(S.main, className)} flex={1} gap="md" {...stackProps}>
+ {children}
+ </Stack>
+ );
+}
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/Sidebar.tsx b/frontend/src/metabase/monitor/components/MonitorLayout/Sidebar.tsx
new file mode 100644
index 00000000000..d0d58a38c5b
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/Sidebar.tsx
@@ -0,0 +1,50 @@
+import type { ReactNode } from "react";
+import { createPortal } from "react-dom";
+
+import ErrorBoundary from "metabase/ErrorBoundary";
+
+import { useMonitorSidebarContext } from "./MonitorContent";
+import { SidebarResizableBox } from "./SidebarResizableBox";
+
+const SIDEBAR_WIDTH = 512;
+
+type SidebarProps = {
+ children: ReactNode;
+ defaultWidth?: number;
+} & (
+ | {
+ resizable?: true;
+ containerWidth: number;
+ }
+ | {
+ resizable: false;
+ }
+);
+
+/**
+ * Portal for Monitor views' sidebar outlet. Resizable by default.
+ */
+export function Sidebar(props: SidebarProps) {
+ const { children, defaultWidth = SIDEBAR_WIDTH } = props;
+ const { sidebarNode } = useMonitorSidebarContext();
+
+ if (sidebarNode == null) {
+ return null;
+ }
+
+ const content = <ErrorBoundary>{children}</ErrorBoundary>;
+
+ return createPortal(
+ props.resizable === false ? (
+ content
+ ) : (
+ <SidebarResizableBox
+ containerWidth={props.containerWidth}
+ defaultWidth={defaultWidth}
+ >
+ {content}
+ </SidebarResizableBox>
+ ),
+ sidebarNode,
+ );
+}
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/Sidebar.unit.spec.tsx b/frontend/src/metabase/monitor/components/MonitorLayout/Sidebar.unit.spec.tsx
new file mode 100644
index 00000000000..dee43a17371
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/Sidebar.unit.spec.tsx
@@ -0,0 +1,73 @@
+import type { ReactNode } from "react";
+import type { ResizableProps } from "react-resizable";
+
+import { renderWithProviders, screen, within } from "__support__/ui";
+
+import { MonitorContent } from "./MonitorContent";
+import { Sidebar } from "./Sidebar";
+
+let latestResizableBoxProps: ResizableProps | null = null;
+
+jest.mock("react-resizable", () => ({
+ ResizableBox: (props: ResizableProps) => {
+ latestResizableBoxProps = props;
+ return <div data-testid="resizable-box">{props.children}</div>;
+ },
+}));
+
+// AppSwitcher pulls in redux/settings the Sidebar behavior doesn't need.
+jest.mock("metabase/nav/components/AppSwitcher", () => ({
+ AppSwitcher: () => null,
+}));
+
+function setup(sidebar: ReactNode) {
+ return renderWithProviders(<MonitorContent>{sidebar}</MonitorContent>);
+}
+
+describe("Sidebar", () => {
+ beforeEach(() => {
+ latestResizableBoxProps = null;
+ });
+
+ it("portals resizable content into the sidebar region at the default width", () => {
+ setup(
+ <Sidebar containerWidth={1000}>
+ <div data-testid="sidebar-content">{"Sidebar"}</div>
+ </Sidebar>,
+ );
+
+ const resizableBox = screen.getByTestId("resizable-box");
+ expect(screen.getByTestId("monitor-sidebar-region")).toContainElement(
+ resizableBox,
+ );
+ expect(
+ within(resizableBox).getByTestId("sidebar-content"),
+ ).toBeInTheDocument();
+ expect(latestResizableBoxProps?.width).toBe(512);
+ });
+
+ it("uses the provided default width", () => {
+ setup(
+ <Sidebar containerWidth={1000} defaultWidth={560}>
+ <div data-testid="sidebar-content">{"Sidebar"}</div>
+ </Sidebar>,
+ );
+
+ expect(latestResizableBoxProps?.width).toBe(560);
+ });
+
+ it("renders content directly without the resizable box when resizable is false", () => {
+ setup(
+ <Sidebar resizable={false}>
+ <div data-testid="sidebar-content">{"Sidebar"}</div>
+ </Sidebar>,
+ );
+
+ expect(
+ within(screen.getByTestId("monitor-sidebar-region")).getByTestId(
+ "sidebar-content",
+ ),
+ ).toBeInTheDocument();
+ expect(screen.queryByTestId("resizable-box")).not.toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/SidebarResizableBox/SidebarResizableBox.module.css b/frontend/src/metabase/monitor/components/MonitorLayout/SidebarResizableBox/SidebarResizableBox.module.css
new file mode 100644
index 00000000000..9c9eaecc135
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/SidebarResizableBox/SidebarResizableBox.module.css
@@ -0,0 +1,7 @@
+.resizableBox {
+ display: flex;
+}
+
+.noSelect {
+ user-select: none;
+}
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/SidebarResizableBox/SidebarResizableBox.tsx b/frontend/src/metabase/monitor/components/MonitorLayout/SidebarResizableBox/SidebarResizableBox.tsx
new file mode 100644
index 00000000000..d9104458243
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/SidebarResizableBox/SidebarResizableBox.tsx
@@ -0,0 +1,62 @@
+import { type ReactNode, type SyntheticEvent, useState } from "react";
+import { ResizableBox, type ResizeCallbackData } from "react-resizable";
+
+import { ResizeHandle } from "metabase/common/components/ResizeHandle";
+
+import S from "./SidebarResizableBox.module.css";
+
+const MIN_SIDEBAR_WIDTH = 400;
+
+type SidebarResizableBoxProps = {
+ /** Width of the view's content area (excluding the sidebar itself). */
+ containerWidth: number;
+ defaultWidth: number;
+ children?: ReactNode;
+ onResizeStart?: () => void;
+ onResizeStop?: () => void;
+};
+
+export function SidebarResizableBox({
+ containerWidth,
+ defaultWidth,
+ children,
+ onResizeStart,
+ onResizeStop,
+}: SidebarResizableBoxProps) {
+ const [sidebarWidth, setSidebarWidth] = useState(defaultWidth);
+ const maxSidebarWidth = Math.max(
+ (containerWidth + sidebarWidth) / 2,
+ MIN_SIDEBAR_WIDTH,
+ );
+
+ const handleResize = (_event: SyntheticEvent, data: ResizeCallbackData) => {
+ setSidebarWidth(data.size.width);
+ };
+
+ const handleResizeStart = () => {
+ document.body.classList.add(S.noSelect);
+ onResizeStart?.();
+ };
+
+ const handleResizeStop = () => {
+ document.body.classList.remove(S.noSelect);
+ onResizeStop?.();
+ };
+
+ return (
+ <ResizableBox
+ className={S.resizableBox}
+ width={sidebarWidth}
+ minConstraints={[MIN_SIDEBAR_WIDTH, 0]}
+ maxConstraints={[maxSidebarWidth, 0]}
+ axis="x"
+ resizeHandles={["w"]}
+ handle={<ResizeHandle handleAxis="w" />}
+ onResizeStart={handleResizeStart}
+ onResize={handleResize}
+ onResizeStop={handleResizeStop}
+ >
+ {children}
+ </ResizableBox>
+ );
+}
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/SidebarResizableBox/SidebarResizableBox.unit.spec.tsx b/frontend/src/metabase/monitor/components/MonitorLayout/SidebarResizableBox/SidebarResizableBox.unit.spec.tsx
new file mode 100644
index 00000000000..46a06074bab
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/SidebarResizableBox/SidebarResizableBox.unit.spec.tsx
@@ -0,0 +1,117 @@
+import type { ResizableProps, ResizeCallbackData } from "react-resizable";
+
+import { act, render, screen } from "__support__/ui";
+
+import { SidebarResizableBox } from "./SidebarResizableBox";
+
+const RESIZE_CALLBACK_DATA: ResizeCallbackData = {
+ size: { width: 600, height: 0 },
+ node: document.createElement("div"),
+ handle: "w",
+};
+
+let latestResizableBoxProps: ResizableProps | null = null;
+
+jest.mock("react-resizable", () => ({
+ ResizableBox: (props: ResizableProps) => {
+ latestResizableBoxProps = props;
+ return <div data-testid="resizable-box">{props.children}</div>;
+ },
+}));
+
+describe("SidebarResizableBox", () => {
+ beforeEach(() => {
+ latestResizableBoxProps = null;
+ });
+
+ it("keeps the user-resized width when the container width changes", () => {
+ const { rerender } = render(
+ <SidebarResizableBox
+ containerWidth={1200}
+ defaultWidth={512}
+ onResizeStart={jest.fn()}
+ onResizeStop={jest.fn()}
+ >
+ <div>{"Sidebar content"}</div>
+ </SidebarResizableBox>,
+ );
+
+ expect(screen.getByTestId("resizable-box")).toBeInTheDocument();
+ act(() => {
+ latestResizableBoxProps?.onResize?.(
+ // react-resizable's callbacks require an event; the component ignores it
+ {} as React.SyntheticEvent,
+ RESIZE_CALLBACK_DATA,
+ );
+ });
+
+ rerender(
+ <SidebarResizableBox
+ containerWidth={1000}
+ defaultWidth={512}
+ onResizeStart={jest.fn()}
+ onResizeStop={jest.fn()}
+ >
+ <div>{"Sidebar content"}</div>
+ </SidebarResizableBox>,
+ );
+
+ expect(latestResizableBoxProps?.width).toBe(600);
+ expect(latestResizableBoxProps?.maxConstraints).toEqual([800, 0]);
+ });
+
+ it("starts at the provided default width", () => {
+ render(
+ <SidebarResizableBox
+ containerWidth={1200}
+ defaultWidth={560}
+ onResizeStart={jest.fn()}
+ onResizeStop={jest.fn()}
+ >
+ <div>{"Sidebar content"}</div>
+ </SidebarResizableBox>,
+ );
+
+ expect(latestResizableBoxProps?.width).toBe(560);
+ });
+
+ it("disables text selection on body while resizing", () => {
+ const onResizeStart = jest.fn();
+ const onResizeStop = jest.fn();
+
+ render(
+ <SidebarResizableBox
+ containerWidth={1200}
+ defaultWidth={512}
+ onResizeStart={onResizeStart}
+ onResizeStop={onResizeStop}
+ >
+ <div>{"Sidebar content"}</div>
+ </SidebarResizableBox>,
+ );
+
+ expect(document.body.className).toBe("");
+
+ act(() => {
+ latestResizableBoxProps?.onResizeStart?.(
+ // react-resizable's callbacks require an event; the component ignores it
+ {} as React.SyntheticEvent,
+ RESIZE_CALLBACK_DATA,
+ );
+ });
+
+ expect(document.body.className).not.toBe("");
+ expect(onResizeStart).toHaveBeenCalled();
+
+ act(() => {
+ latestResizableBoxProps?.onResizeStop?.(
+ // react-resizable's callbacks require an event; the component ignores it
+ {} as React.SyntheticEvent,
+ RESIZE_CALLBACK_DATA,
+ );
+ });
+
+ expect(document.body.className).toBe("");
+ expect(onResizeStop).toHaveBeenCalled();
+ });
+});
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/SidebarResizableBox/index.ts b/frontend/src/metabase/monitor/components/MonitorLayout/SidebarResizableBox/index.ts
new file mode 100644
index 00000000000..cdad874b262
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/SidebarResizableBox/index.ts
@@ -0,0 +1 @@
+export * from "./SidebarResizableBox";
diff --git a/frontend/src/metabase/monitor/components/MonitorLayout/index.ts b/frontend/src/metabase/monitor/components/MonitorLayout/index.ts
new file mode 100644
index 00000000000..cb56dc67c3e
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorLayout/index.ts
@@ -0,0 +1,2 @@
+export * from "./MonitorLayout";
+export * from "./MonitorMain";
diff --git a/frontend/src/metabase/monitor/components/MonitorPageContent/MonitorPageContent.module.css b/frontend/src/metabase/monitor/components/MonitorPageContent/MonitorPageContent.module.css
new file mode 100644
index 00000000000..d7a5d7e63cd
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorPageContent/MonitorPageContent.module.css
@@ -0,0 +1,12 @@
+.MonitorPageWrapper {
+ overflow: hidden;
+ background-color: var(--mb-color-background_page-primary);
+ border: 1px solid var(--mb-color-border-neutral);
+ border-radius: var(--mantine-radius-md);
+}
+
+.MonitorPageContent {
+ padding: var(--mantine-spacing-xl);
+ overflow: auto;
+ height: 100%;
+}
diff --git a/frontend/src/metabase/monitor/components/MonitorPageContent/MonitorPageContent.tsx b/frontend/src/metabase/monitor/components/MonitorPageContent/MonitorPageContent.tsx
new file mode 100644
index 00000000000..7f0d7f4344f
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorPageContent/MonitorPageContent.tsx
@@ -0,0 +1,26 @@
+import cx from "classnames";
+import type { ReactNode } from "react";
+
+import { Box, type BoxProps, Stack } from "metabase/ui";
+
+import S from "./MonitorPageContent.module.css";
+
+type MonitorPageContentProps = {
+ children?: ReactNode;
+} & BoxProps;
+
+export function MonitorPageContent({
+ children,
+ ...boxProps
+}: MonitorPageContentProps) {
+ return (
+ <Box
+ {...boxProps}
+ className={cx(S.MonitorPageWrapper, boxProps?.className)}
+ >
+ <Stack gap="lg" className={S.MonitorPageContent}>
+ {children}
+ </Stack>
+ </Box>
+ );
+}
diff --git a/frontend/src/metabase/monitor/components/MonitorPageContent/index.ts b/frontend/src/metabase/monitor/components/MonitorPageContent/index.ts
new file mode 100644
index 00000000000..0ce7a6935d4
--- /dev/null
+++ b/frontend/src/metabase/monitor/components/MonitorPageContent/index.ts
@@ -0,0 +1 @@
+export { MonitorPageContent } from "./MonitorPageContent";
diff --git a/frontend/src/metabase/monitor/dependency-diagnostics/DependencyDiagnosticsSectionLayout/DependencyDiagnosticsSectionLayout.tsx b/frontend/src/metabase/monitor/dependency-diagnostics/DependencyDiagnosticsSectionLayout/DependencyDiagnosticsSectionLayout.tsx
index 8e1b6bec611..ab79afb0cf5 100644
--- a/frontend/src/metabase/monitor/dependency-diagnostics/DependencyDiagnosticsSectionLayout/DependencyDiagnosticsSectionLayout.tsx
+++ b/frontend/src/metabase/monitor/dependency-diagnostics/DependencyDiagnosticsSectionLayout/DependencyDiagnosticsSectionLayout.tsx
@@ -1,15 +1,15 @@
import { t } from "ttag";
-import { SectionLayout } from "metabase/data-studio/app/components/SectionLayout";
import { usePageTitle } from "metabase/hooks/use-page-title";
import { Outlet } from "metabase/router";
+import { Stack } from "metabase/ui";
export function DependencyDiagnosticsSectionLayout() {
usePageTitle(t`Dependency diagnostics`);
return (
- <SectionLayout>
+ <Stack h="100%" gap={0} bg="background_page-secondary">
<Outlet />
- </SectionLayout>
+ </Stack>
);
}
diff --git a/frontend/src/metabase/monitor/dependency-diagnostics/DependencyDiagnosticsUpsellPage.tsx b/frontend/src/metabase/monitor/dependency-diagnostics/DependencyDiagnosticsUpsellPage.tsx
index 2dd1b1d5a6c..3cda134f20b 100644
--- a/frontend/src/metabase/monitor/dependency-diagnostics/DependencyDiagnosticsUpsellPage.tsx
+++ b/frontend/src/metabase/monitor/dependency-diagnostics/DependencyDiagnosticsUpsellPage.tsx
@@ -1,7 +1,7 @@
import { t } from "ttag";
-import { BaseUpsellPage } from "metabase/data-studio/upsells/pages/BaseUpsellPage";
import { usePageTitle } from "metabase/hooks/use-page-title";
+import { BaseUpsellPage } from "metabase/monitor/upsells";
export function DependencyDiagnosticsUpsellPage() {
usePageTitle(t`Dependency diagnostics`);
diff --git a/frontend/src/metabase/monitor/routes.tsx b/frontend/src/metabase/monitor/routes.tsx
new file mode 100644
index 00000000000..2f05065e301
--- /dev/null
+++ b/frontend/src/metabase/monitor/routes.tsx
@@ -0,0 +1,164 @@
+import { createElement } from "react";
+
+import { NotFound } from "metabase/common/components/ErrorPages";
+import { modalRoute } from "metabase/common/components/ModalRoute";
+import { canAccessMonitorDiagnostics } from "metabase/common/monitor/selectors";
+import { DependencyDiagnosticsSectionLayout } from "metabase/monitor/dependency-diagnostics/DependencyDiagnosticsSectionLayout";
+import { DependencyDiagnosticsUpsellPage } from "metabase/monitor/dependency-diagnostics/DependencyDiagnosticsUpsellPage";
+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";
+import { MonitorUpsell } from "metabase/monitor/tools/components/MonitorUpsell";
+import {
+ getNotificationsRoutes,
+ getTasksRoutes,
+} from "metabase/monitor/tools/routes";
+import { PLUGIN_MONITOR, PLUGIN_MONITOR_TOOLS } from "metabase/plugins";
+import { useSelector } from "metabase/redux";
+import type { State } from "metabase/redux/store";
+import {
+ Navigate,
+ Route,
+ type RouteComponent,
+ redirect,
+ withRouteProps,
+} from "metabase/router";
+import * as Urls from "metabase/urls";
+
+import { MonitorLayout } from "./components/MonitorLayout";
+
+const RoutedJobInfoApp = withRouteProps(JobInfoApp);
+
+/** Lands on the first Monitor section the user can access. */
+function MonitorIndexRedirect() {
+ const indexPath = useSelector(getMonitorIndexPath);
+ return <Navigate to={indexPath} replace />;
+}
+
+export function getMonitorRoutes(
+ CanAccessMonitor: RouteComponent,
+ CanAccessMonitorDiagnostics: RouteComponent,
+ CanAccessMonitoringTools: RouteComponent,
+ CanAccessAlertsManagement: RouteComponent,
+) {
+ return (
+ <Route element={<CanAccessMonitor />}>
+ <Route path="monitor" element={<MonitorLayout />}>
+ <Route index element={<MonitorIndexRedirect />} />
+ <Route element={<CanAccessMonitorDiagnostics />}>
+ {PLUGIN_MONITOR.isDependencyDiagnosticsEnabled ? (
+ <Route
+ path="dependency-diagnostics"
+ element={<DependencyDiagnosticsSectionLayout />}
+ >
+ {PLUGIN_MONITOR.getDependencyDiagnosticsRoutes()}
+ </Route>
+ ) : (
+ <Route path="dependency-diagnostics">
+ <Route index element={<DependencyDiagnosticsUpsellPage />} />
+ <Route path="*" element={<DependencyDiagnosticsUpsellPage />} />
+ </Route>
+ )}
+ </Route>
+
+ <Route element={<CanAccessMonitoringTools />}>
+ <Route path="tasks">{getTasksRoutes()}</Route>
+ <Route path="jobs" element={<RoutedJobInfoApp />}>
+ <Route path=":jobKey" />
+ </Route>
+ <Route path="logs" element={<Logs />}>
+ {modalRoute("levels", LogLevelsModal)}
+ </Route>
+ <Route
+ path="errors"
+ element={createElement(
+ PLUGIN_MONITOR_TOOLS.COMPONENT || MonitorUpsell,
+ )}
+ />
+ <Route path="model-caching" element={<ModelCachePage />}>
+ {modalRoute(":jobId", ModelCacheRefreshJobModal)}
+ </Route>
+ </Route>
+
+ <Route element={<CanAccessAlertsManagement />}>
+ <Route path="notifications">{getNotificationsRoutes()}</Route>
+ </Route>
+
+ <Route path="*" element={<NotFound />} />
+ </Route>
+ </Route>
+ );
+}
+
+// Diagnostics for analysts/admins; otherwise the Tools pages for users who only
+// hold the monitoring application permission.
+function getMonitorIndexPath(state: State) {
+ return canAccessMonitorDiagnostics(state)
+ ? Urls.dependencyDiagnostics()
+ : Urls.monitorTasks();
+}
+
+/**
+ * Legacy redirects for Admin Tools pages that moved into the Monitor area:
+ * - /admin/tools → /monitor
+ * - /admin/tools/help → /admin/help
+ *
+ * The Data Studio → Monitor redirect for Dependency Diagnostics lives in
+ * data-studio/routes.tsx instead: it must be declared inside the Data Studio
+ * region (before that subtree's catch-all) so it isn't shadowed, yet outside the
+ * Data Studio access guard so it forwards every user.
+ */
+export function getMonitorRedirects() {
+ return (
+ <>
+ <Route path="/admin/tools/help" element={redirect(Urls.adminHelp())} />
+ <Route
+ path="/admin/tools/help/*"
+ element={redirect(`${Urls.adminHelp()}/*`)}
+ />
+ <Route
+ path="/admin/tools/tasks"
+ element={redirect(Urls.monitorTasks())}
+ />
+ <Route
+ path="/admin/tools/tasks/*"
+ element={redirect(`${Urls.monitorTasks()}/*`)}
+ />
+ <Route path="/admin/tools/jobs" element={redirect(Urls.monitorJobs())} />
+ <Route
+ path="/admin/tools/jobs/*"
+ element={redirect(`${Urls.monitorJobs()}/*`)}
+ />
+ <Route path="/admin/tools/logs" element={redirect(Urls.monitorLogs())} />
+ <Route
+ path="/admin/tools/logs/*"
+ element={redirect(`${Urls.monitorLogs()}/*`)}
+ />
+ <Route
+ path="/admin/tools/errors"
+ element={redirect(Urls.monitorErroringQuestions())}
+ />
+ <Route
+ path="/admin/tools/model-caching"
+ element={redirect(Urls.monitorModelCaching())}
+ />
+ <Route
+ path="/admin/tools/model-caching/*"
+ element={redirect(`${Urls.monitorModelCaching()}/*`)}
+ />
+ <Route
+ path="/admin/tools/notifications"
+ element={redirect(Urls.monitorNotifications())}
+ />
+ <Route
+ path="/admin/tools/notifications/*"
+ element={redirect(`${Urls.monitorNotifications()}/*`)}
+ />
+ <Route path="/admin/tools" element={redirect(Urls.monitor())} />
+ </>
+ );
+}
diff --git a/frontend/src/metabase/monitor/routes.unit.spec.tsx b/frontend/src/metabase/monitor/routes.unit.spec.tsx
new file mode 100644
index 00000000000..1afa7c67c42
--- /dev/null
+++ b/frontend/src/metabase/monitor/routes.unit.spec.tsx
@@ -0,0 +1,362 @@
+import type { ReactNode } from "react";
+
+import { setupEnterpriseOnlyPlugin } from "__support__/enterprise";
+import { renderWithProviders, screen } from "__support__/ui";
+import { reinitialize } from "metabase/plugins";
+import { createMockState } from "metabase/redux/store/mocks";
+import { Outlet, Route } from "metabase/router";
+import { createMockUser } from "metabase-types/api/mocks";
+
+import { getMonitorRedirects, getMonitorRoutes } from "./routes";
+
+jest.mock("metabase-enterprise/settings", () => ({
+ hasPremiumFeature: jest.fn().mockReturnValue(true),
+}));
+
+jest.mock("./components/MonitorLayout", () => {
+ const { Outlet } = jest.requireActual("metabase/router");
+ return { MonitorLayout: () => <Outlet /> };
+});
+jest.mock(
+ "metabase/monitor/dependency-diagnostics/DependencyDiagnosticsSectionLayout",
+ () => {
+ const { Outlet } = jest.requireActual("metabase/router");
+ return {
+ DependencyDiagnosticsSectionLayout: () => (
+ <div data-testid="diagnostics-section">
+ <Outlet />
+ </div>
+ ),
+ };
+ },
+);
+
+jest.mock("metabase-enterprise/monitor/dependency-diagnostics/pages", () => ({
+ BrokenDependencyDiagnosticsPage: () => <div>{"Broken page"}</div>,
+ UnreferencedDependencyDiagnosticsPage: () => <div>{"Unreferenced page"}</div>,
+}));
+
+jest.mock("metabase/monitor/tools/components/Logs", () => {
+ const { Outlet } = jest.requireActual("metabase/router");
+ return {
+ Logs: () => (
+ <div data-testid="logs-page">
+ {"Logs"}
+ <Outlet />
+ </div>
+ ),
+ };
+});
+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>
+ ),
+ ModelCacheRefreshJobModal: () => null,
+}));
+jest.mock("metabase/monitor/tools/components/LogLevelsModal", () => ({
+ LogLevelsModal: () => null,
+}));
+jest.mock("metabase/monitor/tools/components/MonitorUpsell", () => ({
+ MonitorUpsell: () => (
+ <div data-testid="errors-upsell">{"Erroring questions"}</div>
+ ),
+}));
+
+jest.mock("metabase/monitor/tools/components/TaskListPage", () => ({
+ TaskListPage: () => <div data-testid="task-list-page">{"Task list"}</div>,
+}));
+jest.mock("metabase/monitor/tools/components/TaskDetailsPage", () => ({
+ TaskDetailsPage: () => (
+ <div data-testid="task-details-page">{"Task details"}</div>
+ ),
+}));
+jest.mock("metabase/monitor/tools/components/TaskRunsPage", () => ({
+ TaskRunsPage: () => <div data-testid="task-runs-page">{"Task runs"}</div>,
+}));
+jest.mock("metabase/monitor/tools/components/TaskRunDetailsPage", () => ({
+ TaskRunDetailsPage: () => (
+ <div data-testid="task-run-details-page">{"Task run details"}</div>
+ ),
+}));
+jest.mock(
+ "metabase/monitor/tools/notifications/NotificationsAdminPage",
+ () => ({
+ NotificationsAdminPage: () => (
+ <div data-testid="notifications-page">{"Notifications"}</div>
+ ),
+ }),
+);
+
+const CanAccessMonitor = () => <Outlet />;
+const CanAccessMonitorDiagnostics = () => <Outlet />;
+const CanAccessMonitoringTools = () => <Outlet />;
+const CanAccessAlertsManagement = () => <Outlet />;
+
+const UPSELL_TITLE =
+ "Find and fix broken dependencies without hunting them down";
+
+type SetupOpts = {
+ initialRoute: string;
+ user?: ReturnType<typeof createMockUser>;
+};
+
+const setup = ({
+ initialRoute,
+ user = createMockUser({ is_superuser: true }),
+}: SetupOpts) => {
+ return renderWithProviders(
+ <Route path="/">
+ {getMonitorRedirects()}
+ {getMonitorRoutes(
+ CanAccessMonitor,
+ CanAccessMonitorDiagnostics,
+ CanAccessMonitoringTools,
+ CanAccessAlertsManagement,
+ )}
+ </Route>,
+ {
+ withRouter: true,
+ initialRoute,
+ storeInitialState: createMockState({ currentUser: user }),
+ },
+ );
+};
+
+const DenyingGuard = () => (
+ <div data-testid="unauthorized-marker">{"Unauthorized"}</div>
+);
+
+const setupWithGuards = ({
+ initialRoute,
+ CanAccessMonitorDiagnostics: Diagnostics = CanAccessMonitorDiagnostics,
+ CanAccessMonitoringTools: Tools = CanAccessMonitoringTools,
+ CanAccessAlertsManagement: AlertsManagement = CanAccessAlertsManagement,
+}: {
+ initialRoute: string;
+ CanAccessMonitorDiagnostics?: () => ReactNode;
+ CanAccessMonitoringTools?: () => ReactNode;
+ CanAccessAlertsManagement?: () => ReactNode;
+}) => {
+ return renderWithProviders(
+ <Route path="/">
+ {getMonitorRedirects()}
+ {getMonitorRoutes(CanAccessMonitor, Diagnostics, Tools, AlertsManagement)}
+ </Route>,
+ {
+ withRouter: true,
+ initialRoute,
+ storeInitialState: createMockState({
+ currentUser: createMockUser({ is_superuser: true }),
+ }),
+ },
+ );
+};
+
+describe("monitor routes", () => {
+ afterEach(() => {
+ reinitialize();
+ });
+
+ describe("getMonitorRoutes", () => {
+ describe("OSS (Dependency Diagnostics disabled)", () => {
+ it("renders the upsell at /monitor/dependency-diagnostics", async () => {
+ setup({ initialRoute: "/monitor/dependency-diagnostics" });
+
+ expect(await screen.findByText(UPSELL_TITLE)).toBeInTheDocument();
+ expect(
+ screen.queryByTestId("diagnostics-section"),
+ ).not.toBeInTheDocument();
+ });
+
+ it("renders the upsell for child paths (e.g. /broken)", async () => {
+ setup({ initialRoute: "/monitor/dependency-diagnostics/broken" });
+
+ expect(await screen.findByText(UPSELL_TITLE)).toBeInTheDocument();
+ expect(screen.queryByText("Broken page")).not.toBeInTheDocument();
+ });
+ });
+
+ describe("EE (Dependency Diagnostics enabled)", () => {
+ it("renders the diagnostics section and child routes instead of the upsell", async () => {
+ setupEnterpriseOnlyPlugin("monitor_dependency_diagnostics");
+
+ setup({ initialRoute: "/monitor/dependency-diagnostics/broken" });
+
+ expect(
+ await screen.findByTestId("diagnostics-section"),
+ ).toBeInTheDocument();
+ expect(screen.getByText("Broken page")).toBeInTheDocument();
+ expect(screen.queryByText(UPSELL_TITLE)).not.toBeInTheDocument();
+ });
+
+ it("redirects the diagnostics index to the broken route", async () => {
+ setupEnterpriseOnlyPlugin("monitor_dependency_diagnostics");
+
+ setup({ initialRoute: "/monitor/dependency-diagnostics" });
+
+ expect(await screen.findByText("Broken page")).toBeInTheDocument();
+ });
+ });
+
+ describe("index redirect (/monitor)", () => {
+ it("sends analysts to the diagnostics section", async () => {
+ setup({
+ initialRoute: "/monitor",
+ user: createMockUser({
+ is_superuser: false,
+ is_data_analyst: true,
+ }),
+ });
+
+ expect(await screen.findByText(UPSELL_TITLE)).toBeInTheDocument();
+ });
+
+ it("sends monitoring-only users to the Tools pages", async () => {
+ setup({
+ initialRoute: "/monitor",
+ user: createMockUser({
+ is_superuser: false,
+ is_data_analyst: false,
+ permissions: { can_access_monitoring: true },
+ }),
+ });
+
+ expect(await screen.findByTestId("task-list-page")).toBeInTheDocument();
+ });
+ });
+
+ describe("unknown routes", () => {
+ it("renders the NotFound page inside the Monitor layout", async () => {
+ setup({ initialRoute: "/monitor/does-not-exist" });
+
+ expect(await screen.findByLabelText("error page")).toBeInTheDocument();
+ });
+
+ it("blocks section routes when the section guard denies", async () => {
+ setupWithGuards({
+ initialRoute: "/monitor/logs",
+ CanAccessMonitoringTools: DenyingGuard,
+ });
+
+ expect(
+ await screen.findByTestId("unauthorized-marker"),
+ ).toBeInTheDocument();
+ expect(screen.queryByTestId("logs-page")).not.toBeInTheDocument();
+ });
+
+ it("blocks the notifications route when its own guard denies, independent of the Tools guard", async () => {
+ setupWithGuards({
+ initialRoute: "/monitor/notifications",
+ CanAccessAlertsManagement: DenyingGuard,
+ });
+
+ expect(
+ await screen.findByTestId("unauthorized-marker"),
+ ).toBeInTheDocument();
+ expect(
+ screen.queryByTestId("notifications-page"),
+ ).not.toBeInTheDocument();
+ });
+
+ it("renders NotFound for unknown paths even when both section guards deny (catch-all sits outside the guards)", async () => {
+ setupWithGuards({
+ initialRoute: "/monitor/does-not-exist",
+ CanAccessMonitorDiagnostics: DenyingGuard,
+ CanAccessMonitoringTools: DenyingGuard,
+ });
+
+ expect(await screen.findByLabelText("error page")).toBeInTheDocument();
+ expect(
+ screen.queryByTestId("unauthorized-marker"),
+ ).not.toBeInTheDocument();
+ });
+ });
+ });
+
+ describe("Tools sections (migrated from /admin/tools)", () => {
+ it("renders the Logs section at /monitor/logs", async () => {
+ setup({ initialRoute: "/monitor/logs" });
+
+ expect(await screen.findByTestId("logs-page")).toBeInTheDocument();
+ });
+
+ it("renders the Jobs section at /monitor/jobs", async () => {
+ setup({ initialRoute: "/monitor/jobs" });
+
+ expect(await screen.findByTestId("jobs-page")).toBeInTheDocument();
+ });
+
+ it("renders the Model caching log section at /monitor/model-caching", async () => {
+ setup({ initialRoute: "/monitor/model-caching" });
+
+ expect(
+ await screen.findByTestId("model-caching-page"),
+ ).toBeInTheDocument();
+ });
+
+ it("renders the Erroring questions upsell at /monitor/errors without the audit_app feature", async () => {
+ setup({ initialRoute: "/monitor/errors" });
+
+ expect(await screen.findByTestId("errors-upsell")).toBeInTheDocument();
+ });
+ });
+
+ describe("Tasks section route branches", () => {
+ it.each([
+ ["/monitor/tasks", "task-list-page"],
+ ["/monitor/tasks/list", "task-list-page"],
+ ["/monitor/tasks/list/42", "task-details-page"],
+ ["/monitor/tasks/runs", "task-runs-page"],
+ ["/monitor/tasks/runs/7", "task-run-details-page"],
+ ])("mounts %s", async (route, testId) => {
+ setup({ initialRoute: route });
+
+ expect(await screen.findByTestId(testId)).toBeInTheDocument();
+ });
+ });
+
+ describe("Notifications section route branches", () => {
+ it.each([["/monitor/notifications"], ["/monitor/notifications/13"]])(
+ "mounts %s",
+ async (route) => {
+ setup({ initialRoute: route });
+
+ expect(
+ await screen.findByTestId("notifications-page"),
+ ).toBeInTheDocument();
+ },
+ );
+ });
+
+ describe("getMonitorRedirects (legacy Admin Tools URLs)", () => {
+ it.each([
+ ["/admin/tools/tasks", "task-list-page"],
+ ["/admin/tools/tasks/list", "task-list-page"],
+ ["/admin/tools/tasks/list/42", "task-details-page"],
+ ["/admin/tools/tasks/runs", "task-runs-page"],
+ ["/admin/tools/tasks/runs/7", "task-run-details-page"],
+ ["/admin/tools/jobs", "jobs-page"],
+ ["/admin/tools/jobs/sync", "jobs-page"],
+ ["/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/notifications", "notifications-page"],
+ ["/admin/tools/notifications/13", "notifications-page"],
+ ])("redirects %s into the Monitor space", async (route, testId) => {
+ setup({ initialRoute: route });
+
+ expect(await screen.findByTestId(testId)).toBeInTheDocument();
+ });
+
+ it("redirects the legacy /admin/tools index into the Monitor space", async () => {
+ setup({ initialRoute: "/admin/tools" });
+
+ expect(await screen.findByText(UPSELL_TITLE)).toBeInTheDocument();
+ });
+ });
+});
diff --git a/frontend/src/metabase/monitor/tools/components/JobInfoApp.tsx b/frontend/src/metabase/monitor/tools/components/JobInfoApp.tsx
deleted file mode 100644
index cc8b0b5f545..00000000000
--- a/frontend/src/metabase/monitor/tools/components/JobInfoApp.tsx
+++ /dev/null
@@ -1,98 +0,0 @@
-import cx from "classnames";
-import { t } from "ttag";
-
-import {
- SettingsPageWrapper,
- SettingsSection,
-} from "metabase/admin/components/SettingsSection";
-import { useGetTasksInfoQuery } from "metabase/api";
-import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import AdminS from "metabase/css/admin.module.css";
-import CS from "metabase/css/core/index.css";
-import { useDispatch } from "metabase/redux";
-import { Outlet, push } from "metabase/router";
-import { Ellipsified, Flex, Stack } from "metabase/ui";
-import type { Job } from "metabase-types/api";
-
-interface SchedulerInfoProps {
- scheduler?: string[];
-}
-
-const SchedulerInfo = ({ scheduler }: SchedulerInfoProps) => {
- return (
- scheduler && (
- <Flex align="center">
- <pre>{scheduler.join("\n")}</pre>
- </Flex>
- )
- );
-};
-
-interface JobsTableProps {
- jobs?: Job[];
-}
-
-const JobsTable = ({ jobs }: JobsTableProps) => {
- const dispatch = useDispatch();
-
- const onClickJob = (job: Job) => {
- dispatch(push(`/admin/tools/jobs/${job.key}`));
- };
-
- return (
- jobs && (
- <table className={cx(AdminS.ContentTable, CS.mt2)}>
- <thead>
- <tr>
- <th>{t`Key`}</th>
- <th>{t`Class`}</th>
- <th>{t`Description`}</th>
- </tr>
- </thead>
- <tbody>
- {jobs &&
- jobs.map((job) => (
- <tr
- key={job.key}
- className={CS.cursorPointer}
- onClick={() => onClickJob(job)}
- >
- <td className={CS.textBold} style={{ maxWidth: 250 }}>
- <Ellipsified>{job.key}</Ellipsified>
- </td>
- <td style={{ maxWidth: 250 }}>
- <Ellipsified>{job.class}</Ellipsified>
- </td>
- <td style={{ maxWidth: 250 }}>
- <Ellipsified>{job.description}</Ellipsified>
- </td>
- </tr>
- ))}
- </tbody>
- </table>
- )
- );
-};
-
-export const JobInfoApp = () => {
- const { data, error, isFetching } = useGetTasksInfoQuery();
-
- return (
- <SettingsPageWrapper title={t`Scheduler Info`}>
- <LoadingAndErrorWrapper loading={isFetching} error={error}>
- <Stack gap="xl">
- <SettingsSection>
- <SchedulerInfo scheduler={data?.scheduler} />
- </SettingsSection>
- <SettingsSection>
- <JobsTable jobs={data?.jobs} />
- </SettingsSection>
- {
- // render the outlet so that the individual task modals show up
- <Outlet />
- }
- </Stack>
- </LoadingAndErrorWrapper>
- </SettingsPageWrapper>
- );
-};
diff --git a/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobInfoApp.tsx b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobInfoApp.tsx
new file mode 100644
index 00000000000..53f727cccbe
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobInfoApp.tsx
@@ -0,0 +1,50 @@
+import { useElementSize } from "@mantine/hooks";
+import { t } from "ttag";
+
+import { useGetTasksInfoQuery } from "metabase/api";
+import { DelayedLoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper/DelayedLoadingAndErrorWrapper";
+import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
+import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
+import { Sidebar } from "metabase/monitor/components/MonitorLayout/Sidebar";
+import type { WithRouterProps } from "metabase/router";
+import { Center, Code, Flex } from "metabase/ui";
+
+import { JobTriggersSidebar } from "./JobTriggersSidebar";
+import { JobsTable } from "./JobsTable";
+
+type RouteParams = {
+ jobKey?: string;
+};
+
+export const JobInfoApp = ({ params }: WithRouterProps<RouteParams>) => {
+ const { data, error, isLoading, isFetching } = useGetTasksInfoQuery();
+ const { ref: containerRef, width: containerWidth } = useElementSize();
+ const { jobKey } = params;
+
+ return (
+ <Flex ref={containerRef} h="100%" wrap="nowrap">
+ <MonitorMain>
+ <MonitorHeaderTitle mb="sm">{t`Scheduled jobs`}</MonitorHeaderTitle>
+ {error != null ? (
+ <Center flex={1}>
+ <DelayedLoadingAndErrorWrapper loading={isFetching} error={error} />
+ </Center>
+ ) : (
+ <>
+ {data != null && data.scheduler.length > 0 && (
+ <Code block p="xl" style={{ flexShrink: 0 }}>
+ {data.scheduler.join("\n")}
+ </Code>
+ )}
+ <JobsTable jobs={data?.jobs ?? []} isLoading={isLoading} />
+ </>
+ )}
+ </MonitorMain>
+ {jobKey != null && data != null && (
+ <Sidebar containerWidth={containerWidth}>
+ <JobTriggersSidebar jobKey={jobKey} />
+ </Sidebar>
+ )}
+ </Flex>
+ );
+};
diff --git a/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobInfoApp.unit.spec.tsx b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobInfoApp.unit.spec.tsx
new file mode 100644
index 00000000000..37e4f243223
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobInfoApp.unit.spec.tsx
@@ -0,0 +1,255 @@
+import userEvent from "@testing-library/user-event";
+import fetchMock from "fetch-mock";
+
+import { setupTasksInfoEndpoint } from "__support__/server-mocks";
+import {
+ mockGetBoundingClientRect,
+ renderWithProviders,
+ screen,
+ within,
+} from "__support__/ui";
+import { MonitorContent } from "metabase/monitor/components/MonitorLayout/MonitorContent";
+import { Route, withRouteProps } from "metabase/router";
+import * as Urls from "metabase/urls";
+import type { TaskInfo } from "metabase-types/api";
+import {
+ createMockJob,
+ createMockTaskInfo,
+ createMockTrigger,
+ createMockUser,
+} from "metabase-types/api/mocks";
+
+import { JobInfoApp } from "./JobInfoApp";
+
+const RoutedJobInfoApp = withRouteProps(JobInfoApp);
+
+const PATHNAME = Urls.monitorJobs();
+
+interface SetupOpts {
+ error?: boolean;
+ taskInfo?: TaskInfo;
+ initialRoute?: string;
+}
+
+const setup = ({
+ error,
+ taskInfo = createMockTaskInfo(),
+ initialRoute = PATHNAME,
+}: SetupOpts = {}) => {
+ if (error) {
+ fetchMock.get("path:/api/task/info", { status: 500 });
+ } else {
+ setupTasksInfoEndpoint(taskInfo);
+ }
+
+ mockGetBoundingClientRect({ width: 100, height: 100 });
+
+ return renderWithProviders(
+ <Route
+ path={PATHNAME}
+ element={
+ <MonitorContent>
+ <RoutedJobInfoApp />
+ </MonitorContent>
+ }
+ >
+ <Route path=":jobKey" />
+ </Route>,
+ {
+ initialRoute,
+ withRouter: true,
+ storeInitialState: {
+ currentUser: createMockUser(),
+ },
+ },
+ );
+};
+
+describe("JobInfoApp", () => {
+ it("should show the scheduler info and the jobs table", async () => {
+ setup({
+ taskInfo: createMockTaskInfo({
+ scheduler: ["Scheduler line 1", "Scheduler line 2"],
+ jobs: [createMockJob({ key: "a-job-key" })],
+ }),
+ });
+
+ expect(await screen.findByText(/Scheduler line 1/)).toBeInTheDocument();
+ expect(screen.getByText(/Scheduler line 2/)).toBeInTheDocument();
+ expect(screen.getByRole("treegrid", { name: "Jobs" })).toBeInTheDocument();
+ expect(screen.getByText("a-job-key")).toBeInTheDocument();
+ expect(screen.getByText("org.quartz.jobs.AJobClass")).toBeInTheDocument();
+ expect(screen.getByText("A job description")).toBeInTheDocument();
+ });
+
+ it("should show an empty state when there are no jobs", async () => {
+ setup({ taskInfo: createMockTaskInfo({ jobs: [] }) });
+
+ expect(await screen.findByText("No results")).toBeInTheDocument();
+ });
+
+ it("should show an error state", async () => {
+ setup({ error: true });
+
+ expect(await screen.findByText("An error occurred")).toBeInTheDocument();
+ expect(screen.queryByText("No results")).not.toBeInTheDocument();
+ });
+
+ it("should open the triggers sidebar in the Monitor outlet when a row is clicked", async () => {
+ const { history } = setup({
+ taskInfo: createMockTaskInfo({
+ jobs: [
+ createMockJob({
+ key: "a-job-key",
+ triggers: [
+ createMockTrigger({ key: "trigger-1", state: "WAITING" }),
+ createMockTrigger({ key: "trigger-2", state: "PAUSED" }),
+ ],
+ }),
+ ],
+ }),
+ });
+
+ const row = await screen.findByTestId("job");
+ await userEvent.click(row);
+
+ expect(history?.getCurrentLocation().pathname).toBe(
+ Urls.monitorJobTriggers("a-job-key"),
+ );
+
+ const sidebar = await screen.findByTestId("job-triggers-sidebar");
+ expect(screen.getByTestId("monitor-sidebar-region")).toContainElement(
+ sidebar,
+ );
+ expect(
+ within(sidebar).getByText("Triggers for a-job-key"),
+ ).toBeInTheDocument();
+ expect(within(sidebar).getByText("trigger-1")).toBeInTheDocument();
+ expect(within(sidebar).getByText("WAITING")).toBeInTheDocument();
+ expect(within(sidebar).getByText("trigger-2")).toBeInTheDocument();
+ expect(within(sidebar).getByText("PAUSED")).toBeInTheDocument();
+ });
+
+ it("should open the triggers sidebar via keyboard row activation", async () => {
+ const { history } = setup({
+ taskInfo: createMockTaskInfo({
+ jobs: [
+ createMockJob({
+ key: "a-job-key",
+ triggers: [createMockTrigger({ key: "trigger-1" })],
+ }),
+ ],
+ }),
+ });
+
+ const table = await screen.findByRole("treegrid", { name: "Jobs" });
+ table.focus();
+ // ArrowDown activates the first row, Enter opens its triggers
+ await userEvent.keyboard("{ArrowDown}{Enter}");
+
+ expect(history?.getCurrentLocation().pathname).toBe(
+ Urls.monitorJobTriggers("a-job-key"),
+ );
+
+ const sidebar = await screen.findByTestId("job-triggers-sidebar");
+ expect(within(sidebar).getByText("trigger-1")).toBeInTheDocument();
+ });
+
+ it("should render every trigger attribute, null placeholders, and the may-fire-again No branch", async () => {
+ setup({
+ taskInfo: createMockTaskInfo({
+ jobs: [
+ createMockJob({
+ key: "a-job-key",
+ triggers: [
+ createMockTrigger({
+ key: "trigger-1",
+ "end-time": null,
+ "final-fire-time": null,
+ "may-fire-again?": false,
+ }),
+ ],
+ }),
+ ],
+ }),
+ initialRoute: Urls.monitorJobTriggers("a-job-key"),
+ });
+
+ const sidebar = await screen.findByTestId("job-triggers-sidebar");
+
+ // all 11 labelled attribute rows are present
+ [
+ "Key",
+ "Description",
+ "State",
+ "Priority",
+ "Last Fired",
+ "Next Fire Time",
+ "Start Time",
+ "End Time",
+ "Final Fire Time",
+ "May Fire Again?",
+ "Misfire Instruction",
+ ].forEach((label) => {
+ expect(within(sidebar).getByText(label)).toBeInTheDocument();
+ });
+
+ // may-fire-again? false renders as "No"
+ expect(within(sidebar).getByText("No")).toBeInTheDocument();
+ // null End Time / Final Fire Time render the empty-cell placeholder
+ expect(within(sidebar).getAllByText("—")).toHaveLength(2);
+ });
+
+ it("should show a no-triggers message when the job has no triggers", async () => {
+ setup({
+ taskInfo: createMockTaskInfo({
+ jobs: [createMockJob({ key: "a-job-key", triggers: [] })],
+ }),
+ initialRoute: Urls.monitorJobTriggers("a-job-key"),
+ });
+
+ const sidebar = await screen.findByTestId("job-triggers-sidebar");
+ expect(within(sidebar).getByText("No triggers")).toBeInTheDocument();
+ });
+
+ it("should close the triggers sidebar", async () => {
+ const { history } = setup({
+ taskInfo: createMockTaskInfo({
+ jobs: [
+ createMockJob({
+ key: "a-job-key",
+ triggers: [createMockTrigger()],
+ }),
+ ],
+ }),
+ initialRoute: Urls.monitorJobTriggers("a-job-key"),
+ });
+
+ const sidebar = await screen.findByTestId("job-triggers-sidebar");
+ await userEvent.click(
+ within(sidebar).getByRole("button", { name: "Close" }),
+ );
+
+ expect(history?.getCurrentLocation().pathname).toBe(Urls.monitorJobs());
+ expect(
+ screen.queryByTestId("job-triggers-sidebar"),
+ ).not.toBeInTheDocument();
+ });
+
+ it("should show the triggers sidebar when opened via a direct link", async () => {
+ setup({
+ taskInfo: createMockTaskInfo({
+ jobs: [
+ createMockJob({
+ key: "a-job-key",
+ triggers: [createMockTrigger({ key: "trigger-1" })],
+ }),
+ ],
+ }),
+ initialRoute: Urls.monitorJobTriggers("a-job-key"),
+ });
+
+ const sidebar = await screen.findByTestId("job-triggers-sidebar");
+ expect(within(sidebar).getByText("trigger-1")).toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobTriggersSidebar.module.css b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobTriggersSidebar.module.css
new file mode 100644
index 00000000000..77c6b127301
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobTriggersSidebar.module.css
@@ -0,0 +1,5 @@
+.sidebar {
+ flex: 1 1 auto;
+ overflow: auto;
+ border-left: 1px solid var(--mb-color-border-neutral);
+}
diff --git a/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobTriggersSidebar.tsx b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobTriggersSidebar.tsx
new file mode 100644
index 00000000000..d2298d7fbe3
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobTriggersSidebar.tsx
@@ -0,0 +1,111 @@
+import { Fragment } from "react";
+import { t } from "ttag";
+
+import { useGetTasksInfoQuery } from "metabase/api";
+import { useDispatch } from "metabase/redux";
+import { push } from "metabase/router";
+import { ActionIcon, Divider, Flex, Icon, Stack, Text } from "metabase/ui";
+import * as Urls from "metabase/urls";
+import { EMPTY_CELL_PLACEHOLDER } from "metabase/utils/constants";
+import type { Trigger } from "metabase-types/api";
+
+import S from "./JobTriggersSidebar.module.css";
+
+type JobTriggersSidebarProps = {
+ jobKey: string;
+};
+
+export const JobTriggersSidebar = ({ jobKey }: JobTriggersSidebarProps) => {
+ const { data } = useGetTasksInfoQuery();
+ const dispatch = useDispatch();
+
+ const job = data?.jobs.find((job) => job.key === jobKey);
+ const triggers = job?.triggers ?? [];
+
+ const handleClose = () => {
+ dispatch(push(Urls.monitorJobs()));
+ };
+
+ return (
+ <Stack
+ className={S.sidebar}
+ p="lg"
+ gap="lg"
+ bg="background_page-primary"
+ data-testid="job-triggers-sidebar"
+ >
+ <Flex align="flex-start" justify="space-between" gap="md" wrap="nowrap">
+ <Text fw="bold" style={{ wordBreak: "break-all" }}>
+ {t`Triggers for ${jobKey}`}
+ </Text>
+ <ActionIcon aria-label={t`Close`} onClick={handleClose}>
+ <Icon name="close" />
+ </ActionIcon>
+ </Flex>
+
+ {job == null && <Text c="text-secondary">{t`Job not found`}</Text>}
+
+ {job != null && triggers.length === 0 && (
+ <Text c="text-secondary">{t`No triggers`}</Text>
+ )}
+
+ {triggers.map((trigger, index) => (
+ <Fragment key={trigger.key}>
+ {index > 0 && <Divider />}
+ <TriggerDetails trigger={trigger} />
+ </Fragment>
+ ))}
+ </Stack>
+ );
+};
+
+function TriggerDetails({ trigger }: { trigger: Trigger }) {
+ return (
+ <Stack component="dl" gap="sm" m={0}>
+ <TriggerAttribute label={t`Key`} value={trigger.key} />
+ <TriggerAttribute label={t`Description`} value={trigger.description} />
+ <TriggerAttribute label={t`State`} value={trigger.state} />
+ <TriggerAttribute label={t`Priority`} value={trigger.priority} />
+ <TriggerAttribute
+ label={t`Last Fired`}
+ value={trigger["previous-fire-time"]}
+ />
+ <TriggerAttribute
+ label={t`Next Fire Time`}
+ value={trigger["next-fire-time"]}
+ />
+ <TriggerAttribute label={t`Start Time`} value={trigger["start-time"]} />
+ <TriggerAttribute label={t`End Time`} value={trigger["end-time"]} />
+ <TriggerAttribute
+ label={t`Final Fire Time`}
+ value={trigger["final-fire-time"]}
+ />
+ <TriggerAttribute
+ label={t`May Fire Again?`}
+ value={trigger["may-fire-again?"] ? t`Yes` : t`No`}
+ />
+ <TriggerAttribute
+ label={t`Misfire Instruction`}
+ value={trigger["misfire-instruction"]}
+ />
+ </Stack>
+ );
+}
+
+type TriggerAttributeProps = {
+ label: string;
+ value: string | number | null;
+};
+
+function TriggerAttribute({ label, value }: TriggerAttributeProps) {
+ return (
+ <Flex gap="md">
+ <Text component="dt" fw="bold" w="8rem" flex="0 0 auto">
+ {label}
+ </Text>
+ <Text component="dd" m={0} style={{ wordBreak: "break-word" }}>
+ {value ?? EMPTY_CELL_PLACEHOLDER}
+ </Text>
+ </Flex>
+ );
+}
diff --git a/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobsTable.tsx b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobsTable.tsx
new file mode 100644
index 00000000000..b4e97a9f45b
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/JobInfoApp/JobsTable.tsx
@@ -0,0 +1,105 @@
+import type { Row } from "@tanstack/react-table";
+import { useCallback, useMemo } from "react";
+import { t } from "ttag";
+
+import { MonitorEmptyState } from "metabase/monitor/components/MonitorEmptyState";
+import { useDispatch } from "metabase/redux";
+import { push } from "metabase/router";
+import {
+ Card,
+ Ellipsified,
+ TreeTable,
+ type TreeTableColumnDef,
+ TreeTableSkeleton,
+ useTreeTableInstance,
+} from "metabase/ui";
+import * as Urls from "metabase/urls";
+import type { Job } from "metabase-types/api";
+
+const COLUMN_WIDTHS = [0.34, 0.33, 0.33];
+
+type JobRow = Job & { id: string };
+
+type JobsTableProps = {
+ isLoading: boolean;
+ jobs: Job[];
+};
+
+export const JobsTable = ({ isLoading, jobs }: JobsTableProps) => {
+ const dispatch = useDispatch();
+
+ const rows: JobRow[] = useMemo(
+ () => jobs.map((job) => ({ ...job, id: job.key })),
+ [jobs],
+ );
+ const columns = useMemo(() => getColumns(), []);
+
+ const handleRowActivate = useCallback(
+ (row: Row<JobRow>) => {
+ dispatch(push(Urls.monitorJobTriggers(row.original.key)));
+ },
+ [dispatch],
+ );
+
+ const treeTableInstance = useTreeTableInstance<JobRow>({
+ data: rows,
+ columns,
+ getNodeId: (job) => job.id,
+ onRowActivate: handleRowActivate,
+ });
+
+ return (
+ <Card flex="0 1 auto" mih={0} p={0} withBorder data-testid="jobs-table">
+ {isLoading ? (
+ <TreeTableSkeleton columnWidths={COLUMN_WIDTHS} />
+ ) : (
+ <TreeTable
+ instance={treeTableInstance}
+ hierarchical={false}
+ ariaLabel={t`Jobs`}
+ emptyState={<MonitorEmptyState label={t`No results`} />}
+ getRowProps={() => ({ "data-testid": "job" })}
+ onRowClick={handleRowActivate}
+ />
+ )}
+ </Card>
+ );
+};
+
+function getColumns(): TreeTableColumnDef<JobRow>[] {
+ return [
+ {
+ id: "key",
+ header: t`Key`,
+ width: "auto",
+ minWidth: 200,
+ maxAutoWidth: 300,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (job) => job.key,
+ cell: ({ row }) => <Ellipsified>{row.original.key}</Ellipsified>,
+ },
+ {
+ id: "class",
+ header: t`Class`,
+ width: "auto",
+ minWidth: 200,
+ maxAutoWidth: 350,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (job) => job.class,
+ cell: ({ row }) => <Ellipsified>{row.original.class}</Ellipsified>,
+ },
+ {
+ id: "description",
+ header: t`Description`,
+ width: "auto",
+ minWidth: 200,
+ maxAutoWidth: 350,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (job) => job.description,
+ cell: ({ row }) => <Ellipsified>{row.original.description}</Ellipsified>,
+ },
+ ];
+}
diff --git a/frontend/src/metabase/monitor/tools/components/JobInfoApp/index.ts b/frontend/src/metabase/monitor/tools/components/JobInfoApp/index.ts
new file mode 100644
index 00000000000..9aa7ca8377c
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/JobInfoApp/index.ts
@@ -0,0 +1 @@
+export * from "./JobInfoApp";
diff --git a/frontend/src/metabase/monitor/tools/components/JobTriggersModal.tsx b/frontend/src/metabase/monitor/tools/components/JobTriggersModal.tsx
deleted file mode 100644
index 82819fde267..00000000000
--- a/frontend/src/metabase/monitor/tools/components/JobTriggersModal.tsx
+++ /dev/null
@@ -1,76 +0,0 @@
-import cx from "classnames";
-import { t } from "ttag";
-import _ from "underscore";
-
-import { useGetTasksInfoQuery } from "metabase/api";
-import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import { ModalContent } from "metabase/common/components/ModalContent";
-import AdminS from "metabase/css/admin.module.css";
-import CS from "metabase/css/core/index.css";
-import type { Trigger } from "metabase-types/api";
-
-const renderTriggersTable = (triggers?: Trigger[]) => {
- return (
- <table className={cx(AdminS.ContentTable, CS.mt2)}>
- <thead>
- <tr>
- <th>{t`Key`}</th>
- <th>{t`Description`}</th>
- <th>{t`State`}</th>
- <th>{t`Priority`}</th>
- <th>{t`Last Fired`}</th>
- <th>{t`Next Fire Time`}</th>
- <th>{t`Start Time`}</th>
- <th>{t`End Time`}</th>
- <th>{t`Final Fire Time`}</th>
- <th>{t`May Fire Again?`}</th>
- <th>{t`Misfire Instruction`}</th>
- </tr>
- </thead>
- <tbody>
- {triggers &&
- triggers.map((trigger) => (
- <tr key={trigger.key}>
- <td className={CS.textBold}>{trigger.key}</td>
- <td>{trigger.description}</td>
- <td>{trigger.state}</td>
- <td>{trigger.priority}</td>
- <td>{trigger["previous-fire-time"]}</td>
- <td>{trigger["next-fire-time"]}</td>
- <td>{trigger["start-time"]}</td>
- <td>{trigger["end-time"]}</td>
- <td>{trigger["final-fire-time"]}</td>
- <td>{trigger["may-fire-again?"] ? t`Yes` : t`No`}</td>
- <td>{trigger["misfire-instruction"]}</td>
- </tr>
- ))}
- </tbody>
- </table>
- );
-};
-
-interface JobTriggersModalProps {
- params: {
- jobKey?: string;
- };
- onClose: () => void;
-}
-
-export const JobTriggersModal = ({
- params,
- onClose,
-}: JobTriggersModalProps) => {
- const { data, error, isFetching } = useGetTasksInfoQuery();
-
- const { jobKey } = params;
- const jobs = data?.jobs;
- const job = jobKey && jobs ? _.findWhere(jobs, { key: jobKey }) : undefined;
-
- return (
- <ModalContent title={t`Triggers for ${jobKey}`} onClose={onClose}>
- <LoadingAndErrorWrapper loading={isFetching} error={error}>
- {() => renderTriggersTable(job?.triggers)}
- </LoadingAndErrorWrapper>
- </ModalContent>
- );
-};
diff --git a/frontend/src/metabase/monitor/tools/components/Logs/Logs.styled.tsx b/frontend/src/metabase/monitor/tools/components/Logs/Logs.styled.tsx
deleted file mode 100644
index 12464201f33..00000000000
--- a/frontend/src/metabase/monitor/tools/components/Logs/Logs.styled.tsx
+++ /dev/null
@@ -1,22 +0,0 @@
-// eslint-disable-next-line no-restricted-imports
-import styled from "@emotion/styled";
-
-import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-
-export const LogsContainer = styled(LoadingAndErrorWrapper)`
- height: 100%;
- display: flex;
- flex-direction: column;
-`;
-
-export const LogsContent = styled.div`
- border: 1px solid var(--mb-color-border-neutral);
- border-radius: 0.5rem;
- background-color: var(--mb-color-background_page-secondary);
- font-family: "Lucida Console", Monaco, monospace;
- font-size: 14px;
- white-space: pre;
- padding: 1em;
- overflow: auto;
- height: 100%;
-`;
diff --git a/frontend/src/metabase/monitor/tools/components/Logs/Logs.tsx b/frontend/src/metabase/monitor/tools/components/Logs/Logs.tsx
index 1fe8d34772b..ef8c1b598fe 100644
--- a/frontend/src/metabase/monitor/tools/components/Logs/Logs.tsx
+++ b/frontend/src/metabase/monitor/tools/components/Logs/Logs.tsx
@@ -1,33 +1,32 @@
-import * as React from "react";
import { useMemo } from "react";
-import reactAnsiStyle from "react-ansi-style";
import { t } from "ttag";
-import {
- SettingsPageWrapper,
- SettingsSection,
-} from "metabase/admin/components/SettingsSection";
-import { AnsiLogs } from "metabase/common/components/AnsiLogs";
+import { DelayedLoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper/DelayedLoadingAndErrorWrapper";
import { useUrlState } from "metabase/common/hooks/use-url-state";
+import {
+ LogsViewer,
+ createLogFormatter,
+ getAllProcessUUIDs,
+} from "metabase/monitor/components/LogsViewer";
+import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
+import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
import { Link, Outlet, useRouter } from "metabase/router";
import {
Button,
+ Center,
DefaultSelectItem,
+ FixedSizeIcon,
Flex,
+ Group,
Icon,
Select,
TextInput,
} from "metabase/ui";
+import * as Urls from "metabase/urls";
import { openSaveDialog } from "metabase/utils/dom";
-import { LogsContainer, LogsContent } from "./Logs.styled";
import { usePollingLogsQuery, useTailLogs } from "./hooks";
-import {
- createLogFormatter,
- filterLogs,
- getAllProcessUUIDs,
- urlStateConfig,
-} from "./utils";
+import { filterLogs, urlStateConfig } from "./utils";
interface LogsProps {
// NOTE: fetching logs could come back from any machine if there's multiple machines backing a MB instance
@@ -53,39 +52,33 @@ export const Logs = ({
[logs, process, query, processUUIDs],
);
const hasAnyLogs = logs.length > 0;
+ const hasFilteredLogs = filteredLogs.length > 0;
const { scrollRef, onScroll, refollow } = useTailLogs(filteredLogs);
- const formatter = useMemo(
- () => createLogFormatter(process, processUUIDs),
- [process, processUUIDs],
- );
- const logText = useMemo(
- () => filteredLogs.map(formatter).join("\n"),
- [filteredLogs, formatter],
- );
-
- const displayLogs = useMemo(() => {
- if (!logText) {
- return hasAnyLogs
- ? t`Nothing matches your filters.`
- : t`There's nothing here, yet.`;
- }
-
- return reactAnsiStyle(React, logText);
- }, [hasAnyLogs, logText]);
const handleDownload = () => {
- const blob = new Blob([logText], { type: "text/json" });
+ const formatLog = createLogFormatter(process, processUUIDs);
+ const logText = filteredLogs.flatMap(formatLog).join("\n");
+ const blob = new Blob([logText], { type: "text/plain" });
openSaveDialog("logs.txt", blob);
};
return (
<>
- <SettingsPageWrapper title={t`Logs`}>
- <SettingsSection>
- <LogsContainer loading={!loaded} error={error}>
- <Flex align="center" gap="md" justify="space-between" mb="md">
- <Flex align="center" gap="md">
+ <Flex h="100%" wrap="nowrap">
+ <MonitorMain>
+ <MonitorHeaderTitle mb="sm">{t`Application logs`}</MonitorHeaderTitle>
+
+ {!loaded || error != null ? (
+ <Center flex={1}>
+ <DelayedLoadingAndErrorWrapper loading={!loaded} error={error} />
+ </Center>
+ ) : (
+ <>
+ <Group gap="md" align="center" wrap="nowrap">
<TextInput
+ flex={1}
+ miw="8rem"
+ leftSection={<FixedSizeIcon name="search" />}
placeholder={t`Filter logs`}
rightSection={
query.length > 0 ? (
@@ -103,7 +96,6 @@ export const Logs = ({
) : undefined
}
value={query}
- w={220} // set width to prevent CLS when the "Clear" button appears/disappears
onChange={(event) => {
patchUrlState({ query: event.target.value });
refollow();
@@ -142,36 +134,39 @@ export const Logs = ({
}}
/>
)}
- </Flex>
- <Flex align="center" gap="md">
<Button
component={Link}
- to="/admin/tools/logs/levels"
+ to={Urls.monitorLogLevels()}
leftSection={<Icon name="pulse" />}
variant="default"
>{t`Customize log levels`}</Button>
<Button
- disabled={logText.length === 0}
+ disabled={!hasFilteredLogs}
leftSection={<Icon name="download" />}
variant="filled"
onClick={handleDownload}
>{t`Download`}</Button>
- </Flex>
- </Flex>
+ </Group>
- <AnsiLogs
- id="logs-content"
- ref={scrollRef}
- onScroll={onScroll}
- component={LogsContent}
- >
- {displayLogs}
- </AnsiLogs>
- </LogsContainer>
- </SettingsSection>
- </SettingsPageWrapper>
+ <LogsViewer
+ ref={scrollRef}
+ logs={filteredLogs}
+ processUUID={process}
+ processUUIDs={processUUIDs}
+ emptyMessage={
+ hasAnyLogs
+ ? t`Nothing matches your filters.`
+ : t`There's nothing here, yet.`
+ }
+ aria-label={t`Logs output`}
+ onScroll={onScroll}
+ />
+ </>
+ )}
+ </MonitorMain>
+ </Flex>
{
// render the outlet so that the modals show up
diff --git a/frontend/src/metabase/monitor/tools/components/Logs/Logs.unit.spec.tsx b/frontend/src/metabase/monitor/tools/components/Logs/Logs.unit.spec.tsx
index 9a1a13d08f8..0e3b482b140 100644
--- a/frontend/src/metabase/monitor/tools/components/Logs/Logs.unit.spec.tsx
+++ b/frontend/src/metabase/monitor/tools/components/Logs/Logs.unit.spec.tsx
@@ -1,3 +1,4 @@
+import userEvent from "@testing-library/user-event";
import fetchMock from "fetch-mock";
import { act, renderWithProviders, screen, waitFor } from "__support__/ui";
@@ -7,11 +8,20 @@ import {
} from "metabase/redux/store/mocks";
import type { Location } from "metabase/router";
import { Route } from "metabase/router";
+import { openSaveDialog } from "metabase/utils/dom";
import { DEFAULT_POLLING_DURATION_MS, Logs } from "./Logs";
import { maybeMergeLogs } from "./utils";
-const PATHNAME = "/admin/tools/logs";
+jest.mock("metabase/utils/dom", () => ({
+ ...jest.requireActual("metabase/utils/dom"),
+ openSaveDialog: jest.fn(),
+}));
+
+// jest.mock replaces the module factory; retype the import as its mock
+const mockOpenSaveDialog = openSaveDialog as jest.Mock;
+
+const PATHNAME = "/monitor/logs";
const log = {
timestamp: "2024-01-10T21:21:58.597Z",
@@ -142,9 +152,11 @@ describe("Logs", () => {
it("should display results if server responds with logs", async () => {
fetchMock.get("path:/api/logger/logs", [log]);
setup();
- await waitFor(() => {
- expect(screen.getByText(new RegExp(log.fqns))).toBeInTheDocument();
- });
+ expect(await screen.findByText(new RegExp(log.fqns))).toBeInTheDocument();
+ // The log message is wrapped in a green ANSI escape sequence
+ expect(screen.getByText(/GET \/api\/collection\/root/)).toHaveClass(
+ "react-ansi-style-green",
+ );
expect(screen.getByRole("button", { name: /Download/ })).toBeEnabled();
});
@@ -187,4 +199,56 @@ describe("Logs", () => {
expect(shouldBeMerged).not.toBe(originalLogs);
});
});
+
+ describe("download", () => {
+ const readBlobText = (blob: Blob): Promise<string> =>
+ new Promise((resolve, reject) => {
+ const reader = new FileReader();
+ reader.onload = () => resolve(String(reader.result));
+ reader.onerror = () => reject(reader.error);
+ reader.readAsText(blob);
+ });
+
+ const alpha = {
+ ...log,
+ process_uuid: "uuid-1",
+ fqns: "metabase.alpha",
+ msg: "alpha-message",
+ };
+ const beta = {
+ ...log,
+ process_uuid: "uuid-2",
+ fqns: "metabase.beta",
+ msg: "beta-message",
+ };
+
+ beforeEach(() => {
+ mockOpenSaveDialog.mockClear();
+ });
+
+ it("downloads only the currently filtered logs, prefixed by process UUID", async () => {
+ fetchMock.get("path:/api/logger/logs", [alpha, beta]);
+ setup({
+ location: createMockLocation({
+ pathname: PATHNAME,
+ search: "?query=alpha-message",
+ }),
+ });
+
+ const downloadButton = await screen.findByRole("button", {
+ name: /Download/,
+ });
+ await waitFor(() => expect(downloadButton).toBeEnabled());
+ await userEvent.click(downloadButton);
+
+ expect(mockOpenSaveDialog).toHaveBeenCalledTimes(1);
+ const [filename, blob] = mockOpenSaveDialog.mock.calls[0];
+ expect(filename).toBe("logs.txt");
+ // mock.calls args are untyped; the dialog is always called with a Blob
+ const text = await readBlobText(blob as Blob);
+ expect(text).toContain("[uuid-1]");
+ expect(text).toContain("alpha-message");
+ expect(text).not.toContain("beta-message");
+ });
+ });
});
diff --git a/frontend/src/metabase/monitor/tools/components/Logs/LogsViewer.tsx b/frontend/src/metabase/monitor/tools/components/Logs/LogsViewer.tsx
deleted file mode 100644
index f3bbc3c6a92..00000000000
--- a/frontend/src/metabase/monitor/tools/components/Logs/LogsViewer.tsx
+++ /dev/null
@@ -1,29 +0,0 @@
-import * as React from "react";
-import { useMemo } from "react";
-import reactAnsiStyle from "react-ansi-style";
-
-import { AnsiLogs } from "metabase/common/components/AnsiLogs";
-import type { Log } from "metabase-types/api";
-
-import { LogsContent } from "./Logs.styled";
-import { createLogFormatter, getAllProcessUUIDs } from "./utils";
-
-type LogsViewerProps = React.ComponentPropsWithoutRef<"div"> & {
- logs: Log[];
-};
-
-// TODO(egorgrushin): use it in frontend/src/metabase/monitor/tools/components/Logs/Logs.tsx
-export const LogsViewer = ({ logs, ...rest }: LogsViewerProps) => {
- const logText = useMemo(() => {
- const processUUIDs = getAllProcessUUIDs(logs);
- const formatLog = createLogFormatter("ALL", processUUIDs);
- return logs.map(formatLog).join("\n");
- }, [logs]);
- const displayLogs = useMemo(() => reactAnsiStyle(React, logText), [logText]);
-
- return (
- <AnsiLogs component={LogsContent} {...rest}>
- {displayLogs}
- </AnsiLogs>
- );
-};
diff --git a/frontend/src/metabase/monitor/tools/components/Logs/utils.ts b/frontend/src/metabase/monitor/tools/components/Logs/utils.ts
index dea114afd92..ac739482290 100644
--- a/frontend/src/metabase/monitor/tools/components/Logs/utils.ts
+++ b/frontend/src/metabase/monitor/tools/components/Logs/utils.ts
@@ -1,4 +1,3 @@
-import dayjs from "dayjs";
import orderBy from "lodash.orderby";
import _ from "underscore";
@@ -7,6 +6,7 @@ import {
type UrlStateConfig,
getFirstParamValue,
} from "metabase/common/hooks/use-url-state";
+import { createLogFormatter } from "metabase/monitor/components/LogsViewer/utils";
import type { Log } from "metabase-types/api";
const MAX_LOGS = 50000;
@@ -93,26 +93,3 @@ export function filterLogs(
return matchesProcessFilter && matchesQueryFilter;
});
}
-
-export function getAllProcessUUIDs(logs: Log[]) {
- const uuids = new Set<string>();
- logs.forEach((log) => uuids.add(log.process_uuid));
- return [...uuids].filter(Boolean).sort();
-}
-
-// date formatting is expensive for megabytes of logs
-const formatTs = (ts: string) => dayjs(ts).format();
-const memoedFormatTs = _.memoize(formatTs);
-
-export const createLogFormatter =
- (process: string, processUUIDs: string[]) => (log: Log) => {
- const timestamp = memoedFormatTs(log.timestamp);
- const uuid =
- process === "ALL" && processUUIDs.length > 1
- ? `[${log.process_uuid}]`
- : undefined;
- return [
- [uuid, timestamp, log.level, log.fqns, log.msg].filter(Boolean).join(" "),
- ...(log.exception || []),
- ];
- };
diff --git a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobModal.tsx b/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobModal.tsx
index f463cc27ec5..3e79f34af43 100644
--- a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobModal.tsx
+++ b/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobModal.tsx
@@ -11,10 +11,10 @@ import { Link } from "metabase/common/components/Link";
import { ModalContent } from "metabase/common/components/ModalContent";
import type { ModalComponentProps } from "metabase/common/components/ModalRoute";
import ButtonsS from "metabase/css/components/buttons.module.css";
-import { Button } from "metabase/ui";
+import { Box, Button } from "metabase/ui";
import { parseNumberParam } from "metabase/urls";
-import { ErrorBox } from "./ModelCacheRefreshJobs.styled";
+import S from "./ModelCacheRefreshJobs.module.css";
export function ModelCacheRefreshJobModal({
params,
@@ -61,7 +61,9 @@ export function ModelCacheRefreshJobModal({
return (
<ModalContent title={t`Oh oh…`} onClose={onClose} footer={footer}>
- {persistedModel?.error && <ErrorBox>{persistedModel.error}</ErrorBox>}
+ {persistedModel?.error && (
+ <Box className={S.errorBox}>{persistedModel.error}</Box>
+ )}
</ModalContent>
);
}
diff --git a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.module.css b/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.module.css
new file mode 100644
index 00000000000..b42f0c223ae
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.module.css
@@ -0,0 +1,10 @@
+.errorBox {
+ padding: 0.5rem 1rem;
+ border-radius: var(--mantine-radius-sm);
+ color: var(--mb-color-text-primary);
+ background-color: var(--mb-color-background_page-secondary);
+ font-family: var(--mantine-font-family-monospace);
+ font-weight: 400;
+ font-size: var(--mantine-font-size-xs);
+ line-height: 1.25rem;
+}
diff --git a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.styled.tsx b/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.styled.tsx
deleted file mode 100644
index ad77d5c77bd..00000000000
--- a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.styled.tsx
+++ /dev/null
@@ -1,33 +0,0 @@
-// eslint-disable-next-line no-restricted-imports
-import styled from "@emotion/styled";
-
-export const ErrorBox = styled.div`
- padding: 0.5rem 1rem;
- border-radius: 4px;
- color: var(--mb-color-text-primary);
- background-color: var(--mb-color-background_page-secondary);
- font-family: Monaco, monospace;
- font-weight: 400;
- font-size: 12px;
- line-height: 20px;
-`;
-
-export const IconButtonContainer = styled.button`
- cursor: pointer;
-
- .Icon {
- color: var(--mb-color-text-disabled);
- }
-
- &:hover {
- .Icon {
- color: var(--mb-color-text-primary);
- }
- }
-`;
-
-export const PaginationControlsContainer = styled.div`
- display: flex;
- justify-content: flex-end;
- margin: 1.5rem 0;
-`;
diff --git a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.tsx b/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.tsx
index c8a6c9d998e..3018f2cd710 100644
--- a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.tsx
+++ b/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.tsx
@@ -1,169 +1,120 @@
-import cx from "classnames";
+import type { Row } from "@tanstack/react-table";
import dayjs from "dayjs";
-import { useCallback } from "react";
+import { type ReactNode, useCallback, useMemo } from "react";
import { t } from "ttag";
-import NoResults from "assets/img/no_results.svg";
import {
- SettingsPageWrapper,
- SettingsSection,
-} from "metabase/admin/components/SettingsSection";
-import {
- useListPersistedInfoQuery,
+ useLazyListPersistedInfoQuery,
useRefreshModelCacheMutation,
} from "metabase/api";
import { DateTime } from "metabase/common/components/DateTime";
-import { EmptyState } from "metabase/common/components/EmptyState";
import { Link } from "metabase/common/components/Link";
-import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
+import { DelayedLoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper/DelayedLoadingAndErrorWrapper";
import { PaginationControls } from "metabase/common/components/PaginationControls";
+import { useAbortableQuery } from "metabase/common/hooks/use-abortable-query";
import { usePagination } from "metabase/common/hooks/use-pagination";
-import AdminS from "metabase/css/admin.module.css";
-import CS from "metabase/css/core/index.css";
-import { Outlet } from "metabase/router";
-import { Icon, Tooltip } from "metabase/ui";
+import { MonitorEmptyState } from "metabase/monitor/components/MonitorEmptyState";
+import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
+import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
+import { useDispatch } from "metabase/redux";
+import { Outlet, push } from "metabase/router";
+import {
+ ActionIcon,
+ Card,
+ Center,
+ Ellipsified,
+ Flex,
+ Icon,
+ Text,
+ Tooltip,
+ TreeTable,
+ type TreeTableColumnDef,
+ TreeTableSkeleton,
+ useTreeTableInstance,
+} from "metabase/ui";
import * as Urls from "metabase/urls";
import { capitalize } from "metabase/utils/formatting";
import { checkCanRefreshModelCache } from "metabase-lib/v1/metadata/utils/models";
import type { ModelCacheRefreshStatus } from "metabase-types/api";
-import {
- ErrorBox,
- IconButtonContainer,
- PaginationControlsContainer,
-} from "./ModelCacheRefreshJobs.styled";
-
-type JobTableItemProps = {
- job: ModelCacheRefreshStatus;
- onRefresh: () => void;
-};
-
-function JobTableItem({ job, onRefresh }: JobTableItemProps) {
- const modelUrl = Urls.model({ id: job.card_id, name: job.card_name });
- const collectionUrl = Urls.collection({
- id: job.collection_id,
- name: job.collection_name,
- });
-
- const lastRunAtLabel = capitalize(dayjs(job.refresh_begin).fromNow());
-
- const renderStatus = useCallback(() => {
- if (job.state === "off") {
- return t`Off`;
- }
- if (job.state === "creating") {
- return t`Queued`;
- }
- if (job.state === "refreshing") {
- return t`Refreshing`;
- }
- if (job.state === "persisted") {
- return t`Completed`;
- }
- if (job.state === "error") {
- return (
- <Link to={`/admin/tools/model-caching/${job.id}`}>
- <ErrorBox>{job.error}</ErrorBox>
- </Link>
- );
- }
- return job.state;
- }, [job]);
-
- return (
- <tr key={job.id}>
- <td>
- <span>
- <Link variant="brand" to={modelUrl}>
- {job.card_name}
- </Link>{" "}
- {t`in`}{" "}
- <Link variant="brand" to={collectionUrl}>
- {job.collection_name || t`Our analytics`}
- </Link>
- </span>
- </td>
- <td>{renderStatus()}</td>
- <td>
- <Tooltip label={<DateTime value={job.refresh_begin} />}>
- <span>{lastRunAtLabel}</span>
- </Tooltip>
- </td>
- <td>{job.creator?.common_name || t`Automatic`}</td>
- <td>
- {checkCanRefreshModelCache(job) && (
- <Tooltip label={t`Refresh`}>
- <IconButtonContainer onClick={onRefresh}>
- <Icon name="refresh" />
- </IconButtonContainer>
- </Tooltip>
- )}
- </td>
- </tr>
- );
-}
-
const PAGE_SIZE = 20;
+const COLUMN_WIDTHS = [0.22, 0.16, 0.28, 0.14, 0.14, 0.06];
+
export function ModelCacheRefreshJobs() {
+ const dispatch = useDispatch();
const [refreshModelCache] = useRefreshModelCacheMutation();
const { page, handleNextPage, handlePreviousPage } = usePagination();
- const { data, error, isFetching } = useListPersistedInfoQuery({
- limit: PAGE_SIZE,
- offset: PAGE_SIZE * page,
- });
+
+ const { data, error, isLoading, isFetching } = useAbortableQuery(
+ useLazyListPersistedInfoQuery,
+ {
+ limit: PAGE_SIZE,
+ offset: PAGE_SIZE * page,
+ },
+ );
const { data: persistedModels, total } = data ?? { data: [], total: 0 };
+
+ // "deletable" records are pending cleanup and aren't shown to the user
+ const jobs = useMemo(
+ () => persistedModels.filter((info) => info.state !== "deletable"),
+ [persistedModels],
+ );
const hasPagination = total > PAGE_SIZE;
- const modelCacheInfo = persistedModels.filter(
- (cacheInfo) => cacheInfo.state !== "deletable",
+
+ const columns = useMemo(
+ () => getColumns((job) => refreshModelCache(job.card_id)),
+ [refreshModelCache],
);
- if (error || isFetching) {
- return <LoadingAndErrorWrapper error={error} loading={isFetching} />;
- }
+ const handleRowActivate = useCallback(
+ (row: Row<ModelCacheRefreshStatus>) => {
+ const { card_id, card_name } = row.original;
+ dispatch(push(Urls.model({ id: card_id, name: card_name })));
+ },
+ [dispatch],
+ );
- if (modelCacheInfo.length === 0) {
+ const treeTableInstance = useTreeTableInstance<ModelCacheRefreshStatus>({
+ data: jobs,
+ columns,
+ getNodeId: (job) => String(job.id),
+ onRowActivate: handleRowActivate,
+ });
+
+ if (error != null) {
return (
- <div data-testid="model-cache-logs">
- <EmptyState
- title={t`No results`}
- illustrationElement={<img src={NoResults} />}
- />
- </div>
+ <Center flex={1}>
+ <DelayedLoadingAndErrorWrapper loading={isFetching} error={error} />
+ </Center>
);
}
return (
- <div data-testid="model-cache-logs">
- <table className={cx(AdminS.ContentTable, CS.borderBottom)}>
- <colgroup>
- <col style={{ width: "30%" }} />
- <col style={{ width: "40%" }} />
- <col />
- <col />
- <col style={{ width: "5%" }} />
- </colgroup>
- <thead>
- <tr>
- <th>{t`Model`}</th>
- <th>{t`Status`}</th>
- <th>{t`Last run at`}</th>
- <th>{t`Created by`}</th>
- <th></th>
- </tr>
- </thead>
- <tbody>
- {modelCacheInfo.map((job) => (
- <JobTableItem
- key={job.id}
- job={job}
- onRefresh={() => refreshModelCache(job.card_id)}
- />
- ))}
- </tbody>
- </table>
- {hasPagination && (
- <PaginationControlsContainer>
+ <>
+ <Card
+ flex="0 1 auto"
+ mih={0}
+ p={0}
+ withBorder
+ data-testid="model-cache-logs"
+ >
+ {isLoading ? (
+ <TreeTableSkeleton columnWidths={COLUMN_WIDTHS} />
+ ) : (
+ <TreeTable
+ instance={treeTableInstance}
+ hierarchical={false}
+ ariaLabel={t`Model caching log`}
+ emptyState={<MonitorEmptyState label={t`No log entries`} />}
+ getRowProps={() => ({ "data-testid": "model-cache-log-row" })}
+ onRowClick={handleRowActivate}
+ />
+ )}
+ </Card>
+
+ {!isLoading && hasPagination && (
+ <Flex justify="end">
<PaginationControls
showTotal
page={page}
@@ -173,19 +124,148 @@ export function ModelCacheRefreshJobs() {
onNextPage={handleNextPage}
onPreviousPage={handlePreviousPage}
/>
- </PaginationControlsContainer>
+ </Flex>
)}
- </div>
+ </>
);
}
export function ModelCachePage() {
return (
- <SettingsPageWrapper title={t`Model cache log`}>
- <SettingsSection>
+ <Flex h="100%" wrap="nowrap">
+ <MonitorMain>
+ <MonitorHeaderTitle mb="sm">{t`Model caching log`}</MonitorHeaderTitle>
<ModelCacheRefreshJobs />
- </SettingsSection>
+ </MonitorMain>
<Outlet /> {/* refresh modal */}
- </SettingsPageWrapper>
+ </Flex>
);
}
+
+function getColumns(
+ onRefresh: (job: ModelCacheRefreshStatus) => void,
+): TreeTableColumnDef<ModelCacheRefreshStatus>[] {
+ return [
+ {
+ id: "model",
+ header: t`Model`,
+ minWidth: "auto",
+ maxAutoWidth: 300,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (job) => job.card_name,
+ cell: ({ row }) => <Ellipsified>{row.original.card_name}</Ellipsified>,
+ },
+ {
+ id: "collection",
+ header: t`Collection`,
+ minWidth: "auto",
+ maxAutoWidth: 240,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (job) => job.collection_name || t`Our analytics`,
+ cell: ({ row }) => {
+ const { collection_id, collection_name } = row.original;
+ return (
+ <Link
+ variant="brand"
+ to={Urls.collection({ id: collection_id, name: collection_name })}
+ onClick={(event) => event.stopPropagation()}
+ >
+ <Ellipsified>{collection_name || t`Our analytics`}</Ellipsified>
+ </Link>
+ );
+ },
+ },
+ {
+ id: "status",
+ header: t`Status`,
+ width: "auto",
+ minWidth: 120,
+ maxAutoWidth: 320,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (job) => job.state,
+ cell: ({ row }) => <ModelCacheStatus job={row.original} />,
+ },
+ {
+ id: "last_run_at",
+ header: t`Last run at`,
+ width: "auto",
+ minWidth: 130,
+ enableSorting: true,
+ sortDescFirst: true,
+ accessorFn: (job) => job.refresh_begin,
+ cell: ({ row }) => (
+ <Tooltip label={<DateTime value={row.original.refresh_begin} />}>
+ <Text span>
+ {capitalize(dayjs(row.original.refresh_begin).fromNow())}
+ </Text>
+ </Tooltip>
+ ),
+ },
+ {
+ id: "created_by",
+ header: t`Created by`,
+ width: "auto",
+ minWidth: 110,
+ maxAutoWidth: 200,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (job) => job.creator?.common_name || t`Automatic`,
+ cell: ({ row }) => row.original.creator?.common_name || t`Automatic`,
+ },
+ {
+ id: "actions",
+ header: "",
+ width: 60,
+ enableSorting: false,
+ cell: ({ row }) =>
+ checkCanRefreshModelCache(row.original) ? (
+ <Flex justify="flex-end" w="100%">
+ <Tooltip label={t`Refresh`}>
+ <ActionIcon
+ aria-label={t`Refresh`}
+ onClick={(event) => {
+ event.stopPropagation();
+ onRefresh(row.original);
+ }}
+ >
+ <Icon name="refresh" />
+ </ActionIcon>
+ </Tooltip>
+ </Flex>
+ ) : null,
+ },
+ ];
+}
+
+function ModelCacheStatus({
+ job,
+}: {
+ job: ModelCacheRefreshStatus;
+}): ReactNode {
+ switch (job.state) {
+ case "off":
+ return t`Off`;
+ case "creating":
+ return t`Queued`;
+ case "refreshing":
+ return t`Refreshing`;
+ case "persisted":
+ return t`Completed`;
+ case "error":
+ return (
+ <Link
+ to={Urls.monitorModelCacheRefreshJob(job.id)}
+ onClick={(event) => event.stopPropagation()}
+ >
+ <Ellipsified ff="monospace" c="error">
+ {job.error}
+ </Ellipsified>
+ </Link>
+ );
+ default:
+ return job.state;
+ }
+}
diff --git a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.unit.spec.tsx b/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.unit.spec.tsx
index f288cd5560e..9b3dc91847a 100644
--- a/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.unit.spec.tsx
+++ b/frontend/src/metabase/monitor/tools/components/ModelCacheRefreshJobs/ModelCacheRefreshJobs.unit.spec.tsx
@@ -1,11 +1,18 @@
+import userEvent from "@testing-library/user-event";
+
import { setupModelPersistenceEndpoints } from "__support__/server-mocks/persist";
-import { renderWithProviders, screen } from "__support__/ui";
+import {
+ mockGetBoundingClientRect,
+ renderWithProviders,
+ screen,
+} from "__support__/ui";
import type { ModelCacheRefreshStatus } from "metabase-types/api";
import { getMockModelCacheInfo } from "metabase-types/api/mocks/models";
import { ModelCacheRefreshJobs } from "./ModelCacheRefreshJobs";
async function setup({ logs = [] }: { logs?: ModelCacheRefreshStatus[] } = {}) {
+ mockGetBoundingClientRect({ width: 100, height: 100 });
setupModelPersistenceEndpoints(logs);
renderWithProviders(<ModelCacheRefreshJobs />);
@@ -16,8 +23,8 @@ async function setup({ logs = [] }: { logs?: ModelCacheRefreshStatus[] } = {}) {
describe("ModelCacheRefreshJobs", () => {
it("shows empty state when there are no cache logs", async () => {
await setup({ logs: [] });
- expect(screen.getByText("No results")).toBeInTheDocument();
- expect(document.querySelector("table")).not.toBeInTheDocument();
+ expect(await screen.findByText("No log entries")).toBeInTheDocument();
+ expect(screen.queryByTestId("model-cache-log-row")).not.toBeInTheDocument();
});
it("shows empty state when all logs are in 'deletable' state", async () => {
@@ -27,8 +34,8 @@ describe("ModelCacheRefreshJobs", () => {
getMockModelCacheInfo({ id: 2, card_id: 2, state: "deletable" }),
],
});
- expect(screen.getByText("No results")).toBeInTheDocument();
- expect(document.querySelector("table")).not.toBeInTheDocument();
+ expect(await screen.findByText("No log entries")).toBeInTheDocument();
+ expect(screen.queryByTestId("model-cache-log-row")).not.toBeInTheDocument();
});
it("shows model and collection names", async () => {
@@ -39,7 +46,7 @@ describe("ModelCacheRefreshJobs", () => {
await setup({ logs: [info] });
- expect(screen.getByText("Customer")).toBeInTheDocument();
+ expect(await screen.findByText("Customer")).toBeInTheDocument();
expect(screen.getByText("Growth")).toBeInTheDocument();
});
@@ -49,7 +56,7 @@ describe("ModelCacheRefreshJobs", () => {
collection_name: undefined,
});
await setup({ logs: [info] });
- expect(screen.getByText("Our analytics")).toBeInTheDocument();
+ expect(await screen.findByText("Our analytics")).toBeInTheDocument();
});
it("doesn't show records in 'deletable' state", async () => {
@@ -64,30 +71,33 @@ describe("ModelCacheRefreshJobs", () => {
getMockModelCacheInfo({ id: 2, card_id: 2, state: "persisted" }),
],
});
+ expect(
+ await screen.findByTestId("model-cache-log-row"),
+ ).toBeInTheDocument();
expect(screen.queryByText("DELETABLE")).not.toBeInTheDocument();
});
it("displays 'off' state correctly", async () => {
await setup({ logs: [getMockModelCacheInfo({ state: "off" })] });
- expect(screen.getByText("Off")).toBeInTheDocument();
+ expect(await screen.findByText("Off")).toBeInTheDocument();
expect(screen.queryByLabelText("refresh icon")).not.toBeInTheDocument();
});
it("displays 'creating' state correctly", async () => {
await setup({ logs: [getMockModelCacheInfo({ state: "creating" })] });
- expect(screen.getByText("Queued")).toBeInTheDocument();
+ expect(await screen.findByText("Queued")).toBeInTheDocument();
expect(screen.getByLabelText("refresh icon")).toBeInTheDocument();
});
it("displays 'refreshing' state correctly", async () => {
await setup({ logs: [getMockModelCacheInfo({ state: "refreshing" })] });
- expect(screen.getByText("Refreshing")).toBeInTheDocument();
+ expect(await screen.findByText("Refreshing")).toBeInTheDocument();
expect(screen.queryByLabelText("refresh icon")).not.toBeInTheDocument();
});
it("displays 'persisted' state correctly", async () => {
await setup({ logs: [getMockModelCacheInfo({ state: "persisted" })] });
- expect(screen.getByText("Completed")).toBeInTheDocument();
+ expect(await screen.findByText("Completed")).toBeInTheDocument();
expect(screen.getByLabelText("refresh icon")).toBeInTheDocument();
});
@@ -95,7 +105,47 @@ describe("ModelCacheRefreshJobs", () => {
await setup({
logs: [getMockModelCacheInfo({ state: "error", error: "FOO BAR ERROR" })],
});
- expect(screen.getByText("FOO BAR ERROR")).toBeInTheDocument();
+ expect(await screen.findByText("FOO BAR ERROR")).toBeInTheDocument();
expect(screen.getByLabelText("refresh icon")).toBeInTheDocument();
});
+
+ it("sorts client-side by Model when its header is clicked", async () => {
+ await setup({
+ logs: [
+ getMockModelCacheInfo({ id: 1, card_id: 1, card_name: "Zebra" }),
+ getMockModelCacheInfo({ id: 2, card_id: 2, card_name: "Apple" }),
+ ],
+ });
+
+ const getRows = () => screen.getAllByTestId("model-cache-log-row");
+ await screen.findAllByTestId("model-cache-log-row");
+ expect(getRows()[0]).toHaveTextContent("Zebra");
+ expect(getRows()[1]).toHaveTextContent("Apple");
+
+ await userEvent.click(screen.getByRole("columnheader", { name: /Model/ }));
+
+ expect(getRows()[0]).toHaveTextContent("Apple");
+ expect(getRows()[1]).toHaveTextContent("Zebra");
+ });
+
+ it("sorts client-side by Collection when its header is clicked", async () => {
+ await setup({
+ logs: [
+ getMockModelCacheInfo({ id: 1, card_id: 1, collection_name: "Zeta" }),
+ getMockModelCacheInfo({ id: 2, card_id: 2, collection_name: "Alpha" }),
+ ],
+ });
+
+ const getRows = () => screen.getAllByTestId("model-cache-log-row");
+ await screen.findAllByTestId("model-cache-log-row");
+ expect(getRows()[0]).toHaveTextContent("Zeta");
+ expect(getRows()[1]).toHaveTextContent("Alpha");
+
+ await userEvent.click(
+ screen.getByRole("columnheader", { name: /Collection/ }),
+ );
+
+ expect(getRows()[0]).toHaveTextContent("Alpha");
+ expect(getRows()[1]).toHaveTextContent("Zeta");
+ });
});
diff --git a/frontend/src/metabase/monitor/tools/components/MonitorBackLink/MonitorBackLink.tsx b/frontend/src/metabase/monitor/tools/components/MonitorBackLink/MonitorBackLink.tsx
new file mode 100644
index 00000000000..7de20dddf71
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/MonitorBackLink/MonitorBackLink.tsx
@@ -0,0 +1,19 @@
+import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
+import { Link } from "metabase/router";
+import { Flex, Icon } from "metabase/ui";
+
+type MonitorBackLinkProps = {
+ to: string;
+ label: string;
+};
+
+export const MonitorBackLink = ({ to, label }: MonitorBackLinkProps) => (
+ <Link to={to}>
+ <MonitorHeaderTitle>
+ <Flex align="center" gap="xs">
+ <Icon name="chevronleft" />
+ {label}
+ </Flex>
+ </MonitorHeaderTitle>
+ </Link>
+);
diff --git a/frontend/src/metabase/monitor/tools/components/MonitorBackLink/index.ts b/frontend/src/metabase/monitor/tools/components/MonitorBackLink/index.ts
new file mode 100644
index 00000000000..ec260eff7b8
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/MonitorBackLink/index.ts
@@ -0,0 +1 @@
+export { MonitorBackLink } from "./MonitorBackLink";
diff --git a/frontend/src/metabase/monitor/tools/components/MonitorUpsell/MonitorUpsell.tsx b/frontend/src/metabase/monitor/tools/components/MonitorUpsell/MonitorUpsell.tsx
new file mode 100644
index 00000000000..7b7bd83371e
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/MonitorUpsell/MonitorUpsell.tsx
@@ -0,0 +1,19 @@
+import { t } from "ttag";
+
+import { usePageTitle } from "metabase/hooks/use-page-title";
+import { BaseUpsellPage } from "metabase/monitor/upsells";
+
+export const MonitorUpsell = () => {
+ usePageTitle(t`Erroring questions`);
+
+ return (
+ <BaseUpsellPage
+ campaign="audit-tools"
+ location="settings-tools"
+ header={t`Erroring questions`}
+ title={t`Troubleshoot faster`}
+ description={t`Find and fix issues fast, with an overview of all errors and model caching logs.`}
+ image="app/assets/img/upsell-performance-tools.png"
+ />
+ );
+};
diff --git a/frontend/src/metabase/monitor/tools/components/MonitorUpsell/index.ts b/frontend/src/metabase/monitor/tools/components/MonitorUpsell/index.ts
new file mode 100644
index 00000000000..fc7671fb10b
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/MonitorUpsell/index.ts
@@ -0,0 +1 @@
+export * from "./MonitorUpsell";
diff --git a/frontend/src/metabase/monitor/tools/components/TaskDetailsPage/TaskDetailsPage.module.css b/frontend/src/metabase/monitor/tools/components/TaskDetailsPage/TaskDetailsPage.module.css
index a38323bd214..e756952ee35 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskDetailsPage/TaskDetailsPage.module.css
+++ b/frontend/src/metabase/monitor/tools/components/TaskDetailsPage/TaskDetailsPage.module.css
@@ -1,3 +1,7 @@
+.content {
+ overflow: auto;
+}
+
.codeContainer {
border: var(--border-size) var(--border-style) var(--mb-color-border-neutral);
border-radius: var(--default-border-radius);
diff --git a/frontend/src/metabase/monitor/tools/components/TaskDetailsPage/TaskDetailsPage.tsx b/frontend/src/metabase/monitor/tools/components/TaskDetailsPage/TaskDetailsPage.tsx
index 76a44788352..aa0b25bcdc5 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskDetailsPage/TaskDetailsPage.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskDetailsPage/TaskDetailsPage.tsx
@@ -2,12 +2,15 @@ import { useMemo } from "react";
import { t } from "ttag";
import _ from "underscore";
-import { SettingsSection } from "metabase/admin/components/SettingsSection";
import { useGetTaskQuery, useListDatabasesQuery } from "metabase/api";
import { CodeEditor } from "metabase/common/components/CodeEditor";
import { CopyButton } from "metabase/common/components/CopyButton";
import { DateTime } from "metabase/common/components/DateTime";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
+import { LogsViewer } from "metabase/monitor/components/LogsViewer";
+import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
+import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
+import { MonitorPageContent } from "metabase/monitor/components/MonitorPageContent";
import { Link } from "metabase/router";
import {
Anchor,
@@ -18,7 +21,6 @@ import {
Loader,
Stack,
Text,
- Title,
Tooltip,
} from "metabase/ui";
import * as Urls from "metabase/urls";
@@ -27,7 +29,7 @@ import { openSaveDialog } from "metabase/utils/dom";
import type { Database } from "metabase-types/api";
import { formatTaskDetails, getFilename } from "../../utils";
-import { LogsViewer } from "../Logs/LogsViewer";
+import { MonitorBackLink } from "../MonitorBackLink";
import { TaskStatusBadge } from "../TaskStatusBadge";
import S from "./TaskDetailsPage.module.css";
@@ -60,134 +62,134 @@ export const TaskDetailsPage = ({ params }: TaskDetailsPageProps) => {
};
return (
- <SettingsSection>
- <Flex align="center" gap="sm">
- <Link to={Urls.adminToolsTasksList()}>
- <Flex align="center" gap="xs" c="text-secondary">
- <Icon name="chevronleft" />
- {t`Back to Tasks`}
- </Flex>
- </Link>
- </Flex>
+ <Flex h="100%" wrap="nowrap">
+ <MonitorMain gap="lg">
+ <MonitorBackLink
+ to={Urls.monitorTasksList()}
+ label={t`Back to Tasks`}
+ />
- <Stack gap="sm">
- <Title order={3}>{t`Task details`}</Title>
- <Flex gap="md">
- <Text fw="bold" w={120}>{t`ID`}</Text>
- <Text>{task.id}</Text>
- </Flex>
- <Flex gap="md">
- <Text fw="bold" w={120}>{t`Task`}</Text>
- <Text>{task.task}</Text>
- </Flex>
- <Flex gap="md" align="center">
- <Text fw="bold" w={120}>{t`Status`}</Text>
- <TaskStatusBadge task={task} />
- </Flex>
- {task.run_id !== null && (
- <Flex gap="md" align="baseline">
- <Text fw="bold" w={120}>{t`Task run`}</Text>
- <Anchor
- component={Link}
- to={Urls.adminToolsTaskRunDetails(task.run_id)}
- >
- {t`Go to the corresponding run`}
- </Anchor>
- </Flex>
- )}
- <Flex gap="md">
- <Text fw="bold" w={120}>{t`DB Name`}</Text>
- <Text>
- {isLoadingDatabases ? (
- <Loader size="xs" />
- ) : db ? (
- dbName
- ) : (
- EMPTY_CELL_PLACEHOLDER
- )}
- </Text>
- </Flex>
- <Flex gap="md">
- <Text fw="bold" w={120}>{t`DB Engine`}</Text>
- <Text>
- {isLoadingDatabases ? (
- <Loader size="xs" />
- ) : db ? (
- dbEngine
- ) : (
- EMPTY_CELL_PLACEHOLDER
+ <MonitorPageContent className={S.content}>
+ <Stack gap="sm">
+ <MonitorHeaderTitle>{t`Task details`}</MonitorHeaderTitle>
+ <Flex gap="md">
+ <Text fw="bold" w={120}>{t`ID`}</Text>
+ <Text>{task.id}</Text>
+ </Flex>
+ <Flex gap="md">
+ <Text fw="bold" w={120}>{t`Task`}</Text>
+ <Text>{task.task}</Text>
+ </Flex>
+ <Flex gap="md" align="center">
+ <Text fw="bold" w={120}>{t`Status`}</Text>
+ <TaskStatusBadge task={task} />
+ </Flex>
+ {task.run_id !== null && (
+ <Flex gap="md" align="baseline">
+ <Text fw="bold" w={120}>{t`Task run`}</Text>
+ <Anchor
+ component={Link}
+ to={Urls.monitorTaskRunDetails(task.run_id)}
+ >
+ {t`Go to the corresponding run`}
+ </Anchor>
+ </Flex>
)}
- </Text>
- </Flex>
- <Flex gap="md" align="baseline">
- <Text fw="bold" w={120}>{t`Started at`}</Text>
- <Tooltip label={task.started_at}>
- <DateTime
- value={task.started_at}
- unit="minute"
- data-testid="started-at"
- />
- </Tooltip>
- <CopyButton value={task.started_at} />
- </Flex>
- <Flex gap="md">
- <Text fw="bold" w={120}>{t`Ended at`}</Text>
- {task.ended_at ? (
- <Tooltip label={task.ended_at}>
- <DateTime
- value={task.ended_at}
- unit="minute"
- data-testid="ended-at"
+ <Flex gap="md">
+ <Text fw="bold" w={120}>{t`DB Name`}</Text>
+ <Text>
+ {isLoadingDatabases ? (
+ <Loader size="xs" />
+ ) : db ? (
+ dbName
+ ) : (
+ EMPTY_CELL_PLACEHOLDER
+ )}
+ </Text>
+ </Flex>
+ <Flex gap="md">
+ <Text fw="bold" w={120}>{t`DB Engine`}</Text>
+ <Text>
+ {isLoadingDatabases ? (
+ <Loader size="xs" />
+ ) : db ? (
+ dbEngine
+ ) : (
+ EMPTY_CELL_PLACEHOLDER
+ )}
+ </Text>
+ </Flex>
+ <Flex gap="md" align="baseline">
+ <Text fw="bold" w={120}>{t`Started at`}</Text>
+ <Tooltip label={task.started_at}>
+ <DateTime
+ value={task.started_at}
+ unit="minute"
+ data-testid="started-at"
+ />
+ </Tooltip>
+ <CopyButton value={task.started_at} />
+ </Flex>
+ <Flex gap="md">
+ <Text fw="bold" w={120}>{t`Ended at`}</Text>
+ {task.ended_at ? (
+ <Tooltip label={task.ended_at}>
+ <DateTime
+ value={task.ended_at}
+ unit="minute"
+ data-testid="ended-at"
+ />
+ </Tooltip>
+ ) : (
+ EMPTY_CELL_PLACEHOLDER
+ )}
+ {task.ended_at && <CopyButton value={task.ended_at} />}
+ </Flex>
+ <Flex gap="md">
+ <Text fw="bold" w={120}>{t`Duration (ms)`}</Text>
+ <Text>{task.duration}</Text>
+ </Flex>
+ <Flex justify="space-between" align="flex-end">
+ <MonitorHeaderTitle>{t`JSON details`}</MonitorHeaderTitle>
+ <Button
+ leftSection={<Icon name="download" />}
+ variant="filled"
+ onClick={handleDownload}
+ >{t`Download`}</Button>
+ </Flex>
+ <Box
+ className={S.codeContainer}
+ p={linesCount > 1 ? 0 : "xs"}
+ pos="relative"
+ mt="md"
+ data-testid="code-container"
+ >
+ <CodeEditor
+ language="json"
+ lineNumbers={linesCount > 1}
+ readOnly
+ value={code}
/>
- </Tooltip>
- ) : (
- EMPTY_CELL_PLACEHOLDER
- )}
- {task.ended_at && <CopyButton value={task.ended_at} />}
- </Flex>
- <Flex gap="md">
- <Text fw="bold" w={120}>{t`Duration (ms)`}</Text>
- <Text>{task.duration}</Text>
- </Flex>
- <Flex justify="space-between" align="flex-end">
- <Title order={3}>{t`JSON details`}</Title>
- <Button
- leftSection={<Icon name="download" />}
- variant="filled"
- onClick={handleDownload}
- >{t`Download`}</Button>
- </Flex>
- <Box
- className={S.codeContainer}
- p={linesCount > 1 ? 0 : "xs"}
- pos="relative"
- mt="md"
- data-testid="code-container"
- >
- <CodeEditor
- language="json"
- lineNumbers={linesCount > 1}
- readOnly
- value={code}
- />
- <Box p="sm" pos="absolute" right={0} top={0}>
- <CopyButton value={code} />
- </Box>
- </Box>
+ <Box p="sm" pos="absolute" right={0} top={0}>
+ <CopyButton value={code} />
+ </Box>
+ </Box>
- <Title order={3}>{t`Logs`}</Title>
- {hasLogs ? (
- <Box className={S.codeContainer}>
- <LogsViewer
- logs={task?.logs ?? []}
- data-testid="task-logs"
- ></LogsViewer>
- </Box>
- ) : (
- <Text>{t`There are no captured logs`}</Text>
- )}
- </Stack>
- </SettingsSection>
+ <MonitorHeaderTitle>{t`Logs`}</MonitorHeaderTitle>
+ {hasLogs ? (
+ <Box className={S.codeContainer}>
+ <LogsViewer
+ logs={task?.logs ?? []}
+ data-testid="task-logs"
+ ></LogsViewer>
+ </Box>
+ ) : (
+ <Text>{t`There are no captured logs`}</Text>
+ )}
+ </Stack>
+ </MonitorPageContent>
+ </MonitorMain>
+ </Flex>
);
};
diff --git a/frontend/src/metabase/monitor/tools/components/TaskDetailsPage/TaskDetailsPage.unit.spec.tsx b/frontend/src/metabase/monitor/tools/components/TaskDetailsPage/TaskDetailsPage.unit.spec.tsx
index 9c2f8afcd61..c9388fd73fb 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskDetailsPage/TaskDetailsPage.unit.spec.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskDetailsPage/TaskDetailsPage.unit.spec.tsx
@@ -29,7 +29,7 @@ jest.mock("@mantine/hooks", () => ({
// Unjustified type cast. FIXME
const mockUseClipboard = useClipboard as jest.Mock;
-const PATHNAME = `${Urls.adminToolsTasksList()}/:taskId`;
+const PATHNAME = `${Urls.monitorTasksList()}/:taskId`;
interface SetupOpts {
task?: Task;
@@ -42,7 +42,7 @@ const setup = ({ task = createMockTask() }: SetupOpts = {}) => {
return renderWithProviders(
<Route path={PATHNAME} element={<RoutedTaskDetailsPage />} />,
{
- initialRoute: Urls.adminToolsTaskDetails(task.id),
+ initialRoute: Urls.monitorTaskDetails(task.id),
withRouter: true,
},
);
@@ -141,4 +141,24 @@ describe("TaskDetailsPage", () => {
await userEvent.click(endedAtCopyIcon);
expect(copyMock).toHaveBeenCalledWith(endedAt);
});
+
+ it("shows a placeholder when the task has no captured logs", async () => {
+ setup({ task: createMockTask({ logs: null }) });
+
+ await waitForLoaderToBeRemoved();
+
+ expect(screen.getByText("There are no captured logs")).toBeInTheDocument();
+ expect(screen.queryByTestId("task-logs")).not.toBeInTheDocument();
+ });
+
+ it("should show a link back to the tasks list", async () => {
+ setup();
+
+ await waitForLoaderToBeRemoved();
+
+ expect(screen.getByRole("link", { name: /Back to Tasks/ })).toHaveAttribute(
+ "href",
+ Urls.monitorTasksList(),
+ );
+ });
});
diff --git a/frontend/src/metabase/monitor/tools/components/TaskListPage/TaskListPage.tsx b/frontend/src/metabase/monitor/tools/components/TaskListPage/TaskListPage.tsx
index 4ca9ebe99cc..ce73da8cdef 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskListPage/TaskListPage.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskListPage/TaskListPage.tsx
@@ -1,8 +1,12 @@
-import { useListDatabasesQuery, useListTasksQuery } from "metabase/api";
+import { useMemo } from "react";
+
+import { useLazyListTasksQuery, useListDatabasesQuery } from "metabase/api";
+import { DelayedLoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper/DelayedLoadingAndErrorWrapper";
import { PaginationControls } from "metabase/common/components/PaginationControls";
+import { useAbortableQuery } from "metabase/common/hooks/use-abortable-query";
import { useUrlState } from "metabase/common/hooks/use-url-state";
import type { WithRouterProps } from "metabase/router";
-import { Flex } from "metabase/ui";
+import { Center, Flex, Group } from "metabase/ui";
import { TaskPicker } from "../TaskPicker";
import { TaskStatusPicker } from "../TaskStatusPicker";
@@ -18,13 +22,18 @@ export const TaskListPage = ({ location }: WithRouterProps) => {
{ page, sort_column, sort_direction, status, task },
{ patchUrlState },
] = useUrlState(location, urlStateConfig);
- const sortingOptions = { sort_column, sort_direction };
+ const sortingOptions = useMemo(
+ () => ({ sort_column, sort_direction }),
+ [sort_column, sort_direction],
+ );
const {
data: tasksData,
+ isFetching,
isLoading: isLoadingTasks,
error: tasksError,
- } = useListTasksQuery(
+ } = useAbortableQuery(
+ useLazyListTasksQuery,
{
limit: PAGE_SIZE,
offset: page * PAGE_SIZE,
@@ -52,39 +61,49 @@ export const TaskListPage = ({ location }: WithRouterProps) => {
return (
<TasksTabs>
- <Flex gap="md" justify="space-between">
- <Flex gap="md">
- <TaskPicker
- value={task}
- onChange={(task) => patchUrlState({ task, page: 0 })}
- />
+ <Group gap="md" align="center" wrap="nowrap">
+ <TaskPicker
+ value={task}
+ onChange={(task) => patchUrlState({ task, page: 0 })}
+ />
- <TaskStatusPicker
- value={status}
- onChange={(status) => patchUrlState({ status, page: 0 })}
- />
- </Flex>
+ <TaskStatusPicker
+ value={status}
+ onChange={(status) => patchUrlState({ status, page: 0 })}
+ />
+ </Group>
- <PaginationControls
- onPreviousPage={() => patchUrlState({ page: page - 1 })}
- onNextPage={() => patchUrlState({ page: page + 1 })}
+ {error !== undefined ? (
+ <Center flex={1}>
+ <DelayedLoadingAndErrorWrapper loading={isLoading} error={error} />
+ </Center>
+ ) : (
+ <TasksTable
+ databases={databases}
+ isFetching={isFetching}
+ isLoading={isLoading}
page={page}
- pageSize={PAGE_SIZE}
- itemsLength={tasks.length}
- total={total}
+ sortingOptions={sortingOptions}
+ tasks={tasks}
+ onSortingOptionsChange={(sortingOptions) =>
+ patchUrlState({ ...sortingOptions, page: 0 })
+ }
/>
- </Flex>
+ )}
- <TasksTable
- databases={databases}
- error={error}
- isLoading={isLoading}
- sortingOptions={sortingOptions}
- tasks={tasks}
- onSortingOptionsChange={(sortingOptions) =>
- patchUrlState({ ...sortingOptions, page: 0 })
- }
- />
+ {!isLoading && error == null && (
+ <Flex justify="end">
+ <PaginationControls
+ page={page}
+ pageSize={PAGE_SIZE}
+ itemsLength={tasks.length}
+ total={total}
+ showTotal
+ onPreviousPage={() => patchUrlState({ page: page - 1 })}
+ onNextPage={() => patchUrlState({ page: page + 1 })}
+ />
+ </Flex>
+ )}
</TasksTabs>
);
};
diff --git a/frontend/src/metabase/monitor/tools/components/TaskListPage/TaskListPage.unit.spec.tsx b/frontend/src/metabase/monitor/tools/components/TaskListPage/TaskListPage.unit.spec.tsx
index f3e13b5e2bb..9d2eaf00bd5 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskListPage/TaskListPage.unit.spec.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskListPage/TaskListPage.unit.spec.tsx
@@ -8,6 +8,7 @@ import {
} from "__support__/server-mocks";
import {
act,
+ mockGetBoundingClientRect,
renderWithProviders,
screen,
waitFor,
@@ -33,7 +34,7 @@ interface SetupOpts {
tasksResponse?: ListTasksResponse;
}
-const PATHNAME = Urls.adminToolsTasksList();
+const PATHNAME = Urls.monitorTasksList();
const setup = ({
error,
@@ -44,6 +45,7 @@ const setup = ({
}: SetupOpts = {}) => {
setupDatabasesEndpoints([createSampleDatabase()]);
setupUniqueTasksEndpoint(["task-a", "task-b"]);
+ mockGetBoundingClientRect({ width: 100, height: 100 });
if (error) {
fetchMock.get("path:/api/task", { status: 500 });
@@ -52,7 +54,9 @@ const setup = ({
}
return renderWithProviders(
- <Route path={PATHNAME} element={<RoutedTaskListPage />} />,
+ <Route path={PATHNAME} element={<RoutedTaskListPage />}>
+ <Route path=":taskId" />
+ </Route>,
{
initialRoute: `${location.pathname}${location.search}`,
withRouter: true,
@@ -60,6 +64,11 @@ const setup = ({
);
};
+const getLastTaskCallUrl = () => {
+ const calls = fetchMock.callHistory.calls("path:/api/task");
+ return calls[calls.length - 1]?.url;
+};
+
describe("TaskListPage", () => {
beforeEach(() => {
jest.useFakeTimers({ advanceTimers: true });
@@ -69,39 +78,33 @@ describe("TaskListPage", () => {
jest.useRealTimers();
});
- it("should show loading and empty state", async () => {
+ it("should show empty state", async () => {
setup();
- expect(screen.getByTestId("loading-indicator")).toBeInTheDocument();
- await waitForLoaderToBeRemoved();
- expect(screen.getByText("No results")).toBeInTheDocument();
+ expect(await screen.findByText("No results")).toBeInTheDocument();
});
- it("should show loading and results state", async () => {
+ it("should show results state", async () => {
setup({
tasksResponse: createMockTasksResponse({ data: [createMockTask()] }),
});
- expect(screen.getByTestId("loading-indicator")).toBeInTheDocument();
- await waitForLoaderToBeRemoved();
+ expect(await screen.findByText("A task")).toBeInTheDocument();
expect(screen.queryByText("No results")).not.toBeInTheDocument();
- expect(screen.getByText("A task")).toBeInTheDocument();
});
it("should show error state", async () => {
setup({ error: true });
- expect(screen.getByTestId("loading-indicator")).toBeInTheDocument();
- await waitForLoaderToBeRemoved();
+ expect(await screen.findByText("An error occurred")).toBeInTheDocument();
expect(screen.queryByText("No results")).not.toBeInTheDocument();
expect(screen.queryByText("A task")).not.toBeInTheDocument();
- expect(screen.getByText("An error occurred")).toBeInTheDocument();
});
it("should not show pagination controls if there's only 1 page", async () => {
setup();
- await waitForLoaderToBeRemoved();
+ await screen.findByText("No results");
expect(
screen.queryByRole("button", { name: "Previous page" }),
).not.toBeInTheDocument();
@@ -128,9 +131,9 @@ describe("TaskListPage", () => {
).toEqual([
"http://localhost/api/task?limit=50&offset=0&sort_column=started_at&sort_direction=desc",
]);
- await waitForLoaderToBeRemoved();
-
- const previousPage = screen.getByRole("button", { name: "Previous page" });
+ const previousPage = await screen.findByRole("button", {
+ name: "Previous page",
+ });
const nextPage = screen.getByRole("button", { name: "Next page" });
expect(previousPage).toBeDisabled();
@@ -177,6 +180,25 @@ describe("TaskListPage", () => {
expect(history?.getCurrentLocation().search).toEqual("");
});
+ it("should show the total results count below the table", async () => {
+ setup({
+ tasksResponse: createMockTasksResponse({
+ data: [createMockTask()],
+ total: 75,
+ limit: 50,
+ offset: 0,
+ }),
+ });
+
+ await screen.findByText("A task");
+
+ const pagination = screen.getByRole("navigation", { name: "pagination" });
+ expect(
+ within(pagination).getByTestId("pagination-total"),
+ ).toHaveTextContent("75");
+ expect(pagination).toHaveTextContent("1 - 1");
+ });
+
it("should reset pagination on task filter change", async () => {
const { history } = setup({
tasksResponse: createMockTasksResponse({
@@ -195,9 +217,9 @@ describe("TaskListPage", () => {
).toEqual([
"http://localhost/api/task?limit=50&offset=0&sort_column=started_at&sort_direction=desc",
]);
- await waitForLoaderToBeRemoved();
-
- const previousPage = screen.getByRole("button", { name: "Previous page" });
+ const previousPage = await screen.findByRole("button", {
+ name: "Previous page",
+ });
const nextPage = screen.getByRole("button", { name: "Next page" });
const taskPicker = screen.getByPlaceholderText("Filter by task");
@@ -250,9 +272,9 @@ describe("TaskListPage", () => {
).toEqual([
"http://localhost/api/task?limit=50&offset=0&sort_column=started_at&sort_direction=desc",
]);
- await waitForLoaderToBeRemoved();
-
- const previousPage = screen.getByRole("button", { name: "Previous page" });
+ const previousPage = await screen.findByRole("button", {
+ name: "Previous page",
+ });
const nextPage = screen.getByRole("button", { name: "Next page" });
const taskStatusPicker = screen.getByPlaceholderText("Filter by status");
@@ -290,6 +312,7 @@ describe("TaskListPage", () => {
it("should reset pagination on sorting change", async () => {
const { history } = setup({
tasksResponse: createMockTasksResponse({
+ data: [createMockTask()],
total: 75,
limit: 50,
offset: 0,
@@ -305,11 +328,11 @@ describe("TaskListPage", () => {
).toEqual([
"http://localhost/api/task?limit=50&offset=0&sort_column=started_at&sort_direction=desc",
]);
- await waitForLoaderToBeRemoved();
-
- const previousPage = screen.getByRole("button", { name: "Previous page" });
+ const previousPage = await screen.findByRole("button", {
+ name: "Previous page",
+ });
const nextPage = screen.getByRole("button", { name: "Next page" });
- const startedAtHeader = screen.getByRole("button", {
+ const startedAtHeader = screen.getByRole("columnheader", {
name: /Started at/,
});
@@ -457,84 +480,108 @@ describe("TaskListPage", () => {
});
it("should allow to sort tasks list", async () => {
- const { history } = setup();
+ const { history } = setup({
+ tasksResponse: createMockTasksResponse({ data: [createMockTask()] }),
+ });
await waitFor(() => {
expect(fetchMock.callHistory.calls("path:/api/task")).toHaveLength(1);
});
-
- expect(
- fetchMock.callHistory.calls("path:/api/task").map((call) => call.url),
- ).toEqual([
+ expect(getLastTaskCallUrl()).toEqual(
"http://localhost/api/task?limit=50&offset=0&sort_column=started_at&sort_direction=desc",
- ]);
- await waitForLoaderToBeRemoved();
-
- const startedAtHeader = screen.getByRole("button", { name: /Started at/ });
- const endedAtHeader = screen.getByRole("button", { name: /Ended at/ });
- const durationHeader = screen.getByRole("button", { name: /Duration/ });
-
- expect(startedAtHeader).toBeInTheDocument();
- expect(endedAtHeader).toBeInTheDocument();
- expect(durationHeader).toBeInTheDocument();
+ );
+ const startedAtHeader = await screen.findByRole("columnheader", {
+ name: /Started at/,
+ });
+ expect(startedAtHeader).toHaveAttribute("aria-sort", "descending");
expect(
within(startedAtHeader).getByRole("img", { name: "chevrondown icon" }),
).toBeInTheDocument();
expect(history?.getCurrentLocation().search).toEqual("");
await userEvent.click(startedAtHeader);
-
+ await waitFor(() => {
+ expect(
+ screen.getByRole("columnheader", { name: /Started at/ }),
+ ).toHaveAttribute("aria-sort", "ascending");
+ });
expect(
- within(startedAtHeader).getByRole("img", { name: "chevronup icon" }),
+ within(
+ screen.getByRole("columnheader", { name: /Started at/ }),
+ ).getByRole("img", { name: "chevronup icon" }),
).toBeInTheDocument();
- expect(
- fetchMock.callHistory.calls("path:/api/task").map((call) => call.url),
- ).toEqual([
- "http://localhost/api/task?limit=50&offset=0&sort_column=started_at&sort_direction=desc",
+ expect(getLastTaskCallUrl()).toEqual(
"http://localhost/api/task?limit=50&offset=0&sort_column=started_at&sort_direction=asc",
- ]);
+ );
act(() => {
jest.advanceTimersByTime(URL_UPDATE_DEBOUNCE_DELAY);
});
expect(history?.getCurrentLocation().search).toEqual("?sort_direction=asc");
- await userEvent.click(endedAtHeader);
-
- expect(
- within(endedAtHeader).getByRole("img", { name: "chevronup icon" }),
- ).toBeInTheDocument();
- expect(
- fetchMock.callHistory.calls("path:/api/task").map((call) => call.url),
- ).toEqual([
+ await userEvent.click(
+ screen.getByRole("columnheader", { name: /Started at/ }),
+ );
+ await waitFor(() => {
+ expect(
+ screen.getByRole("columnheader", { name: /Started at/ }),
+ ).toHaveAttribute("aria-sort", "descending");
+ });
+ expect(getLastTaskCallUrl()).toEqual(
"http://localhost/api/task?limit=50&offset=0&sort_column=started_at&sort_direction=desc",
- "http://localhost/api/task?limit=50&offset=0&sort_column=started_at&sort_direction=asc",
- "http://localhost/api/task?limit=50&offset=0&sort_column=ended_at&sort_direction=asc",
- ]);
+ );
act(() => {
jest.advanceTimersByTime(URL_UPDATE_DEBOUNCE_DELAY);
});
- expect(history?.getCurrentLocation().search).toEqual(
- "?sort_column=ended_at&sort_direction=asc",
- );
+ expect(history?.getCurrentLocation().search).toEqual("");
- await userEvent.click(durationHeader);
+ // every sortable column drives the request and URL state
+ const cases: { header: RegExp; column: string }[] = [
+ { header: /Ended at/, column: "ended_at" },
+ { header: /Duration/, column: "duration" },
+ { header: /Task/, column: "task" },
+ { header: /DB Name/, column: "db_name" },
+ { header: /DB Engine/, column: "db_engine" },
+ { header: /Status/, column: "status" },
+ ];
+
+ for (const { header, column } of cases) {
+ await userEvent.click(screen.getByRole("columnheader", { name: header }));
+
+ await waitFor(() => {
+ expect(
+ screen.getByRole("columnheader", { name: header }),
+ ).toHaveAttribute("aria-sort", "ascending");
+ });
+ expect(
+ within(screen.getByRole("columnheader", { name: header })).getByRole(
+ "img",
+ { name: "chevronup icon" },
+ ),
+ ).toBeInTheDocument();
+ expect(getLastTaskCallUrl()).toEqual(
+ `http://localhost/api/task?limit=50&offset=0&sort_column=${column}&sort_direction=asc`,
+ );
+ act(() => {
+ jest.advanceTimersByTime(URL_UPDATE_DEBOUNCE_DELAY);
+ });
+ expect(history?.getCurrentLocation().search).toEqual(
+ `?sort_column=${column}&sort_direction=asc`,
+ );
+ }
+ });
- expect(
- within(durationHeader).getByRole("img", { name: "chevronup icon" }),
- ).toBeInTheDocument();
- expect(
- fetchMock.callHistory.calls("path:/api/task").map((call) => call.url),
- ).toEqual([
- "http://localhost/api/task?limit=50&offset=0&sort_column=started_at&sort_direction=desc",
- "http://localhost/api/task?limit=50&offset=0&sort_column=started_at&sort_direction=asc",
- "http://localhost/api/task?limit=50&offset=0&sort_column=ended_at&sort_direction=asc",
- "http://localhost/api/task?limit=50&offset=0&sort_column=duration&sort_direction=asc",
- ]);
- act(() => {
- jest.advanceTimersByTime(URL_UPDATE_DEBOUNCE_DELAY);
+ it("should navigate to task details when a row is clicked", async () => {
+ const { history } = setup({
+ tasksResponse: createMockTasksResponse({
+ data: [createMockTask({ id: 123 })],
+ }),
});
- expect(history?.getCurrentLocation().search).toEqual(
- "?sort_column=duration&sort_direction=asc",
+
+ const row = await screen.findByTestId("task");
+ await userEvent.click(row);
+
+ expect(history?.getCurrentLocation().pathname).toBe(
+ Urls.monitorTaskDetails(123),
);
});
@@ -560,7 +607,9 @@ describe("TaskListPage", () => {
const taskPicker = screen.getByPlaceholderText("Filter by task");
expect(taskPicker).toBeInTheDocument();
- expect(taskPicker).toHaveValue("task-b");
+ await waitFor(() => {
+ expect(taskPicker).toHaveValue("task-b");
+ });
});
it("accepts status query param", async () => {
@@ -619,9 +668,7 @@ describe("TaskListPage", () => {
}),
});
- await waitForLoaderToBeRemoved();
-
- const row = screen.getByTestId("task");
+ const row = await screen.findByTestId("task");
const startedAtElement = within(row).getByTestId("started-at");
const endedAtElement = within(row).getByTestId("ended-at");
expect(startedAtElement).toHaveTextContent("March 4, 2023, 1:45 AM");
@@ -641,9 +688,7 @@ describe("TaskListPage", () => {
}),
});
- await waitForLoaderToBeRemoved();
-
- const row = screen.getByTestId("task");
+ const row = await screen.findByTestId("task");
const startedAtElement = within(row).getByTestId("started-at");
await userEvent.hover(startedAtElement);
diff --git a/frontend/src/metabase/monitor/tools/components/TaskListPage/TasksTable.tsx b/frontend/src/metabase/monitor/tools/components/TaskListPage/TasksTable.tsx
index bc5ea9dc430..d9f1b26d986 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskListPage/TasksTable.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskListPage/TasksTable.tsx
@@ -1,16 +1,23 @@
-import cx from "classnames";
+import type { Row } from "@tanstack/react-table";
+import { useCallback, useMemo } from "react";
import { t } from "ttag";
import _ from "underscore";
import { DateTime } from "metabase/common/components/DateTime";
-import { SortableColumnHeader } from "metabase/common/components/ItemsTable/BaseItemsTable";
-import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import AdminS from "metabase/css/admin.module.css";
-import CS from "metabase/css/core/index.css";
+import { useScrollToTop, useSortingStateChange } from "metabase/common/hooks";
+import { MonitorEmptyState } from "metabase/monitor/components/MonitorEmptyState";
import { TaskStatusBadge } from "metabase/monitor/tools/components/TaskStatusBadge";
import { useDispatch } from "metabase/redux";
import { push } from "metabase/router";
-import { Box, Ellipsified, Flex } from "metabase/ui";
+import {
+ Card,
+ Ellipsified,
+ Text,
+ TreeTable,
+ type TreeTableColumnDef,
+ TreeTableSkeleton,
+ useTreeTableInstance,
+} from "metabase/ui";
import * as Urls from "metabase/urls";
import { EMPTY_CELL_PLACEHOLDER } from "metabase/utils/constants";
import type {
@@ -20,10 +27,15 @@ import type {
Task,
} from "metabase-types/api";
+import { DEFAULT_SORTING, TASK_SORT_COLUMNS } from "./utils";
+
+const COLUMN_WIDTHS = [0.25, 0.15, 0.12, 0.16, 0.16, 0.1, 0.06];
+
interface Props {
databases: Database[];
- error: unknown;
+ isFetching: boolean;
isLoading: boolean;
+ page: number;
sortingOptions: SortingOptions<ListTasksSortColumn>;
tasks: Task[];
onSortingOptionsChange: (
@@ -33,129 +45,188 @@ interface Props {
export const TasksTable = ({
databases,
- error,
+ isFetching,
isLoading,
+ page,
sortingOptions,
tasks,
onSortingOptionsChange,
}: Props) => {
- // index databases by id for lookup
- const databaseByID: Record<number, Database> = _.indexBy(databases, "id");
- const showLoadingAndErrorWrapper = isLoading || error != null;
const dispatch = useDispatch();
- const onClickTask = (task: Task) => {
- dispatch(push(Urls.adminToolsTaskDetails(task.id)));
- };
+ const databaseByID: Record<number, Database> = useMemo(
+ () => _.indexBy(databases, "id"),
+ [databases],
+ );
- return (
- <table
- className={cx(AdminS.ContentTable, CS.mt2)}
- data-testid="tasks-table"
- >
- <thead>
- <tr>
- {/* set width to limit CLS when changing sort direction */}
- <Box component="th" w={300}>{t`Task`}</Box>
- <th>{t`DB Name`}</th>
- <th>{t`DB Engine`}</th>
- <SortableColumnHeader
- name="started_at"
- sortingOptions={sortingOptions}
- onSortingOptionsChange={onSortingOptionsChange}
- >{t`Started at`}</SortableColumnHeader>
- <SortableColumnHeader
- name="ended_at"
- sortingOptions={sortingOptions}
- onSortingOptionsChange={onSortingOptionsChange}
- >{t`Ended at`}</SortableColumnHeader>
- <SortableColumnHeader
- name="duration"
- sortingOptions={sortingOptions}
- onSortingOptionsChange={onSortingOptionsChange}
- >{t`Duration (ms)`}</SortableColumnHeader>
- <th>{t`Status`}</th>
- </tr>
- </thead>
+ const columns = useMemo(() => getColumns(databaseByID), [databaseByID]);
+ const { sortingState, onSortingChange } = useSortingStateChange({
+ sortingOptions,
+ columns: TASK_SORT_COLUMNS,
+ defaultSorting: DEFAULT_SORTING,
+ onSortingOptionsChange,
+ });
- <tbody>
- {showLoadingAndErrorWrapper && (
- <tr>
- <td colSpan={7}>
- <LoadingAndErrorWrapper loading={isLoading} error={error} />
- </td>
- </tr>
- )}
+ const handleRowActivate = useCallback(
+ (row: Row<Task>) => {
+ dispatch(push(Urls.monitorTaskDetails(row.original.id)));
+ },
+ [dispatch],
+ );
- {!showLoadingAndErrorWrapper && (
- <>
- {tasks.length === 0 && (
- <tr>
- <td colSpan={8}>
- <Flex
- c="text-disabled"
- justify="center"
- >{t`No results`}</Flex>
- </td>
- </tr>
- )}
+ const treeTableInstance = useTreeTableInstance<Task>({
+ data: tasks,
+ columns,
+ sorting: sortingState,
+ manualSorting: true,
+ getNodeId: (task) => String(task.id),
+ onRowActivate: handleRowActivate,
+ onSortingChange,
+ });
- {tasks.map((task: Task) => {
- const db = task.db_id ? databaseByID[task.db_id] : null;
- const name = db ? db.name : null;
- const engine = db ? db.engine : null;
- // only want unknown if there is a db on the task and we don't have info
- return (
- <tr
- data-testid="task"
- key={task.id}
- className={CS.cursorPointer}
- onClick={() => onClickTask(task)}
- >
- <td className={CS.textBold}>{task.task}</td>
- <td>{task.db_id ? name || t`Unknown name` : null}</td>
- <td>{task.db_id ? engine || t`Unknown engine` : null}</td>
+ useScrollToTop({
+ ref: treeTableInstance.containerRef,
+ keys: [page, sortingOptions],
+ skip: isFetching,
+ });
- <td>
- <Ellipsified
- style={{ maxWidth: 180 }}
- alwaysShowTooltip
- tooltip={task.started_at}
- >
- <DateTime
- value={task.started_at}
- unit="minute"
- data-testid="started-at"
- />
- </Ellipsified>
- </td>
- <td>
- {task.ended_at ? (
- <Ellipsified
- style={{ maxWidth: 180 }}
- alwaysShowTooltip={Boolean(task.ended_at)}
- tooltip={task.ended_at}
- >
- <DateTime
- value={task.ended_at}
- unit="minute"
- data-testid="ended-at"
- />
- </Ellipsified>
- ) : (
- EMPTY_CELL_PLACEHOLDER
- )}
- </td>
- <td>{task.duration}</td>
- <td>
- <TaskStatusBadge task={task} />
- </td>
- </tr>
- );
- })}
- </>
- )}
- </tbody>
- </table>
+ return (
+ <Card flex="0 1 auto" mih={0} p={0} withBorder data-testid="tasks-table">
+ {isLoading ? (
+ <TreeTableSkeleton columnWidths={COLUMN_WIDTHS} />
+ ) : (
+ <TreeTable
+ instance={treeTableInstance}
+ hierarchical={false}
+ ariaLabel={t`Tasks`}
+ emptyState={<MonitorEmptyState label={t`No results`} />}
+ getRowProps={() => ({ "data-testid": "task" })}
+ onRowClick={handleRowActivate}
+ />
+ )}
+ </Card>
);
};
+
+function getColumns(
+ databaseByID: Record<number, Database>,
+): TreeTableColumnDef<Task>[] {
+ return [
+ {
+ id: "task",
+ header: t`Task`,
+ width: "auto",
+ minWidth: 200,
+ maxAutoWidth: 230,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (task) => task.task,
+ cell: ({ row }) => <Text>{row.original.task}</Text>,
+ },
+ {
+ id: "db_name",
+ header: t`DB Name`,
+ width: "auto",
+ minWidth: 120,
+ maxAutoWidth: 240,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (task) =>
+ task.db_id !== null ? (databaseByID[task.db_id]?.name ?? "") : "",
+ cell: ({ row }) => {
+ const { db_id } = row.original;
+ // only want unknown if there is a db on the task and we don't have info
+ if (db_id === null) {
+ return null;
+ }
+ return databaseByID[db_id]?.name || t`Unknown name`;
+ },
+ },
+ {
+ id: "db_engine",
+ header: t`DB Engine`,
+ width: "auto",
+ minWidth: 120,
+ maxAutoWidth: 240,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (task) =>
+ task.db_id !== null ? (databaseByID[task.db_id]?.engine ?? "") : "",
+ cell: ({ row }) => {
+ const { db_id } = row.original;
+ if (db_id === null) {
+ return null;
+ }
+ return databaseByID[db_id]?.engine || t`Unknown engine`;
+ },
+ },
+ {
+ id: "started_at",
+ header: t`Started at`,
+ width: "auto",
+ minWidth: 150,
+ enableSorting: true,
+ sortDescFirst: true,
+ accessorFn: (task) => task.started_at,
+ cell: ({ row }) => (
+ <Ellipsified
+ style={{ maxWidth: 180 }}
+ alwaysShowTooltip
+ tooltip={row.original.started_at}
+ >
+ <DateTime
+ value={row.original.started_at}
+ unit="minute"
+ data-testid="started-at"
+ />
+ </Ellipsified>
+ ),
+ },
+ {
+ id: "ended_at",
+ header: t`Ended at`,
+ width: "auto",
+ minWidth: 150,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (task) => task.ended_at,
+ cell: ({ row }) =>
+ row.original.ended_at ? (
+ <Ellipsified
+ style={{ maxWidth: 180 }}
+ alwaysShowTooltip
+ tooltip={row.original.ended_at}
+ >
+ <DateTime
+ value={row.original.ended_at}
+ unit="minute"
+ data-testid="ended-at"
+ />
+ </Ellipsified>
+ ) : (
+ EMPTY_CELL_PLACEHOLDER
+ ),
+ },
+ {
+ id: "duration",
+ header: t`Duration (ms)`,
+ width: "auto",
+ minWidth: 80,
+ maxAutoWidth: 100,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (task) => task.duration,
+ cell: ({ row }) => row.original.duration,
+ },
+ {
+ id: "status",
+ header: t`Status`,
+ width: "auto",
+ minWidth: 100,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (task) => task.status,
+ cell: ({ row }) => <TaskStatusBadge task={row.original} />,
+ },
+ ];
+}
diff --git a/frontend/src/metabase/monitor/tools/components/TaskListPage/utils.ts b/frontend/src/metabase/monitor/tools/components/TaskListPage/utils.ts
index f831fbb6420..78d56651131 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskListPage/utils.ts
+++ b/frontend/src/metabase/monitor/tools/components/TaskListPage/utils.ts
@@ -2,16 +2,35 @@ import {
type QueryParam,
type UrlStateConfig,
getFirstParamValue,
+ parsePage,
+ parseSortColumn,
+ parseSortDirection,
} from "metabase/common/hooks/use-url-state";
import type {
ListTasksSortColumn,
SortDirection,
+ SortingOptions,
TaskStatus,
} from "metabase-types/api";
+export const TASK_SORT_COLUMNS = [
+ "started_at",
+ "ended_at",
+ "duration",
+ "task",
+ "status",
+ "db_name",
+ "db_engine",
+] satisfies readonly ListTasksSortColumn[];
+
const DEFAULT_SORT_COLUMN: ListTasksSortColumn = "started_at";
const DEFAULT_SORT_DIRECTION = "desc";
+export const DEFAULT_SORTING: SortingOptions<ListTasksSortColumn> = {
+ sort_column: DEFAULT_SORT_COLUMN,
+ sort_direction: DEFAULT_SORT_DIRECTION,
+};
+
type UrlState = {
page: number;
sort_column: ListTasksSortColumn;
@@ -23,8 +42,15 @@ type UrlState = {
export const urlStateConfig: UrlStateConfig<UrlState> = {
parse: (query) => ({
page: parsePage(query.page),
- sort_column: parseSortColumn(query.sort_column),
- sort_direction: parseSortDirection(query.sort_direction),
+ sort_column: parseSortColumn(
+ query.sort_column,
+ TASK_SORT_COLUMNS,
+ DEFAULT_SORT_COLUMN,
+ ),
+ sort_direction: parseSortDirection(
+ query.sort_direction,
+ DEFAULT_SORT_DIRECTION,
+ ),
status: parseStatus(query.status),
task: parseTask(query.task),
}),
@@ -38,26 +64,6 @@ export const urlStateConfig: UrlStateConfig<UrlState> = {
}),
};
-function parsePage(param: QueryParam): UrlState["page"] {
- const value = getFirstParamValue(param);
- const parsed = parseInt(value || "0", 10);
- return Number.isFinite(parsed) && parsed >= 0 ? parsed : 0;
-}
-
-function parseSortColumn(param: QueryParam): UrlState["sort_column"] {
- const value = getFirstParamValue(param);
- return value && isSortColumn(value) ? value : DEFAULT_SORT_COLUMN;
-}
-
-function isSortColumn(value: string): value is ListTasksSortColumn {
- return ["started_at", "ended_at", "duration"].includes(value);
-}
-
-function parseSortDirection(param: QueryParam): UrlState["sort_direction"] {
- const value = getFirstParamValue(param);
- return value === "asc" ? "asc" : DEFAULT_SORT_DIRECTION;
-}
-
function parseStatus(param: QueryParam): UrlState["status"] {
const value = getFirstParamValue(param);
return value && isTaskStatus(value) ? value : null;
diff --git a/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.module.css b/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.module.css
new file mode 100644
index 00000000000..742ade34171
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.module.css
@@ -0,0 +1,3 @@
+.content {
+ overflow: auto;
+}
diff --git a/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.tsx b/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.tsx
index 476cf163e80..82a3586bf18 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.tsx
@@ -1,26 +1,18 @@
import cx from "classnames";
import { t } from "ttag";
-import { SettingsSection } from "metabase/admin/components/SettingsSection";
import { useGetTaskRunQuery } from "metabase/api";
import { CopyButton } from "metabase/common/components/CopyButton";
import { DateTime } from "metabase/common/components/DateTime";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import AdminS from "metabase/css/admin.module.css";
import CS from "metabase/css/core/index.css";
+import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
+import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
+import { MonitorPageContent } from "metabase/monitor/components/MonitorPageContent";
import { useDispatch } from "metabase/redux";
import { Link, push } from "metabase/router";
-import {
- Anchor,
- Box,
- Flex,
- Grid,
- Icon,
- Stack,
- Text,
- Title,
- Tooltip,
-} from "metabase/ui";
+import { Anchor, Box, Flex, Grid, Stack, Text, Tooltip } from "metabase/ui";
import * as Urls from "metabase/urls";
import { EMPTY_CELL_PLACEHOLDER } from "metabase/utils/constants";
import type { Task } from "metabase-types/api";
@@ -31,9 +23,12 @@ import {
getEntityUrl,
renderTaskRunCounters,
} from "../../utils";
+import { MonitorBackLink } from "../MonitorBackLink";
import { TaskRunStatusBadge } from "../TaskRunStatusBadge";
import { TaskStatusBadge } from "../TaskStatusBadge";
+import S from "./TaskRunDetailsPage.module.css";
+
type TaskRunDetailsPageProps = {
params: { runId: number };
};
@@ -43,7 +38,7 @@ export const TaskRunDetailsPage = ({ params }: TaskRunDetailsPageProps) => {
const dispatch = useDispatch();
const onClickTask = (task: Task) => {
- dispatch(push(Urls.adminToolsTaskDetails(task.id)));
+ dispatch(push(Urls.monitorTaskDetails(task.id)));
};
if (!taskRun || error || isLoading) {
@@ -51,124 +46,121 @@ export const TaskRunDetailsPage = ({ params }: TaskRunDetailsPageProps) => {
}
return (
- <SettingsSection>
- <Flex align="center" gap="sm">
- <Link to={Urls.adminToolsTasksRuns()}>
- <Flex align="center" gap="xs" c="text-secondary">
- <Icon name="chevronleft" />
- {t`Back to Runs`}
- </Flex>
- </Link>
- </Flex>
+ <Flex h="100%" wrap="nowrap">
+ <MonitorMain gap="lg">
+ <MonitorBackLink to={Urls.monitorTasksRuns()} label={t`Back to Runs`} />
- <Grid>
- <Grid.Col span={{ base: 12, lg: "content" }} maw="50%">
- <Title order={3} mb="md">{t`Run details`}</Title>
- <Stack gap="sm">
- <Flex gap="md">
- <Text fw="bold" w={120}>{t`ID`}</Text>
- <Text>{taskRun.id}</Text>
- </Flex>
- <Flex gap="md">
- <Text fw="bold" w={120}>{t`Run type`}</Text>
- <Text>{formatTaskRunType(taskRun.run_type)}</Text>
- </Flex>
- <Flex gap="md">
- <Text fw="bold" w={120}>{t`Entity type`}</Text>
- <Text>{formatTaskRunEntityType(taskRun.entity_type)}</Text>
- </Flex>
- <Flex gap="md" align="baseline">
- <Text fw="bold" w={120}>{t`Entity`}</Text>
- <Anchor
- component={Link}
- to={getEntityUrl(
- taskRun.entity_type,
- taskRun.entity_id,
- taskRun.entity_name,
- )}
- >
- {taskRun.entity_name ?? taskRun.entity_id}
- </Anchor>
- </Flex>
- <Flex gap="md" align="center">
- <Text fw="bold" w={120}>{t`Status`}</Text>
- <TaskRunStatusBadge taskRun={taskRun} />
- </Flex>
- <Flex gap="md">
- <Text fw="bold" w={120}>{t`Started at`}</Text>
- <Tooltip label={taskRun.started_at}>
- <DateTime
- value={taskRun.started_at}
- unit="minute"
- data-testid="started-at"
- />
- </Tooltip>
- <CopyButton value={taskRun.started_at} />
- </Flex>
- <Flex gap="md">
- <Text fw="bold" w={120}>{t`Ended at`}</Text>
- {taskRun.ended_at ? (
- <>
- <Tooltip label={taskRun.ended_at}>
+ <MonitorPageContent className={S.content}>
+ <Grid>
+ <Grid.Col span={{ base: 12, lg: "content" }} maw="50%">
+ <MonitorHeaderTitle mb="md">{t`Run details`}</MonitorHeaderTitle>
+ <Stack gap="sm">
+ <Flex gap="md">
+ <Text fw="bold" w={120}>{t`ID`}</Text>
+ <Text>{taskRun.id}</Text>
+ </Flex>
+ <Flex gap="md">
+ <Text fw="bold" w={120}>{t`Run type`}</Text>
+ <Text>{formatTaskRunType(taskRun.run_type)}</Text>
+ </Flex>
+ <Flex gap="md">
+ <Text fw="bold" w={120}>{t`Entity type`}</Text>
+ <Text>{formatTaskRunEntityType(taskRun.entity_type)}</Text>
+ </Flex>
+ <Flex gap="md" align="baseline">
+ <Text fw="bold" w={120}>{t`Entity`}</Text>
+ <Anchor
+ component={Link}
+ to={getEntityUrl(
+ taskRun.entity_type,
+ taskRun.entity_id,
+ taskRun.entity_name ?? undefined,
+ )}
+ >
+ {taskRun.entity_name ?? taskRun.entity_id}
+ </Anchor>
+ </Flex>
+ <Flex gap="md" align="center">
+ <Text fw="bold" w={120}>{t`Status`}</Text>
+ <TaskRunStatusBadge taskRun={taskRun} />
+ </Flex>
+ <Flex gap="md">
+ <Text fw="bold" w={120}>{t`Started at`}</Text>
+ <Tooltip label={taskRun.started_at}>
<DateTime
- value={taskRun.ended_at}
+ value={taskRun.started_at}
unit="minute"
- data-testid="ended-at"
+ data-testid="started-at"
/>
</Tooltip>
- <CopyButton value={taskRun.ended_at} />
- </>
- ) : (
- EMPTY_CELL_PLACEHOLDER
- )}
- </Flex>
- <Flex gap="md">
- <Text fw="bold" w={120}>{t`Task count`}</Text>
- <Text>{renderTaskRunCounters(taskRun)}</Text>
- </Flex>
- </Stack>
- </Grid.Col>
+ <CopyButton value={taskRun.started_at} />
+ </Flex>
+ <Flex gap="md">
+ <Text fw="bold" w={120}>{t`Ended at`}</Text>
+ {taskRun.ended_at ? (
+ <>
+ <Tooltip label={taskRun.ended_at}>
+ <DateTime
+ value={taskRun.ended_at}
+ unit="minute"
+ data-testid="ended-at"
+ />
+ </Tooltip>
+ <CopyButton value={taskRun.ended_at} />
+ </>
+ ) : (
+ EMPTY_CELL_PLACEHOLDER
+ )}
+ </Flex>
+ <Flex gap="md">
+ <Text fw="bold" w={120}>{t`Task count`}</Text>
+ <Text>{renderTaskRunCounters(taskRun)}</Text>
+ </Flex>
+ </Stack>
+ </Grid.Col>
- <Grid.Col span={{ base: 12, lg: "auto" }}>
- <Title order={3} mb="md">{t`Associated tasks`}</Title>
- <table
- className={cx(AdminS.ContentTable)}
- data-testid="task-run-tasks-table"
- >
- <thead>
- <tr>
- <Box component="th" w={200}>{t`Task`}</Box>
- <th>{t`Status`}</th>
- </tr>
- </thead>
- <tbody>
- {taskRun.tasks.length === 0 && (
- <tr>
- <td colSpan={2}>
- <Flex
- c="text-disabled"
- justify="center"
- >{t`No tasks`}</Flex>
- </td>
- </tr>
- )}
- {taskRun.tasks.map((task) => (
- <tr
- key={task.id}
- className={CS.cursorPointer}
- data-testid="task-run-task"
- onClick={() => onClickTask(task)}
- >
- <td className={CS.textBold}>{task.task}</td>
- <td>
- <TaskStatusBadge task={task} />
- </td>
- </tr>
- ))}
- </tbody>
- </table>
- </Grid.Col>
- </Grid>
- </SettingsSection>
+ <Grid.Col span={{ base: 12, lg: "auto" }}>
+ <MonitorHeaderTitle mb="md">{t`Associated tasks`}</MonitorHeaderTitle>
+ <table
+ className={cx(AdminS.ContentTable)}
+ data-testid="task-run-tasks-table"
+ >
+ <thead>
+ <tr>
+ <Box component="th" w={200}>{t`Task`}</Box>
+ <th>{t`Status`}</th>
+ </tr>
+ </thead>
+ <tbody>
+ {taskRun.tasks.length === 0 && (
+ <tr>
+ <td colSpan={2}>
+ <Flex
+ c="text-disabled"
+ justify="center"
+ >{t`No tasks`}</Flex>
+ </td>
+ </tr>
+ )}
+ {taskRun.tasks.map((task) => (
+ <tr
+ key={task.id}
+ className={CS.cursorPointer}
+ data-testid="task-run-task"
+ onClick={() => onClickTask(task)}
+ >
+ <td className={CS.textBold}>{task.task}</td>
+ <td>
+ <TaskStatusBadge task={task} />
+ </td>
+ </tr>
+ ))}
+ </tbody>
+ </table>
+ </Grid.Col>
+ </Grid>
+ </MonitorPageContent>
+ </MonitorMain>
+ </Flex>
);
};
diff --git a/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.unit.spec.tsx b/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.unit.spec.tsx
index 46c3620132a..63fbdd19a33 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.unit.spec.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskRunDetailsPage/TaskRunDetailsPage.unit.spec.tsx
@@ -25,7 +25,7 @@ jest.mock("@mantine/hooks", () => ({
// Unjustified type cast. FIXME
const mockUseClipboard = useClipboard as jest.Mock;
-const PATHNAME = `${Urls.adminToolsTasksRuns()}/:runId`;
+const PATHNAME = `${Urls.monitorTasksRuns()}/:runId`;
interface SetupOpts {
taskRun?: TaskRunExtended;
@@ -37,7 +37,7 @@ const setup = ({ taskRun = createMockTaskRunExtended() }: SetupOpts = {}) => {
return renderWithProviders(
<Route path={PATHNAME} element={<RoutedTaskRunDetailsPage />} />,
{
- initialRoute: Urls.adminToolsTaskRunDetails(taskRun.id),
+ initialRoute: Urls.monitorTaskRunDetails(taskRun.id),
withRouter: true,
},
);
@@ -53,6 +53,17 @@ describe("TaskRunDetailsPage", () => {
});
});
+ it("should show a link back to the runs list", async () => {
+ setup();
+
+ await waitForLoaderToBeRemoved();
+
+ expect(screen.getByRole("link", { name: /Back to Runs/ })).toHaveAttribute(
+ "href",
+ Urls.monitorTasksRuns(),
+ );
+ });
+
it("should display formatted datetime for started_at and ended_at", async () => {
const taskRun = createMockTaskRunExtended({
started_at: "2023-03-04T01:45:26.005475-08:00",
diff --git a/frontend/src/metabase/monitor/tools/components/TaskRunEntityPicker/TaskRunEntityPicker.tsx b/frontend/src/metabase/monitor/tools/components/TaskRunEntityPicker/TaskRunEntityPicker.tsx
index bce4399dfc7..a6532f759b4 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskRunEntityPicker/TaskRunEntityPicker.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskRunEntityPicker/TaskRunEntityPicker.tsx
@@ -1,7 +1,8 @@
import { useMemo } from "react";
import { t } from "ttag";
-import { skipToken, useListTaskRunEntitiesQuery } from "metabase/api";
+import { skipToken, useLazyListTaskRunEntitiesQuery } from "metabase/api";
+import { useAbortableQuery } from "metabase/common/hooks/use-abortable-query";
import { Loader, Select, type SelectProps, Tooltip } from "metabase/ui";
import type { TaskRunDateFilterOption, TaskRunType } from "metabase-types/api";
@@ -34,13 +35,11 @@ export const TaskRunEntityPicker = ({
...props
}: TaskRunEntityPickerProps) => {
const effectiveStartedAt = toBackendStartedAt(startedAt, includeToday);
- const hasAllRequiredParams = runType && effectiveStartedAt;
- const { data: entities, isLoading } = useListTaskRunEntitiesQuery(
+ const hasAllRequiredParams = runType != null && effectiveStartedAt != null;
+ const { data: entities, isLoading } = useAbortableQuery(
+ useLazyListTaskRunEntitiesQuery,
hasAllRequiredParams
- ? {
- "run-type": runType,
- "started-at": effectiveStartedAt,
- }
+ ? { "run-type": runType, "started-at": effectiveStartedAt }
: skipToken,
);
diff --git a/frontend/src/metabase/monitor/tools/components/TaskRunEntityPicker/TaskRunEntityPicker.unit.spec.tsx b/frontend/src/metabase/monitor/tools/components/TaskRunEntityPicker/TaskRunEntityPicker.unit.spec.tsx
new file mode 100644
index 00000000000..564316ae7d7
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/components/TaskRunEntityPicker/TaskRunEntityPicker.unit.spec.tsx
@@ -0,0 +1,84 @@
+import fetchMock from "fetch-mock";
+
+import { renderWithProviders, screen, waitFor } from "__support__/ui";
+import type {
+ RunEntity,
+ TaskRunDateFilterOption,
+ TaskRunType,
+} from "metabase-types/api";
+
+import { TaskRunEntityPicker } from "./TaskRunEntityPicker";
+
+const ENTITIES: RunEntity[] = [
+ { entity_type: "database", entity_id: 1, entity_name: "Sample DB" },
+ { entity_type: "card", entity_id: 2, entity_name: "My question" },
+];
+
+function setup({
+ runType = "sync",
+ startedAt = "past7days",
+ includeToday = false,
+ entities = ENTITIES,
+}: {
+ runType?: TaskRunType | null;
+ startedAt?: TaskRunDateFilterOption | null;
+ includeToday?: boolean;
+ entities?: RunEntity[];
+} = {}) {
+ fetchMock.get("path:/api/task/runs/entities", entities);
+
+ const onChange = jest.fn();
+ renderWithProviders(
+ <TaskRunEntityPicker
+ runType={runType}
+ startedAt={startedAt}
+ includeToday={includeToday}
+ value={null}
+ onChange={onChange}
+ />,
+ );
+
+ return { onChange };
+}
+
+const getEntityCalls = () =>
+ fetchMock.callHistory.calls("path:/api/task/runs/entities");
+
+describe("TaskRunEntityPicker", () => {
+ it("does not request entities when the run type is missing", async () => {
+ setup({ runType: null });
+
+ await Promise.resolve();
+ expect(getEntityCalls()).toHaveLength(0);
+ expect(screen.getByPlaceholderText("Filter by entity")).toBeDisabled();
+ });
+
+ it("does not request entities when the start time is missing", async () => {
+ setup({ startedAt: null });
+
+ await Promise.resolve();
+ expect(getEntityCalls()).toHaveLength(0);
+ expect(screen.getByPlaceholderText("Filter by entity")).toBeDisabled();
+ });
+
+ it("requests entities with the resolved params once all are set", async () => {
+ setup({ runType: "sync", startedAt: "past7days" });
+
+ await waitFor(() => expect(getEntityCalls()).toHaveLength(1));
+
+ const url = getEntityCalls()[0].url;
+ expect(url).toContain("run-type=sync");
+ expect(url).toContain("started-at=past7days");
+
+ await waitFor(() =>
+ expect(screen.getByPlaceholderText("Filter by entity")).toBeEnabled(),
+ );
+ });
+
+ it("appends the include-today suffix to relative ranges", async () => {
+ setup({ runType: "sync", startedAt: "past7days", includeToday: true });
+
+ await waitFor(() => expect(getEntityCalls()).toHaveLength(1));
+ expect(getEntityCalls()[0].url).toContain("started-at=past7days%7E");
+ });
+});
diff --git a/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsPage.tsx b/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsPage.tsx
index efb08fa2789..67ccc0b5575 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsPage.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsPage.tsx
@@ -1,10 +1,13 @@
+import { useMemo } from "react";
import { t } from "ttag";
-import { useListTaskRunsQuery } from "metabase/api";
+import { useLazyListTaskRunsQuery } from "metabase/api";
+import { DelayedLoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper/DelayedLoadingAndErrorWrapper";
import { PaginationControls } from "metabase/common/components/PaginationControls";
+import { useAbortableQuery } from "metabase/common/hooks/use-abortable-query";
import { useUrlState } from "metabase/common/hooks/use-url-state";
import { useRouter } from "metabase/router";
-import { Flex } from "metabase/ui";
+import { Center, Flex, Group } from "metabase/ui";
import { toBackendStartedAt } from "../../utils";
import { TaskRunTypePicker } from "../RunTypePicker";
@@ -22,6 +25,8 @@ export const TaskRunsPage = () => {
const [
{
page,
+ sort_column,
+ sort_direction,
"run-type": runType,
"entity-type": entityType,
"entity-id": entityId,
@@ -31,15 +36,23 @@ export const TaskRunsPage = () => {
},
{ patchUrlState },
] = useUrlState(location, urlStateConfig);
+ const sortingOptions = useMemo(
+ () => ({ sort_column, sort_direction }),
+ [sort_column, sort_direction],
+ );
const {
data: taskRunsData,
+ isFetching,
isLoading,
error,
- } = useListTaskRunsQuery(
+ } = useAbortableQuery(
+ useLazyListTaskRunsQuery,
{
limit: PAGE_SIZE,
offset: page * PAGE_SIZE,
+ "sort-column": sort_column,
+ "sort-direction": sort_direction,
"run-type": runType ?? undefined,
"entity-type": entityType ?? undefined,
"entity-id": entityId ?? undefined,
@@ -58,68 +71,86 @@ export const TaskRunsPage = () => {
return (
<TasksTabs>
- <Flex gap="md" justify="space-between">
- <Flex gap="md">
- <TaskRunTypePicker
- value={runType}
- onChange={(runType) =>
- patchUrlState({
- "run-type": runType,
+ <Group gap="md" align="center" wrap="wrap">
+ <TaskRunTypePicker
+ value={runType}
+ onChange={(runType) =>
+ patchUrlState({
+ "run-type": runType,
+ "entity-type": null,
+ "entity-id": null,
+ page: 0,
+ })
+ }
+ />
+
+ <TaskRunDatePicker
+ value={startedAt}
+ includeToday={includeToday}
+ placeholder={t`Filter by started at`}
+ onChange={(nextStartedAt, nextIncludeToday) =>
+ patchUrlState({
+ "started-at": nextStartedAt,
+ "include-today": nextIncludeToday,
+ ...(nextStartedAt !== startedAt && {
"entity-type": null,
"entity-id": null,
- page: 0,
- })
- }
- />
-
- <TaskRunDatePicker
- value={startedAt}
- includeToday={includeToday}
- placeholder={t`Filter by started at`}
- onChange={(nextStartedAt, nextIncludeToday) =>
- patchUrlState({
- "started-at": nextStartedAt,
- "include-today": nextIncludeToday,
- ...(nextStartedAt !== startedAt && {
- "entity-type": null,
- "entity-id": null,
- }),
- page: 0,
- })
- }
- />
+ }),
+ page: 0,
+ })
+ }
+ />
- <TaskRunEntityPicker
- runType={runType}
- startedAt={startedAt}
- includeToday={includeToday}
- value={entityValue}
- onChange={(entity) =>
- patchUrlState({
- "entity-type": entity?.entityType ?? null,
- "entity-id": entity?.entityId ?? null,
- page: 0,
- })
- }
- />
+ <TaskRunEntityPicker
+ runType={runType}
+ startedAt={startedAt}
+ includeToday={includeToday}
+ value={entityValue}
+ onChange={(entity) =>
+ patchUrlState({
+ "entity-type": entity?.entityType ?? null,
+ "entity-id": entity?.entityId ?? null,
+ page: 0,
+ })
+ }
+ />
- <TaskRunStatusPicker
- value={status}
- onChange={(status) => patchUrlState({ status, page: 0 })}
- />
- </Flex>
+ <TaskRunStatusPicker
+ value={status}
+ onChange={(status) => patchUrlState({ status, page: 0 })}
+ />
+ </Group>
- <PaginationControls
- onPreviousPage={() => patchUrlState({ page: page - 1 })}
- onNextPage={() => patchUrlState({ page: page + 1 })}
+ {error !== undefined ? (
+ <Center flex={1}>
+ <DelayedLoadingAndErrorWrapper loading={isLoading} error={error} />
+ </Center>
+ ) : (
+ <TaskRunsTable
+ taskRuns={taskRuns}
+ isFetching={isFetching}
+ isLoading={isLoading}
page={page}
- pageSize={PAGE_SIZE}
- itemsLength={taskRuns.length}
- total={total}
+ sortingOptions={sortingOptions}
+ onSortingOptionsChange={(sortingOptions) =>
+ patchUrlState({ ...sortingOptions, page: 0 })
+ }
/>
- </Flex>
+ )}
- <TaskRunsTable taskRuns={taskRuns} isLoading={isLoading} error={error} />
+ {!isLoading && error === undefined && (
+ <Flex justify="end">
+ <PaginationControls
+ page={page}
+ pageSize={PAGE_SIZE}
+ itemsLength={taskRuns.length}
+ total={total}
+ showTotal
+ onPreviousPage={() => patchUrlState({ page: page - 1 })}
+ onNextPage={() => patchUrlState({ page: page + 1 })}
+ />
+ </Flex>
+ )}
</TasksTabs>
);
};
diff --git a/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsPage.unit.spec.tsx b/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsPage.unit.spec.tsx
index 1c3b7be181c..9f5e5f6ace1 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsPage.unit.spec.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsPage.unit.spec.tsx
@@ -3,11 +3,15 @@ import fetchMock from "fetch-mock";
import { setupTaskRunsEndpoints } from "__support__/server-mocks";
import {
+ act,
+ mockGetBoundingClientRect,
renderWithProviders,
screen,
waitFor,
waitForLoaderToBeRemoved,
+ within,
} from "__support__/ui";
+import { URL_UPDATE_DEBOUNCE_DELAY } from "metabase/common/hooks/use-url-state";
import { Route } from "metabase/router";
import * as Urls from "metabase/urls";
import type { ListTaskRunsResponse } from "metabase-types/api";
@@ -15,7 +19,7 @@ import { createMockTaskRun } from "metabase-types/api/mocks";
import { TaskRunsPage } from "./TaskRunsPage";
-const PATHNAME = Urls.adminToolsTasksRuns();
+const PATHNAME = Urls.monitorTasksRuns();
interface SetupOpts {
taskRunsResponse?: ListTaskRunsResponse;
@@ -34,8 +38,12 @@ const setup = ({
setupTaskRunsEndpoints(taskRunsResponse);
}
+ mockGetBoundingClientRect({ width: 100, height: 100 });
+
return renderWithProviders(
- <Route path={PATHNAME} element={<TaskRunsPage />} />,
+ <Route path={PATHNAME} element={<TaskRunsPage />}>
+ <Route path=":runId" />
+ </Route>,
{
initialRoute,
withRouter: true,
@@ -71,9 +79,7 @@ describe("TaskRunsPage", () => {
}),
});
- await waitForLoaderToBeRemoved();
-
- const startedAtElement = screen.getByTestId("started-at");
+ const startedAtElement = await screen.findByTestId("started-at");
const endedAtElement = screen.getByTestId("ended-at");
expect(startedAtElement).toHaveTextContent("March 4, 2023, 1:45 AM");
expect(endedAtElement).toHaveTextContent("March 4, 2023, 1:46 AM");
@@ -92,14 +98,211 @@ describe("TaskRunsPage", () => {
}),
});
- await waitForLoaderToBeRemoved();
-
- const startedAtElement = screen.getByTestId("started-at");
+ const startedAtElement = await screen.findByTestId("started-at");
await userEvent.hover(startedAtElement);
expect(await screen.findByRole("tooltip")).toHaveTextContent(rawTimestamp);
});
+ it("should show the total results count below the table", async () => {
+ setup({
+ taskRunsResponse: createMockTaskRunsResponse({
+ data: [createMockTaskRun()],
+ total: 75,
+ limit: 50,
+ offset: 0,
+ }),
+ });
+ await waitForLoaderToBeRemoved();
+
+ const pagination = screen.getByRole("navigation", { name: "pagination" });
+ expect(
+ within(pagination).getByTestId("pagination-total"),
+ ).toHaveTextContent("75");
+ expect(pagination).toHaveTextContent("1 - 1");
+ });
+
+ it("should navigate to run details when a row is clicked", async () => {
+ const { history } = setup({
+ taskRunsResponse: createMockTaskRunsResponse({
+ data: [createMockTaskRun({ id: 55 })],
+ }),
+ });
+
+ const row = await screen.findByTestId("task-run");
+ await userEvent.click(row);
+
+ expect(history?.getCurrentLocation().pathname).toBe(
+ Urls.monitorTaskRunDetails(55),
+ );
+ });
+
+ describe("sorting", () => {
+ beforeEach(() => {
+ jest.useFakeTimers({ advanceTimers: true });
+ });
+
+ afterEach(() => {
+ jest.useRealTimers();
+ });
+
+ it("requests the default sorting", async () => {
+ setup();
+
+ await waitFor(() => {
+ expect(fetchMock.callHistory.calls("path:/api/task/runs")).toHaveLength(
+ 1,
+ );
+ });
+
+ const params = getLastRunsParams();
+ expect(params.get("sort-column")).toBe("started_at");
+ expect(params.get("sort-direction")).toBe("desc");
+ });
+
+ it("accepts sorting query params", async () => {
+ setup({
+ initialRoute: `${PATHNAME}?sort_column=task_count&sort_direction=asc`,
+ });
+
+ await waitFor(() => {
+ expect(fetchMock.callHistory.calls("path:/api/task/runs")).toHaveLength(
+ 1,
+ );
+ });
+
+ const params = getLastRunsParams();
+ expect(params.get("sort-column")).toBe("task_count");
+ expect(params.get("sort-direction")).toBe("asc");
+ });
+
+ it("sorts by each sortable column", async () => {
+ const { history } = setup({
+ taskRunsResponse: createMockTaskRunsResponse({
+ data: [createMockTaskRun()],
+ }),
+ });
+
+ await waitFor(() => {
+ expect(fetchMock.callHistory.calls("path:/api/task/runs")).toHaveLength(
+ 1,
+ );
+ });
+
+ const cases: { header: RegExp; column: string }[] = [
+ { header: /Run Type/, column: "run_type" },
+ { header: /Entity/, column: "entity_name" },
+ { header: /Ended at/, column: "ended_at" },
+ { header: /Status/, column: "status" },
+ { header: /Task Count/, column: "task_count" },
+ ];
+
+ for (const { header, column } of cases) {
+ const columnHeader = screen.getByRole("columnheader", { name: header });
+ await userEvent.click(columnHeader);
+
+ await waitFor(() => {
+ expect(
+ screen.getByRole("columnheader", { name: header }),
+ ).toHaveAttribute("aria-sort", "ascending");
+ });
+ const params = getLastRunsParams();
+ expect(params.get("sort-column")).toBe(column);
+ expect(params.get("sort-direction")).toBe("asc");
+ act(() => {
+ jest.advanceTimersByTime(URL_UPDATE_DEBOUNCE_DELAY);
+ });
+ expect(history?.getCurrentLocation().search).toEqual(
+ `?sort_column=${column}&sort_direction=asc`,
+ );
+ }
+ });
+
+ it("toggles sort direction when clicking the active sorted column", async () => {
+ const { history } = setup({
+ taskRunsResponse: createMockTaskRunsResponse({
+ data: [createMockTaskRun()],
+ }),
+ });
+
+ const startedAtHeader = await screen.findByRole("columnheader", {
+ name: /Started at/,
+ });
+ expect(startedAtHeader).toHaveAttribute("aria-sort", "descending");
+
+ await userEvent.click(startedAtHeader);
+ await waitFor(() => {
+ expect(
+ screen.getByRole("columnheader", { name: /Started at/ }),
+ ).toHaveAttribute("aria-sort", "ascending");
+ });
+ expect(getLastRunsParams().get("sort-direction")).toBe("asc");
+ act(() => {
+ jest.advanceTimersByTime(URL_UPDATE_DEBOUNCE_DELAY);
+ });
+ expect(history?.getCurrentLocation().search).toEqual(
+ "?sort_direction=asc",
+ );
+
+ await userEvent.click(
+ screen.getByRole("columnheader", { name: /Started at/ }),
+ );
+ await waitFor(() => {
+ expect(
+ screen.getByRole("columnheader", { name: /Started at/ }),
+ ).toHaveAttribute("aria-sort", "descending");
+ });
+ expect(getLastRunsParams().get("sort-direction")).toBe("desc");
+ act(() => {
+ jest.advanceTimersByTime(URL_UPDATE_DEBOUNCE_DELAY);
+ });
+ expect(history?.getCurrentLocation().search).toEqual("");
+ });
+
+ it("resets pagination on sorting change", async () => {
+ const { history } = setup({
+ taskRunsResponse: createMockTaskRunsResponse({
+ data: [createMockTaskRun()],
+ total: 75,
+ limit: 50,
+ offset: 0,
+ }),
+ });
+
+ await waitFor(() => {
+ expect(fetchMock.callHistory.calls("path:/api/task/runs")).toHaveLength(
+ 1,
+ );
+ });
+
+ const nextPage = await screen.findByRole("button", { name: "Next page" });
+ await userEvent.click(nextPage);
+
+ await waitFor(() => {
+ expect(getLastRunsParams().get("offset")).toBe("50");
+ });
+ act(() => {
+ jest.advanceTimersByTime(URL_UPDATE_DEBOUNCE_DELAY);
+ });
+ expect(history?.getCurrentLocation().search).toEqual("?page=1");
+
+ await userEvent.click(
+ screen.getByRole("columnheader", { name: /Run Type/ }),
+ );
+
+ await waitFor(() => {
+ expect(getLastRunsParams().get("offset")).toBe("0");
+ });
+ expect(getLastRunsParams().get("sort-column")).toBe("run_type");
+ act(() => {
+ jest.advanceTimersByTime(URL_UPDATE_DEBOUNCE_DELAY);
+ });
+ expect(history?.getCurrentLocation().search).toEqual(
+ "?sort_column=run_type&sort_direction=asc",
+ );
+ });
+ });
+
describe("started-at filter with include-today", () => {
it("requests with the ~ suffix when today is included", async () => {
setup();
@@ -168,6 +371,50 @@ describe("TaskRunsPage", () => {
).toBeInTheDocument();
expect(getLastRunsParams().get("started-at")).toBe("past1weeks~");
});
+
+ it("does not append the ~ suffix for a this* range", async () => {
+ setup({
+ initialRoute: `${PATHNAME}?started-at=thisday&include-today=true`,
+ });
+ await waitForLoaderToBeRemoved();
+
+ expect(getLastRunsParams().get("started-at")).toBe("thisday");
+ });
+ });
+
+ describe("entity filter", () => {
+ it("ignores a lone entity-id without a matching entity-type", async () => {
+ setup({
+ initialRoute: `${PATHNAME}?entity-id=5`,
+ });
+ await waitForLoaderToBeRemoved();
+
+ const params = getLastRunsParams();
+ expect(params.get("entity-id")).toBeNull();
+ expect(params.get("entity-type")).toBeNull();
+ });
+
+ it("ignores a lone entity-type without a matching entity-id", async () => {
+ setup({
+ initialRoute: `${PATHNAME}?entity-type=card`,
+ });
+ await waitForLoaderToBeRemoved();
+
+ const params = getLastRunsParams();
+ expect(params.get("entity-id")).toBeNull();
+ expect(params.get("entity-type")).toBeNull();
+ });
+
+ it("forwards the entity pair when both are present", async () => {
+ setup({
+ initialRoute: `${PATHNAME}?entity-type=card&entity-id=5`,
+ });
+ await waitForLoaderToBeRemoved();
+
+ const params = getLastRunsParams();
+ expect(params.get("entity-type")).toBe("card");
+ expect(params.get("entity-id")).toBe("5");
+ });
});
});
diff --git a/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsTable.tsx b/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsTable.tsx
index ae5fd98e8aa..733de18f788 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsTable.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TaskRunsPage/TaskRunsTable.tsx
@@ -1,129 +1,207 @@
-import cx from "classnames";
+import type { Row } from "@tanstack/react-table";
+import { useCallback, useMemo } from "react";
import { t } from "ttag";
import { DateTime } from "metabase/common/components/DateTime";
-import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import AdminS from "metabase/css/admin.module.css";
-import CS from "metabase/css/core/index.css";
+import { useScrollToTop, useSortingStateChange } from "metabase/common/hooks";
+import { MonitorEmptyState } from "metabase/monitor/components/MonitorEmptyState";
import { useDispatch } from "metabase/redux";
import { push } from "metabase/router";
-import { Box, Ellipsified, Flex } from "metabase/ui";
+import {
+ Card,
+ Ellipsified,
+ Text,
+ TreeTable,
+ type TreeTableColumnDef,
+ TreeTableSkeleton,
+ useTreeTableInstance,
+} from "metabase/ui";
import * as Urls from "metabase/urls";
import { EMPTY_CELL_PLACEHOLDER } from "metabase/utils/constants";
-import type { TaskRun } from "metabase-types/api";
+import type {
+ ListTaskRunsSortColumn,
+ SortingOptions,
+ TaskRun,
+} from "metabase-types/api";
import { formatTaskRunType, renderTaskRunCounters } from "../../utils";
import { TaskRunStatusBadge } from "../TaskRunStatusBadge";
+import { DEFAULT_SORTING, TASK_RUN_SORT_COLUMNS } from "./utils";
+
+const COLUMN_WIDTHS = [0.2, 0.2, 0.17, 0.17, 0.13, 0.13];
+
type TaskRunsTableProps = {
- error: unknown;
+ isFetching: boolean;
isLoading: boolean;
+ page: number;
+ sortingOptions: SortingOptions<ListTaskRunsSortColumn>;
taskRuns: TaskRun[];
+ onSortingOptionsChange: (
+ sortingOptions: SortingOptions<ListTaskRunsSortColumn>,
+ ) => void;
};
export const TaskRunsTable = ({
- error,
+ isFetching,
isLoading,
+ page,
+ sortingOptions,
taskRuns,
+ onSortingOptionsChange,
}: TaskRunsTableProps) => {
- const showLoadingAndErrorWrapper = isLoading || error != null;
const dispatch = useDispatch();
- const onClickTaskRun = (taskRun: TaskRun) => {
- dispatch(push(Urls.adminToolsTaskRunDetails(taskRun.id)));
- };
+ const columns = useMemo(() => getColumns(), []);
+ const { sortingState, onSortingChange } = useSortingStateChange({
+ sortingOptions,
+ columns: TASK_RUN_SORT_COLUMNS,
+ defaultSorting: DEFAULT_SORTING,
+ onSortingOptionsChange,
+ });
- return (
- <table
- className={cx(AdminS.ContentTable, CS.mt2)}
- data-testid="task-runs-table"
- >
- <thead>
- <tr>
- <Box component="th" w={200}>{t`Run Type`}</Box>
- <Box component="th" w={200}>{t`Entity`}</Box>
- <th>{t`Started at`}</th>
- <th>{t`Ended at`}</th>
- <th>{t`Status`}</th>
- <th>{t`Task Count`}</th>
- </tr>
- </thead>
+ const handleRowActivate = useCallback(
+ (row: Row<TaskRun>) => {
+ dispatch(push(Urls.monitorTaskRunDetails(row.original.id)));
+ },
+ [dispatch],
+ );
- <tbody>
- {showLoadingAndErrorWrapper && (
- <tr>
- <td colSpan={6}>
- <LoadingAndErrorWrapper loading={isLoading} error={error} />
- </td>
- </tr>
- )}
+ const treeTableInstance = useTreeTableInstance<TaskRun>({
+ data: taskRuns,
+ columns,
+ sorting: sortingState,
+ manualSorting: true,
+ getNodeId: (taskRun) => String(taskRun.id),
+ onRowActivate: handleRowActivate,
+ onSortingChange,
+ });
- {!showLoadingAndErrorWrapper && (
- <>
- {taskRuns.length === 0 && (
- <tr>
- <td colSpan={6}>
- <Flex
- c="text-disabled"
- justify="center"
- >{t`No results`}</Flex>
- </td>
- </tr>
- )}
+ useScrollToTop({
+ ref: treeTableInstance.containerRef,
+ keys: [page, sortingOptions],
+ skip: isFetching,
+ });
- {taskRuns.map((taskRun) => (
- <tr
- data-testid="task-run"
- key={taskRun.id}
- className={CS.cursorPointer}
- onClick={() => onClickTaskRun(taskRun)}
- >
- <td className={CS.textBold}>
- {formatTaskRunType(taskRun.run_type)}
- </td>
- <td>
- <Ellipsified style={{ maxWidth: 200 }}>
- {taskRun.entity_name}
- </Ellipsified>
- </td>
- <td>
- <Ellipsified
- style={{ maxWidth: 180 }}
- alwaysShowTooltip
- tooltip={taskRun.started_at}
- >
- <DateTime
- value={taskRun.started_at}
- unit="minute"
- data-testid="started-at"
- />
- </Ellipsified>
- </td>
- <td>
- {taskRun.ended_at ? (
- <Ellipsified
- style={{ maxWidth: 180 }}
- tooltip={taskRun.ended_at}
- >
- <DateTime
- value={taskRun.ended_at}
- unit="minute"
- data-testid="ended-at"
- />
- </Ellipsified>
- ) : (
- EMPTY_CELL_PLACEHOLDER
- )}
- </td>
- <td>
- <TaskRunStatusBadge taskRun={taskRun} />
- </td>
- <td>{renderTaskRunCounters(taskRun)}</td>
- </tr>
- ))}
- </>
- )}
- </tbody>
- </table>
+ return (
+ <Card
+ flex="0 1 auto"
+ mih={0}
+ p={0}
+ withBorder
+ data-testid="task-runs-table"
+ >
+ {isLoading ? (
+ <TreeTableSkeleton columnWidths={COLUMN_WIDTHS} />
+ ) : (
+ <TreeTable
+ instance={treeTableInstance}
+ hierarchical={false}
+ ariaLabel={t`Task runs`}
+ emptyState={<MonitorEmptyState label={t`No results`} />}
+ getRowProps={() => ({ "data-testid": "task-run" })}
+ onRowClick={handleRowActivate}
+ />
+ )}
+ </Card>
);
};
+
+function getColumns(): TreeTableColumnDef<TaskRun>[] {
+ return [
+ {
+ id: "run_type",
+ header: t`Run Type`,
+ width: "auto",
+ minWidth: 150,
+ maxAutoWidth: 240,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (taskRun) => taskRun.run_type,
+ cell: ({ row }) => (
+ <Text>{formatTaskRunType(row.original.run_type)}</Text>
+ ),
+ },
+ {
+ id: "entity_name",
+ header: t`Entity`,
+ width: "auto",
+ minWidth: 150,
+ maxAutoWidth: 300,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (taskRun) => taskRun.entity_name ?? "",
+ cell: ({ row }) => (
+ <Ellipsified style={{ maxWidth: 200 }}>
+ {row.original.entity_name}
+ </Ellipsified>
+ ),
+ },
+ {
+ id: "started_at",
+ header: t`Started at`,
+ width: "auto",
+ minWidth: 150,
+ enableSorting: true,
+ sortDescFirst: true,
+ accessorFn: (taskRun) => taskRun.started_at,
+ cell: ({ row }) => (
+ <Ellipsified
+ style={{ maxWidth: 180 }}
+ alwaysShowTooltip
+ tooltip={row.original.started_at}
+ >
+ <DateTime
+ value={row.original.started_at}
+ unit="minute"
+ data-testid="started-at"
+ />
+ </Ellipsified>
+ ),
+ },
+ {
+ id: "ended_at",
+ header: t`Ended at`,
+ width: "auto",
+ minWidth: 150,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (taskRun) => taskRun.ended_at,
+ cell: ({ row }) =>
+ row.original.ended_at ? (
+ <Ellipsified
+ style={{ maxWidth: 180 }}
+ tooltip={row.original.ended_at}
+ >
+ <DateTime
+ value={row.original.ended_at}
+ unit="minute"
+ data-testid="ended-at"
+ />
+ </Ellipsified>
+ ) : (
+ EMPTY_CELL_PLACEHOLDER
+ ),
+ },
+ {
+ id: "status",
+ header: t`Status`,
+ width: "auto",
+ minWidth: 100,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (taskRun) => taskRun.status,
+ cell: ({ row }) => <TaskRunStatusBadge taskRun={row.original} />,
+ },
+ {
+ id: "task_count",
+ header: t`Task Count`,
+ width: "auto",
+ minWidth: 150,
+ enableSorting: true,
+ sortDescFirst: false,
+ accessorFn: (taskRun) => taskRun.task_count,
+ cell: ({ row }) => renderTaskRunCounters(row.original),
+ },
+ ];
+}
diff --git a/frontend/src/metabase/monitor/tools/components/TaskRunsPage/utils.ts b/frontend/src/metabase/monitor/tools/components/TaskRunsPage/utils.ts
index 1d2c73a09f5..796d7546e27 100644
--- a/frontend/src/metabase/monitor/tools/components/TaskRunsPage/utils.ts
+++ b/frontend/src/metabase/monitor/tools/components/TaskRunsPage/utils.ts
@@ -2,8 +2,14 @@ import {
type QueryParam,
type UrlStateConfig,
getFirstParamValue,
+ parsePage,
+ parseSortColumn,
+ parseSortDirection,
} from "metabase/common/hooks/use-url-state";
import type {
+ ListTaskRunsSortColumn,
+ SortDirection,
+ SortingOptions,
TaskRunDateFilterOption,
TaskRunEntityType,
TaskRunStatus,
@@ -17,8 +23,27 @@ import {
guardTaskRunStatus,
} from "../../utils";
+export const TASK_RUN_SORT_COLUMNS = [
+ "started_at",
+ "ended_at",
+ "run_type",
+ "status",
+ "entity_name",
+ "task_count",
+] satisfies readonly ListTaskRunsSortColumn[];
+
+const DEFAULT_SORT_COLUMN: ListTaskRunsSortColumn = "started_at";
+const DEFAULT_SORT_DIRECTION = "desc";
+
+export const DEFAULT_SORTING: SortingOptions<ListTaskRunsSortColumn> = {
+ sort_column: DEFAULT_SORT_COLUMN,
+ sort_direction: DEFAULT_SORT_DIRECTION,
+};
+
type UrlState = {
page: number;
+ sort_column: ListTaskRunsSortColumn;
+ sort_direction: SortDirection;
"run-type": TaskRunType | null;
"entity-type": TaskRunEntityType | null;
"entity-id": number | null;
@@ -28,17 +53,37 @@ type UrlState = {
};
export const urlStateConfig: UrlStateConfig<UrlState> = {
- parse: (query) => ({
- page: parsePage(query.page),
- "run-type": parseTaskRunRunType(query["run-type"]),
- "entity-type": parseTaskRunEntityType(query["entity-type"]),
- "entity-id": parseTaskRunEntityId(query["entity-id"]),
- status: parseTaskRunStatus(query.status),
- "started-at": parseTaskRunStartedAt(query["started-at"]),
- "include-today": parseIncludeToday(query["include-today"]),
- }),
+ parse: (query) => {
+ // entity-type and entity-id only filter meaningfully as a pair (the picker
+ // shows a value only when both are set, and the backend needs the type to
+ // interpret the id), so drop both when either is missing.
+ const entityType = parseTaskRunEntityType(query["entity-type"]);
+ const entityId = parseTaskRunEntityId(query["entity-id"]);
+ const hasEntityPair = entityType !== null && entityId !== null;
+
+ return {
+ page: parsePage(query.page),
+ sort_column: parseSortColumn(
+ query.sort_column,
+ TASK_RUN_SORT_COLUMNS,
+ DEFAULT_SORT_COLUMN,
+ ),
+ sort_direction: parseSortDirection(
+ query.sort_direction,
+ DEFAULT_SORT_DIRECTION,
+ ),
+ "run-type": parseTaskRunRunType(query["run-type"]),
+ "entity-type": hasEntityPair ? entityType : null,
+ "entity-id": hasEntityPair ? entityId : null,
+ status: parseTaskRunStatus(query.status),
+ "started-at": parseTaskRunStartedAt(query["started-at"]),
+ "include-today": parseIncludeToday(query["include-today"]),
+ };
+ },
serialize: ({
page,
+ sort_column,
+ sort_direction,
"run-type": runType,
"entity-type": entityType,
"entity-id": entityId,
@@ -47,6 +92,9 @@ export const urlStateConfig: UrlStateConfig<UrlState> = {
"include-today": includeToday,
}) => ({
page: page === 0 ? undefined : String(page),
+ sort_column: sort_column === DEFAULT_SORT_COLUMN ? undefined : sort_column,
+ sort_direction:
+ sort_direction === DEFAULT_SORT_DIRECTION ? undefined : sort_direction,
"run-type": runType === null ? undefined : runType,
"entity-type": entityType === null ? undefined : entityType,
"entity-id": entityId === null ? undefined : String(entityId),
@@ -56,12 +104,6 @@ export const urlStateConfig: UrlStateConfig<UrlState> = {
}),
};
-const parsePage = (param: QueryParam): UrlState["page"] => {
- const value = getFirstParamValue(param);
- const parsed = parseInt(value || "0", 10);
- return Number.isFinite(parsed) && parsed >= 0 ? parsed : 0;
-};
-
const parseTaskRunRunType = (param: QueryParam): UrlState["run-type"] => {
const value = getFirstParamValue(param);
return value && guardTaskRunRunType(value) ? value : null;
diff --git a/frontend/src/metabase/monitor/tools/components/TasksTabs/TasksTabs.tsx b/frontend/src/metabase/monitor/tools/components/TasksTabs/TasksTabs.tsx
index 1458532df36..b1888dedb12 100644
--- a/frontend/src/metabase/monitor/tools/components/TasksTabs/TasksTabs.tsx
+++ b/frontend/src/metabase/monitor/tools/components/TasksTabs/TasksTabs.tsx
@@ -1,62 +1,34 @@
+import type { ReactNode } from "react";
import { t } from "ttag";
import {
- SettingsPageWrapper,
- SettingsSection,
-} from "metabase/admin/components/SettingsSection";
-import { useDispatch } from "metabase/redux";
-import { push, useRouter } from "metabase/router";
-import { Flex, Icon, Tabs, Title, Tooltip } from "metabase/ui";
+ type MonitorHeaderTab,
+ MonitorHeaderTabs,
+} from "metabase/monitor/components/MonitorHeaderTabs";
+import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
+import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
+import { Flex, Stack } from "metabase/ui";
import * as Urls from "metabase/urls";
-type TabConfig = {
- value: string;
- label: string;
-};
-
type TasksTabsProps = {
- children: React.ReactNode;
+ children: ReactNode;
};
export const TasksTabs = ({ children }: TasksTabsProps) => {
- const { location } = useRouter();
- const tabs: TabConfig[] = [
- { value: Urls.adminToolsTasksList(), label: t`Tasks` },
- { value: Urls.adminToolsTasksRuns(), label: t`Runs` },
+ const tabs: MonitorHeaderTab[] = [
+ { label: t`Tasks`, to: Urls.monitorTasksList() },
+ { label: t`Runs`, to: Urls.monitorTasksRuns() },
];
- const DEFAULT_TAB = tabs[0].value;
- const dispatch = useDispatch();
- const activeTab =
- tabs.find(({ value }) => value === location.pathname)?.value ?? DEFAULT_TAB;
-
- const handleTabChange = (value: string | null) => {
- if (value) {
- dispatch(push(value));
- }
- };
return (
- <SettingsPageWrapper>
- <SettingsSection>
- <Flex align="center" gap="sm">
- <Title order={1}>{t`Troubleshooting logs`}</Title>
- <Tooltip
- label={t`Trying to get to the bottom of something? This section shows logs of Metabase's background tasks, which can help shed light on what's going on.`}
- >
- <Icon name="info" />
- </Tooltip>
- </Flex>
- <Tabs value={activeTab} onChange={handleTabChange}>
- <Tabs.List>
- {tabs.map((tab) => (
- <Tabs.Tab key={tab.value} value={tab.value}>
- {tab.label}
- </Tabs.Tab>
- ))}
- </Tabs.List>
- </Tabs>
+ <Flex h="100%" wrap="nowrap">
+ <MonitorMain>
+ <Stack gap="lg">
+ <MonitorHeaderTitle>{t`Background tasks`}</MonitorHeaderTitle>
+ <MonitorHeaderTabs tabs={tabs} />
+ </Stack>
{children}
- </SettingsSection>
- </SettingsPageWrapper>
+ </MonitorMain>
+ </Flex>
);
};
diff --git a/frontend/src/metabase/monitor/tools/components/ToolsApp.tsx b/frontend/src/metabase/monitor/tools/components/ToolsApp.tsx
deleted file mode 100644
index 3884791fe2f..00000000000
--- a/frontend/src/metabase/monitor/tools/components/ToolsApp.tsx
+++ /dev/null
@@ -1,84 +0,0 @@
-import { t } from "ttag";
-
-import { AdminSettingsLayout } from "metabase/admin/components/AdminLayout/AdminSettingsLayout";
-import {
- AdminNavItem,
- type AdminNavItemProps,
- AdminNavWrapper,
-} from "metabase/admin/components/AdminNav";
-import type { Location } from "metabase/router";
-import { Outlet } from "metabase/router";
-import * as Urls from "metabase/urls";
-
-type ToolsAppProps = {
- location: Location;
-};
-
-export function ToolsApp({ location }: ToolsAppProps) {
- return (
- <AdminSettingsLayout
- maw="100rem"
- fullWidth={location?.pathname === Urls.dependencyGraph()}
- sidebar={
- <AdminNavWrapper>
- <ToolsNavItem
- label={t`Help`}
- path={Urls.adminToolsHelp()}
- icon="info"
- location={location}
- />
- <ToolsNavItem
- label={t`Tasks`}
- path={Urls.adminToolsTasks()}
- icon="clipboard"
- location={location}
- />
- <ToolsNavItem
- label={t`Jobs`}
- path={Urls.adminToolsJobs()}
- icon="clock"
- location={location}
- />
- <ToolsNavItem
- label={t`Logs`}
- path={Urls.adminToolsLogs()}
- icon="audit"
- location={location}
- />
- <ToolsNavItem
- label={t`Erroring questions`}
- path={Urls.adminToolsErrors()}
- icon="warning_round_filled"
- location={location}
- />
- <ToolsNavItem
- label={t`Model cache log`}
- path={Urls.adminToolsModelCaching()}
- icon="database"
- location={location}
- />
- <ToolsNavItem
- label={t`Alerts management`}
- path={Urls.adminToolsNotifications()}
- icon="bell"
- location={location}
- />
- </AdminNavWrapper>
- }
- >
- <Outlet />
- </AdminSettingsLayout>
- );
-}
-
-type ToolsNavItemProps = AdminNavItemProps & {
- location: Location;
-};
-
-const ToolsNavItem = ({ location, ...props }: ToolsNavItemProps) => {
- // we want to highlight the nav item even if a subpath is active
- const subpath = location?.pathname;
- const isActive = !!props.path && subpath.includes(props.path);
-
- return <AdminNavItem {...props} active={isActive} />;
-};
diff --git a/frontend/src/metabase/monitor/tools/components/ToolsUpsell/ToolsUpsell.tsx b/frontend/src/metabase/monitor/tools/components/ToolsUpsell/ToolsUpsell.tsx
deleted file mode 100644
index 68f28288cab..00000000000
--- a/frontend/src/metabase/monitor/tools/components/ToolsUpsell/ToolsUpsell.tsx
+++ /dev/null
@@ -1,12 +0,0 @@
-import { t } from "ttag";
-
-import { SettingsPageWrapper } from "metabase/admin/components/SettingsSection";
-import { UpsellPerformanceTools } from "metabase/admin/upsells";
-
-export const ToolsUpsell = () => {
- return (
- <SettingsPageWrapper title={t`Erroring questions`}>
- <UpsellPerformanceTools source="settings-tools" />
- </SettingsPageWrapper>
- );
-};
diff --git a/frontend/src/metabase/monitor/tools/components/ToolsUpsell/index.ts b/frontend/src/metabase/monitor/tools/components/ToolsUpsell/index.ts
deleted file mode 100644
index 003fc2eed03..00000000000
--- a/frontend/src/metabase/monitor/tools/components/ToolsUpsell/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export * from "./ToolsUpsell";
diff --git a/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx b/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx
index c30960e63fb..5909ead473e 100644
--- a/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx
+++ b/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx
@@ -6,19 +6,18 @@ import {
useGetCardQuery,
} from "metabase/api";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import { ADMIN_NAVBAR_HEIGHT } from "metabase/nav/constants";
import { CreateOrEditQuestionAlertModal } from "metabase/notifications/modals/CreateOrEditQuestionAlertModal";
import { loadMetadataForCard } from "metabase/questions/actions";
import { useDispatch, useSelector } from "metabase/redux";
import { getMetadata } from "metabase/selectors/metadata";
-import { Drawer, Stack } from "metabase/ui";
+import { Flex, Stack } from "metabase/ui";
import Question from "metabase-lib/v1/Question";
import { trackAlertsManagementEditClicked } from "../analytics";
+import S from "./NotificationDetailSidebar.module.css";
import { SidebarBody } from "./SidebarBody";
import { SidebarHeader } from "./SidebarHeader";
-import { SIDEBAR_WIDTH } from "./constants";
import type { SidebarProps } from "./types";
export const NotificationDetailSidebar = ({
@@ -30,8 +29,11 @@ export const NotificationDetailSidebar = ({
onClose,
onDelete,
}: SidebarProps) => {
- const { currentData: detail, isFetching: isDetailFetching } =
- useAdminNotificationDetailQuery(notificationId);
+ const {
+ currentData: detail,
+ error: detailError,
+ isFetching: isDetailFetching,
+ } = useAdminNotificationDetailQuery(notificationId);
const notification = detail ?? notificationSummary;
const [isEditModalOpen, setIsEditModalOpen] = useState(false);
@@ -60,25 +62,19 @@ export const NotificationDetailSidebar = ({
return (
<>
- <Drawer
- opened
- onClose={onClose}
- position="right"
- size={SIDEBAR_WIDTH}
- withCloseButton={false}
- padding={0}
- withOverlay={false}
- lockScroll={false}
- shadow="lg"
- zIndex={100}
- styles={{
- inner: {
- top: ADMIN_NAVBAR_HEIGHT,
- height: `calc(100vh - ${ADMIN_NAVBAR_HEIGHT})`,
- },
+ <Flex
+ className={S.sidebar}
+ direction="column"
+ h="100%"
+ flex="1 1 auto"
+ miw={0}
+ style={{
+ borderLeft: "1px solid var(--mb-color-border-neutral)",
}}
+ bg="background_page-primary"
+ data-testid="notification-detail-sidebar"
>
- <Stack h="100%" p="lg" gap="lg">
+ <Stack h="100%" p="lg" gap="lg" style={{ overflowY: "auto" }}>
<SidebarHeader
isBulkLoading={isBulkLoading}
notificationId={notificationId}
@@ -93,17 +89,19 @@ export const NotificationDetailSidebar = ({
setIsEditModalOpen(true);
}}
/>
- {notification ? (
+ {detailError ? (
+ <LoadingAndErrorWrapper error={detailError} />
+ ) : notification ? (
<SidebarBody
notification={notification}
detail={detail}
isDetailFetching={isDetailFetching}
/>
) : (
- <LoadingAndErrorWrapper loading />
+ <LoadingAndErrorWrapper loading={isDetailFetching} />
)}
</Stack>
- </Drawer>
+ </Flex>
{isEditModalOpen && notification && question && (
<CreateOrEditQuestionAlertModal
editingNotification={notification}
diff --git a/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/NotificationRunSummaryLog.tsx b/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/NotificationRunSummaryLog.tsx
index 78831635ffc..0fc5bdfadd1 100644
--- a/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/NotificationRunSummaryLog.tsx
+++ b/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/NotificationRunSummaryLog.tsx
@@ -19,7 +19,7 @@ export const NotificationRunSummaryLog = ({
cardId,
onViewAllClick,
}: NotificationRunSummaryLogProps) => {
- const viewAllUrl = Urls.adminToolsTasksRunsFor({
+ const viewAllUrl = Urls.monitorTasksRunsFor({
runType: "alert",
entityType: "card",
entityId: cardId,
diff --git a/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/SidebarHeader.tsx b/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/SidebarHeader.tsx
index 3af00153b17..3e4bd88682b 100644
--- a/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/SidebarHeader.tsx
+++ b/frontend/src/metabase/monitor/tools/notifications/NotificationDetailSidebar/SidebarHeader.tsx
@@ -41,7 +41,7 @@ export const SidebarHeader = ({
const dispatch = useDispatch();
const handleCopyLink = async () => {
- const url = `${window.location.origin}${Urls.adminToolsNotificationDetail(notificationId)}`;
+ const url = `${window.location.origin}${Urls.monitorNotificationDetail(notificationId)}`;
await navigator.clipboard.writeText(url);
trackAlertsManagementLinkCopied(notificationId);
dispatch(addUndo({ message: t`Link copied to clipboard` }));
@@ -50,7 +50,7 @@ export const SidebarHeader = ({
const handleNavigate = (id: NotificationId | undefined) => {
if (id !== undefined) {
trackAlertsManagementAlertOpened(id, "sidebar_navigation");
- dispatch(push(Urls.adminToolsNotificationDetail(id)));
+ dispatch(push(Urls.monitorNotificationDetail(id)));
}
};
diff --git a/frontend/src/metabase/monitor/tools/notifications/NotificationsAdminPage/NotificationsAdminPage.tsx b/frontend/src/metabase/monitor/tools/notifications/NotificationsAdminPage/NotificationsAdminPage.tsx
index ad404c48a8b..c4d6b6f4a59 100644
--- a/frontend/src/metabase/monitor/tools/notifications/NotificationsAdminPage/NotificationsAdminPage.tsx
+++ b/frontend/src/metabase/monitor/tools/notifications/NotificationsAdminPage/NotificationsAdminPage.tsx
@@ -1,11 +1,12 @@
-import type { Row, SortingState } from "@tanstack/react-table";
+import { useElementSize } from "@mantine/hooks";
+import type { RowSelectionState, SortingState } from "@tanstack/react-table";
import { useCallback, useEffect, useMemo, useState } from "react";
import { t } from "ttag";
-import { SettingsPageWrapper } from "metabase/admin/components/SettingsSection";
import {
useAdminListNotificationsQuery,
useBulkNotificationActionMutation,
+ useLazyAdminListNotificationsQuery,
} from "metabase/api";
import {
BulkActionBar,
@@ -14,19 +15,18 @@ import {
} from "metabase/common/components/BulkActionBar";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { PaginationControls } from "metabase/common/components/PaginationControls";
+import { useAbortableQuery } from "metabase/common/hooks/use-abortable-query";
import { useConfirmation } from "metabase/common/hooks/use-confirmation";
import { useUrlState } from "metabase/common/hooks/use-url-state";
+import { MonitorHeaderTitle } from "metabase/monitor/components/MonitorHeaderTitle";
+import { MonitorMain } from "metabase/monitor/components/MonitorLayout";
+import { Sidebar } from "metabase/monitor/components/MonitorLayout/Sidebar";
import { useDispatch } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
-import type { WithRouterProps } from "metabase/router";
-import { push } from "metabase/router";
-import { Flex, type SelectionState, Title } from "metabase/ui";
+import { type WithRouterProps, push } from "metabase/router";
+import { Flex } from "metabase/ui";
import * as Urls from "metabase/urls";
-import type {
- AdminNotification,
- NotificationId,
- UserId,
-} from "metabase-types/api";
+import type { NotificationId, UserId } from "metabase-types/api";
import { ChangeOwnerModal } from "../ChangeOwnerModal";
import { NotificationDetailSidebar } from "../NotificationDetailSidebar";
@@ -56,46 +56,47 @@ export const NotificationsAdminPage = ({
params,
}: WithRouterProps<RouteParams>) => {
const notificationId = Urls.extractEntityId(params.notificationId);
+ const { ref: containerRef, width: containerWidth } = useElementSize();
const dispatch = useDispatch();
const [urlState, { patchUrlState }] = useUrlState(location, urlStateConfig);
- const [selectedIds, setSelectedIds] = useState<Set<NotificationId>>(
- new Set(),
- );
- const clearSelected = useCallback(() => setSelectedIds(new Set()), []);
- const getSelectionState = useCallback(
- (row: Row<AdminNotification>): SelectionState =>
- selectedIds.has(row.original.id) ? "all" : "none",
- [selectedIds],
- );
+ const [rowSelection, setRowSelection] = useState<RowSelectionState>({});
+ const clearSelected = useCallback(() => setRowSelection({}), []);
const [isChangeOwnerOpened, setIsChangeOwnerOpened] = useState(false);
const { modalContent: confirmContent, show: showConfirm } = useConfirmation();
- const { data, isLoading, isFetching, error } = useAdminListNotificationsQuery(
+ const { data, isLoading, isFetching, error } = useAbortableQuery(
+ useLazyAdminListNotificationsQuery,
buildListParams(urlState, PAGE_SIZE),
);
const notifications = useMemo(() => data?.data ?? [], [data?.data]);
const total = data?.total ?? 0;
- const selectedCount = selectedIds.size;
const selectedNotifications = useMemo(
- () => notifications.filter((n) => selectedIds.has(n.id)),
- [notifications, selectedIds],
+ () => notifications.filter((n) => rowSelection[String(n.id)]),
+ [notifications, rowSelection],
);
-
- const { data: failingData, isLoading: isFailingLoading } =
- useAdminListNotificationsQuery({
- limit: 1,
- offset: 0,
- active: true,
- last_check_status: "failing",
- });
- const { data: ownerlessData, isLoading: isOwnerlessLoading } =
- useAdminListNotificationsQuery({
- limit: 1,
- offset: 0,
- active: true,
- creatorless: true,
- });
+ const selectedCount = selectedNotifications.length;
+
+ const {
+ data: failingData,
+ error: failingError,
+ isLoading: isFailingLoading,
+ } = useAdminListNotificationsQuery({
+ limit: 1,
+ offset: 0,
+ active: urlState.active ?? undefined,
+ last_check_status: "failing",
+ });
+ const {
+ data: ownerlessData,
+ error: ownerlessError,
+ isLoading: isOwnerlessLoading,
+ } = useAdminListNotificationsQuery({
+ limit: 1,
+ offset: 0,
+ active: urlState.active ?? undefined,
+ creatorless: true,
+ });
const failingCount = failingData?.total ?? 0;
const ownerlessCount = ownerlessData?.total ?? 0;
@@ -165,29 +166,9 @@ export const NotificationsAdminPage = ({
[patchUrlState],
);
- const handleToggleRow = useCallback((id: NotificationId) => {
- setSelectedIds((prev) =>
- prev.has(id)
- ? new Set([...prev].filter((x) => x !== id))
- : new Set([...prev, id]),
- );
- }, []);
-
- const handleToggleAll = useCallback(() => {
- setSelectedIds((prev) => {
- const allIds = notifications.map((n) => n.id);
- const allSelected =
- allIds.length > 0 && allIds.every((id) => prev.has(id));
- if (allSelected) {
- return new Set();
- }
- return new Set([...prev, ...allIds]);
- });
- }, [notifications]);
-
const handleRowClick = (id: NotificationId) => {
trackAlertsManagementAlertOpened(id, "table_row");
- dispatch(push(Urls.adminToolsNotificationDetail(id)));
+ dispatch(push(Urls.monitorNotificationDetail(id)));
};
const handleSearchChange = (query: string) => {
@@ -197,9 +178,9 @@ export const NotificationsAdminPage = ({
patchUrlState({ query, page: 0 });
};
- const handleSidebarClose = () => {
- dispatch(push(Urls.adminToolsNotifications()));
- };
+ const handleSidebarClose = useCallback(() => {
+ dispatch(push(Urls.monitorNotifications()));
+ }, [dispatch]);
const deleteNotifications = useCallback(
async (
@@ -224,7 +205,7 @@ export const NotificationsAdminPage = ({
notificationId !== undefined &&
notificationIds.includes(notificationId)
) {
- dispatch(push(Urls.adminToolsNotifications()));
+ dispatch(push(Urls.monitorNotifications()));
}
} catch {
trackAlertsManagementAlertsDeleted(triggeredFrom, "failure", count);
@@ -302,13 +283,11 @@ export const NotificationsAdminPage = ({
);
const isSidebarOpen = notificationId !== undefined;
-
- if (isLoading || isFailingLoading || isOwnerlessLoading) {
- return <LoadingAndErrorWrapper loading />;
- }
+ const isPageLoading = isLoading || isFailingLoading || isOwnerlessLoading;
+ const countError = failingError ?? ownerlessError;
const { prevNotificationId, nextNotificationId, notificationSummary } =
- (() => {
+ useMemo(() => {
if (notificationId === undefined) {
return {
prevNotificationId: undefined,
@@ -332,71 +311,78 @@ export const NotificationsAdminPage = ({
: undefined,
notificationSummary: notifications[index],
};
- })();
+ }, [notificationId, notifications]);
- return (
- <SettingsPageWrapper pr={isSidebarOpen ? `${SIDEBAR_WIDTH}px` : 0}>
- <Flex align="center" gap="sm">
- <Title order={1}>{t`Alerts management`}</Title>
- </Flex>
-
- <NotificationsTabs
- tab={urlState.tab}
- failingCount={failingCount}
- ownerlessCount={ownerlessCount}
- onChange={(patch) => patchUrlState({ ...patch, page: 0 })}
- />
-
- <Flex gap="md" align="center">
- <NotificationsSearchInput
- value={urlState.query}
- isLoading={isFetching}
- onChange={handleSearchChange}
- />
- <NotificationsFilters state={urlState} onChange={patchUrlState} />
- </Flex>
-
- <NotificationsTable
- notifications={notifications}
- error={error}
- isLoading={isLoading}
- getSelectionState={getSelectionState}
- selectedDetailId={notificationId}
- sorting={sorting}
- onSortingChange={handleSortingChange}
- onToggleRow={handleToggleRow}
- onToggleAll={handleToggleAll}
- onRowClick={handleRowClick}
- />
+ if (isPageLoading || countError) {
+ return (
+ <LoadingAndErrorWrapper loading={isPageLoading} error={countError} />
+ );
+ }
- <Flex
- align="center"
- justify="space-between"
- p="md"
- data-testid="notifications-admin-footer"
- >
- <PaginationControls
- page={urlState.page}
- pageSize={PAGE_SIZE}
- itemsLength={notifications.length}
- total={total}
- onPreviousPage={() => patchUrlState({ page: urlState.page - 1 })}
- onNextPage={() => patchUrlState({ page: urlState.page + 1 })}
- />
+ return (
+ <>
+ <Flex ref={containerRef} h="100%" wrap="nowrap">
+ <MonitorMain>
+ <MonitorHeaderTitle mb="sm">{t`Alerts management`}</MonitorHeaderTitle>
+
+ <NotificationsTabs
+ tab={urlState.tab}
+ failingCount={failingCount}
+ ownerlessCount={ownerlessCount}
+ onChange={(patch) => patchUrlState({ ...patch, page: 0 })}
+ />
+
+ <Flex gap="md" align="center">
+ <NotificationsSearchInput
+ value={urlState.query}
+ isLoading={isFetching}
+ onChange={handleSearchChange}
+ />
+ <NotificationsFilters state={urlState} onChange={patchUrlState} />
+ </Flex>
+
+ <NotificationsTable
+ notifications={notifications}
+ error={error}
+ isFetching={isFetching}
+ isLoading={isLoading}
+ page={urlState.page}
+ rowSelection={rowSelection}
+ selectedDetailId={notificationId}
+ sorting={sorting}
+ onSortingChange={handleSortingChange}
+ onRowSelectionChange={setRowSelection}
+ onRowClick={handleRowClick}
+ />
+
+ <Flex justify="end">
+ <PaginationControls
+ page={urlState.page}
+ pageSize={PAGE_SIZE}
+ itemsLength={notifications.length}
+ total={total}
+ showTotal
+ onPreviousPage={() => patchUrlState({ page: urlState.page - 1 })}
+ onNextPage={() => patchUrlState({ page: urlState.page + 1 })}
+ />
+ </Flex>
+ </MonitorMain>
+
+ {isSidebarOpen && (
+ <Sidebar containerWidth={containerWidth} defaultWidth={SIDEBAR_WIDTH}>
+ <NotificationDetailSidebar
+ notificationId={notificationId}
+ notificationSummary={notificationSummary}
+ isBulkLoading={isBulkLoading}
+ prevNotificationId={prevNotificationId}
+ nextNotificationId={nextNotificationId}
+ onClose={handleSidebarClose}
+ onDelete={(notification) => handleSidebarDelete(notification.id)}
+ />
+ </Sidebar>
+ )}
</Flex>
- {isSidebarOpen && (
- <NotificationDetailSidebar
- notificationId={notificationId}
- notificationSummary={notificationSummary}
- isBulkLoading={isBulkLoading}
- prevNotificationId={prevNotificationId}
- nextNotificationId={nextNotificationId}
- onClose={handleSidebarClose}
- onDelete={(notification) => handleSidebarDelete(notification.id)}
- />
- )}
-
<BulkActionBar
opened={selectedCount > 0}
message={
@@ -430,6 +416,6 @@ export const NotificationsAdminPage = ({
/>
{confirmContent}
- </SettingsPageWrapper>
+ </>
);
};
diff --git a/frontend/src/metabase/monitor/tools/notifications/NotificationsAdminPage/NotificationsAdminPage.unit.spec.tsx b/frontend/src/metabase/monitor/tools/notifications/NotificationsAdminPage/NotificationsAdminPage.unit.spec.tsx
index d35131ade8e..85686c0352e 100644
--- a/frontend/src/metabase/monitor/tools/notifications/NotificationsAdminPage/NotificationsAdminPage.unit.spec.tsx
+++ b/frontend/src/metabase/monitor/tools/notifications/NotificationsAdminPage/NotificationsAdminPage.unit.spec.tsx
@@ -9,6 +9,7 @@ import {
} from "__support__/server-mocks";
import {
setupAdminNotificationDetailEndpoint,
+ setupAdminNotificationDetailErrorEndpoint,
setupBulkNotificationActionEndpoint,
} from "__support__/server-mocks/notification";
import {
@@ -21,9 +22,14 @@ import {
within,
} from "__support__/ui";
import { URL_UPDATE_DEBOUNCE_DELAY } from "metabase/common/hooks/use-url-state";
+import { MonitorContent } from "metabase/monitor/components/MonitorLayout/MonitorContent";
import { Route, withRouteProps } from "metabase/router";
import { SEARCH_DEBOUNCE_DURATION } from "metabase/utils/constants";
-import type { AdminNotification, UserListResult } from "metabase-types/api";
+import type {
+ AdminNotification,
+ NotificationId,
+ UserListResult,
+} from "metabase-types/api";
import {
createMockAdminNotification,
createMockCard,
@@ -41,7 +47,7 @@ import { PAGE_SIZE } from "./constants";
const RoutedNotificationsAdminPage = withRouteProps(NotificationsAdminPage);
-const PATHNAME = "/admin/tools/notifications";
+const PATHNAME = "/monitor/notifications";
const ANN = createMockUserInfo({
id: 1,
@@ -132,6 +138,8 @@ type SetupOpts = {
initialRoute?: string;
cardDelay?: number;
detailDelay?: number;
+ detailErrorId?: NotificationId;
+ failingCountError?: boolean;
};
const setup = ({
@@ -143,6 +151,8 @@ const setup = ({
initialRoute = PATHNAME,
cardDelay,
detailDelay,
+ detailErrorId,
+ failingCountError = false,
}: SetupOpts = {}) => {
fetchMock.get("path:/api/notification/admin", (call) => {
const params = new URL(call.url).searchParams;
@@ -150,7 +160,9 @@ const setup = ({
params.get("limit") === "1" &&
params.get("last_check_status") === "failing"
) {
- return { data: [], total: failingCount, limit: 1, offset: 0 };
+ return failingCountError
+ ? { status: 500, body: { message: "Count failed" } }
+ : { data: [], total: failingCount, limit: 1, offset: 0 };
}
if (params.get("limit") === "1" && params.get("creatorless") === "true") {
return { data: [], total: ownerlessCount, limit: 1, offset: 0 };
@@ -177,18 +189,21 @@ const setup = ({
)
: setupAdminNotificationDetailEndpoint(notification),
);
+ if (detailErrorId !== undefined) {
+ setupAdminNotificationDetailErrorEndpoint(detailErrorId);
+ }
return renderWithProviders(
- <>
- <Route
- path="/admin/tools/notifications"
- element={<RoutedNotificationsAdminPage />}
- />
- <Route
- path="/admin/tools/notifications/:notificationId"
- element={<RoutedNotificationsAdminPage />}
- />
- </>,
+ <Route
+ path="/monitor/notifications"
+ element={
+ <MonitorContent>
+ <RoutedNotificationsAdminPage />
+ </MonitorContent>
+ }
+ >
+ <Route path=":notificationId" />
+ </Route>,
{ withRouter: true, initialRoute },
);
};
@@ -201,6 +216,15 @@ const getListCalls = () =>
new URL(call.url).searchParams.get("limit") === String(PAGE_SIZE),
);
+const getFailingCountCalls = () =>
+ fetchMock.callHistory.calls("path:/api/notification/admin").filter((call) => {
+ const params = new URL(call.url).searchParams;
+ return (
+ params.get("limit") === "1" &&
+ params.get("last_check_status") === "failing"
+ );
+ });
+
const getBulkPosts = async () =>
(await findRequests("POST")).filter((request) =>
request.url.includes("/api/notification/admin/bulk"),
@@ -277,7 +301,7 @@ describe("NotificationsAdminPage", () => {
it("shows an empty state when there are no notifications", async () => {
setup({ notifications: [] });
await waitForLoaderToBeRemoved();
- expect(await screen.findByText("No results")).toBeInTheDocument();
+ expect(await screen.findByText("No alerts")).toBeInTheDocument();
});
});
@@ -329,6 +353,20 @@ describe("NotificationsAdminPage", () => {
expect(history?.getCurrentLocation().search).not.toContain("failing");
});
});
+
+ it("counts inactive failing alerts when the status filter includes them", async () => {
+ setup({ initialRoute: `${PATHNAME}?active=all` });
+ await waitForLoaderToBeRemoved();
+
+ const [countCall] = getFailingCountCalls();
+ expect(new URL(countCall.url).searchParams.get("active")).toBeNull();
+ });
+
+ it("shows count query errors", async () => {
+ setup({ failingCountError: true });
+
+ expect(await screen.findByText("Count failed")).toBeInTheDocument();
+ });
});
describe("search, sorting and pagination", () => {
@@ -387,6 +425,10 @@ describe("NotificationsAdminPage", () => {
});
await waitForLoaderToBeRemoved();
+ expect(await screen.findByTestId("pagination-total")).toHaveTextContent(
+ "120",
+ );
+
const nextPage = screen.getByRole("button", { name: "Next page" });
expect(nextPage).toBeEnabled();
@@ -438,6 +480,19 @@ describe("NotificationsAdminPage", () => {
).toBeInTheDocument();
});
+ it("selects the keyboard-highlighted row via space", async () => {
+ setup({ notifications: [notification1, notification2] });
+ await waitForLoaderToBeRemoved();
+
+ screen.getByRole("treegrid", { name: "Notifications" }).focus();
+ await userEvent.keyboard("{ArrowDown} ");
+
+ const bar = await screen.findByTestId("toast-card");
+ expect(within(bar).getByText("1 alert selected")).toBeInTheDocument();
+ const row1 = screen.getByTestId("notification-row-1");
+ expect(within(row1).getByRole("checkbox")).toBeChecked();
+ });
+
it("clears the selection with the Clear button", async () => {
setup({ notifications: [notification1, notification2] });
await waitForLoaderToBeRemoved();
@@ -563,6 +618,14 @@ describe("NotificationsAdminPage", () => {
expect(history?.getCurrentLocation().pathname).toBe(`${PATHNAME}/1`);
expect(await screen.findByText("Alert 1")).toBeInTheDocument();
+ const sidebarRegion = screen.getByTestId("monitor-sidebar-region");
+ expect(
+ within(sidebarRegion).getByTestId("notification-detail-sidebar"),
+ ).toBeInTheDocument();
+ expect(screen.getByTestId("monitor-main")).not.toContainElement(
+ sidebarRegion,
+ );
+
await userEvent.click(screen.getByRole("button", { name: "Close" }));
await waitFor(() => {
@@ -720,6 +783,16 @@ describe("NotificationsAdminPage", () => {
});
expect(screen.queryAllByTestId("run-summary-loader")).toHaveLength(0);
});
+
+ it("shows an error when a deep-linked alert cannot be loaded", async () => {
+ setup({
+ notifications: [],
+ initialRoute: `${PATHNAME}/999`,
+ detailErrorId: 999,
+ });
+
+ expect(await screen.findByText("An error occurred")).toBeInTheDocument();
+ });
});
describe("change owner modal", () => {
diff --git a/frontend/src/metabase/monitor/tools/notifications/NotificationsTable/NotificationsTable.tsx b/frontend/src/metabase/monitor/tools/notifications/NotificationsTable/NotificationsTable.tsx
index 1b56b44f0a0..92f367caaa1 100644
--- a/frontend/src/metabase/monitor/tools/notifications/NotificationsTable/NotificationsTable.tsx
+++ b/frontend/src/metabase/monitor/tools/notifications/NotificationsTable/NotificationsTable.tsx
@@ -1,10 +1,18 @@
-import type { Row, SortingState, Updater } from "@tanstack/react-table";
+import type {
+ OnChangeFn,
+ Row,
+ RowSelectionState,
+ SortingState,
+ Updater,
+} from "@tanstack/react-table";
import { useCallback, useEffect, useMemo } from "react";
import { t } from "ttag";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
+import { useScrollToTop } from "metabase/common/hooks";
+import { MonitorEmptyState } from "metabase/monitor/components/MonitorEmptyState";
import { listChannelSummaries } from "metabase/monitor/tools/notifications/utils";
-import type { SelectionState, TreeTableColumnDef } from "metabase/ui";
+import type { TreeTableColumnDef } from "metabase/ui";
import {
Badge,
Card,
@@ -29,13 +37,14 @@ import {
type Props = {
notifications: AdminNotification[];
error: unknown;
+ isFetching: boolean;
isLoading: boolean;
- getSelectionState: (row: Row<AdminNotification>) => SelectionState;
+ page: number;
+ rowSelection: RowSelectionState;
selectedDetailId: NotificationId | undefined;
sorting: SortingState;
onSortingChange: (sorting: SortingState) => void;
- onToggleRow: (id: NotificationId) => void;
- onToggleAll: () => void;
+ onRowSelectionChange: OnChangeFn<RowSelectionState>;
onRowClick?: (id: NotificationId) => void;
};
@@ -44,13 +53,14 @@ const getNodeId = (notification: AdminNotification) => String(notification.id);
export const NotificationsTable = ({
notifications,
error,
+ isFetching,
isLoading,
- getSelectionState,
+ page,
+ rowSelection,
selectedDetailId,
sorting,
onSortingChange,
- onToggleRow,
- onToggleAll,
+ onRowSelectionChange,
onRowClick,
}: Props) => {
const selectedRowId =
@@ -64,13 +74,6 @@ export const NotificationsTable = ({
[sorting, onSortingChange],
);
- const handleCheckboxClick = useCallback(
- (row: Row<AdminNotification>) => {
- onToggleRow(row.original.id);
- },
- [onToggleRow],
- );
-
const columns = useMemo<TreeTableColumnDef<AdminNotification>[]>(
() => [
{
@@ -187,12 +190,23 @@ export const NotificationsTable = ({
[],
);
+ const handleRowActivate = useCallback(
+ (row: Row<AdminNotification>) => {
+ onRowClick?.(row.original.id);
+ },
+ [onRowClick],
+ );
+
const instance = useTreeTableInstance<AdminNotification>({
data: notifications,
columns,
getNodeId,
sorting,
manualSorting: true,
+ enableRowSelection: true,
+ rowSelection,
+ onRowSelectionChange,
+ onRowActivate: handleRowActivate,
onSortingChange: handleSortingChange,
selectedRowId,
});
@@ -202,12 +216,11 @@ export const NotificationsTable = ({
setActiveRowId(selectedRowId);
}, [selectedRowId, setActiveRowId]);
- const handleRowClick = useCallback(
- (row: Row<AdminNotification>) => {
- onRowClick?.(row.original.id);
- },
- [onRowClick],
- );
+ useScrollToTop({
+ ref: instance.containerRef,
+ keys: [page, sorting],
+ skip: isFetching,
+ });
const getRowProps = useCallback(
(row: Row<AdminNotification>) => ({
@@ -218,28 +231,36 @@ export const NotificationsTable = ({
if (isLoading || error !== undefined) {
return (
- <Card withBorder p="lg" data-testid="notifications-admin-table">
+ <Card
+ flex="0 1 auto"
+ mih={0}
+ withBorder
+ p="lg"
+ data-testid="notifications-admin-table"
+ >
<LoadingAndErrorWrapper loading={isLoading} error={error} />
</Card>
);
}
return (
- <Card withBorder p={0} data-testid="notifications-admin-table">
+ <Card
+ flex="0 1 auto"
+ mih={0}
+ p={0}
+ withBorder
+ data-testid="notifications-admin-table"
+ >
<TreeTable
instance={instance}
hierarchical={false}
showCheckboxes
- getSelectionState={getSelectionState}
- onCheckboxClick={handleCheckboxClick}
- onHeaderCheckboxClick={onToggleAll}
+ onHeaderCheckboxClick={() => instance.table.toggleAllRowsSelected()}
headerCheckboxAriaLabel={t`Select all`}
ariaLabel={t`Notifications`}
- onRowClick={handleRowClick}
+ onRowClick={handleRowActivate}
getRowProps={getRowProps}
- emptyState={
- <Flex c="text-disabled" justify="center">{t`No results`}</Flex>
- }
+ emptyState={<MonitorEmptyState label={t`No alerts`} />}
/>
</Card>
);
diff --git a/frontend/src/metabase/monitor/tools/notifications/NotificationsTabs/NotificationsTabs.module.css b/frontend/src/metabase/monitor/tools/notifications/NotificationsTabs/NotificationsTabs.module.css
index 9806dcd6c29..0928bacfe56 100644
--- a/frontend/src/metabase/monitor/tools/notifications/NotificationsTabs/NotificationsTabs.module.css
+++ b/frontend/src/metabase/monitor/tools/notifications/NotificationsTabs/NotificationsTabs.module.css
@@ -1,10 +1,8 @@
.list {
padding: 0;
- gap: var(--mantine-spacing-md);
}
.tab.tab {
- padding: 6px 12px;
background-color: transparent;
color: var(--mb-color-text-primary);
gap: var(--mantine-spacing-sm);
@@ -19,12 +17,6 @@
}
}
-.tabLabel {
- font-size: var(--mantine-font-size-md);
- font-weight: bold;
- line-height: 24px;
-}
-
.tabSection[data-position="left"],
.tabSection[data-position="right"] {
margin-inline: 0;
diff --git a/frontend/src/metabase/monitor/tools/utils.ts b/frontend/src/metabase/monitor/tools/utils.ts
index cbc26180848..ea9460fa6b7 100644
--- a/frontend/src/metabase/monitor/tools/utils.ts
+++ b/frontend/src/metabase/monitor/tools/utils.ts
@@ -117,7 +117,11 @@ export const toBackendStartedAt = (
}
// A trailing "~" makes the date range open-ended on the upper bound,
// extending it through today so the current day's runs are included.
- return includeToday ? `${value}~` : value;
+ // The backend grammar only accepts "~" on the relative "past*" forms;
+ // appending it to "this*" values (e.g. "thisday~") is a parse error, so
+ // includeToday is ignored for those.
+ const supportsIncludeToday = value.startsWith("past");
+ return includeToday && supportsIncludeToday ? `${value}~` : value;
};
export const guardTaskRunStartedAtRange = (
diff --git a/frontend/src/metabase/monitor/tools/utils.unit.spec.ts b/frontend/src/metabase/monitor/tools/utils.unit.spec.ts
new file mode 100644
index 00000000000..8ccf4bfca5f
--- /dev/null
+++ b/frontend/src/metabase/monitor/tools/utils.unit.spec.ts
@@ -0,0 +1,23 @@
+import { toBackendStartedAt } from "./utils";
+
+describe("toBackendStartedAt", () => {
+ it("returns undefined when no range is selected", () => {
+ expect(toBackendStartedAt(null, false)).toBeUndefined();
+ expect(toBackendStartedAt(null, true)).toBeUndefined();
+ });
+
+ it("appends the ~ suffix for past* ranges when today is included", () => {
+ expect(toBackendStartedAt("past7days", true)).toBe("past7days~");
+ expect(toBackendStartedAt("past1weeks", true)).toBe("past1weeks~");
+ expect(toBackendStartedAt("past12months", true)).toBe("past12months~");
+ });
+
+ it("does not append the ~ suffix for past* ranges when today is excluded", () => {
+ expect(toBackendStartedAt("past7days", false)).toBe("past7days");
+ });
+
+ it("never appends the ~ suffix for this* ranges (backend rejects thisday~)", () => {
+ expect(toBackendStartedAt("thisday", true)).toBe("thisday");
+ expect(toBackendStartedAt("thisday", false)).toBe("thisday");
+ });
+});
diff --git a/frontend/src/metabase/monitor/upsells/BaseUpsellPage.module.css b/frontend/src/metabase/monitor/upsells/BaseUpsellPage.module.css
new file mode 100644
index 00000000000..49b0b7fe28b
--- /dev/null
+++ b/frontend/src/metabase/monitor/upsells/BaseUpsellPage.module.css
@@ -0,0 +1,6 @@
+@media screen and (max-height: 520px) {
+ .UpsellPageContent {
+ height: 100%;
+ overflow-y: auto;
+ }
+}
diff --git a/frontend/src/metabase/monitor/upsells/BaseUpsellPage.tsx b/frontend/src/metabase/monitor/upsells/BaseUpsellPage.tsx
new file mode 100644
index 00000000000..20ba431077b
--- /dev/null
+++ b/frontend/src/metabase/monitor/upsells/BaseUpsellPage.tsx
@@ -0,0 +1,59 @@
+import { DottedBackground } from "metabase/common/components/upsells/components/DottedBackground";
+import { LineDecorator } from "metabase/common/components/upsells/components/LineDecorator";
+import { useUpgradeAction } from "metabase/common/components/upsells/components/UpgradeModal";
+import { UpsellCardContent } from "metabase/common/components/upsells/components/UpsellCardContent";
+import { MONITOR_UPGRADE_URL } from "metabase/common/components/upsells/constants";
+import { Stack } from "metabase/ui";
+
+import { MonitorHeaderTitle } from "../components/MonitorHeaderTitle";
+
+import S from "./BaseUpsellPage.module.css";
+
+export type BaseUpsellPageProps = {
+ campaign: string;
+ location: string;
+ header: string;
+ title: string;
+ description: string;
+ bulletPoints?: string[];
+ image?: string;
+ variant?: "image-full-height" | "image-card";
+};
+
+export function BaseUpsellPage({
+ campaign,
+ location,
+ header,
+ title,
+ description,
+ bulletPoints,
+ image,
+ variant,
+}: BaseUpsellPageProps) {
+ const { onClick: upgradeOnClick, url: upgradeUrl } = useUpgradeAction({
+ url: MONITOR_UPGRADE_URL,
+ campaign,
+ location,
+ });
+
+ return (
+ <DottedBackground px="3.5rem" pb="2rem">
+ <MonitorHeaderTitle>{header}</MonitorHeaderTitle>
+ <Stack align="center" p={40} className={S.UpsellPageContent}>
+ <LineDecorator>
+ <UpsellCardContent
+ campaign={campaign}
+ location={location}
+ title={title}
+ description={description}
+ bulletPoints={bulletPoints}
+ image={image}
+ upgradeOnClick={upgradeOnClick}
+ upgradeUrl={upgradeUrl}
+ variant={variant}
+ />
+ </LineDecorator>
+ </Stack>
+ </DottedBackground>
+ );
+}
diff --git a/frontend/src/metabase/monitor/upsells/index.ts b/frontend/src/metabase/monitor/upsells/index.ts
new file mode 100644
index 00000000000..4c2437887ef
--- /dev/null
+++ b/frontend/src/metabase/monitor/upsells/index.ts
@@ -0,0 +1 @@
+export * from "./BaseUpsellPage";
diff --git a/frontend/src/metabase/nav/components/AppSwitcher/AppSwitcher.tsx b/frontend/src/metabase/nav/components/AppSwitcher/AppSwitcher.tsx
index a565478eaa0..a510bedf855 100644
--- a/frontend/src/metabase/nav/components/AppSwitcher/AppSwitcher.tsx
+++ b/frontend/src/metabase/nav/components/AppSwitcher/AppSwitcher.tsx
@@ -7,6 +7,8 @@ import { ExternalLink } from "metabase/common/components/ExternalLink";
import { ForwardRefLink } from "metabase/common/components/Link";
import { trackDataStudioOpened } from "metabase/common/data-studio/analytics";
import { canAccessDataStudio as canAccessDataStudioSelector } from "metabase/common/data-studio/selectors";
+import { trackMonitorOpened } from "metabase/common/monitor/analytics";
+import { canAccessMonitor as canAccessMonitorSelector } from "metabase/common/monitor/selectors";
import { prepareInitials } from "metabase/common/utils/user";
import { useDispatch, useSelector } from "metabase/redux";
import { openDiagnostics } from "metabase/redux/app";
@@ -58,6 +60,7 @@ export const AppSwitcher = ({ className }: { className?: string }) => {
const adminItems = useSelector(getAdminPaths);
const canAccessOnboardingPage = useSelector(getCanAccessOnboardingPage);
const canAccessDataStudio = useSelector(canAccessDataStudioSelector);
+ const canAccessMonitor = useSelector(canAccessMonitorSelector);
const isNewInstance = useSelector(getIsNewInstance);
const helpLink = useHelpLink();
@@ -74,7 +77,7 @@ export const AppSwitcher = ({ className }: { className?: string }) => {
const appsSection = useMemo(() => {
const showAdminSettingsItem = adminItems?.length > 0;
- if (!canAccessDataStudio && !showAdminSettingsItem) {
+ if (!canAccessDataStudio && !canAccessMonitor && !showAdminSettingsItem) {
return null;
}
@@ -115,6 +118,27 @@ export const AppSwitcher = ({ className }: { className?: string }) => {
</Menu.Item>,
);
}
+ if (canAccessMonitor) {
+ items.push(
+ <Menu.Item
+ key="monitor-app-link"
+ component={ForwardRefLink}
+ to={Urls.monitor()}
+ onAuxClick={trackMonitorOpened}
+ onClickCapture={trackMonitorOpened}
+ leftSection={
+ <Icon
+ name="pulse"
+ {...(currentApp === "monitor"
+ ? CURRENT_APP_ICON_OVERRIDES
+ : null)}
+ />
+ }
+ >
+ {t`Monitor`}
+ </Menu.Item>,
+ );
+ }
if (showAdminSettingsItem) {
items.push(
<Menu.Item
@@ -137,7 +161,7 @@ export const AppSwitcher = ({ className }: { className?: string }) => {
<Box px="md">{items}</Box>
</>
);
- }, [canAccessDataStudio, adminItems, currentApp]);
+ }, [canAccessDataStudio, canAccessMonitor, adminItems, currentApp]);
// If the instance is not new, we remove the link from the sidebar automatically and show it here instead!
const showOnboardingLink = !isNewInstance && canAccessOnboardingPage;
diff --git a/frontend/src/metabase/nav/components/AppSwitcher/AppSwitcher.unit.spec.tsx b/frontend/src/metabase/nav/components/AppSwitcher/AppSwitcher.unit.spec.tsx
index e80c9e15ec7..abec87baba8 100644
--- a/frontend/src/metabase/nav/components/AppSwitcher/AppSwitcher.unit.spec.tsx
+++ b/frontend/src/metabase/nav/components/AppSwitcher/AppSwitcher.unit.spec.tsx
@@ -18,6 +18,15 @@ import {
} from "metabase-types/api/mocks";
import { AppSwitcher } from "./AppSwitcher";
+import type { CurrentApp } from "./useGetCurrentApp";
+
+jest.mock("metabase/common/monitor/analytics", () => ({
+ trackMonitorOpened: jest.fn(),
+}));
+
+const { trackMonitorOpened } = jest.requireMock(
+ "metabase/common/monitor/analytics",
+);
const USER = createMockUser();
@@ -31,7 +40,7 @@ const REGULAR_ITEMS = [
const ADMIN_ITEMS = [...REGULAR_ITEMS, "Main app", "Admin"];
const HOSTED_ITEMS = [...ADMIN_ITEMS];
-const WITH_DATA_STUDIO = [...ADMIN_ITEMS, "Data studio"];
+const WITH_AREAS = [...ADMIN_ITEMS, "Data studio", "Monitor"];
const adminNavItem = {
name: `People`,
@@ -76,6 +85,7 @@ async function setup({
<Route path="/" element={<AppSwitcher />} />
<Route path="/admin" element={<AppSwitcher />} />
<Route path="/data-studio" element={<AppSwitcher />} />
+ <Route path="/monitor" element={<AppSwitcher />} />
</>,
{
withRouter: true,
@@ -161,6 +171,10 @@ describe("ProfileLink", () => {
await openProfileLink();
await assertActiveApp("data-studio");
+ await userEvent.click(await getMonitorMenuItem());
+ await openProfileLink();
+ await assertActiveApp("monitor");
+
await userEvent.click(await getMainAppMenuItem());
await openProfileLink();
await assertActiveApp("main");
@@ -186,14 +200,23 @@ describe("ProfileLink", () => {
});
});
- describe("with data studio", () => {
- it("should show data studio app when apropriate", async () => {
+ describe("with areas", () => {
+ it("should show data studio and monitor apps when appropriate", async () => {
await setup({ isAdmin: true });
- WITH_DATA_STUDIO.forEach((title) => {
+ WITH_AREAS.forEach((title) => {
expect(screen.getByText(title)).toBeInTheDocument();
});
});
+
+ it("tracks opening Monitor from the app switcher", async () => {
+ trackMonitorOpened.mockClear();
+ await setup({ isAdmin: true });
+
+ await userEvent.click(await getMonitorMenuItem());
+
+ expect(trackMonitorOpened).toHaveBeenCalledTimes(1);
+ });
});
describe("help submenu", () => {
@@ -307,7 +330,7 @@ const openProfileLink = async () => {
const openHelpSubmenu = async () =>
await userEvent.click(await screen.findByRole("menuitem", { name: "Help" }));
-const assertActiveApp = async (current: "main" | "admin" | "data-studio") => {
+const assertActiveApp = async (current: CurrentApp) => {
expect(
await within(await getMainAppMenuItem()).findByRole("img", {
name: current === "main" ? /check_filled/i : /dashboard/i,
@@ -323,6 +346,11 @@ const assertActiveApp = async (current: "main" | "admin" | "data-studio") => {
name: current === "data-studio" ? /check_filled/i : /table/i,
}),
).toBeInTheDocument();
+ expect(
+ await within(await getMonitorMenuItem()).findByRole("img", {
+ name: current === "monitor" ? /check_filled/i : /pulse/i,
+ }),
+ ).toBeInTheDocument();
};
const getMainAppMenuItem = () =>
@@ -331,3 +359,5 @@ const getAdminMenuItem = () =>
screen.findByRole("menuitem", { name: /admin/i });
const getDataStudioMenuItem = () =>
screen.findByRole("menuitem", { name: /data studio/i });
+const getMonitorMenuItem = () =>
+ screen.findByRole("menuitem", { name: /monitor/i });
diff --git a/frontend/src/metabase/nav/components/AppSwitcher/useGetCurrentApp.tsx b/frontend/src/metabase/nav/components/AppSwitcher/useGetCurrentApp.tsx
index d6ebd94d6c8..cd92a26b26d 100644
--- a/frontend/src/metabase/nav/components/AppSwitcher/useGetCurrentApp.tsx
+++ b/frontend/src/metabase/nav/components/AppSwitcher/useGetCurrentApp.tsx
@@ -2,9 +2,11 @@ import { match } from "ts-pattern";
import { useRouter } from "metabase/router";
-export const useGetCurrentApp = () => {
+export type CurrentApp = "main" | "admin" | "data-studio" | "monitor";
+
+export const useGetCurrentApp = (): CurrentApp => {
const { location } = useRouter();
- return match(location.pathname)
+ return match<string, CurrentApp>(location.pathname)
.when(
(path) => path.startsWith("/admin"),
() => "admin",
@@ -13,5 +15,9 @@ export const useGetCurrentApp = () => {
(path) => path.startsWith("/data-studio"),
() => "data-studio",
)
+ .when(
+ (path) => path.startsWith("/monitor"),
+ () => "monitor",
+ )
.otherwise(() => "main");
};
diff --git a/frontend/src/metabase/nav/components/AreaLayout/AreaContent.tsx b/frontend/src/metabase/nav/components/AreaLayout/AreaContent.tsx
new file mode 100644
index 00000000000..ea00a476cec
--- /dev/null
+++ b/frontend/src/metabase/nav/components/AreaLayout/AreaContent.tsx
@@ -0,0 +1,25 @@
+import { type ReactNode, memo } from "react";
+
+import ErrorBoundary from "metabase/ErrorBoundary";
+import { Box } from "metabase/ui";
+
+export const CONTENT_PADDING_X = "3.5rem";
+
+type AreaContentProps = {
+ children?: ReactNode;
+};
+
+export const AreaContent = memo(function AreaContent({
+ children,
+}: AreaContentProps) {
+ return (
+ <Box
+ h="100%"
+ px={CONTENT_PADDING_X}
+ py="1.5rem"
+ style={{ overflowY: "auto" }}
+ >
+ <ErrorBoundary>{children}</ErrorBoundary>
+ </Box>
+ );
+});
diff --git a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/DataStudioLayout.module.css b/frontend/src/metabase/nav/components/AreaLayout/AreaLayout.module.css
similarity index 75%
rename from frontend/src/metabase/data-studio/app/pages/DataStudioLayout/DataStudioLayout.module.css
rename to frontend/src/metabase/nav/components/AreaLayout/AreaLayout.module.css
index 057fe816ee3..61d1481d894 100644
--- a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/DataStudioLayout.module.css
+++ b/frontend/src/metabase/nav/components/AreaLayout/AreaLayout.module.css
@@ -8,10 +8,12 @@
}
.logo {
- display: block;
+ display: flex;
+ align-items: center;
+ justify-content: center;
height: 2rem;
- transition: opacity 400ms ease;
width: 2rem;
+ transition: opacity 400ms ease;
}
.icon {
@@ -61,7 +63,8 @@
}
&.navbarClosed {
- &:hover {
+ &:hover,
+ &:focus-within {
.toggle {
opacity: 1;
}
@@ -73,6 +76,14 @@
}
}
+.groupHeading {
+ color: var(--mb-color-text-secondary);
+ font-weight: 700;
+ font-size: 11px;
+ text-transform: uppercase;
+ letter-spacing: 0.45px;
+}
+
.badgeOverlay {
position: absolute;
top: 0.25rem;
@@ -81,4 +92,8 @@
.upperGroup {
overflow-y: auto;
+
+ /* keep the 4px focus ring (2px outline + 2px offset) inside the scrollport */
+ padding: 4px;
+ margin: -4px;
}
diff --git a/frontend/src/metabase/nav/components/AreaLayout/AreaLayout.tsx b/frontend/src/metabase/nav/components/AreaLayout/AreaLayout.tsx
new file mode 100644
index 00000000000..a5c7b279ab0
--- /dev/null
+++ b/frontend/src/metabase/nav/components/AreaLayout/AreaLayout.tsx
@@ -0,0 +1,78 @@
+import { useHotkeys } from "@mantine/hooks";
+import cx from "classnames";
+import type { ReactNode } from "react";
+
+import { Box, Center, Flex, Loader, Stack } from "metabase/ui";
+
+import S from "./AreaLayout.module.css";
+import { AreaNavbarHeader } from "./AreaNavbarHeader";
+
+type AreaLayoutProps = {
+ logo: ReactNode;
+ testId: string;
+ isLoading: boolean;
+ isNavbarOpened: boolean;
+ onNavbarToggle: (isOpened: boolean) => void;
+ headerControls?: ReactNode;
+ upperNav: ReactNode;
+ lowerNav?: ReactNode;
+ children?: ReactNode;
+};
+
+/**
+ * Shared layout container for top-level "areas" (Data Studio, Monitor, …).
+ */
+export function AreaLayout({
+ logo,
+ testId,
+ isLoading,
+ isNavbarOpened,
+ onNavbarToggle,
+ headerControls,
+ upperNav,
+ lowerNav,
+ children,
+}: AreaLayoutProps) {
+ // Support both sidebar toggle shortcuts for parity with the main app.
+ // `[` matches the global shortcut, while `$mod+.` matches the legacy
+ // Data Studio shortcut.
+ const toggleNavbar = () => onNavbarToggle(!isNavbarOpened);
+ useHotkeys([
+ ["[", toggleNavbar],
+ ["mod+.", toggleNavbar],
+ ]);
+
+ if (isLoading) {
+ return (
+ <Center h="100%">
+ <Loader />
+ </Center>
+ );
+ }
+
+ return (
+ <Flex h="100%">
+ <Stack
+ className={cx(S.nav, { [S.opened]: isNavbarOpened })}
+ h="100%"
+ p="0.75rem"
+ justify="space-between"
+ data-testid={testId}
+ >
+ <Stack gap="md" flex={1} mih={0} className={S.upperGroup}>
+ <AreaNavbarHeader
+ logo={logo}
+ headerControls={headerControls}
+ isNavbarOpened={isNavbarOpened}
+ onNavbarToggle={onNavbarToggle}
+ />
+ {upperNav}
+ </Stack>
+ {lowerNav && <Stack gap="0.75rem">{lowerNav}</Stack>}
+ </Stack>
+ <Box h="100%" flex={1} miw={0}>
+ {children}
+ </Box>
+ </Flex>
+ );
+}
diff --git a/frontend/src/metabase/nav/components/AreaLayout/AreaLayout.unit.spec.tsx b/frontend/src/metabase/nav/components/AreaLayout/AreaLayout.unit.spec.tsx
new file mode 100644
index 00000000000..eee480e2877
--- /dev/null
+++ b/frontend/src/metabase/nav/components/AreaLayout/AreaLayout.unit.spec.tsx
@@ -0,0 +1,70 @@
+import { fireEvent } from "@testing-library/react";
+
+import { renderWithProviders, screen } from "__support__/ui";
+
+import { AreaLayout } from "./AreaLayout";
+
+interface SetupOpts {
+ isNavbarOpened?: boolean;
+}
+
+const setup = ({ isNavbarOpened = true }: SetupOpts = {}) => {
+ const onNavbarToggle = jest.fn();
+
+ renderWithProviders(
+ <AreaLayout
+ logo={<div>{"Logo"}</div>}
+ testId="area-nav"
+ isLoading={false}
+ isNavbarOpened={isNavbarOpened}
+ onNavbarToggle={onNavbarToggle}
+ upperNav={null}
+ >
+ <div data-testid="content">{"Content"}</div>
+ </AreaLayout>,
+ );
+
+ return { onNavbarToggle };
+};
+
+describe("AreaLayout", () => {
+ it("renders its children", () => {
+ setup();
+
+ expect(screen.getByTestId("content")).toHaveTextContent("Content");
+ });
+
+ describe("sidebar toggle shortcuts", () => {
+ it("toggles a collapsed sidebar open with '['", () => {
+ const { onNavbarToggle } = setup({ isNavbarOpened: false });
+
+ fireEvent.keyDown(document.body, { key: "[" });
+
+ expect(onNavbarToggle).toHaveBeenCalledWith(true);
+ });
+
+ it("toggles an open sidebar closed with Cmd + '.'", () => {
+ const { onNavbarToggle } = setup({ isNavbarOpened: true });
+
+ fireEvent.keyDown(document.body, { key: ".", metaKey: true });
+
+ expect(onNavbarToggle).toHaveBeenCalledWith(false);
+ });
+
+ it("toggles with Ctrl + '.' as well", () => {
+ const { onNavbarToggle } = setup({ isNavbarOpened: false });
+
+ fireEvent.keyDown(document.body, { key: ".", ctrlKey: true });
+
+ expect(onNavbarToggle).toHaveBeenCalledWith(true);
+ });
+
+ it("does not toggle on '.' without a modifier", () => {
+ const { onNavbarToggle } = setup({ isNavbarOpened: true });
+
+ fireEvent.keyDown(document.body, { key: "." });
+
+ expect(onNavbarToggle).not.toHaveBeenCalled();
+ });
+ });
+});
diff --git a/frontend/src/metabase/nav/components/AreaLayout/AreaNavbarHeader.tsx b/frontend/src/metabase/nav/components/AreaLayout/AreaNavbarHeader.tsx
new file mode 100644
index 00000000000..04f034957c0
--- /dev/null
+++ b/frontend/src/metabase/nav/components/AreaLayout/AreaNavbarHeader.tsx
@@ -0,0 +1,48 @@
+import cx from "classnames";
+import type { ReactNode } from "react";
+
+import { Box, Flex, Group } from "metabase/ui";
+
+import S from "./AreaLayout.module.css";
+import { ToggleActionIcon } from "./ToggleActionIcon";
+
+type AreaNavbarHeaderProps = {
+ logo: ReactNode;
+ headerControls?: ReactNode;
+ isNavbarOpened: boolean;
+ onNavbarToggle: (isOpened: boolean) => void;
+};
+
+export function AreaNavbarHeader({
+ logo,
+ headerControls,
+ isNavbarOpened,
+ onNavbarToggle,
+}: AreaNavbarHeaderProps) {
+ return (
+ <Flex
+ align="center"
+ justify={isNavbarOpened ? "space-between" : "center"}
+ mb="0.75rem"
+ mt="sm"
+ >
+ <Group gap="sm">
+ <Box
+ className={cx(S.logoWrapper, { [S.navbarClosed]: !isNavbarOpened })}
+ >
+ <Box className={S.logo}>{logo}</Box>
+ {!isNavbarOpened && (
+ <ToggleActionIcon
+ isNavbarOpened={isNavbarOpened}
+ onNavbarToggle={onNavbarToggle}
+ />
+ )}
+ </Box>
+ {isNavbarOpened && headerControls}
+ </Group>
+ {isNavbarOpened && (
+ <ToggleActionIcon isNavbarOpened onNavbarToggle={onNavbarToggle} />
+ )}
+ </Flex>
+ );
+}
diff --git a/frontend/src/metabase/nav/components/AreaLayout/AreaNavbarHeader.unit.spec.tsx b/frontend/src/metabase/nav/components/AreaLayout/AreaNavbarHeader.unit.spec.tsx
new file mode 100644
index 00000000000..f55ba7a67b8
--- /dev/null
+++ b/frontend/src/metabase/nav/components/AreaLayout/AreaNavbarHeader.unit.spec.tsx
@@ -0,0 +1,64 @@
+import userEvent from "@testing-library/user-event";
+
+import { renderWithProviders, screen } from "__support__/ui";
+
+import { AreaNavbarHeader } from "./AreaNavbarHeader";
+
+interface SetupOpts {
+ isNavbarOpened?: boolean;
+}
+
+const setup = ({ isNavbarOpened = true }: SetupOpts = {}) => {
+ const onNavbarToggle = jest.fn();
+
+ renderWithProviders(
+ <AreaNavbarHeader
+ logo={<div>{"Logo"}</div>}
+ headerControls={<div>{"Header controls"}</div>}
+ isNavbarOpened={isNavbarOpened}
+ onNavbarToggle={onNavbarToggle}
+ />,
+ );
+
+ return { onNavbarToggle };
+};
+
+describe("AreaNavbarHeader", () => {
+ it("renders the logo", () => {
+ setup();
+
+ expect(screen.getByText("Logo")).toBeInTheDocument();
+ });
+
+ it("renders header controls when the navbar is open", () => {
+ setup({ isNavbarOpened: true });
+
+ expect(screen.getByText("Header controls")).toBeInTheDocument();
+ });
+
+ it("does not render header controls when the navbar is closed", () => {
+ setup({ isNavbarOpened: false });
+
+ expect(screen.queryByText("Header controls")).not.toBeInTheDocument();
+ });
+
+ it("toggles an open navbar closed", async () => {
+ const { onNavbarToggle } = setup({ isNavbarOpened: true });
+
+ await userEvent.click(
+ screen.getByRole("button", { name: /close sidebar/i }),
+ );
+
+ expect(onNavbarToggle).toHaveBeenCalledWith(false);
+ });
+
+ it("toggles a closed navbar open", async () => {
+ const { onNavbarToggle } = setup({ isNavbarOpened: false });
+
+ await userEvent.click(
+ screen.getByRole("button", { name: /open sidebar/i }),
+ );
+
+ expect(onNavbarToggle).toHaveBeenCalledWith(true);
+ });
+});
diff --git a/frontend/src/metabase/nav/components/AreaLayout/AreaTab.tsx b/frontend/src/metabase/nav/components/AreaLayout/AreaTab.tsx
new file mode 100644
index 00000000000..ef2835ad77b
--- /dev/null
+++ b/frontend/src/metabase/nav/components/AreaLayout/AreaTab.tsx
@@ -0,0 +1,68 @@
+import cx from "classnames";
+import type { ReactNode } from "react";
+
+import { ForwardRefLink } from "metabase/common/components/Link";
+import { UpsellGem } from "metabase/common/components/upsells/components/UpsellGem";
+import { Box, FixedSizeIcon, Flex, Text, Tooltip } from "metabase/ui";
+import type { IconName } from "metabase-types/api";
+
+import S from "./AreaLayout.module.css";
+import { TOOLTIP_OPEN_DELAY } from "./constants";
+
+type AreaTabProps = {
+ label: string;
+ icon: IconName;
+ to: string;
+ isSelected?: boolean;
+ showLabel: boolean;
+ rightSection?: ReactNode;
+ isGated?: boolean;
+ onClick?: () => void;
+};
+
+export function AreaTab({
+ label,
+ icon,
+ to,
+ isSelected,
+ showLabel,
+ rightSection,
+ isGated,
+ onClick,
+}: AreaTabProps) {
+ const upsellGem = isGated ? <UpsellGem.New size={14} /> : null;
+ const effectiveRightSection = rightSection ?? upsellGem;
+
+ return (
+ <Tooltip
+ label={label}
+ position="right"
+ openDelay={TOOLTIP_OPEN_DELAY}
+ disabled={showLabel}
+ >
+ <Flex
+ className={cx(S.tab, { [S.selected]: isSelected })}
+ component={ForwardRefLink}
+ to={to}
+ onClick={onClick}
+ p="sm"
+ gap="sm"
+ bdrs="md"
+ aria-label={label}
+ aria-current={isSelected ? "page" : undefined}
+ justify={showLabel ? "start" : "center"}
+ >
+ <FixedSizeIcon name={icon} display="block" className={S.icon} />
+ {showLabel && <Text lh="sm">{label}</Text>}
+ {effectiveRightSection && (
+ <Box
+ className={showLabel ? undefined : S.badgeOverlay}
+ ml={showLabel ? "auto" : undefined}
+ >
+ {effectiveRightSection}
+ </Box>
+ )}
+ </Flex>
+ </Tooltip>
+ );
+}
diff --git a/frontend/src/metabase/nav/components/AreaLayout/AreaTab.unit.spec.tsx b/frontend/src/metabase/nav/components/AreaLayout/AreaTab.unit.spec.tsx
new file mode 100644
index 00000000000..b4291761630
--- /dev/null
+++ b/frontend/src/metabase/nav/components/AreaLayout/AreaTab.unit.spec.tsx
@@ -0,0 +1,74 @@
+import type { ReactNode } from "react";
+
+import { renderWithProviders, screen } from "__support__/ui";
+import { Route } from "metabase/router";
+
+import { AreaTab } from "./AreaTab";
+
+interface SetupOpts {
+ isGated?: boolean;
+ isSelected?: boolean;
+ rightSection?: ReactNode;
+}
+
+const setup = ({
+ isGated = false,
+ isSelected = false,
+ rightSection,
+}: SetupOpts = {}) => {
+ renderWithProviders(
+ <Route
+ path="/"
+ element={
+ <AreaTab
+ label="Dependency diagnostics"
+ icon="search_check"
+ to="/monitor/dependency-diagnostics"
+ isGated={isGated}
+ isSelected={isSelected}
+ rightSection={rightSection}
+ showLabel
+ />
+ }
+ />,
+ { withRouter: true },
+ );
+};
+
+describe("AreaTab", () => {
+ it("marks the selected tab as the current page for assistive tech", () => {
+ setup({ isSelected: true });
+
+ const tab = screen.getByRole("link", { name: "Dependency diagnostics" });
+ expect(tab).toHaveAttribute("aria-current", "page");
+ });
+
+ it("does not mark an unselected tab as current", () => {
+ setup({ isSelected: false });
+
+ const tab = screen.getByRole("link", { name: "Dependency diagnostics" });
+ expect(tab).not.toHaveAttribute("aria-current");
+ });
+
+ it("shows an upsell gem for a gated tab", () => {
+ setup({ isGated: true });
+
+ expect(screen.getByTestId("upsell-gem")).toBeInTheDocument();
+ });
+
+ it("does not show an upsell gem for an ungated tab", () => {
+ setup({ isGated: false });
+
+ expect(screen.queryByTestId("upsell-gem")).not.toBeInTheDocument();
+ });
+
+ it("shows a custom right section instead of an upsell gem", () => {
+ setup({
+ isGated: true,
+ rightSection: <span data-testid="custom-right-section" />,
+ });
+
+ expect(screen.getByTestId("custom-right-section")).toBeInTheDocument();
+ expect(screen.queryByTestId("upsell-gem")).not.toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/nav/components/AreaLayout/AreaTabGroup.tsx b/frontend/src/metabase/nav/components/AreaLayout/AreaTabGroup.tsx
new file mode 100644
index 00000000000..609256e9c94
--- /dev/null
+++ b/frontend/src/metabase/nav/components/AreaLayout/AreaTabGroup.tsx
@@ -0,0 +1,30 @@
+import type { ReactNode } from "react";
+
+import { Stack, Text } from "metabase/ui";
+
+import S from "./AreaLayout.module.css";
+
+type AreaTabGroupProps = {
+ label: string;
+ showLabel: boolean;
+ children: ReactNode;
+ mb?: string;
+};
+
+export function AreaTabGroup({
+ label,
+ showLabel,
+ children,
+ mb,
+}: AreaTabGroupProps) {
+ return (
+ <Stack component="section" gap="0.75rem" mb={mb} aria-label={label}>
+ {showLabel && (
+ <Text component="h4" className={S.groupHeading} px="sm">
+ {label}
+ </Text>
+ )}
+ {children}
+ </Stack>
+ );
+}
diff --git a/frontend/src/metabase/nav/components/AreaLayout/AreaTabGroup.unit.spec.tsx b/frontend/src/metabase/nav/components/AreaLayout/AreaTabGroup.unit.spec.tsx
new file mode 100644
index 00000000000..15731ca65be
--- /dev/null
+++ b/frontend/src/metabase/nav/components/AreaLayout/AreaTabGroup.unit.spec.tsx
@@ -0,0 +1,38 @@
+import { renderWithProviders, screen } from "__support__/ui";
+
+import { AreaTabGroup } from "./AreaTabGroup";
+
+const setup = ({ showLabel = true }: { showLabel?: boolean } = {}) => {
+ renderWithProviders(
+ <AreaTabGroup label="Content management" showLabel={showLabel}>
+ <div data-testid="child">{"Child item"}</div>
+ </AreaTabGroup>,
+ );
+};
+
+describe("AreaTabGroup", () => {
+ it("renders a static heading with its children always visible", () => {
+ setup();
+
+ expect(
+ screen.getByRole("heading", { name: "Content management" }),
+ ).toBeInTheDocument();
+ expect(screen.getByTestId("child")).toBeVisible();
+ });
+
+ it("is not interactive", () => {
+ setup();
+
+ expect(screen.queryByRole("button")).not.toBeInTheDocument();
+ });
+
+ it("hides the heading in icon-only mode while keeping children visible and the section labelled", () => {
+ setup({ showLabel: false });
+
+ expect(screen.queryByRole("heading")).not.toBeInTheDocument();
+ expect(screen.getByTestId("child")).toBeVisible();
+ expect(
+ screen.getByRole("region", { name: "Content management" }),
+ ).toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/nav/components/AreaLayout/ToggleActionIcon.tsx b/frontend/src/metabase/nav/components/AreaLayout/ToggleActionIcon.tsx
new file mode 100644
index 00000000000..1668b648ec8
--- /dev/null
+++ b/frontend/src/metabase/nav/components/AreaLayout/ToggleActionIcon.tsx
@@ -0,0 +1,40 @@
+import { t } from "ttag";
+
+import { ActionIcon, FixedSizeIcon, Tooltip } from "metabase/ui";
+import { isMac } from "metabase/utils/browser";
+
+import S from "./AreaLayout.module.css";
+import { TOOLTIP_OPEN_DELAY } from "./constants";
+
+const getSidebarTooltipLabel = (isNavbarOpened: boolean) => {
+ const message = isNavbarOpened ? t`Close sidebar` : t`Open sidebar`;
+ const modKey = isMac() ? "⌘" : "Ctrl";
+ return `${message} ([ ${t`or`} ${modKey} + .)`;
+};
+
+type ToggleActionIconProps = {
+ isNavbarOpened: boolean;
+ onNavbarToggle: (isOpened: boolean) => void;
+};
+
+export function ToggleActionIcon({
+ isNavbarOpened,
+ onNavbarToggle,
+}: ToggleActionIconProps) {
+ const label = getSidebarTooltipLabel(isNavbarOpened);
+
+ return (
+ <Tooltip label={label} openDelay={TOOLTIP_OPEN_DELAY}>
+ <ActionIcon
+ aria-label={label}
+ className={S.toggle}
+ onClick={() => onNavbarToggle(!isNavbarOpened)}
+ >
+ <FixedSizeIcon
+ name={isNavbarOpened ? "sidebar_closed" : "sidebar_open"}
+ c="text-secondary"
+ />
+ </ActionIcon>
+ </Tooltip>
+ );
+}
diff --git a/frontend/src/metabase/nav/components/AreaLayout/constants.ts b/frontend/src/metabase/nav/components/AreaLayout/constants.ts
new file mode 100644
index 00000000000..9a00724d9cd
--- /dev/null
+++ b/frontend/src/metabase/nav/components/AreaLayout/constants.ts
@@ -0,0 +1 @@
+export const TOOLTIP_OPEN_DELAY = 1000;
diff --git a/frontend/src/metabase/nav/components/AreaLayout/index.ts b/frontend/src/metabase/nav/components/AreaLayout/index.ts
new file mode 100644
index 00000000000..d228860447f
--- /dev/null
+++ b/frontend/src/metabase/nav/components/AreaLayout/index.ts
@@ -0,0 +1,4 @@
+export * from "./AreaContent";
+export * from "./AreaLayout";
+export * from "./AreaTab";
+export * from "./AreaTabGroup";
diff --git a/frontend/src/metabase/palette/shortcuts/global.ts b/frontend/src/metabase/palette/shortcuts/global.ts
index f553de3a7e0..3bb8da8c2ab 100644
--- a/frontend/src/metabase/palette/shortcuts/global.ts
+++ b/frontend/src/metabase/palette/shortcuts/global.ts
@@ -147,7 +147,11 @@ export const globalShortcuts = {
get name() {
return t`Toggle sidebar`;
},
+ // `shortcut` is what kbar binds (a single key, to avoid kbar treating a
+ // multi-element array as a key sequence). `$mod+.` is handled separately
+ // (MainNavbar/AreaLayout), so we surface both triggers via `shortcutDisplay`.
shortcut: ["["],
+ shortcutDisplay: ["[", "$mod+."],
shortcutGroup: "global" as const,
},
"navigate-admin-settings": {
diff --git a/frontend/src/metabase/plugins/index.ts b/frontend/src/metabase/plugins/index.ts
index 5175dc732c6..26208fe26f3 100644
--- a/frontend/src/metabase/plugins/index.ts
+++ b/frontend/src/metabase/plugins/index.ts
@@ -56,7 +56,6 @@ export {
PLUGIN_REDUX_MIDDLEWARES,
PLUGIN_LOGO_ICON_COMPONENTS,
PLUGIN_ADMIN_ALLOWED_PATH_GETTERS,
- PLUGIN_ADMIN_TOOLS,
PLUGIN_SELECTORS,
PLUGIN_FORM_WIDGETS,
PLUGIN_SNIPPET_SIDEBAR_PLUS_MENU_OPTIONS,
@@ -170,6 +169,7 @@ export {
PLUGIN_DEPENDENCIES,
type DependencyGraphPageContextType,
} from "./oss/dependencies";
+export { PLUGIN_MONITOR, PLUGIN_MONITOR_TOOLS } from "./oss/monitor";
export { PLUGIN_UPLOAD_MANAGEMENT } from "./oss/upload-management";
export { PLUGIN_WHITELABEL } from "./oss/whitelabel";
export {
@@ -215,6 +215,7 @@ import { reinitialize as reinitializeLibrary } from "./oss/library";
import { reinitialize as reinitializeMetabot } from "./oss/metabot";
import { reinitialize as reinitializeModelPersistence } from "./oss/model-persistence";
import { reinitialize as reinitializeModeration } from "./oss/moderation";
+import { reinitialize as reinitializeMonitor } from "./oss/monitor";
import { reinitialize as reinitializeMultiFactorAuth } from "./oss/multi-factor-auth";
import { reinitialize as reinitializeNotificationsSdk } from "./oss/notifications-sdk";
import { reinitialize as reinitializePermissions } from "./oss/permissions";
@@ -262,6 +263,7 @@ export function reinitialize() {
reinitializeMetabot();
reinitializeModelPersistence();
reinitializeModeration();
+ reinitializeMonitor();
reinitializeMultiFactorAuth();
reinitializePermissions();
reinitializeRemoteSync();
diff --git a/frontend/src/metabase/plugins/oss/core.ts b/frontend/src/metabase/plugins/oss/core.ts
index a9bd9a9455e..76bb470b3d2 100644
--- a/frontend/src/metabase/plugins/oss/core.ts
+++ b/frontend/src/metabase/plugins/oss/core.ts
@@ -87,14 +87,6 @@ const getDefaultAdminAllowedPathGetters = (): ((
export const PLUGIN_ADMIN_ALLOWED_PATH_GETTERS =
getDefaultAdminAllowedPathGetters();
-const getDefaultAdminTools = () => ({
- COMPONENT: null,
-});
-
-export const PLUGIN_ADMIN_TOOLS: {
- COMPONENT: ComponentType | null;
-} = getDefaultAdminTools();
-
const getDefaultSelectors = () => ({
canWhitelabel: (_state: State) => false,
getLoadingMessageFactory: (_state: State) => getLoadingMessage,
@@ -194,7 +186,6 @@ export function reinitialize() {
...getDefaultAdminAllowedPathGetters(),
);
- Object.assign(PLUGIN_ADMIN_TOOLS, getDefaultAdminTools());
Object.assign(PLUGIN_SELECTORS, getDefaultSelectors());
Object.assign(PLUGIN_FORM_WIDGETS, getDefaultFormWidgets());
diff --git a/frontend/src/metabase/plugins/oss/dependencies.ts b/frontend/src/metabase/plugins/oss/dependencies.ts
index cdd4f03efde..0b413931204 100644
--- a/frontend/src/metabase/plugins/oss/dependencies.ts
+++ b/frontend/src/metabase/plugins/oss/dependencies.ts
@@ -13,7 +13,6 @@ export type DependencyGraphPageContextType = {
type DependenciesPlugin = {
isEnabled: boolean;
getDataStudioDependencyRoutes: () => ReactNode;
- getDataStudioDependencyDiagnosticsRoutes: () => ReactNode;
DependencyGraphPage: ComponentType;
DependencyGraphPageContext: Context<DependencyGraphPageContextType>;
useGetDependenciesCount: (args: GetDependencyGraphRequest) => {
@@ -25,7 +24,6 @@ type DependenciesPlugin = {
const getDefaultPluginDependencies = (): DependenciesPlugin => ({
isEnabled: false,
getDataStudioDependencyRoutes: () => null,
- getDataStudioDependencyDiagnosticsRoutes: () => null,
DependencyGraphPage: PluginPlaceholder,
DependencyGraphPageContext: createContext({}),
useGetDependenciesCount: () => ({
diff --git a/frontend/src/metabase/plugins/oss/monitor.ts b/frontend/src/metabase/plugins/oss/monitor.ts
new file mode 100644
index 00000000000..8e0cf4d3809
--- /dev/null
+++ b/frontend/src/metabase/plugins/oss/monitor.ts
@@ -0,0 +1,29 @@
+import type { ComponentType, ReactNode } from "react";
+
+type MonitorPlugin = {
+ isDependencyDiagnosticsEnabled: boolean;
+ getDependencyDiagnosticsRoutes: () => ReactNode;
+};
+
+const getDefaultPluginMonitor = (): MonitorPlugin => ({
+ isDependencyDiagnosticsEnabled: false,
+ getDependencyDiagnosticsRoutes: () => null,
+});
+
+export const PLUGIN_MONITOR = getDefaultPluginMonitor();
+
+const getDefaultMonitorTools = (): { COMPONENT: ComponentType | null } => ({
+ COMPONENT: null,
+});
+
+export const PLUGIN_MONITOR_TOOLS: {
+ COMPONENT: ComponentType | null;
+} = getDefaultMonitorTools();
+
+/**
+ * @internal Do not call directly. Use the main reinitialize function from metabase/plugins instead.
+ */
+export function reinitialize() {
+ Object.assign(PLUGIN_MONITOR, getDefaultPluginMonitor());
+ Object.assign(PLUGIN_MONITOR_TOOLS, getDefaultMonitorTools());
+}
diff --git a/frontend/src/metabase/query_builder/reducers.ts b/frontend/src/metabase/query_builder/reducers.ts
index 56060511022..ef523e99e1b 100644
--- a/frontend/src/metabase/query_builder/reducers.ts
+++ b/frontend/src/metabase/query_builder/reducers.ts
@@ -639,6 +639,21 @@ type NestedCardPayloadAction = {
};
};
+const handleQueryCompleted = (
+ state: Card | null,
+ action: NestedCardPayloadAction,
+) => {
+ if (!state) {
+ return state;
+ }
+ return {
+ ...state,
+ display: action.payload.card.display,
+ result_metadata: action.payload.card.result_metadata,
+ visualization_settings: action.payload.card.visualization_settings,
+ };
+};
+
// the card that is actively being worked on
//
// NOTE: the `.addCase` / `.addMatcher` calls below are written as separate
@@ -684,17 +699,7 @@ export const card = createReducer<Card | null>(null, (builder) => {
);
builder.addCase<string, NestedCardPayloadAction>(
QUERY_COMPLETED,
- (state, action) => {
- if (!state) {
- return state;
- }
- return {
- ...state,
- display: action.payload.card.display,
- result_metadata: action.payload.card.result_metadata,
- visualization_settings: action.payload.card.visualization_settings,
- };
- },
+ handleQueryCompleted,
);
builder.addMatcher(createCardPublicLink.matchFulfilled, (state, action) => {
if (!state) {
diff --git a/frontend/src/metabase/querying/run-query.ts b/frontend/src/metabase/querying/run-query.ts
index 321c84091bd..807975bd758 100644
--- a/frontend/src/metabase/querying/run-query.ts
+++ b/frontend/src/metabase/querying/run-query.ts
@@ -1,3 +1,4 @@
+import { RTK_CACHE_KEY_PARAM } from "metabase/api/api";
import { cardApi } from "metabase/api/card";
import { dashboardApi } from "metabase/api/dashboard";
import { datasetApi } from "metabase/api/dataset";
@@ -94,13 +95,13 @@ export function runAdhocDatasetQuery(
// Disambiguate the RTK cache key so two callers running the same MBQL
// query get independent cache entries and abort signals. Without this,
// one caller cancelling would abort the shared in-flight request for
- // every co-subscribed caller. `_refetchDeps` is stripped from the body
- // before it hits the server.
+ // every co-subscribed caller. The key is stripped in `baseQuery` before
+ // the request hits the server.
const requestBody = {
...(isPivot
? { ...body, ...getPivotOptions(new Question(card, metadata)) }
: body),
- _refetchDeps: ++adhocDatasetQueryCounter,
+ [RTK_CACHE_KEY_PARAM]: ++adhocDatasetQueryCounter,
};
const endpoint = isPivot
? datasetApi.endpoints.getAdhocPivotQuery
@@ -138,9 +139,10 @@ function runSavedCardQuery(
// Disambiguate the RTK cache key so two callers running the same saved card
// don't co-subscribe to one in-flight request — otherwise one caller
// aborting its query (e.g. the SDK cancelling the previous run on every
- // re-run) aborts every co-subscriber's query too. Stripped from the body
- // before it hits the server. Mirrors `runAdhocDatasetQuery`.
- _refetchDeps: ++savedCardQueryCounter,
+ // re-run) aborts every co-subscriber's query too. The key is stripped in
+ // `baseQuery` before the request hits the server. Mirrors
+ // `runAdhocDatasetQuery`.
+ [RTK_CACHE_KEY_PARAM]: ++savedCardQueryCounter,
// `token` and `cardId` identify the card in mutually exclusive ways, so we
// send only one. Guest and embedded requests carry a `token`: the
// `onBeforeRequest` middleware rewrites the request to the matching
diff --git a/frontend/src/metabase/querying/run-query.unit.spec.ts b/frontend/src/metabase/querying/run-query.unit.spec.ts
index b0ebdc83f03..4d424de0144 100644
--- a/frontend/src/metabase/querying/run-query.unit.spec.ts
+++ b/frontend/src/metabase/querying/run-query.unit.spec.ts
@@ -219,7 +219,7 @@ describe("metabase/querying/run-query > runQuestionQuery", () => {
dataset_query: {
type: "internal",
fn: "metabase-enterprise.audit-app.pages.queries/bad-table",
- args: [null, null, null, "last_run_at", "desc"],
+ args: [null, "last_run_at", "desc"],
} as unknown as UnsavedCard["dataset_query"],
});
@@ -342,7 +342,7 @@ describe("metabase/querying/run-query > runQuestionQuery", () => {
// Two callers running the same saved card must not co-subscribe to a
// single RTK Query request: otherwise one caller aborting (e.g. the SDK
// cancelling the previous run on every re-run) would abort the other's
- // query too, hanging/blanking the result. A unique `_refetchDeps` per
+ // query too, hanging/blanking the result. A unique `__rtkCacheKey` per
// call keeps the cache keys — and therefore the requests — distinct.
const question = createMockSavedQuestion();
const path = getQueryEndpointPath(question);
diff --git a/frontend/src/metabase/redux/store/admin.ts b/frontend/src/metabase/redux/store/admin.ts
index d674821d599..ee31d90e925 100644
--- a/frontend/src/metabase/redux/store/admin.ts
+++ b/frontend/src/metabase/redux/store/admin.ts
@@ -14,7 +14,7 @@ export type AdminPathKey =
| "databases"
| "permissions"
| "audit"
- | "tools"
+ | "help"
| "performance"
| "performance-models"
| "performance-dashboards-and-questions"
diff --git a/frontend/src/metabase/router/guards.tsx b/frontend/src/metabase/router/guards.tsx
index 580ce1d5d5b..5b7b1819e64 100644
--- a/frontend/src/metabase/router/guards.tsx
+++ b/frontend/src/metabase/router/guards.tsx
@@ -1,6 +1,12 @@
import { type ReactElement, type ReactNode, useEffect } from "react";
import { canAccessDataStudio } from "metabase/common/data-studio/selectors";
+import {
+ canAccessAlertsManagement,
+ canAccessMonitor,
+ canAccessMonitorDiagnostics,
+ canAccessMonitoringTools,
+} from "metabase/common/monitor/selectors";
import { PLUGIN_FEATURE_LEVEL_PERMISSIONS } from "metabase/plugins";
import { useSelector } from "metabase/redux";
import type { State } from "metabase/redux/store";
@@ -207,6 +213,26 @@ const UserCanAccessDataStudio = createRedirectGuard(
"/unauthorized",
);
+const UserCanAccessMonitor = createRedirectGuard(
+ (state) => canAccessMonitor(state),
+ "/unauthorized",
+);
+
+const UserCanAccessMonitorDiagnostics = createRedirectGuard(
+ (state) => canAccessMonitorDiagnostics(state),
+ "/unauthorized",
+);
+
+const UserCanAccessMonitoringTools = createRedirectGuard(
+ (state) => canAccessMonitoringTools(state),
+ "/unauthorized",
+);
+
+const UserCanAccessAlertsManagement = createRedirectGuard(
+ (state) => canAccessAlertsManagement(state),
+ "/unauthorized",
+);
+
export const IsAuthenticated = () => (
<MetabaseIsSetup>
<UserIsAuthenticated>
@@ -267,3 +293,31 @@ export const CanAccessDataModel = () => (
<Outlet />
</UserCanAccessDataModel>
);
+
+export const CanAccessMonitor = () => (
+ <MetabaseIsSetup>
+ <UserIsAuthenticated>
+ <UserCanAccessMonitor>
+ <Outlet />
+ </UserCanAccessMonitor>
+ </UserIsAuthenticated>
+ </MetabaseIsSetup>
+);
+
+export const CanAccessMonitorDiagnostics = () => (
+ <UserCanAccessMonitorDiagnostics>
+ <Outlet />
+ </UserCanAccessMonitorDiagnostics>
+);
+
+export const CanAccessMonitoringTools = () => (
+ <UserCanAccessMonitoringTools>
+ <Outlet />
+ </UserCanAccessMonitoringTools>
+);
+
+export const CanAccessAlertsManagement = () => (
+ <UserCanAccessAlertsManagement>
+ <Outlet />
+ </UserCanAccessAlertsManagement>
+);
diff --git a/frontend/src/metabase/router/guards.unit.spec.tsx b/frontend/src/metabase/router/guards.unit.spec.tsx
index 430819fe699..11067e3eeb0 100644
--- a/frontend/src/metabase/router/guards.unit.spec.tsx
+++ b/frontend/src/metabase/router/guards.unit.spec.tsx
@@ -1,5 +1,5 @@
import { mockSettings } from "__support__/settings";
-import { renderWithProviders, waitFor } from "__support__/ui";
+import { renderWithProviders, screen, waitFor } from "__support__/ui";
import {
createMockSettingsState,
createMockState,
@@ -9,6 +9,8 @@ import { replaceLocation } from "metabase/utils/dom";
import { createMockUser } from "metabase-types/api/mocks";
import {
+ CanAccessAlertsManagement,
+ CanAccessMonitor,
IsAdmin,
IsAuthenticated,
IsNotAuthenticated,
@@ -275,6 +277,137 @@ describe("route-guards", () => {
});
});
+ describe("CanAccessMonitor", () => {
+ interface SetupOpts {
+ currentUser?: ReturnType<typeof createMockUser>;
+ }
+
+ const setup = ({ currentUser }: SetupOpts = {}) => {
+ return renderWithProviders(
+ <>
+ <Route element={<CanAccessMonitor />}>
+ <Route path="/monitor" element={<div>monitor page</div>} />
+ </Route>
+ <Route path="/auth/login" element={<div>login page</div>} />
+ <Route path="/unauthorized" element={<div>unauthorized</div>} />
+ </>,
+ {
+ storeInitialState: createMockState({
+ currentUser,
+ settings: createMockSettingsState({ "has-user-setup": true }),
+ }),
+ withRouter: true,
+ initialRoute: "/monitor",
+ },
+ );
+ };
+
+ it("redirects unauthenticated users to login with redirect back", async () => {
+ const { history } = setup({ currentUser: undefined });
+
+ await waitFor(() => {
+ expect(history?.getCurrentLocation().pathname).toBe("/auth/login");
+ });
+
+ expect(history?.getCurrentLocation().query).toEqual(
+ expect.objectContaining({ redirect: "/monitor" }),
+ );
+ });
+
+ it("redirects users without monitor access to unauthorized", async () => {
+ const { history } = setup({
+ currentUser: createMockUser({
+ is_data_analyst: false,
+ is_superuser: false,
+ }),
+ });
+
+ await waitFor(() => {
+ expect(history?.getCurrentLocation().pathname).toBe("/unauthorized");
+ });
+
+ expect(history?.getCurrentLocation().query).toEqual({});
+ });
+
+ it("renders for analysts", () => {
+ setup({
+ currentUser: createMockUser({
+ is_data_analyst: true,
+ is_superuser: false,
+ }),
+ });
+
+ expect(screen.getByText("monitor page")).toBeInTheDocument();
+ });
+ });
+
+ describe("CanAccessAlertsManagement", () => {
+ interface SetupOpts {
+ currentUser?: ReturnType<typeof createMockUser>;
+ }
+
+ const setup = ({ currentUser }: SetupOpts = {}) => {
+ return renderWithProviders(
+ <>
+ <Route element={<CanAccessAlertsManagement />}>
+ <Route
+ path="/monitor/notifications"
+ element={<div>alerts page</div>}
+ />
+ </Route>
+ <Route path="/unauthorized" element={<div>unauthorized</div>} />
+ </>,
+ {
+ storeInitialState: createMockState({
+ currentUser,
+ settings: createMockSettingsState({ "has-user-setup": true }),
+ }),
+ withRouter: true,
+ initialRoute: "/monitor/notifications",
+ },
+ );
+ };
+
+ it("renders the page for superusers", async () => {
+ setup({ currentUser: createMockUser({ is_superuser: true }) });
+
+ expect(await screen.findByText("alerts page")).toBeInTheDocument();
+ });
+
+ it("redirects a non-admin with monitoring permission to unauthorized without redirect-back", async () => {
+ const { history } = setup({
+ currentUser: createMockUser({
+ is_superuser: false,
+ is_data_analyst: false,
+ permissions: { can_access_monitoring: true },
+ }),
+ });
+
+ await waitFor(() => {
+ expect(history?.getCurrentLocation().pathname).toBe("/unauthorized");
+ });
+
+ expect(history?.getCurrentLocation().query).toEqual({});
+ expect(screen.queryByText("alerts page")).not.toBeInTheDocument();
+ });
+
+ it("redirects an analyst to unauthorized without redirect-back", async () => {
+ const { history } = setup({
+ currentUser: createMockUser({
+ is_superuser: false,
+ is_data_analyst: true,
+ }),
+ });
+
+ await waitFor(() => {
+ expect(history?.getCurrentLocation().pathname).toBe("/unauthorized");
+ });
+
+ expect(history?.getCurrentLocation().query).toEqual({});
+ expect(screen.queryByText("alerts page")).not.toBeInTheDocument();
+ });
+ });
+
describe("isBackendOnlyPath", () => {
it("should return true for /oauth/ paths", () => {
expect(isBackendOnlyPath("/oauth/authorize")).toBe(true);
diff --git a/frontend/src/metabase/routes.tsx b/frontend/src/metabase/routes.tsx
index c2140e45f7d..8e23c059736 100644
--- a/frontend/src/metabase/routes.tsx
+++ b/frontend/src/metabase/routes.tsx
@@ -43,6 +43,7 @@ import { getMetricRoutes } from "metabase/metrics/routes";
import { MetricsViewerPage } from "metabase/metrics-viewer";
import NewModelOptions from "metabase/models/containers/NewModelOptions";
import { getRoutes as getModelRoutes } from "metabase/models/routes";
+import { getMonitorRedirects, getMonitorRoutes } from "metabase/monitor/routes";
import {
PLUGIN_COLLECTIONS,
PLUGIN_DATA_APPS,
@@ -75,8 +76,12 @@ import {
withRouteProps,
} from "metabase/router";
import {
+ CanAccessAlertsManagement,
CanAccessDataModel,
CanAccessDataStudio,
+ CanAccessMonitor,
+ CanAccessMonitorDiagnostics,
+ CanAccessMonitoringTools,
CanAccessOnboarding,
CanAccessSettings,
IsAdmin,
@@ -409,6 +414,14 @@ export const getRoutes = (store: AppStore) => {
CanAccessDataModel,
IsAdmin,
)}
+
+ {/* MONITOR */}
+ {getMonitorRoutes(
+ CanAccessMonitor,
+ CanAccessMonitorDiagnostics,
+ CanAccessMonitoringTools,
+ CanAccessAlertsManagement,
+ )}
</Route>
</Route>
@@ -435,6 +448,9 @@ export const getRoutes = (store: AppStore) => {
element={redirect("/data-studio/transforms/*")}
/>
+ {/* Dependency diagnostics moved from /data-studio to /monitor */}
+ {getMonitorRedirects()}
+
{/* MISC */}
<Route path="/unsubscribe" element={<RoutedUnsubscribePage />} />
<Route path="/unauthorized" element={<Unauthorized />} />
diff --git a/frontend/src/metabase/ui/components/data-display/TreeTable/TreeTable.tsx b/frontend/src/metabase/ui/components/data-display/TreeTable/TreeTable.tsx
index 7fab564b5bb..73e1ec1713c 100644
--- a/frontend/src/metabase/ui/components/data-display/TreeTable/TreeTable.tsx
+++ b/frontend/src/metabase/ui/components/data-display/TreeTable/TreeTable.tsx
@@ -37,6 +37,7 @@ export function TreeTable<TData extends TreeNodeData>({
headerCheckboxAriaLabel,
isChildrenLoading,
isRowDisabled,
+ isRowLoading,
getRowProps,
getRowHref,
renderSubRow,
@@ -69,6 +70,16 @@ export function TreeTable<TData extends TreeNodeData>({
const handleKeyDownWithFocus = useCallback(
(event: KeyboardEvent<HTMLElement>) => {
+ const isCheckboxFocused =
+ event.target instanceof HTMLInputElement &&
+ event.target.type === "checkbox";
+
+ // Flat tables let the focused checkbox handle its own space activation
+ // instead of toggling the keyboard-highlighted row.
+ if (!hierarchical && event.key === " " && isCheckboxFocused) {
+ return;
+ }
+
handleKeyDown(event);
// Ensure focus stays on root after keyboard navigation
if (
@@ -80,7 +91,7 @@ export function TreeTable<TData extends TreeNodeData>({
rootRef.current?.focus();
}
},
- [handleKeyDown],
+ [handleKeyDown, hierarchical],
);
useEffect(() => {
@@ -159,6 +170,7 @@ export function TreeTable<TData extends TreeNodeData>({
onRowDoubleClick={onRowDoubleClick}
isDisabled={isRowDisabled?.(row)}
isChildrenLoading={isChildrenLoading?.(row)}
+ isLoading={isRowLoading?.(row)}
getSelectionState={getSelectionState}
onCheckboxClick={onCheckboxClick}
classNames={classNames}
diff --git a/frontend/src/metabase/ui/components/data-display/TreeTable/TreeTableRow/TreeTableRow.tsx b/frontend/src/metabase/ui/components/data-display/TreeTable/TreeTableRow/TreeTableRow.tsx
index 933bc07e69e..df37354c4cc 100644
--- a/frontend/src/metabase/ui/components/data-display/TreeTable/TreeTableRow/TreeTableRow.tsx
+++ b/frontend/src/metabase/ui/components/data-display/TreeTable/TreeTableRow/TreeTableRow.tsx
@@ -3,14 +3,19 @@ import { flexRender } from "@tanstack/react-table";
import cx from "classnames";
import type { MouseEvent } from "react";
import { memo, useMemo } from "react";
+import { t } from "ttag";
// eslint-disable-next-line boundaries/element-types -- this UI-library row renders a routing Link; it predates the metabase/router facade and should move out of metabase/ui
import { Link } from "metabase/router";
-import { Flex } from "metabase/ui";
+import { Flex, Loader } from "metabase/ui";
import { ExpandButton } from "../ExpandButton";
import { SelectionCheckbox } from "../SelectionCheckbox";
-import { DEFAULT_ROW_HEIGHT, TREE_CELL_BASE_PADDING } from "../constants";
+import {
+ CHECKBOX_COLUMN_WIDTH,
+ DEFAULT_ROW_HEIGHT,
+ TREE_CELL_BASE_PADDING,
+} from "../constants";
import type {
SelectionState,
TreeNodeData,
@@ -35,6 +40,7 @@ interface TreeTableRowContentProps<
selectedRowId: string | null;
isDisabled?: boolean;
isChildrenLoading?: boolean;
+ isLoading?: boolean;
isExpanded: boolean;
canExpand: boolean;
getSelectionState?: (row: Row<TData>) => SelectionState;
@@ -60,6 +66,7 @@ const TreeTableRowContent = memo(function TreeTableRowContent<
selectedRowId,
isDisabled,
isChildrenLoading,
+ isLoading,
isExpanded,
canExpand,
getSelectionState,
@@ -85,6 +92,21 @@ const TreeTableRowContent = memo(function TreeTableRowContent<
? "some"
: "none";
+ const isCheckboxDisabled =
+ isDisabled || (!getSelectionState && !row.getCanSelect());
+
+ const handleCheckboxToggle = (event: MouseEvent) => {
+ event.stopPropagation();
+ if (isLoading || isCheckboxDisabled) {
+ return;
+ }
+ if (onCheckboxClick) {
+ onCheckboxClick(row, rowIndex, event);
+ } else {
+ row.toggleSelected();
+ }
+ };
+
return (
<Flex
{...rowProps}
@@ -111,21 +133,24 @@ const TreeTableRowContent = memo(function TreeTableRowContent<
onDoubleClick={(e) => onRowDoubleClick?.(row, e)}
>
{showCheckboxes && (
- <Flex align="center" pl="0.75rem" className={S.checkboxWrapper}>
- <SelectionCheckbox
- isSelected={selectionState === "all"}
- isSomeSelected={selectionState === "some"}
- disabled={isDisabled || (!getSelectionState && !row.getCanSelect())}
- onClick={(e) => {
- e.stopPropagation();
- if (onCheckboxClick) {
- onCheckboxClick(row, rowIndex, e);
- } else {
- row.toggleSelected();
- }
- }}
- className={classNames?.checkbox}
- />
+ <Flex
+ align="center"
+ pl="0.75rem"
+ w={CHECKBOX_COLUMN_WIDTH}
+ className={S.checkboxWrapper}
+ onClick={handleCheckboxToggle}
+ >
+ {isLoading ? (
+ <Loader size="xs" color="core-brand" aria-label={t`Loading`} />
+ ) : (
+ <SelectionCheckbox
+ isSelected={selectionState === "all"}
+ isSomeSelected={selectionState === "some"}
+ disabled={isCheckboxDisabled}
+ onClick={handleCheckboxToggle}
+ className={classNames?.checkbox}
+ />
+ )}
</Flex>
)}
{visibleCells.map((cell, colIndex) => {
@@ -217,6 +242,7 @@ export function TreeTableRow<TData extends TreeNodeData>({
onRowDoubleClick,
isDisabled,
isChildrenLoading,
+ isLoading,
getSelectionState,
onCheckboxClick,
classNames,
@@ -241,6 +267,7 @@ export function TreeTableRow<TData extends TreeNodeData>({
selectedRowId={selectedRowId ?? null}
isDisabled={isDisabled}
isChildrenLoading={isChildrenLoading}
+ isLoading={isLoading}
isExpanded={isExpanded}
canExpand={canExpand}
getSelectionState={getSelectionState}
diff --git a/frontend/src/metabase/ui/components/data-display/TreeTable/TreeTableRow/TreeTableRow.unit.spec.tsx b/frontend/src/metabase/ui/components/data-display/TreeTable/TreeTableRow/TreeTableRow.unit.spec.tsx
new file mode 100644
index 00000000000..74823b12330
--- /dev/null
+++ b/frontend/src/metabase/ui/components/data-display/TreeTable/TreeTableRow/TreeTableRow.unit.spec.tsx
@@ -0,0 +1,128 @@
+import userEvent from "@testing-library/user-event";
+
+import { renderWithProviders, screen } from "__support__/ui";
+
+import { useTreeTableInstance } from "../hooks";
+import type { TreeNodeData, TreeTableColumnDef } from "../types";
+
+import { TreeTableRow } from "./TreeTableRow";
+
+interface TestNode extends TreeNodeData {
+ id: string;
+ name: string;
+}
+
+const DATA: TestNode[] = [{ id: "1", name: "Orders" }];
+
+const COLUMNS: TreeTableColumnDef<TestNode>[] = [
+ {
+ id: "name",
+ header: "Name",
+ cell: ({ row }) => <span>{row.original.name}</span>,
+ },
+];
+
+interface SetupOpts {
+ isDisabled?: boolean;
+ enableRowSelection?: boolean;
+ onCheckboxClick?: (index: number) => void;
+}
+
+function setup({
+ isDisabled,
+ enableRowSelection = true,
+ onCheckboxClick,
+}: SetupOpts = {}) {
+ function RowContainer() {
+ const instance = useTreeTableInstance({
+ data: DATA,
+ columns: COLUMNS,
+ getNodeId: (node) => node.id,
+ enableRowSelection,
+ });
+ const row = instance.rows[0];
+ const selectedIds = Object.keys(instance.table.getState().rowSelection);
+
+ return (
+ <>
+ <div data-testid="selected-ids">{selectedIds.join(",")}</div>
+ <TreeTableRow
+ row={row}
+ rowIndex={0}
+ virtualItemOrPinnedPosition="top"
+ table={instance.table}
+ columnWidths={instance.columnWidths}
+ showCheckboxes
+ showExpandButtons={false}
+ indentWidth={20}
+ activeRowId={null}
+ selectedRowId={null}
+ isExpanded={false}
+ canExpand={false}
+ measureElement={() => {}}
+ isDisabled={isDisabled}
+ onCheckboxClick={
+ onCheckboxClick ? (_, index) => onCheckboxClick(index) : undefined
+ }
+ hierarchical={false}
+ />
+ </>
+ );
+ }
+
+ renderWithProviders(<RowContainer />);
+}
+
+function getCheckboxWrapper() {
+ // Cast to avoid additional checks in tests.
+ return screen.getByRole("row").firstElementChild as HTMLElement;
+}
+
+describe("TreeTableRow checkbox wrapper", () => {
+ it("does not fire onCheckboxClick when the row is disabled", async () => {
+ const onCheckboxClick = jest.fn();
+ setup({ isDisabled: true, onCheckboxClick });
+
+ await userEvent.click(getCheckboxWrapper());
+
+ expect(onCheckboxClick).not.toHaveBeenCalled();
+ });
+
+ it("does not toggle selection via the default path when the row is disabled", async () => {
+ setup({ isDisabled: true });
+
+ expect(screen.getByTestId("selected-ids")).toBeEmptyDOMElement();
+
+ await userEvent.click(getCheckboxWrapper());
+
+ expect(screen.getByTestId("selected-ids")).toBeEmptyDOMElement();
+ });
+
+ it("fires onCheckboxClick on a wrapper click for an enabled row", async () => {
+ const onCheckboxClick = jest.fn();
+ setup({ onCheckboxClick });
+
+ await userEvent.click(getCheckboxWrapper());
+
+ expect(onCheckboxClick).toHaveBeenCalledWith(0);
+ });
+
+ it("toggles selection on a wrapper click for an enabled row", async () => {
+ setup();
+
+ expect(screen.getByTestId("selected-ids")).toBeEmptyDOMElement();
+
+ await userEvent.click(getCheckboxWrapper());
+
+ expect(screen.getByTestId("selected-ids")).toHaveTextContent("1");
+ });
+
+ it("does not fire onCheckboxClick when the row cannot be selected", async () => {
+ const onCheckboxClick = jest.fn();
+ setup({ enableRowSelection: false, onCheckboxClick });
+
+ await userEvent.click(getCheckboxWrapper());
+
+ expect(onCheckboxClick).not.toHaveBeenCalled();
+ });
+});
diff --git a/frontend/src/metabase/ui/components/data-display/TreeTable/types.ts b/frontend/src/metabase/ui/components/data-display/TreeTable/types.ts
index 2c3baf907f6..cc73c054cd0 100644
--- a/frontend/src/metabase/ui/components/data-display/TreeTable/types.ts
+++ b/frontend/src/metabase/ui/components/data-display/TreeTable/types.ts
@@ -256,6 +256,12 @@ export interface TreeTableProps<
*/
isRowDisabled?: (row: Row<TData>) => boolean;
+ /**
+ * Callback to determine if a row has an operation in progress. When true,
+ * the row's selection checkbox is replaced by a loading spinner.
+ */
+ isRowLoading?: (row: Row<TData>) => boolean;
+
/**
* Callback to get additional props for each row element.
* Useful for adding test IDs or custom data attributes.
@@ -303,6 +309,7 @@ export interface TreeTableRowProps<
onRowDoubleClick?: (row: Row<TData>, event: MouseEvent) => void;
isDisabled?: boolean;
isChildrenLoading?: boolean;
+ isLoading?: boolean;
getSelectionState?: (row: Row<TData>) => SelectionState;
onCheckboxClick?: (row: Row<TData>, index: number, event: MouseEvent) => void;
getRowProps?: (row: Row<TData>) => Record<string, unknown>;
diff --git a/frontend/src/metabase/ui/components/icons/Icon/icons/clipboard.svg b/frontend/src/metabase/ui/components/icons/Icon/icons/clipboard.svg
index 914effd6c68..c14d91dd408 100644
--- a/frontend/src/metabase/ui/components/icons/Icon/icons/clipboard.svg
+++ b/frontend/src/metabase/ui/components/icons/Icon/icons/clipboard.svg
@@ -1,3 +1,3 @@
-<svg viewBox="0 0 32 32" fill="currentcolor" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
- <path d="M8.54667751,5.50894675 L6.00494659,5.50894675 C4.89702623,5.50894675 4,6.40070914 4,7.50075379 L4,30.0171397 C4,31.1120596 4.89764516,32.0089468 6.00494659,32.0089468 L25.9950534,32.0089468 C27.1029738,32.0089468 28,31.1171844 28,30.0171397 L28,7.50075379 C28,6.40583387 27.1023548,5.50894675 25.9950534,5.50894675 L23.5373296,5.50894675 L23.5373296,3.0446713 L19.9106557,3.0446713 C19.9106557,3.0446713 19.6485834,8.05825522e-08 16.0837607,0 C12.518938,-8.05825523e-08 12.1644547,3.04776207 12.1644547,3.04776207 L8.57253264,3.04776207 L8.54667751,5.50894675 Z M23.5373296,7.50894675 L26,7.50894675 L26,30.0089468 L6,30.0089468 L6,7.50894675 L8.52566721,7.50894675 L8.4996301,9.98745456 L23.5373296,9.98745456 L23.5373296,7.50894675 Z M10.573037,5.01478303 L13.9861608,5.01478303 L13.9861608,3.76128231 C13.9861608,3.76128231 14.0254332,1.94834752 16.0135743,1.94834752 C18.0017155,1.94834752 18.0017156,3.7055821 18.0017156,3.7055821 L18.0017156,4.94060459 L21.4955568,4.94060459 L21.4955568,8.03924122 L10.5173901,8.03924122 L10.573037,5.01478303 Z M16,5.00894675 C16.5522847,5.00894675 17,4.5612315 17,4.00894675 C17,3.456662 16.5522847,3.00894675 16,3.00894675 C15.4477153,3.00894675 15,3.456662 15,4.00894675 C15,4.5612315 15.4477153,5.00894675 16,5.00894675 Z M8.5,18.0089468 L8.5,21.0082323 L11.5,21.0082323 L11.5,18.0446111 L8.5,18.0089468 Z M8.5,23.0089468 L8.5,26.0082323 L11.5,26.0082323 L11.5,23.0446111 L8.5,23.0089468 Z M8.5,13.0089468 L8.5,16.0082323 L11.5,16.0082323 L11.5,13.0446111 L8.5,13.0089468 Z M13.5,13.0193041 L13.5,16 L23.5,16 L23.5,13 L13.5,13.0193041 Z M13.5,23.0193041 L13.5,26 L23.5,26 L23.5,23 L13.5,23.0193041 Z M13.5,18.0193041 L13.5,21 L23.5,21 L23.5,18 L13.5,18.0193041 Z" />
+<svg viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+ <path d="M9.872.95c.721 0 1.312.554 1.373 1.259h.514a2.008 2.008 0 0 1 2.009 2.009v8.808a2.01 2.01 0 0 1-2.01 2.008H4.21A2.01 2.01 0 0 1 2.2 13.026V4.218a2.01 2.01 0 0 1 2.009-2.01h.515A1.379 1.379 0 0 1 6.097.95h3.775zM4.21 3.709a.51.51 0 0 0-.509.509v8.808a.51.51 0 0 0 .509.508h7.55a.51.51 0 0 0 .509-.508V4.218a.511.511 0 0 0-.51-.51h-.513a1.378 1.378 0 0 1-1.373 1.259H6.097c-.721 0-1.312-.553-1.373-1.258h-.515zm1.348 6.05a.75.75 0 0 1 0 1.5H5.55a.75.75 0 0 1 0-1.5h.007zm4.944.125a.625.625 0 0 1 0 1.25H7.984a.625.625 0 1 1 0-1.25h2.517zm-4.944-3.27a.75.75 0 0 1 0 1.5H5.55a.75.75 0 0 1 0-1.5h.007zm4.944.124a.625.625 0 0 1 0 1.25H7.984a.625.625 0 0 1 0-1.25h2.517zM6.218 3.467H9.75v-.49L9.75 2.96l.001-.02V2.45H6.218v1.017z" />
</svg>
diff --git a/frontend/src/metabase/ui/components/icons/Icon/icons/pulse.svg b/frontend/src/metabase/ui/components/icons/Icon/icons/pulse.svg
index 7f6c3c7fab2..e88d0e44468 100644
--- a/frontend/src/metabase/ui/components/icons/Icon/icons/pulse.svg
+++ b/frontend/src/metabase/ui/components/icons/Icon/icons/pulse.svg
@@ -1,3 +1,3 @@
-<svg viewBox="0 0 32 32" fill="currentcolor" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
- <path d="M16.9862306,27.387699 C17.4904976,29.2137955 20.0148505,29.3806482 20.7550803,27.6368095 L24.8588086,17.9692172 L31.7352165,17.9692172 L31.7352165,13.9692172 L23.5350474,13.9692172 C22.7324769,13.9692172 22.0076375,14.4489743 21.6940431,15.1877423 L19.314793,20.7927967 L14.8067319,4.4678059 C14.3010535,2.63659841 11.7668377,2.47581319 11.033781,4.22842821 L6.99549907,13.8832799 L0,13.8832799 L0,17.8832799 L8.32686781,17.8832799 C9.13327931,17.8832799 9.86080237,17.3989791 10.1719732,16.655022 L12.491241,11.1100437 L16.9862306,27.387699 Z" />
+<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M2 8H5L6.5 2L8 8L9.5 14L11 8H14" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/>
</svg>
diff --git a/frontend/src/metabase/urls/admin.ts b/frontend/src/metabase/urls/admin.ts
index 0af27fc9a17..81219cb834e 100644
--- a/frontend/src/metabase/urls/admin.ts
+++ b/frontend/src/metabase/urls/admin.ts
@@ -6,9 +6,6 @@ import type {
SchemaName,
SegmentId,
TableId,
- TaskRunDateFilterOption,
- TaskRunEntityType,
- TaskRunType,
} from "metabase-types/api";
export const isInternalUser = (user: Pick<BaseUser, "tenant_id">) =>
@@ -167,76 +164,10 @@ export function customVizDev() {
return `${customViz()}/development`;
}
-export function adminToolsHelp() {
- return "/admin/tools/help";
+export function adminHelp() {
+ return "/admin/help";
}
-export function adminToolsTasks() {
- return "/admin/tools/tasks";
-}
-export function adminToolsTasksList() {
- return `${adminToolsTasks()}/list`;
-}
-
-export function adminToolsTaskDetails(taskId: number) {
- return `${adminToolsTasksList()}/${taskId}`;
-}
-
-export function adminToolsTasksRuns() {
- return `${adminToolsTasks()}/runs`;
-}
-
-export function adminToolsTaskRunDetails(runId: number) {
- return `${adminToolsTasksRuns()}/${runId}`;
-}
-
-export function adminToolsTasksRunsFor(opts: {
- runType: TaskRunType;
- entityType: TaskRunEntityType;
- entityId?: number;
- startedAt?: TaskRunDateFilterOption;
- includeToday?: boolean;
-}) {
- const params: Record<string, string> = {
- "run-type": opts.runType,
- "entity-type": opts.entityType,
- };
- if (opts.entityId) {
- params["entity-id"] = String(opts.entityId);
- }
- if (opts.startedAt) {
- params["started-at"] = opts.startedAt;
- }
- if (opts.includeToday) {
- params["include-today"] = "true";
- }
- return `${adminToolsTasksRuns()}?${new URLSearchParams(params).toString()}`;
-}
-
-export function adminToolsJobs() {
- return "/admin/tools/jobs";
-}
-
-export function adminToolsLogs() {
- return "/admin/tools/logs";
-}
-
-export function adminToolsErrors() {
- return "/admin/tools/errors";
-}
-
-export function adminToolsModelCaching() {
- return "/admin/tools/model-caching";
-}
-
-export function adminToolsGrantAccess() {
- return "/admin/tools/help/grant-access";
-}
-
-export function adminToolsNotifications() {
- return "/admin/tools/notifications";
-}
-
-export function adminToolsNotificationDetail(id: number) {
- return `/admin/tools/notifications/${id}`;
+export function adminHelpGrantAccess() {
+ return `${adminHelp()}/grant-access`;
}
diff --git a/frontend/src/metabase/urls/dependencies.ts b/frontend/src/metabase/urls/dependencies.ts
index 63737de1721..64c517e44c7 100644
--- a/frontend/src/metabase/urls/dependencies.ts
+++ b/frontend/src/metabase/urls/dependencies.ts
@@ -5,9 +5,8 @@ import type {
SortDirection,
} from "metabase-types/api";
-const BASE_URL = `/data-studio`;
-const GRAPH_URL = `${BASE_URL}/dependencies`;
-const DIAGNOSTICS_URL = `${BASE_URL}/dependency-diagnostics`;
+const GRAPH_URL = `/data-studio/dependencies`;
+const DIAGNOSTICS_URL = `/monitor/dependency-diagnostics`;
export type DependencyGraphParams = {
entry?: DependencyEntry;
diff --git a/frontend/src/metabase/urls/index.ts b/frontend/src/metabase/urls/index.ts
index 44f3c63d020..ce571185179 100644
--- a/frontend/src/metabase/urls/index.ts
+++ b/frontend/src/metabase/urls/index.ts
@@ -14,6 +14,7 @@ export * from "./indexed-entities";
export * from "./metabot";
export * from "./metrics";
export * from "./misc";
+export * from "./monitor";
export * from "./models";
export * from "./modelToUrl";
export * from "./permissions";
diff --git a/frontend/src/metabase/urls/monitor.ts b/frontend/src/metabase/urls/monitor.ts
new file mode 100644
index 00000000000..107c130ce86
--- /dev/null
+++ b/frontend/src/metabase/urls/monitor.ts
@@ -0,0 +1,90 @@
+import type {
+ TaskRunDateFilterOption,
+ TaskRunEntityType,
+ TaskRunType,
+} from "metabase-types/api";
+
+const ROOT_URL = "/monitor";
+
+export function monitor() {
+ return ROOT_URL;
+}
+
+export function monitorTasks() {
+ return `${ROOT_URL}/tasks`;
+}
+
+export function monitorTasksList() {
+ return `${monitorTasks()}/list`;
+}
+
+export function monitorTaskDetails(taskId: number) {
+ return `${monitorTasksList()}/${taskId}`;
+}
+
+export function monitorTasksRuns() {
+ return `${monitorTasks()}/runs`;
+}
+
+export function monitorTaskRunDetails(runId: number) {
+ return `${monitorTasksRuns()}/${runId}`;
+}
+
+export function monitorTasksRunsFor(opts: {
+ runType: TaskRunType;
+ entityType: TaskRunEntityType;
+ entityId?: number;
+ startedAt?: TaskRunDateFilterOption;
+ includeToday?: boolean;
+}) {
+ const params: Record<string, string> = {
+ "run-type": opts.runType,
+ "entity-type": opts.entityType,
+ };
+ if (opts.entityId) {
+ params["entity-id"] = String(opts.entityId);
+ }
+ if (opts.startedAt) {
+ params["started-at"] = opts.startedAt;
+ }
+ if (opts.includeToday) {
+ params["include-today"] = "true";
+ }
+ return `${monitorTasksRuns()}?${new URLSearchParams(params).toString()}`;
+}
+
+export function monitorJobs() {
+ return `${ROOT_URL}/jobs`;
+}
+
+export function monitorJobTriggers(jobKey: string) {
+ return `${monitorJobs()}/${jobKey}`;
+}
+
+export function monitorLogs() {
+ return `${ROOT_URL}/logs`;
+}
+
+export function monitorLogLevels() {
+ return `${monitorLogs()}/levels`;
+}
+
+export function monitorErroringQuestions() {
+ return `${ROOT_URL}/errors`;
+}
+
+export function monitorModelCaching() {
+ return `${ROOT_URL}/model-caching`;
+}
+
+export function monitorModelCacheRefreshJob(jobId: number) {
+ return `${monitorModelCaching()}/${jobId}`;
+}
+
+export function monitorNotifications() {
+ return `${ROOT_URL}/notifications`;
+}
+
+export function monitorNotificationDetail(id: number) {
+ return `${monitorNotifications()}/${id}`;
+}
diff --git a/frontend/src/metabase/utils/sorting.ts b/frontend/src/metabase/utils/sorting.ts
new file mode 100644
index 00000000000..654bf1ece74
--- /dev/null
+++ b/frontend/src/metabase/utils/sorting.ts
@@ -0,0 +1,64 @@
+import type { SortingState } from "@tanstack/react-table";
+
+import type { SortDirection, SortingOptions } from "metabase-types/api";
+
+export type Sorting<TColumn extends string> = {
+ column: TColumn;
+ direction: SortDirection;
+};
+
+export function toSorting<TColumn extends string>({
+ sort_column,
+ sort_direction,
+}: SortingOptions<TColumn>): Sorting<TColumn> {
+ return { column: sort_column, direction: sort_direction };
+}
+
+export function toSortingOptions<TColumn extends string>({
+ column,
+ direction,
+}: Sorting<TColumn>): SortingOptions<TColumn> {
+ return { sort_column: column, sort_direction: direction };
+}
+
+export function getSortingState<TColumn extends string>(
+ sorting: Sorting<TColumn> | undefined,
+): SortingState {
+ return sorting == null
+ ? []
+ : [{ id: sorting.column, desc: sorting.direction === "desc" }];
+}
+
+export function isSortColumn<TColumn extends string>(
+ id: string,
+ columns: readonly TColumn[],
+): id is TColumn {
+ return columns.some((column) => column === id);
+}
+
+// Helper to drop 'undefined' from TanStack's sorting cycle (for always-sorted tables).
+export function getNextSorting<TColumn extends string>(
+ sortingState: SortingState,
+ columns: readonly TColumn[],
+ current: Sorting<TColumn>,
+): Sorting<TColumn> {
+ const [firstSort] = sortingState;
+ if (firstSort != null && isSortColumn(firstSort.id, columns)) {
+ return { column: firstSort.id, direction: firstSort.desc ? "desc" : "asc" };
+ }
+ return {
+ column: current.column,
+ direction: current.direction === "desc" ? "asc" : "desc",
+ };
+}
+
+export function getNextOptionalSorting<TColumn extends string>(
+ sortingState: SortingState,
+ columns: readonly TColumn[],
+): Sorting<TColumn> | undefined {
+ const [firstSort] = sortingState;
+ if (firstSort != null && isSortColumn(firstSort.id, columns)) {
+ return { column: firstSort.id, direction: firstSort.desc ? "desc" : "asc" };
+ }
+ return undefined;
+}
diff --git a/frontend/test/__support__/enterprise-typed.ts b/frontend/test/__support__/enterprise-typed.ts
index 6e61a363ab4..a2c05a1384c 100644
--- a/frontend/test/__support__/enterprise-typed.ts
+++ b/frontend/test/__support__/enterprise-typed.ts
@@ -9,6 +9,8 @@ export const ENTERPRISE_PLUGIN_NAME_MAPPING = {
sandboxes: "metabase-enterprise/sandboxes",
clean_up: "metabase-enterprise/clean_up",
tools: "metabase-enterprise/monitor/tools",
+ monitor_dependency_diagnostics:
+ "metabase-enterprise/monitor/dependency-diagnostics",
advanced_permissions: "metabase-enterprise/advanced_permissions",
sharing: "metabase-enterprise/sharing",
metabot: "metabase-enterprise/metabot",
diff --git a/frontend/test/__support__/server-mocks/task.ts b/frontend/test/__support__/server-mocks/task.ts
index 758709d08fa..462967c57d6 100644
--- a/frontend/test/__support__/server-mocks/task.ts
+++ b/frontend/test/__support__/server-mocks/task.ts
@@ -4,6 +4,7 @@ import type {
ListTaskRunsResponse,
ListTasksResponse,
Task,
+ TaskInfo,
TaskRunExtended,
} from "metabase-types/api";
@@ -26,6 +27,13 @@ export function setupUniqueTasksEndpoint(
fetchMock.get(`path:/api/task/unique-tasks`, tasks, options);
}
+export function setupTasksInfoEndpoint(
+ taskInfo: TaskInfo,
+ options?: UserRouteConfig,
+) {
+ fetchMock.get("path:/api/task/info", taskInfo, options);
+}
+
export function setupTaskRunsEndpoints(
response: ListTaskRunsResponse,
options?: UserRouteConfig,
diff --git a/resources/user_key_value_types/monitor.edn b/resources/user_key_value_types/monitor.edn
new file mode 100644
index 00000000000..349f7ef36a3
--- /dev/null
+++ b/resources/user_key_value_types/monitor.edn
@@ -0,0 +1,2 @@
+[:map
+ [:value :boolean]]
diff --git a/src/metabase/channel/urls.clj b/src/metabase/channel/urls.clj
index a9458d675f5..b16de1ff6ca 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/admin/tools/model-caching/%d" (site-url) persisted-info-id))
+ (format "%s/monitor/model-caching/%d" (site-url) persisted-info-id))
(defn transform-job-url
"URL for a transform job."
diff --git a/src/metabase/task_history/api.clj b/src/metabase/task_history/api.clj
index 10917cdb45e..21bc33cd1d7 100644
--- a/src/metabase/task_history/api.clj
+++ b/src/metabase/task_history/api.clj
@@ -76,6 +76,15 @@
[:status {:optional true} [:enum "started" "success" "failed" "abandoned"]]
[:started-at {:optional true} ms/NonBlankString]])
+(def ^:private run-sort-columns
+ "Columns that runs can be sorted by. `:entity_name` and `:task_count` are derived via joins in [[runs-order-by]]."
+ #{:started_at :ended_at :run_type :status :entity_name :task_count})
+
+(mr/def ::RunSortParams
+ [:map
+ [:sort-column {:default :started_at} (into [:enum] run-sort-columns)]
+ [:sort-direction {:default :desc} [:enum :asc :desc]]])
+
(mr/def ::TaskRun
[:map
[:id ms/PositiveInt]
@@ -148,8 +157,10 @@
(let [run-ids (map :id runs)
counts (t2/query {:select [:run_id
[[:count :id] :task_count]
- [[:raw "SUM(CASE WHEN status = 'success' THEN 1 ELSE 0 END)"] :success_count]
- [[:raw "SUM(CASE WHEN status = 'failed' THEN 1 ELSE 0 END)"] :failed_count]]
+ [[:raw "SUM(CASE WHEN status = 'success' THEN 1 ELSE 0 END)"]
+ :success_count]
+ [[:raw "SUM(CASE WHEN status = 'failed' THEN 1 ELSE 0 END)"]
+ :failed_count]]
:from :task_history
:where [:in :run_id run-ids]
:group-by [:run_id]})
@@ -183,28 +194,59 @@
(defn- build-run-where-clause
[{:keys [run-type entity-type entity-id status started-at]}]
+ ;; columns are qualified because the entity_name/task_count sorts add joins whose tables may share column names
+ ;; (e.g. report_card.entity_id)
(let [conditions (cond-> []
- run-type (conj [:= :run_type run-type])
- entity-type (conj [:= :entity_type entity-type])
- entity-id (conj [:= :entity_id entity-id])
- status (conj [:= :status status])
- started-at (conj (timestamp-constraint :started_at started-at)))]
+ run-type (conj [:= :task_run.run_type run-type])
+ entity-type (conj [:= :task_run.entity_type entity-type])
+ entity-id (conj [:= :task_run.entity_id entity-id])
+ status (conj [:= :task_run.status status])
+ started-at (conj (timestamp-constraint :task_run.started_at started-at)))]
(if (seq conditions)
{:where (into [:and] conditions)}
{})))
+(defn- runs-order-by
+ "Build the honeysql fragment used to order the task runs list. Direct columns order in place; `:entity_name`
+ LEFT JOINs the three entity tables and orders by the coalesced name; `:task_count` LEFT JOINs a grouped
+ `task_history` subquery. Derived-column variants keep the selected shape to `task_run.*` and add a
+ deterministic `[:id :desc]` secondary key."
+ [{col :sort-column dir :sort-direction}]
+ (let [secondary [:task_run.id :desc]]
+ (case col
+ :entity_name
+ {:select [:task_run.*]
+ :left-join [[:metabase_database :sort_db]
+ [:and [:= :task_run.entity_type "database"] [:= :task_run.entity_id :sort_db.id]]
+ [:report_card :sort_card]
+ [:and [:= :task_run.entity_type "card"] [:= :task_run.entity_id :sort_card.id]]
+ [:report_dashboard :sort_dash]
+ [:and [:= :task_run.entity_type "dashboard"] [:= :task_run.entity_id :sort_dash.id]]]
+ :order-by [[[:coalesce :sort_db.name :sort_card.name :sort_dash.name] dir] secondary]}
+
+ :task_count
+ {:select [:task_run.*]
+ :left-join [[{:select [:run_id [[:count :*] :task_count]]
+ :from [:task_history]
+ :group-by [:run_id]}
+ :sort_tc]
+ [:= :sort_tc.run_id :task_run.id]]
+ :order-by [[[:coalesce :sort_tc.task_count [:inline 0]] dir] secondary]}
+
+ {:order-by [[col dir] secondary]})))
+
(api.macros/defendpoint :get "/runs" :- ::TaskRunsResponse
"List task runs with optional filters. Returns runs with hydrated entity names and task counts."
[_
- params :- [:maybe ::RunFilterParams]]
+ params :- [:maybe [:merge ::RunFilterParams ::RunSortParams]]]
(perms/check-has-application-permission :monitoring)
(let [where-clause (build-run-where-clause params)
limit (request/limit)
offset (request/offset)
runs (t2/select :model/TaskRun (merge where-clause
+ (runs-order-by params)
(when limit {:limit limit})
- (when offset {:offset offset})
- {:order-by [[:started_at :desc]]}))]
+ (when offset {:offset offset})))]
{:total (t2/count :model/TaskRun where-clause)
:limit limit
:offset offset
diff --git a/src/metabase/task_history/models/task_history.clj b/src/metabase/task_history/models/task_history.clj
index b5190b2a4ad..6b8de9782d2 100644
--- a/src/metabase/task_history/models/task_history.clj
+++ b/src/metabase/task_history/models/task_history.clj
@@ -76,9 +76,10 @@
(defn- params->where
[{:keys [status task]}]
(when (or status task)
+ ;; qualified so filters stay unambiguous when the db_name/db_engine sorts join metabase_database
{:where (cond-> [:and]
- task (conj [:= :task task])
- status (conj [:= :status (name status)]))}))
+ task (conj [:= :task_history.task task])
+ status (conj [:= :task_history.status (name status)]))}))
(def FilterParams
"Schema for filter for task history."
@@ -86,13 +87,25 @@
[:status {:optional true} (into [:enum] task-history-status)]
[:task {:optional true} [:string {:min 1}]]])
+(def ^:private join-sort-columns
+ "Sort columns that require a LEFT JOIN to `metabase_database`, mapped to the joined column to order by."
+ {:db_name :metabase_database.name
+ :db_engine :metabase_database.engine})
+
(defn- params->order-by
+ "Build the honeysql fragment needed to order the task history list. For `:db_name`/`:db_engine` this adds a LEFT JOIN
+ to `metabase_database` (ordering by the joined name/engine) while keeping the selected row shape to `task_history.*`.
+ A secondary `[:id :desc]` key makes ordering deterministic for low-cardinality columns."
[{col :sort_column
dir :sort_direction}]
- {:order-by [[col dir]]})
+ (if-let [order-col (join-sort-columns col)]
+ {:select [:task_history.*]
+ :left-join [:metabase_database [:= :task_history.db_id :metabase_database.id]]
+ :order-by [[order-col dir] [:task_history.id :desc]]}
+ {:order-by [[col dir] [:id :desc]]}))
(def ^:private available-sort-columns
- #{:duration :ended_at :started_at})
+ #{:started_at :ended_at :duration :task :status :db_name :db_engine})
(def SortParams
"Sorting map schema."
diff --git a/src/metabase/warehouses/models/database.clj b/src/metabase/warehouses/models/database.clj
index 128825dd8d2..b4f805dc07e 100644
--- a/src/metabase/warehouses/models/database.clj
+++ b/src/metabase/warehouses/models/database.clj
@@ -175,7 +175,7 @@
"Hook called from the `:model/Database` before-delete. Transforms whose `source_database_id`
is about to be SET NULL by the FK action survive the delete (so the analyst can read the
SQL/Python and rebuild against a new DB), but their dependency-analysis findings need to
- be re-run so they surface on `/data-studio/dependency-diagnostics/broken`. OSS is a no-op
+ be re-run so they surface on `/monitor/dependency-diagnostics/broken`. OSS is a no-op
(no dependencies module)."
metabase-enterprise.dependencies.events
[_db-id]
diff --git a/test/metabase/channel/urls_test.clj b/test/metabase/channel/urls_test.clj
index e136975e37c..ffafabd443a 100644
--- a/test/metabase/channel/urls_test.clj
+++ b/test/metabase/channel/urls_test.clj
@@ -36,6 +36,11 @@
(is (= "https://metabase.com/dashboard/1?%26=contains%3F"
(urls/dashboard-url 1 [{:value "contains?", :slug "&"}]))))))
+(deftest tools-caching-details-url-test
+ (mt/with-temporary-setting-values [site-url "https://metabase.com"]
+ (is (= "https://metabase.com/monitor/model-caching/42"
+ (urls/tools-caching-details-url 42)))))
+
(deftest dashcard-url-test
(mt/with-temporary-setting-values [site-url "https://metabase.com"]
(testing "A valid dashcard URL can be generated without parameters"
diff --git a/test/metabase/task_history/api_test.clj b/test/metabase/task_history/api_test.clj
index 614afbbea8a..ddd4ed5e904 100644
--- a/test/metabase/task_history/api_test.clj
+++ b/test/metabase/task_history/api_test.clj
@@ -8,7 +8,8 @@
[toucan2.core :as t2]))
(def ^:private default-task-history
- {:id true, :db_id true, :started_at true, :ended_at true, :duration 10, :task_details nil :status "success" :logs nil :run_id false})
+ {:id true, :db_id true, :started_at true, :ended_at true, :duration 10, :task_details nil
+ :status "success" :logs nil :run_id false})
(defn- generate-tasks
"Creates `n` task history maps with guaranteed increasing `:ended_at` times. This means that when stored and queried
@@ -496,6 +497,67 @@
(is (=? [{:duration 10000}]
(-> response :data vec))))))))
+(deftest ^:synchronized sort-tasks-by-task-and-status-test
+ (t2/delete! :model/TaskHistory)
+ (let [now (t/zoned-date-time)
+ ;; shared random token as prefix (so rows are unique / filterable) with ordered a<b<c suffixes
+ token (mt/random-name)
+ task-a (str token "-a")
+ task-b (str token "-b")
+ task-c (str token "-c")
+ my-tasks #{task-a task-b task-c}]
+ (mt/with-temp [:model/TaskHistory _ {:task task-b :status :success :started_at now :ended_at now}
+ :model/TaskHistory _ {:task task-a :status :failed :started_at now :ended_at now}
+ :model/TaskHistory _ {:task task-c :status :started :started_at now}]
+ (letfn [(rows [& args]
+ (->> (apply mt/user-http-request :crowberto :get 200 "task/" args)
+ :data
+ (filter (comp my-tasks :task))))]
+ (testing "sort by task"
+ (is (= [task-a task-b task-c] (map :task (rows :sort_column :task :sort_direction :asc))))
+ (is (= [task-c task-b task-a] (map :task (rows :sort_column :task :sort_direction :desc)))))
+ (testing "sort by status (alphabetical: failed < started < success)"
+ (is (= ["failed" "started" "success"] (map :status (rows :sort_column :status :sort_direction :asc))))
+ (is (= ["success" "started" "failed"] (map :status (rows :sort_column :status :sort_direction :desc)))))))))
+
+(deftest ^:synchronized sort-tasks-by-db-test
+ (t2/delete! :model/TaskHistory)
+ (let [now (t/zoned-date-time)]
+ (mt/with-temp [:model/Database db-a {:name "Albatross DB"}
+ :model/Database db-b {:name "Wren DB"}
+ :model/TaskHistory _ {:task "t-a" :status :success :db_id (:id db-a) :started_at now :ended_at now}
+ :model/TaskHistory _ {:task "t-b" :status :success :db_id (:id db-b) :started_at now :ended_at now}
+ :model/TaskHistory _ {:task "t-nil" :status :success :started_at now :ended_at now}]
+ (let [tracked (fn [& args]
+ (->> (apply mt/user-http-request :crowberto :get 200 "task/" args)
+ :data
+ (map :task)
+ (filter #{"t-a" "t-b" "t-nil"})
+ vec))]
+ (testing "sort by db_name; nil db_id row is present and does not error"
+ (let [asc (tracked :sort_column :db_name :sort_direction :asc)
+ desc (tracked :sort_column :db_name :sort_direction :desc)]
+ (is (= #{"t-a" "t-b" "t-nil"} (set asc)))
+ (is (= 3 (count asc)))
+ ;; Albatross DB before Wren DB, and reversed for desc (nil position is DB-dependent, so only
+ ;; assert the two named)
+ (is (< (u/index-of #{"t-a"} asc) (u/index-of #{"t-b"} asc)))
+ (is (< (u/index-of #{"t-b"} desc) (u/index-of #{"t-a"} desc)))))
+ (testing "sort by db_engine (aaa-engine < zzz-engine)"
+ ;; Relabel engines via raw SQL (no Toucan hooks, so no driver init) purely to exercise ordering on the
+ ;; `engine` column; reset to h2 before with-temp teardown so deletion doesn't init a bogus driver.
+ (t2/query {:update :metabase_database :set {:engine "aaa-engine"} :where [:= :id (:id db-a)]})
+ (t2/query {:update :metabase_database :set {:engine "zzz-engine"} :where [:= :id (:id db-b)]})
+ (try
+ (let [asc (tracked :sort_column :db_engine :sort_direction :asc)
+ desc (tracked :sort_column :db_engine :sort_direction :desc)]
+ (is (= 3 (count asc)))
+ (is (< (u/index-of #{"t-a"} asc) (u/index-of #{"t-b"} asc)))
+ (is (< (u/index-of #{"t-b"} desc) (u/index-of #{"t-a"} desc))))
+ (finally
+ (t2/query {:update :metabase_database :set {:engine "h2"}
+ :where [:in :id [(:id db-a) (:id db-b)]]}))))))))
+
;;; +----------------------------------------------------------------------------------------------------------------+
;;; | Task Runs API tests |
;;; +----------------------------------------------------------------------------------------------------------------+
@@ -810,3 +872,86 @@
:started-at "past7days")]
(is (= 1 (count response)))
(is (= "DB2" (-> response first :entity_name)))))))))
+
+(deftest ^:synchronized runs-sort-test
+ (t2/delete! :model/TaskRun)
+ (t2/delete! :model/TaskHistory)
+ (let [now (t/zoned-date-time)]
+ (mt/with-temp [:model/Database db {:name "Wren DB"}
+ :model/Card card {:name "Albatross Card"}
+ :model/TaskRun run-db {:run_type :sync
+ :entity_type :database
+ :entity_id (:id db)
+ :status :success
+ :started_at (t/minus now (t/hours 2))
+ :ended_at (t/minus now (t/hours 1))}
+ :model/TaskRun run-card {:run_type :fingerprint
+ :entity_type :card
+ :entity_id (:id card)
+ :status :failed
+ :started_at (t/minus now (t/hours 1))
+ :ended_at now}
+ ;; run-db has 2 child tasks, run-card has 1
+ :model/TaskHistory _ {:task "a" :status :success :run_id (:id run-db)
+ :started_at now :ended_at now}
+ :model/TaskHistory _ {:task "b" :status :success :run_id (:id run-db)
+ :started_at now :ended_at now}
+ :model/TaskHistory _ {:task "c" :status :success :run_id (:id run-card)
+ :started_at now :ended_at now}]
+ (let [my-ids #{(:id run-db) (:id run-card)}
+ ids (fn [& args] (->> (apply mt/user-http-request :crowberto :get 200 "task/runs" args)
+ :data
+ (map :id)
+ (filter my-ids)))]
+ (testing "default order is started_at desc when no sort params given"
+ (is (= [(:id run-card) (:id run-db)] (ids))))
+ (testing "sort by started_at asc"
+ (is (= [(:id run-db) (:id run-card)] (ids :sort-column :started_at :sort-direction :asc))))
+ (testing "sort by ended_at asc"
+ (is (= [(:id run-db) (:id run-card)] (ids :sort-column :ended_at :sort-direction :asc))))
+ (testing "sort by status (failed < success)"
+ (is (= [(:id run-card) (:id run-db)] (ids :sort-column :status :sort-direction :asc)))
+ (is (= [(:id run-db) (:id run-card)] (ids :sort-column :status :sort-direction :desc))))
+ (testing "sort by run_type (fingerprint < sync)"
+ (is (= [(:id run-card) (:id run-db)] (ids :sort-column :run_type :sort-direction :asc)))
+ (is (= [(:id run-db) (:id run-card)] (ids :sort-column :run_type :sort-direction :desc))))
+ (testing "sort by entity_name across entity types (Albatross Card < Wren DB)"
+ (is (= [(:id run-card) (:id run-db)] (ids :sort-column :entity_name :sort-direction :asc)))
+ (is (= [(:id run-db) (:id run-card)] (ids :sort-column :entity_name :sort-direction :desc))))
+ (testing "sort by task_count (run-card=1 < run-db=2)"
+ (is (= [(:id run-card) (:id run-db)] (ids :sort-column :task_count :sort-direction :asc)))
+ (is (= [(:id run-db) (:id run-card)] (ids :sort-column :task_count :sort-direction :desc))))
+ (testing "invalid sort_column returns 400"
+ (is (=? {:errors {:sort-column some?}}
+ (mt/user-http-request :crowberto :get 400 "task/runs" :sort-column :bogus))))))))
+
+(deftest ^:synchronized runs-filter-with-sort-test
+ ;; the entity_name/task_count sorts add joins, so filter columns must stay unambiguous. Notably `report_card` and
+ ;; `report_dashboard` have their own `entity_id` column.
+ (t2/delete! :model/TaskRun)
+ (t2/delete! :model/TaskHistory)
+ (let [now (t/zoned-date-time)]
+ (mt/with-temp [:model/Database db {:name "Some DB"}
+ :model/Card card {:name "Some Card"}
+ :model/TaskRun run-db {:run_type :sync
+ :entity_type :database
+ :entity_id (:id db)
+ :status :success
+ :started_at now}
+ :model/TaskRun run-card {:run_type :fingerprint
+ :entity_type :card
+ :entity_id (:id card)
+ :status :failed
+ :started_at now}]
+ (letfn [(ids [& args]
+ (->> (apply mt/user-http-request :crowberto :get 200 "task/runs" args)
+ :data
+ (map :id)
+ (filter #{(:id run-db) (:id run-card)})))]
+ (testing "entity filter composes with the entity_name sort joins"
+ (is (= [(:id run-db)]
+ (ids :entity-type "database" :entity-id (:id db)
+ :sort-column :entity_name :sort-direction :asc))))
+ (testing "status filter composes with the task_count sort join"
+ (is (= [(:id run-card)]
+ (ids :status "failed" :sort-column :task_count :sort-direction :asc))))))))