feature: add support for attaching state to location

Author: Joe Nields

Diff for: flow/declarations.js

@@ -84,6 +84,7 @@ declare type Location = {
   path?: string;
   hash?: string;
   query?: Dictionary<string>;
+  state?: mixed;
   params?: Dictionary<string>;
   append?: boolean;
   replace?: boolean;
@@ -96,6 +97,7 @@ declare type Route = {
   name: ?string;
   hash: string;
   query: Dictionary<string>;
+  state: mixed;
   params: Dictionary<string>;
   fullPath: string;
   matched: Array<RouteRecord>;

Diff for: src/history/abstract.js

@@ -42,7 +42,14 @@ export class AbstractHistory extends History {
 
   getCurrentLocation () {
     const current = this.stack[this.stack.length - 1]
-    return current ? current.fullPath : '/'
+    return current
+      ? {
+        path: current.path,
+        query: current.query,
+        hash: current.hash,
+        state: current.state
+      }
+      : { path: '/' }
   }
 
   ensureURL () {

Diff for: src/history/base.js

@@ -28,7 +28,7 @@ export class History {
   +push: (loc: RawLocation) => void;
   +replace: (loc: RawLocation) => void;
   +ensureURL: (push?: boolean) => void;
-  +getCurrentLocation: () => string;
+  +getCurrentLocation: () => Location;
 
   constructor (router: Router, base: ?string) {
     this.router = router

Diff for: src/history/hash.js

@@ -2,7 +2,8 @@
 
 import type Router from '../index'
 import { History } from './base'
-import { cleanPath } from '../util/path'
+import { cleanPath, parsePath } from '../util/path'
+import { resolveQuery, stringifyQuery } from '../util/query'
 import { getLocation } from './html5'
 import { setupScroll, handleScroll } from '../util/scroll'
 import { pushState, replaceState, supportsPushState } from '../util/push-state'
@@ -74,12 +75,16 @@ export class HashHistory extends History {
   }
 
   getCurrentLocation () {
-    return getHash()
+    const { path, query, hash } = parsePath(getHash())
+    return { path, query: resolveQuery(query), hash }
   }
 }
 
 function checkFallback (base) {
-  const location = getLocation(base)
+  const rawLocation = getLocation(base)
+  const location = typeof rawLocation === 'string'
+    ? rawLocation
+    : `${rawLocation.path || ''}${stringifyQuery(rawLocation.query || {})}${rawLocation.hash || ''}`
   if (!/^\/#/.test(location)) {
     window.location.replace(
       cleanPath(base + '/#' + location)
@@ -114,15 +119,15 @@ function getUrl (path) {
 
 function pushHash (path) {
   if (supportsPushState) {
-    pushState(getUrl(path))
+    pushState(undefined, getUrl(path))
   } else {
     window.location.hash = path
   }
 }
 
 function replaceHash (path) {
   if (supportsPushState) {
-    replaceState(getUrl(path))
+    replaceState(undefined, getUrl(path))
   } else {
     window.location.replace(getUrl(path))
   }

Diff for: src/history/html5.js

@@ -3,6 +3,7 @@
 import type Router from '../index'
 import { History } from './base'
 import { cleanPath } from '../util/path'
+import { resolveQuery } from '../util/query'
 import { START } from '../util/route'
 import { setupScroll, handleScroll } from '../util/scroll'
 import { pushState, replaceState, supportsPushState } from '../util/push-state'
@@ -44,7 +45,8 @@ export class HTML5History extends History {
   push (location: RawLocation, onComplete?: Function, onAbort?: Function) {
     const { current: fromRoute } = this
     this.transitionTo(location, route => {
-      pushState(cleanPath(this.base + route.fullPath))
+      const state = typeof location === 'string' ? undefined : location.state
+      pushState(state, cleanPath(this.base + route.fullPath))
       handleScroll(this.router, route, fromRoute, false)
       onComplete && onComplete(route)
     }, onAbort)
@@ -53,7 +55,11 @@ export class HTML5History extends History {
   replace (location: RawLocation, onComplete?: Function, onAbort?: Function) {
     const { current: fromRoute } = this
     this.transitionTo(location, route => {
-      replaceState(cleanPath(this.base + route.fullPath))
+      const state = typeof location === 'string' ? undefined : location.state
+      replaceState(
+        state,
+        cleanPath(this.base + route.fullPath),
+      )
       handleScroll(this.router, route, fromRoute, false)
       onComplete && onComplete(route)
     }, onAbort)
@@ -62,19 +68,25 @@ export class HTML5History extends History {
   ensureURL (push?: boolean) {
     if (getLocation(this.base) !== this.current.fullPath) {
       const current = cleanPath(this.base + this.current.fullPath)
-      push ? pushState(current) : replaceState(current)
+      if (push) pushState(this.current.state, current)
+      else replaceState(this.current.state, current)
     }
   }
 
-  getCurrentLocation (): string {
+  getCurrentLocation (): Location {
     return getLocation(this.base)
   }
 }
 
-export function getLocation (base: string): string {
+export function getLocation (base: string): Location {
   let path = decodeURI(window.location.pathname)
   if (base && path.indexOf(base) === 0) {
     path = path.slice(base.length)
   }
-  return (path || '/') + window.location.search + window.location.hash
+  return {
+    path: (path || '/'),
+    query: resolveQuery((window.location.search: string)),
+    hash: (window.location.hash: string),
+    state: window.history.state ? window.history.state.state : undefined
+  }
 }

Diff for: src/util/deepEqual.js

@@ -0,0 +1,59 @@
+const hasOwn = Object.prototype.hasOwnProperty
+
+function is (x, y) {
+  if (x === y) {
+    // is(-0, +0) === false
+    return x !== 0 || y !== 0 || 1 / x === 1 / y
+  } else {
+    /* eslint-disable no-self-compare */
+    return x !== x && y !== y // is(NaN, NaN) === true
+    /* eslint-enable no-self-compare */
+  }
+}
+
+// deep equal, with guard against circular references
+const guardedDeepEqual = (objA, objB, bufferA, bufferB) => {
+  if (is(objA, objB)) return true
+
+  if (
+    typeof objA !== 'object' ||
+    objA === null ||
+    typeof objB !== 'object' ||
+    objB === null
+  ) {
+    return false
+  }
+  const seenA = bufferA.indexOf(objA) !== -1
+  const seenB = bufferB.indexOf(objB) !== -1
+
+  if (seenA || seenB) return seenA && seenB
+
+  bufferA.push(objA)
+  bufferB.push(objB)
+
+  const keysA = Object.keys(objA)
+  const keysB = Object.keys(objB)
+
+  if (keysA.length !== keysB.length) return false
+
+  for (let i = 0; i < keysA.length; i += 1) {
+    if (!hasOwn.call(objB, keysA[i])) return false
+    const valA = objA[keysA[i]]
+    const valB = objB[keysA[i]]
+    if (
+      typeof valA === 'object' &&
+      valA &&
+      typeof valB === 'object' &&
+      valB &&
+      !guardedDeepEqual(valA, valB, bufferA, bufferB)
+    ) {
+      return false
+    } else if (!is(valA, valB)) {
+      return false
+    }
+  }
+
+  return true
+}
+
+export default (objA, objB) => guardedDeepEqual(objA, objB, [], [])

Diff for: src/util/location.js

@@ -57,6 +57,7 @@ export function normalizeLocation (
     _normalized: true,
     path,
     query,
-    hash
+    hash,
+    state: next.state
   }
 }

Diff for: src/util/push-state.js

@@ -37,23 +37,23 @@ export function setStateKey (key: string) {
   _key = key
 }
 
-export function pushState (url?: string, replace?: boolean) {
+export function pushState (state: mixed, url: string, replace?: boolean) {
   saveScrollPosition()
   // try...catch the pushState call to get around Safari
   // DOM Exception 18 where it limits to 100 pushState calls
   const history = window.history
   try {
     if (replace) {
-      history.replaceState({ key: _key }, '', url)
+      history.replaceState({ key: _key, state }, '', url)
     } else {
       _key = genKey()
-      history.pushState({ key: _key }, '', url)
+      history.pushState({ key: _key, state }, '', url)
     }
   } catch (e) {
     window.location[replace ? 'replace' : 'assign'](url)
   }
 }
 
-export function replaceState (url?: string) {
-  pushState(url, true)
+export function replaceState (state: mixed, url: string) {
+  pushState(state, url, true)
 }

Diff for: src/util/route.js

@@ -2,6 +2,7 @@
 
 import type VueRouter from '../index'
 import { stringifyQuery } from './query'
+import deepEqual from './deepEqual'
 
 const trailingSlashRE = /\/?$/
 
@@ -23,6 +24,7 @@ export function createRoute (
     meta: (record && record.meta) || {},
     path: location.path || '/',
     hash: location.hash || '',
+    state: location.state,
     query,
     params: location.params || {},
     fullPath: getFullPath(location, stringifyQuery),
@@ -79,14 +81,16 @@ export function isSameRoute (a: Route, b: ?Route): boolean {
     return (
       a.path.replace(trailingSlashRE, '') === b.path.replace(trailingSlashRE, '') &&
       a.hash === b.hash &&
-      isObjectEqual(a.query, b.query)
+      isObjectEqual(a.query, b.query) &&
+      deepEqual(a.state, b.state)
     )
   } else if (a.name && b.name) {
     return (
       a.name === b.name &&
       a.hash === b.hash &&
       isObjectEqual(a.query, b.query) &&
-      isObjectEqual(a.params, b.params)
+      isObjectEqual(a.params, b.params) &&
+      deepEqual(a.state, b.state)
     )
   } else {
     return false