fix: Git ssh validation regex enhancement #33426

sondermanish · 2024-05-14T07:45:40Z

Description

Updated SSH validation regular expression to enhance data validation, and allow custom usernames in ssh address.
While connecting to git, Appsmith checks pattern for ssh address provided by the user.
The check only accepted git as username and rejected any custom usernames provided by users.

Fixes #19881

Automation

/ok-to-test tags="@tag.Git"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9090239144
Commit: 05f2b6f
Cypress dashboard url: Click here!

Communication

Should the DevRel and Marketing teams inform users about this change?

Yes
No

coderabbitai · 2024-05-14T07:45:49Z

Walkthrough

The changes introduce new patterns URL_PATTERN_WITHOUT_GIT_PREFIX and URL_PATTERN_WITH_CUSTOM_USERNAME in the GitUtils class to enhance URL parsing functionality for Git URLs with and without custom usernames. Additionally, the GitUtilsTest class has been updated to support custom SSH usernames in the conversion of SSH URLs to browser-compatible URLs.

Changes

Files	Change Summary
`app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/GitUtils.java`	Added new patterns `URL_PATTERN_WITHOUT_GIT_PREFIX` and `URL_PATTERN_WITH_CUSTOM_USERNAME` in `GitUtils` class.
`app/server/appsmith-server/src/test/java/com/appsmith/server/helpers/GitUtilsTest.java`	Enhanced `convertSshUrlToBrowserSupportedUrl()` method to support custom SSH usernames and added relevant test cases.

Assessment against linked issues

Objective	Addressed	Explanation
Add support for custom SSH URLs that do not begin with `git@` (#19881)	✅
Enhance URL parsing functionality to include custom SSH usernames (#19881)	✅

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 81bbf24 and 05f2b6f.

Files selected for processing (2)

app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/GitUtils.java (2 hunks)
app/server/appsmith-server/src/test/java/com/appsmith/server/helpers/GitUtilsTest.java (2 hunks)

Files skipped from review as they are similar to previous changes (2)

app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/GitUtils.java
app/server/appsmith-server/src/test/java/com/appsmith/server/helpers/GitUtilsTest.java

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.

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

Out of diff range and nitpick comments (1)

app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/GitUtils.java (1)

29-30: Add a comment explaining the purpose of the new regex pattern.

To improve code readability and maintainability, consider adding a comment that explains the purpose of the URL_PATTERN_WITHOUT_GIT_PREFIX regex pattern.

github-actions · 2024-05-14T08:09:56Z

Failed server tests

com.appsmith.server.services.ce.ActionServiceCE_Test#createValidActionWithJustName
com.appsmith.server.solutions.CreateDBTablePageSolutionTests#createPageWithInvalidDatasourceTest

nidhi-nair · 2024-05-14T10:16:03Z

app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/GitUtils.java

@@ -26,6 +26,9 @@ public class GitUtils {
    public static final Pattern URL_PATTERN_WITHOUT_SCHEME =
            Pattern.compile("^git@(?<host>.+?):/*(?<path>.+?)(\\.git)?$");

+    public static final Pattern URL_PATTERN_WITHOUT_GIT_PREFIX =
+            Pattern.compile("^[a-zA-Z0-9]+@(?<host>.+?):/*(?<path>.+?)(\\.git)?$");


What if they use ssh prefix with custom username?

nidhi-nair · 2024-05-14T10:16:42Z

app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/GitUtils.java

@@ -26,6 +26,9 @@ public class GitUtils {
    public static final Pattern URL_PATTERN_WITHOUT_SCHEME =
            Pattern.compile("^git@(?<host>.+?):/*(?<path>.+?)(\\.git)?$");

+    public static final Pattern URL_PATTERN_WITHOUT_GIT_PREFIX =


Nit, can we rename this to indicate exactly what we're accepting here, that is, custom username.

nidhi-nair · 2024-05-14T10:17:30Z

app/server/appsmith-server/src/test/java/com/appsmith/server/helpers/GitUtilsTest.java

+
+        // custom ssh username:
+        assertThat(GitUtils.convertSshUrlToBrowserSupportedUrl("custom@vs-ssh.visualstudio.com:v3/newJet/ai/zilla"))
+                .isEqualTo("https://vs-ssh.visualstudio.com/v3/newJet/ai/zilla");


There should be another check somewhere for repo names. Does that pattern comply with this input already? If it does, can you add a test case there as well to make sure that it does not break in the future?

it does comply, adding test cases

nidhi-nair

Needs a few more inclusions.

## Description > Added regex for supporting custom usernames in ssh Fixes #19881 ## Automation /ok-to-test tags="@tag.Git" ### 🔍 Cypress test results  > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9090239144> > Commit: 05f2b6f > Cypress dashboard url: <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9090239144&attempt=1" target="_blank">Click here!</a>  ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No

added regex

81bbf24

sondermanish requested a review from a team as a code owner May 14, 2024 07:45

sondermanish requested a review from nidhi-nair May 14, 2024 07:45

github-actions bot added Enhancement New feature or request Git Pod Anything related to git sync Git Version Control Issues related to version control QA Needs QA attention labels May 14, 2024

sondermanish self-assigned this May 14, 2024

github-actions bot added Bug Something isn't working and removed Enhancement New feature or request labels May 14, 2024

sondermanish added the ok-to-test Required label for CI label May 14, 2024

github-actions bot added the Enhancement New feature or request label May 14, 2024

coderabbitai bot reviewed May 14, 2024

View reviewed changes

nidhi-nair reviewed May 14, 2024

View reviewed changes

nidhi-nair requested changes May 14, 2024

View reviewed changes

added test cases

05f2b6f

sondermanish requested a review from nidhi-nair May 14, 2024 10:52

nidhi-nair approved these changes May 14, 2024

View reviewed changes

sondermanish added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 15, 2024

sondermanish merged commit 1e23643 into release May 15, 2024
42 checks passed

sondermanish deleted the fix/sshurl branch May 15, 2024 05:34

amenasse mentioned this pull request May 19, 2024

[Feature]: Add support for the custom ssh URL that does not begin with git@ #19881

Closed

1 task

sondermanish changed the title ~~fix: added regex~~ fix: modified regex which identifies the ssh address when connecting to git May 21, 2024

github-actions bot removed the Enhancement New feature or request label May 21, 2024