fix: restore previous order of jobs

lint-staged · Oct 2, 2021 · ba62b22 · ba62b22
1 parent cecdda3
commit ba62b22
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 51 deletions.
diff --git a/lib/gitWorkflow.js b/lib/gitWorkflow.js
@@ -8,6 +8,7 @@ const {
   GitError,
   ApplyEmptyCommitError,
   HideUnstagedChangesError,
+  RestoreOriginalStateError,
   RestoreUnstagedChangesError,
 } = require('./symbols')
 const unlink = require('./unlink')
@@ -39,6 +40,7 @@ const processRenames = (files, includeRenameFrom = true) =>
   }, [])
 
 const PATCH_UNSTAGED = 'lint-staged_unstaged.patch'
+const PATCH_PARTIAL = 'lint-staged_partial.patch'
 
 const GIT_DIFF_ARGS = [
   '--binary', // support binary files
@@ -122,15 +124,18 @@ class GitWorkflow {
     try {
       debug('Backing up original state...')
 
+      const unstagedPatch = this.getHiddenFilepath(PATCH_UNSTAGED)
+      await this.execGit(['diff', ...GIT_DIFF_ARGS, '--output', unstagedPatch, '--', '.'])
+
       // Get a list of files with bot staged and unstaged changes.
       // Unstaged changes to these files should be hidden before the tasks run.
       this.partiallyStagedFiles = await this.getPartiallyStagedFiles()
 
       if (this.partiallyStagedFiles) {
         ctx.hasPartiallyStagedFiles = true
-        const unstagedPatch = this.getHiddenFilepath(PATCH_UNSTAGED)
+        const partialPatch = this.getHiddenFilepath(PATCH_PARTIAL)
         const files = processRenames(this.partiallyStagedFiles)
-        await this.execGit(['diff', ...GIT_DIFF_ARGS, '--output', unstagedPatch, '--', ...files])
+        await this.execGit(['diff', ...GIT_DIFF_ARGS, '--output', partialPatch, '--', ...files])
       } else {
         ctx.hasPartiallyStagedFiles = false
       }
@@ -157,6 +162,23 @@ class GitWorkflow {
     }
   }
 
+  /**
+   * Restore original HEAD state in case of errors
+   */
+  async restoreOriginalState(ctx) {
+    try {
+      debug('Restoring original state...')
+      await this.execGit(['checkout', '--force', '--', '.'])
+
+      const unstagedPatch = this.getHiddenFilepath(PATCH_UNSTAGED)
+      await this.execGit(['apply', ...GIT_APPLY_ARGS, unstagedPatch])
+
+      debug('Done restoring original state!')
+    } catch (error) {
+      handleError(error, ctx, RestoreOriginalStateError)
+    }
+  }
+
   /** Add all task modifications to index for files that were staged before running. */
   async applyModifications(ctx) {
     debug('Adding task modifications to index...')
@@ -188,16 +210,16 @@ class GitWorkflow {
    */
   async restorePartialChanges(ctx) {
     debug('Restoring unstaged changes...')
-    const unstagedPatch = this.getHiddenFilepath(PATCH_UNSTAGED)
+    const partialPatch = this.getHiddenFilepath(PATCH_PARTIAL)
     try {
-      await this.execGit(['apply', ...GIT_APPLY_ARGS, unstagedPatch])
+      await this.execGit(['apply', ...GIT_APPLY_ARGS, partialPatch])
     } catch (applyError) {
       debug('Error while restoring changes:')
       debug(applyError)
       debug('Retrying with 3-way merge')
       try {
         // Retry with a 3-way merge if normal apply fails
-        await this.execGit(['apply', ...GIT_APPLY_ARGS, '--3way', unstagedPatch])
+        await this.execGit(['apply', ...GIT_APPLY_ARGS, '--3way', partialPatch])
       } catch (threeWayApplyError) {
         debug('Error while restoring unstaged changes using 3-way merge:')
         debug(threeWayApplyError)
@@ -217,6 +239,7 @@ class GitWorkflow {
   async cleanup() {
     debug('Removing temp files...')
     await unlink(this.getHiddenFilepath(PATCH_UNSTAGED))
+    await unlink(this.getHiddenFilepath(PATCH_PARTIAL))
     debug('Done removing temp files!')
   }
 }

diff --git a/lib/runAll.js b/lib/runAll.js
@@ -220,17 +220,17 @@ const runAll = async (
         enabled: hasPartiallyStagedFiles,
       },
       ...listrTasks,
-      {
-        title: 'Reverting because of errors...',
-        task: (ctx) => git.hideUnstagedChanges(ctx),
-        enabled: restoreOriginalStateEnabled,
-        skip: restoreOriginalStateSkipped,
-      },
       {
         title: 'Applying modifications...',
         task: (ctx) => git.applyModifications(ctx),
         skip: applyModificationsSkipped,
       },
+      {
+        title: 'Reverting because of errors...',
+        task: (ctx) => git.restoreOriginalState(ctx),
+        enabled: restoreOriginalStateEnabled,
+        skip: restoreOriginalStateSkipped,
+      },
       {
         title: 'Restoring partial changes...',
         task: (ctx) => git.restorePartialChanges(ctx),

diff --git a/lib/state.js b/lib/state.js
@@ -21,17 +21,24 @@ const hasPartiallyStagedFiles = (ctx) => ctx.hasPartiallyStagedFiles
 const applyModificationsSkipped = (ctx) => {
   // Always apply back unstaged modifications when skipping backup
   if (!ctx.shouldBackup) return false
+
   // Should be skipped in case of git errors
   if (ctx.errors.has(GitError)) {
     return GIT_ERROR
   }
+
   // Should be skipped when tasks fail
   if (ctx.errors.has(TaskError)) {
     return TASK_ERROR
   }
 }
 
 const restorePartialChangesSkipped = (ctx) => {
+  // Should be skipped when entire state has already been restored
+  if (restoreOriginalStateEnabled(ctx)) {
+    return TASK_ERROR
+  }
+
   // Should be skipped in case of git errors
   if (ctx.errors.has(GitError)) {
     return GIT_ERROR

diff --git a/test/gitWorkflow.spec.js b/test/gitWorkflow.spec.js
@@ -68,7 +68,7 @@ describe('gitWorkflow', () => {
           "errors": Set {
             Symbol(GitError),
           },
-          "hasPartiallyStagedFiles": true,
+          "hasPartiallyStagedFiles": null,
           "output": Array [],
           "quiet": false,
           "shouldBackup": null,

diff --git a/test/integration.test.js b/test/integration.test.js
@@ -650,41 +650,6 @@ describe('lint-staged', () => {
     expect(await readFile('test2.js')).toEqual(testJsFilePretty)
   })
 
-  it('should fail when backup stash is missing', async () => {
-    await appendFile('test.js', testJsFilePretty)
-    await execGit(['add', 'test.js'])
-
-    // Remove backup stash during run
-    await expect(
-      gitCommit({ config: { '*.js': () => 'git stash drop' }, shell: true })
-    ).rejects.toThrowError()
-
-    expect(console.printHistory()).toMatchInlineSnapshot(`
-      "
-      LOG [STARTED] Preparing...
-      LOG [SUCCESS] Preparing...
-      LOG [STARTED] Running tasks...
-      LOG [STARTED] Running tasks for *.js
-      LOG [STARTED] git stash drop
-      ERROR [FAILED] git stash drop [FAILED]
-      ERROR [FAILED] git stash drop [FAILED]
-      LOG [SUCCESS] Running tasks...
-      LOG [STARTED] Reverting because of errors...
-      ERROR [FAILED] Cannot read properties of null (reading 'reduce')
-      LOG [STARTED] Applying modifications...
-      INFO [SKIPPED] 
-      [SKIPPED]   × lint-staged failed due to a git error.
-      LOG [STARTED] Cleaning up...
-      INFO [SKIPPED] 
-      [SKIPPED]   × lint-staged failed due to a git error.
-      ERROR 
-        × lint-staged failed due to a git error.
-      ERROR 
-      × git stash drop:
-      No stash entries found."
-    `)
-  })
-
   it('should fail when task reverts staged changes, to prevent an empty git commit', async () => {
     // Create and commit a pretty file without running lint-staged
     // This way the file will be available for the next step

diff --git a/test/runAll.spec.js b/test/runAll.spec.js
@@ -162,10 +162,10 @@ describe('runAll', () => {
       LOG [STARTED] echo \\"sample\\"
       ERROR [FAILED] echo \\"sample\\" [1]
       LOG [SUCCESS] Running tasks...
-      LOG [STARTED] Reverting because of errors...
-      LOG [SUCCESS] Reverting because of errors...
       LOG [STARTED] Applying modifications...
       INFO [SKIPPED] Skipped because of errors from tasks.
+      LOG [STARTED] Reverting because of errors...
+      LOG [SUCCESS] Reverting because of errors...
       LOG [STARTED] Cleaning up...
       LOG [SUCCESS] Cleaning up..."
     `)
@@ -199,10 +199,10 @@ describe('runAll', () => {
       LOG [STARTED] echo \\"sample\\"
       ERROR [FAILED] echo \\"sample\\" [SIGINT]
       LOG [SUCCESS] Running tasks...
-      LOG [STARTED] Reverting because of errors...
-      LOG [SUCCESS] Reverting because of errors...
       LOG [STARTED] Applying modifications...
       INFO [SKIPPED] Skipped because of errors from tasks.
+      LOG [STARTED] Reverting because of errors...
+      LOG [SUCCESS] Reverting because of errors...
       LOG [STARTED] Cleaning up...
       LOG [SUCCESS] Cleaning up..."
     `)