feat(summary): adds summary report to the end of the export

closes #11

Author: Benedikt Rötsch

bin/contentful-export

@@ -12,6 +12,6 @@ runContentfulExport(usageParams)
   process.exit(0)
 })
 .catch((err) => {
-  log.error('', 'Failed with\n', err)
+  log.error('export', 'Failed with\n', err)
   process.exit(1)
 })

lib/index.js

@@ -7,6 +7,11 @@ import Promise from 'bluebird'
 import jsonStringifySafe from 'json-stringify-safe'
 import log from 'npmlog'
 import { resolve } from 'path'
+import { startCase } from 'lodash'
+import Table from 'cli-table2'
+import moment from 'moment'
+
+const summary = {}
 
 export default function runContentfulExport (usageParams) {
   const defaultOpts = {
@@ -20,6 +25,8 @@ export default function runContentfulExport (usageParams) {
     saveFile: true
   }
 
+  summary.startTime = moment()
+
   const configFile = usageParams.config
     ? require(resolve(process.cwd(), usageParams.config))
     : {}
@@ -60,52 +67,83 @@ export default function runContentfulExport (usageParams) {
       if (!opts.downloadAssets) {
         return response
       }
-      let successCount = 0
-      let warningCount = 0
-      let errorCount = 0
+      summary.assetDownloads = {
+        successCount: 0,
+        warningCount: 0,
+        errorCount: 0
+      }
 
-      log.info('Downloading ' + response.assets.length + ' assets')
+      log.info('export', 'Downloading ' + response.assets.length + ' assets')
 
       return Promise.map(response.assets, (asset) => {
         if (!asset.fields.file) {
-          log.warn('-> asset has no file(s)', jsonStringifySafe(asset))
-          warningCount++
+          log.warn('export', '-> asset has no file(s)', jsonStringifySafe(asset))
+          summary.assetDownloads.warningCount++
           return
         }
         const locales = Object.keys(asset.fields.file)
         return Promise.mapSeries(locales, (locale) => {
           const url = asset.fields.file[locale].url || asset.fields.file[locale].upload
+          if (!url) {
+            log.warn('export', '-> asset no file(s) for locale', locale, jsonStringifySafe(asset))
+            summary.assetDownloads.warningCount++
+            return
+          }
           return downloadAsset(url, opts.exportDir)
           .then((downLoadedFile) => {
-            log.info('-> ' + downLoadedFile)
-            successCount++
+            log.info('export', '-> ' + downLoadedFile)
+            summary.assetDownloads.successCount++
           })
           .catch((error) => {
-            log.error('-> error downloading ' + url + ' => ' + error.message)
-            log.error(JSON.stringify(error, null, 2))
-            errorCount++
+            log.error('export', '-> error downloading ' + url + ' => ' + error.message)
+            log.error('export', JSON.stringify(error, null, 2))
+            summary.assetDownloads.errorCount++
           })
         })
       }, {
         concurrency: 6
       })
       .then(() => {
-        log.info('All ' + response.assets.length + ' assets downloaded.')
-        log.info('Successful file downloads: ' + successCount)
-        log.info('Download warnings: ' + warningCount)
-        log.info('Download errors: ' + errorCount)
+        log.info('export', 'Finished loading files for ' + response.assets.length + ' assets.')
         return response
       })
     })
     .then((response) => {
       if (opts.saveFile) {
         fs.existsSync(opts.exportDir) || fs.mkdirSync(opts.exportDir)
         const responseFile = `${opts.exportDir}/contentful-export-${clients.source.spaceId}-${Date.now()}.json`
-        log.info('Writing space data to json file at : ' + responseFile)
+        log.info('export', 'Writing space data to json file at : ' + responseFile)
         fs.writeFileSync(responseFile, jsonStringifySafe(response, null, 4))
       }
       return response
     })
+    .then((response) => {
+      const responseTable = new Table()
+
+      responseTable.push([{colSpan: 2, content: 'Exported entities'}])
+
+      Object.keys(response).forEach((type) => {
+        responseTable.push([startCase(type), response[type].length])
+      })
+
+      console.log(responseTable.toString())
+
+      if ('assetDownloads' in summary) {
+        const downloadsTable = new Table()
+        downloadsTable.push([{colSpan: 2, content: 'Asset file download results'}])
+        downloadsTable.push(['Successful', summary.assetDownloads.successCount])
+        downloadsTable.push(['Warnings ', summary.assetDownloads.warningCount])
+        downloadsTable.push(['Errors ', summary.assetDownloads.errorCount])
+        console.log(downloadsTable.toString())
+      }
+
+      const durationHuman = summary.startTime.fromNow(true)
+      const durationSeconds = moment().diff(summary.startTime, 'seconds')
+
+      log.info('export', `The export took ${durationHuman} (${durationSeconds}s)`)
+
+      return response
+    })
     .catch((err) => {
       const { sourceSpace, errorLogFile } = opts
       dumpErrorBuffer({

package.json

@@ -49,10 +49,12 @@
   },
   "dependencies": {
     "bluebird": "^3.3.3",
+    "cli-table2": "^0.2.0",
     "contentful-batch-libs": "^5.3.0",
     "fs-extra": "^2.1.2",
     "json-stringify-safe": "^5.0.1",
     "lodash": "^4.0.0",
+    "moment": "^2.18.1",
     "npmlog": "^4.0.0",
     "request": "^2.81.0",
     "yargs": "^7.0.2"

yarn.lock

@@ -909,6 +909,15 @@ cli-cursor@^1.0.1, cli-cursor@^1.0.2:
   dependencies:
     restore-cursor "^1.0.1"
 
+cli-table2@^0.2.0:
+  version "0.2.0"
+  resolved "https://registry.yarnpkg.com/cli-table2/-/cli-table2-0.2.0.tgz#2d1ef7f218a0e786e214540562d4bd177fe32d97"
+  dependencies:
+    lodash "^3.10.1"
+    string-width "^1.0.1"
+  optionalDependencies:
+    colors "^1.1.2"
+
 cli-width@^2.0.0:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/cli-width/-/cli-width-2.1.0.tgz#b234ca209b29ef66fc518d9b98d5847b00edf00a"
@@ -937,6 +946,10 @@ code-point-at@^1.0.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/code-point-at/-/code-point-at-1.1.0.tgz#0d070b4d043a5bea33a2f1a40e2edb3d9a4ccf77"
 
+colors@^1.1.2:
+  version "1.1.2"
+  resolved "https://registry.yarnpkg.com/colors/-/colors-1.1.2.tgz#168a4701756b6a7f51a12ce0c97bfa28c084ed63"
+
 combined-stream@^1.0.5, combined-stream@~1.0.5:
   version "1.0.5"
   resolved "https://registry.yarnpkg.com/combined-stream/-/combined-stream-1.0.5.tgz#938370a57b4a51dea2c77c15d5c5fdf895164009"
@@ -2429,7 +2442,7 @@ lodash.restparam@^3.0.0:
   version "3.6.1"
   resolved "https://registry.yarnpkg.com/lodash.restparam/-/lodash.restparam-3.6.1.tgz#936a4e309ef330a7645ed4145986c85ae5b20805"
 
-lodash@^3.6.0:
+lodash@^3.10.1, lodash@^3.6.0:
   version "3.10.1"
   resolved "https://registry.yarnpkg.com/lodash/-/lodash-3.10.1.tgz#5bf45e8e49ba4189e17d482789dfd15bd140b7b6"
 
@@ -2563,6 +2576,10 @@ [email protected], "mkdirp@>=0.5 0", mkdirp@^0.5.0, mkdirp@^0.5.1, mkdirp@~0.5.1:
   dependencies:
     minimist "0.0.8"
 
+moment@^2.18.1:
+  version "2.18.1"
+  resolved "https://registry.yarnpkg.com/moment/-/moment-2.18.1.tgz#c36193dd3ce1c2eed2adb7c802dbbc77a81b1c0f"
+
 [email protected]:
   version "0.7.1"
   resolved "https://registry.yarnpkg.com/ms/-/ms-0.7.1.tgz#9cd13c03adbff25b65effde7ce864ee952017098"