Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Preferred exporter page + country crash #41530

Merged
merged 4 commits into from
May 2, 2024

Conversation

aldo-expensify
Copy link
Contributor

Details

Fixes the Preferred exporter page for the QBO Export settings
Fixes this country crash: #41095 (comment)

Fixed Issues

$ #41463 (comment) (preferred exporter page not working)
$ #41095 (comment) (country crash)
PROPOSAL:

Tests

  1. Create Workspace
  2. Enable "Accounting" in "More Settings"
  3. Connect to Qbo
  4. Once the connection is done, go to "Export"
  5. Click on the first setting "Preferred exporter"
    image
  6. Verify that the page to change the settings opens correctly and you don't get a "Not Found"
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Create Workspace
  2. Enable "Accounting" in "More Settings"
  3. Connect to Qbo
  4. Once the connection is done, go to "Export"
  5. Click on the first setting "Preferred exporter"
    image
  6. Verify that the page to change the settings opens correctly and you don't get a "Not Found"
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2024-05-02.at.12.34.01.PM.mov
MacOS: Desktop

@aldo-expensify aldo-expensify self-assigned this May 2, 2024
@aldo-expensify aldo-expensify requested a review from a team as a code owner May 2, 2024 19:35
@melvin-bot melvin-bot bot requested review from alitoshmatov and removed request for a team May 2, 2024 19:35
Copy link

melvin-bot bot commented May 2, 2024

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

Copy link
Contributor

github-actions bot commented May 2, 2024

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/41530/index.html ❌ FAILED ❌
Android The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/41530/NewExpensify.dmg https://41530.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@@ -51,7 +51,7 @@ function QuickbooksImportPage({policy}: WithPolicyProps) {
},
];

if (policy?.connections?.quickbooksOnline.data.country !== CONST.COUNTRY.US) {
if (policy?.connections?.quickbooksOnline?.data?.country !== CONST.COUNTRY.US) {
Copy link
Contributor

@hayata-suenaga hayata-suenaga May 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB: should we also mark these fields optional in the TS definition (Policy.ts)?

Screenshot 2024-05-02 at 1 08 04 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm that is probably a good idea, then we wouldn't get a random crash because our types would catch it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried it, but it breaks all calls to updatePolicyConnectionConfig because something goes wrong with the parameter types:

image

I'll leave investigating this for another occasion

hayata-suenaga
hayata-suenaga previously approved these changes May 2, 2024
@hayata-suenaga hayata-suenaga requested review from ikevin127 and removed request for alitoshmatov May 2, 2024 20:13
@hayata-suenaga
Copy link
Contributor

@alitoshmatov, we needed review quite quickly so I assigned @ikevin127 who was available at this time

@trjExpensify
Copy link
Contributor

Few things when testing, not sure if I should have all the recent code merged to main + the changes in this PR:

  1. None of the defaults were set when connecting to QBO, even Chart of Accounts shows Not imported
  2. We're missing the A/P accounts returned in the list still
  3. Choosing Account for Credit card or Debit card shows a page for "Default vendor" instead of Account
  4. The Vendor row appears before you've toggled on Default vendor (Nikolay's PR was initially looking at this)
  5. The preferred exporter list returns the assignedGuide admin on the workspace, we should filter those out like we do in the Members table
  6. Invoices page is blank, it doesn't have the account receivables accounts returned
  7. When trying to enable "Sync reimbursed reports" I'm still getting this TypeError: Uncaught TypeError: TaskQueue: Error with task : Cannot read properties of undefined (reading 'id')
  8. I don't understand the note on Locations, I'll dive into that in a bit
2024-05-02_21-29-29.mp4

@aldo-expensify
Copy link
Contributor Author

aldo-expensify commented May 2, 2024

Few things when testing, not sure if I should have all the recent code merged to main + the changes in this PR:

Yeah, it looks massively broken in your tests, but I will blame the adhoc builds again. You seem to be getting some network errors that should have work, for example:

image

So that may be making everything fail after

@@ -46,7 +46,7 @@ function updatePolicyConnectionConfig<TConnectionName extends ConnectionName, TS
policyID: string,
connectionName: TConnectionName,
settingName: TSettingName,
settingValue?: Partial<Connections[TConnectionName]['config'][TSettingName]>,
settingValue: Partial<Connections[TConnectionName]['config'][TSettingName]>,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed this here because settingValue is NOT optional. This was causing backend server errors.

Comment on lines -37 to -43
useEffect(() => {
if (!isTaxError && !isLocationError) {
return;
}
Connections.updatePolicyConnectionConfig(policyID, CONST.POLICY.CONNECTIONS.NAME.QBO, CONST.QUICK_BOOKS_CONFIG.REIMBURSABLE_EXPENSES_EXPORT_DESTINATION);
}, [policyID, isTaxError, isLocationError]);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was calling updatePolicyConnectionConfig with an invalid value, which did nothing and is an anti-pattern in our app.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can fix this as part 1. of this issue: https://github.com/Expensify/Expensify/issues/390731

@ikevin127
Copy link
Contributor

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: mWeb Chrome
iOS: Native *
ios.MP4
iOS: mWeb Safari
MacOS: Chrome / Safari *
web.mov
MacOS: Desktop

Copy link
Contributor

@ikevin127 ikevin127 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tests well following PR's description steps regarding the "Not found" page error.

✅ Additionally, following #41095 (comment), the country undefined crash seems to be fixed on my side with the following steps:

  1. Toggle "Sync reimbursed reports" on and off.
  2. Click on Import to open the Import RHP, then also click on every RHP option.

LGTM 🚀 (lint check should pass though)

@melvin-bot melvin-bot bot requested a review from carlosmiceli May 2, 2024 21:10
Copy link

melvin-bot bot commented May 2, 2024

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

@aldo-expensify
Copy link
Contributor Author

Thanks @ikevin127 , please re-approve, I had to remove an unused import (lint)

@ikevin127
Copy link
Contributor

@aldo-expensify All good, the only issue was lint not passing but you got that covered. I pulled latest changes and re-tested the steps mentioned at #41530 (review) -> everything works as expected.

Approved ✅

@trjExpensify
Copy link
Contributor

Looking at Kevin's video in the checklist. This one seems incorrect:

Credit card export should not have a list of Vendors returned:

image

Here's OldDot for reference:

image

@trjExpensify
Copy link
Contributor

Debit card should be bank accounts:

image

Vendor bills should be:

Account payable accounts:

image

If default vendor is toggled on, then an additional row and a list of vendors to pick from:

image

@trjExpensify
Copy link
Contributor

Alright, I did a sync now on the adhoc build and now I can at least see all the accounts and stuff.

  1. This is still showing, so looks like a bug: Fix Preferred exporter page + country crash #41530 (comment)
  2. When you select Vendor bill for non-reimbursable export, you get Capital one (a card account) as a placeholder in the push input of the Accounts payable account field.
2024-05-02_22-57-15.mp4
  1. The preferred exporter isn't filtering out the assignedGuide in the list like the members table:

2024-05-02_22-53-58

2024-05-02_23-08-14

@aldo-expensify
Copy link
Contributor Author

This is still showing, so looks like a bug: #41530 (comment)

Are you referring to that it is showing in the placeholder an account of the wrong type selected? This is out of the scope here.

When you select Vendor bill for non-reimbursable export, you get Capital one (a card account) as a placeholder in the push input of the Accounts payable account field.

I think this problem will remain until we solve: https://github.com/Expensify/Expensify/issues/390731

The preferred exporter isn't filtering out the assignedGuide in the list like the members table:

Note that his PR is only enabling the existing Preferred exporter page, I'm not fixing bugs found inside it. If I find it an easy fix, I'll do it here, otherwise in a follow up pr

@aldo-expensify aldo-expensify merged commit 5808670 into main May 2, 2024
17 checks passed
@aldo-expensify aldo-expensify deleted the aldo_fix-preferred-exporter branch May 2, 2024 22:49
@aldo-expensify
Copy link
Contributor Author

I'll merge this since filtering out the guide is a bit more complicated and it is a bug that was already there. I'll fix it in a follow up.

@OSBotify
Copy link
Contributor

OSBotify commented May 2, 2024

✋ 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
Copy link
Contributor

OSBotify commented May 9, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.71-6 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants