From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Wed, 29 Apr 2020 14:10:33 +0000 (+0200)
Subject: chore: remove outdated TODO
X-Git-Tag: v4.0.0-alpha.8~8
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=67a1426b0c99d0d38763c57ec0579a1d61dad1d6;p=thirdparty%2Fvuejs%2Frouter.git

chore: remove outdated TODO
---

diff --git a/__tests__/RouterView.spec.ts b/__tests__/RouterView.spec.ts
index 08a53a66..b7e16391 100644
--- a/__tests__/RouterView.spec.ts
+++ b/__tests__/RouterView.spec.ts
@@ -196,10 +196,15 @@ describe('RouterView', () => {
   })
 
   it('does not pass params as props by default', async () => {
-    // TODO: rewrite so it is by default instead of explicitly stated
     let noPropsWithParams = {
       ...routes.withParams,
-      matched: [{ ...routes.withParams.matched[0], props: false }],
+      matched: [
+        {
+          components: { default: components.User },
+          instances: {},
+          path: '/users/:id',
+        },
+      ],
     }
     const { wrapper, route } = await factory(noPropsWithParams)
     expect(wrapper.html()).toBe(`<div>User: default</div>`)
diff --git a/__tests__/history/hash.spec.ts b/__tests__/history/hash.spec.ts
index 5f3fbdbc..765b23f6 100644
--- a/__tests__/history/hash.spec.ts
+++ b/__tests__/history/hash.spec.ts
@@ -80,7 +80,5 @@ describe('History Hash', () => {
         expect.stringMatching(/^#\/?$/)
       )
     })
-
-    it.todo('warns if we provide a base with file://')
   })
 })
diff --git a/__tests__/matcher/pathParser.spec.ts b/__tests__/matcher/pathParser.spec.ts
index 6225d6c1..2d5d1810 100644
--- a/__tests__/matcher/pathParser.spec.ts
+++ b/__tests__/matcher/pathParser.spec.ts
@@ -9,14 +9,6 @@ describe('Path parser', () => {
       ])
     })
 
-    // TODO: refactor trailing slash cases
-    it.skip('trailing slash', () => {
-      expect(tokenizePath('/foo/')).toEqual([
-        [{ type: TokenType.Static, value: 'foo' }],
-        [{ type: TokenType.Static, value: '' }],
-      ])
-    })
-
     it('empty', () => {
       expect(tokenizePath('')).toEqual([[]])
     })
diff --git a/__tests__/matcher/pathRanking.spec.ts b/__tests__/matcher/pathRanking.spec.ts
index f437fed0..86e9151a 100644
--- a/__tests__/matcher/pathRanking.spec.ts
+++ b/__tests__/matcher/pathRanking.spec.ts
@@ -38,7 +38,7 @@ describe('Path ranking', () => {
     })
     it('longer', () => {
       expect(compare([[2]], [[3, 1]])).toEqual(1)
-      // TODO: we are assuming we never pass end: false
+      // NOTE: we are assuming we never pass end: false
       expect(compare([[3]], [[3, 1]])).toEqual(1)
       expect(compare([[1, 3]], [[2]])).toEqual(1)
       expect(compare([[4]], [[3]])).toEqual(-1)
diff --git a/__tests__/mount.ts b/__tests__/mount.ts
index 46091bc2..8e460a4b 100644
--- a/__tests__/mount.ts
+++ b/__tests__/mount.ts
@@ -41,7 +41,6 @@ function initialProps<P>(propsOption: ComponentObjectPropsOptions<P>) {
     const prop = propsOption[key]!
     // @ts-ignore
     if (!prop.required && prop.default)
-      // TODO: function value
       // @ts-ignore
       copy[key] = prop.default
   }
@@ -57,7 +56,6 @@ afterAll(() => {
 })
 
 export function mount(
-  // TODO: generic?
   targetComponent: Parameters<typeof createApp>[0],
   options: Partial<MountOptions> = {}
 ): Promise<Wrapper> {
@@ -124,7 +122,6 @@ export function mount(
       }
     }
 
-    // TODO: how to cleanup?
     const rootEl = document.createElement('div')
     document.body.appendChild(rootEl)
 
@@ -140,6 +137,7 @@ export function mount(
 
     activeWrapperRemovers.push(() => {
       app.unmount(rootEl)
+      rootEl.remove()
     })
   })
 }
diff --git a/e2e/scroll-behavior/index.ts b/e2e/scroll-behavior/index.ts
index dbafb0a2..5ba37ef5 100644
--- a/e2e/scroll-behavior/index.ts
+++ b/e2e/scroll-behavior/index.ts
@@ -40,8 +40,7 @@ const scrollBehavior: ScrollBehavior = async function (
 
       // specify offset of the element
       if (to.hash === '#anchor2') {
-        // TODO: allow partial { y: 100 }
-        position.offset = { x: 0, y: 100 }
+        position.offset = { y: 100 }
       }
 
       // bypass #1number check
diff --git a/playground/views/ComponentWithData.vue b/playground/views/ComponentWithData.vue
index a1598ac8..9a989f14 100644
--- a/playground/views/ComponentWithData.vue
+++ b/playground/views/ComponentWithData.vue
@@ -8,14 +8,18 @@
 <script>
 import { defineComponent, toRefs, reactive, inject } from 'vue'
 import { getData, delay } from '../api'
+import { onBeforeRouteUpdate } from '../../src'
 
 export default defineComponent({
   name: 'ComponentWithData',
   async setup() {
-    const data = reactive({ other: 'old' })
+    const data = reactive({ other: 'old', fromApi: null })
     data.fromApi = await getData()
 
-    // TODO: add sample with onBeforeRouteUpdate()
+    onBeforeRouteUpdate(async (to, from, next) => {
+      data.fromApi = await getData()
+      next()
+    })
 
     return {
       ...toRefs(data),
diff --git a/playground/views/User.vue b/playground/views/User.vue
index 86ccd0c0..af3e6635 100644
--- a/playground/views/User.vue
+++ b/playground/views/User.vue
@@ -12,10 +12,9 @@ export default defineComponent({
   },
 
   beforeRouteUpdate(to, from, next) {
-    // TODO: these do not work yet
-    console.log('this', this)
+    console.log('in beforeRouteUpdate this', this)
     next(vm => {
-      console.log('in next', vm)
+      console.log('in next callback', vm)
     })
   },
 })
diff --git a/src/RouterLink.ts b/src/RouterLink.ts
index b093820b..6c9eda60 100644
--- a/src/RouterLink.ts
+++ b/src/RouterLink.ts
@@ -51,12 +51,10 @@ export function useLink(props: UseLinkOptions) {
       isSameLocationObject(currentRoute.params, route.value.params)
   )
 
-  // TODO: handle replace prop
-  // const method = unref(rep)
-
-  function navigate(e: MouseEvent = {} as MouseEvent) {
-    // TODO: handle navigate with empty parameters for scoped slot and composition api
-    if (guardEvent(e)) router.push(unref(props.to))
+  function navigate(e: MouseEvent = {} as MouseEvent): Promise<any> {
+    if (guardEvent(e))
+      return router[unref(props.replace) ? 'replace' : 'push'](unref(props.to))
+    return Promise.resolve()
   }
 
   return {
diff --git a/src/history/memory.ts b/src/history/memory.ts
index 83f447f6..8e3a2933 100644
--- a/src/history/memory.ts
+++ b/src/history/memory.ts
@@ -18,7 +18,6 @@ import {
  */
 export default function createMemoryHistory(base: string = ''): RouterHistory {
   let listeners: NavigationCallback[] = []
-  // TODO: make sure this is right as the first location is nowhere so maybe this should be empty instead
   let queue: HistoryLocationNormalized[] = [START]
   let position: number = 0
 
@@ -52,7 +51,6 @@ export default function createMemoryHistory(base: string = ''): RouterHistory {
   const routerHistory: RouterHistory = {
     // rewritten by Object.defineProperty
     location: START,
-    // TODO:
     state: {},
     base,
 
diff --git a/src/install.ts b/src/install.ts
index 86d6b6ef..651b8d09 100644
--- a/src/install.ts
+++ b/src/install.ts
@@ -95,5 +95,4 @@ export function applyRouterPlugin(app: App, router: Router) {
 
   app.provide(routerKey, router)
   app.provide(routeLocationKey, reactive(reactiveRoute))
-  // TODO: merge strats for beforeRoute hooks
 }
diff --git a/src/matcher/index.ts b/src/matcher/index.ts
index 8c4b4a2f..fdd5198f 100644
--- a/src/matcher/index.ts
+++ b/src/matcher/index.ts
@@ -43,7 +43,6 @@ export function createRouterMatcher(
     return matcherMap.get(name)
   }
 
-  // TODO: add routes to children of parent
   function addRoute(
     record: RouteRecordRaw,
     parent?: RouteRecordMatcher,
@@ -250,7 +249,6 @@ export function createRouterMatcher(
     while (parentMatcher) {
       // reversed order so parents are at the beginning
 
-      // TODO: check resolving child routes by path when parent has an alias
       matched.unshift(parentMatcher.record)
       parentMatcher = parentMatcher.parent
     }
diff --git a/src/matcher/pathMatcher.ts b/src/matcher/pathMatcher.ts
index 0132a111..fd4745dc 100644
--- a/src/matcher/pathMatcher.ts
+++ b/src/matcher/pathMatcher.ts
@@ -35,7 +35,6 @@ export function createRouteRecordMatcher(
     // passing originalRecord in Matcher.addRoute
     if (!matcher.record.aliasOf === !parent.record.aliasOf)
       parent.children.push(matcher)
-    // else TODO: save alias children to be able to remove them
   }
 
   return matcher
diff --git a/src/matcher/pathTokenizer.ts b/src/matcher/pathTokenizer.ts
index 5b8cbcb0..2e9c43d6 100644
--- a/src/matcher/pathTokenizer.ts
+++ b/src/matcher/pathTokenizer.ts
@@ -123,9 +123,6 @@ export function tokenizePath(path: string): Array<Token[]> {
         } else if (char === ':') {
           consumeBuffer()
           state = TokenizerState.Param
-          // } else if (char === '{') {
-          // TODO: handle group (or drop it)
-          // addCharToBuffer()
         } else {
           addCharToBuffer()
         }
diff --git a/src/router.ts b/src/router.ts
index 0eaa56e4..bb37b5dd 100644
--- a/src/router.ts
+++ b/src/router.ts
@@ -5,7 +5,6 @@ import {
   PostNavigationGuard,
   START_LOCATION_NORMALIZED,
   Lazy,
-  TODO,
   MatcherLocation,
   RouteLocationNormalizedLoaded,
   RouteLocation,
@@ -60,8 +59,7 @@ export interface ScrollBehavior {
     to: RouteLocationNormalized,
     from: RouteLocationNormalizedLoaded,
     savedPosition: Required<ScrollPositionCoordinates> | null
-  ): // TODO: implement false nad refactor promise based type
-  Awaitable<ScrollPosition | false | void>
+  ): Awaitable<ScrollPosition | false | void>
 }
 
 export interface RouterOptions {
@@ -405,11 +403,10 @@ export function createRouter({
   function navigate(
     to: RouteLocationNormalized,
     from: RouteLocationNormalizedLoaded
-  ): Promise<TODO> {
+  ): Promise<any> {
     let guards: Lazy<any>[]
 
     // all components here have been resolved once because we are leaving
-    // TODO: refactor both together
     guards = extractComponentsGuards(
       from.matched.filter(record => to.matched.indexOf(record) < 0).reverse(),
       'beforeRouteLeave',
@@ -477,7 +474,7 @@ export function createRouter({
         return runGuardQueue(guards)
       })
       .then(() => {
-        // TODO: at this point to.matched is normalized and does not contain any () => Promise<Component>
+        // NOTE: at this point to.matched is normalized and does not contain any () => Promise<Component>
 
         // check in-component beforeRouteEnter
         guards = extractComponentsGuards(
@@ -541,7 +538,7 @@ export function createRouter({
       record.leaveGuards = []
       // free the references
 
-      // TODO: add tests
+      // TODO: to refactor once keep-alive and transition can be supported
       record.instances = {}
     }
 
@@ -564,8 +561,9 @@ export function createRouter({
 
     // accept current navigation
     currentRoute.value = toLocation
-    // TODO: this doesn't work on first load. Moving it to RouterView could allow automatically handling transitions too maybe
-    // TODO: refactor with a state getter
+    // TODO: call handleScroll in afterEach so it can also be triggered on
+    // duplicated navigation (e.g. same anchor navigation). It needs exposing
+    // the navigation information (type, direction)
     if (isBrowser) {
       const savedScroll = getSavedScrollPosition(
         getScrollKey(toLocation.fullPath, 0)
@@ -620,8 +618,9 @@ export function createRouter({
           pushWithRedirect(
             (error as NavigationRedirectError).to,
             toLocation
+          ).catch(() => {
             // TODO: in dev show warning, in prod noop, same as initial navigation
-          )
+          })
           // avoid the then branch
           return Promise.reject()
         }
@@ -649,7 +648,9 @@ export function createRouter({
           failure
         )
       })
-      .catch(() => {})
+      .catch(() => {
+        // TODO: same as above: in dev show warning, in prod noop, same as initial navigation
+      })
   })
 
   // Initialization and Errors
diff --git a/src/types/index.ts b/src/types/index.ts
index 3a6fe8b4..ad30df7a 100644
--- a/src/types/index.ts
+++ b/src/types/index.ts
@@ -3,6 +3,7 @@ import { PathParserOptions } from '../matcher/pathParserRanker'
 import { Ref, ComputedRef, ComponentOptions } from 'vue'
 import { RouteRecord, RouteRecordNormalized } from '../matcher/types'
 import { HistoryState } from '../history/common'
+import { NavigationFailure } from '../errors'
 
 export type Lazy<T> = () => Promise<T>
 export type Override<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U
@@ -86,7 +87,6 @@ export interface _RouteLocationBase {
   hash: string
   name: RouteRecordName | null | undefined
   params: RouteParams
-  // TODO: make it an array?
   redirectedFrom: RouteLocation | undefined
   meta: Record<string | number | symbol, any>
 }
@@ -233,8 +233,6 @@ export interface MatcherLocation
     'name' | 'path' | 'params' | 'matched' | 'meta'
   > {}
 
-// TODO: remove any to type vm and use a generic that comes from the component
-// where the navigation guard callback is defined
 export interface NavigationGuardCallback {
   (): void
   (error: Error): void
@@ -268,7 +266,7 @@ export interface PostNavigationGuard {
     to: RouteLocationNormalized,
     from: RouteLocationNormalized,
     // TODO: move these types to a different file
-    failure?: TODO
+    failure?: NavigationFailure | void
   ): any
 }