[WPB-8707] Remove phone functionality in the development client API version#4149
Merged
mdimjasevic merged 20 commits intodevelopfrom Jul 29, 2024
Merged
Conversation
9ca6d09 to
5fa63a1
Compare
82940a7 to
a244b39
Compare
battermann
approved these changes
Jul 24, 2024
Contributor
battermann
left a comment
There was a problem hiding this comment.
Looks good. If there is a good reason not to use the VersionedReqBody wrapper, I'd like to know, and then it's good to go. Otherwise, it might be a sensible change?
Contributor
There was a problem hiding this comment.
I think we have a special type that can be used here as a wrapper: VersionedReqBody
Contributor
There was a problem hiding this comment.
Same as above... and more below, will not comment on all
a244b39 to
efc32b9
Compare
For client API versions up to and including V5, the response is the same and the 'phone' field is always null. The field does not exist in versions V6 and above.
The response to `POST /register` no longer throws an error when the request contains a phone number. Instead, the "phone" and "phone_code" fields are not parsed and are therefore ignored.
The tests should have been dropped when removing phone number support in client API versions v0..v5 as they lost meaning at least then, if not even before that.
The test's name is suggesting one, but testing a different thing. The test does not make much sense in the current situation.
44a031f to
e88c6e6
Compare
e88c6e6 to
1d1171a
Compare
This was referenced Oct 23, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The PR removes phone numbers and phone functionality from the development client API version, namely from v6.
A couple of up-for-debate choices have been made, and I'm open to discuss them:
phonekey was dropped from Brig'steam_invitationDB table. Previous releases were still reading this column. As there is no Team Settings UI action to enter a phone number, so the column was never written to; hence not reading from the column will not miss to read actual phone numbers. Therefore, during deployment this will lead to benign 5xx errors. Related to this, the"phone"field for endpoints that get one or more team invitations is silently ignored and the field has been removed from the request body of the v6 endpoint to send a team invitation."phone"field of the request body toPOST /registeris now ignored instead of giving an error.Tracked by https://wearezeta.atlassian.net/browse/WPB-8707.
Checklist
POST /login/sendendpoint,PUT /self/phoneendpoint,DELETE /self/phoneendpoint,GET /selfendpoint to remove thephonekey from the response,GET /activateendpoint to remove thephonekey from the response,POST /activate/sendendpoint to remove thephonekey from the request body, i.e., no ability to send an activation code via SMS,phonefield in the response to theGET /teams/invitations/infoendpoint,phonefield in the response to theGET /teams/{tid}/invitationsendpoint,phonefield in the response to theGET /teams/{tid}/invitations/{iid}endpoint,phonefield from the request body ofPOST /teams/{tid}/invitationsendpoint,POST /registerendpoint to remove thephonekey both from the request and the response,POST /loginendpoint by removing phone-related keys, namelyphoneandcode, from the request body,POST /activateendpoint by removing thephonekey from the request body,changelog.d