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: support simple test on normal app #179

Merged
merged 5 commits into from
Dec 29, 2024
Merged

Conversation

fengmk2
Copy link
Member

@fengmk2 fengmk2 commented Dec 29, 2024

Summary by CodeRabbit

  • New Features

    • Added "PRs Welcome" badge to README files.
    • Added Node.js version badge to Chinese README.
    • Introduced a simple GET route in the new "helloworld" application.
    • Established basic configuration for the "helloworld" application.
    • Created a new package.json for the "helloworld" application.
    • Added a test suite for validating the bootstrap functionality of the "helloworld" application.
  • Documentation

    • Updated README files with project badges.
  • Chores

    • Modified test configurations for ESM support.
    • Updated import paths in type definition files.
    • Created a new test fixture application "helloworld".
  • Refactor

    • Removed src/index.d.ts type definitions.
    • Updated src/bootstrap.ts to export app instance.
    • Modified src/lib/app_handler.ts to ensure app return.
    • Refactored test cases in test/app.test.ts for improved readability and maintainability.
    • Updated test suite in test/app_proxy.test.ts to run all tests.

Copy link
Contributor

coderabbitai bot commented Dec 29, 2024

Warning

Rate limit exceeded

@fengmk2 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 56 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 00e6c22 and 14ef0e0.

📒 Files selected for processing (1)
  • .github/workflows/nodejs.yml (1 hunks)

Walkthrough

This pull request introduces several modifications to the @eggjs/mock library, focusing on enhancing the project's documentation, testing infrastructure, and module structure. The changes include adding badges to README files, updating the bootstrap mechanism to export the application instance, removing type definition files, modifying test configurations, and creating a new sample application fixture for testing ESM (ECMAScript Module) compatibility.

Changes

File Change Summary
README.md Added "PRs Welcome" badge
README.zh_CN.md Added Node.js version and "PRs Welcome" badges
src/bootstrap.ts Modified setupApp() to return and export app instance
src/index.d.ts Deleted type definition file
src/lib/app_handler.ts Updated setupApp() function signature to return ApplicationUnittest
test/app_proxy.test.ts Removed .only from test suite descriptor
test/bootstrap.test.ts Replaced existing tests with a new ESM application test
test/fixtures/apps/helloworld/ Added new fixture application with router, config, and test files
test/index.test-d.ts Updated import paths to reference ../src/ directory
test/app.test.ts Refactored tests to use async/await for error handling
package.json Removed "egg-bin": "beta" from devDependencies

Poem

🐰 A Mock's New Dance
In Egg.js realm, a rabbit's glee,
Badges shine, modules run free!
Bootstrap returns, types take flight,
ESM dances with pure delight! 🎉
Mock on, brave code, your journey's bright! 🚀


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 Dec 29, 2024

Open in Stackblitz

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

commit: 14ef0e0

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
test/fixtures/apps/helloworld/app/router.js (1)

1-7: Looks good – consider adding error handling or logging for more robust routing.
This simple GET endpoint works as intended and returns a JSON response. However, you may want to handle potential errors or unexpected inputs to safeguard against silent failures and facilitate debugging in more complex scenarios.

test/fixtures/apps/helloworld/test/helloworld.test.js (1)

1-11: Consider asserting the HTTP status code in addition to the response body.
Although validating the response body is good, including a status code assertion ensures that the server returns a valid success code.

 .expect({
   hello: 'world',
 })
+.expect(200)
test/bootstrap.test.ts (1)

7-20: Debug might yield noisy logs.
The .debug() call can produce verbose logs, which may be valuable during development but disruptive in CI or production environments. Consider removing it or using it conditionally.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 45a34bd and 6f85b2c.

📒 Files selected for processing (12)
  • README.md (1 hunks)
  • README.zh_CN.md (1 hunks)
  • src/bootstrap.ts (1 hunks)
  • src/index.d.ts (0 hunks)
  • src/lib/app_handler.ts (1 hunks)
  • test/app_proxy.test.ts (1 hunks)
  • test/bootstrap.test.ts (1 hunks)
  • test/fixtures/apps/helloworld/app/router.js (1 hunks)
  • test/fixtures/apps/helloworld/config/config.default.js (1 hunks)
  • test/fixtures/apps/helloworld/package.json (1 hunks)
  • test/fixtures/apps/helloworld/test/helloworld.test.js (1 hunks)
  • test/index.test-d.ts (1 hunks)
💤 Files with no reviewable changes (1)
  • src/index.d.ts
✅ Files skipped from review due to trivial changes (6)
  • test/fixtures/apps/helloworld/package.json
  • README.zh_CN.md
  • test/fixtures/apps/helloworld/config/config.default.js
  • test/app_proxy.test.ts
  • README.md
  • test/index.test-d.ts
🔇 Additional comments (2)
src/bootstrap.ts (1)

16-16: Exporting the app instance is a helpful addition.
Enabling other modules or tests to consume this app instance is a good approach. Ensure you also handle the app’s lifecycle properly (e.g., listening, closing) if used in broader contexts.

Also applies to: 21-21

src/lib/app_handler.ts (1)

49-49: Ensuring a consistent return value improves reliability.

Adding a return app statement at the end of setupApp ensures the function returns an instance regardless of which branch is taken, improving predictability for callers. This is an effective change.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
test/app.test.ts (1)

93-97: Refactor test to ensure consistent resource cleanup

If the assertion fails or the error message does not match expectations, the test will not call app.close(). Consider wrapping the app.ready() call in a try/catch/finally block so that app.close() always executes, ensuring consistent resource cleanup:

 it('should emit error when load Application fail', async () => {
   const baseDir = getFixtures('app-fail');
   const app = mm.app({ baseDir, cache: false });
-  await assert.rejects(app.ready(), /load error/);
-  await app.close();
+  try {
+    await assert.rejects(app.ready(), /load error/);
+  } finally {
+    await app.close();
+  }
 });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6f85b2c and 1e72b15.

📒 Files selected for processing (1)
  • test/app.test.ts (1 hunks)

Copy link

codecov bot commented Dec 29, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 57.34%. Comparing base (674b1ca) to head (14ef0e0).
Report is 3 commits behind head on master.

Files with missing lines Patch % Lines
src/lib/app_handler.ts 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #179      +/-   ##
==========================================
+ Coverage   49.54%   57.34%   +7.79%     
==========================================
  Files          21       21              
  Lines        2430     2431       +1     
  Branches       64      191     +127     
==========================================
+ Hits         1204     1394     +190     
+ Misses       1226     1037     -189     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@fengmk2 fengmk2 merged commit 3b0957f into master Dec 29, 2024
12 of 13 checks passed
@fengmk2 fengmk2 deleted the support-getBootstrapApp branch December 29, 2024 06:30
fengmk2 pushed a commit that referenced this pull request Dec 29, 2024
[skip ci]

## [6.0.1](v6.0.0...v6.0.1) (2024-12-29)

### Bug Fixes

* support simple test on normal app ([#179](#179)) ([3b0957f](3b0957f))
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