Include a more stable way of detecting when withOnyx keys change

[tgolen]

This is another take on the same fix that I did in #407.

Details

There are two cases that need to be handled slightly different in componentDidUpdate():

1. The first time it runs, it is triggered by this.state.loading going from true to false
2. Every other time it runs, it is triggered by a change to the props or the state

This causes some differences in how the previousKey is calculated in order to compare if the key changed or not. Hopefully, the code comments explain this pretty well.

Related Issues

NA

Automated Tests

Yes, this is fully covered by automated tests and it was how I found that the solution in #407 was not correct.

Manual Tests

1. Run npm run build and copy the changes to the App's node_modules/react-native-onyx folder
2. In App, modify ReportScreen.js to have a log at the top of the render method like console.log('Tim ReportScreen()');
3. In App, run npm run web on App to start the app
4. Quickly click switch between multiple chats, especially ones that have money request previews in them (though, it's not really related to that)
5. Verify that in the JS console, you never see an infinite re-rendering of the ReportScreen

Now, to verify that the dependent keys are working:

1. Click the global + > Request Money > Scan
2. Once you have created the scan request, click the request preview to go to the report. Now click the request to go to the request details.
3. Verify in the header at the top of the page that it shows the Scanning... label. That label won't be there if the dependent data isn't loading properly

Author Checklist

• I linked the correct issue in the ### Related 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 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 Unable to test due to emulator not being able to load the site
  • 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 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 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
  • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  • 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 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 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

2023-10-31_15-38-18.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

2023-10-31_15-45-31.mp4

iOS

2023-10-31_16-23-26.mp4

Android

Uploading 2023-11-01_10-00-27.mp4…

[tgolen]

I need to finish testing Android before this is ready.

[tgolen]

I'm still held up on testing android chrome, but since that is the last platform to test, I'm going to open this up for reviews.

[mountiny]

Thanks for adding the comments, its really helpful :) Changes look good to me in general and you have tested extensively, we should let the C+ test in the updated App next to unsure all is good