zapier-platform-cli/src/oclif/commands/env/set.js

The CLI for managing integrations in Zapier Developer Platform.

const { Args, Flags } = require('@oclif/core');
const { cyan } = require('colors/safe');
const { omit } = require('lodash');

const BaseCommand = require('../../ZapierBaseCommand');
const { buildFlags } = require('../../buildFlags');
const { callAPI } = require('../../../utils/api');

const successMessage = (version) =>
  `Successfully wrote the following to the environment of version ${cyan(
    version,
  )}:`;

class SetEnvCommand extends BaseCommand {
  async perform() {
    const { version } = this.args;
    this.throwForInvalidVersion(version);
    // args should be [ '1.0.0', 'qer=123', 'qwer=123' ]
    const valuesToSet = this.argv.slice(1).filter((kv) => !kv.startsWith('-'));

    if (!valuesToSet.length) {
      this.error(
        'Must specify at least one key-value pair to set (like `SOME_KEY=1234`)',
      );
    }

    if (!valuesToSet.every((kv) => kv.includes('='))) {
      this.error('Every key-value pair must be in the format `SOME_KEY=1234`');
    }

    // if we get here, we should have well-formed input

    const payload = valuesToSet.reduce((result, kvPair) => {
      const [key, ...valueParts] = kvPair.split('=');
      const value = valueParts.join('='); // Guards against values with = characters
      result[key.toUpperCase()] = value;
      return result;
    }, {});

    const app = await this.getWritableApp();
    if (!app.all_versions.includes(version)) {
      this.error(
        `Version ${version} doesn't exist on integration "${app.title}"`,
      );
    }

    const url = `/apps/${app.id}/versions/${version}/multi-environment`;
    const requestOptions = {
      body: payload,
      method: 'POST',
    };

    if (this.flags.force) {
      requestOptions.extraHeaders = {
        'X-Force-Env-Var-Update': 'true',
      };
    }

    try {
      await callAPI(url, requestOptions, true);

      this.log(successMessage(version));
      this.logJSON(payload);
    } catch (e) {
      if (e.status === 409) {
        this.error(
          `App version ${version} is the production version. Are you sure you want to set potentially live environment variables?` +
            ` If so, run this command again with the --force flag.`,
        );
      }

      // comes back as json: { errors: [ 'The following keys failed to update: 3QER, 4WER' ] },
      const failedKeys = e.json.errors[0].split('update: ')[1].split(', ');
      const successfulResult = omit(payload, failedKeys);
      if (!Object.keys(successfulResult).length) {
        this.error(e.json.errors.join('\nError: '));
      }

      this.warn(successMessage(version));
      this.logJSON(successfulResult);
      this.warn(e.json.errors.join('\nWarning: '));
    }
  }
}

SetEnvCommand.args = {
  version: Args.string({
    description:
      'The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.',
    required: true,
  }),
  'key-value pairs...': Args.string({
    description:
      'The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`',
  }),
};
SetEnvCommand.flags = buildFlags({
  commandFlags: {
    force: Flags.boolean({
      char: 'f',
      description:
        'Force the update of environment variables regardless if the app version is production or not. Use with caution.',
    }),
  },
});
SetEnvCommand.description = `Set environment variables for a version.`;
SetEnvCommand.examples = [`zapier env:set 1.2.3 SECRET=12345 OTHER=4321`];
SetEnvCommand.strict = false;
SetEnvCommand.skipValidInstallCheck = true;

module.exports = SetEnvCommand;