From a87eb1608d354a6e9c8170e0fdc432a5f556c445 Mon Sep 17 00:00:00 2001
From: Kevin J Hoerr <kjhoerr@protonmail.com>
Date: Mon, 4 Apr 2022 01:13:14 +0000
Subject: Refactor dependency on env and add comments

---
 src/routes.ts | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

(limited to 'src/routes.ts')

diff --git a/src/routes.ts b/src/routes.ts
index a8360ca..0998345 100644
--- a/src/routes.ts
+++ b/src/routes.ts
@@ -9,11 +9,16 @@ import Metadata, { HeadIdentity, isError } from "./metadata";
 import loggerConfig from "./util/logger";
 import { InvalidReportDocumentError, Messages } from "./errors";
 
-const logger = winston.createLogger(loggerConfig("HTTP"));
-
-export default (metadata: Metadata): Router => {
+/** 
+ * Provide routes from application state
+ */
+const routes = (metadata: Metadata): Router => {
   const router = Router();
+  const logger = winston.createLogger(loggerConfig("HTTP", metadata.logger.level));
 
+  /**
+   * Persist uploaded coverage report and creates coverage badge
+   */
   const commitFormatDocs = async (
     contents: string,
     identity: HeadIdentity,
@@ -138,6 +143,9 @@ export default (metadata: Metadata): Router => {
     });
   });
 
+  /**
+   * Read a file from the host directory.
+   */
   const retrieveFile = (
     res: express.Response,
     identity: HeadIdentity,
@@ -238,6 +246,7 @@ export default (metadata: Metadata): Router => {
     retrieveFile(res, identity, format.fileName);
   });
 
+  // provide hard link for commit
   router.get("/v1/:org/:repo/:branch/:commit.xml", (req, res) => {
     const { org, repo, branch, commit } = req.params;
     const format = formats.formats.cobertura;
@@ -250,6 +259,7 @@ export default (metadata: Metadata): Router => {
     retrieveFile(res, identity, format.fileName);
   });
 
+  // return 404 for all other routes
   router.use((_, res) => {
     res.status(404);
     res.sendFile(path.join(metadata.getPublicDir(), "static", "404.html"));
@@ -257,3 +267,5 @@ export default (metadata: Metadata): Router => {
 
   return router;
 };
+
+export default routes;
-- 
cgit