rsnext/packages/next/server/web-server.ts
Shu Ding cc5345bba8
Add proper headers to responses in web server (#34723)
This PR adds the `X-Powered-By` and `Content-Type` headers to responses sent by the web server. The latter enables compression for the Edge runtime. Still, the web server doesn't have `Content-Length` and `ETag` as the response is usually dynamic.

Part of #31506.

## Bug

- [x] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes by running `yarn lint`
2022-02-24 12:43:22 +00:00

207 lines
4.9 KiB
TypeScript

import type { WebNextRequest, WebNextResponse } from './base-http/web'
import type { RenderOpts } from './render'
import type RenderResult from './render-result'
import type { NextParsedUrlQuery } from './request-meta'
import type { Params } from './router'
import type { PayloadOptions } from './send-payload'
import type { LoadComponentsReturnType } from './load-components'
import BaseServer, { Options } from './base-server'
import { renderToHTML } from './render'
interface WebServerConfig {
loadComponent: (pathname: string) => Promise<LoadComponentsReturnType | null>
extendRenderOpts?: Partial<BaseServer['renderOpts']>
}
export default class NextWebServer extends BaseServer {
webServerConfig: WebServerConfig
constructor(options: Options & { webServerConfig: WebServerConfig }) {
super(options)
this.webServerConfig = options.webServerConfig
Object.assign(this.renderOpts, options.webServerConfig.extendRenderOpts)
}
protected generateRewrites() {
// @TODO: assuming minimal mode right now
return {
beforeFiles: [],
afterFiles: [],
fallback: [],
}
}
protected handleCompression() {
// @TODO
}
protected getRoutesManifest() {
return {
headers: [],
rewrites: {
fallback: [],
afterFiles: [],
beforeFiles: [],
},
redirects: [],
}
}
protected getPagePath() {
// @TODO
return ''
}
protected getPublicDir() {
// @TODO
return ''
}
protected getBuildId() {
return (globalThis as any).__server_context.buildId
}
protected loadEnvConfig() {
// @TODO
}
protected getHasStaticDir() {
return false
}
protected async hasMiddleware() {
return false
}
protected generateImageRoutes() {
return []
}
protected generateStaticRoutes() {
return []
}
protected generateFsStaticRoutes() {
return []
}
protected generatePublicRoutes() {
return []
}
protected getMiddleware() {
return []
}
protected generateCatchAllMiddlewareRoute() {
return undefined
}
protected getFontManifest() {
return undefined
}
protected getMiddlewareManifest() {
return undefined
}
protected getPagesManifest() {
return {
[(globalThis as any).__server_context.page]: '',
}
}
protected getFilesystemPaths() {
return new Set<string>()
}
protected getPrerenderManifest() {
return {
version: 3 as const,
routes: {},
dynamicRoutes: {},
notFoundRoutes: [],
preview: {
previewModeId: '',
previewModeSigningKey: '',
previewModeEncryptionKey: '',
},
}
}
protected getServerComponentManifest() {
// @TODO: Need to return `extendRenderOpts.serverComponentManifest` here.
return undefined
}
protected async renderHTML(
req: WebNextRequest,
_res: WebNextResponse,
pathname: string,
query: NextParsedUrlQuery,
renderOpts: RenderOpts
): Promise<RenderResult | null> {
return renderToHTML(
{
url: pathname,
cookies: req.cookies,
headers: req.headers,
} as any,
{} as any,
pathname,
query,
{
...renderOpts,
supportsDynamicHTML: true,
disableOptimizedLoading: true,
runtime: 'edge',
}
)
}
protected async sendRenderResult(
_req: WebNextRequest,
res: WebNextResponse,
options: {
result: RenderResult
type: 'html' | 'json'
generateEtags: boolean
poweredByHeader: boolean
options?: PayloadOptions | undefined
}
): Promise<void> {
// Add necessary headers.
// @TODO: Share the isomorphic logic with server/send-payload.ts.
if (options.poweredByHeader && options.type === 'html') {
res.setHeader('X-Powered-By', 'Next.js')
}
if (!res.getHeader('Content-Type')) {
res.setHeader(
'Content-Type',
options.type === 'json'
? 'application/json'
: 'text/html; charset=utf-8'
)
}
// @TODO
const writer = res.transformStream.writable.getWriter()
if (options.result.isDynamic()) {
options.result.pipe({
write: (chunk: Uint8Array) => writer.write(chunk),
end: () => writer.close(),
destroy: (err: Error) => writer.abort(err),
cork: () => {},
uncork: () => {},
// Not implemented: on/removeListener
} as any)
} else {
res.body(await options.result.toUnchunkedString())
}
res.send()
}
protected async runApi() {
// @TODO
return true
}
protected async findPageComponents(
pathname: string,
query?: NextParsedUrlQuery,
params?: Params | null
) {
const result = await this.webServerConfig.loadComponent(pathname)
if (!result) return null
return {
query: {
...(query || {}),
...(params || {}),
},
components: result,
}
}
public updateRenderOpts(renderOpts: Partial<BaseServer['renderOpts']>) {
Object.assign(this.renderOpts, renderOpts)
}
}