Prevent picker onInputChange firing on re-render #11120

neil-marcellini · 2022-09-19T21:46:48Z

Details

On the ReportSettingsPage we update the notification preference as soon as the user changes the value of the picker. However, onInputChange was also triggering when the component updated after the room name was updated. To prevent that I have added a key prop so that it only updates when the actual value changes. I got the idea from this GH issue.

App/src/pages/ReportSettingsPage.js

Lines 198 to 204 in 60cf2f7

    
           onInputChange={(notificationPreference) => { 
        
               Report.updateNotificationPreference( 
        
                   this.props.report.reportID, 
        
                   this.props.report.notificationPreference, 
        
                   notificationPreference, 
        
               ); 
        
           }}

Fixed Issues

$ #10437

Tests

Check out the branch from https://github.com/Expensify/Web-Expensify/pull/34897 for the backend Web-E changes.

Sign in with any account
Create a workspace from the green plus (if needed)
Create a workspace room from the green plus (if needed)
Click the header of the workspace room to open the room details page
Click "Settings"
Note that the notification preference defaults to daily
Rename the room and hit save
Verify that the notification preference remains unchanged

Verify that no errors appear in the JS console

PR Review Checklist

Contributor (PR Author) Checklist

PR Reviewer Checklist

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

QA Steps

Same as tests.

Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

iOS / Safari

Android / Chrome

Desktop

iOS

Android

melvin-bot · 2022-09-19T21:46:50Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

dangrous

Hey so this is working for me but I have one quick question before approving:

Will this cause any issues if we ever have a window with multiple pickers that can have the same value? Wouldn't they then have the same key if they have the same value?

neil-marcellini · 2022-10-05T16:29:21Z

Will this cause any issues if we ever have a window with multiple pickers that can have the same value? Wouldn't they then have the same key if they have the same value?

That's a great question to bring up! Thanks. I looked into it and according to the docs here keys only have to be unique among the children, not globally. Therefore I think this is fine because pickers shouldn't have duplicate values. Here are the more general docs on keys.

Also I'm taking this off of hold now that the Web-PR is on staging. Please review and fill out the checklist when you have a moment.

dangrous · 2022-10-05T18:00:23Z

PR Reviewer Checklist

The Contributor+ 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 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 tagging the marketing team 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 */
- Any functional components have the displayName property
- 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.

melvin-bot · 2022-10-05T18:01:48Z

@neil-marcellini looks like this was merged without passing tests. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

neil-marcellini · 2022-10-05T18:02:46Z

All checks passed. I had to manually re-run the author checklist but not the reviewer checklist.

OSBotify · 2022-10-05T18:05:51Z

✋ 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 · 2022-10-06T00:45:23Z

🚀 Deployed to staging by @neil-marcellini in version: 1.2.12-0 🚀

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

rushatgabhane · 2022-10-06T21:23:54Z

Dropping a note that there was a regression: the blue outline persists on dropdown inputs even after focusing on another input.

We're fixing it by reverting this PR in #11039 (comment)
The original issue is also solved by #11039

neil-marcellini · 2022-10-07T15:34:21Z

Thanks @rushatgabhane, sorry for introducing that regression! I can do an RCA. Would you please explain why setting the key here causes the blue outline to persist?

rushatgabhane · 2022-10-07T15:43:30Z

I can do an RCA

I don't think you need to? Because it didn't make it to production, and was caught by QA #11646

neil-marcellini · 2022-10-07T15:49:04Z

Oh good I misread, thanks!

rushatgabhane · 2022-10-07T15:53:31Z

Would you please explain why setting the key here causes the blue outline to persist?

@neil-marcellini maaaaybe passing a key tells RN to not re-render on blur because it's props and state haven't changed.
That combined with RNPickerSelect being a PureComponent source

I don't know, but it's an interesting bug.

OSBotify · 2022-10-11T23:14:49Z

🚀 Deployed to production by @AndrewGable in version: 1.2.12-4 🚀

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

Prevent picker onInputChange firing on re-render

Prevent picker onInputChange firing on re-render

3dc9792

neil-marcellini self-assigned this Sep 19, 2022

neil-marcellini changed the base branch from main to francois-fixNewRoom October 1, 2022 00:10

neil-marcellini mentioned this pull request Oct 1, 2022

Room notification preference updates after changing the room name #10437

Closed

neil-marcellini changed the title ~~Prevent picker onInputChange firing on re-render~~ [HOLD Web 34897] Prevent picker onInputChange firing on re-render Oct 3, 2022

neil-marcellini marked this pull request as ready for review October 3, 2022 18:10

neil-marcellini requested a review from a team as a code owner October 3, 2022 18:10

melvin-bot bot requested review from dangrous and removed request for a team October 3, 2022 18:10

Base automatically changed from francois-fixNewRoom to main October 3, 2022 22:08

dangrous reviewed Oct 4, 2022

View reviewed changes

neil-marcellini changed the title ~~[HOLD Web 34897] Prevent picker onInputChange firing on re-render~~ Prevent picker onInputChange firing on re-render Oct 5, 2022

dangrous approved these changes Oct 5, 2022

View reviewed changes

neil-marcellini merged commit 7d4b8bf into main Oct 5, 2022

neil-marcellini deleted the neil-room-notif-pref branch October 5, 2022 18:01

melvin-bot bot added the Emergency label Oct 5, 2022

neil-marcellini removed the Emergency label Oct 5, 2022

OSBotify mentioned this pull request Oct 5, 2022

Deploy Checklist: New Expensify 2022-10-05 #11623

Closed

48 tasks

rushatgabhane mentioned this pull request Oct 6, 2022

Form - Migrate setNativeProps to state. #11039

Merged

93 tasks

smrutiparida pushed a commit to autosave-app/App that referenced this pull request Oct 13, 2022

Merge pull request Expensify#11120 from Expensify/neil-room-notif-pref

62331f3

Prevent picker onInputChange firing on re-render

	onInputChange={(notificationPreference) => {
	Report.updateNotificationPreference(
	this.props.report.reportID,
	this.props.report.notificationPreference,
	notificationPreference,
	);
	}}

Prevent picker onInputChange firing on re-render #11120

Prevent picker onInputChange firing on re-render #11120

Uh oh!

Conversation

neil-marcellini commented Sep 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

PR Review Checklist

Contributor (PR Author) Checklist

PR Reviewer Checklist

QA Steps

Screenshots

Web

Mobile Web

Desktop

iOS

Android

Uh oh!

melvin-bot bot commented Sep 19, 2022

Uh oh!

dangrous left a comment

Choose a reason for hiding this comment

Uh oh!

neil-marcellini commented Oct 5, 2022

Uh oh!

dangrous commented Oct 5, 2022

PR Reviewer Checklist

Uh oh!

melvin-bot bot commented Oct 5, 2022

Uh oh!

neil-marcellini commented Oct 5, 2022

Uh oh!

OSBotify commented Oct 5, 2022

Uh oh!

OSBotify commented Oct 6, 2022

Uh oh!

rushatgabhane commented Oct 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

neil-marcellini commented Oct 7, 2022

Uh oh!

rushatgabhane commented Oct 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

neil-marcellini commented Oct 7, 2022

Uh oh!

rushatgabhane commented Oct 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OSBotify commented Oct 11, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

neil-marcellini commented Sep 19, 2022 •

edited

Loading

rushatgabhane commented Oct 6, 2022 •

edited

Loading

rushatgabhane commented Oct 7, 2022 •

edited

Loading

rushatgabhane commented Oct 7, 2022 •

edited

Loading