User: Support sort query param for user and org user, search endpoints

[gamab]

What is this feature?

Support sort query param for user and org user, search endpoints.
This scope param will allow to order (asc or desc) from the backend, the user list based on login, email, name, last_seen_at fields.

Required by: #75228

Why do we need this feature?

[Add a description of the problem the feature is trying to solve.]

Who is this feature for?

[Add information on what kind of user the feature is for.]

Which issue(s) does this PR fix?:

Fixes #

Special notes for your reviewer:

Please check that:

• It works as expected from a user's perspective.
• If this is a pre-GA feature, it is behind a feature toggle.
• The docs are updated, and if this is a notable improvement, it's added to our What's New doc.

[gamab]

Moved all interface here to prevent a cyclic import situation

[linoman]

Looks really good already! Do you think we should update the endpoints comments to include the new optional query parameter?

[eleijonmarck]

nits

• nit: should we add benchmarks to see how the impact is for big users bases? (i created about 100 users locally when i tested for retrieving the sorted users)
• nit: perhaps we can add a comment above this line about not surfacing the err if we use the wrong sorting option. and if so perhaps log it.
• nit: add documentation about using sort options

testing locally works fine ⚡
searching with correct sorting works as expected 👍
http://admin:admin@localhost:3000/api/users/search?query=a&sort=login-asc

---

notes:
sorting using the wrong sorting option asc yields a "unreasonable" error:

http://admin:admin@localhost:3000/api/users/search?query=a&sort=asc

response:
{
"message": "Failed to fetch users",
"traceID": ""
}

but the error is:

MessageID:
"unknown sorting option"
LogMessage:
"asc option unknown"

this line https://github.com/grafana/grafana/blob/gamab/user-sort-option/pkg/services/searchusers/searchusers.go#L65

does not provide the error in the message. most likely because we want to hide user info.

[gamab]

nit: should we add benchmarks to see how the impact is for big users bases? (i created about 100 users locally when i tested for retrieving the sorted users)

I think I'm going to skip on that, we were already sorting by name, email. By default the behavior remains the same.

[gamab]

nit: add documentation about using sort options

Thanks for pointing that out.
The docs on the subject seem pretty poor, I explained the sort query param in the two places we were mentioning user search ✍️

[gamab]

nit: perhaps we can add a comment above this line about not surfacing the err if we use the wrong sorting option. and if so perhaps log it.

I addressed this, the error is now properly surfaced.

[eleijonmarck]

🥇

[eleijonmarck]

Left a comment on ID enumeration, which we should consider for user endpoints.

Otherwise this looks great!

[eleijonmarck]

Tested and error pops up!