@automattic/vip 3.12.1 → 3.13.0

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

@@ -6,6 +6,7 @@ exports.destroyEnvironment = destroyEnvironment;
 exports.doesEnvironmentExist = doesEnvironmentExist;
 exports.exec = exec;
 exports.fetchVersionList = fetchVersionList;
+exports.generatePHPStormWorkspace = generatePHPStormWorkspace;
 exports.generateVSCodeWorkspace = generateVSCodeWorkspace;
 exports.getAllEnvironmentNames = getAllEnvironmentNames;
 exports.getApplicationInformation = getApplicationInformation;
@@ -23,7 +24,6 @@ exports.stopEnvironment = stopEnvironment;
 exports.updateEnvironment = updateEnvironment;
 exports.writeEnvironmentData = writeEnvironmentData;
 var _chalk = _interopRequireDefault(require("chalk"));
-var _copyDir = _interopRequireDefault(require("copy-dir"));
 var _debug = _interopRequireDefault(require("debug"));
 var _ejs = _interopRequireDefault(require("ejs"));
 var _enquirer = require("enquirer");
@@ -31,6 +31,7 @@ var _graphql = require("graphql");
 var _utils = require("lando/lib/utils");
 var _nodeFetch = _interopRequireDefault(require("node-fetch"));
 var _nodeFs = _interopRequireDefault(require("node:fs"));
+var _promises = require("node:fs/promises");
 var _nodePath = _interopRequireDefault(require("node:path"));
 var _semver = _interopRequireDefault(require("semver"));
 var _uuid = require("uuid");
@@ -69,11 +70,13 @@ function xdgDataDirectory() {
 async function startEnvironment(lando, slug, options) {
   debug('Will start an environment', slug);
   const instancePath = getEnvironmentPath(slug);
-  debug('Instance path for', slug, 'is:', instancePath);
+  debug('Instance path for %s is %s', slug, instancePath);
   const environmentExists = _nodeFs.default.existsSync(instancePath);
   if (!environmentExists) {
     throw new Error(_devEnvironment.DEV_ENVIRONMENT_NOT_FOUND);
   }
+  const envFilePath = _nodePath.default.join(instancePath, '.env');
+  _nodeFs.default.appendFileSync(envFilePath, '');
   let updated = false;
   if (!options.skipWpVersionsCheck && process.stdin.isTTY) {
     updated = await maybeUpdateWordPressImage(lando, slug);
@@ -98,7 +101,7 @@ async function stopEnvironment(lando, slug) {
   }
   await (0, _devEnvironmentLando.landoStop)(lando, instancePath);
 }
-async function createEnvironment(lando, instanceData, integrationsConfig) {
+async function createEnvironment(lando, instanceData, integrationsConfig, envVars) {
   const slug = instanceData.siteSlug;
   integrationsConfig ??= {};
   debug('Will process an environment', slug, 'with instanceData for creation: ', instanceData);
@@ -110,7 +113,7 @@ async function createEnvironment(lando, instanceData, integrationsConfig) {
   }
   const preProcessedInstanceData = preProcessInstanceData(instanceData);
   debug('Will create an environment', slug, 'with instanceData: ', preProcessedInstanceData);
-  await prepareLandoEnv(lando, preProcessedInstanceData, instancePath, integrationsConfig);
+  await prepareLandoEnv(lando, preProcessedInstanceData, instancePath, integrationsConfig, envVars);
 }
 async function updateEnvironment(lando, instanceData) {
   const slug = instanceData.siteSlug;
@@ -123,7 +126,7 @@ async function updateEnvironment(lando, instanceData) {
   }
   const preProcessedInstanceData = preProcessInstanceData(instanceData);
   debug('Will create an environment', slug, 'with instanceData: ', preProcessedInstanceData);
-  await prepareLandoEnv(lando, preProcessedInstanceData, instancePath, undefined);
+  await prepareLandoEnv(lando, preProcessedInstanceData, instancePath, undefined, undefined);
 }
 function preProcessInstanceData(instanceData) {
   const newInstanceData = {
@@ -366,7 +369,7 @@ async function writeIntegrationsConfig(instancePath, integrationsConfig) {
     debug(`Integrations configuration file created in ${integrationsConfigTargetPath}`);
   }
 }
-async function prepareLandoEnv(lando, instanceData, instancePath, integrationsConfig) {
+async function prepareLandoEnv(lando, instanceData, instancePath, integrationsConfig, envVars) {
   const templateData = {
     ...instanceData,
     domain: lando.config.domain
@@ -380,6 +383,7 @@ async function prepareLandoEnv(lando, instanceData, instancePath, integrationsCo
   const nginxFolderPath = _nodePath.default.join(instancePath, nginxPathString);
   const nginxFileTargetPath = _nodePath.default.join(nginxFolderPath, nginxFileName);
   const instanceDataTargetPath = _nodePath.default.join(instancePath, instanceDataFileName);
+  const envFilePath = _nodePath.default.join(instancePath, '.env');
   await _nodeFs.default.promises.mkdir(instancePath, {
     recursive: true
   });
@@ -396,6 +400,15 @@ async function prepareLandoEnv(lando, instanceData, instancePath, integrationsCo
     }
   }
   await Promise.all([_nodeFs.default.promises.writeFile(landoFileTargetPath, landoFile), _nodeFs.default.promises.writeFile(nginxFileTargetPath, nginxFile), _nodeFs.default.promises.writeFile(instanceDataTargetPath, instanceDataFile)]);
+  if (envVars !== undefined) {
+    const env = [];
+    Object.entries(envVars ?? {}).forEach(([key]) => {
+      env.push(`VIP_ENV_VAR_${key}=`);
+    });
+    await _nodeFs.default.promises.writeFile(envFilePath, env.join('\n'));
+  } else {
+    await _nodeFs.default.promises.appendFile(envFilePath, '');
+  }
   debug(`Lando file created in ${landoFileTargetPath}`);
   debug(`Nginx file created in ${nginxFileTargetPath}`);
   debug(`Instance data file created in ${instanceDataTargetPath}`);
@@ -444,6 +457,11 @@ async function getApplicationInformation(appId, envType) {
 			type,
 			branch,
 			isMultisite,
+			environmentVariables {
+				nodes {
+					name
+				}
+			}
 			getIntegrationsDevEnvConfig {
 				data
 			}
@@ -486,6 +504,12 @@ async function getApplicationInformation(appId, envType) {
       envData = environments.find(candidateEnv => candidateEnv.type === env);
     }
     if (envData) {
+      const envVars = {};
+      envData.environmentVariables?.nodes?.forEach(envvar => {
+        if (envvar?.name) {
+          envVars[envvar.name] = '';
+        }
+      });
       appData.environment = {
         name: envData.name,
         branch: envData.branch,
@@ -494,7 +518,8 @@ async function getApplicationInformation(appId, envType) {
         primaryDomain: envData.primaryDomain?.name ?? '',
         php: envData.softwareSettings?.php?.current.version ?? '',
         wordpress: envData.softwareSettings?.wordpress?.current.version ?? '',
-        integrations: envData.getIntegrationsDevEnvConfig?.data ?? {}
+        integrations: envData.getIntegrationsDevEnvConfig?.data ?? {},
+        envVars
       };
     }
   }
@@ -536,7 +561,7 @@ async function importMediaPath(slug, filePath) {
   if (!(await doesEnvironmentExist(environmentPath))) {
     throw new Error(_devEnvironment.DEV_ENVIRONMENT_NOT_FOUND);
   }
-  const files = _nodeFs.default.readdirSync(resolvedPath);
+  const files = await (0, _promises.readdir)(resolvedPath);
   if (files.includes(uploadPathString)) {
     const confirm = await (0, _enquirer.prompt)({
       type: 'confirm',
@@ -549,8 +574,15 @@ async function importMediaPath(slug, filePath) {
   }
   const uploadsPath = _nodePath.default.join(environmentPath, uploadPathString);
   console.log(`${_chalk.default.yellow('-')} Started copying files`);
-  _copyDir.default.sync(resolvedPath, uploadsPath);
-  console.log(`${_chalk.default.green('✓')} Files successfully copied to ${uploadsPath}.`);
+  try {
+    await (0, _promises.cp)(resolvedPath, uploadsPath, {
+      recursive: true
+    });
+    console.log(`${_chalk.default.green('✓')} Files successfully copied to ${uploadsPath}.`);
+  } catch (error) {
+    console.error(`${_chalk.default.red('✗')} Error copying files to ${uploadsPath}.`);
+    throw error;
+  }
 }
 
 /**
@@ -768,17 +800,27 @@ function generateVSCodeWorkspace(slug) {
       path: instanceData.appCode.dir
     });
   }
+
+  // Create debug configuration
+  const debugConfig = {
+    name: `Debug ${slug}`,
+    type: 'php',
+    request: 'launch',
+    port: 9003,
+    pathMappings
+  };
+
+  // Check if running under WSL and add hostname if needed
+  // This is to allow xdebug to work when running under WSL
+  if (process.env?.WSL_DISTRO_NAME) {
+    debug('WSL detected, adding hostname to debug configuration');
+    debugConfig.hostname = '0.0.0.0';
+  }
   const workspace = {
     folders,
     launch: {
       version: '0.2.0',
-      configurations: [{
-        name: `Debug ${slug}`,
-        type: 'php',
-        request: 'launch',
-        port: 9003,
-        pathMappings
-      }]
+      configurations: [debugConfig]
     }
   };
   _nodeFs.default.writeFileSync(workspacePath, JSON.stringify(workspace, null, 2));
@@ -796,7 +838,7 @@ const generatePathMappings = (location, instanceData) => {
     pathMappings['/wp/wp-content/plugins'] = _nodePath.default.resolve(instanceData.appCode.dir, 'plugins');
     pathMappings['/wp/wp-content/private'] = _nodePath.default.resolve(instanceData.appCode.dir, 'private');
     pathMappings['/wp/wp-content/themes'] = _nodePath.default.resolve(instanceData.appCode.dir, 'themes');
-    pathMappings['/wp/wp-content/vip-config'] = _nodePath.default.resolve(instanceData.appCode.dir, 'vip-config');
+    pathMappings['/wp/vip-config'] = _nodePath.default.resolve(instanceData.appCode.dir, 'vip-config');
   }
   pathMappings['/wp'] = _nodePath.default.resolve(location, 'wordpress');
   return pathMappings;
@@ -805,4 +847,88 @@ function getVSCodeWorkspacePath(slug) {
   const location = getEnvironmentPath(slug);
   const workspacePath = _nodePath.default.join(location, `${slug}.code-workspace`);
   return workspacePath;
+}
+
+/**
+ * Generates PHPStorm project configuration including debug settings
+ *
+ * @param {string} slug - The slug of the environment to generate PHPStorm config for
+ * @return {string} Project directory path
+ */
+function generatePHPStormWorkspace(slug) {
+  debug('Generating PHPStorm Workspace');
+  const location = getEnvironmentPath(slug);
+  // const location = location;
+  const instanceData = readEnvironmentData(slug);
+  const pathMappings = generatePathMappings(location, instanceData);
+
+  // Create .idea directory
+  _nodeFs.default.mkdirSync(_nodePath.default.join(location, '.idea', 'runConfigurations'), {
+    recursive: true
+  });
+
+  // Generate workspace.xml
+  const workspaceXml = `<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="PhpWorkspaceProjectConfiguration">
+    <include_path>
+      <path value="$PROJECT_DIR$/wordpress" />
+${instanceData?.muPlugins?.dir ? `<path value="${instanceData.muPlugins.dir}" />` : ''}
+${instanceData?.appCode?.dir ? `<path value="${instanceData.appCode.dir}" />` : ''}
+    </include_path>
+  </component>
+  <component name="PhpDebugGeneral" listening_started="true" />
+  <component name="PhpDebugXdebugSettings">
+    <debug_server_list>
+      <server host="localhost" port="9003" />
+    </debug_server_list>
+    <path_mappings>
+${Object.entries(pathMappings).map(([serverPath, localPath]) => `      <mapping local-root="${serverPath}" remote-root="$PROJECT_DIR$/${_nodePath.default.relative(location, localPath)}" />`).join('\n')}
+    </path_mappings>
+  </component>
+  <component name="PhpServers">
+    <servers>
+      <server host="localhost" id="${(0, _uuid.v4)()}" name="localhost" use_path_mappings="true">
+        <path_mappings>
+          <mapping local-root="$PROJECT_DIR$/wordpress" remote-root="/wp" />
+          ${Object.entries(pathMappings).map(([serverPath, localPath]) => `<mapping local-root="${localPath}" remote-root="${serverPath}" />`).join('\n')}
+        </path_mappings>
+      </server>
+    </servers>
+  </component>
+		<component name="WordPressConfiguration" enabled="true">
+    <wordpressPath>$PROJECT_DIR$/wordpress</wordpressPath>
+  </component>
+</project>`;
+  _nodeFs.default.writeFileSync(_nodePath.default.join(location, '.idea', 'workspace.xml'), workspaceXml);
+  const xdebugXml = `<component name="ProjectRunConfigurationManager">
+	<configuration default="false" name="VIP Debug" type="PhpRemoteDebugRunConfigurationType" factoryName="PHP Remote Debug" nameIsGenerated="true" filter_connections="NOT_FILTER" server_name="localhost" session_id="XDEBUG">
+		<method v="2" />
+  </configuration>
+</component>
+`;
+  _nodeFs.default.writeFileSync(_nodePath.default.join(location, '.idea', 'runConfigurations', 'vip-xdebug.xml'), xdebugXml);
+  const projectXml = `<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+	<component name="ProjectModuleManager">
+		<modules>
+			<module fileurl="file://$PROJECT_DIR$/.idea/${slug}.iml" filepath="$PROJECT_DIR$/.idea/${slug}.iml" />
+		</modules>
+	</component>
+</project>
+`;
+  _nodeFs.default.writeFileSync(_nodePath.default.join(location, '.idea', 'modules.xml'), projectXml);
+  const modulesXml = `<?xml version="1.0" encoding="UTF-8"?>
+	<module type="WEB_MODULE" version="4">
+		<component name="NewModuleRootManager">
+		<content url="file://$MODULE_DIR$/${_nodePath.default.relative(location, instanceData?.appCode?.dir ?? '')}" />
+		<content url="file://$MODULE_DIR$/${_nodePath.default.relative(location, instanceData?.muPlugins?.dir ?? '')}" />
+			<content url="file://$MODULE_DIR$" />
+			<orderEntry type="sourceFolder" forTests="false" />
+		<orderEntry type="inheritedJdk" />
+		</component>
+</module>
+`;
+  _nodeFs.default.writeFileSync(_nodePath.default.join(location, '.idea', slug + '.iml'), modulesXml);
+  return location;
 }

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

@@ -44,9 +44,7 @@ const debug = (0, _debug.default)(DEBUG_KEY);
 async function getLandoConfig() {
   // The path will be smth like `yarn/global/node_modules/lando/lib/lando.js`; we need the path up to `lando` (inclusive)
   const landoPath = (0, _nodePath.dirname)((0, _nodePath.dirname)(require.resolve('lando')));
-  // The path will be smth like `yarn/global/node_modules/@lando/compose/index.js`; we need the path up to `@lando` (inclusive)
-  const atLandoPath = (0, _nodePath.dirname)((0, _nodePath.dirname)(require.resolve('@lando/compose')));
-  debug(`Getting Lando config, using paths '${landoPath}' and '${atLandoPath}' for plugins`);
+  debug(`Getting Lando config, using paths '${landoPath}' for plugins`);
   const isLandoDebugSelected = _debug.default.enabled(DEBUG_KEY);
   const isAllDebugSelected = _debug.default.enabled('"*"');
   let logLevelConsole;
@@ -75,11 +73,7 @@ async function getLandoConfig() {
     landoFile: '.lando.yml',
     preLandoFiles: ['.lando.base.yml', '.lando.dist.yml', '.lando.upstream.yml'],
     postLandoFiles: ['.lando.local.yml'],
-    pluginDirs: [landoPath, {
-      path: atLandoPath,
-      subdir: '.',
-      namespace: '@lando'
-    }],
+    pluginDirs: [landoPath],
     disablePlugins: [],
     proxyName: 'vip-dev-env-proxy',
     userConfRoot: landoDir,

package/dist/lib/media-import/progress.js

@@ -2,7 +2,7 @@
 
 exports.__esModule = true;
 exports.MediaImportProgressTracker = void 0;
-var _singleLineLog = require("single-line-log");
+var _singleLineLog = require("@wwa/single-line-log");
 var _format = require("../../lib/cli/format");
 var _status = require("../../lib/media-import/status");
 const PRINT_INTERVAL = process.env.DEBUG ? 5000 : 200; // How often the report is printed. Mainly affects the "spinner" animation.

package/dist/lib/site-import/db-file-import.js

@@ -6,8 +6,8 @@ exports.currentUserCanImportForApp = currentUserCanImportForApp;
 exports.isSupportedApp = exports.isImportingBlockedBySync = void 0;
 var _fileSize = require("../../lib/constants/file-size");
 var _vipgo = require("../../lib/constants/vipgo");
-const SQL_IMPORT_FILE_SIZE_LIMIT = exports.SQL_IMPORT_FILE_SIZE_LIMIT = 100 * _fileSize.GB_IN_BYTES;
-const SQL_IMPORT_FILE_SIZE_LIMIT_LAUNCHED = exports.SQL_IMPORT_FILE_SIZE_LIMIT_LAUNCHED = 5 * _fileSize.GB_IN_BYTES;
+const SQL_IMPORT_FILE_SIZE_LIMIT = exports.SQL_IMPORT_FILE_SIZE_LIMIT = 200 * _fileSize.GB_IN_BYTES;
+const SQL_IMPORT_FILE_SIZE_LIMIT_LAUNCHED = exports.SQL_IMPORT_FILE_SIZE_LIMIT_LAUNCHED = 10 * _fileSize.GB_IN_BYTES;
 function currentUserCanImportForApp(app) {
   // TODO: implement
   return Boolean(app);

package/dist/lib/validations/sql.js

@@ -4,9 +4,9 @@ exports.__esModule = true;
 exports.validate = exports.staticSqlValidations = exports.getTableNames = void 0;
 exports.validateFilename = validateFilename;
 exports.validateImportFileExtension = void 0;
+var _singleLineLog = require("@wwa/single-line-log");
 var _chalk = _interopRequireDefault(require("chalk"));
-var _path = _interopRequireDefault(require("path"));
-var _singleLineLog = require("single-line-log");
+var _nodePath = _interopRequireDefault(require("node:path"));
 var exit = _interopRequireWildcard(require("../../lib/cli/exit"));
 var _clientFileUploader = require("../../lib/client-file-uploader");
 var _tracker = require("../../lib/tracker");
@@ -33,7 +33,7 @@ function formatRecommendation(message) {
  * @returns {boolean} True if the extension is valid
  */
 const validateImportFileExtension = filename => {
-  const ext = _path.default.extname(filename).toLowerCase();
+  const ext = _nodePath.default.extname(filename).toLowerCase();
   if (!['.sql', '.gz'].includes(ext)) {
     exit.withError('Invalid file extension. Please provide a .sql or .gz file.');
   }

package/docs/CHANGELOG.md

@@ -1,5 +1,56 @@
 ## Changelog
 
+### 3.13.0
+
+* build(deps): bump Automattic/vip-actions from dbd477b39f2122bf594da2d65dc0ea8ab5fc9bf0 to bb2853ecb6cd7dba2efe589ebb10cf930759fe69
+* feat(dev-env): add initial support for `.env` files
+* feat(dev-env): Refactor IDE support: add Cursor, PHPStorm and Windsurf
+* build(deps-dev): bump @automattic/eslint-plugin-wpvip from 0.13.0 to 0.13.1
+* build(deps): bump shelljs from 0.9.1 to 0.9.2
+* fix(dev-env): disallow running dev-env as `root`
+* chore(deps): update `lando` to `540a5e0`
+* fix(dev-env): handling of large media files in `vip dev-env import media`
+* build(deps-dev): bump @types/node from 22.13.10 to 22.13.11
+* build(deps-dev): bump the babel group with 2 updates
+* build(deps): bump Automattic/vip-actions from bb2853ecb6cd7dba2efe589ebb10cf930759fe69 to 1137b91acf0f5ea4e0db044bcf14ceabed9b068f
+* build(deps-dev): bump @types/semver from 7.5.8 to 7.7.0
+* build(deps-dev): bump @types/node from 22.13.11 to 22.13.14
+* fix(dev-env): `mu-plugins` prompt logic
+* build(deps-dev): bump dockerode from 4.0.4 to 4.0.5
+* fix(dev-env): handling of `mediaRedirectDomain` in `vip dev-env update`
+* chore: update GraphQL types
+* chore: remove overrides for `@lando/compose`
+* build(deps): bump step-security/harden-runner from 2.11.0 to 2.11.1
+* build(deps-dev): bump @types/dockerode from 3.3.35 to 3.3.37
+* build(deps): bump actions/dependency-review-action from 4.5.0 to 4.6.0
+* build(deps-dev): bump @types/node from 22.13.14 to 22.14.0
+* build(deps-dev): bump typescript from 5.8.2 to 5.8.3
+* build(deps-dev): bump @types/node from 22.14.0 to 22.14.1
+* chore(deps): update `lando`
+* chore(deps): replace `single-line-log` with a fork
+* Clarifying descriptions of options for `vip config envvar`
+* build(deps-dev): bump @types/dockerode from 3.3.37 to 3.3.38
+* build(deps): bump open from 10.1.0 to 10.1.1
+* build(deps): bump @automattic/vip-go-preflight-checks from 2.0.18 to 2.0.19
+* fix(dev-env): strip trailing slash in URLs when doing sync
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.12.2...3.13.0
+
+### 3.12.2
+
+* build(deps-dev): bump @babel/core from 7.26.9 to 7.26.10
+* Increase SQL import file size limit to 200G
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.12.1...3.12.2
+
+### 3.12.1
+
+* build(deps): bump shelljs from 0.8.5 to 0.9.1
+* build(deps-dev): bump @types/node from 22.13.9 to 22.13.10
+* Only use myloader source-db when provided
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.12.0...3.12.1
+
 ### 3.12.0
 
 * fix: rsync to skip files based on checksum