fix: export Router Class

[fengmk2]

Summary by CodeRabbit

• New Features

  • Introduced explicit export of the Router class from @eggjs/router.
  • Enhanced lifecycle management with new methods in the EggCore class.

• Bug Fixes

  • Updated dependency version for @eggjs/koa, potentially addressing minor issues.

• Documentation

  • Added deprecation warnings for certain methods in the EggCore class to guide users on best practices.

[coderabbitai]

Walkthrough

The pull request introduces updates to the @eggjs/core package, focusing on enhancing the EggCore class in src/egg.ts and updating the @eggjs/koa dependency version. The changes include explicit export of the Router class, modifications to type definitions, and improvements to lifecycle management methods. The package.json file sees a minor version bump for the @eggjs/koa dependency, indicating potential bug fixes or minor improvements.

Changes

File	Change Summary
package.json	Updated @eggjs/koa dependency from ^2.20.1 to ^2.20.2
src/egg.ts	- Exported Router class from @eggjs/router - Redefined ContextDelegation type - Updated MiddlewareFunc type - Added private #router and #closePromise properties to EggCore - Modified lifecycle management methods with deprecation warnings

Sequence Diagram

sequenceDiagram
    participant App as EggCore
    participant Router as Router
    participant Middleware as Middleware

    App->>Router: Initialize router
    App->>Middleware: Register middleware
    App->>App: Lifecycle management
    App->>App: beforeStart()
    App->>App: ready()
    App->>App: close()

Loading

Poem

🐰 A Rabbit's Ode to Egg Core's Glow 🥚

Koa's version bumped, a tiny leap,
Router dancing, middleware's keep,
Lifecycle methods sing their song,
EggCore grows mighty, nothing wrong!

Hop, hop, hooray! 🎉

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 09a0c39 and d7be5a1.

📒 Files selected for processing (2)

• package.json (1 hunks)
• src/egg.ts (1 hunks)

🔇 Additional comments (2)

src/egg.ts (1)

40-40: Exporting Router explicitly is consistent and beneficial.

Exporting the Router here makes it easily accessible to consumers without requiring them to import from "@eggjs/router" directly. This aligns with the convention of exporting all relevant classes from a single entry point.

package.json (1)

38-38: Dependency version update verification.

The bump from "^2.20.1" to "^2.20.2" for "@eggjs/koa" seems minor, suggesting bug fixes or small improvements. Verify that no breaking changes impact integration with the newly exported Router.

Use the following script to search for usage of Koa APIs and confirm compatibility with the updated version:

✅ Verification successful

Let me gather more information about the specific version changes.

---

Version update from 2.20.1 to 2.20.2 is safe to proceed

The update only includes a bug fix that makes the Context state property overridable by Sub Class, which doesn't affect Router integration. The change is backward compatible and improves type flexibility. No breaking changes were introduced that would impact the Router functionality.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: scanning the codebase for references to @eggjs/koa to confirm no new breakages
rg '@eggjs/koa' -A 10

Length of output: 3656

---

Script:

#!/bin/bash
# Check the changelog or release notes for @eggjs/koa v2.20.2
gh release view v2.20.2 --repo eggjs/koa || true

# Check git history for any recent changes related to Router integration
rg -l "Router|router" --type ts

Length of output: 1185

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/eggjs/core/@eggjs/core@277

commit: d7be5a1