Skip to content

fix: use $ne operator in findCustomRoles to include roles without protected field#41329

Open
prathamesh04 wants to merge 1 commit into
RocketChat:developfrom
prathamesh04:fix/findCustomRoles-false-negative
Open

fix: use $ne operator in findCustomRoles to include roles without protected field#41329
prathamesh04 wants to merge 1 commit into
RocketChat:developfrom
prathamesh04:fix/findCustomRoles-false-negative

Conversation

@prathamesh04

@prathamesh04 prathamesh04 commented Jul 12, 2026

Copy link
Copy Markdown

Description

This PR fixes a bug in findCustomRoles and countCustomRoles methods in packages/models/src/models/Roles.ts where roles without the protected field were being excluded from results.

Problem

The original query used protected: false which only matches documents where the protected field exists and is explicitly false. It does NOT match documents where the protected field is missing/undefined.

This causes issues on older Rocket.Chat instances where custom roles were created before the protected field was added to the schema. These roles are invisible to findCustomRoles and countCustomRoles.

Solution

Changed the query from protected: false to protected: { $ne: true } which:

  1. Matches documents where protected is false
  2. Matches documents where protected is undefined/missing
  3. Only excludes documents where protected is explicitly true

This is consistent with how MongoDB's $ne operator works and handles the edge case of missing fields properly.

Related Issue

Closes #40798

Changes

  • packages/models/src/models/Roles.ts: Updated findCustomRoles and countCustomRoles query filters

Review in cubic

Summary by CodeRabbit

  • Bug Fixes
    • Improved custom role filtering to include roles without an explicitly defined protected status, while continuing to exclude protected roles.

@prathamesh04 prathamesh04 requested a review from a team as a code owner July 12, 2026 14:55
@dionisio-bot

dionisio-bot Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Looks like this PR is not ready to merge, because of the following issues:

  • This PR is missing the 'stat: QA assured' label
  • This PR is missing the required milestone or project

Please fix the issues and try again

If you have any trouble, please check the PR guidelines

@changeset-bot

changeset-bot Bot commented Jul 12, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: a871369

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

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 40b6ce41-0b50-477c-9a8a-478f0f4dc5ad

📥 Commits

Reviewing files that changed from the base of the PR and between edbaeef and a871369.

📒 Files selected for processing (1)
  • packages/models/src/models/Roles.ts
📜 Recent review details
⏰ Context from checks skipped due to timeout. (2)
  • GitHub Check: CodeRabbit
  • GitHub Check: cubic · AI code reviewer
🧰 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/models/src/models/Roles.ts
🧠 Learnings (3)
📚 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/models/src/models/Roles.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/models/src/models/Roles.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/models/src/models/Roles.ts
🔇 Additional comments (1)
packages/models/src/models/Roles.ts (1)

129-135: LGTM!

Also applies to: 137-142


Walkthrough

Custom role retrieval and counting now exclude only roles with protected: true, allowing roles where protected is false or absent.

Changes

Custom role filtering

Layer / File(s) Summary
Update custom role query filters
packages/models/src/models/Roles.ts
findCustomRoles and countCustomRoles use protected: { $ne: true } instead of requiring protected: false.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested labels: type: bug

🚥 Pre-merge checks | ✅ 5
✅ 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 clearly describes the main change: switching findCustomRoles to use $ne so roles without protected are included.
Linked Issues check ✅ Passed The diff matches issue #40798 by treating missing protected fields as custom roles in findCustomRoles and countCustomRoles.
Out of Scope Changes check ✅ Passed The pull request is narrowly scoped to the role query fix and does not introduce unrelated changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

Comment @coderabbitai help to get the list of available commands.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 1 file

Re-trigger cubic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

findCustomRoles in src/models/Roles.ts produce "false negative".

1 participant