@adobe/aio-cli-plugin-app 10.7.2 → 11.1.0-pre.2024-01-09.2e4115c3

package/package.json

@@ -1,24 +1,25 @@
 {
   "name": "@adobe/aio-cli-plugin-app",
   "description": "Create, Build and Deploy Adobe I/O Applications",
-  "version": "10.7.2",
+  "version": "11.1.0-pre.2024-01-09.2e4115c3",
   "author": "Adobe Inc.",
   "bugs": "https://github.com/adobe/aio-cli-plugin-app/issues",
   "dependencies": {
-    "@adobe/aio-cli-lib-app-config": "^1.1.0",
+    "@adobe/aio-cli-lib-app-config": "next",
     "@adobe/aio-cli-lib-app-config-next": "npm:@adobe/aio-cli-lib-app-config@^3.0.0",
-    "@adobe/aio-cli-lib-console": "^4.1.0",
-    "@adobe/aio-lib-core-config": "^4.0.0",
-    "@adobe/aio-lib-core-logging": "^2.0.0",
-    "@adobe/aio-lib-core-networking": "^4.1.0",
-    "@adobe/aio-lib-env": "^2.0.0",
-    "@adobe/aio-lib-ims": "^6.0.0",
-    "@adobe/aio-lib-runtime": "^5.0.0",
+    "@adobe/aio-cli-lib-console": "next",
+    "@adobe/aio-lib-core-config": "next",
+    "@adobe/aio-lib-core-logging": "next",
+    "@adobe/aio-lib-core-networking": "next",
+    "@adobe/aio-lib-env": "next",
+    "@adobe/aio-lib-ims": "next",
+    "@adobe/aio-lib-runtime": "next",
     "@adobe/aio-lib-templates": "^2.2.0",
-    "@adobe/aio-lib-web": "^6.1.0",
-    "@adobe/generator-aio-app": "^5.1.0",
-    "@adobe/generator-app-common-lib": "^0.4.5",
+    "@adobe/aio-lib-web": "next",
+    "@adobe/generator-aio-app": "next",
+    "@adobe/generator-app-common-lib": "^1.0.0",
     "@adobe/inquirer-table-checkbox": "^1.2.0",
+    "@octokit/rest": "^19.0.11",
     "@oclif/core": "^2.11.6",
     "@parcel/core": "^2.7.0",
     "@parcel/reporter-cli": "^2.7.0",
@@ -48,12 +49,13 @@
     "term-size": "^2.2.1",
     "unzipper": "^0.10.11",
     "upath": "^2",
+    "junk": "^3.1.0",
     "which": "^3.0.0",
     "yeoman-environment": "^3.2.0"
   },
   "devDependencies": {
     "@adobe/aio-lib-test-proxy": "^1.0.0",
-    "@adobe/eslint-config-aio-lib-config": "^2.0.1",
+    "@adobe/eslint-config-aio-lib-config": "^2.0.2",
     "@types/jest": "^29",
     "babel-runtime": "^6.26.0",
     "core-js": "^3",
@@ -73,7 +75,7 @@
     "typescript": "^5.1.6"
   },
   "engines": {
-    "node": "^14.18 || ^16.13 || >=18"
+    "node": ">=18"
   },
   "files": [
     "bin/run",
@@ -106,5 +108,6 @@
   },
   "bin": {
     "aio-next": "./bin/run"
-  }
-}
+  },
+  "prereleaseSha": "2e4115c3814afd05bf049bc66b1a491cc5833a6a"
+}

package/src/BaseCommand.js

@@ -35,20 +35,7 @@ class BaseCommand extends Command {
   async catch (error) {
     const { flags } = await this.parse(this.prototype)
     aioLogger.error(error) // debug log
-    this.handleError(error, flags.verbose)
-  }
-
-  handleError (error, verbose) {
-    const errorMessages = ['no such file or directory', 'find configuration']
-    if (errorMessages.find(msg => error.message.includes(msg))) {
-      const errorList = [
-        'Not a valid application root folder.',
-        'Please run \'aio app\' commands from a folder generated by aio app init',
-        verbose ? error.stack : error.message
-      ]
-      this.error(errorList.join('\n'))
-    }
-    this.error(error.message)
+    this.error(flags.verbose ? error.stack : error.message)
   }
 
   async init () {

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

@@ -11,12 +11,9 @@ governing permissions and limitations under the License.
 
 const AddCommand = require('../../../AddCommand')
 const TemplatesCommand = require('../../../TemplatesCommand')
-const yeoman = require('yeoman-environment')
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:add:event', { provider: 'debug' })
 const { Flags } = require('@oclif/core')
-const ora = require('ora')
 const path = require('path')
-const generators = require('@adobe/generator-aio-app')
 const TemplateRegistryAPI = require('@adobe/aio-lib-templates')
 
 class AddEventCommand extends TemplatesCommand {
@@ -24,7 +21,6 @@ class AddEventCommand extends TemplatesCommand {
     const { flags } = await this.parse(AddEventCommand)
 
     aioLogger.debug(`add events with flags: ${JSON.stringify(flags)}`)
-    const spinner = ora()
 
     // guaranteed to have at least one, otherwise would throw in config load or in matching the ext name
     const entries = Object.entries(this.getAppExtConfigs(flags))
@@ -36,42 +32,27 @@ class AddEventCommand extends TemplatesCommand {
     const config = entries[0][1]
     const actionFolder = path.relative(config.root, config.actions.src)
     const runtimeManifestData = this.getRuntimeManifestConfigFile(configName)
-
+    const eventsData = this.getEventsConfigFile(configName)
     const templateOptions = {
       'skip-prompt': false,
       'action-folder': actionFolder,
       'config-path': runtimeManifestData.file,
-      'full-key-to-manifest': runtimeManifestData.key
+      'full-key-to-manifest': runtimeManifestData.key,
+      'full-key-to-events-manifest': eventsData.key,
+      'events-config-path': eventsData.file
     }
 
-    if (flags['experimental-allow-events-templates']) {
-      const eventsData = this.getEventsConfigFile(configName)
-      templateOptions['full-key-to-events-manifest'] = eventsData.key
-      templateOptions['events-config-path'] = eventsData.file
-      const [searchCriteria, orderByCriteria] = await this.getSearchCriteria()
-      const templates = await this.selectTemplates(searchCriteria, orderByCriteria)
-      if (templates.length === 0) {
-        this.error('No events templates were chosen to be installed.')
-      } else {
-        await this.installTemplates({
-          useDefaultValues: flags.yes,
-          installNpm: flags.install,
-          templateOptions,
-          templates
-        })
-      }
-      // by default yeoman runs the install, we control installation from the app plugin
+    const [searchCriteria, orderByCriteria] = await this.getSearchCriteria()
+    const templates = await this.selectTemplates(searchCriteria, orderByCriteria)
+    if (templates.length === 0) {
+      this.error('No events templates were chosen to be installed.')
     } else {
-      templateOptions['skip-prompt'] = flags.yes
-      templateOptions.force = true
-      const env = yeoman.createEnv()
-      env.options = { skipInstall: true }
-      const eventsGen = env.instantiate(generators['add-events'], {
-        options: templateOptions
+      await this.installTemplates({
+        useDefaultValues: flags.yes,
+        installNpm: flags.install,
+        templateOptions,
+        templates
       })
-      await env.runGenerator(eventsGen)
-
-      await this.runInstallPackages(flags, spinner)
     }
   }
 
@@ -107,10 +88,6 @@ AddEventCommand.flags = {
     multiple: false,
     parse: str => [str]
   }),
-  'experimental-allow-events-templates': Flags.boolean({
-    description: 'Feature flag to enable events templates. NOTE: skip-prompt will have no effect if this flag is enabled.',
-    default: false
-  }),
   ...AddCommand.flags
 }
 

package/src/commands/app/build.js

@@ -116,6 +116,8 @@ class Build extends BaseCommand {
               shouldOptimize: flags['web-optimize'],
               logLevel: flags.verbose ? 'verbose' : 'warn'
             }
+            // empty the dist folder to prevent an S3 explosion
+            fs.emptyDirSync(config.web.distProd)
             const bundler = await bundle(entries, config.web.distProd, bundleOptions, onProgress)
             await bundler.run()
             spinner.succeed(chalk.green(`Building web assets for '${name}'`))

package/src/commands/app/deploy.js

@@ -22,6 +22,9 @@ const { createWebExportFilter, runInProcess, buildExtensionPointPayloadWoMetadat
 const rtLib = require('@adobe/aio-lib-runtime')
 const LogForwarding = require('../../lib/log-forwarding')
 
+const PRE_DEPLOY_EVENT_REG = 'pre-deploy-event-reg'
+const POST_DEPLOY_EVENT_REG = 'post-deploy-event-reg'
+
 class Deploy extends BuildCommand {
   async run () {
     // cli input
@@ -142,13 +145,10 @@ class Deploy extends BuildCommand {
 
     try {
       await runInProcess(config.hooks['pre-app-deploy'], config)
-      if (flags['feature-event-hooks']) {
-        this.log('feature-event-hooks is enabled, running pre-deploy-event-reg hook')
-        const hookResults = await this.config.runHook('pre-deploy-event-reg', { appConfig: config, force: flags['force-events'] })
-        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 })
-        }
+      const hookResults = await this.config.runHook(PRE_DEPLOY_EVENT_REG, { appConfig: config, force: flags['force-events'] })
+      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.error(err)
@@ -250,13 +250,10 @@ class Deploy extends BuildCommand {
 
     try {
       await runInProcess(config.hooks['post-app-deploy'], config)
-      if (flags['feature-event-hooks']) {
-        this.log('feature-event-hooks is enabled, running post-deploy-event-reg hook')
-        const hookResults = await this.config.runHook('post-deploy-event-reg', { appConfig: config, force: flags['force-events'] })
-        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 })
-        }
+      const hookResults = await this.config.runHook(POST_DEPLOY_EVENT_REG, { appConfig: config, force: flags['force-events'] })
+      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.error(err)
@@ -353,10 +350,9 @@ Deploy.flags = {
     exclusive: ['action', 'publish'] // no-publish is excluded
   }),
   'force-events': Flags.boolean({
-    description: '[default: false] Force event registrations and overwrite any previous registrations',
+    description: '[default: false] Force event registrations and delete any registrations not part of the config file',
     default: false,
     allowNo: true,
-    dependsOn: ['feature-event-hooks'],
     exclusive: ['action', 'publish'] // no-publish is excluded
   }),
   'web-optimize': Flags.boolean({
@@ -367,12 +363,6 @@ Deploy.flags = {
     description: '[default: true] Update log forwarding configuration on server',
     default: true,
     allowNo: true
-  }),
-  'feature-event-hooks': Flags.boolean({
-    description: '[default: false] Enable event hooks feature',
-    default: false,
-    allowNo: true,
-    hidden: true
   })
 }
 

package/src/commands/app/init.js

@@ -20,9 +20,10 @@ const generators = require('@adobe/generator-aio-app')
 const TemplateRegistryAPI = require('@adobe/aio-lib-templates')
 const inquirer = require('inquirer')
 const hyperlinker = require('hyperlinker')
-
 const { importConsoleConfig } = require('../../lib/import')
 const { loadAndValidateConfigFile } = require('../../lib/import-helper')
+const { Octokit } = require('@octokit/rest')
+const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:init', { provider: 'debug' })
 
 const DEFAULT_WORKSPACE = 'Stage'
 
@@ -102,24 +103,28 @@ class InitCommand extends TemplatesCommand {
       this.log(chalk.green(`Loaded Adobe Developer Console configuration file for the Project '${consoleConfig.project.title}' in the Organization '${consoleConfig.project.org.name}'`))
     }
 
-    // 2. prompt for templates to be installed
-    const templates = await this.getTemplatesForFlags(flags)
-    // If no templates selected, init a standalone app
-    if (templates.length <= 0) {
-      flags['standalone-app'] = true
-    }
+    if (flags.repo) {
+      await this.withQuickstart(flags.repo)
+    } else {
+      // 2. prompt for templates to be installed
+      const templates = await this.getTemplatesForFlags(flags)
+      // If no templates selected, init a standalone app
+      if (templates.length <= 0) {
+        flags['standalone-app'] = true
+      }
 
-    // 3. run base code generators
-    const projectName = (consoleConfig && consoleConfig.project.name) || path.basename(process.cwd())
-    await this.runCodeGenerators(this.getInitialGenerators(flags), flags.yes, projectName)
+      // 3. run base code generators
+      const projectName = (consoleConfig && consoleConfig.project.name) || path.basename(process.cwd())
+      await this.runCodeGenerators(this.getInitialGenerators(flags), flags.yes, projectName)
 
-    // 4. install templates
-    await this.installTemplates({
-      useDefaultValues: flags.yes,
-      installNpm: flags.install,
-      installConfig: flags.login,
-      templates
-    })
+      // 4. install templates
+      await this.installTemplates({
+        useDefaultValues: flags.yes,
+        installNpm: flags.install,
+        installConfig: flags.login,
+        templates
+      })
+    }
 
     // 5. import config - if any
     if (flags.import) {
@@ -128,40 +133,50 @@ class InitCommand extends TemplatesCommand {
   }
 
   async initWithLogin (flags) {
+    if (flags.repo) {
+      await this.withQuickstart(flags.repo)
+    }
     // this will trigger a login
     const consoleCLI = await this.getLibConsoleCLI()
 
     // 1. select org
-    const org = await this.selectConsoleOrg(consoleCLI)
+    const org = await this.selectConsoleOrg(consoleCLI, flags)
     // 2. get supported services
     const orgSupportedServices = await consoleCLI.getEnabledServicesForOrg(org.id)
     // 3. select or create project
-    const project = await this.selectOrCreateConsoleProject(consoleCLI, org)
+    const project = await this.selectOrCreateConsoleProject(consoleCLI, org, flags)
     // 4. retrieve workspace details, defaults to Stage
     const workspace = await this.retrieveWorkspaceFromName(consoleCLI, org, project, flags)
 
-    // 5. get list of templates to install
-    const templates = await this.getTemplatesForFlags(flags, orgSupportedServices)
-    // If no templates selected, init a standalone app
-    if (templates.length <= 0) {
-      flags['standalone-app'] = true
+    let templates
+    if (!flags.repo) {
+      // 5. get list of templates to install
+      templates = await this.getTemplatesForFlags(flags, orgSupportedServices)
+      // If no templates selected, init a standalone app
+      if (templates.length <= 0) {
+        flags['standalone-app'] = true
+      }
     }
 
     // 6. download workspace config
     const consoleConfig = await consoleCLI.getWorkspaceConfig(org.id, project.id, workspace.id, orgSupportedServices)
 
     // 7. run base code generators
-    await this.runCodeGenerators(this.getInitialGenerators(flags), flags.yes, consoleConfig.project.name)
+    if (!flags.repo) {
+      await this.runCodeGenerators(this.getInitialGenerators(flags), flags.yes, consoleConfig.project.name)
+    }
 
     // 8. import config
     await this.importConsoleConfig(consoleConfig, flags)
 
     // 9. install templates
-    await this.installTemplates({
-      useDefaultValues: flags.yes,
-      installNpm: flags.install,
-      templates
-    })
+    if (!flags.repo) {
+      await this.installTemplates({
+        useDefaultValues: flags.yes,
+        installNpm: flags.install,
+        templates
+      })
+    }
 
     this.log(chalk.blue(chalk.bold(`Project initialized for Workspace ${workspace.name}, you can run 'aio app use -w <workspace>' to switch workspace.`)))
   }
@@ -275,21 +290,24 @@ class InitCommand extends TemplatesCommand {
     return [searchCriteria, orderByCriteria, selection, selectionLabel]
   }
 
-  async selectConsoleOrg (consoleCLI) {
+  async selectConsoleOrg (consoleCLI, flags) {
     const organizations = await consoleCLI.getOrganizations()
-    const selectedOrg = await consoleCLI.promptForSelectOrganization(organizations)
+    const selectedOrg = await consoleCLI.promptForSelectOrganization(organizations, { orgId: flags.org, orgCode: flags.org })
     await this.ensureDevTermAccepted(consoleCLI, selectedOrg.id)
     return selectedOrg
   }
 
-  async selectOrCreateConsoleProject (consoleCLI, org) {
+  async selectOrCreateConsoleProject (consoleCLI, org, flags) {
     const projects = await consoleCLI.getProjects(org.id)
     let project = await consoleCLI.promptForSelectProject(
       projects,
-      {},
+      { projectId: flags.project, projectName: flags.project },
       { allowCreate: true }
     )
     if (!project) {
+      if (flags.project) {
+        this.error(`--project ${flags.project} not found`)
+      }
       // user has escaped project selection prompt, let's create a new one
       const projectDetails = await consoleCLI.promptForCreateProjectDetails()
       project = await consoleCLI.createProject(org.id, projectDetails)
@@ -348,7 +366,56 @@ class InitCommand extends TemplatesCommand {
       }
     )
   }
+
+  async withQuickstart (fullRepo) {
+    const octokit = new Octokit({
+      auth: ''
+    })
+    const spinner = ora('Downloading quickstart repo').start()
+    /** @private */
+    async function downloadRepoDirRecursive (owner, repo, filePath, basePath) {
+      const { data } = await octokit.repos.getContent({ owner, repo, path: filePath })
+      for (const fileOrDir of data) {
+        if (fileOrDir.type === 'dir') {
+          const destDir = path.relative(basePath, fileOrDir.path)
+          fs.ensureDirSync(destDir)
+          await downloadRepoDirRecursive(owner, repo, fileOrDir.path, basePath)
+        } else {
+          // todo: use a spinner
+          spinner.text = `Downloading ${fileOrDir.path}`
+          const response = await fetch(fileOrDir.download_url)
+          const jsonResponse = await response.text()
+          fs.writeFileSync(path.relative(basePath, fileOrDir.path), jsonResponse)
+        }
+      }
+    }
+    // we need to handle n-deep paths, <owner>/<repo>/<path>/<path>
+    const [owner, repo, ...restOfPath] = fullRepo.split('/')
+    const basePath = restOfPath.join('/')
+    try {
+      const response = await octokit.repos.getContent({ owner, repo, path: `${basePath}/app.config.yaml` })
+      aioLogger.debug(`github headers: ${JSON.stringify(response.headers, 0, 2)}`)
+      await downloadRepoDirRecursive(owner, repo, basePath, basePath)
+      spinner.succeed('Downloaded quickstart repo')
+    } catch (e) {
+      if (e.status === 404) {
+        spinner.fail('Quickstart repo not found')
+        this.error('--repo does not point to a valid Adobe App Builder app')
+      }
+      if (e.status === 403) {
+        // This is helpful for debugging, but by default we don't show it
+        // github rate limit is 60 requests per hour for unauthenticated users
+        const resetTime = new Date(e.response.headers['x-ratelimit-reset'] * 1000)
+        aioLogger.debug(`too many requests, resetTime : ${resetTime.toLocaleTimeString()}`)
+        spinner.fail()
+        this.error('too many requests, please try again later')
+      } else {
+        this.error(e)
+      }
+    }
+  }
 }
+
 InitCommand.description = `Create a new Adobe I/O App
 `
 
@@ -372,18 +439,28 @@ InitCommand.flags = {
     description: 'Extension point(s) to implement',
     char: 'e',
     multiple: true,
-    exclusive: ['template']
+    exclusive: ['template', 'repo']
   }),
   'standalone-app': Flags.boolean({
     description: 'Create a stand-alone application',
     default: false,
-    exclusive: ['template']
+    exclusive: ['template', 'repo']
   }),
   template: Flags.string({
     description: 'Specify a link to a template that will be installed',
     char: 't',
     multiple: true
   }),
+  org: Flags.string({
+    description: 'Specify the Adobe Developer Console Org to init from',
+    hidden: true,
+    exclusive: ['import'] // also no-login
+  }),
+  project: Flags.string({
+    description: 'Specify the Adobe Developer Console Project to init from',
+    hidden: true,
+    exclusive: ['import'] // also no-login
+  }),
   workspace: Flags.string({
     description: 'Specify the Adobe Developer Console Workspace to init from, defaults to Stage',
     default: DEFAULT_WORKSPACE,
@@ -394,6 +471,10 @@ InitCommand.flags = {
     description: 'Skip and confirm prompt for creating a new workspace',
     default: false
   }),
+  repo: Flags.string({
+    description: 'Init from gh quick-start repo. Expected to be of the form <owner>/<repo>/<path>',
+    exclusive: ['template', 'extension', 'standalone-app']
+  }),
   'use-jwt': Flags.boolean({
     description: 'if the config has both jwt and OAuth Server to Server Credentials (while migrating), prefer the JWT credentials',
     default: false

package/src/commands/app/install.js

@@ -55,7 +55,9 @@ class InstallCommand extends BaseCommand {
       await this.validateAppConfig(outputPath, USER_CONFIG_FILE)
       await this.validateDeployConfig(outputPath, DEPLOY_CONFIG_FILE)
       await this.npmInstall(flags.verbose)
-      await this.runTests()
+      if (flags.tests) {
+        await this.runTests()
+      }
       this.spinner.succeed('Install done.')
     } catch (e) {
       this.spinner.fail(e.message)
@@ -164,6 +166,11 @@ InstallCommand.flags = {
     description: 'The packaged app output folder path',
     char: 'o',
     default: '.'
+  }),
+  tests: Flags.boolean({
+    description: 'Run packaged app unit tests (e.g. aio app:test)',
+    default: true,
+    allowNo: true
   })
 }