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

Fix padding for edit composer suggestions #41071

Merged
merged 7 commits into from
Oct 7, 2024

Conversation

dukenv0307
Copy link
Contributor

@dukenv0307 dukenv0307 commented Apr 26, 2024

Details

Fixed Issues

$ #34442
#40861
#40864
#40856
#40854
PROPOSAL: #34442 (comment)

Tests

  1. Open any report
  2. Send some messages
  3. Edit a message
  4. Type @ and verify that the mention suggestion list appears with spacing between composer is 8px
  5. Type :sm and verify that the emoji suggestion list appears with spacing between composer is 8px
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Open any report
  2. Send some messages
  3. Edit a message
  4. Type @ and verify that the mention suggestion list appears with spacing between composer is 8px
  5. Type :sm and verify that the emoji suggestion list appears with spacing between composer is 8px
  • 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
Screen.Recording.2024-08-28.at.16.19.33.mov
Android: mWeb Chrome
Screen.Recording.2024-08-28.at.16.30.52.mov
iOS: Native
Screen.Recording.2024-08-28.at.16.20.33.mov
iOS: mWeb Safari
Screen.Recording.2024-08-28.at.16.18.25.mov
MacOS: Chrome / Safari
Screen.Recording.2024-08-28.at.16.17.02.mov
MacOS: Desktop
Screen.Recording.2024-08-28.at.16.26.40.mov

@dukenv0307 dukenv0307 marked this pull request as ready for review May 21, 2024 09:59
@dukenv0307 dukenv0307 requested review from a team as code owners May 21, 2024 09:59
@melvin-bot melvin-bot bot requested review from eVoloshchak and removed request for a team May 21, 2024 09:59
Copy link

melvin-bot bot commented May 21, 2024

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

@dukenv0307
Copy link
Contributor Author

@eVoloshchak The PR is ready for review.

@shawnborton
Copy link
Contributor

Design-wise this seems pretty good.

src/libs/SuggestionUtils.ts Outdated Show resolved Hide resolved
_containerHeight: number,
): ViewStyle {
return {
top: -(height + (shouldBeDisplayedBelowParentContainer ? -2 : 1) * (suggestionsPadding + (shouldPreventScroll ? 0 : borderWidth))),
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
top: -(height + (shouldBeDisplayedBelowParentContainer ? -2 : 1) * (suggestionsPadding + (shouldPreventScroll ? 0 : borderWidth))),
top: -(height + (shouldBeDisplayedBelowParentContainer ? -CONST.AUTO_COMPLETE_SUGGESTER.BORDER_WIDTH : 1) * (suggestionsPadding + (shouldPreventScroll ? 0 : borderWidth))),

Copy link
Contributor Author

Choose a reason for hiding this comment

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

2 here does not mean CONST.AUTO_COMPLETE_SUGGESTER.BORDER_WIDTH.

@dukenv0307
Copy link
Contributor Author

@eVoloshchak I updated please help to check again.

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

On iOS, the following error pops up when suggestions or emoji list is opened (I suspect this might be resolved by merging main)

Screen.Recording.2024-06-11.at.14.33.25.mov

@eVoloshchak
Copy link
Contributor

@dukenv0307, I'm still encountering the same error

Screen.Recording.2024-06-18.at.17.13.15.mov

Verified this doesn't exist on main. Could you double-check if this is working for you on iOS?

@dukenv0307
Copy link
Contributor Author

@eVoloshchak I tested and this bug is fixed now.

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

Suggestions and emoji list are displayed on top of the composer, this doesn't look right, can we remove it to the top?
Simulator Screenshot - iPhone 15 Pro - 2024-06-25 at 22 24 58
Simulator Screenshot - iPhone 15 Pro - 2024-06-25 at 22 24 27

It looks correctly on mWeb

Simulator Screenshot - iPhone 15 Pro - 2024-06-25 at 22 26 50

@shawnborton
Copy link
Contributor

We recently changed the top/bottom padding of our popovers to be 16px instead of 12px, so I wonder if we need to update the offset by 8px to correct that.

@dannymcclain
Copy link
Contributor

We recently changed the top/bottom padding of our popovers to be 16px instead of 12px, so I wonder if we need to update the offset by 8px to correct that.

Oh good call Shawn, I bet that's why we're getting this little overlap with the composer.

@dukenv0307
Copy link
Contributor Author

@eVoloshchak I can't reproduce this bug above.

Screen.Recording.2024-07-04.at.15.41.28.mov

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

@dukenv0307, it is reproducible on Web and mWeb

Screen.Recording.2024-07-08.at.12.18.47.mov

It's also reproducible for the regular composer (not the edit one) on staging, we don't need to fix that in this PR, but I suspect it will be fixed for both with a single fix (@dukenv0307, could you please check if this does the trick?)

@dukenv0307
Copy link
Contributor Author

@eVoloshchak So we want to add a space between the suggestion and the composer, right?

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

So we want to add a space between the suggestion and the composer, right?

@dukenv0307, yes, it should have the same padding as the emoji modal for default composer

Screenshot 2024-07-24 at 08 24 03

Currently, it overlaps with the edit composer

Screenshot 2024-07-24 at 08 24 32

@dukenv0307
Copy link
Contributor Author

@eVoloshchak I updated, please help to check again.

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

Looking good now! (noting the same problem exists for the emoji modal, but that exists on staging and unrelated to this PR)

@dukenv0307, I'm a bit late, apologies for that, could you resolve the conflicts and I'll give this the last round of testing?

@dukenv0307
Copy link
Contributor Author

@eVoloshchak I updated.

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Aug 5, 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-10-07.at.13.41.32.mov
Android: mWeb Chrome
Screen.Recording.2024-10-07.at.13.44.50.mov
iOS: Native
Screen.Recording.2024-10-07.at.13.23.45.mov
iOS: mWeb Safari
Screen.Recording.2024-10-07.at.13.34.49.mov
MacOS: Chrome / Safari
Screen.Recording.2024-10-07.at.13.22.20.mov
MacOS: Desktop
Screen.Recording.2024-10-07.at.13.45.52.mov

@eVoloshchak
Copy link
Contributor

@dukenv0307, when testing this I noticed that emoji suggestions have already been implemented for the edit composer

screen-20240805-120423.mp4

Am I missing something? Looks like the previous PR was reverted, was this added by another PR?

@dukenv0307
Copy link
Contributor Author

@eVoloshchak I updated.

@eVoloshchak
Copy link
Contributor

@dukenv0307, we don't need any other changes besides different padding (fix for #41071 (review)). Treat this like a new PR (or go ahead and create a new PR, your choice)

@dukenv0307
Copy link
Contributor Author

we don't need any other changes besides different padding (fix for #41071 (review)). Treat this like a new PR (or go ahead and create a new PR, your choice)

@eVoloshchak This is all changes that we need to fix the padding issue.

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

  • Bug 1

suggestions list doesn't open when typing "@", emoji suggestions list doesn't open when starting to type an emoji name (this doesn't happen 100% of the times, but pretty consistently)

Screen.Recording.2024-08-27.at.14.54.37.mov
  • Bug 2 (Android)

Both lists overlap with the keyboard/UI (padding calculation is not correct)

Screenshot 2024-08-27 at 14 59 58
Screen.Recording.2024-08-27.at.14.51.37.mov
  • In addition to that, could you please update the testing steps, retest this on all of the platforms and update the Screenshots/Videos section please?

@dukenv0307
Copy link
Contributor Author

suggestions list doesn't open when typing "@", emoji suggestions list doesn't open when starting to type an emoji name (this doesn't happen 100% of the times, but pretty consistently)

@eVoloshchak Is this bug reproducible on the latest main

Both lists overlap with the keyboard/UI (padding calculation is not correct)

I can't reproduce this bug.

In addition to that, could you please update the testing steps, retest this on all of the platforms and update the Screenshots/Videos section please?

I updated the test steps and screenshots.

@eVoloshchak
Copy link
Contributor

Is this bug reproducible on the latest main

Confirmed this is reproducible on staging

I can't reproduce this bug.

I can reliably reproduce it on native Android

Screen.Recording.2024-09-04.at.17.01.54.mov

@dukenv0307
Copy link
Contributor Author

@eVoloshchak Did you try to disable the strict mode?

@eVoloshchak
Copy link
Contributor

Turns out this is working correctly on a physical device, must be a problem with an emulator
@dukenv0307, could you pull the latest main please?

@dukenv0307
Copy link
Contributor Author

@eVoloshchak I updated.

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

Still doesn't look right on mWeb Safari. This isn't a simulator issue, current staging works fine in a simulator

Screen.Recording.2024-09-15.at.10.23.24.mov

@dukenv0307
Copy link
Contributor Author

Investigating.

@dukenv0307
Copy link
Contributor Author

@eVoloshchak This bug happens because measureInWindow returns the wrong y position on mWeb safari when the keyboard is opened. We can also reproduce this bug in staging and production.

Screen.Recording.2024-09-25.at.17.48.09.mov
Screen.Recording.2024-09-25.at.17.51.56.mov
Screen.Recording.2024-09-25.at.17.50.42.mov

@dukenv0307
Copy link
Contributor Author

@eVoloshchak Friendly bump.

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

LGTM!

@stitesExpensify stitesExpensify changed the title Implement suggestion for edit composer Fix padding for edit composer suggestions Oct 7, 2024
@stitesExpensify stitesExpensify merged commit 2859dc2 into Expensify:main Oct 7, 2024
18 checks passed
Copy link
Contributor

github-actions bot commented Oct 7, 2024

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 9.0.46-0 🚀

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

@IuliiaHerets
Copy link

This PR is failing for Android app because of issue #50377

Copy link
Contributor

github-actions bot commented Oct 9, 2024

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.46-5 🚀

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.

6 participants