next-server.ts 53.1 KB
Newer Older
G
Guy Bedford 已提交
1
import compression from 'next/dist/compiled/compression'
J
Joe Haddad 已提交
2
import fs from 'fs'
3
import chalk from 'next/dist/compiled/chalk'
J
Joe Haddad 已提交
4
import { IncomingMessage, ServerResponse } from 'http'
G
Guy Bedford 已提交
5
import Proxy from 'next/dist/compiled/http-proxy'
6
import { join, relative, resolve, sep } from 'path'
7 8 9 10 11
import {
  parse as parseQs,
  stringify as stringifyQs,
  ParsedUrlQuery,
} from 'querystring'
12
import { format as formatUrl, parse as parseUrl, UrlWithParsedQuery } from 'url'
13
import { PrerenderManifest } from '../../build'
J
Joe Haddad 已提交
14 15 16 17 18 19
import {
  getRedirectStatus,
  Header,
  Redirect,
  Rewrite,
  RouteType,
20 21
  CustomRoutes,
} from '../../lib/load-custom-routes'
J
JJ Kasper 已提交
22
import { withCoalescedInvoke } from '../../lib/coalesced-function'
J
Joe Haddad 已提交
23 24
import {
  BUILD_ID_FILE,
25
  CLIENT_PUBLIC_FILES_PATH,
J
Joe Haddad 已提交
26 27
  CLIENT_STATIC_FILES_PATH,
  CLIENT_STATIC_FILES_RUNTIME,
28
  PAGES_MANIFEST,
J
Joe Haddad 已提交
29
  PHASE_PRODUCTION_SERVER,
J
Joe Haddad 已提交
30
  PRERENDER_MANIFEST,
31
  ROUTES_MANIFEST,
32
  SERVERLESS_DIRECTORY,
J
Joe Haddad 已提交
33
  SERVER_DIRECTORY,
T
Tim Neutkens 已提交
34
} from '../lib/constants'
J
Joe Haddad 已提交
35 36 37 38
import {
  getRouteMatcher,
  getRouteRegex,
  getSortedRoutes,
39
  isDynamicRoute,
J
Joe Haddad 已提交
40
} from '../lib/router/utils'
41
import * as envConfig from '../lib/runtime-config'
J
Joe Haddad 已提交
42
import { isResSent, NextApiRequest, NextApiResponse } from '../lib/utils'
43 44 45 46 47 48 49
import {
  apiResolver,
  setLazyProp,
  getCookieParser,
  tryGetPreviewData,
  __ApiPreviewProps,
} from './api-utils'
50
import loadConfig, { isTargetLikeServerless } from './config'
51
import pathMatch from '../lib/router/utils/path-match'
J
Joe Haddad 已提交
52
import { recursiveReadDirSync } from './lib/recursive-readdir-sync'
53
import { loadComponents, LoadComponentsReturnType } from './load-components'
J
Joe Haddad 已提交
54
import { normalizePagePath } from './normalize-page-path'
55
import { RenderOpts, RenderOptsPartial, renderToHTML } from './render'
P
Prateek Bhatnagar 已提交
56
import { getPagePath, requireFontManifest } from './require'
57 58 59
import Router, {
  DynamicRoutes,
  PageChecker,
J
Joe Haddad 已提交
60 61 62
  Params,
  route,
  Route,
63
} from './router'
64
import prepareDestination from '../lib/router/utils/prepare-destination'
65
import { sendPayload } from './send-payload'
J
Joe Haddad 已提交
66
import { serveStatic } from './serve-static'
67
import { IncrementalCache } from './incremental-cache'
68
import { execOnce } from '../lib/utils'
69
import { isBlockedPage } from './utils'
70
import { compile as compilePathToRegex } from 'next/dist/compiled/path-to-regexp'
71
import { loadEnvConfig } from '@next/env'
72
import './node-polyfill-fetch'
J
Jan Potoms 已提交
73
import { PagesManifest } from '../../build/webpack/plugins/pages-manifest-plugin'
74
import { removePathTrailingSlash } from '../../client/normalize-trailing-slash'
75
import getRouteFromAssetPath from '../lib/router/utils/get-route-from-asset-path'
P
Prateek Bhatnagar 已提交
76
import { FontManifest } from './font-utils'
77
import { denormalizePagePath } from './denormalize-page-path'
78 79 80
import accept from '@hapi/accept'
import { normalizeLocalePath } from '../lib/i18n/normalize-locale-path'
import { detectLocaleCookie } from '../lib/i18n/detect-locale-cookie'
81
import * as Log from '../../build/output/log'
S
Steven 已提交
82
import { imageOptimizer } from './image-optimizer'
83
import { detectDomainLocale } from '../lib/i18n/detect-domain-locale'
84
import cookie from 'next/dist/compiled/cookie'
J
JJ Kasper 已提交
85 86

const getCustomRouteMatcher = pathMatch(true)
87 88 89

type NextConfig = any

90 91 92 93 94 95
type Middleware = (
  req: IncomingMessage,
  res: ServerResponse,
  next: (err?: Error) => void
) => void

96 97 98 99 100
type FindComponentsResult = {
  components: LoadComponentsReturnType
  query: ParsedUrlQuery
}

T
Tim Neutkens 已提交
101
export type ServerConstructor = {
102 103 104
  /**
   * Where the Next project is located - @default '.'
   */
J
Joe Haddad 已提交
105
  dir?: string
106 107 108
  /**
   * Hide error messages containing server information - @default false
   */
J
Joe Haddad 已提交
109
  quiet?: boolean
110 111 112
  /**
   * Object what you would use in next.config.js - @default {}
   */
113
  conf?: NextConfig
J
JJ Kasper 已提交
114
  dev?: boolean
115
  customServer?: boolean
116
}
117

N
nkzawa 已提交
118
export default class Server {
119 120 121 122
  dir: string
  quiet: boolean
  nextConfig: NextConfig
  distDir: string
123
  pagesDir?: string
124
  publicDir: string
125
  hasStaticDir: boolean
126
  serverBuildDir: string
J
Jan Potoms 已提交
127
  pagesManifest?: PagesManifest
128 129
  buildId: string
  renderOpts: {
T
Tim Neutkens 已提交
130
    poweredByHeader: boolean
J
Joe Haddad 已提交
131 132 133
    buildId: string
    generateEtags: boolean
    runtimeConfig?: { [key: string]: any }
134 135 136
    assetPrefix?: string
    canonicalBase: string
    dev?: boolean
137
    previewProps: __ApiPreviewProps
138
    customServer?: boolean
139
    ampOptimizerConfig?: { [key: string]: any }
140
    basePath: string
P
Prateek Bhatnagar 已提交
141
    optimizeFonts: boolean
A
Alex Castle 已提交
142
    images: string
P
Prateek Bhatnagar 已提交
143
    fontManifest: FontManifest
144
    optimizeImages: boolean
145 146
    locale?: string
    locales?: string[]
147
    defaultLocale?: string
148
  }
149
  private compression?: Middleware
J
JJ Kasper 已提交
150
  private onErrorMiddleware?: ({ err }: { err: Error }) => Promise<void>
151
  private incrementalCache: IncrementalCache
152
  router: Router
153
  protected dynamicRoutes?: DynamicRoutes
154
  protected customRoutes: CustomRoutes
155

J
Joe Haddad 已提交
156 157 158 159
  public constructor({
    dir = '.',
    quiet = false,
    conf = null,
J
JJ Kasper 已提交
160
    dev = false,
161
    customServer = true,
J
Joe Haddad 已提交
162
  }: ServerConstructor = {}) {
N
nkzawa 已提交
163
    this.dir = resolve(dir)
N
Naoyuki Kanezawa 已提交
164
    this.quiet = quiet
T
Tim Neutkens 已提交
165
    const phase = this.currentPhase()
166
    loadEnvConfig(this.dir, dev, Log)
167

168
    this.nextConfig = loadConfig(phase, this.dir, conf)
169
    this.distDir = join(this.dir, this.nextConfig.distDir)
170
    this.publicDir = join(this.dir, CLIENT_PUBLIC_FILES_PATH)
171
    this.hasStaticDir = fs.existsSync(join(this.dir, 'static'))
T
Tim Neutkens 已提交
172

173 174
    // Only serverRuntimeConfig needs the default
    // publicRuntimeConfig gets it's default in client/index.js
J
Joe Haddad 已提交
175 176 177 178 179
    const {
      serverRuntimeConfig = {},
      publicRuntimeConfig,
      assetPrefix,
      generateEtags,
180
      compress,
J
Joe Haddad 已提交
181
    } = this.nextConfig
182

T
Tim Neutkens 已提交
183
    this.buildId = this.readBuildId()
184

185
    this.renderOpts = {
T
Tim Neutkens 已提交
186
      poweredByHeader: this.nextConfig.poweredByHeader,
187
      canonicalBase: this.nextConfig.amp.canonicalBase,
188
      buildId: this.buildId,
189
      generateEtags,
190
      previewProps: this.getPreviewProps(),
191
      customServer: customServer === true ? true : undefined,
192
      ampOptimizerConfig: this.nextConfig.experimental.amp?.optimizer,
193
      basePath: this.nextConfig.basePath,
A
Alex Castle 已提交
194
      images: JSON.stringify(this.nextConfig.images),
195 196 197 198 199
      optimizeFonts: this.nextConfig.experimental.optimizeFonts && !dev,
      fontManifest:
        this.nextConfig.experimental.optimizeFonts && !dev
          ? requireFontManifest(this.distDir, this._isLikeServerless)
          : null,
200
      optimizeImages: this.nextConfig.experimental.optimizeImages,
201
      defaultLocale: this.nextConfig.experimental.i18n?.defaultLocale,
202
    }
N
Naoyuki Kanezawa 已提交
203

204 205
    // Only the `publicRuntimeConfig` key is exposed to the client side
    // It'll be rendered as part of __NEXT_DATA__ on the client side
206
    if (Object.keys(publicRuntimeConfig).length > 0) {
207
      this.renderOpts.runtimeConfig = publicRuntimeConfig
208 209
    }

210
    if (compress && this.nextConfig.target === 'server') {
211 212 213
      this.compression = compression() as Middleware
    }

214
    // Initialize next/config with the environment configuration
215 216 217 218
    envConfig.setConfig({
      serverRuntimeConfig,
      publicRuntimeConfig,
    })
219

220 221 222 223 224 225 226 227 228 229
    this.serverBuildDir = join(
      this.distDir,
      this._isLikeServerless ? SERVERLESS_DIRECTORY : SERVER_DIRECTORY
    )
    const pagesManifestPath = join(this.serverBuildDir, PAGES_MANIFEST)

    if (!dev) {
      this.pagesManifest = require(pagesManifestPath)
    }

230
    this.customRoutes = this.getCustomRoutes()
J
JJ Kasper 已提交
231
    this.router = new Router(this.generateRoutes())
232
    this.setAssetPrefix(assetPrefix)
J
JJ Kasper 已提交
233

234 235 236
    // call init-server middleware, this is also handled
    // individually in serverless bundles when deployed
    if (!dev && this.nextConfig.experimental.plugins) {
237 238
      const initServer = require(join(this.serverBuildDir, 'init-server.js'))
        .default
239
      this.onErrorMiddleware = require(join(
240
        this.serverBuildDir,
241 242 243 244 245
        'on-error-server.js'
      )).default
      initServer()
    }

246
    this.incrementalCache = new IncrementalCache({
J
JJ Kasper 已提交
247 248 249 250
      dev,
      distDir: this.distDir,
      pagesDir: join(
        this.distDir,
251
        this._isLikeServerless ? SERVERLESS_DIRECTORY : SERVER_DIRECTORY,
J
JJ Kasper 已提交
252 253 254 255
        'pages'
      ),
      flushToDisk: this.nextConfig.experimental.sprFlushToDisk,
    })
P
Prateek Bhatnagar 已提交
256 257 258 259 260 261 262 263 264 265

    /**
     * This sets environment variable to be used at the time of SSR by head.tsx.
     * Using this from process.env allows targetting both serverless and SSR by calling
     * `process.env.__NEXT_OPTIMIZE_FONTS`.
     * TODO(prateekbh@): Remove this when experimental.optimizeFonts are being clened up.
     */
    if (this.renderOpts.optimizeFonts) {
      process.env.__NEXT_OPTIMIZE_FONTS = JSON.stringify(true)
    }
266 267 268
    if (this.renderOpts.optimizeImages) {
      process.env.__NEXT_OPTIMIZE_IMAGES = JSON.stringify(true)
    }
N
Naoyuki Kanezawa 已提交
269
  }
N
nkzawa 已提交
270

271
  protected currentPhase(): string {
272
    return PHASE_PRODUCTION_SERVER
273 274
  }

S
Steven 已提交
275
  public logError(err: Error): void {
276 277 278
    if (this.onErrorMiddleware) {
      this.onErrorMiddleware({ err })
    }
279
    if (this.quiet) return
280
    console.error(err)
281 282
  }

283
  private async handleRequest(
J
Joe Haddad 已提交
284 285
    req: IncomingMessage,
    res: ServerResponse,
286
    parsedUrl?: UrlWithParsedQuery
J
Joe Haddad 已提交
287
  ): Promise<void> {
288 289
    setLazyProp({ req: req as any }, 'cookies', getCookieParser(req))

290
    // Parse url if parsedUrl not provided
291
    if (!parsedUrl || typeof parsedUrl !== 'object') {
292 293
      const url: any = req.url
      parsedUrl = parseUrl(url, true)
294
    }
295

296 297 298
    // Parse the querystring ourselves if the user doesn't handle querystring parsing
    if (typeof parsedUrl.query === 'string') {
      parsedUrl.query = parseQs(parsedUrl.query)
N
Naoyuki Kanezawa 已提交
299
    }
300

301
    const { basePath } = this.nextConfig
302
    const { i18n } = this.nextConfig.experimental
303

304 305 306 307 308
    if (basePath && req.url?.startsWith(basePath)) {
      // store original URL to allow checking if basePath was
      // provided or not
      ;(req as any)._nextHadBasePath = true
      req.url = req.url!.replace(basePath, '') || '/'
T
Tim Neutkens 已提交
309 310
    }

311
    if (i18n && !parsedUrl.pathname?.startsWith('/_next')) {
312 313
      // get pathname from URL with basePath stripped for locale detection
      const { pathname, ...parsed } = parseUrl(req.url || '/')
314
      let defaultLocale = i18n.defaultLocale
315
      let detectedLocale = detectLocaleCookie(req, i18n.locales)
316 317 318 319
      let acceptPreferredLocale = accept.language(
        req.headers['accept-language'],
        i18n.locales
      )
320

321 322 323 324 325
      const { host } = req?.headers || {}
      // remove port from host and remove port if present
      const hostname = host?.split(':')[0].toLowerCase()

      const detectedDomain = detectDomainLocale(i18n.domains, hostname)
326 327 328 329
      if (detectedDomain) {
        defaultLocale = detectedDomain.defaultLocale
        detectedLocale = defaultLocale
      }
330

331 332
      // if not domain specific locale use accept-language preferred
      detectedLocale = detectedLocale || acceptPreferredLocale
333

334 335 336 337 338 339 340 341 342
      let localeDomainRedirect: string | undefined
      const localePathResult = normalizeLocalePath(pathname!, i18n.locales)

      if (localePathResult.detectedLocale) {
        detectedLocale = localePathResult.detectedLocale
        req.url = formatUrl({
          ...parsed,
          pathname: localePathResult.pathname,
        })
J
JJ Kasper 已提交
343
        ;(req as any).__nextStrippedLocale = true
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
        parsedUrl.pathname = localePathResult.pathname

        // check if the locale prefix matches a domain's defaultLocale
        // and we're on a locale specific domain if so redirect to that domain
        if (detectedDomain) {
          const matchedDomain = detectDomainLocale(
            i18n.domains,
            undefined,
            detectedLocale
          )

          if (matchedDomain) {
            localeDomainRedirect = `http${matchedDomain.http ? '' : 's'}://${
              matchedDomain?.domain
            }`
          }
        }
      }

363
      const denormalizedPagePath = denormalizePagePath(pathname || '/')
364
      const detectedDefaultLocale =
365 366
        !detectedLocale ||
        detectedLocale.toLowerCase() === defaultLocale.toLowerCase()
367
      const shouldStripDefaultLocale =
368
        detectedDefaultLocale &&
369 370
        denormalizedPagePath.toLowerCase() ===
          `/${i18n.defaultLocale.toLowerCase()}`
371

372 373
      const shouldAddLocalePrefix =
        !detectedDefaultLocale && denormalizedPagePath === '/'
374

375
      detectedLocale = detectedLocale || i18n.defaultLocale
376

377 378
      if (
        i18n.localeDetection !== false &&
379 380 381
        (localeDomainRedirect ||
          shouldAddLocalePrefix ||
          shouldStripDefaultLocale)
382
      ) {
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
        // set the NEXT_LOCALE cookie when a user visits the default locale
        // with the locale prefix so that they aren't redirected back to
        // their accept-language preferred locale
        if (
          shouldStripDefaultLocale &&
          acceptPreferredLocale !== defaultLocale
        ) {
          const previous = res.getHeader('set-cookie')

          res.setHeader('set-cookie', [
            ...(typeof previous === 'string'
              ? [previous]
              : Array.isArray(previous)
              ? previous
              : []),
            cookie.serialize('NEXT_LOCALE', defaultLocale, {
              httpOnly: true,
              path: '/',
            }),
          ])
        }

405 406 407 408 409
        res.setHeader(
          'Location',
          formatUrl({
            // make sure to include any query values when redirecting
            ...parsed,
410 411 412 413 414
            pathname: localeDomainRedirect
              ? localeDomainRedirect
              : shouldStripDefaultLocale
              ? '/'
              : `/${detectedLocale}`,
415 416 417 418
          })
        )
        res.statusCode = 307
        res.end()
419
        return
420
      }
421
      parsedUrl.query.__nextLocale = detectedLocale || defaultLocale
422 423
    }

424
    res.statusCode = 200
425 426 427
    try {
      return await this.run(req, res, parsedUrl)
    } catch (err) {
J
Joe Haddad 已提交
428 429 430
      this.logError(err)
      res.statusCode = 500
      res.end('Internal Server Error')
431
    }
432 433
  }

434
  public getRequestHandler() {
435
    return this.handleRequest.bind(this)
N
nkzawa 已提交
436 437
  }

438
  public setAssetPrefix(prefix?: string): void {
439
    this.renderOpts.assetPrefix = prefix ? prefix.replace(/\/$/, '') : ''
440 441
  }

442
  // Backwards compatibility
443
  public async prepare(): Promise<void> {}
N
nkzawa 已提交
444

T
Tim Neutkens 已提交
445
  // Backwards compatibility
446
  protected async close(): Promise<void> {}
T
Tim Neutkens 已提交
447

448
  protected setImmutableAssetCacheControl(res: ServerResponse): void {
T
Tim Neutkens 已提交
449
    res.setHeader('Cache-Control', 'public, max-age=31536000, immutable')
N
nkzawa 已提交
450 451
  }

452
  protected getCustomRoutes(): CustomRoutes {
J
JJ Kasper 已提交
453 454 455
    return require(join(this.distDir, ROUTES_MANIFEST))
  }

456 457 458 459
  private _cachedPreviewManifest: PrerenderManifest | undefined
  protected getPrerenderManifest(): PrerenderManifest {
    if (this._cachedPreviewManifest) {
      return this._cachedPreviewManifest
J
Joe Haddad 已提交
460
    }
461 462 463 464 465 466
    const manifest = require(join(this.distDir, PRERENDER_MANIFEST))
    return (this._cachedPreviewManifest = manifest)
  }

  protected getPreviewProps(): __ApiPreviewProps {
    return this.getPrerenderManifest().preview
J
Joe Haddad 已提交
467 468
  }

469
  protected generateRoutes(): {
470
    basePath: string
471 472
    headers: Route[]
    rewrites: Route[]
473
    fsRoutes: Route[]
474
    redirects: Route[]
475 476
    catchAllRoute: Route
    pageChecker: PageChecker
477
    useFileSystemPublicRoutes: boolean
478 479
    dynamicRoutes: DynamicRoutes | undefined
  } {
S
Steven 已提交
480
    const server: Server = this
481 482 483
    const publicRoutes = fs.existsSync(this.publicDir)
      ? this.generatePublicRoutes()
      : []
J
JJ Kasper 已提交
484

485
    const staticFilesRoute = this.hasStaticDir
486 487 488 489 490
      ? [
          {
            // It's very important to keep this route's param optional.
            // (but it should support as many params as needed, separated by '/')
            // Otherwise this will lead to a pretty simple DOS attack.
491
            // See more: https://github.com/vercel/next.js/issues/2617
492
            match: route('/static/:path*'),
493
            name: 'static catchall',
494
            fn: async (req, res, params, parsedUrl) => {
495
              const p = join(this.dir, 'static', ...params.path)
496
              await this.serveStatic(req, res, p, parsedUrl)
497 498 499
              return {
                finished: true,
              }
500 501 502 503
            },
          } as Route,
        ]
      : []
504

505
    const fsRoutes: Route[] = [
T
Tim Neutkens 已提交
506
      {
507
        match: route('/_next/static/:path*'),
508 509
        type: 'route',
        name: '_next/static catchall',
510
        fn: async (req, res, params, parsedUrl) => {
511
          // make sure to 404 for /_next/static itself
512 513 514 515 516 517
          if (!params.path) {
            await this.render404(req, res, parsedUrl)
            return {
              finished: true,
            }
          }
518

J
Joe Haddad 已提交
519 520 521
          if (
            params.path[0] === CLIENT_STATIC_FILES_RUNTIME ||
            params.path[0] === 'chunks' ||
522 523
            params.path[0] === 'css' ||
            params.path[0] === 'media' ||
524
            params.path[0] === this.buildId ||
525
            params.path[0] === 'pages' ||
526
            params.path[1] === 'pages'
J
Joe Haddad 已提交
527
          ) {
T
Tim Neutkens 已提交
528
            this.setImmutableAssetCacheControl(res)
529
          }
J
Joe Haddad 已提交
530 531 532
          const p = join(
            this.distDir,
            CLIENT_STATIC_FILES_PATH,
533
            ...(params.path || [])
J
Joe Haddad 已提交
534
          )
535
          await this.serveStatic(req, res, p, parsedUrl)
536 537 538
          return {
            finished: true,
          }
539
        },
540
      },
J
JJ Kasper 已提交
541 542
      {
        match: route('/_next/data/:path*'),
543 544
        type: 'route',
        name: '_next/data catchall',
J
JJ Kasper 已提交
545
        fn: async (req, res, params, _parsedUrl) => {
J
JJ Kasper 已提交
546 547 548
          // Make sure to 404 for /_next/data/ itself and
          // we also want to 404 if the buildId isn't correct
          if (!params.path || params.path[0] !== this.buildId) {
549 550 551 552
            await this.render404(req, res, _parsedUrl)
            return {
              finished: true,
            }
J
JJ Kasper 已提交
553 554 555 556 557 558
          }
          // remove buildId from URL
          params.path.shift()

          // show 404 if it doesn't end with .json
          if (!params.path[params.path.length - 1].endsWith('.json')) {
559 560 561 562
            await this.render404(req, res, _parsedUrl)
            return {
              finished: true,
            }
J
JJ Kasper 已提交
563 564 565
          }

          // re-create page's pathname
566 567
          let pathname = `/${params.path.join('/')}`

568 569 570
          const { i18n } = this.nextConfig.experimental

          if (i18n) {
571 572 573
            const { host } = req?.headers || {}
            // remove port from host and remove port if present
            const hostname = host?.split(':')[0].toLowerCase()
574
            const localePathResult = normalizeLocalePath(pathname, i18n.locales)
575
            const { defaultLocale } =
576
              detectDomainLocale(i18n.domains, hostname) || {}
577
            let detectedLocale = defaultLocale
578 579 580 581 582

            if (localePathResult.detectedLocale) {
              pathname = localePathResult.pathname
              detectedLocale = localePathResult.detectedLocale
            }
583
            _parsedUrl.query.__nextLocale = detectedLocale!
584 585
          }
          pathname = getRouteFromAssetPath(pathname, '.json')
J
JJ Kasper 已提交
586

J
JJ Kasper 已提交
587
          const parsedUrl = parseUrl(pathname, true)
588

J
JJ Kasper 已提交
589 590 591 592
          await this.render(
            req,
            res,
            pathname,
593
            { ..._parsedUrl.query, _nextDataReq: '1' },
J
JJ Kasper 已提交
594 595
            parsedUrl
          )
596 597 598
          return {
            finished: true,
          }
J
JJ Kasper 已提交
599 600
        },
      },
S
Steven 已提交
601 602 603 604 605 606 607
      {
        match: route('/_next/image'),
        type: 'route',
        name: '_next/image catchall',
        fn: (req, res, _params, parsedUrl) =>
          imageOptimizer(server, req, res, parsedUrl),
      },
T
Tim Neutkens 已提交
608
      {
609
        match: route('/_next/:path*'),
610 611
        type: 'route',
        name: '_next catchall',
T
Tim Neutkens 已提交
612
        // This path is needed because `render()` does a check for `/_next` and the calls the routing again
613
        fn: async (req, res, _params, parsedUrl) => {
T
Tim Neutkens 已提交
614
          await this.render404(req, res, parsedUrl)
615 616 617
          return {
            finished: true,
          }
L
Lukáš Huvar 已提交
618 619
        },
      },
620 621
      ...publicRoutes,
      ...staticFilesRoute,
T
Tim Neutkens 已提交
622
    ]
623

624 625 626 627 628 629
    const getCustomRouteBasePath = (r: { basePath?: false }) => {
      return r.basePath !== false && this.renderOpts.dev
        ? this.nextConfig.basePath
        : ''
    }

630 631 632 633
    const getCustomRoute = (r: Rewrite | Redirect | Header, type: RouteType) =>
      ({
        ...r,
        type,
634
        match: getCustomRouteMatcher(`${getCustomRouteBasePath(r)}${r.source}`),
635 636 637 638 639 640 641
        name: type,
        fn: async (_req, _res, _params, _parsedUrl) => ({ finished: false }),
      } as Route & Rewrite & Header)

    const updateHeaderValue = (value: string, params: Params): string => {
      if (!value.includes(':')) {
        return value
642
      }
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663

      for (const key of Object.keys(params)) {
        if (value.includes(`:${key}`)) {
          value = value
            .replace(
              new RegExp(`:${key}\\*`, 'g'),
              `:${key}--ESCAPED_PARAM_ASTERISKS`
            )
            .replace(
              new RegExp(`:${key}\\?`, 'g'),
              `:${key}--ESCAPED_PARAM_QUESTION`
            )
            .replace(
              new RegExp(`:${key}\\+`, 'g'),
              `:${key}--ESCAPED_PARAM_PLUS`
            )
            .replace(
              new RegExp(`:${key}(?!\\w)`, 'g'),
              `--ESCAPED_PARAM_COLON${key}`
            )
        }
664
      }
665 666 667 668 669 670 671 672 673 674 675 676
      value = value
        .replace(/(:|\*|\?|\+|\(|\)|\{|\})/g, '\\$1')
        .replace(/--ESCAPED_PARAM_PLUS/g, '+')
        .replace(/--ESCAPED_PARAM_COLON/g, ':')
        .replace(/--ESCAPED_PARAM_QUESTION/g, '?')
        .replace(/--ESCAPED_PARAM_ASTERISKS/g, '*')

      // the value needs to start with a forward-slash to be compiled
      // correctly
      return compilePathToRegex(`/${value}`, { validate: false })(
        params
      ).substr(1)
677
    }
678

679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
    // Headers come very first
    const headers = this.customRoutes.headers.map((r) => {
      const headerRoute = getCustomRoute(r, 'header')
      return {
        match: headerRoute.match,
        type: headerRoute.type,
        name: `${headerRoute.type} ${headerRoute.source} header route`,
        fn: async (_req, res, params, _parsedUrl) => {
          const hasParams = Object.keys(params).length > 0

          for (const header of (headerRoute as Header).headers) {
            let { key, value } = header
            if (hasParams) {
              key = updateHeaderValue(key, params)
              value = updateHeaderValue(value, params)
694
            }
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
            res.setHeader(key, value)
          }
          return { finished: false }
        },
      } as Route
    })

    const redirects = this.customRoutes.redirects.map((redirect) => {
      const redirectRoute = getCustomRoute(redirect, 'redirect')
      return {
        type: redirectRoute.type,
        match: redirectRoute.match,
        statusCode: redirectRoute.statusCode,
        name: `Redirect route`,
        fn: async (_req, res, params, parsedUrl) => {
          const { parsedDestination } = prepareDestination(
            redirectRoute.destination,
            params,
713 714 715
            parsedUrl.query,
            false,
            getCustomRouteBasePath(redirectRoute)
716
          )
717 718

          const { query } = parsedDestination
719
          delete (parsedDestination as any).query
720 721 722 723 724

          parsedDestination.search = stringifyQs(query, undefined, undefined, {
            encodeURIComponent: (str: string) => str,
          } as any)

725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
          const updatedDestination = formatUrl(parsedDestination)

          res.setHeader('Location', updatedDestination)
          res.statusCode = getRedirectStatus(redirectRoute as Redirect)

          // Since IE11 doesn't support the 308 header add backwards
          // compatibility using refresh header
          if (res.statusCode === 308) {
            res.setHeader('Refresh', `0;url=${updatedDestination}`)
          }

          res.end()
          return {
            finished: true,
          }
        },
      } as Route
    })

    const rewrites = this.customRoutes.rewrites.map((rewrite) => {
      const rewriteRoute = getCustomRoute(rewrite, 'rewrite')
      return {
747
        ...rewriteRoute,
748 749 750 751 752 753 754 755 756
        check: true,
        type: rewriteRoute.type,
        name: `Rewrite route`,
        match: rewriteRoute.match,
        fn: async (req, res, params, parsedUrl) => {
          const { newUrl, parsedDestination } = prepareDestination(
            rewriteRoute.destination,
            params,
            parsedUrl.query,
757 758
            true,
            getCustomRouteBasePath(rewriteRoute)
759
          )
760

761 762
          // external rewrite, proxy it
          if (parsedDestination.protocol) {
763
            const { query } = parsedDestination
764
            delete (parsedDestination as any).query
765 766 767 768 769 770 771
            parsedDestination.search = stringifyQs(
              query,
              undefined,
              undefined,
              { encodeURIComponent: (str) => str }
            )

772 773 774 775 776 777 778 779 780 781 782
            const target = formatUrl(parsedDestination)
            const proxy = new Proxy({
              target,
              changeOrigin: true,
              ignorePath: true,
            })
            proxy.web(req, res)

            proxy.on('error', (err: Error) => {
              console.error(`Error occurred proxying ${target}`, err)
            })
783 784 785
            return {
              finished: true,
            }
786 787
          }
          ;(req as any)._nextRewroteUrl = newUrl
788 789
          ;(req as any)._nextDidRewrite =
            (req as any)._nextRewroteUrl !== req.url
790

791 792 793 794 795 796 797 798
          return {
            finished: false,
            pathname: newUrl,
            query: parsedDestination.query,
          }
        },
      } as Route
    })
799 800 801 802 803 804

    const catchAllRoute: Route = {
      match: route('/:path*'),
      type: 'route',
      name: 'Catchall render',
      fn: async (req, res, params, parsedUrl) => {
J
Jan Potoms 已提交
805
        let { pathname, query } = parsedUrl
806 807 808 809
        if (!pathname) {
          throw new Error('pathname is undefined')
        }

J
Jan Potoms 已提交
810
        // next.js core assumes page path without trailing slash
811
        pathname = removePathTrailingSlash(pathname)
J
Jan Potoms 已提交
812

813
        if (params?.path?.[0] === 'api') {
814 815 816
          const handled = await this.handleApiRequest(
            req as NextApiRequest,
            res as NextApiResponse,
817
            pathname,
818
            query
819 820 821 822 823 824 825
          )
          if (handled) {
            return { finished: true }
          }
        }

        await this.render(req, res, pathname, query, parsedUrl)
826 827 828 829
        return {
          finished: true,
        }
      },
830
    }
831

832
    const { useFileSystemPublicRoutes } = this.nextConfig
J
Joe Haddad 已提交
833

834 835
    if (useFileSystemPublicRoutes) {
      this.dynamicRoutes = this.getDynamicRoutes()
836
    }
N
nkzawa 已提交
837

838
    return {
839
      headers,
840
      fsRoutes,
841 842
      rewrites,
      redirects,
843
      catchAllRoute,
844
      useFileSystemPublicRoutes,
845
      dynamicRoutes: this.dynamicRoutes,
846
      basePath: this.nextConfig.basePath,
847 848
      pageChecker: this.hasPage.bind(this),
    }
T
Tim Neutkens 已提交
849 850
  }

851
  private async getPagePath(pathname: string): Promise<string> {
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
    return getPagePath(
      pathname,
      this.distDir,
      this._isLikeServerless,
      this.renderOpts.dev
    )
  }

  protected async hasPage(pathname: string): Promise<boolean> {
    let found = false
    try {
      found = !!(await this.getPagePath(pathname))
    } catch (_) {}

    return found
  }

869 870 871 872 873
  protected async _beforeCatchAllRender(
    _req: IncomingMessage,
    _res: ServerResponse,
    _params: Params,
    _parsedUrl: UrlWithParsedQuery
874
  ): Promise<boolean> {
875 876 877
    return false
  }

878
  // Used to build API page in development
T
Tim Neutkens 已提交
879
  protected async ensureApiPage(_pathname: string): Promise<void> {}
880

L
Lukáš Huvar 已提交
881 882 883 884 885 886
  /**
   * Resolves `API` request, in development builds on demand
   * @param req http request
   * @param res http response
   * @param pathname path of request
   */
J
Joe Haddad 已提交
887
  private async handleApiRequest(
888 889
    req: IncomingMessage,
    res: ServerResponse,
890 891
    pathname: string,
    query: ParsedUrlQuery
892
  ): Promise<boolean> {
893
    let page = pathname
L
Lukáš Huvar 已提交
894
    let params: Params | boolean = false
895
    let pageFound = await this.hasPage(page)
J
JJ Kasper 已提交
896

897
    if (!pageFound && this.dynamicRoutes) {
L
Lukáš Huvar 已提交
898 899
      for (const dynamicRoute of this.dynamicRoutes) {
        params = dynamicRoute.match(pathname)
900
        if (dynamicRoute.page.startsWith('/api') && params) {
901 902
          page = dynamicRoute.page
          pageFound = true
L
Lukáš Huvar 已提交
903 904 905 906 907
          break
        }
      }
    }

908
    if (!pageFound) {
909
      return false
J
JJ Kasper 已提交
910
    }
911 912 913 914
    // Make sure the page is built before getting the path
    // or else it won't be in the manifest yet
    await this.ensureApiPage(page)

915 916 917 918 919 920 921 922 923 924
    let builtPagePath
    try {
      builtPagePath = await this.getPagePath(page)
    } catch (err) {
      if (err.code === 'ENOENT') {
        return false
      }
      throw err
    }

925
    const pageModule = await require(builtPagePath)
926
    query = { ...query, ...params }
J
JJ Kasper 已提交
927

928
    if (!this.renderOpts.dev && this._isLikeServerless) {
929
      if (typeof pageModule.default === 'function') {
930
        prepareServerlessUrl(req, query)
931 932
        await pageModule.default(req, res)
        return true
J
JJ Kasper 已提交
933 934 935
      }
    }

J
Joe Haddad 已提交
936 937 938 939 940
    await apiResolver(
      req,
      res,
      query,
      pageModule,
941
      this.renderOpts.previewProps,
942
      false,
J
Joe Haddad 已提交
943 944
      this.onErrorMiddleware
    )
945
    return true
L
Lukáš Huvar 已提交
946 947
  }

948
  protected generatePublicRoutes(): Route[] {
949
    const publicFiles = new Set(
950 951 952
      recursiveReadDirSync(this.publicDir).map((p) =>
        encodeURI(p.replace(/\\/g, '/'))
      )
953 954 955 956 957 958 959
    )

    return [
      {
        match: route('/:path*'),
        name: 'public folder catchall',
        fn: async (req, res, params, parsedUrl) => {
960
          const pathParts: string[] = params.path || []
961 962 963 964 965 966 967 968
          const { basePath } = this.nextConfig

          // if basePath is defined require it be present
          if (basePath) {
            if (pathParts[0] !== basePath.substr(1)) return { finished: false }
            pathParts.shift()
          }

969
          const path = `/${pathParts.join('/')}`
970 971 972 973 974

          if (publicFiles.has(path)) {
            await this.serveStatic(
              req,
              res,
975
              join(this.publicDir, ...pathParts),
976 977
              parsedUrl
            )
978 979 980
            return {
              finished: true,
            }
981 982 983 984 985 986 987
          }
          return {
            finished: false,
          }
        },
      } as Route,
    ]
988 989
  }

990
  protected getDynamicRoutes() {
991 992
    return getSortedRoutes(Object.keys(this.pagesManifest!))
      .filter(isDynamicRoute)
J
Joe Haddad 已提交
993
      .map((page) => ({
994 995 996
        page,
        match: getRouteMatcher(getRouteRegex(page)),
      }))
J
Joe Haddad 已提交
997 998
  }

999
  private handleCompression(req: IncomingMessage, res: ServerResponse): void {
1000 1001 1002 1003 1004
    if (this.compression) {
      this.compression(req, res, () => {})
    }
  }

1005
  protected async run(
J
Joe Haddad 已提交
1006 1007
    req: IncomingMessage,
    res: ServerResponse,
1008
    parsedUrl: UrlWithParsedQuery
1009
  ): Promise<void> {
1010 1011
    this.handleCompression(req, res)

1012
    try {
1013 1014
      const matched = await this.router.execute(req, res, parsedUrl)
      if (matched) {
1015 1016 1017 1018 1019 1020 1021 1022
        return
      }
    } catch (err) {
      if (err.code === 'DECODE_FAILED') {
        res.statusCode = 400
        return this.renderError(null, req, res, '/_error', {})
      }
      throw err
1023 1024
    }

1025
    await this.render404(req, res, parsedUrl)
N
nkzawa 已提交
1026 1027
  }

1028
  protected async sendHTML(
J
Joe Haddad 已提交
1029 1030
    req: IncomingMessage,
    res: ServerResponse,
1031
    html: string
1032
  ): Promise<void> {
T
Tim Neutkens 已提交
1033
    const { generateEtags, poweredByHeader } = this.renderOpts
1034 1035 1036 1037
    return sendPayload(req, res, html, 'html', {
      generateEtags,
      poweredByHeader,
    })
1038 1039
  }

J
Joe Haddad 已提交
1040 1041 1042 1043 1044
  public async render(
    req: IncomingMessage,
    res: ServerResponse,
    pathname: string,
    query: ParsedUrlQuery = {},
1045
    parsedUrl?: UrlWithParsedQuery
J
Joe Haddad 已提交
1046
  ): Promise<void> {
1047 1048 1049 1050 1051 1052
    if (!pathname.startsWith('/')) {
      console.warn(
        `Cannot render page with path "${pathname}", did you mean "/${pathname}"?. See more info here: https://err.sh/next.js/render-no-starting-slash`
      )
    }

1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
    if (
      this.renderOpts.customServer &&
      pathname === '/index' &&
      !(await this.hasPage('/index'))
    ) {
      // maintain backwards compatibility for custom server
      // (see custom-server integration tests)
      pathname = '/'
    }

1063
    const url: any = req.url
1064

1065 1066 1067 1068
    // we allow custom servers to call render for all URLs
    // so check if we need to serve a static _next file or not.
    // we don't modify the URL for _next/data request but still
    // call render so we special case this to prevent an infinite loop
1069
    if (
1070 1071 1072
      !query._nextDataReq &&
      (url.match(/^\/_next\//) ||
        (this.hasStaticDir && url.match(/^\/static\//)))
1073
    ) {
1074 1075 1076
      return this.handleRequest(req, res, parsedUrl)
    }

1077
    if (isBlockedPage(pathname)) {
1078
      return this.render404(req, res, parsedUrl)
1079 1080
    }

1081
    const html = await this.renderToHTML(req, res, pathname, query)
1082 1083
    // Request was ended by the user
    if (html === null) {
1084 1085 1086
      return
    }

1087
    return this.sendHTML(req, res, html)
N
Naoyuki Kanezawa 已提交
1088
  }
N
nkzawa 已提交
1089

J
Joe Haddad 已提交
1090
  private async findPageComponents(
J
Joe Haddad 已提交
1091
    pathname: string,
1092 1093 1094
    query: ParsedUrlQuery = {},
    params: Params | null = null
  ): Promise<FindComponentsResult | null> {
1095
    let paths = [
1096 1097 1098 1099
      // try serving a static AMP version first
      query.amp ? normalizePagePath(pathname) + '.amp' : null,
      pathname,
    ].filter(Boolean)
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109

    if (query.__nextLocale) {
      paths = [
        ...paths.map(
          (path) => `/${query.__nextLocale}${path === '/' ? '' : path}`
        ),
        ...paths,
      ]
    }

1110
    for (const pagePath of paths) {
J
JJ Kasper 已提交
1111
      try {
1112
        const components = await loadComponents(
J
Joe Haddad 已提交
1113
          this.distDir,
1114 1115
          pagePath!,
          !this.renderOpts.dev && this._isLikeServerless
J
Joe Haddad 已提交
1116
        )
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
        // if loading an static HTML file the locale is required
        // to be present since all HTML files are output under their locale
        if (
          query.__nextLocale &&
          typeof components.Component === 'string' &&
          !pagePath?.startsWith(`/${query.__nextLocale}`)
        ) {
          const err = new Error('NOT_FOUND')
          ;(err as any).code = 'ENOENT'
          throw err
        }

1129 1130 1131
        return {
          components,
          query: {
1132
            ...(components.getStaticProps
1133 1134
              ? {
                  amp: query.amp,
1135
                  __next404: query.__next404,
1136 1137 1138
                  _nextDataReq: query._nextDataReq,
                  __nextLocale: query.__nextLocale,
                }
1139 1140 1141 1142
              : query),
            ...(params || {}),
          },
        }
J
JJ Kasper 已提交
1143 1144 1145 1146
      } catch (err) {
        if (err.code !== 'ENOENT') throw err
      }
    }
1147
    return null
J
Joe Haddad 已提交
1148 1149
  }

1150
  protected async getStaticPaths(
1151 1152 1153
    pathname: string
  ): Promise<{
    staticPaths: string[] | undefined
1154
    fallbackMode: 'static' | 'blocking' | false
1155
  }> {
1156 1157 1158 1159 1160
    // `staticPaths` is intentionally set to `undefined` as it should've
    // been caught when checking disk data.
    const staticPaths = undefined

    // Read whether or not fallback should exist from the manifest.
1161 1162
    const fallbackField = this.getPrerenderManifest().dynamicRoutes[pathname]
      .fallback
1163

1164 1165 1166 1167 1168 1169 1170 1171 1172
    return {
      staticPaths,
      fallbackMode:
        typeof fallbackField === 'string'
          ? 'static'
          : fallbackField === null
          ? 'blocking'
          : false,
    }
1173 1174
  }

J
Joe Haddad 已提交
1175 1176 1177 1178
  private async renderToHTMLWithComponents(
    req: IncomingMessage,
    res: ServerResponse,
    pathname: string,
1179
    { components, query }: FindComponentsResult,
1180
    opts: RenderOptsPartial
1181
  ): Promise<string | null> {
1182
    // we need to ensure the status code if /404 is visited directly
1183
    if (pathname === '/404') {
1184 1185 1186
      res.statusCode = 404
    }

J
JJ Kasper 已提交
1187
    // handle static page
1188 1189
    if (typeof components.Component === 'string') {
      return components.Component
J
Joe Haddad 已提交
1190 1191
    }

J
JJ Kasper 已提交
1192 1193
    // check request state
    const isLikeServerless =
1194 1195
      typeof components.Component === 'object' &&
      typeof (components.Component as any).renderReqToHTML === 'function'
1196 1197 1198
    const isSSG = !!components.getStaticProps
    const isServerProps = !!components.getServerSideProps
    const hasStaticPaths = !!components.getStaticPaths
1199

1200 1201 1202 1203
    if (!query.amp) {
      delete query.amp
    }

1204
    // Toggle whether or not this is a Data request
1205
    const isDataReq = !!query._nextDataReq && (isSSG || isServerProps)
1206 1207
    delete query._nextDataReq

J
JJ Kasper 已提交
1208 1209
    const locale = query.__nextLocale as string
    delete query.__nextLocale
1210 1211 1212

    const { i18n } = this.nextConfig.experimental
    const locales = i18n.locales as string[]
J
JJ Kasper 已提交
1213

1214 1215 1216 1217 1218 1219 1220 1221
    let previewData: string | false | object | undefined
    let isPreviewMode = false

    if (isServerProps || isSSG) {
      previewData = tryGetPreviewData(req, res, this.renderOpts.previewProps)
      isPreviewMode = previewData !== false
    }

1222 1223 1224
    // Compute the iSSG cache key. We use the rewroteUrl since
    // pages with fallback: false are allowed to be rewritten to
    // and we need to look up the path by the rewritten path
1225 1226 1227
    let urlPathname = parseUrl(req.url || '').pathname || '/'

    let resolvedUrlPathname = (req as any)._nextRewroteUrl
1228
      ? (req as any)._nextRewroteUrl
1229
      : urlPathname
1230

1231 1232 1233 1234 1235 1236 1237 1238 1239
    resolvedUrlPathname = removePathTrailingSlash(resolvedUrlPathname)
    urlPathname = removePathTrailingSlash(urlPathname)

    const stripNextDataPath = (path: string) => {
      if (path.includes(this.buildId)) {
        path = denormalizePagePath(
          (path.split(this.buildId).pop() || '/').replace(/\.json$/, '')
        )
      }
1240 1241

      if (this.nextConfig.experimental.i18n) {
J
JJ Kasper 已提交
1242
        return normalizeLocalePath(path, locales).pathname
1243
      }
1244 1245
      return path
    }
1246

1247 1248
    // remove /_next/data prefix from urlPathname so it matches
    // for direct page visit and /_next/data visit
1249 1250 1251
    if (isDataReq) {
      resolvedUrlPathname = stripNextDataPath(resolvedUrlPathname)
      urlPathname = stripNextDataPath(urlPathname)
1252 1253
    }

1254 1255 1256
    const ssgCacheKey =
      isPreviewMode || !isSSG
        ? undefined // Preview mode bypasses the cache
1257 1258 1259
        : `${locale ? `/${locale}` : ''}${resolvedUrlPathname}${
            query.amp ? '.amp' : ''
          }`
J
JJ Kasper 已提交
1260

1261 1262 1263 1264 1265 1266 1267 1268 1269
    // In development we use a __next404 query to allow signaling we should
    // render the 404 page after attempting to fetch the _next/data for a
    // fallback page since the fallback page will always be available after
    // reload and we don't want to re-serve it and instead want to 404.
    if (this.renderOpts.dev && isSSG && query.__next404) {
      delete query.__next404
      throw new NoFallbackError()
    }

J
JJ Kasper 已提交
1270
    // Complete the response with cached data if its present
1271 1272 1273
    const cachedData = ssgCacheKey
      ? await this.incrementalCache.get(ssgCacheKey)
      : undefined
1274

J
JJ Kasper 已提交
1275
    if (cachedData) {
1276 1277 1278 1279 1280 1281
      if (cachedData.isNotFound) {
        // we don't currently revalidate when notFound is returned
        // so trigger rendering 404 here
        throw new NoFallbackError()
      }

1282
      const data = isDataReq
J
JJ Kasper 已提交
1283 1284 1285
        ? JSON.stringify(cachedData.pageData)
        : cachedData.html

1286
      sendPayload(
1287
        req,
J
JJ Kasper 已提交
1288 1289
        res,
        data,
1290
        isDataReq ? 'json' : 'html',
1291 1292 1293 1294
        {
          generateEtags: this.renderOpts.generateEtags,
          poweredByHeader: this.renderOpts.poweredByHeader,
        },
1295 1296 1297 1298 1299 1300 1301 1302 1303
        !this.renderOpts.dev
          ? {
              private: isPreviewMode,
              stateful: false, // GSP response
              revalidate:
                cachedData.curRevalidate !== undefined
                  ? cachedData.curRevalidate
                  : /* default to minimum revalidate (this should be an invariant) */ 1,
            }
1304
          : undefined
J
JJ Kasper 已提交
1305 1306 1307 1308 1309 1310
      )

      // Stop the request chain here if the data we sent was up-to-date
      if (!cachedData.isStale) {
        return null
      }
J
JJ Kasper 已提交
1311
    }
J
Joe Haddad 已提交
1312

J
JJ Kasper 已提交
1313
    // If we're here, that means data is missing or it's stale.
1314 1315 1316 1317 1318 1319
    const maybeCoalesceInvoke = ssgCacheKey
      ? (fn: any) => withCoalescedInvoke(fn).bind(null, ssgCacheKey, [])
      : (fn: any) => async () => {
          const value = await fn()
          return { isOrigin: true, value }
        }
J
JJ Kasper 已提交
1320

1321 1322 1323 1324 1325
    const doRender = maybeCoalesceInvoke(
      async (): Promise<{
        html: string | null
        pageData: any
        sprRevalidate: number | false
1326
        isNotFound?: boolean
1327 1328 1329 1330
      }> => {
        let pageData: any
        let html: string | null
        let sprRevalidate: number | false
1331
        let isNotFound: boolean | undefined
1332 1333 1334 1335 1336 1337 1338

        let renderResult
        // handle serverless
        if (isLikeServerless) {
          renderResult = await (components.Component as any).renderReqToHTML(
            req,
            res,
P
Prateek Bhatnagar 已提交
1339 1340 1341
            'passthrough',
            {
              fontManifest: this.renderOpts.fontManifest,
1342
              locale,
1343 1344
              locales,
              // defaultLocale,
P
Prateek Bhatnagar 已提交
1345
            }
1346
          )
J
JJ Kasper 已提交
1347

1348 1349 1350
          html = renderResult.html
          pageData = renderResult.renderOpts.pageData
          sprRevalidate = renderResult.renderOpts.revalidate
1351
          isNotFound = renderResult.renderOpts.ssgNotFound
1352
        } else {
1353 1354 1355 1356 1357 1358 1359
          const origQuery = parseUrl(req.url || '', true).query
          const resolvedUrl = formatUrl({
            pathname: resolvedUrlPathname,
            // make sure to only add query values from original URL
            query: origQuery,
          })

1360 1361 1362 1363
          const renderOpts: RenderOpts = {
            ...components,
            ...opts,
            isDataReq,
1364
            resolvedUrl,
1365
            locale,
1366 1367
            locales,
            // defaultLocale,
1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
            // For getServerSideProps we need to ensure we use the original URL
            // and not the resolved URL to prevent a hydration mismatch on
            // asPath
            resolvedAsPath: isServerProps
              ? formatUrl({
                  // we use the original URL pathname less the _next/data prefix if
                  // present
                  pathname: urlPathname,
                  query: origQuery,
                })
              : resolvedUrl,
1379
          }
1380

1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392
          renderResult = await renderToHTML(
            req,
            res,
            pathname,
            query,
            renderOpts
          )

          html = renderResult
          // TODO: change this to a different passing mechanism
          pageData = (renderOpts as any).pageData
          sprRevalidate = (renderOpts as any).revalidate
1393
          isNotFound = (renderOpts as any).ssgNotFound
J
JJ Kasper 已提交
1394 1395
        }

1396
        return { html, pageData, sprRevalidate, isNotFound }
J
JJ Kasper 已提交
1397
      }
1398
    )
J
JJ Kasper 已提交
1399

1400
    const isProduction = !this.renderOpts.dev
J
Joe Haddad 已提交
1401
    const isDynamicPathname = isDynamicRoute(pathname)
1402
    const didRespond = isResSent(res)
1403

1404
    const { staticPaths, fallbackMode } = hasStaticPaths
1405
      ? await this.getStaticPaths(pathname)
1406
      : { staticPaths: undefined, fallbackMode: false }
1407

1408 1409 1410 1411 1412
    // When we did not respond from cache, we need to choose to block on
    // rendering or return a skeleton.
    //
    // * Data requests always block.
    //
1413 1414
    // * Blocking mode fallback always blocks.
    //
1415 1416
    // * Preview mode toggles all pages to be resolved in a blocking manner.
    //
1417
    // * Non-dynamic pages should block (though this is an impossible
1418 1419
    //   case in production).
    //
1420 1421
    // * Dynamic pages should return their skeleton if not defined in
    //   getStaticPaths, then finish the data request on the client-side.
1422
    //
J
Joe Haddad 已提交
1423
    if (
1424
      fallbackMode !== 'blocking' &&
1425
      ssgCacheKey &&
1426 1427 1428
      !didRespond &&
      !isPreviewMode &&
      isDynamicPathname &&
1429 1430
      // Development should trigger fallback when the path is not in
      // `getStaticPaths`
1431 1432
      (isProduction ||
        !staticPaths ||
1433 1434 1435 1436 1437
        // static paths always includes locale so make sure it's prefixed
        // with it
        !staticPaths.includes(
          `${locale ? '/' + locale : ''}${resolvedUrlPathname}`
        ))
J
Joe Haddad 已提交
1438
    ) {
1439 1440 1441 1442 1443
      if (
        // In development, fall through to render to handle missing
        // getStaticPaths.
        (isProduction || staticPaths) &&
        // When fallback isn't present, abort this render so we 404
1444
        fallbackMode !== 'static'
1445
      ) {
1446
        throw new NoFallbackError()
1447 1448
      }

1449 1450
      if (!isDataReq) {
        let html: string
1451

1452 1453
        // Production already emitted the fallback as static HTML.
        if (isProduction) {
1454 1455 1456
          html = await this.incrementalCache.getFallback(
            locale ? `/${locale}${pathname}` : pathname
          )
1457 1458 1459 1460 1461 1462 1463 1464 1465
        }
        // We need to generate the fallback on-demand for development.
        else {
          query.__nextFallback = 'true'
          if (isLikeServerless) {
            prepareServerlessUrl(req, query)
          }
          const { value: renderResult } = await doRender()
          html = renderResult.html
1466 1467
        }

1468 1469 1470 1471 1472 1473
        sendPayload(req, res, html, 'html', {
          generateEtags: this.renderOpts.generateEtags,
          poweredByHeader: this.renderOpts.poweredByHeader,
        })
        return null
      }
1474 1475
    }

1476 1477
    const {
      isOrigin,
1478
      value: { html, pageData, sprRevalidate, isNotFound },
1479
    } = await doRender()
1480
    let resHtml = html
1481 1482 1483 1484 1485 1486

    if (
      !isResSent(res) &&
      !isNotFound &&
      (isSSG || isDataReq || isServerProps)
    ) {
1487
      sendPayload(
1488
        req,
1489 1490
        res,
        isDataReq ? JSON.stringify(pageData) : html,
1491
        isDataReq ? 'json' : 'html',
1492 1493 1494 1495
        {
          generateEtags: this.renderOpts.generateEtags,
          poweredByHeader: this.renderOpts.poweredByHeader,
        },
1496
        !this.renderOpts.dev || (isServerProps && !isDataReq)
1497 1498
          ? {
              private: isPreviewMode,
1499
              stateful: !isSSG,
1500 1501
              revalidate: sprRevalidate,
            }
1502
          : undefined
1503
      )
1504
      resHtml = null
1505
    }
J
JJ Kasper 已提交
1506

1507
    // Update the cache if the head request and cacheable
1508
    if (isOrigin && ssgCacheKey) {
1509 1510
      await this.incrementalCache.set(
        ssgCacheKey,
1511
        { html: html!, pageData, isNotFound },
1512 1513
        sprRevalidate
      )
1514 1515
    }

1516 1517 1518
    if (isNotFound) {
      throw new NoFallbackError()
    }
1519
    return resHtml
1520 1521
  }

1522
  public async renderToHTML(
J
Joe Haddad 已提交
1523 1524 1525
    req: IncomingMessage,
    res: ServerResponse,
    pathname: string,
1526
    query: ParsedUrlQuery = {}
J
Joe Haddad 已提交
1527
  ): Promise<string | null> {
1528 1529 1530
    try {
      const result = await this.findPageComponents(pathname, query)
      if (result) {
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
        try {
          return await this.renderToHTMLWithComponents(
            req,
            res,
            pathname,
            result,
            { ...this.renderOpts }
          )
        } catch (err) {
          if (!(err instanceof NoFallbackError)) {
            throw err
          }
1543
        }
1544
      }
J
Joe Haddad 已提交
1545

1546 1547 1548 1549 1550 1551
      if (this.dynamicRoutes) {
        for (const dynamicRoute of this.dynamicRoutes) {
          const params = dynamicRoute.match(pathname)
          if (!params) {
            continue
          }
J
Joe Haddad 已提交
1552

1553
          const dynamicRouteResult = await this.findPageComponents(
1554 1555 1556 1557
            dynamicRoute.page,
            query,
            params
          )
1558
          if (dynamicRouteResult) {
1559 1560 1561 1562 1563
            try {
              return await this.renderToHTMLWithComponents(
                req,
                res,
                dynamicRoute.page,
1564
                dynamicRouteResult,
1565 1566 1567 1568 1569 1570
                { ...this.renderOpts, params }
              )
            } catch (err) {
              if (!(err instanceof NoFallbackError)) {
                throw err
              }
1571
            }
J
Joe Haddad 已提交
1572 1573
          }
        }
1574 1575 1576
      }
    } catch (err) {
      this.logError(err)
1577 1578 1579 1580 1581

      if (err && err.code === 'DECODE_FAILED') {
        res.statusCode = 400
        return await this.renderErrorToHTML(err, req, res, pathname, query)
      }
1582 1583 1584 1585 1586
      res.statusCode = 500
      return await this.renderErrorToHTML(err, req, res, pathname, query)
    }
    res.statusCode = 404
    return await this.renderErrorToHTML(null, req, res, pathname, query)
N
Naoyuki Kanezawa 已提交
1587 1588
  }

J
Joe Haddad 已提交
1589 1590 1591 1592 1593
  public async renderError(
    err: Error | null,
    req: IncomingMessage,
    res: ServerResponse,
    pathname: string,
1594
    query: ParsedUrlQuery = {}
J
Joe Haddad 已提交
1595 1596 1597
  ): Promise<void> {
    res.setHeader(
      'Cache-Control',
1598
      'no-cache, no-store, max-age=0, must-revalidate'
J
Joe Haddad 已提交
1599
    )
N
Naoyuki Kanezawa 已提交
1600
    const html = await this.renderErrorToHTML(err, req, res, pathname, query)
1601
    if (html === null) {
1602 1603
      return
    }
1604
    return this.sendHTML(req, res, html)
N
nkzawa 已提交
1605 1606
  }

1607 1608 1609 1610 1611 1612 1613 1614 1615
  private customErrorNo404Warn = execOnce(() => {
    console.warn(
      chalk.bold.yellow(`Warning: `) +
        chalk.yellow(
          `You have added a custom /_error page without a custom /404 page. This prevents the 404 page from being auto statically optimized.\nSee here for info: https://err.sh/next.js/custom-error-no-custom-404`
        )
    )
  })

J
Joe Haddad 已提交
1616 1617 1618 1619 1620
  public async renderErrorToHTML(
    err: Error | null,
    req: IncomingMessage,
    res: ServerResponse,
    _pathname: string,
1621
    query: ParsedUrlQuery = {}
J
Joe Haddad 已提交
1622
  ) {
1623
    let result: null | FindComponentsResult = null
1624

1625 1626 1627
    const is404 = res.statusCode === 404
    let using404Page = false

1628
    // use static 404 page if available and is 404 response
1629
    if (is404) {
1630
      result = await this.findPageComponents('/404', query)
1631
      using404Page = result !== null
1632 1633 1634 1635 1636 1637
    }

    if (!result) {
      result = await this.findPageComponents('/_error', query)
    }

1638 1639 1640
    if (
      process.env.NODE_ENV !== 'production' &&
      !using404Page &&
1641 1642
      (await this.hasPage('/_error')) &&
      !(await this.hasPage('/404'))
1643 1644 1645 1646
    ) {
      this.customErrorNo404Warn()
    }

1647
    let html: string | null
1648
    try {
1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
      try {
        html = await this.renderToHTMLWithComponents(
          req,
          res,
          using404Page ? '/404' : '/_error',
          result!,
          {
            ...this.renderOpts,
            err,
          }
        )
1660 1661
      } catch (maybeFallbackError) {
        if (maybeFallbackError instanceof NoFallbackError) {
1662
          throw new Error('invariant: failed to render error page')
1663
        }
1664
        throw maybeFallbackError
1665
      }
1666 1667
    } catch (renderToHtmlError) {
      console.error(renderToHtmlError)
1668 1669 1670 1671
      res.statusCode = 500
      html = 'Internal Server Error'
    }
    return html
N
Naoyuki Kanezawa 已提交
1672 1673
  }

J
Joe Haddad 已提交
1674 1675 1676
  public async render404(
    req: IncomingMessage,
    res: ServerResponse,
1677
    parsedUrl?: UrlWithParsedQuery
J
Joe Haddad 已提交
1678
  ): Promise<void> {
1679 1680
    const url: any = req.url
    const { pathname, query } = parsedUrl ? parsedUrl : parseUrl(url, true)
N
Naoyuki Kanezawa 已提交
1681
    res.statusCode = 404
1682
    return this.renderError(null, req, res, pathname!, query)
N
Naoyuki Kanezawa 已提交
1683
  }
N
Naoyuki Kanezawa 已提交
1684

J
Joe Haddad 已提交
1685 1686 1687 1688
  public async serveStatic(
    req: IncomingMessage,
    res: ServerResponse,
    path: string,
1689
    parsedUrl?: UrlWithParsedQuery
J
Joe Haddad 已提交
1690
  ): Promise<void> {
A
Arunoda Susiripala 已提交
1691
    if (!this.isServeableUrl(path)) {
1692
      return this.render404(req, res, parsedUrl)
A
Arunoda Susiripala 已提交
1693 1694
    }

1695 1696 1697 1698 1699 1700
    if (!(req.method === 'GET' || req.method === 'HEAD')) {
      res.statusCode = 405
      res.setHeader('Allow', ['GET', 'HEAD'])
      return this.renderError(null, req, res, path)
    }

N
Naoyuki Kanezawa 已提交
1701
    try {
1702
      await serveStatic(req, res, path)
N
Naoyuki Kanezawa 已提交
1703
    } catch (err) {
T
Tim Neutkens 已提交
1704
      if (err.code === 'ENOENT' || err.statusCode === 404) {
1705
        this.render404(req, res, parsedUrl)
1706 1707 1708
      } else if (err.statusCode === 412) {
        res.statusCode = 412
        return this.renderError(err, req, res, path)
N
Naoyuki Kanezawa 已提交
1709 1710 1711 1712 1713 1714
      } else {
        throw err
      }
    }
  }

1715 1716 1717 1718 1719 1720 1721 1722 1723
  private _validFilesystemPathSet: Set<string> | null = null
  private getFilesystemPaths(): Set<string> {
    if (this._validFilesystemPathSet) {
      return this._validFilesystemPathSet
    }

    const pathUserFilesStatic = join(this.dir, 'static')
    let userFilesStatic: string[] = []
    if (this.hasStaticDir && fs.existsSync(pathUserFilesStatic)) {
J
Joe Haddad 已提交
1724
      userFilesStatic = recursiveReadDirSync(pathUserFilesStatic).map((f) =>
1725 1726 1727 1728 1729 1730
        join('.', 'static', f)
      )
    }

    let userFilesPublic: string[] = []
    if (this.publicDir && fs.existsSync(this.publicDir)) {
J
Joe Haddad 已提交
1731
      userFilesPublic = recursiveReadDirSync(this.publicDir).map((f) =>
1732 1733 1734 1735 1736 1737 1738
        join('.', 'public', f)
      )
    }

    let nextFilesStatic: string[] = []
    nextFilesStatic = recursiveReadDirSync(
      join(this.distDir, 'static')
J
Joe Haddad 已提交
1739
    ).map((f) => join('.', relative(this.dir, this.distDir), 'static', f))
1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773

    return (this._validFilesystemPathSet = new Set<string>([
      ...nextFilesStatic,
      ...userFilesPublic,
      ...userFilesStatic,
    ]))
  }

  protected isServeableUrl(untrustedFileUrl: string): boolean {
    // This method mimics what the version of `send` we use does:
    // 1. decodeURIComponent:
    //    https://github.com/pillarjs/send/blob/0.17.1/index.js#L989
    //    https://github.com/pillarjs/send/blob/0.17.1/index.js#L518-L522
    // 2. resolve:
    //    https://github.com/pillarjs/send/blob/de073ed3237ade9ff71c61673a34474b30e5d45b/index.js#L561

    let decodedUntrustedFilePath: string
    try {
      // (1) Decode the URL so we have the proper file name
      decodedUntrustedFilePath = decodeURIComponent(untrustedFileUrl)
    } catch {
      return false
    }

    // (2) Resolve "up paths" to determine real request
    const untrustedFilePath = resolve(decodedUntrustedFilePath)

    // don't allow null bytes anywhere in the file path
    if (untrustedFilePath.indexOf('\0') !== -1) {
      return false
    }

    // Check if .next/static, static and public are in the path.
    // If not the path is not available.
A
Arunoda Susiripala 已提交
1774
    if (
1775 1776 1777
      (untrustedFilePath.startsWith(join(this.distDir, 'static') + sep) ||
        untrustedFilePath.startsWith(join(this.dir, 'static') + sep) ||
        untrustedFilePath.startsWith(join(this.dir, 'public') + sep)) === false
A
Arunoda Susiripala 已提交
1778 1779 1780 1781
    ) {
      return false
    }

1782 1783 1784 1785
    // Check against the real filesystem paths
    const filesystemUrls = this.getFilesystemPaths()
    const resolved = relative(this.dir, untrustedFilePath)
    return filesystemUrls.has(resolved)
A
Arunoda Susiripala 已提交
1786 1787
  }

1788
  protected readBuildId(): string {
1789 1790 1791 1792 1793
    const buildIdFile = join(this.distDir, BUILD_ID_FILE)
    try {
      return fs.readFileSync(buildIdFile, 'utf8').trim()
    } catch (err) {
      if (!fs.existsSync(buildIdFile)) {
J
Joe Haddad 已提交
1794
        throw new Error(
1795
          `Could not find a valid build in the '${this.distDir}' directory! Try building your app with 'next build' before starting the server.`
J
Joe Haddad 已提交
1796
        )
1797 1798 1799
      }

      throw err
1800
    }
1801
  }
1802

1803
  protected get _isLikeServerless(): boolean {
1804 1805
    return isTargetLikeServerless(this.nextConfig.target)
  }
1806
}
1807

1808 1809 1810 1811
function prepareServerlessUrl(
  req: IncomingMessage,
  query: ParsedUrlQuery
): void {
1812 1813 1814 1815 1816 1817 1818 1819 1820 1821
  const curUrl = parseUrl(req.url!, true)
  req.url = formatUrl({
    ...curUrl,
    search: undefined,
    query: {
      ...curUrl.query,
      ...query,
    },
  })
}
1822 1823

class NoFallbackError extends Error {}