@automattic/vip 2.12.0 → 2.14.0

package/package/dist/bin/vip-import-validate-files.js

@@ -1,191 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * External dependencies
- */
-"use strict";
-
-var _url = _interopRequireDefault(require("url"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _util = require("util");
-
-var _command = _interopRequireDefault(require("../lib/cli/command"));
-
-var _vipImportValidateFiles = require("../lib/vip-import-validate-files");
-
-var _tracker = require("../lib/tracker");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * Internal dependencies
- */
-// Promisify to use async/await
-const stat = (0, _util.promisify)(_fs.default.stat);
-(0, _command.default)({
-  requiredArgs: 1,
-  format: true
-}).example('vip import validate-files <file>', 'Run the import validation against the file').argv(process.argv, async arg => {
-  await (0, _tracker.trackEvent)('import_validate_files_command_execute');
-  /**
-   * File manipulation
-   *
-   * Manipulating the file path/name to extract the folder name
-   */
-
-  const folder = arg.join(); // File comes in as an array as part of the args- turn it into a string
-
-  arg = _url.default.parse(folder); // Then parse the file to its URL parts
-
-  const filePath = arg.path; // Extract the path of the file
-
-  let folderValidation;
-  /**
-   * Folder structure validation
-   *
-   * Find nested directories and files to see if media files follow the WordPress recommended folder structure
-   *
-   * Recommended structure: `uploads/year/month` (Single sites)
-   */
-
-  const nestedFiles = (0, _vipImportValidateFiles.findNestedDirectories)(filePath);
-  const {
-    files,
-    folderStructureObj
-  } = nestedFiles; // Destructure
-  // Check if there are any nested directories within the given folder
-
-  const nestedDirectories = Object.keys(folderStructureObj);
-
-  if (nestedDirectories && nestedDirectories.length > 0) {
-    folderValidation = (0, _vipImportValidateFiles.folderStructureValidation)(nestedDirectories);
-  }
-  /**
-   * Individual file validations
-   *
-   * - Media file extension/type validation
-   * - Filename validation
-   * - Intermediate image validation
-   */
-
-
-  if (!files || !files.length || files.length <= 0) {
-    console.error(_chalk.default.red('✕ Error:'), 'Media files directory cannot be empty');
-  }
-  /**
-   * Media file extension validation
-   *
-   * Ensure that prohibited media file types are not used
-   */
-  // Collect invalid files for error logging
-
-
-  let intermediateImagesTotal = 0;
-  const errorFileTypes = [];
-  const errorFileNames = [];
-  const intermediateImages = {}; // Iterate through each file to isolate the extension name
-
-  for (const file of files) {
-    // Check if file is a directory
-    const stats = await stat(file);
-    const isFolder = stats.isDirectory();
-
-    const extension = _path.default.extname(file); // Extract the extension of the file
-
-
-    const ext = extension.substr(1); // We only want the ext name minus the period (e.g- .jpg -> jpg)
-
-    const extLowerCase = ext.toLowerCase(); // Change any uppercase extensions to lowercase
-    // Check for any invalid file extensions
-    // Returns true if ext is valid; false if invalid
-
-    const validExtensions = _vipImportValidateFiles.acceptedExtensions.includes(extLowerCase); // Collect files that have no extension, have invalid extensions,
-    // or are directories for error logging
-
-
-    if (!extension || !validExtensions || isFolder) {
-      errorFileTypes.push(file);
-    }
-    /**
-     * Filename validation
-     *
-     * Ensure that filenames don't contain prohibited characters
-     */
-    // Collect files that have invalid file names for error logging
-
-
-    if ((0, _vipImportValidateFiles.isFileSanitized)(file)) {
-      errorFileNames.push(file);
-    }
-    /**
-     * Intermediate image validation
-     *
-     * Detect any intermediate images.
-     *
-     * Intermediate images are copies of images that are resized, so you may have multiples of the same image.
-     * You can resize an image directly on VIP so intermediate images are not necessary.
-     */
-
-
-    const original = (0, _vipImportValidateFiles.doesImageHaveExistingSource)(file); // If an image is an intermediate image, increment the total number and
-    // populate key/value pairs of the original image and intermediate image(s)
-
-    if (original) {
-      intermediateImagesTotal++;
-
-      if (intermediateImages[original]) {
-        // Key: original image, value: intermediate image(s)
-        intermediateImages[original] = `${intermediateImages[original]}, ${file}`;
-      } else {
-        intermediateImages[original] = file;
-      }
-    }
-  }
-  /**
-   * Error logging
-   */
-
-
-  if (errorFileTypes.length > 0) {
-    (0, _vipImportValidateFiles.logErrorsForInvalidFileTypes)(errorFileTypes);
-  }
-
-  if (errorFileNames.length > 0) {
-    (0, _vipImportValidateFiles.logErrorsForInvalidFilenames)(errorFileNames);
-  }
-
-  if (Object.keys(intermediateImages).length > 0) {
-    (0, _vipImportValidateFiles.logErrorsForIntermediateImages)(intermediateImages);
-  } // Log a summary of all errors
-
-
-  (0, _vipImportValidateFiles.summaryLogs)({
-    folderErrorsLength: folderValidation.length,
-    intImagesErrorsLength: intermediateImagesTotal,
-    fileTypeErrorsLength: errorFileTypes.length,
-    filenameErrorsLength: errorFileNames.length,
-    totalFiles: files.length,
-    totalFolders: nestedDirectories.length
-  }); // Tracks events to track activity
-  // Props (object keys) need to be in Snake case vs. camelCase
-
-  /* eslint-disable camelcase */
-
-  const allErrors = {
-    folder_errors_length: folderValidation.length,
-    int_images_errors_length: intermediateImagesTotal,
-    file_type_errors_length: errorFileTypes.length,
-    filename_errors_length: errorFileNames.length,
-    total_files: files.length,
-    total_folders: nestedDirectories.length
-  };
-  /* eslint-enable camelcase */
-
-  await (0, _tracker.trackEvent)('import_validate_files_command_success', allErrors);
-});

package/package/dist/bin/vip-import-validate-sql.js

@@ -1,34 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * External dependencies
- */
-
-/**
- * Internal dependencies
- */
-"use strict";
-
-var _command = _interopRequireDefault(require("../lib/cli/command"));
-
-var exit = _interopRequireWildcard(require("../lib/cli/exit"));
-
-var _sql = require("../lib/validations/sql");
-
-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 }; }
-
-(0, _command.default)({
-  requiredArgs: 1
-}).example('vip import validate-sql <file>', 'Run the import validation against file').argv(process.argv, async arg => {
-  const filename = arg[0];
-
-  if (!arg && !filename) {
-    exit.withError('You must pass in a filename');
-  }
-
-  (0, _sql.validate)(filename);
-});

package/package/dist/bin/vip-import.js

@@ -1,20 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * External dependencies
- */
-
-/**
- * Internal dependencies
- */
-"use strict";
-
-var _command = _interopRequireDefault(require("../lib/cli/command"));
-
-var _tracker = require("../lib/tracker");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-(0, _command.default)().command('sql', 'Import SQL to your database from a file').command('validate-sql', 'Validate your SQL dump').command('validate-files', 'Validate your media file library').command('media', 'Import media files to the production environment of your application from a compressed web archive').example('vip import sql @mysite.develop <file.sql>', 'Import the given SQL file to your site').example('vip import media @mysite.production https://<path_to_publicly_accessible_archive>', 'Import contents of the given archive file into the media library of your site').argv(process.argv, async () => {
-  await (0, _tracker.trackEvent)('vip_import_command_execute');
-});

package/package/dist/bin/vip-logs.js

@@ -1,232 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * External dependencies
- */
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getLogs = getLogs;
-exports.followLogs = followLogs;
-exports.validateInputs = validateInputs;
-exports.appQuery = void 0;
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _command = _interopRequireDefault(require("../lib/cli/command"));
-
-var _rollbar = require("../lib/rollbar");
-
-var _tracker = require("../lib/tracker");
-
-var logsLib = _interopRequireWildcard(require("../lib/app-logs/app-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 }; }
-
-/**
- * Internal dependencies
- */
-const LIMIT_MIN = 1;
-const LIMIT_MAX = 5000;
-const ALLOWED_TYPES = ['app', 'batch'];
-const ALLOWED_FORMATS = ['csv', 'json', 'text'];
-const DEFAULT_POLLING_DELAY_IN_SECONDS = 30;
-const MIN_POLLING_DELAY_IN_SECONDS = 5;
-const MAX_POLLING_DELAY_IN_SECONDS = 300;
-
-async function getLogs(arg, opt) {
-  validateInputs(opt.type, opt.limit, opt.format);
-  const trackingParams = getBaseTrackingParams(opt);
-  await (0, _tracker.trackEvent)('logs_command_execute', trackingParams);
-  let logs;
-
-  try {
-    if (opt.follow) {
-      return await followLogs(opt);
-    }
-
-    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,
-    total: logs.nodes.length
-  });
-
-  if (!logs.nodes.length) {
-    console.error('No logs found');
-    return;
-  }
-
-  printLogs(logs.nodes, opt.format);
-}
-
-async function followLogs(opt) {
-  let after = null;
-  let isFirstRequest = true; // How many times have we polled?
-
-  let requestNumber = 0;
-  const trackingParams = getBaseTrackingParams(opt); // Set an initial default delay
-
-  let delay = DEFAULT_POLLING_DELAY_IN_SECONDS;
-
-  while (true) {
-    const limit = isFirstRequest ? opt.limit : LIMIT_MAX;
-    requestNumber++;
-    trackingParams.request_number = requestNumber;
-    trackingParams.request_delay = delay;
-    trackingParams.limit = limit;
-    let logs;
-
-    try {
-      var _logs;
-
-      logs = await logsLib.getRecentLogs(opt.app.id, opt.env.id, opt.type, limit, after);
-      await (0, _tracker.trackEvent)('logs_command_follow_success', { ...trackingParams,
-        total: (_logs = logs) === null || _logs === void 0 ? void 0 : _logs.nodes.length
-      });
-    } catch (error) {
-      await (0, _tracker.trackEvent)('logs_command_follow_error', { ...trackingParams,
-        error: error.message
-      }); // If the first request fails we don't want to retry (it's probably not recoverable)
-
-      if (isFirstRequest) {
-        console.error(`${_chalk.default.red('Error:')} Failed to fetch logs.`);
-        break;
-      } // Increase the delay on errors to avoid overloading the server, up to a max of 5 minutes
-
-
-      delay += DEFAULT_POLLING_DELAY_IN_SECONDS;
-      delay = Math.min(delay, MAX_POLLING_DELAY_IN_SECONDS);
-      console.error(`${_chalk.default.red('Error:')} Failed to fetch logs. Trying again in ${delay} seconds.`);
-
-      _rollbar.rollbar.error(error);
-    }
-
-    if (logs) {
-      var _logs2, _logs3, _logs4;
-
-      if ((_logs2 = logs) !== null && _logs2 !== void 0 && _logs2.nodes.length) {
-        printLogs(logs.nodes, opt.format);
-      }
-
-      after = (_logs3 = logs) === null || _logs3 === void 0 ? void 0 : _logs3.nextCursor;
-      isFirstRequest = false; // Keep a sane lower limit of MIN_POLLING_DELAY_IN_SECONDS just in case something goes wrong in the server-side
-
-      delay = Math.max(((_logs4 = logs) === null || _logs4 === void 0 ? void 0 : _logs4.pollingDelaySeconds) || DEFAULT_POLLING_DELAY_IN_SECONDS, MIN_POLLING_DELAY_IN_SECONDS);
-    }
-
-    await new Promise(resolve => setTimeout(resolve, delay * 1000));
-  }
-}
-
-function getBaseTrackingParams(opt) {
-  return {
-    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,
-    follow: opt.follow || false,
-    format: opt.format
-  };
-}
-
-function printLogs(logs, format) {
-  // Strip out __typename
-  logs = logs.map(log => {
-    const {
-      timestamp,
-      message
-    } = log;
-    return {
-      timestamp,
-      message
-    };
-  });
-  let output = '';
-
-  if (format && 'text' === format) {
-    const rows = [];
-
-    for (const {
-      timestamp,
-      message
-    } of logs) {
-      rows.push(`${timestamp} ${message}`);
-      output = rows.join('\n');
-    }
-  } else {
-    output = (0, _format.formatData)(logs, 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 > logsLib.LIMIT_MAX) {
-    exit.withError(`Invalid limit: ${limit}. It should be a number between ${LIMIT_MIN} and ${logsLib.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('follow', 'Keep fetching new logs as they are generated').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/package/dist/bin/vip-search-replace.js

@@ -1,71 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * 
- * @format
- */
-
-/**
- * External dependencies
- */
-"use strict";
-
-var _debug = _interopRequireDefault(require("debug"));
-
-var _command = _interopRequireDefault(require("../lib/cli/command"));
-
-var exit = _interopRequireWildcard(require("../lib/cli/exit"));
-
-var _searchAndReplace = require("../lib/search-and-replace");
-
-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 }; }
-
-/**
- * Internal dependencies
- */
-const debug = (0, _debug.default)('@automattic/vip:bin:vip-search-replace'); // Command examples
-
-const examples = [// `search-replace` flag
-{
-  usage: 'vip search-replace <file.sql> --search-replace="from,to"',
-  description: 'Replace instances of <from> with <to> in the provided <file.sql>\n' + '       * Ensure there are no spaces between your search-replace parameters'
-}, // `in-place` flag
-{
-  usage: 'vip search-replace <file.sql> --search-replace="from,to" --in-place',
-  description: 'Perform Search and Replace explicitly on the provided input <file.sql> file'
-}, // `output` flag
-{
-  usage: 'vip search-replace <file.sql> --search-replace="from,to" --output="<output.sql>"',
-  description: 'Search and Replace to the specified output <output.sql> file\n' + '       * Has no effect when the `in-place` flag is used'
-}];
-(0, _command.default)({
-  requiredArgs: 1
-}).option('search-replace', 'Specify the <from> and <to> pairs to be replaced').option('in-place', 'Perform the search and replace explicitly on the input file').option('output', 'Specify the replacement output file for Search and Replace').examples(examples).argv(process.argv, async (arg, opt) => {
-  // TODO: tracks event for usage of this command stand alone
-  const {
-    searchReplace,
-    inPlace,
-    output
-  } = opt;
-  debug('Args: ', arg, 'searchReplace: ', searchReplace);
-  const filename = arg[0];
-
-  if (!arg && !filename) {
-    exit.withError('You must pass in a filename');
-  }
-
-  if (!searchReplace || !searchReplace.length) {
-    exit.withError('You must provide a pair of strings (separated by comma) such as original,replacement');
-  }
-
-  const isImport = false;
-  await (0, _searchAndReplace.searchAndReplace)(filename, searchReplace, {
-    isImport,
-    inPlace,
-    output
-  });
-});