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

feat: add HTTPHeaders decorator #208

Merged
merged 2 commits into from
Apr 15, 2024
Merged

feat: add HTTPHeaders decorator #208

merged 2 commits into from
Apr 15, 2024

Conversation

fengmk2
Copy link
Member

@fengmk2 fengmk2 commented Apr 13, 2024

async foo(@HTTPHeaders headers: IncomingHttpHeaders) {
  console.log(headers);
}

Summary by CodeRabbit

  • New Features

    • Introduced handling of HTTP headers in the application, enabling methods to access and utilize header information directly.
  • Bug Fixes

    • Enhanced parameter handling in HTTP methods to support headers, improving the robustness and functionality of the application.
  • Tests

    • Added new test cases to verify the correct handling of HTTP headers parameters.

```ts
async foo(@HTTPHeaders headers: IncomingHttpHeaders) {
  console.log(headers);
}
```
@fengmk2 fengmk2 requested review from killagu and gxkl April 13, 2024 04:54
@fengmk2 fengmk2 added the enhancement New feature or request label Apr 13, 2024
Copy link

coderabbitai bot commented Apr 13, 2024

Walkthrough

The recent updates focus on enhancing the handling of HTTP headers within the controller decorator framework. Key modifications include the introduction of a new HeadersParamMeta class for managing header parameters, updating import statements, and adding support for the HEADERS type in HTTP parameter processing. These changes streamline header management across various components of the framework, improving both functionality and code organization.

Changes

Files Changes
.../HTTPParam.ts, .../HTTPInfoUtil.ts, .../decorators.test.ts, .../params.test.ts Updated import statements, added support and handling for HTTP headers.
.../HTTPMethodMeta.ts, .../types.ts, .../HTTPMethodRegister.ts, .../AppController.ts Introduced HeadersParamMeta class, added HEADERS to HTTPParamType, and integrated headers parameter handling in method signatures and utility functions.
.../HTTPFooController.ts Added IncomingHttpHeaders import and HTTPHeaders decorator to methods.

🐰✨
Code hops through the gates,
Headers fly, neatly in place.
A rabbit's touch, so deft and wise,
Now the web, through headers, spies.
Celebrate, for the code does leap! 🎉
🐇💻


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b06f900 and b6df0b7.
Files selected for processing (1)
  • core/controller-decorator/test/http/HTTPMeta.test.ts (2 hunks)
Additional comments not posted (2)
core/controller-decorator/test/http/HTTPMeta.test.ts (2)

15-15: The addition of HeadersParamMeta aligns well with the PR's objectives to enhance HTTP headers handling. Good job on maintaining clean import organization.


23-23: Updating the describe block to include the full path is a thoughtful change that enhances clarity in test reporting.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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
Contributor

@killagu killagu left a comment

Choose a reason for hiding this comment

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

LGTM

@fengmk2 fengmk2 merged commit 4678c45 into master Apr 15, 2024
11 checks passed
@fengmk2 fengmk2 deleted the add-HTTPHeaders branch April 15, 2024 02:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants