feat(Git Sync): Introduce the option to select a branch when cloning a repository (#8883)

* Allow users to pick a branch when cloning a repo

* save

* cleanup

* add ref option to git clone action

* cleanup UI

* fix ts in credentials

* fix ts issues from rebase

* fix lint issue

* add ref option to git actions and update credentials handling in UI components

* fix: include credentials in dependency array for useEffect in GitRemoteBranchSelect

Author: gatzjames

packages/insomnia/src/main/git-service.ts

@@ -26,10 +26,12 @@ import type { GitRepository } from '../models/git-repository';
 import { isWorkspace, type WorkspaceScope, WorkspaceScopeKeys } from '../models/workspace';
 import { fsClient } from '../sync/git/fs-client';
 import GitVCS, {
+  fetchRemoteBranches,
   GIT_CLONE_DIR,
   GIT_INSOMNIA_DIR,
   GIT_INSOMNIA_DIR_NAME,
   GIT_INTERNAL_DIR,
+  type GitCredentials,
   MergeConflictError,
 } from '../sync/git/git-vcs';
 import { MemClient } from '../sync/git/mem-client';
@@ -189,6 +191,7 @@ export async function loadGitRepository({ projectId, workspaceId }: { projectId:
   try {
     const gitRepository = await getGitRepository({ workspaceId, projectId });
 
+    const bufferId = await database.bufferChanges();
     const fsClient = await getGitFSClient({ gitRepositoryId: gitRepository._id, projectId, workspaceId });
 
     if (GitVCS.isInitializedForRepo(gitRepository._id) && !gitRepository.needsFullClone) {
@@ -241,6 +244,8 @@ export async function loadGitRepository({ projectId, workspaceId }: { projectId:
       legacyInsomniaWorkspace = await containsLegacyInsomniaDir({ fsClient });
     }
 
+    await database.flushChanges(bufferId);
+
     return {
       branch: await GitVCS.getCurrentBranch(),
       branches: await GitVCS.listBranches(),
@@ -591,6 +596,7 @@ export const initGitRepoCloneAction = async ({
   token,
   username,
   oauth2format,
+  ref,
 }: {
   organizationId: string;
   uri: string;
@@ -599,6 +605,7 @@ export const initGitRepoCloneAction = async ({
   token: string;
   username: string;
   oauth2format?: string;
+  ref?: string;
 }): Promise<
   | {
       files: {
@@ -647,6 +654,7 @@ export const initGitRepoCloneAction = async ({
 
   try {
     await shallowClone({
+      ref,
       fsClient: inMemoryFsClient,
       gitRepository: repoSettingsPatch as GitRepository,
     });
@@ -701,6 +709,7 @@ export const cloneGitRepoAction = async ({
   token,
   username,
   oauth2format,
+  ref,
 }: {
   organizationId: string;
   projectId?: string;
@@ -712,6 +721,7 @@ export const cloneGitRepoAction = async ({
   token: string;
   username: string;
   oauth2format?: string;
+  ref?: string;
 }) => {
   try {
     if (!projectId) {
@@ -750,6 +760,7 @@ export const cloneGitRepoAction = async ({
 
       try {
         await shallowClone({
+          ref,
           fsClient: inMemoryFsClient,
           gitRepository: repoSettingsPatch as GitRepository,
         });
@@ -822,6 +833,7 @@ export const cloneGitRepoAction = async ({
           directory: GIT_CLONE_DIR,
           fs: fsClient,
           gitDirectory: GIT_INTERNAL_DIR,
+          ref,
         });
 
         await models.gitRepository.update(gitRepository, {
@@ -846,7 +858,10 @@ export const cloneGitRepoAction = async ({
         await migrateLegacyInsomniaFolderToFile({ projectId: project._id });
       }
 
-      await models.gitRepository.update(gitRepository, {
+      const updateRepository = await models.gitRepository.getById(gitRepository._id);
+      invariant(updateRepository, 'Git Repository not found');
+
+      await models.gitRepository.update(updateRepository, {
         cachedGitLastCommitTime: Date.now(),
         cachedGitRepositoryBranch: await GitVCS.getCurrentBranch(),
       });
@@ -900,6 +915,7 @@ export const cloneGitRepoAction = async ({
     const providerName = getOauth2FormatName(repoSettingsPatch.credentials);
     try {
       await shallowClone({
+        ref,
         fsClient: inMemoryFsClient,
         gitRepository: repoSettingsPatch as GitRepository,
       });
@@ -1089,6 +1105,7 @@ export const updateGitRepoAction = async ({
   oauth2format,
   username,
   token,
+  ref,
 }: {
   projectId: string;
   workspaceId?: string;
@@ -1098,6 +1115,7 @@ export const updateGitRepoAction = async ({
   oauth2format?: string;
   username: string;
   token: string;
+  ref?: string;
 }) => {
   try {
     let gitRepositoryId: string | null | undefined = null;
@@ -1178,6 +1196,7 @@ export const updateGitRepoAction = async ({
       gitDirectory: GIT_INTERNAL_DIR,
       gitCredentials: gitRepository.credentials,
       legacyDiff: Boolean(workspaceId),
+      ref,
     });
 
     await GitVCS.setAuthor();
@@ -1704,6 +1723,26 @@ export const pushToGitRemoteAction = async ({
   };
 };
 
+export async function fetchGitRemoteBranches({
+  uri,
+  credentials,
+}: {
+  uri: string;
+  credentials?: GitCredentials;
+}): Promise<{ branches: string[]; errors?: string[] }> {
+  try {
+    const branches = await fetchRemoteBranches({
+      uri: parseGitToHttpsURL(uri),
+      credentials,
+    });
+
+    return { branches };
+  } catch (err) {
+    const errorMessage = err instanceof Error ? err.message : 'Error while fetching remote branches';
+    return { branches: [], errors: [errorMessage] };
+  }
+}
+
 export async function pullFromGitRemote({ projectId, workspaceId }: { projectId: string; workspaceId?: string }) {
   try {
     const gitRepository = await getGitRepository({ projectId, workspaceId });
@@ -2472,7 +2511,7 @@ export interface GitServiceAPI {
   diffFileLoader: typeof diffFileLoader;
   getRepositoryDirectoryTree: typeof getRepositoryDirectoryTree;
   migrateLegacyInsomniaFolderToFile: typeof migrateLegacyInsomniaFolderToFile;
-
+  fetchGitRemoteBranches: typeof fetchGitRemoteBranches;
   initSignInToGitHub: typeof initSignInToGitHub;
   completeSignInToGitHub: typeof completeSignInToGitHub;
   signOutOfGitHub: typeof signOutOfGitHub;
@@ -2489,6 +2528,9 @@ export const registerGitServiceAPI = () => {
     loadGitRepository(options),
   );
   ipcMainHandle('git.getGitBranches', (_, options: Parameters<typeof getGitBranches>[0]) => getGitBranches(options));
+  ipcMainHandle('git.fetchGitRemoteBranches', (_, options: Parameters<typeof fetchGitRemoteBranches>[0]) =>
+    fetchGitRemoteBranches(options),
+  );
   ipcMainHandle('git.gitFetchAction', (_, options: Parameters<typeof gitFetchAction>[0]) => gitFetchAction(options));
   ipcMainHandle('git.gitLogLoader', (_, options: Parameters<typeof gitLogLoader>[0]) => gitLogLoader(options));
   ipcMainHandle('git.gitChangesLoader', (_, options: Parameters<typeof gitChangesLoader>[0]) =>

packages/insomnia/src/main/ipc/electron.ts

@@ -49,6 +49,7 @@ export type HandleChannels =
   | 'secretStorage.decryptString'
   | 'git.loadGitRepository'
   | 'git.getGitBranches'
+  | 'git.fetchGitRemoteBranches'
   | 'git.gitFetchAction'
   | 'git.gitLogLoader'
   | 'git.gitChangesLoader'

packages/insomnia/src/preload.ts

@@ -70,6 +70,7 @@ const secretStorage: secretStorageBridgeAPI = {
 const git: GitServiceAPI = {
   loadGitRepository: options => ipcRenderer.invoke('git.loadGitRepository', options),
   getGitBranches: options => ipcRenderer.invoke('git.getGitBranches', options),
+  fetchGitRemoteBranches: options => ipcRenderer.invoke('git.fetchGitRemoteBranches', options),
   gitFetchAction: options => ipcRenderer.invoke('git.gitFetchAction', options),
   gitLogLoader: options => ipcRenderer.invoke('git.gitLogLoader', options),
   gitChangesLoader: options => ipcRenderer.invoke('git.gitChangesLoader', options),

packages/insomnia/src/sync/git/git-vcs.ts

@@ -68,6 +68,7 @@ interface InitOptions {
   gitCredentials?: GitCredentials | null;
   uri?: string;
   repoId: string;
+  ref?: string;
   // If enabled git-vcs will only diff files inside a .insomnia directory
   legacyDiff?: boolean;
 }
@@ -78,6 +79,7 @@ interface InitFromCloneOptions {
   directory: string;
   fs: git.FsClient;
   gitDirectory: string;
+  ref?: string;
   repoId: string;
 }
 
@@ -102,7 +104,7 @@ function getInsomniaFileName(blob: void | Uint8Array | undefined): string {
   try {
     const parsed = parse(Buffer.from(blob).toString('utf-8'));
     return parsed?.fileName || parsed?.name || '';
-  } catch (e) {
+  } catch {
     // If the document couldn't be parsed as yaml return an empty string
     return '';
   }
@@ -120,13 +122,14 @@ interface BaseOpts {
   uri: string;
   repoId: string;
   legacyDiff?: boolean;
+  ref?: string;
 }
 
 export class GitVCS {
   // @ts-expect-error -- TSCONVERSION not initialized with required properties
   _baseOpts: BaseOpts = gitCallbacks();
 
-  async init({ directory, fs, gitDirectory, gitCredentials, uri = '', repoId, legacyDiff = false }: InitOptions) {
+  async init({ directory, fs, gitDirectory, gitCredentials, uri = '', repoId, legacyDiff = false, ref }: InitOptions) {
     this._baseOpts = {
       ...this._baseOpts,
       dir: directory,
@@ -137,6 +140,7 @@ export class GitVCS {
       uri,
       repoId,
       legacyDiff,
+      ref,
     };
 
     if (await this.repoExists()) {
@@ -158,7 +162,7 @@ export class GitVCS {
         });
 
         defaultBranch = mainRef?.target?.replace('refs/heads/', '') || 'main';
-      } catch (err) {
+      } catch {
         // Ignore error
       }
 
@@ -174,13 +178,13 @@ export class GitVCS {
       });
 
       return remoteOriginURI;
-    } catch (err) {
+    } catch {
       // Ignore error
       return this._baseOpts.uri || '';
     }
   }
 
-  async initFromClone({ repoId, url, gitCredentials, directory, fs, gitDirectory }: InitFromCloneOptions) {
+  async initFromClone({ repoId, url, gitCredentials, directory, fs, gitDirectory, ref }: InitFromCloneOptions) {
     this._baseOpts = {
       ...this._baseOpts,
       ...gitCallbacks(gitCredentials),
@@ -190,23 +194,27 @@ export class GitVCS {
       http: httpClient,
       repoId,
     };
+
+    const initRef = ref || this._baseOpts.ref;
+
     try {
       await git.clone({
         ...this._baseOpts,
         url,
-        singleBranch: true,
+        ...(initRef ? { ref: initRef } : {}),
       });
     } catch (err) {
       // If we there is a checkout conflict we only want to clone the repo
       if (err instanceof git.Errors.CheckoutConflictError) {
         await git.clone({
           ...this._baseOpts,
           url,
-          singleBranch: true,
+          ...(initRef ? { ref: initRef } : {}),
           noCheckout: true,
         });
       }
     }
+
     console.log(`[git] Cloned repo to ${gitDirectory} from ${url}`);
   }
 
@@ -366,7 +374,7 @@ export class GitVCS {
 
           try {
             return Buffer.from(blob).toString('utf-8');
-          } catch (e) {
+          } catch {
             return null;
           }
         });
@@ -974,6 +982,7 @@ export class GitVCS {
       await git.checkout({
         ...this._baseOpts,
         ref: branch,
+
         remote: 'origin',
       });
       const branches = await this.listBranches();
@@ -986,7 +995,7 @@ export class GitVCS {
   async repoExists() {
     try {
       await git.getConfig({ ...this._baseOpts, path: '' });
-    } catch (err) {
+    } catch {
       return false;
     }
 
@@ -1067,4 +1076,35 @@ function assertIsPromiseFsClient(fs: git.FsClient): asserts fs is git.PromiseFsC
   }
 }
 
+export async function fetchRemoteBranches({ uri, credentials }: { uri: string; credentials?: GitCredentials | null }) {
+  const [mainRef] = await git.listServerRefs({
+    ...gitCallbacks(credentials),
+    http: httpClient,
+    url: uri,
+    prefix: 'HEAD',
+    symrefs: true,
+  });
+
+  const remoteRefs = await git.listServerRefs({
+    ...gitCallbacks(credentials),
+    http: httpClient,
+    url: uri,
+    prefix: 'refs/heads/',
+    symrefs: true,
+  });
+
+  const defaultBranch = mainRef?.target?.replace('refs/heads/', '') || 'main';
+
+  const remoteBranches = remoteRefs
+    .filter(b => b.ref !== 'HEAD')
+    .map(b => b.ref.replace('refs/heads/', ''))
+    .sort((a, b) => {
+      if (a === defaultBranch) return -1;
+      if (b === defaultBranch) return 1;
+      return a.localeCompare(b);
+    });
+
+  return remoteBranches;
+}
+
 export default new GitVCS();

packages/insomnia/src/sync/git/shallow-clone.ts

@@ -8,14 +8,16 @@ import { gitCallbacks } from './utils';
 interface Options {
   fsClient: git.FsClient;
   gitRepository: Pick<GitRepository, 'credentials' | 'uri'>;
+  ref?: string;
 }
 
 /**
  * Create a shallow clone into the provided FS plugin.
  * */
-export const shallowClone = async ({ fsClient, gitRepository }: Options) => {
+export const shallowClone = async ({ fsClient, gitRepository, ref = undefined }: Options) => {
   await git.clone({
     ...gitCallbacks(gitRepository.credentials),
+    ...(ref ? { ref } : {}),
     fs: fsClient,
     http: httpClient,
     dir: GIT_CLONE_DIR,