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

Prevent going back to participant page when categorizing #53420

Merged
merged 8 commits into from
Dec 11, 2024

Conversation

nkdengineer
Copy link
Contributor

@nkdengineer nkdengineer commented Dec 3, 2024

Explanation of Change

Prevent going back to participant page when categorizing

Fixed Issues

$ #53274
#53318
PROPOSAL:

Tests

  1. Login with a new account
  2. Create two new workspaces
  3. Create a track expense
  4. Categorize it
  5. Select a category
  6. On the confirmation page, click on the back button
  7. Verify that the category page is displayed

Precondition:

  • Device font size should be small.
  • Account has no workspace.
  1. Create a track expense
  2. Categorize it
  3. On the upgrade page, click on the upgrade button
  4. Verify that the success message is center-aligned
  • Verify that no errors appear in the JS console

Offline tests

Same

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  1. Login with a new account
  2. Create two new workspaces
  3. Create a track expense
  4. Categorize it
  5. Select a category
  6. On the confirmation page, click on the back button
  7. Verify that the category page is displayed

Precondition:

  • Device font size should be small.
  • Account has no workspace.
  1. Create a track expense
  2. Categorize it
  3. On the upgrade page, click on the upgrade button
  4. Verify that the success message is center-aligned
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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-12-03.at.11.25.23.mov
Screenshot 2024-12-03 at 11 33 31
Android: mWeb Chrome
Screen.Recording.2024-12-03.at.11.12.10.mov
iOS: Native
Screen.Recording.2024-12-03.at.11.27.00.mov
Screenshot 2024-12-03 at 11 31 55
iOS: mWeb Safari
Screen.Recording.2024-12-03.at.11.14.40.mov
MacOS: Chrome / Safari
Screen.Recording.2024-12-03.at.11.08.24.mov
MacOS: Desktop
Screen.Recording.2024-12-03.at.11.30.02.mov

@nkdengineer nkdengineer marked this pull request as ready for review December 3, 2024 04:46
@nkdengineer nkdengineer requested a review from a team as a code owner December 3, 2024 04:46
@melvin-bot melvin-bot bot requested review from Ollyws and removed request for a team December 3, 2024 04:46
Copy link

melvin-bot bot commented Dec 3, 2024

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

@Ollyws
Copy link
Contributor

Ollyws commented Dec 3, 2024

Wouldn't it make more sense that pressing back here takes us back to the category select page?

@nkdengineer
Copy link
Contributor Author

@trjExpensify What do you think?

@trjExpensify
Copy link
Contributor

Yes, that's what I would expect. If you go back from the category list, then we close the RHP and NOT show a workspace list.

@nkdengineer
Copy link
Contributor Author

@Ollyws All good now.

@Ollyws
Copy link
Contributor

Ollyws commented Dec 3, 2024

Yes, that's what I would expect. If you go back from the category list, then we close the RHP and NOT show a workspace list.

This is working fine when we're going back from the category list, but when we go back from the submit page it closes the panel instead of going back to the category list:

Screen.Recording.2024-12-03.at.19.34.31.mov

@trjExpensify
Copy link
Contributor

Right, I agree if you go back from the confirmation page it should take you to the category list. If you go back from the category list, it closes the RHP.

@nkdengineer
Copy link
Contributor Author

@Ollyws When we are from the category step we always closeAndNavigate to the confirmation step. Then I think it's good to close the RHP in confirmation in this case because if in the confirmation step we click on category item to open the category step and click the back button two times, it also closes the RHP.

if (action === CONST.IOU.ACTION.CATEGORIZE) {
Navigation.closeAndNavigate(ROUTES.MONEY_REQUEST_STEP_CONFIRMATION.getRoute(action, iouType, transactionID, report?.reportID ?? '-1'));
return;
}

cc @trjExpensify

Screen.Recording.2024-12-04.at.12.35.16.mov

@Ollyws
Copy link
Contributor

Ollyws commented Dec 5, 2024

What's your opinion on the behaviour in this video @trjExpensify ?

@trjExpensify
Copy link
Contributor

Yeah, my expectation was:

  1. Click "categorize it"
  2. Upgrade to a workspace to unlock categories
  3. Choose a category
  4. Land on the confirmation page
  5. Go back
  6. Choose a category
  7. Go back
  8. Close the RHP

Whereas, what appears to be happening is:

  1. Click "categorize it"
  2. Upgrade to a workspace to unlock categories
  3. Choose a category
  4. Land on the confirmation page
  5. Go back
  6. Close the RHP

I prefer the first, but I'm not super passionate. Is @nkdengineer basically saying that because this is the same category selector on the confirmation page, we don't navigate back to it when you go back from there ordinarily. CC: @luacmartins @mountiny if you have any strong opinions on this.

@luacmartins
Copy link
Contributor

I agree that the first option @trjExpensify laid out is better.

@mountiny
Copy link
Contributor

mountiny commented Dec 9, 2024

Same as Tom and Carlos

@nkdengineer Can you please update the PR based on that expected outcome? thanks!

@nkdengineer
Copy link
Contributor Author

I updated with this approach. However, I noticed that the animation is different when we click on the category section of the confirmation page for the first time.

@trjExpensify cc @mountiny @Ollyws

Screen.Recording.2024-12-09.at.16.55.39.mov

@mountiny
Copy link
Contributor

mountiny commented Dec 9, 2024

@nkdengineer That is not right, we should be pushing that screen in.

@nkdengineer
Copy link
Contributor Author

@mountiny Currently, we're using closeAndNavigate then this bug will not happen.

Navigation.closeAndNavigate(ROUTES.MONEY_REQUEST_STEP_CONFIRMATION.getRoute(action, iouType, transactionID, report?.reportID ?? '-1'));

But we need to use navigate instead because we want this behavior.

After that when we navigate to this screen, the animation is wrong because the screen is existed

onPress={() => Navigation.navigate(ROUTES.MONEY_REQUEST_STEP_CATEGORY.getRoute(action, iouType, transactionID, reportID, Navigation.getActiveRoute(), reportActionID))}

@mountiny
Copy link
Contributor

mountiny commented Dec 9, 2024

I feel like there must be a way to achieve this @adamgrzybowski @WojtekBoman in case you have an idea on how to achieve this flow in the RHP

Yeah, my expectation was:

  1. Click "categorize it"
  2. Upgrade to a workspace to unlock categories
  3. Choose a category
  4. Land on the confirmation page
  5. Go back
  6. Choose a category
  7. Go back
  8. Close the RHP

@WojtekBoman
Copy link
Contributor

WojtekBoman commented Dec 9, 2024

@mountiny @trjExpensify @nkdengineer

I'd like to make sure. Is this what we want to achieve?

Screen.Recording.2024-12-09.at.13.35.52.mov

@mountiny
Copy link
Contributor

mountiny commented Dec 9, 2024

@WojtekBoman @adamgrzybowski That looks good for the flow once you already upgraded to workspace. I guess its harder when the user does not have a workspace yet and then by categorizing it, we need to create a workspace

@trjExpensify
Copy link
Contributor

I guess its harder when the user does not have a workspace yet and then by categorizing it, we need to create a workspace

They go through an upgrade interstitial. Confirming on that page (before seeing the category list) is what creates the workspace.

@WojtekBoman
Copy link
Contributor

Screen.Recording.2024-12-09.at.17.36.07.mov

After upgrading the workspace, categorizing flow is opened and works the same way as on the previous video that I attached

@trjExpensify
Copy link
Contributor

That looks like what we're after.

@mountiny
Copy link
Contributor

mountiny commented Dec 9, 2024

@WojtekBoman nice! What changes have you made?

@WojtekBoman
Copy link
Contributor

onPress={() => Navigation.navigate(ROUTES.MONEY_REQUEST_STEP_CATEGORY.getRoute(action, iouType, transactionID, reportID, Navigation.getActiveRoute(), reportActionID))}

Here, I added CONST.NAVIGATION.ACTION_TYPE.PUSH as the second param of Navigation.navigate

@WojtekBoman
Copy link
Contributor

I only added the two changes I mentioned above, but I'm not very familiar with the categorization flow, so it's possible I missed something

@mountiny
Copy link
Contributor

mountiny commented Dec 9, 2024

Thank you! @nkdengineer can you please check these out?

@nkdengineer
Copy link
Contributor Author

Thanks, @WojtekBoman. @mountiny I updated the code and the test steps.

@mountiny
Copy link
Contributor

Thanks! @Ollyws what is your ETA for the review?

Copy link
Contributor

🚧 @mountiny has triggered a test build. You can view the workflow run here.

@Ollyws
Copy link
Contributor

Ollyws commented Dec 10, 2024

@mountiny Will get to this one later today.

Copy link
Contributor

@Ollyws
Copy link
Contributor

Ollyws commented Dec 10, 2024

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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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
01_Android_Native.mp4
Android: mWeb Chrome
02_Android_Chrome.mp4
iOS: Native
03_iOS_Native.mp4
iOS: mWeb Safari
04_iOS_Safari.mp4
MacOS: Chrome / Safari
05_MacOS_Chrome.mp4
MacOS: Desktop
06_MacOS_Desktop.mp4

Copy link
Contributor

@Ollyws Ollyws left a comment

Choose a reason for hiding this comment

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

Looks good, thanks everyone!

@melvin-bot melvin-bot bot requested a review from flodnv December 10, 2024 19:50
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.

LGTM

@mountiny
Copy link
Contributor

Thanks!

@mountiny mountiny merged commit 665fa04 into Expensify:main Dec 11, 2024
18 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.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.75-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.75-6 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 failure ❌
🍎🔄 iOS HybridApp 🍎🔄 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.

7 participants