Automatically enable memory only keys when payload size of reconnectapp/openapp is too large #23831

tgolen · 2023-07-28T21:28:23Z

Details

This PR will listen for the server attempting to update the memory only keys feature. If there is an onyx update for that key, then the frontend will fully enable the feature.

Fixed Issues

Part of https://github.com/Expensify/Expensify/issues/300442

Tests

Note: this can only be fully tested by an internal engineering using the PR https://github.com/Expensify/Web-Expensify/pull/38491

Tests for anyone (web and desktop only)

Sign onto NewDot
Run enableMemoryOnlyKeys() from the JS console
Verify the logs say [MemoryOnlyKeys] enabled
Run disableMemoryOnlyKeys() from the JS console
Verify the logs say [MemoryOnlyKeys] disabled

Tests for an internal engineer (all platforms except mobile web)

Update Web-Expensify to use the branch from https://github.com/Expensify/Web-Expensify/pull/38491
Set the MEMORYONLYKEYS_THRESHOLD constant to be a negative number (like -1)
Sign out from NewDot
Sign in to NewDot
Verify the logs show [MemoryOnlyKeys] enabled
Go to JS console to look in Onyx
Verify that no report_ keys and no policy_ keys are saved

Verify that no errors appear in the JS console

Offline tests

None

QA Steps

You can perform the tests above in the Tests for anyone (web and desktop only) section

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed 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 added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 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 Note: this cannot be tested on mobile web due to not being able to access the JS console
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari Note: this cannot be tested on mobile web due to not being able to access the JS console
- 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 any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 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 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-08-14T18:01:53Z

@arosiclair 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 · 2023-08-14T21:21:34Z

@tgolen Maybe you are on top of this already (sorry if so), but I think we're gonna want to add a test that if OpenApp has the memory only keys directive in the response then none of the reports, policies, etc keys should be saved to storage.

The original intention of the mode was that it would run before OpenApp (and sign in) so after the response returns it won't spend time saving things to storage. Can look at the IndexedDB in the ChromeDevTools to figure that out for the purposes of this PR. We shouldn't see any reports or policies in storage.

tgolen · 2023-08-14T21:27:39Z

Thanks for spelling that out. I definitely didn't have that context, but it appears like this is already being handled:

App/src/libs/actions/MemoryOnlyKeys/MemoryOnlyKeys.js

Line 4 in 0a21797

    
           const memoryOnlyKeys = [ONYXKEYS.COLLECTION.REPORT, ONYXKEYS.COLLECTION.POLICY, ONYXKEYS.PERSONAL_DETAILS_LIST];

tgolen · 2023-08-14T21:28:12Z

It sounds like maybe I just need to update the testing instructions

tgolen · 2023-08-14T21:37:21Z

OK, I updated the tests and retested it. Thanks for noticing that!

tgolen · 2023-08-17T16:52:11Z

Bump for review @arosiclair

arosiclair · 2023-08-17T20:25:33Z

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 / Chrome
- iOS / native
- iOS / 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(themeColors.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 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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

arosiclair · 2023-08-17T21:39:26Z

LGTM though I'm still blocked on Android build issues so I can't test there atm

marcaaron

Couple small things, questions, overall - looks great

src/libs/Middleware/SaveResponseInOnyx.js

marcaaron · 2023-08-17T22:27:43Z

src/libs/Middleware/SaveResponseInOnyx.js

+        // Supports both the old format and the new format
+        const onyxUpdates = _.isArray(responseData) ? responseData : responseData.onyxData;
+        // If there is an OnyxUpdate for using memory only keys, enable them
+        _.each(onyxUpdates, ({key, value}) => {


Nab - alternatively _.find() and stop iterating when we hit the key (probably marginal)

marcaaron · 2023-08-17T22:29:30Z

src/libs/actions/MemoryOnlyKeys/MemoryOnlyKeys.js

+const memoryOnlyKeys = [ONYXKEYS.COLLECTION.REPORT, ONYXKEYS.COLLECTION.POLICY, ONYXKEYS.PERSONAL_DETAILS_LIST];
+
+const enable = () => {
+    console.debug('[MemoryOnlyKeys] enabled');


Maybe this (and the one belwo) could be a Log.info()? Could help show that someone enabled this mode if we are investigating server logs.

That's a good idea

marcaaron · 2023-08-17T22:31:17Z

src/libs/actions/MemoryOnlyKeys/exposeGlobalMemoryOnlyKeysMethods/index.js

@@ -0,0 +1,12 @@
+import * as MemoryOnlyKeys from '../MemoryOnlyKeys';
+
+const exposeGlobalMethods = () => {


Suggested change

const exposeGlobalMethods = () => {

const exposeGlobalMemoryOnlyKeysMethods = () => {

marcaaron · 2023-08-17T22:31:26Z

src/libs/actions/MemoryOnlyKeys/exposeGlobalMemoryOnlyKeysMethods/index.js

+    };
+};
+
+export default exposeGlobalMethods;


Suggested change

export default exposeGlobalMethods;

export default exposeGlobalMemoryOnlyKeysMethods;

marcaaron · 2023-08-17T22:31:32Z

src/libs/actions/MemoryOnlyKeys/exposeGlobalMemoryOnlyKeysMethods/index.native.js

+/**
+ * This is a no-op because the global methods will only work for web and desktop
+ */
+const exposeGlobalMethods = () => {};


Suggested change

const exposeGlobalMethods = () => {};

const exposeGlobalMemoryOnlyKeysMethods = () => {};

marcaaron · 2023-08-17T22:31:38Z

src/libs/actions/MemoryOnlyKeys/exposeGlobalMemoryOnlyKeysMethods/index.native.js

+ */
+const exposeGlobalMethods = () => {};
+
+export default exposeGlobalMethods;


Suggested change

export default exposeGlobalMethods;

export default exposeGlobalMemoryOnlyKeysMethods;

marcaaron · 2023-08-17T22:36:18Z

src/libs/actions/User.js

+                }
+
+                MemoryOnlyKeys.enable();
+            });


NAB, I thought maybe we were just sending these onyxUpdate with this key via https? Is including the check here for Pusher updates sort of a future proofing?

Yeah, you're right. This is a hold-over from my original testing/implementation but it doesn't need to be here and is a little confusing. I'll remove it.

tgolen · 2023-08-18T16:28:55Z

Updated!

arosiclair

Android tests well 👍

marcaaron

LGTM (but there's a lint issue to address)

src/libs/actions/User.js

Co-authored-by: Marc Glasser <marc.aaron.glasser@gmail.com>

tgolen · 2023-08-18T19:33:50Z

Updated! Sorry, all your reviews got dismissed. Next one to approve, please feel free to merge.

OSBotify · 2023-08-18T21:14: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 · 2023-08-21T22:23:55Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.56-0 🚀

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

OSBotify · 2023-08-24T03:06:56Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

cubuspl42 · 2023-12-14T11:26:48Z

src/libs/actions/MemoryOnlyKeys/exposeGlobalMemoryOnlyKeysMethods/index.js

+    window.enableMemoryOnlyKeys = () => {
+        MemoryOnlyKeys.enable();
+    };
+    window.disableMemoryOnlyKeys = () => {
+        MemoryOnlyKeys.disable();
+    };


What is it for? Hand-debugging via console, or what?

We're just adding typing for this part and I'm wondering if it's actually beneficial to expand the Window interface, or maybe we don't need any typing for this if we don't intend to use it programmatically.

Yes, it's a JS console thing. And no, it shouldn't really be used in the code anywhere. So I agree there is no point in getting crazy with the types for this.

tgolen added 4 commits July 28, 2023 09:26

Add action and global methods

1b8bf45

Move and reorganize files a little

20fc7e0

Check for updates in pusher response

f092753

Move code to HTTPS handler

86853c6

tgolen self-assigned this Jul 28, 2023

tgolen added 5 commits August 11, 2023 09:20

Merge branch 'main' into tgolen-auto-enableMemoryOnlyKeys

952fb94

Merge branch 'main' into tgolen-auto-enableMemoryOnlyKeys

41f3d9a

Finish implementing checks for onyx update

0b80894

Improve debug logs

b09913c

Enable memory only keys when guides login

0a21797

tgolen changed the title ~~Tgolen auto enable memory only keys~~ Automatically enable memory only keys when payload size of reconnectapp/openapp are too large Aug 14, 2023

tgolen changed the title ~~Automatically enable memory only keys when payload size of reconnectapp/openapp are too large~~ Automatically enable memory only keys when payload size of reconnectapp/openapp is too large Aug 14, 2023

tgolen marked this pull request as ready for review August 14, 2023 18:01

tgolen requested a review from a team as a code owner August 14, 2023 18:01

melvin-bot bot removed the request for review from a team August 14, 2023 18:01

melvin-bot bot requested a review from arosiclair August 14, 2023 18:01

marcaaron requested changes Aug 17, 2023

View reviewed changes

tgolen added 5 commits August 18, 2023 10:17

Merge branch 'main' into tgolen-auto-enableMemoryOnlyKeys

ec861b5

Improve comments, remove unnecessary code

560f569

Switch underscore method to be more efficient

6b6aaf1

Add proper return values

a964554

Change logging to use server logs

5b94b18

Update method names to match file name

825cf66

arosiclair previously approved these changes Aug 18, 2023

View reviewed changes

marcaaron previously approved these changes Aug 18, 2023

View reviewed changes

src/libs/actions/User.js Outdated Show resolved Hide resolved

Update src/libs/actions/User.js

c5d5f61

Co-authored-by: Marc Glasser <marc.aaron.glasser@gmail.com>

tgolen dismissed stale reviews from marcaaron and arosiclair via c5d5f61 August 18, 2023 19:33

arosiclair approved these changes Aug 18, 2023

View reviewed changes

tgolen merged commit da7b20a into main Aug 18, 2023
14 checks passed

tgolen deleted the tgolen-auto-enableMemoryOnlyKeys branch August 18, 2023 21:10

OSBotify mentioned this pull request Aug 21, 2023

Deploy Checklist: New Expensify 2023-08-21 #25625

Closed

VickyStash mentioned this pull request Dec 14, 2023

[TS migration] Migrate '[Remaining Group 2]' lib to TypeScript #32164

Merged

50 tasks

cubuspl42 reviewed Dec 14, 2023

View reviewed changes

VickyStash mentioned this pull request Jan 12, 2024

[$500] Running "enableMemoryOnlyKeys()" and "disableMemoryOnlyKeys()" gives "undefined" #34321

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automatically enable memory only keys when payload size of reconnectapp/openapp is too large #23831

Automatically enable memory only keys when payload size of reconnectapp/openapp is too large #23831

tgolen commented Jul 28, 2023 •

edited

Loading

melvin-bot bot commented Aug 14, 2023

marcaaron commented Aug 14, 2023

tgolen commented Aug 14, 2023

tgolen commented Aug 14, 2023

tgolen commented Aug 14, 2023

tgolen commented Aug 17, 2023

arosiclair commented Aug 17, 2023 •

edited

Loading

arosiclair commented Aug 17, 2023

marcaaron left a comment

marcaaron Aug 17, 2023

tgolen Aug 18, 2023

marcaaron Aug 17, 2023

tgolen Aug 18, 2023

marcaaron Aug 17, 2023

marcaaron Aug 17, 2023

marcaaron Aug 17, 2023

marcaaron Aug 17, 2023

marcaaron Aug 17, 2023

tgolen Aug 18, 2023

tgolen commented Aug 18, 2023

arosiclair left a comment

marcaaron left a comment

tgolen commented Aug 18, 2023

OSBotify commented Aug 18, 2023

OSBotify commented Aug 21, 2023

OSBotify commented Aug 24, 2023

cubuspl42 Dec 14, 2023

cubuspl42 Dec 14, 2023 •

edited

Loading

marcaaron Dec 14, 2023

		@@ -0,0 +1,12 @@
		import * as MemoryOnlyKeys from '../MemoryOnlyKeys';

		const exposeGlobalMethods = () => {

	const exposeGlobalMethods = () => {
	const exposeGlobalMemoryOnlyKeysMethods = () => {

	export default exposeGlobalMethods;
	export default exposeGlobalMemoryOnlyKeysMethods;

	const exposeGlobalMethods = () => {};
	const exposeGlobalMemoryOnlyKeysMethods = () => {};

Automatically enable memory only keys when payload size of reconnectapp/openapp is too large #23831

Automatically enable memory only keys when payload size of reconnectapp/openapp is too large #23831

Conversation

tgolen commented Jul 28, 2023 • edited Loading

Details

Fixed Issues

Tests

Tests for anyone (web and desktop only)

Tests for an internal engineer (all platforms except mobile web)

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 14, 2023

marcaaron commented Aug 14, 2023

tgolen commented Aug 14, 2023

tgolen commented Aug 14, 2023

tgolen commented Aug 14, 2023

tgolen commented Aug 17, 2023

arosiclair commented Aug 17, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

arosiclair commented Aug 17, 2023

marcaaron left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tgolen commented Aug 18, 2023

arosiclair left a comment

Choose a reason for hiding this comment

marcaaron left a comment

Choose a reason for hiding this comment

tgolen commented Aug 18, 2023

OSBotify commented Aug 18, 2023

OSBotify commented Aug 21, 2023

OSBotify commented Aug 24, 2023

Choose a reason for hiding this comment

cubuspl42 Dec 14, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tgolen commented Jul 28, 2023 •

edited

Loading

arosiclair commented Aug 17, 2023 •

edited

Loading

cubuspl42 Dec 14, 2023 •

edited

Loading