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

Suggestion box for edit input #44720

Merged
merged 37 commits into from
Jul 11, 2024

Conversation

perunt
Copy link
Contributor

@perunt perunt commented Jul 2, 2024

Details

This PR updates the suggestion box (in edit mode) to appear right next to the cursor, making it work like inline autosuggestion.

Fixed Issues

$ #19643
PROPOSAL:

Tests

Tests
Testing Emoji Suggestions:

  1. Open the chat interface.
  2. Edit message
  3. Type an emoji trigger, starting with :sm followed by at least two more characters (e.g., :smile).
  4. Verify that the suggestion box appears adjacent to the cursor.
  5. Move the cursor to a new position in the text field.
  6. Again, type an emoji-like text with at least two characters following the :sm prefix.
  7. Confirm that the suggestion box appears next to the cursor as expected.

Testing Mention Suggestions:

  1. Open the chat interface.
  2. Edit message
  3. Initiate a mention by typing the @ symbol followed by any text (e.g., @username).
  4. Ensure the suggestion box pops up next to the cursor.
  5. Reposition the cursor within the text field.
  6. Type another mention, starting with the @ symbol.
  7. Check that the suggestion box is correctly displayed adjacent to the cursor.
  • Verify that no errors appear in the JS console

Offline tests

QA 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 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
2024-07-03.14.56.51.mp4
Android: mWeb Chrome
2024-07-03.15.25.43.mp4
iOS: Native
RPReplay_Final1720001461.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
Untitled.mov
MacOS: Desktop
Untitled.2.mov

@perunt perunt marked this pull request as ready for review July 3, 2024 15:15
@perunt perunt requested a review from a team as a code owner July 3, 2024 15:15
@melvin-bot melvin-bot bot requested review from rayane-djouah and removed request for a team July 3, 2024 15:15
Copy link

melvin-bot bot commented Jul 3, 2024

@rayane-djouah 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]

@puneetlath
Copy link
Contributor

@perunt your plan sounds good to me.

@rayane-djouah
Copy link
Contributor

@perunt - Lint is failing

@perunt
Copy link
Contributor Author

perunt commented Jul 9, 2024

@rayane-djouah done

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.

Thank you!

@perunt perunt mentioned this pull request Jul 10, 2024
50 tasks
@perunt
Copy link
Contributor Author

perunt commented Jul 10, 2024

@puneetlath it looks good to go

@perunt
Copy link
Contributor Author

perunt commented Jul 10, 2024

Also, I just finished the task with hiding the suggestion box
#45076

@rayane-djouah
Copy link
Contributor

Would love to review the next PR as I have context, @puneetlath please assign it to me if possible

Copy link
Contributor

@puneetlath puneetlath left a comment

Choose a reason for hiding this comment

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

Left a handful of comments, mostly about naming. Overall looks solid to me.

@@ -193,6 +194,8 @@ function SuggestionEmoji(

const getSuggestions = useCallback(() => suggestionValues.suggestedEmojis, [suggestionValues]);

const checkIfSuggestionVisible = useCallback(() => isEmojiSuggestionsMenuVisible, [isEmojiSuggestionsMenuVisible]);
Copy link
Contributor

Choose a reason for hiding this comment

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

Our guidelines for booleans are that they should start with is or are to indicate true/false. I think the following naming makes more sense for what this is doing based on my understanding. In that it will return true/false based on whether the suggestion menu is visible.

Suggested change
const checkIfSuggestionVisible = useCallback(() => isEmojiSuggestionsMenuVisible, [isEmojiSuggestionsMenuVisible]);
const isSuggestionsMenuVisible = useCallback(() => isEmojiSuggestionsMenuVisible, [isEmojiSuggestionsMenuVisible]);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, it makes sense. The only concern is that it's a callback, and it would be quite confusing to do isSuggestionsMenuVisible(), so maybe it makes sense to name it getIsSuggestionsMenuVisible?

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah cool. That makes sense to me.

src/pages/home/report/ReportActionCompose/Suggestions.tsx Outdated Show resolved Hide resolved
src/components/AutoCompleteSuggestions/index.tsx Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItemMessageEdit.tsx Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItemMessageEdit.tsx Outdated Show resolved Hide resolved
@perunt perunt requested a review from puneetlath July 11, 2024 08:29
@perunt
Copy link
Contributor Author

perunt commented Jul 11, 2024

@puneetlath can you take a look again?

@puneetlath puneetlath merged commit e7c027a into Expensify:main Jul 11, 2024
14 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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.0.7-3 🚀

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

@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 9.0.7-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.7-8 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.8-6 🚀

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

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.

4 participants