Skip to content

refactor: rename confusing origin getter to senderDomain in EventWrapper #329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Muawiya-contact wants to merge 3 commits into
base: main
Choose a base branch
from
Open

refactor: rename confusing origin getter to senderDomain in EventWrapper #329

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c265ff
refactor: rename confusing origin getter to senderDomain in EventWrapper
Muawiya-contact Jan 19, 2026
61e51f5
refactor: address reviewer feedback on test assertions and unreachabl…
Muawiya-contact Jan 19, 2026
598eb02
refactor(room): split senderDomain from origin semantics in EventWrapper
Muawiya-contact Feb 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions bun.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions packages/federation-sdk/src/services/federation.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,9 @@ export class FederationService {
}

for (const server of servers) {
if (server === event.origin) {
if (server === event.senderDomain) {
this.logger.info(
`Skipping transaction to event origin: ${event.origin}`,
`Skipping transaction to event origin: ${event.senderDomain}`,
);
continue;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/federation-sdk/src/services/room.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1112,7 +1112,7 @@ export class RoomService {

// try to persist the join event now, should succeed with state in place
void this.eventService.processIncomingPDUs(
residentServer || joinEventFinal.origin,
residentServer,
[...state, joinEventFinal.event],
);

Expand Down
4 changes: 2 additions & 2 deletions packages/room/src/authorizartion-rules/rules.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ function isRoomAliasAllowed(
}

// If sender’s domain doesn’t matches state_key, reject.
if (roomAliasEvent.origin !== roomAliasEvent.stateKey) {
if (roomAliasEvent.senderDomain !== roomAliasEvent.stateKey) {
throw new StateResolverAuthorizationError(RejectCodes.AuthError, {
rejectedEvent: roomAliasEvent,
reason:
Expand Down Expand Up @@ -799,7 +799,7 @@ export async function checkEventAuthWithState(
// If the content of the m.room.create event in the room state has the property m.federate set to false, and the sender domain of the event does not match the sender domain of the create event, reject.
if (
roomCreateEvent.getContent()['m.federate'] === false &&
event.origin !== roomCreateEvent.origin
event.senderDomain !== roomCreateEvent.senderDomain
) {
throw new StateResolverAuthorizationError(RejectCodes.AuthError, {
rejectedEvent: event,
Expand Down
32 changes: 25 additions & 7 deletions packages/room/src/manager/event-wrapper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,13 @@ export abstract class PersistentEventBase<
private authEventsIds: Set<EventID> = new Set();
private prevEventsIds: Set<EventID> = new Set();

/**
* The origin server that created this event.
* This is metadata stored separately from the PDU and is used to track
* which server the event came from in federation scenarios.
*/
public eventOrigin?: string;
Copy link
Copy Markdown
Member

@sampaiodiego sampaiodiego Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this new property needed?

Copy link
Copy Markdown
Author

@Muawiya-contact Muawiya-contact Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great catch — you’re right, that extra property is not needed.

I removed eventOrigin and kept the refactor scoped strictly to naming semantics:

  • senderDomain is used only for sender-domain checks (authentication logic).
  • origin remains the federation/server-origin accessor for compatibility.

This keeps the behavior clear without introducing extra mutable state in PersistentEventBase.


constructor(
event: PduWithHashesAndSignaturesOptional,
public readonly version: Version,
Expand Down Expand Up @@ -118,13 +125,15 @@ export abstract class PersistentEventBase<

// TODO: This should be removed or different name used instead?

get origin() {
const domain = extractDomainFromId(this.rawEvent.sender);
if (!domain) {
throw new Error('Invalid sender, no domain found');
}
return domain;
}
/**
* Gets the domain of the sender from their ID.
* @returns {string} The sender's domain.
* @throws {Error} If the sender ID is invalid or has no domain.
*/
get senderDomain() {
const domain = extractDomainFromId(this.rawEvent.sender);
return domain;
}

get residentServer() {
const residentServer = extractDomainFromId(this.rawEvent.room_id);
Expand All @@ -142,6 +151,15 @@ export abstract class PersistentEventBase<
return this.rawEvent.origin_server_ts;
}

/**
* Gets the origin server that created this event.
* This is the server identity where the event originated (from federation).
* @returns {string | undefined} The origin server name, or undefined if not set.
*/
get origin() {
return this.eventOrigin;
}

// if we are accessing the inner event, the event itself should be frozen immediately to not change the reference hash any longer, affecting the id
// if anywhere the code still tries to, we will throw an error, which is why "lock" isn't just a flag in the class.
get event(): Readonly<PduForType<Type>> {
Expand Down
10 changes: 2 additions & 8 deletions packages/room/src/manager/room-state.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,7 @@ export class RoomState {

return topicEvent.getContent().topic;
}

// origin is the origin of the room gotten from the room id
// origin is the domain of the room creator (sender of m.room.create event)
get origin() {
const createEvent = getStateByMapKey(this.stateMap, {
type: 'm.room.create',
Expand All @@ -119,12 +118,7 @@ export class RoomState {
throw new Error('Room create event not found');
}

const origin = createEvent.origin;
if (!origin) {
throw new Error('Room create event has no origin');
}

return origin;
return createEvent.senderDomain;
}

get powerLevels() {
Expand Down