Skip to content

feat(preview): allow setting compression options #20612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(preview): allow setting compression options #20612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/config/preview-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,10 @@ See [`server.cors`](./server-options#server-cors) for more details.
- **Type:** `OutgoingHttpHeaders`

Specify server response headers.

## preview.compression

- **Type:** `CompressionOptions`
- Default: `{ threshold: 1024, level: -1, brotli: false, gzip: true, mimes: /text|javascript|\/json|xml/i }`

Configure compression for files served by the preview server. See [`@polka/compression`](https://www.npmjs.com/package/@polka/compression#options) for more details.
18 changes: 14 additions & 4 deletions packages/vite/src/node/preview.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import fs from 'node:fs'
import path from 'node:path'
import sirv from 'sirv'
import compression from '@polka/compression'
import compression, {
type Options as CompressionOptions,
} from '@polka/compression'
import connect from 'connect'
import type { Connect } from 'dep-types/connect'
import corsMiddleware from 'cors'
Expand Down Expand Up @@ -46,10 +48,17 @@ import {
} from './server/pluginContainer'
import type { MinimalPluginContextWithoutEnvironment } from './plugin'

export interface PreviewOptions extends CommonServerOptions {}
export { type Options as CompressionOptions } from '@polka/compression'

export interface PreviewOptions extends CommonServerOptions {
compression?: CompressionOptions
}

export interface ResolvedPreviewOptions
extends RequiredExceptFor<PreviewOptions, 'host' | 'https' | 'proxy'> {}
extends RequiredExceptFor<
PreviewOptions,
'host' | 'https' | 'proxy' | 'compression'
> {}

export function resolvePreviewOptions(
preview: PreviewOptions | undefined,
Expand All @@ -68,6 +77,7 @@ export function resolvePreviewOptions(
proxy: preview?.proxy ?? server.proxy,
cors: preview?.cors ?? server.cors,
headers: preview?.headers ?? server.headers,
compression: preview?.compression,
}
}

Expand Down Expand Up @@ -224,7 +234,7 @@ export async function preview(
app.use(proxyMiddleware(httpServer, proxy, config))
}

app.use(compression())
app.use(compression(config.preview.compression))

// base
if (config.base !== '/') {
Expand Down
Loading