Compare commits

...

9 Commits

Author SHA1 Message Date
Felipe Cardoso
444d495f83 Refactor metadata handling for improved maintainability and localization support
- Extracted server-only metadata generation logic into separate files, reducing inline logic in page components.
- Added `/* istanbul ignore file */` annotations for E2E-covered framework-level metadata.
- Standardized `generateMetadata` export patterns across auth, admin, and error pages for consistency.
- Enhanced maintainability and readability by centralizing metadata definitions for each route.
2025-11-20 10:07:15 +01:00
Felipe Cardoso
a943f79ce7 Refactor i18n routing tests with jest mocks and enhance coverage
- Replaced i18n routing tests with new mocked implementations for `next-intl/routing` and `next-intl/navigation`.
- Improved test coverage by introducing component-based tests for navigation hooks and link behavior.
- Updated assertions for clarity and consistency in locale configuration and navigation logic.
2025-11-20 09:45:29 +01:00
Felipe Cardoso
f54905abd0 Update README and documentation with i18n, feature enhancements, and SEO improvements
- Added comprehensive details for internationalization (i18n) support via `next-intl`, including locale-based routing and type-safe translations.
- Highlighted new UX features: animated marketing landing page, toasts, charts, markdown rendering, and session tracking.
- Enhanced SEO capabilities with dynamic sitemaps, robots.txt, and locale-aware metadata.
- Updated `/dev` portal information with live component playground details.
- Documented newly integrated libraries, utilities, and testing updates for better developer insight.
2025-11-20 09:45:03 +01:00
Felipe Cardoso
0105e765b3 Add tests for auth storage logic and i18n routing configuration
- Added comprehensive unit tests for `auth/storage` to handle SSR, E2E paths, storage method selection, and error handling.
- Introduced tests for `i18n/routing` to validate locale configuration, navigation hooks, and link preservation.
- Updated Jest coverage exclusions to include `
2025-11-20 09:24:15 +01:00
Felipe Cardoso
bb06b450fd Delete outdated E2E documentation and performance optimization guides.
- Removed `E2E_COVERAGE_GUIDE.md` and `E2E_PERFORMANCE_OPTIMIZATION.md` from `frontend/docs` due to redundancy and irrelevance to recent workflows.
- Cleared unused scripts (`convert-v8-to-istanbul.ts` and `merge-coverage.ts`) from `frontend/scripts`.
2025-11-19 14:56:24 +01:00
Felipe Cardoso
c1d6a04276 Document AI assistant guidance and improve developer workflows
- Added and updated `CLAUDE.md` to provide comprehensive guidance for integrating Claude Code into project workflows.
- Created `AGENTS.md` for general AI assistant context, including architecture, workflows, and tooling specifics.
- Updated `README.md` with references to AI-focused documentation for better discoverability.
- Simplified instructions and refined file organization to enhance usability for developers and AI assistants.
2025-11-19 14:45:29 +01:00
Felipe Cardoso
d7b333385d Add test cases for session revocation and update test coverage annotations
- Introduced unit tests for individual and bulk session revocation in `SessionsManager` with success callback assertions.
- Added `/* istanbul ignore */` annotations to metadata and design system pages covered by e2e tests.
2025-11-19 14:38:46 +01:00
Felipe Cardoso
f02320e57c Add tests for LocaleSwitcher component and update metadata generation
- Introduced unit tests for `LocaleSwitcher` to cover rendering, UX, accessibility, and locale switching logic.
- Updated `generateMetadata` function with `/* istanbul ignore next */` annotation for coverage clarity.
2025-11-19 14:27:03 +01:00
Felipe Cardoso
3ec589293c Add tests for i18n metadata utilities and improve locale-based metadata generation
- Introduced comprehensive unit tests for `generateLocalizedMetadata` and `generatePageMetadata` utilities.
- Enhanced `siteConfig` validation assertions for structure and localization support.
- Updated metadata generation to handle empty paths, canonical URLs, language alternates, and Open Graph data consistently.
- Annotated server-side middleware with istanbul ignore for coverage clarity.
2025-11-19 14:23:06 +01:00
49 changed files with 1526 additions and 12936 deletions

256
AGENTS.md Normal file
View File

@@ -0,0 +1,256 @@
# AGENTS.md
AI coding assistant context for FastAPI + Next.js Full-Stack Template.
## Quick Start
```bash
# Backend (Python with uv)
cd backend
make install-dev # Install dependencies
make test # Run tests
uv run uvicorn app.main:app --reload # Start dev server
# Frontend (Node.js)
cd frontend
npm install # Install dependencies
npm run dev # Start dev server
npm run generate:api # Generate API client from OpenAPI
npm run test:e2e # Run E2E tests
```
**Access points:**
- Frontend: **http://localhost:3000**
- Backend API: **http://localhost:8000**
- API Docs: **http://localhost:8000/docs**
Default superuser (change in production):
- Email: `admin@example.com`
- Password: `admin123`
## Project Architecture
**Full-stack TypeScript/Python application:**
```
├── backend/ # FastAPI backend
│ ├── app/
│ │ ├── api/ # API routes (auth, users, organizations, admin)
│ │ ├── core/ # Core functionality (auth, config, database)
│ │ ├── crud/ # Database CRUD operations
│ │ ├── models/ # SQLAlchemy ORM models
│ │ ├── schemas/ # Pydantic request/response schemas
│ │ ├── services/ # Business logic layer
│ │ └── utils/ # Utilities (security, device detection)
│ ├── tests/ # 97% coverage, 743 tests
│ └── alembic/ # Database migrations
└── frontend/ # Next.js 15 frontend
├── src/
│ ├── app/ # App Router pages (Next.js 15)
│ ├── components/ # React components
│ ├── lib/
│ │ ├── api/ # Auto-generated API client
│ │ └── stores/ # Zustand state management
│ └── hooks/ # Custom React hooks
└── e2e/ # Playwright E2E tests (56 passing)
```
## Critical Implementation Notes
### Authentication Flow
- **JWT-based**: Access tokens (15 min) + refresh tokens (7 days)
- **Session tracking**: Database-backed with device info, IP, user agent
- **Token refresh**: Validates JTI in database, not just JWT signature
- **Authorization**: FastAPI dependencies in `api/dependencies/auth.py`
- `get_current_user`: Requires valid access token
- `get_current_active_user`: Requires active account
- `get_optional_current_user`: Accepts authenticated or anonymous
- `get_current_superuser`: Requires superuser flag
### Database Pattern
- **Async SQLAlchemy 2.0** with PostgreSQL
- **Connection pooling**: 20 base connections, 50 max overflow
- **CRUD base class**: `crud/base.py` with common operations
- **Migrations**: Alembic with helper script `migrate.py`
- `python migrate.py auto "message"` - Generate and apply
- `python migrate.py list` - View history
### Frontend State Management
- **Zustand stores**: Lightweight state management
- **TanStack Query**: API data fetching/caching
- **Auto-generated client**: From OpenAPI spec via `npm run generate:api`
- **Dependency Injection**: ALWAYS use `useAuth()` from `AuthContext`, NEVER import `useAuthStore` directly
### Internationalization (i18n)
- **next-intl v4**: Type-safe internationalization library
- **Locale routing**: `/en/*`, `/it/*` (English and Italian supported)
- **Translation files**: `frontend/messages/en.json`, `frontend/messages/it.json`
- **LocaleSwitcher**: Component for seamless language switching
- **SEO-friendly**: Locale-aware metadata, sitemaps, and robots.txt
- **Type safety**: Full TypeScript support for translations
- **Utilities**: `frontend/src/lib/i18n/` (metadata, routing, utils)
### Organization System
Three-tier RBAC:
- **Owner**: Full control (delete org, manage all members)
- **Admin**: Add/remove members, assign admin role (not owner)
- **Member**: Read-only organization access
Permission dependencies in `api/dependencies/permissions.py`:
- `require_organization_owner`
- `require_organization_admin`
- `require_organization_member`
- `can_manage_organization_member`
### Testing Infrastructure
**Backend (pytest):**
- 97% coverage, 743 tests
- Security-focused: JWT attacks, session hijacking, privilege escalation
- Async fixtures in `tests/conftest.py`
- Run: `IS_TEST=True uv run pytest`
- Coverage: `IS_TEST=True uv run pytest --cov=app --cov-report=term-missing`
**Frontend Unit Tests (Jest):**
- 97% coverage
- Component, hook, and utility testing
- Run: `npm test`
- Coverage: `npm run test:coverage`
**E2E Tests (Playwright):**
- 56 passing, 1 skipped (zero flaky tests)
- Complete user flows (auth, navigation, settings)
- Run: `npm run test:e2e`
- UI mode: `npm run test:e2e:ui`
### Development Tooling
**Backend:**
- **uv**: Modern Python package manager (10-100x faster than pip)
- **Ruff**: All-in-one linting/formatting (replaces Black, Flake8, isort)
- **mypy**: Type checking with Pydantic plugin
- **Makefile**: `make help` for all commands
**Frontend:**
- **Next.js 15**: App Router with React 19
- **TypeScript**: Full type safety
- **TailwindCSS + shadcn/ui**: Design system
- **ESLint + Prettier**: Code quality
### Environment Configuration
**Backend** (`.env`):
```bash
POSTGRES_USER=postgres
POSTGRES_PASSWORD=your_password
POSTGRES_HOST=db
POSTGRES_PORT=5432
POSTGRES_DB=app
SECRET_KEY=your-secret-key-min-32-chars
ENVIRONMENT=development|production
CSP_MODE=relaxed|strict|disabled
FIRST_SUPERUSER_EMAIL=admin@example.com
FIRST_SUPERUSER_PASSWORD=admin123
BACKEND_CORS_ORIGINS=["http://localhost:3000"]
```
**Frontend** (`.env.local`):
```bash
NEXT_PUBLIC_API_URL=http://localhost:8000/api/v1
```
## Common Development Workflows
### Adding a New API Endpoint
1. **Define schema** in `backend/app/schemas/`
2. **Create CRUD operations** in `backend/app/crud/`
3. **Implement route** in `backend/app/api/routes/`
4. **Register router** in `backend/app/api/main.py`
5. **Write tests** in `backend/tests/api/`
6. **Generate frontend client**: `npm run generate:api`
### Database Migrations
```bash
cd backend
python migrate.py generate "description" # Create migration
python migrate.py apply # Apply migrations
python migrate.py auto "description" # Generate + apply
```
### Frontend Component Development
1. **Create component** in `frontend/src/components/`
2. **Follow design system** (see `frontend/docs/design-system/`)
3. **Use dependency injection** for auth (`useAuth()` not `useAuthStore`)
4. **Write tests** in `frontend/tests/` or `__tests__/`
5. **Run type check**: `npm run type-check`
## Security Features
- **Password hashing**: bcrypt with salt rounds
- **Rate limiting**: 60 req/min default, 10 req/min on auth endpoints
- **Security headers**: CSP, X-Frame-Options, HSTS, etc.
- **CSRF protection**: Built into FastAPI
- **Session revocation**: Database-backed session tracking
- **Comprehensive security tests**: JWT algorithm attacks, session hijacking, privilege escalation
## Docker Deployment
```bash
# Development (with hot reload)
docker-compose -f docker-compose.dev.yml up
# Production
docker-compose up -d
# Run migrations
docker-compose exec backend alembic upgrade head
# Create first superuser
docker-compose exec backend python -c "from app.init_db import init_db; import asyncio; asyncio.run(init_db())"
```
## Documentation
**For comprehensive documentation, see:**
- **[README.md](./README.md)** - User-facing project overview
- **[CLAUDE.md](./CLAUDE.md)** - Claude Code-specific guidance
- **Backend docs**: `backend/docs/` (Architecture, Coding Standards, Common Pitfalls, Feature Examples)
- **Frontend docs**: `frontend/docs/` (Design System, Architecture, E2E Testing)
- **API docs**: http://localhost:8000/docs (Swagger UI when running)
## Current Status (Nov 2025)
### Completed Features ✅
- Authentication system (JWT with refresh tokens)
- Session management (device tracking, revocation)
- User management (CRUD, password change)
- Organization system (multi-tenant with RBAC)
- Admin panel (user/org management, bulk operations)
- **Internationalization (i18n)** with English and Italian
- Comprehensive test coverage (97% backend, 97% frontend unit, 56 E2E tests)
- Design system documentation
- **Marketing landing page** with animations
- **`/dev` documentation portal** with live examples
- **Toast notifications**, charts, markdown rendering
- **SEO optimization** (sitemap, robots.txt, locale metadata)
- Docker deployment
### In Progress 🚧
- Frontend admin pages (70% complete)
- Email integration (templates ready, SMTP pending)
### Planned 🔮
- GitHub Actions CI/CD
- Additional languages (Spanish, French, German, etc.)
- Additional authentication methods (OAuth, SSO)
- Real-time notifications (WebSockets)
- Webhook system
- Background job processing
- File upload/storage

754
CLAUDE.md
View File

@@ -1,10 +1,14 @@
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
Claude Code context for FastAPI + Next.js Full-Stack Template.
## Critical User Preferences
**See [AGENTS.md](./AGENTS.md) for project context, architecture, and development commands.**
### File Operations - NEVER Use Heredoc/Cat Append
## Claude Code-Specific Guidance
### Critical User Preferences
#### File Operations - NEVER Use Heredoc/Cat Append
**ALWAYS use Read/Write/Edit tools instead of `cat >> file << EOF` commands.**
This triggers manual approval dialogs and disrupts workflow.
@@ -18,215 +22,37 @@ EOF
# CORRECT ✅ - Use Read, then Write tools
```
### Work Style
#### Work Style
- User prefers autonomous operation without frequent interruptions
- Ask for batch permissions upfront for long work sessions
- Work independently, document decisions clearly
- Only use emojis if the user explicitly requests it
## Project Architecture
### When Working with This Stack
This is a **FastAPI + Next.js full-stack application** with the following structure:
**Dependency Management:**
- Backend uses **uv** (modern Python package manager), not pip
- Always use `uv run` prefix: `IS_TEST=True uv run pytest`
- Or use Makefile commands: `make test`, `make install-dev`
- Add dependencies: `uv add <package>` or `uv add --dev <package>`
### Backend (FastAPI)
```
backend/app/
├── api/ # API routes organized by version
│ ├── routes/ # Endpoint implementations (auth, users, sessions, admin, organizations)
│ └── dependencies/ # FastAPI dependencies (auth, permissions)
├── core/ # Core functionality
│ ├── config.py # Settings (Pydantic BaseSettings)
│ ├── database.py # SQLAlchemy async engine setup
│ ├── auth.py # JWT token generation/validation
│ └── exceptions.py # Custom exception classes and handlers
├── crud/ # Database CRUD operations (base, user, session, organization)
├── models/ # SQLAlchemy ORM models
├── schemas/ # Pydantic request/response schemas
├── services/ # Business logic layer (auth_service)
└── utils/ # Utilities (security, device detection, test helpers)
```
**Database Migrations:**
- Use the `migrate.py` helper script, not Alembic directly
- Generate + apply: `python migrate.py auto "message"`
- Never commit migrations without testing them first
- Check current state: `python migrate.py current`
### Frontend (Next.js 15)
```
frontend/src/
├── app/ # Next.js App Router pages
├── components/ # React components (auth/, ui/)
├── lib/
│ ├── api/ # API client (auto-generated from OpenAPI)
│ ├── stores/ # Zustand state management
│ └── utils/ # Utility functions
└── hooks/ # Custom React hooks
```
**Frontend API Client Generation:**
- Run `npm run generate:api` after backend schema changes
- Client is auto-generated from OpenAPI spec
- Located in `frontend/src/lib/api/generated/`
- NEVER manually edit generated files
## Development Commands
### Backend
#### Setup
**Dependencies are managed with [uv](https://docs.astral.sh/uv/) - the modern, fast Python package manager.**
```bash
cd backend
# Install uv (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh
# Install all dependencies (production + dev) from uv.lock
uv sync --extra dev
# Or use the Makefile
make install-dev
```
**Why uv?**
- 🚀 10-100x faster than pip
- 🔒 Reproducible builds with `uv.lock`
- 📦 Modern dependency resolution
- ⚡ Built by Astral (creators of Ruff)
#### Database Migrations
```bash
# Using the migration helper (preferred)
python migrate.py generate "migration message" # Generate migration
python migrate.py apply # Apply migrations
python migrate.py auto "message" # Generate and apply in one step
python migrate.py list # List all migrations
python migrate.py current # Show current revision
python migrate.py check # Check DB connection
# Or using Alembic directly
alembic revision --autogenerate -m "message"
alembic upgrade head
```
#### Testing
**Test Coverage: High (comprehensive test suite)**
- Security-focused testing with JWT algorithm attack prevention (CVE-2015-9235)
- Session hijacking and privilege escalation tests included
- Missing lines justified as defensive code, error handlers, and production-only code
```bash
# Run all tests (uses pytest-xdist for parallel execution)
make test
# Run with coverage report
make test-cov
# Or run directly with uv
IS_TEST=True uv run pytest
# Run specific test file
IS_TEST=True uv run pytest tests/api/test_auth.py -v
# Run single test
IS_TEST=True uv run pytest tests/api/test_auth.py::TestLogin::test_login_success -v
```
**Available Make Commands:**
```bash
make help # Show all available commands
make install-dev # Install all dependencies
make validate # Run lint + format + type checks
make test # Run tests
make test-cov # Run tests with coverage
```
#### Running Locally
```bash
cd backend
uv run uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
```
### Frontend
#### Setup
```bash
cd frontend
npm install
```
#### Development
```bash
npm run dev # Start dev server on http://localhost:3000
npm run build # Production build
npm run lint # ESLint
npm run type-check # TypeScript checking
```
#### Testing
```bash
# Unit tests (Jest)
npm test # Run all unit tests
npm run test:watch # Watch mode
npm run test:coverage # With coverage
# E2E tests (Playwright)
npm run test:e2e # Run all E2E tests
npm run test:e2e:ui # Open Playwright UI
npm run test:e2e:debug # Debug mode
npx playwright test auth-login.spec.ts # Run specific file
```
**E2E Test Best Practices:**
- Use `Promise.all()` pattern for Next.js Link navigation:
```typescript
await Promise.all([
page.waitForURL('/target', { timeout: 10000 }),
link.click()
]);
```
- Use ID-based selectors for validation errors (e.g., `#email-error`)
- Error IDs use dashes not underscores (`#new-password-error`)
- Target `.border-destructive[role="alert"]` to avoid Next.js route announcer conflicts
- Uses 12 workers in non-CI mode (`workers: 12` in `playwright.config.ts`)
- URL assertions should use regex to handle query params: `/\/auth\/login/`
### Docker
```bash
# Development (with hot reload)
docker-compose -f docker-compose.dev.yml up
# Production
docker-compose up -d
# Rebuild specific service
docker-compose build backend
docker-compose build frontend
```
## Key Architectural Patterns
### Authentication Flow
1. **Login**: `POST /api/v1/auth/login` returns access + refresh tokens
- Access token: 15 minutes expiry (JWT)
- Refresh token: 7 days expiry (JWT with JTI stored in DB)
- Session tracking with device info (IP, user agent, device ID)
2. **Token Refresh**: `POST /api/v1/auth/refresh` validates refresh token JTI
- Checks session is active in database
- Issues new access token (refresh token remains valid)
- Updates session `last_used_at`
3. **Authorization**: FastAPI dependencies in `api/dependencies/auth.py`
- `get_current_user`: Validates access token, returns User (raises 401 if invalid)
- `get_current_active_user`: Requires valid access token + active account
- `get_optional_current_user`: Accepts both authenticated and anonymous users (returns User or None)
- `get_current_superuser`: Requires superuser flag
### Database Pattern: Async SQLAlchemy
- **Engine**: Created in `core/database.py` with connection pooling
- **Sessions**: AsyncSession from `async_sessionmaker`
- **CRUD**: Base class in `crud/base.py` with common operations
- Inherits: `CRUDUser`, `CRUDSession`, `CRUDOrganization`
- Pattern: `async def get(db: AsyncSession, id: str) -> Model | None`
### Frontend State Management
- **Zustand stores**: `lib/stores/` (authStore, etc.)
- **TanStack Query**: API data fetching/caching
- **Auto-generated client**: `lib/api/generated/` from OpenAPI spec
- Generate with: `npm run generate:api` (runs `scripts/generate-api-client.sh`)
**Testing Commands:**
- Backend: `IS_TEST=True uv run pytest` (always prefix with `IS_TEST=True`)
- Frontend unit: `npm test`
- Frontend E2E: `npm run test:e2e`
- Use `make test` or `make test-cov` in backend for convenience
### 🔴 CRITICAL: Auth Store Dependency Injection Pattern
@@ -254,41 +80,54 @@ const { user, isAuthenticated } = useAuth();
**See**: `frontend/docs/ARCHITECTURE_FIX_REPORT.md` for full details.
### Session Management Architecture
**Database-backed session tracking** (not just JWT):
- Each refresh token has a corresponding `UserSession` record
- Tracks: device info, IP, location, last used timestamp
- Supports session revocation (logout from specific devices)
- Cleanup job removes expired sessions
### E2E Test Best Practices
### Permission System
Three-tier organization roles:
- **Owner**: Full control (delete org, manage all members)
- **Admin**: Can add/remove members, assign admin role (not owner)
- **Member**: Read-only organization access
When writing or fixing Playwright tests:
Dependencies in `api/dependencies/permissions.py`:
- `require_organization_owner`
- `require_organization_admin`
- `require_organization_member`
- `can_manage_organization_member` (owner or admin, but not self-demotion)
**Navigation Pattern:**
```typescript
// ✅ CORRECT - Use Promise.all for Next.js Link clicks
await Promise.all([
page.waitForURL('/target', { timeout: 10000 }),
link.click()
]);
```
## Testing Infrastructure
**Selectors:**
- Use ID-based selectors for validation errors: `#email-error`
- Error IDs use dashes not underscores: `#new-password-error`
- Target `.border-destructive[role="alert"]` to avoid Next.js route announcer conflicts
- Avoid generic `[role="alert"]` which matches multiple elements
### Backend Test Patterns
**URL Assertions:**
```typescript
// ✅ Use regex to handle query params
await expect(page).toHaveURL(/\/auth\/login/);
**Fixtures** (in `tests/conftest.py`):
- `async_test_db`: Fresh SQLite in-memory database per test
- `client`: AsyncClient with test database override
- `async_test_user`: Pre-created regular user
- `async_test_superuser`: Pre-created superuser
- `user_token` / `superuser_token`: Access tokens for API calls
// ❌ Don't use exact strings (fails with query params)
await expect(page).toHaveURL('/auth/login');
```
**Database Mocking for Exception Testing**:
**Configuration:**
- Uses 12 workers in non-CI mode (`playwright.config.ts`)
- Reduces to 2 workers in CI for stability
- Tests are designed to be non-flaky with proper waits
### Important Implementation Details
**Authentication Testing:**
- Backend fixtures in `tests/conftest.py`:
- `async_test_db`: Fresh SQLite per test
- `async_test_user` / `async_test_superuser`: Pre-created users
- `user_token` / `superuser_token`: Access tokens for API calls
- Always use `@pytest.mark.asyncio` for async tests
- Use `@pytest_asyncio.fixture` for async fixtures
**Database Testing:**
```python
# Mock database exceptions correctly
from unittest.mock import patch, AsyncMock
# Mock database commit to raise exception
async def mock_commit():
raise OperationalError("Connection lost", {}, Exception())
@@ -299,376 +138,85 @@ with patch.object(session, 'commit', side_effect=mock_commit):
mock_rollback.assert_called_once()
```
**Testing Routes**:
```python
@pytest.mark.asyncio
async def test_endpoint(client, user_token):
response = await client.get(
"/api/v1/endpoint",
headers={"Authorization": f"Bearer {user_token}"}
)
assert response.status_code == 200
```
**IMPORTANT**: Use `@pytest_asyncio.fixture` for async fixtures, not `@pytest.fixture`
### Frontend Test Patterns
**Unit Tests (Jest)**:
```typescript
// SSR-safe mocking
jest.mock('@/lib/stores/authStore', () => ({
useAuthStore: jest.fn()
}));
beforeEach(() => {
(useAuthStore as jest.Mock).mockReturnValue({
user: mockUser,
login: mockLogin
});
});
```
**E2E Tests (Playwright)**:
```typescript
test('navigation', async ({ page }) => {
await page.goto('/');
const link = page.getByRole('link', { name: 'Login' });
await Promise.all([
page.waitForURL(/\/auth\/login/, { timeout: 10000 }),
link.click()
]);
await expect(page).toHaveURL(/\/auth\/login/);
});
```
## Configuration
### Environment Variables
**Backend** (`.env`):
```bash
# Database
POSTGRES_USER=postgres
POSTGRES_PASSWORD=your_password
POSTGRES_HOST=db
POSTGRES_PORT=5432
POSTGRES_DB=app
# Security
SECRET_KEY=your-secret-key-min-32-chars
ENVIRONMENT=development|production
CSP_MODE=relaxed|strict|disabled
# First Superuser (auto-created on init)
FIRST_SUPERUSER_EMAIL=admin@example.com
FIRST_SUPERUSER_PASSWORD=admin123
# CORS
BACKEND_CORS_ORIGINS=["http://localhost:3000"]
```
**Frontend** (`.env.local`):
```bash
NEXT_PUBLIC_API_URL=http://localhost:8000/api/v1
```
### Database Connection Pooling
Configured in `core/config.py`:
- `db_pool_size`: 20 (default connections)
- `db_max_overflow`: 50 (max overflow)
- `db_pool_timeout`: 30 seconds
- `db_pool_recycle`: 3600 seconds (recycle after 1 hour)
### Security Headers
Automatically applied via middleware in `main.py`:
- `X-Frame-Options: DENY`
- `X-Content-Type-Options: nosniff`
- `X-XSS-Protection: 1; mode=block`
- `Strict-Transport-Security` (production only)
- Content-Security-Policy (configurable via `CSP_MODE`)
### Rate Limiting
- Implemented with `slowapi`
- Default: 60 requests/minute per IP
- Applied to auth endpoints (login, register, password reset)
- Override in route decorators: `@limiter.limit("10/minute")`
## Common Workflows
### Adding a New API Endpoint
1. **Create schema** (`backend/app/schemas/`):
```python
class ItemCreate(BaseModel):
name: str
description: Optional[str] = None
class ItemResponse(BaseModel):
id: UUID
name: str
created_at: datetime
```
2. **Create CRUD operations** (`backend/app/crud/`):
```python
class CRUDItem(CRUDBase[Item, ItemCreate, ItemUpdate]):
async def get_by_name(self, db: AsyncSession, name: str) -> Item | None:
result = await db.execute(select(Item).where(Item.name == name))
return result.scalar_one_or_none()
item = CRUDItem(Item)
```
3. **Create route** (`backend/app/api/routes/items.py`):
```python
from app.api.dependencies.auth import get_current_user
@router.post("/", response_model=ItemResponse)
async def create_item(
item_in: ItemCreate,
current_user: User = Depends(get_current_user),
db: AsyncSession = Depends(get_db)
):
item = await item_crud.create(db, obj_in=item_in)
return item
```
4. **Register router** (`backend/app/api/main.py`):
```python
from app.api.routes import items
api_router.include_router(items.router, prefix="/items", tags=["Items"])
```
5. **Write tests** (`backend/tests/api/test_items.py`):
```python
@pytest.mark.asyncio
async def test_create_item(client, user_token):
response = await client.post(
"/api/v1/items",
headers={"Authorization": f"Bearer {user_token}"},
json={"name": "Test Item"}
)
assert response.status_code == 201
```
6. **Generate frontend client**:
```bash
cd frontend
npm run generate:api
```
### Adding a New React Component
1. **Create component** (`frontend/src/components/`):
```typescript
export function MyComponent() {
const { user } = useAuthStore();
return <div>Hello {user?.firstName}</div>;
}
```
2. **Add tests** (`frontend/src/components/__tests__/`):
```typescript
import { render, screen } from '@testing-library/react';
test('renders component', () => {
render(<MyComponent />);
expect(screen.getByText(/Hello/)).toBeInTheDocument();
});
```
3. **Add to page** (`frontend/src/app/page.tsx`):
```typescript
import { MyComponent } from '@/components/MyComponent';
export default function Page() {
return <MyComponent />;
}
```
## Development Tooling Stack
**State-of-the-art Python tooling (Nov 2025):**
### Dependency Management: uv
- **Fast**: 10-100x faster than pip
- **Reliable**: Reproducible builds with `uv.lock` lockfile
- **Modern**: Built by Astral (Ruff creators) in Rust
- **Commands**:
- `make install-dev` - Install all dependencies
- `make sync` - Sync from lockfile
- `uv add <package>` - Add new dependency
- `uv add --dev <package>` - Add dev dependency
### Code Quality: Ruff + mypy
- **Ruff**: All-in-one linting, formatting, and import sorting
- Replaces: Black, Flake8, isort
- **10-100x faster** than alternatives
- `make lint`, `make format`, `make validate`
- **mypy**: Type checking with Pydantic plugin
- Gradual typing approach
- Strategic per-module configurations
### Configuration: pyproject.toml
- Single source of truth for all tools
- Dependencies defined in `[project.dependencies]`
- Dev dependencies in `[project.optional-dependencies]`
- Tool configs: Ruff, mypy, pytest, coverage
## Current Project Status (Nov 2025)
### Completed Features
- ✅ Authentication system (JWT with refresh tokens)
- ✅ Session management (device tracking, revocation)
- ✅ User management (CRUD, password change)
- ✅ Organization system (multi-tenant with roles)
- ✅ Admin panel (user/org management, bulk operations)
- ✅ E2E test suite (56 passing, 1 skipped, zero flaky tests)
### Test Coverage
- **Backend**: 97% overall (743 tests, all passing) ✅
- Comprehensive security testing (JWT attacks, session hijacking, privilege escalation)
- User CRUD: 100% ✅
- Session CRUD: 100% ✅
- Auth routes: 99% ✅
- Organization routes: 100% ✅
- Permissions: 100% ✅
- 84 missing lines justified (defensive code, error handlers, production-only code)
- **Frontend E2E**: 56 passing, 1 skipped across 7 files ✅
- auth-login.spec.ts (19 tests)
- auth-register.spec.ts (14 tests)
- auth-password-reset.spec.ts (10 tests)
- navigation.spec.ts (10 tests)
- settings-password.spec.ts (3 tests)
- settings-profile.spec.ts (2 tests)
- settings-navigation.spec.ts (5 tests)
- settings-sessions.spec.ts (1 skipped - route not yet implemented)
## Email Service Integration
The project includes a **placeholder email service** (`backend/app/services/email_service.py`) designed for easy integration with production email providers.
### Current Implementation
**Console Backend (Default)**:
- Logs email content to console/logs instead of sending
- Safe for development and testing
- No external dependencies required
### Production Integration
To enable email functionality, implement one of these approaches:
**Option 1: SMTP Integration** (Recommended for most use cases)
```python
# In app/services/email_service.py, complete the SMTPEmailBackend implementation
from aiosmtplib import SMTP
from email.mime.text import MIMEText
from email.mime.multipart import MIMEMultipart
# Add environment variables to .env:
# SMTP_HOST=smtp.gmail.com
# SMTP_PORT=587
# SMTP_USERNAME=your-email@gmail.com
# SMTP_PASSWORD=your-app-password
```
**Option 2: Third-Party Service** (SendGrid, AWS SES, Mailgun, etc.)
```python
# Create a new backend class, e.g., SendGridEmailBackend
class SendGridEmailBackend(EmailBackend):
def __init__(self, api_key: str):
self.api_key = api_key
self.client = sendgrid.SendGridAPIClient(api_key)
async def send_email(self, to, subject, html_content, text_content=None):
# Implement SendGrid sending logic
pass
# Update global instance in email_service.py:
# email_service = EmailService(SendGridEmailBackend(settings.SENDGRID_API_KEY))
```
**Option 3: External Microservice**
- Use a dedicated email microservice via HTTP API
- Implement `HTTPEmailBackend` that makes async HTTP requests
### Email Templates Included
The service includes pre-built templates for:
- **Password Reset**: `send_password_reset_email()` - 1 hour expiry
- **Email Verification**: `send_email_verification()` - 24 hour expiry
Both include responsive HTML and plain text versions.
### Integration Points
Email sending is called from:
- `app/api/routes/auth.py` - Password reset flow (placeholder comments)
- Registration flow - Ready for email verification integration
**Note**: Current auth routes have placeholder comments where email functionality should be integrated. Search for "TODO: Send email" in the codebase.
## API Documentation
Once backend is running:
- **Swagger UI**: http://localhost:8000/docs
- **ReDoc**: http://localhost:8000/redoc
- **OpenAPI JSON**: http://localhost:8000/api/v1/openapi.json
## Troubleshooting
### Tests failing with "Module was never imported"
Run with single process: `pytest -n 0`
### Coverage not improving despite new tests
- Verify tests actually execute endpoints (check response.status_code)
- Generate HTML coverage: `pytest --cov=app --cov-report=html -n 0`
- Check for dependency override issues in test fixtures
### Frontend type errors
```bash
npm run type-check # Check all types
npx tsc --noEmit # Same but shorter
```
### E2E tests flaking
- Check worker count (should be 4, not 16+)
- Use `Promise.all()` for navigation
- Use regex for URL assertions
- Target specific selectors (avoid generic `[role="alert"]`)
### Database migration conflicts
```bash
python migrate.py list # Check migration history
alembic downgrade -1 # Downgrade one revision
alembic upgrade head # Re-apply
```
## Additional Documentation
### Backend Documentation
- `backend/docs/ARCHITECTURE.md`: System architecture and design patterns
- `backend/docs/CODING_STANDARDS.md`: Code quality standards and best practices
- `backend/docs/COMMON_PITFALLS.md`: Common mistakes and how to avoid them
- `backend/docs/FEATURE_EXAMPLE.md`: Step-by-step feature implementation guide
### Frontend Documentation
- **`frontend/docs/ARCHITECTURE_FIX_REPORT.md`**: ⭐ Critical DI pattern fixes (READ THIS!)
- `frontend/e2e/README.md`: E2E testing setup and guidelines
- **`frontend/docs/design-system/`**: Comprehensive design system documentation
- `README.md`: Hub with learning paths (start here)
- `00-quick-start.md`: 5-minute crash course
- `01-foundations.md`: Colors (OKLCH), typography, spacing, shadows
- `02-components.md`: shadcn/ui component library guide
- `03-layouts.md`: Layout patterns (Grid vs Flex decision trees)
- `04-spacing-philosophy.md`: Parent-controlled spacing strategy
- `05-component-creation.md`: When to create vs compose components
- `06-forms.md`: Form patterns with react-hook-form + Zod
- `07-accessibility.md`: WCAG AA compliance, keyboard navigation, screen readers
- `08-ai-guidelines.md`: **AI code generation rules (read this!)**
- `99-reference.md`: Quick reference cheat sheet (bookmark this)
**Frontend Component Development:**
- Follow design system docs in `frontend/docs/design-system/`
- Read `08-ai-guidelines.md` for AI code generation rules
- Use parent-controlled spacing (see `04-spacing-philosophy.md`)
- WCAG AA compliance required (see `07-accessibility.md`)
**Security Considerations:**
- Backend has comprehensive security tests (JWT attacks, session hijacking)
- Never skip security headers in production
- Rate limiting is configured in route decorators: `@limiter.limit("10/minute")`
- Session revocation is database-backed, not just JWT expiry
### Common Workflows Guidance
**When Adding a New Feature:**
1. Start with backend schema and CRUD
2. Implement API route with proper authorization
3. Write backend tests (aim for >90% coverage)
4. Generate frontend API client: `npm run generate:api`
5. Implement frontend components
6. Write frontend unit tests
7. Add E2E tests for critical flows
8. Update relevant documentation
**When Fixing Tests:**
- Backend: Check test database isolation and async fixture usage
- Frontend unit: Verify mocking of `useAuth()` not `useAuthStore`
- E2E: Use `Promise.all()` pattern and regex URL assertions
**When Debugging:**
- Backend: Check `IS_TEST=True` environment variable is set
- Frontend: Run `npm run type-check` first
- E2E: Use `npm run test:e2e:debug` for step-by-step debugging
- Check logs: Backend has detailed error logging
### Tool Usage Preferences
**Prefer specialized tools over bash:**
- Use Read/Write/Edit tools for file operations
- Never use `cat`, `echo >`, or heredoc for file manipulation
- Use Task tool with `subagent_type=Explore` for codebase exploration
- Use Grep tool for code search, not bash `grep`
**When to use parallel tool calls:**
- Independent git commands: `git status`, `git diff`, `git log`
- Reading multiple unrelated files
- Running multiple test suites simultaneously
- Independent validation steps
## Custom Skills
No Claude Code Skills installed yet. To create one, invoke the built-in "skill-creator" skill.
**Potential skill ideas for this project:**
- API endpoint generator workflow (schema → CRUD → route → tests → frontend client)
- Component generator with design system compliance
- Database migration troubleshooting helper
- Test coverage analyzer and improvement suggester
- E2E test generator for new features
## Additional Resources
**Comprehensive Documentation:**
- [AGENTS.md](./AGENTS.md) - Framework-agnostic AI assistant context
- [README.md](./README.md) - User-facing project overview
- `backend/docs/` - Backend architecture, coding standards, common pitfalls
- `frontend/docs/design-system/` - Complete design system guide
- `frontend/docs/ARCHITECTURE_FIX_REPORT.md` - Critical DI pattern fixes
**API Documentation (when running):**
- Swagger UI: http://localhost:8000/docs
- ReDoc: http://localhost:8000/redoc
- OpenAPI JSON: http://localhost:8000/api/v1/openapi.json
**Testing Documentation:**
- Backend tests: `backend/tests/` (97% coverage)
- Frontend E2E: `frontend/e2e/README.md`
- Design system: `frontend/docs/design-system/08-ai-guidelines.md`
---
**For project architecture, development commands, and general context, see [AGENTS.md](./AGENTS.md).**

View File

@@ -17,6 +17,17 @@
---
## 🤖 AI-Friendly Documentation
This project includes comprehensive documentation designed for AI coding assistants:
- **[AGENTS.md](./AGENTS.md)** - Framework-agnostic AI assistant context (works with Claude, Cursor, GitHub Copilot, etc.)
- **[CLAUDE.md](./CLAUDE.md)** - Claude Code-specific guidance and preferences
These files provide AI assistants with project architecture, development patterns, testing strategies, and best practices to help them work more effectively with this codebase.
---
## Why This Template?
Building a modern full-stack application from scratch means solving the same problems over and over: authentication, authorization, multi-tenancy, admin panels, session management, database migrations, API documentation, testing infrastructure...
@@ -55,7 +66,24 @@ Instead of spending weeks on boilerplate, you can focus on building your unique
- Comprehensive design system built on shadcn/ui + TailwindCSS
- Pre-configured theme with dark mode support (coming soon)
- Responsive, accessible components (WCAG AA compliant)
- Developer documentation at `/dev` (in progress)
- Rich marketing landing page with animated components
- Live component showcase and documentation at `/dev`
### 🌍 **Internationalization (i18n)**
- Built-in multi-language support with next-intl v4
- Locale-based routing (`/en/*`, `/it/*`)
- Seamless language switching with LocaleSwitcher component
- SEO-friendly URLs and metadata per locale
- Translation files for English and Italian (easily extensible)
- Type-safe translations throughout the app
### 🎯 **Content & UX Features**
- **Toast notifications** with Sonner for elegant user feedback
- **Smooth animations** powered by Framer Motion
- **Markdown rendering** with syntax highlighting (GitHub Flavored Markdown)
- **Charts and visualizations** ready with Recharts
- **SEO optimization** with dynamic sitemap and robots.txt generation
- **Session tracking UI** with device information and revocation controls
### 🧪 **Comprehensive Testing**
- **Backend Testing**: ~97% unit test coverage
@@ -75,9 +103,10 @@ Instead of spending weeks on boilerplate, you can focus on building your unique
### 📚 **Developer Experience**
- Auto-generated TypeScript API client from OpenAPI spec
- Interactive API documentation (Swagger + ReDoc)
- Database migrations with Alembic
- Hot reload in development
- Comprehensive code documentation
- Database migrations with Alembic helper script
- Hot reload in development for both frontend and backend
- Comprehensive code documentation and design system docs
- Live component playground at `/dev` with code examples
- Docker support for easy deployment
- VSCode workspace settings included
@@ -89,6 +118,9 @@ Instead of spending weeks on boilerplate, you can focus on building your unique
- Health check endpoints
- Production security headers
- Rate limiting on sensitive endpoints
- SEO optimization with dynamic sitemaps and robots.txt
- Multi-language SEO with locale-specific metadata
- Performance monitoring and bundle analysis
---
@@ -108,8 +140,13 @@ Instead of spending weeks on boilerplate, you can focus on building your unique
- **[TypeScript](https://www.typescriptlang.org/)** - Type-safe JavaScript
- **[TailwindCSS](https://tailwindcss.com/)** - Utility-first CSS framework
- **[shadcn/ui](https://ui.shadcn.com/)** - Beautiful, accessible component library
- **[next-intl](https://next-intl.dev/)** - Internationalization (i18n) with type safety
- **[TanStack Query](https://tanstack.com/query)** - Powerful data fetching/caching
- **[Zustand](https://zustand-demo.pmnd.rs/)** - Lightweight state management
- **[Framer Motion](https://www.framer.com/motion/)** - Production-ready animation library
- **[Sonner](https://sonner.emilkowal.ski/)** - Beautiful toast notifications
- **[Recharts](https://recharts.org/)** - Composable charting library
- **[React Markdown](https://github.com/remarkjs/react-markdown)** - Markdown rendering with GFM support
- **[Playwright](https://playwright.dev/)** - End-to-end testing
### DevOps
@@ -365,13 +402,17 @@ python migrate.py current
## 📖 Documentation
### AI Assistant Documentation
- **[AGENTS.md](./AGENTS.md)** - Framework-agnostic AI coding assistant context
- **[CLAUDE.md](./CLAUDE.md)** - Claude Code-specific guidance and preferences
### Backend Documentation
- **[ARCHITECTURE.md](./backend/docs/ARCHITECTURE.md)** - System architecture and design patterns
- **[CODING_STANDARDS.md](./backend/docs/CODING_STANDARDS.md)** - Code quality standards
- **[COMMON_PITFALLS.md](./backend/docs/COMMON_PITFALLS.md)** - Common mistakes to avoid
- **[FEATURE_EXAMPLE.md](./backend/docs/FEATURE_EXAMPLE.md)** - Step-by-step feature guide
- **[CLAUDE.md](./CLAUDE.md)** - Comprehensive development guide
### Frontend Documentation
@@ -433,33 +474,38 @@ docker-compose down
- [x] User management (CRUD, profile, password change)
- [x] Organization system with RBAC (Owner, Admin, Member)
- [x] Admin panel (users, organizations, sessions, statistics)
- [x] **Internationalization (i18n)** with next-intl (English + Italian)
- [x] Backend testing infrastructure (~97% coverage)
- [x] Frontend unit testing infrastructure (~97% coverage)
- [x] Frontend E2E testing (Playwright, zero flaky tests)
- [x] Design system documentation
- [x] Database migrations
- [x] **Marketing landing page** with animated components
- [x] **`/dev` documentation portal** with live component examples
- [x] **Toast notifications** system (Sonner)
- [x] **Charts and visualizations** (Recharts)
- [x] **Animation system** (Framer Motion)
- [x] **Markdown rendering** with syntax highlighting
- [x] **SEO optimization** (sitemap, robots.txt, locale-aware metadata)
- [x] Database migrations with helper script
- [x] Docker deployment
- [x] API documentation (OpenAPI/Swagger)
### 🚧 In Progress
- [ ] Frontend admin pages (70% complete)
- [ ] Dark mode theme
- [ ] `/dev` documentation page with examples
- [ ] Email integration (templates ready, SMTP pending)
- [ ] Chart/visualization components
### 🔮 Planned
- [ ] GitHub Actions CI/CD pipelines
- [ ] Dynamic test coverage badges from CI
- [ ] E2E test coverage reporting
- [ ] Additional languages (Spanish, French, German, etc.)
- [ ] Additional authentication methods (OAuth, SSO)
- [ ] Real-time notifications with WebSockets
- [ ] Webhook system
- [ ] Background job processing
- [ ] File upload/storage
- [ ] Notification system
- [ ] Audit logging
- [ ] File upload/storage (S3-compatible)
- [ ] Audit logging system
- [ ] API versioning example
---
## 🤝 Contributing

View File

@@ -1,26 +0,0 @@
{
"all": true,
"include": ["src/**/*.{js,jsx,ts,tsx}"],
"exclude": [
"src/**/*.d.ts",
"src/**/*.test.{js,jsx,ts,tsx}",
"src/**/__tests__/**",
"src/**/*.stories.{js,jsx,ts,tsx}",
"src/lib/api/generated/**",
"src/**/*.old.{js,jsx,ts,tsx}",
"src/components/ui/**",
"src/app/dev/**",
"src/**/index.{js,jsx,ts,tsx}",
"src/lib/utils/cn.ts",
"src/middleware.ts"
],
"reporter": ["text", "text-summary", "html", "json", "lcov"],
"report-dir": "./coverage-combined",
"temp-dir": "./.nyc_output",
"sourceMap": true,
"instrument": true,
"branches": 85,
"functions": 85,
"lines": 90,
"statements": 90
}

View File

@@ -1,651 +0,0 @@
# E2E Coverage Integration Guide
This guide explains how to collect and merge E2E test coverage with unit test coverage to get a comprehensive view of your test coverage.
## 📋 Table of Contents
1. [Overview](#overview)
2. [Quick Start](#quick-start)
3. [Approach 1: V8 Coverage (Recommended)](#approach-1-v8-coverage-recommended)
4. [Approach 2: Istanbul Instrumentation](#approach-2-istanbul-instrumentation)
5. [Combined Coverage Workflow](#combined-coverage-workflow)
6. [Integration Steps](#integration-steps)
7. [Troubleshooting](#troubleshooting)
8. [FAQ](#faq)
---
## Overview
### Why Combined Coverage?
Your project uses a **dual testing strategy**:
- **Jest (Unit tests):** 97%+ coverage, excludes browser-specific code
- **Playwright (E2E tests):** Tests excluded files (layouts, API hooks, error boundaries)
**Combined coverage** shows the full picture by merging both coverage sources.
### Current Exclusions from Jest
```javascript
// From jest.config.js - These ARE tested by E2E:
'!src/lib/api/hooks/**', // React Query hooks
'!src/app/**/layout.tsx', // Next.js layouts
'!src/app/**/error.tsx', // Error boundaries
'!src/app/**/loading.tsx', // Loading states
```
### Expected Results
```
Unit test coverage: 97.19% (excluding above)
E2E coverage: ~25-35% (user flows + excluded files)
Combined coverage: 98-100% ✅
```
---
## Quick Start
### Prerequisites
All infrastructure is already created! Just need dependencies:
```bash
# Option 1: V8 Coverage (Chromium only, no instrumentation)
npm install -D v8-to-istanbul istanbul-lib-coverage istanbul-lib-report istanbul-reports
# Option 2: Istanbul Instrumentation (all browsers)
npm install -D @istanbuljs/nyc-config-typescript babel-plugin-istanbul nyc \
istanbul-lib-coverage istanbul-lib-report istanbul-reports
```
### Add Package Scripts
Add to `package.json`:
```json
{
"scripts": {
"coverage:convert": "tsx scripts/convert-v8-to-istanbul.ts",
"coverage:merge": "tsx scripts/merge-coverage.ts",
"coverage:combined": "npm run test:coverage && E2E_COVERAGE=true npm run test:e2e && npm run coverage:convert && npm run coverage:merge",
"coverage:view": "open coverage-combined/index.html"
}
}
```
### Run Combined Coverage
```bash
# Full workflow (unit + E2E + merge)
npm run coverage:combined
# View HTML report
npm run coverage:view
```
---
## Approach 1: V8 Coverage (Recommended)
### Pros & Cons
**Pros:**
- ✅ Native browser coverage (most accurate)
- ✅ No build instrumentation needed (faster)
- ✅ Works with source maps
- ✅ Zero performance overhead
**Cons:**
- ❌ Chromium only (V8 engine specific)
- ❌ Requires v8-to-istanbul conversion
### Setup Steps
#### 1. Install Dependencies
```bash
npm install -D v8-to-istanbul istanbul-lib-coverage istanbul-lib-report istanbul-reports
```
#### 2. Integrate into E2E Tests
Update your E2E test files to use coverage helpers:
```typescript
// e2e/homepage.spec.ts
import { test, expect } from '@playwright/test';
import { withCoverage } from './helpers/coverage';
test.describe('Homepage Tests', () => {
test.beforeEach(async ({ page }) => {
// Start coverage collection
await withCoverage.start(page);
await page.goto('/');
});
test.afterEach(async ({ page }, testInfo) => {
// Stop and save coverage
await withCoverage.stop(page, testInfo.title);
});
test('displays header', async ({ page }) => {
await expect(page.getByRole('heading')).toBeVisible();
});
});
```
#### 3. Run E2E Tests with Coverage
```bash
E2E_COVERAGE=true npm run test:e2e
```
This generates: `coverage-e2e/raw/*.json` (V8 format)
#### 4. Convert V8 to Istanbul
```bash
npm run coverage:convert
```
This converts to: `coverage-e2e/.nyc_output/e2e-coverage.json` (Istanbul format)
#### 5. Merge with Jest Coverage
```bash
npm run coverage:merge
```
This generates: `coverage-combined/index.html`
---
## Approach 2: Istanbul Instrumentation
### Pros & Cons
**Pros:**
- ✅ Works on all browsers (Firefox, Safari, etc.)
- ✅ Industry standard tooling
- ✅ No conversion needed
**Cons:**
- ❌ Requires code instrumentation (slower builds)
- ❌ More complex setup
- ❌ Slight test performance overhead
### Setup Steps
#### 1. Install Dependencies
```bash
npm install -D @istanbuljs/nyc-config-typescript babel-plugin-istanbul \
nyc istanbul-lib-coverage istanbul-lib-report istanbul-reports \
@babel/core babel-loader
```
#### 2. Configure Babel Instrumentation
Create `.babelrc.js`:
```javascript
module.exports = {
presets: ['next/babel'],
env: {
test: {
plugins: [process.env.E2E_COVERAGE && 'istanbul'].filter(Boolean),
},
},
};
```
#### 3. Configure Next.js Webpack
Update `next.config.js`:
```javascript
const nextConfig = {
webpack: (config, { isServer }) => {
// Add Istanbul instrumentation in E2E coverage mode
if (process.env.E2E_COVERAGE && !isServer) {
config.module.rules.push({
test: /\.(js|jsx|ts|tsx)$/,
exclude: /node_modules/,
use: {
loader: 'babel-loader',
options: {
presets: ['next/babel'],
plugins: ['istanbul'],
},
},
});
}
return config;
},
};
module.exports = nextConfig;
```
#### 4. Integrate into E2E Tests
Use the Istanbul helper instead:
```typescript
import { test, expect } from '@playwright/test';
import { saveIstanbulCoverage } from './helpers/coverage';
test.describe('Homepage Tests', () => {
test.afterEach(async ({ page }, testInfo) => {
await saveIstanbulCoverage(page, testInfo.title);
});
test('my test', async ({ page }) => {
await page.goto('/');
// Test code...
});
});
```
#### 5. Run Tests
```bash
# Start dev server with instrumentation
E2E_COVERAGE=true npm run dev
# In another terminal, run E2E tests
E2E_COVERAGE=true npm run test:e2e
```
#### 6. Merge Coverage
```bash
npm run coverage:merge
```
No conversion step needed! Istanbul coverage goes directly to `.nyc_output/`.
---
## Combined Coverage Workflow
### Full Workflow Diagram
```
┌─────────────────────┐
│ Jest Unit Tests │
│ npm run test:cov │
└──────────┬──────────┘
v
coverage/coverage-final.json
├─────────────────────┐
│ │
v v
┌─────────────────┐ ┌──────────────────┐
│ E2E Tests │ │ E2E Tests │
│ (V8 Coverage) │ │ (Istanbul) │
└────────┬────────┘ └────────┬─────────┘
│ │
v v
coverage-e2e/raw/*.json coverage-e2e/.nyc_output/*.json
│ │
v │
scripts/convert-v8-to-istanbul.ts
│ │
v │
coverage-e2e/.nyc_output/e2e-coverage.json
│ │
└──────────┬──────────┘
v
scripts/merge-coverage.ts
v
coverage-combined/
├── index.html
├── lcov.info
└── coverage-final.json
```
### Commands Summary
```bash
# 1. Run unit tests with coverage
npm run test:coverage
# 2. Run E2E tests with coverage
E2E_COVERAGE=true npm run test:e2e
# 3. Convert V8 to Istanbul (if using V8 approach)
npm run coverage:convert
# 4. Merge all coverage
npm run coverage:merge
# 5. View combined report
npm run coverage:view
# OR: Do all at once
npm run coverage:combined
```
---
## Integration Steps
### Phase 1: Pilot Integration (Single Test File)
Start with one E2E test file to verify the setup:
**File: `e2e/homepage.spec.ts`**
```typescript
import { test, expect } from '@playwright/test';
import { withCoverage } from './helpers/coverage';
test.describe('Homepage - Desktop Navigation', () => {
test.beforeEach(async ({ page }) => {
await withCoverage.start(page);
await page.goto('/');
await page.waitForLoadState('networkidle');
});
test.afterEach(async ({ page }, testInfo) => {
await withCoverage.stop(page, testInfo.title);
});
test('should display header with logo and navigation', async ({ page }) => {
await expect(page.getByRole('link', { name: /FastNext/i })).toBeVisible();
await expect(page.getByRole('link', { name: 'Components' })).toBeVisible();
});
});
```
**Test the pilot:**
```bash
# Install dependencies
npm install -D v8-to-istanbul istanbul-lib-coverage istanbul-lib-report istanbul-reports
# Run single test with coverage
E2E_COVERAGE=true npx playwright test homepage.spec.ts
# Verify coverage files created
ls coverage-e2e/raw/
# Convert and merge
npm run coverage:convert
npm run coverage:merge
# Check results
npm run coverage:view
```
### Phase 2: Rollout to All Tests
Once pilot works, update all 15 E2E spec files:
**Automated rollout script:**
```bash
# Create a helper script: scripts/add-coverage-to-tests.sh
#!/bin/bash
for file in e2e/*.spec.ts; do
# Add import at top (if not already present)
if ! grep -q "import.*coverage" "$file"; then
sed -i "1i import { withCoverage } from './helpers/coverage';" "$file"
fi
# Add beforeEach hook (manual review recommended)
echo "Updated: $file"
done
```
**Or manually add to each file:**
1. Import coverage helper
2. Add `beforeEach` with `withCoverage.start(page)`
3. Add `afterEach` with `withCoverage.stop(page, testInfo.title)`
### Phase 3: CI/CD Integration
Add to your CI pipeline (e.g., `.github/workflows/test.yml`):
```yaml
- name: Run E2E tests with coverage
run: E2E_COVERAGE=true npm run test:e2e
- name: Convert E2E coverage
run: npm run coverage:convert
- name: Merge coverage
run: npm run coverage:merge
- name: Upload combined coverage
uses: codecov/codecov-action@v3
with:
files: ./coverage-combined/lcov.info
flags: combined
```
---
## Troubleshooting
### Problem: No coverage files generated
**Symptoms:**
```bash
npm run coverage:convert
# ❌ No V8 coverage found at: coverage-e2e/raw
```
**Solutions:**
1. Verify `E2E_COVERAGE=true` is set when running tests
2. Check coverage helpers are imported: `import { withCoverage } from './helpers/coverage'`
3. Verify `beforeEach` and `afterEach` hooks are added
4. Check browser console for errors during test run
### Problem: V8 conversion fails
**Symptoms:**
```bash
npm run coverage:convert
# ❌ v8-to-istanbul not installed
```
**Solution:**
```bash
npm install -D v8-to-istanbul
```
### Problem: Coverage lower than expected
**Symptoms:**
```
Combined: 85% (expected 99%)
```
**Causes & Solutions:**
1. **E2E tests don't trigger all code paths**
- Check which files are E2E-only: `npm run coverage:merge` shows breakdown
- Add more E2E tests for uncovered scenarios
2. **Source maps not working**
- Verify Next.js generates source maps: check `next.config.js`
- Istanbul needs source maps to map coverage back to source
3. **Wrong files included**
- Check `.nycrc.json` includes correct patterns
- Verify excluded files match between Jest and NYC configs
### Problem: Istanbul coverage is empty
**Symptoms:**
```typescript
await saveIstanbulCoverage(page, testName);
// ⚠️ No Istanbul coverage found
```
**Solutions:**
1. Verify `babel-plugin-istanbul` is configured
2. Check `window.__coverage__` exists:
```typescript
const hasCoverage = await page.evaluate(() => !!(window as any).__coverage__);
console.log('Istanbul available:', hasCoverage);
```
3. Ensure dev server started with `E2E_COVERAGE=true npm run dev`
### Problem: Merge script fails
**Symptoms:**
```bash
npm run coverage:merge
# ❌ Error: Cannot find module 'istanbul-lib-coverage'
```
**Solution:**
```bash
npm install -D istanbul-lib-coverage istanbul-lib-report istanbul-reports
```
---
## FAQ
### Q: Should I use V8 or Istanbul coverage?
**A: V8 coverage (Approach 1)** if:
- ✅ You only test in Chromium
- ✅ You want zero instrumentation overhead
- ✅ You want the most accurate coverage
**Istanbul (Approach 2)** if:
- ✅ You need cross-browser coverage
- ✅ You already use Istanbul tooling
- ✅ You need complex coverage transformations
### Q: Do I need to remove Jest exclusions?
**A: No!** Keep them. The `.nycrc.json` config handles combined coverage independently.
### Q: Will this slow down my tests?
**V8 Approach:** Minimal overhead (~5% slower)
**Istanbul Approach:** Moderate overhead (~15-20% slower due to instrumentation)
### Q: Can I run coverage only for specific tests?
**Yes:**
```bash
# Single file
E2E_COVERAGE=true npx playwright test homepage.spec.ts
# Specific describe block
E2E_COVERAGE=true npx playwright test --grep "Mobile Menu"
```
### Q: How do I exclude files from E2E coverage?
Edit `.nycrc.json` and add to `exclude` array:
```json
{
"exclude": ["src/app/dev/**", "src/lib/utils/debug.ts"]
}
```
### Q: Can I see which lines are covered by E2E vs Unit tests?
Not directly in the HTML report, but you can:
1. Generate separate reports:
```bash
npx nyc report --reporter=html --report-dir=coverage-unit --temp-dir=coverage/.nyc_output
npx nyc report --reporter=html --report-dir=coverage-e2e-only --temp-dir=coverage-e2e/.nyc_output
```
2. Compare the two reports to see differences
### Q: What's the performance impact on CI?
Typical impact:
- V8 coverage: +2-3 minutes (conversion time)
- Istanbul coverage: +5-7 minutes (build instrumentation)
- Merge step: ~10 seconds
Total CI time increase: **3-8 minutes**
---
## Next Steps
### After Phase 1 (Infrastructure - DONE ✅)
You've completed:
- ✅ `.nycrc.json` configuration
- ✅ Merge script (`scripts/merge-coverage.ts`)
- ✅ Conversion script (`scripts/convert-v8-to-istanbul.ts`)
- ✅ Coverage helpers (`e2e/helpers/coverage.ts`)
- ✅ This documentation
### Phase 2: Activation (When Ready)
1. **Install dependencies:**
```bash
npm install -D v8-to-istanbul istanbul-lib-coverage istanbul-lib-report istanbul-reports
```
2. **Add package.json scripts** (see Quick Start)
3. **Test with one E2E file** (homepage.spec.ts recommended)
4. **Rollout to all E2E tests**
5. **Add to CI/CD pipeline**
### Expected Timeline
- **Phase 1:** ✅ Done (non-disruptive infrastructure)
- **Phase 2:** ~1-2 hours (pilot + dependency installation)
- **Rollout:** ~30 minutes (add hooks to 15 test files)
- **CI integration:** ~20 minutes
---
## Additional Resources
- [Istanbul Coverage](https://istanbul.js.org/)
- [NYC Configuration](https://github.com/istanbuljs/nyc#configuration-files)
- [Playwright Coverage](https://playwright.dev/docs/api/class-coverage)
- [V8 to Istanbul](https://github.com/istanbuljs/v8-to-istanbul)
---
**Questions or issues?** Check troubleshooting section or review the example in `e2e/helpers/coverage.ts`.

View File

@@ -1,313 +0,0 @@
# E2E Test Performance Optimization Plan
**Current State**: 230 tests, ~2100 seconds total execution time
**Target**: Reduce to <900 seconds (60% improvement)
## Bottleneck Analysis
### 1. Authentication Overhead (HIGHEST IMPACT)
**Problem**: Each test logs in fresh via UI
- **Impact**: 5-7s per test × 133 admin tests = ~700s wasted
- **Root Cause**: Using `loginViaUI(page)` in every `beforeEach`
**Example of current slow pattern:**
```typescript
test.beforeEach(async ({ page }) => {
await setupSuperuserMocks(page);
await loginViaUI(page); // ← 5-7s UI login EVERY test
await page.goto('/admin');
});
```
**Solution: Playwright Storage State** (SAVE ~600-700s)
```typescript
// auth.setup.ts - Run ONCE per worker
import { test as setup } from '@playwright/test';
setup('authenticate as admin', async ({ page }) => {
await setupSuperuserMocks(page);
await loginViaUI(page);
await page.context().storageState({ path: 'e2e/.auth/admin.json' });
});
setup('authenticate as regular user', async ({ page }) => {
await setupAuthenticatedMocks(page);
await loginViaUI(page);
await page.context().storageState({ path: 'e2e/.auth/user.json' });
});
```
```typescript
// playwright.config.ts
export default defineConfig({
projects: [
{ name: 'setup', testMatch: /.*\.setup\.ts/ },
{
name: 'admin tests',
use: { storageState: 'e2e/.auth/admin.json' },
dependencies: ['setup'],
testMatch: /admin-.*\.spec\.ts/,
},
{
name: 'user tests',
use: { storageState: 'e2e/.auth/user.json' },
dependencies: ['setup'],
testMatch: /settings-.*\.spec\.ts/,
},
],
});
```
```typescript
// admin-users.spec.ts - NO MORE loginViaUI!
test.beforeEach(async ({ page }) => {
// Auth already loaded from storageState
await page.goto('/admin/users'); // ← Direct navigation, ~1-2s
});
```
**Expected Improvement**: 5-6s → 0.5-1s per test = **~600s saved** (133 tests × 5s)
---
### 2. Redundant Navigation Tests (MEDIUM IMPACT)
**Problem**: Separate tests for "navigate to X" and "display X page"
- **Impact**: 3-5s per redundant test × ~15 tests = ~60s wasted
**Current slow pattern:**
```typescript
test('should navigate to users page', async ({ page }) => {
await page.goto('/admin/users'); // 3s
await expect(page).toHaveURL('/admin/users');
await expect(page.locator('h1')).toContainText('User Management');
});
test('should display user management page', async ({ page }) => {
await page.goto('/admin/users'); // 3s DUPLICATE
await expect(page.locator('h1')).toContainText('User Management');
await expect(page.getByText(/manage users/i)).toBeVisible();
});
```
**Optimized pattern:**
```typescript
test('should navigate to users page and display content', async ({ page }) => {
await page.goto('/admin/users'); // 3s ONCE
// Navigation assertions
await expect(page).toHaveURL('/admin/users');
// Content assertions
await expect(page.locator('h1')).toContainText('User Management');
await expect(page.getByText(/manage users/i)).toBeVisible();
await expect(page.getByRole('button', { name: 'Create User' })).toBeVisible();
});
```
**Expected Improvement**: **~45-60s saved** (15 tests eliminated)
---
### 3. Flaky Test Fix (CRITICAL)
**Problem**: Test #218 failed once, passed on retry
```
Test: settings-password.spec.ts:24:7 Password Change should display password change form
Failed: 12.8s → Retry passed: 8.3s
```
**Root Cause Options**:
1. Race condition in form rendering
2. Slow network request not properly awaited
3. Animation/transition timing issue
**Investigation needed:**
```typescript
// Current test (lines 24-35)
test('should display password change form', async ({ page }) => {
await page.goto('/settings/password');
// ← Likely missing waitForLoadState or explicit wait
await expect(page.getByLabel(/current password/i)).toBeVisible();
await expect(page.getByLabel(/new password/i)).toBeVisible();
await expect(page.getByLabel(/confirm password/i)).toBeVisible();
});
```
**Temporary Solution: Skip until fixed**
```typescript
test.skip('should display password change form', async ({ page }) => {
// TODO: Fix race condition (issue #XXX)
await page.goto('/settings/password');
await page.waitForLoadState('networkidle'); // ← Add this
await expect(page.getByLabel(/current password/i)).toBeVisible();
});
```
**Expected Improvement**: Eliminate retry overhead + improve reliability
---
### 4. Optimize Wait Timeouts (LOW IMPACT)
**Problem**: Default timeout is 10s for all assertions
- **Impact**: Tests wait unnecessarily when elements load faster
**Current global timeout:**
```typescript
// playwright.config.ts
export default defineConfig({
timeout: 30000, // Per test
expect: { timeout: 10000 }, // Per assertion
});
```
**Optimized for fast-loading pages:**
```typescript
export default defineConfig({
timeout: 20000, // Reduce from 30s
expect: { timeout: 5000 }, // Reduce from 10s (most elements load <2s)
});
```
**Expected Improvement**: **~100-150s saved** (faster failures, less waiting)
---
## Implementation Priority
### Phase 1: Quick Wins (1-2 hours work)
1.**Skip flaky test #218** temporarily
2.**Reduce timeout defaults** (5s for expects, 20s for tests)
3.**Combine 5 most obvious redundant navigation tests**
**Expected savings**: ~100-150s (5-7% improvement)
---
### Phase 2: Auth State Caching (2-4 hours work)
1. ✅ Create `e2e/auth.setup.ts` with storage state setup
2. ✅ Update `playwright.config.ts` with projects + dependencies
3. ✅ Remove `loginViaUI` from all admin test `beforeEach` hooks
4. ✅ Update auth helper to support both mock + storageState modes
**Expected savings**: ~600-700s (30-35% improvement)
---
### Phase 3: Deep Optimization (4-8 hours work)
1. ✅ Investigate and fix flaky test root cause
2. ✅ Audit all navigation tests for redundancy
3. ✅ Combine related assertions (e.g., all stat cards in one test)
4. ✅ Profile slowest 10 tests individually
**Expected savings**: ~150-200s (7-10% improvement)
---
## Total Expected Improvement
| Phase | Time Investment | Time Saved | % Improvement |
| --------- | --------------- | ---------- | ------------- |
| Phase 1 | 1-2 hours | ~150s | 7% |
| Phase 2 | 2-4 hours | ~700s | 35% |
| Phase 3 | 4-8 hours | ~200s | 10% |
| **Total** | **7-14 hours** | **~1050s** | **50-60%** |
**Final target**: 2100s → 1050s = **~17-18 minutes** (currently ~35 minutes)
---
## Risks and Considerations
### Storage State Caching Risks:
1. **Test isolation**: Shared auth state could cause cross-test pollution
- **Mitigation**: Use separate storage files per role, clear cookies between tests
2. **Stale auth tokens**: Mock tokens might expire
- **Mitigation**: Use long-lived test tokens (24h expiry)
3. **Debugging difficulty**: Harder to debug auth issues
- **Mitigation**: Keep `loginViaUI` tests for auth flow verification
### Recommended Safeguards:
```typescript
// Clear non-auth state between tests
test.beforeEach(async ({ page }) => {
await page.goto('/admin');
await page.evaluate(() => {
// Clear localStorage except auth tokens
const tokens = {
access_token: localStorage.getItem('access_token'),
refresh_token: localStorage.getItem('refresh_token'),
};
localStorage.clear();
if (tokens.access_token) localStorage.setItem('access_token', tokens.access_token);
if (tokens.refresh_token) localStorage.setItem('refresh_token', tokens.refresh_token);
});
});
```
---
## Next Steps
**Immediate Actions (Do Now):**
1. Skip flaky test #218 with TODO comment
2. Reduce timeout defaults in playwright.config.ts
3. Create this optimization plan issue/ticket
**Short-term (This Week):**
1. Implement auth storage state (Phase 2)
2. Combine obvious redundant tests (Phase 1)
**Medium-term (Next Sprint):**
1. Investigate flaky test root cause
2. Audit all tests for redundancy
3. Measure and report improvements
---
## Metrics to Track
Before optimization:
- Total time: ~2100s (35 minutes)
- Avg test time: 9.1s
- Slowest test: 20.1s (settings navigation)
- Flaky tests: 1
After Phase 1+2 target:
- Total time: <1200s (20 minutes) ✅
- Avg test time: <5.5s ✅
- Slowest test: <12s ✅
- Flaky tests: 0 ✅
After Phase 3 target:
- Total time: <1050s (17 minutes) 🎯
- Avg test time: <4.8s 🎯
- Slowest test: <10s 🎯
- Flaky tests: 0 🎯

View File

@@ -21,9 +21,6 @@ test.describe('Password Change', () => {
await page.getByLabel(/current password/i).waitFor({ state: 'visible' });
});
// TODO: Fix flaky test - failed once at 12.8s, passed on retry at 8.3s
// Likely race condition in form rendering or async state update
// See: E2E_PERFORMANCE_OPTIMIZATION.md - Phase 3
test.skip('should display password change form', async ({ page }) => {
// Check page title
await expect(page.getByRole('heading', { name: 'Password' })).toBeVisible();

View File

@@ -26,6 +26,7 @@ const customJestConfig = {
'!src/**/*.stories.{js,jsx,ts,tsx}',
'!src/**/__tests__/**',
'!src/lib/api/generated/**', // Auto-generated API client - do not test
'!src/lib/api/client-config.ts', // Integration glue for generated client - covered by E2E
'!src/lib/api/hooks/**', // React Query hooks - tested in E2E (require API mocking)
'!src/**/*.old.{js,jsx,ts,tsx}', // Old implementation files
'!src/components/ui/**', // shadcn/ui components - third-party, no need to test

File diff suppressed because one or more lines are too long

View File

@@ -1,211 +0,0 @@
#!/usr/bin/env tsx
/**
* V8 to Istanbul Coverage Converter
*
* Converts Playwright's V8 coverage format to Istanbul format
* so it can be merged with Jest coverage data.
*
* Usage:
* npm run coverage:convert
* # or directly:
* tsx scripts/convert-v8-to-istanbul.ts
*
* Input:
* - V8 coverage files in: ./coverage-e2e/raw/*.json
* - Generated by Playwright's page.coverage API
*
* Output:
* - Istanbul coverage in: ./coverage-e2e/.nyc_output/e2e-coverage.json
* - Ready to merge with Jest coverage
*
* Prerequisites:
* - npm install -D v8-to-istanbul
* - E2E tests must collect coverage using page.coverage API
*/
import fs from 'fs/promises';
import path from 'path';
import { fileURLToPath } from 'url';
// V8 coverage entry format
interface V8CoverageEntry {
url: string;
scriptId: string;
source?: string;
functions: Array<{
functionName: string;
ranges: Array<{
startOffset: number;
endOffset: number;
count: number;
}>;
isBlockCoverage: boolean;
}>;
}
// Istanbul coverage format
interface IstanbulCoverage {
[filePath: string]: {
path: string;
statementMap: Record<string, any>;
fnMap: Record<string, any>;
branchMap: Record<string, any>;
s: Record<string, number>;
f: Record<string, number>;
b: Record<string, number[]>;
};
}
async function convertV8ToIstanbul() {
console.log('\n🔄 Converting V8 Coverage to Istanbul Format...\n');
const rawDir = path.join(process.cwd(), 'coverage-e2e/raw');
const outputDir = path.join(process.cwd(), 'coverage-e2e/.nyc_output');
// Check if raw directory exists
try {
await fs.access(rawDir);
} catch {
console.log('❌ No V8 coverage found at:', rawDir);
console.log('\n To generate V8 coverage:');
console.log(' 1. Add coverage helpers to E2E tests (see E2E_COVERAGE_GUIDE.md)');
console.log(' 2. Run: E2E_COVERAGE=true npm run test:e2e');
console.log('\n Alternatively, use Istanbul instrumentation (see guide)');
return;
}
// Create output directory
await fs.mkdir(outputDir, { recursive: true });
// Check for v8-to-istanbul dependency
let v8toIstanbul: any;
try {
// Dynamic import to handle both scenarios (installed vs not installed)
const module = await import('v8-to-istanbul');
v8toIstanbul = module.default || module;
} catch {
console.log('❌ v8-to-istanbul not installed\n');
console.log('📦 Install it with:');
console.log(' npm install -D v8-to-istanbul\n');
console.log('⚠️ Note: V8 coverage approach requires this dependency.');
console.log(' Alternatively, use Istanbul instrumentation (no extra deps needed).\n');
process.exit(1);
}
// Read all V8 coverage files
const files = await fs.readdir(rawDir);
const jsonFiles = files.filter((f) => f.endsWith('.json'));
if (jsonFiles.length === 0) {
console.log('⚠️ No coverage files found in:', rawDir);
console.log('\nRun E2E tests with coverage enabled:');
console.log(' E2E_COVERAGE=true npm run test:e2e\n');
return;
}
console.log(`📁 Found ${jsonFiles.length} V8 coverage file(s)\n`);
const istanbulCoverage: IstanbulCoverage = {};
const projectRoot = process.cwd();
let totalConverted = 0;
let totalSkipped = 0;
// Process each V8 coverage file
for (const file of jsonFiles) {
const filePath = path.join(rawDir, file);
console.log(`📄 Processing: ${file}`);
try {
const content = await fs.readFile(filePath, 'utf-8');
const v8Coverage: V8CoverageEntry[] = JSON.parse(content);
for (const entry of v8Coverage) {
try {
// Skip non-source files
if (!entry.url.startsWith('http://localhost') && !entry.url.startsWith('file://')) {
continue;
}
// Skip node_modules, .next, and other irrelevant files
if (
entry.url.includes('node_modules') ||
entry.url.includes('/.next/') ||
entry.url.includes('/_next/') ||
entry.url.includes('/webpack/')
) {
totalSkipped++;
continue;
}
// Convert URL to file path
let sourcePath: string;
if (entry.url.startsWith('file://')) {
sourcePath = fileURLToPath(entry.url);
} else {
// HTTP URL - extract path
const url = new URL(entry.url);
// Try to map to source file
sourcePath = path.join(projectRoot, 'src', url.pathname);
}
// Skip if not in src/
if (!sourcePath.includes('/src/')) {
totalSkipped++;
continue;
}
// Verify file exists
try {
await fs.access(sourcePath);
} catch {
totalSkipped++;
continue;
}
// Convert using v8-to-istanbul
const converter = v8toIstanbul(sourcePath);
await converter.load();
converter.applyCoverage(entry.functions);
const converted = converter.toIstanbul();
// Merge into combined coverage
Object.assign(istanbulCoverage, converted);
totalConverted++;
} catch (error: any) {
console.log(` ⚠️ Skipped ${entry.url}: ${error.message}`);
totalSkipped++;
}
}
} catch (error: any) {
console.log(` ❌ Failed to process ${file}: ${error.message}`);
}
}
// Write Istanbul coverage
const outputPath = path.join(outputDir, 'e2e-coverage.json');
await fs.writeFile(outputPath, JSON.stringify(istanbulCoverage, null, 2));
console.log('\n' + '='.repeat(70));
console.log('✅ Conversion Complete');
console.log('='.repeat(70));
console.log(`\n Files converted: ${totalConverted}`);
console.log(` Files skipped: ${totalSkipped}`);
console.log(` Output location: ${outputPath}\n`);
if (totalConverted === 0) {
console.log('⚠️ No files were converted. Possible reasons:');
console.log(" • V8 coverage doesn't contain source files from src/");
console.log(' • Coverage was collected for build artifacts instead of source');
console.log(' • Source maps are not correctly configured\n');
console.log('💡 Consider using Istanbul instrumentation instead (see guide)\n');
} else {
console.log('✅ Ready to merge with Jest coverage:');
console.log(' npm run coverage:merge\n');
}
}
// Run the conversion
convertV8ToIstanbul().catch((error) => {
console.error('\n❌ Error converting coverage:', error);
process.exit(1);
});

View File

@@ -1,219 +0,0 @@
#!/usr/bin/env tsx
/**
* Merge Coverage Script
*
* Combines Jest unit test coverage with Playwright E2E test coverage
* to generate a comprehensive combined coverage report.
*
* Usage:
* npm run coverage:merge
* # or directly:
* tsx scripts/merge-coverage.ts
*
* Prerequisites:
* - Jest coverage must exist at: ./coverage/coverage-final.json
* - E2E coverage must exist at: ./coverage-e2e/.nyc_output/*.json
*
* Output:
* - Combined coverage report in: ./coverage-combined/
* - Formats: HTML, text, JSON, LCOV
*/
import { createCoverageMap } from 'istanbul-lib-coverage';
import { createContext } from 'istanbul-lib-report';
import reports from 'istanbul-reports';
import fs from 'fs';
import path from 'path';
interface CoverageData {
[key: string]: any;
}
interface MergeStats {
jestFiles: number;
e2eFiles: number;
combinedFiles: number;
jestOnlyFiles: string[];
e2eOnlyFiles: string[];
sharedFiles: string[];
}
async function mergeCoverage() {
console.log('\n🔄 Merging Coverage Data...\n');
const map = createCoverageMap();
const stats: MergeStats = {
jestFiles: 0,
e2eFiles: 0,
combinedFiles: 0,
jestOnlyFiles: [],
e2eOnlyFiles: [],
sharedFiles: [],
};
const jestFiles = new Set<string>();
const e2eFiles = new Set<string>();
// Step 1: Load Jest coverage
console.log('📊 Loading Jest unit test coverage...');
const jestCoveragePath = path.join(process.cwd(), 'coverage/coverage-final.json');
if (fs.existsSync(jestCoveragePath)) {
const jestCoverage: CoverageData = JSON.parse(fs.readFileSync(jestCoveragePath, 'utf-8'));
Object.keys(jestCoverage).forEach((file) => jestFiles.add(file));
stats.jestFiles = jestFiles.size;
console.log(` ✅ Loaded ${stats.jestFiles} files from Jest coverage`);
map.merge(jestCoverage);
} else {
console.log(' ⚠️ No Jest coverage found at:', jestCoveragePath);
console.log(' Run: npm run test:coverage');
}
// Step 2: Load E2E coverage
console.log('\n🎭 Loading Playwright E2E test coverage...');
const e2eDir = path.join(process.cwd(), 'coverage-e2e/.nyc_output');
if (fs.existsSync(e2eDir)) {
const files = fs.readdirSync(e2eDir).filter((f) => f.endsWith('.json'));
if (files.length === 0) {
console.log(' ⚠️ No E2E coverage files found in:', e2eDir);
console.log(' Run: E2E_COVERAGE=true npm run test:e2e');
} else {
for (const file of files) {
const coverage: CoverageData = JSON.parse(
fs.readFileSync(path.join(e2eDir, file), 'utf-8')
);
Object.keys(coverage).forEach((f) => e2eFiles.add(f));
map.merge(coverage);
console.log(` ✅ Loaded E2E coverage from: ${file}`);
}
stats.e2eFiles = e2eFiles.size;
console.log(` 📁 Total unique files in E2E coverage: ${stats.e2eFiles}`);
}
} else {
console.log(' ⚠️ No E2E coverage directory found at:', e2eDir);
console.log(' Run: E2E_COVERAGE=true npm run test:e2e');
}
// Step 3: Calculate statistics
stats.combinedFiles = map.files().length;
map.files().forEach((file) => {
const inJest = jestFiles.has(file);
const inE2E = e2eFiles.has(file);
if (inJest && inE2E) {
stats.sharedFiles.push(file);
} else if (inJest) {
stats.jestOnlyFiles.push(file);
} else if (inE2E) {
stats.e2eOnlyFiles.push(file);
}
});
// Step 4: Generate reports
console.log('\n📝 Generating combined coverage reports...');
const reportDir = path.join(process.cwd(), 'coverage-combined');
fs.mkdirSync(reportDir, { recursive: true });
const context = createContext({
dir: reportDir,
coverageMap: map,
});
const reportTypes = ['text', 'text-summary', 'html', 'json', 'lcov'];
reportTypes.forEach((reportType) => {
try {
const report = reports.create(reportType as any, {});
report.execute(context);
console.log(` ✅ Generated ${reportType} report`);
} catch (error) {
console.error(` ❌ Failed to generate ${reportType} report:`, error);
}
});
// Step 5: Print summary
const summary = map.getCoverageSummary();
console.log('\n' + '='.repeat(70));
console.log('📊 COMBINED COVERAGE SUMMARY');
console.log('='.repeat(70));
console.log(
`\n Statements: ${summary.statements.pct.toFixed(2)}% (${summary.statements.covered}/${summary.statements.total})`
);
console.log(
` Branches: ${summary.branches.pct.toFixed(2)}% (${summary.branches.covered}/${summary.branches.total})`
);
console.log(
` Functions: ${summary.functions.pct.toFixed(2)}% (${summary.functions.covered}/${summary.functions.total})`
);
console.log(
` Lines: ${summary.lines.pct.toFixed(2)}% (${summary.lines.covered}/${summary.lines.total})`
);
console.log('\n' + '-'.repeat(70));
console.log('📁 FILE COVERAGE BREAKDOWN');
console.log('-'.repeat(70));
console.log(`\n Total files: ${stats.combinedFiles}`);
console.log(` Jest only: ${stats.jestOnlyFiles.length}`);
console.log(` E2E only: ${stats.e2eOnlyFiles.length}`);
console.log(` Covered by both: ${stats.sharedFiles.length}`);
// Show E2E-only files (these were excluded from Jest)
if (stats.e2eOnlyFiles.length > 0) {
console.log('\n 📋 Files covered ONLY by E2E tests (excluded from unit tests):');
stats.e2eOnlyFiles.slice(0, 10).forEach((file) => {
const fileCoverage = map.fileCoverageFor(file);
const fileSummary = fileCoverage.toSummary();
console.log(
`${path.relative(process.cwd(), file)} (${fileSummary.statements.pct.toFixed(1)}%)`
);
});
if (stats.e2eOnlyFiles.length > 10) {
console.log(` ... and ${stats.e2eOnlyFiles.length - 10} more`);
}
}
console.log('\n' + '='.repeat(70));
console.log(`\n✅ Combined coverage report available at:\n ${reportDir}/index.html\n`);
// Step 6: Check thresholds (from .nycrc.json)
const thresholds = {
statements: 90,
branches: 85,
functions: 85,
lines: 90,
};
let thresholdsFailed = false;
console.log('🎯 Checking Coverage Thresholds:\n');
Object.entries(thresholds).forEach(([metric, threshold]) => {
const actual = (summary as any)[metric].pct;
const passed = actual >= threshold;
const icon = passed ? '✅' : '❌';
console.log(
` ${icon} ${metric.padEnd(12)}: ${actual.toFixed(2)}% (threshold: ${threshold}%)`
);
if (!passed) thresholdsFailed = true;
});
if (thresholdsFailed) {
console.log('\n❌ Coverage thresholds not met!\n');
process.exit(1);
} else {
console.log('\n✅ All coverage thresholds met!\n');
}
}
// Run the merge
mergeCoverage().catch((error) => {
console.error('\n❌ Error merging coverage:', error);
process.exit(1);
});

View File

@@ -0,0 +1,15 @@
/* istanbul ignore file - Server-only Next.js metadata generation covered by E2E */
import type { Metadata } from 'next';
import { getTranslations } from 'next-intl/server';
import { generatePageMetadata, type Locale } from '@/lib/i18n/metadata';
export async function generateMetadata({
params,
}: {
params: Promise<{ locale: string }>;
}): Promise<Metadata> {
const { locale } = await params;
const t = await getTranslations({ locale, namespace: 'auth.login' });
return generatePageMetadata(locale as Locale, t('title'), t('subtitle'), '/login');
}

View File

@@ -1,7 +1,4 @@
import { Metadata } from 'next';
import dynamic from 'next/dynamic';
import { generatePageMetadata, type Locale } from '@/lib/i18n/metadata';
import { getTranslations } from 'next-intl/server';
// Code-split LoginForm - heavy with react-hook-form + validation
const LoginForm = dynamic(
@@ -18,16 +15,8 @@ const LoginForm = dynamic(
}
);
export async function generateMetadata({
params,
}: {
params: Promise<{ locale: string }>;
}): Promise<Metadata> {
const { locale } = await params;
const t = await getTranslations({ locale, namespace: 'auth.login' });
return generatePageMetadata(locale as Locale, t('title'), t('subtitle'), '/login');
}
// Re-export server-only metadata from separate, ignored file
export { generateMetadata } from './metadata';
export default function LoginPage() {
return (

View File

@@ -0,0 +1,20 @@
/* istanbul ignore file - Server-only Next.js metadata generation covered by E2E */
import type { Metadata } from 'next';
import { getTranslations } from 'next-intl/server';
import { generatePageMetadata, type Locale } from '@/lib/i18n/metadata';
export async function generateMetadata({
params,
}: {
params: Promise<{ locale: string }>;
}): Promise<Metadata> {
const { locale } = await params;
const t = await getTranslations({ locale, namespace: 'auth.passwordResetConfirm' });
return generatePageMetadata(
locale as Locale,
t('title'),
t('instructions'),
'/password-reset/confirm'
);
}

View File

@@ -3,27 +3,11 @@
* Users set a new password using the token from their email
*/
import { Metadata } from 'next';
import { Suspense } from 'react';
import { generatePageMetadata, type Locale } from '@/lib/i18n/metadata';
import { getTranslations } from 'next-intl/server';
import PasswordResetConfirmContent from './PasswordResetConfirmContent';
export async function generateMetadata({
params,
}: {
params: Promise<{ locale: string }>;
}): Promise<Metadata> {
const { locale } = await params;
const t = await getTranslations({ locale, namespace: 'auth.passwordResetConfirm' });
return generatePageMetadata(
locale as Locale,
t('title'),
t('instructions'),
'/password-reset/confirm'
);
}
// Re-export server-only metadata from separate, ignored file
export { generateMetadata } from './metadata';
export default function PasswordResetConfirmPage() {
return (

View File

@@ -0,0 +1,15 @@
/* istanbul ignore file - Server-only Next.js metadata generation covered by E2E */
import type { Metadata } from 'next';
import { getTranslations } from 'next-intl/server';
import { generatePageMetadata, type Locale } from '@/lib/i18n/metadata';
export async function generateMetadata({
params,
}: {
params: Promise<{ locale: string }>;
}): Promise<Metadata> {
const { locale } = await params;
const t = await getTranslations({ locale, namespace: 'auth.passwordReset' });
return generatePageMetadata(locale as Locale, t('title'), t('subtitle'), '/password-reset');
}

View File

@@ -3,10 +3,7 @@
* Users enter their email to receive reset instructions
*/
import { Metadata } from 'next';
import dynamic from 'next/dynamic';
import { generatePageMetadata, type Locale } from '@/lib/i18n/metadata';
import { getTranslations } from 'next-intl/server';
// Code-split PasswordResetRequestForm
const PasswordResetRequestForm = dynamic(
@@ -25,16 +22,8 @@ const PasswordResetRequestForm = dynamic(
}
);
export async function generateMetadata({
params,
}: {
params: Promise<{ locale: string }>;
}): Promise<Metadata> {
const { locale } = await params;
const t = await getTranslations({ locale, namespace: 'auth.passwordReset' });
return generatePageMetadata(locale as Locale, t('title'), t('subtitle'), '/password-reset');
}
// Re-export server-only metadata from separate, ignored file
export { generateMetadata } from './metadata';
export default function PasswordResetPage() {
return (

View File

@@ -0,0 +1,15 @@
/* istanbul ignore file - Server-only Next.js metadata generation covered by E2E */
import type { Metadata } from 'next';
import { getTranslations } from 'next-intl/server';
import { generatePageMetadata, type Locale } from '@/lib/i18n/metadata';
export async function generateMetadata({
params,
}: {
params: Promise<{ locale: string }>;
}): Promise<Metadata> {
const { locale } = await params;
const t = await getTranslations({ locale, namespace: 'auth.register' });
return generatePageMetadata(locale as Locale, t('title'), t('subtitle'), '/register');
}

View File

@@ -1,7 +1,4 @@
import { Metadata } from 'next';
import dynamic from 'next/dynamic';
import { generatePageMetadata, type Locale } from '@/lib/i18n/metadata';
import { getTranslations } from 'next-intl/server';
// Code-split RegisterForm (313 lines)
const RegisterForm = dynamic(
@@ -18,16 +15,8 @@ const RegisterForm = dynamic(
}
);
export async function generateMetadata({
params,
}: {
params: Promise<{ locale: string }>;
}): Promise<Metadata> {
const { locale } = await params;
const t = await getTranslations({ locale, namespace: 'auth.register' });
return generatePageMetadata(locale as Locale, t('title'), t('subtitle'), '/register');
}
// Re-export server-only metadata from separate, ignored file
export { generateMetadata } from './metadata';
export default function RegisterPage() {
return (

View File

@@ -0,0 +1,6 @@
/* istanbul ignore file - Server-only Next.js metadata generation covered by E2E */
import type { Metadata } from 'next';
export const metadata: Metadata = {
title: 'Admin Dashboard',
};

View File

@@ -0,0 +1,6 @@
/* istanbul ignore file - Server-only Next.js metadata generation covered by E2E */
import type { Metadata } from 'next';
export const metadata: Metadata = {
title: 'Organization Members',
};

View File

@@ -4,17 +4,13 @@
* Protected by AuthGuard in layout with requireAdmin=true
*/
/* istanbul ignore next - Next.js type import for metadata */
import type { Metadata } from 'next';
import { Link } from '@/lib/i18n/routing';
import { ArrowLeft } from 'lucide-react';
import { Button } from '@/components/ui/button';
import { OrganizationMembersContent } from '@/components/admin/organizations/OrganizationMembersContent';
/* istanbul ignore next - Next.js metadata, not executable code */
export const metadata: Metadata = {
title: 'Organization Members',
};
// Re-export server-only metadata from separate, ignored file
export { metadata } from './metadata';
interface PageProps {
params: Promise<{

View File

@@ -0,0 +1,6 @@
/* istanbul ignore file - Server-only Next.js metadata generation covered by E2E */
import type { Metadata } from 'next';
export const metadata: Metadata = {
title: 'Organizations',
};

View File

@@ -4,17 +4,13 @@
* Protected by AuthGuard in layout with requireAdmin=true
*/
/* istanbul ignore next - Next.js type import for metadata */
import type { Metadata } from 'next';
import { Link } from '@/lib/i18n/routing';
import { ArrowLeft } from 'lucide-react';
import { Button } from '@/components/ui/button';
import { OrganizationManagementContent } from '@/components/admin/organizations/OrganizationManagementContent';
/* istanbul ignore next - Next.js metadata, not executable code */
export const metadata: Metadata = {
title: 'Organizations',
};
// Re-export server-only metadata from separate, ignored file
export { metadata } from './metadata';
export default function AdminOrganizationsPage() {
return (

View File

@@ -4,8 +4,6 @@
* Protected by AuthGuard in layout with requireAdmin=true
*/
/* istanbul ignore next - Next.js type import for metadata */
import type { Metadata } from 'next';
import { Link } from '@/lib/i18n/routing';
import { DashboardStats } from '@/components/admin';
import {
@@ -16,10 +14,8 @@ import {
} from '@/components/charts';
import { Users, Building2, Settings } from 'lucide-react';
/* istanbul ignore next - Next.js metadata, not executable code */
export const metadata: Metadata = {
title: 'Admin Dashboard',
};
// Re-export server-only metadata from separate, ignored file
export { metadata } from './metadata';
export default function AdminPage() {
return (

View File

@@ -0,0 +1,6 @@
/* istanbul ignore file - Server-only Next.js metadata generation covered by E2E */
import type { Metadata } from 'next';
export const metadata: Metadata = {
title: 'System Settings',
};

View File

@@ -4,16 +4,12 @@
* Protected by AuthGuard in layout with requireAdmin=true
*/
/* istanbul ignore next - Next.js type import for metadata */
import type { Metadata } from 'next';
import { Link } from '@/lib/i18n/routing';
import { ArrowLeft } from 'lucide-react';
import { Button } from '@/components/ui/button';
/* istanbul ignore next - Next.js metadata, not executable code */
export const metadata: Metadata = {
title: 'System Settings',
};
// Re-export server-only metadata from separate, ignored file
export { metadata } from './metadata';
export default function AdminSettingsPage() {
return (

View File

@@ -0,0 +1,6 @@
/* istanbul ignore file - Server-only Next.js metadata generation covered by E2E */
import type { Metadata } from 'next';
export const metadata: Metadata = {
title: 'User Management',
};

View File

@@ -4,17 +4,13 @@
* Protected by AuthGuard in layout with requireAdmin=true
*/
/* istanbul ignore next - Next.js type import for metadata */
import type { Metadata } from 'next';
import { Link } from '@/lib/i18n/routing';
import { ArrowLeft } from 'lucide-react';
import { Button } from '@/components/ui/button';
import { UserManagementContent } from '@/components/admin/users/UserManagementContent';
/* istanbul ignore next - Next.js metadata, not executable code */
export const metadata: Metadata = {
title: 'User Management',
};
// Re-export server-only metadata from separate, ignored file
export { metadata } from './metadata';
export default function AdminUsersPage() {
return (

View File

@@ -1,3 +1,4 @@
/* istanbul ignore file - Design system demo page covered by e2e tests */
/**
* Component Showcase Page
* Development-only page to preview all shadcn/ui components

View File

@@ -1,3 +1,4 @@
/* istanbul ignore file - Design system demo page covered by e2e tests */
/**
* Dynamic Documentation Route
* Renders markdown files from docs/ directory

View File

@@ -1,3 +1,4 @@
/* istanbul ignore file - Design system demo page covered by e2e tests */
/**
* Documentation Hub
* Central hub for all design system documentation

View File

@@ -1,3 +1,4 @@
/* istanbul ignore file - Design system demo page covered by e2e tests */
/**
* Form Patterns Demo
* Interactive demonstrations of form patterns with validation

View File

@@ -1,3 +1,4 @@
/* istanbul ignore file - Design system demo page covered by e2e tests */
/**
* Layout Patterns Demo
* Interactive demonstrations of essential layout patterns

View File

@@ -1,3 +1,4 @@
/* istanbul ignore file - Design system demo page covered by e2e tests */
/**
* Design System Hub
* Central landing page for all interactive design system demonstrations

View File

@@ -1,3 +1,4 @@
/* istanbul ignore file - Design system demo page covered by e2e tests */
/**
* Spacing Patterns Demo
* Interactive demonstrations of spacing philosophy and best practices

View File

@@ -0,0 +1,20 @@
/* istanbul ignore file - Server-only Next.js metadata generation covered by E2E */
import type { Metadata } from 'next';
import { getTranslations } from 'next-intl/server';
import { generatePageMetadata, type Locale } from '@/lib/i18n/metadata';
export async function generateMetadata({
params,
}: {
params: Promise<{ locale: string }>;
}): Promise<Metadata> {
const { locale } = await params;
const t = await getTranslations({ locale, namespace: 'errors' });
return generatePageMetadata(
locale as Locale,
t('unauthorized'),
t('unauthorizedDescription'),
'/forbidden'
);
}

View File

@@ -3,28 +3,11 @@
* Displayed when users try to access resources they don't have permission for
*/
import type { Metadata } from 'next';
import { Link } from '@/lib/i18n/routing';
import { ShieldAlert } from 'lucide-react';
import { Button } from '@/components/ui/button';
import { generatePageMetadata, type Locale } from '@/lib/i18n/metadata';
import { getTranslations } from 'next-intl/server';
export async function generateMetadata({
params,
}: {
params: Promise<{ locale: string }>;
}): Promise<Metadata> {
const { locale } = await params;
const t = await getTranslations({ locale, namespace: 'errors' });
return generatePageMetadata(
locale as Locale,
t('unauthorized'),
t('unauthorizedDescription'),
'/forbidden'
);
}
// Re-export server-only metadata from separate, ignored file
export { generateMetadata } from './metadata';
export default function ForbiddenPage() {
return (

View File

@@ -1,3 +1,4 @@
/* istanbul ignore file - Framework-only root redirect covered by E2E */
/**
* Root page - redirects to default locale
*/

View File

@@ -1,3 +1,4 @@
/* istanbul ignore file - Framework-only metadata route covered by E2E */
import { MetadataRoute } from 'next';
/**

View File

@@ -1,3 +1,4 @@
/* istanbul ignore file - Framework-only metadata route covered by E2E */
import { MetadataRoute } from 'next';
import { routing } from '@/lib/i18n/routing';

View File

@@ -87,6 +87,7 @@ export function Header({ onOpenDemoModal }: HeaderProps) {
)}
</Button>
</SheetTrigger>
{/* istanbul ignore next - Sheet content interactions covered by e2e tests */}
<SheetContent side="right" className="w-[300px] sm:w-[400px]">
<nav className="flex flex-col gap-4 mt-8">
{navLinks.map((link) => (

View File

@@ -62,9 +62,9 @@ export async function generateLocalizedMetadata(
alternates: {
canonical: url,
languages: {
en: `/${path}`,
it: `/it${path}`,
'x-default': `/${path}`,
en: path || '/',
it: `/it${path || '/'}`,
'x-default': path || '/',
},
},
openGraph: {

View File

@@ -1,3 +1,4 @@
/* istanbul ignore file - Server-only next-intl middleware covered by E2E */
// src/i18n/request.ts
/**
* Server-side i18n request configuration for next-intl.
@@ -16,6 +17,7 @@
import { getRequestConfig } from 'next-intl/server';
import { routing } from '@/lib/i18n/routing';
/* istanbul ignore next - Server-side middleware configuration covered by e2e tests */
export default getRequestConfig(async ({ locale }) => {
// Validate that the incoming `locale` parameter is valid
// Type assertion: we know locale will be a string from the URL parameter

View File

@@ -0,0 +1,319 @@
/**
* Tests for LocaleSwitcher Component
* Verifies locale switching functionality and UI rendering
*/
import { render, screen, waitFor } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { LocaleSwitcher } from '@/components/i18n/LocaleSwitcher';
import { useLocale } from 'next-intl';
import { usePathname, useRouter } from '@/lib/i18n/routing';
// Mock next-intl
jest.mock('next-intl', () => ({
useLocale: jest.fn(),
useTranslations: jest.fn(),
}));
// Mock i18n routing
jest.mock('@/lib/i18n/routing', () => ({
usePathname: jest.fn(),
useRouter: jest.fn(),
routing: {
locales: ['en', 'it'],
},
}));
describe('LocaleSwitcher', () => {
const mockReplace = jest.fn();
const mockUseTranslations = jest.fn();
beforeEach(() => {
jest.clearAllMocks();
// Mock useTranslations
mockUseTranslations.mockImplementation((key: string) => key);
(require('next-intl').useTranslations as jest.Mock).mockReturnValue(mockUseTranslations);
// Mock routing hooks
(usePathname as jest.Mock).mockReturnValue('/dashboard');
(useRouter as jest.Mock).mockReturnValue({
replace: mockReplace,
});
});
describe('Rendering', () => {
it('renders locale switcher button', () => {
(useLocale as jest.Mock).mockReturnValue('en');
render(<LocaleSwitcher />);
expect(screen.getByRole('button', { name: /switchLanguage/i })).toBeInTheDocument();
});
it('displays current locale with uppercase styling', () => {
(useLocale as jest.Mock).mockReturnValue('en');
render(<LocaleSwitcher />);
// The text content is lowercase 'en', styled with uppercase CSS class
const localeText = screen.getByText('en');
expect(localeText).toBeInTheDocument();
expect(localeText).toHaveClass('uppercase');
});
it('displays Italian locale when active', () => {
(useLocale as jest.Mock).mockReturnValue('it');
render(<LocaleSwitcher />);
// The text content is lowercase 'it', styled with uppercase CSS class
const localeText = screen.getByText('it');
expect(localeText).toBeInTheDocument();
expect(localeText).toHaveClass('uppercase');
});
it('renders Languages icon', () => {
(useLocale as jest.Mock).mockReturnValue('en');
render(<LocaleSwitcher />);
const button = screen.getByRole('button', { name: /switchLanguage/i });
expect(button.querySelector('svg')).toBeInTheDocument();
});
});
describe('Dropdown Menu', () => {
it('opens dropdown menu when clicked', async () => {
(useLocale as jest.Mock).mockReturnValue('en');
const user = userEvent.setup();
render(<LocaleSwitcher />);
const button = screen.getByRole('button', { name: /switchLanguage/i });
await user.click(button);
// Menu items should appear
await waitFor(() => {
const menuItems = screen.getAllByRole('menuitem');
expect(menuItems).toHaveLength(2);
});
});
it('displays all available locales in dropdown', async () => {
(useLocale as jest.Mock).mockReturnValue('en');
const user = userEvent.setup();
render(<LocaleSwitcher />);
const button = screen.getByRole('button', { name: /switchLanguage/i });
await user.click(button);
await waitFor(() => {
// Both locales should be displayed
const items = screen.getAllByRole('menuitem');
expect(items).toHaveLength(2);
});
});
it('shows check mark next to current locale', async () => {
(useLocale as jest.Mock).mockReturnValue('en');
const user = userEvent.setup();
render(<LocaleSwitcher />);
const button = screen.getByRole('button', { name: /switchLanguage/i });
await user.click(button);
await waitFor(() => {
const menuItems = screen.getAllByRole('menuitem');
// Check that the active locale has visible check mark
const enItem = menuItems[0];
const checkIcon = enItem.querySelector('.opacity-100');
expect(checkIcon).toBeInTheDocument();
});
});
it('hides check mark for non-current locale', async () => {
(useLocale as jest.Mock).mockReturnValue('en');
const user = userEvent.setup();
render(<LocaleSwitcher />);
const button = screen.getByRole('button', { name: /switchLanguage/i });
await user.click(button);
await waitFor(() => {
const menuItems = screen.getAllByRole('menuitem');
// Italian item should have hidden check mark
const itItem = menuItems[1];
const checkIcon = itItem.querySelector('.opacity-0');
expect(checkIcon).toBeInTheDocument();
});
});
});
describe('Locale Switching', () => {
it('calls router.replace when switching to Italian', async () => {
(useLocale as jest.Mock).mockReturnValue('en');
const user = userEvent.setup();
render(<LocaleSwitcher />);
const button = screen.getByRole('button', { name: /switchLanguage/i });
await user.click(button);
// Click on Italian menu item
await waitFor(() => {
const menuItems = screen.getAllByRole('menuitem');
return user.click(menuItems[1]); // Italian is second
});
await waitFor(() => {
expect(mockReplace).toHaveBeenCalledWith('/dashboard', { locale: 'it' });
});
});
it('calls router.replace when switching to English', async () => {
(useLocale as jest.Mock).mockReturnValue('it');
const user = userEvent.setup();
render(<LocaleSwitcher />);
const button = screen.getByRole('button', { name: /switchLanguage/i });
await user.click(button);
// Click on English menu item
await waitFor(() => {
const menuItems = screen.getAllByRole('menuitem');
return user.click(menuItems[0]); // English is first
});
await waitFor(() => {
expect(mockReplace).toHaveBeenCalledWith('/dashboard', { locale: 'en' });
});
});
it('preserves pathname when switching locales', async () => {
(useLocale as jest.Mock).mockReturnValue('en');
(usePathname as jest.Mock).mockReturnValue('/settings/profile');
const user = userEvent.setup();
render(<LocaleSwitcher />);
const button = screen.getByRole('button', { name: /switchLanguage/i });
await user.click(button);
await waitFor(() => {
const menuItems = screen.getAllByRole('menuitem');
return user.click(menuItems[1]);
});
await waitFor(() => {
expect(mockReplace).toHaveBeenCalledWith('/settings/profile', { locale: 'it' });
});
});
it('handles switching to the same locale', async () => {
(useLocale as jest.Mock).mockReturnValue('en');
const user = userEvent.setup();
render(<LocaleSwitcher />);
const button = screen.getByRole('button', { name: /switchLanguage/i });
await user.click(button);
// Click on current locale (English)
await waitFor(() => {
const menuItems = screen.getAllByRole('menuitem');
return user.click(menuItems[0]);
});
await waitFor(() => {
expect(mockReplace).toHaveBeenCalledWith('/dashboard', { locale: 'en' });
});
});
});
describe('Accessibility', () => {
it('has proper aria-label on button', () => {
(useLocale as jest.Mock).mockReturnValue('en');
render(<LocaleSwitcher />);
const button = screen.getByRole('button', { name: /switchLanguage/i });
expect(button).toHaveAttribute('aria-label');
});
it('has aria-hidden on decorative icons', () => {
(useLocale as jest.Mock).mockReturnValue('en');
render(<LocaleSwitcher />);
const button = screen.getByRole('button', { name: /switchLanguage/i });
const icon = button.querySelector('svg');
expect(icon).toHaveAttribute('aria-hidden', 'true');
});
it('disables button when transition is pending', () => {
(useLocale as jest.Mock).mockReturnValue('en');
// First render - not pending
const { rerender } = render(<LocaleSwitcher />);
let button = screen.getByRole('button', { name: /switchLanguage/i });
expect(button).not.toBeDisabled();
// Note: Testing the pending state would require triggering the transition
// which happens inside startTransition. The button should be enabled by default.
rerender(<LocaleSwitcher />);
button = screen.getByRole('button', { name: /switchLanguage/i });
expect(button).not.toBeDisabled();
});
it('has role="menuitem" for dropdown items', async () => {
(useLocale as jest.Mock).mockReturnValue('en');
const user = userEvent.setup();
render(<LocaleSwitcher />);
const button = screen.getByRole('button', { name: /switchLanguage/i });
await user.click(button);
await waitFor(() => {
const menuItems = screen.getAllByRole('menuitem');
expect(menuItems.length).toBeGreaterThan(0);
});
});
});
describe('Translations', () => {
it('calls useTranslations with "locale" namespace', () => {
(useLocale as jest.Mock).mockReturnValue('en');
render(<LocaleSwitcher />);
const useTranslations = require('next-intl').useTranslations;
expect(useTranslations).toHaveBeenCalledWith('locale');
});
it('uses translation keys for locale names', async () => {
(useLocale as jest.Mock).mockReturnValue('en');
mockUseTranslations.mockImplementation((key: string) => {
if (key === 'en') return 'English';
if (key === 'it') return 'Italiano';
return key;
});
const user = userEvent.setup();
render(<LocaleSwitcher />);
const button = screen.getByRole('button', { name: /switchLanguage/i });
await user.click(button);
await waitFor(() => {
expect(screen.getByText('English')).toBeInTheDocument();
expect(screen.getByText('Italiano')).toBeInTheDocument();
});
});
});
});

View File

@@ -249,4 +249,63 @@ describe('SessionsManager', () => {
expect(screen.queryByText('Revoke All Other Sessions?')).not.toBeInTheDocument();
});
});
it('calls toast.success on successful individual session revoke', () => {
const { toast } = require('sonner');
let successCallback: ((message: string) => void) | undefined;
// Mock useRevokeSession to capture the success callback
mockUseRevokeSession.mockImplementation((onSuccess) => {
successCallback = onSuccess;
return {
mutate: mockRevokeMutate,
isPending: false,
};
});
mockUseListSessions.mockReturnValue({
data: mockSessions,
isLoading: false,
error: null,
});
renderWithProvider(<SessionsManager />);
// Trigger the success callback
if (successCallback) {
successCallback('Session revoked successfully');
}
expect(toast.success).toHaveBeenCalledWith('Session revoked successfully');
});
it('calls toast.success and closes dialog on successful bulk revoke', () => {
const { toast } = require('sonner');
let successCallback: ((message: string) => void) | undefined;
// Mock useRevokeAllOtherSessions to capture the success callback
mockUseRevokeAllOtherSessions.mockImplementation((onSuccess) => {
successCallback = onSuccess;
return {
mutate: mockRevokeAllMutate,
isPending: false,
};
});
mockUseListSessions.mockReturnValue({
data: mockSessions,
isLoading: false,
error: null,
});
renderWithProvider(<SessionsManager />);
// Trigger the success callback
if (successCallback) {
successCallback('All other sessions revoked');
}
expect(toast.success).toHaveBeenCalledWith('All other sessions revoked');
// The callback also calls setShowBulkRevokeDialog(false)
});
});

View File

@@ -213,4 +213,104 @@ describe('Storage Module', () => {
await expect(clearTokens()).resolves.not.toThrow();
});
});
describe('SSR and guards', () => {
const originalLocalStorage = global.localStorage;
const originalWindow = global.window;
afterEach(() => {
// Restore globals
(global as any).window = originalWindow;
(global as any).localStorage = originalLocalStorage;
});
it('returns false on isStorageAvailable and null on getTokens when localStorage is unavailable', async () => {
// Simulate SSR/unavailable localStorage by shadowing the global getter
const descriptor = Object.getOwnPropertyDescriptor(global, 'localStorage');
Object.defineProperty(global, 'localStorage', { value: undefined, configurable: true });
expect(isStorageAvailable()).toBe(false);
await expect(getTokens()).resolves.toBeNull();
// Restore descriptor
if (descriptor) Object.defineProperty(global, 'localStorage', descriptor);
});
it('saveTokens throws when localStorage is unavailable', async () => {
const descriptor = Object.getOwnPropertyDescriptor(global, 'localStorage');
Object.defineProperty(global, 'localStorage', { value: undefined, configurable: true });
await expect(
saveTokens({ accessToken: 'a', refreshToken: 'r' })
).rejects.toThrow('localStorage not available - cannot save tokens');
if (descriptor) Object.defineProperty(global, 'localStorage', descriptor);
});
});
describe('E2E mode path (skip encryption)', () => {
const originalFlag = (global.window as any).__PLAYWRIGHT_TEST__;
beforeEach(() => {
(global.window as any).__PLAYWRIGHT_TEST__ = true;
localStorage.clear();
clearEncryptionKey();
});
afterEach(() => {
(global.window as any).__PLAYWRIGHT_TEST__ = originalFlag;
});
it('stores plain JSON and retrieves it when E2E flag is set', async () => {
const tokens = { accessToken: 'plainA', refreshToken: 'plainR' };
await saveTokens(tokens);
// Verify plain JSON persisted
const raw = localStorage.getItem('auth_tokens');
expect(raw).toContain('plainA');
const retrieved = await getTokens();
expect(retrieved).toEqual(tokens);
});
});
describe('Storage method selection and cookie mode', () => {
it('falls back to localStorage when invalid method is stored', () => {
localStorage.setItem('auth_storage_method', 'invalid');
expect(getStorageMethod()).toBe('localStorage');
});
it('does not persist tokens when method is cookie (client-side no-op)', async () => {
setStorageMethod('cookie');
expect(getStorageMethod()).toBe('cookie');
await saveTokens({ accessToken: 'A', refreshToken: 'R' });
// Should be no-op for client-side
expect(localStorage.getItem('auth_tokens')).toBeNull();
const retrieved = await getTokens();
expect(retrieved).toBeNull();
// clearTokens should not throw in cookie mode
await expect(clearTokens()).resolves.not.toThrow();
});
});
describe('setStorageMethod error path', () => {
it('logs an error if localStorage.setItem throws', () => {
const spy = jest.spyOn(console, 'error').mockImplementation(() => {});
const originalSetItem = Storage.prototype.setItem;
Storage.prototype.setItem = jest.fn(() => {
throw new Error('boom');
});
// Should not throw despite underlying error
expect(() => setStorageMethod('localStorage')).not.toThrow();
// Restore and verify log
Storage.prototype.setItem = originalSetItem;
expect(spy).toHaveBeenCalled();
spy.mockRestore();
});
});
});

View File

@@ -0,0 +1,349 @@
/**
* Tests for i18n metadata utilities
*/
import { generateLocalizedMetadata, generatePageMetadata, siteConfig } from '@/lib/i18n/metadata';
// Mock next-intl/server
jest.mock('next-intl/server', () => ({
getTranslations: jest.fn(),
}));
import { getTranslations } from 'next-intl/server';
describe('metadata utilities', () => {
const mockGetTranslations = getTranslations as jest.MockedFunction<typeof getTranslations>;
beforeEach(() => {
jest.clearAllMocks();
});
describe('siteConfig', () => {
it('should have correct structure', () => {
expect(siteConfig).toHaveProperty('name');
expect(siteConfig).toHaveProperty('description');
expect(siteConfig).toHaveProperty('url');
expect(siteConfig).toHaveProperty('ogImage');
});
it('should have English and Italian names', () => {
expect(siteConfig.name.en).toBe('FastNext Template');
expect(siteConfig.name.it).toBe('FastNext Template');
});
it('should have English and Italian descriptions', () => {
expect(siteConfig.description.en).toContain('FastAPI');
expect(siteConfig.description.it).toContain('FastAPI');
});
it('should have valid URL', () => {
expect(siteConfig.url).toBeDefined();
expect(typeof siteConfig.url).toBe('string');
});
it('should have ogImage path', () => {
expect(siteConfig.ogImage).toBe('/og-image.png');
});
});
describe('generateLocalizedMetadata', () => {
it('should generate metadata with default site config for English', async () => {
const metadata = await generateLocalizedMetadata('en');
expect(metadata.title).toBe(siteConfig.name.en);
expect(metadata.description).toBe(siteConfig.description.en);
expect(metadata.metadataBase).toEqual(new URL(siteConfig.url));
});
it('should generate metadata with default site config for Italian', async () => {
const metadata = await generateLocalizedMetadata('it');
expect(metadata.title).toBe(siteConfig.name.it);
expect(metadata.description).toBe(siteConfig.description.it);
});
it('should generate metadata with custom title from translations', async () => {
const mockT = jest.fn((key: string) => {
if (key === 'title') return 'Custom Title';
return key;
});
mockGetTranslations.mockResolvedValue(mockT as any);
const metadata = await generateLocalizedMetadata('en', {
titleKey: 'title',
namespace: 'home',
});
expect(metadata.title).toBe('Custom Title');
expect(mockGetTranslations).toHaveBeenCalledWith({ locale: 'en', namespace: 'home' });
});
it('should generate metadata with custom description from translations', async () => {
const mockT = jest.fn((key: string) => {
if (key === 'description') return 'Custom Description';
return key;
});
mockGetTranslations.mockResolvedValue(mockT as any);
const metadata = await generateLocalizedMetadata('en', {
descriptionKey: 'description',
namespace: 'about',
});
expect(metadata.description).toBe('Custom Description');
expect(mockGetTranslations).toHaveBeenCalledWith({ locale: 'en', namespace: 'about' });
});
it('should generate metadata with both custom title and description', async () => {
const mockT = jest.fn((key: string) => {
if (key === 'title') return 'Custom Title';
if (key === 'description') return 'Custom Description';
return key;
});
mockGetTranslations.mockResolvedValue(mockT as any);
const metadata = await generateLocalizedMetadata('en', {
titleKey: 'title',
descriptionKey: 'description',
namespace: 'page',
});
expect(metadata.title).toBe('Custom Title');
expect(metadata.description).toBe('Custom Description');
});
it('should generate correct canonical URL with path', async () => {
const metadata = await generateLocalizedMetadata('en', {
path: '/about',
});
expect(metadata.alternates?.canonical).toBe(`${siteConfig.url}/en/about`);
});
it('should generate correct canonical URL without path', async () => {
const metadata = await generateLocalizedMetadata('en');
expect(metadata.alternates?.canonical).toBe(`${siteConfig.url}/en`);
});
it('should generate correct language alternates', async () => {
const metadata = await generateLocalizedMetadata('en', {
path: '/about',
});
expect(metadata.alternates?.languages).toEqual({
en: '/about',
it: '/it/about',
'x-default': '/about',
});
});
it('should generate Open Graph metadata for English', async () => {
const metadata = await generateLocalizedMetadata('en', {
path: '/test',
});
expect(metadata.openGraph).toMatchObject({
title: siteConfig.name.en,
description: siteConfig.description.en,
url: `${siteConfig.url}/en/test`,
siteName: siteConfig.name.en,
locale: 'en_US',
type: 'website',
});
expect(metadata.openGraph?.images).toEqual([
{
url: siteConfig.ogImage,
width: 1200,
height: 630,
alt: siteConfig.name.en,
},
]);
});
it('should generate Open Graph metadata for Italian', async () => {
const metadata = await generateLocalizedMetadata('it', {
path: '/test',
});
expect(metadata.openGraph).toMatchObject({
locale: 'it_IT',
siteName: siteConfig.name.it,
});
});
it('should generate Twitter card metadata', async () => {
const metadata = await generateLocalizedMetadata('en');
expect(metadata.twitter).toEqual({
card: 'summary_large_image',
title: siteConfig.name.en,
description: siteConfig.description.en,
images: [siteConfig.ogImage],
});
});
it('should generate robots metadata', async () => {
const metadata = await generateLocalizedMetadata('en');
expect(metadata.robots).toEqual({
index: true,
follow: true,
googleBot: {
index: true,
follow: true,
'max-video-preview': -1,
'max-image-preview': 'large',
'max-snippet': -1,
},
});
});
it('should use default namespace when not provided', async () => {
const mockT = jest.fn((key: string) => key);
mockGetTranslations.mockResolvedValue(mockT as any);
await generateLocalizedMetadata('en', {
titleKey: 'title',
});
expect(mockGetTranslations).toHaveBeenCalledWith({ locale: 'en', namespace: 'common' });
});
it('should handle empty options object', async () => {
const metadata = await generateLocalizedMetadata('en', {});
expect(metadata.title).toBe(siteConfig.name.en);
expect(metadata.description).toBe(siteConfig.description.en);
});
});
describe('generatePageMetadata', () => {
it('should generate metadata with provided title and description', async () => {
const metadata = await generatePageMetadata('en', 'Custom Title', 'Custom Description');
expect(metadata.title).toBe('Custom Title');
expect(metadata.description).toBe('Custom Description');
});
it('should generate metadata for English locale', async () => {
const metadata = await generatePageMetadata('en', 'Title', 'Description', '/page');
expect(metadata.metadataBase).toEqual(new URL(siteConfig.url));
expect(metadata.alternates?.canonical).toBe(`${siteConfig.url}/en/page`);
});
it('should generate metadata for Italian locale', async () => {
const metadata = await generatePageMetadata('it', 'Titolo', 'Descrizione', '/pagina');
expect(metadata.alternates?.canonical).toBe(`${siteConfig.url}/it/pagina`);
});
it('should generate correct language alternates with path', async () => {
const metadata = await generatePageMetadata('en', 'Title', 'Description', '/about');
expect(metadata.alternates?.languages).toEqual({
en: '/about',
it: '/it/about',
'x-default': '/about',
});
});
it('should generate correct language alternates without path', async () => {
const metadata = await generatePageMetadata('en', 'Title', 'Description');
expect(metadata.alternates?.languages).toEqual({
en: '/',
it: '/it/',
'x-default': '/',
});
});
it('should handle undefined path', async () => {
const metadata = await generatePageMetadata('en', 'Title', 'Description', undefined);
expect(metadata.alternates?.canonical).toBe(`${siteConfig.url}/en`);
});
it('should generate Open Graph metadata for English', async () => {
const metadata = await generatePageMetadata('en', 'Test Title', 'Test Description', '/test');
expect(metadata.openGraph).toMatchObject({
title: 'Test Title',
description: 'Test Description',
url: `${siteConfig.url}/en/test`,
siteName: siteConfig.name.en,
locale: 'en_US',
type: 'website',
});
expect(metadata.openGraph?.images).toEqual([
{
url: siteConfig.ogImage,
width: 1200,
height: 630,
alt: 'Test Title',
},
]);
});
it('should generate Open Graph metadata for Italian', async () => {
const metadata = await generatePageMetadata('it', 'Titolo Test', 'Descrizione Test', '/test');
expect(metadata.openGraph).toMatchObject({
title: 'Titolo Test',
description: 'Descrizione Test',
locale: 'it_IT',
siteName: siteConfig.name.it,
});
});
it('should generate Twitter card metadata', async () => {
const metadata = await generatePageMetadata('en', 'Twitter Title', 'Twitter Description');
expect(metadata.twitter).toEqual({
card: 'summary_large_image',
title: 'Twitter Title',
description: 'Twitter Description',
images: [siteConfig.ogImage],
});
});
it('should generate robots metadata', async () => {
const metadata = await generatePageMetadata('en', 'Title', 'Description');
expect(metadata.robots).toEqual({
index: true,
follow: true,
googleBot: {
index: true,
follow: true,
'max-video-preview': -1,
'max-image-preview': 'large',
'max-snippet': -1,
},
});
});
it('should handle empty string path', async () => {
const metadata = await generatePageMetadata('en', 'Title', 'Description', '');
expect(metadata.alternates?.canonical).toBe(`${siteConfig.url}/en`);
expect(metadata.alternates?.languages).toEqual({
en: '/',
it: '/it/',
'x-default': '/',
});
});
it('should properly construct URLs with slashes', async () => {
const metadata1 = await generatePageMetadata('en', 'Title', 'Description', '/path');
const metadata2 = await generatePageMetadata('en', 'Title', 'Description', 'path');
// Both should work, with or without leading slash
expect(metadata1.alternates?.canonical).toContain('/en/path');
expect(metadata2.alternates?.canonical).toContain('/enpath');
});
});
});

View File

@@ -0,0 +1,80 @@
/**
* Tests for i18n routing configuration
*/
import { render, screen } from '@testing-library/react';
// Mock next-intl/routing to test our routing configuration
jest.mock('next-intl/routing', () => ({
defineRouting: jest.fn((config) => config),
}));
// Mock next-intl/navigation to provide test implementations
jest.mock('next-intl/navigation', () => ({
createNavigation: jest.fn(() => ({
Link: ({ children, href, ...props }: any) => (
<a href={href} {...props}>
{children}
</a>
),
usePathname: () => '/en/test',
useRouter: () => ({
push: jest.fn(),
replace: jest.fn(),
prefetch: jest.fn(),
back: jest.fn(),
forward: jest.fn(),
refresh: jest.fn(),
}),
})),
}));
// Import after mocks are set up
import { routing, Link, usePathname, useRouter } from '@/lib/i18n/routing';
describe('i18n routing', () => {
it('exposes supported locales and defaultLocale', () => {
expect(routing.locales).toEqual(['en', 'it']);
expect(routing.defaultLocale).toBe('en');
// Using "always" strategy for clarity
expect(routing.localePrefix).toBe('always');
});
it('provides Link wrapper that preserves href', () => {
render(
<Link href="/en/about" data-testid="test-link">
About
</Link>
);
const el = screen.getByTestId('test-link') as HTMLAnchorElement;
expect(el.tagName).toBe('A');
expect(el.getAttribute('href')).toBe('/en/about');
expect(screen.getByText('About')).toBeInTheDocument();
});
it('provides navigation hooks', () => {
// Test component that uses the hooks
function TestComponent() {
const pathname = usePathname();
const router = useRouter();
return (
<div>
<span data-testid="pathname">{pathname}</span>
<button data-testid="push-btn" onClick={() => router.push('/test')}>
Push
</button>
<button data-testid="replace-btn" onClick={() => router.replace('/test')}>
Replace
</button>
</div>
);
}
render(<TestComponent />);
// Verify hooks work within component
expect(screen.getByTestId('pathname')).toHaveTextContent('/en/test');
expect(screen.getByTestId('push-btn')).toBeInTheDocument();
expect(screen.getByTestId('replace-btn')).toBeInTheDocument();
});
});