Skip to content

[Do not merge] Trigger CI for Supervisor API PR - #492

Closed
pkosiec wants to merge 9 commits into
mainfrom
pkosiec/temp-supervisor-api
Closed

[Do not merge] Trigger CI for Supervisor API PR#492
pkosiec wants to merge 9 commits into
mainfrom
pkosiec/temp-supervisor-api

Conversation

@pkosiec

Copy link
Copy Markdown
Member

Apply Mario's defensive/correctness fixes from the supervisor API adapter
review without touching the public API shape (sections 1-8 will land in a
stacked branch). Highlights:
High
- Route the three SSE error-leak sites in supervisor-api.ts (streamBody
catch, mapEvent "error", output_item.done with id="error") through a
single emitError helper that returns a stable client-facing code
(`Supervisor API error (transport|upstream_failed|upstream_tool|
upstream_unknown)`) and logs the verbose detail server-side only.
Addresses CWE-209 verbatim-upstream-error-text leak.
Medium
- Gate the terminal {status:"complete"} emission on lastCompleted.status
/ .error / .incomplete_details so a `response.completed` with a nested
failed status no longer silently succeeds; surface as upstream_failed
instead. Regression tests added.
- Skip the terminal error in the streamBody catch when signal.aborted —
consumer-initiated aborts now end with a clean stop, not a contradictory
terminal error event. Regression test added.
- Tighten the output_item.done error match: require item.type === "error"
(or pair the reserved id="error" with a non-message type) so a stray
assistant message with id="error" is not mis-classified.
- Add maxLineChars / maxBufferChars caps to readSseEvents with 1 MiB / 8
MiB defaults; throw on overflow. Addresses CWE-770. Tests added.
- Docs: add a CWE-1427 callout warning that hosted-tool `description` is a
prompt-injection sink — do not derive it from untrusted input.
- Redact the no-delta warning log: summariseErrorPayload extracts a short
`type: message` line; full payload only via DEBUG. Addresses CWE-532.
- Gate the buffer-level CRLF normalize in sse-reader on `\r` presence to
skip the regex on LF-only steady state.
Low
- mapEvent("error") fallback no longer wraps "Unknown error" with literal
JSON quotes (uses string branch).
- Drop the misleading "we await the factory at module init" comment in
dev-playground; the code never awaits.
- Fix @example imports in supervisor-api.ts JSDoc to use
@databricks/appkit/beta (the actual public re-export).
- Replace trimStart() with single-U+0020 strip in sse-reader per the SSE
spec; remove the now-dead per-line `\r$` strip after the buffer-level
CRLF normalise.
- Flag streamPath as @internal in connectors/serving/client.ts noting the
CWE-918 SSRF risk if it ever leaks to user-controlled input.
- Add JSDoc warning to workspaceClient on SupervisorApiAdapterOptions:
passing a per-request OBO client would leak identity across requests
(CWE-664).
Signed-off-by: Hubert Zub <hubert.zub@databricks.com>
Signed-off-by: Hubert Zub <hubert.zub@databricks.com>
Address structural feedback from Mario Cadenas' review of PR #345 (sections
1-8). Stacked on top of the §9 defensive fixes commit.
API changes (BETA surface only):
- Add `DatabricksAdapter.fromSupervisorApi` static factory for discoverability
alongside `.fromChatCompletions`.
- Shrink `SupervisorApiAdapterOptions` to `{ model, workspaceClient? }`; tools
no longer live on the adapter.
- Hosted tools (`supervisorTools.*`) now return tagged `HostedSupervisorTool`
records and accept named options instead of positional args.
- Declare hosted tools on the agent's `tools` map (same place as function
tools / sub-agents); the agents plugin and `runAgent` route them to the
adapter via the new `AgentInput.extensions[SUPERVISOR_EXTENSION_KEY]`.
- Add capability-negotiation fields to `AgentAdapter`:
`acceptsExtensions?` + `consumesInputTools?`. The agents plugin and
`runAgent` warn at registration when adapter capabilities don't match
declared tools.
Internals:
- Extend `ResolvedToolEntry` / `StandaloneEntry` with a `hosted-supervisor`
branch; `classifyTool` matches it before MCP hosted-tool rejection so
standalone `runAgent` supports supervisor tools.
- Defense-in-depth: both indexers throw if a `hosted-supervisor` entry is
ever dispatched as a callable function.
- `DatabricksAdapter.fromSupervisorApi` uses a dynamic import to avoid
load-time cycles.
Docs:
- Rewrite supervisor-API section in docs/plugins/agents.md for the new shape.
- Add cross-adapter sub-agent composition note (one-directional: chat
parents can call supervisor children, not vice-versa, until SA's
function-call events are routed back through `context.executeTool`).
Playground:
- Update dev-playground supervisor agent to the new shape
(`DatabricksAdapter.fromSupervisorApi(...)` + tools on `createAgent`).
Tests:
- Rewrite supervisor-api.test.ts factory + adapter tests for the new shape.
- Add `isSupervisorTool` and `DatabricksAdapter.fromSupervisorApi` tests.
- New regression tests in `run-agent.test.ts` covering the
hosted-supervisor extension-routing path and both capability-mismatch
warnings.
- New agents-plugin tests covering the same warning paths and the new
`hosted-supervisor` tool-index branch.
Signed-off-by: Hubert Zub <hubert.zub@databricks.com>
Signed-off-by: Hubert Zub <hubert.zub@databricks.com>
@pkosiecpkosiec changed the title [Do not merge] [Do not merge] Trigger CI for Supervisor API PRJul 28, 2026
@github-actions

Copy link
Copy Markdown
Contributor

📦 Bundle size report

Compared against bundle-size-baseline.json (main).

@databricks/appkit

npm tarball (packed): 797 KB (+34 KB) — gzipped download (dist + bin; excludes release-only docs/NOTICE).

distrawgzip
JS (runtime)820 KB (+29 KB)286 KB (+9.9 KB)
Type declarations302 KB (+17 KB)103 KB (+5.9 KB)
Source maps1.6 MB (+65 KB)536 KB (+21 KB)
Other11 KB3.7 KB
Total2.7 MB (+110 KB)929 KB (+37 KB)
Per-entry composition (own code — deps external (as shipped))
EntryInitial (gz)Lazy (gz)Total (gz)node_modules (min)Own code (min)
.86 KB (+10 B)2.5 KB89 KB (+10 B)external281 KB (+42 B)
./beta44 KB (+4.6 KB)429 B (+198 B)45 KB (+4.8 KB)external129 KB (+9.5 KB)
./type-generator19 KB0 B19 KBexternal54 KB

Chunks:

EntryChunkLoadSize (gz)
.index.jsinitial82 KB
.utils.jsinitial4.0 KB
.remote-tunnel-manager.jslazy2.5 KB
./betabeta.jsinitial29 KB
./betastream-manager.jsinitial5.8 KB
./betawide-event-emitter.jsinitial3.2 KB
./betadatabricks.jsinitial3.0 KB
./betaconfiguration.jsinitial2.1 KB
./betaservice-context.jsinitial1.3 KB
./betaclient-options.jsinitial220 B
./betasupervisor-api.jslazy184 B
./betadatabricks.jslazy132 B
./betaindex.jslazy113 B
./type-generatorindex.jsinitial19 KB

@databricks/appkit-ui

npm tarball (packed): 305 KB — gzipped download (dist + bin; excludes release-only docs/NOTICE).

distrawgzip
JS (runtime)359 KB119 KB
Type declarations205 KB74 KB
Source maps685 KB224 KB
CSS16 KB3.3 KB
Total1.2 MB421 KB
Per-entry composition (consumer bundle — deps bundled, peerDeps external)
EntryInitial (gz)Lazy (gz)Total (gz)node_modules (min)Own code (min)
./js4.3 KB49 KB54 KB208 KB12 KB
./js/beta20 B0 B20 B0 B0 B
./react429 KB49 KB478 KB1.3 MB168 KB
./react/beta20 B0 B20 B0 B0 B

Chunks:

EntryChunkLoadSize (gz)
./jsindex.jsinitial4.2 KB
./jschunkinitial120 B
./jsapache-arrowlazy49 KB
./js/betabeta.jsinitial20 B
./reactindex.jsinitial427 KB
./reacttslibinitial2.1 KB
./reactapache-arrowlazy49 KB
./react/betabeta.jsinitial20 B

@github-actions

github-actionsBot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

🤖 AppKit PR bot

🔬 Run evals

Start an eval for this PR from the evals-monitor app: Go to Evals Monitor →

📦 Try this PR's app template

Scaffolds a new app from this PR's SDK build. Run it in any folder (requires the GitHub CLI — gh auth login — and the Databricks CLI):

gh run download 30355377147 -R databricks/appkit -n appkit-template-0.48.0-pr.edf97e3-pkosiec-temp-supervisor-api-492 -D appkit-pr-492 \
&& unzip -o "appkit-pr-492/appkit-template-0.48.0-pr.edf97e3-pkosiec-temp-supervisor-api-492.zip" -d "appkit-pr-492" \
&& databricks apps init --template "appkit-pr-492"

The template pins @databricks/appkit and @databricks/appkit-ui to tarballs built from this branch, so the scaffolded app runs against this PR's code.

hubertzub-dband others added 3 commits July 28, 2026 12:11
Signed-off-by: Hubert Zub <hubert.zub@databricks.com>
Signed-off-by: Hubert Zub <hubert.zub@databricks.com>
Co-authored-by: Pawel Kosiec <pawel.kosiec@gmail.com>
@pkosiec
pkosiec marked this pull request as ready for review July 28, 2026 11:28
@pkosiec
pkosiec requested a review from a team as a code ownerJuly 28, 2026 11:28
@pkosiec
pkosiec requested a review from ditadiJuly 28, 2026 11:28
Signed-off-by: Pawel Kosiec <pawel.kosiec@databricks.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@pkosiec@hubertzub-db