Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

handle offline mode for bank connection #55338

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

huult
Copy link
Contributor

@huult huult commented Jan 16, 2025

Details

Fixed Issues

$ #55096
PROPOSAL: #55096 (comment)

Tests

Same QA step

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Navigate to Workspace Settings and enable Company Cards.
  2. Click Add Cards and select any bank.
  3. Choose Direct as the connection method and go offline.
  4. Click the Next button.
  5. Verify that the application displays the Offline Page for bank connection.
  6. Reconnect to the internet and ensure the application resumes normal functionality.

and

  1. When trying to assign a card on a direct feed specifically.
  2. Verify that the Assign Card button in the modal for direct feeds is disabled when offline.
  • 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
Screen.Recording.2025-01-16.at.10.33.06.mp4
Android: mWeb Chrome
Screen.Recording.2025-01-16.at.10.34.47.mp4
iOS: Native
Screen.Recording.2025-01-16.at.10.37.45.mp4
iOS: mWeb Safari
Screen.Recording.2025-01-16.at.10.38.51.mp4
MacOS: Chrome / Safari
Screen.Recording.2025-01-16.at.10.39.27.mp4
MacOS: Desktop
Screen.Recording.2025-01-16.at.10.40.46.mp4

@huult huult requested a review from a team as a code owner January 16, 2025 03:48
@melvin-bot melvin-bot bot requested review from rojiphil and removed request for a team January 16, 2025 03:48
Copy link

melvin-bot bot commented Jan 16, 2025

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

@rojiphil
Copy link
Contributor

the Assign card button in modal for direct feeds should be disabled when offline.

@huult Is the above implemented?

Also, there are conflicts to be addressed. Please resolve them too. Thanks.

@huult
Copy link
Contributor Author

huult commented Jan 19, 2025

I will update it tomorrow

Copy link
Contributor

🚧 @mountiny has triggered a test build. You can view the workflow run here.

Copy link
Contributor

Copy link
Contributor

@rojiphil rojiphil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@huult I have left just one comment. Otherwise, code LGTM. Please have a look. Thanks.

@rojiphil
Copy link
Contributor

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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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

MacOS: Chrome / Safari
55338-web-safari-001.mp4
MacOS: Desktop
55338-desktop-001.mp4
Android: Native
55338-android-native-001.mp4
Android: mWeb Chrome
55338-mweb-chrome-001.mp4
iOS: Native
55338-ios-native-001.mp4
iOS: mWeb Safari
55338-mweb-mweb-safari-001.mp4

Copy link
Contributor

@rojiphil rojiphil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @huult for the updates.

@mountiny Changes LGTM and works well too.
All yours for review. Thanks.

@@ -36,7 +38,7 @@ function WorkspaceCompanyCardsFeedAddedEmptyPage({handleAssignCard, isDisabledAs
buttonAction: handleAssignCard,
icon: Expensicons.Plus,
success: true,
isDisabled: isDisabledAssignCardButton,
isDisabled: isOffline || isDisabledAssignCardButton,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@huult is this for both direct and custom feeds? this change should only be for direct feeds because only then we might be opening the popuo window

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops! I missed interpreting the expectation correctly here. Thanks for pointing out.

On thinking further, I am not that sure if we would get an empty page for direct feeds. If the empty cards page is not applicable for direct feeds, no changes are needed here. But looks like some more understanding is needed here.

And it looks like we may have to make changes in the header buttons here by considering isOffline and isCustomFeed

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On thinking further, I am not that sure if we would get an empty page for direct feeds. If the empty cards page is not applicable for direct feeds, no changes are needed here. But looks like some more understanding is needed here.

Feed added empty state can occur for direct feeds also. The test video in OP also demonstrates this. So, we need to disable Assign card here only for Direct feed.

And it looks like we may have to make changes in the header buttons here by considering isOffline and isCustomFeed

I think no change has to be made to the Assign card button in the card list header.
@mountiny Is this understanding correct?

@mountiny
Copy link
Contributor

@joekaufmanexpensify @dubielzyk-expensify curious for your take on this one. We have 3 cases in this flow to consider:

  • connecting a new direct feed when you are offline - we can show the offline blocking pattern fine and we dont have to block the button
  • existing feed is connected:
    • the connection is not expired, you should be able to assign cards but you are offline - clicking the Assign Card button can be allowed and we show user the blocking offline page
    • the connection is expired, so clicking assign card would immediately open the window popup if online. However, when you are online, it does not make sense to open the RHP with offline information - it makes sense to disable the assign card button when offline and the connection is expired.

Do you agree with the last case? Is it ok to just make the button disabled in this case when offline?

@joekaufmanexpensify
Copy link
Contributor

Yep, those all make sense to me. No need to allow clicking to assign a card offline if that is just going to prompt you to connect to your bank (which you cannot do while offline).

@dubielzyk-expensify
Copy link
Contributor

All those scenarios sound reasonable to me. I don't mind throwing up a Offline RHP on the last scenario though cause at least it's telling you why you can't click the button instead of just disabling it.

cc @Expensify/design and Offline Expert @trjExpensify

@trjExpensify
Copy link
Contributor

the connection is expired, so clicking assign card would immediately open the window popup if online. However, when you are online, it does not make sense to open the RHP with offline information - it makes sense to disable the assign card button when offline and the connection is expired.

Just so I'm sure I'm following your thoughts..

When you're online, if your connection has expired, clicking Assign new card throws an alert modal to say "Yo, this feed is broken, fix it.".

So the consideration here is that when you're offline, we don't know if your feed is broken or not (?), so if we let you click the button and open the RHP with the offline blocking form. If you come back online with it open, you shouldn't be seeing the actual contents of that page because of your broken connection, so now we're in a bit of a pickle because we let you open the RHP offline?

@joekaufmanexpensify
Copy link
Contributor

When you're online, if your connection has expired, clicking Assign new card throws an alert modal to say "Yo, this feed is >broken, fix it.".

So the consideration here is that when you're offline, we don't know if your feed is broken or not (?), so if we let you click >the button and open the RHP with the offline blocking form. If you come back online with it open, you shouldn't be seeing >the actual contents of that page because of your broken connection, so now we're in a bit of a pickle because we let you >open the RHP offline?

This is just about credentials expired, which is different from broken connection. The former happens in the ordinary course of business. Most bank credentials expire after ~15 minutes and transactions still import after the credentials expire. We don't show an error here, we just prompt the customer to authenticate with their bank before they can assign more cards.

We do know if their credentials are expired before they click assign card. If their credentials are expired and they're offline, we don't want to let them start the assign card flow because the first step will be linking them to connect to their bank (which can't be done offline).

Broken connection is more rare and happens when there is an actual issue with the connection. There we throw an error to authenticate the connection and explain why transactions are not importing. I imagine fixing the broken connection error offline would be similar, where we disable the button to log into your bank.

LMK if that makes sense @trjExpensify

@trjExpensify
Copy link
Contributor

We do know if their credentials are expired before they click assign card. If their credentials are expired and they're offline, we don't want to let them start the assign card flow because the first step will be linking them to connect to their bank (which can't be done offline).

Got it, so clicking Assign new card executes the check, and either opens the Plaid modal to reconnect if they've expired, or allows them to proceed to assign a card if not?

If so, then I think the offline alert modal can be used here -- like clicking Download on the Reports page when offline:

image

@joekaufmanexpensify
Copy link
Contributor

I'm good with that too. I wasn't aware we had that existing component.

@mountiny
Copy link
Contributor

I like the offline alert modal. @huult could you please use that? Is everything clear?

@huult
Copy link
Contributor Author

huult commented Jan 26, 2025

@mountiny When we are in offline mode and click ‘Assign Card,’ does the offline alert modal appear as shown in the video below?

Screen.Recording.2025-01-26.at.22.13.35.mov

@trjExpensify
Copy link
Contributor

We use the standard button colour in the Download case, not the green colour. I expect we want the same here, @Expensify/design?

@dannymcclain
Copy link
Contributor

We use the standard button colour in the Download case, not the green colour. I expect we want the same here, @Expensify/design?

I thought we decided when there is only one button (ie Got it) in a modal, we would always use the green button? Am I misremembering something?

@trjExpensify
Copy link
Contributor

No idea! If we do, let's update the Offline button in download haha.

@shawnborton
Copy link
Contributor

That sounds reasonable to me. It also seems like the button isn't using the right size here, it should be a large button.

@mountiny
Copy link
Contributor

Would anyone be able to summarize the requested changes for @huult to implement please?

I assume if we want to change the default modal look that could be done in a separate PR as its not related to this one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants