@automattic/vip 3.25.0 → 3.25.2-dev.0

package/AGENTS.md

@@ -72,6 +72,12 @@ Guide for future agents working on this codebase. Focus on traps, cross-cutting
 - `prepare` runs `npm run clean && npm run build`; npm package bins point to `dist/**`. Always rebuild before publishing so dist matches src.
 - `helpers/prepublishOnly.js` enforces branch `trunk` for `npm publish --tag latest` and optionally reruns `npm test`. Release flows expect a clean node version that satisfies `engines.node`.
 
+## Standalone SEA Packaging
+
+- Canonical runbook for standalone executable build/signing is in `docs/SEA-BUILD-SIGNING.md`. Use it for macOS, Linux, Windows native, and WSL-mediated Windows builds.
+- SEA builds are Node 22 only (enforced in `helpers/build-sea.js`); always verify `node -v` before `npm run build:sea`.
+- The executable is self-contained for Node runtime + JS deps, but `dev-env` commands still require host Docker/Compose availability.
+
 ## Common Pitfalls Checklist
 
 - Running CLI without a token opens a browser (`open`) and waits for interactive input—pass `--help` or set `WPVIP_DEPLOY_TOKEN` in automation.

package/CLAUDE.md

@@ -1,3 +1,4 @@
 # CLAUDE
 
 For guidance on working in this repo, traps, and migration notes, see `AGENTS.md`.
+For standalone SEA build/signing by platform, see `docs/SEA-BUILD-SIGNING.md`.

package/assets/dev-env.lando.template.yml.ejs

@@ -218,6 +218,8 @@ services:
       environment:
         LANDO_NO_SCRIPTS: 1
         LANDO_NEEDS_EXEC: 1
+        LANDO_HOST_UID: ${LANDO_HOST_USER_ID}
+        LANDO_HOST_GID: ${LANDO_HOST_GROUP_ID}
     volumes:
       mu-plugins: {}
     initOnly: true
@@ -237,6 +239,9 @@ services:
         - clientcode_private:/clientcode/private
         - clientcode_themes:/clientcode/themes
         - clientcode_vipconfig:/clientcode/vip-config
+      environment:
+        LANDO_HOST_UID: ${LANDO_HOST_USER_ID}
+        LANDO_HOST_GID: ${LANDO_HOST_GROUP_ID}
     volumes:
       clientcode_clientmuPlugins: {}
       clientcode_images: {}

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

@@ -10,6 +10,23 @@ var _userError = _interopRequireDefault(require("../lib/user-error"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const exampleUsage = 'vip dev-env exec';
 const usage = 'vip dev-env exec';
+const ENV_UP_CHECK_ATTEMPTS = 5;
+const ENV_UP_CHECK_DELAY_MS = 1500;
+const sleep = ms => new Promise(resolve => setTimeout(resolve, ms));
+async function waitForEnvironmentReadiness(lando, slug) {
+  const instancePath = (0, _devEnvironmentCore.getEnvironmentPath)(slug);
+  return pollEnvironmentReadiness(lando, instancePath, 1);
+}
+async function pollEnvironmentReadiness(lando, instancePath, attempt) {
+  if (await (0, _devEnvironmentLando.isEnvUp)(lando, instancePath)) {
+    return true;
+  }
+  if (attempt >= ENV_UP_CHECK_ATTEMPTS) {
+    return false;
+  }
+  await sleep(ENV_UP_CHECK_DELAY_MS);
+  return pollEnvironmentReadiness(lando, instancePath, attempt + 1);
+}
 const examples = [{
   usage: `${exampleUsage} --slug=example-site -- wp post list`,
   description: 'Run a WP-CLI command against a local environment named "example-site".\n' + '      * A double dash ("--") must separate the arguments of "vip" from those of the "wp" command.'
@@ -46,7 +63,7 @@ const examples = [{
       arg = process.argv.slice(argSplitterIx + 1);
     }
     if (!opt.force) {
-      const isUp = await (0, _devEnvironmentLando.isEnvUp)(lando, (0, _devEnvironmentCore.getEnvironmentPath)(slug));
+      const isUp = await waitForEnvironmentReadiness(lando, slug);
       if (!isUp) {
         throw new _userError.default('A WP-CLI command can only be executed on a running local environment.');
       }

package/dist/bin/vip-import.js

@@ -4,6 +4,6 @@
 var _command = _interopRequireDefault(require("../lib/cli/command"));
 var _tracker = require("../lib/tracker");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-(0, _command.default)().command('sql', 'Import a SQL database file to an environment.').command('validate-sql', 'Validate a local SQL database file prior to import.').command('validate-files', 'Validate the directory structure and contents of a local media file directory prior to archiving and uploading it to a publicly accessible URL.').command('media', 'Import media files to an environment from an archived file located at a publicly accessible URL.').example('vip @example-app.develop import sql example-file.sql', 'Import the local SQL database file "example-file.sql" to the develop environment.').example('vip @example-app.production import media https://www.example.com/uploads.tar.gz', 'Import an archived file from a publicly accessible URL to the production environment.').argv(process.argv, async () => {
+(0, _command.default)().command('sql', 'Import a SQL database file to an environment.').command('validate-sql', 'Validate a local SQL database file prior to import.').command('validate-files', 'Validate that the directory structure and contents of a local media file directory can be successfully imported.').command('media', 'Import media files to a production environment from an archived file at a local path or a publicly accessible remote URL.').example('vip @example-app.develop import sql example-file.sql', 'Import the local SQL database file "example-file.sql" to the develop environment.').example('vip @example-app.production import media https://www.example.com/uploads.tar.gz', 'Import an archived file from a publicly accessible URL to the production environment.').argv(process.argv, async () => {
   await (0, _tracker.trackEvent)('vip_import_command_execute');
 });

package/dist/bin/vip-sea.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+"use strict";
+
+var _seaDispatch = require("../lib/cli/sea-dispatch");
+var _seaRuntime = require("../lib/cli/sea-runtime");
+const run = async () => {
+  if ((0, _seaDispatch.isSeaRuntime)()) {
+    process.env.VIP_CLI_SEA_MODE = '1';
+    await (0, _seaRuntime.prepareSeaRuntimeFilesystem)();
+    const resolution = (0, _seaDispatch.resolveInternalBinFromArgv)(process.argv);
+    if (resolution.bin !== 'vip') {
+      process.env.VIP_CLI_TARGET_BIN = resolution.bin;
+      process.env.VIP_CLI_TARGET_START = String(resolution.start);
+      process.env.VIP_CLI_TARGET_LENGTH = String(resolution.length);
+    }
+  }
+  await import('./vip.js');
+};
+void run();

package/dist/bin/vip.js

@@ -7,6 +7,8 @@ var _debug = _interopRequireDefault(require("debug"));
 var _enquirer = require("enquirer");
 var _command = _interopRequireWildcard(require("../lib/cli/command"));
 var _config = _interopRequireDefault(require("../lib/cli/config"));
+var _internalBinLoader = require("../lib/cli/internal-bin-loader");
+var _seaDispatch = require("../lib/cli/sea-dispatch");
 var _token = _interopRequireDefault(require("../lib/token"));
 var _tracker = require("../lib/tracker");
 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); }
@@ -20,10 +22,28 @@ if (_config.default && _config.default.environment !== 'production') {
 // Config
 const tokenURL = 'https://dashboard.wpvip.com/me/cli/token';
 const customDeployToken = process.env.WPVIP_DEPLOY_TOKEN;
+async function maybeExecuteSeaTargetCommand() {
+  const targetBin = process.env.VIP_CLI_TARGET_BIN;
+  if (!(0, _seaDispatch.isSeaRuntime)() || !targetBin || targetBin === 'vip') {
+    return false;
+  }
+  const start = Number(process.env.VIP_CLI_TARGET_START ?? '0');
+  const length = Number(process.env.VIP_CLI_TARGET_LENGTH ?? '0');
+  const resolution = {
+    start: Number.isInteger(start) ? start : 0,
+    length: Number.isInteger(length) ? length : 0
+  };
+  process.argv = (0, _seaDispatch.rewriteArgvForInternalBin)(process.argv, resolution);
+  const loaded = await (0, _internalBinLoader.loadInternalBin)(targetBin);
+  if (!loaded) {
+    throw new Error(`Unable to load SEA command target "${targetBin}"`);
+  }
+  return true;
+}
 const runCmd = async function () {
   const cmd = (0, _command.default)();
   cmd.command('logout', 'Log out the current authenticated VIP-CLI user.').command('app', 'Interact with applications that the current authenticated VIP-CLI user has permission to access.').command('backup', 'Generate a backup of an environment.').command('cache', 'Manage page cache for an environment.').command('config', 'Manage environment configurations.').command('dev-env', 'Create and manage VIP Local Development Environments.').command('export', 'Export a copy of data associated with an environment.').command('import', 'Import media or SQL database files to an environment.').command('logs', 'Retrieve Runtime Logs from an environment.').command('search-replace', 'Search for a string in a local SQL file and replace it with a new string.').command('slowlogs', 'Retrieve MySQL slow query logs from an environment.').command('db', "Access an environment's database.").command('sync', 'Sync the database from production to a non-production environment.').command('whoami', 'Retrieve details about the current authenticated VIP-CLI user.').command('wp', 'Execute a WP-CLI command against an environment.');
-  cmd.argv(process.argv);
+  await cmd.argv(process.argv);
 };
 
 /**
@@ -34,7 +54,89 @@ const runCmd = async function () {
 function doesArgvHaveAtLeastOneParam(argv, params) {
   return argv.some(arg => params.includes(arg));
 }
+async function runLoginFlow() {
+  console.log();
+  console.log('   _    __ ________         ________    ____');
+  console.log('  | |  / //  _/ __        / ____/ /   /  _/');
+  console.log('  | | / / / // /_/ /______/ /   / /    / /  ');
+  console.log('  | |/ /_/ // ____//_____/ /___/ /____/ /   ');
+  console.log('  |___//___/_/           ____/_____/___/   ');
+  console.log();
+  console.log('  VIP-CLI is your tool for interacting with and managing your VIP applications.');
+  console.log();
+  console.log('  Authenticate your installation of VIP-CLI with your Personal Access Token. This URL will be opened in your web browser automatically so that you can retrieve your token: ' + tokenURL);
+  console.log();
+  await (0, _tracker.trackEvent)('login_command_execute');
+  const answer = await (0, _enquirer.prompt)({
+    type: 'confirm',
+    name: 'continue',
+    message: 'Ready to authenticate?'
+  });
+  if (!answer.continue) {
+    await (0, _tracker.trackEvent)('login_command_browser_cancelled');
+    return null;
+  }
+  const {
+    default: open
+  } = await import('open');
+  open(tokenURL, {
+    wait: false
+  });
+  await (0, _tracker.trackEvent)('login_command_browser_opened');
+  const {
+    token: tokenInput
+  } = await (0, _enquirer.prompt)({
+    type: 'password',
+    name: 'token',
+    message: 'Access Token:'
+  });
+  let token;
+  try {
+    token = new _token.default(tokenInput);
+  } catch (err) {
+    console.log('The token provided is malformed. Please check the token and try again.');
+    await (0, _tracker.trackEvent)('login_command_token_submit_error', {
+      error: err.message
+    });
+    return null;
+  }
+  if (token.expired()) {
+    console.log('The token provided is expired. Please log in again to refresh the token.');
+    await (0, _tracker.trackEvent)('login_command_token_submit_error', {
+      error: 'expired'
+    });
+    return null;
+  }
+  if (!token.valid()) {
+    console.log('The provided token is not valid. Please log in again to refresh the token.');
+    await (0, _tracker.trackEvent)('login_command_token_submit_error', {
+      error: 'invalid'
+    });
+    return null;
+  }
+  try {
+    await _token.default.set(token.raw);
+  } catch (err) {
+    await (0, _tracker.trackEvent)('login_command_token_submit_error', {
+      error: err.message
+    });
+    throw err;
+  }
+
+  // De-anonymize user for tracking
+  await (0, _tracker.aliasUser)(token.id);
+  await (0, _tracker.trackEvent)('login_command_token_submit_success');
+  return token;
+}
 const rootCmd = async function () {
+  if ((0, _seaDispatch.isSeaRuntime)() && !process.env.VIP_CLI_TARGET_BIN) {
+    const resolution = (0, _seaDispatch.resolveInternalBinFromArgv)(process.argv);
+    if (resolution.bin !== 'vip') {
+      process.env.VIP_CLI_TARGET_BIN = resolution.bin;
+      process.env.VIP_CLI_TARGET_START = String(resolution.start);
+      process.env.VIP_CLI_TARGET_LENGTH = String(resolution.length);
+    }
+  }
   let token = await _token.default.get();
   const isHelpCommand = doesArgvHaveAtLeastOneParam(process.argv, ['help', '-h', '--help']);
   const isVersionCommand = doesArgvHaveAtLeastOneParam(process.argv, ['-v', '--version']);
@@ -44,82 +146,22 @@ const rootCmd = async function () {
   const isCustomDeployCmdWithKey = doesArgvHaveAtLeastOneParam(process.argv, ['deploy']) && Boolean(customDeployToken);
   debug('Argv:', process.argv);
   if (!isLoginCommand && (isLogoutCommand || isHelpCommand || isVersionCommand || isDevEnvCommandWithoutEnv || token?.valid() || isCustomDeployCmdWithKey)) {
-    await runCmd();
-  } else {
-    console.log();
-    console.log('   _    __ ________         ________    ____');
-    console.log('  | |  / //  _/ __        / ____/ /   /  _/');
-    console.log('  | | / / / // /_/ /______/ /   / /    / /  ');
-    console.log('  | |/ /_/ // ____//_____/ /___/ /____/ /   ');
-    console.log('  |___//___/_/           ____/_____/___/   ');
-    console.log();
-    console.log('  VIP-CLI is your tool for interacting with and managing your VIP applications.');
-    console.log();
-    console.log('  Authenticate your installation of VIP-CLI with your Personal Access Token. This URL will be opened in your web browser automatically so that you can retrieve your token: ' + tokenURL);
-    console.log();
-    await (0, _tracker.trackEvent)('login_command_execute');
-    const answer = await (0, _enquirer.prompt)({
-      type: 'confirm',
-      name: 'continue',
-      message: 'Ready to authenticate?'
-    });
-    if (!answer.continue) {
-      await (0, _tracker.trackEvent)('login_command_browser_cancelled');
-      return;
-    }
-    const {
-      default: open
-    } = await import('open');
-    open(tokenURL, {
-      wait: false
-    });
-    await (0, _tracker.trackEvent)('login_command_browser_opened');
-    const {
-      token: tokenInput
-    } = await (0, _enquirer.prompt)({
-      type: 'password',
-      name: 'token',
-      message: 'Access Token:'
-    });
-    try {
-      token = new _token.default(tokenInput);
-    } catch (err) {
-      console.log('The token provided is malformed. Please check the token and try again.');
-      await (0, _tracker.trackEvent)('login_command_token_submit_error', {
-        error: err.message
-      });
+    if (await maybeExecuteSeaTargetCommand()) {
       return;
     }
-    if (token.expired()) {
-      console.log('The token provided is expired. Please log in again to refresh the token.');
-      await (0, _tracker.trackEvent)('login_command_token_submit_error', {
-        error: 'expired'
-      });
-      return;
-    }
-    if (!token.valid()) {
-      console.log('The provided token is not valid. Please log in again to refresh the token.');
-      await (0, _tracker.trackEvent)('login_command_token_submit_error', {
-        error: 'invalid'
-      });
+    await runCmd();
+  } else {
+    token = await runLoginFlow();
+    if (!token) {
       return;
     }
-    try {
-      await _token.default.set(token.raw);
-    } catch (err) {
-      await (0, _tracker.trackEvent)('login_command_token_submit_error', {
-        error: err.message
-      });
-      throw err;
-    }
-
-    // De-anonymize user for tracking
-    await (0, _tracker.aliasUser)(token.id);
-    await (0, _tracker.trackEvent)('login_command_token_submit_success');
     if (isLoginCommand) {
       console.log('You are now logged in - see `vip -h` for a list of available commands.');
       process.exit();
     }
+    if (await maybeExecuteSeaTargetCommand()) {
+      return;
+    }
     await runCmd();
   }
 };

package/dist/commands/dev-env-import-sql.js

@@ -115,7 +115,7 @@ class DevEnvImportSQLCommand {
       if (!dumpDetails.sourceDb) {
         console.log(`${_chalk.default.yellow('!')} Unable to identify source DB. Skipping myloader source-db option`);
       }
-      importArg = ['db-myloader', '--overwrite-tables', ...(dumpDetails.sourceDb ? [`--source-db=${dumpDetails.sourceDb}`] : []), `--threads=${threadCount}`, '--max-threads-for-schema-creation=10', '--max-threads-for-index-creation=10', '--skip-triggers', '--skip-post', '--innodb-optimize-keys', '--checksum=SKIP', '--metadata-refresh-interval=2000000', '--stream'].concat(this.options.quiet ? ['--verbose=0'] : ['--verbose=3']);
+      importArg = ['db-myloader', '--overwrite-tables', ...(dumpDetails.sourceDb ? [`--source-db=${dumpDetails.sourceDb}`] : []), `--threads=${threadCount}`, '--max-threads-for-schema-creation=10', '--max-threads-for-index-creation=10', '--skip-triggers', '--skip-post', '--optimize-keys', '--checksum=SKIP', '--metadata-refresh-interval=2000000', '--stream'].concat(this.options.quiet ? ['--verbose=0'] : ['--verbose=3']);
     }
     return importArg;
   }