Skip to content

refactor(server): effectify experimental json route handlers#1020

Open
Astro-Han wants to merge 1 commit into
devfrom
codex/i936-experimental-route-effect
Open

refactor(server): effectify experimental json route handlers#1020
Astro-Han wants to merge 1 commit into
devfrom
codex/i936-experimental-route-effect

Conversation

@Astro-Han
Copy link
Copy Markdown
Owner

@Astro-Han Astro-Han commented May 31, 2026

Summary

Effectify the ordinary JSON handlers in the experimental route for tool, worktree, and MCP resource endpoints.

Why

Issue #936 is moving route handlers onto AppRuntime-backed services while preserving the existing HTTP API shape. This keeps the experimental JSON route handlers on the Effect service path without touching the workspace sub-router or session pagination generator.

Related Issue

Fixes part of #936.

Human Review Status

Pending

Review Focus

Please focus on whether the migrated handlers preserve the same response shape and avoid crossing into /experimental/workspace or /experimental/session behavior.

Risk Notes

No visible UI or copy changed, so the UI checklist item is not applicable.
No platform, packaging, updater, signing, path, shell, or permissions surface was touched, so the platform checklist item is not applicable.
No docs, release notes, dependencies, permissions, credentials, deletion behavior, generated content, or local file surface changed beyond the focused route test.

How To Verify

Focused route test: cd packages/opencode && bun test ./test/server/experimental-routes.test.ts -> 3 passed, 0 failed
Typecheck: cd packages/opencode && bun run typecheck -> passed
Diff check: git diff --check -> passed

Screenshots or Recordings

Not applicable: no visible UI changes.

Checklist

  • Type label — this PR carries exactly one of bug, enhancement, task, documentation. Type labels are author-added; the labeler bot does NOT assign them. Add the label in the GitHub UI, then tick this.
  • Routing labels — this PR carries at least one of app, ui, platform, harness, ci. The labeler bot assigns these on PR open based on changed paths. Confirm the bot's choice (or override if wrong), then tick this.
  • Priority label — this PR carries exactly one of P0, P1, P2, P3. The priority-triage bot suggests one on PR open. Confirm or override, then tick this.
  • Human Review Status above is set to Pending, Approved by @<reviewer>, or Not required: <reason> (default is Pending; "not required" is restricted to bot-authored low-risk PRs).
  • I linked the related issue, or stated in Summary why there is no issue.
  • I described the review focus and any meaningful risks.
  • I replaced the example block in How To Verify with the real verification steps and the key result for each.
  • I did not introduce unrelated refactors, dependencies, generated files, or file changes beyond the stated scope.
  • (conditional) I manually checked visible UI or copy changes when needed, with screenshots or recordings. Leave unticked only if no visible UI or copy changed.
  • (conditional) I considered macOS and Windows impact for platform, packaging, updater, signing, paths, shell, or permissions changes. Leave unticked only if no platform/packaging surface was touched.
  • (conditional) I called out docs, release notes, dependencies, permissions, credentials, deletion behavior, generated content, or local file changes when relevant. Leave unticked only if none of those surfaces was touched.
  • I reviewed the final diff for unrelated changes and suspicious dependency changes.
  • I am targeting dev, and my PR title and commit messages use Conventional Commits in English.

@Astro-Han Astro-Han added P2 Medium priority upstream Tracked upstream or vendor behavior harness Model harness, prompts, tool descriptions, and session mechanics task Narrow execution, audit, spike, migration, tracking, or upstream follow-up work tech-debt Supplemental cleanup, maintainability, architecture, test, or quality debt context labels May 31, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 31, 2026

Warning

Review limit reached

@Astro-Han, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 45 minutes and 34 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 3c7ffcf1-0082-468a-933c-d7e39d30c990

📥 Commits

Reviewing files that changed from the base of the PR and between c019c11 and 3c75f3a.

📒 Files selected for processing (2)
  • packages/opencode/src/server/instance/experimental.ts
  • packages/opencode/test/server/experimental-routes.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/i936-experimental-route-effect

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested priority: P2 (includes non-doc, non-test paths outside the low-risk bucket).

P1/P0 are reserved for maintainer confirmation. Please relabel manually if this is a release blocker, security issue, data-loss risk, or updater/runtime failure.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request refactors several experimental routes in packages/opencode/src/server/instance/experimental.ts to run within the Effect runtime using AppRuntime.runPromise and Effect.gen instead of calling static methods directly. It also introduces a new test suite in packages/opencode/test/server/experimental-routes.test.ts to verify these routes. The feedback suggests combining two separate AppRuntime.runPromise calls in the worktree removal route into a single Effect generator to improve efficiency and handle errors more idiomatically.

Comment on lines +358 to +372
const session = await AppRuntime.runPromise(
Effect.gen(function* () {
const sessions = yield* Session.Service
return yield* sessions.findActiveWorktreeBinding(body.directory)
}),
)
if (session) {
throw new Error(`Worktree is in use by session "${session.title}". Call ExitWorktree from that session first.`)
}
await Worktree.remove(body)
await AppRuntime.runPromise(
Effect.gen(function* () {
const worktrees = yield* Worktree.Service
yield* worktrees.remove(body)
}),
)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

These two separate AppRuntime.runPromise calls can be combined into a single Effect generator. Combining them is more efficient as it avoids the overhead of entering and exiting the Effect runtime twice, and it allows you to handle the error flow idiomatically using Effect.fail.

        await AppRuntime.runPromise(
          Effect.gen(function* () {
            const sessions = yield* Session.Service
            const session = yield* sessions.findActiveWorktreeBinding(body.directory)
            if (session) {
              return yield* Effect.fail(
                new Error("Worktree is in use by session \"" + session.title + "\". Call ExitWorktree from that session first.")
              )
            }
            const worktrees = yield* Worktree.Service
            yield* worktrees.remove(body)
          }),
        )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

harness Model harness, prompts, tool descriptions, and session mechanics P2 Medium priority task Narrow execution, audit, spike, migration, tracking, or upstream follow-up work tech-debt Supplemental cleanup, maintainability, architecture, test, or quality debt context upstream Tracked upstream or vendor behavior

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant