Allow slashes for the ref parameter by 5ouma · Pull Request #137 · 5ouma/reproxy

5ouma · 2024-12-08T08:35:27Z

⚠️ Issue

close #

✏️ Description

Branch names with slashes will become able to be used.

🔄 Type of the Change

I agree to follow the
Code of Conduct.

Branch names with slashes will become able to be used.

Copilot

Copilot reviewed 3 out of 3 changed files in this pull request and generated no suggestions.

codecov · 2024-12-08T08:37:55Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (051a718) to head (373c76a).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #137   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines           93        93           
  Branches         6         6           
=========================================
  Hits            93        93

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

coderabbitai · 2024-12-08T08:37:56Z

Walkthrough

The changes in this pull request primarily involve the addition of a new constant testRefSlash in src/libs/test_utils.ts, which is then utilized in the test cases of src/server.test.ts. The test cases have been updated to reflect this new constant and include modifications to the assertions and naming conventions. In src/server.ts, the routing logic has been altered to enhance the matching of the :ref parameter, while a catch-all route handler has been removed, affecting how unmatched routes are processed.

Changes

File	Change Summary
src/libs/test_utils.ts	Added new exported constant `testRefSlash = "renovate/configure";` with documentation comment.
src/server.test.ts	Imported `testRefSlash` and updated test cases to use it; renamed a test case and added a new one.
src/server.ts	Modified GET request routing logic to enhance `:ref` parameter matching; removed catch-all route handler.

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

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

src/server.test.ts (1)
62-72: LGTM! Good test coverage for redirects with slashed refs.

The test properly verifies redirect behavior with slashed refs. However, consider maintaining consistent naming style:
-  await t.step("/:ref (withSlash, Redirect)", async () => {
+  await t.step("/:ref (with Slash, Redirect)", async () => {

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 051a718 and 373c76a.

📒 Files selected for processing (3)

src/libs/test_utils.ts (1 hunks)
src/server.test.ts (2 hunks)
src/server.ts (2 hunks)

🔇 Additional comments (4)

src/libs/test_utils.ts (1)

43-51: LGTM! Well-documented test constant.

The new constant follows the established pattern and includes proper JSDoc documentation with examples.

src/server.ts (2)

30-30: LGTM! Route pattern correctly handles slashed refs.

The new pattern /:ref{.+}? appropriately allows slashes in the ref parameter while maintaining its optional nature.

Line range hint 30-56: Verify the removal of catch-all route handler.

The catch-all route handler that previously redirected unmatched routes has been removed. This changes how 404s are handled.

src/server.test.ts (1)

55-60: LGTM! Good test coverage for direct access with slashed refs.

The test appropriately verifies that refs containing slashes work for direct access.

feat(route): Allow slashes for the ref parameter

373c76a

Branch names with slashes will become able to be used.

Copilot AI review requested due to automatic review settings December 8, 2024 08:35

auto-assign bot assigned 5ouma Dec 8, 2024

Copilot AI reviewed Dec 8, 2024

View reviewed changes

prlabeler bot added the 🎉 New Feature A new feature label Dec 8, 2024

coderabbitai bot reviewed Dec 8, 2024

View reviewed changes

coderabbitai bot approved these changes Dec 8, 2024

View reviewed changes

5ouma merged commit f074200 into main Dec 8, 2024

5ouma deleted the feat-param-slash branch December 8, 2024 08:42

github-actions bot mentioned this pull request Dec 8, 2024

Release: v1.4.0 #92

Merged

coderabbitai bot mentioned this pull request Dec 8, 2024

Clean up the test utils #138

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Allow slashes for the ref parameter#137

Allow slashes for the ref parameter#137
5ouma merged 1 commit intomainfrom
feat-param-slash

5ouma commented Dec 8, 2024

Uh oh!

Copilot AI left a comment

Uh oh!

codecov bot commented Dec 8, 2024 •

edited

Loading

Uh oh!

coderabbitai bot commented Dec 8, 2024

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

5ouma commented Dec 8, 2024

⚠️ Issue

✏️ Description

🔄 Type of the Change

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Dec 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

coderabbitai bot commented Dec 8, 2024

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Dec 8, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)