Skip to content

Fix: Background report changes to Tags page after clicking Custom tag name in RHP#50332

Closed
twilight2294 wants to merge 35 commits into
Expensify:mainfrom
twilight2294:fix-tag
Closed

Fix: Background report changes to Tags page after clicking Custom tag name in RHP#50332
twilight2294 wants to merge 35 commits into
Expensify:mainfrom
twilight2294:fix-tag

Conversation

@twilight2294

@twilight2294 twilight2294 commented Oct 7, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Details

Fixed Issues

$ #49883
PROPOSAL: #49883 (comment)

Tests

  • Precondition:
  • User is logged in to two devices
  • Workspace has tags
  1. Open App
  2. [Device A] Go to workspace chat
  3. [Device A] Click + > Submit expense > Manual
  4. [Device A] Proceed to confirmation page and click Tag
  5. [Device B] Go to workspace settings > Tags
  6. [Device B] Disable all tags
  7. [Device A] Click Edit tags
  8. [Device A] Click Settings > Custom tag name

Verify that The report in the background will remain after clicking Custom tag name

  • Verify that no errors appear in the JS console

Offline tests

N/A can't test offline

QA Steps

  • Precondition:
  • User is logged in to two devices
  • Workspace has tags
  1. Open App
  2. [Device A] Go to workspace chat
  3. [Device A] Click + > Submit expense > Manual
  4. [Device A] Proceed to confirmation page and click Tag
  5. [Device B] Go to workspace settings > Tags
  6. [Device B] Disable all tags
  7. [Device A] Click Edit tags
  8. [Device A] Click Settings > Custom tag name

Verify that The report in the background will remain after clicking Custom tag name

  • 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
Screen.Recording.2024-10-07.at.8.45.54.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-10-07.at.8.48.45.PM.mov
iOS: Native
Screen.Recording.2024-10-07.at.8.44.21.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-10-07.at.8.43.29.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-10-07.at.7.58.45.PM.mov
MacOS: Desktop
Screen.Recording.2024-10-07.at.8.03.38.PM.mov

@twilight2294 twilight2294 requested a review from a team as a code owner October 7, 2024 14:01
@melvin-bot melvin-bot Bot requested review from paultsimura and removed request for a team October 7, 2024 14:01
@melvin-bot

melvin-bot Bot commented Oct 7, 2024

Copy link
Copy Markdown

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

@twilight2294 twilight2294 mentioned this pull request Oct 7, 2024
Closed
6 tasks
paultsimura
paultsimura suggested changes Oct 8, 2024
View reviewed changes
Comment thread src/ROUTES.ts Outdated
route: 'settings/:policyID/tags/settings',
getRoute: (policyID: string, backTo = '') => getUrlWithBackToParam(`settings/${policyID}/tags/settings` as const, backTo),
},
SETTINGS_EDIT_TAGS: {

@paultsimura paultsimura Oct 8, 2024

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.

Let's keep the naming consistent with other sections, like Categories:

Suggested change
SETTINGS_EDIT_TAGS: {
SETTINGS_TAGS_EDIT: {

Comment thread src/SCREENS.ts Outdated
SETTINGS_TAGS: {
SETTINGS_TAGS_ROOT: 'Settings_Tags',
SETTINGS_TAGS_SETTINGS: 'Settings_Tags_Settings',
SETTINGS_EDIT_TAGS: 'Settings_Tags_Edit',

@paultsimura paultsimura Oct 8, 2024

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.

Suggested change
SETTINGS_EDIT_TAGS: 'Settings_Tags_Edit',
SETTINGS_TAGS_EDIT: 'Settings_Tags_Edit',

Comment thread src/pages/workspace/tags/WorkspaceTagsPage.tsx Outdated
const [policyTagLists, isMultiLevelTags] = useMemo(() => [PolicyUtils.getTagLists(policyTags), PolicyUtils.isMultiLevelTags(policyTags)], [policyTags]);
const canSelectMultiple = !isMultiLevelTags && (shouldUseNarrowLayout ? selectionMode?.isEnabled : true);

const backTo = route.params.backTo;

@paultsimura paultsimura Oct 8, 2024

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.

Let's move it up to keep the route params close, above this line:

const policyID = route.params.policyID ?? '-1';

Comment thread src/pages/workspace/tags/WorkspaceTagsSettingsPage.tsx Outdated
const hasEnabledOptions = OptionsListUtils.hasEnabledOptions(Object.values(policyTags ?? {}).flatMap(({tags}) => Object.values(tags)));
const {canUseWorkspaceRules} = usePermissions();

const backTo = route.params.backTo;

@paultsimura paultsimura Oct 8, 2024

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.

Same here.

Comment thread src/pages/workspace/tags/WorkspaceTagsSettingsPage.tsx
policyTags: OnyxEntry<OnyxTypes.PolicyTagLists>;
};
type WorkspaceTagsSettingsPageProps = WorkspaceTagsSettingsPageOnyxProps & StackScreenProps<SettingsNavigatorParamList, typeof SCREENS.WORKSPACE.TAGS_SETTINGS>;
type WorkspaceTagsSettingsPageProps = StackScreenProps<SettingsNavigatorParamList, typeof SCREENS.WORKSPACE.TAGS_SETTINGS>;

@paultsimura paultsimura Oct 8, 2024

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.

Good job on handling this 👍

@paultsimura

paultsimura commented Oct 8, 2024

Copy link
Copy Markdown
Contributor

Also, please add the remaining pages similar to the Categories.
Otherwise, if you go 1 step deeper into the Tag Edit flow, the bug is still reproducible:

2024-10-08.-.12.28.-.Screen.Recording.2024-10-08.at.12.27.09.mp4

@paultsimura

paultsimura commented Oct 8, 2024

Copy link
Copy Markdown
Contributor

@twilight294 could you please:

  1. Commit all updated files with one commit
  2. Add meaningful commit names, e.g. "Implement proper routing for the 'edit single tag' flow" instead of "Update screens" etc.

@twilight2294

twilight2294 commented Oct 8, 2024

Copy link
Copy Markdown
Contributor Author

I messed Up with the commits, I will bring up a new PR fixing it, will update here

@twilight2294

twilight2294 commented Oct 8, 2024

Copy link
Copy Markdown
Contributor Author

Please refer this PR: #50416 @paultsimura sorry for the extra work, I have fixed the requested changes there

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@paultsimura paultsimura paultsimura requested changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@twilight2294 @paultsimura