chore: sync recent changes - docs, env example, handlers, validation, routes, and UI

Author: frckbrice

.env.example

@@ -0,0 +1,19 @@
+# Server
+PORT=5000
+NODE_ENV=development
+
+# MongoDB (use MONGO_URI or MONGODB_URI for rate-product transaction)
+MONGO_URI=mongodb://localhost:27017/your-db
+MONGO_DB_NAME=digital-market-place-updates
+
+# JWT
+ACCESS_TOKEN_SECRETKEY=your_access_token_secret
+JWT_REFRESH_SECRET=your_refresh_token_secret
+JWT_EXPIRES_IN=15m
+JWT_REFRESH_EXPIRES_IN=7d
+
+# Email (for password reset)
+MY_EMAIL=your-email@gmail.com
+PASSWORD=your-app-password
+
+# CORS: add allowed origins in interface-adapters/middlewares/config/allowedOrigin.js

.eslintrc

@@ -12,10 +12,7 @@
   ],
   "rules": {
     "prettier/prettier": "error",
-    "indent": [
-      "error",
-      2
-    ],
+    "indent": "off",
     "no-unused-vars": "warn",
     "no-console": "off"
   }

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 .env
-
+*.log
+logs/
 /interface-adapters/middlewares/logs/
 /interface-adapters/controllers/examples

.husky/pre-push

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-yarn lint && yarn format 
+yarn lint && yarn format && yarn test

README.md

@@ -70,12 +70,7 @@ public/               # Static files and HTML views
    ```bash
    yarn install
    ```
-3. Create a `.env` file in the root with your environment variables:
-   ```env
-   PORT=5000
-   MONGO_URI=mongodb://localhost:27017/your-db
-   JWT_SECRET=your_jwt_secret
-   ```
+3. Copy `.env.example` to `.env` and set your environment variables. For production, set `NODE_ENV=production` (logging is disabled in production; file and console logs run only in development).
 4. Start the server:
    ```bash
    yarn dev
@@ -147,7 +142,7 @@ See the `routes/` directory for all endpoints. Example:
 
 ## Troubleshooting
 
-- See [troubleshooting.md](./troubleshooting.md) for common issues and solutions.
+- See [troubleshooting.md](./docs/troubleshooting.md) for common issues and solutions.
 
 ## License
 

application-business-rules/use-cases/blogs/blog-handlers.js

@@ -16,7 +16,6 @@ module.exports = {
     async function findAllBlogsUseCaseHandler() {
       try {
         const blogs = await dbBlogHandler.findAllBlogs();
-        // console.log('\n\n from find all blogs use case: ', blogs);
         return Object.freeze(blogs.flat().data);
       } catch (error) {
         logEvents && logEvents(error.message, 'blogUseCase.log');

application-business-rules/use-cases/products/product-handlers.js

@@ -1,5 +1,7 @@
+'use strict';
+
 const productValidationFcts = require('../../../enterprise-business-rules/validate-models/product-validation-fcts');
-// const { findAllProductUseCaseHandler } = require('./product-handlers');
+const { log } = require('../../../interface-adapters/middlewares/loggers/logger');
 
 /**
  * Creates a new product in the database using the provided product data.
@@ -24,12 +26,14 @@ const createProductUseCase = ({ makeProductModelHandler }) =>
       const newProduct = await createProductDbHandler(validatedProductData);
       return Object.freeze(newProduct);
     } catch (error) {
-      console.log('Error from create product handler: ', error);
+      log.error('Error from create product handler:', error.message);
       throw new Error(error.message);
     }
   };
 
-//find one product from DB
+/**
+ * Fetches a single product by ID.
+ */
 const findOneProductUseCase = ({ productValidation }) =>
   async function findOneProductUseCaseHandler({
     productId,
@@ -44,25 +48,28 @@ const findOneProductUseCase = ({ productValidation }) =>
       const newProduct = await findOneProductDbHandler({ productId: uuid });
       return Object.freeze(newProduct);
     } catch (error) {
-      console.log('Error from fetch one product handler: ', error);
+      log.error('Error from fetch one product handler:', error.message);
       throw new Error(error.message);
     }
   };
 
-// find all product use case handler
+/**
+ * Fetches all products with optional filters.
+ */
 const findAllProductsUseCase = () =>
   async function findAllProductUseCaseHandler({ dbProductHandler, filterOptions }) {
     try {
       const allProducts = await dbProductHandler.findAllProductsDbHandler(filterOptions);
-      // console.log('from find all products use case: ', allProducts);
       return Object.freeze(allProducts.data);
     } catch (e) {
-      console.log('Error from fetch all product handler: ', e);
+      log.error('Error from fetch all product handler:', e.message);
       throw new Error(e.message);
     }
   };
 
-// delete product use case
+/**
+ * Deletes a product by ID.
+ */
 const deleteProductUseCase = () =>
   async function deleteProductUseCaseHandler({ productId, dbProductHandler, errorHandlers }) {
     const { findOneProductDbHandler, deleteProductDbHandler } = dbProductHandler;
@@ -83,12 +90,14 @@ const deleteProductUseCase = () =>
       };
       return Object.freeze(result);
     } catch (error) {
-      console.log('Error from delete product handler: ', error);
+      log.error('Error from delete product handler:', error.message);
       throw new Error(error.message);
     }
   };
 
-// update product
+/**
+ * Updates a product by ID.
+ */
 const updateProductUseCase = ({ makeProductModelHandler }) =>
   async function updateProductUseCaseHandler({
     productId,
@@ -113,17 +122,17 @@ const updateProductUseCase = ({ makeProductModelHandler }) =>
         errorHandlers,
       });
 
-      // store product in database mongodb
       const newProduct = await updateProductDbHandler({ productId, ...productData });
-      console.log(' from product handler after DB: ', newProduct);
       return Object.freeze(newProduct);
     } catch (error) {
-      console.log('Error from update product handler: ', error);
+      log.error('Error from update product handler:', error.message);
       throw new Error(error.message);
     }
   };
 
-// rate product in transaction with both Rate model and Product model
+/**
+ * Rates a product (creates rating and updates product aggregates in a transaction).
+ */
 const rateProductUseCase = ({ makeProductRatingModelHandler }) =>
   async function rateProductUseCaseHandler({
     userId,
@@ -132,16 +141,13 @@ const rateProductUseCase = ({ makeProductRatingModelHandler }) =>
     dbProductHandler,
     errorHandlers,
   }) {
-    console.log('hit rating use case handler');
     const ratingData = { ratingValue, userId, productId };
     try {
-      /* validate and build rating model */
       const ratingModel = await makeProductRatingModelHandler({ errorHandlers, ...ratingData });
       const newProduct = await dbProductHandler.rateProductDbHandler(ratingModel);
-      console.log(' from rating product handler after DB: ', newProduct);
       return Object.freeze(newProduct);
     } catch (error) {
-      console.log('Error from fetch one product handler: ', error);
+      log.error('Error from rating product handler:', error.message);
       throw new Error(error.message);
     }
   };

application-business-rules/use-cases/user/index.js

@@ -3,7 +3,7 @@ const profileUseCases = require('./user-profile-usecases');
 const { dbUserHandler } = require('../../../interface-adapters/database-access');
 const { makeUser, validateId } = require('../../../enterprise-business-rules/entities');
 const { RequiredParameterError } = require('../../../interface-adapters/validators-errors/errors');
-const { logEvents } = require('../../../interface-adapters/middlewares/loggers/logger');
+const { logEvents, log } = require('../../../interface-adapters/middlewares/loggers/logger');
 const { makeHttpError } = require('../../../interface-adapters/validators-errors/http-error');
 
 const entityModels = require('../../../enterprise-business-rules/entities');
@@ -13,30 +13,34 @@ const registerUserUseCaseHandler = authUseCases.registerUserUseCase({
   dbUserHandler,
   entityModels,
   logEvents,
+  log,
   makeHttpError,
 });
 const loginUserUseCaseHandler = authUseCases.loginUserUseCase({
   dbUserHandler,
   logEvents,
+  log,
   makeHttpError,
 });
-const logoutUseCaseHandler = authUseCases.logoutUseCase({ RequiredParameterError, logEvents });
+const logoutUseCaseHandler = authUseCases.logoutUseCase({ RequiredParameterError, logEvents, log });
 const refreshTokenUseCaseHandler = authUseCases.refreshTokenUseCase({
   dbUserHandler,
   RequiredParameterError,
   logEvents,
+  log,
 });
 const forgotPasswordUseCaseHandler = authUseCases.forgotPasswordUseCase({
   dbUserHandler,
   logEvents,
+  log,
 });
 const resetPasswordUseCaseHandler = authUseCases.resetPasswordUseCase({
   dbUserHandler,
   logEvents,
+  log,
   makeHttpError,
 });
 
-// Profile Use Cases
 const findAllUsersUseCaseHandler = profileUseCases.findAllUsersUseCase({
   dbUserHandler,
   logEvents,
@@ -45,32 +49,37 @@ const findOneUserUseCaseHandler = profileUseCases.findOneUserUseCase({
   dbUserHandler,
   validateId,
   logEvents,
+  log,
 });
 const updateUserUseCaseHandler = profileUseCases.updateUserUseCase({
   dbUserHandler,
   makeUser,
   validateId,
   RequiredParameterError,
   logEvents,
+  log,
   makeHttpError,
 });
 const deleteUserUseCaseHandler = profileUseCases.deleteUserUseCase({
   dbUserHandler,
   validateId,
   RequiredParameterError,
   logEvents,
+  log,
 });
 const blockUserUseCaseHandler = profileUseCases.blockUserUseCase({
   dbUserHandler,
   validateId,
   RequiredParameterError,
   logEvents,
+  log,
 });
 const unBlockUserUseCaseHandler = profileUseCases.unBlockUserUseCase({
   dbUserHandler,
   validateId,
   RequiredParameterError,
   logEvents,
+  log,
 });
 
 module.exports = {