Merge pull request #14 from RoboVault/feat/cli-qol-fixes

Feat/cli qol fixes

Author: hazelnutcloud

CHANGELOG.md

@@ -1,3 +1,14 @@
+# v0.4.16
+- feat: enhance `arkiver list` command, see `arkiver list --help`
+- feat: added 3 new commands to the CLI:
+  - `arkiver keygen` to generate a new API key
+  - `arkiver keyrm` to remove an API key
+  - `arkiver keyls` to list all API keys
+- feat: adjusted `arkiver init` command
+- feat: Add --gql-only option to arkiver start command to start only the graphQL server
+- feat: Change EventHandler and BlockHandler return type to be Promise<void> | void
+- fix: bug where deploying while logged out causes issues when trying to login again in the same command
+
 # v0.4.15
 - feat: populate relational entities on graphql endpoint
 - feat: add overload to `manifest.addChain` and `chain.addContract` functions to pass in a callback function that takes in a DataSourceBuilder and ContractBuilder instance respectively

cli.ts

@@ -3,6 +3,9 @@ import {
   Command,
   deploy,
   init,
+  keygen,
+  keyls,
+  keyrm,
   list,
   login,
   logout,
@@ -14,7 +17,7 @@ import {
 } from './cli/mod.ts'
 import 'https://deno.land/std@0.179.0/dotenv/load.ts'
 
-export const version = 'v0.4.15'
+export const version = 'v0.4.16'
 
 const command = new Command()
   .name('arkiver')
@@ -88,6 +91,7 @@ command
   .option('--log-level <logLevel:string>', 'Log level', {
     default: 'INFO',
   })
+  .option('--gql-only', 'Only start GraphQL server')
   .action(async (opts, ...args) => {
     util.logHeader(version)
     await checkVersion(version)
@@ -111,11 +115,30 @@ command
 // list
 command
   .command('list', 'List all your arkives')
-  .action(async () => {
+  .option('-A, --all', 'List all arkives')
+  .option('-s, --status <status>', 'Filter by status')
+  .action(async (opts) => {
     await checkVersion(version)
-    await list.action()
+    await list.action(opts)
+  })
+
+// keygen
+command
+  .command('keygen', 'Generate a new API key')
+  .action(keygen.action)
+
+// keyrm
+command
+  .command('keyrm', 'Delete an API key')
+  .arguments('<key:string>')
+  .action(async (_, key) => {
+    await keyrm.action(key)
   })
 
+command
+  .command('keyls', 'List all API keys')
+  .action(keyls.action)
+
 if (import.meta.main) {
   await command.parse(Deno.args)
 }

cli/deploy/cleanup.ts

@@ -1,3 +1,6 @@
+import { spinner } from '../spinner.ts'
+
 export const cleanup = async (tempPath: string) => {
+  spinner().text = 'Cleaning up...'
   await Deno.remove(tempPath, { recursive: true })
 }

cli/deploy/mod.ts

@@ -1,5 +1,7 @@
-import { parseArkiveManifest } from '../../mod.ts'
-import { join, wait } from '../deps.ts'
+import { ArkiveManifest, parseArkiveManifest } from '../../mod.ts'
+import { join } from '../deps.ts'
+import { spinner } from '../spinner.ts'
+import { craftEndpoint, getSupabaseClient } from '../utils.ts'
 import { cleanup } from './cleanup.ts'
 import { pkg } from './pkg.ts'
 import { upload } from './upload.ts'
@@ -12,9 +14,8 @@ export const action = async (
 
   if (dev) return deployDev(options, directory)
 
-  const spinner = wait('Packaging...').start()
-
   try {
+    spinner('Deploying...')
     // package directory
     const { fileName, tempPath } = await pkg(directory)
 
@@ -25,7 +26,8 @@ export const action = async (
     } catch (error) {
       throw new Error(`Error importing manifest.ts: ${error.message}`)
     }
-    const manifest = manifestImport.default ?? manifestImport.manifest
+    const manifest: ArkiveManifest = manifestImport.default ??
+      manifestImport.manifest
     if (!manifest) {
       throw new Error(
         `Manifest file must export a default or manifest object.`,
@@ -41,18 +43,37 @@ export const action = async (
       throw new Error(`Invalid manifest: ${problems}`)
     }
 
-    spinner.text = 'Uploading package...'
     // upload package
     await upload(fileName, tempPath, manifest, options)
 
-    spinner.text = 'Cleaning up...'
     // cleanup
     await cleanup(tempPath)
 
-    spinner.succeed('Deployed successfully!')
+    spinner().succeed(`Deployed successfully!`)
+
+    const client = getSupabaseClient()
+    const { data: userData, error: userError } = await client.auth.getUser()
+
+    if (userError) {
+      console.error(userError)
+    } else {
+      const { data, error } = await client.from('user_profile').select(
+        'username',
+      ).eq('id', userData.user.id).single()
+
+      if (error) {
+        console.error(error)
+      } else {
+        const endpoint = craftEndpoint({
+          arkiveName: manifest.name,
+          environment: options.env ?? 'staging',
+          username: data.username,
+        })
+        console.log(`🚀 Arkive GraphQL endpoint ready at: ${endpoint}`)
+      }
+    }
   } catch (error) {
-    spinner.fail('Deployment failed: ' + error.message)
-    console.error(error)
+    spinner().fail('Deployment failed: ' + error.message)
   }
 
   Deno.exit()

cli/deploy/pkg.ts

@@ -1,26 +1,19 @@
 import { join } from 'https://deno.land/std@0.175.0/path/mod.ts'
+import { $ } from '../deps.ts'
+import { spinner } from '../spinner.ts'
 
 export const pkg = async (dir: string) => {
-  const tempPath = await Deno.makeTempDir()
-  const fileName = crypto.randomUUID() + '.tar.gz'
-  const out = join(tempPath, fileName)
+  spinner().text = 'Packaging...'
+  try {
+    const tempPath = await Deno.makeTempDir()
+    const fileName = crypto.randomUUID() + '.tar.gz'
+    const out = join(tempPath, fileName)
 
-  const process = Deno.run({
-    cmd: ['tar', '-zcvf', out, '-C', dir, '.'],
-    stdout: 'piped',
-    stderr: 'piped',
-  })
+    await $`tar -zcvf ${out} -C ${dir} .`
 
-  const [status, err] = await Promise.all([
-    process.status(),
-    process.stderrOutput(),
-  ])
-  if (status.code !== 0) {
-    const errMsg = `Failed to build package: ${new TextDecoder().decode(err)}`
-    throw new Error(errMsg)
+    return { fileName, tempPath }
+  } catch (error) {
+    spinner().fail('Packaging failed: ' + error)
+    Deno.exit(1)
   }
-
-  process.close()
-
-  return { fileName, tempPath }
 }

cli/deploy/upload.ts

@@ -2,17 +2,20 @@ import { getSupabaseClient } from '../utils.ts'
 import { login } from '../login/mod.ts'
 import { SUPABASE_FUNCTIONS_URL } from '../constants.ts'
 import { ArkiveManifest, JSONBigIntReplacer } from '../../mod.ts'
+import { spinner } from '../spinner.ts'
 
 export const upload = async (
   pkgName: string,
   tempPath: string,
   manifest: ArkiveManifest,
   options: { public?: true; major?: true; env?: string },
 ) => {
+  spinner().text = 'Uploading...'
   const supabase = getSupabaseClient()
   const sessionRes = await supabase.auth.getSession()
 
   if (!sessionRes.data.session) {
+    spinner().info('Not logged in, logging in now...')
     await login({}, supabase)
   }
 
@@ -57,7 +60,7 @@ export const upload = async (
     },
   )
   if (!res.ok) {
-    throw new Error(await res.text())
+    spinner().fail(`Upload failed: ${await res.text()}`)
+    Deno.exit(1)
   }
-  console.log('Deployed successfully: ', await res.json())
 }

cli/deps.ts

@@ -1,17 +1,17 @@
 export { z } from 'https://esm.sh/zod@3.20.2'
-export { Command } from 'https://deno.land/x/cliffy@v0.25.7/command/mod.ts'
+export { Command } from 'https://deno.land/x/cliffy@v1.0.0-rc.1/command/mod.ts'
 export {
   Input,
   prompt,
   Secret,
   Select,
   Toggle,
-} from 'https://deno.land/x/cliffy@v0.25.7/prompt/mod.ts'
+} from 'https://deno.land/x/cliffy@v1.0.0-rc.1/prompt/mod.ts'
 export {
   createClient,
   SupabaseClient,
 } from 'https://esm.sh/@supabase/supabase-js@2.4.1'
-export { wait } from 'https://deno.land/x/wait@0.1.12/mod.ts'
+export { Spinner, wait } from 'https://deno.land/x/wait@0.1.13/mod.ts'
 export { default as $ } from 'https://deno.land/x/dax@0.31.0/mod.ts'
 export { delay } from 'https://deno.land/std@0.179.0/async/mod.ts'
 export { join } from 'https://deno.land/std@0.179.0/path/mod.ts'

cli/init/mod.ts

@@ -3,13 +3,11 @@ import { $, Input, join, prompt, Select, Toggle } from '../deps.ts'
 export const action = async () => {
   let pb = $.progress('Fetching templates...')
 
-  let templatesRes: Response
-
-  await pb.with(async () => {
-    templatesRes = await fetch(
+  const templatesRes = await pb.with(() =>
+    fetch(
       'https://api.github.com/repos/RoboVault/robo-arkiver/contents/examples',
     )
-  })
+  )
 
   if (!templatesRes!.ok) {
     console.log('Error fetching templates: ', templatesRes!.statusText)
@@ -52,8 +50,8 @@ export const action = async () => {
       default: templateNames[0].value,
     },
     {
-      name: 'vscode',
-      message: 'Are you using VSCode?',
+      name: 'git',
+      message: 'Initialize git repo?',
       type: Toggle,
       default: true,
     },
@@ -74,8 +72,8 @@ export const action = async () => {
     )
 
     await $`git remote add origin https://github.com/RoboVault/robo-arkiver && git pull origin main && rm -rf .git`
+      .quiet('both')
       .cwd(newDir)
-      .quiet('stdout')
 
     // traverse the template directory and move all files to the root
     for await (
@@ -88,38 +86,37 @@ export const action = async () => {
 
     await Deno.remove(join(newDir, 'examples'), { recursive: true })
 
-    if (arkive.vscode) {
-      const dir = arkive.dir ?? defaultPath
-      await Deno.mkdir(join(Deno.cwd(), dir, '.vscode'))
+    const dir = arkive.dir ?? defaultPath
+    await Deno.mkdir(join(Deno.cwd(), dir, '.vscode'))
 
-      const vscode = `{
+    const vscode = `{
     "deno.enable": true,
     "deno.unstable": true
   }`
-      await Deno.writeTextFile(
-        join(Deno.cwd(), dir, '.vscode', 'settings.json'),
-        vscode,
-      )
+    await Deno.writeTextFile(
+      join(Deno.cwd(), dir, '.vscode', 'settings.json'),
+      vscode,
+    )
 
-      const gitignore = `/.vscode
+    const gitignore = `/.vscode
   /.vscode/*
   /.vscode/**/*
   `
-      await Deno.writeTextFile(
-        join(Deno.cwd(), dir, '.gitignore'),
-        gitignore,
-      )
-    }
+    await Deno.writeTextFile(
+      join(Deno.cwd(), dir, '.gitignore'),
+      gitignore,
+    )
 
-    await $`git init && git add . && git commit -m "Initial commit"`
-      .cwd(newDir)
-      .quiet('stdout')
+    if (arkive.git) {
+      await $`git init && git add . && git commit -m "Initial commit"`
+        .cwd(newDir)
+        .quiet('stdout')
+    }
   } catch (e) {
     $.logError(`Error initializing arkive: ${e}`)
     return
   }
 
-  // spinner.succeed('Initialized arkive')
   pb.finish()
   $.logStep('Initialized arkive')
 }

cli/key/delete.ts

@@ -0,0 +1,22 @@
+import { spinner } from '../spinner.ts'
+import { getSupabaseClient } from '../utils.ts'
+
+export const action = async (key: string) => {
+  spinner(`Deleting key ${key}`)
+
+  const client = getSupabaseClient()
+
+  const { error } = await client.functions.invoke('api-key', {
+    method: 'DELETE',
+    body: {
+      apiKey: key,
+    },
+  })
+
+  if (error) {
+    spinner().fail(`Failed to delete key: ${error.message}`)
+    return
+  }
+
+  spinner().succeed(`Successfully deleted key: ${key}`)
+}

cli/key/list.ts

@@ -0,0 +1,29 @@
+import { spinner } from '../spinner.ts'
+import { getSupabaseClient } from '../utils.ts'
+
+export const action = async () => {
+  spinner('Fetching API keys')
+
+  const client = getSupabaseClient()
+
+  const { data, error } = await client.functions.invoke<{ api_key: string }[]>(
+    'api-key',
+    {
+      method: 'GET',
+    },
+  )
+
+  if (error) {
+    spinner().fail(`Failed to fetch keys: ${error.message}`)
+    return
+  }
+
+  if (!data) {
+    spinner().fail(`Failed to fetch keys: no data returned`)
+    return
+  }
+
+  spinner().succeed(`Successfully fetched keys:`)
+
+  console.table(data.map((d) => ({ key: d.api_key })))
+}