[Held requests] Hold Request education modal reappears after relogin

[cdOut]

Details

Save the action when the user dismisses the hold request education modal onto the backend, so we don't show it on every login interaction.

Fixed Issues

$ #37012
PROPOSAL:

Tests

1. Request money from one account to another and then proceed to Hold it by going into the request and pressing the Hold button from the three dot menu.
2. After it displays make sure to either press the Got it button or dismiss the modal by pressing on the overlay.
3. Log out and then proceed to log in to the same account you just used
4. Navigate to any held request report and make sure the interstitial doesn't show up.

• Verify that no errors appear in the JS console

Offline tests

QA Steps

• 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: mWeb Chrome
  • iOS: Native
  • iOS: mWeb 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 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 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 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 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.

Screenshots/Videos

Android: Native

ANDROID-NATIVE.mov

Android: mWeb Chrome

ANDROID-CHROME.mov

iOS: Native

IOS-NATIVE.mov

iOS: mWeb Safari

IOS-SAFARI.mov

MacOS: Chrome / Safari

CHROME.mov

MacOS: Desktop

DESKTOP.mov

[melvin-bot]

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

[ahmedGaber93]

Bug: I think we may have a race condition here.

1. hold request
2. after educational model appear, click Got it.
3. go back and reopen the hold request (modal not reopen)
4. go back and refresh the browser, then reopen the hold request (modal reopen again)

When I log dismissedHoldUseExplanation it seem it come with null for first times then back with the correct value.

20240606093752283.mp4

[ahmedGaber93]

After relogin, I am still can reproduce the issue, it seems backend not back nvp_dismissedHoldUseExplanation to the user. Did I miss something?

20240606100501693.mp4

[cdOut]

@robertjchen Could you please confirm the naming of the NVP and if it's currently in use on the main backend or is it up on staging? Is there a specific write command I'm supposed to use or is the one used for other NVPs okay?

[robertjchen]

The naming looks correct to me 🤔 There's no specific write command, it should just be like the other NVPs.

[cdOut]

When I log dismissedHoldUseExplanation it seem it come with null for first times then back with the correct value.

It's a pretty specific case that isn't easily replicable but I've added an initial value and that should fix the null value.

After relogin, I am still can reproduce the issue, it seems backend not back nvp_dismissedHoldUseExplanation to the user. Did I miss something?

It seems to work for some of my accounts and not for the others, @robertjchen is there a specific behavior of how we handle NVPs on the backend here? For example when dealing with new accounts and old ones?

I'll investigate what exactly happens in this pipeline of reading the NVP from the backend to deciding whether to display the explanation modal.

[robertjchen]

is there a specific behavior of how we handle NVPs on the backend here? For example when dealing with new accounts and old ones?

Hm, the NVP controls the display of the modal such that it shows up once for the lifetime of an account. Once the modal is dismissed, we set the NVP so that later on the UI we know not to ever show it again.

• For a new account, the NVP does not exist. In the frontend logic- we detect this and show the modal.
• For a pre-existing account, the NVP does not exist. In the frontend logic- we detect this and show the modal.

When the modal is dismissed we simply set the NVP to some true value. This is automatically propagated to the backend and saved.

Next time they log in, the NVPs are loaded into the frontend. The frontend detects that this NVP exists, and therefore does NOT show the modal.

Let me know if the helps clear it up 🙏 The NVP does not get any special treatment, it's just a setting we set once and check later on.

[ahmedGaber93]

Next time they log in, the NVPs are loaded into the frontend. The frontend detects that this NVP exists, and therefore does NOT show the modal.

@robertjchen Could you please check why backend not back nvp_dismissedHoldUseExplanation for my account a.gaber.dev+1001@gmail.com?

• API request api/SetNameValuePair send the parameter nvp_dismissedHoldUseExplanation with true value and done successfully.

• The above request respond with empty onyxData {"oldValue":"","jsonCode":200,"requestID":"89212ea2df3b536f-CAI","onyxData":[]}

• After relogin nvp_dismissedHoldUseExplanation not back in api/OpenApp, I also checked browser OnyxDB and it not found.

[robertjchen]

Hm, could you try dropping the nvp_ prefix and just usingdismissedHoldUseExplanation to see if it comes back? 🙏

[ahmedGaber93]

@robertjchen dismissedHoldUseExplanation also not back in api/OpenApp, and not found in browser OnyxDB.

[robertjchen]

The team expert who designed the new NVP system just tested the backend API and said the NVP was being returned properly for api/OpenApp. Can you please test again and check if nvp_dismissedHoldUseExplanation is present in the OnyxDB? 😕

[ahmedGaber93]

I am in break now, and I will recheck after one hour.

[ahmedGaber93]

The team expert who designed the new NVP system just tested the backend API and said the NVP was being returned properly for api/OpenApp. Can you please test again and check if nvp_dismissedHoldUseExplanation is present in the OnyxDB? 😕

@robertjchen api/OpenApp have a lot of NVP values but not have nvp_dismissedHoldUseExplanation, also OnyxDB not have it.

20240611174517753.mp4

20240611174623007.mp4

[cdOut]

@robertjchen I've checked myself and the nvp is not present in OnyxDB, there also might be a problem with the API write command, since WRITE_COMMANDS.SET_NAME_VALUE_PAIR is only used for this one and ONYXKEYS.NVP_HAS_SEEN_TRACK_TRAININ, which also does not appear in the OnyxDB.

[robertjchen]

@cdOut That could be it! Similar NVPs used for other settings don't seem to have corresponding API calls. Maybe we can try copying what NVP_HAS_SEEN_TRACK_TRAININ has done and see if that works?

[robertjchen]

@cdOut This tweak seemed to have worked for me, I think the prefix might be throwing things off when setting the NVP.

[robertjchen]

Going to explore a backend approach 👀

[robertjchen]

Got a backend fix under review 👍

[cdOut]

@robertjchen will any adjustments have to be made on the frontend side also?

[robertjchen]

No, just the backend 👍

[robertjchen]

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[robertjchen]

Corresponding backend changes were merged and I tested this PR locally in concert with those changes to confirm that things were working. To speed things up, I'll merge this as well in parallel.

[robertjchen]

Completed fresh reviewer's checklist

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[ahmedGaber93]

Corresponding backend changes were merged and I tested this PR locally in concert with those changes to confirm that things were working. To speed things up, I'll merge this as well in parallel.

@robertjchen Thanks for completing reviewer's checklist. But we still have pending change here #40435 (comment) need to fix. I think @cdOut should create a follow up PR to fix this.

[cdOut]

I'll create a follow up PR in a sec, I wasn't able to push the changes due to the sudden merge.

[robertjchen]

Ah, my apologies! 🙇

[OSBotify]

🚀 Deployed to staging by https://github.com/robertjchen in version: 1.4.86-0 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/robertjchen in version: 1.4.86-0 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/robertjchen in version: 1.4.86-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.0-9 🚀

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