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

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
-}

package/src/lib/run-local-runtime.js

@@ -1,154 +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 fs = require('fs-extra')
-const cloneDeep = require('lodash.clonedeep')
-const utils = require('./app-helper')
-const dedent = require('dedent-js')
-const rtLib = require('@adobe/aio-lib-runtime')
-const rtLibUtils = rtLib.utils
-const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:run-dev-local', { provider: 'debug' })
-
-const {
-  OW_CONFIG_RUNTIMES_FILE,
-  OW_JAR_URL, OW_JAR_PATH,
-  OW_LOCAL_APIHOST,
-  OW_LOCAL_NAMESPACE,
-  OW_LOCAL_AUTH,
-  OW_LOCAL_LOG_FILE
-} = require('../lib/owlocal')
-
-const OW_WAIT_INIT_TIME = 2000
-const OW_WAIT_PERIOD_TIME = 500
-const OW_TIMEOUT = 60000
-
-const LOCAL_RUNTIME = {
-  namespace: OW_LOCAL_NAMESPACE,
-  auth: OW_LOCAL_AUTH,
-  apihost: OW_LOCAL_APIHOST
-}
-
-/**
- * @typedef {object} RunDevLocalObject
- * @property {string} config the modified dev config
- * @property {Function} cleanup callback function to cleanup available resources
- */
-
-/**
- * @typedef {object} RuntimeCredentials
- * @property {string} namespace the runtime namespace
- * @property {string} auth the runtime auth key
- * @property {string} apihost the runtime apihost
- */
-
-/**
- * Checks the system for pre-requisites to run local Openwhisk, then runs it.
- *
- * @param {object} config the app config
- * @param {object} dataDir global config folder to store the ow jar
- * @param {Function} [log] function to log application logs
- * @param {boolean} [verbose=false] set to true to have verbose logging (openwhisk)
- * @returns {RunDevLocalObject} the RunDevLocalObject
- */
-async function runDevLocal (config, dataDir, log = () => undefined, verbose = false) {
-  const owJarFile = path.join(dataDir, OW_JAR_PATH)
-  const devConfig = loadLocalDevConfig(config)
-
-  // take following steps only when we have a backend
-  log('checking if java is installed...')
-  if (!await utils.hasJavaCLI()) {
-    throw new Error('could not find java CLI, please make sure java is installed')
-  }
-
-  log('checking if docker is installed...')
-  if (!await utils.hasDockerCLI()) {
-    throw new Error('could not find docker CLI, please make sure docker is installed')
-  }
-
-  log('checking if docker is running...')
-  if (!await utils.isDockerRunning()) {
-    throw new Error('docker is not running, please make sure to start docker')
-  }
-
-  if (!fs.existsSync(owJarFile)) {
-    log(`downloading OpenWhisk standalone jar from ${OW_JAR_URL} to ${owJarFile}, this might take a while... (to be done only once!)`)
-    await utils.downloadOWJar(OW_JAR_URL, owJarFile)
-  }
-
-  log('starting local OpenWhisk stack...')
-  const owLocalLogFile = OW_LOCAL_LOG_FILE || path.join(config.app.dist, 'openwhisk-local.log.txt')
-  const owExecaOptions = {
-    stdio: [
-      null, // stdin
-      verbose ? fs.openSync(owLocalLogFile, 'w') : null, // stdout
-      'inherit' // stderr
-    ]
-  }
-  const res = await utils.runOpenWhiskJar(owJarFile, OW_CONFIG_RUNTIMES_FILE, OW_LOCAL_APIHOST, OW_WAIT_INIT_TIME, OW_WAIT_PERIOD_TIME, OW_TIMEOUT, owExecaOptions)
-
-  log(`writing credentials to tmp wskdebug config '${devConfig.envFile}'`)
-  await writeLocalEnvFile(devConfig, LOCAL_RUNTIME)
-
-  const cleanup = () => {
-    aioLogger.debug('stopping local OpenWhisk stack...')
-    res.proc.kill()
-
-    aioLogger.debug('removing wskdebug tmp .env file...')
-    if (fs.existsSync(devConfig.envFile)) {
-      fs.unlinkSync(devConfig.envFile)
-    }
-  }
-
-  return {
-    config: devConfig,
-    cleanup
-  }
-}
-
-/**
- * @param {object} config the app config
- * @param {Function} [log] function to log application logs
- * @returns {RunDevLocalObject} the RunDevLocalObject
- */
-function loadLocalDevConfig (config, log) {
-  const devConfig = cloneDeep(config)
-  devConfig.envFile = path.join(config.app.dist, '.env.local')
-  log && log('setting local openwhisk credentials...')
-  devConfig.ow = { ...devConfig.ow, ...LOCAL_RUNTIME }
-  return devConfig
-}
-
-/**
- * Writes the local debugging .env file
- *
- * @param {object} appConfig the app config
- * @param {RuntimeCredentials} runtimeCredentials the runtime credentials
- */
-async function writeLocalEnvFile (appConfig, runtimeCredentials) {
-  const { root, envFile } = appConfig
-  const { dist } = appConfig.app
-  const { namespace, auth, apihost } = runtimeCredentials
-
-  fs.ensureDirSync(dist)
-  const envFilePath = rtLibUtils._absApp(root, envFile)
-
-  await fs.outputFile(envFilePath, dedent(`
-  # This file is auto-generated, do not edit.
-  # The items below are temporary credentials for local debugging
-  OW_NAMESPACE=${namespace}
-  OW_AUTH=${auth}
-  OW_APIHOST=${apihost}
-  `))
-}
-
-module.exports = { runLocalRuntime: runDevLocal, loadLocalDevConfig }

package/src/lib/vscode.js

@@ -1,85 +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 aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:vscode', { provider: 'debug' })
-const rtLibUtils = require('@adobe/aio-lib-runtime').utils
-const fs = require('fs-extra')
-const path = require('path')
-const yeoman = require('yeoman-environment')
-const generators = require('@adobe/generator-aio-app')
-
-const LAUNCH_JSON_FILE = '.vscode/launch.json'
-const LAUNCH_JSON_FILE_BACKUP = '.vscode/launch.json.save'
-
-/** @private */
-function files (config) {
-  return () => ({
-    backupFile: rtLibUtils._absApp(config.root, LAUNCH_JSON_FILE_BACKUP),
-    mainFile: rtLibUtils._absApp(config.root, LAUNCH_JSON_FILE)
-  })
-}
-
-/** @private */
-function update (config) {
-  const _files = files(config)
-  return async (props) => {
-    const { backupFile, mainFile } = _files()
-
-    fs.ensureDirSync(path.dirname(mainFile))
-    if (fs.existsSync(mainFile)) {
-      if (!fs.existsSync(backupFile)) {
-        fs.moveSync(mainFile, backupFile)
-      }
-    }
-
-    const env = yeoman.createEnv()
-    // by default yeoman runs the install, we control installation from the app plugin
-    env.options = { skipInstall: true }
-    const gen = env.instantiate(generators['add-vscode-config'], {
-      options: {
-        'app-config': config,
-        'env-file': config.envFile,
-        'frontend-url': props.frontEndUrl,
-        'skip-prompt': true
-      }
-    })
-    await env.runGenerator(gen)
-  }
-}
-
-/** @private */
-function cleanup (config) {
-  const _files = files(config)
-  return () => {
-    const { backupFile, mainFile } = _files()
-
-    if (fs.existsSync(mainFile) && !fs.existsSync(backupFile)) {
-      aioLogger.debug(`removing ${mainFile}...`)
-      const vscodeDir = path.dirname(mainFile)
-      fs.unlinkSync(mainFile)
-      if (fs.readdirSync(vscodeDir).length === 0) {
-        fs.rmdirSync(vscodeDir)
-      }
-    }
-
-    if (fs.existsSync(backupFile)) {
-      aioLogger.debug(`restoring previous ${mainFile}`)
-      fs.moveSync(backupFile, mainFile, { overwrite: true })
-    }
-  }
-}
-
-module.exports = (config) => ({
-  files: files(config),
-  update: update(config),
-  cleanup: cleanup(config)
-})