@automattic/vip 3.19.3-dev.0 → 3.20.0

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

@@ -3,6 +3,7 @@
 
 exports.__esModule = true;
 exports.gates = gates;
+exports.parseHeaders = parseHeaders;
 exports.promptToContinue = void 0;
 exports.validateAndGetTableNames = validateAndGetTableNames;
 var _chalk = _interopRequireDefault(require("chalk"));
@@ -86,8 +87,8 @@ const SQL_IMPORT_PREFLIGHT_PROGRESS_STEPS = [{
  */
 function isValidUrl(str) {
   try {
-    new URL(str);
-    return true;
+    const url = new URL(str);
+    return !/^[a-z]:$/iu.test(url.protocol);
   } catch {
     return false;
   }
@@ -102,6 +103,35 @@ function isValidMd5(md5) {
   return /^[a-f0-9]{32}$/i.test(md5);
 }
 
+/**
+ * Parse and validate headers from CLI input
+ * @param {string|string[]} headers - Header(s) in "Name: Value" format
+ * @returns {Array<{name: string, value: string}>} Parsed headers
+ */
+function parseHeaders(headers) {
+  if (!headers) {
+    return [];
+  }
+  const headerArray = Array.isArray(headers) ? headers : [headers];
+  const parsedHeaders = [];
+  for (const header of headerArray) {
+    const colonIndex = header.indexOf(':');
+    if (colonIndex === -1) {
+      exit.withError(`Invalid header format: "${header}". Expected format: "Name: Value"`);
+    }
+    const name = header.substring(0, colonIndex).trim();
+    const value = header.substring(colonIndex + 1).trim();
+    if (!name) {
+      exit.withError(`Invalid header format: "${header}". Header name cannot be empty.`);
+    }
+    parsedHeaders.push({
+      name,
+      value
+    });
+  }
+  return parsedHeaders;
+}
+
 /**
  * @param {import('../lib/site-import/db-file-import').AppForImport} app
  * @param {import('../lib/site-import/db-file-import').EnvForImport} env
@@ -226,6 +256,11 @@ const examples = [
   usage: 'vip @example-app.develop import sql https://example.org/file.sql',
   description: 'Import a remote SQL database backup file from the URL with MD5 hash verification to the develop environment of the "example-app" application.'
 },
+// URL import with HTTP Basic Auth
+{
+  usage: 'vip @example-app.develop import sql https://username:password@example.org/file.sql',
+  description: 'Import a remote SQL database backup file from a URL that requires HTTP Basic Authentication.'
+},
 // `search-replace` flag
 {
   usage: 'vip @example-app.develop import sql file.sql --search-replace="from.example.com,to.example.com" --search-replace="example.com/from,example.com/to"',
@@ -241,6 +276,16 @@ const examples = [
   usage: 'vip @example-app.develop import sql file.sql --search-replace="https://from.example.com,https://to.example.com" --output="updated-file.sql"',
   description: 'Create a copy of the imported file with the completed search and replace operations and save it locally to a file named "updated-file.sql".'
 },
+// URL import with headers
+{
+  usage: 'vip @example-app.develop import sql https://example.org/file.sql --header "Authorization: Bearer token"',
+  description: 'Import a remote SQL database backup file from a URL with custom authorization header.'
+},
+// URL import with multiple headers
+{
+  usage: 'vip @example-app.develop import sql https://example.org/file.sql --header "Authorization: Bearer token" --header "User-Agent: VIP CLI"',
+  description: 'Import a remote SQL database backup file from a URL with multiple custom headers.'
+},
 // `sql status` subcommand
 {
   usage: 'vip @example-app.develop import sql status',
@@ -374,7 +419,7 @@ const displayPlaybook = ({
   requiredArgs: 1,
   module: 'import-sql',
   usage
-}).command('status', 'Check the status of a SQL database import currently in progress.').option('skip-validate', 'Do not perform file validation prior to import. If the file contains unsupported entries, the import is likely to fail.').option('search-replace', 'Search for a string in the SQL file and replace it with a new string. Separate the values by a comma only; no spaces (e.g. --search-replace="from,to").').option('in-place', 'Overwrite the local input file with the results of the search and replace operation prior to import.').option('output', 'The local file path to save a copy of the results from the search and replace operation when the --search-replace option is passed. Ignored when used with the --in-place option.').option('skip-maintenance-mode', 'Imports data without putting the environment in maintenance mode. Available only for unlaunched environments. Caution: This may cause site instability during import.').option('md5', 'MD5 hash of the remote SQL file for verification. If not provided, the verification will not be performed.').examples(examples)
+}).command('status', 'Check the status of a SQL database import currently in progress.').option('skip-validate', 'Do not perform file validation prior to import. If the file contains unsupported entries, the import is likely to fail.').option('search-replace', 'Search for a string in the SQL file and replace it with a new string. Separate the values by a comma only; no spaces (e.g. --search-replace="from,to").').option('in-place', 'Overwrite the local input file with the results of the search and replace operation prior to import.').option('output', 'The local file path to save a copy of the results from the search and replace operation when the --search-replace option is passed. Ignored when used with the --in-place option.').option('skip-maintenance-mode', 'Imports data without putting the environment in maintenance mode. Available only for unlaunched environments. Caution: This may cause site instability during import.').option('md5', 'MD5 hash of the remote SQL file for verification. If not provided, the verification will not be performed.').option('header', 'Add a header to the request when downloading from a URL. Format: "Name: Value". Can be used multiple times.').examples(examples)
 // eslint-disable-next-line complexity
 .argv(process.argv, async (arg, opts) => {
   const {
@@ -385,7 +430,8 @@ const displayPlaybook = ({
     skipValidate,
     searchReplace,
     skipMaintenanceMode,
-    md5
+    md5,
+    header
   } = opts;
   const {
     id: envId,
@@ -394,6 +440,12 @@ const displayPlaybook = ({
   const [fileNameOrURL] = arg;
   const isMultiSite = await (0, _isMultiSite.isMultiSiteInSiteMeta)(appId, envId);
   const isUrl = isValidUrl(fileNameOrURL);
+
+  // Parse and validate headers
+  const headers = parseHeaders(header);
+  if (!isUrl && headers.length > 0) {
+    console.log(_chalk.default.yellowBright('The --header parameter is only used for URL imports. It will be ignored for local file imports.'));
+  }
   if (isUrl && opts.inPlace) {
     console.log(_chalk.default.yellowBright('The --in-place option is not supported when importing from a URL. This option will be ignored.'));
     opts.inPlace = false;
@@ -527,7 +579,8 @@ Processing the SQL import for your environment...
       ...startImportVariables.input,
       url: fileNameOrURL,
       searchReplace: [],
-      md5
+      md5,
+      urlHeaders: headers
     };
   } else {
     progressTracker.stepRunning('upload');

package/dist/lib/backup-storage-availability/backup-storage-availability.js

@@ -4,12 +4,11 @@ exports.__esModule = true;
 exports.BackupStorageAvailability = void 0;
 var _checkDiskSpace = _interopRequireDefault(require("check-disk-space"));
 var _enquirer = require("enquirer");
-var _os = _interopRequireDefault(require("os"));
 var _path = _interopRequireDefault(require("path"));
 var _shelljs = require("shelljs");
-var _xdgBasedir = _interopRequireDefault(require("xdg-basedir"));
 var _dockerMachineNotFoundError = require("./docker-machine-not-found-error");
 var _format = require("../cli/format");
+var _xdgData = require("../xdg-data");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const oneGiBInBytes = 1024 * 1024 * 1024;
 class BackupStorageAvailability {
@@ -31,7 +30,7 @@ class BackupStorageAvailability {
     return (0, _format.formatMetricBytes)(bytes);
   }
   async getStorageAvailableInVipPath() {
-    const vipDir = _path.default.join(_xdgBasedir.default.data ?? _os.default.tmpdir(), 'vip');
+    const vipDir = _path.default.join((0, _xdgData.xdgData)(), 'vip');
     const diskSpace = await (0, _checkDiskSpace.default)(vipDir);
     return diskSpace.free;
   }

package/dist/lib/cli/exit.js

@@ -2,20 +2,20 @@
 
 exports.__esModule = true;
 exports.withError = withError;
-var _chalk = require("chalk");
+var _chalk = _interopRequireDefault(require("chalk"));
 var _debug = _interopRequireDefault(require("debug"));
 var _env = _interopRequireDefault(require("../../lib/env"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function withError(message) {
   const msg = message instanceof Error ? message.message : message;
-  console.error(`${(0, _chalk.red)('Error: ')} ${msg.replace(/^Error:\s*/, '')}`);
+  console.error(`${_chalk.default.red('Error: ')} ${msg.replace(/^Error:\s*/, '')}`);
 
   // Debug ouput is printed below error output both for information
   // hierarchy and to make it more likely that the user copies it to their
   // clipboard when dragging across output.
-  console.log(`${(0, _chalk.yellow)('Debug: ')} VIP-CLI v${_env.default.app.version}, Node ${_env.default.node.version}, ${_env.default.os.name} ${_env.default.os.version} ${_env.default.os.arch}`);
+  console.log(`${_chalk.default.yellow('Debug: ')} VIP-CLI v${_env.default.app.version}, Node ${_env.default.node.version}, ${_env.default.os.name} ${_env.default.os.version} ${_env.default.os.arch}`);
   if (_debug.default.names.length > 0 && message instanceof Error) {
-    console.error((0, _chalk.yellow)('Debug: '), message);
+    console.error(_chalk.default.yellow('Debug: '), message);
   }
   process.exit(1);
 }

package/dist/lib/dev-environment/dev-environment-core.js

@@ -35,7 +35,6 @@ var _promises = require("node:fs/promises");
 var _nodePath = _interopRequireDefault(require("node:path"));
 var _semver = _interopRequireDefault(require("semver"));
 var _uuid = require("uuid");
-var _xdgBasedir = _interopRequireDefault(require("xdg-basedir"));
 var _devEnvironmentCli = require("./dev-environment-cli");
 var _devEnvironmentLando = require("./dev-environment-lando");
 var _app = _interopRequireDefault(require("../api/app"));
@@ -44,6 +43,7 @@ var _devEnvironment = require("../constants/dev-environment");
 var _proxyAgent = require("../http/proxy-agent");
 var _searchAndReplace = require("../search-and-replace");
 var _userError = _interopRequireDefault(require("../user-error"));
+var _xdgData = require("../xdg-data");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment');
 const landoFileTemplatePath = _nodePath.default.join(__dirname, '..', '..', '..', 'assets', 'dev-env.lando.template.yml.ejs');
@@ -58,15 +58,6 @@ const integrationsConfigBackupFileName = 'integrations.json.bak';
 const uploadPathString = 'uploads';
 const nginxPathString = 'nginx';
 const integrationsConfigPathString = 'integrations-config';
-function xdgDataDirectory() {
-  if (_xdgBasedir.default.data) {
-    return _xdgBasedir.default.data;
-  }
-
-  // This should not happen. If it does, this means that the system was unable to find user's home directory.
-  // If so, this does not leave us many options as to where to store the data.
-  throw new Error('Unable to determine data directory.');
-}
 async function startEnvironment(lando, slug, options) {
   debug('Will start an environment', slug);
   const instancePath = getEnvironmentPath(slug);
@@ -175,7 +166,7 @@ async function destroyEnvironment(lando, slug, removeFiles) {
   } else {
     debug("Lando file doesn't exist, skipping lando destroy.");
   }
-  await _nodeFs.default.promises.rm(_nodePath.default.join(xdgDataDirectory(), 'vip', 'lando', 'compose', (0, _utils.dockerComposify)(slug)), {
+  await _nodeFs.default.promises.rm(_nodePath.default.join((0, _xdgData.xdgData)(), 'vip', 'lando', 'compose', (0, _utils.dockerComposify)(slug)), {
     force: true,
     recursive: true
   });
@@ -406,7 +397,7 @@ async function prepareLandoEnv(lando, instanceData, instancePath, integrationsCo
   }
 }
 function getAllEnvironmentNames() {
-  const mainEnvironmentPath = xdgDataDirectory();
+  const mainEnvironmentPath = (0, _xdgData.xdgData)();
   const baseDir = _nodePath.default.join(mainEnvironmentPath, 'vip', 'dev-environment');
   const doWeHaveAnyEnvironment = _nodeFs.default.existsSync(baseDir);
   let envNames = [];
@@ -423,7 +414,7 @@ function getEnvironmentPath(name) {
   if (!name) {
     throw new Error('Name was not provided');
   }
-  const mainEnvironmentPath = xdgDataDirectory();
+  const mainEnvironmentPath = (0, _xdgData.xdgData)();
   return _nodePath.default.join(mainEnvironmentPath, 'vip', 'dev-environment', String(name));
 }
 async function getApplicationInformation(appId, envType) {
@@ -721,7 +712,7 @@ async function isVersionListExpired(cacheFile, ttl) {
  */
 async function getVersionList() {
   let res;
-  const mainEnvironmentPath = xdgDataDirectory();
+  const mainEnvironmentPath = (0, _xdgData.xdgData)();
   const cacheFilePath = _nodePath.default.join(mainEnvironmentPath, 'vip');
   const cacheFile = _nodePath.default.join(cacheFilePath, _devEnvironment.DEV_ENVIRONMENT_WORDPRESS_CACHE_KEY);
   // Handle from cache

package/dist/lib/dev-environment/dev-environment-lando.js

@@ -27,11 +27,11 @@ var _promises2 = require("node:fs/promises");
 var _nodeOs = require("node:os");
 var _nodePath = _interopRequireWildcard(require("node:path"));
 var _semver = require("semver");
-var _xdgBasedir = _interopRequireDefault(require("xdg-basedir"));
 var _devEnvironmentCore = require("./dev-environment-core");
 var _dockerUtils = require("./docker-utils");
 var _devEnvironment = require("../constants/dev-environment");
 var _userError = _interopRequireDefault(require("../user-error"));
+var _xdgData = require("../xdg-data");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /**
@@ -57,9 +57,7 @@ async function getLandoConfig() {
   } else {
     logLevelConsole = 'warn';
   }
-
-  // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
-  const vipDir = _nodePath.default.join(_xdgBasedir.default.data || (0, _nodeOs.tmpdir)(), 'vip'); // NOSONAR
+  const vipDir = _nodePath.default.join((0, _xdgData.xdgData)(), 'vip');
   const landoDir = _nodePath.default.join(vipDir, 'lando');
   const fakeHomeDir = _nodePath.default.join(landoDir, 'home');
   try {

package/dist/lib/search-and-replace.js

@@ -4,7 +4,7 @@ exports.__esModule = true;
 exports.getReadAndWriteStreams = getReadAndWriteStreams;
 exports.searchAndReplace = void 0;
 var _vipSearchReplace = require("@automattic/vip-search-replace");
-var _chalk = require("chalk");
+var _chalk = _interopRequireDefault(require("chalk"));
 var _debug = _interopRequireDefault(require("debug"));
 var _fs = _interopRequireDefault(require("fs"));
 var _promises = require("node:stream/promises");
@@ -138,7 +138,7 @@ const searchAndReplace = async (fileName, pairs, {
   try {
     await (0, _promises.pipeline)(streams);
   } catch (error) {
-    console.log((0, _chalk.red)("Oh no! We couldn't write to the output file.  Please check your available disk space and file/folder permissions."));
+    console.log(_chalk.default.red("Oh no! We couldn't write to the output file.  Please check your available disk space and file/folder permissions."));
     throw error;
   }
   const endTime = process.hrtime(startTime);

package/dist/lib/xdg-data.js

@@ -0,0 +1,15 @@
+"use strict";
+
+exports.__esModule = true;
+exports.xdgData = xdgData;
+var _nodeOs = require("node:os");
+var _nodePath = require("node:path");
+function xdgData() {
+  // Use the XDG_DATA_HOME environment variable if set, otherwise default to ~/.local/share
+  const xdgDataHome = process.env.XDG_DATA_HOME;
+  if (xdgDataHome) {
+    return xdgDataHome;
+  }
+  const homeDirectory = (0, _nodeOs.homedir)();
+  return (0, _nodePath.join)(homeDirectory, '.local', 'share');
+}