Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ability to set a contact method your default contact method #16750

Merged
merged 40 commits into from
May 10, 2023

Conversation

Beamanator
Copy link
Contributor

@Beamanator Beamanator commented Mar 30, 2023

@aimane-chnaif I'm sorry but you probably won't be able to complete these tests till https://github.com/Expensify/Web-Expensify/pull/36920 gets to staging

Also cc @cristipaval since you've been helping work on similar pages for a while now 👍

Details

Adds one more piece of functionality for contact methods: Being able to set them as default.

Note: In OldDot, we have some domain security settings that disable users from changing their default login. However, none of the domain functionality is on NewDot (yet) so we are only pulling in the user's domain security group data so we can make sure the user knows if they are or aren't able to update their primary login (default contact method).

Fixed Issues

$ #16747

Tests

  1. If https://github.com/Expensify/Web-Expensify/pull/36920 isn't merged yet, check it out to start testing
  2. Open up OldDot, sign in with a domain admin account
    • Note: Your account should be on the passwordless beta (or if you're an Expensify employee, you should already have access to all betas)
    • You can probably fake this by returning true in Permissions.canUsePasswordlessLogins
    • Note: I removed this point b/c passwordless is live!
  3. Go to domain settings (https://www.expensify.com.dev/domain_groups), check out the security group settings for that account you're signed in as. Make sure "Restrict primary login selection" is false
    • Screenshot 2023-04-06 at 1 29 49 PM
  4. Log in to NewDot with that same account, go to http://localhost:8080/settings/profile/contact-methods
  5. Add a secondary login and verify it
  6. Now open that contact method's "details" page, and verify you see the "Set as default" button
    • Screenshot 2023-04-06 at 1 31 22 PM
  7. Click the button, verify your secondary login was correctly set as default.
    • You should now see "This is your current default contact method. You will not be able to delete this contact method until you set an alternative default by selecting another contact method and pressing “Set as default”." on that contact's details page
    • Screenshot 2023-04-06 at 3 09 46 PM
    • Screenshot 2023-04-06 at 3 09 30 PM
  8. Change back to your other login as default
  9. Next, back in OldDot domain settings, change "Restrict primary login selection" to true
    • Screenshot 2023-04-06 at 3 10 47 PM
  10. Back on http://localhost:8080/settings/profile/contact-methods, open up your secondary login's "details" page
    • Note: You shouldn't have to refresh, because recently we made Onyx update when domain security group settings change in OldDot!
  11. Verify you now only see the "Delete" option
    • Screenshot 2023-04-06 at 3 11 39 PM

Final test to make sure personal details update correctly:

  1. Create a brand new account on a public domain (ex: ...@gmail.com) and DON'T set a display name
  2. Add a new contact method for this account
  3. Set the new contact method as default
  4. Close the sidebar, open settings
  5. Verify the settings page shows all of the correct data immediately
  6. Navigate to other pages of the app, send messages, etc - making sure nothing is broken and that no console errors show up

NOTE: Your old default contact method will still show above messages you sent in chat reports (assuming you don't have a display name set). This is because the "old default contact method" was sent from the server, and we don't update ALL report actions any time a default contact method is changed.

  • I plan to create a follow-up for this, but we already discussed it's find to most past this for now

  • Verify that no errors appear in the JS console

Offline tests

  1. Switch your security group to not have primary login switching disabled again (same as step 3 above)
  2. Refresh NewDot and open up the details page of your secondary login you've been testing with
  3. Go offline, click "Set as default"
  4. Verify you see the button is now grayed out, like this:
    • Screenshot 2023-04-06 at 3 33 29 PM

QA Steps

Same as above

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Screen.Recording.2023-04-06.at.3.36.39.PM.mov

Domain setting change test:

Screen.Recording.2023-04-21.at.4.08.58.PM.mov
Mobile Web - Chrome

Domain setting change test:

Screen.Recording.2023-04-21.at.4.33.27.PM.mov
Mobile Web - Safari
Screen.Recording.2023-04-24.at.2.33.17.PM.mov
Desktop

Domain setting change test:

Screen.Recording.2023-04-21.at.4.17.31.PM.mov
iOS

Domain setting change test:

Screen.Recording.2023-04-24.at.2.25.50.PM.mov
Android

Domain setting change test:

Screen.Recording.2023-04-21.at.4.30.55.PM.mov

@Beamanator Beamanator changed the title Connect to SetContactMethodAsDefault Add ability to set a contact method your default contact method Apr 6, 2023
@Beamanator Beamanator self-assigned this Apr 6, 2023
@Beamanator Beamanator changed the title Add ability to set a contact method your default contact method [HOLD Web-E#36920] Add ability to set a contact method your default contact method Apr 6, 2023
@Beamanator Beamanator marked this pull request as ready for review April 6, 2023 14:03
@Beamanator Beamanator requested a review from a team as a code owner April 6, 2023 14:03
@melvin-bot melvin-bot bot requested review from aimane-chnaif and deetergp and removed request for a team April 6, 2023 14:03
@MelvinBot
Copy link

@aimane-chnaif @deetergp One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@Beamanator
Copy link
Contributor Author

Beamanator commented Apr 6, 2023

FYI I haven't completed the videos on all platforms yet, mainly because my wifi is MISERABLE today and it's really slowing down lots of things 🙃 But the code should still be ready for review!!

deetergp
deetergp previously approved these changes Apr 6, 2023
Copy link
Contributor

@deetergp deetergp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good, despite my one NAB comment. I did check out the Web-E PR and tested it in macOS Chrome and it worked as described 👍

@Beamanator
Copy link
Contributor Author

One more point I'm thinking about with this PR: How to show the Password textinput for users not on the passwordless beta

Internal slack convo here

@aimane-chnaif
Copy link
Contributor

Not related to PR, but I am a bit confused why it says "Phone number" to add new contact method, while both email and phone number are acceptable.

phone.number.mov

@Beamanator
Copy link
Contributor Author

Good point @aimane-chnaif - I made the change to only update the current client instantly, I will definitely add that as a follow-up to make sure other devices get the same update 👍

@aimane-chnaif
Copy link
Contributor

Another bug:

  • X set profile avatar A
  • change default contact to Y
  • Y now has same avatar as X (A)
  • on Y, set profile avatar B
  • change default contact back to X
  • X's avatar changed to B

So my question is one profile avatar is shared between contacts?

aimane-chnaif
aimane-chnaif previously approved these changes May 9, 2023
Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's fix above issues as follow-up, not marking as blocker.
Other than that, tests well.

@aimane-chnaif
Copy link
Contributor

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
web-ios.mov
Mobile Web - Chrome
android.mov
Mobile Web - Safari
desktop-msafari.mov
Desktop
desktop-msafari.mov
iOS
web-ios.mov
Android
android.mov

@Beamanator
Copy link
Contributor Author

Thanks for reviewing @aimane-chnaif !

Another bug:

  • X set profile avatar A
  • change default contact to Y
  • Y now has same avatar as X (A)
  • on Y, set profile avatar B
  • change default contact back to X
  • X's avatar changed to B

So my question is one profile avatar is shared between contacts?

It sounds like this is expected - the user should only ever have 1 profile avatar. If you change your default contact method, the avatar should stay the same. That's what's happening, right? Just making sure I followed correctly

@aimane-chnaif
Copy link
Contributor

It sounds like this is expected - the user should only ever have 1 profile avatar. If you change your default contact method, the avatar should stay the same. That's what's happening, right? Just making sure I followed correctly

yes correct

@aimane-chnaif
Copy link
Contributor

One more concern: session expired error when re-login after logout, and calling OpenReport api endlessly
I experienced this recently before this PR so this should not be a blocker.
I don't have constant reproducible step but after changing default contact multiple times, sometimes happens.

Screenshot 2023-05-09 at 5 26 45 PM

@aimane-chnaif
Copy link
Contributor

We have merge conflict came from prettier

@Beamanator
Copy link
Contributor Author

I'm just about to jump into fixing merge conflicts & the requested change 👍

@Beamanator Beamanator requested a review from deetergp May 10, 2023 09:45
@Beamanator
Copy link
Contributor Author

  • Merge conflict fixed & updated to make sure prettier is happy
  • Updated the function canChangeDefaultContactMethod to do all logic regarding if a user can change their default contact method or not 👍

Ready for re-review @deetergp @aimane-chnaif 🙏

Copy link
Contributor

@deetergp deetergp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good! Thanks for the changes. 👍

Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM2

@Beamanator
Copy link
Contributor Author

Nice! @deetergp @cristipaval either of you want the merge honors? :D

@cristipaval cristipaval merged commit 253c611 into main May 10, 2023
@cristipaval cristipaval deleted the beaman-addSetContactMethodAsDefault branch May 10, 2023 18:10
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.13-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.13-5 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants