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 #53845

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

Conversation

Krishna2323
Copy link
Contributor

@Krishna2323 Krishna2323 commented Dec 10, 2024

Explanation of Change

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 changed the title Krishna2323/issue/52164 pr2 feat: Provide education/confirmation before creating workspaces in New Workspace flows Dec 10, 2024
@Krishna2323
Copy link
Contributor Author

@allgandalf, the regression issues are fixed but I'm facing a new error, can you please take a look?

Monosnap.screencast.2024-12-11.13-55-01.mp4

@allgandalf
Copy link
Contributor

Can you merge main and retry ? is this constantly reproducible ?

@Krishna2323
Copy link
Contributor Author

I'm still able to reproduce this issue even after merging main. I'm investigating the RCA of the issue. @allgandalf please let me know if you know anything about this, this is probably related to how we are updating the onyx value.

It only occurs when creating a second workspace with an avatar. I'm unsure if this is a backend or frontend bug.

@allgandalf
Copy link
Contributor

Can you put out reproduction steps please

@Krishna2323
Copy link
Contributor Author

Krishna2323 commented Dec 15, 2024

Reproduction Steps:

  1. Create a new account > Manage my team's expenses during onboarding process
  2. Go to workspace list page > Create a workspace with an avatar

@danielrvidal
Copy link
Contributor

I can also reproduce the issue. You can see it here:
https://github.com/user-attachments/assets/9f2267d5-72c8-4c98-899e-189183126c0b

@@ -1891,6 +1910,8 @@ function buildPolicyData(policyOwnerEmail = '', makeMeAdmin = false, policyName
customUnitID,
customUnitRateID,
engagementChoice,
currency: outputCurrency,
file,
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
file,
file: {...file},

Please soft clone it to remove non-indexable errors.

@@ -2007,6 +2038,8 @@ function createDraftWorkspace(policyOwnerEmail = '', makeMeAdmin = false, policy
expenseCreatedReportActionID,
customUnitID,
customUnitRateID,
currency: outputCurrency,
file,
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
file,
file: {...file},

Please soft clone it to remove non-indexable errors.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @shubham1206agra 🙇🏻, checking...

@shubham1206agra
Copy link
Contributor

@Krishna2323 Can you ready this PR with fixes?

I need this PR merged today. So, I can work on another feature which requires this screen.

@@ -3723,7 +3723,7 @@ const translations = {
},
emptyWorkspace: {
title: 'Create a workspace',
subtitle: 'Create a workspace to track receipts, reimburse expenses, send invoices, and more -- all at the speed of chat.',
subtitle: 'Create a workspace to track receipts, reimburse expenses, send invoices, and more all at the speed of chat.',
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
subtitle: 'Create a workspace to track receipts, reimburse expenses, send invoices, and more — all at the speed of chat.',
subtitle: 'Create a workspace to track receipts, reimburse expenses, manage travel, send invoices, and more — all at the speed of chat.',

Update the copy as per #53753 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this update can be made in this PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

Alright, thanks

@Krishna2323
Copy link
Contributor Author

@allgandalf, you can review the code, I will add the screenshot after few hours.

@allgandalf
Copy link
Contributor

all good, please take a look at the failing test as well

@Krishna2323
Copy link
Contributor Author

Not sure why the BE is not returning the correct avatar. Will check again.

@Krishna2323 Krishna2323 marked this pull request as ready for review December 20, 2024 16:12
Copy link
Contributor

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

@allgandalf
Copy link
Contributor

@Krishna2323 please fix eslint

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

This comment has been minimized.

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

@allgandalf lint issues fixed.

@allgandalf
Copy link
Contributor

@Krishna2323 can you please merge main? the iOS build is failing on current branch, we fixed iOS build with latest commits on main

@allgandalf
Copy link
Contributor

I will complete other platform testing in the meantime

@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

@allgandalf
Copy link
Contributor

@Krishna2323 can you please update native platform videos

@Krishna2323
Copy link
Contributor Author

native platform videos uploaded, was facing build issues last time.

@allgandalf
Copy link
Contributor

Asked for a new ad-hoc build

@shawnborton
Copy link
Contributor

I can kick it off 🚀

Copy link
Contributor

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

Copy link
Contributor

@allgandalf
Copy link
Contributor

Bug: Not found page when workspace is created from the onboarding modal:

  • Open the adhoc link in incognito mode ( i am able to reproduce this constantly in incognito mode / first time i tried this build)
Screen.Recording.2024-12-24.at.10.48.13.PM.mov

@allgandalf
Copy link
Contributor

Bug: The central pane changes on refresh

( we discussed this solution on the other PR please implement that)

Screen.Recording.2024-12-24.at.10.52.01.PM.mov

@allgandalf
Copy link
Contributor

Bug: Console error when you create a workspace with attachment in offline mode:

Screenshot 2024-12-24 at 10 56 23 PM

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.

I will do a review again tomorrow morning, I guess there isn't much left to change, looks good overall

src/libs/fileDownload/FileUtils.ts Outdated Show resolved Hide resolved
src/libs/fileDownload/FileUtils.ts Outdated Show resolved Hide resolved
src/components/CurrencyPicker.tsx Outdated Show resolved Hide resolved
src/components/CurrencyPicker.tsx Outdated Show resolved Hide resolved
@@ -3723,7 +3723,7 @@ const translations = {
},
emptyWorkspace: {
title: 'Create a workspace',
subtitle: 'Create a workspace to track receipts, reimburse expenses, send invoices, and more -- all at the speed of chat.',
subtitle: 'Create a workspace to track receipts, reimburse expenses, send invoices, and more all at the speed of chat.',
Copy link
Contributor

Choose a reason for hiding this comment

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

Alright, thanks

src/libs/actions/Policy/Policy.ts Show resolved Hide resolved
src/libs/actions/Policy/Policy.ts Show resolved Hide resolved
src/libs/actions/Policy/Policy.ts Show resolved Hide resolved
@Krishna2323
Copy link
Contributor Author

Not found page when workspace is created from the onboarding modal:

@allgandalf, this isn't related to our PR, it can also be reproduced using this adhoc build.

Comment on lines +335 to +347
const createFile = (file: File): FileObject => {
if (getPlatform() === 'web') {
return new File([file], file.name, {
type: file.type,
lastModified: file.lastModified,
});
}
return {
uri: file.uri,
name: file.name,
type: file.type,
};
};
Copy link
Contributor

Choose a reason for hiding this comment

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

@Krishna2323 Can you tell us why did you create this method here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The File API is part of the web platform and is not supported on native iOS and Android environments. This function ensures compatibility by creating a platform-specific file object, handling both web and native platforms appropriately.

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

Bug: Console error when you create a workspace with attachment in offline mode:

I can't reproduce this bug.

Monosnap.screencast.2024-12-27.04-11-44.mp4

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.

5 participants