Skip to content

Conversation

@zirgulis
Copy link
Contributor

Explanation of Change

On Android devices, when editing mentions in a room chat, there is a large space displayed between the mention suggestions popup and the composer. This gap is inconsistent across different Android devices, with some devices (particularly Pixel phones) showing a significantly larger gap than others (like Samsung devices).

Implement an adaptive solution in getBottomSuggestionPadding/index.android.ts that calculates appropriate padding based on the device's aspect ratio.

Fixed Issues

$ #57734
PROPOSAL: #57734 (comment)

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • Verify that no errors appear in the JS console
  1. Open the Expensify app.
  2. Open any room chat or create one if necessary.
  3. Send a mention of any user that is not part of the room.
  4. Send another mention of a different user that is not part of the room.
  5. Return to inbox and open room again, so the system message for the first mention, appears again.
  6. With the keyboard opened, long tap over the second mention and select "Edit Message"
  7. Check the gap displayed between the mentions suggestions box and the edition composer.
  8. Suggestions box should be displayed above the edition composer, without a big space in between.

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 Pasted Graphic
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@zirgulis zirgulis requested a review from a team as a code owner March 14, 2025 14:39
@melvin-bot melvin-bot bot requested review from jjcoffee and removed request for a team March 14, 2025 14:39
@melvin-bot
Copy link

melvin-bot bot commented Mar 14, 2025

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

@jjcoffee
Copy link
Contributor

jjcoffee commented Mar 14, 2025

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • 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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
android-app-2025-04-01_16.12.54.mp4
Android: mWeb Chrome
android-chrome-2025-04-01_16.17.41.mp4
iOS: Native
ios-app-2025-04-01_16.35.02.mp4
iOS: mWeb Safari
ios-safari-2025-04-01_16.37.53.mp4
MacOS: Chrome / Safari
desktop-chrome-2025-04-01_16.10.36.mp4
MacOS: Desktop
desktop-app-2025-04-01_16.20.04.mp4

@jjcoffee
Copy link
Contributor

@zirgulis Thanks! Would you be able to add screenshots for other platforms, just for completeness?

@zirgulis
Copy link
Contributor Author

@zirgulis Thanks! Would you be able to add screenshots for other platforms, just for completeness?

@jjcoffee is it required, though? This change only affects Android native. Other platforms are not affected

@jjcoffee
Copy link
Contributor

is it required, though? This change only affects Android native. Other platforms are not affected

Usually, yes! I understand it's a bit annoying to do when you know for sure that the changes only affect one platform, but my understanding is we always enforce it to ensure there isn't some edge case where other platforms are unexpectedly affected.

@jjcoffee

This comment was marked as resolved.

@jjcoffee
Copy link
Contributor

@zirgulis Any thoughts on this?

@zirgulis
Copy link
Contributor Author

@jjcoffee I found some issues with the current approach, working on a fix, will ping you here in a few hours

@zirgulis
Copy link
Contributor Author

@jjcoffee could you please have another look? I've added some fixes

@jjcoffee
Copy link
Contributor

Thanks, I'll retest tomorrow!

@jjcoffee

This comment was marked as resolved.

@zirgulis
Copy link
Contributor Author

@jjcoffee hmmm this is what I see on my end:
image

Could you please try running:

  1. git clean -fxd
  2. npm i
  3. npm run android

This should make sure that there's no cached files and it should pickup the latest code changes

@jjcoffee

This comment was marked as resolved.

@zirgulis
Copy link
Contributor Author

@jjcoffee I added a commit with some console.logs for debugging. Could you please share what you get printed out?

@jjcoffee
Copy link
Contributor

@zirgulis Here ya go:

windowHeight 890.2857142857143 - (cursorCoordinates.y 27.809524536132812 - scrollValue 0 + y 793.5238647460938) - keyboardHeight -24 = 92.95232500348777
getBottomSuggestionPadding height 890.285714
AutoCompleteSuggestionsPortal bottomPadding 30
AutoCompleteSuggestionsPortal bottom + bottomPadding 122.952325

@zirgulis
Copy link
Contributor Author

@jjcoffee thank you so much for the details! I've made some fixes, could you please check again if it works on your end?

@jjcoffee
Copy link
Contributor

Thanks, I'll retest tomorrow!

@jjcoffee
Copy link
Contributor

jjcoffee commented Mar 26, 2025

@zirgulis Nice, that's much better!

One slight issue still, once the . is entered for the mention, the positioning adjusts and is too close to the input.

android-app-2025-03-26_15.58.47.mp4

@zirgulis
Copy link
Contributor Author

@zirgulis Nice, that's much better!

One slight issue still, once the . is entered for the mention, the positioning adjusts and is too close to the input.

android-app-2025-03-26_15.58.47.mp4

@jjcoffee yes that bug is also present on iOS:
image

This happens because cursorCoordinates.y returns a higher value which makes bottomValue smaller thus decreases the gap whenever the text input becomes multiline.

I think we can live with this since this seems like a corner case. In order to fix this we would need to do an extensive refactoring of all the code related to AutoCompleteSuggestions.

@jjcoffee
Copy link
Contributor

@zirgulis Okay thanks for confirming, that's fine if it's an existing bug.

function getBottomSuggestionPadding(bottom: number): number {
const {height} = Dimensions.get('window');

const bottomPercentageToHeight = (bottom / height) * 100;
Copy link
Contributor

Choose a reason for hiding this comment

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

@zirgulis Could you add some explanatory comments here? There's a lot of magic numbers that future devs won't know what to do with 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jjcoffee done!

@jjcoffee
Copy link
Contributor

jjcoffee commented Apr 1, 2025

@zirgulis Prettier is failing.

@zirgulis
Copy link
Contributor Author

zirgulis commented Apr 1, 2025

@zirgulis Prettier is failing.

@jjcoffee fixed

@jjcoffee
Copy link
Contributor

jjcoffee commented Apr 1, 2025

iOS seems to have the same bug as in the original issue:

ios-app-2025-04-01_16.35.02.mp4

@zirgulis
Copy link
Contributor Author

zirgulis commented Apr 2, 2025

iOS seems to have the same bug as in the original issue:

ios-app-2025-04-01_16.35.02.mp4

@jjcoffee The original issue is in regards to android, therefore the fix in this PR is focusing on android platform. Do we need another task for iOS? when can we merge this PR?

@jjcoffee
Copy link
Contributor

jjcoffee commented Apr 2, 2025

@zirgulis I think QA may just not have tested on all platforms. If the fix has the same RCA, we might be better off doing it in this PR, but if it's more complicated I agree it could be a followup.

Copy link
Contributor

@jjcoffee jjcoffee left a comment

Choose a reason for hiding this comment

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

LGTM for Android 👍

Approving to get a CME assigned to see whether or not we should create a separate issue to fix iOS, since it wasn't brought up in the original issue, and this has dragged on for a while already! cc @cead22

@melvin-bot
Copy link

melvin-bot bot commented Apr 2, 2025

We did not find an internal engineer to review this PR, trying to assign a random engineer to #57734 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

@melvin-bot melvin-bot bot requested a review from cead22 April 2, 2025 13:00
@cead22

This comment was marked as resolved.

@cead22

This comment was marked as resolved.

@cead22
Copy link
Contributor

cead22 commented Apr 3, 2025

Whoops ok I just read all the comments. I think it's up to you if you wanna fix iOS in this PR. That's what I'd recommend but not opposed to doing it in a separate PR

const contentMaxHeight = measureHeightOfSuggestionRows(suggestionsLength, true);
const contentMinHeight = measureHeightOfSuggestionRows(suggestionsLength, false);
let bottomValue = windowHeight - (cursorCoordinates.y - scrollValue + y) - keyboardHeight;

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

const StyleUtils = useStyleUtils();
const styles = useMemo(() => StyleUtils.getBaseAutoCompleteSuggestionContainerStyle({left, width, bottom: bottom + getBottomSuggestionPadding()}), [StyleUtils, left, width, bottom]);
const bottomPadding = Platform.OS === 'android' ? (getBottomSuggestionPadding as GetBottomSuggestionPaddingAndroid)(bottom) : getBottomSuggestionPadding();

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

function AutoCompleteSuggestionsPortal<TSuggestion>({left = 0, width = 0, bottom = 0, resetSuggestions = () => {}, ...props}: AutoCompleteSuggestionsPortalProps<TSuggestion>) {
const StyleUtils = useStyleUtils();
const styles = useMemo(() => StyleUtils.getBaseAutoCompleteSuggestionContainerStyle({left, width, bottom: bottom + getBottomSuggestionPadding()}), [StyleUtils, left, width, bottom]);
const bottomPadding = Platform.OS === 'android' ? (getBottomSuggestionPadding as GetBottomSuggestionPaddingAndroid)(bottom) : getBottomSuggestionPadding();
Copy link
Contributor

Choose a reason for hiding this comment

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

I thought we weren't supposed to do this Platform.OS === 'android'. Is this allowed in index.native.tsx 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.

@cead22 I think in this case it's ok to have this check since the platform-specific difference is minimal. Creating a separate index.ios.tsx would result in significant code duplication

Copy link
Contributor

Choose a reason for hiding this comment

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

Why's that? We're already importing getBottomSuggestionPadding, can't we make that platform specific?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@cead22 getBottomSuggestionPadding is platform specific, but we pass bottom param only to the android version of getBottomSuggestionPadding, therefore there's Platform.OS === 'android' check

Copy link
Contributor

Choose a reason for hiding this comment

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

Can we create a getBottomSuggestionPadding for ios and use that here? If not, can you elaborate on why we'd need a lot of duplicate code?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@cead22 we already have getBottomSuggestionPadding for iOS here

However we only need bottom param for the getBottomSuggestionPadding/index.android.ts , that's why I added Platform.OS === 'android' check so we would only pass bottom param to getBottomSuggestionPadding function in android file

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 pass the param to the iOS function and do nothing with it, so we can simplify this code?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@cead22 yes, added that in my latest commit

@jjcoffee
Copy link
Contributor

jjcoffee commented Apr 7, 2025

Friendly bump @zirgulis on @cead22's comments.

@zirgulis
Copy link
Contributor Author

zirgulis commented Apr 7, 2025

@jjcoffee @cead22 regarding the iOS: we should create a separate task for that. I checked last week what's going on iOS and the fix might not be so straightforward and might affect other platforms. For iOS the issue is when the measureParentContainerAndReportCursor kicks in. @cead22 if someone from Expensify team could create an issue for it I would be happy to work on it

@cead22 cead22 merged commit 0209727 into Expensify:main Apr 9, 2025
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Apr 9, 2025

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@github-actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cead22 in version: 9.1.26-0 🚀

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

@kavimuru
Copy link

@jasperhuangg
Copy link
Contributor

jasperhuangg commented Apr 10, 2025

@kavimuru That is unrelated to the original issue as it only deals with Android. Is there an existing issue for this, or can we create one to track the iOS version of this problem?

@github-actions
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.1.26-10 🚀

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

@jjcoffee jjcoffee mentioned this pull request Apr 17, 2025
50 tasks
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