wrap middleware

.nvmrc

@@ -1 +1 @@
-18
+20

docs/docs/the-basics/coding-with-practica.md

@@ -135,18 +135,14 @@ This is a very typical express code, if you're familiar with express you'll be p
 
 ```javascript
 // A new route to edit order
-router.put('/:id', async (req, res, next) => {
-    try {
-      logger.info(`Order API was called to edit order ${req.params.id}`);
-      // Later on we will call the main code in the domain layer
-      // Fow now let's put hard coded values
-      res.json({id:1, userId: 1, productId: 2, countryId: 1,
-      deliveryAddress: '123 Main St, New York',
-      paymentTermsInDays: 30}).status(200).end();
-    } catch (err) {
-      next(err);
-    }
-  });
+router.put('/:id', wrapHandler(async (req, res, next) => {
+  logger.info(`Order API was called to edit order ${req.params.id}`);
+  // Later on we will call the main code in the domain layer
+  // Fow now let's put hard coded values
+  res.json({id:1, userId: 1, productId: 2, countryId: 1,
+  deliveryAddress: '123 Main St, New York',
+  paymentTermsInDays: 30}).status(200).end();
+}));
 ```
 
 > **✅Best practice:** The API entry-point (controller) should stay thin and focus on forwarding the request to the domain layer.

src/code-templates/.nvmrc

@@ -1 +1 @@
-18
+20

src/code-templates/libraries/logger/index.ts

@@ -1,4 +1,4 @@
-import { context } from '@practica/request-context';
+import { context } from '@practica/middlewares';
 import { Logger, LoggerConfiguration } from './definition';
 import PinoLogger from './pino.logger';
 

src/code-templates/libraries/logger/package.json

@@ -15,7 +15,7 @@
     "url": "git+https://github.com/practicajs/practica.git"
   },
   "dependencies": {
-    "@practica/request-context": "^0.1.0",
+    "@practica/middlewares": "^0.1.0",
     "@practica/configuration-provider": "^0.0.1-alpha.1",
     "pino": "^8.5.0"
   },

src/code-templates/libraries/logger/test/index.test.ts

@@ -1,5 +1,5 @@
 import sinon from 'sinon';
-import { context } from '@practica/request-context';
+import { context } from '@practica/middlewares';
 import { logger } from '../index';
 
 describe('logger', () => {

src/code-templates/libraries/request-context/index.ts → src/code-templates/libraries/middlewares/index.ts

@@ -1,2 +1,3 @@
 export { context } from './src/context';
 export { addRequestId as addRequestIdExpressMiddleware } from './src/request-id/express/middleware';
+export * from './src/wrap-handler';

src/code-templates/libraries/request-context/package.json → src/code-templates/libraries/middlewares/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@practica/request-context",
+  "name": "@practica/middlewares",
   "version": "0.1.0",
   "description": "",
   "main": ".dist/index.js",

src/code-templates/libraries/middlewares/src/wrap-handler.ts

@@ -0,0 +1,12 @@
+
+import express from "express";
+
+export function wrapHandler(handler: express.Handler) {
+  return async (req: express.Request, res: express.Response, next: express.NextFunction) => {
+    try {
+      await handler(req, res, next);
+    } catch (error) {
+      next(error);
+    }
+  };
+}

src/code-templates/services/order-service/entry-points/api/routes.ts

@@ -2,49 +2,41 @@
 import express from 'express';
 import { logger } from '@practica/logger';
 import * as newOrderUseCase from '../../domain/new-order-use-case';
+import { wrapHandler } from '@practica/middlewares';
 
 export default function defineRoutes(expressApp: express.Application) {
   const router = express.Router();
 
-  router.post('/', async (req, res, next) => {
-    try {
-      logger.info(
-        `Order API was called to add new Order ${util.inspect(req.body)}`
-      );
-      // ✅ Best Practice: Using the 3-tier architecture, routes/controller are kept thin, logic is encapsulated in a dedicated domain folder
-      const addOrderResponse = await newOrderUseCase.addOrder(req.body);
-      return res.json(addOrderResponse);
-    } catch (error) {
-      next(error);
-      return undefined;
-    }
-  });
+  router.post('/', wrapHandler(async (req, res, next) => {
+    logger.info(
+      `Order API was called to add new Order ${util.inspect(req.body)}`
+    );
+    // ✅ Best Practice: Using the 3-tier architecture, routes/controller are kept thin, logic is encapsulated in a dedicated domain folder
+    const addOrderResponse = await newOrderUseCase.addOrder(req.body);
+    res.json(addOrderResponse);
+  }));
 
   // get existing order by id
-  router.get('/:id', async (req, res, next) => {
-    try {
-      logger.info(`Order API was called to get user by id ${req.params.id}`);
-      const response = await newOrderUseCase.getOrder(
-        parseInt(req.params.id, 10)
-      );
-
-      if (!response) {
-        res.status(404).end();
-        return;
-      }
+  router.get('/:id', wrapHandler(async (req, res, next) => {
+    logger.info(`Order API was called to get user by id ${req.params.id}`);
+    const response = await newOrderUseCase.getOrder(
+      parseInt(req.params.id, 10)
+    );
 
-      res.json(response);
-    } catch (error) {
-      next(error);
+    if (!response) {
+      res.status(404).end();
+      return;
     }
-  });
+
+    res.json(response);
+  }));
 
   // delete order by id
-  router.delete('/:id', async (req, res) => {
+  router.delete('/:id', wrapHandler(async (req, res) => {
     logger.info(`Order API was called to delete order ${req.params.id}`);
     await newOrderUseCase.deleteOrder(parseInt(req.params.id, 10));
     res.status(204).end();
-  });
+  }));
 
   expressApp.use('/order', router);
 }

src/code-templates/services/order-service/entry-points/api/server.ts

@@ -6,7 +6,7 @@ import helmet from 'helmet';
 import { errorHandler } from '@practica/error-handling';
 import * as configurationProvider from '@practica/configuration-provider';
 import { jwtVerifierMiddleware } from '@practica/jwt-token-verifier';
-import { addRequestIdExpressMiddleware } from '@practica/request-context';
+import { addRequestIdExpressMiddleware } from '@practica/middlewares';
 import configurationSchema from '../../config';
 import defineRoutes from './routes';
 

src/code-templates/services/order-service/package.json

@@ -24,7 +24,7 @@
     "@practica/error-handling": "^0.0.3",
     "@practica/jwt-token-verifier": "^0.0.2",
     "@practica/logger": "^0.0.3",
-    "@practica/request-context": "^0.1.0",
+    "@practica/middlewares": "^0.1.0",
     "@practica/validation": "^0.0.3",
     "@prisma/client": "^4.6.1",
     "@sinclair/typebox": "^0.23.5",
@@ -33,9 +33,9 @@
     "axios": "^0.26.1",
     "express": "^4.17.3",
     "helmet": "^6.0.0",
-    "sequelize": "^6.17.0",
     "node-notifier": "^10.0.1",
-    "pg": "^8.7.3"
+    "pg": "^8.7.3",
+    "sequelize": "^6.17.0"
   },
   "devDependencies": {
     "@jest-performance-reporter/core": "^2.1.2",
@@ -48,7 +48,7 @@
     "@types/pg": "^8.6.5",
     "@types/sequelize": "^4.28.11",
     "@types/sinon": "^10.0.11",
-    "docker-compose": "^0.23.17",
+    "docker-compose": "^0.24.7",
     "is-ci": "^3.0.1",
     "is-port-reachable": "^3.0.0",
     "jest": "^27.5.1",

src/code-templates/services/order-service/test/global-setup.ts

@@ -1,6 +1,6 @@
 import isPortReachable from 'is-port-reachable';
 import path from 'path';
-import dockerCompose from 'docker-compose';
+import { v2 as dockerCompose } from 'docker-compose'
 import { execSync } from 'child_process';
 
 export default async () => {