feat: add tenant code to role apis

[nevil-mathew]

Summary by CodeRabbit

• New Features

  • Role management operations now support tenant-level filtering and localization for role labels.
  • Improved error messages for role creation and update, including specific feedback when a role title is not unique.

• Bug Fixes

  • Corrected and clarified various success and error messages related to role management actions.

• Documentation

  • Enhanced method documentation for role management operations, providing clearer parameter details and usage notes.

• Refactor

  • Deprecated older role listing methods in favor of updated, tenant-aware alternatives.
  • Standardized naming and parameter usage for improved consistency.

[coderabbitai]

Walkthrough

The changes introduce tenant-aware handling in user role management by updating method signatures and logic in controllers and services to include tenant_code. Methods now filter and operate based on both organization and tenant context. Localization messages were refined for clarity, and error handling for unique role constraints was improved. Deprecated methods were commented out.

Changes

Cohort / File(s)	Change Summary
Controller: Tenant-aware Role Methods & Docs src/controllers/v1/user-role.js	Enhanced JSDoc documentation, added tenant_code to method signatures for create, update, delete, and list. Renamed defaultlist to list. Deprecated and commented out default method.
Service: Tenant-aware Logic & Error Handling src/services/user-role.js	Updated all methods to accept and use tenantCode. Added tenant filtering, improved unique constraint error handling, and included optional language for listing. Deprecated and commented out defaultList.
Database Query: Parameter Naming src/database/queries/user-role.js	Changed parameter name from updatedata to updateData in updateRole for consistency.
Localization: Role Message Refinement src/locales/en.json	Refined role-related messages for clarity, corrected singular/plural usage, added new error key for uniqueness, and improved message consistency.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Controller (userRole)
    participant Service (userRoleHelper)
    participant Database

    Client->>Controller (userRole): Create/Update/Delete/List Role (with JWT)
    Controller (userRole)->>Service (userRoleHelper): Call method with (data, organization_id, tenant_code, ...)
    Service (userRoleHelper)->>Database: Query/Update with organization_id, tenant_code
    Database-->>Service (userRoleHelper): Result/Error
    Service (userRoleHelper)-->>Controller (userRole): Response (success/failure, localization)
    Controller (userRole)-->>Client: API Response

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

A bunny hops through code anew,
With tenants now in every view!
Roles are checked with careful eyes,
Unique constraints bring no surprise.
Messages clear, in English bright—
Deprecated paths fade out of sight.
🐇✨ This warren’s code feels just right!

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8f4df7e and bbbf733.

📒 Files selected for processing (4)

• src/controllers/v1/user-role.js (3 hunks)
• src/database/queries/user-role.js (1 hunks)
• src/locales/en.json (1 hunks)
• src/services/user-role.js (6 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

src/database/queries/**

⚙️ CodeRabbit Configuration File

Review database queries for performance. Check for N+1 problems and ensure indexes can be used.

Files:

• src/database/queries/user-role.js

src/controllers/**

⚙️ CodeRabbit Configuration File

These are API controllers. Focus on request/response handling, security (auth middleware usage), and proper status codes.

Files:

• src/controllers/v1/user-role.js

src/services/**

⚙️ CodeRabbit Configuration File

This is core business logic. Please check for correctness, efficiency, and potential edge cases.

Files:

• src/services/user-role.js

🧠 Learnings (3)

📓 Common learnings

Learnt from: nevil-mathew
PR: ELEVATE-Project/user#776
File: src/services/entities.js:18-23
Timestamp: 2025-07-31T08:44:36.982Z
Learning: In the ELEVATE-Project/user codebase, organizationCode and tenantCode parameters passed to service methods always come from req.decodedToken.organization_code and req.decodedToken.tenant_code, which are guaranteed to be present after token validation. Additional validation for these parameters in service methods is unnecessary as the token validation process ensures they are always available.

Learnt from: nevil-mathew
PR: ELEVATE-Project/user#776
File: src/database/models/entityType.js:38-38
Timestamp: 2025-07-31T08:43:35.971Z
Learning: The migration for converting tenant_code to a primary key in the EntityType model was already handled in a previous PR, not in the current refactoring PR that focuses on organization codes instead of organization IDs.

📚 Learning: in the elevate-project/user codebase, organizationcode and tenantcode parameters passed to service m...

Learnt from: nevil-mathew
PR: ELEVATE-Project/user#776
File: src/services/entities.js:18-23
Timestamp: 2025-07-31T08:44:36.982Z
Learning: In the ELEVATE-Project/user codebase, organizationCode and tenantCode parameters passed to service methods always come from req.decodedToken.organization_code and req.decodedToken.tenant_code, which are guaranteed to be present after token validation. Additional validation for these parameters in service methods is unnecessary as the token validation process ensures they are always available.

Applied to files:

• src/controllers/v1/user-role.js
• src/services/user-role.js

📚 Learning: the migration for converting tenant_code to a primary key in the entitytype model was already handle...

Learnt from: nevil-mathew
PR: ELEVATE-Project/user#776
File: src/database/models/entityType.js:38-38
Timestamp: 2025-07-31T08:43:35.971Z
Learning: The migration for converting tenant_code to a primary key in the EntityType model was already handled in a previous PR, not in the current refactoring PR that focuses on organization codes instead of organization IDs.

Applied to files:

• src/services/user-role.js

🔇 Additional comments (12)

src/database/queries/user-role.js (1)

67-69: LGTM - Improved naming consistency.

The parameter name change from updatedata to updateData follows proper camelCase convention and improves code readability.

src/locales/en.json (1)

106-113: LGTM - Improved message consistency and clarity.

The localization updates provide several improvements:

• Consistent singular/plural usage (singular for individual operations, plural for listings)
• Fixed incorrect "Module deleted successfully" to "Role deleted successfully"
• Added new "ROLE_IS_NOT_UNIQUE" message for constraint violations
• More descriptive error messages like "The role has already been deleted or does not exist"
• Added periods for consistency

These changes align well with the enhanced error handling in the service layer.

src/controllers/v1/user-role.js (5)

30-34: LGTM - Proper tenant context integration.

The create method correctly extracts tenant_code from the decoded token and passes it to the service layer, enabling tenant-aware role creation.

---

60-65: LGTM - Consistent tenant filtering for updates.

The update method properly includes tenant_code to ensure role updates are scoped to the correct tenant context.

---

83-87: LGTM - Tenant-aware role deletion.

The delete method correctly passes tenant_code to ensure roles can only be deleted within the appropriate tenant scope.

---

107-117: LGTM - Enhanced list method with tenant context and localization.

The list method improvements include:

• Tenant-aware filtering via tenant_code
• Optional language parameter for localization support
• Consistent parameter passing to service layer

---

125-150: LGTM - Proper deprecation of legacy method.

The deprecated default method is properly commented out with clear deprecation notice directing users to the updated list() method.

src/services/user-role.js (5)

34-62: LGTM - Comprehensive tenant-aware role creation with proper error handling.

The create method enhancements include:

• Proper tenant_code assignment to role data
• Tenant_code included in response for consistency
• Unique constraint error handling with appropriate HTTP status and localized message
• Follows established error handling patterns

The uniqueness constraint handling is particularly well implemented, providing clear feedback when role titles conflict within a tenant.

---

81-114: LGTM - Tenant-scoped updates with robust error handling.

The update method correctly:

• Includes tenant_code in filter criteria alongside organization_id and role id
• Handles uniqueness constraint violations consistently with create method
• Maintains proper error responses and status codes
• Ensures updates are tenant-isolated

---

126-147: LGTM - Proper tenant filtering for role deletion.

The delete method appropriately:

• Scopes deletion by tenant_code, organization_id, and role id
• Uses updated localization message for clearer error feedback
• Maintains consistent response patterns

---

163-225: LGTM - Comprehensive tenant-aware listing with localization support.

The list method provides excellent functionality:

• Proper tenant_code filtering for both user organization and default organization roles
• Includes tenant_code in selected attributes for completeness
• Language-based localization support with fallback handling
• Maintains pagination and search capabilities
• Clean separation of translated vs. non-translated data

The logic correctly handles multi-tenant scenarios while preserving access to default organization roles.

---

239-280: LGTM - Proper deprecation with clear migration path.

The deprecated defaultList method is appropriately commented out with clear deprecation notice, guiding developers to use the enhanced list() method instead.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch user-role-fix

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.