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

New product training tooltips #54064

Merged
merged 28 commits into from
Dec 13, 2024

Conversation

ishpaul777
Copy link
Contributor

@ishpaul777 ishpaul777 commented Dec 12, 2024

Explanation of Change

Fixed Issues

$ #53087
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console
  • Sign in with new account, complete onboarding flow.
  • On small screen verify "Get started!" tooltip show on conceirge chat. Dismiss it clicking anywhere on screen.
  • On large screen, verify tooltip on FAB button appears. Dismiss it clicking anywhere on screen.
  • Create a workspace if not already, veriffy when there's a workspace chat in LHN verify tooltip on workspace chat shows. (on both large and small screen) Dismiss it clicking anywhere on screen.
  • click on search bottom tab, verify tooltip on filter button shows up. Dismiss it clicking anywhere on screen.
  • Verify a tooltip on inbox icon in bottom tab shows up. Dismiss it clicking anywhere on screen.

Offline tests

QA Steps

Same as tests

  • 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
Record_2024-12-13-18-38-24.mp4
Android: mWeb Chrome
Record_2024-12-13-18-14-31.mp4
iOS: Native
Screen.Recording.2024-12-13.at.5.44.54.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-12-13.at.5.48.22.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-12-13.at.6.11.36.PM.mov
MacOS: Desktop
Screen.Recording.2024-12-13.at.6.24.31.PM.mov

ishpaul777 and others added 4 commits December 13, 2024 03:40
Co-authored-by: rayane-djouah <77965000+rayane-djouah@users.noreply.github.com>
Co-authored-by: rayane-djouah <77965000+rayane-djouah@users.noreply.github.com>
Co-authored-by: rayane-djouah <77965000+rayane-djouah@users.noreply.github.com>
Co-authored-by: rayane-djouah <77965000+rayane-djouah@users.noreply.github.com>
Comment on lines 17 to 20
if (shouldUseNarrowLayout) {
return isFocused || topmostCentralPane?.name === SCREENS.SEARCH.CENTRAL_PANE;
}
return isFocused || Object.keys(CENTRAL_PANE_SCREENS).includes(topmostCentralPane?.name ?? '');
Copy link
Contributor

Choose a reason for hiding this comment

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

We shouldn't show the tooltip if the component is not focused, right?

Suggested change
if (shouldUseNarrowLayout) {
return isFocused || topmostCentralPane?.name === SCREENS.SEARCH.CENTRAL_PANE;
}
return isFocused || Object.keys(CENTRAL_PANE_SCREENS).includes(topmostCentralPane?.name ?? '');
if (shouldUseNarrowLayout) {
return isFocused && topmostCentralPane?.name === SCREENS.SEARCH.CENTRAL_PANE;
}
return isFocused && Object.keys(CENTRAL_PANE_SCREENS).includes(topmostCentralPane?.name ?? '');

Copy link
Contributor Author

Choose a reason for hiding this comment

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

for some reason isFocused is always false for components in bottom tab, no idea why

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ishpaul777 ishpaul777 requested a review from rayane-d December 13, 2024 13:01
@ishpaul777 ishpaul777 marked this pull request as ready for review December 13, 2024 13:50
@ishpaul777 ishpaul777 requested review from a team as code owners December 13, 2024 13:50
@melvin-bot melvin-bot bot requested a review from puneetlath December 13, 2024 13:50
@dannymcclain
Copy link
Contributor

Sorry to be so nitpicky 🙈, but can we check the padding values and the border radius for the tooltip?

In Figma, the tooltips have 12px vertical padding and 16px horizontal padding, and a border radius of 8px.

Copy link
Contributor

@rayane-d rayane-d left a comment

Choose a reason for hiding this comment

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

@ishpaul777 Did you confirm the translations on Slack?

workspaceChatTooltip: {
part1: 'Review submitted expenses and chat',
part2: '\nwith approvers in your',
part3: ' workspace 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
part3: ' workspace chat.',
part3: ' workspace chat',

globalCreateTooltip: {
part1: 'Where to ',
part2: 'create expenses,',
part3: '\nstart chatting, and more.',
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
part3: '\nstart chatting, and more.',
part3: '\nstart chatting, and more',

workspaceChatTooltip: {
part1: 'Revisa los gastos enviados y chatea',
part2: '\ncon los aprobadores en tu',
part3: ' chat del espacio de trabajo.',
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
part3: ' chat del espacio de trabajo.',
part3: ' chat del espacio de trabajo',

globalCreateTooltip: {
part1: 'Dónde ',
part2: 'crear gastos,',
part3: '\nempezar a chatear y más.',
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
part3: '\nempezar a chatear y más.',
part3: '\nempezar a chatear y más',

@ishpaul777
Copy link
Contributor Author

asked but still needs confirmation https://expensify.slack.com/archives/C07NMDKEFMH/p1734116662021799 will update accordingly

@rayane-d
Copy link
Contributor

Sorry to be so nitpicky 🙈, but can we check the padding values and the border radius for the tooltip?

In Figma, the tooltips have 12px vertical padding and 16px horizontal padding, and a border radius of 8px.

Currently the tooltips use 8px horizontal padding, 4px vertical padding and 4px border radius:

borderRadius: variables.componentBorderRadiusSmall,
...tooltipVerticalPadding,
...spacing.ph2,

@ishpaul777
Copy link
Contributor Author

yes the the tooltips have combined padding of 12px vertical padding and 16px horizontal padding, (Outer container 4px 8px, inner container 8px 8px)

border radius was 4px i updated it to 8px now

Screenshot 2024-12-14 at 1 06 19 AM

@ishpaul777 ishpaul777 mentioned this pull request Dec 13, 2024
8 tasks
puneetlath
puneetlath previously approved these changes Dec 13, 2024
@ishpaul777
Copy link
Contributor Author

@rayane-djouah This is approved copy and translations, will you please give this a quick review

Screenshot 2024-12-14 at 3 05 49 AM

@ishpaul777 ishpaul777 requested a review from rayane-d December 13, 2024 21:36
@puneetlath puneetlath merged commit 12de96f into Expensify:main Dec 13, 2024
17 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.

@titaniumdev80
Copy link

@puneetlath Sorry, could you let me know where I can find the instructions to generate certificates? Thanks

@titaniumdev80
Copy link

@puneetlath No worries. I've just found it out. Thanks

@puneetlath puneetlath mentioned this pull request Dec 17, 2024
50 tasks
Copy link
Contributor

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.0.77-0 🚀

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

@puneetlath
Copy link
Contributor

FYI we had to revert this because it created a HybridApp crash for a yet-unknown reason: #54260

@ishpaul777 ishpaul777 mentioned this pull request Dec 18, 2024
50 tasks
@ishpaul777
Copy link
Contributor Author

@kavimuru The PR was reverted no need for QA here

Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.77-6 🚀

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

<EducationalTooltip
shouldRender={shouldShowProductTrainingTooltip}
anchorAlignment={{
vertical: CONST.MODAL.ANCHOR_ORIGIN_VERTICAL.BOTTOM,
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 here #57070, because of the tooltip overlaps the expensify logo, we decide to change the vertical alignment to TOP.

@@ -156,17 +158,18 @@ function OptionRowLHN({reportID, isFocused = false, onSelectRow = () => {}, opti
needsOffscreenAlphaCompositing
>
<EducationalTooltip
shouldRender={shouldShowProductTrainingTooltip}
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
shouldRender={shouldShowProductTrainingTooltip && (isActiveWorkspaceChat || shouldShowGetStartedTooltip)}
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi team,

Coming from #56952, we should exclude a case that workspace chat is a taskThread, otherwise it will show multiple tooltips. More details here #56952 (comment)

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.

10 participants