chore(scheduler): run onboarding-audit-agent (daily)

- Executed onboarding-audit-agent
- Identified missing Playwright browser installation in docs
- Updated README.md and CONTRIBUTING.md
- Created ONBOARDING_REPORT.md
- Created completion log

Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
google-labs-jules[bot]andPR0M3TH3AN committed 2026-02-15 09:00:04 +00:00
1 parent 5b188bca31
commit 699fa507b6
4 files changed
+54 -27

No files matched your search

+2 -1
View File
@@ -99,10 +99,11 @@ To set up the project locally:
- **NPM**: v10 or higher (included with Node 22).
2. **Install Dependencies**:
Use `npm ci` to ensure you get the exact dependencies from `package-lock.json`.
Use `npm ci` to ensure you get the exact dependencies from `package-lock.json`. If you intend to run smoke or visual tests, also install Playwright browsers.
```bash
npm ci
npx playwright install
```
3. **Start the Application**:
+32 -25
View File
@@ -1,32 +1,39 @@
# Developer Onboarding Audit
# Onboarding Audit Report
**Date:** 2026-02-12
**Environment:** Linux (x64) | Node.js v22
**Date:** 2026-02-15
**Agent:** onboarding-audit-agent
**Status:** ⚠️ Onboarding failures found (Fixed in this run)
## Steps Executed
## Environment
- **Node:** v22.22.0
- **NPM:** 11.10.0
- **OS:** Linux
1. `npm ci`: Successful.
2. `npm run build:css`: Successful.
3. `npm run format`: Successful.
4. `npm run build`: Successful (required for full lint coverage).
5. `npm run lint`: Successful.
- `lint:assets` skipped initially when `dist/` was missing, then passed after `npm run build`.
- `lint:sw-compat` skipped due to missing git history (expected in shallow clones).
6. `npm run test:unit`: Successful (13 tests passed).
## Executed Steps (Clean Environment)
## Findings
| Step | Command | Result | Notes |
|------|---------|--------|-------|
| 1 | `npm ci` | ✅ Pass | Installed dependencies successfully. |
| 2 | `npm run build` | ✅ Pass | Build verified manually (simulating `npm start` build step). |
| 3 | `npm run test:unit:shard1` | ✅ Pass | Unit tests passed. |
| 4 | `npm run test:smoke` | ❌ Fail / ✅ Pass | Failed initially due to missing Playwright browsers. Passed after running `npx playwright install`. |
| 5 | `npm run format` | ✅ Pass | Format check passed. |
| 6 | `npm run lint` | ✅ Pass | Lint check passed. |
- **Reliability:** The onboarding steps are robust. Dependencies installed correctly, and build/test scripts executed without error.
- **Documentation:**
- `README.md` correctly lists `npm ci`, `npm start` (which builds), and `npm run test:unit`. It was missing `npm run lint` in the "Verify setup" checklist.
- `CONTRIBUTING.md` correctly lists `npm run format` and `npm run lint`. It did not explicitly mention that `npm run build` is a prerequisite for `lint:assets` (though the lint script handles the missing build gracefully).
- **Dev Container:** The `.devcontainer/devcontainer.json` uses `mcr.microsoft.com/devcontainers/javascript-node:22` which aligns with the project's requirement. However, `postCreateCommand` uses `npx playwright install` without `--with-deps`, which might fail if system dependencies are missing in the base image.
- **Node Version:** `package.json` correctly enforces `"engines": { "node": ">=22" }`.
## Failures & Fixes
## Recommendations Implemented
### 1. Missing Playwright Browsers
**Command:** `npm run test:smoke`
**Failure:**
```
browserType.launch: Executable doesn't exist at /home/jules/.cache/ms-playwright/chromium_headless_shell-1208/chrome-headless-shell-linux64/chrome-headless-shell
Looks like Playwright Test or Playwright was just installed or updated.
Please run the following command to download new browsers:
npx playwright install
```
**Root Cause:** `npm ci` installs the `@playwright/test` package but does not download the browser binaries required for smoke and visual tests. The documentation did not mention this step for local setup.
**Fix:** Updated `README.md` and `CONTRIBUTING.md` to include `npx playwright install` as a required step for running these tests.
1. **Documentation Updates:**
- Added `npm run lint` to `README.md` verification steps.
- Clarified build prerequisites for linting in `CONTRIBUTING.md`.
2. **Dev Container Robustness:**
- Updated `.devcontainer/devcontainer.json` to use `npx playwright install --with-deps`.
## Documentation Updates
- **README.md**: Added `npx playwright install` note to "Local Setup".
- **CONTRIBUTING.md**: Added `npx playwright install` note to "Development Setup".
+2 -1
View File
@@ -143,10 +143,11 @@ To run **bitvid** locally:
2. Install dependencies:
The project requires Node.js v22 or higher. Use `npm ci` to install dependencies exactly as specified in `package-lock.json`.
Use `npm ci` to install dependencies exactly as specified in `package-lock.json`. If you intend to run smoke or visual tests, also install Playwright browsers.
```bash
npm ci
npx playwright install
```
3. Start the application:
@@ -0,0 +1,18 @@
# Onboarding Audit Agent Completed
**Agent:** onboarding-audit-agent
**Date:** 2026-02-15
**Result:** ⚠️ Fixed documentation failures
## Summary
Executed onboarding audit against clean environment.
- `npm ci`, `npm run build`, `npm run test:unit:shard1` passed.
- `npm run test:smoke` failed due to missing Playwright browsers.
- `npm run format`, `npm run lint` passed.
## Actions Taken
- Updated `README.md` and `CONTRIBUTING.md` to include `npx playwright install` requirement for smoke/visual tests.
- Updated `ONBOARDING_REPORT.md`.
## Artifacts
- `ONBOARDING_REPORT.md`