@nsshunt/stsappframework 3.2.1 → 3.2.3

package/runtest_ipc_legacy.sh

@@ -1,19 +0,0 @@
-#!/bin/sh
-# openssl req -nodes -new -x509 -keyout server.key -out server.cert
-clear; \
-export STS_PROJ_ROOT=./..; \
-STSENVFILE=$STS_PROJ_ROOT/stsglobalresources/.env \
-REST01_PORT=3003 \
-REST01_HOST_PORT=3003 \
-REST01_ENDPOINT="https://stscore.stsmda.org" \
-MAX_CPU=4 \
-AS_ENDPOINT=https://stscore.stsmda.org \
-AS_HOST_PORT=3002 \
-AS_PORT=3002 \
-DB_HOST=localhost:5432 \
-DB_PASSWORD=postgres \
-HTTPS_SERVER_KEY_PATH=/etc/letsencrypt/live/stsmda.org/privkey.pem \
-HTTPS_SERVER_CERT_PATH=/etc/letsencrypt/live/stsmda.org/fullchain.pem \
-DEBUG=proc* \
-UV_THREADPOOL_SIZE=64 \
-node dist/testing/app_ipc_legacy

package/runtest_ipcex.sh

@@ -1,19 +0,0 @@
-#!/bin/sh
-# openssl req -nodes -new -x509 -keyout server.key -out server.cert
-clear; \
-export STS_PROJ_ROOT=./..; \
-STSENVFILE=$STS_PROJ_ROOT/stsglobalresources/.env \
-REST01_PORT=3003 \
-REST01_HOST_PORT=3003 \
-REST01_ENDPOINT="https://stscore.stsmda.org" \
-MAX_CPU=4 \
-AS_ENDPOINT=https://stscore.stsmda.org \
-AS_HOST_PORT=3002 \
-AS_PORT=3002 \
-DB_HOST=localhost:5432 \
-DB_PASSWORD=postgres \
-HTTPS_SERVER_KEY_PATH=/etc/letsencrypt/live/stsmda.org/privkey.pem \
-HTTPS_SERVER_CERT_PATH=/etc/letsencrypt/live/stsmda.org/fullchain.pem \
-DEBUG=proc* \
-UV_THREADPOOL_SIZE=64 \
-node dist/testing/app_ipcex

package/runtest_redis.sh

@@ -1,19 +0,0 @@
-#!/bin/sh
-# openssl req -nodes -new -x509 -keyout server.key -out server.cert
-clear; \
-export STS_PROJ_ROOT=./..; \
-STSENVFILE=$STS_PROJ_ROOT/stsglobalresources/.env \
-REST01_PORT=3003 \
-REST01_HOST_PORT=3003 \
-REST01_ENDPOINT="https://stscore.stsmda.org" \
-MAX_CPU=4 \
-AS_ENDPOINT=https://stscore.stsmda.org \
-AS_HOST_PORT=3002 \
-AS_PORT=3002 \
-DB_HOST=localhost:5432 \
-DB_PASSWORD=postgres \
-HTTPS_SERVER_KEY_PATH=/etc/letsencrypt/live/stsmda.org/privkey.pem \
-HTTPS_SERVER_CERT_PATH=/etc/letsencrypt/live/stsmda.org/fullchain.pem \
-DEBUG=proc* \
-UV_THREADPOOL_SIZE=64 \
-node dist/testing/app

package/runtest_ww.sh

@@ -1,19 +0,0 @@
-#!/bin/sh
-# openssl req -nodes -new -x509 -keyout server.key -out server.cert
-clear; \
-export STS_PROJ_ROOT=./..; \
-STSENVFILE=$STS_PROJ_ROOT/stsglobalresources/.env \
-REST01_PORT=3003 \
-REST01_HOST_PORT=3003 \
-REST01_ENDPOINT="https://stscore.stsmda.org" \
-MAX_CPU=1 \
-AS_ENDPOINT=https://stscore.stsmda.org \
-AS_HOST_PORT=3002 \
-AS_PORT=3002 \
-DB_HOST=localhost:5432 \
-DB_PASSWORD=postgres \
-HTTPS_SERVER_KEY_PATH=/etc/letsencrypt/live/stsmda.org/privkey.pem \
-HTTPS_SERVER_CERT_PATH=/etc/letsencrypt/live/stsmda.org/fullchain.pem \
-DEBUG=proc* \
-UV_THREADPOOL_SIZE=64 \
-node dist/testing/app_ww

package/src/commonTypes.ts

@@ -1,374 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0 */  // --> OFF
-import express from 'express'
-
-import { JSONObject, ISTSLogger, ModelDelimeter, CheckValidChar } from "@nsshunt/stsutils"
-import { PublishInstrumentController, InstrumentDefinitions, 
-    IContextBase, InstrumentBaseTelemetry, Gauge} from '@nsshunt/stsobservability'
-
-import { STSDefaultClientToServerEvents, STSDefaultServerToClientEvents } from '@nsshunt/stssocketioutils'
-
-import { IDBAccessLayer } from '@nsshunt/stsdatamanagement'
-import { TinyEmitter } from "tiny-emitter";
-
-import { Worker, Address } from 'node:cluster'
-
-import { ISocketIoServerHelper } from '@nsshunt/stssocketioutils'
-
-export interface IServiceProcessContext extends IContextBase {
-	serviceId?: string // Service name and the service version
-
-	serviceInstanceId?: string // Service unique id and the host name
-	sid?: string // Service unique id only, does not include host
-	hostName?: string // Service Instance Host Name
-
-	// Leaf level attributes
-	serviceInstanceProcessId?: string // Service Instance OS Process ID (parent process id)
-	pid?: number // Service Instance OS Process ID (parent process id)
-	ppid?: number// Service Instance OS Parent Process ID if worker. Will be pid if parent process.
-	isMaster?: boolean // True if is Master Process
-	isWorker?: boolean // True if is Worker Process
-	serviceName?: string // Defined in .env or environment variable
-	serviceVersion?: string // Defined in .env or environment variable
-}
-
-export function CreateServiceProcessContext(serviceName: string, serviceVersion: string, serviceInstanceId: string,
-    hostName: string, processId: number, parentProcessId: number): IServiceProcessContext {
-
-    const checkParams = [
-        [ 'servicename', serviceName ], 
-        [ 'serviceversion', serviceVersion ],
-        [ 'hostname', hostName ],
-        [ 'serviceInstanceId', serviceInstanceId ]
-    ];
-    
-    // CHeck for invalid strings
-    CheckValidChar(checkParams);
-    
-    return {
-        nid: `\
-${serviceName}${ModelDelimeter.COMPONENT_SEPERATOR}${serviceVersion}\
-${ModelDelimeter.SEPERATOR}\
-${serviceInstanceId}${ModelDelimeter.COMPONENT_SEPERATOR}${hostName}\
-${ModelDelimeter.NID_SEPERATOR}\
-${processId.toString()}${ModelDelimeter.COMPONENT_SEPERATOR}${parentProcessId.toString()}`,
-        serviceName,
-        serviceVersion,
-        serviceInstanceId,
-        hostName,
-        processId: processId.toString(),
-        parentProcessId: parentProcessId.toString()
-    }
-}
-
-export enum IPCMessageCommand {
-    AddWorker = 'AddWorker',
-    DeleteWorker = 'DeleteWorker',
-    GetConfig = 'GetConfig'
-}
-
-export interface IPCMessagePayload {
-	requestResponse: boolean,
-	id: string,
-    command: IPCMessageCommand,
-	requestDetail?: JSONObject,
-    responseDetail?: JSONObject
-}
-
-export interface IPCMessage {
-	iPCMessagePayload: IPCMessagePayload
-	cb: () => void,
-	timeout: NodeJS.Timeout
-}
-
-export type IPCMessages = Record<string, IPCMessage>
-
-//------------------------------------
-
-export interface IProcessBaseEvents {
-    'processSigint': []
-    'processSigterm': []
-    'processExit': [ workerid: number ]
-
-    'ProcessTerminate': []
-
-    'clusterListening': [ worker: Worker, address: Address ];
-    'clusterOnline': [ worker: Worker ]
-    'clusterExit': [ worker: Worker, code: number, signal: string ]
-    'allListening': []
-
-    'workerMessage': [ id: number, payload: any ]
-    'workerError': [ error: Error ]
-    'workerAdded': [ id: number ]
-    'workerExit': [ code: number, signal: string ]
-
-    'prometheusScrapesListening': [ url: string, endpoint: string, prometheusClusterPort: string ]
-}
-
-export interface IProcessBase extends TinyEmitter {
-    SetupInstrumentation(): void
-    GetAdditionalInstruments(): InstrumentDefinitions
-    CollectAdditionalTelemetry(): void
-    ProcessStartup: () => void
-    UpdateInstrument: (instrumentName: Gauge, telemetry: InstrumentBaseTelemetry) => void
-    get InstrumentController(): PublishInstrumentController | null
-     
-    LogErrorMessage(message: any): void
-    LogInfoMessage(message: any): void
-    LogMessageToLoggerInstrument(message: any): void
-    InstrumentExists(instrumentName: Gauge): boolean
-    ProcessTerminate(): Promise<void>
-     
-    GetUIController(): any
-    get options(): ProcessOptions
-    get socketIoServerHelper(): ISocketIoServerHelper<STSDefaultClientToServerEvents, STSDefaultServerToClientEvents> | null
-    set socketIoServerHelper(value: ISocketIoServerHelper<STSDefaultClientToServerEvents, STSDefaultServerToClientEvents> | null)
-    TerminateDatabase(): Promise<void>
-    get accessLayer(): IDBAccessLayer | null
-    get shuttingDown(): boolean
-    //@@get redisMessageHandler(): RedisMessageHandler
-
-    emit<K extends keyof IProcessBaseEvents>(event: K, ...arg: IProcessBaseEvents[K]): this
-    on<K extends keyof IProcessBaseEvents>(event: K, callback: (...arg: IProcessBaseEvents[K]) => void): this
-    off<K extends keyof IProcessBaseEvents>(event: K, callback: (...arg: IProcessBaseEvents[K]) => void): this
-}
-
-export interface IMasterProcessBase extends IProcessBase {
-    WorkerMessageEvent(messageId: number, msg: any): any
-    SetupServer: () => Promise<void>
-    SetupServerEx: () => Promise<void>
-     
-    KillWorker: (id: string, signal: NodeJS.Signals, options: any, killProcess: boolean, allowKillAll: boolean) => boolean
-    KillWorkers: (signal: NodeJS.Signals, keepOne?: boolean) => void
-    IncWorkers: () => void
-    DecWorkers: () => void
-     
-    AddWorker: (options: any) => number
-    MasterStarted(): void
-     
-    BroadcastDataToWorkers: (command: any, data: any) => void
-    ProcessIPCCommand(iPCMessagePayload: IPCMessagePayload): Promise<IPCMessagePayload>
-}
-
-export interface IServerProcessBase extends IProcessBase {
-    get httpServer(): any
-    get io(): any
-    get expressServer(): STSExpressServer | null
-    set expressServer(server: STSExpressServer | null)
-    Terminate: (clusterPerformExit: boolean, signal?: any) => Promise<void>
-    SetupSTSServer: () => Promise<void>
-    CollectAdditionalTelemetry(): void
-    SetupServer(): Promise<boolean>
-    SetupServerEx: () => Promise<boolean>
-    ProcessStarted(): void
-}
-
-export interface ISingleProcessBase extends IServerProcessBase {
-    TerminateApplication(): Promise<void>
-}
-
-export interface IWorkerProcessBase extends IServerProcessBase {
-    ReceivedMessageFromMaster(msg: any): void
-    AddWorker: (options: any) => Promise<string>
-    DeleteWorker: (workerId: string, options: any) => Promise<JSONObject>
-    GetMasterProcessOptions: () => Promise<JSONObject>
-}
-
-// -----------------------------------------------------------------------------
-
-/*
-export interface IInfluxDBManagerOptions {
-    token: string // API access token
-    url: string // end-pont for API
-    org: string // organisation
-    bucket: string // bucket to store results
-    agent?: {
-        influxDB_keepAlive: boolean
-        influxDB_maxSockets?: number
-        influxDB_maxTotalSockets?: number
-        influxDB_maxFreeSockets?: number
-        influxDB_timeout?: number
-        influxDB_rejectUnauthorized?: boolean
-    }
-    logger: ISTSLogger
-}
-*/
-
-/*
-export type ConsumeMessageCB = (topic: string, partition: number, message: KafkaMessage, heartbeat: () => Promise<void>, pause: () => () => void) => void;
-export type ConsumeMessageErrorCB = (error: any) => void;
-
-export interface IKafkaConsumer {
-    get consumer(): Consumer
-    get id(): string
-    Connect(errorCb: (error: any) => void): Promise<void>
-    Disconnect(errorCb: (error: any) => void): Promise<void>
-    Subscribe: (topics: string[], fromBeginning: boolean, errorCb: (error: any) => void) => Promise<void>
-    Stop: (errorCb: (error: any) => void) => Promise<void>
-    StartConsumingMessages: (autoCommit: boolean, cb: ConsumeMessageCB, errorCb: ConsumeMessageErrorCB) => Promise<void>
-}
-*/
-
-export const iss = `https://stscore.stsmda.org/oauth2/v2.0`;
-
-export interface STSExpressServer {
-	get App(): express.Express
-}
-
-/**
- * Factory method that adds express routes to the express app object.
- */
-export type ExpressRouteFactory = (app: express.Express, stsApp: IProcessBase) => void
-
-/*
-export enum STSServerType {
-    NONE = "NONE",
-    EXPRESS = "EXPRESS",
-    EXPRESS_TLS = "EXPRESS_TLS",
-	TCPRAW_TLS = "TCPRAW_TLS",
-    JSONRPC2_TLS = "JSONRPC_TLS"
-}
-*/
-
-//export interface ProcessOptions extends JSONObject {
-export interface ProcessOptions {
-        /**
-     * Is this service worker the master worker (thread).
-     */
-    isMaster: boolean
-
-    /**
-     * Unique service instance ID (uuidv4).
-     */
-	serviceInstanceId: string
-
-	/**
-	 * HTTPS service public key path.
-	 */
-    httpsServerKeyPath: string
-
-	/**
-	 * HTTPS service certificate (private key) path.
-	 */
-    httpsServerCertificatePath: string
-
-    /**
-     * Determines whether the process will explicitly exit (using code 0) when any terminate signal is received.
-     */
-    processExitOnTerminate: boolean
-
-    /**
-     * Does this service run a Web Socket Server (wss).
-     */
-    wssServer: boolean
-
-	/**
-	 * Service Prometheus metric support.
-	 */
-    prometheusSupport: boolean
-
-	/**
-	 * Service endpoint (without trailing /). Example: https://localhost
-	 */
-    endpoint: string
-
-	/**
-	 * Service API root (without trailing /). Example: /stsrest01/v1
-	 */
-    apiRoot: string
-
-    /**
-     * Service listen port. Example: 3001.
-     * Note that unix domain sockets are also supported. Example: /tmp/stsrest01.sock.
-     * The socket file may also need permissions changed, i.e. chmodSync(port, 511); or chmodSync(port, 777);
-     * Axios client calls will also need to use socketPath. Example:  ..., socketPath: '/tmp/stsrest01.sock'
-     * Ref: https://stackoverflow.com/questions/21342828/node-express-unix-domain-socket-permissions
-     * To setup side car service (per running machine/node)
-     * sudo mkdir /var/run/sts
-     * sudo chown marcusbettens /var/run/sts
-     * In .env file per service
-     * PORT=/var/run/sts/stsrest01.sock
-     */
-    listenPort: string
-
-    /**
-     * Port that this service will be exposed externally on, i.e. clients will use this port to invoke APIs on this service.
-     */
-    port: string
-
-	/**
-	 * Prometheus Cluster Server port (port used for cluster prometheus scrapes). Example: 3011.
-	 */
-    prometheusClusterPort: string
-
-	/**
-	 * Service Name. Example: Rest01
-	 */
-    serviceName: string
-
-    /**
-	 * Service Version. Example: 1.0.0
-	 */
-    serviceVersion: string
-
-    /**
-     * Determines where logging is output to the console (stdout).
-     */
-    consoleLogging: boolean
-
-    /**
-     * Determines where logging is output to the logging instrument (if present).
-     */
-    instrumentLogging: boolean
-    
-    // Publisher options.
-
-    serviceProcessContext?: IServiceProcessContext
-
-    /**
-     * Factory method that adds express routes to the express app object. Used for non-static content.
-     * Non-Static content is applied after logging middleware.
-     */
-    expressServerRouteFactory?: ExpressRouteFactory
-
-    /**
-     * Factory method that adds express routes to the express app object for static content.
-     * Static content is applied before logging middleware.
-     */
-    expressServerRouteStaticFactory?: ExpressRouteFactory
-
-    /**
-     * Determines whether the service will monitor its own health via the /latency API endpoint.
-     * Note: The service must implement the /latency end-point for this to work.
-     */
-    useLatency: boolean
-
-    /**
-     * Determines whether this service is going to need database access.
-     */
-    useDatabase: boolean
-
-    instrumentationObservationInterval: number
-
-    instrumentationTimeWindow: number
-
-    useSocketIoRedisAdaptor: boolean
-    
-    socketIoRedisAdaptorUrl?: string
-
-    useRedisInstrumentationTransport?: boolean
-    
-    redisInstrumentationTransportUrl?: string
-
-    workerExec?: string
-
-    /**
-     * Is this application using nodejs cluster mode?
-     */
-    clusterMode: boolean
-
-    logger: ISTSLogger
-
-    publisherLogger: ISTSLogger
-
-    publishInterval: number
-}

package/src/controller/stscontrollerbase.ts

@@ -1,14 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0 */  // --> OFF
-import { IProcessBase } from './../commonTypes';
-
-export abstract class STSControllerBase {
-    #stsApp: any;
-
-    constructor(stsApp: IProcessBase) {
-        this.#stsApp = stsApp;
-    }
-
-    get stsApp(): IProcessBase {
-        return this.#stsApp
-    }
-}

package/src/controller/stslatencycontroller.ts

@@ -1,26 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0 */  // --> OFF
-import { StatusCodes } from 'http-status-codes'
-import { STSControllerBase } from './stscontrollerbase'
-import { IProcessBase } from './../commonTypes'
-
-export class STSLatencyController extends STSControllerBase {
-    constructor(stsApp: IProcessBase) {
-        super(stsApp);
-    }
-
-    // curl http://localhost:3000/api/v1/latency/latency
-    async stslatency(req: any, res: any)
-    {
-        try {
-            const retVal = { 
-                data: `Ping Completed At: ${Date.now()}`,
-                pid: process.pid,
-                ppid: process.ppid
-            };
-            return res.status(StatusCodes.OK).send(retVal);
-        } catch (error) {
-            this.stsApp.LogErrorMessage(error);
-            return res.status(StatusCodes.INTERNAL_SERVER_ERROR).send( { status: StatusCodes.INTERNAL_SERVER_ERROR, error: 'Operation was not successful', detail: error } );
-        }
-    }
-}

package/src/index.ts

@@ -1,13 +0,0 @@
-export * from './commonTypes'
-export * from './process/masterprocessbase'
-export * from './process/processbase'
-export * from './process/serverprocessbase'
-export * from './process/singleprocessbase'
-export * from './process/workerprocessbase'
-export * from './controller/stscontrollerbase'
-export * from './controller/stslatencycontroller'
-export * from './route/stslatencyroute'
-export * from './route/stsrouterbase'
-export * from './publishertransports/publishTransportUtils'
-export * from './logger/stsTransportLoggerWinston'
-export * from './logger/stsTransportWinston'

package/src/logger/stsTransportLoggerWinston.ts

@@ -1,24 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0 */  // --> OFF
-import Transport, { TransportStreamOptions } from 'winston-transport'
-
-import { IProcessBase } from './../commonTypes'
-
-export interface ISTSTransportLoggerWinstonOptions extends TransportStreamOptions {
-    stsApp: IProcessBase
-}
-
-export class STSTransportLoggerWinston extends Transport {
-
-    #options: ISTSTransportLoggerWinstonOptions;
-
-    constructor(opts: ISTSTransportLoggerWinstonOptions) {
-        super(opts);
-        this.#options = opts;
-    }
-  
-    log(info: any, callback: any) {
-        this.#options.stsApp.LogMessageToLoggerInstrument(info.message);
-        this.emit('logged', info);
-        callback();
-    }
-}

package/src/logger/stsTransportWinston.ts

@@ -1,48 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0 */  // --> OFF
-import Transport, { TransportStreamOptions } from 'winston-transport'
-
-import debugModule from 'debug'
-
-export interface ISTSTransportWinstonOptions extends TransportStreamOptions {
-    stsContext: string
-    debugger?: debugModule.Debugger
-}
-
-export function UpdateSTSTransportWithDebugger(logger: any, newDebugger: any): void {
-    const stsTransport: Transport | undefined = logger.transports.find((transport: any) => {
-        return transport instanceof STSTransportWinston
-    });
-    if (stsTransport) {
-        (stsTransport as STSTransportWinston).debugger = newDebugger
-    }
-}
-
-export class STSTransportWinston extends Transport {
-
-    #options: ISTSTransportWinstonOptions;
-
-    constructor(opts: ISTSTransportWinstonOptions) {
-        super(opts);
-        this.#options = opts;
-    }
-
-    get debugger() : debugModule.Debugger | undefined {
-        return this.#options.debugger;
-    }
-
-    set debugger(newDebugger: debugModule.Debugger) {
-        this.#options.debugger = newDebugger;
-    }
-  
-    log(info: any, callback: any) {
-        //setImmediate(() => {
-        if (info[Symbol.for('level')] == 'debug') {
-            if (this.#options.debugger) {
-                this.#options.debugger(info.message);
-            }
-        }
-        this.emit('logged', info);
-        callback();
-        //});
-    }
-}

package/src/network.ts

@@ -1,36 +0,0 @@
-import os from 'os'
-
-export type NetworkInterfaces = Record<string, string[]>
-
-export function GetNetworkInterfaces(): NetworkInterfaces {
-    const nets = os.networkInterfaces();
-    const results: NetworkInterfaces = { };
-    for (const name of Object.keys(nets)) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        for (const net of nets[name] as any) {
-            // Skip over non-IPv4 and internal (i.e. 127.0.0.1) addresses
-            if (net.family === 'IPv4' && !net.internal) {
-                if (!results[name]) {
-                    results[name] = [];
-                }
-                results[name].push(net.address);
-            }
-        }
-    }
-    return results;
-}
-
-export function GetFirstNetworkInterface(): string | null {
-    const nics: NetworkInterfaces = GetNetworkInterfaces();
-    let hostaddr = null;
-    for (const nic in nics)
-    {
-        const val: string[] = nics[nic];
-        if (val.length > 0)
-        {
-            hostaddr = val[0];
-            break;
-        }
-    }
-    return hostaddr;
-}