release-2.9.0 (#1532)

* fix(macos): skip single-instance lock in Mac App Store builds (#1454) fix(macos): skip single-instance lock in Mac App Store builds * Fix/backend optional sharp (#1455) Fix/backend optional sharp * feat: issue #1218 (#1218) https://github.com/Termix-SSH/Support/issues/1218 * feat: Add option to use saved global custom theme under Connection Defaults (#1209) https://github.com/Termix-SSH/Support/issues/1209 * feat: Add Fleet Sharing functionality to the UI (#1228) https://github.com/Termix-SSH/Support/issues/1228 * feat: Add a list view to the Docker management page (#1237) https://github.com/Termix-SSH/Support/issues/1237 * feat: issue #1264 (#1264) https://github.com/Termix-SSH/Support/issues/1264 * feat: 2FA With FortiToken (#1288) https://github.com/Termix-SSH/Support/issues/1288 * feat: Allow to disable showing paths to folders (#1274) https://github.com/Termix-SSH/Support/issues/1274 * feat: Sync Network Graph between Desktop and Remote Server (#1245) https://github.com/Termix-SSH/Support/issues/1245 * feat: Version Number on offline servers (#1291) https://github.com/Termix-SSH/Support/issues/1291 * feat: Support OrbStack Docker socket path on macOS / Fix "Docker is not installed" on mac... (#1302) https://github.com/Termix-SSH/Support/issues/1302 * feat: Sidebar host click should focus existing tab instead of opening a new connection (#1289) https://github.com/Termix-SSH/Support/issues/1289 * fix: Search in side bar shows overlapping hosts when grouped by tags (#1303) https://github.com/Termix-SSH/Support/issues/1303 * fix: I can't send a file on its own. (#1304) https://github.com/Termix-SSH/Support/issues/1304 * fix: sudo password not autofilling (#1248) https://github.com/Termix-SSH/Support/issues/1248 * fix: node-MainThread (#1300) https://github.com/Termix-SSH/Support/issues/1300 * fix: Tunnel authentication with shared credentials (#1295) https://github.com/Termix-SSH/Support/issues/1295 * fix: host key updates not syncing, metrics 404 race on first connect Host key writes never bumped updatedAt so sync never picked them up. Also retry the first metrics fetch briefly instead of failing right away. * chore: increment ver * feat: add category and icon fields to plugin manifest schema * ci(deps): bump the github-actions group with 2 updates (#1458) Bumps the github-actions group with 2 updates: [crowdin/github-action](https://github.com/crowdin/github-action) and [actions/github-script](https://github.com/actions/github-script). Updates `crowdin/github-action` from 2 to 3 - [Release notes](https://github.com/crowdin/github-action/releases) - [Commits](https://github.com/crowdin/github-action/compare/v2...v3) Updates `actions/github-script` from 7 to 9 - [Release notes](https://github.com/actions/github-script/releases) - [Commits](https://github.com/actions/github-script/compare/v7...v9) --- updated-dependencies: - dependency-name: crowdin/github-action dependency-version: '3' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions - dependency-name: actions/github-script dependency-version: '9' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps-dev): bump the dev-patch-updates group with 13 updates (#1459) Bumps the dev-patch-updates group with 13 updates: | Package | From | To | | --- | --- | --- | | [@codemirror/commands](https://github.com/codemirror/commands) | `6.11.0` | `6.11.1` | | [@codemirror/search](https://github.com/codemirror/search) | `6.7.1` | `6.7.2` | | [@codemirror/view](https://github.com/codemirror/view) | `6.43.9` | `6.43.12` | | [@testing-library/dom](https://github.com/testing-library/dom-testing-library) | `10.4.1` | `10.4.2` | | [@testing-library/react](https://github.com/testing-library/react-testing-library) | `16.3.2` | `16.3.3` | | [@testing-library/user-event](https://github.com/testing-library/user-event) | `14.6.5` | `14.6.7` | | [@types/ssh2](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/ssh2) | `1.15.5` | `1.15.6` | | [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/tree/HEAD/packages/plugin-react) | `6.1.0` | `6.1.1` | | [cytoscape](https://github.com/cytoscape/cytoscape.js) | `3.34.1` | `3.34.3` | | [eslint-plugin-react-refresh](https://github.com/ArnaudBarre/eslint-plugin-react-refresh) | `0.5.4` | `0.5.7` | | [i18next](https://github.com/i18next/i18next) | `26.4.0` | `26.4.2` | | [prettier](https://github.com/prettier/prettier) | `3.9.6` | `3.9.8` | | [react-i18next](https://github.com/i18next/react-i18next) | `17.0.12` | `17.0.14` | Updates `@codemirror/commands` from 6.11.0 to 6.11.1 - [Changelog](https://github.com/codemirror/commands/blob/main/CHANGELOG.md) - [Commits](https://github.com/codemirror/commands/commits) Updates `@codemirror/search` from 6.7.1 to 6.7.2 - [Changelog](https://github.com/codemirror/search/blob/main/CHANGELOG.md) - [Commits](https://github.com/codemirror/search/commits) Updates `@codemirror/view` from 6.43.9 to 6.43.12 - [Changelog](https://github.com/codemirror/view/blob/main/CHANGELOG.md) - [Commits](https://github.com/codemirror/view/commits) Updates `@testing-library/dom` from 10.4.1 to 10.4.2 - [Release notes](https://github.com/testing-library/dom-testing-library/releases) - [Changelog](https://github.com/testing-library/dom-testing-library/blob/main/CHANGELOG.md) - [Commits](https://github.com/testing-library/dom-testing-library/compare/v10.4.1...v10.4.2) Updates `@testing-library/react` from 16.3.2 to 16.3.3 - [Release notes](https://github.com/testing-library/react-testing-library/releases) - [Changelog](https://github.com/testing-library/react-testing-library/blob/main/CHANGELOG.md) - [Commits](https://github.com/testing-library/react-testing-library/compare/v16.3.2...v16.3.3) Updates `@testing-library/user-event` from 14.6.5 to 14.6.7 - [Release notes](https://github.com/testing-library/user-event/releases) - [Changelog](https://github.com/testing-library/user-event/blob/main/CHANGELOG.md) - [Commits](https://github.com/testing-library/user-event/compare/v14.6.5...v14.6.7) Updates `@types/ssh2` from 1.15.5 to 1.15.6 - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/ssh2) Updates `@vitejs/plugin-react` from 6.1.0 to 6.1.1 - [Release notes](https://github.com/vitejs/vite-plugin-react/releases) - [Changelog](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/CHANGELOG.md) - [Commits](https://github.com/vitejs/vite-plugin-react/commits/plugin-react@6.1.1/packages/plugin-react) Updates `cytoscape` from 3.34.1 to 3.34.3 - [Release notes](https://github.com/cytoscape/cytoscape.js/releases) - [Commits](https://github.com/cytoscape/cytoscape.js/compare/v3.34.1...v3.34.3) Updates `eslint-plugin-react-refresh` from 0.5.4 to 0.5.7 - [Release notes](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/releases) - [Changelog](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/blob/main/CHANGELOG.md) - [Commits](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/compare/v0.5.4...v0.5.7) Updates `i18next` from 26.4.0 to 26.4.2 - [Release notes](https://github.com/i18next/i18next/releases) - [Changelog](https://github.com/i18next/i18next/blob/master/CHANGELOG.md) - [Commits](https://github.com/i18next/i18next/compare/v26.4.0...v26.4.2) Updates `prettier` from 3.9.6 to 3.9.8 - [Release notes](https://github.com/prettier/prettier/releases) - [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md) - [Commits](https://github.com/prettier/prettier/compare/3.9.6...3.9.8) Updates `react-i18next` from 17.0.12 to 17.0.14 - [Changelog](https://github.com/i18next/react-i18next/blob/master/CHANGELOG.md) - [Commits](https://github.com/i18next/react-i18next/compare/v17.0.12...v17.0.14) --- updated-dependencies: - dependency-name: "@codemirror/commands" dependency-version: 6.11.1 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dev-patch-updates - dependency-name: "@codemirror/search" dependency-version: 6.7.2 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dev-patch-updates - dependency-name: "@codemirror/view" dependency-version: 6.43.12 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dev-patch-updates - dependency-name: "@testing-library/dom" dependency-version: 10.4.2 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dev-patch-updates - dependency-name: "@testing-library/react" dependency-version: 16.3.3 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dev-patch-updates - dependency-name: "@testing-library/user-event" dependency-version: 14.6.7 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dev-patch-updates - dependency-name: "@types/ssh2" dependency-version: 1.15.6 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dev-patch-updates - dependency-name: "@vitejs/plugin-react" dependency-version: 6.1.1 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dev-patch-updates - dependency-name: cytoscape dependency-version: 3.34.3 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dev-patch-updates - dependency-name: eslint-plugin-react-refresh dependency-version: 0.5.7 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dev-patch-updates - dependency-name: i18next dependency-version: 26.4.2 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dev-patch-updates - dependency-name: prettier dependency-version: 3.9.8 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dev-patch-updates - dependency-name: react-i18next dependency-version: 17.0.14 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dev-patch-updates ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump the prod-patch-updates group with 6 updates (#1461) Bumps the prod-patch-updates group with 6 updates: | Package | From | To | | --- | --- | --- | | [@tanstack/react-virtual](https://github.com/TanStack/virtual/tree/HEAD/packages/react-virtual) | `3.14.10` | `3.14.13` | | [compression](https://github.com/expressjs/compression) | `1.8.1` | `1.8.2` | | [jose](https://github.com/panva/jose) | `6.2.9` | `6.2.12` | | [jszip](https://github.com/Stuk/jszip) | `3.10.1` | `3.10.2` | | [socks](https://github.com/JoshGlazebrook/socks) | `2.8.9` | `2.8.10` | | [undici](https://github.com/nodejs/undici) | `8.10.0` | `8.10.2` | Updates `@tanstack/react-virtual` from 3.14.10 to 3.14.13 - [Release notes](https://github.com/TanStack/virtual/releases) - [Changelog](https://github.com/TanStack/virtual/blob/main/packages/react-virtual/CHANGELOG.md) - [Commits](https://github.com/TanStack/virtual/commits/@tanstack/react-virtual@3.14.13/packages/react-virtual) Updates `compression` from 1.8.1 to 1.8.2 - [Release notes](https://github.com/expressjs/compression/releases) - [Changelog](https://github.com/expressjs/compression/blob/master/HISTORY.md) - [Commits](https://github.com/expressjs/compression/compare/v1.8.1...v1.8.2) Updates `jose` from 6.2.9 to 6.2.12 - [Release notes](https://github.com/panva/jose/releases) - [Changelog](https://github.com/panva/jose/blob/main/CHANGELOG.md) - [Commits](https://github.com/panva/jose/compare/v6.2.9...v6.2.12) Updates `jszip` from 3.10.1 to 3.10.2 - [Changelog](https://github.com/Stuk/jszip/blob/main/CHANGES.md) - [Commits](https://github.com/Stuk/jszip/compare/v3.10.1...v3.10.2) Updates `socks` from 2.8.9 to 2.8.10 - [Release notes](https://github.com/JoshGlazebrook/socks/releases) - [Commits](https://github.com/JoshGlazebrook/socks/compare/2.8.9...2.8.10) Updates `undici` from 8.10.0 to 8.10.2 - [Release notes](https://github.com/nodejs/undici/releases) - [Commits](https://github.com/nodejs/undici/compare/v8.10.0...v8.10.2) --- updated-dependencies: - dependency-name: "@tanstack/react-virtual" dependency-version: 3.14.13 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: prod-patch-updates - dependency-name: compression dependency-version: 1.8.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: prod-patch-updates - dependency-name: jose dependency-version: 6.2.12 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: prod-patch-updates - dependency-name: jszip dependency-version: 3.10.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: prod-patch-updates - dependency-name: socks dependency-version: 2.8.10 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: prod-patch-updates - dependency-name: undici dependency-version: 8.10.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: prod-patch-updates ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat: add plugin worker protocol, bootstrap and plugin_storage table Worker-side ctx proxy plus the message envelope it talks over, and the per-plugin key/value table behind ctx.storage with migrations for all three dialects. Rows cascade with the plugin so uninstalling leaves nothing behind. * feat: add allowlisted host view for plugins An allowlist rather than a list of fields to strip. A blocklist rots: the moment a new secret-bearing column lands on SSHHost it starts leaking silently. With an allowlist a new field stays invisible to plugins until someone adds it here on purpose. * feat: add plugin loader with manifest validation and crash restart Validates an unpacked plugin, spawns a worker_threads worker and manages activate/deactivate/crash-restart with backoff, disabling after three tries. The crash counter clears only after a plugin stays up past a stability window, not on activation. Clearing it on activation let a plugin that activates cleanly and then dies restart forever, because every attempt looked like the first. loader.ts documents what the worker boundary does and does not buy you. Node's permission model is process-wide, not per-worker, so it cannot be enabled for plugin workers alone and is not claimed here. * feat: route internal events through a shared plugin event bus Formalises three ad-hoc publish paths that already existed: automation-events.ts, metrics/automation-bridge.ts and the hostSessionStatus singleton, now the host.session.status topic. Both invariants the old code relied on are preserved. Publishing stays fire-and-forget, so a failing subscriber cannot disturb a metrics poll or a host delete. The automations engine subscribes to the bus at scheduler start instead of being imported ad hoc, which keeps the edge one-directional: automations may import repositories, hosts modules must not import automations. * feat: add plugin ctx broker with permission gate and audit Every ctx call a plugin makes is checked against its granted capabilities, performed by the main thread, then audited. A capability must be both declared in the manifest and granted in the database, so widening a plugin's reach always needs a new manifest the user can see, never just a database row. Audit attribution is set by the broker, not the plugin. The plugin supplies only the details, so it cannot forge the actor. fix: stop plugin workers seeing plaintext credentials in error messages A failing ctx.ssh.connect handed the worker the raw error from deep in the SSH stack, which embeds the connect config. The worker received, in full: Authentication failed for root using password <SECRET> where <SECRET> was the host's real plaintext password. Any plugin with ssh.exec could read it by catching the error, defeating the whole point of the handle-based ssh API. Errors crossing the boundary are now sanitised. Only PluginFacingError and PluginPermissionError, both authored here, reach a plugin verbatim; anything else becomes a generic message and the real one goes to the log. This uses a marker class rather than matching on message text, because matching would start leaking again the moment an upstream error happened to contain a familiar phrase. Covered by credential-isolation.test.ts, which plants a sentinel in every secret-bearing field and asserts it appears in no message the worker ever receives. * feat: dispatch plugin HTTP routes and wire the runtime into startup ctx.http.route now registers a real router on the /plugin-api/:pluginId dispatcher, replacing its stub 404. A plugin never touches the Express req/res: it gets a plain summary and returns a plain object, so sockets and session cookies stay on this side of the boundary. Authorization and cookie headers are not forwarded. Plugins load last in the start-up sequence, after the server is fully wired, and are terminated before the database on shutdown so none can outlive it. A plugin that fails to load cannot stop the backend. fix: correct the nginx plugin-api location regex The pattern was ^/plugin-api/(/.*)?$, which needs a double slash and so never matched /plugin-api/<id>/<route>. Every other block in the file uses ^/prefix(/.*)?$. Left alone, plugin routes would work in dev and 404 only behind Docker. * fix: update stale SFTP transfer test for single file destination paths The test still asserted transferToHost was called with the destination directory "/srv". Commit 7727fa09 (#1304) deliberately changed a single file transfer to send the full destination path including the filename, so the correct expectation is "/srv/remote-1.txt". The code was right and the test was left behind. * feat: ship the ssh terminal as a first-party in-process plugin Adds a hardcoded process:transport-owner tier so the terminal can own its WebSocket server and ssh2 clients, which cannot cross the worker boundary. * feat: ship docker as a first-party in-process plugin Moves docker backend and frontend into plugins/docker/, alongside ssh-terminal. Adds a host editor tab seam, a dashboard card registry, and a build step to compile plugin backends into dist. * feat: ship host metrics as a first-party in-process plugin * fix: harden plugin auth and add per-request identity for ctx calls Require auth on /plugin-api, gate plugin enable/grant/revoke routes behind admin.plugins.manage, and thread the calling user through worker ctx.hosts/ctx.ssh calls instead of always using the install owner. Also adds the plugin permissions grant/revoke UI. * feat: ship the AI assistant as a first-party in-process plugin Moves src/backend/ai and its routes into plugins/ai, mounted through a small /ai dispatcher instead of its own port. Moves the ai-enabled and ai-private-endpoints settings routes out of user-settings-routes.ts into the plugin too, so it has no leftover core dependents. * fix: remove compiled plugin JS left behind in plugins/ after build copy-bundled-plugins.cjs compiled and rewrote plugin backend TS in place, copied it to dist/plugins, but never deleted the .js it had just emitted next to the .ts sources. Those files shadowed the real source for vitest/tsx and had import paths rewritten for the dist layout, so tests failed with "Cannot find module" once a local build had run. Affects docker, host-metrics and ai, not just this one. * feat: add a permission-gated backend service registry for plugins * feat: add a permission-gated UI action registry and action slots for plugins Moves the terminal toolbar's hardwired AI button into a slot the ssh-terminal plugin offers and the ai plugin fills, gated on ai.services.use. * feat: add cross-plugin secret references gated by the provider's RBAC permission * feat: move proxmox discovery/import/sync into a first-party plugin * feat: move remote desktop (RDP/VNC/Telnet) into a first-party plugin Relocates guacamole backend/frontend source and tests into plugins/remote-desktop, following the ssh-terminal/docker pattern. * feat: wire remote-desktop plugin into core and rename i18n keys Repoints core consumers (dispatcher, collab, session-sharing, tab utils) at the plugin, adds isTabTypeAvailable gating for rdp/vnc/ telnet, widens hostCapability to accept an array, and renames the guacamole i18n namespace to remoteDesktop. * feat: move fleets into a first-party plugin * feat: move automations into a first-party plugin * feat: remove legacy alert rules, superseded by automations Alert rules already auto-migrate into automations on boot and the old engine stands down after. Deletes the rule/firing tables, routes, UI, and AI tools; keeps notification channels since automations still use them. Also fixes automations' notify step, which still called the deleted repository. * feat: move network topology into a first-party plugin * feat: move tailscale device discovery and settings into a plugin Adds plugins/tailscale/ with a devices sidebar tab, admin settings section, and re-auth dialog. Host Metrics tailscale manager card and SSH re-auth banner parsing stay in core. * feat: move workspaces into a first-party plugin * feat: move web endpoint into a first-party plugin * feat: collapse plugin runtime to one tier behind a plugin SDK * feat: make each plugin an npm workspace built by a termix-plugin CLI * feat: give plugins their own tables, migrations and sync entities * feat: serve plugin http and websockets from one mount instead of ports * feat: namespace plugin permissions and keep them valid when a plugin is off * feat: give plugins their own settings and one settings screen * feat: load plugin frontends at runtime and remove plugin ids from the shell * fix: mock the ai status fetch in its activate test * feat: add auth extension points and one ssh connect pipeline * feat: rebuild workspaces as the reference plugin * fix: gate second factors after SSO/LDAP behind an admin setting * feat: convert network-topology to a full plugin (B1) * feat: move snippets backend and tables into a plugin (B2) * feat: point core frontend snippets pickers at the plugin (B2) * feat: add the snippets plugin (B2) * feat: wire ai, automations, fleets and ssh-terminal to snippets (B2) * feat: finish the tailscale plugin, including SSH auth (B3) * feat: finish the fleets plugin, add ctx.hosts and host-commands SDK (B4) * chore: update proxmox and host-metrics locale files for B5 * chore: regenerate drizzle migration journals for B5 * feat: add ctx.hosts create/update to the SDK, host-metrics drops proxmox * feat: move proxmox node stats and collectors into the proxmox plugin * feat: drop proxmox host columns, use plugin settings instead * feat: finish the fleets plugin, add ctx.hosts and host-commands SDK (B4) * feat: convert file manager into a plugin * feat: convert ssh tunnels into a plugin * feat: finish the web-endpoint plugin, add ctx.desktop (B8) * feat: move the terminal fully into the ssh-terminal plugin (B9) * feat: convert tmux monitoring into a plugin (B10) * feat: convert serial console into the serial plugin * feat: move session sharing and collab rooms into a plugin (B12) * feat: turn session recording into a plugin (B13) * feat: finish the remote-desktop plugin (B14) * feat: finish the host-metrics plugin, move host status into core (B16) * feat: finish the docker plugin (B15) * feat: finish the automations plugin (B17) * feat: finish the ai plugin (B18) * feat: finish the homepage plugin, move service links and canvas out of core (B19) * feat: convert wake-on-lan into a plugin (B20) * feat: convert secret-sources into a plugin (B20) * feat: move totp and passkeys into plugins (C1) * feat: move sso and ldap logins into plugins (C2) * feat: move opkssh and warpgate into plugins (C3) * feat: move step-ca into a plugin (C4) * feat: move vault ssh signing into a plugin (C5) * feat: move termix identity into a plugin (C6) * feat: move acme certificate automation into a plugin (C7) * fix: finish 2.9.0 plugin moves and get every check green * chore: lock the plugin boundary and remove 2.9.0 leftovers * fix: harden the plugin runtime after the 2.9.0 security review * feat: add plugin packing, signing, pinned trust and tmxplug bundling * test: prove 2.8 to 2.9.0 upgrade is lossless and fix what it caught * fix: give bundled plugin backends a real require for CJS deps * feat: improve UI loading time and jitter * feat: show credential sharing inline in the sidebar like host sharing * feat: tailscale add host and copy ip, fix outbound fetch hang and plugin ESM warning * feat: unify alerts into one plugin, channels, rules and inbox * feat: rebuild desktop sync as linked server accounts, fix packaged plugin bundles and UI scaling * fix: set blacksmith builder cache-key to stop broken gha cache fallback * fix: link plugin-sdk workspace before npm ci in docker deps stage * fix: link every plugin workspace before npm ci in docker deps stage * fix(host-metrics): exclude image and firmware filesystems (#1469) * fix(host-metrics): exclude image and firmware filesystems * fix(ci): build plugin SDK before dependent checks * fix(mysql): keep plugin settings scope indexes within limits * test(mysql): refresh reviewed plugin upgrade SQL * fix(hosts): normalize imported jump host references (#1470) * fix(hosts): normalize imported jump host references * fix(ci): build plugin SDK before dependent checks * fix(mysql): keep plugin settings scope indexes within limits * test(mysql): refresh reviewed plugin upgrade SQL * fix(ci): build plugin SDK and repair MySQL settings migration (#1471) * fix(ci): build plugin SDK before dependent checks * fix(mysql): keep plugin settings scope indexes within limits * test(mysql): refresh reviewed plugin upgrade SQL * fix(file-manager): keep inline rename consistent (#1476) * fix(ci): build plugin SDK before dependent checks * fix(mysql): keep plugin settings scope indexes within limits * test(mysql): refresh reviewed plugin upgrade SQL * fix(file-manager): keep inline rename consistent * fix(dashboard): reuse translated host status labels (#1475) * fix(ci): build plugin SDK before dependent checks * fix(mysql): keep plugin settings scope indexes within limits * test(mysql): refresh reviewed plugin upgrade SQL * fix(dashboard): reuse translated host status labels * docs(api): clarify local and remote version fields (#1474) * fix(ci): build plugin SDK before dependent checks * fix(mysql): keep plugin settings scope indexes within limits * test(mysql): refresh reviewed plugin upgrade SQL * docs(api): clarify local and remote version fields * fix(file-manager): preserve selected backgrounds on hover (#1473) * fix(ci): build plugin SDK before dependent checks * fix(mysql): keep plugin settings scope indexes within limits * test(mysql): refresh reviewed plugin upgrade SQL * fix(file-manager): preserve selection feedback on hover * test(ui): await dialog focus cleanup before teardown * fix(file-manager): restore Ctrl/Cmd+F file search (#1472) * fix(ci): build plugin SDK before dependent checks * fix(mysql): keep plugin settings scope indexes within limits * test(mysql): refresh reviewed plugin upgrade SQL * fix(file-manager): focus file search with Ctrl or Cmd F * fix: keep rounded-full circular in production builds * fix(file-manager): cancel uploads and stop remote writes (#1477) * fix(file-manager): cancel uploads and stop remote writes * test(css): exercise the configured PostCSS plugin chain * fix(file-manager): apply compact density to directory tree (#1478) * fix(file-manager): apply compact density to directory tree * test(css): exercise the configured PostCSS plugin chain * fix(file-manager): preserve font sizes in compact mode (#1480) * fix(file-manager): preserve font sizes in compact mode * test(css): exercise the configured PostCSS plugin chain * fix(file-manager): prioritize file names in narrow lists (#1483) * fix(file-manager): prioritize file names in narrow lists * test(css): exercise the configured PostCSS plugin chain * test(identity): preserve full Ed25519 public keys in fixtures * test(remote-desktop): always mutate ciphertext in tamper test * fix(remote-desktop): probe the saved host guacd endpoint (#1481) * fix(remote-desktop): probe the saved host guacd endpoint * test(css): exercise the configured PostCSS plugin chain * test(identity): preserve full Ed25519 public keys in fixtures * fix(homepage): check allowlisted private service reachability (#1479) * fix(homepage): check allowlisted private service reachability * test(css): exercise the configured PostCSS plugin chain * fix(remote-desktop): stop unsolicited clipboard read prompts (#1482) * fix(remote-desktop): read clipboard only on explicit paste * test(css): exercise the configured PostCSS plugin chain * test(identity): preserve full Ed25519 public keys in fixtures * test(remote-desktop): always mutate ciphertext in tamper test * chore: simplify plugin readmes, changelogs and manifest descriptions * fix: keep plugins loaded after signing in from the login screen * fix(file-manager): accept OS file drops over existing rows (#1484) * fix(file-manager): accept OS file drops over existing rows * test(file-manager): target the file label in drop tests * test(css): exercise the configured PostCSS plugin chain * test(identity): preserve full Ed25519 public keys in fixtures * test(remote-desktop): always mutate ciphertext in tamper test * fix(file-manager): pipeline SFTP download reads (#1485) * feat: add plugin sdk build to beta release * fix: make link-store secret check immune to random base64 matches * fix(ldap): preserve the directory-provided bind DN (#1486) * fix: compute beta changes across dev branches and move the beta tag * chore: untrack plugin sdk ARCHITECTURE.md * chore: remove references to plugin sdk ARCHITECTURE.md * feat: merge host editor terminal tabs into one owned by ssh-terminal * feat: add descriptions to plugin host enable toggles * fix(file-manager): show download progress in file viewers (#1487) * fix(electron): signal backend readiness over IPC (#1488) * fix(split-screen): allow layout creation without randomUUID (#1490) * fix(split-screen): allow layout creation without randomUUID * test(credentials): avoid flaky Ed25519 key generation * fix(sidebar): remeasure visible rows after density changes (#1489) * fix(sidebar): remeasure visible rows after density changes * test(credentials): avoid flaky Ed25519 key generation * feat(split-screen): redesign split screen with free-form panes and pane picker * feat(sidebar): add host click behavior setting, default to always opening a new tab * feat(snippets): redesign panel to match the host list * fix(session-recording): stop session logs panel from refetching in a loop * feat(snippets): bring back sharing, target hosts and drag reorder * feat(ssh-terminal): add toolbar position, start state, display and fade host settings * feat(ssh-terminal): add host setting to turn off password prompt auto-fill * fix(ai): stop streams getting cut off and keep tool steps across messages * feat: improve quick connect system using plugin api * fix: proxmox guest sync, startup snippet sync, drop dead cloudflare ssh transport * feat: move terminal settings, look and ssh tools into ssh-terminal plugin * feat: move snippets, keybinding actions and macros out of core into plugins * feat: store rdp, vnc and telnet logins in a generic per-protocol table * feat: type the plugin host record, move plugin strings out of core and add lint checks * feat: replace core homepage widget registry with generic extension points * feat: plugins only see their own host settings in the browser * feat: harden plugin api for separate repos, signed updates and generic external login * fix: keep plugin css below core utilities and version plugin assets by their css * fix: load and save plugin host settings in the editor and tighten settings row spacing * feat: redesign user host defaults system * fix(remote-desktop): release held keys on focus loss (#1498) * fix(session-sharing): replace local presentation after takeover (#1500) * fix(file-manager): refresh disk usage with directory listing (#1503) * fix(ssh-terminal): preserve input order during local echo reconciliation (#1505) * feat(remote-desktop): expose display zoom controls for RDP (#1514) * fix(file-manager): restore text selection and copying in Markdown previews (#1518) * fix(sidebar): keep compact host addresses visible (#1524) * fix(hosts): preserve plugin settings when reopening the editor (#1499) * fix(ssh-terminal): close owner sockets when presentations unmount (#1501) * fix(session-sharing): synchronize shared SSH terminal dimensions (#1502) * fix(session-sharing): show participant presence in member terminals (#1504) * fix(ai): sync provider configuration and keys across linked devices (#1506) * feat(ssh-terminal): add a duplicate tab action (#1510) * feat(file-manager): allow disabling move-to-trash confirmation (#1511) * feat(file-manager): default to the remote login directory (#1512) * feat(homepage): synchronize canvas layouts across devices (#1515) * fix(shortcuts): prevent accidental double-Shift palette activation (#1519) * feat(tmux-monitor): add a unified multi-host view (#1520) * fix(electron): allow explicit quit with active connections (#1522) * feat: reconnect all disconnected terminal tabs (#1523) * fix(hosts): preserve recording and sharing settings in the dev editor (#1509) * fix(database): preserve RDP domain during startup backfill (#1497) * feat(sidebar): add keyboard type-ahead search for hosts (#1516) * feat(automations): add per-host maintenance mode and recurring schedules (#1521) * feat(tmux): add a per-host mouse toggle and preserve remote configuration (#1513) * fix(session-sharing): use the linked server for desktop meetings and links (#1507) * fix(tunnels): support TOTP for client tunnels and jump hosts (#1508) * fix: type errors and lint failures from merged plugin prs * feat(installer): make the Windows desktop shortcut optional (#1517) * fix: ship the plugin sdk and serialport in desktop builds * fix: prefer ipv4 when resolving ssh host names (#1365) * fix: readable terminal selection with the light theme (#1319) * fix: build desktop session share links on the linked server (#1350) * fix: show meeting guests to members and hide the roster from guests (#1353) * fix: reliable file manager saves with sudo prompt and no base64 guessing (#1335) * fix: show disk usage for the mount being browsed (#1347) * fix: load the linux tray icon reliably and log tray failures (#1332) * fix: cover the gnome close path in the desktop quit test (#1332) * fix: prompt for jump host TOTP in terminal, file manager and metrics (#1312) * feat: optional auto reconnect for dropped ssh sessions (#1321) * feat: tighter compact host rows with inline tags (#1325) * feat: bring back the alert feed homepage widget * feat: pick target terminals for snippets again * feat: share button on connection tabs again * feat: recent servers list when linking the desktop app * feat: list the fixed app shortcuts in keyboard shortcuts * fix: translate hardcoded toasts and drop em dashes from ui text * fix: translate leftover hardcoded ui text * fix: toolbar files button opens at the shell directory again * fix: show the remote desktop note under connection origin again * chore: openapi docs for host metrics manager routes * chore: openapi docs for undocumented routes and fix two broken doc blocks * fix: declare terminal.listSessions use for snippet targets * revert: drop the alert feed widget, the notification center replaces it * feat: restore the alert feed homepage widget * fix: quick connect fills the host address from plugin auth editors like tailscale * fix: docker container logs use the base background color * chore: fix dependabot alerts and apply safe npm upgrades * fix: proxmox stats tab reads its switch from plugin host settings * fix: count plugin ssh logins toward host status and stop showing reachable as a warning * fix: hide the built-in source pill in the host editor * fix: host status shows online when the port answers and only warns on a failed login * fix: drop the top border on the split layout menu * fix: host defaults tabs sit where the host editor puts them and skip plugins with nothing to default * fix: remote desktop auth method labels and notes for vnc and telnet * fix: add description to the web endpoint enable switch * fix: crowdin sync and pretranslate for plugin locales, run plugin tests on release * feat: move telemetry out of core into a usage statistics plugin * fix: recent activity card no longer cuts off host names early * fix: remove duplicate top border on split screen menu * fix: redesign session log player controls, fix tooltip overlap and drop dot separators * fix: file manager and sftp text showing raw i18n keys * fix: onboarding rerunning for existing users after upgrading * fix: fleet detail buttons overflowing the sidebar * fix: session log player scrolling off screen horizontally * fix: network graph lag when adding hosts and on every render * fix: maintenance index name, shared host read only view and badge polling * fix: meeting tabs, workspace tab merging, rail panels as tabs and general ui lag * chore: update release notes * fix: remote desktop tabs reconnecting on every tab switch * fix: build plugin sdk before linting in release workflow * chore: lint, format, and bump version to 2.9.0 * chore: skip crowdin pre-translate in release for now * chore: sync Crowdin translations for 2.9.0 --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Koi <38512047+datlt4@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: ZacharyZcR <zacharyzcr1984@gmail.com>
2026-10-29 06:35:24 +00:00 · 2026-10-01 16:20:16 -05:00
1 parent 49fa488093
commit 3643e7af97
@@ -0,0 +1,140 @@
+import fs from "node:fs";
+import { randomUUID } from "node:crypto";
+import { sql } from "drizzle-orm";
+import type { PluginContext } from "@termix/plugin-sdk/backend";
+import { envOverride } from "./config.js";
+import { usageProperty, type UsageCounts, type UsageStore } from "./usage.js";
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+// ctx.db hands back the server's own drizzle handle and tables, untyped.
+type Table = any;
+type Drizzle = any;
+/* eslint-enable @typescript-eslint/no-explicit-any */
+
+export interface TelemetrySettings {
+  enabled: boolean;
+  includePlatform: boolean;
+  includeFeatureUsage: boolean;
+  includePlugins: boolean;
+  instanceId: string;
+}
+
+export interface TelemetryPayload {
+  event: "instance_heartbeat";
+  distinct_id: string;
+  properties: Record<string, unknown>;
+}
+
+type Env = Record<string, string | undefined>;
+
+export async function readSettings(
+  ctx: PluginContext,
+): Promise<TelemetrySettings> {
+  const all = await ctx.settings.getAll("admin");
+  return {
+    enabled: all.enabled !== false,
+    includePlatform: all.includePlatform !== false,
+    includeFeatureUsage: all.includeFeatureUsage !== false,
+    includePlugins: all.includePlugins !== false,
+    instanceId: typeof all.instanceId === "string" ? all.instanceId : "",
+  };
+}
+
+/** The env variable decides when set, the admin switch otherwise. */
+export function isEnabled(settings: TelemetrySettings, env?: Env): boolean {
+  return envOverride(env) ?? settings.enabled;
+}
+
+/**
+ * Made on first use rather than on activate, so the boot copy of a 2.8
+ * instance id is never shadowed by a new one.
+ */
+export async function ensureInstanceId(ctx: PluginContext): Promise<string> {
+  const existing = await ctx.settings.get<string>("instanceId");
+  if (existing) return existing;
+  const id = randomUUID();
+  await ctx.settings.set("instanceId", id);
+  return id;
+}
+
+export function detectDeployment(
+  env: Env = process.env,
+  exists: (path: string) => boolean = fs.existsSync,
+): "desktop" | "docker" | "server" {
+  if (env.ELECTRON_EMBEDDED === "true") return "desktop";
+  if (exists("/.dockerenv")) return "docker";
+  return "server";
+}
+
+async function countRows(ctx: PluginContext): Promise<{
+  userCount: number;
+  hostCount: number;
+}> {
+  const { users, hosts } = await ctx.db.refs<{ users: Table; hosts: Table }>();
+  const db = await ctx.db.client<Drizzle>();
+  const count = async (table: Table) => {
+    const rows = await db.select({ count: sql<number>`count(*)` }).from(table);
+    return Number(rows[0]?.count ?? 0);
+  };
+  const [userCount, hostCount] = await Promise.all([
+    count(users),
+    count(hosts),
+  ]);
+  return { userCount, hostCount };
+}
+
+export interface BuiltPayload {
+  payload: TelemetryPayload;
+  /** The counts the payload carries, to subtract once it is sent. */
+  usage: UsageCounts;
+}
+
+export async function buildPayload(
+  ctx: PluginContext,
+  usage: UsageStore,
+  env: Env = process.env,
+): Promise<BuiltPayload> {
+  const settings = await readSettings(ctx);
+  const distinctId = await ensureInstanceId(ctx);
+  const { userCount, hostCount } = await countRows(ctx);
+
+  const properties: Record<string, unknown> = {
+    version: env.VERSION || "unknown",
+    user_count: userCount,
+    host_count: hostCount,
+  };
+
+  if (settings.includePlatform) {
+    properties.os = process.platform;
+    properties.arch = process.arch;
+    properties.node_version = process.versions.node;
+    properties.db_dialect = ctx.db.dialect;
+    properties.deployment = detectDeployment(env);
+  }
+
+  let carried: UsageCounts = {};
+  if (settings.includeFeatureUsage) {
+    carried = await usage.read();
+    for (const [name, count] of Object.entries(carried)) {
+      properties[usageProperty(name)] = count;
+    }
+  }
+
+  if (settings.includePlugins) {
+    const running = (await ctx.plugins.list())
+      .filter((plugin) => plugin.state === "active")
+      .map((plugin) => plugin.id)
+      .sort();
+    properties.plugins_enabled = running;
+    properties.plugin_count = running.length;
+  }
+
+  return {
+    payload: {
+      event: "instance_heartbeat",
+      distinct_id: distinctId,
+      properties,
+    },
+    usage: carried,
+  };
+}
@@ -0,0 +1,26 @@
+/** Public project key. Only lets a client send events, never read them. */
+export const DEFAULT_POSTHOG_API_KEY =
+  "phc_xM8UznirsFxUkGE68gH4jzeqevf4kh76wGw7Ci7hH2dd";
+export const DEFAULT_POSTHOG_HOST = "https://us.i.posthog.com";
+
+type Env = Record<string, string | undefined>;
+
+/** ENABLE_TELEMETRY wins over the admin setting when set. */
+export function envOverride(env: Env = process.env): boolean | null {
+  const value = env.ENABLE_TELEMETRY?.trim().toLowerCase();
+  if (!value) return null;
+  return value === "true";
+}
+
+export function posthogConfig(env: Env = process.env): {
+  apiKey: string;
+  host: string;
+} {
+  return {
+    apiKey: env.POSTHOG_API_KEY?.trim() || DEFAULT_POSTHOG_API_KEY,
+    host: (env.POSTHOG_HOST?.trim() || DEFAULT_POSTHOG_HOST).replace(
+      /\/+$/,
+      "",
+    ),
+  };
+}
@@ -0,0 +1,65 @@
+import type { Router } from "express";
+import type { PluginContext } from "@termix/plugin-sdk/backend";
+import { envOverride } from "./config.js";
+import { isEnabled, readSettings } from "./collect.js";
+import { CHECK_INTERVAL_MS, createReporter } from "./reporter.js";
+import { registerRoutes } from "./routes.js";
+import { createUsageStore } from "./usage.js";
+
+/** First check a few minutes after boot, once core's boot copies ran. */
+const FIRST_CHECK_DELAY_MS = 3 * 60 * 1000;
+
+type Env = Record<string, string | undefined>;
+
+export async function activateWith(ctx: PluginContext, env: Env) {
+  const usage = createUsageStore(ctx.kv);
+  const reporter = createReporter(ctx, usage, env);
+
+  const check = async () => {
+    try {
+      await reporter.send();
+    } catch {
+      // Logged by the reporter; the next check tries again.
+    }
+  };
+  ctx.schedule.after(FIRST_CHECK_DELAY_MS, check);
+  ctx.schedule.every(CHECK_INTERVAL_MS, check);
+
+  const countEvent = (feature: string) => async () => {
+    const settings = await readSettings(ctx);
+    if (isEnabled(settings, env) && settings.includeFeatureUsage) {
+      await usage.add({ [feature]: 1 });
+    }
+  };
+  const onLogin = countEvent("ssh_login");
+  const onConnected = countEvent("host_connected");
+  ctx.events.on("host.login", () => void onLogin().catch(() => undefined));
+  ctx.events.on("host.session.status", (payload) => {
+    if ((payload as { online?: boolean } | null)?.online) {
+      void onConnected().catch(() => undefined);
+    }
+  });
+
+  ctx.settings.onValidate("admin", async (values) => {
+    const locked = envOverride(env);
+    if (locked === null || values.enabled === undefined) return;
+    const stored = (await ctx.settings.get<boolean>("enabled")) !== false;
+    if (values.enabled !== stored) {
+      return {
+        enabled:
+          "This is set by the ENABLE_TELEMETRY environment variable and cannot be changed here.",
+      };
+    }
+  });
+
+  registerRoutes(ctx, ctx.http.router<Router>(), reporter, usage, env);
+  return { reporter, usage };
+}
+
+export async function activate(ctx: PluginContext) {
+  await activateWith(ctx, process.env);
+}
+
+export async function deactivate() {
+  // Everything above was registered through ctx and is disposed by core.
+}
@@ -0,0 +1,117 @@
+import { randomUUID } from "node:crypto";
+import type { PluginContext } from "@termix/plugin-sdk/backend";
+import { envOverride, posthogConfig } from "./config.js";
+import { buildPayload, isEnabled, readSettings } from "./collect.js";
+import type { UsageStore } from "./usage.js";
+
+export const REPORT_INTERVAL_MS = 24 * 60 * 60 * 1000;
+/** Checked hourly, so a restart never skips or doubles a day. */
+export const CHECK_INTERVAL_MS = 60 * 60 * 1000;
+
+const STATE_KEY = "state";
+
+export interface ReporterState {
+  lastSentAt: string | null;
+  lastAttemptAt: string | null;
+  lastError: string | null;
+}
+
+export type SendResult =
+  { sent: true } | { sent: false; reason: "disabled" | "not-due" };
+
+type Env = Record<string, string | undefined>;
+
+export function createReporter(
+  ctx: PluginContext,
+  usage: UsageStore,
+  env: Env = process.env,
+  now: () => number = Date.now,
+) {
+  async function state(): Promise<ReporterState> {
+    const stored = (await ctx.kv.get(STATE_KEY)) as
+      Partial<ReporterState> | undefined;
+    return {
+      lastSentAt: stored?.lastSentAt ?? null,
+      lastAttemptAt: stored?.lastAttemptAt ?? null,
+      lastError: stored?.lastError ?? null,
+    };
+  }
+
+  async function saveState(patch: Partial<ReporterState>) {
+    await ctx.kv.set(STATE_KEY, { ...(await state()), ...patch });
+  }
+
+  async function nextDueAt(): Promise<string | null> {
+    const { lastSentAt } = await state();
+    if (!lastSentAt) return null;
+    return new Date(Date.parse(lastSentAt) + REPORT_INTERVAL_MS).toISOString();
+  }
+
+  async function send(options: { force?: boolean } = {}): Promise<SendResult> {
+    if (!isEnabled(await readSettings(ctx), env)) {
+      return { sent: false, reason: "disabled" };
+    }
+    if (!options.force) {
+      const due = await nextDueAt();
+      if (due && Date.parse(due) > now()) {
+        return { sent: false, reason: "not-due" };
+      }
+    }
+
+    const attemptAt = new Date(now()).toISOString();
+    const { apiKey, host } = posthogConfig(env);
+    try {
+      const { payload, usage: carried } = await buildPayload(ctx, usage, env);
+      const response = await ctx.fetch(`${host}/capture/`, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({ api_key: apiKey, ...payload }),
+        timeoutMs: 10_000,
+      });
+      if (!response.ok) {
+        throw new Error(`PostHog answered ${response.status}`);
+      }
+      await usage.subtract(carried);
+      await saveState({
+        lastSentAt: attemptAt,
+        lastAttemptAt: attemptAt,
+        lastError: null,
+      });
+      ctx.log.info("Sent daily usage statistics");
+      return { sent: true };
+    } catch (error) {
+      const message = error instanceof Error ? error.message : String(error);
+      await saveState({ lastAttemptAt: attemptAt, lastError: message });
+      ctx.log.warn(`Could not send usage statistics: ${message}`);
+      throw error;
+    }
+  }
+
+  return {
+    state,
+    send,
+
+    async status() {
+      const settings = await readSettings(ctx);
+      return {
+        enabled: isEnabled(settings, env),
+        locked: envOverride(env) !== null,
+        instanceId: settings.instanceId || null,
+        nextDueAt: await nextDueAt(),
+        ...(await state()),
+      };
+    },
+
+    async preview() {
+      return (await buildPayload(ctx, usage, env)).payload;
+    },
+
+    async resetInstanceId(): Promise<string> {
+      const id = randomUUID();
+      await ctx.settings.set("instanceId", id);
+      return id;
+    },
+  };
+}
+
+export type Reporter = ReturnType<typeof createReporter>;
@@ -0,0 +1,148 @@
+import type { Request, RequestHandler, Response, Router } from "express";
+import type { PluginContext } from "@termix/plugin-sdk/backend";
+import { isEnabled, readSettings } from "./collect.js";
+import type { Reporter } from "./reporter.js";
+import { sanitizeUsage, type UsageStore } from "./usage.js";
+
+/** Whether the signed-in user's feature usage should be counted. */
+export async function shouldTrackUser(
+  ctx: PluginContext,
+  userId: string | undefined,
+  env?: Record<string, string | undefined>,
+): Promise<boolean> {
+  if (!userId) return false;
+  const settings = await readSettings(ctx);
+  if (!isEnabled(settings, env) || !settings.includeFeatureUsage) return false;
+  return (await ctx.settings.getUser(userId, "shareFeatureUsage")) !== false;
+}
+
+export function registerRoutes(
+  ctx: PluginContext,
+  router: Router,
+  reporter: Reporter,
+  usage: UsageStore,
+  env?: Record<string, string | undefined>,
+): void {
+  const manage = ctx.rbac.require("manage") as unknown as RequestHandler;
+
+  /**
+   * @openapi
+   * /plugin-api/telemetry/status:
+   *   get:
+   *     summary: Usage statistics status
+   *     description: Whether usage statistics are sent, whether ENABLE_TELEMETRY locks that, the instance ID and the last attempt.
+   *     tags: [Usage Statistics]
+   *     responses:
+   *       200:
+   *         description: Status.
+   *       403:
+   *         description: Missing the telemetry.manage permission.
+   */
+  router.get("/status", manage, async (_req: Request, res: Response) => {
+    res.json(await reporter.status());
+  });
+
+  /**
+   * @openapi
+   * /plugin-api/telemetry/preview:
+   *   get:
+   *     summary: Preview the next report
+   *     description: The exact event that would be sent right now, without the API key.
+   *     tags: [Usage Statistics]
+   *     responses:
+   *       200:
+   *         description: The event.
+   *       403:
+   *         description: Missing the telemetry.manage permission.
+   */
+  router.get("/preview", manage, async (_req: Request, res: Response) => {
+    res.json(await reporter.preview());
+  });
+
+  /**
+   * @openapi
+   * /plugin-api/telemetry/send:
+   *   post:
+   *     summary: Send usage statistics now
+   *     description: Sends the report straight away. Does nothing while usage statistics are turned off.
+   *     tags: [Usage Statistics]
+   *     responses:
+   *       200:
+   *         description: Whether a report was sent.
+   *       403:
+   *         description: Missing the telemetry.manage permission.
+   *       502:
+   *         description: The report could not be delivered.
+   */
+  router.post("/send", manage, async (_req: Request, res: Response) => {
+    try {
+      res.json(await reporter.send({ force: true }));
+    } catch (error) {
+      res.status(502).json({
+        error: error instanceof Error ? error.message : String(error),
+      });
+    }
+  });
+
+  /**
+   * @openapi
+   * /plugin-api/telemetry/reset-id:
+   *   post:
+   *     summary: Reset the instance ID
+   *     description: Picks a new random instance ID, so later reports look like a new install.
+   *     tags: [Usage Statistics]
+   *     responses:
+   *       200:
+   *         description: The new ID.
+   *       403:
+   *         description: Missing the telemetry.manage permission.
+   */
+  router.post("/reset-id", manage, async (_req: Request, res: Response) => {
+    res.json({ instanceId: await reporter.resetInstanceId() });
+  });
+
+  /**
+   * @openapi
+   * /plugin-api/telemetry/usage/config:
+   *   get:
+   *     summary: Whether to count this user's feature usage
+   *     description: False when usage statistics or feature usage are off, or the user turned off their own part.
+   *     tags: [Usage Statistics]
+   *     responses:
+   *       200:
+   *         description: "{ track: boolean }"
+   */
+  router.get("/usage/config", async (_req: Request, res: Response) => {
+    res.json({ track: await shouldTrackUser(ctx, ctx.currentActor(), env) });
+  });
+
+  /**
+   * @openapi
+   * /plugin-api/telemetry/usage:
+   *   post:
+   *     summary: Add feature usage counts
+   *     description: Counts from the signed-in user's browser, added to the next report. Ignored when this user is not counted. Names and counts are checked and capped.
+   *     tags: [Usage Statistics]
+   *     requestBody:
+   *       required: true
+   *       content:
+   *         application/json:
+   *           schema:
+   *             type: object
+   *             properties:
+   *               features:
+   *                 type: object
+   *                 additionalProperties:
+   *                   type: integer
+   *     responses:
+   *       204:
+   *         description: Recorded or ignored.
+   */
+  router.post("/usage", async (req: Request, res: Response) => {
+    if (await shouldTrackUser(ctx, ctx.currentActor(), env)) {
+      const counts = sanitizeUsage(req.body?.features);
+      if (Object.keys(counts).length > 0) await usage.add(counts);
+    }
+    res.status(204).end();
+  });
+}
@@ -0,0 +1,75 @@
+import type { PluginKeyValue } from "@termix/plugin-sdk/backend";
+
+const USAGE_KEY = "usage";
+const FEATURE_NAME = /^[a-z][a-z0-9_.-]{0,63}$/;
+export const MAX_FEATURES = 100;
+const MAX_COUNT = 100_000;
+
+export type UsageCounts = Record<string, number>;
+
+/** Keeps valid names with positive whole counts, capped. */
+export function sanitizeUsage(input: unknown): UsageCounts {
+  const clean: UsageCounts = {};
+  if (!input || typeof input !== "object" || Array.isArray(input)) {
+    return clean;
+  }
+  for (const [name, raw] of Object.entries(input)) {
+    if (!FEATURE_NAME.test(name)) continue;
+    const count = Math.floor(Number(raw));
+    if (!Number.isFinite(count) || count <= 0) continue;
+    clean[name] = Math.min(count, MAX_COUNT);
+    if (Object.keys(clean).length >= MAX_FEATURES) break;
+  }
+  return clean;
+}
+
+export function createUsageStore(kv: PluginKeyValue) {
+  // One write at a time, so two requests never drop each other's counts.
+  let queue: Promise<unknown> = Promise.resolve();
+  const serial = <T>(fn: () => Promise<T>): Promise<T> => {
+    const next = queue.then(fn, fn);
+    queue = next.catch(() => undefined);
+    return next;
+  };
+
+  const read = async (): Promise<UsageCounts> =>
+    sanitizeUsage(await kv.get(USAGE_KEY));
+
+  return {
+    read,
+
+    add: (counts: UsageCounts) =>
+      serial(async () => {
+        const current = await read();
+        for (const [name, count] of Object.entries(sanitizeUsage(counts))) {
+          if (
+            !(name in current) &&
+            Object.keys(current).length >= MAX_FEATURES
+          ) {
+            continue;
+          }
+          current[name] = Math.min((current[name] ?? 0) + count, MAX_COUNT);
+        }
+        await kv.set(USAGE_KEY, current);
+      }),
+
+    /** Drops what a successful report already carried. */
+    subtract: (sent: UsageCounts) =>
+      serial(async () => {
+        const current = await read();
+        for (const [name, count] of Object.entries(sent)) {
+          const left = (current[name] ?? 0) - count;
+          if (left > 0) current[name] = left;
+          else delete current[name];
+        }
+        await kv.set(USAGE_KEY, current);
+      }),
+  };
+}
+
+export type UsageStore = ReturnType<typeof createUsageStore>;
+
+/** PostHog property name for a feature: used_tab_terminal. */
+export function usageProperty(name: string): string {
+  return `used_${name.replace(/[.-]/g, "_")}`;
+}
@@ -0,0 +1,191 @@
+import { useCallback, useEffect, useState } from "react";
+import { toast } from "sonner";
+import {
+  usePluginApi,
+  useTranslation,
+  type SettingsComponentProps,
+} from "@termix/plugin-sdk/frontend";
+import {
+  Button,
+  Dialog,
+  DialogContent,
+  DialogDescription,
+  DialogFooter,
+  DialogHeader,
+  DialogTitle,
+  useConfirmation,
+} from "@termix/plugin-sdk/ui";
+
+export interface TelemetryStatus {
+  enabled: boolean;
+  locked: boolean;
+  instanceId: string | null;
+  lastSentAt: string | null;
+  lastAttemptAt: string | null;
+  lastError: string | null;
+  nextDueAt: string | null;
+}
+
+function errorMessage(error: unknown): string {
+  const data = (error as { response?: { data?: { error?: string } } })?.response
+    ?.data;
+  if (data?.error) return data.error;
+  return error instanceof Error ? error.message : String(error);
+}
+
+export function TelemetryStatusSetting({ running }: SettingsComponentProps) {
+  const { t } = useTranslation();
+  const api = usePluginApi();
+  const { confirmWithToast } = useConfirmation();
+  const [status, setStatus] = useState<TelemetryStatus | null>(null);
+  const [sending, setSending] = useState(false);
+  const [preview, setPreview] = useState<unknown>(null);
+
+  const load = useCallback(async () => {
+    try {
+      const { data } = await api.get<TelemetryStatus>("/status");
+      setStatus(data);
+    } catch {
+      setStatus(null);
+      toast.error(t("status.loadFailed"));
+    }
+  }, [api, t]);
+
+  useEffect(() => {
+    if (running) void load();
+  }, [running, load]);
+
+  async function sendNow() {
+    setSending(true);
+    try {
+      const { data } = await api.post<{ sent: boolean }>("/send");
+      if (data.sent) toast.success(t("status.sent"));
+      else toast.info(t("status.notSent"));
+    } catch (error) {
+      toast.error(errorMessage(error));
+    } finally {
+      setSending(false);
+      await load();
+    }
+  }
+
+  async function showPreview() {
+    try {
+      const { data } = await api.get("/preview");
+      setPreview(data);
+    } catch (error) {
+      toast.error(errorMessage(error));
+    }
+  }
+
+  function resetId() {
+    void confirmWithToast(t("status.resetIdConfirm"), async () => {
+      try {
+        await api.post("/reset-id");
+        toast.success(t("status.resetIdDone"));
+        await load();
+      } catch (error) {
+        toast.error(errorMessage(error));
+      }
+    });
+  }
+
+  let summary = t("status.off");
+  if (status?.locked) {
+    summary = status.enabled ? t("status.lockedOn") : t("status.lockedOff");
+  } else if (status?.enabled) {
+    summary = t("status.on");
+  }
+
+  const muted = "text-[10px] text-muted-foreground";
+
+  return (
+    <div className="flex flex-col gap-2 border border-border bg-background/50 p-2">
+      <span className="text-xs font-medium">{t("status.title")}</span>
+      {status && (
+        <>
+          <span className={muted}>{summary}</span>
+          <span className={`${muted} break-all`}>
+            {status.instanceId
+              ? t("status.instanceId", { id: status.instanceId })
+              : t("status.noInstanceId")}
+          </span>
+          <span className={muted}>
+            {status.lastSentAt
+              ? t("status.lastSent", {
+                  date: new Date(status.lastSentAt).toLocaleString(),
+                })
+              : t("status.neverSent")}
+          </span>
+          {status.enabled && status.nextDueAt && (
+            <span className={muted}>
+              {t("status.nextSend", {
+                date: new Date(status.nextDueAt).toLocaleString(),
+              })}
+            </span>
+          )}
+          {status.lastError && (
+            <span className="text-[10px] text-destructive">
+              {t("status.lastError", { error: status.lastError })}
+            </span>
+          )}
+        </>
+      )}
+      <div className="flex flex-wrap gap-2">
+        <Button
+          type="button"
+          variant="outline"
+          className="rounded-none"
+          disabled={!running}
+          onClick={showPreview}
+        >
+          {t("status.preview")}
+        </Button>
+        <Button
+          type="button"
+          variant="outline"
+          className="rounded-none"
+          disabled={!running || sending || !status?.enabled}
+          onClick={sendNow}
+        >
+          {sending ? t("status.sending") : t("status.sendNow")}
+        </Button>
+        <Button
+          type="button"
+          variant="outline"
+          className="rounded-none"
+          disabled={!running}
+          onClick={resetId}
+        >
+          {t("status.resetId")}
+        </Button>
+      </div>
+      <Dialog
+        open={preview !== null}
+        onOpenChange={(open) => !open && setPreview(null)}
+      >
+        <DialogContent className="rounded-none sm:max-w-2xl">
+          <DialogHeader>
+            <DialogTitle>{t("status.previewTitle")}</DialogTitle>
+            <DialogDescription>
+              {t("status.previewDescription")}
+            </DialogDescription>
+          </DialogHeader>
+          <pre className="max-h-[60vh] overflow-auto border border-border bg-muted/40 p-2 text-[11px]">
+            {JSON.stringify(preview, null, 2)}
+          </pre>
+          <DialogFooter>
+            <Button
+              type="button"
+              variant="outline"
+              className="rounded-none"
+              onClick={() => setPreview(null)}
+            >
+              {t("status.close")}
+            </Button>
+          </DialogFooter>
+        </DialogContent>
+      </Dialog>
+    </div>
+  );
+}
@@ -0,0 +1,12 @@
+import type { TermixApp } from "@termix/plugin-sdk/frontend";
+import { TelemetryStatusSetting } from "./TelemetryStatusSetting";
+import { startTabTracker } from "./tracker";
+
+export function activate(app: TermixApp): void {
+  app.registerSettingsComponent("status", TelemetryStatusSetting);
+  if (!app.guest) app.onDispose(startTabTracker(app));
+}
+
+export function deactivate(): void {
+  // Registrations through app are disposed by core.
+}
@@ -0,0 +1,109 @@
+import type { TermixApp } from "@termix/plugin-sdk/frontend";
+
+export const FLUSH_INTERVAL_MS = 5 * 60 * 1000;
+
+type Counts = Record<string, number>;
+
+/** Open tabs per type. Slot ids change on every read, so only types count. */
+export function countTabTypes(layout: unknown): Counts {
+  const tabs = (layout as { tabs?: unknown } | null)?.tabs;
+  const counts: Counts = {};
+  if (!Array.isArray(tabs)) return counts;
+  for (const tab of tabs) {
+    const type = (tab as { type?: unknown })?.type;
+    if (typeof type === "string" && type)
+      counts[type] = (counts[type] ?? 0) + 1;
+  }
+  return counts;
+}
+
+/** Tabs opened between two snapshots, keyed as tab.<type>. */
+export function openedSince(before: Counts, after: Counts): Counts {
+  const opened: Counts = {};
+  for (const [type, count] of Object.entries(after)) {
+    const added = count - (before[type] ?? 0);
+    if (added > 0) opened[`tab.${type}`] = added;
+  }
+  return opened;
+}
+
+/**
+ * Counts which kinds of tabs the user opens and sends the totals to the
+ * plugin's backend every few minutes. Does nothing unless the backend says
+ * this user is counted.
+ */
+export function startTabTracker(
+  app: TermixApp,
+  flushMs: number = FLUSH_INTERVAL_MS,
+): () => void {
+  let track = false;
+  let ready = false;
+  let previous: Counts = {};
+  let pending: Counts = {};
+
+  const snapshot = () => countTabTypes(app.tabs.getLayout());
+
+  const refreshConfig = async () => {
+    try {
+      const { data } = await app.api.get<{ track?: boolean }>("/usage/config");
+      track = data?.track === true;
+    } catch {
+      track = false;
+    }
+    if (!track) pending = {};
+  };
+
+  const flush = (keepalive = false) => {
+    if (!track || Object.keys(pending).length === 0) return;
+    const features = pending;
+    pending = {};
+    void app
+      .fetch("/usage", {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({ features }),
+        keepalive,
+      })
+      .catch(() => undefined);
+  };
+
+  const disposers: Array<() => void> = [];
+
+  disposers.push(
+    app.tabs.onReady(() => {
+      // Tabs restored after login were opened in an earlier session.
+      previous = snapshot();
+      ready = true;
+    }),
+  );
+
+  disposers.push(
+    app.tabs.onChange(() => {
+      const current = snapshot();
+      if (ready && track) {
+        for (const [name, count] of Object.entries(
+          openedSince(previous, current),
+        )) {
+          pending[name] = (pending[name] ?? 0) + count;
+        }
+      }
+      previous = current;
+    }),
+  );
+
+  disposers.push(app.onSettingsChanged(() => void refreshConfig()));
+
+  const timer = setInterval(() => flush(), flushMs);
+  disposers.push(() => clearInterval(timer));
+
+  const onPageHide = () => flush(true);
+  window.addEventListener("pagehide", onPageHide);
+  disposers.push(() => window.removeEventListener("pagehide", onPageHide));
+
+  void refreshConfig();
+
+  return () => {
+    flush(true);
+    for (const dispose of disposers) dispose();
+  };
+}