@automattic/vip 4.1.6 → 4.1.8

package/dist/bin/vip-sync.js

@@ -1,34 +1,41 @@
 #!/usr/bin/env node
 "use strict";
-
-var _core = require("@apollo/client/core");
-var _singleLineLog = require("@wwa/single-line-log");
-var _chalk = _interopRequireDefault(require("chalk"));
-var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
-var _api = _interopRequireDefault(require("../lib/api"));
-var _app2 = _interopRequireDefault(require("../lib/api/app"));
-var _command = _interopRequireDefault(require("../lib/cli/command"));
-var _format = require("../lib/cli/format");
-var _tracker = require("../lib/tracker");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@apollo/client/core");
+const single_line_log_1 = require("@wwa/single-line-log");
+const chalk_1 = __importDefault(require("chalk"));
+const graphql_tag_1 = __importDefault(require("graphql-tag"));
+const api_1 = __importDefault(require("../lib/api"));
+const app_1 = __importDefault(require("../lib/api/app"));
+const command_1 = __importDefault(require("../lib/cli/command"));
+const format_1 = require("../lib/cli/format");
+const tracker_1 = require("../lib/tracker");
+// The API reports the current step as the overall status while a sync is in progress.
+const SYNC_RUNNING_STATUSES = ['running', 'started', 'importing', 'cleanup'];
+const SYNC_SUCCESS_STATUSES = ['success', 'complete'];
 const appQuery = `id,name,environments{
 	id,appId,type,name,defaultDomain,branch,datacenter,syncProgress{
-		status,sync,steps{name,status}
+		status,error,progress_update_text,sync,steps{name,status}
 	},syncPreview { canSync, errors { message }, backup { createdAt }, replacements { from, to } }
 }`;
-(0, _command.default)({
-  appContext: true,
-  appQuery,
-  childEnvContext: true,
-  module: 'sync',
-  requireConfirm: 'Are you sure you want to sync from production?'
-}).example('vip @example-app.develop sync', 'Sync the production environment database of the "example-app" application to the develop environment.').argv(process.argv, async (arg, opts) => {
-  const api = (0, _api.default)();
-  let syncing = false;
-  await (0, _tracker.trackEvent)('sync_command_execute');
-  try {
-    await api.mutate({
-      mutation: (0, _graphqlTag.default)`
+(0, command_1.default)({
+    appContext: true,
+    appQuery,
+    childEnvContext: true,
+    module: 'sync',
+    requireConfirm: 'Are you sure you want to sync from production?',
+})
+    .example('vip @example-app.develop sync', 'Sync the production environment database of the "example-app" application to the develop environment.')
+    .argv(process.argv, async (arg, opts) => {
+    const api = (0, api_1.default)();
+    let syncing = false;
+    await (0, tracker_1.trackEvent)('sync_command_execute');
+    try {
+        await api.mutate({
+            mutation: (0, graphql_tag_1.default) `
 					mutation SyncEnvironmentMutation($input: AppEnvironmentSyncInput) {
 						syncEnvironment(input: $input) {
 							environment {
@@ -37,74 +44,75 @@ const appQuery = `id,name,environments{
 						}
 					}
 				`,
-      variables: {
-        input: {
-          id: opts.app.id,
-          environmentId: opts.env.id
-        }
-      }
-    });
-  } catch (error) {
-    if (_core.CombinedGraphQLErrors.is(error)) {
-      let bail = false;
-      for (const err of error.errors) {
-        if (err.message !== 'Site is already syncing') {
-          bail = true;
-          console.log(_chalk.default.red('Error:'), err.message);
-        }
-      }
-
-      // TODO: Log e
-
-      if (bail) {
-        return;
-      }
+            variables: {
+                input: {
+                    id: opts.app.id,
+                    environmentId: opts.env.id,
+                },
+            },
+        });
     }
-    syncing = true;
-    await (0, _tracker.trackEvent)('sync_command_execute_error', {
-      error: `Already syncing: ${error.message}`
-    });
-  }
-  const sprite = {
-    count: 0,
-    sprite: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'],
-    next() {
-      this.count++;
-      if (this.count >= this.sprite.length) {
-        this.count = 0;
-      }
-      return {
-        value: this.sprite[this.count],
-        done: false
-      };
+    catch (error) {
+        if (core_1.CombinedGraphQLErrors.is(error)) {
+            let bail = false;
+            for (const err of error.errors) {
+                if (err.message !== 'Site is already syncing') {
+                    bail = true;
+                    console.log(chalk_1.default.red('Error:'), err.message);
+                }
+            }
+            // TODO: Log e
+            if (bail) {
+                return;
+            }
+        }
+        syncing = true;
+        await (0, tracker_1.trackEvent)('sync_command_execute_error', {
+            error: `Already syncing: ${error.message}`,
+        });
     }
-  };
-  const application = await (0, _app2.default)(opts.app.id, appQuery);
-  let environment = application.environments.find(env => env.id === opts.env.id);
-  if (syncing) {
-    if (environment.syncProgress.status === 'running') {
-      console.log(_chalk.default.yellow('Note:'), 'A data sync is already running.');
-    } else {
-      console.log(_chalk.default.yellow('Note:'), 'Someone recently ran a data sync on this site.');
-      console.log(_chalk.default.yellow('Note:'), 'Please wait a few minutes before trying again.');
+    const sprite = {
+        count: 0,
+        sprite: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'],
+        next() {
+            this.count++;
+            if (this.count >= this.sprite.length) {
+                this.count = 0;
+            }
+            return {
+                value: this.sprite[this.count],
+                done: false,
+            };
+        },
+    };
+    const application = await (0, app_1.default)(opts.app.id, appQuery);
+    let environment = application.environments.find(env => env.id === opts.env.id);
+    if (syncing) {
+        if (SYNC_RUNNING_STATUSES.includes(environment.syncProgress.status)) {
+            console.log(chalk_1.default.yellow('Note:'), 'A data sync is already running.');
+        }
+        else {
+            console.log(chalk_1.default.yellow('Note:'), 'Someone recently ran a data sync on this site.');
+            console.log(chalk_1.default.yellow('Note:'), 'Please wait a few minutes before trying again.');
+        }
     }
-  }
-  console.log();
-  console.log(`  syncing: ${_chalk.default.yellow(opts.app.name)}`);
-  console.log(`     from: ${(0, _format.formatEnvironment)('production')}`);
-  console.log(`       to: ${(0, _format.formatEnvironment)(opts.env.type)}`);
-  let count = 0;
-  const progress = setInterval(async () => {
-    if (count++ % 10 === 0) {
-      // Query the API 1/10 of the time (every 1s)
-      // The rest of the iterations are just for moving the spinner
-      api.query({
-        query: (0, _graphqlTag.default)`
-							query App($id: Int) {
+    console.log();
+    console.log(`  syncing: ${chalk_1.default.yellow(opts.app.name)}`);
+    console.log(`     from: ${(0, format_1.formatEnvironment)('production')}`);
+    console.log(`       to: ${(0, format_1.formatEnvironment)(opts.env.type)}`);
+    let count = 0;
+    const progress = setInterval(async () => {
+        if (count++ % 10 === 0) {
+            // Query the API 1/10 of the time (every 1s)
+            // The rest of the iterations are just for moving the spinner
+            api
+                .query({
+                query: (0, graphql_tag_1.default) `
+							query App($id: Int, $envId: Int) {
 								app(id: $id) {
 									id
 									name
-									environments {
+									environments(id: $envId) {
 										id
 										name
 										defaultDomain
@@ -112,6 +120,8 @@ const appQuery = `id,name,environments{
 										datacenter
 										syncProgress {
 											status
+											error
+											progress_update_text
 											sync
 											steps {
 												name
@@ -122,52 +132,72 @@ const appQuery = `id,name,environments{
 								}
 							}
 						`,
-        fetchPolicy: 'network-only',
-        variables: {
-          id: opts.app.id
+                fetchPolicy: 'network-only',
+                variables: {
+                    id: opts.app.id,
+                    envId: opts.env.id,
+                },
+            })
+                .then(res => res.data.app)
+                .then(_app => {
+                environment = _app.environments.find(env => env.id === opts.env.id);
+            });
         }
-      }).then(res => res.data.app).then(_app => {
-        environment = _app.environments.find(env => env.id === opts.env.id);
-      });
-    }
-    const marks = {
-      pending: '○',
-      running: _chalk.default.blueBright(sprite.next().value),
-      success: _chalk.default.green('✓'),
-      failed: _chalk.default.red('✕'),
-      unknown: _chalk.default.yellow('✕')
-    };
-    const out = [];
-    const steps = environment.syncProgress.steps || [];
-    out.push('');
-    steps.forEach(step => {
-      if (step.status === 'pending') {
-        out.push(_chalk.default.dim(` ${marks[step.status]} ${step.name}`));
-      } else {
-        out.push(` ${marks[step.status]} ${step.name}`);
-      }
-    });
-    out.push('');
-    switch (environment.syncProgress.status) {
-      case 'running':
-        out.push(`${marks.running} Press ^C to hide progress. Data sync will continue in the background.`);
-        break;
-      case 'failed':
-        clearInterval(progress);
-        await (0, _tracker.trackEvent)('sync_command_error', {
-          error: 'API returned `failed` status'
-        });
-        out.push(`${marks.failed} Data Sync is finished for ${opts.app.name}.`);
+        const marks = {
+            pending: '○',
+            running: chalk_1.default.blueBright(sprite.next().value),
+            success: chalk_1.default.green('✓'),
+            finished: chalk_1.default.green('✓'),
+            failed: chalk_1.default.red('✕'),
+            unknown: chalk_1.default.yellow('✕'),
+        };
+        const out = [];
+        const steps = environment.syncProgress.steps || [];
         out.push('');
-        break;
-      case 'success':
-      default:
-        clearInterval(progress);
-        await (0, _tracker.trackEvent)('sync_command_success');
-        out.push(`${marks.success} Data Sync is finished for ${opts.app.name}.`);
+        steps.forEach(step => {
+            if (step.status === 'pending') {
+                out.push(chalk_1.default.dim(` ${marks[step.status]} ${step.name}`));
+            }
+            else {
+                out.push(` ${marks[step.status] ?? marks.unknown} ${step.name}`);
+            }
+        });
         out.push('');
-        break;
-    }
-    (0, _singleLineLog.stdout)(out.join('\n'));
-  }, 100);
-});
+        const { status, error: syncError, progress_update_text: progressText, } = environment.syncProgress;
+        if (progressText) {
+            out.push(` ${progressText}`);
+            out.push('');
+        }
+        if (status === 'failed') {
+            clearInterval(progress);
+            await (0, tracker_1.trackEvent)('sync_command_error', {
+                error: 'API returned `failed` status',
+            });
+            out.push(`${marks.failed} Data Sync failed for ${opts.app.name}.`);
+            if (syncError) {
+                out.push(`${chalk_1.default.red('Error:')} ${syncError}`);
+            }
+            out.push('');
+        }
+        else if (status === 'partially_completed') {
+            clearInterval(progress);
+            await (0, tracker_1.trackEvent)('sync_command_partially_completed');
+            out.push(`${marks.unknown} Data Sync is partially completed for ${opts.app.name}.`);
+            if (syncError) {
+                out.push(`${chalk_1.default.yellow('Error:')} ${syncError}`);
+            }
+            out.push('');
+        }
+        else if (SYNC_SUCCESS_STATUSES.includes(status)) {
+            clearInterval(progress);
+            await (0, tracker_1.trackEvent)('sync_command_success');
+            out.push(`${marks.success} Data Sync is finished for ${opts.app.name}.`);
+            out.push('');
+        }
+        else {
+            // Running, or not_syncing until the job shows up: keep polling.
+            out.push('Press ^C to hide progress. Data sync will continue in the background.');
+        }
+        (0, single_line_log_1.stdout)(out.join('\n'));
+    }, 100);
+});

package/dist/bin/vip-whoami.js

@@ -1,41 +1,77 @@
 #!/usr/bin/env node
 "use strict";
-
-exports.__esModule = true;
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.whoamiCommand = whoamiCommand;
-var _user = require("../lib/api/user");
-var _command = _interopRequireDefault(require("../lib/cli/command"));
-var exit = _interopRequireWildcard(require("../lib/cli/exit"));
-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); }
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const user_1 = require("../lib/api/user");
+const command_1 = __importDefault(require("../lib/cli/command"));
+const exit = __importStar(require("../lib/cli/exit"));
+const tracker_1 = require("../lib/tracker");
 const baseUsage = 'vip whoami';
 async function whoamiCommand() {
-  const trackingParams = {
-    command: 'vip whoami'
-  };
-  await (0, _tracker.trackEvent)('whoami_command_execute', trackingParams);
-  let currentUser;
-  try {
-    currentUser = await (0, _user.getCurrentUserInfo)();
-  } catch (err) {
-    const error = err instanceof Error ? err : new Error('Unknown error');
-    await (0, _tracker.trackEvent)('whoami_command_error', {
-      ...trackingParams,
-      error: error.message
-    });
-    exit.withError(`Failed to fetch information about the currently logged-in user error: ${error.message}`);
-  }
-  await (0, _tracker.trackEvent)('whoami_command_success', trackingParams);
-  const output = [`- Howdy ${currentUser.displayName ?? 'user'}!`, `- Your user ID is ${currentUser.id ?? ' not found'}`];
-  if (currentUser.isVIP) {
-    output.push('- Your account has VIP Staff permissions');
-  }
-  console.log(output.join('\n'));
+    const trackingParams = {
+        command: 'vip whoami',
+    };
+    await (0, tracker_1.trackEvent)('whoami_command_execute', trackingParams);
+    let currentUser;
+    try {
+        currentUser = await (0, user_1.getCurrentUserInfo)();
+    }
+    catch (err) {
+        const error = err instanceof Error ? err : new Error('Unknown error');
+        await (0, tracker_1.trackEvent)('whoami_command_error', { ...trackingParams, error: error.message });
+        exit.withError(`Failed to fetch information about the currently logged-in user error: ${error.message}`);
+    }
+    await (0, tracker_1.trackEvent)('whoami_command_success', trackingParams);
+    const output = [
+        `- Howdy ${currentUser.displayName ?? 'user'}!`,
+        `- Your user ID is ${currentUser.id ?? ' not found'}`,
+    ];
+    if (currentUser.isVIP) {
+        output.push('- Your account has VIP Staff permissions');
+    }
+    console.log(output.join('\n'));
 }
-void (0, _command.default)({
-  usage: baseUsage
-}).examples([{
-  usage: baseUsage + '\n' + '    - Howdy user@example.com!\n' + '    - Your user ID is 1234\n',
-  description: 'Retrieve details about the current authenticated VIP-CLI user.'
-}]).argv(process.argv, whoamiCommand);
+void (0, command_1.default)({ usage: baseUsage })
+    .examples([
+    {
+        usage: baseUsage + '\n' + '    - Howdy user@example.com!\n' + '    - Your user ID is 1234\n',
+        description: 'Retrieve details about the current authenticated VIP-CLI user.',
+    },
+])
+    .argv(process.argv, whoamiCommand);