make it possible to query using parameters

[Baalmart]

Description

make it possible to query using parameters

Changes Made

• make it possible to query using parameters

Testing

• Tested locally
• Tested against staging environment
• Relevant tests passed: [List test names]

Affected Services

• Which services were modified:
  • Auth Service

Endpoints Ready for Testing

• New endpoints ready for testing:
  • Get available users for network
  • Get assigned users for network

API Documentation Updated?

• Yes, API documentation was updated
• No, API documentation does not need updating

Additional Notes

make it possible to query using parameters

Summary by CodeRabbit

• New Features

  • Enhanced user retrieval with a new filtering mechanism for listing available and assigned users based on network roles.
  • Improved accuracy in user listings by excluding already assigned users from the available users list.

• Bug Fixes

  • Maintained existing error handling and logging mechanisms to ensure stability.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request enhance the createNetwork utility in src/auth-service/utils/create-network.js by introducing a new filtering mechanism for user retrieval in the listAvailableUsers and listAssignedUsers methods. A usersFilter is generated to refine queries based on network roles, ensuring that listAvailableUsers excludes users already assigned to a network, while listAssignedUsers filters for those assigned. The overall control flow remains unchanged, maintaining existing error handling and logging.

Changes

File Path	Change Summary
src/auth-service/utils/create-network.js	- Added a usersFilter for refined user queries in listAvailableUsers and listAssignedUsers. - Updated listAvailableUsers to exclude users assigned to the network. - Updated listAssignedUsers to include only users assigned to the network.

Possibly related PRs

• temporarily re-enable network deletion #3954: Modifies the delete method in src/auth-service/utils/create-network.js, related to the createNetwork utility.
• temporarily allow creation and deletion of networks #3976: Changes the create and delete methods in src/auth-service/utils/create-network.js, indicating a direct connection in functionality.
• addressing quick feedback around users pagination #4009: Updates the listAvailableUsers and listAssignedUsers methods in src/auth-service/utils/create-network.js, aligning with the enhancements in the main PR.

Suggested reviewers

• Codebmk

🎉 In the realm of code, where changes unfold,
A filter is born, both clever and bold.
Users now listed with roles in their sight,
Assigned or available, all done just right!
With logic intact, and flow still the same,
This utility shines, enhancing the game! ✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 11.73%. Comparing base (a0525c4) to head (c079505).
Report is 22 commits behind head on staging.

Additional details and impacted files

@@           Coverage Diff            @@
##           staging    #4013   +/-   ##
========================================
  Coverage    11.73%   11.73%           
========================================
  Files          114      114           
  Lines        15331    15331           
  Branches       319      319           
========================================
  Hits          1799     1799           
  Misses       13532    13532           

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

src/auth-service/utils/create-network.js (1)

1035-1036: Consider adding validation for the generated filter.

While the implementation is solid, it might be good to add validation for the output of generateFilter.users() to ensure it returns the expected structure. This would make the code more robust against potential changes in the filter generation logic.

+      // Validate user filter structure
+      const usersFilter = generateFilter.users(request, next);
+      if (!usersFilter || typeof usersFilter !== 'object') {
+        next(
+          new HttpError(
+            "Internal Server Error",
+            httpStatus.INTERNAL_SERVER_ERROR,
+            { message: "Invalid user filter generated" }
+          )
+        );
+      }

Also applies to: 1082-1083

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fc064f6 and c079505.

📒 Files selected for processing (1)

• src/auth-service/utils/create-network.js (2 hunks)

🔇 Additional comments (2)

src/auth-service/utils/create-network.js (2)

1035-1038: LGTM! Clean implementation of user filtering.

The addition of usersFilter and its combination with network-specific filtering is well-structured and maintains good separation of concerns.

---

1082-1085: LGTM! Consistent implementation of filtering logic.

The filtering implementation mirrors the pattern used in listAvailableUsers, maintaining code consistency across similar operations.

[github-actions]

Auth-service changes in this PR available for preview here