Change Router's key to public field

vercel · Mar 31, 2022 · 8542cb5 · 8542cb5
1 parent b1e51be
commit 8542cb5
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/docs/api-reference/next/router.md b/docs/api-reference/next/router.md
@@ -52,6 +52,7 @@ The following is the definition of the `router` object returned by both [`useRou
 - `domainLocales`: `Array<{domain, defaultLocale, locales}>` - Any configured domain locales.
 - `isReady`: `boolean` - Whether the router fields are updated client-side and ready for use. Should only be used inside of `useEffect` methods and not for conditionally rendering on the server. See related docs for use case with [automatically statically optimized pages](/docs/advanced-features/automatic-static-optimization.md)
 - `isPreview`: `boolean` - Whether the application is currently in [preview mode](/docs/advanced-features/preview-mode.md).
+- `key`: `string` - String uniquely representing the current history entry. Reloading will reset it.
 
 The following methods are included inside `router`:
 

diff --git a/packages/next/client/router.ts b/packages/next/client/router.ts
@@ -45,6 +45,7 @@ const urlPropertyFields = [
   'locales',
   'defaultLocale',
   'isReady',
+  'key',
   'isPreview',
   'isLocaleDomain',
   'domainLocales',

diff --git a/packages/next/server/render.tsx b/packages/next/server/render.tsx
@@ -79,6 +79,7 @@ import {
 } from './node-web-streams-helper'
 import { ImageConfigContext } from '../shared/lib/image-config-context'
 import { FlushEffectsContext } from '../shared/lib/flush-effects'
+import { createKey } from '../shared/lib/router/router'
 
 let optimizeAmp: typeof import('./optimize-amp').default
 let getFontDefinitionFromManifest: typeof import('./font-utils').getFontDefinitionFromManifest
@@ -121,6 +122,7 @@ class ServerRouter implements NextRouter {
   domainLocales?: DomainLocale[]
   isPreview: boolean
   isLocaleDomain: boolean
+  key: string
 
   constructor(
     pathname: string,
@@ -149,6 +151,7 @@ class ServerRouter implements NextRouter {
     this.domainLocales = domainLocales
     this.isPreview = !!isPreview
     this.isLocaleDomain = !!isLocaleDomain
+    this.key = createKey()
   }
 
   push(): any {

diff --git a/packages/next/shared/lib/router/router.ts b/packages/next/shared/lib/router/router.ts
@@ -462,6 +462,7 @@ export type NextRouter = BaseRouter &
     | 'isFallback'
     | 'isReady'
     | 'isPreview'
+    | 'key'
   >
 
 export type PrefetchOptions = {
@@ -597,7 +598,7 @@ interface NextDataCache {
 
 type Key = string
 
-function createKey() {
+export function createKey() {
   return Math.random().toString(36).slice(2, 10)
 }
 
@@ -629,6 +630,7 @@ export default class Router implements BaseRouter {
   domainLocales?: DomainLocale[]
   isReady: boolean
   isLocaleDomain: boolean
+  key: Key
 
   private state: Readonly<{
     route: string
@@ -640,8 +642,6 @@ export default class Router implements BaseRouter {
     isPreview: boolean
   }>
 
-  private key: Key
-
   static events: MittEmitter<RouterEvent> = mitt()
 
   constructor(