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

package/src/commands/app/pack.js

@@ -21,14 +21,16 @@ const { loadConfigFile, writeFile } = require('../../lib/import-helper')
 const { getObjectValue } = require('../../lib/app-helper')
 const ora = require('ora')
 const chalk = require('chalk')
+const junk = require('junk')
 
 // eslint-disable-next-line node/no-missing-require
 const libConfigNext = require('@adobe/aio-cli-lib-app-config-next')
 
+const DIST_FOLDER = 'dist'
 const DEFAULTS = {
-  OUTPUT_ZIP_FILE: 'app.zip',
-  ARTIFACTS_FOLDER: 'app-package',
-  DEPLOY_YAML_FILE: 'deploy.yaml'
+  OUTPUT_ZIP_FILE_PATH: path.join(DIST_FOLDER, 'app.zip'),
+  ARTIFACTS_FOLDER_PATH: path.join(DIST_FOLDER, 'app-package'),
+  DEPLOY_YAML_FILE_NAME: 'deploy.yaml'
 }
 
 class Pack extends BaseCommand {
@@ -53,20 +55,37 @@ class Pack extends BaseCommand {
       aioLogger.debug(`changed current working directory to: ${resolvedPath}`)
     }
 
+    // get all 'dist' locations of all extensions (relative to the current working directory)
+    const distLocations = Object.entries(appConfig.all)
+      .map(([, extConfig]) => path.relative(process.cwd(), extConfig.app.dist))
+
     try {
       // 1. create artifacts phase
-      this.spinner.start(`Creating package artifacts folder '${DEFAULTS.ARTIFACTS_FOLDER}'...`)
-      await fs.emptyDir(DEFAULTS.ARTIFACTS_FOLDER)
-      this.spinner.succeed(`Created package artifacts folder '${DEFAULTS.ARTIFACTS_FOLDER}'`)
+      this.spinner.start(`Creating package artifacts folder '${DEFAULTS.ARTIFACTS_FOLDER_PATH}'...`)
+      await fs.emptyDir(DEFAULTS.ARTIFACTS_FOLDER_PATH)
+      this.spinner.succeed(`Created package artifacts folder '${DEFAULTS.ARTIFACTS_FOLDER_PATH}'`)
 
       // ACNA-2038
       // not artifacts folder should exist before we fire the event
-      await this.config.runHook('pre-pack', { appConfig, artifactsFolder: DEFAULTS.ARTIFACTS_FOLDER })
+
+      const hookResults = await this.config.runHook('pre-pack', { appConfig, artifactsFolder: DEFAULTS.ARTIFACTS_FOLDER_PATH })
+      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 })
+      }
+
+      // 1a. Get file list to pack
+      const fileList = await this.filesToPack({ filesToExclude: [flags.output, DEFAULTS.DIST_FOLDER, ...distLocations] })
+      this.log('=== Files to pack ===')
+      fileList.forEach((file) => {
+        this.log(`  ${file}`)
+      })
+      this.log('=====================')
 
       // 2. copy files to package phase
       this.spinner.start('Copying project files...')
-      const fileList = await this.filesToPack([flags.output])
-      await this.copyPackageFiles(DEFAULTS.ARTIFACTS_FOLDER, fileList)
+
+      await this.copyPackageFiles(DEFAULTS.ARTIFACTS_FOLDER_PATH, fileList)
       this.spinner.succeed('Copied project files')
 
       // 3. add/modify artifacts phase
@@ -79,13 +98,18 @@ class Pack extends BaseCommand {
       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 })
+      await this.config.runHook('post-pack', { appConfig, artifactsFolder: DEFAULTS.ARTIFACTS_FOLDER_PATH })
 
       // 4. zip package phase
-      this.spinner.start(`Zipping package artifacts folder '${DEFAULTS.ARTIFACTS_FOLDER}' to '${outputZipFile}'...`)
+      this.spinner.start(`Zipping package artifacts folder '${DEFAULTS.ARTIFACTS_FOLDER_PATH}' to '${outputZipFile}'...`)
       await fs.remove(outputZipFile)
-      await this.zipHelper(DEFAULTS.ARTIFACTS_FOLDER, outputZipFile)
-      this.spinner.succeed(`Zipped package artifacts folder '${DEFAULTS.ARTIFACTS_FOLDER}' to '${outputZipFile}'`)
+      await this.zipHelper(DEFAULTS.ARTIFACTS_FOLDER_PATH, outputZipFile)
+      this.spinner.succeed(`Zipped package artifacts folder '${DEFAULTS.ARTIFACTS_FOLDER_PATH}' to '${outputZipFile}'`)
+
+      // 5. finally delete the artifacts folder
+      this.spinner.start(`Deleting package artifacts folder '${DEFAULTS.ARTIFACTS_FOLDER_PATH}'...`)
+      await fs.remove(DEFAULTS.ARTIFACTS_FOLDER_PATH)
+      this.spinner.succeed(`Deleted package artifacts folder '${DEFAULTS.ARTIFACTS_FOLDER_PATH}'`)
     } catch (e) {
       this.spinner.fail(e.message)
       this.error(flags.verbose ? e : e.message)
@@ -176,7 +200,7 @@ class Pack extends BaseCommand {
     }
 
     await writeFile(
-      path.join(DEFAULTS.ARTIFACTS_FOLDER, DEFAULTS.DEPLOY_YAML_FILE),
+      path.join(DEFAULTS.ARTIFACTS_FOLDER_PATH, DEFAULTS.DEPLOY_YAML_FILE_NAME),
       yaml.dump(deployJson),
       { overwrite: true })
   }
@@ -239,17 +263,38 @@ class Pack extends BaseCommand {
    *
    * This runs `npm pack` to get the list.
    *
-   * @param {Array<string>} filesToExclude a list of files to exclude
-   * @param {string} workingDirectory the working directory to run `npm pack` in
+   * @param {object} options the options for the method
+   * @param {Array<string>} options.filesToExclude a list of files to exclude
+   * @param {string} options.workingDirectory the working directory to run `npm pack` in
    * @returns {Array<string>} a list of files that are to be packed
    */
-  async filesToPack (filesToExclude = [], workingDirectory = process.cwd()) {
+  async filesToPack ({ filesToExclude = [], workingDirectory = process.cwd() } = {}) {
     const { stdout } = await execa('npm', ['pack', '--dry-run', '--json'], { cwd: workingDirectory })
 
+    const noJunkFiles = (file) => {
+      const isJunkFile = junk.is(file)
+      if (isJunkFile) {
+        aioLogger.debug(`junk file (omitted from pack): ${file}`)
+      }
+
+      return !isJunkFile
+    }
+
+    const noDotFiles = (file) => {
+      const isDotFile = /^\..*/.test(file)
+      if (isDotFile) {
+        aioLogger.debug(`hidden dotfile (omitted from pack): ${file}`)
+      }
+
+      return !isDotFile
+    }
+
     const { files } = JSON.parse(stdout)[0]
     return files
       .map(file => file.path)
       .filter(file => !filesToExclude.includes(file))
+      .filter(noJunkFiles) // no junk files like .DS_Store
+      .filter(noDotFiles) // no files that start with a '.'
   }
 
   /**
@@ -291,7 +336,7 @@ class Pack extends BaseCommand {
 
     // rewrite config files
     for (const [file, keys] of Object.entries(fileToAnnotationKey)) {
-      const configFilePath = path.join(DEFAULTS.ARTIFACTS_FOLDER, file)
+      const configFilePath = path.join(DEFAULTS.ARTIFACTS_FOLDER_PATH, file)
       const { values } = loadConfigFile(configFilePath)
 
       keys.forEach(key => {
@@ -321,7 +366,7 @@ Pack.flags = {
   output: Flags.string({
     description: 'The packaged app output file path',
     char: 'o',
-    default: DEFAULTS.OUTPUT_ZIP_FILE
+    default: DEFAULTS.OUTPUT_ZIP_FILE_PATH
   })
 }
 

package/src/commands/app/undeploy.js

@@ -78,13 +78,10 @@ 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 })
-        }
+      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)
@@ -178,12 +175,6 @@ Undeploy.flags = {
     description: 'Force unpublish extension(s) from Exchange, will delete all extension points',
     default: false,
     exclusive: ['unpublish'] // unpublish is excluded
-  }),
-  'feature-event-hooks': Flags.boolean({
-    description: '[default: false] Enable event hooks feature',
-    default: false,
-    allowNo: true,
-    hidden: true
   })
 }
 

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

@@ -1,67 +0,0 @@
-/*
-Copyright 2020 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 REPRESENTATIONS
-OF ANY KIND, either express or implied. See the License for the specific language
-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, Args } = require('@oclif/core')
-const DeleteActionCommand = require('./action')
-const chalk = require('chalk')
-
-class DeleteEventCommand extends BaseCommand {
-  async run () {
-    const { args, flags } = await this.parse(DeleteEventCommand)
-
-    aioLogger.debug(`deleting events from the project, with args ${JSON.stringify(args)}, and flags: ${JSON.stringify(flags)}`)
-
-    // NOTE: this command only wraps app delete action, events will have more than actions later on
-    if (flags.yes && !args['event-action-name']) {
-      this.error('<event-action-name> must also be provided when using --yes')
-    }
-
-    if (!args['event-action-name']) {
-      this.log(chalk.bold(chalk.blue('NOTE: this is running the \'app delete action\' command, please select events actions.')))
-      this.log()
-    }
-
-    const cmdLineArgs = []
-    if (args['event-action-name']) {
-      cmdLineArgs.push(args['event-action-name'])
-    }
-    if (flags.yes) {
-      cmdLineArgs.push('--yes')
-    }
-    await DeleteActionCommand.run(cmdLineArgs)
-  }
-}
-
-DeleteEventCommand.description = `Delete existing Adobe I/O Events actions
-`
-
-DeleteEventCommand.flags = {
-  yes: Flags.boolean({
-    description: 'Skip questions, and use all default values',
-    char: 'y',
-    default: false
-  }),
-  ...BaseCommand.flags
-}
-
-DeleteEventCommand.args =
-  {
-    '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']
-
-module.exports = DeleteEventCommand