Skip to content

Conversation

@ThomasK33
Copy link
Member

Summary

Replaces the custom IPC layer with oRPC for type-safe RPC between browser/renderer and backend processes.

Key Changes

Architecture

  • New ORPC router (src/node/orpc/router.ts) - Central router defining all RPC endpoints with Zod schemas
  • Schema definitions (src/common/orpc/schemas.ts) - Shared Zod schemas for request/response validation
  • ServiceContainer (src/node/services/serviceContainer.ts) - Dependency injection container for all backend services
  • React integration (src/browser/orpc/react.tsx) - ORPCProvider and useORPC() hook for frontend

Transport

  • Desktop (Electron): MessagePort-based RPC via @orpc/server/message-port
  • Server mode: HTTP + WebSocket via @orpc/server/node and @orpc/server/ws
  • Auth middleware with timing-safe token comparison for server mode

Subscriptions

Streaming endpoints (chat events, metadata updates, terminal output) use async generators:

// Router
handler: async function* ({ context, input }) {
  const unsubscribe = service.onEvent(push);
  try {
    while (!ended) { yield queue.shift() ?? await nextEvent(); }
  } finally { unsubscribe(); }
}

// Client
for await (const event of client.workspace.onChat({ workspaceId })) {
  handleEvent(event);
}

Removed

  • src/browser/api.ts (old HTTP/WS client)
  • src/node/services/ipcMain.ts (old IPC handler registration)
  • src/desktop/preload.ts IPC method definitions (now just MessagePort forwarding)
  • tests/ipcMain/ directory (migrated to tests/integration/)

Testing

  • All existing tests migrated to use ORPC test client
  • New StreamCollector utility for testing async generator subscriptions
  • Server endpoint tests for HTTP and WebSocket transports

Migration Notes

  • Frontend components now use useORPC() hook instead of window.api
  • Stores receive client via setClient() during app initialization
  • Type safety is enforced at compile time via Zod schema inference

Generated with mux

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@ThomasK33 ThomasK33 force-pushed the mux-ipc-to-orpc-migration branch 8 times, most recently from 0106889 to a1e6608 Compare November 27, 2025 13:48
Replace Electron's loosely-typed ipcMain/ipcRenderer with ORPC, providing
end-to-end type safety between frontend and backend.

Key changes:
- Add @orpc/client, @orpc/server, @orpc/zod dependencies
- Create ORPC router (src/node/orpc/router.ts) with typed procedures
- Add React ORPC provider and useORPC hook (src/browser/orpc/react.tsx)
- Extract services: WorkspaceService, ProjectService, ProviderService,
  TokenizerService, TerminalService, WindowService, UpdateService
- Replace window.api.* calls with typed client.* calls throughout frontend
- Update test infrastructure to use ORPC test client (orpcTestClient.ts)
- Switch Jest transform from ts-jest to babel-jest for ESM compatibility

Breaking: Removes src/common/types/ipc.ts and src/common/constants/ipc-constants.ts
in favor of src/common/orpc/types.ts and src/common/orpc/schemas.ts

_Generated with mux_

Change-Id: Ibfeb8345e27baf663ca53ae04e4906621fda3b62
Signed-off-by: Thomas Kosiewski <tk@coder.com>

🤖 refactor: complete ORPC migration Phase 5 cleanup

- Delete obsolete src/browser/api.test.ts (tested legacy invokeIPC pattern)
- Update src/desktop/preload.ts comment to reflect ORPC architecture
- Remove unused StreamErrorType re-export from src/common/orpc/types.ts

_Generated with mux_

Change-Id: I27a79252ee4256558f4aab8a3c4d60d7820d6599
Signed-off-by: Thomas Kosiewski <tk@coder.com>

🤖 fix: fix E2E test failures after ORPC migration

1. Fix ORPCProvider platform detection: check for window.api existence
   instead of window.api.platform === 'electron' (preload exposes
   process.platform which is 'darwin'/'win32'/'linux', not 'electron')

2. Fix E2E stream capture: replace assert() with inline throw since
   page.evaluate() stringifies code and loses import references

_Generated with mux_

Change-Id: I9e4b35b830cea0d689845c2f4f2e68653f756e3d
Signed-off-by: Thomas Kosiewski <tk@coder.com>

🤖 test: fix E2E /compact test expectation

Remove outdated '📦 compacted' expectation - the compaction feature
now shows only summary text without the label marker.

_Generated with mux_

Change-Id: Ic43a3dd9d099545a58832ebf60183775843f697f
Signed-off-by: Thomas Kosiewski <tk@coder.com>

🤖 fix: migrate WorkspaceConsumerManager to use ORPC client for tokenization

The tokenizer was still using the old window.api.tokenizer bridge which no longer
exists after the ORPC migration. Updated to use window.__ORPC_CLIENT__.tokenizer
instead.

This fixes the repeated 'Tokenizer IPC bridge unavailable' assertion errors
during E2E tests.

Change-Id: I43820079337ca98e0dc97e863cde9414536d107f
Signed-off-by: Thomas Kosiewski <tk@coder.com>

🤖 fix: fix flaky E2E toast tests with longer duration in E2E mode

Changes:
- Expose isE2E flag via preload to renderer for E2E-specific behavior
- Increase toast auto-dismiss duration from 3s to 10s in E2E mode
- Add sendCommandAndExpectStatus helper that waits for toast concurrently
- Disable fullyParallel for Electron tests to avoid timing issues
- Update tests to use new helper for reliable toast assertions

The root cause was that toasts auto-dismiss after 3 seconds, but under
parallel test execution the timing variance meant assertions could miss
observing the toast before it disappeared.

Change-Id: I
Signed-off-by: Thomas Kosiewski <tk@coder.com>

🤖 fix: fix StreamCollector race condition in integration tests

The StreamCollector was marking the subscription as ready immediately after
getting the async iterator, but the ORPC generator body (which sets up the
actual subscription) doesn't run until iteration starts.

Changes:
- Add waitForSubscription() method that waits for first event
- Mark subscription as ready after receiving first event (from history replay)
- Add small delay after subscription ready to stabilize under load
- Update sendMessageAndWait to use the new synchronization

This fixes flaky integration tests in runtimeFileEditing.test.ts where
streaming events were sometimes missed due to the race condition.

Change-Id: I1f697dbf9486a45c9335fd00c42fb54853715ed3
Signed-off-by: Thomas Kosiewski <tk@coder.com>

🤖 fix: restore native terminal opening for Electron desktop mode

The ORPC migration inadvertently changed the terminal opening behavior:
- Before: Clicking terminal button opened the user's native terminal app
  (Ghostty, Terminal.app, etc.) with cwd set to workspace path
- After: It opened an xterm.js web terminal in an Electron popup window

This restores the original behavior by:
1. Adding TerminalService.openNative() method with platform-specific logic:
   - macOS: Ghostty (if available) or Terminal.app
   - Windows: cmd.exe
   - Linux: x-terminal-emulator, ghostty, alacritty, kitty, etc.
2. Adding ORPC endpoint terminal.openNative for the new method
3. Updating useOpenTerminal hook to call openNative for Electron mode

The web terminal (openWindow) is still available for browser mode.

Added comprehensive unit tests to prevent this regression:
- Tests for macOS Terminal.app and Ghostty detection
- Tests for Windows cmd opening
- Tests for Linux terminal emulator discovery
- Tests for SSH workspace handling
- Tests for error conditions

Change-Id: Ib01af78cab49cb6ed3486eaaee85277f4b3daa15
Signed-off-by: Thomas Kosiewski <tk@coder.com>

🤖 fix: guard against undefined event.key in matchesKeybind

Certain keyboard events (dead keys for accents, modifier-only events, etc.)
can have event.key as undefined, causing a TypeError when calling toLowerCase().

Added defensive check to return false early when event.key is falsy.
Added unit tests for the keybinds utility.

Change-Id: I3784275ea2f0bd1206c548e3014854f259bc7a3e
Signed-off-by: Thomas Kosiewski <tk@coder.com>

🤖 refactor: rename IpcMain to ServiceContainer and fix review issues

- Rename IpcMain class to ServiceContainer to reflect its actual purpose
  as a dependency container for ORPC services
- Move tests/ipcMain/ to tests/integration/ for clarity
- Fix provider config: empty string values now delete keys (allows clearing API keys)
- Fix WorkspaceContext: add missing `client` dependency in createWorkspace
- Fix schemas: add missing compacted/cmuxMetadata fields, remove stale entries
- Fix updater: remove unused mainWindow field and setMainWindow method

Change-Id: Iea939ecdcbb986f5a4f38a8cd2d7f250e8497dcf
Signed-off-by: Thomas Kosiewski <tk@coder.com>

🤖 fix: guard TitleBar against missing window.api in browser mode

Change-Id: Ic6d1ddef2d3a9e3b047d1d6598e583d4ca345c57
Signed-off-by: Thomas Kosiewski <tk@coder.com>

cleanup

Change-Id: Ia6374d2f4e3696709536c93b2488d4bf0f3fda0f
Signed-off-by: Thomas Kosiewski <tk@coder.com>

🤖 feat: add auth middleware to oRPC router

Add bearer token authentication for HTTP and WebSocket endpoints using
oRPC's native middleware pattern. Headers are injected into context at
the transport layer, allowing a unified middleware to handle both.

- Create authMiddleware.ts with createAuthMiddleware and extractWsHeaders
- Update ORPCContext to include optional headers field
- Apply auth middleware to router via t.use()
- Inject headers into context in orpcServer.ts for HTTP and WS
- Support WS auth fallbacks: query param, Authorization header, protocol

Change-Id: Ief9b8b6d03d1f0161b996ac5d88ce2807e910c94
Signed-off-by: Thomas Kosiewski <tk@coder.com>

fix: return actual path from listDirectory, not empty string

The listDirectory function was using buildFileTree() which creates a
synthetic root with name: '' and path: ''. This broke DirectoryPickerModal
which relies on root.path for:
- Displaying the current directory path in the UI
- Computing parent directory via ${root.path}/..
- Returning the selected path to the caller

Fixed by returning a FileTreeNode with the resolved absolute path as both
name and path, matching the original IPC handler behavior.

Added regression tests to prevent this from happening again.

Change-Id: Iaddcbc3982c4f2440bcd92420e295881bf4fe90c
Signed-off-by: Thomas Kosiewski <tk@coder.com>
When the server requires authentication (--auth-token), the browser client
now shows a modal prompting the user to enter the auth token. The token is:
- Stored in localStorage for subsequent visits
- Can also be passed via URL query parameter (?token=...)
- Cleared and re-prompted if authentication fails

This replaces the previous server-side injection approach with a cleaner
user-driven authentication flow.

Change-Id: I5599266df30340bcc5ca016a14a67a5d74c52669
Signed-off-by: Thomas Kosiewski <tk@coder.com>
…ovided

Fixes Storybook tests failing in CI. When a client prop is passed to
ORPCProvider, the component now starts in "connected" state immediately
instead of waiting for useEffect. This prevents a flash of null content
that caused tests to see an empty storybook-root div.

Change-Id: I048104e7f2fe434efcf9b50db0bae445d912b014
Signed-off-by: Thomas Kosiewski <tk@coder.com>
The ORPC migration changed ReviewPanel to use client.workspace.executeBash()
instead of window.api.workspace.executeBash(). Update the story to provide
a mock ORPC client via ORPCProvider instead of mocking window.api.

_Generated with mux_

Change-Id: Icd3cc9eb6a4ce6f9aebb7d8e72e8627d7220f740
Signed-off-by: Thomas Kosiewski <tk@coder.com>
@ThomasK33 ThomasK33 force-pushed the mux-ipc-to-orpc-migration branch 2 times, most recently from e24c438 to 5edd40e Compare November 27, 2025 14:47
- Replace custom API client with ORPC client in mobile app
- Split monolithic schemas.ts into domain-specific schema files
- Derive TypeScript types from Zod schemas (single source of truth)
- Add exhaustive handler map for chat events with TypedEventType
- Fix executeBash result unwrapping (was assuming double-wrapped Result)
- Add usage-delta handler (silently ignored on mobile)

_Generated with mux_

Change-Id: Ia4a52a091b4a9273ee1a1484336c00ac9a145edc
Signed-off-by: Thomas Kosiewski <tk@coder.com>
@ThomasK33 ThomasK33 force-pushed the mux-ipc-to-orpc-migration branch from 5edd40e to 0d73943 Compare November 27, 2025 15:00
The parseRuntimeModeAndHost function was trying to parse "ssh user@host"
as a RuntimeMode, which failed because the schema only accepts "ssh" or
"local". Now checks for the SSH prefix first before attempting mode parsing.

Change-Id: Ia8722ea6febdad1fc95eddba5fcb9d4d5c076932
Signed-off-by: Thomas Kosiewski <tk@coder.com>
@ThomasK33 ThomasK33 added this pull request to the merge queue Nov 27, 2025
Merged via the queue into main with commit 3ee7288 Nov 27, 2025
15 checks passed
@ThomasK33 ThomasK33 deleted the mux-ipc-to-orpc-migration branch November 27, 2025 16:21
@ThomasK33 ThomasK33 linked an issue Nov 27, 2025 that may be closed by this pull request
ethanndickson added a commit that referenced this pull request Nov 28, 2025
The ORPC migration PR (#763) inadvertently deleted the auto-compaction
trigger logic when sending messages. This restores:

- Check if usage >= threshold before sending regular messages
- Execute compaction with continueMessage instead of direct send
- Show 'Context threshold reached - auto-compacting...' toast
- Proper error handling with input/image restoration

The supporting infrastructure (checkAutoCompaction, CompactionWarning,
settings UI) remained intact - only the trigger logic was missing.

_Generated with `mux`_
ethanndickson added a commit that referenced this pull request Nov 28, 2025
Reverts:
- 470e4eb perf: fix streaming content delay from ORPC schema validation (#774)
- b437977 feat: add backend support for soft-interrupts (#767)
- df30cbc fix: use ResultSchema for sendMessage output to prevent field stripping (#773)
- 41c77ef fix: testUtils formatting (#771)
- 3ee7288 refactor: migrate IPC layer to ORPC for type-safe RPC (#763)
github-merge-queue bot pushed a commit that referenced this pull request Nov 28, 2025
Reverts:
- 470e4eb perf: fix streaming content delay from ORPC schema validation
(#774)
- b437977 feat: add backend support for soft-interrupts (#767)
- df30cbc fix: use ResultSchema for sendMessage output to prevent field
stripping (#773)
- 41c77ef fix: testUtils formatting (#771)
- 3ee7288 refactor: migrate IPC layer to ORPC for type-safe RPC (#763)

Due to a huge number of regressions.

_Generated with `mux`_
ThomasK33 added a commit that referenced this pull request Nov 29, 2025
This commit reintroduces the ORPC refactoring that was originally merged
in #763 and subsequently reverted in #777 due to regressions.

## Original PR: #763
Replaces the custom IPC layer with oRPC for type-safe RPC between
browser/renderer and backend processes.

## Why it was reverted (#777)
The original migration caused regressions including:
- Streaming content delay from ORPC schema validation
- Field stripping issues in sendMessage output
- Auto-compaction trigger deletion

## What's different this time
- Rebased onto latest main which includes fixes that were developed
  post-revert (model favorites, auto-compaction, etc.)
- Conflict resolution preserves upstream features added after revert:
  - Workspace name collision retry with hash suffix
  - Mux Gateway coupon code handling with default models
  - AWS Bedrock credential nested structure

## Key Changes

### Architecture
- New ORPC router (src/node/orpc/router.ts) - Central router with Zod schemas
- Schema definitions (src/common/orpc/schemas.ts) - Shared validation
- ServiceContainer (src/node/services/serviceContainer.ts) - DI container
- React integration (src/browser/orpc/react.tsx) - ORPCProvider and useORPC()

### Transport
- Desktop (Electron): MessagePort-based RPC via @orpc/server/message-port
- Server mode: HTTP + WebSocket via @orpc/server/node and @orpc/server/ws
- Auth middleware with timing-safe token comparison

### Removed
- src/browser/api.ts (old HTTP/WS client)
- src/node/services/ipcMain.ts (old IPC handler registration)
- Old IPC method definitions in preload.ts

---
_Generated with mux_
ThomasK33 added a commit that referenced this pull request Nov 29, 2025
This commit reintroduces the ORPC refactoring that was originally merged
in #763 and subsequently reverted in #777 due to regressions.

## Original PR: #763
Replaces the custom IPC layer with oRPC for type-safe RPC between
browser/renderer and backend processes.

## Why it was reverted (#777)
The original migration caused regressions including:
- Streaming content delay from ORPC schema validation
- Field stripping issues in sendMessage output
- Auto-compaction trigger deletion

## What's different this time
- Rebased onto latest main which includes fixes that were developed
  post-revert (model favorites, auto-compaction, etc.)
- Conflict resolution preserves upstream features added after revert:
  - Workspace name collision retry with hash suffix
  - Mux Gateway coupon code handling with default models
  - AWS Bedrock credential nested structure

## Key Changes

### Architecture
- New ORPC router (src/node/orpc/router.ts) - Central router with Zod schemas
- Schema definitions (src/common/orpc/schemas.ts) - Shared validation
- ServiceContainer (src/node/services/serviceContainer.ts) - DI container
- React integration (src/browser/orpc/react.tsx) - ORPCProvider and useORPC()

### Transport
- Desktop (Electron): MessagePort-based RPC via @orpc/server/message-port
- Server mode: HTTP + WebSocket via @orpc/server/node and @orpc/server/ws
- Auth middleware with timing-safe token comparison

### Removed
- src/browser/api.ts (old HTTP/WS client)
- src/node/services/ipcMain.ts (old IPC handler registration)
- Old IPC method definitions in preload.ts

---
_Generated with mux_
ThomasK33 added a commit that referenced this pull request Nov 30, 2025
This commit reintroduces the ORPC refactoring that was originally merged
in #763 and subsequently reverted in #777 due to regressions.

## Original PR: #763
Replaces the custom IPC layer with oRPC for type-safe RPC between
browser/renderer and backend processes.

## Why it was reverted (#777)
The original migration caused regressions including:
- Streaming content delay from ORPC schema validation
- Field stripping issues in sendMessage output
- Auto-compaction trigger deletion

## What's different this time
- Rebased onto latest main which includes fixes that were developed
  post-revert (model favorites, auto-compaction, etc.)
- Conflict resolution preserves upstream features added after revert:
  - Workspace name collision retry with hash suffix
  - Mux Gateway coupon code handling with default models
  - AWS Bedrock credential nested structure

## Key Changes

### Architecture
- New ORPC router (src/node/orpc/router.ts) - Central router with Zod schemas
- Schema definitions (src/common/orpc/schemas.ts) - Shared validation
- ServiceContainer (src/node/services/serviceContainer.ts) - DI container
- React integration (src/browser/orpc/react.tsx) - ORPCProvider and useORPC()

### Transport
- Desktop (Electron): MessagePort-based RPC via @orpc/server/message-port
- Server mode: HTTP + WebSocket via @orpc/server/node and @orpc/server/ws
- Auth middleware with timing-safe token comparison

### Removed
- src/browser/api.ts (old HTTP/WS client)
- src/node/services/ipcMain.ts (old IPC handler registration)
- Old IPC method definitions in preload.ts

---
_Generated with mux_
ThomasK33 added a commit that referenced this pull request Nov 30, 2025
This commit reintroduces the ORPC refactoring that was originally merged
in #763 and subsequently reverted in #777 due to regressions.

## Original PR: #763
Replaces the custom IPC layer with oRPC for type-safe RPC between
browser/renderer and backend processes.

## Why it was reverted (#777)
The original migration caused regressions including:
- Streaming content delay from ORPC schema validation
- Field stripping issues in sendMessage output
- Auto-compaction trigger deletion

## What's different this time
- Rebased onto latest main which includes fixes that were developed
  post-revert (model favorites, auto-compaction, etc.)
- Conflict resolution preserves upstream features added after revert:
  - Workspace name collision retry with hash suffix
  - Mux Gateway coupon code handling with default models
  - AWS Bedrock credential nested structure

## Key Changes

### Architecture
- New ORPC router (src/node/orpc/router.ts) - Central router with Zod schemas
- Schema definitions (src/common/orpc/schemas.ts) - Shared validation
- ServiceContainer (src/node/services/serviceContainer.ts) - DI container
- React integration (src/browser/orpc/react.tsx) - ORPCProvider and useORPC()

### Transport
- Desktop (Electron): MessagePort-based RPC via @orpc/server/message-port
- Server mode: HTTP + WebSocket via @orpc/server/node and @orpc/server/ws
- Auth middleware with timing-safe token comparison

### Removed
- src/browser/api.ts (old HTTP/WS client)
- src/node/services/ipcMain.ts (old IPC handler registration)
- Old IPC method definitions in preload.ts

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migrate our IPC Api to oRPC

1 participant