[QBD] Handle the syncing for QBD #50500

hoangzinh · 2024-10-09T13:00:37Z

Details

Fixed Issues

$ #49698
PROPOSAL:

Tests

Same as Tests

Verify that no errors appear in the JS console

Offline tests

Can't test when offline

QA Steps

Prerequisites: Turn on Beta quickbooksDesktopOnNewDot on your account

In Web/Desktop

Sign in on an account that enabled beta quickbooksDesktopOnNewDot
Go to any Workspace -> Accounting
Click on "Connect" button next to "Quickbooks Desktop" integration
Click on "Done" button on "QuickBooks Desktop setup" page
Verify that it starts to sync data from QBD
Verify that after a few seconds, it shows a connection error
Click on three-dot menu on the right of "Quickbooks Desktop" integration
Verify it shows "Reinstall connector" menu
Click on "Reinstall connector" menu
Verify it opens QuickBooks Desktop setup page
Follow steps here
Back to ND, click on "Done" button on "QuickBooks Desktop setup" page
Verify that it syncs data successfully from QBD

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

N/A

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

Screen.Recording.2024-10-17.at.22.36.42.web.part.1.mov

Screen.Recording.2024-10-17.at.22.34.57.web.part.2.mov

MacOS: Desktop

Screen.Recording.2024-10-17.at.22.40.02.desktop.part.1.mov

Screen.Recording.2024-10-17.at.23.11.04.desktop.part.2.mov

hoangzinh · 2024-10-11T16:34:21Z

@lakchote It's an edge case but behavior is different between OldDot and ND.

In OD, on the setup link screen, if user does nothing and clicks "done", it will show an error message
In ND, on the setup link screen, if user does nothing and clicks "done", it shows sync statues then not show error messages

Screen.Recording.2024-10-11.at.23.29.28.mov

Onyx data:

lakchote · 2024-10-14T07:43:24Z

@hoangzinh

You should show an error message: Could not retrieve data from QuickBooks Desktop.

You can check for this error, by verifying if !lastSync.isConnected.

We should not display Last synced if in fact the user is not connected to QBD.

hoangzinh · 2024-10-14T11:20:09Z

@hoangzinh

You should show an error message: Could not retrieve data from QuickBooks Desktop.

You can check for this error, by verifying if !lastSync.isConnected.

We should not display Last synced if in fact the user is not connected to QBD.

I don't think it's the right direction @lakchote. The initial state of lastSync.isConnected is always false after user taps on "Connect" button on the right of QBD.

Screen.Recording.2024-10-14.at.18.17.29.mov

Based on the function to get sync error here, I think BE should return errorDate and errorMessage in this case

App/src/pages/workspace/accounting/utils.tsx

Lines 302 to 306 in 1535588

    
           if (isSyncInProgress || isEmptyObject(connection?.lastSync) || connection?.lastSync?.isSuccessful !== false || !connection?.lastSync?.errorDate) { 
        
               return; 
        
           } 
        
           return `${syncError} ("${connection?.lastSync?.errorMessage}")`;

lakchote · 2024-10-14T14:03:30Z

@hoangzinh I've raised a PR so the backend properly sets the error message.

hoangzinh · 2024-10-14T15:24:11Z

Thanks @lakchote.

hoangzinh · 2024-10-14T16:00:49Z

src/languages/es.ts

+                        case 'startingImportQBD':
+                        case 'quickbooksDesktopImportMore':
+                            return 'Importando datos desde QuickBooks Desktop';
+                        case 'quickbooksDesktopImportTitle':
+                            return 'Importando título';
+                        case 'quickbooksDesktopImportApproveCertificate':
+                            return 'Importando certificado de aprobación';
+                        case 'quickbooksDesktopImportDimensions':
+                            return 'Importando dimensiones';
+                        case 'quickbooksDesktopImportSavePolicy':
+                            return 'Importando política de guardado';
+                        case 'quickbooksDesktopWebConnectorReminder':
+                            return 'Aún sincronizando datos con QuickBooks... Por favor, asegúrate de que el Conector Web esté en funcionamiento';


Confirmed here https://expensify.slack.com/archives/C01GTK53T8Q/p1728645127772369

lakchote · 2024-10-15T06:17:57Z

@hoangzinh I've raised a PR so the backend properly sets the error message.

@hoangzinh it should be good now, can you test it?

hoangzinh · 2024-10-15T09:10:16Z

It doesn't work @lakchote. I tried to use the staging server, but Pusher event or API didn't return errorDate and errorMessage

Screen.Recording.2024-10-15.at.16.07.28.mov

lakchote · 2024-10-16T12:37:23Z

It doesn't work @lakchote. I tried to use the staging server, but Pusher event or API didn't return errorDate and errorMessage

I've taken a look yesterday and today. I'm currently investigating on the best way to approach this.

lakchote · 2024-10-17T09:11:55Z

Pinging you here @hoangzinh to retest in case you've missed my notifications on NewDot.

lakchote · 2024-10-17T09:15:30Z

Okay, I've retested it on my own and it seems to work well @francoisl:

Screen.Recording.2024-10-17.at.11.14.07.mov

melvin-bot · 2024-10-17T16:12:53Z

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

hoangzinh · 2024-10-17T16:13:46Z

Sorry @suneox. This PR will be reviewed by @ZhenjaHorbach and @lakchote. This is included in the QBD project

ZhenjaHorbach · 2024-10-17T16:19:40Z

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

NA

Android: mWeb Chrome

NA

iOS: Native

NA

iOS: mWeb Safari

NA

MacOS: Chrome / Safari

Error:

web-error.mov

Success:

web-done.mov

MacOS: Desktop

Error:

2024-10-18.13.46.20.mov

Success:

2024-10-18.13.49.14.mov

src/libs/actions/connections/index.ts

ZhenjaHorbach · 2024-10-17T17:07:22Z

if an user is offline
I think the user should not be able to reinstall connector

CC: @lakchote

hoangzinh · 2024-10-17T17:14:58Z

if the user is offline
I think he should not be able to reinstall connector

Agreed. I updated in this commit dc7a92a

ZhenjaHorbach · 2024-10-18T11:55:58Z

Everything seems to be working good !

OSBotify · 2024-10-18T12:34:16Z

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

github-actions · 2024-10-18T19:04:42Z

🚀 Deployed to staging by https://github.com/lakchote in version: 9.0.51-1 🚀

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

github-actions · 2024-10-22T04:37:58Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.51-4 🚀

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

github-actions · 2024-10-22T17:20:22Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.51-4 🚀

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

hoangzinh added 3 commits October 11, 2024 17:16

Trigger first QBD sync

f78f931

Display reinstall connector

cdca828

Add QBD sync stages

20c480b

hoangzinh force-pushed the 49698-handle-syncing-for-QBD-connection branch from 97f6bd0 to 20c480b Compare October 11, 2024 10:32

hoangzinh added 2 commits October 11, 2024 17:56

Fix eslint warning

f9f1b47

Add stage web connector reminder

3ca04c7

Merge branch 'main' into 49698-handle-syncing-for-QBD-connection

849ab81

Add type SyncPolicyToQuickbooksDesktopParams

1bac064

hoangzinh commented Oct 14, 2024

View reviewed changes

Merge branch 'main' into 49698-handle-syncing-for-QBD-connection

369c38f

hoangzinh added 4 commits October 17, 2024 16:50

Merge branch 'main' into 49698-handle-syncing-for-QBD-connection

9760f73

Revert change

931ca11

Revert change of sync now button

7910f90

Fix EOF

a5a1003

hoangzinh marked this pull request as ready for review October 17, 2024 16:12

hoangzinh requested a review from a team as a code owner October 17, 2024 16:12

melvin-bot bot requested review from suneox and removed request for a team October 17, 2024 16:12

ZhenjaHorbach reviewed Oct 17, 2024

View reviewed changes

src/libs/actions/connections/index.ts Show resolved Hide resolved

Disable reinstall button when offline

dc7a92a

ZhenjaHorbach approved these changes Oct 18, 2024

View reviewed changes

melvin-bot bot requested a review from lakchote October 18, 2024 11:56

lakchote approved these changes Oct 18, 2024

View reviewed changes

lakchote merged commit 1e81aa8 into Expensify:main Oct 18, 2024
17 checks passed

github-actions bot mentioned this pull request Oct 18, 2024

Deploy Checklist: New Expensify 2024-10-18 #51106

Closed

59 tasks

melvin-bot bot mentioned this pull request Oct 22, 2024

[HOLD for payment 2024-10-29] [Wave Control] [QBD] Handle the syncing for QBD #49698

Closed

hoangzinh mentioned this pull request Nov 4, 2024

[QBD] Handle errors gracefully if the setup link cannot be obtained #51850

Merged

49 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[QBD] Handle the syncing for QBD #50500

[QBD] Handle the syncing for QBD #50500

hoangzinh commented Oct 9, 2024 •

edited

Loading

hoangzinh commented Oct 11, 2024

lakchote commented Oct 14, 2024 •

edited

Loading

hoangzinh commented Oct 14, 2024

lakchote commented Oct 14, 2024

hoangzinh commented Oct 14, 2024

hoangzinh Oct 14, 2024

lakchote commented Oct 15, 2024

hoangzinh commented Oct 15, 2024

lakchote commented Oct 16, 2024 •

edited

Loading

lakchote commented Oct 17, 2024

lakchote commented Oct 17, 2024

melvin-bot bot commented Oct 17, 2024

hoangzinh commented Oct 17, 2024

ZhenjaHorbach commented Oct 17, 2024 •

edited

Loading

ZhenjaHorbach commented Oct 17, 2024 •

edited

Loading

hoangzinh commented Oct 17, 2024

ZhenjaHorbach commented Oct 18, 2024

OSBotify commented Oct 18, 2024

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 22, 2024

github-actions bot commented Oct 22, 2024

[QBD] Handle the syncing for QBD #50500

[QBD] Handle the syncing for QBD #50500

Conversation

hoangzinh commented Oct 9, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

hoangzinh commented Oct 11, 2024

lakchote commented Oct 14, 2024 • edited Loading

hoangzinh commented Oct 14, 2024

lakchote commented Oct 14, 2024

hoangzinh commented Oct 14, 2024

hoangzinh Oct 14, 2024

Choose a reason for hiding this comment

lakchote commented Oct 15, 2024

hoangzinh commented Oct 15, 2024

lakchote commented Oct 16, 2024 • edited Loading

lakchote commented Oct 17, 2024

lakchote commented Oct 17, 2024

melvin-bot bot commented Oct 17, 2024

hoangzinh commented Oct 17, 2024

ZhenjaHorbach commented Oct 17, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ZhenjaHorbach commented Oct 17, 2024 • edited Loading

hoangzinh commented Oct 17, 2024

ZhenjaHorbach commented Oct 18, 2024

OSBotify commented Oct 18, 2024

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 22, 2024

github-actions bot commented Oct 22, 2024

hoangzinh commented Oct 9, 2024 •

edited

Loading

lakchote commented Oct 14, 2024 •

edited

Loading

lakchote commented Oct 16, 2024 •

edited

Loading

ZhenjaHorbach commented Oct 17, 2024 •

edited

Loading

ZhenjaHorbach commented Oct 17, 2024 •

edited

Loading