[download-microservice] Refactor: Clarify Execution, make bin finding clearer

microservices/download/bins.js

@@ -0,0 +1,88 @@
+// A module that defines the way we locate a specific binary file amid all possible
+// Pulsar Rolling Release binaries.
+// In order to do this the following keys are available:
+//  - startsWith: Checks if the version string startsWith the value
+//  - endsWith: Checks if the version string endsWith the value
+//  - endsWithNot: Checks if the version string does not end with the value
+
+module.exports = {
+  windows: {
+    windows_setup: {
+      startsWith: "Pulsar.Setup",
+      endsWith: ".exe"
+    },
+    windows_portable: {
+      endsWith: "-win.zip"
+    },
+    windows_blockmap: {
+      startsWith: "Pulsar.Setup",
+      endsWith: ".exe.blockmap"
+    }
+  },
+
+  silicon_mac: {
+    mac_zip: {
+      endsWith: "-arm64-mac.zip"
+    },
+    mac_zip_blockmap: {
+      endsWith: "-arm64-mac.zip.blockmap"
+    },
+    mac_dmg: {
+      endsWith: "-arm64.dmg"
+    },
+    mac_dmg_blockmap: {
+      endsWith: "-arm64.dmg.blockmap"
+    }
+  },
+
+  intel_mac: {
+    mac_zip: {
+      endsWith: "-mac.zip",
+      endsWithNot: "-arm64-mac.zip"
+    },
+    mac_zip_blockmap: {
+      endsWith: "-mac.zip.blockmap",
+      endsWithNot: "-arm64-mac.zip.blockmap"
+    },
+    mac_dmg: {
+      endsWith: ".dmg",
+      endsWithNot: "-arm64.dmg"
+    },
+    mac_dmg_blockmap: {
+      endsWith: ".dmg.blockmap",
+      endsWithNot: "-arm64.dmg.blockmap"
+    }
+  },
+
+  arm_linux: {
+    linux_appimage: {
+      endsWith: "-arm64.AppImage"
+    },
+    linux_tar: {
+      endsWith: "-arm64.tar.gz"
+    },
+    linux_rpm: {
+      endsWith: ".aarch64.rpm"
+    },
+    linux_deb: {
+      endsWith: "_arm64.deb"
+    }
+  },
+
+  linux: {
+    linux_appimage: {
+      endsWith: ".AppImage",
+      endsWithNot: "-arm64.AppImage"
+    },
+    linux_tar: {
+      endsWith: ".tar.gz",
+      endsWithNot: "-arm64.tar.gz"
+    },
+    linux_rpm: {
+      endsWith: ".x86_64.rpm"
+    },
+    linux_deb: {
+      endsWith: "_amd64.deb"
+    }
+  }
+};

microservices/download/index.js

@@ -3,26 +3,59 @@ const utils = require("./utils.js");
 const port = parseInt(process.env.PORT) || 8080;
 
 const server = http.createServer(async (req, res) => {
-  // Since req.url is our URL pluse query params, lets split them first.
-  const path = req.url.split("?");
+  if (typeof req?.url !== "string"){
+    // Not sure if this error condition is even possible, but handling it anyway
+    await utils.displayError(req, res, {
+      code: 500,
+      msg: "Internal Server Error: Misformed URL"
+    });
+    console.log("Download Returned 500 due to the requested URL not being received as a string internally");
+    return;
+  }
+
+  // Since req.url is our URL plus query params, lets split them first.
+  const url = req.url.split("?");
+  const path = url[0];
+  const queryParams = url[1];
+
   // Set our Request Route
-  if (path[0] === "/" && req.method === "GET") {
+  if (path === "/" && req.method === "GET") {
+
+    if (typeof queryParams !== "string"){
+      await utils.displayError(req, res, {
+        code: 400,
+        msg: "Missing Query Parameters"
+      });
+      console.log("Download Returned 400 due to the requested URL having no query parameters");
+      return;
+    }
+
+    if (queryParams.length > 100){
+      // Longest valid combo is 36 characters ("os=silicon_mac&type=mac_zip_blockmap"),
+      // But leaving extra room to update the parameters in the future.
+      await utils.displayError(req, res, {
+        code: 414,
+        msg: "Requested Parameters are Too Long"
+      });
+      console.log("Download Returned 414 due to the provided parameters being too long");
+      return;
+    }
 
-    let params = {
-      os: utils.query_os(path[1]),
-      type: utils.query_type(path[1])
+    let validatedParams = {
+      os: utils.query_os(queryParams),
+      type: utils.query_type(queryParams)
     };
 
-    if (!params.os || !params.type) {
+    if (!validatedParams.os || !validatedParams.type) {
       await utils.displayError(req, res, {
-        code: 503,
-        msg: "Missing Required Download Parameters"
+        code: 400,
+        msg: "Required Download Parameters Missing or Invalid"
       });
-      console.log("Download Returned 503 due to missing os or type");
+      console.log("Download Returned 400 due to missing or invalid os or type");
       return;
     }
 
-    let redirLink = await utils.findLink(params.os, params.type);
+    let redirLink = await utils.findLink(validatedParams.os, validatedParams.type);
 
     if (!redirLink.ok) {
       await utils.displayError(req, res, redirLink);
@@ -34,7 +67,7 @@ const server = http.createServer(async (req, res) => {
       Location: redirLink.content
     }).end();
 
-    console.log(`Download Returned: OS: ${params.os} - TYPE: ${params.type} - URL: ${redirLink.content}`);
+    console.log(`Download Returned: OS: ${validatedParams.os} - TYPE: ${validatedParams.type} - URL: ${redirLink.content}`);
 
 
   } else {