MG-2541 - Fix list domain users sdk

[WashingtonKK]

What type of PR is this?

This is a bug fix

What does this do?

Fixes list domain users on sdk

Which issue(s) does this PR fix/relate to?

• Related Issue Bug: List domain users using sdk absmach/supermq#2541

Have you included tests for your changes?

Did you document any new/modified feature?

Notes

Summary by CodeRabbit

• Bug Fixes
  • Improved the API request URL construction for retrieving users associated with a specific domain, enhancing reliability in data retrieval.

[coderabbitai]

Walkthrough

The pull request modifies the ListDomainUsers method in the pkg/sdk/go/domains.go file. The change involves a simplification of the URL construction for API requests related to retrieving users associated with a specific domain. The new implementation uses a more straightforward approach by directly incorporating the domainID with the usersEndpoint, without altering any other methods or functionalities in the file.

Changes

File	Change Summary
pkg/sdk/go/domains.go	Modified the ListDomainUsers method to simplify URL construction for API requests.

Poem

In the code where domains play,
A simpler path has found its way.
With users now in clear sight,
The API shines, oh what a delight!
Hopping through lines, we cheer and say,
"Code so neat, hip-hip-hooray!" 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 92e84c0 and f9abea5.

📒 Files selected for processing (1)

• pkg/sdk/go/domains.go (1 hunks)

🔇 Additional comments (3)

pkg/sdk/go/domains.go (3)

Line range hint 132-143: Validate error handling and response processing

The implementation looks correct with proper error handling for:

1. URL construction errors
2. HTTP request errors
3. JSON unmarshaling errors

---

132-132: Verify URL construction consistency with other domain operations

The URL construction pattern has been changed to use sdk.usersURL instead of sdk.domainsURL, which differs from other domain-user operations in this file. Let's verify this change:

1. AddUserToDomain uses: sdk.domainsURL/domains/{domainID}/users/assign
2. RemoveUserFromDomain uses: sdk.domainsURL/domains/{domainID}/users/unassign
3. New ListDomainUsers uses: sdk.usersURL/{domainID}/users

Consider maintaining consistent URL patterns across all domain-user operations. If this change is intentional due to API design changes, please ensure:

1. The API endpoints are documented
2. Other domain-user operations are updated if needed
3. The change is backward compatible or version controlled

✅ Verification successful

URL construction pattern is consistent with API design

Based on the search results, the URL construction pattern is actually consistent with the API design:

1. Operations on users (listing, searching) use sdk.usersURL base

   • ListDomainUsers: sdk.usersURL/{domainID}/users
   • Similar pattern seen in channels: sdk.usersURL/{domainID}/channels/{channelID}/users
   • Similar pattern seen in things: sdk.usersURL/{domainID}/things/{thingID}/users

2. Operations for domain management use sdk.domainsURL base

   • AddUserToDomain: sdk.domainsURL/domains/{domainID}/users/assign
   • RemoveUserFromDomain: sdk.domainsURL/domains/{domainID}/users/unassign

The change aligns with the codebase's pattern where user-centric operations (like listing) use usersURL, while domain management operations use domainsURL. This separation appears intentional in the API design.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the API endpoint patterns across the codebase
# Look for other instances of domain-user related endpoints to ensure consistency

# Search for domain-user related endpoint patterns
echo "Searching for domain-user endpoint patterns..."
rg -A 2 "fmt.Sprintf.*domains.*users|fmt.Sprintf.*users.*domains" --type go

# Search for usersURL usage patterns
echo "Searching for usersURL usage patterns..."
rg "sdk.usersURL" --type go

Length of output: 6262

---

Line range hint 132-143: Verify the fix resolves issue absmach#2541

The URL construction change appears to address the domain users listing bug. To ensure complete resolution:

Would you like me to help create regression tests to verify this fix prevents similar issues in the future?

✅ Verification successful

URL construction fix for domain users listing is verified

The fix correctly addresses issue absmach#2541 where domain users listing was failing due to incorrect URL construction. The changes now:

• Properly include the domainID in the URL path as required by the users service
• Match the endpoint pattern used in other domain-user operations (assign/unassign)
• Have corresponding test coverage in both SDK and CLI layers

The implementation is consistent with other domain-user operations in the codebase and resolves the "Not Found" error reported in the issue.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Look for related test files and potential regression tests

# Search for related test files
echo "Searching for related test files..."
fd -e go -e yaml -e json "domain.*test|test.*domain" 

# Look for any TODO/FIXME comments related to domain users
echo "Checking for related TODO/FIXME comments..."
rg "TODO|FIXME|XXX|HACK|BUG" -A 3 --type go | rg -i "domain.*user|user.*domain"

Length of output: 412

---

Script:

#!/bin/bash
# Let's examine the test files we found and look for domain users related tests
echo "=== Checking domains_test.go files for user-related tests ==="
for file in pkg/sdk/go/domains_test.go auth/domains_test.go auth/postgres/domains_test.go cli/domains_test.go; do
    echo "=== Content of $file ==="
    rg "Test.*User.*Domain|Test.*Domain.*User" "$file" -A 5
done

# Let's also check the actual implementation and issue
echo "=== Checking implementation details ==="
rg "usersURL|usersEndpoint" pkg/sdk/go/domains.go -A 2

# Let's look at the issue description if available
echo "=== Checking issue #2541 references ==="
gh issue view 2541 || echo "Issue not accessible"

Length of output: 3830

---

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.