disable pressOnEnter on FormAlertWithSubmitButton only for android native #46894

nyomanjyotisa · 2024-08-06T14:32:13Z

Details

disable pressOnEnter on FormAlertWithSubmitButton only for android native

Fixed Issues

$ #46644
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to any room.
Tap on the room header.
Tap on Room description.
Enter some text.
Tap Enter on the keyboard.
Verify enter key will enter the next line
Go back
Tap on Room name
Enter some text
Tap Enter on the keyboard
Verify enter key will submit the form

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Room description:

WhatsApp.Video.2024-08-12.at.8.22.01.PM.mp4

Room name:

WhatsApp.Video.2024-08-12.at.8.27.28.PM.mp4

Android: mWeb Chrome

disablePressOnEnter-on-form-that-has-input-with-shouldSubmitForm-false-by-nyomanjyotisa-.-Pull-Request-46894-.-Expensify-App.1.mp4

iOS: Native

N/A

iOS: mWeb Safari

RPReplay_Final1722955601.MP4

MacOS: Chrome / Safari

-1-New-Expensify.16.mp4

MacOS: Desktop

disablePressOnEnter-on-form-that-has-input-with-shouldSubmitForm-false-by-nyomanjyotisa-.-Pull-Request-46894-.-Expensify-App.mp4

…ubmitForm false

melvin-bot · 2024-08-06T14:56:06Z

@rayane-djouah 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]

rayane-djouah · 2024-08-06T17:08:26Z

@nyomanjyotisa is it possible to disable press on enter only when the multiline input is focused? I'm thinking of using a ref for FormProvider and manipulating it in InputWrapper. what do you think?
In this way, the form will still be submitted when the input with multiline is not focused.

rayane-djouah · 2024-08-08T07:15:57Z

@nyomanjyotisa - Friendly reminder 😄

nyomanjyotisa · 2024-08-08T14:04:53Z

@rayane-djouah i think we can do something like this. Set shouldDisablePressOnEnter to true on focus and set back to false on blur. What do you think?

rayane-djouah · 2024-08-08T17:06:28Z

@nyomanjyotisa - I think we can use some logic in FormWrapper like this:

    const shouldDisablePressOnEnter = useCallback(() => {
        if (disablePressOnEnter) {
            return true;
        }
        const hasFocusedAutoGrowHeightInput = Object.values(inputRefs.current ?? {}).some((inputRef) => inputRef.current?.isFocused && inputRef.current?.autoGrowHeight);
        return hasFocusedAutoGrowHeightInput;
    }, [disablePressOnEnter, inputRefs]);

rayane-djouah · 2024-08-09T22:21:29Z

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-08-13.at.1.31.03.AM.mov

Android: mWeb Chrome

Screen.Recording.2024-08-13.at.1.45.39.AM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-13.at.01.25.12.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-08-13.at.01.30.38.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-08-13.at.1.46.15.AM.mov

MacOS: Desktop

Screen.Recording.2024-08-13.at.1.47.29.AM.mov

rayane-djouah · 2024-08-11T18:40:40Z

@nyomanjyotisa I think the simplest and most reliable solution to fix the bug from root would be to set pressOnEnter for the Button component to be always false for android native.

App/src/components/Button/index.tsx

Lines 300 to 309 in 93dc1c9

    
           {pressOnEnter && ( 
        
               <KeyboardShortcutComponent 
        
                   isDisabled={isDisabled} 
        
                   isLoading={isLoading} 
        
                   allowBubble={allowBubble} 
        
                   onPress={onPress} 
        
                   pressOnEnter={pressOnEnter} 
        
                   enterKeyEventListenerPriority={enterKeyEventListenerPriority} 
        
               /> 
        
           )}

nyomanjyotisa · 2024-08-12T04:47:39Z

Kinda stuck with this, have tried the following

    const shouldDisablePressOnEnter = useCallback(() => {
        if (disablePressOnEnter) {
            return true;
        }
        const hasFocusedAutoGrowHeightInput = Object.values(inputRefs.current ?? {}).some((inputRef) => {
            return inputRef.current?.isFocused && !!inputRef.current?.autoGrowHeight
        });
        
        return hasFocusedAutoGrowHeightInput;
    }, [disablePressOnEnter, inputRefs]);

And set the ref values here

useImperativeHandle(
        ref,
        () => ({
            ...input.current,
            isFocused,
            autoGrowHeight,
        }),
        [autoGrowHeight, isFocused],
    );

but cant make the inputRefs on FormProvider re-rendered on input focus/blur since it created using registerInput

nyomanjyotisa · 2024-08-12T05:13:32Z

Do you mean like this?

    const operatingSystem = getOperatingSystem();
    
    const effectivePressOnEnter = operatingSystem === CONST.OS.ANDROID ? false : pressOnEnter;

    return (
        <>
            {effectivePressOnEnter && (
                <KeyboardShortcutComponent
                    isDisabled={isDisabled}
                    isLoading={isLoading}
                    allowBubble={allowBubble}
                    onPress={onPress}
                    pressOnEnter={effectivePressOnEnter}
                    enterKeyEventListenerPriority={enterKeyEventListenerPriority}
                />
            )}

Not really sure if we can do it this way, I think we still need press on enter on android on several places

rayane-djouah · 2024-08-12T09:09:24Z

@nyomanjyotisa - Yes, but using getPlatform to disable it only on the Android native platform. I also think it’s better to implement this in FormAlertWithSubmitButton rather than in Button.

The Enter key will still work correctly on Android native due to the shouldSubmitForm logic in InputWrapper. This ensures that the form will be submitted if a non-multiline input is submitted:

App/src/components/Form/InputWrapper.tsx

Lines 67 to 71 in 93dc1c9

    
                   /** 
        
                    * Should the containing form be submitted when this input is submitted itself? 
        
                    * Currently, meaningful only for text inputs. 
        
                    */ 
        
                   shouldSubmitForm?: boolean;

…tive

rayane-djouah · 2024-08-12T11:53:05Z

src/components/FormAlertWithSubmitButton.tsx

@@ -82,6 +84,9 @@ function FormAlertWithSubmitButton({
    const style = [!footerContent ? {} : styles.mb3, buttonStyles];
    const safePaddingBottomStyle = useSafePaddingBottomStyle();

+    const platform = getPlatform();
+    const pressOnEnter = platform === CONST.PLATFORM.ANDROID ? false : !disablePressOnEnter;


Could you please add a comment and a link to the issue to explain why we're doing this?
Also please update the PR title and description to align with the latest changes.

sure will do

comment added with link to issue, also updated the PR title and description

rayane-djouah · 2024-08-12T11:57:24Z

Also, please include in the test steps a check for form submission with single-line input submission on Android native, and retest it.

melvin-bot · 2024-08-12T12:35:23Z

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

nyomanjyotisa · 2024-08-12T12:46:07Z

@rayane-djouah test steps updated to test Room name edit as well (single-line input), and retested

nyomanjyotisa · 2024-08-12T12:50:35Z

Before fix on Samsung with Samsung keyboard(Form submitted on enter key press on multiline input):

WhatsApp.Video.2024-08-12.at.8.19.03.PM.mp4

After fix on Samsung with Samsung keyboard:

Enter new line on enter key press on multiline input:

WhatsApp.Video.2024-08-12.at.8.22.01.PM.mp4

Submit form on enter key press on single-line input:

WhatsApp.Video.2024-08-12.at.8.27.28.PM.mp4

rayane-djouah

LGTM and tests well

MonilBhavsar · 2024-08-13T05:31:54Z

src/components/FormAlertWithSubmitButton.tsx

@@ -82,6 +84,10 @@ function FormAlertWithSubmitButton({
    const style = [!footerContent ? {} : styles.mb3, buttonStyles];
    const safePaddingBottomStyle = useSafePaddingBottomStyle();

+    // Disable pressOnEnter only for Android Native due to bug here: https://github.com/Expensify/App/issues/46644


Can we explain the bug in comment please. i mean a specific reason to disable enter

@nyomanjyotisa ^

Updated the comment to add more details @MonilBhavsar

MonilBhavsar · 2024-08-15T15:28:56Z

Lint failure

nyomanjyotisa · 2024-08-16T01:02:42Z

lint fixed

MonilBhavsar

Thanks!

OSBotify · 2024-08-16T06:24:49Z

✋ 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 · 2024-08-19T16:14:27Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 9.0.22-0 🚀

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

OSBotify · 2024-08-19T17:11:07Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 9.0.22-1 🚀

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

OSBotify · 2024-08-20T22:44:05Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 9.0.22-9 🚀

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

disablePressOnEnter on form that has input with multiline and shouldS…

d0a95e7

…ubmitForm false

nyomanjyotisa marked this pull request as ready for review August 6, 2024 14:56

nyomanjyotisa requested a review from a team as a code owner August 6, 2024 14:56

melvin-bot bot requested review from rayane-djouah and removed request for a team August 6, 2024 14:56

nyomanjyotisa mentioned this pull request Aug 6, 2024

Android - Room - Enter key saves the room description instead of entering the next line #46644

Closed

6 tasks

disable pressOnEnter on FormAlertWithSubmitButton only for android na…

c78afbd

…tive

rayane-djouah reviewed Aug 12, 2024

View reviewed changes

add comment

ced67db

nyomanjyotisa changed the title ~~disablePressOnEnter on form that has input with shouldSubmitForm false~~ disable pressOnEnter on FormAlertWithSubmitButton only for android native Aug 12, 2024

rayane-djouah approved these changes Aug 13, 2024

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar August 13, 2024 00:53

MonilBhavsar reviewed Aug 13, 2024

View reviewed changes

update comment

0bd4f0b

rayane-djouah approved these changes Aug 15, 2024

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar August 15, 2024 12:24

lint

207414f

MonilBhavsar approved these changes Aug 16, 2024

View reviewed changes

MonilBhavsar merged commit dfec509 into Expensify:main Aug 16, 2024
15 checks passed

github-actions bot mentioned this pull request Aug 19, 2024

Deploy Checklist: New Expensify 2024-08-19 #47639

Closed

77 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

disable pressOnEnter on FormAlertWithSubmitButton only for android native #46894

disable pressOnEnter on FormAlertWithSubmitButton only for android native #46894

nyomanjyotisa commented Aug 6, 2024 •

edited

Loading

melvin-bot bot commented Aug 6, 2024

rayane-djouah commented Aug 6, 2024 •

edited

Loading

rayane-djouah commented Aug 8, 2024

nyomanjyotisa commented Aug 8, 2024

rayane-djouah commented Aug 8, 2024

rayane-djouah commented Aug 9, 2024 •

edited

Loading

rayane-djouah commented Aug 11, 2024

nyomanjyotisa commented Aug 12, 2024

nyomanjyotisa commented Aug 12, 2024

rayane-djouah commented Aug 12, 2024

rayane-djouah Aug 12, 2024

nyomanjyotisa Aug 12, 2024

nyomanjyotisa Aug 12, 2024

rayane-djouah commented Aug 12, 2024

melvin-bot bot commented Aug 12, 2024

nyomanjyotisa commented Aug 12, 2024

nyomanjyotisa commented Aug 12, 2024

rayane-djouah left a comment

MonilBhavsar Aug 13, 2024

MonilBhavsar Aug 14, 2024

nyomanjyotisa Aug 15, 2024

MonilBhavsar commented Aug 15, 2024

nyomanjyotisa commented Aug 16, 2024

MonilBhavsar left a comment

OSBotify commented Aug 16, 2024

OSBotify commented Aug 19, 2024

OSBotify commented Aug 19, 2024

OSBotify commented Aug 20, 2024

disable pressOnEnter on FormAlertWithSubmitButton only for android native #46894

disable pressOnEnter on FormAlertWithSubmitButton only for android native #46894

Conversation

nyomanjyotisa commented Aug 6, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 6, 2024

rayane-djouah commented Aug 6, 2024 • edited Loading

rayane-djouah commented Aug 8, 2024

nyomanjyotisa commented Aug 8, 2024

rayane-djouah commented Aug 8, 2024

rayane-djouah commented Aug 9, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

rayane-djouah commented Aug 11, 2024

nyomanjyotisa commented Aug 12, 2024

nyomanjyotisa commented Aug 12, 2024

rayane-djouah commented Aug 12, 2024

rayane-djouah Aug 12, 2024

Choose a reason for hiding this comment

nyomanjyotisa Aug 12, 2024

Choose a reason for hiding this comment

nyomanjyotisa Aug 12, 2024

Choose a reason for hiding this comment

rayane-djouah commented Aug 12, 2024

melvin-bot bot commented Aug 12, 2024

nyomanjyotisa commented Aug 12, 2024

nyomanjyotisa commented Aug 12, 2024

rayane-djouah left a comment

Choose a reason for hiding this comment

MonilBhavsar Aug 13, 2024

Choose a reason for hiding this comment

MonilBhavsar Aug 14, 2024

Choose a reason for hiding this comment

nyomanjyotisa Aug 15, 2024

Choose a reason for hiding this comment

MonilBhavsar commented Aug 15, 2024

nyomanjyotisa commented Aug 16, 2024

MonilBhavsar left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 16, 2024

OSBotify commented Aug 19, 2024

OSBotify commented Aug 19, 2024

OSBotify commented Aug 20, 2024

nyomanjyotisa commented Aug 6, 2024 •

edited

Loading

rayane-djouah commented Aug 6, 2024 •

edited

Loading

rayane-djouah commented Aug 9, 2024 •

edited

Loading