Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 34 additions & 0 deletions packages/devtools/src/__tests__/ngrx-collector.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1175,6 +1175,40 @@ describe('ngrx collector with Store DevTools', () => {
}
});

it('resends the held log when the server forgot the page', async () => {
const { store, ng } = setupDevtools();
const pages: NgrxPages = new Map();
const my = {
rpc: {
call: async (name: string, report: unknown) => {
if (name === 'forget-ngrx-page') return void pages.delete(report as string);
if (name !== 'push-ngrx-state') return undefined;
return { seq: mergeNgrxReport(pages, report as NgrxPageReport, []) };
},
register: () => {},
},
};
const overlay = attachNgrx(my, 'p1', () => ng as any);
const seqs = () => ngrxStateOf(pages).pages[0]?.log.map((e) => e.seq);
try {
await overlay.push();
store.dispatch({ type: 'inc' });
store.dispatch({ type: 'inc' });
await overlay.push();
expect(seqs()).toEqual([1, 2]);
overlay.leave();
await Promise.resolve();
expect(pages.size).toBe(0);
store.dispatch({ type: 'inc' });
await overlay.push();
await overlay.push();
expect(seqs()).toEqual([1, 2, 3]);
expect(ngrxStateOf(pages).pages[0].dropped).toBe(0);
} finally {
overlay.stop();
}
});

it('does not call a restore to the newest action paused', () => {
const { store, collector } = setupDevtools();
store.dispatch({ type: 'inc' });
Expand Down
7 changes: 7 additions & 0 deletions packages/devtools/src/ngrx-overlay.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,19 @@ export function attachNgrx<H extends object = Element>(
stores,
classic,
log,
since: sentSeq,
...(lost.updates.length ? { unrestorable: lost.updates } : {}),
};
const answer = (await my.rpc.call('push-ngrx-state', report)) as
{ seq?: unknown } | undefined;
const previous = sentSeq;
sentSeq = typeof answer?.seq === 'number' ? answer.seq : collector.lastSeq();
sentLost = lost.last;
// A lower seq means the server lost this page: resend the held log.
if (sentSeq < previous) {
sentLost = 0;
schedule();
}
} catch {
return;
} finally {
Expand Down
2 changes: 2 additions & 0 deletions packages/devtools/src/ngrx-shared.ts
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ export interface NgrxPageReport {
stores: NgrxSignalStoreInfo[];
classic: NgrxClassicStoreInfo | null;
log: NgrxLogEntry[];
/** The newest seq the server confirmed before this report; `log` holds only later entries. */
since?: number;
/** Entries sent earlier that Store DevTools can no longer restore. */
unrestorable?: NgrxUnrestorableUpdate[];
}
Expand Down
9 changes: 7 additions & 2 deletions packages/devtools/src/rpc/ngrx-tools.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,14 @@ export function mergeNgrxReport(
maxLog = MAX_LOG,
): number {
const previous = pages.get(report.pageId);
const keep = previous && previous.session === report.session ? previous.log : [];
const known = previous?.session === report.session;
const keep = known ? previous.log : [];
const lastSeq = keep.at(-1)?.seq ?? 0;
const fresh = report.log.filter((entry: NgrxLogEntry) => entry.seq > lastSeq);
// The page only sends entries after `since`; if this server forgot the page
// (forget-ngrx-page, expiry, restart), drop the partial log and answer 0 so
// the page resends everything it still holds.
const resync = !known && typeof report.since === 'number' && report.since > 0;
const fresh = resync ? [] : report.log.filter((entry: NgrxLogEntry) => entry.seq > lastSeq);
const lost = new Map<number, NgrxUnrestorable>();
for (const update of Array.isArray(report.unrestorable) ? report.unrestorable : []) {
if (typeof update?.seq === 'number' && UNRESTORABLE.has(update.reason)) {
Expand Down
Loading