Offline and errors pattern in Xero integration by war-in · Pull Request #45493 · Expensify/App

war-in · 2024-07-16T16:00:36Z

Details

Fixed Issues

$ #45406 - partially fixes
PROPOSAL:

Tests

Test errors:

Set Simulate failing network in Troubleshooting (you can set MAX_REQUEST_RETRIES to 0 to get errors faster).
Go to Settings -> Workspaces -> your sage intacct workspace -> Accounting.
Go through every page and try changing values.
See that there are RBRs and error messages when request fails.

Offline tests

Go to Settings -> Workspaces -> your xero workspace -> Accounting.
Go through every page and try changing values.
See that changed values are on opacity 50%.

QA Steps

Test errors:

Set Simulate failing network in Troubleshooting (you can set MAX_REQUEST_RETRIES to 0 to get errors faster).
Go to Settings -> Workspaces -> your sage intacct workspace -> Accounting.
Go through every page and try changing values.
See that there are RBRs and error messages when request fails.

PR Author Checklist

Screenshots/Videos

Android: Native

android.-.native.mov

Android: mWeb Chrome

andorid.-.web.mov

iOS: Native

iOS: mWeb Safari

ios.-.web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

…ntegrations # Conflicts: # src/components/SelectionScreen.tsx

…ntegrations

war-in · 2024-07-17T15:04:44Z

~~TODO: add offline state handling~~
Edit: Done!

…ntegrations

…ntegrations # Conflicts: # src/libs/PolicyUtils.ts

filip-solecki

LGTM, just fix failing lint

melvin-bot · 2024-07-23T10:27:20Z

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

ikevin127 · 2024-07-23T22:55:03Z

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

Android: mWeb Chrome

android-mweb.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-mweb.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

ikevin127 · 2024-07-24T01:14:19Z

@war-in Found one issue with the offline pattern while testing, in short: if options are toggled with Simulate failing network then the errors are cleared, if we then Force offline, upon returning to the Xero accounting we can notice the previously failed and error cleared options are now all grayed-out as if they were toggled while offline.

This only happens when we Simulate failing network first on specific sections of the Xero accounting, then we clear the errors and then go offline - is behaving as if changes were made while offline even if that didn't happen, so this might have something to do with the offline check for the Xero accounting options after failing requests / clearing errors.

Here's the video:

Screen.Recording.2024-07-23.at.18.mp4

Other than this it looks good, I'll move on with the checklist. Please solve the conflicts when you get a change, thank you!

ikevin127 · 2024-07-24T02:35:55Z

Note

✅ Completed PR reviewer checklist.
⚠️ Will do a final check up and Approve once conflicts and issue described in #45493 (comment) are resolved.

war-in · 2024-07-24T12:21:42Z

@ikevin127 thanks for noticing! I think the issue is with how we set the errors.

In the updatePolicyConnectionConfig function we set both pendingFields and errorFields on failure to some values.

Maybe we should just set errorFields on failure and clear pendingFields 🤔 That should solve the issue. But it was done this way previously and I assumed it was correct.

war-in · 2024-07-24T12:25:19Z

@ikevin127 I wonder if we should merge this PR on its own or wait for other PRs (qbo, sage intacct and net suite) because changes in updatePolicyConnectionConfig can affect other integrations.

Maybe we should copy the mentioned function (with changes), use it in changed integrations and leave updatePolicyConnectionConfig untouched?

Please share your thoughts 🙏

…ntegrations # Conflicts: # src/libs/PolicyUtils.ts

ikevin127

@war-in Sorry for the delayed response (Pacific timezone). I noticed by your latest commit that you went with updating the updatePolicyConnectionConfig's function pendingFields to null.

Thereby I confirm that your latest changes fixes the issue mentioned in #45493 (comment), everything else LGTM 🚀

melvin-bot · 2024-07-24T19:12:21Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #45406 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

ikevin127 · 2024-07-24T19:13:23Z

cc @yuwenmemon

war-in · 2024-07-25T07:19:39Z

@ikevin127 If you could please answer this question 🙏

ikevin127 · 2024-07-25T07:26:43Z

Maybe we should copy the mentioned function (with changes), use it in changed integrations and leave updatePolicyConnectionConfig untouched?

@war-in I think it's safer to simply copy and change existing function since I notice that updatePolicyConnectionConfig it's used in quite a few places which we don't know how would be affected if we change the existing function.

If you have more context on the usage of current updatePolicyConnectionConfig and know / can easily verify that it won't introduce regressions if changed to fix the error / offline pattern issue, then feel free to change the existing one - otherwise I'd take the safer route mentioned above.

Maybe @yuwenmemon can chime in here as well before we move forward with a final decision.

war-in · 2024-07-25T07:31:44Z

it's used in quite a few places

@ikevin127 It's used in QBO and Xero integrations afaik. I adjusted usages in Xero but it'll affect QBO for sure (errors will be broken). So it's safer to copy the logic for now and unify it once we update the QBO integration.

war-in · 2024-07-25T11:10:11Z

@ikevin127 I copied the function and left the old one untouched 👍

@yuwenmemon It's ready for an internal review 🚀

yuwenmemon · 2024-07-25T23:36:50Z

I'm fine with reconciling later across all integration to ensure consistency 👍

OSBotify · 2024-07-25T23:50: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-07-26T05:36:44Z

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 9.0.13-0 🚀

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

OSBotify · 2024-07-29T18:39:38Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.13-4 🚀

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

war-in added 10 commits July 16, 2024 12:47

apply offline and errors pattern for xero export

d11de01

update xero advanced page

564d229

revert max retries

d629d70

update XeroOrganizationConfigurationPage

e0d0e53

update XeroTrackingCategoryConfigurationPage

9ed5911

Merge branch 'refs/heads/main' into war-in/offline-errors-remaining-i…

82c04fd

…ntegrations # Conflicts: # src/components/SelectionScreen.tsx

add translated title to Selection Screen

f2ed76e

Merge branch 'refs/heads/main' into war-in/offline-errors-remaining-i…

2fee8f5

…ntegrations

show RBRs everywhere

5d8ec28

fix typescript errors

a6861e4

use more specific type

25be841

war-in mentioned this pull request Jul 17, 2024

[HOLD for payment 2024-09-17] [$250] Add Offline and Error Patterns to Remaining Integrations #45406

Closed

war-in added 10 commits July 17, 2024 18:13

add function for pending action extraction

854b71f

Merge branch 'refs/heads/main' into war-in/offline-errors-remaining-i…

e8f6808

…ntegrations

use unified offline flow on advanced page

4db4bed

use unified offline flow on import page

c2de3de

use unified offline flow on export page

b20bbed

fix lint

73cc0c2

simplify PolicyAccountingPage

d8f6cd9

revert retries

b6bda66

Merge branch 'refs/heads/main' into war-in/offline-errors-remaining-i…

862e0af

…ntegrations # Conflicts: # src/libs/PolicyUtils.ts

use default tracking categories options value

e880a1d

filip-solecki approved these changes Jul 23, 2024

View reviewed changes

fix lint error

147dea1

war-in marked this pull request as ready for review July 23, 2024 10:27

war-in requested a review from a team as a code owner July 23, 2024 10:27

melvin-bot bot requested review from ikevin127 and removed request for a team July 23, 2024 10:27

war-in added 2 commits July 24, 2024 14:26

Merge branch 'refs/heads/main' into war-in/offline-errors-remaining-i…

ae2b0d9

…ntegrations # Conflicts: # src/libs/PolicyUtils.ts

set pendingFields to null after failed request

0d19456

ikevin127 approved these changes Jul 24, 2024

View reviewed changes

war-in added 2 commits July 25, 2024 13:05

do not change original updatePolicyConnectionConfig

4ad177b

do not change original updatePolicyConnectionConfig

4e41702

yuwenmemon approved these changes Jul 25, 2024

View reviewed changes

yuwenmemon merged commit 6d2cf34 into Expensify:main Jul 25, 2024

github-actions bot mentioned this pull request Jul 26, 2024

Deploy Checklist: New Expensify 2024-07-26 #46264

Closed

48 tasks

war-in deleted the war-in/offline-errors-remaining-integrations branch April 11, 2025 11:28

Conversation

war-in commented Jul 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

war-in commented Jul 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

filip-solecki left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Jul 23, 2024

Uh oh!

ikevin127 commented Jul 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

ikevin127 commented Jul 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ikevin127 commented Jul 24, 2024

Uh oh!

war-in commented Jul 24, 2024

Uh oh!

war-in commented Jul 24, 2024

Uh oh!

ikevin127 left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Jul 24, 2024

Uh oh!

ikevin127 commented Jul 24, 2024

Uh oh!

war-in commented Jul 25, 2024

Uh oh!

ikevin127 commented Jul 25, 2024

Uh oh!

war-in commented Jul 25, 2024

Uh oh!

war-in commented Jul 25, 2024

Uh oh!

yuwenmemon commented Jul 25, 2024

Uh oh!

OSBotify commented Jul 25, 2024

Uh oh!

OSBotify commented Jul 26, 2024

Uh oh!

OSBotify commented Jul 29, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

war-in commented Jul 16, 2024 •

edited

Loading

war-in commented Jul 17, 2024 •

edited

Loading

ikevin127 commented Jul 23, 2024 •

edited

Loading

ikevin127 commented Jul 24, 2024 •

edited

Loading