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: split amount is put into a second line #43624

Merged
merged 13 commits into from
Jul 15, 2024
Merged

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Jun 12, 2024

Details

Split amount overflows and jumps into a second line. This PR fixes that.

Fixed Issues

$ #42117
PROPOSAL: #42117 (comment)

Tests

  1. Tap FAB > Split expense
  2. Enter $199.98 amount
  3. Proceed to the confirmation screen with another participant
  4. Verify the split amounts for each participant display in one line
  • Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

  1. Tap FAB > Split expense
  2. Enter $199.98 amount
  3. Proceed to the confirmation screen with another participant
  4. Verify the split amounts for each participant display in one line
  • 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

image

Android: mWeb Chrome

image

iOS: Native

Simulator Screenshot - iPhone 15 Pro Max - 2024-06-14 at 17 32 45
simulator_screenshot_BF7042EB-7DF6-41A0-91CB-9C6FD9080E6A

iOS: mWeb Safari

Simulator Screenshot - iPhone 15 Pro Max - 2024-06-14 at 17 37 29

MacOS: Chrome / Safari

Screenshot 2024-06-14 at 17 32 55

Screenshot 2024-06-14 at 17 34 06

MacOS: Desktop

Screenshot 2024-06-14 at 17 35 37

Copy link

melvin-bot bot commented Jun 12, 2024

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@tienifr
Copy link
Contributor Author

tienifr commented Jun 13, 2024

main is too buggy right now. But everything was tested well early today. I'll complete the screenshots tomorrow.

@tienifr tienifr marked this pull request as ready for review June 14, 2024 10:43
@tienifr tienifr requested a review from a team as a code owner June 14, 2024 10:43
@melvin-bot melvin-bot bot requested review from dukenv0307 and removed request for a team June 14, 2024 10:43
Copy link

melvin-bot bot commented Jun 14, 2024

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

@tienifr
Copy link
Contributor Author

tienifr commented Jun 14, 2024

@dukenv0307 PR ready for review.

@dukenv0307
Copy link
Contributor

Can you check the 2 images below? The distance between the currency symbol and the amount is quite longer than the original one

  • This PR
Screenshot 2024-06-14 at 23 13 27
  • Current main
Screenshot 2024-06-14 at 23 13 33

@dukenv0307
Copy link
Contributor

@tienifr bump

@dukenv0307
Copy link
Contributor

@tienifr friendly bump

@tienifr
Copy link
Contributor Author

tienifr commented Jun 27, 2024

On it now. I was working on a related PR and thought it's better to finish it first before this so we wouldn't have expectation conflicts.

@dangrous
Copy link
Contributor

dangrous commented Jul 1, 2024

That would be great, thanks!

touchableInputWrapperStyle={[styles.ml3]}
onFormatAmount={CurrencyUtils.convertToDisplayStringWithoutCurrency}
onAmountChange={(value: string) => onSplitShareChange(participantOption.accountID ?? -1, Number(value))}
maxLength={formattedTotalAmount.length}
contentWidth={CurrencyUtils.convertToDisplayStringWithoutCurrency(maxSplitAmount).length * 9}
Copy link
Contributor Author

@tienifr tienifr Jul 2, 2024

Choose a reason for hiding this comment

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

Earlier we assumed each digit occupies 9px then multiply the total amount with 9 to compute the content width. That's to make sure the all the split input widths are equal and are the longest possible number length which assumingly is the total amount.

But since the paddings, margins... are no longer inclusive in this content width, in case the total amount has more digits than the individual split amount, we would have a larger input width.

So I kept the old requirement: the split input widths are equal and are the longest possible number length but the longest possible number now is not based on the total amount but the individual split amount.

@dukenv0307
Copy link
Contributor

@tienifr I think we need to keep using formattedTotalAmount like what you propose. There're 2 problems in your code above:

  1. You don't pass currency to convertToDisplayStringWithoutCurrency, so it uses USD by default. For the currency that doesn't have fractions, it returns the wrong value
  2. The split value is sth changeable, so its width will be blink when users change the individual split amount

@dukenv0307
Copy link
Contributor

@tienifr any updates?

@tienifr
Copy link
Contributor Author

tienifr commented Jul 10, 2024

@dukenv0307 As per my investigation, 9 is the longest possible digit width so it was used as a base width for all digits to make sure any digit can fit in:

App/src/styles/utils/index.ts

Lines 1106 to 1108 in b573e74

if ((number >= 6 && number <= 9) || number === 0) {
return percentage(112.5, defaultWidth);
}

The above snippet was previously used to compute the exact number width based on each digit (but we eventually used fixed width 9).

So I think reducing it to 8 makes sense in this case, I already tried with 99.99 and it worked perfectly.

Screenshot 2024-07-10 at 15 19 23
This PR staging
Screenshot 2024-07-10 at 15 17 30 Screenshot 2024-07-10 at 15 18 26

@dukenv0307
Copy link
Contributor

I found the following bug:

  1. Split expense
  2. Enter amount
  3. Choose participants
  4. Click Next
  5. On the participant input, change the amount to a very large number
  6. Observe the input is broken
Screen.Recording.2024-07-10.at.16.03.33.mov

@dukenv0307
Copy link
Contributor

@tienifr ^

@tienifr
Copy link
Contributor Author

tienifr commented Jul 11, 2024

@dukenv0307 I see in your recording that there are duplicated participants (2 duke accounts). This seems to be another issue. Normally, each split amount is automatically calculated properly.

Screenshot 2024-07-11 at 16 31 52

@dukenv0307
Copy link
Contributor

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 Screenshot 2024-07-12 at 16 31 22
Android: mWeb Chrome Screenshot 2024-07-12 at 16 28 55
iOS: Native Screenshot 2024-07-12 at 16 31 43
iOS: mWeb Safari Screenshot 2024-07-12 at 16 25 18
MacOS: Chrome / Safari Screenshot 2024-07-12 at 16 23 19
MacOS: Desktop Screenshot 2024-07-12 at 16 40 07

@melvin-bot melvin-bot bot requested a review from dangrous July 12, 2024 09:41
@dukenv0307
Copy link
Contributor

LGTM

dangrous
dangrous previously approved these changes Jul 12, 2024
Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

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

Cool! One day I feel like we might need to fully refactor BaseTextInput, it's getting kinda complicated... but this works for now!

@dangrous
Copy link
Contributor

aw shoot we got some conflicts in the meantime. Sorry @tienifr can you handle those and then I can merge?

@tienifr
Copy link
Contributor Author

tienifr commented Jul 15, 2024

@dangrous All done.

Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

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

good to go!

@dangrous dangrous merged commit fc15af0 into Expensify:main Jul 15, 2024
15 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/dangrous 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