@nsshunt/stsappframework 3.1.236 → 3.1.237

package/src/middleware/serverNetworkMiddleware.ts

@@ -1,243 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0, @typescript-eslint/no-unused-vars: 0 */  // --> OFF
-import chalk from 'chalk'; // Note: Do NOT upgrade beyond 4.1.2 as the ESM version (5.0.0+) breaks this entire codebase
-import { Request, Response, NextFunction } from 'express'
-import { Socket } from 'node:net'
-import { TinyEmitter } from 'tiny-emitter';
-
-import { ISTSLogger, STSOptionsBase } from '@nsshunt/stsutils';
-
-import { v4 as uuidv4 } from 'uuid';
-import onHeaders  from 'on-headers';
-
-export enum ServerNetworkMiddlewareEventName {
-    UpdateInstrument_SERVER_NET_VAL = 'UpdateInstrument_SERVER_NET_VAL' // request net stats
-}
-
-export interface ISocketRecord {
-    id: string
-    socket: Socket,
-    currentBytesRead: number
-    currentBytesWritten: number
-    lastBytesRead: number
-    lastBytesWritten: number
-    requestBytesRead: number
-    requestBytesWritten: number
-    originalUrl: string
-    eventName: string
-}
-
-export type ServerNetworkMiddlewareEventFunc = (data: ISocketRecord) => void;
-
-export interface IServerNetworkMiddleware {
-    name: string
-    outputDebug: boolean
-    logger: ISTSLogger
-}
-
-export class ServerNetworkMiddleware extends STSOptionsBase
-{
-    #tinyEmitter: TinyEmitter = new TinyEmitter();
-    #socketCollection: Record<string, ISocketRecord> = { };
-    #id: string = '';
-
-    constructor(options: IServerNetworkMiddleware) {
-        super(options);
-    }
-
-    #LogSillyMessage(message: any) {
-        this.options?.logger.silly(message);
-    }
-
-    #LogErrorMessage(message: any) {
-        this.options?.logger.error(message);
-    }
-
-    on(eventName: ServerNetworkMiddlewareEventName, callBackFn: ServerNetworkMiddlewareEventFunc) {
-        this.#tinyEmitter.on(eventName, callBackFn);
-    }
-
-    GetSocketRecord = (socket: Socket): ISocketRecord | null => {
-        for (const [, socketRecord] of Object.entries(this.#socketCollection)) {
-            if (socketRecord.socket === socket) {
-                return socketRecord;
-            }
-        }
-        return null;
-    }
-
-    UpdateNetworkStats = (workingSocketRecord: ISocketRecord, eventName: string, req: Request) => {
-        workingSocketRecord.originalUrl = req.originalUrl;
-        workingSocketRecord.eventName = eventName;
-
-        workingSocketRecord.currentBytesRead = req.socket.bytesRead;
-        workingSocketRecord.currentBytesWritten = req.socket.bytesWritten;
-
-        workingSocketRecord.requestBytesRead = workingSocketRecord.currentBytesRead - workingSocketRecord.lastBytesRead;
-        workingSocketRecord.requestBytesWritten = workingSocketRecord.currentBytesWritten - workingSocketRecord.lastBytesWritten;
-
-        //this.#LogDebugMessage(chalk.gray(`totalBytesRead: [${workingSocketRecord.id}] [${workingSocketRecord.originalUrl}] [${eventName}] [${workingSocketRecord.requestBytesRead}]`));
-        //this.#LogDebugMessage(chalk.gray(`totalBytesWritten: [${workingSocketRecord.id}] [${workingSocketRecord.originalUrl}] [${eventName}] [${workingSocketRecord.requestBytesWritten}]`));
-
-        const workingSocketEventRecord = { ...workingSocketRecord };
-        delete (workingSocketEventRecord as any).socket;
-
-        this.#LogSillyMessage(chalk.gray(`Sending event: [${JSON.stringify(workingSocketEventRecord)}]`));
-
-        this.#tinyEmitter.emit(ServerNetworkMiddlewareEventName.UpdateInstrument_SERVER_NET_VAL, workingSocketEventRecord);
-
-        workingSocketRecord.lastBytesRead = workingSocketRecord.currentBytesRead;
-        workingSocketRecord.lastBytesWritten = workingSocketRecord.currentBytesWritten;
-    }
-
-    #GetRequestContentSize = (req: Request) => {
-        try {
-            let contentLength = 0;
-            if ((req as any)['_contentLength']) {
-                contentLength = (req as any)['_contentLength'];
-            } else {
-                if (req.headers['content-length']) {
-                    contentLength = parseInt(req.headers['content-length'])
-                }
-            }
-            return contentLength;
-        } catch (error) {
-            this.#LogErrorMessage(chalk.red(`ServerNetworkMiddleware:#GetRequestContentSize(): Error: [${error}]`));
-            return 0;
-        }
-    }
-
-    Middleware = (req: Request, res: Response, next: NextFunction) => {
-        let workingSocketRecord: ISocketRecord | null = null;
-        
-        workingSocketRecord = this.GetSocketRecord(req.socket);
-
-        if (!workingSocketRecord) {
-            this.#id = uuidv4();
-            workingSocketRecord = {
-                id: `${(this.options as IServerNetworkMiddleware).name}_${this.#id.toString()}`,
-                socket: req.socket,
-                currentBytesRead: 0,
-                currentBytesWritten: 0,
-                lastBytesRead: 0,
-                lastBytesWritten: 0,
-                requestBytesRead: 0,
-                requestBytesWritten: 0,
-                originalUrl: req.originalUrl,
-                eventName: '',
-            };
-
-            this.#socketCollection[workingSocketRecord.id] = workingSocketRecord;
-
-            this.#LogSillyMessage(chalk.gray(`Adding new socket to recordset: ID: [${workingSocketRecord.id}], originalUrl: [${workingSocketRecord.originalUrl}]`));
-
-            workingSocketRecord.socket.on('data', () => {
-                const socketRecord = this.GetSocketRecord((workingSocketRecord as ISocketRecord).socket);
-                if (socketRecord) {
-                    this.#LogSillyMessage(chalk.gray(`Socket data event: ID: [${socketRecord.id}], originalUrl: [${socketRecord.originalUrl}]`));
-                    this.UpdateNetworkStats(socketRecord, 'socket_data', req);
-                } else {
-                    this.#LogSillyMessage(chalk.magenta(`Socket data event: Could not find socket within recordset`));
-                }
-            });
-
-            workingSocketRecord.socket.on('close', () => {
-                const socketRecord = this.GetSocketRecord((workingSocketRecord as ISocketRecord).socket);
-                if (socketRecord) {
-                    this.#LogSillyMessage(chalk.gray(`Socket close event: ID: [${socketRecord.id}], originalUrl: [${socketRecord.originalUrl}]`));
-                    this.UpdateNetworkStats(socketRecord, 'socket_close', req);
-                    delete this.#socketCollection[socketRecord.id];
-                    this.#LogSillyMessage(chalk.gray(`Socket removed from recordset: ID: [${socketRecord.id}], originalUrl: [${socketRecord.originalUrl}]`));
-                } else {
-                    this.#LogSillyMessage(chalk.magenta(`Socket close event: Could not find socket within recordset`));
-                }
-            });
-
-            workingSocketRecord.socket.on('end', () => {
-                const socketRecord = this.GetSocketRecord((workingSocketRecord as ISocketRecord).socket);
-                if (socketRecord) {
-                    this.#LogSillyMessage(chalk.gray(`Socket end event: ID: [${socketRecord.id}], originalUrl: [${socketRecord.originalUrl}]`));
-                    this.UpdateNetworkStats(socketRecord, 'socket_end', req);
-                } else {
-                    this.#LogSillyMessage(chalk.magenta(`Socket end event: Could not find socket within recordset`));
-                }
-            });
-        }
-
-        // The following gets the payload size from adding _contentLength or content-length to the header size.
-        // From brief observations, this appears to be about 80 bytes short from what is reported by the socket writtenBytes.
-        onHeaders(res, () => {
-            let contentLength = 0;
-            if ((res as any)['_contentLength']) {
-                contentLength = (res as any)['_contentLength'];
-            } else {
-                if (res.hasHeader('content-length')) {
-                    contentLength = parseInt(res.getHeader('content-length') as string);
-                }
-            }
-
-            // Ensure that the client does NOT cache the response
-            res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate'); // HTTP 1.1
-            res.setHeader('Pragma', 'no-cache'); // HTTP 1.0
-            res.setHeader('Expires', '0'); // Proxies
-
-            const headerLength = JSON.stringify(res.getHeaders()).length;
-            const totalSize = contentLength + headerLength;
-
-            this.#LogSillyMessage(chalk.white.bgBlue(`contentLength: [${contentLength}], headerLength: [${headerLength}], total Size: [${totalSize}]`));
-        });
-
-        // This event is the one where bytesWritten is generally recorded
-        req.on('end', () => {
-            const socketRecord = this.GetSocketRecord(req.socket);
-            if (socketRecord) {
-                this.#LogSillyMessage(chalk.gray(`Request end event: ID: [${socketRecord.id}], originalUrl: [${socketRecord.originalUrl}]`))
-                this.UpdateNetworkStats(socketRecord, 'req_end', req);
-            } else {
-                this.#LogSillyMessage(chalk.magenta(`Request end event: Could not find socket within recordset`));
-            }
-        });
-
-        req.on('close', () => {
-            const socketRecord = this.GetSocketRecord(req.socket);
-            if (socketRecord) {
-                this.#LogSillyMessage(chalk.gray(`Request close event: ID: [${socketRecord.id}], originalUrl: [${socketRecord.originalUrl}]`));
-                this.UpdateNetworkStats(socketRecord, 'req_close', req);
-            } else {
-                this.#LogSillyMessage(chalk.magenta(`Request close event: Could not find socket within recordset`));
-            }
-        });
-
-        /* These methods are also available but from testing they provide no specific value add, i.e. the calculated numbers are always 0.
-        req.on('data', () => {
-            workingSocketRecord = this.GetSocketRecord(req.socket);
-            if (workingSocketRecord) {
-                this.#LogDebugMessage(chalk.gray(`Request close event: ID: [${workingSocketRecord.id}], originalUrl: [${workingSocketRecord.originalUrl}]`));
-                this.UpdateNetworkStats(workingSocketRecord, 'data', req);
-            } else {
-                this.#LogDebugMessage(chalk.magenta(`Request close event: Could not find socket within recordset`));
-            }
-        });
-
-        req.on('readable', () => {
-            workingSocketRecord = this.GetSocketRecord(req.socket);
-            if (workingSocketRecord) {
-                this.#LogDebugMessage(chalk.gray(`Request close event: ID: [${workingSocketRecord.id}], originalUrl: [${workingSocketRecord.originalUrl}]`));
-                this.UpdateNetworkStats(workingSocketRecord, 'readable', req);
-            } else {
-                this.#LogDebugMessage(chalk.magenta(`Request close event: Could not find socket within recordset`));
-            }
-        });
-        */
-
-        const inHeadersLength = JSON.stringify(req.headers).length;
-        const inContentLength = this.#GetRequestContentSize(req);
-        const inTotal = inHeadersLength + inContentLength;
-
-        this.#LogSillyMessage(chalk.white.bgGray(`inHeadersLength: [${inHeadersLength}], inContentLength: [${inContentLength}], inTotal: [${inTotal}]`));
-
-        // This event is the one where bytesRead is generally recorded
-        this.UpdateNetworkStats(workingSocketRecord, 'middleware', req);
-
-        next();
-    }
-}

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;
-}