Extract common functionality between unzip implementations

Author: koesie10

extensions/ql-vscode/src/common/unzip-concurrently.ts

@@ -1,30 +1,16 @@
 import { availableParallelism } from "os";
-import { openZip, readZipEntries, unzipFile } from "./unzip";
+import { unzipToDirectory } from "./unzip";
 import PQueue from "p-queue";
 
 export async function unzipToDirectoryConcurrently(
   archivePath: string,
   destinationPath: string,
 ): Promise<void> {
-  const zipFile = await openZip(archivePath, {
-    autoClose: false,
-    strictFileNames: true,
-    lazyEntries: true,
+  const queue = new PQueue({
+    concurrency: availableParallelism(),
   });
 
-  try {
-    const entries = await readZipEntries(zipFile);
-
-    const queue = new PQueue({
-      concurrency: availableParallelism(),
-    });
-
-    await queue.addAll(
-      entries.map((entry) => async () => {
-        await unzipFile(zipFile, entry, destinationPath);
-      }),
-    );
-  } finally {
-    zipFile.close();
-  }
+  return unzipToDirectory(archivePath, destinationPath, async (tasks) => {
+    await queue.addAll(tasks);
+  });
 }

extensions/ql-vscode/src/common/unzip.ts

@@ -109,7 +109,7 @@ async function copyStream(
  * @param entry
  * @param rootDestinationPath
  */
-export async function unzipFile(
+async function unzipFile(
   zipFile: ZipFile,
   entry: ZipEntry,
   rootDestinationPath: string,
@@ -141,16 +141,18 @@ export async function unzipFile(
 }
 
 /**
- * Sequentially unzips all files from a zip archive. Please use
- * `unzipToDirectoryConcurrently` if you can. This function is only
- * provided because Jest cannot import `p-queue`.
+ * Unzips all files from a zip archive. Please use
+ * `unzipToDirectoryConcurrently` or `unzipToDirectorySequentially` instead
+ * of this function.
  *
  * @param archivePath
  * @param destinationPath
+ * @param taskRunner A function that runs the tasks (either sequentially or concurrently).
  */
-export async function unzipToDirectorySequentially(
+export async function unzipToDirectory(
   archivePath: string,
   destinationPath: string,
+  taskRunner: (tasks: Array<() => Promise<void>>) => Promise<void>,
 ): Promise<void> {
   const zipFile = await openZip(archivePath, {
     autoClose: false,
@@ -161,10 +163,29 @@ export async function unzipToDirectorySequentially(
   try {
     const entries = await readZipEntries(zipFile);
 
-    for (const entry of entries) {
-      await unzipFile(zipFile, entry, destinationPath);
-    }
+    await taskRunner(
+      entries.map((entry) => () => unzipFile(zipFile, entry, destinationPath)),
+    );
   } finally {
     zipFile.close();
   }
 }
+
+/**
+ * Sequentially unzips all files from a zip archive. Please use
+ * `unzipToDirectoryConcurrently` if you can. This function is only
+ * provided because Jest cannot import `p-queue`.
+ *
+ * @param archivePath
+ * @param destinationPath
+ */
+export async function unzipToDirectorySequentially(
+  archivePath: string,
+  destinationPath: string,
+): Promise<void> {
+  return unzipToDirectory(archivePath, destinationPath, async (tasks) => {
+    for (const task of tasks) {
+      await task();
+    }
+  });
+}