add comments

Author: marcuspoehls

lib/error-handler.js

@@ -18,13 +18,28 @@ class ErrorHandler {
     this.links = Array.isArray(links) ? links : [links]
   }
 
+  /**
+   * Creates Google and Stack Overflow links
+   * which allow the user to search for
+   * help on these platforms.
+   *
+   * @returns {Array}
+   */
   defaultLinks () {
     return [
       (error) => this.google(error),
       (error) => this.stackOverflow(error)
     ]
   }
 
+  /**
+   * Resolve a Google link with
+   * the error’s message.
+   *
+   * @param {Object} error
+   *
+   * @returns {String}
+   */
   google (error) {
     return `
       <a
@@ -35,6 +50,14 @@ class ErrorHandler {
       </a>`
   }
 
+  /**
+   * Resolve a Stack Overflow link
+   * with the error’s message.
+   *
+   * @param {Object} error
+   *
+   * @returns {String}
+   */
   stackOverflow (error) {
     return `
       <a
@@ -45,14 +68,38 @@ class ErrorHandler {
       </a>`
   }
 
+  /**
+   * Read the icon from disk.
+   *
+   * @param {String} name
+   *
+   * @returns {String}
+   */
   resolveIcon (name) {
     return Fs.readFileSync(this.resolveIconPath(name))
   }
 
+  /**
+   * Resolve the icon’s path on the disk.
+   *
+   * @param {String} name
+   *
+   * @returns {String}
+   */
   resolveIconPath (name) {
     return Path.resolve(__dirname, 'icons', `${name}.svg`)
   }
 
+  /**
+   * Check the outgoing response whether it’s
+   * a developer error. If yes, show the
+   * error details view.
+   *
+   * @param {Request} request
+   * @param {Toolkit} h
+   *
+   * @returns {Response}
+   */
   async handle (request, h) {
     if (this.isDeveloperError(request.response)) {
       return this.resolveError(request, h)
@@ -61,10 +108,25 @@ class ErrorHandler {
     return h.continue
   }
 
+  /**
+   * Check whether the `error` is a 500 error
+   *
+   * @param {Object} error
+   *
+   * @returns {Boolean}
+   */
   isDeveloperError (error) {
     return error.isBoom && error.output.statusCode === 500
   }
 
+  /**
+   * Resolve the error and format, JSON or HTML.
+   *
+   * @param {Request} request
+   * @param {Toolkit} h
+   *
+   * @returns {Response}
+   */
   async resolveError (request, h) {
     await this.logToTerminal(request)
 
@@ -79,6 +141,11 @@ class ErrorHandler {
     return this.sendHtml(request, h)
   }
 
+  /**
+   * Logs the error to terminal.
+   *
+   * @param {Request} request
+   */
   async logToTerminal (request) {
     if (this.toTerminal) {
       const youch = this.createYouch(request)
@@ -88,6 +155,15 @@ class ErrorHandler {
     }
   }
 
+  /**
+   * Create a Youch instance to render a
+   * detailed error view or serialize
+   * the error to JSON.
+   *
+   * @param {Request} request
+   *
+   * @returns {Object}
+   */
   createYouch (request) {
     const error = request.response
     error.status = error.output.statusCode
@@ -104,16 +180,40 @@ class ErrorHandler {
     }
   }
 
+  /**
+   * Determines whether the request
+   * expects JSON in response.
+   *
+   * @param {Request} request
+   *
+   * @returns {Boolean}
+   */
   wantsJson (request) {
     const { 'user-agent': agent, accept } = request.raw.req.headers
 
     return this.matches(agent, /curl|wget|postman|insomnia/i) || this.matches(accept, /json/)
   }
 
+  /**
+   * Determine whether the given `str`
+   * matches the `regex`.
+   *
+   * @param {String} str
+   * @param {String} regex
+   *
+   * @returns {Boolean}
+   */
   matches (str, regex) {
     return str && str.match(regex)
   }
 
+  /**
+   * Create an error object.
+   *
+   * @param {Request} request
+   *
+   * @returns {Object}
+   */
   composeError (request) {
     const error = request.response
 
@@ -129,6 +229,14 @@ class ErrorHandler {
     }
   }
 
+  /**
+   * Respond the request with JSON.
+   *
+   * @param {Request} request
+   * @param {Toolkit} h
+   *
+   * @returns {Response}
+   */
   sendJson (request, h) {
     const error = this.composeError(request)
     const json = this.resolveJson(error)
@@ -139,17 +247,39 @@ class ErrorHandler {
       .code(error.statusCode)
   }
 
+  /**
+   * JSON.stringify the error object and
+   * prettify the stackstrace.
+   *
+   * @param {Object} data
+   *
+   * @returns {String}
+   */
   resolveJson (data) {
     return JSON.stringify({
       ...data,
       stacktrace: data.stacktrace.split('\n').map(line => line.trim())
     })
   }
 
+  /**
+   * Determine whether the user wants to
+   * render their own template.
+   *
+   * @returns {Boolean}
+   */
   hasTemplate () {
     return !!this.template
   }
 
+  /**
+   * Render the defined user template.
+   *
+   * @param {Request} request
+   * @param {Toolkit} h
+   *
+   * @returns {Response}
+   */
   renderTemplate (request, h) {
     const error = this.composeError(request)
 
@@ -158,6 +288,14 @@ class ErrorHandler {
       .code(error.statusCode)
   }
 
+  /**
+   * Respond the request with HTML.
+   *
+   * @param {Request} request
+   * @param {Toolkit} h
+   *
+   * @returns {Response}
+   */
   async sendHtml (request, h) {
     const youch = this.createYouch(request)
     const statusCode = request.response.output.statusCode