fix(core): fix inline client driver for cloudflare-workers

[NathanFlurry]

No description provided.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
rivetkit-serverless	Error			Sep 19, 2025 0:49am

[claude]

Claude finished @NathanFlurry's task —— View job

---

Code Review: Inline Client Driver Fix for Cloudflare Workers

Todo List

• Analyze the changed files to understand the fix
• Review code quality and best practices
• Check for potential bugs or issues
• Evaluate performance considerations
• Assess security concerns
• Review test coverage
• Provide constructive feedback

Review Summary

This PR makes important fixes to the inline client driver for Cloudflare Workers, focusing on improving test infrastructure and transport handling. The changes are well-implemented and address real compatibility issues.

✅ Strengths

1. Robust URL Handling: The new combineUrlPath function in utils.ts:209-244 properly handles complex URL scenarios with existing paths and query parameters.

2. Comprehensive Test Infrastructure: Enhanced test endpoints in manager/router.ts:402-531 provide thorough testing capabilities for inline drivers across different transport types.

3. Proper WebSocket Proxying: The createTestWebSocketProxy function (lines 564-797) handles WebSocket message forwarding with appropriate error handling and cleanup.

4. Transport Abstraction: Good separation of concerns between WebSocket, SSE, and HTTP transports in the generic connection drivers.

⚠️ Areas for Improvement

Bug/Security Concerns

1. Potential Memory Leak (manager/router.ts:568-582):

   let clientWs: UniversalWebSocket | null = null;
   const serverWsPromise = promiseWithResolvers<WSContext>();

   The promise resolvers aren't properly cleaned up if the connection fails early. Consider adding cleanup in the catch block.

2. Error Swallowing (actor/instance.ts:172-175):

   } catch {
       // Swallow errors: callers only await cycle completion, not success
   }

   While intentional, this could hide important errors. Consider at least logging them.

3. HACK Comments indicate technical debt:

   • manager/router.ts:765-767: WebSocket force close hack
   • driver-test-suite/test-inline-client-driver.ts:189-190: Protocol handling hack

Performance Considerations

1. Inefficient String Operations (utils.ts:225):

   const fullPath = (basePath + cleanPath).replace(/\/\//g, "/");

   Consider checking if replacement is needed before calling replace().

2. Polling SSE Pings (actor/router-endpoints.ts:421-433):
   The 1-second ping interval could be made configurable for different deployment scenarios.

Code Quality Issues

1. Missing Type Safety (driver-test-suite/test-inline-client-driver.ts:187-191):

   const ws = new WebSocket(finalWsUrl, [
       "rivetkit",
   ]) as any;

   The as any cast bypasses type safety. Consider proper typing.

2. Inconsistent Error Handling: Some functions throw different error types for similar conditions (e.g., InternalError vs Error).

🔍 Test Coverage Assessment

The test infrastructure improvements are comprehensive:

• ✅ WebSocket connection testing
• ✅ HTTP request proxying
• ✅ SSE connection handling
• ✅ Multiple transport types
• ✅ Error scenarios

However, consider adding tests for:

• URL edge cases in combineUrlPath
• WebSocket proxy error scenarios
• Memory cleanup verification

📋 Recommendations

1. Add proper cleanup for promise resolvers in error scenarios
2. Replace as any casts with proper typing
3. Make ping intervals configurable rather than hardcoded
4. Add JSDoc comments to new public functions like combineUrlPath
5. Consider extracting the WebSocket proxy logic into a separate utility class

🎯 Verdict

This is a solid fix that addresses real compatibility issues with Cloudflare Workers. The code quality is generally good with proper separation of concerns. The main concerns are around error handling and some technical debt (HACK comments), but these don't block the PR. The improvements to test infrastructure are particularly valuable.

Recommendation: ✅ Approve with minor suggestions for future improvements.

---

[NathanFlurry]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• chore(core): migrate gateway to use websocket protocols #1293
• chore(core): update api schema to match new engine schema #1292
• chore(core): fix conn/disconn tests for sse #1290
• fix(core): fix inline client driver for cloudflare-workers #1289 👈 (View in Graphite)
• chore(core): fix missing transport for inline tests #1287 : 1 other dependent PR (#1250 )
• chore(core): fix test for sending message to specific connection sse race condition #1286
• fix(cloudflare-workers): fix alarms #1285
• chore(core): fix broadcast race condition #1284
• chore: list sideEffects #1283
• chore(core): fix connection tests to support sse #1282
• fix(cloudflare-workers): fix aborts on sse streams on cloudflare workers #1281
• fix(cloudflare-workers): fix aborting sse streams #1280
• chore: remove unused FakeEventSource #1279
• main

---

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

• merge queue - adds this PR to the back of the merge queue
• hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

[pkg-pr-new]

More templates

• example-ai-agent
• example-better-auth-external-db
• chat-room
• example-cloudflare-workers
• example-cloudflare-workers-hono
• counter
• example-crdt
• example-database
• example-sqlite
• example-elysia
• example-express
• example-game
• example-hono
• example-hono-react
• example-next-js
• example-rate
• example-raw-fetch-handler
• example-raw-websocket-handler-proxy
• example-react
• starter
• example-stream
• example-sync
• example-tenant
• example-trpc

@rivetkit/actor

pnpm add https://pkg.pr.new/rivet-dev/rivetkit/@rivetkit/actor@1289

@rivetkit/cloudflare-workers

pnpm add https://pkg.pr.new/rivet-dev/rivetkit/@rivetkit/cloudflare-workers@1289

@rivetkit/core

pnpm add https://pkg.pr.new/rivet-dev/rivetkit/@rivetkit/core@1289

@rivetkit/db

pnpm add https://pkg.pr.new/rivet-dev/rivetkit/@rivetkit/db@1289

@rivetkit/framework-base

pnpm add https://pkg.pr.new/rivet-dev/rivetkit/@rivetkit/framework-base@1289

@rivetkit/next-js

pnpm add https://pkg.pr.new/rivet-dev/rivetkit/@rivetkit/next-js@1289

@rivetkit/react

pnpm add https://pkg.pr.new/rivet-dev/rivetkit/@rivetkit/react@1289

rivetkit

pnpm add https://pkg.pr.new/rivet-dev/rivetkit@1289

@rivetkit/sql-loader

pnpm add https://pkg.pr.new/rivet-dev/rivetkit/@rivetkit/sql-loader@1289

commit: c686a97

[graphite-app]

Merge activity

• Sep 24, 6:06 AM UTC: NathanFlurry added this pull request to the Graphite merge queue.
• Sep 24, 6:07 AM UTC: CI is running for this pull request on a draft pull request (#1294) due to your merge queue CI optimization settings.
• Sep 24, 6:08 AM UTC: Merged by the Graphite merge queue via draft PR: #1294.