Skip to content

Commit f0e42d6

Browse files
committed
fix(client): use lightweight connection probe
1 parent ebe8afb commit f0e42d6

5 files changed

Lines changed: 45 additions & 6 deletions

File tree

‎apps/server/src/ws.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,7 @@ const RPC_REQUIRED_SCOPE = new Map<string, AuthEnvironmentScope>([
284284
[ORCHESTRATION_WS_METHODS.subscribeShell, AuthOrchestrationReadScope],
285285
[ORCHESTRATION_WS_METHODS.getArchivedShellSnapshot, AuthOrchestrationReadScope],
286286
[ORCHESTRATION_WS_METHODS.subscribeThread, AuthOrchestrationReadScope],
287+
[WS_METHODS.serverProbe, AuthOrchestrationReadScope],
287288
[WS_METHODS.serverGetConfig, AuthOrchestrationReadScope],
288289
[WS_METHODS.serverRefreshProviders, AuthOrchestrationOperateScope],
289290
[WS_METHODS.serverUpdateProvider, AuthOrchestrationOperateScope],
@@ -1238,6 +1239,10 @@ const makeWsRpcLayer = (
12381239
}),
12391240
{ "rpc.aggregate": "orchestration" },
12401241
),
1242+
[WS_METHODS.serverProbe]: (_input) =>
1243+
observeRpcEffect(WS_METHODS.serverProbe, Effect.succeed({}), {
1244+
"rpc.aggregate": "server",
1245+
}),
12411246
[WS_METHODS.serverGetConfig]: (_input) =>
12421247
observeRpcEffect(WS_METHODS.serverGetConfig, loadServerConfig, {
12431248
"rpc.aggregate": "server",

‎packages/client-runtime/src/connection/supervisor.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -652,7 +652,7 @@ describe("EnvironmentSupervisor", () => {
652652
}).pipe(Effect.provide(TestClock.layer())),
653653
);
654654

655-
it.effect("keeps a healthy session when the application becomes active", () =>
655+
it.effect("probes the active session without reconnecting on application activation", () =>
656656
Effect.gen(function* () {
657657
const probeCount = yield* Ref.make(0);
658658
const probeCalled = yield* Deferred.make<void>();

‎packages/client-runtime/src/rpc/session.test.ts‎

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,9 +169,10 @@ const awaitSocket = Effect.fn("TestRpcSessionFactory.awaitSocket")(function* (
169169

170170
const awaitRequest = Effect.fn("TestRpcSessionFactory.awaitRequest")(function* (
171171
socket: TestWebSocket,
172+
index = 0,
172173
) {
173174
for (let attempt = 0; attempt < 100; attempt += 1) {
174-
const request = socket.sent[0];
175+
const request = socket.sent[index];
175176
if (request) {
176177
return decodeRpcRequest(decodeJson(request));
177178
}
@@ -218,6 +219,30 @@ describe("RpcSessionFactory", () => {
218219
expect(config).toEqual(SERVER_CONFIG);
219220
expect(socket.sent).toHaveLength(1);
220221

222+
const probeFiber = yield* Effect.forkChild(session.probe);
223+
const probeRequest = yield* awaitRequest(socket, 1);
224+
expect(probeRequest).toMatchObject({
225+
_tag: "Request",
226+
tag: WS_METHODS.serverProbe,
227+
payload: {},
228+
});
229+
socket.serverMessage(
230+
encodeJson({
231+
_tag: "Exit",
232+
requestId: probeRequest.id,
233+
exit: {
234+
_tag: "Success",
235+
value: {},
236+
},
237+
}),
238+
);
239+
yield* Fiber.join(probeFiber);
240+
241+
expect(socket.sent.map((request) => decodeRpcRequest(decodeJson(request)).tag)).toEqual([
242+
WS_METHODS.serverGetConfig,
243+
WS_METHODS.serverProbe,
244+
]);
245+
221246
socket.close(1012, "service restart");
222247
const error = yield* Effect.flip(session.closed);
223248

‎packages/client-runtime/src/rpc/session.ts‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,9 @@ export class RpcSessionFactory extends Context.Service<
4242
type InitialConfigError = Effect.Error<
4343
ReturnType<WsRpcProtocolClient[typeof WS_METHODS.serverGetConfig]>
4444
>;
45+
type ProbeError = Effect.Error<ReturnType<WsRpcProtocolClient[typeof WS_METHODS.serverProbe]>>;
4546

46-
function mapInitialConfigError(error: InitialConfigError): ConnectionAttemptError {
47+
function mapSessionRpcError(error: InitialConfigError | ProbeError): ConnectionAttemptError {
4748
switch (error._tag) {
4849
case "EnvironmentAuthorizationError":
4950
return new ConnectionBlockedError({
@@ -115,12 +116,12 @@ export const make = Effect.gen(function* () {
115116
const client = yield* makeWsRpcProtocolClient.pipe(Effect.provide(protocolContext));
116117
const initialConfig = yield* Effect.cached(
117118
client[WS_METHODS.serverGetConfig]({}).pipe(
118-
Effect.mapError(mapInitialConfigError),
119+
Effect.mapError(mapSessionRpcError),
119120
Effect.withSpan("environment.initialSync"),
120121
),
121122
);
122-
const probe = client[WS_METHODS.serverGetConfig]({}).pipe(
123-
Effect.mapError(mapInitialConfigError),
123+
const probe = client[WS_METHODS.serverProbe]({}).pipe(
124+
Effect.mapError(mapSessionRpcError),
124125
Effect.asVoid,
125126
Effect.withSpan("clientRuntime.connection.rpcSession.probe"),
126127
);

‎packages/contracts/src/rpc.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,7 @@ export const WS_METHODS = {
201201
previewAutomationFocusHost: "previewAutomation.focusHost",
202202

203203
// Server meta
204+
serverProbe: "server.probe",
204205
serverGetConfig: "server.getConfig",
205206
serverRefreshProviders: "server.refreshProviders",
206207
serverUpdateProvider: "server.updateProvider",
@@ -246,6 +247,12 @@ export const WsServerRemoveKeybindingRpc = Rpc.make(WS_METHODS.serverRemoveKeybi
246247
error: Schema.Union([KeybindingsConfigError, EnvironmentAuthorizationError]),
247248
});
248249

250+
export const WsServerProbeRpc = Rpc.make(WS_METHODS.serverProbe, {
251+
payload: Schema.Struct({}),
252+
success: Schema.Struct({}),
253+
error: EnvironmentAuthorizationError,
254+
});
255+
249256
export const WsServerGetConfigRpc = Rpc.make(WS_METHODS.serverGetConfig, {
250257
payload: Schema.Struct({}),
251258
success: ServerConfig,
@@ -682,6 +689,7 @@ export const WsSubscribeAuthAccessRpc = Rpc.make(WS_METHODS.subscribeAuthAccess,
682689
});
683690

684691
export const WsRpcGroup = RpcGroup.make(
692+
WsServerProbeRpc,
685693
WsServerGetConfigRpc,
686694
WsServerRefreshProvidersRpc,
687695
WsServerUpdateProviderRpc,

0 commit comments

Comments
 (0)