@automattic/vip 4.1.6 → 4.1.8

package/dist/commands/wp-ssh.js

@@ -1,30 +1,61 @@
 "use strict";
-
-exports.__esModule = true;
-exports.WPCliCommandOverSSH = exports.NonZeroExitCodeError = exports.APIError = void 0;
-var _core = require("@apollo/client/core");
-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 _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 }; }
+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.WPCliCommandOverSSH = exports.APIError = exports.NonZeroExitCodeError = void 0;
 /**
  * External dependencies
  */
-
+const core_1 = require("@apollo/client/core");
+const chalk_1 = __importDefault(require("chalk"));
+const debug_1 = __importDefault(require("debug"));
+const graphql_tag_1 = __importDefault(require("graphql-tag"));
+const ssh2 = __importStar(require("ssh2"));
 /**
  * Internal dependencies
  */
-
-const debug = (0, _debug.default)('@automattic/vip:wp/ssh');
+const package_json_1 = __importDefault(require("../../package.json"));
+const api_1 = __importDefault(require("../lib/api"));
+const tracker_1 = require("../lib/tracker");
+const debug = (0, debug_1.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)`
+const TRIGGER_WP_CLI_COMMAND_MUTATION = (0, graphql_tag_1.default) `
 	mutation TriggerWPCLICommandMutation($input: AppEnvironmentTriggerWPCLICommandInput) {
 		triggerWPCLICommandOnAppEnvironment(input: $input) {
 			inputToken
@@ -42,185 +73,185 @@ const TRIGGER_WP_CLI_COMMAND_MUTATION = (0, _graphqlTag.default)`
 	}
 `;
 class NonZeroExitCodeError extends Error {
-  guid;
-  exitCode;
-  constructor(message, guid, exitCode) {
-    super(message);
-    this.guid = guid;
-    this.exitCode = exitCode;
-  }
+    guid;
+    exitCode;
+    constructor(message, guid, exitCode) {
+        super(message);
+        this.guid = guid;
+        this.exitCode = exitCode;
+    }
 }
 exports.NonZeroExitCodeError = NonZeroExitCodeError;
-class APIError extends Error {}
+class APIError extends Error {
+}
 exports.APIError = APIError;
 class WPCliCommandOverSSH {
-  track;
-  constructor(app, env) {
-    this.app = app;
-    this.env = env;
-    this.track = (0, _tracker.makeCommandTracker)('wp', {
-      app: app.id,
-      env: 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);
-    try {
-      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
+    app;
+    env;
+    track;
+    constructor(app, env) {
+        this.app = app;
+        this.env = env;
+        this.track = (0, tracker_1.makeCommandTracker)('wp', {
+            app: app.id,
+            env: env.id,
+            execution_type: 'ssh',
         });
-        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
-      });
-      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: err.guid,
-          error: 'non_zero_exit_code',
-          message: `Command failed with exit code ${err.exitCode}`,
-          ...extraTrackingInfo
-        });
-        process.exit(err.exitCode);
-      } else if (err instanceof APIError) {
-        console.error(`${_chalk.default.red('Error:')} ${err.message}`);
-        await this.track('error', {
-          error: 'api_error',
-          message: `API Error: ${err.message}`,
-          ...extraTrackingInfo
-        });
-        process.exit(1);
-      }
-      const message = err instanceof Error ? err.message : String(err);
-      console.error(`${_chalk.default.red('Error:')} ${message}`);
-      await this.track('error', {
-        error: 'ssh_command_failed',
-        message: `Error executing command over SSH: ${message}`,
-        ...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`, guid, exitCode));
+    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);
+        try {
+            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');
             }
-          });
-          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();
-          });
+            debug('Connecting to SSH', {
+                host: data.sshAuthentication.host,
+                port: data.sshAuthentication.port,
+                username: data.sshAuthentication.username,
+                guid: data.command.guid,
+            });
+            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: err.guid,
+                    error: 'non_zero_exit_code',
+                    message: `Command failed with exit code ${err.exitCode}`,
+                    ...extraTrackingInfo,
+                });
+                process.exit(err.exitCode);
+            }
+            else if (err instanceof APIError) {
+                console.error(`${chalk_1.default.red('Error:')} ${err.message}`);
+                await this.track('error', {
+                    error: 'api_error',
+                    message: `API Error: ${err.message}`,
+                    ...extraTrackingInfo,
+                });
+                process.exit(1);
+            }
+            const message = err instanceof Error ? err.message : String(err);
+            console.error(`${chalk_1.default.red('Error:')} ${message}`);
+            await this.track('error', {
+                error: 'ssh_command_failed',
+                message: `Error executing command over SSH: ${message}`,
+                ...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_json_1.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`, guid, 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,
+            });
         });
-      }).on('error', err => {
-        reject(err);
-      }).on('close', () => {
-        if (!commandStarted) {
-          reject(new Error('Connection closed before command started'));
+    }
+    async getSSHAuthForCommand(command, extraTrackingInfo) {
+        const api = (0, api_1.default)();
+        try {
+            return await api.mutate({
+                mutation: TRIGGER_WP_CLI_COMMAND_MUTATION,
+                variables: {
+                    input: {
+                        id: this.app.id,
+                        environmentId: this.env.id,
+                        command,
+                    },
+                },
+            });
         }
-      }).connect({
-        host,
-        port,
-        username,
-        privateKey,
-        passphrase,
-        readyTimeout: SSH_HANDSHAKE_TIMEOUT_MS
-      });
-    });
-  }
-  async getSSHAuthForCommand(command, extraTrackingInfo) {
-    const api = (0, _api.default)();
-    try {
-      return await api.mutate({
-        mutation: TRIGGER_WP_CLI_COMMAND_MUTATION,
-        variables: {
-          input: {
-            id: this.app.id,
-            environmentId: this.env.id,
-            command
-          }
+        catch (error) {
+            if (core_1.CombinedGraphQLErrors.is(error)) {
+                const message = error.errors.map(err => err.message).join('; ');
+                throw new APIError(message);
+            }
+            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`);
         }
-      });
-    } catch (error) {
-      if (_core.CombinedGraphQLErrors.is(error)) {
-        const message = error.errors.map(err => err.message).join('; ');
-        throw new APIError(message);
-      }
-      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;
+exports.WPCliCommandOverSSH = WPCliCommandOverSSH;

package/dist/lib/analytics/clients/tracks.js

@@ -1,104 +1,97 @@
 "use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _debug = _interopRequireDefault(require("debug"));
-var _querystring = _interopRequireDefault(require("querystring"));
-var _undici = require("undici");
-var _apiConfig = require("../../cli/apiConfig");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const debug = (0, _debug.default)('@automattic/vip:analytics:clients:tracks');
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const debug_1 = __importDefault(require("debug"));
+const querystring_1 = __importDefault(require("querystring"));
+const undici_1 = require("undici");
+const apiConfig_1 = require("../../cli/apiConfig");
+const debug = (0, debug_1.default)('@automattic/vip:analytics:clients:tracks');
 const validEventOrPropNamePattern = /^[a-z_][a-z0-9_]*$/;
 /**
  * Simple class for tracking using Automattic Tracks.
  *
  * Implementation reference can be found in the Field Guide.
  */
-
 // TODO: add batch support (can include multiples in `events` array)
-
 class Tracks {
-  userAgent;
-  baseParams;
-  static ENDPOINT = 'https://public-api.wordpress.com/rest/v1.1/tracks/record';
-  constructor(userId, userType, eventPrefix, env) {
-    this.eventPrefix = eventPrefix;
-    this.userAgent = env.userAgent;
-    this.baseParams = {
-      'commonProps[_ui]': userId,
-      'commonProps[_ut]': userType,
-      'commonProps[_via_ua]': this.userAgent
-    };
-  }
-  async trackEvent(name, eventProps = {}) {
-    if (!name.startsWith(this.eventPrefix)) {
-      name = this.eventPrefix + name;
+    eventPrefix;
+    userAgent;
+    baseParams;
+    static ENDPOINT = 'https://public-api.wordpress.com/rest/v1.1/tracks/record';
+    constructor(userId, userType, eventPrefix, env) {
+        this.eventPrefix = eventPrefix;
+        this.userAgent = env.userAgent;
+        this.baseParams = {
+            'commonProps[_ui]': userId,
+            'commonProps[_ut]': userType,
+            'commonProps[_via_ua]': this.userAgent,
+        };
     }
-    if (!validEventOrPropNamePattern.test(name)) {
-      debug(`Error: Invalid event name detected: ${name} -- this event will be rejected during ETL`);
+    async trackEvent(name, eventProps = {}) {
+        if (!name.startsWith(this.eventPrefix)) {
+            name = this.eventPrefix + name;
+        }
+        if (!validEventOrPropNamePattern.test(name)) {
+            debug(`Error: Invalid event name detected: ${name} -- this event will be rejected during ETL`);
+        }
+        Object.keys(eventProps).forEach(propName => {
+            if (!validEventOrPropNamePattern.test(propName)) {
+                debug(`Error: Invalid prop name detected: ${propName} -- this event will be rejected during ETL`);
+            }
+        });
+        eventProps.is_vip = await (0, apiConfig_1.checkIfUserIsVip)(); // Add `is_vip` flag to every Tracks event recorded
+        const event = {
+            _en: name,
+            ...eventProps,
+        };
+        // For when we want to support batched events
+        const events = [event];
+        /**
+         * The API expects an indexed events array with event data.
+         *
+         * `querystring.stringify` does not handle nested arrays and objects very well.
+         *
+         * So we can just do it ourselves instead.
+         *
+         * Should end up with something like:
+         *  - events[0][_en]=clickButton // event name
+         *  - events[0][buttonName]=Deploy // event custom prop
+         *  - events[1][_en]=loadPage
+         */
+        const params = events.reduce((reduced, ev, index) => {
+            Object.keys(ev).forEach(key => {
+                const param = `events[${index}][${key}]`;
+                const value = event[key];
+                reduced[param] = value;
+            });
+            return reduced;
+        }, {});
+        debug('trackEvent()', params);
+        try {
+            return await this.send(params);
+        }
+        catch (error) {
+            debug(error);
+        }
+        // Resolve to false instead of rejecting
+        return false;
     }
-    Object.keys(eventProps).forEach(propName => {
-      if (!validEventOrPropNamePattern.test(propName)) {
-        debug(`Error: Invalid prop name detected: ${propName} -- this event will be rejected during ETL`);
-      }
-    });
-    eventProps.is_vip = await (0, _apiConfig.checkIfUserIsVip)(); // Add `is_vip` flag to every Tracks event recorded
-
-    const event = {
-      _en: name,
-      ...eventProps
-    };
-
-    // For when we want to support batched events
-    const events = [event];
-
-    /**
-     * The API expects an indexed events array with event data.
-     *
-     * `querystring.stringify` does not handle nested arrays and objects very well.
-     *
-     * So we can just do it ourselves instead.
-     *
-     * Should end up with something like:
-     *  - events[0][_en]=clickButton // event name
-     *  - events[0][buttonName]=Deploy // event custom prop
-     *  - events[1][_en]=loadPage
-     */
-    const params = events.reduce((reduced, ev, index) => {
-      Object.keys(ev).forEach(key => {
-        const param = `events[${index}][${key}]`;
-        const value = event[key];
-        reduced[param] = value;
-      });
-      return reduced;
-    }, {});
-    debug('trackEvent()', params);
-    try {
-      return await this.send(params);
-    } catch (error) {
-      debug(error);
+    send(extraParams) {
+        const params = { ...this.baseParams, ...extraParams };
+        const method = 'POST';
+        const body = querystring_1.default.stringify(params);
+        const headers = {
+            'Content-Type': 'application/x-www-form-urlencoded',
+            'User-Agent': this.userAgent,
+        };
+        debug('send()', body);
+        return (0, undici_1.fetch)(Tracks.ENDPOINT, {
+            method,
+            body,
+            headers,
+        });
     }
-
-    // Resolve to false instead of rejecting
-    return false;
-  }
-  send(extraParams) {
-    const params = {
-      ...this.baseParams,
-      ...extraParams
-    };
-    const method = 'POST';
-    const body = _querystring.default.stringify(params);
-    const headers = {
-      'Content-Type': 'application/x-www-form-urlencoded',
-      'User-Agent': this.userAgent
-    };
-    debug('send()', body);
-    return (0, _undici.fetch)(Tracks.ENDPOINT, {
-      method,
-      body,
-      headers
-    });
-  }
 }
-exports.default = Tracks;
+exports.default = Tracks;