@capgo/cli 4.0.11 → 4.0.13

package/src/bundle/upload.ts

@@ -1,30 +1,44 @@
-import { randomUUID } from 'node:crypto';
-import { existsSync, readFileSync } from 'node:fs';
-import AdmZip from 'adm-zip';
-import { program } from 'commander';
-import * as p from '@clack/prompts';
-import { checksum as getChecksum } from '@tomasklaen/checksum';
-import ciDetect from 'ci-info';
-import ky from 'ky';
-import { checkLatest } from '../api/update';
-import { checkAppExistsAndHasPermissionOrgErr } from "../api/app";
-import { encryptSource } from '../api/crypto';
-import {
+import { randomUUID } from 'node:crypto'
+import { existsSync, readFileSync } from 'node:fs'
+import process from 'node:process'
+import type { Buffer } from 'node:buffer'
+import AdmZip from 'adm-zip'
+import { program } from 'commander'
+import * as p from '@clack/prompts'
+import { checksum as getChecksum } from '@tomasklaen/checksum'
+import ciDetect from 'ci-info'
+import ky from 'ky'
+import { checkLatest } from '../api/update'
+import { checkAppExistsAndHasPermissionOrgErr } from '../api/app'
+import { encryptSource } from '../api/crypto'
+import type {
   OptionsBase,
-  getConfig, createSupabaseClient,
-  uploadUrl,
-  updateOrCreateChannel, updateOrCreateVersion,
-  formatError, findSavedKey, checkPlanValid,
-  useLogSnag, regexSemver, baseKeyPub, convertAppName, getLocalConfig, checkCompatibility, requireUpdateMetadata,
-  getLocalDepenencies,
-  verifyUser,
+} from '../utils'
+import {
   OrganizationPerm,
+  baseKeyPub,
+  checkCompatibility,
+  checkPlanValid,
+  convertAppName,
+  createSupabaseClient,
+  findSavedKey,
+  formatError,
+  getAppOwner,
+  getConfig,
+  getLocalConfig,
+  getLocalDepenencies,
   hasOrganizationPerm,
-  getAppOwner
-} from '../utils';
-import { checkIndexPosition, searchInDirectory } from './check';
+  regexSemver,
+  requireUpdateMetadata,
+  updateOrCreateChannel,
+  updateOrCreateVersion,
+  uploadUrl,
+  useLogSnag,
+  verifyUser,
+} from '../utils'
+import { checkIndexPosition, searchInDirectory } from './check'
 
-const alertMb = 20;
+const alertMb = 20
 
 interface Options extends OptionsBase {
   bundle?: string
@@ -32,75 +46,74 @@ interface Options extends OptionsBase {
   channel?: string
   displayIvSession?: boolean
   external?: string
-  key?: boolean | string,
-  keyData?: string,
-  ivSessionKey?: string,
+  key?: boolean | string
+  keyData?: string
+  ivSessionKey?: string
   bundleUrl?: boolean
-  codeCheck?: boolean,
-  minUpdateVersion?: string,
-  autoMinUpdateVersion?: boolean,
+  codeCheck?: boolean
+  minUpdateVersion?: string
+  autoMinUpdateVersion?: boolean
   ignoreMetadataCheck?: boolean
 }
 
-export const uploadBundle = async (appid: string, options: Options, shouldExit = true) => {
-
-  p.intro(`Uploading`);
-  await checkLatest();
-  let { bundle, path, channel } = options;
-  const { external, key = false, displayIvSession, autoMinUpdateVersion, ignoreMetadataCheck } = options;
+export async function uploadBundle(appid: string, options: Options, shouldExit = true) {
+  p.intro(`Uploading`)
+  await checkLatest()
+  let { bundle, path, channel } = options
+  const { external, key = false, displayIvSession, autoMinUpdateVersion, ignoreMetadataCheck } = options
   let { minUpdateVersion } = options
   options.apikey = options.apikey || findSavedKey()
   const snag = useLogSnag()
 
-  channel = channel || 'dev';
+  channel = channel || 'dev'
 
-  const config = await getConfig();
+  const config = await getConfig()
   const localS3: boolean = (config.app.extConfig.plugins && config.app.extConfig.plugins.CapacitorUpdater
-    && config.app.extConfig.plugins.CapacitorUpdater.localS3) === true;
+    && config.app.extConfig.plugins.CapacitorUpdater.localS3) === true
 
   const checkNotifyAppReady = options.codeCheck
   appid = appid || config?.app?.appId
   // create bundle name format : 1.0.0-beta.x where x is a uuid
-  const uuid = randomUUID().split('-')[0];
+  const uuid = randomUUID().split('-')[0]
   bundle = bundle || config?.app?.package?.version || `0.0.1-beta.${uuid}`
-  // check if bundle is valid 
+  // check if bundle is valid
   if (!regexSemver.test(bundle)) {
-    p.log.error(`Your bundle name ${bundle}, is not valid it should follow semver convention : https://semver.org/`);
-    program.error('');
+    p.log.error(`Your bundle name ${bundle}, is not valid it should follow semver convention : https://semver.org/`)
+    program.error('')
   }
   path = path || config?.app?.webDir
   if (!options.apikey) {
-    p.log.error(`Missing API key, you need to provide a API key to upload your bundle`);
-    program.error('');
+    p.log.error(`Missing API key, you need to provide a API key to upload your bundle`)
+    program.error('')
   }
   if (!appid || !bundle || !path) {
-    p.log.error("Missing argument, you need to provide a appid and a bundle and a path, or be in a capacitor project");
-    program.error('');
+    p.log.error('Missing argument, you need to provide a appid and a bundle and a path, or be in a capacitor project')
+    program.error('')
   }
   // check if path exist
   if (!existsSync(path)) {
-    p.log.error(`Path ${path} does not exist, build your app first, or provide a valid path`);
-    program.error('');
+    p.log.error(`Path ${path} does not exist, build your app first, or provide a valid path`)
+    program.error('')
   }
 
   if (typeof checkNotifyAppReady === 'undefined' || checkNotifyAppReady) {
     const isPluginConfigured = searchInDirectory(path, 'notifyAppReady')
     if (!isPluginConfigured) {
-      p.log.error(`notifyAppReady() is missing in the source code. see: https://capgo.app/docs/plugin/api/#notifyappready`);
-      program.error('');
+      p.log.error(`notifyAppReady() is missing in the source code. see: https://capgo.app/docs/plugin/api/#notifyappready`)
+      program.error('')
     }
-    const foundIndex = checkIndexPosition(path);
+    const foundIndex = checkIndexPosition(path)
     if (!foundIndex) {
-      p.log.error(`index.html is missing in the root folder or in the only folder in the root folder`);
-      program.error('');
+      p.log.error(`index.html is missing in the root folder or in the only folder in the root folder`)
+      program.error('')
     }
   }
 
-  p.log.info(`Upload ${appid}@${bundle} started from path "${path}" to Capgo cloud`);
+  p.log.info(`Upload ${appid}@${bundle} started from path "${path}" to Capgo cloud`)
 
   const localConfig = await getLocalConfig()
   const supabase = await createSupabaseClient(options.apikey)
-  const userId = await verifyUser(supabase, options.apikey, ['write', 'all', 'upload']);
+  const userId = await verifyUser(supabase, options.apikey, ['write', 'all', 'upload'])
   // Check we have app access to this appId
   // await checkAppExistsAndHasPermissionErr(supabase, options.apikey, appid);
 
@@ -118,73 +131,76 @@ export const uploadBundle = async (appid: string, options: Options, shouldExit =
     .single()
 
   // eslint-disable-next-line no-undef-init
-  let localDependencies: Awaited<ReturnType<typeof getLocalDepenencies>> | undefined = undefined;
-  let finalCompatibility: Awaited<ReturnType<typeof checkCompatibility>>['finalCompatibility'];
+  let localDependencies: Awaited<ReturnType<typeof getLocalDepenencies>> | undefined = undefined
+  let finalCompatibility: Awaited<ReturnType<typeof checkCompatibility>>['finalCompatibility']
 
   // We only check compatibility IF the channel exists
   if (!channelError && channelData && channelData.version && (channelData.version as any).native_packages && !ignoreMetadataCheck) {
-    const spinner = p.spinner();
-    spinner.start(`Checking bundle compatibility with channel ${channel}`);
+    const spinner = p.spinner()
+    spinner.start(`Checking bundle compatibility with channel ${channel}`)
     const {
       finalCompatibility: finalCompatibilityWithChannel,
-      localDependencies: localDependenciesWithChannel
+      localDependencies: localDependenciesWithChannel,
     } = await checkCompatibility(supabase, appid, channel)
 
     finalCompatibility = finalCompatibilityWithChannel
     localDependencies = localDependenciesWithChannel
 
-    if (finalCompatibility.find((x) => x.localVersion !== x.remoteVersion)) {
-      p.log.error(`Your bundle is not compatible with the channel ${channel}`);
-      p.log.warn(`You can check compatibility with "npx @capgo/cli bundle compatibility"`);
+    if (finalCompatibility.find(x => x.localVersion !== x.remoteVersion)) {
+      p.log.error(`Your bundle is not compatible with the channel ${channel}`)
+      p.log.warn(`You can check compatibility with "npx @capgo/cli bundle compatibility"`)
 
       if (autoMinUpdateVersion) {
         minUpdateVersion = bundle
-        p.log.info(`Auto set min-update-version to ${minUpdateVersion}`);
+        p.log.info(`Auto set min-update-version to ${minUpdateVersion}`)
       }
-    } else if (autoMinUpdateVersion) {
+    }
+    else if (autoMinUpdateVersion) {
       try {
         const { minUpdateVersion: lastMinUpdateVersion } = channelData.version as any
         if (!lastMinUpdateVersion || !regexSemver.test(lastMinUpdateVersion)) {
-          p.log.error('Invalid remote min update version, skipping auto setting compatibility');
-          program.error('');
+          p.log.error('Invalid remote min update version, skipping auto setting compatibility')
+          program.error('')
         }
 
         minUpdateVersion = lastMinUpdateVersion
-        p.log.info(`Auto set min-update-version to ${minUpdateVersion}`);
-      } catch (error) {
-        p.log.error(`Cannot auto set compatibility, invalid data ${channelData}`);
-        program.error('');
+        p.log.info(`Auto set min-update-version to ${minUpdateVersion}`)
+      }
+      catch (error) {
+        p.log.error(`Cannot auto set compatibility, invalid data ${channelData}`)
+        program.error('')
       }
     }
-    spinner.stop(`Bundle compatible with ${channel} channel`);
-  } else if (!ignoreMetadataCheck) {
-    p.log.warn(`Channel ${channel} is new or it's your first upload with compatibility check, it will be ignored this time`);
+    spinner.stop(`Bundle compatible with ${channel} channel`)
+  }
+  else if (!ignoreMetadataCheck) {
+    p.log.warn(`Channel ${channel} is new or it's your first upload with compatibility check, it will be ignored this time`)
     localDependencies = await getLocalDepenencies()
 
     if (autoMinUpdateVersion) {
       minUpdateVersion = bundle
-      p.log.info(`Auto set min-update-version to ${minUpdateVersion}`);
+      p.log.info(`Auto set min-update-version to ${minUpdateVersion}`)
     }
   }
 
   if (updateMetadataRequired && !minUpdateVersion && !ignoreMetadataCheck) {
-    p.log.error(`You need to provide a min-update-version to upload a bundle to this channel`);
-    program.error('');
+    p.log.error(`You need to provide a min-update-version to upload a bundle to this channel`)
+    program.error('')
   }
 
   if (minUpdateVersion) {
     if (!regexSemver.test(minUpdateVersion)) {
-      p.log.error(`Your minimal version update ${minUpdateVersion}, is not valid it should follow semver convention : https://semver.org/`);
-      program.error('');
+      p.log.error(`Your minimal version update ${minUpdateVersion}, is not valid it should follow semver convention : https://semver.org/`)
+      program.error('')
     }
   }
 
   const { data: isTrial, error: isTrialsError } = await supabase
     .rpc('is_trial', { userid: userId })
     .single()
-  if (isTrial && isTrial > 0 || isTrialsError) {
-    p.log.warn(`WARNING !!\nTrial expires in ${isTrial} days`);
-    p.log.warn(`Upgrade here: ${localConfig.hostWeb}/dashboard/settings/plans`);
+  if ((isTrial && isTrial > 0) || isTrialsError) {
+    p.log.warn(`WARNING !!\nTrial expires in ${isTrial} days`)
+    p.log.warn(`Upgrade here: ${localConfig.hostWeb}/dashboard/settings/plans`)
   }
 
   // check if app already exist
@@ -193,37 +209,37 @@ export const uploadBundle = async (appid: string, options: Options, shouldExit =
     .single()
 
   if (appVersion || appVersionError) {
-    p.log.error(`Version already exists ${formatError(appVersionError)}`);
-    program.error('');
+    p.log.error(`Version already exists ${formatError(appVersionError)}`)
+    program.error('')
   }
   // make bundle safe for s3 name https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
-  const safeBundle = bundle.replace(/[^a-zA-Z0-9-_.!*'()]/g, '__');
-  const fileName = `${safeBundle}.zip`;
+  const safeBundle = bundle.replace(/[^a-zA-Z0-9-_.!*'()]/g, '__')
+  const fileName = `${safeBundle}.zip`
 
-  let sessionKey;
+  let sessionKey
   let checksum = ''
-  let zipped: Buffer | null = null;
+  let zipped: Buffer | null = null
   if (!external) {
-    const zip = new AdmZip();
-    zip.addLocalFolder(path);
-    zipped = zip.toBuffer();
+    const zip = new AdmZip()
+    zip.addLocalFolder(path)
+    zipped = zip.toBuffer()
     const s = p.spinner()
-    s.start(`Calculating checksum`);
-    checksum = await getChecksum(zipped, 'crc32');
-    s.stop(`Checksum: ${checksum}`);
+    s.start(`Calculating checksum`)
+    checksum = await getChecksum(zipped, 'crc32')
+    s.stop(`Checksum: ${checksum}`)
     if (key || existsSync(baseKeyPub)) {
       const publicKey = typeof key === 'string' ? key : baseKeyPub
       let keyData = options.keyData || ''
       // check if publicKey exist
       if (!keyData && !existsSync(publicKey)) {
-        p.log.error(`Cannot find public key ${publicKey}`);
-        if (ciDetect.isCI) {
-          program.error('');
-        }
+        p.log.error(`Cannot find public key ${publicKey}`)
+        if (ciDetect.isCI)
+          program.error('')
+
         const res = await p.confirm({ message: 'Do you want to use our public key ?' })
         if (!res) {
-          p.log.error(`Error: Missing public key`);
-          program.error('');
+          p.log.error(`Error: Missing public key`)
+          program.error('')
         }
         keyData = localConfig.signKey || ''
       }
@@ -243,20 +259,20 @@ export const uploadBundle = async (appid: string, options: Options, shouldExit =
         keyData = keyFile.toString()
       }
       // encrypt
-      p.log.info(`Encrypting your bundle`);
+      p.log.info(`Encrypting your bundle`)
       const res = encryptSource(zipped, keyData)
       sessionKey = res.ivSessionKey
       if (displayIvSession) {
         p.log.info(`Your Iv Session key is ${sessionKey},
 keep it safe, you will need it to decrypt your bundle.
-It will be also visible in your dashboard\n`);
+It will be also visible in your dashboard\n`)
       }
       zipped = res.encryptedData
     }
-    const mbSize = Math.floor(zipped.byteLength / 1024 / 1024);
+    const mbSize = Math.floor(zipped.byteLength / 1024 / 1024)
     if (mbSize > alertMb) {
-      p.log.warn(`WARNING !!\nThe app size is ${mbSize} Mb, this may take a while to download for users\n`);
-      p.log.info(`Learn how to optimize your assets https://capgo.app/blog/optimise-your-images-for-updates/\n`);
+      p.log.warn(`WARNING !!\nThe app size is ${mbSize} Mb, this may take a while to download for users\n`)
+      p.log.info(`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',
@@ -268,10 +284,12 @@ It will be also visible in your dashboard\n`);
         notify: false,
       }).catch()
     }
-  } else if (external && !external.startsWith('https://')) {
-    p.log.error(`External link should should start with "https://" current is "${external}"`);
-    program.error('');
-  } else {
+  }
+  else if (external && !external.startsWith('https://')) {
+    p.log.error(`External link should should start with "https://" current is "${external}"`)
+    program.error('')
+  }
+  else {
     await snag.track({
       channel: 'app',
       event: 'App external',
@@ -285,11 +303,12 @@ It will be also visible in your dashboard\n`);
     sessionKey = options.ivSessionKey
   }
 
-  const hashedLocalDependencies = localDependencies ? new Map(localDependencies
-    .filter((a) => !!a.native && a.native !== undefined)
-    .map((a) => [a.name, a])) : new Map()
+  const hashedLocalDependencies = localDependencies
+    ? new Map(localDependencies
+      .filter(a => !!a.native && a.native !== undefined)
+      .map(a => [a.name, a]))
+    : new Map()
 
-  // eslint-disable-next-line max-len
   const nativePackages = (hashedLocalDependencies.size > 0 || !options.ignoreMetadataCheck) ? Array.from(hashedLocalDependencies, ([name, value]) => ({ name, version: value.version })) : undefined
 
   const appOwner = await getAppOwner(supabase, appid)
@@ -306,35 +325,36 @@ It will be also visible in your dashboard\n`);
     native_packages: nativePackages,
     checksum,
   }
-  const { error: dbError } = await updateOrCreateVersion(supabase, versionData, options.apikey)
+  const { error: dbError } = await updateOrCreateVersion(supabase, versionData)
   if (dbError) {
-    p.log.error(`Cannot add bundle ${formatError(dbError)}`);
-    program.error('');
+    p.log.error(`Cannot add bundle ${formatError(dbError)}`)
+    program.error('')
   }
   if (!external && zipped) {
-    const spinner = p.spinner();
-    spinner.start(`Uploading Bundle`);
+    const spinner = p.spinner()
+    spinner.start(`Uploading Bundle`)
 
     const url = await uploadUrl(supabase, appid, fileName)
     if (!url) {
-      p.log.error(`Cannot get upload url`);
-      program.error('');
+      p.log.error(`Cannot get upload url`)
+      program.error('')
     }
     await ky.put(url, {
       timeout: 60000,
       body: zipped,
-      headers: (!localS3 ? {
-        "Content-Type": "application/octet-stream",
-        "Cache-Control": "public, max-age=456789, immutable",
-        "x-amz-meta-crc32": checksum,
-      } : undefined)
+      headers: (!localS3
+        ? {
+            'Content-Type': 'application/octet-stream',
+            'Cache-Control': 'public, max-age=456789, immutable',
+            'x-amz-meta-crc32': checksum,
+          }
+        : undefined),
     })
     versionData.storage_provider = 'r2'
-    const { error: dbError2 } = await updateOrCreateVersion(supabase, versionData, options.apikey)
+    const { error: dbError2 } = await updateOrCreateVersion(supabase, versionData)
     if (dbError2) {
-      console.log(dbError2)
-      p.log.error(`Cannot update bundle ${formatError(dbError)}`);
-      program.error('');
+      p.log.error(`Cannot update bundle ${formatError(dbError2)}`)
+      program.error('')
     }
     spinner.stop('Bundle Uploaded 💪')
   }
@@ -350,25 +370,24 @@ It will be also visible in your dashboard\n`);
       version: versionId,
     })
     if (dbError3) {
-      p.log.error(`Cannot set channel, the upload key is not allowed to do that, use the "all" for this.`);
-      console.log(dbError3)
-      program.error('');
+      p.log.error(`Cannot set channel, the upload key is not allowed to do that, use the "all" for this. ${formatError(dbError3)}`)
+      program.error('')
     }
     const appidWeb = convertAppName(appid)
     const bundleUrl = `${localConfig.hostWeb}/app/p/${appidWeb}/channel/${data.id}`
-    if (data?.public) {
+    if (data?.public)
       p.log.info('Your update is now available in your public channel 🎉')
-    } else if (data?.id) {
-      p.log.info(`Link device to this bundle to try it: ${bundleUrl}`);
-    }
+    else if (data?.id)
+      p.log.info(`Link device to this bundle to try it: ${bundleUrl}`)
 
-    if (options.bundleUrl) {
-      p.log.info(`Bundle url: ${bundleUrl}`);
-    }
-  } else if (!versionId) {
-    p.log.warn('Cannot set bundle with upload key, use key with more rights for that');
-    program.error('');
-  } else if (!hasOrganizationPerm(permissions, OrganizationPerm.write)) {
+    if (options.bundleUrl)
+      p.log.info(`Bundle url: ${bundleUrl}`)
+  }
+  else if (!versionId) {
+    p.log.warn('Cannot set bundle with upload key, use key with more rights for that')
+    program.error('')
+  }
+  else if (!hasOrganizationPerm(permissions, OrganizationPerm.write)) {
     p.log.warn('Cannot set channel as a upload organization member')
   }
   await snag.track({
@@ -388,21 +407,23 @@ It will be also visible in your dashboard\n`);
   return true
 }
 
-export const uploadCommand = async (apikey: string, options: Options) => {
+export async function uploadCommand(apikey: string, options: Options) {
   try {
     await uploadBundle(apikey, options, true)
-  } catch (error) {
-    p.log.error(JSON.stringify(error))
+  }
+  catch (error) {
+    p.log.error(formatError(error))
     program.error('')
   }
 }
 
-export const uploadDeprecatedCommand = async (apikey: string, options: Options) => {
+export async function uploadDeprecatedCommand(apikey: string, options: Options) {
   p.log.warn('⚠️  This command is deprecated, use "npx @capgo/cli bundle upload" instead ⚠️')
   try {
     await uploadBundle(apikey, options, true)
-  } catch (error) {
-    p.log.error(JSON.stringify(error))
+  }
+  catch (error) {
+    p.log.error(formatError(error))
     program.error('')
   }
 }