fix(transition): fix dom transition cancel hooks not being called

vuejs · Jun 25, 2020 · acd3156 · acd3156
1 parent b3bdd70
commit acd3156
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 16 deletions.
diff --git a/packages/runtime-dom/src/components/Transition.ts b/packages/runtime-dom/src/components/Transition.ts
@@ -99,7 +99,14 @@ export function resolveTransitionProps(
   const durations = normalizeDuration(duration)
   const enterDuration = durations && durations[0]
   const leaveDuration = durations && durations[1]
-  const { appear, onBeforeEnter, onEnter, onLeave } = baseProps
+  const {
+    appear,
+    onBeforeEnter,
+    onEnter,
+    onLeave,
+    onEnterCancelled,
+    onLeaveCancelled
+  } = baseProps
 
   // is appearing
   if (appear && !instance.isMounted) {
@@ -108,9 +115,11 @@ export function resolveTransitionProps(
     enterToClass = appearToClass
   }
 
-  type Hook = (el: Element, done?: () => void) => void
+  type Hook =
+    | ((el: Element, done: () => void) => void)
+    | ((el: Element) => void)
 
-  const finishEnter: Hook = (el, done) => {
+  const finishEnter = (el: Element, done?: () => void) => {
     removeTransitionClass(el, enterToClass)
     removeTransitionClass(el, enterActiveClass)
     done && done()
@@ -120,16 +129,22 @@ export function resolveTransitionProps(
     }
   }
 
-  const finishLeave: Hook = (el, done) => {
+  const finishLeave = (el: Element, done?: () => void) => {
     removeTransitionClass(el, leaveToClass)
     removeTransitionClass(el, leaveActiveClass)
     done && done()
   }
 
   // only needed for user hooks called in nextFrame
   // sync errors are already handled by BaseTransition
-  function callHookWithErrorHandling(hook: Hook, args: any[]) {
-    callWithAsyncErrorHandling(hook, instance, ErrorCodes.TRANSITION_HOOK, args)
+  const callHook = (hook: Hook | undefined, args: any[]) => {
+    hook &&
+      callWithAsyncErrorHandling(
+        hook,
+        instance,
+        ErrorCodes.TRANSITION_HOOK,
+        args
+      )
   }
 
   return extend(baseProps, {
@@ -141,7 +156,7 @@ export function resolveTransitionProps(
     onEnter(el, done) {
       nextFrame(() => {
         const resolve = () => finishEnter(el, done)
-        onEnter && callHookWithErrorHandling(onEnter as Hook, [el, resolve])
+        callHook(onEnter, [el, resolve])
         removeTransitionClass(el, enterFromClass)
         addTransitionClass(el, enterToClass)
         if (!(onEnter && onEnter.length > 1)) {
@@ -158,7 +173,7 @@ export function resolveTransitionProps(
       addTransitionClass(el, leaveFromClass)
       nextFrame(() => {
         const resolve = () => finishLeave(el, done)
-        onLeave && callHookWithErrorHandling(onLeave as Hook, [el, resolve])
+        callHook(onLeave, [el, resolve])
         removeTransitionClass(el, leaveFromClass)
         addTransitionClass(el, leaveToClass)
         if (!(onLeave && onLeave.length > 1)) {
@@ -170,8 +185,14 @@ export function resolveTransitionProps(
         }
       })
     },
-    onEnterCancelled: finishEnter,
-    onLeaveCancelled: finishLeave
+    onEnterCancelled(el) {
+      finishEnter(el)
+      onEnterCancelled && onEnterCancelled(el)
+    },
+    onLeaveCancelled(el) {
+      finishLeave(el)
+      onLeaveCancelled && onLeaveCancelled(el)
+    }
   } as BaseTransitionProps<Element>)
 }
 

diff --git a/packages/vue/__tests__/Transition.spec.ts b/packages/vue/__tests__/Transition.spec.ts
@@ -433,8 +433,7 @@ describe('e2e: Transition', () => {
         'test-leave-active',
         'test-leave-from'
       ])
-      // fixme
-      expect(enterCancelledSpy).not.toBeCalled()
+      expect(enterCancelledSpy).toBeCalled()
       await nextFrame()
       expect(await classList('.test')).toStrictEqual([
         'test',
@@ -1255,8 +1254,8 @@ describe('e2e: Transition', () => {
           createApp({
             template: `
             <div id="container">
-              <transition name="test">
-                <div v-show="toggle" class="test" @leave-cancelled="onLeaveCancelledSpy">content</div>
+              <transition name="test" @leave-cancelled="onLeaveCancelledSpy">
+                <div v-show="toggle" class="test">content</div>
               </transition>
             </div>
             <button id="toggleBtn" @click="click">button</button>
@@ -1290,8 +1289,7 @@ describe('e2e: Transition', () => {
           'test-enter-active',
           'test-enter-from'
         ])
-        // fixme
-        expect(onLeaveCancelledSpy).not.toBeCalled()
+        expect(onLeaveCancelledSpy).toBeCalled()
         await nextFrame()
         expect(await classList('.test')).toStrictEqual([
           'test',