Skip to content

refactor(server): effectify config json route handlers#1026

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

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

Conversation

@Astro-Han
Copy link
Copy Markdown
Owner

Summary

Migrate the config JSON route handlers to the existing AppRuntime.runPromise(Effect.gen(...)) route runtime pattern.

Why

This continues the ordinary JSON route migration tracked in #936 without changing public route contracts or touching streaming, auth, workspace sync, v2, or SDK/OpenAPI source generation.

Related Issue

Refs #936

Human Review Status

Pending

Review Focus

Please check that /config, /config/providers, and config update behavior still return the same JSON shapes while using the Effect services.

Risk Notes

Skipped conditional checklist items:

  • Visible UI/copy check: not applicable; server-only route refactor.
  • Platform/packaging check: not applicable; no platform or packaging surface touched.
  • Docs/release/dependency/local file check: not applicable; no docs, dependencies, generated content, credentials, or local-only files changed.

How To Verify

Focused route tests: bun test test/server/config-routes.test.ts -> 2 pass, 0 fail
Diff check: git diff --cached --check -> passed before commit

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 7 minutes and 17 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: 75ad9f73-390c-4417-8494-35307d7b2c52

📥 Commits

Reviewing files that changed from the base of the PR and between c019c11 and 28c7dc7.

📒 Files selected for processing (2)
  • packages/opencode/src/server/instance/config.ts
  • packages/opencode/test/server/config-routes.test.ts
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/i936-config-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 the configuration routes in packages/opencode/src/server/instance/config.ts to use the Effect library and AppRuntime for managing service dependencies and execution. It also introduces a new test suite in packages/opencode/test/server/config-routes.test.ts to verify the GET routes for configuration and providers. The reviewer suggests removing a redundant mapValues call in the provider listing route to simplify the code, and recommends adding a test case for the PATCH /config route to ensure full coverage of the refactored handlers.

Comment on lines +98 to +104
const providers = await AppRuntime.runPromise(
Effect.gen(function* () {
const service = yield* Provider.Service
const items = yield* service.list()
return mapValues(items, (item) => item)
}),
)
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

The mapValues(items, (item) => item) call is redundant because it maps each key-value pair to itself, creating an identical record. Since service.list() already returns a Record<ProviderID, Info>, you can return items directly.

        const providers = await AppRuntime.runPromise(
          Effect.gen(function* () {
            const service = yield* Provider.Service
            return yield* service.list()
          }),
        )

Comment on lines +46 to +47
})
})
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

The test suite covers reading the configuration and listing providers, but it does not verify the PATCH /config route. Adding a test for the update behavior ensures that the refactored update handler works correctly and returns the expected JSON shape, as requested in the review focus.

  })

  test("updates config through the route runtime", async () => {
    await using tmp = await tmpdir({ git: true })
    await Instance.provide({
      directory: tmp.path,
      fn: async () => {
        const response = await app().request("/config", {
          method: "PATCH",
          headers: {
            "Content-Type": "application/json",
          },
          body: JSON.stringify({
            model: "openai/gpt-5",
          }),
        })
        const body = await response.json()

        expect(response.status).toBe(200)
        expect(body.model).toBe("openai/gpt-5")
      },
    })
  })
})

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