@automattic/vip 3.25.1 → 3.25.2

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

@@ -16,6 +16,9 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 const examples = [{
   usage: 'vip @example-app.develop db phpmyadmin',
   description: "Generate access to a read-only phpMyAdmin web interface for the environment's database."
+}, {
+  usage: 'vip @example-app.develop db phpmyadmin --print',
+  description: 'Print the phpMyAdmin URL to stdout instead of opening it in a browser.'
 }];
 const appQuery = `
 	id,
@@ -35,16 +38,20 @@ void (0, _command.default)({
   module: 'phpmyadmin',
   requiredArgs: 0,
   usage: 'vip db phpmyadmin'
-}).examples(examples).argv(process.argv, async (arg, {
+}).option('print', 'Print the phpMyAdmin URL to stdout instead of opening it in a browser.').option('silent', 'Do not print any output to the console.').examples(examples).argv(process.argv, async (arg, {
   app,
-  env
+  env,
+  print: printUrl,
+  silent
 }) => {
   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();
+  const cmd = new _phpmyadmin.PhpMyAdminCommand(app, env, trackerFn, silent);
+  await cmd.run({
+    print: printUrl
+  });
   await trackerFn('success');
 });

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/commands/phpmyadmin.js

@@ -4,6 +4,7 @@ exports.__esModule = true;
 exports.PhpMyAdminCommand = exports.GET_PHP_MY_ADMIN_STATUS_QUERY = exports.GENERATE_PHP_MY_ADMIN_URL_MUTATION = exports.ENABLE_PHP_MY_ADMIN_MUTATION = void 0;
 var _chalk = _interopRequireDefault(require("chalk"));
 var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
+var _promises = require("node:timers/promises");
 var _api = _interopRequireWildcard(require("../lib/api"));
 var exit = _interopRequireWildcard(require("../lib/cli/exit"));
 var _progress = require("../lib/cli/progress");
@@ -94,6 +95,45 @@ async function getPhpMyAdminStatus(appId, envId) {
   (0, _api.enableGlobalGraphQLErrorHandling)();
   return resp.data?.app?.environments?.[0]?.phpMyAdminStatus?.status ?? '';
 }
+class MyProgressTracker extends _progress.ProgressTracker {
+  constructor(steps, silent) {
+    super(steps);
+    this.silent = silent;
+  }
+  setSilent(silent) {
+    this.silent = silent;
+  }
+  print() {
+    if (!this.silent) {
+      super.print();
+    }
+  }
+  startPrinting(prePrintCallback) {
+    if (!this.silent) {
+      super.startPrinting(prePrintCallback);
+    }
+  }
+  stopPrinting() {
+    if (!this.silent) {
+      super.stopPrinting();
+    }
+  }
+  stepRunning(stepId, additionalInfo) {
+    if (!this.silent) {
+      super.stepRunning(stepId, additionalInfo);
+    }
+  }
+  stepSuccess(stepId, additionalInfo) {
+    if (!this.silent) {
+      super.stepSuccess(stepId, additionalInfo);
+    }
+  }
+  stepFailed(stepId, additionalInfo) {
+    if (!this.silent) {
+      super.stepFailed(stepId, additionalInfo);
+    }
+  }
+}
 class PhpMyAdminCommand {
   silent;
   steps = {
@@ -101,23 +141,23 @@ class PhpMyAdminCommand {
     GENERATE: 'generate'
   };
   progressTracker;
-  constructor(app, env, track = async () => {}) {
+  constructor(app, env, track = async () => {}, silent = false) {
     this.app = app;
     this.env = env;
     this.track = track;
-    this.progressTracker = new _progress.ProgressTracker([{
+    this.silent = silent;
+    this.progressTracker = new MyProgressTracker([{
       id: this.steps.ENABLE,
-      name: 'Enabling PHPMyAdmin for this environment'
+      name: 'Enabling phpMyAdmin for this environment'
     }, {
       id: this.steps.GENERATE,
       name: 'Generating access link'
-    }]);
+    }], silent);
   }
   log(msg) {
-    if (this.silent) {
-      return;
+    if (!this.silent) {
+      console.log(msg);
     }
-    console.log(msg);
   }
   stopProgressTracker() {
     this.progressTracker.print();
@@ -141,19 +181,22 @@ class PhpMyAdminCommand {
       await (0, _utils.pollUntil)(this.getStatus.bind(this), 1000, sts => sts === 'running');
 
       // Additional 30s for LB routing to be updated
-      await new Promise(resolve => setTimeout(resolve, 30000));
+      await (0, _promises.setTimeout)(30_000);
     }
   }
-  async run(silent = false) {
-    this.silent = silent;
+  async run({
+    print = false
+  } = {}) {
     if (!this.app.id) {
       exit.withError('No app was specified');
     }
     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));
+    if (!this.silent) {
+      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.progressTracker.startPrinting();
     try {
       this.progressTracker.stepRunning(this.steps.ENABLE);
@@ -171,7 +214,7 @@ class PhpMyAdminCommand {
       if (error.graphQLErrors?.find(gqlError => gqlError.message === 'Unauthorized')) {
         exit.withError('You do not have sufficient permission to access phpMyAdmin for this environment.');
       }
-      exit.withError('Failed to enable PhpMyAdmin. Please try again. If the problem persists, please contact support.');
+      exit.withError('Failed to enable phpMyAdmin. Please try again. If the problem persists, please contact support.');
     }
     let url;
     try {
@@ -187,11 +230,16 @@ class PhpMyAdminCommand {
         stack: error.stack
       });
       this.stopProgressTracker();
-      exit.withError(`Failed to generate PhpMyAdmin URL: ${error.message}`);
+      exit.withError(`Failed to generate phpMyAdmin URL: ${error.message}`);
     }
-    void this.openUrl(url);
     this.stopProgressTracker();
-    this.log('PhpMyAdmin is opened in your default browser.');
+    if (print) {
+      // Output only the URL to stdout for scripting/automation use
+      console.log(url);
+    } else {
+      void this.openUrl(url);
+      this.log('phpMyAdmin is opened in your default browser.');
+    }
   }
 }
 exports.PhpMyAdminCommand = PhpMyAdminCommand;