Skip to content

Add tests via Vitest to React framework package #54

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
fabian-hiller wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add tests via Vitest to React framework package #54

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion frameworks/react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
},
"scripts": {
"build": "tsdown",
"test": "vitest run --typecheck",
"lint": "eslint \"src/**/*.ts*\" && tsc --noEmit",
"lint.fix": "eslint \"src/**/*.ts*\" --fix",
"format": "prettier --write ./src",
Expand All @@ -43,20 +44,26 @@
"@eslint/js": "^9.39.1",
"@formisch/core": "workspace:*",
"@formisch/methods": "workspace:*",
"@testing-library/dom": "^10.4.0",
"@testing-library/jest-dom": "^6.6.0",
"@testing-library/react": "^16.3.0",
"@types/node": "^24.10.1",
"@types/react": "^19.2.5",
"@types/react-dom": "^19.2.3",
"@vitejs/plugin-react": "^5.1.1",
"@vitest/coverage-v8": "^3.2.4",
"eslint": "^9.39.1",
"eslint-plugin-react-hooks": "^7.0.1",
"eslint-plugin-react-refresh": "^0.4.24",
"globals": "^16.5.0",
"jsdom": "^26.1.0",
"react": "^19.2.1",
"react-dom": "^19.2.1",
"tsdown": "^0.16.8",
"typescript": "~5.9.3",
"typescript-eslint": "^8.46.4",
"vite": "^7.2.4"
"vite": "^7.2.4",
"vitest": "^3.2.4"
},
"peerDependencies": {
"react": "^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",
Expand Down
252 changes: 252 additions & 0 deletions frameworks/react/src/components/Field/Field.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,252 @@
import { fireEvent, render, screen, waitFor } from '@testing-library/react';
import type { ReactElement } from 'react';
import * as v from 'valibot';
import { describe, expect, test } from 'vitest';
import { useForm } from '../../hooks/index.ts';
import { Field } from './Field.tsx';

describe('Field', () => {
describe('rendering', () => {
test('should render children with field store', () => {
function TestField(): ReactElement {
const form = useForm({
schema: v.object({ name: v.string() }),
});

return (
<Field of={form} path={['name']}>
{(field) => (
<input
data-testid="input"
{...field.props}
value={field.input ?? ''}
/>
)}
</Field>
);
}

render(<TestField />);

expect(screen.getByTestId('input')).toBeInTheDocument();
});

test('should provide field input value', () => {
function TestFieldWithValue(): ReactElement {
const form = useForm({
schema: v.object({ name: v.string() }),
initialInput: { name: 'John' },
});

return (
<Field of={form} path={['name']}>
{(field) => (
<input
data-testid="input"
{...field.props}
value={field.input ?? ''}
/>
)}
</Field>
);
}

render(<TestFieldWithValue />);

const input = screen.getByTestId('input') as HTMLInputElement;
expect(input.value).toBe('John');
});
});

describe('field state', () => {
test('should provide field state to children', () => {
function StateField(): ReactElement {
const form = useForm({
schema: v.object({ email: v.string() }),
});

return (
<Field of={form} path={['email']}>
{(field) => (
<div>
<input data-testid="input" {...field.props} />
<span data-testid="touched">{String(field.isTouched)}</span>
<span data-testid="dirty">{String(field.isDirty)}</span>
<span data-testid="valid">{String(field.isValid)}</span>
</div>
)}
</Field>
);
}

render(<StateField />);

expect(screen.getByTestId('touched')).toHaveTextContent('false');
expect(screen.getByTestId('dirty')).toHaveTextContent('false');
expect(screen.getByTestId('valid')).toHaveTextContent('true');
});

test('should update isTouched on focus', async () => {
function TouchField(): ReactElement {
const form = useForm({
schema: v.object({ name: v.string() }),
});

return (
<Field of={form} path={['name']}>
{(field) => (
<div>
<input data-testid="input" {...field.props} />
<span data-testid="touched">{String(field.isTouched)}</span>
</div>
)}
</Field>
);
}

render(<TouchField />);

expect(screen.getByTestId('touched')).toHaveTextContent('false');

fireEvent.focus(screen.getByTestId('input'));

await waitFor(() => {
expect(screen.getByTestId('touched')).toHaveTextContent('true');
});
});
});

describe('error handling', () => {
test('should display errors from validation', async () => {
function ErrorField(): ReactElement {
const form = useForm({
schema: v.object({
email: v.pipe(v.string(), v.email('Invalid email')),
}),
validate: 'initial',
initialInput: { email: 'invalid' },
});

return (
<Field of={form} path={['email']}>
{(field) => (
<div>
<input data-testid="input" {...field.props} />
{field.errors && (
<span data-testid="error">{field.errors[0]}</span>
)}
</div>
)}
</Field>
);
}

render(<ErrorField />);

await waitFor(() => {
expect(screen.getByTestId('error')).toHaveTextContent('Invalid email');
});
});
});

describe('nested paths', () => {
test('should handle nested object paths', () => {
function NestedField(): ReactElement {
const form = useForm({
schema: v.object({
user: v.object({
profile: v.object({
name: v.string(),
}),
}),
}),
initialInput: {
user: { profile: { name: 'John' } },
},
});

return (
<Field of={form} path={['user', 'profile', 'name']}>
{(field) => (
<input
data-testid="input"
{...field.props}
value={field.input ?? ''}
/>
)}
</Field>
);
}

render(<NestedField />);

const input = screen.getByTestId('input') as HTMLInputElement;
expect(input.value).toBe('John');
});

test('should handle array index paths', () => {
function ArrayField(): ReactElement {
const form = useForm({
schema: v.object({
items: v.array(v.string()),
}),
initialInput: { items: ['first', 'second'] },
});

return (
<div>
<Field of={form} path={['items', 0]}>
{(field) => (
<input
data-testid="input-0"
{...field.props}
value={field.input ?? ''}
/>
)}
</Field>
<Field of={form} path={['items', 1]}>
{(field) => (
<input
data-testid="input-1"
{...field.props}
value={field.input ?? ''}
/>
)}
</Field>
</div>
);
}

render(<ArrayField />);

expect((screen.getByTestId('input-0') as HTMLInputElement).value).toBe(
'first'
);
expect((screen.getByTestId('input-1') as HTMLInputElement).value).toBe(
'second'
);
});
});

describe('props integration', () => {
test('should provide props with correct name', () => {
function PropsField(): ReactElement {
const form = useForm({
schema: v.object({ username: v.string() }),
});

return (
<Field of={form} path={['username']}>
{(field) => <input data-testid="input" {...field.props} />}
</Field>
);
}

render(<PropsField />);

const input = screen.getByTestId('input');
// The name is the stringified path
expect(input).toHaveAttribute('name', '["username"]');
});
});
});
Loading
Loading