INS-2497: prevent git sync parse failure (#5954)

* INS-2497: prevent git sync parse failure * fix import and add tests * CR improvements
Kong · May 15, 2023 · 28f6e18 · 28f6e18
1 parent f5d6d52
commit 28f6e18
Show file tree

Hide file tree

Showing 7 changed files with 114 additions and 41 deletions.
diff --git a/packages/insomnia-smoke-test/tests/prerelease/git-sync-interactions.test.ts b/packages/insomnia-smoke-test/tests/prerelease/git-sync-interactions.test.ts
@@ -51,6 +51,58 @@ test('Clone Repo with bad values', async ({ page }) => {
   await expect(page.locator('.app')).toContainText('Error Pushing Repository');
 });
 
+test('Clone Bitbucket Repo with bad values', async ({ page }) => {
+  await page.click('[data-testid="project"] >> text=Insomnia');
+  await page.getByRole('button', { name: 'Create' }).click();
+  await page.getByRole('menuitem', { name: 'Git Clone' }).click();
+  await page.getByRole('tab', { name: 'Git' }).nth(2).click();
+
+  // Fill in Git Sync details and clone repository
+  await page.getByText('Git URI (https)').fill('https://bitbucket.org/atlassian/bitbucket-example-plugin.git');
+  await page.getByText('Author Name').fill('test');
+  await page.getByText('Author Email').fill('test');
+  await page.getByText('Username').fill('test');
+  await page.getByText('Authentication Token').fill('test');
+  await page.getByRole('button', { name: 'Clone' }).click();
+
+  // Create a branch and try to push with bad Git token
+  await page.getByRole('button', { name: 'master' }).click();
+  await page.getByRole('menuitem', { name: 'Branches' }).click();
+  await page.getByPlaceholder('testing-branch').fill('test123');
+  await page.getByRole('button', { name: '+ Create' }).click();
+  await page.getByRole('cell', { name: 'test123(current)' }).click();
+  await page.getByRole('button', { name: 'Done' }).click();
+  await page.getByRole('button', { name: 'test123' }).click();
+  await page.getByRole('menuitem', { name: 'Push' }).click();
+  await expect(page.locator('.app')).toContainText('Error Pushing Repository');
+});
+
+test('Clone Gitlab Repo with bad values', async ({ page }) => {
+  await page.click('[data-testid="project"] >> text=Insomnia');
+  await page.getByRole('button', { name: 'Create' }).click();
+  await page.getByRole('menuitem', { name: 'Git Clone' }).click();
+  await page.getByRole('tab', { name: 'Git' }).nth(2).click();
+
+  // Fill in Git Sync details and clone repository
+  await page.getByText('Git URI (https)').fill('https://gitlab.com/gitlab-examples/gitlab-examples.gitlab.io.git');
+  await page.getByText('Author Name').fill('test');
+  await page.getByText('Author Email').fill('test');
+  await page.getByText('Username').fill('test');
+  await page.getByText('Authentication Token').fill('test');
+  await page.getByRole('button', { name: 'Clone' }).click();
+
+  // Create a branch and try to push with bad Git token
+  await page.getByRole('button', { name: 'master' }).click();
+  await page.getByRole('menuitem', { name: 'Branches' }).click();
+  await page.getByPlaceholder('testing-branch').fill('test123');
+  await page.getByRole('button', { name: '+ Create' }).click();
+  await page.getByRole('cell', { name: 'test123(current)' }).click();
+  await page.getByRole('button', { name: 'Done' }).click();
+  await page.getByRole('button', { name: 'test123' }).click();
+  await page.getByRole('menuitem', { name: 'Push' }).click();
+  await expect(page.locator('.app')).toContainText('Error Pushing Repository');
+});
+
 // TODO(kreosus): more git sync prerelease tests will be added when gh auth secrets are properly setup for CI use
 
 // TODO(kreosus): more preferences scenarios will be added in the followup iterations of increasing app test coverage
diff --git a/packages/insomnia/package-lock.json b/packages/insomnia/package-lock.json
diff --git a/packages/insomnia/package.json b/packages/insomnia/package.json
@@ -68,6 +68,7 @@
     "fs-extra": "^5.0.0",
     "grpc-reflection-js": "github:Kong/grpc-reflection-js#01fcce0",
     "hawk": "9.0.1",
+    "hosted-git-info": "5.2.1",
     "hkdf": "^0.0.2",
     "html-entities": "^1.2.0",
     "httpsnippet": "^2.0.0",
@@ -132,6 +133,7 @@
     "@types/dompurify": "^2.3.3",
     "@types/fs-extra": "^5.1.0",
     "@types/hawk": "9.0.2",
+    "@types/hosted-git-info": "3.0.2",
     "@types/js-yaml": "^4.0.1",
     "@types/jshint": "^2.12.1",
     "@types/license-checker": "^25.0.1",

diff --git a/packages/insomnia/src/sync/git/__tests__/utils.test.ts b/packages/insomnia/src/sync/git/__tests__/utils.test.ts
@@ -1,6 +1,6 @@
 import { describe, expect, it } from '@jest/globals';
 
-import { addDotGit, translateSSHtoHTTP } from '../utils';
+import { addDotGit } from '../utils';
 
 const links = {
   scp: {
@@ -21,28 +21,6 @@ const links = {
   },
 };
 
-describe('translateSSHtoHTTP', () => {
-  it('fixes up scp-style', () => {
-    expect(translateSSHtoHTTP(links.scp.bare)).toEqual(links.https.bare);
-    expect(translateSSHtoHTTP(links.scp.dotGit)).toEqual(links.https.dotGit);
-  });
-
-  it('fixes up ssh-style', () => {
-    expect(translateSSHtoHTTP(links.ssh.bare)).toEqual('https://a@github.com/b');
-    expect(translateSSHtoHTTP(links.ssh.dotGit)).toEqual('https://a@github.com/b.git');
-  });
-
-  it('leaves http alone', () => {
-    expect(translateSSHtoHTTP(links.http.bare)).toEqual(links.http.bare);
-    expect(translateSSHtoHTTP(links.http.dotGit)).toEqual(links.http.dotGit);
-  });
-
-  it('leaves https alone', () => {
-    expect(translateSSHtoHTTP(links.https.bare)).toEqual(links.https.bare);
-    expect(translateSSHtoHTTP(links.https.dotGit)).toEqual(links.https.dotGit);
-  });
-});
-
 describe('addDotGit', () => {
   it('adds the .git to bare links', () => {
     expect(addDotGit(links.scp.bare)).toEqual(links.scp.dotGit);

diff --git a/packages/insomnia/src/sync/git/utils.ts b/packages/insomnia/src/sync/git/utils.ts
@@ -5,14 +5,6 @@ import type { GitCredentials } from './git-vcs';
 import { getAccessToken as getGitHubAccessToken } from './github-oauth-provider';
 import { getAccessToken as getGitlabAccessToken, refreshToken as refreshGitlabToken } from './gitlab-oauth-provider';
 
-export const translateSSHtoHTTP = (url: string) => {
-  // handle "shorter scp-like syntax"
-  url = url.replace(/^git@([^:]+):/, 'https://$1/');
-  // handle proper SSH URLs
-  url = url.replace(/^ssh:\/\//, 'https://');
-  return url;
-};
-
 export const addDotGit = (url: string): string => (url.endsWith('.git') ? url : `${url}.git`);
 
 const onMessage: MessageCallback = message => {

diff --git a/...components/modals/git-repository-settings-modal/custom-repository-settings-form-group.tsx b/...components/modals/git-repository-settings-modal/custom-repository-settings-form-group.tsx
@@ -45,6 +45,7 @@ export const CustomRepositorySettingsFormGroup: FunctionComponent<Props> = ({
         <label>
           Git URI (https)
           <input
+            type="url"
             required
             autoFocus
             name="uri"

diff --git a/packages/insomnia/src/ui/routes/git-actions.tsx b/packages/insomnia/src/ui/routes/git-actions.tsx
@@ -1,4 +1,5 @@
 import { invariant } from '@remix-run/router';
+import { fromUrl } from 'hosted-git-info';
 import { Errors } from 'isomorphic-git';
 import path from 'path';
 import { ActionFunction, LoaderFunction, redirect } from 'react-router-dom';
@@ -32,7 +33,6 @@ import { shallowClone } from '../../sync/git/shallow-clone';
 import {
   addDotGit,
   getOauth2FormatName,
-  translateSSHtoHTTP,
 } from '../../sync/git/utils';
 import { SegmentEvent, trackSegmentEvent, vcsSegmentEventProperties } from '../analytics';
 
@@ -324,7 +324,7 @@ export const cloneGitRepoAction: ActionFunction = async ({
     vcsSegmentEventProperties('git', 'clone')
   );
   repoSettingsPatch.needsFullClone = true;
-  repoSettingsPatch.uri = translateSSHtoHTTP(repoSettingsPatch.uri || '');
+  repoSettingsPatch.uri = fromUrl(repoSettingsPatch.uri)?.https() || '';
   let fsClient = MemClient.createClient();
 
   const providerName = getOauth2FormatName(repoSettingsPatch.credentials);