[SYNPY-1186] When a username is a number, getUserProfile cannot retrieve the user

[BWMac]

Problem:

When a user calls the getUserProfile method with a username that is a number, the appropriate UserProfile is not retrieved. This essentially boils down to the fact that we currently allow people to pass userNames and ownerIds to getUserProfile, and that people are allowed to create usernames on Synapse that are just a string of numbers.

Solution:

Split getUserProfile into two separate functions. One that accepts userName as a string only, and one that only will accept an ownerId in the form of an integer.

A complication of this solution is that getUserProfile is used in a number of places, some of which also allow userNames or ownerIds. This refactoring and the eventual deprecation of getUserProfile will need to be done in a future PR.

[BryanFauble]

I like the approach you are taking on this - While looking for areas/dependent functions let's take the time to update the parameter section of those function(s) docstrings to be clear that typing of the data they're passing in matters and what we'll do with a string vs int

[BryanFauble]

LGTM

[thomasyu888]

🔥 Let's hold on the deprecation warning because we don't want it popping up every time someone uses the functions that leverages getUserProfile.

We will need to create separate tickets for the deprecation and also create platform tickets for not allowing integer usernames.

[pep8speaks]

Hello @BWMac! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2023-11-20 21:07:56 UTC

[thomasyu888]

Excellent - here's some feedback.

[BryanFauble]

LGTM!

[thomasyu888]

🚀 LGTM!