Show all action templates in categories (#305)

* first commit demo ready

* move console api interraction to console generator

* add tests - ready for review

* bump generator-aio-console

* bump generator-aio-app

* dont repeat config.project

* rename long vars

package.json

@@ -10,8 +10,8 @@
     "@adobe/aio-lib-ims": "^4.1.0",
     "@adobe/aio-lib-runtime": "^1.0.0-0",
     "@adobe/aio-lib-web": "^4.0.0",
-    "@adobe/generator-aio-app": "^1.7.0",
-    "@adobe/generator-aio-console": "^1.1.1",
+    "@adobe/generator-aio-app": "^1.9.0",
+    "@adobe/generator-aio-console": "^1.2.0",
     "@oclif/command": "^1.5.11",
     "@oclif/config": "^1.12.9",
     "@oclif/plugin-help": "^2.2.3",

src/commands/app/add/action.js

@@ -14,6 +14,7 @@ const yeoman = require('yeoman-environment')
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:add:action', { provider: 'debug' })
 const { flags } = require('@oclif/command')
 
+const { servicesToGeneratorInput } = require('../../../lib/app-helper')
 const config = require('@adobe/aio-lib-core-config')
 
 class AddActionCommand extends BaseCommand {
@@ -22,15 +23,20 @@ class AddActionCommand extends BaseCommand {
 
     aioLogger.debug(`adding component ${args.component} to the project, using flags: ${flags}`)
 
-    const services = (config.get('services') || config.get('project.workspace.details.services') || []).map(s => s.code).join(',')
+    const workspaceServices =
+      config.get('services') || // legacy
+      config.get('project.workspace.details.services') ||
+      []
+    const supportedOrgServices = config.get('project.org.details.services') || []
 
     const generator = '@adobe/generator-aio-app/generators/add-action'
     const env = yeoman.createEnv()
     env.register(require.resolve(generator), 'gen')
     const res = await env.run('gen', {
       'skip-install': flags['skip-install'],
       'skip-prompt': flags.yes,
-      'adobe-services': services
+      'adobe-services': servicesToGeneratorInput(workspaceServices),
+      'supported-adobe-services': servicesToGeneratorInput(supportedOrgServices)
     })
     return res
   }

src/commands/app/init.js

@@ -15,9 +15,10 @@ const path = require('path')
 const fs = require('fs-extra')
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:init', { provider: 'debug' })
 const { flags } = require('@oclif/command')
-const { loadAndValidateConfigFile, importConfigJson, writeAio } = require('../../lib/import')
+const { loadAndValidateConfigFile, importConfigJson } = require('../../lib/import')
 const { getCliInfo } = require('../../lib/app-helper')
 const chalk = require('chalk')
+const { servicesToGeneratorInput } = require('../../lib/app-helper')
 
 const SERVICE_API_KEY_ENV = 'SERVICE_API_KEY'
 
@@ -42,8 +43,10 @@ class InitCommand extends BaseCommand {
 
     // default project name and services
     let projectName = path.basename(process.cwd())
-    // list of supported service templates
-    let services = 'AdobeTargetSDK,AdobeAnalyticsSDK,CampaignSDK,McDataServicesSdk,AudienceManagerCustomerSDK,AssetComputeSDK'
+    // list of services added to the workspace
+    let workspaceServices = []
+    // list of services supported by the organization
+    let supportedServices = []
 
     // client id of the console's workspace jwt credentials
     let serviceClientId = ''
@@ -74,9 +77,11 @@ class InitCommand extends BaseCommand {
     if (flags.import) {
       const { values: config } = loadAndValidateConfigFile(flags.import)
 
-      projectName = config.project.name
-      services = config.project.workspace.details.services.map(s => s.code).join(',') || ''
-      const jwtConfig = config.project.workspace.details.credentials && config.project.workspace.details.credentials.find(c => c.jwt)
+      const project = config.project
+      projectName = project.name
+      workspaceServices = project.workspace.details.services
+      supportedServices = project.org.details.services
+      const jwtConfig = project.workspace.details.credentials && project.workspace.details.credentials.find(c => c.jwt)
       serviceClientId = (jwtConfig && jwtConfig.jwt.client_id) || serviceClientId // defaults to ''
     }
 
@@ -88,7 +93,8 @@ class InitCommand extends BaseCommand {
       'skip-install': flags['skip-install'],
       'skip-prompt': flags.yes,
       'project-name': projectName,
-      'adobe-services': services
+      'adobe-services': servicesToGeneratorInput(workspaceServices),
+      'supported-adobe-services': servicesToGeneratorInput(supportedServices)
     })
 
     // config import
@@ -100,11 +106,6 @@ class InitCommand extends BaseCommand {
       if (deleteConsoleCredentials) {
         fs.unlinkSync(flags.import)
       }
-    } else {
-      // write default services value to .aio
-      await writeAio({
-        services: services.split(',').map(code => ({ code }))
-      }, process.cwd(), { merge, interactive })
     }
 
     // finalize configuration data

src/commands/app/use.js

@@ -77,7 +77,8 @@ class Use extends BaseCommand {
     }
 
     const { values: config } = loadAndValidateConfigFile(filePath)
-    const jwtConfig = config.project.workspace.details.credentials && config.project.workspace.details.credentials.find(c => c.jwt)
+    const project = config.project
+    const jwtConfig = project.workspace.details.credentials && project.workspace.details.credentials.find(c => c.jwt)
     const serviceClientId = (jwtConfig && jwtConfig.jwt.client_id) || ''
     const extraEnvVars = { [SERVICE_API_KEY_ENV]: serviceClientId }
 

src/lib/app-helper.js

@@ -341,6 +341,17 @@ function saveAndReplaceDotEnvCredentials (dotenvFile, saveFile, apihost, namespa
   fs.writeFileSync(dotenvFile, envContent)
 }
 
+/**
+ *
+ * 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'
+ */
+function servicesToGeneratorInput (services) {
+  return services.map(s => s.code).filter(s => s).join(',')
+}
+
 module.exports = {
   isNpmInstalled,
   isGitInstalled,
@@ -359,5 +370,6 @@ module.exports = {
   writeConfig,
   downloadOWJar,
   runOpenWhiskJar,
-  saveAndReplaceDotEnvCredentials
+  saveAndReplaceDotEnvCredentials,
+  servicesToGeneratorInput
 }

src/lib/import.js

@@ -298,7 +298,7 @@ function mergeJson (oldData, newData) {
  */
 function mergeData (oldData, newData, fileFormat) {
   aioLogger.debug(`mergeData - oldData: ${oldData}`)
-  aioLogger.debug(`mergeData - newData:${newData}`)
+  aioLogger.debug(`mergeData - newData: ${newData}`)
 
   if (fileFormat === FILE_FORMAT_ENV) {
     return mergeEnv(oldData, newData)
@@ -329,7 +329,7 @@ async function writeFile (destination, data, flags = {}) {
 
   if (interactive) {
     answer = await checkFileConflict(destination)
-    aioLogger.debug(`writeEnv - answer (interactive): ${JSON.stringify(answer)}`)
+    aioLogger.debug(`writeFile - answer (interactive): ${JSON.stringify(answer)}`)
   }
 
   if (answer.abort) {

test/commands/app/add/action.test.js

@@ -68,7 +68,8 @@ describe('good flags', () => {
     expect(mockRun).toHaveBeenCalledWith(genName, {
       'skip-prompt': true,
       'skip-install': false,
-      'adobe-services': ''
+      'adobe-services': '',
+      'supported-adobe-services': ''
     })
   })
 
@@ -81,7 +82,8 @@ describe('good flags', () => {
     expect(mockRun).toHaveBeenCalledWith(genName, {
       'skip-prompt': true,
       'skip-install': true,
-      'adobe-services': ''
+      'adobe-services': '',
+      'supported-adobe-services': ''
     })
   })
 
@@ -94,7 +96,8 @@ describe('good flags', () => {
     expect(mockRun).toHaveBeenCalledWith(genName, {
       'skip-prompt': false,
       'skip-install': true,
-      'adobe-services': ''
+      'adobe-services': '',
+      'supported-adobe-services': ''
     })
   })
   test('no flags', async () => {
@@ -106,12 +109,22 @@ describe('good flags', () => {
     expect(mockRun).toHaveBeenCalledWith(genName, {
       'skip-prompt': false,
       'skip-install': false,
-      'adobe-services': ''
+      'adobe-services': '',
+      'supported-adobe-services': ''
     })
   })
 
   test('pass services config codes to generator-aio-app', async () => {
-    config.get.mockReturnValue([{ code: 'CampaignSDK' }, { code: 'AdobeAnalyticsSDK' }])
+    config.get.mockImplementation(c => {
+      if (c === 'project.org.details.services') {
+        // supported services
+        return [{ code: 'CampaignSDK' }, { code: 'AdobeAnalyticsSDK' }, { code: 'AnotherOneSDK' }]
+      } else if (c === 'project.workspace.details.services') {
+        // added to workspace
+        return [{ code: 'CampaignSDK' }, { code: 'AdobeAnalyticsSDK' }]
+      }
+      return undefined
+    })
 
     await TheCommand.run([])
 
@@ -121,17 +134,21 @@ describe('good flags', () => {
     expect(mockRun).toHaveBeenCalledWith(genName, {
       'skip-prompt': false,
       'skip-install': false,
-      'adobe-services': 'CampaignSDK,AdobeAnalyticsSDK'
+      'adobe-services': 'CampaignSDK,AdobeAnalyticsSDK',
+      'supported-adobe-services': 'CampaignSDK,AdobeAnalyticsSDK,AnotherOneSDK'
     })
   })
 
-  test('pass services config codes from imported config to generator-aio-app', async () => {
-    config.get.mockImplementation((key) => {
-      if (key === 'services') {
-        return undefined
-      } else if (key === 'project.workspace.details.services') {
+  test('pass services config codes from legacy service config key to generator-aio-app', async () => {
+    config.get.mockImplementation(c => {
+      if (c === 'project.org.details.services') {
+        // supported services
+        return [{ code: 'CampaignSDK' }, { code: 'AdobeAnalyticsSDK' }, { code: 'AnotherOneSDK' }]
+      } else if (c === 'services') {
+        // added to workspace
         return [{ code: 'CampaignSDK' }, { code: 'AdobeAnalyticsSDK' }]
       }
+      return undefined
     })
 
     await TheCommand.run([])
@@ -142,7 +159,8 @@ describe('good flags', () => {
     expect(mockRun).toHaveBeenCalledWith(genName, {
       'skip-prompt': false,
       'skip-install': false,
-      'adobe-services': 'CampaignSDK,AdobeAnalyticsSDK'
+      'adobe-services': 'CampaignSDK,AdobeAnalyticsSDK',
+      'supported-adobe-services': 'CampaignSDK,AdobeAnalyticsSDK,AnotherOneSDK'
     })
   })
 })