Add exception handling in OpenAPI

Author: canmingir

index.js

@@ -39,10 +39,10 @@ const run = (statement, p2, p3) => {
 
 const accept = (req, res, fn) => {
   const scope = { params: req.params, query: req.query, body: req.body };
-  const { result } = run(fn, scope, { details: true });
+  const { result, error } = run(fn, scope, { details: true });
   if (!result) res.status(404).end();
-  else if (result === true) res.end();
-  else res.send(Number.isInteger(result) ? result.toString() : result);
+  else if (error) res.status(400).json(result);
+  else res.status(200).json(result);
 };
 
 module.exports = (options) => {

src/libs/openapi.js

@@ -98,8 +98,10 @@ const load = ({ api, types }) => {
         file,
         `function ${method}(req, res) {` +
           `const scope = { params: req.params, query: req.query, body: req.body };` +
-          `const result = nucleoid.run(${action},scope);` +
-          `res.json(result);` +
+          `const { result, error } = nucleoid.run(${action}, scope, { details: true });` +
+          `if (!result) res.status(404).end();` +
+          `else if (error) res.status(400).json(result);` +
+          `else res.status(200).json(result);` +
           `}`
       );
       fs.appendFileSync(file, `${method}.apiDoc = ${JSON.stringify(apiDoc)};`);

src/services/test/data.json

@@ -18,7 +18,7 @@
         "response": {
           "$ref": "#/components/schemas/Item"
         },
-        "action": "function action(req){ const name=req.body.name;const barcode=req.body.barcode;return new Item(name,barcode); }"
+        "action": "function action(req){ const name=req.body.name;const barcode=req.body.barcode; if(!name) { throw 'INVALID_NAME' } return new Item(name, barcode); }"
       }
     },
     "/items/{item}": {

src/services/test/openapi.spec.js

@@ -32,9 +32,21 @@ describe("OpenAPI service", () => {
       name: "ITEM-1",
     });
 
-    const res4 = await request(terminal)
+    const res4 = await request(openapi.app())
+      .post("/api/items")
+      .send({ barcode: "BARCODE-1" });
+    equal(res4.status, 400);
+    equal(res4.body, "INVALID_NAME");
+
+    const res5 = await request(openapi.app())
+      .get("/api/items/invalid_item")
+      .send();
+    equal(res5.status, 404);
+    equal(res5.text, "");
+
+    const res6 = await request(terminal)
       .post("/openapi")
       .send({ action: "stop" });
-    equal(res4.status, 200);
+    equal(res6.status, 200);
   });
 });

src/test/api.spec.js

@@ -1,6 +1,6 @@
 const test = require("../libs/test");
 const request = require("supertest");
-const { deepEqual } = require("assert");
+const { equal, deepEqual } = require("assert");
 const nucleoid = require("../../index");
 const openapi = require("../libs/openapi");
 const _ = require("lodash");
@@ -104,4 +104,31 @@ describe("Nucleoid API", () => {
       },
     ]);
   });
+
+  it("Exception Handling", async () => {
+    const app = nucleoid(options);
+    class User {
+      constructor(name) {
+        this.name = name;
+      }
+    }
+    nucleoid.register(User);
+
+    app.get("/users/:user", (req) => User[req.params.user]);
+    app.post("/users", (req) => {
+      const name = req.body.name;
+      if (!name) {
+        throw "INVALID_NAME";
+      }
+      new User(req.body.name);
+    });
+
+    const res1 = await request(app).post("/users").send();
+    equal(res1.status, 400);
+    equal(res1.body, "INVALID_NAME");
+
+    const res2 = await request(app).get("/users/invalid_user").send();
+    equal(res2.status, 404);
+    deepEqual(res2.text, "");
+  });
 });