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

[#Wave-Control: Add NetSuite]: Added NetSuite connect button and fixed copies #44218

Merged
merged 32 commits into from
Jun 27, 2024

Conversation

mananjadhav
Copy link
Collaborator

@mananjadhav mananjadhav commented Jun 23, 2024

Details

While adding the ConnectToNetSuiteButton component, I found several hardcoded copies for Xero and QBO. This could cause problems when we add NetSuite and other integrations. For instance, when connecting to Xero with existing NetSuite connection it would show: Are you sure you want to disconnect QuickBooks Online to set up Xero.

Hence to avoid clutter in the Token input PR, I created this PR to fix all copies and add the connect button for NetSuite.

Fixed Issues

$ #43434
PROPOSAL:

Pre-requisites:

  1. Collect workspace with accounting enabled.
  2. NetSuite beta enabled for the user. You can return true in the canUseNetSuiteIntegration method.
  3. Setup the netsuite data linked in the comment here for the given workspace as connections: {netsuite: <linkedjson>}, when we need to test disconnect NetSuite.

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", ....})
   }, []);

Tests

  1. Open the workspace with accounting enabled.
  2. Have atleast one connection integrated (I'll take NetSuite in my test steps).
  3. Click on the three dots menu next to the integrated connection and click on Disconnect.
  4. Verify the title and subtitle of the disconnect prompt is of the format:

title: Disconnect {currentIntegrationName}
subtitle: Are you sure you want to disconnect {currentIntegrationName}?

image
  1. Click on Other integrations section.
  2. Click on Connect for any other integration, I'll take Xero.
  3. It should show the connect modal with the title and the subtitle of the format:

title: Connect [Accounting Integration]
subtitle: Are you sure you want to connect to [Accounting Integration]? This will remove any existing accounting connections.

image
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Test steps.

  • 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-connect-modal android-disconnect-modal
Android: mWeb Chrome
mweb-chrome-connect-content.mov
iOS: Native ios-disconnect-modal ios-connect-modal
iOS: mWeb Safari mweb-safari-disconnect-modal mweb-safari-connect-modal
MacOS: Chrome / Safari
web-connect-button-content.mov
MacOS: Desktop
desktop-connect-button-content.mov

@mananjadhav mananjadhav changed the title [#Wave-Control: Add NetSuite]: Added NetSuite connect button and fixed bugs [#Wave-Control: Add NetSuite]: Added NetSuite connect button and fixed copies Jun 23, 2024
@mananjadhav mananjadhav changed the title [#Wave-Control: Add NetSuite]: Added NetSuite connect button and fixed copies [Hold #44038][#Wave-Control: Add NetSuite]: Added NetSuite connect button and fixed copies Jun 23, 2024
@mananjadhav mananjadhav marked this pull request as ready for review June 23, 2024 01:49
@mananjadhav mananjadhav requested review from a team as code owners June 23, 2024 01:49
@melvin-bot melvin-bot bot removed the request for review from a team June 23, 2024 01:49
Copy link

melvin-bot bot commented Jun 23, 2024

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

@melvin-bot melvin-bot bot requested a review from ishpaul777 June 23, 2024 01:49
@mananjadhav
Copy link
Collaborator Author

@ishpaul777 You can ignore this PR.

@yuwenmemon @shubham1206agra The PR can be reviewed after we merge the subsidiary PR. I posted a message with a question here.

@Expensify/design for the copy on the disconnect modals.

@dubielzyk-expensify
Copy link
Contributor

Visually it looks good. Might lack context, but looping in @jamesdeanexpensify for copy check :)

@jamesdeanexpensify
Copy link
Contributor

Chatting here!

@jamesdeanexpensify
Copy link
Contributor

jamesdeanexpensify commented Jun 24, 2024

Here is where we landed:

Connect [Accounting Integration]
Are you sure you want to connect [Accounting Integration]? This will remove any existing accounting connections.

@mananjadhav
Copy link
Collaborator Author

@jamesdeanexpensify Can you also share the Spanish translation?

@jamesdeanexpensify
Copy link
Contributor

Connect [Accounting Integration]
Are you sure you want to connect to [Accounting Integration]? This will remove any existing accounting connections.

Conectar [Accounting Integration]
¿Estás seguro de que quieres conectar a [Accounting Integration]? Esto eliminará cualquier conexión contable existente.

@mananjadhav
Copy link
Collaborator Author

Yes @jamesdeanexpensify

@mananjadhav mananjadhav mentioned this pull request Jun 27, 2024
48 tasks
@mananjadhav mananjadhav changed the title [Hold #44038][#Wave-Control: Add NetSuite]: Added NetSuite connect button and fixed copies [#Wave-Control: Add NetSuite]: Added NetSuite connect button and fixed copies Jun 27, 2024
@mananjadhav
Copy link
Collaborator Author

@shubham1206agra @yuwenmemon @Expensify/design @jamesdeanexpensify This is ready for review.

@shubham1206agra
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
Screen.Recording.2024-06-28.at.12.10.43.AM.mov
iOS: Native
Screen.Recording.2024-06-28.at.12.30.55.AM.mov
iOS: mWeb Safari
Screen.Recording.2024-06-28.at.12.08.05.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-06-28.at.12.06.44.AM.mov
MacOS: Desktop
Screen.Recording.2024-06-28.at.12.13.09.AM.mov

@melvin-bot melvin-bot bot requested a review from yuwenmemon June 27, 2024 19:06
src/CONST.ts Outdated
@@ -1794,6 +1794,11 @@ const CONST = {
XERO: 'xero',
NETSUITE: 'netsuite',
},
NAME_MAP: {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
NAME_MAP: {
NAME_USER_FRIENDLY: {

This will match the constant names we use in the API and is also more intuitive.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Okay updated.

syncError: (integration?: ConnectionName): string => {
switch (integration) {
case CONST.POLICY.CONNECTIONS.NAME.QBO:
return "Can't connect to QuickBooks Online.";
case CONST.POLICY.CONNECTIONS.NAME.XERO:
return "Can't connect to Xero.";
case CONST.POLICY.CONNECTIONS.NAME.NETSUITE:
return "Can't connec to NetSuite";
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
return "Can't connec to NetSuite";
return "Can't connect to NetSuite.";

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good eye!!

Comment on lines 2438 to 2439
const integrationName = integration && CONST.POLICY.CONNECTIONS.NAME_MAP[integration] ? CONST.POLICY.CONNECTIONS.NAME_MAP[integration] : 'integration';
return `Disconnect ${integrationName}`;
Copy link
Contributor

Choose a reason for hiding this comment

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

Can this be simplified down to:

Suggested change
const integrationName = integration && CONST.POLICY.CONNECTIONS.NAME_MAP[integration] ? CONST.POLICY.CONNECTIONS.NAME_MAP[integration] : 'integration';
return `Disconnect ${integrationName}`;
return `Disconnect ${CONST.POLICY.CONNECTIONS.NAME_MAP[integration] ?? 'integration'}`;

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Get a TS error. Hence I had to use this way.

Screenshot 2024-06-28 at 2 20 50 AM

Copy link
Contributor

Choose a reason for hiding this comment

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

Can we just be strict with the types for the function?

            disconnectPrompt: (currentIntegration: ConnectionName): string => `Are you sure you want to disconnect ${CONST.POLICY.CONNECTIONS.NAME_USER_FRIENDLY[currentIntegration] ?? 'integration'}?`},

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good point, let me check if it has any other usage. I can update. Give me a few mins.

Copy link
Collaborator Author

@mananjadhav mananjadhav Jun 27, 2024

Choose a reason for hiding this comment

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

I was able to update it for connectTitle. For disconnectTitle, it allows undefined.

Argument of type 'PolicyConnectionName | undefined' is not assignable to parameter of type 'keyof Connections'.\n Type 'undefined' is not assignable to type 'keyof Connections'.

Comment on lines 2442 to 2445
const integrationName =
integrationToConnect && CONST.POLICY.CONNECTIONS.NAME_MAP[integrationToConnect] ? CONST.POLICY.CONNECTIONS.NAME_MAP[integrationToConnect] : 'accounting integration';
return `Connect ${integrationName}`;
},
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Responded. #44218 (comment)

Comment on lines 2474 to 2481
const integrationName =
currentIntegration && CONST.POLICY.CONNECTIONS.NAME_MAP[currentIntegration] ? CONST.POLICY.CONNECTIONS.NAME_MAP[currentIntegration] : 'this integration';
return `Are you sure you want to disconnect ${integrationName}?`;
},
connectPrompt: (integrationToConnect?: ConnectionName): string => {
const integrationName =
integrationToConnect && CONST.POLICY.CONNECTIONS.NAME_MAP[integrationToConnect] ? CONST.POLICY.CONNECTIONS.NAME_MAP[integrationToConnect] : 'this accounting integration';
return `Are you sure you want to connect ${integrationName}? This will remove any existing acounting connections.`;
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Responded #44218 (comment).

},
syncError: (integration?: ConnectionName): string => {
switch (integration) {
case CONST.POLICY.CONNECTIONS.NAME.QBO:
return 'No se puede conectar a QuickBooks Online.';
case CONST.POLICY.CONNECTIONS.NAME.XERO:
return 'No se puede conectar a Xero';
case CONST.POLICY.CONNECTIONS.NAME.NETSUITE:
return 'No se puede conectar a NetSuite';
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
return 'No se puede conectar a NetSuite';
return 'No se puede conectar a NetSuite.';

Let's also add the punctuation for the Xero copy above.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Added.

@mananjadhav mananjadhav requested a review from yuwenmemon June 27, 2024 20:56
@yuwenmemon yuwenmemon merged commit 0aad889 into Expensify:main Jun 27, 2024
15 checks passed
@OSBotify
Copy link
Contributor

✋ 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 Jul 3, 2024

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.3-7 🚀

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

@OSBotify
Copy link
Contributor

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

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants