Refactor UpdatePolicyConnectionConfiguration to be 1:1:1 (Part 1) #46234

dangrous · 2024-07-25T20:38:05Z

Details

There should be no user facing changes with this PR, it is only changing the API commands.

I also updated the spelling of Quickbooks to be consistent in the code (lowercase b), even though that's not how it is officially in user-facing stuff.

Fixed Issues

https://github.com/Expensify/Expensify/issues/398335

Tests

Same as QA

Verify that no errors appear in the JS console

Offline tests

Same as QA

QA Steps

Create a Collect workspace
Connect to QBO
Once the QBO details have loaded, go to Import Settings
Click on Chart of Accounts
Toggle the "Enabled" option and ensure it works as expected and the setting is saved
Go to Export Settings
Click on "Export out-of-pocket expenses as"
Click on "Accounts payable" and select a different bank account
Ensure the setting is changed correctly
Go to Advanced Settings
Toggle Auto-create entities and ensure it works as expected and the setting is saved

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

dangrous · 2024-07-26T14:00:48Z

src/libs/actions/connections/QuickbooksOnline.ts

+import CONST from '@src/CONST';
+import ONYXKEYS from '@src/ONYXKEYS';
+
+function getQuickbooksOnlineSetupLink(policyID: string) {


getQuickbooksOnlineSetupLink is the same function as it was before - I renamed the file to match spelling; haven't changed this piece at all.

dangrous · 2024-08-08T17:16:34Z

src/libs/actions/connections/QuickbooksOnline.ts

+    });
+    return commandURL + new URLSearchParams(params).toString();
+}
+


From here down is new

melvin-bot · 2024-08-08T17:48:19Z

@ 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 · 2024-08-13T19:08:01Z

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: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-08-13.at.1.28.40.PM.mov

MacOS: Desktop

aldo-expensify · 2024-08-13T20:29:26Z

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: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

aldo-expensify

Looks good and tested well

OSBotify · 2024-08-13T20:47:53Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

zfurtak · 2024-08-14T13:19:35Z

Hello 👋 I found this PR today, while merging conflicts with mine.
Recently I've been introducing a new error and offline flow for QBO integration. (due to this issue)
In my PR I refactored most of the Quickbooks files and adjusted them to integration pattern that was introduced in other integrations.
For example, we've changed how we handle errors (see details in this thread) and when a request fails we change the value to the previous one.
Could we extract the common part of these three functions to make it easier to configure errors and not repeat the same code?
What might be helpful is to wait for my PR to be merged as it changes some logic in errors in these API calls 😊
cc @dangrous

dangrous · 2024-08-14T13:56:10Z

Hey @zfurtak! So, unfortunately, our 1:1:1 (1 user action, 1 api call from JS to PHP, 1 api call from PHP to C++) philosophy means that we can't use a generic function here. It's the first 1 that's the issue, we want each user actions to have separate API calls, and unfortunately changing each individual setting counts as a different user action.

@aldo-expensify and I also kind of agree that this is... not helpful. But we need to stick to the pattern we've decided on, which means individual requests. You can see this pattern was already worked on for NetSuite, not sure about the other integrations.

Would it be possible to make sort of a wrapper/helper function around the API call that handles the errors, maybe? like within the new UpdateQuickbooksOnlineEnableNewCategories for example, instead of calling API.write directly we call writeAndHandleErrors([data]) or something?

Sorry for the trouble, happy to discuss solutions here or in Slack! (that thread link also didn't work for me because it went to the swm slack not ours)

zfurtak · 2024-08-14T14:39:13Z

Hi @dangrous 😊 okay, I see your point!
In NetSuiteCommands.ts file there is one function: updateNetSuiteOnyxData that is called over 15 times in different functions. It would be great to have something similar in this case 😉

I hope my PR will be merged soon, it will be much easier to do it in this order 🤓

aldo-expensify · 2024-08-14T16:54:54Z

In NetSuiteCommands.ts file there is one function: updateNetSuiteOnyxData that is called over 15 times in different functions. It would be great to have something similar in this case 😉

I guess that will have to be refactored 🤮 x 1000

OSBotify · 2024-08-15T18:18:15Z

🚀 Deployed to staging by https://github.com/aldo-expensify in version: 9.0.21-0 🚀

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

OSBotify · 2024-08-19T15:59:19Z

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.21-4 🚀

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

OSBotify · 2024-08-19T16:23:43Z

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.21-4 🚀

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

dangrous added 2 commits July 25, 2024 16:32

first draft of new UpdateQuickbooksOnlineEnableNewCategories

ca23a6c

revert changes to gemfile.lock

a808c9d

dangrous self-assigned this Jul 25, 2024

dangrous added 3 commits July 25, 2024 16:46

typescript fixes

fc14079

standardize spelling in code

3d21aad

actually change name of file, stupid case insensitive git

8dadb84

dangrous commented Jul 26, 2024

View reviewed changes

dangrous added 8 commits August 5, 2024 14:28

add updateQuickbooksOnlineAutoCreateVendor

f04c888

add updateQuickbooksOnlineReimbursableExpensesAccount

0886e93

rename the params type correctly

58c4030

fix types

6e93f8d

add new types in list

98eceb0

only use one type for all commands

81e6b69

Merge branch 'main' into dangrous-refactorupdatepolicyconnectionconfig1

a93c1f5

remove unused import

11ad948

dangrous changed the title ~~[HOLD Web-E#42894] Refactor UpdatePolicyConnectionConfiguration to be 1:1:1 (Part 1)~~ Refactor UpdatePolicyConnectionConfiguration to be 1:1:1 (Part 1) Aug 8, 2024

dangrous commented Aug 8, 2024

View reviewed changes

Merge branch 'main' into dangrous-refactorupdatepolicyconnectionconfig1

e6e0042

dangrous requested a review from aldo-expensify August 8, 2024 17:19

dangrous marked this pull request as ready for review August 8, 2024 17:48

dangrous requested a review from a team as a code owner August 8, 2024 17:48

melvin-bot bot removed the request for review from a team August 8, 2024 17:48

aldo-expensify approved these changes Aug 13, 2024

View reviewed changes

aldo-expensify merged commit 76adc97 into main Aug 13, 2024
17 of 18 checks passed

aldo-expensify deleted the dangrous-refactorupdatepolicyconnectionconfig1 branch August 13, 2024 20:30

github-actions bot mentioned this pull request Aug 15, 2024

Deploy Checklist: New Expensify 2024-08-15 #47512

Closed

74 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor UpdatePolicyConnectionConfiguration to be 1:1:1 (Part 1) #46234

Refactor UpdatePolicyConnectionConfiguration to be 1:1:1 (Part 1) #46234

dangrous commented Jul 25, 2024 •

edited

Loading

dangrous Jul 26, 2024 •

edited

Loading

dangrous Aug 8, 2024

melvin-bot bot commented Aug 8, 2024

aldo-expensify commented Aug 13, 2024 •

edited

Loading

aldo-expensify commented Aug 13, 2024

aldo-expensify left a comment

OSBotify commented Aug 13, 2024

zfurtak commented Aug 14, 2024 •

edited

Loading

dangrous commented Aug 14, 2024

zfurtak commented Aug 14, 2024

aldo-expensify commented Aug 14, 2024

OSBotify commented Aug 15, 2024

OSBotify commented Aug 19, 2024

OSBotify commented Aug 19, 2024

Refactor UpdatePolicyConnectionConfiguration to be 1:1:1 (Part 1) #46234

Refactor UpdatePolicyConnectionConfiguration to be 1:1:1 (Part 1) #46234

Conversation

dangrous commented Jul 25, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

dangrous Jul 26, 2024 • edited Loading

Choose a reason for hiding this comment

dangrous Aug 8, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Aug 8, 2024

aldo-expensify commented Aug 13, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

aldo-expensify commented Aug 13, 2024

Reviewer Checklist

Screenshots/Videos

aldo-expensify left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 13, 2024

zfurtak commented Aug 14, 2024 • edited Loading

dangrous commented Aug 14, 2024

zfurtak commented Aug 14, 2024

aldo-expensify commented Aug 14, 2024

OSBotify commented Aug 15, 2024

OSBotify commented Aug 19, 2024

OSBotify commented Aug 19, 2024

dangrous commented Jul 25, 2024 •

edited

Loading

dangrous Jul 26, 2024 •

edited

Loading

aldo-expensify commented Aug 13, 2024 •

edited

Loading

zfurtak commented Aug 14, 2024 •

edited

Loading