Unverified Commit d1a1a4c0 authored by Javi Velasco's avatar Javi Velasco Committed by GitHub

Improve and refactor some types (#31704)

parent 03ecbcf1
...@@ -2057,8 +2057,6 @@ export default async function build( ...@@ -2057,8 +2057,6 @@ export default async function build(
return buildResult return buildResult
} }
export type ClientSsgManifest = Set<string>
function generateClientSsgManifest( function generateClientSsgManifest(
prerenderManifest: PrerenderManifest, prerenderManifest: PrerenderManifest,
{ {
...@@ -2067,7 +2065,7 @@ function generateClientSsgManifest( ...@@ -2067,7 +2065,7 @@ function generateClientSsgManifest(
locales, locales,
}: { buildId: string; distDir: string; locales: string[] } }: { buildId: string; distDir: string; locales: string[] }
) { ) {
const ssgPages: ClientSsgManifest = new Set<string>([ const ssgPages = new Set<string>([
...Object.entries(prerenderManifest.routes) ...Object.entries(prerenderManifest.routes)
// Filter out dynamic routes // Filter out dynamic routes
.filter(([, { srcRoute }]) => srcRoute == null) .filter(([, { srcRoute }]) => srcRoute == null)
......
...@@ -209,7 +209,7 @@ export default class BuildManifestPlugin { ...@@ -209,7 +209,7 @@ export default class BuildManifestPlugin {
assetMap.lowPriorityFiles.push(ssgManifestPath) assetMap.lowPriorityFiles.push(ssgManifestPath)
assets[ssgManifestPath] = new sources.RawSource(srcEmptySsgManifest) assets[ssgManifestPath] = new sources.RawSource(srcEmptySsgManifest)
const srcEmptyMiddlewareManifest = `self.__MIDDLEWARE_MANIFEST=new Set;self.__MIDDLEWARE_MANIFEST_CB&&self.__MIDDLEWARE_MANIFEST_CB()` const srcEmptyMiddlewareManifest = `self.__MIDDLEWARE_MANIFEST=[];self.__MIDDLEWARE_MANIFEST_CB&&self.__MIDDLEWARE_MANIFEST_CB()`
const middlewareManifestPath = `${CLIENT_STATIC_FILES_PATH}/${this.buildId}/_middlewareManifest.js` const middlewareManifestPath = `${CLIENT_STATIC_FILES_PATH}/${this.buildId}/_middlewareManifest.js`
assetMap.lowPriorityFiles.push(middlewareManifestPath) assetMap.lowPriorityFiles.push(middlewareManifestPath)
assets[middlewareManifestPath] = new sources.RawSource( assets[middlewareManifestPath] = new sources.RawSource(
......
...@@ -18,7 +18,7 @@ export const ssrEntries = new Map<string, { requireFlightManifest: boolean }>() ...@@ -18,7 +18,7 @@ export const ssrEntries = new Map<string, { requireFlightManifest: boolean }>()
export interface MiddlewareManifest { export interface MiddlewareManifest {
version: 1 version: 1
sortedMiddleware: string[] sortedMiddleware: string[]
clientInfo: [string, boolean][] clientInfo: [location: string, isSSR: boolean][]
middleware: { middleware: {
[page: string]: { [page: string]: {
env: string[] env: string[]
......
...@@ -6,7 +6,8 @@ import { StyleRegistry } from 'styled-jsx' ...@@ -6,7 +6,8 @@ import { StyleRegistry } from 'styled-jsx'
import { HeadManagerContext } from '../shared/lib/head-manager-context' import { HeadManagerContext } from '../shared/lib/head-manager-context'
import mitt, { MittEmitter } from '../shared/lib/mitt' import mitt, { MittEmitter } from '../shared/lib/mitt'
import { RouterContext } from '../shared/lib/router-context' import { RouterContext } from '../shared/lib/router-context'
import Router, { import type Router from '../shared/lib/router/router'
import {
AppComponent, AppComponent,
AppProps, AppProps,
delBasePath, delBasePath,
......
import { ComponentType } from 'react' import type { ComponentType } from 'react'
import { ClientSsgManifest } from '../build' import type { RouteLoader } from './route-loader'
import { import {
addBasePath, addBasePath,
addLocale, addLocale,
...@@ -13,7 +13,6 @@ import { ...@@ -13,7 +13,6 @@ import {
createRouteLoader, createRouteLoader,
getClientBuildManifest, getClientBuildManifest,
getMiddlewareManifest, getMiddlewareManifest,
RouteLoader,
} from './route-loader' } from './route-loader'
function normalizeRoute(route: string): string { function normalizeRoute(route: string): string {
...@@ -25,6 +24,15 @@ function normalizeRoute(route: string): string { ...@@ -25,6 +24,15 @@ function normalizeRoute(route: string): string {
return route.replace(/\/$/, '') return route.replace(/\/$/, '')
} }
declare global {
interface Window {
__DEV_MIDDLEWARE_MANIFEST?: [location: string, isSSR: boolean][]
__DEV_PAGES_MANIFEST?: { pages: string[] }
__SSG_MANIFEST_CB?: () => void
__SSG_MANIFEST?: Set<string>
}
}
export type StyleSheetTuple = { href: string; text: string } export type StyleSheetTuple = { href: string; text: string }
export type GoodPageCache = { export type GoodPageCache = {
page: ComponentType page: ComponentType
...@@ -35,10 +43,12 @@ export type GoodPageCache = { ...@@ -35,10 +43,12 @@ export type GoodPageCache = {
export default class PageLoader { export default class PageLoader {
private buildId: string private buildId: string
private assetPrefix: string private assetPrefix: string
private promisedSsgManifest: Promise<Set<string>>
private promisedDevPagesManifest?: Promise<string[]>
private promisedMiddlewareManifest?: Promise<
[location: string, isSSR: boolean][]
>
private promisedSsgManifest?: Promise<ClientSsgManifest>
private promisedDevPagesManifest?: Promise<any>
private promisedMiddlewareManifest?: Promise<[string, boolean][]>
public routeLoader: RouteLoader public routeLoader: RouteLoader
constructor(buildId: string, assetPrefix: string) { constructor(buildId: string, assetPrefix: string) {
...@@ -47,13 +57,12 @@ export default class PageLoader { ...@@ -47,13 +57,12 @@ export default class PageLoader {
this.buildId = buildId this.buildId = buildId
this.assetPrefix = assetPrefix this.assetPrefix = assetPrefix
/** @type {Promise<Set<string>>} */
this.promisedSsgManifest = new Promise((resolve) => { this.promisedSsgManifest = new Promise((resolve) => {
if ((window as any).__SSG_MANIFEST) { if (window.__SSG_MANIFEST) {
resolve((window as any).__SSG_MANIFEST) resolve(window.__SSG_MANIFEST)
} else { } else {
;(window as any).__SSG_MANIFEST_CB = () => { window.__SSG_MANIFEST_CB = () => {
resolve((window as any).__SSG_MANIFEST) resolve(window.__SSG_MANIFEST!)
} }
} }
}) })
...@@ -63,48 +72,54 @@ export default class PageLoader { ...@@ -63,48 +72,54 @@ export default class PageLoader {
if (process.env.NODE_ENV === 'production') { if (process.env.NODE_ENV === 'production') {
return getClientBuildManifest().then((manifest) => manifest.sortedPages) return getClientBuildManifest().then((manifest) => manifest.sortedPages)
} else { } else {
if ((window as any).__DEV_PAGES_MANIFEST) { if (window.__DEV_PAGES_MANIFEST) {
return (window as any).__DEV_PAGES_MANIFEST.pages return window.__DEV_PAGES_MANIFEST.pages
} else { } else {
if (!this.promisedDevPagesManifest) { if (!this.promisedDevPagesManifest) {
// TODO: Decide what should happen when fetching fails instead of asserting
// @ts-ignore
this.promisedDevPagesManifest = fetch( this.promisedDevPagesManifest = fetch(
`${this.assetPrefix}/_next/static/development/_devPagesManifest.json` `${this.assetPrefix}/_next/static/development/_devPagesManifest.json`
) )
.then((res) => res.json()) .then((res) => res.json())
.then((manifest) => { .then((manifest: { pages: string[] }) => {
;(window as any).__DEV_PAGES_MANIFEST = manifest window.__DEV_PAGES_MANIFEST = manifest
return manifest.pages return manifest.pages
}) })
.catch((err) => { .catch((err) => {
console.log(`Failed to fetch devPagesManifest`, err) console.log(`Failed to fetch devPagesManifest`, err)
}) })
} }
return this.promisedDevPagesManifest // TODO Remove this assertion as this could be undefined
return this.promisedDevPagesManifest!
} }
} }
} }
getMiddlewareList(): Promise<[string, boolean][]> { getMiddlewareList() {
if (process.env.NODE_ENV === 'production') { if (process.env.NODE_ENV === 'production') {
return getMiddlewareManifest() return getMiddlewareManifest()
} else { } else {
if ((window as any).__DEV_MIDDLEWARE_MANIFEST) { if (window.__DEV_MIDDLEWARE_MANIFEST) {
return (window as any).__DEV_MIDDLEWARE_MANIFEST return window.__DEV_MIDDLEWARE_MANIFEST
} else { } else {
if (!this.promisedMiddlewareManifest) { if (!this.promisedMiddlewareManifest) {
// TODO: Decide what should happen when fetching fails instead of asserting
// @ts-ignore
this.promisedMiddlewareManifest = fetch( this.promisedMiddlewareManifest = fetch(
`${this.assetPrefix}/_next/static/${this.buildId}/_devMiddlewareManifest.json` `${this.assetPrefix}/_next/static/${this.buildId}/_devMiddlewareManifest.json`
) )
.then((res) => res.json()) .then((res) => res.json())
.then((manifest) => { .then((manifest: [location: string, isSSR: boolean][]) => {
;(window as any).__DEV_MIDDLEWARE_MANIFEST = manifest window.__DEV_MIDDLEWARE_MANIFEST = manifest
return manifest return manifest
}) })
.catch((err) => { .catch((err) => {
console.log(`Failed to fetch _devMiddlewareManifest`, err) console.log(`Failed to fetch _devMiddlewareManifest`, err)
}) })
} }
return this.promisedMiddlewareManifest // TODO Remove this assertion as this could be undefined
return this.promisedMiddlewareManifest!
} }
} }
} }
...@@ -123,7 +138,7 @@ export default class PageLoader { ...@@ -123,7 +138,7 @@ export default class PageLoader {
}: { }: {
href: string href: string
asPath: string asPath: string
ssg: boolean ssg?: boolean
rsc?: boolean rsc?: boolean
locale?: string | false locale?: string | false
}): string { }): string {
...@@ -157,9 +172,7 @@ export default class PageLoader { ...@@ -157,9 +172,7 @@ export default class PageLoader {
* @param {string} route - the route (file-system path) * @param {string} route - the route (file-system path)
*/ */
_isSsg(route: string): Promise<boolean> { _isSsg(route: string): Promise<boolean> {
return this.promisedSsgManifest!.then((s: ClientSsgManifest) => return this.promisedSsgManifest.then((manifest) => manifest.has(route))
s.has(route)
)
} }
loadPage(route: string): Promise<GoodPageCache> { loadPage(route: string): Promise<GoodPageCache> {
......
import { ComponentType } from 'react' import type { ComponentType } from 'react'
import { ClientBuildManifest } from '../build/webpack/plugins/build-manifest-plugin'
import getAssetPathFromRoute from '../shared/lib/router/utils/get-asset-path-from-route' import getAssetPathFromRoute from '../shared/lib/router/utils/get-asset-path-from-route'
import { requestIdleCallback } from './request-idle-callback' import { requestIdleCallback } from './request-idle-callback'
...@@ -11,36 +10,36 @@ const MS_MAX_IDLE_DELAY = 3800 ...@@ -11,36 +10,36 @@ const MS_MAX_IDLE_DELAY = 3800
declare global { declare global {
interface Window { interface Window {
__BUILD_MANIFEST?: ClientBuildManifest __BUILD_MANIFEST?: Record<string, string[]>
__BUILD_MANIFEST_CB?: Function __BUILD_MANIFEST_CB?: Function
__MIDDLEWARE_MANIFEST?: any __MIDDLEWARE_MANIFEST?: [location: string, isSSR: boolean][]
__MIDDLEWARE_MANIFEST_CB?: Function __MIDDLEWARE_MANIFEST_CB?: Function
} }
} }
export interface LoadedEntrypointSuccess { interface LoadedEntrypointSuccess {
component: ComponentType component: ComponentType
exports: any exports: any
} }
export interface LoadedEntrypointFailure { interface LoadedEntrypointFailure {
error: unknown error: unknown
} }
export type RouteEntrypoint = LoadedEntrypointSuccess | LoadedEntrypointFailure type RouteEntrypoint = LoadedEntrypointSuccess | LoadedEntrypointFailure
export interface RouteStyleSheet { interface RouteStyleSheet {
href: string href: string
content: string content: string
} }
export interface LoadedRouteSuccess extends LoadedEntrypointSuccess { interface LoadedRouteSuccess extends LoadedEntrypointSuccess {
styles: RouteStyleSheet[] styles: RouteStyleSheet[]
} }
export interface LoadedRouteFailure { interface LoadedRouteFailure {
error: unknown error: unknown
} }
export type RouteLoaderEntry = LoadedRouteSuccess | LoadedRouteFailure type RouteLoaderEntry = LoadedRouteSuccess | LoadedRouteFailure
export type Future<V> = { interface Future<V> {
resolve: (entrypoint: V) => void resolve: (entrypoint: V) => void
future: Promise<V> future: Promise<V>
} }
...@@ -211,34 +210,35 @@ function resolvePromiseWithTimeout<T>( ...@@ -211,34 +210,35 @@ function resolvePromiseWithTimeout<T>(
// Only cache this response as a last resort if we cannot eliminate all other // Only cache this response as a last resort if we cannot eliminate all other
// code branches that use the Build Manifest Callback and push them through // code branches that use the Build Manifest Callback and push them through
// the Route Loader interface. // the Route Loader interface.
export function getClientBuildManifest(): Promise<ClientBuildManifest> { export function getClientBuildManifest() {
if (self.__BUILD_MANIFEST) { if (self.__BUILD_MANIFEST) {
return Promise.resolve(self.__BUILD_MANIFEST) return Promise.resolve(self.__BUILD_MANIFEST)
} }
const onBuildManifest: Promise<ClientBuildManifest> = const onBuildManifest = new Promise<Record<string, string[]>>((resolve) => {
new Promise<ClientBuildManifest>((resolve) => { // Mandatory because this is not concurrent safe:
// Mandatory because this is not concurrent safe: const cb = self.__BUILD_MANIFEST_CB
const cb = self.__BUILD_MANIFEST_CB self.__BUILD_MANIFEST_CB = () => {
self.__BUILD_MANIFEST_CB = () => { resolve(self.__BUILD_MANIFEST!)
resolve(self.__BUILD_MANIFEST!) cb && cb()
cb && cb() }
} })
})
return resolvePromiseWithTimeout<ClientBuildManifest>( return resolvePromiseWithTimeout(
onBuildManifest, onBuildManifest,
MS_MAX_IDLE_DELAY, MS_MAX_IDLE_DELAY,
markAssetError(new Error('Failed to load client build manifest')) markAssetError(new Error('Failed to load client build manifest'))
) )
} }
export function getMiddlewareManifest(): Promise<any> { export function getMiddlewareManifest() {
if (self.__MIDDLEWARE_MANIFEST) { if (self.__MIDDLEWARE_MANIFEST) {
return Promise.resolve(self.__MIDDLEWARE_MANIFEST) return Promise.resolve(self.__MIDDLEWARE_MANIFEST)
} }
const onMiddlewareManifest: Promise<any> = new Promise<any>((resolve) => { const onMiddlewareManifest = new Promise<
[location: string, isSSR: boolean][]
>((resolve) => {
const cb = self.__MIDDLEWARE_MANIFEST_CB const cb = self.__MIDDLEWARE_MANIFEST_CB
self.__MIDDLEWARE_MANIFEST_CB = () => { self.__MIDDLEWARE_MANIFEST_CB = () => {
resolve(self.__MIDDLEWARE_MANIFEST!) resolve(self.__MIDDLEWARE_MANIFEST!)
......
...@@ -6,7 +6,7 @@ import { ...@@ -6,7 +6,7 @@ import {
AppPropsType, AppPropsType,
NextWebVitalsMetric, NextWebVitalsMetric,
} from '../shared/lib/utils' } from '../shared/lib/utils'
import { Router } from '../client/router' import type { Router } from '../client/router'
export { AppInitialProps } export { AppInitialProps }
......
// tslint:disable:no-console // tslint:disable:no-console
import { ParsedUrlQuery } from 'querystring' import type { ComponentType } from 'react'
import { ComponentType } from 'react' import type { DomainLocale } from '../../../server/config'
import { UrlObject } from 'url' import type { MittEmitter } from '../mitt'
import type { ParsedUrlQuery } from 'querystring'
import type { RouterEvent } from '../../../client/router'
import type { StyleSheetTuple } from '../../../client/page-loader'
import type { UrlObject } from 'url'
import type PageLoader from '../../../client/page-loader'
import { import {
normalizePathTrailingSlash, normalizePathTrailingSlash,
removePathTrailingSlash, removePathTrailingSlash,
} from '../../../client/normalize-trailing-slash' } from '../../../client/normalize-trailing-slash'
import { GoodPageCache, StyleSheetTuple } from '../../../client/page-loader'
import { import {
getClientBuildManifest, getClientBuildManifest,
isAssetError, isAssetError,
markAssetError, markAssetError,
} from '../../../client/route-loader' } from '../../../client/route-loader'
import { RouterEvent } from '../../../client/router'
import isError from '../../../lib/is-error' import isError from '../../../lib/is-error'
import type { DomainLocale } from '../../../server/config'
import { denormalizePagePath } from '../../../server/denormalize-page-path' import { denormalizePagePath } from '../../../server/denormalize-page-path'
import { normalizeLocalePath } from '../i18n/normalize-locale-path' import { normalizeLocalePath } from '../i18n/normalize-locale-path'
import mitt, { MittEmitter } from '../mitt' import mitt from '../mitt'
import { import {
AppContextType, AppContextType,
formatWithValidation, formatWithValidation,
...@@ -612,7 +614,7 @@ export default class Router implements BaseRouter { ...@@ -612,7 +614,7 @@ export default class Router implements BaseRouter {
sub: Subscription sub: Subscription
clc: ComponentLoadCancel clc: ComponentLoadCancel
pageLoader: any pageLoader: PageLoader
_bps: BeforePopStateCallback | undefined _bps: BeforePopStateCallback | undefined
events: MittEmitter<RouterEvent> events: MittEmitter<RouterEvent>
_wrapApp: (App: AppComponent) => any _wrapApp: (App: AppComponent) => any
...@@ -1738,7 +1740,7 @@ export default class Router implements BaseRouter { ...@@ -1738,7 +1740,7 @@ export default class Router implements BaseRouter {
]) ])
} }
async fetchComponent(route: string): Promise<GoodPageCache> { async fetchComponent(route: string) {
let cancelled = false let cancelled = false
const cancel = (this.clc = () => { const cancel = (this.clc = () => {
cancelled = true cancelled = true
...@@ -1819,7 +1821,7 @@ export default class Router implements BaseRouter { ...@@ -1819,7 +1821,7 @@ export default class Router implements BaseRouter {
this.locale this.locale
) )
const fns: [string, boolean][] = await this.pageLoader.getMiddlewareList() const fns = await this.pageLoader.getMiddlewareList()
const requiresPreflight = fns.some(([middleware, isSSR]) => { const requiresPreflight = fns.some(([middleware, isSSR]) => {
return getRouteMatcher(getMiddlewareRegex(middleware, !isSSR))(cleanedAs) return getRouteMatcher(getMiddlewareRegex(middleware, !isSSR))(cleanedAs)
}) })
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment