[QBO Export] feat: handling auto-sync errors #45251

kosmydel · 2024-07-11T11:20:21Z

Details

This PR adds:

handling auto-sync errors,
the ability to enter credentials when we got logged out from integration.

To enter the credentials I also refactor the integration buttons:

buttons are extracted from the connection components,
buttons are renamed: ConnectToSageIntacctButton -> ConnectToSageIntacctFlow,
a new context AccountingContext is added to run the integration flows centrally,
the redirection to upgrade to the control policy screen is now added in the new context,
the AccountingConnectionConfirmationModal is now displayed in the context.

Reconnecting on mWeb iOS might not work due to this bug.

Fixed Issues

$ #44016
PROPOSAL: N/A

Tests

Note

The modal animation doesn't work on the Dev environment with Strict Mode. Disable it in CONFIG.ts by settings USE_REACT_STRICT_MODE to false.

Prerequisites

Collect workspace with an admin and member
Setup QBO (Xero) integration connection

Steps

Log into QBO (Xero) and disconnect the Expensify app: Menu > Apps > Overview > Expensify 3-dot menu > Disconnect (Xero: 9 dots menu > Manage app connections -> Disconnect)
Log into NewDot as the admin
Verify there's an RBR on the path: Avatar > Workspaces > [Workspace name] > Accounting > QBO (Xero)
Verify a red error message appears on the connection explaining the issue
Select QBO's (Xero's) 3-dot menu
Verify there’s a “Enter credentials” option
Select “Enter credentials”
Verify a new window opens to log into QBO (Xero)

Change integration

Go to Accounting settings.
Open Other integrations.
Press connect.
Verify there is a confirmation modal.
Verify the flow is running correctly after pressing Confirm.

Verify new integration connection
All Connect buttons and integration flows were refactored. Verify that it is possible to add each integration:

quickbooksOnline,
xero,
netsuite (set canUseNetSuiteIntegration to true),
intact (set canUseSageIntacctIntegration to true).

Verify reusing connections
Do the steps from this PR

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console
Do the tests from the above list

PR Author Checklist

Screenshots/Videos

Android: Native

android-native.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

Xero:

web.mov

All Connect buttons:

Screen.Recording.2024-07-15.at.16.26.58.mov

MacOS: Desktop

desktop.mov

src/pages/workspace/accounting/PolicyAccountingPage.tsx

melvin-bot · 2024-07-15T14:37:57Z

@ishpaul777 @arosiclair 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]

kosmydel · 2024-07-15T14:40:05Z

On mWeb iOS opening reconnecting the integration might not work yet, there will be a separate issue. More details.

trjExpensify · 2024-07-15T15:17:54Z

@hungvu193 can you take the review of this one with the context on the project? Thanks!

hungvu193 · 2024-07-15T15:18:51Z

Sure thing. Please assign me to this PR. Thank you

ishpaul777 · 2024-07-15T15:28:18Z

Please remove my assignment once @hungvu193 is assiged, Thanks!

hungvu193 · 2024-07-16T07:53:10Z

I got this issue while testing and it worked after I refreshed the page few times.

Screen.Recording.2024-07-16.at.14.51.29.mov

arosiclair · 2024-08-13T15:36:49Z

Found an issue, where the error briefly showed after reconnecting from QBO @war-in

I noticed this while testing as well. There's a delay between IS pushing the last progress update and the final update that sets lastSync.isSuccessful. Let's not block on that problem.

On IOS, pressing Enter credentials doesn't open webview.

I think this should've been fixed by #45762. That's still not the case? cc @zfurtak

On Desktop, I don't see the reconnecting progress after reconnecting is completed.

Is this not an issue on other platforms? I'm actually not sure if the sync should automatically restart after reconnecting.

zfurtak · 2024-08-13T15:42:57Z

On IOS, pressing Enter credentials doesn't open webview.

I think this should've been fixed by #45762. That's still not the case? cc @zfurtak

That's true! 👍

hungvu193 · 2024-08-13T15:49:38Z

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

Screen.Recording.2024-08-13.at.22.57.46.mov

Android: mWeb Chrome

Screen.Recording.2024-08-13.at.11.05.36.mov

iOS: Native

Screen.Recording.2024-08-13.at.22.24.53.mov

iOS: mWeb Safari

safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-08-13.at.09.45.54.mov

MacOS: Desktop

Uploading Screen Recording 2024-08-13 at 22.46.00.mov…

hungvu193

Let's remove these console log 😄

hungvu193 · 2024-08-13T15:54:39Z

src/pages/workspace/accounting/AccountingContext.tsx

+    );
+
+    const renderActiveIntegration = () => {
+        console.log('rerender');


Suggested change

console.log('rerender');

hungvu193 · 2024-08-13T15:54:56Z

src/pages/workspace/accounting/AccountingContext.tsx

+
+    const renderActiveIntegration = () => {
+        console.log('rerender');
+        console.log('activeIntegration', activeIntegration);


Suggested change

console.log('activeIntegration', activeIntegration);

hungvu193 · 2024-08-13T15:55:23Z

Is this not an issue on other platforms? I'm actually not sure if the sync should automatically restart after reconnecting.

After re-enter credentials successfully, if I click on Open electron app desktop app will reload and it will work, if I didn't click on it, the connection progress won't be updated. Is that expected?

Screen.Recording.2024-08-13.at.22.46.00.mov

arosiclair · 2024-08-13T16:12:43Z

Is this not an issue on other platforms? I'm actually not sure if the sync should automatically restart after reconnecting.

After re-enter credentials successfully, if I click on Open electron app desktop app will reload and it will work, if I didn't click on it, the connection progress won't be updated. Is that expected?

I don't think you should expect any progress updates while logging into QBO if that's what you mean. Progress should start after you logged into QBO successfully. Either way, the progress updates are separate from the error handling we're focusing on so let's treat that as a separate issue.

hungvu193 · 2024-08-13T16:19:02Z

I see. Then I think there's only linting left and it will be ready for your final review.

war-in · 2024-08-13T16:50:01Z

@hungvu193 Logs removed! Sorry for that 😅

…rors # Conflicts: # src/components/ConnectToQuickbooksOnlineButton/index.native.tsx # src/components/ConnectToQuickbooksOnlineButton/index.tsx

src/libs/actions/connections/index.ts

src/pages/workspace/accounting/AccountingContext.tsx

src/pages/workspace/accounting/utils.tsx

arosiclair

Looks pretty good overall just a few questions

arosiclair · 2024-08-14T19:15:00Z

src/pages/workspace/accounting/AccountingContext.tsx

+};
+
+function AccountingContextProvider({children, policy}: AccountingContextProviderProps) {
+    const integrationRefs = useRef<Record<string, MutableRefObject<View | null>>>(defaultAccountingContext.integrationRefs.current);


Can you help me understand how we're using integrationRefs? I see it initialized with integrationRefsInitialValue but I don't see where it's updated.

We're changing integration refs in PolicyAccountingPage to pass the position of the threeDotsMenuContainer button to be able to show modal in the correct place

Oh okay I see the name changed to integrationsRef in that file. Lets rename that to popoverAnchorRefs to be a bit more clear. And let's keep the naming consistent in every file.

src/pages/workspace/accounting/AccountingContext.tsx

arosiclair · 2024-08-19T15:52:15Z

src/pages/workspace/accounting/AccountingContext.tsx

+};
+
+function AccountingContextProvider({children, policy}: AccountingContextProviderProps) {
+    const integrationRefs = useRef<Record<string, MutableRefObject<View | null>>>(defaultAccountingContext.integrationRefs.current);


Oh okay I see the name changed to integrationsRef in that file. Lets rename that to popoverAnchorRefs to be a bit more clear. And let's keep the naming consistent in every file.

…rors # Conflicts: # src/pages/workspace/accounting/PolicyAccountingPage.tsx

war-in · 2024-08-19T16:54:35Z

@arosiclair Comment addressed and conflicts resolved 🫡

war-in · 2024-08-20T09:15:48Z

@arosiclair Are we ready for the merge? Or is there something I need to do here? 🤔

arosiclair · 2024-08-20T14:02:35Z

Nope just got distracted 😄

OSBotify · 2024-08-20T14:21:23Z

✋ 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-08-20T22:58:13Z

🚀 Deployed to staging by https://github.com/arosiclair in version: 9.0.23-0 🚀

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

OSBotify · 2024-08-22T17:11:36Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 9.0.23-0 🚀

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

feat: display RBR for auto-sync errors

233a37a

kosmydel force-pushed the @kosmydel/qbo-export/auto-sync-errors branch from 8ba55ba to 5ba1348 Compare July 11, 2024 12:31

feat: reconnect integrations

43e5fe1

kosmydel force-pushed the @kosmydel/qbo-export/auto-sync-errors branch from 5ba1348 to 43e5fe1 Compare July 11, 2024 12:46

lakchote mentioned this pull request Jul 15, 2024

[HOLD #44016] [Xero Export] Display Xero auto-sync errors and RBRs in NewDot #45138

Closed

kosmydel added 3 commits July 15, 2024 09:21

refactor: add AccountingContext

0fecab4

Merge branch 'main' into @kosmydel/qbo-export/auto-sync-errors

4c5e3fd

fix

06b87f7

kosmydel changed the title ~~feat: handling auto-sync errors~~ [QBO Export] feat: handling auto-sync errors Jul 15, 2024

kosmydel added 2 commits July 15, 2024 11:03

refactor: move context

300be83

refactor: rename buttons to flows

1c7f281

kosmydel force-pushed the @kosmydel/qbo-export/auto-sync-errors branch from 6ade96e to 1c7f281 Compare July 15, 2024 09:12

cleanup

176954e

SzymczakJ reviewed Jul 15, 2024

View reviewed changes

src/pages/workspace/accounting/PolicyAccountingPage.tsx Outdated Show resolved Hide resolved

address internal review

5ebb813

kosmydel requested a review from SzymczakJ July 15, 2024 14:33

kosmydel marked this pull request as ready for review July 15, 2024 14:37

kosmydel requested a review from a team as a code owner July 15, 2024 14:37

melvin-bot bot requested review from arosiclair and ishpaul777 and removed request for a team and SzymczakJ July 15, 2024 14:37

trjExpensify requested review from hungvu193 and removed request for ishpaul777 July 15, 2024 15:34

hungvu193 reviewed Aug 13, 2024

View reviewed changes

fix lint

45ebd52

hungvu193 approved these changes Aug 13, 2024

View reviewed changes

melvin-bot bot requested a review from arosiclair August 13, 2024 17:01

war-in added 2 commits August 14, 2024 10:14

Merge branch 'refs/heads/main' into @kosmydel/qbo-export/auto-sync-er…

34368ae

…rors # Conflicts: # src/components/ConnectToQuickbooksOnlineButton/index.native.tsx # src/components/ConnectToQuickbooksOnlineButton/index.tsx

post-merge fixes

5058706

arosiclair requested changes Aug 14, 2024

View reviewed changes

arosiclair reviewed Aug 14, 2024

View reviewed changes

review comment

55881cf

arosiclair requested changes Aug 19, 2024

View reviewed changes

war-in added 2 commits August 19, 2024 18:43

Merge branch 'refs/heads/main' into @kosmydel/qbo-export/auto-sync-er…

3143a3a

…rors # Conflicts: # src/pages/workspace/accounting/PolicyAccountingPage.tsx

rename integrationRefs

451bb3d

arosiclair approved these changes Aug 19, 2024

View reviewed changes

arosiclair merged commit c62f29f into Expensify:main Aug 20, 2024
15 checks passed

arosiclair mentioned this pull request Aug 20, 2024

[HOLD for payment 2024-08-29] [QBO Export] [$250] Display QBO auto-sync errors and RBRs in NewDot #44016

Closed

github-actions bot mentioned this pull request Aug 20, 2024

Deploy Checklist: New Expensify 2024-08-20 #47760

Closed

38 tasks

lanitochka17 mentioned this pull request Aug 21, 2024

mWeb - QBO - Red dot path by disconnecting qbo/xero cannot be created #47807

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[QBO Export] feat: handling auto-sync errors #45251

[QBO Export] feat: handling auto-sync errors #45251

kosmydel commented Jul 11, 2024 •

edited

Loading

melvin-bot bot commented Jul 15, 2024

kosmydel commented Jul 15, 2024

trjExpensify commented Jul 15, 2024

hungvu193 commented Jul 15, 2024

ishpaul777 commented Jul 15, 2024

hungvu193 commented Jul 16, 2024

arosiclair commented Aug 13, 2024

zfurtak commented Aug 13, 2024

hungvu193 commented Aug 13, 2024 •

edited

Loading

hungvu193 left a comment

hungvu193 Aug 13, 2024

hungvu193 Aug 13, 2024

hungvu193 commented Aug 13, 2024

arosiclair commented Aug 13, 2024

hungvu193 commented Aug 13, 2024

war-in commented Aug 13, 2024

arosiclair left a comment

arosiclair Aug 14, 2024

war-in Aug 19, 2024

arosiclair Aug 19, 2024

arosiclair Aug 19, 2024

war-in commented Aug 19, 2024

war-in commented Aug 20, 2024

arosiclair commented Aug 20, 2024

OSBotify commented Aug 20, 2024

OSBotify commented Aug 20, 2024

OSBotify commented Aug 22, 2024

[QBO Export] feat: handling auto-sync errors #45251

[QBO Export] feat: handling auto-sync errors #45251

Conversation

kosmydel commented Jul 11, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 15, 2024

kosmydel commented Jul 15, 2024

trjExpensify commented Jul 15, 2024

hungvu193 commented Jul 15, 2024

ishpaul777 commented Jul 15, 2024

hungvu193 commented Jul 16, 2024

arosiclair commented Aug 13, 2024

zfurtak commented Aug 13, 2024

hungvu193 commented Aug 13, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

hungvu193 left a comment

Choose a reason for hiding this comment

hungvu193 Aug 13, 2024

Choose a reason for hiding this comment

hungvu193 Aug 13, 2024

Choose a reason for hiding this comment

hungvu193 commented Aug 13, 2024

arosiclair commented Aug 13, 2024

hungvu193 commented Aug 13, 2024

war-in commented Aug 13, 2024

arosiclair left a comment

Choose a reason for hiding this comment

arosiclair Aug 14, 2024

Choose a reason for hiding this comment

war-in Aug 19, 2024

Choose a reason for hiding this comment

arosiclair Aug 19, 2024

Choose a reason for hiding this comment

arosiclair Aug 19, 2024

Choose a reason for hiding this comment

war-in commented Aug 19, 2024

war-in commented Aug 20, 2024

arosiclair commented Aug 20, 2024

OSBotify commented Aug 20, 2024

OSBotify commented Aug 20, 2024

OSBotify commented Aug 22, 2024

kosmydel commented Jul 11, 2024 •

edited

Loading

hungvu193 commented Aug 13, 2024 •

edited

Loading