Add logging to primary logic functions

Author: thedoorbell

src/downloadFiles.js

@@ -1,32 +1,44 @@
 import path from 'path'
 import fsp from 'fs/promises'
+import debug from 'debug'
 import getData from './getData.js'
 import generateName from './generateName.js'
 
+const log = debug('page-loader')
+
 const downloadFiles = ($, url, filesDirPath, selector, attr) => {
   const links = $(selector).map((i, tag) => $(tag).attr(attr)).get()
 
   if (links.length === 0) {
+    log('no %s links', selector)
     return Promise.resolve()
   }
 
+  log(`download %ss`, selector)
   return fsp.mkdir(filesDirPath, { recursive: true })
     .then(() => Promise.all(links.map((link) => {
       const absLink = new URL(link, url)
       if (absLink.hostname !== new URL(url).hostname) {
+        log('skip external link %s', absLink.href)
         return Promise.resolve()
       }
       const fileName = path.extname(absLink.pathname)
         ? generateName(absLink.href).replace(/-(?=[a-zA-Z0-9]+$)/, '.')
         : generateName(absLink.href) + '.html'
       const filePath = path.join(filesDirPath, fileName)
 
+      log('download file %s', absLink.href)
       return getData(absLink.href)
-        .then(data => fsp.writeFile(filePath, data))
+        .then((data) => {
+          log('write to file %s', filePath)
+          return fsp.writeFile(filePath, data)
+        })
         .then(() => {
+          const newLink = path.join(path.basename(filesDirPath), fileName)
+          log('change link from %s to %s in HTML', link, newLink)
           $(selector).each((i, tag) => {
             if ($(tag).attr(attr) === link) {
-              $(tag).attr(attr, path.join(path.basename(filesDirPath), fileName))
+              $(tag).attr(attr, newLink)
             }
           })
         })

src/getData.js

@@ -1,4 +1,25 @@
 import axios from 'axios'
+import axiosDebugLog from 'axios-debug-log'
+import debug from 'debug'
+
+const log = debug('page-loader')
+
+axiosDebugLog({
+  debug: log,
+  request: (debug, config) => {
+    debug('Request with ' + config.headers['content-type'], config.url)
+  },
+  response: (debug, response) => {
+    debug(
+      'Response with ' + response.headers['content-type'],
+      'from ' + response.config.url,
+      'status ' + response.status,
+    )
+  },
+  error: (debug, error) => {
+    debug(`Error: ${error.message}`)
+  },
+})
 
 const getData = url => axios
   .get(url, { responseType: 'arraybuffer' })

src/index.js

@@ -2,34 +2,55 @@ import path from 'path'
 import fsp from 'fs/promises'
 import * as cheerio from 'cheerio'
 import * as prettier from 'prettier'
+import debug from 'debug'
 import getData from './getData.js'
 import downloadFiles from './downloadFiles.js'
 import generateName from './generateName.js'
 
+const log = debug('page-loader')
+
 const getAbsolutePath = dirpath => path.resolve(process.cwd(), dirpath)
 
 const downloadPage = (url, outputDir) => {
+  log('download page %s to %s', url, outputDir)
+
+  const absOutputDir = getAbsolutePath(outputDir)
   const fileName = generateName(url) + '.html'
-  const filePath = path.join(getAbsolutePath(outputDir), fileName)
+  const filePath = path.join(absOutputDir, fileName)
   const filesDirName = generateName(url) + '_files'
-  const filesDirPath = path.join(getAbsolutePath(outputDir), filesDirName)
-  let $
+  const filesDirPath = path.join(absOutputDir, filesDirName)
 
-  return getData(url)
+  return fsp.access(absOutputDir)
+    .then(() => {
+      log('output dir exists')
+      return getData(url)
+    })
     .then((html) => {
-      $ = cheerio.load(html)
+      log('HTML downloaded')
+      const $ = cheerio.load(html)
 
       return Promise.all([
         downloadFiles($, url, filesDirPath, 'img', 'src'),
         downloadFiles($, url, filesDirPath, 'link', 'href'),
         downloadFiles($, url, filesDirPath, 'script', 'src'),
       ])
+        .then(() => $)
+    })
+    .then(($) => {
+      log('files downloaded, format HTML')
+      return prettier.format($.html(), { parser: 'html' })
+    })
+    .then((formattedHtml) => {
+      log('write to file %s', filePath)
+      return fsp.writeFile(filePath, formattedHtml)
+    })
+    .then(() => {
+      log('done, output file is %s', filePath)
+      return filePath
     })
-    .then(() => prettier.format($.html(), { parser: 'html' }))
-    .then(formattedHtml => fsp.writeFile(filePath, formattedHtml))
-    .then(() => filePath)
     .catch((err) => {
       // console.error('Full error:', err)
+      log('error: %s', err.message)
       throw new Error(`Error: ${err.message}`)
     })
 }