tango-app-api-audit 1.0.2 → 1.0.3

package/src/controllers/auditMetrics.controllers.js

@@ -1,21 +1,407 @@
+import { download, getUTC, logger } from 'tango-app-api-middleware';
+import { aggregateAuditClientData } from '../service/auditClientData.service.js';
+// import { listQueue } from 'tango-app-api-middleware/src/utils/aws/sqs.js';
 
 
 export async function getAuditImageList( req, res ) {
-  try {
-    const inputData = req.body;
-    return res.sendSuccess( { result: inputData } );
-  } catch ( error ) {
-    logger.info( { error: error, message: req.body, function: 'getAuditImageList' } );
-    return res.sendError( error );
-  }
+  // try {
+  //   logger.info( { env: env } );
+  //   const inputData = req.body;
+  //   return res.sendSuccess( { result: inputData, config: env.cloud.aws.region } );
+  // } catch ( error ) {
+  //   logger.info( { error: error, message: req.body, function: 'getAuditImageList' } );
+  //   return res.sendError( error );
+  // }
 }
 
 export async function userAuditHistory( req, res ) {
+  // try {
+  //   const inputData = req.body;
+  //   return res.sendSuccess( { result: inputData } );
+  // } catch ( error ) {
+  //   logger.info( { error: error, message: req.body, function: 'userAuditHistory' } );
+  //   return res.sendError( error );
+  // }
+}
+
+export async function storeMetrics( req, res ) {
+  // try {
+  //   const today = moment().subtract( 1, 'days' ).format( 'YYYY-MM-DD' );
+  //   const inputData = req.body;
+  //   const dateRange = await getUTC( new Date( inputData.fromDate ), new Date( inputData.toDate ) );
+  //   const start = dateRange.start;
+  //   const end = dateRange.end;
+  //   const filter = [
+  //     { fileDateISO: { $gte: start } },
+  //     { fileDateISO: { $lte: end } },
+  //   ];
+  //   if ( inputData.filterByClient && inputData.filterByClient?.length > 0 ) {
+  //     filter.push( { clientId: { $in: inputData.filterByClient } } );
+  //   }
+  //   const query = [
+  //     {
+  //       $match: {
+  //         $and: filter,
+  //       },
+  //     },
+  //     {
+  //       $project: {
+  //         fileDate: 1,
+  //         fileDateISO: 1,
+  //         clientName: 1,
+  //         clientId: 1,
+  //         installedStore: 1,
+  //         totalFilesCount: 1,
+  //         queueName: 1,
+  //       },
+  //     },
+  //     {
+  //       $lookup: {
+  //         'from': 'audit',
+  //         'let': { 'client_id': '$clientId', 'file_date': '$fileDate', 'total_files_count': '$totalFilesCount' },
+  //         'pipeline': [
+
+  //           {
+  //             $match: {
+  //               $expr: {
+  //                 $and: [
+  //                   { $eq: [ '$clientId', '$$client_id' ] },
+  //                   { $eq: [ '$fileDate', '$$file_date' ] },
+  //                 ],
+  //               },
+  //             },
+  //           },
+  //           {
+  //             $project: {
+  //               completedStores: { $cond: [ { $eq: [ '$storeStatus', 'completed' ] }, 1, 0 ] },
+  //               assignedStores: { $cond: [ { $or: [ { $in: [ '$auditStatus', [ 'inprogress', 'drafted' ] ] }, { $in: [ '$storeStatus', [ 'skipped' ] ] } ] }, 1, 0 ] },
+  //             },
+  //           },
+  //           {
+  //             $group: {
+  //               _id: { clientId: '$clientId', fileDate: '$fileDate' },
+  //               completedStores: { $sum: '$completedStores' },
+  //               assignedStores: { $sum: '$assignedStores' },
+  //               fileCount: { $sum: 1 },
+
+  //             },
+  //           },
+  //           {
+  //             $project: {
+  //               _id: 0,
+  //               fileDateISO: 1,
+  //               completedStores: 1,
+  //               assignedStores: 1,
+  //               completePercentage: {
+  //                 $round: [ {
+  //                   $multiply: [
+  //                     100, {
+  //                       $divide: [
+  //                         '$completedStores', '$$total_files_count',
+  //                       ],
+  //                     },
+  //                   ],
+  //                 }, 1 ],
+
+  //               },
+  //               fileCount: 1,
+  //             },
+
+  //           },
+  //         ], 'as': 'audit',
+  //       },
+  //     },
+  //     {
+  //       $unwind: { path: '$audit', preserveNullAndEmptyArrays: true },
+  //     },
+  //     {
+  //       $project: {
+  //         _id: 0,
+  //         clientId: 1,
+  //         clientName: 1,
+  //         fileDate: 1,
+  //         fileDateISO: 1,
+  //         installedStore: 1,
+  //         totalFilesCount: 1,
+  //         queueName: 1,
+  //         completedStores: { $ifNull: [ '$audit.completedStores', 0 ] },
+  //         assignedStores: { $ifNull: [ '$audit.assignedStores', 0 ] },
+  //         completePercentage: { $ifNull: [ '$audit.completePercentage', 0 ] },
+  //         notAssigned: '',
+  //         status: '',
+  //         fileCount: { $ifNull: [ '$audit.fileCount', 0 ] },
+  //       },
+  //     },
+
+  //   ];
+  //   query.push( {
+  //     $sort: {
+  //       fileDateISO: -1,
+  //     },
+  //   } );
+
+  //   if ( inputData.searchValue && inputData.searchValue !== '' ) {
+  //     query.push( {
+  //       $match: {
+  //         $or: [
+  //           { clientId: { $regex: inputData.searchValue, $options: 'i' } },
+  //           { clientName: { $regex: inputData.searchValue, $options: 'i' } },
+  //         ],
+  //       },
+  //     } );
+  //   }
+  //   const result = await auditFilesCount.aggregate( query );
+
+  //   if ( result.length == 0 ) {
+  //     return res.sendError( 'No data Found', 204 );
+  //   }
+  //   let count;
+  //   if ( inputData.filterByStatus && inputData.filterByStatus.length > 0 ) {
+  //     let testCount;
+  //     for ( let i = 0; i < result.length; i++ ) {
+  //       const item = result[i];
+  //       if ( inputData.fromDate === inputData.toDate && inputData.fromDate === today ) {
+  //         const temp = await listQueue( item.queueName );
+  //         item.notAssigned = Number( temp );
+  //       } else {
+  //         item.notAssigned = 'No Data';
+  //       }
+  //       item.status = ( item.totalFilesCount === item.completedStores && item.assignedStores === 0 && ( item.notAssigned == 0 || item.notAssigned === 'No Data' ) ) ? 'completed' :
+  //         item.fileCount > 0 ? 'pending' : 'not_taken';
+  //       delete item.fileCount;
+  //       testCount = result.filter( ( i ) => inputData.filterByStatus.includes( i.status ) );
+  //       count = testCount.length;
+  //     }
+  //     if ( !inputData.export ) {
+  //       const skip = ( inputData.offset - 1 ) * inputData.limit;
+  //       testCount = testCount.slice( skip, skip + inputData.limit );
+  //     }
+  //     if ( inputData.export ) {
+  //       const exportdata = [];
+  //       testCount.forEach( ( element ) => {
+  //         exportdata.push( {
+  //           'File Date': element.fileDate,
+  //           'Client Name': element.clientName,
+  //           'Client Id': element.clientId,
+  //           'Completed Percentage': element.completePercentage + ' %',
+  //           'Installed Stores': element.installedStore,
+  //           'Audit Stores': element.totalFilesCount,
+  //           'Inprogress Stores': element.assignedStores,
+  //           'Not Assigned': element.notAssigned && element.notAssigned == 'No Data' ? 0 : element.notAssigned,
+  //           'Completed': element.completedStores,
+  //           'Status': element.status,
+  //         } );
+  //       } );
+  //       await download( exportdata, res );
+  //       return;
+  //     }
+  //     return res.sendSuccess( { result: testCount, count: count } );
+  //   }
+  //   for ( let i = 0; i < result.length; i++ ) {
+  //     const item = result[i];
+  //     if ( inputData.fromDate === inputData.toDate && inputData.fromDate === today ) {
+  //       const temp = await listQueue( item.queueName );
+  //       item.notAssigned = Number( temp );
+  //     } else {
+  //       item.notAssigned = 'No Data';
+  //     }
+  //     item.status = ( item.totalFilesCount === item.completedStores && item.assignedStores === 0 && ( item.notAssigned == 0 || item.notAssigned === 'No Data' ) ) ? 'completed' :
+  //       item.fileCount > 0 ? 'pending' : 'not_taken';
+  //     delete item.fileCount;
+  //   }
+  //   if ( inputData.export ) {
+  //     const exportdata = [];
+  //     result.forEach( ( element ) => {
+  //       exportdata.push( {
+  //         'File Date': element.fileDate,
+  //         'Client Name': element.clientName,
+  //         'Client Id': element.clientId,
+  //         'Completed Percentage': element.completePercentage + ' %',
+  //         'Installed Stores': element.installedStore,
+  //         'Audit Stores': element.totalFilesCount,
+  //         'Assigned Stores': element.assignedStores,
+  //         'Not Assigned': element.notAssigned && element.notAssigned == 'No Data' ? 0 : element.notAssigned,
+  //         'Completed': element.completedStores,
+  //         'Status': element.status,
+  //       } );
+  //     } );
+  //     await download( exportdata, res );
+  //     return;
+  //   }
+  //   return res.sendSuccess( { result: result, count: count } );
+  // } catch ( error ) {
+  //   logger.error( { error: error, data: req.body, function: 'storeMetrics' } );
+  //   return res.sendError( error, 500 );
+  // }
+}
+
+export async function clientMetrics( req, res ) {
   try {
+    // const sqs = JSON.parse( process.env.SQS );
     const inputData = req.body;
-    return res.sendSuccess( { result: inputData } );
+    const limit = inputData.limit || 10;
+    const offset = inputData.offset ? ( inputData.offset - 1 ) * limit : 0;
+    const dateRange = await getUTC( new Date( inputData.fromDate ), new Date( inputData.toDate ) );
+    let filter = [
+      { fileDateISO: { $gte: dateRange.start } },
+      { fileDateISO: { $lte: dateRange.end } },
+      { clientId: { $in: inputData.filterByClient } },
+    ];
+    const query = [
+      {
+        $match: {
+          $and: filter,
+        },
+      },
+      {
+        $project: {
+          fileDate: 1,
+          clientId: 1,
+          clientName: 1,
+          queueName: 1,
+          installedStore: 1,
+          totalFilesCount: 1,
+          notAssignedCount: { $ifNull: [ 0, 0 ] },
+          clientStatus: { $ifNull: [ '', '' ] },
+        },
+      },
+      {
+        $lookup: {
+          'from': 'storeAudit',
+          'let': { clientId: '$clientId', fileDate: '$fileDate', totalAuditFiles: '$totalAuditFiles' },
+          'pipeline': [
+
+            {
+              $match: {
+                $expr: {
+                  $and: [
+                    { $eq: [ '$clientId', '$$clientId' ] },
+                    { $eq: [ '$fileDate', '$$fileDate' ] },
+                  ],
+                },
+              },
+            },
+            {
+              $project: {
+                completedStores: { $cond: [ { $eq: [ '$status', 'completed' ] }, 1, 0 ] },
+                inprogressStores: { $cond: [ { $in: [ '$status', [ 'inprogress', 'drafted', 'assigned' ] ] }, 1, 0 ] },
+              },
+            },
+            {
+              $group: {
+                _id: { clientId: '$clientId', fileDate: '$fileDate' },
+                completedStores: { $sum: '$completedStores' },
+                inprogressStores: { $sum: '$inprogressStores' },
+              },
+            },
+            {
+              $project: {
+                _id: 0,
+                completedStores: 1,
+                inprogressStores: 1,
+                completionPercentage: { $ifNull: [
+                  {
+                    $round: [ {
+                      $multiply: [
+                        100, {
+                          $divide: [
+                            '$completedStores', '$$totalAuditFiles',
+                          ],
+                        },
+                      ],
+                    }, 1 ],
+
+                  },
+                  0,
+                ],
+                },
+              },
+            },
+          ], 'as': 'storeAudit',
+        },
+      },
+      {
+        $unwind: {
+          path: '$storeAudit',
+          preserveNullAndEmptyArrays: true,
+        },
+      },
+      {
+        $project: {
+          fileDate: 1,
+          clientId: 1,
+          clientName: 1,
+          totalFilesCount: 1,
+          installedStore: 1,
+          inprogressStoresCount: '$storeAudit.inprogressStores',
+          notAssignedCount: 1,
+          clientStatus: { $cond: [ { $gt: [ '$storeAudit.inprogressStores', 0 ] }, 'not-taken', { $cond: [ { $gt: [ '$notAssignedCount', 0 ] }, 'pending', 'completed' ] } ] },
+          completedStores: '$storeAudit.completedStores',
+          completionPercentage: '$storeAudit.completionPercentage',
+
+        },
+      },
+    ];
+    if ( inputData.searchValue ) {
+      query.push( {
+        $match: {
+          $or: [
+            { clientId: { $regex: inputData.searchValue, $options: 'i' } },
+            { clientName: { $regex: inputData.searchValue, $options: 'i' } },
+          ],
+
+        },
+      } );
+    }
+    if ( inputData.sortColumnName ) {
+      const sortBy = inputData.sortBy || -1;
+      query.push( {
+        $sort: { [inputData.sortColumName]: sortBy },
+      },
+      );
+    }
+
+    const count = await aggregateAuditClientData( query );
+    if ( count.length == 0 ) {
+      return res.sendError( 'No Data Found', 204 );
+    }
+
+    query.push(
+        { $skip: offset },
+        { $limit: limit },
+    );
+    if ( inputData.isExport ) {
+      query.push(
+          {
+            $project: {
+              'File Date': '$fileDate',
+              'Client Name': '$clientName',
+              'Client Id': '$clientId',
+              'Completed Percentage': '$completionPercentage' + ' %',
+              'Installed Stores': '$installedStore',
+              'Audit Stores': '$totalFilesCount',
+              'Inprogress Stores': '$inprogressStoresCount',
+              'Not Assigned': '$notAssignedCount',
+              'Completed': '$completedStores',
+              'Status': '$clientStatus',
+            },
+          },
+          {
+
+          },
+      );
+    }
+
+
+    const result = await aggregateAuditClientData( query );
+    if ( inputData.isExport ) {
+      await download( result, res );
+      return;
+    }
+    return res.sendSuccess( { result: result, count: count.length } );
   } catch ( error ) {
-    logger.info( { error: error, message: req.body, function: 'userAuditHistory' } );
-    return res.sendError( error );
+    const err = error.error || 'Internal Server Error';
+    logger.info( { error: error, message: req.body, function: 'clientMetrics' } );
+    return res.sendError( err, 500 );
   }
 }

package/src/docs/audit.docs.js

@@ -0,0 +1,39 @@
+import { getFileSchema } from '../dtos/audit.dtos.js';
+import j2s from 'joi-to-swagger';
+
+export const auditDocs = {
+  '/v3/audit/get-file': {
+    get: {
+      tags: [ 'Audit' ],
+      description: 'Get a file via queue message',
+      operationId: 'get-file',
+      parameters: [
+        {
+          in: 'query',
+          name: 'queueName',
+          scema: j2s( getFileSchema ).swagger,
+          require: true,
+        },
+        {
+          in: 'query',
+          name: 'nextId',
+          scema: j2s( getFileSchema ).swagger,
+          require: false,
+        },
+        {
+          in: 'query',
+          name: 'limit',
+          scema: j2s( getFileSchema ).swagger,
+          require: false,
+        },
+      ],
+      responses: {
+        200: { description: 'Successfully' },
+        401: { description: 'Unauthorized User' },
+        422: { description: 'Field Error' },
+        500: { description: 'Server Error' },
+        204: { description: 'Not Found' },
+      },
+    },
+  },
+};

package/src/docs/auditMetrics.docs.js

@@ -1,5 +1,5 @@
 import j2s from 'joi-to-swagger';
-import { getAuditImagesSchema } from '../dtos/auditMetrics.dtos.js';
+import { clientMetricsSchema, getAuditImagesSchema } from '../dtos/auditMetrics.dtos.js';
 
 export const auditMetricsDocs = {
 
@@ -25,4 +25,26 @@ export const auditMetricsDocs = {
       },
     },
   },
+  '/v3/audit-metrics/client-metrics': {
+    post: {
+      tags: [ 'Audit Metrics' ],
+      description: `Get list of client wise details with date range`,
+      operationId: 'client-metrics',
+      parameters: {},
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: j2s( clientMetricsSchema ).swagger,
+          },
+        },
+      },
+      responses: {
+        200: { description: 'Successful' },
+        401: { description: 'Unauthorized User' },
+        422: { description: 'Field Error' },
+        500: { description: 'Server Error' },
+        204: { description: 'Not Found' },
+      },
+    },
+  },
 };

package/src/dtos/audit.dtos.js

@@ -0,0 +1,27 @@
+import joi from 'joi';
+
+
+export const getFileSchema = joi.object(
+    {
+      queueName: joi.string().required(),
+      nextId: joi.string().optional(),
+      limit: joi.number().optional(),
+    },
+);
+
+export const getFileValid = {
+  query: getFileSchema,
+};
+
+export const getQueueDetailListSchema = joi.object(
+    {
+      searchValue: joi.string().optional(),
+      offset: joi.string().optional(),
+      limit: joi.number().optional(),
+      export: joi.number().optional(),
+    },
+);
+
+export const getQueueDetailListValid = {
+  query: getQueueDetailListSchema,
+};

package/src/dtos/auditMetrics.dtos.js

@@ -27,3 +27,35 @@ export const userAuditHistorySchema = joi.object(
 export const userAuditHistoryValid = {
   body: userAuditHistorySchema,
 };
+
+export const storeMetricsSchema = joi.object(
+    {
+      fromDate: joi.string().required(),
+      toDate: joi.string().required(),
+      searchValue: joi.string().optional(),
+      clientId: joi.array().required(),
+    },
+);
+
+export const storeMetricsValid = {
+  body: storeMetricsSchema,
+};
+
+export const clientMetricsSchema = joi.object(
+    {
+      fromDate: joi.string().required(),
+      toDate: joi.string().required(),
+      searchValue: joi.string().optional(),
+      filterByClient: joi.array().required(),
+      status: joi.array().optional(),
+      sortColumnName: joi.string().optional(),
+      sortBy: joi.number().optional(),
+      limit: joi.number().optional(),
+      offset: joi.number().optional(),
+      isExport: joi.boolean().optional(),
+    },
+);
+
+export const clientMetricsValid = {
+  body: clientMetricsSchema,
+};

package/src/routes/audit.routes.js

@@ -1,6 +1,12 @@
 import express from 'express';
+import { isExistsQueue } from '../validation/audit.validation.js';
+import { isAllowedSessionHandler, validate } from 'tango-app-api-middleware';
+import { getAuditFile, getQueueDetailList } from '../controllers/audit.controllers.js';
+import { getFileValid, getQueueDetailListValid } from '../dtos/audit.dtos.js';
 
 export const auditRouter = express.Router();
 
+auditRouter.get( '/get-file', validate( getFileValid ), isAllowedSessionHandler, isExistsQueue, getAuditFile );
+auditRouter.get( '/get-queue-detail-list', validate( getQueueDetailListValid ), isAllowedSessionHandler, getQueueDetailList );
 
 export default auditRouter;

package/src/routes/auditMetrics.routes.js

@@ -1,12 +1,13 @@
 
 import express from 'express';
 import { isAllowedSessionHandler, validate } from 'tango-app-api-middleware';
-import { getAuditImageList, userAuditHistory } from '../controllers/auditMetrics.controllers.js';
-import { getAuditImagesValid, userAuditHistoryValid } from '../dtos/auditMetrics.dtos.js';
+import { clientMetrics, getAuditImageList, storeMetrics, userAuditHistory } from '../controllers/auditMetrics.controllers.js';
+import { clientMetricsValid, getAuditImagesValid, storeMetricsValid, userAuditHistoryValid } from '../dtos/auditMetrics.dtos.js';
 
 export const auditMetricsRouter = express.Router();
 
-auditMetricsRouter.post( '/get-audit-images', validate( getAuditImagesValid ), isAllowedSessionHandler, getAuditImageList );
+auditMetricsRouter.post( '/get-audit-images', validate( getAuditImagesValid ), getAuditImageList );
 auditMetricsRouter.post( '/user-audit-history', validate( userAuditHistoryValid ), isAllowedSessionHandler, userAuditHistory );
-
+auditMetricsRouter.post( '/store-metrics', validate( storeMetricsValid ), isAllowedSessionHandler, storeMetrics );
+auditMetricsRouter.post( '/client-metrics', validate( clientMetricsValid ), isAllowedSessionHandler, clientMetrics );
 export default auditMetricsRouter;

package/src/service/assignAudit.service.js

@@ -0,0 +1,8 @@
+import assignAuditModel from 'tango-api-schema/schema/assignAudit.model.js';
+
+export function aggregateAssignAudit( query ) {
+  return assignAuditModel.aggregate( query, { collation: { locale: 'en', strength: 2 } } );
+}
+export function updateOneAssignAudit( query, record ) {
+  return assignAuditModel.updateOne( query, record );
+}

package/src/service/auditClientData.service.js

@@ -0,0 +1,6 @@
+import auditClientDataModel from 'tango-api-schema/schema/auditClientData.model.js';
+
+
+export function aggregateAuditClientData( query ) {
+  return auditClientDataModel.aggregate( query, { collation: { locale: 'en', strength: 2 } } );
+}

package/src/service/client.service.js

@@ -0,0 +1,6 @@
+import clientModel from 'tango-api-schema/schema/client.model.js';
+
+
+export function aggregateClient( query ) {
+  return clientModel.aggregate( query, { collation: { locale: 'en', strength: 2 } } );
+}

package/src/service/storeAudit.service.js

@@ -0,0 +1,9 @@
+import storeAuditModel from 'tango-api-schema/schema/storeAudit.model.js';
+
+export function updateOneStoreAudit( query, record ) {
+  return storeAuditModel.updateOne( query, record );
+}
+
+export function createStoreAudit( record ) {
+  return storeAuditModel.create( record );
+}

package/src/service/user.service.js

@@ -0,0 +1,6 @@
+import userModel from 'tango-api-schema/schema/user.model.js';
+
+
+export function findOneUser( query, fields ) {
+  return userModel.findOne( query, fields );
+}

package/src/service/userAudit.service.js

@@ -0,0 +1,14 @@
+import userAuditModel from 'tango-api-schema/schema/userAudit.model.js';
+
+
+export function aggregateUserAudit( query ) {
+  return userAuditModel.aggregate( query, { collation: { locale: 'en', strength: 2 } } );
+}
+
+export function updateOneUserAudit( query, record ) {
+  return userAuditModel.updateOne( query, record );
+}
+
+export function createUserAudit( record ) {
+  return userAuditModel.create( record );
+}

package/src/validation/audit.validation.js

@@ -0,0 +1,16 @@
+import { getQueueUrl, logger } from 'tango-app-api-middleware';
+
+export async function isExistsQueue( req, res, next ) {
+  try {
+    const inputData = req.query;
+    const isExist = await getQueueUrl( inputData.queueName );
+    if ( isExist.statusCode ) {
+      return res.sendError( `Queue doesn't Exist`, 400 );
+    } else {
+      next();
+    }
+  } catch ( error ) {
+    logger.error( { error: error, message: req.query, function: 'isExistsQueue' } );
+    return res.sendError( error, 500 );
+  }
+}