kjanat/livedash-node
1
0
Fork 0
mirror of https://github.com/kjanat/livedash-node.git synced 2026-01-16 11:32:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

change playwright ci to use pnpm

Browse Source
This commit is contained in:
Kaj Kowalski
2025-06-28 02:45:06 +02:00
parent 7f48a085bf
commit 3b135a64b5
8 changed files with 3271 additions and 5962 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.github/workflows/playwright.yml vendored
View File

@ -1,9 +1,9 @@
name: Playwright Tests name: Playwright Tests
on: on:
push: push:
branches: [main, master] branches: [ main, master ]
pull_request: pull_request:
branches: [main, master] branches: [ main, master ]
jobs: jobs:
test: test:
timeout-minutes: 60 timeout-minutes: 60
@ -14,13 +14,11 @@ jobs:
with: with:
node-version: lts/* node-version: lts/*
- name: Install dependencies - name: Install dependencies
run: npm ci run: npm install -g pnpm && pnpm install
- name: Build dashboard
run: npm run build
- name: Install Playwright Browsers - name: Install Playwright Browsers
run: npx playwright install --with-deps run: pnpm exec playwright install --with-deps
- name: Run Playwright tests - name: Run Playwright tests
run: npx playwright test run: pnpm exec playwright test
- uses: actions/upload-artifact@v4 - uses: actions/upload-artifact@v4
if: ${{ !cancelled() }} if: ${{ !cancelled() }}
with: with:

88
TODO Normal file
View File

@ -0,0 +1,88 @@
# TODO - Remaining Improvement Items
## High Priority
### Testing & Quality Assurance
- [ ] Add comprehensive test coverage for API endpoints (currently minimal)
- [ ] Implement integration tests for the data processing pipeline
- [ ] Add unit tests for validation schemas and authentication logic
- [ ] Create E2E tests for critical user flows (registration, login, dashboard)
### Error Handling & Monitoring
- [ ] Implement global error boundaries for React components
- [ ] Add structured logging with correlation IDs for request tracing
- [ ] Set up error monitoring and alerting (e.g., Sentry integration)
- [ ] Add proper error pages for 404, 500, and other HTTP status codes
### Performance Optimization
- [ ] Implement database query optimization and indexing strategy
- [ ] Add caching layer for frequently accessed data (Redis/in-memory)
- [ ] Optimize React components with proper memoization
- [ ] Implement lazy loading for dashboard components and charts
## Medium Priority
### Security Enhancements
- [ ] Add CSRF protection for state-changing operations
- [ ] Implement session timeout and refresh token mechanism
- [ ] Add API rate limiting with Redis-backed storage (replace in-memory)
- [ ] Implement role-based access control (RBAC) for different user types
- [ ] Add audit logging for sensitive operations
### Code Quality & Maintenance
- [ ] Resolve remaining ESLint warnings and type issues
- [ ] Standardize chart library usage (currently mixing Chart.js and other libraries)
- [ ] Add proper TypeScript strict mode configuration
- [ ] Implement consistent API response formats across all endpoints
### Database & Schema
- [ ] Add database connection pooling configuration
- [ ] Implement proper database migrations for production deployment
- [ ] Add data retention policies for session data
- [ ] Consider database partitioning for large-scale data
### User Experience
- [ ] Add loading states and skeleton components throughout the application
- [ ] Implement proper form validation feedback and error messages
- [ ] Add pagination for large data sets in dashboard tables
- [ ] Implement real-time notifications for processing status updates
## Low Priority
### Documentation & Development
- [ ] Add API documentation (OpenAPI/Swagger)
- [ ] Create deployment guides for different environments
- [ ] Add contributing guidelines and code review checklist
- [ ] Implement development environment setup automation
### Feature Enhancements
- [ ] Add data export functionality (CSV, PDF reports)
- [ ] Implement dashboard customization and user preferences
- [ ] Add multi-language support (i18n)
- [ ] Create admin panel for system configuration
### Infrastructure & DevOps
- [ ] Add Docker configuration for containerized deployment
- [ ] Implement CI/CD pipeline with automated testing
- [ ] Add environment-specific configuration management
- [ ] Set up monitoring and health check endpoints
### Analytics & Insights
- [ ] Add more detailed analytics and reporting features
- [ ] Implement A/B testing framework for UI improvements
- [ ] Add user behavior tracking and analytics
- [ ] Create automated report generation and scheduling
## Completed ✅
- [x] Fix duplicate MetricCard components
- [x] Add input validation schema with Zod
- [x] Strengthen password requirements (12+ chars, complexity)
- [x] Fix schema drift - create missing migrations
- [x] Add rate limiting to authentication endpoints
- [x] Update README.md to use pnpm instead of npm
## Notes
- Focus on high-priority items first, especially testing and error handling
- Security enhancements should be implemented before production deployment
- Performance optimizations can be added incrementally based on usage metrics
- Consider user feedback when prioritizing feature enhancements

16
e2e/example.spec.ts
View File

@ -1,20 +1,18 @@
import { test, expect } from "@playwright/test"; import { test, expect } from '@playwright/test';
test("has title", async ({ page }) => { test('has title', async ({ page }) => {
await page.goto("https://playwright.dev/"); await page.goto('https://playwright.dev/');
// Expect a title "to contain" a substring. // Expect a title "to contain" a substring.
await expect(page).toHaveTitle(/Playwright/); await expect(page).toHaveTitle(/Playwright/);
}); });
test("get started link", async ({ page }) => { test('get started link', async ({ page }) => {
await page.goto("https://playwright.dev/"); await page.goto('https://playwright.dev/');
// Click the get started link. // Click the get started link.
await page.getByRole("link", { name: "Get started" }).click(); await page.getByRole('link', { name: 'Get started' }).click();
// Expects page to have a heading with the name of Installation. // Expects page to have a heading with the name of Installation.
await expect( await expect(page.getByRole('heading', { name: 'Installation' })).toBeVisible();
page.getByRole("heading", { name: "Installation" })
).toBeVisible();
}); });

9
package.json
View File

@ -18,9 +18,11 @@
"prisma:push:force": "prisma db push --force-reset", "prisma:push:force": "prisma db push --force-reset",
"prisma:studio": "prisma studio", "prisma:studio": "prisma studio",
"start": "node server.mjs", "start": "node server.mjs",
"test": "vitest run", "test": "concurrently 'vitest run' 'playwright test'",
"test:watch": "vitest", "test:coverage": "concurrently \"vitest run --coverage\" \"echo 'To add playwright coverage thingy'\"",
"test:coverage": "vitest run --coverage", "test:vitest": "vitest run",
"test:vitest:watch": "vitest",
"test:vitest:coverage": "vitest run --coverage",
"lint:md": "markdownlint-cli2 \"**/*.md\" \"!.trunk/**\" \"!.venv/**\" \"!node_modules/**\"", "lint:md": "markdownlint-cli2 \"**/*.md\" \"!.trunk/**\" \"!.venv/**\" \"!node_modules/**\"",
"lint:md:fix": "markdownlint-cli2 --fix \"**/*.md\" \"!.trunk/**\" \"!.venv/**\" \"!node_modules/**\"" "lint:md:fix": "markdownlint-cli2 --fix \"**/*.md\" \"!.trunk/**\" \"!.venv/**\" \"!node_modules/**\""
}, },
@ -77,6 +79,7 @@
"@typescript-eslint/parser": "^8.35.0", "@typescript-eslint/parser": "^8.35.0",
"@vitejs/plugin-react": "^4.6.0", "@vitejs/plugin-react": "^4.6.0",
"@vitest/coverage-v8": "^3.2.4", "@vitest/coverage-v8": "^3.2.4",
"concurrently": "^9.2.0",
"eslint": "^9.30.0", "eslint": "^9.30.0",
"eslint-config-next": "^15.3.4", "eslint-config-next": "^15.3.4",
"eslint-plugin-prettier": "^5.5.1", "eslint-plugin-prettier": "^5.5.1",

34
playwright.config.ts
View File

@ -1,4 +1,4 @@
import { defineConfig, devices } from "@playwright/test"; import { defineConfig, devices } from '@playwright/test';
/** /**
* Read environment variables from file. * Read environment variables from file.
@ -6,13 +6,13 @@ import { defineConfig, devices } from "@playwright/test";
*/ */
// import dotenv from 'dotenv'; // import dotenv from 'dotenv';
// import path from 'path'; // import path from 'path';
// dotenv.config({ path: path.resolve(__dirname, '.env.development') }); // dotenv.config({ path: path.resolve(__dirname, '.env') });
/** /**
* See https://playwright.dev/docs/test-configuration. * See https://playwright.dev/docs/test-configuration.
*/ */
export default defineConfig({ export default defineConfig({
testDir: "./e2e", testDir: './e2e',
/* Run tests in files in parallel */ /* Run tests in files in parallel */
fullyParallel: true, fullyParallel: true,
/* Fail the build on CI if you accidentally left test.only in the source code. */ /* Fail the build on CI if you accidentally left test.only in the source code. */
@ -22,31 +22,31 @@ export default defineConfig({
/* Opt out of parallel tests on CI. */ /* Opt out of parallel tests on CI. */
workers: process.env.CI ? 1 : undefined, workers: process.env.CI ? 1 : undefined,
/* Reporter to use. See https://playwright.dev/docs/test-reporters */ /* Reporter to use. See https://playwright.dev/docs/test-reporters */
reporter: "html", reporter: 'html',
/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */ /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
use: { use: {
/* Base URL to use in actions like `await page.goto('/')`. */ /* Base URL to use in actions like `await page.goto('/')`. */
// baseURL: 'http://127.0.0.1:3000', // baseURL: 'http://localhost:3000',
/* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */ /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
trace: "on-first-retry", trace: 'on-first-retry',
}, },
/* Configure projects for major browsers */ /* Configure projects for major browsers */
projects: [ projects: [
{ {
name: "chromium", name: 'chromium',
use: { ...devices["Desktop Chrome"] }, use: { ...devices['Desktop Chrome'] },
}, },
{ {
name: "firefox", name: 'firefox',
use: { ...devices["Desktop Firefox"] }, use: { ...devices['Desktop Firefox'] },
}, },
{ {
name: "webkit", name: 'webkit',
use: { ...devices["Desktop Safari"] }, use: { ...devices['Desktop Safari'] },
}, },
/* Test against mobile viewports. */ /* Test against mobile viewports. */
@ -71,9 +71,9 @@ export default defineConfig({
], ],
/* Run your local dev server before starting the tests */ /* Run your local dev server before starting the tests */
webServer: { // webServer: {
command: "npm run start", // command: 'npm run start',
url: "http://127.0.0.1:3000", // url: 'http://localhost:3000',
reuseExistingServer: !process.env.CI, // reuseExistingServer: !process.env.CI,
}, // },
}); });

8658
pnpm-lock.yaml generated
View File

File diff suppressed because it is too large Load Diff

380
tests-examples/demo-todo-app.spec.ts
View File

@ -1,77 +1,75 @@
import { test, expect, type Page } from "@playwright/test"; import { test, expect, type Page } from '@playwright/test';
test.beforeEach(async ({ page }) => { test.beforeEach(async ({ page }) => {
await page.goto("https://demo.playwright.dev/todomvc"); await page.goto('https://demo.playwright.dev/todomvc');
}); });
const TODO_ITEMS = [ const TODO_ITEMS = [
"buy some cheese", 'buy some cheese',
"feed the cat", 'feed the cat',
"book a doctors appointment", 'book a doctors appointment'
] as const; ] as const;
test.describe("New Todo", () => { test.describe('New Todo', () => {
test("should allow me to add todo items", async ({ page }) => { test('should allow me to add todo items', async ({ page }) => {
// create a new todo locator // create a new todo locator
const newTodo = page.getByPlaceholder("What needs to be done?"); const newTodo = page.getByPlaceholder('What needs to be done?');
// Create 1st todo. // Create 1st todo.
await newTodo.fill(TODO_ITEMS[0]); await newTodo.fill(TODO_ITEMS[0]);
await newTodo.press("Enter"); await newTodo.press('Enter');
// Make sure the list only has one todo item. // Make sure the list only has one todo item.
await expect(page.getByTestId("todo-title")).toHaveText([TODO_ITEMS[0]]); await expect(page.getByTestId('todo-title')).toHaveText([
TODO_ITEMS[0]
]);
// Create 2nd todo. // Create 2nd todo.
await newTodo.fill(TODO_ITEMS[1]); await newTodo.fill(TODO_ITEMS[1]);
await newTodo.press("Enter"); await newTodo.press('Enter');
// Make sure the list now has two todo items. // Make sure the list now has two todo items.
await expect(page.getByTestId("todo-title")).toHaveText([ await expect(page.getByTestId('todo-title')).toHaveText([
TODO_ITEMS[0], TODO_ITEMS[0],
TODO_ITEMS[1], TODO_ITEMS[1]
]); ]);
await checkNumberOfTodosInLocalStorage(page, 2); await checkNumberOfTodosInLocalStorage(page, 2);
}); });
test("should clear text input field when an item is added", async ({ test('should clear text input field when an item is added', async ({ page }) => {
page,
}) => {
// create a new todo locator // create a new todo locator
const newTodo = page.getByPlaceholder("What needs to be done?"); const newTodo = page.getByPlaceholder('What needs to be done?');
// Create one todo item. // Create one todo item.
await newTodo.fill(TODO_ITEMS[0]); await newTodo.fill(TODO_ITEMS[0]);
await newTodo.press("Enter"); await newTodo.press('Enter');
// Check that input is empty. // Check that input is empty.
await expect(newTodo).toBeEmpty(); await expect(newTodo).toBeEmpty();
await checkNumberOfTodosInLocalStorage(page, 1); await checkNumberOfTodosInLocalStorage(page, 1);
}); });
test("should append new items to the bottom of the list", async ({ test('should append new items to the bottom of the list', async ({ page }) => {
page,
}) => {
// Create 3 items. // Create 3 items.
await createDefaultTodos(page); await createDefaultTodos(page);
// create a todo count locator // create a todo count locator
const todoCount = page.getByTestId("todo-count"); const todoCount = page.getByTestId('todo-count')
// Check test using different methods. // Check test using different methods.
await expect(page.getByText("3 items left")).toBeVisible(); await expect(page.getByText('3 items left')).toBeVisible();
await expect(todoCount).toHaveText("3 items left"); await expect(todoCount).toHaveText('3 items left');
await expect(todoCount).toContainText("3"); await expect(todoCount).toContainText('3');
await expect(todoCount).toHaveText(/3/); await expect(todoCount).toHaveText(/3/);
// Check all items in one call. // Check all items in one call.
await expect(page.getByTestId("todo-title")).toHaveText(TODO_ITEMS); await expect(page.getByTestId('todo-title')).toHaveText(TODO_ITEMS);
await checkNumberOfTodosInLocalStorage(page, 3); await checkNumberOfTodosInLocalStorage(page, 3);
}); });
}); });
test.describe("Mark all as completed", () => { test.describe('Mark all as completed', () => {
test.beforeEach(async ({ page }) => { test.beforeEach(async ({ page }) => {
await createDefaultTodos(page); await createDefaultTodos(page);
await checkNumberOfTodosInLocalStorage(page, 3); await checkNumberOfTodosInLocalStorage(page, 3);
@ -81,47 +79,39 @@ test.describe("Mark all as completed", () => {
await checkNumberOfTodosInLocalStorage(page, 3); await checkNumberOfTodosInLocalStorage(page, 3);
}); });
test("should allow me to mark all items as completed", async ({ page }) => { test('should allow me to mark all items as completed', async ({ page }) => {
// Complete all todos. // Complete all todos.
await page.getByLabel("Mark all as complete").check(); await page.getByLabel('Mark all as complete').check();
// Ensure all todos have 'completed' class. // Ensure all todos have 'completed' class.
await expect(page.getByTestId("todo-item")).toHaveClass([ await expect(page.getByTestId('todo-item')).toHaveClass(['completed', 'completed', 'completed']);
"completed",
"completed",
"completed",
]);
await checkNumberOfCompletedTodosInLocalStorage(page, 3); await checkNumberOfCompletedTodosInLocalStorage(page, 3);
}); });
test("should allow me to clear the complete state of all items", async ({ test('should allow me to clear the complete state of all items', async ({ page }) => {
page, const toggleAll = page.getByLabel('Mark all as complete');
}) => {
const toggleAll = page.getByLabel("Mark all as complete");
// Check and then immediately uncheck. // Check and then immediately uncheck.
await toggleAll.check(); await toggleAll.check();
await toggleAll.uncheck(); await toggleAll.uncheck();
// Should be no completed classes. // Should be no completed classes.
await expect(page.getByTestId("todo-item")).toHaveClass(["", "", ""]); await expect(page.getByTestId('todo-item')).toHaveClass(['', '', '']);
}); });
test("complete all checkbox should update state when items are completed / cleared", async ({ test('complete all checkbox should update state when items are completed / cleared', async ({ page }) => {
page, const toggleAll = page.getByLabel('Mark all as complete');
}) => {
const toggleAll = page.getByLabel("Mark all as complete");
await toggleAll.check(); await toggleAll.check();
await expect(toggleAll).toBeChecked(); await expect(toggleAll).toBeChecked();
await checkNumberOfCompletedTodosInLocalStorage(page, 3); await checkNumberOfCompletedTodosInLocalStorage(page, 3);
// Uncheck first todo. // Uncheck first todo.
const firstTodo = page.getByTestId("todo-item").nth(0); const firstTodo = page.getByTestId('todo-item').nth(0);
await firstTodo.getByRole("checkbox").uncheck(); await firstTodo.getByRole('checkbox').uncheck();
// Reuse toggleAll locator and make sure its not checked. // Reuse toggleAll locator and make sure its not checked.
await expect(toggleAll).not.toBeChecked(); await expect(toggleAll).not.toBeChecked();
await firstTodo.getByRole("checkbox").check(); await firstTodo.getByRole('checkbox').check();
await checkNumberOfCompletedTodosInLocalStorage(page, 3); await checkNumberOfCompletedTodosInLocalStorage(page, 3);
// Assert the toggle all is checked again. // Assert the toggle all is checked again.
@ -129,236 +119,205 @@ test.describe("Mark all as completed", () => {
}); });
}); });
test.describe("Item", () => { test.describe('Item', () => {
test("should allow me to mark items as complete", async ({ page }) => {
test('should allow me to mark items as complete', async ({ page }) => {
// create a new todo locator // create a new todo locator
const newTodo = page.getByPlaceholder("What needs to be done?"); const newTodo = page.getByPlaceholder('What needs to be done?');
// Create two items. // Create two items.
for (const item of TODO_ITEMS.slice(0, 2)) { for (const item of TODO_ITEMS.slice(0, 2)) {
await newTodo.fill(item); await newTodo.fill(item);
await newTodo.press("Enter"); await newTodo.press('Enter');
} }
// Check first item. // Check first item.
const firstTodo = page.getByTestId("todo-item").nth(0); const firstTodo = page.getByTestId('todo-item').nth(0);
await firstTodo.getByRole("checkbox").check(); await firstTodo.getByRole('checkbox').check();
await expect(firstTodo).toHaveClass("completed"); await expect(firstTodo).toHaveClass('completed');
// Check second item. // Check second item.
const secondTodo = page.getByTestId("todo-item").nth(1); const secondTodo = page.getByTestId('todo-item').nth(1);
await expect(secondTodo).not.toHaveClass("completed"); await expect(secondTodo).not.toHaveClass('completed');
await secondTodo.getByRole("checkbox").check(); await secondTodo.getByRole('checkbox').check();
// Assert completed class. // Assert completed class.
await expect(firstTodo).toHaveClass("completed"); await expect(firstTodo).toHaveClass('completed');
await expect(secondTodo).toHaveClass("completed"); await expect(secondTodo).toHaveClass('completed');
}); });
test("should allow me to un-mark items as complete", async ({ page }) => { test('should allow me to un-mark items as complete', async ({ page }) => {
// create a new todo locator // create a new todo locator
const newTodo = page.getByPlaceholder("What needs to be done?"); const newTodo = page.getByPlaceholder('What needs to be done?');
// Create two items. // Create two items.
for (const item of TODO_ITEMS.slice(0, 2)) { for (const item of TODO_ITEMS.slice(0, 2)) {
await newTodo.fill(item); await newTodo.fill(item);
await newTodo.press("Enter"); await newTodo.press('Enter');
} }
const firstTodo = page.getByTestId("todo-item").nth(0); const firstTodo = page.getByTestId('todo-item').nth(0);
const secondTodo = page.getByTestId("todo-item").nth(1); const secondTodo = page.getByTestId('todo-item').nth(1);
const firstTodoCheckbox = firstTodo.getByRole("checkbox"); const firstTodoCheckbox = firstTodo.getByRole('checkbox');
await firstTodoCheckbox.check(); await firstTodoCheckbox.check();
await expect(firstTodo).toHaveClass("completed"); await expect(firstTodo).toHaveClass('completed');
await expect(secondTodo).not.toHaveClass("completed"); await expect(secondTodo).not.toHaveClass('completed');
await checkNumberOfCompletedTodosInLocalStorage(page, 1); await checkNumberOfCompletedTodosInLocalStorage(page, 1);
await firstTodoCheckbox.uncheck(); await firstTodoCheckbox.uncheck();
await expect(firstTodo).not.toHaveClass("completed"); await expect(firstTodo).not.toHaveClass('completed');
await expect(secondTodo).not.toHaveClass("completed"); await expect(secondTodo).not.toHaveClass('completed');
await checkNumberOfCompletedTodosInLocalStorage(page, 0); await checkNumberOfCompletedTodosInLocalStorage(page, 0);
}); });
test("should allow me to edit an item", async ({ page }) => { test('should allow me to edit an item', async ({ page }) => {
await createDefaultTodos(page); await createDefaultTodos(page);
const todoItems = page.getByTestId("todo-item"); const todoItems = page.getByTestId('todo-item');
const secondTodo = todoItems.nth(1); const secondTodo = todoItems.nth(1);
await secondTodo.dblclick(); await secondTodo.dblclick();
await expect(secondTodo.getByRole("textbox", { name: "Edit" })).toHaveValue( await expect(secondTodo.getByRole('textbox', { name: 'Edit' })).toHaveValue(TODO_ITEMS[1]);
TODO_ITEMS[1] await secondTodo.getByRole('textbox', { name: 'Edit' }).fill('buy some sausages');
); await secondTodo.getByRole('textbox', { name: 'Edit' }).press('Enter');
await secondTodo
.getByRole("textbox", { name: "Edit" })
.fill("buy some sausages");
await secondTodo.getByRole("textbox", { name: "Edit" }).press("Enter");
// Explicitly assert the new text value. // Explicitly assert the new text value.
await expect(todoItems).toHaveText([ await expect(todoItems).toHaveText([
TODO_ITEMS[0], TODO_ITEMS[0],
"buy some sausages", 'buy some sausages',
TODO_ITEMS[2], TODO_ITEMS[2]
]); ]);
await checkTodosInLocalStorage(page, "buy some sausages"); await checkTodosInLocalStorage(page, 'buy some sausages');
}); });
}); });
test.describe("Editing", () => { test.describe('Editing', () => {
test.beforeEach(async ({ page }) => { test.beforeEach(async ({ page }) => {
await createDefaultTodos(page); await createDefaultTodos(page);
await checkNumberOfTodosInLocalStorage(page, 3); await checkNumberOfTodosInLocalStorage(page, 3);
}); });
test("should hide other controls when editing", async ({ page }) => { test('should hide other controls when editing', async ({ page }) => {
const todoItem = page.getByTestId("todo-item").nth(1); const todoItem = page.getByTestId('todo-item').nth(1);
await todoItem.dblclick(); await todoItem.dblclick();
await expect(todoItem.getByRole("checkbox")).not.toBeVisible(); await expect(todoItem.getByRole('checkbox')).not.toBeVisible();
await expect( await expect(todoItem.locator('label', {
todoItem.locator("label", {
hasText: TODO_ITEMS[1], hasText: TODO_ITEMS[1],
}) })).not.toBeVisible();
).not.toBeVisible();
await checkNumberOfTodosInLocalStorage(page, 3); await checkNumberOfTodosInLocalStorage(page, 3);
}); });
test("should save edits on blur", async ({ page }) => { test('should save edits on blur', async ({ page }) => {
const todoItems = page.getByTestId("todo-item"); const todoItems = page.getByTestId('todo-item');
await todoItems.nth(1).dblclick(); await todoItems.nth(1).dblclick();
await todoItems await todoItems.nth(1).getByRole('textbox', { name: 'Edit' }).fill('buy some sausages');
.nth(1) await todoItems.nth(1).getByRole('textbox', { name: 'Edit' }).dispatchEvent('blur');
.getByRole("textbox", { name: "Edit" })
.fill("buy some sausages");
await todoItems
.nth(1)
.getByRole("textbox", { name: "Edit" })
.dispatchEvent("blur");
await expect(todoItems).toHaveText([ await expect(todoItems).toHaveText([
TODO_ITEMS[0], TODO_ITEMS[0],
"buy some sausages", 'buy some sausages',
TODO_ITEMS[2], TODO_ITEMS[2],
]); ]);
await checkTodosInLocalStorage(page, "buy some sausages"); await checkTodosInLocalStorage(page, 'buy some sausages');
}); });
test("should trim entered text", async ({ page }) => { test('should trim entered text', async ({ page }) => {
const todoItems = page.getByTestId("todo-item"); const todoItems = page.getByTestId('todo-item');
await todoItems.nth(1).dblclick(); await todoItems.nth(1).dblclick();
await todoItems await todoItems.nth(1).getByRole('textbox', { name: 'Edit' }).fill(' buy some sausages ');
.nth(1) await todoItems.nth(1).getByRole('textbox', { name: 'Edit' }).press('Enter');
.getByRole("textbox", { name: "Edit" })
.fill(" buy some sausages ");
await todoItems
.nth(1)
.getByRole("textbox", { name: "Edit" })
.press("Enter");
await expect(todoItems).toHaveText([ await expect(todoItems).toHaveText([
TODO_ITEMS[0], TODO_ITEMS[0],
"buy some sausages", 'buy some sausages',
TODO_ITEMS[2], TODO_ITEMS[2],
]); ]);
await checkTodosInLocalStorage(page, "buy some sausages"); await checkTodosInLocalStorage(page, 'buy some sausages');
}); });
test("should remove the item if an empty text string was entered", async ({ test('should remove the item if an empty text string was entered', async ({ page }) => {
page, const todoItems = page.getByTestId('todo-item');
}) => {
const todoItems = page.getByTestId("todo-item");
await todoItems.nth(1).dblclick(); await todoItems.nth(1).dblclick();
await todoItems.nth(1).getByRole("textbox", { name: "Edit" }).fill(""); await todoItems.nth(1).getByRole('textbox', { name: 'Edit' }).fill('');
await todoItems await todoItems.nth(1).getByRole('textbox', { name: 'Edit' }).press('Enter');
.nth(1)
.getByRole("textbox", { name: "Edit" })
.press("Enter");
await expect(todoItems).toHaveText([TODO_ITEMS[0], TODO_ITEMS[2]]); await expect(todoItems).toHaveText([
TODO_ITEMS[0],
TODO_ITEMS[2],
]);
}); });
test("should cancel edits on escape", async ({ page }) => { test('should cancel edits on escape', async ({ page }) => {
const todoItems = page.getByTestId("todo-item"); const todoItems = page.getByTestId('todo-item');
await todoItems.nth(1).dblclick(); await todoItems.nth(1).dblclick();
await todoItems await todoItems.nth(1).getByRole('textbox', { name: 'Edit' }).fill('buy some sausages');
.nth(1) await todoItems.nth(1).getByRole('textbox', { name: 'Edit' }).press('Escape');
.getByRole("textbox", { name: "Edit" })
.fill("buy some sausages");
await todoItems
.nth(1)
.getByRole("textbox", { name: "Edit" })
.press("Escape");
await expect(todoItems).toHaveText(TODO_ITEMS); await expect(todoItems).toHaveText(TODO_ITEMS);
}); });
}); });
test.describe("Counter", () => { test.describe('Counter', () => {
test("should display the current number of todo items", async ({ page }) => { test('should display the current number of todo items', async ({ page }) => {
// create a new todo locator // create a new todo locator
const newTodo = page.getByPlaceholder("What needs to be done?"); const newTodo = page.getByPlaceholder('What needs to be done?');
// create a todo count locator // create a todo count locator
const todoCount = page.getByTestId("todo-count"); const todoCount = page.getByTestId('todo-count')
await newTodo.fill(TODO_ITEMS[0]); await newTodo.fill(TODO_ITEMS[0]);
await newTodo.press("Enter"); await newTodo.press('Enter');
await expect(todoCount).toContainText("1"); await expect(todoCount).toContainText('1');
await newTodo.fill(TODO_ITEMS[1]); await newTodo.fill(TODO_ITEMS[1]);
await newTodo.press("Enter"); await newTodo.press('Enter');
await expect(todoCount).toContainText("2"); await expect(todoCount).toContainText('2');
await checkNumberOfTodosInLocalStorage(page, 2); await checkNumberOfTodosInLocalStorage(page, 2);
}); });
}); });
test.describe("Clear completed button", () => { test.describe('Clear completed button', () => {
test.beforeEach(async ({ page }) => { test.beforeEach(async ({ page }) => {
await createDefaultTodos(page); await createDefaultTodos(page);
}); });
test("should display the correct text", async ({ page }) => { test('should display the correct text', async ({ page }) => {
await page.locator(".todo-list li .toggle").first().check(); await page.locator('.todo-list li .toggle').first().check();
await expect( await expect(page.getByRole('button', { name: 'Clear completed' })).toBeVisible();
page.getByRole("button", { name: "Clear completed" })
).toBeVisible();
}); });
test("should remove completed items when clicked", async ({ page }) => { test('should remove completed items when clicked', async ({ page }) => {
const todoItems = page.getByTestId("todo-item"); const todoItems = page.getByTestId('todo-item');
await todoItems.nth(1).getByRole("checkbox").check(); await todoItems.nth(1).getByRole('checkbox').check();
await page.getByRole("button", { name: "Clear completed" }).click(); await page.getByRole('button', { name: 'Clear completed' }).click();
await expect(todoItems).toHaveCount(2); await expect(todoItems).toHaveCount(2);
await expect(todoItems).toHaveText([TODO_ITEMS[0], TODO_ITEMS[2]]); await expect(todoItems).toHaveText([TODO_ITEMS[0], TODO_ITEMS[2]]);
}); });
test("should be hidden when there are no items that are completed", async ({ test('should be hidden when there are no items that are completed', async ({ page }) => {
page, await page.locator('.todo-list li .toggle').first().check();
}) => { await page.getByRole('button', { name: 'Clear completed' }).click();
await page.locator(".todo-list li .toggle").first().check(); await expect(page.getByRole('button', { name: 'Clear completed' })).toBeHidden();
await page.getByRole("button", { name: "Clear completed" }).click();
await expect(
page.getByRole("button", { name: "Clear completed" })
).toBeHidden();
}); });
}); });
test.describe("Persistence", () => { test.describe('Persistence', () => {
test("should persist its data", async ({ page }) => { test('should persist its data', async ({ page }) => {
// create a new todo locator // create a new todo locator
const newTodo = page.getByPlaceholder("What needs to be done?"); const newTodo = page.getByPlaceholder('What needs to be done?');
for (const item of TODO_ITEMS.slice(0, 2)) { for (const item of TODO_ITEMS.slice(0, 2)) {
await newTodo.fill(item); await newTodo.fill(item);
await newTodo.press("Enter"); await newTodo.press('Enter');
} }
const todoItems = page.getByTestId("todo-item"); const todoItems = page.getByTestId('todo-item');
const firstTodoCheck = todoItems.nth(0).getByRole("checkbox"); const firstTodoCheck = todoItems.nth(0).getByRole('checkbox');
await firstTodoCheck.check(); await firstTodoCheck.check();
await expect(todoItems).toHaveText([TODO_ITEMS[0], TODO_ITEMS[1]]); await expect(todoItems).toHaveText([TODO_ITEMS[0], TODO_ITEMS[1]]);
await expect(firstTodoCheck).toBeChecked(); await expect(firstTodoCheck).toBeChecked();
await expect(todoItems).toHaveClass(["completed", ""]); await expect(todoItems).toHaveClass(['completed', '']);
// Ensure there is 1 completed item. // Ensure there is 1 completed item.
await checkNumberOfCompletedTodosInLocalStorage(page, 1); await checkNumberOfCompletedTodosInLocalStorage(page, 1);
@ -367,11 +326,11 @@ test.describe("Persistence", () => {
await page.reload(); await page.reload();
await expect(todoItems).toHaveText([TODO_ITEMS[0], TODO_ITEMS[1]]); await expect(todoItems).toHaveText([TODO_ITEMS[0], TODO_ITEMS[1]]);
await expect(firstTodoCheck).toBeChecked(); await expect(firstTodoCheck).toBeChecked();
await expect(todoItems).toHaveClass(["completed", ""]); await expect(todoItems).toHaveClass(['completed', '']);
}); });
}); });
test.describe("Routing", () => { test.describe('Routing', () => {
test.beforeEach(async ({ page }) => { test.beforeEach(async ({ page }) => {
await createDefaultTodos(page); await createDefaultTodos(page);
// make sure the app had a chance to save updated todos in storage // make sure the app had a chance to save updated todos in storage
@ -380,33 +339,33 @@ test.describe("Routing", () => {
await checkTodosInLocalStorage(page, TODO_ITEMS[0]); await checkTodosInLocalStorage(page, TODO_ITEMS[0]);
}); });
test("should allow me to display active items", async ({ page }) => { test('should allow me to display active items', async ({ page }) => {
const todoItem = page.getByTestId("todo-item"); const todoItem = page.getByTestId('todo-item');
await page.getByTestId("todo-item").nth(1).getByRole("checkbox").check(); await page.getByTestId('todo-item').nth(1).getByRole('checkbox').check();
await checkNumberOfCompletedTodosInLocalStorage(page, 1); await checkNumberOfCompletedTodosInLocalStorage(page, 1);
await page.getByRole("link", { name: "Active" }).click(); await page.getByRole('link', { name: 'Active' }).click();
await expect(todoItem).toHaveCount(2); await expect(todoItem).toHaveCount(2);
await expect(todoItem).toHaveText([TODO_ITEMS[0], TODO_ITEMS[2]]); await expect(todoItem).toHaveText([TODO_ITEMS[0], TODO_ITEMS[2]]);
}); });
test("should respect the back button", async ({ page }) => { test('should respect the back button', async ({ page }) => {
const todoItem = page.getByTestId("todo-item"); const todoItem = page.getByTestId('todo-item');
await page.getByTestId("todo-item").nth(1).getByRole("checkbox").check(); await page.getByTestId('todo-item').nth(1).getByRole('checkbox').check();
await checkNumberOfCompletedTodosInLocalStorage(page, 1); await checkNumberOfCompletedTodosInLocalStorage(page, 1);
await test.step("Showing all items", async () => { await test.step('Showing all items', async () => {
await page.getByRole("link", { name: "All" }).click(); await page.getByRole('link', { name: 'All' }).click();
await expect(todoItem).toHaveCount(3); await expect(todoItem).toHaveCount(3);
}); });
await test.step("Showing active items", async () => { await test.step('Showing active items', async () => {
await page.getByRole("link", { name: "Active" }).click(); await page.getByRole('link', { name: 'Active' }).click();
}); });
await test.step("Showing completed items", async () => { await test.step('Showing completed items', async () => {
await page.getByRole("link", { name: "Completed" }).click(); await page.getByRole('link', { name: 'Completed' }).click();
}); });
await expect(todoItem).toHaveCount(1); await expect(todoItem).toHaveCount(1);
@ -416,74 +375,63 @@ test.describe("Routing", () => {
await expect(todoItem).toHaveCount(3); await expect(todoItem).toHaveCount(3);
}); });
test("should allow me to display completed items", async ({ page }) => { test('should allow me to display completed items', async ({ page }) => {
await page.getByTestId("todo-item").nth(1).getByRole("checkbox").check(); await page.getByTestId('todo-item').nth(1).getByRole('checkbox').check();
await checkNumberOfCompletedTodosInLocalStorage(page, 1); await checkNumberOfCompletedTodosInLocalStorage(page, 1);
await page.getByRole("link", { name: "Completed" }).click(); await page.getByRole('link', { name: 'Completed' }).click();
await expect(page.getByTestId("todo-item")).toHaveCount(1); await expect(page.getByTestId('todo-item')).toHaveCount(1);
}); });
test("should allow me to display all items", async ({ page }) => { test('should allow me to display all items', async ({ page }) => {
await page.getByTestId("todo-item").nth(1).getByRole("checkbox").check(); await page.getByTestId('todo-item').nth(1).getByRole('checkbox').check();
await checkNumberOfCompletedTodosInLocalStorage(page, 1); await checkNumberOfCompletedTodosInLocalStorage(page, 1);
await page.getByRole("link", { name: "Active" }).click(); await page.getByRole('link', { name: 'Active' }).click();
await page.getByRole("link", { name: "Completed" }).click(); await page.getByRole('link', { name: 'Completed' }).click();
await page.getByRole("link", { name: "All" }).click(); await page.getByRole('link', { name: 'All' }).click();
await expect(page.getByTestId("todo-item")).toHaveCount(3); await expect(page.getByTestId('todo-item')).toHaveCount(3);
}); });
test("should highlight the currently applied filter", async ({ page }) => { test('should highlight the currently applied filter', async ({ page }) => {
await expect(page.getByRole("link", { name: "All" })).toHaveClass( await expect(page.getByRole('link', { name: 'All' })).toHaveClass('selected');
"selected"
);
//create locators for active and completed links //create locators for active and completed links
const activeLink = page.getByRole("link", { name: "Active" }); const activeLink = page.getByRole('link', { name: 'Active' });
const completedLink = page.getByRole("link", { name: "Completed" }); const completedLink = page.getByRole('link', { name: 'Completed' });
await activeLink.click(); await activeLink.click();
// Page change - active items. // Page change - active items.
await expect(activeLink).toHaveClass("selected"); await expect(activeLink).toHaveClass('selected');
await completedLink.click(); await completedLink.click();
// Page change - completed items. // Page change - completed items.
await expect(completedLink).toHaveClass("selected"); await expect(completedLink).toHaveClass('selected');
}); });
}); });
async function createDefaultTodos(page: Page) { async function createDefaultTodos(page: Page) {
// create a new todo locator // create a new todo locator
const newTodo = page.getByPlaceholder("What needs to be done?"); const newTodo = page.getByPlaceholder('What needs to be done?');
for (const item of TODO_ITEMS) { for (const item of TODO_ITEMS) {
await newTodo.fill(item); await newTodo.fill(item);
await newTodo.press("Enter"); await newTodo.press('Enter');
} }
} }
async function checkNumberOfTodosInLocalStorage(page: Page, expected: number) { async function checkNumberOfTodosInLocalStorage(page: Page, expected: number) {
return await page.waitForFunction((e) => { return await page.waitForFunction(e => {
return JSON.parse(localStorage["react-todos"]).length === e; return JSON.parse(localStorage['react-todos']).length === e;
}, expected); }, expected);
} }
async function checkNumberOfCompletedTodosInLocalStorage( async function checkNumberOfCompletedTodosInLocalStorage(page: Page, expected: number) {
page: Page, return await page.waitForFunction(e => {
expected: number return JSON.parse(localStorage['react-todos']).filter((todo: any) => todo.completed).length === e;
) {
return await page.waitForFunction((e) => {
return (
JSON.parse(localStorage["react-todos"]).filter(
(todo: any) => todo.completed
).length === e
);
}, expected); }, expected);
} }
async function checkTodosInLocalStorage(page: Page, title: string) { async function checkTodosInLocalStorage(page: Page, title: string) {
return await page.waitForFunction((t) => { return await page.waitForFunction(t => {
return JSON.parse(localStorage["react-todos"]) return JSON.parse(localStorage['react-todos']).map((todo: any) => todo.title).includes(t);
.map((todo: any) => todo.title)
.includes(t);
}, title); }, title);
} }