refactor(http): clean code - split controllers / middleware (#90)

* chore(http): use http-server folder

* chore(http): move root route

* test(http): add first test

* chore: add updated package.json

* chore(http): finish root tests

* chore: create context (AsyncLocalStorage)

* feat(http): split data endpoint

* chore(http): port middleware in split file

* chore(http): remove useless spec test

* chore(http): fix naming for root import

* chore(http): add flags

* revert: remove sinon deps

* chore: add missing import comment

Author: tony-go

src/commands/http.js

@@ -2,7 +2,7 @@
 import path from "path";
 
 // Import Internal Dependencies
-import { buildServer } from "../httpServer.js";
+import { buildServer } from "../http-server/index.js";
 
 export async function start(json = "nsecure-result.json", options = {}) {
   const port = Number(options.port);

src/http-server/context.js

@@ -0,0 +1,3 @@
+import { AsyncLocalStorage } from "async_hooks";
+
+export const context = new AsyncLocalStorage();

src/http-server/data.js

@@ -0,0 +1,18 @@
+// Import Node.js Dependencies
+import fs from "fs";
+import { pipeline } from "stream";
+
+// Import Internal Dependencies
+import { context } from "./context.js";
+
+export async function get(req, res) {
+  const { dataFilePath } = context.getStore();
+
+  res.writeHead(200, { "Content-Type": "application/json" });
+
+  pipeline(fs.createReadStream(dataFilePath), res, (err) => {
+    if (err) {
+      console.error(err);
+    }
+  });
+}

src/http-server/flags.js

@@ -0,0 +1,27 @@
+// Import Node.Js Dependencies
+import { pipeline } from "stream";
+
+// Import Third-party Dependencies
+import send from "@polka/send-type";
+import { getManifest, lazyFetchFlagFile, getFlags } from "@nodesecure/flags";
+
+// CONSTANTS
+const kNodeSecureFlags = getFlags();
+
+export function getAll(req, res) {
+  send(res, 200, getManifest());
+}
+
+export function get(req, res) {
+  if (req.params.title !== "isDuplicate" && !kNodeSecureFlags.has(req.params.title)) {
+    return send(res, 404, { error: "Not Found" });
+  }
+
+  res.writeHead(200, { "Content-Type": "text/html" });
+
+  return pipeline(lazyFetchFlagFile(req.params.title), res, (err) => {
+    if (err) {
+      console.error(err);
+    }
+  });
+}

src/http-server/index.js

@@ -0,0 +1,43 @@
+/* eslint-disable no-sync */
+
+// Import Node.js Dependencies
+import fs from "fs";
+
+// Import Third-party Dependencies
+import kleur from "kleur";
+import polka from "polka";
+import open from "open";
+import * as i18n from "@nodesecure/i18n";
+
+// Import Internal Dependencies
+import * as root from "./root.js";
+import * as data from "./data.js";
+import * as flags from "./flags.js";
+import * as middleware from "./middleware.js";
+
+export function buildServer(dataFilePath, options = {}) {
+  const httpConfigPort = typeof options.port === "number" ? options.port : 0;
+  const openLink = typeof options.openLink === "boolean" ? options.openLink : true;
+
+  fs.accessSync(dataFilePath, fs.constants.R_OK | fs.constants.W_OK);
+
+  const httpServer = polka();
+
+  httpServer.use(middleware.buildContextMiddleware(dataFilePath));
+  httpServer.use(middleware.addStaticFiles);
+  httpServer.get("/", root.get);
+  httpServer.get("/data", data.get);
+  httpServer.get("/flags", flags.getAll);
+  httpServer.get("/flags/description/:title", flags.get);
+
+  httpServer.listen(httpConfigPort, () => {
+    const link = `http://localhost:${httpServer.server.address().port}`;
+    console.log(kleur.magenta().bold(i18n.getToken("cli.http_server_started")), kleur.cyan().bold(link));
+
+    if (openLink) {
+      open(link);
+    }
+  });
+
+  return httpServer;
+}

src/http-server/middleware.js

@@ -0,0 +1,21 @@
+// Import Node.js Dependencies
+import { join, dirname } from "path";
+import { fileURLToPath } from "url";
+
+// Import Third-party Dependencies
+import sirv from "sirv";
+
+// Import Internal Dependencies
+import { context } from "./context.js";
+
+export function buildContextMiddleware(dataFilePath) {
+  return function addContext(req, res, next) {
+    const store = { dataFilePath };
+    context.run(store, next);
+  };
+}
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const kProjectRootDir = join(__dirname, "..", "..");
+
+export const addStaticFiles = sirv(join(kProjectRootDir, "dist"), { dev: true });

src/http-server/root.js

@@ -0,0 +1,37 @@
+// Import Node.js Dependencies
+import { join, dirname } from "path";
+import { readFile } from "fs/promises";
+import { fileURLToPath } from "url";
+
+// Import Third-party Dependencies
+import zup from "zup";
+import send from "@polka/send-type";
+import * as i18n from "@nodesecure/i18n";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const kProjectRootDir = join(__dirname, "..", "..");
+
+export async function buildHtml() {
+  const HTMLStr = await readFile(join(kProjectRootDir, "views", "index.html"), "utf-8");
+  const templateStr = zup(HTMLStr)({
+    lang: i18n.getToken("lang"),
+    token: (tokenName) => i18n.getToken(`ui.${tokenName}`)
+  });
+
+  return templateStr;
+}
+
+export async function get(req, res) {
+  try {
+    res.writeHead(200, {
+      "Content-Type": "text/html"
+    });
+
+    const templateStr = await buildHtml();
+
+    res.end(templateStr);
+  }
+  catch (err) {
+    send(res, 500, { error: err.message });
+  }
+}

src/httpServer.js

@@ -11,7 +11,7 @@ import * as i18n from "@nodesecure/i18n";
 import * as flags from "@nodesecure/flags";
 
 // Require Internal Dependencies
-import { buildServer } from "../src/httpServer.js";
+import { buildServer } from "../src/http-server/index.js";
 
 // CONSTANTS
 const HTTP_PORT = 1337;