Merge pull request #55 from techstartucalgary/feature/backend-scanner

Feature/backend scanner

backend/docker-compose.yml

@@ -0,0 +1,15 @@
+version: "3"
+
+services:
+  mysql:
+    image: mysql
+    environment:
+      MYSQL_ROOT_PASSWORD: root
+      MYSQL_DATABASE: rethread
+    ports:
+      - "3306:3306"
+    volumes:
+      - mysql:/var/lib/mysql
+
+volumes:
+  mysql:

backend/src/abstracts/product.abstract.ts

@@ -1,23 +1,9 @@
-type PrismaProduct = {
-  id: string;
-  title: string;
-  size: string;
-  color: string;
-  description: string;
-  gender: string;
-  category: string;
-  price: number;
-  imageUrl: string;
-  createdAt: Date;
-  updatedAt: Date;
-};
-
-type PrismaProducts = PrismaProduct[];
+import { PrismaProduct, PrismaProducts } from "../../types";
 
 abstract class ProductProvider {
-  abstract getProducts(): Promise<PrismaProducts | Error>;
+  abstract getProducts(): Promise<PrismaProducts>;
 
-  abstract getProductById(id: string): Promise<PrismaProduct | Error>;
+  abstract getProductById(id: string): Promise<PrismaProduct>;
 
   abstract createProduct(
     title: string,
@@ -29,7 +15,9 @@ abstract class ProductProvider {
     price: number,
     imageUrl: string,
     url: string
-  ): Promise<PrismaProduct | Error>;
+  ): Promise<PrismaProduct>;
 
-  abstract deleteProduct(id: string): Promise<PrismaProduct | Error>;
+  abstract deleteProduct(id: string): Promise<PrismaProduct>;
 }
+
+export default ProductProvider;

backend/src/abstracts/scanner.abstract.ts

@@ -0,0 +1,9 @@
+import { Tag } from "../../types";
+
+abstract class ScannerProvider {
+  abstract getMaterials(text: string): Tag[];
+
+  abstract getTextFromImage(imagePath: string): Promise<string>;
+}
+
+export default ScannerProvider;

backend/src/controllers/product.controller.ts

@@ -1,11 +1,13 @@
+import { PrismaProduct } from "../../types";
+import ProductProvider from "../abstracts/product.abstract";
 import { Request, Response, NextFunction } from "express";
 
 class ProductController {
   constructor(private service: ProductProvider) {
     this.service = service;
   }
 
-  getProducts = async (
+  public getProducts = async (
     req: Request,
     res: Response,
     next: NextFunction
@@ -18,20 +20,22 @@ class ProductController {
     }
   };
 
-  getProductById = async (
+  public getProductById = async (
     req: Request,
     res: Response,
     next: NextFunction
   ): Promise<Response<any, Record<string, any>> | void> => {
     try {
-      const product = await this.service.getProductById(req.params.id);
+      const product: PrismaProduct = await this.service.getProductById(
+        req.params.id
+      );
       return res.status(200).json(product);
     } catch (e) {
       next(e);
     }
   };
 
-  postProduct = async (
+  public postProduct = async (
     req: Request,
     res: Response,
     next: NextFunction
@@ -54,7 +58,7 @@ class ProductController {
     }
   };
 
-  deleteProduct = async (
+  public deleteProduct = async (
     req: Request,
     res: Response,
     next: NextFunction

backend/src/controllers/scanner.controller.ts

@@ -1,30 +1,25 @@
-import { Request, Response, NextFunction, response } from "express";
-import ScannerService from "../services/scanner.service.js";
+import { Tag } from "../../types.js";
+import ScannerProvider from "../abstracts/scanner.abstract.js";
+import { Request, Response, NextFunction } from "express";
 
 class ScannerController {
-    constructor(private service: ScannerService) {
-        this.service = service;
-    }
-    postMaterials = async (//must send image as tag "image" and value base64 string. Returns JSON with the percentage and material of each material found on the tag
-        req: Request,
-        res: Response,
-        next: NextFunction
-    ): Promise<Response<any, Record<string, any>> | void> => {
+  constructor(private service: ScannerProvider) {
+    this.service = service;
+  }
+
+  public postMaterials = async (
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ): Promise<Response<any, Record<string, any>> | void> => {
     try {
-        console.log("postMaterials called");
-            let materials = await (async () => {
-            var str;
-            str = await this.service.getMaterials(await this.service.getTextFromImage(req.body.image));
-            // console.log("Fuck: ", await str);
-            return str;
-        })();
-        console.log("materials: ",materials);
-        return res.status(201).json(JSON.parse(materials));
+      const text: string = await this.service.getTextFromImage(req.body.image);
+      const materials: Tag[] = this.service.getMaterials(text);
+      return res.status(201).json(materials);
     } catch (e) {
-        console.log("Error: ", e);
-        next(e);
+      next(e);
     }
-    };
+  };
 }
 
-export default ScannerController;
+export default ScannerController;

backend/src/errors/tesseract.error.ts

@@ -0,0 +1 @@
+export class TesseractServiceError extends Error {}

backend/src/index.ts

@@ -3,21 +3,18 @@ import cors from "cors";
 import { PORT } from "./config/config.js";
 import errorHandler from "./middlewares/error.middleware.js";
 import { PrismaClient } from "@prisma/client";
-import algorithmRouter from "./routes/algorithm.routes.js";
 import productRouter from "./routes/product.routes.js";
 import scannerRouter from "./routes/scanner.routes.js";
 
 export const app: Express = express();
 export const prisma = new PrismaClient();
 
-app.use(express.json({ limit: '50mb' }));
+app.use(express.json({ limit: "50mb" }));
 
 app.use(cors());
 
 app.use("/api/v1/scanner", scannerRouter);
 
-app.use("/api/v1/algorithm", algorithmRouter);
-
 app.use("/api/v1/products", productRouter);
 
 app.use(errorHandler);

backend/src/middlewares/error.middleware.ts

@@ -13,9 +13,11 @@ import {
   PrismaGenericError,
 } from "../errors/prisma.error.js";
 import { ProductNotFoundError } from "../errors/product.error.js";
+import { TesseractServiceError } from "../errors/tesseract.error.js";
+
 export default function errorHandler(
   e: Error,
-  req: Request,
+  _: Request,
   res: Response,
   next: NextFunction
 ) {
@@ -39,6 +41,8 @@ export default function errorHandler(
     res.status(500).json({ error: "Prisma Generic Error" });
   } else if (e instanceof ProductNotFoundError) {
     res.status(500).json({ error: "Product Not Found Error" });
+  } else if (e instanceof TesseractServiceError) {
+    res.status(500).json({ error: "Tesseract Service Error" });
   } else {
     res.status(500).json({ error: "Unexpected error" });
   }

backend/src/repositories/product.repository.ts

@@ -1,6 +1,8 @@
+import ProductProvider from "../abstracts/product.abstract.js";
 import { prisma } from "../index.js";
 import { Prisma } from "@prisma/client";
 import { ProductNotFoundError } from "../errors/product.error.js";
+import { PrismaProduct, PrismaProducts } from "../../types.js";
 import {
   PrismaClientInitializationError,
   PrismaClientRustPanicError,
@@ -10,7 +12,7 @@ import {
 } from "../errors/prisma.error.js";
 
 class ProductRepository implements ProductProvider {
-  getProducts = async (): Promise<PrismaProducts | Error> => {
+  public getProducts = async (): Promise<PrismaProducts> => {
     try {
       const products: PrismaProducts = await prisma.product.findMany();
       return products;
@@ -31,7 +33,7 @@ class ProductRepository implements ProductProvider {
     }
   };
 
-  getProductById = async (id: string): Promise<PrismaProduct | Error> => {
+  public getProductById = async (id: string): Promise<PrismaProduct> => {
     try {
       const product: PrismaProduct | null = await prisma.product.findUnique({
         where: { id: id },
@@ -59,7 +61,7 @@ class ProductRepository implements ProductProvider {
     }
   };
 
-  createProduct = async (
+  public createProduct = async (
     title: string,
     size: string,
     color: string,
@@ -68,7 +70,7 @@ class ProductRepository implements ProductProvider {
     category: string,
     price: number,
     imageUrl: string
-  ): Promise<PrismaProduct | Error> => {
+  ): Promise<PrismaProduct> => {
     try {
       const newProduct: PrismaProduct = await prisma.product.create({
         data: {
@@ -100,7 +102,7 @@ class ProductRepository implements ProductProvider {
     }
   };
 
-  deleteProduct = async (id: string): Promise<PrismaProduct | Error> => {
+  public deleteProduct = async (id: string): Promise<PrismaProduct> => {
     try {
       const product: PrismaProduct | null = await prisma.product.delete({
         where: { id: id },

backend/src/repositories/scanner.repository.ts

@@ -0,0 +1,23 @@
+import { createWorker } from "tesseract.js";
+import { Tag } from "../../types.js";
+import ScannerProvider from "../abstracts/scanner.abstract.js";
+import { TesseractServiceError } from "../errors/tesseract.error.js";
+
+class ScannerRepository implements ScannerProvider {
+  public getMaterials = (_: string): Tag[] => {
+    throw new Error("Method not implemented.");
+  };
+
+  public getTextFromImage = async (imagePath: string): Promise<string> => {
+    try {
+      const worker: Tesseract.Worker = await createWorker("eng");
+      const ret: Tesseract.RecognizeResult = await worker.recognize(imagePath);
+      await worker.terminate();
+      return ret.data.text;
+    } catch (e) {
+      throw new TesseractServiceError();
+    }
+  };
+}
+
+export default ScannerRepository;

backend/src/routes/product.routes.ts

@@ -1,7 +1,7 @@
-import { Router } from "express";
 import ProductController from "../controllers/product.controller.js";
 import ProductService from "../services/product.service.js";
 import ProductRepository from "../repositories/product.repository.js";
+import { Router } from "express";
 
 const productRouter = Router();
 const productController = new ProductController(

backend/src/routes/scanner.routes.ts

@@ -1,11 +1,13 @@
-import { Router } from "express";
 import ScannerController from "../controllers/scanner.controller.js";
 import ScannerService from "../services/scanner.service.js";
+import ScannerRepository from "../repositories/scanner.repository.js";
+import { Router } from "express";
 
 const scannerRouter = Router();
-
-const scannerController = new ScannerController(new ScannerService());
+const scannerController = new ScannerController(
+  new ScannerService(new ScannerRepository())
+);
 
 scannerRouter.post("/", scannerController.postMaterials);
 
-export default scannerRouter;
+export default scannerRouter;