Skip to content

fix(core): clean up event contract once hydration is done #58174

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

Closed
arturovt wants to merge 1 commit into from
Closed

fix(core): clean up event contract once hydration is done #58174

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
49 changes: 31 additions & 18 deletions packages/core/src/hydration/event_replay.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ import {
import {APP_ID} from '../application/application_tokens';
import {performanceMarkFeature} from '../util/performance';
import {triggerHydrationFromBlockName} from '../defer/triggering';
import {isIncrementalHydrationEnabled} from './utils';

/** Apps in which we've enabled event replay.
* This is to prevent initializing event replay more than once per app.
Expand Down Expand Up @@ -120,28 +121,40 @@ export function withEventReplay(): Provider[] {
const injector = inject(Injector);
const appRef = inject(ApplicationRef);
return () => {
if (!shouldEnableEventReplay(injector)) {
return;
}

// We have to check for the appRef here due to the possibility of multiple apps
// being present on the same page. We only want to enable event replay for the
// apps that actually want it.
if (!appsWithEventReplay.has(appRef)) {
appsWithEventReplay.add(appRef);
appRef.onDestroy(() => appsWithEventReplay.delete(appRef));

// Kick off event replay logic once hydration for the initial part
// of the application is completed. This timing is similar to the unclaimed
// dehydrated views cleanup timing.
whenStable(appRef).then(() => {
const eventContractDetails = injector.get(JSACTION_EVENT_CONTRACT);
initEventReplay(eventContractDetails, injector);
const jsActionMap = injector.get(JSACTION_BLOCK_ELEMENT_MAP);
jsActionMap.get(EAGER_CONTENT_LISTENERS_KEY)?.forEach(removeListeners);
jsActionMap.delete(EAGER_CONTENT_LISTENERS_KEY);
});
if (!shouldEnableEventReplay(injector) || appsWithEventReplay.has(appRef)) {
return;
}

appsWithEventReplay.add(appRef);
appRef.onDestroy(() => appsWithEventReplay.delete(appRef));

// Kick off event replay logic once hydration for the initial part
// of the application is completed. This timing is similar to the unclaimed
// dehydrated views cleanup timing.
whenStable(appRef).then(() => {
const eventContractDetails = injector.get(JSACTION_EVENT_CONTRACT);
initEventReplay(eventContractDetails, injector);
const jsActionMap = injector.get(JSACTION_BLOCK_ELEMENT_MAP);
jsActionMap.get(EAGER_CONTENT_LISTENERS_KEY)?.forEach(removeListeners);
jsActionMap.delete(EAGER_CONTENT_LISTENERS_KEY);

const eventContract = eventContractDetails.instance!;
// This removes event listeners registered through the container manager,
// as listeners registered on `document.body` might never be removed if we
// don't clean up the contract.
if (isIncrementalHydrationEnabled(injector)) {
// When incremental hydration is enabled, we cannot clean up the event
// contract immediately because we're unaware if there are any deferred
// blocks to hydrate. We can only schedule a contract cleanup when the
// app is destroyed.
appRef.onDestroy(() => eventContract.cleanUp());
} else {
eventContract.cleanUp();
}
});
};
},
multi: true,
Expand Down