diff --git a/KNOWN_ISSUES.md b/KNOWN_ISSUES.md index dfa1d1ae..c47cc582 100644 --- a/KNOWN_ISSUES.md +++ b/KNOWN_ISSUES.md @@ -7,18 +7,3 @@ ### Visual Regression Tests (`test:visual`) - **Artifact Retention**: Visual tests are configured to retain screenshots, traces, and videos on failure to assist with debugging. These artifacts can be found in `artifacts/test-results/`. - -## CSS / Design System -- The global CSS (`css/tailwind.source.css`) was updated to fix a linter error by using `calc(theme("screens.md") - var(--breakpoint-edge-offset))` instead of raw pixels. - -## Retrospective & Future Improvements - -### Challenges -- **Generated Artifacts**: The build process modifies `css/tailwind.generated.css`, which creates noise in diffs and potential merge conflicts. It is recommended to ignore this file in version control or enforce a check that it matches the build output without committing it manually in every PR. -- **Test Environment Isolation**: Debugging visual test failures was difficult without access to the live browser UI or artifacts. The reproduction script failed due to environment restrictions on launching browsers. -- **Test Flakiness**: E2E tests for modals are prone to timeouts, likely due to animation/transition handling or resource loading delays in the CI environment. Using `applyReducedMotion` consistently helps but doesn't solve all timing issues. - -### Suggestions -- **Commit Hooks**: Implement a pre-commit hook that runs the linter and potentially the build to ensure generated files are in sync, or configure CI to fail if they are not. -- **Dockerized Testing**: Running tests in a consistent Docker container with Xvfb properly configured would help reproduce environment-specific failures locally. -- **Visual Testing improvements**: Ensure that test fixtures (like `moderation/fixtures/index.html`) correctly force UI updates after state injection to avoid race conditions. diff --git a/issues/pre-commit-hooks.md b/issues/pre-commit-hooks.md new file mode 100644 index 00000000..9254ca81 --- /dev/null +++ b/issues/pre-commit-hooks.md @@ -0,0 +1,4 @@ +# Implement Pre-commit Hooks + +**Suggestion:** +Implement a pre-commit hook that runs the linter and potentially the build to ensure generated files are in sync, or configure CI to fail if they are not. diff --git a/issues/test-env-isolation.md b/issues/test-env-isolation.md new file mode 100644 index 00000000..2a6601bd --- /dev/null +++ b/issues/test-env-isolation.md @@ -0,0 +1,7 @@ +# Test Environment Isolation & Dockerized Testing + +**Problem:** +Debugging visual test failures was difficult without access to the live browser UI or artifacts. The reproduction script failed due to environment restrictions on launching browsers. + +**Suggestion:** +Running tests in a consistent Docker container with Xvfb properly configured would help reproduce environment-specific failures locally. diff --git a/issues/test-flakiness.md b/issues/test-flakiness.md new file mode 100644 index 00000000..3782ee24 --- /dev/null +++ b/issues/test-flakiness.md @@ -0,0 +1,4 @@ +# Test Flakiness (Modals) + +**Problem:** +E2E tests for modals are prone to timeouts, likely due to animation/transition handling or resource loading delays in the CI environment. Using `applyReducedMotion` consistently helps but doesn't solve all timing issues. diff --git a/issues/visual-testing-improvements.md b/issues/visual-testing-improvements.md new file mode 100644 index 00000000..e873becb --- /dev/null +++ b/issues/visual-testing-improvements.md @@ -0,0 +1,4 @@ +# Visual Testing Improvements + +**Suggestion:** +Ensure that test fixtures (like `moderation/fixtures/index.html`) correctly force UI updates after state injection to avoid race conditions.