fix: resolve bug in unarchive method (#144)

Author: sohail2721

package-lock.json

@@ -61,6 +61,7 @@
         "connect-livereload": "^0.6.1",
         "execa": "^9.6.0",
         "express": "^4.17.1",
+        "extract-zip": "^2.0.1",
         "file-type": "^15.0.0",
         "form-data": "^4.0.2",
         "fs-extra": "^11.3.0",
@@ -74,7 +75,6 @@
         "tmp-promise": "^3.0.3",
         "treeify": "^1.1.0",
         "tslib": "^2.8.1",
-        "unzipper": "^0.12.3",
         "uuid": "^11.1.0",
         "yaml": "^2.8.0"
     },

package.json

@@ -12,7 +12,6 @@ import { SDKClient } from "../../client-utils/sdk-client.js";
 import {
   createTempDirectory,
   isValidUrl,
-  unzipFile,
   getMessageInRedColor,
   clearDirectory,
   deleteFile
@@ -22,8 +21,13 @@ import { AuthorizationError, GetValidationParams } from "../../types/api/validat
 import { metadataFileContent, staticPortalRepoUrl } from "../../config/env.js";
 import { PortalQuickstartPrompts } from "../../prompts/portal/quickstart.js";
 import { AuthenticationError } from "../../types/utils.js";
+import { ZipService } from "../../infrastructure/zip-service.js";
+import { FilePath } from "../../types/file/filePath.js";
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { FileName } from "../../types/file/fileName.js";
 
 export class PortalQuickstartController {
+  private readonly zipService = new ZipService();
   private readonly specUrl =
     "https://github.com/apimatic/static-portal-workflow/blob/master/spec/openapi.json";
 
@@ -110,10 +114,10 @@ export class PortalQuickstartController {
         }
       } else {
         specPath = path.normalize(specPath);
-        const fileType = await filetype.fromFile(specPath);
+        const fileType = await filetype.fromFile(specPath); 
 
         if (fileType?.ext === "zip") {
-          await unzipFile(fs.createReadStream(specPath), tempSpecDir);
+          await this.zipService.unArchive(new FilePath(new DirectoryPath(path.dirname(specPath)), new FileName(path.basename(specPath))), new DirectoryPath(tempSpecDir));
         } else {
           const destinationPath = path.join(tempSpecDir, path.basename(specPath));
           await fsExtra.copy(specPath, destinationPath);

src/controllers/portal/quickstart.ts

@@ -1,6 +1,6 @@
 import fs from "fs";
 import archiver from "archiver";
-import unzipper from "unzipper";
+import extract from "extract-zip";
 import { DirectoryPath } from "../types/file/directoryPath.js";
 import { FilePath } from "../types/file/filePath.js";
 
@@ -19,12 +19,27 @@ export class ZipService {
     });
   }
 
-  async unArchive(sourceFile: FilePath, destinationDirectory: DirectoryPath): Promise<void>  {
-    return new Promise((resolve, reject) => {
-      fs.createReadStream(sourceFile.toString())
-        .pipe(unzipper.Extract({ path: destinationDirectory.toString() }))
-        .on("close", () => resolve())
-        .on("error", (err) => reject(err));
+  public async unArchive(sourceFile: FilePath, destinationDirectory: DirectoryPath): Promise<void> {
+    const MAX_FILES = 100_000;
+    const MAX_SIZE = 1_000_000_000; // 1 GB
+    let fileCount = 0;
+    let totalSize = 0;
+
+    await extract(sourceFile.toString(), {
+      dir: destinationDirectory.toString(),
+      onEntry: function (entry) {
+        fileCount++;
+        if (fileCount > MAX_FILES) {
+          throw new Error("Reached max. file count");
+        }
+        // The uncompressedSize comes from the zip headers, so it might not be trustworthy.
+        // Alternatively, calculate the size from the readStream.
+        let entrySize = entry.uncompressedSize;
+        totalSize += entrySize;
+        if (totalSize > MAX_SIZE) {
+          throw new Error("Reached max. size");
+        }
+      }
     });
   }
 }

src/infrastructure/zip-service.ts

@@ -3,25 +3,11 @@ import fs from "fs";
 import fsExtra from "fs-extra";
 import os from "os";
 import archiver from "archiver";
-import unzipper from "unzipper";
 import stripTags from "striptags";
 import colors from "picocolors";
 
 import { loggers, ValidationMessages } from "../types/utils.js";
 
-export const unzipFile = (stream: NodeJS.ReadableStream, destination: string) => {
-  return new Promise((resolve, reject) => {
-    const extractStream = unzipper.Extract({ path: destination });
-
-    stream
-      .pipe(extractStream)
-      .on("error", (error: Error) => reject(new Error("Error during extraction: " + error.message)));
-
-    extractStream.on("close", () => resolve("Extracted"));
-    extractStream.on("error", (error: Error) => reject(new Error("Error during extraction: " + error.message)));
-  });
-};
-
 export const createTempDirectory = async () => {
   return fs.mkdtempSync(path.join(os.tmpdir(), "apimatic-cli-"));
 };