Skip to content

fix(www): de-flake self-host Get started dialog E2E #571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
elie222 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(www): de-flake self-host Get started dialog E2E #571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions apps/www/e2e/marketing-homepage.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,10 @@ test.describe("marketing homepage", () => {
await selfHost.scrollIntoViewIfNeeded();
await captureScreenshot(page, testInfo, "01-marketing-homepage-selfhost");

await expect(async () => {
await selfHost.getByRole("button", { name: /Get started/i }).click();
await expect(page.getByRole("dialog")).toBeVisible();
}).toPass();
const dialog = page.getByRole("dialog");
await expect(page.locator("html")).toHaveAttribute("data-get-started-ready", "");
await selfHost.getByRole("button", { name: /Get started/i }).click();
const dialog = page.locator("[data-get-started-dialog]");
await expect(dialog).toBeVisible();
await expect(dialog.getByRole("heading")).toBeVisible();
await expect(dialog).not.toContainText(
/openssl|docker-compose\.images|POSTGRES_PASSWORD|BETTER_AUTH_SECRET|mkdir rakazo/i,
Expand Down Expand Up @@ -64,11 +63,10 @@ test.describe("marketing homepage", () => {
await selfHost.scrollIntoViewIfNeeded();
await captureScreenshot(page, testInfo, "03-marketing-homepage-zh-selfhost");

await expect(async () => {
await selfHost.getByRole("button", { name: "开始使用" }).click();
await expect(page.getByRole("dialog")).toBeVisible();
}).toPass();
const dialog = page.getByRole("dialog");
await expect(page.locator("html")).toHaveAttribute("data-get-started-ready", "");
await selfHost.getByRole("button", { name: "开始使用" }).click();
const dialog = page.locator("[data-get-started-dialog]");
await expect(dialog).toBeVisible();
await expect(dialog.getByRole("heading")).toHaveText("你想如何开始？");
await expect(dialog).not.toContainText(
/openssl|docker-compose\.images|POSTGRES_PASSWORD|BETTER_AUTH_SECRET|mkdir rakazo/i,
Expand Down
138 changes: 76 additions & 62 deletions apps/www/src/components/GetStartedDialog.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,67 +79,81 @@ const { copy, waitlist } = Astro.props;
</div>
</dialog>

<script>
const dialog = document.querySelector<HTMLDialogElement>("[data-get-started-dialog]");
const openers = document.querySelectorAll<HTMLButtonElement>("[data-get-started-open]");
const closeButtons = dialog?.querySelectorAll<HTMLButtonElement>("[data-get-started-close]");
const choice = dialog?.querySelector<HTMLElement>("[data-get-started-choice]");
const signup = dialog?.querySelector<HTMLElement>("[data-get-started-signup]");
const success = dialog?.querySelector<HTMLElement>("[data-get-started-success]");
const successTitle = dialog?.querySelector<HTMLElement>("[data-get-started-success-title]");
const email = dialog?.querySelector<HTMLInputElement>("input[type='email']");
const selfHostBtn = dialog?.querySelector<HTMLButtonElement>("[data-get-started-selfhost]");
const cloudBtn = dialog?.querySelector<HTMLButtonElement>("[data-get-started-cloud]");
const backBtn = dialog?.querySelector<HTMLButtonElement>("[data-get-started-back]");

function showChoice() {
if (!choice || !signup || !success) return;
choice.hidden = false;
signup.hidden = true;
success.hidden = true;
dialog?.setAttribute("aria-labelledby", "get-started-title");
}

function showCloud() {
if (!choice || !signup || !success) return;
choice.hidden = true;
signup.hidden = false;
success.hidden = true;
dialog?.setAttribute("aria-labelledby", "get-started-cloud-title");
window.requestAnimationFrame(() => email?.focus());
}

openers.forEach((opener) => {
opener.addEventListener("click", () => {
if (!dialog || dialog.open) return;
showChoice();
dialog.showModal();
window.requestAnimationFrame(() => selfHostBtn?.focus());
<script is:inline>
(function () {
const dialog = document.querySelector("[data-get-started-dialog]");
if (!dialog) return;

const choice = dialog.querySelector("[data-get-started-choice]");
const signup = dialog.querySelector("[data-get-started-signup]");
const success = dialog.querySelector("[data-get-started-success]");
const successTitle = dialog.querySelector("[data-get-started-success-title]");
const email = dialog.querySelector("input[type='email']");
const selfHostBtn = dialog.querySelector("[data-get-started-selfhost]");

function showChoice() {
if (!choice || !signup || !success) return;
choice.hidden = false;
signup.hidden = true;
success.hidden = true;
dialog.setAttribute("aria-labelledby", "get-started-title");
}

function showCloud() {
if (!choice || !signup || !success) return;
choice.hidden = true;
signup.hidden = false;
success.hidden = true;
dialog.setAttribute("aria-labelledby", "get-started-cloud-title");
window.requestAnimationFrame(() => email?.focus());
}

document.addEventListener("click", (event) => {
const target = event.target;
if (!(target instanceof Element)) return;

if (target.closest("[data-get-started-open]")) {
if (dialog.open) return;
showChoice();
dialog.showModal();
window.requestAnimationFrame(() => selfHostBtn?.focus());
return;
}

if (target.closest("[data-get-started-close]")) {
dialog.close();
return;
}

if (target.closest("[data-get-started-selfhost]")) {
dialog.close();
document.getElementById("selfhost")?.scrollIntoView({ behavior: "smooth" });
return;
}

if (target.closest("[data-get-started-cloud]")) {
showCloud();
return;
}

if (target.closest("[data-get-started-back]")) {
showChoice();
}
});

dialog.addEventListener("click", (event) => {
if (event.target === dialog) dialog.close();
});
});

selfHostBtn?.addEventListener("click", () => {
dialog?.close();
document.getElementById("selfhost")?.scrollIntoView({ behavior: "smooth" });
});

cloudBtn?.addEventListener("click", () => showCloud());
backBtn?.addEventListener("click", () => showChoice());

closeButtons?.forEach((button) => {
button.addEventListener("click", () => dialog?.close());
});

dialog?.addEventListener("click", (event) => {
if (event.target === dialog) dialog.close();
});

dialog?.addEventListener("waitlist:joined", () => {
if (!choice || !signup || !success) return;
choice.hidden = true;
signup.hidden = true;
success.hidden = false;
dialog.setAttribute("aria-labelledby", "get-started-success-title");
successTitle?.focus();
});

dialog.addEventListener("waitlist:joined", () => {
if (!choice || !signup || !success) return;
choice.hidden = true;
signup.hidden = true;
success.hidden = false;
dialog.setAttribute("aria-labelledby", "get-started-success-title");
successTitle?.focus();
});

document.documentElement.dataset.getStartedReady = "";
})();
</script>
4 changes: 2 additions & 2 deletions apps/www/src/components/HomePage.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ const structuredData = {
<Header locale={locale} copy={copy.nav} starsLabel={starsLabel} homeHref={homeHref} />

<main id="main">
<GetStartedDialog copy={copy.getStartedDialog} waitlist={copy.waitlist} />

<section class="hero">
<a class="hero__pill" href="#selfhost">
<span class="hero__badge">{copy.hero.badge}</span>
Expand Down Expand Up @@ -279,8 +281,6 @@ const structuredData = {
}
</div>
</section>

<GetStartedDialog copy={copy.getStartedDialog} waitlist={copy.waitlist} />
</main>

<Footer
Expand Down
Loading