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: normalize put route #124

Merged
merged 2 commits into from
Jul 11, 2024
Merged

fix: normalize put route #124

merged 2 commits into from
Jul 11, 2024

Conversation

palozano
Copy link
Contributor

@palozano palozano commented Jul 11, 2024

Following this comment, added a middleware to normalize the path of the route.


This change is Reviewable

Summary by CodeRabbit

  • New Features
    • Improved request handling by normalizing paths before routing, enhancing path consistency and reliability.

Following [this comment](#123 (review)),
added a middleware to normalize the path of the route.
@palozano palozano requested a review from dndll as a code owner July 11, 2024 10:00
Copy link

coderabbitai bot commented Jul 11, 2024

Walkthrough

The recent changes in bin/sidecar involve upgrading the tower-http dependency to version 0.4 and introducing the NormalizePathLayer to the router. This enhancement normalizes request paths before routing, ensuring consistent path handling. Additionally, a new tower dependency was added at version 0.4.

Changes

File Change Summary
bin/sidecar/Cargo.toml Upgraded tower-http to 0.4 and added normalize-path feature; added tower at version 0.4.
bin/sidecar/src/main.rs Introduced NormalizePathLayer from tower_http for path normalization before routing requests.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Router
    participant NormalizePathLayer
    participant Service

    Client->>Router: HTTP Request
    Router->>NormalizePathLayer: Apply NormalizePathLayer
    NormalizePathLayer->>Router: Normalized Path
    Router->>Service: Forward Request
    Service->>Router: Response
    Router->>Client: HTTP Response
Loading

Poem

Amid the code, a rabbit hops,
To normalize paths, it never stops.
Routing is now clear and bright,
With tower's power, we take flight.
Upgraded paths, requests align,
In HTTP, our code does shine.


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 as 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.

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

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between de9ed25 and 58c64dc.

Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
Files selected for processing (2)
  • bin/sidecar/Cargo.toml (1 hunks)
  • bin/sidecar/src/main.rs (3 hunks)
Additional comments not posted (4)
bin/sidecar/Cargo.toml (1)

22-23: Dependencies update approved.

The addition of tower and the update of tower-http with the normalize-path feature are appropriate for the middleware implementation.

bin/sidecar/src/main.rs (3)

18-21: Imports approved.

The imports for tower::Layer and tower_http::normalize_path::NormalizePathLayer are necessary and correctly added.


235-235: Path normalization layer applied correctly.

The NormalizePathLayer is correctly applied to the router, ensuring path normalization.


241-241: Server binding with normalized router approved.

The server correctly uses the router_normalized for binding, ensuring that the path normalization is effective.

@palozano palozano self-assigned this Jul 11, 2024
@dndll dndll merged commit 133aa4e into main Jul 11, 2024
4 of 5 checks passed
@dndll dndll deleted the fix/put-route branch July 11, 2024 10:41
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.

2 participants