From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Wed, 2 Sep 2020 16:01:14 +0000 (+0200)
Subject: fix(warn): correctly warn against unused next
X-Git-Tag: v4.0.0-beta.10~71
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=47cd7b97bb7a3999178a26a4ca1af955178ea5d6;p=thirdparty%2Fvuejs%2Frouter.git

fix(warn): correctly warn against unused next
---

diff --git a/__tests__/guards/guardToPromiseFn.spec.ts b/__tests__/guards/guardToPromiseFn.spec.ts
index 66c5d729..d2b596f9 100644
--- a/__tests__/guards/guardToPromiseFn.spec.ts
+++ b/__tests__/guards/guardToPromiseFn.spec.ts
@@ -229,9 +229,53 @@ describe('guardToPromiseFn', () => {
   it('warns if guard resolves without calling next', async () => {
     expect.assertions(2)
     await expect(
-      guardToPromiseFn((to, from, next) => false, to, from)()
+      guardToPromiseFn(
+        async (to, from, next) => {
+          // oops not called next
+        },
+        to,
+        from
+      )()
+    ).rejects.toThrowError()
+    expect('callback was never called').toHaveBeenWarned()
+  })
+
+  it('does not warn if guard rejects without calling next', async () => {
+    expect.assertions(2)
+    await expect(
+      guardToPromiseFn(
+        async (to, from, next) => {
+          // oops not called next
+          throw new Error('nope')
+        },
+        to,
+        from
+      )()
     ).rejects.toThrowError()
+    expect('callback was never called').not.toHaveBeenWarned()
+  })
 
+  it('warns if guard returns without calling next', async () => {
+    expect.assertions(2)
+    await expect(
+      guardToPromiseFn((to, from, next) => false, to, from)()
+    ).rejects.toThrowError()
     expect('callback was never called').toHaveBeenWarned()
   })
+
+  it('does not warn if guard returns undefined', async () => {
+    expect.assertions(2)
+    await expect(
+      guardToPromiseFn(
+        (to, from, next) => {
+          // there could be a callback somewhere
+          setTimeout(next, 10)
+        },
+        to,
+        from
+      )()
+    ).resolves.toEqual(undefined)
+
+    expect('callback was never called').not.toHaveBeenWarned()
+  })
 })
diff --git a/src/navigationGuards.ts b/src/navigationGuards.ts
index a69929fc..1add7d04 100644
--- a/src/navigationGuards.ts
+++ b/src/navigationGuards.ts
@@ -159,27 +159,38 @@ export function guardToPromiseFn(
       }
 
       // wrapping with Promise.resolve allows it to work with both async and sync guards
-      let guardCall = Promise.resolve(
-        guard.call(
-          record && record.instances[name!],
-          to,
-          from,
-          __DEV__ ? canOnlyBeCalledOnce(next, to, from) : next
-        )
+      const guardReturn = guard.call(
+        record && record.instances[name!],
+        to,
+        from,
+        __DEV__ ? canOnlyBeCalledOnce(next, to, from) : next
       )
+      let guardCall = Promise.resolve(guardReturn)
 
       if (guard.length < 3) guardCall = guardCall.then(next)
-      if (__DEV__ && guard.length > 2)
-        guardCall = guardCall.then(() => {
+      if (__DEV__ && guard.length > 2) {
+        const message = `The "next" callback was never called inside of ${
+          guard.name ? '"' + guard.name + '"' : ''
+        }:\n${guard.toString()}\n. If you are returning a value instead of calling "next", make sure to remove the "next" parameter from your function.`
+        if (typeof guardReturn === 'object' && 'then' in guardReturn) {
+          guardCall = guardCall.then(resolvedValue => {
+            // @ts-ignore: _called is added at canOnlyBeCalledOnce
+            if (!next._called) {
+              warn(message)
+              return Promise.reject(new Error('Invalid navigation guard'))
+            }
+            return resolvedValue
+          })
+          // TODO: test me!
+        } else if (guardReturn !== undefined) {
           // @ts-ignore: _called is added at canOnlyBeCalledOnce
-          if (!next._called)
-            warn(
-              `The "next" callback was never called inside of ${
-                guard.name ? '"' + guard.name + '"' : ''
-              }:\n${guard.toString()}\n. If you are returning a value instead of calling "next", make sure to remove the "next" parameter from your function.`
-            )
-          return Promise.reject(new Error('Invalid navigation guard'))
-        })
+          if (!next._called) {
+            warn(message)
+            reject(new Error('Invalid navigation guard'))
+            return
+          }
+        }
+      }
       guardCall.catch(err => reject(err))
     })
 }