Skip to content

Commit 85e77eb

Browse files
fix(client-runtime): remember sticky routes only after initial config
Gate prefer-route persistence on a successful initialConfig so a socket that opens to the wrong environment cannot stick for the next cold start. Treat VPN/OTHER like UNKNOWN on mobile so Tailscale-on-Wi-Fi still keeps LAN routes. Co-authored-by: Cursor <[email protected]>
1 parent 2203a53 commit 85e77eb

5 files changed

Lines changed: 85 additions & 9 deletions

File tree

‎apps/mobile/src/connection/platform.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,12 @@ function networkStatus(state: Network.NetworkState): "unknown" | "offline" | "on
4343

4444
function privateNetworkLikely(state: Network.NetworkState): boolean {
4545
if (state.isConnected !== true) return false;
46+
// VPN/OTHER often mean Wi‑Fi under a tunnel; keep LAN like UNKNOWN does.
4647
return (
4748
state.type === Network.NetworkStateType.WIFI ||
4849
state.type === Network.NetworkStateType.ETHERNET ||
50+
state.type === Network.NetworkStateType.VPN ||
51+
state.type === Network.NetworkStateType.OTHER ||
4952
state.type === Network.NetworkStateType.UNKNOWN
5053
);
5154
}

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

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -470,20 +470,21 @@ const makeHarness = Effect.fn("TestEnvironmentRegistry.makeHarness")(function* (
470470
yield* options?.beforeSessionConnect?.(target.environmentId) ?? Effect.void;
471471
const closed = yield* Deferred.make<never, ConnectionTransientError>();
472472
yield* Ref.update(sessions, (current) => [...current, { closed }]);
473+
const sessionConfig = (
474+
options?.directEndpoints === undefined ? {} : { directEndpoints: options.directEndpoints }
475+
) as ServerConfig;
473476
const session = yield* Effect.acquireRelease(
474477
Effect.succeed({
475478
client: {} as RpcSession.RpcSession["client"],
476-
initialConfig:
477-
options?.directEndpoints === undefined
478-
? Effect.die(new Error("Config is not used by registry tests."))
479-
: Effect.succeed({ directEndpoints: options.directEndpoints } as ServerConfig),
479+
// Succeeds so sticky-route remember can wait on it like production.
480+
initialConfig: Effect.succeed(sessionConfig),
480481
subscribeServerConfig: () =>
481482
options?.directEndpoints === undefined
482483
? Stream.never
483484
: Stream.make({
484485
version: 1 as const,
485486
type: "snapshot" as const,
486-
config: { directEndpoints: options.directEndpoints } as ServerConfig,
487+
config: sessionConfig,
487488
}),
488489
ready: Effect.void,
489490
probe: Effect.void,
@@ -759,6 +760,8 @@ describe("EnvironmentRegistry", () => {
759760
TARGET.environmentId,
760761
(state) => state.phase === "connected",
761762
);
763+
// rememberRoute forks after initialConfig; let that fiber finish.
764+
yield* Effect.yieldNow;
762765

763766
expect(yield* Ref.get(harness.storedLastConnected)).toEqual(
764767
new Map([[TARGET.environmentId, 0]]),
@@ -2385,6 +2388,8 @@ describe("EnvironmentRegistry routes", () => {
23852388
LAN_TARGET.environmentId,
23862389
(state) => state.phase === "connected",
23872390
);
2391+
// rememberRoute forks after initialConfig; let that fiber finish.
2392+
yield* Effect.yieldNow;
23882393

23892394
expect(routesOf(yield* Ref.get(harness.storedTargets), LAN_TARGET.environmentId)).toEqual([
23902395
RELAY_TARGET,

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,48 @@ describe("EnvironmentSupervisor", () => {
353353
}),
354354
);
355355

356+
it.effect("remembers a sticky route only after initial config succeeds", () =>
357+
Effect.gen(function* () {
358+
const releaseConfig = yield* Deferred.make<ServerConfig>();
359+
const remembered = yield* Deferred.make<string>();
360+
const harness = yield* makeHarness({
361+
prepare: (_attempt, target) => Effect.succeed(preparedFor(target)),
362+
initialConfig: () => Deferred.await(releaseConfig),
363+
});
364+
const supervisor = yield* EnvironmentSupervisor.make(LAN_ENTRY, {
365+
initiallyDesired: true,
366+
rememberRoute: ({ activeRoute }) =>
367+
Deferred.succeed(remembered, connectionRouteId(activeRoute.target)).pipe(
368+
Effect.as(Option.none()),
369+
),
370+
}).pipe(Effect.provide(harness.dependencies));
371+
372+
yield* awaitState(supervisor.state, (state) => state.phase === "connected");
373+
expect(Option.isNone(yield* Deferred.poll(remembered))).toBe(true);
374+
375+
yield* Deferred.succeed(releaseConfig, PROBE_CAPABLE_CONFIG);
376+
expect(yield* Deferred.await(remembered)).toBe(connectionRouteId(LAN_TARGET));
377+
}).pipe(Effect.provide(TestClock.layer())),
378+
);
379+
380+
it.effect("does not remember a sticky route when initial config fails", () =>
381+
Effect.gen(function* () {
382+
const remembered = yield* Ref.make(false);
383+
const harness = yield* makeHarness({
384+
prepare: (_attempt, target) => Effect.succeed(preparedFor(target)),
385+
initialConfig: () => Effect.fail(transient("Wrong environment.")),
386+
});
387+
const supervisor = yield* EnvironmentSupervisor.make(LAN_ENTRY, {
388+
initiallyDesired: true,
389+
rememberRoute: () => Ref.set(remembered, true).pipe(Effect.as(Option.none())),
390+
}).pipe(Effect.provide(harness.dependencies));
391+
392+
yield* awaitState(supervisor.state, (state) => state.phase === "connected");
393+
yield* TestClock.adjust("1 second");
394+
expect(yield* Ref.get(remembered)).toBe(false);
395+
}).pipe(Effect.provide(TestClock.layer())),
396+
);
397+
356398
it.effect("waits while offline and connects immediately when the network returns", () =>
357399
Effect.gen(function* () {
358400
const harness = yield* makeHarness({ networkStatus: "offline" });

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

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1284,10 +1284,16 @@ export const make = Effect.fn("EnvironmentSupervisor.make")(function* (
12841284
const connectedAt = yield* Clock.currentTimeMillis;
12851285
yield* setLease(connectedLease);
12861286
if (connectedLease.activeRoute !== undefined && options?.rememberRoute !== undefined) {
1287-
// Persist sticky order for the next cold start only. Applying it to the
1288-
// live entry would make the active route look preferred and stop
1289-
// better-route upgrades (for example LAN while connected over relay).
1290-
yield* options.rememberRoute({ activeRoute: connectedLease.activeRoute });
1287+
const activeRoute = connectedLease.activeRoute;
1288+
const remember = options.rememberRoute;
1289+
// Sticky for the next cold start only, and only after initialConfig. Too
1290+
// early prefers a route that later fails sync; applying it live would also
1291+
// stop better-route upgrades (LAN while on relay).
1292+
yield* connectedLease.session.initialConfig.pipe(
1293+
Effect.andThen(remember({ activeRoute })),
1294+
Effect.ignoreCause({ log: true }),
1295+
Effect.forkScoped,
1296+
);
12911297
}
12921298
if (options?.learnRoutes !== undefined) {
12931299
yield* learnRoutesFrom(options.learnRoutes, connectedLease).pipe(Effect.forkScoped);

‎third-party-licenses.config.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -841,6 +841,26 @@
841841
"name": "iobuffer",
842842
"license": "MIT",
843843
"sourceUrl": "https://github.com/image-js/iobuffer"
844+
},
845+
{
846+
"name": "deprecated-react-native-prop-types",
847+
"version": "2.3.0",
848+
"license": "MIT",
849+
"sourceUrl": "https://github.com/facebook/react-native",
850+
"generatedNotice": {
851+
"licenseId": "MIT",
852+
"copyrights": ["Copyright (c) Meta Platforms, Inc. and affiliates."]
853+
}
854+
},
855+
{
856+
"name": "@react-native/normalize-color",
857+
"version": "2.1.0",
858+
"license": "MIT",
859+
"sourceUrl": "https://github.com/facebook/react-native",
860+
"generatedNotice": {
861+
"licenseId": "MIT",
862+
"copyrights": ["Copyright (c) Meta Platforms, Inc. and affiliates."]
863+
}
844864
}
845865
]
846866
}

0 commit comments

Comments
 (0)