@adobe/aio-cli-plugin-app 13.3.0 → 14.0.0

package/src/commands/app/deploy.js

@@ -185,8 +185,7 @@ class Deploy extends BuildCommand {
           if (!script) {
             const hookResults = await this.config.runHook('deploy-actions', {
               appConfig: config,
-              filterEntities: filterActions || [],
-              isLocalDev: false
+              filterEntities: filterActions || []
             })
             if (hookResults?.failures?.length > 0) {
               // output should be "Error : <plugin-name> : <error-message>\n" for each failure

package/src/commands/app/get-url.js

@@ -18,7 +18,6 @@ const BaseCommand = require('../../BaseCommand')
 const { wrapError } = require('../../lib/app-helper')
 const { getActionUrls } = require('@adobe/aio-lib-runtime').utils
 const yaml = require('js-yaml')
-const { loadLocalDevConfig } = require('../../lib/run-local-runtime')
 
 class GetUrlCommand extends BaseCommand {
   async run () {
@@ -46,16 +45,10 @@ class GetUrlCommand extends BaseCommand {
       }
 
       const actionUrls = {}
-      if (flags.local) {
-        Object.values(fullConfig.all).forEach(config => {
-          const localDevConfig = loadLocalDevConfig(config)
-          Object.assign(actionUrls, getActionUrls(localDevConfig, false, true))
-        })
-      } else {
-        Object.values(fullConfig.all).forEach(config => {
-          Object.assign(actionUrls, getActionUrls(config, true))
-        })
-      }
+
+      Object.values(fullConfig.all).forEach(config => {
+        Object.assign(actionUrls, getActionUrls(config, true))
+      })
       urls.runtime = actionUrls
       const cdnUrls = {}
       if (options.cdn) {
@@ -110,9 +103,6 @@ GetUrlCommand.flags = {
   yml: Flags.boolean({
     description: 'Output yml',
     char: 'y'
-  }),
-  local: Flags.boolean({
-    description: 'Display locally based action URLs'
   })
 }
 

package/src/commands/app/init.js

@@ -75,7 +75,7 @@ class InitCommand extends TemplatesCommand {
 
   getInitialGenerators (flags) {
     // TODO read from config to override
-    const initialGenerators = ['base-app', 'add-ci']
+    const initialGenerators = ['base-app', 'add-ci', 'add-vscode-config']
 
     if (flags['standalone-app']) {
       initialGenerators.push('application')

package/src/commands/app/run.js

@@ -16,7 +16,6 @@ const fs = require('fs-extra')
 const https = require('https')
 const getPort = require('get-port')
 const open = require('open')
-const os = require('node:os')
 
 const { Flags, ux } = require('@oclif/core')
 const coreConfig = require('@adobe/aio-lib-core-config')
@@ -36,16 +35,6 @@ class Run extends BaseCommand {
     // cli input
     const { flags } = await this.parse(Run)
 
-    if (flags.local) {
-      const [firstCpu] = os.cpus()
-      // note: the earliest versions of M1 macs return 'Apple processor' under model.
-      if (firstCpu?.model?.startsWith('Apple')) {
-        this.error('The --local flag is not supported on Apple Silicon Macs.')
-      } else {
-        this.warn('The --local flag is deprecated and will be removed in the next major release.')
-      }
-    }
-
     const spinner = ora()
 
     const runConfigs = await this.getAppExtConfigs(flags)
@@ -87,7 +76,6 @@ class Run extends BaseCommand {
         shouldContentHash: false
       },
       fetchLogs: true,
-      isLocal: flags.local,
       verbose: flags.verbose
     }
 
@@ -107,7 +95,7 @@ class Run extends BaseCommand {
       }
     }
 
-    const verboseOutput = flags.verbose || flags.local || headlessApp
+    const verboseOutput = flags.verbose || headlessApp
     // we should evaluate this, a lot of output just disappears in the spinner text and
     // using verbose dumps ALL of parcel's output, so this become unreadable
     // we need a middle ground. -jm
@@ -217,10 +205,6 @@ Run.args = {}
 
 Run.flags = {
   ...BaseCommand.flags,
-  local: Flags.boolean({
-    description: '[deprecated] Run/debug actions locally (requires Docker running, not available on Apple Silicon Macs)',
-    exclusive: ['no-actions']
-  }),
   serve: Flags.boolean({
     description: '[default: true] Start frontend server (experimental)',
     default: true,

package/src/lib/actions-watcher.js

@@ -24,7 +24,6 @@ const deployActions = require('./deploy-actions')
 /**
  * @typedef {object} WatcherOptions
  * @property {object} config the app config (see src/lib/config-loader.js)
- * @property {boolean} isLocal whether the deployment is local or not
  * @property {Function} log the app logger
  * @property {object} [watcher] the watcher itself
  */
@@ -61,10 +60,9 @@ module.exports = async (watcherOptions) => {
  * @param {Array<string>} filterActions add filters to deploy only specified OpenWhisk actions
  */
 async function buildAndDeploy (watcherOptions, filterActions) {
-  const { config, isLocal, log, inprocHook } = watcherOptions
+  const { config, log, inprocHook } = watcherOptions
   await buildActions(config, filterActions)
   const deployConfig = {
-    isLocalDev: isLocal,
     filterEntities: {
       actions: filterActions
     }

package/src/lib/app-helper.js

@@ -16,7 +16,6 @@ const which = require('which')
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:lib-app-helper', { provider: 'debug' })
 const { getToken, context } = require('@adobe/aio-lib-ims')
 const { CLI } = require('@adobe/aio-lib-ims/src/context')
-const { createFetch } = require('@adobe/aio-lib-core-networking')
 const chalk = require('chalk')
 const aioConfig = require('@adobe/aio-lib-core-config')
 const { AIO_CONFIG_WORKSPACE_SERVICES, AIO_CONFIG_ORG_SERVICES } = require('./defaults')
@@ -262,116 +261,6 @@ function writeConfig (file, config) {
   )
 }
 
-/** @private */
-async function isDockerRunning () {
-  // todo more checks
-  const args = ['info']
-  try {
-    await execa('docker', args)
-    return true
-  } catch (error) {
-    aioLogger.debug('Error spawning docker info: ' + error)
-  }
-  return false
-}
-
-/** @private */
-async function hasDockerCLI () {
-  // todo check min version
-  try {
-    const result = await execa('docker', ['-v'])
-    aioLogger.debug('docker version : ' + result.stdout)
-    return true
-  } catch (error) {
-    aioLogger.debug('Error spawning docker info: ' + error)
-  }
-  return false
-}
-
-/** @private */
-async function hasJavaCLI () {
-  // todo check min version
-  try {
-    const result = await execa('java', ['-version'])
-    // stderr is where the version is printed out for
-    aioLogger.debug('java version : ' + result.stderr)
-    return true
-  } catch (error) {
-    aioLogger.debug('Error spawning java info: ' + error)
-  }
-  return false
-}
-
-/** @private */
-async function downloadOWJar (url, outFile) {
-  aioLogger.debug(`downloadOWJar - url: ${url} outFile: ${outFile}`)
-  let response
-  try {
-    const fetch = createFetch()
-    response = await fetch(url)
-  } catch (e) {
-    aioLogger.debug(`connection error while downloading '${url}'`, e)
-    throw new Error(`connection error while downloading '${url}', are you online?`)
-  }
-  if (!response.ok) throw new Error(`unexpected response while downloading '${url}': ${response.statusText}`)
-  fs.ensureDirSync(path.dirname(outFile))
-  const fstream = fs.createWriteStream(outFile)
-
-  return new Promise((resolve, reject) => {
-    response.body.pipe(fstream)
-    response.body.on('error', (err) => {
-      reject(err)
-    })
-    fstream.on('finish', () => {
-      resolve()
-    })
-  })
-}
-
-/** @private */
-async function waitForOpenWhiskReadiness (host, endTime, period, timeout, lastStatus, waitFunc) {
-  if (Date.now() > endTime) {
-    throw new Error(`local openwhisk stack startup timed out after ${timeout}ms due to ${lastStatus}`)
-  }
-
-  let ok, status
-
-  try {
-    const fetch = createFetch()
-    const response = await fetch(host + '/api/v1')
-    ok = response.ok
-    status = response.statusText
-  } catch (e) {
-    ok = false
-    status = e.toString()
-  }
-
-  if (!ok) {
-    await waitFunc(period)
-    return waitForOpenWhiskReadiness(host, endTime, period, timeout, status, waitFunc)
-  }
-}
-
-/** @private */
-function waitFor (t) {
-  return new Promise(resolve => setTimeout(resolve, t))
-}
-
-/** @private */
-async function runOpenWhiskJar (jarFile, runtimeConfigFile, apihost, waitInitTime, waitPeriodTime, timeout, /* istanbul ignore next */ execaOptions = {}) {
-  aioLogger.debug(`runOpenWhiskJar - jarFile: ${jarFile} runtimeConfigFile ${runtimeConfigFile} apihost: ${apihost} waitInitTime: ${waitInitTime} waitPeriodTime: ${waitPeriodTime} timeout: ${timeout}`)
-  const jvmConfig = aioConfig.get('ow.jvm.args')
-  const jvmArgs = jvmConfig ? jvmConfig.split(' ') : []
-  const proc = execa('java', ['-jar', '-Dwhisk.concurrency-limit.max=10', ...jvmArgs, jarFile, '-m', runtimeConfigFile, '--no-ui', '--disable-color-logging'], execaOptions)
-
-  const endTime = Date.now() + timeout
-  await waitFor(waitInitTime)
-  await waitForOpenWhiskReadiness(apihost, endTime, waitPeriodTime, timeout, null, waitFor)
-
-  // must wrap in an object as execa return value is awaitable
-  return { proc }
-}
-
 /**
  *
  *Converts a service array to an input string that can be consumed by generator-aio-app
@@ -599,14 +488,8 @@ module.exports = {
   removeProtocolFromURL,
   urlJoin,
   checkFile,
-  hasDockerCLI,
-  hasJavaCLI,
-  isDockerRunning,
   writeConfig,
-  downloadOWJar,
-  runOpenWhiskJar,
   servicesToGeneratorInput,
-  waitForOpenWhiskReadiness,
   warnIfOverwriteServicesInProductionWorkspace,
   setOrgServicesConfig,
   setWorkspaceServicesConfig,

package/src/lib/audit-logger.js

@@ -8,7 +8,6 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-const fetch = require('node-fetch')
 const fs = require('fs')
 const path = require('path')
 const chalk = require('chalk')

package/src/lib/defaults.js

@@ -36,5 +36,8 @@ module.exports = {
   LEGACY_RUNTIME_MANIFEST: 'manifest.yml',
   INCLUDE_DIRECTIVE: '$include',
   APPLICATION_CONFIG_KEY: 'application',
-  EXTENSIONS_CONFIG_KEY: 'extensions'
+  EXTENSIONS_CONFIG_KEY: 'extensions',
+  // Adding tracking file constants
+  LAST_BUILT_ACTIONS_FILENAME: 'last-built-actions.json',
+  LAST_DEPLOYED_ACTIONS_FILENAME: 'last-deployed-actions.json'
 }

package/src/lib/run-dev.js

@@ -13,13 +13,11 @@ governing permissions and limitations under the License.
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:runDev', { provider: 'debug' })
 const rtLib = require('@adobe/aio-lib-runtime')
 const rtLibUtils = rtLib.utils
-const vscode = require('./vscode')
 const { bundle } = require('@adobe/aio-lib-web')
 const bundleServe = require('./bundle-serve')
 const { defaultHttpServerPort: SERVER_DEFAULT_PORT } = require('./defaults')
 const serve = require('./serve')
 const Cleanup = require('./cleanup')
-const { runLocalRuntime } = require('./run-local-runtime')
 
 const buildActions = require('./build-actions')
 const deployActions = require('./deploy-actions')
@@ -47,7 +45,6 @@ async function runDev (config, dataDir, options = {}, log = () => {}, inprocHook
   // control variables
   const hasFrontend = config.app.hasFrontend
   const withBackend = config.app.hasBackend && !skipActions
-  const isLocal = options.isLocal // applies only for backend
   const portToUse = parseInt(process.env.PORT) || SERVER_DEFAULT_PORT
 
   const uiPort = await getPort({ port: portToUse })
@@ -56,12 +53,11 @@ async function runDev (config, dataDir, options = {}, log = () => {}, inprocHook
   }
   aioLogger.debug(`hasFrontend ${hasFrontend}`)
   aioLogger.debug(`withBackend ${withBackend}`)
-  aioLogger.debug(`isLocal ${isLocal}`)
 
   let frontEndUrl
 
   // state
-  let devConfig = config // config will be different if local or remote
+  const devConfig = config // config will be different if local or remote
   devConfig.envFile = '.env'
 
   const cleanup = new Cleanup()
@@ -70,20 +66,14 @@ async function runDev (config, dataDir, options = {}, log = () => {}, inprocHook
   try {
     // Build Phase - actions
     if (withBackend) {
-      if (isLocal) {
-        const { config: localConfig, cleanup: localCleanup } = await runLocalRuntime(config, dataDir, log, options.verbose)
-        devConfig = localConfig
-        cleanup.add(() => localCleanup(), 'cleaning up runDevLocal')
-      } else {
-        // check credentials
-        rtLibUtils.checkOpenWhiskCredentials(devConfig)
-        log('using remote actions')
-      }
+      // check credentials
+      rtLibUtils.checkOpenWhiskCredentials(devConfig)
+      log('using remote actions')
 
       // build and deploy actions
       log('building actions..')
       await buildActions(devConfig, null, false /* force build */)
-      const { cleanup: watcherCleanup } = await actionsWatcher({ config: devConfig, isLocal, log, inprocHook })
+      const { cleanup: watcherCleanup } = await actionsWatcher({ config: devConfig, log, inprocHook })
       cleanup.add(() => watcherCleanup(), 'stopping action watcher...')
     }
 
@@ -95,7 +85,7 @@ async function runDev (config, dataDir, options = {}, log = () => {}, inprocHook
         // note the condition: we still write backend urls EVEN if skipActions is set
         // the urls will always point to remotely deployed actions if skipActions is set
         log('injecting backend urls into frontend config')
-        urls = rtLibUtils.getActionUrls(devConfig, true, isLocal && !skipActions, true)
+        urls = rtLibUtils.getActionUrls(devConfig, true, !skipActions, true)
       }
       utils.writeConfig(devConfig.web.injectedConfig, urls)
 
@@ -123,7 +113,6 @@ async function runDev (config, dataDir, options = {}, log = () => {}, inprocHook
     if (withBackend) {
       log('redeploying actions..')
       const deployConfig = {
-        isLocalDev: isLocal,
         filterEntities: {
           byBuiltActions: true
         }
@@ -166,12 +155,6 @@ async function runDev (config, dataDir, options = {}, log = () => {}, inprocHook
     // also there was a latent issue with projects that defined an action src as a folder with an index.js file.
     // it looks explicitly for package.json and fails if it does not find it.
     // regarless, we don't need it, and when we actually remove --local we can be rid of this.
-    if (isLocal) {
-      log('setting up vscode debug configuration files...')
-      const vscodeConfig = vscode(devConfig)
-      await vscodeConfig.update({ frontEndUrl })
-      cleanup.add(() => vscodeConfig.cleanup(), 'cleaning up vscode debug configuration files...')
-    }
 
     // automatically fetch logs if there are actions
     if (config.app.hasBackend && fetchLogs) {

package/bin/openwhisk-standalone-config/get-runtimes.js

@@ -1,55 +0,0 @@
-/*
-Copyright 2021 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 fetch = require('node-fetch')
-
-const DOCKER_ORG = 'adobeapiplatform'
-const DOCKER_REPOS = { // repo-name:kind
-  'adobe-action-nodejs-v10': 'nodejs:10',
-  'adobe-action-nodejs-v12': 'nodejs:12',
-  'adobe-action-nodejs-v14': 'nodejs:14',
-  'adobe-action-nodejs-v16': 'nodejs:16',
-  'adobe-action-nodejs-v18': 'nodejs:18',
-  'adobe-action-nodejs-v20': 'nodejs:20'
-}
-
-const DEFAULT_KIND = 'nodejs:18'
-
-/** @private */
-async function main () {
-  const nodejs = []
-
-  for (const [repoName, kind] of Object.entries(DOCKER_REPOS)) {
-    const data = await fetch(`https://registry.hub.docker.com/v2/repositories/${DOCKER_ORG}/${repoName}/tags`)
-    const json = await data.json()
-    const defaultKind = (kind === DEFAULT_KIND) ? true : undefined
-
-    nodejs.push({
-      kind,
-      default: defaultKind,
-      image: {
-        prefix: DOCKER_ORG,
-        name: repoName,
-        tag: json.results[0].name
-      }
-    })
-  }
-
-  const output = {
-    runtimes: {
-      nodejs
-    }
-  }
-  console.log(JSON.stringify(output, null, 2))
-}
-
-main()
-  .catch(console.error)

package/bin/openwhisk-standalone-config/runtimes.json

@@ -1,55 +0,0 @@
-{
-  "runtimes": {
-    "nodejs": [
-      {
-        "kind": "nodejs:10",
-        "image": {
-          "prefix": "adobeapiplatform",
-          "name": "adobe-action-nodejs-v10",
-          "tag": "3.0.39"
-        }
-      },
-      {
-        "kind": "nodejs:12",
-        "image": {
-          "prefix": "adobeapiplatform",
-          "name": "adobe-action-nodejs-v12",
-          "tag": "3.0.39"
-        }
-      },
-      {
-        "kind": "nodejs:14",
-        "image": {
-          "prefix": "adobeapiplatform",
-          "name": "adobe-action-nodejs-v14",
-          "tag": "3.0.39"
-        }
-      },
-      {
-        "kind": "nodejs:16",
-        "image": {
-          "prefix": "adobeapiplatform",
-          "name": "adobe-action-nodejs-v16",
-          "tag": "3.0.39"
-        }
-      },
-      {
-        "kind": "nodejs:18",
-        "default": true,
-        "image": {
-          "prefix": "adobeapiplatform",
-          "name": "adobe-action-nodejs-v18",
-          "tag": "3.0.39"
-        }
-      },
-      {
-        "kind": "nodejs:20",
-        "image": {
-          "prefix": "adobeapiplatform",
-          "name": "adobe-action-nodejs-v20",
-          "tag": "3.0.39"
-        }
-      }
-    ]
-  }
-}

package/src/lib/owlocal.js

@@ -1,86 +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 path = require('path')
-const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:owlocal', { provider: 'debug' })
-const execa = require('execa')
-const url = require('url')
-
-const OW_LOCAL_DOCKER_PORT = 3233
-
-/** @private */
-function isWindowsOrMac () {
-  return (
-    process.platform === 'win32' ||
-    process.platform === 'darwin'
-  )
-}
-
-/** @private */
-function owJarPath (owJarUrl) {
-  const { pathname } = new url.URL(owJarUrl)
-  const idx = pathname.indexOf('/openwhisk/')
-  let jarPath
-
-  if (idx === -1) {
-    jarPath = path.join('openwhisk', 'openwhisk-standalone.jar') // default path
-    aioLogger.warn(`Could not parse openwhisk jar path from ${owJarUrl}, using default ${jarPath}`)
-  } else {
-    jarPath = pathname
-      .substring(idx + 1) // skip initial forward slash
-      .split(path.posix.sep) // split on forward slashes
-      .join(path.sep) // join on os path separator (for Windows)
-    aioLogger.debug(`Parsed openwhisk jar path from ${owJarUrl}, using ${jarPath}`)
-  }
-
-  return jarPath
-}
-
-/** @private */
-function getDockerNetworkAddress () {
-  try {
-    // Docker for Windows and macOS do not allow routing to the containers via
-    // IP address, only port forwarding is allowed
-    if (!isWindowsOrMac()) {
-      const args = ['network', 'inspect', 'bridge']
-      const result = execa.sync('docker', args)
-      const json = JSON.parse(result.stdout)
-      return `http://${json[0].IPAM.Config[0].Gateway}:${OW_LOCAL_DOCKER_PORT}`
-    }
-  } catch (error) {
-    aioLogger.debug(`getDockerNetworkAddress ${error}`)
-  }
-
-  return `http://localhost:${OW_LOCAL_DOCKER_PORT}`
-}
-
-// gets these values if the keys are set in the environment, if not it will use the defaults set
-const {
-  OW_JAR_URL = 'https://github.com/adobe/aio-cli-plugin-app/releases/download/6.2.0/openwhisk-standalone.jar',
-  OW_CONFIG_RUNTIMES_FILE = path.resolve(__dirname, '../../bin/openwhisk-standalone-config/runtimes.json'),
-  OW_LOCAL_APIHOST = getDockerNetworkAddress(),
-  OW_LOCAL_NAMESPACE = 'guest',
-  OW_LOCAL_AUTH = '23bc46b1-71f6-4ed5-8c54-816aa4f8c502:123zO3xZCLrMN6v2BKK1dXYFpXlPkccOFqm12CdAsMgRU4VrNZ9lyGVCGuMDGIwP',
-  OW_LOCAL_LOG_FILE
-} = process.env
-
-module.exports = {
-  getDockerNetworkAddress,
-  OW_LOCAL_DOCKER_PORT,
-  OW_JAR_URL,
-  OW_JAR_PATH: owJarPath(OW_JAR_URL),
-  OW_CONFIG_RUNTIMES_FILE,
-  OW_LOCAL_APIHOST,
-  OW_LOCAL_NAMESPACE,
-  OW_LOCAL_AUTH,
-  OW_LOCAL_LOG_FILE
-}