Fix race between two 'finish' events

When unzipping the file that is being downloaded, there are two streams
whose `finish` event are eagerly awaited: the stream that unpacks the
last entry of the .zip file and the stream that processes the .zip file
itself.

When this code was originally written, the stream that extracted the
.zip entry always sent its `finish` event before the stream that
processed the enclosing .zip file.

However, with our upgrade to node.js v20.x, this seems no longer to be
true. As a consequence, the code that wants to verify that all expected
bytes were extracted now _sometimes_ runs too early, and shouts
"failure" just before the code that extracts the bytes runs and all
files are written correctly.

Let's work around it by ensuring that both `finish` events were received
before determining success or failure.

Signed-off-by: Johannes Schindelin <[email protected]>

Author: dscho

src/downloader.ts

@@ -70,6 +70,16 @@ export async function unzip(
         process.stderr.write(`Writing ${storeZipAs}\n`)
         res.pipe(fs.createWriteStream(storeZipAs)).on('error', reject)
       }
+
+      let writingEntry = false
+      let wroteLastEntry = false
+      const finish = (): void => {
+        if (writingEntry || !wroteLastEntry) return
+        if (bytesToExtract === 0) resolve(files)
+        // eslint-disable-next-line prefer-promise-reject-errors
+        else reject(`${bytesToExtract} bytes left to extract`)
+      }
+
       res
         .on('error', reject)
         .pipe(unzipper.Parse())
@@ -88,21 +98,23 @@ export async function unzip(
             mkdirp(entryPath.replace(/\/$/, ''))
             entry.autodrain()
           } else {
+            writingEntry = true
             progress(entryPath)
             entry
               .pipe(fs.createWriteStream(`${entryPath}`))
+              .on('error', reject)
               .on('finish', () => {
                 bytesToExtract -= fs.statSync(entryPath).size
+                writingEntry = false
+                finish()
               })
           }
         })
         .on('error', reject)
         .on('finish', progress)
         .on('finish', () => {
-          bytesToExtract === 0
-            ? resolve(files)
-            : // eslint-disable-next-line prefer-promise-reject-errors
-              reject(`${bytesToExtract} bytes left to extract`)
+          wroteLastEntry = true
+          finish()
         })
     }
     if (url.startsWith('file:')) {