Skip to content
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.

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

fix: app.mockContext() should return egg context instance #186

Merged
merged 1 commit into from
Feb 8, 2025

Conversation

fengmk2
Copy link
Member

@fengmk2 fengmk2 commented Feb 8, 2025

Summary by CodeRabbit

  • Chores
    • Upgraded a core package to a beta release, paving the way for upcoming enhancements.
  • Refactor
    • Refined internal structures for improved stability and long-term maintainability.

Copy link
Contributor

coderabbitai bot commented Feb 8, 2025

Walkthrough

This pull request updates the package version for @eggjs/mock in package.json to a beta release and refines TypeScript type management in the application extension file. The changes include switching to type-only imports, renaming a conflicting type alias, and extending the MockContext interface to incorporate two distinct context types.

Changes

File Summary
package.json Updated the @eggjs/mock version from 6.0.6 to 6.0.6-beta.3, reflecting a beta release change.
src/app/extend/application.ts Changed import statements to use the type keyword, renamed Context to EggCoreContext, added a new type import for EggContext, and updated MockContext to extend both EggContext and EggCoreContext.

Possibly related PRs

  • fix: type defines #185: Adjustments to type imports and interface structuring in the application file align with previous changes made for logging types, ensuring consistency in context usage.

Poem

In a burrow of code I delight,
Hopping through types with newfound light.
Beta versions and cleaner names set the pace,
As context and interfaces embrace in grace.
Cheers from a rabbit, coding with a smile!
(\/)\n( ••)\n/ >💻


📜 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 64173de and faf09f9.

📒 Files selected for processing (2)
  • package.json (1 hunks)
  • src/app/extend/application.ts (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • package.json
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Node.js / Test (ubuntu-latest, 22)
  • GitHub Check: Node.js / Test (ubuntu-latest, 20)
  • GitHub Check: Node.js / Test (ubuntu-latest, 18)
  • GitHub Check: Node.js / Test (macos-latest, 22)
  • GitHub Check: Node.js / Test (ubuntu-latest, 18.19.0)
  • GitHub Check: Node.js / Test (macos-latest, 18.19.0)
  • GitHub Check: Node.js / Test (macos-latest, 20)
  • GitHub Check: Node.js / Test (macos-latest, 18)
🔇 Additional comments (2)
src/app/extend/application.ts (2)

10-11: LGTM! Type-only imports improve type safety.

The change to type-only imports is a good practice as it:

  • Prevents type information from being included in the runtime bundle
  • Clearly distinguishes between value and type imports
  • Avoids naming conflicts through proper type aliasing

43-44: 🏁 Script executed:

#!/bin/bash
# Description: Find and analyze the type definitions of EggContext and EggCoreContext

# Search for Context type definitions in egg and @eggjs/core
echo "Searching for Context definitions..."
rg -A 10 "export (type |interface )?Context" 

# Search for any existing type conflicts
echo "Searching for similar type suppressions..."
rg "@ts-expect-error.*Context"

Length of output: 257

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

pkg-pr-new bot commented Feb 8, 2025

Open in Stackblitz

npm i https://pkg.pr.new/eggjs/mock/@eggjs/mock@186

commit: faf09f9

@fengmk2 fengmk2 merged commit 940f321 into master Feb 8, 2025
15 checks passed
@fengmk2 fengmk2 deleted the mockContext-extend-fix branch February 8, 2025 07:14
fengmk2 pushed a commit that referenced this pull request Feb 8, 2025
[skip ci]

## [6.0.7](v6.0.6...v6.0.7) (2025-02-08)

### Bug Fixes

* app.mockContext() should return egg context instance ([#186](#186)) ([940f321](940f321))
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.

1 participant