bug: refresher, quickly scrolling after cancelling refresh causes duplicate refresh

[milanharia]

Prerequisites

• I have read the Contributing Guidelines.
• I agree to follow the Code of Conduct.
• I have searched for existing issues that already report this problem, without success.

Ionic Framework Version

• v4.x
• v5.x
• v6.x
• Nightly

Current Behavior

When using an Ion Refresher on android, if you pull the refresher down partially (so it does not trigger the onIonRefresh event) and then scroll down quickly, the refresher animation triggers (but does not fire the refresh event) which causes the scroll to jank.

Expected Behavior

Scrolling down rapidly should not cause the refresher to appear.

Steps to Reproduce

Take any ionic app page which has enough content so the page can scroll and add an IonRefresher. Swipe down on the page slightly so the refresher icon begins to enter the page (but do not trigger it). Swipe up rapidly to scroll the page down quickly and the refresher icon will enter the page and cause the scrolling to jank.

Video Example

22-06-07-11-03-01_01.mp4

An example of the code:

function doRefresh(event: CustomEvent<RefresherEventDetail>) {
  console.log("Begin async operation");

  setTimeout(() => {
    console.log('Async operation has ended');
    event.detail.complete();
  }, 2000);
}

const Tab1: React.FC = () => {
  return (
    <IonPage>
      <IonHeader>
        <IonToolbar>
          <IonTitle>Tab 1</IonTitle>
        </IonToolbar>
      </IonHeader>
      <IonContent fullscreen>
        <IonHeader collapse="condense">
          <IonToolbar>
            <IonTitle size="large">Tab 1</IonTitle>
          </IonToolbar>
        </IonHeader>
        <IonRefresher slot="fixed" onIonRefresh={doRefresh}>
          <IonRefresherContent />
        </IonRefresher>
           {*/ ...Page Content */}
      </IonContent>
    </IonPage>
  );
};

Code Reproduction URL

https://github.com/milanharia/ionic-android-refresher

Ionic Info

Ionic:

Ionic CLI : 6.19.1 (/usr/local/lib/node_modules/@ionic/cli)
Ionic Framework : @ionic/react 6.1.8

Capacitor:

Capacitor CLI : 3.5.1
@capacitor/android : 3.5.1
@capacitor/core : 3.5.1
@capacitor/ios : not installed

Utility:

cordova-res : not installed globally
native-run : 1.6.0

System:

NodeJS : v16.14.2 (/usr/local/bin/node)
npm : 8.7.0
OS : macOS Monterey

Additional Information

No response

[ionitron-bot]

Thanks for the issue! This issue has been labeled as needs reproduction. This label is added to issues that need a code reproduction.

Please reproduce this issue in an Ionic starter application and provide a way for us to access it (GitHub repo, StackBlitz, etc). Without a reliable code reproduction, it is unlikely we will be able to resolve the issue, leading to it being closed.

If you have already provided a code snippet and are seeing this message, it is likely that the code snippet was not enough for our team to reproduce the issue.

For a guide on how to create a good reproduction, see our Contributing Guide.

[milanharia]

I have created a repo which has this issue within it here. Make sure after pulling the refresher down slightly you scroll down quickly for the bug to occur.

22-06-09-11-56-40.mp4

[liamdebeasi]

Thanks, I can reproduce this. The refresher has a guard built in to protect from the gesture activating when dragging up: https://github.com/ionic-team/ionic-framework/blob/main/core/src/components/refresher/refresher.tsx#L343

However, it requires that the overall progress of the gesture be 0 (I.e. not started). This is done to still allow for users to cancel the gesture by dragging up mid-gesture.

When you do not pull enough for the gesture to complete, the browser executes this section of the code: https://github.com/ionic-team/ionic-framework/blob/main/core/src/components/refresher/refresher.tsx#L379-L383

While we do wait for the animation to finish, we never reset the overall progress of the animation. As a result, the guard mentioned above never kicks in and another gesture begins. Setting this.progress = 0; in the onStart callback fixes the issue.

[liamdebeasi]

Can you try the following dev build and let me know if it resolves the issue?

npm install @ionic/react@6.1.10-dev.11655302783.1c4fffdb @ionic/react-router@6.1.10-dev.11655302783.1c4fffdb

[milanharia]

I can confirm it is fixed in the dev build!

[liamdebeasi]

Thanks for the issue. This has been resolved via #25476, and a fix will be available in an upcoming release of Ionic Framework.

[ionitron-bot]

Thanks for the issue! This issue is being locked to prevent comments that are not relevant to the original issue. If this is still an issue with the latest version of Ionic, please create a new issue and ensure the template is fully filled out.