[HOLD for payment 2024-10-29] [$250] QBD - Category title link shows "undefined settings" when there is error with QBO connection

[IuliiaHerets]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Version Number: 9.0.37-0
Reproducible in staging?: Y
Reproducible in production?: Y
Issue was found when executing this PR: #48759
Email or phone of affected tester (no customers): [email protected]
Issue reported by: Applause Internal Team

Action Performed:

Precondition:

• Workspace is connected to QBD on Old Dot and the set up is not completed to trigger the error.

1. Go to staging.new.expensify.com
2. Go to workspace settings.
3. Go to Categories.

Expected Result:

The link in the header will not show "undefined settings".

Actual Result:

The link in the header shows "undefined settings".
The same issue goes for Tags and Report fields.

Workaround:

Unknown

Platforms:

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Bug6607411_1726643329782.20240918_150524.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~021837252793117015940
• Upwork Job ID: 1837252793117015940
• Last Price Increase: 2024-09-20
• Automatic offers:
• brunovjk | Contributor | 104158165

Issue Owner

Current Issue Owner: @alexpensify

[melvin-bot]

Triggered auto assignment to @alexpensify (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[IuliiaHerets]

We think that this bug might be related to #wave-control

[IuliiaHerets]

@alexpensify FYI I haven't added the External label as I wasn't 100% sure about this issue. Please take a look and add the label if you agree it's a bug and can be handled by external contributors

[abzokhattab]

Edited by proposal-police: This proposal was edited at 2024-09-18 16:04:34 UTC.

Proposal

Please re-state the problem that we are trying to solve in this issue.

The category title link displays "undefined settings."

What is the root cause of that problem?

• The app displays undefined for the QBO when using desktop because the quickbooksDesktop option is not added to the CONNECTIONS names list or the routes list.
  

  App/src/CONST.ts

  Lines 2275 to 2287 in f2a4b87

  	// Here we will add other connections names when we add support for them
  	QBO: 'quickbooksOnline',
  	XERO: 'xero',
  	NETSUITE: 'netsuite',
  	SAGE_INTACCT: 'intacct',
  	},
  	ROUTE: {
  	QBO: 'quickbooks-online',
  	XERO: 'xero',
  	NETSUITE: 'netsuite',
  	SAGE_INTACCT: 'sage-intacct',
  	},
  	NAME_USER_FRIENDLY: {

What changes do you think we should make in order to solve the problem?

• Add QuickBooks Desktop alongside other supported connections from this list:
  

  App/src/CONST.ts

  Lines 2287 to 2296 in f2a4b87

  	NAME_USER_FRIENDLY: {
  	netsuite: 'NetSuite',
  	quickbooksOnline: 'Quickbooks Online',
  	quickbooksDesktop: 'Quickbooks Desktop',
  	xero: 'Xero',
  	intacct: 'Sage Intacct',
  	financialForce: 'FinancialForce',
  	billCom: 'Bill.com',
  	zenefits: 'Zenefits',
  	},

• Update this condition to support QuickBooks Desktop

• updated other hardcoded connection objects across the project to include also the QuickBooks Desktop

What alternative solutions did you explore? (Optional)

Another solution would be to avoid displaying the categories below are imported from... message if the connection name is undefined. If the connection is undefined, it indicates that it's not a supported connection.This can be achieved by changing this condition:

App/src/pages/workspace/categories/WorkspaceCategoriesPage.tsx

Line 283 in 4f695c6

{isConnectedToAccounting ? (

to check for currentConnectionName instead of checking the length of policy?.connections, as this list could contain unsupported connections.
This change should also be applied here, here and here

OR

Instead of displaying undefined for unsupported connections, we can still retrieve the connection name regardless of whether it is supported, as Tom mentioned here .
To achieve this, we have two options:

1. We can update the getCurrentConnectionName function so that it only checks CONST.POLICY.CONNECTIONS.NAME_USER_FRIENDLY, which contains both supported and unsupported connection names, and remove CONST.POLICY.CONNECTIONS.NAME:

function getCurrentConnectionName(policy?: Policy): string | undefined {
    if (!policy?.connections) {
        return undefined;
    }

    const connectionNames = CONST.POLICY.CONNECTIONS.NAME_USER_FRIENDLY;
 
    for (const key of Object.keys(connectionNames)) {
        if (policy.connections[key]) {
            return connectionNames[key];
        }
    }

    return undefined;
}

2. Or, we can create a new function that uses the same logic as above but with a different function name. This would help avoid potential issues elsewhere in the code. In this case, we need to update the function calls here , here , and here, here to use this new function.
   but i recommend to update the current function to keep everything consistent
3. finally in the accounting page we need to show a message in case any of the current connections are unsupported so that the user can check it, to do that we need to add the following component here

         {hasUnsupportedNDIntegration && !hasSyncError && (
                                <FormHelpMessage
                                    isError
                                    shouldShowRedDotIndicator
                                >
                                    <Text style={[{color: theme.textError}]}>
                                        {translate('workspace.accounting.unSupportedIntegration')}
                                        <TextLink
                                            onPress={() => {
                                                Link.openOldDotLink(CONST.OLDDOT_URLS.POLICY_CONNECTIONS_URL(policyID));
                                            }}
                                        >
                                            {translate('workspace.accounting.manageYourSettings')}
                                        </TextLink>
                                    </Text>
                                </FormHelpMessage>
                            )}

note: we might not need to warp it with FormHelpMessage as the user didn't make anything wrong ( the connection is not supported form our side), so it shouldn't be shown as error, we can just show the TextLink for without wrapping it.

[mkzie2]

Edited by proposal-police: This proposal was edited at 2024-09-24 09:51:46 UTC.

Proposal

Please re-state the problem that we are trying to solve in this issue.

• QBO - Category title link shows "undefined settings" when there is error with QBO connection

What is the root cause of that problem?

• We didn't handle the case there is a connection that is not supported in ND in:
  

  App/src/libs/PolicyUtils.ts

  Line 957 in 0c618ac

  return connectionKey ? CONST.POLICY.CONNECTIONS.NAME_USER_FRIENDLY[connectionKey] : undefined;

  
  hence the link is displayed as "undefined setting".

What changes do you think we should make in order to solve the problem?

1. Display The categories below are imported from QuickBooks Desktop (or the name of the connected integration, even if it's not yet supported) to make the messaging consistent.

• First, change function:

App/src/libs/PolicyUtils.ts

Line 952 in 740484c

function getCurrentConnectionName(policy: Policy | undefined): string | undefined {

function getCurrentConnectionName(policy: Policy | undefined, includeUnsupportedConnection = false): string | undefined {
    const accountingIntegrations = Object.values(CONST.POLICY.CONNECTIONS.NAME);
    if (includeUnsupportedConnection) {
        accountingIntegrations.push(...Object.values(CONST.POLICY.UNSUPPORTED_CONNECTIONS.NAME));
    }
    const connectionKey = accountingIntegrations.find((integration) => !!policy?.connections?.[integration]);
    return connectionKey ? CONST.POLICY.CONNECTIONS.NAME_USER_FRIENDLY[connectionKey] : undefined;
}

By introducing a includeUnsupportedConnection param, we can make sure our change in this PR does not break other logics.

• Then, change logic:
  

  App/src/pages/workspace/categories/WorkspaceCategoriesPage.tsx

  Line 73 in ace39e8

  const currentConnectionName = PolicyUtils.getCurrentConnectionName(policy);

    const currentConnectionName = PolicyUtils.getCurrentConnectionName(policy, true);

• Next, create hasSyncError in:
  

  App/src/pages/workspace/categories/WorkspaceCategoriesPage.tsx

  Line 74 in ace39e8

    const [connectionSyncProgress] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY_CONNECTION_SYNC_PROGRESS}${policy?.id}`);
    const isSyncInProgress = isConnectionInProgress(connectionSyncProgress, policy);
    const hasSyncError = PolicyUtils.hasSyncError(policy, isSyncInProgress);

The text "The categories below are imported from your Quickbooks Desktop settings" should not be displayed if the connection encountered an error. We will use hasSyncError to decide whether we should display that text or not.

• (Optional) Next, update:

App/src/pages/workspace/categories/WorkspaceCategoriesPage.tsx

Line 283 in ace39e8

{isConnectedToAccounting ? (

            {!hasSyncError && isConnectedToAccounting ? (

• It will display something like:

If the connection is not supported and successful.

• And it will display something like:

if the connection is not supported and there is an error.

2. On the policy's accounting page, show the Go to Expensify Classic to manage your settings. text.

• We need to update the workspace accounting page to display the text "Go to Expensify Classic to manage your settings" in case "the connection is not supported and successful", since the case "the connection is not supported and there is an error" has already been implemented in another PR.

To do it, add another logic to handle that case to:

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

Line 495 in 1c39bd2

)}

                          {hasUnsupportedNDIntegration && !hasSyncError && (
                                <FormHelpMessage shouldShowRedDotIndicator={false}>
                                    <Text>
                                        <TextLink
                                            onPress={() => {
                                                // Go to Expensify Classic.
                                                Link.openOldDotLink(CONST.OLDDOT_URLS.POLICY_CONNECTIONS_URL(policyID));
                                            }}
                                        >
                                            {"Go to Expensify Classic to manage your settings"}
                                        </TextLink>
                                    </Text>
                                </FormHelpMessage>
                            )}

• Other minor changes can be implemented in PR stage, such as:

1. Remove hasSyncError conditions in:
   

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

   Line 462 in 1c39bd2

   {!(hasUnsupportedNDIntegration && hasSyncError) &&

2. Remove !(hasUnsupportedNDIntegration && hasSyncError) in:
   

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

   Line 380 in 1c39bd2

   if (isEmptyObject(policy?.connections) && !isSyncInProgress && !(hasUnsupportedNDIntegration && hasSyncError)) {

3. Update hasUnsupportedNDIntegration variable to:

    const hasUnsupportedNDIntegration = !isEmptyObject(policy?.connections) && PolicyUtils.hasUnsupportedIntegration(policy, accountingIntegrations);

• It will display something like:

in case "the connection is not supported and successful".

What alternative solutions did you explore? (Optional)

Details

• We should change logic:
  

  App/src/pages/workspace/categories/WorkspaceCategoriesPage.tsx

  Line 283 in ace39e8

  {isConnectedToAccounting ? (

            {!hasSyncError && hasUnsupportedIntegration ? (
                <Text>
                    <Text style={[styles.textNormal, styles.colorMuted]}>{`The categories below have been imported from the connection configured in `}</Text>
                    <TextLink
                        style={[styles.textNormal, styles.link]}
                        onPress={() => {
                            // Go to Expensify Classic.
                            Link.openOldDotLink(CONST.OLDDOT_URLS.POLICY_CONNECTIONS_URL(policyId));
                        }}
                    >
                        {`Expensify Classic`}
                    </TextLink>
                    <Text style={[styles.textNormal, styles.colorMuted]}>.</Text>
                </Text>
            ) : !hasSyncError && isConnectedToAccounting ? (

in there hasUnsupportedIntegration is

const hasUnsupportedIntegration = isConnectedToAccounting && PolicyUtils.hasUnsupportedIntegration(policy, Object.values(CONST.POLICY.CONNECTIONS.NAME));

and hasSyncError is

    const [connectionSyncProgress] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY_CONNECTION_SYNC_PROGRESS}${policy?.id}`);
    const isSyncInProgress = isConnectionInProgress(connectionSyncProgress, policy);
    const hasSyncError = PolicyUtils.hasSyncError(policy, isSyncInProgress);

• It will display something like:

if there is a successful connection which is not supported in ND and when user clicks on "Expensify Classic", it will open OD app like we did in:

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

Line 491 in f7a4aa1

Link.openOldDotLink(CONST.OLDDOT_URLS.POLICY_CONNECTIONS_URL(policyID));

• We should apply the same fix in tag, reportField, taxes page.

[melvin-bot]

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

[melvin-bot]

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

[alexpensify]

@brunovjk when you get a chance, can you please review the proposals? Thanks!

[brunovjk]

@brunovjk when you get a chance, can you please review the proposals? Thanks!

Sure!

[shubham1206agra]

I don't think QBD is implemented at all. cc @lakchote @dylanexpensify

[brunovjk]

Appreciate the insights @shubham1206agra! I will hold off on the proposal review until the last comment has been addressed :D

[abzokhattab]

While adding QuickBooks Desktop (QBD) would resolve the issue for that connection, this "undefined settings" error may still occur with other unsupported connections. To ensure broader coverage and prevent similar issues, I recommend considering the alternative solution proposed, which addresses undefined connections more comprehensively.

[alexpensify]

I'm confused, this GH is about QBO, not QBD. Why did we pivot to talk about QBD?

[lakchote]

I don't understand why we're talking about QBD either here. We're talking about QBO. QBD is not yet implemented in NewDot.

[mkzie2]

@lakchote The QBD is not yet implemented in NewDot. But there are a few cases where the QBD term is still displayed in ND, such as our current issue and that issue.

[brunovjk]

It seems the confusion stems from the fact that this issue was initially labeled as QBO, but the actual functionality being tested in the video and steps involves QBD (QuickBooks Desktop), not QBO (QuickBooks Online).

Here's a summary:

• The issue creator referenced QBO Desktop, but the test steps, video, and setup involve QBD only.
• The PR addresses handling non-configurable integrations in NewDot like QuickBooks Desktop (QBD).
• The video shows a QBD flow (connecting to QBD on OldDot, followed by accessing categories in NewDot).

POC

QBD.mov

I reviewed both proposals (using the alternative solution from the first one), and they are quite similar. While the first proposal from @abzokhattab suggests "avoiding the display of the 'categories below are imported from...' message if the connection name is undefined," I believe the second one from @mkzie2 —which involves adding a message informing the user that certain features like QBD categories and tags are not yet supported—is more appropriate, provided that this issue is confirmed.

@alexpensify @lakchote @shubham1206agra @IuliiaHerets Does this make sense or am I missing something? Thank you :D

[abzokhattab]

I have a question: if the connection setup fails, will the categories still be imported from the failed connection?

If not, I think it makes sense not to display that label here .

Instead, we could add another label warning the user to check the connection page for a potential failed connection, rather than informing them that the categories were imported

[lakchote]

It does make sense @brunovjk, thanks!

The issue's title is misleading, it's indeed about QBD and not QBO cc @IuliiaHerets

QBD in NewDot will soon be supported, and is already supported in OldDot.

Regarding what to do between these 2 choices:

1. avoiding the display of the categories below are imported from... message if the connection name is undefined
2. adding a message informing the user that certain features like QBD categories and tags are not yet supported

I'd go with helping the user by informing him on the current status of the integration.
If it failed to connect, use a specific message. If it's not supported yet, do the same.

I'm going to tag @JmillsExpensify @trjExpensify what would you go with?

[trjExpensify]

QBD in NewDot will soon be supported, and is already supported in OldDot.

How far away are we from building QBD workspace settings out in NewDot? I'm a bit mindful of investing in throwaway work with QBD coming soon. That said, we could hit the "undefined" message with Certina (FinancialForce) as well I guess which is a little further out - but not a million miles away.

Can't we know from the policy object which accounting solution is connected to the workspace already, and show it's name instead of undefined on the categories and tags page here like normal?

Then on the accounting page replace this message with a generic _"Go to Expensify Classic to manage your settings." which we'll remove in turn for QBD and Certina as those are built:

[lakchote]

How far away are we from building QBD workspace settings out in NewDot? I'm a bit mindful of investing in throwaway work with QBD coming soon. That said, we could hit the "undefined" message with Certina (FinancialForce) as well I guess which is a little further out - but not a million miles away.

That's a fair concern. QBD should start to be implemented by the end of the month/early October.
We could do this in advance yes, as it can impact other integrations down the line if they're not supported.

Can't we know from the policy object which accounting solution is connected to the workspace already, and show it's name instead of undefined on the categories and tags page here like normal?
Yes, we can.

What you suggest make sense:

1. Display The categories below are imported from QuickBooks Desktop (or the name of the connected integration, even if it's not yet supported) to make the messaging consistent.
2. On the policy's accounting page, show the Go to Expensify Classic to manage your settings. text.

[melvin-bot]

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

Offer link
Upwork job
Please accept the offer and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[melvin-bot]

📣 @mkzie2 You have been assigned to this job!
Please apply to the Upwork job and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Once you apply to this job, your Upwork ID will be stored and you will be automatically hired for future jobs!
Keep in mind: Code of Conduct | Contributing 📖

[justinpersaud]

Woops I double clicked on the assignee button and hit the clear asignees button, so upwork job should actually be for @mkzie2

[melvin-bot]

@justinpersaud, @alexpensify, @brunovjk, @mkzie2 Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

[brunovjk]

Not overdue, PR being raised. @mkzie2 do you have an estimated deadline? Thanks.

[alexpensify]

Update: PR is in review

[alexpensify]

Weekly Update: PR is still in review

[alexpensify]

Heads up, I will be offline until Tuesday, October 22, 2024, and will not actively watch over this GitHub during that period.

If this GitHub requires an urgent update, please ask for help in the #expensify-open-source Slack Room. If the inquiry can wait, I'll review it when I return online.

[flaviadefaria]

This shouldn't be part of the #migration project as it isn't related to one of the upcoming cohorts. #retain is probably a better place for this issue.

[trjExpensify]

I agree it shouldn't be in #migrate, but it should be in #expense where QBD is being actively built. We're just waiting out the regression period here. Hit staging on Friday.

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 9.0.51-4 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• fix: categories subtitle shows undefined settings when there is sync error #49972

If no regressions arise, payment will be issued on 2024-10-29. 🎊

For reference, here are some details about the assignees on this issue:

• @brunovjk requires payment automatic offer (Contributor)
• @mkzie2 requires payment (Needs manual offer from BZ)

[melvin-bot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@brunovjk] The PR that introduced the bug has been identified. Link to the PR:
• [@brunovjk] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
• [@brunovjk] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
• [@brunovjk] Determine if we should create a regression test for this bug.
• [@brunovjk] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@alexpensify] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[mkzie2]

@brunovjk Please note that as of today we already support QBD integration, only this test case is valid:

1. In OD, try to connect to Quickbooks Desktop but do not complete the set up to trigger error
2. In ND, open workspace settings > Categories
3. Verify Get a better overview of where money is being spent... message shows under Categories title