Require uuid header when consuming messages

If the header does not exist, drop the message and log. Update the tests.
ably-labs · Oct 18, 2023 · f35897f · f35897f
1 parent f3f4caa
commit f35897f
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 12 deletions.
diff --git a/package.json b/package.json
@@ -37,7 +37,6 @@
   },
   "keywords": ["ably", "models", "live", "realtime", "data", "sync", "collaboration"],
   "devDependencies": {
-    "@types/uuid": "^9.0.2",
     "@typescript-eslint/eslint-plugin": "^6.1.0",
     "@typescript-eslint/parser": "^6.1.0",
     "@vitest/coverage-c8": "^0.28.4",
@@ -58,7 +57,6 @@
     "ably": "^1.2.41",
     "lodash": "^4.17.21",
     "pino": "^8.14.1",
-    "rxjs": "^7.8.1",
-    "uuid": "^9.0.0"
+    "rxjs": "^7.8.1"
   }
 }
diff --git a/src/Model.test.ts b/src/Model.test.ts
@@ -417,8 +417,6 @@ describe('Model', () => {
     expect(optimisticSubscriptionSpy).toHaveBeenNthCalledWith(2, null, 'data_1');
     expect(confirmedSubscriptionSpy).toHaveBeenCalledTimes(1);
 
-    // the event data payload does not match the expected event but the uuid does
-    // this passes because the mutation id passed to optimistic is empty.
     events.e1.next(
       customMessage('id_1', 'testEvent', 'confirmed_data', { 'x-ably-models-event-uuid': 'some-custom-id' }),
     );

diff --git a/src/Model.ts b/src/Model.ts
@@ -21,7 +21,11 @@ import type {
   OptimisticEvent,
   ConfirmedEvent,
 } from './types/model.js';
-import type { OptimisticEventOptions } from './types/optimistic.js';
+import {
+  MODELS_EVENT_REJECT_HEADER,
+  MODELS_EVENT_UUID_HEADER,
+  type OptimisticEventOptions,
+} from './types/optimistic.js';
 import EventEmitter from './utilities/EventEmitter.js';
 
 /**
@@ -326,20 +330,25 @@ export default class Model<T> extends EventEmitter<Record<ModelState, ModelState
           throw err;
         }
         let rejected = false;
-        if (event?.extras?.headers && event?.extras?.headers['x-ably-models-reject'] === 'true') {
+        if (event?.extras?.headers && event?.extras?.headers[MODELS_EVENT_REJECT_HEADER] === 'true') {
           rejected = true;
         }
-        let uuid: string | undefined;
-        if (event?.extras?.headers && !!event?.extras?.headers['x-ably-models-event-uuid']) {
-          uuid = event?.extras?.headers['x-ably-models-event-uuid'];
+
+        const mutationId = event?.extras?.headers[MODELS_EVENT_UUID_HEADER];
+        if (!mutationId) {
+          this.logger.warn(
+            { ...this.baseLogContext, action: 'streamEventCallback' },
+            `message does not have "${MODELS_EVENT_UUID_HEADER}" header, skipping message id`,
+            event?.id,
+          );
+          return;
         }
 
         const modelsEvent: ConfirmedEvent = {
           ...event!,
           confirmed: true,
           rejected,
-          mutationId: event!.id,
-          ...(uuid && { mutationId: uuid }),
+          mutationId: mutationId,
         };
 
         await this.onStreamEvent(modelsEvent);

diff --git a/src/types/optimistic.ts b/src/types/optimistic.ts
@@ -41,3 +41,6 @@ export type OptimisticInvocationParams = {
    */
   options?: Partial<OptimisticEventOptions>;
 };
+
+export const MODELS_EVENT_UUID_HEADER = 'x-ably-models-event-uuid';
+export const MODELS_EVENT_REJECT_HEADER = 'x-ably-models-reject';
diff --git a/src/utilities/test/messages.ts b/src/utilities/test/messages.ts
@@ -1,5 +1,7 @@
 import { Types } from 'ably/promises';
 
+import { MODELS_EVENT_UUID_HEADER } from '../../types/optimistic.js';
+
 export const baseMessage: Types.Message = {
   id: '1',
   data: null,
@@ -14,15 +16,22 @@ export const baseMessage: Types.Message = {
 };
 
 export function createMessage(i: number): Types.Message {
+  const headers: { [key: string]: string } = {};
+  headers[MODELS_EVENT_UUID_HEADER] = `id_${i}`;
+
   return {
     ...baseMessage,
     id: `id_${i}`,
     name: `name_${i}`,
     data: `data_${i}`,
+    extras: { headers: headers },
   };
 }
 
 export function customMessage(id: string, name: string, data: string, headers?: Record<string, string>): Types.Message {
+  const baseHeaders: { [key: string]: string } = {};
+  baseHeaders[MODELS_EVENT_UUID_HEADER] = id;
+
   return {
     ...baseMessage,
     id,
@@ -32,6 +41,7 @@ export function customMessage(id: string, name: string, data: string, headers?:
       ...baseMessage.extras,
       headers: {
         ...baseMessage.extras.headers,
+        ...baseHeaders,
         ...(headers || {}),
       },
     },