refactor: extract sanitizeForTestId to shared utility

Address PR review comments by:
- Creating shared sanitizeForTestId utility in apps/ui/src/lib/utils.ts
- Updating ProjectSwitcherItem to use the shared utility
- Adding matching helper to test utils for E2E tests
- Updating all E2E tests to use the sanitization helper

This ensures the component and tests use identical sanitization logic,
making tests robust against project names with special characters.
This commit is contained in:
Stefan de Vogelaere
2026-01-18 14:36:31 +01:00
parent ef2dcbacd4
commit 1ede7e7e6a
6 changed files with 56 additions and 18 deletions

View File

@@ -1,6 +1,6 @@
import { Folder, LucideIcon } from 'lucide-react';
import * as LucideIcons from 'lucide-react';
import { cn } from '@/lib/utils';
import { cn, sanitizeForTestId } from '@/lib/utils';
import { getAuthenticatedImageUrl } from '@/lib/api-fetch';
import type { Project } from '@/lib/electron';
@@ -37,22 +37,9 @@ export function ProjectSwitcherItem({
const IconComponent = getIconComponent();
const hasCustomIcon = !!project.customIconPath;
// Create a sanitized project name for test ID:
// - Convert to lowercase
// - Replace spaces with hyphens
// - Remove all non-alphanumeric characters except hyphens
// - Collapse multiple hyphens into single hyphen
// - Trim leading/trailing hyphens
const sanitizedName = project.name
.toLowerCase()
.replace(/\s+/g, '-')
.replace(/[^a-z0-9-]/g, '')
.replace(/-+/g, '-')
.replace(/^-|-$/g, '');
// Combine project.id with sanitized name for uniqueness and readability
// Format: project-switcher-{id}-{sanitizedName}
const testId = `project-switcher-${project.id}-${sanitizedName}`;
const testId = `project-switcher-${project.id}-${sanitizeForTestId(project.name)}`;
return (
<button

View File

@@ -125,6 +125,34 @@ export const isMac =
(/Mac/.test(navigator.userAgent) ||
(navigator.platform ? navigator.platform.toLowerCase().includes('mac') : false));
/**
* Sanitize a string for use in data-testid attributes.
* Creates a deterministic, URL-safe identifier from any input string.
*
* Transformations:
* - Convert to lowercase
* - Replace spaces with hyphens
* - Remove all non-alphanumeric characters (except hyphens)
* - Collapse multiple consecutive hyphens into a single hyphen
* - Trim leading/trailing hyphens
*
* @param name - The string to sanitize (e.g., project name, feature title)
* @returns A sanitized string safe for CSS selectors and test IDs
*
* @example
* sanitizeForTestId("My Awesome Project!") // "my-awesome-project"
* sanitizeForTestId("test-project-123") // "test-project-123"
* sanitizeForTestId(" Foo Bar ") // "foo-bar"
*/
export function sanitizeForTestId(name: string): string {
return name
.toLowerCase()
.replace(/\s+/g, '-')
.replace(/[^a-z0-9-]/g, '')
.replace(/-+/g, '-')
.replace(/^-|-$/g, '');
}
/**
* Generate a UUID v4 string.
*

View File

@@ -21,6 +21,7 @@ import {
getKanbanColumn,
authenticateForTests,
handleLoginScreenIfPresent,
sanitizeForTestId,
} from '../utils';
const TEST_TEMP_DIR = createTempDirPath('manual-review-test');
@@ -132,7 +133,8 @@ test.describe('Feature Manual Review Flow', () => {
// Verify we're on the correct project (project switcher button shows project name)
// Use ends-with selector since data-testid format is: project-switcher-{id}-{sanitizedName}
await expect(page.locator(`[data-testid$="-${projectName}"]`)).toBeVisible({
const sanitizedProjectName = sanitizeForTestId(projectName);
await expect(page.locator(`[data-testid$="-${sanitizedProjectName}"]`)).toBeVisible({
timeout: 10000,
});

View File

@@ -14,6 +14,7 @@ import {
authenticateForTests,
handleLoginScreenIfPresent,
waitForNetworkIdle,
sanitizeForTestId,
} from '../utils';
const TEST_TEMP_DIR = createTempDirPath('project-creation-test');
@@ -79,7 +80,8 @@ test.describe('Project Creation', () => {
// Wait for project to be set as current and visible on the page
// The project name appears in the project switcher button
// Use ends-with selector since data-testid format is: project-switcher-{id}-{sanitizedName}
await expect(page.locator(`[data-testid$="-${projectName}"]`)).toBeVisible({
const sanitizedProjectName = sanitizeForTestId(projectName);
await expect(page.locator(`[data-testid$="-${sanitizedProjectName}"]`)).toBeVisible({
timeout: 15000,
});

View File

@@ -18,6 +18,7 @@ import {
authenticateForTests,
handleLoginScreenIfPresent,
waitForNetworkIdle,
sanitizeForTestId,
} from '../utils';
// Create unique temp dir for this test run
@@ -159,7 +160,8 @@ test.describe('Open Project', () => {
// The project name appears in the project switcher button
// Use ends-with selector since data-testid format is: project-switcher-{id}-{sanitizedName}
if (targetProjectName) {
await expect(page.locator(`[data-testid$="-${targetProjectName}"]`)).toBeVisible({
const sanitizedName = sanitizeForTestId(targetProjectName);
await expect(page.locator(`[data-testid$="-${sanitizedName}"]`)).toBeVisible({
timeout: 15000,
});
}

View File

@@ -1,5 +1,22 @@
import { Page, Locator } from '@playwright/test';
/**
* Sanitize a string for use in data-testid selectors.
* This mirrors the sanitizeForTestId function in apps/ui/src/lib/utils.ts
* to ensure tests use the same sanitization logic as the component.
*
* @param name - The string to sanitize (e.g., project name)
* @returns A sanitized string safe for CSS selectors
*/
export function sanitizeForTestId(name: string): string {
return name
.toLowerCase()
.replace(/\s+/g, '-')
.replace(/[^a-z0-9-]/g, '')
.replace(/-+/g, '-')
.replace(/^-|-$/g, '');
}
/**
* Get an element by its data-testid attribute
*/