feat: add integration with Redux DevTools

[pac-guerreiro]

Details

This PR adds the ability to use React Native Onyx with Redux DevTools extension to debug writes made to the web storage.

At this time, it's not possible to jump between states from the Redux DevTools extension.

This functionality is only available in web apps.

Related Issues

N/A

Automated Tests

I added integration tests that check if all Onyx methods are registering their actions correctly on the Redux DevTools extension.

Manual Tests

N/A

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
  • 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

MacOS: Chrome / Safari

[AndrewGable]

In general this looks good to me, but going to add one more reviewer who might know the code better than I!

[AndrewGable]

Any reason this is JS and not TS?

[pac-guerreiro]

@AndrewGable I thought that, like the app, we were not allowed to write .ts files yet. But I can rewrite this to .ts if you want!

[pac-guerreiro]

@AndrewGable So should I rewrite it to .ts or do you want me to provide a .d.ts file?

[marcaaron]

Can we please add some tests to show how this will be used and update the documentation with some basic instructions?
I know it's a DX QoL improvement, but we should have someone test it out.

[marcaaron]

Changes look good as far as I understand them 👍

[pac-guerreiro]

Can we please add some tests to show how this will be used and update the documentation with some basic instructions? I know it's a DX QoL improvement, but we should have someone test it out.

@marcaaron Do you mean record some videos to show how this is working? I can update README with instructions on how to use the app with redux devtools 😄

[marcaaron]

@marcaaron Do you mean record some videos to show how this is working?

Not necessarily videos. But some instructions on how one would use this. I'm thinking of people who have not used ReduxDevTool before and might benefit from knowing that this exists and some basic explanation for how to use it.

[pac-guerreiro]

@marcaaron I added some instructions to the README. Let me know if it's clear to you!

[marcaaron]

The README looks awesome. Thanks for the changes!

Is this something that we are wanting to enable on production? I can't think of a reason why not, but wonder if there is any performance issues with that. It seems like something we should only enable on staging so it would be good to have a way to opt in or out.

Thoughts?

[marcaaron]

cc @AndrewGable on the above. If it doesn't seem valuable though then I am 👍 on this one.

[AndrewGable]

I think we are working on adding a hidden development menu, so maybe we can wait for that to mature a bit more then we can explore adding this to it? Seems good for now.