@automattic/vip 3.12.2 → 3.14.0

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

@@ -35,6 +35,8 @@ services:
       image: <%= php %>
       command: run.sh
       working_dir: /wp
+      env_file:
+        - .env
       environment:
         XDEBUG: <%= xdebug ? 'enable' : 'disable' %>
 <% if ( xdebugConfig ) { %>

package/dist/bin/vip-config-envvar-delete.js

@@ -81,4 +81,4 @@ async function deleteEnvVarCommand(arg, opt) {
   envContext: true,
   requiredArgs: 1,
   usage: `${baseUsage} <VARIABLE_NAME>`
-}).examples(examples).option('skip-confirmation', 'Skip manual confirmation of input (USE WITH CAUTION)', false).argv(process.argv, deleteEnvVarCommand);
+}).examples(examples).option('skip-confirmation', 'Skip the confirmation prompt (USE WITH CAUTION).', false).argv(process.argv, deleteEnvVarCommand);

package/dist/bin/vip-config-envvar-set.js

@@ -100,4 +100,4 @@ async function setEnvVarCommand(arg, opt) {
   envContext: true,
   requiredArgs: 1,
   usage: `${baseUsage} <VARIABLE_NAME>`
-}).option('from-file', 'Read environment variable value from file (useful for multiline input)').option('skip-confirmation', 'Skip manual confirmation of input (USE WITH CAUTION)', false).examples(examples).argv(process.argv, setEnvVarCommand);
+}).option('from-file', 'Read environment variable value from a UTF-8-encoded text file (useful for multiline input). Accepts a relative or absolute path.').option('skip-confirmation', 'Skip the confirmation prompt (USE WITH CAUTION).', false).examples(examples).argv(process.argv, setEnvVarCommand);

package/dist/bin/vip-config-envvar.js

@@ -8,8 +8,8 @@ const exampleUsage = 'vip @example-app.develop config envvar';
 
 // Command examples
 const examples = [{
-  usage: `${exampleUsage} delete MY_VARIABLE`,
-  description: 'Delete the environment variable "MY_VARIABLE" from the environment.'
+  usage: `${exampleUsage} set MY_VARIABLE`,
+  description: 'Add or update the environment variable "MY_VARIABLE" and assign its value at the prompt.'
 }, {
   usage: `${exampleUsage} get MY_VARIABLE`,
   description: 'Retrieve the value of the environment variable "MY_VARIABLE".'
@@ -20,8 +20,8 @@ const examples = [{
   usage: `${exampleUsage} list`,
   description: 'List the names of all environment variables.'
 }, {
-  usage: `${exampleUsage} set MY_VARIABLE`,
-  description: 'Add or update the environment variable "MY_VARIABLE" and assign its value at the prompt.'
+  usage: `${exampleUsage} delete MY_VARIABLE`,
+  description: 'Delete the environment variable "MY_VARIABLE" from the environment.'
 }];
 (0, _command.default)({
   requiredArgs: 0,

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

@@ -69,10 +69,13 @@ cmd.argv(process.argv, async (arg, opt) => {
   let defaultOptions = {};
   /** @type {Record<string,import('../lib/dev-environment/types').IntegrationConfig>} */
   let integrationsConfig = {};
+  /** @type {Record<string,string>} */
+  let envVars = {};
   try {
     if (opt.app) {
       const appInfo = await (0, _devEnvironmentCore.getApplicationInformation)(opt.app, opt.env);
       integrationsConfig = appInfo.environment?.integrations ?? {};
+      envVars = appInfo.environment?.envVars ?? {};
       defaultOptions = (0, _devEnvironmentCli.getOptionsFromAppInfo)(appInfo);
     }
   } catch (error) {
@@ -90,7 +93,7 @@ cmd.argv(process.argv, async (arg, opt) => {
   const instanceData = await (0, _devEnvironmentCli.promptForArguments)(preselectedOptions, defaultOptions, suppressPrompts, true);
   instanceData.siteSlug = slug;
   try {
-    await (0, _devEnvironmentCore.createEnvironment)(lando, instanceData, integrationsConfig);
+    await (0, _devEnvironmentCore.createEnvironment)(lando, instanceData, integrationsConfig, envVars);
     await (0, _devEnvironmentCore.printEnvironmentInfo)(lando, slug, {
       extended: false,
       suppressWarnings: true

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

@@ -21,17 +21,24 @@ const examples = [{
   usage: `${exampleUsage} --skip-rebuild --slug=example-site`,
   description: 'Start only the services of a local environment that are not currently in a running state.'
 }, {
-  usage: `${exampleUsage} --vscode --slug=example-site`,
+  usage: `${exampleUsage} --editor=vscode --slug=example-site`,
   description: 'Start a local environment and generate a Workspace file for developing in Visual Studio Code.'
+}, {
+  usage: `${exampleUsage} --editor=cursor --slug=example-site`,
+  description: 'Start a local environment and generate a Workspace file for developing in Cursor Editor.'
+}, {
+  usage: `${exampleUsage} --editor=phpstorm --slug=example-site`,
+  description: 'Start a local environment and generate a Workspace file for developing in PhpStorm.'
 }];
 (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.').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).').examples(examples).argv(process.argv, async (arg, opt) => {
   const slug = await (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const lando = await (0, _devEnvironmentLando.bootstrapLando)();
   (0, _devEnvironmentCli.validateDependencies)(lando);
   const startProcessing = new Date();
   const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);
+  trackingInfo.editor = opt.editor || (opt.vscode ? 'vscode' : undefined);
   trackingInfo.vscode = Boolean(opt.vscode);
   trackingInfo.docker = lando.config.versions.engine;
   trackingInfo.docker_compose = lando.config.versions.compose;
@@ -55,6 +62,7 @@ const examples = [{
     process.exitCode = 1;
   }
   (0, _devEnvironmentCli.postStart)(slug, {
-    openVSCode: Boolean(opt.vscode)
+    editor: opt.editor,
+    vscode: Boolean(opt.vscode)
   });
 });

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

@@ -3,6 +3,10 @@
 
 var _command = _interopRequireDefault(require("../lib/cli/command"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+if (process.getuid?.() === 0) {
+  console.error('This script should not be run as root. Exiting.');
+  process.exit(1);
+}
 (0, _command.default)({
   requiredArgs: 0
 }).command('create', 'Create a new local environment.').command('update', 'Update the settings of a local environment.').command('start', 'Start a local environment.').command('stop', 'Stop a local environment.').command('destroy', 'Remove a local environment.').command('info', 'Retrieve information about a local environment.').command('list', 'Retrieve information about all local environments.').command('exec', 'Run a WP-CLI command against a local environment.').command('import', 'Import media or database files to a local environment.').command('shell', 'Create a shell and run commands against a local environment.').command('logs', 'Retrieve logs for a local environment.').command('sync', 'Sync the database of a VIP Platform environment to a local environment.').command('purge', 'Remove all local environments.').argv(process.argv);

package/dist/bin/vip-sync.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 "use strict";
 
+var _singleLineLog = require("@wwa/single-line-log");
 var _chalk = _interopRequireDefault(require("chalk"));
 var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
-var _singleLineLog = require("single-line-log");
 var _api = _interopRequireDefault(require("../lib/api"));
 var _app2 = _interopRequireDefault(require("../lib/api/app"));
 var _command = _interopRequireDefault(require("../lib/cli/command"));

package/dist/bin/vip-wp.js

@@ -8,6 +8,7 @@ var _readline = _interopRequireDefault(require("readline"));
 var _socket = _interopRequireDefault(require("socket.io-client"));
 var _socket2 = _interopRequireDefault(require("socket.io-stream"));
 var _stream = require("stream");
+var _wpSsh = require("../commands/wp-ssh");
 var _api = _interopRequireWildcard(require("../lib/api"));
 var _command = _interopRequireWildcard(require("../lib/cli/command"));
 var exit = _interopRequireWildcard(require("../lib/cli/exit"));
@@ -30,6 +31,7 @@ const appQuery = `id, name,
 	appId
 	type
 	name
+	wpcliStrategy
 	primaryDomain {
 		name
 	}
@@ -330,6 +332,13 @@ const examples = [{
   (0, _api.disableGlobalGraphQLErrorHandling)();
   const promptIdentifier = `${appName}.${(0, _command.getEnvIdentifier)(opts.env)}`;
   let countSIGINT = 0;
+  if (opts.env.wpcliStrategy === 'ssh') {
+    const wpCommandRunner = new _wpSsh.WPCliCommandOverSSH(opts.app, opts.env);
+    await wpCommandRunner.run(cmd, {
+      command: commandForAnalytics
+    });
+    return;
+  }
   const mutableStdout = new _stream.Writable({
     write(chunk, encoding, callback) {
       if (!this.muted) {

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

@@ -67,8 +67,9 @@ async function extractSiteUrls(sqlFile) {
   return new Promise((resolve, reject) => {
     const urls = new Set();
     readInterface.on('line', line => {
-      const url = findSiteHomeUrl(line);
+      let url = findSiteHomeUrl(line);
       if (url) {
+        url = url.replace(/\/$/, '');
         urls.add(url);
       }
     });
@@ -178,7 +179,7 @@ class DevEnvSyncSQLCommand {
       if (!site?.blogId || site.blogId === 1) continue;
       const url = site?.homeUrl;
       if (!url) continue;
-      const strippedUrl = stripProtocol(url);
+      const strippedUrl = stripProtocol(url).replace(/\/$/, '');
       if (!this.searchReplaceMap[strippedUrl]) continue;
       const domain = new URL(url).hostname;
       const newDomain = primaryDomain === domain ? this.landoDomain : `${this.slugifyDomain(domain)}.${this.landoDomain}`;

package/dist/commands/wp-ssh.js

@@ -0,0 +1,213 @@
+"use strict";
+
+exports.__esModule = true;
+exports.WPCliCommandOverSSH = exports.NonZeroExitCodeError = void 0;
+var _chalk = _interopRequireDefault(require("chalk"));
+var _debug = _interopRequireDefault(require("debug"));
+var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
+var ssh2 = _interopRequireWildcard(require("ssh2"));
+var _package = _interopRequireDefault(require("../../package.json"));
+var _api = _interopRequireDefault(require("../lib/api"));
+var _tracker = require("../lib/tracker");
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+
+const debug = (0, _debug.default)('@automattic/vip:wp/ssh');
+const NON_TTY_COLUMNS = 100;
+const NON_TTY_ROWS = 15;
+const SSH_HANDSHAKE_TIMEOUT_MS = 5000;
+const TRIGGER_WP_CLI_COMMAND_MUTATION = (0, _graphqlTag.default)`
+	mutation TriggerWPCLICommandMutation($input: AppEnvironmentTriggerWPCLICommandInput) {
+		triggerWPCLICommandOnAppEnvironment(input: $input) {
+			inputToken
+			sshAuthentication {
+				host
+				port
+				username
+				privateKey
+				passphrase
+			}
+			command {
+				guid
+			}
+		}
+	}
+`;
+class NonZeroExitCodeError extends Error {
+  exitCode;
+  constructor(message, exitCode) {
+    super(message);
+    this.exitCode = exitCode;
+  }
+}
+exports.NonZeroExitCodeError = NonZeroExitCodeError;
+class WPCliCommandOverSSH {
+  app;
+  env;
+  track;
+  constructor(app, env) {
+    this.app = app;
+    this.env = env;
+    this.track = (0, _tracker.makeCommandTracker)('wp', {
+      app: this.app.id,
+      env: this.env.id,
+      execution_type: 'ssh'
+    });
+  }
+  async run(command, extraTrackingInfo = {}) {
+    if (!this.app.id || !this.env.id) {
+      await this.track('error', {
+        error: 'no_app_env_id',
+        message: 'No app or env ID provided',
+        ...extraTrackingInfo
+      });
+      throw new Error('No app ID or environment ID provided');
+    }
+    debug("Requesting SSH authentication for command '%s'", command);
+    const sshAuth = await this.getSSHAuthForCommand(command, extraTrackingInfo);
+    const data = sshAuth.data?.triggerWPCLICommandOnAppEnvironment;
+    if (!data) {
+      await this.track('error', {
+        error: 'no_ssh_auth_data',
+        message: 'No SSH authentication data received',
+        ...extraTrackingInfo
+      });
+      throw new Error('WP-CLI SSH Authentication failed');
+    }
+    debug('Connecting to SSH', {
+      host: data.sshAuthentication.host,
+      port: data.sshAuthentication.port,
+      username: data.sshAuthentication.username,
+      guid: data.command.guid
+    });
+    try {
+      await this.executeCommandOverSSH({
+        host: data.sshAuthentication.host,
+        port: data.sshAuthentication.port,
+        username: data.sshAuthentication.username,
+        privateKey: data.sshAuthentication.privateKey,
+        passphrase: data.sshAuthentication.passphrase,
+        guid: data.command.guid,
+        inputToken: data.inputToken
+      });
+      await this.track('success', {
+        guid: data?.command.guid
+      });
+    } catch (err) {
+      if (err instanceof NonZeroExitCodeError) {
+        await this.track('error', {
+          guid: data?.command.guid,
+          error: 'non_zero_exit_code',
+          message: `Command failed with exit code ${err.exitCode}`,
+          ...extraTrackingInfo
+        });
+        process.exit(err.exitCode);
+      }
+      const message = err instanceof Error ? err.message : String(err);
+      console.error(`${_chalk.default.red('Error:')} ${message}`);
+      await this.track('error', {
+        guid: data?.command.guid,
+        error: 'ssh_command_failed',
+        message: 'Error executing command over SSH',
+        ...extraTrackingInfo
+      });
+      process.exit(1);
+    }
+  }
+  async executeCommandOverSSH({
+    host,
+    port,
+    username,
+    privateKey,
+    passphrase,
+    guid,
+    inputToken
+  }) {
+    return new Promise((resolve, reject) => {
+      const conn = new ssh2.Client();
+      const columns = process.stdout.columns || NON_TTY_COLUMNS;
+      const rows = process.stdout.rows || NON_TTY_ROWS;
+      const isTTY = process.stdout.isTTY ? 'true' : 'false';
+      let commandStarted = false;
+      conn.on('ready', () => {
+        conn.exec(`GUID=${guid} INPUT_TOKEN=${inputToken} VERSION=${_package.default.version} ROWS=${rows} COLUMNS=${columns} TTY=${isTTY}`, (err, stream) => {
+          if (err) {
+            reject(err);
+            return;
+          }
+          stream.on('exit', exitCode => {
+            if (exitCode !== 0) {
+              reject(new NonZeroExitCodeError(`Command failed`, exitCode));
+            }
+          });
+          commandStarted = true;
+          const handleSIGINT = () => {
+            process.removeListener('SIGINT', handleSIGINT);
+            console.log('SIGINT received. Canceling command...');
+            stream.end('\x03');
+          };
+          process.on('SIGINT', handleSIGINT);
+          const handleSIGTERM = () => {
+            process.removeListener('SIGTERM', handleSIGTERM);
+            console.log('SIGTERM received. Canceling command...');
+            stream.end('\x1F');
+          };
+          process.on('SIGTERM', handleSIGTERM);
+          stream.pipe(process.stdout);
+          process.stdin.pipe(stream);
+          stream.on('close', () => {
+            process.removeListener('SIGINT', handleSIGINT);
+            process.removeListener('SIGTERM', handleSIGTERM);
+            conn.end();
+            resolve();
+          });
+        });
+      }).on('error', err => {
+        reject(err);
+      }).on('close', () => {
+        if (!commandStarted) {
+          reject(new Error('Connection closed before command started'));
+        }
+      }).connect({
+        host,
+        port,
+        username,
+        privateKey,
+        passphrase,
+        readyTimeout: SSH_HANDSHAKE_TIMEOUT_MS
+      });
+    });
+  }
+  async getSSHAuthForCommand(command, extraTrackingInfo) {
+    const api = (0, _api.default)();
+    try {
+      return api.mutate({
+        mutation: TRIGGER_WP_CLI_COMMAND_MUTATION,
+        variables: {
+          input: {
+            id: this.app.id,
+            environmentId: this.env.id,
+            command
+          }
+        }
+      });
+    } catch (error) {
+      const message = error instanceof Error ? error.message : String(error);
+      await this.track('error', {
+        error: 'trigger_failed',
+        message,
+        ...extraTrackingInfo
+      });
+      throw new Error(`Unable to trigger the WP-CLI command`);
+    }
+  }
+}
+exports.WPCliCommandOverSSH = WPCliCommandOverSSH;

package/dist/lib/cli/progress.js

@@ -2,8 +2,8 @@
 
 exports.__esModule = true;
 exports.StepStatus = exports.ProgressTracker = void 0;
+var _singleLineLog = require("@wwa/single-line-log");
 var _nodeOs = require("node:os");
-var _singleLineLog = require("single-line-log");
 var _format = require("../../lib/cli/format");
 const PRINT_INTERVAL = process.env.DEBUG ? 5000 : 200; // How often the report is printed. Mainly affects the "spinner" animation.
 let StepStatus = exports.StepStatus = /*#__PURE__*/function (StepStatus) {