Skip to content

fix(shared-log): guard persistCoordinate against TOCTOU race during shutdown #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Faolain wants to merge 1 commit into
base: fix/pubsub-subscribe-race
Choose a base branch
from
Open

fix(shared-log): guard persistCoordinate against TOCTOU race during shutdown #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
78 changes: 45 additions & 33 deletions packages/programs/data/shared-log/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3673,45 +3673,57 @@ export class SharedLog<
replicas: number;
prev?: EntryReplicated<R>;
}) {
let assignedToRangeBoundary = shouldAssignToRangeBoundary(
properties.leaders,
properties.replicas,
);
// Guard against TOCTOU race: _close() may complete between the caller's
// !this.closed check and this method's execution, tearing down indices.
if (this.closed) return;
if (!this._entryCoordinatesIndex) return;
if (!this._replicationRangeIndex) return;

if (
properties.prev &&
properties.prev.assignedToRangeBoundary === assignedToRangeBoundary
) {
return; // no change
}
try {
let assignedToRangeBoundary = shouldAssignToRangeBoundary(
properties.leaders,
properties.replicas,
);

const cidObject = cidifyString(properties.entry.hash);
const hashNumber = this.indexableDomain.numbers.bytesToNumber(
cidObject.multihash.digest,
);
if (
properties.prev &&
properties.prev.assignedToRangeBoundary === assignedToRangeBoundary
) {
return; // no change
}

await this.entryCoordinatesIndex.put(
new this.indexableDomain.constructorEntry({
assignedToRangeBoundary,
coordinates: properties.coordinates,
meta: properties.entry.meta,
hash: properties.entry.hash,
hashNumber,
}),
);
const cidObject = cidifyString(properties.entry.hash);
const hashNumber = this.indexableDomain.numbers.bytesToNumber(
cidObject.multihash.digest,
);

for (const coordinate of properties.coordinates) {
this.coordinateToHash.add(coordinate, properties.entry.hash);
}
await this.entryCoordinatesIndex.put(
new this.indexableDomain.constructorEntry({
assignedToRangeBoundary,
coordinates: properties.coordinates,
meta: properties.entry.meta,
hash: properties.entry.hash,
hashNumber,
}),
);

for (const coordinate of properties.coordinates) {
this.coordinateToHash.add(coordinate, properties.entry.hash);
}

if (properties.entry.meta.next.length > 0) {
await this.entryCoordinatesIndex.del({
query: new Or(
properties.entry.meta.next.map(
(x) => new StringMatch({ key: "hash", value: x }),
if (properties.entry.meta.next.length > 0) {
await this.entryCoordinatesIndex.del({
query: new Or(
properties.entry.meta.next.map(
(x) => new StringMatch({ key: "hash", value: x }),
),
),
),
});
});
}
} catch (err) {
// If closed by the time error fires, this was a shutdown race
if (this.closed) return;
throw err;
}
}

Expand Down
Loading