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

[yuwenmemon]

With #44739 we added offline and error patterns to the Sage Intacct connection menu.

One observation from discussion in Slack was that this pattern is not necessarily implemented for the other integrations (QBO, Xero, and NetSuite) and we'd like to maintain parity between all integrations menus.

Solution

Implement the same offline and error patterns implemented for Intacct in the other integrations

cc @war-in @JmillsExpensify @shawnborton @trjExpensify

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~014b0b4b88631ddf1d
• Upwork Job ID: 1812869868565563336
• Last Price Increase: 2024-07-15
• Automatic offers:
• ikevin127 | Reviewer | 103126194

Issue Owner

Current Issue Owner: @stephanieelliott

[melvin-bot]

Triggered auto assignment to @puneetlath (NewFeature), see https://stackoverflowteams.com/c/expensify/questions/14418#:~:text=BugZero%20process%20steps%20for%20feature%20requests for more details. Please add this Feature request to a GH project, as outlined in the SO.

[melvin-bot]

⚠️ It looks like this issue is labelled as a New Feature but not tied to any GitHub Project. Keep in mind that all new features should be tied to GitHub Projects in order to properly track external CAP software time ⚠️

[melvin-bot]

Triggered auto assignment to Design team member for new feature review - @shawnborton (NewFeature)

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~014b0b4b88631ddf1d

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @ikevin127 (External)

[war-in]

Hi, I'm Marcin from Software Mansion and I'd like to work on this issue!

[melvin-bot]

📣 @ikevin127 🎉 An offer has been automatically sent to your Upwork account for the Reviewer role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job

[kabeer95]

Add Offline and Error Patterns to Remaining Integrations

Problem Statement

Our current integrations lack essential offline and error handling patterns, which results in a suboptimal user experience when encountering errors or losing connectivity.

Root Cause

The absence of robust offline and error handling stems from a rushed implementation to meet aggressive deadlines. Priority was given to functionality over resilience, leaving our system vulnerable to disruptions caused by network failures or errors.

Changes to Solve the Problem

Add Offline Pattern
Implement an offline pattern to ensure data persistence and synchronization when connectivity is restored.

// Offline pattern
if (!navigator.onLine) {
  // Store data locally and sync when connectivity is restored
  localStorage.setItem('data', JSON.stringify(data));
  displayOfflineMessage();
} else {
  // Sync data with server
  syncDataWithServer();
}

function displayOfflineMessage() {
  // Display offline message to user
  alert('You are offline. Your changes will be synced when connectivity is restored.');
}

Add Error Pattern

Introduce an error pattern to centrally manage and communicate errors to users, facilitating retries for failed actions.

javascript

try {
  // Perform action that may fail
  performAction();
} catch (error) {
  // Catch and handle error centrally
  handleError(error);
  displayErrorMessage();
}

function handleError(error) {
  // Log error for debugging purposes
  console.error(error);
  // Display clear and concise error message to user
  displayErrorMessage();
}

function displayErrorMessage() {
  // Display error message to user
  alert('An error occurred. Please try again.');
}

Benefits

Improved User Experience: Enhancing our system with offline and error patterns ensures users experience greater reliability and continuity, even when faced with connectivity issues or errors.
Increased User Adoption: By providing a seamless experience that minimizes disruption and frustration, we aim to enhance user satisfaction and encourage higher adoption rates.

[ikevin127]

@kabeer95 Thanks for your proposal. Unfortunately this issue was already assigned to Marcin from Software Mansion based on #45406 (comment). Additionally, in the future - in order for reviewers to be able to consider your proposal you need to precisely follow the proposal template when posting a proposal.

[kabeer95]

@ikevin127 okay.

[war-in]

Posting my update because I'll be OOO till Monday

I started working on fixing offline and error patterns in Xero integration and created a draft PR. You can check the web video in the PR description but I haven't worked on offline handling yet.

The best (and fastest) way will be splitting this work into a few PRs (one per integration). It should help with testing.

[war-in]

I also found and fixed some bugs (e.g. showing offline state for all export subpages when only one is updated). It will require thorough review but @hungvu193 is up-to-date (he reviewed my Sage Intacct offline and error PR) so we should be able to merge things fast 🚀

[ikevin127]

ℹ️ Notice that @shubham1206agra will take over the NetSuite PR #46667 as they have credentials for the integration and I don't - the passing over was discussed on Slack. Please remove me from the PR as reviewer and assign them!

Also @hungvu193 took over the SageIntaact PR #46294 for the same reason. This PR is already merged and payment is coming up on 13th.

@stephanieelliott Both C+ reviewers mentioned above will require payment as part of this issue.

cc @yuwenmemon @deetergp

I'm continuing with the review of the other PRs / follow-ups (QBO and Xero).

[ikevin127]

What's the difference between:

• Offline and errors pattern in Sage Intacct integration #46294
  and
• Sage intacct offline error patterns #47079

I thought we already handled that one 🤔

cc @war-in @289Adam289

Also @hungvu193, mind reviewing this one as well since you got the credential for Sage and reviewed the other PR ?

[hungvu193]

Yeah, I can take that one 😄 . Hey @war-in @289Adam289, can you answer the above question?

[zfurtak]

What's the difference between:

• Offline and errors pattern in Sage Intacct integration #46294
  and
• Sage intacct offline error patterns #47079

I thought we already handled that one 🤔

Hello 👋 after merging the first PR, the strategy of handling error and offline behaviours changed a bit, so we needed to update the Sage Intacct PR (details in this thread on #wave8-collect-admins) 🤓

[hungvu193]

I see, I'll review today 😄

[stephanieelliott]

Ok, so I want to make sure i have this right -- these are the PRs and reviewers due payment I have on this issue @hungvu193 @ikevin127 can you look this over and confirm I have the relevant PRs and correct person due payment?

• Sage

  • Sage intacct export: offline and error #44739, Offline and errors pattern in Sage Intacct integration #46294 reviewer @hungvu193 [Paid elsewhere, see comment]

• NetSuite

  • Offline and error patterns in NetSuite integration #46667 - reviewer @shubham1206agra

• QBO:

  • Offline and errors pattern in Quickbooks Online integration #46511 - reviewer @ikevin127

• Xero:

  • Offline and errors pattern in Xero integration #45493 - @ikevin127 [PAID 8/5, see comment]
  • Apply correct error pattern in Xero integration (return to previous value on error) #46898 - @ikevin127 [PAID 8/22, see comment]

[hungvu193]

I reviewed 2 SageIntacct PRs, but no payment needed for me, I will be paid centrally later when SageIntacct project is completed

[ikevin127]

@stephanieelliott The 2 Sage Intaact merged PRs were both reviewed by @hungvu193 which as they mentioned will not be due payment per every PR.

The Xero PR I reviewed first was already paid out to me on 8/5.

So far we're all good with payments, there will be other PRs reviewed by me as part of this issue where I'll need payment once the regression period is over.

[shubham1206agra]

@stephanieelliott NetSuite will be handled by me actually.

[ikevin127]

⚠️ Production deploy automation failed here -> a new payment date should be on [HOLD for Payment 2024-08-22] according to yesterday’s production deploy confirmed in #46898 (comment) and deploy checklist.

I will require payment as reviewer of PR:

• Apply correct error pattern in Xero integration (return to previous value on error) #46898

cc @stephanieelliott

[ikevin127]

cc @stephanieelliott

[stephanieelliott]

Summarizing payment for #46898

Contributor @war-in - no payment due (agency)
C+ @ikevin127 -$250 via Upwork on this job, milestone 2 - PAID

[stephanieelliott]

Status check on the remaining PRs on this issue:

• Offline and error patterns in NetSuite integration #46667 - reviewer @shubham1206agra, Reviewing
• Offline and errors pattern in Quickbooks Online integration #46511 - reviewer @ikevin127, Reviewing

[ikevin127]

The NetSuite one was taken by @shubham1206agra as C+ reviewer since only they have the credentials required to test NetSuite integration.

The 2nd one is correct, currently waiting on CME for final approve and merge, hopefully soon 😁

[melvin-bot]

⚠️ Looks like this issue was linked to a Deploy Blocker here

If you are the assigned CME please investigate whether the linked PR caused a regression and leave a comment with the results.

If a regression has occurred and you are the assigned CM follow the instructions here.

If this regression could have been avoided please consider also proposing a recommendation to the PR checklist so that we can avoid it in the future.

[stephanieelliott]

#46667 - reviewer @shubham1206agra, Reviewing
#46511 - reviewer @ikevin127, Reviewing

Both on staging!

[ikevin127]

⚠️ Automation failed here -> the last 2 payments should be on [HOLD for Payment 2024-09-17] according to 3 days ago production deploy from #48664 (comment) (both PRs are in this deploy checklist, first two).

Notes for payments

• ⚠️ looks like the NetSuite one had a regression and the QBO one had no issues

cc @stephanieelliott

[shubham1206agra]

Just noting that the regression happened due to changes in BE to accommodate another change not related to this issue. So I don't think normal regression applies here.

[ikevin127]

cc @stephanieelliott

[stephanieelliott]

Summarizing payment:

---

PR #46667

• Contributor: @war-in -- no payment due (agency)
• Contributor+: @shubham1206agra -- $250 via Upwork - PAID

Upwork job is here: https://www.upwork.com/jobs/~021837018600586595691

---

PR #46511

• Contributor: @zfurtak -- no payment due (agency)
• Contributor+: @ikevin127 -- 250 via Upwork on this job, milestone 3 - PAID

Upwork job is here: https://www.upwork.com/jobs/~014b0b4b88631ddf1d

[shubham1206agra]

@stephanieelliott Offer accepted

[stephanieelliott]

All paid! Thanks