Skip to content

src: drain platform tasks before taking startup snapshot #56403

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

Merged
merged 2 commits into from
Jan 7, 2025
Merged

src: drain platform tasks before taking startup snapshot #56403

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4642ec5
src: drain platform tasks before creating startup snapshot
legendecas Dec 30, 2024
c1a5d20
fixup! src: drain platform tasks before creating startup snapshot
legendecas Jan 6, 2025
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
28 changes: 18 additions & 10 deletions src/node_snapshotable.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -973,25 +973,33 @@ ExitCode BuildSnapshotWithoutCodeCache(
}
});

Context::Scope context_scope(setup->context());
Environment* env = setup->env();

// Run the custom main script for fully customized snapshots.
if (snapshot_type == SnapshotMetadata::Type::kFullyCustomized) {
Context::Scope context_scope(setup->context());
Environment* env = setup->env();
#if HAVE_INSPECTOR
env->InitializeInspector({});
#endif
if (LoadEnvironment(env, builder_script_content.value()).IsEmpty()) {
return ExitCode::kGenericUserError;
}
}

// FIXME(joyeecheung): right now running the loop in the snapshot
// builder might introduce inconsistencies in JS land that need to
// be synchronized again after snapshot restoration.
ExitCode exit_code =
SpinEventLoopInternal(env).FromMaybe(ExitCode::kGenericUserError);
if (exit_code != ExitCode::kNoFailure) {
return exit_code;
}
// Drain the loop and platform tasks before creating a snapshot. This is
// necessary to ensure that the no roots are held by the the platform
// tasks, which may reference objects associated with a context. For
// example, a WeakRef may schedule an per-isolate platform task as a GC
// root, and referencing an object in a context, causing an assertion in
// the snapshot creator.

// FIXME(joyeecheung): right now running the loop in the snapshot
// builder might introduce inconsistencies in JS land that need to
// be synchronized again after snapshot restoration.
Copy link
Member

@joyeecheung joyeecheung Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// FIXME(joyeecheung): right now running the loop in the snapshot
// builder might introduce inconsistencies in JS land that need to
// be synchronized again after snapshot restoration.
// FIXME(joyeecheung): right now running the loop in the snapshot
// builder might introduce inconsistencies in JS land that need to
// be synchronized again after snapshot restoration.

This should be removed now - I remember I left it because I found some inconsistencies if this was done for the built-in snapshot. But that was quite some time ago and we probably have done enough cleanup in the bootstrap path to make it viable - if the tests are clean now, maybe it's okay to run the event loop for the built-in snapshot too now?

Copy link
Member Author

@legendecas legendecas Jan 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed.

ExitCode exit_code =
SpinEventLoopInternal(env).FromMaybe(ExitCode::kGenericUserError);
if (exit_code != ExitCode::kNoFailure) {
return exit_code;
}
}

Expand Down
Loading