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

feat: Provide education/confirmation before creating workspaces in New Workspace flows #52164

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

Krishna2323
Copy link
Contributor

@Krishna2323 Krishna2323 commented Nov 7, 2024

Explanation of Change

  • Problem: When users attempting to submit expenses are inadvertently led to create workspaces, it causes confusion about how to submit an expense to their boss, leading to frustration and a poor user experience.
  • This PR adds a workspace confirmation page which will be shown before a workspace is created. Workspace confirmation page will have avatar picker, name input and currency selector, users can now choose custom avatar, workspace name and currency before creating a workspace.

Fixed Issues

$ #51504
PROPOSAL: #51504 (comment)

Tests

  1. Go to workspace lists page > Click on Create workspace
  2. Verify RHP is opened with avatar selector, name input and currency selector.
  3. Select any avatar > Enter custom name > Select a different currency
  4. Click confirm
  5. Verify workspace is created with the selected avatar, name and currency.
  6. Repeat Step 1 to 4 with default avatar
  7. Verify workspace is created with the default avatar, name and currency.
  8. Repeat Step 1 to 4 with default currency
  9. Verify workspace is created with the selected avatar, name and default currency.
  10. Click on Create workspace > Enter any custom name
  11. Verify default avatar uses the first character of the name.
  12. Log out and login with a new account > Complete onboarding
  13. Open FAB > Select New workspace > Verify RHP is opened with avatar selector, name input and currency selector.
  14. Select any avatar > Enter custom name > Select a different currency
  15. Click confirm
  16. Verify workspace is created with the selected avatar, name and currency.
  17. Delete the single workspace from workspace list page
  18. On workspace list page click New Workspace button
  19. Verify RHP is opened with avatar selector, name input and currency selector.
  20. Select any avatar > Enter custom name > Select a different currency
  21. Click confirm
  22. Verify workspace is created with the selected avatar, name and currency.
  • Verify that no errors appear in the JS console

Offline tests

  1. Go to workspace lists page > Click on Create workspace
  2. Verify RHP is opened with avatar selector, name input and currency selector.
  3. Select any avatar > Enter custom name > Select a different currency
  4. Click confirm
  5. Verify workspace is created with the selected avatar, name and currency.
  6. Repeat Step 1 to 4 with default avatar
  7. Verify workspace is created with the default avatar, name and currency.
  8. Repeat Step 1 to 4 with default currency
  9. Verify workspace is created with the selected avatar, name and default currency.
  10. Click on Create workspace > Enter any custom name
  11. Verify default avatar uses the first character of the name.
  12. Log out and login with a new account > Complete onboarding
  13. Open FAB > Select New workspace > Verify RHP is opened with avatar selector, name input and currency selector.
  14. Select any avatar > Enter custom name > Select a different currency
  15. Click confirm
  16. Verify workspace is created with the selected avatar, name and currency.
  17. Delete the single workspace from workspace list page
  18. On workspace list page click New Workspace button
  19. Verify RHP is opened with avatar selector, name input and currency selector.
  20. Select any avatar > Enter custom name > Select a different currency
  21. Click confirm
  22. Verify workspace is created with the selected avatar, name and currency.

QA Steps

  1. Go to workspace lists page > Click on Create workspace
  2. Verify RHP is opened with avatar selector, name input and currency selector.
  3. Select any avatar > Enter custom name > Select a different currency
  4. Click confirm
  5. Verify workspace is created with the selected avatar, name and currency.
  6. Repeat Step 1 to 4 with default avatar
  7. Verify workspace is created with the default avatar, name and currency.
  8. Repeat Step 1 to 4 with default currency
  9. Verify workspace is created with the selected avatar, name and default currency.
  10. Click on Create workspace > Enter any custom name
  11. Verify default avatar uses the first character of the name.
  12. Log out and login with a new account > Complete onboarding
  13. Open FAB > Select New workspace > Verify RHP is opened with avatar selector, name input and currency selector.
  14. Select any avatar > Enter custom name > Select a different currency
  15. Click confirm
  16. Verify workspace is created with the selected avatar, name and currency.
  17. Delete the single workspace from workspace list page
  18. On workspace list page click New Workspace button
  19. Verify RHP is opened with avatar selector, name input and currency selector.
  20. Select any avatar > Enter custom name > Select a different currency
  21. Click confirm
  22. Verify workspace is created with the selected avatar, name and currency.
  • 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 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_native.mp4
Android: mWeb Chrome
android_chrome.mp4
iOS: Native
ios_native.mp4
iOS: mWeb Safari
ios_safari.mp4
MacOS: Chrome / Safari
web_chrome.mp4
MacOS: Desktop
desktop_app.mp4

@Krishna2323 Krishna2323 requested a review from a team as a code owner November 7, 2024 08:46
@melvin-bot melvin-bot bot requested review from allgandalf and dubielzyk-expensify and removed request for a team November 7, 2024 08:46
Copy link

melvin-bot bot commented Nov 7, 2024

@dubielzyk-expensify @allgandalf One of you needs to 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]

@Krishna2323 Krishna2323 marked this pull request as draft November 7, 2024 08:46
Signed-off-by: krishna2323 <[email protected]>
@dubielzyk-expensify
Copy link
Contributor

Let me know when this is ready to review from a design standpoint?

@allgandalf
Copy link
Contributor

@dubielzyk-expensify waiting on some BE changes, I will ping you once we get them through, also @Krishna2323 please update the title to mention this one is on hold for BE

@Krishna2323 Krishna2323 changed the title feat: Provide education/confirmation before creating workspaces in New Workspace flows [HOLD for BE]feat: Provide education/confirmation before creating workspaces in New Workspace flows Nov 11, 2024
@allgandalf
Copy link
Contributor

@Krishna2323 can you fix the failing tests in the meantime ?

@allgandalf
Copy link
Contributor

bump @Krishna2323

@Krishna2323
Copy link
Contributor Author

@grgia, the response from backend does not return correct values for currency and avatar both. @allgandalf can you also test this out?

Note for BE: file parameter should be treated as optional.

Monosnap.screencast.2024-11-24.17-28-00.mp4

@grgia
Copy link
Contributor

grgia commented Nov 25, 2024

Hmm. That's strange- I wrote automated tests and the currency/file should be updated as part of the policy object. When you trigger OpenPolicy do you see the same data in the onyx response?

@grgia
Copy link
Contributor

grgia commented Nov 25, 2024

Pulling locally to test the flow

@grgia
Copy link
Contributor

grgia commented Nov 25, 2024

Hey @Krishna2323 when I pull your branch, I cant trigger the education create workspace flow, would you please send me testing steps 🙏

@allgandalf
Copy link
Contributor

created a 🧵 on slack for better communication:

https://expensify.slack.com/archives/C01GTK53T8Q/p1732533526435019

Lets get this one going 💪

@Krishna2323
Copy link
Contributor Author

Krishna2323 commented Nov 25, 2024

I cant trigger the education create workspace flow

@grgia, sorry about that, I hadn't pushed the local changes to the remote at the time. It's updated now. You could easily test by pressing new workspace button on workspace list page.

Signed-off-by: krishna2323 <[email protected]>
Copy link
Contributor

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

Copy link
Contributor

@Krishna2323
Copy link
Contributor Author

@grgia, it's working now🫠, one last backend change is needed. The currency for default distance rate is not updated in the backend.

Monosnap.screencast.2024-11-26.04-21-30.mp4

@allgandalf
Copy link
Contributor

@Krishna2323 please resolve conflicts and when can you open up this PR for review ?

@Krishna2323 Krishna2323 marked this pull request as ready for review November 26, 2024 19:36
@Krishna2323
Copy link
Contributor Author

You can start the code review, I'm on adding the tests steps.

Signed-off-by: krishna2323 <[email protected]>
Signed-off-by: krishna2323 <[email protected]>
@Krishna2323 Krishna2323 changed the title [HOLD for BE]feat: Provide education/confirmation before creating workspaces in New Workspace flows feat: Provide education/confirmation before creating workspaces in New Workspace flows Nov 26, 2024
@Krishna2323
Copy link
Contributor Author

Krishna2323 commented Nov 26, 2024

Will upload the screenshots tomorrow. For now I have uploaded the video for "MacOS: Chrome / Safari".

Monosnap.screencast.2024-11-27.01-30-53.mp4

@allgandalf
Copy link
Contributor

@Krishna2323 can you update the videos please

@Krishna2323
Copy link
Contributor Author

@allgandalf, recordings added.

@allgandalf
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 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

Copy link
Contributor

@allgandalf allgandalf left a comment

Choose a reason for hiding this comment

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

@Krishna2323 overall LGTM, minor comments. Also please do the following:

  1. Merge main
  2. There is also a way to create workspace from track expense have you tested if that works expected ?

@@ -91,6 +91,7 @@ function RightModalNavigator({navigation, route}: RightModalNavigatorProps) {
name={SCREENS.RIGHT_MODAL.REPORT_DETAILS}
component={ModalStackNavigators.ReportDetailsModalStackNavigator}
/>

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change

@@ -11,6 +11,8 @@ type CreateWorkspaceParams = {
customUnitID: string;
customUnitRateID: string;
engagementChoice?: string;
currency: string;
Copy link
Contributor

Choose a reason for hiding this comment

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

Please make this one optional, you have made this param as optional in the util function or vice versa

@allgandalf
Copy link
Contributor

This branch has conflicts, please resolve them

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.

4 participants