[#Wave-Control: Add NetSuite]: Settings Configuration in NewDot: Import List #44663

mananjadhav · 2024-06-30T01:12:08Z

Details

Covers the implementation of Import options page.

This is one of the FE PRs for NetSuite without the proper auth flow integrated. Hence, to get this working we'll need to have a few pre-requisites:

Collect workspace with accounting enabled.
NetSuite beta enabled for the user. You can return true in the canUseNetSuiteIntegration method.
Setup the netsuite data linked in the comment here for the given workspace as connections: {netsuite: <linkedjson>}.

One way I did the setup is calling Onyx.merge with useEffect on any FE component.
   useEffect(() => {
       Onyx.merge(`${ONYXKEYS.COLLECTION.POLICY}76A10AB364F95DA0`, {"connections":{"netsuite":{"accountID":"TSTDRV1668486", ....})
   }, []);

Fixed Issues

$ #43437
PROPOSAL:

Tests

Open the app with the pre-setup workspace.
Go to Accounting from the LHS
Verify that you're able to see Net Suite in the active connections along with the Oracle NetSuite logo.
Click on the Import button.
Verify that the list of options appear as per the linked design doc.
Ensure the following:
a. Selected subsidiary shows up as the subtitle of the page
b. Expense categories is locked switched
c. For each of the fields departments, locations, etc. the title along with the selected value shows up.
d. For point c, if the value is not set then it should show NetSuite employee default.
e. Tax switch shows up based on the syncTax field.
f. Custom segments/records and Custom lists button show up. (won't have any action linked to it).
Test the toggle of Tax switch and verify that syncTax is updated based on the switch value.
In case of the API error, there should be an error message below the switch.

Verify that no errors appear in the JS console

Offline tests

Same as Test Steps. The optimistic update shows up, but it won't be greyed out as that logic is pending.

QA Steps

Same as Test steps.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android-netsuite-import-options.mov

Android: mWeb Chrome

mweb-chrome-netsuite-import-options.mov

iOS: Native

ios-netsuite-import-options.mov

iOS: mWeb Safari

mweb-safari-netsuite-import-options.mov

MacOS: Chrome / Safari

Video

web-netsuite-import-options-video.mov

Screenshot

Tax Error RBR

Sync Tax Condition

web-sync-tax-condition.mov

MacOS: Desktop

desktop-netsuite-import-options.mov

src/CONST.ts

src/languages/en.ts

src/languages/es.ts

src/libs/API/parameters/UpdateNetSuiteSyncTaxConfigurationParams.ts

mananjadhav · 2024-06-30T02:52:54Z

src/libs/actions/connections/NetSuiteCommands.ts

+                                    syncOptions: {
+                                        syncTax: isSyncTaxEnabled,
+                                    },
+                                    // pendingFields: {


This is throwing type errors due to nesting. Will fix this in upcoming PRs.

Sounds good, but then can we make the comment more descriptive than simply "Fixing in the future PR"?

src/libs/actions/connections/NetSuiteCommands.ts

src/pages/workspace/accounting/netsuite/import/NetSuiteImportPage.tsx

mananjadhav · 2024-06-30T03:09:06Z

@Expensify/design You'll notice a small difference in the screenshots for alignment of switch and right arrow icon in the options when compared to the design doc. This is intentional because I am reusing styles that are added to other integrations like QBO. Attaching screenshot.

Design Doc NetSuite switch and right arrow alignment. They're right aligned (flex-end)

NetSuite switch and right arrow alignment

QBO switch and right arrow Alignment

melvin-bot · 2024-06-30T03:42:16Z

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

mananjadhav · 2024-06-30T03:43:03Z

@abdulrahuman5196 Please ignore this PR.

@shubham1206agra @yuwenmemon Will take care of this.

cc - @Expensify/design for your review. Only list of options as a part of this PR.

src/libs/API/types.ts

dannymcclain · 2024-07-01T13:17:53Z

@mananjadhav while I agree we should just reuse styles here to make all the integrations similar, why do the NetSuite and QBO push rows have more padding on the right? Why don't those right carets > sit in the same place as all our other push input rows?

mananjadhav · 2024-07-01T13:39:41Z

Why don't those right carets > sit in the same place as all our other push input rows?

Honestly I haven't applied any specific styling for the list. I've just implemented the default components. Can you give me an example of other places where they're aligned to right?

shawnborton · 2024-07-01T13:41:54Z

Dang, maybe that's just how we have them implemented then? Like a big hit box with padding around the actual icon or something?

mananjadhav · 2024-07-01T13:44:18Z

Dang, maybe that's just how we have them implemented then? Like a big hit box with padding around the actual icon or something?

I am not sure. Hence I am asking for reference. I checked at a few places and it matches my implementation. I've shared an example for QBO already. Here are some example from other pages - Subscription and Preference.

dannymcclain · 2024-07-01T14:01:40Z

Dang, maybe that's just how we have them implemented then? Like a big hit box with padding around the actual icon or something?

Yeah I went cruising through the app to get an example of a "regular" one in the RHP, and I believe this is just how they're implemented in the product right now.

@mananjadhav so let's not customize anything for these.

@shawnborton we should maybe consider trying to update these globally to match what we have in Figma.

Some current, in-product examples (these are all in various RHPs):

mananjadhav · 2024-07-01T14:03:19Z

@mananjadhav so let's not customize anything for these.

Noted. Thanks @dannymcclain. Can you and @shawnborton help with rest of the design review?

mananjadhav · 2024-07-01T21:16:30Z

~~Pending two questions and translations, this is ready for review.~~ Pending translations. Rest ready for review.

…port-list-screen

src/libs/PolicyUtils.ts

shubham1206agra · 2024-07-02T13:15:15Z

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

Screen.Recording.2024-07-02.at.6.33.17.PM.mov

iOS: Native

Screen.Recording.2024-07-02.at.6.38.54.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-07-02.at.6.28.16.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-02.at.6.27.04.PM.mov

MacOS: Desktop

Screen.Recording.2024-07-02.at.6.35.39.PM.mov

src/libs/actions/connections/NetSuiteCommands.ts

src/CONST.ts

src/ROUTES.ts

yuwenmemon · 2024-07-02T18:40:41Z

src/ROUTES.ts

@@ -940,6 +940,10 @@ const ROUTES = {
        route: 'settings/workspaces/:policyID/accounting/net-suite/subsidiary-selector',


NAB: We should update these to be consistent at some point:

Suggested change

route: 'settings/workspaces/:policyID/accounting/net-suite/subsidiary-selector',

route: 'settings/workspaces/:policyID/accounting/netsuite/subsidiary-selector',

In fact this is broken looking at the line below: https://github.com/Expensify/App/pull/44663/files#diff-6bf4223547606b393fe6164e58be4ce31148526f088e3710737115ba4c256f3cR322

So maybe let's just fix it here.

yuwenmemon · 2024-07-02T18:41:43Z

src/languages/en.ts

+                expenseCategories: `Expense categories`,
+                expenseCategoriesDescription: `NetSuite expense categories import into Expensify as categories.`,


Suggested change

expenseCategories: `Expense categories`,

expenseCategoriesDescription: `NetSuite expense categories import into Expensify as categories.`,

expenseCategories: 'Expense categories',

expenseCategoriesDescription: 'NetSuite expense categories import into Expensify as categories.',

yuwenmemon · 2024-07-02T18:42:30Z

src/SCREENS.ts

@@ -273,6 +273,7 @@ const SCREENS = {
            XERO_BILL_PAYMENT_ACCOUNT_SELECTOR: 'Policy_Accounting_Xero_Bill_Payment_Account_Selector',
            XERO_EXPORT_BANK_ACCOUNT_SELECT: 'Policy_Accounting_Xero_Export_Bank_Account_Select',
            NETSUITE_SUBSIDIARY_SELECTOR: 'Policy_Accounting_Net_Suite_Subsidiary_Selector',
+            NETSUITE_IMPORT: 'Policy_Accounting_Net_Suite_Import',


Suggested change

NETSUITE_IMPORT: 'Policy_Accounting_Net_Suite_Import',

NETSUITE_IMPORT: 'Policy_Accounting_NetSuite_Import',

yuwenmemon · 2024-07-02T19:00:10Z

src/libs/PolicyUtils.ts

@@ -528,6 +528,17 @@ function getNetSuiteTaxAccountOptions(policy: Policy | undefined, subsidiaryCoun
        }));
 }

+function isSyncTaxEnabled(policy: Policy | undefined): boolean {


This is trying to do the same thing as canUseTaxNetSuite below - can we just reuse that method instead? Also the name is misleading here.

Okay I received the same feedback from @shubham1206agra. This method is not dependent on canUseNetSuiteUSATax (!!betas?.includes(CONST.BETAS.NETSUITE_USA_TAX)). Hence I created a new one. If the logic is the same I'll use that.

I've updated to use canUseNetSuiteUSATax

yuwenmemon · 2024-07-02T19:01:00Z

src/libs/actions/connections/NetSuiteCommands.ts

+                                    syncOptions: {
+                                        syncTax: isSyncTaxEnabled,
+                                    },
+                                    // pendingFields: {


Sounds good, but then can we make the comment more descriptive than simply "Fixing in the future PR"?

yuwenmemon · 2024-07-02T19:03:53Z

src/pages/workspace/accounting/netsuite/import/NetSuiteImportPage.tsx

+
+    const policyID = policy?.id ?? '-1';
+    const config = policy?.connections?.netsuite?.options.config;
+    const importFields = CONST.NETSUITE_CONFIG.IMPORT_FIELDS;


NAB: Can we just use the constant directly in the code? Especially because I see we use this just once.

yuwenmemon · 2024-07-02T19:04:02Z

src/pages/workspace/accounting/netsuite/import/NetSuiteImportPage.tsx

+    const policyID = policy?.id ?? '-1';
+    const config = policy?.connections?.netsuite?.options.config;
+    const importFields = CONST.NETSUITE_CONFIG.IMPORT_FIELDS;
+    const importCustomFields = CONST.NETSUITE_CONFIG.IMPORT_CUSTOM_FIELDS;


NAB: Same as above.

yuwenmemon

Thanks!

OSBotify · 2024-07-02T19:52:05Z

✋ 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 · 2024-07-03T20:03:39Z

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 9.0.4-0 🚀

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

OSBotify · 2024-07-04T22:16:06Z

🚀 Cherry-picked to staging by https://github.com/tgolen in version: 9.0.4-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-10T11:04:59Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

OSBotify · 2024-07-15T20:23:23Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.6-8 🚀

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

mananjadhav added 6 commits June 30, 2024 06:36

feat: added import route

1b9a19d

feat: import fields and expense categories list added

2d782fd

feat: custom list and tax options

9b865aa

feat: added api setup

ef9426f

feat: api call without pending action

1e49875

refactor: run prettier

d0d3afd

mananjadhav changed the title ~~[#Wave-Control: Add NetSuite]: Settings Configuration in NewDot: Import~~ [#Wave-Control: Add NetSuite]: Settings Configuration in NewDot: Import List Jun 30, 2024