ADD pipeline listing

Author: maxjf1

README.md

@@ -42,10 +42,10 @@ Settings need to be passed as enviroment variables:
 ## Routes
 Arguments need to be send as JSON (`content-type: application/json`).
 
-- `/pipeline/ocr`: Handle OCR actions
-    - GET: Obtain a list of previous OCR actions
-    - POST: Register an new OCR job. The `file` argument with the file url (or an object containing the `name` property) is mandatory.
-- GET `/pipeline/ocr/id`: Gets the status of an OCR job. The response is in the following format (changing the status):
+- GET `/pipeline/options`: returns all pipeline options
+- POST `/pipeline/:type`: Register an new pipeline job. `type` is the pipeline ID, and you need to pass the `input` arguments.
+- GET: `/pipeline`Obtain a list of previous pipeline jobs
+- GET `/pipeline/:id`: Gets the status of an pipeline job. The response is in the following format (changing the status):
 ```json
 {
     "type": "ocr",

docker-compose.yml

@@ -3,9 +3,9 @@ services:
   dashboard:
     build: .
     image: maxjf1/easytopic-dashboard-api:latest
-    # command: npm run dev
-    # volumes:
-    #   - ./:/app
+    command: npm run dev
+    volumes:
+      - ./:/app
     depends_on:
       - rabbitmq
     ports:

src/pipelines.json

@@ -0,0 +1,7 @@
+import ocr from './ocr.json';
+import ocrTest from './ocrTest.json';
+
+export default [
+    ocr,
+    ocrTest,
+];

src/pipelines/index.js

@@ -0,0 +1,46 @@
+{
+    "version": "1.0",
+    "id": "ocr",
+    "name": "OCR",
+    "description": "Runs OCR on an image files",
+    "input": [
+        {
+            "id": "image",
+            "name": "Image",
+            "description": "The image from the OCR will be generated",
+            "type": "file",
+            "accept": [
+                "image/*"
+            ]
+        }
+    ],
+    "output": [
+        {
+            "id": "ocr",
+            "type": "text",
+            "name": "OCR Result",
+            "description": "The result of the OCR processing"
+        }
+    ],
+    "pipeline": [
+        {
+            "id": "ocr-service",
+            "queues": [
+                {
+                    "env": "OCR_INPUT_QUEUE",
+                    "default": "ocr-in"
+                },
+                {
+                    "env": "OCR_OUTPUT_QUEUE",
+                    "default": "ocr-out"
+                }
+            ],
+            "arguments": {
+                "file": "image"
+            },
+            "output": [
+                "ocr"
+            ]
+        }
+    ]
+}

src/pipelines/ocr.json

@@ -0,0 +1,57 @@
+{
+    "version": "1.0",
+    "id": "ocr-jpg",
+    "name": "OCR",
+    "description": "Runs OCR on jpg files",
+    "input": [
+        {
+            "id": "image",
+            "name": "Image",
+            "description": "The image from the OCR will be generated",
+            "type": "file",
+            "accept": ".jpg"
+        },
+        {
+            "id": "args",
+            "name": "Arguments",
+            "description": "The arguments will be passed to the OCR worker",
+            "type": "text"
+        }
+    ],
+    "output": [
+        {
+            "id": "ocr",
+            "type": "text",
+            "name": "OCR Result",
+            "description": "The result of the OCR processing"
+        },
+        {
+            "id": "ocr-duplicate",
+            "type": "text",
+            "name": "OCR duplicate",
+            "description": "Just a duplicate result of the OCR"
+        }
+    ],
+    "pipeline": [
+        {
+            "id": "ocr-service",
+            "queues": [
+                {
+                    "env": "OCR_INPUT_QUEUE",
+                    "default": "ocr-in"
+                },
+                {
+                    "env": "OCR_OUTPUT_QUEUE",
+                    "default": "ocr-out"
+                }
+            ],
+            "arguments": {
+                "file": "image"
+            },
+            "output": {
+                "ocr": "ocr",
+                "ocr-duplicate": "ocr"
+            }
+        }
+    ]
+}

src/pipelines/ocrTest.json

@@ -1,6 +1,7 @@
 import { Router } from 'express';
 import LocalDatabase from '../lib/LocalDatabase';
 import { getChannel, queues } from '../lib/queueConnection';
+import pipelines from '../pipelines';
 
 const pipelineRouter = new Router();
 /**
@@ -29,6 +30,10 @@ pipelineRouter.post('/ocr', async ({ body: { file } }, res) => {
     res.send(item);
 });
 
+pipelineRouter.get('/options', (req, res) => res.send(
+    pipelines.map(({ pipeline, ...info }) => info),
+));
+
 pipelineRouter.get('/:id', ({ params: { id } }, res) => res
     .send(LocalDatabase.getItem(id) || 404));