@adobe/helix-cli/src/deploy.cmd.js

/*
 * Copyright 2018 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.
 */

'use strict';

const { fetch } = require('@adobe/helix-fetch');
const chalk = require('chalk');
const ow = require('openwhisk');
const glob = require('glob');
const path = require('path');
const fs = require('fs-extra');
const { v4: uuidv4 } = require('uuid');
const ProgressBar = require('progress');
const { HelixConfig, GitUrl } = require('@adobe/helix-shared');
const GitUtils = require('./git-utils');
const useragent = require('./user-agent-util');
const AbstractCommand = require('./abstract.cmd.js');
const PackageCommand = require('./package.cmd.js');
const ConfigUtils = require('./config/config-utils.js');

function humanFileSize(size) {
  const i = size === 0 ? 0 : Math.floor(Math.log(size) / Math.log(1024));
  const p2 = 1024 ** i;
  return `${(size / p2).toFixed(2)} ${['B', 'KiB', 'MiB', 'GiB', 'TiB'][i]}`;
}

class DeployCommand extends AbstractCommand {
  constructor(logger) {
    super(logger);
    this._enableAuto = true;
    this._circleciAuth = null;
    this._wsk_auth = null;
    this._wsk_namespace = null;
    this._wsk_host = null;
    this._fastly_namespace = null;
    this._fastly_auth = null;
    this._target = null;
    this._files = null;
    this._prefix = null;
    this._modulePaths = [];
    this._requiredModules = null;
    this._default = { };
    this._defaultFile = () => ({});
    this._enableDirty = false;
    this._dryRun = false;
    this._createPackages = 'auto';
    this._addStrain = null;
    this._enableMinify = false;
    this._resolveGitRefSvc = 'helix-services/resolve-git-ref@v1';
    this._customPipeline = null;
    this._epsagonAppName = null;
    this._epsagonToken = null;
    this._coralogixAppName = null;
    this._coralogixToken = null;
    this._updated = null;
    this._updatedBy = null;
  }

  get requireConfigFile() {
    return this._addStrain === null;
  }

  withEnableAuto(value) {
    this._enableAuto = value;
    return this;
  }

  withCircleciAuth(value) {
    this._circleciAuth = value;
    return this;
  }

  withFastlyAuth(value) {
    this._fastly_auth = value;
    return this;
  }

  withFastlyNamespace(value) {
    this._fastly_namespace = value;
    return this;
  }

  withWskHost(value) {
    this._wsk_host = value;
    return this;
  }

  withWskAuth(value) {
    this._wsk_auth = value;
    return this;
  }

  withWskNamespace(value) {
    this._wsk_namespace = value;
    return this;
  }

  withWskActionMemory(value) {
    this._wsk_action_memory = value;
    return this;
  }

  withWskActionConcurrency(value) {
    this._wsk_action_concurrency = value;
    return this;
  }

  withTarget(value) {
    this._target = value;
    return this;
  }

  withFiles(value) {
    this._files = value;
    return this;
  }

  withModulePaths(value) {
    this._modulePaths = value;
    return this;
  }

  withRequiredModules(mods) {
    this._requiredModules = mods;
    return this;
  }

  withDefault(value) {
    this._default = value;
    return this;
  }

  withDefaultFile(value) {
    this._defaultFile = value;
    return this;
  }

  withEnableDirty(value) {
    this._enableDirty = value;
    return this;
  }

  withDryRun(value) {
    this._dryRun = value;
    return this;
  }

  withCreatePackages(value) {
    this._createPackages = value;
    return this;
  }

  withAddStrain(value) {
    this._addStrain = value === undefined ? null : value;
    return this;
  }

  withMinify(value) {
    this._enableMinify = value;
    return this;
  }

  withResolveGitRefService(value) {
    this._resolveGitRefSvc = value;
    return this;
  }

  withCustomPipeline(customPipeline) {
    this._customPipeline = customPipeline;
    return this;
  }

  withEpsagonAppName(value) {
    this._epsagonAppName = value;
    return this;
  }

  withEpsagonToken(value) {
    this._epsagonToken = value;
    return this;
  }

  withCoralogixAppName(value) {
    this._coralogixAppName = value;
    return this;
  }

  withCoralogixToken(value) {
    this._coralogixToken = value;
    return this;
  }

  withUpdatedAt(value) {
    this._updated = value;
    return this;
  }

  withUpdatedBy(value) {
    this._updatedBy = value;
    return this;
  }

  actionName(script) {
    if (script.main.indexOf(path.resolve(__dirname, 'openwhisk')) === 0) {
      return `hlx--${script.name}`;
    }
    if (script.main.match(/cgi-bin/)) {
      return `${this._prefix}/cgi-bin-${script.name}`;
    }
    return `${this._prefix}/${script.name}`;
  }

  async init() {
    await super.init();
    this._target = path.resolve(this.directory, this._target);
    // init dev default file params
    this._default = Object.assign(this._defaultFile(this.directory), this._default);
    // read the package json if present
    try {
      this._pkgJson = await fs.readJson(path.resolve(this.directory, 'package.json'));
    } catch (e) {
      this._pkgJson = {};
    }
    this._updated = this._updated || new Date().getTime();
  }

  static getBuildVarOptions(name, value, auth, owner, repo) {
    const body = JSON.stringify({
      name,
      value,
    });
    const options = {
      method: 'POST',
      auth,
      uri: `https://circleci.com/api/v1.1/project/github/${owner}/${repo}/envvar`,
      headers: {
        'Content-Type': 'application/json',
        Accept: 'application/json',
        'User-Agent': useragent,
      },
      body,
    };
    return options;
  }

  static setBuildVar(name, value, owner, repo, auth) {
    const options = DeployCommand.getBuildVarOptions(name, value, auth, owner, repo);
    return fetch(options.uri, options);
  }

  async autoDeploy() {
    if (!(fs.existsSync(path.resolve(process.cwd(), '.circleci', 'config.yaml')) || fs.existsSync(path.resolve(process.cwd(), '.circleci', 'config.yml')))) {
      throw new Error(`Cannot automate deployment without ${path.resolve(process.cwd(), '.circleci', 'config.yaml')}`);
    }

    const { owner, repo, ref } = await GitUtils.getOriginURL(this.directory);

    const auth = {
      username: this._circleciAuth,
      password: '',
    };

    const followoptions = {
      method: 'POST',
      json: true,
      auth,
      headers: {
        'Content-Type': 'application/json',
        Accept: 'application/json',
        'User-Agent': useragent,
      },
      uri: `https://circleci.com/api/v1.1/project/github/${owner}/${repo}/follow`,
    };

    this.log.info(`Automating deployment with ${followoptions.uri}`);

    let response = await fetch(followoptions.uri, followoptions);
    const follow = await response.json();

    const envars = [];

    if (this._fastly_namespace) {
      envars.push(DeployCommand.setBuildVar('HLX_FASTLY_NAMESPACE', this._fastly_namespace, owner, repo, auth));
    }
    if (this._fastly_auth) {
      envars.push(DeployCommand.setBuildVar('HLX_FASTLY_AUTH', this._fastly_auth, owner, repo, auth));
    }

    if (this._wsk_auth) {
      envars.push(DeployCommand.setBuildVar('HLX_WSK_AUTH', this._wsk_auth, owner, repo, auth));
    }

    if (this._wsk_host) {
      envars.push(DeployCommand.setBuildVar('HLX_WSK_HOST', this._wsk_host, owner, repo, auth));
    }
    if (this._wsk_namespace) {
      envars.push(DeployCommand.setBuildVar('HLX_WSK_NAMESPACE', this._wsk_namespace, owner, repo, auth));
    }

    if (this._epsagonAppName) {
      envars.push(DeployCommand.setBuildVar('HLX_EPSAGON_APP_NAME', this._epsagonAppName, owner, repo, auth));
    }
    if (this._epsagonToken) {
      envars.push(DeployCommand.setBuildVar('HLX_EPSAGON_TOKEN', this._epsagonToken, owner, repo, auth));
    }
    if (this._coralogixAppName) {
      envars.push(DeployCommand.setBuildVar('HLX_CORALOGIX_APP_NAME', this._coralogixAppName, owner, repo, auth));
    }
    if (this._coralogixToken) {
      envars.push(DeployCommand.setBuildVar('HLX_CORALOGIX_TOKEN', this._coralogixToken, owner, repo, auth));
    }

    await Promise.all(envars);

    if (follow.first_build) {
      this.log.info('\nAuto-deployment started.');
      this.log.info('Configuration finished. Go to');
      this.log.info(`${chalk.grey(`https://circleci.com/gh/${owner}/${repo}/edit`)} for build settings or`);
      this.log.info(`${chalk.grey(`https://circleci.com/gh/${owner}/${repo}`)} for build status.`);
    } else {
      this.log.warn('\nAuto-deployment already set up. Triggering a new build.');

      const triggeroptions = {
        method: 'POST',
        json: true,
        auth,
        headers: {
          'Content-Type': 'application/json',
          Accept: 'application/json',
          'User-Agent': useragent,
        },
        uri: `https://circleci.com/api/v1.1/project/github/${owner}/${repo}/tree/${ref}`,
      };

      response = await fetch(triggeroptions.uri, triggeroptions);
      const triggered = await response.json();

      this.log.info(`Go to ${chalk.grey(`${triggered.build_url}`)} for build status.`);
    }
  }

  async run() {
    await this.init();
    const origin = await GitUtils.getOrigin(this.directory);
    if (!origin) {
      throw Error('hlx cannot deploy without a remote git repository. Add one with\n$ git remote add origin <github_repo_url>.git');
    }
    const dirty = await GitUtils.isDirty(this.directory);
    if (dirty && !this._enableDirty) {
      throw Error('hlx will not deploy a working copy that has uncommitted changes. Re-run with flag --dirty to force.');
    }
    if (this._enableAuto) {
      return this.autoDeploy();
    }

    // get git coordinates and list affected strains
    const ref = await GitUtils.getBranch(this.directory);
    const giturl = new GitUrl(`${origin}#${ref}`);
    const affected = this.config.strains.filterByCode(giturl);
    if (affected.length === 0) {
      let newStrain = this._addStrain ? this.config.strains.get(this._addStrain) : null;
      if (!newStrain) {
        newStrain = this.config.strains.get('default');
        // if default is proxy, fall back to default default
        if (newStrain.isProxy()) {
          const hlx = await new HelixConfig()
            .withSource(await ConfigUtils.createDefaultConfig(this.directory))
            .init();
          newStrain = hlx.strains.get('default');
        }
        newStrain = newStrain.clone();
        newStrain.name = this._addStrain || uuidv4();
        this.config.strains.add(newStrain);
      }

      newStrain.code = giturl;
      // also tweak content and static url, if default is still local
      if (newStrain.content.isLocal) {
        newStrain.content = giturl;
      }
      if (newStrain.static.url.isLocal) {
        newStrain.static.url = giturl;
      }
      if (this._addStrain === null) {
        this.log.error(chalk`Remote repository {cyan ${giturl}} does not affect any strains.
      
Add a strain definition to your config file:
{grey ${newStrain.toYAML()}}

Alternatively you can auto-add one using the {grey --add <name>} option.`);
        throw Error();
      }

      affected.push(newStrain);
      this.config.modified = true;
      this.log.info(chalk`Updated strain {cyan ${newStrain.name}} in helix-config.yaml`);
    }

    if (dirty) {
      this._prefix = `${giturl.host.replace(/[\W]/g, '-')}--${giturl.owner.replace(/[\W]/g, '-')}--${giturl.repo.replace(/[\W]/g, '-')}--${giturl.ref.replace(/[\W]/g, '-')}-dirty`;
    } else {
      this._prefix = await GitUtils.getCurrentRevision(this.directory);
    }

    const owoptions = {
      apihost: this._wsk_host,
      api_key: this._wsk_auth,
      namespace: this._wsk_namespace,
    };
    const openwhisk = ow(owoptions);

    if (this._createPackages !== 'ignore') {
      const pgkCommand = new PackageCommand(this.log)
        .withTarget(this._target)
        .withFiles(this._files)
        .withModulePaths(this._modulePaths)
        .withRequiredModules(this._requiredModules)
        .withDirectory(this.directory)
        .withOnlyModified(this._createPackages === 'auto')
        .withCustomPipeline(this._customPipeline)
        .withMinify(this._enableMinify);
      await pgkCommand.run();
    }

    // get the list of scripts from the info files
    const infos = [...glob.sync(`${this._target}/**/*.info.json`)];
    const scriptInfos = await Promise.all(infos.map((info) => fs.readJSON(info)));
    const scripts = scriptInfos
      .filter((script) => script.zipFile)
      // generate action names
      .map((script) => {
        // eslint-disable-next-line no-param-reassign
        script.actionName = this.actionName(script);
        return script;
      });

    const bar = new ProgressBar('[:bar] :action :etas', {
      total: (scripts.length * 2) // two ticks for each script
       + 1 // one tick for creating the package
       + 2, // two ticks for binding static
      width: 50,
      renderThrottle: 1,
      stream: process.stdout,
    });

    const tick = (message, name) => {
      bar.tick({
        action: name ? `deploying ${name}` : '',
      });
      if (message) {
        this.log.infoFields(message, {
          progress: true,
        });
      }
    };

    const params = Object.entries({
      EPSAGON_TOKEN: this._epsagonToken,
      CORALOGIX_API_KEY: this._coralogixToken,
      CORALOGIX_APPLICATION_NAME: this._coralogixAppName,
      RESOLVE_GITREF_SERVICE: this._resolveGitRefSvc,
      EPSAGON_APPLICATION_NAME: this._epsagonAppName,
      ...this._default,
    }).reduce((obj, [key, value]) => {
      // remove all falsy values
      if (value) {
        // eslint-disable-next-line no-param-reassign
        obj[key] = value;
      }
      return obj;
    }, {});

    // read files ...
    const read = scripts
      .filter((script) => script.zipFile) // skip empty zip files
      .map((script) => fs.readFile(script.zipFile)
        .then((action) => ({ script, action })));

    // create openwhisk package
    if (!this._dryRun) {
      const parameters = Object.keys(params).map((key) => {
        const value = params[key];
        return { key, value };
      });
      const annotations = [
        {
          key: 'hlx-code-origin',
          value: giturl.toString(),
        },
        {
          key: 'updated',
          value: this._updated,
        },
        {
          key: 'pkgVersion',
          value: this._pkgJson.version || 'n/a',
        },
        {
          key: 'pkgName',
          value: this._pkgJson.name || 'n/a',
        },
      ];
      if (this._updatedBy) {
        annotations.push({ key: 'updatedBy', value: this._updatedBy });
      }
      await openwhisk.packages.update({
        name: this._prefix,
        package: {
          publish: true,
          parameters,
          annotations,
        },
      });
      tick(`created package ${this._prefix}`, '');
    }

    let bindHelixServices;
    // bind helix-services
    if (!this._dryRun) {
      bindHelixServices = openwhisk.packages.update({
        package: {
          binding: {
            namespace: 'helix', // namespace to bind from
            name: 'helix-services', // package to bind from
          },
        },
        name: 'helix-services', // name of the new package
      }).then(() => {
        tick('bound helix-services', '');
      });
    }

    // ... and deploy
    const deployed = read.map((p) => p.then(({ script, action }) => {
      const actionoptions = {
        name: script.actionName,
        'User-Agent': useragent,
        action,
        kind: 'nodejs:10',
        annotations: {
          'web-export': true,
          pkgVersion: this._pkgJson.version || 'n/a',
          pkgName: this._pkgJson.name || 'n/a',
          dependencies: script.dependencies.map((dep) => dep.id).join(','),
          git: giturl.toString(),
          updated: this._updated,
        },
      };
      if (this._updatedBy) {
        actionoptions.annotations.updatedBy = this._updatedBy;
      }
      if (this._wsk_action_memory || this._wsk_action_concurrency) {
        const limits = actionoptions.limits || {};
        if (this._wsk_action_memory) {
          limits.memory = this._wsk_action_memory;
        }
        if (this._wsk_action_concurrency) {
          limits.concurrency = this._wsk_action_concurrency;
        }
        actionoptions.limits = limits;
      }

      const baseName = path.basename(script.main);
      tick(`deploying ${baseName}`, baseName);

      if (this._dryRun) {
        tick(` deployed ${baseName} (skipped)`);
        return true;
      }

      return openwhisk.actions.update(actionoptions).then(() => {
        tick(` deployed ${baseName} (deployed)`);
        return true;
      }).catch((e) => {
        this.log.error(`❌  Unable to deploy the action ${script.name}:  ${e.message}`);
        // eslint-disable-next-line no-param-reassign
        script.error = true;
        tick();
        return false;
      });
    }));

    await Promise.all([...deployed, bindHelixServices]);

    let numErrors = 0;
    bar.terminate();
    this.log.info(`✅  deployment of ${scripts.length} action${scripts.length !== 1 ? 's' : ''} completed:`);
    scripts.forEach((script) => {
      let status = '';
      if (script.error) {
        status = chalk.red(' (failed)');
        numErrors += 1;
      }
      this.log.info(`   - ${this._wsk_namespace}/${script.actionName} (${humanFileSize(script.archiveSize)})${status}`);
    });

    if (numErrors) {
      this.log.error(`${numErrors} occurred while deploying actions. ${chalk.grey(path.relative(this.directory, this.config.configPath))} not updated.`);
      throw Error();
    }
    // update package in affected strains
    this.log.info(`Affected strains of ${giturl}:`);
    const packageProperty = `${this._wsk_namespace}/${this._prefix}`;
    affected.forEach((strain) => {
      this.log.info(`- ${strain.name}`);
      if (strain.package !== packageProperty) {
        this.config.modified = true;
        // eslint-disable-next-line no-param-reassign
        strain.package = packageProperty;
      }
    });

    if (!this._dryRun && this.config.modified) {
      await this.config.saveConfig();
      this.log.info(`Updated ${path.relative(this.directory, this.config.configPath)}`);
    }
    return this;
  }
}
module.exports = DeployCommand;