@adobe/aio-cli-plugin-app 13.1.1 → 13.1.3

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@adobe/aio-cli-plugin-app",
   "description": "Create, Build and Deploy Adobe I/O Applications",
-  "version": "13.1.1",
+  "version": "13.1.3",
   "author": "Adobe Inc.",
   "bugs": "https://github.com/adobe/aio-cli-plugin-app/issues",
   "dependencies": {
-    "@adobe/aio-cli-lib-app-config": "^4",
+    "@adobe/aio-cli-lib-app-config": "^4.0.3",
     "@adobe/aio-cli-lib-console": "^5",
     "@adobe/aio-lib-core-config": "^5",
     "@adobe/aio-lib-core-logging": "^3",
     "@adobe/aio-lib-core-networking": "^5",
     "@adobe/aio-lib-env": "^3",
     "@adobe/aio-lib-ims": "^7",
-    "@adobe/aio-lib-runtime": "^7.0.0",
+    "@adobe/aio-lib-runtime": "^7.0.1",
     "@adobe/aio-lib-templates": "^3",
     "@adobe/aio-lib-web": "^7",
     "@adobe/generator-aio-app": "^7",
@@ -54,22 +54,22 @@
   },
   "devDependencies": {
     "@adobe/aio-lib-test-proxy": "^2",
-    "@adobe/eslint-config-aio-lib-config": "^3.0.0",
+    "@adobe/eslint-config-aio-lib-config": "^4.0.0",
     "@types/jest": "^29",
     "babel-runtime": "^6.26.0",
     "core-js": "^3",
     "eol": "^0.9.1",
-    "eslint": "^8.46.0",
+    "eslint": "^8.57.1",
     "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.28.0",
-    "eslint-plugin-jest": "^27.2.3",
-    "eslint-plugin-jsdoc": "^42.0.0",
-    "eslint-plugin-n": "^15.7",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jest": "^27.9.0",
+    "eslint-plugin-jsdoc": "^48.11.0",
+    "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-promise": "^6.6.0",
     "jest": "^29.5.0",
     "nock": "^13.2.9",
-    "oclif": "^3.2.0",
+    "oclif": "^4.17.13",
     "stdout-stderr": "^0.1.9"
   },
   "engines": {

package/src/commands/app/deploy.js

@@ -18,10 +18,11 @@ const BaseCommand = require('../../BaseCommand')
 const BuildCommand = require('./build')
 const webLib = require('@adobe/aio-lib-web')
 const { Flags } = require('@oclif/core')
-const { createWebExportFilter, runInProcess, buildExtensionPointPayloadWoMetadata, buildExcShellViewExtensionMetadata, getCliInfo } = require('../../lib/app-helper')
+const { runInProcess, buildExtensionPointPayloadWoMetadata, buildExcShellViewExtensionMetadata, getCliInfo } = require('../../lib/app-helper')
 const rtLib = require('@adobe/aio-lib-runtime')
 const LogForwarding = require('../../lib/log-forwarding')
 const { sendAuditLogs, getAuditLogEvent, getFilesCountWithExtension } = require('../../lib/audit-logger')
+const logActions = require('../../lib/log-actions')
 
 const PRE_DEPLOY_EVENT_REG = 'pre-deploy-event-reg'
 const POST_DEPLOY_EVENT_REG = 'post-deploy-event-reg'
@@ -64,7 +65,7 @@ class Deploy extends BuildCommand {
             const lfConfig = lf.getLocalConfigWithSecrets()
             if (lfConfig.isDefined()) {
               await lf.updateServerConfig(lfConfig)
-              spinner.succeed(chalk.green(`Log forwarding is set to '${lfConfig.getDestination()}'`))
+              spinner.succeed(chalk.green(`\nLog forwarding is set to '${lfConfig.getDestination()}'`))
             } else {
               if (flags.verbose) {
                 spinner.info(chalk.dim('Log forwarding is not updated: no configuration is provided'))
@@ -93,14 +94,6 @@ class Deploy extends BuildCommand {
         }
       }
 
-      // 3. send deploy log event
-      const logEvent = getAuditLogEvent(flags, aioConfig.project, 'AB_APP_DEPLOY')
-      if (logEvent) {
-        await sendAuditLogs(cliDetails.accessToken, logEvent, cliDetails.env)
-      } else {
-        this.log(chalk.red(chalk.bold('Warning: No valid config data found to send audit log event for deployment.')))
-      }
-
       // 4. deploy actions and web assets for each extension
       // Possible improvements:
       // - parallelize
@@ -112,9 +105,14 @@ class Deploy extends BuildCommand {
         if (v.app.hasFrontend && flags['web-assets']) {
           const opItems = getFilesCountWithExtension(v.web.distProd)
           const assetDeployedLogEvent = getAuditLogEvent(flags, aioConfig.project, 'AB_APP_ASSETS_DEPLOYED')
-          if (assetDeployedLogEvent) {
+          if (assetDeployedLogEvent && cliDetails?.accessToken) {
             assetDeployedLogEvent.data.opItems = opItems
-            await sendAuditLogs(cliDetails.accessToken, assetDeployedLogEvent, cliDetails.env)
+            try {
+              // only send logs in case of web-assets deployment
+              await sendAuditLogs(cliDetails.accessToken, assetDeployedLogEvent, cliDetails.env)
+            } catch (error) {
+              this.warn('Error: Audit Log Service Error: Failed to send audit log event for deployment.')
+            }
           }
         }
       }
@@ -238,24 +236,9 @@ class Deploy extends BuildCommand {
 
     // log deployed resources
     if (deployedRuntimeEntities.actions && deployedRuntimeEntities.actions.length > 0) {
-      this.log(chalk.blue(chalk.bold('Your deployed actions:')))
-      const web = deployedRuntimeEntities.actions.filter(createWebExportFilter(true))
-      const nonWeb = deployedRuntimeEntities.actions.filter(createWebExportFilter(false))
-
-      if (web.length > 0) {
-        this.log('web actions:')
-        web.forEach(a => {
-          this.log(chalk.blue(chalk.bold(`  -> ${a.url || a.name} `)))
-        })
-      }
-
-      if (nonWeb.length > 0) {
-        this.log('non-web actions:')
-        nonWeb.forEach(a => {
-          this.log(chalk.blue(chalk.bold(`  -> ${a.url || a.name} `)))
-        })
-      }
+      await logActions({ entities: deployedRuntimeEntities, log: (...rest) => this.log(chalk.bold(chalk.blue(...rest))) })
     }
+
     // TODO urls should depend on extension point, exc shell only for exc shell extension point - use a post-app-deploy hook ?
     if (deployedFrontendUrl) {
       this.log(chalk.blue(chalk.bold(`To view your deployed application:\n  -> ${deployedFrontendUrl}`)))

package/src/commands/app/undeploy.js

@@ -27,16 +27,21 @@ class Undeploy extends BaseCommand {
     const { flags } = await this.parse(Undeploy)
 
     const undeployConfigs = await this.getAppExtConfigs(flags)
+
+    // 1. undeploy actions and web assets for each extension
+    const keys = Object.keys(undeployConfigs)
+    const values = Object.values(undeployConfigs)
+
+    // if it is standalone app, unpublish it without token
+    const isStandaloneApp = (keys.length === 1 && keys[0] === 'application')
+    flags.unpublish = flags.unpublish && !isStandaloneApp
+
     let libConsoleCLI
     if (flags.unpublish) {
       // force login at beginning (if required)
       libConsoleCLI = await this.getLibConsoleCLI()
     }
 
-    // 1. undeploy actions and web assets for each extension
-    const keys = Object.keys(undeployConfigs)
-    const values = Object.values(undeployConfigs)
-
     if (
       (!flags.unpublish && !flags['web-assets'] && !flags.actions)
     ) {
@@ -46,28 +51,25 @@ class Undeploy extends BaseCommand {
     const spinner = ora()
     try {
       const aioConfig = (await this.getFullConfig()).aio
-      const cliDetails = await getCliInfo()
-      const logEvent = getAuditLogEvent(flags, aioConfig.project, 'AB_APP_UNDEPLOY')
-
-      // 1.1. send audit log event for successful undeploy
-      if (logEvent) {
-        await sendAuditLogs(cliDetails.accessToken, logEvent, cliDetails.env)
-      } else {
-        this.log(chalk.red(chalk.bold('Warning: No valid config data found to send audit log event for deployment.')))
-      }
+      const cliDetails = await getCliInfo(flags.unpublish)
 
       for (let i = 0; i < keys.length; ++i) {
         const k = keys[i]
         const v = values[i]
         await this.undeployOneExt(k, v, flags, spinner)
         const assetUndeployLogEvent = getAuditLogEvent(flags, aioConfig.project, 'AB_APP_ASSETS_UNDEPLOYED')
-        if (assetUndeployLogEvent) {
-          await sendAuditLogs(cliDetails.accessToken, assetUndeployLogEvent, cliDetails.env)
+        // send logs for case of web-assets undeployment
+        if (assetUndeployLogEvent && cliDetails?.accessToken) {
+          try {
+            await sendAuditLogs(cliDetails.accessToken, assetUndeployLogEvent, cliDetails.env)
+          } catch (error) {
+            this.warn('Warning: Audit Log Service Error: Failed to send audit log event for un-deployment.')
+          }
         }
       }
 
       // 1.2. unpublish extension manifest
-      if (flags.unpublish && !(keys.length === 1 && keys[0] === 'application')) {
+      if (flags.unpublish) {
         const payload = await this.unpublishExtensionPoints(libConsoleCLI, undeployConfigs, aioConfig, flags['force-unpublish'])
         this.log(chalk.blue(chalk.bold(`New Extension Point(s) in Workspace '${aioConfig.project.workspace.name}': '${Object.keys(payload.endpoints)}'`)))
       } else {
@@ -110,9 +112,9 @@ class Undeploy extends BaseCommand {
           if (!script) {
             await rtLib.undeployActions(config)
           }
-          spinner.succeed(chalk.green(`Un-Deploying actions for ${extName}`))
+          spinner.succeed(chalk.green(`Un-deploying actions for ${extName}`))
         } catch (err) {
-          spinner.fail(chalk.green(`Un-Deploying actions for ${extName}`))
+          spinner.fail(chalk.green(`Un-deploying actions for ${extName}`))
           throw err
         }
       } else {

package/src/lib/actions-watcher.js

@@ -63,7 +63,13 @@ module.exports = async (watcherOptions) => {
 async function buildAndDeploy (watcherOptions, filterActions) {
   const { config, isLocal, log, inprocHook } = watcherOptions
   await buildActions(config, filterActions)
-  await deployActions(config, isLocal, log, filterActions, inprocHook)
+  const deployConfig = {
+    isLocalDev: isLocal,
+    filterEntities: {
+      actions: filterActions
+    }
+  }
+  await deployActions({ config, deployConfig, log, inprocHook })
 }
 
 /**

package/src/lib/app-helper.js

@@ -155,7 +155,7 @@ async function runScript (command, dir, cmdArgs = []) {
             aioLogger.debug(`Killing ${command} event hook long-running process (pid: ${pid})`)
             process.kill(pid, 'SIGTERM')
           } catch (_) {
-          // do nothing if pid not found
+            // do nothing if pid not found
           }
         })
       }
@@ -551,11 +551,13 @@ function deleteUserConfig (configData) {
 /** @private */
 const createWebExportFilter = (filterValue) => {
   return (action) => {
-    if (!action || !action.annotations) {
+    if (!action) {
       return false
     }
 
-    return String(!!action.annotations['web-export']) === String(filterValue)
+    // if no annotations, its as if web-export = false
+    const webExportValue = action.annotations?.['web-export'] ?? false
+    return String(!!webExportValue) === String(filterValue)
   }
 }
 

package/src/lib/audit-logger.js

@@ -12,18 +12,16 @@ const fetch = require('node-fetch')
 const fs = require('fs')
 const path = require('path')
 const chalk = require('chalk')
-const { getCliEnv, PROD_ENV } = require('@adobe/aio-lib-env')
-const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:lib-audit-logger', { provider: 'debug' })
 
 const OPERATIONS = {
   AB_APP_DEPLOY: 'ab_app_deploy',
   AB_APP_UNDEPLOY: 'ab_app_undeploy',
-  AB_APP_TEST: 'ab_app_test', // todo : remove after testing
+  AB_APP_TEST: 'ab_app_test',
   AB_APP_ASSETS_DEPLOYED: 'ab_app_assets_deployed',
   AB_APP_ASSETS_UNDEPLOYED: 'ab_app_assets_undeployed'
 }
 
-const AUDIT_SERVICE_ENPOINTS = {
+const AUDIT_SERVICE_ENDPOINTS = {
   stage: 'https://adp-auditlog-service-stage.adobeioruntime.net/api/v1/web/audit-log-api/event-post',
   prod: 'https://adp-auditlog-service-prod.adobeioruntime.net/api/v1/web/audit-log-api/event-post'
 }
@@ -35,12 +33,7 @@ const AUDIT_SERVICE_ENPOINTS = {
  * @param {string} env valid env stage|prod
  */
 async function sendAuditLogs (accessToken, logEvent, env = 'prod') {
-  // TODO: this is blocked by the audit service only being available in stage
-  // remove this check once the service is available in prod
-  if (env !== 'stage') {
-    return
-  }
-  const url = AUDIT_SERVICE_ENPOINTS[env]
+  const url = AUDIT_SERVICE_ENDPOINTS[env] ?? AUDIT_SERVICE_ENDPOINTS.prod
   const payload = {
     event: logEvent
   }
@@ -67,11 +60,6 @@ async function sendAuditLogs (accessToken, logEvent, env = 'prod') {
  * @returns {object} logEvent
  */
 function getAuditLogEvent (flags, project, event) {
-  if (getCliEnv() === PROD_ENV) {
-    aioLogger.debug('Audit logging is currently disabled in production environment')
-    return null
-  }
-
   let logEvent, logStrMsg
   if (project && project.org && project.workspace) {
     if (event === 'AB_APP_DEPLOY') {
@@ -113,7 +101,7 @@ function getFilesCountWithExtension (directory) {
     return log
   }
 
-  const files = fs.readdirSync(directory)
+  const files = fs.readdirSync(directory, { recursive: true })
 
   if (files.length === 0) {
     this.log(chalk.red(chalk.bold(`Error: No files found in directory ${directory}.`)))
@@ -121,7 +109,6 @@ function getFilesCountWithExtension (directory) {
   }
 
   const fileTypeCounts = {}
-
   files.forEach(file => {
     const ext = path.extname(file).toLowerCase() || 'no extension'
     if (fileTypeCounts[ext]) {
@@ -134,23 +121,38 @@ function getFilesCountWithExtension (directory) {
   Object.keys(fileTypeCounts).forEach(ext => {
     const count = fileTypeCounts[ext]
     let description
-
-    if (ext === '.js') description = 'Javascript file(s)'
-    else if (ext === '.css') description = 'CSS file(s)'
-    else if (ext === '.html') description = 'HTML page(s)'
-    else if (['.png', '.jpg', '.jpeg', '.gif', '.svg', '.webp'].includes(ext)) description = 'image(s)'
-    else if (ext === 'no extension') description = 'file(s) without extension'
-    else description = `${ext} file(s)`
-
+    switch (ext) {
+      case '.js':
+        description = 'Javascript file(s)'
+        break
+      case '.css':
+        description = 'CSS file(s)'
+        break
+      case '.html':
+        description = 'HTML page(s)'
+        break
+      case '.png':
+      case '.jpg':
+      case '.jpeg':
+      case '.gif':
+      case '.svg':
+      case '.webp':
+        description = `${ext} image(s)`
+        break
+      case 'no extension':
+        description = 'file(s) without extension'
+        break
+      default:
+        description = `${ext} file(s)`
+    }
     log.push(`${count} ${description}\n`)
   })
-
   return log
 }
 
 module.exports = {
   sendAuditLogs,
   getAuditLogEvent,
-  AUDIT_SERVICE_ENPOINTS,
+  AUDIT_SERVICE_ENDPOINTS,
   getFilesCountWithExtension
 }

package/src/lib/deploy-actions.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2020 Adobe. All rights reserved.
+Copyright 2024 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License. You may obtain a copy
 of the License at http://www.apache.org/licenses/LICENSE-2.0
@@ -10,60 +10,52 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-const { runInProcess, createWebExportFilter } = require('./app-helper')
+const { runInProcess } = require('./app-helper')
 const { deployActions } = require('@adobe/aio-lib-runtime')
+const logActions = require('./log-actions')
 
 /**
  * Deploys actions.
  *
- * @param {object} config see src/lib/config-loader.js
- * @param {boolean} isLocalDev default false, set to true if it's a local deploy
- * @param {Function} [log] a log function
- * @param {boolean} filter true if a filter by built actions is desired.
+ * @private
+ * @param {object} options
+ * @param {object} options.config see src/lib/config-loader.js
+ * @param {object} [options.deployConfig] see https://github.com/adobe/aio-lib-runtime/blob/master/README.md#typedefs
+ * @param {Function} [options.log] a log function
+ * @param {Function} [options.inprocHook] a hook function
  */
-/** @private */
-module.exports = async (config, isLocalDev = false, log = () => {}, filter = false, inprocHook) => {
+module.exports = async ({
+  config,
+  deployConfig = {},
+  log = () => {},
+  inprocHook
+}) => {
   await runInProcess(config.hooks['pre-app-deploy'], config)
-  const script = await runInProcess(config.hooks['deploy-actions'], { config, options: { isLocalDev, filter } })
+
+  const hookFilterEntities = Array.isArray(deployConfig.filterEntities?.actions) ? deployConfig.filterEntities.actions : []
+  const hookData = {
+    appConfig: config,
+    filterEntities: hookFilterEntities,
+    isLocalDev: deployConfig.isLocalDev
+  }
+
+  let entities
+  const script = await runInProcess(config.hooks['deploy-actions'], hookData)
   if (!script) {
-    const deployConfig = {
-      isLocalDev,
-      filterEntities: {
-        byBuiltActions: filter
-      }
-    }
     if (inprocHook) {
-      const hookFilterEntities = Array.isArray(filter) ? filter : []
-      const hookResults = await inprocHook('deploy-actions', {
-        appConfig: config,
-        filterEntities: hookFilterEntities,
-        isLocalDev
-      })
+      const hookResults = await inprocHook('deploy-actions', hookData)
       if (hookResults?.failures?.length > 0) {
         // output should be "Error : <plugin-name> : <error-message>\n" for each failure
         log('Error: ' + hookResults.failures.map(f => `${f.plugin.name} : ${f.error.message}`).join('\nError: '))
         throw new Error(`Hook 'deploy-actions' failed with ${hookResults.failures[0].error}`)
       }
     }
-    const entities = await deployActions(config, deployConfig, log)
-    if (entities.actions) {
-      const web = entities.actions.filter(createWebExportFilter(true))
-      const nonWeb = entities.actions.filter(createWebExportFilter(false))
 
-      if (web.length > 0) {
-        log('web actions:')
-        web.forEach(a => {
-          log(`  -> ${a.url || a.name}`)
-        })
-      }
-
-      if (nonWeb.length > 0) {
-        log('non-web actions:')
-        nonWeb.forEach(a => {
-          log(`  -> ${a.url || a.name}`)
-        })
-      }
-    }
+    entities = await deployActions(config, deployConfig, log)
+    await logActions({ entities, log })
   }
+
   await runInProcess(config.hooks['post-app-deploy'], config)
+
+  return { script, entities }
 }

package/src/lib/log-actions.js

@@ -0,0 +1,52 @@
+/*
+Copyright 2024 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONSTJ
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const { createWebExportFilter } = require('./app-helper')
+
+/**
+ * Logs deployed action entities.
+ *
+ * @private
+ * @param {object} options
+ * @param {object} options.entities runtime entities that have been deployed
+ * @param {object} [options.deployConfig] see https://github.com/adobe/aio-lib-runtime?tab=readme-ov-file#typedefs
+ * @param {Function} [options.log] a log function
+ */
+module.exports = async ({
+  entities,
+  log = console.log
+}) => {
+  if (!entities.actions) {
+    return
+  }
+
+  log('Your deployed actions:')
+
+  const _web = entities.actions.filter(createWebExportFilter(true))
+  const _webRaw = entities.actions.filter(createWebExportFilter('raw'))
+  const web = [..._web, ..._webRaw]
+  const nonWeb = entities.actions.filter(createWebExportFilter(false))
+
+  if (web.length > 0) {
+    log('web actions:')
+    web.forEach(a => {
+      log(`  -> ${a.url || a.name}`)
+    })
+  }
+
+  if (nonWeb.length > 0) {
+    log('non-web actions:')
+    nonWeb.forEach(a => {
+      log(`  -> ${a.url || a.name}`)
+    })
+  }
+}

package/src/lib/run-dev.js

@@ -122,7 +122,18 @@ async function runDev (config, dataDir, options = {}, log = () => {}, inprocHook
     // Deploy Phase - deploy actions
     if (withBackend) {
       log('redeploying actions..')
-      await deployActions(devConfig, isLocal, log, true, inprocHook)
+      const deployConfig = {
+        isLocalDev: isLocal,
+        filterEntities: {
+          byBuiltActions: true
+        }
+      }
+      await deployActions({
+        config: devConfig,
+        deployConfig,
+        log,
+        inprocHook
+      })
     }
 
     // Deploy Phase - serve the web UI