fix: Persist "Mask fragile user data while exporting Onyx state" switch state #45401

etCoderDysto · 2024-07-15T13:19:50Z

Details

Fixed Issues

$ #44841
PROPOSAL: #44841 (comment)

Tests

Navigate to account settings > Troubleshoot
Disable 'Mask fragile user data while exporting Onyx state' switch
Navigate away from Troubleshoot page
Navigate back to settings > Troubleshoot

Verify that the switch remains disabled

Enable 'Mask fragile user data while exporting Onyx state' switch
Navigate away from Troubleshoot page
Navigate back to settings > Troubleshoot

Verify that the switch remains enabled
Verify that no errors appear in the JS console

Offline tests

Same as Test steps.
Note: Switch won't be grayed out when toggling it in offline mode. The feature is only client side.

QA Steps

Same as Test steps.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android.mp4

Android: mWeb Chrome

Android.web.mp4

iOS: Native

iOS.mp4

iOS: mWeb Safari

ios.safari.mp4

MacOS: Chrome / Safari

Desktop.web.mp4

MacOS: Desktop

Desktop.mp4

Merge main to fix branch

melvin-bot · 2024-07-15T13:19:56Z

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

etCoderDysto · 2024-07-15T13:21:36Z

@ZhenjaHorbach The switch is disabled by default. Should I make it enabled by default?

ZhenjaHorbach · 2024-07-15T13:41:13Z

@ZhenjaHorbach The switch is disabled by default. Should I make it enabled by default?

I think yes
In the previous implementation it is enabled by default

etCoderDysto · 2024-07-15T13:46:43Z

@ZhenjaHorbach The switch is disabled by default. Should I make it enabled by default?

I think yes In the previous implementation it is enabled by default

Great! I am working on it.

ZhenjaHorbach · 2024-07-15T13:49:25Z

And let's create a separate file for setShouldMaskOnyxState
I'm not sure that App.ts is the place for this

etCoderDysto · 2024-07-15T13:52:58Z

And let's create a separate file for setShouldMaskOnyxState
I'm not sure that App.ts is the place for this

Sure! I was also not sure if I should put it there. I put it there to implement the idea. I will create a separate file.

etCoderDysto · 2024-07-15T14:53:20Z

I think yes. In the previous implementation it is enabled by default

Done✅.

And let's create a separate file for setShouldMaskOnyxState. I'm not sure that App.ts is the place for this.

Done✅.

ZhenjaHorbach · 2024-07-15T15:02:11Z

src/pages/settings/Troubleshoot/TroubleshootPage.tsx

+    useEffect(() => {
+        // Set shouldMaskOnyxState to true when user navigates to troubleshoot page after sign in
+        if (shouldMaskOnyxState !== undefined) {
+            return;
+        }
+        setShouldMaskOnyxState(true);
+    });


Is this really necessary?
We already have shouldMaskOnyxState ?? true
Plus this useEffect will call after every single render

Yes, if we don't update shouldMaskOnyx state to be true. We will export unmasked Onyx state below even if the switch is enabled.

App/src/pages/settings/Troubleshoot/TroubleshootPage.tsx

Lines 69 to 73 in 69a202e

if (shouldMaskOnyxState) {

dataToShare = ExportOnyxState.maskFragileData(value);

}

ExportOnyxState.shareAsFile(JSON.stringify(dataToShare));

.

if I add empty dependency to useEffect, setShouldMaskOnyxState is going to called only once when the user navigates to troubleshoot page after sign in.

I think it's normal practice
We can consider undefined as true

Sounds good to me. To confirm that I get what you said right.

I should update the above diff to

if (shouldMaskOnyxState ?? shouldMaskOnyxState === undefined) { dataToShare = ExportOnyxState.maskFragileData(value); }

Remove the whole useEffect code block.

Is that right?

Alternatively, we can update the diff to

if (shouldMaskOnyxState !== false) { dataToShare = ExportOnyxState.maskFragileData(value); }

Both seems to work.

Remove useEffect and add selector for this

Merge main to fix branch

ZhenjaHorbach · 2024-07-15T17:28:58Z

src/pages/settings/Troubleshoot/TroubleshootPage.tsx

@@ -150,7 +142,7 @@ function TroubleshootPage({shouldStoreLogs, shouldMaskOnyxState}: TroubleshootPa
                                <TestToolRow title={translate('initialSettingsPage.troubleshoot.maskExportOnyxStateData')}>
                                    <Switch
                                        accessibilityLabel={translate('initialSettingsPage.troubleshoot.maskExportOnyxStateData')}
-                                        isOn={shouldMaskOnyxState ?? true}
+                                        isOn={!!shouldMaskOnyxState}


!! is unnecessary. Since we will always receive a boolean value

Removed !!.

ZhenjaHorbach · 2024-07-15T19:48:30Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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

android.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

ZhenjaHorbach · 2024-07-15T19:53:34Z

src/libs/actions/setShouldMaskOnyxState.ts

@@ -0,0 +1,6 @@
+import Onyx from 'react-native-onyx';
+import ONYXKEYS from '@src/ONYXKEYS';
+


Just notice
Let's rename this file (MaskOnyx)
And export like

export default { setShouldMaskOnyxState, };

Similar file is UpdateRequired

I have made the changes. But I used name export, rather than default export here

App/src/libs/actions/MaskOnyx.ts

Lines 8 to 10 in 772da95

export {

// eslint-disable-next-line import/prefer-default-export

setShouldMaskOnyxState,

When using default export, the function is wrapped inside an object and it can't be destructured at import.

ZhenjaHorbach · 2024-07-15T20:31:39Z

The changes works well
But first need to fix the comment above

ZhenjaHorbach · 2024-07-15T20:40:28Z

Test steps are a bit broken and not completely filled😅

etCoderDysto · 2024-07-15T20:52:44Z

Test steps are a bit broken and not completely filled😅

I have updated the test steps 😄.

ZhenjaHorbach · 2024-07-15T21:08:00Z

LGTM

hayata-suenaga

🟢

OSBotify · 2024-07-16T14:23:43Z

✋ 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-07-17T02:09:56Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 9.0.8-1 🚀

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

OSBotify · 2024-07-17T15:50:16Z

🚀 Cherry-picked to staging by https://github.com/Beamanator in version: 9.0.8-3 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-18T13:55:23Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.8-6 🚀

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

OSBotify · 2024-07-19T19:37:40Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.9-5 🚀

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

etCoderDysto added 7 commits July 12, 2024 21:41

Add SHOULD_MASK_ONYX_STATE to ONYXKEYS

1d57f06

Initialize SHOULD_MASK_ONYX_STATE with true

1c4c42f

Create action that updates SHOULD_MASK_ONYX_STATE

5cad05e

Fetch shouldMaskOnyxState from store and update it on toggle

b5ba084

fix type issue

03b546c

Merge branch 'main' into persist-export-onxy-switch-state

3900ec6

Merge main to fix branch

Don't initialize shouldMaskOnyxState on every time the app loads

f426d76

etCoderDysto requested a review from a team as a code owner July 15, 2024 13:19

melvin-bot bot requested review from ZhenjaHorbach and removed request for a team July 15, 2024 13:19

etCoderDysto mentioned this pull request Jul 15, 2024

[HOLD for payment 2024-07-25] Troubleshoot-"Mask fragile user data while exporting Onyx state" toggle is auto-enabled #44841

Closed

6 tasks

etCoderDysto added 4 commits July 15, 2024 17:24

Enable shouldMask switch by default

6f221f3

Create shouldMaskOnyx action in separate file

3253190

replace shouldMaskOnyx from App by the newly created action

6bdd32f

remove setShouldMask action from App

69a202e

ZhenjaHorbach reviewed Jul 15, 2024

View reviewed changes

etCoderDysto added 3 commits July 15, 2024 20:24

Use selector make shouldMaskOnyx true when it is undefiend

13d7b26

Merge branch 'main' into persist-export-onxy-switch-state

27e2064

Merge main to fix branch

remove unused useEffect

69c79fe

ZhenjaHorbach reviewed Jul 15, 2024

View reviewed changes

Remove coarcion from !!shouldMaskOnyxState

3324b32

ZhenjaHorbach reviewed Jul 15, 2024

View reviewed changes

Rename setShouldMaskOnyx to MaskOnyx

772da95

ZhenjaHorbach approved these changes Jul 15, 2024

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga July 15, 2024 21:08

hayata-suenaga approved these changes Jul 16, 2024

View reviewed changes

hayata-suenaga merged commit e009c43 into Expensify:main Jul 16, 2024
16 of 17 checks passed

github-actions bot mentioned this pull request Jul 17, 2024

Deploy Checklist: New Expensify 2024-07-17 #45538

Closed

48 tasks

Christinadobrzyn mentioned this pull request Jul 25, 2024

[HOLD for payment 2024-07-22] [HOLD for payment 2024-07-17] [$250] [Performance] [MEDIUM] Add "Export Onyx state" option to Troubleshoot menu and four finger tap #43097

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Persist "Mask fragile user data while exporting Onyx state" switch state #45401

fix: Persist "Mask fragile user data while exporting Onyx state" switch state #45401

etCoderDysto commented Jul 15, 2024 •

edited

Loading

melvin-bot bot commented Jul 15, 2024

etCoderDysto commented Jul 15, 2024

ZhenjaHorbach commented Jul 15, 2024

etCoderDysto commented Jul 15, 2024

ZhenjaHorbach commented Jul 15, 2024

etCoderDysto commented Jul 15, 2024

etCoderDysto commented Jul 15, 2024

ZhenjaHorbach Jul 15, 2024

etCoderDysto Jul 15, 2024

ZhenjaHorbach Jul 15, 2024 •

edited

Loading

etCoderDysto Jul 15, 2024

etCoderDysto Jul 15, 2024

ZhenjaHorbach Jul 15, 2024

ZhenjaHorbach Jul 15, 2024

etCoderDysto Jul 15, 2024

ZhenjaHorbach commented Jul 15, 2024 •

edited

Loading

ZhenjaHorbach Jul 15, 2024 •

edited

Loading

etCoderDysto Jul 15, 2024 •

edited

Loading

ZhenjaHorbach commented Jul 15, 2024

ZhenjaHorbach commented Jul 15, 2024

etCoderDysto commented Jul 15, 2024 •

edited

Loading

ZhenjaHorbach commented Jul 15, 2024

hayata-suenaga left a comment

OSBotify commented Jul 16, 2024

OSBotify commented Jul 17, 2024

OSBotify commented Jul 17, 2024

OSBotify commented Jul 18, 2024

OSBotify commented Jul 19, 2024

	if (shouldMaskOnyxState) {
	dataToShare = ExportOnyxState.maskFragileData(value);
	}

	ExportOnyxState.shareAsFile(JSON.stringify(dataToShare));

		@@ -0,0 +1,6 @@
		import Onyx from 'react-native-onyx';
		import ONYXKEYS from '@src/ONYXKEYS';

	export {
	// eslint-disable-next-line import/prefer-default-export
	setShouldMaskOnyxState,

fix: Persist "Mask fragile user data while exporting Onyx state" switch state #45401

fix: Persist "Mask fragile user data while exporting Onyx state" switch state #45401

Conversation

etCoderDysto commented Jul 15, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 15, 2024

etCoderDysto commented Jul 15, 2024

ZhenjaHorbach commented Jul 15, 2024

etCoderDysto commented Jul 15, 2024

ZhenjaHorbach commented Jul 15, 2024

etCoderDysto commented Jul 15, 2024

etCoderDysto commented Jul 15, 2024

ZhenjaHorbach Jul 15, 2024

Choose a reason for hiding this comment

etCoderDysto Jul 15, 2024

Choose a reason for hiding this comment

ZhenjaHorbach Jul 15, 2024 • edited Loading

Choose a reason for hiding this comment

etCoderDysto Jul 15, 2024

Choose a reason for hiding this comment

etCoderDysto Jul 15, 2024

Choose a reason for hiding this comment

ZhenjaHorbach Jul 15, 2024

Choose a reason for hiding this comment

ZhenjaHorbach Jul 15, 2024

Choose a reason for hiding this comment

etCoderDysto Jul 15, 2024

Choose a reason for hiding this comment

ZhenjaHorbach commented Jul 15, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ZhenjaHorbach Jul 15, 2024 • edited Loading

Choose a reason for hiding this comment

etCoderDysto Jul 15, 2024 • edited Loading

Choose a reason for hiding this comment

ZhenjaHorbach commented Jul 15, 2024

ZhenjaHorbach commented Jul 15, 2024

etCoderDysto commented Jul 15, 2024 • edited Loading

ZhenjaHorbach commented Jul 15, 2024

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 16, 2024

OSBotify commented Jul 17, 2024

OSBotify commented Jul 17, 2024

OSBotify commented Jul 18, 2024

OSBotify commented Jul 19, 2024

etCoderDysto commented Jul 15, 2024 •

edited

Loading

ZhenjaHorbach Jul 15, 2024 •

edited

Loading

ZhenjaHorbach commented Jul 15, 2024 •

edited

Loading

ZhenjaHorbach Jul 15, 2024 •

edited

Loading

etCoderDysto Jul 15, 2024 •

edited

Loading

etCoderDysto commented Jul 15, 2024 •

edited

Loading