ac-custom-error 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+<a name="0.2.0"></a>
+ 
+# [0.2.0](https://github.com/admiralcloud/ac-custom-error/compare/v0.1.0..v0.2.0) (2023-03-12 11:47:33)
+
+
+### Feature
+
+* **App:** Enhance error with options | MP | [53ada866bf85e3c9a9f50583efd1f9f11debab50](https://github.com/admiralcloud/ac-custom-error/commit/53ada866bf85e3c9a9f50583efd1f9f11debab50)    
+In addition to additionalInfo, the error can now also contain options. Use options for further error processing in you app.  
+Related issues: [undefined/undefined#master](undefined/browse/master)
 <a name="0.1.0"></a>
  
 # [0.1.0](https://github.com/admiralcloud/ac-custom-error/compare/..v0.1.0) (2023-03-10 13:45:10)

package/README.md

@@ -4,21 +4,47 @@ Extend the NodeJS error with an error code and additional information.
 [![Node.js CI](https://github.com/AdmiralCloud/ac-custom-error/actions/workflows/node.js.yml/badge.svg)](https://github.com/AdmiralCloud/ac-custom-error/actions/workflows/node.js.yml)
 
 # Usage
+Use it just like the built-in error:
++ first parameter is the actual error message as string
++ second parameter is the error code 
++ third parameter is an optional object of additional information (e.g. variables clarifying the error)
++ fouth parameter is an optional object of options that can help further processing of the error 
+
+## Example
 ```
 const ACError = require('ac-custom-error')
 
-throw new ACError('myError', 123, { id: 333 })
+throw new ACError('myError', 123, { id: 333 }, { stack: true })
 
 // OUTPUT 
 ACError: myError
     at STACK
   code: 123,
   errorMessage: 'myError',
-  additionalInfo: { id: 333 }
+  additionalInfo: { id: 333 },
+  options: { stack: true }
 }
 
 ```
 
+### How to use options
+You might have an app were you would like to distinguish between soft errors (e.g. a requested ID is not available) and hard errors (that are bugs in the code). The first one should be logged as information in the code (maybe not even on ERROR level). The second one, the hard error, should probably contain as much information as possible for further debugging, so you want to log the stack as well.
+
+```
+// EXAMPLE soft error
+throw new Error('userIdInvalid', 10223, { id: 12345 })
+// will e.g. log like this
+WARN | userIdInvalid | 10223 | { id: 12345 }
+
+// EXAMPLE hard error
+throw new Error('SQLinvalid', 13001, { query: 'SELECT FROM a' }, { stack: true })
+// will e.g. log like this
+ACError: SQLinvalid
+  at SQLconnect (/pathTofile:150:10)
+  ...
+ERROR | SQLinvalid | 13001 | { query: 'SELECT FROM a' }
+```
+
 
 # Links
 - [Website](https://www.admiralcloud.com/)

package/index.js

@@ -1,5 +1,5 @@
 class ACError extends Error {
-  constructor(message, code, additionalInfo = {}) {
+  constructor(message, code, additionalInfo = {}, options = {}) {
     super(message)
     
     if (Error.captureStackTrace) {
@@ -8,10 +8,14 @@ class ACError extends Error {
     // info
     this.code = code || -1
     this.errorMessage = message
-    // show other properties of options object
+    // show other properties of the error (usually additional payload parameters that clarify the error)
     if (Object.keys(additionalInfo).length) {
       this.additionalInfo = additionalInfo
     }
+    // options 
+    if (Object.keys(options).length) {
+      this.options = options
+    }
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ac-custom-error",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Custom NodeJS error with error code and additional info",
   "main": "index.js",
   "repository": "https://github.com/AdmiralCloud/ac-custom-error",

package/test.js

@@ -2,8 +2,8 @@ const { expect } = require('chai')
 
 const ACError = require('./index')
 
-const errorFunction = ({ message, code, additionalInfo }) => {
-  throw new ACError(message, code, additionalInfo)
+const errorFunction = ({ message, code, additionalInfo, options }) => {
+  throw new ACError(message, code, additionalInfo, options )
 }
 
 
@@ -38,5 +38,20 @@ describe('Run tests', () => {
     expect(error.additionalInfo.id).to.equal(errorParams.additionalInfo.id)
   })
 
+  it('Check that options are available', () => {
+    let errorParams = { message: 'myError', code: 123, additionalInfo: {}, options: { stack: true } }
+    let error
+    try {
+      errorFunction(errorParams)
+    }
+    catch (err) {
+      error = err
+    }
+    expect(error).to.be.an('Error')
+    expect(error.message).to.equal(errorParams.message)
+    expect(error.code).to.equal(errorParams.code)
+    expect(error.options).to.have.property('stack', errorParams.options.stack)
+  })
+
 })