Skip to content

Conversation

@timbez
Copy link
Contributor

@timbez timbez commented Jan 15, 2026

Description

include userRealmId in Task resource interface

Implements NAE-2354

Dependencies

Third party dependencies

Blocking Pull requests

How Has Been This Tested?

manually tested

Name Tested on
OS Windows 11
Runtime Node 20.19.4
Dependency Manager NPM 10.8.2
Framework version 17.3.10
Run parameters
Other configuration

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • My changes have been checked, personally or remotely, with @...
  • I have commented my code, particularly in hard-to-understand areas
  • I have resolved all conflicts with the target branch of the PR
  • I have updated and synced my code with the target branch
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes:
    • Lint test
    • Unit tests
    • Integration tests
  • I have checked my contribution with code analysis tools:
  • I have made corresponding changes to the documentation:
    • Developer documentation
    • User Guides
    • Migration Guides

Summary by CodeRabbit

  • Platform Improvements
    • Enhanced user context infrastructure to support improved user identification and management capabilities.

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

- include userRealmId in Task resource interface
@timbez timbez requested review from Kovy95 and machacjozef January 15, 2026 14:00
@timbez timbez self-assigned this Jan 15, 2026
@timbez timbez added the improvement New feature or request label Jan 15, 2026
@coderabbitai
Copy link

coderabbitai bot commented Jan 15, 2026

Walkthrough

Added an optional userRealmId property of type string to the Task interface, positioned immediately after the existing userId property. This is a single-line interface extension with no behavioral changes.

Changes

Cohort / File(s) Summary
Task Interface Extension
projects/netgrif-components-core/src/lib/resources/interface/task.ts
Added optional userRealmId?: string property to Task interface following userId field

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding userRealmId to the Task interface for task responses.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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 and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@projects/netgrif-components-core/src/lib/resources/interface/task.ts`:
- Around line 32-33: Add a JSDoc comment for the userRealmId property in the
Task resource interface to match the existing documentation style used for
userId; locate the userRealmId declaration in the Task interface and add a short
JSDoc line explaining that it represents the realm/identity provider of the user
(e.g., references the same realm concept as UserResourceSmall) and any optional
semantics or format expectations so API consumers understand its purpose.
📜 Review details

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3355fb8 and e151c5c.

📒 Files selected for processing (1)
  • projects/netgrif-components-core/src/lib/resources/interface/task.ts
⏰ 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). (9)
  • GitHub Check: task-list-completed
  • GitHub Check: task-list-completed
  • GitHub Check: task-list-completed
  • GitHub Check: task-list-completed
  • GitHub Check: task-list-completed
  • GitHub Check: Matrix Test (24)
  • GitHub Check: Matrix Test (20)
  • GitHub Check: Test with SonarCloud
  • GitHub Check: Matrix Test (22)
🔇 Additional comments (1)
projects/netgrif-components-core/src/lib/resources/interface/task.ts (1)

33-33: LGTM - Clean interface extension.

The optional userRealmId property is correctly placed after userId, maintains backward compatibility, and follows the existing pattern for optional user-related fields in this interface.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

Comment on lines 32 to +33
userId: string;
userRealmId?: string;
Copy link

Choose a reason for hiding this comment

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

🧹 Nitpick | 🔵 Trivial

Consider adding JSDoc documentation for consistency.

The userId property above has a JSDoc comment referencing UserResourceSmall. For consistency and API clarity, consider documenting userRealmId similarly to explain its purpose and relation to the user realm concept.

📝 Suggested documentation
     */
     userId: string;
+    /**
+     * Realm identifier of the assigned user
+     */
     userRealmId?: string;
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
userId: string;
userRealmId?: string;
userId: string;
/**
* Realm identifier of the assigned user
*/
userRealmId?: string;
🤖 Prompt for AI Agents
In `@projects/netgrif-components-core/src/lib/resources/interface/task.ts` around
lines 32 - 33, Add a JSDoc comment for the userRealmId property in the Task
resource interface to match the existing documentation style used for userId;
locate the userRealmId declaration in the Task interface and add a short JSDoc
line explaining that it represents the realm/identity provider of the user
(e.g., references the same realm concept as UserResourceSmall) and any optional
semantics or format expectations so API consumers understand its purpose.

@sonarqubecloud
Copy link

tuplle
tuplle previously approved these changes Jan 15, 2026
@machacjozef machacjozef changed the base branch from release/7.0.0-rev9 to release/7.0.0-rev10 January 19, 2026 15:45
@machacjozef machacjozef dismissed tuplle’s stale review January 19, 2026 15:45

The base branch was changed.

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

Labels

improvement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants