Compare commits

..

No commits in common. "main" and "4.0.2" have entirely different histories.
main ... 4.0.2

686 changed files with 28107 additions and 51604 deletions

View file

@ -5,24 +5,33 @@ description: Use when updating Codex Panel for a new Codex CLI or app-server API
# Codex Panel App-Server Update
Use this skill when Codex Panel needs to follow Codex CLI or experimental `codex app-server` API changes.
## Ground Rules
- Treat `src/generated/app-server/` as generated output. Do not hand-edit generated bindings.
- Use `docs/design.md` for app-server boundary and source-of-truth decisions before adding compatibility layers or product behavior.
- Prefer current Codex CLI behavior over broad backward compatibility unless a concrete user need requires compatibility code.
- Separate required compatibility fixes from optional cleanup or product improvements.
- Do not rely on local Git hooks. Run required generation and verification commands explicitly.
## Procedure
1. Read the README Compatibility section and the relevant design and development guidance, then trace the affected app-server paths.
2. Confirm the recorded, installed, and target Codex CLI versions. Check official release information when behavior is uncertain.
3. Regenerate bindings with `npm run generate:app-server-types`.
4. Review generated diffs for protocol changes that affect runtime behavior. If mechanical normalization is needed, update the normalization code in `scripts/generate-app-server-types.mjs` and regenerate instead of patching generated files by hand.
5. Implement only the required compatibility changes and record the target version after validating it.
6. Report optional cleanup or product follow-ups separately; do not implement them unless requested.
1. Read the README Compatibility section, `docs/design.md`, `docs/development.md`, `package.json`, and app-server-related source around requests, notifications, threads, approvals, runtime settings, hooks, and model listing.
2. Compare the README Compatibility table's `codex.testedCliVersion` with the target `codex --version`.
3. Check official Codex CLI or app-server release information when the target version is newer or behavior is uncertain.
4. Regenerate bindings with `npm run generate:app-server-types`.
5. Review generated diffs for protocol changes that affect runtime behavior. If mechanical normalization is needed, update the normalization code in `scripts/generate-app-server-types.mjs` and regenerate instead of patching generated files by hand.
6. Implement only the compatibility changes needed for the target Codex CLI version.
7. Update the README Compatibility table's `codex.testedCliVersion` only after validating against that version.
8. Identify optional follow-ups separately from required compatibility work:
- API changes that allow removing compatibility shims, fallback code, or local workarounds.
- New routes, notifications, fields, or lifecycle signals that could simplify existing implementation.
- New app-server capabilities that could enable Codex Panel product improvements.
9. Report optional follow-ups as proposals only, grouped separately from implemented required fixes unless the user explicitly asks to implement them.
## Verification
- Run `npm run check` after regenerated bindings or compatibility changes.
- Use the live Obsidian workflow when runtime behavior needs verification.
- Report the tested Codex CLI version, changed compatibility behavior, and optional follow-ups.
- If the change must be reflected in Obsidian, run `npm run build` and verify the plugin reload path separately.
- Report the tested Codex CLI version, the generation command used, any app-server compatibility behavior that changed, and any optional simplification or feature proposals found.

View file

@ -5,11 +5,15 @@ description: Use when validating Codex Panel inside a live Obsidian app with the
# Codex Panel Obsidian Dev
Use this skill for live Obsidian checks after building Codex Panel or when investigating behavior that unit tests cannot observe.
## Ground Rules
- Work from the Codex Panel repository root.
- Use `docs/development.md` for the build and generated-asset expectations before live Obsidian validation.
- Ask before altering or reloading the live Obsidian session, attaching a debugger, or running intrusive evaluation or input commands.
- Prefer read-only inspection before state-changing commands.
- Treat `obsidian plugin:reload id=codex-panel`, `obsidian reload`, `obsidian restart`, `obsidian devtools`, `obsidian eval`, `obsidian dev:cdp`, and `obsidian dev:mobile` as state-changing or intrusive. Ask the user before running them.
- Prefer read-only inspection first: `plugin`, `commands`, `dev:errors`, `dev:dom`, `dev:css`, `dev:console`, `dev:screenshot`, `version`.
- If `dev:console` reports that the debugger is not attached, ask before running `obsidian dev:debug on`.
- Do not clear console or error buffers unless the user approves; clearing can destroy useful failure context.
## Workflow
@ -20,13 +24,13 @@ description: Use when validating Codex Panel inside a live Obsidian app with the
npm run build
```
2. If approved, reload the plugin when the live session needs the new build:
2. Before reloading the live plugin, ask the user whether it is OK to reload their current Obsidian session. If approved:
```bash
obsidian plugin:reload id=codex-panel
```
3. Open the relevant surface when needed:
3. Open the relevant Codex Panel surface when needed:
```bash
obsidian command id=codex-panel:open-panel
@ -43,12 +47,54 @@ description: Use when validating Codex Panel inside a live Obsidian app with the
obsidian dev:screenshot path=<scratch-path>/codex-panel.png
```
5. Use focused Codex Panel-owned selectors found in the relevant implementation or styles.
5. Use focused selectors for the behavior under test. Prefer stable Codex Panel classes such as `.codex-panel`, `.codex-panel__composer`, `.codex-panel-threads`, and `.codex-panel-chat-turn-diff`.
## Dynamic UI Investigations
When behavior depends on layout, asynchronous rendering, or virtualized DOM state, capture the visible state and relevant DOM metrics before and after the real input path, then again after rendering settles. Compare framework or data state with the DOM where possible. Remove temporary probes and instrumentation before final validation and re-check runtime errors.
When checking behavior that depends on browser layout, asynchronous rendering, or virtualized DOM state, measure the live UI rather than inferring from unit tests alone.
- Capture both the user-visible state and the underlying DOM metrics. Useful fields include `scrollTop`, `scrollHeight`, `clientHeight`, element bounding rects, rendered element counts, inline styles, and relevant computed styles.
- For virtualized or asynchronously rendered regions, compare framework state against DOM state where possible, such as virtualizer total size versus actual `scrollHeight`, rendered item count versus data count, or pre-event versus post-frame measurements.
- Prefer real input paths for input-sensitive bugs. Use `obsidian dev:cdp method=Input.dispatchMouseEvent ...` or focused keyboard events when a synthetic `dispatchEvent()` may skip browser/Electron behavior.
- Record measurements before the action, immediately after the action, after at least one animation frame, and after a short timeout when layout, markdown rendering, resize observers, or virtualizer settle loops may run later.
- If injecting temporary DOM probes with `obsidian eval`, remove them before finishing and re-check `dev:errors`. Avoid leaving long-running eval promises; use bounded `setTimeout`-based scripts that resolve.
- Treat console instrumentation as temporary. Remove debug logging before final validation, and search the touched files for probe markers or conflict markers before reporting.
## Common Checks
- Confirm the loaded version and enabled state:
```bash
obsidian plugin id=codex-panel
```
- List available Codex Panel commands:
```bash
obsidian commands filter=codex-panel
```
- Count rendered elements:
```bash
obsidian dev:dom selector=.codex-panel__composer total
```
- Inspect text, attributes, or computed styles:
```bash
obsidian dev:dom selector=.codex-panel__composer text
obsidian dev:dom selector=.codex-panel__composer attr=aria-label
obsidian dev:dom selector=.codex-panel__composer css=display
obsidian dev:css selector=.codex-panel__composer
```
- Capture a screenshot for visual review:
```bash
obsidian dev:screenshot path=<scratch-path>/codex-panel.png
```
## Reporting
Report the observed behavior, runtime errors, intrusive actions taken, and evidence paths. State when an approval-gated check was skipped.
Report the commands run, whether Obsidian was reloaded, key `dev:errors` or `dev:console` findings, and any screenshot path produced. If a command was skipped because it required user approval, state that plainly.

View file

@ -5,23 +5,28 @@ description: Use when preparing, checking, committing, tagging, pushing, or repa
# Codex Panel Release
`docs/release.md` is the public procedure and source of truth for the release command sequence. This skill adds agent-facing gates, review duties, and failure handling.
Use this skill when delegating Codex Panel release work to an agent. `docs/release.md` is the public procedure and source of truth for the release command sequence. This skill adds agent-facing gates, review duties, and failure handling.
## Ground Rules
- Read and follow `docs/release.md`; do not maintain a parallel release command sequence here.
- Do not assume local Git hooks exist or ran. Run required verification commands explicitly.
- Do not create GitHub Releases locally with `gh release create`; the tag-triggered GitHub Actions workflow owns release creation and asset attachment.
- Treat generated release notes as a draft. Review the full release diff and keep one short, public-facing `## Changes` section without internal or procedural detail.
- Keep internal validation notes, procedural details, and implementation reasoning out of release notes.
- Release notes must be short, public-facing bullets under the single `## Changes` section required by `docs/release.md`.
## Delegation Procedure
1. Read `docs/release.md` and inspect the current version metadata and recent release notes.
1. Read `docs/release.md`, `package.json`, `manifest.json`, `versions.json`, and existing `.github/release-notes/` files.
2. Identify the target release version and the commit range since the previous released tag.
3. Inspect the full release diff, run preparation as documented, and edit the draft for completeness, accuracy, and user-facing wording.
4. Before committing, ask the user to approve the release version, reviewed release-note bullets, and included commit range.
5. After approval, follow `docs/release.md` through preflight, tag, and push. Let GitHub Actions create or update the GitHub Release.
3. Follow the preparation step in `docs/release.md`.
4. Draft `.github/release-notes/X.Y.Z.md` from the full diff since the previous released tag, not only the latest commit.
5. Before committing, ask the user to approve the release version, release-note bullets, and included commit range.
6. After approval, follow `docs/release.md` for the commit, preflight, tag, and push sequence.
7. After pushing, let GitHub Actions create or update the GitHub Release.
## Failure Handling
- If a release script or preflight fails, fix the cause and rerun the explicit failed command.
- If the tag-triggered workflow fails before GitHub Release creation, use the repair procedure in `docs/release.md`.
- If a GitHub Release already exists or was partially created, inspect the state before taking action; do not assume local asset upload is the right recovery path.

View file

@ -4,8 +4,6 @@ updates:
directory: "/"
schedule:
interval: "weekly"
commit-message:
prefix: "ci(deps)"
cooldown:
default-days: 7
@ -13,9 +11,6 @@ updates:
directory: "/"
schedule:
interval: "weekly"
commit-message:
prefix: "chore(deps)"
prefix-development: "chore(deps)"
cooldown:
default-days: 7
open-pull-requests-limit: 5
@ -29,6 +24,3 @@ updates:
update-types:
- "version-update:semver-minor"
- "version-update:semver-major"
- dependency-name: "typescript"
update-types:
- "version-update:semver-major"

View file

@ -1,4 +0,0 @@
## Changes
- Added a `/permissions` slash command that shows the current permissions and approval settings.
- Refined the status panel permissions display into Permissions and Approvals sections, with connection diagnostics labeled consistently.

View file

@ -1,4 +0,0 @@
## Changes
- Fixed Windows connection failures when the configured Codex executable is an npm-installed command shim such as `codex.cmd`.
- Refined runtime permission and approval status resolution for more consistent diagnostics.

View file

@ -1,4 +0,0 @@
## Changes
- Let `/permissions` set the permission profile used for subsequent Codex turns, with composer completions for available profiles.
- Updated app-server compatibility for Codex CLI 0.142.5.

View file

@ -1,4 +0,0 @@
## Changes
- Added an opt-in **Reference active note on send** setting that references the current Obsidian note when sending from the composer without changing the prompt text.
- Renamed sent-message context metadata to `Context · n items`, with implicit active-note context shown as `Active note · path/to/note.md`.

View file

@ -1,4 +0,0 @@
## Changes
- Added `/clip <url> [message]` to save readable web page clippings as Markdown notes and send wikilink references from the composer.
- Added web clipping settings for the saved note folder, filename template, and tags.

View file

@ -1,5 +0,0 @@
## Changes
- Renamed active-note context to `@active` and updated related settings copy to refer to the active file consistently.
- Improved thread matching for composer thread commands and thread search so title and ID matches rank more predictably.
- Made saved vault paths for attachments, web clippings, and archived thread notes more consistent with their configured defaults.

View file

@ -1,4 +0,0 @@
## Changes
- Add Obsidian tag completions in the composer after `#`.
- Open Obsidian Search when clicking rendered tags in Codex Panel messages.

View file

@ -1,5 +0,0 @@
## Changes
- Match Obsidian's tag index and global search behavior for tag completions and rendered tag clicks.
- Show composer context as 0% before a thread starts instead of leaving it blank.
- Harden saved Markdown output for web clips and archived threads with safer YAML frontmatter handling.

View file

@ -1,6 +0,0 @@
## Changes
- Add an action to open subagent threads directly from agent summary messages.
- Show reasoning effort descriptions in composer suggestions.
- Update app-server compatibility for Codex CLI 0.143.0.
- Polish toolbar and slash command wording, and fix composer suggestion matching.

View file

@ -1,3 +0,0 @@
## Changes
- Polish chat panel wording around conversations, context, and composer guidance.

View file

@ -1,6 +0,0 @@
## Changes
- Update app-server compatibility for Codex CLI 0.144.0 and improve reconnection, metadata, and MCP request handling.
- Load thread history incrementally in Threads View while retaining complete thread-picker search results.
- Fix web clips to save Defuddle's Markdown output and refresh collapsed-content controls after layout changes.
- Prevent stale asynchronous UI updates after panels, settings, or the plugin close.

View file

@ -1,4 +0,0 @@
## Changes
- Add `@today`, `@tomorrow`, and `@yesterday` composer completions that resolve through the configured Daily Notes or Periodic Notes folder and date format.
- Improve `@active` and `@selection` suggestions with clearer note, range, and selected-text previews.

View file

@ -1,3 +0,0 @@
## Changes
- Align DOM creation and daily-note date handling with Obsidian's bundled APIs for Community plugin review compatibility.

View file

@ -1,5 +0,0 @@
## Changes
- Add `/btw` side chats that open an ephemeral conversation in a new panel without interrupting the source thread.
- Open subagent threads as read-only panels and hide conversation actions that do not apply to them.
- Improve reliability around Vault file destinations, web clipping, app-server connections, and asynchronous panel cleanup.

View file

@ -1,4 +0,0 @@
## Changes
- Improve chat and side-chat stability during concurrent actions, panel restoration, and cleanup.
- Prevent stale app-server data and rapid settings changes from overwriting newer state.

View file

@ -1,5 +0,0 @@
## Changes
- Replace `/clip` with `/web <url> [message]` for temporary web context without saving a note. For durable archives—especially rendered or signed-in pages—use Obsidian Web Clipper and reference the saved note.
- Improve hook controls so trusting a hook no longer enables it automatically, and only trusted unmanaged hooks can be enabled or disabled.
- Prevent an in-flight automatic thread title from overwriting a newer manual rename.

View file

@ -1,5 +0,0 @@
## Changes
- You can now cancel an in-progress `/web` import and keep the original prompt to edit or resend it.
- Changing the Codex executable in settings now reconnects open panels cleanly.
- File links containing backticks are now preserved when exporting archived threads.

View file

@ -1,5 +0,0 @@
## Changes
- Persistent threads now reconnect cleanly after temporary Codex disconnects or app-server setting changes, while temporary side chats no longer resume incorrectly.
- Slash-command suggestions now immediately respect the restrictions for temporary side chats and subagent threads.
- Thread rename and archive results are now kept within the Codex context where the operation started, preventing stale updates after settings change.

View file

@ -1,3 +0,0 @@
## Changes
- Release assets now carry individually verifiable provenance attestations.

View file

@ -1,3 +0,0 @@
## Changes
- Restored availability of downloadable install assets while upstream attestation verification catches up with GitHub's API changes.

View file

@ -1,6 +0,0 @@
## Changes
- Added search to Codex Panel settings.
- Large web, thread, selection, and vault references are now bounded predictably, report truncation when needed, and keep their context details after reopening a thread.
- Paste and drop attachments now preserve their intended insertion point while files are being saved, with clearer composer editing state.
- Improved reliability when switching threads, leaving running subagents, or changing runtime and app-server settings, preventing stale results and lost updates.

View file

@ -1,6 +0,0 @@
## Changes
- Thread history now stays in sync across the chat toolbar, thread picker, and Threads view while loading older threads or refreshing.
- Thread search now uses fuzzy title matching across the complete active history instead of matching thread IDs.
- Running subagent summaries now show each agent's latest activity instead of only its initial status.
- Opening the thread picker again now closes the previous picker, and accepted MCP links are preserved in conversation history.

View file

@ -1,6 +0,0 @@
## Changes
- Thread rename and auto-name controls now prevent conflicting edits while work is in progress, and cancelling auto-name returns to the existing draft.
- Actions with known unmet prerequisites are now disabled before execution, including unavailable auto-name and selection rewrite actions.
- Thread operation errors no longer appear as entries in navigation lists.
- Resumed conversations now hide Codex Panel's internal context metadata while preserving their context attachments.

View file

@ -1,4 +0,0 @@
## Changes
- Thread references created with `/refer` now remain as readable, clickable links in conversation history and open the referenced thread in an available Codex Panel.
- Opening an existing thread in a new panel is now faster because resume no longer waits for background metadata and thread-list refreshes.

View file

@ -1,5 +0,0 @@
## Changes
- Updated compatibility for Codex CLI 0.145.0.
- Subagent conversations that support replies can now be continued directly from their panel.
- Fixed malformed links in exported thread archives.

View file

@ -18,69 +18,16 @@ jobs:
- name: Checkout
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
fetch-depth: 0
persist-credentials: false
- name: Detect compatibility changes
id: compatibility
env:
BASE_SHA: ${{ github.event_name == 'pull_request' && github.event.pull_request.base.sha || github.event.before }}
HEAD_SHA: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
run: |
if git diff --quiet "$BASE_SHA" "$HEAD_SHA" -- \
.github/workflows/check.yml \
README.md \
manifest.json \
package.json \
package-lock.json \
scripts/api-baseline.mjs \
scripts/app-server-compatibility.mjs \
scripts/generate-app-server-types.mjs \
src/app-server/connection/compatibility.json \
src/generated/app-server \
versions.json; then
echo "required=false" >> "$GITHUB_OUTPUT"
else
echo "required=true" >> "$GITHUB_OUTPUT"
fi
- name: Setup Node.js
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
with:
node-version: 26
node-version: 24
cache: npm
- name: Install dependencies
run: npm ci --ignore-scripts
- name: Install recorded Codex CLI
if: steps.compatibility.outputs.required == 'true'
run: npm install --global "@openai/codex@$(node scripts/app-server-compatibility.mjs --tested-cli-version)"
- name: Check API baselines
if: steps.compatibility.outputs.required == 'true'
run: npm run api:baseline
- name: Check generated app-server bindings
if: steps.compatibility.outputs.required == 'true'
run: npm run generate:app-server-types:check
- name: Check pull request commit messages
if: github.event_name == 'pull_request'
env:
BASE_SHA: ${{ github.event.pull_request.base.sha }}
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
run: npm run commitlint -- --from "$BASE_SHA" --to "$HEAD_SHA" --verbose
- name: Check pushed commit messages
if: github.event_name == 'push'
env:
BASE_SHA: ${{ github.event.before }}
HEAD_SHA: ${{ github.sha }}
run: npm run commitlint -- --from "$BASE_SHA" --to "$HEAD_SHA" --verbose
- name: Check release metadata
run: npm run release:check
- name: Check
run: npm run check

View file

@ -7,6 +7,8 @@ on:
permissions:
contents: write
id-token: write
attestations: write
jobs:
release:
@ -17,43 +19,33 @@ jobs:
- name: Checkout
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
fetch-depth: 0
persist-credentials: false
- name: Setup Node.js
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
with:
node-version: 26
node-version: 24
package-manager-cache: false
- name: Install dependencies
run: npm ci --ignore-scripts
- name: Install recorded Codex CLI
run: npm install --global "@openai/codex@$(node scripts/app-server-compatibility.mjs --tested-cli-version)"
- name: Check API baselines
run: npm run api:baseline
- name: Check generated app-server bindings
run: npm run generate:app-server-types:check
- name: Check release version
run: npm run release:check
env:
RELEASE_VERSION: ${{ github.ref_name }}
- name: Check release commit messages
env:
TAG: ${{ github.ref_name }}
run: |
PREVIOUS_TAG="$(node -p 'Object.keys(require("./versions.json")).at(-2)')"
git rev-parse --verify "refs/tags/$PREVIOUS_TAG"
npm run commitlint -- --from "$PREVIOUS_TAG" --to "$TAG" --verbose
- name: Run checks and build
run: npm run check
- name: Generate artifact attestations
uses: actions/attest@59d89421af93a897026c735860bf21b6eb4f7b26 # v4
with:
subject-path: |
main.js
manifest.json
styles.css
- name: Create GitHub release
env:
GH_TOKEN: ${{ github.token }}

4
.gitignore vendored
View file

@ -1,6 +1,4 @@
node_modules/
.pnpm-store/
.stryker-tmp/
.jj/
.codex/
main.js
@ -9,6 +7,4 @@ data.json
*.log
.DS_Store
dist/
coverage/
reports/
tmp/

View file

@ -1 +0,0 @@
26

View file

@ -1,11 +1,6 @@
This repository contains the Codex Panel Obsidian plugin.
## Working Principles
- Start from evidence. Reproduce defects before fixing them; for product changes, reconstruct the current workflow, user need, alternatives, and losses before deciding what should change. Treat theoretical failure modes and reviewer agreement as hypotheses, not evidence of meaningful user or operational harm.
- Use design documents as context, not as a substitute for current behavior and user expectations. Prefer coherent user-facing behavior and clear ownership, and remove needless abstraction or obsolete compatibility instead of preserving it by default.
- Treat implementation, tests, documentation, lint policy, and final history as one deliverable: inspect each for drift, but update only the durable contracts that changed. Documentation should record user-facing behavior, long-term design, or reusable workflow; do not add it merely to narrate an implementation change or duplicate tests and tooling.
- Parallelize only substantial concerns that can be implemented and tested independently with little shared-file contention. Keep small, tightly coupled, sequential, or coordination-heavy work together.
Jujutsu is the recommended local change-management workflow when available.
## What To Read
@ -15,8 +10,4 @@ This repository contains the Codex Panel Obsidian plugin.
- Read `docs/release.md` for release preparation, release notes, preflight, tagging, pushing, and release repair.
- Use the repo-local skills in `.agents/skills/` when a task matches a more specific workflow.
## Changes And Validation
- Jujutsu is the recommended local change-management workflow when available. Make each final change a coherent review unit with an honest description.
- Before publishing, inspect and reorganize the graph when needed rather than preserving implementation chronology: normally fold corrective follow-ups into the concern they complete, split mixed changes, and keep a follow-up separate only when it remains meaningful on its own.
- Use Conventional Commits for new commits and follow `docs/development.md` for repository rules and validation. Re-run relevant validation after history edits and before handoff or publication.
When implementation, design, or workflow changes create drift from docs or lint policy, update the affected docs or lint settings in the same change and report that update.

View file

@ -2,7 +2,7 @@
Codex Panel brings Codex into an Obsidian sidebar. It keeps Codex threads beside your notes, helps you add vault context to prompts, and lets you handle approvals and file changes without switching windows.
If the Codex CLI is already installed and authenticated, Codex Panel uses that local setup.
If the Codex CLI is already installed and authenticated, Codex Panel uses that local setup. The plugin handles the Obsidian side of the workflow, while models, credentials, sandboxing, tools, hooks, and thread state stay with Codex.
![Codex Panel](assets/screenshot.webp)
@ -35,46 +35,34 @@ You can also open the plugin page directly: <https://community.obsidian.md/plugi
## Quick start
1. Open the note or project you want to work on.
2. Run **Codex Panel: Open panel** from the command palette, or select the ribbon icon.
3. In the composer, reference what matters and describe the outcome you want. For example: `@active Summarize this note and suggest the next three actions.`
4. Follow the turn in the panel, respond to requests when needed, and review any file changes before continuing.
1. Open the command palette and run **Codex Panel: Open panel**, or select the ribbon icon.
2. If Obsidian cannot find `codex`, set **Settings -> Codex Panel -> Codex executable** to an absolute path such as `/opt/homebrew/bin/codex`.
3. Ask Codex to work on the vault or project from the composer.
4. Return to earlier work from **Codex Panel: Open thread...** or **Codex Panel: Open threads view**.
If Obsidian cannot find `codex`, set **Settings -> Codex Panel -> Codex executable** to an absolute path such as `/opt/homebrew/bin/codex`.
## Using Codex Panel
## Working with Codex Panel
Each panel can keep a separate conversation, so related work can stay open side by side. Start fresh from the panel, reopen recent threads from the picker or panel history, or use the Threads view to see active work across the vault.
### Keep work separate or pick it up later
The composer understands Obsidian links. It suggests vault files and recent notes, keeps wikilinks readable, includes linked files with your prompt, and opens file links from Codex replies back in Obsidian. Use `@active-note` or `@selection` to include the active note or current Markdown selection without pasting it manually. Paste or drop files to save them in the attachment folder and reference them from the same prompt.
A panel is an independent working surface with its own active thread and draft. Open multiple panels when different tasks should stay visible and separate. Regular Codex threads remain available after a panel closes; return to them from **Codex Panel: Open thread...**, panel history, or the Threads view.
Completions cover slash commands, `$skill-name` skills, recent threads, models, and reasoning levels. Use `/help` for the current command list.
For a one-off question alongside the current thread, use `/btw` to open a temporary side chat. To carry context between regular threads without merging their histories, use `/refer <thread> <message>`. The submitted message keeps a normal link to the referenced thread; clicking it opens the thread in an available Codex Panel, creating one when needed.
While a turn is running, the panel streams the conversation, reasoning, tool activity, file changes, plans, and agent activity. You can answer Codex questions, approve commands, respond to requests, steer or interrupt the turn, and manage active goals above the message stream.
### Bring in the right context
When Codex changes files, open an Obsidian diff view to review the changes and copy the patch. For a focused note edit, select Markdown text and run **Codex Panel: Rewrite selection** to ask Codex for a replacement and review a selection-scoped diff before applying it.
The composer lets you point Codex to relevant material without pasting it into the prompt. Type wikilinks to reference vault files while keeping their names readable. Use `@active` for the active file or `@selection` for the current Markdown selection.
Use the toolbar, composer status row, or slash commands to inspect usage, adjust turn settings, and check Codex connection details.
When Obsidian Daily Notes or the daily section of Periodic Notes is enabled, `@today`, `@tomorrow`, and `@yesterday` resolve through its folder and date format. Paste or drop files to save them in the configured attachment folder and reference them from the same prompt. For material outside the vault, `/web <url> [message]` fetches readable page content and attaches it to the next turn without creating a note.
### Guide a running turn
As a turn runs, the panel keeps the conversation together with requests that need your attention. You can answer questions, approve or reject actions, steer the turn with another message, or interrupt it. Plans, goals, tool activity, and agent work remain available when you need to inspect how the task is progressing.
### Review and keep the result
When Codex changes files, open the Obsidian diff view to review the changes and copy the patch. For a focused edit, select Markdown text and run **Codex Panel: Rewrite selection** to request a replacement and review a selection-scoped diff before applying it.
Archive a finished thread with or without saving it as a Markdown note. Saved notes use the configured folder, filename template, and tags; archived threads can later be restored or permanently deleted from settings.
Use `/help` for the current slash command list.
Threads can be archived as Markdown notes with a configurable folder, filename template, and tags. You can also archive without saving, then restore or permanently delete archived threads from settings.
## Compatibility
| Key | Version | Policy |
| -------------------------------------- | --------- | --------------------------------------------------------------------------------------------------- |
| `manifest.minAppVersion` | `1.12.0` | Minimum Obsidian desktop version declared for plugin loading. |
| `obsidian` API types | `1.12.3` | TypeScript API package used for compile-time checks; kept in the same minor as `manifest` baseline. |
| `codexAppServer.testedCliVersion` | `0.145.0` | Exact CLI patch used to generate and verify bindings; compatibility is tracked by minor version. |
| Key | Version | Policy |
| ------------------------ | --------- | --------------------------------------------------------------------------------------------------- |
| `manifest.minAppVersion` | `1.12.0` | Minimum Obsidian desktop version declared for plugin loading. |
| `obsidian` API types | `1.12.3` | TypeScript API package used for compile-time checks; kept in the same minor as `manifest` baseline. |
| `codex.testedCliVersion` | `0.142.0` | Track app-server compatibility by Codex CLI minor version. |
Codex Panel depends on the experimental `codex app-server` API.

View file

@ -56,21 +56,11 @@
},
{
"path": "./scripts/grit/import-boundaries/no-app-server-connection-boundary-imports.grit",
"includes": [
"**/src/app-server/protocol/**/*.ts",
"**/src/domain/**/*.ts",
"**/src/shared/**/*.{ts,tsx}",
"**/src/features/selection-rewrite/**/*.{ts,tsx}",
"!**/src/features/selection-rewrite/app-server-transport.ts"
]
"includes": ["**/src/app-server/protocol/**/*.ts", "**/src/domain/**/*.ts", "**/src/shared/**/*.{ts,tsx}"]
},
{
"path": "./scripts/grit/import-boundaries/no-app-server-protocol-boundary-imports.grit",
"includes": ["**/src/**/*.{ts,tsx}", "!**/src/app-server/**", "!**/src/features/chat/app-server/mappers/thread-stream/turn-items.ts"]
},
{
"path": "./scripts/grit/import-boundaries/no-chat-turn-item-non-turn-protocol-imports.grit",
"includes": ["**/src/features/chat/app-server/mappers/thread-stream/turn-items.ts"]
"includes": ["**/src/**/*.{ts,tsx}", "!**/src/app-server/**"]
},
{
"path": "./scripts/grit/import-boundaries/no-generated-app-server-boundary-imports.grit",
@ -78,7 +68,6 @@
"**/src/**/*.{ts,tsx}",
"!**/src/app-server/connection/**",
"!**/src/app-server/protocol/server-requests.ts",
"!**/src/app-server/protocol/thread.ts",
"!**/src/app-server/protocol/turn.ts"
]
},
@ -99,10 +88,6 @@
"path": "./scripts/grit/import-boundaries/no-workspace-chat-internal-imports.grit",
"includes": ["**/src/workspace/**/*.ts"]
},
{
"path": "./scripts/grit/import-boundaries/no-thread-workflow-app-server-imports.grit",
"includes": ["**/src/features/threads/workflows/**/*.ts"]
},
// Chat feature layer boundaries.
{
@ -131,6 +116,32 @@
},
// Chat state and runtime ownership.
{
"path": "./scripts/grit/import-boundaries/no-preact-signal-imports.grit",
"includes": [
"**/src/**/*.{ts,tsx}",
"!**/src/features/chat/panel/shell-read-model.ts",
"!**/src/features/chat/panel/surface/**/*.{ts,tsx}"
]
},
{
"path": "./scripts/grit/import-boundaries/no-chat-shell-read-model-imports.grit",
"includes": [
"**/src/features/chat/**/*.{ts,tsx}",
"!**/src/features/chat/panel/shell-read-model.ts",
"!**/src/features/chat/panel/shell.dom.tsx",
"!**/src/features/chat/panel/composer-controller.ts",
"!**/src/features/chat/panel/surface/**/*.{ts,tsx}"
]
},
{
"path": "./scripts/grit/import-boundaries/no-chat-signal-type-references.grit",
"includes": [
"**/src/features/chat/**/*.{ts,tsx}",
"!**/src/features/chat/panel/shell-read-model.ts",
"!**/src/features/chat/panel/surface/**/*.{ts,tsx}"
]
},
{
"path": "./scripts/grit/runtime/no-state-module-side-effects.grit",
"includes": ["**/src/features/chat/application/state/**/*.ts"]

View file

@ -1,9 +0,0 @@
export default {
defaultIgnores: false,
extends: ["@commitlint/config-conventional"],
ignores: [(message) => /^Merge pull request #\d+ from \S+/.test(message)],
rules: {
"subject-case": [0],
"type-enum": [2, "always", ["build", "chore", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test"]],
},
};

View file

@ -8,15 +8,7 @@ This document records durable design direction. User-facing behavior belongs in
Keep the panel thin. Codex Panel owns the Obsidian experience around Codex: panels, composing, vault-aware link handoff, approvals and user input, file-change review, archive export, panel preferences, diagnostics, and selection rewrite.
Codex owns runtime behavior and thread state: models, credentials, sandboxing, approval policy, MCP servers, hooks, providers, agent-initiated network access, thread history, archived state, goals, and runtime settings. The panel should read and update that state through `codex app-server`, not redefine it.
The panel may provide a narrow management surface when direct configuration of Codex-owned state is impractical and app-server still owns the semantics. Hook controls serve this role: help users recognize and manage hooks they added or changed without presenting the panel as a code-audit surface.
The panel may acquire prompt context through an explicit user action. `/web` fetches the requested page through Obsidian and attaches the extracted content as untrusted turn context; it is not a search surface or agent network policy.
Panel-acquired context remains reference material rather than current user authorization. Send its bounded payload as untrusted app-server context without adding Panel-owned metadata envelopes to Codex history. Apply physical byte and part limits at the app-server boundary; keep source-specific selection and truncation policy with the context producer. Keep read-only compatibility for envelopes written by older Panel versions isolated at history projection boundaries.
Vault file references are prompt handoff data, not durable thread metadata. Keep their display state local; ordinary wikilinks remain represented by the user-authored message text. Thread references persist as ordinary, human-readable `codex://threads/` Markdown links, while their bounded transcript payload remains ephemeral turn context.
Codex owns runtime behavior and thread state: models, credentials, sandboxing, approval policy, MCP servers, hooks, providers, network access, thread history, archived state, goals, and runtime settings. The panel should read and update that state through `codex app-server`, not redefine it.
Panel settings should store only panel-specific preferences. Do not mirror Codex configuration in Obsidian settings just to display or inspect it.
@ -26,11 +18,7 @@ Panel settings should store only panel-specific preferences. Do not mirror Codex
The app-server API is experimental. The project tracks the supported Codex CLI minor and favors a clean current flow over broad old-protocol compatibility.
Runtime controls should express visible user intent for the active thread rather than copy Codex configuration. Diagnostics should expose only actionable troubleshooting facts.
An app-server context is the pair of Codex executable and Vault root. Replacing it must invalidate context-bound connections and work before publishing the new context, keep events attributed to their source context, and discard old runtime metadata. Preserve last-known-good state only across transient failures within the same context.
Vault root is the Panel-owned workspace root for that context. Panel operations always use it as the thread working directory and do not project mutable protocol thread cwd values into panel state.
Runtime controls should express visible user intent for the active thread. They should not copy Codex configuration, and diagnostics should expose only actionable troubleshooting facts.
## Code Boundaries
@ -48,45 +36,27 @@ Do not hide complexity behind forwarding layers. Add an abstraction only when it
## UI Ownership
Runtime UI composition is Preact-owned. Preact components should render the panel shell, toolbar, thread stream, composer, and request controls.
Runtime UI composition is Preact-owned. Preact components should render the panel shell, toolbar, message stream, composer, and request controls.
Obsidian and app-server boundaries stay outside Preact components. External lifecycles, app-server connections, editor/workspace APIs, and rendering bridges belong in boundary modules.
Chat-visible state should have one authoritative owner. Components should consume narrow projections of that state rather than mirror it into another reactive store.
Chat-visible state belongs in the chat state store and named reducer actions. Signals and components may project that state, but they should not become parallel sources of truth.
TanStack Query is the single panel-side owner of cached app-server resources. Features may project authoritative event results into that state, but should not introduce parallel cache or synchronization mechanisms. Partial read models are reconciled at explicit lifecycle boundaries rather than kept globally and continuously consistent.
Preact Signals are a chat panel rendering adapter, not a second state system. Panel surfaces may read narrow signal-backed read models, but application workflows, domain code, presentation helpers, and pure UI components must not depend on broad reducer slices or reactive state primitives.
Thread lifecycle changes should be projected from completed operation facts into the shared read model. When one user action changes multiple visible projections, publish them coherently without delaying live operational state or coupling independent panels.
Reads with different completeness requirements have separate lifecycles. Complete operation-local reads must not replace bounded shared history, and transient activity should come from its owning live state rather than forcing history refreshes.
Imperative UI bridges are allowed only where the host platform requires them. They should remain narrow boundary adapters, not a second UI composition system inside Preact-owned surfaces.
Imperative DOM bridges are allowed when an external API, host lifecycle, hit-test, focus/selection operation, or measurement problem requires an `HTMLElement`. They should remain narrow boundary adapters, not a second UI composition system inside Preact-owned surfaces.
## Interaction Principles
Multiple panels are separate Obsidian leaves. Treat each panel as its own Codex working surface with independent connection, thread, turn state, composer, and pending requests.
Long-running actions must preserve the user intent that started them. Panel-local results may affect a panel only while that intent still owns its target; Codex facts completed in the current app-server context remain shared truth even if the initiating panel has moved on.
Coordinate conflicting work at the narrowest shared semantic owner. Independent panels should not block one another, and stale reads or writes must not overwrite newer shared state. Coalesce work only when replacement is part of the operation's meaning.
Foreground reveal and focus are the narrow workspace-wide exception: the latest user intent wins without serializing unrelated panel or app-server work. Cleanup obligations created by a committed state transition must survive the UI action that initiated them.
Do not use explanatory copy as the default remedy for an unclear or incoherent interface. Before adding instructions, warnings, status text, validation messages, confirmations, or diagnostics, determine why the interface does not communicate the necessary behavior through its structure and state. Prefer improving information hierarchy, labels, defaults, available choices, affordances, validation timing, progress indication, and feedback. Add text only when irreducible information remains and it materially helps the user decide, act, or recover; do not expose implementation concepts merely because they explain the current behavior.
Subagent threads opened from agent activity remain persistent and restorable but stay outside ordinary thread history. Use the app-server direct-input capability when available, falling back to read-only subagent panels for older servers, while preserving parent and agent provenance for other specialized behavior.
Mode-derived restrictions for the active panel thread must remain consistent across actions and UI. Keep connection state, turn busy state, and operations targeting another listed thread in their owning workflows.
Thread history and other app-server resources should follow app-server semantics. Panel-side views are read models over app-server snapshots and lifecycle events; stale or partial refreshes must not overwrite newer state. Obsidian integrations such as archive note export are convenience views, not replacements for Codex history.
Routine thread lists should load a bounded recent set and paginate older threads on demand instead of eagerly fetching complete inventories.
Thread history, archived state, forks, catalog snapshots, and other app-server resources should follow app-server semantics. Panel-side views are read models over app-server snapshots and lifecycle events; stale or partial refreshes must not overwrite newer state. Obsidian integrations such as archive note export are convenience views of Codex state, not replacements for Codex history.
Selection rewrite is intentionally scoped to a focused edit-and-review workflow. Avoid expanding it into a broader writing assistant without a separate design decision.
Server requests should become panel UI only when the user can naturally answer them in context. Unknown or unsupported requests should stay diagnostic instead of pretending to be normal conversation text.
Thread stream display should separate primary conversation from diagnostic detail and progress/status. Preserve stable item identity across history, streaming, and rendering updates.
Message stream display should separate primary conversation from diagnostic detail and progress/status. Preserve stable item identity across history, streaming, and rendering updates.
Codex Panel UI should feel native inside Obsidian. Prefer Obsidian variables, standard classes, and side-panel patterns. Add custom visual treatment only when Codex-specific state would otherwise be hard to read.
@ -94,8 +64,8 @@ Codex Panel UI should feel native inside Obsidian. Prefer Obsidian variables, st
Tests should protect user expectations, app-server/panel responsibility boundaries, and state-transition invariants.
Prefer tests for visible behavior and state-transition invariants across panels, threads, requests, streams, and display fallbacks.
Prefer tests for visible behavior: independent panels, thread-scoped resets, pending request handling, approval flows, readable transcript/detail/status grouping, scroll preservation, and display fallbacks for structured app-server values.
Avoid tests that freeze incidental implementation details unless those details directly protect a user-visible invariant.
Avoid tests that freeze incidental implementation details such as exact DOM nesting, render counts, node reuse, helper decomposition, or no-op array updates unless those details directly protect a user-visible invariant.
Panel tests may define how received structured values are displayed, retained, or normalized. They should not redefine Codex-owned runtime policy, model lists, sandbox behavior, approval policy, or thread history semantics.

View file

@ -8,37 +8,14 @@ Use this document for day-to-day implementation mechanics: commands, generated f
npm ci
npm run fix
npm run check
npm run test:coverage
npm run test:mutation
```
Use the Node.js version in `.node-version`.
Use this as the normal edit loop: make the change, run `npm run fix`, then run `npm run check`. Treat `npm run fix` as trusted mechanical cleanup for formatting, import ordering, and Knip safe fixes; review the resulting diff at normal change-boundary checkpoints rather than after each tool adjustment.
Use `npm run fix` for mechanical cleanup, review its diff, and run `npm run check` before handoff.
Use `npm run test:coverage` to identify source modules and branches that lack exercised behavior. It reports every authored TypeScript source file, including files not imported by tests, while excluding generated app-server bindings. Open `coverage/index.html` to inspect line-level gaps. Coverage is diagnostic and has no pass/fail threshold; prioritize user-visible behavior and state-transition invariants rather than raising the aggregate percentage.
Use `npm run test:mutation` for an exploratory mutation test of domain-owned logic, app-server protocol normalization, thread-stream event mapping, and the chat root reducer. Review surviving mutants individually instead of treating the aggregate score as a quality gate: add tests for meaningful behavior gaps, simplify equivalent or redundant code, and leave mutants alone when neither change improves the durable contract. The run ignores expensive module-initialization mutants, is intentionally manual, and writes its ignored HTML report to `reports/mutation/mutation.html`.
## Commit Messages
Use [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/) for new commits:
```text
feat(composer): add daily note context suggestions
fix: prevent manual titles from being overwritten
```
Use one of `build`, `chore`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`, or `test`. Scopes are optional. Keep the description concise and omit a trailing period; capitalization is unrestricted. Use `!` before the colon or a `BREAKING CHANGE:` footer for a disruptive change.
CI checks commits introduced by pull requests and direct pushes; GitHub-generated pull-request merge commits are exempt. To check a range locally, run `npm run commitlint -- --from <base> --to <head> --verbose`.
Use focused scripts while iterating, but run `npm run check` before handoff. CI and release preflight use the same check.
Use focused scripts such as `npm run typecheck`, `npm run test`, or `npm run build` only when diagnosing a specific failure or when a full check would obscure the signal while iterating. Do not treat focused scripts as a substitute for the final `npm run check`. CI and release preflight run the same `npm run check` command as local development.
Keep rule suppressions local and include the Obsidian-specific reason when a native Obsidian UI pattern intentionally diverges from a generic browser rule.
Grit policy cases protect matcher semantics rather than diagnostic wording, source locations, or the exact shape of Biome configuration. Keep one valid and invalid source case for each policy, and change a case only when that policy's accepted or rejected source shape intentionally changes.
## Generated and Loaded Files
`main.js`, `styles.css`, `data.json`, and `node_modules/` are ignored by Git. `main.js` and `styles.css` are still the files Obsidian loads, so run `npm run build` before live Obsidian validation if you have not already run `npm run check` after the source change.
@ -49,45 +26,60 @@ The app-server TypeScript bindings in `src/generated/app-server/` are generated
```sh
npm run generate:app-server-types
npm run generate:app-server-types:check
npm run check
```
Do not hand-edit the bindings. `src/app-server/connection/compatibility.json` records their CLI patch and generation arguments; the check command regenerates and compares them without replacing tracked files.
The generation script uses `codex app-server generate-ts --experimental` because the panel depends on experimental app-server fields. Do not hand-edit generated bindings.
## Placement Rules
Follow the ownership boundaries in `docs/design.md` and the import and source-shape lint rules. Put behavior where its reason to change lives, and update the lint policy and its tests when intentionally changing a boundary.
The source tree is organized by implementation ownership, not by the single Obsidian plugin entrypoint. Put behavior where its reason to change lives: app-server protocol adaptation at the app-server boundary, app-server-independent domain models in domain code, cross-feature reusable adapters and primitives under `src/shared/`, and feature workflows under their owning feature. Keep shared subfolders named by the boundary or primitive they own, such as DOM, Obsidian, runtime, or UI rendering.
Keep generated protocol types behind app-server adapters and expose panel-owned contracts or projections to features. Keep direct DOM work in explicit bridge, measurement, or rendering modules; use the established filename suffixes for those boundaries and reserve `.tsx` for rendering.
Within chat, keep state transitions and workflow orchestration separate from app-server adaptation, session/Obsidian wiring, and rendering surfaces. Tests should mirror the ownership boundary of the code under test.
Keep new code near the state or API it owns. A feature may import another feature only for a capability that feature owns. When moving behavior across an ownership boundary or adding a new shared classification, update the lint policy and its tests with that boundary in the same change.
Generated app-server types should stay behind app-server connection and protocol adapter modules. If domain, shared code, settings, workspace, or feature code needs app-server data, add or reuse a panel-owned projection at the boundary instead of importing generated payload types directly.
Chat application workflows should receive chat-owned contracts, not root `src/app-server/` modules or direct `AppServerClient` access. Keep app-server access, connection freshness checks, vault-path injection, and payload projection in `src/features/chat/app-server/` transports or host-owned wiring.
Chat panel-visible state belongs in `ChatStateStore` and should flow through named reducer actions and the panel read model adapter. Use Preact Signals only in chat panel rendering adapters such as the shell read model and surface projections. When a surface needs fewer dependencies, narrow the read model instead of passing broad reducer slices.
Chat feature dependencies should flow from pure workflow and meaning code toward owned adapters and render surfaces. Lower layers must not reach into host/session wiring, panel internals, or UI implementation details.
Chat modules should not import `src/workspace/` directly; workspace operations enter chat through host contracts, while workspace modules may coordinate concrete Obsidian chat views.
Use DOM reads, writes, measurements, hit-tests, focus/selection operations, and DOM event listener wiring only from explicit bridge modules, Obsidian-owned API boundaries, or rendering and measurement code that cannot be expressed cleanly as Preact components. Normal modules may keep refs and call named adapters, but they should not interpret DOM structure or layout directly. Name bridge files with a `.dom`, `.obsidian`, or `.measure` suffix.
Use `.tsx` only where the module owns rendering or a host rendering bridge. Non-rendering source should use `.ts`; when a new rendering-owned location is intentional, update the source-shape lint policy and its tests rather than relying on convention alone.
## CSS Rules
CSS should stay native to Obsidian. Prefer Obsidian variables and Codex Panel tokens for color, typography, spacing, and layout dimensions instead of hardcoded values.
Keep selectors shallow and scoped to Codex Panel classes. Add new authored CSS files to `src/styles/order.json`, and remove unused or test-only classes.
Keep selectors shallow and specific to Codex Panel classes. Avoid broad invalidation patterns such as `:has()`, hidden specificity inside `:where()`, IDs, and universal selectors. Keep needed type selectors under Codex Panel-owned class roots for Obsidian-rendered or semantic child DOM. Add new authored CSS files to `src/styles/order.json`, and remove unused or test-only `codex-panel` classes instead of keeping dead styles.
## Naming Conventions
Name modules by owned responsibility. Use lifecycle or boundary nouns only when the object owns that lifecycle or boundary, and passive-data names for values.
Name modules by responsibility: use `Controller` only for stateful lifecycle/control surfaces, `Handler` for inbound event or request entrypoints, `Actions` for caller-facing command or callback bundles without lifecycle ownership, `Coordinator` for stateful background or cross-surface coordination, `Service` for reusable domain capabilities, `Presenter` for UI state projection, `Renderer` for render-only UI contracts, and `Host`/`Ports` for dependency boundary objects. Use `State`, `Snapshot`, `Projection`, `ViewModel`, `Options`, `Context`, `Result`, `Target`, `Capabilities`, or `ActionTargets` for passive value objects; do not use `Actions` for passive values. Use boundary/infrastructure nouns such as `Client`, `Transport`, `Cache`, `Store`, `Catalog`, `Manager`, `Bridge`, `Tracker`, `Session`, `Runtime`, `Provider`, or `Adapter` only when the object owns that concrete boundary or lifecycle role.
Prefer functions and factories. Reserve classes for mutable resource ownership, external class APIs, and `Error` types.
Prefer functions and factory-created objects over classes. Use a class only when it owns mutable lifecycle/resource state, extends or implements an external class-based API such as Obsidian views/modals/tabs, or represents an `Error`; do not use a class merely to group pure functions or dependencies.
## Common Pitfalls
- Build before Obsidian validation. Obsidian loads ignored root assets, not the TypeScript or authored CSS sources directly.
- Preserve last-known-good app-server state on refresh failure. Do not turn disconnected reads into authoritative empty thread lists, settings snapshots, hook inventories, or diagnostics.
- Normalize optional and nullable app-server values before display. Users should not see raw `undefined`, `null`, protocol enum gaps, or fallback labels that imply Panel owns a Codex runtime setting.
- Do not use DOM order as thread history state. Thread stream DOM is a presentation surface, and delayed Markdown rendering can change heights after initial render.
- Do not use DOM order as message history state. Message stream DOM is a presentation surface, and delayed Markdown rendering can change heights after initial render.
## API Baselines
Use the local API baseline report when checking whether the development environment matches the supported API policy:
```sh
npm run api:baseline
```
Obsidian runtime compatibility is declared through `manifest.json` and `versions.json`. The `obsidian` npm package provides compile-time TypeScript API definitions; it is not runtime validation for an Obsidian app-version matrix. Because the project does not run app-version smoke tests, keep the API type package in the same minor as `manifest.minAppVersion` and use the latest patch in that minor for local type checking. `npm run api:baseline` exits non-zero when the local environment or recorded baselines drift. Raise `manifest.minAppVersion` only when intentionally adopting a newer Obsidian app/API minor.
Codex app-server compatibility is managed by CLI minor version. `src/app-server/connection/compatibility.json` is the source of truth for the exact generation patch and app-server capabilities; README displays that patch.
Local compatibility work should run `npm run api:baseline` and `npm run generate:app-server-types:check`; CI runs the same verification with the recorded CLI.
Codex app-server compatibility is managed by Codex CLI minor version. README records the tested Codex CLI patch version, and the baseline check verifies that the local `codex --version` is in the same minor before app-server binding or compatibility work.

View file

@ -4,15 +4,15 @@ GitHub Releases attach only `main.js`, `manifest.json`, and `styles.css` as Obsi
Release work is Jujutsu-first in a colocated Git repository; Git is still used to push the tag that triggers the GitHub Release workflow. If the checkout has not been initialized for Jujutsu yet, run `jj git init --colocate` and `jj bookmark track main --remote=origin` once.
Plugin versions are for Obsidian distribution, not a library API compatibility contract. Use patch releases for workflow-preserving changes, minor releases for visible capabilities or raised runtime baselines, and major releases for disruptive workflow, settings, storage, or support-policy changes.
Plugin versions use SemVer-shaped numbers for Obsidian distribution, but they are not a library API compatibility contract. Prefer patch releases for fixes, dependency updates, internal changes, and compatibility refreshes that preserve existing workflows, including routine Codex CLI app-server compatibility updates. Prefer minor releases for user-visible capabilities, settings, workflow additions, or supported-runtime baseline changes such as raising the minimum supported Obsidian app/API version. Reserve major releases for disruptive workflow, settings, storage, or support-policy changes.
Create a release by preparing the next version, reviewing and editing the generated release notes, committing the release changes, then running the preflight before pushing the matching tag:
Create a release by preparing the next version, editing the generated release notes, committing the release changes, then running the preflight before pushing the matching tag:
```sh
npm run release:prepare -- X.Y.Z
# Review and edit .github/release-notes/X.Y.Z.md.
# Edit .github/release-notes/X.Y.Z.md.
jj status
jj commit -m "chore(release): X.Y.Z"
jj commit -m "Bump version to X.Y.Z"
jj bookmark move main --to @-
npm run release:preflight
jj tag set X.Y.Z -r main
@ -20,10 +20,8 @@ jj git push --remote origin --bookmark main
git push origin X.Y.Z
```
`release:prepare` updates version files and drafts `## Changes` from selected Conventional Commits since the previous version. Use those commits to locate candidate changes, then compare the resulting user-visible behavior with the previous release before choosing the version. Review the draft against the full diff for complete, user-facing notes; consolidate and reorder entries as needed, and replace an empty placeholder.
Run `release:preflight` after the release commit is on `main`; it validates the commit range and release readiness.
`release:prepare` updates the version files and creates a `## Changes` release notes template. `release:preflight` verifies the local Jujutsu/Git state, release metadata, API baselines, lockfile, and the same `npm run check` validation used by CI after the release commit is on `main`.
Release notes should normally include only user-facing changes. Internal implementation changes, validation details, and release procedure notes should be omitted when minor; when they are important enough to mention, group them into at most one concise bullet.
The release notes file must contain a single `## Changes` section. The tag-triggered workflow validates and publishes the install assets. If it fails before creating the GitHub Release, fix the commit, move the local tag with `jj tag set --allow-move -r main X.Y.Z`, then update the remote tag with `git push --force origin X.Y.Z`.
The release workflow runs `npm ci`, `npm run release:check`, `npm run check`, attaches the install assets, and generates GitHub artifact attestations for them. The release notes file is required and must contain a single `## Changes` section. If a tag-triggered release fails before creating the GitHub Release, fix the commit, move the local tag with `jj tag set --allow-move -r main X.Y.Z`, then update the remote tag with `git push --force origin X.Y.Z`.

View file

@ -1,7 +1,7 @@
{
"id": "codex-panel",
"name": "Codex Panel",
"version": "5.2.1",
"version": "4.0.2",
"minAppVersion": "1.12.0",
"description": "Codex in your sidebar.",
"author": "murashit",

4270
package-lock.json generated

File diff suppressed because it is too large Load diff

View file

@ -1,6 +1,6 @@
{
"name": "codex-panel",
"version": "5.2.1",
"version": "4.0.2",
"description": "Codex in your Obsidian sidebar.",
"main": "main.js",
"author": "murashit",
@ -13,14 +13,10 @@
"url": "https://github.com/murashit/codex-panel/issues"
},
"homepage": "https://github.com/murashit/codex-panel#readme",
"engines": {
"node": ">=26"
},
"scripts": {
"api:baseline": "node scripts/api-baseline.mjs",
"build": "node esbuild.config.mjs",
"build:styles": "node scripts/build-styles.mjs",
"commitlint": "commitlint",
"check": "concurrently --group --pad-prefix 'node:check:*' && node --run build",
"check:biome": "biome check --diagnostic-level=warn --error-on-warnings",
"check:css-usage": "node scripts/check-css-usage.mjs",
@ -28,50 +24,32 @@
"check:test": "node --run test",
"check:typecheck": "node --run typecheck",
"check:unused": "knip --no-progress",
"fix": "biome check --fix --skip=plugin --diagnostic-level=warn --error-on-warnings && knip --fix --no-progress",
"fix": "biome check --fix --diagnostic-level=warn --error-on-warnings && knip --fix --no-progress",
"generate:app-server-types": "node scripts/generate-app-server-types.mjs",
"generate:app-server-types:check": "node scripts/generate-app-server-types.mjs --check",
"release:check": "node scripts/release/check.mjs",
"release:notes": "node scripts/release/notes.mjs",
"release:preflight": "node scripts/release/preflight.mjs",
"release:prepare": "node scripts/release/prepare.mjs",
"test": "vitest run --pool threads --maxWorkers 6",
"test:coverage": "vitest run --pool threads --maxWorkers 6 --coverage",
"test:mutation": "stryker run",
"typecheck": "tsc -p tsconfig.json --noEmit --incremental --tsBuildInfoFile node_modules/.cache/typescript/tsconfig.tsbuildinfo"
},
"devDependencies": {
"@biomejs/biome": "^2.5.3",
"@commitlint/cli": "^21.2.1",
"@commitlint/config-conventional": "^21.2.0",
"@stryker-mutator/core": "^9.6.1",
"@stryker-mutator/vitest-runner": "^9.6.1",
"@types/mdast": "^4.0.4",
"@types/node": "^26.1.1",
"@vitest/coverage-v8": "^4.1.10",
"concurrently": "^9.2.4",
"conventional-changelog-conventionalcommits": "^10.2.1",
"conventional-commits-parser": "^7.1.0",
"@biomejs/biome": "^2.5.1",
"@types/node": "^25.9.3",
"concurrently": "^10.0.3",
"esbuild": "^0.28.0",
"eslint": "^10.6.0",
"eslint-plugin-obsidianmd": "^0.4.1",
"eslint": "^10.5.0",
"eslint-plugin-obsidianmd": "^0.3.0",
"jsdom": "^29.1.1",
"knip": "^6.25.0",
"moment": "^2.30.1",
"knip": "^6.17.1",
"obsidian": "~1.12.3",
"typescript": "^6.0.3",
"typescript-eslint": "^8.64.0",
"vitest": "^4.1.10"
"typescript-eslint": "^8.61.1",
"vitest": "^4.1.9"
},
"dependencies": {
"@tanstack/query-core": "^5.101.2",
"defuddle": "^0.19.1",
"diff": "^9.0.0",
"mdast-util-from-markdown": "^2.0.3",
"mdast-util-to-markdown": "^2.1.2",
"@preact/signals": "^2.9.2",
"@tanstack/query-core": "^5.101.0",
"micromark": "^4.0.2",
"obsidian-daily-notes-interface": "^0.9.5",
"preact": "^10.29.7",
"unist-util-visit": "^5.1.0"
"preact": "^10.29.2"
}
}

View file

@ -59,10 +59,8 @@ export async function createApiBaselineReport(options = {}) {
const readmeBaselines = readCompatibilityBaselines(inputs.readme);
const codexReadmeVersion = readmeBaselines.codexTestedCliVersion;
const codexRecordedVersion = inputs.appServerCompatibilityJson.codexAppServer?.testedCliVersion ?? null;
const codexLocalVersion = options.readCodexVersion ? await options.readCodexVersion() : readCodexVersion();
const codexReadmeSemver = parseSemver(codexReadmeVersion);
const codexRecordedSemver = parseSemver(codexRecordedVersion);
const codexLocalSemver = parseSemver(codexLocalVersion);
const obsidianMinVersion = inputs.manifestJson.minAppVersion;
@ -75,42 +73,25 @@ export async function createApiBaselineReport(options = {}) {
const obsidianLockSemver = parseSemver(obsidianLockVersion);
const obsidianMinSemver = parseSemver(obsidianMinVersion);
const generationArguments = inputs.appServerCompatibilityJson.codexAppServer?.typeGeneration?.arguments ?? null;
const expectedGenerationArguments = ["app-server", "generate-ts", "--experimental"];
const appServerGenerationArgumentsDeclared =
Array.isArray(generationArguments) && generationArguments.every((argument) => typeof argument === "string");
const appServerGenerationArgumentsSupported =
appServerGenerationArgumentsDeclared && arraysEqual(generationArguments, expectedGenerationArguments);
const initializeCapabilities = inputs.appServerCompatibilityJson.codexAppServer?.initialize?.capabilities ?? {};
const initializeExperimentalApi = initializeCapabilities.experimentalApi === true;
const initializeRequestAttestationDisabled = initializeCapabilities.requestAttestation === false;
const appServerGenerationExperimental =
inputs.appServerGenerateSource.includes("app-server") &&
inputs.appServerGenerateSource.includes("generate-ts") &&
inputs.appServerGenerateSource.includes("--experimental");
const initializeExperimentalApi = /experimentalApi:\s*true/.test(inputs.clientSource);
const initializeRequestAttestationDisabled = /requestAttestation:\s*false/.test(inputs.clientSource);
if (!codexReadmeSemver) {
fail("README.md Compatibility table must define `codexAppServer.testedCliVersion` as X.Y.Z.");
}
if (!codexRecordedSemver || codexRecordedSemver.version !== codexRecordedVersion) {
fail("src/app-server/connection/compatibility.json must declare codexAppServer.testedCliVersion as X.Y.Z.");
fail("README.md Compatibility table must define `codex.testedCliVersion` as X.Y.Z.");
}
if (!codexLocalSemver) {
fail("local codex --version could not be read.");
}
if (codexReadmeVersion && codexRecordedVersion && codexReadmeVersion !== codexRecordedVersion) {
fail(`README Codex CLI ${codexReadmeVersion} does not match recorded tested CLI ${codexRecordedVersion}.`);
}
if (codexLocalSemver && codexRecordedSemver && codexLocalSemver.version !== codexRecordedSemver.version) {
fail(`local Codex CLI ${codexLocalSemver.version} does not match recorded tested CLI ${codexRecordedSemver.version}.`);
}
if (!appServerGenerationArgumentsDeclared) {
fail("src/app-server/connection/compatibility.json must declare codexAppServer.typeGeneration.arguments as a string array.");
} else if (!appServerGenerationArgumentsSupported) {
fail(`app-server type generation arguments must be ${expectedGenerationArguments.join(" ")}.`);
}
if (!initializeExperimentalApi) {
fail("src/app-server/connection/compatibility.json must declare codexAppServer.initialize.capabilities.experimentalApi: true.");
}
if (!initializeRequestAttestationDisabled) {
fail("src/app-server/connection/compatibility.json must declare codexAppServer.initialize.capabilities.requestAttestation: false.");
if (codexReadmeSemver && codexLocalSemver && minorKey(codexReadmeSemver) !== minorKey(codexLocalSemver)) {
fail(`local Codex CLI minor ${minorKey(codexLocalSemver)} does not match compatibility table minor ${minorKey(codexReadmeSemver)}.`);
}
if (!appServerGenerationExperimental) fail("generate:app-server-types must use codex app-server generate-ts --experimental.");
if (!initializeExperimentalApi) fail("app-server initialize must declare experimentalApi: true.");
if (!initializeRequestAttestationDisabled) fail("app-server initialize must declare requestAttestation: false.");
if (!obsidianMinSemver) fail("manifest.json minAppVersion must be X.Y.Z.");
if (obsidianMinSemver && obsidianMinSemver.patch !== 0) {
@ -145,17 +126,13 @@ export async function createApiBaselineReport(options = {}) {
return {
codex: {
policy: "compatibility is managed by minor; generated bindings are proven against an exact CLI patch",
recordedTestedCliVersion: codexRecordedVersion,
policy: "managed by minor version",
readmeTestedCliVersion: codexReadmeVersion,
readmeTestedMinor: minorKey(codexReadmeSemver),
localCliVersion: codexLocalVersion,
localCliMinor: minorKey(codexLocalSemver),
readmeMatchesRecordedVersion: codexReadmeVersion && codexRecordedVersion ? codexReadmeVersion === codexRecordedVersion : false,
localCliMatchesRecordedVersion:
codexLocalSemver && codexRecordedSemver ? codexLocalSemver.version === codexRecordedSemver.version : null,
generationArguments,
appServerGenerationArgumentsSupported,
localCliMatchesTestedMinor: codexReadmeSemver && codexLocalSemver ? minorKey(codexReadmeSemver) === minorKey(codexLocalSemver) : null,
appServerGenerationExperimental,
initializeExperimentalApi,
initializeRequestAttestationDisabled,
},
@ -180,7 +157,7 @@ function readCompatibilityBaselines(readme) {
const section = markdownSection(readme, "Compatibility");
const table = readMarkdownTableValues(section);
return {
codexTestedCliVersion: table.get("codexAppServer.testedCliVersion") ?? null,
codexTestedCliVersion: table.get("codex.testedCliVersion") ?? null,
obsidianApiTypesVersion: table.get("obsidian") ?? null,
obsidianMinAppVersion: table.get("manifest.minAppVersion") ?? null,
};
@ -247,22 +224,20 @@ function displayValue(value) {
return value ?? "(missing)";
}
function arraysEqual(left, right) {
return left.length === right.length && left.every((value, index) => value === right[index]);
}
async function readBaselineInputs(cwd) {
const [packageJson, packageLockJson, manifestJson, versionsJson, readme, appServerCompatibilityJson] = await Promise.all([
const [packageJson, packageLockJson, manifestJson, versionsJson, readme, clientSource, appServerGenerateSource] = await Promise.all([
readJson(cwd, "package.json"),
readJson(cwd, "package-lock.json"),
readJson(cwd, "manifest.json"),
readJson(cwd, "versions.json"),
readFile(path.join(cwd, "README.md"), "utf8"),
readJson(cwd, "src/app-server/connection/compatibility.json"),
readFile(path.join(cwd, "src/app-server/connection/client.ts"), "utf8"),
readFile(path.join(cwd, "scripts/generate-app-server-types.mjs"), "utf8"),
]);
return {
appServerCompatibilityJson,
appServerGenerateSource,
clientSource,
manifestJson,
packageJson,
packageLockJson,
@ -285,11 +260,10 @@ function printReport(report) {
console.log("Codex app-server");
console.log(` policy: ${report.codex.policy}`);
console.log(` compatibility table CLI: ${displayValue(report.codex.readmeTestedCliVersion)}`);
console.log(` recorded tested CLI: ${displayValue(report.codex.recordedTestedCliVersion)}`);
console.log(` compatibility table minor: ${displayValue(report.codex.readmeTestedMinor)}`);
console.log(` local codex CLI: ${displayValue(report.codex.localCliVersion)}`);
console.log(` local codex minor: ${displayValue(report.codex.localCliMinor)}`);
console.log(` generation arguments: ${report.codex.generationArguments?.join(" ") ?? "(missing)"}`);
console.log(` generate-ts --experimental: ${report.codex.appServerGenerationExperimental ? "yes" : "no"}`);
console.log(` initialize experimentalApi: ${report.codex.initializeExperimentalApi ? "yes" : "no"}`);
console.log(` initialize requestAttestation disabled: ${report.codex.initializeRequestAttestationDisabled ? "yes" : "no"}`);
console.log("");

View file

@ -1,49 +0,0 @@
import { readFile } from "node:fs/promises";
import path from "node:path";
import { fileURLToPath } from "node:url";
const compatibilityRelativePath = "src/app-server/connection/compatibility.json";
const exactSemverPattern = /^\d+\.\d+\.\d+$/;
if (isMain()) {
const args = process.argv.slice(2);
if (args.length !== 1 || args[0] !== "--tested-cli-version") {
console.error("Usage: node scripts/app-server-compatibility.mjs --tested-cli-version");
process.exit(1);
}
try {
const policy = await readAppServerGenerationPolicy(process.cwd());
console.log(policy.testedCliVersion);
} catch (error) {
console.error(error instanceof Error ? error.message : String(error));
process.exit(1);
}
}
export async function readAppServerGenerationPolicy(cwd) {
const compatibilityPath = path.join(cwd, compatibilityRelativePath);
const compatibility = JSON.parse(await readFile(compatibilityPath, "utf8"));
const testedCliVersion = compatibility.codexAppServer?.testedCliVersion;
const generationArguments = compatibility.codexAppServer?.typeGeneration?.arguments;
if (typeof testedCliVersion !== "string" || !exactSemverPattern.test(testedCliVersion)) {
throw new Error(`${compatibilityRelativePath} must declare codexAppServer.testedCliVersion as X.Y.Z.`);
}
if (!isStringArray(generationArguments) || generationArguments.length === 0) {
throw new Error(`${compatibilityRelativePath} must declare codexAppServer.typeGeneration.arguments as a non-empty string array.`);
}
if (generationArguments.includes("--out")) {
throw new Error(`${compatibilityRelativePath} must not include --out in codexAppServer.typeGeneration.arguments.`);
}
return { generationArguments, testedCliVersion };
}
function isStringArray(value) {
return Array.isArray(value) && value.every((entry) => typeof entry === "string" && entry.length > 0);
}
function isMain() {
return process.argv[1] ? path.resolve(process.argv[1]) === fileURLToPath(import.meta.url) : false;
}

View file

@ -21,7 +21,6 @@ export async function buildStyles() {
}
export async function renderStyles() {
const { version } = JSON.parse(await readFile("package.json", "utf8"));
const parts = [];
const sourceFiles = await readStyleOrder();
@ -30,7 +29,7 @@ export async function renderStyles() {
parts.push(content.trimEnd());
}
return `/* Codex Panel v${version} */\n\n${parts.join("\n\n")}\n`;
return `${parts.join("\n\n")}\n`;
}
async function readStyleOrder() {

View file

@ -15,8 +15,6 @@ const sourceFiles = await filesInTree(path.join(root, "src"), new Set([".ts", ".
const testFiles = await filesInTree(path.join(root, "tests"), new Set([".ts", ".tsx"]));
const cssClasses = await collectCssClasses(cssFiles);
const cssCustomProperties = await collectCssCustomProperties(cssFiles);
const referencedCssCustomProperties = await collectReferencedCssCustomProperties(cssFiles);
const sourceTexts = await readTexts(sourceFiles);
const testTexts = await readTexts(testFiles);
const sourceText = sourceTexts.map((item) => item.text).join("\n");
@ -24,7 +22,6 @@ const dynamicPrefixes = collectDynamicClassPrefixes(sourceText);
const testOnlyCandidates = [];
const candidates = [];
const unusedCustomProperties = [];
for (const [className, locations] of cssClasses) {
const sourceMatches = locationsInTexts(sourceTexts, className);
@ -39,13 +36,8 @@ for (const [className, locations] of cssClasses) {
candidates.push({ className, locations });
}
for (const [propertyName, locations] of cssCustomProperties) {
if (referencedCssCustomProperties.has(propertyName) || locationsInTexts(sourceTexts, propertyName).length > 0) continue;
unusedCustomProperties.push({ propertyName, locations });
}
if (candidates.length + testOnlyCandidates.length + unusedCustomProperties.length + dynamicPrefixes.length > 0) {
printCandidates({ testOnlyCandidates, candidates, unusedCustomProperties, dynamicPrefixes });
if (candidates.length + testOnlyCandidates.length + dynamicPrefixes.length > 0) {
printCandidates({ testOnlyCandidates, candidates, dynamicPrefixes });
process.exit(1);
}
@ -61,11 +53,12 @@ async function orderedCssFiles() {
async function collectCssClasses(files) {
const result = new Map();
for (const file of files) {
const text = stripCssComments(await readFile(file, "utf8"));
const text = await readFile(file, "utf8");
const lines = text.split("\n");
for (const [index, line] of lines.entries()) {
const withoutComment = line.replace(/\/\*.*?\*\//g, "");
const classPattern = /(^|[^\\])\.([_a-zA-Z][\w-]*)/g;
for (const match of line.matchAll(classPattern)) {
for (const match of withoutComment.matchAll(classPattern)) {
const className = match[2];
if (!className.startsWith("codex-panel")) continue;
const locations = result.get(className) ?? [];
@ -77,38 +70,6 @@ async function collectCssClasses(files) {
return new Map([...result.entries()].sort(([left], [right]) => left.localeCompare(right)));
}
async function collectCssCustomProperties(files) {
const result = new Map();
for (const file of files) {
const text = stripCssComments(await readFile(file, "utf8"));
const lines = text.split("\n");
for (const [index, line] of lines.entries()) {
for (const match of line.matchAll(/(--codex-panel-[\w-]+)\s*:/g)) {
const propertyName = match[1];
const locations = result.get(propertyName) ?? [];
locations.push(`${relative(file)}:${index + 1}`);
result.set(propertyName, locations);
}
}
}
return new Map([...result.entries()].sort(([left], [right]) => left.localeCompare(right)));
}
async function collectReferencedCssCustomProperties(files) {
const result = new Set();
for (const file of files) {
const text = stripCssComments(await readFile(file, "utf8"));
for (const match of text.matchAll(/var\(\s*(--codex-panel-[\w-]+)/g)) {
result.add(match[1]);
}
}
return result;
}
function stripCssComments(text) {
return text.replace(/\/\*[\s\S]*?\*\//g, (comment) => comment.replace(/[^\n]/g, ""));
}
function collectDynamicClassPrefixes(text) {
const prefixes = new Set();
const templatePrefixPattern = /codex-panel(?:-[a-z]+)?__[a-z0-9-]+--\$\{/g;
@ -128,12 +89,9 @@ async function readTexts(files) {
function locationsInTexts(texts, needle) {
const locations = [];
const escapedNeedle = needle.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
const pattern = new RegExp(`(^|[^\\w-])${escapedNeedle}(?![\\w-])`);
for (const { file, text } of texts) {
const match = pattern.exec(text);
if (!match) continue;
const offset = match.index + match[1].length;
const offset = text.indexOf(needle);
if (offset === -1) continue;
const line = text.slice(0, offset).split("\n").length;
locations.push(`${relative(file)}:${line}`);
}
@ -161,7 +119,7 @@ async function collectFiles(directory, extensions, excludedPrefixes, result) {
}
}
function printCandidates({ testOnlyCandidates, candidates, unusedCustomProperties, dynamicPrefixes }) {
function printCandidates({ testOnlyCandidates, candidates, dynamicPrefixes }) {
console.error("CSS usage check failed.");
if (dynamicPrefixes.length > 0) {
console.error("");
@ -189,15 +147,6 @@ function printCandidates({ testOnlyCandidates, candidates, unusedCustomPropertie
console.error(` css: ${item.locations.join(", ")}`);
}
}
if (unusedCustomProperties.length > 0) {
console.error("");
console.error("Unused CSS custom property candidates:");
for (const item of unusedCustomProperties) {
console.error(` ${item.propertyName}`);
console.error(` css: ${item.locations.join(", ")}`);
}
}
}
function relative(file) {

View file

@ -1,102 +1,28 @@
import { spawnSync } from "node:child_process";
import { mkdir, mkdtemp, readdir, readFile, rename, rm, writeFile } from "node:fs/promises";
import { mkdir, readdir, readFile, rm, writeFile } from "node:fs/promises";
import path from "node:path";
import { fileURLToPath } from "node:url";
import { readAppServerGenerationPolicy } from "./app-server-compatibility.mjs";
const generatedRelativeDir = "src/generated/app-server";
const generatedHeader = "// GENERATED CODE! DO NOT MODIFY BY HAND!";
const normalizationNotice = "// This file was mechanically normalized after generation by scripts/generate-app-server-types.mjs.";
if (process.argv[1] && path.resolve(process.argv[1]) === fileURLToPath(import.meta.url)) {
try {
const args = process.argv.slice(2);
if (args.some((arg) => arg !== "--check") || args.length > 1) {
throw new Error("Usage: node scripts/generate-app-server-types.mjs [--check]");
}
await generateAppServerTypes({ check: args.includes("--check") });
} catch (error) {
console.error(error instanceof Error ? error.message : String(error));
process.exitCode = 1;
}
await generateAppServerTypes();
}
export async function generateAppServerTypes(options = {}) {
const cwd = options.cwd ?? process.cwd();
const generatedDir = path.resolve(cwd, generatedRelativeDir);
const runCommand = options.runCommand ?? run;
const readCodexVersion = options.readCodexVersion ?? readInstalledCodexVersion;
const policy = await readAppServerGenerationPolicy(cwd);
const installedCliVersion = await readCodexVersion(cwd);
if (installedCliVersion !== policy.testedCliVersion) {
throw new Error(
`Codex CLI ${policy.testedCliVersion} is required to generate app-server bindings; found ${installedCliVersion ?? "an unreadable version"}.`,
);
}
const generatedParent = path.dirname(generatedDir);
await mkdir(generatedParent, { recursive: true });
const stagedDir = await mkdtemp(path.join(generatedParent, ".app-server-"));
try {
const stagedRelativeDir = path.relative(cwd, stagedDir);
await runCommand("codex", [...policy.generationArguments, "--out", stagedRelativeDir], { cwd });
await normalizeGeneratedTypes(stagedDir);
if (options.check === true) {
const differences = await compareGeneratedTrees(generatedDir, stagedDir);
if (differences.length > 0) {
throw new Error(`generated app-server bindings are out of date:\n${differences.map((difference) => ` ${difference}`).join("\n")}`);
}
} else {
await replaceGeneratedTypes(generatedDir, stagedDir);
}
} finally {
await rm(stagedDir, { recursive: true, force: true });
}
await cleanGeneratedTypes(generatedDir);
await runCommand("codex", ["app-server", "generate-ts", "--experimental", "--out", generatedRelativeDir], { cwd });
await normalizeGeneratedTypes(generatedDir);
}
async function compareGeneratedTrees(trackedDir, stagedDir) {
const [trackedFiles, stagedFiles] = await Promise.all([listFiles(trackedDir), listFiles(stagedDir)]);
const trackedSet = new Set(trackedFiles);
const stagedSet = new Set(stagedFiles);
const differences = [];
for (const file of stagedFiles) {
if (!trackedSet.has(file)) {
differences.push(`added: ${file}`);
continue;
}
const [trackedSource, stagedSource] = await Promise.all([readFile(path.join(trackedDir, file)), readFile(path.join(stagedDir, file))]);
if (!trackedSource.equals(stagedSource)) differences.push(`changed: ${file}`);
}
for (const file of trackedFiles) {
if (!stagedSet.has(file)) differences.push(`removed: ${file}`);
}
return differences;
}
async function replaceGeneratedTypes(generatedDir, stagedDir) {
const backupDir = `${generatedDir}.backup-${process.pid.toString()}-${Date.now().toString()}`;
let hasBackup = false;
try {
try {
await rename(generatedDir, backupDir);
hasBackup = true;
} catch (error) {
if (!isMissingPathError(error)) throw error;
}
await rename(stagedDir, generatedDir);
if (hasBackup) await rm(backupDir, { recursive: true, force: true });
} catch (error) {
if (hasBackup) {
await rm(generatedDir, { recursive: true, force: true });
await rename(backupDir, generatedDir);
}
throw error;
}
}
function isMissingPathError(error) {
return error instanceof Error && "code" in error && error.code === "ENOENT";
async function cleanGeneratedTypes(generatedDir) {
await rm(generatedDir, { recursive: true, force: true });
await mkdir(generatedDir, { recursive: true });
}
async function normalizeGeneratedTypes(generatedDir) {
@ -124,24 +50,6 @@ async function listTypeScriptFiles(dir) {
return files.flat();
}
async function listFiles(dir, relativeDir = "") {
let entries;
try {
entries = await readdir(path.join(dir, relativeDir), { withFileTypes: true });
} catch (error) {
if (isMissingPathError(error)) return [];
throw error;
}
const files = await Promise.all(
entries.map((entry) => {
const relativePath = path.join(relativeDir, entry.name);
if (entry.isDirectory()) return listFiles(dir, relativePath);
return entry.isFile() ? [relativePath.replaceAll(path.sep, "/")] : [];
}),
);
return files.flat().sort();
}
function normalizeSource(source) {
let normalized = source;
do {
@ -164,18 +72,8 @@ function run(command, args, options = {}) {
shell: false,
});
if (result.error) {
throw new Error(`Failed to run ${command} ${args.join(" ")}: ${result.error.message}`);
console.error(`Failed to run ${command} ${args.join(" ")}: ${result.error.message}`);
process.exit(1);
}
if (result.status !== 0) throw new Error(`${command} ${args.join(" ")} exited with status ${(result.status ?? 1).toString()}.`);
}
function readInstalledCodexVersion(cwd) {
const result = spawnSync("codex", ["--version"], {
cwd,
encoding: "utf8",
stdio: "pipe",
shell: false,
});
if (result.error || result.status !== 0) return null;
return `${result.stdout}\n${result.stderr}`.match(/\b\d+\.\d+\.\d+\b/)?.[0] ?? null;
if (result.status !== 0) process.exit(result.status ?? 1);
}

View file

@ -9,7 +9,12 @@ private pattern js_module_reference() {
private pattern app_server_protocol_source() { r"^[\"'](?:(?:\.\./)+app-server/protocol|src/app-server/protocol)/[^/\"']+(?:/.*)?[\"']$" }
private pattern turn_protocol_source() { r"^[\"'](?:(?:\.\./)+app-server/protocol/turn|src/app-server/protocol/turn)(?:/.*)?[\"']$" }
js_module_reference() as $stmt where {
$stmt <: contains `$source` where { $source <: app_server_protocol_source() },
$stmt <: contains `$source` where {
$source <: app_server_protocol_source(),
not { $filename <: r".*/src/features/chat/app-server/mappers/message-stream/turn-items\.ts$", $source <: turn_protocol_source() }
},
register_diagnostic(span=$stmt, message="Source modules outside root src/app-server must use domain models and app-server services instead of app-server protocol modules. Chat turn-item conversion may consume turn protocol at its app-server boundary; feature state and UI must use Panel-owned models.", severity="error")
}

View file

@ -9,7 +9,7 @@ private pattern js_module_reference() {
js_module_reference() as $stmt where {
$stmt <: contains `$source` where {
$source <: r"^[\"'](?:(?:\.\./)+(?:app-server|host|panel|presentation|ui)|(?:\.\./){2,}(?:selection-rewrite|thread-picker|threads|threads-view|turn-diff)|src/(?:app-server|features/(?:chat/(?:app-server|host|panel|presentation|ui)|selection-rewrite|thread-picker|threads|threads-view|turn-diff)))(?:/.*)?[\"']$"
$source <: r"^[\"'](?:(?:\.\./)+(?:app-server|host|panel|presentation|ui)|src/(?:app-server|features/chat/(?:app-server|host|panel|presentation|ui)))(?:/.*)?[\"']$"
},
register_diagnostic(span=$stmt, message="Chat application modules must not import app-server, sibling feature, host, panel, presentation, or UI layers; expose state and workflow contracts instead.", severity="error")
register_diagnostic(span=$stmt, message="Chat application modules must not import app-server, host, panel, presentation, or UI layers; expose state and workflow contracts instead.", severity="error")
}

View file

@ -0,0 +1,17 @@
language js
private pattern js_module_reference() {
or {
JsImport(),
JsImportCallExpression()
}
}
private pattern chat_shell_read_model_source() {
r"^[\"'](?:(?:\.\./)+(?:panel/)?shell-read-model|(?:\./)?shell-read-model|src/features/chat/panel/shell-read-model)(?:\.ts)?[\"']$"
}
js_module_reference() as $stmt where {
$stmt <: contains `$source` where { $source <: chat_shell_read_model_source() },
register_diagnostic(span=$stmt, message="Import chat panel signal read models only from the shell and panel surface rendering adapters.", severity="error")
}

View file

@ -0,0 +1,8 @@
language js
or {
`ReadonlySignal<$type>` as $stmt,
`Signal<$type>` as $stmt
} where {
register_diagnostic(span=$stmt, message="Keep Preact signal types inside the chat panel read-model and surface rendering adapter layer.", severity="error")
}

View file

@ -1,17 +0,0 @@
language js
private pattern js_module_reference() {
or {
JsImport(),
JsImportCallExpression()
}
}
private pattern app_server_protocol_source() { r"^[\"'](?:(?:\.\./)+app-server/protocol|src/app-server/protocol)/[^/\"']+(?:/.*)?[\"']$" }
private pattern turn_protocol_source() { r"^[\"'](?:(?:\.\./)+app-server/protocol/turn|src/app-server/protocol/turn)(?:/.*)?[\"']$" }
js_module_reference() as $stmt where {
$stmt <: contains `$source` where { $source <: app_server_protocol_source(), not { $source <: turn_protocol_source() } },
register_diagnostic(span=$stmt, message="Source modules outside root src/app-server must use domain models and app-server services instead of app-server protocol modules. Chat turn-item conversion may consume turn protocol at its app-server boundary; feature state and UI must use Panel-owned models.", severity="error")
}

View file

@ -0,0 +1,13 @@
language js
private pattern js_module_reference() {
or {
JsImport(),
JsImportCallExpression()
}
}
js_module_reference() as $stmt where {
$stmt <: contains `$source` where { $source <: r"^[\"']@preact/signals[\"']$" },
register_diagnostic(span=$stmt, message="Do not import @preact/signals from this module.", severity="error")
}

View file

@ -1,15 +0,0 @@
language js
private pattern js_module_reference() {
or {
JsImport(),
JsImportCallExpression()
}
}
js_module_reference() as $stmt where {
$stmt <: contains `$source` where {
$source <: r"^[\"'](?:(?:\.\./)+app-server/(?:connection|services)|src/app-server/(?:connection|services))(?:/.*)?[\"']$"
},
register_diagnostic(span=$stmt, message="Thread workflows must depend on feature-owned ports instead of app-server clients or services.", severity="error")
}

View file

@ -1,73 +0,0 @@
import { spawnSync } from "node:child_process";
import { pathToFileURL } from "node:url";
import conventionalCommits from "conventional-changelog-conventionalcommits";
import { CommitParser } from "conventional-commits-parser";
const releaseNoteTypes = new Set(["feat", "fix", "perf"]);
const parser = new CommitParser(conventionalCommits().parser);
function fail(message) {
throw new Error(`release notes generation failed: ${message}`);
}
function runGit(args, cwd) {
const result = spawnSync("git", args, {
cwd,
encoding: "utf8",
shell: false,
});
if (result.error) fail(result.error.message);
if (result.status !== 0) {
fail(`${args.join(" ")} exited with ${result.status}: ${result.stderr.trim()}`);
}
return result.stdout;
}
function formatSubject(subject) {
const sentence = subject.replace(/^([a-z])/, (letter) => letter.toUpperCase());
return /[.!?]$/.test(sentence) ? sentence : `${sentence}.`;
}
export function releaseNoteForCommit(message) {
const commit = parser.parse(message);
if (!commit.subject) return null;
const isBreaking = commit.notes.length > 0;
if (!isBreaking && !releaseNoteTypes.has(commit.type ?? "")) return null;
return formatSubject(commit.subject);
}
export function renderReleaseNotes(messages) {
const entries = messages.map(releaseNoteForCommit).filter((entry) => entry !== null);
const bullets = entries.length > 0 ? entries.map((entry) => `- ${entry}`).join("\n") : "- ";
return `## Changes\n\n${bullets}\n`;
}
export function readCommitMessagesSince(tag, cwd = process.cwd()) {
runGit(["rev-parse", "--verify", `refs/tags/${tag}`], cwd);
const output = runGit(["log", "--format=%B%x00", `${tag}..HEAD`], cwd);
return output
.split("\0")
.map((message) => message.trim())
.filter(Boolean);
}
export function generateReleaseNotes(tag, cwd = process.cwd()) {
return renderReleaseNotes(readCommitMessagesSince(tag, cwd));
}
if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) {
const previousTag = process.argv[2];
if (!previousTag) {
console.error("usage: npm run release:notes -- X.Y.Z");
process.exit(1);
}
try {
process.stdout.write(generateReleaseNotes(previousTag));
} catch (error) {
console.error(error instanceof Error ? error.message : error);
process.exit(1);
}
}

View file

@ -1,5 +1,4 @@
import { spawnSync } from "node:child_process";
import { readFileSync } from "node:fs";
function fail(message) {
console.error(`release preflight failed: ${message}`);
@ -82,14 +81,8 @@ if (maybeRun("jj", ["root"])) {
assertGitReleaseState(packageVersion);
}
const versionKeys = Object.keys(JSON.parse(readFileSync("versions.json", "utf8")));
const previousTag = versionKeys.at(-2);
if (!previousTag) fail("versions.json must contain a release before the prepared version");
run("git", ["rev-parse", "--verify", `refs/tags/${previousTag}`], { capture: true });
run("npm", ["run", "commitlint", "--", "--from", previousTag, "--to", "main", "--verbose"]);
run("npm", ["run", "release:check"]);
run("npm", ["run", "api:baseline"]);
run("npm", ["run", "generate:app-server-types:check"]);
run("npm", ["ci", "--dry-run"]);
run("npm", ["run", "check"]);

View file

@ -1,6 +1,5 @@
import { mkdir, readFile, writeFile } from "node:fs/promises";
import path from "node:path";
import { generateReleaseNotes } from "./notes.mjs";
import { compareVersions, isExpectedNextVersion, parseVersion } from "./versioning.mjs";
function fail(message) {
@ -39,13 +38,6 @@ try {
if (error.code !== "ENOENT") throw error;
}
let releaseNotes;
try {
releaseNotes = generateReleaseNotes(previousVersionKey);
} catch (error) {
fail(error instanceof Error ? error.message : String(error));
}
packageJson.version = releaseVersion;
packageLockJson.version = releaseVersion;
if (!packageLockJson.packages?.[""]) fail('package-lock.json is missing packages[""]');
@ -59,7 +51,7 @@ await writeFile("manifest.json", `${JSON.stringify(manifestJson, null, 2)}\n`);
await writeFile("versions.json", `${JSON.stringify(versionsJson, null, 2)}\n`);
await mkdir(notesDir, { recursive: true });
await writeFile(notesPath, releaseNotes);
await writeFile(notesPath, "## Changes\n\n- \n");
console.log(`prepared release ${releaseVersion}`);
console.log(`review and edit ${notesPath}, then run npm run release:preflight after committing`);
console.log(`edit ${notesPath}, then run npm run release:preflight after committing`);

View file

@ -1,6 +1,6 @@
import type { AppServerClient } from "./client";
export type AppServerClientRequestPolicy = { kind: "reject"; message: string };
export type AppServerClientRequestPolicy = { kind: "interactive" } | { kind: "reject"; message: string };
export interface AppServerClientAccessOptions {
serverRequests?: AppServerClientRequestPolicy;

View file

@ -1,32 +0,0 @@
import { CLIENT_VERSION } from "../../constants";
import type { InitializeCapabilities } from "../../generated/app-server/InitializeCapabilities";
import type { InitializeParams } from "../../generated/app-server/InitializeParams";
import compatibility from "./compatibility.json";
interface AppServerCompatibility {
codexAppServer: {
testedCliVersion: string;
typeGeneration: {
arguments: string[];
};
initialize: {
capabilities: Pick<InitializeCapabilities, "experimentalApi" | "requestAttestation">;
};
};
}
const appServerCompatibility = compatibility satisfies AppServerCompatibility;
export function codexPanelAppServerInitializeParams(): InitializeParams {
return {
clientInfo: {
name: "obsidian_codex_panel",
title: "Codex Panel",
version: CLIENT_VERSION,
},
capabilities: {
experimentalApi: appServerCompatibility.codexAppServer.initialize.capabilities.experimentalApi,
requestAttestation: appServerCompatibility.codexAppServer.initialize.capabilities.requestAttestation,
},
};
}

View file

@ -1,4 +1,4 @@
import type { InitializeParams } from "../../generated/app-server/InitializeParams";
import { CLIENT_VERSION } from "../../constants";
import type { InitializeResponse } from "../../generated/app-server/InitializeResponse";
import type { RequestId } from "../../generated/app-server/RequestId";
import type { ServerNotification } from "../../generated/app-server/ServerNotification";
@ -7,14 +7,12 @@ import type { AppsListResponse } from "../../generated/app-server/v2/AppsListRes
import type { CollaborationModeListResponse } from "../../generated/app-server/v2/CollaborationModeListResponse";
import type { ConfigReadResponse } from "../../generated/app-server/v2/ConfigReadResponse";
import type { ConfigWriteResponse } from "../../generated/app-server/v2/ConfigWriteResponse";
import type { EnvironmentInfoResponse } from "../../generated/app-server/v2/EnvironmentInfoResponse";
import type { FsReadFileResponse } from "../../generated/app-server/v2/FsReadFileResponse";
import type { GetAccountRateLimitsResponse } from "../../generated/app-server/v2/GetAccountRateLimitsResponse";
import type { HooksListResponse } from "../../generated/app-server/v2/HooksListResponse";
import type { ListMcpServerStatusResponse } from "../../generated/app-server/v2/ListMcpServerStatusResponse";
import type { ModelListResponse } from "../../generated/app-server/v2/ModelListResponse";
import type { ModelProviderCapabilitiesReadResponse } from "../../generated/app-server/v2/ModelProviderCapabilitiesReadResponse";
import type { PermissionProfileListResponse } from "../../generated/app-server/v2/PermissionProfileListResponse";
import type { PluginInstalledResponse } from "../../generated/app-server/v2/PluginInstalledResponse";
import type { PluginReadResponse } from "../../generated/app-server/v2/PluginReadResponse";
import type { SkillsListResponse } from "../../generated/app-server/v2/SkillsListResponse";
@ -26,16 +24,15 @@ import type { ThreadGoalClearResponse } from "../../generated/app-server/v2/Thre
import type { ThreadGoalGetResponse } from "../../generated/app-server/v2/ThreadGoalGetResponse";
import type { ThreadGoalSetResponse } from "../../generated/app-server/v2/ThreadGoalSetResponse";
import type { ThreadInjectItemsResponse } from "../../generated/app-server/v2/ThreadInjectItemsResponse";
import type { ThreadItemsListResponse } from "../../generated/app-server/v2/ThreadItemsListResponse";
import type { ThreadListResponse } from "../../generated/app-server/v2/ThreadListResponse";
import type { ThreadReadResponse } from "../../generated/app-server/v2/ThreadReadResponse";
import type { ThreadResumeResponse } from "../../generated/app-server/v2/ThreadResumeResponse";
import type { ThreadRollbackResponse } from "../../generated/app-server/v2/ThreadRollbackResponse";
import type { ThreadSetNameResponse } from "../../generated/app-server/v2/ThreadSetNameResponse";
import type { ThreadSettingsUpdateResponse } from "../../generated/app-server/v2/ThreadSettingsUpdateResponse";
import type { ThreadStartResponse } from "../../generated/app-server/v2/ThreadStartResponse";
import type { ThreadTurnsListResponse } from "../../generated/app-server/v2/ThreadTurnsListResponse";
import type { ThreadUnarchiveResponse } from "../../generated/app-server/v2/ThreadUnarchiveResponse";
import type { ThreadUnsubscribeResponse } from "../../generated/app-server/v2/ThreadUnsubscribeResponse";
import type { TurnInterruptResponse } from "../../generated/app-server/v2/TurnInterruptResponse";
import type { TurnStartResponse } from "../../generated/app-server/v2/TurnStartResponse";
import type { TurnSteerResponse } from "../../generated/app-server/v2/TurnSteerResponse";
@ -59,15 +56,6 @@ export interface AppServerServerRequestResponder {
export type AppServerTransportFactory = (handlers: AppServerTransportHandlers) => AppServerTransport;
export interface AppServerClientOptions {
codexPath: string;
cwd: string;
handlers: AppServerClientHandlers;
initializeParams: InitializeParams;
requestTimeoutMs?: number;
transportFactory?: AppServerTransportFactory;
}
export interface ClientResponseByMethod {
initialize: InitializeResponse;
"config/batchWrite": ConfigWriteResponse;
@ -84,18 +72,16 @@ export interface ClientResponseByMethod {
"thread/read": ThreadReadResponse;
"thread/archive": ThreadArchiveResponse;
"thread/delete": ThreadDeleteResponse;
"thread/unsubscribe": ThreadUnsubscribeResponse;
"thread/unarchive": ThreadUnarchiveResponse;
"thread/rollback": ThreadRollbackResponse;
"thread/name/set": ThreadSetNameResponse;
"thread/settings/update": ThreadSettingsUpdateResponse;
"thread/turns/list": ThreadTurnsListResponse;
"thread/items/list": ThreadItemsListResponse;
"skills/list": SkillsListResponse;
"app/list": AppsListResponse;
"plugin/installed": PluginInstalledResponse;
"plugin/read": PluginReadResponse;
"model/list": ModelListResponse;
"permissionProfile/list": PermissionProfileListResponse;
"account/rateLimits/read": GetAccountRateLimitsResponse;
"mcpServerStatus/list": ListMcpServerStatusResponse;
"collaborationMode/list": CollaborationModeListResponse;
@ -105,7 +91,6 @@ export interface ClientResponseByMethod {
"turn/steer": TurnSteerResponse;
"turn/interrupt": TurnInterruptResponse;
"fs/readFile": FsReadFileResponse;
"environment/info": EnvironmentInfoResponse;
}
export type TypedClientRequestMethod = Extract<ClientRequestMethod, keyof ClientResponseByMethod>;
@ -119,20 +104,14 @@ export class AppServerClient {
private lifecycle: AppServerClientLifecycleState = { kind: "disconnected" };
private readonly rpc: JsonRpcClient;
private readonly intentionallyStoppedTransports = new WeakSet<AppServerTransport>();
private readonly codexPath: string;
private readonly cwd: string;
private readonly handlers: AppServerClientHandlers;
private readonly initializeParams: InitializeParams;
private readonly requestTimeoutMs: number;
private readonly transportFactory: AppServerTransportFactory | undefined;
constructor(options: AppServerClientOptions) {
this.codexPath = options.codexPath;
this.cwd = options.cwd;
this.handlers = options.handlers;
this.initializeParams = options.initializeParams;
this.requestTimeoutMs = options.requestTimeoutMs ?? DEFAULT_REQUEST_TIMEOUT_MS;
this.transportFactory = options.transportFactory;
constructor(
private readonly codexPath: string,
private readonly cwd: string,
private readonly handlers: AppServerClientHandlers,
private readonly requestTimeoutMs = DEFAULT_REQUEST_TIMEOUT_MS,
private readonly transportFactory?: AppServerTransportFactory,
) {
this.rpc = new JsonRpcClient({
requestTimeoutMs: this.requestTimeoutMs,
send: (message) => {
@ -197,7 +176,17 @@ export class AppServerClient {
this.lifecycle = { kind: "starting", transport };
try {
transport.start();
const init = await this.request("initialize", this.initializeParams);
const init = await this.request("initialize", {
clientInfo: {
name: "obsidian_codex_panel",
title: "Codex Panel",
version: CLIENT_VERSION,
},
capabilities: {
experimentalApi: true,
requestAttestation: false,
},
});
this.notify({ method: "initialized" });
this.lifecycle = { kind: "initialized", transport, initializeResponse: init };
return init;

View file

@ -1,14 +0,0 @@
{
"codexAppServer": {
"testedCliVersion": "0.145.0",
"typeGeneration": {
"arguments": ["app-server", "generate-ts", "--experimental"]
},
"initialize": {
"capabilities": {
"experimentalApi": true,
"requestAttestation": false
}
}
}
}

View file

@ -1,27 +1,34 @@
import type { ServerInitialization } from "../../domain/server/initialization";
import type { InitializeParams } from "../../generated/app-server/InitializeParams";
import type { ServerNotification } from "../../generated/app-server/ServerNotification";
import type { ServerRequest } from "../../generated/app-server/ServerRequest";
import { AppServerClient, type AppServerClientHandlers, type AppServerServerRequestResponder } from "./client";
import { appServerInitializationFromResponse } from "../protocol/initialization";
import { AppServerClient, type AppServerClientHandlers } from "./client";
export interface ConnectionManagerHandlers {
onNotification: (notification: ServerNotification) => void;
onServerRequest: (request: ServerRequest, responder: AppServerServerRequestResponder) => void;
onServerRequest: (request: ServerRequest) => void;
onLog: (message: string) => void;
onExit: () => void;
}
type AppServerClientFactory = (codexPath: string, cwd: string, handlers: AppServerClientHandlers) => AppServerClient;
export type AppServerClientFactory = (codexPath: string, cwd: string, handlers: AppServerClientHandlers) => AppServerClient;
export interface AppServerConnectionContext {
codexPath: string;
cwd: string;
}
type ConnectionLifecycleState =
| { kind: "idle"; generation: number }
| {
kind: "connecting";
generation: number;
codexPath: string;
cwd: string;
client: AppServerClient;
promise: Promise<ServerInitialization>;
}
| { kind: "connected"; generation: number; client: AppServerClient }
| { kind: "connected"; generation: number; codexPath: string; cwd: string; client: AppServerClient }
| { kind: "disconnected"; generation: number };
export class StaleConnectionError extends Error {
@ -35,15 +42,22 @@ export class ConnectionManager {
private state: ConnectionLifecycleState = { kind: "idle", generation: 0 };
constructor(
private readonly codexPath: string,
private readonly codexPath: () => string,
private readonly cwd: string,
initializeParams: InitializeParams,
private readonly clientFactory: AppServerClientFactory = (codexPath, cwd, handlers) =>
new AppServerClient({ codexPath, cwd, handlers, initializeParams }),
private readonly clientFactory: AppServerClientFactory = (codexPath, cwd, handlers) => new AppServerClient(codexPath, cwd, handlers),
) {}
currentClient(): AppServerClient | null {
return this.state.kind === "connected" && this.state.client.isConnected() ? this.state.client : null;
return this.state.kind === "connected" && this.state.client.isConnected() && this.stateMatchesCurrentContext(this.state)
? this.state.client
: null;
}
currentConnectionContext(): AppServerConnectionContext | null {
if (this.state.kind !== "connected" || !this.state.client.isConnected() || !this.stateMatchesCurrentContext(this.state)) {
return null;
}
return { codexPath: this.state.codexPath, cwd: this.state.cwd };
}
isConnected(): boolean {
@ -53,22 +67,22 @@ export class ConnectionManager {
async connect(handlers: ConnectionManagerHandlers): Promise<ServerInitialization> {
const currentClient = this.currentClient();
if (currentClient) {
return serverInitializationFromResponse(currentClient.initializeResponse);
return appServerInitializationFromResponse(currentClient.initializeResponse);
}
if (this.state.kind === "connecting") return this.state.promise;
if (this.state.kind === "connected") this.disconnect();
if (this.state.kind === "connecting" && this.stateMatchesCurrentContext(this.state)) return this.state.promise;
if (this.state.kind === "connecting" || this.state.kind === "connected") this.disconnect();
const generation = this.state.generation + 1;
const codexPath = this.codexPath;
const codexPath = this.codexPath();
const cwd = this.cwd;
const client = this.clientFactory(codexPath, cwd, {
onNotification: (notification) => {
if (this.isStale(generation)) return;
handlers.onNotification(notification);
},
onServerRequest: (request, responder) => {
onServerRequest: (request) => {
if (this.isStale(generation)) return;
handlers.onServerRequest(request, responder);
handlers.onServerRequest(request);
},
onLog: (message) => {
if (this.isStale(generation)) return;
@ -87,8 +101,8 @@ export class ConnectionManager {
client.disconnect();
throw new StaleConnectionError();
}
this.state = { kind: "connected", generation, client };
return serverInitializationFromResponse(response);
this.state = { kind: "connected", generation, codexPath, cwd, client };
return appServerInitializationFromResponse(response);
})
.catch((error: unknown) => {
if (this.isStale(generation)) {
@ -101,10 +115,14 @@ export class ConnectionManager {
throw error;
});
this.state = { kind: "connecting", generation, client, promise };
this.state = { kind: "connecting", generation, codexPath, cwd, client, promise };
return promise;
}
resetConnection(): void {
this.disconnect();
}
disconnect(): void {
const previous = this.state;
this.state = { kind: "disconnected", generation: previous.generation + 1 };
@ -116,13 +134,8 @@ export class ConnectionManager {
private isStale(generation: number): boolean {
return generation !== this.state.generation;
}
}
function serverInitializationFromResponse(response: ServerInitialization): ServerInitialization {
return {
userAgent: response.userAgent,
codexHome: response.codexHome,
platformFamily: response.platformFamily,
platformOs: response.platformOs,
};
private stateMatchesCurrentContext(state: Extract<ConnectionLifecycleState, { kind: "connecting" | "connected" }>): boolean {
return state.codexPath === this.codexPath() && state.cwd === this.cwd;
}
}

View file

@ -1,4 +0,0 @@
export interface AppServerExecutionContext {
readonly codexPath: string;
readonly vaultPath: string;
}

View file

@ -99,34 +99,16 @@ export class JsonRpcClient {
handleLine(line: string): void {
if (line.trim().length === 0) return;
let parsed: unknown;
let message: RpcInboundMessage;
try {
parsed = JSON.parse(line) as unknown;
message = JSON.parse(line) as RpcInboundMessage;
} catch {
this.options.onLog(`Invalid app-server JSON: ${line}`);
return;
}
const invalidParamsRequest = invalidKnownParamsRequest(parsed);
if (invalidParamsRequest) {
this.options.onLog(`Invalid app-server params: ${invalidParamsRequest.method}`);
this.reject(invalidParamsRequest.id, -32602, "Invalid params.");
return;
}
const message = rpcInboundMessage(parsed);
if (!message) {
this.options.onLog(`Invalid app-server JSON-RPC message: ${line}`);
return;
}
if ("id" in message && "method" in message) {
try {
this.options.onServerRequest(message);
} catch (error) {
this.options.onLog(`App-server request handler failed: ${errorMessage(error)}`);
this.reject(message.id, -32603, "Codex Panel failed to handle the app-server request.");
}
this.options.onServerRequest(message);
return;
}
@ -136,11 +118,7 @@ export class JsonRpcClient {
}
if ("method" in message) {
try {
this.options.onNotification(message);
} catch (error) {
this.options.onLog(`App-server notification handler failed: ${errorMessage(error)}`);
}
this.options.onNotification(message);
}
}
@ -184,62 +162,6 @@ export class JsonRpcClient {
}
}
function rpcInboundMessage(value: unknown): RpcInboundMessage | null {
if (!isRecord(value)) return null;
const hasId = Object.hasOwn(value, "id");
const hasMethod = Object.hasOwn(value, "method");
if (hasId && !isRequestId(value["id"])) return null;
if (hasMethod && (typeof value["method"] !== "string" || value["method"].length === 0 || !isRecord(value["params"]))) return null;
if (hasId && hasMethod) return value as unknown as ServerRequest;
if (hasId) {
const hasResult = Object.hasOwn(value, "result");
const hasError = Object.hasOwn(value, "error");
return hasResult !== hasError ? (value as unknown as RpcInboundMessage) : null;
}
return hasMethod ? (value as unknown as ServerNotification) : null;
}
function isRecord(value: unknown): value is Record<string, unknown> {
return value !== null && typeof value === "object" && !Array.isArray(value);
}
function isRequestId(value: unknown): value is RequestId {
return typeof value === "string" || (typeof value === "number" && Number.isFinite(value));
}
function invalidKnownParamsRequest(value: unknown): { id: RequestId; method: string } | null {
if (!isRecord(value) || !Object.hasOwn(value, "id") || typeof value["method"] !== "string") return null;
const method = value["method"];
const id = value["id"];
const params = value["params"];
const required = requiredStringFields(method);
if (!required) return null;
if (!isRecord(params)) return isRequestId(id) ? { id, method } : null;
return required.every((field) => typeof params[field] === "string") ? null : isRequestId(id) ? { id, method } : null;
}
function requiredStringFields(method: string): readonly string[] | null {
switch (method) {
case "item/commandExecution/requestApproval":
case "item/fileChange/requestApproval":
return ["threadId", "turnId", "itemId"];
case "item/tool/requestUserInput":
case "mcpServer/elicitation/request":
return ["threadId", "turnId", "itemId"];
case "currentTime/read":
return ["threadId"];
case "applyPatchApproval":
case "execCommandApproval":
return ["conversationId", "callId"];
default:
return null;
}
}
function errorMessage(error: unknown): string {
return error instanceof Error ? error.message : String(error);
}
function isRpcError(value: unknown): value is RpcError {
return value !== null && typeof value === "object" && typeof (value as { message?: unknown }).message === "string";
}

View file

@ -1,45 +1,31 @@
import { AppServerClient } from "./client";
import type { AppServerClientAccessOptions } from "./client-access";
import { codexPanelAppServerInitializeParams } from "./client-profile";
export interface ShortLivedAppServerClientLifetime {
created(client: AppServerClient): void;
disposed(client: AppServerClient): void;
}
export async function withShortLivedAppServerClient<T>(
codexPath: string,
cwd: string,
operation: (client: AppServerClient) => Promise<T>,
options: AppServerClientAccessOptions = {},
lifetime?: ShortLivedAppServerClientLifetime,
): Promise<T> {
const client = new AppServerClient({
codexPath,
cwd,
initializeParams: codexPanelAppServerInitializeParams(),
handlers: {
onNotification: () => undefined,
onServerRequest: (request, responder) => {
void request;
responder.reject(
-32601,
options.serverRequests?.kind === "reject"
? options.serverRequests.message
: "This Codex Panel view does not handle server requests.",
);
},
onLog: () => undefined,
onExit: () => undefined,
const client = new AppServerClient(codexPath, cwd, {
onNotification: () => undefined,
onServerRequest: (request, responder) => {
void request;
responder.reject(
-32601,
options.serverRequests?.kind === "reject"
? options.serverRequests.message
: "This Codex Panel view does not handle server requests.",
);
},
onLog: () => undefined,
onExit: () => undefined,
});
lifetime?.created(client);
try {
await client.connect();
return await operation(client);
} finally {
client.disconnect();
lifetime?.disposed(client);
}
}

View file

@ -7,7 +7,6 @@ interface AppServerSpawnSpec {
command: string;
args: string[];
killProcessTreeOnStop: boolean;
windowsVerbatimArguments?: boolean;
}
export interface AppServerTransport {
@ -24,7 +23,10 @@ export interface AppServerTransportHandlers {
onError: (error: Error) => void;
}
function createAppServerSpawnSpec(codexPath: string, options: { platform?: NodeJS.Platform; comSpec?: string } = {}): AppServerSpawnSpec {
export function createAppServerSpawnSpec(
codexPath: string,
options: { platform?: NodeJS.Platform; comSpec?: string } = {},
): AppServerSpawnSpec {
const platform = options.platform ?? process.platform;
if (platform !== "win32" || !isWindowsCommandScript(codexPath)) {
return { command: codexPath, args: ["app-server"], killProcessTreeOnStop: false };
@ -33,9 +35,8 @@ function createAppServerSpawnSpec(codexPath: string, options: { platform?: NodeJ
const comSpec = options.comSpec?.trim() || process.env["ComSpec"]?.trim() || process.env["COMSPEC"]?.trim() || "cmd.exe";
return {
command: comSpec,
args: ["/d", "/s", "/c", `"${quoteWindowsCmdArgument(codexPath)} app-server"`],
args: ["/d", "/c", `${quoteWindowsCmdArgument(codexPath)} app-server`],
killProcessTreeOnStop: true,
windowsVerbatimArguments: true,
};
}
@ -69,7 +70,6 @@ export class StdioAppServerTransport implements AppServerTransport {
this.process = spawn(launch.command, launch.args, {
cwd: this.cwd,
stdio: ["pipe", "pipe", "pipe"],
windowsVerbatimArguments: launch.windowsVerbatimArguments,
});
this.process.once("error", (error) => {

View file

@ -6,9 +6,10 @@ export interface CatalogModel {
displayName: string;
description: string;
hidden: boolean;
supportedReasoningEfforts: readonly { reasoningEffort: string; description: string }[];
supportedReasoningEfforts: readonly { reasoningEffort: string }[];
defaultReasoningEffort: string | null;
inputModalities: readonly string[];
additionalSpeedTiers: readonly string[];
serviceTiers: readonly { id: string; name: string }[];
defaultServiceTier: string | null;
isDefault: boolean;
@ -55,12 +56,9 @@ function modelMetadataFromCatalogModel(model: CatalogModel): ModelMetadata {
description: model.description,
hidden: model.hidden,
supportedReasoningEfforts: model.supportedReasoningEfforts.map((option) => option.reasoningEffort),
reasoningEffortOptions: model.supportedReasoningEfforts.map((option) => ({
reasoningEffort: option.reasoningEffort,
description: option.description,
})),
defaultReasoningEffort: model.defaultReasoningEffort,
inputModalities: [...model.inputModalities],
additionalSpeedTiers: [...model.additionalSpeedTiers],
serviceTiers: model.serviceTiers.map((tier) => ({ id: tier.id, name: tier.name })),
defaultServiceTier: model.defaultServiceTier,
isDefault: model.isDefault,

View file

@ -0,0 +1,17 @@
import type { ServerInitialization } from "../../domain/server/initialization";
interface AppServerInitializeResponse {
userAgent: string;
codexHome: string;
platformFamily: string;
platformOs: string;
}
export function appServerInitializationFromResponse(response: AppServerInitializeResponse): ServerInitialization {
return {
userAgent: response.userAgent,
codexHome: response.codexHome,
platformFamily: response.platformFamily,
platformOs: response.platformOs,
};
}

View file

@ -1,148 +0,0 @@
import type { VaultFileReference } from "../../domain/chat/input";
import type { ReferencedThreadMetadata } from "../../domain/threads/reference";
/*
* Compatibility boundary for user messages persisted by old Codex Panel
* versions. New request construction must not depend on this module. Once old
* thread history no longer needs recovery, delete this file and its explicit
* fallbacks in turn.ts.
*/
function legacyPanelReferencedThreadFromPrompt(text: string): { text: string; reference: ReferencedThreadMetadata } | null {
const envelope = referencedThreadEnvelopeFromPrompt(text);
return envelope ? { text: envelope.visibleText, reference: envelope.reference } : null;
}
interface LegacyPanelUserMessageContentItem {
type: string;
name?: string;
path?: string;
}
interface LegacyPanelUserMessageInput {
content: readonly LegacyPanelUserMessageContentItem[];
visibleText: string;
}
export interface LegacyPanelUserMessageProjection {
text: string;
referencedThread: ReferencedThreadMetadata | null;
fileReferences: VaultFileReference[];
mentionTextByContentIndex: ReadonlyMap<number, string>;
}
export function legacyPanelUserMessageProjection(input: LegacyPanelUserMessageInput): LegacyPanelUserMessageProjection {
const referencedThread = legacyPanelReferencedThreadFromPrompt(input.visibleText);
const fileReferences: VaultFileReference[] = [];
const mentionTextByContentIndex = new Map<number, string>();
for (const [index, item] of input.content.entries()) {
if (!isMention(item)) continue;
const reference = legacyPanelFileReference(item);
if (reference) fileReferences.push(reference);
if (!input.visibleText) {
mentionTextByContentIndex.set(index, reference ? `[file] ${reference.path}` : `[@${item.name}] ${item.path}`);
}
}
return {
text: referencedThread?.text ?? input.visibleText,
referencedThread: referencedThread?.reference ?? null,
fileReferences,
mentionTextByContentIndex,
};
}
function isMention(
input: LegacyPanelUserMessageInput["content"][number],
): input is LegacyPanelUserMessageContentItem & { type: "mention"; name: string; path: string } {
return input.type === "mention" && typeof input.name === "string" && typeof input.path === "string";
}
function legacyPanelFileReference(input: { name: string; path: string }): VaultFileReference | null {
if (!input.path || /^[A-Za-z][A-Za-z0-9+.-]*:\/\//.test(input.path)) return null;
return { name: input.name, path: input.path };
}
const REFERENCED_THREAD_ENVELOPE_START = "[Codex Panel referenced thread v1]";
const REFERENCED_THREAD_ENVELOPE_END = "[/Codex Panel referenced thread]";
interface ReferencedThreadEnvelope {
version: 1;
reference: ReferencedThreadMetadata;
visibleText: string;
}
interface ReferencedThreadEnvelopeMetadata {
version: 1;
threadId: string;
title: string;
includedTurns: number;
turnLimit: number;
}
function referencedThreadEnvelopeFromPrompt(text: string): ReferencedThreadEnvelope | null {
const headerStart = text.indexOf(REFERENCED_THREAD_ENVELOPE_START);
const requestBoundary = `\n${REFERENCED_THREAD_ENVELOPE_END}\n\nCurrent user request:\n`;
const boundaryStart = text.lastIndexOf(requestBoundary);
if (headerStart !== 0 || boundaryStart === -1) return null;
const metadataText = firstNonEmptyLine(text.slice(REFERENCED_THREAD_ENVELOPE_START.length, boundaryStart));
const metadata = referencedThreadEnvelopeMetadataFromJson(metadataText);
const visibleText = text.slice(boundaryStart + requestBoundary.length).trim();
if (!metadata || !visibleText) return null;
return {
version: 1,
visibleText,
reference: {
threadId: metadata.threadId,
title: metadata.title,
includedTurns: metadata.includedTurns,
turnLimit: metadata.turnLimit,
},
};
}
function firstNonEmptyLine(text: string): string | null {
return (
text
.split(/\r?\n/)
.map((line) => line.trim())
.find((line) => line.length > 0) ?? null
);
}
function referencedThreadEnvelopeMetadataFromJson(text: string | null): ReferencedThreadEnvelopeMetadata | null {
if (!text) return null;
let parsed: unknown;
try {
parsed = JSON.parse(text) as unknown;
} catch {
return null;
}
if (!parsed || typeof parsed !== "object") return null;
const value = parsed as Record<string, unknown>;
if (value["version"] !== 1) return null;
const threadId = stringValue(value["threadId"]);
const title = stringValue(value["title"]);
const includedTurns = finiteNonNegativeInteger(value["includedTurns"]);
const turnLimit = finitePositiveInteger(value["turnLimit"]);
if (!threadId || !title || includedTurns === null || turnLimit === null) return null;
return {
version: 1,
threadId,
title,
includedTurns,
turnLimit,
};
}
function stringValue(value: unknown): string | null {
return typeof value === "string" && value.length > 0 ? value : null;
}
function finiteNonNegativeInteger(value: unknown): number | null {
return typeof value === "number" && Number.isInteger(value) && value >= 0 ? value : null;
}
function finitePositiveInteger(value: unknown): number | null {
return typeof value === "number" && Number.isInteger(value) && value > 0 ? value : null;
}

View file

@ -1,222 +0,0 @@
import type { VaultFileReference } from "../../domain/chat/input";
import { isPanelSubmissionClientId, turnContextSubmissionId } from "../../domain/chat/submission-id";
import type { ReferencedThreadMetadata } from "../../domain/threads/reference";
/*
* Read-only compatibility for v2 metadata envelopes written by Codex Panel
* versions that predate durable, human-readable references in message text.
* Request construction must not import this module.
*/
const TURN_CONTEXT_MANIFEST_PREFIX = "[Codex Panel context v2]";
const TURN_CONTEXT_MANIFEST_MAX_BYTES = 2_800;
const TURN_CONTEXT_FILE_REFERENCE_MAX_COUNT = 64;
const TURN_CONTEXT_FILE_REFERENCE_NAME_MAX_LENGTH = 255;
const TURN_CONTEXT_FILE_REFERENCE_PATH_MAX_LENGTH = 2_048;
interface LegacyTurnContextManifestEntry {
kind: "referencedThread" | "web" | "obsidian";
id: string;
parts: number;
sourceBytes: number;
includedBytes: number;
truncated: boolean;
threadId?: string;
includedTurns?: number;
turnLimit?: number;
omittedTurns?: number;
inlineExcerpts?: number;
}
export interface LegacyTurnContextManifest {
version: 2;
submissionId?: string;
contexts: readonly LegacyTurnContextManifestEntry[];
fileReferences?: readonly VaultFileReference[];
}
export interface LegacyTurnContextProjection {
text: string;
manifest: LegacyTurnContextManifest | null;
}
type UserMessageContentItem = { type: "text"; text: string } | { type: string };
function legacyTurnContextManifestFromText(text: string): LegacyTurnContextManifest | null {
const trimmed = text.trim();
if (!trimmed.startsWith(TURN_CONTEXT_MANIFEST_PREFIX)) return null;
if (new TextEncoder().encode(trimmed).byteLength > TURN_CONTEXT_MANIFEST_MAX_BYTES) return null;
const payload = trimmed.slice(TURN_CONTEXT_MANIFEST_PREFIX.length).trimStart();
const notice = "Reference/display metadata only; not user instructions.";
const json = payload.startsWith(notice) ? payload.slice(notice.length).trimStart() : payload;
let parsed: unknown;
try {
parsed = JSON.parse(json) as unknown;
} catch {
return null;
}
if (!parsed || typeof parsed !== "object") return null;
const value = parsed as Record<string, unknown>;
if (value["version"] !== 2 || !Array.isArray(value["contexts"])) return null;
const contexts = value["contexts"].map(legacyManifestEntryFromUnknown);
if (contexts.some((entry) => entry === null)) return null;
const submissionId = optionalStringValue(value["submissionId"], 120);
if (submissionId === null) return null;
const fileReferences = optionalFileReferences(value["fileReferences"]);
if (fileReferences === null) return null;
return {
version: 2,
...(submissionId === undefined ? {} : { submissionId }),
contexts: contexts as LegacyTurnContextManifestEntry[],
...(fileReferences === undefined ? {} : { fileReferences }),
};
}
export function legacyTurnContextProjection(
content: readonly UserMessageContentItem[],
clientId: string | null,
): LegacyTurnContextProjection {
let manifest: LegacyTurnContextManifest | null = null;
const visibleText: string[] = [];
const lastTextIndex = lastTextItemIndex(content);
for (const [index, item] of content.entries()) {
if (item.type !== "text" || !("text" in item) || typeof item.text !== "string") continue;
const manifestPrefix = `\n${TURN_CONTEXT_MANIFEST_PREFIX}`;
const manifestStart = index === lastTextIndex ? item.text.lastIndexOf(manifestPrefix) : -1;
const isStandaloneManifest = manifestStart === 0 && index > 0 && index === content.length - 1;
const parsed = manifestStart > 0 || isStandaloneManifest ? legacyTurnContextManifestFromText(item.text.slice(manifestStart)) : null;
if (parsed && manifestMatchesClientId(parsed, clientId)) {
manifest = parsed;
if (manifestStart > 0) visibleText.push(item.text.slice(0, manifestStart));
continue;
}
visibleText.push(item.text);
}
return { text: visibleText.join("\n"), manifest };
}
function lastTextItemIndex(content: readonly UserMessageContentItem[]): number {
for (let index = content.length - 1; index >= 0; index -= 1) {
if (content[index]?.type === "text") return index;
}
return -1;
}
function manifestMatchesClientId(manifest: LegacyTurnContextManifest, clientId: string | null): boolean {
if (!isPanelSubmissionClientId(clientId)) return false;
const submissionId = turnContextSubmissionId(clientId);
if (manifest.submissionId !== undefined && manifest.submissionId !== submissionId) return false;
const contextIds = manifest.contexts.map((context) => context.id);
return (
(manifest.submissionId === submissionId || contextIds.length > 0) &&
new Set(contextIds).size === contextIds.length &&
contextIds.every((contextId) => new RegExp(`^${escapeRegExp(submissionId)}\\.\\d{2}$`).test(contextId))
);
}
function escapeRegExp(value: string): string {
return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
}
export function referencedThreadFromLegacyManifest(manifest: LegacyTurnContextManifest | null): ReferencedThreadMetadata | null {
const context = manifest?.contexts.find((entry) => entry.kind === "referencedThread");
if (!context?.threadId || context.includedTurns === undefined || context.turnLimit === undefined || context.omittedTurns === undefined) {
return null;
}
return {
threadId: context.threadId,
title: context.threadId.slice(0, 8),
includedTurns: context.includedTurns,
turnLimit: context.turnLimit,
omittedTurns: context.omittedTurns,
truncated: context.truncated,
};
}
export function fileReferencesFromLegacyManifest(manifest: LegacyTurnContextManifest | null): VaultFileReference[] {
return manifest?.fileReferences ? [...manifest.fileReferences] : [];
}
function legacyManifestEntryFromUnknown(input: unknown): LegacyTurnContextManifestEntry | null {
if (!input || typeof input !== "object") return null;
const value = input as Record<string, unknown>;
const kind = contextKind(value["kind"]);
const id = stringValue(value["id"]);
const parts = nonNegativeInteger(value["parts"]);
const sourceBytes = nonNegativeInteger(value["sourceBytes"]);
const includedBytes = nonNegativeInteger(value["includedBytes"]);
const truncated = value["truncated"];
if (!kind || !id || parts === null || sourceBytes === null || includedBytes === null || typeof truncated !== "boolean") return null;
if (kind === "obsidian") {
const inlineExcerpts = optionalNonNegativeInteger(value["inlineExcerpts"]);
if (inlineExcerpts === null) return null;
return {
kind,
id,
parts,
sourceBytes,
includedBytes,
truncated,
...(inlineExcerpts === undefined ? {} : { inlineExcerpts }),
};
}
if (kind !== "referencedThread") return { kind, id, parts, sourceBytes, includedBytes, truncated };
const threadId = stringValue(value["threadId"]);
const includedTurns = nonNegativeInteger(value["includedTurns"]);
const turnLimit = positiveInteger(value["turnLimit"]);
const omittedTurns = nonNegativeInteger(value["omittedTurns"]);
if (!threadId || includedTurns === null || turnLimit === null || omittedTurns === null) return null;
return {
kind,
id,
parts,
sourceBytes,
includedBytes,
truncated,
threadId,
includedTurns,
turnLimit,
omittedTurns,
};
}
function contextKind(value: unknown): LegacyTurnContextManifestEntry["kind"] | null {
return value === "referencedThread" || value === "web" || value === "obsidian" ? value : null;
}
function stringValue(value: unknown): string | null {
return typeof value === "string" && value.length > 0 && value.length <= 160 ? value : null;
}
function optionalStringValue(value: unknown, maxLength: number): string | null | undefined {
if (value === undefined) return undefined;
return typeof value === "string" && value.length > 0 && value.length <= maxLength ? value : null;
}
function optionalFileReferences(value: unknown): VaultFileReference[] | null | undefined {
if (value === undefined) return undefined;
if (!Array.isArray(value) || value.length > TURN_CONTEXT_FILE_REFERENCE_MAX_COUNT) return null;
const references = value.map(manifestFileReference);
return references.some((reference) => reference === null) ? null : (references as VaultFileReference[]);
}
function manifestFileReference(input: unknown): VaultFileReference | null {
if (!input || typeof input !== "object") return null;
const reference = input as Record<string, unknown>;
const name = optionalStringValue(reference["name"], TURN_CONTEXT_FILE_REFERENCE_NAME_MAX_LENGTH);
const path = optionalStringValue(reference["path"], TURN_CONTEXT_FILE_REFERENCE_PATH_MAX_LENGTH);
return name && path ? { name, path } : null;
}
function nonNegativeInteger(value: unknown): number | null {
return typeof value === "number" && Number.isSafeInteger(value) && value >= 0 ? value : null;
}
function optionalNonNegativeInteger(value: unknown): number | null | undefined {
return value === undefined ? undefined : nonNegativeInteger(value);
}
function positiveInteger(value: unknown): number | null {
return typeof value === "number" && Number.isSafeInteger(value) && value > 0 ? value : null;
}

View file

@ -1,6 +1,4 @@
import { splitUtf8Context } from "../../domain/chat/context-budget";
import type { CodexInputItem } from "../../domain/chat/input";
import { turnContextSubmissionId } from "../../domain/chat/submission-id";
type AppServerUserInputImageDetail = "auto" | "low" | "high" | "original";
@ -8,75 +6,28 @@ type AppServerUserInput =
| { type: "text"; text: string; text_elements: [] }
| { type: "image"; detail?: AppServerUserInputImageDetail; url: string }
| { type: "localImage"; detail?: AppServerUserInputImageDetail; path: string }
| { type: "skill"; name: string; path: string };
| { type: "skill"; name: string; path: string }
| { type: "mention"; name: string; path: string };
interface AppServerAdditionalContextEntry {
value: string;
kind: "untrusted" | "application";
}
export interface AppServerTurnInput {
input: AppServerUserInput[];
additionalContext?: Record<string, AppServerAdditionalContextEntry>;
}
const ADDITIONAL_CONTEXT_PART_BODY_MAX_BYTES = 2_800;
const ADDITIONAL_CONTEXT_MAX_PARTS = 8;
export function toAppServerUserInput(input: readonly CodexInputItem[]): AppServerUserInput[] {
return input.flatMap((item) => appServerUserInputItemFromCodexInputItem(item));
}
export function appServerTurnInputFromCodexInput(input: readonly CodexInputItem[], submissionId: string): AppServerTurnInput {
export function additionalContextFromCodexInput(
input: readonly CodexInputItem[],
): Record<string, AppServerAdditionalContextEntry> | undefined {
const additionalContext: Record<string, AppServerAdditionalContextEntry> = {};
const contexts = input.filter(
(item): item is Extract<CodexInputItem, { type: "additionalContext" }> =>
item.type === "additionalContext" && Boolean(item.key) && Boolean(item.value),
);
if (contexts.length > ADDITIONAL_CONTEXT_MAX_PARTS) {
throw new Error(`Too many additional context sources (${String(contexts.length)}).`);
for (const item of input) {
if (item.type !== "additionalContext") continue;
if (!item.key || !item.value) continue;
additionalContext[item.key] = { value: item.value, kind: item.kind };
}
const partAllocations = allocatedPartCounts(contexts);
for (const [contextIndex, item] of contexts.entries()) {
const id = `${turnContextSubmissionId(submissionId)}.${String(contextIndex).padStart(2, "0")}`;
const split = splitUtf8Context(item.value, ADDITIONAL_CONTEXT_PART_BODY_MAX_BYTES, partAllocations[contextIndex] ?? 1);
const partCount = split.parts.length;
split.parts.forEach((part, partIndex) => {
const key = [
"codex_panel",
id,
safeKeyPart(item.key),
`part_${String(partIndex + 1).padStart(2, "0")}_of_${String(partCount).padStart(2, "0")}`,
].join(".");
additionalContext[key] = {
kind: item.kind,
value: [
`Codex Panel context part ${String(partIndex + 1)}/${String(partCount)}.`,
`Source: ${safeKeyPart(item.key)}`,
"",
part,
].join("\n"),
};
});
}
return {
input: toAppServerUserInput(input),
...(Object.keys(additionalContext).length > 0 ? { additionalContext } : {}),
};
}
function allocatedPartCounts(contexts: readonly Extract<CodexInputItem, { type: "additionalContext" }>[]): number[] {
const allocations = contexts.map(() => 1);
const desired = contexts.map(
(context) => splitUtf8Context(context.value, ADDITIONAL_CONTEXT_PART_BODY_MAX_BYTES, ADDITIONAL_CONTEXT_MAX_PARTS).parts.length,
);
let remaining = ADDITIONAL_CONTEXT_MAX_PARTS - contexts.length;
for (let index = 0; index < contexts.length && remaining > 0; index += 1) {
const extra = Math.min(Math.max((desired[index] ?? 1) - 1, 0), remaining);
allocations[index] = (allocations[index] ?? 1) + extra;
remaining -= extra;
}
return allocations;
return Object.keys(additionalContext).length > 0 ? additionalContext : undefined;
}
function appServerUserInputItemFromCodexInputItem(item: CodexInputItem): AppServerUserInput[] {
@ -89,18 +40,13 @@ function appServerUserInputItemFromCodexInputItem(item: CodexInputItem): AppServ
return [{ type: "localImage", path: item.path, ...appServerImageDetailProp(item.detail) }];
case "skill":
return [{ type: "skill", name: item.name, path: item.path }];
case "fileReference":
return [];
case "mention":
return [{ type: "mention", name: item.name, path: item.path }];
case "additionalContext":
return [];
}
}
function safeKeyPart(value: string): string {
const safe = value.replace(/[^A-Za-z0-9_.-]/g, "_").slice(0, 120);
return safe || "context";
}
function appServerImageDetailProp(detail: Extract<CodexInputItem, { type: "image" | "localImage" }>["detail"]): {
detail?: AppServerUserInputImageDetail;
} {

View file

@ -36,15 +36,15 @@ export function runtimeConfigSnapshotFromAppServerConfig(response: ConfigReadRes
}
function startupPermissionsFromConfig(config: Record<string, unknown>): RuntimePermissionState {
const activePermissionProfile = permissionProfileFromConfig(config);
return {
approvalPolicy: approvalPolicyOrNull(config["approval_policy"]),
sandboxPolicy: activePermissionProfile ? null : sandboxPolicyFromConfig(config),
activePermissionProfile,
sandboxPolicy: sandboxPolicyFromConfig(config),
activePermissionProfile: permissionProfileFromConfig(config),
};
}
function permissionProfileFromConfig(config: Record<string, unknown>): RuntimePermissionState["activePermissionProfile"] {
if (typeof config["sandbox_mode"] === "string") return null;
const profile = nonEmptyStringOrNull(config["default_permissions"]);
return profile ? { id: profile, extends: null } : null;
}
@ -66,7 +66,7 @@ function sandboxPolicyFromConfig(config: Record<string, unknown>): RuntimeSandbo
}
function approvalPolicyOrNull(value: unknown): RuntimeApprovalPolicy | null {
if (value === "untrusted" || value === "on-request" || value === "never") return value;
if (value === "untrusted" || value === "on-failure" || value === "on-request" || value === "never") return value;
if (!value || typeof value !== "object") return null;
const granular = (value as Record<string, unknown>)["granular"];
if (!granular || typeof granular !== "object") return null;

View file

@ -53,12 +53,16 @@ type AppServerMcpElicitationPrimitiveSchema =
title?: unknown;
description?: unknown;
default?: unknown;
minimum?: unknown;
maximum?: unknown;
}
| {
type: "array";
title?: unknown;
description?: unknown;
default?: unknown;
minItems?: unknown;
maxItems?: unknown;
items?: unknown;
}
| {
@ -66,8 +70,12 @@ type AppServerMcpElicitationPrimitiveSchema =
title?: unknown;
description?: unknown;
default?: unknown;
format?: unknown;
minLength?: unknown;
maxLength?: unknown;
oneOf?: unknown;
enum?: unknown;
enumNames?: unknown;
};
interface NormalizedMcpElicitationParams {
@ -159,8 +167,6 @@ export function appServerMcpElicitationRequest(request: AppServerRequest): Pendi
},
};
}
const fields = mcpElicitationFieldsFromRequestedSchema(params.requestedSchema);
if (!fields) return null;
return {
requestId: request.id,
params: {
@ -170,7 +176,7 @@ export function appServerMcpElicitationRequest(request: AppServerRequest): Pendi
mode: "form",
message: params.message,
meta: params.meta,
fields,
fields: mcpElicitationFieldsFromRequestedSchema(params.requestedSchema),
},
};
}
@ -536,10 +542,6 @@ function nullableString(value: unknown): string | null {
return typeof value === "string" ? value : null;
}
function numberOrNull(value: unknown): number | null {
return typeof value === "number" && Number.isFinite(value) ? value : null;
}
function asRecordOrNull(value: unknown): Record<string, unknown> | null {
return value && typeof value === "object" ? (value as Record<string, unknown>) : null;
}
@ -606,19 +608,21 @@ function normalizeMcpElicitationParams(params: McpElicitationParams): Normalized
}
}
function mcpElicitationFieldsFromRequestedSchema(schema: unknown): PendingMcpElicitationField[] | null {
function numberOrNull(value: unknown): number | null {
return typeof value === "number" && Number.isFinite(value) ? value : null;
}
function mcpElicitationFieldsFromRequestedSchema(schema: unknown): PendingMcpElicitationField[] {
const record = asRecordOrNull(schema);
const properties = asRecordOrNull(record?.["properties"]);
if (record?.["type"] !== "object" || !properties) return null;
if (!properties) return [];
const required = new Set(
Array.isArray(record["required"]) ? record["required"].filter((item): item is string => typeof item === "string") : [],
Array.isArray(record?.["required"]) ? record["required"].filter((item): item is string => typeof item === "string") : [],
);
const fields: PendingMcpElicitationField[] = [];
for (const [id, fieldSchema] of Object.entries(properties)) {
if (!isMcpElicitationPrimitiveSchema(fieldSchema)) return null;
fields.push(mcpElicitationFieldFromSchema(id, fieldSchema, required.has(id)));
}
return fields;
return Object.entries(properties).flatMap(([id, fieldSchema]) => {
if (!isMcpElicitationPrimitiveSchema(fieldSchema)) return [];
return [mcpElicitationFieldFromSchema(id, fieldSchema, required.has(id))];
});
}
function isMcpElicitationPrimitiveSchema(schema: unknown): schema is AppServerMcpElicitationPrimitiveSchema {
@ -647,13 +651,17 @@ function mcpElicitationFieldFromSchema(
return {
...base,
type: schema.type,
defaultValue: typeof schema.default === "number" && Number.isFinite(schema.default) ? schema.default : null,
minimum: numberOrNull(schema.minimum),
maximum: numberOrNull(schema.maximum),
defaultValue: numberOrNull(schema.default),
};
case "array":
return {
...base,
type: "multi-select",
options: multiSelectOptions(schema),
minItems: bigintToNumberOrNull(schema.minItems),
maxItems: bigintToNumberOrNull(schema.maxItems),
defaultValue: stringArrayOrEmpty(schema.default),
};
case "string": {
@ -669,6 +677,9 @@ function mcpElicitationFieldFromSchema(
return {
...base,
type: "string",
format: nullableString(schema.format),
minLength: numberOrNull(schema.minLength),
maxLength: numberOrNull(schema.maxLength),
defaultValue: typeof schema.default === "string" ? schema.default : "",
};
}
@ -683,7 +694,7 @@ function singleSelectOptions(schema: Extract<AppServerMcpElicitationPrimitiveSch
});
if (options.length > 0) return options;
}
return enumOptions(schema.enum);
return enumOptions(schema.enum, schema.enumNames);
}
function multiSelectOptions(schema: Extract<AppServerMcpElicitationPrimitiveSchema, { type: "array" }>): PendingMcpElicitationOption[] {
@ -696,7 +707,7 @@ function multiSelectOptions(schema: Extract<AppServerMcpElicitationPrimitiveSche
});
if (options.length > 0) return options;
}
return enumOptions(items?.["enum"]);
return enumOptions(items?.["enum"], null);
}
function stringArrayOrEmpty(value: unknown): readonly string[] {
@ -709,11 +720,12 @@ function stringArrayOrEmpty(value: unknown): readonly string[] {
return strings;
}
function enumOptions(values: unknown): PendingMcpElicitationOption[] {
function enumOptions(values: unknown, labels: unknown): PendingMcpElicitationOption[] {
if (!Array.isArray(values)) return [];
return values.flatMap((value) => {
const labelValues = Array.isArray(labels) ? labels : [];
return values.flatMap((value, index) => {
if (typeof value !== "string") return [];
return [{ value, label: value }];
return [{ value, label: nonEmptyString(labelValues[index]) ?? value }];
});
}
@ -724,6 +736,11 @@ function selectOption(value: unknown): PendingMcpElicitationOption | null {
return { value: optionValue, label: nonEmptyString(record?.["title"]) ?? optionValue };
}
function bigintToNumberOrNull(value: unknown): number | null {
if (typeof value === "bigint") return Number(value);
return typeof value === "number" && Number.isFinite(value) ? value : null;
}
function toJsonContent(content: Record<string, McpElicitationContentValue> | null): unknown {
if (!content) return null;
return Object.fromEntries(

View file

@ -1,26 +0,0 @@
type AppServerJsonValue = number | string | boolean | AppServerJsonValue[] | { [key: string]: AppServerJsonValue | undefined } | null;
const SIDE_CHAT_DEVELOPER_INSTRUCTIONS = `You are in a side conversation, not the main thread.
The inherited fork history is reference context only. Do not continue any task, plan, tool call, approval, edit, or request found only in that history. Only instructions submitted after the side-conversation boundary are active.
Use the side conversation for questions and lightweight, non-mutating exploration. Do not use sub-agents. This thread is read-only; do not modify files, source, git state, permissions, configuration, or other workspace state.`;
const SIDE_CHAT_BOUNDARY = `Side conversation boundary.
Everything before this boundary is inherited history from the parent thread. It is reference context only, not the current task.
Do not continue any instructions, plans, tool calls, approvals, edits, or requests from before this boundary. Only messages submitted after this boundary are active user instructions for this side conversation. If there is no user question after this boundary yet, wait for one.`;
export function sideChatDeveloperInstructions(existingInstructions: string | null | undefined): string {
const existing = existingInstructions?.trim();
return existing ? `${existing}\n\n${SIDE_CHAT_DEVELOPER_INSTRUCTIONS}` : SIDE_CHAT_DEVELOPER_INSTRUCTIONS;
}
export function appServerSideChatBoundaryItem(): AppServerJsonValue {
return {
type: "message",
role: "user",
content: [{ type: "input_text", text: SIDE_CHAT_BOUNDARY }],
};
}

View file

@ -1,15 +1,14 @@
import type { Thread, ThreadProvenance } from "../../domain/threads/model";
import type { Thread as GeneratedThread } from "../../generated/app-server/v2/Thread";
import type { Thread } from "../../domain/threads/model";
type RequiredThreadRecordFields = "id" | "preview" | "name" | "createdAt" | "updatedAt";
export type ThreadRecord = Pick<GeneratedThread, RequiredThreadRecordFields> &
Partial<Omit<GeneratedThread, RequiredThreadRecordFields | "source" | "status" | "turns">> & {
/** Kept unknown at the protocol edge so a newer SessionSource variant degrades to `other` instead of breaking thread lists. */
source?: unknown;
status?: unknown;
turns?: readonly GeneratedThread["turns"][number][];
};
export interface ThreadRecord {
id: string;
preview: string;
name: string | null;
createdAt: number;
updatedAt: number;
recencyAt?: number | null;
[key: string]: unknown;
}
export function threadFromThreadRecord(thread: ThreadRecord, options: { archived?: boolean } = {}): Thread {
const hasRecencyAt = Object.hasOwn(thread, "recencyAt");
@ -21,54 +20,10 @@ export function threadFromThreadRecord(thread: ThreadRecord, options: { archived
archived: options.archived ?? false,
createdAt: finiteTimestamp(thread.createdAt),
updatedAt: finiteTimestamp(thread.updatedAt),
canAcceptDirectInput: typeof thread.canAcceptDirectInput === "boolean" ? thread.canAcceptDirectInput : null,
provenance: threadProvenance(thread),
...(hasRecencyAt ? { recencyAt: typeof recencyAt === "number" && Number.isFinite(recencyAt) ? recencyAt : null } : {}),
};
}
function threadProvenance(thread: ThreadRecord): ThreadProvenance {
const source = recordOrNull(thread["source"]);
const subagent = source?.["subAgent"];
const threadSource = stringOrNull(thread["threadSource"]);
if (subagent === undefined && stringOrNull(thread["parentThreadId"]) === null && !threadSource?.startsWith("subAgent")) {
return { kind: "interactive" };
}
const spawn = recordOrNull(recordOrNull(subagent)?.["thread_spawn"]);
return {
kind: "subagent",
subagentKind: subagentKind(subagent, threadSource),
parentThreadId: stringOrNull(thread["parentThreadId"]) ?? stringOrNull(spawn?.["parent_thread_id"]),
sessionId: stringOrNull(thread["sessionId"]),
depth: finiteNumberOrNull(spawn?.["depth"]),
agentNickname: stringOrNull(thread["agentNickname"]) ?? stringOrNull(spawn?.["agent_nickname"]),
agentRole: stringOrNull(thread["agentRole"]) ?? stringOrNull(spawn?.["agent_role"]),
};
}
function subagentKind(value: unknown, threadSource: string | null): Extract<ThreadProvenance, { kind: "subagent" }>["subagentKind"] {
if (value === "review" || value === "compact" || value === "memory_consolidation") {
return value === "memory_consolidation" ? "memory-consolidation" : value;
}
if (recordOrNull(value)?.["thread_spawn"] || threadSource === "subAgentThreadSpawn") return "thread-spawn";
if (threadSource === "subAgentReview") return "review";
if (threadSource === "subAgentCompact") return "compact";
return "other";
}
function recordOrNull(value: unknown): Record<string, unknown> | null {
return typeof value === "object" && value !== null && !Array.isArray(value) ? (value as Record<string, unknown>) : null;
}
function stringOrNull(value: unknown): string | null {
return typeof value === "string" && value.length > 0 ? value : null;
}
function finiteNumberOrNull(value: unknown): number | null {
return typeof value === "number" && Number.isFinite(value) ? value : null;
}
export function threadsFromThreadRecords(threads: readonly ThreadRecord[], options: { archived?: boolean } = {}): Thread[] {
return threads.map((thread) => threadFromThreadRecord(thread, options));
}

View file

@ -28,7 +28,6 @@ interface ToolInventoryPluginSummary {
type ToolInventoryPluginSource =
| { type: "local"; path: string }
| { type: "git"; url: string; path: string | null; refName: string | null; sha: string | null }
| { type: "npm"; package: string; version: string | null; registry: string | null }
| { type: "remote" };
interface ToolInventoryMarketplaceLoadError {
@ -81,6 +80,5 @@ function pluginSourceLabel(source: ToolInventoryPluginSource): string {
const path = source.path ? `/${source.path}` : "";
return `${source.url}${path}${ref}`;
}
if (source.type === "npm") return source.version ? `${source.package}@${source.version}` : source.package;
return "remote";
}

View file

@ -1,23 +1,18 @@
import type { VaultFileReference } from "../../domain/chat/input";
import type { ReferencedThreadMetadata } from "../../domain/threads/reference";
import {
nonEmptyTurnTranscriptSummaries,
conversationSummaryFromTranscriptEntries,
nonEmptyConversationSummaries,
type ThreadConversationSummary,
type ThreadTranscriptEntry,
type TurnTranscriptSummary,
turnTranscriptSummaryFromTranscriptEntries,
} from "../../domain/threads/transcript";
import type { ThreadItem as GeneratedThreadItem } from "../../generated/app-server/v2/ThreadItem";
import type { Turn as GeneratedTurn } from "../../generated/app-server/v2/Turn";
import { legacyPanelUserMessageProjection } from "./legacy-panel-user-message";
import {
fileReferencesFromLegacyManifest,
legacyTurnContextProjection,
referencedThreadFromLegacyManifest,
} from "./legacy-turn-context-manifest";
export type TurnItem = GeneratedThreadItem;
export type TurnRecord = GeneratedTurn;
type AppServerUserInput = Extract<TurnItem, { type: "userMessage" }>["content"][number];
type AppServerTextUserInput = Extract<AppServerUserInput, { type: "text" }>;
function transcriptEntriesFromTurnRecord(turn: TurnRecord): ThreadTranscriptEntry[] {
return turn.items.flatMap((item) => transcriptEntriesFromTurnItem(item, turn));
}
@ -26,69 +21,35 @@ export function transcriptEntriesFromTurnRecords(turns: readonly TurnRecord[]):
return turns.flatMap(transcriptEntriesFromTurnRecord);
}
function turnTranscriptSummaryFromTurnRecord(turn: TurnRecord): TurnTranscriptSummary {
return turnTranscriptSummaryFromTranscriptEntries(transcriptEntriesFromTurnRecord(turn));
function conversationSummaryFromTurnRecord(turn: TurnRecord): ThreadConversationSummary {
return conversationSummaryFromTranscriptEntries(transcriptEntriesFromTurnRecord(turn));
}
export function turnTranscriptAssistantTextFromTurnRecord(turn: TurnRecord): string | null {
return turnTranscriptSummaryFromTurnRecord(turn).assistantText;
export function conversationAssistantTextFromTurnRecord(turn: TurnRecord): string | null {
return conversationSummaryFromTurnRecord(turn).assistantText;
}
export function completedTurnTranscriptSummaryFromTurnRecord(turn: TurnRecord): TurnTranscriptSummary | null {
export function completedConversationSummaryFromTurnRecord(turn: TurnRecord): ThreadConversationSummary | null {
if (turn.status !== "completed") return null;
const summary = turnTranscriptSummaryFromTurnRecord(turn);
const summary = conversationSummaryFromTurnRecord(turn);
return summary.userText && summary.assistantText ? summary : null;
}
export function completedTurnTranscriptSummariesFromTurnRecords(turns: readonly TurnRecord[]): TurnTranscriptSummary[] {
export function completedConversationSummariesFromTurnRecords(turns: readonly TurnRecord[]): ThreadConversationSummary[] {
return turns.flatMap((turn) => {
const summary = completedTurnTranscriptSummaryFromTurnRecord(turn);
const summary = completedConversationSummaryFromTurnRecord(turn);
return summary ? [summary] : [];
});
}
export function chronologicalTurnTranscriptSummariesFromTurnRecords(turns: readonly TurnRecord[]): TurnTranscriptSummary[] {
return nonEmptyTurnTranscriptSummaries(
[...turns].sort((a, b) => (a.startedAt ?? 0) - (b.startedAt ?? 0)).map(turnTranscriptSummaryFromTurnRecord),
export function chronologicalConversationSummariesFromTurnRecords(turns: readonly TurnRecord[]): ThreadConversationSummary[] {
return nonEmptyConversationSummaries(
[...turns].sort((a, b) => (a.startedAt ?? 0) - (b.startedAt ?? 0)).map(conversationSummaryFromTurnRecord),
);
}
export interface TurnUserItemProjection {
text: string;
referencedThread: ReferencedThreadMetadata | null;
fileReferences: VaultFileReference[];
contexts: TurnUserContextMetadata[];
}
interface TurnUserContextMetadata {
kind: "web" | "obsidian";
truncated: boolean;
inlineExcerpts?: number;
}
export function turnUserItemProjection(item: Extract<TurnItem, { type: "userMessage" }>): TurnUserItemProjection {
const projected = legacyTurnContextProjection(item.content, item.clientId);
if (!projected.manifest) {
const legacy = legacyPanelUserMessageProjection({
content: item.content,
visibleText: projected.text,
});
const supplementalText = nonTextUserInputText(item.content, projected.text, legacy.mentionTextByContentIndex);
return {
text: [legacy.text, supplementalText].filter(Boolean).join("\n"),
referencedThread: legacy.referencedThread,
fileReferences: legacy.fileReferences,
contexts: [],
};
}
const supplementalText = nonTextUserInputText(item.content, projected.text);
const text = [projected.text, supplementalText].filter(Boolean).join("\n");
return {
text,
referencedThread: referencedThreadFromLegacyManifest(projected.manifest),
fileReferences: fileReferencesFromLegacyManifest(projected.manifest),
contexts: legacyContextMetadata(projected.manifest.contexts),
};
export function turnUserItemText(item: Extract<TurnItem, { type: "userMessage" }>): string {
return userInputText(item.content);
}
export function lastAgentMessageTextFromTurnRecord(turn: TurnRecord): string | null {
@ -104,20 +65,8 @@ export function lastAgentMessageTextFromTurnRecord(turn: TurnRecord): string | n
function transcriptEntriesFromTurnItem(item: TurnItem, turn: TurnRecord): ThreadTranscriptEntry[] {
if (item.type === "userMessage") {
const projection = turnUserItemProjection(item);
const text = projection.text.trim();
const contexts = projection.contexts.map((context) => ({ kind: context.kind, truncated: context.truncated }));
return text
? [
{
kind: "user",
text,
timestamp: turn.startedAt,
...(projection.referencedThread ? { referencedThread: projection.referencedThread } : {}),
...(contexts.length > 0 ? { contexts } : {}),
},
]
: [];
const text = turnUserItemText(item).trim();
return text ? [{ kind: "user", text, timestamp: turn.startedAt }] : [];
}
if (item.type === "agentMessage") {
const text = item.text.trim();
@ -130,36 +79,22 @@ function transcriptEntriesFromTurnItem(item: TurnItem, turn: TurnRecord): Thread
return [];
}
function legacyContextMetadata(
contexts: readonly { kind: "referencedThread" | "web" | "obsidian"; truncated: boolean; inlineExcerpts?: number }[],
): TurnUserContextMetadata[] {
return contexts.flatMap((context) => {
if (context.kind === "referencedThread") return [];
return [
{
kind: context.kind,
truncated: context.truncated,
...(context.inlineExcerpts === undefined ? {} : { inlineExcerpts: context.inlineExcerpts }),
},
];
});
}
function nonTextUserInputText(
content: Extract<TurnItem, { type: "userMessage" }>["content"],
visibleText: string,
mentionTextByContentIndex?: ReadonlyMap<number, string>,
): string {
const hasText = visibleText.length > 0;
const textIncludes = (value: string) => value.length > 0 && visibleText.includes(value);
function userInputText(content: readonly AppServerUserInput[]): string {
const textItems = content.filter(isTextUserInput);
const hasText = textItems.some((item) => item.text.length > 0);
const textIncludes = (value: string) => value.length > 0 && textItems.some((item) => item.text.includes(value));
return content
.map((item, index) => {
.map((item) => {
if (item.type === "text") return item.text;
if (item.type === "localImage") return hasText && textIncludes(item.path) ? "" : `[local image] ${item.path}`;
if (item.type === "image") return hasText && textIncludes(item.url) ? "" : `[image] ${item.url}`;
if (item.type === "mention") return mentionTextByContentIndex?.get(index) ?? "";
if (item.type === "skill") return hasText ? "" : `[$${item.name}] ${item.path}`;
return "";
if (item.type === "mention") return hasText ? "" : `[@${item.name}] ${item.path}`;
return hasText ? "" : `[$${item.name}] ${item.path}`;
})
.filter(Boolean)
.join("\n");
}
function isTextUserInput(item: AppServerUserInput): item is AppServerTextUserInput {
return item.type === "text";
}

View file

@ -1,65 +0,0 @@
import type { InfiniteData } from "@tanstack/query-core";
import { type Thread, threadRecencyAt } from "../../domain/threads/model";
import type { ThreadPage } from "../services/threads";
import type { ThreadListMutation } from "./thread-list-mutation";
export type ActiveThreadCursor = string | null;
export type ActiveThreadData = InfiniteData<ThreadPage, ActiveThreadCursor>;
export function activeThreadsFromData(data: ActiveThreadData | undefined): readonly Thread[] | null {
if (!data) return null;
return orderedUniqueThreads(data.pages.flatMap((page) => page.threads));
}
export function recentActiveThreadsFromData(data: ActiveThreadData | undefined): readonly Thread[] | null {
if (!data) return null;
const threads = activeThreadsFromData(data) ?? [];
const recentWindowCapacity = Math.max(data.pages[0]?.fetchedSize ?? 0, threads.length > 0 ? 1 : 0);
return threads.slice(0, recentWindowCapacity);
}
export function activeThreadDataHasMore(data: ActiveThreadData | undefined): boolean {
return data?.pages.at(-1)?.nextCursor != null;
}
export function applyActiveThreadMutation(data: ActiveThreadData | undefined, mutation: ThreadListMutation): ActiveThreadData | undefined {
if (!data || mutation.list !== "active" || mutation.kind === "refresh") return data;
const pages = data.pages.map((page) => ({ ...page, threads: [...page.threads] }));
switch (mutation.kind) {
case "upsert": {
const existing = pages.some((page) => page.threads.some((thread) => thread.id === mutation.thread.id));
if (existing) {
for (const page of pages) {
page.threads = page.threads.map((thread) => (thread.id === mutation.thread.id ? mutation.thread : thread));
}
} else if (pages[0]) {
pages[0].threads = [mutation.thread, ...pages[0].threads];
}
break;
}
case "remove":
for (const page of pages) page.threads = page.threads.filter((thread) => thread.id !== mutation.threadId);
break;
case "update":
for (const page of pages) {
page.threads = page.threads.map((thread) => (thread.id === mutation.threadId ? { ...thread, ...mutation.changes } : thread));
}
break;
}
return { pages, pageParams: [...data.pageParams] };
}
function orderedUniqueThreads(threads: readonly Thread[]): readonly Thread[] {
const seen = new Set<string>();
return threads
.filter((thread) => {
if (seen.has(thread.id)) return false;
seen.add(thread.id);
return true;
})
.map((thread, index) => ({ thread, index }))
.sort((left, right) => threadRecencyAt(right.thread) - threadRecencyAt(left.thread) || left.index - right.index)
.map(({ thread }) => thread);
}

View file

@ -1,692 +1,389 @@
import {
CancelledError,
InfiniteQueryObserver,
type InfiniteQueryObserverOptions,
type InfiniteQueryObserverResult,
QueryClient,
QueryObserver,
type QueryObserverResult,
} from "@tanstack/query-core";
import type { ModelMetadata, SkillMetadata } from "../../domain/catalog/metadata";
import { cloneRuntimeConfigSnapshot, type RuntimeConfigSnapshot } from "../../domain/runtime/config";
import type { RateLimitSnapshot } from "../../domain/runtime/metrics";
import type { RuntimePermissionProfileSummary } from "../../domain/runtime/permissions";
import {
createServerDiagnostics,
type DiagnosticProbeResult,
diagnosticProbeError,
diagnosticProbeOk,
diagnosticsWithProbe,
} from "../../domain/server/diagnostics";
import type { SharedServerMetadata, SharedServerMetadataResource } from "../../domain/server/metadata";
import { QueryClient, QueryObserver, type QueryObserverResult } from "@tanstack/query-core";
import type { ModelMetadata } from "../../domain/catalog/metadata";
import { createServerDiagnostics, diagnosticProbeError, diagnosticProbeOk, diagnosticsWithProbe } from "../../domain/server/diagnostics";
import type { SharedServerMetadata } from "../../domain/server/metadata";
import type { Thread } from "../../domain/threads/model";
import { StaleExecutionRuntimeError } from "../../shared/runtime/execution-runtime-lifetime";
import type { AppServerClient } from "../connection/client";
import type { AppServerClientAccess, AppServerClientAccessOptions } from "../connection/client-access";
import type { AppServerExecutionContext } from "../connection/execution-context";
import type { AppServerClientAccessOptions } from "../connection/client-access";
import { runtimeConfigSnapshotFromAppServerConfig } from "../protocol/runtime-config";
import { listModelMetadata } from "../services/catalog";
import { readEffectiveConfig } from "../services/runtime-metadata";
import { listThreads, readThreadPage, type ThreadPage } from "../services/threads";
import { listThreads } from "../services/threads";
import {
type ActiveThreadCursor,
type ActiveThreadData,
activeThreadDataHasMore,
activeThreadsFromData,
applyActiveThreadMutation,
recentActiveThreadsFromData,
} from "./active-thread-inventory";
import { readPermissionProfileMetadataProbe, readRateLimitMetadataProbe, readSkillMetadataProbe } from "./metadata-probes";
import type { ObservedPaginatedResult, ObservedPaginatedResultListener, ObservedResult, ObservedResultListener } from "./observed-result";
import { cloneModelMetadata, cloneSharedServerMetadata, cloneSharedServerMetadataResource, cloneThreads } from "./snapshots";
import { applyThreadListMutation, type ThreadListKind, type ThreadListMutation } from "./thread-list-mutation";
type AppServerQueryContext,
activeThreadsQueryKey,
appServerMetadataQueryKey,
appServerModelsQueryKey,
appServerQueriesFilter,
appServerQueryContextIsComplete,
archivedThreadsQueryKey,
cloneAppServerQueryContext,
} from "./keys";
import { readRateLimitMetadataProbe, readSkillMetadataProbe } from "./metadata-probes";
import type { ObservedResult, ObservedResultListener } from "./observed-result";
import { cloneModelMetadata, cloneSharedServerMetadata, cloneThreads } from "./snapshots";
const THREAD_LIST_STALE_TIME_MS = 10_000;
const APP_SERVER_METADATA_STALE_TIME_MS = 10_000;
const MODELS_STALE_TIME_MS = 60_000;
const ACTIVE_THREADS_QUERY_KEY = ["threads", "active"] as const;
const ACTIVE_THREAD_SEARCH_INVENTORY_QUERY_KEY = ["threads", "active-search-inventory"] as const;
const ARCHIVED_THREADS_QUERY_KEY = ["threads", "archived"] as const;
const MODELS_QUERY_KEY = ["models"] as const;
const RUNTIME_CONFIG_QUERY_KEY = ["runtime-config"] as const;
const SKILLS_QUERY_KEY = ["skills"] as const;
const PERMISSION_PROFILES_QUERY_KEY = ["permission-profiles"] as const;
const RATE_LIMITS_QUERY_KEY = ["rate-limits"] as const;
export interface AppServerQueryClientRunner {
runWithClient<T>(
context: AppServerQueryContext,
operation: (client: AppServerClient) => Promise<T>,
options?: AppServerClientAccessOptions,
): Promise<T>;
}
interface AppServerQueryOptions<T> {
readonly queryKey: readonly unknown[];
readonly queryFn: (context: { signal: AbortSignal }) => Promise<T>;
readonly staleTime?: number;
readonly queryFn: () => Promise<T>;
readonly staleTime: number;
}
type ActiveThreadsQueryKey = typeof ACTIVE_THREADS_QUERY_KEY;
interface MetadataResourceSnapshot<T> {
readonly value: T;
readonly probe: DiagnosticProbeResult;
}
type MetadataResourceKind = "skills" | "permissionProfiles" | "rateLimits";
type MetadataResourceValue = readonly SkillMetadata[] | readonly RuntimePermissionProfileSummary[] | RateLimitSnapshot | null;
type ThreadListKind = "active" | "archived";
type ThreadListUpdater = (threads: readonly Thread[] | null) => readonly Thread[] | null;
export class AppServerQueryCache {
private readonly context: Readonly<AppServerExecutionContext>;
private readonly client: QueryClient;
private readonly clientAccess: AppServerClientAccess;
private readonly observerUnsubscribes = new Set<() => void>();
private disposed = false;
readonly client: QueryClient;
private readonly clientRunner: AppServerQueryClientRunner | null;
constructor(context: AppServerExecutionContext, clientAccess: AppServerClientAccess) {
this.context = Object.freeze({ ...context });
this.client = createAppServerQueryClient();
this.clientAccess = clientAccess;
constructor(options: { client?: QueryClient; clientRunner?: AppServerQueryClientRunner } = {}) {
this.client = options.client ?? createAppServerQueryClient();
this.clientRunner = options.clientRunner ?? null;
}
dispose(): void {
if (this.disposed) return;
this.disposed = true;
for (const unsubscribe of [...this.observerUnsubscribes]) unsubscribe();
this.observerUnsubscribes.clear();
clear(): void {
this.client.clear();
}
activeThreadsSnapshot(): readonly Thread[] | null {
if (this.disposed) return null;
const data = this.client.getQueryData<ActiveThreadData>(ACTIVE_THREADS_QUERY_KEY);
const threads = activeThreadsFromData(data);
return threads ? cloneThreads(threads) : null;
clearContext(context: AppServerQueryContext): void {
if (!appServerQueryContextIsComplete(context)) return;
const filter = appServerQueriesFilter(context);
void this.client.cancelQueries(filter);
this.client.removeQueries(filter);
}
recentActiveThreadsSnapshot(): readonly Thread[] | null {
if (this.disposed) return null;
const data = this.client.getQueryData<ActiveThreadData>(ACTIVE_THREADS_QUERY_KEY);
const threads = recentActiveThreadsFromData(data);
return threads ? cloneThreads(threads) : null;
activeThreadsSnapshot(context: AppServerQueryContext): readonly Thread[] | null {
return this.threadListSnapshot(context, "active");
}
archivedThreadsSnapshot(): readonly Thread[] | null {
if (this.disposed) return null;
return this.threadListSnapshot("archived");
archivedThreadsSnapshot(context: AppServerQueryContext): readonly Thread[] | null {
return this.threadListSnapshot(context, "archived");
}
observeActiveThreadsResult(
listener: ObservedPaginatedResultListener<readonly Thread[]>,
context: AppServerQueryContext,
listener: ObservedResultListener<readonly Thread[]>,
options: { emitCurrent?: boolean } = {},
): () => void {
this.assertUsable();
const observer = new InfiniteQueryObserver(this.client, {
...this.activeThreadsQueryOptions(),
enabled: false,
});
const emit = (result: InfiniteQueryObserverResult<ActiveThreadData>): void => {
if (!this.disposed) listener(this.projectObservedActiveThreadsResult(result));
};
const unsubscribe = observer.subscribe(emit);
if (options.emitCurrent ?? true) emit(observer.getCurrentResult());
return this.trackObserver(() => {
unsubscribe();
observer.destroy();
});
return this.observeQueryResult(this.threadListQueryOptions(context, "active"), cloneThreads, listener, options);
}
observeArchivedThreadsResult(listener: ObservedResultListener<readonly Thread[]>, options: { emitCurrent?: boolean } = {}): () => void {
this.assertUsable();
return this.observeQueryResult(this.archivedThreadsQueryOptions(), cloneThreads, listener, options);
observeArchivedThreadsResult(
context: AppServerQueryContext,
listener: ObservedResultListener<readonly Thread[]>,
options: { emitCurrent?: boolean } = {},
): () => void {
return this.observeQueryResult(this.threadListQueryOptions(context, "archived"), cloneThreads, listener, options);
}
fetchActiveThreads(options: { force?: boolean } = {}): Promise<readonly Thread[]> {
return this.runWhileActive(async () => {
const key = ACTIVE_THREADS_QUERY_KEY;
if (options.force) {
if (this.client.getQueryState(key)?.fetchMeta?.fetchMore?.direction === "forward") {
await this.client.cancelQueries({ queryKey: key, exact: true });
}
await this.client.invalidateQueries({ queryKey: key, refetchType: "none" });
this.assertUsable();
}
return this.readThroughQueryCancellation(
async () => {
const data = await this.client.fetchInfiniteQuery(this.activeThreadsQueryOptions());
return cloneThreads(activeThreadsFromData(data) ?? []);
},
() => this.activeThreadsSnapshot(),
);
});
async fetchActiveThreads(context: AppServerQueryContext, options: { force?: boolean } = {}): Promise<readonly Thread[]> {
return this.fetchThreadList(context, "active", options);
}
refreshActiveThreads(): Promise<readonly Thread[]> {
return this.fetchActiveThreads({ force: true });
async fetchArchivedThreads(context: AppServerQueryContext, options: { force?: boolean } = {}): Promise<readonly Thread[]> {
return this.fetchThreadList(context, "archived", options);
}
fetchActiveThreadSearchInventory(): Promise<readonly Thread[]> {
return this.runWhileActive(async () => {
const key = ACTIVE_THREAD_SEARCH_INVENTORY_QUERY_KEY;
const options = {
queryKey: key,
queryFn: ({ signal }: { signal: AbortSignal }) =>
this.runWithClient((client) => listThreads(client, this.context.vaultPath, { signal })),
};
return this.readFreshThroughQueryCancellation(key, async () => cloneThreads(await this.client.fetchQuery(options)));
});
async refreshActiveThreads(context: AppServerQueryContext): Promise<readonly Thread[]> {
return this.fetchActiveThreads(context, { force: true });
}
hasMoreActiveThreads(): boolean {
if (this.disposed) return false;
return activeThreadDataHasMore(this.client.getQueryData<ActiveThreadData>(ACTIVE_THREADS_QUERY_KEY));
async refreshArchivedThreads(context: AppServerQueryContext): Promise<readonly Thread[]> {
return this.fetchArchivedThreads(context, { force: true });
}
loadMoreActiveThreads(): Promise<readonly Thread[]> {
return this.runWhileActive(async () => {
const current = this.activeThreadsSnapshot() ?? (await this.fetchActiveThreads());
const observer = new InfiniteQueryObserver(this.client, {
...this.activeThreadsQueryOptions(),
enabled: false,
});
try {
if (!observer.getCurrentResult().hasNextPage) return current;
const result = await observer.fetchNextPage({ cancelRefetch: false, throwOnError: true });
this.assertUsable();
return result.data ? cloneThreads(activeThreadsFromData(result.data) ?? []) : current;
} catch (error) {
if (error instanceof CancelledError) return this.activeThreadsSnapshot() ?? current;
throw error;
} finally {
observer.destroy();
}
});
setActiveThreads(context: AppServerQueryContext, threads: readonly Thread[]): void {
this.setThreadList(context, "active", threads);
}
refreshArchivedThreads(): Promise<readonly Thread[]> {
return this.fetchArchivedThreads({ force: true });
setArchivedThreads(context: AppServerQueryContext, threads: readonly Thread[]): void {
this.setThreadList(context, "archived", threads);
}
fetchArchivedThreads(options: { force?: boolean } = {}): Promise<readonly Thread[]> {
return this.runWhileActive(async () => {
const key = ARCHIVED_THREADS_QUERY_KEY;
if (options.force) {
await this.client.invalidateQueries({ queryKey: key, refetchType: "none" });
this.assertUsable();
}
return this.readFreshThroughQueryCancellation(key, async () =>
cloneThreads(await this.client.fetchQuery(this.archivedThreadsQueryOptions())),
);
});
updateActiveThreads(context: AppServerQueryContext, updater: ThreadListUpdater): readonly Thread[] | null {
return this.updateThreadList(context, "active", updater);
}
applyThreadListMutations(mutations: readonly ThreadListMutation[]): void {
this.assertUsable();
if (mutations.length === 0) return;
const activeMutations = mutations.filter((mutation) => mutation.list === "active");
if (activeMutations.length > 0) {
const key = ACTIVE_THREADS_QUERY_KEY;
const wasFetching = this.client.getQueryState(key)?.fetchStatus === "fetching";
const fetchIsNextPage = this.client.getQueryState(key)?.fetchMeta?.fetchMore?.direction === "forward";
void this.client.cancelQueries({ queryKey: key, exact: true });
const before = this.client.getQueryData<ActiveThreadData>(key);
const after = activeMutations.reduce<ActiveThreadData | undefined>(applyActiveThreadMutation, before);
if (after !== before) this.client.setQueryData(key, after);
void this.client.invalidateQueries({ queryKey: key, refetchType: "none" });
const searchKey = ACTIVE_THREAD_SEARCH_INVENTORY_QUERY_KEY;
void this.client.cancelQueries({ queryKey: searchKey, exact: true });
void this.client.invalidateQueries({ queryKey: searchKey, refetchType: "none" });
const refreshRequested = activeMutations.some((mutation) => mutation.kind === "refresh");
if ((wasFetching && !fetchIsNextPage) || (refreshRequested && before)) {
void this.fetchActiveThreads({ force: true }).catch(() => {
// Query observers retain refresh failures while the event projection remains last-known-good state.
});
}
}
const archivedMutations = mutations.filter((mutation) => mutation.list === "archived");
if (archivedMutations.length > 0) {
const key = ARCHIVED_THREADS_QUERY_KEY;
const wasFetching = this.client.getQueryState(key)?.fetchStatus === "fetching";
void this.client.cancelQueries({ queryKey: key, exact: true });
const before = this.archivedThreadsSnapshot();
const after = archivedMutations.reduce<readonly Thread[] | null>(applyThreadListMutation, before);
if (after !== before && after) this.client.setQueryData(key, cloneThreads(after));
void this.client.invalidateQueries({ queryKey: key, refetchType: "none" });
const refreshRequested = archivedMutations.some((mutation) => mutation.kind === "refresh");
if (wasFetching || (refreshRequested && before)) {
void this.fetchArchivedThreads({ force: true }).catch(() => {
// Query observers retain refresh failures while the event projection remains last-known-good state.
});
}
}
updateArchivedThreads(context: AppServerQueryContext, updater: ThreadListUpdater): readonly Thread[] | null {
return this.updateThreadList(context, "archived", updater);
}
private threadListSnapshot(kind: ThreadListKind): readonly Thread[] | null {
if (kind === "active") return this.activeThreadsSnapshot();
const threads = this.client.getQueryData<readonly Thread[]>(ARCHIVED_THREADS_QUERY_KEY);
private threadListSnapshot(context: AppServerQueryContext, kind: ThreadListKind): readonly Thread[] | null {
if (!appServerQueryContextIsComplete(context)) return null;
const threads = this.client.getQueryData<readonly Thread[]>(this.threadListQueryKey(context, kind));
return threads ? cloneThreads(threads) : null;
}
appServerMetadataSnapshot(): SharedServerMetadata | null {
if (this.disposed) return null;
const runtimeConfig = this.client.getQueryData<RuntimeConfigSnapshot>(RUNTIME_CONFIG_QUERY_KEY);
if (!runtimeConfig) return null;
const skills = this.metadataResourceState("skills");
const permissionProfiles = this.metadataResourceState("permissionProfiles");
const rateLimits = this.metadataResourceState("rateLimits");
const diagnostics = [this.modelsProbe(), skills.probe, permissionProfiles.probe, rateLimits.probe].reduce(
(current, probe) => diagnosticsWithProbe(current, probe),
createServerDiagnostics(),
);
return cloneSharedServerMetadata({
runtimeConfig,
availableSkills: skills.value ?? [],
availablePermissionProfiles: permissionProfiles.value ?? [],
rateLimit: rateLimits.value ?? null,
serverDiagnostics: diagnostics,
});
private async fetchThreadList(
context: AppServerQueryContext,
kind: ThreadListKind,
options: { force?: boolean } = {},
): Promise<readonly Thread[]> {
const refreshContext = cloneAppServerQueryContext(context);
if (!appServerQueryContextIsComplete(refreshContext)) {
return [];
}
const key = this.threadListQueryKey(refreshContext, kind);
if (options.force) await this.client.invalidateQueries({ queryKey: key });
const threads = await this.client.fetchQuery(this.threadListQueryOptions(refreshContext, kind));
return cloneThreads(threads);
}
observeAppServerMetadataResources(
listener: (resource: SharedServerMetadataResource) => void,
private setThreadList(context: AppServerQueryContext, kind: ThreadListKind, threads: readonly Thread[]): void {
if (!appServerQueryContextIsComplete(context)) return;
this.client.setQueryData(this.threadListQueryKey(context, kind), cloneThreads(threads));
}
private updateThreadList(context: AppServerQueryContext, kind: ThreadListKind, updater: ThreadListUpdater): readonly Thread[] | null {
if (!appServerQueryContextIsComplete(context)) return null;
const current = this.threadListSnapshot(context, kind);
const next = updater(current);
if (!next) return null;
this.client.setQueryData(this.threadListQueryKey(context, kind), cloneThreads(next), current ? undefined : { updatedAt: 0 });
return cloneThreads(next);
}
appServerMetadataSnapshot(context: AppServerQueryContext): SharedServerMetadata | null {
if (!appServerQueryContextIsComplete(context)) return null;
const metadata = this.client.getQueryData<SharedServerMetadata>(appServerMetadataQueryKey(context));
return metadata ? cloneSharedServerMetadata(metadata) : null;
}
observeAppServerMetadataResult(
context: AppServerQueryContext,
listener: ObservedResultListener<SharedServerMetadata>,
options: { emitCurrent?: boolean } = {},
): () => void {
this.assertUsable();
let unsubscribed = false;
const emit = (resource: SharedServerMetadataResource): void => {
if (!this.disposed && !unsubscribed) listener(cloneSharedServerMetadataResource(resource));
};
return this.observeQueryResult(this.appServerMetadataQueryOptions(context), cloneSharedServerMetadata, listener, options);
}
const runtimeConfig = new QueryObserver(this.client, { ...this.runtimeConfigQueryOptions(), enabled: false });
const models = new QueryObserver(this.client, { ...this.modelsQueryOptions(), enabled: false });
const skills = new QueryObserver(this.client, { ...this.skillsQueryOptions(), enabled: false });
const permissionProfiles = new QueryObserver(this.client, { ...this.permissionProfilesQueryOptions(), enabled: false });
const rateLimits = new QueryObserver(this.client, { ...this.rateLimitsQueryOptions(), enabled: false });
const emitRuntimeConfig = (result: QueryObserverResult<RuntimeConfigSnapshot>, includeFetching = false): void => {
if (result.isFetching && !includeFetching) return;
emit({ id: "runtimeConfig", value: result.data ? cloneRuntimeConfigSnapshot(result.data) : undefined });
};
const emitModels = (result: QueryObserverResult<readonly ModelMetadata[]>, includeFetching = false): void => {
if (result.isFetching && !includeFetching) return;
emit({ id: "models", value: result.data ? cloneModelMetadata(result.data) : undefined, probe: this.modelsProbe() });
};
const emitSkills = (result: QueryObserverResult<MetadataResourceSnapshot<readonly SkillMetadata[]>>, includeFetching = false): void => {
if (result.isFetching && !includeFetching) return;
const state = this.metadataResourceState("skills");
emit({ id: "skills", value: state.value ?? undefined, probe: state.probe });
};
const emitPermissionProfiles = (
result: QueryObserverResult<MetadataResourceSnapshot<readonly RuntimePermissionProfileSummary[]>>,
includeFetching = false,
): void => {
if (result.isFetching && !includeFetching) return;
const state = this.metadataResourceState("permissionProfiles");
emit({ id: "permissionProfiles", value: state.value ?? undefined, probe: state.probe });
};
const emitRateLimits = (
result: QueryObserverResult<MetadataResourceSnapshot<RateLimitSnapshot | null>>,
includeFetching = false,
): void => {
if (result.isFetching && !includeFetching) return;
const state = this.metadataResourceState("rateLimits");
emit({ id: "rateLimits", value: state.value, probe: state.probe });
};
const unsubscribers = [
runtimeConfig.subscribe(emitRuntimeConfig),
models.subscribe(emitModels),
skills.subscribe(emitSkills),
permissionProfiles.subscribe(emitPermissionProfiles),
rateLimits.subscribe(emitRateLimits),
];
if (options.emitCurrent ?? true) {
emitRuntimeConfig(runtimeConfig.getCurrentResult(), true);
emitModels(models.getCurrentResult(), true);
emitSkills(skills.getCurrentResult(), true);
emitPermissionProfiles(permissionProfiles.getCurrentResult(), true);
emitRateLimits(rateLimits.getCurrentResult(), true);
async refreshAppServerMetadata(
context: AppServerQueryContext,
options: { forceSkills?: boolean } = {},
): Promise<SharedServerMetadata | null> {
const refreshContext = cloneAppServerQueryContext(context);
if (!appServerQueryContextIsComplete(refreshContext)) {
return null;
}
return this.trackObserver(() => {
unsubscribed = true;
for (const unsubscribe of unsubscribers) unsubscribe();
runtimeConfig.destroy();
models.destroy();
skills.destroy();
permissionProfiles.destroy();
rateLimits.destroy();
});
const key = appServerMetadataQueryKey(refreshContext);
await Promise.all([
this.client.invalidateQueries({ queryKey: key }),
this.client.invalidateQueries({ queryKey: appServerModelsQueryKey(refreshContext) }),
]);
const metadata = await this.client.fetchQuery(this.appServerMetadataQueryOptions(refreshContext, options));
return this.writeAppServerMetadata(refreshContext, metadata);
}
refreshAppServerMetadata(): Promise<void> {
return this.runWhileActive(async () => {
const runtimeResult = this.fetchRuntimeConfig().then(
() => ({ ok: true as const }),
(error: unknown) => ({ ok: false as const, error }),
);
const [, runtime] = await Promise.all([
Promise.allSettled([
this.fetchMetadataResource("skills"),
this.fetchMetadataResource("permissionProfiles"),
this.fetchMetadataResource("rateLimits"),
this.fetchModels({ force: true }),
]),
runtimeResult,
]);
this.assertUsable();
if (!runtime.ok) throw runtime.error;
writeAppServerMetadata(context: AppServerQueryContext, metadata: SharedServerMetadata): SharedServerMetadata | null {
if (!appServerQueryContextIsComplete(context)) return null;
const previous = this.appServerMetadataSnapshot(context);
const probes = metadata.serverDiagnostics.probes;
const next = cloneSharedServerMetadata({
...metadata,
availableModels: probes.models.status === "ok" ? metadata.availableModels : (this.modelsSnapshot(context) ?? []),
availableSkills: probes.skills.status === "ok" ? metadata.availableSkills : (previous?.availableSkills ?? []),
rateLimit: probes.rateLimits.status === "ok" ? metadata.rateLimit : (previous?.rateLimit ?? null),
});
this.client.setQueryData(appServerMetadataQueryKey(context), cloneSharedServerMetadata(next));
if (probes.models.status === "ok") {
this.client.setQueryData(appServerModelsQueryKey(context), cloneModelMetadata(next.availableModels));
}
return cloneSharedServerMetadata(next);
}
refreshSkills(): Promise<void> {
return this.runWhileActive(async () => {
await this.refreshNotifiedMetadataResource("skills");
this.assertUsable();
});
updateAppServerMetadata(
context: AppServerQueryContext,
updater: (metadata: SharedServerMetadata | null) => SharedServerMetadata | null,
): SharedServerMetadata | null {
if (!appServerQueryContextIsComplete(context)) return null;
const next = updater(this.appServerMetadataSnapshot(context));
return next ? this.writeAppServerMetadata(context, next) : null;
}
refreshRateLimits(): Promise<void> {
return this.runWhileActive(async () => {
await this.refreshNotifiedMetadataResource("rateLimits");
this.assertUsable();
});
}
modelsSnapshot(): readonly ModelMetadata[] | null {
if (this.disposed) return null;
const models = this.client.getQueryData<readonly ModelMetadata[]>(MODELS_QUERY_KEY);
modelsSnapshot(context: AppServerQueryContext): readonly ModelMetadata[] | null {
if (!appServerQueryContextIsComplete(context)) return null;
const models = this.client.getQueryData<readonly ModelMetadata[]>(appServerModelsQueryKey(context));
return models ? cloneModelMetadata(models) : null;
}
observeModelsResult(listener: ObservedResultListener<readonly ModelMetadata[]>, options: { emitCurrent?: boolean } = {}): () => void {
this.assertUsable();
return this.observeQueryResult(this.modelsQueryOptions(), cloneModelMetadata, listener, options);
observeModelsResult(
context: AppServerQueryContext,
listener: ObservedResultListener<readonly ModelMetadata[]>,
options: { emitCurrent?: boolean } = {},
): () => void {
return this.observeQueryResult(this.modelsQueryOptions(context), cloneModelMetadata, listener, options);
}
fetchModels(options: { force?: boolean } = {}): Promise<readonly ModelMetadata[]> {
return this.runWhileActive(async () => {
const key = MODELS_QUERY_KEY;
if (options.force) {
await this.client.invalidateQueries({ queryKey: key, refetchType: "none" });
this.assertUsable();
}
const models = await this.client.fetchQuery(this.modelsQueryOptions());
this.assertUsable();
return cloneModelMetadata(models);
});
}
refreshModels(): Promise<readonly ModelMetadata[]> {
return this.fetchModels({ force: true });
}
private activeThreadsQueryOptions(): InfiniteQueryObserverOptions<
ThreadPage,
Error,
ActiveThreadData,
ActiveThreadsQueryKey,
ActiveThreadCursor
> {
return {
queryKey: ACTIVE_THREADS_QUERY_KEY,
queryFn: async ({ pageParam, signal }) => {
signal.throwIfAborted();
const page = await this.runWithClient((client) =>
readThreadPage(client, this.context.vaultPath, { cursor: pageParam, archived: false }),
);
signal.throwIfAborted();
return page;
},
initialPageParam: null,
getNextPageParam: (lastPage) => lastPage.nextCursor ?? undefined,
staleTime: Number.POSITIVE_INFINITY,
};
}
private archivedThreadsQueryOptions(): AppServerQueryOptions<readonly Thread[]> {
return {
queryKey: ARCHIVED_THREADS_QUERY_KEY,
queryFn: ({ signal }: { signal: AbortSignal }) =>
this.runWithClient((client) => listThreads(client, this.context.vaultPath, { archived: true, signal })).then(cloneThreads),
staleTime: Number.POSITIVE_INFINITY,
};
}
private runtimeConfigQueryOptions(): AppServerQueryOptions<RuntimeConfigSnapshot> {
return {
queryKey: RUNTIME_CONFIG_QUERY_KEY,
queryFn: async (): Promise<RuntimeConfigSnapshot> =>
this.runWithClient(async (client) =>
runtimeConfigSnapshotFromAppServerConfig(await readEffectiveConfig(client, this.context.vaultPath)),
),
};
}
private skillsQueryOptions(): AppServerQueryOptions<MetadataResourceSnapshot<readonly SkillMetadata[]>> {
return {
queryKey: SKILLS_QUERY_KEY,
queryFn: async () =>
this.runWithClient(async (client) => successfulMetadataResource(await readSkillMetadataProbe(client, this.context.vaultPath))),
};
}
private permissionProfilesQueryOptions(): AppServerQueryOptions<MetadataResourceSnapshot<readonly RuntimePermissionProfileSummary[]>> {
return {
queryKey: PERMISSION_PROFILES_QUERY_KEY,
queryFn: async () =>
this.runWithClient(async (client) =>
successfulMetadataResource(await readPermissionProfileMetadataProbe(client, this.context.vaultPath)),
),
};
}
private rateLimitsQueryOptions(): AppServerQueryOptions<MetadataResourceSnapshot<RateLimitSnapshot | null>> {
return {
queryKey: RATE_LIMITS_QUERY_KEY,
queryFn: async () => this.runWithClient(async (client) => successfulMetadataResource(await readRateLimitMetadataProbe(client))),
};
}
private async fetchRuntimeConfig(): Promise<RuntimeConfigSnapshot> {
const runtimeConfig = await this.client.fetchQuery(this.runtimeConfigQueryOptions());
this.assertUsable();
return cloneRuntimeConfigSnapshot(runtimeConfig);
}
private fetchMetadataResource(resource: MetadataResourceKind): Promise<void> {
return (async (): Promise<void> => {
if (resource === "skills") {
const options = this.skillsQueryOptions();
await this.client.fetchQuery(options);
this.assertUsable();
return;
}
if (resource === "permissionProfiles") {
const options = this.permissionProfilesQueryOptions();
await this.client.fetchQuery(options);
this.assertUsable();
return;
}
const options = this.rateLimitsQueryOptions();
await this.client.fetchQuery(options);
this.assertUsable();
})();
}
private async refreshNotifiedMetadataResource(resource: "skills" | "rateLimits"): Promise<void> {
const queryKey = resource === "skills" ? SKILLS_QUERY_KEY : RATE_LIMITS_QUERY_KEY;
await this.client.cancelQueries({ queryKey, exact: true });
this.assertUsable();
try {
await this.fetchMetadataResource(resource);
} catch (error) {
if (!(error instanceof CancelledError)) throw error;
async fetchModels(context: AppServerQueryContext, options: { force?: boolean } = {}): Promise<readonly ModelMetadata[]> {
const refreshContext = cloneAppServerQueryContext(context);
if (!appServerQueryContextIsComplete(refreshContext)) {
return [];
}
const key = appServerModelsQueryKey(refreshContext);
if (options.force) await this.client.invalidateQueries({ queryKey: key });
const models = await this.client.fetchQuery(this.modelsQueryOptions(refreshContext));
return cloneModelMetadata(models);
}
private metadataResourceState(resource: "skills"): { value: readonly SkillMetadata[] | null; probe: DiagnosticProbeResult };
private metadataResourceState(resource: "permissionProfiles"): {
value: readonly RuntimePermissionProfileSummary[] | null;
probe: DiagnosticProbeResult;
};
private metadataResourceState(resource: "rateLimits"): { value: RateLimitSnapshot | null; probe: DiagnosticProbeResult };
private metadataResourceState(resource: MetadataResourceKind): { value: MetadataResourceValue; probe: DiagnosticProbeResult } {
const key =
resource === "skills" ? SKILLS_QUERY_KEY : resource === "permissionProfiles" ? PERMISSION_PROFILES_QUERY_KEY : RATE_LIMITS_QUERY_KEY;
const state = this.client.getQueryState<MetadataResourceSnapshot<MetadataResourceValue>>(key);
const failedProbe = diagnosticProbeFromError(state?.error);
async refreshModels(context: AppServerQueryContext): Promise<readonly ModelMetadata[]> {
return this.fetchModels(context, { force: true });
}
private threadListQueryOptions(context: AppServerQueryContext, kind: ThreadListKind): AppServerQueryOptions<readonly Thread[]> {
const refreshContext = cloneAppServerQueryContext(context);
return {
value: state?.data?.value ?? null,
probe: failedProbe ?? state?.data?.probe ?? createServerDiagnostics().probes[resource],
queryKey: this.threadListQueryKey(refreshContext, kind),
queryFn: async (): Promise<readonly Thread[]> => {
return cloneThreads(
await this.runWithClient(refreshContext, (client) =>
listThreads(client, refreshContext.vaultPath, { archived: kind === "archived" }),
),
);
},
staleTime: THREAD_LIST_STALE_TIME_MS,
};
}
private modelsProbe(): DiagnosticProbeResult {
const state = this.client.getQueryState<readonly ModelMetadata[]>(MODELS_QUERY_KEY);
return (
diagnosticProbeFromError(state?.error) ??
(state?.data
? diagnosticProbeOk("models", `${String(state.data.length)} models`, state.dataUpdatedAt)
: createServerDiagnostics().probes.models)
);
private threadListQueryKey(
context: AppServerQueryContext,
kind: ThreadListKind,
): ReturnType<typeof activeThreadsQueryKey> | ReturnType<typeof archivedThreadsQueryKey> {
return kind === "archived" ? archivedThreadsQueryKey(context) : activeThreadsQueryKey(context);
}
private modelsQueryOptions(): AppServerQueryOptions<readonly ModelMetadata[]> {
private appServerMetadataQueryOptions(
context: AppServerQueryContext,
options: { forceSkills?: boolean } = {},
): AppServerQueryOptions<SharedServerMetadata> {
const refreshContext = cloneAppServerQueryContext(context);
return {
queryKey: MODELS_QUERY_KEY,
queryFn: async (): Promise<readonly ModelMetadata[]> => {
try {
return cloneModelMetadata(
await this.runWithClient((client) => listModelMetadata(client), {
serverRequests: { kind: "reject", message: "Codex model list refresh does not handle server requests." },
}),
queryKey: appServerMetadataQueryKey(refreshContext),
queryFn: async (): Promise<SharedServerMetadata> => {
return this.runWithClient(refreshContext, async (client) => {
const runtimeConfig = runtimeConfigSnapshotFromAppServerConfig(await readEffectiveConfig(client, refreshContext.vaultPath));
const [models, skills, rateLimit] = await Promise.all([
this.readModelMetadataProbe(refreshContext, client),
readSkillMetadataProbe(client, refreshContext.vaultPath, options.forceSkills ?? false),
readRateLimitMetadataProbe(client),
]);
const diagnostics = [models.probe, skills.probe, rateLimit.probe].reduce(
(current, probe) => diagnosticsWithProbe(current, probe),
this.appServerMetadataSnapshot(refreshContext)?.serverDiagnostics ?? createServerDiagnostics(),
);
} catch (error) {
throw new MetadataResourceQueryError(diagnosticProbeError("models", error, Date.now()));
}
return {
runtimeConfig,
availableModels: models.value,
availableSkills: skills.value,
rateLimit: rateLimit.value,
serverDiagnostics: diagnostics,
};
});
},
staleTime: APP_SERVER_METADATA_STALE_TIME_MS,
};
}
private modelsQueryOptions(context: AppServerQueryContext): AppServerQueryOptions<readonly ModelMetadata[]> {
const refreshContext = cloneAppServerQueryContext(context);
return {
queryKey: appServerModelsQueryKey(refreshContext),
queryFn: async (): Promise<readonly ModelMetadata[]> => {
return cloneModelMetadata(
await this.runWithClient(refreshContext, (client) => listModelMetadata(client), {
serverRequests: { kind: "reject", message: "Codex model list refresh does not handle server requests." },
}),
);
},
staleTime: MODELS_STALE_TIME_MS,
};
}
private observeQueryResult<TQuery, TValue>(
queryOptions: AppServerQueryOptions<TQuery>,
project: (value: TQuery) => TValue,
listener: ObservedResultListener<TValue>,
private async readModelMetadataProbe(
context: AppServerQueryContext,
client: AppServerClient,
): Promise<{
value: readonly ModelMetadata[];
probe: SharedServerMetadata["serverDiagnostics"]["probes"]["models"];
}> {
try {
const models = cloneModelMetadata(await this.client.fetchQuery(this.modelsQueryOptionsWithClient(context, client)));
return { value: models, probe: diagnosticProbeOk("models", `${String(models.length)} models`, Date.now()) };
} catch (error) {
return {
value: this.modelsSnapshot(context) ?? [],
probe: diagnosticProbeError("models", error, Date.now()),
};
}
}
private modelsQueryOptionsWithClient(
context: AppServerQueryContext,
client: AppServerClient,
): AppServerQueryOptions<readonly ModelMetadata[]> {
const refreshContext = cloneAppServerQueryContext(context);
return {
...this.modelsQueryOptions(refreshContext),
queryFn: async (): Promise<readonly ModelMetadata[]> => cloneModelMetadata(await listModelMetadata(client)),
};
}
private observeQueryResult<T>(
queryOptions: AppServerQueryOptions<T>,
clone: (value: T) => T,
listener: ObservedResultListener<T>,
options: { emitCurrent?: boolean },
): () => void {
const observer = new QueryObserver<TQuery>(this.client, {
const observer = new QueryObserver<T>(this.client, {
...queryOptions,
enabled: false,
});
const emit = (result: QueryObserverResult<TQuery>): void => {
if (!this.disposed) listener(this.projectObservedResult(result, project));
const emit = (result: QueryObserverResult<T>): void => {
listener(this.cloneObservedResult(result, clone));
};
const unsubscribe = observer.subscribe(emit);
if (options.emitCurrent ?? true) emit(observer.getCurrentResult());
return this.trackObserver(() => {
unsubscribe();
observer.destroy();
});
return unsubscribe;
}
private projectObservedResult<TQuery, TValue>(
result: QueryObserverResult<TQuery>,
project: (value: TQuery) => TValue,
): ObservedResult<TValue> {
private cloneObservedResult<T>(result: QueryObserverResult<T>, clone: (value: T) => T): ObservedResult<T> {
return {
value: result.data === undefined ? null : project(result.data),
value: result.data === undefined ? null : clone(result.data),
error: result.error instanceof Error ? result.error : null,
isFetching: result.isFetching,
};
}
private projectObservedActiveThreadsResult(
result: InfiniteQueryObserverResult<ActiveThreadData>,
): ObservedPaginatedResult<readonly Thread[]> {
const threads = activeThreadsFromData(result.data);
return {
value: threads ? cloneThreads(threads) : null,
error: result.error instanceof Error ? result.error : null,
isFetching: result.isFetching,
hasMore: result.hasNextPage,
isFetchingNextPage: result.isFetchingNextPage,
};
}
private runWithClient<T>(operation: (client: AppServerClient) => Promise<T>, options: AppServerClientAccessOptions = {}): Promise<T> {
this.assertUsable();
return this.clientAccess.withClient(operation, options);
}
private async readThroughQueryCancellation<T>(read: () => Promise<T>, fallback?: () => T | null): Promise<T> {
for (;;) {
try {
const value = await read();
this.assertUsable();
return value;
} catch (error) {
if (!(error instanceof CancelledError)) throw error;
this.assertUsable();
const fallbackValue = fallback?.();
if (fallbackValue != null) return fallbackValue;
}
private runWithClient<T>(
context: AppServerQueryContext,
operation: (client: AppServerClient) => Promise<T>,
options: AppServerClientAccessOptions = {},
): Promise<T> {
if (!this.clientRunner) {
throw new Error("Codex app-server query client runner is not configured.");
}
return this.clientRunner.runWithClient(context, operation, options);
}
private async readFreshThroughQueryCancellation<T>(queryKey: readonly unknown[], read: () => Promise<T>): Promise<T> {
for (;;) {
const value = await this.readThroughQueryCancellation(read);
this.assertUsable();
if (!this.client.getQueryState(queryKey)?.isInvalidated) return value;
}
}
private assertUsable(): void {
if (this.disposed) throw new StaleExecutionRuntimeError();
}
private runWhileActive<T>(operation: () => Promise<T>): Promise<T> {
this.assertUsable();
return (async () => {
try {
const result = await operation();
this.assertUsable();
return result;
} catch (error) {
if (this.disposed) throw new StaleExecutionRuntimeError();
throw error;
}
})();
}
private trackObserver(unsubscribe: () => void): () => void {
let subscribed = true;
const trackedUnsubscribe = (): void => {
if (!subscribed) return;
subscribed = false;
this.observerUnsubscribes.delete(trackedUnsubscribe);
unsubscribe();
};
this.observerUnsubscribes.add(trackedUnsubscribe);
return trackedUnsubscribe;
}
}
class MetadataResourceQueryError extends Error {
constructor(readonly probe: DiagnosticProbeResult) {
super(probe.message ?? `Codex app-server ${probe.id} query failed.`);
this.name = "MetadataResourceQueryError";
}
}
function successfulMetadataResource<T>(result: MetadataResourceSnapshot<T>): MetadataResourceSnapshot<T> {
if (result.probe.status !== "ok") throw new MetadataResourceQueryError(result.probe);
return result;
}
function diagnosticProbeFromError(error: unknown): DiagnosticProbeResult | null {
return error instanceof MetadataResourceQueryError ? error.probe : null;
}
function createAppServerQueryClient(): QueryClient {
return new QueryClient({
defaultOptions: {
queries: {
networkMode: "always",
gcTime: Infinity,
retry: false,
refetchOnReconnect: false,
refetchOnWindowFocus: false,
},
mutations: {

View file

@ -0,0 +1,56 @@
import type { QueryKey } from "@tanstack/query-core";
export interface AppServerQueryContext {
codexPath: string;
vaultPath: string;
}
type AppServerQueryScope = readonly ["app-server", string, string];
export type AppServerActiveThreadsQueryKey = readonly [...AppServerQueryScope, "threads", "active"];
export type AppServerArchivedThreadsQueryKey = readonly [...AppServerQueryScope, "threads", "archived"];
export type AppServerMetadataQueryKey = readonly [...AppServerQueryScope, "metadata"];
export type AppServerModelsQueryKey = readonly [...AppServerQueryScope, "models"];
export function appServerQueryContextIsComplete(context: AppServerQueryContext): boolean {
return nonEmptyString(context.codexPath) && nonEmptyString(context.vaultPath);
}
export function cloneAppServerQueryContext(context: AppServerQueryContext): AppServerQueryContext {
return { ...context };
}
export function appServerQueryContextRawEquals(left: AppServerQueryContext, right: AppServerQueryContext): boolean {
return left.codexPath === right.codexPath && left.vaultPath === right.vaultPath;
}
export function appServerQueryContextMatches(left: AppServerQueryContext, right: AppServerQueryContext): boolean {
return appServerQueryContextIsComplete(left) && appServerQueryContextIsComplete(right) && appServerQueryContextRawEquals(left, right);
}
function appServerQueryScope(context: AppServerQueryContext): AppServerQueryScope {
return ["app-server", context.codexPath, context.vaultPath];
}
export function activeThreadsQueryKey(context: AppServerQueryContext): AppServerActiveThreadsQueryKey {
return [...appServerQueryScope(context), "threads", "active"];
}
export function archivedThreadsQueryKey(context: AppServerQueryContext): AppServerArchivedThreadsQueryKey {
return [...appServerQueryScope(context), "threads", "archived"];
}
export function appServerMetadataQueryKey(context: AppServerQueryContext): AppServerMetadataQueryKey {
return [...appServerQueryScope(context), "metadata"];
}
export function appServerModelsQueryKey(context: AppServerQueryContext): AppServerModelsQueryKey {
return [...appServerQueryScope(context), "models"];
}
export function appServerQueriesFilter(context: AppServerQueryContext): { queryKey: QueryKey } {
return { queryKey: appServerQueryScope(context) };
}
function nonEmptyString(value: string): boolean {
return value.trim().length > 0;
}

View file

@ -1,9 +1,8 @@
import type { SkillMetadata } from "../../domain/catalog/metadata";
import type { RateLimitSnapshot } from "../../domain/runtime/metrics";
import type { RuntimePermissionProfileSummary } from "../../domain/runtime/permissions";
import { type Diagnostics, diagnosticProbeError, diagnosticProbeOk } from "../../domain/server/diagnostics";
import { accountRateLimitsSummaryFromResponse, rateLimitSnapshotFromAccountRateLimitsResponse } from "../protocol/runtime-metrics";
import { listPermissionProfiles, listSkillCatalog } from "../services/catalog";
import { listSkillCatalog } from "../services/catalog";
import type { AppServerRequestClient } from "../services/request-client";
import { readAccountRateLimits } from "../services/runtime-metadata";
@ -13,31 +12,31 @@ interface MetadataProbeResult<T, K extends keyof Diagnostics["probes"]> {
}
export type SkillMetadataProbeResult = MetadataProbeResult<SkillMetadata[], "skills">;
export type PermissionProfileMetadataProbeResult = MetadataProbeResult<RuntimePermissionProfileSummary[], "permissionProfiles">;
export type RateLimitMetadataProbeResult = MetadataProbeResult<RateLimitSnapshot | null, "rateLimits">;
export async function readSkillMetadataProbe(client: AppServerRequestClient, vaultPath: string): Promise<SkillMetadataProbeResult> {
export async function readSkillMetadataProbe(
client: AppServerRequestClient | null,
vaultPath: string,
forceReload = false,
): Promise<SkillMetadataProbeResult> {
if (!client) {
return { value: [], probe: diagnosticProbeError("skills", new Error("Codex app-server is not connected."), Date.now()) };
}
try {
const catalog = await listSkillCatalog(client, vaultPath);
const catalog = await listSkillCatalog(client, vaultPath, { forceReload });
return { value: catalog.skills, probe: diagnosticProbeOk("skills", `${String(catalog.totalCount)} skills`, Date.now()) };
} catch (error) {
return { value: [], probe: diagnosticProbeError("skills", error, Date.now()) };
}
}
export async function readPermissionProfileMetadataProbe(
client: AppServerRequestClient,
vaultPath: string,
): Promise<PermissionProfileMetadataProbeResult> {
try {
const profiles = await listPermissionProfiles(client, vaultPath);
return { value: profiles, probe: diagnosticProbeOk("permissionProfiles", `${String(profiles.length)} profiles`, Date.now()) };
} catch (error) {
return { value: [], probe: diagnosticProbeError("permissionProfiles", error, Date.now()) };
export async function readRateLimitMetadataProbe(client: AppServerRequestClient | null): Promise<RateLimitMetadataProbeResult> {
if (!client) {
return {
value: null,
probe: diagnosticProbeError("rateLimits", new Error("Codex app-server is not connected."), Date.now()),
};
}
}
export async function readRateLimitMetadataProbe(client: AppServerRequestClient): Promise<RateLimitMetadataProbeResult> {
try {
const response = await readAccountRateLimits(client);
return {

View file

@ -6,13 +6,10 @@ export interface ObservedResult<T> {
export type ObservedResultListener<T> = (result: ObservedResult<T>) => void;
export interface ObservedPaginatedResult<T> extends ObservedResult<T> {
readonly hasMore: boolean;
readonly isFetchingNextPage: boolean;
export function observedValue<T>(result: ObservedResult<T>): T | null {
return result.value;
}
export type ObservedPaginatedResultListener<T> = (result: ObservedPaginatedResult<T>) => void;
export function observedInitialLoading<T>(result: ObservedResult<T>, currentValue: T | null | undefined): boolean {
return currentValue == null && result.isFetching;
}

View file

@ -0,0 +1,193 @@
import type { ModelMetadata } from "../../domain/catalog/metadata";
import type { SharedServerMetadata } from "../../domain/server/metadata";
import type { Thread } from "../../domain/threads/model";
import type { AppServerQueryCache } from "./cache";
import {
type AppServerQueryContext,
appServerQueryContextMatches,
appServerQueryContextRawEquals,
cloneAppServerQueryContext,
} from "./keys";
import type { ObservedResultListener } from "./observed-result";
export interface AppServerSharedQueriesOptions {
cache: AppServerQueryCache;
context: () => AppServerQueryContext;
}
export class StaleAppServerSharedQueryContextError extends Error {
constructor() {
super("Codex app-server query context changed while loading shared queries.");
this.name = "StaleAppServerSharedQueryContextError";
}
}
export function isStaleAppServerSharedQueryContextError(error: unknown): error is StaleAppServerSharedQueryContextError {
return error instanceof StaleAppServerSharedQueryContextError;
}
export class AppServerSharedQueries {
private readonly contextChangeListeners = new Set<() => void>();
constructor(private readonly options: AppServerSharedQueriesOptions) {}
contextKey(): string {
const context = this.context();
return `${context.codexPath}\u0000${context.vaultPath}`;
}
activeThreadsSnapshot(): readonly Thread[] | null {
return this.options.cache.activeThreadsSnapshot(this.context());
}
archivedThreadsSnapshot(): readonly Thread[] | null {
return this.options.cache.archivedThreadsSnapshot(this.context());
}
fetchActiveThreads(): Promise<readonly Thread[]> {
return this.runForCurrentContext((context) => this.options.cache.fetchActiveThreads(context));
}
fetchArchivedThreads(): Promise<readonly Thread[]> {
return this.runForCurrentContext((context) => this.options.cache.fetchArchivedThreads(context));
}
refreshActiveThreads(): Promise<readonly Thread[]> {
return this.runForCurrentContext((context) => this.options.cache.refreshActiveThreads(context));
}
refreshArchivedThreads(): Promise<readonly Thread[]> {
return this.runForCurrentContext((context) => this.options.cache.refreshArchivedThreads(context));
}
setActiveThreads(threads: readonly Thread[]): void {
this.options.cache.setActiveThreads(this.context(), threads);
}
setArchivedThreads(threads: readonly Thread[]): void {
this.options.cache.setArchivedThreads(this.context(), threads);
}
updateActiveThreads(updater: (threads: readonly Thread[] | null) => readonly Thread[] | null): readonly Thread[] | null {
return this.options.cache.updateActiveThreads(this.context(), updater);
}
updateArchivedThreads(updater: (threads: readonly Thread[] | null) => readonly Thread[] | null): readonly Thread[] | null {
return this.options.cache.updateArchivedThreads(this.context(), updater);
}
observeActiveThreadsResult(listener: ObservedResultListener<readonly Thread[]>, options?: { emitCurrent?: boolean }): () => void {
return this.observeCurrentContext(
(context, contextListener, observeOptions) => this.options.cache.observeActiveThreadsResult(context, contextListener, observeOptions),
listener,
options,
);
}
observeArchivedThreadsResult(listener: ObservedResultListener<readonly Thread[]>, options?: { emitCurrent?: boolean }): () => void {
return this.observeCurrentContext(
(context, contextListener, observeOptions) =>
this.options.cache.observeArchivedThreadsResult(context, contextListener, observeOptions),
listener,
options,
);
}
appServerMetadataSnapshot(): SharedServerMetadata | null {
return this.options.cache.appServerMetadataSnapshot(this.context());
}
updateAppServerMetadata(updater: (metadata: SharedServerMetadata | null) => SharedServerMetadata | null): SharedServerMetadata | null {
return this.options.cache.updateAppServerMetadata(this.context(), updater);
}
refreshAppServerMetadata(options: { forceSkills?: boolean } = {}): Promise<SharedServerMetadata | null> {
return this.runForCurrentContext((context) => this.options.cache.refreshAppServerMetadata(context, options));
}
observeAppServerMetadataResult(listener: ObservedResultListener<SharedServerMetadata>, options?: { emitCurrent?: boolean }): () => void {
return this.observeCurrentContext(
(context, contextListener, observeOptions) =>
this.options.cache.observeAppServerMetadataResult(context, contextListener, observeOptions),
listener,
options,
);
}
modelsSnapshot(): readonly ModelMetadata[] | null {
return this.options.cache.modelsSnapshot(this.context());
}
fetchModels(): Promise<readonly ModelMetadata[]> {
return this.runForCurrentContext((context) => this.options.cache.fetchModels(context));
}
refreshModels(): Promise<readonly ModelMetadata[]> {
return this.runForCurrentContext((context) => this.options.cache.refreshModels(context));
}
observeModelsResult(listener: ObservedResultListener<readonly ModelMetadata[]>, options?: { emitCurrent?: boolean }): () => void {
return this.observeCurrentContext(
(context, contextListener, observeOptions) => this.options.cache.observeModelsResult(context, contextListener, observeOptions),
listener,
options,
);
}
notifyContextChanged(): void {
for (const listener of [...this.contextChangeListeners]) {
listener();
}
}
private context(): AppServerQueryContext {
return this.options.context();
}
private async runForCurrentContext<T>(operation: (context: AppServerQueryContext) => Promise<T>): Promise<T> {
const context = cloneAppServerQueryContext(this.context());
const result = await operation(context);
if (!appServerQueryContextRawEquals(this.context(), context)) {
throw new StaleAppServerSharedQueryContextError();
}
return result;
}
private observeCurrentContext<T>(
observe: (context: AppServerQueryContext, listener: (value: T) => void, options: { emitCurrent?: boolean }) => () => void,
listener: (value: T) => void,
options: { emitCurrent?: boolean } = {},
): () => void {
let observedContext: AppServerQueryContext | null = null;
let unsubscribeQuery: (() => void) | null = null;
let firstSubscribe = true;
const subscribe = (): void => {
const context = cloneAppServerQueryContext(this.context());
if (observedContext && appServerQueryContextMatches(observedContext, context)) return;
unsubscribeQuery?.();
observedContext = context;
const observeOptions: { emitCurrent?: boolean } = {};
if (firstSubscribe) {
if (options.emitCurrent !== undefined) observeOptions.emitCurrent = options.emitCurrent;
} else {
observeOptions.emitCurrent = true;
}
unsubscribeQuery = observe(
context,
(value) => {
if (appServerQueryContextMatches(this.context(), context)) listener(value);
},
observeOptions,
);
firstSubscribe = false;
};
subscribe();
this.contextChangeListeners.add(subscribe);
return () => {
this.contextChangeListeners.delete(subscribe);
unsubscribeQuery?.();
};
}
}

View file

@ -1,7 +1,7 @@
import type { ModelMetadata } from "../../domain/catalog/metadata";
import { cloneRuntimeConfigSnapshot } from "../../domain/runtime/config";
import type { RateLimitSnapshot } from "../../domain/runtime/metrics";
import type { SharedServerMetadata, SharedServerMetadataResource } from "../../domain/server/metadata";
import type { SharedServerMetadata } from "../../domain/server/metadata";
import { cloneToolInventorySnapshot } from "../../domain/server/tool-inventory";
import type { Thread } from "../../domain/threads/model";
@ -13,8 +13,8 @@ export function cloneModelMetadata(models: readonly ModelMetadata[]): ModelMetad
return models.map((model) => ({
...model,
supportedReasoningEfforts: [...model.supportedReasoningEfforts],
...(model.reasoningEffortOptions ? { reasoningEffortOptions: model.reasoningEffortOptions.map((option) => ({ ...option })) } : {}),
inputModalities: [...model.inputModalities],
additionalSpeedTiers: [...model.additionalSpeedTiers],
serviceTiers: model.serviceTiers.map((tier) => ({ ...tier })),
}));
}
@ -24,8 +24,8 @@ export function cloneSharedServerMetadata(metadata: SharedServerMetadata): Share
...metadata,
runtimeConfig: metadata.runtimeConfig ? cloneRuntimeConfigSnapshot(metadata.runtimeConfig) : null,
rateLimit: metadata.rateLimit ? cloneRateLimitSnapshot(metadata.rateLimit) : null,
availableModels: cloneModelMetadata(metadata.availableModels),
availableSkills: metadata.availableSkills.map((skill) => ({ ...skill })),
availablePermissionProfiles: metadata.availablePermissionProfiles.map((profile) => ({ ...profile })),
serverDiagnostics: {
probes: { ...metadata.serverDiagnostics.probes },
mcpServers: metadata.serverDiagnostics.mcpServers.map((server) => ({ ...server })),
@ -34,40 +34,6 @@ export function cloneSharedServerMetadata(metadata: SharedServerMetadata): Share
};
}
export function cloneSharedServerMetadataResource(resource: SharedServerMetadataResource): SharedServerMetadataResource {
switch (resource.id) {
case "runtimeConfig":
return {
id: resource.id,
value: resource.value ? cloneRuntimeConfigSnapshot(resource.value) : undefined,
};
case "models":
return {
id: resource.id,
value: resource.value ? cloneModelMetadata(resource.value) : undefined,
probe: { ...resource.probe },
};
case "skills":
return {
id: resource.id,
value: resource.value?.map((skill) => ({ ...skill })),
probe: { ...resource.probe },
};
case "permissionProfiles":
return {
id: resource.id,
value: resource.value?.map((profile) => ({ ...profile })),
probe: { ...resource.probe },
};
case "rateLimits":
return {
id: resource.id,
value: resource.value ? cloneRateLimitSnapshot(resource.value) : resource.value,
probe: { ...resource.probe },
};
}
}
function cloneRateLimitSnapshot(snapshot: RateLimitSnapshot): RateLimitSnapshot {
return {
...snapshot,

View file

@ -1,31 +0,0 @@
import type { Thread } from "../../domain/threads/model";
export type ThreadListKind = "active" | "archived";
export type ThreadListMutation =
| { readonly kind: "upsert"; readonly list: ThreadListKind; readonly thread: Thread }
| { readonly kind: "remove"; readonly list: ThreadListKind; readonly threadId: string }
| {
readonly kind: "update";
readonly list: ThreadListKind;
readonly threadId: string;
readonly changes: Partial<Pick<Thread, "name" | "recencyAt">>;
}
| { readonly kind: "refresh"; readonly list: ThreadListKind };
export function applyThreadListMutation(snapshot: readonly Thread[] | null, mutation: ThreadListMutation): readonly Thread[] | null {
switch (mutation.kind) {
case "refresh":
return snapshot;
case "upsert": {
if (!snapshot) return null;
const index = snapshot.findIndex((thread) => thread.id === mutation.thread.id);
if (index < 0) return [mutation.thread, ...snapshot];
return snapshot.map((thread) => (thread.id === mutation.thread.id ? mutation.thread : thread));
}
case "remove":
return snapshot?.filter((thread) => thread.id !== mutation.threadId) ?? null;
case "update":
return snapshot?.map((thread) => (thread.id === mutation.threadId ? { ...thread, ...mutation.changes } : thread)) ?? null;
}
}

View file

@ -3,26 +3,26 @@ export interface ActiveRouteScope {
activeTurnId: string | null;
}
export interface AppServerRouteScope {
export interface MessageScope {
threadId: string | null;
turnId: string | null;
}
export function isAppServerRouteScopeInActiveRouteScope(routeScope: AppServerRouteScope, activeScope: ActiveRouteScope): boolean {
// Scope identifiers are filters only when both the app-server envelope and the active
export function isMessageScopeInActiveRouteScope(messageScope: MessageScope, activeScope: ActiveRouteScope): boolean {
// Scope identifiers are filters only when both the message and the active
// panel have one. Thread catalog and idle-thread notifications often omit
// active turn scope, so missing ids stay eligible for the active route.
if (routeScope.threadId && activeScope.activeThreadId && routeScope.threadId !== activeScope.activeThreadId) return false;
if (routeScope.turnId && activeScope.activeTurnId && routeScope.turnId !== activeScope.activeTurnId) return false;
if (messageScope.threadId && activeScope.activeThreadId && messageScope.threadId !== activeScope.activeThreadId) return false;
if (messageScope.turnId && activeScope.activeTurnId && messageScope.turnId !== activeScope.activeTurnId) return false;
return true;
}
export function isTurnScopedAppServerRouteForIdleActiveThread(routeScope: AppServerRouteScope, activeScope: ActiveRouteScope): boolean {
return activeScope.activeThreadId !== null && activeScope.activeTurnId === null && routeScope.turnId !== null;
export function isTurnScopedMessageForIdleActiveThread(messageScope: MessageScope, activeScope: ActiveRouteScope): boolean {
return activeScope.activeThreadId !== null && activeScope.activeTurnId === null && messageScope.turnId !== null;
}
export function fallbackAppServerRouteScope(envelope: { params?: unknown }): AppServerRouteScope {
const rawParams = envelope.params;
export function fallbackMessageScope(message: { params?: unknown }): MessageScope {
const rawParams = message.params;
const params =
rawParams !== null && typeof rawParams === "object" && !Array.isArray(rawParams) ? (rawParams as Record<string, unknown>) : null;
return {

View file

@ -17,10 +17,10 @@ import {
} from "../protocol/server-requests";
import {
type ActiveRouteScope,
type AppServerRouteScope,
fallbackAppServerRouteScope,
isAppServerRouteScopeInActiveRouteScope,
isTurnScopedAppServerRouteForIdleActiveThread,
fallbackMessageScope,
isMessageScopeInActiveRouteScope,
isTurnScopedMessageForIdleActiveThread,
type MessageScope,
} from "./scope";
export type ServerRequestRoute =
@ -33,43 +33,50 @@ export type ServerRequestRoute =
| { kind: "inactive"; request: ServerRequest };
type ServerRequestMethod = ServerRequest["method"];
type ServerRequestDescriptorByMethod = {
[Method in ServerRequestMethod]: {
routeKind: Exclude<ServerRequestRoute["kind"], "inactive" | "unknown">;
scope: (request: Extract<ServerRequest, { method: Method }>) => AppServerRouteScope;
};
type ServerRequestRouteKindByMethod = Record<ServerRequestMethod, Exclude<ServerRequestRoute["kind"], "inactive" | "unknown">>;
type ServerRequestScopeExtractors = {
[Method in ServerRequestMethod]: (request: Extract<ServerRequest, { method: Method }>) => MessageScope;
};
const SERVER_REQUEST_DESCRIPTORS = {
"item/commandExecution/requestApproval": { routeKind: "approval", scope: threadTurnRequestScope },
"item/fileChange/requestApproval": { routeKind: "approval", scope: threadTurnRequestScope },
"item/permissions/requestApproval": { routeKind: "approval", scope: threadTurnRequestScope },
"item/tool/requestUserInput": { routeKind: "userInput", scope: threadTurnRequestScope },
"mcpServer/elicitation/request": { routeKind: "mcpElicitation", scope: threadTurnRequestScope },
"item/tool/call": { routeKind: "unsupported", scope: threadTurnRequestScope },
"account/chatgptAuthTokens/refresh": { routeKind: "unsupported", scope: unscopedRequestScope },
"attestation/generate": { routeKind: "unsupported", scope: unscopedRequestScope },
"currentTime/read": { routeKind: "currentTime", scope: threadOnlyRequestScope },
applyPatchApproval: { routeKind: "unsupported", scope: unscopedRequestScope },
execCommandApproval: { routeKind: "unsupported", scope: unscopedRequestScope },
} satisfies ServerRequestDescriptorByMethod;
const SERVER_REQUEST_SCOPE_EXTRACTORS: ServerRequestScopeExtractors = {
"item/commandExecution/requestApproval": threadTurnRequestScope,
"item/fileChange/requestApproval": threadTurnRequestScope,
"item/tool/requestUserInput": threadTurnRequestScope,
"mcpServer/elicitation/request": threadTurnRequestScope,
"item/permissions/requestApproval": threadTurnRequestScope,
"item/tool/call": threadTurnRequestScope,
"account/chatgptAuthTokens/refresh": unscopedRequestScope,
"attestation/generate": unscopedRequestScope,
"currentTime/read": threadOnlyRequestScope,
applyPatchApproval: unscopedRequestScope,
execCommandApproval: unscopedRequestScope,
};
interface ServerRequestDescriptor {
readonly routeKind: Exclude<ServerRequestRoute["kind"], "inactive" | "unknown">;
readonly scope: (request: ServerRequest) => AppServerRouteScope;
}
const SERVER_REQUEST_ROUTE_KIND_BY_METHOD: ServerRequestRouteKindByMethod = {
"item/commandExecution/requestApproval": "approval",
"item/fileChange/requestApproval": "approval",
"item/permissions/requestApproval": "approval",
"item/tool/requestUserInput": "userInput",
"mcpServer/elicitation/request": "mcpElicitation",
"item/tool/call": "unsupported",
"account/chatgptAuthTokens/refresh": "unsupported",
"attestation/generate": "unsupported",
"currentTime/read": "currentTime",
applyPatchApproval: "unsupported",
execCommandApproval: "unsupported",
};
export function routeServerRequest(request: ServerRequest, scope: ActiveRouteScope): ServerRequestRoute {
const routeScope = serverRequestScope(request);
const messageScope = serverRequestScope(request);
if (!isServerRequest(request)) {
if (!isAppServerRouteScopeInActiveRouteScope(routeScope, scope)) return { kind: "inactive", request };
if (isTurnScopedAppServerRouteForIdleActiveThread(routeScope, scope)) return { kind: "inactive", request };
if (!isMessageScopeInActiveRouteScope(messageScope, scope)) return { kind: "inactive", request };
if (isTurnScopedMessageForIdleActiveThread(messageScope, scope)) return { kind: "inactive", request };
return { kind: "unknown", request };
}
if (!isAppServerRouteScopeInActiveRouteScope(routeScope, scope)) return { kind: "inactive", request };
if (isTurnScopedAppServerRouteForIdleActiveThread(routeScope, scope)) return { kind: "inactive", request };
if (!isMessageScopeInActiveRouteScope(messageScope, scope)) return { kind: "inactive", request };
if (isTurnScopedMessageForIdleActiveThread(messageScope, scope)) return { kind: "inactive", request };
switch (serverRequestDescriptor(request).routeKind) {
switch (SERVER_REQUEST_ROUTE_KIND_BY_METHOD[request.method]) {
case "approval": {
const approval = appServerApprovalRequest(request);
if (approval) return { kind: "approval", request, approval };
@ -111,27 +118,24 @@ export function serverRequestCurrentTimeResponse(currentTimeMs: number): unknown
return { currentTimeAt: Math.floor(currentTimeMs / 1000) };
}
function serverRequestScope(request: ServerRequest): AppServerRouteScope {
if (!isServerRequest(request)) return fallbackAppServerRouteScope(request);
return serverRequestDescriptor(request).scope(request);
function serverRequestScope(request: ServerRequest): MessageScope {
if (!isServerRequest(request)) return fallbackMessageScope(request);
const extractor = SERVER_REQUEST_SCOPE_EXTRACTORS[request.method] as (request: ServerRequest) => MessageScope;
return extractor(request);
}
function isServerRequest(request: ServerRequest): boolean {
return Object.hasOwn(SERVER_REQUEST_DESCRIPTORS, request.method);
return Object.hasOwn(SERVER_REQUEST_SCOPE_EXTRACTORS, request.method);
}
function serverRequestDescriptor(request: ServerRequest): ServerRequestDescriptor {
return SERVER_REQUEST_DESCRIPTORS[request.method] as ServerRequestDescriptor;
}
function threadTurnRequestScope(request: { params: { threadId: string; turnId: string | null } }): AppServerRouteScope {
function threadTurnRequestScope(request: { params: { threadId: string; turnId: string | null } }): MessageScope {
return { threadId: request.params.threadId, turnId: request.params.turnId };
}
function threadOnlyRequestScope(request: { params: { threadId: string | null } }): AppServerRouteScope {
function threadOnlyRequestScope(request: { params: { threadId: string | null } }): MessageScope {
return { threadId: request.params.threadId, turnId: null };
}
function unscopedRequestScope(): AppServerRouteScope {
function unscopedRequestScope(): MessageScope {
return { threadId: null, turnId: null };
}

View file

@ -1,6 +1,4 @@
import type { HookItem, ModelMetadata, SkillMetadata } from "../../domain/catalog/metadata";
import type { RuntimePermissionProfileSummary } from "../../domain/runtime/permissions";
import type { ClientResponseByMethod } from "../connection/client";
import type { ClientRequestParams } from "../connection/rpc-messages";
import {
type AppServerHookOperation,
@ -22,47 +20,11 @@ export interface ModelMetadataClient {
}
export async function listModelMetadata(client: ModelMetadataClient, options: { includeHidden?: boolean } = {}): Promise<ModelMetadata[]> {
const models: ClientResponseByMethod["model/list"]["data"] = [];
const seenCursors = new Set<string>();
let cursor: string | null = null;
for (;;) {
const response: ClientResponseByMethod["model/list"] = await client.request("model/list", {
includeHidden: options.includeHidden ?? false,
cursor,
limit: 100,
});
models.push(...response.data);
cursor = response.nextCursor ?? null;
if (!cursor) break;
if (seenCursors.has(cursor)) throw new Error("Codex app-server returned a repeated model list cursor.");
seenCursors.add(cursor);
}
return modelMetadataFromCatalogModels(models);
}
export async function listPermissionProfiles(client: AppServerRequestClient, cwd: string): Promise<RuntimePermissionProfileSummary[]> {
const profiles: RuntimePermissionProfileSummary[] = [];
const seenCursors = new Set<string>();
let cursor: string | null = null;
for (;;) {
const response: ClientResponseByMethod["permissionProfile/list"] = await client.request("permissionProfile/list", {
cwd,
cursor,
limit: 100,
});
profiles.push(...response.data.map((profile) => ({ ...profile })));
cursor = response.nextCursor ?? null;
if (!cursor) break;
if (seenCursors.has(cursor)) {
throw new Error("Codex app-server returned a repeated permission profile list cursor.");
}
seenCursors.add(cursor);
}
return profiles;
const response = await client.request("model/list", {
includeHidden: options.includeHidden ?? false,
limit: 100,
});
return modelMetadataFromCatalogModels(response.data);
}
export async function listSkillCatalog(
@ -95,15 +57,15 @@ export async function listHookCatalog(client: AppServerRequestClient, cwd: strin
export async function trustHookItem(client: AppServerRequestClient, hook: HookItem): Promise<void> {
const operation = appServerHookOperationFromHookItem(hook);
await writeHookState(client, operation.key, {
enabled: true,
trusted_hash: operation.currentHash,
});
}
export async function setHookItemEnabled(client: AppServerRequestClient, hook: HookItem, enabled: boolean): Promise<void> {
if (hook.isManaged) throw new Error("Managed hooks cannot be enabled or disabled here.");
const operation = appServerHookOperationFromHookItem(hook);
if (operation.trustStatus !== "trusted") throw new Error("Trust the current hook definition before enabling it.");
await writeHookState(client, operation.key, { enabled });
const state: HookConfigState = operation.trustStatus === "trusted" ? { enabled, trusted_hash: operation.currentHash } : { enabled };
await writeHookState(client, operation.key, state);
}
type HookConfigState = Record<string, string | boolean | null>;

View file

@ -1,12 +1,10 @@
import { listenAbortSignal } from "../../shared/runtime/abort-signal";
import { AppServerClient, type AppServerClientHandlers } from "../connection/client";
import type { AppServerClientRequestPolicy } from "../connection/client-access";
import { codexPanelAppServerInitializeParams } from "../connection/client-profile";
import type { ServerNotification } from "../connection/rpc-messages";
import { lastAgentMessageTextFromTurnRecord, type TurnItem, type TurnRecord } from "../protocol/turn";
import type { ModelMetadataClient } from "./catalog";
import type { AppServerRequestClient } from "./request-client";
import { type RuntimeOverrideSettings, resolvedRuntimeOverrideForClient } from "./runtime-overrides";
import { deleteThread, startEphemeralThread } from "./threads";
import { type AppServerStartStructuredTurnOptions, startStructuredTurn } from "./turns";
@ -38,7 +36,7 @@ export interface EphemeralStructuredTurnClient {
type EphemeralStructuredTurnRuntimeCapableClient = EphemeralStructuredTurnClient & ModelMetadataClient;
type EphemeralStructuredTurnClientFactory = (
export type EphemeralStructuredTurnClientFactory = (
codexPath: string,
cwd: string,
handlers: AppServerClientHandlers,
@ -57,31 +55,17 @@ export interface RunEphemeralStructuredTurnOptions {
timedOutMessage: string;
abortMessage?: string;
runtime?: StructuredTurnRuntimeOverride | undefined;
runtimeSettings?: RuntimeOverrideSettings | undefined;
resolveRuntime?: ((client: ModelMetadataClient) => Promise<StructuredTurnRuntimeOverride>) | undefined;
signal?: AbortSignal | undefined;
onProgress?: (event: StructuredTurnProgressEvent) => void;
}
export type EphemeralStructuredTurnRunner = (options: RunEphemeralStructuredTurnOptions) => Promise<TurnRecord>;
export interface EphemeralStructuredTurnDependencies {
clientFactory?: EphemeralStructuredTurnClientFactory | undefined;
timers?: EphemeralStructuredTurnTimers | undefined;
clientLifecycle?:
| {
created(client: EphemeralStructuredTurnClient): void;
disposed(client: EphemeralStructuredTurnClient): void;
}
| undefined;
}
export async function runEphemeralStructuredTurn(
options: RunEphemeralStructuredTurnOptions,
dependencies: EphemeralStructuredTurnDependencies = {},
): Promise<TurnRecord> {
export async function runEphemeralStructuredTurn(options: RunEphemeralStructuredTurnOptions): Promise<TurnRecord> {
throwIfAborted(options.signal, options.abortMessage);
let state = createEphemeralStructuredTurnState();
const timers = dependencies.timers ?? DEFAULT_EPHEMERAL_STRUCTURED_TURN_TIMERS;
const timers = options.timers ?? DEFAULT_EPHEMERAL_STRUCTURED_TURN_TIMERS;
let handleNotification: (notification: ServerNotification) => void = () => undefined;
let operationAbortError: Error | null = null;
const operationAbort = new AbortController();
@ -112,15 +96,7 @@ export async function runEphemeralStructuredTurn(
};
});
const clientFactory =
dependencies.clientFactory ??
((codexPath, cwd, handlers) =>
new AppServerClient({
codexPath,
cwd,
handlers,
initializeParams: codexPanelAppServerInitializeParams(),
}));
const clientFactory = options.clientFactory ?? ((codexPath, cwd, handlers) => new AppServerClient(codexPath, cwd, handlers));
let threadId: string | null = null;
const client = clientFactory(options.codexPath, options.cwd, {
onNotification: (notification) => {
@ -137,13 +113,10 @@ export async function runEphemeralStructuredTurn(
abortOperation(new Error(options.exitedMessage));
},
});
dependencies.clientLifecycle?.created(client);
try {
await runAbortable(client.connect());
const runtime = options.runtimeSettings
? await runAbortable(resolvedRuntimeOverrideForClient(client, options.runtimeSettings))
: (options.runtime ?? {});
const runtime = options.resolveRuntime ? await runAbortable(options.resolveRuntime(client)) : (options.runtime ?? {});
const threadResponse = await runAbortable(
startEphemeralThread(client, {
cwd: options.cwd,
@ -182,20 +155,13 @@ export async function runEphemeralStructuredTurn(
} finally {
state = completeEphemeralStructuredTurnState(state);
timers.clearTimeout(timeout);
try {
await deleteEphemeralStructuredTurnThread(client, threadId);
} finally {
client.disconnect();
dependencies.clientLifecycle?.disposed(client);
}
await deleteEphemeralStructuredTurnThread(client, threadId);
client.disconnect();
}
}
export async function runEphemeralStructuredTurnForLastAgentText(
options: RunEphemeralStructuredTurnOptions,
runner: EphemeralStructuredTurnRunner = runEphemeralStructuredTurn,
): Promise<string | null> {
const turn = await runner(options);
export async function runEphemeralStructuredTurnForLastAgentText(options: RunEphemeralStructuredTurnOptions): Promise<string | null> {
const turn = await runEphemeralStructuredTurn(options);
return lastAgentMessageTextFromTurnRecord(turn);
}

View file

@ -3,7 +3,7 @@ import type { ThreadTokenUsage, TokenUsageBreakdown } from "../../domain/runtime
const ROLLOUT_TOKEN_USAGE_READ_TIMEOUT_MS = 2_000;
const ROLLOUT_TOKEN_USAGE_MAX_BASE64_BYTES = 12 * 1024 * 1024;
export type RolloutReadFileBase64 = (path: string, options: { timeoutMs: number }) => Promise<string | null>;
export type RolloutReadFileBase64 = (path: string, options: { timeoutMs: number }) => Promise<string>;
export async function recoverRolloutTokenUsage(
path: string | null,
@ -11,13 +11,12 @@ export async function recoverRolloutTokenUsage(
): Promise<ThreadTokenUsage | null> {
if (!path || !isAbsolutePath(path)) return null;
let dataBase64: string | null;
let dataBase64: string;
try {
dataBase64 = await readFileBase64(path, { timeoutMs: ROLLOUT_TOKEN_USAGE_READ_TIMEOUT_MS });
} catch {
return null;
}
if (dataBase64 === null) return null;
if (dataBase64.length > ROLLOUT_TOKEN_USAGE_MAX_BASE64_BYTES) return null;
const text = decodeBase64Text(dataBase64);

View file

@ -5,12 +5,13 @@ import {
threadTitleFromGeneratedText,
threadTitlePrompt,
} from "../../domain/threads/title-generation-model";
import { turnTranscriptAssistantTextFromTurnRecord } from "../protocol/turn";
import { conversationAssistantTextFromTurnRecord } from "../protocol/turn";
import {
type EphemeralStructuredTurnRunner,
type EphemeralStructuredTurnClientFactory,
runEphemeralStructuredTurn,
type StructuredTurnOutputSchema,
} from "./ephemeral-structured-turn";
import { resolvedRuntimeOverrideForClient } from "./runtime-overrides";
const THREAD_TITLE_SERVICE_NAME = "codex-panel-naming";
const THREAD_TITLE_TIMEOUT_MS = 60_000;
@ -40,20 +41,14 @@ export interface ThreadTitleRuntimeSettings {
threadNamingEffort: ReasoningEffort | null;
}
export interface GenerateThreadTitleWithCodexOptions {
runner?: EphemeralStructuredTurnRunner;
signal?: AbortSignal;
}
export async function generateThreadTitleWithCodex(
codexPath: string,
cwd: string,
context: ThreadTitleContext,
runtimeSettings: ThreadTitleRuntimeSettings,
options: GenerateThreadTitleWithCodexOptions = {},
clientFactory?: EphemeralStructuredTurnClientFactory,
): Promise<string | null> {
const runner = options.runner ?? runEphemeralStructuredTurn;
const turn = await runner({
const turn = await runEphemeralStructuredTurn({
codexPath,
cwd,
serviceName: THREAD_TITLE_SERVICE_NAME,
@ -64,10 +59,10 @@ export async function generateThreadTitleWithCodex(
serverRequests: { kind: "reject", message: "Thread title generation does not handle server requests." },
exitedMessage: "Codex title generation app-server exited.",
timedOutMessage: "Timed out while generating a Codex thread title.",
abortMessage: "Thread title generation cancelled.",
runtimeSettings: { model: runtimeSettings.threadNamingModel, effort: runtimeSettings.threadNamingEffort },
signal: options.signal,
resolveRuntime: (client) =>
resolvedRuntimeOverrideForClient(client, { model: runtimeSettings.threadNamingModel, effort: runtimeSettings.threadNamingEffort }),
clientFactory,
});
const response = turnTranscriptAssistantTextFromTurnRecord(turn);
const response = conversationAssistantTextFromTurnRecord(turn);
return response ? threadTitleFromGeneratedText(response) : null;
}

View file

@ -6,26 +6,32 @@ import type { RuntimeServiceTierRequest, RuntimeSettingsPatch } from "../../doma
import type { ThreadActivationSnapshot } from "../../domain/threads/activation";
import type { ArchiveThreadInput } from "../../domain/threads/archive-markdown";
import type { ThreadGoal, ThreadGoalUpdate } from "../../domain/threads/goal";
import type { HistoricalTurn } from "../../domain/threads/history";
import type { Thread } from "../../domain/threads/model";
import { REFERENCED_THREAD_TURN_LIMIT } from "../../domain/threads/reference";
import type { TurnTranscriptSummary } from "../../domain/threads/transcript";
import type { ThreadConversationSummary } from "../../domain/threads/transcript";
import type { ClientResponseByMethod } from "../connection/client";
import type { ClientRequestParams } from "../connection/rpc-messages";
import { appServerSideChatBoundaryItem, sideChatDeveloperInstructions } from "../protocol/side-chat";
import { type ThreadRecord, threadFromThreadRecord, threadsFromThreadRecords } from "../protocol/thread";
import { appServerThreadGoalUpdate, appServerThreadGoalUserHistoryItem, threadGoalFromAppServerGoal } from "../protocol/thread-goal";
import { appServerRuntimeSettingsPatch } from "../protocol/thread-settings";
import {
chronologicalTurnTranscriptSummariesFromTurnRecords,
completedTurnTranscriptSummariesFromTurnRecords,
chronologicalConversationSummariesFromTurnRecords,
completedConversationSummariesFromTurnRecords,
transcriptEntriesFromTurnRecords,
} from "../protocol/turn";
import type { AppServerRequestClient } from "./request-client";
export type ThreadTurnSortDirection = "asc" | "desc";
const THREAD_LIST_PAGE_LIMIT = 100;
interface TurnTranscriptSummaryPage {
summaries: TurnTranscriptSummary[];
export type ThreadTurnSortDirection = "asc" | "desc";
export type ThreadConversationSummaryClient = AppServerRequestClient;
export type ThreadForkClient = AppServerRequestClient;
export type ThreadRollbackClient = AppServerRequestClient;
export type ThreadCompactionClient = AppServerRequestClient;
interface ThreadConversationSummaryPage {
summaries: ThreadConversationSummary[];
nextCursor: string | null;
}
@ -42,7 +48,6 @@ interface ThreadActivationResponse extends Partial<RuntimePermissionState> {
export interface AppServerStartThreadOptions {
cwd: string;
serviceTier?: RuntimeServiceTierRequest;
permissions?: RuntimeSettingsPatch["permissions"];
}
export interface AppServerStartEphemeralThreadOptions {
@ -51,28 +56,21 @@ export interface AppServerStartEphemeralThreadOptions {
developerInstructions: string;
}
export interface AppServerThreadListOptions {
interface AppServerThreadListOptions {
archived?: boolean;
cursor?: string | null;
limit?: number | null;
}
export interface ThreadPage {
readonly threads: readonly Thread[];
readonly nextCursor: string | null;
readonly fetchedSize: number;
}
export function startThread(
client: AppServerRequestClient,
options: AppServerStartThreadOptions,
): Promise<ClientResponseByMethod["thread/start"]> {
const { cwd, serviceTier, permissions } = options;
const { cwd, serviceTier } = options;
return client.request("thread/start", {
cwd,
serviceName: "codex-panel",
...(serviceTier !== undefined ? { serviceTier } : {}),
...(permissions !== undefined ? { permissions } : {}),
});
}
@ -88,6 +86,7 @@ export function startEphemeralThread(
ephemeral: true,
sandbox: "read-only",
approvalPolicy: "never",
multiAgentMode: "none",
environments: [],
});
}
@ -105,25 +104,21 @@ export function resumeThread(
});
}
export async function listThreads(
client: AppServerRequestClient,
cwd: string,
options: { archived?: boolean; signal?: AbortSignal } = {},
): Promise<Thread[]> {
export async function listThreads(client: AppServerRequestClient, cwd: string, options: { archived?: boolean } = {}): Promise<Thread[]> {
const archived = options.archived ?? false;
const threads: Thread[] = [];
const records: ThreadRecord[] = [];
const seenCursors = new Set<string>();
let cursor: string | null = null;
for (;;) {
options.signal?.throwIfAborted();
const page = await readThreadPage(client, cwd, {
const response = await listThreadPage(client, cwd, {
archived,
cursor,
limit: THREAD_LIST_PAGE_LIMIT,
});
threads.push(...page.threads);
records.push(...response.data);
cursor = page.nextCursor;
cursor = response.nextCursor ?? null;
if (!cursor) break;
if (seenCursors.has(cursor)) {
throw new Error("Codex app-server returned a repeated thread list cursor.");
@ -131,24 +126,7 @@ export async function listThreads(
seenCursors.add(cursor);
}
return threads;
}
export async function readThreadPage(
client: AppServerRequestClient,
cwd: string,
options: AppServerThreadListOptions = {},
): Promise<ThreadPage> {
const archived = options.archived ?? false;
const page = await readThreadRecordPage(client, cwd, {
...options,
archived,
});
return {
threads: threadsFromThreadRecords(page.data, { archived }),
nextCursor: page.nextCursor ?? null,
fetchedSize: page.data.length,
};
return threadsFromThreadRecords(records, { archived });
}
export function threadFromAppServerRecord(thread: ThreadRecord, options: { archived?: boolean } = {}): Thread {
@ -163,136 +141,65 @@ export async function readThreadForArchiveExport(client: AppServerRequestClient,
};
}
export async function readCompletedTurnTranscriptSummariesPage(
client: AppServerRequestClient,
export async function readCompletedConversationSummariesPage(
client: ThreadConversationSummaryClient,
threadId: string,
cursor: string | null,
limit: number,
sortDirection: ThreadTurnSortDirection = "asc",
): Promise<TurnTranscriptSummaryPage> {
): Promise<ThreadConversationSummaryPage> {
const response = await listThreadTurns(client, threadId, cursor, limit, sortDirection);
return {
summaries: completedTurnTranscriptSummariesFromTurnRecords(response.data),
summaries: completedConversationSummariesFromTurnRecords(response.data),
nextCursor: response.nextCursor,
};
}
export async function readReferencedThreadTurnTranscriptSummaries(
client: AppServerRequestClient,
export async function readReferencedThreadConversationSummaries(
client: ThreadConversationSummaryClient,
threadId: string,
limit = REFERENCED_THREAD_TURN_LIMIT,
): Promise<TurnTranscriptSummary[]> {
): Promise<ThreadConversationSummary[]> {
const response = await listThreadTurns(client, threadId, null, limit);
return chronologicalTurnTranscriptSummariesFromTurnRecords(response.data);
return chronologicalConversationSummariesFromTurnRecords(response.data);
}
type ThreadForkPosition =
| { readonly kind: "through-turn"; readonly turnId: string }
| { readonly kind: "before-turn"; readonly turnId: string };
export interface ThreadRollbackSnapshot {
thread: Thread;
cwd: string;
turns: readonly HistoricalTurn[];
}
interface AppServerForkThreadOptions {
readonly position?: ThreadForkPosition;
readonly deferGoalContinuation?: boolean;
readonly runtime?: {
readonly model?: string;
readonly reasoningEffort?: string | null;
readonly serviceTier?: ServiceTier | null;
readonly approvalPolicy?: RuntimePermissionState["approvalPolicy"];
readonly approvalsReviewer?: ApprovalsReviewer;
readonly permissions?: string;
readonly sandboxPolicy?: RuntimePermissionState["sandboxPolicy"];
interface ThreadRollbackResult {
readonly thread: ThreadRecord & {
readonly cwd: string;
readonly turns: readonly HistoricalTurn[];
};
}
export async function forkThread(
client: AppServerRequestClient,
threadId: string,
cwd: string,
options: AppServerForkThreadOptions = {},
): Promise<Thread> {
const position = options.position;
const runtime = options.runtime;
const permissions = runtime?.permissions;
const sandbox = permissions === undefined ? appServerSandboxMode(runtime?.sandboxPolicy) : undefined;
function threadRollbackSnapshotFromAppServerResponse(response: ThreadRollbackResult): ThreadRollbackSnapshot {
return {
thread: threadFromThreadRecord(response.thread),
cwd: response.thread.cwd,
turns: response.thread.turns,
};
}
export async function rollbackThread(client: ThreadRollbackClient, threadId: string, numTurns?: number): Promise<ThreadRollbackSnapshot> {
const response = await client.request("thread/rollback", { threadId, numTurns: numTurns ?? 1 });
return threadRollbackSnapshotFromAppServerResponse(response);
}
export async function forkThread(client: ThreadForkClient, threadId: string, cwd: string): Promise<Thread> {
const response = await client.request("thread/fork", {
threadId,
cwd,
excludeTurns: true,
...(position?.kind === "through-turn" ? { lastTurnId: position.turnId } : {}),
...(position?.kind === "before-turn" ? { beforeTurnId: position.turnId } : {}),
...(options.deferGoalContinuation ? { deferGoalContinuation: true } : {}),
...(runtime?.model !== undefined ? { model: runtime.model } : {}),
...(runtime?.serviceTier !== undefined ? { serviceTier: runtime.serviceTier } : {}),
...(runtime?.approvalPolicy !== undefined && runtime.approvalPolicy !== null ? { approvalPolicy: runtime.approvalPolicy } : {}),
...(runtime?.approvalsReviewer !== undefined ? { approvalsReviewer: runtime.approvalsReviewer } : {}),
...(permissions !== undefined ? { permissions } : {}),
...(sandbox !== undefined ? { sandbox } : {}),
...(runtime?.reasoningEffort !== undefined ? { config: { model_reasoning_effort: runtime.reasoningEffort } } : {}),
});
return threadFromThreadRecord(response.thread);
}
function appServerSandboxMode(
policy: RuntimePermissionState["sandboxPolicy"] | undefined,
): "read-only" | "workspace-write" | "danger-full-access" | undefined {
if (!policy || policy.type === "externalSandbox") return undefined;
if (policy.type === "dangerFullAccess") return "danger-full-access";
if (policy.type === "readOnly") return "read-only";
return "workspace-write";
}
export interface EphemeralThreadForkSnapshot {
readonly activation: ThreadActivationSnapshot;
readonly sourceThreadId: string;
}
export class EphemeralThreadCleanupRequiredError extends Error {
readonly cleanupError: unknown;
readonly threadId: string;
constructor(threadId: string, cause: unknown, cleanupError: unknown) {
super(`Could not prepare or unsubscribe side chat ${threadId}.`, { cause });
this.name = "EphemeralThreadCleanupRequiredError";
this.threadId = threadId;
this.cleanupError = cleanupError;
}
}
export async function forkEphemeralThread(
client: AppServerRequestClient,
sourceThreadId: string,
vaultPath: string,
): Promise<EphemeralThreadForkSnapshot> {
const config = await client.request("config/read", { cwd: vaultPath });
const response = await client.request("thread/fork", {
threadId: sourceThreadId,
cwd: vaultPath,
ephemeral: true,
sandbox: "read-only",
approvalPolicy: "never",
developerInstructions: sideChatDeveloperInstructions(config.config.developer_instructions),
excludeTurns: true,
});
try {
await client.request("thread/inject_items", {
threadId: response.thread.id,
items: [appServerSideChatBoundaryItem()],
});
} catch (error) {
try {
await unsubscribeThread(client, response.thread.id, { timeoutMs: 5_000 });
} catch (cleanupError) {
throw new EphemeralThreadCleanupRequiredError(response.thread.id, error, cleanupError);
}
throw error;
}
return {
activation: threadActivationSnapshotFromAppServerResponse(response),
sourceThreadId,
};
}
export async function compactThread(client: AppServerRequestClient, threadId: string): Promise<void> {
export async function compactThread(client: ThreadCompactionClient, threadId: string): Promise<void> {
await client.request("thread/compact/start", { threadId });
}
@ -304,14 +211,6 @@ export async function deleteThread(client: AppServerRequestClient, threadId: str
await client.request("thread/delete", { threadId }, options);
}
export async function unsubscribeThread(
client: AppServerRequestClient,
threadId: string,
options: { timeoutMs?: number } = {},
): Promise<void> {
await client.request("thread/unsubscribe", { threadId }, options);
}
export async function restoreArchivedThread(client: AppServerRequestClient, threadId: string): Promise<Thread> {
const response = await client.request("thread/unarchive", { threadId });
return threadFromThreadRecord(response.thread);
@ -325,9 +224,7 @@ export function threadActivationSnapshotFromAppServerResponse(response: ThreadAc
});
return {
thread: threadFromThreadRecord(response.thread),
approvalPolicyKnown: "approvalPolicy" in response,
sandboxPolicyKnown: "sandbox" in response || "sandboxPolicy" in response,
permissionProfileKnown: "activePermissionProfile" in response,
cwd: response.cwd,
model: response.model,
reasoningEffort: normalizeReasoningEffort(response.reasoningEffort),
serviceTier: parseServiceTier(response.serviceTier),
@ -387,7 +284,7 @@ export function listThreadTurns(
});
}
function readThreadRecordPage(client: AppServerRequestClient, cwd: string, options: AppServerThreadListOptions) {
function listThreadPage(client: AppServerRequestClient, cwd: string, options: AppServerThreadListOptions) {
return client.request("thread/list", {
cwd,
...(options.cursor ? { cursor: options.cursor } : {}),

View file

@ -1,17 +1,11 @@
import type { SkillMetadata } from "../../domain/catalog/metadata";
import {
type DiagnosticProbeResult,
diagnosticProbeError,
diagnosticProbeOk,
shortDiagnosticErrorMessage,
} from "../../domain/server/diagnostics";
import { type DiagnosticProbeResult, diagnosticProbeError, diagnosticProbeOk } from "../../domain/server/diagnostics";
import {
type McpServerDiagnostic,
type McpServerStatusSummary,
mcpServerStatusSummariesFromStatuses,
} from "../../domain/server/mcp-status";
import type { ToolInventoryMarketplaceError, ToolInventoryPlugin, ToolInventorySnapshot } from "../../domain/server/tool-inventory";
import type { ClientResponseByMethod } from "../connection/client";
import { toolInventoryPluginsFromInstalledResponse } from "../protocol/tool-inventory";
import { listSkillCatalog } from "./catalog";
import type { AppServerRequestClient } from "./request-client";
@ -98,7 +92,7 @@ async function readPlugins(
return {
items: null,
marketplaceErrors: [],
error: shortDiagnosticErrorMessage(error),
error: shortErrorMessage(error),
probe: diagnosticProbeError("plugins", error, checkedAt),
};
}
@ -110,22 +104,12 @@ async function readMcpServers(
checkedAt: number,
): Promise<{ items: McpServerStatusSummary[] | null; error: string | null; probe: DiagnosticProbeResult }> {
try {
const servers: McpServerStatusSummary[] = [];
const seenCursors = new Set<string>();
let cursor: string | null = null;
for (;;) {
const response: ClientResponseByMethod["mcpServerStatus/list"] = await client.request("mcpServerStatus/list", {
detail: "toolsAndAuthOnly",
cursor,
limit: 100,
...(threadId ? { threadId } : {}),
});
servers.push(...mcpServerStatusSummariesFromStatuses(response.data));
cursor = response.nextCursor ?? null;
if (!cursor) break;
if (seenCursors.has(cursor)) throw new Error("Codex app-server returned a repeated MCP server status list cursor.");
seenCursors.add(cursor);
}
const response = await client.request("mcpServerStatus/list", {
detail: "toolsAndAuthOnly",
limit: 100,
...(threadId ? { threadId } : {}),
});
const servers = mcpServerStatusSummariesFromStatuses(response.data);
return {
items: servers,
error: null,
@ -134,7 +118,7 @@ async function readMcpServers(
} catch (error) {
return {
items: null,
error: shortDiagnosticErrorMessage(error),
error: shortErrorMessage(error),
probe: diagnosticProbeError("mcpServers", error, checkedAt),
};
}
@ -158,6 +142,12 @@ async function readSkills(
probe: diagnosticProbeOk("skills", `${String(catalog.totalCount)} skills`, checkedAt),
};
} catch (error) {
return { items: null, error: shortDiagnosticErrorMessage(error), probe: diagnosticProbeError("skills", error, checkedAt) };
return { items: null, error: shortErrorMessage(error), probe: diagnosticProbeError("skills", error, checkedAt) };
}
}
function shortErrorMessage(error: unknown, maxLength = 160): string {
const message = error instanceof Error ? error.message : String(error);
const compact = message.replace(/\s+/g, " ").trim() || "Codex app-server request failed.";
return compact.length > maxLength ? `${compact.slice(0, maxLength - 3)}...` : compact;
}

View file

@ -1,7 +1,7 @@
import type { CodexInput } from "../../domain/chat/input";
import type { ClientResponseByMethod } from "../connection/client";
import type { ClientRequestParams } from "../connection/rpc-messages";
import { appServerTurnInputFromCodexInput, toAppServerUserInput } from "../protocol/request-input";
import { additionalContextFromCodexInput, toAppServerUserInput } from "../protocol/request-input";
import type { AppServerRequestClient } from "./request-client";
type AppServerTurnRuntimeOverrides = Partial<AppServerTurnRuntimeParams>;
@ -32,14 +32,14 @@ export function startTurn(
options: AppServerStartTurnOptions,
): Promise<ClientResponseByMethod["turn/start"]> {
const { threadId, cwd, input, clientUserMessageId, runtime } = options;
const prepared = toTurnInput(input, contextSubmissionId(clientUserMessageId, "user"));
const additionalContext = toAdditionalContext(input);
const params: ClientRequestParams<"turn/start"> = {
threadId,
cwd,
...(clientUserMessageId !== undefined ? { clientUserMessageId } : {}),
...(prepared.additionalContext !== undefined ? { additionalContext: prepared.additionalContext } : {}),
...(additionalContext !== undefined ? { additionalContext } : {}),
...appServerTurnRuntimeParams(runtime),
input: prepared.input,
input: toUserInput(input),
};
return client.request("turn/start", params);
}
@ -72,13 +72,13 @@ export function steerTurn(
input: string | CodexInput,
clientUserMessageId?: string | null,
): Promise<unknown> {
const prepared = toTurnInput(input, contextSubmissionId(clientUserMessageId, "steer"));
const additionalContext = toAdditionalContext(input);
return client.request("turn/steer", {
threadId,
expectedTurnId,
input: prepared.input,
input: toUserInput(input),
...(clientUserMessageId !== undefined ? { clientUserMessageId } : {}),
...(prepared.additionalContext !== undefined ? { additionalContext: prepared.additionalContext } : {}),
...(additionalContext !== undefined ? { additionalContext } : {}),
});
}
@ -86,9 +86,14 @@ export function interruptTurn(client: AppServerRequestClient, threadId: string,
return client.request("turn/interrupt", { threadId, turnId });
}
function toTurnInput(input: string | CodexInput, submissionId: string) {
if (typeof input !== "string") return appServerTurnInputFromCodexInput(input, submissionId);
return { input: toAppServerUserInput([{ type: "text", text: input }]) };
function toUserInput(input: string | CodexInput): ClientRequestParams<"turn/start">["input"] {
if (typeof input !== "string") return toAppServerUserInput(input);
return toAppServerUserInput([{ type: "text", text: input }]);
}
function toAdditionalContext(input: string | CodexInput): ClientRequestParams<"turn/start">["additionalContext"] | undefined {
if (typeof input === "string") return undefined;
return additionalContextFromCodexInput(input);
}
function appServerTurnRuntimeParams(runtime: AppServerTurnRuntimeOverrides | undefined): AppServerTurnRuntimeParams {
@ -100,11 +105,3 @@ function appServerTurnRuntimeParams(runtime: AppServerTurnRuntimeOverrides | und
if (runtime?.approvalsReviewer !== undefined) params.approvalsReviewer = runtime.approvalsReviewer;
return params;
}
let fallbackContextSubmissionSequence = 0;
function contextSubmissionId(clientUserMessageId: string | null | undefined, kind: "user" | "steer"): string {
if (clientUserMessageId) return clientUserMessageId;
fallbackContextSubmissionSequence += 1;
return `local-${kind}-${String(Date.now())}-fallback-${String(fallbackContextSubmissionSequence)}-1`;
}

View file

@ -3,11 +3,6 @@ interface ModelServiceTier {
readonly name: string;
}
interface ReasoningEffortMetadata {
readonly reasoningEffort: string;
readonly description: string;
}
export interface ModelMetadata {
readonly id: string;
readonly model: string;
@ -15,9 +10,9 @@ export interface ModelMetadata {
readonly description: string;
readonly hidden: boolean;
readonly supportedReasoningEfforts: readonly string[];
readonly reasoningEffortOptions?: readonly ReasoningEffortMetadata[];
readonly defaultReasoningEffort: string | null;
readonly inputModalities: readonly string[];
readonly additionalSpeedTiers: readonly string[];
readonly serviceTiers: readonly ModelServiceTier[];
readonly defaultServiceTier: string | null;
readonly isDefault: boolean;
@ -59,14 +54,6 @@ export function supportedEffortsForModelMetadata(model: ModelMetadata | null): R
);
}
export function reasoningEffortDescriptionForModelMetadata(model: ModelMetadata | null, effort: ReasoningEffort): string | null {
const normalizedEffort = normalizeReasoningEffort(effort);
if (!normalizedEffort) return null;
const option = model?.reasoningEffortOptions?.find((item) => normalizeReasoningEffort(item.reasoningEffort) === normalizedEffort);
const description = option?.description.trim();
return description ? description : null;
}
export function sortedModelMetadata(models: readonly ModelMetadata[]): ModelMetadata[] {
return [...models]
.filter((model) => !model.hidden)

View file

@ -1,53 +0,0 @@
const encoder = new TextEncoder();
export function utf8ByteLength(value: string): number {
return encoder.encode(value).byteLength;
}
export function splitUtf8Context(value: string, maxBytes: number, maxParts: number): { parts: string[]; includedBytes: number } {
const parts: string[] = [];
let rest = value;
while (rest && parts.length < maxParts) {
const prefix = utf8Prefix(rest, maxBytes);
if (!prefix) break;
const boundary = preferredBoundary(prefix, rest.length > prefix.length);
const part = prefix.slice(0, boundary);
parts.push(part);
rest = rest.slice(part.length);
}
return { parts, includedBytes: parts.reduce((total, part) => total + utf8ByteLength(part), 0) };
}
export function truncateUtf8(value: string, maxBytes: number): string {
return utf8Prefix(value, maxBytes);
}
function utf8Prefix(value: string, maxBytes: number): string {
if (maxBytes <= 0 || !value) return "";
if (utf8ByteLength(value) <= maxBytes) return value;
let low = 0;
let high = value.length;
while (low < high) {
const middle = Math.ceil((low + high) / 2);
const candidate = safeCodeUnitBoundary(value, middle);
if (utf8ByteLength(value.slice(0, candidate)) <= maxBytes) low = middle;
else high = middle - 1;
}
return value.slice(0, safeCodeUnitBoundary(value, low));
}
function safeCodeUnitBoundary(value: string, index: number): number {
if (index <= 0 || index >= value.length) return index;
const code = value.charCodeAt(index);
return code >= 0xdc00 && code <= 0xdfff ? index - 1 : index;
}
function preferredBoundary(prefix: string, hasRemainder: boolean): number {
if (!hasRemainder) return prefix.length;
const minimum = Math.floor(prefix.length / 2);
for (const marker of ["\n\n", "\n", " "]) {
const index = prefix.lastIndexOf(marker);
if (index >= minimum) return index + marker.length;
}
return prefix.length;
}

View file

@ -1,15 +1,8 @@
export interface VaultFileReference {
export interface RequestMention {
name: string;
path: string;
}
export interface SkillReference {
name: string;
path: string;
}
export const ACTIVE_FILE_REFERENCE_NAME = "<active>";
export interface RequestAdditionalContext {
key: string;
value: string;
@ -21,30 +14,21 @@ export type CodexInputItem =
| { type: "image"; url: string; detail?: UserInputImageDetail }
| { type: "localImage"; path: string; detail?: UserInputImageDetail }
| { type: "skill"; name: string; path: string }
| { type: "fileReference"; name: string; path: string }
| {
type: "additionalContext";
key: string;
value: string;
kind: RequestAdditionalContext["kind"];
};
| { type: "mention"; name: string; path: string }
| { type: "additionalContext"; key: string; value: string; kind: RequestAdditionalContext["kind"] };
export type CodexInput = CodexInputItem[];
type UserInputImageDetail = "auto" | "low" | "high" | "original";
export function codexTextInput(text: string): CodexInput {
return [{ type: "text", text }];
}
export function codexTextInputWithReferences(
export function codexTextInputWithMentions(
text: string,
fileReferences: readonly VaultFileReference[],
skills: readonly SkillReference[] = [],
mentions: readonly RequestMention[],
skills: readonly RequestMention[] = [],
additionalContext: readonly RequestAdditionalContext[] = [],
): CodexInput {
return [
...codexTextInput(text),
...fileReferences.map((reference) => ({ type: "fileReference" as const, name: reference.name, path: reference.path })),
...mentions.map((mention) => ({ type: "mention" as const, name: mention.name, path: mention.path })),
...skills.map((skill) => ({ type: "skill" as const, name: skill.name, path: skill.path })),
...additionalContext.map((context) => ({
type: "additionalContext" as const,
@ -58,3 +42,7 @@ export function codexTextInputWithReferences(
export function codexTextInputWithAttachments(text: string, input: readonly CodexInputItem[]): CodexInput {
return [...codexTextInput(text), ...input.filter((item) => item.type !== "text")];
}
function codexTextInput(text: string): CodexInput {
return [{ type: "text", text }];
}

View file

@ -1,10 +0,0 @@
const PANEL_SUBMISSION_CLIENT_ID_PATTERN = /^local-(?:user|steer)-\d+-[A-Za-z0-9_-]+-[a-z0-9]+-[a-z0-9]+$/;
export function isPanelSubmissionClientId(value: string | null | undefined): value is string {
return typeof value === "string" && PANEL_SUBMISSION_CLIENT_ID_PATTERN.test(value);
}
export function turnContextSubmissionId(value: string): string {
const safe = value.replace(/[^A-Za-z0-9_.-]/g, "_").slice(0, 120);
return safe || "context";
}

View file

@ -1,19 +0,0 @@
import { fromMarkdown } from "mdast-util-from-markdown";
import { visit } from "unist-util-visit";
export type MarkdownCodeRange = readonly [start: number, end: number];
export function markdownCodeRanges(markdown: string): MarkdownCodeRange[] {
const ranges: MarkdownCodeRange[] = [];
visit(fromMarkdown(markdown), (node) => {
if (node.type !== "code" && node.type !== "inlineCode") return;
const start = node.position?.start.offset;
const end = node.position?.end.offset;
if (start !== undefined && end !== undefined) ranges.push([start, end]);
});
return ranges;
}
export function markdownCodeRangeContainsOffset(ranges: readonly MarkdownCodeRange[], offset: number): boolean {
return ranges.some(([start, end]) => offset >= start && offset < end);
}

Some files were not shown because too many files have changed in this diff Show more