fix: add a timeout on PressableWithFeedback for disable removal #18865

allroundexperts · 2023-05-12T20:14:27Z

Details

This PR adds a delay of 1000ms in GenericPressable before the disabled cursor style kicks in. This is needed in order to fix the quick cursor style change that often occurs when the PressableWithFeedback button is clicked quickly.

Fixed Issues

$ #18862
PROPOSAL: #18862 (comment)

Tests

Login into the app and go to any page that contains a PressableWithFeedback button (eg The submit button at the first step of the manual connect bank account page)
Click the submit button multiple times quickly without filling the inputs.
Verify that the cursor style does not change to disabled and make sure that it does not flicker.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Login into the app and go to any page that contains a PressableWithFeedback button (eg The submit button at the first step of the manual connect bank account page)
Click the submit button multiple times quickly without filling the inputs.
Verify that the cursor style does not change to disabled and make sure that it does not flicker.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-05-13.at.3.03.19.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-05-13.at.12.58.45.AM.mov

Mobile Web - Safari

Screen.Recording.2023-05-13.at.12.55.18.AM.mov

Desktop

Screen.Recording.2023-05-13.at.3.09.15.AM.mov

iOS

Screen.Recording.2023-05-13.at.1.13.42.AM.mov

Android

Screen.Recording.2023-05-13.at.1.00.22.AM.mov

melvin-bot · 2023-05-12T20:14:32Z

@roryabraham @s77rt One of you needs to 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]

roryabraham

So the problem with this implementation is that it doesn't actually disable the Pressable until after 1000ms, which is not what we want. We just want to prevent the disabled cursor style from showing until the Pressable has been disabled for 1000ms.

Also, it currently is only delaying the Pressable from being re-enabled, which we agreed we didn't want to do at all.

Something like this is more like what I had in mind (in BaseGenericPressable):

const isDisabled = useMemo(() => {
    let shouldBeDisabledByScreenReader = false;
    if (enableInScreenReaderStates === CONST.SCREEN_READER_STATES.ACTIVE) {
        shouldBeDisabledByScreenReader = !isScreenReaderActive;
    }
    
    if (enableInScreenReaderStates === CONST.SCREEN_READER_STATES.DISABLED) {
        shouldBeDisabledByScreenReader = isScreenReaderActive;
    }
    
    return props.disabled || shouldBeDisabledByScreenReader;
}, [isScreenReaderActive, enableInScreenReaderStates, props.disabled]);
  
const [shouldUseDisabledCursor, setShouldUseDisabledCursor] = useState(isDisabled);
useEffect(() => {
    if (!isDisabled) {
        setShouldUseDisabledCursor(isDisabled);
    } else {
        setTimeout(() => setShouldUseDisabledCursor(isDisabled), 1000);
    }
}, [isDisabled]);


...
...

getCursorStyle(shouldUseDisabledCursor, [props.accessibilityRole, props.role].includes('text')),

allroundexperts · 2023-05-12T22:10:10Z

@roryabraham Handled your comments.

s77rt

I don't think this solution is working. We basically disabled the "disabled cursor". This is because the useEffect will run after the click event is already handled.

allroundexperts · 2023-05-13T12:51:37Z

I don't think this solution is working. We basically disabled the "disabled cursor". This is because the useEffect will run after the click event is already handled.

@s77rt I think this is what is intended. As far as I've understood, we need to show the disabled cursor AFTER 1s timeout. We don't need to add a timeout to the disabled state itself.

s77rt · 2023-05-13T13:04:41Z

@allroundexperts What I meant is that the cursor won't show even if the button remains disabled for more than 1s. The timer won't even start.

allroundexperts · 2023-05-13T13:07:58Z

@allroundexperts What I meant is that the cursor won't show even if the button remains disabled for more than 1s. The timer won't even start.

That's weird. Checkout the second video I attached for Web. It seems to be getting triggered fine. I made the onPress handler a Promise that resolved after 2s for testing.

s77rt · 2023-05-13T13:14:47Z

It will only work if the onPress callback is async. As in this case the useEffect setup will fire before the onPress async work is done.

If the callback is sync. We will first do the sync work (keep cursor in normal state - even if the work is taking more than 1sec) and then call the useEffect setup which would be pointless at this stage.

allroundexperts · 2023-05-13T13:16:51Z

s in this case the useEffect setup will fire before the onPress async work is done.

If the callback is sync. We will first do the sync work (keep cursor in normal state - even if the work is taking more than 1sec) and then call the useEffect setup which would be pointless at this sta

Nice finding. I'll try to come up with a solution that works for sync code as well. As a side note, do we have any sync action that usually takes more than a second 🤔?

s77rt · 2023-05-13T13:25:21Z

I'm not totally sure. Seems like an edge case so maybe we can have the disabled cursor just for the async work.

allroundexperts · 2023-05-13T13:28:04Z

I'm not totally sure. Seems like an edge case so maybe we can have the disabled cursor just for the async work.

@roryabraham Can you confirm if that is a reasonable assumption?

allroundexperts · 2023-05-13T13:51:28Z

@s77rt I think this is a reasonable assumption. If a sync function is taking more than a second, then during that time, the whole UI would be blocked anyways because of the single threaded nature of JS. I've attached a video of what happens when a sync function is used for onPress handler (a for loop that goes to 200000).

Screen.Recording.2023-05-13.at.6.50.50.PM.mov

s77rt · 2023-05-13T14:04:00Z

Yeah I think you are right.

s77rt · 2023-05-13T15:13:34Z

src/components/Pressable/PressableWithFeedback.js

+                        .then(() => {
+                            setDisabled(props.disabled);
+                        })
+                        .catch(() => setDisabled(props.disabled));


Why this is required?

During my testing, I found that the button would be stuck in a disabled state if the promise failed. This resets the button so that the user can continue.

Can you pinpoint to any real case that I can reproduce?
Also if that's the case we should just use finally instead of then & catch.

It really depends on the onPress function being supplied. And yea, finally looks good.

s77rt · 2023-05-13T15:16:35Z

src/components/Pressable/GenericPressable/BaseGenericPressable.js

+    useEffect(() => {
+        let timer = null;
+        if (!isDisabled) {
+            setShouldUseDisabledCursor(false);
+        } else {
+            timer = setTimeout(() => setShouldUseDisabledCursor(true), 1000);
        }
-        onPressHandler(event);
-    }, [onPressHandler]);
+
+        return () => {
+            if (!timer) return;
+            clearTimeout(timer);
+        };
+    }, [isDisabled]);


Make the cleanup function only if isDisabled is true.

useEffect(() => { if (isDisabled) { const timer = setTimeout(() => setShouldUseDisabledCursor(true), 1000); return () => clearTimeout(timer); } setShouldUseDisabledCursor(false); }, [isDisabled]);

s77rt · 2023-05-13T16:29:06Z

src/components/Pressable/PressableWithFeedback.js

+                        .then(() => {
+                            setDisabled(props.disabled);
+                        })
+                        .catch(() => setDisabled(props.disabled));


Can you pinpoint to any real case that I can reproduce?
Also if that's the case we should just use finally instead of then & catch.

s77rt · 2023-05-13T16:29:58Z

BTW; the diff looks to be a lot. Is this caused by prettier? Can you fix that?

allroundexperts · 2023-05-13T18:36:11Z

BTW; the diff looks to be a lot. Is this caused by prettier? Can you fix that?

Merged with latest and fixed.

s77rt

Code looks good. But the PR details / tests are not correct. Please update.

allroundexperts · 2023-05-14T18:45:37Z

@s77rt I've updated the steps. However, I'm unsure how to test the actual cursor getting disabled after 1s since none of the actions in our app takes this long. Do you have any idea of how we should deal with this?

s77rt · 2023-05-14T19:11:04Z

@allroundexperts Just test against this case #17103 (comment)

allroundexperts · 2023-05-14T19:12:41Z

@allroundexperts Just test against this case #17103 (comment)

@s77rt I've mentioned a similar case in the tests section of my proposal.

s77rt · 2023-05-14T21:14:12Z

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 / Chrome
- iOS / native
- iOS / 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(themeColors.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 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

Web

web.mp4

Mobile Web - Chrome

mweb-chrome.mp4

Mobile Web - Safari

mweb-safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

s77rt · 2023-05-14T21:14:38Z

@allroundexperts Almost ready 😁 Can you please remove the old videos as they may be confusing since the disabled cursor is visible on those.

allroundexperts · 2023-05-14T21:16:36Z

@allroundexperts Almost ready 😁 Can you please remove the old videos as they may be confusing since the disabled cursor is visible on those.

@s77rt If you are talking about the videos in web or desktop, those are all new videos. The disabled cursor shows up after 1s because I was running a promise that resolved after 2s.

s77rt · 2023-05-14T21:20:51Z

@allroundexperts Yeah but the 2s promise is not on staging so it's hard for the QA team to test this and it may be confusing.

allroundexperts · 2023-05-14T21:22:18Z

@allroundexperts Yeah but the 2s promise is not on staging so it's hard for the QA team to test this and it may be confusing.

Makes sense. Removing that one.

allroundexperts · 2023-05-14T21:24:17Z

@s77rt Removed on web and desktop.

s77rt · 2023-05-14T21:26:45Z

@allroundexperts Thank you!

s77rt

LGTM! 🚀

cc @roryabraham

allroundexperts · 2023-05-16T21:24:58Z

@roryabraham This is waiting for your review.

OSBotify · 2023-05-17T01:07:30Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.15-0 🚀

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

isagoico · 2023-05-17T20:07:03Z

@roryabraham @s77rt This issue is failing step 3 on Web and Desktop - #19137

roryabraham · 2023-05-17T20:23:37Z

I went ahead and closed that other issue. I think that it was maybe just poorly described testing steps.

isagoico · 2023-05-17T20:24:04Z

Great! Then we can check this one off from the checklist. Thanks!

OSBotify · 2023-05-18T06:50:41Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.15-12 🚀

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

allroundexperts requested a review from a team as a code owner May 12, 2023 20:14

melvin-bot bot requested review from roryabraham and s77rt and removed request for a team May 12, 2023 20:14

allroundexperts mentioned this pull request May 12, 2023

[HOLD for payment 2023-05-25] [$1000] Disabled cursor briefly shows #18862

Closed

6 tasks

roryabraham requested changes May 12, 2023

View reviewed changes

fix: add a timeout on BaseGenericPressable for disabled cursor style

1cf0c12

allroundexperts force-pushed the fix-18862 branch from c457c82 to 1cf0c12 Compare May 12, 2023 22:02

allroundexperts requested a review from roryabraham May 12, 2023 22:03

s77rt suggested changes May 13, 2023

View reviewed changes

fix: update the cleanup function for disabling cursor

5846a52

allroundexperts requested a review from s77rt May 13, 2023 15:22

s77rt suggested changes May 13, 2023

View reviewed changes

Merge branch 'main' into fix-18862

2e04988

allroundexperts requested a review from s77rt May 13, 2023 18:35

fix: lint differences

72adc46

allroundexperts requested a review from s77rt May 13, 2023 21:55

s77rt reviewed May 13, 2023

View reviewed changes

hungvu193 mentioned this pull request May 14, 2023

[HOLD for payment 2023-06-01] [HOLD PR #18865][$1000] iOS / Safari - On long pressing "terms of service" link it gets completely hidden #17103

Closed

6 tasks

allroundexperts added 2 commits May 14, 2023 23:36

Merge branch 'main' into fix-18862

3d15814

fix: reset onpressHandler diff

527046e

allroundexperts requested a review from s77rt May 14, 2023 18:44

s77rt approved these changes May 14, 2023

View reviewed changes

roryabraham approved these changes May 16, 2023

View reviewed changes

roryabraham merged commit f365b88 into Expensify:main May 16, 2023

OSBotify mentioned this pull request May 16, 2023

Deploy Checklist: New Expensify 2023-05-16 #19088

Closed

71 tasks

bernhardoj mentioned this pull request May 17, 2023

Fix currency selection is saved even though we don't press Save yet #18995

Merged

57 tasks

hoangzinh mentioned this pull request May 17, 2023

[NoQA] Chore/Fix linter related to PressableWithFeedback component #19109

Merged

57 tasks

isagoico mentioned this pull request May 17, 2023

Buttons with 'PressableWithFeedback' - cursor changes to disabled on 4th click #19137

Closed

6 tasks

tienifr mentioned this pull request Jul 12, 2023

[HOLD for payment 2023-08-08] [$1000] Web - Assign Task - Delay in transitioning from a hand cursor to a "not allowed" sign. #22058

Closed

6 tasks

fix: add a timeout on PressableWithFeedback for disable removal #18865

fix: add a timeout on PressableWithFeedback for disable removal #18865

Conversation

allroundexperts commented May 12, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 12, 2023

roryabraham left a comment

Choose a reason for hiding this comment

allroundexperts commented May 12, 2023

s77rt left a comment

Choose a reason for hiding this comment

allroundexperts commented May 13, 2023 • edited Loading

s77rt commented May 13, 2023

allroundexperts commented May 13, 2023 • edited Loading

s77rt commented May 13, 2023

allroundexperts commented May 13, 2023

s77rt commented May 13, 2023

allroundexperts commented May 13, 2023

allroundexperts commented May 13, 2023

s77rt commented May 13, 2023

s77rt May 13, 2023

Choose a reason for hiding this comment

allroundexperts May 13, 2023

Choose a reason for hiding this comment

s77rt May 13, 2023

Choose a reason for hiding this comment

allroundexperts May 13, 2023

Choose a reason for hiding this comment

s77rt May 13, 2023

Choose a reason for hiding this comment

allroundexperts May 13, 2023

Choose a reason for hiding this comment

s77rt May 13, 2023

Choose a reason for hiding this comment

s77rt commented May 13, 2023

allroundexperts commented May 13, 2023

s77rt left a comment

Choose a reason for hiding this comment

allroundexperts commented May 14, 2023

s77rt commented May 14, 2023

allroundexperts commented May 14, 2023

s77rt commented May 14, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

s77rt commented May 14, 2023

allroundexperts commented May 14, 2023

s77rt commented May 14, 2023

allroundexperts commented May 14, 2023

allroundexperts commented May 14, 2023

s77rt commented May 14, 2023

s77rt left a comment

Choose a reason for hiding this comment

allroundexperts commented May 16, 2023

OSBotify commented May 17, 2023

isagoico commented May 17, 2023

roryabraham commented May 17, 2023

isagoico commented May 17, 2023

OSBotify commented May 18, 2023

allroundexperts commented May 12, 2023 •

edited

Loading

allroundexperts commented May 13, 2023 •

edited

Loading

allroundexperts commented May 13, 2023 •

edited

Loading

s77rt commented May 14, 2023 •

edited

Loading