Room Version 12 fixes (#979)

* Relax our room_id validation as room version 12 drops the server part of the room_id

Signed-off-by: MTRNord <[email protected]>

* Ensure we log validation errors as this caused quite a headache while debugging room version 12 changes

Signed-off-by: MTRNord <[email protected]>

* Add changeset

---------

Signed-off-by: MTRNord <[email protected]>

Author: Marcel-Nordeck

.changeset/rare-beans-send.md

@@ -0,0 +1,8 @@
+---
+'@matrix-widget-toolkit/testing': minor
+'@matrix-widget-toolkit/react': minor
+'@matrix-widget-toolkit/api': minor
+'@matrix-widget-toolkit/mui': minor
+---
+
+Reduce strictness on room_ids to comply with changes in room version 12

example-widget-mui/src/events/validation.test.ts

@@ -16,9 +16,19 @@
 
 import { RoomEvent } from '@matrix-widget-toolkit/api';
 import Joi from 'joi';
-import { beforeEach, describe, expect, it } from 'vitest';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { isValidEvent } from './validation';
 
+// Mock console.warn for tests
+const originalConsoleWarn = console.warn;
+beforeEach(() => {
+  console.warn = vi.fn();
+});
+
+afterEach(() => {
+  console.warn = originalConsoleWarn;
+});
+
 const exampleSchema = Joi.object({
   key: Joi.string(),
 });
@@ -63,6 +73,19 @@ describe('isValidEvent', () => {
     );
   });
 
+  it('should log warning when content validation fails', () => {
+    event.content = { other: 'my-value' };
+
+    expect(isValidEvent(event, 'com.example.event', exampleSchema)).toEqual(
+      false,
+    );
+    expect(console.warn).toHaveBeenCalledWith(
+      'Error while validating com.example.event event:',
+      expect.any(Array),
+      { event },
+    );
+  });
+
   it('should validate successful', () => {
     expect(isValidEvent(event, 'com.example.event', exampleSchema)).toEqual(
       true,

example-widget-mui/src/events/validation.ts

@@ -33,7 +33,11 @@ export function isValidEvent(
   const result = schema.validate(event.content);
 
   if (result.error) {
-    // TODO: Log here if desired: console.warn('Error while validating event', result.error);
+    console.warn(
+      `Error while validating ${eventType} event:`,
+      result.error.details,
+      { event },
+    );
     return false;
   }
 

packages/api/src/api/extras/events.test.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { describe, expect, it } from 'vitest';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { RoomEvent, StateEvent, ToDeviceMessageEvent } from '../types';
 import {
   isRoomEvent,
@@ -24,6 +24,16 @@ import {
   isValidToDeviceMessageEvent,
 } from './events';
 
+// Mock console.warn for tests
+const originalConsoleWarn = console.warn;
+beforeEach(() => {
+  console.warn = vi.fn();
+});
+
+afterEach(() => {
+  console.warn = originalConsoleWarn;
+});
+
 const roomEvent: RoomEvent = {
   type: 'com.example.type',
   sender: '@user-id',
@@ -93,6 +103,16 @@ describe('isValidRoomEvent', () => {
       }),
     ).toBe(false);
   });
+
+  it('should log warning when validation fails', () => {
+    const invalidEvent = { ...roomEventData, type: undefined };
+    expect(isValidRoomEvent(invalidEvent)).toBe(false);
+    expect(console.warn).toHaveBeenCalledWith(
+      'Invalid room event:',
+      expect.any(Array),
+      { event: invalidEvent },
+    );
+  });
 });
 
 const stateEventData: StateEvent = {
@@ -138,6 +158,16 @@ describe('isValidStateEvent', () => {
       }),
     ).toBe(false);
   });
+
+  it('should log warning when validation fails', () => {
+    const invalidEvent = { ...stateEventData, type: undefined };
+    expect(isValidStateEvent(invalidEvent)).toBe(false);
+    expect(console.warn).toHaveBeenCalledWith(
+      'Invalid state event:',
+      expect.any(Array),
+      { event: invalidEvent },
+    );
+  });
 });
 
 const toDeviceMessageData: ToDeviceMessageEvent = {
@@ -172,4 +202,14 @@ describe('isValidToDeviceMessageEvent', () => {
       }),
     ).toBe(false);
   });
+
+  it('should log warning when validation fails', () => {
+    const invalidEvent = { ...toDeviceMessageData, type: undefined };
+    expect(isValidToDeviceMessageEvent(invalidEvent)).toBe(false);
+    expect(console.warn).toHaveBeenCalledWith(
+      'Invalid to device message event:',
+      expect.any(Array),
+      { event: invalidEvent },
+    );
+  });
 });

packages/api/src/api/extras/events.ts

@@ -48,7 +48,12 @@ export function isRoomEvent(event: RoomEvent | StateEvent): event is RoomEvent {
 // Allow any here, so that the validation works for every event
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isValidRoomEvent(event: unknown): event is RoomEvent<any> {
-  return roomEventSchema.validate(event).error === undefined;
+  const result = roomEventSchema.validate(event);
+  if (result.error) {
+    console.warn('Invalid room event:', result.error.details, { event });
+    return false;
+  }
+  return true;
 }
 
 /**
@@ -60,7 +65,12 @@ export function isValidRoomEvent(event: unknown): event is RoomEvent<any> {
 // Allow any here, so that the validation works for every event
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isValidStateEvent(event: unknown): event is StateEvent<any> {
-  return stateEventSchema.validate(event).error === undefined;
+  const result = stateEventSchema.validate(event);
+  if (result.error) {
+    console.warn('Invalid state event:', result.error.details, { event });
+    return false;
+  }
+  return true;
 }
 
 /**
@@ -74,7 +84,14 @@ export function isValidToDeviceMessageEvent(
   // Allow any here, so that the validation works for every event
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
 ): event is ToDeviceMessageEvent<any> {
-  return toDeviceMessageSchema.validate(event).error === undefined;
+  const result = toDeviceMessageSchema.validate(event);
+  if (result.error) {
+    console.warn('Invalid to device message event:', result.error.details, {
+      event,
+    });
+    return false;
+  }
+  return true;
 }
 
 /**
@@ -85,7 +102,8 @@ const eventSchemaProps = {
   // Do roughly check against the format
   // https://spec.matrix.org/v1.13/appendices/#common-identifier-format
   sender: Joi.string().pattern(new RegExp('^@[^\\s:]*:\\S*$')).required(),
-  room_id: Joi.string().pattern(new RegExp('^![^:]*:\\S*')).required(),
+  // Prior versions of the code had checked for a server_name. However in room version 12+ this got dropped. There is no way for us to check this here.
+  room_id: Joi.string().pattern(new RegExp('^!')).required(),
   content: Joi.object().required(),
 };