diff --git a/.env.example b/.env.example index bfd61b36..706b402a 100644 --- a/.env.example +++ b/.env.example @@ -7,7 +7,17 @@ KEY_ENCRYPTION_KEY=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA= # one to leave alone until somebody has decided otherwise: the trail is append-only and nothing else # can remove a row, so this is the only way it ever shrinks. # AUDIT_RETENTION_DAYS=365 +# Two names for one number, and they have to agree. +# +# The server reads PORT (server/src/index.ts). scripts/start.sh reads SERVER_PORT, because it also +# has to know where the app should proxy and which port to report free -- and docs/configuration.md +# documents SERVER_PORT as the setting. Only PORT shipped here, so moving the server by editing this +# line left the script still looking at 3001: it found whatever else was there, accepted the first +# 200 as proof, and failed several stages later parsing that stranger's HTML as JSON. +# +# Change both, or neither. PORT=3001 +SERVER_PORT=3001 TENANT_PACKAGE_DIR=../examples/fintech # What this deployment calls itself, when more than one shares an Intelligence project. A copy of a # deployment made for development uses the same project key, and threads are listed per Bot with @@ -230,8 +240,13 @@ COMPUTER_TOKEN= # # This is attribution, not anonymity, and it is not a boundary by itself: it gives a security team a # per-Bot address for network rules alongside AGENT_COMPUTER_POLICY. -# EGRESS_PROXY_DEFAULT=http://user:password@proxy.internal:8080 -# EGRESS_PROXY_SALES_BOT=http://sales.proxy.internal:8080 +# +# These go in `egress.env` beside this file, NOT here. The names are per-Bot, so Compose cannot +# list them the way it lists every variable below, and it hands a container only what it is told to. +# In `.env` they reach no process and the browser goes out directly with nothing saying so. +# +# EGRESS_PROXY_DEFAULT=http://user:password@proxy.internal:8080 +# EGRESS_PROXY_SALES_BOT=http://sales.proxy.internal:8080 # The managed coworker AG-UI endpoint. Optional: use an HTTP(S) URL, and set MANAGED_AGENT_TOKEN diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a5f0ec41..a5550af0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -73,6 +73,83 @@ jobs: - run: bun run typecheck working-directory: ${{ matrix.package }} + chart: + name: chart (${{ matrix.target }}) + runs-on: ubuntu-latest + strategy: + # One red target must not hide whether another is red too. + fail-fast: false + matrix: + target: [self-hosted, eks, eks-sandbox, gke, aks] + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + persist-credentials: false + - uses: azure/setup-helm@9bc31f4ebc9c6b171d7bfbaa5d006ae7abdb4310 # v5.0.1 + with: + version: v3.19.0 + # For the coherence check below, which is a Bun script like everything else here. + - uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2.2.0 + with: + bun-version: 1.3.14 + # Nothing rendered this chart until now, which is how four values files that produce a server + # unable to start were shipped and stayed shipped. Rendering is the cheap half; the refusals in + # validation.yaml are the half that catches a missing value before a cluster does. + - run: helm dependency build charts/openbot + # Structure only. `helm lint` reports a template `fail` as an INFO line and exits 0 even under + # `--strict`, which was driven and confirmed, so it cannot gate the refusals below. Rendering + # does: `helm template` exits non-zero on one. + - run: helm lint charts/openbot --values charts/openbot/ci/${{ matrix.target }}-values.yaml + # A key encryption key is a real 32 bytes rather than a placeholder, because the chart checks + # its shape. Generated here so no example key is ever a literal in this repository. + - name: Render + run: | + helm template ci charts/openbot \ + --values charts/openbot/ci/${{ matrix.target }}-values.yaml \ + --set-string secrets.keyEncryptionKey="$(openssl rand -base64 32)" \ + --api-versions agents.x-k8s.io/v1beta1/Sandbox \ + --api-versions extensions.agents.x-k8s.io/v1beta1/SandboxTemplate \ + > rendered.yaml + # Rendering proves the templates run. This proves the result is coherent, which is a different + # question: every secret key a container demands has to be one the chart actually writes. + # Getting that wrong is invisible until a pod starts, and every shipped target had it wrong. + - run: bun scripts/check-rendered-chart.ts rendered.yaml + # And that the refusals are load-bearing rather than decorative. A chart full of `fail` + # messages nothing ever triggers is a chart that has never been shown to refuse anything, and + # every one of these describes a state that shipped in a values file at some point. + - name: Refusals fire + run: | + set -uo pipefail + refuses() { + local why="$1"; shift + if helm template ci charts/openbot \ + --values charts/openbot/ci/${{ matrix.target }}-values.yaml \ + --set-string secrets.keyEncryptionKey="$(openssl rand -base64 32)" \ + --api-versions agents.x-k8s.io/v1beta1/Sandbox \ + --api-versions extensions.agents.x-k8s.io/v1beta1/SandboxTemplate \ + "$@" >/dev/null 2>&1; then + echo "::error::The chart rendered $why, which it is supposed to refuse." + return 1 + fi + echo "refused: $why" + } + # The public example key, which the server will not start with. Only where this chart + # holds the secret: with a store, the value is not readable at template time, so the + # refusal is deliberately not armed and asserting it here would be asserting a bug. + if ! grep -qE '^ *enabled: true' <(sed -n '/^externalSecrets:/,/^[a-z]/p' charts/openbot/ci/${{ matrix.target }}-values.yaml); then + refuses "the public example encryption key" \ + --set-string secrets.keyEncryptionKey="$(head -c 32 /dev/zero | base64)" + else + echo "skipped: the example-key refusal is not armed when the secret comes from a store" + fi + # A Bot endpoint with nothing on the request that says who is calling. Armed whether the + # secret is this chart's or a store's, because the key list is readable either way. + refuses "a managed agent URL with no token" \ + --set-string config.managedAgent.url=http://agent.default:8000/ag-ui + # A browser inside every replica of a replicated API. + refuses "an embedded browser across several replicas" \ + --set server.embeddedComputer=true --set server.replicaCount=2 + test: name: tests runs-on: ubuntu-latest @@ -261,7 +338,7 @@ jobs: name: verify runs-on: ubuntu-latest if: always() - needs: [static, deployables, test, build, migrations, image] + needs: [static, deployables, chart, test, build, migrations, image] steps: - name: Require every check env: diff --git a/.gitignore b/.gitignore index f5d48e06..bfc1237c 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,8 @@ docs/plans/ .env .env.* !.env.example +# Per-Bot egress proxies. Carries credentials in the URL, like .env does. +egress.env node_modules/ **/dist/ app/src/lib/generated/application-config.ts @@ -21,3 +23,8 @@ app/src/lib/generated/application-config.ts # TanStack Router scratch output app/.tanstack/ + +# Helm subchart tarballs, fetched by `helm dependency build`. The lock beside them is NOT ignored: +# it is what makes that fetch reproducible, and ignoring it meant every build resolved the dependency +# afresh, so CI and a customer install could take different subchart versions with no diff to show it. +charts/*/charts/ diff --git a/CHANGELOG.md b/CHANGELOG.md index cbee9e84..25d106f0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,279 @@ Newest first. `Unreleased` is what is on `main` and not yet tagged. ## Unreleased +### A channel a Bot has spoken in unseen shows a dot + +The sidebar marks a channel when a Bot has said something since you last had it open: a dot beside +the preview, the name a touch heavier. Opening the channel clears it, your own messages never set +it, and the channel you are looking at never shows it. The marker is yours alone — per member, on +the membership row like the pin — so one person reading does not clear anybody else's dot. + +The deployment gains one nullable column, via migration `0019`. + +### The API can reach Intelligence and sign-in when a NetworkPolicy is on + +`networkPolicy.enabled` wrote a rule for the API server that named DNS, the database and the Bots' +computers, and nothing on 443. On a cluster that enforces policy the server could therefore reach +neither CopilotKit Intelligence, nor an identity provider, nor a Bot: nobody could sign in and no +conversation ran. Two of the five shipped `ci/` targets turn the policy on, and on GKE enforcement is +the default and cannot be switched off. + +Nothing said so. The pod passed every probe and stayed Ready, because `/health` answers from a +literal, so the first evidence was a timeout to a hostname that read as the internet being down. + +The API now reaches HTTP and HTTPS everywhere outside the cluster's private ranges, in every +`computers.mode` rather than only `sandbox`, cut by the same exception list the computers' own policy +uses. It still cannot address another pod, a node, or a cloud metadata endpoint. + +`mode: sandbox` had been working only because a rule meant for the Kubernetes API server carried no +destination and so permitted everything. That rule now covers the API server alone, and +`networkPolicy.kubernetesApiCidr` narrows it to your cluster's service range; left empty it stays as +it was, because a chart cannot know that range. +### Taking the wheel stops the Bot's shell, not just its clicks + +While a person held the wheel the Bot was refused on the page, and not in the shell. `/exec` and a +workspace write went through, so a Bot could keep running commands and rewriting its `/workspace` +underneath somebody who had taken the browser at a login wall. The guard existed and covered +navigation and the four page actions; the shell arrived later and was never wired to it. + +Every acting path now asks the same question in one place, so the property the documentation states +is the property the computer has. Reading is deliberately not acting: `/files/read` and +`/files/list` still answer while a person drives, because a Bot that has just been stopped still has +to be able to say what it was doing. + +Nothing to configure. A Bot that acts during a takeover gets the refusal it already got for a click, +and the trail records the attempt and the failure the same way. + +### A finished turn shows the page it opened, not the one open now + +Reopening a conversation made every past turn fetch the screen as it is now, so an answer about +Hacker News from an hour ago sat under a picture of whatever the Bot had open since. + +A page is now photographed where it is opened. The server takes the frame the moment a navigation +succeeds and keeps it in `computer_page_frame` under the computer and the address, which is the one +moment the screen is certainly showing the page that was asked for. Reopening the conversation shows +that frame rather than the live screen, and a turn with nothing kept names the page instead of +drawing the wrong one. + +The surface used to capture it itself once the turn went quiet, and that is a race it cannot win: a +reopened turn and one that has just finished are indistinguishable from inside the component, the +same computer is driven by other conversations in between, and a resumed computer starts blank. It +filed pictures of pages the turn never opened, or none at all. It only reads now. + +**Redeploy the computers with the server.** A screenshot only says which page it is of on an +`agent-computer` built after that field was added, and this is what decides whether a frame is kept. +Where each Bot has a computer of its own there is nobody to race with, so an old computer's picture is +accepted and the feature works through a rollout. On ONE SHARED COMPUTER it cannot be: another Bot's +navigation lands between the navigation and the picture, and a frame that cannot be told apart from +theirs is refused. So a shared-computer deployment that updates the server and not the computer keeps +no frames until it does, and says so in the server log each time rather than leaving somebody to +wonder. + +Two things followed from making a past turn a record. Its placeholder is decided by the turn being +over rather than by whether a live frame happens to be in hand, because a tile that was live a moment +ago keeps its last screenshot and used to fall through to "Waiting for the assistant's screen…" and +wait there for ever. And opening one full size shows that same kept frame, with no live stream and no +wheel: zooming a past turn used to mount the socket and offer Take control, so the one gesture for +looking closer at what a turn did replaced it with whatever the Bot has open now. + +### A conversation keeps the browsing that produced its answers + +Every turn in which a Bot used a tool was disappearing from the transcript on reload. The sentence +the Bot wrote stayed; the browsing that produced it did not, the inline screen went with it, and the +footer said some messages could not be read. + +The history store writes a tool call as `{id, name, args}`. AG-UI describes +`{id, type: "function", function: {name, arguments}}`. The reader validated against the second, +treated the first as damage from an interrupted run, and dropped it. It is not damage: it is how +every tool call is stored, so what looked like a guard against one bad turn was deleting all of the +real ones. Observed on a live thread where every browsing turn was counted unreadable and every one +of them was well formed in the store's own dialect. + +The two spellings are now read as the same thing. The check stays for turns that really are +malformed, and a mixed or unrecognised array is still refused rather than half-translated, because a +reader that rewrites what it does not recognise is worse than one that refuses it. + + +### Run this on Kubernetes + +A Helm chart under `charts/openbot`, Bots and all, and the fixes that installing it for real turned +up. Proven on a real EKS cluster: five workloads, replicas across two nodes, EBS volumes bound, and a +Bot opening a real page from inside AWS with the decision in the audit trail. + +One chart, four targets: EKS, GKE, AKS and somebody's own cluster, with nothing but values between +them. There is no cloud branching in any template. Every place the clouds genuinely differ is a +value whose default is what a plain self-hosted cluster does: the cluster's own default StorageClass, +no RuntimeClass, a plain Kubernetes Secret, an Ingress. Identity is one `serviceAccount.annotations` +map, which is all IRSA, Workload Identity and AKS workload identity are. Secrets are a plain Secret +by default and an ExternalSecret against any backend when asked, so Secrets Manager, Secret Manager +and Key Vault are a values block rather than three code paths. Gateway API is supported beside +Ingress rather than instead of it. `charts/openbot/ci` holds a values file per target. + +Two replicas by default, because horizontal is the point and one replica hides every bug that is +not. A bad install is refused at `helm install`, naming the value to change, rather than discovered +in a crash loop: no database or two of them, nobody who could sign in, nobody who would be an +administrator, a key of the wrong shape, both routers enabled, or a browser asked for inside more +than one replica. + +**A Bot's computer is not in an API pod.** The image runs one beside the API so that a single +container works on its own, and `EMBEDDED_COMPUTER=off` turns it off. A replica must not carry a +browser: it is a few hundred megabytes holding one Bot's logins, so scaling the API would scale +those with it. + +**Migrations no longer need a development tool.** `bun x drizzle-kit migrate` cannot run in the +shipped image at all. The CLI reads a TypeScript config, which needs the esbuild that +`bun install --production` correctly leaves out, so it printed "Reading config file", exited 1 and +said nothing else. `EMBEDDED_POSTGRES=on` was therefore starting a container whose database was +never migrated, and the first symptom was the API reporting that `users` does not exist. +`server/scripts/migrate.ts` uses the migrator inside `drizzle-orm`, which is a runtime dependency +already, and keeps the same journal, so a database migrated by either tool is migrated. + +**A computer for each Bot, suspended when idle.** `computers.mode: sandbox` gives every Bot its own +browser as a `Sandbox` from `kubernetes-sigs/agent-sandbox`, which is built for this workload: an +isolated, stateful, singleton pod with a stable identity and persistent storage. Suspending is one +field, and it keeps the volumes, so a computer comes back with its logins rather than signed out of +everything. `shared` stays the default and needs nothing installed in the cluster. + +**The NetworkPolicy would have fenced the API off from its own work.** Its egress named DNS and the +bundled database and nothing else, so on a cluster that enforces policy the API could not have +reached a Bot's computer or, with a managed database, the database. Both are allowed now, and turning +the policy on with an external database and no rule for it is refused rather than shipped. Worth +knowing either way: EKS runs its CNI with `--enable-network-policy=false`, so a policy there installs, +looks right, and does nothing at all. + +**A cluster with no controller is refused at install.** `computers.mode: sandbox` needs the +agent-sandbox CRD, and without it the install succeeds, every pod is healthy, and the deployment +looks finished until the first Bot asks for a browser. The chart reads the cluster and refuses, +naming the one command that fixes it. + +**What decides a computer is idle is the audit trail, not the browser.** Asking the browser would +wake it, so every computer anything asked about would come back up and the bill would never fall. + +**Durable work, claimed by whichever replica gets there first.** `work_items` plus +`select ... for update skip locked` and a lease: no coordinator, no leader election, and a replica +added is throughput added. The idle-computer culler is its first user; scheduled routines and +hand-offs between Bots are the other two, which is why it is written once rather than three times +slightly differently. A CronJob runs the sweep, because a timer in the API fires in every replica and +suspending a browser somebody just started using is not something to do five times. + +**Which run of a computer this is, across a suspend.** A resumed browser counts snapshot +generations from one again, so a ref the model still holds from before the suspend would match a row +nothing has overwritten and the boundary would decide about an element on a page that no longer +exists. The first answer here used the node and the pod address, and resuming a real computer +disproved it: a suspended sandbox is very often rescheduled onto the same node and handed the same +address back, so both were identical across a suspend and resume and the check would have said "same +run" for the exact case it exists to catch. It reads the `Ready` condition's transition time instead, +which moves every time a computer starts serving again. + +**Which run of a computer this is, on more than one replica.** `sessionOf` answered from a map in +the process that started the computer, which is right until there are two: the replica that took a +snapshot is usually not the one handling the click, and the second had nothing to answer with. An +unknown session means "no opinion" and skips the generation check, so on exactly the deployment +shape it was written for, the check that stops a ref from a replaced computer resolving against a +live one was silently absent. It now asks the supervisor when it does not know, by listing rather +than by ensuring, so asking never starts a computer that had stopped. +### Notion joins the connector catalogue + +Notion is now a governed MCP connector, reached through Notion's own hosted server on the +catalogue's default transport, as the person asking — the same grant, policy and audit machinery +Google Drive already runs through. Unlike Drive, it ships both read and write tools from the start; +the writing ones are named in the catalogue, and an advertised tool absent from that list classifies +as a read — so reconciling the write-tool names against what Notion's hosted server actually calls +them, on the first Refresh tools, is required, not cosmetic. A tool the server never advertised at +all still classifies as a write, same as any other connector. + +There is no client to register: this deployment introduces itself to Notion on first connect. That +shortens setup but does not finish it — unlike Drive, whose tool list is this codebase's own code, +Notion's tool list is an answer from Notion's hosted server, so a deployment has recorded none of it +until Refresh tools has run at least once; and, like every other connector, a Bot gets nothing until +its tools are granted to it. Setup is enable at `/admin/plugins/notion`, connect an account at +`/settings/connected-accounts`, refresh tools, then grant — a bulk **Grant tools…** dialog on +`/admin/plugins/notion` grants a batch of tools to a batch of Bots in one pass, one grant and one +audit row per Bot per tool. No migration. + +### Refresh tokens rotate in place, and replicas take turns spending them + +A vendor that rotates refresh tokens invalidates the one it just handed out, so two replicas racing +to use a stale token would have the loser refused, or worse: a rotating vendor's reuse detection can +read that as a stolen token and revoke the whole connection. Every plugin call that mints an access +token now locks the credential's vault row for the length of the exchange, so a second replica waits +rather than races, and the rotated token is written back in the same transaction that held the lock. +Nothing to configure; a connection just stops going stale under concurrent traffic. + +### An MCP token is spent only by its own server, and only at the address it was given + +Pointing a server at a credential is the one place this deployment takes a reference to a stored +secret rather than the secret itself. Everywhere else, the value was typed into the same request that +stores it: a Bot's key is minted from what an administrator pasted and the id it gets is nobody's to +choose. So this is the one field where which secret and which address could be made to disagree, and +the add settles the disagreement by spending the credential: the tool refresh runs before the call +returns and sends what it decrypts to the URL from that same request. + +Two ways they could disagree, and both are now refused. A server could be pointed at any `mcp` +credential in the vault, including one minted for a different vendor, so a token given to one server +was deliverable to another. And re-adding a server with a different URL rewrote the address while +keeping the credential, so the same token could be sent somewhere else entirely with no +cross-server trick at all: the token really did belong to that server, and only the address moved. + +The second is why the first was not enough on its own. A credential now has to belong to the server +it is attached to, and a server that already holds one cannot be re-added at a different address. +Correcting a title or retrying an interrupted add sends the same URL and is unaffected. A server +holding no credential can still be re-addressed, because there is nothing to misdirect. Moving a +server that does hold one means removing it and adding it again with the token the new address is +meant to have, which is the honest description of what has happened anyway. + +This matters more than "an administrator could misconfigure something". A stored credential cannot +be read back by anybody, by design: the credentials screen answers that a credential exists and +never what it is. These two shapes were the way around that, so a deployment where somebody has +used them should treat the credentials involved as disclosed and rotate them. + +A token also stops outliving the server it was minted for. Re-adding a server without naming a +credential used to clear the pointer while leaving the credential live, and removing a server retires +its token by reading it off that pointer, so a cleared one meant the token survived its server and +could be attached to a freshly created one at any address, where there was no longer a stored address +to compare against. Three ordinary acts in a row and the binding above stopped meaning anything. The +pointer now survives a re-add that names none, removal therefore finds and retires it, and a retired +credential is refused rather than quietly attached to fail on its next call. + +Curated servers keep working as they did. Their URL comes from the catalogue rather than the +request, and a per-instance hostname is matched against the vendor's own anchored pattern before +anything is stored, so re-adding one cannot point it at an address of the caller's choosing. +### A configured egress proxy reaches the browser that uses it + +`EGRESS_PROXY_DEFAULT` and `EGRESS_PROXY_` were documented as the way to give a Bot a stable +outbound address, and Compose passed neither to anything. `docker-compose.yml` named no egress +variable and had no `env_file`, so the shared computer resolved every Bot to no proxy and went out +directly, and under the supervisor the same emptiness meant there was nothing to forward into the +computers it creates. + +The failure was silent, which for a setting whose purpose is to give a security team a per-Bot +address for network rules is the worst of the available failures. The stack started, the browser +left by the host, and the Computers screen reported "Leaves directly" because it was reading the +same empty environment. + +They now live in `egress.env`, which both the computer and the supervisor are given. A file rather +than more `environment:` entries because `EGRESS_PROXY_` is derived from a Bot's id and there +is no fixed set of names to list; a file of its own rather than `.env` because that one holds the +deployment's secrets and the container running a browser and a Bot's shell is deliberately not +given them. It is optional, so a deployment with no proxy is unchanged, and gitignored, because a +proxy URL can carry a password. + +**Move these two out of `.env` and into `egress.env`.** In `.env` they reach no process. +### Screens without a conversation stop polling for a Bot that does not exist + +Every surface asks which components its Bot holds, and asks again every few seconds so a revoked +grant leaves an open conversation quickly. The Bot it asked about was whichever one the surface +declared — and on a screen with no conversation at all, that was the placeholder id the routing +holder falls back to, which no package registers and the server answers 404 for. An admin page left +open polled a guaranteed miss every five seconds, indefinitely. + +Nothing looked wrong. The screen rendered, because an absent grant list and an empty one draw the +same. The cost was the noise: a request log where the same 404 repeats forever is one where the 404 +that matters is invisible. + +The grant queries now wait for a surface to declare a real Bot, and simply do not run while the +placeholder holds. Conversation surfaces — the Bot page, channels — declare one and are unchanged. + ### Knowledge searches instead of guessing A package can say which of its skills each coworker gets, and the fintech example gives Knowledge the @@ -59,6 +332,60 @@ this port has to reach it another way**, which is what publishing it on every in This does not reach back in time. A deployment that has been running with the two on one network should assume a Bot could have read or written the database, and look at the trail with that in mind. +### A credential in an MCP server address is refused in the query and the fragment too + +Refusing `https://user:token@vendor.example/mcp` closed the userinfo spelling of a credential in the +address and left the two obvious ones open. `?token=`, `?api_key=` and their neighbours were still +accepted, and the address is stored and named in the trail exactly as given: audit redaction keys on +the field name, `url` is not a sensitive one, so the secret was written to `mcp_servers` and to an +append-only audit row in clear text. That is the same disclosure the userinfo rule exists to prevent, +one character away. + +A parameter whose name reads as a credential is now refused, in the query string and in the fragment, +and the refusal points at the token field without repeating what was typed. The name is read rather +than matched against a list, so `?auth_token=`, `?x-api-key=` and `?X-Amz-Signature=` are refused +alongside `?token=`: a rule that only catches the spellings somebody thought of reads as a guard +while behaving like a gap. The test is on the parameter name rather than on the presence of a query, +because vendors route and version with parameters and a floor that refused every one of them would +be one an operator works around instead of with. `https://mcp.example.com/mcp?workspace=acme&version=2` +is unaffected, and so is an ordinary fragment. A credential written into the *path* is still +accepted: it is indistinguishable from a route, and at least one hosted provider addresses servers +that way. **A deployment where somebody has put a credential in an address should treat it as +disclosed and rotate it**, for the same reason as before: the audit row cannot be deleted. + +`metadata.goog` is refused too. It is Google's own short name for the metadata server, published +beside `metadata.google.internal`, and it carries a dot and none of the suffixes this check lists, so +it read as an ordinary vendor name. The long spelling was only ever refused incidentally, by the +`.internal` rule. Both are now named, so the address this check was written for is refused on purpose +rather than by luck. +### A curated MCP server is pointed at its own kind of credential too + +Adding a server by URL was made to check which credential it is being pointed at. Adding one from the +catalogue, the other half of the same screen, took the same field from the same request and stored it +unread, so a credential of any kind could be attached to a curated server and spent by the refresh +that runs before the add returns. + +Worth being plain about the reach, because it is narrower than the path beside it. The column is a +foreign key, so an id naming nothing was already refused by the database, and the one entry in the +catalogue is reached with each person's own Google account, whose OAuth client is registered through +its own call and sent to an address pinned in code. Nothing could be delivered to an address a caller +chose. What was reachable was a credential of the wrong kind being accepted and spent on behalf of +somebody who never agreed to it, and a malformed id arriving as a database error rather than as a +refusal. + +The rule now comes from the entry: a server the deployment holds one token for takes that token, and +a server answered as the person asking takes no credential when it is added, because its client +arrives through the call that mints it. Both add paths ask the same question in the same words, so a +credential that does not exist and one of the wrong kind are still refused identically and the +endpoint cannot be used to ask which ids are real. Adding a curated server the way the admin screen +does is unchanged. + +Adding a curated server that is already there no longer clears the credential it points at. The +column holds the OAuth client that registering one put there, and re-adding the server to change an +instance host said nothing about that client, but cleared it anyway: the credential row was left +behind with nothing pointing at it and nothing to revoke it, and everybody who had connected their +account was told the deployment has no client registered. A re-add that names no credential now +leaves the one that is there alone. ### Name the private addresses an agent may live at @@ -233,6 +560,24 @@ without a word, because the input path looks for a viewer before it looks for an A close now stops casting only when the socket closing is the one that was casting. +### A sidebar channel row can be pinned or deleted + +Right-click on a channel in the sidebar and a menu opens with two entries: Pin channel and Delete +channel. + +Pin is held per member rather than per channel, so pinning one holds it at the top of your own +roster — newest first among pinned channels — and leaves every other member's roster unaffected. + +Delete is confirmed in a dialog first, and it is soft. The channel disappears from every member's +roster and from a direct fetch of it, while the row, its transcript, and its Intelligence thread all +survive. That disappearance is live, not just on next load: every member's open tabs drop the row as +the delete lands, and a tab parked on the channel itself is sent home. The deletion is audited as its +own `channel.deleted` row. A channel the deployment package defines is refused, with the reason +named. Recovery today is clearing `channels.deleted_at` in the database directly; there is no restore +control in the product. + +The deployment gains two nullable columns, via migration `0016`. + ### An MCP server address that points inside the deployment is refused in three more spellings Adding an MCP server by URL is checked before the address is stored, because that form is otherwise a @@ -286,29 +631,44 @@ one they are, so those match too. No configuration changes and nothing is stored differently; a deployment that was already on the light theme sees no difference at all. +### `start.sh` refuses a port that answers but is not OpenBot + +The startup checks asked whether a port answered, and treated that as proof the port belonged to this +stack. Those are not the same claim. Any single-page app serves its index.html for every path it does +not recognise, so an unrelated dashboard on a default port answers `200` to `/api/capabilities` as +readily as this server does. + +The cost was not a wrong answer, it was a wrong answer three stages later. `require_free_or_ours` +reported "already up", so the server was never started; `wait_for` then printed a green +"server ready"; and the run failed at stage 3 inside `json.loads`, parsing that stranger's HTML. The +error names `char 0`, which reads like an empty response rather than a `<`, so the visible symptom +pointed nowhere near the port. + +Each surface is now asked for something only it can produce: a `licenseStatus` field for the server, +its own `` for the app, `/health` for the compose services. When a check gives up it says +whether the process failed to start or the port belongs to something else. + +The root cause was in `.env.example`, and is fixed there too. The server reads `PORT`, this script +reads `SERVER_PORT`, `docs/configuration.md` documents `SERVER_PORT` as the setting, and only `PORT` +shipped. Moving the server by editing that one line left the script still looking at 3001. Both names +are now present, next to each other, saying they have to agree. + +**A run may now stop where it used to continue.** That is the point: it stops at the port that is +wrong, naming it, rather than several steps later on a parse error. + +### `docker compose up -d` configures the same stack `scripts/start.sh` does + +`SUPERVISOR_TOKEN` and `COMPUTER_TOKEN` defaulted to the empty string in `docker-compose.yml`, so +which stack you got depended on how you brought it up. `scripts/start.sh` resolves both to their +`openbot-dev-*` defaults and exports them before calling compose. A plain `docker compose up -d` — +which this project's own shutdown notes tell you to use — passed an empty string instead. + +`agent-computer` refuses to start without one, so that half failed loudly. The supervisor half was +the quiet one: the server kept the token it started with while the supervisor held an empty string, +and every call between them was refused at the door. -### A conversation can be deleted - -Nothing removed a channel. Starting one was the only lever the product gave a person, and every -conversation with every coworker sat in the roster forever, growing on every message the way -`DEFAULT_CHANNEL_PAGE`'s own note already described: a page that was instant in a demo returns -thousands of rows for anybody who has actually been using the product a while, one that never shrinks -again. - -Deleting a channel now removes it for good. The channel row goes, and its memberships, its linked -coworkers, and its Intelligence thread mapping go with it through the same foreign-key cascades that -already existed for them — no migration needed, only a query that finally uses them. The deployment -also asks Intelligence to permanently delete the thread itself, so the message history is not just -unlisted, it is gone from the platform too. - -A thread the platform refuses to delete does not hold the channel hostage. The local removal already -committed by the time that call runs, so a rejected or unreachable upstream delete leaves the channel -gone from the roster regardless, with an audit row (`channel.deleted`) naming the thread and whether -Intelligence actually forgot it. A channel that is gone locally with an orphaned thread still on the -platform is a smaller, more honest failure than a channel sitting in the roster with its history -silently wiped out from under it, and the audit trail is where an administrator finds the one that -did not clean up completely. `DELETE /api/channels/:channelId` answers with `historyLeftBehind`, so a -screen showing the outcome does not have to guess which of the two happened. +Both now carry the same defaults `start.sh` applies, as `COMPUTER_IMAGE` already did two lines down. +A value set in `.env` still wins, and a deployment should set one. ## 0.0.4 diff --git a/README.md b/README.md index 63b1b726..f71a6a5f 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,6 @@ Leave `EMBEDDED_POSTGRES` off and set `DATABASE_URL` to point at a database you | `/bot` | Direct chat with a Bot; `?agent=<id>` selects one. | | `/skills` | Create and enable personal skills. | | `/settings` | User preferences. | -| `/admin/connectors` | Configure deployment knowledge sources. | | `/admin/credentials` | Store write-only encrypted credentials. | | `/admin/computers` | View, stop, and reset Bot computers. | | `/admin/boundaries` | Configure browser/file/MCP action policy. | @@ -147,7 +146,7 @@ Leave `EMBEDDED_POSTGRES` off and set `DATABASE_URL` to point at a database you - **Secrets never enter the transcript**: the trail records that a secret was requested and how long it was, not what it said. - **Bring your own agent**: any AG-UI endpoint is a Bot, on a framework or hand-written. Endpoints are validated with the same target checks used for browser navigation, and an auth header is stored write-only. - **Components instead of prose**: compiled React components live in `app/src/components/gallery/`, sandboxed ones are authored in `/admin/playground` and published with no deployment. Every call asks the server whether the component exists, is published, and is not withheld from that Bot. Data functions are granted per component. -- **Governed MCP**: Google Drive ships in the catalogue, reached as the person asking. The catalogue carries only vendors this deployment stands behind, so adding one is a review of that vendor. Custom servers must pass URL checks, and any tool not positively classified as a read is treated as a write. A Bot is told which connectors exist here and which it holds, so it says it has not been granted one rather than browsing to the vendor's website. +- **Governed MCP**: Google Drive and Notion ship in the catalogue, reached as the person asking. The catalogue carries only vendors this deployment stands behind, so adding one is a review of that vendor. Custom servers must pass URL checks; unknown tools and custom-server tools are treated as writes, and a catalogue tool the server advertises but does not name as a write classifies as a read. A Bot is told which connectors exist here and which it holds, so it says it has not been granted one rather than browsing to the vendor's website. - **Skills are instructions, not capabilities**: personal skills attach only to Bots their author owns, deployment skills are admin-owned, and both are invoked with `/` in the composer. - **Sign in with what your company already has**: Google, Microsoft or Okta from the environment, or a company's own SAML or OpenID Connect provider registered while the deployment runs and routed by email domain. Any one turns sign-in on; several may be configured at once. - **Decide who gets in**: `/admin/people` lists everybody who has signed in, promotes and demotes them, and removes access, which ends the session they are using and stops the next sign-in. Every change is on the audit trail. diff --git a/agent-bot/src/history.ts b/agent-bot/src/history.ts index b4f09a68..1c7165bb 100644 --- a/agent-bot/src/history.ts +++ b/agent-bot/src/history.ts @@ -63,16 +63,7 @@ export function toProviderMessages( const toolCalls = message.toolCalls?.map((call) => ({ id: call.id, type: "function" as const, - function: { - /* - * A name is required by the provider and is not always present: read back from the thread - * store these arrive undefined, and a payload carrying `"name": undefined` is rejected - * outright. The call still has to be shown, or the model repeats an action it already - * took, so it keeps its id and is named as something the model can read. - */ - name: call.function?.name ?? "tool", - arguments: call.function?.arguments ?? "{}", - }, + function: callDetails(call), })); messages.push({ role: "assistant", @@ -109,3 +100,36 @@ export function toProviderMessages( return messages; } + +/** + * A tool call's name and arguments, in whichever dialect it arrived in. + * + * TWO SPELLINGS, ONE CALL. AG-UI describes `{id, type: "function", function: {name, arguments}}` and + * the history store writes `{id, name, args}`. Read back from a thread, every call arrives in the + * second, so code reaching straight for `call.function` finds nothing there. + * + * That was diagnosed here as "the name is not always present" and papered over with a default, which + * turned every restored call into a tool named `tool` with no arguments. The model is then shown a + * call it cannot recognise as the one it made, so it makes it again: the exact repetition the + * fallback was written to prevent. + */ +function callDetails(call: { + function?: { name?: unknown; arguments?: unknown }; + name?: unknown; + args?: unknown; +}): { name: string; arguments: string } { + const name = call.function?.name ?? call.name; + const args = call.function?.arguments ?? call.args; + return { + // Still defaulted, because a call with no name at all is rejected outright by the provider and + // showing the model something is better than losing the turn. It is now the last resort it was + // meant to be rather than the ordinary path. + name: typeof name === "string" && name ? name : "tool", + arguments: + typeof args === "string" + ? args + : args === undefined || args === null + ? "{}" + : JSON.stringify(args), + }; +} diff --git a/agent-bot/tests/history.test.ts b/agent-bot/tests/history.test.ts index 540d29d8..9aae3b0b 100644 --- a/agent-bot/tests/history.test.ts +++ b/agent-bot/tests/history.test.ts @@ -207,3 +207,47 @@ describe("a history that arrives out of order", () => { expect(assistant.tool_calls?.[0]?.function.name).toBe("tool"); }); }); + +/** + * A call read back from the thread store arrives in the store's dialect, not AG-UI's. + * + * `{id, name, args}` rather than `{id, type, function: {name, arguments}}`. Reaching straight for + * `call.function` finds nothing there, and the default underneath turned every restored call into a + * tool named `tool` with no arguments: the model is shown a call it cannot recognise as the one it + * made, so it makes it again. That is the repetition the default was written to prevent. + */ +describe("a tool call restored from the thread store", () => { + test("keeps the name and arguments it was made with", () => { + const messages = toProviderMessages({ + messages: [ + { + id: "m1", + role: "assistant", + content: null, + toolCalls: [ + { + id: "call_1", + name: "computer_navigate", + args: '{"url":"https://news.ycombinator.com"}', + }, + ], + }, + { + id: "m2", + role: "tool", + toolCallId: "call_1", + content: '{"ok":true}', + }, + ], + } as never); + + const withCalls = messages.find( + (message: Record<string, unknown>) => message.tool_calls, + ) as Record<string, unknown>; + const call = (withCalls.tool_calls as Array<Record<string, unknown>>)[0]; + const fn = call.function as Record<string, unknown>; + + expect(fn.name).toBe("computer_navigate"); + expect(fn.arguments).toBe('{"url":"https://news.ycombinator.com"}'); + }); +}); diff --git a/agent-computer/src/authorisation.ts b/agent-computer/src/authorisation.ts index 667f2d44..cbeabb10 100644 --- a/agent-computer/src/authorisation.ts +++ b/agent-computer/src/authorisation.ts @@ -47,3 +47,30 @@ export function offeredToken(headers: Headers, url: URL): string { export function isOpenPath(pathname: string): boolean { return pathname === "/health"; } + +/** + * Which paths act on the computer, and so are refused while a person holds the wheel. + * + * One list, asked once per request, rather than a check inside each handler. The shell is the reason: + * `/exec` arrived after the wheel existed and was never given the guard the page paths had, so a Bot + * could keep running commands and writing files underneath somebody who had taken the browser at a + * login wall. A per-handler check is exactly the thing the next endpoint forgets, which is how that + * happened; a list the dispatcher consults is one an endpoint has to be added to. + * + * Reading is not acting. `/files/read` and `/files/list` stay open so a Bot that has been stopped can + * still read its own notes and explain what it was doing, which is the answer the person handing the + * wheel back usually wants. + */ +const ACTING_PATHS = new Set([ + "/navigate", + "/click", + "/type", + "/key", + "/scroll", + "/exec", + "/files/write", +]); + +export function actsOnTheComputer(pathname: string): boolean { + return ACTING_PATHS.has(pathname); +} diff --git a/agent-computer/src/index.ts b/agent-computer/src/index.ts index b4762635..5d7177a6 100644 --- a/agent-computer/src/index.ts +++ b/agent-computer/src/index.ts @@ -1,7 +1,12 @@ import { serve } from "bun"; import type { Page } from "playwright"; import { parseAriaSnapshot, type SnapshotElement } from "./aria-snapshot"; -import { isOpenPath, matchesToken, offeredToken } from "./authorisation"; +import { + actsOnTheComputer, + isOpenPath, + matchesToken, + offeredToken, +} from "./authorisation"; import { isPlainBotId } from "./bot-id"; import { type Control, @@ -485,6 +490,26 @@ serve<StreamData>({ } const session = sessionFor(botId); + /* + * The wheel, asked once for everything that acts. + * + * Refused here rather than inside each handler because the handler that forgets is the whole + * defect: the shell shipped without this check and ran commands underneath a person who had taken + * the browser at a login wall. `actsOnTheComputer` is the list, and a new acting endpoint is + * refused by being added to it rather than by remembering to repeat this. + */ + if (actsOnTheComputer(url.pathname)) { + try { + session.control.assertBotMayAct(); + } catch (error) { + // A person holding the wheel is not a failure of the action; the Bot should wait and say so. + if (error instanceof ControlError) { + return json({ error: error.message, humanHasControl: true }, 409); + } + throw error; + } + } + if (url.pathname === "/stream") { /* * The socket carries the Bot in the query because it cannot do it in a header. Every other call here names @@ -696,7 +721,6 @@ serve<StreamData>({ const startedAt = Date.now(); try { - session.control.assertBotMayAct(); const target = await currentPage(botId); await target.goto(body.url, { waitUntil: "domcontentloaded", @@ -715,10 +739,6 @@ serve<StreamData>({ elapsedMs: Date.now() - startedAt, }); } catch (error) { - // A person holding the wheel is not a failed navigation; the Bot should wait. - if (error instanceof ControlError) { - return json({ error: error.message, humanHasControl: true }, 409); - } // The page is the Bot's working surface, so a failed navigation is reported rather than // thrown: the transcript needs to say what happened, and the browser stays usable. return json( @@ -893,7 +913,6 @@ serve<StreamData>({ const startedAt = Date.now(); try { - session.control.assertBotMayAct(); const target = await currentPage(botId); const detail = await performAction( session, @@ -932,10 +951,6 @@ serve<StreamData>({ if (error instanceof StaleSnapshotError) { return json({ error: error.message, stale: true }, 409); } - // 409 as well, and for the same reason: nothing is broken, the caller simply has to wait. - if (error instanceof ControlError) { - return json({ error: error.message, humanHasControl: true }, 409); - } return json({ error: describe(error, "The action failed.") }, 502); } } diff --git a/agent-computer/src/profile-listing.ts b/agent-computer/src/profile-listing.ts new file mode 100644 index 00000000..cd00047c --- /dev/null +++ b/agent-computer/src/profile-listing.ts @@ -0,0 +1,38 @@ +/** + * Which entries under the profiles root are Bots. + * + * ITS OWN MODULE SO ONE ANSWER SERVES BOTH SIDES. The rule lived inline in `profiles.ts`, and the + * test that covered it had a second copy: delete the production filter and the suite stayed green, + * because it was checking its own copy rather than the shipped one. A predicate worth testing is + * worth importing. + * + * Free of Playwright on purpose. `profiles.ts` launches browsers, so a test that wanted this rule had + * to drag a browser runtime in with it, which is most of why the copy existed in the first place. + */ +import { isPlainBotId } from "./bot-id"; + +/** The shape of a directory entry, as both `readdir` and a test can supply it. */ +export type ProfileEntry = { name: string; isDirectory: () => boolean }; + +/** + * The Bot ids among a directory listing, sorted and deduplicated. + * + * ONLY ENTRIES THIS CODE COULD HAVE MADE. The root is a mounted volume, and a volume is not an empty + * directory: a real disk formatted ext4 arrives with `lost+found` already in it, so on a cloud the + * fleet page listed a Bot by that name, offered to reset it, and nobody could say where it came from. + * Never seen locally, because a bind mount and kind's local-path volumes have no such directory, + * which is exactly the shape of bug that ships. + * + * `isPlainBotId` is the same allow-list that stops a hostile id becoming a path, used here for the + * other half of the question: an entry it would refuse to create is not one of ours to list. + */ +export function botIdsIn(entries: readonly ProfileEntry[]): string[] { + return [ + ...new Set( + entries + .filter((entry) => entry.isDirectory()) + .filter((entry) => isPlainBotId(entry.name)) + .map((entry) => entry.name), + ), + ].sort(); +} diff --git a/agent-computer/src/profiles.ts b/agent-computer/src/profiles.ts index 420931ee..28f6547f 100644 --- a/agent-computer/src/profiles.ts +++ b/agent-computer/src/profiles.ts @@ -40,6 +40,7 @@ import { profileDirectoryFor } from "./bot-id"; import { chooseEvictions, chooseIdle } from "./browser-eviction"; import { egressFor, egressLabel } from "./egress"; import { numberFromEnv } from "./env"; +import { botIdsIn } from "./profile-listing"; // Re-exported so callers that already import it from here do not change, while the test imports it // from the playwright-free `./env` instead of pulling this module's browser driver in with it. @@ -368,12 +369,11 @@ export function createProfiles(root: string) { const onDisk = await readdir(root, { withFileTypes: true }).catch( () => [], ); - return [ - ...new Set([ - ...onDisk.filter((e) => e.isDirectory()).map((e) => e.name), - ...live.keys(), - ]), - ].sort(); + /* + * The rule lives in its own module, so the test that covers it imports the same one this uses. + * It had a copy before, which meant deleting this filter left the suite green. + */ + return [...new Set([...botIdsIn(onDisk), ...live.keys()])].sort(); }, /** What the admin surface lists. Running or not, because a Bot that has a profile has a computer. */ diff --git a/agent-computer/tests/authorisation.test.ts b/agent-computer/tests/authorisation.test.ts index 9ec6521b..34fcfdc4 100644 --- a/agent-computer/tests/authorisation.test.ts +++ b/agent-computer/tests/authorisation.test.ts @@ -1,5 +1,10 @@ import { describe, expect, test } from "bun:test"; -import { isOpenPath, matchesToken, offeredToken } from "../src/authorisation"; +import { + actsOnTheComputer, + isOpenPath, + matchesToken, + offeredToken, +} from "../src/authorisation"; /** * The check that stands in front of a Bot's browser. @@ -88,3 +93,50 @@ describe("what an unauthenticated caller may reach", () => { } }); }); + +/** + * Which paths the wheel stops. + * + * A person takes the wheel at a login wall precisely because they no longer want the Bot acting, and + * `control.ts` states the property outright: "While a person holds control every acting call from the + * Bot is refused". That was true of the page from the start and untrue of the shell, which arrived + * later (#62) and was never wired to the wheel, so a Bot could run a command and rewrite the + * workspace underneath somebody mid-sign-in. + * + * The list lives here, beside the other path decision, rather than in `index.ts`, for the reason the + * header of this file gives: a decision next to `chromium.launch()` cannot be tested without Chrome. + * + * Reading is not acting. `/files/read` and `/files/list` stay open so a Bot waiting to be handed the + * wheel back can still say what it was doing. + */ +describe("what the wheel stops while a person is driving", () => { + test("every path that acts on the computer, the shell and a workspace write included", () => { + for (const path of [ + "/navigate", + "/click", + "/type", + "/key", + "/scroll", + "/exec", + "/files/write", + ]) { + expect(actsOnTheComputer(path)).toBeTrue(); + } + }); + + test("reading, looking and the handover itself are not acting", () => { + for (const path of [ + "/files/read", + "/files/list", + "/snapshot", + "/screenshot", + "/health", + "/control", + "/control/take", + "/control/release", + "/stream", + ]) { + expect(actsOnTheComputer(path)).toBeFalse(); + } + }); +}); diff --git a/agent-computer/tests/profile-listing.test.ts b/agent-computer/tests/profile-listing.test.ts new file mode 100644 index 00000000..e790a80c --- /dev/null +++ b/agent-computer/tests/profile-listing.test.ts @@ -0,0 +1,49 @@ +import { describe, expect, test } from "bun:test"; +import { mkdir, mkdtemp, readdir, writeFile } from "node:fs/promises"; +import { tmpdir } from "node:os"; +import { join } from "node:path"; +import { isPlainBotId } from "../src/bot-id"; +import { botIdsIn } from "../src/profile-listing"; + +/** + * Which directories under the profiles root are Bots. + * + * The root is a mounted volume, and a volume is not an empty directory. A real disk formatted ext4 + * arrives with `lost+found` already in it, so on a cloud the fleet page listed a Bot by that name and + * offered to reset it. Never seen locally, because a bind mount and kind's local-path volumes have no + * such directory: the bug appears only on the deployment shape the feature is for. + * + * The rule is the one that already exists. `isPlainBotId` decides what may become a profile path, so + * an entry it would refuse to create is not one of ours to list. + */ +async function knownIn(root: string): Promise<string[]> { + const onDisk = await readdir(root, { withFileTypes: true }).catch(() => []); + /* + * THE SHIPPED PREDICATE, imported rather than restated. + * + * This test used to carry its own copy of the filter, which meant it proved the copy rather than + * the product: deleting the real one left the suite green and the fleet page listing `lost+found` + * as a Bot again. + */ + return botIdsIn(onDisk); +} + +describe("listing the Bots that have a computer", () => { + test("lists Bot profiles and ignores what the filesystem put there", async () => { + const root = await mkdtemp(join(tmpdir(), "profiles-")); + await mkdir(join(root, "knowledge")); + await mkdir(join(root, "risk-analyst")); + // What an ext4 volume brings with it, which is the whole reason this test exists. + await mkdir(join(root, "lost+found")); + // A file is not a computer either. + await writeFile(join(root, "notes.txt"), ""); + + expect(await knownIn(root)).toEqual(["knowledge", "risk-analyst"]); + }); + + test("the name a real volume arrives with is not a usable Bot id", () => { + // Stated directly, because this is the property the filter leans on. + expect(isPlainBotId("lost+found")).toBe(false); + expect(isPlainBotId("knowledge")).toBe(true); + }); +}); diff --git a/agent-langgraph/src/history.ts b/agent-langgraph/src/history.ts index e95f376a..ce16acf4 100644 --- a/agent-langgraph/src/history.ts +++ b/agent-langgraph/src/history.ts @@ -73,11 +73,11 @@ export function toLangChainMessages(input: RunAgentInput): BaseMessage[] { tool_calls: message.toolCalls?.map((call) => ({ id: call.id, - name: call.function.name, + name: callDetails(call).name, // LangChain wants parsed arguments where AG-UI carries the raw string. A call whose // arguments did not parse is passed as empty rather than dropped: the model needs to // see that it made the call, or it makes it again. - args: parseArguments(call.function.arguments), + args: parseArguments(callDetails(call).arguments), })) ?? [], }), ); @@ -95,7 +95,7 @@ export function toLangChainMessages(input: RunAgentInput): BaseMessage[] { new ToolMessage({ tool_call_id: call.id, content: NO_ANSWER_CAME, - name: call.function.name, + name: callDetails(call).name, }), ); } @@ -116,3 +116,28 @@ function parseArguments(raw: string): Record<string, unknown> { return {}; } } + +/** + * A tool call's name and arguments, in whichever dialect it arrived in. + * + * TWO SPELLINGS, ONE CALL. AG-UI describes `{id, type: "function", function: {name, arguments}}` and + * the history store writes `{id, name, args}`. Read back from a thread, every call arrives in the + * second, so `call.function.name` here did not merely degrade: it threw, and took the run with it. + */ +function callDetails(call: { + function?: { name?: unknown; arguments?: unknown }; + name?: unknown; + args?: unknown; +}): { name: string; arguments: string } { + const name = call.function?.name ?? call.name; + const args = call.function?.arguments ?? call.args; + return { + name: typeof name === "string" && name ? name : "tool", + arguments: + typeof args === "string" + ? args + : args === undefined || args === null + ? "{}" + : JSON.stringify(args), + }; +} diff --git a/app/src/components/app-sidebar/app-sidebar.tsx b/app/src/components/app-sidebar/app-sidebar.tsx index b6e8d2dc..99946b00 100644 --- a/app/src/components/app-sidebar/app-sidebar.tsx +++ b/app/src/components/app-sidebar/app-sidebar.tsx @@ -13,7 +13,12 @@ import { useQuery, useQueryClient, } from "@tanstack/react-query"; -import { Link, type LinkOptions, useNavigate } from "@tanstack/react-router"; +import { + Link, + type LinkOptions, + useNavigate, + useParams, +} from "@tanstack/react-router"; import { AnimatePresence, motion, useReducedMotion } from "motion/react"; import type * as React from "react"; import { useState } from "react"; @@ -109,6 +114,44 @@ function matchingChannels( ); } +/** + * Pinned channels first, everything else after, newest activity first within each group. + * + * The mirror of a server rule, not the rule itself: the roster query orders pinned-first and its + * cursor carries the pin, so a pinned channel arrives on page one however long ago it was last + * spoken in. Sorting here as well is for what happens between refetches — the socket patches a pin + * onto a loaded row without moving it, and re-sorts a page by recency alone — which is the same + * reason `byRecency` in use-channel-events.ts mirrors the recency rule. A stable partition, so the + * recency order inside each group is whatever arrived. + */ +export function pinnedFirst(channels: ChannelSummary[]): ChannelSummary[] { + return [...channels].sort((a, b) => Number(b.pinned) - Number(a.pinned)); +} + +/** + * Whether a Bot has said something this member has not had on screen yet. + * + * A Bot's message, and only a Bot's: your own message carries a null agent id and reading your own + * words needs no marker. ISO-8601 strings compare correctly as strings, which is the same bet the + * server's recency sort already makes. + */ +export function hasUnseenActivity(channel: ChannelSummary): boolean { + if (channel.lastMessageAgentId === null || channel.lastMessageAt === null) { + return false; + } + return ( + channel.lastReadAt === null || channel.lastMessageAt > channel.lastReadAt + ); +} + +/** Unseen activity somewhere you are not looking. The open channel never shows the dot. */ +export function isUnread( + channel: ChannelSummary, + openChannelId: string | undefined, +): boolean { + return channel.id !== openChannelId && hasUnseenActivity(channel); +} + /** * A roster row that can animate. * @@ -124,6 +167,13 @@ function ChannelRow({ animateOrder: boolean; }) { const shouldReduceMotion = useReducedMotion(); + // Whether this row is unread, as a boolean, for the same reason `Channel` computes `isOpen` + // that way: navigating re-renders the rows whose answer changed, not the whole roster. + const unread = useParams({ + strict: false, + select: (params) => + isUnread(channel, (params as { channelId?: string }).channelId), + }); return ( <motion.div animate={{ opacity: 1, transform: "translateY(0px)" }} @@ -145,6 +195,8 @@ function ChannelRow({ ? relativeTime(channel.lastMessageAt) : undefined } + pinned={channel.pinned} + unread={unread} /> </motion.div> ); @@ -160,7 +212,7 @@ export function AppSidebar({ ...props }: React.ComponentProps<typeof Sidebar>) { useChannelEvents(); const [search, setSearch] = useState(""); const searching = search.trim().length > 0; - const visibleChannels = matchingChannels(channels.data, search); + const visibleChannels = pinnedFirst(matchingChannels(channels.data, search)); /* * FILTERING DOES NOT ANIMATE. Rows exit and relayout on every keystroke otherwise, which is a * list thrashing under somebody who is still typing — and the moving target is the very thing diff --git a/app/src/components/app-sidebar/channel.tsx b/app/src/components/app-sidebar/channel.tsx index 9b15b799..18733576 100644 --- a/app/src/components/app-sidebar/channel.tsx +++ b/app/src/components/app-sidebar/channel.tsx @@ -1,34 +1,39 @@ -import { IconDots } from "@tabler/icons-react"; +import { + IconPin, + IconPinFilled, + IconPinnedOff, + IconTrash, +} from "@tabler/icons-react"; import { useMutation, useQueryClient } from "@tanstack/react-query"; import { Link, useNavigate, useParams } from "@tanstack/react-router"; import { memo, useState } from "react"; -import { deleteChannelMutationOptions } from "@/lib/channels/mutations"; -import { ChannelAvatar } from "../channels/avatar"; +import { Button } from "@/components/ui/button"; +import { + ContextMenu, + ContextMenuContent, + ContextMenuItem, + ContextMenuTrigger, +} from "@/components/ui/context-menu"; import { - AlertDialog, - AlertDialogCancel, - AlertDialogContent, - AlertDialogDescription, - AlertDialogFooter, - AlertDialogHeader, - AlertDialogTitle, -} from "../ui/alert-dialog"; -import { Button } from "../ui/button"; + Dialog, + DialogContent, + DialogDescription, + DialogFooter, + DialogHeader, + DialogTitle, +} from "@/components/ui/dialog"; import { - DropdownMenu, - DropdownMenuContent, - DropdownMenuGroup, - DropdownMenuItem, - DropdownMenuTrigger, -} from "../ui/dropdown-menu"; + deleteChannelMutationOptions, + setChannelPinnedMutationOptions, +} from "@/lib/channels/mutations"; +import { ChannelAvatar } from "../channels/avatar"; /** * Memoized roster row. `use-channel-events` preserves unchanged row identity, and * `content-visibility` keeps off-screen rows cheap without virtualization. * - * State inside a row is no reason to drop the memo: `memo` compares the props it is handed and has - * nothing to say about a hook. Dropping it re-renders every row in the roster whenever the sidebar - * renders, which is the cost the identity-preserving patch in `use-channel-events` exists to avoid. + * Right-click opens Pin and Delete. Deleting is confirmed in a dialog that names the channel, + * because the row it was invoked on is one of several identical-looking rows. */ export const Channel = memo(function Channel({ channelId, @@ -36,139 +41,175 @@ export const Channel = memo(function Channel({ name, lastMessage, lastMessageAt, + pinned, + unread, }: { channelId: string; participantIds: string[]; name: string; lastMessage?: string; lastMessageAt?: string; + pinned: boolean; + unread: boolean; }) { const queryClient = useQueryClient(); const navigate = useNavigate(); - // `strict: false`: this row renders in the sidebar on every screen, not only while its own - // channel is open, so there may be no `channelId` route param to read at all. - const { channelId: openChannelId } = useParams({ strict: false }); - const [deleteDialogOpen, setDeleteDialogOpen] = useState(false); + // Whether this row's channel is the one on screen, as a boolean, so navigating between + // channels re-renders the two rows whose answer changed rather than the whole roster. + const isOpen = useParams({ + strict: false, + select: (params) => + (params as { channelId?: string }).channelId === channelId, + }); + const setPinned = useMutation(setChannelPinnedMutationOptions(queryClient)); const deleteChannel = useMutation(deleteChannelMutationOptions(queryClient)); + const [confirming, setConfirming] = useState(false); + /** + * Why a pin did not take, said on the row it was asked of. + * + * Pinning used to fail in total silence: the menu closed, the pin did not move, and nothing on + * screen accounted for it — which reads as the app ignoring the click. There is no toast in this + * app, and the row is where the person was looking, so the sentence goes here and is replaced by + * the next attempt. + */ + const [pinProblem, setPinProblem] = useState<string | null>(null); - const handleDelete = async () => { - // Navigate away first: the row this menu lives on unmounts the moment the list invalidates, - // and a screen still pointed at a channel id that no longer resolves is worse than a screen - // that moved on a beat early. - if (openChannelId === channelId) { + const confirmDelete = async () => { + /* + * Away first when this row's channel is the one on screen. + * + * The roster invalidates the moment the delete lands, so this row — and the dialog living inside + * it — unmounts while the rest of this function is still owed. Navigating after the mutation + * therefore ran in a component that was already gone, leaving somebody looking at a conversation + * that no longer exists. Leaving before asking is safe in the other direction: a refused delete + * puts them on the roster with the channel still in it, and says why in the dialog. + */ + if (isOpen) { await navigate({ to: "/" }); } try { await deleteChannel.mutateAsync(channelId); - /* - * Closed on success rather than left to the unmount. - * - * The row does go away when the roster invalidates, taking this dialog with it, but that is a - * side effect of a cache write and not something this component controls. - */ - setDeleteDialogOpen(false); } catch { - /* - * Left open, deliberately. A delete that failed leaves the row exactly where it was, so - * closing would return the person to a roster that still lists the conversation they just - * asked to be rid of, with nothing anywhere saying why. The message is rendered below; - * `mutateAsync` rejects rather than swallowing, which is why this catch exists at all. - */ + // The error is on the mutation and rendered in the dialog; leaving it open says "not done". + return; } + setConfirming(false); }; return ( - <div className="group/channel relative"> - <Link - to="/channel/$channelId" - params={{ channelId }} - type="button" - className="flex flex-row py-2 px-2 gap-2 items-center w-full hover:bg-foreground/5 rounded-lg [contain-intrinsic-size:auto_3.25rem] [content-visibility:auto]" - activeProps={{ - className: "bg-foreground/5", + <> + <ContextMenu> + <ContextMenuTrigger> + <Link + to="/channel/$channelId" + params={{ channelId }} + type="button" + className="flex flex-row py-2 px-2 gap-2 items-center w-full hover:bg-foreground/5 rounded-lg [contain-intrinsic-size:auto_3.25rem] [content-visibility:auto]" + activeProps={{ + className: "bg-foreground/5", + }} + > + <div className=""> + <ChannelAvatar participantIds={participantIds} size={32} /> + </div> + <div className="flex-col min-w-0 flex-1"> + <div className="flex flex-row items-center justify-between gap-2"> + <span + className={`text-[14px] tracking-[-1%] truncate ${ + unread ? "font-medium" : "" + }`} + > + {name} + </span> + <div className="text-[12px] text-muted-foreground/70"> + {lastMessageAt} + </div> + </div> + <div className="mt-px flex h-4 items-center gap-1.5"> + <span className="min-w-0 flex-1 truncate text-[12px] leading-4 text-muted-foreground"> + {lastMessage} + </span> + {unread ? ( + /* State about the message beats state about the row, so it sits first. */ + <span className="size-2 shrink-0 rounded-full bg-primary" /> + ) : null} + {pinned ? ( + <IconPinFilled className="size-3 shrink-0 text-muted-foreground/70" /> + ) : null} + </div> + </div> + </Link> + </ContextMenuTrigger> + <ContextMenuContent> + <ContextMenuItem + onClick={() => { + setPinProblem(null); + setPinned.mutate( + { channelId, pinned: !pinned }, + { onError: (thrown) => setPinProblem(thrown.message) }, + ); + }} + > + {pinned ? <IconPinnedOff /> : <IconPin />} + {pinned ? "Unpin channel" : "Pin channel"} + </ContextMenuItem> + <ContextMenuItem + variant="destructive" + onClick={() => { + // A refusal from a previous attempt is not news about this one. + deleteChannel.reset(); + setConfirming(true); + }} + > + <IconTrash /> + Delete channel… + </ContextMenuItem> + </ContextMenuContent> + </ContextMenu> + {pinProblem ? ( + <p className="px-2 pb-1 text-destructive text-xs" role="alert"> + {pinProblem} + </p> + ) : null} + <Dialog + onOpenChange={(open) => { + if (!open) setConfirming(false); }} + open={confirming} > - <div className=""> - <ChannelAvatar participantIds={participantIds} size={32} /> - </div> - <div className="flex-col min-w-0 flex-1"> - <div className="flex flex-row items-center justify-between gap-2"> - <span className="text-[14px] tracking-[-1%] truncate">{name}</span> - <div className="group-hover/channel:invisible text-[12px] text-muted-foreground/70"> - {lastMessageAt} - </div> - </div> - <div className="mt-px flex h-4 items-center gap-1.5"> - <span className="min-w-0 flex-1 truncate text-[12px] leading-4 text-muted-foreground"> - {lastMessage} - </span> - </div> - </div> - </Link> - <div className="absolute right-1 top-1/2 -translate-y-1/2 opacity-0 group-hover/channel:opacity-100 focus-within:opacity-100"> - <DropdownMenu> - <DropdownMenuTrigger - render={ - <Button - variant="ghost" - size="icon-sm" - aria-label={`Options for ${name}`} - > - <IconDots /> - </Button> - } - /> - <DropdownMenuContent align="end"> - <DropdownMenuGroup> - {/* Only opens the dialog below; the menu closes on click, too early to confirm anything. */} - <DropdownMenuItem - onClick={() => setDeleteDialogOpen(true)} - variant="destructive" - > - Delete - </DropdownMenuItem> - </DropdownMenuGroup> - </DropdownMenuContent> - </DropdownMenu> - </div> - <AlertDialog open={deleteDialogOpen} onOpenChange={setDeleteDialogOpen}> - <AlertDialogContent> - <AlertDialogHeader> - <AlertDialogTitle>Delete this conversation?</AlertDialogTitle> - <AlertDialogDescription> - This deletes your conversation with{" "} - <span className="font-medium text-foreground">{name}</span>, - including its message history. This cannot be undone. - </AlertDialogDescription> - </AlertDialogHeader> - {deleteChannel.isError ? ( - <p className="text-destructive text-sm" role="alert"> + <DialogContent> + <DialogHeader> + <DialogTitle>Delete {name}?</DialogTitle> + <DialogDescription> + The conversation will no longer appear for anyone in it. + </DialogDescription> + </DialogHeader> + {deleteChannel.error ? ( + <p className="text-destructive text-sm"> {deleteChannel.error.message} </p> ) : null} - <AlertDialogFooter> - <AlertDialogCancel disabled={deleteChannel.isPending}> + <DialogFooter> + <Button + onClick={() => setConfirming(false)} + size="sm" + variant="ghost" + > Cancel - </AlertDialogCancel> - {/* - * A plain button, not `AlertDialogAction`. - * - * That one renders the primitive's `Close`, so it shuts the dialog the instant it is - * pressed, before the request it starts has been answered. Nothing then reports a - * delete that failed: the dialog is gone, the conversation is still in the roster, and - * the person is left to work out for themselves that the thing they asked for did not - * happen. It also means "Deleting…" below could never appear. - */} + </Button> <Button disabled={deleteChannel.isPending} - onClick={() => void handleDelete()} + onClick={() => { + void confirmDelete(); + }} + size="sm" variant="destructive" > {deleteChannel.isPending ? "Deleting…" : "Delete"} </Button> - </AlertDialogFooter> - </AlertDialogContent> - </AlertDialog> - </div> + </DialogFooter> + </DialogContent> + </Dialog> + </> ); }); diff --git a/app/src/components/channels/chat-transcript.tsx b/app/src/components/channels/chat-transcript.tsx index 84edf602..f5044c1c 100644 --- a/app/src/components/channels/chat-transcript.tsx +++ b/app/src/components/channels/chat-transcript.tsx @@ -409,8 +409,17 @@ const TranscriptMessage = memo(function TranscriptMessage({ <MessageRow align={align}> <MessageContent> <Arriving delay={delay}> - <Bubble align={align} variant={isUser ? "muted" : "ghost"}> - <BubbleContent> + {/* + A Bot's message takes the whole column, not the width of its words: block content + inside it — a fenced code block, a table — should span the transcript rather than + shrink to its own text. A person's bubble keeps fitting what they said. + */} + <Bubble + align={align} + variant={isUser ? "muted" : "ghost"} + className={isUser ? undefined : "w-full"} + > + <BubbleContent className={isUser ? undefined : "w-full"}> {isUser ? ( // A person's own message is shown exactly as they typed it. Rendering it as markdown // would silently reformat what they said, and an asterisk in a sentence is not diff --git a/app/src/components/channels/composer/composer.tsx b/app/src/components/channels/composer/composer.tsx index 0c4781b2..dc8ef92b 100644 --- a/app/src/components/channels/composer/composer.tsx +++ b/app/src/components/channels/composer/composer.tsx @@ -70,6 +70,17 @@ export type ComposerProps = { * connecting and restoring its history, and the composer is on screen throughout. */ pending?: boolean; + /** + * Put the caret in the editor the first moment it can take one, and then leave it alone. For the + * screens where typing is the next thing a person does — choosing a coworker answers the "to" + * field, and the message is what remains. + * + * Once, not on every change: it used to re-claim the caret whenever the editor became interactive + * again, so a person who had clicked into something else — a search box, another channel's row — + * had the cursor yanked back the moment a turn finished. A send of their own still returns the + * caret, because that one they asked for. + */ + autoFocus?: boolean; /** * There is a run on the wire for Stop to reach. * @@ -95,6 +106,7 @@ export function Composer({ onStop, disabled = false, pending = false, + autoFocus = false, stoppable, }: ComposerProps) { const [value, setValue] = useState<Segment[]>([]); @@ -103,6 +115,8 @@ export function Composer({ const promptAreaRef = useRef<PromptAreaHandle>(null); /** A send has completed and the caret is owed back, as soon as the editor will take it. */ const wantsFocus = useRef(false); + /** `autoFocus` has been honoured once, and is not owed again for the life of this composer. */ + const claimedAutoFocus = useRef(false); const isBusy = pending || isSubmitting; const triggers = useMemo( @@ -191,14 +205,24 @@ export function Composer({ * Keyed off the editor becoming interactive rather than off the send resolving, so it survives * whatever the parent does with `pending` in between — and it runs after the commit, which is the * only point at which the element is enabled and focusable. + * + * Two different debts, and only one of them recurs. A finished send owes the caret back every + * time. `autoFocus` owes it exactly once, at the start: it used to be re-owed on every + * disabled/busy transition, so every completed turn stole the caret back from wherever the person + * had moved it, and a composer that had never been sent from would grab focus mid-conversation. */ useEffect(() => { - if (!wantsFocus.current || disabled || isBusy) { + if (disabled || isBusy) { + return; + } + const owed = wantsFocus.current || (autoFocus && !claimedAutoFocus.current); + if (!owed) { return; } wantsFocus.current = false; + claimedAutoFocus.current = true; promptAreaRef.current?.focus(); - }, [disabled, isBusy]); + }, [autoFocus, disabled, isBusy]); const handleFormSubmit = (event: FormEvent<HTMLFormElement>) => { event.preventDefault(); diff --git a/app/src/components/channels/conversation-view.tsx b/app/src/components/channels/conversation-view.tsx index 420e33ca..dd28b866 100644 --- a/app/src/components/channels/conversation-view.tsx +++ b/app/src/components/channels/conversation-view.tsx @@ -26,6 +26,7 @@ export function ConversationView({ commands, disabled = false, pending = false, + autoFocus = false, stopped, stoppable, queueWhileBusy = false, @@ -53,6 +54,8 @@ export function ConversationView({ * drains on this falling. */ pending?: boolean; + /** Focus the composer the moment it can take a caret; forwarded to the composer. */ + autoFocus?: boolean; /** Why the last turn ended without an answer. Drawn at the end of the transcript, not here. */ stopped?: string; /** @@ -224,6 +227,7 @@ export function ConversationView({ {notice} <Composer agents={agents} + autoFocus={autoFocus} {...(commands ? { commands } : {})} className="w-full mt-auto" compact diff --git a/app/src/components/computer/activity-log.tsx b/app/src/components/computer/activity-log.tsx index 33353c29..3a7a7719 100644 --- a/app/src/components/computer/activity-log.tsx +++ b/app/src/components/computer/activity-log.tsx @@ -12,6 +12,7 @@ */ import { IconFile, IconFolder, IconTerminal2 } from "@tabler/icons-react"; import { useSyncExternalStore } from "react"; +import { Empty, EmptyHeader, EmptyTitle } from "@/components/ui/empty"; import { activityFor, type ComputerActivity, @@ -102,10 +103,14 @@ export function ActivityLog({ computerId }: { computerId: string }) { if (entries.length === 0) { return ( - <p className="py-6 text-center text-muted-foreground text-sm"> - Nothing yet. Commands the Bot runs, and files it reads, appear here as - they happen. - </p> + <Empty className="h-[180px] border border-dashed"> + <EmptyHeader> + <EmptyTitle className="text-muted-foreground"> + Nothing yet. Commands the Bot runs, and files it reads, appear here + as they happen. + </EmptyTitle> + </EmptyHeader> + </Empty> ); } diff --git a/app/src/components/computer/computer-view.tsx b/app/src/components/computer/computer-view.tsx index 9ba91baa..532c85b1 100644 --- a/app/src/components/computer/computer-view.tsx +++ b/app/src/components/computer/computer-view.tsx @@ -7,9 +7,13 @@ import { supplySecret, takeControl, } from "@/lib/computers/control"; -import { readScreenshot, type Screenshot } from "@/lib/computers/screen"; +import { + readPageFrame, + readScreenshot, + type Screenshot, +} from "@/lib/computers/screen"; +import { ChannelAvatar } from "../channels/avatar"; import { LiveScreen } from "./live-screen"; -import { ComputerPlaceholder } from "./placeholder"; /** Explicit blank-browser URLs use placeholder artwork; missing URL fields are treated as real pages. */ function isBlankBrowser(shot: Screenshot): boolean { @@ -18,6 +22,53 @@ function isBlankBrowser(shot: Screenshot): boolean { return url === "" || url === "about:blank"; } +/** The part of a URL worth putting on screen; the whole thing is rarely readable at this size. */ +function hostOf(url: string): string { + try { + return new URL(url).host; + } catch { + return url; + } +} + +/** + * What each finished turn opened, and the frame it ended on, kept outside any component. + * + * MODULE SCOPE, BECAUSE THE TILE DOES NOT SURVIVE. A transcript re-renders freely and remounts the + * tiles in it, and anything held in component state goes with it: the fresh mount has no page yet, + * behaves for one render like a live turn, and reaches for the live screen. Keyed on the tool call, + * which is the identity of the turn rather than of the component drawing it. + * + * Bounded, because a long conversation is a lot of screenshots. Oldest out first, and a turn whose + * frame has been dropped falls back to naming its page. + */ +type RememberedTurn = { + page?: { url?: string; title?: string }; + frame?: { base64: string; url: string }; + /** Whether the server has already been asked, so a turn with no frame is not asked again. */ + asked?: boolean; +}; +const REMEMBERED_TURNS = new Map<string, RememberedTurn>(); +const MAX_REMEMBERED_TURNS = 40; + +function rememberTurn(toolCallId: string, patch: RememberedTurn): void { + const existing = REMEMBERED_TURNS.get(toolCallId) ?? {}; + /* + * A FRAME IS WRITTEN ONCE, which is what the server's own insert says and what this has to agree + * with. Letting a later write win is exactly what went wrong: the tile restored the right frame and + * then replaced it, one render later, with a screenshot of whatever the Bot had open by then. + */ + const merged: RememberedTurn = { ...existing, ...patch }; + if (existing.frame) merged.frame = existing.frame; + REMEMBERED_TURNS.delete(toolCallId); + REMEMBERED_TURNS.set(toolCallId, merged); + while (REMEMBERED_TURNS.size > MAX_REMEMBERED_TURNS) { + const oldest = REMEMBERED_TURNS.keys().next().value; + if (oldest === undefined) break; + REMEMBERED_TURNS.delete(oldest); + } +} + /** Default browser viewport ratio, reserved before the first screenshot arrives. */ const DEFAULT_ASPECT_RATIO = 1280 / 800; @@ -45,6 +96,80 @@ const SETTLE_TIMEOUT_MS = 30_000; /** Short confirmation window after a secret is sent to the page. */ const SECRET_CONFIRM_MS = 6_000; +/** + * What the frame says when there is no picture in it. + * + * Shared by the card and the full-size view because it is the same fact at either size, and because + * the full-size view is now reachable with nothing to draw: the wheel lives down there, so a person + * whose Bot is looking at a blank browser — or whose screen cannot be read at all — has to be able + * to open it and be told why it is empty, rather than find a disabled frame and no way in. + */ +function NothingToSee({ + problem, + blankBrowser, + settled, + page, +}: { + problem: string | null; + blankBrowser: boolean; + /** Whether this is a turn that has finished, rather than the browser as it is now. */ + settled?: boolean; + /** The page that turn opened, named when there is no picture of it. */ + page?: { url?: string; title?: string } | undefined; +}) { + return ( + <span className="absolute inset-0 flex flex-col items-center justify-center gap-1 p-4 text-center text-muted-foreground text-sm"> + {settled ? ( + <> + {/* + What this turn had open, named rather than drawn. + + The picture is gone: nothing stored it, and fetching one now would show a different page. + Naming the page is the honest version of the same sentence, and it stays true however + many times the Bot has browsed since. + + GATED ON THE TURN BEING OVER, not on whether a live frame happens to be in hand. A tile + that was live a moment ago keeps its last screenshot in state after it settles, and this + used to check for that: with one held and no frame stored, it fell through to "Waiting + for the assistant's screen…" and waited there for ever, because the poll that would have + ended the wait stops the moment a turn settles. + */} + {page?.url ? ( + <> + <span className="font-medium">{page.title || "A page"}</span> + <span className="break-all">{hostOf(page.url)}</span> + <span> + Opened during this turn. The screen has moved on since. + </span> + </> + ) : ( + /* + * A turn that ended without getting anywhere: refused by a boundary, stopped, or failed. + * Saying "opened during this turn" here would describe something that did not happen. + */ + <span>This turn did not open a page.</span> + )} + </> + ) : problem ? ( + <> + <span className="font-medium"> + You cannot see the screen right now + </span> + <span>{problem}</span> + <span> + The assistant may still be working. An administrator can check + whether its computer is running. + </span> + </> + ) : blankBrowser ? ( + <span>The assistant has not opened a page yet.</span> + ) : ( + <span>Waiting for the assistant's screen…</span> + )} + </span> + ); +} + type Props = { /** Which computer to watch. One shared computer unless each Bot has been given its own. */ computerId: string; @@ -55,6 +180,32 @@ type Props = { aspectRatio?: number; minWidth?: number; minHeight?: number; + /** Whose screen this is, drawn as a small badge over the frame. Absent, no badge is drawn. */ + name?: string; + /** + * The page this turn left the browser on, for a turn that has finished. + * + * A conversation is a record, and a record must not change its mind. Without this, reopening a + * conversation made every past turn fetch the screen as it is now, so an answer about Hacker News + * from an hour ago sat under a picture of whatever the Bot has open today. The frame was live, the + * caption was not, and the turn read as though it had browsed somewhere it never went. + */ + page?: { url?: string; title?: string }; + /** + * Whether the turn this tile belongs to has ended. + * + * SEPARATE FROM HAVING A PAGE. A navigation that was refused, failed or stopped ends without one, + * and a tile that decided history by "do I have a page" left exactly those turns polling the live + * screen for ever, under an answer that had nothing to do with what was on it. + */ + finished?: boolean; + /** + * The tool call this tile belongs to, which is what a kept frame is filed under. + * + * Without it the tile can still name the page; with it, it can show the page. Optional because the + * side panel is not a turn and has nothing to remember. + */ + toolCallId?: string; }; export function ComputerView({ @@ -64,6 +215,10 @@ export function ComputerView({ aspectRatio = DEFAULT_ASPECT_RATIO, minWidth = DEFAULT_MIN_WIDTH, minHeight = DEFAULT_MIN_HEIGHT, + name, + page, + finished, + toolCallId, }: Props) { const [shot, setShot] = useState<Screenshot | null>(null); const [problem, setProblem] = useState<string | null>(null); @@ -92,8 +247,76 @@ export function ComputerView({ /** Force a short watch window after non-Bot actions such as secret entry. */ const watchUntil = useRef(0); + /** + * A finished turn is history, and history is not polled. + * + * While a turn runs, the frames are that turn's own and freeze where it left them, which is right. + * Reopening the conversation later is the case this guards: the component mounts with no frame, + * and fetching one would put today's page under yesterday's answer. It shows the page that turn + * actually left open instead, which is the thing being remembered. + * + * `page` is what marks a turn as settled history rather than one still going, so a caller that + * knows nothing about the page keeps the old behaviour and nothing regresses. + * + * DELIBERATELY NOT "AND WE HAVE NO FRAME YET". That is what this said first, and it undid itself: + * restoring the kept frame set the frame, which made the turn stop counting as history, which + * restarted the polling this exists to prevent, which replaced the restored picture with the live + * one. The turn being over is the fact; whether a picture has arrived yet is not. + */ + if (toolCallId && page?.url) rememberTurn(toolCallId, { page }); + const knownPage = + page?.url !== undefined + ? page + : toolCallId + ? REMEMBERED_TURNS.get(toolCallId)?.page + : undefined; + const keptFrame = toolCallId + ? (REMEMBERED_TURNS.get(toolCallId)?.frame ?? null) + : null; + /** Bumped when a frame arrives, because the store it lands in is not React state. */ + const [, setFrameArrived] = useState(0); + + const settled = !active && (finished || Boolean(knownPage)); + + /* + * The frame this turn's page was showing, fetched once and then kept. + * + * A READ, AND ONLY A READ. The tile used to capture the frame itself once the turn went inactive, + * and it kept filing the wrong picture: a reopened turn and one that has just finished look + * identical from in here, the same computer is driven by other conversations between the two, and + * a resumed computer starts blank. The frame is now taken on the server the moment the navigation + * succeeds, which is the one moment the screen is certainly showing the page that was asked for, + * so there is nothing left here to race. + */ + useEffect(() => { + if (!toolCallId || !settled) return; + const remembered = REMEMBERED_TURNS.get(toolCallId); + /* + * Asked once per turn, answer or not. Without remembering the empty answer, every turn from + * before this shipped refetched nothing on every remount, which on a long transcript is one + * pointless request per turn per scroll. + */ + if (remembered?.frame || remembered?.asked) return; + let current = true; + + void (async () => { + const stored = await readPageFrame(computerId, toolCallId); + if (!current) return; + rememberTurn(toolCallId, { + asked: true, + ...(stored ? { frame: { base64: stored.frame, url: stored.url } } : {}), + }); + if (stored) setFrameArrived((n) => n + 1); + })(); + + return () => { + current = false; + }; + }, [computerId, toolCallId, settled]); + // biome-ignore lint/correctness/useExhaustiveDependencies: `secretPending` intentionally restarts settled polling. useEffect(() => { + if (settled) return; const mine = ++generation.current; let timer: ReturnType<typeof setTimeout>; // Consecutive identical frames observed during post-action settling. @@ -141,10 +364,11 @@ export function ComputerView({ generation.current++; clearTimeout(timer); }; - }, [computerId, active, intervalMs, secretPending]); + }, [computerId, active, intervalMs, secretPending, settled]); /** Poll control state independently from screenshot polling so help/secret prompts surface. */ useEffect(() => { + if (settled) return; let live = true; let timer: ReturnType<typeof setTimeout>; const tick = async () => { @@ -158,7 +382,7 @@ export function ComputerView({ live = false; clearTimeout(timer); }; - }, [computerId]); + }, [computerId, settled]); // Input forwarding lives in LiveScreen on the socket. // Escape is bound to the window so it works regardless of overlay focus. @@ -172,27 +396,54 @@ export function ComputerView({ }, [expanded]); // Always render the card frame; help/secret controls live below the conditional picture. - const blankBrowser = shot ? isBlankBrowser(shot) : false; + /* + * A finished turn is never "blank": it opened a page, and that is what it shows or names. Only a + * live browser can be sitting on about:blank. + */ + const blankBrowser = !settled && shot ? isBlankBrowser(shot) : false; /* * Sized from the ratio, never from the payload, so the frame is identical while a screen is - * loading and once it arrives. + * loading, once it arrives, and while the browser has nothing open. A blank browser used to + * collapse to a strip of text; that made the panel change shape the moment a page opened, and a + * surface whose whole job is showing a screen kept surprising the layout around it. + */ + const frameStyle = { aspectRatio, minWidth, minHeight }; + /** + * What this tile draws: the kept frame for a turn that is over, the live one while it runs. * - * A browser that has opened nothing is the exception. Reserving a screen-sized frame for it put a - * placeholder the height of a browser window into the middle of a conversation, above an answer - * that never involved the browser at all: a Bot asked about Google Drive rendered a full-size - * empty panel saying it had not opened a page. Nothing is loading there and nothing is coming, so - * there is no layout jump to protect against and no reason to take the room. + * A finished turn never draws `shot`. It may hold one, caught in the render between mounting and + * its result arriving, and that frame is of whatever the Bot has open now rather than of this turn. */ - const frameStyle = blankBrowser - ? { minWidth } - : { aspectRatio, minWidth, minHeight }; - /** Blank browser placeholders should not be opened as readable screens. */ - const showScreen = shot !== null && !blankBrowser; + const drawn = settled + ? keptFrame + : shot + ? { base64: shot.base64, url: shot.url ?? "" } + : null; + /** Whether there is a page to draw. A blank browser and an unreadable screen are both "no". */ + const showScreen = drawn !== null && !blankBrowser; + /** + * Whether the full-size view has a stream worth opening. + * + * Nothing to draw, and it says so in the same words the card does — but somebody holding the wheel + * gets the live socket whatever is on it, because once a person is driving the stream is the truth + * about the page and a placeholder over it would be the view arguing with them. + */ + const showLiveScreen = !settled && (showScreen || driving); + /** + * Whether the wheel in somebody's hands is the wheel THIS tile is showing. + * + * A person can take control mid-navigation, and the turn then settles under them. `driving` stays + * true, because it is true: they are driving the browser. It is just not the browser in this + * picture any more. Left ungated, the frozen tile asserted "You have control" over a page from an + * hour ago, with the hand-back footer already gone and the backdrop refusing to close because it + * believed somebody was driving it. + */ + const wheelHere = driving && !settled; const polledScreen = showScreen ? ( <img - src={`data:image/png;base64,${shot.base64}`} + src={`data:image/png;base64,${drawn.base64}`} alt="What the assistant is looking at" // Keep unexpected screenshot dimensions inside the reserved frame. className="absolute inset-0 h-full w-full object-contain opacity-100 transition-opacity duration-300 starting:opacity-0" @@ -206,48 +457,76 @@ export function ComputerView({ <button type="button" onClick={() => setExpanded(true)} - // Disabled while blank/waiting but still reserves the frame. - disabled={!showScreen} - className="relative block w-full bg-muted enabled:cursor-zoom-in" + /* + * Opens whether or not there is a picture in it. It used to be disabled without one, and + * the wheel is down there: a blank browser, a screen that had not arrived yet, or a + * computer that could not be reached left a person with no way to take control at all — + * the states where they most want it. With nothing to draw the full-size view shows these + * same words, and the wheel below them. + */ + className="relative block w-full cursor-pointer bg-muted" style={frameStyle} aria-label="Open the assistant's screen full size" > {polledScreen} - {blankBrowser ? ( - <ComputerPlaceholder className="absolute inset-0 h-full w-full" /> + {/* Whose computer this is — and whose hands are on it — said on the picture itself. */} + {name || wheelHere ? ( + <span className="absolute right-2 bottom-2 flex items-center gap-1.5"> + {name ? ( + <span className="flex items-center gap-1.5 rounded-full bg-black/60 py-1 pr-2.5 pl-1.5 font-medium text-white text-xs backdrop-blur-sm"> + <ChannelAvatar participantIds={[computerId]} size={16} /> + {name} + </span> + ) : null} + {wheelHere ? ( + <span className="rounded-full bg-white px-2.5 py-1 font-medium text-black text-xs shadow-sm"> + You have control + </span> + ) : null} + </span> ) : null} - {/* The blank state is a line of text, so it needs its own height rather than the frame's. */} - {blankBrowser ? <span className="block py-6" /> : null} {showScreen ? null : ( - <span - className={`absolute inset-0 flex flex-col items-center justify-center gap-1 p-4 text-center text-sm ${ - blankBrowser - ? "bg-black/25 text-white" - : "text-muted-foreground" - }`} - > - {problem ? ( - <> - <span className="font-medium"> - You cannot see the screen right now - </span> - <span>{problem}</span> - <span className={blankBrowser ? "text-white/80" : undefined}> - The assistant may still be working. An administrator can - check whether its computer is running. - </span> - </> - ) : blankBrowser ? ( - <span>The assistant has not opened a page yet.</span> - ) : ( - <span>Waiting for the assistant's screen…</span> - )} - </span> + <NothingToSee + blankBrowser={blankBrowser} + page={knownPage} + problem={problem} + settled={settled} + /> )} </button> + {/* + * The Bot ASKING for the wheel, which is not the same thing as a person wanting it. + * + * The standing "who is driving" prose and the everyday Take control button live in the + * full-size view, where there is a page big enough to drive. This row is the exception: a + * request is an exceptional state with a reason attached, it is the one moment the screen is + * waiting on a person rather than the other way round, and making them open the full-size + * view to find out what was wanted would hide the reason behind a click. Taking the wheel + * from here opens that view, because driving is what they are being asked to do. + */} + {!driving && !settled && control?.requested ? ( + <div className="flex items-start justify-between gap-3 border-t bg-amber-500/10 px-3 py-2 text-sm"> + <span> + <strong className="font-medium">The assistant needs you.</strong>{" "} + {control.reason} + </span> + <button + type="button" + onClick={async () => { + const state = await takeControl(computerId); + if (state) setControl(state); + setExpanded(true); + }} + className="shrink-0 rounded-md bg-primary px-3 py-1 font-medium text-primary-foreground text-xs" + > + Take control + </button> + </div> + ) : null} + {/* Secret values go directly to the page path and are never included in the conversation. Audit records that a secret was supplied, not the value. @@ -303,77 +582,12 @@ export function ComputerView({ </form> ) : null} - {driving ? ( - <div className="flex items-center justify-between gap-3 border-t bg-muted/40 px-3 py-2 text-sm"> - <span>You have control of this browser.</span> - <span className="flex shrink-0 gap-2"> - <button - type="button" - onClick={() => setExpanded(true)} - className="rounded-md border px-3 py-1 text-xs font-medium" - > - Open full size - </button> - <button - type="button" - onClick={() => void handBack()} - className="rounded-md bg-primary px-3 py-1 text-xs font-medium text-primary-foreground" - > - Hand back - </button> - </span> - </div> - ) : null} - {/* - * The wheel is offered whether or not the Bot asked for it. - * - * It only used to appear once the Bot called `computer_request_help`, which made the button - * depend on the Bot getting one instruction right. It does not always: asked to open a page - * behind a sign-in, a Bot answered "If you'd like, I can prompt you to take control … would - * you like to proceed with signing in?" and called nothing. The person was told to take - * control, and there was no control to take. The prompt already forbids that sentence in as - * many words, so the answer is not more prose: it is that a person who wants their own - * browser should not have to be offered it first. - * - * The amber row stays the Bot ASKING, which is a different thing and still worth its own - * colour and its reason. Without a request this is a quiet control that says who is driving. + * The inline card carries no persistent footer: taking the wheel, handing it back, and the + * standing "who is driving" prose all live in the full-size view, where there is a page big + * enough to drive. The two rows above appear only while the Bot is stuck — waiting on a + * credential, or asking for the wheel — and go again when it is not. */} - {!driving ? ( - <div - className={`flex items-start justify-between gap-3 border-t px-3 py-2 text-sm ${ - control?.requested ? "bg-amber-500/10" : "bg-muted/40" - }`} - > - <span> - {control?.requested ? ( - <> - <strong className="font-medium"> - The assistant needs you. - </strong>{" "} - {control.reason} - </> - ) : ( - "The assistant is driving. You can take over whenever you want." - )} - </span> - <button - type="button" - onClick={async () => { - const state = await takeControl(computerId); - if (state) setControl(state); - setExpanded(true); - }} - className={`shrink-0 rounded-md px-3 py-1 text-xs font-medium ${ - control?.requested - ? "bg-primary text-primary-foreground" - : "border" - }`} - > - Take control - </button> - </div> - ) : null} </figure> {/* @@ -385,68 +599,117 @@ export function ComputerView({ role="dialog" aria-modal="true" aria-label="The assistant's screen" - className="fixed inset-0 z-50 flex flex-col p-4 sm:p-8" + className="fixed inset-0 z-50 flex flex-col items-center justify-center p-4 sm:p-8" > - {/* Backdrop closes only while read-only; during driving, Escape remains the exit. */} + {/* + Backdrop closes only while read-only; during driving, Escape remains the exit. A + turn that is over is always read-only, whoever is holding the live browser. + */} <button type="button" - onClick={() => !driving && setExpanded(false)} + onClick={() => !wheelHere && setExpanded(false)} aria-label="Close the assistant's screen" - aria-hidden={driving} - tabIndex={driving ? -1 : 0} - className={`absolute inset-0 bg-black/80 ${driving ? "cursor-default" : "cursor-zoom-out"}`} + aria-hidden={wheelHere} + tabIndex={wheelHere ? -1 : 0} + className={`absolute inset-0 bg-black/80 ${wheelHere ? "cursor-default" : "cursor-zoom-out"}`} /> - <div className="relative mb-3 flex items-center justify-between gap-4 text-sm text-white"> - <span className="pointer-events-none"> - {driving ? ( - <> - <strong className="font-medium">You have control.</strong>{" "} - Click and type on the page as you normally would. - {control?.reason ? ` ${control.reason}` : null} - </> - ) : ( - <>The assistant's screen{active ? ", updating live" : ""}</> - )} - </span> - <span className="flex shrink-0 items-center gap-3"> - {driving ? ( - <button - type="button" - onClick={() => { - setExpanded(false); - void handBack(); - }} - className="rounded-md bg-white px-3 py-1 text-xs font-medium text-black" - > - Hand back to the assistant - </button> + {/* A card holding the screen, with who and the wheel centered beneath it. */} + <div className="relative flex w-full max-w-[70vw] min-w-0 flex-col rounded-2xl bg-background p-4 shadow-2xl"> + {/* + Overlay uses the live socket; the inline card keeps low-cost polling. With no page + to draw it reserves the same frame and says the same thing the card does — the + wheel below is the reason this view opens at all in that state. + */} + <div + className={`relative max-h-[75vh] min-h-0 overflow-auto rounded-xl ${showLiveScreen ? "bg-black" : "bg-muted"}`} + > + {settled && drawn ? ( + /* + * A record, opened larger. Not a window on the browser. + * + * Zooming a past turn used to mount the live stream and offer Take control, so + * the one gesture for looking closer at what a turn did was also the one that + * replaced it with whatever the Bot has open now. The kept frame exists to stop + * exactly that; its own zoom control was undoing it. + */ + <div className="relative w-full" style={{ aspectRatio }}> + <img + alt="What this turn had open" + className="absolute inset-0 h-full w-full object-contain" + src={`data:image/png;base64,${drawn.base64}`} + /> + </div> + ) : showLiveScreen ? ( + <LiveScreen + computerId={computerId} + driving={driving} + onProblem={setProblem} + /> ) : ( - /* Offered here too, and for the same reason: see the inline card above. */ - <button - type="button" - onClick={async () => { - const state = await takeControl(computerId); - if (state) setControl(state); - }} - className="rounded-md bg-white px-3 py-1 text-xs font-medium text-black" - > - Take control - </button> + <div className="relative w-full" style={{ aspectRatio }}> + <NothingToSee + blankBrowser={blankBrowser} + page={knownPage} + problem={problem} + settled={settled} + /> + </div> )} - <span className="pointer-events-none text-white/70"> - {driving - ? "Press Escape to close" - : "Click anywhere or press Escape to close"} - </span> - </span> - </div> - {/* Overlay uses the live socket; the inline card keeps low-cost polling. */} - <div className="relative min-h-0 flex-1 overflow-auto rounded-lg bg-black"> - <LiveScreen - computerId={computerId} - driving={driving} - onProblem={setProblem} - /> + </div> + {/* + NOT ON A TURN THAT IS OVER. Every past turn used to carry the wheel and the + standing "who is driving" prose under a picture of a page it opened an hour ago, + offering control of whatever the Bot has open now. Those sentences are about the + present and this view is a record; a record does not get a steering wheel. + */} + {settled ? null : ( + <div className="mt-4 flex items-center justify-center gap-4"> + <span className="flex min-w-0 items-center gap-2 text-sm"> + {name ? ( + <span className="flex shrink-0 items-center gap-1.5 font-medium"> + <ChannelAvatar + participantIds={[computerId]} + size={20} + /> + {name} + </span> + ) : null} + {driving ? ( + <span className="truncate text-muted-foreground"> + You have control — click and type on the page. + {control?.reason ? ` ${control.reason}` : null} + </span> + ) : control?.requested ? ( + <span className="truncate text-muted-foreground"> + <strong className="font-medium text-foreground"> + The assistant needs you. + </strong>{" "} + {control.reason} + </span> + ) : null} + </span> + {driving ? ( + <button + type="button" + onClick={() => void handBack()} + className="shrink-0 rounded-md bg-primary px-3 py-1.5 font-medium text-primary-foreground text-sm" + > + Hand back + </button> + ) : ( + <button + type="button" + onClick={async () => { + const state = await takeControl(computerId); + if (state) setControl(state); + }} + className="shrink-0 rounded-md border px-3 py-1.5 font-medium text-sm" + > + Take control + </button> + )} + </div> + )} </div> </div>, document.body, diff --git a/app/src/components/computer/placeholder.tsx b/app/src/components/computer/placeholder.tsx deleted file mode 100644 index 57dfab79..00000000 --- a/app/src/components/computer/placeholder.tsx +++ /dev/null @@ -1,162 +0,0 @@ -import type { SVGProps } from "react"; - -/** - * Decorative waiting artwork for the fixed-size computer frame. - */ -export function ComputerPlaceholder(props: SVGProps<SVGSVGElement>) { - return ( - <svg - viewBox="0 0 1200 800" - preserveAspectRatio="xMidYMin slice" - fill="none" - aria-hidden="true" - focusable="false" - xmlns="http://www.w3.org/2000/svg" - {...props} - > - <g clipPath="url(#clip0_2002_10)"> - <path fill="#fff" d="M0 0H1200V800H0z" /> - <path fill="url(#paint0_linear_2002_10)" d="M0 0H1200V754H0z" /> - <g - opacity={0.93} - filter="url(#filter0_n_2002_10)" - style={{ - mixBlendMode: "lighten", - }} - > - <path - transform="rotate(180 1201 754)" - fill="url(#paint1_radial_2002_10)" - d="M1201 754H2402V1509H1201z" - /> - </g> - <g - filter="url(#filter1_n_2002_10)" - style={{ - mixBlendMode: "color-burn", - }} - > - <path fill="#F0F0F0" fillOpacity={0.84} d="M0 0H1200V754H0z" /> - </g> - </g> - <defs> - <filter - id="filter0_n_2002_10" - x={0} - y={-1} - width={1201} - height={755} - filterUnits="userSpaceOnUse" - colorInterpolationFilters="sRGB" - > - <feFlood floodOpacity={0} result="BackgroundImageFix" /> - <feBlend in="SourceGraphic" in2="BackgroundImageFix" result="shape" /> - <feTurbulence - type="fractalNoise" - baseFrequency="0.76923078298568726 0.76923078298568726" - stitchTiles="stitch" - numOctaves={3} - result="noise" - seed={2673} - /> - <feComponentTransfer in="noise" result="coloredNoise1"> - <feFuncR type="linear" slope={2} intercept={-0.5} /> - <feFuncG type="linear" slope={2} intercept={-0.5} /> - <feFuncB type="linear" slope={2} intercept={-0.5} /> - <feFuncA - type="discrete" - tableValues="1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0" - /> - </feComponentTransfer> - <feComposite - operator="in" - in2="shape" - in="coloredNoise1" - result="noise1Clipped" - /> - <feComponentTransfer in="noise1Clipped" result="color1"> - <feFuncA type="table" tableValues="0 0.15" /> - </feComponentTransfer> - <feMerge result="effect1_noise_2002_10"> - <feMergeNode in="shape" /> - <feMergeNode in="color1" /> - </feMerge> - </filter> - <filter - id="filter1_n_2002_10" - x={0} - y={0} - width={1200} - height={754} - filterUnits="userSpaceOnUse" - colorInterpolationFilters="sRGB" - > - <feFlood floodOpacity={0} result="BackgroundImageFix" /> - <feBlend in="SourceGraphic" in2="BackgroundImageFix" result="shape" /> - <feTurbulence - type="fractalNoise" - baseFrequency="2 2" - stitchTiles="stitch" - numOctaves={3} - result="noise" - seed={7521} - /> - <feColorMatrix - in="noise" - type="luminanceToAlpha" - result="alphaNoise" - /> - <feComponentTransfer in="alphaNoise" result="coloredNoise1"> - <feFuncA - type="discrete" - tableValues="1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0" - /> - </feComponentTransfer> - <feComposite - operator="in" - in2="shape" - in="coloredNoise1" - result="noise1Clipped" - /> - <feFlood floodColor="rgba(0, 0, 0, 0.25)" result="color1Flood" /> - <feComposite - operator="in" - in2="noise1Clipped" - in="color1Flood" - result="color1" - /> - <feMerge result="effect1_noise_2002_10"> - <feMergeNode in="shape" /> - <feMergeNode in="color1" /> - </feMerge> - </filter> - <linearGradient - id="paint0_linear_2002_10" - x1={1200} - y1={-53.8571} - x2={-274.518} - y2={423.589} - gradientUnits="userSpaceOnUse" - > - <stop stopColor="#FFB8E7" /> - <stop offset={1} stopColor="#2EE297" /> - </linearGradient> - <radialGradient - id="paint1_radial_2002_10" - cx={0} - cy={0} - r={1} - gradientTransform="matrix(229.838 -1654.36 2337.29 481.415 2278.37 2408.36)" - gradientUnits="userSpaceOnUse" - > - <stop offset={0.420388} stopColor="#9DF200" /> - <stop offset={0.66} stopColor="#0099A9" /> - <stop offset={1} stopColor="#fff" /> - </radialGradient> - <clipPath id="clip0_2002_10"> - <path fill="#fff" d="M0 0H1200V800H0z" /> - </clipPath> - </defs> - </svg> - ); -} diff --git a/app/src/components/ui/alert-dialog.tsx b/app/src/components/ui/alert-dialog.tsx deleted file mode 100644 index b30e42a2..00000000 --- a/app/src/components/ui/alert-dialog.tsx +++ /dev/null @@ -1,150 +0,0 @@ -import { AlertDialog as AlertDialogPrimitive } from "@base-ui/react/alert-dialog"; -import type * as React from "react"; - -import { Button } from "@/components/ui/button"; -import { cn } from "@/lib/utils"; - -/** - * A modal for an action a click cannot undo. Built on `AlertDialogRoot` rather than `Dialog`'s - * `DialogRoot`: it carries `role="alertdialog"` and is announced immediately, and has no corner - * close button — the only way out is one of the footer's own buttons. - */ -function AlertDialog({ ...props }: AlertDialogPrimitive.Root.Props) { - return <AlertDialogPrimitive.Root data-slot="alert-dialog" {...props} />; -} - -function AlertDialogTrigger({ ...props }: AlertDialogPrimitive.Trigger.Props) { - return ( - <AlertDialogPrimitive.Trigger data-slot="alert-dialog-trigger" {...props} /> - ); -} - -function AlertDialogPortal({ ...props }: AlertDialogPrimitive.Portal.Props) { - return ( - <AlertDialogPrimitive.Portal data-slot="alert-dialog-portal" {...props} /> - ); -} - -function AlertDialogOverlay({ - className, - ...props -}: AlertDialogPrimitive.Backdrop.Props) { - return ( - <AlertDialogPrimitive.Backdrop - data-slot="alert-dialog-overlay" - className={cn( - "fixed inset-0 z-50 bg-black/10 transition-opacity duration-150 data-ending-style:opacity-0 data-starting-style:opacity-0 supports-backdrop-filter:backdrop-blur-xs", - className, - )} - {...props} - /> - ); -} - -function AlertDialogContent({ - className, - ...props -}: AlertDialogPrimitive.Popup.Props) { - return ( - <AlertDialogPortal> - <AlertDialogOverlay /> - <AlertDialogPrimitive.Popup - data-slot="alert-dialog-content" - className={cn( - "-translate-x-1/2 -translate-y-1/2 fixed top-1/2 left-1/2 z-50 flex w-[calc(100%-2rem)] max-w-md flex-col gap-4 rounded-xl border border-border bg-popover p-5 text-sm text-popover-foreground shadow-lg transition duration-150 ease-out data-ending-style:scale-[0.98] data-ending-style:opacity-0 data-starting-style:scale-[0.98] data-starting-style:opacity-0", - className, - )} - {...props} - /> - </AlertDialogPortal> - ); -} - -function AlertDialogHeader({ className, ...props }: React.ComponentProps<"div">) { - return ( - <div - data-slot="alert-dialog-header" - className={cn("flex flex-col gap-1", className)} - {...props} - /> - ); -} - -function AlertDialogFooter({ className, ...props }: React.ComponentProps<"div">) { - return ( - <div - data-slot="alert-dialog-footer" - className={cn("flex flex-row items-center justify-end gap-2", className)} - {...props} - /> - ); -} - -function AlertDialogTitle({ - className, - ...props -}: AlertDialogPrimitive.Title.Props) { - return ( - <AlertDialogPrimitive.Title - data-slot="alert-dialog-title" - className={cn("font-heading font-medium text-base text-foreground", className)} - {...props} - /> - ); -} - -function AlertDialogDescription({ - className, - ...props -}: AlertDialogPrimitive.Description.Props) { - return ( - <AlertDialogPrimitive.Description - data-slot="alert-dialog-description" - className={cn("text-muted-foreground text-sm text-pretty", className)} - {...props} - /> - ); -} - -/** The button that answers "no" or "not now." Closes without running anything else. */ -function AlertDialogCancel({ - className, - ...props -}: React.ComponentProps<typeof Button>) { - return ( - <AlertDialogPrimitive.Close - render={<Button variant="outline" className={className} {...props} />} - /> - ); -} - -/** - * The button that carries out the action, styled destructive by default since that is the only - * reason this component exists rather than the ordinary `Dialog`. Pass `onClick` to run the action; - * closing is automatic, the same as `AlertDialogCancel`. - */ -function AlertDialogAction({ - className, - variant = "destructive", - ...props -}: React.ComponentProps<typeof Button>) { - return ( - <AlertDialogPrimitive.Close - render={<Button variant={variant} className={className} {...props} />} - /> - ); -} - -export { - AlertDialog, - AlertDialogAction, - AlertDialogCancel, - AlertDialogContent, - AlertDialogDescription, - AlertDialogFooter, - AlertDialogHeader, - AlertDialogOverlay, - AlertDialogPortal, - AlertDialogTitle, - AlertDialogTrigger, -}; diff --git a/app/src/components/ui/checkbox.tsx b/app/src/components/ui/checkbox.tsx new file mode 100644 index 00000000..a863a705 --- /dev/null +++ b/app/src/components/ui/checkbox.tsx @@ -0,0 +1,26 @@ +import { Checkbox as CheckboxPrimitive } from "@base-ui/react/checkbox" +import { IconCheck } from "@tabler/icons-react" + +import { cn } from "@/lib/utils" + +function Checkbox({ className, ...props }: CheckboxPrimitive.Root.Props) { + return ( + <CheckboxPrimitive.Root + data-slot="checkbox" + className={cn( + "peer flex size-4 shrink-0 items-center justify-center rounded-[4px] border border-input shadow-xs outline-none transition-[background-color,border-color,box-shadow] duration-150 ease-out focus-visible:border-ring focus-visible:ring-3 focus-visible:ring-ring/50 aria-invalid:border-destructive aria-invalid:ring-3 aria-invalid:ring-destructive/20 data-checked:border-primary data-checked:bg-primary data-checked:text-primary-foreground data-disabled:cursor-not-allowed data-disabled:opacity-50", + className + )} + {...props} + > + <CheckboxPrimitive.Indicator + data-slot="checkbox-indicator" + className="flex items-center justify-center text-current" + > + <IconCheck className="size-3" /> + </CheckboxPrimitive.Indicator> + </CheckboxPrimitive.Root> + ) +} + +export { Checkbox } diff --git a/app/src/components/ui/context-menu.tsx b/app/src/components/ui/context-menu.tsx new file mode 100644 index 00000000..3b23d181 --- /dev/null +++ b/app/src/components/ui/context-menu.tsx @@ -0,0 +1,269 @@ +import * as React from "react" +import { ContextMenu as ContextMenuPrimitive } from "@base-ui/react/context-menu" + +import { cn } from "@/lib/utils" +import { IconChevronRight, IconCheck } from "@tabler/icons-react" + +function ContextMenu({ ...props }: ContextMenuPrimitive.Root.Props) { + return <ContextMenuPrimitive.Root data-slot="context-menu" {...props} /> +} + +function ContextMenuPortal({ ...props }: ContextMenuPrimitive.Portal.Props) { + return ( + <ContextMenuPrimitive.Portal data-slot="context-menu-portal" {...props} /> + ) +} + +function ContextMenuTrigger({ + className, + ...props +}: ContextMenuPrimitive.Trigger.Props) { + return ( + <ContextMenuPrimitive.Trigger + data-slot="context-menu-trigger" + className={cn("select-none", className)} + {...props} + /> + ) +} + +function ContextMenuContent({ + className, + align = "start", + alignOffset = 4, + side = "right", + sideOffset = 0, + ...props +}: ContextMenuPrimitive.Popup.Props & + Pick< + ContextMenuPrimitive.Positioner.Props, + "align" | "alignOffset" | "side" | "sideOffset" + >) { + return ( + <ContextMenuPrimitive.Portal> + <ContextMenuPrimitive.Positioner + className="isolate z-50 outline-none" + align={align} + alignOffset={alignOffset} + side={side} + sideOffset={sideOffset} + > + <ContextMenuPrimitive.Popup + data-slot="context-menu-content" + className={cn("z-50 max-h-(--available-height) min-w-36 origin-(--transform-origin) overflow-x-hidden overflow-y-auto rounded-lg bg-popover p-1 text-popover-foreground shadow-md ring-1 ring-foreground/10 duration-100 outline-none data-[side=bottom]:slide-in-from-top-2 data-[side=inline-end]:slide-in-from-left-2 data-[side=inline-start]:slide-in-from-right-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 data-open:animate-in data-open:fade-in-0 data-open:zoom-in-95 data-closed:animate-out data-closed:fade-out-0 data-closed:zoom-out-95", className )} + {...props} + /> + </ContextMenuPrimitive.Positioner> + </ContextMenuPrimitive.Portal> + ) +} + +function ContextMenuGroup({ ...props }: ContextMenuPrimitive.Group.Props) { + return ( + <ContextMenuPrimitive.Group data-slot="context-menu-group" {...props} /> + ) +} + +function ContextMenuLabel({ + className, + inset, + ...props +}: ContextMenuPrimitive.GroupLabel.Props & { + inset?: boolean +}) { + return ( + <ContextMenuPrimitive.GroupLabel + data-slot="context-menu-label" + data-inset={inset} + className={cn( + "px-1.5 py-1 text-xs font-medium text-muted-foreground data-inset:pl-7", + className + )} + {...props} + /> + ) +} + +function ContextMenuItem({ + className, + inset, + variant = "default", + ...props +}: ContextMenuPrimitive.Item.Props & { + inset?: boolean + variant?: "default" | "destructive" +}) { + return ( + <ContextMenuPrimitive.Item + data-slot="context-menu-item" + data-inset={inset} + data-variant={variant} + className={cn( + "group/context-menu-item relative flex cursor-default items-center gap-1.5 rounded-md px-1.5 py-1 text-sm outline-hidden select-none focus:bg-accent focus:text-accent-foreground data-inset:pl-7 data-[variant=destructive]:text-destructive data-[variant=destructive]:focus:bg-destructive/10 data-[variant=destructive]:focus:text-destructive dark:data-[variant=destructive]:focus:bg-destructive/20 data-disabled:pointer-events-none data-disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4 focus:*:[svg]:text-accent-foreground data-[variant=destructive]:*:[svg]:text-destructive", + className + )} + {...props} + /> + ) +} + +function ContextMenuSub({ ...props }: ContextMenuPrimitive.SubmenuRoot.Props) { + return ( + <ContextMenuPrimitive.SubmenuRoot data-slot="context-menu-sub" {...props} /> + ) +} + +function ContextMenuSubTrigger({ + className, + inset, + children, + ...props +}: ContextMenuPrimitive.SubmenuTrigger.Props & { + inset?: boolean +}) { + return ( + <ContextMenuPrimitive.SubmenuTrigger + data-slot="context-menu-sub-trigger" + data-inset={inset} + className={cn( + "flex cursor-default items-center gap-1.5 rounded-md px-1.5 py-1 text-sm outline-hidden select-none focus:bg-accent focus:text-accent-foreground data-inset:pl-7 data-open:bg-accent data-open:text-accent-foreground [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4", + className + )} + {...props} + > + {children} + <IconChevronRight className="ml-auto" /> + </ContextMenuPrimitive.SubmenuTrigger> + ) +} + +function ContextMenuSubContent({ + ...props +}: React.ComponentProps<typeof ContextMenuContent>) { + return ( + <ContextMenuContent + data-slot="context-menu-sub-content" + className="shadow-lg" + side="right" + {...props} + /> + ) +} + +function ContextMenuCheckboxItem({ + className, + children, + checked, + inset, + ...props +}: ContextMenuPrimitive.CheckboxItem.Props & { + inset?: boolean +}) { + return ( + <ContextMenuPrimitive.CheckboxItem + data-slot="context-menu-checkbox-item" + data-inset={inset} + className={cn( + "relative flex cursor-default items-center gap-1.5 rounded-md py-1 pr-8 pl-1.5 text-sm outline-hidden select-none focus:bg-accent focus:text-accent-foreground data-inset:pl-7 data-disabled:pointer-events-none data-disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4", + className + )} + checked={checked} + {...props} + > + <span className="pointer-events-none absolute right-2"> + <ContextMenuPrimitive.CheckboxItemIndicator> + <IconCheck + /> + </ContextMenuPrimitive.CheckboxItemIndicator> + </span> + {children} + </ContextMenuPrimitive.CheckboxItem> + ) +} + +function ContextMenuRadioGroup({ + ...props +}: ContextMenuPrimitive.RadioGroup.Props) { + return ( + <ContextMenuPrimitive.RadioGroup + data-slot="context-menu-radio-group" + {...props} + /> + ) +} + +function ContextMenuRadioItem({ + className, + children, + inset, + ...props +}: ContextMenuPrimitive.RadioItem.Props & { + inset?: boolean +}) { + return ( + <ContextMenuPrimitive.RadioItem + data-slot="context-menu-radio-item" + data-inset={inset} + className={cn( + "relative flex cursor-default items-center gap-1.5 rounded-md py-1 pr-8 pl-1.5 text-sm outline-hidden select-none focus:bg-accent focus:text-accent-foreground data-inset:pl-7 data-disabled:pointer-events-none data-disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4", + className + )} + {...props} + > + <span className="pointer-events-none absolute right-2"> + <ContextMenuPrimitive.RadioItemIndicator> + <IconCheck + /> + </ContextMenuPrimitive.RadioItemIndicator> + </span> + {children} + </ContextMenuPrimitive.RadioItem> + ) +} + +function ContextMenuSeparator({ + className, + ...props +}: ContextMenuPrimitive.Separator.Props) { + return ( + <ContextMenuPrimitive.Separator + data-slot="context-menu-separator" + className={cn("-mx-1 my-1 h-px bg-border", className)} + {...props} + /> + ) +} + +function ContextMenuShortcut({ + className, + ...props +}: React.ComponentProps<"span">) { + return ( + <span + data-slot="context-menu-shortcut" + className={cn( + "ml-auto text-xs tracking-widest text-muted-foreground group-focus/context-menu-item:text-accent-foreground", + className + )} + {...props} + /> + ) +} + +export { + ContextMenu, + ContextMenuTrigger, + ContextMenuContent, + ContextMenuItem, + ContextMenuCheckboxItem, + ContextMenuRadioItem, + ContextMenuLabel, + ContextMenuSeparator, + ContextMenuShortcut, + ContextMenuGroup, + ContextMenuPortal, + ContextMenuSub, + ContextMenuSubContent, + ContextMenuSubTrigger, + ContextMenuRadioGroup, +} diff --git a/app/src/lib/channels/mutations.ts b/app/src/lib/channels/mutations.ts index 1fb3f76c..2d10c4e4 100644 --- a/app/src/lib/channels/mutations.ts +++ b/app/src/lib/channels/mutations.ts @@ -1,6 +1,10 @@ -import { mutationOptions, type QueryClient } from "@tanstack/react-query"; +import { + mutationOptions, + type InfiniteData, + type QueryClient, +} from "@tanstack/react-query"; import { client, tryClient } from "@/lib/client"; -import { type AgentChannel, channelKeys } from "./queries"; +import { type AgentChannel, type ChannelPage, channelKeys } from "./queries"; /** * Start a new channel with one or more coworkers. @@ -22,35 +26,6 @@ export function createChannelMutationOptions(queryClient: QueryClient) { }); } -/** - * Delete a channel, and ask the platform to forget the thread behind it. - * - * Other tabs learn a channel is gone from the socket event in `use-channel-events.ts`; this tab - * issued the delete itself and never receives its own event, so it clears the roster and detail - * cache directly on success. - * - * Resolves to whether the message history outlived the channel. The local delete commits first and - * the thread deletion can fail on its own, so this is not a failure to throw on: the conversation - * is gone either way, and the caller shows the residue rather than reporting an error that did not - * happen. - */ -export function deleteChannelMutationOptions(queryClient: QueryClient) { - return mutationOptions({ - mutationFn: async (channelId: string): Promise<boolean> => { - const response = await client(`/api/channels/${channelId}`, { - method: "DELETE", - fallback: "Could not delete this conversation", - }); - const body = (await response.json()) as { historyLeftBehind?: boolean }; - return body.historyLeftBehind === true; - }, - onSuccess: (_data, channelId) => { - queryClient.invalidateQueries({ queryKey: channelKeys.all }); - queryClient.removeQueries({ queryKey: channelKeys.detail(channelId) }); - }, - }); -} - /** * Report the last thing said in a channel. * @@ -79,3 +54,83 @@ export function recordChannelActivityMutationOptions() { }, }); } + +/** Pin or unpin a channel for this member. A marker, not a reorder, so no optimistic sort. */ +export function setChannelPinnedMutationOptions(queryClient: QueryClient) { + return mutationOptions({ + mutationFn: async (variables: { channelId: string; pinned: boolean }) => { + await client(`/api/channels/${variables.channelId}/pin`, { + method: "PUT", + body: { pinned: variables.pinned }, + fallback: "Could not pin this channel", + }); + }, + onSuccess: () => + queryClient.invalidateQueries({ queryKey: channelKeys.all }), + }); +} + +/** + * Stamp a channel read for this member, patching the cache before the wire answers. + * + * Patched in onMutate rather than refetched on success: the dot must clear the instant the channel + * opens, not a round-trip later. No rollback on failure and no invalidation — a mark-read that did + * not land is a dot that returns on the next refetch, which is the truth reasserting itself, and a + * refetch here would race the socket's own patches for nothing. + */ +export function markChannelReadMutationOptions(queryClient: QueryClient) { + return mutationOptions({ + mutationFn: async (channelId: string) => { + await client(`/api/channels/${channelId}/read`, { + method: "PUT", + fallback: "Could not mark this channel read", + }); + }, + onMutate: (channelId) => { + const now = new Date().toISOString(); + queryClient.setQueryData( + channelKeys.list(), + (data: InfiniteData<ChannelPage> | undefined) => + data && { + ...data, + pages: data.pages.map((page) => ({ + ...page, + channels: page.channels.map((row) => + row.id === channelId + ? { + ...row, + /* + * The later of now and the row's own lastMessageAt: lastMessageAt comes from + * another clock, and a marker stamped "now" by a clock running behind it + * would leave the row still reading as unseen — and the dot still lit. + */ + lastReadAt: + row.lastMessageAt && row.lastMessageAt > now + ? row.lastMessageAt + : now, + } + : row, + ), + })), + }, + ); + }, + }); +} + +/** Soft-delete a channel for everyone in it. The server keeps the transcript; the roster forgets. */ +export function deleteChannelMutationOptions(queryClient: QueryClient) { + return mutationOptions({ + mutationFn: async (channelId: string) => { + await client(`/api/channels/${channelId}`, { + method: "DELETE", + fallback: "Could not delete this channel", + }); + }, + // The roster only. The open channel's detail query would refetch into the fresh 404 and + // flash an error before the navigate-home lands; left alone, it keeps its cache and the + // navigation happens with nothing to complain about. + onSuccess: () => + queryClient.invalidateQueries({ queryKey: channelKeys.list() }), + }); +} diff --git a/app/src/lib/channels/queries.ts b/app/src/lib/channels/queries.ts index 21ecbce7..6da66bf1 100644 --- a/app/src/lib/channels/queries.ts +++ b/app/src/lib/channels/queries.ts @@ -24,6 +24,10 @@ export type ChannelSummary = AgentChannel & { lastMessageAgentId: string | null; /** ISO-8601. Ordering falls back to this, so a channel just created sorts to the top. */ createdAt: string; + /** Whether this member pinned the channel. Pinned channels sort first in the roster. */ + pinned: boolean; + /** ISO-8601 when this member last had the channel open, or null for never. The caller's, only. */ + lastReadAt: string | null; }; export const channelKeys = { diff --git a/app/src/lib/channels/use-channel-events.ts b/app/src/lib/channels/use-channel-events.ts index 63459dd4..70ffab50 100644 --- a/app/src/lib/channels/use-channel-events.ts +++ b/app/src/lib/channels/use-channel-events.ts @@ -10,15 +10,98 @@ import { type ChannelPage, type ChannelSummary, channelKeys } from "./queries"; * list to recover events missed while disconnected. */ -type ChannelActivityEvent = { +export type ChannelActivityEvent = { channelId: string; lastMessage: string | null; lastMessageAt: string | null; lastMessageAgentId: string | null; - /** The channel is gone. Absent on an ordinary activity event. */ + /** The channel is gone from every member's roster. Absent on an ordinary activity event. */ deleted?: true; + /** + * This member's pin, changed. Absent on an ordinary activity event. + * + * The server scopes a pin to the member who made it, so one arriving here is the reader's own, + * made in another tab or on another replica. + */ + pinned?: boolean; }; +/** The infinite query's cache, which holds pages rather than one array. */ +type ChannelCache = { pages: ChannelPage[]; pageParams: unknown[] }; + +/** + * Apply one event to the cached pages. + * + * Pure, and exported, because the patching rules are the whole of what a socket event does to the + * screen and they should be provable without a socket. Returns the cache it was given when nothing + * changed, so React re-renders nothing, and `"unknown"` when the event names a channel no page + * holds — which the caller answers with a refetch rather than a patch. + */ +export function applyChannelEvent( + data: ChannelCache, + activity: ChannelActivityEvent, +): ChannelCache | "unknown" { + const holdingPage = data.pages.findIndex((page) => + page.channels.some((channel) => channel.id === activity.channelId), + ); + + // Must run before the patch below, which spreads the event onto the existing row — reaching that + // first would stamp `deleted: true` on the row instead of removing it. An unknown channel here is + // already gone from this cache, so there is nothing to patch or invalidate for, unlike the + // "unknown channel" case below for an ordinary event. + if (activity.deleted) { + if (holdingPage === -1) return data; + const page = data.pages[holdingPage] as ChannelPage; + const pages = data.pages.slice(); + pages[holdingPage] = { + ...page, + channels: page.channels.filter( + (channel) => channel.id !== activity.channelId, + ), + }; + return { ...data, pages }; + } + + // An unknown channel id means the roster is stale; refetch rather than patch. + if (holdingPage === -1) return "unknown"; + + const page = data.pages[holdingPage] as ChannelPage; + const index = page.channels.findIndex( + (channel) => channel.id === activity.channelId, + ); + const previous = page.channels[index]; + if (!previous) return data; + + /* + * A pin patches the one field it is about. + * + * The spread below would carry this event's null message onto the row and wipe the preview the + * roster renders. No re-sort either: a pin is not activity, and pinned rows are lifted at render + * time by `pinnedFirst`, not by the order they sit in here. + */ + if (activity.pinned !== undefined) { + if (previous.pinned === activity.pinned) return data; + const channels = page.channels.slice(); + channels[index] = { ...previous, pinned: activity.pinned }; + const pages = data.pages.slice(); + pages[holdingPage] = { ...page, channels }; + return { ...data, pages }; + } + + // Preserve object identity for unchanged rows so memoized rows do not re-render. + const next = page.channels.slice(); + next[index] = { ...previous, ...activity }; + next.sort(byRecency); + + // An event that changes nothing visible, a duplicate, or a report the server ignored as stale, + // returns the original object, so React re-renders nothing at all. + if (next.every((channel, at) => channel === page.channels[at])) return data; + + const pages = data.pages.slice(); + pages[holdingPage] = { ...page, channels: next }; + return { ...data, pages }; +} + const FIRST_RETRY_MS = 500; const MAX_RETRY_MS = 30_000; @@ -66,73 +149,25 @@ export function useChannelEvents() { */ queryClient.setQueryData( channelKeys.list(), - ( - data: { pages: ChannelPage[]; pageParams: unknown[] } | undefined, - ) => { + (data: ChannelCache | undefined) => { if (!data) return data; - - const holdingPage = data.pages.findIndex((page) => - page.channels.some( - (channel) => channel.id === activity.channelId, - ), - ); - - // Must run before the patch below, which spreads the event onto the existing row — - // reaching that first would stamp `deleted: true` on the row instead of removing it. - // An unknown channel here is already gone from this cache, so there is nothing to patch - // or invalidate for, unlike the "unknown channel" case below for an ordinary event. - if (activity.deleted) { - if (holdingPage === -1) return data; - const page = data.pages[holdingPage] as ChannelPage; - const pages = data.pages.slice(); - pages[holdingPage] = { - ...page, - channels: page.channels.filter( - (channel) => channel.id !== activity.channelId, - ), - }; - return { ...data, pages }; - } - + const patched = applyChannelEvent(data, activity); + if (patched !== "unknown") return patched; // An unknown channel id means the roster is stale; refetch rather than patch. - if (holdingPage === -1) { - void queryClient.invalidateQueries({ - queryKey: channelKeys.list(), - }); - return data; - } - - const page = data.pages[holdingPage] as ChannelPage; - const index = page.channels.findIndex( - (channel) => channel.id === activity.channelId, - ); - const previous = page.channels[index]; - if (!previous) return data; - - // Preserve object identity for unchanged rows so memoized rows do not re-render. - const next = page.channels.slice(); - next[index] = { ...previous, ...activity }; - next.sort(byRecency); - - // An event that changes nothing visible, a duplicate, or a report the server ignored as - // stale, returns the original object, so React re-renders nothing at all. - if (next.every((channel, at) => channel === page.channels[at])) { - return data; - } - - const pages = data.pages.slice(); - pages[holdingPage] = { ...page, channels: next }; - return { ...data, pages }; + void queryClient.invalidateQueries({ + queryKey: channelKeys.list(), + }); + return data; }, ); /* * A tab looking at the channel somebody just deleted in another tab. * - * The tab that issued the delete moves itself before it fires the request. Every other tab - * only ever hears about it here, and dropping the row without moving leaves that tab on a - * route whose channel no longer resolves: an error, or an empty conversation, depending on - * which query answers first. + * The tab that issued the delete moves itself once the request returns. Every other tab only + * ever hears about it here, and dropping the row without moving leaves that tab on a route + * whose channel no longer resolves: an error, or an empty conversation, depending on which + * query answers first. * * Read off the router at event time rather than through `useParams`, so the effect does not * have to be torn down and reconnected on every navigation just to keep this value fresh. diff --git a/app/src/lib/computers/activity.ts b/app/src/lib/computers/activity.ts index f6c29330..c9535034 100644 --- a/app/src/lib/computers/activity.ts +++ b/app/src/lib/computers/activity.ts @@ -70,16 +70,16 @@ export function activityFor(computerId: string): ComputerActivity[] { } /** - * Whether this Bot has opened a page since the surface was loaded. - * - * The screen is a property of the computer and outlives a conversation: several Bots share one, and - * the profile keeps whatever page was last open. So a Bot that spends a whole conversation in a - * terminal still has a screen, showing somebody else's order form from an hour ago, and defaulting - * the pane to it captions a stale page as what this Bot is doing right now. That is worse than - * showing nothing, because it is confidently wrong. + * Which Bots have opened a page since the surface was loaded. * * Recorded rather than inferred from the screenshot: a screenshot always succeeds, and "the browser - * has a page loaded" is a different fact from "this Bot opened one". + * has a page loaded" is a different fact from "this Bot opened one" — the screen belongs to the + * computer and outlives a conversation, so a Bot that has browsed nothing still has a page on it. + * + * Nothing reads this today. The screen and the activity log are now stacked rather than tabbed, so + * no view has to guess which of the two to open, and the caption that hedged about whose page it + * was is gone with it. The note stays because the tool handler is the only place the fact exists and + * losing it would mean re-deriving it from a screenshot, which cannot answer it. */ const browsed = new Set<string>(); @@ -89,10 +89,6 @@ export function noteBrowsed(computerId: string): void { for (const listener of listeners) listener(); } -export function hasBrowsed(computerId: string): boolean { - return browsed.has(computerId); -} - export function subscribeToActivity(listener: () => void): () => void { listeners.add(listener); return () => { diff --git a/app/src/lib/computers/screen.ts b/app/src/lib/computers/screen.ts index 874a5438..df3025e2 100644 --- a/app/src/lib/computers/screen.ts +++ b/app/src/lib/computers/screen.ts @@ -40,3 +40,31 @@ export async function readScreenshot( return { error: unavailable }; } } + +/** The frame a page was showing when a Bot opened it. */ +export type PageFrame = { url: string; title: string | null; frame: string }; + +/** + * What this turn had on screen when it opened its page, or nothing if it was never kept. + * + * Nothing here writes. The frame is taken on the server at the moment the navigation succeeds, which + * is the only moment the screen is certainly showing the page that was asked for. Capturing it here + * instead meant capturing it after the turn, from a computer other conversations are also driving, + * and filing whatever it happened to show. + */ +export async function readPageFrame( + computerId: string, + toolCallId: string, +): Promise<PageFrame | null> { + try { + const response = await tryClient( + `/api/computers/${computerId}/page-frame/${encodeURIComponent(toolCallId)}`, + ); + if (!response.ok) return null; + const body = (await response.json()) as { frame?: PageFrame | null }; + return body.frame ?? null; + } catch { + // A missing picture is a smaller sentence, not a broken conversation. + return null; + } +} diff --git a/app/src/lib/copilot/active-bot.tsx b/app/src/lib/copilot/active-bot.tsx index b66da3aa..dfb8dda2 100644 --- a/app/src/lib/copilot/active-bot.tsx +++ b/app/src/lib/copilot/active-bot.tsx @@ -73,3 +73,24 @@ export function useActiveBotHolder(): BotHolder { export function useActiveBotId(): string { return useContext(ActiveBotValueContext)?.botId ?? DEFAULT_BOT_ID; } + +/** + * The active Bot when a surface has declared one, and undefined while the placeholder holds. + * + * The placeholder exists so a handler always has something to route with, but it is not a Bot: no + * package registers an agent by that name, and the server answers 404 for it. A grant query handed + * the placeholder therefore polls a guaranteed miss on its own interval — every few seconds, on + * every screen without a conversation — and the constant failing request is noise that would bury a + * real 404 the day one matters. A query given undefined instead simply does not run. + * + * The name is already reserved in practice: an agents.yaml entry called "default" would be + * indistinguishable from the placeholder in every handler that reads the holder. + */ +export function declaredBotId(botId: string): string | undefined { + return botId === DEFAULT_BOT_ID ? undefined : botId; +} + +/** As useActiveBotId, for callers that should do nothing while the placeholder holds. */ +export function useDeclaredBotId(): string | undefined { + return declaredBotId(useActiveBotId()); +} diff --git a/app/src/lib/copilot/computer-tools.tsx b/app/src/lib/copilot/computer-tools.tsx index c4087b49..20d9f75d 100644 --- a/app/src/lib/copilot/computer-tools.tsx +++ b/app/src/lib/copilot/computer-tools.tsx @@ -126,6 +126,9 @@ type ComputerOutcome = { bytes?: number; /** A file read. Named `text` on the way back and `contents` on the way in. */ text?: string; + /** Where a navigation landed, which is what a finished turn's screen tile remembers. */ + url?: string; + title?: string; }; /** @@ -249,7 +252,10 @@ export function ComputerTools() { handler: async ( { url }: { url: string }, // Context is optional in the SDK. - { signal }: { signal?: AbortSignal } = {}, + { + signal, + toolCall, + }: { signal?: AbortSignal; toolCall?: { id?: string } } = {}, ) => { const computerId = bot.current; const result = await callComputer( @@ -257,7 +263,15 @@ export function ComputerTools() { "/navigate", { method: "POST", - body: { url }, + /* + * Which turn is asking, so the server can file the picture under it. + * + * The handler's context carries the tool call, which is worth saying because assuming it + * did not is how the frame ended up keyed on the page instead: two visits to one address + * then collided, and resolving that by letting the newer win made a past turn's picture + * change under the person reading it. + */ + body: { url, ...(toolCall?.id ? { toolCallId: toolCall.id } : {}) }, }, signal, ); @@ -279,11 +293,50 @@ export function ComputerTools() { } : result; }, - render: ({ status }) => ( - <div className="my-2"> - <ComputerView computerId={bot.current} active={status !== "complete"} /> - </div> - ), + render: ({ result, status, toolCallId }) => { + /* + * The page this turn left open, so reopening the conversation shows what it browsed rather + * than what the Bot has open now. Only once the turn is finished: while it runs, the live + * frames are its own. + */ + /* + * A RESULT IS WHAT MAKES A TURN OVER, not the status. + * + * A restored tool call arrives with its result already in hand and a status that is briefly + * something other than complete, so keying on the status alone made every reopened turn look + * like one still running: the tile polled the live screen, put today's page under yesterday's + * answer, and only then restored the frame it should have shown from the start. + */ + const finished = status === "complete" || result !== undefined; + const outcome = finished ? outcomeOf(result) : {}; + const page = + typeof outcome.url === "string" + ? { + url: outcome.url, + ...(typeof outcome.title === "string" + ? { title: outcome.title } + : {}), + } + : undefined; + return ( + <div className="my-2"> + <ComputerView + computerId={bot.current} + active={!finished} + /* + * FINISHED, NOT "GOT SOMEWHERE". The tile used to count a turn as history only once it + * had a page, so a navigation that was refused, failed or stopped never settled: it kept + * polling the live screen under a turn that was over, and offered control of it. Those + * are the turns most worth freezing, because the thing on screen has nothing to do with + * what the person is reading. + */ + finished={finished} + {...(page ? { page } : {})} + {...(toolCallId ? { toolCallId } : {})} + /> + </div> + ); + }, }); useFrontendTool({ diff --git a/app/src/lib/copilot/gallery-tools.tsx b/app/src/lib/copilot/gallery-tools.tsx index 26b39a2a..b421df73 100644 --- a/app/src/lib/copilot/gallery-tools.tsx +++ b/app/src/lib/copilot/gallery-tools.tsx @@ -9,7 +9,7 @@ import { decideComponent, type GrantedComponent, } from "@/lib/components/queries"; -import { useActiveBotId } from "@/lib/copilot/active-bot"; +import { useActiveBotId, useDeclaredBotId } from "@/lib/copilot/active-bot"; import { GALLERY_COMPONENTS, type GalleryComponent, @@ -32,7 +32,10 @@ export function GalleryTools() { // Active Bot comes from the route/channel surface currently driving the provider. const grantsFor = useActiveBotId(); - const { data: granted } = useQuery(agentComponentsQueryOptions(grantsFor)); + // See sandboxed-tools: the placeholder Bot is not fetchable, so the grant query waits for a + // surface to declare a real one. + const declared = useDeclaredBotId(); + const { data: granted } = useQuery(agentComponentsQueryOptions(declared)); const held = useMemo( () => new Map( diff --git a/app/src/lib/copilot/sandboxed-tools.tsx b/app/src/lib/copilot/sandboxed-tools.tsx index 5b570c01..f69aa43f 100644 --- a/app/src/lib/copilot/sandboxed-tools.tsx +++ b/app/src/lib/copilot/sandboxed-tools.tsx @@ -12,7 +12,7 @@ import { decideComponent, type GrantedComponent, } from "@/lib/components/queries"; -import { useActiveBotId } from "@/lib/copilot/active-bot"; +import { useActiveBotId, useDeclaredBotId } from "@/lib/copilot/active-bot"; import { type PublishedSandboxed, publishedSandboxedQueryOptions, @@ -24,8 +24,11 @@ import { */ export function SandboxedTools() { const botId = useActiveBotId(); + // Grants are fetched only once a surface has declared its Bot; the placeholder is not one the + // server knows, and asking would 404 on every poll. + const declared = useDeclaredBotId(); const { data: published } = useQuery(publishedSandboxedQueryOptions()); - const { data: granted } = useQuery(agentComponentsQueryOptions(botId)); + const { data: granted } = useQuery(agentComponentsQueryOptions(declared)); const held = new Map( (granted ?? []).map((component: GrantedComponent) => [ diff --git a/app/src/lib/copilot/thread-messages.ts b/app/src/lib/copilot/thread-messages.ts index 887ecec3..d6d35e97 100644 --- a/app/src/lib/copilot/thread-messages.ts +++ b/app/src/lib/copilot/thread-messages.ts @@ -11,14 +11,25 @@ import { tryClient } from "@/lib/client"; * * WHAT ARRIVES HERE IS NOT TRUSTED. This used to end `stored as Message[]`, which is a cast rather * than a check: whatever the history store held was handed to `setMessages` and then to every - * projection that reads a transcript. A turn shaped differently — a tool call persisted as - * `{id, name, args}` instead of AG-UI's `{id, type: "function", function: {…}}`, which interrupted - * runs have produced — reached a renderer that dereferenced `toolCall.function.arguments` and took - * the whole conversation down with it. One bad turn made a thread unreadable. + * projection that reads a transcript. A turn shaped differently reached a renderer that dereferenced + * `toolCall.function.arguments` and took the whole conversation down with it. One bad turn made a + * thread unreadable. * * So each turn is parsed against the schema AG-UI ships, and one that does not parse is left out. * Checked here rather than in a projection because there are several projections and one history: * fixing it in the reader that is closest to the wire is what makes every consumer safe at once. + * + * BUT `{id, name, args}` IS NOT A CORRUPTION, AND TREATING IT AS ONE DELETED REAL WORK. That shape + * was read as damage from an interrupted run and dropped. It is how the runtime persists every tool + * call it stores, so dropping it meant every turn in which a Bot used a tool vanished on reload: the + * transcript kept the sentence the Bot wrote and lost the browsing that produced it, the inline + * screen went with it, and the footer said some messages could not be read. Observed against a live + * thread, where every browsing turn was counted unreadable and every one of them was well formed in + * the store's own dialect. + * + * So it is translated rather than refused. The check stays for turns that really are malformed; a + * reader is entitled to insist on one shape, but not to throw away the history because the writer + * spells it another way. */ /** @@ -52,8 +63,11 @@ export function readableTurns(stored: readonly unknown[]): StoredThread { let unreadable = 0; for (const turn of stored) { - if (MessageSchema.safeParse(turn).success) { - messages.push(turn as Message); + const candidate = withNormalisedToolCalls( + withoutNullAssistantContent(turn), + ); + if (MessageSchema.safeParse(candidate).success) { + messages.push(candidate as Message); } else { unreadable += 1; } @@ -62,6 +76,89 @@ export function readableTurns(stored: readonly unknown[]): StoredThread { return { messages, unreadable }; } +/** + * An assistant turn whose content is `null`, read as one that simply has no content. + * + * The schema makes an assistant's content optional and does not allow it to be null, so the two say + * the same thing and only one parses. A turn that called a tool and said nothing alongside it is + * written exactly that way, so this dropped the browsing and kept nothing in its place: the same + * loss the tool-call dialect caused, arriving by a different route. + * + * ASSISTANT ONLY. A user turn's content is required, and `content: null` there is not a message + * somebody sent; it used to reach a projection and draw as a blank line, which is why it is refused + * and counted rather than quietly shown. That decision stands. + */ +function withoutNullAssistantContent(turn: unknown): unknown { + if (typeof turn !== "object" || turn === null) return turn; + const record = turn as Record<string, unknown>; + if (record.role !== "assistant" || record.content !== null) return turn; + const { content: _dropped, ...rest } = record; + return rest; +} + +/** A tool call as the history store writes one. */ +type StoredToolCall = { id?: unknown; name?: unknown; args?: unknown }; + +/** + * The store's dialect for a tool call, in the shape AG-UI describes. + * + * `{id, name, args}` becomes `{id, type: "function", function: {name, arguments}}`. Only the array is + * rebuilt and only when every entry is in that dialect: a turn already in AG-UI's shape is returned + * untouched, and a mixed or unrecognised array is left exactly as it came so the parse below still + * refuses it rather than this quietly inventing something. + * + * The rest of the message is spread through unchanged, for the same reason `parsed.data` is not used + * anywhere here: a reader that rewrites what it does not recognise is worse than one that refuses it. + */ +function withNormalisedToolCalls(turn: unknown): unknown { + if (typeof turn !== "object" || turn === null) return turn; + const calls = (turn as { toolCalls?: unknown }).toolCalls; + if (!Array.isArray(calls) || calls.length === 0) return turn; + + const isStoredDialect = (call: unknown): call is StoredToolCall => + typeof call === "object" && + call !== null && + "name" in call && + "args" in call && + !("function" in call); + if (!calls.every(isStoredDialect)) return turn; + + return { + ...(turn as Record<string, unknown>), + toolCalls: calls.map((call) => ({ + id: call.id, + type: "function", + function: { name: call.name, arguments: argumentsOf(call.args) }, + })), + }; +} + +/** + * The arguments, as a string, because that is what the protocol says they are. + * + * AG-UI types `arguments` as a string and the store is under no such obligation: it holds whatever + * the run put there, which for a tool called with structured input is an object. Passing that through + * produced a call that looked translated and still failed validation, so the turn was dropped anyway. + * That is this whole function's bug one layer down, which is a good reason to be explicit here rather + * than to trust the shapes to line up. + * + * A string is already right and is left exactly as it is, down to its whitespace: it may be a + * fragment of a stream that was never valid JSON, and re-encoding it would change what the model + * actually said. Anything else is encoded. `undefined` becomes `"{}"`, which is what a call with no + * arguments means and what every reader of this field expects to parse. + */ +function argumentsOf(args: unknown): string { + if (typeof args === "string") return args; + if (args === undefined || args === null) return "{}"; + try { + return JSON.stringify(args); + } catch { + // Circular, or something else that cannot be encoded. An empty object is a call the reader can + // parse; a throw here would lose the whole conversation over one malformed argument list. + return "{}"; + } +} + export async function readThreadMessages( threadId: string, agentId: string, diff --git a/app/src/lib/markdown.tsx b/app/src/lib/markdown.tsx index 1dae79d0..6ed4be50 100644 --- a/app/src/lib/markdown.tsx +++ b/app/src/lib/markdown.tsx @@ -22,9 +22,9 @@ import type { ComponentProps } from "react"; * a connector that answers from a live system. It also survives the model's phrasing: whether it * writes "I found it in X" or lists three files, each one is drawn the same way. * - * Recognition is by URL, and only Google's own document hosts. Anything else is an ordinary link, - * because a chip asserts "this is a file in a system you have connected" and that is not something - * to claim about a URL a model wrote. + * Recognition is by URL, and only document hosts this deployment knows about. Anything else is an + * ordinary link, because a chip asserts "this is a file in a system you have connected" and that + * is not something to claim about a URL a model wrote. */ const DRIVE_KINDS = [ { match: "/document/", icon: IconFileText, label: "Doc" }, @@ -32,14 +32,14 @@ const DRIVE_KINDS = [ { match: "/presentation/", icon: IconPresentation, label: "Slides" }, ] as const; -function driveKind(href: string | undefined) { +export function documentChipKind(href: string | undefined) { if (!href) return null; let url: URL; try { url = new URL(href); } catch { - // A relative or malformed href is not a Drive document, and is not worth throwing over. + // A relative or malformed href is not a recognised document, and is not worth throwing over. return null; } @@ -59,12 +59,19 @@ function driveKind(href: string | undefined) { if (url.hostname === "drive.google.com") { return { match: "", icon: IconFile, label: "Drive" }; } + /* + * Same exact-host rule as Drive: a chip asserts "this is a document in a system you have + * connected", and notion.so.evil.test is somebody else's domain wearing the name. + */ + if (url.hostname === "notion.so" || url.hostname === "www.notion.so") { + return { match: "", icon: IconFileText, label: "Notion" }; + } return null; } export const markdownComponents = { a: ({ href, children, ...rest }: ComponentProps<"a">) => { - const kind = driveKind(href); + const kind = documentChipKind(href); if (kind) { const Icon = kind.icon; diff --git a/app/src/lib/plugins/mutations.ts b/app/src/lib/plugins/mutations.ts index 7ead8df7..e8bee1ff 100644 --- a/app/src/lib/plugins/mutations.ts +++ b/app/src/lib/plugins/mutations.ts @@ -53,10 +53,40 @@ export type PluginKind = "mcp" | "skill"; const FALLBACK = "That did not work."; -function invalidatePlugins(queryClient: QueryClient) { +/** + * Refetch everything the plugin screens read. + * + * Exported because a bulk grant has to say when: N of these in a row, each awaiting its own + * refetch, is a dialog that spends most of a batch re-reading a list nobody has looked at yet. + */ +export function invalidatePlugins(queryClient: QueryClient) { return queryClient.invalidateQueries({ queryKey: pluginKeys.all }); } +/** + * Grant one plugin to one Bot, and refetch nothing. + * + * The write on its own, for the caller granting a batch of them: the server still records a row per + * grant, so the audit trail is unchanged, but the reader is refreshed once at the end rather than + * between every pair. Anything granting a single one should use the mutation below instead, which + * carries the refetch with it. + */ +export function grantPlugin(variables: { + kind: PluginKind; + ref: string; + agentId: string; +}): Promise<unknown> { + return client("/api/plugins/grants", { + method: "POST", + body: { + kind: variables.kind, + ref: variables.ref, + agentId: variables.agentId, + }, + fallback: "That Agent could not be changed.", + }); +} + /** * Whether one Bot carries one plugin. * @@ -72,15 +102,7 @@ export function setPluginGrantMutationOptions(queryClient: QueryClient) { granted: boolean; }) => { if (variables.granted) { - await client("/api/plugins/grants", { - method: "POST", - body: { - kind: variables.kind, - ref: variables.ref, - agentId: variables.agentId, - }, - fallback: "That Agent could not be changed.", - }); + await grantPlugin(variables); return; } await client( diff --git a/app/src/lib/plugins/queries.ts b/app/src/lib/plugins/queries.ts index 19dc6008..9530b33b 100644 --- a/app/src/lib/plugins/queries.ts +++ b/app/src/lib/plugins/queries.ts @@ -42,6 +42,11 @@ export type PluginServer = { toolsRefreshedAt: string | null; lastError: string | null; addedBy: string | null; + /** + * Whether this server registers its own OAuth client (RFC 7591) rather than waiting on an + * administrator to paste one in. + */ + dynamicClient: boolean; tools: PluginTool[]; /** Empty for a healthy connector. See {@link WithdrawnGrant}. */ withdrawn: WithdrawnGrant[]; diff --git a/app/src/routes/_authed/_app/bot.tsx b/app/src/routes/_authed/_app/bot.tsx index 620b2e96..b29f1322 100644 --- a/app/src/routes/_authed/_app/bot.tsx +++ b/app/src/routes/_authed/_app/bot.tsx @@ -1,7 +1,9 @@ import { CopilotChat } from "@copilotkit/react-core/v2"; import { IconPlus } from "@tabler/icons-react"; +import { useQuery } from "@tanstack/react-query"; import { createFileRoute } from "@tanstack/react-router"; import { Button } from "@/components/ui/button"; +import { agentListQueryOptions } from "@/lib/agents/queries"; import { useActiveBot } from "@/lib/copilot/active-bot"; import { useBotThread } from "@/lib/copilot/bot-thread"; import { useStoppedTurn } from "@/lib/copilot/stopped-turn"; @@ -13,10 +15,45 @@ export const Route = createFileRoute("/_authed/_app/bot")({ }), }); +/** + * Which Bot this screen is for. + * + * WHATEVER THIS DEPLOYMENT ACTUALLY HAS. The default used to be a hardcoded `risk-analyst`, a name + * from a tenant package this one is not: on a clone that ships anything else, opening this screen + * without naming a Bot took the whole page down to an unstyled error boundary, because the chat + * throws when asked for an agent the runtime never synced. OpenBot exists to be forked, so a Bot + * name written into a route is a defect on every fork but the one it came from. + * + * A named Bot that this deployment does not have is answered in a sentence rather than thrown, + * for the same reason: a mistyped link is not a crash. + */ function RouteComponent() { const { agent } = Route.useSearch(); - const agentId = agent ?? "risk-analyst"; + const { data: agents, isPending } = useQuery(agentListQueryOptions()); + const agentId = agent ?? agents?.[0]?.id; + const known = agents?.some((candidate) => candidate.id === agentId) ?? false; + if (isPending) return null; + if (!agentId || !known) { + return ( + <div className="flex h-screen items-center justify-center p-6"> + <p className="text-muted-foreground text-sm"> + {agent + ? `This deployment has no Bot called "${agent}".` + : "This deployment has no Bots yet."} + </p> + </div> + ); + } + + /* + * Keyed on the Bot, so the hooks below never see it change under them. They cannot be called + * conditionally, and the guards above return before any of them run. + */ + return <BotChat agentId={agentId} key={agentId} />; +} + +function BotChat({ agentId }: { agentId: string }) { // Tool calls here act on this Bot's own computer. useActiveBot(agentId); /* diff --git a/app/src/routes/_authed/_app/channel/$channelId.tsx b/app/src/routes/_authed/_app/channel/$channelId.tsx index 8040d2c4..1c282746 100644 --- a/app/src/routes/_authed/_app/channel/$channelId.tsx +++ b/app/src/routes/_authed/_app/channel/$channelId.tsx @@ -1,10 +1,16 @@ import { IconDeviceDesktop, IconSettings } from "@tabler/icons-react"; -import { useQuery } from "@tanstack/react-query"; +import { + useInfiniteQuery, + useMutation, + useQuery, + useQueryClient, +} from "@tanstack/react-query"; import { createFileRoute } from "@tanstack/react-router"; import { motion, useReducedMotion } from "motion/react"; -import { useEffect, useRef, useState, useSyncExternalStore } from "react"; +import { useEffect, useRef } from "react"; import { z } from "zod"; import { AgentProfile } from "@/components/agents/agent-profile"; +import { hasUnseenActivity } from "@/components/app-sidebar/app-sidebar"; import { ChannelAvatar } from "@/components/channels/avatar"; import { ChannelChat } from "@/components/channels/channel-chat"; import { ActivityLog } from "@/components/computer/activity-log"; @@ -12,12 +18,12 @@ import { ComputerView } from "@/components/computer/computer-view"; import { useNeedsYou } from "@/components/computer/needs-you"; import { DetailPanel } from "@/components/layout/detail-panel"; import { Button } from "@/components/ui/button"; -import { type AgentChannel, channelQueryOptions } from "@/lib/channels/queries"; +import { markChannelReadMutationOptions } from "@/lib/channels/mutations"; import { - activityFor, - hasBrowsed, - subscribeToActivity, -} from "@/lib/computers/activity"; + type AgentChannel, + channelListQueryOptions, + channelQueryOptions, +} from "@/lib/channels/queries"; import { onComputerActivity } from "@/lib/copilot/computer-activity"; const chatSearchSchema = z.object({ @@ -42,13 +48,11 @@ export const Route = createFileRoute("/_authed/_app/channel/$channelId")({ /** * What the Bot is looking at, and what it is doing. * - * Two surfaces rather than one. The screen was the only window into a Bot's computer, so a Bot that - * spent two minutes in a terminal showed a blank browser and nothing else: the honest answer to - * "what is it doing" was "something, on a machine holding your logins". The second tab is the shell - * and the workspace, and it fills up while the screen sits still. - * - * The screen stays the default, because most work is browsing and it is the surface somebody has to - * take the wheel on. The count on the other tab is what says the Bot is busy somewhere else. + * Two surfaces, stacked rather than tabbed. The screen was the only window into a Bot's computer, + * so a Bot that spent two minutes in a terminal showed a blank browser and nothing else: the honest + * answer to "what is it doing" was "something, on a machine holding your logins". The activity — + * the shell and the workspace — sits below the screen, so watching one never costs the other and + * nothing about what the Bot is doing hides behind a tab nobody clicked. */ function ComputerViewPanel({ agentId, @@ -57,77 +61,13 @@ function ComputerViewPanel({ agentId: string; name?: string; }) { - const activity = useSyncExternalStore( - subscribeToActivity, - () => activityFor(agentId), - () => activityFor(agentId), - ); - const browsed = useSyncExternalStore( - subscribeToActivity, - () => hasBrowsed(agentId), - () => hasBrowsed(agentId), - ); - - /* - * Which surface opens, decided by what the Bot is actually doing. - * - * The screen belongs to the computer rather than to the conversation: Bots share one and the - * profile keeps whatever page was open last. A Bot that spends a whole conversation in a terminal - * therefore has a screen showing somebody else's page from an hour ago, and defaulting to it - * captions that as what this Bot is doing now. - * - * So the screen is the default until there is a reason to think otherwise, and work away from the - * browser with no page opened is that reason. Once somebody picks a tab, their choice stands. - */ - const [chosen, setChosen] = useState<"screen" | "activity" | null>(null); - const showing = - chosen ?? (!browsed && activity.length > 0 ? "activity" : "screen"); - return ( <div className="mt-4 px-4"> <div className="p-4"> - <div className="mb-3 flex gap-2"> - <Button - onClick={() => setChosen("screen")} - size="sm" - variant={showing === "screen" ? "default" : "outline"} - > - Screen - </Button> - <Button - onClick={() => setChosen("activity")} - size="sm" - variant={showing === "activity" ? "default" : "outline"} - > - Activity - {activity.length > 0 ? ( - <span className="ml-1.5 tabular-nums opacity-70"> - {activity.length} - </span> - ) : null} - </Button> - </div> + <ComputerView active computerId={agentId} name={name} /> - {/* - Both mounted, one hidden. Unmounting the screen would drop its socket and its polling, so - looking at the terminal for a moment would cost the live view and the take-the-wheel prompt - that rides on it. - */} - <div className={showing === "screen" ? undefined : "hidden"}> - <ComputerView active computerId={agentId} /> - {/* - The caption says whose page this is, and it is only this Bot's once it has opened one. - Before that the browser still shows whatever was last open on the shared computer, and - calling that "General Assistant's screen" states something untrue with confidence. - */} - <span className="mt-4 flex w-full items-center justify-center text-balance px-4 text-center text-muted-foreground text-sm"> - {browsed - ? `${name || "Agent"}'s screen` - : `${name || "Agent"} has not opened a page in this conversation. This is whatever its computer had open last.`} - </span> - </div> - - <div className={showing === "activity" ? undefined : "hidden"}> + <div className="mt-10"> + <h3 className="mb-2 font-medium text-sm">Activity</h3> <ActivityLog computerId={agentId} /> </div> </div> @@ -145,10 +85,43 @@ function RouteComponent() { const isWatching = watch === true; /** Channel routing currently supports one coworker. */ const agentId = channel.data?.agentIds[0]; - /** Needs-you state is rendered by the screen when the screen is already open. */ + /** Only polled while the screen is closed; the screen panel polls control itself. */ const needsYou = useNeedsYou(agentId, !isWatching); - // Needs-you prompts auto-open the screen because the actionable prompt is rendered there. + const queryClient = useQueryClient(); + const markRead = useMutation(markChannelReadMutationOptions(queryClient)); + /* + * This channel's roster summary, read out of the same infinite query the sidebar renders. + * The detail query deliberately knows nothing about activity; the roster is where the socket + * keeps lastMessageAt live, so it is the one honest source for "has something new been said". + */ + const roster = useInfiniteQuery(channelListQueryOptions()); + const summary = roster.data?.find((row) => row.id === channelId); + + /* + * Opening the channel marks it read; the Bot replying while it is open marks it read again. + * One effect covers both: the dep changes on navigation and on every activity patch, and the + * unseen check keeps it from writing a row per render. No dependency on the mutation object — + * its identity changes per render and the effect must not re-fire for that. + * + * Keyed on primitives, deliberately. The optimistic mark-read patch changes the summary OBJECT's + * identity without changing these values, so an object dep would re-fire the effect on its own + * write — and when lastMessageAt sits ahead of this browser's clock (another device wrote it), + * that re-fire loops into a PUT per render. Primitives hold still under the patch: one PUT. + */ + const unseen = summary !== undefined && hasUnseenActivity(summary); + const markReadMutate = markRead.mutate; + useEffect(() => { + if (unseen) { + markReadMutate(channelId); + } + }, [channelId, unseen, markReadMutate]); + + /* + * Needs-you prompts auto-open the screen panel, because the prompt with the reason on it — the + * amber "the assistant needs you" row, and the masked field for a credential — is drawn on the + * screen card in that panel. Nothing about a stuck Bot is actionable until this pane is open. + */ useEffect(() => { if (!needsYou) return; show("watch"); diff --git a/app/src/routes/_authed/_app/channel/new.tsx b/app/src/routes/_authed/_app/channel/new.tsx index 520b5f89..100f7b3e 100644 --- a/app/src/routes/_authed/_app/channel/new.tsx +++ b/app/src/routes/_authed/_app/channel/new.tsx @@ -107,6 +107,9 @@ function RouteComponent() { </Combobox> </div> <ConversationView + // Choosing a coworker answers the "To:" field, so the message is what remains: the caret + // lands in the composer the moment a recipient exists, whether picked here or in the URL. + autoFocus // Commands must be loaded before the first channel message is sent. commands={skillCommands} disabled={recipients.length === 0} diff --git a/app/src/routes/_authed/admin/plugins/$key.tsx b/app/src/routes/_authed/admin/plugins/$key.tsx index 2e824918..6c6f96d4 100644 --- a/app/src/routes/_authed/admin/plugins/$key.tsx +++ b/app/src/routes/_authed/admin/plugins/$key.tsx @@ -14,6 +14,7 @@ import { PageShell, } from "@/components/layout/page-shell"; import { Button } from "@/components/ui/button"; +import { Checkbox } from "@/components/ui/checkbox"; import { Dialog, DialogBody, @@ -40,6 +41,8 @@ import { storeMcpToken } from "@/lib/credentials/mutations"; import { addCuratedServerMutationOptions, connectAccountMutationOptions, + grantPlugin, + invalidatePlugins, refreshPluginServerMutationOptions, registerOAuthClientMutationOptions, removePluginServerMutationOptions, @@ -61,8 +64,18 @@ export const Route = createFileRoute("/_authed/admin/plugins/$key")({ component: RouteComponent, }); -/** Which of the three shapes of edit a row opens, or none. */ -type OpenDialog = "token" | "client" | "instance" | null; +/** Which of the four dialogs is open, or none. */ +type OpenDialog = "token" | "client" | "instance" | "grant" | null; + +/** The set with one member toggled, as a new set so React sees the change. */ +function toggled( + set: ReadonlySet<string>, + member: string, +): ReadonlySet<string> { + const next = new Set(set); + if (!next.delete(member)) next.add(member); + return next; +} /** * How widely a tool is granted, in words rather than a fraction. @@ -101,6 +114,24 @@ function RouteComponent() { const [token, setToken] = useState(""); const [instanceHost, setInstanceHost] = useState(""); const [client, setClient] = useState({ clientId: "", clientSecret: "" }); + /** Who gets the tools, and which, while the grant dialog is open. */ + const [selectedBots, setSelectedBots] = useState<ReadonlySet<string>>( + new Set(), + ); + const [selectedRefs, setSelectedRefs] = useState<ReadonlySet<string>>( + new Set(), + ); + /** + * How far through a batch of grants we are, or null when none is running. + * + * A count rather than a boolean because a bulk grant is honestly N writes: a Bot times twelve + * tools is twelve requests, and a button that says only "Granting…" for the length of them gives + * an administrator no way to tell a slow batch from a stuck one. + */ + const [granting, setGranting] = useState<{ + done: number; + total: number; + } | null>(null); /* Every write reports into one banner rather than each growing its own handler. */ const report = { onError: (thrown: Error) => setError(thrown.message) }; @@ -173,6 +204,39 @@ function RouteComponent() { } }; + /* + * One write per grant, in selection order. The server records each grant as its own audit row, so + * a bulk action here is honestly N decisions; a refusal stops the rest and leaves the dialog open + * with the banner saying why. + * + * One refetch for the batch, at the end. Going through the grant mutation invalidated every plugin + * query after each write and awaited it, so a batch of twenty grants was twenty round trips + * interleaved with twenty refetches of a list nobody could see behind the dialog — most of the + * wait, for nothing anybody read. It is invalidated even when a grant is refused, because the ones + * before it landed and the screen behind is now stale about them. + */ + const grantSelected = async () => { + setError(null); + const total = selectedBots.size * selectedRefs.size; + setGranting({ done: 0, total }); + let done = 0; + try { + for (const agentId of selectedBots) { + for (const ref of selectedRefs) { + await grantPlugin({ agentId, kind: "mcp", ref }); + done += 1; + setGranting({ done, total }); + } + } + setDialog(null); + } catch (thrown) { + setError((thrown as Error).message); + } finally { + await invalidatePlugins(queryClient); + setGranting(null); + } + }; + /* Nothing rather than a placeholder, so no sentence asserts anything while the fetch is open. */ if (plugins.isPending) { return <PageShell title="Plugin">{null}</PageShell>; @@ -189,6 +253,16 @@ function RouteComponent() { ); } + /* The grant dialog's two halves of the tool list, split by what a boundary would see. */ + const reads = server?.tools.filter((tool) => tool.effect !== "write") ?? []; + const writes = server?.tools.filter((tool) => tool.effect === "write") ?? []; + const chosenWrites = writes.filter((tool) => + selectedRefs.has(tool.ref), + ).length; + const chosenNames = bots + .filter((bot) => selectedBots.has(bot.id)) + .map((bot) => bot.name); + return ( <PageShell backButton={{ label: "Plugins", linkProps: { to: "/admin/plugins" } }} @@ -251,10 +325,15 @@ function RouteComponent() { title="Connection" > {/* - * Rows that DO something, and nothing else. The layout skill's third row kind — a value - * with no chevron and nothing to click — earns its place on a screen full of them, but - * among four actionable rows a dead one reads as a control that has stopped working. The - * redirect URI is prose under the card instead. + * Rows that DO something, and nothing else — with one admitted exception. The layout + * skill's third row kind — a value with no chevron and nothing to click — earns its + * place on a screen full of them, but among four actionable rows a dead one reads as a + * control that has stopped working. The redirect URI is prose under the card instead. + * + * The exception is the OAuth client row for a vendor with a dynamic client: there is a + * real fact to state — this deployment registers itself, nobody configures it — right + * where the actionable client row would otherwise sit. Leaving that slot empty would + * read as a missing setup step, not as nothing to do. */} <PageRows> {auth === "deployment-bearer" ? ( @@ -279,7 +358,29 @@ function RouteComponent() { </Item> ) : null} - {auth === "user-oauth" ? ( + {auth === "user-oauth" && server?.dynamicClient ? ( + /* + * Nothing to click. This deployment registers its own OAuth client with the + * vendor (RFC 7591) the first time anybody connects, so there is no client id + * or secret for an administrator to hold, let alone paste. + */ + <Item size="sm"> + <ItemContent> + <ItemTitle>OAuth client</ItemTitle> + <ItemDescription> + This deployment registers itself with the vendor on first + connect. There is nothing to paste. + </ItemDescription> + </ItemContent> + <ItemActions> + <span className="text-muted-foreground text-xs"> + Self-registered + </span> + </ItemActions> + </Item> + ) : null} + + {auth === "user-oauth" && !server?.dynamicClient ? ( <Item render={ <button onClick={() => setDialog("client")} type="button" /> @@ -314,10 +415,13 @@ function RouteComponent() { * It is NOT part of setup. The connector is fully configured without it, which is why it * sits below the client and says so rather than reading as the next required step. * - * Shown only once a client exists, because there is nothing to consent against before - * that: a Connect button with no OAuth client behind it can only fail. + * Shown once a client exists, because there is nothing to consent against before + * that: a Connect button with no OAuth client behind it can only fail. A vendor with a + * dynamic client is the exception — there is no client to register in advance, so + * Connect is shown right away and is itself what creates one. */} - {auth === "user-oauth" && server?.hasCredential ? ( + {auth === "user-oauth" && + (server?.hasCredential || server?.dynamicClient) ? ( <> <Separator /> <Item size="sm"> @@ -325,7 +429,7 @@ function RouteComponent() { <ItemTitle>Your account</ItemTitle> <ItemDescription> {youConnected - ? "Connected, so a Bot granted these tools reads your Drive as you. Everybody else connects their own." + ? `Connected, so a Bot granted these tools uses your ${title} as you. Everybody else connects their own.` : "Connect your own account to try this connector. Setup is complete without it, and it reaches your documents only."} </ItemDescription> </ItemContent> @@ -416,21 +520,28 @@ function RouteComponent() { {auth === "user-oauth" ? ( <div className="mt-3 p-3"> - <p className="text-muted-foreground text-sm"> - Add this to the client's authorised redirect URIs at the vendor, - exactly as written. A single wrong character fails there, with a - message that does not mention OpenBot. - </p> - {plugins.data?.redirectUri ? ( - /* Selectable and monospaced: it is copied by hand into somebody else's console. */ - <code className="mt-3 block select-all break-all rounded bg-muted px-2 py-1 font-mono text-xs"> - {plugins.data.redirectUri} - </code> + {server?.dynamicClient ? ( + <p className="text-muted-foreground text-sm"> + The deployment registers its redirect URI itself, so there is + nothing to add at the vendor. + </p> ) : ( + <p className="text-muted-foreground text-sm"> + Add this to the client's authorised redirect URIs at the + vendor, exactly as written. A single wrong character fails + there, with a message that does not mention OpenBot. + </p> + )} + {!plugins.data?.redirectUri ? ( <p className="mt-3 text-destructive text-sm" role="alert"> This deployment has no public URL, so nobody can complete a consent flow. Set OPENBOT_PUBLIC_URL. </p> + ) : server?.dynamicClient ? null : ( + /* Selectable and monospaced: it is copied by hand into somebody else's console. */ + <code className="mt-3 block select-all break-all rounded bg-muted px-2 py-1 font-mono text-xs"> + {plugins.data.redirectUri} + </code> )} </div> ) : null} @@ -446,14 +557,35 @@ function RouteComponent() { * an administrator came here to do. */ action={ - <Button - onClick={() => refresh.mutate(key)} - size="sm" - type="button" - variant="ghost" - > - Refresh tools - </Button> + <div className="flex gap-1.5"> + <Button + onClick={() => refresh.mutate(key)} + size="sm" + type="button" + variant="ghost" + > + Refresh tools + </Button> + {/* + * Outline where refresh is ghost: granting is the thing an administrator came to + * this section to do. Hidden rather than disabled with nothing to grant — a dialog + * over an empty list could only explain its own emptiness. + */} + {server.tools.length > 0 && bots.length > 0 ? ( + <Button + onClick={() => { + setSelectedBots(new Set()); + setSelectedRefs(new Set()); + setDialog("grant"); + }} + size="sm" + type="button" + variant="outline" + > + Grant tools… + </Button> + ) : null} + </div> } description="A Bot is told about a tool only when it holds it. Every call is decided again when it happens, so removing a grant takes effect on the next one." title="Tools" @@ -561,7 +693,7 @@ function RouteComponent() { <Dialog onOpenChange={(open) => setDialog(open ? dialog : null)} - open={dialog !== null} + open={dialog !== null && dialog !== "grant"} > <DialogContent> <DialogHeader> @@ -659,6 +791,202 @@ function RouteComponent() { </DialogFooter> </DialogContent> </Dialog> + + {/* + * Who first, then what: the decision arrives as "set this Bot up", not as a list of tools + * looking for an owner. Both groups get a select-all; the amber heading and the footer's + * "N of which change things" are what keep a bulk write grant a read decision, not a blind one. + */} + {server ? ( + <Dialog + onOpenChange={(open) => setDialog(open ? dialog : null)} + open={dialog === "grant"} + > + <DialogContent> + <DialogHeader> + <DialogTitle>Grant tools</DialogTitle> + <DialogDescription> + Each grant is its own entry on the audit trail, and a granted + write is still checked against the boundaries on every call. + </DialogDescription> + </DialogHeader> + <DialogBody className="mt-4 space-y-5"> + {/* + * Each set of tickboxes is a group named by its own heading, so a screen reader + * reaching a bare tool name is told which list it is in. "Changes things" is the whole + * warning on those, and it is a heading a sighted reader cannot miss and a listener + * would otherwise never hear. + * + * A `fieldset` because that is what a group of tickboxes is, named by the heading + * already on screen rather than by a `legend` duplicating it. `min-w-0` undoes the + * one thing a fieldset brings that a div did not: a min-content floor that a long + * tool name would push the dialog out to. + */} + <fieldset aria-labelledby="grant-to-heading" className="min-w-0"> + <p className="mb-2 font-medium text-sm" id="grant-to-heading"> + To + </p> + <div className="space-y-2"> + {bots.map((bot) => ( + <div className="flex items-center gap-2" key={bot.id}> + <Checkbox + checked={selectedBots.has(bot.id)} + id={`grant-bot-${bot.id}`} + onCheckedChange={() => + setSelectedBots((previous) => + toggled(previous, bot.id), + ) + } + /> + <label + className="text-sm" + htmlFor={`grant-bot-${bot.id}`} + > + {bot.name} + </label> + </div> + ))} + </div> + </fieldset> + <div className="max-h-64 space-y-5 overflow-y-auto"> + {reads.length > 0 ? ( + <fieldset + aria-labelledby="grant-reads-heading" + className="min-w-0" + > + <div className="mb-1 flex items-center justify-between"> + <p + className="font-medium text-sm" + id="grant-reads-heading" + > + Reads + </p> + <Button + onClick={() => + setSelectedRefs((previous) => { + const next = new Set(previous); + for (const tool of reads) next.add(tool.ref); + return next; + }) + } + size="sm" + type="button" + variant="ghost" + > + Select all + </Button> + </div> + <div className="space-y-2"> + {reads.map((tool) => ( + <div className="flex items-center gap-2" key={tool.ref}> + <Checkbox + checked={selectedRefs.has(tool.ref)} + id={`grant-tool-${tool.ref}`} + onCheckedChange={() => + setSelectedRefs((previous) => + toggled(previous, tool.ref), + ) + } + /> + <label + className="font-mono text-xs" + htmlFor={`grant-tool-${tool.ref}`} + > + {tool.name} + </label> + </div> + ))} + </div> + </fieldset> + ) : null} + {writes.length > 0 ? ( + <fieldset + aria-labelledby="grant-writes-heading" + className="min-w-0" + > + <div className="mb-1 flex items-center justify-between"> + <p + className="font-medium text-amber-600 text-sm dark:text-amber-500" + id="grant-writes-heading" + > + Changes things + </p> + <Button + onClick={() => + setSelectedRefs((previous) => { + const next = new Set(previous); + for (const tool of writes) next.add(tool.ref); + return next; + }) + } + size="sm" + type="button" + variant="ghost" + > + Select all + </Button> + </div> + <div className="space-y-2"> + {writes.map((tool) => ( + <div className="flex items-center gap-2" key={tool.ref}> + <Checkbox + checked={selectedRefs.has(tool.ref)} + id={`grant-tool-${tool.ref}`} + onCheckedChange={() => + setSelectedRefs((previous) => + toggled(previous, tool.ref), + ) + } + /> + <label + className="font-mono text-xs" + htmlFor={`grant-tool-${tool.ref}`} + > + {tool.name} + </label> + </div> + ))} + </div> + </fieldset> + ) : null} + </div> + </DialogBody> + <DialogFooter className="mt-4 items-center"> + {/* What is about to happen, in one sentence, before it does. */} + {selectedRefs.size > 0 && chosenNames.length > 0 ? ( + <p className="flex-1 text-muted-foreground text-xs"> + {`Grant ${selectedRefs.size} ${ + selectedRefs.size === 1 ? "tool" : "tools" + }${ + chosenWrites > 0 + ? `, ${chosenWrites} of which ${ + chosenWrites === 1 ? "changes" : "change" + } things,` + : "" + } to ${chosenNames.join(", ")}.`} + </p> + ) : null} + <Button onClick={() => setDialog(null)} size="sm" variant="ghost"> + Cancel + </Button> + <Button + disabled={ + granting !== null || + selectedBots.size === 0 || + selectedRefs.size === 0 + } + onClick={() => void grantSelected()} + size="sm" + > + {/* The one in flight, not the ones finished: a count that starts at zero of twelve reads as nothing happening. */} + {granting + ? `Granting ${Math.min(granting.done + 1, granting.total)} of ${granting.total}…` + : "Grant"} + </Button> + </DialogFooter> + </DialogContent> + </Dialog> + ) : null} </PageShell> ); } diff --git a/app/src/routes/_authed/admin/plugins/index.tsx b/app/src/routes/_authed/admin/plugins/index.tsx index 69b6ee44..17d6db1d 100644 --- a/app/src/routes/_authed/admin/plugins/index.tsx +++ b/app/src/routes/_authed/admin/plugins/index.tsx @@ -1,5 +1,6 @@ import { IconBrandGoogleDrive, + IconBrandNotion, IconChevronRight, IconPlug, } from "@tabler/icons-react"; @@ -54,6 +55,7 @@ export const Route = createFileRoute("/_authed/admin/plugins/")({ */ const MARKS: Record<string, React.ComponentType<{ className?: string }>> = { "google-drive": IconBrandGoogleDrive, + notion: IconBrandNotion, }; const markFor = (key: string) => MARKS[key] ?? IconPlug; diff --git a/app/src/routes/_authed/admin/route.tsx b/app/src/routes/_authed/admin/route.tsx index d83cfe74..e92175c3 100644 --- a/app/src/routes/_authed/admin/route.tsx +++ b/app/src/routes/_authed/admin/route.tsx @@ -19,12 +19,12 @@ function RouteComponent() { return ( <SidebarProvider /* - * The same 340px the app and Settings use. A rail that changes width as you cross into admin - * makes the whole frame look like it moved. + * The same 300px Settings uses: these two rails hold short nav labels, not the roster's + * two-line previews, so they earn less width than the app shell's 340px. */ style={ { - "--sidebar-width": "340px", + "--sidebar-width": "300px", "--sidebar-width-mobile": "20rem", } as React.CSSProperties } diff --git a/app/src/routes/_authed/settings/connected-accounts/index.tsx b/app/src/routes/_authed/settings/connected-accounts/index.tsx index 07e2bf6a..04a7f96b 100644 --- a/app/src/routes/_authed/settings/connected-accounts/index.tsx +++ b/app/src/routes/_authed/settings/connected-accounts/index.tsx @@ -1,5 +1,6 @@ import { IconBrandGoogleDrive, + IconBrandNotion, IconChevronRight, IconPlug, } from "@tabler/icons-react"; @@ -52,6 +53,7 @@ export const Route = createFileRoute("/_authed/settings/connected-accounts/")({ /** The same marks the admin connector list uses: these are the same vendors seen from your side. */ const MARKS: Record<string, React.ComponentType<{ className?: string }>> = { "google-drive": IconBrandGoogleDrive, + notion: IconBrandNotion, }; const markFor = (key: string) => MARKS[key] ?? IconPlug; diff --git a/app/src/routes/_authed/settings/route.tsx b/app/src/routes/_authed/settings/route.tsx index 9aae2f3e..93e3d935 100644 --- a/app/src/routes/_authed/settings/route.tsx +++ b/app/src/routes/_authed/settings/route.tsx @@ -10,12 +10,12 @@ function RouteComponent() { return ( <SidebarProvider /* - * The same 340px the app shell uses. Settings is a different screen, not a different product, - * and a rail that changes width on the way in makes the whole frame look like it moved. + * The same 300px admin uses: these two rails hold short nav labels, not the roster's + * two-line previews, so they earn less width than the app shell's 340px. */ style={ { - "--sidebar-width": "340px", + "--sidebar-width": "300px", "--sidebar-width-mobile": "20rem", } as React.CSSProperties } diff --git a/app/tests/channel-event-patch.test.ts b/app/tests/channel-event-patch.test.ts new file mode 100644 index 00000000..62efb793 --- /dev/null +++ b/app/tests/channel-event-patch.test.ts @@ -0,0 +1,171 @@ +import { describe, expect, test } from "bun:test"; +import type { ChannelPage, ChannelSummary } from "../src/lib/channels/queries"; +import { + applyChannelEvent, + type ChannelActivityEvent, +} from "../src/lib/channels/use-channel-events"; + +/** A minimal but fully-typed channel summary, so tests build real objects rather than casts. */ +function channel( + id: string, + overrides: Partial<ChannelSummary> = {}, +): ChannelSummary { + return { + id, + name: id, + agentIds: [], + threadId: `thread-${id}`, + active: true, + lastMessage: null, + lastMessageAt: null, + lastMessageAgentId: null, + createdAt: "2024-01-01T00:00:00.000Z", + pinned: false, + ...overrides, + }; +} + +function cache(...pages: ChannelSummary[][]) { + return { + pages: pages.map( + (channels): ChannelPage => ({ channels, nextCursor: null }), + ), + pageParams: pages.map(() => ""), + }; +} + +function event( + overrides: Partial<ChannelActivityEvent> & { channelId: string }, +): ChannelActivityEvent { + return { + lastMessage: null, + lastMessageAt: null, + lastMessageAgentId: null, + ...overrides, + }; +} + +describe("an ordinary activity event", () => { + test("patches the row inside the page that holds it and re-sorts that page", () => { + const data = cache([ + channel("a", { lastMessageAt: "2024-03-01T00:00:00.000Z" }), + channel("b"), + ]); + + const patched = applyChannelEvent( + data, + event({ + channelId: "b", + lastMessage: "Said something.", + lastMessageAt: "2024-04-01T00:00:00.000Z", + }), + ); + + expect(patched).not.toBe("unknown"); + if (patched === "unknown") return; + expect(patched.pages[0]?.channels.map((row) => row.id)).toEqual(["b", "a"]); + expect(patched.pages[0]?.channels[0]?.lastMessage).toBe("Said something."); + }); + + test("is unknown when no page holds the channel, so the caller refetches", () => { + expect( + applyChannelEvent(cache([channel("a")]), event({ channelId: "z" })), + ).toBe("unknown"); + }); +}); + +/** + * A channel somebody deleted in another tab, or on another replica. + * + * The tab that issued the delete moves itself; every other tab only ever hears about it here, so + * without this the row stays on their roster until something else makes them refetch. + */ +describe("a deleted channel", () => { + test("is removed from the page that held it", () => { + const data = cache([channel("a"), channel("b")], [channel("c")]); + + const patched = applyChannelEvent( + data, + event({ channelId: "b", deleted: true }), + ); + + expect(patched).not.toBe("unknown"); + if (patched === "unknown") return; + expect(patched.pages[0]?.channels.map((row) => row.id)).toEqual(["a"]); + // The other page is untouched, object identity included, so its rows do not re-render. + expect(patched.pages[1]).toBe(data.pages[1]); + }); + + test("is never spread onto the row instead of removing it", () => { + const patched = applyChannelEvent( + cache([channel("a")]), + event({ channelId: "a", deleted: true }), + ); + + expect(patched).not.toBe("unknown"); + if (patched === "unknown") return; + // The failure this guards is a row left on the roster carrying `deleted: true`, which renders + // as an ordinary channel whose every query now 404s. + expect(patched.pages[0]?.channels).toEqual([]); + }); + + test("changes nothing when this cache never had the channel", () => { + const data = cache([channel("a")]); + + // Unlike an ordinary event, an unknown id here is not a stale roster: the channel is already + // gone from this cache, so there is nothing to patch and nothing to refetch for. + expect( + applyChannelEvent(data, event({ channelId: "z", deleted: true })), + ).toBe(data); + }); +}); + +/** + * A pin this person made in one of their own tabs. + * + * Scoped to them by the server, so arriving here means it is the reader's own pin. + */ +describe("a pin", () => { + test("patches only the pinned flag, leaving the last message alone", () => { + const data = cache([ + channel("a", { + lastMessage: "Said something.", + lastMessageAt: "2024-04-01T00:00:00.000Z", + lastMessageAgentId: "agent-1", + }), + ]); + + const patched = applyChannelEvent( + data, + event({ channelId: "a", pinned: true }), + ); + + expect(patched).not.toBe("unknown"); + if (patched === "unknown") return; + expect(patched.pages[0]?.channels[0]).toEqual({ + ...(data.pages[0]?.channels[0] as ChannelSummary), + pinned: true, + }); + }); + + test("unpins the same way", () => { + const patched = applyChannelEvent( + cache([channel("a", { pinned: true })]), + event({ channelId: "a", pinned: false }), + ); + + expect(patched).not.toBe("unknown"); + if (patched === "unknown") return; + expect(patched.pages[0]?.channels[0]?.pinned).toBe(false); + }); + + test("returns the same cache when the row already says so", () => { + const data = cache([channel("a", { pinned: true })]); + + // A duplicate, or the tab that made the pin hearing its own event back. Identity preserved, so + // React re-renders nothing at all. + expect( + applyChannelEvent(data, event({ channelId: "a", pinned: true })), + ).toBe(data); + }); +}); diff --git a/app/tests/channel-menu-mutations.test.ts b/app/tests/channel-menu-mutations.test.ts new file mode 100644 index 00000000..b0cd4791 --- /dev/null +++ b/app/tests/channel-menu-mutations.test.ts @@ -0,0 +1,174 @@ +import { afterEach, expect, test } from "bun:test"; +import { QueryClient, type InfiniteData } from "@tanstack/react-query"; +import { + deleteChannelMutationOptions, + markChannelReadMutationOptions, + setChannelPinnedMutationOptions, +} from "../src/lib/channels/mutations"; +import { channelKeys, type ChannelPage } from "../src/lib/channels/queries"; + +const realFetch = globalThis.fetch; + +afterEach(() => { + globalThis.fetch = realFetch; +}); + +type SeenRequest = { url: string; init: RequestInit | undefined }; + +function capturingFetch(status: number, body: unknown) { + const seen: SeenRequest[] = []; + globalThis.fetch = (async (url: unknown, init?: RequestInit) => { + seen.push({ url: String(url), init }); + return new Response(body === undefined ? null : JSON.stringify(body), { + status, + headers: { "content-type": "application/json" }, + }); + }) as unknown as typeof fetch; + return seen; +} + +function invalidationRecorder() { + const invalidated: unknown[] = []; + const queryClient = { + invalidateQueries: async (filter: unknown) => { + invalidated.push(filter); + }, + } as unknown as QueryClient; + return { queryClient, invalidated }; +} + +test("pinning PUTs the flag to the channel's pin route and invalidates the roster", async () => { + const seen = capturingFetch(200, { pinned: true }); + const { queryClient, invalidated } = invalidationRecorder(); + const options = setChannelPinnedMutationOptions(queryClient); + + await options.mutationFn?.({ channelId: "channel-1", pinned: true }); + await options.onSuccess?.( + undefined as never, + { channelId: "channel-1", pinned: true }, + undefined as never, + undefined as never, + ); + + expect(seen).toHaveLength(1); + expect(seen[0]?.url).toBe("/api/channels/channel-1/pin"); + expect(seen[0]?.init?.method).toBe("PUT"); + expect(JSON.parse(String(seen[0]?.init?.body))).toEqual({ pinned: true }); + expect(invalidated).toEqual([{ queryKey: ["channels"] }]); +}); + +test("deleting sends DELETE to the channel route and invalidates the roster", async () => { + const seen = capturingFetch(204, undefined); + const { queryClient, invalidated } = invalidationRecorder(); + const options = deleteChannelMutationOptions(queryClient); + + await options.mutationFn?.("channel-1"); + await options.onSuccess?.( + undefined as never, + "channel-1", + undefined as never, + undefined as never, + ); + + expect(seen).toHaveLength(1); + expect(seen[0]?.url).toBe("/api/channels/channel-1"); + expect(seen[0]?.init?.method).toBe("DELETE"); + expect(invalidated).toEqual([{ queryKey: ["channels", "list"] }]); +}); + +test("a refused delete surfaces the server's sentence", async () => { + capturingFetch(409, { + error: + "This channel is defined by the deployment package, so it cannot be deleted here.", + }); + const { queryClient } = invalidationRecorder(); + const options = deleteChannelMutationOptions(queryClient); + + await expect(options.mutationFn?.("channel-1")).rejects.toThrow( + "This channel is defined by the deployment package, so it cannot be deleted here.", + ); +}); + +test("marking read PUTs the read route and patches lastReadAt in place", async () => { + const seen = capturingFetch(204, undefined); + const queryClient = new QueryClient(); + queryClient.setQueryData(channelKeys.list(), { + pages: [ + { + channels: [ + { + id: "channel-1", + name: "Assistant channel", + agentIds: ["agent-1"], + threadId: "thread-1", + active: true, + lastMessage: "hello", + lastMessageAt: "2026-08-25T12:00:00.000Z", + lastMessageAgentId: "agent-1", + createdAt: "2026-08-25T11:00:00.000Z", + pinned: false, + lastReadAt: null, + }, + ], + nextCursor: null, + }, + ], + pageParams: [""], + } satisfies InfiniteData<ChannelPage>); + const options = markChannelReadMutationOptions(queryClient); + + options.onMutate?.("channel-1"); + await options.mutationFn?.("channel-1"); + + expect(seen).toHaveLength(1); + expect(seen[0]?.url).toBe("/api/channels/channel-1/read"); + expect(seen[0]?.init?.method).toBe("PUT"); + const patched = queryClient.getQueryData<InfiniteData<ChannelPage>>( + channelKeys.list(), + ); + // The dot clears from the cache before the wire answered, and nothing was invalidated: + // there is no onSuccess to queue a refetch that would race the socket's own patches. + expect(patched?.pages[0]?.channels[0]?.lastReadAt).not.toBeNull(); + expect(options.onSuccess).toBeUndefined(); +}); + +test("a message stamped by a clock ahead of ours still reads as seen after marking", async () => { + capturingFetch(204, undefined); + const queryClient = new QueryClient(); + const futureLastMessageAt = new Date(Date.now() + 60_000).toISOString(); + queryClient.setQueryData(channelKeys.list(), { + pages: [ + { + channels: [ + { + id: "channel-1", + name: "Assistant channel", + agentIds: ["agent-1"], + threadId: "thread-1", + active: true, + lastMessage: "hello", + lastMessageAt: futureLastMessageAt, + lastMessageAgentId: "agent-1", + createdAt: "2026-08-25T11:00:00.000Z", + pinned: false, + lastReadAt: null, + }, + ], + nextCursor: null, + }, + ], + pageParams: [""], + } satisfies InfiniteData<ChannelPage>); + const options = markChannelReadMutationOptions(queryClient); + + options.onMutate?.("channel-1"); + + const patched = queryClient.getQueryData<InfiniteData<ChannelPage>>( + channelKeys.list(), + ); + const row = patched?.pages[0]?.channels[0]; + // A reader's clock running behind the writer's must not leave the row still reading as unseen: + // the patched lastReadAt has to catch up to (or pass) lastMessageAt, not just "now". + expect(row?.lastReadAt).not.toBeNull(); + expect((row?.lastReadAt as string) >= futureLastMessageAt).toBe(true); +}); diff --git a/app/tests/channel-order.test.ts b/app/tests/channel-order.test.ts new file mode 100644 index 00000000..ad283696 --- /dev/null +++ b/app/tests/channel-order.test.ts @@ -0,0 +1,53 @@ +import { expect, test } from "bun:test"; +import { pinnedFirst } from "../src/components/app-sidebar/app-sidebar"; +import type { ChannelSummary } from "../src/lib/channels/queries"; + +/** A minimal but fully-typed channel summary, so tests build real objects rather than casts. */ +function channel(id: string, pinned: boolean): ChannelSummary { + return { + id, + name: id, + agentIds: [], + threadId: `thread-${id}`, + active: true, + lastMessage: null, + lastMessageAt: null, + lastMessageAgentId: null, + createdAt: "2024-01-01T00:00:00.000Z", + pinned, + lastReadAt: null, + }; +} + +test("holds pinned channels at the top, newest-activity order preserved within each group", () => { + /* + * Interleaved, which is what the cache can hold between refetches: the server hands back + * pinned-first, and then the socket patches a pin onto a loaded row without moving it, or re-sorts + * a page by recency alone. This function is the render-level mirror that closes that window. + */ + const channels = [ + channel("a", false), + channel("b", true), + channel("c", false), + channel("d", true), + channel("e", false), + ]; + + expect(pinnedFirst(channels).map((c) => c.id)).toEqual([ + "b", + "d", + "a", + "c", + "e", + ]); +}); + +test("leaves an all-unpinned roster in its original order", () => { + const channels = [ + channel("a", false), + channel("b", false), + channel("c", false), + ]; + + expect(pinnedFirst(channels).map((c) => c.id)).toEqual(["a", "b", "c"]); +}); diff --git a/app/tests/channel-unread.test.ts b/app/tests/channel-unread.test.ts new file mode 100644 index 00000000..40192e3e --- /dev/null +++ b/app/tests/channel-unread.test.ts @@ -0,0 +1,62 @@ +import { expect, test } from "bun:test"; +import { + hasUnseenActivity, + isUnread, +} from "../src/components/app-sidebar/app-sidebar"; +import type { ChannelSummary } from "../src/lib/channels/queries"; + +/** A minimal but fully-typed summary, so tests build real objects rather than casts. */ +function channel(overrides: Partial<ChannelSummary>): ChannelSummary { + return { + id: "channel-1", + name: "Assistant channel", + agentIds: ["agent-1"], + threadId: "thread-1", + active: true, + lastMessage: "hello", + lastMessageAt: "2026-08-25T12:00:00.000Z", + lastMessageAgentId: "agent-1", + createdAt: "2026-08-25T11:00:00.000Z", + pinned: false, + lastReadAt: null, + ...overrides, + }; +} + +test("a Bot message in a never-opened channel is unseen", () => { + expect(hasUnseenActivity(channel({}))).toBe(true); +}); + +test("a Bot message newer than the read marker is unseen", () => { + expect( + hasUnseenActivity(channel({ lastReadAt: "2026-08-25T11:30:00.000Z" })), + ).toBe(true); +}); + +test("a read marker after the last message means nothing is unseen", () => { + expect( + hasUnseenActivity(channel({ lastReadAt: "2026-08-25T12:30:00.000Z" })), + ).toBe(false); +}); + +test("your own last message never counts as unseen", () => { + expect(hasUnseenActivity(channel({ lastMessageAgentId: null }))).toBe(false); +}); + +test("a silent channel has nothing unseen", () => { + expect( + hasUnseenActivity( + channel({ + lastMessage: null, + lastMessageAt: null, + lastMessageAgentId: null, + }), + ), + ).toBe(false); +}); + +test("the open channel is never unread, however unseen its activity", () => { + expect(isUnread(channel({}), "channel-1")).toBe(false); + expect(isUnread(channel({}), "channel-2")).toBe(true); + expect(isUnread(channel({}), undefined)).toBe(true); +}); diff --git a/app/tests/declared-bot.test.ts b/app/tests/declared-bot.test.ts new file mode 100644 index 00000000..5b7b2244 --- /dev/null +++ b/app/tests/declared-bot.test.ts @@ -0,0 +1,21 @@ +import { describe, expect, test } from "bun:test"; +import { declaredBotId } from "../src/lib/copilot/active-bot"; + +/** + * The placeholder Bot id is a routing convenience, not a Bot. Anything that would ask the server + * about it must be told there is nothing to ask about. + */ + +describe("declaredBotId", () => { + test("returns undefined for the placeholder", () => { + expect(declaredBotId("default")).toBeUndefined(); + }); + + test("passes a declared Bot through", () => { + expect(declaredBotId("general-assistant")).toBe("general-assistant"); + }); + + test("passes a Bot through even when the placeholder is its prefix", () => { + expect(declaredBotId("default-2")).toBe("default-2"); + }); +}); diff --git a/app/tests/markdown-chips.test.ts b/app/tests/markdown-chips.test.ts new file mode 100644 index 00000000..31d86466 --- /dev/null +++ b/app/tests/markdown-chips.test.ts @@ -0,0 +1,41 @@ +import { describe, expect, test } from "bun:test"; +import { documentChipKind } from "../src/lib/markdown"; + +/** + * Which links get drawn as a document chip. + * + * Recognition is by exact host and https only, because a chip asserts "this is a document in a + * system you have connected" — a claim that must not be honored for an impostor domain or a + * downgraded scheme. + */ +describe("recognising a document link", () => { + test("a Google Doc URL is drawn as a Doc chip", () => { + expect(documentChipKind("https://docs.google.com/document/d/x")).toEqual( + expect.objectContaining({ label: "Doc" }), + ); + }); + + test("a Notion workspace page URL is drawn as a Notion chip", () => { + expect(documentChipKind("https://www.notion.so/ws/Page-abc")).toEqual( + expect.objectContaining({ label: "Notion" }), + ); + }); + + test("a bare notion.so URL is drawn as a Notion chip", () => { + expect(documentChipKind("https://notion.so/abc")).toEqual( + expect.objectContaining({ label: "Notion" }), + ); + }); + + test("a lookalike host is not a Notion document, even though it ends the same way", () => { + expect(documentChipKind("https://notion.so.evil.test/x")).toBeNull(); + }); + + test("a Notion URL over plain http is not a document chip", () => { + expect(documentChipKind("http://www.notion.so/x")).toBeNull(); + }); + + test("a relative href is not a document chip", () => { + expect(documentChipKind("/some/relative/path")).toBeNull(); + }); +}); diff --git a/app/tests/plugin-grants.test.ts b/app/tests/plugin-grants.test.ts new file mode 100644 index 00000000..f18ee1aa --- /dev/null +++ b/app/tests/plugin-grants.test.ts @@ -0,0 +1,111 @@ +import { afterEach, expect, test } from "bun:test"; +import type { QueryClient } from "@tanstack/react-query"; +import { + grantPlugin, + setPluginGrantMutationOptions, +} from "../src/lib/plugins/mutations"; + +/** + * Granting a batch of tools, and what a batch is allowed to cost. + * + * The admin dialog grants a tool per Bot per tick, so choosing two Bots and twelve tools is + * twenty-four writes. Every one of them used to go through the grant mutation, which invalidates + * every plugin query and waits for the refetch — so most of the wait was re-reading a list hidden + * behind the dialog. `grantPlugin` is the write on its own, and the caller refetches once at the + * end. These pin that the write is unchanged and that the refetch is not attached to it. + */ + +const realFetch = globalThis.fetch; + +afterEach(() => { + globalThis.fetch = realFetch; +}); + +type SeenRequest = { url: string; init: RequestInit | undefined }; + +function capturingFetch(status: number, body: unknown) { + const seen: SeenRequest[] = []; + globalThis.fetch = (async (url: unknown, init?: RequestInit) => { + seen.push({ url: String(url), init }); + return new Response(body === undefined ? null : JSON.stringify(body), { + status, + headers: { "content-type": "application/json" }, + }); + }) as unknown as typeof fetch; + return seen; +} + +function invalidationRecorder() { + const invalidated: unknown[] = []; + const queryClient = { + invalidateQueries: async (filter: unknown) => { + invalidated.push(filter); + }, + } as unknown as QueryClient; + return { queryClient, invalidated }; +} + +test("one grant is one POST of the three things it joins", async () => { + const seen = capturingFetch(200, {}); + + await grantPlugin({ agentId: "agent-1", kind: "mcp", ref: "notion/search" }); + + expect(seen).toHaveLength(1); + expect(seen[0]?.url).toBe("/api/plugins/grants"); + expect(seen[0]?.init?.method).toBe("POST"); + expect(JSON.parse(String(seen[0]?.init?.body))).toEqual({ + agentId: "agent-1", + kind: "mcp", + ref: "notion/search", + }); +}); + +test("a batch of grants is N grant requests and nothing else", async () => { + const seen = capturingFetch(200, {}); + + for (const ref of ["notion/search", "notion/fetch", "notion/create"]) { + await grantPlugin({ agentId: "agent-1", kind: "mcp", ref }); + } + + // Three writes, and no read in between: the refetch belongs to the caller, once, at the end. + expect(seen.map((request) => request.init?.method)).toEqual([ + "POST", + "POST", + "POST", + ]); +}); + +test("a refused grant carries the server's own sentence", async () => { + capturingFetch(403, { error: "That Agent is defined by the package." }); + + await expect( + grantPlugin({ agentId: "agent-1", kind: "mcp", ref: "notion/search" }), + ).rejects.toThrow("That Agent is defined by the package."); +}); + +test("granting one on its own still carries its refetch", async () => { + const seen = capturingFetch(200, {}); + const { queryClient, invalidated } = invalidationRecorder(); + const options = setPluginGrantMutationOptions(queryClient); + + await options.mutationFn?.({ + agentId: "agent-1", + granted: true, + kind: "mcp", + ref: "notion/search", + }); + await options.onSuccess?.( + undefined as never, + { + agentId: "agent-1", + granted: true, + kind: "mcp", + ref: "notion/search", + }, + undefined as never, + undefined as never, + ); + + expect(seen).toHaveLength(1); + expect(invalidated).toEqual([{ queryKey: ["plugins"] }]); +}); diff --git a/app/tests/thread-messages.test.ts b/app/tests/thread-messages.test.ts index faa8f831..badce946 100644 --- a/app/tests/thread-messages.test.ts +++ b/app/tests/thread-messages.test.ts @@ -1,159 +1,252 @@ import { describe, expect, test } from "bun:test"; -import { readableTurns } from "@/lib/copilot/thread-messages"; +import { readableTurns } from "../src/lib/copilot/thread-messages"; /** - * What comes back out of the history store, and what is refused at the door. + * Reading back a conversation that used a tool. * - * The old reader cast whatever it was given to `Message[]`, so a turn the store held in some other - * shape reached every projection that draws a transcript — and one of them dereferenced - * `toolCall.function.arguments`, which took the conversation down rather than the turn. - * - * These are the shapes that have actually been seen, not invented ones: the tool call persisted as - * `{id, name, args}` comes from #199, which found seventeen of them in one thread after interrupted - * runs, and the content shapes come from the tests on #43. + * The shapes below are copied from a live thread rather than invented. The store writes a tool call + * as `{id, name, args}`; AG-UI describes `{id, type: "function", function: {name, arguments}}`. A + * reader that insists on the second and refuses the first throws away every turn in which a Bot did + * anything, which is the half of the conversation worth keeping. */ - -const userTurn = { id: "m1", role: "user", content: "What did I miss?" }; - -const assistantTurn = { - id: "m2", - role: "assistant", - content: "Here is the summary.", +const userTurn = { + id: "6953d56c", + role: "user", + content: "open hackernews.com and tell me the top 3 stories", }; -/** As AG-UI defines a tool call: a literal `function` type, with the call nested under it. */ -const wellFormedToolCall = { - id: "m3", +/** As the history store writes it. */ +const storedToolCall = { + id: "0fe7b049", role: "assistant", toolCalls: [ { - id: "call_1", - type: "function", - function: { name: "search_files", arguments: "{}" }, + id: "call_maB4q3", + name: "computer_navigate", + args: '{"url":"https://news.ycombinator.com"}', }, ], }; -describe("reading back a stored thread", () => { - test("an ordinary conversation comes back whole, with nothing counted", () => { - const { messages, unreadable } = readableTurns([userTurn, assistantTurn]); - expect(messages).toHaveLength(2); +const toolResult = { + id: "aa5e9452", + role: "tool", + toolCallId: "call_maB4q3", + content: '{"ok":true,"title":"Hacker News"}', +}; + +const answer = { id: "5c1f", role: "assistant", content: "Top 3 stories…" }; + +describe("restoring a conversation that used a tool", () => { + test("a browsing turn survives the read", () => { + const { messages, unreadable } = readableTurns([ + userTurn, + storedToolCall, + toolResult, + answer, + ]); + + // Every one of them, and the tool call above all: without it the transcript keeps the sentence + // the Bot wrote and loses the browsing that produced it. + expect(messages).toHaveLength(4); expect(unreadable).toBe(0); }); - test("a well-formed tool call survives", () => { - // The shape the transcript knows how to draw. If validation rejected this, the fix would have - // traded a crash for an empty conversation. - const { messages, unreadable } = readableTurns([wellFormedToolCall]); - expect(messages).toHaveLength(1); - expect(unreadable).toBe(0); + test("the tool call comes back in the shape every renderer reads", () => { + const { messages } = readableTurns([storedToolCall]); + expect(messages[0]).toMatchObject({ + role: "assistant", + toolCalls: [ + { + id: "call_maB4q3", + type: "function", + function: { + name: "computer_navigate", + arguments: '{"url":"https://news.ycombinator.com"}', + }, + }, + ], + }); }); - test("a tool call stored the LangChain way is dropped and counted", () => { - /* - * The turn from #199: `{id, name, args}` rather than `{id, type: "function", function: {…}}`. - * This is the one that crashed a renderer reading `toolCall.function.arguments`, so the whole - * turn has to not arrive — and the count is what stops it vanishing quietly. - */ - const langChainShaped = { - id: "m4", + test("a call already in AG-UI's shape is left alone", () => { + const already = { + id: "x", role: "assistant", - toolCalls: [{ id: "call_2", name: "search_files", args: {} }], + toolCalls: [ + { + id: "c1", + type: "function", + function: { name: "computer_click", arguments: "{}" }, + }, + ], }; + const { messages, unreadable } = readableTurns([already]); + expect(unreadable).toBe(0); + expect(messages[0]).toEqual(already as never); + }); - const { messages, unreadable } = readableTurns([ - userTurn, - langChainShaped, - assistantTurn, - ]); - - expect(messages.map((message) => message.id)).toEqual(["m1", "m2"]); + test("a turn that is genuinely malformed is still refused", () => { + /* + * The guard is not being removed, only taught a second spelling. A tool call with neither shape + * is something no renderer can draw, and letting it through is how one bad turn used to take a + * whole conversation down. + */ + const nonsense = { id: "y", role: "assistant", toolCalls: [{ id: "c2" }] }; + const { messages, unreadable } = readableTurns([nonsense]); + expect(messages).toHaveLength(0); expect(unreadable).toBe(1); }); - test("multimodal content is not mistaken for a malformed turn", () => { - // AG-UI allows content as typed parts as well as a string, so a turn carrying an image is - // ordinary. Rejecting it would lose real messages in the name of safety. - const withParts = { - id: "m5", - role: "user", - content: [{ type: "text", text: "What is in this?" }], + test("a mixed array is refused rather than half-translated", () => { + // Guessing at half of it would be this file inventing history rather than reading it. + const mixed = { + id: "z", + role: "assistant", + toolCalls: [ + { id: "a", name: "one", args: "{}" }, + { + id: "b", + type: "function", + function: { name: "two", arguments: "{}" }, + }, + ], }; - const { messages, unreadable } = readableTurns([withParts]); - expect(messages).toHaveLength(1); + expect(readableTurns([mixed]).unreadable).toBe(1); + }); + + test("everything else passes through untouched", () => { + const { messages, unreadable } = readableTurns([userTurn, answer]); expect(unreadable).toBe(0); + expect(messages[0]).toEqual(userTurn as never); }); +}); - test("content that is not content is dropped rather than drawn as empty", () => { +/** + * The cases the rewrite dropped, plus the one it never had. + * + * A reader that translates between two dialects is exactly where a quiet data-loss bug lives, and + * these are the shapes a real thread contains: arguments the store kept as an object, content that + * is a list of parts rather than a string, a turn with no content at all, and an order that has to + * survive the trip because a conversation read out of sequence is not the conversation. + */ +describe("shapes a real thread contains", () => { + test("arguments the store kept as an object become a string", () => { + const [turn] = readableTurns([ + { + id: "m1", + role: "assistant", + toolCalls: [ + { id: "c1", name: "computer_navigate", args: { url: "https://x" } }, + ], + }, + ]).messages as Array<Record<string, unknown>>; + + const call = (turn.toolCalls as Array<Record<string, unknown>>)[0]; + const fn = call.function as Record<string, unknown>; /* - * From the #43 cases. These used to reach a projection and resolve to an empty message, so the - * transcript showed a turn that said nothing and read as though somebody had sent a blank line. - * Refused here instead, and reported. + * AG-UI types this as a string. Passing the object through produced a call that looked + * translated and still failed validation, so the turn was dropped anyway: this function's own + * bug, one layer down. */ - const shapes = [ - { id: "a", role: "user" }, - { id: "b", role: "user", content: null }, - { id: "c", role: "user", content: 42 }, - { id: "d", role: "user", content: [null, "text", 7] }, - ]; - - const { messages, unreadable } = readableTurns(shapes); - expect(messages).toEqual([]); - expect(unreadable).toBe(4); + expect(typeof fn.arguments).toBe("string"); + expect(JSON.parse(fn.arguments as string)).toEqual({ url: "https://x" }); }); - test("a turn that is not an object at all is dropped", () => { + test("a string of arguments is passed through exactly", () => { + const [turn] = readableTurns([ + { + id: "m1", + role: "assistant", + toolCalls: [{ id: "c1", name: "t", args: '{"url": "https://x"}' }], + }, + ]).messages as Array<Record<string, unknown>>; + + const call = (turn.toolCalls as Array<Record<string, unknown>>)[0]; + // Down to the whitespace: it may be a fragment of a stream that was never valid JSON, and + // re-encoding it would change what the model actually said. + expect((call.function as Record<string, unknown>).arguments).toBe( + '{"url": "https://x"}', + ); + }); + + /* + * A call with no arguments at all. Not `args` missing entirely, which the dialect check refuses on + * purpose so that it never rewrites something that was not a stored call in the first place. + */ + test("a call with empty arguments becomes something a reader can parse", () => { + const [turn] = readableTurns([ + { + id: "m1", + role: "assistant", + toolCalls: [{ id: "c1", name: "t", args: null }], + }, + ]).messages as Array<Record<string, unknown>>; + + const call = (turn.toolCalls as Array<Record<string, unknown>>)[0]; + expect((call.function as Record<string, unknown>).arguments).toBe("{}"); + }); + + /* + * A turn that called a tool and said nothing alongside it is written exactly this way, and it was + * being dropped: the same loss the tool-call dialect caused, arriving by a different route. The + * schema makes an assistant's content optional and does not allow null, so the two say the same + * thing and only one parsed. + */ + test("an assistant turn that said nothing while it worked survives", () => { const { messages, unreadable } = readableTurns([ - null, - "a string", - 7, - userTurn, + { + id: "m1", + role: "assistant", + content: null, + toolCalls: [{ id: "c1", name: "computer_navigate", args: "{}" }], + }, ]); - expect(messages.map((message) => message.id)).toEqual(["m1"]); - expect(unreadable).toBe(3); + + expect(messages).toHaveLength(1); + expect(unreadable).toBe(0); }); - test("a turn with no recognised role is dropped", () => { - // The schema is a union on `role`, so an unknown one matches no member. + /* + * And a person's turn is not the same case. Content is required there, so `null` is not a message + * somebody sent: it used to reach a projection and draw as a blank line. Refused and counted, so + * the surface can say so, which is the decision #207 made and this does not disturb. + */ + test("a person's turn with no content is still refused and counted", () => { const { messages, unreadable } = readableTurns([ - { id: "x", role: "narrator", content: "once upon a time" }, + { id: "m1", role: "user", content: null }, ]); + expect(messages).toEqual([]); expect(unreadable).toBe(1); }); - test("order is the stored order, so a dropped turn does not reshuffle the rest", () => { - const { messages } = readableTurns([ - assistantTurn, - { id: "bad", role: "assistant", toolCalls: [{ id: "c", name: "n" }] }, - userTurn, - ]); - expect(messages.map((message) => message.id)).toEqual(["m2", "m1"]); - }); + test("content that is a list of parts survives", () => { + const content = [{ type: "text", text: "What is in this?" }]; - test("a turn that parses keeps the fields the schema does not name", () => { - /* - * The reason the original object is returned rather than `parsed.data`. Zod strips unknown keys, - * so handing back the parsed copy would make this a silent rewrite of every message that passed - * — dropping whatever the runtime carries that this file has not heard of. - */ - const carrying = { ...userTurn, somethingTheRuntimeAdded: "keep me" }; - const { messages } = readableTurns([carrying]); - expect( - (messages[0] as unknown as { somethingTheRuntimeAdded?: string }) - .somethingTheRuntimeAdded, - ).toBe("keep me"); - }); + const { messages, unreadable } = readableTurns([ + { id: "m1", role: "user", content }, + ]); - test("an empty history is not a failure", () => { - expect(readableTurns([])).toEqual({ messages: [], unreadable: 0 }); + expect(messages).toHaveLength(1); + expect(unreadable).toBe(0); }); - test("a thread where nothing parses reports every turn", () => { - // The case that must not read as "this conversation is empty": the transcript has nothing to - // draw, so the count is the only thing that tells the person their history is still there. - const { messages, unreadable } = readableTurns([{ nope: true }, 1, null]); - expect(messages).toEqual([]); - expect(unreadable).toBe(3); + test("the order of the conversation is the order it came in", () => { + const read = readableTurns([ + { id: "m1", role: "user", content: "one" }, + { + id: "m2", + role: "assistant", + toolCalls: [ + { id: "c1", name: "computer_navigate", args: { url: "u" } }, + ], + }, + { id: "m3", role: "assistant", content: "three" }, + ]).messages as Array<Record<string, unknown>>; + + expect(read.map((m) => m.role)).toEqual(["user", "assistant", "assistant"]); + expect(read[0]?.content).toBe("one"); + expect(read[2]?.content).toBe("three"); }); }); diff --git a/charts/openbot/.helmignore b/charts/openbot/.helmignore new file mode 100644 index 00000000..8eb5223f --- /dev/null +++ b/charts/openbot/.helmignore @@ -0,0 +1,5 @@ +.DS_Store +.git/ +.gitignore +*.tmproj +ci/ diff --git a/charts/openbot/Chart.lock b/charts/openbot/Chart.lock new file mode 100644 index 00000000..0b0c959b --- /dev/null +++ b/charts/openbot/Chart.lock @@ -0,0 +1,6 @@ +dependencies: +- name: postgresql + repository: oci://registry-1.docker.io/bitnamicharts + version: 16.7.27 +digest: sha256:6fbb2d72eeffa5642d7158c0c7aaad596851e65272e3dc3411ce74c6f580b8e1 +generated: "2026-08-25T12:55:25.336493-07:00" diff --git a/charts/openbot/Chart.yaml b/charts/openbot/Chart.yaml new file mode 100644 index 00000000..b6e4f3d8 --- /dev/null +++ b/charts/openbot/Chart.yaml @@ -0,0 +1,31 @@ +apiVersion: v2 +name: openbot +description: Run OpenBot on any Kubernetes cluster, managed or your own +type: application +# The chart's own version, bumped when templates or defaults change. +version: 0.1.0 +# The OpenBot release this chart's default image tag points at. +appVersion: "0.0.4" +home: https://github.com/CopilotKit/OpenBot +sources: + - https://github.com/CopilotKit/OpenBot +keywords: + - openbot + - copilotkit + - agents +maintainers: + - name: CopilotKit + url: https://github.com/CopilotKit +dependencies: + # BUNDLED FOR SOMEBODY TRYING IT, OFF FOR ANYBODY WITH A DATABASE. A deployment with RDS, Cloud SQL + # or Azure Database sets `postgresql.enabled: false` and a connection URL, which is the same line + # the Intelligence chart draws, so somebody who has deployed that does not have to relearn it. + - name: postgresql + # EXACT, NOT A RANGE. `~16` let a subchart patch arrive on its own, and a subchart patch carries a + # new PostgreSQL image tag. That image comes from Bitnami's frozen `bitnamilegacy` mirror, which + # is not gaining new tags, so the next patch is one an install cannot pull. CI renders this chart + # and never pulls from it, so nothing here would have said a word: the first sign would have been + # somebody's install sitting in ImagePullBackOff. Bump it deliberately, with the tag below. + version: "16.7.27" + repository: "oci://registry-1.docker.io/bitnamicharts" + condition: postgresql.enabled diff --git a/charts/openbot/README.md b/charts/openbot/README.md new file mode 100644 index 00000000..e783de07 --- /dev/null +++ b/charts/openbot/README.md @@ -0,0 +1,225 @@ +# OpenBot on Kubernetes + +Runs OpenBot on any Kubernetes cluster: EKS, GKE, AKS, or your own. One chart, four targets, and the +only difference between them is values. + +## Install + +The bundled database and one administrator, which is the shortest thing that works: + +```sh +helm dependency build charts/openbot +helm upgrade --install openbot charts/openbot \ + --namespace openbot --create-namespace \ + --set postgresql.enabled=true \ + --set config.initialAdminEmails=you@example.com \ + --set-string secrets.keyEncryptionKey="$(openssl rand -base64 32)" +``` + +`secrets.keyEncryptionKey` encrypts the credential vault. Generate it once, keep it, and do not put +it in a file anybody commits. The chart marks the Secret it creates `helm.sh/resource-policy: keep`, +so an uninstall does not take the key that every stored credential was encrypted with. + +## What the defaults assume + +**A plain cluster with no cloud features.** The cluster's own default StorageClass, no RuntimeClass, +a plain Kubernetes Secret, an Ingress. There is no cloud branching anywhere in the templates and +there should never be. A deployment on a managed cluster turns things on; a self-hosted one changes +nothing and still works. + +Two replicas by default, because horizontal is the point. Everything that has to survive a replica is +in PostgreSQL, and one replica hides every bug that is not. + +**No browser in the API pod.** The image runs a Bot's computer beside the API so that one container +works on its own. A replica must not carry one: a browser is a few hundred megabytes holding one +Bot's logins, so scaling the API would scale those with it. `server.embeddedComputer` is off here, +and asking for it with more than one replica is refused at install time. + +## Your own database, which is what a real deployment uses + +```sh +--set postgresql.enabled=false \ +--set database.existingSecret=openbot-database # key: database-url +``` + +`postgresql.enabled` is **off by default and not production-grade**. A database on a pod goes away +when the pod does: a rollout, a node drain or an eviction is a restart, and while the volume survives, +nothing about that shape gives you backups, failover or point-in-time recovery. It is there so +somebody can try OpenBot in one command. + +Point it at RDS, Cloud SQL, Azure Database or your own server, and keep the URL in a Secret rather +than in a values file. Setting both a bundled database and a URL is refused, rather than one of them +silently winning. + +**Put `?sslmode=require` on the URL.** Every managed database refuses an unencrypted connection: +RDS has `rds.force_ssl` on by default, and Cloud SQL and Azure Database do the same. Without it the +migration fails with `no pg_hba.conf entry for host ... no encryption`, which names the host and the +user and not the actual problem. + +**The migrating role has to be able to create and drop the `vector` extension.** The first migration +creates it and a later one drops it again. On a managed database, create it once as the +administrative role; `CREATE EXTENSION IF NOT EXISTS` then passes for an ordinary user. + +## The four targets + +`ci/` holds a values file per target, and each is the shortest thing that expresses what is different +about that cluster: + +| File | What it shows | +| --- | --- | +| `self-hosted-values.yaml` | Nothing turned on. If this file needs to grow, a default is wrong. | +| `eks-values.yaml` | IRSA, Secrets Manager, ALB, zone spread, autoscaling. | +| `gke-values.yaml` | Workload Identity, Secret Manager, Gateway API instead of an Ingress. | +| `aks-values.yaml` | Workload identity, Key Vault, the AKS web app routing class. | + +Render any of them without a cluster: + +```sh +helm template openbot charts/openbot -f charts/openbot/ci/eks-values.yaml +``` + +### Identity, in one map + +IRSA on EKS, Workload Identity on GKE and workload identity on AKS are all annotations on a +ServiceAccount, so `serviceAccount.annotations` covers all three and the chart needs no idea which +cloud it is on. + +### Secrets, without a vendor + +A plain Kubernetes Secret is the default, because that is what a self-hosted cluster has. Setting +`externalSecrets.enabled` turns the same keys into an ExternalSecret against whatever store the +cluster has, so Secrets Manager, Secret Manager and Key Vault are a values block rather than three +code paths. + +### Check for a default StorageClass first + +A fresh EKS cluster very often has none. `eksctl` creates `gp2`, which is not marked default and uses +the in-tree `kubernetes.io/aws-ebs` provisioner that current Kubernetes no longer has. A volume asking +for "the default" then never binds, the computer sits `Pending`, and nothing says why. One line tells +you: + +```sh +kubectl get sc +``` + +Either create a default class backed by `ebs.csi.aws.com`, or set `computers.persistence.storageClass` +and `postgresql.primary.persistence.storageClass` to one that exists. `ci/eks-values.yaml` does the +second. + +`volumeBindingMode: WaitForFirstConsumer` matters on every cloud: without it the volume is created in +a zone chosen before the pod is scheduled, and pods stick unschedulable with a node-affinity conflict. +That only happens in multi-zone clusters, so it passes every single-zone test. + +### Storage has gravity + +The API tier holds nothing on disk. When per-Bot computers arrive they will, and the ordinary block +volume on all three clouds is **zonal**: once provisioned, every pod referencing it is scheduled into +that zone, so a Bot's computer is pinned to a zone for as long as its profile exists. That is +acceptable and worth stating rather than discovering. `storageClass` stays empty by default, meaning +the cluster's default class, because naming `gp3` or `pd-balanced` here is how a chart stops +installing on somebody's bare-metal cluster. + +## Refused at install, not in a crash loop + +The chart fails the install, naming the value to change, when: there is no database or two of them; +nobody would be an administrator; `singleUser` is combined with a public URL; both an Ingress and an +HTTPRoute are enabled; both `externalSecrets` and an existing Secret are named; a Bot endpoint is +named with no token to call it with; or a browser is asked for inside more than one API replica. + +## Your own Bot + +OpenBot is a shell for somebody else's agent, and `config.managedAgent.url` is where that agent goes: +an AG-UI endpoint the server pod can reach, so a Service in this cluster rather than localhost. + +```yaml +config: + managedAgent: + url: http://my-agent.my-namespace:8000/ag-ui +secrets: + managedAgentToken: <a long random value> +``` + +The token travels on every call and is required whenever a url is set. With an existing Secret or an +external store, the key is `managed-agent-token`. + +Left empty, this deployment has the Bots its tenant package declares as built-in and no others. A +package entry pointing at an endpoint that resolves to nothing is dropped rather than registered as a +coworker nobody can talk to. + +## Upgrading the server without the computers + +`computers.mode: shared` runs one browser for every Bot, and on that shape the transcript's kept +screenshots need the computer image to be as new as the server's. A screenshot only says which page +it is of on a computer built after that field was added, and on a shared browser a picture that +cannot be told apart from another Bot's is refused rather than filed under the wrong turn. The +conversation still names the page it opened; it just does not show it, and the server log says why +each time. + +With `computers.mode: sandbox` or `external`, each Bot has a computer of its own, there is nobody to +race with, and this does not arise. + +## A computer for each Bot + +`computers.mode` decides how a Bot gets a browser: + +| Mode | What it does | Needs | +| --- | --- | --- | +| `shared` | One browser for every Bot, run by this chart. | Nothing. | +| `sandbox` | A computer each, suspended when idle and resumed with its logins intact. | The `agent-sandbox` controller in the cluster. | +| `external` | Neither; `computers.url` points at one somebody else runs. | Nothing. | + +`shared` is what a first install should use. Sessions, files and logins are shared between Bots in +that mode, which is stated on the fleet page rather than hidden. + +`sandbox` uses `kubernetes-sigs/agent-sandbox`, whose `Sandbox` CRD is built for exactly this +workload: an isolated, stateful, singleton pod with a stable identity and persistent storage. +Suspending is `operatingMode: Suspended`, which terminates the pod and keeps the volumes. + +**That controller is not installed by this chart, and the chart refuses to install without it.** +The check reads the cluster, so it is a real answer rather than a value somebody has to remember: + +```sh +kubectl apply --server-side -f \ + https://github.com/kubernetes-sigs/agent-sandbox/releases/download/v0.5.6/sandbox-with-extensions.yaml +``` + +Without that refusal the install succeeds, every pod is healthy, and the deployment looks finished +until the first Bot asks for a browser and the API server answers 404. Rendering offline? Pass +`--api-versions agents.x-k8s.io/v1beta1/Sandbox`. + +**What decides that a computer is idle** is the audit trail, not the browser. Asking the browser +would wake it, so every computer anything asked about would come back up and the bill would never +fall. That is the known, invisible way to lose scale-to-zero: everything works, nothing suspends. + +**A CronJob does the suspending, not a timer in the API.** Every replica would fire its own timer and +each would decide independently to suspend the same computer. The work is claimed and leased out of +PostgreSQL with `select ... for update skip locked`, so whichever pod runs the sweep takes what +nobody else holds, and one that dies mid-suspend hands its work back when the lease expires. The +decision is re-checked at the moment of acting, because somebody may have come back in between. + +## NetworkPolicy, and whether your cluster enforces one + +Off by default, because a NetworkPolicy on a cluster whose CNI does not enforce one is a resource +that silently does nothing, and on a cluster that does enforce one a wrong rule is an outage. + +**On EKS it does nothing unless you turn it on.** The VPC CNI ships with +`--enable-network-policy=false`, so the policy installs, looks right, and is never applied. Check +before trusting it: + +```sh +kubectl -n kube-system get ds aws-node -o yaml | grep enable-network-policy +``` + +The egress rules allow DNS, a Bot's computer on 4100, the API server when computers are Sandboxes, +and the bundled database. **A managed database is an address this chart cannot know**, so turning +the policy on with an external database and no `networkPolicy.extraEgress` is refused: on an +enforcing cluster it would fence the API off from its own database, which reads as the database +being down. + +## Upgrades + +Migrations run as a `pre-install,pre-upgrade` Job, so no replica ever serves in front of a schema it +has not seen. An init container would mean every replica racing to migrate the same database. + +Use `helm upgrade --install --atomic` so a failed upgrade rolls back rather than leaving half a +rollout. diff --git a/charts/openbot/ci/aks-values.yaml b/charts/openbot/ci/aks-values.yaml new file mode 100644 index 00000000..de50c308 --- /dev/null +++ b/charts/openbot/ci/aks-values.yaml @@ -0,0 +1,56 @@ +# AKS. Azure Database, workload identity, Key Vault through external-secrets. +config: + initialAdminEmails: admin@example.com + intelligence: + apiUrl: https://api.cloud.copilotkit.ai + gatewayWsUrl: wss://gateway.cloud.copilotkit.ai + auth: + google: + clientId: example.apps.googleusercontent.com + publicUrl: https://openbot.example.com +postgresql: + enabled: false +database: + existingSecret: openbot-database +serviceAccount: + annotations: + azure.workload.identity/client-id: 00000000-0000-0000-0000-000000000000 +server: + podLabels: + azure.workload.identity/use: "true" +externalSecrets: + enabled: true + secretStoreRef: + name: azure-key-vault + data: + - secretKey: key-encryption-key + remoteRef: + key: openbot-key-encryption-key + # Sessions are signed with this. The server refuses to start when sign-in is configured and it + # is missing, so every provider store has to carry it. + - secretKey: better-auth-secret + remoteRef: + key: openbot-better-auth-secret + - secretKey: intelligence-api-key + remoteRef: + key: openbot-intelligence-api-key + - secretKey: google-client-secret + remoteRef: + key: openbot/google-client-secret + - secretKey: computer-token + remoteRef: + key: openbot/computer-token + - secretKey: license-token + remoteRef: + key: openbot-license-token +ingress: + enabled: true + className: webapprouting.kubernetes.azure.com + hosts: + - host: openbot.example.com + paths: + - path: / + pathType: Prefix + +computers: + mode: shared diff --git a/charts/openbot/ci/eks-sandbox-values.yaml b/charts/openbot/ci/eks-sandbox-values.yaml new file mode 100644 index 00000000..2a7335a1 --- /dev/null +++ b/charts/openbot/ci/eks-sandbox-values.yaml @@ -0,0 +1,106 @@ +# EKS, with a computer each rather than one shared browser. +# +# Needs the agent-sandbox controller installed; CI renders it with --api-versions instead. +# +# CHECK THE CLUSTER HAS A DEFAULT STORAGECLASS BEFORE INSTALLING, because a fresh EKS cluster very +# often does not. `eksctl` creates `gp2`, which is not marked default and uses the in-tree +# `kubernetes.io/aws-ebs` provisioner that no longer exists in current Kubernetes. A volume asking +# for "the default" then never binds, the computer sits Pending, and nothing says why. Verified on a +# real 1.34 cluster; `kubectl get sc` shows it in one line. +# +# Either create a default class: +# +# provisioner: ebs.csi.aws.com, volumeBindingMode: WaitForFirstConsumer, +# annotated storageclass.kubernetes.io/is-default-class: "true" +# +# or name one here, which is what the line below does. `WaitForFirstConsumer` is not optional on any +# cloud: without it the volume is created in a zone picked before the pod is scheduled, and pods stick +# unschedulable with a node-affinity conflict, in multi-zone clusters only, so it passes every +# single-zone test. +config: + initialAdminEmails: admin@example.com + intelligence: + apiUrl: https://api.cloud.copilotkit.ai + gatewayWsUrl: wss://gateway.cloud.copilotkit.ai + auth: + google: + clientId: example.apps.googleusercontent.com + publicUrl: https://openbot.example.com +postgresql: + enabled: false +database: + existingSecret: openbot-database +serviceAccount: + annotations: + eks.amazonaws.com/role-arn: arn:aws:iam::000000000000:role/openbot +externalSecrets: + enabled: true + secretStoreRef: + name: aws-secrets-manager + data: + - secretKey: key-encryption-key + remoteRef: + key: openbot/key-encryption-key + # Sessions are signed with this. The server refuses to start when sign-in is configured and it + # is missing, so every provider store has to carry it. + - secretKey: better-auth-secret + remoteRef: + key: openbot-better-auth-secret + - secretKey: intelligence-api-key + remoteRef: + key: openbot/intelligence-api-key + - secretKey: google-client-secret + remoteRef: + key: openbot/google-client-secret + - secretKey: computer-token + remoteRef: + key: openbot/computer-token + - secretKey: license-token + remoteRef: + key: openbot/license-token +ingress: + enabled: true + className: alb + annotations: + alb.ingress.kubernetes.io/scheme: internet-facing + alb.ingress.kubernetes.io/target-type: ip +server: + autoscaling: + enabled: true + minReplicas: 2 + maxReplicas: 10 + topologySpreadConstraints: + - maxSkew: 1 + topologyKey: topology.kubernetes.io/zone + whenUnsatisfiable: ScheduleAnyway + labelSelector: + matchLabels: + app.kubernetes.io/name: openbot + app.kubernetes.io/component: server + +computers: + # A computer each, which is the mode the rest of this chart exists for and the one nothing rendered + # until now. `shared` and `sandbox` produce different Deployments, different RBAC and a different + # pod template, so a target that only ever renders one of them checks half the chart. + mode: sandbox + persistence: + # Named here rather than in the chart, which is the whole point of a per-target values file: the + # chart must not name `gp3`, and a deployment on EKS should. + storageClass: gp3 + +# On, so these render in CI at all. They were written, reviewed and shipped without a single target +# producing one, which means nothing had ever checked they were valid YAML, let alone right. Off is +# still the chart's default: a policy on a cluster whose CNI ignores it does nothing, and on one that +# enforces it a wrong rule is an outage, so turning it on stays a deployment's decision. +networkPolicy: + enabled: true + # This target's database is RDS rather than a pod, so egress to it has to be named. The chart + # refuses to render without this, which is how the omission was found: rendering the policies in CI + # at all is what exercised the refusal. + extraEgress: + - to: + - ipBlock: + cidr: 10.0.0.0/16 + ports: + - port: 5432 + protocol: TCP diff --git a/charts/openbot/ci/eks-values.yaml b/charts/openbot/ci/eks-values.yaml new file mode 100644 index 00000000..737a3c60 --- /dev/null +++ b/charts/openbot/ci/eks-values.yaml @@ -0,0 +1,84 @@ +# EKS. RDS for the database, IRSA for identity, Secrets Manager through external-secrets. +# +# CHECK THE CLUSTER HAS A DEFAULT STORAGECLASS BEFORE INSTALLING, because a fresh EKS cluster very +# often does not. `eksctl` creates `gp2`, which is not marked default and uses the in-tree +# `kubernetes.io/aws-ebs` provisioner that no longer exists in current Kubernetes. A volume asking +# for "the default" then never binds, the computer sits Pending, and nothing says why. Verified on a +# real 1.34 cluster; `kubectl get sc` shows it in one line. +# +# Either create a default class: +# +# provisioner: ebs.csi.aws.com, volumeBindingMode: WaitForFirstConsumer, +# annotated storageclass.kubernetes.io/is-default-class: "true" +# +# or name one here, which is what the line below does. `WaitForFirstConsumer` is not optional on any +# cloud: without it the volume is created in a zone picked before the pod is scheduled, and pods stick +# unschedulable with a node-affinity conflict, in multi-zone clusters only, so it passes every +# single-zone test. +config: + initialAdminEmails: admin@example.com + intelligence: + apiUrl: https://api.cloud.copilotkit.ai + gatewayWsUrl: wss://gateway.cloud.copilotkit.ai + auth: + google: + clientId: example.apps.googleusercontent.com + publicUrl: https://openbot.example.com +postgresql: + enabled: false +database: + existingSecret: openbot-database +serviceAccount: + annotations: + eks.amazonaws.com/role-arn: arn:aws:iam::000000000000:role/openbot +externalSecrets: + enabled: true + secretStoreRef: + name: aws-secrets-manager + data: + - secretKey: key-encryption-key + remoteRef: + key: openbot/key-encryption-key + # Sessions are signed with this. The server refuses to start when sign-in is configured and it + # is missing, so every provider store has to carry it. + - secretKey: better-auth-secret + remoteRef: + key: openbot-better-auth-secret + - secretKey: intelligence-api-key + remoteRef: + key: openbot/intelligence-api-key + - secretKey: google-client-secret + remoteRef: + key: openbot/google-client-secret + - secretKey: computer-token + remoteRef: + key: openbot/computer-token + - secretKey: license-token + remoteRef: + key: openbot/license-token +ingress: + enabled: true + className: alb + annotations: + alb.ingress.kubernetes.io/scheme: internet-facing + alb.ingress.kubernetes.io/target-type: ip +server: + autoscaling: + enabled: true + minReplicas: 2 + maxReplicas: 10 + topologySpreadConstraints: + - maxSkew: 1 + topologyKey: topology.kubernetes.io/zone + whenUnsatisfiable: ScheduleAnyway + labelSelector: + matchLabels: + app.kubernetes.io/name: openbot + app.kubernetes.io/component: server + +computers: + mode: shared + persistence: + # Named here rather than in the chart, which is the whole point of a per-target values file: the + # chart must not name `gp3`, and a deployment on EKS should. + storageClass: gp3 diff --git a/charts/openbot/ci/gke-values.yaml b/charts/openbot/ci/gke-values.yaml new file mode 100644 index 00000000..b2531e0e --- /dev/null +++ b/charts/openbot/ci/gke-values.yaml @@ -0,0 +1,55 @@ +# GKE. Cloud SQL, Workload Identity, Secret Manager through external-secrets, Gateway API. +config: + initialAdminEmails: admin@example.com + intelligence: + apiUrl: https://api.cloud.copilotkit.ai + gatewayWsUrl: wss://gateway.cloud.copilotkit.ai + auth: + google: + clientId: example.apps.googleusercontent.com + publicUrl: https://openbot.example.com +postgresql: + enabled: false +database: + existingSecret: openbot-database +serviceAccount: + annotations: + iam.gke.io/gcp-service-account: openbot@example-project.iam.gserviceaccount.com +externalSecrets: + enabled: true + secretStoreRef: + name: gcp-secret-manager + data: + - secretKey: key-encryption-key + remoteRef: + key: openbot-key-encryption-key + # Sessions are signed with this. The server refuses to start when sign-in is configured and it + # is missing, so every provider store has to carry it. + - secretKey: better-auth-secret + remoteRef: + key: openbot-better-auth-secret + - secretKey: intelligence-api-key + remoteRef: + key: openbot-intelligence-api-key + - secretKey: google-client-secret + remoteRef: + key: openbot/google-client-secret + - secretKey: computer-token + remoteRef: + key: openbot/computer-token + - secretKey: license-token + remoteRef: + key: openbot-license-token +# Gateway API rather than an Ingress, which the same chart supports without a second code path. +ingress: + enabled: false +httpRoute: + enabled: true + parentRefs: + - name: openbot-gateway + namespace: gateway-system + hostnames: + - openbot.example.com + +computers: + mode: shared diff --git a/charts/openbot/ci/self-hosted-values.yaml b/charts/openbot/ci/self-hosted-values.yaml new file mode 100644 index 00000000..b4f7ea8f --- /dev/null +++ b/charts/openbot/ci/self-hosted-values.yaml @@ -0,0 +1,48 @@ +# Somebody's own cluster, which is the shape every default is written for. +# +# Nothing here turns a cloud feature on, because there are none to turn on: the cluster's default +# StorageClass, a plain Secret, the bundled database, an Ingress. If this file needs to grow, a +# default is wrong. +config: + initialAdminEmails: admin@example.com + intelligence: + apiUrl: https://api.cloud.copilotkit.ai + gatewayWsUrl: wss://gateway.cloud.copilotkit.ai + auth: + google: + clientId: example.apps.googleusercontent.com + publicUrl: https://openbot.internal +postgresql: + enabled: true + auth: + # Yours to choose, and the same value on every upgrade. Rendering example only. + password: "example-for-rendering-only" +secrets: + # Sessions are signed with this. Rendering example only; generate one with: openssl rand -base64 32 + betterAuthSecret: "example-for-rendering-only-at-least-32-chars" + # NOT SET HERE, AND THAT IS THE POINT. This file used to carry the public example key from + # `.env.example`, which the server refuses to start with in production: the target rendered, and + # the deployment it described could never run. Supply a real one: + # --set-string secrets.keyEncryptionKey="$(openssl rand -base64 32)" + intelligenceApiKey: "example-for-rendering-only" + googleClientSecret: "example-for-rendering-only" + computerToken: "example-for-rendering-only" + licenseToken: "example-for-rendering-only" +ingress: + enabled: true + className: nginx + hosts: + - host: openbot.internal + paths: + - path: / + pathType: Prefix + +computers: + mode: shared + +# On, so these render in CI at all. They were written, reviewed and shipped without a single target +# producing one, which means nothing had ever checked they were valid YAML, let alone right. Off is +# still the chart's default: a policy on a cluster whose CNI ignores it does nothing, and on one that +# enforces it a wrong rule is an outage, so turning it on stays a deployment's decision. +networkPolicy: + enabled: true diff --git a/charts/openbot/templates/_helpers.tpl b/charts/openbot/templates/_helpers.tpl new file mode 100644 index 00000000..14d96645 --- /dev/null +++ b/charts/openbot/templates/_helpers.tpl @@ -0,0 +1,387 @@ +{{/* +Shared shapes, so a component template says what is different about it and nothing else. + +Anything defined here is used by more than one component, or is a decision worth making in exactly +one place. A helper used once belongs in the template that uses it. +*/}} + +{{- define "openbot.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{- define "openbot.fullname" -}} +{{- if .Values.fullnameOverride -}} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- $name := default .Chart.Name .Values.nameOverride -}} +{{- if contains $name .Release.Name -}} +{{- .Release.Name | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} +{{- end -}} +{{- end -}} +{{- end -}} + +{{- define "openbot.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{- define "openbot.labels" -}} +helm.sh/chart: {{ include "openbot.chart" . }} +{{ include "openbot.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- with .Values.commonLabels }} +{{ toYaml . }} +{{- end }} +{{- end -}} + +{{- define "openbot.selectorLabels" -}} +app.kubernetes.io/name: {{ include "openbot.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end -}} + +{{/* Labels for one component, so two workloads in one release never select each other's pods. */}} +{{- define "openbot.componentLabels" -}} +{{ include "openbot.labels" .root }} +app.kubernetes.io/component: {{ .component }} +{{- end -}} + +{{- define "openbot.componentSelectorLabels" -}} +{{ include "openbot.selectorLabels" .root }} +app.kubernetes.io/component: {{ .component }} +{{- end -}} + +{{- define "openbot.componentName" -}} +{{- printf "%s-%s" (include "openbot.fullname" .root) .component | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{- define "openbot.serviceAccountName" -}} +{{- if .Values.serviceAccount.create -}} +{{- default (include "openbot.fullname" .) .Values.serviceAccount.name -}} +{{- else -}} +{{- default "default" .Values.serviceAccount.name -}} +{{- end -}} +{{- end -}} + +{{/* The image, with the chart's appVersion as the tag unless one is named. */}} +{{- define "openbot.image" -}} +{{- $tag := default .Chart.AppVersion .Values.image.tag -}} +{{- printf "%s:%s" .Values.image.repository $tag -}} +{{- end -}} + +{{- define "openbot.secretName" -}} +{{- default (printf "%s-secrets" (include "openbot.fullname" .)) .Values.secrets.existingSecret -}} +{{- end -}} + +{{- define "openbot.configMapName" -}} +{{- printf "%s-config" (include "openbot.fullname" .) -}} +{{- end -}} + +{{/* +Where the database is. + +One definition, because the migrations Job and the API must never disagree about it: a Job that +migrated one database while the API talked to another is a failure that looks like a missing table. +*/}} +{{- define "openbot.databaseUrlEnv" -}} +{{- if .Values.postgresql.enabled -}} +{{- /* + THE PASSWORD IS DECLARED FIRST, AND THAT IS NOT A STYLE CHOICE. + + Kubernetes expands `$(VAR)` in an env value only from variables defined earlier in the same list. + Declared after, the reference is left as the literal text `$(POSTGRES_PASSWORD)` and handed to the + server as the password, which fails authentication with `28P01` and reads exactly like a wrong + password rather than like a template that did not expand. +*/}} +- name: POSTGRES_PASSWORD + valueFrom: + secretKeyRef: + name: {{ default (printf "%s-postgresql" .Release.Name) .Values.postgresql.auth.existingSecret }} + {{- /* The subchart keeps the superuser's password under its own key, not `password`. */}} + key: {{ eq .Values.postgresql.auth.username "postgres" | ternary "postgres-password" "password" }} +- name: DATABASE_URL + value: postgres://{{ .Values.postgresql.auth.username }}:$(POSTGRES_PASSWORD)@{{ .Release.Name }}-postgresql:5432/{{ .Values.postgresql.auth.database }} +{{- else if .Values.database.existingSecret -}} +- name: DATABASE_URL + valueFrom: + secretKeyRef: + name: {{ .Values.database.existingSecret }} + key: {{ .Values.database.existingSecretKey }} +{{- else -}} +- name: DATABASE_URL + value: {{ .Values.database.url | quote }} +{{- end -}} +{{- end -}} + +{{/* +Everything the API reads that is not the database. + +Secrets are referenced, never rendered: a value that appears here would appear in `helm get values` +and in whatever holds the release, which is not where `KEY_ENCRYPTION_KEY` belongs. +*/}} +{{- define "openbot.commonEnv" -}} +- name: PORT + value: {{ .Values.server.service.port | quote }} +- name: NODE_ENV + value: production +- name: EMBEDDED_POSTGRES + value: "off" +{{- /* The switch that makes a replica a replica: no browser in an API pod. */}} +- name: EMBEDDED_COMPUTER + value: {{ ternary "on" "off" .Values.server.embeddedComputer | quote }} +- name: TENANT_PACKAGE_DIR + value: {{ .Values.config.tenantPackageDir | quote }} +{{- if .Values.config.publicUrl }} +- name: OPENBOT_PUBLIC_URL + value: {{ .Values.config.publicUrl | quote }} +- name: BETTER_AUTH_URL + value: {{ .Values.config.publicUrl | quote }} +{{- end }} +{{- if .Values.config.initialAdminEmails }} +- name: INITIAL_ADMIN_EMAILS + value: {{ .Values.config.initialAdminEmails | quote }} +{{- end }} +{{- if .Values.config.singleUser }} +- name: OPENBOT_SINGLE_USER + value: "true" +{{- end }} +{{- if .Values.config.logLevel }} +- name: LOG_LEVEL + value: {{ .Values.config.logLevel | quote }} +{{- end }} +{{- /* + Where this deployment's Bots find a computer, decided by the mode rather than by the operator. + + `shared` addresses the StatefulSet's one pod by its stable name, which is what a headless Service + gives it. `external` takes the URL as written. `sandbox` sets neither: the provider asks the + cluster for each Bot's own computer and gets an address back, so a fixed URL would be the one + thing that could send every Bot to the same browser. +*/}} +{{- if eq .Values.computers.mode "shared" }} +- name: AGENT_COMPUTER_URL + value: http://{{ include "openbot.componentName" (dict "root" . "component" "computer") }}-0.{{ include "openbot.componentName" (dict "root" . "component" "computer") }}:4100 +{{- else if and (eq .Values.computers.mode "external") .Values.computers.url }} +- name: AGENT_COMPUTER_URL + value: {{ .Values.computers.url | quote }} +{{- else if eq .Values.computers.mode "sandbox" }} +- name: COMPUTER_SANDBOX_NAMESPACE + value: {{ default .Release.Namespace .Values.computers.sandbox.namespace | quote }} +- name: COMPUTER_SANDBOX_IDLE_AFTER + value: {{ .Values.computers.sandbox.idleAfter | quote }} +- name: COMPUTER_SANDBOX_TEMPLATE_FILE + value: /etc/openbot/sandbox-template.json +{{- end }} +- name: INTELLIGENCE_API_URL + value: {{ .Values.config.intelligence.apiUrl | quote }} +- name: INTELLIGENCE_GATEWAY_WS_URL + value: {{ .Values.config.intelligence.gatewayWsUrl | quote }} +- name: INTELLIGENCE_API_KEY + valueFrom: + secretKeyRef: + name: {{ include "openbot.secretName" . }} + key: intelligence-api-key +- name: COPILOTKIT_LICENSE_TOKEN + valueFrom: + secretKeyRef: + name: {{ include "openbot.secretName" . }} + key: license-token +{{- with .Values.config.managedAgent.url }} +- name: MANAGED_AGENT_AG_UI_URL + value: {{ . | quote }} +- name: MANAGED_AGENT_TOKEN + valueFrom: + secretKeyRef: + name: {{ include "openbot.secretName" $ }} + key: managed-agent-token +{{- end }} +{{- with .Values.config.auth.google.clientId }} +- name: GOOGLE_OAUTH_CLIENT_ID + value: {{ . | quote }} +- name: GOOGLE_OAUTH_CLIENT_SECRET + valueFrom: + secretKeyRef: + name: {{ include "openbot.secretName" $ }} + key: google-client-secret +{{- end }} +{{- with .Values.config.auth.microsoft.clientId }} +- name: MICROSOFT_OAUTH_CLIENT_ID + value: {{ . | quote }} +- name: MICROSOFT_OAUTH_CLIENT_SECRET + valueFrom: + secretKeyRef: + name: {{ include "openbot.secretName" $ }} + key: microsoft-client-secret +{{- end }} +{{- with .Values.config.auth.microsoft.tenantId }} +- name: MICROSOFT_OAUTH_TENANT_ID + value: {{ . | quote }} +{{- end }} +{{- with .Values.config.auth.okta.clientId }} +- name: OKTA_OAUTH_CLIENT_ID + value: {{ . | quote }} +- name: OKTA_OAUTH_CLIENT_SECRET + valueFrom: + secretKeyRef: + name: {{ include "openbot.secretName" $ }} + key: okta-client-secret +{{- end }} +{{- with .Values.config.auth.okta.issuer }} +- name: OKTA_OAUTH_ISSUER + value: {{ . | quote }} +{{- end }} +- name: KEY_ENCRYPTION_KEY + valueFrom: + secretKeyRef: + name: {{ include "openbot.secretName" . }} + key: key-encryption-key +{{- /* + Optional only while it genuinely is. + + With no identity provider there is no sign-in and nothing to sign, so an absent key is correct. + With one configured the server refuses to start without it, and `optional: true` turned that into a + crash loop rather than a container that says which key is missing. It also hid the whole path from + the render check, which skips optional keys: a deployment supplying its own Secret without this in + it rendered clean and then never came up. +*/}} +- name: BETTER_AUTH_SECRET + valueFrom: + secretKeyRef: + name: {{ include "openbot.secretName" . }} + key: better-auth-secret + optional: {{ not (or .Values.config.auth.google.clientId .Values.config.auth.microsoft.clientId .Values.config.auth.okta.clientId) }} +- name: OPENAI_API_KEY + valueFrom: + secretKeyRef: + name: {{ include "openbot.secretName" . }} + key: model-api-key + optional: true +- name: COMPUTER_TOKEN + valueFrom: + secretKeyRef: + name: {{ default (include "openbot.secretName" .) .Values.computers.existingTokenSecret }} + key: computer-token + optional: {{ eq .Values.computers.mode "external" }} +{{- with .Values.config.extraEnv }} +{{ toYaml . }} +{{- end }} +{{- end -}} + +{{/* +Keeping replicas apart. + +Soft by default, so a one-node cluster still schedules. A deployment that means it sets +`podAntiAffinity: hard` and gets a replica per node, or writes its own `affinity` and gets neither. +*/}} +{{- define "openbot.podAntiAffinity" -}} +{{- $root := .root -}} +{{- $component := .component -}} +{{- if $root.Values.server.affinity -}} +{{ toYaml $root.Values.server.affinity }} +{{- else if eq (default "soft" $root.Values.server.podAntiAffinity) "hard" -}} +podAntiAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + - topologyKey: kubernetes.io/hostname + labelSelector: + matchLabels: +{{ include "openbot.componentSelectorLabels" (dict "root" $root "component" $component) | indent 10 }} +{{- else if eq (default "soft" $root.Values.server.podAntiAffinity) "soft" -}} +podAntiAffinity: + preferredDuringSchedulingIgnoredDuringExecution: + - weight: 100 + podAffinityTerm: + topologyKey: kubernetes.io/hostname + labelSelector: + matchLabels: +{{ include "openbot.componentSelectorLabels" (dict "root" $root "component" $component) | indent 12 }} +{{- end -}} +{{- end -}} + +{{/* +The pod and volumes every Bot's computer is cut from, as JSON. + +One definition, used by the ConfigMap the server reads and by the SandboxTemplate a warm pool cuts +from, so a pre-warmed computer and one created on demand cannot drift into being different things. + +NO CLUSTER CREDENTIAL. Every pod gets a service account token mounted unless it says otherwise, so +the container that opens pages a person named and runs commands a model chose was carrying one. It +could not do much with it, which is not the point: this is the last pod in the deployment that should +be able to address the API server at all, and the default is the wrong way round. +*/}} +{{- define "openbot.sandboxPodTemplate" -}} +{{- $spec := dict + "podTemplate" (dict + "metadata" (dict "labels" (dict + "app.kubernetes.io/name" (include "openbot.name" .) + "app.kubernetes.io/instance" .Release.Name + "app.kubernetes.io/component" "computer")) + "spec" (dict + "terminationGracePeriodSeconds" 30 + "automountServiceAccountToken" false + "containers" (list (dict + "name" "computer" + "image" (include "openbot.image" .) + "imagePullPolicy" .Values.image.pullPolicy + "command" (list "/usr/local/bin/bun" "/app/agent-computer/src/index.ts") + "ports" (list (dict "name" "http" "containerPort" 4100)) + "env" (concat + (list + (dict "name" "PORT" "value" "4100") + (dict "name" "WORKSPACE_DIR" "value" "/workspace") + (dict "name" "PROFILES_DIR" "value" "/profiles") + (dict "name" "COMPUTER_TOKEN" "valueFrom" (dict "secretKeyRef" (dict + "name" (default (include "openbot.secretName" .) .Values.computers.existingTokenSecret) + "key" "computer-token")))) + .Values.computers.extraEnv) + "volumeMounts" (list + (dict "name" "profiles" "mountPath" "/profiles") + (dict "name" "workspace" "mountPath" "/workspace")) + "readinessProbe" (dict + "httpGet" (dict "path" "/health" "port" "http") + "periodSeconds" 10 + "failureThreshold" 6) + "resources" .Values.computers.resources)))) -}} +{{- $pod := index $spec "podTemplate" -}} +{{- $podSpec := index $pod "spec" -}} +{{- with .Values.computers.runtimeClassName }}{{- $_ := set $podSpec "runtimeClassName" . }}{{- end }} +{{- with .Values.imagePullSecrets }}{{- $_ := set $podSpec "imagePullSecrets" . }}{{- end }} +{{- with .Values.computers.nodeSelector }}{{- $_ := set $podSpec "nodeSelector" . }}{{- end }} +{{- with .Values.computers.tolerations }}{{- $_ := set $podSpec "tolerations" . }}{{- end }} +{{- $claim := dict + "accessModes" (list "ReadWriteOnce") + "resources" (dict "requests" (dict "storage" .Values.computers.persistence.profilesSize)) -}} +{{- $work := dict + "accessModes" (list "ReadWriteOnce") + "resources" (dict "requests" (dict "storage" .Values.computers.persistence.workspaceSize)) -}} +{{- with .Values.computers.persistence.storageClass }} +{{- $_ := set $claim "storageClassName" . }}{{- $_ := set $work "storageClassName" . }} +{{- end }} +{{- /* + A Service, which is the whole reason a computer has a stable address. + + Without it the controller creates the pod and reports no `serviceFQDN`, so the sandbox is Ready and + unreachable: `locate` waits for an address that is never coming and times out. A pod IP would be + the wrong answer anyway, because it changes on every resume, which is exactly what a suspended + computer does. +*/}} +{{- $_ := set $spec "service" true -}} +{{- $_ := set $spec "volumeClaimTemplates" (list + (dict "metadata" (dict "name" "profiles") "spec" $claim) + (dict "metadata" (dict "name" "workspace") "spec" $work)) -}} +{{ toPrettyJson $spec }} +{{- end -}} + +{{/* +Whether the API pod gets a Kubernetes token. + +FALSE UNLESS IT ACTUALLY NEEDS ONE. The API talks to a database and to Bots, not to the cluster, so a +mounted token is a credential sitting in a pod that has no use for it. `computers.mode: sandbox` is +the exception and the only one: there the server asks the API server to create, resume and suspend a +Sandbox per Bot, and without a token it fails on the first browser action with a missing file rather +than anything that names the cause. +*/}} +{{- define "openbot.automountToken" -}} +{{- or .Values.serviceAccount.automountServiceAccountToken (eq .Values.computers.mode "sandbox") -}} +{{- end -}} diff --git a/charts/openbot/templates/computer/culler-cronjob.yaml b/charts/openbot/templates/computer/culler-cronjob.yaml new file mode 100644 index 00000000..40f469f6 --- /dev/null +++ b/charts/openbot/templates/computer/culler-cronjob.yaml @@ -0,0 +1,77 @@ +{{- if and (eq .Values.computers.mode "sandbox") .Values.computers.sandbox.culler.enabled }} +{{- $component := "culler" -}} +{{/* +Suspending computers nobody is using. + +A CronJob rather than a timer in the API, and the difference is the whole reason this file exists. +An interval in the server fires in every replica, so five replicas would each decide independently +to suspend the same computer. The audit-retention sweep gets away with that because deleting old +rows twice is the same as deleting them once; suspending a browser somebody just started using is +not. The work is claimed and leased out of PostgreSQL, so whichever pod runs this takes what nobody +else holds, and a pod that dies mid-suspend hands its work back when the lease expires. + +`concurrencyPolicy: Forbid` on top, because a schedule that overlaps itself is the same problem in +one workload rather than across several. +*/}} +apiVersion: batch/v1 +kind: CronJob +metadata: + name: {{ include "openbot.componentName" (dict "root" . "component" $component) }} + labels: +{{ include "openbot.componentLabels" (dict "root" . "component" $component) | indent 4 }} +spec: + schedule: {{ .Values.computers.sandbox.culler.schedule | quote }} + concurrencyPolicy: Forbid + successfulJobsHistoryLimit: 1 + failedJobsHistoryLimit: 3 + startingDeadlineSeconds: 120 + jobTemplate: + spec: + backoffLimit: 1 + template: + metadata: + labels: +{{ include "openbot.componentSelectorLabels" (dict "root" . "component" $component) | indent 12 }} + {{- if .Values.postgresql.enabled }} + {{- /* + The bundled database admits pods carrying this label and nothing else, which this chart pins on. + Anything that opens the database needs it, and only the API server had it: this would have been + refused on any cluster that actually enforces a NetworkPolicy. Not caught by hand, because the + cluster it was driven on ships enforcement switched off. + */}} + {{ .Release.Name }}-postgresql-client: "true" + {{- end }} + spec: + restartPolicy: Never + serviceAccountName: {{ include "openbot.serviceAccountName" . }} + {{- /* It reads the cluster's Sandboxes, so it needs the token the API pod does not. */}} + automountServiceAccountToken: true + {{- with .Values.imagePullSecrets }} + imagePullSecrets: +{{ toYaml . | indent 12 }} + {{- end }} + containers: + - name: culler + image: {{ include "openbot.image" . }} + imagePullPolicy: {{ .Values.image.pullPolicy }} + workingDir: /app/server + command: ["/usr/local/bin/bun", "scripts/cull-idle-computers.ts"] + env: +{{ include "openbot.databaseUrlEnv" . | indent 16 }} +{{ include "openbot.commonEnv" . | indent 16 }} + {{- /* The same shape of computer the server uses, so the two cannot disagree. */}} + volumeMounts: + - name: sandbox-template + mountPath: /etc/openbot + readOnly: true + resources: + requests: + cpu: 50m + memory: 128Mi + limits: + memory: 512Mi + volumes: + - name: sandbox-template + configMap: + name: {{ include "openbot.componentName" (dict "root" . "component" "computer-template") }} +{{- end }} diff --git a/charts/openbot/templates/computer/pod-template.yaml b/charts/openbot/templates/computer/pod-template.yaml new file mode 100644 index 00000000..67e39a22 --- /dev/null +++ b/charts/openbot/templates/computer/pod-template.yaml @@ -0,0 +1,24 @@ +{{- if eq .Values.computers.mode "sandbox" }} +{{/* +What a Bot's computer looks like, handed to the server as a file. + +`Sandbox` takes its pod inline and has no template reference, so something has to give the server the +shape of a computer. It belongs here rather than in the code: which image a computer runs, what +volumes it keeps, and which RuntimeClass it uses are deployment decisions, and the three clouds do +not agree about the last one. + +MOUNTED, NOT FETCHED. A ConfigMap the server reads through the API would need a credential to read +ConfigMaps, and this needs no permission at all if the pod simply has the file. It also means the +template cannot change under a running server without a rollout, which is what the checksum +annotation on the Deployment already arranges. +*/}} +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ include "openbot.componentName" (dict "root" . "component" "computer-template") }} + labels: +{{ include "openbot.componentLabels" (dict "root" . "component" "computer") | indent 4 }} +data: + sandbox-template.json: | +{{ include "openbot.sandboxPodTemplate" . | indent 4 }} +{{- end }} diff --git a/charts/openbot/templates/computer/sandbox-rbac.yaml b/charts/openbot/templates/computer/sandbox-rbac.yaml new file mode 100644 index 00000000..2bf66d53 --- /dev/null +++ b/charts/openbot/templates/computer/sandbox-rbac.yaml @@ -0,0 +1,47 @@ +{{- if eq .Values.computers.mode "sandbox" }} +{{- $ns := default .Release.Namespace .Values.computers.sandbox.namespace -}} +{{/* +What the API may do to computers, and nothing else. + +A ROLE, NOT A CLUSTERROLE. Scoped to the one namespace the computers live in, so the worst this +credential can do is manage Bots' browsers in the place they already are. Compare the Docker +supervisor, which holds the host's Docker socket and is therefore root-equivalent on that host: this +is a smaller blast radius, granted by the cluster rather than by a shared environment variable. +*/}} +apiVersion: rbac.authorization.k8s.io/v1 +kind: Role +metadata: + name: {{ include "openbot.componentName" (dict "root" . "component" "sandbox") }} + namespace: {{ $ns }} + labels: +{{ include "openbot.labels" . | indent 4 }} +rules: + - apiGroups: ["agents.x-k8s.io"] + resources: ["sandboxes"] + verbs: ["get", "list", "watch", "create", "patch", "delete"] + - apiGroups: ["agents.x-k8s.io"] + resources: ["sandboxes/status"] + verbs: ["get"] + {{- if .Values.computers.sandbox.warmPool.enabled }} + {{- /* The extension kinds are in their own API group, which a Role must name exactly. */}} + - apiGroups: ["extensions.agents.x-k8s.io"] + resources: ["sandboxclaims"] + verbs: ["get", "list", "create", "delete"] + {{- end }} +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: RoleBinding +metadata: + name: {{ include "openbot.componentName" (dict "root" . "component" "sandbox") }} + namespace: {{ $ns }} + labels: +{{ include "openbot.labels" . | indent 4 }} +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: Role + name: {{ include "openbot.componentName" (dict "root" . "component" "sandbox") }} +subjects: + - kind: ServiceAccount + name: {{ include "openbot.serviceAccountName" . }} + namespace: {{ .Release.Namespace }} +{{- end }} diff --git a/charts/openbot/templates/computer/sandbox-template.yaml b/charts/openbot/templates/computer/sandbox-template.yaml new file mode 100644 index 00000000..90046594 --- /dev/null +++ b/charts/openbot/templates/computer/sandbox-template.yaml @@ -0,0 +1,23 @@ +{{- if and (eq .Values.computers.mode "sandbox") .Values.computers.sandbox.warmPool.enabled }} +{{- $ns := default .Release.Namespace .Values.computers.sandbox.namespace -}} +{{/* +The template a warm pool cuts pre-warmed computers from. + +Only rendered with a warm pool, because that is the only thing that reads it: a `Sandbox` carries its +pod inline and has no template reference, so the on-demand path takes the same shape from the +ConfigMap beside this file. One definition feeds both, so a pre-warmed computer and one created on +demand cannot drift into being different things. + +`extensions.agents.x-k8s.io`, not `agents.x-k8s.io`. The two extension kinds sit in their own API +group, which is easy to get wrong and fails as "no matches for kind" at install. +*/}} +apiVersion: extensions.agents.x-k8s.io/v1beta1 +kind: SandboxTemplate +metadata: + name: {{ $ns }}-computer + namespace: {{ $ns }} + labels: +{{ include "openbot.labels" . | indent 4 }} +spec: +{{ include "openbot.sandboxPodTemplate" . | fromJson | toYaml | indent 2 }} +{{- end }} diff --git a/charts/openbot/templates/computer/service.yaml b/charts/openbot/templates/computer/service.yaml new file mode 100644 index 00000000..8d4719da --- /dev/null +++ b/charts/openbot/templates/computer/service.yaml @@ -0,0 +1,19 @@ +{{- if eq .Values.computers.mode "shared" }} +{{- $component := "computer" -}} +{{/* Headless, because a StatefulSet wants stable per-pod names rather than a load-balanced one. */}} +apiVersion: v1 +kind: Service +metadata: + name: {{ include "openbot.componentName" (dict "root" . "component" $component) }} + labels: +{{ include "openbot.componentLabels" (dict "root" . "component" $component) | indent 4 }} +spec: + clusterIP: None + ports: + - port: 4100 + targetPort: http + protocol: TCP + name: http + selector: +{{ include "openbot.componentSelectorLabels" (dict "root" . "component" $component) | indent 4 }} +{{- end }} diff --git a/charts/openbot/templates/computer/statefulset.yaml b/charts/openbot/templates/computer/statefulset.yaml new file mode 100644 index 00000000..f20fffcd --- /dev/null +++ b/charts/openbot/templates/computer/statefulset.yaml @@ -0,0 +1,170 @@ +{{- if eq .Values.computers.mode "shared" }} +{{- $component := "computer" -}} +{{/* +A Bot's computer: Chromium, a workspace, and a browser profile that has to survive a restart. + +A STATEFULSET, NOT A DEPLOYMENT, and not because there is more than one of them. The profile +directory holds real logins, and a Deployment's pods get no stable volume of their own: two replicas +would fight over one `ReadWriteOnce` claim and a rollout would hand the new pod an empty profile, +which reads as every Bot being signed out of everything at once. + +`replicas: 1` on purpose in this mode. One browser for every Bot is what `shared` means, and it is +the mode that needs no CRD in the cluster. `computers.mode: sandbox` gives each Bot its own, and is +where the idle suspend lives; see the provider RBAC beside this file. + +STORAGE HAS GRAVITY. The volume below is `ReadWriteOnce`, and on all three clouds the ordinary block +volume is zonal, so this pod is pinned to whichever zone its volume was created in for as long as +that profile exists. That is acceptable and worth stating rather than discovering. `storageClass` +stays empty by default, meaning the cluster's default class, because naming `gp3` or `pd-balanced` +here is how a chart stops installing on somebody's bare-metal cluster. +*/}} +apiVersion: apps/v1 +kind: StatefulSet +metadata: + name: {{ include "openbot.componentName" (dict "root" . "component" $component) }} + labels: +{{ include "openbot.componentLabels" (dict "root" . "component" $component) | indent 4 }} +spec: + serviceName: {{ include "openbot.componentName" (dict "root" . "component" $component) }} + replicas: 1 + selector: + matchLabels: +{{ include "openbot.componentSelectorLabels" (dict "root" . "component" $component) | indent 6 }} + {{- /* + THE DEFAULT IS RETAIN, AND THAT IS WHAT WE WANT, SAID OUT LOUD. + + `whenScaled: Delete` here would erase every Bot's logins the first time this scaled down. It is + written explicitly rather than inherited, so that nobody later "tidies up" a field they think is + missing. + */}} + persistentVolumeClaimRetentionPolicy: + whenDeleted: {{ .Values.computers.persistence.whenDeleted }} + whenScaled: Retain + volumeClaimTemplates: + - metadata: + name: profiles + spec: + accessModes: ["ReadWriteOnce"] + {{- with .Values.computers.persistence.storageClass }} + storageClassName: {{ . | quote }} + {{- end }} + resources: + requests: + storage: {{ .Values.computers.persistence.profilesSize }} + - metadata: + name: workspace + spec: + accessModes: ["ReadWriteOnce"] + {{- with .Values.computers.persistence.storageClass }} + storageClassName: {{ . | quote }} + {{- end }} + resources: + requests: + storage: {{ .Values.computers.persistence.workspaceSize }} + template: + metadata: + labels: +{{ include "openbot.componentSelectorLabels" (dict "root" . "component" $component) | indent 8 }} + spec: + {{- /* + No cluster credential in the one pod running a browser and a shell. + + A pod carries a service account token unless it says otherwise, so the container that opens + pages a person named and runs commands a model chose was carrying one. It could not do much + with it, which is not the point: this is the last pod in the deployment that should be able + to address the API server, and the default is the wrong way round. + */}} + automountServiceAccountToken: false + {{- with .Values.imagePullSecrets }} + imagePullSecrets: +{{ toYaml . | indent 8 }} + {{- end }} + {{- /* + gVisor or Kata, where the cluster has one, and an ordinary pod where it does not. + + The product already has this idea: `COMPUTER_RUNTIME=runsc` runs a computer under gVisor on a + host that supports it. This is the same setting where Kubernetes expects it. Unset by + default, because a chart that assumed a RuntimeClass would fail to install on a cluster that + has none, and the three clouds do not agree: GKE has managed gVisor, AKS offers Kata, and on + EKS it is bring your own node configuration. + */}} + {{- with .Values.computers.runtimeClassName }} + runtimeClassName: {{ . }} + {{- end }} + terminationGracePeriodSeconds: 30 + {{- with .Values.computers.nodeSelector }} + nodeSelector: +{{ toYaml . | indent 8 }} + {{- end }} + {{- with .Values.computers.tolerations }} + tolerations: +{{ toYaml . | indent 8 }} + {{- end }} + containers: + - name: computer + image: {{ include "openbot.image" . }} + imagePullPolicy: {{ .Values.image.pullPolicy }} + {{- /* + The computer alone, not the whole image. + + One image serves both roles and the command decides which: this skips s6 and runs the + browser process directly, so a computer pod carries no API and no database. + */}} + command: ["/usr/local/bin/bun", "/app/agent-computer/src/index.ts"] + ports: + - name: http + containerPort: 4100 + protocol: TCP + env: + - name: PORT + value: "4100" + - name: WORKSPACE_DIR + value: /workspace + - name: PROFILES_DIR + value: /profiles + - name: COMPUTER_TOKEN + valueFrom: + secretKeyRef: + name: {{ default (include "openbot.secretName" .) .Values.computers.existingTokenSecret }} + key: computer-token + {{- with .Values.computers.maxBrowsers }} + - name: COMPUTER_MAX_BROWSERS + value: {{ . | quote }} + {{- end }} + {{- with .Values.computers.browserIdleMs }} + - name: COMPUTER_BROWSER_IDLE_MS + value: {{ . | quote }} + {{- end }} + {{- with .Values.computers.extraEnv }} +{{ toYaml . | indent 12 }} + {{- end }} + volumeMounts: + - name: profiles + mountPath: /profiles + - name: workspace + mountPath: /workspace + {{- /* + Readiness only, and deliberately no liveness probe. + + A browser under load can be slow to answer without being broken, and a liveness probe + that restarts it takes every signed-in session with it. Readiness keeps traffic away + until it can answer; nothing kills it for being busy. + */}} + readinessProbe: + httpGet: + path: /health + port: http + initialDelaySeconds: 5 + periodSeconds: 10 + failureThreshold: 6 + startupProbe: + httpGet: + path: /health + port: http + periodSeconds: 5 + failureThreshold: 60 + {{- with .Values.computers.resources }} + resources: +{{ toYaml . | indent 12 }} + {{- end }} +{{- end }} diff --git a/charts/openbot/templates/computer/warmpool.yaml b/charts/openbot/templates/computer/warmpool.yaml new file mode 100644 index 00000000..1cac665b --- /dev/null +++ b/charts/openbot/templates/computer/warmpool.yaml @@ -0,0 +1,22 @@ +{{- if and (eq .Values.computers.mode "sandbox") .Values.computers.sandbox.warmPool.enabled }} +{{- $ns := default .Release.Namespace .Values.computers.sandbox.namespace -}} +{{/* +Computers waiting, so a Bot's first action after lunch does not wait for Chromium to boot. + +A resume costs a pod schedule and a browser launch, and a `ReadWriteOnce` volume that has to detach +from the old node first. That is a real wait, and this is the upstream mechanism for avoiding most +of it rather than something to reinvent. Off by default, because a pool is browsers nobody is using +yet, which is exactly the cost the suspend is here to remove. +*/}} +apiVersion: extensions.agents.x-k8s.io/v1beta1 +kind: SandboxWarmPool +metadata: + name: {{ $ns }}-computer + namespace: {{ $ns }} + labels: +{{ include "openbot.labels" . | indent 4 }} +spec: + replicas: {{ .Values.computers.sandbox.warmPool.replicas }} + sandboxTemplateRef: + name: {{ $ns }}-computer +{{- end }} diff --git a/charts/openbot/templates/configmap.yaml b/charts/openbot/templates/configmap.yaml new file mode 100644 index 00000000..11bf220b --- /dev/null +++ b/charts/openbot/templates/configmap.yaml @@ -0,0 +1,17 @@ +{{/* +Non-secret configuration, in a ConfigMap so a change to it rolls the pods. + +Everything here is readable by anybody who can read the namespace, which is the test for whether a +value belongs in this file rather than in the Secret beside it. +*/}} +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ include "openbot.configMapName" . }} + labels: +{{ include "openbot.labels" . | indent 4 }} +data: + OPENBOT_DEPLOYMENT: kubernetes + {{- if .Values.config.publicUrl }} + TRUSTED_ORIGINS: {{ .Values.config.publicUrl | quote }} + {{- end }} diff --git a/charts/openbot/templates/externalsecret.yaml b/charts/openbot/templates/externalsecret.yaml new file mode 100644 index 00000000..caebbb87 --- /dev/null +++ b/charts/openbot/templates/externalsecret.yaml @@ -0,0 +1,24 @@ +{{- if .Values.externalSecrets.enabled }} +{{/* +The same keys, from whatever the cluster's secret store is. + +Backend-agnostic on purpose: Secrets Manager, Secret Manager and Key Vault are all a `secretStoreRef` +and a list of remote keys, so none of them appears in this chart by name. +*/}} +apiVersion: external-secrets.io/v1 +kind: ExternalSecret +metadata: + name: {{ include "openbot.secretName" . }} + labels: +{{ include "openbot.labels" . | indent 4 }} +spec: + refreshInterval: {{ .Values.externalSecrets.refreshInterval }} + secretStoreRef: + name: {{ required "externalSecrets.secretStoreRef.name is required when externalSecrets.enabled is true" .Values.externalSecrets.secretStoreRef.name }} + kind: {{ .Values.externalSecrets.secretStoreRef.kind }} + target: + name: {{ include "openbot.secretName" . }} + creationPolicy: Owner + data: +{{ toYaml (required "externalSecrets.data must name at least key-encryption-key" .Values.externalSecrets.data) | indent 4 }} +{{- end }} diff --git a/charts/openbot/templates/httproute.yaml b/charts/openbot/templates/httproute.yaml new file mode 100644 index 00000000..fdb9a988 --- /dev/null +++ b/charts/openbot/templates/httproute.yaml @@ -0,0 +1,26 @@ +{{- if .Values.httpRoute.enabled }} +{{/* +Gateway API, as an alternative rather than a replacement. + +Where this is going, and not where every cluster is: plenty of self-hosted clusters still run an +Ingress controller, so both exist here and neither is assumed. Turning both on is a mistake rather +than a merge, and `validation.yaml` says so at install time. +*/}} +apiVersion: gateway.networking.k8s.io/v1 +kind: HTTPRoute +metadata: + name: {{ include "openbot.fullname" . }} + labels: +{{ include "openbot.labels" . | indent 4 }} +spec: + parentRefs: +{{ toYaml (required "httpRoute.parentRefs is required when httpRoute.enabled is true" .Values.httpRoute.parentRefs) | indent 4 }} + {{- with .Values.httpRoute.hostnames }} + hostnames: +{{ toYaml . | indent 4 }} + {{- end }} + rules: + - backendRefs: + - name: {{ include "openbot.fullname" . }}-server + port: {{ .Values.server.service.port }} +{{- end }} diff --git a/charts/openbot/templates/ingress.yaml b/charts/openbot/templates/ingress.yaml new file mode 100644 index 00000000..53224f2e --- /dev/null +++ b/charts/openbot/templates/ingress.yaml @@ -0,0 +1,44 @@ +{{- if .Values.ingress.enabled }} +{{- $fullname := include "openbot.fullname" . -}} +{{- $port := .Values.server.service.port -}} +{{/* +Getting traffic in, one of two ways. + +`className` has no default because the controller differs on every cluster and always will, and the +annotations that configure it differ with it. Naming one here would be a chart that installs on the +cluster it was written on. +*/}} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ $fullname }} + labels: +{{ include "openbot.labels" . | indent 4 }} + {{- with .Values.ingress.annotations }} + annotations: +{{ toYaml . | indent 4 }} + {{- end }} +spec: + {{- with .Values.ingress.className }} + ingressClassName: {{ . }} + {{- end }} + {{- with .Values.ingress.tls }} + tls: +{{ toYaml . | indent 4 }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + pathType: {{ .pathType }} + backend: + service: + name: {{ $fullname }}-server + port: + number: {{ $port }} + {{- end }} + {{- end }} +{{- end }} diff --git a/charts/openbot/templates/migrations/job.yaml b/charts/openbot/templates/migrations/job.yaml new file mode 100644 index 00000000..d62a3afd --- /dev/null +++ b/charts/openbot/templates/migrations/job.yaml @@ -0,0 +1,105 @@ +{{- if .Values.migrations.enabled }} +{{- $component := "migrations" -}} +{{/* +The schema, before anything serves a request. + +A pre-install and pre-upgrade hook rather than an init container on the Deployment: with several +replicas, an init container means every replica races to migrate the same database, and the +migration that loses is a failed pod on an otherwise healthy rollout. One Job runs once. + +WHEN IT RUNS DEPENDS ON WHOSE DATABASE IT IS, and both wrong answers deadlock rather than slow down. + +A pre-install hook runs before the chart's own resources, so with the bundled database the +StatefulSet does not exist yet and never will while the hook is running: waiting cannot help, +because the thing being waited for is behind the wait. A post-install hook has the mirror image of +the same problem, because `--wait` holds it until the Deployment is ready and the Deployment cannot +be ready against a database with no schema in it. + +So on a first install with the bundled database this is not a hook at all. It is an ordinary Job, +created in the same pass as the database and the Deployment, and it waits for the database while the +replicas restart against a schema that is on its way. Nothing is ordered because nothing needs to +be: the Job's own wait is the ordering, and a replica that starts too early is a restart rather than +a failure. + +Every other case is a hook, because in every other case the database already exists. An external +database on install, and any upgrade at all, run `pre`, where the schema is ready before a replica +reaches a version of it that it has not seen. + +Deleted before the next run and on success. A failed one is kept, so the reason is still readable. +*/}} +apiVersion: batch/v1 +kind: Job +metadata: + name: {{ include "openbot.componentName" (dict "root" . "component" $component) }}-{{ .Release.Revision }} + labels: +{{ include "openbot.componentLabels" (dict "root" . "component" $component) | indent 4 }} + {{- if not (and .Values.postgresql.enabled .Release.IsInstall) }} + annotations: + helm.sh/hook: pre-install,pre-upgrade + helm.sh/hook-weight: "-5" + helm.sh/hook-delete-policy: before-hook-creation,hook-succeeded + {{- end }} +spec: + activeDeadlineSeconds: {{ .Values.migrations.activeDeadlineSeconds }} + backoffLimit: {{ .Values.migrations.backoffLimit }} + template: + metadata: + labels: +{{ include "openbot.componentSelectorLabels" (dict "root" . "component" $component) | indent 8 }} + {{- if .Values.postgresql.enabled }} + {{- /* + The bundled database admits pods carrying this label and nothing else, which this chart pins on. + Anything that opens the database needs it, and only the API server had it: this would have been + refused on any cluster that actually enforces a NetworkPolicy. Not caught by hand, because the + cluster it was driven on ships enforcement switched off. + */}} + {{ .Release.Name }}-postgresql-client: "true" + {{- end }} + spec: + restartPolicy: Never + {{- /* + NO SERVICE ACCOUNT, WHICH IS BOTH CORRECT AND NECESSARY. + + Correct because this Job talks to a database and never to the cluster, so a cluster + credential in it is one nothing needs. Necessary because as a pre-install hook it runs before + the chart's own resources exist, and naming the ServiceAccount the API pods use fails with + "serviceaccount not found" and a Job that can never schedule. The default account, with no + token mounted, is what a migration actually requires. + */}} + automountServiceAccountToken: false + {{- with .Values.imagePullSecrets }} + imagePullSecrets: +{{ toYaml . | indent 8 }} + {{- end }} + containers: + - name: migrate + image: {{ include "openbot.image" . }} + imagePullPolicy: {{ .Values.image.pullPolicy }} + workingDir: /app/server + command: + - /bin/sh + - -ec + - | + # Bounded, so a database that is never coming back fails the install rather than + # holding it open until somebody notices. `pg_isready` reads the same DATABASE_URL the + # migration is about to use, so this cannot wait on the wrong server. + deadline=$(( $(date +%s) + {{ .Values.migrations.waitForDatabaseSeconds }} )) + until pg_isready -d "$DATABASE_URL" -q; do + if [ "$(date +%s)" -ge "$deadline" ]; then + echo "the database did not accept connections within {{ .Values.migrations.waitForDatabaseSeconds }}s" >&2 + exit 1 + fi + sleep 2 + done + exec /usr/local/bin/bun scripts/migrate.ts + env: +{{ include "openbot.databaseUrlEnv" . | indent 12 }} + - name: EMBEDDED_POSTGRES + value: "off" + - name: EMBEDDED_COMPUTER + value: "off" + {{- with .Values.migrations.resources }} + resources: +{{ toYaml . | indent 12 }} + {{- end }} +{{- end }} diff --git a/charts/openbot/templates/networkpolicy.yaml b/charts/openbot/templates/networkpolicy.yaml new file mode 100644 index 00000000..d188a428 --- /dev/null +++ b/charts/openbot/templates/networkpolicy.yaml @@ -0,0 +1,182 @@ +{{- if .Values.networkPolicy.enabled }} +{{- $component := "server" -}} +{{/* +What the API may reach, and what may reach it. + +Off by default, because a NetworkPolicy on a cluster with no CNI that enforces one is a resource +that silently does nothing, and on a cluster that does enforce one a wrong rule is an outage. A +deployment that turns this on is saying it knows which of the two it has. + +Egress allows DNS, the database, the computers, and HTTP and HTTPS to everywhere that is not the +cluster's own private network. THAT LAST ONE IS NOT A CONCESSION, it is what this pod does: sign-in +goes to an identity provider, every conversation goes to Intelligence, and every run goes to a Bot +at an address somebody registered. All three are hostnames rather than CIDRs, and a NetworkPolicy +cannot match a hostname, so there is no narrower rule to write. Leaving it out did not fence the API +off, it stopped the product working, and only in `computers.mode: sandbox` did a rule meant for the +Kubernetes API server quietly cover for it. + +The private ranges stay cut out by exception, the way the computers' policy does it, so this is +still a pod that cannot address another pod, a node, or a cloud metadata endpoint. +*/}} +apiVersion: networking.k8s.io/v1 +kind: NetworkPolicy +metadata: + name: {{ include "openbot.componentName" (dict "root" . "component" $component) }} + labels: +{{ include "openbot.componentLabels" (dict "root" . "component" $component) | indent 4 }} +spec: + podSelector: + matchLabels: +{{ include "openbot.componentSelectorLabels" (dict "root" . "component" $component) | indent 6 }} + policyTypes: + - Ingress + - Egress + ingress: + - ports: + - port: {{ .Values.server.service.port }} + protocol: TCP + {{- with .Values.networkPolicy.extraIngress }} +{{ toYaml . | indent 4 }} + {{- end }} + egress: + # DNS, or nothing resolves and every failure looks like the database being down. + - ports: + - port: 53 + protocol: UDP + - port: 53 + protocol: TCP + {{- if .Values.postgresql.enabled }} + - to: + - podSelector: + matchLabels: + app.kubernetes.io/name: postgresql + ports: + - port: 5432 + protocol: TCP + {{- end }} + {{- if ne .Values.computers.mode "external" }} + {{- /* + A Bot's computer, which the API has to reach for every browser action. + + Easy to forget, because nothing about the API looks like it talks to another pod: the browser is + behind a Service and reads like an outside address. On a cluster that enforces policy, leaving + this out means every Bot action fails and the API looks broken rather than fenced. + */}} + - to: + - podSelector: + matchLabels: + app.kubernetes.io/component: computer + ports: + - port: 4100 + protocol: TCP + {{- end }} + {{- /* + Intelligence, the identity provider, and every Bot: all of them, and all outside the cluster. + + Written as an exception list rather than as a destination list because the destinations are + hostnames the deployment configures and a NetworkPolicy matches addresses. The same shape the + computers' policy below already uses, for the same reason. + */}} + - to: + - ipBlock: + cidr: 0.0.0.0/0 + except: + # The cluster and everything else on the private network, including the database. + - 10.0.0.0/8 + - 172.16.0.0/12 + - 192.168.0.0/16 + # Link-local, which is where every cloud keeps the endpoint that hands out credentials. + - 169.254.0.0/16 + ports: + - port: 80 + protocol: TCP + - port: 443 + protocol: TCP + {{- if eq .Values.computers.mode "sandbox" }} + {{- /* + The Kubernetes API server, which is where a per-Bot computer is asked for. + + Its own rule because it sits on the private network the rule above cuts out, so nothing else + here reaches it. Unscoped unless a deployment says otherwise: the API server answers on a + ClusterIP from the service range, and a chart cannot know that range at template time. Name it + in `networkPolicy.kubernetesApiCidr` and this narrows to it. + */}} + - {{- with .Values.networkPolicy.kubernetesApiCidr }} + to: + - ipBlock: + cidr: {{ . }} + {{- end }} + ports: + - port: 443 + protocol: TCP + - port: 6443 + protocol: TCP + {{- end }} + {{- with .Values.networkPolicy.extraEgress }} +{{ toYaml . | indent 4 }} + {{- end }} +--- +{{- $computer := "computer" -}} +{{/* +What a Bot's computer may reach. + +THE ONE POD THAT RUNS A BROWSER AND A SHELL. It opens pages a person named and runs commands a model +chose, which makes it the pod most likely to be doing something nobody intended, and it was the only +one with no policy at all: on a cluster that enforces them it could open a socket to anything in the +namespace, the deployment's own database included. Compose has kept the database off the Bot's +network since the beginning, and this is that same boundary, said in the other deployment's words. + +Egress is the open internet minus the cluster's own private space, because browsing is the job. The +private ranges are cut out by exception rather than by listing what is allowed: a Bot has no business +addressing another pod, a node, or a cloud metadata endpoint, and naming the exceptions is the only +way to say that without also saying which websites exist. + +Ingress is the API server and nothing else. The gateway is the only thing that may drive it. +*/}} +apiVersion: networking.k8s.io/v1 +kind: NetworkPolicy +metadata: + name: {{ include "openbot.componentName" (dict "root" . "component" $computer) }} + labels: +{{ include "openbot.componentLabels" (dict "root" . "component" $computer) | indent 4 }} +spec: + podSelector: + matchLabels: +{{ include "openbot.componentSelectorLabels" (dict "root" . "component" $computer) | indent 6 }} + policyTypes: + - Ingress + - Egress + ingress: + - from: + - podSelector: + matchLabels: +{{ include "openbot.componentSelectorLabels" (dict "root" . "component" "server") | indent 14 }} + ports: + - port: 4100 + protocol: TCP + egress: + # DNS, or every address a Bot is asked to open fails as if the site were down. + - ports: + - port: 53 + protocol: UDP + - port: 53 + protocol: TCP + - to: + - ipBlock: + cidr: 0.0.0.0/0 + except: + # The cluster and everything else on the private network, including the database. + - 10.0.0.0/8 + - 172.16.0.0/12 + - 192.168.0.0/16 + # Link-local, which is where every cloud keeps the endpoint that hands out credentials. + - 169.254.0.0/16 + ports: + - port: 80 + protocol: TCP + - port: 443 + protocol: TCP + {{- with .Values.networkPolicy.computerExtraEgress }} +{{ toYaml . | indent 4 }} + {{- end }} +{{- end }} diff --git a/charts/openbot/templates/secret.yaml b/charts/openbot/templates/secret.yaml new file mode 100644 index 00000000..c10439d5 --- /dev/null +++ b/charts/openbot/templates/secret.yaml @@ -0,0 +1,50 @@ +{{- if and (not .Values.secrets.existingSecret) (not .Values.externalSecrets.enabled) }} +{{/* +The fallback, and the default, because a plain Kubernetes Secret is what a self-hosted cluster has. + +A deployment on a cloud points `externalSecrets` at its own store instead and this renders nothing. +Either way the templates that read these keys are identical, which is the point: no vendor appears +anywhere except in a values block. + +`helm.sh/resource-policy: keep` is deliberate. `KEY_ENCRYPTION_KEY` is what the credential vault is +encrypted with, so a `helm uninstall` that took it would leave every stored credential unreadable +even after a reinstall against the same database. +*/}} +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "openbot.secretName" . }} + labels: +{{ include "openbot.labels" . | indent 4 }} + annotations: + helm.sh/resource-policy: keep +type: Opaque +stringData: + key-encryption-key: {{ required "secrets.keyEncryptionKey is required unless secrets.existingSecret or externalSecrets is used. Generate one with: openssl rand -base64 32" .Values.secrets.keyEncryptionKey | quote }} + intelligence-api-key: {{ required "secrets.intelligenceApiKey is required. OpenBot needs CopilotKit Intelligence and refuses to start without it." .Values.secrets.intelligenceApiKey | quote }} + license-token: {{ required "secrets.licenseToken is required. OpenBot needs CopilotKit Intelligence and refuses to start without it." .Values.secrets.licenseToken | quote }} + {{- with .Values.secrets.betterAuthSecret }} + better-auth-secret: {{ . | quote }} + {{- end }} + {{- with .Values.secrets.modelApiKey }} + model-api-key: {{ . | quote }} + {{- end }} + {{- with .Values.secrets.managedAgentToken }} + managed-agent-token: {{ . | quote }} + {{- end }} + {{- with .Values.secrets.googleClientSecret }} + google-client-secret: {{ . | quote }} + {{- end }} + {{- with .Values.secrets.microsoftClientSecret }} + microsoft-client-secret: {{ . | quote }} + {{- end }} + {{- with .Values.secrets.oktaClientSecret }} + okta-client-secret: {{ . | quote }} + {{- end }} + {{- with .Values.secrets.computerToken }} + computer-token: {{ . | quote }} + {{- end }} + {{- with .Values.secrets.supervisorToken }} + supervisor-token: {{ . | quote }} + {{- end }} +{{- end }} diff --git a/charts/openbot/templates/server/deployment.yaml b/charts/openbot/templates/server/deployment.yaml new file mode 100644 index 00000000..2ed9af3e --- /dev/null +++ b/charts/openbot/templates/server/deployment.yaml @@ -0,0 +1,155 @@ +{{- $component := "server" -}} +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "openbot.componentName" (dict "root" . "component" $component) }} + labels: +{{ include "openbot.componentLabels" (dict "root" . "component" $component) | indent 4 }} + {{- with .Values.commonAnnotations }} + annotations: +{{ toYaml . | indent 4 }} + {{- end }} +spec: + {{- /* Left unset when the HPA owns it, so a chart upgrade cannot undo a scale the HPA decided. */}} + {{- if not .Values.server.autoscaling.enabled }} + replicas: {{ .Values.server.replicaCount }} + {{- end }} + selector: + matchLabels: +{{ include "openbot.componentSelectorLabels" (dict "root" . "component" $component) | indent 6 }} + template: + metadata: + labels: +{{ include "openbot.componentSelectorLabels" (dict "root" . "component" $component) | indent 8 }} + {{- if .Values.postgresql.enabled }} + {{- /* + The bundled database's own policy admits pods carrying this label and nothing else. + + Its shipped default is `allowExternal: true`, which renders an ingress rule with no `from` + at all: any pod in any namespace may open 5432, the Bot's browser container included. That + is pinned off in this chart's values, which makes this label the thing that lets the API in, + and the reason a Bot's computer is now refused. + */}} + {{ .Release.Name }}-postgresql-client: "true" + {{- end }} + {{- with .Values.server.podLabels }} +{{ toYaml . | indent 8 }} + {{- end }} + annotations: + {{- /* + Roll the pods when configuration changes. + + Without this a `helm upgrade` that only changes the ConfigMap leaves every replica running + the old values, and the deployment looks upgraded while behaving exactly as it did. + */}} + checksum/config: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }} + {{- if eq .Values.computers.mode "sandbox" }} + {{- /* + The shape of a computer, which the server reads once and keeps. + + A mounted ConfigMap does update in place, but the file is read on the first computer request + and the provider built from it is held for the life of the process. Without this the + template can change under a running server and every Sandbox it creates is still cut from + the old one, which is a rollout that looks like it worked and changes nothing. + */}} + checksum/computer-template: {{ include (print $.Template.BasePath "/computer/pod-template.yaml") . | sha256sum }} + {{- end }} + {{- with .Values.server.podAnnotations }} +{{ toYaml . | indent 8 }} + {{- end }} + spec: + serviceAccountName: {{ include "openbot.serviceAccountName" . }} + automountServiceAccountToken: {{ include "openbot.automountToken" . }} + {{- with .Values.imagePullSecrets }} + imagePullSecrets: +{{ toYaml . | indent 8 }} + {{- end }} + {{- with .Values.podSecurityContext }} + securityContext: +{{ toYaml . | indent 8 }} + {{- end }} + {{- $affinity := include "openbot.podAntiAffinity" (dict "root" . "component" $component) }} + {{- if $affinity }} + affinity: +{{ $affinity | indent 8 }} + {{- end }} + {{- with .Values.server.topologySpreadConstraints }} + topologySpreadConstraints: +{{ toYaml . | indent 8 }} + {{- end }} + {{- with .Values.server.nodeSelector }} + nodeSelector: +{{ toYaml . | indent 8 }} + {{- end }} + {{- with .Values.server.tolerations }} + tolerations: +{{ toYaml . | indent 8 }} + {{- end }} + containers: + - name: server + image: {{ include "openbot.image" . }} + imagePullPolicy: {{ .Values.image.pullPolicy }} + {{- with .Values.securityContext }} + securityContext: +{{ toYaml . | indent 12 }} + {{- end }} + ports: + - name: http + containerPort: {{ .Values.server.service.port }} + protocol: TCP + env: +{{ include "openbot.databaseUrlEnv" . | indent 12 }} +{{ include "openbot.commonEnv" . | indent 12 }} + envFrom: + - configMapRef: + name: {{ include "openbot.configMapName" . }} + {{- with .Values.config.extraEnvFrom }} +{{ toYaml . | indent 12 }} + {{- end }} + {{- /* + Three probes, and the startup one is the reason the other two can be impatient. + + A cold start migrates nothing but does read and validate the tenant package, so first + boot is slower than steady state. Without a startup probe the liveness one has to be + slack enough for the slowest boot, which means a wedged replica stays in the Service for + as long as a healthy slow one would. + */}} + startupProbe: + httpGet: + path: /health + port: http + periodSeconds: {{ .Values.server.startupProbe.periodSeconds }} + failureThreshold: {{ .Values.server.startupProbe.failureThreshold }} + readinessProbe: + httpGet: + path: /health + port: http + initialDelaySeconds: {{ .Values.server.readinessProbe.initialDelaySeconds }} + periodSeconds: {{ .Values.server.readinessProbe.periodSeconds }} + timeoutSeconds: {{ .Values.server.readinessProbe.timeoutSeconds }} + failureThreshold: {{ .Values.server.readinessProbe.failureThreshold }} + livenessProbe: + httpGet: + path: /health + port: http + initialDelaySeconds: {{ .Values.server.livenessProbe.initialDelaySeconds }} + periodSeconds: {{ .Values.server.livenessProbe.periodSeconds }} + timeoutSeconds: {{ .Values.server.livenessProbe.timeoutSeconds }} + failureThreshold: {{ .Values.server.livenessProbe.failureThreshold }} + {{- if eq .Values.computers.mode "sandbox" }} + {{- /* The shape of a Bot's computer, as a file rather than as a permission to read one. */}} + volumeMounts: + - name: sandbox-template + mountPath: /etc/openbot + readOnly: true + {{- end }} + {{- with .Values.server.resources }} + resources: +{{ toYaml . | indent 12 }} + {{- end }} + {{- if eq .Values.computers.mode "sandbox" }} + volumes: + - name: sandbox-template + configMap: + name: {{ include "openbot.componentName" (dict "root" . "component" "computer-template") }} + {{- end }} diff --git a/charts/openbot/templates/server/hpa.yaml b/charts/openbot/templates/server/hpa.yaml new file mode 100644 index 00000000..6a79a421 --- /dev/null +++ b/charts/openbot/templates/server/hpa.yaml @@ -0,0 +1,37 @@ +{{- if .Values.server.autoscaling.enabled }} +{{- $component := "server" -}} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "openbot.componentName" (dict "root" . "component" $component) }} + labels: +{{ include "openbot.componentLabels" (dict "root" . "component" $component) | indent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "openbot.componentName" (dict "root" . "component" $component) }} + minReplicas: {{ .Values.server.autoscaling.minReplicas }} + maxReplicas: {{ .Values.server.autoscaling.maxReplicas }} + metrics: + {{- if .Values.server.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + target: + type: Utilization + averageUtilization: {{ .Values.server.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.server.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + target: + type: Utilization + averageUtilization: {{ .Values.server.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} + {{- with .Values.server.autoscaling.behavior }} + behavior: +{{ toYaml . | indent 4 }} + {{- end }} +{{- end }} diff --git a/charts/openbot/templates/server/pdb.yaml b/charts/openbot/templates/server/pdb.yaml new file mode 100644 index 00000000..83cd913f --- /dev/null +++ b/charts/openbot/templates/server/pdb.yaml @@ -0,0 +1,30 @@ +{{- if .Values.server.podDisruptionBudget.enabled }} +{{- $component := "server" -}} +{{/* +What a drain may take at once. + +Only meaningful with more than one replica: a budget of `minAvailable: 1` over a single replica means +a node drain blocks forever rather than being safe, so this is rendered only where it can be kept. +*/}} +{{- $replicas := int .Values.server.replicaCount -}} +{{- if .Values.server.autoscaling.enabled }} +{{- $replicas = int .Values.server.autoscaling.minReplicas -}} +{{- end }} +{{- if gt $replicas 1 }} +apiVersion: policy/v1 +kind: PodDisruptionBudget +metadata: + name: {{ include "openbot.componentName" (dict "root" . "component" $component) }} + labels: +{{ include "openbot.componentLabels" (dict "root" . "component" $component) | indent 4 }} +spec: + {{- if .Values.server.podDisruptionBudget.maxUnavailable }} + maxUnavailable: {{ .Values.server.podDisruptionBudget.maxUnavailable }} + {{- else }} + minAvailable: {{ .Values.server.podDisruptionBudget.minAvailable }} + {{- end }} + selector: + matchLabels: +{{ include "openbot.componentSelectorLabels" (dict "root" . "component" $component) | indent 6 }} +{{- end }} +{{- end }} diff --git a/charts/openbot/templates/server/service.yaml b/charts/openbot/templates/server/service.yaml new file mode 100644 index 00000000..1d60306d --- /dev/null +++ b/charts/openbot/templates/server/service.yaml @@ -0,0 +1,24 @@ +{{- $component := "server" -}} +apiVersion: v1 +kind: Service +metadata: + name: {{ include "openbot.componentName" (dict "root" . "component" $component) }} + labels: +{{ include "openbot.componentLabels" (dict "root" . "component" $component) | indent 4 }} + {{- with .Values.server.service.annotations }} + annotations: +{{ toYaml . | indent 4 }} + {{- end }} +spec: + type: {{ .Values.server.service.type }} + {{- with .Values.server.service.loadBalancerSourceRanges }} + loadBalancerSourceRanges: +{{ toYaml . | indent 4 }} + {{- end }} + ports: + - port: {{ .Values.server.service.port }} + targetPort: http + protocol: TCP + name: http + selector: +{{ include "openbot.componentSelectorLabels" (dict "root" . "component" $component) | indent 4 }} diff --git a/charts/openbot/templates/server/serviceaccount.yaml b/charts/openbot/templates/server/serviceaccount.yaml new file mode 100644 index 00000000..83ddfa90 --- /dev/null +++ b/charts/openbot/templates/server/serviceaccount.yaml @@ -0,0 +1,17 @@ +{{- if .Values.serviceAccount.create }} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "openbot.serviceAccountName" . }} + labels: +{{ include "openbot.labels" . | indent 4 }} + {{- /* + IRSA, Workload Identity and AKS workload identity are all annotations here, which is why this is + one map and not three code paths. The chart never learns which cloud it is on. + */}} + {{- with .Values.serviceAccount.annotations }} + annotations: +{{ toYaml . | indent 4 }} + {{- end }} +automountServiceAccountToken: {{ include "openbot.automountToken" . }} +{{- end }} diff --git a/charts/openbot/templates/validation.yaml b/charts/openbot/templates/validation.yaml new file mode 100644 index 00000000..7f16e1b0 --- /dev/null +++ b/charts/openbot/templates/validation.yaml @@ -0,0 +1,249 @@ +{{/* +Refused at install time, not discovered in a crash loop. + +Every check here is something the API would fail on at boot, or something that is quietly wrong +rather than loudly broken. A `helm install` that succeeds and leaves pods restarting is worse than +one that refuses and says why, because the second names the value to change. + +This template renders nothing. +*/}} + +{{- if and (not .Values.postgresql.enabled) (not .Values.database.url) (not .Values.database.existingSecret) }} +{{- fail "No database. Either set postgresql.enabled=true to run the bundled one, or set database.url (or database.existingSecret) to point at your own." }} +{{- end }} + +{{- /* + The bundled database, without a password anybody can produce again. + + The subchart generates one on install and then refuses to render on upgrade without being handed + the current value, so a release installed without one cannot be upgraded, only reinstalled. That + failure arrives on the second deploy, which is the worst time to find it. +*/}} +{{- if and .Values.postgresql.enabled (not .Values.postgresql.auth.password) (not .Values.postgresql.auth.existingSecret) }} +{{- fail "The bundled database needs a password you can supply again on upgrade. Set postgresql.auth.password, or postgresql.auth.existingSecret to name one you made. Generate one with: openssl rand -hex 24" }} +{{- end }} + +{{- if and .Values.postgresql.enabled (or .Values.database.url .Values.database.existingSecret) }} +{{- fail "Two databases. postgresql.enabled is true and database.url is also set, so it is not clear which one is meant. Pick one." }} +{{- end }} + +{{- /* + Nobody can get in, which is two separate mistakes rather than one. + + Naming administrators does not create a way to sign in, and configuring sign-in does not make + anybody an administrator: the server refuses to start without a provider, and grants the role to + nobody without the addresses. An earlier version of this check accepted admin emails alone, which + passed the install and then crash-looped on the first boot, so both are checked and named apart. +*/}} +{{- $provider := or .Values.config.auth.google.clientId .Values.config.auth.microsoft.clientId .Values.config.auth.okta.clientId -}} +{{- if and (not .Values.config.singleUser) (not $provider) }} +{{- fail "Nobody could sign in. Configure config.auth.google, config.auth.microsoft or config.auth.okta, or set config.singleUser=true for a local trial where every request is one fixed administrator." }} +{{- end }} + +{{- if and $provider (not .Values.config.initialAdminEmails) }} +{{- fail "Nobody would be an administrator. config.initialAdminEmails is what grants the role; nothing else does." }} +{{- end }} + +{{- if and $provider (not .Values.config.publicUrl) }} +{{- fail "Sign-in needs somewhere to come back to. Set config.publicUrl to the address people reach this deployment at, which is where the OAuth callback lands." }} +{{- end }} + +{{- if and .Values.config.auth.okta.clientId (not .Values.config.auth.okta.issuer) }} +{{- fail "config.auth.okta.issuer is required alongside the Okta client, such as https://example.okta.com/oauth2/default. It is what makes it a particular Okta rather than Okta in general." }} +{{- end }} + +{{- /* + Every visitor as one administrator, on an address the internet can reach. + + `singleUser` is a local trial mode, and a LoadBalancer with no source ranges is the open internet. + Together they are a deployment where anybody who finds the address is an administrator, which is + the exact failure the server refuses to start into when nobody has said they meant it. +*/}} +{{- if and .Values.config.singleUser (eq .Values.server.service.type "LoadBalancer") (not .Values.server.service.loadBalancerSourceRanges) }} +{{- fail "config.singleUser treats every visitor as an administrator, so it must not be put behind a LoadBalancer that anybody can reach. Set server.service.loadBalancerSourceRanges, or configure an identity provider." }} +{{- end }} + +{{- if and .Values.config.singleUser .Values.config.publicUrl }} +{{- fail "config.singleUser serves every visitor as one administrator, so it must not be combined with a public URL. Configure an identity provider and set config.initialAdminEmails instead." }} +{{- end }} + +{{- /* + Intelligence, which is not optional. + + All four values are required together and the server refuses to start on a partial set, so the + same rule is applied here: caught at install with the values named, rather than in a crash loop + whose message is in a log nobody has opened. +*/}} +{{- if or (not .Values.config.intelligence.apiUrl) (not .Values.config.intelligence.gatewayWsUrl) }} +{{- fail "OpenBot requires CopilotKit Intelligence. Set config.intelligence.apiUrl and config.intelligence.gatewayWsUrl, and the matching secrets.intelligenceApiKey and secrets.licenseToken." }} +{{- end }} + +{{- /* + A computer nobody can reach, or one anybody can. + + `agent-computer` refuses every request without `COMPUTER_TOKEN` and permits only `/health`, so a + chart that created one without a token would create a process that answers nothing. And a mode of + `external` with no address is a deployment whose Bots have no computer at all, which fails at the + first browser action rather than at install. +*/}} +{{- if and (ne .Values.computers.mode "external") (not .Values.secrets.computerToken) (not .Values.computers.existingTokenSecret) (not .Values.secrets.existingSecret) (not .Values.externalSecrets.enabled) }} +{{- fail "A computer needs a token, which is the only thing standing between it and anybody who can reach its port. Set secrets.computerToken. Generate one with: openssl rand -hex 32" }} +{{- end }} + +{{- if and (eq .Values.computers.mode "external") (not .Values.computers.url) }} +{{- fail "computers.mode is external but computers.url is empty, so no Bot would have a computer. Set the address, or use mode: shared to have this chart run one." }} +{{- end }} + +{{- /* + Asking for per-Bot computers on a cluster that cannot make them. + + `computers.mode: sandbox` creates `Sandbox` objects, which only exist once the agent-sandbox + controller is installed. Without it the install succeeds, every pod is healthy, and the deployment + looks finished right up until the first Bot asks for a browser and gets a 404 from the API server. + That is the worst time to learn it, so it is a refusal here instead, with the command to run. + + Read from the cluster, so it is a real check rather than a value somebody has to remember to set. + `helm template` with no cluster has no way to know, which is what `--api-versions` is for and what + the chart's own render tests pass. +*/}} +{{- if and (eq .Values.computers.mode "sandbox") .Values.computers.sandbox.requireController }} +{{- if not (.Capabilities.APIVersions.Has "agents.x-k8s.io/v1beta1/Sandbox") }} +{{- fail "computers.mode is sandbox, which gives every Bot its own computer, but this cluster has no Sandbox CRD. Install the controller first:\n\n kubectl apply --server-side -f https://github.com/kubernetes-sigs/agent-sandbox/releases/download/v0.5.6/sandbox-with-extensions.yaml\n\nOr use computers.mode: shared, which needs nothing installed. Rendering without a cluster? Pass --api-versions agents.x-k8s.io/v1beta1/Sandbox, or set computers.sandbox.requireController=false." }} +{{- end }} +{{- end }} + +{{- if not (has .Values.computers.mode (list "shared" "sandbox" "external")) }} +{{- fail "computers.mode must be one of: shared, sandbox, external." }} +{{- end }} + +{{- /* + A policy that would fence the deployment off from its own database. + + The egress rules name DNS, the computers and, when it is bundled, the database. A managed database + is an address this chart cannot know, so on a cluster that enforces policy the API would resolve it + and then be unable to reach it, which reads as the database being down rather than as a rule. + + Worth knowing either way: a NetworkPolicy on a cluster whose CNI does not enforce one is a resource + that silently does nothing. EKS needs the VPC CNI started with `--enable-network-policy=true`, and + it is off by default, so this can look like it is working when it is not doing anything at all. +*/}} +{{- if and .Values.networkPolicy.enabled (not .Values.postgresql.enabled) (not .Values.networkPolicy.extraEgress) }} +{{- fail "networkPolicy.enabled with an external database, but nothing lets the API reach it. Add the database to networkPolicy.extraEgress, for example a `to: [{ipBlock: {cidr: 10.0.0.0/16}}]` with port 5432." }} +{{- end }} + +{{- if and .Values.ingress.enabled .Values.httpRoute.enabled }} +{{- fail "ingress.enabled and httpRoute.enabled are both set. They are two ways to do the same thing; pick the one your cluster runs." }} +{{- end }} + +{{- /* + A key of the wrong shape. + + `KEY_ENCRYPTION_KEY` must decode to exactly 32 bytes, and the server refuses to start otherwise. + Checked here only when the chart is the one creating the Secret: a key coming from an existing + Secret or an external store is not readable at template time, and guessing about it would mean + refusing installs that are fine. +*/}} +{{- if and .Values.secrets.keyEncryptionKey (not .Values.secrets.existingSecret) (not .Values.externalSecrets.enabled) }} +{{- if ne (len (b64dec .Values.secrets.keyEncryptionKey)) 32 }} +{{- fail "secrets.keyEncryptionKey must be a base64-encoded 32-byte value. Generate one with: openssl rand -base64 32" }} +{{- end }} +{{- /* + The right length and no secret in it. + + The example key in `.env.example` is thirty-two zero bytes, which passes every shape check and is + public. The server refuses to start on it in production and this chart shipped a values file + carrying it, so the target rendered and the deployment it described could never run. Checked as a + property rather than by copying the value, which would mean writing a key-shaped literal into a + template to forbid a key-shaped literal. +*/}} +{{- if not (regexMatch "[^\\x00]" (b64dec .Values.secrets.keyEncryptionKey)) }} +{{- fail "secrets.keyEncryptionKey is the public example key from .env.example. The server refuses to start with it. Generate one with: openssl rand -base64 32" }} +{{- end }} +{{- end }} + +{{- if and .Values.externalSecrets.enabled .Values.secrets.existingSecret }} +{{- fail "externalSecrets.enabled and secrets.existingSecret are both set. The first creates the Secret and the second says one already exists; pick one." }} +{{- end }} + +{{- /* + A replica count that cannot survive the thing replicas are for. + + One replica is a supported way to run this and not the default, so this is a note rather than a + refusal only when somebody has also asked for a disruption budget, where one replica means a node + drain blocks rather than being safe. +*/}} +{{- if and (not .Values.server.autoscaling.enabled) (lt (int .Values.server.replicaCount) 1) }} +{{- fail "server.replicaCount must be at least 1." }} +{{- end }} + +{{- if .Values.server.embeddedComputer }} +{{- if gt (int .Values.server.replicaCount) 1 }} +{{- fail "server.embeddedComputer runs a browser inside every API pod, which cannot be replicated: each replica would hold a profile directory belonging to one Bot. Either set server.replicaCount=1, or leave embeddedComputer off and give the Bots a computer of their own." }} +{{- end }} +{{- end }} + +{{- /* + A Bot endpoint with nothing on the request that says who is calling. + + The server refuses to start in this state, and it is better to hear it from `helm install` than + from a pod's third crash loop. Only checked when the chart holds the token: a value in an existing + Secret or an external store is not readable at template time, so an install that gets it from + there is left alone rather than refused on a guess. +*/}} +{{- if .Values.config.managedAgent.url }} +{{- if and (not .Values.secrets.managedAgentToken) (not .Values.secrets.existingSecret) (not .Values.externalSecrets.enabled) }} +{{- fail "config.managedAgent.url is set without secrets.managedAgentToken. Every call to your Bot carries that token, and an endpoint that accepts unauthenticated calls is an open door to whatever the Bot can reach." }} +{{- end }} +{{- /* + The same requirement, for a deployment whose secrets come from a store. + + The value is not readable at template time, but the LIST of keys is, and a store that never + mentions this key cannot be holding one. Without this the refusal simply went dark on every cloud + target, which is where a Bot endpoint is most likely to be pointed at something real. +*/}} +{{- if .Values.externalSecrets.enabled }} +{{- $named := list }} +{{- range .Values.externalSecrets.data }}{{- $named = append $named .secretKey }}{{- end }} +{{- if not (has "managed-agent-token" $named) }} +{{- fail "config.managedAgent.url is set but externalSecrets.data does not name managed-agent-token. Every call to your Bot carries that token, and an endpoint that accepts unauthenticated calls is an open door to whatever the Bot can reach." }} +{{- end }} +{{- end }} +{{- end }} + +{{- /* + Sign-in configured with nothing to sign sessions with. + + The server throws "Sign-in requires BETTER_AUTH_SECRET" and the pod crash-loops, which is a slow + and confusing way to be told about a value that was missing before anything was created. Every + shipped `ci/` values file was in exactly this state, which is what happens when nothing renders the + chart. Checked only when this chart holds the secret: from an existing Secret or an external store + it is not readable at template time, and refusing on a guess would refuse installs that are fine. +*/}} +{{- if or .Values.config.auth.google.clientId .Values.config.auth.microsoft.clientId .Values.config.auth.okta.clientId }} +{{- if and (not .Values.secrets.betterAuthSecret) (not .Values.secrets.existingSecret) (not .Values.externalSecrets.enabled) }} +{{- fail "An identity provider is configured but secrets.betterAuthSecret is not. Sessions are signed with it and the server refuses to start without it. Generate one with: openssl rand -base64 32" }} +{{- end }} +{{- if and .Values.secrets.betterAuthSecret (lt (len .Values.secrets.betterAuthSecret) 32) }} +{{- fail "secrets.betterAuthSecret must be at least 32 characters. Generate one with: openssl rand -base64 32" }} +{{- end }} +{{- if not .Values.config.publicUrl }} +{{- fail "An identity provider is configured but config.publicUrl is not. Sign-in redirects come back to that address, so the server refuses to start without it." }} +{{- end }} +{{- end }} + +{{- /* + The same requirement, for a deployment whose secrets come from a store. + + The value itself is not readable at template time, but the LIST of keys is, and a store that never + mentions `better-auth-secret` cannot be holding one. Every shipped cloud `ci/` file was in this + state, so the refusal above passed and the pod still crash-looped. +*/}} +{{- if .Values.externalSecrets.enabled }} +{{- if or .Values.config.auth.google.clientId .Values.config.auth.microsoft.clientId .Values.config.auth.okta.clientId }} +{{- $named := list }} +{{- range .Values.externalSecrets.data }}{{- $named = append $named .secretKey }}{{- end }} +{{- if not (has "better-auth-secret" $named) }} +{{- fail "An identity provider is configured but externalSecrets.data does not name better-auth-secret. Sessions are signed with it and the server refuses to start without it." }} +{{- end }} +{{- end }} +{{- end }} diff --git a/charts/openbot/values.yaml b/charts/openbot/values.yaml new file mode 100644 index 00000000..dbb42f81 --- /dev/null +++ b/charts/openbot/values.yaml @@ -0,0 +1,391 @@ +# OpenBot, on any Kubernetes cluster. +# +# THE DEFAULTS ARE WHAT A PLAIN CLUSTER CAN DO. Every place the clouds genuinely differ is a value, +# and its default is whatever a self-hosted cluster with no cloud features does: the cluster's own +# default StorageClass, no RuntimeClass, a plain Kubernetes Secret, bundled PostgreSQL, an Ingress. +# A deployment on EKS, GKE or AKS turns things on; a self-hosted one changes nothing and still works. +# There is no cloud branching anywhere in the templates, and there should never be: a chart that only +# installs cleanly on a managed cluster has failed the thing this repository is for. + +nameOverride: "" +fullnameOverride: "" + +image: + repository: ghcr.io/copilotkit/openbot + # Empty means the chart's appVersion, so an upgrade of the chart moves the image with it. + tag: "" + pullPolicy: IfNotPresent +imagePullSecrets: [] + +server: + replicaCount: 2 + # Two by default because horizontal is the point. Everything that has to survive a replica is in + # PostgreSQL, and one replica hides every bug that is not. + + # THE BROWSER IS NOT IN THIS POD. The image runs a Bot's computer beside the API for the + # one-container case; a replica of the API must not carry one, because a browser is a few hundred + # megabytes holding one Bot's logins, and scaling the API would scale those with it. + embeddedComputer: false + + resources: + requests: + cpu: 250m + memory: 512Mi + limits: + memory: 2Gi + + # Off by default. Turn it on and set the metric you actually want to scale on. + autoscaling: + enabled: false + minReplicas: 2 + maxReplicas: 10 + targetCPUUtilizationPercentage: 70 + targetMemoryUtilizationPercentage: null + behavior: {} + + podDisruptionBudget: + enabled: true + minAvailable: 1 + maxUnavailable: null + + # Spread replicas so a node or zone going away does not take the deployment with it. Soft by + # default: a single-node cluster still schedules, which is what a first `helm install` runs on. + topologySpreadConstraints: [] + podAntiAffinity: soft + + nodeSelector: {} + tolerations: [] + affinity: {} + podAnnotations: {} + podLabels: {} + + service: + type: ClusterIP + port: 3001 + annotations: {} + # WHO MAY REACH IT, when the type is LoadBalancer. Empty means everybody, which is what a cloud + # load balancer does by default and almost never what somebody wants for an internal tool. Narrow + # it to the addresses your people come from. Not every cloud honours this on every load balancer + # type, so treat it as one layer rather than the only one. + loadBalancerSourceRanges: [] + + # Probes hit the API's own health route. + livenessProbe: + initialDelaySeconds: 20 + periodSeconds: 20 + timeoutSeconds: 5 + failureThreshold: 6 + readinessProbe: + initialDelaySeconds: 5 + periodSeconds: 10 + timeoutSeconds: 5 + failureThreshold: 3 + startupProbe: + periodSeconds: 5 + failureThreshold: 60 + +serviceAccount: + create: true + name: "" + # ONE MAP, THREE CLOUDS. IRSA on EKS, Workload Identity on GKE and on AKS are all annotations on a + # ServiceAccount, so this covers every one of them and the chart needs no idea which it is on. + # eks.amazonaws.com/role-arn: arn:aws:iam::<account>:role/<role> + # iam.gke.io/gcp-service-account: <name>@<project>.iam.gserviceaccount.com + # azure.workload.identity/client-id: <client-id> + annotations: {} + automountServiceAccountToken: false + +# The database migrations, run as a Job before the API starts. A pre-upgrade hook, so a rollout +# never puts a new replica in front of a schema it has not seen. +migrations: + enabled: true + backoffLimit: 3 + # How long to wait for the database to accept connections before giving up. A pre-install hook runs + # before the chart's own resources, so on a first install with the bundled database this Job starts + # before the database does. + waitForDatabaseSeconds: 300 + # A ceiling on the whole Job, so a migration that hangs fails the release rather than holding it. + activeDeadlineSeconds: 900 + # Kept on failure so somebody can read why. Helm deletes it before the next run. + resources: + requests: + cpu: 100m + memory: 256Mi + limits: + memory: 1Gi + +# What OpenBot needs to run. Anything secret belongs in `secrets` below, never here. +config: + # Where people reach this deployment. Sets the OAuth callback and the trusted origin. + publicUrl: "" + # Administrators by email address, comma-separated. Required unless singleUser is on. + initialAdminEmails: "" + # Every request is one fixed administrator. Local trials only; the deployment refuses to start + # with no identity provider unless this says somebody meant it. + singleUser: false + + # How people sign in. One of these, or `singleUser` above, and nothing else will do: the server + # refuses to start rather than serve a deployment where every visitor is an administrator. + # + # Client secrets go under `secrets` below. Only the public halves belong here. + auth: + google: + clientId: "" + microsoft: + clientId: "" + # `common` is Microsoft's own default and admits personal accounts as well as work ones. A + # company that means "our staff" puts its directory GUID here. + tenantId: "" + okta: + clientId: "" + issuer: "" + tenantPackageDir: /app/examples/fintech + + # CopilotKit Intelligence, which OpenBot requires. All four values are needed together: the server + # refuses to start on a partial set, deliberately, because a half-configured Intelligence is a + # mistake somebody made rather than a deployment that meant to run without one. + intelligence: + apiUrl: "" + gatewayWsUrl: "" + # The two secret halves live under `secrets` below, never here. + # Your own Bot, over AG-UI. + # + # OpenBot is a shell for somebody else's agent, so this is the seam that matters: point it at a + # service you run and coworkers created here reach it. Left empty, this deployment has only the + # Bots its tenant package declares as built-in, and a package entry whose endpoint resolves to + # nothing is dropped rather than registered as a coworker nobody can talk to. + # + # The address must be reachable from the server pod, so a Service in this cluster is named as + # `http://my-agent.my-namespace:8000/ag-ui`, not as localhost. + managedAgent: + url: "" + # The token travels in `secrets.managedAgentToken`. Required whenever a url is set: the server + # refuses to start with one and not the other, because an unauthenticated Bot endpoint is an + # open door to whatever that Bot can reach. + logLevel: "" + # Free-form additions, for anything this chart has no opinion about. + extraEnv: [] + extraEnvFrom: [] + +# How a Bot gets a computer. +# +# shared One browser for every Bot, run by this chart. Needs nothing installed in the cluster, +# and is what a first install should use. +# sandbox A computer each, as a `Sandbox` from kubernetes-sigs/agent-sandbox, suspended when +# idle and resumed with its logins intact. Needs that controller in the cluster. +# external Neither. `url` points at a computer somebody else runs. +computers: + mode: shared + # Only for `mode: external`. The other modes derive the address from what they created. + url: "" + # Never a literal. See `secrets` below. + existingTokenSecret: "" + + # gVisor or Kata, where the cluster has one. Unset means an ordinary pod, because the three clouds + # do not agree: GKE has managed gVisor, AKS offers Kata and gVisor, and on EKS it is bring your own + # node configuration. A chart that assumed a RuntimeClass would fail to install without one. + runtimeClassName: "" + + # How many browsers one computer holds at once, and how long an untouched one is kept. Empty means + # the process default, which is a handful and thirty minutes. + maxBrowsers: "" + browserIdleMs: "" + + persistence: + # EMPTY MEANS THE CLUSTER'S DEFAULT CLASS. Naming `gp3` or `pd-balanced` is how a chart stops + # installing on a bare-metal cluster. Note that the ordinary block volume on every cloud is + # zonal, so a computer is pinned to the zone its profile was created in. + storageClass: "" + profilesSize: 10Gi + workspaceSize: 10Gi + # What happens to a Bot's logins when the release is deleted. `Retain` keeps them, which is the + # safe default; `Delete` is for a trial you want to leave no trace of. + whenDeleted: Retain + + resources: + requests: + cpu: 500m + # Chromium is roughly 200-500MB headless and up to 2GB with real pages open. + memory: 1Gi + limits: + memory: 4Gi + + nodeSelector: {} + tolerations: [] + extraEnv: [] + + # `mode: sandbox` only. Where the per-Bot computers are created and what may create them. + sandbox: + # Refuse to install when the cluster has no Sandbox CRD, rather than succeeding and failing at + # the first browser action. Turn it off only where the CRD arrives after this chart does, such as + # a GitOps run that applies both together. + requireController: true + namespace: "" + # Pre-warmed sandboxes, so a Bot's first action after lunch does not wait for Chromium to boot. + warmPool: + enabled: false + replicas: 2 + # Suspend a computer nobody has used for this long. The Sandbox CRD has an absolute expiry, which + # is not the same question, so the culler below asks this one. + idleAfter: 30m + culler: + enabled: true + schedule: "*/5 * * * *" + +database: + # Used when `postgresql.enabled` is false. A URL, or a secret holding one. + # + # PUT `?sslmode=require` ON IT. Every managed database refuses an unencrypted connection: RDS has + # `rds.force_ssl` on by default, and Cloud SQL and Azure Database do the same. Without it the + # migration fails with `no pg_hba.conf entry for host ... no encryption`, which names the host and + # the user and not the actual problem. + # + # postgres://user:password@host:5432/openbot?sslmode=require + # + # Keep it in a Secret rather than here: `url` is readable by anybody who can read the release. + url: "" + existingSecret: "" + existingSecretKey: "database-url" + +# The bundled database. Off by default in favour of a managed one. +# The bundled database. +# +# NOT PRODUCTION-GRADE, AND OFF FOR THAT REASON. A database on a pod is a database that goes away +# when the pod does: a rollout, a node drain or an evicted pod is a restart, and while the volume +# survives, nothing about this shape gives you backups, failover, point-in-time recovery or a +# connection that outlives the release. It exists so somebody can try OpenBot in one command. +# +# A REAL DEPLOYMENT POINTS `database` ABOVE AT A MANAGED DATABASE: RDS, Cloud SQL, Azure Database, or +# your own server. That is the same line the Intelligence chart draws, and for the same reason. +postgresql: + enabled: false + auth: + # THE SUPERUSER, DELIBERATELY, AND ONLY FOR THIS BUNDLED DATABASE. + # + # The first migration runs `CREATE EXTENSION vector` and a later one drops it again, and only a + # superuser can do either. An ordinary role fails the install at migration one with "permission + # denied to create extension", which reads like a broken chart rather than a database privilege. + # + # This is the shape `docker-compose.yml` already ships, where the app user is the cluster + # superuser, and it is safe for the same reason: this database exists for this release alone and + # nothing else can reach it. + # + # A MANAGED DATABASE IS NOT THIS. On RDS, Cloud SQL or Azure there is no superuser to hand out, + # so create the extension once as the administrative role and grant the migrating role ownership + # of it. `CREATE EXTENSION IF NOT EXISTS` then passes for an ordinary user. + username: postgres + database: openbot + # SET ONE, OR UPGRADES FAIL. The subchart generates a password on install and then refuses to + # render on upgrade unless it is given the current one, which turns the second `helm upgrade` + # into an error about credentials. A password you chose, or a Secret you made, makes the release + # repeatable. The chart refuses to install without one rather than letting you find out later. + password: "" + existingSecret: "" + image: + # Bitnami moved its unsupported images to this frozen mirror. Nothing new lands here, so the tag + # is named rather than inherited from the subchart: with it inherited, bumping the subchart + # silently asks for an image the mirror does not have, and the chart still renders perfectly. + repository: bitnamilegacy/postgresql + tag: 17.6.0-debian-12-r4 + primary: + # PINNED, BECAUSE THE SHIPPED DEFAULT ADMITS EVERYTHING. + # + # The subchart renders its NetworkPolicy whether or not this chart's own is enabled, and with + # `allowExternal: true` its ingress rule carries no `from` at all: any pod in any namespace may + # open 5432. That includes a Bot's computer, the one pod running a browser on pages a person + # named and a shell on commands a model chose. Compose has kept the database off the Bot's + # network since the beginning; this is the same boundary in the other deployment's words. + # + # With this off, the database admits pods labelled `<release>-postgresql-client`, which the API + # server carries and nothing else does. + networkPolicy: + allowExternal: false + allowExternalEgress: false + persistence: + enabled: true + # EMPTY MEANS THE CLUSTER'S DEFAULT CLASS, and that is deliberate. Naming `gp3` or + # `pd-balanced` here is exactly how a chart stops installing on somebody's bare-metal cluster. + storageClass: "" + size: 20Gi + +# Secrets, without picking a vendor. +# +# A plain Kubernetes Secret is the default because that is what a self-hosted cluster has. +# `externalSecrets` turns the same fields into an ExternalSecret instead, so Secrets Manager, Secret +# Manager and Key Vault are a values block rather than three code paths. +secrets: + # Point at a Secret you made yourself, and the chart creates none. + existingSecret: "" + # Created by the chart when `existingSecret` is empty. Pass with --set-string or a values file that + # is not in version control; `KEY_ENCRYPTION_KEY` and the model credential are the two that matter + # and neither should ever be a literal in a file anybody commits. + keyEncryptionKey: "" + betterAuthSecret: "" + modelApiKey: "" + computerToken: "" + supervisorToken: "" + intelligenceApiKey: "" + licenseToken: "" + # Sent to `config.managedAgent.url` on every call. Required when that url is set. + managedAgentToken: "" + # The client secret for whichever provider is configured above. + googleClientSecret: "" + microsoftClientSecret: "" + oktaClientSecret: "" + +externalSecrets: + enabled: false + # Whatever your cluster's ClusterSecretStore or SecretStore is called. Backend-agnostic on purpose. + secretStoreRef: + name: "" + kind: ClusterSecretStore + refreshInterval: 1h + # remoteRef keys, one per secret this chart reads. + data: [] + +ingress: + enabled: false + # The controller differs on every cluster and always will, so this is a value with no default. + className: "" + annotations: {} + hosts: + - host: openbot.example.com + paths: + - path: / + pathType: Prefix + tls: [] + +# Gateway API, as an alternative rather than a replacement. Plenty of self-hosted clusters still run +# an Ingress controller, so both are here and neither is assumed. +httpRoute: + enabled: false + parentRefs: [] + hostnames: [] + +networkPolicy: + enabled: false + # Where the API may reach out to. A deployment with a managed database adds its CIDR here. + # + # It already reaches HTTP and HTTPS everywhere outside the cluster's private ranges, because that + # is where Intelligence, sign-in and the Bots are. This is for anything on the private side. + extraEgress: [] + extraIngress: [] + # `computers.mode: sandbox` only. The service range the Kubernetes API server answers on, so the + # rule that lets the API ask for a Bot's computer can name it instead of being left open. + # + # Empty means unscoped, which is the only thing a chart can do by default: the range is the + # cluster's, not the release's. `kubectl get svc kubernetes -o jsonpath='{.spec.clusterIP}'` shows + # which one yours is on; on EKS it is usually 172.20.0.0/16, on GKE and kubeadm 10.96.0.0/12. + kubernetesApiCidr: "" + # Where a Bot's computer may reach beyond the public internet. A deployment whose Bots must reach + # an internal site adds it here, one address at a time, rather than reopening the private ranges. + computerExtraEgress: [] + +podSecurityContext: + runAsNonRoot: false + fsGroup: null +securityContext: {} + +# Applied to every pod this chart creates. +commonLabels: {} +commonAnnotations: {} diff --git a/docker-compose.yml b/docker-compose.yml index e2e7cfbc..e89f4f93 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -61,9 +61,24 @@ services: # Loopback only. This process drives a browser holding real logins; COMPUTER_TOKEN is the # request control, and loopback keeps the surface off routed networks. - "127.0.0.1:${COMPUTER_PORT:-4100}:4100" + # Per-Bot egress, in a file of its own because the names are not knowable here. + # + # `EGRESS_PROXY_<BOT>` is derived from the Bot's id, so there is no fixed list to write out the + # way COMPUTER_TOKEN is. Not `.env`: that holds the deployment's secrets, and this container + # drives a browser and runs a Bot's shell, so it is given what it needs and not the rest. + # Optional, because going out directly is the ordinary case and must still start. + env_file: + - path: ./egress.env + required: false environment: # The secret every caller must present. The container refuses to start without it. - COMPUTER_TOKEN: ${COMPUTER_TOKEN:-} + # + # The default matches the one scripts/start.sh applies when .env leaves this blank, which + # .env.example does. Without it the two paths disagree: the script exports a value and brings + # the stack up working, while a plain `docker compose up -d` -- which this project's own + # shutdown notes tell you to use -- hands the container an empty string instead. Reaches only + # a loopback-bound port; a deployment sets a real value in .env. + COMPUTER_TOKEN: ${COMPUTER_TOKEN:-openbot-dev-computer-token} # How many Bots may hold a running browser at once, and how long an untouched one is kept. # A few hundred MB each, so on a deployment with many Bots these are the difference between # a container that holds steady and one that is killed for memory. Defaults are 8 and 30 @@ -143,13 +158,20 @@ services: build: context: . dockerfile: supervisor/Dockerfile + # The same file, because this process does not read these itself: it forwards every EGRESS_PROXY + # key out of its own environment into each computer it creates, so it has to be given them first. + env_file: + - path: ./egress.env + required: false environment: PORT: "4300" # Shared with the API server. The Bot-level verb set is the boundary; this token keeps other # services on the network from calling those verbs. - SUPERVISOR_TOKEN: ${SUPERVISOR_TOKEN:-} + # Defaulted for the same reason as agent-computer's above: so `docker compose up -d` by hand + # configures the same stack scripts/start.sh does, rather than a silently unauthenticated one. + SUPERVISOR_TOKEN: ${SUPERVISOR_TOKEN:-openbot-dev-supervisor-token} # Handed to every computer this creates, so the server and the computers share one secret. - COMPUTER_TOKEN: ${COMPUTER_TOKEN:-} + COMPUTER_TOKEN: ${COMPUTER_TOKEN:-openbot-dev-computer-token} COMPUTER_IMAGE: ${COMPUTER_IMAGE:-openbot-agent-computer:latest} # Which deployment the computers it creates belong to, so two stacks on one Docker host never # derive the same container and volume names for the same Bot. diff --git a/docker/s6/s6-rc.d/computer/run b/docker/s6/s6-rc.d/computer/run index 77989bda..d671a813 100755 --- a/docker/s6/s6-rc.d/computer/run +++ b/docker/s6/s6-rc.d/computer/run @@ -1,8 +1,21 @@ #!/command/with-contenv sh # The Bot's browser. Bound to loopback: its only caller is the API beside it. # +# `EMBEDDED_COMPUTER=on` is the default, because one container that just works is what this image is +# for. Off, this service exits 0 immediately and s6 leaves it alone, the same way `postgres` does, +# and the API reaches a computer elsewhere through `AGENT_COMPUTER_URL` or a supervisor. +# +# That switch is what lets this image be a stateless replica. A browser is a few hundred megabytes of +# memory holding one Bot's logins, so an API pod carrying one is neither stateless nor cheap to run +# several of: scaling the API would scale the browsers with it, and every replica would hold a +# profile directory that matters to exactly one Bot. +# # `with-contenv` is not decoration. Without it s6 starts a service with none of the container's # environment, and the failure is a config error naming a variable that is plainly set. +set -eu +if [ "${EMBEDDED_COMPUTER:-on}" != "on" ]; then + exec /bin/true +fi cd /app/agent-computer export PORT=4100 export WORKSPACE_DIR=/workspace diff --git a/docker/s6/scripts/migrate.sh b/docker/s6/scripts/migrate.sh index 3a71d4df..6776b1e2 100755 --- a/docker/s6/scripts/migrate.sh +++ b/docker/s6/scripts/migrate.sh @@ -8,4 +8,7 @@ set -eu [ "${EMBEDDED_POSTGRES:-off}" = "on" ] || exit 0 cd /app/server -exec s6-setuidgid pwuser /usr/local/bin/bun x drizzle-kit migrate --config=drizzle.config.ts +# `scripts/migrate.ts`, not `drizzle-kit`. The CLI is a development dependency and needs esbuild to +# read its TypeScript config, which `bun install --production` leaves out of this image: asked to +# migrate here it exits 1 without printing why, and the container comes up against an empty database. +exec s6-setuidgid pwuser /usr/local/bin/bun scripts/migrate.ts diff --git a/docs/README.md b/docs/README.md index 7392c968..e850f9ee 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,6 +8,7 @@ Start with the root [README](../README.md), then use these references: - [Coworkers](coworkers.md): durable Bot profiles, channels, visibility, deletion, and external AG-UI registration. - Plugins, one connector per page — what an administrator registers, what each person consents to, and what the failures mean: - [Google Drive](plugins/google-drive.md) + - [Notion](plugins/notion.md) - [Deployment](deployment.md): the container, what is in the image, minimum sizes, and the platform notes. - [Releasing](releasing.md): how a release is proposed, reviewed and published. diff --git a/docs/architecture.md b/docs/architecture.md index e8dc5a5c..46072940 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -138,9 +138,9 @@ MCP servers and skills share the plugin grant table, but they have different own - MCP tools are admin-governed because they can reach external systems with stored credentials. - Skills are reusable instructions. A person can create personal skills and attach them only to Bots they own. Administrators create deployment skills. -The curated MCP catalogue contains Google Drive. Custom MCP servers must pass URL checks; unknown tools and custom-server tools are treated as writes unless positively classified as reads. +The curated MCP catalogue contains Google Drive and Notion. Custom MCP servers must pass URL checks; unknown tools and custom-server tools are treated as writes unless positively classified as reads. -A catalogue entry says whose credential a Bot reaches it with, which is a different question from whether it is reachable at all. A deployment-wide token answers the same for everybody; Google Drive is `user-oauth`, so a Bot reads it as the person asking and sees only what that person can see. An administrator enabling the connector and a person connecting their own account are two decisions, and neither can be made for the other. See [Google Drive](plugins/google-drive.md). +A catalogue entry says whose credential a Bot reaches it with, which is a different question from whether it is reachable at all. A deployment-wide token answers the same for everybody; Google Drive and Notion are both `user-oauth`, so a Bot reaches them as the person asking and sees only what that person can see. An administrator enabling the connector and a person connecting their own account are two decisions, and neither can be made for the other. See [Google Drive](plugins/google-drive.md) and [Notion](plugins/notion.md). Every MCP call checks the grant first, then evaluates the same action policy engine with MCP context, then audits the result. diff --git a/docs/configuration.md b/docs/configuration.md index be7ff85b..a8291d3c 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -191,8 +191,8 @@ where `<provider>` is `google`, `microsoft` or `okta`. - `WORKSPACE_DIR` - `PROFILES_DIR` - `COMPUTER_BOT_ID` -- `EGRESS_PROXY_DEFAULT` -- `EGRESS_PROXY_<BOT_ID>` +- `EGRESS_PROXY_DEFAULT` (in `egress.env`, see below) +- `EGRESS_PROXY_<BOT_ID>` (in `egress.env`, see below) - `COMPUTER_SHELL_ENV` A command on the computer inherits PATH, locale and terminal names, and the proxy variables, not @@ -200,6 +200,24 @@ the rest of the process environment. Userinfo is stripped from a proxy URL, so a `HTTP_PROXY` is not in `env`. `COMPUTER_SHELL_ENV` is a comma-separated list of extra names to pass. Naming a secret or a credentialed proxy there is an operator's decision; the default does not. +### Per-Bot egress + +The two egress variables live in `egress.env` at the repository root, not in `.env`. `EGRESS_PROXY_<BOT_ID>` +is derived from a Bot's id, so there is no fixed set of names for Compose to list the way it lists +every other variable, and Compose passes a container only the names it is given. A file of its own +rather than `.env` because that one holds the deployment's secrets and neither the browser container +nor the supervisor is given those. + +```sh +# egress.env +EGRESS_PROXY_DEFAULT=http://user:password@proxy.internal:8080 +EGRESS_PROXY_SALES_BOT=http://sales.proxy.internal:8080 +``` + +The file is optional and gitignored. Without it every Bot's browser goes out directly, which is the +default. Both the shared computer and the supervisor are given it: the computer resolves its own +proxy from these names, and the supervisor forwards them into each computer it creates. + The supervisor also reads: - `COMPUTER_IMAGE` diff --git a/docs/deployment.md b/docs/deployment.md index 830827d0..14164094 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -135,3 +135,9 @@ which makes them the shortest path from nothing to a running deployment. **The image is 5.3 GB**, most of it the Playwright base, which ships Firefox and WebKit alongside the Chromium we use. Deleting them afterwards does not help, because the bytes still ship in the layer below. Building Chromium-only onto a slim base would cut this substantially and is not done yet. + +**A strict content-security-policy needs a hash or a nonce.** `app/index.html` runs a small inline +script that decides the theme before the first paint. Nothing in this repo sends a CSP header, so it +works as shipped; a deployment that adds one at its proxy has to allow that script explicitly, or +`script-src` blocks it and the page renders with the wrong theme until the app boots. A `'sha256-'` +hash of the script body is the version that survives a rebuild without a per-request nonce. diff --git a/docs/plugins/notion.md b/docs/plugins/notion.md new file mode 100644 index 00000000..44bb1331 --- /dev/null +++ b/docs/plugins/notion.md @@ -0,0 +1,79 @@ +# Notion + +A Bot with this connector granted reaches Notion **as the person asking**, through the hosted MCP +server Notion runs at `mcp.notion.com`, on the catalogue's default MCP transport. Two people asking +the same question get the pages their own accounts can see, and neither sees anything they could not +open themselves. Unlike Google Drive, this connector ships both read and write tools: the writing +tools are named in the catalogue, and the action policy governs every call the same as any other +plugin tool. + +Setting it up takes two people, and neither can do the other's half: + +| Who | Does | Where | +| ----------------- | ------------------------------------------- | ----------------------------- | +| An administrator | Enables the connector | `/admin/plugins/notion` | +| Each person | Consents with their own Notion account | `/settings/connected-accounts` | + +There is deliberately no endpoint for an administrator to connect an account on somebody's behalf. + +## What an administrator does + +### 1. Enable the connector in OpenBot + +At `/admin/plugins/notion`, turn on **Enable for this deployment**. There is no client to register +and no secret to paste: this deployment introduces itself to Notion on first connect, over RFC 7591 +dynamic client registration. The prerequisite is a public URL the redirect URI can be derived from — +`OPENBOT_PUBLIC_URL` if it is set, or the auth base URL it falls back to otherwise — nothing needs to +be registered at Notion ahead of time. + +### 2. Connect your own account + +On the same page, use **Your account** to connect your own Notion account before doing anything +else here. Unlike Google Drive's tool list, which is OpenBot's own code and needs no credential to +read, this connector's tool list is an answer from Notion's hosted server: refreshing it takes a +credential, and the refresh in the next step mints one from the connection belonging to whoever +presses the button — not whichever account happens to be connected here. That is a personal grant +like anybody else's, reaching only what your own account can see — not deployment configuration — +but it has to come first, because an administrator who presses Refresh tools without having +connected their own account is refused, not lent someone else's. + +### 3. Press Refresh tools + +This records the tool list Notion's hosted server advertises today, both reads and writes. + +Notion has **no read-only scope**. Access is granted per page, at the moment somebody consents, not +by a scope string the way Google's `drive.readonly` is — so there is nothing at the vendor standing +behind a tool's read-or-write classification. The catalogue's write-tool list, plus the action +policy, is the **entire** write barrier for this connector. + +That makes reconciling the catalogue's write-tool names against what the live list actually calls +them, on this first refresh, required rather than cosmetic. A name that has changed at the vendor is +the dangerous direction, not a safe one: `classifyTool` reads a tool Notion advertises but that no +longer matches an entry in the write list as a **read**, so an uncorrected rename quietly turns a +write into something the policy will pass through. The safe direction runs the other way — a tool +name the server never advertised at all still classifies as a write — but that is not the case this +refresh exists to catch. + +### 4. Grant tools to a Bot + +Enabling the connector does not give any Bot access to it. Each tool is granted per Bot, the same as +every other plugin tool. Every call then checks the grant, evaluates the action policy, and writes an +audit row. + +## What each person does + +At `/settings/connected-accounts`, Notion appears once an administrator has enabled it. Open it and +press **Connect**. That leaves OpenBot for Notion's own consent screen — the arrow on the button says +so — where the pages and databases to share are chosen, and returns to the same page, which then +reads **Connected**. + +Nothing is cached. OpenBot stores the refresh token and mints a short-lived access token for each +call, so withdrawing access at Notion takes effect on the next call rather than whenever a cache +expires. + +## See also + +- [Architecture](../architecture.md) — where plugins, grants, policy and audit sit. +- [Configuration](../configuration.md) — `OPENBOT_PUBLIC_URL`, `OPENBOT_APP_URL`, `KEY_ENCRYPTION_KEY`. +- [Notion's own guide](https://developers.notion.com/guides/mcp/build-mcp-client) to building an MCP + client against its hosted server. diff --git a/examples/fintech/skills.yaml b/examples/fintech/skills.yaml index b651e589..24a1cca4 100644 --- a/examples/fintech/skills.yaml +++ b/examples/fintech/skills.yaml @@ -17,8 +17,8 @@ # file may name tools for connectors this deployment has not added, and should — that is what makes # them work the moment somebody does. # -# Refs are `<serverId>/<toolName>`, the same form a grant is written in. `google-drive` is the -# catalogue connector; a server an administrator adds by URL uses the id it was given. +# Refs are `<serverId>/<toolName>`, the same form a grant is written in. `google-drive` and `notion` +# are catalogue connectors; a server an administrator adds by URL uses the id it was given. skills: - slug: find-a-document title: Find a document @@ -33,6 +33,18 @@ skills: - google-drive/read_file_content - google-drive/get_file_metadata + - slug: find-a-notion-page + title: Find a Notion page + summary: Search Notion for a page and read what it says. + instructions: >- + Find the Notion page the person is asking about before answering anything about its contents. + Search first, then fetch the page you found rather than answering from its title. If the search + returns nothing, say so and say what you searched for, rather than guessing at what the page + might contain. Name the page you used. + tools: + - notion/notion-search + - notion/notion-fetch + - slug: whats-changed title: What changed recently summary: List recently changed documents and say who changed them and when. diff --git a/scripts/check-rendered-chart.ts b/scripts/check-rendered-chart.ts new file mode 100644 index 00000000..dc5de112 --- /dev/null +++ b/scripts/check-rendered-chart.ts @@ -0,0 +1,168 @@ +/** + * Is this rendered chart coherent with itself? + * + * Rendering proves the templates run. It does not prove the result works, and the way it fails is + * quiet: a container names a secret key, the chart writes a Secret without it, and nothing says so + * until a pod starts somewhere nobody is watching. Every shipped `ci/` target was in that state, on + * the value that signs sessions, which is why the server could not start on any of them. + * + * Deliberately not a schema validator. Kubernetes already rejects malformed objects and a schema + * check needs a cluster or a pinned bundle of CRDs; what it cannot see is whether the pieces this + * chart writes agree with each other. + */ +const [file] = process.argv.slice(2); +if (!file) { + console.error("usage: check-rendered-chart.ts <rendered.yaml>"); + process.exit(2); +} + +const text = await Bun.file(file).text(); +const documents = text + .split(/^---$/m) + .map((chunk) => chunk.trim()) + .filter((chunk) => chunk.length > 0 && !/^(#[^\n]*\n?)*$/.test(chunk)); + +if (documents.length === 0) { + console.error(`${file} rendered nothing.`); + process.exit(1); +} + +const problems: string[] = []; + +/** + * Which Secret holds which keys, read from the text rather than parsed. + * + * A YAML parser is a dependency this check does not need: both halves of the question are single + * lines at known indentation, and a rendered chart is machine-written, so the shapes do not vary. + */ +const written = new Map<string, Set<string>>(); +for (const document of documents) { + if (!/^kind:\s*Secret\s*$/m.test(document)) continue; + const name = document.match(/^\s{2}name:\s*(\S+)/m)?.[1]; + if (!name) continue; + const keys = new Set<string>(); + // `stringData` or `data`: a subchart writes base64 under the second, and a key is a key either way. + const body = document.split(/^(?:stringData|data):\s*$/m)[1] ?? ""; + for (const line of body.split("\n")) { + const key = line.match(/^\s{2}([a-z0-9-]+):/)?.[1]; + if (key) keys.add(key); + } + written.set(name.replace(/^["']|["']$/g, ""), keys); +} + +/** + * Every key a container asks for, and whether anything writes it. + * + * Only checked against Secrets this chart renders. A Secret that comes from outside, or from a + * store, is not readable here, and refusing on a guess would fail installs that are fine. + */ +const demands = [ + ...text.matchAll( + /secretKeyRef:\s*\n\s*name:\s*(\S+)\s*\n\s*key:\s*([A-Za-z0-9._-]+)(?:\s*\n\s*optional:\s*(true|false))?/g, + ), +]; + +/* + * A check that finds nothing is not a check that passed. + * + * Every one of these questions is asked by matching text, and text moves: rename a field, reindent a + * template, and the pattern quietly stops matching. The result is a green tick that means "I looked + * at nothing", which is worse than no check at all because somebody trusts it. Every target this + * chart has renders a Deployment that reads secrets, so zero is always wrong. + */ +if (demands.length === 0) { + console.error( + "::error::This check found no secretKeyRef at all, which cannot be right. Its patterns have stopped matching the rendered output.", + ); + process.exit(1); +} +/* + * Unless the Secret is somebody else's. A deployment pointing at an existing Secret, or at a store + * through an ExternalSecret, renders none of its own, and there is nothing here to compare against. + * That is a legitimate shape, not a broken pattern. + */ +const secretComesFromOutside = + text.includes("kind: ExternalSecret") || text.includes("existingSecret"); +if (written.size === 0 && !secretComesFromOutside) { + console.error( + "::error::This check found no rendered Secret to compare against. Its patterns have stopped matching the rendered output.", + ); + process.exit(1); +} +let skippedOptional = 0; +for (const [, rawName, rawKey, optional] of demands) { + /* + * An optional key absent from the Secret is the deployment saying it does not need it, which is a + * legitimate shape rather than a fault. It is worth counting out loud: a key that is optional when + * it should not be is exactly how a required value went missing and was invisible here. + */ + if (optional === "true") { + skippedOptional += 1; + continue; + } + const name = rawName.replace(/^["']|["']$/g, ""); + const key = rawKey.replace(/^["']|["']$/g, ""); + const keys = written.get(name); + if (!keys) continue; + if (!keys.has(key)) { + problems.push( + `A container needs "${key}" from Secret "${name}", which this chart renders without it.`, + ); + } +} + +/** + * Anything the chart writes and nothing reads. + * + * The mirror of the above, and the reason a key gets quietly dropped from an environment: the + * Secret keeps carrying it and nobody notices the variable went. + */ +for (const [name, keys] of written) { + for (const key of keys) { + if (!text.includes(`key: ${key}`)) { + problems.push( + `Secret "${name}" carries "${key}", which nothing in this render reads.`, + ); + } + } +} + +/** + * A policy that fences the API off from the services it cannot work without. + * + * The same question as the Secret one above, asked of the other thing a render can be internally + * wrong about: this chart requires CopilotKit Intelligence and an identity provider, reaches both + * over HTTPS at hostnames, and also writes the rule that says where the API may go. Those two had + * never been compared. The server's egress named DNS, the database and the computers, so on any + * cluster that enforces policy nobody could sign in and no conversation ran — and the pod stayed + * Ready throughout, because `/health` answers from a literal. + * + * Asked of the rendered object rather than the template, because the rule that covered for this was + * conditional on `computers.mode` and only one mode ever had it. + */ +const serverPolicy = documents.find( + (document) => + /^kind:\s*NetworkPolicy\s*$/m.test(document) && + /app\.kubernetes\.io\/component:\s*server/.test(document), +); +if (serverPolicy) { + const egress = serverPolicy.split(/^\s{2}egress:\s*$/m)[1] ?? ""; + if (!/port:\s*443\b/.test(egress)) { + problems.push( + "The server's NetworkPolicy has no egress on 443, so the API cannot reach Intelligence or an identity provider. Nothing would report it: /health answers from a literal and every probe reads it.", + ); + } +} + +if (problems.length > 0) { + for (const problem of problems) console.error(`::error::${problem}`); + process.exit(1); +} + +console.log( + `${documents.length} objects, ${demands.length} secret keys demanded, and every required one is written.` + + (serverPolicy ? " The server's egress reaches 443." : "") + + (skippedOptional > 0 + ? ` ${skippedOptional} optional key${skippedOptional === 1 ? " was" : "s were"} not checked.` + : ""), +); diff --git a/scripts/start.sh b/scripts/start.sh index 20536095..54831826 100755 --- a/scripts/start.sh +++ b/scripts/start.sh @@ -111,21 +111,65 @@ holder() { lsof -nP -iTCP:"$1" -sTCP:LISTEN -Fcn 2>/dev/null | awk '/^c/{c=substr($0,2)} /^n/{print c" ("substr($0,2)")"; exit}' || true } +# Does whatever holds this port answer as OpenBot, rather than merely answer? +# +# `curl -f` proves something is listening and returned 2xx. That is not the same claim, and the gap +# between them is not academic: any single-page app serves its own index.html for every path it does +# not recognise, so an unrelated dashboard sitting on a default port answers 200 to +# `/api/capabilities` as readily as this server does. +# +# When that happened here the cost was not a wrong answer, it was a wrong answer three stages later. +# `require_free_or_ours` reported "already up", the server was therefore never started, `wait_for` +# printed a green "server ready", and the run died at stage 3 in `json.loads` on a mouthful of HTML — +# a JSON parse error standing in for "that port belongs to something else". +# +# So each surface is asked for something only it can produce. +identifies_as_openbot() { + local port="$1" name="$2" + case "$name" in + # A field of this server's own payload. A stray 200 does not carry it. + server) + curl -fsS --max-time 3 "http://localhost:$port/api/copilotkit/info" 2>/dev/null \ + | grep -q '"licenseStatus"' + ;; + # The app is static HTML with nothing to interrogate, so its title is the identity available. + app) + curl -fsS --max-time 3 "http://localhost:$port/" 2>/dev/null \ + | grep -qi '<title>[^<]*OpenBot' + ;; + # Compose services on dedicated loopback ports, answering a route named for this stack. + *) + curl -fsS --max-time 3 "http://localhost:$port/health" >/dev/null 2>&1 + ;; + esac +} + require_free_or_ours() { local port="$1" name="$2" who who="$(holder "$port")" [ -z "$who" ] && return 0 - if curl -fsS --max-time 3 "http://localhost:$port/health" >/dev/null 2>&1 \ - || curl -fsS --max-time 3 "http://localhost:$port/api/capabilities" >/dev/null 2>&1 \ - || curl -fsS --max-time 3 "http://localhost:$port/" >/dev/null 2>&1; then + if identifies_as_openbot "$port" "$name"; then info " $name: already up on $port ($who)" return 0 fi - red " $name: port $port is held by something else: $who" + red " $name: port $port is held by something that is not OpenBot: $who" red " Re-run with ${name^^}_PORT=<free port>, or stop that process yourself." exit 1 } +# As wait_for, but satisfied only by OpenBot answering, not by anything answering. +wait_for_openbot() { + local port="$1" name="$2" tries="${3:-40}" + for _ in $(seq 1 "$tries"); do + identifies_as_openbot "$port" "$name" && { green " $name ready"; return 0; } + sleep 1 + done + red " $name never answered as OpenBot on port $port" + red " Either it failed to start, or that port belongs to another process." + red " Log: $LOGS/${name}.log" + exit 1 +} + wait_for() { local url="$1" name="$2" tries="${3:-40}" for _ in $(seq 1 "$tries"); do @@ -214,7 +258,7 @@ if [ "$SECRETS_ROTATED" = "true" ]; then pkill -f "bun --env-file=../.env src/index.ts" >/dev/null 2>&1 || true sleep 1 fi -if ! curl -fsS --max-time 3 "http://localhost:$SERVER_PORT/api/capabilities" >/dev/null 2>&1; then +if ! identifies_as_openbot "$SERVER_PORT" server; then if [ "$ONE_COMPUTER_EACH" = "true" ]; then (cd server && PORT="$SERVER_PORT" \ COMPUTER_SUPERVISOR_URL="http://localhost:$SUPERVISOR_PORT" \ @@ -225,7 +269,7 @@ if ! curl -fsS --max-time 3 "http://localhost:$SERVER_PORT/api/capabilities" >/d (cd server && PORT="$SERVER_PORT" bun --env-file=../.env src/index.ts >"$LOGS/server.log" 2>&1 &) fi fi -wait_for "http://localhost:$SERVER_PORT/api/capabilities" "server" +wait_for_openbot "$SERVER_PORT" server info "3/4 Runtime health" INFO="$(curl -fsS --max-time 8 "http://localhost:$SERVER_PORT/api/copilotkit/info")" @@ -246,10 +290,10 @@ PY info "4/4 App" require_free_or_ours "$APP_PORT" app -if ! curl -fsS --max-time 3 "http://localhost:$APP_PORT/" >/dev/null 2>&1; then +if ! identifies_as_openbot "$APP_PORT" app; then (cd app && bun run dev --port "$APP_PORT" --strictPort >"$LOGS/app.log" 2>&1 &) fi -wait_for "http://localhost:$APP_PORT/" "app" +wait_for_openbot "$APP_PORT" app cat <<EOF diff --git a/server/drizzle.config.ts b/server/drizzle.config.ts index 24e6775d..a0fdf026 100644 --- a/server/drizzle.config.ts +++ b/server/drizzle.config.ts @@ -23,6 +23,7 @@ export default defineConfig({ "./src/db/schema/coworker.ts", "./src/db/schema/components.ts", "./src/db/schema/plugins.ts", + "./src/db/schema/work.ts", ], out: "./drizzle", dbCredentials: { diff --git a/server/drizzle/0016_pin_and_soft_delete_channels.sql b/server/drizzle/0016_pin_and_soft_delete_channels.sql new file mode 100644 index 00000000..f1ca6d46 --- /dev/null +++ b/server/drizzle/0016_pin_and_soft_delete_channels.sql @@ -0,0 +1,2 @@ +ALTER TABLE "channel_memberships" ADD COLUMN "pinned_at" timestamp with time zone;--> statement-breakpoint +ALTER TABLE "channels" ADD COLUMN "deleted_at" timestamp with time zone; \ No newline at end of file diff --git a/server/drizzle/0017_durable_work.sql b/server/drizzle/0017_durable_work.sql new file mode 100644 index 00000000..c03aaa11 --- /dev/null +++ b/server/drizzle/0017_durable_work.sql @@ -0,0 +1,16 @@ +CREATE TABLE "work_items" ( + "kind" text NOT NULL, + "key" text NOT NULL, + "run_at" timestamp with time zone DEFAULT now() NOT NULL, + "claimed_by" text, + "lease_until" timestamp with time zone, + "attempts" integer DEFAULT 0 NOT NULL, + "finished_at" timestamp with time zone, + "last_error" text, + "payload" jsonb DEFAULT '{}'::jsonb NOT NULL, + "created_at" timestamp with time zone DEFAULT now() NOT NULL, + "updated_at" timestamp with time zone DEFAULT now() NOT NULL, + CONSTRAINT "work_items_kind_key_pk" PRIMARY KEY("kind","key") +); +--> statement-breakpoint +CREATE INDEX "work_items_claimable_idx" ON "work_items" USING btree ("kind","run_at"); \ No newline at end of file diff --git a/server/drizzle/0018_page_frames.sql b/server/drizzle/0018_page_frames.sql new file mode 100644 index 00000000..1c301bf2 --- /dev/null +++ b/server/drizzle/0018_page_frames.sql @@ -0,0 +1,11 @@ +CREATE TABLE "computer_page_frame" ( + "computer_id" text NOT NULL, + "tool_call_id" text NOT NULL, + "url" text NOT NULL, + "title" text, + "frame" text NOT NULL, + "captured_at" timestamp with time zone DEFAULT now() NOT NULL, + CONSTRAINT "computer_page_frame_computer_id_tool_call_id_pk" PRIMARY KEY("computer_id","tool_call_id") +); +--> statement-breakpoint +CREATE INDEX "computer_page_frame_captured_idx" ON "computer_page_frame" USING btree ("captured_at"); \ No newline at end of file diff --git a/server/drizzle/0019_channel_read_marker.sql b/server/drizzle/0019_channel_read_marker.sql new file mode 100644 index 00000000..81128352 --- /dev/null +++ b/server/drizzle/0019_channel_read_marker.sql @@ -0,0 +1 @@ +ALTER TABLE "channel_memberships" ADD COLUMN "last_read_at" timestamp with time zone; \ No newline at end of file diff --git a/server/drizzle/meta/0016_snapshot.json b/server/drizzle/meta/0016_snapshot.json new file mode 100644 index 00000000..714e5982 --- /dev/null +++ b/server/drizzle/meta/0016_snapshot.json @@ -0,0 +1,2395 @@ +{ + "id": "8e5982ba-c8e3-4634-a05c-68a90e066dac", + "prevId": "8f1f91d5-9cb1-490a-a28f-a0a3f15b9614", + "version": "7", + "dialect": "postgresql", + "tables": { + "public.accounts": { + "name": "accounts", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "account_id": { + "name": "account_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "provider_id": { + "name": "provider_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "issuer": { + "name": "issuer", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "access_token": { + "name": "access_token", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "refresh_token": { + "name": "refresh_token", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "id_token": { + "name": "id_token", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "access_token_expires_at": { + "name": "access_token_expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "refresh_token_expires_at": { + "name": "refresh_token_expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "scope": { + "name": "scope", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "password": { + "name": "password", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "accounts_provider_account_idx": { + "name": "accounts_provider_account_idx", + "columns": [ + { + "expression": "provider_id", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "account_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "accounts_user_id_users_id_fk": { + "name": "accounts_user_id_users_id_fk", + "tableFrom": "accounts", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.agents": { + "name": "agents", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "type": { + "name": "type", + "type": "agent_type", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "configuration": { + "name": "configuration", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "package_id": { + "name": "package_id", + "type": "uuid", + "primaryKey": false, + "notNull": false + }, + "override": { + "name": "override", + "type": "jsonb", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "agents_package_id_deployment_packages_id_fk": { + "name": "agents_package_id_deployment_packages_id_fk", + "tableFrom": "agents", + "tableTo": "deployment_packages", + "columnsFrom": ["package_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.audit_events": { + "name": "audit_events", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "uuid", + "primaryKey": true, + "notNull": true, + "default": "gen_random_uuid()" + }, + "actor_user_id": { + "name": "actor_user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "event_type": { + "name": "event_type", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "target_type": { + "name": "target_type", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "target_id": { + "name": "target_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "payload": { + "name": "payload", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "audit_events_created_at_idx": { + "name": "audit_events_created_at_idx", + "columns": [ + { + "expression": "created_at", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "audit_events_type_time_idx": { + "name": "audit_events_type_time_idx", + "columns": [ + { + "expression": "event_type", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "created_at", + "isExpression": false, + "asc": false, + "nulls": "last" + }, + { + "expression": "id", + "isExpression": false, + "asc": false, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "audit_events_actor_time_idx": { + "name": "audit_events_actor_time_idx", + "columns": [ + { + "expression": "actor_user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "created_at", + "isExpression": false, + "asc": false, + "nulls": "last" + }, + { + "expression": "id", + "isExpression": false, + "asc": false, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "audit_events_target_time_idx": { + "name": "audit_events_target_time_idx", + "columns": [ + { + "expression": "target_type", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "target_id", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "created_at", + "isExpression": false, + "asc": false, + "nulls": "last" + }, + { + "expression": "id", + "isExpression": false, + "asc": false, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.channel_agents": { + "name": "channel_agents", + "schema": "", + "columns": { + "channel_id": { + "name": "channel_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "channel_agents_channel_id_channels_id_fk": { + "name": "channel_agents_channel_id_channels_id_fk", + "tableFrom": "channel_agents", + "tableTo": "channels", + "columnsFrom": ["channel_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "channel_agents_agent_id_agents_id_fk": { + "name": "channel_agents_agent_id_agents_id_fk", + "tableFrom": "channel_agents", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "channel_agents_channel_id_agent_id_pk": { + "name": "channel_agents_channel_id_agent_id_pk", + "columns": ["channel_id", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.channel_memberships": { + "name": "channel_memberships", + "schema": "", + "columns": { + "channel_id": { + "name": "channel_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "pinned_at": { + "name": "pinned_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "channel_memberships_channel_id_channels_id_fk": { + "name": "channel_memberships_channel_id_channels_id_fk", + "tableFrom": "channel_memberships", + "tableTo": "channels", + "columnsFrom": ["channel_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "channel_memberships_user_id_users_id_fk": { + "name": "channel_memberships_user_id_users_id_fk", + "tableFrom": "channel_memberships", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "channel_memberships_channel_id_user_id_pk": { + "name": "channel_memberships_channel_id_user_id_pk", + "columns": ["channel_id", "user_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.channels": { + "name": "channels", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "description": { + "name": "description", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "suggested_prompts": { + "name": "suggested_prompts", + "type": "text[]", + "primaryKey": false, + "notNull": true, + "default": "'{}'" + }, + "allowed_groups": { + "name": "allowed_groups", + "type": "text[]", + "primaryKey": false, + "notNull": true, + "default": "'{}'" + }, + "package_id": { + "name": "package_id", + "type": "uuid", + "primaryKey": false, + "notNull": false + }, + "override": { + "name": "override", + "type": "jsonb", + "primaryKey": false, + "notNull": false + }, + "last_message": { + "name": "last_message", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "last_message_at": { + "name": "last_message_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "last_message_agent_id": { + "name": "last_message_agent_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "deleted_at": { + "name": "deleted_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "channels_recent_activity_idx": { + "name": "channels_recent_activity_idx", + "columns": [ + { + "expression": "COALESCE(\"last_message_at\", \"created_at\") DESC", + "asc": true, + "isExpression": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "channels_package_id_deployment_packages_id_fk": { + "name": "channels_package_id_deployment_packages_id_fk", + "tableFrom": "channels", + "tableTo": "deployment_packages", + "columnsFrom": ["package_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + }, + "channels_last_message_agent_id_agents_id_fk": { + "name": "channels_last_message_agent_id_agents_id_fk", + "tableFrom": "channels", + "tableTo": "agents", + "columnsFrom": ["last_message_agent_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.credentials": { + "name": "credentials", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "uuid", + "primaryKey": true, + "notNull": true, + "default": "gen_random_uuid()" + }, + "kind": { + "name": "kind", + "type": "credential_kind", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "provider": { + "name": "provider", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "encrypted_value": { + "name": "encrypted_value", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "key_id": { + "name": "key_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "metadata": { + "name": "metadata", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "revoked_at": { + "name": "revoked_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "credentials_active_key_idx": { + "name": "credentials_active_key_idx", + "columns": [ + { + "expression": "kind", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "provider", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "key_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "where": "\"credentials\".\"revoked_at\" IS NULL", + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.deployment_packages": { + "name": "deployment_packages", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "uuid", + "primaryKey": true, + "notNull": true, + "default": "gen_random_uuid()" + }, + "tenant_id": { + "name": "tenant_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "source_path": { + "name": "source_path", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "checksum": { + "name": "checksum", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "loaded_at": { + "name": "loaded_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "deployment_packages_tenant_id_unique": { + "name": "deployment_packages_tenant_id_unique", + "nullsNotDistinct": false, + "columns": ["tenant_id"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.intelligence_channel_mappings": { + "name": "intelligence_channel_mappings", + "schema": "", + "columns": { + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "channel_id": { + "name": "channel_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "thread_id": { + "name": "thread_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "intelligence_channel_mappings_thread_idx": { + "name": "intelligence_channel_mappings_thread_idx", + "columns": [ + { + "expression": "thread_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "intelligence_channel_mappings_user_id_users_id_fk": { + "name": "intelligence_channel_mappings_user_id_users_id_fk", + "tableFrom": "intelligence_channel_mappings", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "intelligence_channel_mappings_channel_id_channels_id_fk": { + "name": "intelligence_channel_mappings_channel_id_channels_id_fk", + "tableFrom": "intelligence_channel_mappings", + "tableTo": "channels", + "columnsFrom": ["channel_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "intelligence_channel_mappings_user_id_channel_id_pk": { + "name": "intelligence_channel_mappings_user_id_channel_id_pk", + "columns": ["user_id", "channel_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.revoked_access": { + "name": "revoked_access", + "schema": "", + "columns": { + "email": { + "name": "email", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "revoked_at": { + "name": "revoked_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "revoked_by": { + "name": "revoked_by", + "type": "text", + "primaryKey": false, + "notNull": true + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.sessions": { + "name": "sessions", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "token": { + "name": "token", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "expires_at": { + "name": "expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true + }, + "ip_address": { + "name": "ip_address", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "user_agent": { + "name": "user_agent", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "sessions_user_id_users_id_fk": { + "name": "sessions_user_id_users_id_fk", + "tableFrom": "sessions", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "sessions_token_unique": { + "name": "sessions_token_unique", + "nullsNotDistinct": false, + "columns": ["token"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.sso_providers": { + "name": "sso_providers", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "issuer": { + "name": "issuer", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "oidc_config": { + "name": "oidc_config", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "saml_config": { + "name": "saml_config", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "provider_id": { + "name": "provider_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "organization_id": { + "name": "organization_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "domain": { + "name": "domain", + "type": "text", + "primaryKey": false, + "notNull": true + } + }, + "indexes": {}, + "foreignKeys": { + "sso_providers_user_id_users_id_fk": { + "name": "sso_providers_user_id_users_id_fk", + "tableFrom": "sso_providers", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "sso_providers_provider_id_unique": { + "name": "sso_providers_provider_id_unique", + "nullsNotDistinct": false, + "columns": ["provider_id"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.user_roles": { + "name": "user_roles", + "schema": "", + "columns": { + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "role": { + "name": "role", + "type": "role", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "user_roles_user_id_users_id_fk": { + "name": "user_roles_user_id_users_id_fk", + "tableFrom": "user_roles", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "user_roles_user_id_role_pk": { + "name": "user_roles_user_id_role_pk", + "columns": ["user_id", "role"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.users": { + "name": "users", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "email": { + "name": "email", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "image": { + "name": "image", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "email_verified": { + "name": "email_verified", + "type": "boolean", + "primaryKey": false, + "notNull": true, + "default": false + }, + "groups": { + "name": "groups", + "type": "text[]", + "primaryKey": false, + "notNull": true, + "default": "'{}'" + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "users_email_unique": { + "name": "users_email_unique", + "nullsNotDistinct": false, + "columns": ["email"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.verifications": { + "name": "verifications", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "identifier": { + "name": "identifier", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "value": { + "name": "value", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "expires_at": { + "name": "expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.action_policy": { + "name": "action_policy", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "mode": { + "name": "mode", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "deny": { + "name": "deny", + "type": "text[]", + "primaryKey": false, + "notNull": true + }, + "allow": { + "name": "allow", + "type": "text[]", + "primaryKey": false, + "notNull": true + }, + "updated_by": { + "name": "updated_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.computer_snapshot": { + "name": "computer_snapshot", + "schema": "", + "columns": { + "computer_id": { + "name": "computer_id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "snapshot_id": { + "name": "snapshot_id", + "type": "integer", + "primaryKey": false, + "notNull": true + }, + "url": { + "name": "url", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "elements": { + "name": "elements", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "taken_at": { + "name": "taken_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "session": { + "name": "session", + "type": "text", + "primaryKey": false, + "notNull": false + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.agent_preferences": { + "name": "agent_preferences", + "schema": "", + "columns": { + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "hidden_at": { + "name": "hidden_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + } + }, + "indexes": {}, + "foreignKeys": { + "agent_preferences_user_id_users_id_fk": { + "name": "agent_preferences_user_id_users_id_fk", + "tableFrom": "agent_preferences", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "agent_preferences_agent_id_agents_id_fk": { + "name": "agent_preferences_agent_id_agents_id_fk", + "tableFrom": "agent_preferences", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "agent_preferences_user_id_agent_id_pk": { + "name": "agent_preferences_user_id_agent_id_pk", + "columns": ["user_id", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.agent_profiles": { + "name": "agent_profiles", + "schema": "", + "columns": { + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "owner_user_id": { + "name": "owner_user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "role_description": { + "name": "role_description", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "avatar_seed": { + "name": "avatar_seed", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "visibility": { + "name": "visibility", + "type": "agent_visibility", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "callback_token_hash": { + "name": "callback_token_hash", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "callback_token_issued_at": { + "name": "callback_token_issued_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "deleted_at": { + "name": "deleted_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "agent_profiles_visibility_deleted_idx": { + "name": "agent_profiles_visibility_deleted_idx", + "columns": [ + { + "expression": "visibility", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "deleted_at", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "agent_profiles_agent_id_agents_id_fk": { + "name": "agent_profiles_agent_id_agents_id_fk", + "tableFrom": "agent_profiles", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "agent_profiles_owner_user_id_users_id_fk": { + "name": "agent_profiles_owner_user_id_users_id_fk", + "tableFrom": "agent_profiles", + "tableTo": "users", + "columnsFrom": ["owner_user_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.component_exclusions": { + "name": "component_exclusions", + "schema": "", + "columns": { + "component_name": { + "name": "component_name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "withheld_by": { + "name": "withheld_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "component_exclusions_component_name_components_name_fk": { + "name": "component_exclusions_component_name_components_name_fk", + "tableFrom": "component_exclusions", + "tableTo": "components", + "columnsFrom": ["component_name"], + "columnsTo": ["name"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "component_exclusions_agent_id_agents_id_fk": { + "name": "component_exclusions_agent_id_agents_id_fk", + "tableFrom": "component_exclusions", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "component_exclusions_component_name_agent_id_pk": { + "name": "component_exclusions_component_name_agent_id_pk", + "columns": ["component_name", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.component_functions": { + "name": "component_functions", + "schema": "", + "columns": { + "component_name": { + "name": "component_name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "function_name": { + "name": "function_name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "granted_by": { + "name": "granted_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "component_functions_component_name_components_name_fk": { + "name": "component_functions_component_name_components_name_fk", + "tableFrom": "component_functions", + "tableTo": "components", + "columnsFrom": ["component_name"], + "columnsTo": ["name"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "component_functions_component_name_function_name_pk": { + "name": "component_functions_component_name_function_name_pk", + "columns": ["component_name", "function_name"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.components": { + "name": "components", + "schema": "", + "columns": { + "name": { + "name": "name", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "kind": { + "name": "kind", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "draft_description": { + "name": "draft_description", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "published_description": { + "name": "published_description", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published": { + "name": "published", + "type": "boolean", + "primaryKey": false, + "notNull": true, + "default": false + }, + "published_at": { + "name": "published_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "updated_by": { + "name": "updated_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.mcp_servers": { + "name": "mcp_servers", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "vendor": { + "name": "vendor", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "url": { + "name": "url", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "provenance": { + "name": "provenance", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "'first-party'" + }, + "credential_id": { + "name": "credential_id", + "type": "uuid", + "primaryKey": false, + "notNull": false + }, + "tools_refreshed_at": { + "name": "tools_refreshed_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "last_error": { + "name": "last_error", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "added_by": { + "name": "added_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "mcp_servers_credential_id_credentials_id_fk": { + "name": "mcp_servers_credential_id_credentials_id_fk", + "tableFrom": "mcp_servers", + "tableTo": "credentials", + "columnsFrom": ["credential_id"], + "columnsTo": ["id"], + "onDelete": "restrict", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.mcp_tools": { + "name": "mcp_tools", + "schema": "", + "columns": { + "server_id": { + "name": "server_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "description": { + "name": "description", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "input_schema": { + "name": "input_schema", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "mcp_tools_server_id_mcp_servers_id_fk": { + "name": "mcp_tools_server_id_mcp_servers_id_fk", + "tableFrom": "mcp_tools", + "tableTo": "mcp_servers", + "columnsFrom": ["server_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "mcp_tools_server_id_name_pk": { + "name": "mcp_tools_server_id_name_pk", + "columns": ["server_id", "name"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.mcp_user_credentials": { + "name": "mcp_user_credentials", + "schema": "", + "columns": { + "server_id": { + "name": "server_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "credential_id": { + "name": "credential_id", + "type": "uuid", + "primaryKey": false, + "notNull": true + }, + "scope": { + "name": "scope", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "connected_at": { + "name": "connected_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "mcp_user_credentials_user_idx": { + "name": "mcp_user_credentials_user_idx", + "columns": [ + { + "expression": "user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "mcp_user_credentials_server_id_mcp_servers_id_fk": { + "name": "mcp_user_credentials_server_id_mcp_servers_id_fk", + "tableFrom": "mcp_user_credentials", + "tableTo": "mcp_servers", + "columnsFrom": ["server_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "mcp_user_credentials_user_id_users_id_fk": { + "name": "mcp_user_credentials_user_id_users_id_fk", + "tableFrom": "mcp_user_credentials", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "mcp_user_credentials_credential_id_credentials_id_fk": { + "name": "mcp_user_credentials_credential_id_credentials_id_fk", + "tableFrom": "mcp_user_credentials", + "tableTo": "credentials", + "columnsFrom": ["credential_id"], + "columnsTo": ["id"], + "onDelete": "no action", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "mcp_user_credentials_server_id_user_id_pk": { + "name": "mcp_user_credentials_server_id_user_id_pk", + "columns": ["server_id", "user_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.plugin_grants": { + "name": "plugin_grants", + "schema": "", + "columns": { + "kind": { + "name": "kind", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "ref": { + "name": "ref", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "granted_by": { + "name": "granted_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "plugin_grants_agent_idx": { + "name": "plugin_grants_agent_idx", + "columns": [ + { + "expression": "agent_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "plugin_grants_agent_id_agents_id_fk": { + "name": "plugin_grants_agent_id_agents_id_fk", + "tableFrom": "plugin_grants", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "plugin_grants_kind_ref_agent_id_pk": { + "name": "plugin_grants_kind_ref_agent_id_pk", + "columns": ["kind", "ref", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.sandboxed_components": { + "name": "sandboxed_components", + "schema": "", + "columns": { + "name": { + "name": "name", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "draft_description": { + "name": "draft_description", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_html": { + "name": "draft_html", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_css": { + "name": "draft_css", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_js_functions": { + "name": "draft_js_functions", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_argument_schema": { + "name": "draft_argument_schema", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "published_description": { + "name": "published_description", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_html": { + "name": "published_html", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_css": { + "name": "published_css", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_js_functions": { + "name": "published_js_functions", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_argument_schema": { + "name": "published_argument_schema", + "type": "jsonb", + "primaryKey": false, + "notNull": false + }, + "sample_arguments": { + "name": "sample_arguments", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "revision": { + "name": "revision", + "type": "integer", + "primaryKey": false, + "notNull": true, + "default": 0 + }, + "published": { + "name": "published", + "type": "boolean", + "primaryKey": false, + "notNull": true, + "default": false + }, + "published_at": { + "name": "published_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "authored_by": { + "name": "authored_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.skill_tools": { + "name": "skill_tools", + "schema": "", + "columns": { + "skill_id": { + "name": "skill_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "ref": { + "name": "ref", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "declared_by": { + "name": "declared_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "skill_tools_ref_idx": { + "name": "skill_tools_ref_idx", + "columns": [ + { + "expression": "ref", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "skill_tools_skill_id_skills_id_fk": { + "name": "skill_tools_skill_id_skills_id_fk", + "tableFrom": "skill_tools", + "tableTo": "skills", + "columnsFrom": ["skill_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "skill_tools_skill_id_ref_pk": { + "name": "skill_tools_skill_id_ref_pk", + "columns": ["skill_id", "ref"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.skills": { + "name": "skills", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "owner_user_id": { + "name": "owner_user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "slug": { + "name": "slug", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "summary": { + "name": "summary", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "instructions": { + "name": "instructions", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "origin": { + "name": "origin", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "'yours'" + }, + "installed_by": { + "name": "installed_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "skills_slug_key": { + "name": "skills_slug_key", + "columns": [ + { + "expression": "slug", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "concurrently": false, + "method": "btree", + "with": {} + }, + "skills_owner_idx": { + "name": "skills_owner_idx", + "columns": [ + { + "expression": "owner_user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "skills_owner_user_id_users_id_fk": { + "name": "skills_owner_user_id_users_id_fk", + "tableFrom": "skills", + "tableTo": "users", + "columnsFrom": ["owner_user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + } + }, + "enums": { + "public.agent_type": { + "name": "agent_type", + "schema": "public", + "values": ["built_in", "remote_ag_ui"] + }, + "public.credential_kind": { + "name": "credential_kind", + "schema": "public", + "values": [ + "model", + "connector", + "agent", + "mcp", + "mcp_oauth_client", + "mcp_user_token" + ] + }, + "public.role": { + "name": "role", + "schema": "public", + "values": ["admin", "user"] + }, + "public.agent_visibility": { + "name": "agent_visibility", + "schema": "public", + "values": ["public", "private"] + } + }, + "schemas": {}, + "sequences": {}, + "roles": {}, + "policies": {}, + "views": {}, + "_meta": { + "columns": {}, + "schemas": {}, + "tables": {} + } +} diff --git a/server/drizzle/meta/0017_snapshot.json b/server/drizzle/meta/0017_snapshot.json new file mode 100644 index 00000000..b69915a6 --- /dev/null +++ b/server/drizzle/meta/0017_snapshot.json @@ -0,0 +1,2506 @@ +{ + "id": "eab681f3-28cb-4ef4-a5f0-5e82f53a6f42", + "prevId": "8e5982ba-c8e3-4634-a05c-68a90e066dac", + "version": "7", + "dialect": "postgresql", + "tables": { + "public.accounts": { + "name": "accounts", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "account_id": { + "name": "account_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "provider_id": { + "name": "provider_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "issuer": { + "name": "issuer", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "access_token": { + "name": "access_token", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "refresh_token": { + "name": "refresh_token", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "id_token": { + "name": "id_token", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "access_token_expires_at": { + "name": "access_token_expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "refresh_token_expires_at": { + "name": "refresh_token_expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "scope": { + "name": "scope", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "password": { + "name": "password", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "accounts_provider_account_idx": { + "name": "accounts_provider_account_idx", + "columns": [ + { + "expression": "provider_id", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "account_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "accounts_user_id_users_id_fk": { + "name": "accounts_user_id_users_id_fk", + "tableFrom": "accounts", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.agents": { + "name": "agents", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "type": { + "name": "type", + "type": "agent_type", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "configuration": { + "name": "configuration", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "package_id": { + "name": "package_id", + "type": "uuid", + "primaryKey": false, + "notNull": false + }, + "override": { + "name": "override", + "type": "jsonb", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "agents_package_id_deployment_packages_id_fk": { + "name": "agents_package_id_deployment_packages_id_fk", + "tableFrom": "agents", + "tableTo": "deployment_packages", + "columnsFrom": ["package_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.audit_events": { + "name": "audit_events", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "uuid", + "primaryKey": true, + "notNull": true, + "default": "gen_random_uuid()" + }, + "actor_user_id": { + "name": "actor_user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "event_type": { + "name": "event_type", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "target_type": { + "name": "target_type", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "target_id": { + "name": "target_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "payload": { + "name": "payload", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "audit_events_created_at_idx": { + "name": "audit_events_created_at_idx", + "columns": [ + { + "expression": "created_at", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "audit_events_type_time_idx": { + "name": "audit_events_type_time_idx", + "columns": [ + { + "expression": "event_type", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "created_at", + "isExpression": false, + "asc": false, + "nulls": "last" + }, + { + "expression": "id", + "isExpression": false, + "asc": false, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "audit_events_actor_time_idx": { + "name": "audit_events_actor_time_idx", + "columns": [ + { + "expression": "actor_user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "created_at", + "isExpression": false, + "asc": false, + "nulls": "last" + }, + { + "expression": "id", + "isExpression": false, + "asc": false, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "audit_events_target_time_idx": { + "name": "audit_events_target_time_idx", + "columns": [ + { + "expression": "target_type", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "target_id", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "created_at", + "isExpression": false, + "asc": false, + "nulls": "last" + }, + { + "expression": "id", + "isExpression": false, + "asc": false, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.channel_agents": { + "name": "channel_agents", + "schema": "", + "columns": { + "channel_id": { + "name": "channel_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "channel_agents_channel_id_channels_id_fk": { + "name": "channel_agents_channel_id_channels_id_fk", + "tableFrom": "channel_agents", + "tableTo": "channels", + "columnsFrom": ["channel_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "channel_agents_agent_id_agents_id_fk": { + "name": "channel_agents_agent_id_agents_id_fk", + "tableFrom": "channel_agents", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "channel_agents_channel_id_agent_id_pk": { + "name": "channel_agents_channel_id_agent_id_pk", + "columns": ["channel_id", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.channel_memberships": { + "name": "channel_memberships", + "schema": "", + "columns": { + "channel_id": { + "name": "channel_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "pinned_at": { + "name": "pinned_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "channel_memberships_channel_id_channels_id_fk": { + "name": "channel_memberships_channel_id_channels_id_fk", + "tableFrom": "channel_memberships", + "tableTo": "channels", + "columnsFrom": ["channel_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "channel_memberships_user_id_users_id_fk": { + "name": "channel_memberships_user_id_users_id_fk", + "tableFrom": "channel_memberships", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "channel_memberships_channel_id_user_id_pk": { + "name": "channel_memberships_channel_id_user_id_pk", + "columns": ["channel_id", "user_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.channels": { + "name": "channels", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "description": { + "name": "description", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "suggested_prompts": { + "name": "suggested_prompts", + "type": "text[]", + "primaryKey": false, + "notNull": true, + "default": "'{}'" + }, + "allowed_groups": { + "name": "allowed_groups", + "type": "text[]", + "primaryKey": false, + "notNull": true, + "default": "'{}'" + }, + "package_id": { + "name": "package_id", + "type": "uuid", + "primaryKey": false, + "notNull": false + }, + "override": { + "name": "override", + "type": "jsonb", + "primaryKey": false, + "notNull": false + }, + "last_message": { + "name": "last_message", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "last_message_at": { + "name": "last_message_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "last_message_agent_id": { + "name": "last_message_agent_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "deleted_at": { + "name": "deleted_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "channels_recent_activity_idx": { + "name": "channels_recent_activity_idx", + "columns": [ + { + "expression": "COALESCE(\"last_message_at\", \"created_at\") DESC", + "asc": true, + "isExpression": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "channels_package_id_deployment_packages_id_fk": { + "name": "channels_package_id_deployment_packages_id_fk", + "tableFrom": "channels", + "tableTo": "deployment_packages", + "columnsFrom": ["package_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + }, + "channels_last_message_agent_id_agents_id_fk": { + "name": "channels_last_message_agent_id_agents_id_fk", + "tableFrom": "channels", + "tableTo": "agents", + "columnsFrom": ["last_message_agent_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.credentials": { + "name": "credentials", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "uuid", + "primaryKey": true, + "notNull": true, + "default": "gen_random_uuid()" + }, + "kind": { + "name": "kind", + "type": "credential_kind", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "provider": { + "name": "provider", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "encrypted_value": { + "name": "encrypted_value", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "key_id": { + "name": "key_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "metadata": { + "name": "metadata", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "revoked_at": { + "name": "revoked_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "credentials_active_key_idx": { + "name": "credentials_active_key_idx", + "columns": [ + { + "expression": "kind", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "provider", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "key_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "where": "\"credentials\".\"revoked_at\" IS NULL", + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.deployment_packages": { + "name": "deployment_packages", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "uuid", + "primaryKey": true, + "notNull": true, + "default": "gen_random_uuid()" + }, + "tenant_id": { + "name": "tenant_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "source_path": { + "name": "source_path", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "checksum": { + "name": "checksum", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "loaded_at": { + "name": "loaded_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "deployment_packages_tenant_id_unique": { + "name": "deployment_packages_tenant_id_unique", + "nullsNotDistinct": false, + "columns": ["tenant_id"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.intelligence_channel_mappings": { + "name": "intelligence_channel_mappings", + "schema": "", + "columns": { + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "channel_id": { + "name": "channel_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "thread_id": { + "name": "thread_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "intelligence_channel_mappings_thread_idx": { + "name": "intelligence_channel_mappings_thread_idx", + "columns": [ + { + "expression": "thread_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "intelligence_channel_mappings_user_id_users_id_fk": { + "name": "intelligence_channel_mappings_user_id_users_id_fk", + "tableFrom": "intelligence_channel_mappings", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "intelligence_channel_mappings_channel_id_channels_id_fk": { + "name": "intelligence_channel_mappings_channel_id_channels_id_fk", + "tableFrom": "intelligence_channel_mappings", + "tableTo": "channels", + "columnsFrom": ["channel_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "intelligence_channel_mappings_user_id_channel_id_pk": { + "name": "intelligence_channel_mappings_user_id_channel_id_pk", + "columns": ["user_id", "channel_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.revoked_access": { + "name": "revoked_access", + "schema": "", + "columns": { + "email": { + "name": "email", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "revoked_at": { + "name": "revoked_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "revoked_by": { + "name": "revoked_by", + "type": "text", + "primaryKey": false, + "notNull": true + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.sessions": { + "name": "sessions", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "token": { + "name": "token", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "expires_at": { + "name": "expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true + }, + "ip_address": { + "name": "ip_address", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "user_agent": { + "name": "user_agent", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "sessions_user_id_users_id_fk": { + "name": "sessions_user_id_users_id_fk", + "tableFrom": "sessions", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "sessions_token_unique": { + "name": "sessions_token_unique", + "nullsNotDistinct": false, + "columns": ["token"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.sso_providers": { + "name": "sso_providers", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "issuer": { + "name": "issuer", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "oidc_config": { + "name": "oidc_config", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "saml_config": { + "name": "saml_config", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "provider_id": { + "name": "provider_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "organization_id": { + "name": "organization_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "domain": { + "name": "domain", + "type": "text", + "primaryKey": false, + "notNull": true + } + }, + "indexes": {}, + "foreignKeys": { + "sso_providers_user_id_users_id_fk": { + "name": "sso_providers_user_id_users_id_fk", + "tableFrom": "sso_providers", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "sso_providers_provider_id_unique": { + "name": "sso_providers_provider_id_unique", + "nullsNotDistinct": false, + "columns": ["provider_id"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.user_roles": { + "name": "user_roles", + "schema": "", + "columns": { + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "role": { + "name": "role", + "type": "role", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "user_roles_user_id_users_id_fk": { + "name": "user_roles_user_id_users_id_fk", + "tableFrom": "user_roles", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "user_roles_user_id_role_pk": { + "name": "user_roles_user_id_role_pk", + "columns": ["user_id", "role"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.users": { + "name": "users", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "email": { + "name": "email", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "image": { + "name": "image", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "email_verified": { + "name": "email_verified", + "type": "boolean", + "primaryKey": false, + "notNull": true, + "default": false + }, + "groups": { + "name": "groups", + "type": "text[]", + "primaryKey": false, + "notNull": true, + "default": "'{}'" + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "users_email_unique": { + "name": "users_email_unique", + "nullsNotDistinct": false, + "columns": ["email"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.verifications": { + "name": "verifications", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "identifier": { + "name": "identifier", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "value": { + "name": "value", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "expires_at": { + "name": "expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.action_policy": { + "name": "action_policy", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "mode": { + "name": "mode", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "deny": { + "name": "deny", + "type": "text[]", + "primaryKey": false, + "notNull": true + }, + "allow": { + "name": "allow", + "type": "text[]", + "primaryKey": false, + "notNull": true + }, + "updated_by": { + "name": "updated_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.computer_snapshot": { + "name": "computer_snapshot", + "schema": "", + "columns": { + "computer_id": { + "name": "computer_id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "snapshot_id": { + "name": "snapshot_id", + "type": "integer", + "primaryKey": false, + "notNull": true + }, + "url": { + "name": "url", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "elements": { + "name": "elements", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "taken_at": { + "name": "taken_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "session": { + "name": "session", + "type": "text", + "primaryKey": false, + "notNull": false + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.agent_preferences": { + "name": "agent_preferences", + "schema": "", + "columns": { + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "hidden_at": { + "name": "hidden_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + } + }, + "indexes": {}, + "foreignKeys": { + "agent_preferences_user_id_users_id_fk": { + "name": "agent_preferences_user_id_users_id_fk", + "tableFrom": "agent_preferences", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "agent_preferences_agent_id_agents_id_fk": { + "name": "agent_preferences_agent_id_agents_id_fk", + "tableFrom": "agent_preferences", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "agent_preferences_user_id_agent_id_pk": { + "name": "agent_preferences_user_id_agent_id_pk", + "columns": ["user_id", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.agent_profiles": { + "name": "agent_profiles", + "schema": "", + "columns": { + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "owner_user_id": { + "name": "owner_user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "role_description": { + "name": "role_description", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "avatar_seed": { + "name": "avatar_seed", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "visibility": { + "name": "visibility", + "type": "agent_visibility", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "callback_token_hash": { + "name": "callback_token_hash", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "callback_token_issued_at": { + "name": "callback_token_issued_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "deleted_at": { + "name": "deleted_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "agent_profiles_visibility_deleted_idx": { + "name": "agent_profiles_visibility_deleted_idx", + "columns": [ + { + "expression": "visibility", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "deleted_at", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "agent_profiles_agent_id_agents_id_fk": { + "name": "agent_profiles_agent_id_agents_id_fk", + "tableFrom": "agent_profiles", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "agent_profiles_owner_user_id_users_id_fk": { + "name": "agent_profiles_owner_user_id_users_id_fk", + "tableFrom": "agent_profiles", + "tableTo": "users", + "columnsFrom": ["owner_user_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.component_exclusions": { + "name": "component_exclusions", + "schema": "", + "columns": { + "component_name": { + "name": "component_name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "withheld_by": { + "name": "withheld_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "component_exclusions_component_name_components_name_fk": { + "name": "component_exclusions_component_name_components_name_fk", + "tableFrom": "component_exclusions", + "tableTo": "components", + "columnsFrom": ["component_name"], + "columnsTo": ["name"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "component_exclusions_agent_id_agents_id_fk": { + "name": "component_exclusions_agent_id_agents_id_fk", + "tableFrom": "component_exclusions", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "component_exclusions_component_name_agent_id_pk": { + "name": "component_exclusions_component_name_agent_id_pk", + "columns": ["component_name", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.component_functions": { + "name": "component_functions", + "schema": "", + "columns": { + "component_name": { + "name": "component_name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "function_name": { + "name": "function_name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "granted_by": { + "name": "granted_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "component_functions_component_name_components_name_fk": { + "name": "component_functions_component_name_components_name_fk", + "tableFrom": "component_functions", + "tableTo": "components", + "columnsFrom": ["component_name"], + "columnsTo": ["name"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "component_functions_component_name_function_name_pk": { + "name": "component_functions_component_name_function_name_pk", + "columns": ["component_name", "function_name"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.components": { + "name": "components", + "schema": "", + "columns": { + "name": { + "name": "name", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "kind": { + "name": "kind", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "draft_description": { + "name": "draft_description", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "published_description": { + "name": "published_description", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published": { + "name": "published", + "type": "boolean", + "primaryKey": false, + "notNull": true, + "default": false + }, + "published_at": { + "name": "published_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "updated_by": { + "name": "updated_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.mcp_servers": { + "name": "mcp_servers", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "vendor": { + "name": "vendor", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "url": { + "name": "url", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "provenance": { + "name": "provenance", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "'first-party'" + }, + "credential_id": { + "name": "credential_id", + "type": "uuid", + "primaryKey": false, + "notNull": false + }, + "tools_refreshed_at": { + "name": "tools_refreshed_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "last_error": { + "name": "last_error", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "added_by": { + "name": "added_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "mcp_servers_credential_id_credentials_id_fk": { + "name": "mcp_servers_credential_id_credentials_id_fk", + "tableFrom": "mcp_servers", + "tableTo": "credentials", + "columnsFrom": ["credential_id"], + "columnsTo": ["id"], + "onDelete": "restrict", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.mcp_tools": { + "name": "mcp_tools", + "schema": "", + "columns": { + "server_id": { + "name": "server_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "description": { + "name": "description", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "input_schema": { + "name": "input_schema", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "mcp_tools_server_id_mcp_servers_id_fk": { + "name": "mcp_tools_server_id_mcp_servers_id_fk", + "tableFrom": "mcp_tools", + "tableTo": "mcp_servers", + "columnsFrom": ["server_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "mcp_tools_server_id_name_pk": { + "name": "mcp_tools_server_id_name_pk", + "columns": ["server_id", "name"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.mcp_user_credentials": { + "name": "mcp_user_credentials", + "schema": "", + "columns": { + "server_id": { + "name": "server_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "credential_id": { + "name": "credential_id", + "type": "uuid", + "primaryKey": false, + "notNull": true + }, + "scope": { + "name": "scope", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "connected_at": { + "name": "connected_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "mcp_user_credentials_user_idx": { + "name": "mcp_user_credentials_user_idx", + "columns": [ + { + "expression": "user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "mcp_user_credentials_server_id_mcp_servers_id_fk": { + "name": "mcp_user_credentials_server_id_mcp_servers_id_fk", + "tableFrom": "mcp_user_credentials", + "tableTo": "mcp_servers", + "columnsFrom": ["server_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "mcp_user_credentials_user_id_users_id_fk": { + "name": "mcp_user_credentials_user_id_users_id_fk", + "tableFrom": "mcp_user_credentials", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "mcp_user_credentials_credential_id_credentials_id_fk": { + "name": "mcp_user_credentials_credential_id_credentials_id_fk", + "tableFrom": "mcp_user_credentials", + "tableTo": "credentials", + "columnsFrom": ["credential_id"], + "columnsTo": ["id"], + "onDelete": "no action", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "mcp_user_credentials_server_id_user_id_pk": { + "name": "mcp_user_credentials_server_id_user_id_pk", + "columns": ["server_id", "user_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.plugin_grants": { + "name": "plugin_grants", + "schema": "", + "columns": { + "kind": { + "name": "kind", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "ref": { + "name": "ref", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "granted_by": { + "name": "granted_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "plugin_grants_agent_idx": { + "name": "plugin_grants_agent_idx", + "columns": [ + { + "expression": "agent_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "plugin_grants_agent_id_agents_id_fk": { + "name": "plugin_grants_agent_id_agents_id_fk", + "tableFrom": "plugin_grants", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "plugin_grants_kind_ref_agent_id_pk": { + "name": "plugin_grants_kind_ref_agent_id_pk", + "columns": ["kind", "ref", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.sandboxed_components": { + "name": "sandboxed_components", + "schema": "", + "columns": { + "name": { + "name": "name", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "draft_description": { + "name": "draft_description", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_html": { + "name": "draft_html", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_css": { + "name": "draft_css", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_js_functions": { + "name": "draft_js_functions", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_argument_schema": { + "name": "draft_argument_schema", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "published_description": { + "name": "published_description", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_html": { + "name": "published_html", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_css": { + "name": "published_css", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_js_functions": { + "name": "published_js_functions", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_argument_schema": { + "name": "published_argument_schema", + "type": "jsonb", + "primaryKey": false, + "notNull": false + }, + "sample_arguments": { + "name": "sample_arguments", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "revision": { + "name": "revision", + "type": "integer", + "primaryKey": false, + "notNull": true, + "default": 0 + }, + "published": { + "name": "published", + "type": "boolean", + "primaryKey": false, + "notNull": true, + "default": false + }, + "published_at": { + "name": "published_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "authored_by": { + "name": "authored_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.skill_tools": { + "name": "skill_tools", + "schema": "", + "columns": { + "skill_id": { + "name": "skill_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "ref": { + "name": "ref", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "declared_by": { + "name": "declared_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "skill_tools_ref_idx": { + "name": "skill_tools_ref_idx", + "columns": [ + { + "expression": "ref", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "skill_tools_skill_id_skills_id_fk": { + "name": "skill_tools_skill_id_skills_id_fk", + "tableFrom": "skill_tools", + "tableTo": "skills", + "columnsFrom": ["skill_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "skill_tools_skill_id_ref_pk": { + "name": "skill_tools_skill_id_ref_pk", + "columns": ["skill_id", "ref"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.skills": { + "name": "skills", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "owner_user_id": { + "name": "owner_user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "slug": { + "name": "slug", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "summary": { + "name": "summary", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "instructions": { + "name": "instructions", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "origin": { + "name": "origin", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "'yours'" + }, + "installed_by": { + "name": "installed_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "skills_slug_key": { + "name": "skills_slug_key", + "columns": [ + { + "expression": "slug", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "concurrently": false, + "method": "btree", + "with": {} + }, + "skills_owner_idx": { + "name": "skills_owner_idx", + "columns": [ + { + "expression": "owner_user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "skills_owner_user_id_users_id_fk": { + "name": "skills_owner_user_id_users_id_fk", + "tableFrom": "skills", + "tableTo": "users", + "columnsFrom": ["owner_user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.work_items": { + "name": "work_items", + "schema": "", + "columns": { + "kind": { + "name": "kind", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "key": { + "name": "key", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "run_at": { + "name": "run_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "claimed_by": { + "name": "claimed_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "lease_until": { + "name": "lease_until", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "attempts": { + "name": "attempts", + "type": "integer", + "primaryKey": false, + "notNull": true, + "default": 0 + }, + "finished_at": { + "name": "finished_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "last_error": { + "name": "last_error", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "payload": { + "name": "payload", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "work_items_claimable_idx": { + "name": "work_items_claimable_idx", + "columns": [ + { + "expression": "kind", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "run_at", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": { + "work_items_kind_key_pk": { + "name": "work_items_kind_key_pk", + "columns": ["kind", "key"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + } + }, + "enums": { + "public.agent_type": { + "name": "agent_type", + "schema": "public", + "values": ["built_in", "remote_ag_ui"] + }, + "public.credential_kind": { + "name": "credential_kind", + "schema": "public", + "values": [ + "model", + "connector", + "agent", + "mcp", + "mcp_oauth_client", + "mcp_user_token" + ] + }, + "public.role": { + "name": "role", + "schema": "public", + "values": ["admin", "user"] + }, + "public.agent_visibility": { + "name": "agent_visibility", + "schema": "public", + "values": ["public", "private"] + } + }, + "schemas": {}, + "sequences": {}, + "roles": {}, + "policies": {}, + "views": {}, + "_meta": { + "columns": {}, + "schemas": {}, + "tables": {} + } +} diff --git a/server/drizzle/meta/0018_snapshot.json b/server/drizzle/meta/0018_snapshot.json new file mode 100644 index 00000000..1c83b0ec --- /dev/null +++ b/server/drizzle/meta/0018_snapshot.json @@ -0,0 +1,2577 @@ +{ + "id": "aa5ec39b-170c-495b-b4a9-e08ed0fd643d", + "prevId": "eab681f3-28cb-4ef4-a5f0-5e82f53a6f42", + "version": "7", + "dialect": "postgresql", + "tables": { + "public.accounts": { + "name": "accounts", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "account_id": { + "name": "account_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "provider_id": { + "name": "provider_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "issuer": { + "name": "issuer", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "access_token": { + "name": "access_token", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "refresh_token": { + "name": "refresh_token", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "id_token": { + "name": "id_token", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "access_token_expires_at": { + "name": "access_token_expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "refresh_token_expires_at": { + "name": "refresh_token_expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "scope": { + "name": "scope", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "password": { + "name": "password", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "accounts_provider_account_idx": { + "name": "accounts_provider_account_idx", + "columns": [ + { + "expression": "provider_id", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "account_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "accounts_user_id_users_id_fk": { + "name": "accounts_user_id_users_id_fk", + "tableFrom": "accounts", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.agents": { + "name": "agents", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "type": { + "name": "type", + "type": "agent_type", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "configuration": { + "name": "configuration", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "package_id": { + "name": "package_id", + "type": "uuid", + "primaryKey": false, + "notNull": false + }, + "override": { + "name": "override", + "type": "jsonb", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "agents_package_id_deployment_packages_id_fk": { + "name": "agents_package_id_deployment_packages_id_fk", + "tableFrom": "agents", + "tableTo": "deployment_packages", + "columnsFrom": ["package_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.audit_events": { + "name": "audit_events", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "uuid", + "primaryKey": true, + "notNull": true, + "default": "gen_random_uuid()" + }, + "actor_user_id": { + "name": "actor_user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "event_type": { + "name": "event_type", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "target_type": { + "name": "target_type", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "target_id": { + "name": "target_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "payload": { + "name": "payload", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "audit_events_created_at_idx": { + "name": "audit_events_created_at_idx", + "columns": [ + { + "expression": "created_at", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "audit_events_type_time_idx": { + "name": "audit_events_type_time_idx", + "columns": [ + { + "expression": "event_type", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "created_at", + "isExpression": false, + "asc": false, + "nulls": "last" + }, + { + "expression": "id", + "isExpression": false, + "asc": false, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "audit_events_actor_time_idx": { + "name": "audit_events_actor_time_idx", + "columns": [ + { + "expression": "actor_user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "created_at", + "isExpression": false, + "asc": false, + "nulls": "last" + }, + { + "expression": "id", + "isExpression": false, + "asc": false, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "audit_events_target_time_idx": { + "name": "audit_events_target_time_idx", + "columns": [ + { + "expression": "target_type", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "target_id", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "created_at", + "isExpression": false, + "asc": false, + "nulls": "last" + }, + { + "expression": "id", + "isExpression": false, + "asc": false, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.channel_agents": { + "name": "channel_agents", + "schema": "", + "columns": { + "channel_id": { + "name": "channel_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "channel_agents_channel_id_channels_id_fk": { + "name": "channel_agents_channel_id_channels_id_fk", + "tableFrom": "channel_agents", + "tableTo": "channels", + "columnsFrom": ["channel_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "channel_agents_agent_id_agents_id_fk": { + "name": "channel_agents_agent_id_agents_id_fk", + "tableFrom": "channel_agents", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "channel_agents_channel_id_agent_id_pk": { + "name": "channel_agents_channel_id_agent_id_pk", + "columns": ["channel_id", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.channel_memberships": { + "name": "channel_memberships", + "schema": "", + "columns": { + "channel_id": { + "name": "channel_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "pinned_at": { + "name": "pinned_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "channel_memberships_channel_id_channels_id_fk": { + "name": "channel_memberships_channel_id_channels_id_fk", + "tableFrom": "channel_memberships", + "tableTo": "channels", + "columnsFrom": ["channel_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "channel_memberships_user_id_users_id_fk": { + "name": "channel_memberships_user_id_users_id_fk", + "tableFrom": "channel_memberships", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "channel_memberships_channel_id_user_id_pk": { + "name": "channel_memberships_channel_id_user_id_pk", + "columns": ["channel_id", "user_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.channels": { + "name": "channels", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "description": { + "name": "description", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "suggested_prompts": { + "name": "suggested_prompts", + "type": "text[]", + "primaryKey": false, + "notNull": true, + "default": "'{}'" + }, + "allowed_groups": { + "name": "allowed_groups", + "type": "text[]", + "primaryKey": false, + "notNull": true, + "default": "'{}'" + }, + "package_id": { + "name": "package_id", + "type": "uuid", + "primaryKey": false, + "notNull": false + }, + "override": { + "name": "override", + "type": "jsonb", + "primaryKey": false, + "notNull": false + }, + "last_message": { + "name": "last_message", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "last_message_at": { + "name": "last_message_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "last_message_agent_id": { + "name": "last_message_agent_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "deleted_at": { + "name": "deleted_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "channels_recent_activity_idx": { + "name": "channels_recent_activity_idx", + "columns": [ + { + "expression": "COALESCE(\"last_message_at\", \"created_at\") DESC", + "asc": true, + "isExpression": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "channels_package_id_deployment_packages_id_fk": { + "name": "channels_package_id_deployment_packages_id_fk", + "tableFrom": "channels", + "tableTo": "deployment_packages", + "columnsFrom": ["package_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + }, + "channels_last_message_agent_id_agents_id_fk": { + "name": "channels_last_message_agent_id_agents_id_fk", + "tableFrom": "channels", + "tableTo": "agents", + "columnsFrom": ["last_message_agent_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.credentials": { + "name": "credentials", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "uuid", + "primaryKey": true, + "notNull": true, + "default": "gen_random_uuid()" + }, + "kind": { + "name": "kind", + "type": "credential_kind", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "provider": { + "name": "provider", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "encrypted_value": { + "name": "encrypted_value", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "key_id": { + "name": "key_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "metadata": { + "name": "metadata", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "revoked_at": { + "name": "revoked_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "credentials_active_key_idx": { + "name": "credentials_active_key_idx", + "columns": [ + { + "expression": "kind", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "provider", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "key_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "where": "\"credentials\".\"revoked_at\" IS NULL", + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.deployment_packages": { + "name": "deployment_packages", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "uuid", + "primaryKey": true, + "notNull": true, + "default": "gen_random_uuid()" + }, + "tenant_id": { + "name": "tenant_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "source_path": { + "name": "source_path", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "checksum": { + "name": "checksum", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "loaded_at": { + "name": "loaded_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "deployment_packages_tenant_id_unique": { + "name": "deployment_packages_tenant_id_unique", + "nullsNotDistinct": false, + "columns": ["tenant_id"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.intelligence_channel_mappings": { + "name": "intelligence_channel_mappings", + "schema": "", + "columns": { + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "channel_id": { + "name": "channel_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "thread_id": { + "name": "thread_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "intelligence_channel_mappings_thread_idx": { + "name": "intelligence_channel_mappings_thread_idx", + "columns": [ + { + "expression": "thread_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "intelligence_channel_mappings_user_id_users_id_fk": { + "name": "intelligence_channel_mappings_user_id_users_id_fk", + "tableFrom": "intelligence_channel_mappings", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "intelligence_channel_mappings_channel_id_channels_id_fk": { + "name": "intelligence_channel_mappings_channel_id_channels_id_fk", + "tableFrom": "intelligence_channel_mappings", + "tableTo": "channels", + "columnsFrom": ["channel_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "intelligence_channel_mappings_user_id_channel_id_pk": { + "name": "intelligence_channel_mappings_user_id_channel_id_pk", + "columns": ["user_id", "channel_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.revoked_access": { + "name": "revoked_access", + "schema": "", + "columns": { + "email": { + "name": "email", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "revoked_at": { + "name": "revoked_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "revoked_by": { + "name": "revoked_by", + "type": "text", + "primaryKey": false, + "notNull": true + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.sessions": { + "name": "sessions", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "token": { + "name": "token", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "expires_at": { + "name": "expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true + }, + "ip_address": { + "name": "ip_address", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "user_agent": { + "name": "user_agent", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "sessions_user_id_users_id_fk": { + "name": "sessions_user_id_users_id_fk", + "tableFrom": "sessions", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "sessions_token_unique": { + "name": "sessions_token_unique", + "nullsNotDistinct": false, + "columns": ["token"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.sso_providers": { + "name": "sso_providers", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "issuer": { + "name": "issuer", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "oidc_config": { + "name": "oidc_config", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "saml_config": { + "name": "saml_config", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "provider_id": { + "name": "provider_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "organization_id": { + "name": "organization_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "domain": { + "name": "domain", + "type": "text", + "primaryKey": false, + "notNull": true + } + }, + "indexes": {}, + "foreignKeys": { + "sso_providers_user_id_users_id_fk": { + "name": "sso_providers_user_id_users_id_fk", + "tableFrom": "sso_providers", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "sso_providers_provider_id_unique": { + "name": "sso_providers_provider_id_unique", + "nullsNotDistinct": false, + "columns": ["provider_id"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.user_roles": { + "name": "user_roles", + "schema": "", + "columns": { + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "role": { + "name": "role", + "type": "role", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "user_roles_user_id_users_id_fk": { + "name": "user_roles_user_id_users_id_fk", + "tableFrom": "user_roles", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "user_roles_user_id_role_pk": { + "name": "user_roles_user_id_role_pk", + "columns": ["user_id", "role"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.users": { + "name": "users", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "email": { + "name": "email", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "image": { + "name": "image", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "email_verified": { + "name": "email_verified", + "type": "boolean", + "primaryKey": false, + "notNull": true, + "default": false + }, + "groups": { + "name": "groups", + "type": "text[]", + "primaryKey": false, + "notNull": true, + "default": "'{}'" + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "users_email_unique": { + "name": "users_email_unique", + "nullsNotDistinct": false, + "columns": ["email"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.verifications": { + "name": "verifications", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "identifier": { + "name": "identifier", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "value": { + "name": "value", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "expires_at": { + "name": "expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.action_policy": { + "name": "action_policy", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "mode": { + "name": "mode", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "deny": { + "name": "deny", + "type": "text[]", + "primaryKey": false, + "notNull": true + }, + "allow": { + "name": "allow", + "type": "text[]", + "primaryKey": false, + "notNull": true + }, + "updated_by": { + "name": "updated_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.computer_page_frame": { + "name": "computer_page_frame", + "schema": "", + "columns": { + "computer_id": { + "name": "computer_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "tool_call_id": { + "name": "tool_call_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "url": { + "name": "url", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "frame": { + "name": "frame", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "captured_at": { + "name": "captured_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "computer_page_frame_captured_idx": { + "name": "computer_page_frame_captured_idx", + "columns": [ + { + "expression": "captured_at", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": { + "computer_page_frame_computer_id_tool_call_id_pk": { + "name": "computer_page_frame_computer_id_tool_call_id_pk", + "columns": ["computer_id", "tool_call_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.computer_snapshot": { + "name": "computer_snapshot", + "schema": "", + "columns": { + "computer_id": { + "name": "computer_id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "snapshot_id": { + "name": "snapshot_id", + "type": "integer", + "primaryKey": false, + "notNull": true + }, + "url": { + "name": "url", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "elements": { + "name": "elements", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "taken_at": { + "name": "taken_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "session": { + "name": "session", + "type": "text", + "primaryKey": false, + "notNull": false + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.agent_preferences": { + "name": "agent_preferences", + "schema": "", + "columns": { + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "hidden_at": { + "name": "hidden_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + } + }, + "indexes": {}, + "foreignKeys": { + "agent_preferences_user_id_users_id_fk": { + "name": "agent_preferences_user_id_users_id_fk", + "tableFrom": "agent_preferences", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "agent_preferences_agent_id_agents_id_fk": { + "name": "agent_preferences_agent_id_agents_id_fk", + "tableFrom": "agent_preferences", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "agent_preferences_user_id_agent_id_pk": { + "name": "agent_preferences_user_id_agent_id_pk", + "columns": ["user_id", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.agent_profiles": { + "name": "agent_profiles", + "schema": "", + "columns": { + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "owner_user_id": { + "name": "owner_user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "role_description": { + "name": "role_description", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "avatar_seed": { + "name": "avatar_seed", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "visibility": { + "name": "visibility", + "type": "agent_visibility", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "callback_token_hash": { + "name": "callback_token_hash", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "callback_token_issued_at": { + "name": "callback_token_issued_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "deleted_at": { + "name": "deleted_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "agent_profiles_visibility_deleted_idx": { + "name": "agent_profiles_visibility_deleted_idx", + "columns": [ + { + "expression": "visibility", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "deleted_at", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "agent_profiles_agent_id_agents_id_fk": { + "name": "agent_profiles_agent_id_agents_id_fk", + "tableFrom": "agent_profiles", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "agent_profiles_owner_user_id_users_id_fk": { + "name": "agent_profiles_owner_user_id_users_id_fk", + "tableFrom": "agent_profiles", + "tableTo": "users", + "columnsFrom": ["owner_user_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.component_exclusions": { + "name": "component_exclusions", + "schema": "", + "columns": { + "component_name": { + "name": "component_name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "withheld_by": { + "name": "withheld_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "component_exclusions_component_name_components_name_fk": { + "name": "component_exclusions_component_name_components_name_fk", + "tableFrom": "component_exclusions", + "tableTo": "components", + "columnsFrom": ["component_name"], + "columnsTo": ["name"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "component_exclusions_agent_id_agents_id_fk": { + "name": "component_exclusions_agent_id_agents_id_fk", + "tableFrom": "component_exclusions", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "component_exclusions_component_name_agent_id_pk": { + "name": "component_exclusions_component_name_agent_id_pk", + "columns": ["component_name", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.component_functions": { + "name": "component_functions", + "schema": "", + "columns": { + "component_name": { + "name": "component_name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "function_name": { + "name": "function_name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "granted_by": { + "name": "granted_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "component_functions_component_name_components_name_fk": { + "name": "component_functions_component_name_components_name_fk", + "tableFrom": "component_functions", + "tableTo": "components", + "columnsFrom": ["component_name"], + "columnsTo": ["name"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "component_functions_component_name_function_name_pk": { + "name": "component_functions_component_name_function_name_pk", + "columns": ["component_name", "function_name"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.components": { + "name": "components", + "schema": "", + "columns": { + "name": { + "name": "name", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "kind": { + "name": "kind", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "draft_description": { + "name": "draft_description", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "published_description": { + "name": "published_description", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published": { + "name": "published", + "type": "boolean", + "primaryKey": false, + "notNull": true, + "default": false + }, + "published_at": { + "name": "published_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "updated_by": { + "name": "updated_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.mcp_servers": { + "name": "mcp_servers", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "vendor": { + "name": "vendor", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "url": { + "name": "url", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "provenance": { + "name": "provenance", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "'first-party'" + }, + "credential_id": { + "name": "credential_id", + "type": "uuid", + "primaryKey": false, + "notNull": false + }, + "tools_refreshed_at": { + "name": "tools_refreshed_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "last_error": { + "name": "last_error", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "added_by": { + "name": "added_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "mcp_servers_credential_id_credentials_id_fk": { + "name": "mcp_servers_credential_id_credentials_id_fk", + "tableFrom": "mcp_servers", + "tableTo": "credentials", + "columnsFrom": ["credential_id"], + "columnsTo": ["id"], + "onDelete": "restrict", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.mcp_tools": { + "name": "mcp_tools", + "schema": "", + "columns": { + "server_id": { + "name": "server_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "description": { + "name": "description", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "input_schema": { + "name": "input_schema", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "mcp_tools_server_id_mcp_servers_id_fk": { + "name": "mcp_tools_server_id_mcp_servers_id_fk", + "tableFrom": "mcp_tools", + "tableTo": "mcp_servers", + "columnsFrom": ["server_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "mcp_tools_server_id_name_pk": { + "name": "mcp_tools_server_id_name_pk", + "columns": ["server_id", "name"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.mcp_user_credentials": { + "name": "mcp_user_credentials", + "schema": "", + "columns": { + "server_id": { + "name": "server_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "credential_id": { + "name": "credential_id", + "type": "uuid", + "primaryKey": false, + "notNull": true + }, + "scope": { + "name": "scope", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "connected_at": { + "name": "connected_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "mcp_user_credentials_user_idx": { + "name": "mcp_user_credentials_user_idx", + "columns": [ + { + "expression": "user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "mcp_user_credentials_server_id_mcp_servers_id_fk": { + "name": "mcp_user_credentials_server_id_mcp_servers_id_fk", + "tableFrom": "mcp_user_credentials", + "tableTo": "mcp_servers", + "columnsFrom": ["server_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "mcp_user_credentials_user_id_users_id_fk": { + "name": "mcp_user_credentials_user_id_users_id_fk", + "tableFrom": "mcp_user_credentials", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "mcp_user_credentials_credential_id_credentials_id_fk": { + "name": "mcp_user_credentials_credential_id_credentials_id_fk", + "tableFrom": "mcp_user_credentials", + "tableTo": "credentials", + "columnsFrom": ["credential_id"], + "columnsTo": ["id"], + "onDelete": "no action", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "mcp_user_credentials_server_id_user_id_pk": { + "name": "mcp_user_credentials_server_id_user_id_pk", + "columns": ["server_id", "user_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.plugin_grants": { + "name": "plugin_grants", + "schema": "", + "columns": { + "kind": { + "name": "kind", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "ref": { + "name": "ref", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "granted_by": { + "name": "granted_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "plugin_grants_agent_idx": { + "name": "plugin_grants_agent_idx", + "columns": [ + { + "expression": "agent_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "plugin_grants_agent_id_agents_id_fk": { + "name": "plugin_grants_agent_id_agents_id_fk", + "tableFrom": "plugin_grants", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "plugin_grants_kind_ref_agent_id_pk": { + "name": "plugin_grants_kind_ref_agent_id_pk", + "columns": ["kind", "ref", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.sandboxed_components": { + "name": "sandboxed_components", + "schema": "", + "columns": { + "name": { + "name": "name", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "draft_description": { + "name": "draft_description", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_html": { + "name": "draft_html", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_css": { + "name": "draft_css", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_js_functions": { + "name": "draft_js_functions", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_argument_schema": { + "name": "draft_argument_schema", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "published_description": { + "name": "published_description", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_html": { + "name": "published_html", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_css": { + "name": "published_css", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_js_functions": { + "name": "published_js_functions", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_argument_schema": { + "name": "published_argument_schema", + "type": "jsonb", + "primaryKey": false, + "notNull": false + }, + "sample_arguments": { + "name": "sample_arguments", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "revision": { + "name": "revision", + "type": "integer", + "primaryKey": false, + "notNull": true, + "default": 0 + }, + "published": { + "name": "published", + "type": "boolean", + "primaryKey": false, + "notNull": true, + "default": false + }, + "published_at": { + "name": "published_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "authored_by": { + "name": "authored_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.skill_tools": { + "name": "skill_tools", + "schema": "", + "columns": { + "skill_id": { + "name": "skill_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "ref": { + "name": "ref", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "declared_by": { + "name": "declared_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "skill_tools_ref_idx": { + "name": "skill_tools_ref_idx", + "columns": [ + { + "expression": "ref", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "skill_tools_skill_id_skills_id_fk": { + "name": "skill_tools_skill_id_skills_id_fk", + "tableFrom": "skill_tools", + "tableTo": "skills", + "columnsFrom": ["skill_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "skill_tools_skill_id_ref_pk": { + "name": "skill_tools_skill_id_ref_pk", + "columns": ["skill_id", "ref"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.skills": { + "name": "skills", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "owner_user_id": { + "name": "owner_user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "slug": { + "name": "slug", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "summary": { + "name": "summary", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "instructions": { + "name": "instructions", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "origin": { + "name": "origin", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "'yours'" + }, + "installed_by": { + "name": "installed_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "skills_slug_key": { + "name": "skills_slug_key", + "columns": [ + { + "expression": "slug", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "concurrently": false, + "method": "btree", + "with": {} + }, + "skills_owner_idx": { + "name": "skills_owner_idx", + "columns": [ + { + "expression": "owner_user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "skills_owner_user_id_users_id_fk": { + "name": "skills_owner_user_id_users_id_fk", + "tableFrom": "skills", + "tableTo": "users", + "columnsFrom": ["owner_user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.work_items": { + "name": "work_items", + "schema": "", + "columns": { + "kind": { + "name": "kind", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "key": { + "name": "key", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "run_at": { + "name": "run_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "claimed_by": { + "name": "claimed_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "lease_until": { + "name": "lease_until", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "attempts": { + "name": "attempts", + "type": "integer", + "primaryKey": false, + "notNull": true, + "default": 0 + }, + "finished_at": { + "name": "finished_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "last_error": { + "name": "last_error", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "payload": { + "name": "payload", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "work_items_claimable_idx": { + "name": "work_items_claimable_idx", + "columns": [ + { + "expression": "kind", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "run_at", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": { + "work_items_kind_key_pk": { + "name": "work_items_kind_key_pk", + "columns": ["kind", "key"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + } + }, + "enums": { + "public.agent_type": { + "name": "agent_type", + "schema": "public", + "values": ["built_in", "remote_ag_ui"] + }, + "public.credential_kind": { + "name": "credential_kind", + "schema": "public", + "values": [ + "model", + "connector", + "agent", + "mcp", + "mcp_oauth_client", + "mcp_user_token" + ] + }, + "public.role": { + "name": "role", + "schema": "public", + "values": ["admin", "user"] + }, + "public.agent_visibility": { + "name": "agent_visibility", + "schema": "public", + "values": ["public", "private"] + } + }, + "schemas": {}, + "sequences": {}, + "roles": {}, + "policies": {}, + "views": {}, + "_meta": { + "columns": {}, + "schemas": {}, + "tables": {} + } +} diff --git a/server/drizzle/meta/0019_snapshot.json b/server/drizzle/meta/0019_snapshot.json new file mode 100644 index 00000000..e899ec13 --- /dev/null +++ b/server/drizzle/meta/0019_snapshot.json @@ -0,0 +1,2583 @@ +{ + "id": "9f46b81a-bfe4-4c29-ab95-e08d00506767", + "prevId": "aa5ec39b-170c-495b-b4a9-e08ed0fd643d", + "version": "7", + "dialect": "postgresql", + "tables": { + "public.accounts": { + "name": "accounts", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "account_id": { + "name": "account_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "provider_id": { + "name": "provider_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "issuer": { + "name": "issuer", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "access_token": { + "name": "access_token", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "refresh_token": { + "name": "refresh_token", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "id_token": { + "name": "id_token", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "access_token_expires_at": { + "name": "access_token_expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "refresh_token_expires_at": { + "name": "refresh_token_expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "scope": { + "name": "scope", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "password": { + "name": "password", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "accounts_provider_account_idx": { + "name": "accounts_provider_account_idx", + "columns": [ + { + "expression": "provider_id", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "account_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "accounts_user_id_users_id_fk": { + "name": "accounts_user_id_users_id_fk", + "tableFrom": "accounts", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.agents": { + "name": "agents", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "type": { + "name": "type", + "type": "agent_type", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "configuration": { + "name": "configuration", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "package_id": { + "name": "package_id", + "type": "uuid", + "primaryKey": false, + "notNull": false + }, + "override": { + "name": "override", + "type": "jsonb", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "agents_package_id_deployment_packages_id_fk": { + "name": "agents_package_id_deployment_packages_id_fk", + "tableFrom": "agents", + "tableTo": "deployment_packages", + "columnsFrom": ["package_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.audit_events": { + "name": "audit_events", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "uuid", + "primaryKey": true, + "notNull": true, + "default": "gen_random_uuid()" + }, + "actor_user_id": { + "name": "actor_user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "event_type": { + "name": "event_type", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "target_type": { + "name": "target_type", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "target_id": { + "name": "target_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "payload": { + "name": "payload", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "audit_events_created_at_idx": { + "name": "audit_events_created_at_idx", + "columns": [ + { + "expression": "created_at", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "audit_events_type_time_idx": { + "name": "audit_events_type_time_idx", + "columns": [ + { + "expression": "event_type", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "created_at", + "isExpression": false, + "asc": false, + "nulls": "last" + }, + { + "expression": "id", + "isExpression": false, + "asc": false, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "audit_events_actor_time_idx": { + "name": "audit_events_actor_time_idx", + "columns": [ + { + "expression": "actor_user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "created_at", + "isExpression": false, + "asc": false, + "nulls": "last" + }, + { + "expression": "id", + "isExpression": false, + "asc": false, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + }, + "audit_events_target_time_idx": { + "name": "audit_events_target_time_idx", + "columns": [ + { + "expression": "target_type", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "target_id", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "created_at", + "isExpression": false, + "asc": false, + "nulls": "last" + }, + { + "expression": "id", + "isExpression": false, + "asc": false, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.channel_agents": { + "name": "channel_agents", + "schema": "", + "columns": { + "channel_id": { + "name": "channel_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "channel_agents_channel_id_channels_id_fk": { + "name": "channel_agents_channel_id_channels_id_fk", + "tableFrom": "channel_agents", + "tableTo": "channels", + "columnsFrom": ["channel_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "channel_agents_agent_id_agents_id_fk": { + "name": "channel_agents_agent_id_agents_id_fk", + "tableFrom": "channel_agents", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "channel_agents_channel_id_agent_id_pk": { + "name": "channel_agents_channel_id_agent_id_pk", + "columns": ["channel_id", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.channel_memberships": { + "name": "channel_memberships", + "schema": "", + "columns": { + "channel_id": { + "name": "channel_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "pinned_at": { + "name": "pinned_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "last_read_at": { + "name": "last_read_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "channel_memberships_channel_id_channels_id_fk": { + "name": "channel_memberships_channel_id_channels_id_fk", + "tableFrom": "channel_memberships", + "tableTo": "channels", + "columnsFrom": ["channel_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "channel_memberships_user_id_users_id_fk": { + "name": "channel_memberships_user_id_users_id_fk", + "tableFrom": "channel_memberships", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "channel_memberships_channel_id_user_id_pk": { + "name": "channel_memberships_channel_id_user_id_pk", + "columns": ["channel_id", "user_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.channels": { + "name": "channels", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "description": { + "name": "description", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "suggested_prompts": { + "name": "suggested_prompts", + "type": "text[]", + "primaryKey": false, + "notNull": true, + "default": "'{}'" + }, + "allowed_groups": { + "name": "allowed_groups", + "type": "text[]", + "primaryKey": false, + "notNull": true, + "default": "'{}'" + }, + "package_id": { + "name": "package_id", + "type": "uuid", + "primaryKey": false, + "notNull": false + }, + "override": { + "name": "override", + "type": "jsonb", + "primaryKey": false, + "notNull": false + }, + "last_message": { + "name": "last_message", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "last_message_at": { + "name": "last_message_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "last_message_agent_id": { + "name": "last_message_agent_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "deleted_at": { + "name": "deleted_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "channels_recent_activity_idx": { + "name": "channels_recent_activity_idx", + "columns": [ + { + "expression": "COALESCE(\"last_message_at\", \"created_at\") DESC", + "asc": true, + "isExpression": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "channels_package_id_deployment_packages_id_fk": { + "name": "channels_package_id_deployment_packages_id_fk", + "tableFrom": "channels", + "tableTo": "deployment_packages", + "columnsFrom": ["package_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + }, + "channels_last_message_agent_id_agents_id_fk": { + "name": "channels_last_message_agent_id_agents_id_fk", + "tableFrom": "channels", + "tableTo": "agents", + "columnsFrom": ["last_message_agent_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.credentials": { + "name": "credentials", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "uuid", + "primaryKey": true, + "notNull": true, + "default": "gen_random_uuid()" + }, + "kind": { + "name": "kind", + "type": "credential_kind", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "provider": { + "name": "provider", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "encrypted_value": { + "name": "encrypted_value", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "key_id": { + "name": "key_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "metadata": { + "name": "metadata", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "revoked_at": { + "name": "revoked_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "credentials_active_key_idx": { + "name": "credentials_active_key_idx", + "columns": [ + { + "expression": "kind", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "provider", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "key_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "where": "\"credentials\".\"revoked_at\" IS NULL", + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.deployment_packages": { + "name": "deployment_packages", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "uuid", + "primaryKey": true, + "notNull": true, + "default": "gen_random_uuid()" + }, + "tenant_id": { + "name": "tenant_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "source_path": { + "name": "source_path", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "checksum": { + "name": "checksum", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "loaded_at": { + "name": "loaded_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "deployment_packages_tenant_id_unique": { + "name": "deployment_packages_tenant_id_unique", + "nullsNotDistinct": false, + "columns": ["tenant_id"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.intelligence_channel_mappings": { + "name": "intelligence_channel_mappings", + "schema": "", + "columns": { + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "channel_id": { + "name": "channel_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "thread_id": { + "name": "thread_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "intelligence_channel_mappings_thread_idx": { + "name": "intelligence_channel_mappings_thread_idx", + "columns": [ + { + "expression": "thread_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "intelligence_channel_mappings_user_id_users_id_fk": { + "name": "intelligence_channel_mappings_user_id_users_id_fk", + "tableFrom": "intelligence_channel_mappings", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "intelligence_channel_mappings_channel_id_channels_id_fk": { + "name": "intelligence_channel_mappings_channel_id_channels_id_fk", + "tableFrom": "intelligence_channel_mappings", + "tableTo": "channels", + "columnsFrom": ["channel_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "intelligence_channel_mappings_user_id_channel_id_pk": { + "name": "intelligence_channel_mappings_user_id_channel_id_pk", + "columns": ["user_id", "channel_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.revoked_access": { + "name": "revoked_access", + "schema": "", + "columns": { + "email": { + "name": "email", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "revoked_at": { + "name": "revoked_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "revoked_by": { + "name": "revoked_by", + "type": "text", + "primaryKey": false, + "notNull": true + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.sessions": { + "name": "sessions", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "token": { + "name": "token", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "expires_at": { + "name": "expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true + }, + "ip_address": { + "name": "ip_address", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "user_agent": { + "name": "user_agent", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "sessions_user_id_users_id_fk": { + "name": "sessions_user_id_users_id_fk", + "tableFrom": "sessions", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "sessions_token_unique": { + "name": "sessions_token_unique", + "nullsNotDistinct": false, + "columns": ["token"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.sso_providers": { + "name": "sso_providers", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "issuer": { + "name": "issuer", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "oidc_config": { + "name": "oidc_config", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "saml_config": { + "name": "saml_config", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "provider_id": { + "name": "provider_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "organization_id": { + "name": "organization_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "domain": { + "name": "domain", + "type": "text", + "primaryKey": false, + "notNull": true + } + }, + "indexes": {}, + "foreignKeys": { + "sso_providers_user_id_users_id_fk": { + "name": "sso_providers_user_id_users_id_fk", + "tableFrom": "sso_providers", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "sso_providers_provider_id_unique": { + "name": "sso_providers_provider_id_unique", + "nullsNotDistinct": false, + "columns": ["provider_id"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.user_roles": { + "name": "user_roles", + "schema": "", + "columns": { + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "role": { + "name": "role", + "type": "role", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "user_roles_user_id_users_id_fk": { + "name": "user_roles_user_id_users_id_fk", + "tableFrom": "user_roles", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "user_roles_user_id_role_pk": { + "name": "user_roles_user_id_role_pk", + "columns": ["user_id", "role"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.users": { + "name": "users", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "email": { + "name": "email", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "image": { + "name": "image", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "email_verified": { + "name": "email_verified", + "type": "boolean", + "primaryKey": false, + "notNull": true, + "default": false + }, + "groups": { + "name": "groups", + "type": "text[]", + "primaryKey": false, + "notNull": true, + "default": "'{}'" + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": { + "users_email_unique": { + "name": "users_email_unique", + "nullsNotDistinct": false, + "columns": ["email"] + } + }, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.verifications": { + "name": "verifications", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "identifier": { + "name": "identifier", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "value": { + "name": "value", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "expires_at": { + "name": "expires_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.action_policy": { + "name": "action_policy", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "mode": { + "name": "mode", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "deny": { + "name": "deny", + "type": "text[]", + "primaryKey": false, + "notNull": true + }, + "allow": { + "name": "allow", + "type": "text[]", + "primaryKey": false, + "notNull": true + }, + "updated_by": { + "name": "updated_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.computer_page_frame": { + "name": "computer_page_frame", + "schema": "", + "columns": { + "computer_id": { + "name": "computer_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "tool_call_id": { + "name": "tool_call_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "url": { + "name": "url", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "frame": { + "name": "frame", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "captured_at": { + "name": "captured_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "computer_page_frame_captured_idx": { + "name": "computer_page_frame_captured_idx", + "columns": [ + { + "expression": "captured_at", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": { + "computer_page_frame_computer_id_tool_call_id_pk": { + "name": "computer_page_frame_computer_id_tool_call_id_pk", + "columns": ["computer_id", "tool_call_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.computer_snapshot": { + "name": "computer_snapshot", + "schema": "", + "columns": { + "computer_id": { + "name": "computer_id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "snapshot_id": { + "name": "snapshot_id", + "type": "integer", + "primaryKey": false, + "notNull": true + }, + "url": { + "name": "url", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "elements": { + "name": "elements", + "type": "jsonb", + "primaryKey": false, + "notNull": true + }, + "taken_at": { + "name": "taken_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "session": { + "name": "session", + "type": "text", + "primaryKey": false, + "notNull": false + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.agent_preferences": { + "name": "agent_preferences", + "schema": "", + "columns": { + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "hidden_at": { + "name": "hidden_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + } + }, + "indexes": {}, + "foreignKeys": { + "agent_preferences_user_id_users_id_fk": { + "name": "agent_preferences_user_id_users_id_fk", + "tableFrom": "agent_preferences", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "agent_preferences_agent_id_agents_id_fk": { + "name": "agent_preferences_agent_id_agents_id_fk", + "tableFrom": "agent_preferences", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "agent_preferences_user_id_agent_id_pk": { + "name": "agent_preferences_user_id_agent_id_pk", + "columns": ["user_id", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.agent_profiles": { + "name": "agent_profiles", + "schema": "", + "columns": { + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "owner_user_id": { + "name": "owner_user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "role_description": { + "name": "role_description", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "avatar_seed": { + "name": "avatar_seed", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "visibility": { + "name": "visibility", + "type": "agent_visibility", + "typeSchema": "public", + "primaryKey": false, + "notNull": true + }, + "callback_token_hash": { + "name": "callback_token_hash", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "callback_token_issued_at": { + "name": "callback_token_issued_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "deleted_at": { + "name": "deleted_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "agent_profiles_visibility_deleted_idx": { + "name": "agent_profiles_visibility_deleted_idx", + "columns": [ + { + "expression": "visibility", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "deleted_at", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "agent_profiles_agent_id_agents_id_fk": { + "name": "agent_profiles_agent_id_agents_id_fk", + "tableFrom": "agent_profiles", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "agent_profiles_owner_user_id_users_id_fk": { + "name": "agent_profiles_owner_user_id_users_id_fk", + "tableFrom": "agent_profiles", + "tableTo": "users", + "columnsFrom": ["owner_user_id"], + "columnsTo": ["id"], + "onDelete": "set null", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.component_exclusions": { + "name": "component_exclusions", + "schema": "", + "columns": { + "component_name": { + "name": "component_name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "withheld_by": { + "name": "withheld_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "component_exclusions_component_name_components_name_fk": { + "name": "component_exclusions_component_name_components_name_fk", + "tableFrom": "component_exclusions", + "tableTo": "components", + "columnsFrom": ["component_name"], + "columnsTo": ["name"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "component_exclusions_agent_id_agents_id_fk": { + "name": "component_exclusions_agent_id_agents_id_fk", + "tableFrom": "component_exclusions", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "component_exclusions_component_name_agent_id_pk": { + "name": "component_exclusions_component_name_agent_id_pk", + "columns": ["component_name", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.component_functions": { + "name": "component_functions", + "schema": "", + "columns": { + "component_name": { + "name": "component_name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "function_name": { + "name": "function_name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "granted_by": { + "name": "granted_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "component_functions_component_name_components_name_fk": { + "name": "component_functions_component_name_components_name_fk", + "tableFrom": "component_functions", + "tableTo": "components", + "columnsFrom": ["component_name"], + "columnsTo": ["name"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "component_functions_component_name_function_name_pk": { + "name": "component_functions_component_name_function_name_pk", + "columns": ["component_name", "function_name"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.components": { + "name": "components", + "schema": "", + "columns": { + "name": { + "name": "name", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "kind": { + "name": "kind", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "draft_description": { + "name": "draft_description", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "published_description": { + "name": "published_description", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published": { + "name": "published", + "type": "boolean", + "primaryKey": false, + "notNull": true, + "default": false + }, + "published_at": { + "name": "published_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "updated_by": { + "name": "updated_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.mcp_servers": { + "name": "mcp_servers", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "vendor": { + "name": "vendor", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "url": { + "name": "url", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "provenance": { + "name": "provenance", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "'first-party'" + }, + "credential_id": { + "name": "credential_id", + "type": "uuid", + "primaryKey": false, + "notNull": false + }, + "tools_refreshed_at": { + "name": "tools_refreshed_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "last_error": { + "name": "last_error", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "added_by": { + "name": "added_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "mcp_servers_credential_id_credentials_id_fk": { + "name": "mcp_servers_credential_id_credentials_id_fk", + "tableFrom": "mcp_servers", + "tableTo": "credentials", + "columnsFrom": ["credential_id"], + "columnsTo": ["id"], + "onDelete": "restrict", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.mcp_tools": { + "name": "mcp_tools", + "schema": "", + "columns": { + "server_id": { + "name": "server_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "name": { + "name": "name", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "description": { + "name": "description", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "input_schema": { + "name": "input_schema", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": { + "mcp_tools_server_id_mcp_servers_id_fk": { + "name": "mcp_tools_server_id_mcp_servers_id_fk", + "tableFrom": "mcp_tools", + "tableTo": "mcp_servers", + "columnsFrom": ["server_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "mcp_tools_server_id_name_pk": { + "name": "mcp_tools_server_id_name_pk", + "columns": ["server_id", "name"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.mcp_user_credentials": { + "name": "mcp_user_credentials", + "schema": "", + "columns": { + "server_id": { + "name": "server_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "user_id": { + "name": "user_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "credential_id": { + "name": "credential_id", + "type": "uuid", + "primaryKey": false, + "notNull": true + }, + "scope": { + "name": "scope", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "connected_at": { + "name": "connected_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "mcp_user_credentials_user_idx": { + "name": "mcp_user_credentials_user_idx", + "columns": [ + { + "expression": "user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "mcp_user_credentials_server_id_mcp_servers_id_fk": { + "name": "mcp_user_credentials_server_id_mcp_servers_id_fk", + "tableFrom": "mcp_user_credentials", + "tableTo": "mcp_servers", + "columnsFrom": ["server_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "mcp_user_credentials_user_id_users_id_fk": { + "name": "mcp_user_credentials_user_id_users_id_fk", + "tableFrom": "mcp_user_credentials", + "tableTo": "users", + "columnsFrom": ["user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + }, + "mcp_user_credentials_credential_id_credentials_id_fk": { + "name": "mcp_user_credentials_credential_id_credentials_id_fk", + "tableFrom": "mcp_user_credentials", + "tableTo": "credentials", + "columnsFrom": ["credential_id"], + "columnsTo": ["id"], + "onDelete": "no action", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "mcp_user_credentials_server_id_user_id_pk": { + "name": "mcp_user_credentials_server_id_user_id_pk", + "columns": ["server_id", "user_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.plugin_grants": { + "name": "plugin_grants", + "schema": "", + "columns": { + "kind": { + "name": "kind", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "ref": { + "name": "ref", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "agent_id": { + "name": "agent_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "granted_by": { + "name": "granted_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "plugin_grants_agent_idx": { + "name": "plugin_grants_agent_idx", + "columns": [ + { + "expression": "agent_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "plugin_grants_agent_id_agents_id_fk": { + "name": "plugin_grants_agent_id_agents_id_fk", + "tableFrom": "plugin_grants", + "tableTo": "agents", + "columnsFrom": ["agent_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "plugin_grants_kind_ref_agent_id_pk": { + "name": "plugin_grants_kind_ref_agent_id_pk", + "columns": ["kind", "ref", "agent_id"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.sandboxed_components": { + "name": "sandboxed_components", + "schema": "", + "columns": { + "name": { + "name": "name", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "draft_description": { + "name": "draft_description", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_html": { + "name": "draft_html", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_css": { + "name": "draft_css", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_js_functions": { + "name": "draft_js_functions", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "''" + }, + "draft_argument_schema": { + "name": "draft_argument_schema", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "published_description": { + "name": "published_description", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_html": { + "name": "published_html", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_css": { + "name": "published_css", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_js_functions": { + "name": "published_js_functions", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "published_argument_schema": { + "name": "published_argument_schema", + "type": "jsonb", + "primaryKey": false, + "notNull": false + }, + "sample_arguments": { + "name": "sample_arguments", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "revision": { + "name": "revision", + "type": "integer", + "primaryKey": false, + "notNull": true, + "default": 0 + }, + "published": { + "name": "published", + "type": "boolean", + "primaryKey": false, + "notNull": true, + "default": false + }, + "published_at": { + "name": "published_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "authored_by": { + "name": "authored_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": {}, + "foreignKeys": {}, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.skill_tools": { + "name": "skill_tools", + "schema": "", + "columns": { + "skill_id": { + "name": "skill_id", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "ref": { + "name": "ref", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "declared_by": { + "name": "declared_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "skill_tools_ref_idx": { + "name": "skill_tools_ref_idx", + "columns": [ + { + "expression": "ref", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "skill_tools_skill_id_skills_id_fk": { + "name": "skill_tools_skill_id_skills_id_fk", + "tableFrom": "skill_tools", + "tableTo": "skills", + "columnsFrom": ["skill_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": { + "skill_tools_skill_id_ref_pk": { + "name": "skill_tools_skill_id_ref_pk", + "columns": ["skill_id", "ref"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.skills": { + "name": "skills", + "schema": "", + "columns": { + "id": { + "name": "id", + "type": "text", + "primaryKey": true, + "notNull": true + }, + "owner_user_id": { + "name": "owner_user_id", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "slug": { + "name": "slug", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "title": { + "name": "title", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "summary": { + "name": "summary", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "instructions": { + "name": "instructions", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "origin": { + "name": "origin", + "type": "text", + "primaryKey": false, + "notNull": true, + "default": "'yours'" + }, + "installed_by": { + "name": "installed_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "skills_slug_key": { + "name": "skills_slug_key", + "columns": [ + { + "expression": "slug", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": true, + "concurrently": false, + "method": "btree", + "with": {} + }, + "skills_owner_idx": { + "name": "skills_owner_idx", + "columns": [ + { + "expression": "owner_user_id", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": { + "skills_owner_user_id_users_id_fk": { + "name": "skills_owner_user_id_users_id_fk", + "tableFrom": "skills", + "tableTo": "users", + "columnsFrom": ["owner_user_id"], + "columnsTo": ["id"], + "onDelete": "cascade", + "onUpdate": "no action" + } + }, + "compositePrimaryKeys": {}, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + }, + "public.work_items": { + "name": "work_items", + "schema": "", + "columns": { + "kind": { + "name": "kind", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "key": { + "name": "key", + "type": "text", + "primaryKey": false, + "notNull": true + }, + "run_at": { + "name": "run_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "claimed_by": { + "name": "claimed_by", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "lease_until": { + "name": "lease_until", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "attempts": { + "name": "attempts", + "type": "integer", + "primaryKey": false, + "notNull": true, + "default": 0 + }, + "finished_at": { + "name": "finished_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": false + }, + "last_error": { + "name": "last_error", + "type": "text", + "primaryKey": false, + "notNull": false + }, + "payload": { + "name": "payload", + "type": "jsonb", + "primaryKey": false, + "notNull": true, + "default": "'{}'::jsonb" + }, + "created_at": { + "name": "created_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + }, + "updated_at": { + "name": "updated_at", + "type": "timestamp with time zone", + "primaryKey": false, + "notNull": true, + "default": "now()" + } + }, + "indexes": { + "work_items_claimable_idx": { + "name": "work_items_claimable_idx", + "columns": [ + { + "expression": "kind", + "isExpression": false, + "asc": true, + "nulls": "last" + }, + { + "expression": "run_at", + "isExpression": false, + "asc": true, + "nulls": "last" + } + ], + "isUnique": false, + "concurrently": false, + "method": "btree", + "with": {} + } + }, + "foreignKeys": {}, + "compositePrimaryKeys": { + "work_items_kind_key_pk": { + "name": "work_items_kind_key_pk", + "columns": ["kind", "key"] + } + }, + "uniqueConstraints": {}, + "policies": {}, + "checkConstraints": {}, + "isRLSEnabled": false + } + }, + "enums": { + "public.agent_type": { + "name": "agent_type", + "schema": "public", + "values": ["built_in", "remote_ag_ui"] + }, + "public.credential_kind": { + "name": "credential_kind", + "schema": "public", + "values": [ + "model", + "connector", + "agent", + "mcp", + "mcp_oauth_client", + "mcp_user_token" + ] + }, + "public.role": { + "name": "role", + "schema": "public", + "values": ["admin", "user"] + }, + "public.agent_visibility": { + "name": "agent_visibility", + "schema": "public", + "values": ["public", "private"] + } + }, + "schemas": {}, + "sequences": {}, + "roles": {}, + "policies": {}, + "views": {}, + "_meta": { + "columns": {}, + "schemas": {}, + "tables": {} + } +} diff --git a/server/drizzle/meta/_journal.json b/server/drizzle/meta/_journal.json index 1162cae9..b2ebb2ae 100644 --- a/server/drizzle/meta/_journal.json +++ b/server/drizzle/meta/_journal.json @@ -113,6 +113,34 @@ "when": 1787525879804, "tag": "0015_credentials_one_live_key", "breakpoints": true + }, + { + "idx": 16, + "version": "7", + "when": 1787581516968, + "tag": "0016_pin_and_soft_delete_channels", + "breakpoints": true + }, + { + "idx": 17, + "version": "7", + "when": 1787684818682, + "tag": "0017_durable_work", + "breakpoints": true + }, + { + "idx": 18, + "version": "7", + "when": 1787688017645, + "tag": "0018_page_frames", + "breakpoints": true + }, + { + "idx": 19, + "version": "7", + "when": 1787744867526, + "tag": "0019_channel_read_marker", + "breakpoints": true } ] } diff --git a/server/scripts/cull-idle-computers.ts b/server/scripts/cull-idle-computers.ts new file mode 100644 index 00000000..626e55ae --- /dev/null +++ b/server/scripts/cull-idle-computers.ts @@ -0,0 +1,100 @@ +/** + * One sweep: notice which computers have gone idle, and suspend whatever this pod can claim. + * + * Run from a CronJob rather than from a timer inside the API. Every replica would fire its own timer + * and each would decide, independently, to suspend the same computer. Deleting old audit rows twice + * is harmless, which is why the retention sweep may work that way; taking a browser away from + * somebody who has just come back is not. + * + * Exits non-zero only when the sweep itself could not run. A computer that refused to suspend is + * reported and left for the next sweep, because a computer still running costs money rather than + * losing anything, and a failing CronJob that pages somebody at 3am should mean something worse. + */ +import { randomUUID } from "node:crypto"; +import { createPageFrameStore } from "../src/computer/page-frames"; +import { createComputerProvider } from "../src/computer/provider"; +import { loadConfig } from "../src/config"; +import { createDatabase } from "../src/db/client"; +import { + CULL_KIND, + offerIdleComputers, + suspendClaimedComputers, +} from "../src/work/culler"; +import { createWorkQueue } from "../src/work/queue"; + +const config = loadConfig(process.env); +if (!config.computer) { + throw new Error( + "No computer provider is configured, so there are no computers to suspend.", + ); +} +if (config.computer.provider !== "sandbox") { + throw new Error( + `The culler only has something to do where each Bot has its own computer, and this deployment uses the "${config.computer.provider}" provider.`, + ); +} + +const database = createDatabase(config.databaseUrl); +const queue = createWorkQueue(database); +const pageFrames = createPageFrameStore(database); +const provider = createComputerProvider(config.computer); + +// A name for the lease, so a stuck claim can be traced back to the pod that took it. +const owner = `culler/${process.env.HOSTNAME ?? randomUUID().slice(0, 8)}`; + +/** + * How long a turn's screenshot is kept. + * + * A month, because reading back a conversation is the thing these exist for and people do that long + * after the run. Past that the transcript names the page it opened instead, which is the same + * sentence with less in it rather than a broken one. + */ +const FRAME_RETENTION_MS = 30 * 24 * 60 * 60 * 1000; + +try { + const options = { + database, + queue, + provider, + idleAfterMs: config.computer.idleAfterMs, + owner, + }; + const { offered } = await offerIdleComputers(options); + const report = await suspendClaimedComputers(options); + /* + * Sweep what has been done for a day. + * + * A finished row is what stops the same key being run twice, so it has to outlive the run by long + * enough for any late replica to collide with it. It does not have to outlive that by a week: a + * queue is not an archive, and the audit trail is where "what happened" lives. + */ + const purged = await queue.purge({ + kind: CULL_KIND, + olderThanMs: 24 * 60 * 60 * 1000, + }); + /* + * And the screenshots, which had a reaper and nothing calling it. + * + * A page is a row and a Bot that browses makes them for as long as it runs, so this table only + * ever grew: written on every navigation, taken out by a profile wipe and by nothing else. Kept + * long enough that reading back a conversation from last month still shows what it opened, and not + * for ever, because these are the largest thing this deployment stores and the least useful once + * nobody is reading that conversation any more. + * + * Here rather than in the API server because this is already the sweep that runs on a schedule + * with a claim under it, and a second timer would be a second thing to get wrong. + */ + const framesPurged = await pageFrames.purge(FRAME_RETENTION_MS); + console.info( + JSON.stringify({ + type: "computer-cull", + offered, + suspended: report.suspended, + skipped: report.skipped, + purged, + framesPurged, + }), + ); +} finally { + await database.$client.end({ timeout: 5 }); +} diff --git a/server/scripts/migrate.ts b/server/scripts/migrate.ts new file mode 100644 index 00000000..e4dddbed --- /dev/null +++ b/server/scripts/migrate.ts @@ -0,0 +1,43 @@ +/** + * Apply the migrations, using only what a running deployment already has. + * + * NOT `drizzle-kit migrate`, and that is the whole point of this file. The CLI is a development + * dependency: it reads `drizzle.config.ts`, which means compiling TypeScript, which means the esbuild + * that `bun install --production` correctly leaves out of a runtime image. Asked to migrate there it + * prints "Reading config file", exits 1, and says nothing at all, so a deployment looks like it + * migrated and comes up against an empty database complaining that `users` does not exist. + * + * The migrator underneath it is part of `drizzle-orm`, which is a runtime dependency because the + * server imports it anyway. It needs a connection and the folder of SQL files, both of which are in + * the image, and it keeps the same `drizzle.__drizzle_migrations` journal the CLI does, so the two + * are interchangeable and a database migrated by either is migrated. + */ +import { join } from "node:path"; +import { drizzle } from "drizzle-orm/postgres-js"; +import { migrate } from "drizzle-orm/postgres-js/migrator"; +import postgres from "postgres"; + +const databaseUrl = process.env.DATABASE_URL; +if (!databaseUrl) { + throw new Error( + "DATABASE_URL must be configured before running a database migration command", + ); +} + +/* + * One connection, and `max: 1`. + * + * Migrations are a single ordered conversation with the database, and a pool would let two + * statements that must be ordered land on different connections. + */ +const client = postgres(databaseUrl, { max: 1, onnotice: () => {} }); + +try { + await migrate(drizzle(client), { + migrationsFolder: join(import.meta.dir, "..", "drizzle"), + }); + console.info(JSON.stringify({ type: "migrations-applied", status: "ok" })); +} finally { + // Released whatever happened, so a failure exits rather than hanging on an open socket. + await client.end({ timeout: 5 }); +} diff --git a/server/src/app.ts b/server/src/app.ts index edd47dff..744a80c4 100644 --- a/server/src/app.ts +++ b/server/src/app.ts @@ -5,8 +5,6 @@ import { authoriseAgentCall } from "./agents/callback-token"; import type { BotAccessCheck } from "./agents/profile-policy"; import type { AgentProfileStore } from "./agents/profile-store"; import { createAgentRoutes } from "./agents/routes"; -import { createRoutingRoutes } from "./routing/routes"; -import type { IntentRouter } from "./routing/classify"; import { type AuditReader, type AuditStore, @@ -34,6 +32,7 @@ import type { ComponentStore } from "./components/store"; import type { ComputerGateway } from "./computer/gateway"; import type { PolicyStore } from "./computer/policy-store"; import { createComputerRoutes } from "./computer/routes"; +import type { PageFrameStore } from "./computer/page-frames"; import { configuredAuthProviders, type DeploymentConfig } from "./config"; import type { CredentialAdminService, CredentialInput } from "./credentials"; import { createIntelligenceClient } from "./intelligence-client"; @@ -41,6 +40,8 @@ import type { PeopleStore } from "./people/store"; import { createPluginRoutes } from "./plugins/routes"; import type { PluginStore } from "./plugins/store"; import { REFUSAL_MARKER } from "./plugins/tools"; +import type { IntentRouter } from "./routing/classify"; +import { createRoutingRoutes } from "./routing/routes"; import type { PackageStatusReader } from "./tenant-package"; /** @@ -155,6 +156,17 @@ export function createApp( * the default coworker, which is exactly the failsafe the router itself falls back to. */ intentRouter?: IntentRouter, + /** + * Where the frame a browsing turn ended on is kept. + * + * Appended last on purpose: these are positional, so inserting one anywhere else silently + * shifts every existing call site's arguments by one. + * + * Absent leaves the transcript working and past turns without a picture, which is the correct + * degraded behaviour: a conversation that cannot show what it saw is better than one that shows + * the wrong thing. + */ + pageFrames?: PageFrameStore, ) { const app = new Hono<{ Variables: AppVariables }>(); @@ -630,6 +642,7 @@ export function createApp( computerPolicy, requireUser, canUseBot, + pageFrames, ), ); } @@ -686,19 +699,10 @@ export function createApp( } } - // Shared by the thread-existence check below and a deleted channel's request to forget its thread. - const intelligence = createIntelligenceClient(config.runtime.intelligence); - if (channelStore) { app.route( "/api/channels", - createChannelRoutes( - channelStore, - requireUser, - channelEvents, - auditStore, - (params) => intelligence.deleteThread(params), - ), + createChannelRoutes(channelStore, requireUser, channelEvents, auditStore), ); } @@ -714,6 +718,24 @@ export function createApp( "/api/plugins", createPluginRoutes(pluginStore, requireUser, canUseBot, { encryptionKey: config.keyEncryptionKey, + /* + * Whether the person a consent was started for still has access, asked when the callback + * lands rather than when the flow began. + * + * The callback carries no session — identity comes from the state — so this is where the + * question gets asked at all. `find` answers both halves of it: no row means a user id that + * names nobody, and `revoked` means an administrator removed them while they were away at + * the vendor. Either way there is no live person for a fresh refresh token to belong to. + * + * No people store means this deployment cannot answer the question, so it refuses rather + * than assuming yes. It also cannot remove anybody, which is exactly why guessing here + * would be a hole nothing else closes. + */ + personHasAccess: async (userId) => { + if (!peopleStore) return false; + const person = await peopleStore.find(userId); + return person !== undefined && !person.revoked; + }, // The deployment-wide fallback a Bot may present, as a yes or no. The secret itself stays // in config and is checked in `/api/agent-tools/call`; the surface only needs to know // whether a Bot without its own credential has any way to call back. @@ -837,9 +859,13 @@ export function createApp( threadIdentity, requireUser, // config.ts refuses to boot without the full Intelligence contract (see copilot.ts's - // header comment), so `config.runtime.intelligence` is never missing here, and the shared - // `intelligence` client built above is never missing either. - createThreadReader(intelligence), + // header comment), so `config.runtime.intelligence` is never missing here. Built from it + // rather than assumed, though: this is the one place besides the runtime mount itself that + // needs to reach Intelligence, and it should keep working unmodified if that guarantee ever + // loosens and a deployment can legitimately have no reader to build. + createThreadReader( + createIntelligenceClient(config.runtime.intelligence), + ), ), ); } diff --git a/server/src/audit.ts b/server/src/audit.ts index 3b738346..b7100e12 100644 --- a/server/src/audit.ts +++ b/server/src/audit.ts @@ -60,9 +60,12 @@ export const auditEventTypes = [ */ "channel.routed", /** - * A channel was deleted, taking its memberships, agent links, and thread mapping with it. The - * channel row is already gone by the time this is written, so this is the only place left that - * says it ever existed. `payload.threadForgotten: false` marks a thread that outlived it. + * A channel was removed from every member's roster, and by whom. + * + * The removal is soft, so the row and its thread survive and `channels.deleted_at` records that it + * happened. What it cannot record is who did it: a timestamp answers "when did that conversation + * disappear" and not "who ended it for everybody in it", which is the half somebody asks about. + * `payload.mechanism` names how, so a later hard delete is distinguishable from this one. */ "channel.deleted", "agent.invoked", diff --git a/server/src/auth/signed-value.ts b/server/src/auth/signed-value.ts index e6acc31a..026ea80a 100644 --- a/server/src/auth/signed-value.ts +++ b/server/src/auth/signed-value.ts @@ -1,4 +1,5 @@ import { createHmac, timingSafeEqual } from "node:crypto"; +import { decryptSecret, encryptSecret } from "../credentials"; /** * A value this deployment can hand out and later recognise as its own. @@ -7,6 +8,13 @@ import { createHmac, timingSafeEqual } from "node:crypto"; * carried by a customer's own agent process, for instance. The alternative is a row per statement, * which buys nothing here because these are short-lived and single-purpose, and costs a write and a * read on a path that already has both. + * + * Two shapes, and the difference between them is the whole point of this module. A SIGNED value is + * authenticated and readable: anybody holding it can read what it says, and only this deployment can + * make another one. A SEALED value is authenticated and unreadable: nobody without the key learns + * anything from holding it. Which one a statement needs is decided by what is inside it — a signed + * value is right for a claim that is public anyway, and is wrong the moment the statement carries a + * secret of its own. */ /** @@ -59,3 +67,64 @@ export function verify( if (given.length !== wanted.length) return null; return timingSafeEqual(given, wanted) ? value : null; } + +/** + * The key a value is sealed with. + * + * Derived like a signing key and under a distinguished prefix, so the same deployment secret gives + * this use its own material: a sealing key is never a signing key, and neither is the key the + * credential vault encrypts with. AES-256 wants 32 bytes and an HMAC-SHA256 digest is exactly that, + * base64 because {@link encryptSecret} takes its key that way. + */ +function sealingKey(encryptionKey: string, label: string): string { + return createHmac("sha256", encryptionKey) + .update(`seal:${label}`) + .digest("base64"); +} + +/** + * A value nobody but this deployment can read, in one URL-safe string. + * + * AES-256-GCM, through the same helper the credential vault uses rather than a second crypto + * implementation to keep right. GCM authenticates as well as encrypts, so a sealed value needs no + * signature around it: a tampered one fails to decrypt rather than decrypting to something else. + * + * The label separates uses exactly as it does for a signature, but here it does so through the key — + * a value sealed for one purpose is not merely rejected by another, it cannot be opened by it at all. + * + * base64url over the envelope, because this is for values that travel as a query parameter and the + * envelope itself is JSON with base64 inside it. Sealing says nothing about freshness: a caller that + * needs an expiry puts one INSIDE the value and checks it after opening. + */ +export async function seal( + value: string, + encryptionKey: string, + label: string, +): Promise<string> { + const envelope = await encryptSecret(sealingKey(encryptionKey, label), value); + return Buffer.from(envelope, "utf8").toString("base64url"); +} + +/** + * The value a sealed string carries, or nothing. + * + * One answer for every way of being unopenable — not base64url, not an envelope, sealed under + * another label, sealed by somebody else, altered by a byte — because there is exactly one thing to + * do with a value this deployment cannot read, and a caller that has to tell those apart is a caller + * that can get one of them wrong. + */ +export async function unseal( + sealed: string | undefined, + encryptionKey: string, + label: string, +): Promise<string | null> { + if (!sealed) return null; + try { + return await decryptSecret( + sealingKey(encryptionKey, label), + Buffer.from(sealed, "base64url").toString("utf8"), + ); + } catch { + return null; + } +} diff --git a/server/src/channels/events.ts b/server/src/channels/events.ts index b0682a41..b0bced6f 100644 --- a/server/src/channels/events.ts +++ b/server/src/channels/events.ts @@ -22,8 +22,15 @@ export type ChannelActivityEvent = { lastMessage: string | null; lastMessageAt: string | null; lastMessageAgentId: string | null; - /** The channel is gone. Absent on an ordinary activity event. */ + /** The channel is hidden from every member's roster. Absent on an ordinary activity event. */ deleted?: true; + /** + * One member's pin, changed. Absent on an ordinary activity event. + * + * A pin lives on one membership row, so the writer names that member alone in `memberIds` and the + * hub's delivery rule does the rest: nobody else in the channel hears a pin they did not make. + */ + pinned?: boolean; }; type Send = (payload: string) => void; diff --git a/server/src/channels/routes.ts b/server/src/channels/routes.ts index a912aa68..0d10a13a 100644 --- a/server/src/channels/routes.ts +++ b/server/src/channels/routes.ts @@ -1,4 +1,15 @@ -import { and, asc, desc, eq, inArray, isNull, lt, or, sql } from "drizzle-orm"; +import { + and, + asc, + desc, + eq, + exists, + inArray, + isNull, + lt, + or, + sql, +} from "drizzle-orm"; import type { Context, MiddlewareHandler } from "hono"; import { Hono } from "hono"; import { @@ -38,6 +49,10 @@ export type ChannelSummary = AgentChannel & { lastMessageAt: Date | null; lastMessageAgentId: string | null; createdAt: Date; + /** Whether the caller pinned this channel. A pin is per-member, so this is the caller's, only. */ + pinned: boolean; + /** When the caller last had this channel open, or null for never. The caller's, only. */ + lastReadAt: Date | null; }; /** What a client that ran an agent reports back about the message it just saw. */ @@ -70,14 +85,26 @@ const DEFAULT_CHANNEL_PAGE = 50; /** The most a caller may ask for, so the endpoint cannot be talked back into reading everything. */ const MAX_CHANNEL_PAGE = 200; -/** Where a page stopped: both halves of the sort, since two channels can share a timestamp. */ -type ChannelCursor = { recency: string; id: string }; +/** + * Where a page stopped: every part of the sort, in sort order. + * + * `pinned` leads, because the ordering does: a keyset cursor has to name the whole sort key or the + * next page is selected by a different rule than the page it follows, which serves some channels + * twice and others never. `recency` and `id` are both here for the same reason — two channels can + * share a timestamp. + */ +type ChannelCursor = { pinned: boolean; recency: string; id: string }; function encodeChannelCursor(cursor: ChannelCursor): string { return Buffer.from(JSON.stringify(cursor), "utf8").toString("base64url"); } -/** A malformed cursor reads as the first page, which is the honest answer to a stale link. */ +/** + * A malformed cursor reads as the first page, which is the honest answer to a stale link. + * + * A cursor minted before `pinned` existed is malformed by this definition, and deliberately: it + * describes a position in an ordering this query no longer has. + */ function decodeChannelCursor( value: string | undefined, ): ChannelCursor | undefined { @@ -86,7 +113,9 @@ function decodeChannelCursor( const parsed = JSON.parse( Buffer.from(value, "base64url").toString("utf8"), ) as ChannelCursor; - return typeof parsed?.id === "string" && typeof parsed?.recency === "string" + return typeof parsed?.id === "string" && + typeof parsed?.recency === "string" && + typeof parsed?.pinned === "boolean" ? parsed : undefined; } catch { @@ -94,17 +123,50 @@ function decodeChannelCursor( } } +/** + * The roster's sort key, as SQL, in the order it sorts. + * + * Every part descends, which is what lets the cursor be one row comparison rather than a nest of + * ORs: a pin is 1 and no pin is 0, so `desc` puts pinned channels first, and both remaining parts + * already wanted `desc`. Starting a conversation counts as activity — a channel somebody just made + * has nothing said in it yet and is the one they are about to type in, so ordering on the message + * alone would bury it under every channel that has one. + * + * The browser repeats the recency half when the socket patches a row, and lifts pinned rows at + * render; both must agree with this, or the list reorders itself on the next event. See `byRecency` + * in use-channel-events.ts and `pinnedFirst` in app-sidebar.tsx. + */ +const PINNED_RANK = sql`case when ${channelMemberships.pinnedAt} is not null then 1 else 0 end`; +const RECENCY = sql`coalesce(${channels.lastMessageAt}, ${channels.createdAt})`; +const ROSTER_ORDER = [ + sql`${PINNED_RANK} desc`, + sql`${RECENCY} desc`, + desc(channels.id), +]; + export type ChannelStore = { create(actor: AgentActor, agentIds: string[]): Promise<AgentChannel>; get(actor: AgentActor, channelId: string): Promise<AgentChannel | null>; list(actor: AgentActor, query?: ChannelQuery): Promise<ChannelPage>; + /** Pin or unpin the caller's own membership. Throws ChannelNotFoundError for a non-member. */ + setPinned( + actor: AgentActor, + channelId: string, + pinned: boolean, + ): Promise<void>; + /** Stamp the caller's own membership as read now. Throws ChannelNotFoundError for a non-member. */ + markRead(actor: AgentActor, channelId: string): Promise<void>; + /** + * Hide the channel for every member. Soft: the row and the thread survive, every read filters. + * Throws ChannelNotFoundError for a non-member and ChannelPackageOwnedError for a channel the + * tenant package defines, which configuration owns rather than any member. + */ + softDelete(actor: AgentActor, channelId: string): Promise<void>; recordActivity( actor: AgentActor, channelId: string, activity: ChannelActivity, ): Promise<void>; - /** Deletes the channel for everyone in it. Returns the thread it owned, so the caller can forget it upstream. */ - remove(actor: AgentActor, channelId: string): Promise<string | null>; }; const PRIVATE_AGENT_CHANNEL_DESCRIPTION = "Private agent channel."; @@ -226,7 +288,7 @@ export function createChannelStore( agentProfiles, eq(agentProfiles.agentId, channelAgents.agentId), ) - .where(eq(channels.id, channelId)) + .where(and(eq(channels.id, channelId), isNull(channels.deletedAt))) .orderBy(asc(channelAgents.agentId)); const first = rows[0]; @@ -258,7 +320,8 @@ export function createChannelStore( const page = await database .select({ id: channels.id, - recency: sql<Date>`coalesce(${channels.lastMessageAt}, ${channels.createdAt})`, + recency: sql<Date>`${RECENCY}`, + pinned: sql<boolean>`${channelMemberships.pinnedAt} is not null`, }) .from(channels) .innerJoin( @@ -269,14 +332,16 @@ export function createChannelStore( ), ) .where( - cursor - ? sql`(coalesce(${channels.lastMessageAt}, ${channels.createdAt}), ${channels.id}) < (${cursor.recency}::timestamptz, ${cursor.id})` - : undefined, - ) - .orderBy( - sql`coalesce(${channels.lastMessageAt}, ${channels.createdAt}) desc`, - desc(channels.id), + and( + isNull(channels.deletedAt), + // One row comparison over the whole sort key, which only reads as "everything after the + // cursor" because every part of that key descends. See ROSTER_ORDER. + cursor + ? sql`(${PINNED_RANK}, ${RECENCY}, ${channels.id}) < (${cursor.pinned ? 1 : 0}::int, ${cursor.recency}::timestamptz, ${cursor.id})` + : undefined, + ), ) + .orderBy(...ROSTER_ORDER) // One more than asked for, so "is there another page" needs no second count query. .limit(limit + 1); @@ -285,6 +350,7 @@ export function createChannelStore( const nextCursor = page.length > limit && last ? encodeChannelCursor({ + pinned: last.pinned, recency: new Date(last.recency).toISOString(), id: last.id, }) @@ -303,6 +369,8 @@ export function createChannelStore( lastMessageAt: channels.lastMessageAt, lastMessageAgentId: channels.lastMessageAgentId, createdAt: channels.createdAt, + pinnedAt: channelMemberships.pinnedAt, + lastReadAt: channelMemberships.lastReadAt, }) .from(channels) .innerJoin( @@ -324,22 +392,20 @@ export function createChannelStore( agentProfiles, eq(agentProfiles.agentId, channelAgents.agentId), ) - // Most recent first, where starting a conversation counts as activity. A channel somebody - // just created has nothing said in it yet, and is also the one they are about to type in, // ordering on the message alone would bury it under every channel that has one. - // - // The browser repeats this when the socket patches a row. Both must agree, or the list - // reorders itself on the next event; see `byRecency` in use-channel-events.ts. .where( - inArray( - channels.id, - wanted.map((row) => row.id), + and( + inArray( + channels.id, + wanted.map((row) => row.id), + ), + // Repeated, not inherited from the query that chose the page: these are two statements + // on two snapshots, so a delete that commits between them would otherwise hand back a + // channel this person can no longer see. + isNull(channels.deletedAt), ), ) - .orderBy( - sql`coalesce(${channels.lastMessageAt}, ${channels.createdAt}) desc`, - desc(channels.id), - asc(channelAgents.agentId), - ); + // The same order the page was chosen in, since the rows below are read in order. + .orderBy(...ROSTER_ORDER, asc(channelAgents.agentId)); // One row per channel-agent pair; the ordering above keeps each channel's rows together and // its agents in the same lexicographic order `get` returns. @@ -361,25 +427,183 @@ export function createChannelStore( lastMessageAt: row.lastMessageAt, lastMessageAgentId: row.lastMessageAgentId, createdAt: row.createdAt, + pinned: row.pinnedAt !== null, + lastReadAt: row.lastReadAt, }); } return { channels: [...summaries.values()], nextCursor }; }, + async setPinned(actor, channelId, pinned) { + await database.transaction( + async (transaction) => { + const updated = await transaction + .update(channelMemberships) + .set({ pinnedAt: pinned ? new Date() : null }) + .where( + and( + eq(channelMemberships.channelId, channelId), + eq(channelMemberships.userId, actor.id), + // A deleted channel is not there to pin. Without this, pinning one succeeds and + // announces, and the announcement sends this person's tabs to refetch a roster that + // cannot show the row. `get` and `list` filter the same way. + exists( + transaction + .select({ one: sql`1` }) + .from(channels) + .where( + and( + eq(channels.id, channelId), + isNull(channels.deletedAt), + ), + ), + ), + ), + ) + .returning({ channelId: channelMemberships.channelId }); + // Not a member, no such channel, or a deleted one: the same answer every way, matching + // recordActivity and `get`. + if (updated.length === 0) throw new ChannelNotFoundError(channelId); + + /* + * Announced to this member alone. + * + * A pin is a fact about one membership row, so `memberIds` holds the person who made it + * and nobody else. The hub delivers by that list, which is what carries the pin across + * this person's own tabs and replicas without putting it on anybody else's roster. + */ + const event: ChannelActivityEvent = { + channelId, + memberIds: [actor.id], + lastMessage: null, + lastMessageAt: null, + lastMessageAgentId: null, + pinned, + }; + await transaction.execute( + sql`select pg_notify(${CHANNEL_ACTIVITY_TOPIC}, ${JSON.stringify(event)})`, + ); + }, + { isolationLevel: "read committed" }, + ); + }, + + async markRead(actor, channelId) { + const updated = await database + .update(channelMemberships) + .set({ + /* + * The later of this clock and the channel's own last-message stamp. last_message_at is + * written from the reporting browser's clock and is not bounded; a marker stamped + * plainly "now" by a server running behind it would leave the row reading as unseen for + * every member, re-lighting the dot on each refetch until wall clock catches up. + */ + lastReadAt: sql`greatest(now(), coalesce((select ${channels.lastMessageAt} from ${channels} where ${channels.id} = ${channelMemberships.channelId}), now()))`, + }) + .where( + and( + eq(channelMemberships.channelId, channelId), + eq(channelMemberships.userId, actor.id), + // A deleted channel is not there to read. The same guard `setPinned` carries, for the + // same reason: the row is gone from every roster, so nothing about it is markable. + exists( + database + .select({ one: sql`1` }) + .from(channels) + .where( + and(eq(channels.id, channelId), isNull(channels.deletedAt)), + ), + ), + ), + ) + .returning({ channelId: channelMemberships.channelId }); + // Not a member, or no such channel: the same answer either way, matching setPinned. + if (updated.length === 0) throw new ChannelNotFoundError(channelId); + }, + + async softDelete(actor, channelId) { + await database.transaction( + async (transaction) => { + const [row] = await transaction + .select({ packageId: channels.packageId }) + .from(channels) + .innerJoin( + channelMemberships, + and( + eq(channelMemberships.channelId, channels.id), + eq(channelMemberships.userId, actor.id), + ), + ) + .where(eq(channels.id, channelId)); + // Not a member, or no such channel: the same answer either way. + if (!row) throw new ChannelNotFoundError(channelId); + // Package channels are configuration; the sync that wrote them owns them. + if (row.packageId !== null) { + throw new ChannelPackageOwnedError(channelId); + } + // The guard on deletedAt is what makes a repeat call a no-op rather than a new stamp. + await transaction + .update(channels) + .set({ deletedAt: new Date(), updatedAt: new Date() }) + .where(and(eq(channels.id, channelId), isNull(channels.deletedAt))); + + // Read on this transaction, so the members told are the ones the channel had when it was + // hidden. Soft leaves the membership rows in place, so this reads the same list a repeat + // call would. + const members = await transaction + .select({ userId: channelMemberships.userId }) + .from(channelMemberships) + .where(eq(channelMemberships.channelId, channelId)); + + /* + * Announced inside the transaction, so it is delivered on commit and a refused delete — + * a channel the package owns, or one the caller is not in — announces nothing at all. + * + * Every member is told, because the deletion hides the channel for all of them: without + * this, a second tab and a second replica keep rendering a row whose channel no longer + * resolves until something else makes them refetch. + */ + const event: ChannelActivityEvent = { + channelId, + memberIds: members.map((member) => member.userId), + lastMessage: null, + lastMessageAt: null, + lastMessageAgentId: null, + deleted: true, + }; + await transaction.execute( + sql`select pg_notify(${CHANNEL_ACTIVITY_TOPIC}, ${JSON.stringify(event)})`, + ); + }, + { isolationLevel: "read committed" }, + ); + }, + recordActivity(actor, channelId, activity) { return database.transaction( async (transaction) => { const [membership] = await transaction .select({ channelId: channelMemberships.channelId }) .from(channelMemberships) + // Joined rather than checked on the membership alone, so a deleted channel is refused + // too. `get` and `list` filter on `deleted_at`, so without this a client holding a stale + // roster row can bump `last_message` on a channel nobody can see and announce it to + // every member, each of whom refetches their roster for an invisible row. + .innerJoin( + channels, + and( + eq(channels.id, channelMemberships.channelId), + isNull(channels.deletedAt), + ), + ) .where( and( eq(channelMemberships.channelId, channelId), eq(channelMemberships.userId, actor.id), ), ); - // Not a member, or no such channel: the same answer either way, so belonging to a channel - // is not something an outsider can probe for. + // Not a member, no such channel, or a deleted one: the same answer every way, so belonging + // to a channel is not something an outsider can probe for. if (!membership) throw new ChannelNotFoundError(channelId); if (activity.agentId !== null) { @@ -441,64 +665,6 @@ export function createChannelStore( { isolationLevel: "read committed" }, ); }, - - // `create` inserts exactly one membership row, so "delete" and "leave" are the same act while a - // channel has exactly one member. Named `remove` for the multi-member split this becomes later. - remove(actor, channelId) { - return database.transaction( - async (transaction) => { - const [membership] = await transaction - .select({ channelId: channelMemberships.channelId }) - .from(channelMemberships) - .where( - and( - eq(channelMemberships.channelId, channelId), - eq(channelMemberships.userId, actor.id), - ), - ); - // Not a member, or no such channel: the same answer either way, so belonging to a channel - // is not something an outsider can probe for. Same reasoning as `recordActivity` above. - if (!membership) throw new ChannelNotFoundError(channelId); - - // Read before the delete, not after: the cascade below wipes both of these tables, and the - // notify payload needs the members it is telling, while the caller needs the thread id to - // ask Intelligence to forget it. - const members = await transaction - .select({ userId: channelMemberships.userId }) - .from(channelMemberships) - .where(eq(channelMemberships.channelId, channelId)); - const [mapping] = await transaction - .select({ threadId: intelligenceChannelMappings.threadId }) - .from(intelligenceChannelMappings) - .where( - and( - eq(intelligenceChannelMappings.channelId, channelId), - eq(intelligenceChannelMappings.userId, actor.id), - ), - ); - - // Cascades `channel_memberships`, `channel_agents`, and `intelligence_channel_mappings`: - // see the `onDelete: "cascade"` on each in db/schema/core.ts. Nothing else references a - // channel, so this one delete is the whole local removal. - await transaction.delete(channels).where(eq(channels.id, channelId)); - - const event: ChannelActivityEvent = { - channelId, - memberIds: members.map((member) => member.userId), - lastMessage: null, - lastMessageAt: null, - lastMessageAgentId: null, - deleted: true, - }; - await transaction.execute( - sql`select pg_notify(${CHANNEL_ACTIVITY_TOPIC}, ${JSON.stringify(event)})`, - ); - - return mapping?.threadId ?? null; - }, - { isolationLevel: "read committed" }, - ); - }, }; } @@ -509,6 +675,13 @@ export class ChannelNotFoundError extends Error { } } +export class ChannelPackageOwnedError extends Error { + constructor(id: string) { + super(`Channel ${id} is defined by the deployment package.`); + this.name = "ChannelPackageOwnedError"; + } +} + type ChannelInputParseResult = | { ok: true; value: { agentIds: string[] } } | { ok: false; error: string }; @@ -589,31 +762,24 @@ export function createChannelRoutes( requireUser: MiddlewareHandler<{ Variables: AppVariables }>, /** Absent in tests and wherever live updates are not wanted; the routes still work without it. */ events?: ChannelEventHub, - /** Where a channel's deletion is written. Absent in tests that do not care about the trail. */ + /** Where a channel's removal is written. Absent in tests that do not care about the trail. */ auditStore?: AuditStore, - /** - * Ask Intelligence to permanently delete a thread. Absent leaves a channel deletable and its - * thread left behind on the platform: the local removal below does not depend on this existing. - */ - forgetThread?: (params: { - threadId: string; - userId: string; - agentId: string; - }) => Promise<void>, ) { const routes = new Hono<{ Variables: AppVariables }>(); /** * Write the one audit row this file ever writes, tolerantly. * - * Mirrors `record` in agents/routes.ts: never fatal, because the channel is already gone and the + * Mirrors `record` in agents/routes.ts: never fatal, because the channel is already hidden and the * caller has already been told so by the time this runs. A trail that is briefly unavailable is * not a reason to report a failure that did not happen. + * + * Reached only after `softDelete` resolves, so a refused delete — a channel the package owns, or + * one the caller is not in — writes nothing. The trail records acts, not attempts. */ const recordDeleted = async ( context: Context<{ Variables: AppVariables }>, channelId: string, - payload: { threadId: string | null; threadForgotten: boolean }, ): Promise<void> => { if (!auditStore) return; const actor = context.var.actor; @@ -633,7 +799,9 @@ export function createChannelRoutes( * by default, and "somebody deleted this conversation" is the whole point of the row. */ actorUserId: actor.id, - payload, + // Named rather than implied: the channel row and its thread are still there, and a later + // hard delete would be a different fact about the same channel. + payload: { mechanism: "soft" }, }); } catch (error) { console.error( @@ -723,72 +891,58 @@ export function createChannelRoutes( } }); - routes.get("/:channelId", requireUser, async (context) => { + routes.put("/:channelId/pin", requireUser, async (context) => { + const body = await context.req.json().catch(() => null); + if (!isChannelInputObject(body)) { + return context.json({ error: "Pin input must be a JSON object." }, 400); + } + const { pinned } = body as { pinned?: unknown }; + if (typeof pinned !== "boolean") { + return context.json({ error: "Pinned must be true or false." }, 400); + } + try { - const channel = await store.get( + await store.setPinned( context.var.actor, context.req.param("channelId"), + pinned, ); - if (!channel) { - return context.json({ error: "Channel not found." }, 404); - } - return context.json({ channel: channelDto(channel) }); + return context.json({ pinned }); + } catch (error) { + return mapStoreError(context, error); + } + }); + + routes.put("/:channelId/read", requireUser, async (context) => { + try { + await store.markRead(context.var.actor, context.req.param("channelId")); + return context.body(null, 204); } catch (error) { return mapStoreError(context, error); } }); - // Registered unconditionally, unlike `GET /:threadId` in thread-routes.ts: removing your own - // channel from your own roster can always succeed locally, whether or not Intelligence is reachable. routes.delete("/:channelId", requireUser, async (context) => { const channelId = context.req.param("channelId"); try { - const threadId = await store.remove(context.var.actor, channelId); - - // The local delete already committed above, so a failed thread deletion is non-fatal: a - // channel gone locally with an orphaned thread beats one still on screen with its history wiped. - let threadForgotten = false; - if (threadId && forgetThread) { - try { - await forgetThread({ - threadId, - userId: context.var.actor.id, - // Derived here, never accepted from the caller: this is the same string - // channel-chat.tsx builds for the same channel, and trusting a client-supplied agentId - // would let a request name any thread it likes and ask the platform to delete it. - agentId: `channel:${channelId}`, - }); - threadForgotten = true; - } catch { - console.error( - JSON.stringify({ - type: "channel-thread-forget-failed", - note: "Could not delete the Intelligence thread for a removed channel.", - channelId, - threadId, - }), - ); - } - } - - await recordDeleted(context, channelId, { threadId, threadForgotten }); + await store.softDelete(context.var.actor, channelId); + await recordDeleted(context, channelId); + return context.body(null, 204); + } catch (error) { + return mapStoreError(context, error); + } + }); - /* - * 200 with the outcome, not a bare 204. - * - * The thread deletion is the half that can fail on its own, and 204 says the whole act - * succeeded whichever way it went. The screen then tells somebody their message history is - * gone while it is still sitting on the platform, which is the one thing a person deleting a - * conversation is asking about. - * - * Reported as the question the caller has rather than the two facts it is derived from: no - * thread and a forgotten thread both mean nothing was left behind, and only a thread that - * survived is worth putting on a screen. - */ - return context.json( - { historyLeftBehind: threadId !== null && !threadForgotten }, - 200, + routes.get("/:channelId", requireUser, async (context) => { + try { + const channel = await store.get( + context.var.actor, + context.req.param("channelId"), ); + if (!channel) { + return context.json({ error: "Channel not found." }, 404); + } + return context.json({ channel: channelDto(channel) }); } catch (error) { return mapStoreError(context, error); } @@ -815,6 +969,9 @@ function channelSummaryDto(channel: ChannelSummary) { lastMessageAt: channel.lastMessageAt?.toISOString() ?? null, lastMessageAgentId: channel.lastMessageAgentId, createdAt: channel.createdAt.toISOString(), + pinned: channel.pinned, + // Serialised as ISO-8601 like lastMessageAt, so the browser can compare the two as strings. + lastReadAt: channel.lastReadAt?.toISOString() ?? null, }; } @@ -825,5 +982,14 @@ function mapStoreError(context: Context, error: unknown): Response { if (error instanceof ChannelNotFoundError) { return context.json({ error: "Channel not found." }, 404); } + if (error instanceof ChannelPackageOwnedError) { + return context.json( + { + error: + "This channel is defined by the deployment package, so it cannot be deleted here.", + }, + 409, + ); + } throw error; } diff --git a/server/src/computer/gateway.ts b/server/src/computer/gateway.ts index bf6a8920..b2fa548d 100644 --- a/server/src/computer/gateway.ts +++ b/server/src/computer/gateway.ts @@ -35,6 +35,7 @@ export { WorkspaceRequestError, } from "./client"; +import type { PageFrameStore } from "./page-frames"; import { type ActionPolicy, evaluateActionPolicy, @@ -112,6 +113,13 @@ export type ComputerGatewayOptions = { * is correct in one process and is what a unit test wants. See snapshot-store.ts. */ snapshots?: SnapshotStore; + /** + * Where the frame a page was opened on is kept, so a reset can take them with the profile. + * + * Absent, a reset clears the profile and leaves the pictures, which is the wrong half of a promise + * this deployment makes in as many words. + */ + pageFrames?: PageFrameStore; }; export interface ComputerGateway { @@ -231,6 +239,7 @@ export function createComputerGateway( * ref from a superseded page from resolving to whatever now holds it. See snapshot-store.ts. */ const snapshots = options.snapshots ?? createInMemorySnapshotStore(); + const pageFrames = options.pageFrames; /** * Where this Bot's computer is, checked before anything is sent to it. @@ -667,6 +676,15 @@ export function createComputerGateway( // The refs the last snapshot handed out describe a page that no longer exists, and a fresh // computer counts generations from one again, so the row has to go with the profile. await snapshots.clear(botId); + /* + * And the pictures, which are the part that made the promise above untrue. + * + * "Every login the Bot had is gone" was said while screenshots of the signed-in pages stayed + * in the database: an inbox, an admin console, a bank statement, still readable from the + * transcript by anybody who could reach that Bot. A reset that leaves those has not reset + * anything a person would recognise as private. + */ + await pageFrames?.clear(botId); await writeControlEvent(auditStore, "computer.reset", { botId, actor, @@ -1037,19 +1055,26 @@ async function write( * is the file body of this pair, and stays out. */ ...(entry.command ? { command: entry.command } : {}), + /* + * The element, where the action named one. + * + * KEYED ON THE REF, not on the kind of action. An unresolved element is worth recording + * plainly rather than as an absent field that reads like a logging gap, but that only applies + * when the Bot pointed at something and the server could not say what: a ref it holds and the + * snapshot no longer does. Deciding it by elimination instead put "not in the current + * snapshot" on every navigation, every file read and every command, which is the reverse of + * the intent. Those actions did not fail to identify an element; they never had one, and a + * trail that says otherwise sends a reader looking for a snapshot that was never taken. + */ element: entry.element ? { role: entry.element.role, name: entry.element.name, ...(entry.element.type ? { type: entry.element.type } : {}), } - : entry.filePath || entry.command - ? // A file or command action has no element and never will. Those rows leave the element - // field absent rather than describing a browser snapshot. - undefined - : // An action on an element the server cannot identify is worth recording plainly, rather - // than as an absent field that reads like a logging gap. - "not in the current snapshot", + : entry.ref + ? "not in the current snapshot" + : undefined, ...(entry.failure ? { failure: entry.failure } : {}), decision: { allowed: entry.decision.allowed, diff --git a/server/src/computer/page-frames.ts b/server/src/computer/page-frames.ts new file mode 100644 index 00000000..727dbd0d --- /dev/null +++ b/server/src/computer/page-frames.ts @@ -0,0 +1,139 @@ +/** + * What a Bot's screen looked like when it opened a page. + * + * Written where the navigation happens, which is the one moment the screen is certainly showing the + * page that was asked for, and read back when somebody reopens the conversation that asked for it. + */ +import { and, eq, lt, sql } from "drizzle-orm"; +import type { Database } from "../db/client"; +import { computerPageFrame } from "../db/schema"; + +/** + * A screenshot, and the ceiling on one. + * + * Generous enough for a full page at the sizes a computer runs, small enough that nothing can push + * megabytes into the store. Refused rather than truncated, because half a PNG is not a smaller + * picture, it is a broken one. + */ +const MAX_FRAME_BYTES = 4 * 1024 * 1024; + +/** + * How big a base64 string actually is, in bytes. + * + * `String.length` counts characters, which is the same number only while every character is ASCII. + * Base64 is ASCII, so the two agree today; measuring the thing the limit is named for means they + * cannot quietly stop agreeing. + */ +function byteLength(value: string): number { + return Buffer.byteLength(value, "utf8"); +} + +function tooLarge(value: string): boolean { + return byteLength(value) > MAX_FRAME_BYTES; +} + +export type PageFrameStore = { + save: (frame: { + computerId: string; + toolCallId: string; + url: string; + title?: string; + frame: string; + }) => Promise<void>; + load: ( + computerId: string, + toolCallId: string, + ) => Promise<{ url: string; title: string | null; frame: string } | null>; + /** + * Everything kept for one computer. Returns how many went. + * + * Called when a profile is wiped, because "every login the Bot had is gone" is not true while + * pictures of the signed-in pages are still readable from the transcript. + */ + clear: (computerId: string) => Promise<number>; + /** + * Frames older than the retention window, across every computer. Returns how many went. + * + * A page is a distinct row, so a Bot that browses grows this table for as long as it runs and + * nothing ever took anything out of it. Screenshots are the largest thing this deployment stores + * and the least useful once nobody is reading that conversation any more. + */ + purge: (olderThanMs: number) => Promise<number>; +}; + +export function createPageFrameStore(database: Database): PageFrameStore { + return { + async save(input) { + if (!input.toolCallId || !input.url) return; + if (tooLarge(input.frame)) { + /* + * Said out loud rather than dropped in silence. A turn with no picture falls back to naming + * its page, which looks exactly like a turn nobody photographed, so without this line a + * deployment whose pages are all too big has no way to find that out. + */ + console.warn( + `[computer] a frame of ${input.url} was ${byteLength(input.frame)} bytes and was not kept; the limit is ${MAX_FRAME_BYTES}.`, + ); + return; + } + await database + .insert(computerPageFrame) + .values({ + computerId: input.computerId, + toolCallId: input.toolCallId, + url: input.url, + ...(input.title ? { title: input.title } : {}), + frame: input.frame, + }) + /* + * Written once. A turn happens once and is then over for good, so a second write for the + * same turn is either a retry of the same thing or a mistake, and neither should change what + * a past turn shows. Letting the newer win is what made the record mutable before. + */ + .onConflictDoNothing(); + }, + + async load(computerId, toolCallId) { + const [row] = await database + .select({ + url: computerPageFrame.url, + title: computerPageFrame.title, + frame: computerPageFrame.frame, + }) + .from(computerPageFrame) + /* + * Both, always. A caller who may reach one Bot must not be able to read another Bot's screen + * by naming a turn: the Bot in the path is what the route already checked, so it is what this + * is keyed on too. + */ + .where( + and( + eq(computerPageFrame.computerId, computerId), + eq(computerPageFrame.toolCallId, toolCallId), + ), + ); + return row ?? null; + }, + + async clear(computerId) { + const gone = await database + .delete(computerPageFrame) + .where(eq(computerPageFrame.computerId, computerId)) + .returning({ url: computerPageFrame.url }); + return gone.length; + }, + + async purge(olderThanMs) { + const gone = await database + .delete(computerPageFrame) + .where( + lt( + computerPageFrame.capturedAt, + sql`now() - make_interval(secs => ${olderThanMs / 1000})`, + ), + ) + .returning({ url: computerPageFrame.url }); + return gone.length; + }, + }; +} diff --git a/server/src/computer/provider.ts b/server/src/computer/provider.ts index 7993227c..6dd30336 100644 --- a/server/src/computer/provider.ts +++ b/server/src/computer/provider.ts @@ -1,11 +1,15 @@ import type { ComputerConfig } from "../config"; +import { + createSandboxComputerProvider, + inClusterConfig, + readSandboxTemplate, +} from "./sandbox"; +import type { ComputerStatus } from "./schema"; import { createDockerSupervisorProvider, type SupervisorOptions, } from "./supervisor"; -import type { ComputerStatus } from "./schema"; - /** The address and lifecycle details for one Bot's computer. */ export type ComputerLocation = { botId: string; @@ -232,5 +236,67 @@ export function createComputerProvider( baseUrl: config.baseUrl, ...(config.token ? { token: config.token } : {}), }); + case "sandbox": + /* + * Built lazily, because reading the service account is asynchronous and this factory is not. + * Every method needs the same credentials, so the promise is created once and awaited by each + * rather than the file being read on every call. + */ + return createLazySandboxProvider(config); } } + +/** + * The sandbox provider, built on first use. + * + * Its credentials come off disk, which is asynchronous, and `createComputerProvider` is not. Rather + * than make every caller await a factory, the work happens once behind a promise and each method + * waits on the same one. A failure to read them surfaces on the first computer request, naming what + * is missing, instead of taking the whole deployment down at boot over a feature it may not use. + */ +function createLazySandboxProvider( + config: Extract<ComputerConfig, { provider: "sandbox" }>, +): ComputerProvider { + let built: Promise<ComputerProvider> | undefined; + + const provider = async (): Promise<ComputerProvider> => { + /* + * A FAILURE IS NOT REMEMBERED, only a success. + * + * `??=` holds whatever the first call produced, and a rejected promise is something. One + * unreadable token file or one blip reading the template at the wrong moment, and every computer + * request for the rest of the pod's life failed with that same stale error: no probe notices, + * because the pod is serving happily, and nothing recovers short of a restart. Clearing the memo + * on rejection makes the next request try again, which is what a transient failure deserves. + */ + built ??= (async () => { + const [cluster, template] = await Promise.all([ + inClusterConfig(), + readSandboxTemplate(config.templateFile), + ]); + return createSandboxComputerProvider({ + namespace: config.namespace, + idleAfterMs: config.idleAfterMs, + template, + apiServer: cluster.apiServer, + token: cluster.token, + ca: cluster.ca, + }); + })().catch((error: unknown) => { + built = undefined; + throw error; + }); + return built; + }; + + return { + name: "sandbox", + isolation: "per-bot", + locate: async (botId) => (await provider()).locate(botId), + status: async (botId) => (await provider()).status(botId), + stop: async (botId) => (await provider()).stop(botId), + reset: async (botId) => (await provider()).reset(botId), + list: async () => (await provider()).list(), + sessionOf: async (botId) => (await provider()).sessionOf?.(botId), + }; +} diff --git a/server/src/computer/routes.ts b/server/src/computer/routes.ts index e8a88be6..e2e1dd74 100644 --- a/server/src/computer/routes.ts +++ b/server/src/computer/routes.ts @@ -3,19 +3,20 @@ import { Hono } from "hono"; import type { BotAccessCheck } from "../agents/profile-policy"; import type { AppVariables } from "../auth/guards"; import { requireAdmin } from "../auth/guards"; +import { DEPLOYMENT_ROUTES } from "./deployment-routes"; import { type ActionActor, ActionRefusedError, type ComputerGateway, ComputerUnavailableError, ElementNotFoundError, - NavigationRefusedError, HumanHasControlError, + NavigationRefusedError, StaleSnapshotError, WorkspaceRefusedError, WorkspaceRequestError, } from "./gateway"; -import { DEPLOYMENT_ROUTES } from "./deployment-routes"; +import type { PageFrameStore } from "./page-frames"; import { type PolicyStore, parseActionPolicy } from "./policy-store"; /** @@ -38,6 +39,8 @@ export function createComputerRoutes( * deployment cannot be wired up without an answer to it. */ canUseBot: BotAccessCheck, + /** Where the frame a page was opened on is kept. Absent leaves the transcript as it was. */ + pageFrames?: PageFrameStore, ) { const routes = new Hono<{ Variables: AppVariables }>(); @@ -99,27 +102,152 @@ export function createComputerRoutes( } }); + /** + * Whether the same page is on both, ignoring the two ways one page spells itself. + * + * The trailing slash a browser adds and the fragment it keeps are not different pages. A URL that + * cannot be parsed is compared as written. + */ + function samePage(a: string, b: string): boolean { + const tidy = (value: string) => { + try { + const parsed = new URL(value); + parsed.hash = ""; + return parsed.toString().replace(/\/$/, ""); + } catch { + return value.replace(/\/$/, ""); + } + }; + return tidy(a) === tidy(b); + } + + /** + * Whether a screenshot can be trusted to be of the page this turn opened. + * + * A SCREENSHOT THAT DOES NOT SAY WHAT IT IS OF IS THE ORDINARY CASE ON AN OLD COMPUTER. The url on + * a screenshot was added after the first computers shipped, so an `agent-computer` that has not + * been redeployed sends none. Refusing on a missing url therefore did not fail safe, it failed + * silently and completely: on a fleet part-way through a rollout the feature kept no frames at all + * and said nothing about why. + * + * So the question is asked where it means something. With a computer each there is no second Bot + * to race with, nothing can have moved the page between the navigation and the picture, and an + * unknown page is this turn's page. On one shared computer another Bot's navigation lands in + * exactly that gap, which is the case this guard exists for, and there an unknown page is refused. + */ + function frameIsOfThisPage( + shotUrl: string | undefined, + pageUrl: string, + ): { ok: true } | { ok: false; why: string } { + if (shotUrl === undefined) { + if (gateway.provider.isolation === "per-bot") return { ok: true }; + return { + ok: false, + why: "this computer is shared and the screenshot did not say which page it is of, so it cannot be told apart from another Bot's", + }; + } + if (!samePage(shotUrl, pageUrl)) { + return { ok: false, why: `the screen showed ${shotUrl}` }; + } + return { ok: true }; + } + + /** + * Photograph the page this turn just opened. + * + * Awaited rather than left running, so a surface asking for the frame the moment the turn ends + * finds it there. A navigation already costs seconds; one screenshot inside the cluster does not + * change how the tool feels, and a frame that arrives after the reader has gone is no frame at all. + * + * CHECKED AGAINST THE PAGE THE NAVIGATION REPORTED, because the screenshot is a second round trip + * and nothing holds the browser still between them. With one computer shared by every Bot, another + * Bot's navigation lands in that gap and this would file its page under this turn. The guard used + * to live in the browser and was deleted when the capture moved here; it belongs on whichever side + * does the capturing. + * + * Never fatal. A stored picture is a convenience for reading a conversation back, and failing the + * navigation the Bot was asked to do because the convenience failed would be the wrong trade every + * time. EVERY REFUSAL SAYS SO, including the two that used to return quietly: a deployment that + * keeps no frames has to be able to find out why from its own logs rather than by reading this file. + */ + async function keepFrameOf( + botId: string, + toolCallId: string, + url: string, + title: string, + ) { + if (!pageFrames) return; + if (!toolCallId) { + console.warn( + `[computer] not keeping a frame of ${url}: the caller did not say which turn it was for.`, + ); + return; + } + try { + /* + * Only if the computer is already up. `screenshot` goes through `locate`, which resumes a + * suspended computer, so a convenience picture could wake a machine the culler had just put to + * sleep and hold a navigation open for the length of a pod schedule while it did. + */ + const status = await gateway.status(botId); + if (status.state !== "ready") { + console.warn( + `[computer] not keeping a frame for ${toolCallId}: the computer is ${status.state}, and photographing it would wake it.`, + ); + return; + } + const shot = await gateway.screenshot(botId); + const verdict = frameIsOfThisPage(shot.url, url); + if (!verdict.ok) { + console.warn( + `[computer] not keeping a frame for ${toolCallId}: ${verdict.why} rather than ${url}.`, + ); + return; + } + await pageFrames.save({ + computerId: botId, + toolCallId, + url, + title, + frame: shot.base64, + }); + } catch (error) { + console.warn( + `[computer] could not keep a frame of ${url}:`, + error instanceof Error ? error.message : error, + ); + } + } + routes.post("/:botId/navigate", async (context) => { const body = (await context.req.json().catch(() => null)) as { url?: unknown; + toolCallId?: unknown; } | null; if (typeof body?.url !== "string" || !body.url.trim()) { return context.json({ error: "A web address is required." }, 400); } + /* + * Which turn asked, so the picture can be filed under it. Optional: a caller that does not know + * (the side panel, a script) still navigates, and simply keeps no frame. + */ + const toolCallId = + typeof body.toolCallId === "string" ? body.toolCallId : ""; try { - return context.json( - await gateway.navigate( - context.req.param("botId") ?? "default", - { - id: context.var.actor.id, - ...(context.var.actor.email === DEV_ACTOR_EMAIL - ? {} - : { userId: context.var.actor.id }), - }, - body.url.trim(), - ), + const botId = context.req.param("botId") ?? "default"; + const result = await gateway.navigate( + botId, + { + id: context.var.actor.id, + ...(context.var.actor.email === DEV_ACTOR_EMAIL + ? {} + : { userId: context.var.actor.id }), + }, + body.url.trim(), ); + await keepFrameOf(botId, toolCallId, result.url, result.title); + return context.json(result); } catch (error) { if (error instanceof ActionRefusedError) { return context.json({ error: error.message, rule: error.rule }, 403); @@ -361,6 +489,23 @@ export function createComputerRoutes( }); /** The Bot's files. Through the gateway, like every other acting call. */ + /** + * The frame this turn was showing when it opened its page. + * + * Read only. Nothing writes through a route: the frame is taken where the navigation happens, + * which is the one moment the screen is certainly showing the page that was asked for. The surface + * used to capture it itself, after the turn, and lost the race often enough to show the wrong page + * or a blank one. + */ + routes.get("/:botId/page-frame/:toolCallId", async (context) => { + if (!pageFrames) return context.json({ frame: null }); + const stored = await pageFrames.load( + context.req.param("botId"), + context.req.param("toolCallId"), + ); + return context.json({ frame: stored }); + }); + routes.post("/:botId/files/list", (context) => act(context, (botId, actor, body) => gateway.listFiles(botId, actor, { diff --git a/server/src/computer/sandbox.ts b/server/src/computer/sandbox.ts new file mode 100644 index 00000000..3169a973 --- /dev/null +++ b/server/src/computer/sandbox.ts @@ -0,0 +1,416 @@ +/** + * A computer each, as a `Sandbox` on Kubernetes. + * + * `kubernetes-sigs/agent-sandbox` defines a CRD for "isolated, stateful singleton workloads with + * stable identity and persistent storage", aimed at agents that run untrusted code and drive + * graphical interfaces. That is a description of a Bot's computer, so this provider maps onto it + * rather than hand-rolling a StatefulSet per Bot and owning suspend, resume and identity ourselves. + * + * The part that would have been the hard build is a field. `spec.operatingMode` is `Running` or + * `Suspended`, and Suspended terminates the pod while keeping the volumes, so "spin down when idle, + * come back with the logins intact" is one patch and a condition to wait on. + * + * NO CLIENT LIBRARY. The Kubernetes API is HTTP and JSON, this needs five verbs of it, and a + * generated client would be a large dependency in an image that already ships a browser. The + * in-cluster service account gives a token and a CA, which is what `inClusterConfig` reads. + */ +import { readFile } from "node:fs/promises"; +import type { ComputerLocation, ComputerProvider } from "./provider"; +import type { ComputerStatus } from "./schema"; + +const SERVICE_ACCOUNT = "/var/run/secrets/kubernetes.io/serviceaccount"; +const GROUP = "agents.x-k8s.io"; +const VERSION = "v1beta1"; + +export class SandboxError extends Error { + constructor(message: string) { + super(message); + this.name = "SandboxError"; + } +} + +/** One Sandbox, in the shape the parts of it this file reads. */ +type Sandbox = { + metadata?: { name?: string; creationTimestamp?: string }; + spec?: { operatingMode?: "Running" | "Suspended" }; + status?: { + serviceFQDN?: string; + conditions?: { + type?: string; + status?: string; + reason?: string; + /** When this condition last changed, which is how one run of a computer is told from the next. */ + lastTransitionTime?: string; + }[]; + podIPs?: string[]; + nodeName?: string; + }; +}; + +export type SandboxProviderOptions = { + /** Where the Bots' computers live. The provider is scoped to exactly this namespace. */ + namespace: string; + /** + * The pod and volumes every computer is cut from. + * + * `Sandbox` carries its pod inline and has no template reference, so this has to come from + * somewhere. It comes from a file the chart mounts, which means the server needs no permission to + * read ConfigMaps and the shape of a computer stays a deployment decision rather than a constant + * in this file. + */ + template: Record<string, unknown>; + /** How long a computer may go untouched before the culler suspends it. */ + idleAfterMs: number; + apiServer?: string; + /** + * How this pod proves who it is, or a way to ask for the current one. + * + * A FUNCTION IS THE HONEST SHAPE, because a projected service account token is not a constant. The + * kubelet rewrites the file well before the token expires, and the expiry is the cluster's to set: + * an hour on a hardened cluster, a day by default. Read once and held for the life of the process, + * it works right up until the first rotation and then every sandbox call returns 401, which reads + * like the cluster broke rather than like a credential going stale. + */ + token?: string | (() => Promise<string>); + ca?: string; + fetchImpl?: typeof fetch; + /** How long `locate` waits for a suspended computer to come back before giving up. */ + resumeTimeoutMs?: number; +}; + +/** + * The service account this pod was given, which is how it reaches the API server. + * + * Absent outside a cluster, and that is not an error here: `createComputerProvider` only asks for + * this provider when a deployment configured it, and a clear message about a missing token beats a + * connection refused to an address nobody set. + */ +/** + * Read the pod template the chart mounted. + * + * A missing file is a deployment that asked for per-Bot computers without saying what one looks + * like, which is worth failing on by name rather than creating a Sandbox the API server rejects for + * a missing required field. + */ +export async function readSandboxTemplate( + path: string, +): Promise<Record<string, unknown>> { + let raw: string; + try { + raw = await readFile(path, "utf8"); + } catch { + throw new SandboxError( + `COMPUTER_SANDBOX_TEMPLATE_FILE points at ${path}, which cannot be read. That file is what a Bot's computer is cut from; the chart mounts it when computers.mode is sandbox.`, + ); + } + const parsed = JSON.parse(raw) as Record<string, unknown>; + if (!parsed.podTemplate) { + throw new SandboxError( + `${path} has no podTemplate, so there is nothing to make a computer from.`, + ); + } + return parsed; +} + +/** How long a read token is reused before the file is consulted again. */ +const TOKEN_MEMO_MS = 30_000; + +export async function inClusterConfig(): Promise<{ + apiServer: string; + token: () => Promise<string>; + ca: string; +}> { + const host = process.env.KUBERNETES_SERVICE_HOST; + const port = process.env.KUBERNETES_SERVICE_PORT ?? "443"; + if (!host) { + throw new SandboxError( + "COMPUTER_PROVIDER=sandbox needs to run inside a cluster: KUBERNETES_SERVICE_HOST is not set, so there is no API server to ask for a Bot's computer.", + ); + } + /* + * The CA is read once and the token is not. + * + * A cluster CA changes when the cluster is rebuilt, which is not a thing that happens under a + * running pod. The token changes on a schedule the cluster chooses, so it is re-read, with a short + * memo so an ordinary burst of sandbox calls does not become a burst of disk reads. Half a minute + * is far inside any rotation window and far outside any burst. + */ + const ca = await readFile(`${SERVICE_ACCOUNT}/ca.crt`, "utf8"); + let cached: { value: string; readAt: number } | undefined; + const token = async () => { + if (cached && Date.now() - cached.readAt < TOKEN_MEMO_MS) + return cached.value; + const value = (await readFile(`${SERVICE_ACCOUNT}/token`, "utf8")).trim(); + cached = { value, readAt: Date.now() }; + return value; + }; + // Read once here so a missing or unreadable token is an error at start-up rather than on the + // first Bot to ask for a computer. + await token(); + return { apiServer: `https://${host}:${port}`, token, ca }; +} + +/** + * A Kubernetes name for a Bot. + * + * Bot ids are ours and may hold anything a person typed; a resource name may hold lowercase + * alphanumerics and dashes, and is refused rather than truncated by the API server. Anything else + * becomes a dash, and a short hash keeps two ids that differ only in punctuation from colliding on + * one computer, which would be one Bot reading another's logins. + */ +export function sandboxNameFor(botId: string): string { + const slug = botId + .toLowerCase() + .replace(/[^a-z0-9-]/g, "-") + .replace(/^-+|-+$/g, ""); + let hash = 5381; + for (let index = 0; index < botId.length; index += 1) { + hash = ((hash << 5) + hash + botId.charCodeAt(index)) >>> 0; + } + const suffix = hash.toString(36); + return `bot-${slug.slice(0, 40) || "unnamed"}-${suffix}`; +} + +function conditionOf(sandbox: Sandbox, type: string): string | undefined { + return sandbox.status?.conditions?.find((c) => c.type === type)?.status; +} + +/** Ready means the pod is up and the service answers; anything else is not somewhere to send a Bot. */ +function isReady(sandbox: Sandbox): boolean { + return conditionOf(sandbox, "Ready") === "True"; +} + +function isSuspended(sandbox: Sandbox): boolean { + return ( + sandbox.spec?.operatingMode === "Suspended" || + conditionOf(sandbox, "Suspended") === "True" + ); +} + +export function createSandboxComputerProvider( + options: SandboxProviderOptions, +): ComputerProvider { + const doFetch = options.fetchImpl ?? fetch; + const resumeTimeoutMs = options.resumeTimeoutMs ?? 120_000; + const base = () => + `${options.apiServer}/apis/${GROUP}/${VERSION}/namespaces/${options.namespace}/sandboxes`; + + async function call( + path: string, + init: RequestInit & { contentType?: string } = {}, + ): Promise<unknown> { + const { contentType, ...rest } = init; + const token = + typeof options.token === "function" + ? await options.token() + : options.token; + const response = await doFetch(`${base()}${path}`, { + ...rest, + /* + * The cluster's own CA, which is the only thing that signs the API server's certificate. + * + * It is not in any public trust store, so without this every call fails with "unable to verify + * the first certificate" and a Bot simply never gets a computer. The alternative some reach for + * is to stop verifying, which would leave the token in every one of these requests open to + * anything that can answer on that address. + */ + ...(options.ca ? { tls: { ca: options.ca } } : {}), + headers: { + ...(token ? { authorization: `Bearer ${token}` } : {}), + ...(contentType ? { "content-type": contentType } : {}), + accept: "application/json", + ...(rest.headers ?? {}), + }, + } as RequestInit); + if (response.status === 404) return undefined; + if (!response.ok) { + const body = await response.text().catch(() => ""); + throw new SandboxError( + `The cluster refused a sandbox request (${response.status}): ${body.slice(0, 300)}`, + ); + } + return response.json(); + } + + const read = (botId: string) => + call(`/${sandboxNameFor(botId)}`) as Promise<Sandbox | undefined>; + + /** The desired body for a Bot's computer. Created once, then only ever patched. */ + function desired(botId: string): Record<string, unknown> { + return { + apiVersion: `${GROUP}/${VERSION}`, + kind: "Sandbox", + metadata: { + name: sandboxNameFor(botId), + namespace: options.namespace, + labels: { + "app.kubernetes.io/managed-by": "openbot", + "openbot.dev/component": "computer", + }, + // The Bot id as written, which the name above cannot always carry. The culler reads this + // rather than trying to reverse the slug. + annotations: { "openbot.dev/bot-id": botId }, + }, + spec: { + operatingMode: "Running", + // `podTemplate` is required and `volumeClaimTemplates` is what makes a suspend worth doing, + // and both arrive together from the mounted template. + ...options.template, + }, + }; + } + + async function waitForReady(botId: string): Promise<Sandbox> { + const deadline = Date.now() + resumeTimeoutMs; + for (;;) { + const sandbox = await read(botId); + if (sandbox && isReady(sandbox) && sandbox.status?.serviceFQDN) { + return sandbox; + } + if (Date.now() >= deadline) { + throw new SandboxError( + `The computer for ${botId} did not become ready within ${Math.round(resumeTimeoutMs / 1000)}s. A resume costs a pod schedule and a browser launch, so this is a real wait rather than a failure, but it has to end somewhere.`, + ); + } + await new Promise((resolve) => setTimeout(resolve, 1_000)); + } + } + + return { + name: "sandbox", + isolation: "per-bot", + + async locate(botId: string): Promise<string> { + const existing = await read(botId); + if (!existing) { + await call("", { + method: "POST", + contentType: "application/json", + body: JSON.stringify(desired(botId)), + }); + } else if (isSuspended(existing)) { + /* + * Woken, because somebody is asking for it. + * + * `locate` runs immediately before an action, so reaching a suspended computer here means a + * person is waiting. A merge patch rather than a replace: the controller owns most of this + * object and writing the whole thing back would fight it. + */ + await call(`/${sandboxNameFor(botId)}`, { + method: "PATCH", + contentType: "application/merge-patch+json", + body: JSON.stringify({ spec: { operatingMode: "Running" } }), + }); + } + + const ready = await waitForReady(botId); + const fqdn = ready.status?.serviceFQDN; + if (!fqdn) { + throw new SandboxError( + `The computer for ${botId} is ready but reported no address, so it cannot be reached.`, + ); + } + return `http://${fqdn}:4100`; + }, + + async status(botId: string): Promise<ComputerStatus> { + try { + const sandbox = await read(botId); + if (!sandbox) return { botId, state: "absent" }; + /* + * A SUSPENDED COMPUTER IS DOWN AND FINE, and reading it any other way is how scale-to-zero + * is lost. Answering this by dialling the pod would wake it, so every computer anything ever + * asked about would come back up and the bill would never fall. The conditions are the whole + * answer and nothing here touches the browser. + */ + if (isSuspended(sandbox)) return { botId, state: "absent" }; + if (isReady(sandbox)) return { botId, state: "ready" }; + return { botId, state: "starting" }; + } catch (error) { + return { + botId, + state: "unreachable", + reason: + error instanceof Error && error.message.length > 0 + ? error.message + : "The cluster could not be asked about this computer.", + }; + } + }, + + async stop(botId: string): Promise<{ wasRunning: boolean }> { + const sandbox = await read(botId); + if (!sandbox || isSuspended(sandbox)) return { wasRunning: false }; + // Suspended, not deleted: the pod goes and the volumes stay, which is the difference between + // stopping a computer and wiping a Bot's logins. + await call(`/${sandboxNameFor(botId)}`, { + method: "PATCH", + contentType: "application/merge-patch+json", + body: JSON.stringify({ spec: { operatingMode: "Suspended" } }), + }); + return { wasRunning: true }; + }, + + async reset(botId: string): Promise<{ cleared: boolean }> { + const sandbox = await read(botId); + if (!sandbox) return { cleared: false }; + // Deleted, which takes the volumes with it. This is the one that is meant to lose the logins. + await call(`/${sandboxNameFor(botId)}`, { method: "DELETE" }); + return { cleared: true }; + }, + + async list(): Promise<ComputerLocation[]> { + const body = (await call("")) as { items?: Sandbox[] } | undefined; + return (body?.items ?? []).map((sandbox) => { + const botId = + (sandbox.metadata as { annotations?: Record<string, string> }) + ?.annotations?.["openbot.dev/bot-id"] ?? + sandbox.metadata?.name ?? + ""; + return { + botId, + status: + isSuspended(sandbox) || !isReady(sandbox) ? "stopped" : "running", + url: sandbox.status?.serviceFQDN + ? `http://${sandbox.status.serviceFQDN}:4100` + : "", + ...(sandbox.metadata?.creationTimestamp + ? { startedAt: sandbox.metadata.creationTimestamp } + : {}), + }; + }); + }, + + async sessionOf(botId: string): Promise<string | undefined> { + /* + * Which run of this computer this is, and it has to change across a suspend and resume. + * + * A snapshot's generation only orders snapshots within one run of a browser: a resumed computer + * counts from one again, so a ref the model still holds from before the suspend would match a + * row nothing has overwritten, and the boundary would decide about an element on a page that no + * longer exists. + * + * NOT THE NODE AND NOT THE POD IP, which is what this used and what testing a real resume + * disproved. A suspended sandbox is very often rescheduled onto the same node and handed the + * same address back, because nothing else has taken it: measured on EKS, both were byte for + * byte identical across a suspend and resume, so the check would have said "same run" for the + * exact case it exists to catch. + * + * The `Ready` condition's transition time does move, because suspending drives Ready to False + * and resuming drives it back to True. It is the moment this run of the browser started + * serving, which is precisely the question, and it needs no permission beyond the sandbox this + * already reads. The pod's own UID would be exact too, and would cost a second read and the + * right to list pods. + * + * Reading, never ensuring: this must not be the thing that wakes a computer up. + */ + const sandbox = await read(botId); + if (!sandbox || isSuspended(sandbox)) return undefined; + const ready = sandbox.status?.conditions?.find( + (condition) => condition.type === "Ready", + ); + if (ready?.status !== "True") return undefined; + return ready.lastTransitionTime; + }, + }; +} diff --git a/server/src/computer/supervisor.ts b/server/src/computer/supervisor.ts index 37c388f7..76ac0201 100644 --- a/server/src/computer/supervisor.ts +++ b/server/src/computer/supervisor.ts @@ -13,14 +13,22 @@ * honest about being one shared computer. */ -import type { ComputerStatus } from "./schema"; import type { ComputerLocation, ComputerProvider } from "./provider"; +import type { ComputerStatus } from "./schema"; /** * The last container start time seen for each Bot, from the `/ensure` that located it. * * Not a cache in front of the supervisor: `locate` still calls it every time. This only carries the * answer the few lines to whoever needs to know which run of the computer they are talking to. + * + * PROCESS-LOCAL, AND THEREFORE NEVER THE ONLY ANSWER. On one replica the snapshot and the click that + * follows it are the same process, so this is always populated by the time anything asks. On several + * they are usually not, and a replica that has never located this Bot has nothing here. `resolve` + * reads an unknown session as "no opinion" and skips the generation check, so an empty map does not + * fail — it silently stops checking, on exactly the deployment shape the check was written for. So + * `sessionOf` falls back to asking, and this stays what it always was: a way to skip the round trip + * on the replica that just did the work. */ const sessions = new Map<string, string>(); @@ -157,11 +165,34 @@ export function createDockerSupervisorProvider( async sessionOf(botId: string): Promise<string | undefined> { /* * Read from the same `/ensure` every action already makes, and remembered rather than asked - * for again: `locate` runs immediately before the call that needs this, so the value is as - * fresh as the address it was fetched with. Asking twice would double the supervisor's work on - * the hot path to learn something it just told us. + * for again: on the replica that located this Bot, `locate` ran immediately before the call + * that needs this, so the value is as fresh as the address it was fetched with. Asking twice + * would double the supervisor's work on the hot path to learn something it just told us. */ - return sessions.get(botId); + const known = sessions.get(botId); + if (known) return known; + + /* + * Nothing here means another replica did the work, not that there is nothing to know. + * + * LISTING, NOT ENSURING, and the difference is the whole feature. `/ensure` starts a computer + * that is not running, so answering "which run is this" with it would wake every idle Bot that + * anything asked about, and a deployment that suspends idle computers would quietly never + * suspend one. Listing is a read: a Bot with no computer answers undefined, which is the same + * answer as before and leaves the check exactly where it was. + */ + try { + const computers = await listRaw(); + const startedAt = computers.find( + (computer) => computer.botId === botId, + )?.startedAt; + if (startedAt) sessions.set(botId, startedAt); + return startedAt; + } catch { + // Unknown, not mismatched. A supervisor that cannot be reached must not turn every ref into + // a refusal; the generation check goes back to being skipped, which is where it started. + return undefined; + } }, async locate(botId: string): Promise<string> { diff --git a/server/src/computer/target.ts b/server/src/computer/target.ts index a0874141..0304b9a9 100644 --- a/server/src/computer/target.ts +++ b/server/src/computer/target.ts @@ -39,6 +39,20 @@ const NEVER_ALLOWED_HOSTNAMES = new Set([ "100.100.100.200", ]); +/** + * Is this the address of a cloud metadata service? + * + * Exported because the same question is asked outside browsing: an MCP server address an + * administrator types is refused on the same grounds, and the answer has to come from one list. + * Two copies drift, and the copy that misses an alias is the one that lets a credential endpoint + * through. + * + * Canonicalises first, so the trailing-dot and IPv6 spellings are seen through here as well. + */ +export function isNeverAllowedHostname(hostname: string): boolean { + return NEVER_ALLOWED_HOSTNAMES.has(canonicalHostname(hostname.toLowerCase())); +} + /** Hostnames inside the deployment. Reachable only when a deployment opts in. */ const INTERNAL_HOSTNAMES = new Set([ "localhost", @@ -204,9 +218,7 @@ export function checkComputerAddress(raw: string): TargetVerdict { // Canonicalised for the same reason navigation is: the address reaches a fetch either way, so the // spellings that gate has to see through are the spellings this one has to see through. - if ( - NEVER_ALLOWED_HOSTNAMES.has(canonicalHostname(url.hostname.toLowerCase())) - ) { + if (isNeverAllowedHostname(url.hostname)) { return { allowed: false, reason: @@ -244,7 +256,7 @@ export function checkNavigationTarget( const hostname = canonicalHostname(url.hostname.toLowerCase()); // Checked before the opt-in, so no configuration can reach it. - if (NEVER_ALLOWED_HOSTNAMES.has(hostname)) { + if (isNeverAllowedHostname(hostname)) { return { allowed: false, reason: diff --git a/server/src/config.ts b/server/src/config.ts index c4a71671..3dced0e6 100644 --- a/server/src/config.ts +++ b/server/src/config.ts @@ -38,7 +38,28 @@ export type SharedComputerConfig = { policy?: ActionPolicy; }; -export type ComputerConfig = DockerComputerConfig | SharedComputerConfig; +/** + * A computer each, created by the cluster. + * + * The namespace is the whole scope: the service account this runs under may manage Sandboxes there + * and nowhere else, which is a smaller blast radius than the Docker supervisor's, since that one + * holds a socket that is root-equivalent on its host. + */ +export type SandboxComputerConfig = { + provider: "sandbox"; + namespace: string; + idleAfterMs: number; + /** Where the chart mounted the shape of a computer. */ + templateFile: string; + token?: string; + allowPrivateHosts: boolean; + policy?: ActionPolicy; +}; + +export type ComputerConfig = + | DockerComputerConfig + | SharedComputerConfig + | SandboxComputerConfig; /** * Who a deployment lets in, and through which front door. @@ -560,10 +581,39 @@ function privateHostsAllowed(environment: Environment): boolean { return true; } +/** + * A duration a person would write, as milliseconds. + * + * `30m` rather than `1800000`, because this one is read and edited by whoever is deciding how long a + * computer may sit idle, and a wrong number of zeroes there is either a computer that never sleeps + * or one that vanishes mid-task. Plain digits are still milliseconds, so anything already set keeps + * its meaning. + */ +export function durationMs(value: string): number { + const match = /^(\d+)\s*(ms|s|m|h)?$/.exec(value.trim()); + if (!match) { + throw new Error( + `"${value}" is not a duration. Write it as 30s, 30m, 2h, or a plain number of milliseconds.`, + ); + } + const amount = Number(match[1]); + switch (match[2]) { + case "h": + return amount * 3_600_000; + case "m": + return amount * 60_000; + case "s": + return amount * 1_000; + default: + return amount; + } +} + function computerConfig(environment: Environment): ComputerConfig | undefined { const supervisorAddress = optional(environment, "COMPUTER_SUPERVISOR_URL"); const sharedAddress = optional(environment, "AGENT_COMPUTER_URL"); - if (!supervisorAddress && !sharedAddress) { + const sandboxNamespace = optional(environment, "COMPUTER_SANDBOX_NAMESPACE"); + if (!supervisorAddress && !sharedAddress && !sandboxNamespace) { return undefined; } @@ -577,6 +627,27 @@ function computerConfig(environment: Environment): ComputerConfig | undefined { const allowPrivateHosts = privateHostsAllowed(environment); const policy = actionPolicy(environment); + /* + * Checked before the other two, because a deployment that named a namespace means the cluster to + * make the computers, and a stray `AGENT_COMPUTER_URL` left in an environment would otherwise + * quietly put every Bot back on one shared browser. + */ + if (sandboxNamespace) { + return { + provider: "sandbox", + namespace: sandboxNamespace, + idleAfterMs: durationMs( + optional(environment, "COMPUTER_SANDBOX_IDLE_AFTER") ?? "30m", + ), + templateFile: + optional(environment, "COMPUTER_SANDBOX_TEMPLATE_FILE") ?? + "/etc/openbot/sandbox-template.json", + allowPrivateHosts, + ...(computerToken ? { token: computerToken } : {}), + ...(policy ? { policy } : {}), + }; + } + const supervisorUrl = url(environment, "COMPUTER_SUPERVISOR_URL"); if (supervisorUrl) { const supervisorToken = optional(environment, "SUPERVISOR_TOKEN"); diff --git a/server/src/credentials.ts b/server/src/credentials.ts index ea14fd3a..b95d7517 100644 --- a/server/src/credentials.ts +++ b/server/src/credentials.ts @@ -64,6 +64,27 @@ export type CredentialStore = { value: CredentialStoreValue, executor?: CredentialExecutor, ) => Promise<StoredCredential>; + /** + * Re-encrypt a live row in place, keeping the id everything already points at. + * + * A vendor whose refresh token ROTATES is the one caller. It has already killed the old token at + * its end by the time it answers, so there is no second grant left to withdraw and nothing to + * learn from a new row — only a row per tool call, forever. A person RECONNECTING still goes + * through `rotate`, because that is the act that leaves a live grant behind for us to withdraw at + * our side too. + * + * A revoked or missing row is refused rather than written through: a grant somebody withdrew must + * not come back to life by being handed a fresh secret. + * + * Without an executor this writes on its own connection. With one it joins the caller's + * transaction, which is how the caller that has locked this row spends the token under that lock: + * the write has to commit with the lock rather than beside it. + */ + updateSecret: ( + id: string, + encryptedValue: string, + executor?: CredentialExecutor, + ) => Promise<void>; /** * Replace one credential with another, atomically. * @@ -224,6 +245,23 @@ export function createCredentialStore( } return credential; }, + updateSecret: async (id, encryptedValue, executor = database) => { + const [credential] = await executor + .update(credentials) + .set({ encryptedValue, updatedAt: new Date() }) + .where(and(eq(credentials.id, id), isNull(credentials.revokedAt))) + .returning({ id: credentials.id }); + + /* + * One statement, so nothing can revoke the row between a check and the write. + * + * The cost is that "no such row" and "revoked" arrive as the same answer, hence the one + * message naming both. The caller acts identically on either: it refuses its call. + */ + if (!credential) { + throw new Error("Credential was not found or is revoked"); + } + }, rotate: async (input, executor) => { const write = async (transaction: CredentialExecutor) => { /** diff --git a/server/src/db/client.ts b/server/src/db/client.ts index d197dc0e..2aa57a45 100644 --- a/server/src/db/client.ts +++ b/server/src/db/client.ts @@ -12,6 +12,20 @@ export function createDatabase( databaseUrl: string, options: { max?: number } = {}, ) { + /* + * Loud rather than silent when the arguments are the wrong way round. + * + * Bun's `SQL` takes either a URL or an options object as its one argument, so a caller passing the + * pool options where the address belongs gets a working database from `$DATABASE_URL` and no + * complaint. Two tests were doing exactly that, green for a reason that had nothing to do with + * what they were checking, and the test tree is not type-checked so nothing else was going to say + * so. A connection string is a string. + */ + if (typeof databaseUrl !== "string" || databaseUrl.trim() === "") { + throw new TypeError( + "createDatabase needs a connection string as its first argument. Pool options go second.", + ); + } const client = options.max === undefined ? new SQL(databaseUrl) diff --git a/server/src/db/schema/computer.ts b/server/src/db/schema/computer.ts index 87b508d5..6892f8c6 100644 --- a/server/src/db/schema/computer.ts +++ b/server/src/db/schema/computer.ts @@ -4,7 +4,14 @@ * Split by owner so two people can add tables all day without touching the same lines. Add tables * here; never edit core.ts or coworker.ts to do it. */ -import { integer, pgTable, text, timestamp } from "drizzle-orm/pg-core"; +import { + index, + integer, + pgTable, + primaryKey, + text, + timestamp, +} from "drizzle-orm/pg-core"; import { jsonb } from "./json"; /** @@ -80,3 +87,47 @@ export const computerSnapshot = pgTable("computer_snapshot", { */ session: text("session"), }); + +/** + * What a Bot's screen looked like on the turn that opened it. + * + * A conversation is a record, and a record must not change its mind. The transcript used to fetch + * the live screen for every past turn, so an answer about one page sat under a picture of whichever + * page the Bot had open by the time somebody read it back. + * + * KEYED ON THE TURN, which is the identity of the thing being remembered. Keying on the page instead + * was a mistake with a plausible reason: two visits to one address collided, and letting the newer + * win made a past turn's picture change under it, which is the exact mutability this table exists to + * remove. A turn happens once and is then over for good, so the row is written once and never + * updated. + * + * The computer is in the key as well as the turn, so a caller who may reach one Bot cannot read + * another Bot's screen by naming a tool call. + */ +export const computerPageFrame = pgTable( + "computer_page_frame", + { + /** Whose computer it was. */ + computerId: text("computer_id").notNull(), + /** The turn that opened it. */ + toolCallId: text("tool_call_id").notNull(), + /** The page, as the browser reported it after the navigation settled. */ + url: text("url").notNull(), + title: text("title"), + /** + * The frame itself, base64 PNG. + * + * Bounded by the code that writes it rather than by the column, because the useful limit is "a + * screenshot" and the honest failure is a refusal at the boundary rather than a database error. + */ + frame: text("frame").notNull(), + capturedAt: timestamp("captured_at", { withTimezone: true }) + .notNull() + .defaultNow(), + }, + (table) => [ + primaryKey({ columns: [table.computerId, table.toolCallId] }), + // The reaper's query: everything older than the retention window, whoever it belongs to. + index("computer_page_frame_captured_idx").on(table.capturedAt), + ], +); diff --git a/server/src/db/schema/core.ts b/server/src/db/schema/core.ts index 35dc9ac1..f8869b26 100644 --- a/server/src/db/schema/core.ts +++ b/server/src/db/schema/core.ts @@ -267,6 +267,12 @@ export const channels = pgTable( onDelete: "set null", }, ), + /** + * When this channel was deleted, or null. Soft: the row, the transcript, and the Intelligence + * thread stay intact, and every read path filters on this instead. Channel grain, because + * deleting is for everyone — per-member hiding would be a membership fact instead. + */ + deletedAt: timestamp("deleted_at", { withTimezone: true }), createdAt: createdAt(), updatedAt: updatedAt(), }, @@ -297,6 +303,16 @@ export const channelMemberships = pgTable( userId: text("user_id") .notNull() .references(() => users.id, { onDelete: "cascade" }), + /** + * When this member pinned the channel, or null. On the membership, not the channel: a pin is + * one person's marker, and the membership row is already the per-member half of a channel. + */ + pinnedAt: timestamp("pinned_at", { withTimezone: true }), + /** + * When this member last had the channel open, or null for never. On the membership like the + * pin: reading is one person's act, and the unread marker it feeds is that person's alone. + */ + lastReadAt: timestamp("last_read_at", { withTimezone: true }), createdAt: createdAt(), }, (table) => [primaryKey({ columns: [table.channelId, table.userId] })], diff --git a/server/src/db/schema/index.ts b/server/src/db/schema/index.ts index b924af64..68ee5d83 100644 --- a/server/src/db/schema/index.ts +++ b/server/src/db/schema/index.ts @@ -3,5 +3,6 @@ export * from "./components"; export * from "./computer"; export * from "./core"; -export * from "./plugins"; export * from "./coworker"; +export * from "./plugins"; +export * from "./work"; diff --git a/server/src/db/schema/work.ts b/server/src/db/schema/work.ts new file mode 100644 index 00000000..6f6cb18a --- /dev/null +++ b/server/src/db/schema/work.ts @@ -0,0 +1,98 @@ +import { + index, + integer, + pgTable, + primaryKey, + text, + timestamp, +} from "drizzle-orm/pg-core"; +import { jsonb } from "./json"; + +const createdAt = () => + timestamp("created_at", { withTimezone: true }).notNull().defaultNow(); +const updatedAt = () => + timestamp("updated_at", { withTimezone: true }).notNull().defaultNow(); + +/** + * Durable work, claimed by whichever replica gets there first, leased so a dead one's work comes + * back. + * + * ONE MECHANISM, THREE FEATURES. Suspending idle computers needs it, scheduled routines need it, and + * a hop from one Bot to another needs it. Written once with all three in view rather than three + * times slightly differently, because the parts that are easy to get wrong are the same every time: + * who owns an item, what happens when the owner dies, and whether a recovery can run something + * twice. + * + * POSTGRES, NOT A QUEUE. It is already the thing every replica shares, and `for update skip locked` + * is exactly this problem: each replica takes rows nobody else holds, no coordinator, no leader + * election, no single point of failure, and adding a replica adds throughput rather than contention. + * + * NOT `setInterval`. The audit-retention sweep uses one and is safe only because deleting old rows + * twice is the same as deleting them once. Anything that spends money, calls a tool or posts a + * message is not that: fired by every replica it happens N times, and on a cluster that is Tuesday. + */ +export const workItems = pgTable( + "work_items", + { + /** What kind of work. `computer.suspend` today; routines and bot-to-bot hops later. */ + kind: text("kind").notNull(), + /** + * What the work is about, unique within its kind. + * + * The Bot id for a computer to suspend, and for a routine the routine and the minute it was due, + * because IDEMPOTENCE LIVES HERE. A routine due at 07:00 must run once even if three replicas + * wake together and a lease is reclaimed mid-flight; making the key carry the scheduled time is + * what turns "fire it again" into "insert that already exists" rather than a second run. Without + * it every recovery path is also a duplicate-run path. + */ + key: text("key").notNull(), + /** When this becomes eligible. A claim never sees an item before its time. */ + runAt: timestamp("run_at", { withTimezone: true }).notNull().defaultNow(), + /** + * Which replica holds it, and until when. + * + * Null owner means nobody has it. A lease in the past means whoever had it stopped renewing, and + * the row is free again: that is the whole recovery story, and it needs no process to notice a + * death, only the next claim to look at the clock. + */ + claimedBy: text("claimed_by"), + leaseUntil: timestamp("lease_until", { withTimezone: true }), + /** + * How many times this has been handed out. + * + * A RECLAIMED ITEM IS NOT A FRESH ONE, and the difference matters enough to count rather than + * infer. An item on its first attempt has certainly not run; one on its second may already have + * called a tool and spent money before its owner died. Whatever picks it up has to be able to + * tell those apart, so it is a number here rather than a state folded into failure. + */ + attempts: integer("attempts").notNull().default(0), + /** + * When it was done, or null while it still wants doing. + * + * KEPT RATHER THAN DELETED, because the idempotence this table promises has to survive + * completion. Finishing used to remove the row, so a routine due at 07:00 that ran and finished + * was re-offered cleanly by the next replica to wake late and ran a second time: the insert that + * was supposed to collide had nothing left to collide with. A finished row is the collision. + * + * Swept on a retention window rather than kept forever, because a queue is not an archive. + */ + finishedAt: timestamp("finished_at", { withTimezone: true }), + /** + * Why the last attempt gave up. + * + * An item that has run out of attempts stops being handed out and stays here with its count and + * its reason. That is the terminal state: visible in the table somebody can query rather than a + * row that quietly retries until the end of time. + */ + lastError: text("last_error"), + /** Anything the work needs that is not in the key. */ + payload: jsonb("payload").notNull().default({}), + createdAt: createdAt(), + updatedAt: updatedAt(), + }, + (table) => [ + primaryKey({ columns: [table.kind, table.key] }), + // The claim's own query: due, unclaimed or expired, not yet finished, oldest first. + index("work_items_claimable_idx").on(table.kind, table.runAt), + ], +); diff --git a/server/src/index.ts b/server/src/index.ts index 4b7f2bf6..228be1bb 100644 --- a/server/src/index.ts +++ b/server/src/index.ts @@ -22,6 +22,7 @@ import { createThreadIdentity } from "./channels/thread-identity"; import { createSandboxedStore } from "./components/sandboxed"; import { createComponentStore } from "./components/store"; import { createComputerGateway } from "./computer/gateway"; +import { createPageFrameStore } from "./computer/page-frames"; import { startPolicyListener } from "./computer/policy-listener"; import { createPolicyStore, @@ -45,6 +46,7 @@ import { } from "./credentials"; import { createDatabase } from "./db/client"; import { createPeopleStore } from "./people/store"; +import { redirectUriFor } from "./plugins/oauth"; import { createPluginStore } from "./plugins/store"; import { grantedSkills, grantedTools } from "./plugins/tools"; import { createIntentRouter } from "./routing/classify"; @@ -253,6 +255,9 @@ const computerGateway = computerProvider // when the snapshot was taken by another server. A Map here would be blank on every replica // but the one that snapshotted, and the boundary would decide with no element to look at. snapshots: createSnapshotStore(database), + // So wiping a profile takes the pictures of its signed-in pages with it, which is what the + // sentence on that button already promised. + pageFrames: createPageFrameStore(database), allowPrivateHosts: config.computer?.allowPrivateHosts, token: config.computer?.token, }) @@ -274,6 +279,15 @@ const pluginStore = createPluginStore({ credentials: credentialStore, encryptionKey: config.keyEncryptionKey, policy: () => policyStore.get(), + /* + * Where a vendor sends people back, for a vendor whose client this deployment registers itself. + * + * The same value the connect and callback routes build, from the same config field, because it has + * to match what was registered character for character. Undefined without a public URL, which is + * the honest state: there is nowhere for a consent flow to come back to, so there is nothing worth + * registering. + */ + redirectUri: config.publicUrl ? redirectUriFor(config.publicUrl) : undefined, }); void recordAuditEvent(bootAuditStore, { @@ -541,6 +555,8 @@ const app = createApp( identityProviderStore, // Chooses the coworker for an untagged message, on the deployment's own model and key. intentRouter, + // What a browsing turn's screen looked like when it finished, so the transcript can show it later. + createPageFrameStore(database), ); /** diff --git a/server/src/plugins/catalogue.ts b/server/src/plugins/catalogue.ts index 3c81ef4d..f4fd2d3e 100644 --- a/server/src/plugins/catalogue.ts +++ b/server/src/plugins/catalogue.ts @@ -26,6 +26,9 @@ * These are where this deployment sends a person's authorization code and receives the refresh * token that stands in for their access, so they are a reviewed source contract too. */ +// The one place browsing and this check agree on: the addresses that hold the deployment's own +// cloud credentials. `target.ts` imports nothing itself, so asking it here adds no dependency. +import { isNeverAllowedHostname } from "../computer/target"; // Type-only, so naming the transport here creates no import cycle with the registry that resolves it. import type { TransportKind } from "./transport"; @@ -46,9 +49,25 @@ export type CatalogueAuth = revokeUrl: string; /** * What to ask a person to consent to. Narrow on purpose: a scope granted by everybody who - * connects and used by nothing is a permission nobody remembers agreeing to. + * connects and used by nothing is a permission nobody remembers agreeing to. Empty for a + * vendor whose consent screen itself is the scoping (Notion), where scope strings would + * assert a control that does not exist. */ scopes: readonly string[]; + /** + * How the deployment gets its OAuth client. Absent means an administrator registers one at + * the vendor and pastes it in. `dynamic` means the deployment registers ITSELF (RFC 7591) + * on first connect — no admin step, no client secret; PKCE carries the proof instead. + */ + clientRegistration?: "dynamic"; + /** The RFC 7591 endpoint. Pinned https, required when `clientRegistration` is `dynamic`. */ + registrationUrl?: string; + /** + * Vendor-specific consent-URL parameters. Google's offline/consent pair lives HERE rather + * than in `authorizationUrlFor`, so one vendor's requirements are never sent to another — + * an unknown parameter is a thing a strict vendor may refuse the whole request over. + */ + authorizationParams?: Readonly<Record<string, string>>; }; export type CatalogueEntry = { @@ -88,8 +107,11 @@ export type CatalogueEntry = { * * Kept so the policy can be written about effect rather than about tool names a rule author would * have to look up. Known-incomplete for some vendors, which is why {@link classifyTool} treats an - * unknown tool as a write rather than as a read: a missed write that gets extra scrutiny is safer - * than a write classified as a read. + * unknown tool as a write rather than as a read: a tool the server never advertised, so nothing + * here could have named it, is safe to over-scrutinize as a write. The opposite direction is the + * one that matters for this list: a tool the server DOES advertise but that is missing from here + * classifies as a read, so an incomplete list is the failure mode, not a safe default — this list + * has to lean over-inclusive. */ writeTools: readonly string[]; /** @@ -105,7 +127,7 @@ export type CatalogueEntry = { }; /** - * One entry, deliberately. + * A short list, deliberately. * * Atlassian, Box, Slack, Salesforce and ServiceNow were here and were removed: each was a reviewed * source contract for a vendor nobody had connected, and a screen offering five untried connectors @@ -157,6 +179,15 @@ export const CATALOGUE: readonly CatalogueEntry[] = Object.freeze([ revokeUrl: "https://oauth2.googleapis.com/revoke", // Read-only, because nothing in this slice writes to anybody's Drive. scopes: Object.freeze(["https://www.googleapis.com/auth/drive.readonly"]), + /* + * `offline` and `consent` are both load bearing FOR GOOGLE. Without `access_type=offline` + * Google returns no refresh token; without `prompt=consent` a reconnect returns none either. + * They are Google parameters, so they live on Google's entry. + */ + authorizationParams: Object.freeze({ + access_type: "offline", + prompt: "consent", + }), }, /* * Named writes even though the scope above makes Google refuse them. @@ -169,6 +200,60 @@ export const CATALOGUE: readonly CatalogueEntry[] = Object.freeze([ docsUrl: "https://developers.google.com/workspace/guides/configure-mcp-servers", }, + { + key: "notion", + title: "Notion", + vendor: "Notion", + summary: "Pages and databases of whoever is asking.", + /* + * The hosted MCP server Notion runs, on the default MCP transport — the first entry to use + * it. Drive's REST adapter is a workaround for a preview-gated vendor; Notion's server is + * generally available, so this entry is the shape the catalogue was designed for. + */ + host: "https://mcp.notion.com", + path: "/mcp", + auth: { + kind: "user-oauth", + // From https://mcp.notion.com/.well-known/oauth-authorization-server, verified live. + authorizationUrl: "https://mcp.notion.com/authorize", + tokenUrl: "https://mcp.notion.com/token", + // Notion's published revocation_endpoint IS its token endpoint — not a copy-paste mistake. + revokeUrl: "https://mcp.notion.com/token", + /* + * Notion has no scope strings and no read-only scope: access is per-page, chosen on the + * consent screen. `writeTools` below plus the action policy are the ENTIRE write barrier — + * there is no vendor-side scope backing them up. + */ + scopes: Object.freeze([]), + clientRegistration: "dynamic", + registrationUrl: "https://mcp.notion.com/register", + }, + /* + * The writing tools as the hosted server advertises them today. The hosted server advertises + * its tools, so a name here that does not match an advertised tool is not the risk — an + * advertised tool that is missing from this list is: {@link classifyTool} reads an unlisted + * but advertised name as a read, never as a write. That makes under-inclusion the failure + * mode, so this list has to lean over-inclusive rather than minimal, and reconciling it + * against the live tool list on the first Refresh tools is required, not cosmetic. + */ + writeTools: Object.freeze([ + "notion-convert-page-to-skill", + "notion-create-attachment", + "notion-create-comment", + "notion-create-database", + "notion-create-file-upload", + "notion-create-folder", + "notion-create-pages", + "notion-create-view", + "notion-duplicate-page", + "notion-move-pages", + "notion-update-data-source", + "notion-update-folder", + "notion-update-page", + "notion-update-view", + ]), + docsUrl: "https://developers.notion.com/guides/mcp/build-mcp-client", + }, ]); const BY_KEY = new Map(CATALOGUE.map((entry) => [entry.key, entry])); @@ -181,6 +266,21 @@ const PATTERNS = new Map( ]), ); +/** + * Which kind of credential this entry's server record may be pointed at, or null when it takes none + * from the caller. + * + * Beside the entry rather than at the call site, because it is a property of the vendor's auth and + * not of the request. `deployment-bearer` is the only kind that means "one token this deployment + * holds for this server", which is what `mcp` names in the vault. A `user-oauth` server is answered + * with the asker's own grant and its OAuth client is registered through its own call, which mints + * the credential itself, so an id offered when the server is added is never the right one whatever + * kind it names. A server needing no credential takes none. + */ +export function serverCredentialKind(entry: CatalogueEntry): "mcp" | null { + return entry.auth.kind === "deployment-bearer" ? "mcp" : null; +} + export function catalogueEntry(key: string): CatalogueEntry | null { return BY_KEY.get(key) ?? null; } @@ -227,11 +327,10 @@ export function resolveServerUrl( /** * What this tool does, in the only two categories a policy author cares about. * - * Unknown counts as a write, in both directions it can be unknown. A tool named in - * {@link CatalogueEntry.writeTools} is a write. A tool the server advertised and this file has never - * heard of is a write, because these lists are a verified subset for several vendors rather than the - * complete surface. A tool the server never advertised at all is a write, because the only thing - * that produced the name was a model. + * Unknown counts as a write. A tool named in {@link CatalogueEntry.writeTools} is a write. A tool + * the server never advertised at all is a write, because the only thing that produced the name was + * a model. A server with no catalogue entry behind it is a write throughout, because nothing + * reviewed says any tool of theirs only reads. * * Only a tool the server itself listed AND that is absent from the write list is treated as a read. * That is the one case where both sources agree, and it is the only one where guessing permissively @@ -249,6 +348,61 @@ export function classifyTool( return entry.writeTools.includes(toolName) ? "write" : "read"; } +/** + * Words that make a parameter name a credential, wherever they appear in it. + * + * A containment test rather than a list of exact names, because the exact-name version of this rule + * refused `?token=` and accepted `?auth_token=`, `?api_token=`, `?session_token=` and every other + * spelling one word away. An operator has no way to know which of those the check happens to hold, + * so a rule that only refuses the names somebody thought of reads as a guard while behaving like a + * gap. + * + * Not shared with `sensitiveKeys` in `audit.ts`: that module reaches the database and this function + * deliberately imports nothing that does. The two also want different contents, since audit redacts + * `content`, `prompt` and `result`, which are payload field names and mean nothing here. + */ +const CREDENTIAL_WORDS = [ + "token", + "secret", + "password", + "passwd", + "credential", + "signature", + "bearer", +]; + +/** + * Names that are a credential on their own but are too short to contain safely. + * + * `sig` is the reason this list is separate from the one above: "design" contains it. These are + * compared whole, so an ordinary word carrying the same three letters is left alone. + */ +const CREDENTIAL_NAMES = new Set([ + "auth", + "authorization", + "pass", + "pwd", + "sig", +]); + +/** + * Does this parameter name say it holds a credential? + * + * Names are compared with their separators dropped, so `api_key`, `apiKey` and `x-api-key` are one + * question rather than three. A name ending in "key" is a credential and a name merely containing it + * is not, which is what keeps `keyword` and `monkey` apart; "author" is likewise not "auth". + * + * It over-refuses in one direction on purpose. A parameter this rule misreads costs an operator a + * rename, and one it misses is written to an append-only audit row that cannot be deleted. + */ +function readsAsCredential(name: string): boolean { + const normalized = name.replaceAll(/[^a-zA-Z0-9]/g, "").toLowerCase(); + if (CREDENTIAL_NAMES.has(normalized) || normalized.endsWith("key")) { + return true; + } + return CREDENTIAL_WORDS.some((word) => normalized.includes(word)); +} + /** * Is this a URL an administrator may point the deployment at? * @@ -285,6 +439,32 @@ export function customUrlRefusal(raw: string): string | null { return "Put the credential in the token field rather than in the address."; } + /* + * The query is the other half of the same hole, and the fragment is the half after that. + * + * No host rule below reads either one, and both are stored and audited with the rest of the + * string, so a token written here is as durable and as readable as one written into the userinfo. + * The fragment never reaches the server at all, which is why it is not a request-forgery concern + * and is still a disclosure one: what this rule is about is where the string ends up, not where + * the request goes. + * + * The test is on the parameter name rather than on the presence of a query, because vendors + * legitimately route and version with parameters. A floor that refused every one of them would be + * one an operator works around rather than with, and an ordinary `#section` is left alone for the + * same reason. + */ + const hash = url.hash.replace(/^#/, ""); + const marker = hash.indexOf("?"); + const fragment = + marker === -1 ? [hash] : [hash.slice(0, marker), hash.slice(marker + 1)]; + const named = [ + ...url.searchParams.keys(), + ...fragment.flatMap((part) => [...new URLSearchParams(part).keys()]), + ]; + if (named.some(readsAsCredential)) { + return "Put the credential in the token field rather than in the address."; + } + // A trailing dot is the root-anchored spelling of the same name and resolves to the same place, so // they are stripped here rather than added to each comparison below. Without it "localhost." // misses the equality test, "vault.internal." misses the suffix tests, and "database." picks up @@ -296,6 +476,20 @@ export function customUrlRefusal(raw: string): string | null { if (host.includes(":") || /^[0-9.]+$/.test(host)) { return "Give a hostname rather than an IP address."; } + /* + * The cloud metadata endpoint, by name rather than by luck. + * + * `metadata.goog` is Google's own short alias for it, published beside `metadata.google.internal`, + * and it carries a dot and none of the suffixes below, so it read as an ordinary vendor name. The + * long spelling was refused only incidentally, by the `.internal` test. + * + * Asked of the list browsing already uses rather than a second copy here. That list holds the + * aliases somebody has already had to think about, including the ones Alibaba and ECS answer on, + * and a new alias added there should not have to be remembered here as well. + */ + if (isNeverAllowedHostname(host)) { + return "That address holds this deployment's own cloud credentials."; + } if (host === "localhost" || host.endsWith(".localhost")) { return "That address is local to the deployment."; } diff --git a/server/src/plugins/oauth.ts b/server/src/plugins/oauth.ts index 04a461de..5d9c2b70 100644 --- a/server/src/plugins/oauth.ts +++ b/server/src/plugins/oauth.ts @@ -1,5 +1,5 @@ import { createHash, randomBytes } from "node:crypto"; -import { sign, verify } from "../auth/signed-value"; +import { seal, unseal } from "../auth/signed-value"; import type { CatalogueAuth } from "./catalogue"; /** @@ -8,19 +8,27 @@ import type { CatalogueAuth } from "./catalogue"; * The browser is in the middle of this, which is the whole difficulty. An authorization code arrives * on a request that somebody else's server sent the person to, so nothing on it can be believed on * its own — not who is connecting, not which server they meant, not that they ever asked. Two things - * carry the truth across: a signed state, which is this deployment's own statement about the request + * carry the truth across: a sealed state, which is this deployment's own statement about the request * it started, and a PKCE verifier, which proves the code being redeemed belongs to that request. * + * SEALED, not signed, and that distinction is the reason this comment exists. The state carries the + * PKCE verifier, and the callback URL carries the verifier's state and the authorization code + * TOGETHER. A dynamically registered client is public — it proves itself with PKCE and no secret — + * so the verifier is the only thing binding that code to this deployment. A signed state is readable + * by anybody holding it, and a callback URL is held by every CDN log, proxy log, browser history and + * vendor log it passes through: any one of those readers could redeem the code. Encrypted, the state + * says nothing to anybody but this deployment. + * * Everything here fails closed. A state that was tampered with, replayed after it expired, or minted * for some other purpose reads back as nothing, because the alternative is attaching one person's * Google account to another person's row. */ /** - * The label this deployment's connect states are signed under. + * The label this deployment's connect states are sealed under. * - * Its own, so a signature valid here can never be replayed as a run assertion and vice versa. Every - * signed value the deployment hands out would otherwise be a candidate state. + * Its own, so a state cannot be opened as a run assertion and vice versa. Every value the deployment + * hands out under this key would otherwise be a candidate state. */ const CONNECT_LABEL = "mcp-oauth-connect"; @@ -46,7 +54,7 @@ const CALLBACK_PATH = "/api/plugins/oauth/callback"; * one falls back instead of being followed, so the worst a tampered state achieves is the wrong page * of this app. * - * It lives in the SIGNED state rather than on the callback URL because the callback is a request + * It lives in the SEALED state rather than on the callback URL because the callback is a request * somebody else's server sent the browser on. Nothing on it is believable by itself. */ export type ConnectOrigin = "settings" | "admin"; @@ -56,13 +64,24 @@ export type ConnectState = { userId: string; /** Which server they are connecting. Prevents a code for one vendor landing on another's row. */ serverId: string; - /** The PKCE verifier, held here rather than in a table because it is single-use and short-lived. */ + /** + * The PKCE verifier, held here rather than in a table because it is single-use and short-lived. + * + * It is also why the state is sealed rather than signed: this is a secret travelling beside the + * code it unlocks, so a state anybody could read would be a code anybody could redeem. + */ verifier: string; /** Where to go back to. Absent reads as `settings`, which is where every flow used to end. */ returnTo?: ConnectOrigin; }; -type SignedState = ConnectState & { exp: number }; +/** + * What is actually sealed: the state, plus when it stops being one. + * + * The expiry travels inside the sealed value because sealing says nothing about freshness. Nobody + * can move it without the key, and this deployment checks it on the way out. + */ +type SealedState = ConnectState & { exp: number }; /** * Where the vendor sends somebody back to. @@ -148,35 +167,39 @@ export function challengeFor(verifier: string): string { return createHash("sha256").update(verifier).digest("base64url"); } -export function signConnectState( +/** + * The state to send a person to the vendor with. + * + * Async because sealing is: the encryption goes through WebCrypto, like every other secret this + * deployment writes down. It is one call on a path that already makes a network request or two. + */ +export async function sealConnectState( state: ConnectState, encryptionKey: string, now: number = Date.now(), -): string { - const payload: SignedState = { ...state, exp: now + STATE_TTL_MS }; - const value = Buffer.from(JSON.stringify(payload)).toString("base64url"); - return sign(value, encryptionKey, CONNECT_LABEL); +): Promise<string> { + const payload: SealedState = { ...state, exp: now + STATE_TTL_MS }; + return seal(JSON.stringify(payload), encryptionKey, CONNECT_LABEL); } /** * What a state says, or nothing at all. * - * One return for every way of being unacceptable — bad signature, wrong label, expired, malformed, - * missing a field — because a caller that has to tell those apart is a caller that can get one of - * them wrong. There is exactly one thing to do with an unusable state, so there is one answer. + * One return for every way of being unacceptable — altered, sealed by another key, sealed for + * another purpose, expired, malformed, missing a field — because a caller that has to tell those + * apart is a caller that can get one of them wrong. There is exactly one thing to do with an + * unusable state, so there is one answer. */ -export function readConnectState( - signed: string, +export async function readConnectState( + sealed: string, encryptionKey: string, now: number = Date.now(), -): ConnectState | null { - const value = verify(signed, encryptionKey, CONNECT_LABEL); +): Promise<ConnectState | null> { + const value = await unseal(sealed, encryptionKey, CONNECT_LABEL); if (!value) return null; try { - const payload = JSON.parse( - Buffer.from(value, "base64url").toString("utf8"), - ) as Partial<SignedState>; + const payload = JSON.parse(value) as Partial<SealedState>; if ( typeof payload.userId !== "string" || @@ -203,14 +226,31 @@ export function readConnectState( } } +/** + * The six keys that carry this flow's own security: who is asking (`client_id`), where the vendor + * answers (`redirect_uri`), the grant shape (`response_type`), the sealed state (`state`), and the + * PKCE proof (`code_challenge`, `code_challenge_method`). A catalogue entry's `authorizationParams` + * must never rewrite one of these — an entry setting `code_challenge_method: "plain"` would defeat + * PKCE with nothing here to catch it. The catalogue is frozen, reviewed code today, so nothing can + * reach this, but a future entry that tried would fail at first connect rather than quietly winning. + */ +const RESERVED_AUTHORIZATION_PARAMS: ReadonlySet<string> = new Set([ + "client_id", + "redirect_uri", + "response_type", + "state", + "code_challenge", + "code_challenge_method", +]); + /** * The vendor's consent screen, as a URL to send somebody to. * - * `offline` and `consent` are both load bearing. Without `access_type=offline` Google returns an - * access token and no refresh token, so the connection would appear to work and then stop about an - * hour later with nothing to renew it. Without `prompt=consent` a second connect returns no refresh - * token at all, because the person already agreed once — which turns reconnecting after a disconnect - * into a silent no-op. + * Vendor-specific parameters — Google's `offline`/`consent` pair, or nothing at all for a vendor + * like Notion whose consent screen is itself the scoping — come from the catalogue entry's own + * `authorizationParams`, never hardcoded here. The rationale for any one vendor's requirements lives + * on that vendor's entry, because a parameter this function adds for everybody is a parameter an + * unrelated vendor never asked for and may refuse the whole request over. */ export function authorizationUrlFor(input: { auth: Extract<CatalogueAuth, { kind: "user-oauth" }>; @@ -220,17 +260,34 @@ export function authorizationUrlFor(input: { codeChallenge: string; }): string { const url = new URL(input.auth.authorizationUrl); - url.search = new URLSearchParams({ + const params = new URLSearchParams({ client_id: input.clientId, redirect_uri: input.redirectUri, response_type: "code", - scope: input.auth.scopes.join(" "), - access_type: "offline", - prompt: "consent", state: input.state, code_challenge: input.codeChallenge, code_challenge_method: "S256", - }).toString(); + }); + // Empty means the consent screen itself is the scoping; an empty scope= is not "no scope". + if (input.auth.scopes.length > 0) { + params.set("scope", input.auth.scopes.join(" ")); + } + // The vendor's own requirements, from its reviewed entry — never another vendor's. + for (const [name, value] of Object.entries( + input.auth.authorizationParams ?? {}, + )) { + // Applied last, so a reserved name here would quietly rewrite the flow's own security instead + // of the vendor's. That is a bad entry, and it must fail at first connect, not win silently. + if (RESERVED_AUTHORIZATION_PARAMS.has(name)) { + throw new Error( + `authorizationParams may not set "${name}": it is one of the flow's own security ` + + "parameters (client_id, redirect_uri, response_type, state, code_challenge, " + + "code_challenge_method) and must never be rewritten by a catalogue entry.", + ); + } + params.set(name, value); + } + url.search = params.toString(); return url.toString(); } @@ -256,39 +313,108 @@ export async function redeemAuthorizationCode(input: { redirectUri: string; verifier: string; }): Promise<RedeemedGrant | null> { + const params = new URLSearchParams({ + grant_type: "authorization_code", + code: input.code, + client_id: input.clientId, + redirect_uri: input.redirectUri, + code_verifier: input.verifier, + }); + // A public (DCR) client proves itself with PKCE, and some vendors refuse an unexpected empty field. + if (input.clientSecret) params.set("client_secret", input.clientSecret); + const response = await fetch(input.tokenUrl, { method: "POST", headers: { "content-type": "application/x-www-form-urlencoded" }, - body: new URLSearchParams({ - grant_type: "authorization_code", - code: input.code, - client_id: input.clientId, - client_secret: input.clientSecret, - redirect_uri: input.redirectUri, - code_verifier: input.verifier, - }), + body: params, + /* + * A redirect is a refusal, not a detour to be followed. + * + * `tokenUrl` is pinned in the catalogue because this request carries a client secret and an + * authorization code, and following a 302 would hand both to whatever address the answer named. + * Manual leaves the 3xx as the response, which is not `ok`, so it falls into the refusal below. + */ + redirect: "manual", signal: AbortSignal.timeout(15_000), }); if (!response.ok) return null; - const body = (await response.json()) as { + /* + * Read defensively, because a 200 is not a promise of JSON. + * + * A CDN interstitial, a captive portal or a maintenance page answers 200 with HTML, and an + * unguarded parse would throw a SyntaxError out of a function whose whole contract is to refuse + * quietly — escaping the callback as a 500 instead of the redirect-with-a-notice a person who has + * just consented should get, and quoting the vendor's body into whatever logged the throw. + */ + const body = (await response.json().catch(() => null)) as { refresh_token?: unknown; scope?: unknown; - }; + } | null; /* * No refresh token is a failure, not a partial success. * * It is what a vendor returns when it believes this person already consented, and storing the * access token instead would produce a connection that works for an hour and then cannot be - * renewed — the worst of the three outcomes, because it looks like success. + * renewed — the worst of the three outcomes, because it looks like success. A body that was not + * JSON at all arrives here as nothing, which is the same answer: the vendor said something other + * than a token. */ - if (typeof body.refresh_token !== "string" || !body.refresh_token) { + if (typeof body?.refresh_token !== "string" || !body.refresh_token) { return null; } return { refreshToken: body.refresh_token, - scope: typeof body.scope === "string" ? body.scope : "", + /* + * Capped where it is read. It is a short string in the protocol and vendor-controlled in fact, + * and everything downstream shows it to somebody — the connected-accounts page, the + * `mcp.account_connected` payload, the `scope` column — none of which is a promise about length. + */ + scope: typeof body.scope === "string" ? body.scope.slice(0, 512) : "", + }; +} + +/** + * Register this deployment as an OAuth client, at the vendor's own registration endpoint. + * + * RFC 7591, the shape Notion's hosted MCP expects: a public client (`token_endpoint_auth_method: + * "none"`) whose proof is PKCE rather than a secret. Null on refusal rather than a throw, for the + * same reason `redeemAuthorizationCode` refuses quietly: the vendor's error body is written for a + * developer console and can be surfaced by the caller that knows who is listening. + */ +export async function registerDynamicClient(input: { + registrationUrl: string; + redirectUri: string; +}): Promise<{ clientId: string; clientSecret: string } | null> { + const response = await fetch(input.registrationUrl, { + method: "POST", + headers: { "content-type": "application/json" }, + body: JSON.stringify({ + redirect_uris: [input.redirectUri], + grant_types: ["authorization_code", "refresh_token"], + response_types: ["code"], + token_endpoint_auth_method: "none", + client_name: "OpenBot", + }), + // The registration endpoint is pinned in the catalogue, so a redirect is somebody else deciding + // where this deployment introduces itself. Left as the response, which is not `ok`. + redirect: "manual", + signal: AbortSignal.timeout(15_000), + }); + if (!response.ok) return null; + // A 200 is not a promise of JSON — see `redeemAuthorizationCode`. A body that will not parse is + // the vendor answering with something other than a client, which is this function's null. + const body = (await response.json().catch(() => null)) as { + client_id?: unknown; + client_secret?: unknown; + } | null; + if (typeof body?.client_id !== "string" || !body.client_id) return null; + return { + clientId: body.client_id, + // A public client has none; a vendor that issues one anyway gets it stored and sent back. + clientSecret: + typeof body.client_secret === "string" ? body.client_secret : "", }; } diff --git a/server/src/plugins/routes.ts b/server/src/plugins/routes.ts index 164242b7..30d73294 100644 --- a/server/src/plugins/routes.ts +++ b/server/src/plugins/routes.ts @@ -12,15 +12,29 @@ import { redeemAuthorizationCode, redirectUriFor, connectedAccountsUrlFor, - signConnectState, + sealConnectState, } from "./oauth"; import { CatalogueEntryUnknownError, CustomServerRefusedError, + type OAuthClient, PluginRefusedError, type PluginStore, } from "./store"; +/** + * Whether the person a consent was started for still has access to this deployment. + * + * A seam rather than an import, because these routes have no business knowing what a person is or + * where the deny list lives — and because the answer has to come from the deployment as it is when + * the callback lands, not from what was true when the flow started. + * + * False for somebody who was removed while they were away at the vendor's consent screen, and false + * for a user id that names nobody at all. Both are the same refusal: there is no live person for + * this grant to belong to. + */ +export type ConnectingPersonCheck = (userId: string) => Promise<boolean>; + /** * The Plugins surface: what this deployment has added, and which Bots may use it. * @@ -47,8 +61,8 @@ export function createPluginRoutes( */ canUseBot: BotAccessCheck, /** - * What the connect flow needs that the store does not hold: the key its state is signed with, and - * the address a vendor sends people back to. + * What the connect flow needs that the store does not hold: the key its state is sealed with, the + * address a vendor sends people back to, and who still has access when they come back. * * Optional, so a deployment with no public URL configured simply cannot start a connect flow and * says so, rather than building a redirect URI out of a request header and failing at the vendor. @@ -60,6 +74,16 @@ export function createPluginRoutes( */ connect?: { encryptionKey: string; + /** + * Whether the person a state names may still connect an account here. + * + * Required rather than optional, unlike everything else that arrived on this object as "one more + * parameter". The callback is sessionless on purpose, so this is the ONLY thing asking whether + * the identity in the state is still one this deployment recognises — and a deployment that + * forgot to pass it would complete a consent for somebody who was removed ten minutes ago and + * write a live refresh token nothing will ever revoke. + */ + personHasAccess: ConnectingPersonCheck; /** * Whether this deployment holds a shared secret a Bot may present when calling a tool back. * @@ -178,7 +202,12 @@ export function createPluginRoutes( }); return context.json({ server }); } catch (error) { - if (error instanceof CatalogueEntryUnknownError) { + // A refused credential is the administrator's mistake to correct, so it comes back as a + // refusal with its reason rather than as a 500 the way an unmapped throw would. + if ( + error instanceof CatalogueEntryUnknownError || + error instanceof CustomServerRefusedError + ) { return context.json({ error: error.message }, 400); } throw error; @@ -348,8 +377,48 @@ export function createPluginRoutes( ); } - const client = await store.oauthClientFor(serverId); + /* + * A dynamic entry introduces the deployment itself on first use; a manual one still waits + * for an administrator. Registration lives here, on the one handler that already refuses + * without OPENBOT_PUBLIC_URL — the redirect URI it registers is guaranteed to exist. + */ + /* + * A vendor in the catalogue that nobody has added to this deployment reaches here, gets past + * every check above — the entry is real — and then asks the store for a client it cannot have, + * because there is no server row to hold one. `ensureOAuthClient` says so by throwing, and + * unhandled that was a 500 on the one path where a person is trying to connect their account. + * + * The same 409 as a vendor whose client an administrator has not pasted in yet, because it is + * the same situation: the person pressing Connect has no step to take, and an administrator has + * one. The sentence names the step rather than the exception. + */ + let client: OAuthClient | null; + try { + client = + (await store.oauthClientFor(serverId)) ?? + (entry.auth.clientRegistration === "dynamic" + ? await store.ensureOAuthClient(serverId, actorEmail(context)) + : null); + } catch (error) { + if (error instanceof CatalogueEntryUnknownError) { + return context.json( + { + error: `${entry.title} has not been added to this deployment yet. An administrator has to add it first.`, + }, + 409, + ); + } + throw error; + } if (!client) { + if (entry.auth.clientRegistration === "dynamic") { + return context.json( + { + error: `${entry.title} refused this deployment's registration. Try again, and check the vendor's status if it persists.`, + }, + 502, + ); + } return context.json( { error: `${entry.title} has no OAuth client registered yet. An administrator has to add one first.`, @@ -362,7 +431,7 @@ export function createPluginRoutes( * Where to come back to, as one of two names rather than a URL the caller chose. * * Read from the query and narrowed immediately, so an unrecognised value is the default rather - * than something carried into a signed state. See {@link ConnectOrigin}: a destination that could + * than something carried into a sealed state. See {@link ConnectOrigin}: a destination that could * name another origin is an open redirect with a consent screen in front of it. */ const returnTo = @@ -374,7 +443,7 @@ export function createPluginRoutes( auth: entry.auth, clientId: client.clientId, redirectUri: redirectUriFor(connect.publicUrl), - state: signConnectState( + state: await sealConnectState( { userId: context.var.actor.id, serverId, verifier, returnTo }, connect.encryptionKey, ), @@ -387,10 +456,13 @@ export function createPluginRoutes( * Where the vendor sends somebody back. * * Deliberately not behind `requireUser`. The person arrives on a redirect from another company's - * server, and whose connection this is comes from the signed state rather than from whatever + * server, and whose connection this is comes from the sealed state rather than from whatever * session the browser happens to be carrying — which is what stops a callback delivered to the * wrong browser from attaching one person's Google account to another person's row. * + * Having no session is what makes the access check below necessary. Every other route asks the + * question by being behind a guard; this one has to ask it out loud. + * * Every failure ends the same way: back at Settings with a word about what happened, and nothing * written. There is no useful distinction here for the person between a forged state and an expired * one, and spelling out which is which tells anybody probing this endpoint how far they got. @@ -402,12 +474,29 @@ export function createPluginRoutes( if (!connect?.publicUrl) return context.redirect(failed); const code = context.req.query("code"); - const state = readConnectState( + const state = await readConnectState( context.req.query("state") ?? "", connect.encryptionKey, ); if (!code || !state) return context.redirect(failed); + /* + * Is the person in the state still somebody here? + * + * Asked here, before the code is redeemed and before anything is written, because a state is + * good for ten minutes and access can end inside them. Removing somebody deny-lists their + * address, deletes their sessions and retires the credentials they had already granted — and + * none of that reaches a consent already in flight at the vendor. Without this, that consent + * comes back and writes a fresh, live refresh token belonging to somebody who no longer has + * access, which nothing downstream will ever revoke because nothing knows it was created. + * + * The same anonymous failure as an unreadable state. Whether an address is deny-listed is not a + * fact this endpoint owes an unauthenticated caller. + */ + if (!(await connect.personHasAccess(state.userId))) { + return context.redirect(failed); + } + const entry = catalogueEntry(state.serverId); if (entry?.auth.kind !== "user-oauth") return context.redirect(failed); @@ -435,7 +524,7 @@ export function createPluginRoutes( connectedAccountsUrlFor( connect.appUrl, { serverId: state.serverId }, - // From the signed state, so the destination is one this deployment chose, not the browser. + // From the sealed state, so the destination is one this deployment chose, not the browser. state.returnTo, ), ); diff --git a/server/src/plugins/store.ts b/server/src/plugins/store.ts index c54d775f..958c29f9 100644 --- a/server/src/plugins/store.ts +++ b/server/src/plugins/store.ts @@ -6,9 +6,11 @@ import { type PolicyContext, } from "../computer/policy"; import { + type CredentialExecutor, type CredentialSecretReader, type CredentialStore, decryptCredentialForUse, + decryptSecret, encryptSecret, } from "../credentials"; import type { Database } from "../db/client"; @@ -30,8 +32,10 @@ import { classifyTool, customUrlRefusal, resolveServerUrl, + serverCredentialKind, } from "./catalogue"; import { McpServerError } from "./mcp"; +import { registerDynamicClient } from "./oauth"; import { transportFor } from "./transport"; /** @@ -92,6 +96,12 @@ export type ServerRecord = { toolsRefreshedAt: string | null; lastError: string | null; addedBy: string | null; + /** + * Whether the catalogue entry registers its own OAuth client (RFC 7591) rather than waiting on + * an administrator to paste one in. So the admin screen can hide the paste-a-client form where + * there is nothing for it to collect. + */ + dynamicClient: boolean; tools: ToolRecord[]; /** * Grants on tools this server no longer advertises. @@ -182,6 +192,43 @@ export class CustomServerRefusedError extends Error { } } +/** + * The vendor's `error` code, when a token endpoint refuses an exchange. + * + * {@link INVALID_CLIENT} is the one code this module ACTS on rather than reports, so it has to + * survive as a value. It used to travel inside the sentence, which meant the recovery in + * {@link createPluginStore}'s `refuseAndReplaceEvictedClient` hung on a substring of prose written for a + * person to read: rewording the sentence — translating it, dropping the parenthesis — would have + * turned self-registration off with every test still green. A field cannot be reworded by accident. + */ +export class TokenRefusedError extends McpServerError { + constructor( + message: string, + readonly code: string | null, + ) { + super(message); + this.name = "TokenRefusedError"; + } +} + +/** + * The vendor saying the CLIENT is the problem, rather than the grant. RFC 6749 §5.2. + * + * Told apart from every other refusal because it is the only one a deployment can do anything about + * on its own: a client it issued to itself, it can issue again. + */ +export const INVALID_CLIENT = "invalid_client"; + +/** + * A transaction, as the writes in this module hand one to each other. + * + * Named because two writes here are one decision — a secret in the vault, and the pointer that says + * what it is for — and the only way to say that is to run both on the same executor. `select`, + * `insert` and `update` alone would do for {@link CredentialExecutor}; this needs `execute` too, for + * the advisory lock that serialises the client path. + */ +type Transaction = Parameters<Parameters<Database["transaction"]>[0]>[0]; + /** * A tool name the model can actually call. * @@ -199,6 +246,39 @@ export function refFromToolName(toolName: string): string | null { return `${rest.slice(0, separator)}/${rest.slice(separator + 2)}`; } +/** + * Advertised tool names this deployment's write list does not name, where that list is the whole + * barrier. + * + * WHY THIS IS WORTH A ROW. {@link classifyTool} reads an advertised name absent from `writeTools` as + * a READ. So under-inclusion is the failure mode of that list, and it is silent: a write the vendor + * offers and the entry forgot is offered to a model as a read, and nothing anywhere says so. Notion's + * entry says reconciling its list against the live tool list "is required, not cosmetic" — this is + * the mechanical half of that, so the reconciliation is somebody reading a trail rather than somebody + * remembering. + * + * Only where the list stands alone. A vendor that expresses SCOPES has something behind the list: a + * tool missing from Drive's `writeTools` still cannot write, because `drive.readonly` refuses it at + * the vendor. Naming those would be noise in front of the one case that has no second barrier at all + * — Notion, whose access is per-page on a consent screen and whose `scopes` are therefore empty. + * + * A server with no catalogue entry is not reconciled either, and for the opposite reason: nothing + * reviewed says any tool of theirs only reads, so all of them are already writes. + * + * Sorted, so two readings of the same listing produce the same row. + */ +export function unlistedAdvertisedTools( + entry: CatalogueEntry | null, + advertised: readonly string[], +): string[] { + if (!entry || entry.writeTools.length === 0) return []; + if (entry.auth.kind !== "user-oauth" || entry.auth.scopes.length > 0) { + return []; + } + const writes = new Set(entry.writeTools); + return advertised.filter((name) => !writes.has(name)).sort(); +} + const iso = (value: Date | string | null): string | null => value === null ? null : value instanceof Date ? value.toISOString() : value; @@ -247,36 +327,83 @@ function effectiveUrl( * host does not: this request carries the deployment's client secret and somebody's refresh token, * so where it goes is a reviewed decision rather than a runtime one. * - * The vendor's error body is deliberately not passed through. It is written for whoever registered - * the client, not for the person who asked a Bot a question, and it can name the client id. + * The vendor's error body is deliberately not passed through — it is written for whoever registered + * the client, not for the person who asked a Bot a question, and it can name the client id. Its + * `error` CODE is, though, and only that: `invalid_client` is what tells a client the vendor has + * forgotten apart from a grant somebody withdrew, and those two have entirely different answers. + * It goes out as a field on {@link TokenRefusedError} as well as in the sentence, because the field + * is the copy the recovery reads. + * + * Exported for its own tests rather than for a caller. Every path through the store reaches it as + * the default `exchangeRefreshToken`, and the store's own suites inject a stub in its place — which + * leaves what this function does with a REAL vendor reply, honest or garbled, untested unless it can + * be called directly. */ -async function exchangeRefreshTokenOverHttp(input: { +export async function exchangeRefreshTokenOverHttp(input: { tokenUrl: string; client: OAuthClient; refreshToken: string; }): Promise<AccessToken> { + const params = new URLSearchParams({ + grant_type: "refresh_token", + refresh_token: input.refreshToken, + client_id: input.client.clientId, + }); + // A public (DCR) client proves itself without one, and some vendors refuse an unexpected empty + // field outright. The same guard the authorization-code redemption in `oauth.ts` uses. + if (input.client.clientSecret) { + params.set("client_secret", input.client.clientSecret); + } + const response = await fetch(input.tokenUrl, { method: "POST", headers: { "content-type": "application/x-www-form-urlencoded" }, - body: new URLSearchParams({ - grant_type: "refresh_token", - refresh_token: input.refreshToken, - client_id: input.client.clientId, - client_secret: input.client.clientSecret, - }), + body: params, signal: AbortSignal.timeout(TOKEN_TIMEOUT_MS), }); if (!response.ok) { - throw new McpServerError( - `The vendor would not renew this access (${response.status}).`, + /* + * The code, when the refusal is JSON and carries one. Read defensively: a token endpoint that + * is refusing may be refusing with an HTML error page, and a parse failure here would replace + * the vendor's status — the one fact we do have — with a syntax error. + */ + const refusal = (await response.json().catch(() => null)) as { + error?: unknown; + } | null; + /* + * Capped where it is read, because everything downstream of here shows it to somebody: the + * person who asked, the model, the connector's `lastError` on the admin page, and an audit + * payload. It is a short token in the protocol and vendor-controlled in fact, and nothing on + * those paths is a promise about length. + */ + const code = + typeof refusal?.error === "string" ? refusal.error.slice(0, 64) : null; + throw new TokenRefusedError( + `The vendor would not renew this access (${response.status}).${code ? ` (${code})` : ""}`, + code, ); } - const body = (await response.json()) as { + /* + * A 200 is not a promise of JSON, and this branch used to read it as one. + * + * The refusal above already parses defensively; the success branch did not, so a CDN interstitial + * or a maintenance page answering 200 with HTML threw a SyntaxError from here — out through + * `callTool`, which records the failure with the thrower's message, and the parser's message + * quotes the body it choked on. So a vendor's HTML reached an audit payload and the person who + * asked, as a crash rather than as the refusal every other unusable reply produces. + */ + const body = (await response.json().catch(() => null)) as { access_token?: unknown; expires_in?: unknown; - }; + refresh_token?: unknown; + } | null; + if (!body) { + throw new McpServerError( + "The vendor answered this renewal with something other than a token.", + ); + } if (typeof body.access_token !== "string" || !body.access_token) { throw new McpServerError("The vendor renewed this access with no token."); } @@ -284,6 +411,17 @@ async function exchangeRefreshTokenOverHttp(input: { accessToken: body.access_token, expiresInSeconds: typeof body.expires_in === "number" ? body.expires_in : undefined, + /* + * Only when the vendor sent one, and only a non-empty one. + * + * A rotating vendor replies with a new refresh token and invalidates the one it was shown; a + * vendor that does not rotate sends none. Reading an absent or empty field as a rotation would + * repoint a working connection at nothing. + */ + refreshToken: + typeof body.refresh_token === "string" && body.refresh_token + ? body.refresh_token + : undefined, }; } @@ -301,8 +439,39 @@ const TOKEN_TIMEOUT_MS = 10_000; */ export type OAuthClient = { clientId: string; clientSecret: string }; +/** + * The client and when the vault row holding it was written. + * + * The date is not about the client: it is how long ago this deployment last introduced itself, which + * is the one thing that distinguishes a client the vendor has evicted from one a re-registration + * minted moments ago. Null only for a row that has since disappeared, which the read refuses first. + */ +type StoredClient = { client: OAuthClient; registeredAt: Date | null }; + +/** + * How long a freshly stored OAuth client is left alone after `invalid_client`. + * + * Re-registering once per refusal is right for one call and wrong for a deployment: a vendor that is + * simply down answers every exchange `invalid_client`, and every tool call anywhere then mints a + * client of its own, because each of them is the first refusal IT has seen. A client younger than + * this was already the product of a re-registration, so registering again inside the window is + * amplification rather than recovery — the honest answer is the vendor's refusal, unedited. + */ +const CLIENT_REREGISTRATION_BACKOFF_MS = 5 * 60_000; + /** What a vendor's token endpoint gave back for a refresh token. */ -export type AccessToken = { accessToken: string; expiresInSeconds?: number }; +export type AccessToken = { + accessToken: string; + expiresInSeconds?: number; + /** + * The refresh token to present next time, from a vendor that rotates. + * + * Absent from Google's replies and present in every one of Notion's. When it is here it is the + * only one that still works — the token just spent is dead at the vendor — so it has to be + * persisted before the access token beside it is used for anything. + */ + refreshToken?: string; +}; export type PluginStoreOptions = { database: Database; @@ -342,6 +511,13 @@ export type PluginStoreOptions = { client: OAuthClient; refreshToken: string; }) => Promise<AccessToken>; + /** RFC 7591 self-registration, for entries whose clientRegistration is dynamic. */ + registerClient?: (input: { + registrationUrl: string; + redirectUri: string; + }) => Promise<OAuthClient | null>; + /** Where the vendor sends people back; needed to (re)register a dynamic client. */ + redirectUri?: string; }; export function createPluginStore(options: PluginStoreOptions) { @@ -354,6 +530,32 @@ export function createPluginStore(options: PluginStoreOptions) { const injectedVendor = options.callVendor; const exchangeRefreshToken = options.exchangeRefreshToken ?? exchangeRefreshTokenOverHttp; + const registerClient = options.registerClient ?? registerDynamicClient; + + /* + * One exchange at a time per (server, person). A rotating vendor invalidates the refresh + * token it was shown, so two concurrent calls that both present the old one would have the + * second refused through no fault of anybody's. The chain serialises them; the map entry is + * removed when the chain drains so the map cannot grow past the set of active connections. + */ + const exchangeChains = new Map<string, Promise<unknown>>(); + function serialized<T>(key: string, work: () => Promise<T>): Promise<T> { + const previous = exchangeChains.get(key) ?? Promise.resolve(); + const next = previous.catch(() => {}).then(work); + exchangeChains.set(key, next); + /* + * The refusal belongs to the caller, who is holding `next` and will see it. This branch exists + * only to forget the key, so it swallows before it cleans up: `next.finally(…)` on its own + * derives a SECOND rejected promise that nobody is holding, and a refused call — a withdrawn + * credential, say — then surfaces as an unhandled rejection somewhere unrelated. + */ + void next + .catch(() => {}) + .finally(() => { + if (exchangeChains.get(key) === next) exchangeChains.delete(key); + }); + return next; + } async function grantsFor(kind: PluginKind, refs: string[]) { if (refs.length === 0) return new Map<string, string[]>(); @@ -514,6 +716,12 @@ export function createPluginStore(options: PluginStoreOptions) { ); } + /* + * Whether this person has connected at all, which is a refusal worth reaching before anything + * queues behind another call. WHICH credential they hold is read again inside the critical + * section below, because a reconnection can move it while this call waits its turn — and even + * when the row stays put, the secret inside it does not. + */ const [held] = await database .select({ credentialId: mcpUserCredentials.credentialId }) .from(mcpUserCredentials) @@ -532,32 +740,716 @@ export function createPluginStore(options: PluginStoreOptions) { ); } - const refreshToken = await secretFor( - held.credentialId, - `Your ${entry.title} access was withdrawn. Connect it again in Settings.`, - ); + // Held before the critical section, because narrowing does not survive into a closure and this + // is where the entry is known to be a `user-oauth` one. + const { tokenUrl } = entry.auth; + const { title } = entry; + /* + * Where to register again, for a vendor that issues its own clients — and undefined for one an + * administrator registered with by hand, where there is nothing this deployment could do about a + * client the vendor no longer honours. + */ + const registrationUrl = + entry.auth.clientRegistration === "dynamic" + ? entry.auth.registrationUrl + : undefined; + + /* + * What to tell the person when the deployment holds no client they can be called on, in the + * words of whoever can actually change that. + * + * A hand-registered client is an administrator's paperwork — they pasted it in from the vendor's + * console, and only they can paste one in again. A self-registered one is nobody's paperwork: + * there is no console entry to re-create, and the deployment introduces itself again the next + * time somebody connects. Naming an administrator there would send the person to somebody with + * no step to take, which is worse than saying nothing. + */ + const noClient = registrationUrl + ? `${title} has no OAuth client for this deployment, so this cannot be called. Connect ${title} again in Settings: the deployment registers itself with the vendor when somebody connects.` + : `${title} has no OAuth client registered for this deployment, so this cannot be called. An administrator has to add one.`; + const unusableClient = registrationUrl + ? `${title} has no usable OAuth client for this deployment. Connect ${title} again in Settings: the deployment registers itself with the vendor on the next connect.` + : `${title} has no usable OAuth client for this deployment. An administrator has to add one again.`; + /** + * What to say when the vendor has forgotten the client this person's grant was issued under. + * + * The same register as the two above, and the same instruction, because it is the same situation + * from the person's side: nothing they can be called on. What is different is that the + * deployment CAN do its half — introduce itself again — and has, by the time this is thrown. So + * the sentence says that too, otherwise "connect again" reads as a thing to keep trying. + * + * Their refresh token is not carried across. A grant belongs to the client it was issued to (RFC + * 6749 §6, §10.4), so re-presenting it under the new client is a request a conforming vendor + * refuses — and one that only ever appears to work against a vendor whose acceptance would + * itself be the vulnerability. A new consent is the only thing that produces a usable grant. + */ + const clientReplaced = `${title} no longer recognises this deployment's OAuth client, so this cannot be called. The deployment has registered itself again — connect ${title} again in Settings.`; if (!row.credentialId) { - // The person did their part; the deployment has not. Said plainly, because the person cannot - // fix it and should not be told to try. - throw new PluginRefusedError( - `${entry.title} has no OAuth client registered for this deployment, so this cannot be called. An administrator has to add one.`, - null, + // The person did their part; the deployment has not. Refused before anything queues, because + // a deployment holding no client has the same answer for everybody asking. + throw new PluginRefusedError(noClient, null); + } + + /** + * The client as the deployment holds it right now, or the refusal for holding none. + * + * Read from the server row each time rather than from the row this call came in with: a retry + * that registered again — this connection's own, a moment ago — replaced it, and the pointer + * carried in from before the queue names the evicted one. + */ + async function currentClient(): Promise<StoredClient> { + /* + * When the client was stored comes back with it, from the vault row itself rather than from a + * column of our own. It is what the retry below measures its backoff against, and a left join + * keeps it one query: a server pointing at nothing is the refusal on the next line, and a + * pointer to a row that is no longer there is `secretFor`'s to refuse. + */ + const [server] = await database + .select({ + credentialId: mcpServers.credentialId, + registeredAt: credentialRows.createdAt, + }) + .from(mcpServers) + .leftJoin( + credentialRows, + eq(credentialRows.id, mcpServers.credentialId), + ) + .where(eq(mcpServers.id, row.id)) + .limit(1); + if (!server?.credentialId) { + throw new PluginRefusedError(noClient, null); + } + return { + client: JSON.parse( + await secretFor(server.credentialId, unusableClient), + ) as OAuthClient, + registeredAt: server.registeredAt, + }; + } + + /* + * The exchange, one call at a time for this connection, reading the connection fresh inside. + * + * Both halves of what goes out are read in here rather than carried in from above, because both + * can move while this call waits its turn. The refresh token rotates, and the token read a + * moment ago is then already spent — presenting it would be refused by the vendor for no reason + * the person could act on. The client is replaced by a re-registration, and presenting the + * evicted one would have every queued call discover that separately and register around it. + * + * TWO things serialise this, and they are not redundant. The map above queues calls made in THIS + * process; the row lock below serialises the whole deployment. Only the lock is a correctness + * property — a second replica has a map of its own and is not in ours — and the map is what + * keeps a burst of calls on one connection from piling N transactions onto that one row lock, + * each of them holding a pooled connection while it waits its turn. + * + * An evicted client is handled AFTER the transaction rather than inside it. Nothing about + * re-registering needs this person's lock — the client is per server — and doing it inside would + * have a second pooled connection opened while this one holds a row lock, which is the shape the + * pool note in `db/client.ts` is about. + */ + return await serialized(`${row.id}:${actorId}`, async () => { + /* + * The client, read before the transaction opens rather than inside it. + * + * It is per SERVER and is not what the lock protects, and reading it here keeps the vault read + * off a second pooled connection while this call holds one open for the whole exchange. Still + * inside the critical section, so the ordering that matters is unchanged: a queued call reads + * the client after whatever ran before it replaced it. + */ + const stored = await currentClient(); + + /* + * The vault row, locked for as long as the token it holds is being spent. + * + * A rotating vendor kills the refresh token it was shown, so two replicas that both read the + * stored token and both present it do not merely race: the second presentation looks to the + * vendor like a stolen token being replayed, and refresh-token-reuse detection answers it by + * revoking the whole token family. The connection is then bricked, and nobody did anything + * wrong. `SELECT … FOR UPDATE` is what makes the second replica wait for the first, exactly as + * a person reconnecting already waits (`credentials.rotate`). + * + * Yes, the lock is held across an HTTP call to the vendor — bounded by the exchange's own + * timeout. That is the point rather than an oversight: the lock IS the cross-replica + * serialisation, and a lock released before the exchange would serialise nothing. + * + * The read comes AFTER the lock, never before. A replica that woke from the lock and used a + * token it had read on the way in would present the one the first replica just spent, which is + * the very double-spend this exists to prevent. + */ + try { + return await database.transaction(async (transaction) => { + const [current] = await transaction + .select({ + credentialId: mcpUserCredentials.credentialId, + scope: mcpUserCredentials.scope, + }) + .from(mcpUserCredentials) + .where( + and( + eq(mcpUserCredentials.serverId, row.id), + eq(mcpUserCredentials.userId, actorId), + ), + ) + .limit(1); + + // Disconnected while this call was queued. The same sentence as above: nothing is broken, + // and connecting again is the thing to do. + if (!current) { + throw new PluginRefusedError( + `You have not connected your ${title} account. Connect it in Settings and ask again.`, + null, + ); + } + + const [locked] = await transaction + .select({ + encryptedValue: credentialRows.encryptedValue, + revokedAt: credentialRows.revokedAt, + }) + .from(credentialRows) + .where(eq(credentialRows.id, current.credentialId)) + .for("update"); + /* + * A row that is gone or revoked, said the way `secretFor` says it: withdrawn access is + * nobody's fault and connecting again is the step. Reached by a replica that waited here + * while somebody disconnected, as well as by one that was told after the fact. + */ + if (!locked || locked.revokedAt) { + throw new PluginRefusedError( + `Your ${title} access was withdrawn. Connect it again in Settings.`, + null, + ); + } + const refreshToken = await decryptSecret( + encryptionKey, + locked.encryptedValue, + ); + + const minted = await exchangeRefreshToken({ + tokenUrl, + client: stored.client, + refreshToken, + }); + + /* + * A vendor that sent nothing back, or sent back the token we presented, rotated nothing — + * and writing either would be inventing a rotation, at the cost of a needless + * re-encryption of every connection on every call. + */ + if (minted.refreshToken && minted.refreshToken !== refreshToken) { + /* + * The vendor rotated the grant: the token we were just shown is now the only valid one. + * Persisting it is not optional bookkeeping — failing to would strand the connection on + * the next call — so a failure here refuses THIS call rather than returning an access + * token whose refresh token is already spent. + * + * In this transaction, so it commits with the lock that made the exchange ours: written + * outside it, the next replica in line would wake to the token this one just spent. + */ + await rotateConnectionToken( + { + credentialId: current.credentialId, + refreshToken: minted.refreshToken, + }, + transaction, + ); + } + + return { token: minted.accessToken }; + }); + } catch (error) { + /* + * Outside the transaction, so the row lock is already released and the vault read this does + * is not a second connection held behind this one's. + * + * Rethrows anything that is not the vendor disowning our client, which is every ordinary + * failure: a withdrawn grant, a vendor being down, a disconnect mid-queue. + */ + return await refuseAndReplaceEvictedClient({ + error, + clientRegisteredAt: stored.registeredAt, + registrationUrl, + serverId: row.id, + refusal: clientReplaced, + }); + } + }); + } + + /** + * The vendor has disowned this deployment's client: fix the deployment, refuse the call. + * + * `invalid_client` is the vendor saying the CLIENT is the problem, and for a client the deployment + * issued to itself there is nobody to tell — no console entry an administrator could re-create, so + * every connection to that server would otherwise sit behind a refusal nothing here can act on. + * Introducing itself again is the same act as the first registration, and it is worth doing: it is + * what makes the next CONSENT possible. + * + * IT DOES NOT MAKE THIS CALL POSSIBLE, and this function used to pretend otherwise. It registered a + * new client and re-presented the same refresh token under it. A refresh token is bound to the + * client it was issued to — RFC 6749 §6 has the token endpoint verify exactly that, and §10.4 is + * why — so a conforming vendor refuses the retry, and the only vendor it can work against is one + * whose acceptance would itself be the vulnerability. So the grant is never carried across, and the + * person is told the one thing that helps: connect again. + * + * The re-registration is still bounded by {@link CLIENT_REREGISTRATION_BACKOFF_MS}, and that bound + * is the whole protection here rather than a nicety. This runs for any non-admin's tool call, and + * it REPLACES the client every other connection in the deployment is bound to; a vendor that is + * simply down answers every exchange `invalid_client`, so without the window one outage would have + * each call in turn rotate the deployment-wide client. A client younger than the window is the + * product of the last refusal's re-registration, and is left exactly alone. + * + * Always throws. The refusal it raises when it did register is the caller's answer; anything it + * cannot act on is rethrown untouched, because the vendor's own words are better than ours. + */ + async function refuseAndReplaceEvictedClient(input: { + error: unknown; + /** When the client that was just refused was stored. */ + clientRegisteredAt: Date | null; + registrationUrl: string | undefined; + serverId: string; + /** What to tell the person once the deployment has registered itself again. */ + refusal: string; + }): Promise<never> { + const { error, registrationUrl, serverId } = input; + /* + * The code, off the error itself. Never the sentence: that is written for a person, and a + * recovery that read it would be one rewording away from silently never running again. + */ + const code = error instanceof TokenRefusedError ? error.code : null; + const { redirectUri } = options; + if (code !== INVALID_CLIENT || !registrationUrl || !redirectUri) { + throw error; + } + + const registeredAt = input.clientRegisteredAt; + if ( + registeredAt && + Date.now() - registeredAt.getTime() < CLIENT_REREGISTRATION_BACKOFF_MS + ) { + throw error; + } + + const fresh = await registerClient({ registrationUrl, redirectUri }); + // The vendor would not have us either. The first refusal is the one worth reporting: it says + // what actually stopped the call, where this one says what stopped the recovery. + if (!fresh) throw error; + + await persistOAuthClient({ serverId, client: fresh, by: "deployment" }); + throw new PluginRefusedError(input.refusal, null); + } + + /** + * Point one person's connection at a new refresh token, revoking the one it replaces. + * + * For a person connecting, which is where a new row earns its keep: what they held before this is + * still a live grant at the vendor, and the revocation is how it stops being one. A vendor's own + * rotation is the other case entirely, and goes through {@link rotateConnectionToken}. + * + * Upserted on the pair, so it is the same act whether they are connecting or reconnecting. The + * credential the row used to point at is revoked in the same breath: a refresh token nothing + * points at is still a live grant at the vendor, and leaving it behind would mean somebody had two + * valid grants and could only ever see one of them to withdraw it. + * + * Says whether it replaced something, which is the one fact the caller writing the trail needs + * and cannot recover afterwards. + * + * ONE TRANSACTION, because these are two writes and one decision. The secret goes into the vault + * and the connection row is pointed at it; separately, a failure between them leaves the pointer + * naming the credential the rotation had just revoked — a connection that reads as live on the + * settings page and refuses every call, with the person's actual grant retired and no way back to + * it. `credentials.rotate` and `credentials.create` already accept the caller's executor for + * exactly this, and the pointer write runs on the same one. + */ + async function swapUserCredential(input: { + serverId: string; + userId: string; + refreshToken: string; + scope: string; + }): Promise<{ replaced: boolean }> { + const key = { + kind: "mcp_user_token" as const, + provider: input.serverId, + keyId: input.userId, + }; + const value = { + ...key, + metadata: { server: input.serverId, scope: input.scope }, + // Encrypted before the transaction opens: it is arithmetic, and it has no business happening + // while a pooled connection is held open behind row locks. + encryptedValue: await encryptSecret(encryptionKey, input.refreshToken), + }; + + return await database.transaction(async (transaction) => { + /* + * `credentials_active_key_idx` holds one live credential per key, so a second insert for the + * same person and server would be refused. Asked of the key rather than of the connection row, + * because the row can name a credential that has already been revoked while the key itself is + * free, and it is the key the index constrains. + */ + const live = await credentials.findLiveByKey(key, transaction); + const stored = live + ? await credentials.rotate( + { ...value, previousCredentialId: live.id }, + transaction, + ) + : await credentials.create(value, transaction); + + await transaction + .insert(mcpUserCredentials) + .values({ + serverId: input.serverId, + userId: input.userId, + credentialId: stored.id, + scope: input.scope, + }) + .onConflictDoUpdate({ + target: [mcpUserCredentials.serverId, mcpUserCredentials.userId], + set: { + credentialId: stored.id, + scope: input.scope, + updatedAt: new Date(), + }, + }); + + return { replaced: live !== null }; + }); + } + + /** + * Carry a connection over to the refresh token the vendor rotated to. + * + * In place, in the vault row the connection already points at — deliberately NOT the swap + * {@link swapUserCredential} performs. A rotating vendor issues a new refresh token on every + * exchange, so a swap here would mint a row and revoke a row per tool call, forever, on the + * hottest path there is. And the revocation would have nothing to withdraw: the token just spent + * was dead at the vendor the moment it answered, so the only live grant is the one being written. + * + * Deliberately WITHOUT the `mcp.account_connected` row, for the same reason as ever: rotation is + * the vendor's plumbing, not a person's act, and a trail that records it as one reads as a + * re-consent that nobody performed. + * + * The scope and the row are left alone. Nothing about what the vendor granted has changed — only + * which token presents it. + */ + async function rotateConnectionToken( + input: { + credentialId: string; + refreshToken: string; + }, + /** + * The transaction the caller spent the token in, and this write belongs to it. + * + * The caller holds a `FOR UPDATE` lock on the very row being written. On its own pooled + * connection this write would be a second session waiting for a lock only the caller can + * release, and the caller cannot release it while awaiting this — so it would hang to the + * statement timeout rather than rotate. + */ + executor?: CredentialExecutor, + ): Promise<void> { + await credentials.updateSecret( + input.credentialId, + await encryptSecret(encryptionKey, input.refreshToken), + executor, + ); + } + + /** The one vault key a server's OAuth client is ever stored under. */ + const oauthClientKey = (serverId: string) => ({ + kind: "mcp_oauth_client" as const, + provider: serverId, + keyId: `oauth-client-${serverId}`, + }); + + /** + * One writer at a time for one server's OAuth client, across the whole deployment. + * + * Everything that stores a client reads "is there a live one" and then writes accordingly, and the + * gap between those two used to be unserialised. `POST /connect` is `requireUser`, so two people + * pressing Connect on a fresh connector is not a rare interleaving: both read no live client, and + * then the second `create` meets the first on `credentials_active_key_idx` as a raw 23505 — a 500 + * where a consent URL belonged — or, when there was a client to replace, the second `rotate` finds + * its own predecessor already revoked and says so. + * + * An ADVISORY lock rather than a row lock, because the thing being protected is the ABSENCE of a + * row as much as a row: there is nothing to lock `FOR UPDATE` on a first registration. Held for + * the transaction, so it is released by the commit or the rollback and never by us forgetting. + * + * `hashtext` collisions are harmless here. Two servers sharing a hash would take turns registering + * clients, which is slower and not wrong. + */ + async function withOAuthClientLock<T>( + serverId: string, + work: (transaction: Transaction) => Promise<T>, + ): Promise<T> { + return await database.transaction(async (transaction) => { + await transaction.execute( + sql`select pg_advisory_xact_lock(hashtext(${`oauth-client-${serverId}`}))`, ); + return await work(transaction); + }); + } + + /** + * {@link storedOAuthClient}'s question, asked on the caller's own transaction. + * + * The same question deliberately — the server row's pointer, and the row it names being live — + * because the callback redeems against `oauthClientFor`, which reads exactly that. A read that + * accepted a live client the server row does NOT name would hand somebody a consent screen for a + * client the callback then cannot find, and the connect would fail after the vendor said yes. + * + * On the transaction rather than through `storedOAuthClient` because the caller is inside + * {@link withOAuthClientLock} and holding a pooled connection: a read on a second connection would + * be a session queueing behind sessions that cannot finish until it returns. + */ + async function heldOAuthClient( + transaction: Transaction, + serverId: string, + ): Promise<OAuthClient | null> { + const [server] = await transaction + .select({ credentialId: mcpServers.credentialId }) + .from(mcpServers) + .where(eq(mcpServers.id, serverId)) + .limit(1); + if (!server?.credentialId) return null; + + const [held] = await transaction + .select({ + encryptedValue: credentialRows.encryptedValue, + revokedAt: credentialRows.revokedAt, + }) + .from(credentialRows) + .where(eq(credentialRows.id, server.credentialId)) + .limit(1); + if (!held || held.revokedAt) return null; + + try { + return JSON.parse( + await decryptSecret(encryptionKey, held.encryptedValue), + ) as OAuthClient; + } catch { + // Unreadable is the same as none: there is nothing to send anybody to consent with. + return null; } - const client = JSON.parse( - await secretFor( - row.credentialId, - `${entry.title} has no usable OAuth client for this deployment. An administrator has to add one again.`, + } + + /** + * The two writes that store a client, on one transaction: the vault row, and the pointer to it. + * + * One transaction because they are one decision. Separately, a failure between them leaves + * `mcp_servers.credential_id` naming the credential the rotation had just revoked — a connector + * that looks configured on every screen and cannot complete a consent flow. + * + * The caller is expected to hold {@link withOAuthClientLock}, which is what makes the read below + * safe to act on. + */ + async function writeOAuthClient( + input: { serverId: string; client: OAuthClient }, + transaction: Transaction, + ): Promise<{ replaced: boolean }> { + const key = oauthClientKey(input.serverId); + const value = { + ...key, + metadata: { server: input.serverId, clientId: input.client.clientId }, + encryptedValue: await encryptSecret( + encryptionKey, + JSON.stringify(input.client), ), - ) as OAuthClient; + }; - const minted = await exchangeRefreshToken({ - tokenUrl: entry.auth.tokenUrl, - client, - refreshToken, + const live = await credentials.findLiveByKey(key, transaction); + const stored = live + ? await credentials.rotate( + { ...value, previousCredentialId: live.id }, + transaction, + ) + : await credentials.create(value, transaction); + + await transaction + .update(mcpServers) + .set({ credentialId: stored.id, updatedAt: new Date() }) + .where(eq(mcpServers.id, input.serverId)); + + return { replaced: live !== null }; + } + + /** + * The trail row for a client this deployment now holds. + * + * Written AFTER the transaction that stored it, not inside. The audit store has its own handle on + * the database, so writing from inside would open a second pooled connection while the first is + * held — the shape the pool note in `db/client.ts` warns about, and the one that turns a busy + * deployment into a hang. A trail row lost to a crash in that window is a worse trade than a + * deadlock, but only just, and this way round the client is at least the thing that is certain. + */ + async function recordClientRegistered( + input: { serverId: string; client: OAuthClient; by: string }, + replaced: boolean, + ): Promise<void> { + await recordAuditEvent(auditStore, { + eventType: "mcp.oauth_client_registered", + targetType: "mcp_server", + targetId: input.serverId, + payload: { + actor: input.by, + server: input.serverId, + // The id, never the secret. It identifies the client that was registered, which is what + // somebody reading the trail needs in order to check it against the vendor's console. + clientId: input.client.clientId, + replaced, + }, }); - return { token: minted.accessToken }; + } + + /** + * Store the deployment's OAuth client for a `user-oauth` server, whoever obtained it. + * + * Both halves go into one encrypted value, so a single vault read yields a usable client. The id is + * copied into `metadata` as well — it is not a secret, and a page listing what the deployment holds + * should be able to name it without decrypting anything. + * + * Replacing a client revokes the previous one rather than orphaning it, so "what does this + * deployment hold" keeps having one answer per server. Nobody's connection breaks in the sense that + * matters here — a refresh token is the person's — but nobody's connection SURVIVES either: a grant + * belongs to the client it was issued to, so replacing the client is asking everybody to connect + * again. That is why the two callers that replace one both say so to whoever is listening. + * + * Shared by an administrator pasting one in and by the deployment registering its own, so `by` is + * the only difference between the two in the trail — which is the honest one. + */ + async function persistOAuthClient(input: { + serverId: string; + client: OAuthClient; + by: string; + }): Promise<void> { + const { entry } = await requireServer(input.serverId); + if (entry?.auth.kind !== "user-oauth") { + throw new CustomServerRefusedError( + `${input.serverId} is not reached with an OAuth client.`, + ); + } + + const { replaced } = await withOAuthClientLock( + input.serverId, + (transaction) => + writeOAuthClient( + { serverId: input.serverId, client: input.client }, + transaction, + ), + ); + + await recordClientRegistered(input, replaced); + } + + /** + * The deployment's OAuth client for a server as it stands, or null if there is none to read. + * + * Decrypted, because both halves are needed: the id to build a consent URL and the secret to + * redeem the code it comes back with. Held for the length of one request, like every other secret + * this module reads. + */ + async function storedOAuthClient( + serverId: string, + ): Promise<OAuthClient | null> { + const [row] = await database + .select({ credentialId: mcpServers.credentialId }) + .from(mcpServers) + .where(eq(mcpServers.id, serverId)) + .limit(1); + if (!row?.credentialId) return null; + + try { + return JSON.parse( + await decryptCredentialForUse( + encryptionKey, + credentials, + row.credentialId, + ), + ) as OAuthClient; + } catch { + // A revoked, missing or unreadable client is the same as none for every caller: there is + // nothing to send anybody to consent with, and the answer is to obtain one again. + return null; + } + } + + /** + * The credential a server is being pointed at is of the kind that server can spend. + * + * Both add paths dereference the pointer before they return, so this is checked where the pointer + * is accepted rather than where it is used. `mcp` is the only kind that answers "this server's own + * token". A `mcp_user_token` is one person's grant and a `mcp_oauth_client` identifies the + * deployment to a vendor; spending either here uses a credential on behalf of somebody who never + * agreed to it, which is the same objection `POST /api/admin/credentials` already makes when it + * refuses to mint those two by hand. + * + * The shape is checked before the lookup because `credentials.id` is a `uuid` column, so a value + * that is not one makes the query itself fail rather than return no rows, and the caller gets a + * database error where a refusal belongs. + * + * One message for both "wrong kind" and "no such credential", deliberately. A caller who can tell + * those apart can ask this endpoint which credential ids are real. + */ + async function requireCredentialOfKind( + serverTitle: string, + serverId: string, + credentialId: string, + kind: "mcp" | null, + ): Promise<void> { + /* + * A server that takes no credential when it is added is refused here rather than at the caller, + * so that offering an id is one question with one answer wherever it is asked. The wording says + * what is true of both kinds that reach it: a `user-oauth` server's client arrives through the + * call that mints it, and a server needing no credential has nothing to be given. + */ + if (!kind) { + throw new CustomServerRefusedError( + `${serverTitle} takes no credential when it is added.`, + ); + } + + const looksLikeId = + /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test( + credentialId, + ); + /* + * Live, as well as the right kind and the right owner. + * + * A revoked credential cannot be decrypted, so attaching one only ever produced a server that + * fails on its next call. Refusing it here says so at the moment somebody can still act on it, + * and it closes the case where a token was retired precisely because it should stop being used. + */ + const [named] = looksLikeId + ? await database + .select({ + kind: credentialRows.kind, + provider: credentialRows.provider, + }) + .from(credentialRows) + .where( + and( + eq(credentialRows.id, credentialId), + isNull(credentialRows.revokedAt), + ), + ) + : []; + + /* + * Whose it is, as well as what it is. + * + * `provider` is the server a token was minted for: `storeMcpToken` sets it to the server id and + * is the only way the plugins screen makes one. Without this, any `mcp` row in the vault could + * be attached to any server, and since the refresh spends it against that server's address, a + * token given to one vendor was deliverable to another. Reading a credential back is otherwise + * impossible by design, so this closes the one field that accepts a reference to a secret rather + * than the secret itself. + */ + if (named?.kind !== kind || named.provider !== serverId) { + throw new CustomServerRefusedError( + "That is not a credential this server can use. Add the server's own token instead.", + ); + } } async function requireServer(serverId: string) { @@ -598,6 +1490,27 @@ export function createPluginStore(options: PluginStoreOptions) { const resolved = resolveServerUrl(input.key, input.instanceHost); if (!resolved) throw new CatalogueEntryUnknownError(input.key); + /* + * The pointer is checked here for the same reason it is on the path below: the refresh that + * runs before this returns dereferences whatever it names. + * + * What that reaches is narrower on this path, because the URL is the catalogue's rather than + * the caller's, so a credential cannot be delivered to an address somebody chose. That is a + * property of today's catalogue rather than of this function: the one entry it holds is + * `user-oauth`, and the catalogue's own comment invites a fork to re-add the vendors that were + * taken out. The first `deployment-bearer` entry restores the full shape, so the check belongs + * here now rather than in the review that re-adds one. + */ + const credentialId = input.credentialId?.trim() || undefined; + if (credentialId) { + await requireCredentialOfKind( + resolved.entry.title, + resolved.entry.key, + credentialId, + serverCredentialKind(resolved.entry), + ); + } + await database .insert(mcpServers) .values({ @@ -605,14 +1518,24 @@ export function createPluginStore(options: PluginStoreOptions) { title: resolved.entry.title, vendor: resolved.entry.vendor, url: resolved.url, - credentialId: input.credentialId ?? null, + credentialId: credentialId ?? null, addedBy: input.by, }) .onConflictDoUpdate({ target: mcpServers.id, set: { url: resolved.url, - credentialId: input.credentialId ?? null, + /* + * Left alone when the caller sends none, rather than cleared. + * + * `registerOAuthClient` keeps the client it minted in this column, and adding the server + * again to change an instance host is not a statement about that client. Clearing it + * orphaned the credential row, which nothing then revokes, and told everybody who had + * connected that the deployment has no OAuth client registered. There is no longer a way + * to hand it back through this call either, since a `user-oauth` entry now refuses a + * credential id, so the pointer has to survive here. + */ + ...(credentialId ? { credentialId } : {}), addedBy: input.by, updatedAt: new Date(), }, @@ -691,30 +1614,51 @@ export function createPluginStore(options: PluginStoreOptions) { * One message for both "wrong kind" and "no such credential", deliberately. A caller who can * tell those apart can ask this endpoint which credential ids are real. */ + /* + * A credential is spent at the address it was given to, or not spent. + * + * Adding a server that is already here rewrites its URL, and the refresh that follows sends + * whatever credential it holds to the new one, in the same call. That is the same disclosure + * as naming another server's token and it needs no trick at all: the token really does belong + * to this server, and only the address moved. A check on whose credential it is cannot see it, + * which is why this rule is here and not folded into that one. + * + * Refused rather than repaired, because the two harmless readings of the request are both + * served by something else. Correcting a title or retrying an interrupted add sends the same + * URL and is unaffected, and genuinely moving a server means the vendor is at a new address, + * where the honest act is to remove it and add it again with the token that address is + * supposed to hold. + * + * Only this path. A curated server's URL comes from the catalogue rather than the request, so + * the most a caller can influence is an instance hostname, and that is matched against the + * vendor's own anchored pattern before anything is stored. Re-adding one cannot point it at an + * address of the caller's choosing, which is the whole of what this refuses. + */ const credentialId = input.credentialId?.trim() || undefined; + const [existing] = await database + .select({ url: mcpServers.url, credentialId: mcpServers.credentialId }) + .from(mcpServers) + .where(eq(mcpServers.id, input.id)); + + if ( + existing && + existing.url !== input.url && + (existing.credentialId || credentialId) + ) { + throw new CustomServerRefusedError( + `${input.id} is already here at a different address and holds a credential. Remove it and add it again, with the token the new address is meant to have.`, + ); + } + if (credentialId) { - /* - * The shape is checked before the lookup because `credentials.id` is a `uuid` column, so a - * value that is not one makes the query itself fail rather than return no rows, and the - * caller gets a database error where a refusal belongs. The same was true of the foreign key - * before this guard existed. - */ - const looksLikeId = - /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test( - credentialId, - ); - const [named] = looksLikeId - ? await database - .select({ kind: credentialRows.kind }) - .from(credentialRows) - .where(eq(credentialRows.id, credentialId)) - : []; - - if (named?.kind !== "mcp") { - throw new CustomServerRefusedError( - "That is not a credential this server can use. Add the server's own token instead.", - ); - } + // Always `mcp`: a server added by URL is reached with the one token the deployment holds for + // it, whatever the vendor is, because nothing here knows the vendor. + await requireCredentialOfKind( + input.title, + input.id, + credentialId, + "mcp", + ); } await database @@ -733,7 +1677,21 @@ export function createPluginStore(options: PluginStoreOptions) { set: { title: input.title, url: input.url, - credentialId: credentialId ?? null, + /* + * Kept when the caller names none, rather than cleared, for a reason beyond tidiness. + * + * Clearing it left the credential live with nothing pointing at it, and `removeServer` + * retires a token by reading it off the row: with the pointer gone it revoked nothing + * and deleted the server, so the token outlived the server it was minted for. It could + * then be attached to a freshly created server at any address, because the rule above + * compares against a row that no longer existed. Three ordinary acts, and the address + * this server was entrusted to stopped meaning anything. + * + * So the pointer survives, `removeServer` finds it, and a removed server's token is + * dead rather than loose. Detaching a token without removing the server is not a thing + * this endpoint does, and nothing asks it to. + */ + ...(credentialId ? { credentialId } : {}), addedBy: input.by, updatedAt: new Date(), }, @@ -763,19 +1721,26 @@ export function createPluginStore(options: PluginStoreOptions) { }, /** - * Remove a server, and stop its token being live. + * Remove a server, and stop every secret it was reached with being live. + * + * TWO KINDS OF SECRET, and both have to go. The server's own credential is whatever + * `mcp_servers.credential_id` names — a `mcp` bearer token an administrator added, or, for a + * `user-oauth` vendor, the deployment's OAuth client, keyed `oauth-client-<serverId>`. Nothing + * else revokes it, so leaving it behind means re-adding the same server meets its own abandoned + * row on `credentials_active_key_idx`. + * + * The other kind is every PERSON'S grant for this server, keyed `mcp_user_token` on the server id. + * `mcp_user_credentials` cascades on the server row, so removing the connector used to delete + * every pointer and leave every refresh token live and unreferenced: reachable from no screen, + * revoked by no operation, and still a usable grant at the vendor. "We removed the connector" has + * to be true of the thing that matters, which is the token sitting at the vendor. * - * The token is keyed `mcp-<serverId>` and nothing else revokes it, so - * leaving it behind means re-adding the same server meets its own - * abandoned row on `credentials_active_key_idx`. It is revoked rather - * than deleted, because the vault keeps revoked rows for audit. + * Revoked rather than deleted, because the vault keeps revoked rows for audit. * - * The revoke goes first. These are two writes on two tables and the - * store exposes no transaction that spans both, so the order decides - * what a failure between them leaves: revoke-then-delete leaves a server - * whose token no longer works and which removing again will finish off, - * while delete-then-revoke leaves a live token no server references and - * no operation can reach. + * The revokes go first. These are writes on two tables and the store exposes no transaction that + * spans both, so the order decides what a failure between them leaves: revoke-then-delete leaves + * a server whose secrets no longer work and which removing again will finish off, while + * delete-then-revoke leaves live secrets no server references and no operation can reach. */ async removeServer(serverId: string, by: string): Promise<void> { const [existing] = await database @@ -819,6 +1784,50 @@ export function createPluginStore(options: PluginStoreOptions) { }); } + /* + * Every person's grant for this server, read out of the VAULT rather than through the join + * table. + * + * `credentials.provider` holds the server id for an `mcp_user_token`, so the vault can be asked + * directly — which matters because the join row is the thing about to be cascaded away, and a + * grant whose pointer has already gone (a person removed earlier) would otherwise be invisible + * here too. The same argument `retireConnectionsFor` makes from the other direction. + */ + const held = await database + .select({ id: credentialRows.id, keyId: credentialRows.keyId }) + .from(credentialRows) + .where( + and( + eq(credentialRows.kind, "mcp_user_token"), + eq(credentialRows.provider, serverId), + isNull(credentialRows.revokedAt), + ), + ) + .orderBy(asc(credentialRows.keyId)); + + for (const grant of held) { + await credentials.revoke(grant.id); + await recordAuditEvent(auditStore, { + eventType: "mcp.account_disconnected", + targetType: "mcp_server", + targetId: serverId, + payload: { + actor: by, + server: serverId, + // Whose it was. `key_id` holds the user id for this kind, and it is the only place left + // to read it from once the join row has been cascaded away. + owner: grant.keyId, + /* + * Not "they disconnected" and not "they were removed": an administrator took the whole + * connector away, and the person did nothing. An auditor asking what happened to their + * access should see which of the three this was. + */ + reason: "mcp_server_removed", + vendorRevoked: false, + }, + }); + } + await database.delete(mcpServers).where(eq(mcpServers.id, serverId)); await recordAuditEvent(auditStore, { eventType: "configuration.changed", @@ -938,6 +1947,34 @@ export function createPluginStore(options: PluginStoreOptions) { }); } + /* + * Tools the vendor advertises that this deployment's write list does not name. + * + * The mechanical half of the reconciliation Notion's catalogue entry says is required. See + * {@link unlistedAdvertisedTools} for why only that shape of vendor is named here: an + * advertised tool absent from `writeTools` classifies as a READ, so an under-inclusive list + * is silent, and for a vendor with no scope strings there is nothing else standing behind it. + * + * `configuration.changed` rather than a type of its own, the same as the stranded grants + * above and for the same reason: nothing was denied and the refresh succeeded. What changed + * is that the deployment now knows a name it had not classified. + */ + const unlisted = unlistedAdvertisedTools(entry, [...advertised]); + if (unlisted.length > 0) { + await recordAuditEvent(auditStore, { + eventType: "configuration.changed", + targetType: "mcp_server", + targetId: serverId, + payload: { + actor: actorId, + change: "unlisted_tools_advertised", + server: serverId, + tools: unlisted, + note: "Advertised by this server and not named in its reviewed write list, so each is offered to models as a read. This vendor has no read-only scope behind that list, so anything here that writes should be added to the entry.", + }, + }); + } + return { tools: tools.length }; } catch (error) { const message = @@ -950,7 +1987,17 @@ export function createPluginStore(options: PluginStoreOptions) { // unreachable is not a reason to revoke what Bots are using. await database .update(mcpServers) - .set({ lastError: message, updatedAt: new Date() }) + .set({ + /* + * Capped at the same 400 characters `callTool` caps its recorded failure at. + * + * Parts of this sentence come from a vendor, and it is drawn on the admin page — neither + * is a promise about length, and the two paths that show a vendor's words to an operator + * should not disagree about how much of them to keep. + */ + lastError: message.slice(0, 400), + updatedAt: new Date(), + }) .where(eq(mcpServers.id, serverId)); return { tools: 0 }; } @@ -998,6 +2045,9 @@ export function createPluginStore(options: PluginStoreOptions) { toolsRefreshedAt: iso(row.toolsRefreshedAt), lastError: row.lastError, addedBy: row.addedBy, + dynamicClient: + entry?.auth.kind === "user-oauth" && + entry.auth.clientRegistration === "dynamic", tools: tools .filter((tool) => tool.serverId === row.id) .map((tool) => { @@ -1339,81 +2389,99 @@ export function createPluginStore(options: PluginStoreOptions) { /** * Register the deployment's OAuth client for a `user-oauth` server. * - * Both halves go into one encrypted value, so a single vault read yields a usable client. The id - * is copied into `metadata` as well — it is not a secret, and a page listing what the deployment - * holds should be able to name it without decrypting anything. + * An administrator pasting in what they created at the vendor. The work itself is + * {@link persistOAuthClient}, which self-registration goes through too — one path, so a client + * this deployment issued itself is stored, revoked and recorded exactly like a pasted one. + */ + registerOAuthClient: persistOAuthClient, + + /** + * The client to send somebody to the vendor with, registering one first if that is this + * vendor's way of getting one. + * + * A dynamically registered client is not paperwork anybody did: there is no console entry to + * paste, so "none yet" is the ordinary state of a server nobody has connected — and the answer + * is for the deployment to introduce itself, which is what it would have to do eventually + * anyway. Where an administrator registers by hand instead, and where the deployment has no + * public URL to be sent back to, the answer stays null: inventing a client at a vendor that + * never offered to issue one, or registering a redirect URI that resolves to nothing, would + * both leave behind a client that can never complete a consent flow. + * + * ONE CLIENT PER DEPLOYMENT EVEN WHEN TWO PEOPLE ASK AT ONCE. This is `requireUser`'s handler, so + * two first connects racing is the ordinary first hour of a connector. Registering twice is not + * merely wasteful: the loser's consent screen names a client the vault no longer holds, so that + * person consents and their callback then redeems the code against the client that replaced it — + * a connect that fails after the vendor already said yes. So the registration happens under + * {@link withOAuthClientLock}, with the "do we hold one" question asked AGAIN inside it, and the + * second caller finds the first one's client and is handed the same one. * - * Replacing a client revokes the previous one rather than orphaning it, so "what does this - * deployment hold" keeps having one answer per server. Nobody's connection breaks: a refresh - * token is the person's, and it is the client that is being rotated underneath it. + * The lock is held across the registration request to the vendor, deliberately. It is one round + * trip with its own timeout, and a lock released before it would serialise nothing. */ - async registerOAuthClient(input: { - serverId: string; - client: OAuthClient; - by: string; - }): Promise<void> { - const { row, entry } = await requireServer(input.serverId); - if (entry?.auth.kind !== "user-oauth") { - throw new CustomServerRefusedError( - `${input.serverId} is not reached with an OAuth client.`, - ); + async ensureOAuthClient( + serverId: string, + by: string, + ): Promise<OAuthClient | null> { + const stored = await storedOAuthClient(serverId); + if (stored) return stored; + + const { entry } = await requireServer(serverId); + if ( + entry?.auth.kind !== "user-oauth" || + entry.auth.clientRegistration !== "dynamic" || + !entry.auth.registrationUrl || + !options.redirectUri + ) { + return null; } + // Held before the lock, because narrowing does not survive into the closure below. + const { registrationUrl } = entry.auth; + const { redirectUri } = options; - const key = { - kind: "mcp_oauth_client" as const, - provider: input.serverId, - keyId: `oauth-client-${input.serverId}`, - }; - const value = { - ...key, - metadata: { server: input.serverId, clientId: input.client.clientId }, - encryptedValue: await encryptSecret( - encryptionKey, - JSON.stringify(input.client), - ), - }; - - /* - * Re-registering a client replaces the one before it, in one transaction. - * - * A key holds at most one live credential, so inserting a second for this server would be - * refused by `credentials_active_key_idx` rather than leaving the orphan it used to leave. - * The question is asked of the key and not of `row.credentialId`, because the server row keeps - * naming a credential an administrator has revoked from the Credentials page: the pointer can - * be stale where the key is not, and it is the key the index constrains. - */ - const live = await credentials.findLiveByKey(key); - const stored = live - ? await credentials.rotate({ ...value, previousCredentialId: live.id }) - : await credentials.create(value); + const outcome = await withOAuthClientLock( + serverId, + async (transaction) => { + /* + * Asked again, under the lock. The read above was a fast path taken without one, and by now + * the caller we were racing has committed a client of its own — which is the one this + * deployment holds, so it is the one to consent against. + */ + const held = await heldOAuthClient(transaction, serverId); + if (held) return { client: held, registered: false, replaced: false }; - await database - .update(mcpServers) - .set({ credentialId: stored.id, updatedAt: new Date() }) - .where(eq(mcpServers.id, input.serverId)); + const registered = await registerClient({ + registrationUrl, + redirectUri, + }); + if (!registered) return null; - await recordAuditEvent(auditStore, { - eventType: "mcp.oauth_client_registered", - targetType: "mcp_server", - targetId: input.serverId, - payload: { - actor: input.by, - server: input.serverId, - // The id, never the secret. It identifies the client an administrator registered, which is - // what somebody reading the trail needs in order to check it against the vendor's console. - clientId: input.client.clientId, - replaced: row.credentialId !== null, + const { replaced } = await writeOAuthClient( + { serverId, client: registered }, + transaction, + ); + return { client: registered, registered: true, replaced }; }, - }); + ); + + if (!outcome) return null; + // Only what this call actually did. A trail row for handing back somebody else's client would + // claim a registration that never happened. + if (outcome.registered) { + await recordClientRegistered( + { serverId, client: outcome.client, by }, + outcome.replaced, + ); + } + return outcome.client; }, /** * Record that one person connected their own account to one server. * - * Upserted on the pair, so reconnecting replaces rather than accumulating. The credential the row - * used to point at is revoked in the same breath: a refresh token nothing points at is still a - * live grant at the vendor, and leaving it behind would mean a person who reconnected had two - * valid grants and could only ever see one of them to disconnect it. + * The credential swap is {@link swapUserCredential}, and this is its only caller: a person + * connecting or reconnecting is exactly when there is an older grant to revoke. Rotation writes + * the same connection in place instead ({@link rotateConnectionToken}). What is only here is the + * audit row: this one IS somebody's act, and the trail should say so. */ async recordConnection(input: { serverId: string; @@ -1421,56 +2489,7 @@ export function createPluginStore(options: PluginStoreOptions) { refreshToken: string; scope: string; }): Promise<void> { - const [previous] = await database - .select({ credentialId: mcpUserCredentials.credentialId }) - .from(mcpUserCredentials) - .where( - and( - eq(mcpUserCredentials.serverId, input.serverId), - eq(mcpUserCredentials.userId, input.userId), - ), - ) - .limit(1); - - const key = { - kind: "mcp_user_token" as const, - provider: input.serverId, - keyId: input.userId, - }; - /* - * Reconnecting replaces this person's token for this server, in one transaction. - * - * `credentials_active_key_idx` holds one live credential per key, so a second insert for the - * same person and server would be refused. Asked of the key rather than of `previous`, because - * the connection row can name a credential that has already been revoked while the key itself - * is free, and it is the key the index constrains. - */ - const live = await credentials.findLiveByKey(key); - const value = { - ...key, - metadata: { server: input.serverId, scope: input.scope }, - encryptedValue: await encryptSecret(encryptionKey, input.refreshToken), - }; - const stored = live - ? await credentials.rotate({ ...value, previousCredentialId: live.id }) - : await credentials.create(value); - - await database - .insert(mcpUserCredentials) - .values({ - serverId: input.serverId, - userId: input.userId, - credentialId: stored.id, - scope: input.scope, - }) - .onConflictDoUpdate({ - target: [mcpUserCredentials.serverId, mcpUserCredentials.userId], - set: { - credentialId: stored.id, - scope: input.scope, - updatedAt: new Date(), - }, - }); + const { replaced } = await swapUserCredential(input); await recordAuditEvent(auditStore, { eventType: "mcp.account_connected", @@ -1481,7 +2500,7 @@ export function createPluginStore(options: PluginStoreOptions) { server: input.serverId, // What the vendor granted, so a later refusal for want of a scope can be explained. scope: input.scope, - reconnected: previous !== undefined, + reconnected: replaced, }, }); }, @@ -1489,32 +2508,9 @@ export function createPluginStore(options: PluginStoreOptions) { /** * The deployment's OAuth client for a server, or null if none is registered. * - * Decrypted, because both halves are needed: the id to build a consent URL and the secret to - * redeem the code it comes back with. Held for the length of one request, like every other - * secret this module reads. + * Reads only. {@link ensureOAuthClient} is the one that will go and get one. */ - async oauthClientFor(serverId: string): Promise<OAuthClient | null> { - const [row] = await database - .select({ credentialId: mcpServers.credentialId }) - .from(mcpServers) - .where(eq(mcpServers.id, serverId)) - .limit(1); - if (!row?.credentialId) return null; - - try { - return JSON.parse( - await decryptCredentialForUse( - encryptionKey, - credentials, - row.credentialId, - ), - ) as OAuthClient; - } catch { - // A revoked, missing or unreadable client is the same as none for every caller: there is - // nothing to send anybody to consent with, and the answer is for an administrator to add one. - return null; - } - }, + oauthClientFor: storedOAuthClient, /** Which `user-oauth` servers this person has connected, for their own settings page. */ async connectionsFor( @@ -1841,6 +2837,9 @@ export function createPluginStore(options: PluginStoreOptions) { * that the failure now exists in the trail, which is where somebody asking "is this connector * working" looks. The vendor's own sentence is kept, since for a 403 that is the sentence * naming which API is not enabled. + * + * Capped like the `isError` branch above, and for the same reason: parts of this sentence + * came from the vendor, and a failure is not a promise about length. */ await recordAuditEvent(auditStore, { eventType: "mcp.call_failed", @@ -1848,7 +2847,10 @@ export function createPluginStore(options: PluginStoreOptions) { targetId: input.ref, payload: { ...decided, - failure: error instanceof Error ? error.message : String(error), + failure: (error instanceof Error + ? error.message + : String(error) + ).slice(0, 400), }, }); throw error; diff --git a/server/src/work/culler.ts b/server/src/work/culler.ts new file mode 100644 index 00000000..4ceab968 --- /dev/null +++ b/server/src/work/culler.ts @@ -0,0 +1,229 @@ +/** + * Suspending computers nobody is using. + * + * A `Sandbox` has `shutdownTime`, an absolute expiry, which is not the question anybody is asking: + * "nobody has touched this for thirty minutes" is. So this asks that one, and it has to survive the + * replica that started it, which is why the work is claimed and leased out of PostgreSQL rather than + * held in a timer. + * + * NOTHING HERE TOUCHES A BROWSER. Deciding whether a computer is idle by dialling it would wake the + * computer, so every idle Bot anything asked about would come back up and the bill would never fall. + * That is the known, invisible way to lose scale-to-zero: everything works, nothing ever suspends. + * Idleness is read from the audit trail, which is a record of what a Bot did rather than a question + * put to the thing that did it. + */ +import { and, inArray, like, sql } from "drizzle-orm"; +import type { ComputerProvider } from "../computer/provider"; +import type { Database } from "../db/client"; +import { auditEvents } from "../db/schema"; +import { DEFAULT_MAX_ATTEMPTS, type WorkQueue } from "./queue"; + +export const CULL_KIND = "computer.suspend"; + +export type CullerOptions = { + database: Database; + queue: WorkQueue; + provider: ComputerProvider; + /** A computer untouched for this long is idle. */ + idleAfterMs: number; + /** Who this replica is, for the lease. */ + owner: string; + leaseMs?: number; + /** How many goes an item gets before it stops being offered. */ + maxAttempts?: number; + now?: () => Date; +}; + +export type CullReport = { + considered: number; + suspended: string[]; + skipped: { botId: string; reason: string }[]; +}; + +/** + * Which Bots have a computer running, and when each was last asked to do anything. + * + * The audit trail is the source: every acting call writes a row before the computer is touched, so + * "last used" is already recorded, server-side, and survives a restart. A computer that has never + * acted has no row and reads as idle since it started, which is the answer wanted. + */ +async function lastActedAt( + database: Database, + botIds: string[], +): Promise<Map<string, Date>> { + if (botIds.length === 0) return new Map(); + /* + * The Bot is in the payload rather than in a column, so the grouping key is an expression. Written + * through the query builder rather than as one raw string, because a list parameter has to be + * bound as a list: handed to `= any($1)` as a JavaScript array it arrives as one opaque value and + * the query fails rather than matching nothing, which at least says so. + */ + const bot = sql<string>`${auditEvents.payload}->>'bot'`; + const rows = await database + .select({ bot, last: sql<string>`max(${auditEvents.createdAt})` }) + .from(auditEvents) + .where(and(like(auditEvents.eventType, "computer.%"), inArray(bot, botIds))) + .groupBy(bot); + + return new Map( + rows + .filter((row) => row.bot) + .map((row) => [row.bot, new Date(row.last)] as const), + ); +} + +/** + * Offer every idle computer for suspension. + * + * Offering rather than suspending: the decision and the act are separated so that whichever replica + * runs this does not have to be the one that carries it out, and so a suspension that fails halfway + * is retried by whoever picks the item up next rather than lost with the process that noticed. + */ +export async function offerIdleComputers( + options: CullerOptions, +): Promise<{ offered: string[] }> { + const now = options.now?.() ?? new Date(); + const computers = await options.provider.list(); + const running = computers.filter((computer) => computer.status === "running"); + const used = await lastActedAt( + options.database, + running.map((computer) => computer.botId), + ); + + const offered: string[] = []; + for (const computer of running) { + const since = + used.get(computer.botId) ?? + (computer.startedAt ? new Date(computer.startedAt) : undefined); + // No row and no start time means nothing is known about it, and suspending on no evidence is + // how somebody's session disappears mid-task. Left alone. + if (!since) continue; + if (now.getTime() - since.getTime() < options.idleAfterMs) continue; + await options.queue.offer({ + kind: CULL_KIND, + key: computer.botId, + payload: { botId: computer.botId, idleSince: since.toISOString() }, + }); + offered.push(computer.botId); + } + return { offered }; +} + +/** + * Carry out whatever suspensions this replica can claim. + * + * Re-checked at the moment of acting, because the decision was made by another replica at another + * time and a person may have started working in between. Suspending a computer somebody is using is + * worse than leaving an idle one running for another five minutes. + */ +export async function suspendClaimedComputers( + options: CullerOptions, +): Promise<CullReport> { + const leaseMs = options.leaseMs ?? 60_000; + const claimed = await options.queue.claim({ + kind: CULL_KIND, + owner: options.owner, + leaseMs, + limit: 20, + ...(options.maxAttempts === undefined + ? {} + : { maxAttempts: options.maxAttempts }), + }); + + const report: CullReport = { + considered: claimed.length, + suspended: [], + skipped: [], + }; + + for (const item of claimed) { + const botId = String(item.payload.botId ?? item.key); + /* + * Renewed before each one, because the batch is twenty and the lease is one. + * + * Twenty suspensions is twenty calls to an API server, and nothing renewed while they ran: on a + * slow cluster the lease expired part-way down the list and another replica claimed the tail + * this one was still working through. A lease nobody renews is a timer, and a timer is what this + * queue exists not to be. + * + * False means it is already somebody else's. Stopping is then the correct answer, not an error: + * the item is being handled, just not here. + */ + if ( + !(await options.queue.renew({ + kind: CULL_KIND, + key: item.key, + owner: options.owner, + leaseMs, + })) + ) { + report.skipped.push({ + botId, + reason: "the lease went to another replica", + }); + continue; + } + try { + const now = options.now?.() ?? new Date(); + const used = await lastActedAt(options.database, [botId]); + const since = used.get(botId); + if (since && now.getTime() - since.getTime() < options.idleAfterMs) { + // Somebody came back. Drop the item rather than releasing it, because the next sweep will + // offer it again if it goes quiet, and a released one would just be reclaimed and re-checked. + await options.queue.finish({ + kind: CULL_KIND, + key: item.key, + owner: options.owner, + }); + report.skipped.push({ + botId, + reason: "used again before it was suspended", + }); + continue; + } + + await options.provider.stop(botId); + await options.queue.finish({ + kind: CULL_KIND, + key: item.key, + owner: options.owner, + }); + report.suspended.push(botId); + } catch (error) { + /* + * Released rather than dropped, and pushed out rather than retried immediately: a cluster that + * refused this once will probably refuse it again in the next second, and a computer left + * running costs money rather than losing anything. + */ + const reason = + error instanceof Error ? error.message : "could not be suspended"; + await options.queue.release({ + kind: CULL_KIND, + key: item.key, + owner: options.owner, + delayMs: 5 * 60_000, + reason, + }); + /* + * Said out loud when it gives up, because otherwise it stops silently. + * + * At the cap the item is no longer claimed, so this loop simply never sees that Bot again and + * every sweep looks clean while one computer stays awake indefinitely. The row carries the + * count and the reason for anybody who queries it; this is for the person reading the logs. + */ + if (item.attempts >= (options.maxAttempts ?? DEFAULT_MAX_ATTEMPTS)) { + console.warn( + JSON.stringify({ + type: "computer-cull-gave-up", + botId, + attempts: item.attempts, + reason, + }), + ); + } + report.skipped.push({ botId, reason }); + } + } + + return report; +} diff --git a/server/src/work/queue.ts b/server/src/work/queue.ts new file mode 100644 index 00000000..ce30b41b --- /dev/null +++ b/server/src/work/queue.ts @@ -0,0 +1,286 @@ +/** + * Claiming durable work, so several replicas can share it without a coordinator. + * + * `select ... for update skip locked` inside a transaction: each replica takes rows nobody else + * holds and never waits behind another's. No leader election, no single point of failure, and a + * replica added is throughput added rather than contention added. + * + * A claim carries a lease. While the work runs its owner renews; one that stops being renewed is + * free again the moment anything looks, so recovery needs no process to notice a death, only the + * next claim to read the clock. + * + * WHOSE CLOCK. The database's, everywhere, and this is the load-bearing part. Leases used to be + * computed as `Date.now() + leaseMs` on the replica and compared against `now()` in Postgres, which + * is two clocks pretending to be one: a node ninety seconds behind wrote a sixty-second lease that + * Postgres considered expired on arrival, and the next replica to look took the item straight out + * from under the first. Both then ran it. Every time this file names a moment it names it in SQL. + */ +import { and, eq, gte, isNull, lt, or, sql } from "drizzle-orm"; +import type { Database } from "../db/client"; +import { workItems } from "../db/schema"; + +export type WorkItem = { + kind: string; + key: string; + payload: Record<string, unknown>; + /** + * How many times this has been handed out, including now. + * + * ONE MEANS IT HAS CERTAINLY NOT RUN. More than one means a previous owner stopped renewing, and + * may already have called a tool or spent money before it did. A caller that cannot tell those + * apart cannot safely retry anything with an outside effect, so this is a number rather than a + * state folded into failure. + */ + attempts: number; +}; + +/** + * How many times one item may be handed out before it stops being offered. + * + * Without a cap a permanently failing item is retried until somebody notices, which on a queue with + * no dashboard is never. At the cap it stops being claimed and stays in the table with its count and + * its last error, which is a terminal state a person can query rather than a silence. + */ +export const DEFAULT_MAX_ATTEMPTS = 5; + +export type WorkQueue = { + /** Put work on the queue, or leave what is there. Idempotent on (kind, key). */ + offer: (item: { + kind: string; + key: string; + payload?: Record<string, unknown>; + runAt?: Date; + }) => Promise<void>; + /** Take up to `limit` due items, leased to `owner`. */ + claim: (input: { + kind: string; + owner: string; + leaseMs: number; + limit?: number; + maxAttempts?: number; + }) => Promise<WorkItem[]>; + /** Keep a claim alive while the work runs. False means it was already taken away. */ + renew: (input: { + kind: string; + key: string; + owner: string; + leaseMs: number; + }) => Promise<boolean>; + /** + * Done. False means the lease had already gone to somebody else, so this was not ours to finish. + */ + finish: (input: { + kind: string; + key: string; + owner: string; + }) => Promise<boolean>; + /** Not done, and worth another go after `delayMs`. False means it was no longer ours. */ + release: (input: { + kind: string; + key: string; + owner: string; + delayMs: number; + reason?: string; + }) => Promise<boolean>; + /** + * Drop what is done with, older than the retention window. Returns how many went. + * + * Both kinds of done: finished, and given up on. An item at its attempt cap is not finished and was + * reaped by nothing, so its key stayed occupied for ever and the work could never be offered again. + */ + purge: (input: { + kind: string; + olderThanMs: number; + maxAttempts?: number; + }) => Promise<number>; +}; + +/** A moment `ms` from now, named in SQL so it is the database's clock and not the caller's. */ +function fromNow(ms: number) { + return sql`now() + make_interval(secs => ${ms / 1000})`; +} + +export function createWorkQueue(database: Database): WorkQueue { + /** + * Still ours, and still wanting doing. + * + * `finish` and `release` used to match on the key alone, so a replica whose lease had quietly + * expired could delete or reschedule an item another replica was in the middle of executing. Only + * `renew` got this right; all three ask the same question now. + */ + const ours = (kind: string, key: string, owner: string) => + and( + eq(workItems.kind, kind), + eq(workItems.key, key), + eq(workItems.claimedBy, owner), + isNull(workItems.finishedAt), + ); + + return { + async offer({ kind, key, payload = {}, runAt }) { + await database + .insert(workItems) + .values({ kind, key, payload, ...(runAt ? { runAt } : {}) }) + /* + * Nothing on conflict, deliberately. + * + * The key is the identity of the work, so a second offer of the same thing is the same + * thing, not a new one. For a routine the key carries the minute it was due, which is what + * makes "three replicas woke at 07:00" produce one run instead of three. A finished row + * still counts as a conflict, which is what makes that true after the run as well as during + * it. + */ + .onConflictDoNothing(); + }, + + async claim({ + kind, + owner, + leaseMs, + limit = 1, + maxAttempts = DEFAULT_MAX_ATTEMPTS, + }) { + return database.transaction(async (transaction) => { + /* + * `skip locked` is what makes this concurrent rather than merely correct. Without it a + * second replica blocks on the first replica's rows and the queue serialises; with it, it + * walks past them and takes the next free ones. + */ + const due = await transaction.execute(sql` + select "kind", "key" + from "work_items" + where "kind" = ${kind} + and "finished_at" is null + and "attempts" < ${maxAttempts} + and "run_at" <= now() + and ("lease_until" is null or "lease_until" <= now()) + order by "run_at" asc + limit ${limit} + for update skip locked + `); + + const rows = ( + Array.isArray(due) ? due : ((due as { rows?: unknown[] })?.rows ?? []) + ) as { + kind: string; + key: string; + }[]; + if (rows.length === 0) return []; + + const claimed: WorkItem[] = []; + for (const row of rows) { + const [updated] = await transaction + .update(workItems) + .set({ + claimedBy: owner, + leaseUntil: fromNow(leaseMs), + attempts: sql`${workItems.attempts} + 1`, + updatedAt: sql`now()`, + }) + .where( + and(eq(workItems.kind, row.kind), eq(workItems.key, row.key)), + ) + .returning({ + kind: workItems.kind, + key: workItems.key, + payload: workItems.payload, + attempts: workItems.attempts, + }); + if (updated) { + claimed.push({ + kind: updated.kind, + key: updated.key, + payload: (updated.payload ?? {}) as Record<string, unknown>, + attempts: updated.attempts, + }); + } + } + return claimed; + }); + }, + + async renew({ kind, key, owner, leaseMs }) { + const [renewed] = await database + .update(workItems) + .set({ leaseUntil: fromNow(leaseMs), updatedAt: sql`now()` }) + /* + * Only while still ours. A lease that expired and was taken by somebody else must not be + * renewed back out from under them, which would put two replicas on one item believing they + * each held it. + */ + .where(ours(kind, key, owner)) + .returning({ key: workItems.key }); + return Boolean(renewed); + }, + + async finish({ kind, key, owner }) { + const [finished] = await database + .update(workItems) + /* + * Marked, not deleted. The row is what a later offer of the same key collides with, and + * deleting it handed that key back to anybody who re-offered it: the recovery path was also + * a duplicate-run path. Swept later by `purge`. + */ + .set({ + finishedAt: sql`now()`, + claimedBy: null, + leaseUntil: null, + updatedAt: sql`now()`, + }) + .where(ours(kind, key, owner)) + .returning({ key: workItems.key }); + return Boolean(finished); + }, + + async release({ kind, key, owner, delayMs, reason }) { + // Freed and pushed out, rather than finished: the work still wants doing, just not immediately + // and not by whoever just gave up on it. The reason stays on the row so an item that runs out + // of attempts says why rather than simply stopping. + const [released] = await database + .update(workItems) + .set({ + claimedBy: null, + leaseUntil: null, + runAt: fromNow(delayMs), + updatedAt: sql`now()`, + ...(reason === undefined ? {} : { lastError: reason }), + }) + .where(ours(kind, key, owner)) + .returning({ key: workItems.key }); + return Boolean(released); + }, + + async purge({ kind, olderThanMs, maxAttempts = DEFAULT_MAX_ATTEMPTS }) { + const cutoff = fromNow(-olderThanMs); + const gone = await database + .delete(workItems) + .where( + and( + eq(workItems.kind, kind), + or( + lt(workItems.finishedAt, cutoff), + /* + * AND THE ONES THAT GAVE UP, which is the half this forgot. + * + * An item at its attempt cap is not finished, so it was reaped by nothing: `claim` + * skipped it, `purge` did not match it, and `offer` cannot replace a row that is still + * there. Its key was wedged for good. The culler keys on the Bot id, so five failed + * suspends meant that Bot never scaled to zero again, silently and for ever. + * + * Reaped on the same window rather than kept, because the window is also how long it + * waits before anything tries again: whatever was broken has had a day to be fixed, + * and the next sweep offers the work afresh. The audit trail is where "this failed" + * lives; this table is what still wants doing. + */ + and( + gte(workItems.attempts, maxAttempts), + lt(workItems.updatedAt, cutoff), + ), + ), + ), + ) + .returning({ key: workItems.key }); + return gone.length; + }, + }; +} diff --git a/server/tests/channel-activity.integration.test.ts b/server/tests/channel-activity.integration.test.ts index 06698aca..a592eb88 100644 --- a/server/tests/channel-activity.integration.test.ts +++ b/server/tests/channel-activity.integration.test.ts @@ -227,6 +227,8 @@ describe("channel activity", () => { lastMessageAgentId: agentId, lastMessageAt: at, createdAt: expect.any(Date), + pinned: false, + lastReadAt: null, }, ]); }); @@ -345,3 +347,99 @@ describe("channel activity", () => { ).toEqual([busy.id, quiet.id]); }); }); + +/** + * A pin holds a channel at the top of the roster, which is a claim about the roster and not about + * whichever page happens to be loaded. + * + * Ordering pinned-first only in the browser sorts the rows already fetched, so a channel somebody + * pinned and then did not talk to for a month sits on page three and never appears at the top at + * all — the roster the person sees contradicts the pin they made. The order therefore belongs in the + * query, and the cursor has to carry the pin flag as its leading element or paging walks the same + * channel twice. + */ +describe("a pinned channel in a paged roster", () => { + /** Channels with explicit, minute-apart activity, newest last, so recency order is not a clock race. */ + async function channelsWithActivity(owner: AgentActor, count: number) { + const agentId = await createAgent(owner); + const ids: string[] = []; + for (let index = 0; index < count; index += 1) { + ids.push((await createChannel(owner, [agentId])).id); + } + const base = Date.now() - count * 60_000; + for (const [index, id] of ids.entries()) { + await store.recordActivity(owner, id, { + agentId, + at: new Date(base + index * 60_000), + text: `Message ${index}`, + }); + } + return ids; + } + + /** Every channel the cursor reaches, in the order the pages hand them over. */ + async function walk(owner: AgentActor, limit: number) { + const seen: string[] = []; + let cursor: string | undefined; + for (let page = 0; page < 20; page += 1) { + const result = await store.list(owner, { + limit, + ...(cursor ? { cursor } : {}), + }); + seen.push(...result.channels.map((channel) => channel.id)); + if (!result.nextCursor) break; + cursor = result.nextCursor; + } + return seen; + } + + test("lifts a pinned channel onto the first page, however old it is", async () => { + const owner = await createUser(); + const ids = await channelsWithActivity(owner, 6); + const oldest = ids[0] as string; + + await store.setPinned(owner, oldest, true); + + // Two per page, six channels: on recency alone this one is the last row of the last page. + const page = await store.list(owner, { limit: 2 }); + expect(page.channels.map((channel) => channel.id)[0]).toBe(oldest); + }); + + test("walks every channel exactly once across pinned and unpinned", async () => { + const owner = await createUser(); + const ids = await channelsWithActivity(owner, 6); + // Two pins, chosen so the group boundary does not line up with a page boundary. + await store.setPinned(owner, ids[0] as string, true); + await store.setPinned(owner, ids[3] as string, true); + + const seen = await walk(owner, 2); + + // Pinned first, and recency within each group: the cursor has to order pages the same way the + // first page is ordered, or a channel is served twice and another never at all. + expect(seen).toEqual([ + ids[3] as string, + ids[0] as string, + ids[5] as string, + ids[4] as string, + ids[2] as string, + ids[1] as string, + ]); + expect(new Set(seen).size).toBe(seen.length); + }); + + test("unpinning puts the channel back where recency alone would have it", async () => { + const owner = await createUser(); + const ids = await channelsWithActivity(owner, 4); + const oldest = ids[0] as string; + + await store.setPinned(owner, oldest, true); + await store.setPinned(owner, oldest, false); + + expect(await walk(owner, 2)).toEqual([ + ids[3] as string, + ids[2] as string, + ids[1] as string, + oldest, + ]); + }); +}); diff --git a/server/tests/channel-events.integration.test.ts b/server/tests/channel-events.integration.test.ts index 98d93258..697217a9 100644 --- a/server/tests/channel-events.integration.test.ts +++ b/server/tests/channel-events.integration.test.ts @@ -5,17 +5,24 @@ import { createAgentProfileStore } from "../src/agents/profile-store"; import type { AgentActor } from "../src/agents/profile-types"; import { type ChannelActivityEvent, + type ChannelEventHub, createChannelEventHub, startChannelActivityListener, } from "../src/channels/events"; -import { createChannelStore } from "../src/channels/routes"; +import { + ChannelNotFoundError, + ChannelPackageOwnedError, + createChannelStore, +} from "../src/channels/routes"; import { createThreadIdentity } from "../src/channels/thread-identity"; import { createDatabase } from "../src/db/client"; import { TEST_POOL } from "./support/database"; import { agentProfiles, agents, + channelMemberships, channels, + deploymentPackages, intelligenceChannelMappings, users, } from "../src/db/schema"; @@ -103,6 +110,7 @@ const testPrefix = `channel-events-${randomUUID()}`; const createdUserIds: string[] = []; const createdAgentIds: string[] = []; const createdChannelIds: string[] = []; +const createdPackageIds: string[] = []; afterEach(async () => { for (const channelId of createdChannelIds.splice(0)) { @@ -111,6 +119,11 @@ afterEach(async () => { .where(eq(intelligenceChannelMappings.channelId, channelId)); await database.delete(channels).where(eq(channels.id, channelId)); } + for (const packageId of createdPackageIds.splice(0)) { + await database + .delete(deploymentPackages) + .where(eq(deploymentPackages.id, packageId)); + } for (const agentId of createdAgentIds.splice(0)) { await database .delete(agentProfiles) @@ -187,3 +200,264 @@ describe("channel activity delivery", () => { }); }); }); + +async function createTestUser(name: string): Promise<AgentActor> { + const id = `${testPrefix}-user-${randomUUID()}`; + await database.insert(users).values({ + id, + email: `${id}@example.test`, + name, + }); + createdUserIds.push(id); + return { id, role: "user" }; +} + +/** A channel with two members, which is what makes "who hears this" a question worth asking. */ +async function createSharedChannel(owner: AgentActor, other: AgentActor) { + const profile = await profileStore.create(owner, { + name: "Expense Manager", + title: "Finance Operations", + roleDescription: "Review receipts.", + visibility: "public", + }); + createdAgentIds.push(profile.id); + const channel = await store.create(owner, [profile.id]); + createdChannelIds.push(channel.id); + // `create` writes the creator's membership only; the second member is added directly, with the + // thread mapping the roster join requires. + await database.insert(channelMemberships).values({ + channelId: channel.id, + userId: other.id, + }); + await database.insert(intelligenceChannelMappings).values({ + userId: other.id, + channelId: channel.id, + // thread_id is globally unique, so the second member's mapping needs one of its own. + threadId: randomUUID(), + }); + return channel; +} + +/** Collect what each person's connection hears, and a promise that settles when one of them does. */ +function watch(hub: ChannelEventHub, userIds: string[]) { + const heard = new Map<string, ChannelActivityEvent[]>(); + let announce = () => {}; + const anything = new Promise<void>((resolve) => { + announce = resolve; + }); + for (const userId of userIds) { + heard.set(userId, []); + hub.register(userId, (payload) => { + heard.get(userId)?.push(JSON.parse(payload)); + announce(); + }); + } + const of = (userId: string) => heard.get(userId) ?? []; + return { of, anything }; +} + +function within5s(arrived: Promise<void>) { + return Promise.race([ + arrived, + new Promise((_, reject) => + setTimeout(() => reject(new Error("no event within 5s")), 5000), + ), + ]); +} + +/** + * Two changes a roster has to hear about that are not a message: a channel that is gone, and a pin. + * + * They differ in who is owed the news. A deletion hides the channel for everybody in it, so every + * member's tabs need telling; a pin belongs to one member's own membership row, so telling anybody + * else would show them a pin they did not make. + */ +describe("channel change delivery", () => { + test("announces a deleted channel to every member, exactly once", async () => { + const owner = await createTestUser("Deleting Member"); + const other = await createTestUser("Other Member"); + const channel = await createSharedChannel(owner, other); + + const hub = createChannelEventHub(); + const watched = watch(hub, [owner.id, other.id]); + const listener = await startChannelActivityListener(databaseUrl, hub); + + try { + await store.softDelete(owner, channel.id); + await within5s(watched.anything); + } finally { + await listener.stop(); + } + + // One announcement, heard by both members: a soft delete hides the row for everyone in it. + expect(watched.of(owner.id)).toHaveLength(1); + expect(watched.of(other.id)).toHaveLength(1); + expect(watched.of(owner.id)[0]).toMatchObject({ + channelId: channel.id, + deleted: true, + }); + expect(watched.of(owner.id)[0]?.memberIds?.sort()).toEqual( + [owner.id, other.id].sort(), + ); + }); + + test("announces nothing for a delete the deployment package refuses", async () => { + const owner = await createTestUser("Refused Member"); + const [deploymentPackage] = await database + .insert(deploymentPackages) + .values({ + tenantId: `${testPrefix}-tenant-${randomUUID()}`, + sourcePath: "/tmp/none", + checksum: "0", + }) + .returning({ id: deploymentPackages.id }); + if (!deploymentPackage) throw new Error("package row was not created"); + createdPackageIds.push(deploymentPackage.id); + const channelId = `${testPrefix}-package-channel-${randomUUID()}`; + await database.insert(channels).values({ + id: channelId, + name: "Package channel", + description: "Defined by the tenant package.", + packageId: deploymentPackage.id, + }); + createdChannelIds.push(channelId); + await database + .insert(channelMemberships) + .values({ channelId, userId: owner.id }); + + const hub = createChannelEventHub(); + const watched = watch(hub, [owner.id]); + const listener = await startChannelActivityListener(databaseUrl, hub); + + try { + await expect(store.softDelete(owner, channelId)).rejects.toBeInstanceOf( + ChannelPackageOwnedError, + ); + // The refusal rolls the transaction back, so there is nothing to wait for. A window long + // enough for a notify that did happen to arrive is what makes the empty assertion mean + // something. + await new Promise((resolve) => setTimeout(resolve, 500)); + } finally { + await listener.stop(); + } + + // The channel is still there for everybody, so telling a roster it is gone would be a lie. + expect(watched.of(owner.id)).toEqual([]); + }); + + test("tells the pinning member's own tabs and nobody else's", async () => { + const owner = await createTestUser("Pinning Member"); + const other = await createTestUser("Other Member"); + const channel = await createSharedChannel(owner, other); + + const hub = createChannelEventHub(); + const watched = watch(hub, [owner.id, other.id]); + const listener = await startChannelActivityListener(databaseUrl, hub); + + try { + await store.setPinned(owner, channel.id, true); + await within5s(watched.anything); + } finally { + await listener.stop(); + } + + expect(watched.of(owner.id)).toHaveLength(1); + expect(watched.of(owner.id)[0]).toMatchObject({ + channelId: channel.id, + pinned: true, + memberIds: [owner.id], + }); + /* + * The half worth having a test for. A pin lives on one membership row, and the hub delivers by + * `memberIds`, so naming anybody else here would put a pin on their roster that they did not + * make. Both members are watching the same hub through the same notify, so an event that + * included the other member would already be in this array. + */ + expect(watched.of(other.id)).toEqual([]); + }); + + /* + * A write refused because the channel is deleted announces nothing either. + * + * The listener is attached after the delete, so the delete's own announcement is not what these + * observe: what is being asserted is that a later report about a hidden channel is silent. A notify + * here would send every member's browser off to refetch a roster for a row it cannot show. + */ + test("announces nothing for activity reported on a deleted channel", async () => { + const owner = await createTestUser("Deleted Channel Member"); + const other = await createTestUser("Other Member"); + const channel = await createSharedChannel(owner, other); + await store.softDelete(owner, channel.id); + + const hub = createChannelEventHub(); + const watched = watch(hub, [owner.id, other.id]); + const listener = await startChannelActivityListener(databaseUrl, hub); + + try { + await expect( + store.recordActivity(owner, channel.id, { + agentId: null, + at: new Date(), + text: "Said into a channel that is gone.", + }), + ).rejects.toBeInstanceOf(ChannelNotFoundError); + // The refusal rolls back, so there is nothing to wait for; the window is what makes an empty + // assertion mean something. + await new Promise((resolve) => setTimeout(resolve, 500)); + } finally { + await listener.stop(); + } + + expect(watched.of(owner.id)).toEqual([]); + expect(watched.of(other.id)).toEqual([]); + }); + + test("announces nothing for a pin on a deleted channel", async () => { + const owner = await createTestUser("Pinning Member"); + const channel = await createSharedChannel( + owner, + await createTestUser("Other Member"), + ); + await store.softDelete(owner, channel.id); + + const hub = createChannelEventHub(); + const watched = watch(hub, [owner.id]); + const listener = await startChannelActivityListener(databaseUrl, hub); + + try { + await expect( + store.setPinned(owner, channel.id, true), + ).rejects.toBeInstanceOf(ChannelNotFoundError); + await new Promise((resolve) => setTimeout(resolve, 500)); + } finally { + await listener.stop(); + } + + expect(watched.of(owner.id)).toEqual([]); + }); + + test("announces an unpin the same way", async () => { + const owner = await createTestUser("Unpinning Member"); + const other = await createTestUser("Other Member"); + const channel = await createSharedChannel(owner, other); + await store.setPinned(owner, channel.id, true); + + const hub = createChannelEventHub(); + const watched = watch(hub, [owner.id, other.id]); + const listener = await startChannelActivityListener(databaseUrl, hub); + + try { + await store.setPinned(owner, channel.id, false); + await within5s(watched.anything); + } finally { + await listener.stop(); + } + + expect(watched.of(owner.id)).toHaveLength(1); + expect(watched.of(owner.id)[0]).toMatchObject({ + channelId: channel.id, + pinned: false, + }); + expect(watched.of(other.id)).toEqual([]); + }); +}); diff --git a/server/tests/channel-routes.test.ts b/server/tests/channel-routes.test.ts index 17906cc7..7019b1f9 100644 --- a/server/tests/channel-routes.test.ts +++ b/server/tests/channel-routes.test.ts @@ -7,7 +7,7 @@ import { test, } from "bun:test"; import { randomUUID } from "node:crypto"; -import { eq } from "drizzle-orm"; +import { and, eq } from "drizzle-orm"; import type { MiddlewareHandler } from "hono"; import { Hono } from "hono"; import { @@ -22,6 +22,7 @@ import type { AppVariables } from "../src/auth/guards"; import { type AgentChannel, ChannelNotFoundError, + ChannelPackageOwnedError, type ChannelStore, createChannelRoutes, createChannelStore, @@ -30,16 +31,17 @@ import { import { createThreadIdentity } from "../src/channels/thread-identity"; import { loadConfig } from "../src/config"; import { createDatabase } from "../src/db/client"; +import { TEST_POOL } from "./support/database"; import { agentProfiles, agents, channelAgents, channelMemberships, channels, + deploymentPackages, intelligenceChannelMappings, users, } from "../src/db/schema"; -import { TEST_POOL } from "./support/database"; import { testEnvironment } from "./support/environment"; const actor = { @@ -74,9 +76,14 @@ function fakeStore( calls.push(["get", receivedActor, id]); return channel({ id }); }, - async remove(receivedActor, id) { - calls.push(["remove", receivedActor, id]); - return "thread-1"; + async setPinned(receivedActor, id, pinned) { + calls.push(["setPinned", receivedActor, id, pinned]); + }, + async markRead(receivedActor, id) { + calls.push(["markRead", receivedActor, id]); + }, + async softDelete(receivedActor, id) { + calls.push(["softDelete", receivedActor, id]); }, }; @@ -303,155 +310,220 @@ describe("channel routes", () => { expect(response.status).toBe(599); expect(await json(response)).toEqual({ sentinel: "database disconnected" }); }); -}); -describe("channel delete route", () => { - /** Rows written by the route under test, in order. */ - let audited: AuditEventInput[] = []; + test("pins through the authenticated actor and reports the new state", async () => { + const store = fakeStore(); + const app = appFor(store); - beforeEach(() => { - audited = []; + const response = await app.request("http://openbot.test/channel-1/pin", { + method: "PUT", + headers: { "content-type": "application/json" }, + body: JSON.stringify({ pinned: true }), + }); + + expect(response.status).toBe(200); + expect(await json(response)).toEqual({ pinned: true }); + expect(store.calls).toEqual([["setPinned", actor, "channel-1", true]]); }); - function appWithForget( - store: ChannelStore, - forgetThread?: (params: { - threadId: string; - userId: string; - agentId: string; - }) => Promise<void>, - auditStore: AuditStore = { - insert: async (event) => void audited.push(event), - }, - ) { - const app = new Hono<{ Variables: AppVariables }>(); - app.route( - "/", - createChannelRoutes( - store, - requireUser, - undefined, - auditStore, - forgetThread, - ), + test.each([ + ["{", "Pin input must be a JSON object."], + [JSON.stringify([]), "Pin input must be a JSON object."], + [JSON.stringify({}), "Pinned must be true or false."], + [JSON.stringify({ pinned: "yes" }), "Pinned must be true or false."], + ])("rejects malformed pin bodies: %p", async (body, error) => { + const store = fakeStore(); + const response = await appFor(store).request( + "http://openbot.test/channel-1/pin", + { + method: "PUT", + headers: { "content-type": "application/json" }, + body, + }, ); - return app; - } - test("returns 200 and calls store.remove with the actor and channel id", async () => { + expect(response.status).toBe(400); + expect(await json(response)).toEqual({ error }); + expect(store.calls).toEqual([]); + }); + + test("keeps authentication in front of pinning", async () => { const store = fakeStore(); - const response = await appWithForget(store, async () => {}).request( - "http://openbot.test/channel-1", - { method: "DELETE" }, + const denied: MiddlewareHandler<{ Variables: AppVariables }> = (context) => + Promise.resolve(context.json({ error: "denied" }, 401)); + const app = appFor(store, denied); + + const response = await app.request("http://openbot.test/channel-1/pin", { + method: "PUT", + headers: { "content-type": "application/json" }, + body: JSON.stringify({ pinned: true }), + }); + + expect(response.status).toBe(401); + expect(store.calls).toEqual([]); + }); + + test("marks read through the authenticated actor and answers 204", async () => { + const store = fakeStore(); + const response = await appFor(store).request( + "http://openbot.test/channel-1/read", + { method: "PUT" }, ); - expect(response.status).toBe(200); - expect(await json(response)).toEqual({ historyLeftBehind: false }); - expect(store.calls).toEqual([["remove", actor, "channel-1"]]); + expect(response.status).toBe(204); + expect(store.calls).toEqual([["markRead", actor, "channel-1"]]); }); - test("maps ChannelNotFoundError to 404", async () => { + test("maps an unknown channel to 404 for marking read", async () => { const store = fakeStore({ - remove: async () => { + markRead: async () => { throw new ChannelNotFoundError("channel-1"); }, }); - const response = await appWithForget(store).request( - "http://openbot.test/channel-1", - { method: "DELETE" }, + const response = await appFor(store).request( + "http://openbot.test/channel-1/read", + { method: "PUT" }, ); expect(response.status).toBe(404); expect(await json(response)).toEqual({ error: "Channel not found." }); }); - test("calls forgetThread with the derived channel-scoped agent id", async () => { + test("keeps authentication in front of marking read", async () => { const store = fakeStore(); - const calls: unknown[] = []; - const response = await appWithForget(store, async (params) => { - calls.push(params); - }).request("http://openbot.test/channel-1", { method: "DELETE" }); + const denied: MiddlewareHandler<{ Variables: AppVariables }> = (context) => + Promise.resolve(context.json({ error: "denied" }, 401)); + const response = await appFor(store, denied).request( + "http://openbot.test/channel-1/read", + { method: "PUT" }, + ); - expect(response.status).toBe(200); - expect(calls).toEqual([ - { threadId: "thread-1", userId: actor.id, agentId: "channel:channel-1" }, - ]); + expect(response.status).toBe(401); + expect(store.calls).toEqual([]); }); - /* - * The critical ordering-decision regression test: a rejected upstream delete must not become a - * failure response. The local removal already committed by the time `forgetThread` runs, so this - * MUST fail if a later change propagates that rejection as an error status instead of swallowing - * it and still answering 204. - */ - test("still succeeds when forgetThread rejects, and says the history survived", async () => { + test("deletes through the authenticated actor and answers 204", async () => { const store = fakeStore(); - const response = await appWithForget(store, async () => { - throw new Error("Intelligence is unreachable"); - }).request("http://openbot.test/channel-1", { method: "DELETE" }); + const response = await appFor(store).request( + "http://openbot.test/channel-1", + { method: "DELETE" }, + ); - expect(response.status).toBe(200); - // The half that failed is the half a person deleting a conversation is asking about, so it has - // to reach them rather than being swallowed into an indistinguishable success. - expect(await json(response)).toEqual({ historyLeftBehind: true }); + expect(response.status).toBe(204); + expect(store.calls).toEqual([["softDelete", actor, "channel-1"]]); }); - test("does not call forgetThread when remove found no thread to forget", async () => { + test("maps a package-owned refusal to 409", async () => { const store = fakeStore({ - remove: async (receivedActor, id) => { - store.calls.push(["remove", receivedActor, id]); - return null; + softDelete: async () => { + throw new ChannelPackageOwnedError("channel-1"); }, }); - let called = false; - const response = await appWithForget(store, async () => { - called = true; - }).request("http://openbot.test/channel-1", { method: "DELETE" }); + const response = await appFor(store).request( + "http://openbot.test/channel-1", + { method: "DELETE" }, + ); - expect(response.status).toBe(200); - // Nothing to forget is not something left behind. - expect(await json(response)).toEqual({ historyLeftBehind: false }); - expect(called).toBe(false); + expect(response.status).toBe(409); + expect(await json(response)).toEqual({ + error: + "This channel is defined by the deployment package, so it cannot be deleted here.", + }); }); - /* - * The channel row is gone by the time this runs, so this row is the only thing left that says the - * conversation ever existed or who ended it. Untested, it is also the easiest thing to drop in a - * later refactor without anything going red. - */ - test("writes an attributed audit row naming the thread it forgot", async () => { + test("keeps authentication in front of deleting", async () => { const store = fakeStore(); - await appWithForget(store, async () => {}).request( + const denied: MiddlewareHandler<{ Variables: AppVariables }> = (context) => + Promise.resolve(context.json({ error: "denied" }, 401)); + const app = appFor(store, denied); + + const response = await app.request("http://openbot.test/channel-1", { + method: "DELETE", + }); + + expect(response.status).toBe(401); + expect(store.calls).toEqual([]); + }); +}); + +/** + * The channel row survives a soft delete, but nothing on it says who hid it or when. + * + * "Where did that conversation go" is the question this answers, and the row is the only thing that + * can: `deleted_at` is a timestamp with no actor. Untested, it is also the easiest thing to drop in + * a later refactor without anything going red — which is exactly how it was lost once already. + */ +describe("channel delete audit", () => { + /** Rows written by the route under test, in order. */ + let audited: AuditEventInput[] = []; + + beforeEach(() => { + audited = []; + }); + + function appWithAudit( + store: ChannelStore, + auditStore: AuditStore = { + insert: async (event) => void audited.push(event), + }, + ) { + const app = new Hono<{ Variables: AppVariables }>(); + app.route( + "/", + createChannelRoutes(store, requireUser, undefined, auditStore), + ); + return app; + } + + test("writes an attributed row naming the mechanism", async () => { + const response = await appWithAudit(fakeStore()).request( "http://openbot.test/channel-1", { method: "DELETE" }, ); + expect(response.status).toBe(204); expect(audited).toEqual([ { eventType: "channel.deleted", targetType: "channel", targetId: "channel-1", actorUserId: actor.id, - payload: { threadId: "thread-1", threadForgotten: true }, + payload: { mechanism: "soft" }, }, ]); }); - test("records a thread that outlived the channel", async () => { - const store = fakeStore(); - await appWithForget(store, async () => { - throw new Error("Intelligence is unreachable"); - }).request("http://openbot.test/channel-1", { method: "DELETE" }); + /* Same discipline as bot-lifecycle-audit.test.ts: the trail records acts, not attempts. */ + test("a refused change writes nothing", async () => { + const store = fakeStore({ + softDelete: async () => { + throw new ChannelPackageOwnedError("channel-1"); + }, + }); - expect(audited).toEqual([ - { - eventType: "channel.deleted", - targetType: "channel", - targetId: "channel-1", - actorUserId: actor.id, - payload: { threadId: "thread-1", threadForgotten: false }, + const response = await appWithAudit(store).request( + "http://openbot.test/channel-1", + { method: "DELETE" }, + ); + + expect(response.status).toBe(409); + expect(audited).toEqual([]); + }); + + test("a delete of somebody else's channel writes nothing", async () => { + const store = fakeStore({ + softDelete: async () => { + throw new ChannelNotFoundError("channel-1"); }, - ]); + }); + + const response = await appWithAudit(store).request( + "http://openbot.test/channel-1", + { method: "DELETE" }, + ); + + expect(response.status).toBe(404); + expect(audited).toEqual([]); }); /* @@ -462,19 +534,17 @@ describe("channel delete route", () => { * "by whom", which is the half worth keeping. */ test("attributes the local development actor rather than dropping it", async () => { - const store = fakeStore(); const app = new Hono<{ Variables: AppVariables }>(); app.route( "/", createChannelRoutes( - store, + fakeStore(), async (context, next) => { context.set("actor", DEV_ACTOR); await next(); }, undefined, { insert: async (event) => void audited.push(event) }, - async () => {}, ), ); @@ -484,18 +554,30 @@ describe("channel delete route", () => { }); /* - * The channel is already gone and the caller has already been told so. A trail that is briefly - * unavailable is not a reason to report a failure that did not happen. + * The channel is already hidden and the caller has already been told so by the time this runs. A + * trail that is briefly unavailable is not a reason to report a failure that did not happen. */ test("still answers when the audit write throws", async () => { - const store = fakeStore(); - const response = await appWithForget(store, async () => {}, { + const response = await appWithAudit(fakeStore(), { insert: async () => { throw new Error("audit table is unreachable"); }, }).request("http://openbot.test/channel-1", { method: "DELETE" }); - expect(response.status).toBe(200); + expect(response.status).toBe(204); + }); + + test("deletes without a trail when the deployment keeps none", async () => { + const store = fakeStore(); + const app = new Hono<{ Variables: AppVariables }>(); + app.route("/", createChannelRoutes(store, requireUser)); + + const response = await app.request("http://openbot.test/channel-1", { + method: "DELETE", + }); + + expect(response.status).toBe(204); + expect(store.calls).toEqual([["softDelete", actor, "channel-1"]]); }); }); @@ -585,6 +667,7 @@ const testPrefix = `channel-store-${randomUUID()}`; const createdUserIds: string[] = []; const createdAgentIds: string[] = []; const createdChannelIds: string[] = []; +const createdPackageIds: string[] = []; afterEach(async () => { for (const channelId of createdChannelIds.splice(0)) { @@ -593,6 +676,11 @@ afterEach(async () => { .where(eq(intelligenceChannelMappings.channelId, channelId)); await database.delete(channels).where(eq(channels.id, channelId)); } + for (const packageId of createdPackageIds.splice(0)) { + await database + .delete(deploymentPackages) + .where(eq(deploymentPackages.id, packageId)); + } for (const agentId of createdAgentIds.splice(0)) { await database .delete(agentProfiles) @@ -946,44 +1034,435 @@ describe("channel store integration", () => { expect(await channelTableSnapshot()).toEqual(before); }, ); +}); - test("deletes the channel row and cascades memberships, agents, and the thread mapping", async () => { +describe("channel pinning", () => { + test("stamps and clears pinned_at on the caller's own membership", async () => { const actor = await createPersistentUser(); const agentId = await createPersistentAgent({ - name: "Removable agent", + name: "Pinnable agent", owner: actor, }); const created = await persistentStore.create(actor, [agentId]); - // Not pushed to createdChannelIds: `remove` is the thing under test, and afterEach's cleanup - // deleting an already-deleted row is a no-op either way. + createdChannelIds.push(created.id); - const threadId = await persistentStore.remove(actor, created.id); + await persistentStore.setPinned(actor, created.id, true); + let [row] = await database + .select({ pinnedAt: channelMemberships.pinnedAt }) + .from(channelMemberships) + .where( + and( + eq(channelMemberships.channelId, created.id), + eq(channelMemberships.userId, actor.id), + ), + ); + expect(row?.pinnedAt).not.toBeNull(); + + await persistentStore.setPinned(actor, created.id, false); + [row] = await database + .select({ pinnedAt: channelMemberships.pinnedAt }) + .from(channelMemberships) + .where( + and( + eq(channelMemberships.channelId, created.id), + eq(channelMemberships.userId, actor.id), + ), + ); + expect(row?.pinnedAt).toBeNull(); + }); - expect(threadId).toBe(created.threadId); - const persisted = await persistedChannel(created.id); - expect(persisted.channelRow).toBeUndefined(); - expect(persisted.memberships).toEqual([]); - expect(persisted.linkedAgents).toEqual([]); - expect(persisted.mappings).toEqual([]); + test("refuses to pin a channel the caller is not a member of", async () => { + const member = await createPersistentUser(); + const outsider = await createPersistentUser(); + const agentId = await createPersistentAgent({ + name: "Members-only agent", + owner: member, + }); + const created = await persistentStore.create(member, [agentId]); + createdChannelIds.push(created.id); + + await expect( + persistentStore.setPinned(outsider, created.id, true), + ).rejects.toBeInstanceOf(ChannelNotFoundError); }); - test("refuses a non-member's remove and leaves the channel row untouched", async () => { - const owner = await createPersistentUser(); + test("pins and unpins through the caller's own membership", async () => { + const actor = await createPersistentUser(); + const agentId = await createPersistentAgent({ + name: "Pinnable agent", + owner: actor, + }); + const created = await persistentStore.create(actor, [agentId]); + createdChannelIds.push(created.id); + + await persistentStore.setPinned(actor, created.id, true); + let page = await persistentStore.list(actor); + expect( + page.channels.find((channel) => channel.id === created.id)?.pinned, + ).toBe(true); + + await persistentStore.setPinned(actor, created.id, false); + page = await persistentStore.list(actor); + expect( + page.channels.find((channel) => channel.id === created.id)?.pinned, + ).toBe(false); + }); + + test("one member's pin is invisible to another member", async () => { + const pinner = await createPersistentUser(); + const other = await createPersistentUser(); + const agentId = await createPersistentAgent({ + name: "Shared pinnable agent", + owner: pinner, + visibility: "public", + }); + const created = await persistentStore.create(pinner, [agentId]); + createdChannelIds.push(created.id); + // The store only creates the creator's membership; give the other user one directly, + // plus the thread mapping the list join requires. + await database.insert(channelMemberships).values({ + channelId: created.id, + userId: other.id, + }); + await database.insert(intelligenceChannelMappings).values({ + userId: other.id, + channelId: created.id, + // thread_id is globally unique; the pinner's own mapping row already claimed + // created.threadId, so the other member's row needs one of its own. + threadId: randomUUID(), + }); + + await persistentStore.setPinned(pinner, created.id, true); + + const otherPage = await persistentStore.list(other); + expect( + otherPage.channels.find((channel) => channel.id === created.id)?.pinned, + ).toBe(false); + }); + + test("reports pinned false for a channel nobody pinned", async () => { + const actor = await createPersistentUser(); + const agentId = await createPersistentAgent({ + name: "Unpinned agent", + owner: actor, + }); + const created = await persistentStore.create(actor, [agentId]); + createdChannelIds.push(created.id); + + expect( + (await persistentStore.list(actor)).channels.find( + (channel) => channel.id === created.id, + )?.pinned, + ).toBe(false); + }); +}); + +describe("channel read markers", () => { + // Two members of one channel, which is what a per-member marker has to be tested against. + async function sharedChannel() { + const reader = await createPersistentUser(); + const other = await createPersistentUser(); + const agentId = await createPersistentAgent({ + name: "Shared readable agent", + owner: reader, + visibility: "public", + }); + const created = await persistentStore.create(reader, [agentId]); + createdChannelIds.push(created.id); + // The store only creates the creator's membership; give the other user one directly, + // plus the thread mapping the list join requires. + await database.insert(channelMemberships).values({ + channelId: created.id, + userId: other.id, + }); + await database.insert(intelligenceChannelMappings).values({ + userId: other.id, + channelId: created.id, + // thread_id is globally unique; the reader's own mapping row already claimed + // created.threadId, so the other member's row needs one of its own. + threadId: randomUUID(), + }); + return { reader, other, channelId: created.id }; + } + + test("stamps last_read_at on the caller's own membership only", async () => { + const { reader, other, channelId } = await sharedChannel(); + + await persistentStore.markRead(reader, channelId); + + const rows = await database + .select({ + userId: channelMemberships.userId, + lastReadAt: channelMemberships.lastReadAt, + }) + .from(channelMemberships) + .where(eq(channelMemberships.channelId, channelId)); + expect( + rows.find((row) => row.userId === reader.id)?.lastReadAt, + ).not.toBeNull(); + expect(rows.find((row) => row.userId === other.id)?.lastReadAt).toBeNull(); + }); + + test("the list carries the caller's lastReadAt and nobody else's", async () => { + const { reader, other, channelId } = await sharedChannel(); + + await persistentStore.markRead(reader, channelId); + + const forReader = await persistentStore.list(reader); + const forOther = await persistentStore.list(other); + expect( + forReader.channels.find((channel) => channel.id === channelId) + ?.lastReadAt, + ).not.toBeNull(); + expect( + forOther.channels.find((channel) => channel.id === channelId)?.lastReadAt, + ).toBeNull(); + }); + + test("refuses to mark read a channel the caller is not a member of", async () => { + const { channelId } = await sharedChannel(); + const outsider = await createPersistentUser(); + + await expect( + persistentStore.markRead(outsider, channelId), + ).rejects.toBeInstanceOf(ChannelNotFoundError); + }); + + test("stamps a read no earlier than the channel's own last-message clock", async () => { + const { reader, channelId } = await sharedChannel(); + // last_message_at is written from the reporting browser's clock and is not bounded; simulate + // one running ahead of the server so a plain "now" stamp would still read as unseen. + const future = new Date(Date.now() + 60_000); + await database + .update(channels) + .set({ lastMessageAt: future }) + .where(eq(channels.id, channelId)); + + await persistentStore.markRead(reader, channelId); + + const [row] = await database + .select({ lastReadAt: channelMemberships.lastReadAt }) + .from(channelMemberships) + .where( + and( + eq(channelMemberships.channelId, channelId), + eq(channelMemberships.userId, reader.id), + ), + ); + expect(row?.lastReadAt).not.toBeNull(); + expect(row?.lastReadAt?.getTime() ?? 0).toBeGreaterThanOrEqual( + future.getTime(), + ); + }); + + test("refuses to mark a soft-deleted channel read, mirroring setPinned", async () => { + const { reader, channelId } = await sharedChannel(); + + await persistentStore.softDelete(reader, channelId); + + await expect( + persistentStore.markRead(reader, channelId), + ).rejects.toBeInstanceOf(ChannelNotFoundError); + + const [row] = await database + .select({ lastReadAt: channelMemberships.lastReadAt }) + .from(channelMemberships) + .where( + and( + eq(channelMemberships.channelId, channelId), + eq(channelMemberships.userId, reader.id), + ), + ); + // The membership row outlives the channel, but its marker was never stamped. + expect(row?.lastReadAt).toBeNull(); + }); +}); + +describe("channel soft delete", () => { + test("hides a deleted channel from list and get", async () => { + const actor = await createPersistentUser(); + const other = await createPersistentUser(); + const agentId = await createPersistentAgent({ + name: "Deletable agent", + owner: actor, + visibility: "public", + }); + const created = await persistentStore.create(actor, [agentId]); + createdChannelIds.push(created.id); + // The store only creates the creator's membership; give the other user one directly, + // plus the thread mapping the list join requires. + await database.insert(channelMemberships).values({ + channelId: created.id, + userId: other.id, + }); + await database.insert(intelligenceChannelMappings).values({ + userId: other.id, + channelId: created.id, + // thread_id is globally unique; the actor's own mapping row already claimed + // created.threadId, so the other member's row needs one of its own. + threadId: randomUUID(), + }); + + await persistentStore.softDelete(actor, created.id); + + expect(await persistentStore.get(actor, created.id)).toBeNull(); + const page = await persistentStore.list(actor); + expect( + page.channels.find((channel) => channel.id === created.id), + ).toBeUndefined(); + + expect(await persistentStore.get(other, created.id)).toBeNull(); + const otherPage = await persistentStore.list(other); + expect( + otherPage.channels.find((channel) => channel.id === created.id), + ).toBeUndefined(); + }); + + test("stamps deleted_at on the channel", async () => { + const actor = await createPersistentUser(); + const agentId = await createPersistentAgent({ + name: "Deletable agent", + owner: actor, + }); + const created = await persistentStore.create(actor, [agentId]); + createdChannelIds.push(created.id); + + await persistentStore.softDelete(actor, created.id); + + // Soft: the row is still there, stamped rather than gone. + const [row] = await database + .select({ deletedAt: channels.deletedAt }) + .from(channels) + .where(eq(channels.id, created.id)); + expect(row?.deletedAt).not.toBeNull(); + }); + + test("deleting again is a no-op, not an error", async () => { + const actor = await createPersistentUser(); + const agentId = await createPersistentAgent({ + name: "Twice-deleted agent", + owner: actor, + }); + const created = await persistentStore.create(actor, [agentId]); + createdChannelIds.push(created.id); + + await persistentStore.softDelete(actor, created.id); + await expect( + persistentStore.softDelete(actor, created.id), + ).resolves.toBeUndefined(); + }); + + test("refuses to delete a channel the caller is not a member of", async () => { + const member = await createPersistentUser(); const outsider = await createPersistentUser(); const agentId = await createPersistentAgent({ name: "Guarded agent", - owner, + owner: member, }); - const created = await persistentStore.create(owner, [agentId]); + const created = await persistentStore.create(member, [agentId]); createdChannelIds.push(created.id); await expect( - persistentStore.remove(outsider, created.id), + persistentStore.softDelete(outsider, created.id), ).rejects.toBeInstanceOf(ChannelNotFoundError); + }); - expect((await persistedChannel(created.id)).channelRow).toMatchObject({ - id: created.id, + /* + * A deleted channel is gone as far as every other path is concerned. + * + * `get` and `list` filter on `deleted_at`, so a member who still has a stale roster row, or a + * client that reports the reply to a message sent moments before the delete, would otherwise be + * writing to and announcing a channel nobody can see: every member's browser refetches its roster + * for a row that resolves to nothing. + */ + test("refuses activity on a deleted channel and leaves the last message alone", async () => { + const actor = await createPersistentUser(); + const agentId = await createPersistentAgent({ + name: "Silenced agent", + owner: actor, }); + const created = await persistentStore.create(actor, [agentId]); + createdChannelIds.push(created.id); + await persistentStore.recordActivity(actor, created.id, { + agentId, + at: new Date(Date.now() - 60_000), + text: "Said before the delete.", + }); + await persistentStore.softDelete(actor, created.id); + + await expect( + persistentStore.recordActivity(actor, created.id, { + agentId, + at: new Date(), + text: "Said after the delete.", + }), + ).rejects.toBeInstanceOf(ChannelNotFoundError); + + // Same answer `get` gives, and the row the roster would have shown is untouched. + const [row] = await database + .select({ + lastMessage: channels.lastMessage, + lastMessageAt: channels.lastMessageAt, + }) + .from(channels) + .where(eq(channels.id, created.id)); + expect(row?.lastMessage).toBe("Said before the delete."); + }); + + test("refuses to pin a deleted channel and leaves the membership alone", async () => { + const actor = await createPersistentUser(); + const agentId = await createPersistentAgent({ + name: "Unpinnable agent", + owner: actor, + }); + const created = await persistentStore.create(actor, [agentId]); + createdChannelIds.push(created.id); + await persistentStore.softDelete(actor, created.id); + + await expect( + persistentStore.setPinned(actor, created.id, true), + ).rejects.toBeInstanceOf(ChannelNotFoundError); + + const [row] = await database + .select({ pinnedAt: channelMemberships.pinnedAt }) + .from(channelMemberships) + .where( + and( + eq(channelMemberships.channelId, created.id), + eq(channelMemberships.userId, actor.id), + ), + ); + expect(row?.pinnedAt).toBeNull(); + }); + + test("refuses to delete a package-defined channel", async () => { + const actor = await createPersistentUser(); + const [pkg] = await database + .insert(deploymentPackages) + .values({ + tenantId: persistentId("tenant"), + sourcePath: "/tmp/none", + checksum: "0", + }) + .returning({ id: deploymentPackages.id }); + if (!pkg) throw new Error("package row was not created"); + createdPackageIds.push(pkg.id); + const channelId = persistentId("package-channel"); + await database.insert(channels).values({ + id: channelId, + name: "Package channel", + description: "Defined by the tenant package.", + packageId: pkg.id, + }); + createdChannelIds.push(channelId); + await database.insert(channelMemberships).values({ + channelId, + userId: actor.id, + }); + + await expect( + persistentStore.softDelete(actor, channelId), + ).rejects.toBeInstanceOf(ChannelPackageOwnedError); }); }); diff --git a/server/tests/computer-culler.integration.test.ts b/server/tests/computer-culler.integration.test.ts new file mode 100644 index 00000000..6f8555e0 --- /dev/null +++ b/server/tests/computer-culler.integration.test.ts @@ -0,0 +1,222 @@ +import { afterAll, beforeEach, describe, expect, test } from "bun:test"; +import { randomUUID } from "node:crypto"; +import { and, eq, like } from "drizzle-orm"; +import type { + ComputerLocation, + ComputerProvider, +} from "../src/computer/provider"; +import { createDatabase } from "../src/db/client"; +import { auditEvents, workItems } from "../src/db/schema"; +import { + CULL_KIND, + offerIdleComputers, + suspendClaimedComputers, +} from "../src/work/culler"; +import { createWorkQueue } from "../src/work/queue"; +import { TEST_POOL } from "./support/database"; + +/** + * Spinning a computer down when nobody is using it, which is the whole reason the fleet does not + * cost a hundred idle browsers. + * + * The interesting cases are the ones where it must NOT act: a computer somebody just used, and a + * computer nothing is known about. Suspending either takes a person's session away mid-task, and + * both are easy to get wrong in a way no error ever reports. + */ +const database = createDatabase( + process.env.DATABASE_URL ?? + "postgres://openbot:openbot@localhost:5432/openbot", + TEST_POOL, +); +const queue = createWorkQueue(database); +const suite = randomUUID().slice(0, 8); +const botOf = (name: string) => `cull-${suite}-${name}`; + +function providerWith(computers: ComputerLocation[]) { + const stopped: string[] = []; + const provider: ComputerProvider = { + name: "fake", + isolation: "per-bot", + locate: async () => "http://unused", + status: async (botId) => ({ botId, state: "ready" }), + stop: async (botId) => { + stopped.push(botId); + return { wasRunning: true }; + }, + reset: async () => ({ cleared: false }), + list: async () => computers, + }; + return { provider, stopped }; +} + +const ran = (botId: string, when: Date) => ({ + eventType: "computer.action_allowed", + targetType: "computer", + targetId: botId, + payload: { bot: botId, action: "computer_navigate" }, + createdAt: when, +}); + +/* + * This suite's own rows and nobody else's. + * + * The kind is fixed by the culler, so scoping on it alone deleted every queued suspension in the + * database. Against a shared development database that is somebody's real work, thrown away by a + * test run. The keys are this suite's Bot ids, so that is what the sweep matches. + */ +const mine = () => + and(eq(workItems.kind, CULL_KIND), like(workItems.key, `cull-${suite}-%`)); + +afterAll(async () => { + await database.delete(workItems).where(mine()); + await database.$client.end({ timeout: 5 }); +}); + +beforeEach(async () => { + await database.delete(workItems).where(mine()); +}); + +const idleAfterMs = 30 * 60_000; +const now = () => new Date("2026-08-24T12:00:00Z"); +const minutesAgo = (minutes: number) => + new Date(now().getTime() - minutes * 60_000); + +describe("suspending computers nobody is using", () => { + test("a computer idle longer than the threshold is offered, and then suspended", async () => { + const botId = botOf("idle"); + await database.insert(auditEvents).values(ran(botId, minutesAgo(45))); + const { provider, stopped } = providerWith([ + { botId, status: "running", url: "http://c" }, + ]); + const options = { + database, + queue, + provider, + idleAfterMs, + owner: "replica-1", + now, + }; + + expect((await offerIdleComputers(options)).offered).toEqual([botId]); + const report = await suspendClaimedComputers(options); + + expect(report.suspended).toEqual([botId]); + expect(stopped).toEqual([botId]); + }); + + test("a computer used a minute ago is left alone", async () => { + const botId = botOf("busy"); + await database.insert(auditEvents).values(ran(botId, minutesAgo(1))); + const { provider, stopped } = providerWith([ + { botId, status: "running", url: "http://c" }, + ]); + + const offered = await offerIdleComputers({ + database, + queue, + provider, + idleAfterMs, + owner: "replica-1", + now, + }); + + expect(offered.offered).toEqual([]); + expect(stopped).toEqual([]); + }); + + /* + * The race the lease exists for. One replica decides a computer is idle; before anything acts on + * that, the person comes back. Suspending them mid-task is worse than paying for another five + * minutes of an idle browser, so the decision is re-checked at the moment of acting. + */ + test("a computer used after being offered is not suspended", async () => { + const botId = botOf("returned"); + await database.insert(auditEvents).values(ran(botId, minutesAgo(45))); + const { provider, stopped } = providerWith([ + { botId, status: "running", url: "http://c" }, + ]); + const options = { + database, + queue, + provider, + idleAfterMs, + owner: "replica-1", + now, + }; + + await offerIdleComputers(options); + // They came back while the item sat on the queue. + await database.insert(auditEvents).values(ran(botId, minutesAgo(2))); + const report = await suspendClaimedComputers(options); + + expect(stopped).toEqual([]); + expect(report.skipped[0]?.reason).toContain("used again"); + }); + + test("a computer nothing is known about is left alone", async () => { + // No audit row and no start time. Suspending on no evidence is how a session disappears. + const botId = botOf("unknown"); + const { provider, stopped } = providerWith([ + { botId, status: "running", url: "http://c" }, + ]); + + const offered = await offerIdleComputers({ + database, + queue, + provider, + idleAfterMs, + owner: "replica-1", + now, + }); + + expect(offered.offered).toEqual([]); + expect(stopped).toEqual([]); + }); + + test("a computer already stopped is not offered again", async () => { + const botId = botOf("stopped"); + await database.insert(auditEvents).values(ran(botId, minutesAgo(90))); + const { provider } = providerWith([ + { botId, status: "stopped", url: "http://c" }, + ]); + + expect( + ( + await offerIdleComputers({ + database, + queue, + provider, + idleAfterMs, + owner: "replica-1", + now, + }) + ).offered, + ).toEqual([]); + }); + + test("two replicas culling together suspend each computer once", async () => { + const ids = ["a", "b", "c", "d"].map(botOf); + for (const botId of ids) { + await database.insert(auditEvents).values(ran(botId, minutesAgo(60))); + } + const { provider, stopped } = providerWith( + ids.map((botId) => ({ + botId, + status: "running" as const, + url: "http://c", + })), + ); + const base = { database, queue, provider, idleAfterMs, now }; + + await offerIdleComputers({ ...base, owner: "replica-1" }); + const [first, second] = await Promise.all([ + suspendClaimedComputers({ ...base, owner: "replica-1" }), + suspendClaimedComputers({ ...base, owner: "replica-2" }), + ]); + + const all = [...first.suspended, ...second.suspended]; + expect(all.sort()).toEqual([...ids].sort()); + // Each exactly once, which is the point of claiming rather than sweeping. + expect(new Set(stopped).size).toBe(stopped.length); + }); +}); diff --git a/server/tests/computer-gateway.test.ts b/server/tests/computer-gateway.test.ts index bdbfd7b4..e2b4c255 100644 --- a/server/tests/computer-gateway.test.ts +++ b/server/tests/computer-gateway.test.ts @@ -1,5 +1,6 @@ import { describe, expect, test } from "bun:test"; import type { AuditEventInput, AuditStore } from "../src/audit"; +import { StaleSnapshotError } from "../src/computer/client"; import { ActionRefusedError, createComputerGateway, @@ -10,7 +11,6 @@ import type { ComputerLocation, ComputerProvider, } from "../src/computer/provider"; -import { StaleSnapshotError } from "../src/computer/client"; import type { SnapshotResult } from "../src/computer/schema"; import { createInMemorySnapshotStore, @@ -600,6 +600,20 @@ describe("the computer gateway", () => { expect(calls).toEqual(["navigate"]); }); + /* + * "not in the current snapshot" is a statement about a ref that could not be resolved, and it used + * to be written on every action that never named an element at all. A reader looking at a + * navigation row went hunting for a snapshot that was never taken. + */ + test("an action that never named an element records no element", async () => { + const { gateway, rows } = await gatewayWith(PERMISSIVE); + + await gateway.navigate("bot-1", ACTOR, "https://example.com/"); + + expect(rows.at(-1)?.payload.action).toBe("computer_navigate"); + expect(rows.at(-1)?.payload.element).toBeUndefined(); + }); + test("an action on an unresolvable ref is still decided and still recorded", async () => { const { gateway, rows } = await gatewayWith(PERMISSIVE); // The assertion this test was written for is unchanged: the decision is taken and the row says diff --git a/server/tests/computer-page-frame-route.test.ts b/server/tests/computer-page-frame-route.test.ts new file mode 100644 index 00000000..130c59c6 --- /dev/null +++ b/server/tests/computer-page-frame-route.test.ts @@ -0,0 +1,308 @@ +import { describe, expect, test } from "bun:test"; +import type { MiddlewareHandler } from "hono"; +import type { AppVariables, AuthenticatedActor } from "../src/auth/guards"; +import type { ComputerGateway } from "../src/computer/gateway"; +import type { PageFrameStore } from "../src/computer/page-frames"; +import type { PolicyStore } from "../src/computer/policy-store"; +import { createComputerRoutes } from "../src/computer/routes"; + +/** + * The frame is taken where the navigation happens. + * + * The surface used to capture it after the turn and file it under the tool call, which lost a race it + * could not win: the same computer is driven by other conversations between the turn ending and the + * tile asking, and a resumed computer starts blank. So the transcript showed the wrong page, or none. + * + * What these cover is the seam that replaced it: navigating photographs the page it just opened, and + * a screenshot that cannot be taken never fails the navigation the Bot was actually asked to do. + */ + +const actor: AuthenticatedActor = { + id: "user-1", + email: "member@openbot.test", + role: "user", +}; + +const asActor: MiddlewareHandler<{ Variables: AppVariables }> = async ( + context, + next, +) => { + context.set("actor", actor); + await next(); +}; + +function harness(options?: { + screenshot?: () => Promise<{ base64: string; url?: string }>; + navigate?: () => Promise<{ url: string; title: string }>; + status?: (botId: string) => Promise<{ botId: string; state: string }>; + isolation?: "per-bot" | "shared"; +}) { + const saved: Array<{ + computerId: string; + toolCallId: string; + url: string; + frame: string; + }> = []; + const gateway = { + provider: { isolation: options?.isolation ?? "per-bot" }, + navigate: + options?.navigate ?? + (async () => ({ + url: "https://example.com/story", + title: "A story", + text: "", + truncated: false, + elapsedMs: 1, + })), + status: + options?.status ?? + (async (botId: string) => ({ botId, state: "ready" as const })), + screenshot: + options?.screenshot ?? + (async () => ({ base64: "PNGBYTES", url: "https://example.com/story" })), + } as unknown as ComputerGateway; + + const pageFrames: PageFrameStore = { + async save(frame) { + saved.push({ + computerId: frame.computerId, + toolCallId: frame.toolCallId, + url: frame.url, + frame: frame.frame, + }); + }, + async load(computerId, toolCallId) { + const found = saved.find( + (row) => row.computerId === computerId && row.toolCallId === toolCallId, + ); + return found ? { url: found.url, title: null, frame: found.frame } : null; + }, + async clear() { + return saved.splice(0).length; + }, + async purge() { + return 0; + }, + }; + + const routes = createComputerRoutes( + gateway, + {} as PolicyStore, + asActor, + async () => true, + pageFrames, + ); + return { routes, saved }; +} + +function navigate( + routes: ReturnType<typeof harness>["routes"], + url: string, + // `null` means "send no turn at all". `undefined` would take the default, which is the opposite. + toolCallId: string | null = "call-1", +) { + return routes.request("http://openbot.test/bot-9/navigate", { + method: "POST", + headers: { "content-type": "application/json" }, + body: JSON.stringify({ url, ...(toolCallId ? { toolCallId } : {}) }), + }); +} + +describe("the frame a page was opened on", () => { + test("navigating keeps a frame of the page it landed on", async () => { + const { routes, saved } = harness(); + + expect((await navigate(routes, "https://example.com/story")).status).toBe( + 200, + ); + + expect(saved).toEqual([ + { + computerId: "bot-9", + toolCallId: "call-1", + url: "https://example.com/story", + frame: "PNGBYTES", + }, + ]); + }); + + /* + * The address the browser ended on, not the one that was asked for. A redirect, a canonical host or + * an added trailing slash all mean the two differ, and the transcript asks by the page the tool + * reported, so filing under the request would file under a key nothing ever looks up. + */ + test("the frame is filed under the page the browser reached", async () => { + const { routes, saved } = harness({ + navigate: async () => ({ + url: "https://www.example.com/story/", + title: "A story", + }), + screenshot: async () => ({ + base64: "PNGBYTES", + url: "https://www.example.com/story/", + }), + }); + + await navigate(routes, "https://example.com/story"); + + expect(saved[0]?.url).toBe("https://www.example.com/story/"); + }); + + test("the kept frame is read back by the page it was taken of", async () => { + const { routes } = harness(); + await navigate(routes, "https://example.com/story"); + + const response = await routes.request( + "http://openbot.test/bot-9/page-frame/call-1", + ); + + expect(await response.json()).toEqual({ + frame: { + url: "https://example.com/story", + title: null, + frame: "PNGBYTES", + }, + }); + }); + + test("a turn nobody photographed reads back as no frame", async () => { + const { routes } = harness(); + + const response = await routes.request( + "http://openbot.test/bot-9/page-frame/call-never", + ); + + expect(await response.json()).toEqual({ frame: null }); + }); + + /* + * The picture is a convenience for reading the conversation back. Failing the navigation the Bot + * was asked to do because the convenience failed would be the wrong trade every time. + */ + test("a screenshot that cannot be taken does not fail the navigation", async () => { + const { routes, saved } = harness({ + screenshot: async () => { + throw new Error("computer is suspended"); + }, + }); + + const response = await navigate(routes, "https://example.com/story"); + + expect(response.status).toBe(200); + expect(await response.json()).toMatchObject({ + url: "https://example.com/story", + }); + expect(saved).toEqual([]); + }); + + /* + * The screenshot is a second round trip and nothing holds the browser still between them. With one + * computer shared by every Bot, another Bot's navigation lands in that gap, and this used to file + * its page under this turn. + */ + test("a frame of a different page than the one opened is refused", async () => { + const { routes, saved } = harness({ + screenshot: async () => ({ + base64: "SOMEBODY-ELSES-PAGE", + url: "https://payroll.example/salaries", + }), + }); + + expect((await navigate(routes, "https://example.com/story")).status).toBe( + 200, + ); + + expect(saved).toEqual([]); + }); + + /* + * A convenience picture must not wake a machine the culler has just put to sleep, nor hold a + * navigation open for the length of a pod schedule while it does. + */ + test("a suspended computer is not resumed to photograph it", async () => { + let asked = false; + const { routes, saved } = harness({ + status: async (botId: string) => ({ botId, state: "suspended" }), + screenshot: async () => { + asked = true; + return { base64: "PNGBYTES", url: "https://example.com/story" }; + }, + }); + + expect((await navigate(routes, "https://example.com/story")).status).toBe( + 200, + ); + + expect(asked).toBe(false); + expect(saved).toEqual([]); + }); + + /* + * A computer built before screenshots said which page they were of. + * + * Refusing on a missing url did not fail safe, it failed silently and completely: a fleet part-way + * through a rollout kept no frames at all. With a computer each there is nobody to race with, so + * the picture can only be this turn's. + */ + test("an old computer's unlabelled frame is kept when the Bot has its own", async () => { + const { routes, saved } = harness({ + isolation: "per-bot", + screenshot: async () => ({ base64: "PNGBYTES" }), + }); + + await navigate(routes, "https://example.com/story"); + + expect(saved).toHaveLength(1); + }); + + /* And on one shared browser it cannot be told apart from another Bot's, so it is refused. */ + test("an old computer's unlabelled frame is refused when the computer is shared", async () => { + const { routes, saved } = harness({ + isolation: "shared", + screenshot: async () => ({ base64: "PNGBYTES" }), + }); + + await navigate(routes, "https://example.com/story"); + + expect(saved).toEqual([]); + }); + + /* A caller that does not know which turn it is still navigates, and simply keeps no frame. */ + test("a navigation with no turn named keeps no frame", async () => { + const { routes, saved } = harness(); + + expect( + (await navigate(routes, "https://example.com/story", null)).status, + ).toBe(200); + + expect(saved).toEqual([]); + }); + + /* + * The store is optional so a deployment can be wired without one. Navigation must not notice. + */ + test("a deployment keeping no frames still navigates", async () => { + const gateway = { + navigate: async () => ({ url: "https://example.com/story", title: "T" }), + status: async (botId: string) => ({ botId, state: "ready" as const }), + screenshot: async () => { + throw new Error("should not be asked"); + }, + } as unknown as ComputerGateway; + const routes = createComputerRoutes( + gateway, + {} as PolicyStore, + asActor, + async () => true, + ); + + expect((await navigate(routes, "https://example.com/story")).status).toBe( + 200, + ); + expect( + await ( + await routes.request("http://openbot.test/bot-9/page-frame/call-1") + ).json(), + ).toEqual({ frame: null }); + }); +}); diff --git a/server/tests/computer-page-frame-store.integration.test.ts b/server/tests/computer-page-frame-store.integration.test.ts new file mode 100644 index 00000000..55fe0952 --- /dev/null +++ b/server/tests/computer-page-frame-store.integration.test.ts @@ -0,0 +1,214 @@ +import { afterEach, describe, expect, test } from "bun:test"; +import { eq } from "drizzle-orm"; +import { createPageFrameStore } from "../src/computer/page-frames"; +import { createDatabase } from "../src/db/client"; +import { computerPageFrame } from "../src/db/schema"; +import { TEST_POOL } from "./support/database"; + +/** + * A conversation is a record, and a record must not change its mind. + * + * The transcript used to fetch the live screen for every past turn, so an answer about one page sat + * under a picture of whichever page the Bot had open by the time somebody read it back. The frame is + * kept per computer and TURN, which is the identity of the thing being remembered; keying it on the + * page instead let a second visit to one address rewrite an earlier turn's picture, which is the + * same mutability wearing a different hat. + * + * Driven against the database rather than a fake, because the properties under test are the + * database's: which rows collide, and what happens when they do. + */ + +const database = createDatabase( + process.env.DATABASE_URL ?? + "postgres://openbot:openbot@localhost:5432/openbot", + TEST_POOL, +); + +const store = createPageFrameStore(database); +const computers: string[] = []; + +function computerId(): string { + const id = `frame-probe-${crypto.randomUUID().slice(0, 8)}`; + computers.push(id); + return id; +} + +afterEach(async () => { + for (const id of computers.splice(0)) { + await database + .delete(computerPageFrame) + .where(eq(computerPageFrame.computerId, id)); + } +}); + +describe("kept page frames", () => { + test("a turn is read back with the frame it opened its page on", async () => { + const id = computerId(); + await store.save({ + computerId: id, + toolCallId: "call-1", + url: "https://example.com/one", + title: "One", + frame: "AAAA", + }); + + const stored = await store.load(id, "call-1"); + expect(stored?.frame).toBe("AAAA"); + expect(stored?.title).toBe("One"); + expect(stored?.url).toBe("https://example.com/one"); + }); + + test("a turn nobody photographed has no frame", async () => { + expect(await store.load(computerId(), "call-missing")).toBe(null); + }); + + test("two turns on one computer keep their own frames", async () => { + const id = computerId(); + await store.save({ + computerId: id, + toolCallId: "call-a", + url: "https://a.example", + frame: "A", + }); + await store.save({ + computerId: id, + toolCallId: "call-b", + url: "https://b.example", + frame: "B", + }); + + expect((await store.load(id, "call-a"))?.frame).toBe("A"); + expect((await store.load(id, "call-b"))?.frame).toBe("B"); + }); + + /* + * The whole reason the key is the turn. Two visits to one address are two turns and each keeps its + * own picture; keyed on the page, the second rewrote the first and a past turn changed under the + * person reading it. + */ + test("visiting the same page again leaves the earlier turn alone", async () => { + const id = computerId(); + await store.save({ + computerId: id, + toolCallId: "call-first", + url: "https://news.example", + title: "Before", + frame: "OLD", + }); + await store.save({ + computerId: id, + toolCallId: "call-second", + url: "https://news.example", + title: "After", + frame: "NEW", + }); + + expect((await store.load(id, "call-first"))?.frame).toBe("OLD"); + expect((await store.load(id, "call-second"))?.frame).toBe("NEW"); + }); + + /* A turn happens once. A second write for it is a retry or a mistake, and neither may change it. */ + test("a turn's frame is written once and never rewritten", async () => { + const id = computerId(); + await store.save({ + computerId: id, + toolCallId: "call-1", + url: "https://example.com", + frame: "FIRST", + }); + await store.save({ + computerId: id, + toolCallId: "call-1", + url: "https://example.com", + frame: "SECOND", + }); + + expect((await store.load(id, "call-1"))?.frame).toBe("FIRST"); + }); + + /* + * The computer is part of the key, not decoration. A caller who may reach one Bot must not be able + * to read another Bot's screen by naming a turn. + */ + test("one computer cannot read another computer's frame", async () => { + const mine = computerId(); + const theirs = computerId(); + await store.save({ + computerId: theirs, + toolCallId: "call-1", + url: "https://payroll.example", + frame: "SECRET", + }); + + expect(await store.load(mine, "call-1")).toBe(null); + }); + + /* + * "Every login the Bot had is gone" is not true while pictures of the signed-in pages are still + * readable from the transcript. + */ + test("wiping a computer takes its pictures with it", async () => { + const mine = computerId(); + const theirs = computerId(); + await store.save({ + computerId: mine, + toolCallId: "call-1", + url: "https://inbox.example", + frame: "MINE", + }); + await store.save({ + computerId: theirs, + toolCallId: "call-1", + url: "https://inbox.example", + frame: "THEIRS", + }); + + expect(await store.clear(mine)).toBe(1); + expect(await store.load(mine, "call-1")).toBe(null); + // And nobody else's. + expect((await store.load(theirs, "call-1"))?.frame).toBe("THEIRS"); + }); + + /* A page is a row, so a Bot that browses grows this table for as long as it runs. */ + test("frames past the retention window are swept", async () => { + const id = computerId(); + await store.save({ + computerId: id, + toolCallId: "call-1", + url: "https://example.com", + frame: "AAAA", + }); + + expect(await store.purge(60_000)).toBe(0); + expect(await store.purge(0)).toBeGreaterThanOrEqual(1); + expect(await store.load(id, "call-1")).toBe(null); + }); + + /* + * Refused rather than truncated. Half a PNG is not a smaller picture, it is a broken one, and the + * turn falls back to naming the page it opened. + */ + test("a frame too large to be a screenshot is not kept", async () => { + const id = computerId(); + await store.save({ + computerId: id, + toolCallId: "call-1", + url: "https://huge.example", + frame: "x".repeat(4 * 1024 * 1024 + 1), + }); + + expect(await store.load(id, "call-1")).toBe(null); + }); + + test("a frame with no turn to file it under is not kept", async () => { + const id = computerId(); + await store.save({ + computerId: id, + toolCallId: "", + url: "https://example.com", + frame: "AAAA", + }); + + expect(await store.load(id, "")).toBe(null); + }); +}); diff --git a/server/tests/computer-provider.test.ts b/server/tests/computer-provider.test.ts index 3285c844..be508c90 100644 --- a/server/tests/computer-provider.test.ts +++ b/server/tests/computer-provider.test.ts @@ -1,11 +1,11 @@ import { afterEach, describe, expect, test } from "bun:test"; -import type { ComputerConfig } from "../src/config"; import { createComputerProvider, createSharedComputerProvider, describeComputerIsolation, ProviderError, } from "../src/computer/provider"; +import type { ComputerConfig } from "../src/config"; const servers: { stop(closeActiveConnections?: boolean): void }[] = []; @@ -302,3 +302,45 @@ describe("computer provider factory", () => { expect(createComputerProvider(config).name).toBe("shared"); }); }); + +/** + * A transient failure must not become a permanent one. + * + * The provider is built once behind a promise, and `??=` remembers whatever that first call + * produced. A rejected promise is something: one unreadable token file at the wrong moment and every + * computer request for the rest of the pod's life failed with the same stale error, while the pod + * served happily and no probe noticed. + */ +describe("building the sandbox provider", () => { + test("a failed first attempt is not remembered", async () => { + const original = process.env.KUBERNETES_SERVICE_HOST; + delete process.env.KUBERNETES_SERVICE_HOST; + + try { + const provider = createComputerProvider({ + provider: "sandbox", + namespace: "openbot", + idleAfterMs: 60_000, + templateFile: "/nowhere/sandbox-template.json", + }); + + const first = await provider.status("bot-1").catch((e: unknown) => e); + const second = await provider.status("bot-1").catch((e: unknown) => e); + + expect(first).toBeInstanceOf(Error); + expect(second).toBeInstanceOf(Error); + /* + * DIFFERENT OBJECTS, which is the whole assertion. + * + * A memo holding the rejected promise hands back the identical Error every time, because + * nothing runs again. Two distinct instances mean the second call re-entered the build, so a + * deployment whose token file was briefly unreadable recovers on the next request instead of + * needing a restart. + */ + expect(second).not.toBe(first); + } finally { + if (original === undefined) delete process.env.KUBERNETES_SERVICE_HOST; + else process.env.KUBERNETES_SERVICE_HOST = original; + } + }); +}); diff --git a/server/tests/computer-sandbox.test.ts b/server/tests/computer-sandbox.test.ts new file mode 100644 index 00000000..11950f52 --- /dev/null +++ b/server/tests/computer-sandbox.test.ts @@ -0,0 +1,159 @@ +import { describe, expect, test } from "bun:test"; +import { + createSandboxComputerProvider, + sandboxNameFor, +} from "../src/computer/sandbox"; + +/** + * A computer each, as a Sandbox, and the two questions that decide whether it is safe. + * + * Which run of a computer this is, because a resumed browser counts generations from one again and a + * ref from before the suspend must not resolve against the page after it. And whether asking a + * question can wake a computer, because one that wakes on being asked about never suspends and the + * bill never falls. + */ +function providerWith(sandbox: unknown, seen: string[] = []) { + return createSandboxComputerProvider({ + namespace: "openbot", + template: { podTemplate: { spec: { containers: [] } } }, + idleAfterMs: 60_000, + apiServer: "https://kubernetes.default", + token: "t", + fetchImpl: (async (url: string | URL | Request, init?: RequestInit) => { + seen.push(`${init?.method ?? "GET"} ${new URL(String(url)).pathname}`); + return Response.json(sandbox); + }) as unknown as typeof fetch, + }); +} + +const running = (readyAt: string, node: string, ip: string) => ({ + metadata: { name: "bot-knowledge-abc" }, + spec: { operatingMode: "Running" }, + status: { + serviceFQDN: "bot-knowledge-abc.openbot.svc.cluster.local", + nodeName: node, + podIPs: [ip], + conditions: [ + { type: "Suspended", status: "False" }, + { type: "Ready", status: "True", lastTransitionTime: readyAt }, + ], + }, +}); + +describe("telling one run of a Bot's computer from the next", () => { + /* + * THE CASE A REAL RESUME DISPROVED THE OLD ANSWER WITH. + * + * A suspended sandbox is very often rescheduled onto the same node and handed the same address + * back, because nothing else has taken it. Measured on EKS: both identical across a suspend and + * resume. Anything built from them says "same run" for the exact case the check exists to catch. + */ + test("changes across a resume even when the node and address do not", async () => { + const before = await providerWith( + running("2026-08-24T23:14:04Z", "node-a", "192.168.49.27"), + ).sessionOf?.("knowledge"); + const after = await providerWith( + running("2026-08-25T00:40:04Z", "node-a", "192.168.49.27"), + ).sessionOf?.("knowledge"); + + expect(before).toBeDefined(); + expect(after).toBeDefined(); + expect(after).not.toBe(before); + }); + + test("is the same while one run keeps serving", async () => { + const sandbox = running("2026-08-25T00:40:04Z", "node-a", "192.168.49.27"); + expect(await providerWith(sandbox).sessionOf?.("knowledge")).toBe( + await providerWith(sandbox).sessionOf?.("knowledge"), + ); + }); + + test("a suspended computer has no run to name", async () => { + // Unknown rather than mismatched: there is no page behind a suspended computer to resolve against. + const suspended = { + metadata: { name: "bot-knowledge-abc" }, + spec: { operatingMode: "Suspended" }, + status: { conditions: [{ type: "Suspended", status: "True" }] }, + }; + expect( + await providerWith(suspended).sessionOf?.("knowledge"), + ).toBeUndefined(); + }); + + test("asking which run it is never starts a computer", async () => { + /* + * The invisible way to lose scale-to-zero: everything works, nothing ever suspends, and only the + * bill says otherwise. Reading is a GET; anything that creates or patches would wake it. + */ + const seen: string[] = []; + await providerWith( + running("2026-08-25T00:40:04Z", "n", "1.2.3.4"), + seen, + ).sessionOf?.("knowledge"); + expect(seen.every((call) => call.startsWith("GET "))).toBe(true); + }); + + test("status reads a suspended computer as down and fine, without touching it", async () => { + const seen: string[] = []; + const suspended = { + metadata: { name: "bot-knowledge-abc" }, + spec: { operatingMode: "Suspended" }, + status: { conditions: [{ type: "Suspended", status: "True" }] }, + }; + const status = await providerWith(suspended, seen).status("knowledge"); + + expect(status.state).toBe("absent"); + expect(seen.every((call) => call.startsWith("GET "))).toBe(true); + }); +}); + +describe("naming a Bot's computer in a cluster", () => { + test("a bot id that is not a legal name still gets one, and a unique one", () => { + // Bot ids are ours and hold anything a person typed; a resource name may not. Two ids that differ + // only in punctuation must not land on one computer, which would be one Bot reading another's + // logins. + const a = sandboxNameFor("Sales Bot"); + const b = sandboxNameFor("sales-bot"); + expect(a).toMatch(/^[a-z0-9-]+$/); + expect(b).toMatch(/^[a-z0-9-]+$/); + expect(a).not.toBe(b); + }); + + test("the same id always names the same computer", () => { + expect(sandboxNameFor("knowledge")).toBe(sandboxNameFor("knowledge")); + }); +}); + +/** + * A projected service account token is not a constant. + * + * The kubelet rewrites the file well before the token expires, and how long that is belongs to the + * cluster: an hour where somebody hardened it, a day by default. Read once and held for the life of + * the process, sandbox calls work right up to the first rotation and then every one returns 401, + * which reads like the cluster broke rather than like a credential going stale. + */ +describe("the credential a sandbox call carries", () => { + test("is asked for again rather than captured once", async () => { + const sent: string[] = []; + let current = "first"; + const provider = createSandboxComputerProvider({ + namespace: "openbot", + idleAfterMs: 60_000, + template: { podTemplate: {} }, + apiServer: "https://cluster.test", + token: async () => current, + fetchImpl: (async (_url: string, init: RequestInit) => { + sent.push( + String((init.headers as Record<string, string>).authorization), + ); + return new Response("null", { status: 404 }); + }) as unknown as typeof fetch, + }); + + await provider.status("bot-1"); + current = "rotated"; + await provider.status("bot-1"); + + expect(sent).toEqual(["Bearer first", "Bearer rotated"]); + }); +}); diff --git a/server/tests/computer-supervisor.test.ts b/server/tests/computer-supervisor.test.ts index 919d4cc3..ddc38ced 100644 --- a/server/tests/computer-supervisor.test.ts +++ b/server/tests/computer-supervisor.test.ts @@ -236,3 +236,79 @@ describe("Docker supervisor provider", () => { expect(await provider.reset("bot")).toEqual({ cleared: false }); }); }); + +/** + * Which run of a computer this is, asked by a replica that did not start it. + * + * `sessionOf` is what stops a ref from a dead container resolving against a live one: a replaced + * computer counts generations from one again, so the generation alone cannot tell them apart. It + * answers from what the last `/ensure` reported, which is free and correct while one process does + * both halves of the work. + * + * On more than one replica it is neither. The replica that took the snapshot is very often not the + * replica handling the click, and the second one has never called `/ensure` for that Bot, so it has + * nothing to answer with. `resolve` treats an unknown session as "no opinion" and skips the check by + * design, which is right for a provider that cannot tell and wrong here: the check is simply absent, + * silently, on exactly the deployment shape it was written for. + */ +describe("telling one run of a computer from the next, across replicas", () => { + /* + * A bot id of its own per test, because the map this reads is module scope. + * + * Two providers in one process are not two replicas: they share it. A test that located the + * computer under one name and then asked under the same name would pass whatever the code did, + * which is the shape of a test that proves nothing. + */ + const startedAt = "2026-08-24T09:00:00.000Z"; + + function replica(botId: string, seen: string[] = []) { + const running = [ + { + botId, + container: `openbot-computer-${botId}`, + status: "running", + url: `http://openbot-computer-${botId}:4100`, + startedAt, + }, + ]; + return createDockerSupervisorProvider({ + baseUrl: "http://supervisor:4300", + token: "t", + fetchImpl: (async (url: string | URL | Request) => { + const path = new URL(String(url)).pathname; + seen.push(path); + if (path.endsWith("/ensure")) return Response.json(running[0]); + return Response.json({ computers: running }); + }) as unknown as typeof fetch, + }); + } + + test("a replica that located the computer knows the run", async () => { + const client = replica("located"); + await client.locate("located"); + expect(await client.sessionOf?.("located")).toBe(startedAt); + }); + + test("a replica that never located it still knows the run", async () => { + /* + * The regression. This replica is serving the click; another one took the snapshot. Without an + * answer here the generation check is skipped and a ref from a computer that has since been + * replaced resolves against the new one, which is the case the check exists for. + */ + const client = replica("never-located"); + expect(await client.sessionOf?.("never-located")).toBe(startedAt); + }); + + test("asking does not start a computer that is not running", async () => { + /* + * The other half, and the easier one to get wrong. `/ensure` starts a computer; answering this + * question with it would mean every idle Bot is woken by being asked about, which is how a + * deployment ends up never suspending anything and never noticing, because everything works and + * only the bill says otherwise. + */ + const seen: string[] = []; + const client = replica("asked-about", seen); + await client.sessionOf?.("asked-about"); + expect(seen.some((path) => path.endsWith("/ensure"))).toBe(false); + }); +}); diff --git a/server/tests/credentials.test.ts b/server/tests/credentials.test.ts index b343f969..32970be7 100644 --- a/server/tests/credentials.test.ts +++ b/server/tests/credentials.test.ts @@ -59,6 +59,13 @@ describe("credential encryption", () => { stored.push(value); return { id: "credential-1", revokedAt: null }; }, + // An administrator's credential is replaced by a new row, never edited in place, so a + // call here would mean this path had changed shape. + updateSecret: async () => { + throw new Error( + "administrator credentials are not updated in place", + ); + }, rotate: async () => { throw new Error("nothing live to replace, so create is the path"); }, @@ -114,6 +121,9 @@ describe("credential encryption", () => { encryptionKey: key, store: { create: async () => ({ id: "credential-unused", revokedAt: null }), + updateSecret: async () => { + throw new Error("administrator credentials are not updated in place"); + }, rotate: async (input: { previousCredentialId: string }) => { rotated.push(input); return { id: "credential-new", revokedAt: null }; @@ -587,6 +597,96 @@ describe("one live credential per key", () => { }); }); +/** + * The in-place write, which exists for one caller: a connector whose vendor rotates its refresh + * token on every exchange. Everything else replaces a credential by writing a new row and revoking + * the old one, because that is the act that has an old grant to withdraw. + */ +describe("credential secret update", () => { + /** A live `mcp_user_token` row, which is the only kind of row this write is for. */ + async function liveCredential(plaintext: string, revoked = false) { + const id = randomUUID(); + credentialIds.push(id); + await database.insert(credentials).values({ + id, + kind: "mcp_user_token", + provider: "notion", + keyId: `user-${id}`, + encryptedValue: await encryptSecret(key, plaintext), + metadata: {}, + revokedAt: revoked ? new Date("2026-03-01T00:00:00.000Z") : null, + }); + return id; + } + + test("re-encrypts a live row without moving it", async () => { + const store = createCredentialStore(database); + const id = await liveCredential("rt-1"); + + await store.updateSecret(id, await encryptSecret(key, "rt-2")); + + // The same row, addressed by the same id everything else already holds, now carrying the new + // token — and still live, because nothing about the grant changed. + const stored = await store.readSecret(id); + expect(stored?.revokedAt).toBeNull(); + await expect( + decryptSecret(key, stored?.encryptedValue ?? ""), + ).resolves.toBe("rt-2"); + }); + + test("refuses a revoked row rather than bringing it back to life", async () => { + const store = createCredentialStore(database); + const id = await liveCredential("rt-1", true); + + await expect( + store.updateSecret(id, await encryptSecret(key, "rt-2")), + ).rejects.toThrow("Credential was not found or is revoked"); + // Untouched: a withdrawn grant must not become usable again by being written through. + const stored = await store.readSecret(id); + await expect( + decryptSecret(key, stored?.encryptedValue ?? ""), + ).resolves.toBe("rt-1"); + }); + + test("refuses a row that is not there", async () => { + await expect( + createCredentialStore(database).updateSecret( + randomUUID(), + await encryptSecret(key, "rt-2"), + ), + ).rejects.toThrow("Credential was not found or is revoked"); + }); + + /** + * The write joins the caller's transaction when it is handed one. + * + * A rotating vendor is spent under a row lock the caller took, and the re-encryption has to be + * part of that transaction: on its own connection it would commit whether or not the caller's + * transaction did, and — with every pooled connection inside such a transaction — would wait for a + * connection that only the caller could release. + */ + test("joins a caller's transaction, so a rollback takes the new secret with it", async () => { + const store = createCredentialStore(database); + const id = await liveCredential("rt-1"); + + await expect( + database.transaction(async (transaction) => { + await store.updateSecret( + id, + await encryptSecret(key, "rt-2"), + transaction, + ); + throw new Error("the caller changed its mind"); + }), + ).rejects.toThrow("the caller changed its mind"); + + const stored = await store.readSecret(id); + await expect( + decryptSecret(key, stored?.encryptedValue ?? ""), + ).resolves.toBe("rt-1"); + }); +}); + describe("admin credential API", () => { test("returns only credential status and metadata", async () => { const app = createApp( diff --git a/server/tests/plugin-catalogue.test.ts b/server/tests/plugin-catalogue.test.ts index a122a5a7..9ba4dfd6 100644 --- a/server/tests/plugin-catalogue.test.ts +++ b/server/tests/plugin-catalogue.test.ts @@ -1,11 +1,13 @@ import { describe, expect, test } from "bun:test"; import { CATALOGUE, + type CatalogueEntry, catalogueEntry, classifyTool, customUrlRefusal, hostAdmissible, resolveServerUrl, + serverCredentialKind, } from "../src/plugins/catalogue"; /** @@ -118,8 +120,15 @@ describe("whose credential a server uses", () => { expect(entry.auth.tokenUrl.startsWith("https://")).toBe(true); expect(entry.auth.revokeUrl.startsWith("https://")).toBe(true); // No scopes means consent to nothing, which would fail at the vendor with a message that - // does not name us. - expect(entry.auth.scopes.length).toBeGreaterThan(0); + // does not name us — except for a vendor whose consent screen itself is the scoping + // (Notion, with dynamic client registration), where a scope string would assert a control + // that does not exist. + if (entry.auth.clientRegistration !== "dynamic") { + expect(entry.auth.scopes.length).toBeGreaterThan(0); + } + if (entry.auth.clientRegistration === "dynamic") { + expect(entry.auth.registrationUrl?.startsWith("https://")).toBe(true); + } } }); @@ -178,6 +187,57 @@ describe("Google Drive", () => { }); }); +describe("Notion", () => { + const entry = catalogueEntry("notion"); + + test("is in the catalogue with the MCP transport", () => { + expect(entry).not.toBeNull(); + // Transport omitted means MCP, which is the point: Drive's REST adapter is the exception. + expect(entry?.transport).toBeUndefined(); + expect(entry?.host).toBe("https://mcp.notion.com"); + expect(entry?.path).toBe("/mcp"); + }); + + test("registers its client dynamically, with every endpoint pinned to https", () => { + if (entry?.auth.kind !== "user-oauth") throw new Error("wrong auth kind"); + expect(entry.auth.clientRegistration).toBe("dynamic"); + expect(entry.auth.registrationUrl?.startsWith("https://")).toBe(true); + expect(entry.auth.authorizationUrl.startsWith("https://")).toBe(true); + expect(entry.auth.tokenUrl.startsWith("https://")).toBe(true); + // Notion MCP scoping is the consent screen; scope strings would assert control that + // does not exist. + expect(entry.auth.scopes).toEqual([]); + }); + + test("pins the exact write list, so a dropped or renamed entry fails here", () => { + // Copied from the catalogue's Notion entry, in its declared order. This list is the + // entire write barrier for Notion (see the comment above writeTools in catalogue.ts) — + // asserting membership against itself would never catch a silently dropped or renamed + // tool, so the fix is to pin the literal names. + expect(entry?.writeTools).toEqual([ + "notion-convert-page-to-skill", + "notion-create-attachment", + "notion-create-comment", + "notion-create-database", + "notion-create-file-upload", + "notion-create-folder", + "notion-create-pages", + "notion-create-view", + "notion-duplicate-page", + "notion-move-pages", + "notion-update-data-source", + "notion-update-folder", + "notion-update-page", + "notion-update-view", + ]); + for (const name of entry?.writeTools ?? []) { + expect(classifyTool(entry, name, true)).toBe("write"); + } + expect(classifyTool(entry, "notion-search", true)).toBe("read"); + expect(classifyTool(entry, "brand-new-tool", false)).toBe("write"); + }); +}); + describe("what a tool does", () => { const drive = catalogueEntry("google-drive")!; @@ -284,7 +344,155 @@ describe("a URL an administrator typed", () => { expect(refusal).not.toContain("oauth"); }); + test("a credential in the query string is refused", () => { + // The same harm as the userinfo case above, reached through the other part of the URL no host + // rule looks at. addCustomServer writes the string it was given into mcp_servers.url and into + // the configuration.changed audit payload, audit redaction keys on the field name, and "url" is + // not a sensitive name, so a token here sits in an append-only trail in clear text. + expect( + customUrlRefusal("https://mcp.example.com/mcp?token=sk-live-abcdef"), + ).not.toBeNull(); + expect( + customUrlRefusal("https://mcp.example.com/mcp?api_key=SECRET"), + ).not.toBeNull(); + expect( + customUrlRefusal("https://mcp.example.com/mcp?access_token=SECRET"), + ).not.toBeNull(); + expect( + customUrlRefusal("https://mcp.example.com/mcp?client_secret=SECRET"), + ).not.toBeNull(); + }); + + test("the names a credential is actually given are refused too", () => { + // The first version of this rule listed exact names, which is a corner of the class rather than + // the class: every one of these was accepted while `?token=` was refused, and an operator does + // not know which spelling the check happens to hold. The match reads the name for what it says. + for (const name of [ + "auth_token", + "api_token", + "apiToken", + "access_key", + "secret_key", + "private_key", + "session_token", + "x-api-key", + "subscription-key", + "X-Amz-Signature", + "bearer", + "pwd", + ]) { + expect( + customUrlRefusal(`https://mcp.example.com/mcp?${name}=s3cret`), + ).not.toBeNull(); + } + }); + + test("an ordinary query parameter is still accepted", () => { + // The rule reads the parameter name, not the presence of a query, because vendors route and + // version with parameters. Refusing every query string would make this floor an outage rather + // than a guard, and an operator who cannot add a working server will find a way around it. + expect( + customUrlRefusal("https://mcp.example.com/mcp?workspace=acme&version=2"), + ).toBeNull(); + // The near misses, which are what a rule that reads names rather than matching them exactly has + // to get right: "keyword" is not a key and "author" is not auth. + expect( + customUrlRefusal("https://mcp.example.com/mcp?keyword=x&author=jane"), + ).toBeNull(); + }); + + test("refusing a credential in the query does not repeat it", () => { + // Same property as the userinfo refusal: this string is rendered to an administrator and can + // reach a log, so it must not carry the secret it exists to reject. + const refusal = customUrlRefusal( + "https://mcp.example.com/mcp?token=s3cret", + ); + expect(refusal).not.toBeNull(); + expect(refusal).not.toContain("s3cret"); + expect(refusal).not.toContain("mcp.example.com"); + }); + + test("a credential in the fragment is refused too", () => { + // The fragment never leaves the browser, but that is not the harm here. addCustomServer stores + // and audits the whole string, so a secret written after the hash is as durable and as readable + // as one in the query. Refusing one and not the other would leave the same bypass a character + // away. + expect( + customUrlRefusal("https://mcp.example.com/mcp#token=s3cret"), + ).not.toBeNull(); + // The shapes a fragment is actually written in. A hash route or an OAuth-style callback puts a + // path before the question mark, and reading the whole fragment as one query string turns all + // of it into a single name that matches nothing. + expect( + customUrlRefusal("https://mcp.example.com/mcp#/callback?token=s3cret"), + ).not.toBeNull(); + expect( + customUrlRefusal("https://mcp.example.com/mcp#!/x?token=s3cret"), + ).not.toBeNull(); + expect( + customUrlRefusal("https://mcp.example.com/mcp#token%3Ds3cret"), + ).not.toBeNull(); + // An ordinary fragment is not a credential and is left alone. + expect(customUrlRefusal("https://mcp.example.com/mcp#section")).toBeNull(); + }); + + test("the short name for the cloud metadata endpoint is refused", () => { + // metadata.goog is Google's own alias for the metadata server, published beside + // metadata.google.internal and 169.254.169.254. It carries a dot and none of the suffixes + // above, so it read as an ordinary vendor name, while the long spelling was caught only + // incidentally by the .internal test. + expect( + customUrlRefusal("https://metadata.goog/computeMetadata/v1/"), + ).not.toBeNull(); + expect( + customUrlRefusal("https://metadata.goog./computeMetadata/v1/"), + ).not.toBeNull(); + expect( + customUrlRefusal("https://METADATA.GOOG/computeMetadata/v1/"), + ).not.toBeNull(); + }); + test("nonsense is refused rather than thrown", () => { expect(customUrlRefusal("not a url")).toBe("That is not a URL."); }); }); + +describe("which credential a curated server is given", () => { + /** + * A synthetic entry, because the catalogue holds one vendor today and it is `user-oauth`. + * + * The shared-token branch is the one a fork re-enables when it puts a removed vendor back, which + * is the case this rule exists for, so it is exercised here rather than left to be discovered + * then. The other side of the same argument is why the entry is written out in full rather than + * spread from a real one: what is under test is the auth kind deciding the answer. + */ + const sharedToken: CatalogueEntry = { + key: "shared-token-vendor", + title: "Vendor", + vendor: "Vendor", + summary: "A server the deployment holds one token for.", + host: "https://mcp.vendor.example", + path: "/mcp", + auth: { kind: "deployment-bearer" }, + writeTools: [], + docsUrl: "https://vendor.example/docs", + }; + + test("a shared-token server takes the deployment's own token for it", () => { + expect(serverCredentialKind(sharedToken)).toBe("mcp"); + }); + + test("a server reached as the asker takes no credential from the caller", () => { + // Its OAuth client arrives through registerOAuthClient, which mints the credential itself. An id + // offered here is therefore never the right one, whatever kind it names. + const drive = catalogueEntry("google-drive"); + expect(drive?.auth.kind).toBe("user-oauth"); + expect(serverCredentialKind(drive as CatalogueEntry)).toBeNull(); + }); + + test("a server that needs no credential takes none", () => { + expect( + serverCredentialKind({ ...sharedToken, auth: { kind: "none" } }), + ).toBeNull(); + }); +}); diff --git a/server/tests/plugin-connect-route.test.ts b/server/tests/plugin-connect-route.test.ts new file mode 100644 index 00000000..ccdcf46b --- /dev/null +++ b/server/tests/plugin-connect-route.test.ts @@ -0,0 +1,161 @@ +import { describe, expect, test } from "bun:test"; +import type { MiddlewareHandler } from "hono"; +import { Hono } from "hono"; +import type { AppVariables } from "../src/auth/guards"; +import { createPluginRoutes } from "../src/plugins/routes"; +import { + CatalogueEntryUnknownError, + type OAuthClient, +} from "../src/plugins/store"; + +/** + * `POST /servers/:id/connect`, for a dynamically registered vendor. + * + * Notion has no administrator step: nobody pastes a client id, so the first person to connect is + * the one who makes the deployment introduce itself (RFC 7591) to the vendor. Google Drive is the + * regression pin for the OLD behaviour, which must survive unchanged for a manually registered + * vendor: no stored client is still a 409 telling an administrator to add one, and registration is + * never attempted for it. + */ + +/** A real key shape: base64 over 32 bytes, which is what the deployment's own check demands. */ +const ENCRYPTION_KEY = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="; + +function signedIn(): MiddlewareHandler<{ Variables: AppVariables }> { + return async (context, next) => { + context.set("actor", { + id: "user-1", + email: "person@openbot.test", + role: "user", + } as never); + await next(); + }; +} + +function app(store: { + oauthClientFor: (serverId: string) => Promise<OAuthClient | null>; + ensureOAuthClient: ( + serverId: string, + by: string, + ) => Promise<OAuthClient | null>; +}) { + const routes = createPluginRoutes( + store as never, + signedIn(), + async () => true, + { + publicUrl: "https://openbot.example", + appUrl: "https://app.example", + encryptionKey: ENCRYPTION_KEY, + // Only the callback asks this. Every test here stops at the authorization URL. + personHasAccess: async () => true, + }, + ); + return new Hono().route("/api/plugins", routes); +} + +describe("connecting a dynamically registered vendor", () => { + test("registers a client on first connect and mints an authorization URL with it", async () => { + const ensureCalls: { serverId: string; by: string }[] = []; + const hono = app({ + oauthClientFor: async () => null, + ensureOAuthClient: async (serverId, by) => { + ensureCalls.push({ serverId, by }); + return { clientId: "dyn-1", clientSecret: "" }; + }, + }); + + const response = await hono.request( + "http://t/api/plugins/servers/notion/connect", + { method: "POST" }, + ); + + expect(response.status).toBe(200); + expect(ensureCalls).toEqual([ + { serverId: "notion", by: "person@openbot.test" }, + ]); + + const body = (await response.json()) as { authorizationUrl: string }; + const url = new URL(body.authorizationUrl); + expect(url.host).toBe("mcp.notion.com"); + expect(url.pathname).toBe("/authorize"); + expect(url.searchParams.get("client_id")).toBe("dyn-1"); + }); + + test("a refused registration answers 502, naming the vendor", async () => { + const ensureCalls: { serverId: string; by: string }[] = []; + const hono = app({ + oauthClientFor: async () => null, + ensureOAuthClient: async (serverId, by) => { + ensureCalls.push({ serverId, by }); + return null; + }, + }); + + const response = await hono.request( + "http://t/api/plugins/servers/notion/connect", + { method: "POST" }, + ); + + expect(response.status).toBe(502); + expect(ensureCalls.length).toBe(1); + const body = (await response.json()) as { error: string }; + expect(body.error).toBe( + "Notion refused this deployment's registration. Try again, and check the vendor's status if it persists.", + ); + }); +}); + +describe("connecting a manually registered vendor (regression pin)", () => { + test("still 409s with no client registered, and never attempts self-registration", async () => { + const ensureCalls: { serverId: string; by: string }[] = []; + const hono = app({ + oauthClientFor: async () => null, + ensureOAuthClient: async (serverId, by) => { + ensureCalls.push({ serverId, by }); + return { clientId: "should-not-happen", clientSecret: "x" }; + }, + }); + + const response = await hono.request( + "http://t/api/plugins/servers/google-drive/connect", + { method: "POST" }, + ); + + expect(response.status).toBe(409); + expect(ensureCalls).toEqual([]); + const body = (await response.json()) as { error: string }; + expect(body.error).toContain("no OAuth client registered"); + }); +}); + +/** + * Connecting a catalogue vendor that nobody has added to this deployment. + * + * The entry exists, so the handler gets past every check it makes about the vendor, and then asks the + * store for a client — which cannot answer, because there is no server row to hold one. That is an + * administrator's missing step and the person pressing Connect can do nothing about it, so it is the + * same 409 as a vendor whose client an administrator has not pasted in yet. It used to be a 500: an + * unhandled `CatalogueEntryUnknownError` out of `ensureOAuthClient`. + */ +describe("connecting a vendor this deployment has not added", () => { + test("is the 409 an administrator can act on, not a 500", async () => { + const hono = app({ + oauthClientFor: async () => null, + ensureOAuthClient: async (serverId) => { + throw new CatalogueEntryUnknownError(serverId); + }, + }); + + const response = await hono.request( + "http://t/api/plugins/servers/notion/connect", + { method: "POST" }, + ); + + expect(response.status).toBe(409); + const body = (await response.json()) as { error: string }; + expect(body.error).toBe( + "Notion has not been added to this deployment yet. An administrator has to add it first.", + ); + }); +}); diff --git a/server/tests/plugin-credential-binding.integration.test.ts b/server/tests/plugin-credential-binding.integration.test.ts new file mode 100644 index 00000000..1427b6f8 --- /dev/null +++ b/server/tests/plugin-credential-binding.integration.test.ts @@ -0,0 +1,328 @@ +import { + afterAll, + afterEach, + beforeAll, + describe, + expect, + test, +} from "bun:test"; +import { randomUUID } from "node:crypto"; +import { eq, inArray, like } from "drizzle-orm"; +import { createAuditStore } from "../src/audit"; +import { encryptSecret } from "../src/credentials"; +import { createDatabase } from "../src/db/client"; +import { credentials, mcpServers, mcpTools } from "../src/db/schema"; +import { + CustomServerRefusedError, + createPluginStore, +} from "../src/plugins/store"; +import { TEST_POOL } from "./support/database"; + +/** + * Which address a stored credential may be spent against, and whose it has to be. + * + * Pointing a server at a credential is the one place this deployment accepts a *reference* to a + * secret rather than the secret itself. Everywhere else that a stored value is spent, the value was + * typed into the same request that stores it: `storeAgentAuth` mints its own row from the key an + * administrator pasted and hands back an id nobody chose. So this is the field where "which secret" + * and "which address" can be made to disagree, and the add is what settles the disagreement, because + * the refresh runs before it returns and sends what it decrypts to the URL from that same request. + * + * Two rules, and the second is the one that matters. Naming another server's token was accepted, so + * a credential could be spent by a server it was never given to. And re-adding a server with a + * different URL rewrote the address while keeping the credential, so the same token could be sent + * somewhere else entirely without any cross-server trick at all. Closing only the first leaves the + * second, which is why they are one question here rather than two. + */ + +const database = createDatabase( + process.env.DATABASE_URL ?? + "postgres://openbot:openbot@localhost:5432/openbot", + TEST_POOL, +); + +const KEY = `${"x".repeat(43)}=`; +const tag = randomUUID().slice(0, 8); +const serverId = `binding-${tag}`; +const otherServerId = `binding-other-${tag}`; +const ownCredentialId = randomUUID(); +const otherCredentialId = randomUUID(); +const OWN_TOKEN = `sk-own-${tag}`; +const OTHER_TOKEN = `sk-other-${tag}`; +const LEGITIMATE_URL = "https://legit.vendor.example/mcp"; +const CHOSEN_URL = "https://collector.attacker.example/mcp"; + +const store = createPluginStore({ + database, + auditStore: createAuditStore(database), + credentials: { + readSecret: async (id: string) => { + const [row] = await database + .select({ + encryptedValue: credentials.encryptedValue, + revokedAt: credentials.revokedAt, + }) + .from(credentials) + .where(eq(credentials.id, id)); + return row ?? null; + }, + create: async () => { + throw new Error("this suite does not write credentials"); + }, + /** + * A real revoke, unlike the other suites here, because the chain below turns on whether removing + * a server actually retires its token. Stubbing this to throw would make the test prove nothing + * about the case it exists for. + */ + revoke: async (id: string) => { + await database + .update(credentials) + .set({ revokedAt: new Date() }) + .where(eq(credentials.id, id)); + }, + } as never, + encryptionKey: KEY, + policy: () => ({ mode: "enforce", deny: [], allow: ["true"] }), +}); + +/** + * What left the deployment, so a refusal can be shown to have stopped the send rather than reported + * on it afterwards. The vendors here do not exist, so a real request would fail anyway; what this + * captures is whether one was attempted at all, and what it carried. + */ +let sent: { url: string; authorization: string | null }[] = []; +const realFetch = globalThis.fetch; + +beforeAll(async () => { + globalThis.fetch = (async (input: RequestInfo | URL, init?: RequestInit) => { + const request = + input instanceof Request ? input : new Request(input as string, init); + sent.push({ + url: request.url, + authorization: request.headers.get("authorization"), + }); + return new Response("{}", { status: 500 }); + }) as typeof fetch; + + const encrypted = async (value: string) => encryptSecret(KEY, value); + await database.insert(credentials).values([ + { + id: ownCredentialId, + kind: "mcp", + // How `storeMcpToken` records whose token this is: the server it was minted for. + provider: serverId, + keyId: `mcp-${serverId}`, + encryptedValue: await encrypted(OWN_TOKEN), + metadata: {}, + }, + { + id: otherCredentialId, + kind: "mcp", + provider: otherServerId, + keyId: `mcp-${otherServerId}`, + encryptedValue: await encrypted(OTHER_TOKEN), + metadata: {}, + }, + ]); +}); + +afterEach(() => { + sent = []; +}); + +afterAll(async () => { + globalThis.fetch = realFetch; + await database.delete(mcpTools).where(like(mcpTools.serverId, `binding-%`)); + await database.delete(mcpServers).where(like(mcpServers.id, `binding-%`)); + await database + .delete(credentials) + .where(inArray(credentials.id, [ownCredentialId, otherCredentialId])); +}); + +async function storedUrl(id: string) { + const [row] = await database + .select({ url: mcpServers.url }) + .from(mcpServers) + .where(eq(mcpServers.id, id)); + return row?.url ?? null; +} + +describe("a credential is spent only by the server it belongs to", () => { + test("another server's token is refused", async () => { + await expect( + store.addCustomServer({ + id: serverId, + title: "Collector", + url: CHOSEN_URL, + credentialId: otherCredentialId, + by: "admin@example.com", + }), + ).rejects.toBeInstanceOf(CustomServerRefusedError); + + // The refusal is the whole point only if it happens before the send. + expect(sent).toEqual([]); + expect(await storedUrl(serverId)).toBeNull(); + }); + + test("the server's own token is accepted", async () => { + const added = await store.addCustomServer({ + id: serverId, + title: "Collector", + url: LEGITIMATE_URL, + credentialId: ownCredentialId, + by: "admin@example.com", + }); + + expect(added.id).toBe(serverId); + expect(await storedUrl(serverId)).toBe(LEGITIMATE_URL); + // This is the case the field exists for, so the token does go out, to the address it was given. + expect(sent[0]?.url).toContain("legit.vendor.example"); + expect(sent[0]?.authorization).toContain(OWN_TOKEN); + }); +}); + +describe("a credential is spent only at the address it was given", () => { + test("re-adding the server at a different address is refused", async () => { + // The case a check on whose credential it is cannot see: the token really does belong to this + // server. What changed is where the server points, and the add would spend the credential + // against the new address in the same call. + await expect( + store.addCustomServer({ + id: serverId, + title: "Collector", + url: CHOSEN_URL, + credentialId: ownCredentialId, + by: "admin@example.com", + }), + ).rejects.toBeInstanceOf(CustomServerRefusedError); + + expect(sent).toEqual([]); + expect(await storedUrl(serverId)).toBe(LEGITIMATE_URL); + }); + + test("re-adding it at the address it already has still works", async () => { + // Adding twice is not an attack and must stay ordinary: it is how a title is corrected and how + // an interrupted add is retried. + const added = await store.addCustomServer({ + id: serverId, + title: "Collector, renamed", + url: LEGITIMATE_URL, + credentialId: ownCredentialId, + by: "admin@example.com", + }); + + expect(added.title).toBe("Collector, renamed"); + expect(await storedUrl(serverId)).toBe(LEGITIMATE_URL); + }); + + test("a server holding no credential can still be re-addressed", async () => { + // Nothing to misdirect, so nothing to refuse. The rule is about spending a secret somewhere it + // was not entrusted to, not about URLs being immutable. + const openServerId = `binding-open-${tag}`; + await store.addCustomServer({ + id: openServerId, + title: "Open", + url: LEGITIMATE_URL, + by: "admin@example.com", + }); + + const moved = await store.addCustomServer({ + id: openServerId, + title: "Open", + url: CHOSEN_URL, + by: "admin@example.com", + }); + + expect(moved.id).toBe(openServerId); + expect(await storedUrl(openServerId)).toBe(CHOSEN_URL); + expect(sent.every((call) => call.authorization === null)).toBe(true); + }); +}); + +/** + * The way a token used to outlive the server it belonged to, and become spendable again. + * + * Three ordinary administrative acts in a row, none of them suspicious on its own. This is the shape + * that makes "a credential belongs to its server" and "a server keeps its address" both true and + * still not enough: the address rule only fires when a row is already here, so anything that gets + * the row out of the way while the token stays live reopens the same door. + */ +describe("a token does not outlive the server it was given to", () => { + const holderId = `binding-holder-${tag}`; + const holderCredentialId = randomUUID(); + const HOLDER_TOKEN = `sk-holder-${tag}`; + + beforeAll(async () => { + await database.insert(credentials).values({ + id: holderCredentialId, + kind: "mcp", + provider: holderId, + keyId: `mcp-${holderId}`, + encryptedValue: await encryptSecret(KEY, HOLDER_TOKEN), + metadata: {}, + }); + }); + + afterAll(async () => { + // The server row first: it holds a foreign key onto the credential, so the other order is + // refused by the database rather than by anything this suite is testing. + await database.delete(mcpTools).where(eq(mcpTools.serverId, holderId)); + await database.delete(mcpServers).where(eq(mcpServers.id, holderId)); + await database + .delete(credentials) + .where(eq(credentials.id, holderCredentialId)); + }); + + test("re-adding without a token keeps the one the server already holds", async () => { + // Clearing it was the first link: the row stops naming the credential, so nothing later knows + // the credential belongs to anything, and nothing retires it. + await store.addCustomServer({ + id: holderId, + title: "Holder", + url: LEGITIMATE_URL, + credentialId: holderCredentialId, + by: "admin@example.com", + }); + + await store.addCustomServer({ + id: holderId, + title: "Holder, renamed", + url: LEGITIMATE_URL, + by: "admin@example.com", + }); + + const [row] = await database + .select({ credentialId: mcpServers.credentialId }) + .from(mcpServers) + .where(eq(mcpServers.id, holderId)); + expect(row?.credentialId).toBe(holderCredentialId); + }); + + test("removing the server retires its token", async () => { + await store.removeServer(holderId, "admin@example.com"); + + const [row] = await database + .select({ revokedAt: credentials.revokedAt }) + .from(credentials) + .where(eq(credentials.id, holderCredentialId)); + expect(row?.revokedAt).not.toBeNull(); + }); + + test("a retired token cannot be attached to a server again", async () => { + // The end of the chain. Even with the row gone, so the address rule has nothing to compare + // against, the credential itself is no longer spendable. + sent = []; + + await expect( + store.addCustomServer({ + id: holderId, + title: "Holder", + url: CHOSEN_URL, + credentialId: holderCredentialId, + by: "admin@example.com", + }), + ).rejects.toBeInstanceOf(CustomServerRefusedError); + + expect(sent).toEqual([]); + }); +}); diff --git a/server/tests/plugin-curated-credential.integration.test.ts b/server/tests/plugin-curated-credential.integration.test.ts new file mode 100644 index 00000000..65c9171c --- /dev/null +++ b/server/tests/plugin-curated-credential.integration.test.ts @@ -0,0 +1,261 @@ +import { afterAll, beforeAll, describe, expect, test } from "bun:test"; +import { randomUUID } from "node:crypto"; +import { eq, inArray } from "drizzle-orm"; +import { createAuditStore } from "../src/audit"; +import { encryptSecret } from "../src/credentials"; +import { createDatabase } from "../src/db/client"; +import { credentials, mcpServers, mcpTools } from "../src/db/schema"; +import { CATALOGUE, serverCredentialKind } from "../src/plugins/catalogue"; +import { + CustomServerRefusedError, + createPluginStore, +} from "../src/plugins/store"; +import { TEST_POOL } from "./support/database"; + +/** + * Which credential a curated server is allowed to be pointed at. + * + * `addCustomServer` was given this rule and `addServer`, one function above it, was not: it takes the + * same `credentialId` from the same administrator's request and stored it unread. The two paths are + * a pair, and a guard on one of them is a guard on the path somebody happened to look at. + * + * What is reachable today is narrower than the custom case and worth stating rather than dressing + * up. `mcp_servers.credential_id` is a real foreign key, so an id naming nothing is refused by the + * database, and the one entry in the catalogue is `user-oauth`, whose client is registered through + * `registerOAuthClient` and sent to a pinned vendor address. What is left is a credential of the + * wrong kind being accepted and spent, a malformed id arriving as a database error where a refusal + * belongs, and the whole hole reopening the moment a fork re-adds a `deployment-bearer` vendor, + * which the catalogue's own comment invites. + */ + +const database = createDatabase( + process.env.DATABASE_URL ?? + "postgres://openbot:openbot@localhost:5432/openbot", + TEST_POOL, +); + +const store = createPluginStore({ + database, + auditStore: createAuditStore(database), + credentials: { + readSecret: async () => null, + create: async () => { + throw new Error("this suite does not write credentials"); + }, + revoke: async () => { + throw new Error("this suite does not revoke credentials"); + }, + }, + encryptionKey: "x".repeat(44), + policy: () => ({ mode: "enforce", deny: [], allow: ["true"] }), +}); + +/** The catalogue key under test. Real, because which credential it takes is a property of the entry. */ +const serverId = "google-drive"; +const suffix = randomUUID().slice(0, 8); +const deploymentCredentialId = randomUUID(); +const personalCredentialId = randomUUID(); +const oauthClientCredentialId = randomUUID(); + +/** + * Whether this deployment already had the server, and what it pointed at. + * + * The id is a real catalogue key rather than a suite-scoped one, so on a database somebody is using + * it is their configured server. It is removed only when this suite is what created it, and left + * pointing where it pointed before when it is not. + */ +let existing: { credentialId: string | null } | null = null; + +beforeAll(async () => { + const [row] = await database + .select({ credentialId: mcpServers.credentialId }) + .from(mcpServers) + .where(eq(mcpServers.id, serverId)); + existing = row ?? null; + + const encrypted = await encryptSecret(`${"A".repeat(43)}=`, "not-read-here"); + await database.insert(credentials).values([ + { + id: deploymentCredentialId, + kind: "mcp", + provider: serverId, + keyId: `mcp-${serverId}-${suffix}`, + encryptedValue: encrypted, + metadata: {}, + }, + { + id: oauthClientCredentialId, + kind: "mcp_oauth_client", + provider: serverId, + keyId: `oauth-client-${serverId}-${suffix}`, + encryptedValue: encrypted, + metadata: {}, + }, + { + id: personalCredentialId, + kind: "mcp_user_token", + provider: serverId, + // For a user token the key is the person, which is what makes one pickable by name from the + // administrator's own credential list. + keyId: `user_someone_else_${suffix}`, + encryptedValue: encrypted, + metadata: {}, + }, + ]); +}); + +afterAll(async () => { + if (existing) { + await database + .update(mcpServers) + .set({ credentialId: existing.credentialId }) + .where(eq(mcpServers.id, serverId)); + } else { + await database.delete(mcpTools).where(eq(mcpTools.serverId, serverId)); + await database.delete(mcpServers).where(eq(mcpServers.id, serverId)); + } + await database + .delete(credentials) + .where( + inArray(credentials.id, [ + deploymentCredentialId, + oauthClientCredentialId, + personalCredentialId, + ]), + ); +}); + +describe("a curated server may only be pointed at its own kind of credential", () => { + test("somebody else's connector token is refused, and nothing is written", async () => { + await expect( + store.addServer({ + key: serverId, + credentialId: personalCredentialId, + by: "admin@example.com", + }), + ).rejects.toBeInstanceOf(CustomServerRefusedError); + + // The refusal has to stop the write, not merely report on it: a row here is a pointer the next + // refresh dereferences. + const rows = await database + .select({ id: mcpServers.id }) + .from(mcpServers) + .where(eq(mcpServers.id, serverId)); + expect(rows).toHaveLength(existing ? 1 : 0); + }); + + test("a deployment token is refused for a vendor reached as the person asking", async () => { + // The right kind for a shared-token server and the wrong thing entirely for this one. Drive is + // answered with each person's own grant, and the deployment's OAuth client is registered through + // its own call, so there is no credential for this path to be given at all. + await expect( + store.addServer({ + key: serverId, + credentialId: deploymentCredentialId, + by: "admin@example.com", + }), + ).rejects.toBeInstanceOf(CustomServerRefusedError); + }); + + test("a malformed credential id is a refusal rather than a database error", async () => { + // `credentials.id` is a uuid column, so a value that is not one makes the query itself fail and + // the administrator gets a 500 where a refusal belongs. The same was true of the custom path + // before its shape check, and it is the reason that check reads the shape before the lookup. + const refused = store + .addServer({ + key: serverId, + credentialId: "not-a-uuid", + by: "admin@example.com", + }) + .catch((error: Error) => error); + expect(await refused).toBeInstanceOf(CustomServerRefusedError); + }); + + test("adding it again leaves the registered OAuth client where it was", async () => { + /* + * `registerOAuthClient` keeps the client it minted in this column, and adding the server again + * to change an instance host says nothing about that client. Clearing it orphaned a credential + * row that nothing revokes and told everybody who had connected that the deployment has no + * client registered, and there is no way to hand it back through this call now that a + * `user-oauth` entry refuses a credential id. + */ + await store.addServer({ key: serverId, by: "admin@example.com" }); + await database + .update(mcpServers) + .set({ credentialId: oauthClientCredentialId }) + .where(eq(mcpServers.id, serverId)); + + await store.addServer({ key: serverId, by: "admin@example.com" }); + + const [row] = await database + .select({ credentialId: mcpServers.credentialId }) + .from(mcpServers) + .where(eq(mcpServers.id, serverId)); + expect(row?.credentialId).toBe(oauthClientCredentialId); + + // Put it back, so the case below reads the column this suite left rather than this one. + await database + .update(mcpServers) + .set({ credentialId: null }) + .where(eq(mcpServers.id, serverId)); + }); + + test("adding the server without a credential still works", async () => { + // The case that must keep passing, so the refusals above are a rule and not a wall. This is also + // how the admin screen adds this vendor: it sends no credential and registers the OAuth client + // afterwards. + const added = await store.addServer({ + key: serverId, + by: "admin@example.com", + }); + expect(added.id).toBe(serverId); + + const [row] = await database + .select({ credentialId: mcpServers.credentialId }) + .from(mcpServers) + .where(eq(mcpServers.id, serverId)); + expect(row?.credentialId).toBeNull(); + }); +}); + +/** + * Every entry the catalogue actually holds, asked the same question. + * + * The shared-token branch cannot be reached today: the catalogue is frozen in code and its one entry + * is reached as the person asking. Rather than add a seam to this store so a test can invent an + * entry, the check is written over whatever the catalogue contains, so the branch starts being + * exercised the moment somebody re-adds one of the vendors that were taken out. That is the review + * where it matters, and this is the test that will be sitting there when it happens. + */ +describe("every curated entry is asked which credential it takes", () => { + test("the catalogue's own entries decide it, whatever they are", async () => { + expect(CATALOGUE.length).toBeGreaterThan(0); + + for (const entry of CATALOGUE) { + const kind = serverCredentialKind(entry); + + if (kind === null) { + // Takes none from the caller, so any id is refused, including one of the right kind. + await expect( + store.addServer({ + key: entry.key, + credentialId: deploymentCredentialId, + by: "admin@example.com", + }), + ).rejects.toBeInstanceOf(CustomServerRefusedError); + continue; + } + + // A shared-token entry takes the deployment's token for that server and nothing else. The + // fixture credential belongs to a different server, so it is refused on ownership, which is + // the branch a wrong pointer would take. + await expect( + store.addServer({ + key: entry.key, + credentialId: deploymentCredentialId, + by: "admin@example.com", + }), + ).rejects.toBeInstanceOf(CustomServerRefusedError); + } + }); +}); diff --git a/server/tests/plugin-oauth-callback.test.ts b/server/tests/plugin-oauth-callback.test.ts new file mode 100644 index 00000000..757d84a7 --- /dev/null +++ b/server/tests/plugin-oauth-callback.test.ts @@ -0,0 +1,231 @@ +import { describe, expect, test } from "bun:test"; +import type { MiddlewareHandler } from "hono"; +import { Hono } from "hono"; +import type { AppVariables } from "../src/auth/guards"; +import { challengeFor, sealConnectState } from "../src/plugins/oauth"; +import { createPluginRoutes } from "../src/plugins/routes"; + +/** + * `GET /oauth/callback`: the request the vendor sends somebody back on. + * + * It has no session by design — whose connection this is comes from the state, not from whatever + * cookie the browser happens to be carrying. That is what makes the state the only thing standing + * between a consent screen and a live refresh token in this deployment's vault, and it is why what + * the state says has to be checked against the deployment as it is when the callback LANDS rather + * than as it was when the flow started ten minutes earlier. + * + * So these tests are mostly about what must not be written: a grant for a state this deployment did + * not seal, for a state old enough to have expired, or for somebody who no longer has access. + */ + +const KEY = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="; + +const CALLBACK = "http://t/api/plugins/oauth/callback"; + +const FAILED = + "https://app.example/settings/connected-accounts?connected=failed"; + +function signedIn(): MiddlewareHandler<{ Variables: AppVariables }> { + return async (context, next) => { + context.set("actor", { + id: "user-1", + email: "person@openbot.test", + role: "user", + } as never); + await next(); + }; +} + +/** What `recordConnection` was asked to write, which is the row this endpoint can create. */ +type Recorded = { + serverId: string; + userId: string; + refreshToken: string; + scope: string; +}; + +function app(input: { + recorded: Recorded[]; + /** Whether the person named by the state still has access. Present by default. */ + personHasAccess?: (userId: string) => Promise<boolean>; +}) { + const store = { + oauthClientFor: async () => ({ clientId: "dyn-1", clientSecret: "" }), + ensureOAuthClient: async () => ({ clientId: "dyn-1", clientSecret: "" }), + recordConnection: async (connection: Recorded) => { + input.recorded.push(connection); + }, + }; + const routes = createPluginRoutes( + store as never, + signedIn(), + async () => true, + { + publicUrl: "https://openbot.example", + appUrl: "https://app.example", + encryptionKey: KEY, + personHasAccess: input.personHasAccess ?? (async () => true), + }, + ); + return new Hono().route("/api/plugins", routes); +} + +/** A vendor that would happily hand over a refresh token, so only our own checks can refuse. */ +async function withWillingVendor<T>( + run: (asked: { params: URLSearchParams }[]) => Promise<T>, +): Promise<T> { + const asked: { params: URLSearchParams }[] = []; + const realFetch = globalThis.fetch; + globalThis.fetch = (async (_url: unknown, init?: RequestInit) => { + asked.push({ params: new URLSearchParams(String(init?.body)) }); + return new Response( + JSON.stringify({ refresh_token: "rt-1", scope: "read" }), + { status: 200, headers: { "content-type": "application/json" } }, + ); + }) as unknown as typeof fetch; + try { + return await run(asked); + } finally { + globalThis.fetch = realFetch; + } +} + +function callbackUrl(state: string): string { + return `${CALLBACK}?code=code-1&state=${encodeURIComponent(state)}`; +} + +describe("a consent that came back the way it left", () => { + test("the state minted by connect is the state the callback reads", async () => { + const recorded: Recorded[] = []; + const hono = app({ recorded }); + + const started = await hono.request( + "http://t/api/plugins/servers/notion/connect", + { method: "POST" }, + ); + const { authorizationUrl } = (await started.json()) as { + authorizationUrl: string; + }; + const authorization = new URL(authorizationUrl); + const state = authorization.searchParams.get("state") ?? ""; + + const asked = await withWillingVendor(async (asked) => { + const response = await hono.request(callbackUrl(state)); + expect(response.headers.get("location")).toBe( + "https://app.example/settings/connected-accounts/notion", + ); + return asked; + }); + + expect(recorded).toEqual([ + { + serverId: "notion", + userId: "user-1", + refreshToken: "rt-1", + scope: "read", + }, + ]); + /* + * The verifier survived the round trip, and it survived it INSIDE the state rather than beside + * it: the code challenge the vendor was shown is the S256 of the verifier the callback redeemed + * with. That is the property the sealed state has to keep — it is unreadable, not lossy. + */ + const verifier = asked[0]?.params.get("code_verifier") ?? ""; + expect(verifier.length).toBeGreaterThanOrEqual(43); + expect(challengeFor(verifier)).toBe( + authorization.searchParams.get("code_challenge"), + ); + // And it was never on the callback URL in a form anybody reading that URL could use. + expect(state).not.toContain(verifier); + }); +}); + +describe("a consent that outlived the person's access", () => { + /* + * THE HOLE THIS CLOSES. Removing somebody deny-lists their address, deletes their sessions and + * retires the credentials they had already granted — and none of that reaches a consent already in + * flight at the vendor, because a state is good for ten minutes and the callback has no session to + * check. Completed, that consent used to write a fresh, live refresh token belonging to somebody + * who no longer has access, which nothing downstream would ever revoke because nothing knew it + * existed. + */ + test("writes nothing, and does not even ask the vendor", async () => { + const recorded: Recorded[] = []; + const asked: string[] = []; + const hono = app({ + recorded, + personHasAccess: async (userId) => { + asked.push(userId); + return false; + }, + }); + const state = await sealConnectState( + { userId: "removed-user", serverId: "notion", verifier: "v-1" }, + KEY, + ); + + const requests = await withWillingVendor(async (requests) => { + const response = await hono.request(callbackUrl(state)); + expect(response.headers.get("location")).toBe(FAILED); + return requests; + }); + + expect(recorded).toEqual([]); + expect(asked).toEqual(["removed-user"]); + // Refused before the code was redeemed, so the deployment never even holds the token it would + // have had to throw away. + expect(requests).toEqual([]); + }); + + test("a user id that names nobody is the same refusal", async () => { + const recorded: Recorded[] = []; + const hono = app({ recorded, personHasAccess: async () => false }); + const state = await sealConnectState( + { userId: "never-existed", serverId: "notion", verifier: "v-1" }, + KEY, + ); + + await withWillingVendor(async () => { + const response = await hono.request(callbackUrl(state)); + expect(response.headers.get("location")).toBe(FAILED); + }); + expect(recorded).toEqual([]); + }); +}); + +describe("a consent this deployment did not start", () => { + test("a state altered on the way back is refused, and nothing is written", async () => { + const recorded: Recorded[] = []; + const hono = app({ recorded }); + const sealed = await sealConnectState( + { userId: "user-1", serverId: "notion", verifier: "v-1" }, + KEY, + ); + const at = Math.floor(sealed.length / 2); + const tampered = `${sealed.slice(0, at)}${sealed[at] === "A" ? "B" : "A"}${sealed.slice(at + 1)}`; + + await withWillingVendor(async () => { + const response = await hono.request(callbackUrl(tampered)); + expect(response.headers.get("location")).toBe(FAILED); + }); + expect(recorded).toEqual([]); + }); + + test("a state left in a tab too long is refused, and nothing is written", async () => { + const recorded: Recorded[] = []; + const hono = app({ recorded }); + // Sealed as if the flow had started half an hour ago: the expiry rides inside the state, so this + // is the same value the browser would still be holding. + const stale = await sealConnectState( + { userId: "user-1", serverId: "notion", verifier: "v-1" }, + KEY, + Date.now() - 30 * 60_000, + ); + + await withWillingVendor(async () => { + const response = await hono.request(callbackUrl(stale)); + expect(response.headers.get("location")).toBe(FAILED); + }); + expect(recorded).toEqual([]); + }); +}); diff --git a/server/tests/plugin-oauth.test.ts b/server/tests/plugin-oauth.test.ts index 570cde21..853adc53 100644 --- a/server/tests/plugin-oauth.test.ts +++ b/server/tests/plugin-oauth.test.ts @@ -1,13 +1,16 @@ import { describe, expect, test } from "bun:test"; -import { catalogueEntry } from "../src/plugins/catalogue"; +import { seal } from "../src/auth/signed-value"; +import type { CatalogueAuth } from "../src/plugins/catalogue"; import { authorizationUrlFor, challengeFor, createVerifier, readConnectState, + redeemAuthorizationCode, redirectUriFor, + registerDynamicClient, connectedAccountsUrlFor, - signConnectState, + sealConnectState, } from "../src/plugins/oauth"; /** @@ -16,7 +19,7 @@ import { * Everything here exists because the browser is in the middle of it. An authorization code arrives * on a URL somebody else's server sent the person to, so nothing on that request can be believed on * its own: not who is connecting, not which server they meant, and not that they ever asked. The - * signed state is what carries those facts across, and the PKCE verifier is what proves the code + * sealed state is what carries those facts across, and the PKCE verifier is what proves the code * being redeemed belongs to the request that started it. * * So these tests are almost entirely about refusal. A state that was tampered with, replayed after @@ -25,22 +28,17 @@ import { */ const KEY = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="; -const drive = catalogueEntry("google-drive"); -if (drive?.auth.kind !== "user-oauth") { - throw new Error("google-drive must be a user-oauth entry for these tests"); -} -const driveAuth = drive.auth; const NOW = 1_770_000_000_000; describe("the state that travels through the vendor", () => { - test("carries who, which server, and the verifier, and reads back exactly", () => { - const signed = signConnectState( + test("carries who, which server, and the verifier, and reads back exactly", async () => { + const sealed = await sealConnectState( { userId: "user-1", serverId: "google-drive", verifier: "v-1" }, KEY, NOW, ); - expect(readConnectState(signed, KEY, NOW)).toEqual({ + expect(await readConnectState(sealed, KEY, NOW)).toEqual({ userId: "user-1", serverId: "google-drive", verifier: "v-1", @@ -50,8 +48,8 @@ describe("the state that travels through the vendor", () => { }); }); - test("the screen to return to survives the round trip", () => { - const signed = signConnectState( + test("the screen to return to survives the round trip", async () => { + const sealed = await sealConnectState( { userId: "user-1", serverId: "google-drive", @@ -61,7 +59,7 @@ describe("the state that travels through the vendor", () => { KEY, NOW, ); - expect(readConnectState(signed, KEY, NOW)?.returnTo).toBe("admin"); + expect((await readConnectState(sealed, KEY, NOW))?.returnTo).toBe("admin"); }); /* @@ -71,17 +69,17 @@ describe("the state that travels through the vendor", () => { * * The defence is that the field cannot express another origin at all. Only "admin" is recognised; * everything else — a URL, a protocol-relative host, a path traversal — reads back as the default. - * Asserted through a SIGNED state, because a valid signature is exactly what an attacker would not - * have, and the point is that the narrowing does not depend on the signature to hold. + * Asserted through a state this deployment actually sealed, because a state it will open at all is + * exactly what an attacker does not have, and the point is that the narrowing holds regardless. */ - test("a destination that names anywhere else reads back as the default", () => { + test("a destination that names anywhere else reads back as the default", async () => { for (const hostile of [ "https://evil.test", "//evil.test", "/admin/plugins/../../evil", "ADMIN", ]) { - const signed = signConnectState( + const sealed = await sealConnectState( { userId: "user-1", serverId: "google-drive", @@ -91,57 +89,123 @@ describe("the state that travels through the vendor", () => { KEY, NOW, ); - expect(readConnectState(signed, KEY, NOW)?.returnTo).toBe("settings"); + expect((await readConnectState(sealed, KEY, NOW))?.returnTo).toBe( + "settings", + ); } }); - test("is refused once a character of it changes", () => { - const signed = signConnectState( + test("is refused once a character of it changes", async () => { + const sealed = await sealConnectState( { userId: "user-1", serverId: "google-drive", verifier: "v-1" }, KEY, NOW, ); - // The payload is base64url, so flipping a character inside it is the realistic tamper: somebody - // trying to have the callback attach their Google account to another person's row. - const tampered = `${signed.slice(0, 4)}${signed[4] === "A" ? "B" : "A"}${signed.slice(5)}`; - expect(readConnectState(tampered, KEY, NOW)).toBeNull(); + /* + * Every character of a sealed state is the envelope, the nonce or the ciphertext, so one flipped + * character anywhere is the realistic tamper: somebody trying to have the callback attach their + * account to another person's row. AES-GCM authenticates as well as encrypts, so an altered + * state fails to open rather than opening as something else — no separate signature catches it. + */ + for (const at of [0, Math.floor(sealed.length / 2), sealed.length - 1]) { + const tampered = `${sealed.slice(0, at)}${sealed[at] === "A" ? "B" : "A"}${sealed.slice(at + 1)}`; + expect(await readConnectState(tampered, KEY, NOW)).toBeNull(); + } }); - test("is refused when signed with a different key", () => { - const signed = signConnectState( + test("is refused when sealed with a different key", async () => { + const sealed = await sealConnectState( { userId: "user-1", serverId: "google-drive", verifier: "v-1" }, "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB=", NOW, ); - expect(readConnectState(signed, KEY, NOW)).toBeNull(); + expect(await readConnectState(sealed, KEY, NOW)).toBeNull(); }); - test("expires, so a stale consent screen cannot be redeemed later", () => { - const signed = signConnectState( + test("expires, so a stale consent screen cannot be redeemed later", async () => { + // The expiry rides INSIDE the sealed value, where nobody can move it — but it still has to be + // checked on the way out, which is the half that encrypting does not do for you. + const sealed = await sealConnectState( { userId: "user-1", serverId: "google-drive", verifier: "v-1" }, KEY, NOW, ); - expect(readConnectState(signed, KEY, NOW + 60_000)).not.toBeNull(); - expect(readConnectState(signed, KEY, NOW + 60 * 60_000)).toBeNull(); + expect(await readConnectState(sealed, KEY, NOW + 60_000)).not.toBeNull(); + expect(await readConnectState(sealed, KEY, NOW + 60 * 60_000)).toBeNull(); }); - test("cannot be a run assertion wearing a different hat", () => { - // Signed under its own label, so a signature valid for one kind of statement is not valid as - // another. Without that, any signed value this deployment ever hands out is a candidate state. - const signed = signConnectState( - { userId: "user-1", serverId: "google-drive", verifier: "v-1" }, + test("cannot be a run assertion wearing a different hat", async () => { + /* + * Sealed under its own label, and the label derives the key — so a value this deployment sealed + * for another purpose is not merely rejected here, it cannot be opened here at all. Without + * that, anything the deployment ever sealed under this key would be a candidate state. + */ + const elsewhere = await seal( + JSON.stringify({ + userId: "user-1", + serverId: "google-drive", + verifier: "v-1", + exp: NOW + 60_000, + }), + KEY, + "agent-callback", + ); + expect(await readConnectState(elsewhere, KEY, NOW)).toBeNull(); + }); + + /** + * THE PROPERTY THIS FORMAT EXISTS FOR: the state says nothing to anybody without the key. + * + * The state and the authorization code travel on the SAME callback URL, and a dynamically + * registered client is public — PKCE is the only thing binding that code to this deployment. So + * every reader of that URL, and there are several nobody chose (a CDN log, a proxy log, browser + * history, the vendor's own logs), used to hold everything needed to redeem the code: a state that + * was base64url JSON with an HMAC after it is authenticated, and perfectly readable. + * + * Asserted by decoding rather than by eye, because the failure being guarded against is a value + * that LOOKS opaque and is not. + */ + test("does not carry the PKCE verifier where a reader without the key can find it", async () => { + const verifier = createVerifier(); + const state = await sealConnectState( + { userId: "user-1", serverId: "notion", verifier }, KEY, NOW, ); - const [payload] = signed.split("."); - expect(readConnectState(payload ?? "", KEY, NOW)).toBeNull(); + expect(state).not.toContain(verifier); + // Opaque as far as a URL is concerned, too: one token, nothing in it to escape. + expect(state).toMatch(/^[A-Za-z0-9\-_]+$/); + for (const segment of state.split(".")) { + for (const encoding of ["base64url", "base64", "hex"] as const) { + expect(Buffer.from(segment, encoding).toString("utf8")).not.toContain( + verifier, + ); + } + } }); - test("is refused when it is not a state at all", () => { - expect(readConnectState("", KEY, NOW)).toBeNull(); - expect(readConnectState("nonsense", KEY, NOW)).toBeNull(); - expect(readConnectState("a.b", KEY, NOW)).toBeNull(); + test("still fits in a query parameter", async () => { + // Sealing costs size, and the state has to survive a round trip through somebody else's URL + // handling. A real-shaped one — a UUID for the person, a live verifier — is well inside it. + const state = await sealConnectState( + { + userId: crypto.randomUUID(), + serverId: "google-drive", + verifier: createVerifier(), + }, + KEY, + NOW, + ); + expect(state.length).toBeLessThan(1_024); + }); + + test("is refused when it is not a state at all", async () => { + expect(await readConnectState("", KEY, NOW)).toBeNull(); + expect(await readConnectState("nonsense", KEY, NOW)).toBeNull(); + expect(await readConnectState("a.b", KEY, NOW)).toBeNull(); + // A real envelope, sealed with the right key under the right label, carrying no state at all. + const empty = await seal("{}", KEY, "mcp-oauth-connect"); + expect(await readConnectState(empty, KEY, NOW)).toBeNull(); }); }); @@ -169,9 +233,20 @@ describe("PKCE", () => { }); describe("the address the person is sent to", () => { + // A literal fixture, not the live Google Drive entry: this pins Google's behavior through the + // params-from-the-entry refactor without the test depending on the catalogue's own shape. + const googleAuth: Extract<CatalogueAuth, { kind: "user-oauth" }> = { + kind: "user-oauth", + authorizationUrl: "https://accounts.google.com/o/oauth2/v2/auth", + tokenUrl: "https://oauth2.googleapis.com/token", + revokeUrl: "https://oauth2.googleapis.com/revoke", + scopes: ["https://www.googleapis.com/auth/drive.readonly"], + authorizationParams: { access_type: "offline", prompt: "consent" }, + }; + const url = new URL( authorizationUrlFor({ - auth: driveAuth, + auth: googleAuth, clientId: "client-id", redirectUri: "https://openbot.example/api/plugins/oauth/callback", state: "signed-state", @@ -180,7 +255,7 @@ describe("the address the person is sent to", () => { ); test("is the vendor's own, from the catalogue", () => { - expect(`${url.origin}${url.pathname}`).toBe(driveAuth.authorizationUrl); + expect(`${url.origin}${url.pathname}`).toBe(googleAuth.authorizationUrl); }); test("asks for a refresh token that consent is granted for once", () => { @@ -193,7 +268,7 @@ describe("the address the person is sent to", () => { }); test("asks only for the scopes the entry pins", () => { - expect(url.searchParams.get("scope")).toBe(driveAuth.scopes.join(" ")); + expect(url.searchParams.get("scope")).toBe(googleAuth.scopes.join(" ")); }); test("carries the state and the challenge, and names the method", () => { @@ -201,6 +276,80 @@ describe("the address the person is sent to", () => { expect(url.searchParams.get("code_challenge")).toBe("challenge"); expect(url.searchParams.get("code_challenge_method")).toBe("S256"); }); + + test("a vendor with no authorization params and no scopes sends neither, nor an empty scope", () => { + // Notion's shape: no authorizationParams, and scopes: [] because the consent screen itself is + // the scoping. An empty `scope=` would be a malformed request to some vendors, so the key must + // be entirely absent, not present-and-empty. + const notionAuth: Extract<CatalogueAuth, { kind: "user-oauth" }> = { + kind: "user-oauth", + authorizationUrl: "https://mcp.notion.com/authorize", + tokenUrl: "https://mcp.notion.com/token", + revokeUrl: "https://mcp.notion.com/revoke", + scopes: [], + }; + const bare = new URL( + authorizationUrlFor({ + auth: notionAuth, + clientId: "client-id", + redirectUri: "https://openbot.example/api/plugins/oauth/callback", + state: "signed-state", + codeChallenge: "challenge", + }), + ); + expect(bare.searchParams.has("access_type")).toBe(false); + expect(bare.searchParams.has("prompt")).toBe(false); + expect(bare.searchParams.has("scope")).toBe(false); + }); + + /* + * DEFENSE IN DEPTH, NOT REACHABILITY TODAY. The catalogue is frozen, reviewed code, so nothing in + * it can set this now — but `authorizationParams` is applied LAST, after the six keys that carry + * this flow's own security (who is asking, where the vendor answers, and the PKCE proof). An entry + * that names one of them would quietly win, and a future entry setting `code_challenge_method: + * "plain"` would defeat PKCE with no test catching it. Throwing at URL-build time turns that into a + * fail-at-first-connect instead of a silent downgrade. + */ + test("an entry that names one of the flow's own keys throws rather than winning", () => { + const hostileAuth: Extract<CatalogueAuth, { kind: "user-oauth" }> = { + kind: "user-oauth", + authorizationUrl: "https://vendor.example/authorize", + tokenUrl: "https://vendor.example/token", + revokeUrl: "https://vendor.example/revoke", + scopes: [], + authorizationParams: { code_challenge_method: "plain" }, + }; + expect(() => + authorizationUrlFor({ + auth: hostileAuth, + clientId: "client-id", + redirectUri: "https://openbot.example/api/plugins/oauth/callback", + state: "signed-state", + codeChallenge: "challenge", + }), + ).toThrow(/code_challenge_method/); + }); + + test("an entry's harmless extra parameter still passes through", () => { + const audienceAuth: Extract<CatalogueAuth, { kind: "user-oauth" }> = { + kind: "user-oauth", + authorizationUrl: "https://vendor.example/authorize", + tokenUrl: "https://vendor.example/token", + revokeUrl: "https://vendor.example/revoke", + scopes: [], + authorizationParams: { audience: "x" }, + }; + const withAudience = new URL( + authorizationUrlFor({ + auth: audienceAuth, + clientId: "client-id", + redirectUri: "https://openbot.example/api/plugins/oauth/callback", + state: "signed-state", + codeChallenge: "challenge", + }), + ); + expect(withAudience.searchParams.get("audience")).toBe("x"); + }); }); describe("the address the vendor sends them back to", () => { @@ -304,3 +453,250 @@ describe("where the callback sends somebody afterwards", () => { ); }); }); + +describe("registering this deployment as an OAuth client", () => { + test("registers a dynamic client with the redirect URI and no secret", async () => { + const seen: { url: string; body: unknown }[] = []; + const realFetch = globalThis.fetch; + globalThis.fetch = (async (url: unknown, init?: RequestInit) => { + seen.push({ url: String(url), body: JSON.parse(String(init?.body)) }); + return new Response(JSON.stringify({ client_id: "dyn-123" }), { + status: 201, + headers: { "content-type": "application/json" }, + }); + }) as unknown as typeof fetch; + try { + const client = await registerDynamicClient({ + registrationUrl: "https://vendor.example/register", + redirectUri: "https://openbot.example/api/plugins/oauth/callback", + }); + expect(client).toEqual({ clientId: "dyn-123", clientSecret: "" }); + expect(seen[0]?.url).toBe("https://vendor.example/register"); + expect(seen[0]?.body).toEqual({ + redirect_uris: ["https://openbot.example/api/plugins/oauth/callback"], + grant_types: ["authorization_code", "refresh_token"], + response_types: ["code"], + token_endpoint_auth_method: "none", + client_name: "OpenBot", + }); + } finally { + globalThis.fetch = realFetch; + } + }); + + test("a refused registration returns null rather than a client", async () => { + const realFetch = globalThis.fetch; + globalThis.fetch = (async () => + new Response("no", { status: 400 })) as unknown as typeof fetch; + try { + expect( + await registerDynamicClient({ + registrationUrl: "https://vendor.example/register", + redirectUri: "https://openbot.example/cb", + }), + ).toBeNull(); + } finally { + globalThis.fetch = realFetch; + } + }); + + /** + * A 200 carrying something that is not JSON. + * + * A CDN interstitial, a captive portal, a load balancer's maintenance page: all of them answer 200 + * with HTML, and this function's contract is that a vendor which will not register us reads back + * as null. An unguarded `response.json()` breaks that contract in the worst available way — it + * throws a SyntaxError, which escapes the whole request as a 500, and the parser's message quotes + * the vendor's body into whatever logs it. + */ + test("a 200 that is not JSON is a refusal, not a thrown parse error", async () => { + const realFetch = globalThis.fetch; + globalThis.fetch = (async () => + new Response("<html>Attention Required!</html>", { + status: 200, + headers: { "content-type": "text/html" }, + })) as unknown as typeof fetch; + try { + expect( + await registerDynamicClient({ + registrationUrl: "https://vendor.example/register", + redirectUri: "https://openbot.example/cb", + }), + ).toBeNull(); + } finally { + globalThis.fetch = realFetch; + } + }); + + /** + * A redirect is a refusal, and is never followed. + * + * This request carries nothing secret, but where it goes is a reviewed decision: the registration + * endpoint is pinned in the catalogue, and a 302 is somebody else deciding for us. Followed, it + * would have this deployment register itself at whatever address the answer named — and believe + * the client id that came back. + */ + test("a redirect is not followed, and reads back as a refusal", async () => { + const seen: { redirect: RequestRedirect | undefined }[] = []; + const realFetch = globalThis.fetch; + globalThis.fetch = (async (_url: unknown, init?: RequestInit) => { + seen.push({ redirect: init?.redirect }); + return new Response(null, { + status: 302, + headers: { location: "https://elsewhere.example/register" }, + }); + }) as unknown as typeof fetch; + try { + expect( + await registerDynamicClient({ + registrationUrl: "https://vendor.example/register", + redirectUri: "https://openbot.example/cb", + }), + ).toBeNull(); + expect(seen[0]?.redirect).toBe("manual"); + } finally { + globalThis.fetch = realFetch; + } + }); +}); + +describe("redeeming an authorization code", () => { + test("an empty client secret sends no client_secret field", async () => { + const seen: { params: URLSearchParams }[] = []; + const realFetch = globalThis.fetch; + globalThis.fetch = (async (_url: unknown, init?: RequestInit) => { + seen.push({ params: new URLSearchParams(String(init?.body)) }); + return new Response( + JSON.stringify({ refresh_token: "rt-1", scope: "" }), + { status: 200, headers: { "content-type": "application/json" } }, + ); + }) as unknown as typeof fetch; + try { + await redeemAuthorizationCode({ + tokenUrl: "https://vendor.example/token", + clientId: "client-id", + clientSecret: "", + code: "code-1", + redirectUri: "https://openbot.example/api/plugins/oauth/callback", + verifier: "verifier-1", + }); + expect(seen[0]?.params.has("client_secret")).toBe(false); + } finally { + globalThis.fetch = realFetch; + } + }); + + test("a non-empty client secret still sends the field", async () => { + const seen: { params: URLSearchParams }[] = []; + const realFetch = globalThis.fetch; + globalThis.fetch = (async (_url: unknown, init?: RequestInit) => { + seen.push({ params: new URLSearchParams(String(init?.body)) }); + return new Response( + JSON.stringify({ refresh_token: "rt-1", scope: "" }), + { status: 200, headers: { "content-type": "application/json" } }, + ); + }) as unknown as typeof fetch; + try { + await redeemAuthorizationCode({ + tokenUrl: "https://vendor.example/token", + clientId: "client-id", + clientSecret: "secret-1", + code: "code-1", + redirectUri: "https://openbot.example/api/plugins/oauth/callback", + verifier: "verifier-1", + }); + expect(seen[0]?.params.get("client_secret")).toBe("secret-1"); + } finally { + globalThis.fetch = realFetch; + } + }); + + /** + * A 200 carrying something that is not JSON. + * + * The documented contract is a refusal — "a refusal rather than an exception when the vendor + * declines" — and a CDN interstitial answering 200 with HTML is exactly the case where the + * unguarded parse turned that refusal into a 500. The person had consented by then, so the failure + * lands on the callback: it must redirect them back to Settings with a notice, not crash. + */ + test("a 200 that is not JSON is a refusal, not a thrown parse error", async () => { + const realFetch = globalThis.fetch; + globalThis.fetch = (async () => + new Response("<html>checking your browser</html>", { + status: 200, + headers: { "content-type": "text/html" }, + })) as unknown as typeof fetch; + try { + expect( + await redeemAuthorizationCode({ + tokenUrl: "https://vendor.example/token", + clientId: "client-id", + clientSecret: "", + code: "code-1", + redirectUri: "https://openbot.example/api/plugins/oauth/callback", + verifier: "verifier-1", + }), + ).toBeNull(); + } finally { + globalThis.fetch = realFetch; + } + }); + + /** A redirect from the token endpoint is a refusal too, and is never followed. */ + test("a redirect is not followed, and reads back as a refusal", async () => { + const seen: { redirect: RequestRedirect | undefined }[] = []; + const realFetch = globalThis.fetch; + globalThis.fetch = (async (_url: unknown, init?: RequestInit) => { + seen.push({ redirect: init?.redirect }); + return new Response(null, { + status: 307, + headers: { location: "https://elsewhere.example/token" }, + }); + }) as unknown as typeof fetch; + try { + expect( + await redeemAuthorizationCode({ + tokenUrl: "https://vendor.example/token", + clientId: "client-id", + clientSecret: "", + code: "code-1", + redirectUri: "https://openbot.example/api/plugins/oauth/callback", + verifier: "verifier-1", + }), + ).toBeNull(); + expect(seen[0]?.redirect).toBe("manual"); + } finally { + globalThis.fetch = realFetch; + } + }); + + /** + * The scope is capped where it is read. + * + * It is a short string in the protocol and vendor-controlled in fact, and everything downstream + * shows it to somebody: the connected-accounts page, an `mcp.account_connected` payload, the + * `mcp_user_credentials.scope` column. None of those is a promise about length, and a vendor + * answering with a megabyte of it should cost a truncated line rather than a stored megabyte. + */ + test("a vendor's scope is capped rather than stored whole", async () => { + const realFetch = globalThis.fetch; + globalThis.fetch = (async () => + new Response( + JSON.stringify({ refresh_token: "rt-1", scope: "s".repeat(2_000) }), + { status: 200, headers: { "content-type": "application/json" } }, + )) as unknown as typeof fetch; + try { + const grant = await redeemAuthorizationCode({ + tokenUrl: "https://vendor.example/token", + clientId: "client-id", + clientSecret: "", + code: "code-1", + redirectUri: "https://openbot.example/api/plugins/oauth/callback", + verifier: "verifier-1", + }); + expect(grant?.scope.length).toBe(512); + } finally { + globalThis.fetch = realFetch; + } + }); +}); diff --git a/server/tests/plugin-routes.integration.test.ts b/server/tests/plugin-routes.integration.test.ts new file mode 100644 index 00000000..e25aab01 --- /dev/null +++ b/server/tests/plugin-routes.integration.test.ts @@ -0,0 +1,268 @@ +import { afterAll, beforeAll, describe, expect, test } from "bun:test"; +import { randomUUID } from "node:crypto"; +import { eq, inArray } from "drizzle-orm"; +import { createApp } from "../src/app"; +import { createAuditStore } from "../src/audit"; +import { loadConfig } from "../src/config"; +import { encryptSecret } from "../src/credentials"; +import { createDatabase } from "../src/db/client"; +import { credentials, mcpServers, mcpTools } from "../src/db/schema"; +import { createPluginStore } from "../src/plugins/store"; +import { TEST_POOL } from "./support/database"; +import { testEnvironment } from "./support/environment"; + +/** + * The whole path an administrator's request actually takes, with nothing stubbed between the request + * and the row. + * + * The two halves are covered on their own: the store's refusals against a real database, and the + * route's mapping of them against a stubbed store. Both passing does not prove the pair is wired + * together, and the failure that would live in the gap is quiet in exactly the way that matters: a + * refusal that reaches the browser as a 500 reads as a broken deployment rather than a correctable + * mistake, and a refusal that stops short of the write leaves a row pointing at a credential the + * next refresh spends. So this asks the question end to end and then looks in the table. + */ + +const database = createDatabase( + process.env.DATABASE_URL ?? + "postgres://openbot:openbot@localhost:5432/openbot", + TEST_POOL, +); + +const store = createPluginStore({ + database, + auditStore: createAuditStore(database), + credentials: { + // Never read: Drive's tool list is in this deployment's own code, so the add path here reaches + // no vault. Loud rather than absent, so a call that starts reaching one is named. + readSecret: async () => { + throw new Error("this suite does not read credentials"); + }, + create: async () => { + throw new Error("this suite does not write credentials"); + }, + revoke: async () => { + throw new Error("this suite does not revoke credentials"); + }, + }, + encryptionKey: "x".repeat(44), + policy: () => ({ mode: "enforce", deny: [], allow: ["true"] }), +}); + +const ADMIN = { + id: "admin-1", + email: "admin@openbot.test", + name: "An Administrator", + image: null, +}; + +function request( + body: unknown, + role: "admin" | "user" = "admin", + path = "/api/plugins/servers", +) { + const app = createApp( + loadConfig(testEnvironment()), + { + handler: () => new Response(null, { status: 204 }), + api: { getSession: async () => ({ user: ADMIN }) }, + } as never, + { rolesForUser: async () => [role] }, + // Positions 4-14 are the other stores; the real one is 15, pluginStore. + ...(Array.from({ length: 11 }) as never[]), + store as never, + ); + + return app.request(`http://openbot.test${path}`, { + method: "POST", + headers: { "content-type": "application/json" }, + body: JSON.stringify(body), + }); +} + +const serverId = "google-drive"; +const suffix = randomUUID().slice(0, 8); +const personalCredentialId = randomUUID(); +const customServerId = `route-custom-${suffix}`; +const foreignCredentialId = randomUUID(); +const ownCredentialId = randomUUID(); + +/** What this deployment already had, so a database somebody is using is left as it was found. */ +let existing: { credentialId: string | null } | null = null; + +beforeAll(async () => { + const [row] = await database + .select({ credentialId: mcpServers.credentialId }) + .from(mcpServers) + .where(eq(mcpServers.id, serverId)); + existing = row ?? null; + + const encrypted = await encryptSecret(`${"A".repeat(43)}=`, "not-read-here"); + await database.insert(credentials).values([ + { + id: personalCredentialId, + kind: "mcp_user_token", + provider: serverId, + keyId: `user_someone_else_${suffix}`, + encryptedValue: encrypted, + metadata: {}, + }, + { + id: foreignCredentialId, + kind: "mcp", + // Minted for a different server, which is what makes it somebody else's to spend. + provider: `route-elsewhere-${suffix}`, + keyId: `mcp-elsewhere-${suffix}`, + encryptedValue: encrypted, + metadata: {}, + }, + { + id: ownCredentialId, + kind: "mcp", + provider: customServerId, + keyId: `mcp-${customServerId}`, + encryptedValue: encrypted, + metadata: {}, + }, + ]); +}); + +afterAll(async () => { + if (existing) { + await database + .update(mcpServers) + .set({ credentialId: existing.credentialId }) + .where(eq(mcpServers.id, serverId)); + } else { + await database.delete(mcpTools).where(eq(mcpTools.serverId, serverId)); + await database.delete(mcpServers).where(eq(mcpServers.id, serverId)); + } + await database.delete(mcpTools).where(eq(mcpTools.serverId, customServerId)); + await database.delete(mcpServers).where(eq(mcpServers.id, customServerId)); + await database + .delete(credentials) + .where( + inArray(credentials.id, [ + personalCredentialId, + foreignCredentialId, + ownCredentialId, + ]), + ); +}); + +async function serverRow() { + const [row] = await database + .select({ credentialId: mcpServers.credentialId }) + .from(mcpServers) + .where(eq(mcpServers.id, serverId)); + return row ?? null; +} + +describe("adding a curated server over HTTP", () => { + test("a credential of the wrong kind is refused, and nothing is written", async () => { + const before = await serverRow(); + + const response = await request({ + key: serverId, + credentialId: personalCredentialId, + }); + + // Not a 500. An administrator who picked the wrong row is told what to do about it. + expect(response.status).toBe(400); + expect((await response.json()).error).toContain( + "takes no credential when it is added", + ); + + // And the refusal stopped the write rather than reporting on it. + expect(await serverRow()).toEqual(before); + }); + + test("a malformed credential id is refused the same way, not as a database error", async () => { + const response = await request({ key: serverId, credentialId: "nonsense" }); + + expect(response.status).toBe(400); + }); + + test("the add the admin screen makes still works and writes the row", async () => { + const response = await request({ key: serverId }); + + expect(response.status).toBe(200); + expect((await response.json()).server.id).toBe(serverId); + // Whatever the column held before, not null: an add that names no credential leaves a registered + // OAuth client alone, so asserting null here would pass on a fresh database and fail on the one + // deployment shape that behaviour exists for. + expect(await serverRow()).toEqual({ + credentialId: existing?.credentialId ?? null, + }); + }); + + test("somebody who is not an administrator is refused before the store", async () => { + const response = await request({ key: serverId }, "user"); + + expect(response.status).toBe(403); + }); +}); + +/** + * The same two rules, asked over HTTP against the real store. + * + * Both are refusals an administrator has to be able to act on, so what they must never be is a 500: + * "something went wrong" sends somebody to look at the deployment when the answer is to pick a + * different token or remove the server first. + */ +describe("adding a server by URL over HTTP", () => { + const custom = "/api/plugins/servers/custom"; + + test("another server's token is refused rather than spent", async () => { + const response = await request( + { + id: customServerId, + title: "Collector", + url: "https://collector.attacker.example/mcp", + credentialId: foreignCredentialId, + }, + "admin", + custom, + ); + + expect(response.status).toBe(400); + + const rows = await database + .select({ id: mcpServers.id }) + .from(mcpServers) + .where(eq(mcpServers.id, customServerId)); + expect(rows).toHaveLength(0); + }); + + test("re-addressing a server that holds a token is refused", async () => { + const added = await request( + { + id: customServerId, + title: "Collector", + url: "https://legit.vendor.example/mcp", + credentialId: ownCredentialId, + }, + "admin", + custom, + ); + expect(added.status).toBe(200); + + const moved = await request( + { + id: customServerId, + title: "Collector", + url: "https://collector.attacker.example/mcp", + credentialId: ownCredentialId, + }, + "admin", + custom, + ); + expect(moved.status).toBe(400); + + const [row] = await database + .select({ url: mcpServers.url }) + .from(mcpServers) + .where(eq(mcpServers.id, customServerId)); + expect(row?.url).toBe("https://legit.vendor.example/mcp"); + }); +}); diff --git a/server/tests/plugin-routes.test.ts b/server/tests/plugin-routes.test.ts new file mode 100644 index 00000000..cace693d --- /dev/null +++ b/server/tests/plugin-routes.test.ts @@ -0,0 +1,105 @@ +import { describe, expect, test } from "bun:test"; +import { createApp } from "../src/app"; +import { loadConfig } from "../src/config"; +import { + CatalogueEntryUnknownError, + CustomServerRefusedError, +} from "../src/plugins/store"; +import { testEnvironment } from "./support/environment"; + +/** + * What a refused add looks like to the administrator who made it. + * + * The store's refusals are tested where they are decided. What is worth pinning here is the mapping, + * because an unmapped throw leaves the route on its default path: the refusal becomes a 500, the + * screen says something went wrong, and a correctable mistake reads as a broken deployment. The + * curated route mapped one refusal and not the other, which is exactly the shape that is invisible + * until somebody hits it. + */ + +const ADMIN = { + id: "admin-1", + email: "admin@openbot.test", + name: "An Administrator", + image: null, +}; + +function appWith( + addServer: () => Promise<never>, + role: "admin" | "user" = "admin", +) { + const store = { + addServer, + // Every read the plugins surface makes on its way to the route under test. + listServers: async () => [], + listSkills: async () => [], + listGrants: async () => [], + }; + + const app = createApp( + loadConfig(testEnvironment()), + { + handler: () => new Response(null, { status: 204 }), + api: { getSession: async () => ({ user: ADMIN }) }, + } as never, + { rolesForUser: async () => [role] }, + // Positions 4-14 are the other stores; `store` is 15, pluginStore. + ...(Array.from({ length: 11 }) as never[]), + store as never, + ); + + return (body: unknown) => + app.request("http://openbot.test/api/plugins/servers", { + method: "POST", + headers: { "content-type": "application/json" }, + body: JSON.stringify(body), + }); +} + +describe("adding a curated server", () => { + test("a refused credential comes back as a refusal with its reason", async () => { + const request = appWith(async () => { + throw new CustomServerRefusedError( + "That is not a credential this server can use. Add the server's own token instead.", + ); + }); + + const response = await request({ + key: "google-drive", + credentialId: "11111111-1111-1111-1111-111111111111", + }); + + expect(response.status).toBe(400); + expect(await response.json()).toEqual({ + error: + "That is not a credential this server can use. Add the server's own token instead.", + }); + }); + + test("an unknown catalogue key still comes back the same way", async () => { + const request = appWith(async () => { + throw new CatalogueEntryUnknownError("nope"); + }); + + expect((await request({ key: "nope" })).status).toBe(400); + }); + + test("a failure that is not a refusal is not dressed up as one", async () => { + // The must-not case. Mapping every throw to 400 would tell an administrator to correct their + // input when the database is down, and would hide a real fault behind a message about + // credentials. + const request = appWith(async () => { + throw new Error("the database is unreachable"); + }); + + expect((await request({ key: "google-drive" })).status).toBe(500); + }); + + test("somebody who is not an administrator cannot add one at all", async () => { + const request = appWith(async () => { + throw new Error("the store must not be reached"); + }, "user"); + + expect((await request({ key: "google-drive" })).status).toBe(403); + }); +}); diff --git a/server/tests/plugin-store.integration.test.ts b/server/tests/plugin-store.integration.test.ts index bddede09..646c108c 100644 --- a/server/tests/plugin-store.integration.test.ts +++ b/server/tests/plugin-store.integration.test.ts @@ -1,23 +1,47 @@ -import { afterAll, beforeAll, describe, expect, test } from "bun:test"; +import { + afterAll, + beforeAll, + beforeEach, + describe, + expect, + test, +} from "bun:test"; import { randomUUID } from "node:crypto"; +import { MCPMock } from "@copilotkit/aimock/mcp"; import { and, eq, inArray, like, sql } from "drizzle-orm"; import { createAuditStore } from "../src/audit"; -import { encryptSecret } from "../src/credentials"; import type { ActionPolicy } from "../src/computer/policy"; +import { + createCredentialStore, + type CredentialStoreValue, + decryptSecret, + encryptSecret, +} from "../src/credentials"; import { createDatabase } from "../src/db/client"; import { TEST_POOL } from "./support/database"; import { agents, auditEvents, + credentials, credentials as credentialRows, mcpServers, mcpTools, + mcpUserCredentials, pluginGrants, + users, } from "../src/db/schema"; +import { catalogueEntry } from "../src/plugins/catalogue"; +import { redirectUriFor } from "../src/plugins/oauth"; import { + type AccessToken, createPluginStore, CustomServerRefusedError, + exchangeRefreshTokenOverHttp, + INVALID_CLIENT, + type OAuthClient, PluginRefusedError, + TokenRefusedError, + unlistedAdvertisedTools, } from "../src/plugins/store"; /** @@ -71,11 +95,15 @@ const store = createPluginStore({ credentials: { // No credential is ever read in these tests, because every call is refused before the vault. readSecret: async () => null, - // Nor created. Loud rather than absent: a call reaching this would mean this file had started - // exercising something it does not claim to, and a silent no-op would hide that. + // Nor written in place. Loud rather than absent: a call reaching either of these would mean + // this file had started exercising something it does not claim to, and a silent no-op would + // hide that. create: async () => { throw new Error("this suite does not write credentials"); }, + updateSecret: async () => { + throw new Error("this suite does not write credentials"); + }, // `removeServer` does revoke: it retires the token the server was configured with so a re-add // does not collide on `credentials_active_key_idx`. The stamp goes to the real row, because // `removeServer` reads liveness from the table before deciding whether to revoke at all. @@ -497,6 +525,90 @@ describe("removing an MCP server", () => { // `credentialId` is suite-scoped, so re-runs never collide. }); + /** + * The people's grants go too, not only the server's own token. + * + * `mcp_user_credentials` cascades on the server row, so removing a `user-oauth` connector used to + * delete every pointer and leave every refresh token in the vault live and unreferenced: reachable + * from no screen, revoked by no operation, and still a usable grant at the vendor. "We removed the + * connector" has to be true of the thing that matters, which is the token sitting at Notion. + */ + test("revokes every person's grant for the server it removes", async () => { + const removalServerId = `removal-target-people-${suite}`; + const connectedUserId = `user_removal_${suite}`; + revokedCredentialIds.length = 0; + + await database + .insert(users) + .values({ + id: connectedUserId, + email: `${connectedUserId}@openbot.test`, + name: connectedUserId, + emailVerified: false, + }) + .onConflictDoNothing(); + + const [grant] = await database + .insert(credentialRows) + .values({ + kind: "mcp_user_token", + provider: removalServerId, + keyId: connectedUserId, + encryptedValue: "{}", + metadata: {}, + }) + .returning({ id: credentialRows.id }); + const grantId = grant?.id; + if (!grantId) throw new Error("grant row was not created"); + issuedCredentialIds.push(grantId); + + await database.insert(mcpServers).values({ + id: removalServerId, + title: "removal target with people", + vendor: "test", + url: "https://example.invalid/mcp", + provenance: "custom", + }); + await database.insert(mcpUserCredentials).values({ + serverId: removalServerId, + userId: connectedUserId, + credentialId: grantId, + scope: "", + }); + + try { + await store.removeServer(removalServerId, "admin@openbot.local"); + + expect(revokedCredentialIds).toEqual([grantId]); + const [row] = await database + .select({ revokedAt: credentialRows.revokedAt }) + .from(credentialRows) + .where(eq(credentialRows.id, grantId)); + expect(row?.revokedAt).not.toBeNull(); + + // And the trail says whose access ended and why, which is the row an auditor reaches for. + const trail = await database + .select({ + eventType: auditEvents.eventType, + owner: sql<string>`payload ->> 'owner'`, + reason: sql<string>`payload ->> 'reason'`, + }) + .from(auditEvents) + .where( + and( + eq(auditEvents.targetType, "mcp_server"), + eq(auditEvents.targetId, removalServerId), + eq(auditEvents.eventType, "mcp.account_disconnected"), + ), + ); + expect(trail).toHaveLength(1); + expect(trail[0]?.owner).toBe(connectedUserId); + expect(trail[0]?.reason).toBe("mcp_server_removed"); + } finally { + await database.delete(users).where(eq(users.id, connectedUserId)); + } + }); + test("does not call revoke when the server had no credential", async () => { const removalServerId = `removal-target-nocred-${suite}`; revokedCredentialIds.length = 0; @@ -617,130 +729,1677 @@ describe("a grant on a tool the vendor no longer lists", () => { }); /** - * Which credential a custom server is allowed to be pointed at. + * A vendor that hands back a new refresh token every time it is asked for access. * - * `addCustomServer` takes the pointer from the request body, and the add itself dereferences it: the - * refresh that follows decrypts whatever it names and sends it to the URL from the same request. So - * the pointer is the whole control. An administrator naming somebody's `mcp_user_token` was enough - * to have that person's decrypted token delivered to an address the administrator chose, before any - * grant, policy check or Bot existed. + * Notion does. The token it was shown is dead the moment it answers, so a deployment that keeps the + * old one has spent somebody's connection on a single call: the next one presents a token the vendor + * has already invalidated, and the person is told to connect again for no reason they can see. That + * makes persisting the new token part of the exchange rather than bookkeeping after it, and it makes + * two concurrent calls a problem — both would present the same token, and one of them would lose. * - * `POST /api/admin/credentials` already refuses to *mint* a `mcp_user_token` by hand, and says why: - * it would be "creating a credential attributed to a person who never agreed to it". Pointing at one - * spends that credential on the same person's behalf, which is the same objection. + * This suite needs a REAL vault, unlike the store fixture above: rotation re-encrypts the row the + * connection already points at, and a stub that throws cannot show that happening — nor show that + * nothing else was written. So it builds its own store, with the vendor and its token endpoint + * injected and everything else genuine. */ -describe("a custom server may only be pointed at its own kind of credential", () => { - const suffix = randomUUID().slice(0, 8); - const deploymentCredentialId = randomUUID(); - const personalCredentialId = randomUUID(); - const oauthClientCredentialId = randomUUID(); - const customServerId = `custom-cred-${suffix}`; - const madeServerIds: string[] = []; +describe("refresh token rotation", () => { + const rotationBotId = `agent_rotation_bot_${suite}`; + const rotationUserId = `user_rotation_${suite}`; + /** Notion, because it is the entry whose vendor actually rotates. */ + const rotationServerId = "notion"; + /** Suite-scoped, so it cannot collide with a name Notion really advertises. */ + const rotationToolName = `search_${suite}`; + const rotationRef = `${rotationServerId}/${rotationToolName}`; + /** + * 32 zero bytes in base64. + * + * A real AES-256 key length, unlike the `"x".repeat(44)` the fixture above gets away with: every + * call there is refused before the vault is opened, and every call here goes through it. + */ + const ROTATION_KEY = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="; + const CLIENT = { clientId: "notion-client", clientSecret: "notion-secret" }; + /** Notion has no scope strings; the connection stores what the vendor said, which is nothing. */ + const SCOPE = ""; + + /** Every vault row this suite created, so the cleanup can take exactly those. */ + const vaultRows: string[] = []; + /** Every access token the store was about to send to the vendor, in order. */ + const sent: string[] = []; + /** + * The exchange, as a sequence of the moments it entered and left. + * + * Recorded as a log rather than as a count because the property under test is an ORDERING: two + * exchanges for one connection must not overlap. A log makes an overlap visible without the test + * having to guess when to look. + */ + const log: string[] = []; + /** What each exchange received and what it rotated to, which is the pairing rotation is about. */ + const exchanges: { received: string; returned?: string }[] = []; + /** What the vendor's token endpoint does, installed per test. */ + let mint: (refreshToken: string) => Promise<AccessToken> = async () => { + throw new Error("no exchange was installed for this test"); + }; + + /** + * The vault, wired once and shared by every store this describe builds. + * + * Shared deliberately: a second replica of this deployment reads and writes the same rows through + * the same code, and a per-store copy of the wiring would be a second place for the fixture to + * drift from what production does. + */ + const vault = { + readSecret: async (id: string) => { + const [row] = await database + .select({ + encryptedValue: credentials.encryptedValue, + revokedAt: credentials.revokedAt, + }) + .from(credentials) + .where(eq(credentials.id, id)); + return row ?? null; + }, + create: async (value: CredentialStoreValue) => { + const [row] = await database + .insert(credentials) + .values(value) + .returning({ id: credentials.id, revokedAt: credentials.revokedAt }); + if (!row) throw new Error("credential was not stored"); + vaultRows.push(row.id); + return row; + }, + /* + * The vault's own in-place update, not a stand-in for it. + * + * This is the write rotation now performs, and the suite asserts the ROW it leaves behind: the + * same id, re-encrypted, nothing added. A hand-rolled copy of the statement here would assert + * the copy rather than the vault — and would not join the caller's transaction, which is the + * whole of what keeps two replicas from spending one refresh token twice. + */ + updateSecret: createCredentialStore(database).updateSecret, + /* + * The real swap and the real key lookup too: `credentials_active_key_idx` holds one live row + * per key, so a reconnect in this suite replaces its previous token through the same + * transaction production uses. A stand-in would dodge the index the test data must obey. + */ + rotate: async ( + value: CredentialStoreValue & { previousCredentialId: string }, + ) => { + const stored = await createCredentialStore(database).rotate(value); + vaultRows.push(stored.id); + return stored; + }, + findLiveByKey: createCredentialStore(database).findLiveByKey, + isLive: createCredentialStore(database).isLive, + revoke: async (id: string) => { + const [row] = await database + .update(credentials) + .set({ revokedAt: new Date() }) + .where(eq(credentials.id, id)) + .returning({ revokedAt: credentials.revokedAt }); + if (!row?.revokedAt) throw new Error("credential was not revoked"); + return row.revokedAt; + }, + }; + + const rotationStore = createPluginStore({ + database, + auditStore: createAuditStore(database), + credentials: vault, + encryptionKey: ROTATION_KEY, + policy: () => policy, + // Stops before the network, and records what the call would have gone out with. + callVendor: async (connection) => { + sent.push(connection.token ?? "<none>"); + return { text: "[vendor not reached in tests]", isError: false }; + }, + exchangeRefreshToken: async ({ client, refreshToken }) => { + expect(client).toEqual(CLIENT); + log.push(`start:${refreshToken}`); + const minted = await mint(refreshToken); + log.push(`end:${refreshToken}`); + exchanges.push({ received: refreshToken, returned: minted.refreshToken }); + return minted; + }, + }); + + /** + * A second replica of this deployment, over the same database. + * + * The point of building the store again rather than calling the same one twice is what is NOT + * shared: the in-process map that queues one connection's exchanges belongs to a store instance, + * so two instances are as unserialised as two containers behind a load balancer. Whatever keeps + * them from spending one refresh token twice has to live in the database. + */ + function replica(exchange: (refreshToken: string) => Promise<AccessToken>) { + return createPluginStore({ + database, + auditStore: createAuditStore(database), + credentials: vault, + encryptionKey: ROTATION_KEY, + policy: () => policy, + callVendor: async () => ({ + text: "[vendor not reached in tests]", + isError: false, + }), + exchangeRefreshToken: async ({ refreshToken }) => exchange(refreshToken), + }); + } + + /** The deployment's OAuth client, which is what `mcp_servers.credential_id` holds. */ + async function registerClient() { + const [credential] = await database + .insert(credentials) + .values({ + kind: "mcp_oauth_client", + provider: rotationServerId, + keyId: "oauth-client", + metadata: { clientId: CLIENT.clientId }, + encryptedValue: await encryptSecret( + ROTATION_KEY, + JSON.stringify(CLIENT), + ), + }) + .returning({ id: credentials.id }); + if (!credential) throw new Error("client was not stored"); + vaultRows.push(credential.id); + await database + .update(mcpServers) + .set({ credentialId: credential.id }) + .where(eq(mcpServers.id, rotationServerId)); + } + + /** Which vault row this person's connection points at, so a swap is observable. */ + async function connectionCredential() { + const [row] = await database + .select({ credentialId: mcpUserCredentials.credentialId }) + .from(mcpUserCredentials) + .where( + and( + eq(mcpUserCredentials.serverId, rotationServerId), + eq(mcpUserCredentials.userId, rotationUserId), + ), + ); + return row?.credentialId ?? null; + } + + /** + * Every vault row this person's connection has ever had, live or revoked. + * + * The count is the point. A rotating vendor issues a new refresh token on every exchange, so a + * rotation that minted a row would leave one row per tool call here — which is invisible to any + * assertion that only looks at where the connection currently points. + */ + async function connectionVaultRows() { + return ( + database + .select({ + id: credentials.id, + encryptedValue: credentials.encryptedValue, + revokedAt: credentials.revokedAt, + }) + .from(credentials) + .where( + and( + eq(credentials.kind, "mcp_user_token"), + eq(credentials.provider, rotationServerId), + eq(credentials.keyId, rotationUserId), + ), + ) + // Ordered, so that comparing the whole list before and after is comparing the rows rather + // than whatever order the database felt like returning them in. + .orderBy(credentials.id) + ); + } + + /** How many times this person is recorded as having connected their account. */ + async function connectedRows() { + return ( + await database + .select({ actor: sql<string>`payload ->> 'actor'` }) + .from(auditEvents) + .where( + and( + eq(auditEvents.eventType, "mcp.account_connected"), + eq(auditEvents.targetId, rotationServerId), + sql`payload ->> 'actor' = ${rotationUserId}`, + ), + ) + ).length; + } + + /** Waiting for something the other call does, rather than for a duration. */ + async function waitUntil(condition: () => boolean, what: string) { + for (let attempt = 0; attempt < 300; attempt += 1) { + if (condition()) return; + await new Promise((resolve) => setTimeout(resolve, 10)); + } + throw new Error(`timed out waiting for ${what}`); + } + + /** A connection holding `rt-1`, written through the store so the vault is exercised. */ + async function connect() { + await rotationStore.recordConnection({ + serverId: rotationServerId, + userId: rotationUserId, + refreshToken: "rt-1", + scope: SCOPE, + }); + log.length = 0; + exchanges.length = 0; + sent.length = 0; + } + + let notionWasAlreadyConfigured = false; + /** + * The OAuth client this deployment had before the suite ran, restored afterwards. + * + * `mcp_servers.credential_id` is live configuration, and this suite repoints it. Restored + * unconditionally, because the delete below removes the row it would otherwise still address. + */ + let clientBefore: string | null = null; beforeAll(async () => { - const encrypted = await encryptSecret( - `${"A".repeat(43)}=`, - "not-read-here", + await database + .insert(agents) + .values({ + id: rotationBotId, + name: rotationBotId, + type: "remote_ag_ui", + configuration: {}, + }) + .onConflictDoNothing(); + await database + .insert(users) + .values({ + id: rotationUserId, + email: `${rotationUserId}@openbot.test`, + name: rotationUserId, + emailVerified: false, + }) + .onConflictDoNothing(); + + const [existing] = await database + .select({ id: mcpServers.id, credentialId: mcpServers.credentialId }) + .from(mcpServers) + .where(eq(mcpServers.id, rotationServerId)); + notionWasAlreadyConfigured = existing !== undefined; + clientBefore = existing?.credentialId ?? null; + + // Written directly, so the test needs no vendor to be reachable. What is under test is which + // refresh token the next exchange presents, not the listing. + await database + .insert(mcpServers) + .values({ + id: rotationServerId, + title: "Notion", + vendor: "Notion", + url: "https://mcp.notion.com/mcp", + provenance: "first-party", + }) + .onConflictDoNothing(); + await database + .insert(mcpTools) + .values({ + serverId: rotationServerId, + name: rotationToolName, + description: "Search pages.", + }) + .onConflictDoNothing(); + await rotationStore.grant( + "mcp", + rotationRef, + rotationBotId, + "admin@openbot.local", ); - await database.insert(credentialRows).values([ - { - id: deploymentCredentialId, - kind: "mcp", - provider: customServerId, - keyId: customServerId, - encryptedValue: encrypted, - metadata: {}, - }, - { - id: personalCredentialId, - kind: "mcp_user_token", - provider: "google-drive", - // For a user token the key is the person, which is what makes one pickable by name from the - // administrator's own credential list. - keyId: `user_someone_else_${suffix}`, - encryptedValue: encrypted, - metadata: {}, - }, - { - id: oauthClientCredentialId, - kind: "mcp_oauth_client", - provider: "google-drive", - keyId: "google-drive", - encryptedValue: encrypted, - metadata: {}, - }, - ]); + await registerClient(); }); afterAll(async () => { - // By prefix, not by the ids this suite meant to make: before the fix the refused adds succeed, - // and a row left behind holds a foreign key onto the credentials deleted just below. + // This suite's own person, never every row for this vendor: the id carries the run's suffix. await database - .delete(mcpServers) - .where(like(mcpServers.id, `${customServerId}%`)); + .delete(mcpUserCredentials) + .where( + and( + eq(mcpUserCredentials.serverId, rotationServerId), + eq(mcpUserCredentials.userId, rotationUserId), + ), + ); + // Before the deletes, because the column addresses one of the rows they remove. await database - .delete(credentialRows) + .update(mcpServers) + .set({ credentialId: clientBefore }) + .where(eq(mcpServers.id, rotationServerId)); + for (const id of vaultRows) { + await database.delete(credentials).where(eq(credentials.id, id)); + } + await database + .delete(pluginGrants) .where( - inArray(credentialRows.id, [ - deploymentCredentialId, - personalCredentialId, - oauthClientCredentialId, - ]), + and( + eq(pluginGrants.ref, rotationRef), + eq(pluginGrants.agentId, rotationBotId), + ), + ); + await database + .delete(mcpTools) + .where( + and( + eq(mcpTools.serverId, rotationServerId), + eq(mcpTools.name, rotationToolName), + ), ); + // A server row is deployment configuration, so it goes only if this suite is what added it. + if (!notionWasAlreadyConfigured) { + await database + .delete(mcpTools) + .where(eq(mcpTools.serverId, rotationServerId)); + await database + .delete(mcpServers) + .where(eq(mcpServers.id, rotationServerId)); + } + await database.delete(agents).where(eq(agents.id, rotationBotId)); + await database.delete(users).where(eq(users.id, rotationUserId)); }); - test("somebody else's connector token is refused, and no server is written", async () => { - const id = `${customServerId}-personal`; - await expect( - store.addCustomServer({ - id, - title: "Collector", - url: "https://collector.example/mcp", - credentialId: personalCredentialId, - by: "admin@example.com", - }), - ).rejects.toBeInstanceOf(CustomServerRefusedError); + test("the list says which servers register their own OAuth client", async () => { + // Notion is dynamic (RFC 7591, registered by this deployment on first connect); Google Drive + // is not — an administrator pastes its client in, so the paste-a-client form still has a job + // to do there. The field distinguishes the two so the admin screen can hide the form only + // where it would otherwise be filled in with nothing to type. + const servers = await store.listServers(); + const notion = servers.find((server) => server.id === rotationServerId); + const drive = servers.find((server) => server.id === serverId); + expect(notion?.dynamicClient).toBe(true); + expect(drive?.dynamicClient).toBe(false); + }); - // The refusal has to stop the write, not merely report on it: a row here is a pointer the next - // refresh would dereference. - const rows = await database - .select({ id: mcpServers.id }) - .from(mcpServers) - .where(eq(mcpServers.id, id)); - expect(rows).toHaveLength(0); + test("the token the vendor rotated to is the one the next call presents", async () => { + await connect(); + const before = await connectionCredential(); + const rowsBefore = await connectionVaultRows(); + const connectedBefore = await connectedRows(); + mint = async () => ({ accessToken: "at-1", refreshToken: "rt-2" }); + + await rotationStore.callTool({ + ref: rotationRef, + args: {}, + botId: rotationBotId, + actorId: rotationUserId, + }); + await rotationStore.callTool({ + ref: rotationRef, + args: {}, + botId: rotationBotId, + actorId: rotationUserId, + }); + + // The whole property: the second exchange presented what the first was given back. + expect(exchanges.map((exchange) => exchange.received)).toEqual([ + "rt-1", + "rt-2", + ]); + // Both calls went out with an access token, so neither was refused on the way. + expect(sent).toEqual(["at-1", "at-1"]); + + /* + * Two rotations, and the vault holds exactly what it held before: the same row, still live, + * carrying the latest token. + * + * This is the whole reason rotation is in place rather than a swap. Every single call to a + * rotating vendor rotates, so minting a row per rotation would grow the vault without bound on + * the hottest path there is — and would revoke a grant the vendor had already killed itself the + * moment it handed the new token back. + */ + const after = await connectionCredential(); + expect(after).toBe(before); + const rowsAfter = await connectionVaultRows(); + expect(rowsAfter.map((row) => row.id)).toEqual( + rowsBefore.map((row) => row.id), + ); + const live = rowsAfter.filter((row) => row.revokedAt === null); + expect(live.map((row) => row.id)).toEqual([before]); + // And the row that stayed is the one the vendor rotated to, not the one it replaced. + expect( + await decryptSecret(ROTATION_KEY, live[0]?.encryptedValue ?? ""), + ).toBe("rt-2"); + + // And nothing claims the person connected an account again. Rotation is the vendor's plumbing, + // not somebody's act, and a trail that says otherwise is read as a re-consent that never + // happened. + expect(await connectedRows()).toBe(connectedBefore); }); - test("the deployment's OAuth client is refused too", async () => { - // Not a per-person secret, but not this server's token either, and handing a vendor its own - // client secret as a bearer token is the mistake `refreshTools` was already changed to avoid. - const id = `${customServerId}-client`; - await expect( - store.addCustomServer({ - id, - title: "Collector", - url: "https://collector.example/mcp", - credentialId: oauthClientCredentialId, - by: "admin@example.com", - }), - ).rejects.toBeInstanceOf(CustomServerRefusedError); + test("a vendor that does not rotate leaves the connection alone", async () => { + await connect(); + const before = await connectionCredential(); + // Google's reply: an access token and nothing else. Repointing anything here would be inventing + // a rotation the vendor did not perform. + mint = async () => ({ accessToken: "at-1" }); + + await rotationStore.callTool({ + ref: rotationRef, + args: {}, + botId: rotationBotId, + actorId: rotationUserId, + }); + await rotationStore.callTool({ + ref: rotationRef, + args: {}, + botId: rotationBotId, + actorId: rotationUserId, + }); + + expect(exchanges.map((exchange) => exchange.received)).toEqual([ + "rt-1", + "rt-1", + ]); + // Said explicitly, because it is the condition the store branches on: no refresh token came + // back at all. A test that only checked the connection was untouched would pass just as well + // against a store that rotated to the token it already held. + expect(exchanges.map((exchange) => exchange.returned)).toEqual([ + undefined, + undefined, + ]); + expect(await connectionCredential()).toBe(before); }); - test("a credential that does not exist is refused the same way", async () => { - // Same message as the wrong-kind refusal on purpose. A caller who can tell "wrong kind" from - // "no such row" can ask this endpoint which ids are real, which is a vault oracle. - const id = `${customServerId}-missing`; - const missing = store.addCustomServer({ - id, - title: "Collector", - url: "https://collector.example/mcp", - credentialId: randomUUID(), - by: "admin@example.com", + test("a vendor that hands the same token back writes nothing", async () => { + await connect(); + const before = await connectionVaultRows(); + // Notion's reply when the grant did not move: a fresh access token and the refresh token we + // presented. Nothing rotated, so there is nothing to persist. + mint = async () => ({ accessToken: "at-1", refreshToken: "rt-1" }); + + await rotationStore.callTool({ + ref: rotationRef, + args: {}, + botId: rotationBotId, + actorId: rotationUserId, }); - await expect(missing).rejects.toBeInstanceOf(CustomServerRefusedError); - const wrongKind = store - .addCustomServer({ - id: `${customServerId}-kind-message`, + /* + * Byte-identical, which is a stronger claim than "same row". + * + * Encryption draws a fresh IV every time, so re-encrypting the very same token would leave a + * different envelope in the same row. An untouched envelope is the only evidence that the write + * did not happen at all. + */ + expect(await connectionVaultRows()).toEqual(before); + expect(sent).toEqual(["at-1"]); + }); + + test("two calls at once take turns, and the second spends what the first was given", async () => { + await connect(); + let release: (minted: AccessToken) => void = () => {}; + const parked = new Promise<AccessToken>((resolve) => { + release = resolve; + }); + let asked = 0; + mint = async () => { + asked += 1; + // The first exchange hangs until this test lets it finish. The second must not have started. + return asked === 1 + ? parked + : { accessToken: "at-2", refreshToken: "rt-3" }; + }; + + const both = Promise.allSettled([ + rotationStore.callTool({ + ref: rotationRef, + args: {}, + botId: rotationBotId, + actorId: rotationUserId, + }), + rotationStore.callTool({ + ref: rotationRef, + args: {}, + botId: rotationBotId, + actorId: rotationUserId, + }), + ]); + + try { + await waitUntil(() => log.length > 0, "the first exchange to start"); + /* + * Long enough for a second, unserialised call to reach the vendor on its own. Its queries are + * a few milliseconds against a local database, so an overlapping exchange would be in the log + * by now — and with the exchanges serialised, waiting changes nothing at all. + */ + await new Promise((resolve) => setTimeout(resolve, 250)); + expect(log).toEqual(["start:rt-1"]); + } finally { + release({ accessToken: "at-1", refreshToken: "rt-2" }); + } + + const results = await both; + expect(results.map((result) => result.status)).toEqual([ + "fulfilled", + "fulfilled", + ]); + // One after another, never interleaved, and the second presented the first's rotated token — + // which is only possible because the first persisted it before answering. + expect(log).toEqual(["start:rt-1", "end:rt-1", "start:rt-2", "end:rt-2"]); + expect(exchanges).toEqual([ + { received: "rt-1", returned: "rt-2" }, + { received: "rt-2", returned: "rt-3" }, + ]); + }); + + /** + * Two replicas, one connection, and the vendor shown each refresh token exactly once. + * + * This is the case the in-process queue cannot reach. Each replica has its own map, so both read + * the stored token, both present it, and a vendor with refresh-token-reuse detection reads the + * second presentation as a stolen token and revokes the whole family — bricking a connection that + * nobody did anything wrong with. The row lock is what makes the second replica wait and then read + * what the first rotated to. + */ + test("two replicas take turns at the row, and neither spends a token twice", async () => { + await connect(); + /** Every refresh token the vendor was shown, by either replica, in order. */ + const presented: string[] = []; + let issued = 1; + const exchange = async (refreshToken: string) => { + presented.push(refreshToken); + /* + * Long enough that an unlocked second replica has read the vault and presented what it found + * there before this exchange answers. With the lock held it changes nothing except how long + * the other replica waits for its turn. + */ + await new Promise((resolve) => setTimeout(resolve, 50)); + issued += 1; + return { accessToken: `at-${issued}`, refreshToken: `rt-${issued}` }; + }; + const first = replica(exchange); + const second = replica(exchange); + + const call = (store: ReturnType<typeof replica>) => + store.callTool({ + ref: rotationRef, + args: {}, + botId: rotationBotId, + actorId: rotationUserId, + }); + const results = await Promise.all([call(first), call(second)]); + + expect(results.map((result) => result.isError)).toEqual([false, false]); + // The whole property. `["rt-1", "rt-1"]` is the double-spend: two replicas presenting one token. + expect(presented).toEqual(["rt-1", "rt-2"]); + // And the row the connection points at carries the last token issued, so a third call would + // present that rather than something either replica had already spent. + const live = (await connectionVaultRows()).filter( + (row) => row.revokedAt === null, + ); + expect( + await decryptSecret(ROTATION_KEY, live[0]?.encryptedValue ?? ""), + ).toBe("rt-3"); + }); +}); + +/** + * A client this deployment registered for itself, which the vendor has since forgotten. + * + * A dynamically registered client is nobody's paperwork: there is no console entry an administrator + * could go and re-create, so a vendor that evicts one — a pruned test client, an expired + * registration — would otherwise strand every connection to that server behind a refusal nobody in + * the deployment can act on. The one thing the deployment CAN do is introduce itself again, which is + * exactly what it did the first time, so it does that once and retries. + * + * Once, and only once. A retry that re-registered on every refusal would answer a vendor outage by + * minting clients in a loop, and the second refusal is the honest signal that the problem is not the + * client at all. + */ +describe("a dynamic client the vendor has evicted", () => { + const dynamicBotId = `agent_dynamic_bot_${suite}`; + const dynamicUserId = `user_dynamic_${suite}`; + /** Notion, because it is the entry that registers itself. */ + const dynamicServerId = "notion"; + /** Suite-scoped, so it cannot collide with a name Notion really advertises. */ + const dynamicToolName = `search_dyn_${suite}`; + const dynamicRef = `${dynamicServerId}/${dynamicToolName}`; + /** 32 zero bytes in base64: a real AES-256 key, because every call here opens the vault. */ + const DYNAMIC_KEY = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="; + /** The client the deployment registered once and the vendor has stopped honouring. */ + const EVICTED: OAuthClient = { clientId: "dyn-1", clientSecret: "" }; + /** What registering again gets. No secret: a DCR client proves itself with PKCE. */ + const FRESH: OAuthClient = { clientId: "dyn-2", clientSecret: "" }; + /** Built the way the callback route builds it, so the vendor is offered the real thing. */ + const REDIRECT_URI = redirectUriFor("https://openbot.test"); + /** The pinned endpoint, read from the entry rather than copied, so the two cannot drift. */ + const REGISTRATION_URL = (() => { + const entry = catalogueEntry(dynamicServerId); + if (entry?.auth.kind !== "user-oauth" || !entry.auth.registrationUrl) { + throw new Error( + "notion is not a dynamically registered user-oauth entry", + ); + } + return entry.auth.registrationUrl; + })(); + const SCOPE = ""; + + /** Every vault row this suite created, so the cleanup can take exactly those. */ + const vaultRows: string[] = []; + /** Which client each exchange was offered, in order. One entry per call, never two. */ + const offered: string[] = []; + /** + * Every exchange as the pair it really is: which client presented which grant. + * + * The pair is the property, not either half. A refresh token belongs to the client it was issued + * to — RFC 6749 §6 has the token endpoint check exactly that, and §10.4 says why — so a pair + * naming a token under a client it was never issued to is this deployment attempting to spend one + * client's grant as another's. No call may ever produce one. + */ + const exchanges: { clientId: string; refreshToken: string }[] = []; + /** Which client the vendor issued each refresh token to, so the stub can enforce the binding. */ + const issuedTo = new Map<string, string>(); + /** Every registration the store asked the vendor for, with what it asked with. */ + const registrations: { registrationUrl: string; redirectUri: string }[] = []; + /** Which client ids the vendor still honours. Anything else is answered `invalid_client`. */ + let accepted = new Set<string>(); + /** What the vendor's registration endpoint hands back, installed per test. */ + let issue: () => OAuthClient | null = () => { + throw new Error("no registration was installed for this test"); + }; + + /* + * The real vault, with every row it mints written down. + * + * Genuine rather than stubbed, because what this suite asserts is that a re-registered client is + * KEPT — which is a write and a read back through the encryption, not a call that was made. The + * one wrapper is the bookkeeping that lets the cleanup take exactly this suite's rows. + */ + const realVault = createCredentialStore(database); + const vault = { + ...realVault, + /* + * The executor is FORWARDED, and dropping it is not a detail. + * + * The store hands its own transaction to the vault so that a secret and the pointer that names it + * commit together. A wrapper that swallows it has the insert run on a second pooled connection + * instead — which, with the caller holding the first and a sibling holding the second, is not a + * slower write but a deadlock: the insert waits for a connection only a transaction that is + * waiting for the insert can release. + */ + create: async ( + value: Parameters<typeof realVault.create>[0], + executor?: Parameters<typeof realVault.create>[1], + ) => { + const row = await realVault.create(value, executor); + vaultRows.push(row.id); + return row; + }, + }; + + /** + * How the vendor refuses a client it no longer honours. + * + * Both halves of what `exchangeRefreshTokenOverHttp` builds for a reply carrying an `error` code: + * the sentence a person reads, and the code as a FIELD. The field is the half the retry + * reads, which is why it is set structurally here rather than spelled into the prose — two tests + * below vary each half independently to prove which one is load-bearing. + */ + const evictionRefusal = () => + new TokenRefusedError( + "The vendor would not renew this access (401). (invalid_client)", + INVALID_CLIENT, + ); + /** The refusal in force, so a test can vary the sentence or the code. Reset before each. */ + let refuse: () => Error = evictionRefusal; + + /* + * The exchange, standing in for the vendor's token endpoint. + */ + const seams = { + exchangeRefreshToken: async ({ + client, + refreshToken, + }: { + tokenUrl: string; + client: OAuthClient; + refreshToken: string; + }): Promise<AccessToken> => { + offered.push(client.clientId); + exchanges.push({ clientId: client.clientId, refreshToken }); + if (!accepted.has(client.clientId)) { + throw refuse(); + } + /* + * A grant belongs to one client, and this stub enforces it. + * + * It did not, and that omission is what made the old "register again and re-present the same + * refresh token" retry look like it worked. It only ever worked against a vendor that skipped + * the check RFC 6749 §6 requires — so the mechanism was pinned by a fixture whose behaviour + * would itself have been the vulnerability. + */ + const owner = issuedTo.get(refreshToken); + if (owner !== undefined && owner !== client.clientId) { + throw new TokenRefusedError( + "The vendor would not renew this access (400). (invalid_grant)", + "invalid_grant", + ); + } + // The same token back, so nothing rotates: what this suite is about is the client. + return { accessToken: `at-${client.clientId}`, refreshToken }; + }, + registerClient: async (input: { + registrationUrl: string; + redirectUri: string; + }) => { + registrations.push(input); + return issue(); + }, + }; + + const dynamicStore = createPluginStore({ + database, + auditStore: createAuditStore(database), + credentials: vault, + encryptionKey: DYNAMIC_KEY, + policy: () => policy, + callVendor: async () => ({ + text: "[vendor not reached in tests]", + isError: false, + }), + ...seams, + redirectUri: REDIRECT_URI, + }); + + /** + * The same store, for a deployment with no public URL. + * + * There is nowhere for the vendor to send anybody back to, so there is nothing honest to register + * — and registering a redirect URI that does not resolve would leave a client that can never + * complete a consent flow. + */ + const storeWithNoRedirect = createPluginStore({ + database, + auditStore: createAuditStore(database), + credentials: vault, + encryptionKey: DYNAMIC_KEY, + policy: () => policy, + ...seams, + }); + + /** + * Point the server at a client, the way a registration does, without going through one. + * + * Aged an hour by default, because that is the client these tests are about: one the deployment + * has been using for a while and the vendor has since evicted. A row written a moment ago is + * inside the re-registration window and is deliberately not registered around, which is its own + * test below rather than the state every other test starts from. + */ + async function putClient( + client: OAuthClient, + registeredAt = new Date(Date.now() - 60 * 60 * 1000), + ) { + /* + * One live client per key is law (`credentials_active_key_idx`), so planting a client the way a + * registration would means retiring whatever live row the key still holds from an earlier test. + */ + await database + .update(credentials) + .set({ revokedAt: new Date(), updatedAt: new Date() }) + .where( + and( + eq(credentials.kind, "mcp_oauth_client"), + eq(credentials.provider, dynamicServerId), + eq(credentials.keyId, `oauth-client-${dynamicServerId}`), + sql`${credentials.revokedAt} IS NULL`, + ), + ); + const [row] = await database + .insert(credentials) + .values({ + kind: "mcp_oauth_client", + provider: dynamicServerId, + keyId: `oauth-client-${dynamicServerId}`, + metadata: { clientId: client.clientId }, + encryptedValue: await encryptSecret( + DYNAMIC_KEY, + JSON.stringify(client), + ), + createdAt: registeredAt, + }) + .returning({ id: credentials.id }); + if (!row) throw new Error("client was not stored"); + vaultRows.push(row.id); + await database + .update(mcpServers) + .set({ credentialId: row.id }) + .where(eq(mcpServers.id, dynamicServerId)); + } + + /** A deployment that holds no client for this server at all. */ + async function clearClient(serverId = dynamicServerId) { + await database + .update(mcpServers) + .set({ credentialId: null }) + .where(eq(mcpServers.id, serverId)); + } + + /** + * How many of those rows say a particular actor registered a particular client. + * + * Counted rather than "the most recent row", because these rows have no ordering finer than the + * second they were written in and this suite writes several of them. + */ + const registeredBy = ( + rows: { actor: string; clientId: string }[], + actor: string, + clientId: string, + ) => + rows.filter((row) => row.actor === actor && row.clientId === clientId) + .length; + + /** What the trail says about clients registered for this server, and by whom. */ + async function registeredRows() { + return database + .select({ + actor: sql<string>`payload ->> 'actor'`, + clientId: sql<string>`payload ->> 'clientId'`, + }) + .from(auditEvents) + .where( + and( + eq(auditEvents.eventType, "mcp.oauth_client_registered"), + eq(auditEvents.targetId, dynamicServerId), + ), + ); + } + + /** + * A connection holding `rt-1`, written through the store so the vault is exercised. + * + * `issuedBy` is which client the vendor issued that grant to, which is the fact the stub above + * enforces. It is the evicted one in every test here, because that is what an eviction means: the + * grant somebody holds was obtained under the client the vendor has since stopped honouring. + */ + async function connect(issuedBy: OAuthClient = EVICTED) { + await dynamicStore.recordConnection({ + serverId: dynamicServerId, + userId: dynamicUserId, + refreshToken: "rt-1", + scope: SCOPE, + }); + issuedTo.set("rt-1", issuedBy.clientId); + offered.length = 0; + exchanges.length = 0; + registrations.length = 0; + } + + /** One tool call by the connected person, which is every call this suite makes. */ + const call = () => + dynamicStore.callTool({ + ref: dynamicRef, + args: {}, + botId: dynamicBotId, + actorId: dynamicUserId, + }); + + let notionWasAlreadyConfigured = false; + /** This deployment's own client, restored afterwards: the column is live configuration. */ + let clientBefore: string | null = null; + + // The vendor refuses the ordinary way unless a test says otherwise, so a test that varies the + // refusal cannot leave the next one asserting against somebody else's setup. + beforeEach(() => { + refuse = evictionRefusal; + }); + + beforeAll(async () => { + await database + .insert(agents) + .values({ + id: dynamicBotId, + name: dynamicBotId, + type: "remote_ag_ui", + configuration: {}, + }) + .onConflictDoNothing(); + await database + .insert(users) + .values({ + id: dynamicUserId, + email: `${dynamicUserId}@openbot.test`, + name: dynamicUserId, + emailVerified: false, + }) + .onConflictDoNothing(); + + const [existing] = await database + .select({ id: mcpServers.id, credentialId: mcpServers.credentialId }) + .from(mcpServers) + .where(eq(mcpServers.id, dynamicServerId)); + notionWasAlreadyConfigured = existing !== undefined; + clientBefore = existing?.credentialId ?? null; + + await database + .insert(mcpServers) + .values({ + id: dynamicServerId, + title: "Notion", + vendor: "Notion", + url: "https://mcp.notion.com/mcp", + provenance: "first-party", + }) + .onConflictDoNothing(); + await database + .insert(mcpTools) + .values({ + serverId: dynamicServerId, + name: dynamicToolName, + description: "Search pages.", + }) + .onConflictDoNothing(); + await dynamicStore.grant( + "mcp", + dynamicRef, + dynamicBotId, + "admin@openbot.local", + ); + }); + + afterAll(async () => { + await database + .delete(mcpUserCredentials) + .where( + and( + eq(mcpUserCredentials.serverId, dynamicServerId), + eq(mcpUserCredentials.userId, dynamicUserId), + ), + ); + // Before the deletes, because the column addresses one of the rows they remove. + await database + .update(mcpServers) + .set({ credentialId: clientBefore }) + .where(eq(mcpServers.id, dynamicServerId)); + for (const id of vaultRows) { + await database.delete(credentials).where(eq(credentials.id, id)); + } + await database + .delete(pluginGrants) + .where( + and( + eq(pluginGrants.ref, dynamicRef), + eq(pluginGrants.agentId, dynamicBotId), + ), + ); + await database + .delete(mcpTools) + .where( + and( + eq(mcpTools.serverId, dynamicServerId), + eq(mcpTools.name, dynamicToolName), + ), + ); + if (!notionWasAlreadyConfigured) { + await database + .delete(mcpTools) + .where(eq(mcpTools.serverId, dynamicServerId)); + await database + .delete(mcpServers) + .where(eq(mcpServers.id, dynamicServerId)); + } + await database.delete(agents).where(eq(agents.id, dynamicBotId)); + await database.delete(users).where(eq(users.id, dynamicUserId)); + }); + + test("the deployment registers again, once, and refuses this call", async () => { + await putClient(EVICTED); + await connect(); + const registeredBefore = await registeredRows(); + // The vendor honours the fresh client, so a retry under it is exactly what would have LOOKED + // like a recovery. The point of this test is that it is not attempted. + accepted = new Set([FRESH.clientId]); + issue = () => FRESH; + + /* + * The person is told to connect again, because that is the only thing that can help them. + * + * Their refresh token was issued to the client the vendor has forgotten, and a grant belongs to + * the client it was issued to. There is no arrangement of stored secrets that turns it into a + * usable one — only a new consent under the client that now exists. + */ + await expect(call()).rejects.toThrow( + "Notion no longer recognises this deployment's OAuth client", + ); + + /* + * One exchange, on the client the deployment held. The old grant is never presented to the new + * client: a conforming vendor refuses that (RFC 6749 §6), so the retry that used to be here + * could only ever have succeeded against a vendor whose acceptance was itself the bug. + */ + expect(offered).toEqual([EVICTED.clientId]); + expect(exchanges).toEqual([ + { clientId: EVICTED.clientId, refreshToken: "rt-1" }, + ]); + + // Registered exactly once, with the pinned endpoint and the deployment's own redirect URI — + // never a URL from the request, which is the property `redirectUriFor` exists for. + expect(registrations).toEqual([ + { registrationUrl: REGISTRATION_URL, redirectUri: REDIRECT_URI }, + ]); + + // And kept, so the connect this refusal sends somebody to uses the client that works. + expect(await dynamicStore.oauthClientFor(dynamicServerId)).toEqual(FRESH); + + /* + * With a row in the trail saying the deployment did it to itself. + * + * `deployment` rather than the person whose call triggered it: they consented to nothing here, + * and a trail naming them would read as an administrator having registered a client. + */ + const registered = await registeredRows(); + expect(registered.length).toBe(registeredBefore.length + 1); + expect(registeredBy(registered, "deployment", FRESH.clientId)).toBe( + registeredBy(registeredBefore, "deployment", FRESH.clientId) + 1, + ); + }); + + test("a vendor refusing everything costs one registration, not one per call", async () => { + await putClient(EVICTED); + await connect(); + // The vendor honours nothing, which is what an outage looks like from here. + accepted = new Set<string>(); + issue = () => ({ clientId: "dyn-3", clientSecret: "" }); + + await expect(call()).rejects.toThrow( + "Notion no longer recognises this deployment's OAuth client", + ); + expect(registrations.length).toBe(1); + expect(exchanges).toEqual([ + { clientId: EVICTED.clientId, refreshToken: "rt-1" }, + ]); + + /* + * The next call is a NEW call, not a retry: it reads the client the deployment now holds, offers + * it once, and is refused. What it must not do is register a second one — dyn-3 was stored + * moments ago, so it is inside the re-registration window and is left alone. That is the + * difference between an outage costing one client and costing one per tool call. + */ + exchanges.length = 0; + await expect(call()).rejects.toThrow("invalid_client"); + expect(registrations.length).toBe(1); + expect(exchanges).toEqual([{ clientId: "dyn-3", refreshToken: "rt-1" }]); + }); + + /** + * A client minted moments ago is not registered around again. + * + * Once per call is right for one call and wrong for a deployment: a vendor answering every + * exchange `invalid_client` — an outage, not an eviction — has every tool call anywhere in the + * deployment mint a client of its own, because each of them is the first refusal it has seen. + * The age of the stored client is the one piece of shared state that says otherwise, and a client + * younger than the window is already the product of somebody's re-registration. + */ + test("a client registered moments ago is refused rather than replaced", async () => { + // Written now, the way a re-registration would have written it a moment ago. + await putClient(EVICTED, new Date()); + await connect(); + accepted = new Set<string>(); + issue = () => FRESH; + + // The vendor's own refusal, surfaced as it stands: nothing here can improve on it. + await expect(call()).rejects.toThrow("invalid_client"); + + expect(registrations).toEqual([]); + expect(offered).toEqual([EVICTED.clientId]); + expect(exchanges).toEqual([ + { clientId: EVICTED.clientId, refreshToken: "rt-1" }, + ]); + }); + + /** + * The code decides, not the sentence. + * + * The sentence is written for a person and will be reworded — shortened, translated, given a + * different parenthesis. When the recovery hung on a substring of it, any of those edits would + * have switched self-registration off with every test in this file still passing, and the symptom + * would have been every Notion connection in the deployment stranded behind a refusal. + */ + test("a refusal that words it differently still re-registers", async () => { + await putClient(EVICTED); + await connect(); + accepted = new Set([FRESH.clientId]); + issue = () => FRESH; + // Not one character of the code anywhere in the prose. + refuse = () => + new TokenRefusedError( + "Le fournisseur a refusé de renouveler cet accès (401).", + INVALID_CLIENT, + ); + + await expect(call()).rejects.toThrow( + "Notion no longer recognises this deployment's OAuth client", + ); + + expect(offered).toEqual([EVICTED.clientId]); + expect(registrations.length).toBe(1); + expect(await dynamicStore.oauthClientFor(dynamicServerId)).toEqual(FRESH); + }); + + /** And the other way round: prose that says the word, over a code that does not. */ + test("a refusal whose code is another one is not registered around", async () => { + await putClient(EVICTED); + await connect(); + accepted = new Set<string>(); + issue = () => FRESH; + refuse = () => + new TokenRefusedError( + "The vendor would not renew this access (400). (invalid_grant, not an invalid_client problem)", + "invalid_grant", + ); + + await expect(call()).rejects.toThrow("invalid_grant"); + + // A withdrawn grant is the person's to fix by connecting again. Minting a client for it would + // leave a spare client behind and still refuse. + expect(registrations).toEqual([]); + expect(offered).toEqual([EVICTED.clientId]); + }); + + /** + * Two calls queued on one connection, and one registration between them. + * + * The client is read INSIDE the per-connection critical section, so the second call reads it after + * the first has replaced it. Read before the queue instead, both calls would carry the evicted + * client in, both would be refused, and both would register — a client minted per queued call, on + * a deployment whose client the first call already replaced. + * + * Both calls fail, and they fail differently, which is the honest outcome. The first found the + * client evicted; the second offered the client that now exists and was refused because the grant + * it holds was issued to the old one. Only a new consent fixes that, and both refusals say so. + */ + test("two calls queued on one connection register once between them", async () => { + await putClient(EVICTED); + await connect(); + accepted = new Set([FRESH.clientId]); + issue = () => FRESH; + + const results = await Promise.allSettled([call(), call()]); + + expect(results.map((result) => result.status)).toEqual([ + "rejected", + "rejected", + ]); + // One exchange per call, and never a token offered twice inside one of them. + expect(offered).toEqual([EVICTED.clientId, FRESH.clientId]); + expect(registrations.length).toBe(1); + }); + + test("a client the deployment already holds is handed back untouched", async () => { + await putClient(EVICTED); + registrations.length = 0; + + expect( + await dynamicStore.ensureOAuthClient( + dynamicServerId, + "someone@openbot.test", + ), + ).toEqual(EVICTED); + // Nothing was asked of the vendor: this is the path every connect takes once, and it must not + // mint a client on top of the working one. + expect(registrations).toEqual([]); + }); + + test("a dynamic entry with no client gets one, kept and recorded", async () => { + await clearClient(); + registrations.length = 0; + const registeredBefore = await registeredRows(); + issue = () => FRESH; + + expect( + await dynamicStore.ensureOAuthClient( + dynamicServerId, + "someone@openbot.test", + ), + ).toEqual(FRESH); + expect(registrations).toEqual([ + { registrationUrl: REGISTRATION_URL, redirectUri: REDIRECT_URI }, + ]); + expect(await dynamicStore.oauthClientFor(dynamicServerId)).toEqual(FRESH); + + const registered = await registeredRows(); + expect(registered.length).toBe(registeredBefore.length + 1); + // Whoever pressed Connect, because for a first registration that IS the act that caused it. + expect( + registeredBy(registered, "someone@openbot.test", FRESH.clientId), + ).toBe( + registeredBy(registeredBefore, "someone@openbot.test", FRESH.clientId) + + 1, + ); + }); + + test("an entry an administrator registers by hand is left alone", async () => { + /* + * Drive, whose client is pasted in from Google's console. Registering one for it would be + * inventing a client at a vendor that never offered to issue one — the honest answer is none, + * and the 409 an administrator sees is the instruction to go and paste one. + */ + const [before] = await database + .select({ credentialId: mcpServers.credentialId }) + .from(mcpServers) + .where(eq(mcpServers.id, serverId)); + await clearClient(serverId); + registrations.length = 0; + + try { + expect( + await dynamicStore.ensureOAuthClient(serverId, "someone@openbot.test"), + ).toBeNull(); + expect(registrations).toEqual([]); + } finally { + await database + .update(mcpServers) + .set({ credentialId: before?.credentialId ?? null }) + .where(eq(mcpServers.id, serverId)); + } + }); + + test("a deployment with no public URL registers nothing", async () => { + await clearClient(); + registrations.length = 0; + + expect( + await storeWithNoRedirect.ensureOAuthClient( + dynamicServerId, + "someone@openbot.test", + ), + ).toBeNull(); + expect(registrations).toEqual([]); + }); + + /** + * Two people pressing Connect at the same moment, on a deployment holding no client yet. + * + * `POST /connect` is `requireUser`, not `requireAdmin`, so this is not a rare interleaving — it is + * the ordinary first hour of a connector nobody has used. Unserialised, the two runs read "no live + * client" and then both write one: the second `create` meets the first on + * `credentials_active_key_idx` as a raw 23505, which reaches the person as a 500 where a consent + * URL belonged, and a `rotate` racing the same way fails with "Previous credential is already + * revoked" instead. + * + * One client, not two, and that part is not only about the error. Two clients means one of the two + * consent screens names a client the vault no longer holds, so that person consents and their + * callback then redeems the code against the other client — a connect that fails after the vendor + * said yes, which is the hardest possible place to fail. + */ + test("two first connects race to one client, and both callers get it", async () => { + await clearClient(); + // No live row for the key either, so this really is a deployment holding nothing: `clearClient` + // only drops the pointer, and it is the KEY the index constrains. + await database + .update(credentials) + .set({ revokedAt: new Date(), updatedAt: new Date() }) + .where( + and( + eq(credentials.kind, "mcp_oauth_client"), + eq(credentials.provider, dynamicServerId), + eq(credentials.keyId, `oauth-client-${dynamicServerId}`), + sql`${credentials.revokedAt} IS NULL`, + ), + ); + registrations.length = 0; + // A distinct client per registration, so two registrations cannot be mistaken for one. + let issued = 0; + issue = () => { + issued += 1; + return { clientId: `dyn-race-${issued}`, clientSecret: "" }; + }; + + const [first, second] = await Promise.all([ + dynamicStore.ensureOAuthClient(dynamicServerId, "one@openbot.test"), + dynamicStore.ensureOAuthClient(dynamicServerId, "two@openbot.test"), + ]); + + // Neither raised, and neither got null: both people can be sent to consent. + expect(first).not.toBeNull(); + expect(second).not.toBeNull(); + // The same client, so both consent screens name the client the deployment actually holds. + expect(first).toEqual(second); + expect(registrations.length).toBe(1); + + /* + * One live row for the key, and the server row naming exactly it. + * + * The pair is the assertion, not either half: the vault write and the pointer write are one + * transaction now, so a reader can never see a live client the server row does not name, nor a + * server row naming a client the vault retired. + */ + const live = await database + .select({ id: credentials.id }) + .from(credentials) + .where( + and( + eq(credentials.kind, "mcp_oauth_client"), + eq(credentials.provider, dynamicServerId), + eq(credentials.keyId, `oauth-client-${dynamicServerId}`), + sql`${credentials.revokedAt} IS NULL`, + ), + ); + expect(live.length).toBe(1); + const [server] = await database + .select({ credentialId: mcpServers.credentialId }) + .from(mcpServers) + .where(eq(mcpServers.id, dynamicServerId)); + expect(server?.credentialId).toBe(live[0]?.id); + }); + + /** + * A refresh naming the advertised tools this deployment's write list does not cover. + * + * Notion has no scope strings and no read-only scope: access is per-page, chosen on the consent + * screen, so `writeTools` plus the action policy are the ENTIRE write barrier. The entry's own + * comment says reconciling that list against the live tool list "is required, not cosmetic" — and + * until this row existed, nothing mechanical did it. An advertised tool missing from the list + * classifies as a READ ({@link classifyTool}), so under-inclusion is the failure mode and it is + * silent. + * + * The vendor here is a real MCP server on localhost, reached by pointing the pinned host at it for + * the length of this test. The host is pinned for good reasons and nothing in the store will take a + * URL from a caller, so the seam is fetch — which is also the honest one: what is under test is + * what a real listing over the real protocol produces. + */ + test("a refresh names the advertised tools no write list covers", async () => { + await putClient(EVICTED); + await connect(); + accepted = new Set([EVICTED.clientId]); + + /** Suite-scoped, so it cannot be a name Notion really advertises, nor a name in `writeTools`. */ + const unlistedName = `notion-invent-${suite}`; + const mock = new MCPMock(); + mock + .addTool({ + name: "notion-create-pages", + description: "A write the list already names.", + inputSchema: { type: "object", properties: {} }, + }) + .addTool({ + name: unlistedName, + description: "Advertised, and named by no write list.", + inputSchema: { type: "object", properties: {} }, + }); + const mockUrl = await mock.start(); + + // What the deployment currently advertises for this server, because a refresh replaces the list + // wholesale and this one is pointing the vendor at a mock. + const advertisedBefore = await database + .select() + .from(mcpTools) + .where(eq(mcpTools.serverId, dynamicServerId)); + const [stampBefore] = await database + .select({ + toolsRefreshedAt: mcpServers.toolsRefreshedAt, + lastError: mcpServers.lastError, + }) + .from(mcpServers) + .where(eq(mcpServers.id, dynamicServerId)); + + const realFetch = globalThis.fetch; + globalThis.fetch = ((input: RequestInfo | URL, init?: RequestInit) => { + const target = String(input instanceof Request ? input.url : input); + return realFetch( + target.startsWith("https://mcp.notion.com") ? mockUrl : input, + init, + ); + }) as typeof fetch; + + try { + expect( + await dynamicStore.refreshTools(dynamicServerId, dynamicUserId), + ).toEqual({ tools: 2 }); + } finally { + globalThis.fetch = realFetch; + await mock.stop?.(); + await database + .delete(mcpTools) + .where(eq(mcpTools.serverId, dynamicServerId)); + if (advertisedBefore.length > 0) { + await database.insert(mcpTools).values(advertisedBefore); + } + await database + .update(mcpServers) + .set({ + toolsRefreshedAt: stampBefore?.toolsRefreshedAt ?? null, + lastError: stampBefore?.lastError ?? null, + }) + .where(eq(mcpServers.id, dynamicServerId)); + } + + const named = ( + await database + .select({ payload: auditEvents.payload }) + .from(auditEvents) + .where( + and( + eq(auditEvents.eventType, "configuration.changed"), + eq(auditEvents.targetId, dynamicServerId), + sql`payload ->> 'change' = 'unlisted_tools_advertised'`, + ), + ) + ).flatMap((row) => (row.payload as { tools?: string[] }).tools ?? []); + + // The one the list does not name, and never the one it does. + expect(named).toContain(unlistedName); + expect(named).not.toContain("notion-create-pages"); + }); + + /** + * What a failed refresh writes into `lastError`, and how much of it. + * + * The column is drawn on the admin page and parts of the sentence come from a vendor, so it is not + * a promise about length — the same reasoning `callTool` already applies to the failure it records. + * Capped at the same 400 characters, so the two agree. + */ + test("a refusal written to lastError is capped like every other vendor sentence", async () => { + await putClient(EVICTED); + await connect(); + // A refusal the retry cannot act on — no code at all — so it arrives unedited and long. + accepted = new Set<string>(); + refuse = () => new Error(`vendor said: ${"y".repeat(1_000)}`); + + const [before] = await database + .select({ lastError: mcpServers.lastError }) + .from(mcpServers) + .where(eq(mcpServers.id, dynamicServerId)); + + try { + // Zero tools and no throw: a refresh records its failure rather than raising it. + expect( + await dynamicStore.refreshTools(dynamicServerId, dynamicUserId), + ).toEqual({ tools: 0 }); + + const [row] = await database + .select({ lastError: mcpServers.lastError }) + .from(mcpServers) + .where(eq(mcpServers.id, dynamicServerId)); + expect(row?.lastError?.length).toBe(400); + expect(row?.lastError?.startsWith("vendor said: ")).toBe(true); + } finally { + // The column is live configuration an operator reads, so this suite puts back what it found. + await database + .update(mcpServers) + .set({ lastError: before?.lastError ?? null }) + .where(eq(mcpServers.id, dynamicServerId)); + } + }); + + /** + * The vault row and the pointer that names it commit together, or neither does. + * + * They were two transactions, so a failure between them left `mcp_user_credentials` naming a + * credential that had just been revoked — a connection that reads as live on the settings page and + * refuses every call. The pointer write is the one that can fail on its own: `user_id` is a real + * foreign key, so a person who is no longer in `users` is a genuine 23503 at exactly that + * statement, which is the injection this test uses rather than a spy. + */ + test("a pointer write that fails leaves no live grant behind", async () => { + const ghost = `user_ghost_${suite}`; + + await expect( + dynamicStore.recordConnection({ + serverId: dynamicServerId, + userId: ghost, + refreshToken: "rt-ghost", + scope: SCOPE, + }), + ).rejects.toThrow(); + + // Nothing in the vault, live or otherwise: the insert that minted it was rolled back with the + // pointer write that failed. Asked of the key, because that is what a later connect collides on. + const rows = await database + .select({ id: credentials.id }) + .from(credentials) + .where( + and( + eq(credentials.kind, "mcp_user_token"), + eq(credentials.provider, dynamicServerId), + eq(credentials.keyId, ghost), + ), + ); + expect(rows).toEqual([]); + }); +}); + +/** + * Which credential a custom server is allowed to be pointed at. + * + * `addCustomServer` takes the pointer from the request body, and the add itself dereferences it: the + * refresh that follows decrypts whatever it names and sends it to the URL from the same request. So + * the pointer is the whole control. An administrator naming somebody's `mcp_user_token` was enough + * to have that person's decrypted token delivered to an address the administrator chose, before any + * grant, policy check or Bot existed. + * + * `POST /api/admin/credentials` already refuses to *mint* a `mcp_user_token` by hand, and says why: + * it would be "creating a credential attributed to a person who never agreed to it". Pointing at one + * spends that credential on the same person's behalf, which is the same objection. + */ +describe("a custom server may only be pointed at its own kind of credential", () => { + const suffix = randomUUID().slice(0, 8); + const deploymentCredentialId = randomUUID(); + const personalCredentialId = randomUUID(); + const oauthClientCredentialId = randomUUID(); + /** + * The upsert case gets its own token, because a credential names the server it was minted for and + * that case adds a second server id. Sharing one row across two ids is a shape `storeMcpToken` + * cannot produce: it sets the provider to the server it is minting for, every time. + */ + const upsertCredentialId = randomUUID(); + const customServerId = `custom-cred-${suffix}`; + const madeServerIds: string[] = []; + + beforeAll(async () => { + const encrypted = await encryptSecret( + `${"A".repeat(43)}=`, + "not-read-here", + ); + await database.insert(credentialRows).values([ + { + id: deploymentCredentialId, + kind: "mcp", + provider: customServerId, + keyId: customServerId, + encryptedValue: encrypted, + metadata: {}, + }, + { + id: personalCredentialId, + kind: "mcp_user_token", + provider: "google-drive", + // For a user token the key is the person, which is what makes one pickable by name from the + // administrator's own credential list. + keyId: `user_someone_else_${suffix}`, + encryptedValue: encrypted, + metadata: {}, + }, + { + id: upsertCredentialId, + kind: "mcp", + provider: `${customServerId}-upsert`, + keyId: `${customServerId}-upsert`, + encryptedValue: encrypted, + metadata: {}, + }, + { + id: oauthClientCredentialId, + kind: "mcp_oauth_client", + provider: "google-drive", + keyId: "google-drive", + encryptedValue: encrypted, + metadata: {}, + }, + ]); + }); + + afterAll(async () => { + // By prefix, not by the ids this suite meant to make: before the fix the refused adds succeed, + // and a row left behind holds a foreign key onto the credentials deleted just below. + await database + .delete(mcpServers) + .where(like(mcpServers.id, `${customServerId}%`)); + await database + .delete(credentialRows) + .where( + inArray(credentialRows.id, [ + deploymentCredentialId, + personalCredentialId, + oauthClientCredentialId, + ]), + ); + }); + + test("somebody else's connector token is refused, and no server is written", async () => { + const id = `${customServerId}-personal`; + await expect( + store.addCustomServer({ + id, + title: "Collector", + url: "https://collector.example/mcp", + credentialId: personalCredentialId, + by: "admin@example.com", + }), + ).rejects.toBeInstanceOf(CustomServerRefusedError); + + // The refusal has to stop the write, not merely report on it: a row here is a pointer the next + // refresh would dereference. + const rows = await database + .select({ id: mcpServers.id }) + .from(mcpServers) + .where(eq(mcpServers.id, id)); + expect(rows).toHaveLength(0); + }); + + test("the deployment's OAuth client is refused too", async () => { + // Not a per-person secret, but not this server's token either, and handing a vendor its own + // client secret as a bearer token is the mistake `refreshTools` was already changed to avoid. + const id = `${customServerId}-client`; + await expect( + store.addCustomServer({ + id, + title: "Collector", + url: "https://collector.example/mcp", + credentialId: oauthClientCredentialId, + by: "admin@example.com", + }), + ).rejects.toBeInstanceOf(CustomServerRefusedError); + }); + + test("a credential that does not exist is refused the same way", async () => { + // Same message as the wrong-kind refusal on purpose. A caller who can tell "wrong kind" from + // "no such row" can ask this endpoint which ids are real, which is a vault oracle. + const id = `${customServerId}-missing`; + const missing = store.addCustomServer({ + id, + title: "Collector", + url: "https://collector.example/mcp", + credentialId: randomUUID(), + by: "admin@example.com", + }); + await expect(missing).rejects.toBeInstanceOf(CustomServerRefusedError); + + const wrongKind = store + .addCustomServer({ + id: `${customServerId}-kind-message`, title: "Collector", url: "https://collector.example/mcp", credentialId: personalCredentialId, @@ -818,7 +2477,7 @@ describe("a custom server may only be pointed at its own kind of credential", () id, title: "Collector", url: "https://collector.example/mcp", - credentialId: deploymentCredentialId, + credentialId: upsertCredentialId, by: "admin@example.com", }); @@ -836,7 +2495,7 @@ describe("a custom server may only be pointed at its own kind of credential", () .select({ credentialId: mcpServers.credentialId }) .from(mcpServers) .where(eq(mcpServers.id, id)); - expect(row?.credentialId).toBe(deploymentCredentialId); + expect(row?.credentialId).toBe(upsertCredentialId); }); test("a custom server with no credential at all still works", async () => { @@ -851,3 +2510,133 @@ describe("a custom server may only be pointed at its own kind of credential", () expect(added.id).toBe(id); }); }); + +/** + * Which advertised names a vendor's write list does not cover, as a rule on its own. + * + * Unit-tested here as well as through a refresh, because the rule is the part that decides whether + * anybody ever hears about an under-inclusive write list, and it has two branches a live listing + * cannot show side by side: a vendor whose consent screen is the whole barrier, and one whose own + * scope is read-only. The entries are the real ones, so a catalogue edit that removed Drive's + * read-only scope would fail here rather than start filing rows about Drive. + */ +describe("advertised tools a write list does not name", () => { + test("a Notion tool absent from the write list is named, sorted", () => { + expect( + unlistedAdvertisedTools(catalogueEntry("notion"), [ + "notion-search", + "notion-create-pages", + "notion-fetch", + ]), + ).toEqual(["notion-fetch", "notion-search"]); + }); + + test("a write the list already names is not", () => { + expect( + unlistedAdvertisedTools(catalogueEntry("notion"), [ + "notion-create-pages", + ]), + ).toEqual([]); + }); + + /* + * Drive's grant is `drive.readonly`, so a tool missing from its write list cannot write whatever + * this deployment believes about it — the vendor refuses. Filing rows about it would be noise + * standing between somebody and the vendor where it is the only barrier. + */ + test("a vendor whose own scope is read-only is not reconciled here", () => { + expect( + unlistedAdvertisedTools(catalogueEntry("google-drive"), [ + "search_files", + "made_up_tool", + ]), + ).toEqual([]); + }); + + /** A server an administrator added by URL: every tool of theirs is already a write. */ + test("a server nobody reviewed is not reconciled here either", () => { + expect(unlistedAdvertisedTools(null, ["anything"])).toEqual([]); + }); +}); + +/** + * What the real token endpoint said, read by the real exchange. + * + * Every other suite in this file injects `exchangeRefreshToken`, because what they are about is which + * credential a call goes out with rather than how a reply is parsed. That leaves the parsing itself — + * the one part that meets a vendor's actual bytes — with nothing exercising it, and the interesting + * bytes are the dishonest ones: a 200 carrying a CDN interstitial rather than a token. + */ +describe("a vendor reply that is not a token", () => { + const replyClient: OAuthClient = { clientId: "c-1", clientSecret: "" }; + + test("a 200 that is not JSON is a refusal, not a thrown parse error", async () => { + const realFetch = globalThis.fetch; + globalThis.fetch = (async () => + new Response("<html>checking your browser</html>", { + status: 200, + headers: { "content-type": "text/html" }, + })) as unknown as typeof fetch; + try { + /* + * The refusal this module already knows how to carry, rather than a SyntaxError. + * + * An unguarded parse throws out of here into `callTool`, which records it as `mcp.call_failed` + * with the parser's message — and that message quotes the vendor's body, so an interstitial's + * HTML ends up in an audit payload and in front of the person who asked. + */ + await expect( + exchangeRefreshTokenOverHttp({ + tokenUrl: "https://vendor.example/token", + client: replyClient, + refreshToken: "rt-1", + }), + ).rejects.toThrow( + "The vendor answered this renewal with something other than a token.", + ); + } finally { + globalThis.fetch = realFetch; + } + }); + + test("a 200 with JSON and no access token is still the refusal it always was", async () => { + const realFetch = globalThis.fetch; + globalThis.fetch = (async () => + new Response(JSON.stringify({ token_type: "bearer" }), { + status: 200, + headers: { "content-type": "application/json" }, + })) as unknown as typeof fetch; + try { + await expect( + exchangeRefreshTokenOverHttp({ + tokenUrl: "https://vendor.example/token", + client: replyClient, + refreshToken: "rt-1", + }), + ).rejects.toThrow("The vendor renewed this access with no token."); + } finally { + globalThis.fetch = realFetch; + } + }); + + /** The error branch, which already read defensively: the status survives an unparseable body. */ + test("a refusal that is not JSON keeps the status, which is the one fact there is", async () => { + const realFetch = globalThis.fetch; + globalThis.fetch = (async () => + new Response("<html>502</html>", { + status: 502, + headers: { "content-type": "text/html" }, + })) as unknown as typeof fetch; + try { + await expect( + exchangeRefreshTokenOverHttp({ + tokenUrl: "https://vendor.example/token", + client: replyClient, + refreshToken: "rt-1", + }), + ).rejects.toThrow("The vendor would not renew this access (502)."); + } finally { + globalThis.fetch = realFetch; + } + }); +}); diff --git a/server/tests/plugin-user-credential.integration.test.ts b/server/tests/plugin-user-credential.integration.test.ts index 08ca92b4..c097ec19 100644 --- a/server/tests/plugin-user-credential.integration.test.ts +++ b/server/tests/plugin-user-credential.integration.test.ts @@ -114,6 +114,11 @@ const store = createPluginStore({ create: async () => { throw new Error("this suite writes credentials directly"); }, + // Google does not rotate, so no exchange here ever reaches the in-place update. Loud, so that + // one starting to would show up rather than pass quietly. + updateSecret: async () => { + throw new Error("this suite writes credentials directly"); + }, /* * A real revocation, against this suite's own rows. * diff --git a/server/tests/server-side-tools.integration.test.ts b/server/tests/server-side-tools.integration.test.ts index d0fbffd4..eb5c58bc 100644 --- a/server/tests/server-side-tools.integration.test.ts +++ b/server/tests/server-side-tools.integration.test.ts @@ -31,7 +31,7 @@ import { TEST_POOL } from "./support/database"; const database = createDatabase( process.env.DATABASE_URL ?? - "postgres://openkai:openkai@localhost:5432/openkai", + "postgres://openbot:openbot@localhost:5432/openbot", TEST_POOL, ); diff --git a/server/tests/work-queue.integration.test.ts b/server/tests/work-queue.integration.test.ts new file mode 100644 index 00000000..a7397e6a --- /dev/null +++ b/server/tests/work-queue.integration.test.ts @@ -0,0 +1,326 @@ +import { afterAll, beforeEach, describe, expect, test } from "bun:test"; +import { randomUUID } from "node:crypto"; +import { and, eq } from "drizzle-orm"; +import { createDatabase } from "../src/db/client"; +import { workItems } from "../src/db/schema"; +import { createWorkQueue } from "../src/work/queue"; +import { TEST_POOL } from "./support/database"; + +/** + * The one mechanism suspending idle computers, running routines and handing work between Bots all + * need, driven against a real PostgreSQL rather than a fake. + * + * A fake cannot answer the only question worth asking here. `for update skip locked` is a promise + * the database makes about two transactions racing, and a stub that returns rows in order would pass + * every test below while the real thing handed one item to two replicas. + */ +const database = createDatabase( + process.env.DATABASE_URL ?? + "postgres://openbot:openbot@localhost:5432/openbot", + TEST_POOL, +); +const queue = createWorkQueue(database); +const kind = `test.${randomUUID().slice(0, 8)}`; + +afterAll(async () => { + await database.delete(workItems).where(eq(workItems.kind, kind)); + await database.$client.end({ timeout: 5 }); +}); + +beforeEach(async () => { + await database.delete(workItems).where(eq(workItems.kind, kind)); +}); + +describe("claiming durable work", () => { + test("one replica takes a due item, and it comes back with what it is about", async () => { + await queue.offer({ kind, key: "bot-a", payload: { botId: "bot-a" } }); + + const claimed = await queue.claim({ + kind, + owner: "replica-1", + leaseMs: 30_000, + }); + + expect(claimed).toHaveLength(1); + expect(claimed[0]?.key).toBe("bot-a"); + expect(claimed[0]?.payload).toEqual({ botId: "bot-a" }); + // First time out, so whatever runs this knows it has certainly not run before. + expect(claimed[0]?.attempts).toBe(1); + }); + + test("a second replica does not get an item the first is holding", async () => { + await queue.offer({ kind, key: "bot-a" }); + + const first = await queue.claim({ + kind, + owner: "replica-1", + leaseMs: 30_000, + }); + const second = await queue.claim({ + kind, + owner: "replica-2", + leaseMs: 30_000, + }); + + expect(first).toHaveLength(1); + expect(second).toHaveLength(0); + }); + + /* + * THE TEST THIS FILE EXISTS FOR. + * + * Ten replicas reaching for ten items at the same moment must between them take each item once. + * Anything less than `skip locked` fails here: plain `for update` serialises and one transaction + * waits behind another, and no locking at all hands the same row to several claimants, which for a + * routine is the same run billed N times. + */ + test("ten replicas racing for ten items take each of them exactly once", async () => { + const keys = Array.from({ length: 10 }, (_, index) => `bot-${index}`); + for (const key of keys) await queue.offer({ kind, key }); + + const results = await Promise.all( + Array.from({ length: 10 }, (_, index) => + queue.claim({ + kind, + owner: `replica-${index}`, + leaseMs: 30_000, + limit: 3, + }), + ), + ); + + const taken = results.flat().map((item) => item.key); + expect(taken).toHaveLength(10); + expect(new Set(taken).size).toBe(10); + }); + + test("a lease that stopped being renewed comes back to whoever asks next", async () => { + await queue.offer({ kind, key: "bot-a" }); + // Claimed by a replica that then dies: nothing renews, and the lease is already in the past. + await queue.claim({ kind, owner: "replica-1", leaseMs: -1 }); + + const recovered = await queue.claim({ + kind, + owner: "replica-2", + leaseMs: 30_000, + }); + + expect(recovered).toHaveLength(1); + /* + * Second time out, which is the number that matters. Whatever picks this up has to be able to + * tell "this never started" from "this started and we lost the process", because the second may + * already have called a tool and spent money. + */ + expect(recovered[0]?.attempts).toBe(2); + }); + + test("renewing keeps a claim, and cannot steal one back after it was lost", async () => { + await queue.offer({ kind, key: "bot-a" }); + await queue.claim({ kind, owner: "replica-1", leaseMs: -1 }); + await queue.claim({ kind, owner: "replica-2", leaseMs: 30_000 }); + + // Replica 1 wakes up and tries to keep a claim that is no longer its own. + const stale = await queue.renew({ + kind, + key: "bot-a", + owner: "replica-1", + leaseMs: 30_000, + }); + const current = await queue.renew({ + kind, + key: "bot-a", + owner: "replica-2", + leaseMs: 30_000, + }); + + expect(stale).toBe(false); + expect(current).toBe(true); + }); + + test("offering the same work twice leaves one item", async () => { + /* + * Idempotence, which is where every recovery path stops being a duplicate-run path. A routine + * due at 07:00 is offered by every replica that wakes; the key carries the minute, so they are + * all offering the same thing. + */ + await queue.offer({ kind, key: "routine:daily:2026-08-24T07:00" }); + await queue.offer({ kind, key: "routine:daily:2026-08-24T07:00" }); + await queue.offer({ kind, key: "routine:daily:2026-08-24T07:00" }); + + const rows = await database + .select({ key: workItems.key }) + .from(workItems) + .where(eq(workItems.kind, kind)); + expect(rows).toHaveLength(1); + }); + + test("an item that is not due yet is not claimed", async () => { + await queue.offer({ + kind, + key: "later", + runAt: new Date(Date.now() + 60_000), + }); + + expect( + await queue.claim({ kind, owner: "replica-1", leaseMs: 30_000 }), + ).toHaveLength(0); + }); + + /* + * The idempotence this table promises has to survive completion. + * + * Finishing used to delete the row, so the insert a re-offer was supposed to collide with had + * nothing left to collide with: a routine due at 07:00 that had already run was handed straight + * back to the next replica to wake late, and ran twice. Every recovery path was a duplicate-run + * path. + */ + test("a finished item stays, so re-offering the same key runs nothing", async () => { + await queue.offer({ kind, key: "bot-a" }); + await queue.claim({ kind, owner: "replica-1", leaseMs: 30_000 }); + expect(await queue.finish({ kind, key: "bot-a", owner: "replica-1" })).toBe( + true, + ); + + await queue.offer({ kind, key: "bot-a" }); + + expect( + await queue.claim({ kind, owner: "replica-2", leaseMs: 30_000 }), + ).toHaveLength(0); + }); + + test("finished rows are swept once they are past their retention", async () => { + await queue.offer({ kind, key: "bot-a" }); + await queue.claim({ kind, owner: "replica-1", leaseMs: 30_000 }); + await queue.finish({ kind, key: "bot-a", owner: "replica-1" }); + + expect(await queue.purge({ kind, olderThanMs: 60_000 })).toBe(0); + expect(await queue.purge({ kind, olderThanMs: 0 })).toBe(1); + }); + + test("releasing frees the item and holds it back for a while", async () => { + await queue.offer({ kind, key: "bot-a" }); + await queue.claim({ kind, owner: "replica-1", leaseMs: 30_000 }); + await queue.release({ + kind, + key: "bot-a", + owner: "replica-1", + delayMs: 60_000, + }); + + // Free, but not yet due, so nobody picks it straight back up and spins on it. + expect( + await queue.claim({ kind, owner: "replica-2", leaseMs: 30_000 }), + ).toHaveLength(0); + }); + + /* + * Both of these are the same bug from two ends: the lease says who may act on an item, and only + * `renew` used to ask. A replica whose lease had quietly gone could delete or reschedule work + * another replica was in the middle of doing. + */ + test("a replica that lost its lease cannot finish somebody else's work", async () => { + await queue.offer({ kind, key: "bot-a" }); + await queue.claim({ kind, owner: "replica-1", leaseMs: 1 }); + await Bun.sleep(30); + await queue.claim({ kind, owner: "replica-2", leaseMs: 30_000 }); + + expect(await queue.finish({ kind, key: "bot-a", owner: "replica-1" })).toBe( + false, + ); + + const [row] = await database + .select({ by: workItems.claimedBy, done: workItems.finishedAt }) + .from(workItems) + .where(and(eq(workItems.kind, kind), eq(workItems.key, "bot-a"))); + expect(row?.by).toBe("replica-2"); + expect(row?.done).toBeNull(); + }); + + test("a replica that lost its lease cannot reschedule somebody else's work", async () => { + await queue.offer({ kind, key: "bot-a" }); + await queue.claim({ kind, owner: "replica-1", leaseMs: 1 }); + await Bun.sleep(30); + await queue.claim({ kind, owner: "replica-2", leaseMs: 30_000 }); + + expect( + await queue.release({ + kind, + key: "bot-a", + owner: "replica-1", + delayMs: 60_000, + }), + ).toBe(false); + + const [row] = await database + .select({ by: workItems.claimedBy }) + .from(workItems) + .where(and(eq(workItems.kind, kind), eq(workItems.key, "bot-a"))); + expect(row?.by).toBe("replica-2"); + }); + + /* + * Two clocks pretending to be one. + * + * The lease was computed as `Date.now() + leaseMs` on the replica and compared against `now()` in + * Postgres. A node behind the database wrote a live lease that arrived already expired, and the + * next replica to look took the item out from under it. Both ran it. Every moment is named in SQL + * now, so a wrong local clock cannot produce one. + */ + test("a replica whose clock is behind still holds a real lease", async () => { + await queue.offer({ kind, key: "bot-a" }); + + const realNow = Date.now; + Date.now = () => realNow() - 90_000; + try { + await queue.claim({ kind, owner: "replica-1", leaseMs: 60_000 }); + } finally { + Date.now = realNow; + } + + expect( + await queue.claim({ kind, owner: "replica-2", leaseMs: 60_000 }), + ).toHaveLength(0); + }); + + /* + * A permanently failing item has to stop somewhere a person can see, rather than retrying until + * somebody notices, which on a queue with no dashboard is never. + */ + test("an item stops being offered once it runs out of attempts", async () => { + await queue.offer({ kind, key: "bot-a" }); + + for (let attempt = 0; attempt < 3; attempt += 1) { + const [item] = await queue.claim({ + kind, + owner: "replica-1", + leaseMs: 30_000, + maxAttempts: 3, + }); + expect(item?.attempts).toBe(attempt + 1); + await queue.release({ + kind, + key: "bot-a", + owner: "replica-1", + delayMs: 0, + reason: "the cluster said no", + }); + } + + expect( + await queue.claim({ + kind, + owner: "replica-1", + leaseMs: 30_000, + maxAttempts: 3, + }), + ).toHaveLength(0); + + // Still here, with its count and its reason, which is the terminal state rather than a silence. + const [row] = await database + .select({ attempts: workItems.attempts, why: workItems.lastError }) + .from(workItems) + .where(and(eq(workItems.kind, kind), eq(workItems.key, "bot-a"))); + expect(row?.attempts).toBe(3); + expect(row?.why).toBe("the cluster said no"); + }); +}); diff --git a/server/tsconfig.json b/server/tsconfig.json index 4bd6962d..8858dd28 100644 --- a/server/tsconfig.json +++ b/server/tsconfig.json @@ -1,4 +1,11 @@ { "extends": "../tsconfig.base.json", - "include": ["src"] + // `scripts` too: the migration runner and the culler entrypoint ship in the image, so they are + // product code that happens to live outside `src`. + // + // `tests` is NOT here yet, and that is a known gap rather than a decision: the suite has never been + // type-checked and turning it on surfaces a few hundred years of accumulated `any`. It is what let + // a test pass an options object where a connection string belongs and hear nothing back. Its own + // change, because it is a sweep and not a fix. + "include": ["src", "scripts"] } diff --git a/tests/compose.test.ts b/tests/compose.test.ts index ac18455f..b7261b3e 100644 --- a/tests/compose.test.ts +++ b/tests/compose.test.ts @@ -121,3 +121,35 @@ test("runs migrations after PostgreSQL becomes healthy", () => { expect(compose).toContain("condition: service_healthy"); expect(compose).toContain('"drizzle-kit", "migrate"'); }); + +/** + * Per-Bot egress reaches the processes that read it. + * + * `EGRESS_PROXY_<BOT>` and `EGRESS_PROXY_DEFAULT` are resolved from `process.env` by the computer + * itself (`agent-computer/src/egress.ts`), and the supervisor forwards every `EGRESS_PROXY` key out + * of its own environment into each computer it creates (`supervisor/src/index.ts`). Compose gives a + * container only what its `environment:` and `env_file:` blocks name, and for a long time neither + * named these, so an operator who configured a proxy per the documentation got a browser that went + * out directly and no error saying so. + * + * A file rather than `environment:` entries because the names are per-Bot and therefore not knowable + * here, and a file of its own rather than `.env` because that one holds the deployment's secrets and + * the browser container is deliberately not given them. + */ +test("carries per-Bot egress into the computer and the supervisor", () => { + const compose = readFileSync( + join(import.meta.dir, "..", "docker-compose.yml"), + "utf8", + ); + + // Both halves: the shared computer reads them itself, and the supervisor passes them on. + const services = compose.split(/^ {2}(?=\S)/m); + for (const name of ["agent-computer:", "supervisor:"]) { + const service = services.find((block) => block.startsWith(name)); + expect(service).toBeDefined(); + expect(service).toContain("egress.env"); + } + + // Optional, because a deployment with no proxy is the ordinary case and must still start. + expect(compose).toContain("required: false"); +});