@adobe/aio-cli-plugin-app 10.4.0 → 10.6.0

package/src/commands/app/delete/event.js

@@ -11,7 +11,7 @@ governing permissions and limitations under the License.
 
 const BaseCommand = require('../../../BaseCommand')
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:delete:event', { provider: 'debug' })
-const { Flags } = require('@oclif/core')
+const { Flags, Args } = require('@oclif/core')
 const DeleteActionCommand = require('./action')
 const chalk = require('chalk')
 
@@ -54,13 +54,13 @@ DeleteEventCommand.flags = {
   ...BaseCommand.flags
 }
 
-DeleteEventCommand.args = [
+DeleteEventCommand.args =
   {
-    name: 'event-action-name',
-    description: 'Action `pkg/name` to delete, you can specify multiple actions via a comma separated list',
-    required: false
+    'event-action-name': Args.string({
+      description: 'Action `pkg/name` to delete, you can specify multiple actions via a comma separated list',
+      required: false
+    })
   }
-]
 
 DeleteEventCommand.aliases = ['app:delete:events']
 

package/src/commands/app/delete/extension.js

@@ -122,6 +122,6 @@ DeleteExtensionCommand.flags = {
 }
 
 DeleteExtensionCommand.aliases = ['app:delete:ext', 'app:delete:extensions']
-DeleteExtensionCommand.args = []
+DeleteExtensionCommand.args = {}
 
 module.exports = DeleteExtensionCommand

package/src/commands/app/delete/index.js

@@ -21,6 +21,6 @@ class DeleteCommand extends BaseCommand {
 
 DeleteCommand.description = 'Delete a component from an existing Adobe I/O App'
 
-DeleteCommand.args = []
+DeleteCommand.args = {}
 
 module.exports = DeleteCommand

package/src/commands/app/delete/service.js

@@ -115,6 +115,6 @@ DeleteServiceCommand.flags = {
 }
 
 DeleteServiceCommand.aliases = ['app:delete:services']
-DeleteServiceCommand.args = []
+DeleteServiceCommand.args = {}
 
 module.exports = DeleteServiceCommand

package/src/commands/app/delete/web-assets.js

@@ -98,6 +98,6 @@ DeleteWebAssetsCommand.flags = {
   ...BaseCommand.flags
 }
 
-DeleteWebAssetsCommand.args = []
+DeleteWebAssetsCommand.args = {}
 
 module.exports = DeleteWebAssetsCommand

package/src/commands/app/deploy.js

@@ -12,11 +12,12 @@ governing permissions and limitations under the License.
 
 const ora = require('ora')
 const chalk = require('chalk')
+const open = require('open')
 
 const BaseCommand = require('../../BaseCommand')
 const BuildCommand = require('./build')
 const webLib = require('@adobe/aio-lib-web')
-const { Flags, CliUx: { ux: cli } } = require('@oclif/core')
+const { Flags } = require('@oclif/core')
 const { createWebExportFilter, runInProcess, buildExtensionPointPayloadWoMetadata, buildExcShellViewExtensionMetadata } = require('../../lib/app-helper')
 const rtLib = require('@adobe/aio-lib-runtime')
 const LogForwarding = require('../../lib/log-forwarding')
@@ -241,7 +242,7 @@ class Deploy extends BuildCommand {
       const launchUrl = this.getLaunchUrlPrefix() + deployedFrontendUrl
       if (flags.open) {
         this.log(chalk.blue(chalk.bold(`Opening your deployed application in the Experience Cloud shell:\n  -> ${launchUrl}`)))
-        cli.open(launchUrl)
+        open(launchUrl)
       } else {
         this.log(chalk.blue(chalk.bold(`To view your deployed application in the Experience Cloud shell:\n  -> ${launchUrl}`)))
       }
@@ -375,6 +376,6 @@ Deploy.flags = {
   })
 }
 
-Deploy.args = []
+Deploy.args = {}
 
 module.exports = Deploy

package/src/commands/app/get-url.js

@@ -12,7 +12,7 @@ governing permissions and limitations under the License.
 
 const chalk = require('chalk')
 
-const { Flags } = require('@oclif/core')
+const { Flags, Args } = require('@oclif/core')
 
 const BaseCommand = require('../../BaseCommand')
 const { wrapError } = require('../../lib/app-helper')
@@ -116,8 +116,10 @@ GetUrlCommand.flags = {
   })
 }
 
-GetUrlCommand.args = [
-  { name: 'action' }
-]
+GetUrlCommand.args =
+  {
+    action: Args.string({
+    })
+  }
 
 module.exports = GetUrlCommand

package/src/commands/app/index.js

@@ -22,6 +22,6 @@ class IndexCommand extends BaseCommand {
 
 IndexCommand.description = 'Create, run, test, and deploy Adobe I/O Apps'
 
-IndexCommand.args = []
+IndexCommand.args = {}
 
 module.exports = IndexCommand

package/src/commands/app/info.js

@@ -79,6 +79,6 @@ Info.flags = {
   })
 }
 
-Info.args = []
+Info.args = {}
 
 module.exports = Info

package/src/commands/app/init.js

@@ -15,7 +15,7 @@ const path = require('path')
 const fs = require('fs-extra')
 const ora = require('ora')
 const chalk = require('chalk')
-const { Flags } = require('@oclif/core')
+const { Flags, Args } = require('@oclif/core')
 const generators = require('@adobe/generator-aio-app')
 const TemplateRegistryAPI = require('@adobe/aio-lib-templates')
 const inquirer = require('inquirer')
@@ -400,12 +400,12 @@ InitCommand.flags = {
   })
 }
 
-InitCommand.args = [
+InitCommand.args =
   {
-    name: 'path',
-    description: 'Path to the app directory',
-    default: '.'
+    path: Args.string({
+      description: 'Path to the app directory',
+      default: '.'
+    })
   }
-]
 
 module.exports = InitCommand

package/src/commands/app/install.js

@@ -11,13 +11,15 @@ governing permissions and limitations under the License.
 */
 
 const BaseCommand = require('../../BaseCommand')
-const { Flags } = require('@oclif/core')
+const { Flags, Args } = require('@oclif/core')
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:install', { provider: 'debug' })
 const path = require('node:path')
 const fs = require('fs-extra')
 const execa = require('execa')
 const unzipper = require('unzipper')
 const { validateJsonWithSchema } = require('../../lib/install-helper')
+const { loadConfigFile, writeFile } = require('../../lib/import-helper')
+const { getObjectValue } = require('../../lib/app-helper')
 const jsYaml = require('js-yaml')
 const { USER_CONFIG_FILE, DEPLOY_CONFIG_FILE } = require('../../lib/defaults')
 const ora = require('ora')
@@ -28,6 +30,7 @@ class InstallCommand extends BaseCommand {
     const { args, flags } = await this.parse(InstallCommand)
 
     this.preRelease()
+    const appConfig = this.getFullConfig()
 
     aioLogger.debug(`flags: ${JSON.stringify(flags, null, 2)}`)
     aioLogger.debug(`args: ${JSON.stringify(args, null, 2)}`)
@@ -49,6 +52,7 @@ class InstallCommand extends BaseCommand {
     try {
       await this.validateZipDirectoryStructure(args.path)
       await this.unzipFile(args.path, outputPath)
+      await this.addCodeDownloadAnnotation(outputPath, appConfig)
       await this.validateConfig(outputPath, USER_CONFIG_FILE)
       await this.validateConfig(outputPath, DEPLOY_CONFIG_FILE)
       await this.npmInstall(flags.verbose)
@@ -139,6 +143,67 @@ class InstallCommand extends BaseCommand {
       }
     })
   }
+
+  /**
+   * An annotation called disable-download will be added to all actions in app.config.yaml
+   * (and linked yaml configs for example in extensions). This value will be set to true.
+   * The annotation will by default be false if not set.
+   *
+   * @param {object} outputPath the path to the app package
+   * @param {object} appConfig the app's configuration file
+   */
+  async addCodeDownloadAnnotation (outputPath, appConfig) {
+    this.spinner.start('Adding disable-download annotations...')
+    // get each annotation key relative to the file it is defined in
+    /// iterate only over extensions that have actions defined
+    const fileToAnnotationKey = {}
+    Object.entries(appConfig.all)
+      .filter(([_, extConf]) => extConf.manifest?.full?.packages)
+      .forEach(([ext, extConf]) => {
+        Object.entries(extConf.manifest.full.packages)
+          .filter(([pkg, pkgConf]) => pkgConf.actions)
+          .forEach(([pkg, pkgConf]) => {
+            Object.entries(pkgConf.actions).forEach(([action, actionConf]) => {
+              const baseFullKey = ext === 'application'
+                ? `application.runtimeManifest.packages.${pkg}.actions.${action}`
+                : `extensions.${ext}.runtimeManifest.packages.${pkg}.actions.${action}`
+
+              let index
+              if (actionConf.annotations) {
+                index = appConfig.includeIndex[`${baseFullKey}.annotations`]
+              } else {
+                // the annotation object is not defined, take the parent key
+                index = appConfig.includeIndex[baseFullKey]
+              }
+              if (!fileToAnnotationKey[index.file]) {
+                fileToAnnotationKey[index.file] = []
+              }
+              fileToAnnotationKey[index.file].push(index.key) // index.key is relative to the file
+            })
+          })
+      })
+
+    // rewrite config files
+    for (const [file, keys] of Object.entries(fileToAnnotationKey)) {
+      const configFilePath = path.join(outputPath, file)
+      const { values } = loadConfigFile(configFilePath)
+
+      keys.forEach(key => {
+        const object = getObjectValue(values, key)
+        if (key.endsWith('.annotations') || key === 'annotations') {
+          // object is the annotations object
+          object['disable-download'] = true
+        } else {
+          // annotation object is not defined, the object is the action object
+          object.annotations = { 'disable-download': true }
+        }
+      })
+
+      // write back the modified manifest to disk
+      await writeFile(configFilePath, jsYaml.dump(values), { overwrite: true })
+    }
+    this.spinner.succeed('Added disable-download annotations')
+  }
 }
 
 InstallCommand.hidden = true // hide from help for pre-release
@@ -155,12 +220,12 @@ InstallCommand.flags = {
   })
 }
 
-InstallCommand.args = [
+InstallCommand.args =
   {
-    name: 'path',
-    description: 'Path to the app package to install',
-    required: true
+    path: Args.string({
+      description: 'Path to the app package to install',
+      required: true
+    })
   }
-]
 
 module.exports = InstallCommand

package/src/commands/app/list/extension-points.js

@@ -66,6 +66,6 @@ ListExtensionPointsCommand.flags = {
 }
 
 ListExtensionPointsCommand.aliases = ['app:list:ext-points', 'app:list:extension-points']
-ListExtensionPointsCommand.args = []
+ListExtensionPointsCommand.args = {}
 
 module.exports = ListExtensionPointsCommand

package/src/commands/app/list/extension.js

@@ -93,6 +93,6 @@ ListExtensionCommand.flags = {
 }
 
 ListExtensionCommand.aliases = ['app:list:ext', 'app:list:extensions']
-ListExtensionCommand.args = []
+ListExtensionCommand.args = {}
 
 module.exports = ListExtensionCommand

package/src/commands/app/list/index.js

@@ -21,6 +21,6 @@ class ListCommand extends BaseCommand {
 
 ListCommand.description = 'List components for Adobe I/O App'
 
-ListCommand.args = []
+ListCommand.args = {}
 
 module.exports = ListCommand

package/src/commands/app/pack.js

@@ -10,15 +10,14 @@ governing permissions and limitations under the License.
 */
 
 const BaseCommand = require('../../BaseCommand')
-const { Flags } = require('@oclif/core')
+const { Flags, Args } = require('@oclif/core')
 const path = require('node:path')
 const fs = require('fs-extra')
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:pack', { provider: 'debug' })
 const archiver = require('archiver')
 const yaml = require('js-yaml')
 const execa = require('execa')
-const { loadConfigFile, writeFile } = require('../../lib/import-helper')
-const { getObjectValue } = require('../../lib/app-helper')
+const { writeFile } = require('../../lib/import-helper')
 const ora = require('ora')
 const chalk = require('chalk')
 
@@ -70,10 +69,6 @@ class Pack extends BaseCommand {
       await this.createDeployYamlFile(appConfig)
       this.spinner.succeed('Created configuration files')
 
-      this.spinner.start('Adding code-download annotations...')
-      await this.addCodeDownloadAnnotation(appConfig)
-      this.spinner.succeed('Added code-download annotations')
-
       // doing this before zip so other things can be added to the zip
       await this.config.runHook('post-pack', { appConfig, artifactsFolder: DEFAULTS.ARTIFACTS_FOLDER })
 
@@ -135,13 +130,23 @@ class Pack extends BaseCommand {
     // TODO: send a PR to their plugin to have a `--json` flag
     const command = await this.config.findCommand('api-mesh:get')
     if (command) {
-      this.spinner.start('Getting api-mesh config...')
-      const { stdout } = await execa('aio', ['api-mesh', 'get'], { cwd: process.cwd() })
-      // until we get the --json flag, we parse the output
-      const idx = stdout.indexOf('{')
-      meshConfig = JSON.parse(stdout.substring(idx))
-      aioLogger.debug(`api-mesh:get - ${JSON.stringify(meshConfig, null, 2)}`)
-      this.spinner.succeed('Got api-mesh config')
+      try {
+        this.spinner.start('Getting api-mesh config...')
+        const { stdout } = await execa('aio', ['api-mesh', 'get'], { cwd: process.cwd() })
+        // until we get the --json flag, we parse the output
+        const idx = stdout.indexOf('{')
+        meshConfig = JSON.parse(stdout.substring(idx))
+        aioLogger.debug(`api-mesh:get - ${JSON.stringify(meshConfig, null, 2)}`)
+        this.spinner.succeed('Got api-mesh config')
+      } catch (err) {
+        // Ignore error if no mesh found, otherwise throw
+        if (err?.stderr.includes('Error: Unable to get mesh config. No mesh found for Org')) {
+          aioLogger.debug('No api-mesh config found')
+        } else {
+          console.error(err)
+          throw err
+        }
+      }
     } else {
       aioLogger.debug('api-mesh:get command was not found, meshConfig is not available for app:pack')
     }
@@ -233,42 +238,6 @@ class Pack extends BaseCommand {
       .map(file => file.path)
       .filter(file => !filesToExclude.includes(file))
   }
-
-  /**
-   * An annotation called code-download will be added to all actions in app.config.yaml
-   * (and linked yaml configs for example in extensions). This value will be set to false.
-   * The annotation will by default be true if not set.
-   *
-   * @param {object} appConfig the app's configuration file
-   */
-  async addCodeDownloadAnnotation (appConfig) {
-    // get the configFiles that have runtime manifests
-    const configFiles = []
-    for (const [, value] of Object.entries(appConfig.includeIndex)) {
-      const { key } = value
-      if (key === 'runtimeManifest' || key === 'application.runtimeManifest') {
-        configFiles.push(value)
-      }
-    }
-
-    // for each configFile, we modify each action to have the "code-download: false" annotation
-    for (const configFile of configFiles) {
-      const configFilePath = path.join(DEFAULTS.ARTIFACTS_FOLDER, configFile.file)
-      const { values } = loadConfigFile(configFilePath)
-
-      const runtimeManifest = getObjectValue(values, configFile.key)
-      for (const [, pkgManifest] of Object.entries(runtimeManifest.packages)) {
-        // key is the package name (unused), value is the package manifest. we iterate through each package's "actions"
-        for (const [, actionManifest] of Object.entries(pkgManifest.actions)) {
-          // key is the action name (unused), value is the action manifest. we add the "code-download: false" annotation
-          actionManifest.annotations['code-download'] = false
-        }
-      }
-
-      // write back the modified manifest to disk
-      await writeFile(configFilePath, yaml.dump(values), { overwrite: true })
-    }
-  }
 }
 
 Pack.hidden = true // hide from help for pre-release
@@ -285,12 +254,12 @@ Pack.flags = {
   })
 }
 
-Pack.args = [
+Pack.args =
   {
-    name: 'path',
-    description: 'Path to the app directory to package',
-    default: '.'
+    path: Args.string({
+      description: 'Path to the app directory to package',
+      default: '.'
+    })
   }
-]
 
 module.exports = Pack

package/src/commands/app/run.js

@@ -15,8 +15,9 @@ const chalk = require('chalk')
 const fs = require('fs-extra')
 const https = require('https')
 const getPort = require('get-port')
+const open = require('open')
 
-const { Flags, CliUx: { ux: cli } } = require('@oclif/core')
+const { Flags, ux } = require('@oclif/core')
 const coreConfig = require('@adobe/aio-lib-core-config')
 
 const BaseCommand = require('../../BaseCommand')
@@ -117,7 +118,7 @@ class Run extends BaseCommand {
       const launchUrl = this.getLaunchUrlPrefix() + frontendUrl
       if (flags.open) {
         this.log(chalk.blue(chalk.bold(`Opening your deployed application in the Experience Cloud shell:\n  -> ${launchUrl}`)))
-        cli.open(launchUrl)
+        open(launchUrl)
       } else {
         this.log(chalk.blue(chalk.bold(`To view your deployed application in the Experience Cloud shell:\n  -> ${launchUrl}`)))
       }
@@ -178,17 +179,17 @@ class Run extends BaseCommand {
     const actualPort = await getPort({ port })
     server.listen(actualPort)
     this.log('A self signed development certificate has been generated, you will need to accept it in your browser in order to use it.')
-    cli.open(`https://localhost:${actualPort}`)
-    cli.action.start('Waiting for the certificate to be accepted.')
+    open(`https://localhost:${actualPort}`)
+    ux.action.start('Waiting for the certificate to be accepted.')
     // eslint-disable-next-line no-unmodified-loop-condition
     while (!certAccepted && Date.now() - startTime < 20000) {
-      await cli.wait()
+      await ux.wait()
     }
     if (certAccepted) {
-      cli.action.stop()
+      ux.action.stop()
       this.log('Great, you accepted the certificate!')
     } else {
-      cli.action.stop('timed out')
+      ux.action.stop('timed out')
     }
     server.close()
 
@@ -198,6 +199,8 @@ class Run extends BaseCommand {
 
 Run.description = 'Run an Adobe I/O App'
 
+Run.args = {}
+
 Run.flags = {
   ...BaseCommand.flags,
   local: Flags.boolean({

package/src/commands/app/undeploy.js

@@ -12,7 +12,6 @@ governing permissions and limitations under the License.
 
 const ora = require('ora')
 const chalk = require('chalk')
-// const path = require('path')
 
 const { Flags } = require('@oclif/core')
 
@@ -79,6 +78,14 @@ class Undeploy extends BaseCommand {
     // undeploy
     try {
       await runInProcess(config.hooks['pre-app-undeploy'], config)
+      if (flags['feature-event-hooks'] && flags.events) {
+        this.log('feature-event-hooks is enabled, running pre-undeploy-event-reg hook')
+        const hookResults = await this.config.runHook('pre-undeploy-event-reg', { appConfig: config })
+        if (hookResults?.failures?.length > 0) {
+          // output should be "Error : <plugin-name> : <error-message>\n" for each failure
+          this.error(hookResults.failures.map(f => `${f.plugin.name} : ${f.error.message}`).join('\nError: '), { exit: 1 })
+        }
+      }
     } catch (err) {
       this.log(err)
     }
@@ -86,7 +93,6 @@ class Undeploy extends BaseCommand {
     if (flags.actions) {
       if (config.app.hasBackend) {
         try {
-          this.config.runHook('pre-undeploy-event-reg', { appConfig: config })
           const script = await runInProcess(config.hooks['undeploy-actions'], config)
           if (!script) {
             await rtLib.undeployActions(config)
@@ -118,16 +124,7 @@ class Undeploy extends BaseCommand {
     }
 
     try {
-      this.config.runHook('post-undeploy-event-reg', { appConfig: config })
       await runInProcess(config.hooks['post-app-undeploy'], config)
-      if (flags['feature-event-hooks'] && flags.events) {
-        this.log('feature-event-hooks is enabled, running post-undeploy-event-reg hook')
-        const hookResults = await this.config.runHook('post-undeploy-event-reg', { appConfig: config })
-        if (hookResults?.failures?.length > 0) {
-          // output should be "Error : <plugin-name> : <error-message>\n" for each failure
-          this.error(hookResults.failures.map(f => `${f.plugin.name} : ${f.error.message}`).join('\nError: '), { exit: 1 })
-        }
-      }
     } catch (err) {
       this.log(err)
     }
@@ -190,6 +187,6 @@ Undeploy.flags = {
   })
 }
 
-Undeploy.args = []
+Undeploy.args = {}
 
 module.exports = Undeploy

package/src/commands/app/use.js

@@ -12,7 +12,7 @@ governing permissions and limitations under the License.
 const BaseCommand = require('../../BaseCommand')
 const { CONSOLE_CONFIG_KEY, getProjectCredentialType } = require('../../lib/import-helper')
 const { importConsoleConfig, downloadConsoleConfigToBuffer } = require('../../lib/import')
-const { Flags } = require('@oclif/core')
+const { Flags, Args } = require('@oclif/core')
 const inquirer = require('inquirer')
 const config = require('@adobe/aio-lib-core-config')
 const { EOL } = require('os')
@@ -341,7 +341,7 @@ If the optional configuration file is not set, this command will retrieve the co
 
 To set these global config values, see the help text for 'aio console --help'.
 
-To download the configuration file for your project, select the 'Download' button in the toolbar of your project's page in https://console.adobe.io
+To download the configuration file for your project, select the 'Download' button in the toolbar of your project's page in https://developer.adobe.com/console/
 `
 
 Use.flags = {
@@ -398,12 +398,12 @@ Use.flags = {
   })
 }
 
-Use.args = [
+Use.args =
   {
-    name: 'config_file_path',
-    description: 'path to an Adobe I/O Developer Console configuration file',
-    required: false
+    config_file_path: Args.string({
+      description: 'path to an Adobe I/O Developer Console configuration file',
+      required: false
+    })
   }
-]
 
 module.exports = Use

package/src/lib/app-helper.js

@@ -71,6 +71,7 @@ async function installPackages (dir, options = { spinner: null, verbose: false }
  * @param {string} scriptName  npm script name
  * @param {string} dir directory to run npm script in
  * @param {string[]} cmdArgs args to pass to npm script
+ * @returns {object} the child process
  */
 async function runPackageScript (scriptName, dir, cmdArgs = []) {
   aioLogger.debug(`running npm run-script ${scriptName} in dir: ${dir}`)
@@ -85,7 +86,6 @@ async function runPackageScript (scriptName, dir, cmdArgs = []) {
 }
 
 /**
- *
  * @param {string} hookPath to be require()'d and run. Should export an async function that takes a config object as its only argument
  * @param {object} config which will be passed to the hook
  * @returns {Promise<*>} whatever the hook returns
@@ -357,7 +357,7 @@ async function runOpenWhiskJar (jarFile, runtimeConfigFile, apihost, waitInitTim
 
 /**
  *
- * Converts a service array to an input string that can be consumed by generator-aio-app
+ *Converts a service array to an input string that can be consumed by generator-aio-app
  *
  * @param {Array} services array of services [{ code: 'xxx', name: 'xxx' }, ...]
  * @returns {string} 'code1,code2,code3'

package/src/lib/import-helper.js

@@ -200,24 +200,24 @@ async function checkFileConflict (filePath) {
  * Transform a json object to a flattened version. Any nesting is separated by the `separator` string.
  * For example, if you have the `_` separator string, flattening this:
  *
+ * @example
  * {
- *    foo: {
- *      bar: 'a',
- *      baz: {
- *        faz: 'b'
- *      }
- *    }
+ *   foo: {
+ *     bar: 'a',
+ *     baz: {
+ *       faz: 'b'
+ *     }
+ *   }
  * }
  *
  * const result = flattenObjectWithSeparator(json, {}, '', '_)
  * The result would then be:
  * {
- *    'foo_bar': 'a',
- *    'foo_baz_faz': 'b'
+ *   'foo_bar': 'a',
+ *   'foo_baz_faz': 'b'
  * }
  *
  * Any underscores in the object key are escaped with an underscore.
- *
  * @param {object} json the json object to transform
  * @param {object} result the result object to initialize the function with
  * @param {string} prefix the prefix to add to the final key

package/src/lib/log-poller.js

@@ -33,6 +33,7 @@ const FETCH_LOG_INTERVAL = 10000
 
 /**
  * Class EventPoller.
+ *
  */
 class EventPoller extends EventEmitter {
   constructor (timeout) {