feat(rspeedy): Support server.compress

.changeset/evil-pigs-doubt.md

@@ -0,0 +1,5 @@
+---
+"@lynx-js/rspeedy": patch
+---
+
+Support `server.compress`

packages/rspeedy/core/etc/rspeedy.api.md

@@ -4,6 +4,7 @@
 
 ```ts
 
+import type { CompressOptions } from '@rsbuild/core';
 import type { CreateRsbuildOptions } from '@rsbuild/core';
 import type { DataUriLimit } from '@rsbuild/core';
 import type { DistPathConfig } from '@rsbuild/core';
@@ -304,6 +305,7 @@ export type RspeedyInstance = RsbuildInstance & {
 // @public
 export interface Server {
     base?: string | undefined;
+    compress?: boolean | CompressOptions | undefined;
     headers?: Record<string, string | string[]> | undefined;
     host?: string | undefined;
     port?: number | undefined;

packages/rspeedy/core/src/config/rsbuild/index.ts

@@ -88,6 +88,8 @@ export function toRsbuildConfig(
     server: {
       base: config.server?.base,
 
+      compress: config.server?.compress,
+
       headers: config.server?.headers,
 
       host: config.server?.host,

packages/rspeedy/core/src/config/server/index.ts

@@ -2,7 +2,7 @@
 // Licensed under the Apache License Version 2.0 that can be found in the
 // LICENSE file in the root directory of this source tree.
 
-import type { ProxyConfig } from '@rsbuild/core'
+import type { CompressOptions, ProxyConfig } from '@rsbuild/core'
 
 /**
  * {@inheritdoc Config.server}
@@ -32,6 +32,60 @@ export interface Server {
    */
   base?: string | undefined
 
+  /**
+   * Configure whether to enable {@link https://developer.mozilla.org/en-US/docs/Glossary/gzip_compression | gzip compression } for static assets served by the dev server or preview server.
+   *
+   * Default: true
+   *
+   * See {@link https://rsbuild.rs/config/server/compress | Rsbuild - server.compress } for details.
+   *
+   * @example
+   *
+   * To disable the gzip compression, set compress to false:
+   *
+   * ```js
+   * export default {
+   *   server: {
+   *     compress: false,
+   *   },
+   * }
+   * ```
+   *
+   * @example
+   *
+   * Compress if it starts with /foo
+   *
+   * ```js
+   * export default {
+   *   server: {
+   *     compress: {
+   *       filter: (req) => {
+   *         if (req.url?.includes('/foo')) {
+   *           return false;
+   *         }
+   *         return true;
+   *       },
+   *     },
+   *   },
+   * }
+   * ```
+   *
+   * @example
+   *
+   * set level of zlib compression
+   *
+   * ```js
+   * export default {
+   *   server: {
+   *     compress: {
+   *       level: 6,
+   *     },
+   *   },
+   * }
+   * ```
+   */
+  compress?: boolean | CompressOptions | undefined
+
   /**
    * Adds headers to all responses.
    *

packages/rspeedy/core/test/config/rsbuild.test.ts

@@ -1,6 +1,8 @@
 // Copyright 2024 The Lynx Authors. All rights reserved.
 // Licensed under the Apache License Version 2.0 that can be found in the
 // LICENSE file in the root directory of this source tree.
+import type { IncomingMessage } from 'node:http'
+
 import type { RsbuildPlugin } from '@rsbuild/core'
 import { describe, expect, test } from 'vitest'
 
@@ -618,6 +620,64 @@ describe('Config - toRsBuildConfig', () => {
     })
   })
 
+  describe('Server', () => {
+    test('transform server.compress: undefined (no server)', () => {
+      const rsbuildConfig = toRsbuildConfig({})
+      expect(rsbuildConfig.server?.compress).toBeUndefined()
+    })
+
+    test('transform server.compress: undefined (empty server)', () => {
+      const rsbuildConfig = toRsbuildConfig({ server: {} })
+      expect(rsbuildConfig.server?.compress).toBeUndefined()
+    })
+
+    test('transform server.compress: false', () => {
+      const rsbuildConfig = toRsbuildConfig({
+        server: { compress: false },
+      })
+      expect(rsbuildConfig.server?.compress).toBe(false)
+    })
+
+    test('transform server.compress: true', () => {
+      const rsbuildConfig = toRsbuildConfig({
+        server: { compress: true },
+      })
+      expect(rsbuildConfig.server?.compress).toBe(true)
+    })
+
+    test('transform server.compress: { level } object format', () => {
+      const rsbuildConfig = toRsbuildConfig({
+        server: { compress: { level: 6 } },
+      })
+      expect(rsbuildConfig.server?.compress).toMatchInlineSnapshot(`
+        {
+          "level": 6,
+        }
+      `)
+    })
+
+    test('transform server.compress: { filter } object format', () => {
+      const filter = (req: IncomingMessage) =>
+        !(req.url ?? '').startsWith('/nozip')
+      const rsbuildConfig = toRsbuildConfig({
+        server: { compress: { filter } },
+      })
+      expect(
+        rsbuildConfig.server
+          && typeof rsbuildConfig.server.compress === 'object',
+      ).toBe(true)
+      const compress = rsbuildConfig.server!.compress as {
+        filter: typeof filter
+      }
+      expect(typeof compress.filter).toBe('function')
+      const expectFunction = compress.filter
+      expect(expectFunction({ url: '/nozip/a.js' } as IncomingMessage)).toBe(
+        false,
+      )
+      expect(expectFunction({ url: '/ok/b.js' } as IncomingMessage)).toBe(true)
+    })
+  })
+
   describe('Source', () => {
     test('transform empty source.alias', () => {
       const rsbuildConfig = toRsbuildConfig({

packages/rspeedy/core/test/config/server.test-d.ts

@@ -14,6 +14,23 @@ describe('Config - Server', () => {
     assertType<Server>({ base: '/foo' })
   })
 
+  test('server.compress', () => {
+    assertType<Server>({})
+    assertType<Server>({ compress: undefined })
+    assertType<Server>({ compress: false })
+    assertType<Server>({ compress: true })
+    assertType<Server>({ compress: { level: 1 } })
+    assertType<Server>({
+      compress: {
+        filter: (req, res) => {
+          assertType<IncomingMessage>(req)
+          assertType<ServerResponse>(res)
+          return true
+        },
+      },
+    })
+  })
+
   test('server.headers', () => {
     assertType<Server>({})
     assertType<Server>({