QBO: Add explicit description for each export entity #42548

s77rt · 2024-05-23T18:04:58Z

Details

Same as #42524. Now using the correct base

Fixed Issues

$ #42520
PROPOSAL:

Tests

Preconditions:

Workspace connected to QBO

Go to Workspace > Accounting
Click Export > Export out-of-pocket expenses as
Verify that changing the export entity changes the label of the account option as follow:
- Check -> Bank account
- Journal entry -> Account
- Vendor bill -> Accounts payable
Click on the account option
Verify that the title of the page you are navigated to matches the label

Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

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

Networking issue

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-05-23T18:16:25Z

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

trjExpensify · 2024-05-24T01:49:38Z

@rushatgabhane @mananjadhav @hungvu193 @ikevin127 - any of you guys with QBO setup for testing able to take the C+ review of this for @eh2077?

hungvu193 · 2024-05-24T01:51:16Z

@trjExpensify I saw @rushatgabhane was already on another issue so I can take this one

hungvu193 · 2024-05-24T02:05:38Z

@s77rt Is there any extra step that I need to do? That's what I saw when I opened Export out-of-pocket expenses as page. That being said, should we hide that menu item if we don't have data for it?

Screen.Recording.2024-05-24.at.09.04.42.mov

hungvu193 · 2024-05-24T02:26:10Z

src/pages/workspace/accounting/qbo/export/QuickbooksOutOfPocketExpenseAccountSelectPage.tsx

+                titleText = translate('workspace.qbo.accountsPayable');
+                descriptionText = translate('workspace.qbo.accountsPayableDescription');
+                break;
+            default:


Sorry my OCD 🤦 , can we just add a break if there's no code after default case 🙋

hungvu193 · 2024-05-24T02:26:35Z

src/pages/workspace/accounting/qbo/export/QuickbooksOutOfPocketExpenseConfigurationPage.tsx

+                hintText = isLocationEnabled ? undefined : translate('workspace.qbo.exportVendorBillDescription');
+                description = translate('workspace.qbo.accountsPayable');
+                break;
+            default:


NAB, same as above

s77rt · 2024-05-24T05:41:40Z

@hungvu193

Is there any extra step that I need to do?

You need to select an export entity (the "Export as" option)

should we hide that menu item if we don't have data for it?

Yes! @trjExpensify Do you know if we have an issue for that? (the account menu item is blank)

hungvu193 · 2024-05-24T07:01:23Z

Cool cool. Waiting for confirmation from @trjExpensify then I can complete the checklist.

hungvu193 · 2024-05-24T09:58:51Z

@hungvu193

Is there any extra step that I need to do?

You need to select an export entity (the "Export as" option)

should we hide that menu item if we don't have data for it?

Yes! @trjExpensify Do you know if we have an issue for that? (the account menu item is blank)

Hey, coming from this thread (https://expensify.slack.com/archives/C036QM0SLJK/p1716544065033859?thread_ts=1716238514.357639&cid=C036QM0SLJK)
the export out of pocket should never be empty, the default should be selected if the user has not self-configured it to be different.
And
The default option for out of pocket is Vendor Bill, for company cards the default is credit card.

@s77rt Can you update it? Thank you

s77rt · 2024-05-24T10:14:33Z

@hungvu193 This is not related to this PR. It should be handled separately. As far as I can tell this best to be fixed in the backend.

hungvu193 · 2024-05-24T10:21:10Z

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

iOS: mWeb Safari

mSafari.mov

MacOS: Chrome / Safari

chrome.mov

MacOS: Desktop

hungvu193

LGTM 🚀

pecanoro · 2024-05-24T14:56:34Z

@hayata-suenaga Do you want to final review before emerging?

hayata-suenaga

seems 🟢 to me 😄

hayata-suenaga · 2024-05-24T18:15:29Z

This is merging into the freeze branch so we can merge this

OSBotify · 2024-06-06T12:35:13Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.79-11 🚀

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

Add explicit description for each export entity

db992fd

s77rt marked this pull request as ready for review May 23, 2024 18:16

s77rt requested a review from a team as a code owner May 23, 2024 18:16

melvin-bot bot requested review from eh2077 and removed request for a team May 23, 2024 18:16

s77rt mentioned this pull request May 23, 2024

QBO: Added explicit description for each export entity #42524

Closed

50 tasks

trjExpensify requested review from pecanoro and hayata-suenaga May 23, 2024 23:07

pecanoro approved these changes May 24, 2024

View reviewed changes

hungvu193 reviewed May 24, 2024

View reviewed changes

s77rt added 2 commits May 24, 2024 06:50

Update QuickbooksOutOfPocketExpenseAccountSelectPage.tsx

f3686bf

Update QuickbooksOutOfPocketExpenseConfigurationPage.tsx

7367815

trjExpensify removed the request for review from eh2077 May 24, 2024 10:03

hungvu193 approved these changes May 24, 2024

View reviewed changes

hayata-suenaga approved these changes May 24, 2024

View reviewed changes

hayata-suenaga merged commit a85c237 into Expensify:qbo-freeze-branch May 24, 2024
16 checks passed

trjExpensify mentioned this pull request May 30, 2024

Prevent invalid configuration between location and JE selection #41638

Merged

48 tasks

hayata-suenaga mentioned this pull request May 31, 2024

QBO freeze branch #42543

Merged

49 tasks

github-actions bot mentioned this pull request Jun 4, 2024

Deploy Checklist: New Expensify 2024-06-04 #43037

Closed

melvin-bot bot mentioned this pull request Jun 6, 2024

[$250] [HOLD for payment 2024-06-13] [QBO] Amend the account type available to configure on reimbursable exports to be relevant to the selected export option #42520

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

QBO: Add explicit description for each export entity #42548

QBO: Add explicit description for each export entity #42548

s77rt commented May 23, 2024 •

edited

Loading

melvin-bot bot commented May 23, 2024

trjExpensify commented May 24, 2024

hungvu193 commented May 24, 2024

hungvu193 commented May 24, 2024 •

edited

Loading

hungvu193 May 24, 2024

hungvu193 May 24, 2024

s77rt commented May 24, 2024

hungvu193 commented May 24, 2024

hungvu193 commented May 24, 2024

s77rt commented May 24, 2024

hungvu193 commented May 24, 2024

hungvu193 left a comment

pecanoro commented May 24, 2024

hayata-suenaga left a comment

hayata-suenaga commented May 24, 2024

OSBotify commented Jun 6, 2024

QBO: Add explicit description for each export entity #42548

QBO: Add explicit description for each export entity #42548

Conversation

s77rt commented May 23, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 23, 2024

trjExpensify commented May 24, 2024

hungvu193 commented May 24, 2024

hungvu193 commented May 24, 2024 • edited Loading

hungvu193 May 24, 2024

Choose a reason for hiding this comment

hungvu193 May 24, 2024

Choose a reason for hiding this comment

s77rt commented May 24, 2024

hungvu193 commented May 24, 2024

hungvu193 commented May 24, 2024

s77rt commented May 24, 2024

hungvu193 commented May 24, 2024

Reviewer Checklist

Screenshots/Videos

hungvu193 left a comment

Choose a reason for hiding this comment

pecanoro commented May 24, 2024

hayata-suenaga left a comment

Choose a reason for hiding this comment

hayata-suenaga commented May 24, 2024

OSBotify commented Jun 6, 2024

s77rt commented May 23, 2024 •

edited

Loading

hungvu193 commented May 24, 2024 •

edited

Loading