@nsshunt/stsappframework 3.1.209 → 3.1.210

package/src/messagehandling/webWorkerMessageHandler.ts

@@ -1,341 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0, @typescript-eslint/no-unused-vars: 0 */  // --> OFF */  // --> OFF
-import { TinyEmitter } from "tiny-emitter";
-import { ISTSLogger, JSONObject } from '@nsshunt/stsutils'
-
-import { IIPCMessageProcessorIPCPayload, IServiceProcessContext, ProcessOptions } from '../commonTypes'
-
-import { IPCMessageManager, IPCMessageManagerOptions } from '../ipcMessageManager'
-
-import chalk from 'chalk';
-
-import { MessagePort } from 'worker_threads';
-
-export interface IWebWorderMessageHandlerOptions {
-    logger: ISTSLogger
-    role: 'SERVER' | 'CLIENT'
-    namespace: string
-    groups: string[]
-    ignoreEvents?: string[]
-    processOptions?: ProcessOptions
-    messagePort: MessagePort
-}
-
-export interface IClientRecord {
-    id: string
-    clientConnected: Date
-    pingCount: number
-    timeout: NodeJS.Timeout
-    groups: string[]
-    serviceProcessContext?: IServiceProcessContext
-}
-
-export interface IEventPayload {
-    __eventName: string
-    args: any[]
-}
-
-export interface IEventRecord {
-    event: string
-    callback: any,
-    ctx?: any
-}
-
-export interface IPingData {
-    id: string
-    groups: string[]
-    serviceProcessContext?: IServiceProcessContext
-}
-
-export class WebWorkerMessageHandler extends TinyEmitter {
-    #ipcMessageManager: IPCMessageManager | null = null;
-    #options: IWebWorderMessageHandlerOptions;
-    #events: Record<string, IEventRecord> = { };
-    #clients: Record<string, IClientRecord> = { };
-    #pingTimeout: NodeJS.Timeout | null = null;
-    #messagePort: MessagePort;
-
-    constructor(options: IWebWorderMessageHandlerOptions) {
-        super();
-        this.#options = options;
-        this.#messagePort = options.messagePort;
-
-        this.SetupPrimary();
-
-        if (this.#options.role.localeCompare('CLIENT') === 0) {
-            const ping = () => {
-                this.#pingTimeout = setTimeout(() => {
-                    const pingData: IPingData = {
-                        id: (this.#ipcMessageManager as IPCMessageManager).id,
-                        groups: this.#options.groups,
-                    }
-                    if (this.#options.processOptions) {
-                        pingData.serviceProcessContext = this.#options.processOptions.serviceProcessContext;
-                    }
-                    this.emit('ping', pingData, (response: any) => { });
-                    ping();
-                }, 1000).unref();
-            }
-            ping();
-        } else {
-            this.on('ping', (pingData: IPingData, callback: any) => {
-                const { id, groups, serviceProcessContext } = pingData;
-                if (this.#clients[id]) {
-                    clearTimeout(this.#clients[id].timeout);
-                    this.#clients[id].pingCount++;
-                    this.#clients[id].timeout = setTimeout(() => {
-                        delete this.#clients[id];
-                    }, 2000);
-                    this.#clients[id].groups = groups;
-                    this.#clients[id].serviceProcessContext = serviceProcessContext;
-                } else {
-                    this.#clients[id] = {
-                        id,
-                        clientConnected: new Date(),
-                        pingCount: 0,
-                        timeout: setTimeout(() => {
-                            delete this.#clients[id];
-                        }, 2000),
-                        groups,
-                        serviceProcessContext
-                    }
-                }
-                callback('ok');
-            });
-        }
-    }
-
-    #processRawMessage = (rawmessage: string) => {
-        const message = JSON.parse(rawmessage);
-        this.#ipcMessageManager?.ProcessMessage(message, { });
-    }
-
-    get clients(): Record<string, IClientRecord> {
-        return this.#clients;
-    }
-
-    get groups(): string[] {
-        return this.#options.groups;
-    }
-    
-    AddGroup = (group: string) => {
-        const index = this.#options.groups.indexOf(group);
-        if (index === -1) {
-            this.#options.groups.push(group);
-        }
-    }
-
-    RemoveGroup = (group: string) => {
-        const removeIndex = this.#options.groups.indexOf(group);
-        if (removeIndex !== -1) {
-            this.#options.groups.splice(removeIndex, 1);
-        }
-    }
-
-    SetupPrimary = () => {
-        const ipcMessageManagerOptions: IPCMessageManagerOptions = {
-            logger: this.#options.logger,
-            requestResponseMessageTimeout: 5000,
-            namespace: this.#options.namespace,
-            role: this.#options.role,
-            messageSender: this.#messageSender,
-            groups: this.#options.groups,
-            // This method is used to calculate if all responses have been received from multiple clients (broadcast)
-            // returns true/false.
-            ProcessResponseMessage: this.#ProcessResponseMessage,
-            // This gets called when an event is received from a message receiver (when ProcessMessage is invoked from the receiver event handler)
-            ProcessRequestMessage: this.#processPayload,
-             
-            messageReceiverStart: (options: any) => {
-                this.#messagePort.on('message', this.#processRawMessage);
-                //this.#redisSubscriber.on("message", this.#processRawMessage);
-            },
-             
-            messageReceiverStop: (options: any) => {
-                this.#messagePort.off("message", this.#processRawMessage);
-                //this.#redisSubscriber.off("message", this.#processRawMessage);
-            }
-        }
-        this.#ipcMessageManager = new IPCMessageManager(ipcMessageManagerOptions);
-    }
-
-     
-    #messageSender = (payload: IIPCMessageProcessorIPCPayload, options: any) => {
-        if (payload.messageType.localeCompare('REQUEST') === 0) {
-            //this.#redisPublisher.publish(this.#requestChannel, JSON.stringify(payload));
-            this.#messagePort.postMessage(JSON.stringify(payload));
-        } else if (payload.messageType.localeCompare('RESPONSE') === 0) {
-            this.#messagePort.postMessage(JSON.stringify(payload));
-            //this.#redisPublisher.publish(this.#responseChannel, JSON.stringify(payload));
-        }
-    }
-
-     
-    #ProcessResponseMessage = async (responses: Record<string, IIPCMessageProcessorIPCPayload>, options: any): Promise<boolean> => {
-        // Now check if we have all responses ...
-        let allFound = false;
-
-        for (const [responseId, response] of Object.entries(responses)) {
-            if (response.senderRole.localeCompare('CLIENT') === 0) {
-                allFound = true;
-                break;
-            }
-        }
-        if (allFound) {
-            return allFound;
-        }
-
-        let found = true;
-
-        // Sender role here is SERVER
-        let requestGroup = null;
-        for (const [responseId, response] of Object.entries(responses)) {
-            if (response.requestPayload.args.length > 0 && response.requestPayload.args[0].group) {
-                requestGroup = response.requestPayload.args[0].group;
-                break;
-            }
-        }
-
-        if (requestGroup) {
-            const clientsInGroup = Object.values(this.#clients).filter(c => {
-                if (c.groups.indexOf(requestGroup) === -1) {
-                    return false;
-                }
-                return true;
-            });
-
-            // Now make sure that all clients are in the responses
-            found = true;
-            clientsInGroup.forEach(c => {
-                if (!responses[c.id]) {
-                    found = false;
-                }
-            })
-        } else {
-            const clientsInGroup = Object.values(this.#clients)
-
-            // Now make sure that all clients are in the responses
-            found = true;
-            clientsInGroup.forEach(c => {
-                if (!responses[c.id]) {
-                    found = false;
-                }
-            })
-        }
-
-        return found;
-    }
-
-    #processPayload = (payload: IIPCMessageProcessorIPCPayload, options: any): Promise<JSONObject> => {
-        // check the event name from the collection and invoke that function
-        return new Promise<JSONObject>((resolve, reject) => {
-            if (payload.messageType.localeCompare('REQUEST') === 0) {
-                if (payload.requestPayload['__eventName']) {
-                    const eventName = payload.requestPayload['__eventName'];
-                    // Only process events that I have registered interest in (using .on)
-                    if (this.#events[eventName]) {
-                        try {
-                            //const retVal = this.#events[eventName].callback(payload.requestPayload.args, payload, options, this.#events[eventName].ctx);
-                            this.#events[eventName].callback(...payload.requestPayload.args, (responseMessage: any) => {
-                                resolve(responseMessage);
-                            });
-                        } catch (error) {
-                            reject(error);
-                        }
-                    }
-                }
-            }
-        });
-    }
-
-    // p.on('fromworker', (arg1: number, arg2: string, callback: any) => {
-    override on(event: string, callback: any, ctx?: any): this {
-        if (this.#events[event]) {
-            // Update the event with the same name
-            delete this.#events[event];
-        }
-        const eventObject: IEventRecord = {
-            event,
-            callback,
-            ctx
-        }
-        this.#events[eventObject.event] = eventObject;
-        return this;
-    }
-
-    override off(event: string, callback?: any): this {
-        if (this.#events[event]) {
-            delete this.#events[event];
-        }
-        return this;
-    }
-
-    Start = () => {
-        this.#ipcMessageManager?.Start();
-    }
-
-    Stop = () => {
-        if (this.#pingTimeout) {
-            clearTimeout(this.#pingTimeout);
-            this.#pingTimeout = null;
-        }
-
-        this.#ipcMessageManager?.Stop();
-
-        /*
-        this.#redisSubscriber.quit();
-        this.#redisSubscriber.disconnect();
-
-        this.#redisPublisher.quit();
-        this.#redisPublisher.disconnect();
-        */
-    }
-
-    override emit(event: string, ...args: any[]): this {
-        (async () => {
-            try {
-                const retVal = await this.#ipcMessageManager?.SendMessage({
-                    __eventName: event,
-                    args: args.slice(0, args.length-1)
-                } as IEventPayload);            
-                // Invoke the response callback
-                args[args.length-1](retVal);
-            } catch (error) {
-                if (this.#options.ignoreEvents) {
-                    if (this.#options.ignoreEvents.indexOf((error as any).__eventName) !== -1) {
-                        return;
-                    }
-                }
-                this.#options.logger.error(chalk.red(`RedisMessageHandler:emit(): Error: [${JSON.stringify(error)}]`));
-            }
-        })();
-        return this;
-    }
-
-    emitWithError(event: string, args: JSONObject, responseCb: (response: JSONObject | undefined) => void, errorCb: (error: any) => void): this {
-        (async () => {
-            try {
-                const retVal = await this.#ipcMessageManager?.SendMessage({
-                    __eventName: event,
-                    args: [ args ]
-                } as IEventPayload);            
-                // Invoke the response callback
-                responseCb(retVal);
-            } catch (error) {
-                if (this.#options.ignoreEvents) {
-                    if (this.#options.ignoreEvents.indexOf((error as any).__eventName) !== -1) {
-                        return;
-                    }
-                }
-                errorCb(error);
-            }
-        })();
-        return this;
-    }
-
-    emitex = async(event: string, ...args: any[]): Promise<JSONObject> => {
-        return (this.#ipcMessageManager as IPCMessageManager).SendMessage({
-            __eventName: event,
-            args
-        } as IEventPayload);            
-    }
-}

package/src/messagehandling/webWorkerSupport.ts

@@ -1,66 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0, @typescript-eslint/no-unused-vars: 0 */  // --> OFF */  // --> OFF
-import { parentPort, MessagePort } from 'worker_threads';
-
-import { WebWorkerMessageHandler } from './webWorkerMessageHandler'
-
-import { defaultLogger, JSONObject } from '@nsshunt/stsutils'
-
-import chalk from 'chalk';
-
-export class WorkerSupport {
-    #wwClient: WebWorkerMessageHandler | null = null;
-
-    constructor() {
-        this.#wwClient = new WebWorkerMessageHandler({
-            logger: defaultLogger,
-            role: 'CLIENT',
-            namespace: 'mytestapp',
-            groups: [ ],
-            ignoreEvents: [ 'ping' ],
-            messagePort: parentPort as MessagePort
-        });
-        this.#wwClient.Start();
-    
-        this.#wwClient.on('test', (arg1: JSONObject, callback: any) => {
-            callback( {
-                status: `PID: [${process.pid}]: response message from event = test with args ${JSON.stringify(arg1)}`
-            })
-        });
-    
-        this.#wwClient.on('globalmessage', (arg1: JSONObject, callback: any) => {
-            callback( {
-                status: `PID: [${process.pid}]: response message from event = globalmessage with args ${JSON.stringify(arg1)}`
-            })
-        });
-    
-        setTimeout(async () => {
-            const sendObj1 = { from: 'child1' };
-            console.log(chalk.magenta(`calling globalmessage = [${JSON.stringify(sendObj1)}]`));
-            const retVal1 = await this.#wwClient?.emitex('globalmessage', sendObj1);
-            console.log(chalk.magenta(`caller response from globalmessage = [${JSON.stringify(retVal1)}]`));
-
-            const sendObj2 = { from: 'child2' };
-            console.log(chalk.magenta(`calling test = [${JSON.stringify(sendObj2)}]`));
-            const retVal2 = await this.#wwClient?.emitex('test', sendObj2);
-            console.log(chalk.magenta(`caller response from test = [${JSON.stringify(retVal2)}]`));
-        }, 2000);
-    }
-
-    ProcessMessage = async(data: any) => {
-        console.log(`Received: [${data}]`);
-        //parentPort?.postMessage(data);
-    }
-}
-
-new WorkerSupport();
-
-/*
-parentPort?.on('message', (data: any) => {
-    if (isNode) {
-        worker.ProcessMessage(data);
-    } else {
-        // const payloadMessage: IIWMessagePayload = data.data as IIWMessagePayload; // browser version
-        worker.ProcessMessage(data.data); // browser version
-    }
-});
-*/

package/src/redisMessageHandler.test.ts

@@ -1,157 +0,0 @@
-/* eslint @typescript-eslint/no-explicit-any: 0 */  // --> OFF
-import { beforeAll, afterAll, test, describe, expect } from 'vitest';
-
-import { RedisMessageHandler } from './redisMessageHandler'
-
-import { JSONObject, Sleep, defaultLogger } from '@nsshunt/stsutils';
-
-import chalk from 'chalk';
-
-import { v4 as uuidv4 } from 'uuid';
-
-import { GenericContainer } from "testcontainers";
-
-describe.skip("Redis Message Handler Test", () =>
-{
-    let ioRedisContainer: any;
-    let ioRedisMessageProcessorUrl = '';
-
-    beforeAll(async () => {
-        // --- [ioRedis ] -------------------------------------------------------------------------
-
-        ioRedisContainer = await new GenericContainer("redis")
-            .withExposedPorts(6379)
-            .start();
-        ioRedisMessageProcessorUrl = `redis://${ioRedisContainer.getHost()}:${ioRedisContainer.getMappedPort(6379)}`;            
-    });
-
-    afterAll(async () => {
-        if (ioRedisContainer) {
-            await ioRedisContainer.stop();
-        }
-    }, 5000);
-    
-    class Server {
-        #r1: RedisMessageHandler;
-
-        constructor() {
-            this.#r1 = new RedisMessageHandler({
-                logger: defaultLogger,
-                role: 'SERVER',
-                redisUrl: ioRedisMessageProcessorUrl, // goptions.imRedisMessageProcessorUrl,
-                namespace: 'redistestingstsframework',
-                groups: [ ]
-            });
-            this.#r1.Start();
-
-            this.#r1.on('fromworkerredis', (arg1: string, arg2: number, arg3: string, callback: any) => {
-                console.log(chalk.magenta(`${process.pid}: fromworkerredis.ON: [${arg1} ${arg2} ${arg3}]`));
-                //callback(null);
-                callback({status: `response message from event = fromworkerredis with args ${arg1} ${arg2} ${arg3}`})
-            });
-        }
-
-        Start = async (expectedResponses: number, iterations: number, delay: number) => {
-            for (let i=0; i < iterations; i++) {
-                /*
-                Object.keys(p).forEach(async (pKey) => {
-                    const emitobj = { i: i, a: 'a', b: 'b', worker: pKey };
-                    console.log(chalk.green(`${process.pid}: emit event to worker: [${pKey}] fromprimary: [${JSON.stringify(emitobj)}`));
-                    p[pKey].emit('fromprimary', emitobj, (response: any) => {
-                        console.log(chalk.green(`${process.pid}: ${JSON.stringify(response)}`));
-                    });
-                });
-                */
-
-
-                const emitobj = { i: i, a: 'a', b: 'b' };
-                console.log(chalk.cyan(`${process.pid}: emit event fromprimaryredis fromprimary: [${JSON.stringify(emitobj)}`));
-                this.#r1.emit('fromprimaryredis', emitobj, (response: any) => {
-                    console.log(chalk.cyan(`${process.pid}: Response(fromprimaryredis): Count: [${response.length}] [${JSON.stringify(response)}]`));
-                    expect(response.length).toEqual(expectedResponses);
-                });
-
-                await Sleep(delay);
-            }
-        }
-
-        Stop = () => {
-            this.#r1.Stop();
-        }
-    }
-
-    class Client {
-        #r1: RedisMessageHandler;
-
-        constructor() {
-            this.#r1 = new RedisMessageHandler({
-                logger: defaultLogger,
-                role: 'CLIENT',
-                redisUrl: ioRedisMessageProcessorUrl, // goptions.imRedisMessageProcessorUrl,
-                namespace: 'redistestingstsframework',
-                groups: [ ]
-            });
-            this.#r1.Start();
-    
-            this.#r1.on('fromprimaryredis', (arg1: JSONObject, callback: any) => {
-                //callback();
-                console.log(chalk.yellow(`${process.pid}: fromprimaryredis.ON: [${JSON.stringify(arg1)}]`));
-                callback({status: `PID: [${process.pid}]: response message from event = fromprimaryredis with args ${JSON.stringify(arg1)}`})
-            });
-        }
-
-        Start = async (iterations: number, delay: number) => {
-            for (let i=0; i < iterations; i++) {
-                const id = uuidv4();
-                /*
-                console.log(chalk.yellow(`${process.pid}: emit event fromworker: [${id} ${i} Hello]`));
-                w1.emit('fromworker', id, i, 'Hello', (response: any) => {
-                    console.log(chalk.yellow(`${process.pid}: ${JSON.stringify(response)}`));
-                });
-                */
-
-                console.log(chalk.green(`${process.pid}: emit event fromworkerredis: [${id} ${i} Hello]`));
-                this.#r1.emit('fromworkerredis', id, i, 'Hello', (response: any) => {
-                    console.log(chalk.green(`${process.pid}: Response(fromworkerredis): [${JSON.stringify(response)}]`));
-                });
-                await Sleep(delay);
-            }
-        }
-
-        Stop = () => {
-            this.#r1.Stop();
-        }
-    }
-
-
-    test('Test 1', async () => 
-    {
-        const clientCount = 20;
-        const iterations = 5;
-        const delay = 100;
-
-        expect.assertions(iterations);
-
-        // Setup new server and clients
-        const server = new Server();
-        const clients: Client[] = [ ];
-        for (let i=0; i < clientCount; i++) {
-            clients.push(new Client());
-        }
-
-        // Need this delay to ensure the pings are all sent and received between the clients and the server
-        await Sleep(2000);
-
-        // Start sending messages
-        server.Start(clientCount, iterations, delay);
-        clients.forEach(c => c.Start(iterations, delay));
-
-        // Allow time to process
-        await Sleep(3000);
-
-        // All done, stop.
-        clients.forEach(c => c.Stop());
-        server.Stop();
-    }, 30000);
-});
-