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

clean up existing Product training tooltips #53396

Merged
merged 36 commits into from
Dec 12, 2024

Conversation

ishpaul777
Copy link
Contributor

@ishpaul777 ishpaul777 commented Dec 2, 2024

Explanation of Change

Fixed Issues

$ #53086
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console
  1. Sign up with new Account (say Account A). Completed Onboarding flow
    2.( On desktop, resize screen to mobile size) verify Tooltip on Concierge is displayed
    3.Create a workpace, go back and open FAB menu, Verify that a tooltip on QAB is visibile
  2. Go to search screen > Filters > Add and save a filter verify tooltip is shown on saved search threedot. (this is visible on desktop screen size only)
  3. As another user create a workspace, invite this user A to the workspace
  4. As user A go the invited workspace chat verify tooltip on "+" is shown.

Offline tests

QA Steps

Same as test steps

  • 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-09.at.10.49.16.PM.mov
Android: mWeb Chrome
iOS: Native
Screen.Recording.2024-12-09.at.10.09.07.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-12-09.at.10.16.32.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-12-09.at.10.13.41.PM.mov
MacOS: Desktop
Screen.Recording.2024-12-09.at.10.58.01.PM.mov

@ishpaul777 ishpaul777 changed the title Product training tooltips clean up existing Product training tooltips Dec 5, 2024
@ishpaul777 ishpaul777 mentioned this pull request Dec 6, 2024
50 tasks
Copy link
Contributor

@rayane-djouah rayane-djouah left a comment

Choose a reason for hiding this comment

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

I would be happy to review this since I reviewed #53225 and have context

@ishpaul777
Copy link
Contributor Author

Please start when you can, i'll completed checklist in couple hours/tomorrow

@ishpaul777
Copy link
Contributor Author

ishpaul777 commented Dec 10, 2024

@rayane-djouah I have resolved/responded to your review comments above, will you be able to re-review.

Copy link
Contributor

@rayane-djouah rayane-djouah left a comment

Choose a reason for hiding this comment

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

Code looks good! Testing..

@rayane-djouah
Copy link
Contributor

@ishpaul777, BUG: The tooltips do not display the correct colors in dark mode:

Screenshot Screenshot 2024-12-10 at 9 05 54 PM

@rayane-djouah
Copy link
Contributor

@ishpaul777, BUG: The workspaceChatCreate tooltip breaks when the keyboard is open:

Screenshot Screenshot 2024-12-10 at 9 11 08 PM

@rayane-djouah
Copy link
Contributor

Screenshots/Videos

Android: Native
Screen.Recording.2024-12-10.at.9.09.20.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-12-10.at.9.14.22.PM.mov
iOS: Native
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-12-10.at.21.01.16.mp4
iOS: mWeb Safari
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-12-10.at.21.03.02.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-12-10.at.8.15.36.PM.mov
Screen.Recording.2024-12-10.at.8.26.47.PM.mov
MacOS: Desktop
Screen.Recording.2024-12-10.at.8.17.37.PM.mov

@ishpaul777
Copy link
Contributor Author

ishpaul777 commented Dec 11, 2024

@ishpaul777, BUG: The workspaceChatCreate tooltip breaks when the keyboard is open:

reproducable on main as well with QAB tooltip also

Record_2024-12-12-00-01-48.mp4

@rayane-djouah
Copy link
Contributor

reproducable on main as well with QAB tooltip also

Yeah, confimed 👍

Screenshot

Screenshot_1733951703

@rayane-djouah
Copy link
Contributor

rayane-djouah commented Dec 11, 2024

Screenshots/Videos

Android: Native
Screen.Recording.2024-12-11.at.10.35.23.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-12-11.at.10.40.02.PM.mov

Screenshot_1733953360

iOS: Native
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-12-11.at.22.46.00.mp4

Simulator Screenshot - iPhone 15 Pro Max - 2024-12-11 at 22 57 06

iOS: mWeb Safari
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-12-11.at.22.59.24.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-12-11.at.11.01.49.PM.mov
MacOS: Desktop
Screen.Recording.2024-12-11.at.10.46.51.PM.mov
Screenshot 2024-12-11 at 10 56 43 PM

@ishpaul777
Copy link
Contributor Author

i have updated translation and hide this behind beta for now!

@rayane-djouah
Copy link
Contributor

Copy link
Contributor

@rayane-djouah rayane-djouah left a comment

Choose a reason for hiding this comment

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

LGTM and tests well 👍

@melvin-bot melvin-bot bot requested a review from puneetlath December 11, 2024 22:58
/**
* When user dismisses the conciergeLHNGBR product training tooltip, we store the timestamp here.
*/
conciergeLHNGBR: Date;
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we use the constants from Const file for these? Or do we not typically do that for types files?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

something like this @puneetlath ?

import CONST from '@src/CONST';

const {CONCEIRGE_LHN_GBR, RENAME_SAVED_SEARCH, WORKSAPCE_CHAT_CREATE, QUICK_ACTION_BUTTON} = CONST.PRODUCT_TRAINING_TOOLTIP_NAMES;

type DismissedProductTraining = {
    /**
     * When user dismisses the nudgeMigration Welcome Modal, we store the timestamp here.
     */
    [CONST.MIGRATED_USER_WELCOME_MODAL]: Date;

    /**
     * When user dismisses the conciergeLHNGBR product training tooltip, we store the timestamp here.
     */
    [CONCEIRGE_LHN_GBR]: Date;

    .......
};


Copy link
Contributor

Choose a reason for hiding this comment

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

Yes exactly. What do you think?

@@ -0,0 +1,67 @@
import type {ValueOf} from 'type-fest';
Copy link
Contributor

Choose a reason for hiding this comment

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

This all caps filename seems unusual. Is that usually how we name these?

@puneetlath puneetlath merged commit d56dfec into Expensify:main Dec 12, 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.

Copy link
Contributor

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

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

@IuliiaHerets IuliiaHerets mentioned this pull request Dec 13, 2024
8 tasks
@IuliiaHerets
Copy link

This PR is failing because of issue #54127

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.

5 participants