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 IOU amount input flicking on native platforms #54189

Merged
merged 4 commits into from
Dec 26, 2024

Conversation

QichenZhu
Copy link
Contributor

@QichenZhu QichenZhu commented Dec 16, 2024

Explanation of Change

Fixed Issues

$ #53286
PROPOSAL: #53286 (comment)

Tests

  1. Launch the app.
  2. Tap FAB > Create expense > Manual.
  3. Enter the number 3.
  4. Enter a decimal point. Verify that 3 is fully visible during the process.
  5. Delete the number and input a large number (at least 8 digits).
  6. Tap Next, then select a recipient.
  7. On the confirmation page, tap the amount to edit it. Verify that the number pad and Next button are center-aligned.
  8. Switch to a different currency. Verify that the number pad and Next button are still center-aligned.
  • Verify that no errors appear in the JS console

Offline tests

  1. Launch the app.
  2. Tap FAB > Create expense > Manual.
  3. Enter the number 3.
  4. Enter a decimal point. Verify that 3 is fully visible during the process.
  5. Delete the number and input a large number (at least 8 digits).
  6. Tap Next, then select a recipient.
  7. On the confirmation page, tap the amount to edit it. Verify that the number pad and Next button are center-aligned.
  8. Switch to a different currency. Verify that the number pad and Next button are still center-aligned.

QA Steps

  1. Launch the app.
  2. Tap FAB > Create expense > Manual.
  3. Enter the number 3.
  4. Enter a decimal point. Verify that 3 is fully visible during the process.
  5. Delete the number and input a large number (at least 8 digits).
  6. Tap Next, then select a recipient.
  7. On the confirmation page, tap the amount to edit it. Verify that the number pad and Next button are center-aligned.
  8. Switch to a different currency. Verify that the number pad and Next button are still center-aligned.
  • 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)
    Error: Uncaught (in promise) TypeError: Failed to execute add' on Cache': Request scheme 'app' is unsupported
  • 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.
    Unit tests are not added as this fixes a styling issue.
  • 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
android-native.mp4
Android: mWeb Chrome
android-web.mp4
iOS: Native
ios-native.mp4
iOS: mWeb Safari
ios-web.mp4
MacOS: Chrome / Safari
mac-web.mp4
MacOS: Desktop
mac-desktop.mov

Copy link

melvin-bot bot commented Dec 16, 2024

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

@QichenZhu
Copy link
Contributor Author

Found this console error on the desktop app.

Screenshot 2024-12-17 at 12 23 27 AM

It's also found in 9.0.75-6.

@QichenZhu QichenZhu marked this pull request as ready for review December 18, 2024 00:24
@QichenZhu QichenZhu requested review from a team as code owners December 18, 2024 00:24
@melvin-bot melvin-bot bot requested review from brunovjk and removed request for a team December 18, 2024 00:24
Copy link

melvin-bot bot commented Dec 18, 2024

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

@QichenZhu
Copy link
Contributor Author

@Expensify/design Could you please review this? Thanks!

@dubielzyk-expensify
Copy link
Contributor

Looks better to me from a visual perspective 👍

@QichenZhu
Copy link
Contributor Author

@brunovjk The following two lines happen to be in the same files as the changes in this PR and make the linter unhappy. If I'm responsible to do the migration, I can open a separate PR, as it's better not to include unrelated things here. What do you think?

policyID={policyID ?? '-1'}

const transactionID = transaction?.parentTransactionID || transaction?.transactionID || '';

@brunovjk
Copy link
Contributor

@QichenZhu I believe we can try to migrate them here. The change in MoneyRequestAmountForm.tsx seems straightforward, following the guide. As for the change in styles/utils/index.ts Im not sure. Can we solve it in this PR? If you think it would be better to do it in another PR, that's fine, just tell and we'll pass it on to an internal member, and we'll go from there. What do you think?

@QichenZhu
Copy link
Contributor Author

@brunovjk Thanks for the suggestion! I’d be happy to handle it here if it’s straightforward.

Do these changes make sense to you?

policyID={policyID ?? '-1'}

policyID={policyID}

const transactionID = transaction?.parentTransactionID || transaction?.transactionID || '';

const transactionID = transaction?.parentTransactionID || transaction?.transactionID;

if (!transactionID) {
    return CONST.ERECEIPT_COLORS.YELLOW;
}

I’m just wondering if it’s sufficient because, even though we remove nullish coalescing from policyId passed to SettlementButton, the prop defined in SettlementButton itself still has a default value.

If we migrate SettlementButton as well, more files might be affected, and we’d need to migrate even more files.

@brunovjk
Copy link
Contributor

Great! Thanks @QichenZhu.
@VickyStash could you take a look at this comment? I'm all for update the MoneyRequestAmountForm.tsx file, but not so much in changing App/src/styles/utils/index.ts here. What do you think?

@VickyStash
Copy link
Contributor

@VickyStash could you take a look at this #54189 (comment)? I'm all for update the MoneyRequestAmountForm.tsx file, but not so much in changing App/src/styles/utils/index.ts here. What do you think?

What are your concerns regarding App/src/styles/utils/index.ts changes?

As for SettlementButton - don't touch it in this PR I think. This file wasn't changed here, right?

@brunovjk
Copy link
Contributor

What are your concerns regarding App/src/styles/utils/index.ts changes?

My main concern here is that this change might introduce unexpected behavior since it modifies a utility function used in multiple places. But, let's try, I will make sure to test it well! @QichenZhu can you can make these updates in MoneyRequestAmountForm.tsx and App/src/styles/utils/index.ts , about SettlementButton I believe there would be no problem in leaving it as it is, later we should update it anyway. What do you think?

@brunovjk
Copy link
Contributor

brunovjk commented Dec 19, 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 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
54189_android_native.mov
Android: mWeb Chrome
54189_android_web.mov
iOS: Native
54189_ios_native.mov
iOS: mWeb Safari
54189_ios_web.mov
MacOS: Chrome / Safari
54189_web_chrome.mov
MacOS: Desktop
54189_web_desktop.mov

@melvin-bot melvin-bot bot requested a review from neil-marcellini December 19, 2024 13:45
@brunovjk
Copy link
Contributor

@QichenZhu would you mind resolving the conflicts? Thanks.

QichenZhu

This comment was marked as resolved.

@QichenZhu
Copy link
Contributor Author

Conflicts resolved.

@brunovjk
Copy link
Contributor

Great, thank you. Retesting.

@brunovjk
Copy link
Contributor

Screenshots/Videos

Android: Native
54189_android_native.mov
Android: mWeb Chrome
54189_android_web.mov
iOS: Native
54189_ios_native.mov
iOS: mWeb Safari
54189_ios_web.mov
MacOS: Chrome / Safari
54189_web_chrome.mov
MacOS: Desktop
54189_web_desktop.mov

@neil-marcellini neil-marcellini merged commit 2389457 into Expensify:main Dec 26, 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/neil-marcellini in version: 9.0.79-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 success ✅
🍎🔄 iOS HybridApp 🍎🔄 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