@nsshunt/stsappframework 3.0.103 → 3.0.105

package/src_new/commonTypes.ts

@@ -1,239 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0 */  // --> OFF
-import { Server, Socket, Namespace } from "socket.io";
-
-import { STSOptionsBase, JSONObject } from "@nsshunt/stsutils"
-import { PublishInstrumentControllerV2, InstrumentDefinitions } from '@nsshunt/stspublisherserver'
-import { InstrumentBaseTelemetry, Gauge, InstrumentBase } from '@nsshunt/stsinstrumentation'
-import { PGAccessLayer } from '@nsshunt/stsdatamanagement'
-import { STSDefaultClientToServerEvents, STSDefaultServerToClientEvents } from '@nsshunt/stssocketio-client'
-import { Consumer, IHeaders } from 'kafkajs'
-
-export enum IPCMessageCommand {
-    AddWorker = 'AddWorker',
-    DeleteWorker = 'DeleteWorker'
-}
-
-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 IProcessBase extends STSOptionsBase {
-    SetupInstrumentation(): void
-    GetAdditionalInstruments(): InstrumentDefinitions
-    CollectAdditionalTelemetry(): void
-    ProcessStartup: () => void
-    UpdateInstrument: (instrumentName: Gauge, telemetry: InstrumentBaseTelemetry) => void
-    get InstrumentController(): PublishInstrumentControllerV2 | null
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any    
-    LogEx: (message: any) => void
-    InstrumentExists(instrumentName: Gauge): boolean
-    ProcessTerminate: () => Promise<void>
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    GetUIController(): any
-    get socketIoServerHelper(): ISocketIoServerHelper<STSDefaultClientToServerEvents, STSDefaultServerToClientEvents> | null
-    set socketIoServerHelper(value: ISocketIoServerHelper<STSDefaultClientToServerEvents, STSDefaultServerToClientEvents> | null)
-    TerminateDatabase(): Promise<void>
-    get accessLayer(): PGAccessLayer | null
-    get shuttingDown(): boolean
-}
-
-export interface IMasterProcessBase extends IProcessBase {
-    // eslint-disable-next-line  @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
-    WorkerMessageEvent(msg: any): any
-    SetupServer: () => Promise<void>
-    SetupServerEx: () => Promise<void>
-    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
-    KillWorker: (id: string, signal: NodeJS.Signals, options: any, killProcess: boolean, allowKillAll: boolean) => boolean
-    KillWorkers: (signal: NodeJS.Signals) => void
-    IncWorkers: () => void
-    DecWorkers: () => void
-    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
-    AddWorker: (options: any) => number
-    MasterStarted(): void
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    BroadcastDataToWorkers: (command: any, data: any) => void
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    ProcessTerminating(): Promise<void>
-}
-
-export interface ISingleProcessBase extends IProcessBase {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    get httpServer(): any
-    CollectAdditionalTelemetry(): void
-    ProcessStarted(): any
-    get io(): any
-    ProcessTerminating(): Promise<void>
-    get expressServer(): any // STSExpressServer - need to put interface in common types - circular reference
-    SetupServer(): Promise<boolean>
-    SetupServerEx: () => Promise<void>
-    TerminateApplication(): Promise<void>
-}
-
-export interface IWorkerProcessBase extends IProcessBase {
-    get httpServer(): any
-    WorkerStarted(): any
-    // eslint-disable-next-line  @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
-    ReceivedMessageFromMaster(msg: any): void
-    CollectAdditionalTelemetry(): void
-    get io(): any
-    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
-    AddWorker: (options: any) => Promise<string>
-    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
-    DeleteWorker: (workerId: string, options: any) => Promise<JSONObject>
-    ProcessTerminating(): Promise<void>
-    get expressServer(): any
-    SetupServer: () => Promise<void>
-    SetupServerEx: () => Promise<void>
-}
-
-// -----------------------------------------------------------------------------
-
-export type ServerEventCb = (socket: any, data: any) => void
-
-export interface ServerSocketEvent {
-	serverEventName: string,
-	serverEventCb: ServerEventCb
-}
-
-export enum STSNamespace {
-	STSMonitor = 'stsmonitor',
-	STSControl = 'stscontrol'
-}
-
-export enum STSRoom {
-	// STSMonitor rooms
-	STSInstrumentDataRoom = 'stsinstrumentdataroom', // This room is for all instrument data messages
-	STSInstrumentDataSubscriptionRoom = 'stsinstrumentdatasubscriptionroom', // This room is only for subscribed instrument data messages
-
-	// STSControl rooms
-	STSRunnerRoom = 'stsrunnerroom',
-	STSNodeRunnerRoom = 'stsnoderunnerroom'
-}
-
-export enum STSEvent {
-	// STSInstrumentData
-	STSInstrumentData = 'stsinstrumentdata',
-	STSSubInstrumentData = 'stssubinstrumentdata', // sub-scribed instrument data. This only outputs the nodes that have been subscribed by the client(s).
-	STSResetInstrumentData = 'stsresetinstrumentdata',
-
-	STSStartLoggingInstrumentData = 'stsStartLoggingInstrumentData',
-	STSStopLoggingInstrumentData = 'stsStopLoggingInstrumentData',
-
-	// STSRunner events
-	STSStart = 'stsstart', // Start a test run with options as payload.
-	STSStop = 'stsstop', // Stop test run(s).
-	STSPause = 'stspause', // Pause test run(s).
-	STSResume = 'stsresume', // Resume test run(s).
-	STSTerminate = 'ststerminate', // Terminate runner instances and exit applications.
-	// This may also be uysed to force trigger self healing (i.e. auto re-start) when
-	// running within a container orchestrator such as K8, K3 or Docker Swarm.
-	STSUpdateStaticConfig = 'stsupdatestaticconfig', // Update base configuration. Options as payload.
-	STSUpdateDynamicConfig = 'stsupdatedynamicconfig', // Update running configuration. This is used
-	// to control the runnning behaviour of test(s) in-flight. Options as payload.
-
-	STSSendToRoom = 'sendToRoom',
-
-	// Standard socket events
-	connect = 'connect'
-}
-
-// https://socket.io/docs/v4/typescript/
-
-export interface InterServerEvents {
-	ping: () => void;
-}
-
-export interface STSSocketIONamespace {
-	namespace: string
-	pid: number
-	socketionamespace: Namespace<STSDefaultClientToServerEvents, STSDefaultServerToClientEvents, InterServerEvents>
-}
-
-export type STSServerSocket = Socket<STSDefaultClientToServerEvents, STSDefaultServerToClientEvents, InterServerEvents>
-export type STSClientSocket = Socket<STSDefaultServerToClientEvents, STSDefaultClientToServerEvents, InterServerEvents>
-
-export interface ISocketIoServerHelper<ClientToServerEvents extends STSDefaultClientToServerEvents, ServerToClientEvents extends STSDefaultServerToClientEvents>
-{
-    LogMessage: (namespace: STSSocketIONamespace, message: string) => void
-    LeaveRoom: (namespace: STSSocketIONamespace, socket: STSServerSocket, room: STSRoom) => void
-    JoinRoom: (namespace: STSSocketIONamespace, socket: STSServerSocket, room: STSRoom) => void
-    SetupNamespace: (io: Server, namespace: STSNamespace, rooms: string[], autoJoinRooms: boolean, 
-        /* serverSocketEvents: ServerSocketEvent[], */
-        socketConnectCallBack: ((socket: Socket<ClientToServerEvents, ServerToClientEvents, InterServerEvents>) => void) | null,
-        socketEventsCallBack: ((socket: Socket<ClientToServerEvents, ServerToClientEvents, InterServerEvents>) => void) | null
-        ) => Namespace<ClientToServerEvents, ServerToClientEvents, InterServerEvents>
-    GetSTSSocketIONamespace: (namespace: any) => STSSocketIONamespace
-    DisconnectSockets: () => void
-    SetupEvent(event: ClientToServerEvents, eventCb: ServerEventCb): ISocketIoServerHelper<ClientToServerEvents, ServerToClientEvents>
-}
-
-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
-    }
-}
-
-export type Nid = string;
-
-export interface ContextBase extends JSONObject {
-	nid?: Nid
-}
-
-export interface ServiceProcessContext extends ContextBase {
-	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
-
-	// Left 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 interface InstrumentPayload {
-	//nid: string
-	context: ServiceProcessContext
-	instruments: Record<string, InstrumentBase>
-}
-
-export interface IKafkaConsumer {
-    get consumer(): Consumer
-    get id(): string
-    Connect(): Promise<void>
-    Disconnect(): Promise<void>
-    Subscribe: (topics: string[], fromBeginning: boolean) => Promise<void>
-    Stop: () => Promise<void>
-    StartConsumingMessages: (cb: (topic: string, key: string, partition: number, value: string, headers: IHeaders | undefined) => void) => Promise<void>
-}
-
-export type logFunction = (msg: any) => void
-

package/src_new/index.ts

@@ -1,22 +0,0 @@
-export * from './commonTypes'
-export * from './processoptions'
-export * from './authDefs'
-export * from './authutilsnode'
-export * from './stsrouterbase'
-export * from './stscontrollerbase'
-export * from './singleprocessbase'
-export * from './masterprocessbase'
-export * from './workerprocessbase'
-export * from './socketIoServerHelper'
-export * from './stslatencycontroller'
-export * from './stslatencyroute'
-export * from './kafka/kafkamanager'
-export * from './kafka/kafkaproducer'
-export * from './kafka/kafkaconsumer'
-export * from './kafka/IMKafkaManager'
-export * from './influxdb/influxDBManager'
-export * from './influxdb/influxDBManagerBase'
-export * from './influxdb/influxDBManagerService'
-export * from './influxdb/influxDBManagerAgent'
-export * from './publishertransports/publishTransportUtils'
-export * from './instrumentationsubscriber'