diff --git a/packages/taro-h5/__tests__/ui/scroll.test.ts b/packages/taro-h5/__tests__/ui/scroll.test.ts index ba8f434bcf99..df4f60773b6a 100644 --- a/packages/taro-h5/__tests__/ui/scroll.test.ts +++ b/packages/taro-h5/__tests__/ui/scroll.test.ts @@ -62,6 +62,82 @@ describe.each([false, true])('pageScrollTo target (window scroll: %s)', usingWin expect(positions.every(value => value >= 0 && value <= 400)).toBe(true) }) + test.each([0, 34])('settles a scroll superseded by a %sms scroll', async duration => { + const success = jest.fn() + const fail = jest.fn() + const complete = jest.fn() + const settled = jest.fn() + const first = pageScrollTo({ scrollTop: 200, success, fail, complete }).then(settled) + jest.advanceTimersByTime(17) + const second = pageScrollTo({ scrollTop: 300, duration }) + + jest.runAllTimers() + await expect(second).resolves.toEqual({ errMsg: 'pageScrollTo:ok' }) + const failure = { errMsg: 'pageScrollTo:fail interrupted by another scroll' } + expect(settled).toHaveBeenCalledTimes(1) + expect(settled).toHaveBeenCalledWith(failure) + expect(success).not.toHaveBeenCalled() + expect(fail).toHaveBeenCalledTimes(1) + expect(fail).toHaveBeenCalledWith(failure) + expect(complete).toHaveBeenCalledTimes(1) + expect(complete).toHaveBeenCalledWith(failure) + expect(position).toBe(300) + expect(jest.getTimerCount()).toBe(0) + await first + }) + + test('rejects a superseded scroll without failure callbacks', async () => { + const rejected = jest.fn() + const first = pageScrollTo({ scrollTop: 200 }).catch(rejected) + const second = pageScrollTo({ scrollTop: 300 }) + + jest.runAllTimers() + await second + expect(rejected).toHaveBeenCalledWith({ errMsg: 'pageScrollTo:fail interrupted by another scroll' }) + await first + }) + + test('honors a newer scroll started from a cancellation callback', async () => { + let latest: ReturnType | undefined + const onInterrupted = () => { + latest = pageScrollTo({ scrollTop: 400, duration: 0 }) + } + const first = pageScrollTo({ scrollTop: 200, fail: onInterrupted }) + const rejected = jest.fn() + const second = pageScrollTo({ scrollTop: 300 }).catch(rejected) + + jest.runAllTimers() + await Promise.resolve() + expect(latest).toBeDefined() + await latest + expect(rejected).toHaveBeenCalledWith({ errMsg: 'pageScrollTo:fail interrupted by another scroll' }) + expect(position).toBe(400) + await first + await second + }) + + if (!usingWindowScroll) { + test('keeps animations on independent page containers running', async () => { + page.id = 'pages/first' + Current.page = { path: page.id } + const nextPage = document.createElement('div') + nextPage.className = 'taro_page' + nextPage.id = 'pages/second' + document.body.appendChild(nextPage) + const firstComplete = jest.fn() + const first = pageScrollTo({ scrollTop: 200, complete: firstComplete }) + Current.page = { path: nextPage.id } + const second = pageScrollTo({ scrollTop: 300 }) + + jest.runAllTimers() + await second + expect(firstComplete).toHaveBeenCalledWith({ errMsg: 'pageScrollTo:ok' }) + expect(position).toBe(200) + expect(nextPage.scrollTop).toBe(300) + await first + }) + } + test('preserves the position when already at the target', async () => { position = 200 const result = pageScrollTo({ scrollTop: 200 }) diff --git a/packages/taro-h5/src/api/ui/scroll/index.ts b/packages/taro-h5/src/api/ui/scroll/index.ts index 9eb69839fae8..8ce84a9bfe8f 100644 --- a/packages/taro-h5/src/api/ui/scroll/index.ts +++ b/packages/taro-h5/src/api/ui/scroll/index.ts @@ -4,7 +4,7 @@ import { Current } from '@tarojs/runtime' import { easeInOut, getTimingFunc } from '../../../utils' import { MethodHandler } from '../../../utils/handler' -let timer: ReturnType +const activeScrolls: WeakMap void> = new WeakMap() const FRAME_DURATION = 17 /** @@ -14,11 +14,17 @@ export const pageScrollTo: typeof Taro.pageScrollTo = ({ scrollTop, selector = ' let scrollFunc const handle = new MethodHandler({ name: 'pageScrollTo', success, fail, complete }) return new Promise((resolve, reject) => { + const failScroll = (errMsg: string) => { + try { + handle.fail({ errMsg }, { resolve, reject }) + } catch (error) { + reject(error) + } + } + try { if (scrollTop === undefined && !selector) { - return handle.fail({ - errMsg: 'scrollTop" 或 "selector" 需要其之一' - }, { resolve, reject }) + return failScroll('scrollTop" 或 "selector" 需要其之一') } const usingWindowScroll = (window as any).__taroAppConfig?.usingWindowScroll @@ -64,23 +70,41 @@ export const pageScrollTo: typeof Taro.pageScrollTo = ({ scrollTop, selector = ' const frameCnt = Math.ceil(duration / FRAME_DURATION) const easeFunc = getTimingFunc(easeInOut, frameCnt + 1) + const scrollTarget = usingWindowScroll ? window : el + let timer: ReturnType | undefined + const interrupt = () => { + clearTimeout(timer) + failScroll('interrupted by another scroll') + } + const scroll = (frame = 0) => { - if (frame >= frameCnt) { - scrollFunc(to) - return handle.success({}, { resolve, reject }) + if (activeScrolls.get(scrollTarget) !== interrupt) return + const atTarget = frame >= frameCnt + try { + scrollFunc(atTarget ? to : from + delta * easeFunc(frame)) + } catch (error) { + activeScrolls.delete(scrollTarget) + return failScroll(error.message) + } + if (atTarget) { + activeScrolls.delete(scrollTarget) + try { + handle.success({}, { resolve, reject }) + } catch (error) { + reject(error) + } + return } - const dest = from + delta * easeFunc(frame) - scrollFunc(dest) - timer && clearTimeout(timer) - timer = setTimeout(() => { - scroll(frame + 1) - }, FRAME_DURATION) + timer = setTimeout(() => scroll(frame + 1), FRAME_DURATION) } + + const previous = activeScrolls.get(scrollTarget) + // Cancellation callbacks may start another scroll on this target. + activeScrolls.set(scrollTarget, interrupt) + previous?.() scroll() - } catch (e) { - return handle.fail({ - errMsg: e.message - }, { resolve, reject }) + } catch (error) { + failScroll(error.message) } }) }