chore: move the debugger command out of the debugger plugin (twilio#161)

Less repos to mange.

package.json

@@ -16,7 +16,6 @@
     "@oclif/plugin-warn-if-update-available": "^1.7.0",
     "@sendgrid/mail": "^6.5.2",
     "@twilio/cli-core": "^4.4.7",
-    "@twilio/plugin-debugger": "^1.1.9",
     "chalk": "^2.4.2",
     "inquirer": "^6.5.2",
     "twilio": "^3.39.4"
@@ -64,8 +63,7 @@
       "@oclif/plugin-autocomplete",
       "@oclif/plugin-help",
       "@oclif/plugin-plugins",
-      "@oclif/plugin-warn-if-update-available",
-      "@twilio/plugin-debugger"
+      "@oclif/plugin-warn-if-update-available"
     ],
     "warn-if-update-available": {
       "timeoutInDays": 1,

src/commands/debugger/logs/list.js

@@ -0,0 +1,128 @@
+const { flags } = require('@oclif/command');
+const { TwilioClientCommand } = require('@twilio/cli-core').baseCommands;
+const { TwilioCliError } = require('@twilio/cli-core').services.error;
+const { sleep } = require('@twilio/cli-core').services.JSUtils;
+const querystring = require('querystring');
+
+const STREAMING_DELAY_IN_SECONDS = 1;
+const STREAMING_HISTORY_IN_MINUTES = 5;
+
+class DebuggerLogsList extends TwilioClientCommand {
+  constructor(argv, config, secureStorage) {
+    super(argv, config, secureStorage);
+
+    this.showHeaders = true;
+    this.latestLogEvents = [];
+  }
+
+  async run() {
+    await super.run();
+
+    const props = this.parseProperties() || {};
+    this.validatePropsAndFlags(props, this.flags);
+
+    // Get any historical data first.
+    const logEvents = await this.getLogEvents(props);
+    this.outputLogEvents(logEvents);
+
+    // Then get streaming data.
+    /* eslint-disable no-await-in-loop */
+    while (this.flags.streaming) {
+      await sleep(STREAMING_DELAY_IN_SECONDS * 1000);
+
+      // If streaming, just look at the last X minutes. This allows for delayed
+      // events to show up. Note that time of day is ignored by this filter,
+      // but it will still allow us to capture logs during day rollovers (i.e.,
+      // our local clock just rolled over midnight but an event from 1 minute
+      // before midnight had yet to make its way through the pipeline);.
+      props.startDate = new Date(new Date() - (STREAMING_HISTORY_IN_MINUTES * 60 * 1000));
+      props.endDate = undefined; // Eh, why not?
+
+      const logEvents = await this.getLogEvents(props);
+      this.outputLogEvents(logEvents);
+    }
+  }
+
+  validatePropsAndFlags(props, flags) {
+    if (flags.streaming) {
+      if (props.startDate && new Date(props.startDate) > new Date()) {
+        throw new TwilioCliError('"streaming" flag does not support a future "start-date" value');
+      }
+
+      if (props.endDate) {
+        throw new TwilioCliError('"streaming" flag does not support the "end-date" option');
+      }
+    }
+  }
+
+  async getLogEvents(props) {
+    const logEvents = await this.twilioClient.monitor.alerts.list(props);
+
+    return this.filterLogEvents(logEvents);
+  }
+
+  filterLogEvents(logEvents) {
+    const previousLogEvents = new Set(this.latestLogEvents);
+    this.latestLogEvents = new Set(logEvents.map(event => event.sid));
+
+    // Filter out any events that we just saw, and then reverse them so they're
+    // in ascending order.
+    return logEvents
+      .filter(event => !previousLogEvents.has(event.sid))
+      .reverse();
+  }
+
+  outputLogEvents(logEvents) {
+    if (logEvents.length > 0) {
+      logEvents.forEach(e => {
+        e.alertText = this.formatAlertText(e.alertText);
+      });
+      this.output(logEvents, this.flags.properties, { showHeaders: this.showHeaders });
+      this.showHeaders = false;
+    }
+  }
+
+  formatAlertText(text) {
+    try {
+      const data = querystring.parse(text);
+      return data.parserMessage || data.Msg || text;
+    } catch (error) {
+      return text;
+    }
+  }
+}
+
+DebuggerLogsList.description = `Show a list of log events generated for the account
+
+Argg, this is only a subset of the log events and live tailing isn't quite ready! Think this is a killer feature? Let us know here: https://twil.io/twilio-cli-feedback`;
+
+DebuggerLogsList.PropertyFlags = {
+  'log-level': flags.enum({
+    options: ['error', 'warning', 'notice', 'debug'],
+    description: 'Only show log events for this log level'
+  }),
+  'start-date': flags.string({
+    description: 'Only show log events on or after this date'
+  }),
+  'end-date': flags.string({
+    description: 'Only show log events on or before this date'
+  })
+};
+
+DebuggerLogsList.flags = Object.assign(
+  {
+    properties: flags.string({
+      default: 'dateCreated, logLevel, errorCode, alertText',
+      description:
+        'The event properties you would like to display (JSON output always shows all properties)'
+    }),
+    streaming: flags.boolean({
+      char: 's',
+      description: 'Continuously stream incoming log events'
+    })
+  },
+  DebuggerLogsList.PropertyFlags,
+  TwilioClientCommand.flags
+);
+
+module.exports = DebuggerLogsList;