@nsshunt/stsappframework 3.1.236 → 3.1.237

package/src/process/serverprocessbase.ts

@@ -1,455 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0, @typescript-eslint/no-unused-vars: 0 */  // --> OFF
-import chalk from 'chalk';
-
-import { goptions } from '@nsshunt/stsconfig'
-
-import fs from 'node:fs'
-
-import { JSONObject, Sleep } from '@nsshunt/stsutils'
-
-import { ProcessOptions, IServerProcessBase } from './../commonTypes'
-import { ProcessBase } from './processbase';
-
-import { register, Counter, collectDefaultMetrics, AggregatorRegistry } from 'prom-client'
-
-import { createServer as createServerHttps } from 'node:https'
-import { createServer } from 'node:http'
-import tls from 'node:tls'
-import net from 'node:net'
-
-import { Server, ServerOptions } from "socket.io";
-import { STSExpressServer } from './../stsexpressserver'
-import { Express } from 'express'
-
-import { createAdapter as clusterCreateAdapter } from '@socket.io/cluster-adapter'
-import { createAdapter } from "@socket.io/redis-streams-adapter";
-//import { ClusterAdapterWithHeartbeat } from 'socket.io-adaptor';
-
-//import { createAdapter } from "@socket.io/redis-adapter";
-
-import { createClient, RedisClientType } from 'redis';
-import { Redis } from 'ioredis';
-
-import jayson from 'jayson'
-
-import { STSTransportLoggerWinston } from './../logger/stsTransportLoggerWinston'
-
-/**
- * todo
- * @typedef {Object} options - todo
- * @property {boolean} [wssServer=false] - Create a web socket server on this worker instance
- */
-export abstract class ServerProcessBase extends ProcessBase implements IServerProcessBase
-{
-    #masterProcessExitTime = goptions.masterProcessExitTime;
-    #io: Server | null = null;
-    #redisClient: RedisClientType | Redis | null = null;
-    #httpServer: any = null;
-    #expressServer: STSExpressServer | null = null;
-    #sockets: net.Socket[] = [ ];
-    #shuttingDown = false;
-
-    constructor(options: ProcessOptions) {
-        super(options);
-    }
-
-    get httpServer() {
-        return this.#httpServer;
-    }
-
-    get io() {
-        return this.#io;
-    }
-
-    get expressServer(): STSExpressServer | null {
-        return this.#expressServer;
-    }
-    set expressServer(val: STSExpressServer | null) {
-        this.#expressServer = val;
-    }
-
-    // Setup server to Prometheus scrapes:
-    #SetupPrometheusEndPoints = (expressServer: Express) => {
-        // AggregatorRegistry is required here in the worker as well as the master in order for prom-client to work correctly.
-        new AggregatorRegistry();
-
-        const prefix = 'sts_';
-
-        collectDefaultMetrics({
-            labels: { NODE_APP_INSTANCE: process.pid },
-            prefix: prefix
-        });
-
-        const c = new Counter({
-            name: 'sts_test_counter',
-            help: 'Example of a counter',
-            labelNames: ['code'],
-        });
-
-        setInterval(() => {
-            c.inc({ code: 200 });
-        }, 1000).unref();
-
-        setInterval(() => {
-            c.inc({ code: 400 });
-            c.inc({ code: 'worker_' + process.pid });
-        }, 500).unref();
-
-        expressServer.get('/metrics', async (req: any, res: any) => {
-            try {
-                res.set('Content-Type', register.contentType);
-                res.end(await register.metrics());
-            } catch (ex) {
-                res.status(500).end(ex);
-            }
-        });
-
-        expressServer.get('/metrics/counter', async (req: any, res: any) => {
-            try {
-                res.set('Content-Type', register.contentType);
-                res.end(await register.getSingleMetricAsString('test_counter'));
-            } catch (ex) {
-                res.status(500).end(ex);
-            }
-        });
-    }
-
-    #SetupTLSServer = async (socket: net.Socket): Promise<void> => {
-        // Add a 'close' event handler to this instance of socket
-        this.LogInfoMessage('CONNECTED: ' + socket.remoteAddress + ':' + socket.remotePort + ' ' + process.pid);
-        this.#sockets.push(socket);
-
-        //const self = this;
-        socket.on('close', (data: any) => {
-            const index = this.#sockets.findIndex(function(o) {
-                return o.remoteAddress === socket.remoteAddress && o.remotePort === socket.remotePort;
-            })
-            if (index !== -1) this.#sockets.splice(index, 1);
-            this.LogInfoMessage('CLOSED: ' + socket.remoteAddress + ' ' + socket.remotePort + ' ' + process.pid);
-        });
-
-        socket.on('data', (data: any) => {
-            this.LogInfoMessage('DATA ' + socket.remoteAddress + ': ' + socket.remotePort + ': ' + data);
-            socket.write(socket.remoteAddress + ':' + socket.remotePort + " said " + data + '\n');
-
-            // Write the data back to all the connected, the client will receive it as data from the server
-            /*
-            self.#sockets.forEach(function(socket, index, array) {
-                socket.write(socket.remoteAddress + ':' + socket.remotePort + " said " + data + '\n');
-            });
-
-            */
-        });
-    }
-
-    #SetupRPCServer = async (socket: net.Socket): Promise<void> => {
-        this.LogInfoMessage('CONNECTED: ' + socket.remoteAddress + ':' + socket.remotePort + ' ' + process.pid);
-
-        socket.on('close', (data: any) => {
-            this.LogInfoMessage('CLOSED: ' + socket.remoteAddress + ' ' + socket.remotePort + ' ' + process.pid);
-        });
-
-        socket.on('data', (data: any) => {
-            this.LogInfoMessage('DATA ' + socket.remoteAddress + ': ' + data);
-        });
-    }
-
-    #SetupWSSServer = async (): Promise<void> => {
-        // socket.io
-        // WebSocket
-        const options: Partial<ServerOptions> = {
-            transports: [ "websocket" ] // or [ "websocket", "polling" ] (to use long-poolling. Note that the order matters)
-            // The default path is /socket.io
-            // This can be changed with the path option as shown below
-            //,path: '/zzz'
-        };
-
-        //this.#io = require("socket.io")(this.#httpServer, options);
-        this.#io = new Server(this.#httpServer, options);
-
-        if (this.options.useSocketIoRedisAdaptor) {
-            this.LogInfoMessage(`Using Redis for socket.io cluster management (worker)`);
-            if (this.options.socketIoRedisAdaptorUrl) {
-                this.LogInfoMessage(`Redis url: [${this.options.socketIoRedisAdaptorUrl}]`);
-                this.#redisClient = createClient({url: this.options.socketIoRedisAdaptorUrl});
-            } else {
-                this.LogInfoMessage(`Redis url: [localhost]`);
-                this.#redisClient = createClient();
-            }
-            await this.#redisClient.connect();
-
-            //this.#redisClient = new Redis(this.options.socketIoRedisAdaptorUrl as string);
-
-            this.#io.adapter(createAdapter(this.#redisClient));
-
-            this.LogInfoMessage(`Redis successfully connected.`);
-        } else {
-            if (this.options.clusterMode) {
-                this.#io.adapter(clusterCreateAdapter() as any);
-                this.LogInfoMessage(`Using nodejs cluster mode for socket.io cluster management`);
-            } else {
-                this.LogInfoMessage(`Not using any adaptors for socket.io cluster management.}`);
-            }
-        }
-
-        // To use a seperate socket server, the code below can be applied.
-        // this.#io = require("socket.io")(options);
-        // this.#io.adapter(createAdapter());
-        // this.#io.listen(3006);
-
-        this.#io.engine.on("connection_error", (err) => {
-            this.LogInfoMessage(err.req); // the request object
-            this.LogInfoMessage(err.code); // the error code, for example 1
-            this.LogInfoMessage(err.message); // the error message, for example "Session ID unknown"
-            this.LogInfoMessage(err.context); // some additional error context
-        });
-    }
-
-    #GetTLSOptions = (): JSONObject => {
-        return {
-            key: fs.readFileSync(this.options.httpsServerKeyPath),
-            cert: fs.readFileSync(this.options.httpsServerCertificatePath)
-        };
-    }
-
-    #SetupExpressServer = async (useTls: boolean): Promise<void> => {
-        if (useTls) {
-            this.#httpServer = createServerHttps(this.#GetTLSOptions(), (this.#expressServer as STSExpressServer).App);
-        } else {
-            this.#httpServer = createServer((this.#expressServer as STSExpressServer).App);
-        }
-        if (this.options.prometheusSupport === true) {
-            this.#SetupPrometheusEndPoints((this.#expressServer as STSExpressServer).App);
-        }
-        if (this.options.wssServer === true) {
-            await this.#SetupWSSServer();
-        }
-        // https://stackoverflow.com/questions/21342828/node-express-unix-domain-socket-permissions
-        //@@httpServer.listen('/tmp/stsrest01.sock').on('listening', () =>
-        //@@httpServer.listen('/var/run/sts/stsrest01.sock').on('listening', () =>
-        this.#httpServer.listen(this.options.listenPort, () => { 
-            //@@chmodSync(this.options.port, 511);
-        }).on('listening', () => {
-            this.LogInfoMessage(`live on ${this.options.endpoint}:${this.options.listenPort}${this.options.apiRoot}`);
-        });
-    }
-
-    #SetupTCPRawServer = async (): Promise<void> => {
-        // The second parameter is the automatic listener for the secureConnection event from the tls.Server class
-        this.#httpServer = tls.createServer(this.#GetTLSOptions(), this.#SetupTLSServer);
-        this.#httpServer.listen(this.options.listenPort, 'stscore.stsmda.org', () => { 
-            this.LogInfoMessage('TCP Server is running on port ' + this.options.listenPort + '.');
-        }).on('listening', () => {
-            this.LogInfoMessage(`TCP live on ${this.options.endpoint}:${this.options.listenPort}${this.options.apiRoot}`);
-        });
-    }
-
-    #SetupJSONRPCServer = async (): Promise<void> => {
-        const jaysonServer = new jayson.server();
-        // Supported methods here - move somewhere else ...
-        jaysonServer.method("add", function(args: any, callback: any) {
-            callback(null, args[0] + args[1]);
-        });
-        this.#httpServer = jaysonServer.tls(this.#GetTLSOptions());
-        (this.#httpServer as tls.Server).on('secureConnection', this.#SetupRPCServer);
-        this.#httpServer.listen(this.options.listenPort, 'stscore.stsmda.org', () => { 
-            this.LogInfoMessage('JSON RPC 2.0 Server is running on port ' + this.options.listenPort + '.');
-        }).on('listening', () => {
-            this.LogInfoMessage(`JSON RPC 2.0 live on ${this.options.endpoint}:${this.options.listenPort}${this.options.apiRoot}`);
-        });
-    }
-
-    override get shuttingDown(): boolean {
-        return this.#shuttingDown;
-    }
-
-    TerminateSocketIO = async (): Promise<void> => {
-        if (this.options.wssServer === true && this.#io !== null) {
-            const logPrefix = `ServerProcessBase:TerminateSockets():${process.pid}:`;
-            this.LogInfoMessage(`${logPrefix} Disconnect SocketIO Sockets.`);
-            await Sleep(250);
-            await this.#io?.of('/').adapter.close();
-            if (this.socketIoServerHelper !== null) {
-                await this.socketIoServerHelper.CloseAdaptors();
-                await Sleep(50);
-                if (this.#redisClient) {
-                    this.#redisClient.disconnect();
-                    await Sleep(50);
-                }
-                this.LogInfoMessage(`${logPrefix} this.socketIoServerHelper.DisconnectSockets()`);
-                await this.socketIoServerHelper.DisconnectSockets();
-            } else {
-                this.LogInfoMessage(`${logPrefix} this.#io.disconnectSockets()`);
-                if (this.#redisClient) {
-                    this.#redisClient.disconnect();
-                    await Sleep(50);
-                }
-                this.#io.disconnectSockets();
-            }
-            this.socketIoServerHelper = null;
-            this.#io = null;
-        }
-    }
-
-    TerminateHTTPServer = async (): Promise<void> => {
-        const logPrefix = `ServerProcessBase:TerminateHTTPServer():${process.pid}:`;
-        if (this.#httpServer !== null) {
-            if (goptions.STSServerType.localeCompare('TCPRAW_TLS') === 0) {
-                this.#sockets.forEach((socket: net.Socket, index, array) => {
-                    this.LogInfoMessage(chalk.yellow(`${logPrefix} TCP Socket destroy, remote address: [${socket.remoteAddress}], remote port: [${socket.remotePort}]`));
-                    socket.destroy();
-                    //socket.end();
-                });
-            }
-            this.LogInfoMessage(`${logPrefix} Closing httpServer.`);
-            await this.#httpServer.close();
-            this.#httpServer = null;
-        }
-    }
-
-    // Terminate in order;
-    // forked worker threads (send signal)
-    // De-Register service
-    // systeminformation observers
-    // instrument timers (gauge etc.)
-    // publisher
-    // terminate UI (if loaded)
-    Terminate = async (clusterPerformExit: boolean, signal?: any): Promise<void> => {
-        const logPrefix = `ServerProcessBase:Terminate():${process.pid}:`;
-        if (this.#shuttingDown === false) {
-            this.#shuttingDown = true;
-
-            if (signal) {
-                this.LogInfoMessage(this.GetSignalColour(signal)(`${logPrefix} Received signal: ${signal}`));
-            } else {
-                this.LogInfoMessage(this.GetSignalColour(null)(`${logPrefix} Received Terminate without signal.`));
-            }
-
-            await this.ProcessTerminate();
-
-            this.TerminateUIController();
-
-            await this.TerminateSocketIO();
-
-            await this.TerminateHTTPServer();
-            
-            await this.TerminateDatabase();
-
-            // Output final messages here (before TerminateInstrumentController)
-            if (this.options.clusterMode) {
-                this.LogInfoMessage(`${logPrefix} clusterPerformExit value: [${clusterPerformExit}]`);
-                if (clusterPerformExit) {
-                    this.LogInfoMessage(`${logPrefix} Process will self terminate with process.exit(0).`);
-                } else {
-                    this.LogInfoMessage(`${logPrefix} Child process will not self terminate. Terminate will be handled by master process.`);
-                }
-            }
-
-            this.TerminateInstrumentController();
-
-            //@@ always return here appears to always cleanly exit
-            // and cleanly exit from socket.io cluster adaptor
-            // without return here, socket.io cluster adaptor terminates in an error state
-            // as the implementation relies on cluster.on to send messages to worker threads
-            // but these have already been closed from the process.exit(0) below.
-
-            await Sleep(1000); // Allow socket.io time to clean-up
-
-            if (this.options.clusterMode === true) {
-                if (clusterPerformExit === true) {
-                    setTimeout(() => {
-                        process.exit(0);
-                    }, 0);
-                } 
-            } else {
-                this.ProcessExit(this.#masterProcessExitTime);
-            }
-        } else {
-            this.LogInfoMessage(`${logPrefix} Process already terminating.`);
-        }
-    }
-
-    async SetupServer(): Promise<boolean> {
-        return new Promise((resolve, reject) => {
-            try {
-                this.SetupInstrumentation();
-                setTimeout(async () => {
-                    try {
-                        await this.SetupServerEx();
-                        resolve(true);
-                    } catch (error) {
-                        reject(error);
-                    }
-                }, 100);
-            } catch (error) {
-                reject(error);
-            }
-        })
-    }
-
-    ProcessStarted() {
-        const transport = new STSTransportLoggerWinston({
-            stsApp: this
-        });
-        setTimeout(() => {
-            (this.options.logger as any).add(transport);
-        }, 0);
-    }
-
-    async SetupServerEx(): Promise<boolean> {
-        this.LogInfoMessage(chalk.green(`ServerProcessBase:SetupServerEx(): Main Process:${process.pid} Starting ...`));
-
-        this.ProcessStartup();
-
-        if (this.options.expressServerRouteFactory || this.options.expressServerRouteStaticFactory) {
-            this.expressServer = new STSExpressServer(this.options, this);
-        }
-
-        this.LogInfoMessage(`ServerProcessBase:SetupServerEx(): Worker instance starting. Service instance Id: [${this.options.serviceInstanceId}]`);
-
-        // Signal Codes
-        // https://en.wikipedia.org/wiki/Signal_(IPC)
-        process.on('SIGTERM', async () => {
-            this.LogInfoMessage(`ServerProcessBase:SetupServerEx(): SIGTERM signal received for worker: ${process.pid}`);
-            await this.Terminate(true, true);
-        });
-
-        process.on('SIGINT', async () => {
-            this.LogInfoMessage(`ServerProcessBase:SetupServerEx(): SIGINT signal received for worker: ${process.pid}`);
-            await this.Terminate(true, true);
-        });
-
-        process.on('exit', (code) => {
-            if (code === 0) {
-                this.LogInfoMessage(chalk.green(`ServerProcessBase:SetupServerEx(): Process: ${process.pid} terminated gracefully with code: ${code}`));
-            } else {
-                this.LogInfoMessage(chalk.red(`ServerProcessBase:SetupServerEx(): Process: ${process.pid} terminated with code: ${code}`));
-            }
-        });
-
-        await this.SetupSTSServer();
-        
-        this.ProcessStarted();
-
-        this.LogInfoMessage(chalk.green(`ServerProcessBase:SetupServerEx(): Main Process:${process.pid} Started`));
-
-        return true;
-    };
-
-    SetupSTSServer = async(): Promise<void> => {
-        switch (goptions.STSServerType) {
-        case 'EXPRESS' :
-            await this.#SetupExpressServer(false);
-            break;
-        case 'EXPRESS_TLS' :
-            await this.#SetupExpressServer(true);
-            break;
-        case 'TCPRAW_TLS' :
-            await this.#SetupTCPRawServer();
-            break;
-        case 'JSONRPC2_TLS' :
-            await this.#SetupJSONRPCServer();
-            break;
-        }
-    }
-}

package/src/process/singleprocessbase.ts

@@ -1,63 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0 */  // --> OFF
-import { goptions } from '@nsshunt/stsconfig'
-
-import { Gauge, GaugeTypes, InstrumentGaugeOptions, InstrumentGaugeTelemetry } from '@nsshunt/stsobservability'
-
-import { ISingleProcessBase, ProcessOptions } from './../commonTypes';
-import { InstrumentDefinitions } from '@nsshunt/stsobservability'
-import { ServerProcessBase } from './serverprocessbase'
-
-import si from 'systeminformation' // https://systeminformation.io/
-
-export type EventCb = (socket: any, data: any) => void
-
-export class SingleProcessBase extends ServerProcessBase implements ISingleProcessBase
-{
-    /**
-	 * 
-	 * @param {SingleProcessBaseOptions} options 
-	 */
-    constructor(options: ProcessOptions) {
-        super(options)
-    }
-
-    override CollectAdditionalTelemetry(): void {
-        const siValueObject = {
-            currentLoad: 'currentLoad'
-        }
-        si.get(siValueObject).then(data => {
-            this.UpdateInstrument(Gauge.CPU_SYSTEM_LOAD_GAUGE, {
-                val: data.currentLoad.currentLoad
-            } as InstrumentGaugeTelemetry);
-        });
-    }
-
-    override GetAdditionalInstruments(): InstrumentDefinitions {
-        return [
-            [ Gauge.CPU_SYSTEM_LOAD_GAUGE, GaugeTypes.INSTRUMENT_GAUGE, {
-                interval: goptions.instrumentationObservationInterval, 
-                sampleSize: goptions.instrumentationTimeWindow
-            } as InstrumentGaugeOptions]
-        ]
-    }
-
-    /**
-	 * UIController (instance of UIController) to manage a console based user interface associated for this node application.
-	 * @returns UIController instance to manage a console based user interface associated for this node application. Null for no capability.
-	 */
-    override GetUIController(): any {
-        return null;
-    }
-
-    override SetupServerEx = async (): Promise<boolean> => {
-        await super.SetupServerEx();
-
-        this.LogSystemTelemetry();
-
-        return true;
-    }
-
-    async TerminateApplication() {
-        await this.Terminate(false, 'SIGINT');
-    }
-}