next-server.ts 53.0 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
        parsedUrl.pathname = localePathResult.pathname
345 346 347 348 349 350 351 352 353 354
      }

      // If a detected locale is a domain specific locale and we aren't already
      // on that domain and path prefix redirect to it to prevent duplicate
      // content from multiple domains
      if (detectedDomain && parsedUrl.pathname === '/') {
        const localeToCheck = acceptPreferredLocale
        // const localeToCheck = localePathResult.detectedLocale
        //   ? detectedLocale
        //   : acceptPreferredLocale
355

356 357 358
        const matchedDomain = detectDomainLocale(
          i18n.domains,
          undefined,
359
          localeToCheck
360 361
        )

362 363 364 365 366
        if (
          matchedDomain &&
          (matchedDomain.domain !== detectedDomain.domain ||
            localeToCheck !== matchedDomain.defaultLocale)
        ) {
367 368
          localeDomainRedirect = `http${matchedDomain.http ? '' : 's'}://${
            matchedDomain.domain
369 370
          }/${
            localeToCheck === matchedDomain.defaultLocale ? '' : localeToCheck
371
          }`
372 373 374
        }
      }

375
      const denormalizedPagePath = denormalizePagePath(pathname || '/')
376
      const detectedDefaultLocale =
377 378
        !detectedLocale ||
        detectedLocale.toLowerCase() === defaultLocale.toLowerCase()
379 380 381 382
      const shouldStripDefaultLocale = false
      // detectedDefaultLocale &&
      // denormalizedPagePath.toLowerCase() ===
      //   `/${i18n.defaultLocale.toLowerCase()}`
383

384 385
      const shouldAddLocalePrefix =
        !detectedDefaultLocale && denormalizedPagePath === '/'
386

387
      detectedLocale = detectedLocale || i18n.defaultLocale
388

389 390
      if (
        i18n.localeDetection !== false &&
391 392 393
        (localeDomainRedirect ||
          shouldAddLocalePrefix ||
          shouldStripDefaultLocale)
394
      ) {
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
        // 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: '/',
            }),
          ])
        }

417 418 419 420 421
        res.setHeader(
          'Location',
          formatUrl({
            // make sure to include any query values when redirecting
            ...parsed,
422 423 424 425 426
            pathname: localeDomainRedirect
              ? localeDomainRedirect
              : shouldStripDefaultLocale
              ? '/'
              : `/${detectedLocale}`,
427 428 429 430
          })
        )
        res.statusCode = 307
        res.end()
431
        return
432
      }
433
      parsedUrl.query.__nextLocale = detectedLocale || defaultLocale
434 435
    }

436
    res.statusCode = 200
437 438 439
    try {
      return await this.run(req, res, parsedUrl)
    } catch (err) {
J
Joe Haddad 已提交
440 441 442
      this.logError(err)
      res.statusCode = 500
      res.end('Internal Server Error')
443
    }
444 445
  }

446
  public getRequestHandler() {
447
    return this.handleRequest.bind(this)
N
nkzawa 已提交
448 449
  }

450
  public setAssetPrefix(prefix?: string): void {
451
    this.renderOpts.assetPrefix = prefix ? prefix.replace(/\/$/, '') : ''
452 453
  }

454
  // Backwards compatibility
455
  public async prepare(): Promise<void> {}
N
nkzawa 已提交
456

T
Tim Neutkens 已提交
457
  // Backwards compatibility
458
  protected async close(): Promise<void> {}
T
Tim Neutkens 已提交
459

460
  protected setImmutableAssetCacheControl(res: ServerResponse): void {
T
Tim Neutkens 已提交
461
    res.setHeader('Cache-Control', 'public, max-age=31536000, immutable')
N
nkzawa 已提交
462 463
  }

464
  protected getCustomRoutes(): CustomRoutes {
J
JJ Kasper 已提交
465 466 467
    return require(join(this.distDir, ROUTES_MANIFEST))
  }

468 469 470 471
  private _cachedPreviewManifest: PrerenderManifest | undefined
  protected getPrerenderManifest(): PrerenderManifest {
    if (this._cachedPreviewManifest) {
      return this._cachedPreviewManifest
J
Joe Haddad 已提交
472
    }
473 474 475 476 477 478
    const manifest = require(join(this.distDir, PRERENDER_MANIFEST))
    return (this._cachedPreviewManifest = manifest)
  }

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

481
  protected generateRoutes(): {
482
    basePath: string
483 484
    headers: Route[]
    rewrites: Route[]
485
    fsRoutes: Route[]
486
    redirects: Route[]
487 488
    catchAllRoute: Route
    pageChecker: PageChecker
489
    useFileSystemPublicRoutes: boolean
490 491
    dynamicRoutes: DynamicRoutes | undefined
  } {
S
Steven 已提交
492
    const server: Server = this
493 494 495
    const publicRoutes = fs.existsSync(this.publicDir)
      ? this.generatePublicRoutes()
      : []
J
JJ Kasper 已提交
496

497
    const staticFilesRoute = this.hasStaticDir
498 499 500 501 502
      ? [
          {
            // 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.
503
            // See more: https://github.com/vercel/next.js/issues/2617
504
            match: route('/static/:path*'),
505
            name: 'static catchall',
506
            fn: async (req, res, params, parsedUrl) => {
507
              const p = join(this.dir, 'static', ...params.path)
508
              await this.serveStatic(req, res, p, parsedUrl)
509 510 511
              return {
                finished: true,
              }
512 513 514 515
            },
          } as Route,
        ]
      : []
516

517
    const fsRoutes: Route[] = [
T
Tim Neutkens 已提交
518
      {
519
        match: route('/_next/static/:path*'),
520 521
        type: 'route',
        name: '_next/static catchall',
522
        fn: async (req, res, params, parsedUrl) => {
523
          // make sure to 404 for /_next/static itself
524 525 526 527 528 529
          if (!params.path) {
            await this.render404(req, res, parsedUrl)
            return {
              finished: true,
            }
          }
530

J
Joe Haddad 已提交
531 532 533
          if (
            params.path[0] === CLIENT_STATIC_FILES_RUNTIME ||
            params.path[0] === 'chunks' ||
534 535
            params.path[0] === 'css' ||
            params.path[0] === 'media' ||
536
            params.path[0] === this.buildId ||
537
            params.path[0] === 'pages' ||
538
            params.path[1] === 'pages'
J
Joe Haddad 已提交
539
          ) {
T
Tim Neutkens 已提交
540
            this.setImmutableAssetCacheControl(res)
541
          }
J
Joe Haddad 已提交
542 543 544
          const p = join(
            this.distDir,
            CLIENT_STATIC_FILES_PATH,
545
            ...(params.path || [])
J
Joe Haddad 已提交
546
          )
547
          await this.serveStatic(req, res, p, parsedUrl)
548 549 550
          return {
            finished: true,
          }
551
        },
552
      },
J
JJ Kasper 已提交
553 554
      {
        match: route('/_next/data/:path*'),
555 556
        type: 'route',
        name: '_next/data catchall',
J
JJ Kasper 已提交
557
        fn: async (req, res, params, _parsedUrl) => {
J
JJ Kasper 已提交
558 559 560
          // 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) {
561 562 563 564
            await this.render404(req, res, _parsedUrl)
            return {
              finished: true,
            }
J
JJ Kasper 已提交
565 566 567 568 569 570
          }
          // 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')) {
571 572 573 574
            await this.render404(req, res, _parsedUrl)
            return {
              finished: true,
            }
J
JJ Kasper 已提交
575 576 577
          }

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

580 581 582
          const { i18n } = this.nextConfig.experimental

          if (i18n) {
583 584 585
            const { host } = req?.headers || {}
            // remove port from host and remove port if present
            const hostname = host?.split(':')[0].toLowerCase()
586
            const localePathResult = normalizeLocalePath(pathname, i18n.locales)
587
            const { defaultLocale } =
588
              detectDomainLocale(i18n.domains, hostname) || {}
589
            let detectedLocale = defaultLocale
590 591 592 593 594

            if (localePathResult.detectedLocale) {
              pathname = localePathResult.pathname
              detectedLocale = localePathResult.detectedLocale
            }
595
            _parsedUrl.query.__nextLocale = detectedLocale!
596 597
          }
          pathname = getRouteFromAssetPath(pathname, '.json')
J
JJ Kasper 已提交
598

J
JJ Kasper 已提交
599
          const parsedUrl = parseUrl(pathname, true)
600

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

636 637 638 639 640 641
    const getCustomRouteBasePath = (r: { basePath?: false }) => {
      return r.basePath !== false && this.renderOpts.dev
        ? this.nextConfig.basePath
        : ''
    }

642 643 644 645
    const getCustomRoute = (r: Rewrite | Redirect | Header, type: RouteType) =>
      ({
        ...r,
        type,
646
        match: getCustomRouteMatcher(`${getCustomRouteBasePath(r)}${r.source}`),
647 648 649 650 651 652 653
        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
654
      }
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675

      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}`
            )
        }
676
      }
677 678 679 680 681 682 683 684 685 686 687 688
      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)
689
    }
690

691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
    // 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)
706
            }
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
            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,
725 726 727
            parsedUrl.query,
            false,
            getCustomRouteBasePath(redirectRoute)
728
          )
729 730

          const { query } = parsedDestination
731
          delete (parsedDestination as any).query
732

733
          parsedDestination.search = stringifyQs(query)
734

735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
          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 {
757
        ...rewriteRoute,
758 759 760 761 762 763 764 765 766
        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,
767 768
            true,
            getCustomRouteBasePath(rewriteRoute)
769
          )
770

771 772
          // external rewrite, proxy it
          if (parsedDestination.protocol) {
773
            const { query } = parsedDestination
774
            delete (parsedDestination as any).query
775
            parsedDestination.search = stringifyQs(query)
776

777 778 779 780 781 782 783 784 785 786 787
            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)
            })
788 789 790
            return {
              finished: true,
            }
791 792
          }
          ;(req as any)._nextRewroteUrl = newUrl
793 794
          ;(req as any)._nextDidRewrite =
            (req as any)._nextRewroteUrl !== req.url
795

796 797 798 799 800 801 802 803
          return {
            finished: false,
            pathname: newUrl,
            query: parsedDestination.query,
          }
        },
      } as Route
    })
804 805 806 807 808 809

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

J
Jan Potoms 已提交
815
        // next.js core assumes page path without trailing slash
816
        pathname = removePathTrailingSlash(pathname)
J
Jan Potoms 已提交
817

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

        await this.render(req, res, pathname, query, parsedUrl)
831 832 833 834
        return {
          finished: true,
        }
      },
835
    }
836

837
    const { useFileSystemPublicRoutes } = this.nextConfig
J
Joe Haddad 已提交
838

839 840
    if (useFileSystemPublicRoutes) {
      this.dynamicRoutes = this.getDynamicRoutes()
841
    }
N
nkzawa 已提交
842

843
    return {
844
      headers,
845
      fsRoutes,
846 847
      rewrites,
      redirects,
848
      catchAllRoute,
849
      useFileSystemPublicRoutes,
850
      dynamicRoutes: this.dynamicRoutes,
851
      basePath: this.nextConfig.basePath,
852 853
      pageChecker: this.hasPage.bind(this),
    }
T
Tim Neutkens 已提交
854 855
  }

856
  private async getPagePath(pathname: string): Promise<string> {
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
    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
  }

874 875 876 877 878
  protected async _beforeCatchAllRender(
    _req: IncomingMessage,
    _res: ServerResponse,
    _params: Params,
    _parsedUrl: UrlWithParsedQuery
879
  ): Promise<boolean> {
880 881 882
    return false
  }

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

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

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

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

920 921 922 923 924 925 926 927 928 929
    let builtPagePath
    try {
      builtPagePath = await this.getPagePath(page)
    } catch (err) {
      if (err.code === 'ENOENT') {
        return false
      }
      throw err
    }

930
    const pageModule = await require(builtPagePath)
931
    query = { ...query, ...params }
J
JJ Kasper 已提交
932

933
    if (!this.renderOpts.dev && this._isLikeServerless) {
934
      if (typeof pageModule.default === 'function') {
935
        prepareServerlessUrl(req, query)
936 937
        await pageModule.default(req, res)
        return true
J
JJ Kasper 已提交
938 939 940
      }
    }

J
Joe Haddad 已提交
941 942 943 944 945
    await apiResolver(
      req,
      res,
      query,
      pageModule,
946
      this.renderOpts.previewProps,
947
      false,
J
Joe Haddad 已提交
948 949
      this.onErrorMiddleware
    )
950
    return true
L
Lukáš Huvar 已提交
951 952
  }

953
  protected generatePublicRoutes(): Route[] {
954
    const publicFiles = new Set(
955 956 957
      recursiveReadDirSync(this.publicDir).map((p) =>
        encodeURI(p.replace(/\\/g, '/'))
      )
958 959 960 961 962 963 964
    )

    return [
      {
        match: route('/:path*'),
        name: 'public folder catchall',
        fn: async (req, res, params, parsedUrl) => {
965
          const pathParts: string[] = params.path || []
966 967 968 969 970 971 972 973
          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()
          }

974
          const path = `/${pathParts.join('/')}`
975 976 977 978 979

          if (publicFiles.has(path)) {
            await this.serveStatic(
              req,
              res,
980
              join(this.publicDir, ...pathParts),
981 982
              parsedUrl
            )
983 984 985
            return {
              finished: true,
            }
986 987 988 989 990 991 992
          }
          return {
            finished: false,
          }
        },
      } as Route,
    ]
993 994
  }

995
  protected getDynamicRoutes() {
996 997
    return getSortedRoutes(Object.keys(this.pagesManifest!))
      .filter(isDynamicRoute)
J
Joe Haddad 已提交
998
      .map((page) => ({
999 1000 1001
        page,
        match: getRouteMatcher(getRouteRegex(page)),
      }))
J
Joe Haddad 已提交
1002 1003
  }

1004
  private handleCompression(req: IncomingMessage, res: ServerResponse): void {
1005 1006 1007 1008 1009
    if (this.compression) {
      this.compression(req, res, () => {})
    }
  }

1010
  protected async run(
J
Joe Haddad 已提交
1011 1012
    req: IncomingMessage,
    res: ServerResponse,
1013
    parsedUrl: UrlWithParsedQuery
1014
  ): Promise<void> {
1015 1016
    this.handleCompression(req, res)

1017
    try {
1018 1019
      const matched = await this.router.execute(req, res, parsedUrl)
      if (matched) {
1020 1021 1022 1023 1024 1025 1026 1027
        return
      }
    } catch (err) {
      if (err.code === 'DECODE_FAILED') {
        res.statusCode = 400
        return this.renderError(null, req, res, '/_error', {})
      }
      throw err
1028 1029
    }

1030
    await this.render404(req, res, parsedUrl)
N
nkzawa 已提交
1031 1032
  }

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

J
Joe Haddad 已提交
1045 1046 1047 1048 1049
  public async render(
    req: IncomingMessage,
    res: ServerResponse,
    pathname: string,
    query: ParsedUrlQuery = {},
1050
    parsedUrl?: UrlWithParsedQuery
J
Joe Haddad 已提交
1051
  ): Promise<void> {
1052 1053 1054 1055 1056 1057
    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`
      )
    }

1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
    if (
      this.renderOpts.customServer &&
      pathname === '/index' &&
      !(await this.hasPage('/index'))
    ) {
      // maintain backwards compatibility for custom server
      // (see custom-server integration tests)
      pathname = '/'
    }

1068
    const url: any = req.url
1069

1070 1071 1072 1073
    // 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
1074
    if (
1075 1076 1077
      !query._nextDataReq &&
      (url.match(/^\/_next\//) ||
        (this.hasStaticDir && url.match(/^\/static\//)))
1078
    ) {
1079 1080 1081
      return this.handleRequest(req, res, parsedUrl)
    }

1082
    if (isBlockedPage(pathname)) {
1083
      return this.render404(req, res, parsedUrl)
1084 1085
    }

1086
    const html = await this.renderToHTML(req, res, pathname, query)
1087 1088
    // Request was ended by the user
    if (html === null) {
1089 1090 1091
      return
    }

1092
    return this.sendHTML(req, res, html)
N
Naoyuki Kanezawa 已提交
1093
  }
N
nkzawa 已提交
1094

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

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

1115
    for (const pagePath of paths) {
J
JJ Kasper 已提交
1116
      try {
1117
        const components = await loadComponents(
J
Joe Haddad 已提交
1118
          this.distDir,
1119 1120
          pagePath!,
          !this.renderOpts.dev && this._isLikeServerless
J
Joe Haddad 已提交
1121
        )
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
        // 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
        }

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

1154
  protected async getStaticPaths(
1155 1156 1157
    pathname: string
  ): Promise<{
    staticPaths: string[] | undefined
1158
    fallbackMode: 'static' | 'blocking' | false
1159
  }> {
1160 1161 1162 1163 1164
    // `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.
1165 1166
    const fallbackField = this.getPrerenderManifest().dynamicRoutes[pathname]
      .fallback
1167

1168 1169 1170 1171 1172 1173 1174 1175 1176
    return {
      staticPaths,
      fallbackMode:
        typeof fallbackField === 'string'
          ? 'static'
          : fallbackField === null
          ? 'blocking'
          : false,
    }
1177 1178
  }

J
Joe Haddad 已提交
1179 1180 1181 1182
  private async renderToHTMLWithComponents(
    req: IncomingMessage,
    res: ServerResponse,
    pathname: string,
1183
    { components, query }: FindComponentsResult,
1184
    opts: RenderOptsPartial
1185
  ): Promise<string | null> {
1186 1187
    const is404Page = pathname === '/404'

1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
    const isLikeServerless =
      typeof components.Component === 'object' &&
      typeof (components.Component as any).renderReqToHTML === 'function'
    const isSSG = !!components.getStaticProps
    const isServerProps = !!components.getServerSideProps
    const hasStaticPaths = !!components.getStaticPaths

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

1199
    // we need to ensure the status code if /404 is visited directly
1200
    if (is404Page && !isDataReq) {
1201 1202 1203
      res.statusCode = 404
    }

J
JJ Kasper 已提交
1204
    // handle static page
1205 1206
    if (typeof components.Component === 'string') {
      return components.Component
J
Joe Haddad 已提交
1207 1208
    }

1209 1210 1211 1212
    if (!query.amp) {
      delete query.amp
    }

J
JJ Kasper 已提交
1213 1214
    const locale = query.__nextLocale as string
    delete query.__nextLocale
1215 1216 1217

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

1219 1220 1221 1222 1223 1224 1225 1226
    let previewData: string | false | object | undefined
    let isPreviewMode = false

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

1227 1228 1229
    // 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
1230 1231 1232
    let urlPathname = parseUrl(req.url || '').pathname || '/'

    let resolvedUrlPathname = (req as any)._nextRewroteUrl
1233
      ? (req as any)._nextRewroteUrl
1234
      : urlPathname
1235

1236 1237 1238 1239 1240 1241 1242 1243 1244
    resolvedUrlPathname = removePathTrailingSlash(resolvedUrlPathname)
    urlPathname = removePathTrailingSlash(urlPathname)

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

      if (this.nextConfig.experimental.i18n) {
J
JJ Kasper 已提交
1247
        return normalizeLocalePath(path, locales).pathname
1248
      }
1249 1250
      return path
    }
1251

1252 1253
    // remove /_next/data prefix from urlPathname so it matches
    // for direct page visit and /_next/data visit
1254 1255 1256
    if (isDataReq) {
      resolvedUrlPathname = stripNextDataPath(resolvedUrlPathname)
      urlPathname = stripNextDataPath(urlPathname)
1257 1258
    }

1259
    let ssgCacheKey =
1260 1261
      isPreviewMode || !isSSG
        ? undefined // Preview mode bypasses the cache
1262 1263 1264
        : `${locale ? `/${locale}` : ''}${resolvedUrlPathname}${
            query.amp ? '.amp' : ''
          }`
J
JJ Kasper 已提交
1265

1266 1267 1268 1269 1270 1271
    if (is404Page && isSSG) {
      ssgCacheKey = `${locale ? `/${locale}` : ''}${pathname}${
        query.amp ? '.amp' : ''
      }`
    }

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

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

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

1288
      sendPayload(
1289
        req,
J
JJ Kasper 已提交
1290 1291
        res,
        data,
1292
        isDataReq ? 'json' : 'html',
1293 1294 1295 1296
        {
          generateEtags: this.renderOpts.generateEtags,
          poweredByHeader: this.renderOpts.poweredByHeader,
        },
1297 1298 1299 1300 1301 1302 1303 1304 1305
        !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,
            }
1306
          : undefined
J
JJ Kasper 已提交
1307 1308 1309 1310 1311 1312
      )

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

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

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

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

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

1362 1363 1364 1365
          const renderOpts: RenderOpts = {
            ...components,
            ...opts,
            isDataReq,
1366
            resolvedUrl,
1367
            locale,
1368 1369
            locales,
            // defaultLocale,
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
            // 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,
1381
          }
1382

1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
          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
1395
          isNotFound = (renderOpts as any).isNotFound
J
JJ Kasper 已提交
1396 1397
        }

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

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

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

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

1451 1452
      if (!isDataReq) {
        let html: string
1453

1454 1455
        // Production already emitted the fallback as static HTML.
        if (isProduction) {
1456 1457 1458
          html = await this.incrementalCache.getFallback(
            locale ? `/${locale}${pathname}` : pathname
          )
1459 1460 1461 1462 1463 1464 1465 1466 1467
        }
        // 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
1468 1469
        }

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

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

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

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

1518 1519 1520
    if (isNotFound) {
      throw new NoFallbackError()
    }
1521
    return resHtml
1522 1523
  }

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

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

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

      if (err && err.code === 'DECODE_FAILED') {
        res.statusCode = 400
        return await this.renderErrorToHTML(err, req, res, pathname, query)
      }
1584 1585 1586 1587 1588
      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 已提交
1589 1590
  }

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

1609 1610 1611 1612 1613 1614 1615 1616 1617
  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 已提交
1618 1619 1620 1621 1622
  public async renderErrorToHTML(
    err: Error | null,
    req: IncomingMessage,
    res: ServerResponse,
    _pathname: string,
1623
    query: ParsedUrlQuery = {}
J
Joe Haddad 已提交
1624
  ) {
1625
    let result: null | FindComponentsResult = null
1626

1627 1628 1629
    const is404 = res.statusCode === 404
    let using404Page = false

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

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

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

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

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

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

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

1717 1718 1719 1720 1721 1722 1723 1724 1725
  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 已提交
1726
      userFilesStatic = recursiveReadDirSync(pathUserFilesStatic).map((f) =>
1727 1728 1729 1730 1731 1732
        join('.', 'static', f)
      )
    }

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

    let nextFilesStatic: string[] = []
    nextFilesStatic = recursiveReadDirSync(
      join(this.distDir, 'static')
J
Joe Haddad 已提交
1741
    ).map((f) => join('.', relative(this.dir, this.distDir), 'static', f))
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 1774 1775

    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 已提交
1776
    if (
1777 1778 1779
      (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 已提交
1780 1781 1782 1783
    ) {
      return false
    }

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

1790
  protected readBuildId(): string {
1791 1792 1793 1794 1795
    const buildIdFile = join(this.distDir, BUILD_ID_FILE)
    try {
      return fs.readFileSync(buildIdFile, 'utf8').trim()
    } catch (err) {
      if (!fs.existsSync(buildIdFile)) {
J
Joe Haddad 已提交
1796
        throw new Error(
1797
          `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 已提交
1798
        )
1799 1800 1801
      }

      throw err
1802
    }
1803
  }
1804

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

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

class NoFallbackError extends Error {}