Fix Sage Intacct entity is not shown on Connections card by SzymczakJ · Pull Request #46487 · Expensify/App

SzymczakJ · 2024-07-30T11:17:15Z

Details

Fixed Issues

$ #45935
PROPOSAL: N/A

Tests

Head to Workspace settings
Head to Accounting
Connect to Sage Intacct
Verify that Top level is shown as entity
Try changing entity and veirfy that it works

Offline tests

QA Steps

Same as tests

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

Android: mWeb Chrome

andoirweb.mov

iOS: Native

ios.mov

iOS: mWeb Safari

iosweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

war-in · 2024-07-31T08:37:21Z

src/languages/en.ts

                        case 'intacctImportTitle':
                            return 'Importing Sage Intacct data';
                        default: {
+                            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions


Why do we need this line now? 🤔

+1 @SzymczakJ do you have a reason for this one?

war-in · 2024-07-31T08:38:50Z

src/languages/es.ts

Should we also update the syncStageName here?

war-in · 2024-07-31T08:47:19Z

src/pages/workspace/accounting/PolicyAccountingPage.tsx

                          description: translate('workspace.intacct.entity'),
                          iconRight: Expensicons.ArrowRight,
-                          title: getCurrentSageIntacctEntityName(policy),
+                          title: getCurrentSageIntacctEntityName(policy) ?? translate('workspace.common.topLevel'),


We should modify getCurrentSageIntacctEntityName function to return top level as a default

melvin-bot · 2024-07-31T16:15:22Z

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

SzymczakJ · 2024-07-31T17:36:53Z

@hungvu193 since you have context, can you take a look? 🙏

hungvu193 · 2024-07-31T23:44:12Z

Sure 👍

hungvu193 · 2024-08-01T07:19:18Z

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

Screen.Recording.2024-08-01.at.14.18.52.mov

Android: mWeb Chrome

Screen.Recording.2024-08-01.at.14.16.03.mov

iOS: Native

Screen.Recording.2024-08-01.at.14.07.54.mov

iOS: mWeb Safari

Screen.Recording.2024-08-01.at.14.09.26.mov

MacOS: Chrome / Safari

Chrome.mov

MacOS: Desktop

Screen.Recording.2024-08-01.at.13.36.57.mov

hungvu193

LGTM 🚀

melvin-bot · 2024-08-01T07:19:36Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #45935 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

hungvu193 · 2024-08-01T07:20:43Z

All yours @tgolen

tgolen · 2024-08-01T16:06:38Z

src/languages/en.ts

                        case 'intacctImportTitle':
                            return 'Importing Sage Intacct data';
                        default: {
+                            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions


+1 @SzymczakJ do you have a reason for this one?

tgolen · 2024-08-01T16:07:10Z

src/languages/en.ts

                            return 'Marking NetSuite bills and invoices as paid';
                        case 'intacctCheckConnection':
                            return 'Checking Sage Intacct connection';
+                        case 'intacctImportDimensions':


This looks like it's missing a corresponding change in es.ts

I checked es.ts and this key already existed

Yeah, I noticed it when connecting to Sage Intacct. It showed "Translation missing for stage: intacctImportDimensions", so decided to fix it before somebody else notices this bug.

Nice. Thanks for fixing that!

tgolen · 2024-08-01T16:09:55Z

src/libs/PolicyUtils.ts

 }

-function getCurrentSageIntacctEntityName(policy?: Policy): string | undefined {
+function getCurrentSageIntacctEntityName(policy: Policy | undefined, translate: LocaleContextProps['translate']): string | undefined {


I think it's really strange to be passing the translate function as a parameter. I'd prefer returning early in the method when there is no currentEntityID and having the calling function deal with the return value (maybe it should return null).

Or my second suggestion would be to add a param to getCurrentSageIntacctEntityName() which is called defaultNameIfNoEntity and it would be called like:

getCurrentSageIntacctEntityName(policy, translate('workspace.common.topLevel'))

Yes, I think I like this approach the best.

I have same thoughts with you initially, however after checking source code I see we also used "translate" as a function param in other places, so I think I'm fine with this current changes.

Or we can do somethings like this:

getCurrentSageIntacctEntityName(policy) ?? translate("topLevel")

Or we can do somethings like this:

getCurrentSageIntacctEntityName(policy) ?? translate("topLevel")

I thought about that too but we would have to repeat it every time we use getCurrentSageIntacctEntityName function. It'd be better to handle this case inside the function

To be clear, I don't think we should be doing that in the other places either. I think that translations are just a concern of the display and so they should only be handled in display components. Let's not keep spreading that concern out all over the app.

SzymczakJ · 2024-08-02T08:46:24Z

+1 @SzymczakJ do you have a reason for this one?

It's because of typescript and a rule that requires a switch to have a default:. I've defined a case for every possible entry, so typescript knows that stage type is never, and this cannot be part of string template.

But when BE will return some new string, then we will need that default case.

tgolen · 2024-08-02T13:08:09Z

src/languages/en.ts

                            return 'Marking NetSuite bills and invoices as paid';
                        case 'intacctCheckConnection':
                            return 'Checking Sage Intacct connection';
+                        case 'intacctImportDimensions':


Nice. Thanks for fixing that!

OSBotify · 2024-08-02T13:22:14Z

✋ 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-08-06T04:28:26Z

🚀 Deployed to staging by https://github.com/tgolen in version: 9.0.17-0 🚀

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

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

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

OSBotify · 2024-08-08T04:53:53Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

OSBotify · 2024-08-08T20:05:17Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

SzymczakJ added 4 commits July 30, 2024 12:38

map empty entity to top level

7d342ce

add intacctImportDimensions translation

90b3b9d

add spanish translation

70d4ae2

fix lint

6900273

war-in approved these changes Jul 31, 2024

View reviewed changes

fix PR comments

523591e

SzymczakJ marked this pull request as ready for review July 31, 2024 16:15

SzymczakJ requested a review from a team as a code owner July 31, 2024 16:15

melvin-bot bot requested review from eh2077 and removed request for a team July 31, 2024 16:15

hungvu193 approved these changes Aug 1, 2024

View reviewed changes

tgolen requested changes Aug 1, 2024

View reviewed changes

Merge branch 'main' into @szymczak/sage-intacct-entity-bug

00c06df

fix PR comments

c2f4b81

SzymczakJ requested a review from tgolen August 2, 2024 12:27

tgolen approved these changes Aug 2, 2024

View reviewed changes

tgolen merged commit 49435db into Expensify:main Aug 2, 2024

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

Deploy Checklist: New Expensify 2024-08-06 #46849

Closed

83 tasks

melvin-bot bot mentioned this pull request Aug 7, 2024

[$250] BUG: Sage Intacct subsidiary is not shown on Connections card under Sage Intacct logo #45935

Closed

SzymczakJ deleted the @szymczak/sage-intacct-entity-bug branch April 8, 2025 09:12

Conversation

SzymczakJ commented Jul 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Jul 31, 2024

Uh oh!

SzymczakJ commented Jul 31, 2024

Uh oh!

hungvu193 commented Jul 31, 2024

Uh oh!

hungvu193 commented Aug 1, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

hungvu193 left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Aug 1, 2024

Uh oh!

hungvu193 commented Aug 1, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hungvu193 Aug 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SzymczakJ commented Aug 2, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Aug 2, 2024

Uh oh!

OSBotify commented Aug 6, 2024

Uh oh!

OSBotify commented Aug 7, 2024

Uh oh!

OSBotify commented Aug 8, 2024

Uh oh!

OSBotify commented Aug 8, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

SzymczakJ commented Jul 30, 2024 •

edited

Loading

hungvu193 Aug 1, 2024 •

edited

Loading