done for basic CRUD for products

Author: frckbrice

.gitignore

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

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

@@ -51,11 +51,11 @@ const findOneProductUseCase = ({ productValidation }) => async function
 
 
 // find all product use case handler
-const findAllProductsUseCase = () => findAllProductUseCaseHandler = async ({ dbProductHandler, logEvents }) => {
+const findAllProductsUseCase = () => findAllProductUseCaseHandler = async ({ dbProductHandler, logEvents, filterOptions }) => {
 
     try {
 
-        const allProducts = await dbProductHandler.findAllProductsDbHandler();
+        const allProducts = await dbProductHandler.findAllProductsDbHandler(filterOptions);
         // console.log("from find all products use case: ", allProducts);
         return Object.freeze(allProducts)
     } catch (e) {

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

@@ -284,7 +284,7 @@ const basicProductValidation = ({ productData, errorHandlers }) => {
     resultingProductData.rateAverage = 0;
     resultingProductData.lastModified = new Date().toISOString();
     resultingProductData.instock = Boolean(resultingProductData.inventory && resultingProductData.inventory > 0)
-
+    resultingProductData.brands = productData.brands || [];
 
     if (errors.length) {
         throw new RequiredParameterError(errors.join(', '));

index.js

@@ -8,6 +8,7 @@ const errorHandler = require('./interface-adapters/middlewares/loggers/errorHand
 const userAndAuthRouter = require('./routes/auth-user.router.js');
 const { logger } = require('./interface-adapters/middlewares/loggers/logger.js');
 const productRouter = require('./routes/product.routes.js');
+const createIndexFn = require('./interface-adapters/database-access/db-indexes.js');
 
 const app = express();
 
@@ -19,6 +20,7 @@ const corsOptions = require('./interface-adapters/middlewares/config/corsOptions
 // databae connetion call function
 dbconnection().then((db) => {
     console.log("database connected: ", db.databaseName);
+    createIndexFn();
 });
 
 app.use(logger);

interface-adapters/controllers/examples.js

@@ -26,7 +26,7 @@
     }
   ],
   highlights: [ 'Comfortable', 'Stylish', '100% Cotton' ],
-  already in variations-----> ---------> specifications: { material: 'Cotton', fit: 'Regular' },
+  already in variations -----> specifications: { material: 'Cotton', fit: 'Regular' },
   seoKeywords: [ 'Comfortable', 'Stylish', '100% Cotton' ],
   salePrice: 19,
   slug: 't-shirt',
@@ -57,6 +57,8 @@
   // const uri = 'mongodb://mongodb0.example.com:27017,mongodb1.example.com:27017/?replicaSet=myRepl'
   // For a sharded cluster, connect to the mongos instances; e.g.
   // const uri = 'mongodb://mongos0.example.com:27017,mongos1.example.com:27017/'
+  
+  
   const client = new MongoClient(uri);
   await client.connect();
   // Prereq: Create collections.
@@ -84,7 +86,7 @@
     await session.withTransaction(async () => {
       const coll1 = client.db('mydb1').collection('foo');
       const coll2 = client.db('mydb2').collection('bar');
-      
+
       // Important:: You must pass the session to the operations
       await coll1.insertOne({ abc: 1 }, { session });
       await coll2.insertOne({ xyz: 999 }, { session });

interface-adapters/controllers/products/product-controller.js

@@ -119,13 +119,14 @@ const findOneProductController = ({
 
 
 // find all product controller
-const findAllProductController = ({ dbProductHandler, findAllProductUseCaseHandler, logEvents }) => async function findAllProductControllerHandler() {
+const findAllProductController = ({ dbProductHandler, findAllProductUseCaseHandler, logEvents }) => async function findAllProductControllerHandler(httpRequest) {
 
-    console.log("from find all product controller")
 
+    const filterOptions = httpRequest.query;
     return findAllProductUseCaseHandler({
         dbProductHandler,
-        logEvents
+        logEvents,
+        filterOptions
     }).then((products) => {
 
         // console.log("products from findAllProductController: ", products);
@@ -240,8 +241,6 @@ const rateProductController = ({ dbProductHandler, rateProductUseCaseHandler, ma
         productId,
     } = httpRequest.body;
 
-    console.log("hit rating product controller")
-
     if (!productId || !userId || !ratingValue) {
         return makeHttpError({
             statusCode: 400,
@@ -278,7 +277,7 @@ const rateProductController = ({ dbProductHandler, rateProductUseCaseHandler, ma
             `${e.no}:${e.type}\t${e.name}\t${e.message}`,
             "controllerHandlerErr.log"
         );
-        console.log("error from rateProductController controller handler: ", e);
+        console.error("error from rateProductController controller handler: ", e);
         if (e.name === 'RangeError')
             return makeHttpError({ errorMessage: e.message, statusCode: e.statusCode || 404 })
         return makeHttpError({ errorMessage: e.message, statusCode: e.statusCode || 500 });

interface-adapters/database-access/db-connection.js

@@ -3,6 +3,11 @@ const { MongoServerSelectionError, MongoServerClosedError, MongoServerError } =
 const { logEvents } = require("../../interface-adapters/middlewares/loggers/logger")
 module.exports = {
 
+    /**
+ * Establishes a connection to the MongoDB database and returns a reference to the database.
+ *
+ * @return {Promise<Db>} A promise that resolves to a reference to the MongoDB database.
+ */
     dbconnection: async () => {
         // The MongoClient is the object that references the connection to our
         // datastore (Atlas, for example)
@@ -34,6 +39,7 @@ module.exports = {
         const database = client.db(datastoreName);
         // const userCollection = database.collection("users");
 
+
         return database;
     }
 }

interface-adapters/database-access/db-indexes.js

@@ -1,31 +1,53 @@
-import { makeDb } from '../src/data-access'
-import dotenv from 'dotenv'
-dotenv.config();
+const { dbconnection } = require('./db-connection');
+require('dotenv').config();
 
-// database collection will automatically be created if it does not exist
-// indexes will only be added if they don't exist
-//Although indexes improve query performance, adding an index has negative performance impact for write operations
-(async function setupDb() {
+// all the collections stated here are created if not exist.
+module.exports = async function setupDb() {
   console.log('Setting up database...')
+  const db = await dbconnection();
 
-  const db = await makeDb()
-  const result = await db
-    .collection('users')
-    .createIndexes([
-      { key: { id: 1 }, name: 'userId_idx' },
-      { key: { email: 1 }, name: 'email_idx' },
-      { background: true, sparse: true }
-    ], function (err, result) {
-      console.log(result);
-      callback(result);
-    });
+  const allProductsIndexName = await db.collection("products").listIndexes().toArray();
 
-  db.collection("Rating")
-    .createIndex([{ userId: 1 }, { postId: 1 }, { background: true, sparse: true }], function (err, result) {
-      console.log(result);
-      callback(result);
-    })
 
+  let indexArr = [];
+  // create indexes only if not exist
+  allProductsIndexName.forEach(element => {
+    if (element.name === 'productTextIndex' || element.name === 'productUniqueIndex') {
+      return;
+    }
+    indexArr = [...indexArr, db.collection('products').createIndexes([
+      {
+        key: { "title": "text", "description": "text", "category": "text", "seoKeywords": "text", "origin": "text", "variations": "text", "highlights": "text", "brand": "text" },
+        name: 'productTextIndex',
+        default_language: 'english',
+        weights: { description: 10, title: 3 }
+      },
+      { key: { title: 1, }, name: 'productUniqueIndex' }
+    ])]
+  });
 
-  process.exit()
-})()
+  const allUsersIndexName = await db.collection("users").listIndexes().toArray();
+  allUsersIndexName.forEach(element => {
+    if (element.name === 'userUniqueIndex') {
+      return;
+    }
+    indexArr = [...indexArr, db.collection('users').createIndexes([
+      { key: { email: 1, }, unique: true, name: 'userUniqueIndex' }
+    ])]
+  });
+
+  const allRatingsIndexName = await db.collection("ratings").listIndexes().toArray();
+  allRatingsIndexName.forEach(element => {
+    if (element.name === 'ratingsUniqueIndex') {
+      // db.collection('ratings').dropIndex('ratingsUniqueIndex');
+      return;
+    }
+    indexArr = [...indexArr, db.collection('ratings').createIndexes([
+      { key: { userId: 1, postId: 1 }, name: 'ratingUniqueIndex' }
+    ])]
+  });
+
+  await Promise.all([
+    ...indexArr
+  ]);
+}

interface-adapters/database-access/store-product.js

@@ -57,24 +57,48 @@ const findOneProduct = async ({ productId, dbconnection }) => {
 }
 
 // find all products from the database 
-const findAllProducts = async ({ dbconnection, logEvents }) => {
+const findAllProducts = async ({ dbconnection, logEvents, ...filterOptions }) => {
+    const { category, minPrice, maxPrice, page, perPage, searchTerm } = filterOptions;
 
-    const db = await dbconnection();
-    try {
-        const allProducts = await db.collection('products').find({}, {
-            projection: {
-                _id: 1, title: 1, description: 1, price: 1, category: 1, brand: 1, inventory: 1, creationDate: 1, expirationDate: 1, origin: 1, variations: 1, salePrice: 1, slug: 1, totalRatings: 1, totalReviews: 1, totalSales: 1, rateAverage: 1,
-                lastModified: 1,
-                instock: 1
-            }
-        }).toArray()
+    //TODO: id necessary add limiting fields. this affect the projection props
 
-        return allProducts.map((product) => {
-            const id = product._id.toString();
-            delete product._id;
-            return { ...product, id };
-        });
+    const filter = {};
+    if (category) filter.category = category;
+    if (minPrice) filter.price = { $gte: parseFloat(minPrice) };
+    if (maxPrice) filter.price = { $lte: parseFloat(maxPrice) };
+    if (searchTerm) filter.$text = { $search: searchTerm };
 
+    const projection = {
+        _id: 0, title: 1, description: 1, price: 1, category: 1, brand: 1, creationDate: 1, expirationDate: 1, origin: 1, variations: 1, salePrice: 1, slug: 1,
+        lastModified: 1,
+        instock: 1
+    };
+
+    const offset = (page - 1) * perPage;
+    const db = await dbconnection();
+
+    try {
+        const allProducts = await db
+            .collection('products')
+            .find(filter)
+            .project(projection)
+            .skip(offset)
+            .limit(Number(perPage))
+            .toArray();
+
+
+        const totalProducts = await db
+            .collection('products').countDocuments(filter);
+        const totalPages = Math.ceil(totalProducts / perPage);
+        const products = allProducts.map(product => ({ ...product, id: product._id.toString() }));
+
+        return {
+            data: products,
+            totalProducts,
+            totalPages,
+            page,
+            perPage
+        };
     } catch (error) {
         console.log("Error from product DB handler: ", error);
         logEvents(
@@ -83,7 +107,7 @@ const findAllProducts = async ({ dbconnection, logEvents }) => {
         );
         return [];
     }
-}
+};
 
 // update existing product
 const updateProduct = async ({ productId, productData, dbconnection, logEvents }) => {
@@ -169,8 +193,10 @@ const rateProduct = async ({ logEvents, ...ratingModel }) => {
             const productCollection = client.db("digital-market-place-updates").collection("products");
             const ratingCollection = client.db("digital-market-place-updates").collection("ratings");
 
+            // check if the product has been rated before.
             const existingProduct = await productCollection.findOne({ _id: new ObjectId(ratingModel.productId) }, { session });
-            if (!existingProduct) {
+            if (!existingProduct) {// cannot rate ghost product.
+                session.abortTransaction();
                 return {
                     error: {
                         code: 404,
@@ -182,6 +208,7 @@ const rateProduct = async ({ logEvents, ...ratingModel }) => {
             /* find first if this user has already rate this existing product*/
             const existingRating = await ratingCollection.findOne({ userId: ratingModel.userId, productId: ratingModel.productId }, { session });
             if (existingRating) {
+                session.abortTransaction();
                 return {
                     error: {
                         code: 409,
@@ -190,17 +217,15 @@ const rateProduct = async ({ logEvents, ...ratingModel }) => {
                 };
             }
 
-            console.log("before insertion")
             /* create a new rating document */
             const newRating = await ratingCollection.insertOne(ratingModel, { session });
-            console.log("after insertion")
             const { totalRatings } = existingProduct;
             const totalReviews = totalRatings?.reduce((sum, rating) => sum + rating, 0) || 0;
-            const newAverage = totalRatings?.reduce((sum, rating, index) => sum + rating * (index + 1), 0) / (totalReviews || 1);
+            const newAverage = totalReviews ? totalRatings?.reduce((sum, rating, index) => sum + rating * (index + 1), 0) / totalReviews : existingProduct.rateAverage;
 
             /* increase the new rating value in the totalRatings array */
             for (let index = 0; index < 5; index++) {
-                if ((ratingModel.ratingValue === (index + 1))) {
+                if (ratingModel.ratingValue === (index + 1)) {
                     totalRatings[index] = totalRatings[index] + 1;
                 }
             }
@@ -224,11 +249,8 @@ const rateProduct = async ({ logEvents, ...ratingModel }) => {
                 },
                 { session }
             );
-
-            await session.commitTransaction();
-            console.log("Product rated successfully!", updatedProduct);
+            // await session.commitTransaction();
             return { updatedProduct, newRating };
-
         }, transactionOptions);
 
     } catch (error) {
@@ -244,7 +266,6 @@ const rateProduct = async ({ logEvents, ...ratingModel }) => {
         await client.close();
     }
 }
-
 // find one rating for a product based on product id and user id
 const findOneRating = async ({ productId, userId }) => {
 
@@ -267,7 +288,7 @@ module.exports = ({ dbconnection, logEvents }) => {
     return Object.freeze({
         createProductDbHandler: async (productData) => createProduct(productData, dbconnection, logEvents),
         findOneProductDbHandler: async ({ productId }) => findOneProduct({ productId, dbconnection, logEvents }),
-        findAllProductsDbHandler: async () => findAllProducts({ dbconnection, logEvents }),
+        findAllProductsDbHandler: async (filterOptions) => findAllProducts({ dbconnection, logEvents, ...filterOptions }),
         updateProductDbHandler: async ({ productId, productData }) => updateProduct({ productId, productData, dbconnection, logEvents }),
         deleteProductDbHandler: async ({ productId }) => deleteProduct({ productId, dbconnection, logEvents }),
         updateProductDbHandler: async ({ productId, ...productData }) => updatedProduct({ productId, dbconnection, logEvents, ...productData }),

interface-adapters/middlewares/logs/mongoErrLog.log

@@ -125,3 +125,11 @@
 	undefined	undefined
 2024-07-04	20:30:49	627dba76-ad4f-494d-9748-486930a8eb79	undefined:40388ADB40740000:error:0A000438:SSL routines:ssl3_read_bytes:tlsv1 alert internal error:../deps/openssl/openssl/ssl/record/rec_layer_s3.c:1590:SSL alert number 80
 	undefined	undefined
+2024-07-12	13:33:59	a56141b4-1fc5-4efd-87d7-e1541598def8	undefined:40B8665EC9770000:error:0A000438:SSL routines:ssl3_read_bytes:tlsv1 alert internal error:../deps/openssl/openssl/ssl/record/rec_layer_s3.c:1590:SSL alert number 80
+	undefined	undefined
+2024-07-12	13:34:56	7bc5ff36-49d3-48d2-a2c4-adb47ce952ff	undefined:4068F109A47B0000:error:0A000438:SSL routines:ssl3_read_bytes:tlsv1 alert internal error:../deps/openssl/openssl/ssl/record/rec_layer_s3.c:1590:SSL alert number 80
+	undefined	undefined
+2024-07-12	13:48:31	f2a555f9-bd54-4555-8c8a-9ca886fc1084	undefined:4038EB82E7720000:error:0A000438:SSL routines:ssl3_read_bytes:tlsv1 alert internal error:../deps/openssl/openssl/ssl/record/rec_layer_s3.c:1590:SSL alert number 80
+	undefined	undefined
+2024-07-12	13:49:14	c99b1035-de1b-4e3f-9843-46d4d9b91e80	undefined:40C84CEB5B7C0000:error:0A000438:SSL routines:ssl3_read_bytes:tlsv1 alert internal error:../deps/openssl/openssl/ssl/record/rec_layer_s3.c:1590:SSL alert number 80
+	undefined	undefined