miqro 6.2.0 → 6.2.1

package/src/common/arguments.ts

@@ -12,6 +12,7 @@ import { isSea } from "node:sea";
 import cluster from "node:cluster";
 import { __package_dirname, getVersion } from "./assets.js";
 import { Parser, Schema } from "@miqro/parser";
+import { ServerOptions } from "node:https";
 
 const parser = new Parser();
 
@@ -23,6 +24,9 @@ interface MiqroJSON {
   browser?: string | boolean;
   logFile?: string | boolean;
   editor?: boolean;
+  https?: boolean;
+  serverOptions?: ServerOptions;
+  httpsRedirect?: number;
 }
 
 const MiqroJSONSchema: Schema<MiqroJSON> = {
@@ -34,7 +38,10 @@ const MiqroJSONSchema: Schema<MiqroJSON> = {
     inflateDir: "string?",
     browser: "boolean?|string?",
     logFile: "boolean?|string?",
-    editor: "boolean?"
+    editor: "boolean?",
+    https: "boolean?",
+    serverOptions: "any?",
+    httpsRedirect: "number?"
   }
 }
 
@@ -76,6 +83,9 @@ export interface Arguments {
   services: string[];
   editor: boolean;
   hotreload: boolean;
+  https: boolean;
+  serverOptions: ServerOptions;
+  httpsRedirect?: number;
 }
 
 /**
@@ -87,6 +97,9 @@ export function parseArguments(): Arguments {
 
   const args = cluster.isPrimary ? process.argv.slice(2, process.argv.length) : process.argv.slice(3, process.argv.length);
   const flags: {
+    httpsRedirect: number | null;
+    https: boolean | null;
+    serverOptions: ServerOptions;
     logFile: string | boolean | null;
     browser: string | boolean | null;
     name: string | null;
@@ -110,6 +123,9 @@ export function parseArguments(): Arguments {
     inflateDir?: string | null;
     hotreload?: boolean | null;
   } = {
+    httpsRedirect: null,
+    https: null,
+    serverOptions: {},
     name: null,
     browser: null,
     logFile: null,
@@ -196,6 +212,59 @@ export function parseArguments(): Arguments {
         }
         flags.hotreload = true;
         continue;
+      case "--https":
+        if (flags.https !== null) {
+          console.error("bad arguments.");
+          console.error(usage);
+          process.exit(EXIT_CODES.BAD_ARGUMENTS);
+        }
+        flags.https = true;
+        continue;
+      case "--https-redirect":
+        if (flags.httpsRedirect !== null) {
+          console.error("bad arguments.");
+          console.error(usage);
+          process.exit(EXIT_CODES.BAD_ARGUMENTS);
+        }
+        const httpsRedirectPort = parseInt(String(args[i + 1]) as any, 10);
+        if (isNaN(httpsRedirectPort)) {
+          console.error("bad arguments. --https-redirect must be a number.");
+          console.error(usage);
+          process.exit(EXIT_CODES.BAD_ARGUMENTS);
+        }
+        flags.httpsRedirect = httpsRedirectPort;
+        i++;
+        continue;
+      case "--https-cert":
+        if (flags.serverOptions.cert) {
+          console.error("bad arguments.");
+          console.error(usage);
+          process.exit(EXIT_CODES.BAD_ARGUMENTS);
+        }
+        const httpsCertPath = args[i + 1] as any;
+        if (typeof httpsCertPath !== "string") {
+          console.error("bad arguments. --https-cert must be a string.");
+          console.error(usage);
+          process.exit(EXIT_CODES.BAD_ARGUMENTS);
+        }
+        flags.serverOptions.cert = readFileSync(httpsCertPath);
+        i++;
+        continue;
+      case "--https-key":
+        if (flags.serverOptions.key) {
+          console.error("bad arguments.");
+          console.error(usage);
+          process.exit(EXIT_CODES.BAD_ARGUMENTS);
+        }
+        const httpsKeyPath = args[i + 1] as any;
+        if (typeof httpsKeyPath !== "string") {
+          console.error("bad arguments. --https-key must be a string.");
+          console.error(usage);
+          process.exit(EXIT_CODES.BAD_ARGUMENTS);
+        }
+        flags.serverOptions.key = readFileSync(httpsKeyPath);
+        i++;
+        continue;
       case "--port":
         if (flags.port !== null) {
           console.error("bad arguments.");
@@ -426,6 +495,8 @@ export function parseArguments(): Arguments {
   const miqroJSONPath = !flags.disableMiqroJSON ? flags.miqroJSONPath ? resolve(flags.miqroJSONPath) : getMiqroJSONPath() : false;
   const miqroRC = miqroJSONPath ? importMiqroJSON(miqroJSONPath) : {};
 
+  //console.dir(miqroRC.serverOptions);
+
   // try to load .miqrorc
   if (!flags.disableMiqroJSON && miqroJSONPath) {
     if (services.length === 0) {
@@ -435,6 +506,33 @@ export function parseArguments(): Arguments {
         }
       }
     }
+    if (flags.https === null) {
+      if (miqroRC.https) {
+        flags.https = miqroRC.https;
+      }
+    }
+    if (flags.httpsRedirect === null) {
+      if (miqroRC.httpsRedirect && flags.https) {
+        /*console.log("reading key from " + String(miqroRC.serverOptions?.key));
+        flags.serverOptions.key = readFileSync(String(miqroRC.serverOptions?.key));*/
+        flags.httpsRedirect = miqroRC.httpsRedirect;
+      }
+    }
+    if (!flags.serverOptions.key) {
+      if (miqroRC.serverOptions?.key) {
+        /*console.log("reading key from " + String(miqroRC.serverOptions?.key));
+        flags.serverOptions.key = readFileSync(String(miqroRC.serverOptions?.key));*/
+        flags.serverOptions.key = miqroRC.serverOptions?.key;
+      }
+    }
+
+    if (!flags.serverOptions.cert) {
+      if (miqroRC.serverOptions?.cert) {
+        /*console.log("reading cert from " + String(miqroRC.serverOptions?.cert));
+        flags.serverOptions.cert = readFileSync(String(miqroRC.serverOptions?.cert));*/
+        flags.serverOptions.cert = miqroRC.serverOptions?.cert;
+      }
+    }
     if (flags.port === null) {
       if (miqroRC.port) {
         flags.port = String(miqroRC.port);
@@ -548,6 +646,21 @@ export function parseArguments(): Arguments {
 
   const generateDocType = flags.generateDocType ? flags.generateDocType as any : "MD";
 
+  if (flags.https && (!flags.serverOptions.key)) {
+    console.error("bad arguments. cannot use --https without --https-key. or set values in miqro.json file.");
+    process.exit(EXIT_CODES.BAD_ARGUMENTS);
+  }
+
+  if (flags.https && (!flags.serverOptions.cert)) {
+    console.error("bad arguments. cannot use --https without --https-cert. or set values in miqro.json file.");
+    process.exit(EXIT_CODES.BAD_ARGUMENTS);
+  }
+
+  if (flags.httpsRedirect && !flags.https) {
+    console.error("bad arguments. cannot use --https-redirect without --https. or set values in miqro.json file.");
+    process.exit(EXIT_CODES.BAD_ARGUMENTS);
+  }
+
   return {
     name: flags.name ? flags.name : undefined,
     browser: flags.browser !== null ? flags.browser : undefined,
@@ -571,6 +684,9 @@ export function parseArguments(): Arguments {
     generateDocOut: flags.generateDocOut ? resolve(process.cwd(), flags.generateDocOut) : generateDocType === "MD" ? resolve(process.cwd(), "API.md") : resolve(process.cwd(), "API.json"),
     generateDocType,
     services,
-    editor: flags.editor ? true : false
+    editor: flags.editor ? true : false,
+    https: flags.https ? true : false,
+    httpsRedirect: flags.httpsRedirect ? flags.httpsRedirect : undefined,
+    serverOptions: flags.serverOptions
   }
 }

package/src/common/help.ts

@@ -40,6 +40,10 @@ export const help = `
 --config\n\toverrides the default miqro.json path.
 --port\n\toverrides the default port from PORT.
 --name\n\toverrides the default name of the server.
+--https\n\tserves the server in https instead of http
+--https-key\n\tpoint to a server.key file for https.
+--https-cert\n\tpoint to a server.cert file for https.
+--https-redirect\n\tserves an aditional http server that redirects to https. it needs a port number.
 
 ==environment variables==
 

package/src/main.ts

@@ -22,7 +22,10 @@ async function main(args: Arguments) {
       services: args.services,
       browser: args.browser,
       logFile: args.logFile,
-      hotreload: args.test ? false : args.hotreload
+      hotreload: args.test ? false : args.hotreload,
+      https: args.test ? false : args.https,
+      serverOptions: args.serverOptions,
+      httpRedirect: args.test ? undefined : args.httpsRedirect
     });
     // check arguments
     if (args.generateDoc) {

package/src/services/app.ts

@@ -31,6 +31,7 @@ import { createLogProviderOptions } from "./utils/log-transport.js";
 import { createAdminInterface } from "./utils/admin-interface.js";
 import { dirname, join, relative, resolve } from "node:path";
 import { cwd } from "node:process";
+import { ServerOptions } from "node:https";
 
 export interface MiqroOptions {
   name: string;
@@ -42,6 +43,9 @@ export interface MiqroOptions {
   browser?: string | boolean;
   logFile?: string | boolean;
   hotreload?: boolean;
+  serverOptions?: ServerOptions<any, any>;
+  https?: boolean;
+  httpRedirect?: number;
 }
 
 export interface InflateOptions {
@@ -76,6 +80,7 @@ export class Miqro {
   public status: "stopped" | "starting" | "stopping" | "reloading" | "started" = "stopped";
   public options: MiqroOptions;
   public server?: App | null = null;
+  public httpsRedirectServer?: App | null = null;
   public cache: ClusterCache;
   public localCache: LocalCache;
   public webSocketManager: WebSocketManager;
@@ -424,6 +429,7 @@ export class Miqro {
     //this.disconnect();
     this.status = "starting";
     this.server = undefined;
+    this.httpsRedirectServer = undefined;
     this.connect();
     await this.dbManager.connectAll();
     this.server = new App({
@@ -431,8 +437,17 @@ export class Miqro {
         req.server = this.serverInterface;
         return this.webSocketManager.onUpgrade(req, socket, head);
       },
-      loggerFactory: this.loggerProvider.requestLoggerFactory
+      loggerFactory: this.loggerProvider.requestLoggerFactory,
+      serverOptions: this.options?.serverOptions,
+      https: this.options?.https
     });
+    if (this.options?.httpRedirect) {
+      this.httpsRedirectServer = new App();
+      this.httpsRedirectServer.use(async (req: ServerRequest, res) => {
+        const hostname = req.headers.host.split(":").length > 1 ? req.headers.host.split(":")[0] : req.headers.host;
+        return await res.redirect('https://' + hostname + ":" + this.options.port + req.url);
+      });
+    }
 
     this.webSocketManager.replaceALLWS(this.inflated.wsConfigList);
 
@@ -455,11 +470,20 @@ export class Miqro {
     this.logger?.trace("calling listen on [%s]", this.options.port);
 
     await this.server.listen(this.options.port);
+    if (this.options?.httpRedirect) {
+      await this.httpsRedirectServer.listen(this.options.httpRedirect);
+    }
+
+    if (this.options?.httpRedirect && this.logger && (cluster.isPrimary || process.env["CLUSTER_NODE_NUMBER"] === "0")) {
+      this.logger?.log("\t\t==listening on [http][%s] for [https][%s] redirection==", this.options?.httpRedirect, this.options.port);
+    } else if (this.options?.httpRedirect) {
+      this.logger?.debug("\t\t==listening on [http][%s] for [https][%s] redirection==", this.options?.httpRedirect, this.options.port);
+    }
 
     if (this.logger && (cluster.isPrimary || process.env["CLUSTER_NODE_NUMBER"] === "0")) {
-      this.logger?.log("\t\t==listening on [%s]==", this.options.port);
+      this.logger?.log("\t\t==listening on [%s][%s]==", this.options.https ? "https" : "http", this.options.port);
     } else {
-      this.logger?.debug("\t\t==listening on [%s]==", this.options.port);
+      this.logger?.debug("\t\t==listening on [%s][%s]==", this.options.https ? "https" : "http", this.options.port);
     }
 
     await notifiyServerConfig(this.logger, this.serverInterface, this.adminInterface, this.inflated.serverConfigMap, "start");
@@ -484,7 +508,9 @@ export class Miqro {
       this.watcher = null;
     }
     const server = this.server;
+    const httpsRedirectServer = this.httpsRedirectServer;
     this.server = null;
+    this.httpsRedirectServer = null;
     this.disconnect();
     this.logger?.debug("\t\t==stop==");
     this.logger?.debug("clear running server routes");
@@ -495,6 +521,9 @@ export class Miqro {
     notifiyServerConfigSync(this, "unload");
     //server.ws.disconnectAll();
     this.logger?.debug("stopping");
+    if (httpsRedirectServer) {
+      await httpsRedirectServer.close();
+    }
     const p = server.close();
     await p;
     await pD;

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

@@ -26,6 +26,15 @@ export function createServerInterface(options: ServerInterfaceImplOptions): Serv
     cache: options.cache,
     localCache: options.localCache,
     logger: options.logger,
+    reload() {
+      return options?.app?.reload();
+    },
+    restart() {
+      return options?.app?.restart();
+    },
+    stop() {
+      return options?.app?.stop();
+    },
     db: {
       get(name) {
         return options.dbManager.getDB(name);

package/src/types/browser.globals.d.ts

@@ -1,9 +1 @@
 import "./jsx.globals.js";
-import { RuntimeElementDefinitionOptions, Component } from "@miqro/jsx/esm/lib.js";
-
-declare global {
-  // only available browser side
-  var jsx: {
-    define: (tagName: string, component: Component, options?: RuntimeElementDefinitionOptions) => void;
-  }
-}

package/src/types/jsx.globals.d.ts

@@ -4,6 +4,7 @@ declare global {
   // jsx only for the default value of tsconfig.json
   var React: {};
   var jsx: {
+    define: (tagName: string, component: jsxLib.Component, options?: jsxLib.RuntimeElementDefinitionOptions) => void;
     useRuntime: typeof jsxLib.useRuntime;
     usePathname: typeof jsxLib.usePathname;
     Link: typeof jsxLib.Link;

package/src/types/miqro.d.ts

@@ -206,6 +206,15 @@ export interface ServerInterface extends ServerGlobal{
   getWorkerCount: () => number;
   openBrowser: (path: string) => void;
   getLogger: (identifier: string, options?: { level?: any; transports?: any[]; formatter?: any; }) => Logger;
+  stop: () => Promise<void>;
+  reload: () => Promise<null | {
+    filePath: string;
+    error: Error;
+  }[]>;
+  restart: () => Promise<null | {
+    filePath: string;
+    error: Error;
+  }[]>;
 }
 
 export interface ServerRequest extends Request {

package/src/types.ts

@@ -184,6 +184,15 @@ export interface ServerInterface extends ServerGlobal {
   logger?: Logger;
   openBrowser: (path: string) => void;
   getLogger: (identifier: string, options?: { level?: any; transports?: any[]; formatter?: any; }) => Logger;
+  stop: () => Promise<void>;
+  reload: () => Promise<null | {
+    filePath: string;
+    error: Error;
+  }[]>;
+  restart: () => Promise<null | {
+    filePath: string;
+    error: Error;
+  }[]>;
 }
 
 export interface ServerRequest extends Request {