Cypress test config

cypress.config.js

@@ -5,6 +5,7 @@ module.exports = defineConfig({
   viewportWidth: 1920,
   viewportHeight: 1080,
   video: false,
+  defaultCommandTimeout: 15000,
   env: {
     API_AUTH: "https://auth.api.dev.zesty.io",
     COOKIE_NAME: "DEV_APP_SID",
@@ -27,4 +28,7 @@ module.exports = defineConfig({
     specPattern: "cypress/e2e/**/*.{js,jsx,ts,tsx}",
     testIsolation: false,
   },
+  requestTimeout: 60_000,
+  responseTimeout: 60_000,
+  retries: 1,
 });

cypress/e2e/content/actions.spec.js

@@ -122,7 +122,7 @@ describe("Actions in content editor", () => {
     cy.getBySelector("ConfirmPublishButton").click();
 
     cy.intercept("GET", "**/publishings").as("publish");
-    cy.wait("@publish");
+    cy.wait("@publish", { timeout: 30_000 });
 
     cy.getBySelector("ContentPublishedIndicator").should("exist");
   });
@@ -257,9 +257,9 @@ describe("Actions in content editor", () => {
     // these waits are due to a delay
     // dealing with these specific endpoints
     // the local environment is slow
-    cy.contains("Successfully sent workflow request", { timeout: 5000 }).should(
-      "exist"
-    );
+    cy.contains("Successfully sent workflow request", {
+      timeout: 15_000,
+    }).should("exist");
   });
 
   // it("Refreshes the CDN cache", () => {
@@ -330,6 +330,6 @@ describe("Actions in content editor", () => {
 
     cy.getBySelector("CreateItemSaveButton").click();
 
-    cy.contains("Created Item", { timeout: 5000 }).should("exist");
+    cy.contains("Created Item", { timeout: 30_000 }).should("exist");
   });
 });

cypress/e2e/content/pages/ContentItemPage.js

@@ -0,0 +1,24 @@
+class ContentItemPage {
+  elements = {
+    createItemButton: () => cy.getBySelector("CreateItemSaveButton"),
+    duoModeToggle: () => cy.getBySelector("DuoModeToggle"),
+    moreMenu: () => cy.getBySelector("ContentItemMoreButton"),
+    deleteItemButton: () => cy.getBySelector("DeleteContentItem"),
+    confirmDeleteItemButton: () =>
+      cy.getBySelector("DeleteContentItemConfirmButton"),
+    versionSelector: () => cy.getBySelector("VersionSelector"),
+    versionItem: () => cy.getBySelector("VersionItem"),
+    addWorkflowStatusLabel: () => cy.getBySelector("AddWorkflowStatusLabel"),
+    workflowStatusLabelOption: () =>
+      cy.getBySelector("WorkflowStatusLabelOption"),
+    activeWorkflowStatusLabel: () =>
+      cy.getBySelector("ActiveWorkflowStatusLabel"),
+    publishItemButton: () => cy.getBySelector("PublishButton"),
+    confirmPublishItemButton: () => cy.getBySelector("ConfirmPublishButton"),
+    toast: () => cy.getBySelector("toast"),
+    contentPublishedIndicator: () =>
+      cy.getBySelector("ContentPublishedIndicator"),
+  };
+}
+
+export default new ContentItemPage();

cypress/e2e/content/workflows.spec.js

@@ -0,0 +1,198 @@
+import ContentItemPage from "./pages/ContentItemPage";
+import CONFIG from "../../../src/shell/app.config";
+import instanceZUID from "../../../src/utility/instanceZUID";
+
+const INSTANCE_API = `${
+  CONFIG?.[process.env.NODE_ENV]?.API_INSTANCE_PROTOCOL
+}${instanceZUID}${CONFIG?.[process.env.NODE_ENV]?.API_INSTANCE}`;
+const TITLES = {
+  contentItem: "Content item workflow test",
+  publishLabel: "Publish Approval",
+  testLabel: "Random Test Label",
+};
+const LABEL_DATA = {
+  publishLabel: {
+    name: TITLES.publishLabel,
+    description: "",
+    color: "#4E5BA6",
+    allowPublish: true,
+    addPermissionRoles: ["30-86f8ccec82-swp72s", "30-8ee88afe82-gmx631"],
+    removePermissionRoles: ["30-86f8ccec82-swp72s", "30-8ee88afe82-gmx631"],
+  },
+  testLabel: {
+    name: TITLES.testLabel,
+    description: "",
+    color: "#4E5BA6",
+    allowPublish: false,
+    addPermissionRoles: ["30-86f8ccec82-swp72s", "30-8ee88afe82-gmx631"],
+    removePermissionRoles: ["30-86f8ccec82-swp72s", "30-8ee88afe82-gmx631"],
+  },
+};
+
+describe("Content Item Workflows", () => {
+  before(() => {
+    cy.intercept("POST", "**/labels").as("createLabel");
+    cy.intercept("GET", "**/labels*").as("getLabels");
+
+    // Create allow publish workflow label
+    Object.values(LABEL_DATA).forEach((data) => {
+      cy.apiRequest({
+        method: "POST",
+        url: `${INSTANCE_API}/env/labels`,
+        body: data,
+      });
+    });
+
+    // Visit test page
+    cy.apiRequest({
+      method: "POST",
+      url: `${INSTANCE_API}/content/models/6-b6cde1aa9f-wftv50/items`,
+      body: {
+        data: {
+          title: TITLES.contentItem,
+          description: TITLES.contentItem,
+          tc_title: TITLES.contentItem,
+          tc_description: TITLES.contentItem,
+          tc_image: null,
+        },
+        web: {
+          canonicalTagMode: 1,
+          parentZUID: "0",
+          metaLinkText: TITLES.contentItem,
+          metaTitle: TITLES.contentItem,
+          pathPart: TITLES.contentItem?.replaceAll(" ", "-")?.toLowerCase(),
+          metaDescription: TITLES.contentItem,
+        },
+        meta: { langID: 1, contentModelZUID: "6-b6cde1aa9f-wftv50" },
+      },
+    }).then((response) => {
+      cy.visit(`/content/6-b6cde1aa9f-wftv50/${response.data?.ZUID}`);
+    });
+  });
+
+  after(() => {
+    // Delete test content item
+    cy.location("pathname").then((loc) => {
+      const [_, __, modelZUID, itemZUID] = loc?.split("/");
+      cy.apiRequest({
+        method: "DELETE",
+        url: `${INSTANCE_API}/content/models/${modelZUID}/items/${itemZUID}`,
+      });
+    });
+
+    // Delete test labels
+    cy.apiRequest({ url: `${INSTANCE_API}/env/labels?showDeleted=true` }).then(
+      (response) => {
+        response?.data
+          ?.filter(
+            (label) =>
+              !label?.deletedAt &&
+              [TITLES.publishLabel, TITLES.testLabel].includes(label?.name)
+          )
+          .forEach((label) => {
+            cy.apiRequest({
+              url: `${INSTANCE_API}/env/labels/${label.ZUID}`,
+              method: "DELETE",
+            });
+          });
+      }
+    );
+  });
+
+  it("Can add a workflow label", () => {
+    ContentItemPage.elements.versionSelector().should("exist").click();
+    ContentItemPage.elements.addWorkflowStatusLabel().should("exist").click();
+    ContentItemPage.elements
+      .workflowStatusLabelOption()
+      .contains(TITLES.testLabel)
+      .should("exist")
+      .click({ force: true });
+
+    cy.get("body").type("{esc}");
+
+    cy.intercept("PUT", "**/labels/*").as("updateLabel");
+    cy.wait("@updateLabel");
+
+    cy.reload();
+
+    ContentItemPage.elements.versionSelector().should("exist").click();
+    ContentItemPage.elements
+      .versionItem()
+      .first()
+      .within(() => {
+        ContentItemPage.elements
+          .activeWorkflowStatusLabel()
+          .should("have.length", 1);
+      });
+
+    cy.get("body").type("{esc}");
+  });
+
+  it("Cannot add a workflow label when role has no permission", () => {
+    ContentItemPage.elements.versionSelector().should("exist").click();
+    ContentItemPage.elements.addWorkflowStatusLabel().should("exist").click();
+    ContentItemPage.elements
+      .workflowStatusLabelOption()
+      .first()
+      .should("exist")
+      .click({ force: true });
+
+    cy.get("body").type("{esc}");
+
+    cy.reload();
+
+    ContentItemPage.elements.versionSelector().should("exist").click();
+    ContentItemPage.elements
+      .versionItem()
+      .first()
+      .within(() => {
+        ContentItemPage.elements
+          .activeWorkflowStatusLabel()
+          .should("have.length", 1);
+      });
+
+    cy.get("body").type("{esc}");
+  });
+
+  it("Cannot publish a content item if label with allowPublish is missing", () => {
+    ContentItemPage.elements
+      .publishItemButton()
+      .should("exist")
+      .click({ force: true });
+    ContentItemPage.elements
+      .confirmPublishItemButton()
+      .should("exist")
+      .click({ force: true });
+    ContentItemPage.elements
+      .toast()
+      .contains(
+        `Cannot Publish: "${TITLES.contentItem}". Does not have a status that allows publishing`
+      );
+  });
+
+  it("Can publish a content item if label with allowPublish is applied", () => {
+    cy.reload();
+    ContentItemPage.elements.versionSelector().should("exist").click();
+    ContentItemPage.elements.addWorkflowStatusLabel().should("exist").click();
+    ContentItemPage.elements
+      .workflowStatusLabelOption()
+      .contains(TITLES.publishLabel)
+      .should("exist")
+      .click({ force: true });
+
+    cy.get("body").type("{esc}");
+
+    cy.intercept("PUT", "**/labels/*").as("updateLabel");
+    cy.wait("@updateLabel");
+
+    cy.reload();
+
+    ContentItemPage.elements.publishItemButton().should("exist").click();
+    ContentItemPage.elements.confirmPublishItemButton().should("exist").click();
+
+    cy.intercept("GET", "**/publishings").as("publish");
+    cy.wait("@publish");
+
+    ContentItemPage.elements.contentPublishedIndicator().should("exist");
+  });
+});