feat: added error context and message id to build in api errors

Author: Lukas Siemon

lib/api.js

@@ -29,7 +29,9 @@ const Parser = (request, params) => {
     try {
       body = JSON.parse(get(event, 'body', '{}'));
     } catch (e) {
-      throw response.ApiError("Invalid Json Body detected.");
+      throw response.ApiError("Invalid Json Body detected.", 400, 99001, {
+        value: get(event, 'body')
+      });
     }
     const eventParsed = Object.assign({}, event, { body });
     params.forEach(p => p.feed(eventParsed));

lib/param.js

@@ -29,11 +29,12 @@ class Param {
     const result = get(this.event, `${types[this.type]}.${this.name}`);
     if (result === undefined) {
       if (this.required) {
-        throw response.ApiError(`Required ${this.type}-Parameter "${this.name}" missing.`);
+        throw response.ApiError(`Required ${this.type}-Parameter "${this.name}" missing.`, 400, 99002);
       }
     } else if (!this.validate(result)) {
-      // todo: add context
-      throw response.ApiError(`Invalid Value for ${this.type}-Parameter "${this.name}" provided.`);
+      throw response.ApiError(`Invalid Value for ${this.type}-Parameter "${this.name}" provided.`, 400, 99003, {
+        value: result
+      });
     }
     return result;
   }

test/handler/test_param_invalid_body.json

@@ -4,7 +4,7 @@
   "timeout": 2000,
   "response": [
     {
-      "to.deep.equal": "{\"statusCode\":400,\"body\":\"{\\\"message\\\":\\\"Invalid Json Body detected.\\\"}\"}"
+      "to.deep.equal": "{\"statusCode\":400,\"body\":\"{\\\"message\\\":\\\"Invalid Json Body detected.\\\",\\\"messageId\\\":99001,\\\"context\\\":{\\\"value\\\":\\\"invalid_json_string\\\"}}\"}"
     }
   ],
   "logs": [

test/handler/test_param_invalid_email.json

@@ -4,7 +4,7 @@
   "timeout": 2000,
   "response": [
     {
-      "to.deep.equal": "{\"statusCode\":400,\"body\":\"{\\\"message\\\":\\\"Invalid Value for json-Parameter \\\\\\\"email\\\\\\\" provided.\\\"}\"}"
+      "to.deep.equal": "{\"statusCode\":400,\"body\":\"{\\\"message\\\":\\\"Invalid Value for json-Parameter \\\\\\\"email\\\\\\\" provided.\\\",\\\"messageId\\\":99003,\\\"context\\\":{\\\"value\\\":\\\"invalid@email\\\"}}\"}"
     }
   ],
   "logs": [

test/handler/test_param_missing_required.json

@@ -4,7 +4,7 @@
   "timeout": 2000,
   "response": [
     {
-      "to.deep.equal": "{\"statusCode\":400,\"body\":\"{\\\"message\\\":\\\"Required json-Parameter \\\\\\\"username\\\\\\\" missing.\\\"}\"}"
+      "to.deep.equal": "{\"statusCode\":400,\"body\":\"{\\\"message\\\":\\\"Required json-Parameter \\\\\\\"username\\\\\\\" missing.\\\",\\\"messageId\\\":99002}\"}"
     }
   ],
   "logs": [

test/handler/test_param_not_string.json

@@ -4,7 +4,7 @@
   "timeout": 2000,
   "response": [
     {
-      "to.deep.equal": "{\"statusCode\":400,\"body\":\"{\\\"message\\\":\\\"Invalid Value for json-Parameter \\\\\\\"username\\\\\\\" provided.\\\"}\"}"
+      "to.deep.equal": "{\"statusCode\":400,\"body\":\"{\\\"message\\\":\\\"Invalid Value for json-Parameter \\\\\\\"username\\\\\\\" provided.\\\",\\\"messageId\\\":99003,\\\"context\\\":{\\\"value\\\":{}}}\"}"
     }
   ],
   "logs": [