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

Feature: Track expense training modal #40675

Merged

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Apr 22, 2024

Details

This PR creates a training interstitial when you click Track expense.

Fixed Issues

$ #40156
PROPOSAL: #40156 (comment)

Tests

  1. Press FAB >> Track expense
  2. Verify the training interstitial shows
  3. Press Learn more
  4. Verify user is navigated to HelpDot for Track
  5. Press Got it
  6. Verify user is navigated to Track expense page
  7. Press Back button
  8. Verify Track expense RHP dismisses
  9. Press FAB >> Track expense
  10. Verify the training interstitial shows again
  11. Toggle Don't show me this again >> Press Got it
  12. Verify SetNameValuePair API is called
  13. Verify user is navigated to Track expense page
  14. Dismiss Track expense page
  15. Press FAB >> Track expense
  16. Verify the training interstitial does not show, user is navigated directly to Track expense page instead
  • Verify that no errors appear in the JS console

Offline tests

Precondition: User has not togggled the Don't show me this again option.

  1. Toggle offline mode
  2. Press FAB >> Track expense
  3. Verify the training interstitial does not show, user is navigated directly to Track expense page instead

QA Steps

  1. Press FAB >> Track expense
  2. Verify the training interstitial shows
  3. Press Learn more
  4. Verify user is navigated to HelpDot for Track
  5. Press Got it
  6. Verify user is navigated to Track expense page
  7. Press Back button
  8. Verify Track expense RHP dismisses
  9. Press FAB >> Track expense
  10. Verify the training interstitial shows again
  11. Toggle Don't show me this again >> Press Got it
  12. Verify user is navigated to Track expense page
  13. Dismiss Track expense page
  14. Press FAB >> Track expense
  15. Verify the training interstitial does not show, user is navigated directly to Track expense page instead
  • 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
Android: mWeb Chrome
Screen.Recording.2024-04-22.at.15.57.07-compressed.mov
iOS: Native
Screen.Recording.2024-04-22.at.16.13.12-compressed.mov
iOS: mWeb Safari
Screen.Recording.2024-04-22.at.15.51.21-compressed.mov
MacOS: Chrome / Safari
Untitled.mov
Screen.Recording.2024-04-22.at.14.57.22-compressed.mov
Screenshot 2024-04-22 at 15 49 40
MacOS: Desktop
Screen.Recording.2024-04-22.at.14.59.07-compressed.mov

@srikarparsi
Copy link
Contributor

Hey @rushatgabhane, if you could take a look at this as soon as possible that would be great. We're looking to get this merged by Tuesday.

@rushatgabhane
Copy link
Member

yes, this is # 1 priority

@tienifr tienifr marked this pull request as ready for review April 22, 2024 08:58
@tienifr tienifr requested a review from a team as a code owner April 22, 2024 08:58
@melvin-bot melvin-bot bot removed the request for review from a team April 22, 2024 08:58
Copy link

melvin-bot bot commented Apr 22, 2024

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

@dubielzyk-expensify dubielzyk-expensify requested a review from a team April 22, 2024 09:17
@tienifr
Copy link
Contributor Author

tienifr commented Apr 22, 2024

Basically I just reused the onboarding welcome video component.

@dubielzyk-expensify
Copy link
Contributor

dubielzyk-expensify commented Apr 22, 2024

Adding @Expensify/design here for review as well. We'll swap out the video once that's ready. As for the other parts of the UI, this looks good!

Basically I just reused the onboarding welcome video component.

Great move! I think we'd want the same behavior so that works for me. Keen to hear what @Expensify/design team thinks. Especially the centered modal on desktop.

@shawnborton
Copy link
Contributor

For this screenshot here:
CleanShot 2024-04-22 at 08 58 26@2x

It seems like the padding and button spacing is off. I think there should only be 20px of inner padding in the content area, and I think the button stack might be too close together? It also feels like a lot of space above the checkbox.

@dubielzyk-expensify perhaps you can provide the exact desktop mock for this so we have the right guide here?

@dannymcclain
Copy link
Contributor

Agree with Shawn, generally looking good but that button stack is pretty tight.

@srikarparsi
Copy link
Contributor

Hi @tienifr, here is the URL for the Learn more button: https://use.expensify.com/track-expenses

@dubielzyk-expensify
Copy link
Contributor

Here's the mobile and desktop mocks:

CleanShot 2024-04-23 at 10 15 06@2x

There should be 12px padding between the stacked buttons. Here's more detailed specs:
CleanShot 2024-04-23 at 10 17 31@2x

Also can we update the edge padding of the modal to be 20px

@rushatgabhane
Copy link
Member

@tienifr could you please resolve merge conflicts

Copy link
Member

@rushatgabhane rushatgabhane 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! Just a few minor comments

src/CONST.ts Outdated Show resolved Hide resolved
src/components/FeatureTrainingModal.tsx Show resolved Hide resolved
src/components/FeatureTrainingModal.tsx Outdated Show resolved Hide resolved
src/components/FeatureTrainingModal.tsx Outdated Show resolved Hide resolved
@tienifr
Copy link
Contributor Author

tienifr commented Apr 23, 2024

@dubielzyk-expensify

Also can we update the edge padding of the modal to be 20px

Currently the horizontal padding for onboarding welcome video is 32px on desktop and 20px on mobile. Do you mean we need to make it consistently 20px? Or do we just apply 20px padding to this training interstitial only?

@tienifr
Copy link
Contributor Author

tienifr commented Apr 24, 2024

Redundant padding removed:

Screenshot 2024-04-24 at 15 56 00 Screenshot 2024-04-24 at 15 56 39

@tienifr
Copy link
Contributor Author

tienifr commented Apr 24, 2024

Awating last design decision:

Yes we only shows video time progress and volume control. Do you want to allow all controls?

@rushatgabhane
Copy link
Member

rushatgabhane commented Apr 24, 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 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
Screen.Recording.2024-04-24.at.15.07.24.mov
Android: mWeb Chrome
Screen.Recording.2024-04-24.at.15.13.28.mov
iOS: Native
Screen.Recording.2024-04-24.at.15.15.07.mov
Screen.Recording.2024-04-24.at.15.14.44.mov
iOS: mWeb Safari
Screen.Recording.2024-04-24.at.15.16.18.mov
MacOS: Chrome / Safari
Screen.Recording.2024-04-24.at.14.54.43.mov
Screen.Recording.2024-04-24.at.14.54.28.mov
MacOS: Desktop
Screen.Recording.2024-04-24.at.15.18.43.mov

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot melvin-bot bot requested a review from srikarparsi April 24, 2024 09:50
@shawnborton
Copy link
Contributor

I see a slight jump when the video first loads on desktop. You can see in this frame the video size is a bit different before it fully loads:
CleanShot 2024-04-24 at 07 41 52@2x

Then full size:
CleanShot 2024-04-24 at 07 42 22@2x

Can we fix that please?

@shawnborton
Copy link
Contributor

The same thing is happening on iOS too:
CleanShot 2024-04-24 at 07 42 58@2x

@dannymcclain
Copy link
Contributor

Yes we only shows video time progress and volume control. Do you want to allow all controls?

I'm curious for @Expensify/design's thoughts—but I don't see why we wouldn't allow all controls? Personally I'd rather them all be available, but I don't want to uproot a strategic decision if it was done for a specific purpose.

@shawnborton
Copy link
Contributor

Same thoughts here, I would think all of those controls would be available to the user.

@tienifr
Copy link
Contributor Author

tienifr commented Apr 24, 2024

I see a slight jump when the video first loads on desktop. You can see in this frame the video size is a bit different before it fully loads

#40675 (comment) @dubielzyk-expensify I wondered if we could make this track traning video and the onboarding video here consistent in aspect ratio (I just thought there should be consistency, shouldn't it??). They're 1560*1280 and 1280*960 respectively. Otherwise, I would need to manually change the code to specify the ratios. Also, I couldn't here the sound of the track training video? Is that expected?

@tienifr
Copy link
Contributor Author

tienifr commented Apr 24, 2024

Same thoughts here, I would think all of those controls would be available to the user.

Added full controls to the video:

Screenshot 2024-04-25 at 02 57 24

@dubielzyk-expensify
Copy link
Contributor

So this Track video was created mostly for a different use case which is why the aspect ratio is different. I'd ideally want the dialog to load and scale to the video size. If not, I can look into resizing them, but might wanna do that in a follow-up PR cause that means me changing 4 other videos we've made as well.

@tienifr
Copy link
Contributor Author

tienifr commented Apr 25, 2024

@dubielzyk-expensify Okay so I guess I should fix it now in this PR.

I see a slight jump when the video first loads on desktop. You can see in this frame the video size is a bit different before it fully loads

This is fixed now.

@tienifr
Copy link
Contributor Author

tienifr commented Apr 25, 2024

@srikarparsi We're ready for your review.

@srikarparsi
Copy link
Contributor

@tienifr lint looks to be failing. Can you run npm run lint and commit the changes?

@tienifr
Copy link
Contributor Author

tienifr commented Apr 25, 2024

@srikarparsi Updated!

Copy link
Contributor

@srikarparsi srikarparsi left a comment

Choose a reason for hiding this comment

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

lgtm thanks @tienifr and @rushatgabhane!

@srikarparsi srikarparsi merged commit 1276b1d into Expensify:main Apr 25, 2024
15 checks passed
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/srikarparsi in version: 1.4.67-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.67-7 🚀

platform result
🤖 android 🤖 failure ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.67-7 🚀

platform result
🤖 android 🤖 failure ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

onInputChange={toggleWillShowAgain}
/>
)}
{helpText && (
Copy link
Contributor

Choose a reason for hiding this comment

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

Coming from #45619 (comment), we need to ensure that the left part of a conditional rendering a React component is a boolean and NOT a string

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants