@automattic/vip 2.36.2 → 2.37.0-dev.0

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

@@ -17,7 +17,7 @@ services:
     type: compose
     services:
       image: ghcr.io/automattic/vip-container-images/dev-tools:0.9
-      command: exit 0
+      command: /bin/true
       volumes:
         - devtools:/dev-tools
         - scripts:/scripts

package/dist/bin/vip-db-phpmyadmin.js

@@ -0,0 +1,53 @@
+#!/usr/bin/env node
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+"use strict";
+
+var _phpmyadmin = require("../commands/phpmyadmin");
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+var _tracker = require("../lib/tracker");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const examples = [{
+  usage: 'vip db phpmyadmin @mysite.develop',
+  description: 'Open PhpMyAdmin console for the database of the @mysite.develop environment'
+}];
+const appQuery = `
+	id,
+	name,
+	type,
+	organization { id, name },
+	environments{
+		id
+		appId
+		type
+		name
+		primaryDomain { name }
+		uniqueLabel
+	}
+`;
+void (0, _command.default)({
+  appContext: true,
+  appQuery,
+  envContext: true,
+  module: 'phpmyadmin',
+  requiredArgs: 0,
+  usage: 'vip db phpmyadmin'
+}).examples(examples).argv(process.argv, async (arg, {
+  app,
+  env
+}) => {
+  const trackerFn = (0, _tracker.makeCommandTracker)('phpmyadmin', {
+    app: app.id,
+    env: env.uniqueLabel
+  });
+  await trackerFn('execute');
+  const cmd = new _phpmyadmin.PhpMyAdminCommand(app, env, trackerFn);
+  await cmd.run();
+  await trackerFn('success');
+});

package/dist/bin/vip-db.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+"use strict";
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+var _tracker = require("../lib/tracker");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+void (0, _command.default)({
+  usage: 'vip db'
+}).command('phpmyadmin', 'Open PhpMyAdmin console for your application database').example('vip db phpmyadmin @mysite.develop', 'Open PhpMyAdmin console for your database of the @mysite.develop environment').argv(process.argv, async () => {
+  await (0, _tracker.trackEvent)('vip_db_command_execute');
+});

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

@@ -415,7 +415,6 @@ Processing the SQL import for your environment...
 `;
     progressTracker.suffix = `\n${(0, _format.getGlyphForStatus)(status, progressTracker.runningSprite)} ${status === 'running' ? 'Loading remaining steps' : ''}`; // TODO: maybe use progress tracker status
   };
-
   const failWithError = failureError => {
     status = 'failed';
     setProgressTrackerPrefixAndSuffix();

package/dist/bin/vip.js

@@ -21,7 +21,7 @@ if (_config.default && _config.default.environment !== 'production') {
 const tokenURL = 'https://dashboard.wpvip.com/me/cli/token';
 const runCmd = async function () {
   const cmd = (0, _command.default)();
-  cmd.command('logout', 'Logout from your current session').command('app', 'List and modify your VIP applications').command('backup', 'Generate a backup for VIP applications').command('cache', 'Manage page cache for your VIP applications').command('config', 'Set configuration for your VIP applications').command('dev-env', 'Use local dev-environment').command('export', 'Export data from your VIP application').command('import', 'Import media or SQL files into your VIP applications').command('logs', 'Get logs from your VIP applications').command('search-replace', 'Perform search and replace tasks on files').command('slowlogs', 'Get slowlogs from your VIP applications').command('sync', 'Sync production to a development environment').command('whoami', 'Display details about the currently logged-in user').command('validate', 'Validate your VIP application and environment').command('wp', 'Run WP CLI commands against an environment');
+  cmd.command('logout', 'Logout from your current session').command('app', 'List and modify your VIP applications').command('backup', 'Generate a backup for VIP applications').command('cache', 'Manage page cache for your VIP applications').command('config', 'Set configuration for your VIP applications').command('dev-env', 'Use local dev-environment').command('export', 'Export data from your VIP application').command('import', 'Import media or SQL files into your VIP applications').command('logs', 'Get logs from your VIP applications').command('search-replace', 'Perform search and replace tasks on files').command('slowlogs', 'Get slowlogs from your VIP applications').command('db', 'Run operations on your VIP application database').command('sync', 'Sync production to a development environment').command('whoami', 'Display details about the currently logged-in user').command('validate', 'Validate your VIP application and environment').command('wp', 'Run WP CLI commands against an environment');
   cmd.argv(process.argv);
 };
 

package/dist/commands/phpmyadmin.js

@@ -0,0 +1,95 @@
+"use strict";
+
+exports.__esModule = true;
+exports.PhpMyAdminCommand = exports.GENERATE_PHP_MY_ADMIN_URL_MUTATION = void 0;
+var _chalk = _interopRequireDefault(require("chalk"));
+var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
+var _api = _interopRequireWildcard(require("../lib/api"));
+var exit = _interopRequireWildcard(require("../lib/cli/exit"));
+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 && Object.prototype.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(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+
+const GENERATE_PHP_MY_ADMIN_URL_MUTATION = exports.GENERATE_PHP_MY_ADMIN_URL_MUTATION = (0, _graphqlTag.default)`
+	mutation GeneratePhpMyAdminAccess($input: GeneratePhpMyAdminAccessInput) {
+		generatePHPMyAdminAccess(input: $input) {
+			expiresAt
+			url
+		}
+	}
+`;
+async function generatePhpMyAdminAccess(envId) {
+  // Disable global error handling so that we can handle errors ourselves
+  (0, _api.disableGlobalGraphQLErrorHandling)();
+  const api = await (0, _api.default)();
+  const resp = await api.mutate({
+    mutation: GENERATE_PHP_MY_ADMIN_URL_MUTATION,
+    variables: {
+      input: {
+        environmentId: envId
+      }
+    }
+  });
+
+  // Re-enable global error handling
+  (0, _api.enableGlobalGraphQLErrorHandling)();
+
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+  return resp?.data?.generatePHPMyAdminAccess?.url;
+}
+class PhpMyAdminCommand {
+  app;
+  env;
+  silent;
+  track;
+  constructor(app, env, trackerFn = async () => {}) {
+    this.app = app;
+    this.env = env;
+    this.track = trackerFn;
+  }
+  log(msg) {
+    if (this.silent) {
+      return;
+    }
+    console.log(msg);
+  }
+  async openUrl(url) {
+    const {
+      default: open
+    } = await import('open');
+    void open(url, {
+      wait: false
+    });
+  }
+  async run(silent = false) {
+    this.silent = silent;
+    if (!this.env.id) {
+      exit.withError('No environment was specified');
+    }
+    const message = 'Note: PHPMyAdmin sessions are read-only. If you run a query that writes to DB, it will fail.';
+    console.log(_chalk.default.yellow(message));
+    this.log('Generating PhpMyAdmin URL...');
+    let url;
+    try {
+      url = await generatePhpMyAdminAccess(this.env.id);
+    } catch (err) {
+      const error = err;
+      void this.track('error', {
+        error_type: 'generate_pma_url',
+        error_message: error.message,
+        stack: error.stack
+      });
+      exit.withError(`Failed to generate PhpMyAdmin URL: ${error.message}`);
+    }
+    void this.openUrl(url);
+    this.log('PhpMyAdmin is opened in your default browser.');
+  }
+}
+exports.PhpMyAdminCommand = PhpMyAdminCommand;

package/dist/lib/cli/command.js

@@ -88,7 +88,6 @@ _args.default.argv = async function (argv, cb) {
     options.app = parsedAlias.app;
     options.env = parsedAlias.env; // Can be undefined
   }
-
   const validationError = validateOpts(options);
   if (validationError) {
     const error = validationError.toString();

package/dist/lib/client-file-uploader.js

@@ -38,7 +38,6 @@ require('fetch-retry')(_nodeFetch.default, {
     return Math.pow(2, attempt) * 1000; // 1000, 2000, 4000
   }
 });
-
 const debug = (0, _debug.default)('vip:lib/client-file-uploader');
 
 // Files smaller than COMPRESS_THRESHOLD will not be compressed before upload
@@ -198,7 +197,6 @@ async function uploadUsingPutObject({
     ...fetchOptions.headers,
     'Content-Length': `${fileSize}` // This has to be a string
   };
-
   let readBytes = 0;
   const progressPassThrough = new _stream.PassThrough();
   progressPassThrough.on('data', data => {
@@ -484,7 +482,6 @@ async function uploadPart({
        *   ...so it may not be feasible to include with presigned requests.
        */
     };
-
     fetchOptions.body = (0, _fs.createReadStream)(fileName, {
       start,
       end

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

@@ -40,4 +40,4 @@ const DEV_ENVIRONMENT_PHP_VERSIONS = exports.DEV_ENVIRONMENT_PHP_VERSIONS = {
     label: '7.4 (EOL; not supported)'
   }
 };
-const DEV_ENVIRONMENT_VERSION = exports.DEV_ENVIRONMENT_VERSION = '2.0.0';
+const DEV_ENVIRONMENT_VERSION = exports.DEV_ENVIRONMENT_VERSION = '2.0.1';

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

@@ -189,7 +189,6 @@ async function getEnvironmentName(options) {
   }
   return DEFAULT_SLUG; // Fall back to the default slug if we don't have any, e.g. during the env creation purpose
 }
-
 function getEnvironmentStartCommand(slug, configurationFileOptions) {
   const isUsingConfigurationFileSlug = Object.keys(configurationFileOptions).length > 0 && configurationFileOptions.slug === slug;
   if (!slug || isUsingConfigurationFileSlug) {
@@ -606,7 +605,6 @@ function processBooleanOption(value) {
   // eslint-disable-next-line @typescript-eslint/no-base-to-string
   return !FALSE_OPTIONS.includes(value.toString().toLowerCase()); // NOSONAR
 }
-
 function processStringOrBooleanOption(value) {
   if (typeof value === 'boolean') {
     return value;

package/dist/lib/site-import/status.js

@@ -342,7 +342,6 @@ ${maybeExitPrompt}
       overallStatus = results.progress?.status ?? 'unknown';
       // This shouldn't be 'unknown'...what should we do here?
     }
-
     progressTracker.stopPrinting();
     setProgressTrackerSuffix();
 

package/docs/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## Changelog
 
+### 2.36.3
+
+- build(deps): bump @json2csv/plainjs from 7.0.3 to 7.0.4
+- build(deps-dev): bump nock from 13.3.8 to 13.4.0
+- build(deps-dev): bump the babel group with 2 updates
+- build(deps-dev): bump @automattic/eslint-plugin-wpvip from 0.9.0 to 0.9.1
+- fix(dev-env): `/lando-entrypoint.sh: exec: line 83: exit: not found`
+- build(deps-dev): bump eslint from 8.54.0 to 8.55.0
+- build(deps-dev): bump typescript from 5.3.2 to 5.3.3
+- build(deps-dev): bump the testing group with 1 update
+- chore(deps): update lando to 25fcd83
+- build(deps): bump Automattic/vip-actions from 0.1.2 to 0.2.0
+
 ### 2.36.2
 
 - #1558 fix(dev-env): Fix typo on suggested start command after updating env