Skip to content

Commit a02f78d

Browse files
fix(server): recover empty environment identity files safely
1 parent 62e9125 commit a02f78d

3 files changed

Lines changed: 54 additions & 5 deletions

File tree

‎apps/server/src/environment/ServerEnvironment.test.ts‎

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,11 @@ const makeServerConfig = Effect.fn(function* (baseDir: string) {
7373
});
7474

7575
it.layer(NodeServices.layer)("ServerEnvironmentLive", (it) => {
76-
it.effect("concurrent initializers use the same persisted environment id", () =>
76+
it.effect.each([
77+
{ name: "missing", content: undefined },
78+
{ name: "empty", content: "" },
79+
{ name: "whitespace-only", content: " \t\n" },
80+
])("concurrent initializers recover a $name environment id file", ({ content }) =>
7781
Effect.gen(function* () {
7882
const fileSystem = yield* FileSystem.FileSystem;
7983
const crypto = yield* Crypto.Crypto;
@@ -82,14 +86,41 @@ it.layer(NodeServices.layer)("ServerEnvironmentLive", (it) => {
8286
});
8387
const serverConfig = yield* makeServerConfig(baseDir);
8488
yield* fileSystem.makeDirectory(serverConfig.stateDir, { recursive: true });
89+
if (content !== undefined) {
90+
yield* fileSystem.writeFileString(serverConfig.environmentIdPath, content);
91+
}
8592
const bothGenerated = yield* Deferred.make<void>();
93+
const bothReadEmpty = yield* Deferred.make<void>();
94+
const firstInitialized = yield* Deferred.make<void>();
8695
let remaining = 2;
96+
let emptyReads = 0;
8797
const readIdentity = Effect.gen(function* () {
8898
const identity = yield* ServerEnvironment.ServerEnvironmentIdentity;
8999
return yield* identity.getEnvironmentId;
90100
}).pipe(
101+
Effect.tap(() => Deferred.succeed(firstInitialized, undefined)),
91102
Effect.provide(Layer.fresh(ServerEnvironment.identityLayer)),
92103
Effect.provideService(ServerConfig.ServerConfig, serverConfig),
104+
Effect.provideService(FileSystem.FileSystem, {
105+
...fileSystem,
106+
readFileString: (path) =>
107+
fileSystem.readFileString(path).pipe(
108+
Effect.tap(
109+
Effect.fn(function* (value) {
110+
if (path !== serverConfig.environmentIdPath || remaining > 0 || value.trim()) {
111+
return;
112+
}
113+
// Both observe the empty file, but one repairs it after the other has finished.
114+
if (++emptyReads === 2) {
115+
yield* Deferred.succeed(bothReadEmpty, undefined);
116+
yield* Deferred.await(firstInitialized);
117+
} else {
118+
yield* Deferred.await(bothReadEmpty);
119+
}
120+
}),
121+
),
122+
),
123+
}),
93124
Effect.provideService(Crypto.Crypto, {
94125
...crypto,
95126
randomUUIDv4: Effect.gen(function* () {

‎apps/server/src/environment/ServerEnvironment.ts‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,20 +114,30 @@ const makeIdentity = Effect.gen(function* () {
114114
});
115115

116116
const persistEnvironmentId = Effect.fn("ServerEnvironmentIdentity.persistEnvironmentId")(
117-
function* (value: string) {
117+
function* (value: string, mode: "create" | "recover") {
118+
const destinationPath =
119+
mode === "recover"
120+
? `${serverConfig.environmentIdPath}.recovery`
121+
: serverConfig.environmentIdPath;
118122
const tempPath = yield* fileSystem.makeTempFileScoped({
119123
directory: serverConfig.stateDir,
120124
prefix: ".environment-id-",
121125
});
122126
yield* fileSystem.writeFileString(tempPath, `${value}\n`);
123127
// Publish the completed file without replacing an ID created by another process.
124128
yield* fileSystem
125-
.link(tempPath, serverConfig.environmentIdPath)
129+
.link(tempPath, destinationPath)
126130
.pipe(
127131
Effect.catch((cause) =>
128132
cause.reason._tag === "AlreadyExists" ? Effect.void : Effect.fail(cause),
129133
),
130134
);
135+
if (mode === "recover") {
136+
// Keep the recovery ID so delayed initializers also publish the same winner.
137+
yield* fileSystem.remove(tempPath);
138+
yield* fileSystem.copyFile(destinationPath, tempPath);
139+
yield* fileSystem.rename(tempPath, serverConfig.environmentIdPath);
140+
}
131141
},
132142
Effect.scoped,
133143
Effect.mapError(
@@ -147,8 +157,12 @@ const makeIdentity = Effect.gen(function* () {
147157
}
148158

149159
const generated = yield* crypto.randomUUIDv4;
150-
yield* persistEnvironmentId(generated);
151-
const winner = yield* readPersistedEnvironmentId;
160+
yield* persistEnvironmentId(generated, "create");
161+
let winner = yield* readPersistedEnvironmentId;
162+
if (winner === null) {
163+
yield* persistEnvironmentId(generated, "recover");
164+
winner = yield* readPersistedEnvironmentId;
165+
}
152166
if (winner === null) {
153167
return yield* new ServerEnvironmentIdPersistenceError({
154168
operation: "initialize",

‎docs/internals/remote.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ It is identified by a stable `environmentId`, persisted by the server at `<state
4141
and generated on first start (`apps/server/src/environment/ServerEnvironment.ts`). Desktop, mobile,
4242
and web all reason about the same concept.
4343

44+
Initialization publishes a complete ID atomically. Empty or whitespace-only ID files are repaired
45+
using a retained `<stateDir>/environment-id.recovery` file so concurrent and delayed repairs choose
46+
the same ID. Existing nonempty ID files remain authoritative.
47+
4448
### Known environments and connection targets
4549

4650
A saved client-side entry for an environment the client knows how to reach. It is not

0 commit comments

Comments
 (0)