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

Add missing multi tag view #41351

Merged
merged 27 commits into from
May 12, 2024
Merged

Conversation

s77rt
Copy link
Contributor

@s77rt s77rt commented Apr 30, 2024

Details

Fixed Issues

$ #41279
PROPOSAL:

Tests

  1. Login with an account that has accounting beta enabled
  2. Go to a workspace > More features and enable Tags and Accounting
  3. In LHN click Accounting and connect QBO
  4. Click Import and import Classes and Customers/Projects
  5. In LHN click Tags
  6. Verify you see 2 tags Classes and Customers/Projects
  7. Click on any tag
  8. Verify a RHP is opened and lists the subtags of the selected tag
  9. Verify you can click on a subtag, change its name and its enabled status
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as 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
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
web.mov
MacOS: Desktop

@s77rt s77rt mentioned this pull request Apr 30, 2024
50 tasks
@s77rt s77rt marked this pull request as ready for review April 30, 2024 19:44
@s77rt s77rt requested a review from a team as a code owner April 30, 2024 19:44
@melvin-bot melvin-bot bot requested review from rojiphil and removed request for a team April 30, 2024 19:44
Copy link

melvin-bot bot commented Apr 30, 2024

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

@trjExpensify trjExpensify requested review from ikevin127 and removed request for rojiphil April 30, 2024 20:42
@trjExpensify
Copy link
Contributor

@ikevin127 is going to jump on this for us. Thanks!

@trjExpensify
Copy link
Contributor

@s77rt did you ensure that if there's only one level of tag, the UI remains as it is today in production on the Tags page?

@s77rt
Copy link
Contributor Author

s77rt commented Apr 30, 2024

@trjExpensify Yes that area is not touched

Copy link
Contributor

@ikevin127

This comment was marked as resolved.

@trjExpensify
Copy link
Contributor

Nice work picking this up! It's testing quite well for me on that adhoc build:

2024-05-01_00-09-32.mp4

Few things to note:

  1. (This wasn't your fault, it wasn't stipulated in the doc) we should remove the checkboxes and bulk select capability in the main Tags page table when there's multiLevel tags. These options available don't make sense here:
image

CC: @dubielzyk-expensify @JmillsExpensify

  1. We intentionally don't have the Required toggle yet in the RHP, as a result of this convo and needing a new command for it. Let's not forget to follow-up with that. Issue created here for polish.

  2. When connected to QBO you shouldn't be able to Add or Delete imported values. There's an issue for it here, so that's known. @hayata-suenaga let's make sure it's taken care of in this multiTag view as well.

  3. When I disabled Classes that change on the Tags page wasn't reflected, I had to "Sync now" the connection manually to move from multiLevel to singleLevel tags. @hayata-suenaga, I think you have an issue for that here. Can you confirm it requires back-end work and can't be made external?

@ikevin127
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
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari *
Screen.Recording.2024-04-30.at.20.02.16.mov
MacOS: Desktop

Copy link
Contributor

@ikevin127 ikevin127 left a comment

Choose a reason for hiding this comment

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

I tested #41279 expected results steps:

  1. ✅ When more than one of Classes, Customers/Projects or Locations are selected for import, the Tags page table will represent each distinct tag level imported from QBO.
  2. ✅ If the tag level is required, Required will be added to the status column in the table instead of Enabled || Disabled.
  3. ✅ Behind the "Settings" button on the Tags page header in the RHP:
    3a. The toggle for "Members must tag all spend" will remain, allowing users to bulk toggle on/off making all tag levels mandatory.
    3b. ⚠️ the Custom tag name field will be removed; users will be able to set the Custom tag name a level deeper for each of the tag levels (see 4b. below).
  4. ✅ Clicking on a tag level name in the table will open the RHP, which will contain:
    4a. A Required toggle, when enabled it makes the tag level required coding on the workspace and sets Required in the main Tags page table.
    4b. ⚠️ A Custom tag name > push input row, that opens a simple "Custom tag name" page with a text input to rename the tag level.
    4c. A list of all of the tag values for that tag level (that opens up the individual tag value edit page with the same permissions and logic that exists today).
    4d. checkboxes right-aligned each of the tag values to facilitate bulk select capabilities via the [Selected X v] button with the same permissions and logic that exists today.

✅ Additionally -> Tags that are not multi-tag are working just like before.

All the steps test well and the implementation works as expected.
Regarding the ⚠️ warning points -> see details below ⬇️.

Now regarding ⚠️ issues found during testing, besides the 4 notes mentioned #41351 (comment), are the following:

  1. If we click on Classes main tag then click on any of the Classes sub-tags -> we get "Page not found" in RHP. This does not happen with the Customers/Projects main tag sub-tags.
Video - Issue 1
issue-1.mov
  1. If we click on Classes main tag, we can observe sub-tags with &amp; symbol in their name which is not decoded into & (ampersand) and we're left with sub-tag labels like R&amp;D instead of R&D. Additionally, if click on this we also get the RHP "Page not found" and the URL param looks weird as it's actually encoding the label R&amp;D which is url encoded to R%26amp%3BD instead of encoding decoded label R&D which should result in url encoded R%26D.
Video - Issue 2
issue-2.mov

❗ Now I'm not sure if these should be PR blockers or we're good to move forward despide these issues. If we're good, then we can move forward - otherwise these issues should be fixed before this is merged.

cc @roryabraham @s77rt @trjExpensify

Copy link

melvin-bot bot commented May 1, 2024

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

src/ROUTES.ts Outdated Show resolved Hide resolved
@@ -59,7 +59,7 @@ function QuickbooksImportPage({policy}: WithPolicyProps) {
},
];

if (policy?.connections?.quickbooksOnline.data.country !== CONST.COUNTRY.US) {
if (policy?.connections?.quickbooksOnline?.data?.country !== CONST.COUNTRY.US) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this change needed? TS does not report that these optional chaining operators are necessary.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah - problem here - that we have crash on this line - seem like TS types for data and country is not expecting to be undefined, but from API side it could :-)
just fyi
Screenshot 2024-05-01 at 11 59 53

Copy link
Contributor

@roryabraham roryabraham May 1, 2024

Choose a reason for hiding this comment

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

thanks for the context! Let's update the TS types for data and country to be optional then? to make sure that we're safely accessing them everywhere, not just here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have updated the type for data to be optional. We need to do the same for the Connection object: both quickbooksOnline and xero are optional. Tried to make that change here but caused ts errors on updatePolicyConnectionConfig. Let's create a separate issue to handle that

src/pages/workspace/tags/WorkspaceEditTagsPage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/tags/WorkspaceTagsPage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/tags/WorkspaceViewTagsPage.tsx Outdated Show resolved Hide resolved
}, [isFocused]);

const policyTagLists = useMemo(() => PolicyUtils.getTagLists(policyTags).filter((policy) => policy.name === currentTagListName), [currentTagListName, policyTags]);
const tagList = useMemo<PolicyForList[]>(
Copy link
Contributor

Choose a reason for hiding this comment

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

IMO this can be made much more readable, and also significantly reduce our type coercion using an implementation like this:

const tagList = useMemo<PolicyForList[]>(
        () =>
            policyTagLists
                .map((policyTagList) => Object.values(policyTagList.tags))
                .flat()
                .sort((tagA, tagB) => localeCompare(tagA.name, tagB.name))
                .map((tag) => ({
                    value: tag.name,
                    text: PolicyUtils.getCleanedTagName(tag.name),
                    keyForList: tag.name,
                    isSelected: selectedTags[tag.name],
                    pendingAction: tag.pendingAction,
                    errors: tag.errors ?? undefined,
                    enabled: tag.enabled,
                    isDisabled: tag.pendingAction === CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE,
                    rightElement: <RightElementEnabledStatus enabled={tag.enabled} />,
                })),
        [policyTagLists, selectedTags],
    );

Also, I can't help but notice that this is exactly the same as the other file. So let's DRY this up by moving it to a util function.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't get the time to look into this one. I can handle later if we don't have to merge today otherwise it can be done in a follow up

src/pages/workspace/tags/WorkspaceTagsPage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/tags/WorkspaceViewTagsPage.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

Some other high-level feedback on this PR is that it seems like there's a lot more room to optimize things:

  • don't re-create an object that shadows an array on every render, use memoization and generate them at the same time
  • don't copy-paste large segments of code. let's try to put in some work to do a reasonable amount of DRY
  • question your type casts. Try removing them and see what happens. we should often be able to rely on type inference, and if need to cast types it's often a sign that something could be simplified. For example by using native array sorting rather than lodashSortBy (which is slower and mangles types)
  • generally I try to avoid creating functions that just contain render logic and calling them on every render. Usually a better pattern is to store the JSX element(s) that we want to render in variables and use useMemo to encapsulate the more complex render logic. It's the same level of work and readability, with better memoization often leading to better performance.

@roryabraham
Copy link
Contributor

(btw @s77rt I know you took over this PR from @narefyev91, so hopefully this feedback is helpful to him as well)

@narefyev91
Copy link
Contributor

(btw @s77rt I know you took over this PR from @narefyev91, so hopefully this feedback is helpful to him as well)

Yeah! But most of your comments related to already existed code :-)
fyi https://github.com/Expensify/App/pull/38647/files , #37621
I think that i and @s77rt did not really try to refactoring already existing code - just because of very close deadline. But yeah in any case thanks for comments @roryabraham - appreciated!

@trjExpensify
Copy link
Contributor

If we click on Classes main tag, we can observe sub-tags with & symbol in their name which is not decoded into & (ampersand) and we're left with sub-tag labels like R&D instead of R&D. Additionally, if click on this we also get the RHP "Page not found" and the URL param looks weird as it's actually encoding the label R&D which is url encoded to R%26amp%3BD instead of encoding decoded label R&D which should result in url encoded R%26D.

@MonilBhavsar @luacmartins I seem to remember you guys having some experience with this from categories. Context:

  1. User has a list of Classes stored in their QBO account with a name containing an &. I.e G&A || Sales & Marketing || R&D
  2. They connect QBO to Expensify and import Classes as tags
  3. The imported values should render as G&A, Sales & Marketing` etc
  4. The app shouldn't crash if you go to the edit page of one of those tag values

Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

Chatted about this in slack, but let's please make the two changes I requested here

@s77rt
Copy link
Contributor Author

s77rt commented May 9, 2024

I have pushed changes for the types. I didn't add a comment as it will only explain the what not the why.

@hayata-suenaga
Copy link
Contributor

hayata-suenaga commented May 10, 2024

I was curious how this PR is going. I haven't checked the code but the UI looking really nice!

Screen.Recording.2024-05-10.at.2.03.31.PM.mov

@hayata-suenaga hayata-suenaga changed the title [HOLD until May 10th] Add missing multi tag view Add missing multi tag view May 10, 2024
@roryabraham roryabraham self-requested a review May 11, 2024 17:41
Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

otherwise LGTM 👍🏼

src/pages/workspace/tags/WorkspaceViewTagsPage.tsx Outdated Show resolved Hide resolved
@roryabraham roryabraham merged commit a9f9d45 into Expensify:main May 12, 2024
16 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

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.73-0 🚀

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

@pecanoro
Copy link
Contributor

Why wasn't this PR tested on mobile? It created this deploy blocker here for example: #42059

@s77rt
Copy link
Contributor Author

s77rt commented May 13, 2024

Sorry my bad! I have raised a PR fixing the regression

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.73-7 🚀

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

Successfully merging this pull request may close these issues.

10 participants