miqro 6.0.12 → 6.0.14

package/src/bin/generate-doc.ts

@@ -16,28 +16,31 @@ export async function generateDocs(args: Arguments, logger: Logger, result: Infl
   const fileMapAPIRouteList = Object.keys(fileMap).map(f => fileMap[f]).filter(fMap => fMap.previewMethod === "api").map(fMap => fMap.routes);
 
   const jsonDoc = router.getJSONDoc();
-  Object.keys(jsonDoc).forEach(path => {
-    const methods = Object.keys(jsonDoc[path]);
-    methods.forEach(method => {
-      const data = jsonDoc[path][method];
-      //console.log("[%s] [%s]", path, method);
-
-      if (fileMapAPIRouteList.filter(f => {
-        for (const r of f) {
-          if (r.method === String(method).toUpperCase() && r.path === path) {
-            return true;
+
+  if (!args.generateDocAll) {
+    Object.keys(jsonDoc).forEach(path => {
+      const methods = Object.keys(jsonDoc[path]);
+      methods.forEach(method => {
+        const data = jsonDoc[path][method];
+        //console.log("[%s] [%s]", path, method);
+
+        if (fileMapAPIRouteList.filter(f => {
+          for (const r of f) {
+            if (r.method === String(method).toUpperCase() && r.path === path) {
+              return true;
+            }
           }
+          return false;
+        }).length === 0) {
+          //console.log("DELETE [%s] [%s]", path, method);
+          delete jsonDoc[path][method];
+        } else {
+          //console.log("KEEP [%s] [%s]", path, method);
         }
-        return false;
-      }).length === 0) {
-        //console.log("DELETE [%s] [%s]", path, method);
-        delete jsonDoc[path][method];
-      } else {
-        //console.log("KEEP [%s] [%s]", path, method);
-      }
 
+      });
     });
-  });
+  }
 
   switch (args.generateDocType) {
     case "JSON":

package/src/cluster.ts

@@ -5,17 +5,21 @@ import { dirname, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
 import { execSync } from "node:child_process";
 import { parseArguments } from "./common/arguments.js";
+import { checkEnvVariable } from "@miqro/core";
+import { cpus } from "node:os";
 
 const __package_dirname = import.meta.url ? resolve(dirname(fileURLToPath(import.meta.url))) : null;
 
 //const usage = "CLUSTER_COUNT=os.cpus().length [CLUSTER_AUTO_BROADCAST=true|false] [CLUSTER_DISABLE_RESTART=true|false]";
 
+const CLUSTER_COUNT = checkEnvVariable("CLUSTER_COUNT", String(cpus().length));
+
 const args = parseArguments();
 
 if (args.inflate || args.test || args.compile || args.installTSConfig || args.installTypes || args.migrateDown || args.migrateUp) {
   await import("./main.js");
 } else {
-  const CMD = `CLUSTER_AUTO_BROADCAST=true ${process.argv[0]} ${mainPath()} ${resolve(__package_dirname, "main.js")} ${process.argv.slice(2).join(" ")}`;
+  const CMD = `CLUSTER_COUNT=${CLUSTER_COUNT} CLUSTER_AUTO_BROADCAST=true ${process.argv[0]} ${mainPath()} ${resolve(__package_dirname, "main.js")} ${process.argv.slice(2).join(" ")}`;
 
   console.log(CMD);
 

package/src/common/arguments.ts

@@ -23,6 +23,7 @@ export interface Arguments {
   inflate: boolean;
   generateDoc: boolean;
   generateDocOut: string;
+  generateDocAll: boolean;
   generateDocType: "JSON" | "MD";
   migrateUp: boolean;
   migrateDown: boolean;
@@ -46,6 +47,7 @@ export function parseArguments(): Arguments {
     installTSConfig: boolean | null;
     inflate: boolean | null;
     generateDoc: boolean | null;
+    generateDocAll: boolean | null;
     generateDocOut?: string | null;
     generateDocType?: string | null;
     test: boolean;
@@ -67,6 +69,7 @@ export function parseArguments(): Arguments {
     test: null,
     inflate: null,
     generateDoc: null,
+    generateDocAll: null,
     generateDocOut: null,
     generateDocType: null,
     editor: null,
@@ -120,6 +123,14 @@ export function parseArguments(): Arguments {
         }
         flags.generateDoc = true;
         continue;
+      case "--generate-doc-all":
+        if (flags.generateDocAll !== null) {
+          console.error("bad arguments.");
+          console.error(usage);
+          process.exit(EXIT_CODES.BAD_ARGUMENTS);
+        }
+        flags.generateDocAll = true;
+        continue;
       case "--generate-doc-out":
         if (flags.generateDocOut !== null) {
           console.error("bad arguments. --generate-doc-out already set.");
@@ -343,7 +354,7 @@ export function parseArguments(): Arguments {
     process.exit(EXIT_CODES.BAD_ARGUMENTS);
   }
 
-  if ((flags.generateDocOut || flags.generateDocType) && !flags.generateDoc) {
+  if ((flags.generateDocAll || flags.generateDocOut || flags.generateDocType) && !flags.generateDoc) {
     console.error("bad arguments. cannot use without --generate-doc");
     process.exit(EXIT_CODES.BAD_ARGUMENTS);
   }
@@ -351,6 +362,7 @@ export function parseArguments(): Arguments {
   const generateDocType = flags.generateDocType ? flags.generateDocType as any : "MD";
 
   return {
+    generateDocAll: flags.generateDocAll ? true : false,
     hotreload: flags.hotreload ? true : false,
     installTypes: flags.installTypes ? true : false,
     installTSConfig: flags.installTSConfig ? true : false,

package/src/common/constants.ts

@@ -1,5 +1,3 @@
-import { checkEnvVariable } from "@miqro/core";
-
 export const EXIT_CODES = {
   BAD_ARGUMENTS: 10,
   NORMAL_EXIT: 0,
@@ -9,10 +7,12 @@ export const EXIT_CODES = {
   TEST_FAILED: 30,
 }
 
-export const CLEAR_JSX_CACHE = checkEnvVariable("CLEAR_JSX_CACHE", "1") === "1";
+export const CLEAR_JSX_CACHE = (process.env["CLEAR_JSX_CACHE"] !== undefined ? process.env["CLEAR_JSX_CACHE"] : "1") === "1";
 
 export const EDITOR_CONFIG_KEY = "$$editor$$";
 
+export const HOT_RELOAD_PATH = "/hot-reload";
+
 //export const SERVER_IDENTIFIER = cluster.isPrimary ? "SERVER" : process.env["CLUSTER_NODE_NUMBER"] ? `WORKER_${process.env["CLUSTER_NODE_NUMBER"]}` : "WORKER";
 
 //export const DB_IDENTIFIER = cluster.isPrimary ? "DATABASE" : process.env["CLUSTER_NODE_NUMBER"] ? `WORKER_${process.env["CLUSTER_NODE_NUMBER"]}_DATABASE` : "WORKER_DATABASE";

package/src/common/help.ts

@@ -18,7 +18,7 @@ export const help = `
 
 -v, --version\t\toutputs the version number
 -h, --help\t\toutputs this page.
---watch\t\tuse to enable the hot-reload functionality.
+--watch\t\t\tuse to enable the hot-reload functionality.
 --test\t\t\trun the tests for a service.
 --migrate-up\t\tmigrations up.
 --migrate-down\t\tmigrations down.
@@ -28,6 +28,7 @@ export const help = `
 --generate-doc\t\tgenerates a documentation for the api endpoints of the service.
 --generate-doc-out\tthe output file for the generated documentation. default value is API.md.
 --generate-doc-type\tthe format of the generated documentation. it can be JSON or MD. default value is MD.
+--generate-doc-all\toutputs all the server routes in the documentation output.
 --compile\t\tinflates the application and tries to create a NODE SEA binary.
 --inflate-sea\t\tinflates the application with sea compilation scripts.
 --install-tsconfig\tcreates a tsconfig.json configured to use with --install-types.

package/src/services/app.ts

@@ -14,7 +14,7 @@ import editorServerConfig from "../../editor/server.js";
 
 import { ClusterCache } from "./utils/cluster-cache.js";
 import { createEditorRouter } from "./editor.js";
-import { EDITOR_CONFIG_KEY } from "../common/constants.js";
+import { EDITOR_CONFIG_KEY, HOT_RELOAD_PATH } from "../common/constants.js";
 import { watchAndServer } from "../common/watch.js";
 import { LocalCache } from "./utils/cache.js";
 import { initGlobals } from "./globals.js";
@@ -325,9 +325,9 @@ export class Miqro {
       }
 
       if (this.options?.hotreload/* && !options?.inflateTests*/) {
-        this.logger?.debug("setting up websocket on [/hot-reload]");
+        this.logger?.debug("setting up websocket on [%s]", HOT_RELOAD_PATH);
         wsConfigList.push({
-          path: "/hot-reload/"
+          path: HOT_RELOAD_PATH
         });
       }
 

package/src/services/editor.tsx

@@ -1,4 +1,4 @@
-import { APIRoute, Handler, Router, RouterHandlerOptions, SessionHandler } from "@miqro/core";
+import { APIRoute, Handler, HandlerWithOptions, Router, RouterHandlerOptions, SessionHandler } from "@miqro/core";
 import { getAsset } from "../common/assets.js";
 
 import { BASEEDITOR_PATH } from "../../editor/common/constants.js";
@@ -17,8 +17,9 @@ import { CONTENT_TYPE_MAP } from "../common/content-type.js";
 
 export async function createEditorRouter(adminInterface: EditorAdminInterface): Promise<Router> {
   const router = new Router();
+  const innerRouter = new Router();
 
-  router.use(async (req: AdminRequest, res) => {
+  innerRouter.use(async (req: AdminRequest, res) => {
     res.setHeader("x-uuid", req.uuid);
     req.editor = adminInterface;
   });
@@ -39,21 +40,23 @@ export async function createEditorRouter(adminInterface: EditorAdminInterface):
 
   const { EditorIndex } = await import("../../editor/common/editor-index.js");
 
-  router.post(`${BASEEDITOR_PATH}/api/fs/write`, getHandler(authHandler, writeAPI));
+  innerRouter.use(authHandler);
 
-  router.post(`${BASEEDITOR_PATH}/api/fs/rename`, getHandler(authHandler, renameAPI));
+  innerRouter.post(`/api/fs/write`, getHandler(/*authHandler, */writeAPI));
 
-  router.post(`${BASEEDITOR_PATH}/api/fs/read`, getHandler(authHandler, readAPI));
+  innerRouter.post(`/api/fs/rename`, getHandler(/*authHandler, */renameAPI));
 
-  router.post(`${BASEEDITOR_PATH}/api/fs/delete`, getHandler(authHandler, deleteAPI));
+  innerRouter.post(`/api/fs/read`, getHandler(/*authHandler, */readAPI));
 
-  router.get(`${BASEEDITOR_PATH}/api/fs/scan`, getHandler(authHandler, scanAPI));
+  innerRouter.post(`/api/fs/delete`, getHandler(/*authHandler, */deleteAPI));
 
-  router.post(`${BASEEDITOR_PATH}/api/server/restart`, getHandler(authHandler, restartAPI));
+  innerRouter.get(`/api/fs/scan`, getHandler(/*authHandler, */scanAPI));
 
-  router.post(`${BASEEDITOR_PATH}/api/server/reload`, getHandler(authHandler, reloadAPI));
+  innerRouter.post(`/api/server/restart`, getHandler(/*authHandler, */restartAPI));
 
-  router.get(`${BASEEDITOR_PATH}/font.ttf`, async (_req, res) => {
+  innerRouter.post(`/api/server/reload`, getHandler(/*authHandler, */reloadAPI));
+
+  innerRouter.get(`/font.ttf`, async (_req, res) => {
     return await res.asyncEnd({
       status: 200,
       headers: {
@@ -63,14 +66,16 @@ export async function createEditorRouter(adminInterface: EditorAdminInterface):
     })
   });
 
-  router.get(BASEEDITOR_PATH, [authHandler, EditorIndex(editorCSS, editorJS, false)]);
+  innerRouter.get("/", EditorIndex(editorCSS, editorJS, false));
 
 
 
-  router.use(async (req: AdminRequest, res) => {
+  innerRouter.use(async (req: AdminRequest, res) => {
     delete req.editor;
   });
 
+  router.use(innerRouter, BASEEDITOR_PATH);
+
   return router;
 }
 
@@ -84,10 +89,13 @@ function getHandlerOptions(router: APIRoute): RouterHandlerOptions {
   };
 }
 
-function getHandler(auth: Handler, router: APIRoute): Router {
-  const ret = new Router();
+function getHandler(/*auth: Handler, */router: APIRoute): HandlerWithOptions {
+  /*const ret = new Router();
   ret.use(auth);
   ret.use(router.handler, undefined, undefined, getHandlerOptions(router));
-  return ret;
-
+  return ret;*/
+  return {
+    ...getHandlerOptions(router),
+    handler: router.handler as Handler
+  }
 }

package/src/services/hot-reload.ts

@@ -1,11 +1,13 @@
 //import { checkEnvVariable } from "@miqro/core";
 
+import { HOT_RELOAD_PATH } from "../common/constants.js";
+
 export function getHotReloadScript() {
   const HOT_RELOAD_JS_SCRIPT = `
 // Create WebSocket connection.
 
 function getSocket() {
-    return new WebSocket("/hot-reload");
+    return new WebSocket("${HOT_RELOAD_PATH}");
 }
 
 const socket = getSocket();

package/src/services/utils/log.ts

@@ -40,9 +40,9 @@ export class LogProvider {
     } catch (e) {
       urlParsingError = e;
     }
-    const pathToEnv = path.replace(/\//ig, "_").toUpperCase();
+    const pathToEnv = path.replace(/\//ig, "_").replace(/\./ig, "_").replace(/-/ig, "_").toUpperCase();
     const WORKER_IDENTIFIER = process.env["CLUSTER_NODE_NUMBER"] ? `WORKER_${process.env["CLUSTER_NODE_NUMBER"]}_` : "";
-    const identifier = `${pathToEnv === "_" ? "" : `${pathToEnv.substring(1)}`}${method.toUpperCase()}`;
+    const identifier = `${pathToEnv === "_" ? "" : `${pathToEnv.substring(1)}`}${pathToEnv.charAt(pathToEnv.length - 1) !== "_" ? "_" : ""}${method.toUpperCase()}`;
     const upgrade = req.headers.connection?.indexOf("Upgrade") !== -1;
 
     const logger = this.getLogger(

package/src/services/utils/server-interface.ts

@@ -144,6 +144,12 @@ export class ServerInterfaceImpl implements ServerInterface {
       }
     });
   }
+  public getWorkerNumber(): number {
+    return cluster.isPrimary || process.env["CLUSTER_NODE_NUMBER"] === undefined ? 0 : parseInt(process.env["CLUSTER_NODE_NUMBER"], 10);
+  }
+  public getWorkerCount(): number {
+    return cluster.isPrimary || process.env["CLUSTER_NODE_NUMBER"] === undefined || process.env["CLUSTER_COUNT"] === undefined ? 1 : parseInt(process.env["CLUSTER_COUNT"], 10);
+  }
   public isPrimaryWorker(): boolean {
     return cluster.isPrimary || process.env["CLUSTER_NODE_NUMBER"] === "0";
   }

package/src/types/miqro.d.ts

@@ -94,6 +94,8 @@ export interface ServerInterface {
   localCache: CacheInterface;
   logger: Logger;
   isPrimaryWorker: () => boolean;
+  getWorkerNumber: () => number;
+  getWorkerCount: () => number;
   openBrowser: (path: string) => void;
   getLogger: (identifier: string, options?: { level?: any; transports?: any[]; formatter?: any; }) => Logger;
 }

package/src/types.ts

@@ -107,6 +107,8 @@ export interface ServerInterface {
   localCache: CacheInterface;
   logger?: Logger;
   isPrimaryWorker: () => boolean;
+  getWorkerNumber: () => number;
+  getWorkerCount: () => number;
   openBrowser: (path: string) => void;
   getLogger: (identifier: string, options?: { level?: any; transports?: any[]; formatter?: any; }) => Logger;
 }