Add Onyx key to allow remotely resetting client data by marcaaron · Pull Request #38196 · Expensify/App

marcaaron · 2024-03-13T01:33:05Z

Details

Gives a way to reset a client via an Onyx key flag

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/359211

Tests

Have app open
Run ../script/psysh.sh
Onyx::pushUpdatesToClients([257], ['onyxMethod' => 'set', 'key' => 'resetRequired', 'value' => true]);
Wait some time and verify the app reloads all the data and look normal

Verify that no errors appear in the JS console

Offline tests

❌

QA Steps

Internal. See linked Web-Expensify PR

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Full disclosure there is some kind of bug on main preventing me from testing in mobile sized views.

Android: mWeb Chrome

Full disclosure there is some kind of bug on main preventing me from testing in mobile sized views.

iOS: Native

Full disclosure there is some kind of bug on main preventing me from testing in mobile sized views.

iOS: mWeb Safari

Full disclosure there is some kind of bug on main preventing me from testing in mobile sized views.

MacOS: Chrome / Safari

2024-04-04_13-21-45.mp4

MacOS: Desktop

melvin-bot · 2024-04-10T01:30:29Z

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

marcaaron · 2024-04-10T01:31:43Z

Hey @cubuspl42! For the testing here you can use the JS console to manually set the key in Onyx. I think it should have the same effect as triggering it from the local dev. But let me know if it's unclear or creates any issues. Thanks so much for your help 🙇

jakub-trzebiatowski · 2024-04-10T10:08:56Z

src/ONYXKEYS.ts

    /** Indicates whether an forced upgrade is required */
    UPDATE_REQUIRED: 'updateRequired',

+    /** Indicates whether an forced reset is required a.k.a. clear Oynx data without signing the user out */


Do you think it would be a good idea to include the intention for this feature in the comment? If it's meant to be debug-only, maybe we could highlight it

Given the confusion experienced here I think it's a great idea to update this and explain the intention!

It's a server side way to force clients to reload in case some backend code leaves the app in a broken state.

Please let me know if the change looks good to you 🙇

Looks much better! The comment doesn't mention that it's a server-to-client pipe, but maybe that's obvious.

jakub-trzebiatowski · 2024-04-10T10:19:31Z

@marcaaron

So I understand that I'm meant to ignore the "Tests" section, as it's internal, and just use the global Onyx JS object?

marcaaron · 2024-04-10T20:11:28Z

@cubuspl42 That's correct. Please use the global Onyx JS object to test that the "reload" behavior works ok. I am not sure if it will be easy to do on native (might have to use Flipper and/or mWeb local debugger). But let me know if you run into any issues and we can have the next reviewer test with the local code provided that will work with the dev environment.

jakub-trzebiatowski · 2024-04-11T07:56:10Z

Would you merge main? We're ~1500 commits behind.

jakub-trzebiatowski · 2024-04-11T08:20:39Z

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 approved by marketing by adding the Waiting for Copy label for a copy review 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 */
- 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

addResetRequiredKey-android-compressed.mp4

Android: mWeb Chrome

addResetRequiredKey-android-web-compressed.mp4

iOS: Native

addResetRequiredKey-ios-compressed.mp4

iOS: mWeb Safari

addResetRequiredKey-ios-web-compressed.mp4

MacOS: Chrome / Safari

addResetRequiredKey-web-converted.mp4

MacOS: Desktop

addResetRequiredKey-desktop-converted.mp4

jakub-trzebiatowski

On Native, I used this snippet to test the change:

// eslint-disable-next-line rulesdir/prefer-actions-set-data
Onyx.set(ONYXKEYS.RESET_REQUIRED, true).then((result) => {
    // eslint-disable-next-line no-console
    console.log("Reset successful");
}).catch((error) => {
    console.error("Reset failed", error);
});

melvin-bot · 2024-04-12T09:40:07Z

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

melvin-bot · 2024-04-12T09:40:10Z

🎯 @cubuspl42, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #40170.

srikarparsi

lgtm

OSBotify · 2024-04-12T22:32: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-04-18T04:54:50Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 1.4.63-0 🚀

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

OSBotify · 2024-04-22T14:55:49Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

jjcoffee · 2024-09-16T11:40:23Z

src/libs/actions/App.ts

 });

+const KEYS_TO_PRESERVE: OnyxKey[] = [
+    ONYXKEYS.ACCOUNT,


@marcaaron Was there any specific reason not to include ONYXKEYS.USER here? We're considering adding it in #49087, but wanted to check first if there are any good arguments against doing so.

Can't think of a reason! Thanks for asking! The array of keys also predates this PR so we could also ask the author of the original PR that introduced this change.

Add Onyx key to allow remotely resetting client data

fa716a9

marcaaron self-assigned this Mar 13, 2024

marcaaron requested a review from a team as a code owner March 13, 2024 01:33

melvin-bot bot requested review from alitoshmatov and removed request for a team March 13, 2024 01:33

marcaaron removed the request for review from alitoshmatov March 13, 2024 01:33

marcaaron added 5 commits April 4, 2024 12:03

Merge branch 'main' into marcaaron-addResetRequiredKey

9e285f6

Prettier

692092f

Fix logic

356e38a

I am being dumb

be7b69a

style

b38eb55

Expensify deleted a comment from melvin-bot bot Apr 10, 2024

marcaaron requested a review from a team April 10, 2024 01:30

melvin-bot bot removed the request for review from a team April 10, 2024 01:30

melvin-bot bot requested a review from jakub-trzebiatowski April 10, 2024 01:30

jakub-trzebiatowski reviewed Apr 10, 2024

View reviewed changes

Update comment

3cd178a

marcaaron requested a review from jakub-trzebiatowski April 10, 2024 20:13

jakub-trzebiatowski approved these changes Apr 12, 2024

View reviewed changes

melvin-bot bot requested a review from srikarparsi April 12, 2024 09:40

melvin-bot bot mentioned this pull request Apr 12, 2024

[Offer pending] Payment issue for E/App PR#38196 #40170

Closed

srikarparsi approved these changes Apr 12, 2024

View reviewed changes

srikarparsi merged commit 6600b4c into main Apr 12, 2024

srikarparsi deleted the marcaaron-addResetRequiredKey branch April 12, 2024 22:25

github-actions bot mentioned this pull request Apr 18, 2024

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

jjcoffee reviewed Sep 16, 2024

View reviewed changes

Conversation

marcaaron commented Mar 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Apr 10, 2024

Uh oh!

marcaaron commented Apr 10, 2024

Uh oh!

jakub-trzebiatowski Apr 10, 2024

Choose a reason for hiding this comment

Uh oh!

marcaaron Apr 10, 2024

Choose a reason for hiding this comment

Uh oh!

marcaaron Apr 10, 2024

Choose a reason for hiding this comment

Uh oh!

jakub-trzebiatowski Apr 11, 2024

Choose a reason for hiding this comment

Uh oh!

jakub-trzebiatowski commented Apr 10, 2024

Uh oh!

marcaaron commented Apr 10, 2024

Uh oh!

jakub-trzebiatowski commented Apr 11, 2024

Uh oh!

jakub-trzebiatowski commented Apr 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

jakub-trzebiatowski left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Apr 12, 2024

Uh oh!

melvin-bot bot commented Apr 12, 2024

Uh oh!

srikarparsi left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Apr 12, 2024

Uh oh!

OSBotify commented Apr 18, 2024

Uh oh!

OSBotify commented Apr 22, 2024

Uh oh!

jjcoffee Sep 16, 2024

Choose a reason for hiding this comment

Uh oh!

marcaaron Sep 16, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

marcaaron commented Mar 13, 2024 •

edited

Loading

jakub-trzebiatowski commented Apr 11, 2024 •

edited

Loading