@automattic/vip 2.6.0 → 2.7.0-dev1

package/config/config.json

@@ -1,6 +1,6 @@
 {
   "tracksUserType": "vip:user_id",
   "tracksAnonUserType": "anon",
-  "tracksEventPrefix": "vip_cli_",
-  "environment": "production"
+  "tracksEventPrefix": "vip_cli_dev_",
+  "environment": "development"
 }

package/dist/bin/vip-dev-environment-start.js

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @fomat
+ */
+
+/**
+ * External dependencies
+ */
+"use strict";
+
+var _debug = _interopRequireDefault(require("debug"));
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+var _devEnvironment = require("../lib/dev-environment");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Internal dependencies
+ */
+const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment'); // Command examples
+
+const examples = [{
+  usage: 'vip dev-environment start',
+  description: 'Starts local dev environment\n' + '       * If the environment isn\'t built yet it will build it as well'
+}];
+(0, _command.default)().option('slug', `Custom name of the dev environment (default: "${_devEnvironment.defaults.environmentSlug}")`).option('title', 'Title for the WordPress site (default: "VIP Dev")').option('multisite', 'Enable multisite install').option('php', 'Use a specific PHP version').option('wordpress', 'Use a specific WordPress version or local directory (default: last stable)').option('mu-plugins', 'Use a specific mu-plugins changeset or local directory (default: "auto": last commit in master)').option('jetpack', 'Use a specific Jetpack from a local directory (default: "mu": use the version in mu-plugins)').option('client-code', 'Use the client code from a local directory or VIP skeleton (default: use the VIP skeleton)').examples(examples).argv(process.argv, async (arg, opt) => {
+  const slug = opt.slug || _devEnvironment.defaults.environmentSlug;
+  debug('Args: ', arg, 'Options: ', opt);
+
+  try {
+    await (0, _devEnvironment.startEnvironment)(slug, opt);
+  } catch (e) {
+    console.log(_chalk.default.red('Error:'), e.message);
+  }
+});

package/dist/bin/vip-dev-environment.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @fomat
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+"use strict";
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+(0, _command.default)({
+  requiredArgs: 1
+}).command('start', 'Start the local dev environment').argv(process.argv);

package/dist/bin/vip-logs.js

@@ -0,0 +1,151 @@
+#!/usr/bin/env node
+
+/**
+ * Internal dependencies
+ */
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getLogs = getLogs;
+exports.validateInputs = validateInputs;
+exports.appQuery = void 0;
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+var _rollbar = require("../lib/rollbar");
+
+var _tracker = require("../lib/tracker");
+
+var logsLib = _interopRequireWildcard(require("../lib/logs/logs"));
+
+var exit = _interopRequireWildcard(require("../lib/cli/exit"));
+
+var _format = require("../lib/cli/format");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const LIMIT_MAX = 5000;
+const LIMIT_MIN = 1;
+const ALLOWED_TYPES = ['app', 'batch'];
+const ALLOWED_FORMATS = ['csv', 'json', 'text'];
+
+async function getLogs(arg, opt) {
+  validateInputs(opt.type, opt.limit, opt.format);
+  const trackingParams = {
+    command: 'vip logs',
+    org_id: opt.app.organization.id,
+    app_id: opt.app.id,
+    env_id: opt.env.id,
+    type: opt.type,
+    limit: opt.limit,
+    format: opt.format
+  };
+  await (0, _tracker.trackEvent)('logs_command_execute', trackingParams);
+  let logs = [];
+
+  try {
+    logs = await logsLib.getRecentLogs(opt.app.id, opt.env.id, opt.type, opt.limit);
+  } catch (error) {
+    _rollbar.rollbar.error(error);
+
+    await (0, _tracker.trackEvent)('logs_command_error', { ...trackingParams,
+      error: error.message
+    });
+    return exit.withError(error.message);
+  }
+
+  await (0, _tracker.trackEvent)('logs_command_success', { ...trackingParams,
+    logs_output: logs.length
+  });
+
+  if (!logs.length) {
+    console.error('No logs found');
+    return;
+  } // Strip out __typename
+
+
+  logs = logs.map(log => {
+    const {
+      timestamp,
+      message
+    } = log;
+    return {
+      timestamp,
+      message
+    };
+  });
+  let output = '';
+
+  if (opt.format && 'text' === opt.format) {
+    const rows = [];
+
+    for (const {
+      timestamp,
+      message
+    } of logs) {
+      rows.push(`${timestamp} ${message}`);
+      output = rows.join('\n');
+    }
+  } else {
+    output = (0, _format.formatData)(logs, opt.format);
+  }
+
+  console.log(output);
+}
+
+function validateInputs(type, limit, format) {
+  if (!ALLOWED_TYPES.includes(type)) {
+    exit.withError(`Invalid type: ${type}. The supported types are: ${ALLOWED_TYPES.join(', ')}.`);
+  }
+
+  if (!ALLOWED_FORMATS.includes(format)) {
+    exit.withError(`Invalid format: ${format}. The supported formats are: ${ALLOWED_FORMATS.join(', ')}.`);
+  }
+
+  if (!Number.isInteger(limit) || limit < LIMIT_MIN || limit > LIMIT_MAX) {
+    exit.withError(`Invalid limit: ${limit}. It should be a number between ${LIMIT_MIN} and ${LIMIT_MAX}.`);
+  }
+}
+
+const appQuery = `
+	id
+	name
+	environments {
+		id
+		appId
+		name
+		type
+	}
+	organization {
+		id
+		name
+	}
+`;
+exports.appQuery = appQuery;
+(0, _command.default)({
+  appContext: true,
+  appQuery,
+  envContext: true,
+  module: 'logs'
+}).option('type', 'The type of logs to be returned: "app" or "batch"', 'app').option('limit', 'The maximum number of log lines', 500).option('format', 'Output the log lines in CSV or JSON format', 'text').examples([{
+  usage: 'vip @mysite.production logs',
+  description: 'Get the most recent app logs'
+}, {
+  usage: 'vip @mysite.production logs --type batch',
+  description: 'Get the most recent batch logs'
+}, {
+  usage: 'vip @mysite.production logs --limit 100',
+  description: 'Get the most recent 100 log entries'
+}, {
+  usage: 'vip @mysite.production logs --limit 100 --format csv',
+  description: 'Get the most recent 100 log entries formatted as comma-separated values (CSV)'
+}, {
+  usage: 'vip @mysite.production logs --limit 100 --format json',
+  description: 'Get the most recent 100 log entries formatted as JSON'
+}]).argv(process.argv, getLogs);

package/dist/bin/vip.js

@@ -48,7 +48,7 @@ const runCmd = async function () {
     await _token.default.purge();
     await (0, _tracker.trackEvent)('logout_command_execute');
     console.log('You are successfully logged out.');
-  }).command('app', 'List and modify your VIP applications').command('config', 'Set configuration for your VIP applications').command('dev-env', 'Use local dev-environment').command('import', 'Import media or SQL files into your VIP applications').command('search-replace', 'Perform search and replace tasks on files').command('sync', 'Sync production to a development environment').command('wp', 'Run WP CLI commands against an environment');
+  }).command('app', 'List and modify your VIP applications').command('config', 'Set configuration for your VIP applications').command('dev-env', 'Use local dev-environment').command('import', 'Import media or SQL files into your VIP applications').command('logs', 'Get logs from your VIP applications').command('search-replace', 'Perform search and replace tasks on files').command('sync', 'Sync production to a development environment').command('wp', 'Run WP CLI commands against an environment');
   cmd.argv(process.argv);
 };
 

package/dist/lib/dev-environment.js

@@ -0,0 +1,194 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.startEnvironment = startEnvironment;
+exports.generateInstanceData = generateInstanceData;
+exports.getEnvironmentPath = getEnvironmentPath;
+exports.defaults = void 0;
+
+var _debug = _interopRequireDefault(require("debug"));
+
+var _xdgBasedir = _interopRequireDefault(require("xdg-basedir"));
+
+var _os = _interopRequireDefault(require("os"));
+
+var _fs = _interopRequireDefault(require("fs"));
+
+var _ejs = _interopRequireDefault(require("ejs"));
+
+var _path = _interopRequireDefault(require("path"));
+
+var _lando = _interopRequireDefault(require("lando/lib/lando"));
+
+var _utils = _interopRequireDefault(require("lando/plugins/lando-core/lib/utils"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment');
+const containerImages = {
+  wordpress: {
+    image: 'wpvipdev/wordpress',
+    tag: '5.6'
+  },
+  jetpack: {
+    image: 'wpvipdev/jetpack'
+  },
+  muPlugins: {
+    image: 'wpvipdev/mu-plugins',
+    tag: 'auto'
+  },
+  clientCode: {
+    image: 'wpvipdev/skeleton',
+    tag: '181a17d9aedf7da73730d65ccef3d8dbf172a5c5'
+  }
+};
+const defaults = {
+  environmentSlug: 'vip-local',
+  title: 'VIP Dev',
+  multisite: false,
+  phpVersion: '7.3',
+  jetpack: {
+    mode: 'inherit'
+  },
+  wordpress: {},
+  muPlugins: {},
+  clientCode: {}
+};
+exports.defaults = defaults;
+['wordpress', 'muPlugins', 'clientCode'].forEach(type => {
+  defaults[type] = {
+    mode: 'image',
+    image: containerImages[type].image,
+    tag: containerImages[type].tag
+  };
+});
+const landoFileTemplatePath = 'assets/dev-environment.lando.template.yml.ejs';
+const landoFileName = '.lando.yml';
+
+async function startEnvironment(slug, options) {
+  debug('Will start an environment', slug, 'with options: ', options);
+  const instancePath = getEnvironmentPath(slug);
+
+  const alreadyExists = _fs.default.existsSync(instancePath);
+
+  if (alreadyExists) {
+    const parameters = Object.keys(options || {}).filter(key => key !== 'slug');
+
+    if (parameters && parameters.length) {
+      throw new Error(`The environment ${slug} already exists and we can not change its configuration` + ` ( configuration parameters - ${parameters.join(', ')} found ).` + ' Destroy the environment first if you would like to recreate it.');
+    }
+  } else {
+    const instanceData = generateInstanceData(slug, options);
+    debug('Instance data to create a new environment:', instanceData);
+    await prepareLandoEnv(instanceData, instancePath);
+  }
+
+  await landoStart(instancePath);
+}
+
+function getLandoConfig() {
+  const landoPath = _path.default.join(__dirname, '..', '..', 'node_modules', 'lando');
+
+  debug(`Getting lando config, using path '${landoPath}' for plugins`);
+  return {
+    logLevelConsole: 'warn',
+    landoFile: '.lando.yml',
+    preLandoFiles: ['.lando.base.yml', '.lando.dist.yml', '.lando.upstream.yml'],
+    postLandoFiles: ['.lando.local.yml'],
+    pluginDirs: [landoPath, {
+      path: _path.default.join(landoPath, 'integrations'),
+      subdir: '.'
+    }]
+  };
+}
+
+async function landoStart(instancePath) {
+  debug('Will start lando app on path:', instancePath);
+  const lando = new _lando.default(getLandoConfig());
+  await lando.bootstrap();
+  const app = lando.getApp(instancePath);
+  await app.init();
+  await app.start();
+  console.log(lando.cli.formatData(_utils.default.startTable(app), {
+    format: 'table'
+  }, {
+    border: false
+  }));
+}
+
+async function prepareLandoEnv(instanceData, instancePath) {
+  const landoFile = await _ejs.default.renderFile(landoFileTemplatePath, instanceData);
+
+  const landoFileTargetPath = _path.default.join(instancePath, landoFileName);
+
+  _fs.default.mkdirSync(instancePath, {
+    recursive: true
+  });
+
+  _fs.default.writeFileSync(landoFileTargetPath, landoFile);
+
+  debug(`Lando file created in ${landoFileTargetPath}`);
+}
+
+function generateInstanceData(slug, options) {
+  const instanceData = {
+    siteSlug: slug,
+    wpTitle: options.title || defaults.title,
+    multisite: options.multisite || defaults.multisite,
+    phpVersion: options.phpVersion || defaults.phpVersion,
+    wordpress: getParamInstanceData(options.wordpress, 'wordpress'),
+    muPlugins: getParamInstanceData(options.muPlugins, 'muPlugins'),
+    jetpack: getParamInstanceData(options.jetpack, 'jetpack'),
+    clientCode: getParamInstanceData(options.clientCode, 'clientCode')
+  };
+  return instanceData;
+}
+
+function getParamInstanceData(param, type) {
+  if (param) {
+    if (param.includes('/')) {
+      return {
+        mode: 'local',
+        dir: param
+      };
+    }
+
+    if (type === 'jetpack' && param === 'mu') {
+      return {
+        mode: 'inherit'
+      };
+    }
+
+    return {
+      mode: 'image',
+      image: containerImages[type].image,
+      tag: param
+    };
+  }
+
+  return defaults[type];
+}
+
+function getEnvironmentPath(name) {
+  if (!name) {
+    throw new Error('Name was not provided');
+  }
+
+  const mainEnvironmentPath = _xdgBasedir.default.data || _os.default.tmpdir();
+
+  return _path.default.join(mainEnvironmentPath, 'vip', 'dev-environment', name);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "2.6.0",
+  "version": "2.7.0-dev1",
   "description": "The VIP Javascript library & CLI",
   "main": "index.js",
   "bin": {
@@ -33,6 +33,7 @@
     "vip-import-sql-status": "dist/bin/vip-import-sql-status.js",
     "vip-import-validate-files": "dist/bin/vip-import-validate-files.js",
     "vip-import-validate-sql": "dist/bin/vip-import-validate-sql.js",
+    "vip-logs": "dist/bin/vip-logs.js",
     "vip-search-replace": "dist/bin/vip-search-replace.js",
     "vip-sync": "dist/bin/vip-sync.js",
     "vip-wp": "dist/bin/vip-wp.js"