Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tidy-sockets-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@effect/rpc": patch
---

Include socket error details in RpcClient protocol error messages.
5 changes: 4 additions & 1 deletion packages/rpc/src/RpcClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1013,7 +1013,10 @@ export const makeProtocolSocket = (options?: {
}
currentError = new RpcClientError({
reason: "Protocol",
message: "Error in socket",
message: Option.match(error, {
onNone: () => "Error in socket",
onSome: (error) => `Socket ${error.message}`
}),
cause: Cause.squash(cause)
})
return writeResponse({
Expand Down
39 changes: 39 additions & 0 deletions packages/rpc/test/RpcClient.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import * as Socket from "@effect/platform/Socket"
import type { RpcClientError } from "@effect/rpc"
import { RpcClient, RpcSerialization } from "@effect/rpc"
import { assert, describe, it } from "@effect/vitest"
import { Deferred, Effect, Schedule } from "effect"

describe("RpcClient", () => {
it.effect("includes socket close details in protocol errors", () =>
Effect.scoped(Effect.gen(function*() {
const socketError = new Socket.SocketCloseError({
reason: "Close",
code: 1006,
closeReason: "connection lost"
})
const socket: Socket.Socket = {
[Socket.TypeId]: Socket.TypeId,
run: () => Effect.fail(socketError),
runRaw: () => Effect.fail(socketError),
writer: Effect.succeed(() => Effect.void)
}
const errorLatch = yield* Deferred.make<RpcClientError.RpcClientError>()
const protocol = yield* RpcClient.makeProtocolSocket({
retrySchedule: Schedule.stop
}).pipe(
Effect.provideService(Socket.Socket, socket),
Effect.provideService(RpcSerialization.RpcSerialization, RpcSerialization.json)
)

yield* protocol.run((response) =>
response._tag === "ClientProtocolError"
? Deferred.succeed(errorLatch, response.error)
: Effect.void
).pipe(Effect.forkScoped)

const error = yield* Deferred.await(errorLatch)
assert.strictEqual(error.message, "Socket Close: 1006: connection lost")
assert.strictEqual(error.cause, socketError)
})))
})