App Builder experience for Configurable Logging

package.json

@@ -23,6 +23,7 @@
     "chalk": "^4.0.0",
     "chokidar": "^3.5.2",
     "cli-ux": "^5.4.5",
+    "crypto": "^1.0.1",
     "debug": "^4.1.1",
     "dedent-js": "^1.0.1",
     "dotenv": "^8.2.0",

src/commands/app/config/get/log-forwarding.js

@@ -0,0 +1,46 @@
+/*
+Copyright 2019 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 LogForwarding = require('../../../../lib/log-forwarding')
+
+class LogForwardingCommand extends BaseCommand {
+  async run () {
+    const lf = await LogForwarding.init(this.getFullConfig().aio)
+
+    const localConfig = lf.getLocalConfig()
+    const serverConfig = await lf.getServerConfig()
+
+    if (!localConfig.isEqual(serverConfig)) {
+      this.log('Local and server log forwarding configuration is different')
+      this.log("Run either 'aio app:deploy' to update the server, " +
+        "or 'aio app:config:set:log-forwarding' to set new local and server configuration")
+      this.log('Local configuration:')
+      this.printConfig(localConfig)
+      this.log('\nServer configuration:')
+    }
+    this.printConfig(serverConfig)
+  }
+
+  printConfig (config) {
+    if (config.isDefined()) {
+      this.log(`destination: ${config.getDestination()}`)
+      this.log('settings:', config.getSettings())
+    } else {
+      this.log('Not defined')
+    }
+  }
+}
+
+LogForwardingCommand.description = 'Get log forwarding destination configuration'
+LogForwardingCommand.aliases = ['app:config:get:log-forwarding', 'app:config:get:lf']
+
+module.exports = LogForwardingCommand

src/commands/app/config/index.js

@@ -0,0 +1,25 @@
+/*
+Copyright 2019 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 HHelp = require('@oclif/plugin-help').default
+const BaseCommand = require('../../../BaseCommand')
+
+class IndexCommand extends BaseCommand {
+  async run () {
+    const help = new HHelp(this.config)
+    help.showHelp(['app:config', '--help'])
+  }
+}
+
+IndexCommand.description = 'Manage app config'
+IndexCommand.aliases = ['app:config', 'app:config']
+
+module.exports = IndexCommand

src/commands/app/config/set/index.js

@@ -0,0 +1,25 @@
+/*
+Copyright 2019 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 HHelp = require('@oclif/plugin-help').default
+const BaseCommand = require('../../../../BaseCommand')
+
+class IndexCommand extends BaseCommand {
+  async run () {
+    const help = new HHelp(this.config)
+    help.showHelp(['app:config:set', '--help'])
+  }
+}
+
+IndexCommand.description = 'Set app config'
+IndexCommand.aliases = ['app:config:set', 'app:config:set']
+
+module.exports = IndexCommand

src/commands/app/config/set/log-forwarding.js

@@ -0,0 +1,44 @@
+/*
+Copyright 2019 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 LogForwarding = require('../../../../lib/log-forwarding')
+
+class LogForwardingCommand extends BaseCommand {
+  async run () {
+    const lf = await LogForwarding.init(this.getFullConfig().aio)
+
+    const destination = await this.promptDestination(lf.getSupportedDestinations())
+    const destinationSettingsConfig = lf.getSettingsConfig(destination)
+    const settings = await this.prompt(destinationSettingsConfig)
+    const lfConfig = new LogForwarding.LogForwardingConfig(destination, settings)
+
+    await lf.updateServerConfig(lfConfig)
+    this.log(`Log forwarding is set to '${destination}'`)
+    await lf.updateLocalConfig(lfConfig)
+    this.log('Log forwarding settings are saved to the local configuration')
+  }
+
+  async promptDestination (supportedDestinations) {
+    const responses = await this.prompt([{
+      name: 'type',
+      message: 'select log forwarding destination',
+      type: 'list',
+      choices: supportedDestinations
+    }])
+    return responses.type
+  }
+}
+
+LogForwardingCommand.description = 'Set log forwarding destination configuration'
+LogForwardingCommand.aliases = ['app:config:set:log-forwarding', 'app:config:set:lf']
+
+module.exports = LogForwardingCommand

src/commands/app/deploy.js

@@ -21,6 +21,7 @@ const webLib = require('@adobe/aio-lib-web')
 const { flags } = require('@oclif/command')
 const { createWebExportFilter, runScript, buildExtensionPointPayloadWoMetadata, buildExcShellViewExtensionMetadata } = require('../../lib/app-helper')
 const rtLib = require('@adobe/aio-lib-runtime')
+const LogForwarding = require('../../lib/log-forwarding')
 
 class Deploy extends BuildCommand {
   async run () {
@@ -55,7 +56,29 @@ class Deploy extends BuildCommand {
     const spinner = ora()
 
     try {
-      // 1. deploy actions and web assets for each extension
+      const aioConfig = this.getFullConfig().aio
+      // 1. update log forwarding configuration
+      if (flags['log-forwarding-update']) {
+        spinner.start('Updating log forwarding configuration')
+        try {
+          const lf = await LogForwarding.init(aioConfig)
+          if (lf.isLocalConfigChanged()) {
+            const lfConfig = lf.getLocalConfigWithSecrets()
+            if (lfConfig.isDefined()) {
+              await lf.updateServerConfig(lfConfig)
+              spinner.succeed(chalk.green(`Log forwarding is set to '${lfConfig.getDestination()}'`))
+            } else {
+              spinner.fail(chalk.green('Log forwarding is not updated: no configuration is provided'))
+            }
+          } else {
+            spinner.fail(chalk.green('Log forwarding is not updated: configuration not changed since last update'))
+          }
+        } catch (error) {
+          spinner.fail(chalk.red('Log forwarding is not updated.'))
+          throw error
+        }
+      }
+      // 2. deploy actions and web assets for each extension
       // Possible improvements:
       // - parallelize
       // - break into smaller pieces deploy, allowing to first deploy all actions then all web assets
@@ -64,9 +87,9 @@ class Deploy extends BuildCommand {
         const v = values[i]
         await this.deploySingleConfig(k, v, flags, spinner)
       }
-      // 2. deploy extension manifest
+
+      // 3. deploy extension manifest
       if (flags.publish) {
-        const aioConfig = this.getFullConfig().aio
         const payload = await this.publishExtensionPoints(libConsoleCLI, deployConfigs, aioConfig, flags['force-publish'])
         this.log(chalk.blue(chalk.bold(`New Extension Point(s) in Workspace '${aioConfig.project.workspace.name}': '${Object.keys(payload.endpoints)}'`)))
       } else {
@@ -302,6 +325,11 @@ Deploy.flags = {
   'web-optimize': flags.boolean({
     description: '[default: false] Enable optimization (minification) of web js/css/html',
     default: false
+  }),
+  'log-forwarding-update': flags.boolean({
+    description: '[default: true] Update log forwarding configuration on server',
+    default: true,
+    allowNo: true
   })
 }