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 new Display Name page #12142

Merged
merged 12 commits into from
Nov 7, 2022
Merged

Add new Display Name page #12142

merged 12 commits into from
Nov 7, 2022

Conversation

Beamanator
Copy link
Contributor

@Beamanator Beamanator commented Oct 26, 2022

Currently holding on implementation of the UpdateDisplayName command - cc @dangrous

Command being created here: https://github.com/Expensify/Web-Expensify/pull/35315

Details

This is the new Display Name page that comes from the N7 Free Plan Account Settings doc. This PR just implements the page, which you'll need to manually navigate to for now. Once all of these pages are built (there's ~ 5 more), we'll hook them all up in a modified Profile page!

Fixed Issues

$ #11572

Tests

  1. Navigate to http://localhost:8080/settings/profile/display-name
    • Note: You have to do this manually for now, there's no button to navigate you to this new page yet :D
  2. Add first & last names that are > 50 characters
  3. Click "Save", then verify you see this error:
    • Screen Shot 2022-11-01 at 1 42 57 PM
  4. Change the first & last names to something < 50 characters each
  5. Click "Save", verify you got navigated back to the Profile page
  6. Next, log out & log in, go back to that page, make sure the updates are still there

Offline test

  1. Navigate to http://localhost:8080/settings/profile/display-name in two devices (or a normal browser & an incognito browser)
  2. Go offline on one device, update your name, click "Save"
  3. Verify your display name updates everywhere in that device
  4. Go back online
  5. Verify your display name updates on the second device
  • Verify that no errors appear in the JS console

QA Steps

  1. Navigate to http://staging.new.expensify.com/settings/profile/display-name
    • Note: You have to do this manually for now, there's no button to navigate you to this new page yet :D
  2. Add first & last names that are > 50 characters
  3. Click "Save", then verify you see this error:
    • Screen Shot 2022-11-01 at 1 42 57 PM
  4. Change the first & last names to something < 50 characters each
  5. Click "Save", verify you got navigated back to the Profile page
  6. Next, log out & log in, go back to that page, make sure the updates are still there

Offline test

  1. Navigate to http://staging.new.expensify.com/settings/profile/display-name in two devices (or a normal browser & an incognito browser)
  2. Go offline on one device, update your name, click "Save"
  3. Verify your display name updates everywhere in that device
  4. Go back online
  5. Verify your display name updates on the second device
  • Verify that no errors appear in the JS console

PR Review Checklist

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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • 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
  • 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

  • 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • 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 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots

Web

Screen Shot 2022-11-01 at 1 42 57 PM

Screen.Recording.2022-11-01.at.1.52.38.PM.mov

Mobile Web - Chrome

Couldn't get Android chrome working :'( Asking for C+ / reviewer for assistance

Mobile Web - Safari

Screen Shot 2022-11-01 at 1 58 40 PM

Screen.Recording.2022-11-01.at.2.02.04.PM.mov

Desktop

Can't test yet, b/c page isn't hooked up to a button & can't manually navigate in desktop

iOS

Can't test yet, b/c page isn't hooked up to a button & can't manually navigate in native

Android

Can't test yet, b/c page isn't hooked up to a button & can't manually navigate in native

@Beamanator Beamanator self-assigned this Oct 26, 2022
src/languages/es.js Outdated Show resolved Hide resolved
@Beamanator Beamanator changed the title [HOLD Web-E] Add new Display Name page [HOLD Web-E#35315] Add new Display Name page Oct 27, 2022
@Beamanator Beamanator marked this pull request as ready for review November 1, 2022 13:04
@Beamanator Beamanator requested a review from a team as a code owner November 1, 2022 13:04
@melvin-bot melvin-bot bot requested review from eVoloshchak and stitesExpensify and removed request for a team November 1, 2022 13:05
@Beamanator
Copy link
Contributor Author

Beamanator commented Nov 1, 2022

@eVoloshchak FYI you probably can't test this yet, till the server-side changes make it to Staging

So code is ready for review, but can't merge till the server-side PR is merged

@Beamanator
Copy link
Contributor Author

Also I need a bit of help testing on android mweb - my android sims are not playing nicely today 🙃

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Nov 2, 2022

@Beamanator
I don't have the bandwidth right now, could you unassign me please?

@Beamanator Beamanator removed the request for review from eVoloshchak November 2, 2022 15:52
@Beamanator
Copy link
Contributor Author

Thanks for letting me know @eVoloshchak !

@Beamanator
Copy link
Contributor Author

@stitesExpensify do you have time to test this or do you prefer we assign a new C+? FYI it's not possible for C+ to test in staging YET (waiting on a Web-E PR)

@stitesExpensify
Copy link
Contributor

I can test it. I'll try to get to it today

@Beamanator
Copy link
Contributor Author

Thanks @stitesExpensify !

@stitesExpensify
Copy link
Contributor

I'll do this tomorrow. Looks like web is still in review as well

Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

FYI the offline test does not appear to be working (on both android/web, and web/incognito). LMK if I'm doing something wrong

2022-11-03_13-07-37.mp4

@Beamanator
Copy link
Contributor Author

Huh I swear that was working when I tested 😆

@Beamanator
Copy link
Contributor Author

Weird, I just tested (Chrome, normal + incognito) and I saw it working as expected 😡 Video:

Screen.Recording.2022-11-04.at.1.41.09.PM.mov

Just to make sure, you did pull main in Web-E right?

@stitesExpensify
Copy link
Contributor

hmm I could have sworn I did, but I'll try again!

@Beamanator
Copy link
Contributor Author

Merging main so we're testing on latest 👍

@Beamanator Beamanator changed the title [HOLD Web-E#35315] Add new Display Name page Add new Display Name page Nov 7, 2022
@stitesExpensify
Copy link
Contributor

Sorry for the delay, I found out that my local pusher was broken which caused it to not work (obviously). Test passed!

Copy link
Contributor

@stitesExpensify stitesExpensify 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 great! Nice work!

@stitesExpensify stitesExpensify merged commit ae3f424 into main Nov 7, 2022
@stitesExpensify stitesExpensify deleted the beaman-newDisplayNamePage branch November 7, 2022 16:47
@melvin-bot melvin-bot bot added the Emergency label Nov 7, 2022
@melvin-bot
Copy link

melvin-bot bot commented Nov 7, 2022

@stitesExpensify looks like this was merged without the checklist test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@OSBotify
Copy link
Contributor

OSBotify commented Nov 7, 2022

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@Beamanator
Copy link
Contributor Author

Removing emergency label, I guess the PR reviewer checklist may not have been filled out when this was merged 😅

@stitesExpensify
Copy link
Contributor

I could have sworn I checked all of those boxes 🙃 My bad

@OSBotify
Copy link
Contributor

OSBotify commented Nov 8, 2022

🚀 Deployed to staging by @stitesExpensify in version: 1.2.25-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Nov 9, 2022

🚀 Deployed to production by @yuwenmemon in version: 1.2.25-0 🚀

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.

4 participants