Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: unify storage/providers (for further InMemory storage integration) [1/3] #475

Merged
merged 4 commits into from
Feb 29, 2024

Conversation

kirillzyusko
Copy link
Contributor

@kirillzyusko kirillzyusko commented Feb 27, 2024

Details

A follow up for #439

This is the first PR that prepares an "infrastructure" for next PR. In this PR I did:

  • all calls to providers are managed via additional Storage layer (in future this layer will intercept errors and will substitute provider to InMemory);
  • synchronization between tabs is not a responsibility of provider anymore - now it's handled in separate InstanceSync class/object - such approach allows us to avoid code duplication if we add InMemory provider on web;
  • all providers are initialized lazily (all providers got a new init method);

Related Issues

Expensify/App#29403

Automated Tests

This PR changes the way we use the storage but the functionality of the library to the outer world is the same. Therefore no new tests were added.

Manual Tests

Verify that no flows and functionality were broken by the changes. Check for console errors regarding Onyx.

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

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

Copy link
Contributor

github-actions bot commented Feb 27, 2024

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@kirillzyusko kirillzyusko force-pushed the refactor/split-up-in-memory-pr-part-1 branch from 29cd54c to b83cc07 Compare February 27, 2024 13:42
@kirillzyusko
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@kirillzyusko
Copy link
Contributor Author

recheck

@kirillzyusko kirillzyusko marked this pull request as ready for review February 27, 2024 14:04
@kirillzyusko kirillzyusko requested a review from a team as a code owner February 27, 2024 14:04
@melvin-bot melvin-bot bot requested review from danieldoglas and removed request for a team February 27, 2024 14:05
@danieldoglas
Copy link
Contributor

Adding original reviewers from #439

lib/storage/index.ts Outdated Show resolved Hide resolved
lib/storage/platforms/NativeStorage.ts Outdated Show resolved Hide resolved
lib/storage/platforms/WebStorage.ts Outdated Show resolved Hide resolved
lib/storage/platforms/index.ts Outdated Show resolved Hide resolved
@kirillzyusko
Copy link
Contributor Author

@tgolen I addressed your notes - would you mind to check this PR again? 👀

Copy link
Collaborator

@tgolen tgolen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha, I see what you did now! I like it.

* On native platforms, we omit this syncing logic by setting this to mock implementation.
*/
const InstanceSync = {
init: NOOP,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this need to use lodash, or can it just be an empty arrow function like init: () => {}?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tgolen if I add empty functions I'm getting eslint errors:

image

Do you think it would be better to specify our own function?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, that's interesting. OK, it's probably fine to leave it as NOOP for now. Thanks for trying!

@@ -1563,6 +1563,16 @@ function init({
shouldSyncMultipleInstances = Boolean(global.localStorage),
debugSetState = false,
} = {}) {
Storage.init();

if (shouldSyncMultipleInstances) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was there any specific reason to move this up here? I think it makes sense but I'm also surprised that it wasn't here to begin with.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tgolen it was already asked in #439 (comment)

And I agree, that it's better to keep initialization in a single place 👀

@marcaaron
Copy link
Contributor

Got some competing priorities so will have to pull myself off the review to avoid becoming a blocker. If there is anything that needs my attention I am happy to take a look!

@marcaaron marcaaron removed their request for review February 28, 2024 01:26
tgolen
tgolen previously approved these changes Feb 28, 2024
@tgolen
Copy link
Collaborator

tgolen commented Feb 28, 2024

Looks like you'll need to run prettier on this branch to get the lint test to pass.

@kirillzyusko
Copy link
Contributor Author

@tgolen I fixed eslint errors in 1932e25 - can you please check if it's okay? 👀

Copy link
Contributor

@danieldoglas danieldoglas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes LGTM based on what I've read in the description. Please assign me on the next PR as well so I can get more context.

@kirillzyusko kirillzyusko changed the title refactor: unify storage/providers (for further InMemory storage integration) [1/2] refactor: unify storage/providers (for further InMemory storage integration) [1/3] Feb 28, 2024
@tgolen
Copy link
Collaborator

tgolen commented Feb 28, 2024

Looks like the lint errors are fixed. Sorry, I didn't catch this one earlier either:

image

Looks like you need to setup commit signing. It can be a pain to go back and sign previous commits... so what you could do is close this PR and create a brand new one after you've setup commit signing. Up to you!

@kirillzyusko kirillzyusko force-pushed the refactor/split-up-in-memory-pr-part-1 branch from 1932e25 to 1bfc24d Compare February 28, 2024 17:21
@kirillzyusko
Copy link
Contributor Author

Looks like you need to setup commit signing.

My bad 🤦‍♂️

I signed them now and pushed to this PR (hopefully now everything is okay and it can be merged 😊)

@kirillzyusko
Copy link
Contributor Author

@tgolen is there any other blockers preventing this PR from being merged?

@tgolen tgolen merged commit 428a995 into Expensify:main Feb 29, 2024
4 checks passed
tgolen added a commit that referenced this pull request Mar 5, 2024
kirillzyusko added a commit to margelo/react-native-onyx that referenced this pull request Mar 6, 2024
This reverts commit 577e611.
kirillzyusko added a commit to margelo/react-native-onyx that referenced this pull request Mar 12, 2024
This reverts commit 577e611.
kirillzyusko added a commit to margelo/react-native-onyx that referenced this pull request Mar 15, 2024
This reverts commit 577e611.
kirillzyusko added a commit to margelo/react-native-onyx that referenced this pull request Mar 25, 2024
This reverts commit 577e611.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants