From edc1c67ecfa16cba492aa2aaa744fffe90193a71 Mon Sep 17 00:00:00 2001 From: Evie Gauthier Date: Mon, 16 Mar 2026 21:43:51 -0400 Subject: [PATCH] test(matrix-to): add unit tests; fix setMatrixToBase reset, http support, room regex --- src/app/plugins/matrix-to.test.ts | 250 ++++++++++++++++++++++++++++++ src/app/plugins/matrix-to.ts | 7 +- 2 files changed, 254 insertions(+), 3 deletions(-) create mode 100644 src/app/plugins/matrix-to.test.ts diff --git a/src/app/plugins/matrix-to.test.ts b/src/app/plugins/matrix-to.test.ts new file mode 100644 index 000000000..806dc03e7 --- /dev/null +++ b/src/app/plugins/matrix-to.test.ts @@ -0,0 +1,250 @@ +import { afterEach, describe, expect, it } from 'vitest'; +import { + getMatrixToRoom, + getMatrixToRoomEvent, + getMatrixToUser, + parseMatrixToRoom, + parseMatrixToRoomEvent, + parseMatrixToUser, + setMatrixToBase, + testMatrixTo, +} from './matrix-to'; + +// Reset to default after each test so state doesn't leak between tests. +afterEach(() => { + setMatrixToBase(undefined); +}); + +// --------------------------------------------------------------------------- +// Link generation +// --------------------------------------------------------------------------- + +describe('getMatrixToUser', () => { + it('generates a standard matrix.to user link', () => { + expect(getMatrixToUser('@alice:example.com')).toBe( + 'https://matrix.to/#/@alice:example.com' + ); + }); + + it('uses custom base when configured', () => { + setMatrixToBase('https://matrix.example.org'); + expect(getMatrixToUser('@alice:example.com')).toBe( + 'https://matrix.example.org/#/@alice:example.com' + ); + }); + + it('strips trailing slash from custom base', () => { + setMatrixToBase('https://matrix.example.org/'); + expect(getMatrixToUser('@alice:example.com')).toBe( + 'https://matrix.example.org/#/@alice:example.com' + ); + }); +}); + +describe('getMatrixToRoom', () => { + it('generates a standard matrix.to room link', () => { + expect(getMatrixToRoom('!room:example.com')).toBe( + 'https://matrix.to/#/!room:example.com' + ); + }); + + it('appends via servers', () => { + expect(getMatrixToRoom('!room:example.com', ['s1.org', 's2.org'])).toBe( + 'https://matrix.to/#/!room:example.com?via=s1.org&via=s2.org' + ); + }); + + it('uses custom base when configured', () => { + setMatrixToBase('https://matrix.example.org'); + expect(getMatrixToRoom('#general:example.com')).toBe( + 'https://matrix.example.org/#/#general:example.com' + ); + }); +}); + +describe('getMatrixToRoomEvent', () => { + it('generates a standard matrix.to event link', () => { + expect(getMatrixToRoomEvent('!room:example.com', '$event123')).toBe( + 'https://matrix.to/#/!room:example.com/$event123' + ); + }); + + it('appends via servers', () => { + expect( + getMatrixToRoomEvent('!room:example.com', '$event123', ['s1.org']) + ).toBe('https://matrix.to/#/!room:example.com/$event123?via=s1.org'); + }); + + it('uses custom base when configured', () => { + setMatrixToBase('https://matrix.example.org'); + expect(getMatrixToRoomEvent('!room:example.com', '$event123')).toBe( + 'https://matrix.example.org/#/!room:example.com/$event123' + ); + }); +}); + +// --------------------------------------------------------------------------- +// testMatrixTo +// --------------------------------------------------------------------------- + +describe('testMatrixTo', () => { + it('matches standard matrix.to URLs', () => { + expect(testMatrixTo('https://matrix.to/#/@alice:example.com')).toBe(true); + expect(testMatrixTo('https://matrix.to/#/!room:example.com')).toBe(true); + expect(testMatrixTo('https://matrix.to/#/!room:example.com/$event')).toBe(true); + expect(testMatrixTo('http://matrix.to/#/@alice:example.com')).toBe(true); + }); + + it('rejects non-matrix.to URLs', () => { + expect(testMatrixTo('https://example.com')).toBe(false); + expect(testMatrixTo('https://notmatrix.to/#/@alice:example.com')).toBe(false); + }); + + it('matches custom base URLs after setMatrixToBase', () => { + setMatrixToBase('https://matrix.example.org'); + expect(testMatrixTo('https://matrix.example.org/#/@alice:example.com')).toBe(true); + }); + + it('still matches standard matrix.to after setMatrixToBase (cross-client compat)', () => { + setMatrixToBase('https://matrix.example.org'); + expect(testMatrixTo('https://matrix.to/#/@alice:example.com')).toBe(true); + }); +}); + +// --------------------------------------------------------------------------- +// parseMatrixToUser +// --------------------------------------------------------------------------- + +describe('parseMatrixToUser', () => { + it('parses a standard matrix.to user link', () => { + expect(parseMatrixToUser('https://matrix.to/#/@alice:example.com')).toBe( + '@alice:example.com' + ); + }); + + it('returns undefined for non-user links', () => { + expect(parseMatrixToUser('https://matrix.to/#/!room:example.com')).toBeUndefined(); + }); + + it('parses user links from custom base', () => { + setMatrixToBase('https://matrix.example.org'); + expect( + parseMatrixToUser('https://matrix.example.org/#/@alice:example.com') + ).toBe('@alice:example.com'); + }); + + it('parses standard matrix.to user links even after custom base is set', () => { + setMatrixToBase('https://matrix.example.org'); + expect(parseMatrixToUser('https://matrix.to/#/@alice:example.com')).toBe( + '@alice:example.com' + ); + }); +}); + +// --------------------------------------------------------------------------- +// parseMatrixToRoom +// --------------------------------------------------------------------------- + +describe('parseMatrixToRoom', () => { + it('parses a room ID link', () => { + expect(parseMatrixToRoom('https://matrix.to/#/!room:example.com')).toEqual({ + roomIdOrAlias: '!room:example.com', + viaServers: undefined, + }); + }); + + it('parses a room alias link', () => { + expect(parseMatrixToRoom('https://matrix.to/#/#general:example.com')).toEqual({ + roomIdOrAlias: '#general:example.com', + viaServers: undefined, + }); + }); + + it('parses via servers', () => { + expect( + parseMatrixToRoom('https://matrix.to/#/!room:example.com?via=s1.org&via=s2.org') + ).toEqual({ + roomIdOrAlias: '!room:example.com', + viaServers: ['s1.org', 's2.org'], + }); + }); + + it('returns undefined for event links (too many segments)', () => { + expect( + parseMatrixToRoom('https://matrix.to/#/!room:example.com/$event123') + ).toBeUndefined(); + }); + + it('parses room links from custom base', () => { + setMatrixToBase('https://matrix.example.org'); + expect( + parseMatrixToRoom('https://matrix.example.org/#/!room:example.com') + ).toEqual({ roomIdOrAlias: '!room:example.com', viaServers: undefined }); + }); + + it('still parses standard matrix.to room links after custom base is set', () => { + setMatrixToBase('https://matrix.example.org'); + expect(parseMatrixToRoom('https://matrix.to/#/!room:example.com')).toEqual({ + roomIdOrAlias: '!room:example.com', + viaServers: undefined, + }); + }); +}); + +// --------------------------------------------------------------------------- +// parseMatrixToRoomEvent +// --------------------------------------------------------------------------- + +describe('parseMatrixToRoomEvent', () => { + it('parses a room event link', () => { + expect( + parseMatrixToRoomEvent('https://matrix.to/#/!room:example.com/$event123') + ).toEqual({ + roomIdOrAlias: '!room:example.com', + eventId: '$event123', + viaServers: undefined, + }); + }); + + it('parses via servers', () => { + expect( + parseMatrixToRoomEvent( + 'https://matrix.to/#/!room:example.com/$event123?via=s1.org' + ) + ).toEqual({ + roomIdOrAlias: '!room:example.com', + eventId: '$event123', + viaServers: ['s1.org'], + }); + }); + + it('returns undefined for room-only links', () => { + expect( + parseMatrixToRoomEvent('https://matrix.to/#/!room:example.com') + ).toBeUndefined(); + }); + + it('parses event links from custom base', () => { + setMatrixToBase('https://matrix.example.org'); + expect( + parseMatrixToRoomEvent( + 'https://matrix.example.org/#/!room:example.com/$event123' + ) + ).toEqual({ + roomIdOrAlias: '!room:example.com', + eventId: '$event123', + viaServers: undefined, + }); + }); + + it('still parses standard matrix.to event links after custom base is set', () => { + setMatrixToBase('https://matrix.example.org'); + expect( + parseMatrixToRoomEvent('https://matrix.to/#/!room:example.com/$event123') + ).toEqual({ + roomIdOrAlias: '!room:example.com', + eventId: '$event123', + viaServers: undefined, + }); + }); +}); diff --git a/src/app/plugins/matrix-to.ts b/src/app/plugins/matrix-to.ts index ae0a9f4f9..0397a8010 100644 --- a/src/app/plugins/matrix-to.ts +++ b/src/app/plugins/matrix-to.ts @@ -5,7 +5,7 @@ let MATRIX_TO_BASE = 'https://matrix.to'; * Must be called before any getMatrixTo* functions are used. */ export const setMatrixToBase = (baseUrl?: string): void => { - if (baseUrl) MATRIX_TO_BASE = baseUrl.replace(/\/$/, ''); + MATRIX_TO_BASE = baseUrl ? baseUrl.replace(/\/$/, '') : 'https://matrix.to'; }; export const getMatrixToUser = (userId: string): string => `${MATRIX_TO_BASE}/#/${userId}`; @@ -64,7 +64,8 @@ let cachedRegexes: { const getMatchRegexes = () => { if (cachedRegexBase === MATRIX_TO_BASE && cachedRegexes) return cachedRegexes; cachedRegexBase = MATRIX_TO_BASE; - const standard = escapeForRegex('https://matrix.to'); + // Use https? so both http:// and https://matrix.to are accepted (original behaviour). + const standard = `https?://${escapeForRegex('matrix.to')}`; const b = MATRIX_TO_BASE !== 'https://matrix.to' ? `(?:${standard}|${escapeForRegex(MATRIX_TO_BASE)})` @@ -72,7 +73,7 @@ const getMatchRegexes = () => { cachedRegexes = { any: new RegExp(`^${b}\\S*$`), user: new RegExp(`^${b}/#/(@[^:\\s]+:[^?/\\s]+)\\/?$`), - room: new RegExp(`^${b}/#/([#!][^?/\\s]+)\\/?([?\\S]*)?$`), + room: new RegExp(`^${b}/#/([#!][^?/\\s]+)\\/?(\\?[\\S]*)?$`), event: new RegExp(`^${b}/#/([#!][^?/\\s]+)/(\\$[^?/\\s]+)\\/?([?\\S]*)?$`), }; return cachedRegexes;