@nsshunt/stsappframework 3.0.103 → 3.0.105

package/src_working/processoptions.ts

@@ -1,164 +0,0 @@
-import { IServiceProcessContext } from '@nsshunt/stspublisherserver'
-//import { JSONObject } from '@nsshunt/stsutils'
-import express from 'express'
-
-import { IProcessBase } from './commonTypes'
-
-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
-
-    // Service details
-
-    serverType: STSServerType
-
-	/**
-	 * 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
-
-    useRedisAdaptor: boolean
-    
-    redisAdaptorUrl?: string
-
-    useRedisInstrumentationTransport?: boolean
-
-    redisInstrumentationTransportUrl?: string
-
-    workerExec?: string
-
-    /**
-     * Is this application using nodejs cluster mode?
-     */
-    clusterMode: boolean
-}

package/src_working/publishertransports/publishTransportDirect.ts

@@ -1,45 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0, @typescript-eslint/no-unused-vars: 0 */  // --> OFF
-
-//import Debug from "debug";
-//const debug = Debug(`proc:${process.pid}:PublishRESTServer`);
-
-import { IPublisherTransport, IInstrumentPayload } from '@nsshunt/stspublisherserver'
-import { IMKafkaManager } from './../kafka/IMKafkaManager'
-import { InfluxDBManager } from './../influxdb/influxDBManager'
-
-import { PublishTransportUtils } from './publishTransportUtils'
-
-export class PublishTransportDirect implements IPublisherTransport
-{
-    #influxDBManager: InfluxDBManager;
-    #IMkafkaManager: IMKafkaManager;
-
-    constructor()
-    {
-        this.#influxDBManager = new InfluxDBManager();
-        this.#IMkafkaManager = new IMKafkaManager();
-        this.#IMkafkaManager.Start();
-    }
-    
-    // Returns true for success or false for failure.
-    Publish = async (payload: IInstrumentPayload): Promise<boolean> =>
-    {
-        try {
-            const updatedContext = PublishTransportUtils.GetServiceContext(payload.context.nid);
-            payload.context = updatedContext as any;
-    
-            //this.#SendIPCMessageToMaster(InstrumentManagerEventName.UPDATE_INSTRUMENT_DATA, instrumentPayload)
-            this.#influxDBManager.OutputInfluxDB(payload);
-            this.#IMkafkaManager.OutputLogs(payload);
-
-            return true;
-        } catch (error)
-        {
-            return false;
-        }
-    }
-
-    async Close(): Promise<boolean> {
-        return true;
-    }
-}

package/src_working/publishertransports/publishTransportUtils.ts

@@ -1,53 +0,0 @@
-import { ServiceProcessContext } from './../commonTypes'
-import { ModelDelimeter } from '@nsshunt/stsutils'
-
-export class PublishTransportUtils
-{
-    static GetServiceContext(nid: string): ServiceProcessContext {
-        // Return null if no context is required
-        //return null;
-        if (nid === ModelDelimeter.ROOT) {
-            return { root: ModelDelimeter.ROOT };
-        }
-        const context: ServiceProcessContext = { nid };
-        const idsplit = nid.split(ModelDelimeter.SEPERATOR);
-
-        const serviceId = idsplit[0];
-        const serviceInstanceId = idsplit[1].split(ModelDelimeter.NID_SEPERATOR)[0];
-        const serviceInstanceProcessId = idsplit[1].split(ModelDelimeter.NID_SEPERATOR)[1];
-
-        const serviceIdSplit = serviceId.split(ModelDelimeter.COMPONENT_SEPERATOR);
-        const serviceName =serviceIdSplit[0]; // Defined in .env or environment variable
-        const serviceVersion = serviceIdSplit[1]; // Defined in .env or environment variable
-
-        context.serviceId = serviceId; // Service name and the service version
-
-        if (typeof serviceInstanceId != 'undefined') {
-            const serviceInstanceIdSplit = serviceInstanceId.split(ModelDelimeter.COMPONENT_SEPERATOR);
-            const sid = serviceInstanceIdSplit[0];
-            const hostName = serviceInstanceIdSplit[1];
-
-            context.serviceInstanceId = serviceInstanceId; // Service unique id and the host name
-            context.sid = sid; // Service unique id only, does not include host
-            context.hostName = hostName; // Service Instance Host Name
-
-            if (typeof serviceInstanceProcessId != 'undefined') {
-                const serviceInstanceProcessIdSplit = serviceInstanceProcessId.split(ModelDelimeter.COMPONENT_SEPERATOR);
-                const pid = parseInt(serviceInstanceProcessIdSplit[0]);
-                const ppid = parseInt(serviceInstanceProcessIdSplit[1]);
-                const isMaster = (pid === ppid ? true : false);
-
-                context.serviceInstanceProcessId = serviceInstanceProcessId; // Service Instance OS Process ID (parent process id)
-                context.pid = pid; // Service Instance OS Process ID (parent process id)
-                context.ppid = ppid; // Service Instance OS Parent Process ID if worker. Will be pid if parent process.
-                context.isMaster = isMaster; // True if is Master Process
-                context.isWorker = !isMaster; // True if is Worker Process
-                context.serviceName = serviceName; // Defined in .env or environment variable
-                context.serviceVersion = serviceVersion; // Defined in .env or environment variable
-                context.serviceInstanceId = serviceInstanceId; // unique service id with host
-            }
-        }
-
-        return context;
-    }
-}

package/src_working/server.ts

@@ -1,141 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0, @typescript-eslint/no-unused-vars: 0 */  // --> OFF
-import express, { Express, Request, Response, NextFunction } from 'express';
-
-import cors from 'cors';
-import cookieParser from 'cookie-parser';
-
-import { RequestLoggerMiddleware, RequestLoggerMiddlewareEventName } from '@nsshunt/stspublisherserver'
-
-import { ProcessOptions } from './processoptions'
-
-import { $Options } from '@nsshunt/stsconfig'
-const goptions = $Options()
-
-import { IProcessBase } from './commonTypes'
-import { Gauge, InstrumentGaugeTelemetry, InstrumentHistogramTelemetry, InstrumentVelocityTelemetry } from '@nsshunt/stsinstrumentation'
-
-import { ISocketRecord, ServerNetworkMiddleware, ServerNetworkMiddlewareEventName } from './middleware/serverNetworkMiddleware'
-
-export class STSExpressServer
-{
-    #app: Express;
-
-    constructor(options: ProcessOptions, stsApp: IProcessBase)
-    {
-        // Standard RequestLoggerMiddleware for all STS services
-        const requestLoggerMiddleware = new RequestLoggerMiddleware({ 
-            ignoresocketio: goptions.ignoresocketio 
-        });
-
-        const serverNetworkMiddleware = new ServerNetworkMiddleware({ 
-            name: (stsApp.options as ProcessOptions).serviceName,
-            outputDebug: false
-        });
-
-        serverNetworkMiddleware.on(ServerNetworkMiddlewareEventName.UpdateInstrument_SERVER_NET_VAL, (data: ISocketRecord) => {
-            //console.log(`serverNetworkMiddleware: [${JSON.stringify(data)}]`.magenta)
-            stsApp.UpdateInstrument(Gauge.NETWORK_RX_GAUGE, {
-                Inc: data.requestBytesRead
-            } as InstrumentGaugeTelemetry);
-
-            stsApp.UpdateInstrument(Gauge.NETWORK_TX_GAUGE, {
-                Inc: data.requestBytesWritten
-            } as InstrumentGaugeTelemetry);
-        });
-
-        requestLoggerMiddleware.on(RequestLoggerMiddlewareEventName.UpdateInstrument_AR_INC, () => {
-            stsApp.UpdateInstrument(Gauge.ACTIVE_REQUEST_GAUGE, {
-                Inc: 1
-            } as InstrumentGaugeTelemetry);
-        });
-
-        requestLoggerMiddleware.on(RequestLoggerMiddlewareEventName.UpdateInstrument_AR_DEC, () => {
-            stsApp.UpdateInstrument(Gauge.ACTIVE_REQUEST_GAUGE, {
-                Dec: 1
-            } as InstrumentGaugeTelemetry);
-        });
-
-        requestLoggerMiddleware.on(RequestLoggerMiddlewareEventName.UpdateInstrument_DH_VAL, (timeInMs) => {
-            stsApp.UpdateInstrument(Gauge.DURATION_HISTOGRAM_GAUGE, {
-                val: timeInMs
-            } as InstrumentHistogramTelemetry);
-        });
-
-        requestLoggerMiddleware.on(RequestLoggerMiddlewareEventName.UpdateInstrument_D_VAL, (timeInMs) => {
-            stsApp.UpdateInstrument(Gauge.DURATION_GAUGE, {
-                val: timeInMs
-            } as InstrumentHistogramTelemetry);
-        });
-
-        requestLoggerMiddleware.on(RequestLoggerMiddlewareEventName.UpdateInstrument_RC_INC, () => {
-            stsApp.UpdateInstrument(Gauge.REQUEST_COUNT_GAUGE, {
-                Inc: 1
-            } as InstrumentGaugeTelemetry);
-        });
-
-        requestLoggerMiddleware.on(RequestLoggerMiddlewareEventName.UpdateInstrument_V_INC, () => {
-            if (stsApp.InstrumentExists(Gauge.VELOCITY_GAUGE)) {
-                stsApp.UpdateInstrument(Gauge.VELOCITY_GAUGE, {
-                    Inc: 1
-                } as InstrumentVelocityTelemetry);
-            }
-        });
-
-        const app = express();
-        this.#app = app;
-
-        // https://stackoverflow.com/questions/19743396/cors-cannot-use-wildcard-in-access-control-allow-origin-when-credentials-flag-i
-        // See answer from Christoph Hansen is thread above ...
-        // https://expressjs.com/en/resources/middleware/cors.html
-        const corsConfig = {
-            credentials: true,
-            origin: true,
-        };
-
-        app.use(cors(corsConfig));
-
-        app.use(cookieParser())
-
-        app.use(express.urlencoded({ extended: false, limit: goptions.maxPayloadSize }));
-		
-        app.use(express.json({limit: goptions.maxPayloadSize}));
-
-        // Allow the static SPA to also be servered by this app
-        //app.use('/static', express.static(path.join(__dirname, 'public')))
-        if (options.expressServerRouteStaticFactory) {
-            options.expressServerRouteStaticFactory(app, stsApp);
-        }
-
-        app.use(requestLoggerMiddleware.Middleware.bind(requestLoggerMiddleware));
-
-        app.use(serverNetworkMiddleware.Middleware.bind(serverNetworkMiddleware));
-
-        if (options.expressServerRouteFactory) {
-            options.expressServerRouteFactory(app, stsApp);
-        }
-
-        // Express error handling fall-back
-        app.use(function(err: any, req: Request, res: Response, next: NextFunction) {
-            //@@ add to errors metric here - perhaps break down by type
-
-            if (err) {
-                //@@console.log(err);
-                res.status(err.status).send(err);
-            } else {
-                next();
-            }
-            /*
-			if(err.name === 'UnauthorizedError') {
-				res.status(401).send(err);
-			} else {
-				next();
-			}
-			*/
-        });
-    }
-
-    get App(): Express
-    {
-        return this.#app;
-    }
-}