Aggressive lint, format, and RESTful cleanup: codebase ready for CI/CD and Docker

Author: frckbrice

.github/workflows/ci-cd.yml

@@ -55,4 +55,4 @@ jobs:
           IMAGE=your-dockerhub-username/your-repo-name
           docker tag $IMAGE:latest $IMAGE:${{ github.sha }}
           docker push $IMAGE:latest
-          docker push $IMAGE:${{ github.sha }} 
+          docker push $IMAGE:${{ github.sha }}

.lintstagedrc.json

@@ -1,6 +1,3 @@
 {
-    "*.js": [
-        "prettier --write",
-        "eslint --fix"
-    ]
-}
+  "*.js": ["prettier --write", "eslint --fix"]
+}

.prettierrc

@@ -4,4 +4,4 @@
   "tabWidth": 2,
   "trailingComma": "es5",
   "printWidth": 100
-} 
+}

README.md

@@ -5,6 +5,7 @@
 A Node.js REST API for a digital marketplace, structured according to Uncle Bob's Clean Architecture principles. This project demonstrates separation of concerns, testability, and scalability by organizing code into distinct layers: Enterprise Business Rules, Application Business Rules, Interface Adapters, and Frameworks & Drivers.
 
 ## Table of Contents
+
 - [Introduction](#introduction)
 - [Architecture Overview](#architecture-overview)
 - [Features](#features)
@@ -19,9 +20,11 @@ A Node.js REST API for a digital marketplace, structured according to Uncle Bob'
 - [License](#license)
 
 ## Introduction
+
 This backend API allows users to register, authenticate, and interact with products, blogs, and ratings. It is designed for maintainability and extensibility, following Clean Architecture best practices.
 
 ## Architecture Overview
+
 The project is organized into the following layers:
 
 - **Enterprise Business Rules**: Core business logic and domain models (`enterprise-business-rules/`).
@@ -45,6 +48,7 @@ public/               # Static files and HTML views
 ```
 
 ## Features
+
 - User registration and authentication (JWT)
 - Product CRUD operations
 - Blog and rating management
@@ -55,10 +59,12 @@ public/               # Static files and HTML views
 ## Getting Started
 
 ### Prerequisites
+
 - Node.js (v18+ recommended)
 - MongoDB instance (local or cloud)
 
 ### Installation
+
 1. Clone the repository:
    ```bash
    git clone <repo-url>
@@ -84,6 +90,7 @@ public/               # Static files and HTML views
 The server will run at [http://localhost:5000](http://localhost:5000).
 
 ## Project Structure
+
 - `index.js` - Main entry point, sets up Express, routes, and middleware
 - `routes/` - Express route definitions for products, users, blogs
 - `interface-adapters/` - Controllers, DB access, adapters, and middleware
@@ -94,6 +101,7 @@ The server will run at [http://localhost:5000](http://localhost:5000).
 ## API Endpoints
 
 ### Products
+
 - `POST   /products/` - Create a new product
 - `GET    /products/` - Get all products
 - `GET    /products/:productId` - Get a product by ID
@@ -102,11 +110,13 @@ The server will run at [http://localhost:5000](http://localhost:5000).
 - `POST   /products/:productId/:userId/rating` - Rate a product
 
 ### Users & Auth
+
 - `POST   /users/register` - Register a new user
 - `POST   /users/login` - User login
 - `GET    /users/profile` - Get user profile (auth required)
 
 ### Blogs
+
 - `GET    /blogs/` - Get all blogs
 - `POST   /blogs/` - Create a new blog
 
@@ -163,4 +173,4 @@ The server will run at [http://localhost:5000](http://localhost:5000).
 
 ## License
 
-This project is licensed under the ISC License. See the [LICENSE](LICENSE) file for details. 
+This project is licensed under the ISC License. See the [LICENSE](LICENSE) file for details.

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

@@ -1,3 +1,6 @@
+const productValidationFcts = require('../../../enterprise-business-rules/validate-models/product-validation-fcts');
+// const { findAllProductUseCaseHandler } = require('./product-handlers');
+
 /**
  * Creates a new product in the database using the provided product data.
  *
@@ -48,7 +51,7 @@ const findOneProductUseCase = ({ productValidation }) =>
 
 // find all product use case handler
 const findAllProductsUseCase = () =>
-  (findAllProductUseCaseHandler = async ({ dbProductHandler, filterOptions }) => {
+  async function findAllProductUseCaseHandler({ dbProductHandler, filterOptions }) {
     try {
       const allProducts = await dbProductHandler.findAllProductsDbHandler(filterOptions);
       // console.log("from find all products use case: ", allProducts);
@@ -57,7 +60,7 @@ const findAllProductsUseCase = () =>
       console.log('Error from fetch all product handler: ', e);
       throw new Error(e.message);
     }
-  });
+  };
 
 // delete product use case
 const deleteProductUseCase = () =>
@@ -66,7 +69,7 @@ const deleteProductUseCase = () =>
     const { InvalidPropertyError } = errorHandlers;
     try {
       // validate id
-      const uuid = productValidation.validateObjectId(productId, InvalidPropertyError);
+      const uuid = productValidationFcts.validateObjectId(productId, InvalidPropertyError);
       // check first that the product exists
       const existingProduct = await findOneProductDbHandler({ productId: uuid });
       if (!existingProduct) {
@@ -97,7 +100,7 @@ const updateProductUseCase = ({ makeProductModelHandler }) =>
     const { InvalidPropertyError } = errorHandlers;
     try {
       // validate id
-      const uuid = productValidation.validateObjectId(productId, InvalidPropertyError);
+      const uuid = productValidationFcts.validateObjectId(productId, InvalidPropertyError);
       // check first that the product exists
       const existingProduct = await findOneProductDbHandler({ productId: uuid });
       if (!existingProduct) {

docker-compose.yml

@@ -4,7 +4,7 @@ services:
     build: .
     container_name: clean-arch-app
     ports:
-      - "5000:5000"
+      - '5000:5000'
     environment:
       - PORT=5000
       - MONGODB_URI=mongodb://mongo:27017/cleanarchdb
@@ -16,9 +16,9 @@ services:
     image: mongo:6.0
     container_name: clean-arch-mongo
     ports:
-      - "27017:27017"
+      - '27017:27017'
     volumes:
       - mongo_data:/data/db
     restart: unless-stopped
 volumes:
-  mongo_data: 
+  mongo_data:

enterprise-business-rules/validate-models/product-validation-fcts.js

@@ -5,8 +5,6 @@ function validateTitle({ title, InvalidPropertyError }) {
   return title.charAt(0).toUpperCase() + title.slice(1).toLowerCase();
 }
 
-//validate title length
-
 //validate and normalise product description
 function validateDescription({ description, InvalidPropertyError }) {
   if (description.length < 50) {
@@ -98,11 +96,11 @@ function validateBrands(brands, InvalidPropertyError) {
 }
 
 //validate and normalize product rating: rating is an array of refences to users in the users collection
-function validateRating(rating, InvalidPropertyError) {
-  const ratingObj = {};
+// function validateRating(rating, InvalidPropertyError) {
+//   const ratingObj = {};
 
-  return rating;
-}
+//   return rating;
+// }
 
 // validate image type for png jpg
 const validateImageType = (image, InvalidPropertyError) => {

enterprise-business-rules/validate-models/user-validation-functions.js

@@ -97,17 +97,6 @@ function validateRole(roles) {
   return roles;
 }
 
-const validActive = new Set(['true', 'false']);
-function validateActive(active) {
-  if (!validActive.has(active)) {
-    throw new InvalidPropertyError(`A user's active must be either 'true' or 'false'.`);
-  }
-  if (!Array.isArray(active)) {
-    active = [active];
-  }
-  return active;
-}
-
 //validate mongodb id
 function validateId(id) {
   if (!ObjectId.isValid(id)) {
@@ -153,7 +142,6 @@ async function validateUserData(userData) {
   if (!email) errors.push('user must have an email.');
   if (!password) errors.push('user must have a password.');
   if (!roles) errors.push('user must have a role');
-  if (typeof active !== 'boolean') errors.push('user must have an active status');
 
   if (errors.length) {
     throw new RequiredParameterError(errors.join(', '));

interface-adapters/controllers/products/index.js

@@ -1,4 +1,4 @@
-const { dbProductHandler } = require('../../database-access');
+// const { dbProductHandler } = require('../../database-access');
 const productControllerHandlsers = require('./product-controller')();
 const productUseCaseHandlers = require('../../../application-business-rules/use-cases/products');
 

interface-adapters/controllers/users/user-auth-controller.js

@@ -1,3 +1,5 @@
+const { makeHttpError } = require('../../validators-errors/http-error');
+
 module.exports = {
   /**
    * Registers a new user using the provided user case handler.
@@ -410,13 +412,13 @@ module.exports = {
       }
       try {
         const blockedUser = await blockUserUseCaseHandler({ userId });
-        console.log(' from blockUserController controller handler: ', e);
+        console.log(' from blockUserController controller handler: ', blockedUser);
         return {
           headers: {
             'Content-Type': 'application/json',
           },
           statusCode: 201,
-          data: JSON.stringify({ message: 'user blocked successfully' }),
+          data: JSON.stringify({ message: 'user blocked successfully', blockedUser }),
         };
       } catch (e) {
         logEvents(
@@ -470,8 +472,6 @@ module.exports = {
   // user controller for forgot password
   forgotPasswordController: ({
     forgotPasswordUseCaseHandler,
-    UniqueConstraintError,
-    InvalidPropertyError,
     makeHttpError,
     logEvents,
     sendEmail,