Skip to content

fix: categories subtitle shows undefined settings when there is sync error - #49972

Merged
justinpersaud merged 9 commits into
Expensify:mainfrom
mkzie2:mkzie2-issue-49394
Oct 18, 2024
Merged

justinpersaud merged 9 commits into
Expensify:mainfrom
mkzie2:mkzie2-issue-49394

Conversation

@mkzie2

@mkzie2 mkzie2 commented Oct 1, 2024 •

Copy link
Copy Markdown
Contributor

Details

This PR:

  • On workspace settings pages (categories, tags, taxes and report fields), not shows imported from [integration] settings text when having integration sync error
  • On workspace accounting page, shows the Go to Expensify Classic to manage your settings. text when synced with unsupported integration

Fixed Issues

$ #49394
PROPOSAL: #49394 (comment)

Tests

  1. In OD, try to connect to Quickbooks Desktop but do not complete the set up to trigger error
  2. In ND, open workspace settings > Categories
  3. Verify Get a better overview of where money is being spent... message shows

  1. Install QuickBooks Desktop here
  2. In OD, connect to QuickBooks Desktop successfully following this
  3. In ND, open workspace settings > Categories
  4. Verify The categories below are imported from Quickbooks Desktop settings. message shows
  5. Press Quickbooks Desktop settings
  6. Verify Go to Expensify Classic to manage your settings. message shows without any integration menu (Import, Export, Advanced...) or error message
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

See 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

Screenshot_1727831055
Screenshot_1727831061


Screenshot_1727831164
Screenshot_1727831169

iOS: Native

Simulator Screenshot - iPhone 16 Pro Max - 2024-10-02 at 08 00 16
Simulator Screenshot - iPhone 16 Pro Max - 2024-10-02 at 08 00 24

Simulator Screenshot - iPhone 16 Pro Max - 2024-10-02 at 08 07 00

Simulator Screenshot - iPhone 16 Pro Max - 2024-10-02 at 08 06 55

iOS: mWeb Safari

Simulator Screenshot - iPhone 16 Pro Max - 2024-10-02 at 08 02 24
Simulator Screenshot - iPhone 16 Pro Max - 2024-10-02 at 08 02 31

Simulator Screenshot - iPhone 16 Pro Max - 2024-10-02 at 08 11 44
Simulator Screenshot - iPhone 16 Pro Max - 2024-10-02 at 08 11 49

MacOS: Chrome / Safari
Screen.Recording.2024-10-02.at.07.42.18.mov
Screen.Recording.2024-10-02.at.14.39.47.mov
MacOS: Desktop

Screenshot 2024-10-02 at 07 59 20
Screenshot 2024-10-02 at 07 59 18
Screenshot 2024-10-02 at 08 16 22
Screenshot 2024-10-02 at 08 16 20

@mkzie2
mkzie2 marked this pull request as ready for review October 2, 2024 01:18
@mkzie2
mkzie2 requested a review from a team as a code owner October 2, 2024 01:18
@melvin-bot
melvin-bot Bot requested review from brunovjk and removed request for a team October 2, 2024 01:18
@melvin-bot

melvin-bot Bot commented Oct 2, 2024

Copy link
Copy Markdown

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

@brunovjk

brunovjk commented Oct 2, 2024

Copy link
Copy Markdown
Contributor

@mkzie2 were we able to resolve the type error? I'll fill out the checklist after. Thank you :D

@mkzie2

mkzie2 commented Oct 4, 2024

Copy link
Copy Markdown
Contributor Author

@brunovjk Done.

@brunovjk

brunovjk commented Oct 5, 2024 •

Copy link
Copy Markdown
Contributor

Great work so far @mkzie2. I have just two points before I continue with the checklist:

1 - Do we really need to create a new CONST UNSUPPORTED_CONNECTIONS? During the week I'll come back to investigate further, mayne ask for guidance, don't worry much about it for now.
2 - I think we need to do the same for all the other tabs (check which ones need), do you agree?

pull.49972.mov

Thank you very much :D

@brunovjk

brunovjk commented Oct 8, 2024

Copy link
Copy Markdown
Contributor

Excuse @mkzie2 did you have a chance to take a look at my last comment? Thanks.

@mkzie2

mkzie2 commented Oct 10, 2024 •

Copy link
Copy Markdown
Contributor Author

Do we really need to create a new CONST UNSUPPORTED_CONNECTIONS

Yes. The purpose of this PR is to handle all unsupported integrations though I'm not sure about all their names (only Quickbooks Desktop at the moment). But if there is, we just simply add it to the list and it'll be covered.

I think we need to do the same for all the other tabs

Agree. There'll be Categories, Tags, Taxes and Report fields pages. Will update now.

Also note that the original issue: "... imported from your undefined settings" was fixed for QBD on main.

image

@brunovjk

Copy link
Copy Markdown
Contributor

Got it, thanks a lot for the clarification. Great! I'll wait for your update so I can continue with the review. Please let me know if you need anything.

Also note that the original issue: "... imported from your undefined settings" was fixed for QBD on main.

Hmm, I'll take a closer look in a bit, I wonder if it's been fixed for other tabs and connections as well? Thank you very much.

@mkzie2

mkzie2 commented Oct 10, 2024 •

Copy link
Copy Markdown
Contributor Author

I wonder if it's been fixed for other tabs and connections as well

@brunovjk This is a BE issue, it was fixed from the BE so all tabs are fixed.

@brunovjk

Copy link
Copy Markdown
Contributor

Great, very good :D thank you @mkzie2. Do you think we can close the issue then?

@mkzie2

mkzie2 commented Oct 10, 2024 •

Copy link
Copy Markdown
Contributor Author

@brunovjk Based on #49394 (comment), we have 2 requirements:

  1. Display The categories below are imported from QuickBooks Desktop (or the name of the connected integration, even if it's not yet supported) to make the messaging consistent.
  2. On the policy's accounting page, show the Go to Expensify Classic to manage your settings. text.

The undefined settings bug is just 1️⃣. We still need to fix 2️⃣.

However I have one concern: Currently, when hasSyncError, all the workspace settings like categories, tags,... has not been imported from integration settings yet but we still show the imported from ... subtitle. That's confusing.

We might not want to fix 1️⃣ but I think we SHOULD fix the issue I just mentioned. The solution is already implemented by this change.

Wdyt?

@brunovjk

brunovjk commented Oct 10, 2024 •

Copy link
Copy Markdown
Contributor

However I have one concern: Currently, when hasSyncError, all the workspace settings like categories, tags,... has not been imported from integration settings yet but we still show the imported from ... subtitle. That's confusing.

We might not want to fix 1️⃣ but I think we SHOULD fix the issue I just mentioned. The solution is already implemented by this change.

Wdyt?

I agree 100%! Let's stick with the plan :D Maybe we need to update the PR details and test steps? Let me know when I can test it, Thank you.

@mkzie2

mkzie2 commented Oct 10, 2024

Copy link
Copy Markdown
Contributor Author

@brunovjk These test steps in PR description already covered that case:

Screenshot 2024-10-10 at 18 24 29

I applied changes to other tabs, you can start testing now.

@brunovjk

Copy link
Copy Markdown
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
49972_android_native.mov
Android: mWeb Chrome
49972_android_mweb.mov
iOS: Native
49972_ios_native.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
49972_web_chorme.mov
MacOS: Desktop
49972_web_desktop.mov

@brunovjk brunovjk left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overall the changes seem good to me, however I still wonder if do we need to specify in PolicyUtils.getCurrentConnectionName that we accept includeUnsupportedConnection, nor create a CONST for it. @mkzie2 explained why we need it here, but I would like to know your opinion on this @justinpersaud. Thank you.

@melvin-bot
melvin-bot Bot requested a review from justinpersaud October 10, 2024 14:37
@mkzie2

mkzie2 commented Oct 11, 2024 •

Copy link
Copy Markdown
Contributor Author

@justinpersaud TL;DR One of the original issues ("imported from undefined settings" text when integrating QBD) was fixed in BE so basically we won't need the changes that @brunovjk mentioned above.

But if we want to prevent future unsupported integrations (QBD used to be unsupported) from reintroducing the undefined text issue, we SHOULD keep those changes.

@justinpersaud

Copy link
Copy Markdown
Contributor

I was just looking internally and it's likely because we just finished supporting Quickbooks in the backend very recently.

Personally, I don't think we need to keep the code there for that as it was specific to this use case so I think you can go ahead and remove it.

@brunovjk

Copy link
Copy Markdown
Contributor

Great! I agree 100% thank you @justinpersaud :D

cc: @mkzie2

@mkzie2

mkzie2 commented Oct 16, 2024 •

Copy link
Copy Markdown
Contributor Author

@brunovjk Reverted those changes.

@brunovjk

Copy link
Copy Markdown
Contributor

Thank you very much for the changes @mkzie2. I retested and noticed a bug where even with "connection error" hasSyncError is false, this way we never show the error message. I tested with different policies and connectionSyncProgress it is always undefined:

Screen.Recording.2024-10-16.at.09.55.06.mov

I don't believe this bug is related to our PR, it seems more like an issue with the backend, but I can't confirm it. @mkzie2 did you reproduce the same bug or were you able to test everything normally? Thanks again.

@mkzie2

mkzie2 commented Oct 17, 2024

Copy link
Copy Markdown
Contributor Author

@brunovjk I do not face that problem. I got hasSyncError=true and the error was saved in policy.connections. I guess it's BE bug. Could you retry on main?

@brunovjk

Copy link
Copy Markdown
Contributor

@brunovjk I do not face that problem. I got hasSyncError=true and the error was saved in policy.connections. I guess it's BE bug. Could you retry on main?

Great @mkzie2, I tested it again and this part actually works fine. However, there is one thing, even if the connection is not fully completed in OldDot we initially treat it as if it was successfully completed in NewDot, but we have not yet finished the setup. This leads to a bug where, if in OldDot you close the page before completing the setup, in NewDot we treat it as if it was completed:

Screen.Recording.2024-10-17.at.08.04.09.mov

Do you think we can/should fix this through FE? Thanks a lot.

cc: @justinpersaud

@justinpersaud

Copy link
Copy Markdown
Contributor

Hmm that is pretty minor but I will get a second opinion

@brunovjk

brunovjk commented Oct 18, 2024 •

Copy link
Copy Markdown
Contributor

Great, besides that everything looks good here @justinpersaud :D Thanks.

@lakchote

Copy link
Copy Markdown
Contributor

I do agree with @justinpersaud it's pretty minor and not a blocker, as the user will complete the setup on NewDot eventually from start to finish when everyone is migrated there. And if an user is on OldDot, he'll complete the flow on OldDot either way and will not have the issue once he's migrated to NewDot. cc @hoangzinh so you're aware of this too.

By the way @brunovjk, the error messages weren't correctly pushed to the frontend, it's now the case and wasn't related to this PR.

@justinpersaud
justinpersaud merged commit 40e2230 into Expensify:main Oct 18, 2024
@OSBotify

Copy link
Copy Markdown
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.

@github-actions github-actions Bot mentioned this pull request Oct 18, 2024
59 tasks done
@github-actions

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/justinpersaud in version: 9.0.51-1 🚀

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

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.51-4 🚀

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

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.51-4 🚀

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.

5 participants