feat: Uniq key for event (#133)

lad-tech · Nov 8, 2024 · ff69a67 · ff69a67
1 parent 61145d8
commit ff69a67
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 6 deletions.
diff --git a/examples/MathService/interfaces.ts b/examples/MathService/interfaces.ts
@@ -15,9 +15,9 @@ export interface FibonacciNumberEvent {
 }
 
 export type EmitterMath = {
-  Elapsed: (params: ElapsedEvent) => void;
-  Notify: (params: NotifyEvent) => void;
-  FibonacciNumber: (params: FibonacciNumberEvent) => void;
+  Elapsed: (params: ElapsedEvent, uniqId?: string) => void;
+  Notify: (params: NotifyEvent, uniqId?: string) => void;
+  FibonacciNumber: (params: FibonacciNumberEvent, uniqId?: string) => void;
 };
 
 export type EmitterMathExternal = {

diff --git a/src/Service.ts b/src/Service.ts
@@ -1,5 +1,5 @@
 import { Root } from './Root';
-import { JSONCodec, Subscription, DebugEvents, Events } from 'nats';
+import { JSONCodec, Subscription, DebugEvents, Events, headers, MsgHdrs } from 'nats';
 import {
   Message,
   Emitter,
@@ -43,6 +43,12 @@ export class Service<E extends Emitter = Emitter> extends Root {
   private httpMethods = new Map<string, Method>();
   private rootSpans = new Map<string, Span>();
 
+  /**
+   * Unique identifier NATS header for a message that will be used by the server apply
+   * de-duplication within the configured Duplicate Window
+   */
+  private readonly UNIQ_ID_HEADER = 'Nats-Msg-Id';
+
   constructor(private options: ServiceOptions<E>) {
     super(options.brokerConnection, options.loggerOutputFormatter);
 
@@ -51,7 +57,7 @@ export class Service<E extends Emitter = Emitter> extends Root {
     if (options.events) {
       const events = Object.keys(options.events.list) as [keyof E];
       this.emitter = events.reduce((result, eventName) => {
-        result[eventName] = ((params: unknown) => {
+        result[eventName] = ((params: unknown, uniqId?: string) => {
           const subject: string[] = [options.name];
 
           const eventOptions = options.events?.list[eventName];
@@ -68,7 +74,13 @@ export class Service<E extends Emitter = Emitter> extends Root {
 
           subject.push(String(eventName));
 
-          this.broker.publish(subject.join('.'), this.buildMessage(params));
+          let settings: { headers: MsgHdrs } | undefined;
+          if (uniqId) {
+            settings = { headers: headers() };
+            settings.headers.append(this.UNIQ_ID_HEADER, uniqId);
+          }
+
+          this.broker.publish(subject.join('.'), this.buildMessage(params), settings);
         }) as E[keyof E];
         return result;
       }, this.emitter);

diff --git a/src/__tests__/Service.ts b/src/__tests__/Service.ts
@@ -32,6 +32,7 @@ describe('Testing Service class methods', () => {
       subscribe: jetstreamSubscribeMock,
     }),
     status: () => brokerEvents,
+    publish: jest.fn(),
   };
 
   const codec = JSONCodec();
@@ -234,6 +235,20 @@ describe('Testing Service class methods', () => {
       await setTimeout(1);
       expect(result).toMatchObject(streamResponse);
     });
+
+    test('Event sending', async () => {
+      const mathService = new Service<EmitterMath>({
+        name,
+        brokerConnection: broker as any,
+        methods: [],
+        events,
+      });
+
+      await mathService.start();
+
+      mathService.emitter.Notify({ method: 'Test' }, 'uniq_key');
+      expect(broker.publish).toBeCalledTimes(1);
+    });
   });
 
   describe('Other', () => {