Wrapping up log function

Author: manifestinteractive

README.md

@@ -14,8 +14,6 @@ Make developing for Salesforce Commerce Cloud work with any IDE on MacOS, Window
 - [X] Watch for code changes and upload in background ( without being prompted for passwords )
 - [X] Log Viewing with Advanced Search & Filter Capabilities
 
-### NOTE: THIS IS A WORK IN PROGRESS
-
 Developer Overview
 ---
 

bin/cli.js

@@ -6,100 +6,115 @@ const yargs = require('yargs')
 const chalk = require('chalk')
 
 const argv = yargs
-  .usage('Usage: $0 <command> <client> <instance> --switches')
+  .usage('Usage: sfcc <command> <client> <instance> --switches')
   .command('setup', 'Setup SFCC Development', {
     client: {
       alias: 'c',
-      describe: 'Client Name'
+      describe: 'Client Name',
+      type: 'string'
     },
     hostname: {
       alias: 'h',
-      describe: 'Hostname for Instance'
+      describe: 'Hostname for Instance',
+      type: 'string'
     },
     version: {
       alias: 'v',
-      describe: 'Code Version'
+      describe: 'Code Version',
+      type: 'string'
     },
     directory: {
       alias: 'd',
-      describe: 'Absolute path to Repository'
+      describe: 'Absolute path to Repository',
+      type: 'string'
     },
     username: {
       alias: 'u',
-      describe: 'Your Business Manager Username'
+      describe: 'Your Business Manager Username',
+      type: 'string'
     },
     password: {
       alias: 'p',
-      describe: 'Your Business Manager Password'
+      describe: 'Your Business Manager Password',
+      type: 'string'
     },
     alias: {
       alias: 'a',
       describe: 'Instance Alias',
-      default: 'sandbox'
+      default: 'sandbox',
+      type: 'string'
     }
   })
   .command('list', 'List Configured SFCC Clients')
   .command('delete <client> [instance]', 'Delete Config for Client')
   .command('watch [client] [instance]', 'Watch for Changes and Push Updates', {
     log: {
       describe: 'Pipe Output to Log File ~/.sffc-cli.log',
+      type: 'boolean',
       default: false
     },
     'errors-only': {
       describe: 'Only Show Notification for Errors',
+      type: 'boolean',
       default: false
     }
   })
   .command('log [client] [instance]', 'Stream log files from an instance', {
-    interval: {
-      describe: 'Polling interval (seconds)',
+    polling: {
+      alias: 'p',
+      describe: 'Polling Interval (seconds)',
+      type: 'number',
       default: 2
     },
     lines: {
-      describe: 'Number of lines to display',
+      alias: 'l',
+      describe: 'Number of Lines to Display',
+      type: 'number',
       default: 100
     },
     include: {
-      describe: 'Log levels to include',
+      alias: 'i',
+      describe: 'Log Types to Include',
       type: 'array',
       default: []
     },
     exclude: {
-      describe: 'Log levels to exclude',
+      alias: 'e',
+      describe: 'Log Types to Exclude',
       type: 'array',
       default: []
     },
-    list: {
-      describe: 'Output a list of available log levels',
-      default: false
-    },
-    dates: {
-      describe: 'Output a list of available log dates',
-      default: false
-    },
     filter: {
-      describe: 'Filter log messages by regexp',
+      alias: 'f',
+      describe: 'Filter Log Messages by RegExp',
+      type: 'string',
       default: null
     },
-    length: {
-      describe: 'Length to truncate a log message',
+    truncate: {
+      alias: 't',
+      describe: 'Length to Truncate Messages',
+      type: 'number',
       default: null
     },
-    search: {
-      describe: 'Search all log files',
+    list: {
+      describe: 'Output List of Log Types',
+      type: 'boolean',
       default: false
     },
-    'no-timestamp': {
-      describe: "Don't convert timestamps to local time",
+    search: {
+      describe: 'Search Logs with no Live Updates',
+      type: 'boolean',
       default: false
     },
     latest: {
       describe: 'Show Latest Logs Only',
-      boolean: false
+      type: 'boolean',
+      default: false
     }
   })
-  .example('$0 delete my-client sandbox', 'Delete my-client sandbox config')
-  .example('$0 watch my-client sandbox', 'Watch for my-client sandbox changes')
+  .example('sfcc delete my-client sandbox', 'Delete my-client sandbox config')
+  .example('sfcc watch my-client sandbox', 'Watch for my-client sandbox changes')
+  .example('sfcc log -i customerror --latest', 'Watch Latest Custom Error Logs')
   .demand(1)
   .help()
   .version().argv

commands/log.js

@@ -42,7 +42,6 @@ module.exports = async options => {
 
     // Group Logs
     let groups = groupBy(files, ({displayname}) => displayname.split('-blade')[0])
-    let dates = groupBy(files, ({creationdate}) => creationdate.split('T')[0])
 
     // pick out logs we want to include
     if (options.include.length > 0) {
@@ -74,7 +73,7 @@ module.exports = async options => {
 
     // get list of log types
     if (options.list) {
-      console.log(chalk.green.bold('\nLog Levels:\n'))
+      console.log(chalk.green.bold('\nLog Types:\n'))
 
       forEach(keys(groups).sort(), group => {
         console.log('· ' + group)
@@ -85,24 +84,6 @@ module.exports = async options => {
       process.exit()
     }
 
-    // get lost of log dates
-    if (options.dates) {
-      console.log(chalk.green.bold('\nLog Dates:\n'))
-
-      forEach(
-        keys(dates)
-          .sort()
-          .reverse(),
-        date => {
-          console.log('· ' + date)
-        }
-      )
-
-      console.log('')
-
-      process.exit()
-    }
-
     // setup logs
     const logs = []
     forEach(groups, (files, name) => {

docs/usage.md

@@ -59,6 +59,61 @@ sfcc delete <client>
 ```
 
 
+`sfcc log`
+---
+
+If you only have a single project, you can run:
+
+```bash
+sfcc log
+```
+
+If needed to setup multiple clients, or multiple instances for the same client, you will need to specify what to watch:
+
+```bash
+sfcc log <client> <instance>
+```
+
+**FLAGS:**
+
+Name     | Param      | Default | Definition
+---------|------------|---------|----------------------------------------------
+Polling  | `-p`       | `2`     | Polling Interval ( in Seconds )
+Lines    | `-l`       | `100`   | Number of Existing Lines to Display
+Include  | `-i`       |         | Log Types to Include ( use `sfcc log --list` for list )
+Exclude  | `-e`       |         | Log Types to Exclude ( use `sfcc log --list` for list )
+Filter   | `-f`       |         | Filter Log Messages that contain this string or RegExp
+Truncate | `-t`       |         | Length to Truncate Messages ( if they are too long )
+List     | `--list`   |         | Output List of Log Types for `-i` & `-e`
+Search   | `--search` | `false` | Search Logs with no Live Updates
+Latest   | `--latest` | `false` | Show Latest Logs Only ( default is to use ALL logs )
+
+#### ADVANCED USE:
+
+Get current list of log types:
+
+```bash
+sfcc log list
+```
+
+Watch latest `customerror` logs that contain the text `PipelineCallServlet`:
+
+```bash
+sfcc log -i customerror -l 5 -f PipelineCallServlet --latest
+```
+
+View any `warn,error` logs that contain a matching `[0-9]{15}` RegExp pattern, and watch for new entries:
+
+```bash
+sfcc log -i warn,error -f '[0-9]{15}'
+```
+
+Search all latest existing logs except `staging,syslog` that contain either `WARN|ERROR` RegExp pattern:
+
+```bash
+sfcc log -e staging,syslog -f 'WARN|ERROR' --search --latest
+```
+
 `sfcc help`
 ---
 
@@ -71,5 +126,6 @@ sfcc help
 You can get help on a specific command by just adding `help` to the end of the command:
 
 ```bash
+sfcc log help
 sfcc watch help
 ```

lib/search.js

@@ -7,8 +7,11 @@ const truncate = require('lodash/truncate')
 const read = require('./read')
 
 module.exports = async (selected, groups, options) => {
-  const text = 'Searching'
+  const including = options.include.length > 0 ? ` '${options.include.join(', ')}'` : ''
+  const excluding = options.exclude.length > 0 ? ` '${options.exclude.join(', ')}'` : ''
+  const filters = options.filter.length > 0 ? ` containing '${options.filter}'` : ''
 
+  const text = `Searching${including}${excluding} Logs${filters} [Ctrl-C to Cancel]`
   const spinner = ora(text)
   const output = fn => {
     spinner.stop()
@@ -58,25 +61,25 @@ module.exports = async (selected, groups, options) => {
           // highlight the matching parts of the line
           if (options.filter) {
             line = line.replace(new RegExp(options.filter, 'ig'), exp => {
-              return chalk.yellow(exp)
+              return chalk.white.bgGreen.bold(exp)
             })
           }
 
-          if (options.length > 0) {
+          if (options.truncate > 0) {
             line = truncate(line.trim(), {
-              length: options.length,
-              omission: ''
+              length: options.truncate,
+              omission: '…'
             })
           }
 
-          output(() => console.log(`${chalk.white(name)} ${line}`, 'blue'))
+          output(() => console.log(`${chalk.cyan.bold(name)} ${line}`))
         }
       }
     }
   }
 
   // spinner.stop();
-  spinner.text = `Search ` + (options.filter ? `for '${options.filter}' ` : '') + `complete`
+  spinner.text = `Search ${including}${excluding} Logs${filters} Complete`
   spinner.succeed()
   process.exit()
 }

lib/tail.js

@@ -7,7 +7,11 @@ const truncate = require('lodash/truncate')
 const read = require('./read')
 
 module.exports = async (selected, logs, groups, options) => {
-  const text = 'Streaming'
+  const including = options.include.length > 0 ? ` '${options.include.join(', ')}'` : ''
+  const excluding = options.exclude.length > 0 ? ` '${options.exclude.join(', ')}'` : ''
+  const filters = options.filter.length > 0 ? ` containing '${options.filter}'` : ''
+
+  const text = `Streaming${including}${excluding} Logs${filters} [Ctrl-C to Cancel]`
   const spinner = ora(text)
   const output = fn => {
     spinner.stop()
@@ -46,28 +50,29 @@ module.exports = async (selected, logs, groups, options) => {
           if (options.filter && !new RegExp(options.filter).test(line)) {
             continue
           }
-          if (options.length > 0) {
+          if (options.truncate > 0) {
             line = truncate(line.trim(), {
-              length: options.length,
-              omission: ''
-            })
-          }
-          if (!options.noTimestamp) {
-            line = line.replace(/\[(.+)\sGMT\]/g, (exp, match) => {
-              const date = new Date(Date.parse(match + 'Z'))
-              return chalk.magenta(`[${date.toLocaleDateString()} ${date.toLocaleTimeString()}]`)
+              length: options.truncate,
+              omission: '…'
             })
           }
+
           if (options.filter) {
             line = line.replace(new RegExp(options.filter, 'g'), exp => {
-              return chalk.yellow(exp)
+              return chalk.white.bgGreen.bold(exp)
             })
           }
-          output(() => console.log(`${chalk.white(name)} ${line}`, 'blue'))
+
+          line = line.replace(/\[(.+)\sGMT\]/g, (exp, match) => {
+            const date = new Date(Date.parse(match + 'Z'))
+            return chalk.magenta(`[${date.toLocaleDateString()} ${date.toLocaleTimeString()}]`)
+          })
+
+          output(() => console.log(`${chalk.cyan.bold(name)} ${line}`))
         }
       }
     }
   }
 
-  setTimeout(tail, options.interval * 1000)
+  setTimeout(tail, options.polling * 1000)
 }