Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.
TypeScript i18nextnext-authnextjspostgresqlprismareact-emailt3-stacktailwindcsstrpcturborepotypescriptzod
🚀 Add package for automatically generating screenshots (#2186)
Luke Vella95ce0dbfb9d8
diff --git a/.gitignore b/.gitignoreindex 56308a05c..e460470dc 100644--- a/.gitignore+++ b/.gitignore@@ -38,6 +38,9 @@ tsconfig.tsbuildinfo# Playwrightplaywright-reporttest-results++# Screenshots tool output+packages/screenshots/screenshots.kiro.verceldiff --git a/apps/web/next.config.ts b/apps/web/next.config.tsindex e0ee42db6..a268460a1 100644--- a/apps/web/next.config.ts+++ b/apps/web/next.config.ts@@ -99,9 +99,12 @@ const nextConfig: NextConfig = {},];},- devIndicators: {- position: "bottom-right",- },+ devIndicators:+ process.env.HIDE_DEV_INDICATOR === "true"+ ? false+ : {+ position: "bottom-right",+ },};const sentryWebpackPluginOptions = {diff --git a/apps/web/package.json b/apps/web/package.jsonindex d4b369638..b4f2802b4 100644--- a/apps/web/package.json+++ b/apps/web/package.json@@ -112,6 +112,7 @@"@babel/core": "^7.26.10","@next/bundle-analyzer": "16.1.6","@playwright/test": "^1.57.0",+ "@rallly/test-helpers": "workspace:*","@rallly/tsconfig": "workspace:*","@testing-library/jest-dom": "^6.7.0","@testing-library/react": "^16.3.0",diff --git a/apps/web/tests/admin-setup.spec.ts b/apps/web/tests/admin-setup.spec.tsindex 6823155cb..72a89d515 100644--- a/apps/web/tests/admin-setup.spec.ts+++ b/apps/web/tests/admin-setup.spec.ts@@ -1,6 +1,6 @@import { expect, test } from "@playwright/test";import { prisma } from "@rallly/database";-import { deleteAllMessages } from "./mailpit/mailpit";+import { deleteAllMessages } from "@rallly/test-helpers";import { createUserInDb, loginWithEmail } from "./test-utils";const INITIAL_ADMIN_TEST_EMAIL = "[email protected]";diff --git a/apps/web/tests/authentication.spec.ts b/apps/web/tests/authentication.spec.tsindex 7f861657c..31c321586 100644--- a/apps/web/tests/authentication.spec.ts+++ b/apps/web/tests/authentication.spec.ts@@ -1,9 +1,12 @@import { expect, test } from "@playwright/test";import { prisma } from "@rallly/database";-import { deleteAllMessages } from "./mailpit/mailpit";+import {+ deleteAllMessages,+ getCode,+ getPasswordResetLink,+} from "@rallly/test-helpers";import { RegisterPage } from "./register-page";import { createUserInDb, loginWithEmail } from "./test-utils";-import { getCode, getPasswordResetLink } from "./utils";const testUserEmail = "[email protected]";const testExistingUserEmail = "[email protected]";diff --git a/apps/web/tests/control-panel.spec.ts b/apps/web/tests/control-panel.spec.tsindex 2d2e7405d..7203f7080 100644--- a/apps/web/tests/control-panel.spec.ts+++ b/apps/web/tests/control-panel.spec.ts@@ -1,7 +1,7 @@import { expect, test } from "@playwright/test";import { prisma } from "@rallly/database";-import { deleteAllMessages } from "./mailpit/mailpit";+import { deleteAllMessages } from "@rallly/test-helpers";import { createUserInDb, loginWithEmail } from "./test-utils";const CONTROL_PANEL_NON_ADMIN_EMAIL = "[email protected]";diff --git a/apps/web/tests/create-delete-poll.spec.ts b/apps/web/tests/create-delete-poll.spec.tsindex 78a6bca44..072014ca5 100644--- a/apps/web/tests/create-delete-poll.spec.ts+++ b/apps/web/tests/create-delete-poll.spec.ts@@ -1,9 +1,8 @@import type { Page } from "@playwright/test";import { expect, test } from "@playwright/test";+import { deleteAllMessages } from "@rallly/test-helpers";import { NewPollPage } from "tests/new-poll-page";-import { deleteAllMessages } from "./mailpit/mailpit";-test.describe.serial(() => {let page: Page;@@ -29,7 +28,7 @@ test.describe.serial(() => {const deletePollDialog = page.getByRole("dialog");- deletePollDialog.getByRole("button", { name: "delete" }).click();+ await deletePollDialog.getByRole("button", { name: "delete" }).click();await expect(page).toHaveURL("/login?redirectTo=%2Fpolls");});diff --git a/apps/web/tests/guest-to-user-migration.spec.ts b/apps/web/tests/guest-to-user-migration.spec.tsindex eaa56aa15..855c5ed42 100644--- a/apps/web/tests/guest-to-user-migration.spec.ts+++ b/apps/web/tests/guest-to-user-migration.spec.ts@@ -1,9 +1,8 @@import { expect, test } from "@playwright/test";import { prisma } from "@rallly/database";+import { deleteAllMessages } from "@rallly/test-helpers";import { NewPollPage } from "tests/new-poll-page";-import { LoginPage } from "./login-page";-import { deleteAllMessages } from "./mailpit/mailpit";import { RegisterPage } from "./register-page";const testUser = {@@ -57,7 +56,7 @@ test.describe.serial(() => {await page.getByRole("link", { name: "Login" }).click();await expect(page).toHaveURL(/login/);- // Step 3: Complete lplogin+ // Step 3: Complete loginconst loginPage = new LoginPage(page);await loginPage.login({email: testUser.email,diff --git a/apps/web/tests/login-page.ts b/apps/web/tests/login-page.tsindex d55e2e049..f485ec93a 100644--- a/apps/web/tests/login-page.ts+++ b/apps/web/tests/login-page.ts@@ -1,6 +1,6 @@import type { Page } from "@playwright/test";-import { getCode } from "./utils";+import { getCode } from "@rallly/test-helpers";export class LoginPage {constructor(private readonly page: Page) {}diff --git a/apps/web/tests/mailpit/types.ts b/apps/web/tests/mailpit/types.tsdeleted file mode 100644index 92861bc42..000000000--- a/apps/web/tests/mailpit/types.ts+++ /dev/null@@ -1,46 +0,0 @@-export interface MailpitAttachment {- ContentID: string;- ContentType: string;- FileName: string;- PartID: string;- Size: number;-}--export interface MailpitEmailAddress {- Address: string;- Name: string;-}--export interface MailpitMessageSummary {- Attachments: number;- Bcc: MailpitEmailAddress[];- Cc: MailpitEmailAddress[];- Created: string;- From: MailpitEmailAddress;- ID: string;- MessageID: string;- Read: boolean;- ReplyTo: MailpitEmailAddress[];- Size: number;- Snippet: string;- Subject: string;- Tags: string[];- To: MailpitEmailAddress[];-}--export interface MailpitMessage extends MailpitMessageSummary {- HTML: string;- Text: string;- Inline: MailpitAttachment[];- ReturnPath: string;- Date: string;-}--export interface MailpitListMessagesResponse {- messages: MailpitMessageSummary[];- messages_count: number;- start: number;- tags: string[];- total: number;- unread: number;-}diff --git a/apps/web/tests/register-page.ts b/apps/web/tests/register-page.tsindex d46bb2c4f..6d740a21a 100644--- a/apps/web/tests/register-page.ts+++ b/apps/web/tests/register-page.ts@@ -1,7 +1,7 @@import type { Page } from "@playwright/test";import { expect } from "@playwright/test";-import { getCode } from "./utils";+import { getCode } from "@rallly/test-helpers";export class RegisterPage {constructor(private readonly page: Page) {}diff --git a/apps/web/tests/test-utils.ts b/apps/web/tests/test-utils.tsindex 7f4f8e60f..4be22f7ed 100644--- a/apps/web/tests/test-utils.ts+++ b/apps/web/tests/test-utils.ts@@ -1,8 +1,8 @@-import type { Page } from "@playwright/test";import type { SpaceTier, UserRole } from "@rallly/database";import { prisma } from "@rallly/database";import dayjs from "dayjs";-import { LoginPage } from "./login-page";++export { loginWithEmail } from "@rallly/test-helpers";export async function createUserInDb({email,@@ -109,15 +109,3 @@ export async function createTestPoll({data: pollData,});}--export async function loginWithEmail(- page: Page,- { email, password }: { email: string; password?: string },-) {- const loginPage = new LoginPage(page);- await loginPage.goto();- await loginPage.login({- email,- password,- });-}diff --git a/apps/web/tests/vote-and-comment.spec.ts b/apps/web/tests/vote-and-comment.spec.tsindex 3ab9a4860..4063a60fc 100644--- a/apps/web/tests/vote-and-comment.spec.ts+++ b/apps/web/tests/vote-and-comment.spec.ts@@ -1,10 +1,9 @@import type { Page } from "@playwright/test";import { expect, test } from "@playwright/test";import { prisma } from "@rallly/database";+import { captureOne } from "@rallly/test-helpers";import { load } from "cheerio";import type { PollPage } from "tests/poll-page";--import { captureOne } from "./mailpit/mailpit";import { NewPollPage } from "./new-poll-page";test.describe(() => {diff --git a/package.json b/package.jsonindex 18d49b0b2..64bdc11ef 100644--- a/package.json+++ b/package.json@@ -27,6 +27,7 @@"i18n:scan": "turbo i18n:scan","type-check": "turbo type-check","release": "./scripts/create-release.sh",+ "screenshots": "pnpm --filter @rallly/screenshots capture","sherif": "pnpx sherif@latest","sherif:fix": "pnpx sherif@latest --fix"},diff --git a/packages/screenshots/capture/create-poll.spec.ts b/packages/screenshots/capture/create-poll.spec.tsnew file mode 100644index 000000000..bd6b1b7ed--- /dev/null+++ b/packages/screenshots/capture/create-poll.spec.ts@@ -0,0 +1,11 @@+import { test } from "@playwright/test";+import { screenshotPath } from "./helpers";++test("create poll", async ({ page }) => {+ await page.goto("/new");+ await page.waitForLoadState("networkidle");+ await page.screenshot({+ path: screenshotPath("create-poll"),+ fullPage: true,+ });+});diff --git a/packages/screenshots/capture/dashboard.spec.ts b/packages/screenshots/capture/dashboard.spec.tsnew file mode 100644index 000000000..fcba94ec9--- /dev/null+++ b/packages/screenshots/capture/dashboard.spec.ts@@ -0,0 +1,10 @@+import { test } from "@playwright/test";+import { loginWithEmail } from "@rallly/test-helpers";+import { screenshotPath } from "./helpers";++test("dashboard", async ({ page }) => {+ await loginWithEmail(page, { email: "[email protected]" });+ await page.goto("/");+ await page.waitForLoadState("networkidle");+ await page.screenshot({ path: screenshotPath("dashboard"), fullPage: true });+});diff --git a/packages/screenshots/capture/helpers.ts b/packages/screenshots/capture/helpers.tsnew file mode 100644index 000000000..29a7025eb--- /dev/null+++ b/packages/screenshots/capture/helpers.ts@@ -0,0 +1,3 @@+export function screenshotPath(name: string) {+ return `screenshots/${name}.png`;+}diff --git a/packages/screenshots/capture/login.spec.ts b/packages/screenshots/capture/login.spec.tsnew file mode 100644index 000000000..44ab01c39--- /dev/null+++ b/packages/screenshots/capture/login.spec.ts@@ -0,0 +1,8 @@+import { test } from "@playwright/test";+import { screenshotPath } from "./helpers";++test("login page", async ({ page }) => {+ await page.goto("/login");+ await page.getByText("Welcome").waitFor();+ await page.screenshot({ path: screenshotPath("login"), fullPage: true });+});diff --git a/packages/screenshots/capture/poll-admin.spec.ts b/packages/screenshots/capture/poll-admin.spec.tsnew file mode 100644index 000000000..569abd7ab--- /dev/null+++ b/packages/screenshots/capture/poll-admin.spec.ts@@ -0,0 +1,111 @@+import { test } from "@playwright/test";+import { prisma } from "@rallly/database";+import { loginWithEmail } from "@rallly/test-helpers";+import dayjs from "dayjs";+import { screenshotPath } from "./helpers";++const pollId = "screenshot-poll";++test.beforeAll(async () => {+ const existingPoll = await prisma.poll.findUnique({+ where: { id: pollId },+ });++ if (existingPoll) {+ await prisma.poll.delete({ where: { id: pollId } });+ }++ await prisma.poll.create({+ data: {+ id: pollId,+ title: "Q1 Planning Session",+ description:+ "Let's find a time to discuss our goals and priorities for the upcoming quarter.",+ location: "Conference Room A",+ userId: "pro-user",+ spaceId: "space-2",+ status: "open",+ timeZone: "America/New_York",+ adminUrlId: "screenshot-admin",+ participantUrlId: "screenshot-participant",+ options: {+ create: [+ {+ startTime: dayjs()+ .add(7, "day")+ .hour(9)+ .minute(0)+ .second(0)+ .toDate(),+ duration: 60,+ },+ {+ startTime: dayjs()+ .add(8, "day")+ .hour(14)+ .minute(0)+ .second(0)+ .toDate(),+ duration: 60,+ },+ {+ startTime: dayjs()+ .add(10, "day")+ .hour(10)+ .minute(0)+ .second(0)+ .toDate(),+ duration: 60,+ },+ ],+ },+ participants: {+ create: [+ { name: "Sarah Johnson", email: "[email protected]" },+ { name: "Michael Chen", email: "[email protected]" },+ { name: "Emily Rodriguez", email: "[email protected]" },+ ],+ },+ },+ include: { options: true, participants: true },+ });++ // Add votes for each participant+ const poll = await prisma.poll.findUniqueOrThrow({+ where: { id: pollId },+ include: { options: true, participants: true },+ });++ const votePatterns: Record<string, ("yes" | "no" | "ifNeedBe")[]> = {+ "Sarah Johnson": ["yes", "ifNeedBe", "yes"],+ "Michael Chen": ["yes", "yes", "no"],+ "Emily Rodriguez": ["ifNeedBe", "yes", "yes"],+ };++ for (const participant of poll.participants) {+ const votes = votePatterns[participant.name] ?? ["yes", "yes", "yes"];+ await prisma.vote.createMany({+ data: poll.options.map((option, i) => ({+ id: `screenshot-vote-${participant.id}-${option.id}`,+ optionId: option.id,+ participantId: participant.id,+ pollId: poll.id,+ type: votes[i],+ })),+ });+ }+});++test.afterAll(async () => {+ await prisma.poll.delete({ where: { id: pollId } }).catch(() => {});+});++test("poll admin", async ({ page }) => {+ await loginWithEmail(page, { email: "[email protected]" });+ await page.goto(`/poll/${pollId}`);+ await page.waitForLoadState("networkidle");+ await page.screenshot({+ path: screenshotPath("poll-admin"),+ fullPage: true,+ });+});diff --git a/packages/screenshots/package.json b/packages/screenshots/package.jsonnew file mode 100644index 000000000..f04b4052c--- /dev/null+++ b/packages/screenshots/package.json@@ -0,0 +1,16 @@+{+ "name": "@rallly/screenshots",+ "private": true,+ "scripts": {+ "capture": "playwright test"+ },+ "dependencies": {+ "@rallly/database": "workspace:*",+ "@rallly/test-helpers": "workspace:*",+ "dayjs": "^1.11.13",+ "dotenv": "^17.2.4"+ },+ "devDependencies": {+ "@playwright/test": "^1.57.0"+ }+}diff --git a/packages/screenshots/playwright.config.ts b/packages/screenshots/playwright.config.tsnew file mode 100644index 000000000..e89a4055a--- /dev/null+++ b/packages/screenshots/playwright.config.ts@@ -0,0 +1,25 @@+import { defineConfig, devices } from "@playwright/test";+import { config } from "dotenv";++config({ path: "../../.env" });++const port = process.env.PORT || 3000;+const baseURL = `http://localhost:${port}`;++export default defineConfig({+ testDir: "./capture",+ outputDir: "./test-results",+ projects: [{ name: "chromium", use: { ...devices["Desktop Chrome"] } }],+ use: {+ viewport: { width: 1440, height: 900 },+ baseURL,+ },+ webServer: {+ command: `HIDE_DEV_INDICATOR=true pnpm --filter @rallly/web exec next dev --port ${port}`,+ url: `${baseURL}/login`,+ reuseExistingServer: true,+ timeout: 30000,+ },+ retries: 0,+ workers: 1,+});diff --git a/packages/screenshots/tsconfig.json b/packages/screenshots/tsconfig.jsonnew file mode 100644index 000000000..8288dd34c--- /dev/null+++ b/packages/screenshots/tsconfig.json@@ -0,0 +1,11 @@+{+ "compilerOptions": {+ "target": "ES2022",+ "module": "ESNext",+ "moduleResolution": "bundler",+ "esModuleInterop": true,+ "strict": true,+ "skipLibCheck": true+ },+ "include": ["capture/**/*.ts", "playwright.config.ts"]+}diff --git a/packages/test-helpers/package.json b/packages/test-helpers/package.jsonnew file mode 100644index 000000000..2782bcb20--- /dev/null+++ b/packages/test-helpers/package.json@@ -0,0 +1,14 @@+{+ "name": "@rallly/test-helpers",+ "private": true,+ "exports": {+ ".": "./src/index.ts"+ },+ "dependencies": {+ "@playwright/test": "^1.57.0",+ "cheerio": "^1.0.0-rc.12"+ },+ "devDependencies": {+ "@rallly/tsconfig": "workspace:*"+ }+}diff --git a/apps/web/tests/utils.ts b/packages/test-helpers/src/email.tssimilarity index 74%rename from apps/web/tests/utils.tsrename to packages/test-helpers/src/email.tsindex 8d82da52f..58533499b 100644--- a/apps/web/tests/utils.ts+++ b/packages/test-helpers/src/email.ts@@ -1,19 +1,15 @@import { load } from "cheerio";-import { captureEmailHTML } from "./mailpit/mailpit";+import { captureEmailHTML } from "./mailpit";/*** Get the 6-digit code from the email- * @param email The email address to get the code for- * @returns 6-digit code*/-export const getCode = async (email: string) => {+export async function getCode(email: string): Promise<string> {const html = await captureEmailHTML(email);-const $ = load(html);-return $("#code").text().trim();-};+}/*** Extract the password reset link from the email HTMLdiff --git a/packages/test-helpers/src/index.ts b/packages/test-helpers/src/index.tsnew file mode 100644index 000000000..5beecb409--- /dev/null+++ b/packages/test-helpers/src/index.ts@@ -0,0 +1,14 @@+export { getCode, getPasswordResetLink } from "./email";+export { loginWithEmail } from "./login";+export {+ captureEmailHTML,+ captureOne,+ deleteAllMessages,+ getMessage,+ getMessages,+ type MailpitAttachment,+ type MailpitEmailAddress,+ type MailpitListMessagesResponse,+ type MailpitMessage,+ type MailpitMessageSummary,+} from "./mailpit";diff --git a/packages/test-helpers/src/login.ts b/packages/test-helpers/src/login.tsnew file mode 100644index 000000000..4255d6426--- /dev/null+++ b/packages/test-helpers/src/login.ts@@ -0,0 +1,25 @@+import type { Page } from "@playwright/test";++import { getCode } from "./email";++export async function loginWithEmail(+ page: Page,+ { email, password }: { email: string; password?: string },+) {+ await page.goto("/login");+ await page.getByText("Welcome").waitFor();++ await page.getByPlaceholder("[email protected]").fill(email);+ await page.getByRole("button", { name: "Continue with email" }).click();++ if (password) {+ await page.getByLabel("Password").fill(password);+ await page.getByRole("button", { name: "Login with password" }).click();+ } else {+ const code = await getCode(email);+ await page.getByRole("heading", { name: "Finish Logging In" }).waitFor();+ await page.getByPlaceholder("Enter your 6-digit code").fill(code);+ }++ await page.waitForLoadState("networkidle");+}diff --git a/apps/web/tests/mailpit/mailpit.ts b/packages/test-helpers/src/mailpit.tssimilarity index 59%rename from apps/web/tests/mailpit/mailpit.tsrename to packages/test-helpers/src/mailpit.tsindex e98aaecc0..c1a21a808 100644--- a/apps/web/tests/mailpit/mailpit.ts+++ b/packages/test-helpers/src/mailpit.ts@@ -1,6 +1,52 @@-import type { MailpitListMessagesResponse, MailpitMessage } from "./types";+export interface MailpitAttachment {+ ContentID: string;+ ContentType: string;+ FileName: string;+ PartID: string;+ Size: number;+}++export interface MailpitEmailAddress {+ Address: string;+ Name: string;+}++export interface MailpitMessageSummary {+ Attachments: number;+ Bcc: MailpitEmailAddress[];+ Cc: MailpitEmailAddress[];+ Created: string;+ From: MailpitEmailAddress;+ ID: string;+ MessageID: string;+ Read: boolean;+ ReplyTo: MailpitEmailAddress[];+ Size: number;+ Snippet: string;+ Subject: string;+ Tags: string[];+ To: MailpitEmailAddress[];+}++export interface MailpitMessage extends MailpitMessageSummary {+ HTML: string;+ Text: string;+ Inline: MailpitAttachment[];+ ReturnPath: string;+ Date: string;+}++export interface MailpitListMessagesResponse {+ messages: MailpitMessageSummary[];+ messages_count: number;+ start: number;+ tags: string[];+ total: number;+ unread: number;+}-const MAILPIT_API_URL = "http://localhost:8025/api";+const MAILPIT_API_URL =+ process.env.MAILPIT_API_URL ?? "http://localhost:8025/api";export async function getMessages(): Promise<MailpitListMessagesResponse> {const response = await fetch(`${MAILPIT_API_URL}/v1/messages`);@@ -23,8 +69,11 @@ export async function deleteAllMessages(): Promise<void> {async function markMessageAsRead(id: string): Promise<void> {await fetch(`${MAILPIT_API_URL}/v1/messages`, {+ headers: {+ "Content-Type": "application/json",+ },method: "PUT",- body: JSON.stringify({ IDs: [id], Read: true, Search: "tag:captured" }),+ body: JSON.stringify({ IDs: [id], Read: true }),});}@@ -38,7 +87,6 @@ export async function captureOne(while (Date.now() < deadline) {const { messages } = await getMessages();- // Find most recent email to this addressconst message = messages.reverse().find(@@ -51,7 +99,6 @@ export async function captureOne(return { email: fullMessage };}- // Wait a bit before trying againawait new Promise((resolve) => setTimeout(resolve, 100));}diff --git a/packages/test-helpers/tsconfig.json b/packages/test-helpers/tsconfig.jsonnew file mode 100644index 000000000..9b522dfba--- /dev/null+++ b/packages/test-helpers/tsconfig.json@@ -0,0 +1,4 @@+{+ "extends": "@rallly/tsconfig/node.json",+ "include": ["**/*.ts"]+}diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex c6cc2df47..9e7d30e62 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -455,6 +455,9 @@ importers:'@playwright/test':specifier: ^1.57.0version: 1.58.1+ '@rallly/test-helpers':+ specifier: workspace:*+ version: link:../../packages/test-helpers'@rallly/tsconfig':specifier: workspace:*version: link:../../packages/tsconfig@@ -698,6 +701,25 @@ importers:specifier: 19.2.13version: 19.2.13+ packages/screenshots:+ dependencies:+ '@rallly/database':+ specifier: workspace:*+ version: link:../database+ '@rallly/test-helpers':+ specifier: workspace:*+ version: link:../test-helpers+ dayjs:+ specifier: ^1.11.13+ version: 1.11.19+ dotenv:+ specifier: ^17.2.4+ version: 17.2.4+ devDependencies:+ '@playwright/test':+ specifier: ^1.57.0+ version: 1.58.1+packages/tailwind-config:dependencies:'@tailwindcss/postcss':@@ -719,6 +741,19 @@ importers:specifier: ^1.0.7version: 1.0.7([email protected])+ packages/test-helpers:+ dependencies:+ '@playwright/test':+ specifier: ^1.57.0+ version: 1.58.1+ cheerio:+ specifier: ^1.0.0-rc.12+ version: 1.2.0+ devDependencies:+ '@rallly/tsconfig':+ specifier: workspace:*+ version: link:../tsconfig+packages/tsconfig:devDependencies:'@tsconfig/next':