mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-10-27 07:52:24 +00:00
docs: update KNOWN_ISSUES.md and triage environment issues
- Update KNOWN_ISSUES.md to reflect current environment status (missing devDependencies). - Create issues/test-env-deps.md to document missing dependencies preventing test runs. - Create issues/popover-flip-bug.md to document the persistent popover flip bug. - Update timestamps and references in KNOWN_ISSUES.md. Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
1 parent
ec50db8645
commit
c6cb9e6785
3 files changed
+87
-2
No files matched your search
+20
-2
@@ -1,14 +1,32 @@
|
||||
# Known Issues
|
||||
|
||||
## Environment
|
||||
|
||||
### Missing Dependencies
|
||||
|
||||
The current development environment is missing critical `devDependencies` (`jsdom`, `playwright`, `fake-indexeddb`), preventing many test suites from running.
|
||||
|
||||
- **Affected:** `tests/app/channel-profile-moderation.test.mjs`, `test:dm:unit`, `test:dm:integration`, `test:e2e`, `test:visual`.
|
||||
- **Reference:** `issues/test-env-deps.md`
|
||||
- **Last checked:** 2026-02-08
|
||||
|
||||
## Tests
|
||||
|
||||
### Unit Tests
|
||||
- `npm run test:unit` may time out in resource-constrained environments (like CI) when running the full suite serially. CI workflows use sharding (`test:unit:shardX`) to mitigate this. Targeted testing (`test:dm:unit`, `test:dm:integration`) is recommended for local development focus. (Last checked: 2025-02-23)
|
||||
|
||||
- `npm run test:unit` generally passes, but `tests/app/channel-profile-moderation.test.mjs` fails due to missing `jsdom`.
|
||||
- Timeouts may occur in resource-constrained environments (like CI) when running the full suite serially. CI workflows use sharding (`test:unit:shardX`) to mitigate this. Targeted testing (`test:dm:unit`, `test:dm:integration`) is recommended for local development focus but currently fails due to missing `fake-indexeddb`. (Last checked: 2026-02-08)
|
||||
|
||||
### Skipped Tests
|
||||
|
||||
The following tests are skipped due to flakiness or environmental issues and should be investigated:
|
||||
|
||||
- `tests/e2e/popover.spec.ts`: `keeps the bottom-right grid menu inside the viewport` (Visual regression layout issue: Floating UI `flip` middleware fails to respect viewport boundary in constrained height scenarios. Verified 2025-02-23, fix attempt failed.)
|
||||
- `tests/e2e/popover.spec.ts`: `keeps the bottom-right grid menu inside the viewport`
|
||||
- **Issue:** Visual regression layout issue: Floating UI `flip` middleware fails to respect viewport boundary in constrained height scenarios.
|
||||
- **Reference:** `issues/popover-flip-bug.md`
|
||||
- **Status:** Verification attempted 2026-02-08 but failed due to missing `@playwright/test`. (Verified 2025-02-23, fix attempt failed.)
|
||||
|
||||
### 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/`.
|
||||
- **Note:** `test:visual` currently fails due to missing `@playwright/test`.
|
||||
@@ -0,0 +1,37 @@
|
||||
# Popover Flip Bug in Constrained Viewports
|
||||
|
||||
## Problem
|
||||
|
||||
The popover (using Floating UI `flip` middleware) fails to respect viewport boundaries in constrained height scenarios, causing it to overlap or be cut off instead of flipping to the top.
|
||||
|
||||
## Affected Components
|
||||
|
||||
- `js/ui/overlay/popoverEngine.js`
|
||||
- Popovers triggered from `data-test-trigger="grid-bottom-right"` (e.g., in `tests/e2e/popover.spec.ts`).
|
||||
|
||||
## Reproduction Steps
|
||||
|
||||
1. Open a popover near the bottom of a constrained viewport.
|
||||
2. Ensure there is enough space above the popover to flip.
|
||||
3. Observe that the popover stays at the bottom and is clipped.
|
||||
|
||||
## Test Case
|
||||
|
||||
- `tests/e2e/popover.spec.ts`: "keeps the bottom-right grid menu inside the viewport" (skipped).
|
||||
|
||||
## History
|
||||
|
||||
- **2025-02-23**: Verification failed. Fix attempt failed.
|
||||
- **2026-02-08**: Verification attempted but failed due to missing environment dependencies (`@playwright/test`).
|
||||
|
||||
## Possible Causes
|
||||
|
||||
- Misconfiguration of `flip` middleware (padding, boundary).
|
||||
- Conflict with `shift` middleware.
|
||||
- Viewport detection issues in constrained test environment.
|
||||
|
||||
## Tags
|
||||
|
||||
- ui
|
||||
- bug
|
||||
- floating-ui
|
||||
@@ -0,0 +1,30 @@
|
||||
# Test Environment Missing Dependencies
|
||||
|
||||
## Problem
|
||||
|
||||
The current development environment is missing several `devDependencies` that are listed in `package.json`. This prevents running certain test suites.
|
||||
|
||||
## Affected Dependencies
|
||||
|
||||
- `jsdom`: Required for `tests/app/channel-profile-moderation.test.mjs`.
|
||||
- `fake-indexeddb`: Required for `test:dm:unit` and `test:dm:integration`.
|
||||
- `@playwright/test` (and `playwright`): Required for E2E tests (`test:e2e`, `tests/e2e/popover.spec.ts`, etc.) and visual regression tests (`test:visual`).
|
||||
|
||||
## Impact
|
||||
|
||||
- `npm run test:unit` fails partially (`tests/app/channel-profile-moderation.test.mjs` fails with `ERR_MODULE_NOT_FOUND`).
|
||||
- `npm run test:dm:unit` fails completely.
|
||||
- `npm run test:dm:integration` fails completely.
|
||||
- `npm run test:e2e` fails completely.
|
||||
- `npm run test:visual` fails completely.
|
||||
|
||||
## Notes
|
||||
|
||||
- `npm install` is restricted in this environment, preventing easy re-installation.
|
||||
- This issue was verified on 2026-02-08.
|
||||
|
||||
## Tags
|
||||
|
||||
- environment
|
||||
- testing
|
||||
- dependencies
|
||||
Reference in new issue
Block a user