feat: support trace method request #4

fengmk2 · 2025-01-17T13:53:44Z

Summary by CodeRabbit

New Features
- Added support for HTTP TRACE method in the testing framework
- Expanded request handling capabilities for TRACE requests
Dependency Updates
- Updated @arethetypeswrong/cli to version ^0.17.3
- Added @eggjs/bin version 7
- Removed egg-bin version 6

coderabbitai · 2025-01-17T13:53:52Z

Walkthrough

This pull request introduces support for the HTTP TRACE method across the library. The changes involve updating package dependencies, adding a new trace method to both the TestAgent and Request classes in the source code, and implementing corresponding test cases to verify the TRACE method functionality in an Express application. The modifications expand the library's capabilities to handle TRACE requests for debugging and diagnostic purposes.

Changes

File	Changes
`package.json`	- Updated `@arethetypeswrong/cli` from `^0.17.1` to `^0.17.3` - Added new dependency `@eggjs/bin` (version 7) - Removed `egg-bin` dependency (version 6)
`src/agent.ts`	- Added `trace(url: string)` method to `TestAgent` class
`src/request.ts`	- Added `trace(url: string)` method to `Request` class
`test/supertest.test.ts`	- Added TRACE method implementation for Express app - Added test case for TRACE method functionality

Sequence Diagram

sequenceDiagram
    participant Client
    participant SuperTest
    participant ExpressApp
    Client->>SuperTest: trace('/')
    SuperTest->>ExpressApp: TRACE request
    ExpressApp-->>SuperTest: Respond with 'trace method'
    SuperTest-->>Client: Return response

Poem

🐰 A Rabbit's Ode to TRACE 🕵️

With TRACE, we hop and debug with grace,
A method that leaves no request to chase,
From agent to request, we've added might,
Tracing paths with technological delight!

Hop hop hooray! 🚀

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.

socket-security · 2025-01-17T13:54:09Z

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@eggjs/[email protected]	environment Transitive: eval, filesystem, shell, unsafe	`+229`	21.3 MB	fengmk2

View full report↗︎

pkg-pr-new · 2025-01-17T13:54:44Z

Open in Stackblitz

npm i https://pkg.pr.new/eggjs/supertest/@eggjs/supertest@4

commit: 0056ca2

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (2)

test/supertest.test.ts (2)

207-217: Consider adding more test scenarios.

While the basic TRACE functionality is tested, consider adding tests for:

Error responses (4xx, 5xx)

Headers specific to TRACE method

Request with body (should be ignored as per HTTP spec)

1093-1096: Consider adding more agent-specific test scenarios.

While the basic agent functionality is tested, consider adding tests for:

TRACE with custom headers

TRACE with different content types

Error handling scenarios

Also applies to: 1126-1130

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 732b13c and 0056ca2.

📒 Files selected for processing (4)

package.json (1 hunks)
src/agent.ts (1 hunks)
src/request.ts (1 hunks)
test/supertest.test.ts (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (5)

GitHub Check: Node.js / Test (windows-latest, 23)
GitHub Check: Node.js / Test (windows-latest, 22)
GitHub Check: Node.js / Test (windows-latest, 20)
GitHub Check: Node.js / Test (windows-latest, 18.19.0)
GitHub Check: Node.js / Test (windows-latest, 18)

🔇 Additional comments (2)

src/request.ts (1)

59-61: LGTM! Implementation follows established patterns.

The trace method implementation is consistent with other HTTP methods in the class, correctly delegating to _testRequest with the uppercase method name.

src/agent.ts (1)

86-88: LGTM! Implementation follows established patterns.

The trace method implementation is consistent with other HTTP methods in the class, correctly delegating to _testRequest with uppercase method name.

package.json

[skip ci] ## [8.2.0](v8.1.1...v8.2.0) (2025-01-17) ### Features * support trace method request ([#4](#4)) ([1e3d92b](1e3d92b))

codecov · 2025-01-17T13:59:14Z

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

feat: support trace method request

0056ca2

coderabbitai bot reviewed Jan 17, 2025

View reviewed changes

package.json Show resolved Hide resolved

fengmk2 merged commit 1e3d92b into master Jan 17, 2025
22 checks passed

fengmk2 deleted the support-trace-method branch January 17, 2025 13:57

fengmk2 pushed a commit that referenced this pull request Jan 17, 2025

Release 8.2.0

71cc1da

[skip ci] ## [8.2.0](v8.1.1...v8.2.0) (2025-01-17) ### Features * support trace method request ([#4](#4)) ([1e3d92b](1e3d92b))

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support trace method request #4

feat: support trace method request #4

fengmk2 commented Jan 17, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 17, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

socket-security bot commented Jan 17, 2025

pkg-pr-new bot commented Jan 17, 2025

coderabbitai bot left a comment

codecov bot commented Jan 17, 2025

feat: support trace method request #4

feat: support trace method request #4

Conversation

fengmk2 commented Jan 17, 2025 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Jan 17, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram

Poem

Finishing Touches

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

socket-security bot commented Jan 17, 2025

pkg-pr-new bot commented Jan 17, 2025

coderabbitai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Jan 17, 2025

Welcome to Codecov 🎉

fengmk2 commented Jan 17, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 17, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)