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 form submit behavior #34471

Merged
merged 28 commits into from
Feb 9, 2024
Merged

Conversation

shubham1206agra
Copy link
Contributor

@shubham1206agra shubham1206agra commented Jan 13, 2024

Details

Fixed Issues

$ #31433
PROPOSAL: #31433 (comment)

Tests

  1. Open App
  2. Tap profile icon
  3. Tap profile > Personal Details > Legal Name.
  4. Enter any text.
  5. Tap enter.
  6. Note the user is navigated to "personal details" page.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

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-01-22.at.12.54.46.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-01-22.at.2.27.37.PM.mov
iOS: Native
Screen.Recording.2024-01-22.at.3.10.52.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-01-22.at.2.30.55.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-01-22.at.2.11.34.PM.mov
MacOS: Desktop
Screen.Recording.2024-01-22.at.3.00.51.PM.mov

Copy link

melvin-bot bot commented Jan 13, 2024

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

@shubham1206agra
Copy link
Contributor Author

@cubuspl42 Should I modify the logic used here for native devices? #24636

@cubuspl42
Copy link
Contributor

@cubuspl42 Should I modify the logic used here for native devices? #24636

Speaking frankly, I already lost some of the context of this issue. I would love to be able to buy more mental RAM.

Would you quickly sum up our two basic options here? What will be the consequences (especially the ones observable with the naked eye) of modifying the mentioned submitOnEnter handling on Native and not modifying it?

@shubham1206agra
Copy link
Contributor Author

Would you quickly sum up our two basic options here? What will be the consequences (especially the ones observable with the naked eye) of modifying the mentioned submitOnEnter handling on Native and not modifying it?

I think when the implementation was done, they haven't evaluated the option of native platform. Right now, it does not submit on enter in mWeb devices only (not on native). I think we should modify it for not submit on native devices as it will allow us to press enter for multi-line field in native.

@cubuspl42
Copy link
Contributor

So, currently, we can't add a multi-line description on Native? Or did I get this wrong

@shubham1206agra
Copy link
Contributor Author

So, currently, we can't add a multi-line description on Native? Or did I get this wrong

No. Wait let me reach out on slack to clarify.

@cubuspl42
Copy link
Contributor

@shubham1206agra Please ping me when what we discussed on Slack is ready to review! I also assume that the PR should be ready to be un-drafted when it happens.

@shubham1206agra
Copy link
Contributor Author

Yes I will ping you

@shubham1206agra
Copy link
Contributor Author

Reproducible issue (also present on main) [NAB]
Submit does not work on 1st iteration, and on 2nd iteration, it goes 2 steps back after submit.

@cubuspl42
Copy link
Contributor

Reproducible issue (also present on main) [NAB] Submit does not work on 1st iteration, and on 2nd iteration, it goes 2 steps back after submit.

Do we have a tracking issue for this?

@shubham1206agra shubham1206agra marked this pull request as ready for review January 22, 2024 09:42
@shubham1206agra shubham1206agra requested a review from a team as a code owner January 22, 2024 09:42
@melvin-bot melvin-bot bot requested review from cubuspl42 and removed request for a team January 22, 2024 09:42
Copy link

melvin-bot bot commented Jan 22, 2024

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

@shubham1206agra
Copy link
Contributor Author

Reproducible issue (also present on main) [NAB] Submit does not work on 1st iteration, and on 2nd iteration, it goes 2 steps back after submit.

Do we have a tracking issue for this?

Nope

@shubham1206agra
Copy link
Contributor Author

I am not sure why performance test is failing.

@cubuspl42
Copy link
Contributor

I noticed that you mentioned we're holding on #34474

@cubuspl42
Copy link
Contributor

I am not sure why performance test is failing.

Typically it means they are failing on main and merging it helps after some time passes. If not, it might mean we broke something performance-wise.

@luacmartins
Copy link
Contributor

Bump @shubham1206agra. We also have conflicts now. Let's try to get this one to the finish line!

@shubham1206agra
Copy link
Contributor Author

I am not able to repro the issue.

When I test on Android/Web, I observe this result:

form-submit-issue-1-android-web-compressed.mp4
This seems to be specific to Android/Web and single-word locations.

@cubuspl42 I still am not able to repro this. Let me ask an adhoc build here.
cc @luacmartins

@cubuspl42
Copy link
Contributor

We could potentially ignore this issue, especially if it's not easily reproducible. It's quite a corner case.

@cubuspl42
Copy link
Contributor

Sorry, I was confused. This doesn't affect only single-word address lines.

It doesn't work when the suggestion list is visible.

It does work if I un-focus and re-focus the "Address line" field, so the suggestion list doesn't open. Then, I can submit the input with the "Go" button.

form-submit-issue-2-android-web-compressed.mp4

It may be related to the fact that I have the rest of the form filled out.

Anyway, I agree that we should wrap this PR up as soon as possible.

I want to ask you to remove the support for address search from this PR. This is not a typical text input; we can consider it out of scope. It's not worth the risk.

@luacmartins
Copy link
Contributor

@cubuspl42 it seems like we're had some commits since your last comment. Has your comment been addressed?

@cubuspl42
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 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 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
fix-form-submit-android-compressed.mp4
Android: mWeb Chrome
fix-form-submit-android-web-compressed.mp4
iOS: Native
fix-form-submit-ios-compressed.mp4
iOS: mWeb Safari
fix-form-submit-ios-web-compressed.mp4
MacOS: Chrome / Safari
fix-form-submit-web-converted.mp4
MacOS: Desktop
fix-form-submit-desktop-converted.mp4

@cubuspl42
Copy link
Contributor

I'm still having problems on Android/Web, this time also with plain text inputs. Maybe this is something on my side?...

@luacmartins Would you have a possibility to test this PR on Android/Web?

@luacmartins
Copy link
Contributor

luacmartins commented Feb 8, 2024

@cubuspl42 sorry, I'm only working 50% today and won't have time to do that today. It'd be great if you could figure this out today. Otherwise I can try testing tomorrow.

@cubuspl42
Copy link
Contributor

I'll try testing on an old physical Android smartphone I own. Let me charge it.

Copy link
Contributor

@cubuspl42 cubuspl42 left a comment

Choose a reason for hiding this comment

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

It's working on my physical Android device on Chrome 👍

@melvin-bot melvin-bot bot requested a review from MonilBhavsar February 9, 2024 10:30
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM!

@luacmartins luacmartins merged commit 8b8522a into Expensify:main Feb 9, 2024
16 of 17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Feb 9, 2024

✋ 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/luacmartins in version: 1.4.40-0 🚀

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

@hayata-suenaga
Copy link
Contributor

this issue might be related to this deploy blocker

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.40-5 🚀

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

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.

5 participants