Skip to content

[WEB-2605] fix: update URL regex pattern to allow complex links.#5767

Merged
pushya22 merged 1 commit intopreviewfrom
fix/links-regex
Oct 8, 2024
Merged

[WEB-2605] fix: update URL regex pattern to allow complex links.#5767
pushya22 merged 1 commit intopreviewfrom
fix/links-regex

Conversation

@prateekshourya29
Copy link
Member

@prateekshourya29 prateekshourya29 commented Oct 7, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced URL validation to accommodate a broader range of valid URL formats, including subdomains and diverse path characters.
  • Bug Fixes

    • Improved robustness of the URL validation logic.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 7, 2024

Walkthrough

The changes involve an update to the regular expression used in the checkURLValidity function located in the web/helpers/string.helper.ts file. This modification enhances the URL validation process by accommodating a wider range of valid URL formats, including subdomains and various characters in the path. No other changes were made to the logic or functionality of the other exported functions in the file.

Changes

File Path Change Summary
web/helpers/string.helper.ts Updated regex in checkURLValidity function to improve URL validation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant WebApp
    participant StringHelper

    User->>WebApp: Enter URL
    WebApp->>StringHelper: checkURLValidity(URL)
    StringHelper-->>WebApp: Validate URL
    WebApp-->>User: Display validation result
Loading

Poem

In the garden of code, a rabbit hops free,
With regex so bright, as clear as can be.
Valid URLs dance, in a format so wide,
Subdomains and paths, now take it in stride.
Hooray for the changes, let’s cheer with delight,
For a helper so clever, it shines ever bright! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 39eabc2 and 7b2078c.

📒 Files selected for processing (1)
  • web/helpers/string.helper.ts (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
web/helpers/string.helper.ts (1)

273-273: Improved URL validation, but consider further enhancements.

The updated regex pattern significantly improves URL validation by allowing more complex URLs, including subdomains and a wider range of characters in the path. This change aligns well with the PR objective to allow complex links.

However, consider the following suggestions for further improvement:

  1. The TLD length limit (2-6 characters) might exclude some newer, longer TLDs. Consider increasing this limit or using a more flexible pattern.
  2. The current pattern doesn't explicitly handle IP addresses or localhost. If these are required, you may need to add support for them.

Here's a suggested enhancement to address these points:

-  const urlPattern = /^(https?:\/\/)?([\w.-]+\.[a-z]{2,6})(\/[\w\-.~:/?#[\]@!$&'()*+,;=%]*)?$/i;
+  const urlPattern = /^(https?:\/\/)?(localhost|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|[\w.-]+\.[a-z]{2,})(:\d+)?(\/[\w\-.~:/?#[\]@!$&'()*+,;=%]*)?$/i;

This pattern adds support for:

  • localhost
  • IP addresses
  • Longer TLDs
  • Port numbers

To ensure this change doesn't introduce any regressions, please run the following test cases:

This script will help verify that the function correctly handles various URL formats, including the new cases we've added support for.


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.

@pushya22 pushya22 merged commit 328b696 into preview Oct 8, 2024
@pushya22 pushya22 deleted the fix/links-regex branch October 8, 2024 07:50
@sriramveeraghanta sriramveeraghanta added this to the v0.23.1 milestone Oct 10, 2024
sharma01ketan added a commit that referenced this pull request Oct 11, 2024
sharma01ketan added a commit that referenced this pull request Oct 11, 2024
sharma01ketan added a commit that referenced this pull request Oct 11, 2024
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.

4 participants