refactor: clean up code and remove references to GIT_LOCAL_REPOS_DESIGN.md

Author: gatzjames

GIT_LOCAL_REPOS_DESIGN.md

@@ -72,7 +72,9 @@ export class ProjectPage extends BasePage {
       }
 
       const breadcrumbLink = this.page.getByTestId('workspace-breadcrumb-level-0').getByRole('link');
-      await ((await breadcrumbLink.isVisible()) ? breadcrumbLink.click() : this.sidebar.projectRow(projectName).click());
+      await ((await breadcrumbLink.isVisible())
+        ? breadcrumbLink.click()
+        : this.sidebar.projectRow(projectName).click());
 
       try {
         await this.page.waitForURL(this.projectDashboardUrl, { timeout: 5000, waitUntil: 'commit' });
@@ -103,9 +105,7 @@ export class ProjectPage extends BasePage {
   async createCollection(name = 'My Collection'): Promise<void> {
     await this.selectCreateInProjectType('Collection');
     await this.page.getByRole('dialog').waitFor({ state: 'visible' });
-    const nameInput = this.page
-      .getByRole('dialog')
-      .getByPlaceholder('Enter a name for your Request Collection');
+    const nameInput = this.page.getByRole('dialog').getByPlaceholder('Enter a name for your Request Collection');
     await nameInput.waitFor({ state: 'visible' });
     await nameInput.fill(name);
     await this.page.getByRole('dialog').getByRole('button', { name: 'Create' }).click();
@@ -154,7 +154,7 @@ export class ProjectPage extends BasePage {
   /**
    * Opens an existing local folder as a Git project (no clone). The native
    * directory picker is mocked to return `folderPath`. If the folder isn't a git
-   * repo, the app runs `git init`. See GIT_LOCAL_REPOS_DESIGN.md.
+   * repo, the app runs `git init`.
    */
   async openGitProjectFromFolder(name: string, folderPath: string): Promise<void> {
     await mockOpenDialogForDirectory(this.app, folderPath);

packages/insomnia-smoke-test/playwright/pages/project/index.ts

@@ -10,7 +10,6 @@ import { test } from '../../playwright/test';
 // Verifies repositories can live in user-chosen folders on disk:
 //  - opening an existing/plain folder as a Git project (runs `git init` if needed)
 //  - cloning into a user-chosen destination folder
-// See GIT_LOCAL_REPOS_DESIGN.md.
 
 const makeTempDir = (prefix: string) => fs.mkdtempSync(path.join(os.tmpdir(), prefix));
 
@@ -26,9 +25,7 @@ test.describe('Git repositories in user-chosen folders', () => {
       await insomnia.projectPage.openGitProjectFromFolder('Opened Folder Project', folder);
 
       // `git init` must have run inside the chosen folder (decision OQ2).
-      await expect
-        .poll(() => fs.existsSync(path.join(folder, '.git')), { timeout: 30_000 })
-        .toBe(true);
+      await expect.poll(() => fs.existsSync(path.join(folder, '.git')), { timeout: 30_000 }).toBe(true);
 
       // The project landed — no error banner.
       await expect.soft(page.getByText('Opened Folder Project')).toBeVisible();
@@ -41,9 +38,7 @@ test.describe('Git repositories in user-chosen folders', () => {
     const folder = makeTempDir('insomnia-open-collision-');
     try {
       await insomnia.projectPage.openGitProjectFromFolder('First Adoption', folder);
-      await expect
-        .poll(() => fs.existsSync(path.join(folder, '.git')), { timeout: 30_000 })
-        .toBe(true);
+      await expect.poll(() => fs.existsSync(path.join(folder, '.git')), { timeout: 30_000 }).toBe(true);
 
       // Back to the project dashboard, then try to adopt the same folder again.
       await insomnia.projectPage.openGitProjectFromFolder('Second Adoption', folder);
@@ -74,9 +69,7 @@ test.describe('Git clone into a user-chosen folder', () => {
       await insomnia.projectPage.cloneGitProjectIntoFolder('Cloned Into Folder', parent);
 
       // The repo URL is "git-server.git" → derived repo name "git-server".
-      await expect
-        .poll(() => fs.existsSync(path.join(parent, 'git-server', '.git')), { timeout: 60_000 })
-        .toBe(true);
+      await expect.poll(() => fs.existsSync(path.join(parent, 'git-server', '.git')), { timeout: 60_000 }).toBe(true);
     } finally {
       fs.rmSync(parent, { recursive: true, force: true });
     }

packages/insomnia-smoke-test/tests/smoke/git-local-repos.test.ts

@@ -58,8 +58,7 @@ const config = {
       NSRequiresAquaSystemAppearance: false,
       NSLocalNetworkUsageDescription:
         'Insomnia needs permission to connect to local APIs and development servers such as localhost, 127.0.0.1, or other LAN hosts.',
-      // Allow Finder "Open With → Insomnia" on folders so they can be opened as
-      // Git projects. See GIT_LOCAL_REPOS_DESIGN.md.
+      // Allow Finder "Open With → Insomnia" on folders so they can be opened as Git projects.
       CFBundleDocumentTypes: [
         {
           CFBundleTypeName: 'Folder',

packages/insomnia/electron-builder.config.js

@@ -225,7 +225,6 @@ app.on('activate', (_error, hasVisibleWindows) => {
 // When a folder path is opened from the OS (CLI arg, Finder "Open With", etc.),
 // normalise it into the open-folder deep link so the renderer has a single,
 // well-formed entry point. Returns null when the path isn't an existing folder.
-// See GIT_LOCAL_REPOS_DESIGN.md.
 const toOpenFolderDeepLink = async (rawPath: string): Promise<string | null> => {
   try {
     if (!rawPath || !path.isAbsolute(rawPath)) {

packages/insomnia/src/entry.main.ts

@@ -370,10 +370,7 @@ async function assertBranchOnOrigin(context: string): Promise<void> {
  * the GitRepository document should pass `directory` to avoid a DB lookup;
  * otherwise the directory is resolved from the database by id.
  */
-async function getRepoBaseDir(
-  gitRepositoryId: string,
-  directory?: string | null,
-): Promise<string> {
+async function getRepoBaseDir(gitRepositoryId: string, directory?: string | null): Promise<string> {
   let dir = directory;
   if (dir === undefined) {
     const repo = await services.gitRepository.getById(gitRepositoryId);
@@ -395,8 +392,7 @@ async function getRepoBaseDir(
  *
  * Insomnia owns the app-managed location (`directory === null`). A user-chosen
  * `directory` belongs to the user and must never be deleted when the project is
- * removed (decision D4 in GIT_LOCAL_REPOS_DESIGN.md). Failures are logged, not
- * thrown — losing a project record should not be blocked by a stale folder.
+ * removed. Failures are logged, not thrown — losing a project record should not be blocked by a stale folder.
  */
 async function deleteManagedRepoFolderIfOwned(repo: Pick<GitRepository, '_id' | 'directory'>) {
   if (repo.directory) {
@@ -595,7 +591,12 @@ export async function loadGitRepository({ projectId, workspaceId }: { projectId:
     }
 
     const bufferId = await database.bufferChanges();
-    const fsClient = await getGitFSClient({ gitRepositoryId: gitRepository._id, projectId, workspaceId, directory: gitRepository.directory });
+    const fsClient = await getGitFSClient({
+      gitRepositoryId: gitRepository._id,
+      projectId,
+      workspaceId,
+      directory: gitRepository.directory,
+    });
 
     if (GitVCS.isInitializedForRepo(gitRepository._id) && !gitRepository.needsFullClone) {
       let legacyInsomniaWorkspace;
@@ -1171,7 +1172,7 @@ export const cloneGitRepoAction = async ({
   selectedAuthorEmail?: string | null;
   /**
    * Optional absolute path to a user-chosen folder to clone into. When omitted,
-   * the repository is stored in the app-managed location. See GIT_LOCAL_REPOS_DESIGN.md.
+   * the repository is stored in the app-managed location.
    */
   directory?: string | null;
 }) => {
@@ -1295,7 +1296,11 @@ export const cloneGitRepoAction = async ({
 
       const project = await getProject();
 
-      const fsClient = await getGitFSClient({ projectId: project._id, gitRepositoryId: gitRepository._id, directory: gitRepository.directory });
+      const fsClient = await getGitFSClient({
+        projectId: project._id,
+        gitRepositoryId: gitRepository._id,
+        directory: gitRepository.directory,
+      });
 
       if (gitRepository.needsFullClone) {
         await GitVCS.initFromClone({
@@ -1567,7 +1572,7 @@ export const cloneGitRepoAction = async ({
 };
 
 /**
- * Open/adopt an existing local folder as a Git project. See GIT_LOCAL_REPOS_DESIGN.md.
+ * Open/adopt an existing local folder as a Git project.
  *
  * Unlike {@link cloneGitRepoAction} this performs no network clone — it points
  * Insomnia at a folder already on disk:
@@ -1606,7 +1611,9 @@ export const openGitRepoAction = async ({
       }
       await fs.promises.access(resolvedDirectory, fs.constants.R_OK | fs.constants.W_OK);
     } catch {
-      return { errors: [`Folder is not accessible (check it exists and you have read/write permission): ${resolvedDirectory}`] };
+      return {
+        errors: [`Folder is not accessible (check it exists and you have read/write permission): ${resolvedDirectory}`],
+      };
     }
 
     // Hard-block if another project already owns this folder (OQ5).
@@ -1702,7 +1709,7 @@ export const openGitRepoAction = async ({
  * Release a Git repository's runtime/disk resources when its project is being
  * deleted (called from the renderer delete flow). Stops the file watcher and
  * deletes the on-disk folder only when Insomnia owns it — user-chosen folders
- * are left untouched (decision D4 in GIT_LOCAL_REPOS_DESIGN.md).
+ * are left untouched.
  *
  * The DB document removal stays in the renderer action so it participates in the
  * same buffered change-set; this only handles the main-process-only concerns.
@@ -1719,7 +1726,7 @@ export const cleanupGitRepoStorageAction = async ({ gitRepositoryId }: { gitRepo
 
 /**
  * Move a Git project's on-disk repository to a user-chosen folder and record the
- * new location on `GitRepository.directory`. See GIT_LOCAL_REPOS_DESIGN.md.
+ * new location on `GitRepository.directory`.
  *
  * The whole repository (working tree + `.git`) is moved, so history and
  * uncommitted changes are preserved. If the previous location was the managed
@@ -3437,9 +3444,7 @@ export const registerGitServiceAPI = () => {
   ipcMainHandle('git.cloneGitRepo', (_, options: Parameters<typeof cloneGitRepoAction>[0]) =>
     cloneGitRepoAction(options),
   );
-  ipcMainHandle('git.openGitRepo', (_, options: Parameters<typeof openGitRepoAction>[0]) =>
-    openGitRepoAction(options),
-  );
+  ipcMainHandle('git.openGitRepo', (_, options: Parameters<typeof openGitRepoAction>[0]) => openGitRepoAction(options));
   ipcMainHandle('git.cleanupGitRepoStorage', (_, options: Parameters<typeof cleanupGitRepoStorageAction>[0]) =>
     cleanupGitRepoStorageAction(options),
   );

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

@@ -407,7 +407,7 @@ const Root = () => {
       }
       // Open a local folder as a Git project (from the OS: Finder "Open With",
       // `insomnia /path/to/folder`, or this deep link). The main process has
-      // already verified the path is an existing directory. See GIT_LOCAL_REPOS_DESIGN.md.
+      // already verified the path is an existing directory
       if (urlWithoutParams === 'insomnia://app/open-folder') {
         const folderPath = params.path;
         if (!folderPath) {

packages/insomnia/src/root.tsx

@@ -37,7 +37,7 @@ export async function clientAction({ params }: Route.ClientActionArgs) {
       const gitRepository = effectiveRepoId ? await services.gitRepository.getById(effectiveRepoId) : null;
       if (gitRepository) {
         // Stop the watcher and delete the on-disk folder only if Insomnia owns it.
-        // User-chosen folders are left untouched (see GIT_LOCAL_REPOS_DESIGN.md, D4).
+        // User-chosen folders are left untouched.
         await window.main.git.cleanupGitRepoStorage({ gitRepositoryId: gitRepository._id });
         await services.gitRepository.remove(gitRepository);
       }

packages/insomnia/src/routes/organization.$organizationId.project.$projectId.delete.tsx

@@ -345,7 +345,7 @@ export async function clientAction({ request, params }: Route.ClientActionArgs)
 
       if (gitRepository) {
         // Stop the watcher and delete the folder only if Insomnia owns it; a
-        // user-chosen folder stays on disk (see GIT_LOCAL_REPOS_DESIGN.md, D4).
+        // user-chosen folder stays on disk.
         await window.main.git.cleanupGitRepoStorage({ gitRepositoryId: gitRepository._id });
         await services.gitRepository.remove(gitRepository);
       }

packages/insomnia/src/routes/organization.$organizationId.project.$projectId.update.tsx

@@ -30,7 +30,7 @@ export interface CreateProjectData {
   directory?: string | null;
   /**
    * When set, adopt this existing local folder as a Git project instead of
-   * cloning from a URL. See GIT_LOCAL_REPOS_DESIGN.md.
+   * cloning from a URL.
    */
   openExistingDirectory?: string;
 }