@capgo/cli 4.10.2 → 4.10.6-beta.1

package/src/bundle/zip.ts

@@ -1,7 +1,6 @@
 import { randomUUID } from 'node:crypto'
 import { writeFileSync } from 'node:fs'
 import process from 'node:process'
-import AdmZip from 'adm-zip'
 import { program } from 'commander'
 import * as p from '@clack/prompts'
 import { checksum as getChecksum } from '@tomasklaen/checksum'
@@ -14,6 +13,7 @@ import {
   getConfig,
   regexSemver,
   useLogSnag,
+  zipFile,
 } from '../utils'
 import { checkIndexPosition, searchInDirectory } from './check'
 
@@ -28,112 +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 zip = new AdmZip()
-  zip.addLocalFolder(path)
-  const zipped = zip.toBuffer()
-  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/channel/add.ts

@@ -4,7 +4,7 @@ import * as p from '@clack/prompts'
 import { checkAppExistsAndHasPermissionOrgErr } from '../api/app'
 import { createChannel, findUnknownVersion } from '../api/channels'
 import type { OptionsBase } from '../utils'
-import { OrganizationPerm, createSupabaseClient, findSavedKey, getConfig, getOrganizationId, useLogSnag, verifyUser } from '../utils'
+import { OrganizationPerm, createSupabaseClient, findSavedKey, formatError, getConfig, getOrganizationId, useLogSnag, verifyUser } from '../utils'
 
 interface Options extends OptionsBase {
   default?: boolean
@@ -27,7 +27,7 @@ export async function addChannel(channelId: string, appId: string, options: Opti
   }
   const supabase = await createSupabaseClient(options.apikey)
 
-  const userId = await verifyUser(supabase, options.apikey, ['write', 'all'])
+  await verifyUser(supabase, options.apikey, ['write', 'all'])
   // Check we have app access to this appId
   await checkAppExistsAndHasPermissionOrgErr(supabase, options.apikey, appId, OrganizationPerm.admin)
 
@@ -39,18 +39,24 @@ export async function addChannel(channelId: string, appId: string, options: Opti
       p.log.error(`Cannot find default version for channel creation, please contact Capgo support 🤨`)
       program.error('')
     }
-    await createChannel(supabase, {
+    const res = await createChannel(supabase, {
       name: channelId,
       app_id: appId,
       version: data.id,
       owner_org: orgId,
     })
+
+    if (res.error) {
+      p.log.error(`Cannot create Channel 🙀\n${formatError(res.error)}`)
+      program.error('')
+    }
+
     p.log.success(`Channel created ✅`)
     await snag.track({
       channel: 'channel',
       event: 'Create channel',
       icon: '✅',
-      user_id: userId,
+      user_id: orgId,
       tags: {
         'app-id': appId,
         'channel': channelId,

package/src/channel/delete.ts

@@ -4,7 +4,7 @@ import * as p from '@clack/prompts'
 import { checkAppExistsAndHasPermissionOrgErr } from '../api/app'
 import { delChannel } from '../api/channels'
 import type { OptionsBase } from '../utils'
-import { OrganizationPerm, createSupabaseClient, findSavedKey, getConfig, useLogSnag, verifyUser } from '../utils'
+import { OrganizationPerm, createSupabaseClient, findSavedKey, formatError, getConfig, getOrganizationId, useLogSnag, verifyUser } from '../utils'
 
 export async function deleteChannel(channelId: string, appId: string, options: OptionsBase) {
   p.intro(`Delete channel`)
@@ -29,13 +29,18 @@ export async function deleteChannel(channelId: string, appId: string, options: O
 
   p.log.info(`Deleting channel ${appId}#${channelId} from Capgo`)
   try {
-    await delChannel(supabase, channelId, appId, userId)
+    const deleteStatus = await delChannel(supabase, channelId, appId, userId)
+    if (deleteStatus.error) {
+      p.log.error(`Cannot delete Channel 🙀 ${formatError(deleteStatus.error)}`)
+      program.error('')
+    }
+    const orgId = await getOrganizationId(supabase, appId)
     p.log.success(`Channel deleted`)
     await snag.track({
       channel: 'channel',
       event: 'Delete channel',
       icon: '✅',
-      user_id: userId,
+      user_id: orgId,
       tags: {
         'user-id': userId,
         'app-id': appId,

package/src/channel/set.ts

@@ -161,9 +161,8 @@ export async function setChannel(channel: string, appId: string, options: Option
       channel: 'channel',
       event: 'Set channel',
       icon: '✅',
-      user_id: userId,
+      user_id: orgId,
       tags: {
-        'user-id': userId,
         'app-id': appId,
       },
       notify: false,

package/src/index.ts

@@ -1,6 +1,6 @@
 import { program } from 'commander'
-import { getUserId } from 'user/account'
 import pack from '../package.json'
+import { getUserId } from './user/account'
 import { zipBundle } from './bundle/zip'
 import { initApp } from './init'
 import { listBundle } from './bundle/list'
@@ -294,12 +294,11 @@ program
     'Minimal version required to update to this version. Used only if the disable auto update is set to metadata in channel',
   )
 
-const user = program
-  .command('user')
-  .description('Manage user')
+const account = program
+  .command('account')
+  .description('Manage account')
 
-user.command('account')
-  .alias('a')
+account.command('id')
   .description('Get your account ID')
   .action(getUserId)
   .option('-a, --apikey <apikey>', 'apikey to link to your account')

package/src/init.ts

@@ -1,12 +1,12 @@
-import { readFileSync, writeFileSync } from 'node:fs'
+import { readFileSync, readdirSync, rmSync, writeFileSync } from 'node:fs'
 import type { ExecSyncOptions } from 'node:child_process'
 import { execSync, spawnSync } from 'node:child_process'
 import process from 'node:process'
+import { tmpdir } from 'node:os'
 import * as p from '@clack/prompts'
-import type { SupabaseClient } from '@supabase/supabase-js'
 import type LogSnag from 'logsnag'
 import semver from 'semver'
-import type { Database } from './types/supabase.types'
+import tmp from 'tmp'
 import { markSnag, waitLog } from './app/debug'
 import { createKey } from './key'
 import { addChannel } from './channel/add'
@@ -28,6 +28,63 @@ const regexImport = /import.*from.*/g
 const defaultChannel = 'production'
 const execOption = { stdio: 'pipe' }
 
+let tmpObject: tmp.FileResult['name'] | undefined
+
+function readTmpObj() {
+  if (!tmpObject) {
+    tmpObject = readdirSync(tmp.tmpdir)
+      .map((name) => { return { name, full: `${tmp.tmpdir}/${name}` } })
+      .find(obj => obj.name.startsWith('capgocli'))?.full
+      ?? tmp.fileSync({ prefix: 'capgocli' }).name
+  }
+}
+
+function markStepDone(step: number) {
+  try {
+    readTmpObj()
+    writeFileSync(tmpObject!, JSON.stringify({ step_done: step }))
+  }
+  catch (err) {
+    p.log.error(`Cannot mark step as done in the CLI, error:\n${err}`)
+    p.log.warn('Onboarding will continue but please report it to the capgo team!')
+  }
+}
+
+async function readStepsDone(orgId: string, snag: LogSnag): Promise<number | undefined> {
+  try {
+    readTmpObj()
+    const rawData = readFileSync(tmpObject!, 'utf-8')
+    if (!rawData || rawData.length === 0)
+      return undefined
+
+    const { step_done } = JSON.parse(rawData)
+    p.log.info(`You have already got to the step ${step_done}/10 in the previous session`)
+    const skipSteps = await p.confirm({ message: 'Would you like to continue from where you left off?' })
+    await cancelCommand(skipSteps, orgId, snag)
+    if (skipSteps)
+      return step_done
+    return undefined
+  }
+  catch (err) {
+    p.log.error(`Cannot read which steps have been compleated, error:\n${err}`)
+    p.log.warn('Onboarding will continue but please report it to the capgo team!')
+    return undefined
+  }
+}
+
+function cleanupStepsDone() {
+  if (!tmpObject) {
+    return
+  }
+
+  try {
+    rmSync(tmpObject)
+  }
+  catch (err) {
+    p.log.error(`Cannot delete the tmp steps file.\nError: ${err}`)
+  }
+}
+
 async function cancelCommand(command: boolean | symbol, orgId: string, snag: LogSnag) {
   if (p.isCancel(command)) {
     await markSnag('onboarding-v2', orgId, snag, 'canceled', '🤷')
@@ -53,7 +110,7 @@ async function step2(organization: Organization, snag: LogSnag, appId: string, o
       s.stop(`App add Done ✅`)
   }
   else {
-    p.log.info(`Run yourself "${pm.runner} @capgo/cli@latest app add ${appId}"`)
+    p.log.info(`If you change your mind, run it for yourself with: "${pm.runner} @capgo/cli@latest app add ${appId}"`)
   }
   await markStep(organization.gid, snag, 2)
 }
@@ -76,7 +133,7 @@ async function step3(orgId: string, snag: LogSnag, apikey: string, appId: string
       s.stop(`Channel add Done ✅`)
   }
   else {
-    p.log.info(`Run yourself "${pm.runner} @capgo/cli@latest channel add ${defaultChannel} ${appId} --default"`)
+    p.log.info(`If you change your mind, run it for yourself with: "${pm.runner} @capgo/cli@latest channel add ${defaultChannel} ${appId} --default"`)
   }
   await markStep(orgId, snag, 3)
 }
@@ -128,7 +185,7 @@ async function step4(orgId: string, snag: LogSnag, apikey: string, appId: string
     }
   }
   else {
-    p.log.info(`Run yourself "${pm.installCommand} @capgo/capacitor-updater@latest"`)
+    p.log.info(`If you change your mind, run it for yourself with: "${pm.installCommand} @capgo/capacitor-updater@latest"`)
   }
   await markStep(orgId, snag, 4)
 }
@@ -279,18 +336,18 @@ async function step9(orgId: string, snag: LogSnag) {
     s.stop(`Started Done ✅`)
   }
   else {
-    p.log.info(`Run yourself with command: ${pm.runner} cap run <ios|android>`)
+    p.log.info(`If you change your mind, run it for yourself with: ${pm.runner} cap run <ios|android>`)
   }
   await markStep(orgId, snag, 9)
 }
 
-async function _step10(orgId: string, snag: LogSnag, supabase: SupabaseClient<Database>, appId: string) {
+async function step10(orgId: string, snag: LogSnag, apikey: string, appId: string) {
   const doRun = await p.confirm({ message: `Automatic check if update working in device ?` })
   await cancelCommand(doRun, orgId, snag)
   if (doRun) {
     p.log.info(`Wait logs sent to Capgo from ${appId} device, Put the app in background and open it again.`)
-    p.log.info('Waiting...')
-    await waitLog('onboarding-v2', supabase, appId, snag, orgId)
+    p.log.info('Waiting... (there is a usual delay of 15 seconds until the backend process the logs)')
+    await waitLog('onboarding-v2', apikey, appId, snag, orgId)
   }
   else {
     const appIdUrl = convertAppName(appId)
@@ -321,19 +378,62 @@ export async function initApp(apikeyCommand: string, appId: string, options: Sup
   const organization = await getOrganization(supabase, ['admin', 'super_admin'])
   const orgId = organization.gid
 
-  await markStep(orgId, snag, 1)
+  const stepToSkip = await readStepsDone(orgId, snag) ?? 0
 
-  await step2(organization, snag, appId, options)
-  await step3(orgId, snag, apikey, appId)
-  await step4(orgId, snag, apikey, appId)
-  await step5(orgId, snag, apikey, appId)
-  await step6(orgId, snag, apikey, appId)
-  await step7(orgId, snag, apikey, appId)
-  await step8(orgId, snag, apikey, appId)
-  await step9(orgId, snag)
-  // await step10(orgId, snag, supabase, appId)
+  try {
+    if (stepToSkip < 1)
+      await markStep(orgId, snag, 1)
+
+    if (stepToSkip < 2) {
+      await step2(organization, snag, appId, options)
+      markStepDone(2)
+    }
+
+    if (stepToSkip < 3) {
+      await step3(orgId, snag, apikey, appId)
+      markStepDone(3)
+    }
+
+    if (stepToSkip < 4) {
+      await step4(orgId, snag, apikey, appId)
+      markStepDone(4)
+    }
+
+    if (stepToSkip < 5) {
+      await step5(orgId, snag, apikey, appId)
+      markStepDone(5)
+    }
+
+    if (stepToSkip < 6) {
+      await step6(orgId, snag, apikey, appId)
+      markStepDone(6)
+    }
+
+    if (stepToSkip < 7) {
+      await step7(orgId, snag, apikey, appId)
+      markStepDone(7)
+    }
+
+    if (stepToSkip < 8) {
+      await step8(orgId, snag, apikey, appId)
+      markStepDone(8)
+    }
+
+    if (stepToSkip < 9) {
+      await step9(orgId, snag)
+      markStepDone(9)
+    }
+
+    await step10(orgId, snag, apikey, appId)
+    await markStep(orgId, snag, 0)
+    cleanupStepsDone()
+  }
+  catch (e) {
+    console.error(e)
+    p.log.error(`Error during onboarding, please try again later`)
+    process.exit(1)
+  }
 
-  await markStep(orgId, snag, 0)
   p.log.info(`Welcome onboard ✈️!`)
   p.log.info(`Your Capgo update system is setup`)
   p.log.info(`Next time use \`${pm.runner} @capgo/cli@latest bundle upload\` to only upload your bundle`)

package/src/key.ts

@@ -76,8 +76,8 @@ export async function createKey(options: Options, log = true) {
 
   // check if baseName already exist
   if (existsSync(baseKeyPub) && !options.force) {
+    p.log.error('Public Key already exists, use --force to overwrite')
     if (log) {
-      p.log.error('Public Key already exists, use --force to overwrite')
       program.error('')
     }
     else {
@@ -86,8 +86,8 @@ export async function createKey(options: Options, log = true) {
   }
   writeFileSync(baseKeyPub, publicKey)
   if (existsSync(baseKey) && !options.force) {
+    p.log.error('Private Key already exists, use --force to overwrite')
     if (log) {
-      p.log.error('Private Key already exists, use --force to overwrite')
       program.error('')
     }
     else {