Skip to content

Commit

Permalink
Merge pull request #509 from USEPA/feature/update-error-logging-and-4…
Browse files Browse the repository at this point in the history 
…01-checks

Feature/update error logging and 401 checks
  • Loading branch information
@courtneymyers
courtneymyers authored Nov 27, 2024
2 parents fa7b666 + 38a9fbf commit 9534991
Show file tree
Hide file tree
Showing 7 changed files with 202 additions and 69 deletions.
4 changes: 2 additions & 2 deletions app/server/app/middleware.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ function checkClientRouteExists(req, res, next) {
* @param {express.Response} res
* @param {express.NextFunction} next
*/
function storeBapComboKeys(req, res, next) {
function fetchBapComboKeys(req, res, next) {
const { mail } = req.user;

getBapComboKeys(req, mail)
Expand Down Expand Up @@ -230,6 +230,6 @@ module.exports = {
ensureHelpdesk,
protectClientRoutes,
checkClientRouteExists,
storeBapComboKeys,
fetchBapComboKeys,
verifyMongoObjectId,
};
43 changes: 33 additions & 10 deletions app/server/app/routes/bap.js
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
const express = require("express");
// ---
const { ensureAuthenticated, storeBapComboKeys } = require("../middleware");
const { ensureAuthenticated, fetchBapComboKeys } = require("../middleware");
const {
// checkForBapDuplicates,
getSamEntities,
getBapFormSubmissionsStatuses,
} = require("../utilities/bap");
const { checkUserData } = require("../utilities/user");
const log = require("../utilities/logger");

const router = express.Router();
Expand All @@ -26,10 +27,9 @@ router.use(ensureAuthenticated);

// --- get user's SAM.gov data from the BAP
router.get("/sam", (req, res) => {
const { mail, memberof } = req.user;
const userRoles = memberof.split(",");
const adminOrHelpdeskUser =
userRoles.includes("csb_admin") || userRoles.includes("csb_helpdesk");
const { mail } = req.user;

const { adminOrHelpdeskUser } = checkUserData({ req });

if (!mail) {
const logMessage = `User with no email address attempted to fetch SAM.gov records.`;
Expand Down Expand Up @@ -64,22 +64,45 @@ router.get("/sam", (req, res) => {
entities,
});
})
.catch((_error) => {
// NOTE: logged in bap verifyBapConnection
.catch((error) => {
const errorStatus = 500;
const errorMessage = `Error getting SAM.gov data from the BAP.`;

log({ level: "error", message: errorMessage, req, otherInfo: error });

return res.status(errorStatus).json({ message: errorMessage });
});
});

// --- get user's form submissions statuses from the BAP
router.get("/submissions", storeBapComboKeys, (req, res) => {
router.get("/submissions", fetchBapComboKeys, (req, res) => {
const { mail } = req.user;

const { adminOrHelpdeskUser, noBapComboKeys } = checkUserData({ req });

if (noBapComboKeys) {
if (adminOrHelpdeskUser) {
return res.json([]);
}

const logMessage =
`User with email '${mail}' attempted to fetch form submissions ` +
`from the BAP without any SAM.gov combo keys.`;
log({ level: "error", message: logMessage, req });

const errorStatus = 401;
const errorMessage = `Unauthorized.`;
return res.status(errorStatus).json({ message: errorMessage });
}

return getBapFormSubmissionsStatuses(req)
.then((submissions) => res.json(submissions))
.catch((_error) => {
// NOTE: logged in bap verifyBapConnection
.catch((error) => {
const errorStatus = 500;
const errorMessage = `Error getting form submissions statuses from the BAP.`;

log({ level: "error", message: errorMessage, req, otherInfo: error });

return res.status(errorStatus).json({ message: errorMessage });
});
});
Expand Down
32 changes: 16 additions & 16 deletions app/server/app/routes/formio2022.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ const express = require("express");
// ---
const {
ensureAuthenticated,
storeBapComboKeys,
fetchBapComboKeys,
verifyMongoObjectId,
} = require("../middleware");
const {
Expand Down Expand Up @@ -34,7 +34,7 @@ router.use(ensureAuthenticated);
// --- download Formio S3 file metadata
router.get(
"/s3/:formType/:mongoId/:comboKey/storage/s3",
storeBapComboKeys,
fetchBapComboKeys,
(req, res) => {
downloadS3FileMetadata({ rebateYear, req, res });
},
Expand All @@ -43,27 +43,27 @@ router.get(
// --- upload Formio S3 file metadata
router.post(
"/s3/:formType/:mongoId/:comboKey/storage/s3",
storeBapComboKeys,
fetchBapComboKeys,
(req, res) => {
uploadS3FileMetadata({ rebateYear, req, res });
},
);

// --- get user's 2022 FRF submissions from Formio
router.get("/frf-submissions", storeBapComboKeys, (req, res) => {
router.get("/frf-submissions", fetchBapComboKeys, (req, res) => {
fetchFRFSubmissions({ rebateYear, req, res });
});

// --- post a new 2022 FRF submission to Formio
router.post("/frf-submission", storeBapComboKeys, (req, res) => {
router.post("/frf-submission", fetchBapComboKeys, (req, res) => {
createFRFSubmission({ rebateYear, req, res });
});

// --- get an existing 2022 FRF's schema and submission data from Formio
router.get(
"/frf-submission/:mongoId",
verifyMongoObjectId,
storeBapComboKeys,
fetchBapComboKeys,
(req, res) => {
fetchFRFSubmission({ rebateYear, req, res });
},
Expand All @@ -73,54 +73,54 @@ router.get(
router.post(
"/frf-submission/:mongoId",
verifyMongoObjectId,
storeBapComboKeys,
fetchBapComboKeys,
(req, res) => {
updateFRFSubmission({ rebateYear, req, res });
},
);

// --- get user's 2022 PRF submissions from Formio
router.get("/prf-submissions", storeBapComboKeys, (req, res) => {
router.get("/prf-submissions", fetchBapComboKeys, (req, res) => {
fetchPRFSubmissions({ rebateYear, req, res });
});

// --- post a new 2022 PRF submission to Formio
router.post("/prf-submission", storeBapComboKeys, (req, res) => {
router.post("/prf-submission", fetchBapComboKeys, (req, res) => {
createPRFSubmission({ rebateYear, req, res });
});

// --- get an existing 2022 PRF's schema and submission data from Formio
router.get("/prf-submission/:rebateId", storeBapComboKeys, (req, res) => {
router.get("/prf-submission/:rebateId", fetchBapComboKeys, (req, res) => {
fetchPRFSubmission({ rebateYear, req, res });
});

// --- post an update to an existing draft 2022 PRF submission to Formio
router.post("/prf-submission/:rebateId", storeBapComboKeys, (req, res) => {
router.post("/prf-submission/:rebateId", fetchBapComboKeys, (req, res) => {
updatePRFSubmission({ rebateYear, req, res });
});

// --- delete an existing 2022 PRF submission from Formio
router.post("/delete-prf-submission", storeBapComboKeys, (req, res) => {
router.post("/delete-prf-submission", fetchBapComboKeys, (req, res) => {
deletePRFSubmission({ rebateYear, req, res });
});

// --- get user's 2022 CRF submissions from Formio
router.get("/crf-submissions", storeBapComboKeys, (req, res) => {
router.get("/crf-submissions", fetchBapComboKeys, (req, res) => {
fetchCRFSubmissions({ rebateYear, req, res });
});

// --- post a new 2022 CRF submission to Formio
router.post("/crf-submission", storeBapComboKeys, (req, res) => {
router.post("/crf-submission", fetchBapComboKeys, (req, res) => {
createCRFSubmission({ rebateYear, req, res });
});

// --- get an existing 2022 CRF's schema and submission data from Formio
router.get("/crf-submission/:rebateId", storeBapComboKeys, (req, res) => {
router.get("/crf-submission/:rebateId", fetchBapComboKeys, (req, res) => {
fetchCRFSubmission({ rebateYear, req, res });
});

// --- post an update to an existing draft 2022 CRF submission to Formio
router.post("/crf-submission/:rebateId", storeBapComboKeys, (req, res) => {
router.post("/crf-submission/:rebateId", fetchBapComboKeys, (req, res) => {
updateCRFSubmission({ rebateYear, req, res });
});

Expand Down
40 changes: 20 additions & 20 deletions app/server/app/routes/formio2023.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ const express = require("express");
// ---
const {
ensureAuthenticated,
storeBapComboKeys,
fetchBapComboKeys,
verifyMongoObjectId,
} = require("../middleware");
const {
Expand Down Expand Up @@ -46,7 +46,7 @@ router.get("/nces/:searchText?", (req, res) => {
// --- download Formio S3 file metadata
router.get(
"/s3/:formType/:mongoId/:comboKey/storage/s3",
storeBapComboKeys,
fetchBapComboKeys,
(req, res) => {
downloadS3FileMetadata({ rebateYear, req, res });
},
Expand All @@ -55,27 +55,27 @@ router.get(
// --- upload Formio S3 file metadata
router.post(
"/s3/:formType/:mongoId/:comboKey/storage/s3",
storeBapComboKeys,
fetchBapComboKeys,
(req, res) => {
uploadS3FileMetadata({ rebateYear, req, res });
},
);

// --- get user's 2023 FRF submissions from Formio
router.get("/frf-submissions", storeBapComboKeys, (req, res) => {
router.get("/frf-submissions", fetchBapComboKeys, (req, res) => {
fetchFRFSubmissions({ rebateYear, req, res });
});

// --- post a new 2023 FRF submission to Formio
router.post("/frf-submission", storeBapComboKeys, (req, res) => {
router.post("/frf-submission", fetchBapComboKeys, (req, res) => {
createFRFSubmission({ rebateYear, req, res });
});

// --- get an existing 2023 FRF's schema and submission data from Formio
router.get(
"/frf-submission/:mongoId",
verifyMongoObjectId,
storeBapComboKeys,
fetchBapComboKeys,
(req, res) => {
fetchFRFSubmission({ rebateYear, req, res });
},
Expand All @@ -85,74 +85,74 @@ router.get(
router.post(
"/frf-submission/:mongoId",
verifyMongoObjectId,
storeBapComboKeys,
fetchBapComboKeys,
(req, res) => {
updateFRFSubmission({ rebateYear, req, res });
},
);

// --- get user's 2023 PRF submissions from Formio
router.get("/prf-submissions", storeBapComboKeys, (req, res) => {
router.get("/prf-submissions", fetchBapComboKeys, (req, res) => {
fetchPRFSubmissions({ rebateYear, req, res });
});

// --- post a new 2023 PRF submission to Formio
router.post("/prf-submission", storeBapComboKeys, (req, res) => {
router.post("/prf-submission", fetchBapComboKeys, (req, res) => {
createPRFSubmission({ rebateYear, req, res });
});

// --- get an existing 2023 PRF's schema and submission data from Formio
router.get("/prf-submission/:rebateId", storeBapComboKeys, (req, res) => {
router.get("/prf-submission/:rebateId", fetchBapComboKeys, (req, res) => {
fetchPRFSubmission({ rebateYear, req, res });
});

// --- post an update to an existing draft 2023 PRF submission to Formio
router.post("/prf-submission/:rebateId", storeBapComboKeys, (req, res) => {
router.post("/prf-submission/:rebateId", fetchBapComboKeys, (req, res) => {
updatePRFSubmission({ rebateYear, req, res });
});

// --- delete an existing 2023 PRF submission from Formio
router.post("/delete-prf-submission", storeBapComboKeys, (req, res) => {
router.post("/delete-prf-submission", fetchBapComboKeys, (req, res) => {
deletePRFSubmission({ rebateYear, req, res });
});

// --- get user's 2023 CRF submissions from Formio
router.get("/crf-submissions", storeBapComboKeys, (req, res) => {
router.get("/crf-submissions", fetchBapComboKeys, (req, res) => {
res.json([]); // TODO: replace with `fetchCRFSubmissions({ rebateYear, req, res })` when CRF is ready
});

// --- post a new 2023 CRF submission to Formio
// router.post("/crf-submission", storeBapComboKeys, (req, res) => {
// router.post("/crf-submission", fetchBapComboKeys, (req, res) => {
// createCRFSubmission({ rebateYear, req, res });
// });

// --- get an existing 2023 CRF's schema and submission data from Formio
// router.get("/crf-submission/:rebateId", storeBapComboKeys, (req, res) => {
// router.get("/crf-submission/:rebateId", fetchBapComboKeys, (req, res) => {
// fetchCRFSubmission({ rebateYear, req, res });
// });

// --- post an update to an existing draft 2023 CRF submission to Formio
// router.post("/crf-submission/:rebateId", storeBapComboKeys, (req, res) => {
// router.post("/crf-submission/:rebateId", fetchBapComboKeys, (req, res) => {
// updateCRFSubmission({ rebateYear, req, res });
// });

// --- get user's 2023 Change Request form submissions from Formio
router.get("/changes", storeBapComboKeys, (req, res) => {
router.get("/changes", fetchBapComboKeys, (req, res) => {
fetchChangeRequests({ rebateYear, req, res });
});

// --- get the 2023 Change Request form's schema from Formio
router.get("/change", storeBapComboKeys, (req, res) => {
router.get("/change", fetchBapComboKeys, (req, res) => {
fetchChangeRequestSchema({ rebateYear, req, res });
});

// --- post a new 2023 Change Request form submission to Formio
router.post("/change", storeBapComboKeys, (req, res) => {
router.post("/change", fetchBapComboKeys, (req, res) => {
createChangeRequest({ rebateYear, req, res });
});

// --- get an existing 2023 Change Request form's schema and submission data from Formio
router.get("/change/:mongoId", storeBapComboKeys, (req, res) => {
router.get("/change/:mongoId", fetchBapComboKeys, (req, res) => {
fetchChangeRequest({ rebateYear, req, res });
});

Expand Down
Loading

0 comments on commit 9534991

Please sign in to comment.