Merge pull request #63 from gchq/release/0.0.10

Release/0.0.10

app.js

@@ -12,6 +12,7 @@ import helmet from "helmet";
 
 import bakeRouter from "./routes/bake";
 import magicRouter from "./routes/magic";
+import healthRouter from "./routes/health.js";
 
 const app = express();
 app.disable("x-powered-by");
@@ -41,6 +42,7 @@ app.use(cookieParser());
 const swaggerFile = fs.readFileSync("./swagger.yml", "utf8");
 
 // Routes
+app.use("/health", healthRouter);
 app.use("/bake", bakeRouter);
 app.use("/magic", magicRouter);
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cyberchef-server",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "An application providing API access to CyberChef",
   "author": "d98762625 <d98762625@gmail.com>",
   "license": "Apache-2.0",

routes/health.js

@@ -0,0 +1,21 @@
+import { Router } from "express";
+const router = Router();
+
+/**
+ * bakePost
+ */
+router.get("/", async function healthGet(req, res, next) {
+    const healthcheck = {
+        uptime: process.uptime(),
+        message: "OK",
+        timestamp: Date()
+    };
+    try {
+        res.send(healthcheck);
+    } catch (error) {
+        healthcheck.message = error;
+        res.status(503).send();
+    }
+});
+
+export default router;

swagger.yml

@@ -2,10 +2,38 @@ openapi: 3.0.0
 info:
   title: CyberChef API
   description: A HTTP API that exposes some of CyberChef's functionality.
-  version: 0.0.9
+  version: 0.0.10
 
 
 paths:
+  /health:
+    get:
+      summary: Server healthcheck
+      description: >
+        If the server is up, returns a 200 response and some basic info about uptime
+
+      responses:
+        '200':
+          description: Server is alive and healthy
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/HealthResponse"
+              example:
+                uptime: 1138.00
+                message: "OK"
+                timestamp: "Thu Dec 17 2017 19:23:54 GMT+0000"
+
+        '503':
+          description: Server error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/HealthResponse"
+              example:
+                uptime: 1138.00
+                message: "Internal Server Error: Not enough biscuits"
+                timestamp: "Thu Dec 19 2019 19:23:54 GMT+0000"
   /bake:
     post:
       summary: Bakes a recipe
@@ -40,8 +68,7 @@ paths:
           content:
             application/json:
               schema:
-                type: "string"
-                value: "Object"
+                $ref:  "#/components/schemas/BakeResponse"
               example:
                 type: "string"
                 value: "01001110,01111010,01001101,01100111,01001110,01101101,01011001,01100111,01001110,01101101,01010001,01100111,01001110,01101010,01010101,01100111,01001101,01101010,01000001,01100111,01001110,01101010,01101011,01100111,01001110,01101101,01010101,01100111,01001110,01111010,01000001,01100111,01001110,01111010,01010101,01100111,01001110,01111010,01010001,00111101"
@@ -71,9 +98,7 @@ paths:
           content:
             application/json:
               schema:
-                type: "string"
-                value:
-                  $ref: "#/components/schemas/MagicResponse"
+                $ref: "#/components/schemas/MagicResponse"
               example:
                 type: 6
                 value:
@@ -127,11 +152,12 @@ components:
       properties:
         op:
           type: string
-          required: true
         args:
           oneOf:
             - $ref: "#/components/schemas/ArgArray"
             - $ref: "#/components/schemas/ArgObject"
+      required:
+        - op
 
     OperationArray:
       type: array
@@ -141,7 +167,7 @@ components:
     ArgArray:
       type: array
       items:
-        type: {}
+        type: object
       example: 
         - 16
         - true
@@ -154,6 +180,16 @@ components:
         upperCaseHex: true
         includeFinalLength: false
 
+    BakeResponse:
+      type: object
+      properties:
+        type:
+          type: string
+        value:
+          oneOf:
+            - type: string
+            - type: number
+
     MagicInput:
       type: object
       properties:
@@ -166,7 +202,7 @@ components:
       type: object
       properties:
         type:
-          type: int
+          type: integer
         value:
           type: array
           items:
@@ -177,16 +213,28 @@ components:
         recipe:
           type: array
           items:
-            type: Object
+            type: object
         data:
           type: string
         languageScores:
           type: array
           items:
-            type: Object
+            type: object
         matchingOps:
           type: array
           items:
-            type: Object
-        useful: bool
+            type: object
+        useful: 
+          type: boolean
+
+    HealthResponse:
+      type: object
+      properties:
+        uptime:
+          type: number
+        message:
+          type: string
+        timestamp:
+          type: string
+
 

test/health.js

@@ -0,0 +1,11 @@
+import request from "supertest";
+import app from "../app";
+
+describe("GET /health", function() {
+    it("should respond with a success response", function(done) {
+        request(app)
+            .get("/health")
+            .set("Accept", "application/json")
+            .expect(200, done);
+    });
+});