Skip to content

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

Simplify content moderation e2e tests (#67375)

Nemanja Glumac4680a440e1eb
diff --git a/e2e/test/scenarios/organization/content-verification.cy.spec.js b/e2e/test/scenarios/organization/content-verification.cy.spec.js
index ce39e9e7a7b..9322e93484a 100644
--- a/e2e/test/scenarios/organization/content-verification.cy.spec.js
+++ b/e2e/test/scenarios/organization/content-verification.cy.spec.js
@@ -4,515 +4,51 @@ import {
ORDERS_DASHBOARD_ID,
} from "e2e/support/cypress_sample_instance_data";
+/**
+ * Smoke tests for content verification feature.
+ *
+ * Detailed coverage exists in:
+ * - Backend: enterprise/backend/test/metabase_enterprise/content_verification/api/moderation_review_test.clj
+ * - Frontend: enterprise/frontend/src/metabase-enterprise/moderation/service.unit.spec.ts
+ * - Components: Multiple unit tests for ModerationStatusIcon, ModerationReviewBanner, etc.
+ * - Menu items: frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionMoreActionsMenu/tests/QuestionMoreActionsMenu.enterprise.unit.spec.tsx
+ */
describe("scenarios > premium > content verification", () => {
beforeEach(() => {
H.restore();
cy.signInAsAdmin();
+ H.activateToken("pro-self-hosted");
});
- context("without a token", () => {
- beforeEach(() => H.deleteToken());
+ it("admin can verify and unverify a question", () => {
+ H.visitQuestion(ORDERS_COUNT_QUESTION_ID);
- it("should not be able to verify a saved question", () => {
- cy.log("Gate the API");
- cy.request({
- method: "POST",
- url: "/api/moderation-review",
- failOnStatusCode: false,
- body: {
- status: "verified",
- moderated_item_id: ORDERS_COUNT_QUESTION_ID,
- moderated_item_type: "card",
- },
- }).then(({ body, status, statusText }) => {
- expect(body).to.deep.include(
- H.getPartialPremiumFeatureError("Content verification"),
- );
- expect(status).to.eq(402);
- expect(statusText).to.eq("Payment Required");
- });
+ cy.log("Verify the question");
+ H.openQuestionActions();
+ cy.findByTextEnsureVisible("Verify this question").click();
- cy.log("Gate the UI");
- H.visitQuestion(ORDERS_COUNT_QUESTION_ID);
- H.openQuestionActions();
- H.popover()
- .should("contain", "Add to dashboard")
- .and("not.contain", "Verify this question");
+ cy.findByTestId("qb-header").icon("verified").should("be.visible");
- cy.log("Turn the question into a model and try again");
- cy.request("PUT", `/api/card/${ORDERS_COUNT_QUESTION_ID}`, {
- type: "model",
- });
+ cy.log("Remove verification");
+ H.openQuestionActions();
+ cy.findByTextEnsureVisible("Remove verification").click();
- cy.intercept("POST", "/api/dataset").as("dataset");
- cy.visit(`/model/${ORDERS_COUNT_QUESTION_ID}`);
- cy.wait("@dataset");
-
- H.openQuestionActions();
- H.popover()
- .should("contain", "Edit query definition")
- .and("not.contain", "Verify this question");
- });
-
- it("should not be able to verify a Dashboard", () => {
- cy.log("Gate the API");
- cy.request({
- method: "POST",
- url: "/api/moderation-review",
- failOnStatusCode: false,
- body: {
- status: "verified",
- moderated_item_id: ORDERS_DASHBOARD_ID,
- moderated_item_type: "dashboard",
- },
- }).then(({ body, status, statusText }) => {
- expect(body).to.deep.include(
- H.getPartialPremiumFeatureError("Content verification"),
- );
- expect(status).to.eq(402);
- expect(statusText).to.eq("Payment Required");
- });
-
- cy.log("Gate the UI");
- H.visitDashboard(ORDERS_DASHBOARD_ID);
- H.openDashboardMenu();
- H.popover()
- .should("contain", "Enter fullscreen")
- .and("not.contain", "Verify this question");
- });
+ cy.findByTestId("qb-header").icon("verified").should("not.exist");
});
- context("premium token with paid features", () => {
- beforeEach(() => H.activateToken("pro-self-hosted"));
-
- describe("an admin", () => {
- it("should be able to verify and unverify a saved question", () => {
- H.visitQuestion(ORDERS_COUNT_QUESTION_ID);
-
- verifyQuestion();
-
- // 1. Question title
- cy.findByTestId("qb-header").within(() => {
- cy.findByText("Orders, Count");
- cy.icon("verified");
- });
-
- // 2. Question's history
- H.questionInfoButton().click();
- H.sidesheet().within(() => {
- cy.findByText(/You verified this/);
- cy.findByRole("tab", { name: "History" }).click();
- cy.findByText("You verified this");
- });
- cy.findByLabelText("Close").click();
-
- // 3. Recently viewed list
- H.openCommandPalette();
- H.commandPalette()
- .findByRole("option", { name: "Orders, Count" })
- .find(".Icon-verified_filled");
- H.commandPaletteInput().type("Orders");
- H.commandPalette()
- .findByRole("option", { name: "Orders, Count" })
- .find(".Icon-verified_filled");
- H.closeCommandPalette();
-
- // 4. Search results
- H.commandPaletteSearch("orders");
- cy.findAllByTestId("search-result-item")
- .contains("Orders, Count")
- .siblings(".Icon-verified_filled");
-
- // 5. Question's collection
- cy.visit("/collection/root");
- cy.findByRole("table")
- .findByText("Orders, Count")
- .closest("td")
- .icon("verified");
-
- cy.log("Go back to the question and remove the verification");
- H.visitQuestion(ORDERS_COUNT_QUESTION_ID);
-
- removeQuestionVerification();
-
- // 1. Question title
- cy.findByTestId("qb-header-left-side")
- .find(".Icon-verified")
- .should("not.exist");
-
- // 2. Question's history
- H.questionInfoButton().click();
- H.sidesheet().within(() => {
- cy.findByRole("tab", { name: "History" }).click();
- cy.findByText("You removed verification");
- cy.findByText("You verified this"); // Implicit assertion - there can be only one :)
- });
- cy.findByLabelText("Close").click();
-
- // 3. Recently viewed list
- H.openCommandPalette();
- H.commandPalette()
- .findByRole("option", { name: "Orders, Count" })
- .find(".Icon-verified_filled")
- .should("not.exist");
- H.commandPaletteInput().type("Orders");
- H.commandPalette()
- .findByRole("option", { name: "Orders, Count" })
- .find(".Icon-verified_filled")
- .should("not.exist");
- H.closeCommandPalette();
-
- // 4. Search results
- H.commandPaletteSearch("orders");
- cy.findAllByTestId("search-result-item")
- .contains("Orders, Count")
- .siblings(".Icon-verified_filed")
- .should("not.exist");
-
- // 5. Question's collection
- cy.visit("/collection/root");
- cy.findByRole("table")
- .findByText("Orders, Count")
- .closest("td")
- .icon("verified")
- .should("not.exist");
- });
-
- it("should be able to verify and unverify a dashboard", () => {
- H.visitDashboard(ORDERS_DASHBOARD_ID);
-
- verifyDashboard();
-
- // 1. Question title
- cy.findByTestId("dashboard-header").within(() => {
- cy.findByText("Orders in a dashboard");
- cy.icon("verified");
- });
-
- // 2. Question's history
- H.openDashboardInfoSidebar();
- H.sidesheet().within(() => {
- cy.findByText(/You verified this/);
- cy.findByRole("tab", { name: "History" }).click();
- cy.findByText("You verified this");
- });
- cy.findByLabelText("Close").click();
-
- // // 3. Recently viewed list
- H.openCommandPalette();
- H.commandPalette()
- .findByRole("option", { name: "Orders in a dashboard" })
- .find(".Icon-verified_filled");
- H.closeCommandPalette();
-
- // // 4. Search results
- H.commandPaletteSearch("orders");
- cy.findAllByTestId("search-result-item")
- .contains("Orders in a dashboard")
- .siblings(".Icon-verified_filled");
-
- // // 5. Question's collection
- cy.visit("/collection/root");
- cy.findByRole("table")
- .findByText("Orders in a dashboard")
- .closest("td")
- .icon("verified");
-
- cy.log("Go back to the question and remove the verification");
- H.visitDashboard(ORDERS_DASHBOARD_ID);
-
- removeDashboardVerification();
-
- // 1. Question title
- cy.findByTestId("dashboard-header")
- .find(".Icon-verified")
- .should("not.exist");
-
- // 2. Question's history
- H.openDashboardInfoSidebar().click();
- H.sidesheet().within(() => {
- cy.findByRole("tab", { name: "History" }).click();
- cy.findByText("You removed verification");
- cy.findByText("You verified this"); // Implicit assertion - there can be only one :)
- });
- cy.findByLabelText("Close").click();
-
- // 3. Recently viewed list
- H.openCommandPalette();
- H.commandPalette()
- .findByRole("option", { name: "Orders in a dashboard" })
- .find(".Icon-verified_filled")
- .should("not.exist");
- H.closeCommandPalette();
-
- // 4. Search results
- H.commandPaletteSearch("orders");
- cy.findAllByTestId("search-result-item")
- .contains("Orders in a dashboard")
- .siblings(".Icon-verified_filed")
- .should("not.exist");
-
- // 5. Question's collection
- cy.visit("/collection/root");
- cy.findByRole("table")
- .findByText("Orders in a dashboard")
- .closest("td")
- .icon("verified")
- .should("not.exist");
- });
- });
-
- describe("non-admin user", () => {
- beforeEach(() => {
- H.createModerationReview({
- status: "verified",
- moderated_item_type: "card",
- moderated_item_id: ORDERS_COUNT_QUESTION_ID,
- });
-
- H.createModerationReview({
- status: "verified",
- moderated_item_type: "dashboard",
- moderated_item_id: ORDERS_DASHBOARD_ID,
- });
-
- cy.signInAsNormalUser();
- });
-
- it("should be able to see that a question has been verified but can't moderate the question themselves", () => {
- H.visitQuestion(ORDERS_COUNT_QUESTION_ID);
+ it("admin can verify and unverify a dashboard", () => {
+ H.visitDashboard(ORDERS_DASHBOARD_ID);
- cy.findByTestId("qb-header").within(() => {
- cy.findByText("Orders, Count");
- cy.icon("verified");
- });
+ cy.log("Verify the dashboard");
+ H.openDashboardMenu();
+ cy.findByTextEnsureVisible("Verify this dashboard").click();
- cy.log("Non-admin users cannot change question verification status.");
- H.openQuestionActions();
- H.popover()
- .should("contain", "Add to dashboard")
- .and("not.contain", "Remove verification");
+ cy.findByTestId("dashboard-header").icon("verified").should("be.visible");
- H.questionInfoButton().click();
- H.sidesheet().within(() => {
- cy.findAllByText(/A moderator verified this/); // overview tab
- cy.findByRole("tab", { name: "History" }).click();
- cy.findAllByText("A moderator verified this"); // history tab
- });
- cy.findByLabelText("Close").click();
+ cy.log("Remove verification");
+ H.openDashboardMenu();
+ cy.findByTextEnsureVisible("Remove verification").click();
- H.commandPaletteSearch("orders");
- cy.log("Verified content should show up higher in search results");
- cy.findAllByTestId("search-result-item")
- .eq(0)
- .within(() => {
- cy.findByText("Orders, Count");
- cy.icon("verified_filled");
- });
-
- cy.visit("/collection/root");
- cy.findByRole("table")
- .findByText("Orders, Count")
- .closest("td")
- .icon("verified");
- });
-
- it("should be able to see that a dashboard has been verified but can't moderate the dashboard themselves", () => {
- H.visitDashboard(ORDERS_DASHBOARD_ID);
-
- cy.findByTestId("dashboard-header").within(() => {
- cy.findByText("Orders in a dashboard");
- cy.icon("verified");
- });
-
- cy.log("Non-admin users cannot change question verification status.");
- H.openDashboardMenu();
- H.popover()
- .should("contain", "Enter fullscreen")
- .and("not.contain", "Remove verification");
-
- H.openDashboardInfoSidebar();
- H.sidesheet().within(() => {
- cy.findAllByText(/A moderator verified this/); // overview tab
- cy.findByRole("tab", { name: "History" }).click();
- cy.findAllByText("A moderator verified this"); // history tab
- });
- cy.findByLabelText("Close").click();
-
- H.commandPaletteSearch("orders");
- cy.log("Verified content should show up higher in search results");
- cy.findAllByTestId("search-result-item")
- .first()
- .within(() => {
- cy.findByText("Orders in a dashboard");
- cy.icon("verified_filled");
- });
-
- cy.visit("/collection/root");
- cy.findByRole("table")
- .findByText("Orders in a dashboard")
- .closest("td")
- .icon("verified");
- });
- });
- });
-
- context("token expired or removed", () => {
- beforeEach(() => {
- H.activateToken("pro-self-hosted");
- H.createModerationReview({
- status: "verified",
- moderated_item_type: "card",
- moderated_item_id: ORDERS_COUNT_QUESTION_ID,
- });
-
- H.createModerationReview({
- status: "verified",
- moderated_item_type: "dashboard",
- moderated_item_id: ORDERS_DASHBOARD_ID,
- });
-
- H.deleteToken();
- });
-
- it("should not treat the question as verified anymore", () => {
- H.visitQuestion(ORDERS_COUNT_QUESTION_ID);
-
- cy.findByTestId("qb-header").within(() => {
- cy.findByText("Orders, Count");
- cy.icon("verified").should("not.exist");
- });
-
- H.questionInfoButton().click();
- H.sidesheet().within(() => {
- cy.findByRole("tab", { name: "History" }).click();
- cy.contains(/created this./);
- cy.contains(/verified this/).should("not.exist");
- });
- cy.findByLabelText("Close").click();
-
- H.openCommandPalette();
- H.commandPalette()
- .findByRole("option", { name: "Orders, Count" })
- .find(".Icon-verified_filled")
- .should("not.exist");
- H.commandPaletteInput().type("Orders");
- H.commandPalette()
- .findByRole("option", { name: "Orders, Count" })
- .find(".Icon-verified_filled")
- .should("not.exist");
- H.closeCommandPalette();
-
- H.commandPaletteSearch("orders");
- cy.log(
- "The question lost the verification status and does not appear high in search results anymore",
- );
- cy.findAllByTestId("search-result-item").as("searchResults");
- // NOTE: It still appears first, probably due to the recency ranker...
- // I have confirmed that the ranker is no longer active at least.
- // We could probably fix this by opening another dashboard before searching.
- // .first()
- // .should("not.contain", "Orders, Count");
- cy.log("Verified icon should not appear at all in search results");
- cy.get("@searchResults").icon("verified").should("not.exist");
- });
-
- it("should not treat the dashboard as verified anymore", () => {
- H.visitDashboard(ORDERS_DASHBOARD_ID);
-
- cy.findByTestId("dashboard-header").within(() => {
- cy.findByText("Orders in a dashboard");
- cy.icon("verified").should("not.exist");
- });
-
- H.openDashboardInfoSidebar();
- H.sidesheet().within(() => {
- cy.findByRole("tab", { name: "History" }).click();
- cy.contains(/created this./);
- cy.contains(/verified this/).should("not.exist");
- });
- cy.findByLabelText("Close").click();
-
- H.commandPaletteSearch("orders");
- cy.log(
- "The question lost the verification status and does not appear high in search results anymore",
- );
- cy.findAllByTestId("search-result-item").as("searchResults");
- // NOTE: It still appears first, probably due to the recency ranker...
- // I have confirmed that the ranker is no longer active at least.
- // We could probably fix this by opening another question before searching.
- // .first()
- // .should("not.contain", "Orders in a dashboard");
- cy.log("Verified icon should not appear at all in search results");
- cy.get("@searchResults").icon("verified").should("not.exist");
- });
+ cy.findByTestId("dashboard-header").icon("verified").should("not.exist");
});
});
-
-function verifyQuestion() {
- cy.intercept("GET", "/api/card/*").as("loadCard");
-
- H.openQuestionActions();
- cy.findByTextEnsureVisible("Verify this question").click();
-
- cy.wait("@loadCard").then(({ response: { body } }) => {
- const { moderation_reviews } = body;
-
- /**
- * According to Dan's analysis, the reason behind intermittent failures in this test
- * could be the errors in H2 (app db).
- * More info: https://metaboat.slack.com/archives/C505ZNNH4/p1657300770484219?thread_ts=1657295926.728949&cid=C505ZNNH4
- *
- * We observed that even when the click on "Verify this question" was successful,
- * the response still shows `moderation_reviews` as an empty array.
- *
- * Therefore, we have to conditionally skip this test if that error occurs.
- */
- if (Array.isArray(moderation_reviews) && moderation_reviews.length === 0) {
- cy.skipOn(true);
- } else {
- const [{ status }] = moderation_reviews;
-
- expect(status).to.eq("verified");
- }
- });
-}
-
-function verifyDashboard() {
- cy.intercept("GET", "/api/dashboard/*").as("loadDashboard");
-
- H.openDashboardMenu();
- cy.findByTextEnsureVisible("Verify this dashboard").click();
-
- cy.wait("@loadDashboard").then(({ response: { body } }) => {
- const { moderation_reviews } = body;
-
- /**
- * According to Dan's analysis, the reason behind intermittent failures in this test
- * could be the errors in H2 (app db).
- * More info: https://metaboat.slack.com/archives/C505ZNNH4/p1657300770484219?thread_ts=1657295926.728949&cid=C505ZNNH4
- *
- * We observed that even when the click on "Verify this question" was successful,
- * the response still shows `moderation_reviews` as an empty array.
- *
- * Therefore, we have to conditionally skip this test if that error occurs.
- */
- if (Array.isArray(moderation_reviews) && moderation_reviews.length === 0) {
- cy.skipOn(true);
- } else {
- const [{ status }] = moderation_reviews;
-
- expect(status).to.eq("verified");
- }
- });
-}
-
-function removeQuestionVerification() {
- H.openQuestionActions();
- cy.findByTextEnsureVisible("Remove verification").click();
-}
-
-function removeDashboardVerification() {
- H.openDashboardMenu();
- cy.findByTextEnsureVisible("Remove verification").click();
-}
diff --git a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionMoreActionsMenu/tests/QuestionMoreActionsMenu.enterprise.unit.spec.tsx b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionMoreActionsMenu/tests/QuestionMoreActionsMenu.enterprise.unit.spec.tsx
index 6465826247a..b229c1292b4 100644
--- a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionMoreActionsMenu/tests/QuestionMoreActionsMenu.enterprise.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionMoreActionsMenu/tests/QuestionMoreActionsMenu.enterprise.unit.spec.tsx
@@ -1,4 +1,5 @@
import { screen } from "__support__/ui";
+import { createMockModerationReview } from "metabase-types/api/mocks";
import { openMenu, setup } from "./setup";
@@ -28,4 +29,44 @@ describe("QuestionMoreActionsMenu > Enterprise", () => {
});
});
});
+
+ describe("content verification", () => {
+ it('should show "Verify this question" for admin users', async () => {
+ setup({
+ canManageSubscriptions: false,
+ isAdmin: true,
+ isEmailSetup: false,
+ isEnterprise: true,
+ });
+ await openMenu();
+ expect(screen.getByText("Verify this question")).toBeInTheDocument();
+ });
+
+ it('should show "Remove verification" for admin users on verified questions', async () => {
+ setup({
+ canManageSubscriptions: false,
+ isAdmin: true,
+ isEmailSetup: false,
+ isEnterprise: true,
+ moderationReviews: [
+ createMockModerationReview({ status: "verified", most_recent: true }),
+ ],
+ });
+ await openMenu();
+ expect(screen.getByText("Remove verification")).toBeInTheDocument();
+ });
+
+ it('should not show "Verify this question" for non-admin users', async () => {
+ setup({
+ canManageSubscriptions: false,
+ isAdmin: false,
+ isEmailSetup: false,
+ isEnterprise: true,
+ });
+ await openMenu();
+ expect(
+ screen.queryByText("Verify this question"),
+ ).not.toBeInTheDocument();
+ });
+ });
});
diff --git a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionMoreActionsMenu/tests/setup.tsx b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionMoreActionsMenu/tests/setup.tsx
index 70d61d9975d..20866372049 100644
--- a/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionMoreActionsMenu/tests/setup.tsx
+++ b/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionMoreActionsMenu/tests/setup.tsx
@@ -10,7 +10,12 @@ import { mockSettings } from "__support__/settings";
import { renderWithProviders, screen } from "__support__/ui";
import { QuestionAlertListModal } from "metabase/notifications/modals";
import Question from "metabase-lib/v1/Question";
-import type { Card, Notification, User } from "metabase-types/api";
+import type {
+ Card,
+ ModerationReview,
+ Notification,
+ User,
+} from "metabase-types/api";
import {
createMockCard,
createMockSettings,
@@ -27,6 +32,7 @@ type SetupOpts = {
isAdmin: boolean;
isEmailSetup: boolean;
isEnterprise: boolean;
+ moderationReviews?: ModerationReview[];
};
export function setup({
@@ -35,13 +41,17 @@ export function setup({
isAdmin = false,
isEmailSetup = false,
isEnterprise = false,
+ moderationReviews,
}: SetupOpts) {
- const card = createMockCard();
+ const card = createMockCard(
+ isEnterprise ? { moderation_reviews: moderationReviews ?? [] } : {},
+ );
const tokenFeatures = createMockTokenFeatures({
advanced_permissions: isEnterprise,
dashboard_subscription_filters: isEnterprise,
audit_app: isEnterprise,
+ content_verification: isEnterprise,
});
const settingValues = createMockSettings({