fix: users.presence ignoring comma-separated IDs after OpenAPI migration#40513
Merged
Conversation
Contributor
|
Looks like this PR is ready to merge! 🎉 |
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughThis PR fixes the ChangesFix users.presence comma-separated ID handling
🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
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. Comment |
🦋 Changeset detectedLatest commit: ee2fc11 The changes in this PR will be included in the next version bump. This PR includes changesets to release 42 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
ricardogarim
force-pushed
the
fix/users-presence-comma-separated-ids
branch
3 times, most recently
from
994a6c4 to
ec3c979
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #40513 +/- ##
========================================
Coverage 69.60% 69.61%
========================================
Files 3323 3324 +1
Lines 122610 122651 +41
Branches 21872 21874 +2
========================================
+ Hits 85347 85379 +32
+ Misses 33933 33928 -5
- Partials 3330 3344 +14
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
ricardogarim
force-pushed
the
fix/users-presence-comma-separated-ids
branch
from
ec3c979 to
1015c10
Compare
ricardogarim
force-pushed
the
fix/users-presence-comma-separated-ids
branch
3 times, most recently
from
29963d7 to
fb643e9
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
apps/meteor/app/api/server/v1/users.ts (1)
1541-1543: ⚡ Quick winConsider filtering out empty strings after splitting.
The normalization logic correctly handles both string and array inputs by wrapping, flattening, and splitting on commas. However, edge cases like
ids=""orids="id1,,id3"(double comma) will produce empty strings in theuserIdsarray after splitting. While the MongoDB query will simply not match empty IDs (not a correctness issue), filtering out empty strings would make the logic more robust.♻️ Suggested improvement
-const userIds = [ids].flat().flatMap((id) => id.split(',')); +const userIds = [ids].flat().flatMap((id) => id.split(',')).filter((id) => id.trim());🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@apps/meteor/app/api/server/v1/users.ts` around lines 1541 - 1543, When building userIds from ids (the line initializing userIds and the call to Users.findNotOfflineByIds), filter out empty strings and whitespace-only entries after splitting to avoid passing "" into the DB query; update the normalization pipeline that produces userIds (e.g., after .split(',')) to trim each id and remove falsy or empty values (for example via a .map(trim) then .filter(id => id !== '') or equivalent) before passing userIds into Users.findNotOfflineByIds.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@apps/meteor/app/api/server/v1/users.ts`:
- Around line 1541-1543: When building userIds from ids (the line initializing
userIds and the call to Users.findNotOfflineByIds), filter out empty strings and
whitespace-only entries after splitting to avoid passing "" into the DB query;
update the normalization pipeline that produces userIds (e.g., after
.split(',')) to trim each id and remove falsy or empty values (for example via a
.map(trim) then .filter(id => id !== '') or equivalent) before passing userIds
into Users.findNotOfflineByIds.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 6efb4b70-34a9-40a0-a9ee-7f55e270465a
📒 Files selected for processing (3)
.changeset/fix-presence-comma-ids.mdapps/meteor/app/api/server/v1/users.tspackages/rest-typings/src/v1/users/UsersPresenceParamsGET.ts
🚧 Files skipped from review as they are similar to previous changes (1)
- .changeset/fix-presence-comma-ids.md
📜 Review details
⏰ 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). (2)
- GitHub Check: 📦 Build Packages
- GitHub Check: CodeQL-Build
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{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:
packages/rest-typings/src/v1/users/UsersPresenceParamsGET.tsapps/meteor/app/api/server/v1/users.ts
🧠 Learnings (8)
📚 Learning: 2026-02-26T19:25:44.063Z
Learnt from: gabriellsh
Repo: RocketChat/Rocket.Chat PR: 38778
File: packages/ui-voip/src/providers/useMediaSession.ts:192-192
Timestamp: 2026-02-26T19:25:44.063Z
Learning: In the Rocket.Chat repository, do not reference Biome lint rules in code review feedback. Biome is not used even if biome.json exists; only reference Biome rules if there is explicit, project-wide usage documented. For TypeScript files, review lint implications without Biome guidance unless the project enables Biome rules.
Applied to files:
packages/rest-typings/src/v1/users/UsersPresenceParamsGET.tsapps/meteor/app/api/server/v1/users.ts
📚 Learning: 2026-02-26T19:25:44.063Z
Learnt from: gabriellsh
Repo: RocketChat/Rocket.Chat PR: 38778
File: packages/ui-voip/src/providers/useMediaSession.ts:192-192
Timestamp: 2026-02-26T19:25:44.063Z
Learning: In this repository (RocketChat/Rocket.Chat), Biome lint rules are not used even if a biome.json exists. When reviewing TypeScript files (e.g., packages/ui-voip/src/providers/useMediaSession.ts), ensure lint suggestions do not reference Biome-specific rules. Rely on general ESLint/TypeScript lint rules and project conventions instead.
Applied to files:
packages/rest-typings/src/v1/users/UsersPresenceParamsGET.tsapps/meteor/app/api/server/v1/users.ts
📚 Learning: 2026-05-06T12:21:44.083Z
Learnt from: juliajforesti
Repo: RocketChat/Rocket.Chat PR: 40256
File: apps/meteor/client/components/CreateDiscussion/CreateDiscussion.tsx:121-149
Timestamp: 2026-05-06T12:21:44.083Z
Learning: Field wrappers in rocket.chat/fuselage-forms (Field, FieldLabel, FieldRow, FieldError, FieldHint) auto-create htmlFor/id associations, aria-describedby, and role="alert" for errors. Do not manually set htmlFor, id, aria-describedby, or role attributes when using these wrappers. This automatic wiring does not apply to plain rocket.chat/fuselage components, which require explicit ID wiring per the accessibility docs. In code reviews, prefer using fuselage-forms wrappers for form fields and verify there is no unnecessary manual ID/aria wiring in files that use these wrappers. If a component uses plain fuselage components, ensure proper id wiring as per docs.
Applied to files:
packages/rest-typings/src/v1/users/UsersPresenceParamsGET.tsapps/meteor/app/api/server/v1/users.ts
📚 Learning: 2026-05-11T23:14:59.316Z
Learnt from: ricardogarim
Repo: RocketChat/Rocket.Chat PR: 40469
File: packages/rest-typings/src/v1/users.ts:337-337
Timestamp: 2026-05-11T23:14:59.316Z
Learning: In Rocket.Chat REST endpoint typings (e.g., packages/rest-typings/src/v1/users.ts and other rest-typings files), keep the established convention of deriving field types from the domain model (e.g., use IUser indexed access like IUser['statusExpiresAt']) rather than swapping individual fields to serialized primitives (like string) in an ad-hoc way. If a truly different “serialized” representation is needed, perform the refactor consistently across the codebase (not just a single endpoint/field) and ensure all related REST typings stay aligned with the shared serialization types.
Applied to files:
packages/rest-typings/src/v1/users/UsersPresenceParamsGET.ts
📚 Learning: 2026-02-23T17:53:06.802Z
Learnt from: ggazzo
Repo: RocketChat/Rocket.Chat PR: 35995
File: apps/meteor/app/api/server/v1/rooms.ts:1107-1112
Timestamp: 2026-02-23T17:53:06.802Z
Learning: During PR reviews that touch endpoint files under apps/meteor/app/api/server/v1, enforce strict scope: if a PR targets a specific endpoint (e.g., rooms.favorite), do not propose changes to unrelated endpoints (e.g., rooms.invite) unless maintainers explicitly request them. Focus feedback on the touched endpoint's behavior, API surface, and related tests; avoid broad cross-endpoint changes in the same PR unless requested.
Applied to files:
apps/meteor/app/api/server/v1/users.ts
📚 Learning: 2026-02-24T19:09:01.522Z
Learnt from: ahmed-n-abdeltwab
Repo: RocketChat/Rocket.Chat PR: 38974
File: apps/meteor/app/api/server/v1/im.ts:220-221
Timestamp: 2026-02-24T19:09:01.522Z
Learning: In Rocket.Chat OpenAPI migration PRs for endpoints under apps/meteor/app/api/server/v1, avoid introducing logic changes. Only perform scope-tight changes that preserve behavior; style-only cleanups (e.g., removing inline comments) may be deferred to follow-ups to keep the migration PR focused.
Applied to files:
apps/meteor/app/api/server/v1/users.ts
📚 Learning: 2026-03-15T14:31:25.380Z
Learnt from: amitb0ra
Repo: RocketChat/Rocket.Chat PR: 39647
File: apps/meteor/app/api/server/v1/users.ts:710-757
Timestamp: 2026-03-15T14:31:25.380Z
Learning: Do not flag this type/schema misalignment in the OpenAPI/migration review for apps/meteor/app/api/server/v1/users.ts. The UserCreateParamsPOST type intentionally uses non-optional fields: fields: string and settings?: IUserSettings without an AJV schema entry, carried over from the original rest-typings (PR `#39647`). Treat this as a known pre-existing divergence and document it as a separate follow-up fix; do not block or mark it as a review issue during the migration.
Applied to files:
apps/meteor/app/api/server/v1/users.ts
📚 Learning: 2026-03-16T23:33:11.443Z
Learnt from: amitb0ra
Repo: RocketChat/Rocket.Chat PR: 39676
File: apps/meteor/app/api/server/v1/users.ts:862-869
Timestamp: 2026-03-16T23:33:11.443Z
Learning: In rockets OpenAPI/AJV migration reviews for RocketChat/Rocket.Chat, when reviewing migrations that involve apps/meteor/app/api/server/v1/users.ts, do not require or flag a missing query AJV schema for the fields consumed by parseJsonQuery() (i.e., fields, sort, query) as part of this endpoint's migration PR. The addition of global query-param schemas for parseJsonQuery() usage is a cross-cutting concern and out of scope for individual endpoint migrations. Only flag violations related to the specific scope of the migration, not the absence of a query schema for parseJsonQuery() in this file.
Applied to files:
apps/meteor/app/api/server/v1/users.ts
🔇 Additional comments (2)
packages/rest-typings/src/v1/users/UsersPresenceParamsGET.ts (2)
13-14: PR description claims schema changed totype: 'string', but implementation usestype: ['string', 'array'].The PR objectives state: "Change ids schema to type: 'string' (consistent with groups, channels, im, settings endpoints)." However, the actual implementation on line 13 uses
type: ['string', 'array'], nottype: 'string'. The schema still accepts both strings and arrays, which differs from the stated objective. The fix works becausetype: ['string', 'array']prevents AJV'scoerceTypes: 'array'from coercing the string"id1,id2"into a single-element array["id1,id2"], while the server-side normalization on line 1541 of the users.ts file handles both input forms.
13-14: LGTM!
ricardogarim
force-pushed
the
fix/users-presence-comma-separated-ids
branch
from
fb643e9 to
ddafd25
Compare
ricardogarim
force-pushed
the
fix/users-presence-comma-separated-ids
branch
from
ddafd25 to
3a858fc
Compare
ggazzo
requested changes
May 13, 2026
ggazzo
left a comment
ggazzo
left a comment
Member
There was a problem hiding this comment.
Since this behavior is 'special' , can we create a test to ensure that it won't change?
ricardogarim
force-pushed
the
fix/users-presence-comma-separated-ids
branch
from
5cd16b8 to
ee2fc11
Compare
ricardogarim
added
the
stat: QA assured
dionisio-bot
Bot
added
the
stat: ready to merge
ggazzo
approved these changes
May 14, 2026
Member
Author
|
/patch |
Contributor
|
Pull request #40527 added to Project: "Patch 8.4.2" |
Merged
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed changes
Regression in 8.4.0:
GET /v1/users.presence?ids=id1,id2,id3returns an empty array when called with multiple comma-separated IDs. Single ID works fine. This breaks user presence on mobile, where everyone appears offline.Root cause: PR #39553 (OpenAPI migration) added
ajvQueryvalidation withanyOf: [string, array]. Combined withajvQuery'scoerceTypes: 'array', AJV coerces"id1,id2"into["id1,id2"](single-element array), skipping the.split(',')logic.The endpoint accepts three formats:
?ids=userId1- single ID (string)?ids=userId1&ids=userId2- repeated params (array)?ids=userId1,userId2- comma-separated (string, but AJV coerces to["userId1,userId2"]— broken case)Fix:
anyOfwithtype: ['string', 'array']to avoid AJV coercion issues (ajv#1140)Issue(s)
Steps to test or reproduce
GET /v1/users.presence?ids=<userId>- single ID, returns the userGET /v1/users.presence?ids=<userId1>,<userId2>- comma-separated, returns empty (before fix), returns both (after fix)GET /v1/users.presence?ids=<userId1>&ids=<userId2>- repeated params, returns bothSummary by CodeRabbit
users.presenceendpoint to correctly handle multiple comma-separated user IDs instead of returning an empty array.