fix: handle stash failures

Author: mshanemc

README.md

@@ -15,22 +15,15 @@ You should use the class named sourceTracking.
 
 ## TODO
 
-NUT for compatibility checks
+NUT for tracking file compatibility check logic
 pollSourceMembers should better handle aggregated types. ex:
 
 ```
-DEBUG Could not find 2 SourceMembers: AuraDefinition__pageTemplate_2_7_3/pageTemplate_2_7_3.cmp-meta.xml,[object Object],CustomObject__Account,[object Object]
+DEBUG Could not find 2 SourceMembers (using ebikes): AuraDefinition__pageTemplate_2_7_3/pageTemplate_2_7_3.cmp-meta.xml,[object Object],CustomObject__Account,[object Object]
 ```
 
-push/pull throw on conflict, but don't provide errors for --json
-
-- SDR sets all retrieve FileResponse as `Changed` even if it didn't exist locally. That's going to yield slightly different json output on a `pull` than toolbelt did. See `remoteChanges.nut.ts > remote changes:add > can pull the add`. Fixing in pull is less optimal than fixing in SDR (because source:retrieve is also currently reporting those as `Changed` instead of `Created`)
-  work around our gitignore stash trick...sometimes it gets in the incomplete state. What if there is no gitignore? All kinds of error handling issues around that
-
 ### Enhancements
 
-- status can "mark ignores"
-- why does push take so long?
 - for updating ST after deploy/retrieve, we need a quick way for those commands to ask, "is this an ST org?" OR a graceful "ifSupported" wrapper for those methods.
 - ensureRemoteTracking could have 2 options in an object
   1. `ensureQueryHasReturned` which will make sure the query has run at least once

src/shared/localShadowRepo.ts

@@ -50,7 +50,6 @@ export class ShadowRepo extends AsyncCreatable<ShadowRepoOptions> {
   private packageDirs!: NamedPackageDir[];
   private status!: StatusRow[];
   private logger!: Logger;
-  private stashed = false;
   private options: ShadowRepoOptions;
 
   public constructor(options: ShadowRepoOptions) {
@@ -80,10 +79,16 @@ export class ShadowRepo extends AsyncCreatable<ShadowRepoOptions> {
     await git.init({ fs, dir: this.projectPath, gitdir: this.gitDir, defaultBranch: 'main' });
   }
 
+  /**
+   * Delete the local tracking files
+   *
+   * @returns the deleted directory
+   */
   public async delete(): Promise<string> {
     if (typeof fs.promises.rm === 'function') {
       await fs.promises.rm(this.gitDir, { recursive: true, force: true });
     } else {
+      // when node 12 support is over, switch to promise version
       fs.rmdirSync(this.gitDir, { recursive: true });
     }
     return this.gitDir;
@@ -108,6 +113,7 @@ export class ShadowRepo extends AsyncCreatable<ShadowRepoOptions> {
         // filter out hidden files and __tests__ patterns, regardless of gitignore
         filter: (f) => !f.includes(`${path.sep}.`) && !f.includes('__tests__'),
       });
+      // isomorphic-git stores things in unix-style tree.  Convert to windows-style if necessary
       if (os.type() === 'Windows_NT') {
         this.status = this.status.map((row) => [path.normalize(row[FILE]), row[HEAD], row[WORKDIR], row[3]]);
       }
@@ -222,22 +228,18 @@ export class ShadowRepo extends AsyncCreatable<ShadowRepoOptions> {
   }
 
   private async stashIgnoreFile(): Promise<void> {
-    if (!this.stashed) {
-      this.stashed = true;
-      await fs.promises.rename(
-        path.join(this.projectPath, '.gitignore'),
-        path.join(this.projectPath, '.BAK.gitignore')
-      );
+    const originalLocation = path.join(this.projectPath, '.gitignore');
+    // another process may have already stashed the file
+    if (fs.existsSync(originalLocation)) {
+      await fs.promises.rename(originalLocation, path.join(this.projectPath, '.BAK.gitignore'));
     }
   }
 
   private async unStashIgnoreFile(): Promise<void> {
-    if (this.stashed) {
-      this.stashed = false;
-      await fs.promises.rename(
-        path.join(this.projectPath, '.BAK.gitignore'),
-        path.join(this.projectPath, '.gitignore')
-      );
+    const stashedLocation = path.join(this.projectPath, '.gitignore');
+    // another process may have already un-stashed the file
+    if (fs.existsSync(stashedLocation)) {
+      await fs.promises.rename(stashedLocation, path.join(this.projectPath, '.gitignore'));
     }
   }
 }