geonix 1.20.1 → 1.20.3

package/eslint.config.js

@@ -14,7 +14,8 @@ export default [
             }
         },
         rules: {
-            // "no-console": "error",
+            "curly": "error",
+            "no-console": "error",
             semi: "error",
             "no-unused-vars": ["error", { argsIgnorePattern: "^_.*" }],
             "no-constant-condition": ["error", { checkLoops: false }],

package/index.d.ts

@@ -65,6 +65,14 @@ export class Gateway {
     constructor(opts: any);
     #private;
 }
+export class Logger {
+    constructor(options: any);
+    info(...args: any[]): void;
+    error(...args: any[]): void;
+    debug(...args: any[]): void;
+    #private;
+}
+export const logger: Logger;
 export const registry: Registry;
 /**
  * Registry maintains a local list of available services and their versions.
@@ -138,6 +146,17 @@ export class Service {
     $getServiceInfo(): {};
     #private;
 }
+export type ServiceOptions = {
+    middleware: {
+        json: boolean;
+        raw: boolean;
+        cookies: boolean;
+    };
+    /**
+     * Enable full beacon
+     */
+    fullBeacon: boolean;
+};
 /**
  * Converts data to stream
  *
@@ -151,6 +170,7 @@ export function getReadable(object: any): Promise<any>;
 export function streamToBuffer(object: any): Promise<any>;
 export function streamToString(object: any): Promise<any>;
 export const stats: {};
+export const activeStreams: {};
 /**
  * Parse nats:// URL
  * @param {string} url
@@ -158,6 +178,7 @@ export const stats: {};
  */
 export function parseURL(url: string): any;
 export function getFirstItemFromAsyncIterable(asyncIterable: any): Promise<any>;
+export function getNetworkAddresses(): any[];
 export function sleep(delay: number): Promise<any>;
 export function picoid(size?: number): any;
 export function hash(data: string | Buffer): any;
@@ -176,7 +197,6 @@ export function ServeStatic(root: any, options?: {}): any;
 export const webserver: WebServer;
 declare class WebServer {
     start(): Promise<void>;
-    getAddresses(): any[];
     getPort(): any;
     router(): any;
     waitUntilReady(): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "geonix",
-    "version": "1.20.1",
+    "version": "1.20.3",
     "type": "module",
     "description": "",
     "bin": {
@@ -10,6 +10,7 @@
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1",
         "build": "npx tsc && cat build/* > index.d.ts && rm -rf build",
+        "lint": "npx eslint src",
         "deploy": "npm run build && npm publish"
     },
     "author": "Davor Tarandek <dtarandek@tria.hr>",
@@ -28,7 +29,7 @@
         "registry": "https://registry.npmjs.org/"
     },
     "devDependencies": {
-        "eslint": "^9.9.1",
+        "eslint": "^9.10.0",
         "typescript": "^5.5.4"
     }
-}
+}

package/src/Codec.js

@@ -0,0 +1,16 @@
+import { JSONCodec } from "nats";
+
+export const codec = JSONCodec();
+
+export function encode(data) {
+    return codec.encode(data);
+}
+
+export function decode(data) {
+    // check if data is json
+    if (Buffer.isBuffer(data) && data.readUInt8(0) === "{".charCodeAt(0)) {
+        return codec.decode(data);
+    }
+
+    throw new Error("Codec.decode: unknown data type");
+}

package/src/Connection.js

@@ -1,7 +1,9 @@
-import { connect, JSONCodec } from "nats";
-import { parseURL, picoid, sleep } from "./Util.js";
+import { connect } from "nats";
+import { getFirstItemFromAsyncIterable, parseURL, picoid, sleep } from "./Util.js";
 import { Stream } from "./Stream.js";
 import { webserver } from "./WebServer.js";
+import { logger } from "./Logger.js";
+import { decode, encode } from "./Codec.js";
 
 // -------------------------------------------------------------------------------------------------
 const CONNECTION_TIMEOUT = 10000;
@@ -9,6 +11,16 @@ const CONNECTION_TIMEOUT = 10000;
 const defaultRequestOptions = {
     timeout: 300000
 };
+
+const defaultConnectionOptions = {
+    timeout: CONNECTION_TIMEOUT,
+    reconnect: true,
+    debug: process.env.TRANSPORT_DEBUG === "true",
+    maxReconnectAttempts: 30,
+    pingInterval: 30000,
+    waitOnFirstConnect: true,
+    connections: 1
+};
 // -------------------------------------------------------------------------------------------------
 
 /**
@@ -36,17 +48,8 @@ class Connection {
      * @param {string} transport 
      */
     async start(transport = process.env.TRANSPORT || "nats://localhost") {
-        const defaults = {
-            timeout: CONNECTION_TIMEOUT,
-            reconnect: true,
-            debug: process.env.TRANSPORT_DEBUG === "true",
-            maxReconnectAttempts: 30,
-            pingInterval: 30000,
-            waitOnFirstConnect: true,
-            connections: 1
-        };
         const options = {
-            ...defaults,
+            ...defaultConnectionOptions,
             ...parseURL(transport)
         };
 
@@ -54,7 +57,7 @@ class Connection {
             this.#connections.push(await connect(options));
         }
 
-        console.log("gx.connection.connected");
+        logger.info("gx.connection.connected");
 
         this.#ready = true;
 
@@ -64,7 +67,7 @@ class Connection {
 
     async monitorStatus() {
         for await (const event of this.#getConnection().status()) {
-            console.log("gx.connection.status", JSON.stringify(event));
+            logger.info("gx.connection.status", JSON.stringify(event));
         }
     }
 
@@ -76,13 +79,13 @@ class Connection {
         await Promise.all(this.#connections.map(connection => connection.closed()));
 
         this.#closed = true;
-        console.log("gx.connection.closed");
+        logger.info("gx.connection.closed");
 
         webserver.stop();
 
         await sleep(5000);
 
-        console.log("gx.terminate");
+        logger.info("gx.terminate");
         process.exit(1);
     }
 
@@ -90,8 +93,9 @@ class Connection {
      * Wait for the connection to be fully established
      */
     async waitUntilReady() {
-        while (!this.#ready)
+        while (!this.#ready) {
             await sleep(100);
+        }
     }
 
     /**
@@ -102,14 +106,16 @@ class Connection {
      * @returns void
      */
     async publish(subject, json) {
-        if (this.#draining || this.#closed)
+        if (this.#draining || this.#closed) {
             return;
+        }
 
-        let payload = codec.encode(json);
+        let payload = encode(json);
 
         // if payload is too big, convert it to Stream
-        if (payload.length > this.getMaxPayloadSize())
-            payload = codec.encode(Stream(JSON.stringify(json)));
+        if (payload.length > this.getMaxPayloadSize()) {
+            payload = encode(Stream(JSON.stringify(json)));
+        }
 
         await this.#getConnection().publish(subject, payload);
     }
@@ -122,8 +128,9 @@ class Connection {
      * @returns void
      */
     async publishRaw(subject, data) {
-        if (this.#draining || this.#closed)
+        if (this.#draining || this.#closed) {
             return;
+        }
 
         await this.#getConnection().publish(subject, data);
     }
@@ -144,19 +151,20 @@ class Connection {
 
         const respondTo = `gx2.r.${picoid(16)}`;
 
-        let payload = codec.encode({ $r: respondTo, p: json });
+        let payload = encode({ $r: respondTo, p: json });
 
         // if payload is too big, convert it to Stream
-        if (payload.length > this.getMaxPayloadSize())
-            payload = codec.encode(Stream(JSON.stringify({ $r: respondTo, p: json })));
+        if (payload.length > this.getMaxPayloadSize()) {
+            payload = encode(Stream(JSON.stringify({ $r: respondTo, p: json })));
+        }
 
         const nc = this.#getConnection();
         let response = await nc.subscribe(respondTo, { max: 1, ...options });
 
         await nc.publish(subject, payload);
 
-        for await (let event of response)
-            return codec.decode(event.data);
+        const event = await getFirstItemFromAsyncIterable(response);
+        return decode(event.data);
     }
 
     async subscribe(subject, options) {
@@ -188,14 +196,13 @@ class Connection {
 
 }
 
-export const codec = JSONCodec();
-
 export const connection = new Connection();
 connection.start();
 
 export const stopConnection = () => {
-    if (!connection)
+    if (!connection) {
         return;
+    }
 
     connection.drain();
 };

package/src/Gateway.js

@@ -8,14 +8,15 @@ import expressWs from "express-ws";
 import querystring from "querystring";
 import semver from "semver";
 import { WebSocket } from "ws";
+import { logger } from "./Logger.js";
 
 const raw = express.raw({ limit: "100mb" });
 
 const DEBUG_ENDPOINT = "/lZ6jD2eC3iP0zB3jJ1yJ9pM8gG3yI3vS";
 const endpointMatcher = /^((?<options>.+)\|)?(?<verb>WS|GET|POST|PATCH|PUT|DELETE|HEAD|OPTIONS|ALL)\s(?<url>.*)/;
 
-const logger = (req, res, next) => {
-    console.info(`HTTP ${req.method} ${req.url}`);
+const requestLogger = (req, res, next) => {
+    logger.info(`HTTP ${req.method} ${req.url}`);
 
     next();
 };
@@ -63,10 +64,10 @@ export class Gateway {
         this.#port = process.env.PORT || port;
         this.#api.listen(this.#port);
 
-        console.debug(`geonix.gateway: listening on http://0.0.0.0:${this.#port}`);
+        logger.debug(`geonix.gateway: listening on http://0.0.0.0:${this.#port}`);
 
         // logging
-        this.#api.use(logger);
+        this.#api.use(requestLogger);
 
         // cors
         this.#api.use((req, res, next) => {
@@ -86,8 +87,9 @@ export class Gateway {
         });
 
         // debug router (only available in non-production environments)
-        if (process.env.NODE_ENV !== "production")
+        if (process.env.NODE_ENV !== "production") {
             this.#api.use(DEBUG_ENDPOINT, this.#debugRouter());
+        }
 
         this.#api.use((req, res, next) => {
             if (this.#opts.beforeRequest) {
@@ -100,10 +102,8 @@ export class Gateway {
         this.#api.use(raw, (req, res, next) => {
             stats.requests++;
 
-            if (this.#router)
-                this.#router(req, res, next);
-            else
-                next();
+            if (this.#router) { this.#router(req, res, next); }
+            else { next(); }
         });
 
         this.#api.use((req, res, next) => {
@@ -126,8 +126,9 @@ export class Gateway {
         });
 
         setInterval(() => {
-            if (this.#rebuildRouter)
+            if (this.#rebuildRouter) {
                 this.#buildRouter();
+            }
         }, 1000);
 
         while (true) {
@@ -143,12 +144,12 @@ export class Gateway {
                     break;
                 }
             } catch (e) {
-                console.error(e);
+                logger.error(e);
             }
         }
 
         // terminate process
-        console.debug("geonix.gateway: stopped");
+        logger.debug("geonix.gateway: stopped");
         process.exit(0);
     }
 
@@ -156,15 +157,14 @@ export class Gateway {
         let entries = Object.values(registry.getEntries());
 
         const processEntry = async (entry) => {
-            if (this.#registry[entry.i] !== undefined)
-                return false;
+            if (this.#registry[entry.i] !== undefined) { return false; }
 
-            console.log(`gateway.onServiceAdded: ${entry.n}@${entry.v} (#${entry.i})`);
+            logger.info(`gateway.onServiceAdded: ${entry.n}@${entry.v} (#${entry.i})`);
 
             // figure out if endpoints is reachable via direct http call
             let backend;
             if (entry.a) {
-                for (let address of entry.a)
+                for (let address of entry.a) {
                     try {
                         const ac = new AbortController();
                         const timeout = setTimeout(() => ac.abort(), 500);
@@ -172,12 +172,13 @@ export class Gateway {
                         clearTimeout(timeout);
                         if (result.status === "healthy" && result.services?.includes(entry.n)) {
                             backend = address;
-                            console.log(`${entry.n}@${entry.v} (#${entry.i}) directly reachable @ ${address}`);
+                            logger.info(`${entry.n}@${entry.v} (#${entry.i}) directly reachable @ ${address}`);
                             break;
                         }
                     } catch {
                         // silently ignore errors
                     }
+                }
             }
 
             let proxy;
@@ -190,7 +191,7 @@ export class Gateway {
                     try {
                         await this.#proxyHttpOverNats(streamId, entry, client);
                     } catch (e) {
-                        console.error("nats.proxy.error", e);
+                        logger.error("nats.proxy.error", e);
                         client.destroy();
                     }
                 }, 50000, 10000);
@@ -204,8 +205,9 @@ export class Gateway {
 
         entries = (await Promise.all(entries.map(processEntry))).filter(result => result === true);
 
-        if (entries.length > 0)
+        if (entries.length > 0) {
             this.#rebuildRouter = true;
+        }
     }
 
     async #handleRemovedServices() {
@@ -215,7 +217,7 @@ export class Gateway {
         for (let { entry, proxy } of localEntries) {
             if (registryEntries[entry.i] === undefined) {
                 proxy?.server?.close();
-                console.log(`gateway.onServiceRemoved: ${entry.n}@${entry.v}`);
+                logger.info(`gateway.onServiceRemoved: ${entry.n}@${entry.v}`);
                 delete this.#registry[entry.i];
 
                 this.#rebuildRouter = true;
@@ -290,8 +292,7 @@ export class Gateway {
             });
 
             const dataLoop = async () => {
-                for await (const event of ingress)
-                    client.write(event.data);
+                for await (const event of ingress) { client.write(event.data); }
             };
 
             dataLoop();
@@ -321,15 +322,16 @@ export class Gateway {
                 inbound.on("close", () => backend.close());
             });
         } catch (e) {
-            console.error(e);
+            logger.error(e);
         }
     }
 
     async #buildRouter() {
-        if (this.#buildRouterRunning)
+        if (this.#buildRouterRunning) {
             return;
+        }
 
-        console.debug("gateway.buildRouter");
+        logger.debug("gateway.buildRouter");
 
         this.#rebuildRouter = false;
         this.#buildRouterRunning = true;
@@ -359,8 +361,8 @@ export class Gateway {
                                 backend: [backend]
                             });
                         } catch (e) {
-                            console.error("gateway.buildRouter.error:", entry);
-                            console.error("gateway.buildRouter.error:", e);
+                            logger.error("gateway.buildRouter.error:", entry);
+                            logger.error("gateway.buildRouter.error:", e);
                         }
                     }
                 }
@@ -372,12 +374,13 @@ export class Gateway {
                 const version = endpoints[index].version;
                 const url = `${endpoints[index].endpoint.verb} ${endpoints[index].endpoint.url}`;
 
-                for (let n = 0; n < index; n++)
+                for (let n = 0; n < index; n++) {
                     if (`${endpoints[n].endpoint.verb} ${endpoints[n].endpoint.url}` === url && endpoints[n].version === version) {
                         endpoints[n].backend = endpoints[n].backend.concat(endpoints[index].backend);
                         endpoints.splice(index, 1);
                         break;
                     }
+                }
             }
 
             // sort endpoints by order, if there is one
@@ -397,21 +400,22 @@ export class Gateway {
                     router.ws(uri, (ws, req) => {
                         const url = req.originalUrl.replace(/\/\.websocket$/, "");
 
-                        console.debug("proxy.web.ws.to:", backend + req.originalUrl);
+                        logger.debug("proxy.web.ws.to:", backend + req.originalUrl);
                         this.#proxyWebsocketOverNats(`ws://${backend}${url}`, ws, req);
                     });
-                } else
+                } else {
                     router[verb](uri, async (req, res, _next) => {
                         stats.proxied++;
                         backend = endpoint.backend[endpoint.requests++ % endpoint.backend.length];
 
                         try {
-                            console.debug("proxy.web.to:", backend + req.originalUrl);
+                            logger.debug("proxy.web.to:", backend + req.originalUrl);
                             await proxyHttp(`http://${backend}`, req, res);
                         } catch (e) {
-                            console.error("proxy.web.error:", e);
+                            logger.error("proxy.web.error:", e);
                         }
                     });
+                }
             }
 
             this.#router = router;

package/src/Logger.js

@@ -0,0 +1,34 @@
+const defaultLoggerOptions = {
+    timestamp: true
+};
+
+export class Logger {
+
+    #options = defaultLoggerOptions;
+
+    constructor(options) {
+        this.#options = { ...this.#options, ...options };
+    }
+
+    #log(...args) {
+        const ts = this.#options.timestamp ? new Date().toISOString() : undefined;
+
+        // eslint-disable-next-line no-console
+        console.log(...[ts, ...args].filter($ => $));
+    }
+
+    info(...args) {
+        this.#log("INF", ...args);
+    }
+
+    error(...args) {
+        this.#log("ERR", ...args);
+    }
+
+    debug(...args) {
+        this.#log("DBG", ...args);
+    }
+
+}
+
+export const logger = new Logger();

package/src/Registry.js

@@ -1,8 +1,9 @@
-import { connection, codec } from "./Connection.js";
+import { connection } from "./Connection.js";
 import { sleep } from "./Util.js";
 import semver from "semver";
 import EventEmitter from "events";
 import { directRequest } from "./Request.js";
+import { decode } from "./Codec.js";
 
 const REGISTRY_ENTRY_TIMEOUT = 5000;
 
@@ -30,7 +31,7 @@ class Registry extends EventEmitter {
         const subscription = await connection.subscribe("gx2.beacon");
 
         for await (const event of subscription) {
-            let data = codec.decode(event.data);
+            let data = decode(event.data);
 
             const exists = this.#registry[data.i] !== undefined;
 
@@ -44,8 +45,9 @@ class Registry extends EventEmitter {
                 timeout: Date.now() + REGISTRY_ENTRY_TIMEOUT
             };
 
-            if (!exists)
+            if (!exists) {
                 this.emit("added", this.#registry[data.i]);
+            }
         }
     }
 
@@ -83,14 +85,16 @@ class Registry extends EventEmitter {
             let matchVersion = version ? semver.satisfies(entry.v, version) : true;
             let matchId = id ? entry.id === id : true;
 
-            if (matchName && matchVersion && matchId)
+            if (matchName && matchVersion && matchId) {
                 matches.push(entry);
+            }
         }
 
         if (matches.length > 0) {
             // return instance id in case of id matching
-            if (id)
+            if (id) {
                 return matches[0].i;
+            }
 
             // sort matched services in the registry by version
             matches.sort((a, b) => semver.rcompare(a.v, b.v));

package/src/Request.js

@@ -5,6 +5,7 @@ import { hash, sleep } from "./Util.js";
 import { RequestOptionsClass } from "./RequestOptions.js";
 import { isStream, streamToString } from "./Stream.js";
 import { inspect } from "node:util";
+import { logger } from "./Logger.js";
 
 const REGISTRY_TIMEOUT = 300000;
 
@@ -44,8 +45,9 @@ function getOriginator() {
     for (const item of stack) {
         const typeName = item.getTypeName();
 
-        if (Service.serviceClasses.includes(typeName))
+        if (Service.serviceClasses.includes(typeName)) {
             return `${typeName}.${item.getMethodName()}`;
+        }
     }
 }
 
@@ -64,8 +66,9 @@ export async function Request(service, method, args, context, options) {
     const { name, version, id } = match.groups;
 
     // allow passing RequestOptions as first arg
-    if (args?.length > 0 && args[0] instanceof RequestOptionsClass)
+    if (args?.length > 0 && args[0] instanceof RequestOptionsClass) {
         options = (args.shift())?.options;
+    }
 
     let identifier = null;
 
@@ -75,8 +78,9 @@ export async function Request(service, method, args, context, options) {
     let retries = Math.floor(registryTimeout / delay);
     while (identifier == null && retries-- > 0) {
         identifier = registry.getIdentifier(name, version, id);
-        if (!identifier)
+        if (!identifier) {
             await sleep(delay);
+        }
     }
 
     return directRequest(identifier, method, args, context, options, service);
@@ -108,10 +112,11 @@ export async function directRequest(identifier, method, args, context, options,
             options);
 
         // automatically process streamed response
-        if (isStream(response))
+        if (isStream(response)) {
             response = JSON.parse(await streamToString(response));
+        }
     } catch (e) {
-        console.debug("GxError: directRequest", inspect({
+        logger.debug("GxError: directRequest", inspect({
             originator, service: service ?? identifier, method, args, context, options,
             error: e, duration: Date.now() - requestBegin
         }));
@@ -119,12 +124,14 @@ export async function directRequest(identifier, method, args, context, options,
         throw e;
     }
 
-    if (!response)
+    if (!response) {
         throw Error("Request: invalid response");
+    }
 
     // got error?
-    if (response.e)
+    if (response.e) {
         throw Error(`Request: remote error: ${response.e}`);
+    }
 
     return response.r;
 }
@@ -147,10 +154,12 @@ export async function Publish(subject, payload) {
  * @returns 
  */
 export async function Subscribe(subject, callback) {
-    if (typeof callback !== "function")
+    if (typeof callback !== "function") {
         return;
+    }
 
     const subscription = await connection.subscribe(`gx.sub.${subject}`);
-    for await (const event of subscription)
+    for await (const event of subscription) {
         callback(event.data);
+    }
 }

package/src/RequestOptions.js

@@ -1,5 +1,6 @@
 export class RequestOptionsClass {
     options;
+
     constructor(options) {
         this.options = options;
     }