fix: five defects found while rewriting the docs (UF-061 to UF-065)

- Key messages named a Settings > API Keys tab that does not exist; they
  now point at Settings > Models (UF-061).
- The connector suggestion looked for vault.db, which never exists; it
  now checks the vault for a connector entry (UF-062).
- /config and /preferences were registered with a leading slash and
  never matched (UF-063).
- Pins and documents were written under ~/.waggle whatever the data
  directory; they now use the server's data directory (UF-064).
- The Windows uninstaller named a Data & Privacy page that does not
  exist (UF-065).
This commit is contained in:
shumeiko.it
2026-11-01 02:08:57 +01:00
parent 9806afbced
commit 74200d46e8
14 changed files with 171 additions and 40 deletions

View File

@@ -89,6 +89,11 @@ Baseline: commit `b20b138` of the main Waggle repository.
| UF-058 | The mock-embedding warning names a variable Waggle does not read | Fixed | Sidecar, embeddings |
| UF-059 | Installers ship third-party code without its notices | Open | Licensing, packaging |
| UF-060 | The sidecar ships `buffers` 0.1.1, which has no license | Open | Licensing |
| UF-061 | Key messages send users to "Settings > API Keys", which does not exist | Fixed | Sidecar |
| UF-062 | The connector suggestion looks for `vault.db`, which never exists | Fixed | Sidecar |
| UF-063 | `/config` and `/preferences` never run `/settings` | Fixed | Agent, commands |
| UF-064 | Pins and documents ignore the configured data directory | Fixed | Sidecar |
| UF-065 | The Windows uninstaller names a "Data & Privacy" settings page that does not exist | Fixed | Desktop, Windows installer |
## Entries
@@ -605,3 +610,48 @@ Entries UF-010 to UF-019 come from the UI audit `anti-slop/audit-001-2026-10-14.
- Cause: `exceljs` 4.4.0 still depends on `unzipper` 0.10, which pulls in the unmaintained `binary` and `buffers` packages.
- What we did: nothing in the code yet. The OSS license gate lists it as an exception pending the licensing review, so the issue shows on every run.
- Recommendation: remove the dependency, for example with an npm override to a newer `unzipper` release if one no longer depends on `binary` (check that `exceljs` still reads workbooks), or ask the author for a license.
### UF-061. Key messages send users to "Settings > API Keys", which does not exist
- Status: Fixed
- Found: 2026-11-01
- Where: at commit `b20b138`, `packages/server/src/local/service.ts:403`, `packages/server/src/local/index.ts:3036,3208`, `packages/server/src/local/routes/anthropic-proxy.ts:910,1120,1127`, `packages/server/src/local/routes/chat.ts:1818,1864,3738`
- Symptom: when no provider key is set or a key has expired, the health status, the proxy errors and the chat replies tell the user to open "Settings > API Keys". Settings has no such tab; its tabs are General, Models, Permissions, Channels, Backup and Advanced (plus the commercial ones).
- Cause: the copy was written for an earlier Settings layout. Keys moved to the Provider Keys section of Settings → Models and to the Vault app; the chat error action already opens Settings → Models.
- What we did: every message now says "Settings > Models".
- Recommendation: point the copy at Settings > Models, and keep the server copy and the Settings tab names in one shared constant.
### UF-062. The connector suggestion looks for `vault.db`, which never exists
- Status: Fixed
- Found: 2026-11-01
- Where: at commit `b20b138`, `packages/server/src/local/proactive-handlers.ts:292`
- Symptom: after 50 memories the "Connect your external tools" suggestion appears even when the user has connected GitHub, Slack or another connector.
- Cause: the handler treats the existence of `<dataDir>/vault.db` as "a connector is set up", but the vault is `vault.json` (`packages/core/src/vault.ts`). The file check is also too broad: provider API keys live in the same vault.
- What we did: the proactive context now carries the vault, and the handler checks for a `connector:<id>` entry. A test covers both cases.
- Recommendation: same change in the main project.
### UF-063. `/config` and `/preferences` never run `/settings`
- Status: Fixed
- Found: 2026-11-01
- Where: at commit `b20b138`, `packages/agent/src/commands/workflow-commands.ts:442`
- Symptom: typing `/config` or `/preferences` in chat answers "Unknown command".
- Cause: the aliases are registered as `'/config'` and `'/preferences'`, but the registry strips the leading slash before the lookup, as it does for every other alias.
- What we did: registered the aliases without the slash and added a test.
- Recommendation: same change in the main project; the registry could also reject aliases that start with `/`.
### UF-064. Pins and documents ignore the configured data directory
- Status: Fixed
- Found: 2026-11-01
- Where: at commit `b20b138`, `packages/server/src/local/routes/pins.ts:32`, `packages/server/src/local/routes/documents.ts:37`
- Symptom: with `WAGGLE_DATA_DIR` or a custom data directory, pinned messages and the document version registry are still written to `~/.waggle/workspaces/<id>/`, so they split from the rest of the workspace and survive a data erase of the configured directory.
- Cause: both routes build the path from `os.homedir()` instead of the server's data directory.
- What we did: both routes use `localConfig.dataDir`. A test checks where the files land.
- Recommendation: same change in the main project, and a lint rule against `os.homedir()` in routes.
### UF-065. The Windows uninstaller names a "Data & Privacy" settings page that does not exist
- Status: Fixed
- Found: 2026-11-01
- Where: at commit `b20b138`, `app/src-tauri/nsis/installer.nsi:22`
- Symptom: when the user ticks "delete app data" in the uninstaller, the message says data can only be erased from "Settings > Data & Privacy". There is no such page.
- Cause: the copy predates the current Settings layout; the erase action is the "Erase all my data" button on Settings → General.
- What we did: the message now names Settings > General > Erase all my data.
- Recommendation: same change in the main project.