docs(wiki): sync bundled runtime support notes#5929
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (3)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds and updates wiki documentation: new package pages for ChangesWiki documentation and metadata
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Deploying egg with
|
| Latest commit: |
191dfed
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5ec29d11.egg-cci.pages.dev |
| Branch Preview URL: | https://agent-egg-doc-e3a2c930.egg-cci.pages.dev |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the project's wiki by adding documentation for the Onerror Plugin and Utils Package, and updating the Egg Bundler documentation. These updates detail the implementation of local error handling to support static bundling and the mechanism for shared module loading. Feedback was provided to ensure the documentation for the Onerror Plugin accurately reflects the configuration keys used in the source code, specifically regarding JSONP support.
| # Onerror Plugin | ||
|
|
||
| `@eggjs/onerror` is the default Egg error-handling plugin. It installs | ||
| `ctx.onerror` and supports configurable handlers for HTML, text, JSON, JSONP, |
There was a problem hiding this comment.
The implementation in plugins/onerror/src/lib/onerror.ts uses the key js for JSONP support. It is better to refer to it as JS (JSONP) to align with the code while maintaining the conceptual name.
| `ctx.onerror` and supports configurable handlers for HTML, text, JSON, JSONP, | |
| `ctx.onerror` and supports configurable handlers for HTML, text, JSON, JS (JSONP), |
|
|
||
| - `errorPageUrl` redirects production HTML requests after unexpected errors. | ||
| - `accepts` customizes content negotiation. | ||
| - `all`, `html`, `text`, `json`, and `jsonp` customize response handling for |
There was a problem hiding this comment.
The configuration key used in the OnerrorOptions interface and the content negotiation logic in plugins/onerror/src/lib/onerror.ts is js, not jsonp. This should be updated to match the implementation to avoid configuration errors.
| - `all`, `html`, `text`, `json`, and `jsonp` customize response handling for | |
| - `all`, `html`, `text`, `json`, and `js` customize response handling for |
There was a problem hiding this comment.
Pull request overview
This PR updates the repository wiki to document recently discovered “bundled runtime support” behaviors across @eggjs/utils, @eggjs/onerror, and @eggjs/egg-bundler, and records the update in the wiki change log.
Changes:
- Add new wiki package pages for
@eggjs/utils(bundled module-loader hook behavior) and@eggjs/onerror(localonerror()implementation rationale). - Update the Egg Bundler wiki page metadata to include
ExternalsResolver.ts. - Append a new entry to
wiki/log.mdand link the new package pages fromwiki/index.md.
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/utils.md | New wiki page describing @eggjs/utils public surfaces and bundled module-loading behavior. |
| wiki/packages/onerror.md | New wiki page describing @eggjs/onerror configuration and local error handler implementation details. |
| wiki/packages/egg-bundler.md | Adds ExternalsResolver.ts to wiki “source_files” metadata and updates updated_at. |
| wiki/log.md | Adds a new wiki log entry for the bundled runtime support documentation update. |
| wiki/index.md | Links the newly added onerror and utils wiki pages from the package index. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@wiki/log.md`:
- Line 3: Update the log entry date on the second line in wiki/log.md from
"2026-05-06" to the actual PR date "2026-05-05" (or alternatively add an
explicit note that dates are UTC) so the entry aligns with the PR timestamp and
avoids a future-dated record; locate the string "## [2026-05-06] package | sync
bundled runtime support changes" and replace the date portion or append a UTC
dating note to that header.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 28375593-8baf-448b-80e2-7df4297dd853
📒 Files selected for processing (5)
wiki/index.mdwiki/log.mdwiki/packages/egg-bundler.mdwiki/packages/onerror.mdwiki/packages/utils.md
| @@ -1,5 +1,11 @@ | |||
| # Wiki Log | |||
|
|
|||
| ## [2026-05-06] package | sync bundled runtime support changes | |||
There was a problem hiding this comment.
Use a non-future log date to avoid chronology drift.
Line 3 records 2026-05-06, but this PR is dated 2026-05-05 (2026-05-05T18:06:51Z). Please align to the actual entry date (or explicitly document UTC-based dating) so the log and package updated_at fields don’t appear future-dated.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@wiki/log.md` at line 3, Update the log entry date on the second line in
wiki/log.md from "2026-05-06" to the actual PR date "2026-05-05" (or
alternatively add an explicit note that dates are UTC) so the entry aligns with
the PR timestamp and avoids a future-dated record; locate the string "##
[2026-05-06] package | sync bundled runtime support changes" and replace the
date portion or append a UTC dating note to that header.
Deploying egg-v3 with
|
| Latest commit: |
191dfed
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4315a9aa.egg-v3.pages.dev |
| Branch Preview URL: | https://agent-egg-doc-e3a2c930.egg-v3.pages.dev |
Summary
@eggjs/utilsbundled module-loader behavior and@eggjs/onerrorlocal error handler implementation.Validation
git diff --checkpnpm exec oxfmt --check wiki/index.md wiki/log.md wiki/packages/egg-bundler.md wiki/packages/utils.md wiki/packages/onerror.mdNote:
pnpm install --no-frozen-lockfilewas needed in this fresh worktree to makeoxfmtavailable. The markdown-only pre-commit hook was bypassed becauseoxlint --type-aware --fixexits withNo files found to lintfor this docs-only file set.Summary by CodeRabbit