@automattic/vip 3.25.2 → 3.25.3-dev.0

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

@@ -30,9 +30,13 @@ const examples = [{
   usage: `${exampleUsage} --editor=phpstorm --slug=example-site`,
   description: 'Start a local environment and generate a Workspace file for developing in PhpStorm.'
 }];
-(0, _command.default)({
+const cmd = (0, _command.default)({
   usage
-}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).option('skip-rebuild', 'Only start services that are not in a running state.').option(['w', 'skip-wp-versions-check'], 'Skip the prompt to update WordPress; occurs if the last major release version is not configured.').option('vscode', 'Generate a Visual Studio Code Workspace file (deprecated, use --editor=vscode instead).').option('editor', 'Generate a workspace file for the specified editor (supports: vscode, cursor, windsurf, phpstorm).').examples(examples).argv(process.argv, async (arg, opt) => {
+}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).option('skip-rebuild', 'Only start services that are not in a running state.').option(['w', 'skip-wp-versions-check'], 'Skip the prompt to update WordPress; occurs if the last major release version is not configured.').option('vscode', 'Generate a Visual Studio Code Workspace file (deprecated, use --editor=vscode instead).').option('editor', 'Generate a workspace file for the specified editor (supports: vscode, cursor, windsurf, phpstorm).');
+if (process.platform !== 'win32') {
+  cmd.option('autofix-domain-resolution', 'Automatically fix domain resolution issues by updating the hosts file [UNSAFE].');
+}
+cmd.examples(examples).argv(process.argv, async (arg, opt) => {
   const slug = await (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const lando = await (0, _devEnvironmentLando.bootstrapLando)({
     logFile: (0, _devEnvironmentCli.getDevEnvLogFile)(slug)
@@ -49,7 +53,8 @@ const examples = [{
   debug('Args: ', arg, 'Options: ', opt);
   const options = {
     skipRebuild: Boolean(opt.skipRebuild),
-    skipWpVersionsCheck: Boolean(opt.skipWpVersionsCheck)
+    skipWpVersionsCheck: Boolean(opt.skipWpVersionsCheck),
+    autofixDomains: Boolean(opt.autofixDomainResolution)
   };
   try {
     await (0, _devEnvironmentCore.startEnvironment)(lando, slug, options);

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

@@ -78,9 +78,9 @@ async function startEnvironment(lando, slug, options) {
     await (0, _devEnvironmentLando.removeProxyCache)(lando);
   }
   if (options.skipRebuild && !updated) {
-    await (0, _devEnvironmentLando.landoStart)(lando, instancePath);
+    await (0, _devEnvironmentLando.landoStart)(lando, instancePath, options.autofixDomains);
   } else {
-    await (0, _devEnvironmentLando.landoRebuild)(lando, instancePath);
+    await (0, _devEnvironmentLando.landoRebuild)(lando, instancePath, options.autofixDomains);
   }
   await printEnvironmentInfo(lando, slug, {
     extended: false

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

@@ -15,6 +15,7 @@ exports.landoShell = landoShell;
 exports.landoStart = landoStart;
 exports.landoStop = landoStop;
 exports.removeProxyCache = removeProxyCache;
+exports.tryResolveDomains = tryResolveDomains;
 exports.validateDockerInstalled = validateDockerInstalled;
 var _chalk = _interopRequireDefault(require("chalk"));
 var _debug = _interopRequireDefault(require("debug"));
@@ -35,6 +36,7 @@ var _devEnvironment = require("../constants/dev-environment");
 var _env = _interopRequireDefault(require("../env"));
 var _userError = _interopRequireDefault(require("../user-error"));
 var _xdgData = require("../xdg-data");
+var _hostsUpdater = require("./hosts-updater");
 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 }; }
 /**
@@ -323,11 +325,32 @@ async function bootstrapLando(options = {}) {
     debug('bootstrapLando() took %d ms', duration);
   }
 }
-async function landoStart(lando, instancePath) {
+const autofixedApps = new WeakSet();
+function installDnsAutofixer(app) {
+  if (autofixedApps.has(app)) {
+    return;
+  }
+  autofixedApps.add(app);
+  app.events.on('post-start', 9, async () => {
+    const urlsToScan = [];
+    app.info.filter(service => service.urls.length).forEach(service => {
+      service.urls.forEach(url => {
+        if (!/^https?:\/\/(localhost|127\.0\.0\.1):/.exec(url) && !url.includes('*')) {
+          urlsToScan.push(url);
+        }
+      });
+    });
+    await tryResolveDomains(urlsToScan, true);
+  });
+}
+async function landoStart(lando, instancePath, autoFixDomainResolution = false) {
   const started = new Date();
   try {
     debug('Will start lando app on path:', instancePath);
     const app = await getLandoApplication(lando, instancePath);
+    if (autoFixDomainResolution) {
+      installDnsAutofixer(app);
+    }
     await app.start();
   } finally {
     const duration = new Date().getTime() - started.getTime();
@@ -351,11 +374,14 @@ async function landoLogs(lando, instancePath, options) {
     debug('landoLogs() took %d ms', duration);
   }
 }
-async function landoRebuild(lando, instancePath) {
+async function landoRebuild(lando, instancePath, autoFixDomainResolution = false) {
   const started = new Date();
   try {
     debug('Will rebuild lando app on path:', instancePath);
     const app = await getLandoApplication(lando, instancePath);
+    if (autoFixDomainResolution) {
+      installDnsAutofixer(app);
+    }
     await ensureNoOrphantProxyContainer(lando);
     await app.rebuild();
   } finally {
@@ -529,7 +555,7 @@ async function getExtraServicesConnections(lando, app) {
   }
   return extraServices;
 }
-async function tryResolveDomains(urls) {
+async function tryResolveDomains(urls, autofix) {
   const domains = [...new Set(urls.filter(url => url.toLowerCase().startsWith('http')).map(url => {
     try {
       return new URL(url).hostname;
@@ -538,6 +564,7 @@ async function tryResolveDomains(urls) {
     }
   }).filter(domain => domain !== undefined))];
   const domainsToFix = [];
+  const pendingWarnings = [];
   for (const domain of domains) {
     try {
       // eslint-disable-next-line no-await-in-loop
@@ -545,20 +572,72 @@ async function tryResolveDomains(urls) {
       debug('%s resolves to %s', domain, address.address);
       if (address.address !== '127.0.0.1') {
         domainsToFix.push(domain);
-        console.warn(_chalk.default.yellow.bold('WARNING:'), `${domain} resolves to ${address.address} instead of 127.0.0.1. Things may not work as expected.`);
+        pendingWarnings.push(`${domain} resolves to ${address.address} instead of 127.0.0.1. Things may not work as expected.`);
       }
     } catch (err) {
       const msg = err instanceof Error ? err.message : 'Unknown error';
       domainsToFix.push(domain);
-      console.warn(_chalk.default.yellow.bold('WARNING:'), `Failed to resolve ${domain}: ${msg}`);
+      pendingWarnings.push(`Failed to resolve ${domain}: ${msg}`);
     }
   }
   if (domainsToFix.length) {
+    if (autofix) {
+      console.log(_chalk.default.green('Attempting to fix domain resolution issues...'));
+      const result = await autofixDomains(domainsToFix);
+      if (result instanceof Error) {
+        // Autofix failed — surface the original DNS warnings so the user knows what went wrong
+        pendingWarnings.forEach(msg => console.warn(_chalk.default.yellow.bold('WARNING:'), msg));
+        console.error(_chalk.default.red(result.message));
+        if (result.cause) {
+          console.error(_chalk.default.red('Cause: '), result.cause.message);
+        }
+      } else {
+        // Autofix succeeded — suppress the warnings so a clean start looks clean
+        console.log(_chalk.default.green('Domain resolution issues fixed successfully.'));
+        return;
+      }
+    } else {
+      pendingWarnings.forEach(msg => console.warn(_chalk.default.yellow.bold('WARNING:'), msg));
+    }
     console.warn(_chalk.default.yellow('Please add the following lines to the hosts file on your system:\n'));
     console.warn(domainsToFix.map(domain => `127.0.0.1 ${domain}`).join('\n'));
     console.warn(_chalk.default.yellow('\nLearn more: https://docs.wpvip.com/vip-local-development-environment/troubleshooting-dev-env/#h-resolve-networking-configuration-issues\n'));
   }
 }
+function ensureError(error) {
+  if (error instanceof Error) {
+    return error;
+  }
+  return new Error(String(error));
+}
+const AUTOFIX_DOWNLOAD_TIMEOUT_MS = 30_000;
+async function autofixDomains(domains) {
+  const dir = await (0, _hostsUpdater.getInstallDir)();
+  const filename = (0, _hostsUpdater.getExeName)();
+  let binary = _nodePath.default.join(dir, filename);
+  try {
+    await (0, _promises2.access)(binary, _promises2.constants.X_OK);
+  } catch {
+    try {
+      binary = await (0, _hostsUpdater.installBinary)('latest', dir, AUTOFIX_DOWNLOAD_TIMEOUT_MS);
+    } catch (err) {
+      return new Error('Failed to install hosts updater binary, cannot autofix domain resolution issues.', {
+        cause: ensureError(err)
+      });
+    }
+  }
+  const fixableDomains = domains.filter(domain => !domain.includes('*'));
+  if (fixableDomains.length) {
+    try {
+      await (0, _hostsUpdater.updateDomains)(binary, fixableDomains);
+    } catch (err) {
+      return new Error('Failed to update hosts file, cannot autofix domain resolution issues.', {
+        cause: ensureError(err)
+      });
+    }
+  }
+  return true;
+}
 async function getRunningServicesForProject(docker, project) {
   const containers = await docker.listContainers({
     filters: {
@@ -579,7 +658,7 @@ async function checkEnvHealth(lando, app) {
     });
   });
   const urlsToScan = Object.keys(urls).filter(url => !url.includes('*'));
-  await tryResolveDomains(urlsToScan);
+  await tryResolveDomains(urlsToScan, false);
   app.urls.forEach(entry => {
     // We use different status codes to see if the service is up.
     // We may consider the service is up when Lando considers it is down.

package/dist/lib/dev-environment/hosts-updater.js

@@ -0,0 +1,184 @@
+"use strict";
+
+exports.__esModule = true;
+exports.InvalidChecksumError = exports.DownloadError = void 0;
+exports.download = download;
+exports.getExeName = getExeName;
+exports.getInstallDir = getInstallDir;
+exports.getReleaseUrl = getReleaseUrl;
+exports.installBinary = installBinary;
+exports.updateDomains = updateDomains;
+var _nodeFetch = _interopRequireDefault(require("node-fetch"));
+var _nodeChild_process = require("node:child_process");
+var _nodeCrypto = require("node:crypto");
+var _nodeFs = require("node:fs");
+var _promises = require("node:fs/promises");
+var _nodeOs = require("node:os");
+var _nodePath = require("node:path");
+var _nodeStream = require("node:stream");
+var _promises2 = require("node:stream/promises");
+var _nodeUtil = require("node:util");
+var _nodeZlib = require("node:zlib");
+var _proxyAgent = require("../http/proxy-agent");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+class DownloadError extends Error {
+  constructor(url, code, options) {
+    super((0, _nodeUtil.format)('Failed to download file: %s (status code: %d)', url, code), options);
+    this.name = 'DownloadError';
+  }
+}
+exports.DownloadError = DownloadError;
+class InvalidChecksumError extends Error {
+  constructor(message, options) {
+    super(message, options);
+    this.name = 'InvalidChecksumError';
+  }
+}
+exports.InvalidChecksumError = InvalidChecksumError;
+const archMap = {
+  ia32: '386',
+  x64: 'amd64',
+  arm64: 'arm64'
+};
+const platformMap = {
+  win32: 'windows',
+  darwin: 'darwin',
+  linux: 'linux'
+};
+function getReleaseUrl(version = 'latest', arch = process.arch, platform = process.platform) {
+  const resolvedArch = archMap[arch];
+  const resolvedPlatform = platformMap[platform];
+  if (!resolvedArch || !resolvedPlatform) {
+    throw new Error('Unsupported platform or architecture');
+  }
+  const suffix = 'windows' === resolvedPlatform ? '.exe' : '';
+  if (version !== 'latest') {
+    const binary = `https://github.com/Automattic/dev-env-update-hosts/releases/download/${version}/dev-env-update-hosts-${resolvedPlatform}-${resolvedArch}${suffix}.gz`;
+    const checksum = `${binary}.sum`;
+    return [binary, checksum];
+  }
+  const binary = `https://github.com/Automattic/dev-env-update-hosts/releases/latest/download/dev-env-update-hosts-${resolvedPlatform}-${resolvedArch}${suffix}.gz`;
+  const checksum = `${binary}.sum`;
+  return [binary, checksum];
+}
+async function download(url, asText, timeout = 0) {
+  const controller = new AbortController();
+  const timeoutId = timeout > 0 ? setTimeout(() => controller.abort(), timeout) : null;
+  const clearTimer = () => {
+    if (timeoutId) {
+      clearTimeout(timeoutId);
+    }
+  };
+  const proxyAgent = (0, _proxyAgent.createProxyAgent)(url.toString());
+  let response;
+  try {
+    response = await (0, _nodeFetch.default)(url, {
+      signal: controller.signal,
+      redirect: 'follow',
+      agent: proxyAgent ?? undefined
+    });
+  } catch (err) {
+    clearTimer();
+    throw err;
+  }
+  if (!response.ok) {
+    clearTimer();
+    throw new DownloadError(url, response.status);
+  }
+  if (asText) {
+    try {
+      return await response.text();
+    } finally {
+      clearTimer();
+    }
+  }
+
+  // For streams: unref the timer so it will not prevent process exit once the
+  // body has been fully consumed, but it will still abort a stalled read while
+  // the event loop is kept alive by the active stream pipeline.
+  timeoutId?.unref();
+  return response.body;
+}
+function getExeName(platform = process.platform, arch = process.arch) {
+  const exeSuffix = platform === 'win32' ? '.exe' : '';
+  return `dev-env-update-host-${platform}-${arch}${exeSuffix}`;
+}
+async function installBinary(version, dest, timeout = 0, arch = process.arch, platform = process.platform) {
+  const [binaryUrl, checksumUrl] = getReleaseUrl(version, arch, platform);
+  const checksum = (await download(new URL(checksumUrl), true, timeout)).trim();
+  const compressedStream = await download(new URL(binaryUrl), false, timeout);
+  if (!compressedStream) {
+    throw new Error('Failed to download binary');
+  }
+  const hash = (0, _nodeCrypto.createHash)('sha256');
+  const hashTap = new _nodeStream.Transform({
+    transform(chunk, _encoding, callback) {
+      hash.update(chunk);
+      callback(null, chunk);
+    }
+  });
+  const destFilename = (0, _nodePath.join)(dest, getExeName(platform, arch));
+  // Use a unique temp name to avoid collisions when multiple processes install concurrently.
+  const tempFilename = `${destFilename}.${(0, _nodeCrypto.randomBytes)(8).toString('hex')}.tmp`;
+  const outStream = (0, _nodeFs.createWriteStream)(tempFilename, {
+    mode: 0o755
+  });
+  let removeTmp = true;
+  try {
+    await (0, _promises2.pipeline)(compressedStream, hashTap, (0, _nodeZlib.createGunzip)(), outStream);
+    const calculatedChecksum = hash.digest('hex');
+    if (!(0, _nodeCrypto.timingSafeEqual)(Buffer.from(calculatedChecksum, 'hex'), Buffer.from(checksum, 'hex'))) {
+      throw new InvalidChecksumError((0, _nodeUtil.format)('Downloaded file checksum does not match expected value (expected: %s, got: %s)', checksum, calculatedChecksum));
+    }
+    await (0, _promises.rename)(tempFilename, destFilename);
+    removeTmp = false;
+  } finally {
+    if (removeTmp) {
+      await (0, _promises.rm)(tempFilename, {
+        force: true
+      }).catch(err => {
+        console.warn('Error removing temporary file %s: %s', tempFilename, err);
+      });
+    }
+  }
+  return destFilename;
+}
+async function getInstallDir() {
+  const binDir = (0, _nodePath.join)((0, _nodePath.dirname)(__dirname), 'bin');
+  try {
+    await (0, _promises.mkdir)(binDir, {
+      recursive: true
+    });
+    await (0, _promises.access)(binDir, _promises.constants.W_OK);
+    return binDir;
+  } catch {
+    // Swallow errors and fall back to a temporary directory
+  }
+  const tmpDir = await (0, _promises.mkdtemp)((0, _nodePath.join)((0, _nodeOs.tmpdir)(), 'dev-env-update-hosts-'));
+  process.once('exit', () => {
+    try {
+      (0, _nodeFs.rmSync)(tmpDir, {
+        recursive: true,
+        force: true
+      });
+    } catch (err) {
+      console.warn('Error removing temporary dir: %s', err);
+    }
+  });
+  return tmpDir;
+}
+function updateDomains(binary, domains) {
+  return new Promise((resolve, reject) => {
+    const child = (0, _nodeChild_process.spawn)(binary, domains, {
+      stdio: 'inherit'
+    });
+    child.on('error', err => reject(err));
+    child.on('exit', code => {
+      if (code === 0) {
+        resolve();
+      } else {
+        reject(new Error(`Binary exited with code ${code}`));
+      }
+    });
+  });
+}

package/npm-shrinkwrap.json

@@ -1,16 +1,16 @@
 {
   "name": "@automattic/vip",
-  "version": "3.25.2",
+  "version": "3.25.3-dev.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@automattic/vip",
-      "version": "3.25.2",
+      "version": "3.25.3-dev.0",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {
-        "@apollo/client": "4.1.8",
+        "@apollo/client": "4.1.9",
         "@automattic/vip-search-replace": "^2.0.0",
         "@json2csv/plainjs": "^7.0.3",
         "@wwa/single-line-log": "^1.1.4",
@@ -143,15 +143,10 @@
       }
     },
     "node_modules/@apollo/client": {
-      "version": "4.1.8",
-      "resolved": "https://registry.npmjs.org/@apollo/client/-/client-4.1.8.tgz",
-      "integrity": "sha512-0joBqkgwxDTzAni0azryXQjbSIKBFqfzEa1eh8KX6aWl4RHWAlfNwZAaWlIpOYWTeRnSZu2glnyGiHGPMAAerA==",
+      "version": "4.1.9",
+      "resolved": "https://registry.npmjs.org/@apollo/client/-/client-4.1.9.tgz",
+      "integrity": "sha512-qfpkQD51tdU/7iAR6aLb4w9o/L7I475DluWHRb61U/3Q0AH29nNOxOBHjBbWDdf16ncPOoQuxne1sEs2NjqBFw==",
       "license": "MIT",
-      "workspaces": [
-        "dist",
-        "codegen",
-        "scripts/codemods/ac3-to-ac4"
-      ],
       "dependencies": {
         "@graphql-typed-document-node/core": "^3.1.1",
         "@wry/caches": "^1.0.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "3.25.2",
+  "version": "3.25.3-dev.0",
   "description": "The VIP Javascript library & CLI",
   "main": "index.js",
   "bin": {
@@ -138,7 +138,7 @@
     "typescript": "^6.0.2"
   },
   "dependencies": {
-    "@apollo/client": "4.1.8",
+    "@apollo/client": "4.1.9",
     "@automattic/vip-search-replace": "^2.0.0",
     "@json2csv/plainjs": "^7.0.3",
     "@wwa/single-line-log": "^1.1.4",