Skip to content

fix(collab): skip live-doc registration grace when the direct connection timed out #61

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
devYRPauli wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(collab): skip live-doc registration grace when the direct connection timed out #61

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
17 changes: 11 additions & 6 deletions server/collab.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7300,11 +7300,16 @@ export async function loadCanonicalYDoc(
degradedReason: null,
};
}
const { doc, cleanup } = await getOrLoadHocuspocusDoc(slug, {
const { doc, cleanup, timedOut } = await getOrLoadHocuspocusDoc(slug, {
allowDirectConnection: options.liveRequired === true,
});
let registeredLiveDoc = getLiveHocuspocusDoc(slug);
if (!registeredLiveDoc && options.liveRequired) {
// Only wait out the registration grace when the direct connection itself did
// not time out. A stalled/timed-out direct connection establishes nothing for
// the live-doc map to register, so the bounded direct-connection timeout would
// otherwise be followed by the full (much longer) registration grace, defeating
// its purpose. If the doc is already registered, the check above returns it.
if (!registeredLiveDoc && options.liveRequired && !timedOut) {
registeredLiveDoc = await waitForLiveHocuspocusDocRegistration(slug);
}
if (registeredLiveDoc) {
Expand Down Expand Up @@ -9560,7 +9565,7 @@ type DirectConnectionLike = {
async function getOrLoadHocuspocusDoc(
slug: string,
options: { allowDirectConnection?: boolean } = {},
): Promise<{ doc: Y.Doc | null; cleanup?: () => Promise<void> }> {
): Promise<{ doc: Y.Doc | null; cleanup?: () => Promise<void>; timedOut?: boolean }> {
const existing = getLiveHocuspocusDoc(slug);
if (existing) return { doc: existing };
if (!options.allowDirectConnection) return { doc: null };
Expand Down Expand Up @@ -9621,9 +9626,9 @@ async function getOrLoadHocuspocusDoc(
}
};

if (doc && typeof (doc as any).getText === 'function') return { doc, cleanup };
if (direct) return { doc: null, cleanup };
return { doc: null };
if (doc && typeof (doc as any).getText === 'function') return { doc, cleanup, timedOut: directTimedOut };
if (direct) return { doc: null, cleanup, timedOut: directTimedOut };
return { doc: null, timedOut: directTimedOut };
}

async function waitForLiveHocuspocusDocRegistration(slug: string): Promise<Y.Doc | null> {
Expand Down