@capgo/cli 4.10.53 → 4.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/cli",
-  "version": "4.10.53",
+  "version": "4.11.0",
   "description": "A CLI to upload to capgo servers",
   "author": "github.com/riderx",
   "license": "Apache 2.0",
@@ -58,6 +58,7 @@
     "console-table-printer": "^2.12.1",
     "get-latest-version": "^5.1.0",
     "is-wsl": "^3.1.0",
+    "jszip": "^3.10.1",
     "ky": "^1.3.0",
     "logsnag": "1.0.0",
     "mime": "^4.0.3",

package/src/bundle/upload.ts

@@ -256,7 +256,7 @@ export async function uploadBundle(appid: string, options: Options, shouldExit =
   let checksum = ''
   let zipped: Buffer | null = null
   if (!external && useS3 === false) {
-    zipped = zipFile(path)
+    zipped = await zipFile(path)
     const s = p.spinner()
     s.start(`Calculating checksum`)
     checksum = await getChecksum(zipped, 'crc32')
@@ -329,7 +329,7 @@ It will be also visible in your dashboard\n`)
   }
   else {
     if (useS3) {
-      zipped = zipFile(path)
+      zipped = await zipFile(path)
       const s = p.spinner()
       s.start(`Calculating checksum`)
       checksum = await getChecksum(zipped, 'crc32')

package/src/bundle/zip.ts

@@ -28,110 +28,116 @@ interface Options extends OptionsBase {
 }
 
 export async function zipBundle(appId: string, options: Options) {
-  let { bundle, path } = options
-  const { json } = options
-  const snag = useLogSnag()
-  if (!json)
-    await checkLatest()
-
-  const config = await getConfig()
-  appId = appId || config?.app?.appId
-  // create bundle name format : 1.0.0-beta.x where x is a uuid
-  const uuid = randomUUID().split('-')[0]
-  bundle = bundle || config?.app?.package?.version || `0.0.1-beta.${uuid}`
-  if (!json)
-    p.intro(`Zipping ${appId}@${bundle}`)
-    // check if bundle is valid
-  if (!regexSemver.test(bundle)) {
+  try {
+    let { bundle, path } = options
+    const { json } = options
+    const snag = useLogSnag()
     if (!json)
-      p.log.error(`Your bundle name ${bundle}, is not valid it should follow semver convention : https://semver.org/`)
-    else
-      console.error(formatError({ error: 'invalid_semver' }))
-    program.error('')
-  }
-  path = path || config?.app?.webDir
-  if (!appId || !bundle || !path) {
+      await checkLatest()
+
+    const config = await getConfig()
+    appId = appId || config?.app?.appId
+    // create bundle name format : 1.0.0-beta.x where x is a uuid
+    const uuid = randomUUID().split('-')[0]
+    bundle = bundle || config?.app?.package?.version || `0.0.1-beta.${uuid}`
     if (!json)
-      p.log.error('Missing argument, you need to provide a appId and a bundle and a path, or be in a capacitor project')
-    else
-      console.error(formatError({ error: 'missing_argument' }))
-    program.error('')
-  }
-  if (!json)
-    p.log.info(`Started from path "${path}"`)
-  const checkNotifyAppReady = options.codeCheck
-  if (typeof checkNotifyAppReady === 'undefined' || checkNotifyAppReady) {
-    const isPluginConfigured = searchInDirectory(path, 'notifyAppReady')
-    if (!isPluginConfigured) {
+      p.intro(`Zipping ${appId}@${bundle}`)
+    // check if bundle is valid
+    if (!regexSemver.test(bundle)) {
       if (!json)
-        p.log.error(`notifyAppReady() is missing in the source code. see: https://capgo.app/docs/plugin/api/#notifyappready`)
+        p.log.error(`Your bundle name ${bundle}, is not valid it should follow semver convention : https://semver.org/`)
       else
-        console.error(formatError({ error: 'notifyAppReady_not_in_source_code' }))
+        console.error(formatError({ error: 'invalid_semver' }))
       program.error('')
     }
-    const foundIndex = checkIndexPosition(path)
-    if (!foundIndex) {
+    path = path || config?.app?.webDir
+    if (!appId || !bundle || !path) {
       if (!json)
-        p.log.error(`index.html is missing in the root folder or in the only folder in the root folder`)
+        p.log.error('Missing argument, you need to provide a appId and a bundle and a path, or be in a capacitor project')
       else
-        console.error(formatError({ error: 'index_html_not_found' }))
+        console.error(formatError({ error: 'missing_argument' }))
       program.error('')
     }
-  }
-  const zipped = zipFile(path)
-  if (!json)
-    p.log.info(`Zipped ${zipped.byteLength} bytes`)
-  const s = p.spinner()
-  if (!json)
-    s.start(`Calculating checksum`)
-  const checksum = await getChecksum(zipped, 'crc32')
-  if (!json)
-    s.stop(`Checksum: ${checksum}`)
-  const mbSize = Math.floor(zipped.byteLength / 1024 / 1024)
-  // We do not issue this warning for json
-  if (mbSize > alertMb && !json) {
-    p.log.warn(`WARNING !!\nThe app size is ${mbSize} Mb, this may take a while to download for users\n`)
-    p.log.warn(`Learn how to optimize your assets https://capgo.app/blog/optimise-your-images-for-updates/\n`)
+    if (!json)
+      p.log.info(`Started from path "${path}"`)
+    const checkNotifyAppReady = options.codeCheck
+    if (typeof checkNotifyAppReady === 'undefined' || checkNotifyAppReady) {
+      const isPluginConfigured = searchInDirectory(path, 'notifyAppReady')
+      if (!isPluginConfigured) {
+        if (!json)
+          p.log.error(`notifyAppReady() is missing in the source code. see: https://capgo.app/docs/plugin/api/#notifyappready`)
+        else
+          console.error(formatError({ error: 'notifyAppReady_not_in_source_code' }))
+        program.error('')
+      }
+      const foundIndex = checkIndexPosition(path)
+      if (!foundIndex) {
+        if (!json)
+          p.log.error(`index.html is missing in the root folder or in the only folder in the root folder`)
+        else
+          console.error(formatError({ error: 'index_html_not_found' }))
+        program.error('')
+      }
+    }
+    const zipped = await zipFile(path)
+    if (!json)
+      p.log.info(`Zipped ${zipped.byteLength} bytes`)
+    const s = p.spinner()
+    if (!json)
+      s.start(`Calculating checksum`)
+    const checksum = await getChecksum(zipped, 'crc32')
+    if (!json)
+      s.stop(`Checksum: ${checksum}`)
+    const mbSize = Math.floor(zipped.byteLength / 1024 / 1024)
+    // We do not issue this warning for json
+    if (mbSize > alertMb && !json) {
+      p.log.warn(`WARNING !!\nThe app size is ${mbSize} Mb, this may take a while to download for users\n`)
+      p.log.warn(`Learn how to optimize your assets https://capgo.app/blog/optimise-your-images-for-updates/\n`)
+      await snag.track({
+        channel: 'app-error',
+        event: 'App Too Large',
+        icon: '🚛',
+        tags: {
+          'app-id': appId,
+        },
+        notify: false,
+      }).catch()
+    }
+    const s2 = p.spinner()
+    const name = options.name || `${appId}_${bundle}.zip`
+    if (!json)
+      s2.start(`Saving to ${name}`)
+    writeFileSync(name, zipped)
+    if (!json)
+      s2.stop(`Saved to ${name}`)
+
     await snag.track({
-      channel: 'app-error',
-      event: 'App Too Large',
-      icon: '🚛',
+      channel: 'app',
+      event: 'App zip',
+      icon: '⏫',
       tags: {
         'app-id': appId,
       },
       notify: false,
     }).catch()
-  }
-  const s2 = p.spinner()
-  const name = options.name || `${appId}_${bundle}.zip`
-  if (!json)
-    s2.start(`Saving to ${name}`)
-  writeFileSync(name, zipped)
-  if (!json)
-    s2.stop(`Saved to ${name}`)
-
-  await snag.track({
-    channel: 'app',
-    event: 'App zip',
-    icon: '⏫',
-    tags: {
-      'app-id': appId,
-    },
-    notify: false,
-  }).catch()
 
-  if (!json)
-    p.outro(`Done ✅`)
+    if (!json)
+      p.outro(`Done ✅`)
 
-  if (json) {
-    const output = {
-      bundle,
-      filename: name,
-      checksum,
+    if (json) {
+      const output = {
+        bundle,
+        filename: name,
+        checksum,
+      }
+      // Keep the console log and stringify for user who parse the output
+      // eslint-disable-next-line no-console
+      console.log(JSON.stringify(output, null, 2))
     }
-    // Keep the console log and stringify for user who parse the output
-    // eslint-disable-next-line no-console
-    console.log(JSON.stringify(output, null, 2))
+    process.exit()
+  }
+  catch (error) {
+    p.log.error(formatError(error))
+    program.error('')
   }
-  process.exit()
 }

package/src/utils.ts

@@ -1,6 +1,6 @@
-import { existsSync, readFileSync, readdirSync } from 'node:fs'
-import os, { homedir } from 'node:os'
-import { resolve } from 'node:path'
+import { existsSync, readFileSync, readdirSync, statSync } from 'node:fs'
+import { homedir, release as osRelease } from 'node:os'
+import { join, resolve, sep } from 'node:path'
 import process from 'node:process'
 import type { Buffer } from 'node:buffer'
 import { loadConfig } from '@capacitor/cli/dist/config'
@@ -17,6 +17,7 @@ import type { InstallCommand, PackageManagerRunner, PackageManagerType } from '@
 import { findInstallCommand, findPackageManagerRunner, findPackageManagerType } from '@capgo/find-package-manager'
 import AdmZip from 'adm-zip'
 import isWsl from 'is-wsl'
+import JSZip from 'jszip'
 import type { Database } from './types/supabase.types'
 
 export const baseKey = '.capgo_key'
@@ -518,17 +519,50 @@ async function prepareMultipart(supabase: SupabaseClient<Database>, appId: strin
   }
 }
 
-export function zipFile(filePath: string) {
-  //  if windows and not wsl then do error
-  if (os.release().toLowerCase().includes('microsoft') && !isWsl) {
-    p.log.error(`Windows powershell is not supported, please use WSL or a Linux distribution`)
-    program.error('')
+export async function zipFile(filePath: string): Promise<Buffer> {
+  if (osRelease().toLowerCase().includes('microsoft') && !isWsl) {
+    return zipFileWindows(filePath)
+  }
+  else {
+    return zipFileUnix(filePath)
   }
+}
+
+export function zipFileUnix(filePath: string) {
   const zip = new AdmZip()
   zip.addLocalFolder(filePath)
   return zip.toBuffer()
 }
 
+export async function zipFileWindows(filePath: string): Promise<Buffer> {
+  const zip = new JSZip()
+
+  // Helper function to recursively add files and folders to the ZIP archive
+  const addToZip = async (folderPath: string, zipPath: string) => {
+    const items = readdirSync(folderPath)
+
+    for (const item of items) {
+      const itemPath = join(folderPath, item)
+      const stats = statSync(itemPath)
+
+      if (stats.isFile()) {
+        const fileContent = await readFileSync(itemPath)
+        zip.file(join(zipPath, item).split(sep).join('/'), fileContent)
+      }
+      else if (stats.isDirectory()) {
+        await addToZip(itemPath, join(zipPath, item))
+      }
+    }
+  }
+
+  // Start adding files and folders to the ZIP archive
+  await addToZip(filePath, '')
+
+  // Generate the ZIP file as a Buffer
+  const zipBuffer = await zip.generateAsync({ type: 'nodebuffer', platform: 'UNIX', compression: 'DEFLATE' })
+  return zipBuffer
+}
+
 async function finishMultipartDownload(key: string, uploadId: string, url: string, parts: any[]) {
   const metadata = {
     action: 'mpu-complete',

package/test/test_zip_swift/Package.resolved

@@ -0,0 +1,24 @@
+{
+  "originHash" : "be28ad70f15d01b567aeb05f85c074fc7d437a0ade8a8ceab7a6149b8f5b3593",
+  "pins" : [
+    {
+      "identity" : "swift-argument-parser",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-argument-parser",
+      "state" : {
+        "revision" : "0fbc8848e389af3bb55c182bc19ca9d5dc2f255b",
+        "version" : "1.4.0"
+      }
+    },
+    {
+      "identity" : "ziparchive",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/ZipArchive/ZipArchive.git",
+      "state" : {
+        "revision" : "79d4dc9729096c6ad83dd3cee2b9f354d1b4ab7b",
+        "version" : "2.5.5"
+      }
+    }
+  ],
+  "version" : 3
+}

package/test/test_zip_swift/Package.swift

@@ -0,0 +1,29 @@
+// swift-tools-version: 5.10
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "MyCLI",
+    platforms: [
+        .macOS(.v11)
+    ], dependencies: [
+        .package(url: "https://github.com/apple/swift-argument-parser.git", .upToNextMajor(from: "1.4.0")),
+        .package(url: "https://github.com/ZipArchive/ZipArchive.git", .upToNextMajor(from: "2.5.5"))
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package, defining a module or a test suite.
+        // Targets can depend on other targets in this package and products from dependencies.
+        .executableTarget(
+            name: "MyCLI", 
+            dependencies: [
+                .product(name: "ZipArchive", package: "ZipArchive"),
+                .product(name: "ArgumentParser", package: "swift-argument-parser"),
+            ],
+            path: "Sources",
+            swiftSettings: [
+                .unsafeFlags(["-parse-as-library"])
+            ]
+        ),
+    ]
+)

package/test/test_zip_swift/Sources/main.swift

@@ -0,0 +1,80 @@
+// The Swift Programming Language
+// https://docs.swift.org/swift-book
+
+import ArgumentParser
+import Foundation
+import ZipArchive
+import Darwin
+
+extension URL {
+    var isDirectory: Bool {
+        (try? resourceValues(forKeys: [.isDirectoryKey]))?.isDirectory == true
+    }
+    var exist: Bool {
+        return FileManager().fileExists(atPath: self.path)
+    }
+}
+
+
+func verifyZipFile(zipFilePath: String) {
+    let destUnZip = URL(fileURLWithPath: NSTemporaryDirectory()).appendingPathComponent("extracted")
+
+    var unzipError: NSError?
+    let success = SSZipArchive.unzipFile(atPath: zipFilePath,
+         toDestination: destUnZip.path,
+         preserveAttributes: true,
+         overwrite: true,
+         nestedZipLevel: 1,
+         password: nil,
+         error: &unzipError,
+         delegate: nil,
+         progressHandler: { (entry, _, _, _) in
+            if entry.contains("\\") {
+                print("Windows path is not supported: \(entry)")
+                exit(1)
+            }
+
+            let fileURL = destUnZip.appendingPathComponent(entry)
+            let canonicalPath = fileURL.path
+            let canonicalDir = destUnZip.path
+
+            if !canonicalPath.hasPrefix(canonicalDir) {
+                print("SecurityException, Failed to ensure directory is the start path: \(canonicalDir) of \(canonicalPath)")
+                exit(1)
+            }
+         },
+         completionHandler: nil)
+
+    if !success || unzipError != nil {
+        print("Failed to unzip file: \(zipFilePath)")
+        print("Error: \(unzipError?.localizedDescription ?? "")")
+        exit(1)
+    }
+
+    print("ZIP file is valid: \(zipFilePath)")
+}
+
+@main
+struct CapgoCliTest: ParsableCommand {
+    @Option(parsing: .upToNextOption, help: "Specify the files to test")
+  public var zipFiles: [String]
+
+  public func run() throws {
+    print("Hello capgo test", zipFiles)
+      
+      for file in zipFiles {
+          guard let fileUrl =  URL(string: file) else {
+              print("Cannot convert \"\(file)\" into a file")
+              Darwin.exit(1)
+          }
+          
+          if (!fileUrl.exist) {
+              print("File \"\(fileUrl)\" does not exist")
+              Darwin.exit(1)
+          }
+          
+        print("Testing file \(file)")
+        verifyZipFile(zipFilePath: file)
+      }
+  }
+}