From d6fbf02092a86a5011fa44f51099288007e5f995 Mon Sep 17 00:00:00 2001 From: Patrick Fic Date: Thu, 9 Jan 2025 11:22:08 -0800 Subject: [PATCH 1/2] IO-3076 Initial usage reports design. --- server.js | 3 +- server/data/data.js | 1 + server/data/usageReport.js | 84 ++++++++++++++++++++++++++++++++ server/graphql-client/queries.js | 73 +++++++++++++++++++++++++++ server/routes/dataRoutes.js | 3 +- server/tasks/tasks.js | 2 +- 6 files changed, 163 insertions(+), 3 deletions(-) create mode 100644 server/data/usageReport.js diff --git a/server.js b/server.js index 5327d2998..ef480a7ea 100644 --- a/server.js +++ b/server.js @@ -329,7 +329,8 @@ const main = async () => { main().catch((error) => { logger.log(`Main-API-Error: Something was not caught in the application.`, "error", "api", null, { error: error.message, - errorjson: JSON.stringify(error) + errorjson: JSON.stringify(error), + stack: error.stack }); // Note: If we want the app to crash on all uncaught async operations, we would // need to put a `process.exit(1);` here diff --git a/server/data/data.js b/server/data/data.js index 0f6fcd30c..bc79ef9a3 100644 --- a/server/data/data.js +++ b/server/data/data.js @@ -3,3 +3,4 @@ exports.autohouse = require("./autohouse").default; exports.chatter = require("./chatter").default; exports.claimscorp = require("./claimscorp").default; exports.kaizen = require("./kaizen").default; +exports.usageReport = require("./usageReport").default; \ No newline at end of file diff --git a/server/data/usageReport.js b/server/data/usageReport.js new file mode 100644 index 000000000..6c3734826 --- /dev/null +++ b/server/data/usageReport.js @@ -0,0 +1,84 @@ +const path = require("path"); +require("dotenv").config({ + path: path.resolve(process.cwd(), `.env.${process.env.NODE_ENV || "development"}`) +}); +const client = require("../graphql-client/graphql-client").client; +const emailer = require("../email/sendemail"); +const moment = require("moment-timezone"); +const converter = require("json-2-csv"); +const logger = require("../utils/logger"); +const queries = require("../graphql-client/queries"); + +exports.default = async (req, res) => { + try { + logger.log("usage-report-email-start", "debug", req?.user?.email, null, {}); + if (process.env.NODE_ENV !== "production") { + res.sendStatus(403); + return; + } + // Only process if the appropriate token is provided. + if (req.headers["x-imex-auth"] !== process.env.AUTOHOUSE_AUTH_TOKEN) { + res.sendStatus(401); + logger.log("usage-report-email-forbidden", "warn", req?.user?.email, null, {}); + return; + } + + //Query the elements. + const queryResults = await client.request(queries.STATUS_UPDATE, { + today: moment().startOf("day").subtract(3, "days"), + period: moment().subtract(90, "days").startOf("day") + }); + + //Massage the data. + const shopList = []; + queryResults.bodyshops.forEach((shop) => { + shopList.push({ + "Shop Name": shop.shopname, + "Days Since Creation": moment().diff(moment(shop.created_at), "days"), + "Jobs Created": shop.jobs_created.aggregate.count, + "Jobs Updated": shop.jobs_updated.aggregate.count, + "Owners Created": shop.owners_created.aggregate.count, + "Owners Updated": shop.owners_updated.aggregate.count, + "Vehicles Created": shop.vehicles_created.aggregate.count, + "Vehicles Updated": shop.vehicles_updated.aggregate.count, + "Tasks Created": shop.tasks_created.aggregate.count, + "Tasks Updated": shop.tasks_updated.aggregate.count + }); + }); + + const csv = converter.json2csv(shopList, { emptyFieldValue: "" }); + emailer + .sendTaskEmail({ + to: ["patrick.fic@convenient-brands.com"], + subject: `RO Usage Report - ${moment().format("MM/DD/YYYY")}`, + text: ` +Usage Report for ${moment().format("MM/DD/YYYY")} for Rome Online Customers. + +Notes: + - Days Since Creation: The number of days since the shop was created. Only shops created in the last 90 days are included. + - Updated values should be higher than created values. + - Counts are inclusive of the last 3 days of data. + `, + attachments: [{ filename: `RO Usage Report ${moment().format("MM/DD/YYYY")}.csv`, content: csv }] + }) + .then(() => { + logger.log("usage-report-email-success", "debug", req?.user?.email, null, { + csv + }); + }) + .catch((error) => { + logger.log("usage-report-email-send-error", "ERROR", req?.user?.email, null, { + error: error.message, + stack: error.stack + }); + }); + + return res.sendStatus(200); + } catch (error) { + logger.log("usage-report-email-error", "ERROR", req?.user?.email, null, { + error: error.message, + stack: error.stack + }); + res.status(500).json({ error: error.message, stack: error.stack }); + } +}; diff --git a/server/graphql-client/queries.js b/server/graphql-client/queries.js index d585a4255..e0a1a4981 100644 --- a/server/graphql-client/queries.js +++ b/server/graphql-client/queries.js @@ -2617,3 +2617,76 @@ exports.CREATE_CONVERSATION = `mutation CREATE_CONVERSATION($conversation: [conv } } `; + + +exports.STATUS_UPDATE = `query STATUS_UPDATE($period: timestamptz!, $today: timestamptz!) { + bodyshops(where: { created_at: { _gte: $period } }) { + shopname + id + created_at + jobs_created: jobs_aggregate(where: { created_at: { _gte: $today } }) { + aggregate { + count + } + } + jobs_updated: jobs_aggregate(where: { updated_at: { _gte: $today } }) { + aggregate { + count + } + } + + owners_created: owners_aggregate(where: { created_at: { _gte: $today } }) { + aggregate { + count + } + } + owners_updated: owners_aggregate(where: { updated_at: { _gte: $today } }) { + aggregate { + count + } + } + + vehicles_created: vehicles_aggregate( + where: { created_at: { _gte: $today } } + ) { + aggregate { + count + } + } + vehicles_updated: vehicles_aggregate( + where: { updated_at: { _gte: $today } } + ) { + aggregate { + count + } + } + + tasks_created: tasks_aggregate(where: { created_at: { _gte: $today } }) { + aggregate { + count + } + } + tasks_updated: tasks_aggregate(where: { updated_at: { _gte: $today } }) { + aggregate { + count + } + } + jobs { + parts_orders_created: parts_orders_aggregate( + where: { created_at: { _gte: $today } } + ) { + aggregate { + count + } + } + parts_orders_updated: parts_orders_aggregate( + where: { updated_at: { _gte: $today } } + ) { + aggregate { + count + } + } + } + } +} +` \ No newline at end of file diff --git a/server/routes/dataRoutes.js b/server/routes/dataRoutes.js index a12563282..788574074 100644 --- a/server/routes/dataRoutes.js +++ b/server/routes/dataRoutes.js @@ -1,10 +1,11 @@ const express = require("express"); const router = express.Router(); -const { autohouse, claimscorp, chatter, kaizen } = require("../data/data"); +const { autohouse, claimscorp, chatter, kaizen, usageReport } = require("../data/data"); router.post("/ah", autohouse); router.post("/cc", claimscorp); router.post("/chatter", chatter); router.post("/kaizen", kaizen); +router.post("/usagereport", usageReport); module.exports = router; diff --git a/server/tasks/tasks.js b/server/tasks/tasks.js index 2ae944e60..f823d13c9 100644 --- a/server/tasks/tasks.js +++ b/server/tasks/tasks.js @@ -41,7 +41,7 @@ exports.taskHandler = async (req, res) => { return res.status(200).send(csv); } catch (error) { - res.status(500).json({ error: error.message, stack: error.stackTrace }); + res.status(500).json({ error: error.message, stack: error.stack }); } }; From 2f267a9f2cb9eda3aedd797fb876a50523b5352a Mon Sep 17 00:00:00 2001 From: Patrick Fic Date: Fri, 10 Jan 2025 11:39:18 -0800 Subject: [PATCH 2/2] IO-3076 updates to usage report. --- server/data/usageReport.js | 46 +++++++++++++++++++++----------------- 1 file changed, 26 insertions(+), 20 deletions(-) diff --git a/server/data/usageReport.js b/server/data/usageReport.js index 6c3734826..dd7bb4d42 100644 --- a/server/data/usageReport.js +++ b/server/data/usageReport.js @@ -8,48 +8,54 @@ const moment = require("moment-timezone"); const converter = require("json-2-csv"); const logger = require("../utils/logger"); const queries = require("../graphql-client/queries"); +const InstanceMgr = require("../utils/instanceMgr").default; exports.default = async (req, res) => { try { logger.log("usage-report-email-start", "debug", req?.user?.email, null, {}); + + if (InstanceMgr({ rome: false, imex: true })) { + //Disable for ImEX at the moment. + res.sendStatus(403); + logger.log("usage-report-email-forbidden", "warn", req?.user?.email, null, {}); + return; + } + if (process.env.NODE_ENV !== "production") { res.sendStatus(403); return; } - // Only process if the appropriate token is provided. + // Validate using autohouse token header. if (req.headers["x-imex-auth"] !== process.env.AUTOHOUSE_AUTH_TOKEN) { res.sendStatus(401); logger.log("usage-report-email-forbidden", "warn", req?.user?.email, null, {}); return; } - //Query the elements. + //Query the usage data. const queryResults = await client.request(queries.STATUS_UPDATE, { today: moment().startOf("day").subtract(3, "days"), period: moment().subtract(90, "days").startOf("day") }); //Massage the data. - const shopList = []; - queryResults.bodyshops.forEach((shop) => { - shopList.push({ - "Shop Name": shop.shopname, - "Days Since Creation": moment().diff(moment(shop.created_at), "days"), - "Jobs Created": shop.jobs_created.aggregate.count, - "Jobs Updated": shop.jobs_updated.aggregate.count, - "Owners Created": shop.owners_created.aggregate.count, - "Owners Updated": shop.owners_updated.aggregate.count, - "Vehicles Created": shop.vehicles_created.aggregate.count, - "Vehicles Updated": shop.vehicles_updated.aggregate.count, - "Tasks Created": shop.tasks_created.aggregate.count, - "Tasks Updated": shop.tasks_updated.aggregate.count - }); - }); + const shopList = queryResults.bodyshops.map((shop) => ({ + "Shop Name": shop.shopname, + "Days Since Creation": moment().diff(moment(shop.created_at), "days"), + "Jobs Created": shop.jobs_created.aggregate.count, + "Jobs Updated": shop.jobs_updated.aggregate.count, + "Owners Created": shop.owners_created.aggregate.count, + "Owners Updated": shop.owners_updated.aggregate.count, + "Vehicles Created": shop.vehicles_created.aggregate.count, + "Vehicles Updated": shop.vehicles_updated.aggregate.count, + "Tasks Created": shop.tasks_created.aggregate.count, + "Tasks Updated": shop.tasks_updated.aggregate.count + })); const csv = converter.json2csv(shopList, { emptyFieldValue: "" }); emailer .sendTaskEmail({ - to: ["patrick.fic@convenient-brands.com"], + to: ["patrick.fic@convenient-brands.com", "bradley.rhoades@convenient-brands.com"], subject: `RO Usage Report - ${moment().format("MM/DD/YYYY")}`, text: ` Usage Report for ${moment().format("MM/DD/YYYY")} for Rome Online Customers. @@ -72,8 +78,8 @@ Notes: stack: error.stack }); }); - - return res.sendStatus(200); + res.sendStatus(200); + return; } catch (error) { logger.log("usage-report-email-error", "ERROR", req?.user?.email, null, { error: error.message,