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

Create WorkspaceTagsSettingsPage #37755

Merged
merged 17 commits into from
Mar 11, 2024

Conversation

waterim
Copy link
Contributor

@waterim waterim commented Mar 5, 2024

Details

Create Tags Settings Page

Fixed Issues

$ #37310
$ #37848
$ #37873

Tests

  1. Go to settings in collect policy workspace
  2. Go to tags
  3. Click on Settings button
  4. Try to update Tags name
  5. Try the switcher

  1. Go to tag page
  2. try to reload the page
  3. Look that sidebar is correct.

  1. Navigate to staging.new.expensify.com

  2. Go to Workspace settings > Collect workspace

  3. Select the "Tags" tab

  4. Add some tags via classic app

  5. Refresh the page to see the newly added tags

  • Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

None

  • 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 / Chrome
    • iOS / native
    • iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web image image
IOS image image
Android image image

@luacmartins luacmartins self-requested a review March 5, 2024 14:33
@waterim waterim marked this pull request as ready for review March 6, 2024 17:45
@waterim waterim requested a review from a team as a code owner March 6, 2024 17:45
@melvin-bot melvin-bot bot requested review from Pujan92 and removed request for a team March 6, 2024 17:45
Copy link

melvin-bot bot commented Mar 6, 2024

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

@luacmartins luacmartins requested review from mkhutornyi and removed request for Pujan92 March 6, 2024 18:03
@luacmartins
Copy link
Contributor

Assigning @mkhutornyi for review!

src/pages/workspace/tags/WorkspaceEditTagsPage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/tags/WorkspaceEditTagsPage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/tags/WorkspaceEditTagsPage.tsx Outdated Show resolved Hide resolved
@mkhutornyi
Copy link
Contributor

Please resolve conflict

@waterim
Copy link
Contributor Author

waterim commented Mar 6, 2024

@mkhutornyi Updated and resolved

@mkhutornyi
Copy link
Contributor

mkhutornyi commented Mar 6, 2024

No Tests / QA Steps specified. Please also add platform screenshots

@mkhutornyi
Copy link
Contributor

Not from this PR but font seems to be wrong

Screenshot 2024-03-07 at 1 09 23 am Screenshot 2024-03-07 at 1 09 27 am

@waterim
Copy link
Contributor Author

waterim commented Mar 7, 2024

@mkhutornyi Updated everything, also fixed fonts and bugs

@mkhutornyi
Copy link
Contributor

Looks like linked issues added by Carlos are overwritten.

@waterim please link again like this:

$ https://github.com/Expensify/App/issues/37310
$ https://github.com/Expensify/App/issues/37848
$ https://github.com/Expensify/App/issues/37873

Also, please add more test cases from those linked issues

@waterim
Copy link
Contributor Author

waterim commented Mar 7, 2024

@mkhutornyi updated

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Left a few comments

src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`,
value: {
requiresTag,
errors: {
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this should be errorFields. errors is just an object keyed by timestamp, so this wouldn't work as we have here. Same for the others below.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

errors are working, it shows an error, we have the same in categories
Maybe Im missing something

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm seeing the following issues when simulating an error from the API:

  1. For enable/disable the error shows up in the LHN instead of the RHN under the toggle. Clearing the error also clears the entire policy
Screen.Recording.2024-03-08.at.3.14.18.PM.mov
  1. App crashes when simulating an error on the rename API:
Screen.Recording.2024-03-08.at.3.15.17.PM.mov
Screenshot 2024-03-08 at 3 17 55 PM

Copy link
Contributor

Choose a reason for hiding this comment

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

Is this thread resolved?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm retesting this now

Copy link
Contributor

Choose a reason for hiding this comment

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

No, this is still happening. I think we can continue with this and I'll address it in a fast following PR.

Comment on lines 2620 to 2621
[newName]: {...oldPolicyTags, name: newName},
[oldName]: null,
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm I think the correct pattern here is to have the old tagList pending as delete and the new one pending as add

Suggested change
[newName]: {...oldPolicyTags, name: newName},
[oldName]: null,
[newName]: {...oldPolicyTags, name: newName, pendingAction: CONST.RED_BRICK_ROAD_PENDING_ACTION.ADD},
[oldName]:
{pendingAction:CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE},

Copy link
Contributor

Choose a reason for hiding this comment

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

In addition, we'd have successData to remove the pendingActions and delete the old taglist

@waterim
Copy link
Contributor Author

waterim commented Mar 11, 2024

@mkhutornyi This one is already in development in moreFeatures PR
will be an additional Wrapper which will redirect to "More features" if its disabled

@mkhutornyi
Copy link
Contributor

ok given reported issues are planned to be fixed in next PRs, will go ahead checklist

@mkhutornyi
Copy link
Contributor

mkhutornyi commented Mar 11, 2024

After enable tags, it takes super long to load tags list initially. Also, at the moment tags are loaded, Tags menu briefly disappears. Also disabled category is automatically enabled. This can be clearly reproduced after logout and re-login

desktop.mov

@mkhutornyi
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 / Chrome
    • iOS / native
    • iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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(themeColors.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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
mchrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
msafari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@mkhutornyi
Copy link
Contributor

App crashes while updating tag name

Screenshot 2024-03-12 at 12 12 09 am

@luacmartins
Copy link
Contributor

luacmartins commented Mar 11, 2024

@mkhutornyi I found that issue too and my PR will fix that - #38096. I based my PR on this branch so the commit history is a bit off now.

@luacmartins luacmartins mentioned this pull request Mar 11, 2024
49 tasks
@mkhutornyi
Copy link
Contributor

@mkhutornyi I found that issue too and my PR will fix that

ok let's get that PR merged asap

Copy link
Contributor

@mkhutornyi mkhutornyi left a comment

Choose a reason for hiding this comment

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

@waterim please note all the reported bugs in this PR and make sure to cover them in next PR

@melvin-bot melvin-bot bot requested a review from MonilBhavsar March 11, 2024 22:15
@luacmartins luacmartins merged commit abaf874 into Expensify:main Mar 11, 2024
17 of 20 checks passed
Copy link

melvin-bot bot commented Mar 11, 2024

@luacmartins looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@melvin-bot melvin-bot bot added the Emergency label Mar 11, 2024
@luacmartins
Copy link
Contributor

Tests were passing. Removing label.

@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/luacmartins in version: 1.4.51-0 🚀

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

@lanitochka17
Copy link

This PR is failing because of issue #38188

The issue is reproducible in: All platforms

Bug6411610_1710280159625.20240313_054753.1.mp4

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.51-3 🚀

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

color={theme.spinner}
/>
)}
{tagList.length === 0 && !isLoading && (
Copy link
Contributor

Choose a reason for hiding this comment

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

This line caused a bug later on. The deleted tags in offline mode had there state set as pending.

@@ -2639,6 +2653,109 @@ function setWorkspaceRequiresCategory(policyID: string, requiresCategory: boolea
API.write('SetWorkspaceRequiresCategory', parameters, onyxData);
}

function setPolicyRequiresTag(policyID: string, requiresTag: boolean) {
Copy link
Contributor

Choose a reason for hiding this comment

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

We were only supporting single level tags here (#43754) so we updated this to suport multi-level tags in #44937

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.

8 participants