Block navigation shortcuts when plaid modal is loading/shown #18462

huzaifa-99 · 2023-05-05T00:23:45Z

Details

Fixed Issues

$ #17598
PROPOSAL: #17598 (comment)

Tests

Verify if Group creation shortcut is blocked when there is no plaid modal shown

Open the app -> settings -> payments -> add bank account
When the plaid modal is loading try to use to CTRL/CMD + SHIFT + K shortcut to create group chat, verify if this shortcut is blocked (it must be). The page url will be /settings/payments/add-bank-account
After successfully filling in the plaid account details on the plaid modal, and navigated back, try to use the CTRL/CMD + SHIFT + K shortcut again, verify if it works (it must work this time).

Verify if search shortcut is blocked when there is no plaid modal shown

Open the app -> settings -> payments -> add bank account
When the plaid modal is loading try to use to CTRL/CMD + K shortcut to open search, verify if this shortcut is blocked (it must be). The page url will be /settings/payments/add-bank-account
After successfully filling in the plaid account details on the plaid modal, and navigated back, try to use the CTRL/CMD + K shortcut again, verify if it works (it must work this time).

Verify if Group creation shortcut is blocked when plaid modal is loading in VBBA flow

Create Workspace
Go to Workspace's settings and click "Connect bank account"
Verify that the shortcut CTRL/CMD + K works
Go back to Workspace's settings and click "Connect bank account"
Click "Connect online with Plaid", and while the spinner is shown, try to press CTRL/CMD + K: it should do nothing
Follow the plaid modal flow to add a bank account from Wells Fargo, select the "saving" and "checking" bank accounts. After finishing with the plaid modal, you should land in this view:
Confirm that the shortcut CTRL/CMD + K works again

Verify that no errors appear in the JS console

Offline tests

Same as the "Tests" section above.

QA Steps

Same as the "Tests" section above.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Chrome

Desktop.Chrome.-.compressed.mp4

Safari

Desktop.Safari.-.compressed.mp4

Mobile Web - Chrome

17598.mp4

Mobile Web - Safari

IOS.Safari.mp4

Desktop

Mac.Desktop.-.compressed.mp4

iOS

Screen.Recording.2023-05-05.at.6.33.49.AM.mov

Android

2.mp4

melvin-bot · 2023-05-05T00:23:50Z

@aldo-expensify @0xmiroslav One of you needs to 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]

huzaifa-99 · 2023-05-05T01:54:00Z

Sry for the lint issues above. This was my first PR here with more than 10 line changes, so forgot to properly lint. Will be careful next time.

src/CONST.js

aldo-expensify · 2023-05-05T15:28:25Z

src/components/AddPlaidBankAccount.js

+        // block keyboard shortcuts that can navigate when plaid modal is shown
+        if (lodashGet(this.props.plaidData, 'bankAccounts', []).length > 0) {
+            this.unblockKeyboardShortcuts();
+        } else {
+            this.blockKeyboardShortcuts();
+        }


I have some preference for subscribing the keyboard shortcuts in componentDidMount and setting the parameter shouldBubble to () => lodashGet(this.props.plaidData, 'bankAccounts', []).length > 0 so it allows the default shortcuts to work when we have the bank accounts.

I just find it slightly easier to understand when this can happen if it is in componentDidMount and componentWillUnmount compared to componentDidUpdate

@0xmiroslav thoughts?

That would also work, @aldo-expensify @0xmiroslav please let me know if I should update it.

@aldo-expensify @0xmiroslav bump ^

yes, it's better solution. Thanks for suggestion
@huzaifa-99 let's do that!

0xmiros · 2023-05-08T11:54:49Z

src/components/AddPlaidBankAccount.js

+                shortcut.descriptionKey,
+                shortcut.modifiers,
+                false,
+                () => lodashGet(this.props.plaidData, 'bankAccounts', []).length > 0, // stop bubbling when there are bank accounts


Is this correct comment?

Nice catch, it should be 'start' (fixed). Thanks for spotting @0xmiroslav

0xmiros · 2023-05-08T12:19:06Z

src/components/AddPlaidBankAccount.js

+        // return early if shortcuts already blocked
+        if (this.subscribedKeyboardShortcuts.length > 0) {
+            return;
+        }


This is safety check but when does this happen?

Since we are now subscribing in the componentDidMount, this check would not be triggered. Its safe to remove, @0xmiroslav should I do that?

yes, we don't need redundant code if we 100% confirm that it's redundant

Done @0xmiroslav

0xmiros · 2023-05-08T17:08:20Z

src/components/AddPlaidBankAccount.js

+        const unsubscribeCallbacks = _.map(
+            shortcutsToBlock,
+            shortcut => KeyboardShortcut.subscribe(
+                shortcut.shortcutKey,
+                () => {}, // do nothing
+                shortcut.descriptionKey,
+                shortcut.modifiers,
+                false,
+                () => lodashGet(this.props.plaidData, 'bankAccounts', []).length > 0, // start bubbling when there are bank accounts
+            ),
+        );
+        this.subscribedKeyboardShortcuts = unsubscribeCallbacks;


NAB: no need to define unsubscribeCallbacks variable. set to this.subscribedKeyboardShortcuts directly

Done @0xmiroslav

0xmiros · 2023-05-08T17:13:12Z

@huzaifa-99 please merge main

…d-before-plaid

huzaifa-99 · 2023-05-08T17:18:14Z

@0xmiroslav main merged

src/CONST.js

0xmiros

Looks good. Checklisting

0xmiros · 2023-05-08T19:43:57Z

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 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

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop1.mov

desktop2.mov

iOS

ios.mov

Android

android.mov

0xmiros · 2023-05-08T19:44:32Z

@aldo-expensify over to you!

aldo-expensify · 2023-05-08T22:43:51Z

@huzaifa-99 I think you may need to pull main again. The unit tests are still failing.

aldo-expensify

Worked well for me.

Added testing instructions for the VBBA flow.

@huzaifa-99 , you will need to update from main again to fix the tests.

…d-before-plaid

huzaifa-99 · 2023-05-09T03:08:55Z

@aldo-expensify Main merged. Tests are also passing

…d-before-plaid

aldo-expensify · 2023-05-09T04:15:56Z

Thanks @huzaifa-99 !

OSBotify · 2023-05-09T04:22:39Z

✋ 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-05-11T02:44:24Z

🚀 Deployed to staging by https://github.com/aldo-expensify in version: 1.3.13-0 🚀

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

OSBotify · 2023-05-15T08:25:39Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.13-5 🚀

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

Block navigation shortcuts when plaid modal is loading

6d3b74c

huzaifa-99 requested a review from a team as a code owner May 5, 2023 00:23

melvin-bot bot requested review from 0xmiros and aldo-expensify and removed request for a team May 5, 2023 00:23

huzaifa-99 added 3 commits May 5, 2023 06:17

Fixed lint issues

3d14b7a

Fix lint issues

28c7e9c

Fix lint issues

18420e3

huzaifa-99 mentioned this pull request May 5, 2023

[HOLD for payment 2023-05-22] [$1000] Infinite loading when returning back from Plaid if user hits CTRL+SHIFT+K before the Plaid page opens up #17598

Closed

6 tasks

aldo-expensify reviewed May 5, 2023

View reviewed changes

huzaifa-99 added 3 commits May 5, 2023 20:38

Removed empty type strings for keyboard shortcut consts

c29e02d

Listen to navigation key shortcuts in component mount lifecycle

61590d3

Fix lint issues

4356b3c

0xmiros reviewed May 8, 2023

View reviewed changes

Updated comment

726095b

huzaifa-99 requested a review from 0xmiros May 8, 2023 12:00

0xmiros reviewed May 8, 2023

View reviewed changes

Removed extra failsafe

ae1c69e

0xmiros reviewed May 8, 2023

View reviewed changes

huzaifa-99 added 2 commits May 8, 2023 22:16

Removed extra variable assignment

a07dbc9

Merge branch 'Expensify:main' into fix-infinite-loading-when-navigate…

a7a4f41

…d-before-plaid

huzaifa-99 requested a review from 0xmiros May 8, 2023 17:17

aldo-expensify reviewed May 8, 2023

View reviewed changes

src/CONST.js Show resolved Hide resolved

aldo-expensify reviewed May 8, 2023

View reviewed changes

src/CONST.js Show resolved Hide resolved

huzaifa-99 requested a review from aldo-expensify May 8, 2023 17:45

0xmiros approved these changes May 8, 2023

View reviewed changes

aldo-expensify approved these changes May 9, 2023

View reviewed changes

Merge branch 'Expensify:main' into fix-infinite-loading-when-navigate…

ceb5661

…d-before-plaid

Merge branch 'Expensify:main' into fix-infinite-loading-when-navigate…

fc7666a

…d-before-plaid

aldo-expensify merged commit 144979b into Expensify:main May 9, 2023

OSBotify mentioned this pull request May 11, 2023

Deploy Checklist: New Expensify 2023-05-11 #18764

Closed

51 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Block navigation shortcuts when plaid modal is loading/shown #18462

Block navigation shortcuts when plaid modal is loading/shown #18462

huzaifa-99 commented May 5, 2023 •

edited by aldo-expensify

Loading

melvin-bot bot commented May 5, 2023

huzaifa-99 commented May 5, 2023

aldo-expensify May 5, 2023

huzaifa-99 May 5, 2023

huzaifa-99 May 8, 2023

0xmiros May 8, 2023

0xmiros May 8, 2023

huzaifa-99 May 8, 2023 •

edited

Loading

0xmiros May 8, 2023

huzaifa-99 May 8, 2023

0xmiros May 8, 2023

huzaifa-99 May 8, 2023

0xmiros May 8, 2023

huzaifa-99 May 8, 2023

0xmiros commented May 8, 2023

huzaifa-99 commented May 8, 2023

0xmiros left a comment

0xmiros commented May 8, 2023

0xmiros commented May 8, 2023

aldo-expensify commented May 8, 2023

aldo-expensify left a comment

huzaifa-99 commented May 9, 2023

aldo-expensify commented May 9, 2023

OSBotify commented May 9, 2023

OSBotify commented May 11, 2023

OSBotify commented May 15, 2023

Block navigation shortcuts when plaid modal is loading/shown #18462

Block navigation shortcuts when plaid modal is loading/shown #18462

Conversation

huzaifa-99 commented May 5, 2023 • edited by aldo-expensify Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 5, 2023

huzaifa-99 commented May 5, 2023

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

huzaifa-99 May 8, 2023 • edited Loading

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

0xmiros commented May 8, 2023

huzaifa-99 commented May 8, 2023

0xmiros left a comment

Choose a reason for hiding this comment

0xmiros commented May 8, 2023

Reviewer Checklist

Screenshots/Videos

0xmiros commented May 8, 2023

aldo-expensify commented May 8, 2023

aldo-expensify left a comment

Choose a reason for hiding this comment

huzaifa-99 commented May 9, 2023

aldo-expensify commented May 9, 2023

OSBotify commented May 9, 2023

OSBotify commented May 11, 2023

OSBotify commented May 15, 2023

huzaifa-99 commented May 5, 2023 •

edited by aldo-expensify

Loading

huzaifa-99 May 8, 2023 •

edited

Loading