Pick only params from route before passing them to screen #44531

jnowakow · 2024-06-27T10:05:59Z

Details

The bug was caused by screen in FullScreenNavigator being unmounted and mounted when RHP modal was opened. It happened because in some cases RHP route accepted more params then route in FullScreenNavigator. When RHP was opened those additional params where pushed back to FullScreenNavigator which caused it to re-render.

Fixed Issues

$ #44192
PROPOSAL: N/A

Tests

Go to Settings > Workspace > Members
Click on member row
Verify that members list doesn't blink

Verify that no errors appear in the JS console

Offline tests

Same as in Tests

QA Steps

Same as in Tests

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.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-06-27T10:06:28Z

@blimpich 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]

blimpich · 2024-06-27T17:18:53Z

@jnowakow should I have been assigned to this? Looks like its still WIP and not linked to a current issue? Should I unassign myself?

adamgrzybowski · 2024-07-01T13:37:31Z

LGTM! 🎸

jnowakow · 2024-07-03T06:50:32Z

@mountiny it's ready for review 🎉

jayeshmangwani · 2024-07-03T10:07:24Z

Automation seems to have failed in requesting a review from me; I am starting to review the PR.

jayeshmangwani · 2024-07-03T11:34:56Z

@jnowakow Workspace Name page is still blinks for me.

workspace-profile-flicker.mov

jayeshmangwani · 2024-07-04T05:53:26Z

Workspace Name page is still blinks for me.

Hey @jnowakow If the issue is not happening for you, then we can test it on adhoc builds, as the issue is happening for me every time.

jnowakow · 2024-07-04T07:25:31Z

@jayeshmangwani can we trigger adhoc builds? It works fine for me:

workspace.mov

jayeshmangwani · 2024-07-04T08:51:47Z

@mountiny can we please run adhoc builds here?

jayeshmangwani · 2024-07-04T09:36:22Z

Although it is not reproducing for you, let me add a video of all the steps with console logs of ProfilePage re-rendering. This might help in reproducing the issue.

Workspace-Profile-Page-Re-Render.mov

jnowakow · 2024-07-11T11:57:04Z

@jayeshmangwani I'm able to reproduce both on main and on my branch. I'll try to debug it today, however tomorrow is my last day at work before longer break so if I don't manage to fix it today what about merging this PR and opening another issue for this particular one?
cc @mountiny

jayeshmangwani · 2024-07-11T12:35:20Z

if I don't manage to fix it today what about merging this PR and opening another issue for this particular one?

@mountiny what's your suggestion on this? If Jan doesn't manage to fix the issue for iOS by the end of today, should we merge this PR that fixes the issue for web and open another issue for iOS?

jnowakow · 2024-07-12T10:05:13Z

Ok, I found the place that is breaking. It's fault of withPrepareCentralPaneScreen. Simply removing it for WorkspacesListPage fixes the issue but I'll try to figure it out why exactly it causes the screen to remount as it may also happen in other places too.

jayeshmangwani · 2024-07-12T10:08:03Z

Ok, I found the place that is breaking

Thanks for the update! 🎉

jnowakow · 2024-07-12T12:41:58Z

@jayeshmangwani I just removed withPrepareCentralPaneScreen for this screen and issue seems to be fixed. I haven't found the solution to fix it with this function, maybe @WojtekBoman will know but I think it's good as it is now.
If there will be any other problems with this PR someone from SWM will take over on Monday. cc @staszekscp

mountiny · 2024-07-12T13:52:36Z

Maybe this will help with the rerender issue #45335

jayeshmangwani · 2024-07-12T14:04:42Z

Maybe this will help with the rerender issue #45335

Yes, this PR will solve the re-render issue. I have added the changes and tested them locally.

@jnowakow Please add back the withPrepareCentralPaneScreen to the WorkspacesListPage.

jnowakow · 2024-07-12T14:10:26Z

@mountiny, you're right - it seems to fix the issue

jnowakow · 2024-07-12T14:10:53Z

I'm reverting last commit then

jayeshmangwani · 2024-07-16T11:21:46Z

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

Android.mov

Android: mWeb Chrome

mWeb-chrome.mov

iOS: Native

iOS.mov

iOS: mWeb Safari

mWeb-safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

jayeshmangwani

Tests well. Not seeing any flicker on the members page or any workspace subpages.

jayeshmangwani · 2024-07-16T20:30:37Z

Not sure why tests are failing here. They are working fine for me locally. Maybe we need to merge the main branch and push the code here, as Jan is on break from work. @staszekscp Please help merge the main branch here.

Kicu · 2024-07-17T10:08:52Z

I will take a look at this later today, I also work with SWM and with @staszekscp

Kicu · 2024-07-17T13:52:02Z

hey @jayeshmangwani I merged newest main and all the checks are passing 🚀

Kicu · 2024-07-19T06:59:00Z

Merged newest main, solved conflicts, tested the flow on web only and I see no screen blinking as expected.

jayeshmangwani · 2024-07-19T07:27:47Z

@mountiny All yours. Would you take a look at the PR?

mountiny

Thanks, I got one question

mountiny · 2024-07-19T11:39:40Z

src/libs/Navigation/linkingConfig/createNormalizedConfigs.ts

+// THOSE FUNCTIONS ARE COPIED FROM react-navigation/core IN ORDER TO AVOID PATCHING
+// THAT'S THE REASON WHY ESLINT IS DISABLED


@Kicu @adamgrzybowski Is it suggested to use this code permanently? Why can we not use this from react-navigation? Is it not exposed or did we need to make some changes to this method? If we cannot get this merged upstream, can we find a different way so we avoid duplicating this?

it's not exposed. We can ask somebody from react-navigation to expose it.

Discussing more here https://expensify.slack.com/archives/C04878MDF34/p1721389874173849?thread_ts=1721350042.643069&cid=C04878MDF34

OSBotify · 2024-07-19T12:01:36Z

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

OSBotify · 2024-07-19T20:13:09Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.10-2 🚀

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

OSBotify · 2024-07-22T13:35:25Z

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 9.0.10-3 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-23T08:02:19Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.10-7 🚀

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

OSBotify · 2024-07-25T03:13:57Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.11-5 🚀

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

Pick only params from route before passing them to screen

c0ebcb7

jnowakow requested a review from a team as a code owner June 27, 2024 10:05

jnowakow marked this pull request as draft June 27, 2024 10:06

melvin-bot bot requested review from blimpich and removed request for a team June 27, 2024 10:06

Merge branch 'main' into fix-too-many-params-passed-to-screens

21406bd

blimpich removed their request for review June 27, 2024 17:19

jnowakow added 2 commits June 28, 2024 08:58

Merge branch 'main' into fix-too-many-params-passed-to-screens

e39cb9c

Add normalized configs

2acd090

mountiny self-requested a review June 28, 2024 20:29

mountiny assigned jnowakow Jun 28, 2024

jayeshmangwani mentioned this pull request Jun 29, 2024

[HOLD for payment 2024-08-02] [$125] Web - Workspace - Screen blinks when opening member profile #44192

Closed

6 tasks

jnowakow added 2 commits July 1, 2024 08:23

Merge branch 'main' into fix-too-many-params-passed-to-screens

d86b8d1

Fix prettier

158e36e

jnowakow marked this pull request as ready for review July 1, 2024 14:05

jnowakow added 3 commits July 2, 2024 08:15

Merge branch 'main' into fix-too-many-params-passed-to-screens

291e8a8

Merge branch 'main' into fix-too-many-params-passed-to-screens

9b2cce2

Merge branch 'main' into fix-too-many-params-passed-to-screens

2747d3f

Merge branch 'main' into fix-too-many-params-passed-to-screens

8e2e70a

mountiny added the Ready To Build label Jul 4, 2024

Merge branch 'main' into fix-too-many-params-passed-to-screens

ee5cb87

jnowakow force-pushed the fix-too-many-params-passed-to-screens branch from d588870 to ee5cb87 Compare July 12, 2024 14:12

jayeshmangwani approved these changes Jul 16, 2024

View reviewed changes

Merge branch 'main' into fix-too-many-params-passed-to-screens

5b92b73

Merge branch 'main' into fix-too-many-params-passed-to-screens

6c69b9e

mountiny approved these changes Jul 19, 2024

View reviewed changes

mountiny merged commit f1b29ee into Expensify:main Jul 19, 2024
16 checks passed

github-actions bot mentioned this pull request Jul 19, 2024

Deploy Checklist: New Expensify 2024-07-19 #45794

Closed

mountiny mentioned this pull request Jul 22, 2024

[$250] Chat – “Hmm... ” page appears briefly when navigate to IOU link while logout #45899

Open

6 tasks

Kicu deleted the fix-too-many-params-passed-to-screens branch September 3, 2024 14:20

		// THOSE FUNCTIONS ARE COPIED FROM react-navigation/core IN ORDER TO AVOID PATCHING
		// THAT'S THE REASON WHY ESLINT IS DISABLED

Pick only params from route before passing them to screen #44531

Pick only params from route before passing them to screen #44531

Conversation

jnowakow commented Jun 27, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 27, 2024

blimpich commented Jun 27, 2024

adamgrzybowski commented Jul 1, 2024

jnowakow commented Jul 3, 2024

jayeshmangwani commented Jul 3, 2024

jayeshmangwani commented Jul 3, 2024

jayeshmangwani commented Jul 4, 2024

jnowakow commented Jul 4, 2024

jayeshmangwani commented Jul 4, 2024

jayeshmangwani commented Jul 4, 2024

jnowakow commented Jul 11, 2024

jayeshmangwani commented Jul 11, 2024

jnowakow commented Jul 12, 2024

jayeshmangwani commented Jul 12, 2024

jnowakow commented Jul 12, 2024

mountiny commented Jul 12, 2024 • edited Loading

jayeshmangwani commented Jul 12, 2024

jnowakow commented Jul 12, 2024

jnowakow commented Jul 12, 2024

jayeshmangwani commented Jul 16, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

jayeshmangwani left a comment

Choose a reason for hiding this comment

jayeshmangwani commented Jul 16, 2024

Kicu commented Jul 17, 2024

Kicu commented Jul 17, 2024

Kicu commented Jul 19, 2024

jayeshmangwani commented Jul 19, 2024

mountiny left a comment

Choose a reason for hiding this comment

mountiny Jul 19, 2024

Choose a reason for hiding this comment

adamgrzybowski Jul 19, 2024

Choose a reason for hiding this comment

mountiny Jul 19, 2024

Choose a reason for hiding this comment

OSBotify commented Jul 19, 2024

OSBotify commented Jul 19, 2024

OSBotify commented Jul 22, 2024

OSBotify commented Jul 23, 2024

OSBotify commented Jul 25, 2024

jnowakow commented Jun 27, 2024 •

edited

Loading

mountiny commented Jul 12, 2024 •

edited

Loading

jayeshmangwani commented Jul 16, 2024 •

edited

Loading