diff --git a/docs/oss/upstream-fixes.md b/docs/oss/upstream-fixes.md new file mode 100644 index 0000000..b16ee13 --- /dev/null +++ b/docs/oss/upstream-fixes.md @@ -0,0 +1,216 @@ +# Upstream fixes for the main Waggle project + +This log lists defects in the main Waggle project that we found while preparing the open-source demo edition. Each entry describes what we observed, why it happens, what we did, and what we recommend changing in the main project. + +Changes made only to meet the OSS scope (removing billing, tiers, KVARK, team mode and similar) are not defects and are not listed here. + +Baseline: commit `b20b138` of `git.os-dev.tech/oleg.m/waggle-os`. + +## Status values + +- **Fixed**: fixed in the OSS edition. The same fix is recommended for the main project. +- **Workaround**: worked around without changing the code. The main project needs a proper fix. +- **Open**: found, not fixed yet. + +## Entry template + +``` +### UF-NNN. Short title +- Status: Fixed | Workaround | Open +- Found: YYYY-MM-DD +- Where: path/to/file.ts:line +- Symptom: what the user or developer sees +- Cause: why it happens +- What we did: change in the OSS edition, or workaround +- Recommendation: what to change in the main project +``` + +## Summary + +| ID | Title | Status | Area | +|---|---|---|---| +| UF-001 | Vendored PptxGenJS runtime is missing from the repository | Fixed | Build, git | +| UF-002 | Setup instructions skip the package build step | Open | Docs, build | +| UF-003 | `npm run dev:web` cannot authenticate against the sidecar | Workaround | Web UI, sidecar | +| UF-004 | Packaged macOS and Linux apps likely cannot find the sidecar | Open | Desktop shell | +| UF-005 | Live Stripe webhook secret in git history | Open | Security | +| UF-006 | Conflicting license files in weaver and optimizer | Open | Licensing | +| UF-007 | Onboarding Industry dropdown opens invisibly under the scrim | Fixed | Web UI | +| UF-008 | Local model downloads are cancelled after five minutes | Fixed | Sidecar, local models | +| UF-009 | Model recommendations assume a smaller quantization than the one downloaded | Open | Local models | +| UF-010 | Brand fonts are declared but never loaded | Open | Web UI | +| UF-011 | Token-based shadows compile to nothing | Open | Web UI | +| UF-012 | Border-radius scale is inverted | Open | Web UI | +| UF-013 | Notification fetch failure shows "All caught up" | Open | Web UI | +| UF-014 | Timeline "Edit" button has no action | Open | Web UI | +| UF-015 | Ctrl+Shift+digit app shortcuts never fire | Open | Web UI | +| UF-016 | Tailwind `dark:` variants never apply | Open | Web UI | +| UF-017 | Startup text is invisible in the light theme | Open | Web UI | +| UF-018 | Default model shown in the top bar disagrees with Model Pilot | Open | Web UI, models | +| UF-019 | Memory count pluralization: "1 Memories" | Open | Web UI | +| UF-020 | WhatsApp connector bundles GPL-3.0 code into the sidecar | Open | Licensing | +| UF-021 | Settings visual-regression baseline is ignored by git | Fixed | Tests, git | + +## Entries + +### UF-001. Vendored PptxGenJS runtime is missing from the repository +- Status: Fixed +- Found: 2026-09-27 +- Where: `.gitignore:14` (rule `dist`); `vendor/pptxgenjs/package.json` (`main` points to `dist/pptxgen.cjs.js`) +- Symptom: on a fresh clone, `npm run dev:server` crashes with `ERR_MODULE_NOT_FOUND` for `packages/agent/node_modules/pptxgenjs/dist/pptxgen.cjs.js`. +- Cause: the generic `dist` ignore rule keeps the vendored runtime file out of git. The file exists only on machines where it was created by hand. +- What we did: restored the file locally from npm `pptxgenjs@4.0.1`. The vendored `types/index.d.ts` and `LICENSE` are byte-identical to that release, so the runtime is assumed to be unmodified. SHA-256 of the restored file: `873d182a8e2e1c0b5e522ef146117936b96b9b2024667bd4c1de59e2b031d27a`. On 2026-10-15 we added the exception `!vendor/*/dist/` to `.gitignore`, marked `vendor/**` as `-text` in `.gitattributes` so git keeps the upstream bytes, and committed the file. +- Recommendation: add `!vendor/**/dist/` to `.gitignore` (or anchor the rule to `/packages/*/dist`) and commit the original vendored file. Confirm whether it differs from upstream 4.0.1. + +### UF-002. Setup instructions skip the package build step +- Status: Open +- Found: 2026-09-27 +- Where: `README.md`, section "Run from source (development)" +- Symptom: following the README (`npm install`, then `npm run dev:server`) fails with `ERR_MODULE_NOT_FOUND` for `node_modules/@waggle/core/dist/index.js`. +- Cause: workspace packages export their compiled `dist/` output, which only `npm run build:packages` produces. The README does not mention this step. +- What we did: ran `npm run build:packages` before starting the sidecar. +- Recommendation: add `npm run build:packages` to the README, or run it automatically (for example a `predev:server` script), or export package sources for development. + +### UF-003. `npm run dev:web` cannot authenticate against the sidecar +- Status: Workaround +- Found: 2026-10-13 +- Where: `apps/web/vite.config.ts` (proxy option `changeOrigin: true`); `packages/server/src/local/index.ts:459` (`browserBootstrapAuthorityAllowed`) +- Symptom: the UI on `http://localhost:8080` loads, but every API call fails. The console shows "Session bootstrap origin does not match the local service authority" (HTTP 403, `SESSION_BOOTSTRAP_ORIGIN_MISMATCH`), followed by HTTP 401 on the other endpoints. +- Cause: the session-token bootstrap only accepts requests whose page origin equals the request `Host`. The Vite proxy runs with `changeOrigin: true` and rewrites `Host` to `127.0.0.1:3333`, so the check always fails in the documented dev setup. +- What we did: built the UI with `npm run build` and opened it through the sidecar on `http://localhost:3333`, the same way the Playwright suite and `install.sh` run it. No code changes. +- Recommendation: set `changeOrigin: false` for the `/api` and `/health` proxies so `Host` stays `localhost:8080`, or allow the dev-server origin explicitly. Confirm the security intent of the bootstrap check first. Update the README accordingly. + +### UF-004. Packaged macOS and Linux apps likely cannot find the sidecar +- Status: Open (found by reading the code; not yet confirmed by launching a packaged build) +- Found: 2026-09-27 +- Where: `app/src-tauri/src/service.rs`, functions `resolve_node_path` and `resolve_service_script` +- Symptom: expected error on start of a packaged macOS or Linux build: the shell cannot locate `node` or `resources/service.js`. +- Cause: both functions look for resources next to the executable (`std::env::current_exe()`). That matches the Windows NSIS layout only. On macOS resources live in `Contents/Resources`, on Linux under `/usr/lib/`. The code never uses Tauri's `resource_dir()`. CI builds the macOS app but never launches it. +- What we did: nothing yet. Planned in work package P1.3d. +- Recommendation: resolve resources through `app.path().resource_dir()` and add a CI smoke test that launches packaged macOS and Linux builds. + +### UF-005. Live Stripe webhook secret in git history +- Status: Open (action for Egzakta) +- Found: 2026-09-27 +- Where: first commit `0c3e2ea`, file `docs/launch/drafts/2026-05-12-apps-www-deployment-readiness.md`. The value is redacted in `b20b138`, but it remains in history. +- Symptom: anyone with access to the repository history can read the live webhook signing secret. The same document says the live Stripe secret key was left in a chat log and not rotated. +- Cause: a secret was committed in a planning document. +- What we did: the OSS edition will be published from a new repository with a single clean commit; the current history will not be pushed publicly. +- Recommendation: rotate the live webhook signing secret and the live secret key, and treat the existing history as compromised. + +### UF-006. Conflicting license files in weaver and optimizer +- Status: Open +- Found: 2026-09-27 +- Where: `packages/weaver/LICENSE`, `packages/optimizer/LICENSE`; `packages/weaver/package.json`, `packages/optimizer/package.json` +- Symptom: the LICENSE files say "All rights reserved. This software is proprietary and confidential", while both `package.json` files declare `"license": "MIT"`. +- Cause: inconsistent licensing metadata. +- What we did: nothing yet. The OSS edition needs a written decision (question Q6 for Egzakta). +- Recommendation: decide the license for both packages and make the LICENSE files and `package.json` agree. + +### UF-007. Onboarding Industry dropdown opens invisibly under the scrim +- Status: Fixed +- Found: 2026-10-13 +- Where: `apps/web/src/components/os/overlays/onboarding/WhoAreYouStep.tsx` (Industry `SelectContent`); `apps/web/src/components/os/overlays/OnboardingWizard.tsx:298` (`.onboarding-scrim`, `z-[9999]`); `apps/web/src/components/ui/select.tsx` (`SelectContent`, `z-50`) +- Symptom: on the "Tell us who you are" step, clicking the Industry select shows no options. Clicking just below the select still picks a value. +- Cause: `SelectContent` is portaled to `` with the primitive's `z-50`. The onboarding scrim is a fixed full-screen layer with `z-[9999]`, a 92% opaque background and `pointer-events: none`. The options render under the scrim, so they are invisible, while clicks pass through the scrim to them. +- What we did: added `className="z-[10000]"` to the Industry `SelectContent` and a regression test in `WhoAreYouStep.test.tsx` that opens the dropdown and checks that it stacks above the scrim. Checked in the browser: the options are visible and selectable. No other portaled popup renders inside a layer above `z-50` (the PersonaSwitcher tooltip is not portaled). +- Recommendation: apply the same fix. Longer term, define a shared z-index scale for overlays and popovers instead of independent values, and add a browser-level (Playwright) check for the onboarding flow: the jsdom test can only check classes, not real stacking. + +### UF-008. Local model downloads are cancelled after five minutes +- Status: Fixed. Verified three ways: (1) unit tests; (2) a real download of `llama3.1:8b` (4.7 GB) through the fixed route returned HTTP 200 with a verified digest and a passing generation probe; (3) a scaled-down experiment with Node's real `fetch` and a 2-second header timeout: `stream: false` failed with `UND_ERR_HEADERS_TIMEOUT`, `stream: true` completed a 5-second pull. +- Found: 2026-10-13 +- Where: `packages/server/src/local/routes/local-inference.ts`, route `POST /api/local-inference/pull` +- Symptom: downloading a large local model (observed with `qwen3:30b-a3b`, about 18.6 GB) never finishes. The request in the browser stays without a response, and the download stops after exactly five minutes. Ollama's partial files showed 12 of 20 parts last written at 18:05:47, five minutes after the start at 18:00:47; a retry stopped again about five minutes later. The download reached 68% over two attempts. +- Cause: the route called Ollama's `/api/pull` with `stream: false`. In that mode Ollama sends no response headers until the whole model is downloaded. Node's built-in `fetch` (undici) aborts a request after 300 seconds without headers, and Ollama cancels the pull when its client disconnects. Every pull longer than five minutes was therefore cancelled. Ollama keeps the downloaded parts, so each retry resumed, but again for five minutes only. +- What we did: the route now requests `stream: true` and reads Ollama's NDJSON progress to the end. Response headers arrive at once, and progress lines keep the connection alive. An `{"error": ...}` line or a stream that ends without `success` returns HTTP 502 with Ollama's message. Added two regression tests in `packages/server/tests/local/local-inference-route.test.ts`; all 23 route tests pass and `tsc` for `packages/server` is clean. +- Recommendation: apply the same fix. Note that the route still has a 45-minute overall timeout and the web UI waits 50 minutes (`apps/web/src/lib/adapter.ts`, `pullLocalModel`). Very large models on slow connections can still hit those limits; a retry resumes, but relaying the streamed progress to the UI would remove the problem and show the user a progress bar. +- Follow-up observed on 2026-10-13: after the repeated five-minute interruptions, resuming the same download with the fixed route failed inside Ollama with `remove …/sha256-58574f2e…-partial-0: no such file or directory`. Ollama's partial download state had become inconsistent and the previously downloaded data was lost. The fixed route reported this error to the client within two minutes instead of hanging. Consider detecting this error and offering to reset the partial download. + +### UF-009. Model recommendations assume a smaller quantization than the one downloaded +- Status: Open +- Found: 2026-10-13 +- Where: `GET /api/local-inference/models` (ranking from `packages/agent/src/cookbook/*`); `apps/web/src/components/os/model-gate/ModelGate.tsx:393` (`adapter.pullLocalModel(name)`) +- Symptom: on a Mac with 16 GB of memory, the model picker ranks `qwen3:30b-a3b` first with fit "good", estimating 9.2 GB of memory for quantization `Q2_K`. Downloading it fetches the default tag, which is about 18.6 GB (Q4_K_M), so the recommended model does not fit the machine once downloaded. +- Cause: the fit engine scores each model at its best-fitting quantization (`bestQuant`), but the UI pulls the bare catalog name, which resolves to Ollama's default quantization. +- What we did: nothing yet. +- Recommendation: either pull the tag that matches the scored quantization (where Ollama publishes one), or score models at the quantization of the default tag. Show the download size and memory requirement for exactly what will be downloaded. + +Entries UF-010 to UF-019 come from the UI audit `anti-slop/audit-001-2026-10-14.md` (found 2026-10-14). "Live" means confirmed in the running app; "code" means found by reading the code and the built CSS. + +### UF-010. Brand fonts are declared but never loaded +- Status: Open (live) +- Where: `apps/web/tailwind.config.ts`, `apps/web/src/index.css:213-215` +- Symptom: the UI asks for Hanken Grotesk and JetBrains Mono, but the page registers 0 `@font-face` rules, so most users see the system font. +- Recommendation: bundle the fonts (self-hosted `@font-face`) or import them, as the design handoff does (`docs/design_handoff_waggle_app/design-files/styles/waggle.css:7`). + +### UF-011. Token-based shadows compile to nothing +- Status: Open (code) +- Where: 31 uses of `shadow-[var(--shadow-*)]`, e.g. `OvernightHero.tsx:32`, `HomeCockpit.tsx:271, 374` +- Symptom: Tailwind treats the arbitrary value as a shadow colour, so no `box-shadow` is drawn. Intended card elevation and honey focus glows do not render. +- Recommendation: define the shadows in `tailwind.config.ts` (`boxShadow`) or use `shadow-[...]` with a full shadow value. + +### UF-012. Border-radius scale is inverted +- Status: Open (code) +- Where: `apps/web/tailwind.config.ts` (`xl` mapped to `--r-xl` = 26px) +- Symptom: `rounded-xl` (26px) is larger than `rounded-2xl` (16px) and `rounded-3xl` (24px); small dropdowns get 26px corners. +- Recommendation: restore a monotonic scale and replace the 154 arbitrary radius values with scale steps. + +### UF-013. Notification fetch failure shows "All caught up" +- Status: Open (code) +- Where: `apps/web/src/hooks/useNotifications.ts:14`, `NotificationInbox.tsx` +- Symptom: on a failed request the list is set to empty, and the inbox tells the user everything is read. There is no loading or error state. +- Recommendation: keep loading and error states separate from the empty state, with a retry. + +### UF-014. Timeline "Edit" button has no action +- Status: Open (code) +- Where: `apps/web/src/components/os/apps/memory/TimelineTab.tsx:237` +- Symptom: an icon button labelled Edit has no `onClick` and no accessible name; it does nothing. +- Recommendation: wire it to editing or remove it. + +### UF-015. Ctrl+Shift+digit app shortcuts never fire +- Status: Open (code) +- Where: `apps/web/src/hooks/useKeyboardShortcuts.ts:92`, help text in `KeyboardShortcutsHelp.tsx:12-21` +- Symptom: the handler compares `e.key` with digits, but with Shift held `e.key` is "!", "@" and so on (US layout), so the documented shortcuts do not work. +- Recommendation: match `e.code` (`Digit0`…`Digit9`). + +### UF-016. Tailwind `dark:` variants never apply +- Status: Open (code) +- Where: `apps/web/tailwind.config.ts:4` (`darkMode: ["class"]`), theme switching via `data-theme` +- Symptom: the `.dark` class is never set, so `dark:` variants (e.g. `ui/alert.tsx:12`, chart theme in `ui/chart.tsx:7`) never take effect. +- Recommendation: use `darkMode: ["selector", '[data-theme="dark"]']` or set `.dark` together with `data-theme`. + +### UF-017. Startup text is invisible in the light theme +- Status: Open (code) +- Where: `apps/web/src/main.tsx:12` +- Symptom: the "Starting Waggle…" text has a fixed colour `#f6f1e4`, while the light theme background is `#f7f1e4`. +- Recommendation: use a theme token for the startup text. + +### UF-018. Default model shown in the top bar disagrees with Model Pilot +- Status: Open (live) +- Where: top bar model pill; Settings → Models → Model Pilot +- Symptom: the top bar shows "Default model: Llama3.1 (8b)" while Model Pilot shows Primary "Not set" next to "You have a working model". +- Recommendation: show the same source of truth in both places, or explain that Model Pilot is unset and the default comes from elsewhere. + +### UF-019. Memory count pluralization: "1 Memories" +- Status: Open (live) +- Where: Memory → Trust tab header +- Symptom: with one memory the header reads "1 Memories in this hive". +- Recommendation: pluralize by count. + +### UF-020. WhatsApp connector bundles GPL-3.0 code into the sidecar +- Status: Open +- Found: 2026-10-15 +- Where: `packages/server/package.json:30` and `packages/launcher/package.json:42` (`@whiskeysockets/baileys` ^7.0.0-rc13); `packages/server/src/local/channels/whatsapp-adapter.ts:118,260`; `scripts/build-sidecar.mjs` (`EXTERNAL` list) +- Symptom: Baileys itself is MIT, but it depends on `libsignal` 6.0.0 (`WhiskeySockets/libsignal-node`), which is GPL-3.0. Baileys is not in the esbuild `EXTERNAL` list, so the sidecar build bundles Baileys together with `libsignal` into `service.js`, which ships inside the desktop installer. This follows from the build configuration; we have not inspected a built installer. +- Cause: the licenses of transitive dependencies are not checked. +- What we did: nothing in the main project code. The OSS edition replaces Baileys with `whatsapp-web.js` (Apache-2.0), per Egzakta decision Q5. +- Recommendation: include this in the license review (Q6). Shipping GPL-3.0 code inside a binary distributed under other terms is a compliance risk that needs a legal opinion. Options: replace Baileys in the main product as well, or move the WhatsApp connector into a separately installed component. Add a license check for transitive dependencies to CI. + +### UF-021. Settings visual-regression baseline is ignored by git +- Status: Fixed +- Found: 2026-10-15 +- Where: `.gitignore:230` (rule `s*.png`); `tests/visual/views.spec.ts:19` (view `settings`) +- Symptom: the visual suite screenshots seven views, but the repository holds baselines for six. The `settings-dark.png` and `settings-light.png` baselines match the `s*.png` ignore rule, so they never reach git and the Settings view has no committed baseline. +- Cause: a broad ignore rule meant for stray screenshots also matches baseline file names. +- What we did: added the exception `!tests/visual/baselines/**/*.png` to `.gitignore`. The Settings baselines still need to be generated with `npm run test:visual -- --update-snapshots` and committed. +- Recommendation: apply the same exception in the main project and commit the Settings baselines.