Merge pull request #235 from codecov/better-log

Better logs

Author: drazisil-codecov

.circleci/config.yml

@@ -26,14 +26,14 @@ jobs:
       # Download and cache dependencies
       - restore_cache:
           keys:
-            - v1-dependencies-{{ checksum "npm-shrinkwrap.json" }}
+            - v2-dependencies-{{ checksum "npm-shrinkwrap.json" }}
 
       - run: npm install
 
       - save_cache:
           paths:
             - node_modules
-          key: v1-dependencies-{{ checksum "npm-shrinkwrap.json" }}
+          key: v2-dependencies-{{ checksum "npm-shrinkwrap.json" }}
 
       # run tests!
       - run: make test
@@ -133,7 +133,7 @@ jobs:
       - run:
           name: Run Alpine binary -f (dry run)
           command: |
-            out/codecov-alpine -f /root/project/coverage-alpine/cobertura-coverage.xml -F alpine -d -Z -e CIRCLE_BRANCH >> output_alpine.txt
+            NODE_DEBUG=vm out/codecov-alpine -f /root/project/coverage-alpine/cobertura-coverage.xml -F alpine -d -Z -e CIRCLE_BRANCH >> output_alpine.txt
       - run:
           name: Run Alpine binary auto-detect (dry run)
           command: |
@@ -143,6 +143,9 @@ jobs:
           command: |
             out/codecov-alpine -F alpine -Z -e CIRCLE_BRANCH
 
+      - store_artifacts:
+          path: output_alpine.txt
+
       - persist_to_workspace:
           root: .
           paths:
@@ -181,7 +184,7 @@ jobs:
       - run:
           name: Run Linux binary -f (dry run)
           command: |
-            out/codecov-linux -f /home/circleci/project/coverage/cobertura-coverage.xml -F linux -d -Z -e CIRCLE_BRANCH >> output_linux.txt
+            out/codecov-linux -f /home/circleci/project/coverage/cobertura-coverage.xml -F linux -d -Z -v -e CIRCLE_BRANCH >> output_linux.txt
       - run:
           name: Run Linux binary auto-detect (dry run)
           command: |
@@ -232,7 +235,7 @@ jobs:
       - run:
           name: Run MacOS binary -f (dry-run)
           command: |
-            out/codecov-macos -f /Users/distiller/project/coverage/cobertura-coverage.xml -F macos -d -Z -e CIRCLE_BRANCH >> output_osx.txt
+            out/codecov-macos -f /Users/distiller/project/coverage/cobertura-coverage.xml -F macos -d -Z -v -e CIRCLE_BRANCH >> output_osx.txt
       - run:
           name: Run MacOS binary auto-detect (dry-run)
           command: |
@@ -282,7 +285,7 @@ jobs:
           command: |
             dir C:\Users\circleci\project\coverage\
             attrib C:\Users\circleci\project\coverage\cobertura-coverage.xml
-            .\out\codecov.exe -f C:\Users\circleci\project\coverage\cobertura-coverage.xml -F windows -d -Z -e CIRCLE_BRANCH >> output_win.txt
+            .\out\codecov.exe -f C:\Users\circleci\project\coverage\cobertura-coverage.xml -F windows -d -Z -v -e CIRCLE_BRANCH >> output_win.txt
           shell: cmd.exe
       - run:
           name: Run Windows binary auto-detect (dry-run)

bin/codecov

@@ -106,7 +106,7 @@ var argv = require('yargs') // eslint-disable-line
       alias: 'Q',
       type: 'string',
       description: `Used internally by Codecov, this argument helps track wrappers
-        of the uploader (e.g. GitHub Action, CircleCI Orb)`
+        of the uploader (e.g. GitHub Action, CircleCI Orb)`,
     },
   })
   .version()

src/ci_providers/provider_azurepipelines.js

@@ -1,5 +1,5 @@
 const childProcess = require('child_process')
-const { log } = require('../helpers/logger')
+const { error, info, verbose } = require('../helpers/logger')
 
 function detect(envs) {
   return !!envs.SYSTEM_TEAMFOUNDATIONSERVERURI
@@ -63,7 +63,7 @@ function _getSHA(inputs) {
       .trimRight()
     if (mergeCommitRegex.exec(mergeCommitMessage)) {
       const mergeCommit = mergeCommitMessage.split(' ')[1]
-      log(`    Fixing merge commit SHA ${commit} -> ${mergeCommit}`)
+      info(`    Fixing merge commit SHA ${commit} -> ${mergeCommit}`)
       commit = mergeCommit
     }
   }

src/ci_providers/provider_githubactions.js

@@ -1,5 +1,5 @@
 const childProcess = require('child_process')
-const { log } = require('../helpers/logger')
+const { error, info, verbose } = require('../helpers/logger')
 
 function detect(envs) {
   return envs.GITHUB_ACTIONS
@@ -70,10 +70,10 @@ function _getSHA(inputs) {
       .trimRight()
     if (mergeCommitRegex.exec(mergeCommitMessage)) {
       const mergeCommit = mergeCommitMessage.split(' ')[1]
-      log(`    Fixing merge commit SHA ${commit} -> ${mergeCommit}`)
+      info(`    Fixing merge commit SHA ${commit} -> ${mergeCommit}`)
       commit = mergeCommit
     } else if (mergeCommitMessage === '') {
-      log(
+      info(
         '->  Issue detecting commit SHA. Please run actions/checkout with fetch-depth > 1 or set to 0',
       )
     }

src/ci_providers/provider_local.js

@@ -1,5 +1,6 @@
 const childprocess = require('child_process')
 const { parseSlug } = require('../helpers/git')
+const { logAndThrow } = require('../helpers/util')
 
 function detect(envs) {
   return !envs.CI
@@ -27,9 +28,7 @@ function _getBranch(inputs) {
       .trimRight()
     return branchName
   } catch (error) {
-    throw new Error(
-      `There was an error getting the branch name from git: ${error}`,
-    )
+    logAndThrow(`There was an error getting the branch name from git: ${error}`)
   }
 }
 
@@ -66,9 +65,7 @@ function _getSHA(inputs) {
       .trimRight()
     return sha
   } catch (error) {
-    throw new Error(
-      `There was an error getting the commit SHA from git: ${error}`,
-    )
+    logAndThrow(`There was an error getting the commit SHA from git: ${error}`)
   }
 }
 
@@ -84,7 +81,7 @@ function _getSlug(inputs) {
       .trimRight()
     return parseSlug(slug)
   } catch (error) {
-    throw new Error(`There was an error getting the slug from git: ${error}`)
+    logAndThrow(`There was an error getting the slug from git: ${error}`)
   }
 }
 

src/ci_providers/provider_template.js

@@ -4,6 +4,9 @@
  * @param {*} envs an object of enviromental variable key/value pairs
  * @returns boolean
  */
+
+const { logAndThrow } = require('../helpers/util')
+
 // eslint-disable-next-line no-unused-vars
 function detect(envs) {
   return false
@@ -42,9 +45,7 @@ function _getBranch(inputs) {
   try {
     return args.branch || ''
   } catch (error) {
-    throw new Error(
-      `There was an error getting the branch name from git: ${error}`,
-    )
+    logAndThrow(`There was an error getting the branch name from git: ${error}`)
   }
 }
 
@@ -71,9 +72,7 @@ function _getPR(inputs) {
   try {
     return args.pr || ''
   } catch (error) {
-    throw new Error(
-      `There was an error getting the branch name from git: ${error}`,
-    )
+    logAndThrow(`There was an error getting the pr number: ${error}`)
   }
 }
 
@@ -105,9 +104,7 @@ function _getSHA(inputs) {
   try {
     return args.sha || ''
   } catch (error) {
-    throw new Error(
-      `There was an error getting the commit SHA from git: ${error}`,
-    )
+    logAndThrow(`There was an error getting the commit SHA from git: ${error}`)
   }
 }
 /**
@@ -121,7 +118,7 @@ function _getSlug(inputs) {
   try {
     return args.slug || ''
   } catch (error) {
-    throw new Error(`There was an error getting the slug from git: ${error}`)
+    logAndThrow(`There was an error getting the slug from git: ${error}`)
   }
 }
 /**

src/helpers/files.js

@@ -3,8 +3,8 @@ const childProcess = require('child_process')
 const fs = require('fs')
 const glob = require('glob')
 const path = require('path').posix
-
-const { log } = require('./logger')
+const { logAndThrow } = require('./util')
+const { error, info, verbose } = require('./logger')
 
 /**
  *
@@ -195,7 +195,8 @@ function fetchGitRoot() {
       process.cwd()
     ).trimRight()
   } catch (error) {
-    throw new Error('Error fetching git root. Please try using the -R flag.')
+    logAndThrow('Error fetching git root. Please try using the -R flag.')
+    return '.'
   }
 }
 
@@ -206,11 +207,12 @@ function fetchGitRoot() {
  */
 function parseGitIgnore(projectRoot) {
   const gitIgnorePath = path.join(projectRoot, '.gitignore')
-  let lines
+  /** @type {string[]} */
+  let lines = []
   try {
     lines = readAllLines(gitIgnorePath) || []
   } catch (error) {
-    throw new Error(`Unable to open ${gitIgnorePath}: ${error}`)
+    logAndThrow(`Unable to open ${gitIgnorePath}: ${error}`)
   }
 
   return lines.filter(line => {
@@ -226,11 +228,12 @@ function parseGitIgnore(projectRoot) {
  * @param {string} projectRoot Root of the project
  * @param {string} dirPath Directory to search in
  * @param {Object} args
+ * @param {boolean} [args.verbose]
  * @param {string[]} arrayOfFiles
  * @returns {string[]}
  */
 function getAllFiles(projectRoot, dirPath, args, arrayOfFiles = []) {
-  log(`Searching for files in ${dirPath}`, { level: 'debug', args })
+  verbose(`Searching for files in ${dirPath}`, args.verbose)
   const files = fs.readdirSync(dirPath)
 
   files.forEach(function (file) {
@@ -250,7 +253,7 @@ function getAllFiles(projectRoot, dirPath, args, arrayOfFiles = []) {
       )
     }
   })
-  log(`Search complete for files in ${dirPath}`, { level: 'debug', args })
+  verbose(`Search complete for files in ${dirPath}`, args.verbose)
   return arrayOfFiles
 }
 
@@ -278,8 +281,9 @@ function readCoverageFile(projectRoot, filePath) {
       encoding: 'utf-8',
     })
   } catch (error) {
-    throw new Error(`There was an error reading the coverage file: ${error}`)
+    logAndThrow(`There was an error reading the coverage file: ${error}`)
   }
+  return ''
 }
 
 function endNetworkMarker() {
@@ -332,7 +336,7 @@ function getFilePath(projectRoot, filePath) {
 function removeFile(projectRoot, filePath) {
   fs.unlink(getFilePath(projectRoot, filePath), err => {
     if (err) {
-      log(`Error removing ${filePath} coverage file`)
+      error(`Error removing ${filePath} coverage file`)
     }
   })
 }

src/helpers/git.js

@@ -1,4 +1,5 @@
 const childProcess = require('child_process')
+const { logAndThrow } = require('./util')
 
 function parseSlug(slug) {
   // origin    https://github.com/torvalds/linux.git (fetch)
@@ -18,18 +19,16 @@ function parseSlug(slug) {
     const cleanSlug = slug.split(':')[1].replace('.git', '')
     return cleanSlug
   }
-  throw new Error(`Unable to parse slug URL: ${slug}`)
+  logAndThrow(`Unable to parse slug URL: ${slug}`)
 }
 
 function parseSlugFromRemoteAddr(remoteAddr) {
   let slug = ''
   if (!remoteAddr) {
-    remoteAddr = (childProcess
-      .spawnSync('git', [
-        'config',
-        '--get',
-        'remote.origin.url',
-      ]).stdout || '')
+    remoteAddr = (
+      childProcess.spawnSync('git', ['config', '--get', 'remote.origin.url'])
+        .stdout || ''
+    )
       .toString()
       .trimRight()
   }

src/helpers/logger.js

@@ -1,7 +1,21 @@
 // @ts-check
 
 /**
- *
+ *  We really only need three log levels
+ * * Error
+ * * Info
+ * * Verbose
+ * For the purposes of minimal refactor, I'm aliasing debug() to verbose()
+ * I'm also mapping the log() options to the new calls and
+ * deprecating log()
+ */
+
+function _getTimestamp() {
+  return new Date().toISOString()
+}
+
+/**
+ * @deprecated - Please use error(), info(), or verbose()
  * @param {string} message
  * @param {Object} [options]
  * @param {string} [options.level]
@@ -11,24 +25,56 @@
  */
 function log(message, options) {
   if (!options || !options.level) {
-    return console.log(message)
+    return info(message)
   }
   switch (options.level) {
     case 'debug':
       if (options.args && options.args.verbose) {
-        console.debug(message)
+        return verbose(message, true)
       }
 
       break
     case 'error':
-      console.error(message)
-      break
+      return error(message)
     default:
-      console.log(message)
-      break
+      return info(message)
+  }
+}
+
+/**
+ *
+ * @param {string} message - message to log
+ * @param {boolean} shouldVerbose - pass the value of the verbose flag
+ * @return void
+ */
+function verbose(message, shouldVerbose = false) {
+  if (shouldVerbose === true) {
+    console.debug(`[${_getTimestamp()}] ['verbose'] ${message}`)
   }
 }
 
+/**
+ *
+ * @param {string} message - message to log
+ * @return void
+ */
+function error(message) {
+  console.error(`[${_getTimestamp()}] ['error'] ${message}`)
+}
+
+/**
+ *
+ * @param {string} message - message to log
+ * @return void
+ */
+function info(message) {
+  console.log(`[${_getTimestamp()}] ['info'] ${message}`)
+}
+
 module.exports = {
+  debug: verbose,
+  error,
+  info,
   log,
+  verbose,
 }