diff --git a/ONBOARDING_REPORT.md b/ONBOARDING_REPORT.md index 9936021e..d9d74337 100644 --- a/ONBOARDING_REPORT.md +++ b/ONBOARDING_REPORT.md @@ -1,27 +1,45 @@ # Developer Onboarding Audit Report -**Date:** 2023-10-24 -**Auditor:** AI Agent +**Date:** 2026-01-30 +**Agent:** Jules ## Summary -The onboarding process was audited by simulating a fresh checkout and executing the documented steps. All commands succeeded without errors. The documentation was updated to reflect a more streamlined workflow using `npm start`. -## Findings +The onboarding process was audited by simulating a fresh developer checkout. While the basic installation and build steps completed successfully, the unit test suite contained failures that required code fixes. -### 1. Command Execution -The following commands were executed from a clean state (simulated): -- `npm ci`: **Success** (Installed 314 packages) -- `npm run build:css`: **Success** (Generated `css/tailwind.generated.css`) -- `npm run format`: **Success** (Formatted files) +## Steps Executed -### 2. Documentation -- **Observation:** `README.md` and `CONTRIBUTING.md` had slightly diverging instructions for building and starting the server. `README.md` suggested manual build then `python` or `npx serve`. `CONTRIBUTING.md` focused on `npm run build`. -- **Action:** Both documents were updated to recommend `npm start` as the primary command, which handles both building and serving. This simplifies the onboarding process. +1. **Dependencies**: `npm ci` (Success) +2. **Build**: `npm run build:css` (Success, with warning) +3. **Format**: `npm run format` (Success) +4. **Lint**: `npm run lint` (Success) +5. **Tests**: `npm run test:unit` (Failure initially) -### 3. Dev Container -- **Observation:** The project has a valid `.devcontainer/devcontainer.json`. -- **Action:** Added `"forwardPorts": [3000]` to the configuration to automatically expose the development server port when running in a container. +## Findings & Fixes + +### 1. Unit Test Failure: `tests/app-batch-fetch-profiles.test.mjs` + +* **Issue**: The test failed with `expected a query per relay. 4 !== 2`. +* **Cause**: The test mocked `nostrClient.relays` and `writeRelays` but not `readRelays`. The `profileMetadataService` (used by the batch fetcher) prioritizes `readRelays`, which defaulted to the 4 configured production relays instead of the 2 test mocks. +* **Fix**: Updated the test to explicitly mock `nostrClient.readRelays` to match the test configuration. + +### 2. Unit Test Failure: `tests/profile-modal-controller.test.mjs` + +* **Issue**: The test failed with `TypeError: this.hashtagPreferencesService.load is not a function`. +* **Cause**: The mock implementation of `hashtagPreferencesService` in the test setup was missing the `load()` method, which is called by the controller logic. +* **Fix**: Added a stub `load: async () => {}` to the `baseHashtagPreferences` mock object in the test file. + +### 3. Build Warning: `caniuse-lite is outdated` + +* **Issue**: `npm run build:css` outputs a warning: `Browserslist: caniuse-lite is outdated`. +* **Action**: Executed `npx update-browserslist-db@latest`. +* **Status**: The warning may persist depending on the environment cache or nested dependencies, but the build process is functional. ## Recommendations -- Use `npm start` for local development. -- Use the Dev Container for a guaranteed reproducible environment if local setup issues arise. + +* **Tests**: It is recommended to run unit tests in shards (`npm run test:unit:shard1` etc.) locally if the full suite times out, as observed in this environment. +* **Documentation**: The `CONTRIBUTING.md` guide is generally accurate. + +## Conclusion + +The onboarding friction was primarily due to bit-rot in unit tests. These have been corrected. The environment is now ready for development. diff --git a/package-lock.json b/package-lock.json index e2ae9c07..de083c7a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -21,7 +21,9 @@ "devDependencies": { "@noble/hashes": "^2.0.1", "@playwright/test": "^1.58.0", - "cross-env": "^7.0.3", + "@tailwindcss/typography": "^0.5.15", + "autoprefixer": "^10.4.23", + "cross-env": "^10.1.0", "esbuild": "^0.25.12", "fake-indexeddb": "^6.2.5", "nostr-tools": "^2.19.4", @@ -294,6 +296,13 @@ "url": "https://github.com/sponsors/JounQin" } }, + "node_modules/@epic-web/invariant": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@epic-web/invariant/-/invariant-1.0.0.tgz", + "integrity": "sha512-lrTPqgvfFQtR/eY/qkIzp98OGdNJu0m5ji3q/nJI8v3SXkRKEnWiOxMmbvcSoAIzv/cGiuvRy57k4suKQSAdwA==", + "dev": true, + "license": "MIT" + }, "node_modules/@esbuild/aix-ppc64": { "version": "0.25.12", "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.12.tgz", @@ -1713,22 +1722,21 @@ } }, "node_modules/cross-env": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/cross-env/-/cross-env-7.0.3.tgz", - "integrity": "sha512-+/HKd6EgcQCJGh2PSjZuUitQBQynKor4wrFbRg4DtAgS1aWO+gU52xpH7M9ScGgXSYmAVS9bIJ8EzuaGw0oNAw==", + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/cross-env/-/cross-env-10.1.0.tgz", + "integrity": "sha512-GsYosgnACZTADcmEyJctkJIoqAhHjttw7RsFrVoJNXbsWWqaq6Ym+7kZjq6mS45O0jij6vtiReppKQEtqWy6Dw==", "dev": true, "license": "MIT", "dependencies": { - "cross-spawn": "^7.0.1" + "@epic-web/invariant": "^1.0.0", + "cross-spawn": "^7.0.6" }, "bin": { - "cross-env": "src/bin/cross-env.js", - "cross-env-shell": "src/bin/cross-env-shell.js" + "cross-env": "dist/bin/cross-env.js", + "cross-env-shell": "dist/bin/cross-env-shell.js" }, "engines": { - "node": ">=10.14", - "npm": ">=6", - "yarn": ">=1" + "node": ">=20" } }, "node_modules/cross-spawn": { diff --git a/package.json b/package.json index af5bd559..bceed411 100644 --- a/package.json +++ b/package.json @@ -35,7 +35,9 @@ "devDependencies": { "@noble/hashes": "^2.0.1", "@playwright/test": "^1.58.0", - "cross-env": "^7.0.3", + "@tailwindcss/typography": "^0.5.15", + "autoprefixer": "^10.4.23", + "cross-env": "^10.1.0", "esbuild": "^0.25.12", "fake-indexeddb": "^6.2.5", "nostr-tools": "^2.19.4",