IKHSAN
EN Read in EnglishID

opendesk

Publik
Branch
main
Commit terakhir
08d9f3328 Oktober 2026

portal-walkthrough.spec.ts

Buka raw
import type { Page } from "@playwright/test";
import { expect, test as base, uid, usePersona } from "../../helpers/fixtures";
import { raiseTicket } from "../../helpers/factories";
import { PASSWORD, personas } from "../../helpers/personas";
import { createArticle, createCategory } from "../../helpers/portal";
import { snapshotSettings } from "../../helpers/settings";
import { siteHeader } from "../../helpers/site";

// Title ids (R1, H9, K2, ...) follow the portal walkthrough checklist.

const KB_SETTINGS = ["public_knowledge_base", "allow_anonymous_article_voting", "banner_preset"];
const QUICK_LINKS = "Knowledge Base Quick Links";
const GUEST = { storageState: { cookies: [], origins: [] } };
const PHONE = { width: 390, height: 844 };

const test = base.extend<{ kb: (values: Record<string, any>) => Promise<void> }>({
  kb: async ({ api }, use) => {
    const restore = await snapshotSettings(api, KB_SETTINGS);
    await use((values) => api.update("OD Settings", "OD Settings", values));
    await restore();
  },
});

async function seedAudiences(api) {
  const category = await createCategory(api);
  const make = (visibility: string, status = "Published") =>
    createArticle(api, category.name, { title: `${visibility} ${status} ${uid()}`, visibility, status });
  return {
    category,
    public: await make("Public"),
    customers: await make("Customers"),
    agents: await make("Private"),
    draft: await make("Public", "Draft"),
  };
}

function accountMenu(page: Page) {
  return page.getByRole("button", { name: "Opendesk", exact: true });
}

test.describe("routing", () => {
  test.describe("guest, private knowledge base", () => {
    test.use(GUEST);

    test("R1 sends a guest to login and back", async ({ page, kb }) => {
      await kb({ public_knowledge_base: 0 });
      await page.goto("/help/categories?a=1");
      await expect(page).toHaveURL(/\/login\?redirect-to=%2Fhelp%2Fcategories%3Fa%3D1/);
      await page.locator("#login_email").fill(personas.customer.email);
      await page.locator("#login_password").fill(PASSWORD);
      await page.getByRole("button", { name: "Continue", exact: true }).click();
      await expect(page).toHaveURL(/\/help\/categories\?a=1$/);
    });
  });

  test.describe("guest, public knowledge base", () => {
    test.use(GUEST);

    test("R2 knowledge base pages render signed out", async ({ page, api, kb }) => {
      await kb({ public_knowledge_base: 1 });
      const category = await createCategory(api);
      const article = await createArticle(api, category.name);
      await page.goto("/help");
      await expect(page.getByRole("heading", { name: "Here's what might help" })).toBeVisible();
      await expect(page.getByRole("button", { name: "Log in" })).toBeVisible();
      await page.goto("/help/categories");
      await expect(page.getByRole("heading", { name: "All categories" })).toBeVisible();
      await page.goto(`/help/category/${category.name}`);
      await expect(page.getByRole("heading", { name: category.category_name, level: 1 })).toBeVisible();
      await page.goto(`/help/articles/${article.name}`);
      await expect(page.getByRole("heading", { name: article.title, level: 1 })).toBeVisible();
    });

    test("R3 ticket pages send a guest to login with the query kept", async ({ page, kb, apiAs }) => {
      await kb({ public_knowledge_base: 1 });
      const ticket = await raiseTicket(await apiAs("customer"));
      for (const path of ["/help/my-tickets?x=1", "/help/my-tickets/new?from=search&q=hi", `/help/my-tickets/${ticket.name}`]) {
        await page.goto(path);
        await expect(page).toHaveURL(`/login?redirect-to=${encodeURIComponent(path)}`);
      }
    });

    test("R4 an unknown path sends a public guest to login, not a 404", async ({ page, kb }) => {
      await kb({ public_knowledge_base: 1 });
      await page.goto("/help/no-such-page");
      await expect(page).toHaveURL(/\/login\?redirect-to=%2Fhelp%2Fno-such-page/);
    });
  });

  test.describe("customer", () => {
    usePersona("customer");

    test("R5 an unknown path shows Not Found with a way home", async ({ page }) => {
      await page.goto("/help/no-such-page");
      await expect(page.getByText("The page you are looking for does not exist.")).toBeVisible();
      await page.getByRole("link", { name: "Back to Home" }).click();
      await expect(page).toHaveURL(/\/help\/?$/);
    });

    test("R6 /help and /help/ open the knowledge base home", async ({ page }) => {
      for (const path of ["/help", "/help/"]) {
        await page.goto(path);
        await expect(page.getByRole("heading", { name: "Here's what might help" })).toBeVisible();
      }
    });

    test("R7–R12 old desk portal links land on the new routes", async ({ page, api }) => {
      const category = await createCategory(api);
      const article = await createArticle(api, category.name, { title: `Old link ${uid()}` });
      const cases: [string, RegExp][] = [
        ["/opendesk/my-tickets?x=1", /\/help\/my-tickets\?x=1$/],
        ["/opendesk/my-tickets/new?from=article", /\/help\/my-tickets\/new\?from=article$/],
        ["/opendesk/kb-public", /\/help\/?$/],
        [`/opendesk/kb-public/articles/${article.name}`, new RegExp(`/help/articles/${article.name}-old-link-`)],
        [`/opendesk/kb-public/${category.name}`, new RegExp(`/help/category/${category.name}$`)],
      ];
      for (const [from, to] of cases) {
        await page.goto(from);
        await expect(page, from).toHaveURL(to);
      }
    });

    test("R15 any other desk route sends a customer to the portal", async ({ page }) => {
      await page.goto("/opendesk/teams");
      await expect(page).toHaveURL(/\/help\/?$/);
    });
  });
});

test.describe("header", () => {
  test.describe("guest", () => {
    test.use(GUEST);

    test("H1 H8 logo links home, Log in returns to the page", async ({ page, kb }) => {
      await kb({ public_knowledge_base: 1 });
      await page.goto("/help/categories?a=1");
      await expect(page.getByRole("link", { name: "Opendesk" })).toHaveAttribute("href", "/help/");
      await expect(accountMenu(page)).toHaveCount(0);
      await page.getByRole("button", { name: "Log in" }).click();
      await expect(page).toHaveURL(/\/login\?redirect-to=%2Fhelp%2Fcategories%3Fa%3D1/);
    });
  });

  test.describe("guest on a phone", () => {
    test.use({ ...GUEST, viewport: PHONE });

    test("H10 a guest's logo menu holds only the text links", async ({ page, api, kb }) => {
      await kb({ public_knowledge_base: 1 });
      await saveQuickLinks(api, [{ label: "E2E Guest link", url: "https://example.com/guest", open_in_new_tab: 0 }]);
      try {
        await page.goto("/help");
        await accountMenu(page).click();
        await expect(page.getByRole("menuitem")).toHaveText(["E2E Guest link"]);
      } finally {
        await api.delete("OD Form Script", QUICK_LINKS);
      }
    });
  });

  test.describe("customer", () => {
    usePersona("customer");

    test("H2–H4 account menu goes home, to my tickets and to settings", async ({ page }) => {
      await page.goto("/help/categories");
      await accountMenu(page).click();
      await expect(page.getByRole("menuitem", { name: "Agent portal" })).toHaveCount(0);
      await page.getByRole("menuitem", { name: "My tickets" }).click();
      await expect(page).toHaveURL(/\/help\/my-tickets/);
      await accountMenu(page).click();
      await page.getByRole("menuitem", { name: "Home" }).click();
      await expect(page).toHaveURL(/\/help\/?$/);
      await accountMenu(page).click();
      await page.getByRole("menuitem", { name: "Settings" }).click();
      await expect(page).toHaveURL(/\/settings\/profile$/);
      await expect(page.getByRole("dialog")).toBeVisible();
    });

    test("H7 theme toggle switches at once and survives a reload", async ({ page }) => {
      await page.goto("/help");
      const theme = () => page.evaluate(() => document.documentElement.getAttribute("data-theme"));
      const before = await theme();
      await page.getByRole("button", { name: "Toggle theme" }).click();
      const after = await theme();
      expect(after).not.toBe(before);
      await page.reload();
      await expect.poll(theme).toBe(after);
      await page.getByRole("button", { name: "Toggle theme" }).click();
    });

    test("H12 ticket breadcrumbs lead back to the list", async ({ page, apiAs }) => {
      const ticket = await raiseTicket(await apiAs("customer"));
      await page.goto("/help/my-tickets/new");
      await expect(page.getByText("New ticket").first()).toBeVisible();
      await page.goto(`/help/my-tickets/${ticket.name}`);
      await expect(page.getByText(ticket.subject).first()).toBeVisible();
      await page.getByRole("link", { name: "Tickets" }).first().click();
      await expect(page).toHaveURL(/\/help\/my-tickets/);
    });

    test("H5 Log out signs out and lands on the home page", async ({ browser, baseURL }) => {
      // Own session: logging out would end the shared stored one.
      const context = await browser.newContext({ baseURL, extraHTTPHeaders: siteHeader() });
      const page = await context.newPage();
      await page.request.post("/api/method/login", { form: { usr: personas.customer.email, pwd: PASSWORD } });
      await page.goto("/help/categories");
      await accountMenu(page).click();
      await page.getByRole("menuitem", { name: "Log out" }).click();
      await expect(page).toHaveURL(/\/(help\/?|login.*)$/);
      const user = await page.request.get("/api/method/frappe.auth.get_logged_user");
      expect(user.status()).not.toBe(200);
      await context.close();
    });
  });

  test.describe("agent", () => {
    usePersona("agent");

    test("H6 agents also get Agent portal", async ({ page }) => {
      await page.goto("/help");
      await accountMenu(page).click();
      await page.getByRole("menuitem", { name: "Agent portal" }).click();
      await expect(page).toHaveURL(/\/opendesk/);
    });
  });

  test.describe("quick links and custom actions", () => {
    usePersona("customer");

    test("H9 H11 quick links and knowledge base actions show on knowledge base pages only", async ({ page, api }) => {
      const links = [
        { label: "E2E Docs", url: "https://docs.example.com", open_in_new_tab: 1 },
        { label: "E2E Same tab", url: "https://example.com/same", open_in_new_tab: 0 },
        { label: "E2E GitHub", url: "https://github.com/ikhsanddy/opendesk", open_in_new_tab: 1 },
        { label: "E2E Unsafe", url: "javascript:alert(1)", open_in_new_tab: 0 },
      ];
      // Short labels: long ones overflow the phone header onto the logo menu.
      const action = "E2E";
      await saveQuickLinks(api, links);
      const scriptName = `E2E KB Script ${uid()}`;
      await api.insert("OD Form Script", {
        __newname: scriptName,
        dt: "OD Ticket",
        apply_to: "Form",
        enabled: 1,
        apply_to_knowledge_base: 1,
        script: `function setupForm() { return { actions: [
          { label: "${action} plain", onClick: () => {} },
          { group: "${action} grp", buttonLabel: "${action} labelled", options: [{ label: "${action} inside", onClick: () => {} }] },
          { group: "${action} hidden", options: [{ label: "${action} in more", onClick: () => {} }] },
        ] } }`,
      });
      try {
        await page.goto("/help");
        const docs = page.getByRole("link", { name: "E2E Docs" });
        await expect(docs).toHaveAttribute("href", "https://docs.example.com");
        await expect(docs).toHaveAttribute("target", "_blank");
        await expect(docs).toHaveAttribute("rel", /noopener/);
        await expect(page.getByRole("link", { name: "E2E Same tab" })).not.toHaveAttribute("target", "_blank");
        await expect(page.getByRole("link", { name: "E2E GitHub" })).toBeVisible();
        await expect(page.getByRole("link", { name: "E2E GitHub" })).not.toHaveText("E2E GitHub");
        await expect(page.getByText("E2E Unsafe")).toHaveCount(0);

        await expect(page.getByRole("button", { name: `${action} plain` })).toBeVisible();
        await page.getByRole("button", { name: `${action} labelled` }).click();
        await expect(page.getByRole("menuitem", { name: `${action} inside` })).toBeVisible();
        await page.keyboard.press("Escape");
        await page.getByRole("button", { name: "More actions" }).click();
        await expect(page.getByRole("menuitem", { name: `${action} in more` })).toBeVisible();
        await page.keyboard.press("Escape");

        await page.goto("/help/my-tickets");
        await expect(page.getByRole("button", { name: "Raise a ticket" })).toBeVisible();
        await expect(page.getByRole("link", { name: "E2E Docs" })).toHaveCount(0);
        await expect(page.getByRole("button", { name: `${action} plain` })).toHaveCount(0);

        // H10: on a phone text links move into the logo menu.
        await page.setViewportSize(PHONE);
        await page.goto("/help");
        await expect(page.getByRole("link", { name: "E2E GitHub" })).toBeVisible();
        await expect(page.getByRole("link", { name: "E2E Docs" })).toHaveCount(0);
        await accountMenu(page).click();
        await expect(page.getByRole("menuitem", { name: "E2E Docs" })).toBeVisible();
      } finally {
        await api.delete("OD Form Script", scriptName);
        await api.delete("OD Form Script", QUICK_LINKS);
      }
    });
  });

  test.describe("custom actions on a phone", () => {
    usePersona("customer");
    test.use({ viewport: PHONE });

    test("H11 a labelled action menu folds into More actions on a phone", async ({ page, api }) => {
      const scriptName = `E2E KB Script ${uid()}`;
      await api.insert("OD Form Script", {
        __newname: scriptName,
        dt: "OD Ticket",
        apply_to: "Form",
        enabled: 1,
        apply_to_knowledge_base: 1,
        script: `function setupForm() { return { actions: [
          { group: "Help", buttonLabel: "Contact our support team", options: [{ label: "Email us", onClick: () => {} }] },
          { group: "Other", options: [{ label: "Status page", onClick: () => {} }] },
        ] } }`,
      });
      await saveQuickLinks(api, [{ label: "GitHub", url: "https://github.com/ikhsanddy/opendesk", open_in_new_tab: 1 }]);
      try {
        await page.goto("/help");
        await expect(page.getByRole("link", { name: "GitHub" })).toBeVisible();
        await expect(page.getByRole("button", { name: "Contact our support team" })).toHaveCount(0);
        await expect(accountMenu(page)).toBeInViewport({ ratio: 1 });
        await page.getByRole("button", { name: "More actions" }).click();
        await expect(page.getByRole("menuitem", { name: "Email us" })).toBeVisible();
        await expect(page.getByRole("menuitem", { name: "Status page" })).toBeVisible();
      } finally {
        await api.delete("OD Form Script", QUICK_LINKS);
        await api.delete("OD Form Script", scriptName);
      }
    });
  });

  test.describe("drawers on a phone", () => {
    usePersona("customer");
    test.use({ viewport: PHONE });

    test("H13 the section bar opens the article sheet; Esc closes it", async ({ page, api }) => {
      const category = await createCategory(api);
      const article = await createArticle(api, category.name);
      await page.goto(`/help/articles/${article.name}`);
      const sidebar = page.getByRole("navigation", { name: "Knowledge base" });
      const bar = page.getByRole("button", { name: `Articles / ${category.category_name}` });
      await expect(sidebar).not.toBeInViewport();
      await bar.click();
      const sheet = page.getByRole("dialog", { name: "Browse articles" });
      await expect(sheet).toBeVisible();
      await expect(sidebar).toBeInViewport();
      // The sheet traps focus: it lands on the sheet or inside it.
      await expect.poll(() => sheet.evaluate((el) => el.contains(document.activeElement))).toBe(true);
      await page.keyboard.press("Escape");
      await expect(sidebar).not.toBeInViewport();
      await expect(bar).toBeFocused();
    });

    test("H14 Ticket details opens the details drawer; Close details closes it", async ({ page, apiAs }) => {
      const ticket = await raiseTicket(await apiAs("customer"));
      await page.goto(`/help/my-tickets/${ticket.name}`);
      await page.getByRole("button", { name: "Ticket details" }).click();
      const close = page.getByRole("button", { name: "Close details" });
      await expect(close).toBeInViewport();
      await close.click();
      await expect(close).not.toBeInViewport();
    });
  });

  test.describe("admin preview", () => {
    usePersona("admin");

    test("H15 ?preview=1 shows the stored draft for the rest of the tab", async ({ page, api }) => {
      const category = await createCategory(api);
      await createArticle(api, category.name);
      await page.goto("/help");
      await page.evaluate(
        ([pinned]) =>
          localStorage.setItem(
            "kb:preview",
            JSON.stringify({ banner_image: "", banner_preset: "Violet", pinned: [pinned], links: [{ label: "E2E Preview link", url: "https://example.com", open_in_new_tab: false }] })
          ),
        [category.name]
      );
      await page.goto("/help?preview=1");
      await expect(page.getByRole("link", { name: "E2E Preview link" })).toBeVisible();
      await expect(page.getByRole("heading", { name: category.category_name, level: 2 })).toBeVisible();
      await page.goto("/help/categories");
      await expect(page.getByRole("link", { name: "E2E Preview link" })).toBeVisible();
      await page.evaluate(() => localStorage.removeItem("kb:preview"));
    });
  });
});

test.describe("knowledge base home", () => {
  usePersona("customer");

  test("K1 the hero shows the title and the banner preset", async ({ page, kb }) => {
    await kb({ banner_preset: "Blue" });
    await page.goto("/help");
    const title = page.getByRole("heading", { name: "Here's what might help", level: 1 });
    await expect(title).toBeVisible();
    await expect(page.getByText("Explore answers to frequently asked questions")).toBeVisible();
    const background = await page.evaluate(() =>
      [...document.querySelectorAll<HTMLElement>("*")].map((el) => el.style.background).find((bg) => bg.includes("surface-blue"))
    );
    expect(background).toContain("surface-blue");
  });

  test("K9 recently viewed is kept per user", async ({ page, api }) => {
    const category = await createCategory(api);
    const article = await createArticle(api, category.name);
    await page.goto(`/help/articles/${article.name}`);
    await expect(page.getByRole("heading", { name: article.title, level: 1 })).toBeVisible();
    const lists = await page.evaluate(() =>
      Object.fromEntries(Object.keys(localStorage).filter((key) => key.startsWith("opendesk-kb-recent")).map((key) => [key, JSON.parse(localStorage.getItem(key) || "[]")]))
    );
    expect(lists[`opendesk-kb-recent-articles:${personas.customer.email}`][0].name).toBe(article.name);
    // The guest list, written during session load, must stay empty.
    expect.soft(lists["opendesk-kb-recent-articles:Guest"] || []).toEqual([]);
  });

  test("K10 K12 pinned categories and View all", async ({ page, api }) => {
    const pinned = [await createCategory(api), await createCategory(api)];
    for (const category of pinned) await createArticle(api, category.name);
    try {
      for (const [index, category] of pinned.entries()) {
        await api.update("OD Article Category", category.name, { pinned: 1, pinned_order: index + 1 });
      }
      await page.goto("/help");
      const grid = page.locator('[data-component-id="category-grid-repeater"]');
      await expect(grid.getByRole("link")).toHaveCount(2);
      await expect(grid.getByRole("link").first()).toContainText(pinned[0].category_name);
      // K12: two cards take two columns.
      const columns = await grid.evaluate((el) => getComputedStyle(el).gridTemplateColumns.split(" ").length);
      expect(columns).toBe(2);
      await page.getByRole("button", { name: "View all" }).click();
      await expect(page).toHaveURL(/\/help\/categories$/);
      await page.goBack();
      await expect(grid.getByRole("link")).toHaveCount(2);
      // K11: a card opens its category.
      await grid.getByRole("link").first().click();
      await expect(page).toHaveURL(new RegExp(`/help/category/${pinned[0].name}$`));
    } finally {
      for (const category of pinned) await api.update("OD Article Category", category.name, { pinned: 0, pinned_order: 0 });
    }
  });

  test("K15 a lone pinned category gets its own layout", async ({ page, api }) => {
    const category = await createCategory(api);
    const articles = [await createArticle(api, category.name), await createArticle(api, category.name)];
    try {
      await api.update("OD Article Category", category.name, { pinned: 1, pinned_order: 1 });
      await page.goto("/help");
      await expect(page.getByRole("heading", { name: category.category_name })).toBeVisible();
      for (const article of articles) await expect(page.getByRole("link", { name: article.title })).toBeVisible();
      await expect(page.getByRole("radio", { name: "Popular" })).toHaveCount(0);
      await page.getByRole("button", { name: "View all categories" }).click();
      await expect(page).toHaveURL(/\/help\/categories$/);
    } finally {
      await api.update("OD Article Category", category.name, { pinned: 0, pinned_order: 0 });
    }
  });

  test("K14 Latest and Popular tabs sort the articles", async ({ page, api }) => {
    const category = await createCategory(api);
    const popular = await createArticle(api, category.name, { title: `Popular ${uid()}` });
    // Above any earlier run's articles; OD Article.views is a 32 bit int.
    await api.update("OD Article", popular.name, { views: Math.floor(Date.now() / 1000) });
    const latest = await createArticle(api, category.name, { title: `Latest ${uid()}` });
    await page.goto("/help");
    const articles = page.locator('[data-component-id="Repeater-9o4hxaycp"]').getByRole("link");
    await expect(articles.first()).toContainText(popular.title);
    await page.getByRole("radio", { name: "Latest" }).click();
    await expect(articles.first()).toContainText(latest.title);
    await page.getByRole("radio", { name: "Popular" }).click();
    await expect(articles.first()).toContainText(popular.title);
    await articles.first().press("Enter");
    await expect(page).toHaveURL(new RegExp(`/help/articles/${popular.name}-`));
  });
});

test.describe("audiences", () => {
  test.describe("guest", () => {
    test.use(GUEST);

    test("K16 CT3 AR4 AR21 AR24 a guest reads public articles only and cannot vote", async ({ page, api, kb }) => {
      await kb({ public_knowledge_base: 1, allow_anonymous_article_voting: 0 });
      const seeded = await seedAudiences(api);
      const only = await createCategory(api);
      await createArticle(api, only.name, { visibility: "Customers" });

      await page.goto(`/help/category/${seeded.category.name}`);
      await expect(page.getByText("1 article", { exact: true })).toBeVisible();
      await expect(page.getByRole("link", { name: seeded.public.title }).last()).toBeVisible();
      await expect(page.getByRole("link", { name: seeded.customers.title })).toHaveCount(0);

      await page.goto(`/help/category/${only.name}`);
      await expect(page.getByText("Category not found")).toBeVisible();
      await page.goto(`/help/articles/${seeded.customers.name}`);
      await expect(page.getByText("Article not found")).toBeVisible();

      await page.goto(`/help/articles/${seeded.public.name}`);
      await expect(page.getByRole("heading", { name: seeded.public.title, level: 1 })).toBeVisible();
      await expect(page.getByRole("button", { name: "Yes, it was helpful" })).toHaveCount(0);
      await expect(page.getByRole("link", { name: "here", exact: true })).toHaveCount(0);
      const vote = await page.request.post("/api/method/opendesk.api.knowledge_base.vote_on_article", {
        form: { article: seeded.public.name, vote: "1" },
      });
      expect(vote.status()).toBe(403);
    });

    test("AR20 a guest votes with a visitor cookie when anonymous voting is on", async ({ page, api, kb }) => {
      await kb({ public_knowledge_base: 1, allow_anonymous_article_voting: 1 });
      const category = await createCategory(api);
      const article = await createArticle(api, category.name);
      await page.goto(`/help/articles/${article.name}`);
      await page.getByRole("button", { name: "Yes, it was helpful" }).click();
      await expect(page.getByText("Thanks for your feedback!")).toBeVisible();
      const cookie = (await page.context().cookies()).find((row) => row.name === "od_visitor");
      expect(cookie?.httpOnly).toBe(true);
      const [row] = await api.list("OD Article Feedback", { filters: { article: article.name }, fields: ["feedback", "visitor_id", "user"] });
      expect(row.feedback).toBe("1");
      expect(row.visitor_id).toBeTruthy();
      // AR19: the vote is still shown on a revisit.
      await page.reload();
      await expect(page.getByRole("button", { name: "Yes, it was helpful" })).toHaveAttribute("aria-pressed", "true");
    });
  });

  test.describe("customer", () => {
    usePersona("customer");

    test("K16 CT1 AR4 a customer reads public and customer articles", async ({ page, api }) => {
      const seeded = await seedAudiences(api);
      await page.goto(`/help/category/${seeded.category.name}`);
      await expect(page.getByRole("heading", { name: seeded.category.category_name, level: 1 })).toBeVisible();
      await expect(page.getByText("2 articles", { exact: true })).toBeVisible();
      await expect(page.getByText("By Administrator")).toBeVisible();
      await expect(page.getByRole("link", { name: seeded.customers.title }).last()).toBeVisible();
      await expect(page.getByRole("link", { name: seeded.agents.title })).toHaveCount(0);
      for (const hidden of [seeded.agents, seeded.draft]) {
        await page.goto(`/help/articles/${hidden.name}`);
        await expect(page.getByText("Article not found")).toBeVisible();
      }
    });
  });

  test.describe("agent", () => {
    usePersona("agent");

    test("K16 AR5 an agent reads every audience and drafts", async ({ page, api }) => {
      const seeded = await seedAudiences(api);
      await page.goto(`/help/category/${seeded.category.name}`);
      await expect(page.getByText("3 articles", { exact: true })).toBeVisible();
      for (const article of [seeded.agents, seeded.draft]) {
        await page.goto(`/help/articles/${article.name}`);
        await expect(page.getByRole("heading", { name: article.title, level: 1 })).toBeVisible();
      }
    });
  });
});

test.describe("categories and category pages", () => {
  usePersona("customer");

  test("CA1 All categories lists a readable category and opens it", async ({ page, api }) => {
    const category = await createCategory(api);
    await createArticle(api, category.name);
    await page.goto("/help/categories");
    await page.getByRole("link", { name: category.category_name }).click();
    await expect(page).toHaveURL(new RegExp(`/help/category/${category.name}$`));
  });

  test("/ focuses Search categories on All categories, and the article search elsewhere", async ({ page, api }) => {
    const category = await createCategory(api);
    await createArticle(api, category.name);
    await page.goto("/help/categories");
    const search = page.getByRole("textbox", { name: "Search categories" });
    await expect(search).toBeVisible();
    await page.keyboard.press("/");
    await expect(search).toBeFocused();
    await expect(search).toHaveValue("");

    await page.goto(`/help/category/${category.name}`);
    await expect(page.getByPlaceholder("Search articles").first()).toBeVisible();
    await page.keyboard.press("/");
    await expect(page.getByPlaceholder("Search articles").first()).toBeFocused();
  });

  test("CT2–CT5 article list, sidebar toggle and sidebar search", async ({ page, api }) => {
    const category = await createCategory(api);
    const other = await createCategory(api);
    const article = await createArticle(api, category.name, { title: `Sidebar ${uid()}` });
    const otherArticle = await createArticle(api, other.name, { title: `Elsewhere ${uid()}` });

    await page.goto("/help/category/no-such-category");
    await expect(page.getByText("Category not found")).toBeVisible();

    await page.goto(`/help/category/${category.name}`);
    const sidebar = page.getByRole("navigation", { name: "Knowledge base" });
    await expect(sidebar.getByRole("button", { name: category.category_name })).toHaveAttribute("aria-expanded", "true");
    await sidebar.getByRole("button", { name: other.category_name }).click();
    await expect(sidebar.getByRole("button", { name: other.category_name })).toHaveAttribute("aria-expanded", "true");
    await expect(sidebar.getByRole("button", { name: category.category_name })).toHaveAttribute("aria-expanded", "false");
    await expect(sidebar.getByRole("link", { name: otherArticle.title })).toBeVisible();

    await page.locator("body").press("/");
    const search = sidebar.getByRole("textbox", { name: "Search articles" });
    await expect(search).toBeFocused();
    await search.fill(article.title);
    await expect(sidebar.getByRole("link", { name: article.title })).toBeVisible();
    await expect(sidebar.getByRole("link", { name: otherArticle.title })).toHaveCount(0);
    await search.fill(`nothing ${uid()}`);
    await expect(sidebar.getByText(/No articles match/)).toBeVisible();
    await search.fill("");

    // CT2: the list row opens the article.
    await page.locator("main, body").getByRole("link", { name: article.title }).last().click();
    await expect(page).toHaveURL(new RegExp(`/help/articles/${article.name}-`));
    // AR26: the sidebar marks the article being read.
    await expect(sidebar.getByRole("link", { name: article.title })).toHaveAttribute("aria-current", "page");
  });
});

test.describe("article page", () => {
  usePersona("customer");
  test.use({ permissions: ["clipboard-read", "clipboard-write"] });

  test("AR1 AR2 bare and stale links settle on the slug, keeping the hash", async ({ page, api }) => {
    const category = await createCategory(api);
    const article = await createArticle(api, category.name, { title: `Slug test ${uid()}` });
    const slug = article.title.toLowerCase().replace(/\s+/g, "-");
    await page.goto(`/help/articles/${article.name}#part`);
    await expect(page).toHaveURL(`/help/articles/${article.name}-${slug}#part`);
    await page.goto(`/help/articles/${article.name}-an-old-title`);
    await expect(page).toHaveURL(`/help/articles/${article.name}-${slug}`);
  });

  test("AR3 a heading link opens at that heading", async ({ page, api }) => {
    const category = await createCategory(api);
    const filler = "<p>" + "word ".repeat(600) + "</p>";
    const article = await createArticle(api, category.name, {
      content: `<h2>First part</h2>${filler}<h2>Deep part</h2>${filler}`,
    });
    await page.goto(`/help/articles/${article.name}#deep-part`);
    const heading = page.getByRole("heading", { name: "Deep part" });
    await expect(heading).toBeVisible();
    await expect(heading, "the page should scroll to the linked heading").toBeInViewport({ timeout: 2000 });
  });

  test("AR3 a heading link from the old knowledge base still opens at that heading", async ({ page, api }) => {
    const category = await createCategory(api);
    const filler = "<p>" + "word ".repeat(600) + "</p>";
    const article = await createArticle(api, category.name, {
      content: `<h2>First part</h2>${filler}<h2>What's new?</h2>${filler}`,
    });
    // The old desk kept the trailing dash; the portal's own id is `what-s-new`.
    await page.goto(`/help/articles/${article.name}#what-s-new-`);
    const heading = page.getByRole("heading", { name: "What's new?" });
    await expect(heading).toBeVisible();
    await expect(heading, "the page should scroll to the linked heading").toBeInViewport({ timeout: 2000 });
  });

  test("AR6 AR7 AR9–AR12 meta line, view count and copy actions", async ({ page, api, context }) => {
    const category = await createCategory(api);
    const article = await createArticle(api, category.name, { title: `Copy me ${uid()}`, visibility: "Customers" });
    await page.goto(`/help/articles/${article.name}`);
    await expect(page.getByText("1 minute to read")).toBeVisible();
    await expect(page.getByText("Administrator").last()).toBeVisible();
    await expect.poll(async () => (await api.get("OD Article", article.name)).views).toBe(1);

    await page.getByText("Copy link").click();
    await expect(page.getByText("Link copied")).toBeVisible();
    expect(await page.evaluate(() => navigator.clipboard.readText())).toBe(page.url());

    await page.getByRole("button", { name: "Copy for LLM" }).click();
    await expect(page.getByText("Copied as Markdown")).toBeVisible();
    expect(await page.evaluate(() => navigator.clipboard.readText())).toContain(`# ${article.title}`);

    await page.getByRole("button", { name: "More ways to use this article with an LLM" }).click();
    await expect(page.getByRole("menuitem", { name: "Copy as Markdown" })).toBeVisible();
    // AR12: a Customers article is never offered to outside LLMs.
    await expect(page.getByRole("menuitem", { name: "Open in ChatGPT" })).toHaveCount(0);
    const popup = context.waitForEvent("page");
    await page.getByRole("menuitem", { name: "View as Markdown" }).click();
    const markdown = await popup;
    await expect(markdown.locator("body")).toContainText(`# ${article.title}`);
    await markdown.close();

    // AR7: no second view within the hour; wait for the request first.
    const counted = page.waitForResponse((response) => response.url().includes("increment_views"));
    await page.reload();
    await counted;
    expect((await api.get("OD Article", article.name)).views).toBe(1);
  });

  test("AR17 AR18 AR22 a vote can change, clear, and is rate limited", async ({ page, api }) => {
    const category = await createCategory(api);
    const article = await createArticle(api, category.name);
    const no = page.getByRole("button", { name: "No, it wasn't helpful" });
    const yes = page.getByRole("button", { name: "Yes, it was helpful" });
    const feedback = async () =>
      (await api.list("OD Article Feedback", { filters: { article: article.name, user: personas.customer.email }, fields: ["feedback"] }))[0]?.feedback;
    await page.goto(`/help/articles/${article.name}`);
    await no.click();
    await expect(no).toHaveAttribute("aria-pressed", "true");
    await expect.poll(feedback).toBe("2");
    await yes.click();
    await expect.poll(feedback).toBe("1");
    await yes.click();
    await expect(yes).toHaveAttribute("aria-pressed", "false");
    await expect.poll(feedback).toBe("0");
    await no.click();
    await yes.click();
    await expect(page.getByText("Thanks for your feedback!").first()).toBeVisible();
    // The sixth vote on one article within an hour is refused.
    await expect.poll(feedback).toBe("1");
    const refused = page.waitForResponse(
      (response) => response.url().includes("vote_on_article") && /"vote":\s*2/.test(response.request().postData() || "")
    );
    await no.click();
    expect((await refused).status()).toBe(429);
    await expect(page.locator("[data-sonner-toast][data-type=error]")).toBeVisible();
    expect(await feedback()).toBe("1");
  });

  test("AR14 below xl the inline On this page jumps to a heading", async ({ page, api }) => {
    await page.setViewportSize({ width: 1024, height: 800 });
    const category = await createCategory(api);
    const filler = "<p>" + "word ".repeat(400) + "</p>";
    const article = await createArticle(api, category.name, {
      content: `<h2>Alpha part</h2>${filler}<h3>Beta part</h3>${filler}<h2>Gamma part</h2>${filler}`,
    });
    await page.goto(`/help/articles/${article.name}`);
    await page.getByRole("button", { name: "On this page" }).click();
    await page.getByRole("button", { name: "Gamma part" }).click();
    await expect(page.getByRole("heading", { name: "Gamma part" })).toBeInViewport();
  });

  test("AR15 at xl a single heading still gets the side contents", async ({ page, api }) => {
    await page.setViewportSize({ width: 1440, height: 900 });
    const category = await createCategory(api);
    const article = await createArticle(api, category.name, { content: "<h2>Only part</h2><p>Body</p>" });
    await page.goto(`/help/articles/${article.name}`);
    await expect(page.getByRole("heading", { name: "Only part" })).toBeVisible();
    const toc = page.getByRole("navigation").filter({ hasText: "On this page" });
    await expect.soft(toc.getByRole("button", { name: "Only part" }), "one heading still shows the xl TOC").toBeVisible();
  });

  test("AR25 AR27 related articles open and reset the article scroll", async ({ page, api }) => {
    const category = await createCategory(api);
    const filler = "<p>" + "word ".repeat(800) + "</p>";
    const created = [];
    for (let i = 0; i < 8; i++) created.push(await createArticle(api, category.name, { title: `Related ${i} ${uid()}`, content: filler }));
    await page.goto(`/help/articles/${created[0].name}`);
    await expect(page.getByText("Related articles")).toBeVisible();
    const rows = page.locator('[data-component-id="container-article-scroll"]').getByRole("link", { name: /^Related \d/ });
    await expect(rows).toHaveCount(5);
    const panel = page.locator('[data-component-id="container-article-scroll"]');
    await panel.evaluate((el) => el.scrollTo({ top: el.scrollHeight }));
    const target = rows.first();
    const title = (await target.innerText()).split("\n")[0];
    await target.click();
    await expect(page.getByRole("heading", { name: title, level: 1 })).toBeVisible();
    await expect.poll(() => panel.evaluate((el) => el.scrollTop)).toBe(0);
  });

  test.describe("phone", () => {
    test.use({ viewport: PHONE });

    test("AR13 the Article actions menu holds the copy actions", async ({ page, api }) => {
      const category = await createCategory(api);
      const article = await createArticle(api, category.name);
      await page.goto(`/help/articles/${article.name}`);
      await expect(page.getByText("Copy link")).toBeHidden();
      await page.getByRole("button", { name: "Article actions" }).click();
      for (const name of ["Copy for LLM", "Copy link", "View as Markdown"]) {
        await expect(page.getByRole("menuitem", { name })).toBeVisible();
      }
    });
  });
});

test.describe("article page, public knowledge base", () => {
  usePersona("customer");

  test("AR12 a public article offers Open in ChatGPT and Claude", async ({ page, api, kb, context }) => {
    await kb({ public_knowledge_base: 1 });
    const category = await createCategory(api);
    const article = await createArticle(api, category.name);
    await page.goto(`/help/articles/${article.name}`);
    await page.getByRole("button", { name: "More ways to use this article with an LLM" }).click();
    await expect(page.getByRole("menuitem", { name: "Open in ChatGPT" })).toBeVisible();
    const popup = context.waitForEvent("page");
    await page.getByRole("menuitem", { name: "Open in Claude" }).click();
    const claude = await popup;
    expect(decodeURIComponent(claude.url())).toContain(`get_article_markdown?name=${article.name}`);
    await claude.close();
  });
});

test.describe("knowledge base settings", () => {
  usePersona("admin");

  test("S30–S34 the Knowledge Base panel saves toggles, pins, banner and links", async ({ page, api, kb, context }) => {
    await kb({ public_knowledge_base: 1, allow_anonymous_article_voting: 0, banner_preset: "" });
    const category = await createCategory(api);
    await createArticle(api, category.name);
    const label = `E2E Link ${uid()}`;
    try {
      await page.goto("/help");
      await accountMenu(page).click();
      await page.getByRole("menuitem", { name: "Settings" }).click();
      const dialog = page.getByRole("dialog");
      await dialog.getByRole("tab", { name: "Knowledge Base", exact: true }).click();
      await expect(page).toHaveURL(/\/settings\/knowledge-base$/);

      // Switches save without the Save button.
      await dialog.getByText("Allow guests to vote on articles").locator("xpath=../..").getByRole("switch").click();
      await expect.poll(async () => (await api.get("OD Settings", "OD Settings")).allow_anonymous_article_voting).toBe(1);
      await expect(dialog.getByText("Unsaved")).toBeHidden();
      await dialog.getByRole("radio", { name: "Blue" }).click();
      await expect(dialog.getByText("Unsaved")).toBeVisible();
      // Pins save from their own dialog, apart from the draft.
      await dialog.getByRole("button", { name: "Customize" }).click();
      const pins = page.getByRole("dialog", { name: "Pinned categories" });
      await pins.getByRole("button", { name: `Pin ${category.category_name}`, exact: true }).click();
      await pins.getByRole("button", { name: "Save" }).click();
      await expect(pins).toBeHidden();
      await expect.poll(async () => (await api.get("OD Article Category", category.name)).pinned).toBe(1);
      await dialog.getByRole("button", { name: "Add link" }).click();
      await dialog.getByPlaceholder("Contact sales").fill(label);
      // S33: an unsafe address is refused on Save.
      await dialog.getByPlaceholder("https://example.com/contact").fill("javascript:alert(1)");
      await dialog.getByRole("button", { name: "Save" }).click();
      await expect(page.getByText(`${label}: use a web address`)).toBeVisible();
      await dialog.getByPlaceholder("https://example.com/contact").fill("https://example.com/e2e");

      // S34: Preview opens the portal with the draft.
      const popup = context.waitForEvent("page");
      await dialog.getByRole("button", { name: "Preview" }).click();
      const preview = await popup;
      await expect(preview).toHaveURL(/\/help\/?\?preview=1/);
      await expect(preview.getByRole("link", { name: label })).toBeVisible();
      await preview.close();

      await dialog.getByRole("button", { name: "Save" }).click();
      await expect(dialog.getByText("Unsaved")).toBeHidden();
      const settings = await api.get("OD Settings", "OD Settings");
      expect(settings.banner_preset).toBe("Blue");
      expect((await api.get("OD Article Category", category.name)).pinned).toBe(1);
      expect((await api.get("OD Form Script", QUICK_LINKS)).script).toContain(label);
    } finally {
      await api.update("OD Article Category", category.name, { pinned: 0, pinned_order: 0 });
      if (await api.exists("OD Form Script", { name: QUICK_LINKS })) await api.delete("OD Form Script", QUICK_LINKS);
    }
  });
});

test.describe("knowledge base settings: pins on the home page", () => {
  usePersona("admin");

  test("pins saved from Settings show on the home page without a reload", async ({ page, api }) => {
    const pinned = [await createCategory(api), await createCategory(api)];
    for (const category of pinned) await createArticle(api, category.name);
    try {
      await page.goto("/help/settings/knowledge-base");
      const grid = page.locator('[data-component-id="category-grid-repeater"]');
      // The settings dialog hides the page from the accessibility tree, so match by CSS.
      const cards = grid.locator("a");
      await expect.poll(() => cards.count()).toBeGreaterThan(2);
      await page.getByRole("dialog").getByRole("button", { name: "Customize" }).click();
      const pins = page.getByRole("dialog", { name: "Pinned categories" });
      for (const category of pinned) {
        await pins.getByRole("button", { name: `Pin ${category.category_name}`, exact: true }).click();
      }
      await pins.getByRole("button", { name: "Save" }).click();
      await expect(pins).toBeHidden();
      await expect(cards).toHaveCount(2);
      await expect(cards.first()).toContainText(pinned[0].category_name);
    } finally {
      for (const category of pinned) await api.update("OD Article Category", category.name, { pinned: 0, pinned_order: 0 });
    }
  });
});

test.describe("knowledge base settings: pin row menu", () => {
  usePersona("admin");

  test("S38 a pinned row's menu edits the draft; Save writes the order", async ({ page, api }) => {
    const first = await createCategory(api);
    const second = await createCategory(api);
    await api.update("OD Article Category", first.name, { pinned: 1, pinned_order: 1 });
    await api.update("OD Article Category", second.name, { pinned: 1, pinned_order: 2 });
    try {
      await page.goto("/help/settings/knowledge-base");
      const dialog = page.getByRole("dialog");
      await dialog.getByRole("button", { name: `Options for ${first.category_name}` }).click();
      await page.getByRole("menuitem", { name: "Move down" }).click();
      await expect(dialog.getByText("Unsaved")).toBeVisible();
      expect((await api.get("OD Article Category", first.name)).pinned_order).toBe(1);
      await dialog.getByRole("button", { name: "Save" }).click();
      await expect(dialog.getByText("Unsaved")).toBeHidden();
      expect((await api.get("OD Article Category", first.name)).pinned_order).toBe(2);
      expect((await api.get("OD Article Category", second.name)).pinned_order).toBe(1);

      await dialog.getByRole("button", { name: `Options for ${second.category_name}` }).click();
      await page.getByRole("menuitem", { name: "Unpin" }).click();
      await expect(dialog.getByText("Unsaved")).toBeVisible();
      expect((await api.get("OD Article Category", second.name)).pinned).toBe(1);
      await dialog.getByRole("button", { name: "Save" }).click();
      await expect(dialog.getByText("Unsaved")).toBeHidden();
      expect((await api.get("OD Article Category", second.name)).pinned).toBe(0);
      expect((await api.get("OD Article Category", first.name)).pinned_order).toBe(1);
    } finally {
      for (const category of [first, second]) {
        await api.update("OD Article Category", category.name, { pinned: 0, pinned_order: 0 });
      }
    }
  });
});

async function saveQuickLinks(api, links: Record<string, any>[]) {
  const json = JSON.stringify(links);
  await api.insert("OD Form Script", {
    __newname: QUICK_LINKS,
    dt: "OD Ticket",
    apply_to: "Form",
    enabled: 1,
    apply_to_knowledge_base: 1,
    script: `function setupForm() {\n  return { links: ${json} };\n}`,
  });
}
byte
46.803
baris
922
Jenis
ts
Commit terakhir
28 Oktober 2026