regression(federation): fix group DM name

[sampaiodiego]

Proposed changes (including videos or screenshots)

Issue(s)

FB-162

[FB-165]

depends on RocketChat/homeserver#321

Steps to test or reproduce

Further comments

Summary by CodeRabbit

• Chores

  • Updated federation service dependency to the latest stable version for improved compatibility and stability.

• Improvements

  • Consolidated direct message creation workflow for more reliable handling of federated environments and group messaging scenarios.

• Tests

  • Expanded test coverage for federated direct message interactions with enhanced room synchronization, membership state validation, and multi-member scenarios.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[changeset-bot]

⚠️ No Changeset found

Latest commit: 7986d68

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

Updates federation-sdk from 0.3.5 to 0.3.7 across two package.json files. Refactors direct message creation in FederationMatrix to use a consolidated federationSDK.createDirectMessage call instead of ad-hoc per-member logic, filtering out the creator and mapping members to federation-friendly user IDs. Corresponding tests updated to validate the new DM creation flow with synchronization assertions.

Changes

Cohort / File(s)	Summary
Dependency Updates apps/meteor/package.json, ee/packages/federation-matrix/package.json	Version bump for @rocket.chat/federation-sdk from 0.3.5 to 0.3.7 across both package manifests.
DM Creation Refactoring ee/packages/federation-matrix/src/FederationMatrix.ts	Consolidated ad-hoc 1-on-1 and group DM creation logic into single federationSDK.createDirectMessage call. Builds creatorUserId from username/server, filters creator from member list, maps members to federation user IDs, and uses returned roomId for federation mapping. Adjusted creator retrieval with field projection to minimize data transfer.
DM End-to-End Tests ee/packages/federation-matrix/tests/end-to-end/dms.spec.ts	Converted failing test cases to active tests with retry patterns (100ms delay). Added assertions for room name validation before/after member joins. Expanded federated DM scenarios with explicit join flow validation and Synapse membership checks. Refined test titles and synchronization validations across RC and Synapse subscriptions.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• fix(federation): DM creation sending invite twice #37222: Modifies per-member invite loop and error handling in FederationMatrix.ts DM creation flow.
• fix(federation): can't add local and remote users together via room creation modal #37208: Implements shift from per-member to batch/consolidated invitation approach in federation DM handling.
• chore: add federation-sdk as dependency for meteor #37268: Updates @rocket.chat/federation-sdk dependency version across package manifests.

Suggested labels

stat: ready to merge, stat: QA assured

Suggested reviewers

• ggazzo
• rodrigok

Poem

🐰 The federation SDK blooms anew at version seven-three,
DMs now gather 'round one call instead of many spree,
Creator and members dance in federation harmony,
Room names reflect the joined, as synced they'll always be! ✨

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'regression(federation): fix group DM name' is directly related to the primary change in the PR, which focuses on fixing group DM naming in the federation implementation. However, it describes only one aspect of the broader changes, which also include power level alignment and federation-sdk updates.
Linked Issues check	✅ Passed	The PR addresses both linked issues: FB-162 is addressed by consolidating DM creation logic to use federationSDK.createDirectMessage and updating test assertions for group DM names; FB-165 is addressed through the federation-sdk dependency update to v0.3.7, which includes power level alignment fixes.
Out of Scope Changes check	✅ Passed	All code changes are within scope: DM creation logic refactoring, test updates for group DM naming and power levels, and federation-sdk dependency update directly support the linked issues and PR objectives.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch federation-fix-multi-dm-name

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between a7ab99f and 7986d68.

⛔ Files ignored due to path filters (1)

• yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (4)

• apps/meteor/package.json
• ee/packages/federation-matrix/package.json
• ee/packages/federation-matrix/src/FederationMatrix.ts
• ee/packages/federation-matrix/tests/end-to-end/dms.spec.ts

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{ts,tsx,js}

📄 CodeRabbit inference engine (.cursor/rules/playwright.mdc)

**/*.{ts,tsx,js}: Write concise, technical TypeScript/JavaScript with accurate typing in Playwright tests
Avoid code comments in the implementation

Files:

• ee/packages/federation-matrix/src/FederationMatrix.ts
• ee/packages/federation-matrix/tests/end-to-end/dms.spec.ts

**/*.spec.ts

📄 CodeRabbit inference engine (.cursor/rules/playwright.mdc)

**/*.spec.ts: Use descriptive test names that clearly communicate expected behavior in Playwright tests
Use .spec.ts extension for test files (e.g., login.spec.ts)

Files:

• ee/packages/federation-matrix/tests/end-to-end/dms.spec.ts

🧠 Learnings (11)

📓 Common learnings

Learnt from: ricardogarim
Repo: RocketChat/Rocket.Chat PR: 37205
File: ee/packages/federation-matrix/src/FederationMatrix.ts:296-301
Timestamp: 2025-10-28T16:53:42.761Z
Learning: In the Rocket.Chat federation-matrix integration (ee/packages/federation-matrix/), the createRoom method from rocket.chat/federation-sdk will support a 4-argument signature (userId, roomName, visibility, displayName) in newer versions. Code using this 4-argument call is forward-compatible with planned library updates and should not be flagged as an error.

Learnt from: ricardogarim
Repo: RocketChat/Rocket.Chat PR: 37205
File: ee/packages/federation-matrix/src/FederationMatrix.ts:296-301
Timestamp: 2025-10-28T16:53:42.761Z
Learning: In the Rocket.Chat federation-matrix integration (ee/packages/federation-matrix/), the createRoom method from rocket.chat/federation-sdk will support a 4-argument signature (userId, roomName, visibility, displayName) in newer versions. Code using this 4-argument call is forward-compatible with planned library updates and should not be flagged as an error.

Learnt from: sampaiodiego
Repo: RocketChat/Rocket.Chat PR: 37357
File: ee/packages/federation-matrix/src/setup.ts:103-120
Timestamp: 2025-11-05T21:04:35.787Z
Learning: In Rocket.Chat's federation-matrix setup (ee/packages/federation-matrix/src/setup.ts and apps/meteor/ee/server/startup/federation.ts), configureFederationMatrixSettings does not need to be called before setupFederationMatrix. The SDK's init() establishes infrastructure (database, event handlers, APIs) first, and the configuration can be applied later via settings watchers before actual federation events are processed. The config only matters when events actually occur, at which point all infrastructure is already configured.

📚 Learning: 2025-09-19T15:15:04.642Z

Learnt from: rodrigok
Repo: RocketChat/Rocket.Chat PR: 36991
File: apps/meteor/server/services/federation/infrastructure/rocket-chat/adapters/Settings.ts:219-221
Timestamp: 2025-09-19T15:15:04.642Z
Learning: The Federation_Matrix_homeserver_domain setting in apps/meteor/server/services/federation/infrastructure/rocket-chat/adapters/Settings.ts is part of the old federation system and is being deprecated/removed, so configuration issues with this setting should not be flagged for improvement.

Applied to files:

• apps/meteor/package.json
• ee/packages/federation-matrix/package.json
• ee/packages/federation-matrix/src/FederationMatrix.ts

📚 Learning: 2025-10-28T16:53:42.761Z

Learnt from: ricardogarim
Repo: RocketChat/Rocket.Chat PR: 37205
File: ee/packages/federation-matrix/src/FederationMatrix.ts:296-301
Timestamp: 2025-10-28T16:53:42.761Z
Learning: In the Rocket.Chat federation-matrix integration (ee/packages/federation-matrix/), the createRoom method from rocket.chat/federation-sdk will support a 4-argument signature (userId, roomName, visibility, displayName) in newer versions. Code using this 4-argument call is forward-compatible with planned library updates and should not be flagged as an error.

Applied to files:

• apps/meteor/package.json
• ee/packages/federation-matrix/package.json
• ee/packages/federation-matrix/src/FederationMatrix.ts
• ee/packages/federation-matrix/tests/end-to-end/dms.spec.ts

📚 Learning: 2025-11-04T16:49:19.107Z

Learnt from: ricardogarim
Repo: RocketChat/Rocket.Chat PR: 37377
File: apps/meteor/ee/server/hooks/federation/index.ts:86-88
Timestamp: 2025-11-04T16:49:19.107Z
Learning: In Rocket.Chat's federation system (apps/meteor/ee/server/hooks/federation/), permission checks follow two distinct patterns: (1) User-initiated federation actions (creating rooms, adding users to federated rooms, joining from invites) should throw MeteorError to inform users they lack 'access-federation' permission. (2) Remote server-initiated federation events should silently skip/ignore when users lack permission. The beforeAddUserToRoom hook only executes for local user-initiated actions, so throwing an error there is correct. Remote federation events are handled separately by the federation Matrix package with silent skipping logic.

Applied to files:

• apps/meteor/package.json
• ee/packages/federation-matrix/src/FederationMatrix.ts
• ee/packages/federation-matrix/tests/end-to-end/dms.spec.ts

📚 Learning: 2025-11-05T21:04:35.787Z

Learnt from: sampaiodiego
Repo: RocketChat/Rocket.Chat PR: 37357
File: ee/packages/federation-matrix/src/setup.ts:103-120
Timestamp: 2025-11-05T21:04:35.787Z
Learning: In Rocket.Chat's federation-matrix setup (ee/packages/federation-matrix/src/setup.ts and apps/meteor/ee/server/startup/federation.ts), configureFederationMatrixSettings does not need to be called before setupFederationMatrix. The SDK's init() establishes infrastructure (database, event handlers, APIs) first, and the configuration can be applied later via settings watchers before actual federation events are processed. The config only matters when events actually occur, at which point all infrastructure is already configured.

Applied to files:

• apps/meteor/package.json
• ee/packages/federation-matrix/package.json
• ee/packages/federation-matrix/src/FederationMatrix.ts

📚 Learning: 2025-09-25T09:59:26.461Z

Learnt from: Dnouv
Repo: RocketChat/Rocket.Chat PR: 37057
File: packages/apps-engine/src/definition/accessors/IUserRead.ts:23-27
Timestamp: 2025-09-25T09:59:26.461Z
Learning: AppUserBridge.getUserRoomIds in apps/meteor/app/apps/server/bridges/users.ts always returns an array of strings by mapping subscription documents to room IDs, never undefined, even when user has no room subscriptions.

Applied to files:

• ee/packages/federation-matrix/src/FederationMatrix.ts

📚 Learning: 2025-09-25T09:59:26.461Z

Learnt from: Dnouv
Repo: RocketChat/Rocket.Chat PR: 37057
File: packages/apps-engine/src/definition/accessors/IUserRead.ts:23-27
Timestamp: 2025-09-25T09:59:26.461Z
Learning: AppUserBridge.getUserRoomIds in apps/meteor/app/apps/server/bridges/users.ts always returns an array of strings (mapping subscription documents to room IDs), never undefined, even when user has no room subscriptions.

Applied to files:

• ee/packages/federation-matrix/src/FederationMatrix.ts

📚 Learning: 2025-09-16T13:33:49.237Z

Learnt from: cardoso
Repo: RocketChat/Rocket.Chat PR: 36890
File: apps/meteor/tests/e2e/e2e-encryption/e2ee-otr.spec.ts:21-26
Timestamp: 2025-09-16T13:33:49.237Z
Learning: The im.delete API endpoint accepts either a `roomId` parameter (requiring the actual DM room _id) or a `username` parameter (for the DM partner's username). Constructing slug-like identifiers like `user2${Users.userE2EE.data.username}` doesn't work for this endpoint.

Applied to files:

• ee/packages/federation-matrix/src/FederationMatrix.ts
• ee/packages/federation-matrix/tests/end-to-end/dms.spec.ts

📚 Learning: 2025-12-09T20:01:00.324Z

Learnt from: sampaiodiego
Repo: RocketChat/Rocket.Chat PR: 37532
File: ee/packages/federation-matrix/src/FederationMatrix.ts:920-927
Timestamp: 2025-12-09T20:01:00.324Z
Learning: When reviewing federation invite handling in Rocket.Chat (specifically under ee/packages/federation-matrix), understand that rejecting an invite via federationSDK.rejectInvite() triggers an event-driven cleanup: a leave event is emitted and handled by handleLeave() in ee/packages/federation-matrix/src/events/member.ts, which calls Room.performUserRemoval() to remove the subscription. Do not add explicit cleanup in the reject branch of handleInvite(); rely on the existing leave-event flow for cleanup. If making changes, ensure this invariant remains and that any related paths still funnel cleanup through the leave event to avoid duplicate or missing removals.

Applied to files:

• ee/packages/federation-matrix/src/FederationMatrix.ts
• ee/packages/federation-matrix/tests/end-to-end/dms.spec.ts

📚 Learning: 2025-11-24T17:08:17.065Z

Learnt from: CR
Repo: RocketChat/Rocket.Chat PR: 0
File: .cursor/rules/playwright.mdc:0-0
Timestamp: 2025-11-24T17:08:17.065Z
Learning: Applies to apps/meteor/tests/e2e/**/*.spec.ts : Ensure tests run reliably in parallel without shared state conflicts

Applied to files:

• ee/packages/federation-matrix/tests/end-to-end/dms.spec.ts

📚 Learning: 2025-09-16T13:33:49.237Z

Learnt from: cardoso
Repo: RocketChat/Rocket.Chat PR: 36890
File: apps/meteor/tests/e2e/e2e-encryption/e2ee-otr.spec.ts:21-26
Timestamp: 2025-09-16T13:33:49.237Z
Learning: In Rocket.Chat test files, the im.delete API endpoint accepts either a `roomId` parameter (requiring the actual DM room _id) or a `username` parameter (for the DM partner's username). It does not accept slug-like constructions such as concatenating usernames together.

Applied to files:

• ee/packages/federation-matrix/tests/end-to-end/dms.spec.ts

🧬 Code graph analysis (2)

ee/packages/federation-matrix/src/FederationMatrix.ts (1)

packages/core-typings/src/IUser.ts (2)

• IUser (187-258)
• isUserNativeFederated (279-280)

ee/packages/federation-matrix/tests/end-to-end/dms.spec.ts (2)

apps/meteor/tests/end-to-end/api/helpers/retry.ts (1)

• retry (12-33)

apps/meteor/tests/data/rooms.helper.ts (2)

• addUserToRoom (121-146)
• getSubscriptionByRoomId (90-106)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)

• GitHub Check: cubic · AI code reviewer
• GitHub Check: 🚢 Build Docker (amd64, authorization-service, queue-worker-service, ddp-streamer-service, cove...
• GitHub Check: 🚢 Build Docker (amd64, rocketchat, coverage)
• GitHub Check: 🚢 Build Docker (arm64, authorization-service, queue-worker-service, ddp-streamer-service, cove...
• GitHub Check: 🚢 Build Docker (arm64, rocketchat, coverage)
• GitHub Check: 🚢 Build Docker (amd64, account-service, presence-service, omnichannel-transcript-service, cove...
• GitHub Check: 🚢 Build Docker (arm64, account-service, presence-service, omnichannel-transcript-service, cove...

🔇 Additional comments (7)

ee/packages/federation-matrix/package.json (1)

25-25: Dependency version bump looks good.

The federation-sdk update to 0.3.7 aligns with the main app's package.json and supports the new createDirectMessage API used in FederationMatrix.ts.

apps/meteor/package.json (1)

102-102: Dependency version aligned correctly.

The federation-sdk 0.3.7 version matches the ee/packages/federation-matrix/package.json, ensuring consistency across the monorepo.

ee/packages/federation-matrix/tests/end-to-end/dms.spec.ts (4)

940-975: Good test coverage for Synapse room name validation.

These new tests effectively validate the PR objectives (FB-162) by verifying:

• Room name shows the inviter's username on Synapse before the invited user joins (line 941)
• Room name updates to show all members after join (line 974)

The retry pattern with { delayMs: 100 } is appropriate for async federation events.

---

1112-1154: Permission validation tests properly updated.

The test at line 1112-1126 correctly validates that a non-owner user (rcUserConfig2) cannot add another user to a group DM. The subsequent test (lines 1128-1154) properly uses retry patterns to handle async federation events when the Synapse admin adds a user.

---

1761-1788: Comprehensive test for multi-user DM invitation flow.

The test validates the complete flow of a Synapse user inviting a fourth Rocket.Chat user, with proper retry-based assertions for:

• Matrix membership state verification
• RC subscription status verification with correct inviter display name

This aligns well with the PR objective (FB-162) to ensure invites display the inviter's name correctly.

---

1679-1713: Well-structured test for 1:1 federated DM creation.

The test properly validates the initial DM creation state before turning it into a group DM, checking that the room shows only the invited Synapse user's name.

ee/packages/federation-matrix/src/FederationMatrix.ts (1)

263-279: The refactored DM creation logic is correct and handles federation user IDs properly.

The consolidated approach correctly:

• Fetches only the required username field for the creator
• Excludes the creator from the members list
• Maps members based on federation status (native federated users use member.username directly; others use @${member.username}:${this.serverName})

Minor consideration: While IUser.username is optional in the type definition, members passed here originate from Users.findUsersByUsernames() queries in createDirectRoom, so username is guaranteed at runtime. No changes needed.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.66%. Comparing base (a7ab99f) to head (7986d68).
⚠️ Report is 5 commits behind head on release-8.0.0.

Additional details and impacted files

@@                Coverage Diff                @@
##           release-8.0.0   #37957      +/-   ##
=================================================
+ Coverage          70.65%   70.66%   +0.01%     
=================================================
  Files               3143     3144       +1     
  Lines             108687   108679       -8     
  Branches           19513    19478      -35     
=================================================
+ Hits               76788    76797       +9     
+ Misses             29901    29889      -12     
+ Partials            1998     1993       -5     

Flag	Coverage Δ
e2e	60.16% <ø> (-0.03%)	⬇️
e2e-api	48.57% <ø> (+1.08%)	⬆️
unit	71.77% <ø> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[cubic-dev-ai]

No issues found across 5 files

[github-actions]

📦 Docker Image Size Report

📈 Changes

Service	Current	Baseline	Change	Percent
sum of all images	1.1GiB	1.1GiB	+11MiB
rocketchat	355MiB	345MiB	+11MiB
omnichannel-transcript-service	132MiB	132MiB	-2.6KiB
queue-worker-service	132MiB	132MiB	-1.7KiB
ddp-streamer-service	126MiB	126MiB	-1.6KiB
account-service	113MiB	113MiB	-1.1KiB
authorization-service	111MiB	111MiB	+24B
presence-service	111MiB	111MiB	-10B

📊 Historical Trend

---
config:
  theme: "dark"
  xyChart:
    width: 900
    height: 400
---
xychart
  title "Image Size Evolution by Service (Last 30 Days + This PR)"
  x-axis ["11/15 22:28", "11/16 01:28", "11/17 23:50", "11/18 22:53", "11/19 23:02", "11/21 16:49", "11/24 17:34", "11/27 22:32", "11/28 19:05", "12/01 23:01", "12/02 21:57", "12/03 21:00", "12/04 18:17", "12/05 21:56", "12/08 20:15", "12/09 22:17", "12/10 23:26", "12/11 21:56", "12/12 22:45", "12/13 01:34", "12/15 22:31", "12/16 22:18", "12/17 21:04", "12/18 23:12", "12/19 23:27", "12/20 21:03", "12/22 18:54", "12/23 16:16", "12/23 22:20 (PR)"]
  y-axis "Size (GB)" 0 --> 0.5
  line "account-service" [0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11]
  line "authorization-service" [0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11]
  line "ddp-streamer-service" [0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12]
  line "omnichannel-transcript-service" [0.14, 0.14, 0.14, 0.14, 0.14, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13]
  line "presence-service" [0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11]
  line "queue-worker-service" [0.14, 0.14, 0.14, 0.14, 0.14, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13]
  line "rocketchat" [0.36, 0.36, 0.35, 0.35, 0.35, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.35]

Loading

Statistics (last 28 days):

• 📊 Average: 1.5GiB
• ⬇️ Minimum: 1.2GiB
• ⬆️ Maximum: 1.6GiB
• 🎯 Current PR: 1.1GiB

ℹ️ About this report

This report compares Docker image sizes from this build against the develop baseline.

• Tag: pr-37957
• Baseline: develop
• Timestamp: 2025-12-23 22:20:30 UTC
• Historical data points: 28

---

Updated: Tue, 23 Dec 2025 22:20:30 GMT