Skip to content

docs(bundler): document manifest loader fs runtime#5956

Open
killagu wants to merge 1 commit into
nextfrom
agent/egg-doc/d0743594
Open

docs(bundler): document manifest loader fs runtime#5956
killagu wants to merge 1 commit into
nextfrom
agent/egg-doc/d0743594

Conversation

@killagu
Copy link
Copy Markdown
Contributor

@killagu killagu commented May 29, 2026

Summary

  • document that bundled workers create and pass ManifestLoaderFS into Egg startup
  • update the LLM wiki pages for core and egg-bundler with the manifest-backed loader FS behavior
  • add a wiki log entry for the 2026-05-30 doc sync

Verification

  • git diff --check
  • XDG_CACHE_HOME=/tmp/xdg-cache XDG_DATA_HOME=/tmp/xdg-data PNPM_HOME=/tmp/pnpm-home pnpm dlx oxfmt@0.46.0 --check tools/egg-bundler/README.md tools/egg-bundler/docs/output-structure.md wiki/log.md wiki/packages/core.md wiki/packages/egg-bundler.md

Note: pnpm run fmtcheck could not run directly before install because dependencies were absent. pnpm install --frozen-lockfile could not proceed because this checkout has no pnpm-lock.yaml and pnpm reported a frozen lockfile/config mismatch, so I ran the same formatter version via pnpm dlx on the touched files.

Summary by CodeRabbit

  • Documentation
    • Clarified how framework file discovery and module resolution work in the bundler system.
    • Updated descriptions of bundled worker initialization flow and loader filesystem behavior.
    • Added changelog entry documenting runtime changes to worker initialization.

Review Change Stack

Copilot AI review requested due to automatic review settings May 29, 2026 18:05
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4fa4b70c-6936-411f-81da-b20cbfc975e9

📥 Commits

Reviewing files that changed from the base of the PR and between b015dce and 1e571ef.

📒 Files selected for processing (5)
  • tools/egg-bundler/README.md
  • tools/egg-bundler/docs/output-structure.md
  • wiki/log.md
  • wiki/packages/core.md
  • wiki/packages/egg-bundler.md

📝 Walkthrough

Walkthrough

This PR updates documentation across bundler, core, and wiki artifacts to describe the new ManifestLoaderFS-backed initialization flow in bundled workers. Changes clarify manifest store creation, global module loader setup, and filesystem parameter passing to startEgg for manifest-first module resolution, with framework specifier and LoaderFS abstraction details.

Changes

ManifestLoaderFS Worker Initialization Documentation

Layer / File(s) Summary
Bundler documentation — worker initialization flow
tools/egg-bundler/README.md, tools/egg-bundler/docs/output-structure.md
README clarifies framework file discovery through Egg's manifest-backed loader filesystem. Output-structure doc replaces worker entry description to detail building ManifestStore, initializing globalThis.__EGG_BUNDLE_MODULE_LOADER__, creating ManifestLoaderFS, and passing it to startEgg; updates explanation of framework vs. runtime specifier lookup and bundle-map keying strategy.
Core package LoaderFS documentation — abstraction and ManifestLoaderFS
wiki/packages/core.md
Source files metadata updated to include packages/core/src/loader/loader_fs.ts. LoaderFS section expanded to state @eggjs/core re-exports LoaderFS/RealLoaderFS from @eggjs/loader-fs and introduces ManifestLoaderFS implementation. Additional documentation describes how custom loaderFS options pass through EggLoader into loadToApp()/loadToContext(), and how manifest-backed ManifestLoaderFS serves modules via globalThis.__EGG_BUNDLE_MODULE_LOADER__ for readJSON()/loadFile().
Wiki changelog and egg-bundler package documentation — runtime metadata and behavior tracking
wiki/log.md, wiki/packages/egg-bundler.md
New wiki log entry (2026-05-30) documents runtime change: bundled workers construct ManifestLoaderFS from bundled manifest and pass it to startEgg for bundle-map-first module resolution with real filesystem fallback. Egg-bundler package wiki bumps updated_at metadata and rewrites Current Behavior section to explicitly include ManifestLoaderFS creation and loaderFS passing into startup.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • eggjs/egg#5944: Implements the ManifestLoaderFS construction and loaderFS parameter passing into bundled worker startup that this PR documents.
  • eggjs/egg#5943: Implements the ManifestLoaderFS and its wiring into EggLoader for manifest-backed loading described in this PR's core package documentation.
  • eggjs/egg#5936: Introduces and threads the LoaderFS abstraction through EggLoader, FileLoader, and ContextLoader that this PR documents in the core package wiki.

Suggested reviewers

  • fengmk2
  • jerryliang64

Poem

🐰 A bundle of docs, so crisp and so clean,
ManifestLoaderFS now takes the scene,
With loaderFS passed where startEgg awaits,
Through manifest maps at resolving gates,
Knowledge bundled up, for all to see!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the primary change: documentation updates across multiple files about the manifest-backed loader filesystem runtime behavior in the bundler.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/egg-doc/d0743594

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation across several files (including READMEs, guides, and wiki logs) to reflect the introduction of the manifest-backed loader filesystem (ManifestLoaderFS) in the Egg bundler runtime. The documentation now details how the bundled worker entry creates a ManifestLoaderFS from the startup manifest and passes it to startEgg to handle file discovery and module loading. There are no review comments to address, and no further feedback is required.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying egg with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1e571ef
Status: ✅  Deploy successful!
Preview URL: https://54854dcd.egg-cci.pages.dev
Branch Preview URL: https://agent-egg-doc-d0743594.egg-cci.pages.dev

View logs

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Documents the current bundled-worker runtime behavior in @eggjs/egg-bundler and @eggjs/core, specifically that bundled workers now construct a ManifestLoaderFS from the bundled startup manifest and pass it into Egg startup so loader filesystem operations can be served from manifest/bundle-map data with real-FS fallback.

Changes:

  • Update bundler docs to describe creating ManifestStore + ManifestLoaderFS and passing loaderFS into startEgg(...).
  • Update the core wiki page to document ManifestLoaderFS as the manifest-backed bundled-runtime LoaderFS implementation and how it interacts with __EGG_BUNDLE_MODULE_LOADER__.
  • Add a wiki log entry for the 2026-05-30 doc sync and update wiki page updated_at metadata.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
wiki/packages/egg-bundler.md Updates the wiki description of bundled worker startup to include ManifestLoaderFS being created and passed into Egg startup.
wiki/packages/core.md Documents ManifestLoaderFS as part of the LoaderFS surface and describes how it serves reads from manifest + bundle loader before fallback.
wiki/log.md Adds a 2026-05-30 entry recording the doc sync and the manifest-backed loader FS runtime behavior.
tools/egg-bundler/README.md Clarifies that runtime file discovery/module loading is served through Egg’s manifest-backed loader filesystem.
tools/egg-bundler/docs/output-structure.md Expands the runtime description to explicitly include ManifestStore + ManifestLoaderFS creation and passing loaderFS to startEgg.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying egg-v3 with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1e571ef
Status: ✅  Deploy successful!
Preview URL: https://85829f58.egg-v3.pages.dev
Branch Preview URL: https://agent-egg-doc-d0743594.egg-v3.pages.dev

View logs

Comment thread wiki/log.md

Dates use the workspace-local Asia/Shanghai calendar date.

## [2026-05-30] package | document manifest-backed loader fs runtime
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

这个 log.md 是有什么神奇的用途吗?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants