eggjs / tegg

Strong Type framework with eggjs.
MIT License
240 stars 35 forks source link

feat: add HTTPHeaders decorator #208

Closed fengmk2 closed 7 months ago

fengmk2 commented 7 months ago
async foo(@HTTPHeaders headers: IncomingHttpHeaders) {
  console.log(headers);
}

Summary by CodeRabbit

coderabbitai[bot] commented 7 months ago

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 b06f900f3b255b0f2488942815f60a3b8017093c and b6df0b7cbfc2b0a2044f9289d2a572164749c1d1.
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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.