Skip to content

feat: add http cookies#235

Merged
killagu merged 1 commit intomasterfrom
feat/add-http-cookies
Sep 12, 2024
Merged

feat: add http cookies#235
killagu merged 1 commit intomasterfrom
feat/add-http-cookies

Conversation

@akitaSummer
Copy link
Contributor

@akitaSummer akitaSummer commented Sep 10, 2024 •
edited by coderabbitai bot
Loading

Checklist
  • npm test passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)
Description of change

Summary by CodeRabbit

  • New Features

    • Introduced a new Cookies decorator for handling HTTP cookie parameters.
    • Added a new class HTTPCookies for enhanced cookie management.
    • Expanded HTTP parameter handling to include cookies.

  • Bug Fixes

    • Improved robustness in cookie handling within HTTP requests.

  • Tests

    • Enhanced test cases to validate cookie handling in HTTP requests.

@coderabbitai
Copy link

coderabbitai bot commented Sep 10, 2024 •
edited
Loading

Walkthrough

The pull request introduces enhancements to the HTTP parameter handling in the project by adding support for cookies. A new Cookies decorator is implemented, allowing controllers to access cookie data. Additionally, a new HTTPCookies class wraps the cookie management functionality from the @eggjs/cookies package. The changes include updates to various files, such as the addition of a CookiesParamMeta class and modifications to existing controllers and tests to incorporate cookie handling. These updates expand the capabilities of the application regarding HTTP request management.

Changes

File Path Change Summary
core/controller-decorator/package.json Added dependency @eggjs/cookies version ^3.0.1.
core/controller-decorator/src/decorator/http/HTTPParam.ts Introduced Cookies decorator for cookie parameter handling.
core/controller-decorator/src/model/HTTPCookies.ts Added HTTPCookies class extending Cookies for enhanced cookie management.
core/controller-decorator/src/model/HTTPMethodMeta.ts Added CookiesParamMeta class and updated HTTPMethodMeta to handle cookie parameters.
core/controller-decorator/src/model/index.ts Exported HTTPCookies from the module.
core/types/controller-decorator/model/types.ts Added COOKIES to HTTPParamType enum.
plugin/controller/lib/impl/http/HTTPMethodRegister.ts Updated to handle HTTPParamType.COOKIES in request processing.
plugin/controller/test/fixtures/apps/http-inject-app/app/controller/AppController.ts Modified testRequest method to include cookies parameter.
plugin/controller/test/http/request.test.ts Enhanced tests to validate cookie handling in HTTP requests.

Sequence Diagram(s)

sequenceDiagram
    participant Controller
    participant HTTPMethodRegister
    participant HTTPCookies

    Controller->>HTTPMethodRegister: Handle HTTP Request
    HTTPMethodRegister->>HTTPCookies: Create instance for cookies
    HTTPCookies->>HTTPMethodRegister: Return cookies instance
    HTTPMethodRegister->>Controller: Pass cookies to controller method
    Controller->>Controller: Process request with cookies
Loading

🐰 In the garden where cookies bloom,
A decorator adds sweet perfume.
With HTTPCookies, we now can see,
How to handle treats with glee!
So hop along, let's celebrate,
For cookie joy, we can’t be late! 🍪✨

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fc0e4e5 and 4ead773.

Files selected for processing (9)
  • core/controller-decorator/package.json (1 hunks)
  • core/controller-decorator/src/decorator/http/HTTPParam.ts (1 hunks)
  • core/controller-decorator/src/model/HTTPCookies.ts (1 hunks)
  • core/controller-decorator/src/model/HTTPMethodMeta.ts (2 hunks)
  • core/controller-decorator/src/model/index.ts (1 hunks)
  • core/types/controller-decorator/model/types.ts (1 hunks)
  • plugin/controller/lib/impl/http/HTTPMethodRegister.ts (2 hunks)
  • plugin/controller/test/fixtures/apps/http-inject-app/app/controller/AppController.ts (2 hunks)
  • plugin/controller/test/http/request.test.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • core/controller-decorator/src/model/HTTPCookies.ts
Files skipped from review as they are similar to previous changes (8)
  • core/controller-decorator/package.json
  • core/controller-decorator/src/decorator/http/HTTPParam.ts
  • core/controller-decorator/src/model/HTTPMethodMeta.ts
  • core/controller-decorator/src/model/index.ts
  • core/types/controller-decorator/model/types.ts
  • plugin/controller/lib/impl/http/HTTPMethodRegister.ts
  • plugin/controller/test/fixtures/apps/http-inject-app/app/controller/AppController.ts
  • plugin/controller/test/http/request.test.ts

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.
    • @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 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
Copy link

socket-security bot commented Sep 10, 2024 •
edited
Loading

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

Package New capabilities Transitives Size Publisher
npm/[email protected] filesystem, network, unsafe Transitive: environment, eval, shell +60 1.61 MB fengmk2

View full report↗︎

@akitaSummer akitaSummer requested review from gxkl and killagu September 10, 2024 10:47
killagu
killagu reviewed Sep 11, 2024
View reviewed changes
@akitaSummer akitaSummer requested a review from killagu September 11, 2024 07:22
killagu
killagu approved these changes Sep 12, 2024
View reviewed changes
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

@killagu killagu merged commit f46efa5 into master Sep 12, 2024
@killagu killagu deleted the feat/add-http-cookies branch September 12, 2024 03:42
@killagu
Copy link
Contributor

killagu commented Sep 14, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@killagu killagu killagu approved these changes

@gxkl gxkl Awaiting requested review from gxkl

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@akitaSummer @killagu