[Fix]: App returns to tag page after tapping back button on workspace editor #51568

twilight2294 · 2024-10-28T13:24:43Z

Details

Fixed Issues

$ #51414
PROPOSAL: N/A

Tests

Precondition:

Workspace has imported dependent tags (attached below).

Launch ND or hybrid app.
Go to workspace settings > Tags.
Tap on any main tag.
Tap app back button to go back to main tag page.
Tap app back button to return to workspace editor.
Tap app back button again.

Verify that no errors appear in the JS console

Offline tests

Precondition:

Workspace has imported dependent tags (attached below).

Launch ND or hybrid app.
Go to workspace settings > Tags.
Tap on any main tag.
Tap app back button to go back to main tag page.
Tap app back button to return to workspace editor.
Tap app back button again.

QA Steps

Precondition:

Workspace has imported dependent tags (attached below).

Launch ND or hybrid app.
Go to workspace settings > Tags.
Tap on any main tag.
Tap app back button to go back to main tag page.
Tap app back button to return to workspace editor.
Tap app back button again.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-10-31.at.5.46.47.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-10-31.at.5.48.17.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-31.at.5.22.22.PM.mov

MacOS: Desktop

Screen.Recording.2024-10-31.at.5.27.14.PM.mov

twilight2294 · 2024-10-28T13:28:13Z

c.c. @paultsimura :

Please refer issue #50695, this issue exists in our current codebase, refer to this comment for RCA.

I think the current changes are fine to solve our problem. we can put the route as undefined and we when we dismiss the RHP we would be on the tags view page. do you have any questions about the solution ?

paultsimura · 2024-10-28T19:37:07Z

@twilight2294 there were a couple of other places in our original PR where before we used just Navigation.goBack, and in the PR we've changed to some specific fallback route for non-isQuickSettingsFlow scenario.
Please check for them, I think we should pass undefined in them as well to use the pre-PR logic for non-isQuickSettingsFlow scenarios.

twilight2294 · 2024-10-30T14:34:26Z

@paultsimura i checked this is the only place left out, for all other places we send undefined, this was probably missed because this bug occurs for multi-level tags and we cannot add them in ND

paultsimura · 2024-10-30T17:04:48Z

What about these?

App/src/pages/workspace/categories/EditCategoryPage.tsx

Lines 52 to 56 in 13982f1

    
           Navigation.goBack( 
        
               isQuickSettingsFlow 
        
                   ? ROUTES.SETTINGS_CATEGORY_SETTINGS.getRoute(route.params.policyID, route.params.categoryName, backTo) 
        
                   : ROUTES.WORKSPACE_CATEGORY_SETTINGS.getRoute(route.params.policyID, route.params.categoryName), 
        
           );

App/src/pages/workspace/tags/EditTagPage.tsx

Lines 64 to 68 in 13982f1

    
           Navigation.goBack( 
        
               isQuickSettingsFlow 
        
                   ? ROUTES.SETTINGS_TAG_SETTINGS.getRoute(route?.params?.policyID, route.params.orderWeight, route.params.tagName, backTo) 
        
                   : ROUTES.WORKSPACE_TAG_SETTINGS.getRoute(route?.params?.policyID, route.params.orderWeight, route.params.tagName), 
        
           );

App/src/pages/workspace/tags/EditTagPage.tsx

Lines 87 to 93 in 13982f1

    
           onBackButtonPress={() => 
        
               Navigation.goBack( 
        
                   isQuickSettingsFlow 
        
                       ? ROUTES.SETTINGS_TAG_SETTINGS.getRoute(route?.params?.policyID, route.params.orderWeight, route.params.tagName, backTo) 
        
                       : ROUTES.WORKSPACE_TAG_SETTINGS.getRoute(route?.params?.policyID, route.params.orderWeight, route.params.tagName), 
        
               ) 
        
           }

App/src/pages/workspace/tags/TagApproverPage.tsx

Lines 29 to 31 in 13982f1

    
           Navigation.goBack( 
        
               isQuickSettingsFlow ? ROUTES.SETTINGS_TAG_SETTINGS.getRoute(policyID, orderWeight, tagName, backTo) : ROUTES.WORKSPACE_TAG_SETTINGS.getRoute(policyID, orderWeight, tagName), 
        
           );

App/src/pages/workspace/tags/WorkspaceEditTagsPage.tsx

Lines 79 to 81 in 13982f1

    
           Navigation.goBack( 
        
               isQuickSettingsFlow ? ROUTES.SETTINGS_TAGS_SETTINGS.getRoute(route?.params?.policyID, backTo) : ROUTES.WORKSPACE_TAGS_SETTINGS.getRoute(route?.params?.policyID), 
        
           )

twilight2294 · 2024-10-30T17:10:39Z

Those are level 2 pages (Meaning that they don't immediately navigate to the tags/category main page, if we remove that route then when the user would refresh and then press back button then RHP would get dismissed) Also the bug is for only level 1 pages (Pages which on back press go to the main category/tags page)

paultsimura · 2024-10-30T17:22:15Z

This sounds reasonable, let me check further 🤔

twilight2294 · 2024-10-30T17:25:57Z

I'll save you a bit more time, look below all the level 1 pages have undefined here, we just missed it on that particular page because we are not able to add multi-level tags and test on newdot:

App/src/pages/workspace/categories/WorkspaceCategoriesSettingsPage.tsx

Lines 105 to 107 in 13982f1

    
           <HeaderWithBackButton 
        
               title={translate('common.settings')} 
        
               onBackButtonPress={() => Navigation.goBack(isQuickSettingsFlow ? ROUTES.SETTINGS_CATEGORIES_ROOT.getRoute(policyID, backTo) : undefined)}

App/src/pages/workspace/tags/WorkspaceTagsSettingsPage.tsx

Lines 135 to 137 in 13982f1

    
           <HeaderWithBackButton 
        
               title={translate('common.settings')} 
        
               onBackButtonPress={() => Navigation.goBack(isQuickSettingsFlow ? ROUTES.SETTINGS_TAGS_ROOT.getRoute(policyID, backTo) : undefined)}

paultsimura · 2024-10-30T17:43:21Z

Got it. Please proceed with the checklist & recordings.

paultsimura · 2024-10-30T19:46:48Z

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

2024-10-30.-.20.23.-.android.mp4

Android: mWeb Chrome

2024-10-30.-.20.23.-.chrome.mp4

iOS: Native

2024-10-30.-.20.23.-.Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-10-30.at.20.21.57.mp4

iOS: mWeb Safari

2024-10-30.-.20.23.-.Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-10-30.at.18.48.54.mp4

MacOS: Chrome / Safari

2024-10-30.-.20.23.-.Screen.Recording.2024-10-30.at.18.47.19.mp4

MacOS: Desktop

2024-10-30.-.20.23.-.Screen.Recording.2024-10-30.at.20.11.28.mp4

twilight2294 · 2024-10-30T19:58:05Z

@paultsimura where do i get the multi-level tags file? can you share it with me please, its blocking my testing

paultsimura · 2024-10-30T19:59:23Z

dependent_tags.csv

melvin-bot · 2024-10-31T17:58:58Z

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

paultsimura · 2024-11-01T11:07:19Z

@twilight2294 please also update the PR description with the tests included

paultsimura

LGTM ✔️

twilight2294 · 2024-11-01T11:40:13Z

Updated @paultsimura

OSBotify · 2024-11-01T12:27:53Z

✋ 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 · 2024-11-04T14:38:49Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 9.0.57-0 🚀

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

github-actions · 2024-11-06T00:02:22Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.57-10 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

Update WorkspaceViewTagsPage.tsx

f98f9ff

twilight2294 marked this pull request as ready for review October 31, 2024 17:58

twilight2294 requested a review from a team as a code owner October 31, 2024 17:58

melvin-bot bot requested review from ntdiary and removed request for a team October 31, 2024 17:58

paultsimura approved these changes Nov 1, 2024

View reviewed changes

melvin-bot bot requested a review from Julesssss November 1, 2024 11:08

Julesssss approved these changes Nov 1, 2024

View reviewed changes

Julesssss merged commit cb28419 into Expensify:main Nov 1, 2024
19 of 23 checks passed

github-actions bot mentioned this pull request Nov 4, 2024

Deploy Checklist: New Expensify 2024-11-04 #51953

Closed

63 tasks

melvin-bot bot mentioned this pull request Nov 6, 2024

[HOLD for payment 2024-11-13] [$250] Tags - App returns to tag page after tapping back button on workspace editor #51414

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fix]: App returns to tag page after tapping back button on workspace editor #51568

[Fix]: App returns to tag page after tapping back button on workspace editor #51568

twilight2294 commented Oct 28, 2024 •

edited

Loading

twilight2294 commented Oct 28, 2024

paultsimura commented Oct 28, 2024

twilight2294 commented Oct 30, 2024

paultsimura commented Oct 30, 2024

twilight2294 commented Oct 30, 2024

paultsimura commented Oct 30, 2024

twilight2294 commented Oct 30, 2024

paultsimura commented Oct 30, 2024

paultsimura commented Oct 30, 2024 •

edited

Loading

twilight2294 commented Oct 30, 2024

paultsimura commented Oct 30, 2024

melvin-bot bot commented Oct 31, 2024

paultsimura commented Nov 1, 2024

paultsimura left a comment

twilight2294 commented Nov 1, 2024

OSBotify commented Nov 1, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 6, 2024

[Fix]: App returns to tag page after tapping back button on workspace editor #51568

[Fix]: App returns to tag page after tapping back button on workspace editor #51568

Conversation

twilight2294 commented Oct 28, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

twilight2294 commented Oct 28, 2024

paultsimura commented Oct 28, 2024

twilight2294 commented Oct 30, 2024

paultsimura commented Oct 30, 2024

twilight2294 commented Oct 30, 2024

paultsimura commented Oct 30, 2024

twilight2294 commented Oct 30, 2024

paultsimura commented Oct 30, 2024

paultsimura commented Oct 30, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

twilight2294 commented Oct 30, 2024

paultsimura commented Oct 30, 2024

melvin-bot bot commented Oct 31, 2024

paultsimura commented Nov 1, 2024

paultsimura left a comment

Choose a reason for hiding this comment

twilight2294 commented Nov 1, 2024

OSBotify commented Nov 1, 2024

github-actions bot commented Nov 4, 2024

github-actions bot commented Nov 6, 2024

twilight2294 commented Oct 28, 2024 •

edited

Loading

paultsimura commented Oct 30, 2024 •

edited

Loading