fix: Hanging indefinitely when unzip fails with an empty error

Author: Camille Drapier

cli/CHANGELOG.md

@@ -1,4 +1,12 @@
 <!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
+## 13.6.5
+
+_Released 2/15/2024 (PENDING)_
+
+**Bugfixes:**
+
+- Fixed an issue with the unzip promise never being rejected when an empty error happens. Fixed in [#28850](https://github.com/cypress-io/cypress/pull/28850).
+
 ## 13.6.4
 
 _Released 1/30/2024_

cli/lib/tasks/unzip.js

@@ -84,11 +84,11 @@ const unzip = ({ zipFilePath, installDir, progress }) => {
             return resolve()
           })
           .catch((err) => {
-            if (err) {
-              debug('error %s', err.message)
+            const error = err || new Error('Unknown error with Node extract tool')
 
-              return reject(err)
-            }
+            debug('error %s', error.message)
+
+            return reject(error)
           })
         }
 

cli/test/lib/tasks/unzip_spec.js

@@ -132,6 +132,45 @@ describe('lib/tasks/unzip', function () {
       })
     })
 
+    it('can try unzip first then fall back to node unzip and fails with an empty error', async function () {
+      const zipFilePath = path.join('test', 'fixture', 'example.zip')
+
+      sinon.stub(unzip.utils.unzipTools, 'extract').callsFake(() => {
+        return new Promise((_, reject) => reject())
+      })
+
+      const unzipChildProcess = new events.EventEmitter()
+
+      unzipChildProcess.stdout = {
+        on () {},
+      }
+
+      unzipChildProcess.stderr = {
+        on () {},
+      }
+
+      sinon.stub(cp, 'spawn').withArgs('unzip').returns(unzipChildProcess)
+
+      setTimeout(() => {
+        debug('emitting unzip error')
+        unzipChildProcess.emit('error', new Error('unzip fails badly'))
+      }, 100)
+
+      try {
+        await unzip
+        .start({
+          zipFilePath,
+          installDir,
+        })
+      } catch (err) {
+        logger.error(err)
+        expect(err.message).to.include('Unknown error with Node extract tool')
+
+        return
+      }
+      throw new Error('should have failed')
+    })
+
     it('calls node unzip just once', function (done) {
       const zipFilePath = path.join('test', 'fixture', 'example.zip')