ref(hc): Introduce RpcUserProfile and UserService.get_many_profiles #68847
Conversation
Offer a more performant alternative to UserService.get_many that provides all attributes that can be provided without fetching from any related tables.
Rename `ids_only` to more accurately reflect what it does, since `get_many_profiles` is now using it to fetch more than just IDs but still wants to avoid selecting any related data. Make `query_many` no longer private by convention. We now want to call it directly, so that we can then do a different kind of serialization than _UserFilterQuery's default. (DatabaseBackedUserSocialAuthService also was previously calling it directly.)
github-actions
bot
added
the
Scope: Backend
| @@ -34,12 +34,13 @@ class RpcAuthenticator(RpcModel): | |||
| config: Any = None | |||
|
|
|||
|
|
|||
| class RpcUser(RpcModel): | |||
| class RpcUserProfile(RpcModel): | |||
There was a problem hiding this comment.
I know introducing this new noun ("profile") could be a little confusing. I hope it fits.
I considered naming it something like RpcMinimalUser, but that would mess up the semantics of the "is-a" relationship. That is, RpcUser extending RpcMinimalUser implies "an RpcUser is an RpcMinimalUser", which is wrong because RpcUser is not minimal.
There was a problem hiding this comment.
Profile seems like a decent name.
There was a problem hiding this comment.
I think profile is better than minimal. We have also used Summary for similar result types like OrganizationSummary.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #68847 +/- ##
===========================================
+ Coverage 58.20% 79.72% +21.51%
===========================================
Files 6420 6423 +3
Lines 284863 284799 -64
Branches 49079 49039 -40
===========================================
+ Hits 165817 227060 +61243
+ Misses 118650 57373 -61277
+ Partials 396 366 -30
|
| @@ -34,12 +34,13 @@ class RpcAuthenticator(RpcModel): | |||
| config: Any = None | |||
|
|
|||
|
|
|||
| class RpcUser(RpcModel): | |||
| class RpcUserProfile(RpcModel): | |||
There was a problem hiding this comment.
I think profile is better than minimal. We have also used Summary for similar result types like OrganizationSummary.
|
https://github.com/getsentry/getsentry/pull/13660 should fix the |
Offer a more performant alternative to UserService.get_many that provides all attributes that can be provided without fetching from any related tables.
Rename
ids_onlyto more accurately reflect what it does, sinceget_many_profilesis now using it to fetch more than just IDs but still wants to avoid selecting any related data.Make
query_manyno longer private by convention. We now want to call it directly, so that we can then do a different kind of serialization than _UserFilterQuery's default. (DatabaseBackedUserSocialAuthService also was previously calling it directly.)