metabase/e2e/test/scenarios/sharing/public-sharing.cy.spec.js

const { H } = cy;
import { SAMPLE_DB_ID } from "e2e/support/cypress_data";
import { SAMPLE_DATABASE } from "e2e/support/cypress_sample_database";

const { ORDERS_ID } = SAMPLE_DATABASE;

const DEFAULT_ACTION_DETAILS = {
  database_id: SAMPLE_DB_ID,
  dataset_query: {
    database: SAMPLE_DB_ID,
    native: {
      query: "UPDATE orders SET quantity = 0 WHERE id = {{order_id}}",
      "template-tags": {
        order_id: {
          "display-name": "Order ID",
          id: "fake-uuid",
          name: "order_id",
          type: "text",
        },
      },
    },
    type: "native",
  },
  name: "Reset order quantity",
  description: "Set order quantity to 0",
  type: "query",
  parameters: [
    {
      id: "fake-uuid",
      hasVariableTemplateTagTarget: true,
      name: "Order ID",
      slug: "order_id",
      type: "string/=",
      target: ["variable", ["template-tag", "fake-uuid"]],
    },
  ],
  visualization_settings: {
    fields: {
      "fake-uuid": {
        id: "fake-uuid",
        fieldType: "string",
        inputType: "string",
        hidden: false,
        order: 999,
        required: true,
        name: "",
        title: "",
        placeholder: "",
        description: "",
      },
    },
    type: "button",
  },
};

describe("scenarios > admin > settings > public sharing", () => {
  beforeEach(() => {
    H.restore();
    cy.signInAsAdmin();
    cy.intercept("GET", "/api/action/public").as("getPublicActions");
    cy.intercept("GET", "/api/dashboard/public").as("getPublicDashboards");
    cy.intercept("GET", "/api/card/public").as("getPublicQuestions");
  });

  it("should list, open, and revoke public dashboards, questions, and actions, and toggle public sharing", () => {
    cy.intercept("PUT", "/api/setting/enable-public-sharing").as(
      "updatePublicSharing",
    );

    const expectedDashboardName = "Public dashboard";
    const expectedDashboardSlug = "public-dashboard";
    const expectedQuestionName = "Public question";
    const expectedQuestionSlug = "public-question";
    const expectedActionName = "Public action";

    H.setActionsEnabledForDB(SAMPLE_DB_ID);

    H.createQuestion({
      name: "Question",
      query: {
        "source-table": ORDERS_ID,
      },
    })
      .then(({ body: { id: card_id } }) =>
        H.createDashboardWithTabs({
          name: expectedDashboardName,
          tabs: [
            { id: 1, name: "Tab 1" },
            { id: 2, name: "Tab 2" },
          ],
          dashcards: [
            {
              id: -1,
              card_id,
              dashboard_tab_id: 1,
              row: 0,
              col: 0,
              size_x: 8,
              size_y: 8,
            },
          ],
        }),
      )
      .then((dashboard) => {
        cy.wrap(dashboard.id).as("dashboardId");
        cy.request("POST", `/api/dashboard/${dashboard.id}/public_link`, {});
      })
      .then((response) => {
        cy.wrap(response.body.uuid).as("dashboardUuid");
      });

    H.createQuestion({
      name: expectedQuestionName,
      query: {
        "source-table": ORDERS_ID,
      },
    })
      .then(({ body }) => {
        const questionId = body.id;
        cy.wrap(questionId).as("questionId");
        cy.request("POST", `/api/card/${questionId}/public_link`, {});
      })
      .then((response) => {
        cy.wrap(response.body.uuid).as("questionUuid");
      });

    H.createQuestion({
      name: "Model",
      query: {
        "source-table": ORDERS_ID,
      },
      type: "model",
    }).then(({ body }) => {
      const modelId = body.id;
      cy.wrap(modelId).as("modelId");
    });

    cy.get("@modelId").then((modelId) => {
      H.createAction({
        ...DEFAULT_ACTION_DETAILS,
        name: expectedActionName,
        model_id: modelId,
      }).then(({ body }) => {
        const actionId = body.id;
        cy.wrap(actionId).as("actionId");
      });
    });

    cy.get("@actionId")
      .then((actionId) => {
        cy.request("POST", `/api/action/${actionId}/public_link`, {});
      })
      .then(({ body }) => {
        cy.wrap(body.uuid).as("actionUuid");
      });

    cy.visit("/admin/settings/public-sharing");
    cy.wait([
      "@getPublicActions",
      "@getPublicQuestions",
      "@getPublicDashboards",
    ]);

    cy.findByTestId("admin-layout-content")
      .findByText("Shared dashboards")
      .should("be.visible");
    cy.findByTestId("admin-layout-content")
      .findByText(expectedDashboardName)
      .should("be.visible");
    cy.findByTestId("admin-layout-content")
      .findByText("Shared questions")
      .should("be.visible");
    cy.findByTestId("admin-layout-content")
      .findByText(expectedQuestionName)
      .should("be.visible");
    cy.findByTestId("admin-layout-content")
      .findByText("Shared action forms")
      .scrollIntoView()
      .should("be.visible");
    cy.findByTestId("admin-layout-content")
      .findByText(expectedActionName)
      .scrollIntoView()
      .should("be.visible");

    cy.log("public dashboard");
    cy.get("@dashboardUuid").then((dashboardUuid) => {
      cy.findByText(
        `${location.origin}/public/dashboard/${dashboardUuid}`,
      ).click();
      cy.findByRole("heading", { name: expectedDashboardName }).should(
        "be.visible",
      );
      cy.findByRole("tab", { name: "Tab 1" }).should("be.visible");
      cy.visit("/admin/settings/public-sharing");
    });

    cy.get("@dashboardId").then((dashboardId) => {
      cy.findByText(expectedDashboardName).click();
      cy.log(
        "Sometimes the URL will be updated with the tab ID, so we need to account for that",
      );
      cy.url().should(
        "match",
        new RegExp(
          `${location.origin}/dashboard/${dashboardId}-${expectedDashboardSlug}*`,
        ),
      );
      cy.visit("/admin/settings/public-sharing");
    });

    cy.log("public question");
    cy.get("@questionUuid").then((questionUuid) => {
      cy.findByText(
        `${location.origin}/public/question/${questionUuid}`,
      ).click();
      cy.findByRole("heading", { name: expectedQuestionName }).should(
        "be.visible",
      );
      cy.visit("/admin/settings/public-sharing");
    });

    cy.get("@questionId").then((questionId) => {
      cy.findByText(expectedQuestionName).click();
      cy.url().should(
        "eq",
        `${location.origin}/question/${questionId}-${expectedQuestionSlug}`,
      );
      cy.visit("/admin/settings/public-sharing");
    });

    cy.log("public action");
    cy.get("@actionUuid").then((actionUuid) => {
      cy.findByText(`${location.origin}/public/action/${actionUuid}`).click();
      cy.findByRole("heading", { name: expectedActionName }).should(
        "be.visible",
      );
      cy.visit("/admin/settings/public-sharing");
    });

    cy.then(function () {
      cy.findByText(expectedActionName).click();
      cy.url().should(
        "eq",
        `${location.origin}/model/${this.modelId}/detail/actions/${this.actionId}`,
      );
      cy.findByRole("dialog").within(() => {
        cy.findByText(expectedActionName).should("be.visible");
      });
      cy.visit("/admin/settings/public-sharing");
    });

    revokePublicLink(expectedDashboardName);
    cy.findByTestId("admin-layout-content")
      .findByText("No dashboards have been publicly shared yet.")
      .scrollIntoView()
      .should("be.visible");

    revokePublicLink(expectedQuestionName);
    cy.findByTestId("admin-layout-content")
      .findByText("No questions have been publicly shared yet.")
      .scrollIntoView()
      .should("be.visible");

    revokePublicLink(expectedActionName);
    cy.findByTestId("admin-layout-content")
      .findByText("No actions have been publicly shared yet.")
      .scrollIntoView()
      .should("be.visible");

    cy.findByTestId("enable-public-sharing-setting")
      .scrollIntoView()
      .within(() => {
        cy.findByText("Enabled").should("be.visible");
        cy.findByLabelText("Enabled").click();
      });
    cy.wait("@updatePublicSharing");
    cy.findByTestId("enable-public-sharing-setting")
      .findByText("Disabled")
      .should("be.visible");
  });
});

function revokePublicLink(name) {
  cy.findByTestId("admin-layout-content")
    .findByText(name)
    .closest("tr")
    .findByRole("button", { name: "Revoke link" })
    .click();
  H.modal().within(() => {
    cy.findByText("Disable this link?").should("be.visible");
    cy.button("Yes").click();
  });
}