Fix screen behind RHP overlay changes when open contact method from teachers page #47999

bernhardoj · 2024-08-26T13:02:31Z

Details

If we open the contact method page from the teachers page, the screen behind the RHP overlay changes. This PR fixes it.

Fixed Issues

$ #47612
PROPOSAL: #47612 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Open Settings > Save the world > I am a teacher
Press the "Contact methods" or "Update email address" button
(Web/Desktop) Verify the screen behind the overlay doesn't change
Press the existing contact method
(Web/Desktop) Verify the screen behind the overlay doesn't change
Close the contact method page
Verify the teacher page screen is shown

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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
  - 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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.

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android.mweb.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.mweb.mp4

MacOS: Chrome / Safari

wbe.mp4

MacOS: Desktop

desktop.mp4

…achers page

melvin-bot · 2024-08-26T13:02:36Z

@Ollyws Please 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]

Ollyws · 2024-08-27T09:54:52Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

Android: Native

01_Android_Native.mp4

Android: mWeb Chrome

02_Android_Chrome.mp4

iOS: Native

03_iOS_Native.mp4

iOS: mWeb Safari

04_iOS_Safari.mp4

MacOS: Chrome / Safari

05_MacOS_Chrome.mp4

MacOS: Desktop

06_MacOS_Desktop.mp4

Ollyws

LGTM.

OSBotify · 2024-08-27T10:27:47Z

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

rushatgabhane · 2024-08-28T19:42:49Z

src/pages/settings/Profile/Contacts/NewContactMethodPage.tsx

+
+            User.addNewContactMethodAndNavigate(submitDetail, route.params.backTo);
+        },
+        [route.params.backTo],


route.params.backTo use optional chaining here otherwise the app will crash if backTo is not present.

I'll take care of this in #48216

rushatgabhane · 2024-08-28T19:51:26Z

src/pages/settings/Profile/Contacts/NewContactMethodPage.tsx

+            const validateIfnumber = LoginUtils.validateNumber(phoneLogin);
+            const submitDetail = (validateIfnumber || values.phoneOrEmail).trim().toLowerCase();
+
+            User.addNewContactMethodAndNavigate(submitDetail, route.params.backTo);


I'll take care of this in #48216

OSBotify · 2024-08-28T21:46:07Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 9.0.26-1 🚀

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

OSBotify · 2024-08-30T18:34:34Z

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.26-6 🚀

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

bernhardoj added 2 commits August 26, 2024 20:55

fix screen below RHP overlay changes when open contact method from te…

5ceca0e

…achers page

use backTo from params directly

d8543d8

bernhardoj requested a review from a team as a code owner August 26, 2024 13:02

melvin-bot bot requested review from Ollyws and removed request for a team August 26, 2024 13:02

Ollyws approved these changes Aug 27, 2024

View reviewed changes

melvin-bot bot requested a review from cristipaval August 27, 2024 09:55

cristipaval approved these changes Aug 27, 2024

View reviewed changes

cristipaval merged commit 3347c10 into Expensify:main Aug 27, 2024
16 checks passed

rushatgabhane reviewed Aug 28, 2024

View reviewed changes

github-actions bot mentioned this pull request Aug 28, 2024

Deploy Checklist: New Expensify 2024-08-28 #48221

Closed

93 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix screen behind RHP overlay changes when open contact method from teachers page #47999

Fix screen behind RHP overlay changes when open contact method from teachers page #47999

bernhardoj commented Aug 26, 2024

melvin-bot bot commented Aug 26, 2024

Ollyws commented Aug 27, 2024

Ollyws left a comment

OSBotify commented Aug 27, 2024

rushatgabhane Aug 28, 2024

marcaaron Aug 28, 2024

rushatgabhane Aug 28, 2024

marcaaron Aug 28, 2024

OSBotify commented Aug 28, 2024

OSBotify commented Aug 30, 2024

Fix screen behind RHP overlay changes when open contact method from teachers page #47999

Fix screen behind RHP overlay changes when open contact method from teachers page #47999

Conversation

bernhardoj commented Aug 26, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 26, 2024

Ollyws commented Aug 27, 2024

Reviewer Checklist

Screenshots/Videos

Ollyws left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 27, 2024

rushatgabhane Aug 28, 2024

Choose a reason for hiding this comment

marcaaron Aug 28, 2024

Choose a reason for hiding this comment

rushatgabhane Aug 28, 2024

Choose a reason for hiding this comment

marcaaron Aug 28, 2024

Choose a reason for hiding this comment

OSBotify commented Aug 28, 2024

OSBotify commented Aug 30, 2024