feat: replace brotli with zstd compression

Author: rexzhang

Dockerfile

@@ -21,7 +21,7 @@ COPY docker /app
 COPY requirements.d /app/requirements.d
 
 RUN \
-    # install python depends ---
+    # install python build depends ---
     apk add --no-cache --virtual .build-deps build-base libffi-dev \
     # --- LDAP
     openldap-dev krb5-dev \

README.md

@@ -25,7 +25,7 @@ An asynchronous WebDAV server implementation, Support multi-provider, multi-acco
 - Passed all [litmus(0.13)](http://www.webdav.org/neon/litmus) test, except 3 warning
 - Browse the file directory in the browser
 - Support HTTP Basic/Digest authentication
-- Support response in Gzip/Brotli
+- Support response in Gzip/Zstd
 - Compatible with macOS finder and Window10 Explorer
 
 ## Quickstart

TODO

@@ -12,6 +12,13 @@
         ☐ 更新文档 @wip
         ☐ 使用 TOML 方便添加注释的特性, 增加各种使用场景配置范例 @long-term
         ☐ 以 TOML 下的可读性为标准,适当调整配置文件结构 @long-term
+    ☐ 重构 DAVResponse
+        ☐ 统一 401 的响应行为 @high @next-release
+        ☐ 浏览器请求才弹认证请求框, 服务器返回 401 时不弹认证框
+        ☐ 重构部分 DAVResponse 代码, 这个与压缩依赖部分一起修改
+        ☐ 顺带解决 litmus 的一个告警?
+        ✔ 移除 brotli 压缩方法 @done(25-11-14)
+        ✔ 添加sztd支持 @done(25-11-14)
     ☐ 浏览器后台(内部)界面 @low
         ☐ info界面
             ☐ /_/admin/INDEX
@@ -48,12 +55,7 @@
 
 待实现:
     ☐ 基于配置,检查依赖安装情况,以便在启动时告警
-    ☐ 兼容 Py3.14
-    ☐ 重构 DAVResponse 来统一 401 的响应行为 @high @next-release
-        ☐ 浏览器请求才弹认证请求框, 服务器返回 401 时不弹认证框
-        ☐ 重构部分 DAVResponse 代码, 这个与压缩依赖部分一起修改
-        ☐ 顺带解决 litmus 的一个告警?
-    ☐ 移除第三方压缩依赖,添加sztd支持 @block dataclass-wizard 不兼容 py3.14
+    ☐ 兼容 Py3.14  @block dataclass-wizard 不兼容 py3.14
     ☐ 更新 xmltodict 到最新版本
         这个上游库变化非常大, 之前版本与现在版本不兼容
     ☐ 浏览器前台界面 @low

asgi_webdav/config.py

@@ -118,7 +118,8 @@ class TextFileCharsetDetect:
 class Compression:
     enable: bool = True
     enable_gzip: bool = True
-    enable_brotli: bool = True
+    enable_zstd: bool = True
+
     level: DAVCompressLevel = DAVCompressLevel.RECOMMEND
 
     content_type_user_rule: str = ""

asgi_webdav/constants.py

@@ -315,19 +315,7 @@ def __repr__(self):
 
 RESPONSE_DATA_BLOCK_SIZE = 64 * 1024
 
-
-class DAVAcceptEncoding:
-    # https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/Content-Encoding
-    # https://caniuse.com/?search=gzip
-    # identity
-    gzip: bool = False
-    br: bool = False
-
-    def __repr__(self):
-        return f"gzip:{self.gzip}, br:{self.br}"
-
-
-DEFAULT_COMPRESSION_CONTENT_MINIMUM_LENGTH = 1000  # bytes
+DEFAULT_COMPRESSION_CONTENT_MINIMUM_LENGTH = 1024  # bytes
 DEFAULT_COMPRESSION_CONTENT_TYPE_RULE = r"^application/xml$|^text/"
 
 

asgi_webdav/request.py

@@ -9,7 +9,6 @@
 
 from asgi_webdav.constants import (
     DAV_PROPERTY_BASIC_KEYS,
-    DAVAcceptEncoding,
     DAVDepth,
     DAVHeaders,
     DAVLockScope,
@@ -92,7 +91,7 @@ def path(self) -> DAVPath:
     authorization_method: str | None = None
 
     # response info
-    accept_encoding: DAVAcceptEncoding = field(default_factory=DAVAcceptEncoding)
+    accept_encoding: str = ""
 
     def __post_init__(self):
         self.method = self.scope.get("method", DAVMethod.UNKNOWN)
@@ -212,12 +211,10 @@ def __post_init__(self):
             else:
                 self.lock_token = lock_token
 
+        # header: accept-encoding
         accept_encoding = self.headers.get(b"accept-encoding")
         if accept_encoding:
-            if b"br" in accept_encoding:
-                self.accept_encoding.br = True
-            if b"gzip" in accept_encoding:
-                self.accept_encoding.gzip = True
+            self.accept_encoding = accept_encoding.decode("utf-8")
 
         # header: range
         if self.method == DAVMethod.GET:

asgi_webdav/response.py

@@ -2,11 +2,16 @@
 import gzip
 import pprint
 import re
+import sys
 from collections.abc import AsyncGenerator
 from enum import Enum
-from io import BytesIO
 from logging import getLogger
 
+if sys.version_info >= (3, 14):
+    import zstd
+else:
+    from backports import zstd
+
 from asgi_webdav.config import Config, get_config
 from asgi_webdav.constants import (
     DEFAULT_COMPRESSION_CONTENT_MINIMUM_LENGTH,
@@ -17,11 +22,6 @@
 from asgi_webdav.helpers import get_data_generator_from_content
 from asgi_webdav.request import DAVRequest
 
-try:
-    import brotli
-except ImportError:
-    brotli = None
-
 logger = getLogger(__name__)
 
 
@@ -32,9 +32,15 @@ class DAVResponseType(Enum):
 
 
 class DAVCompressionMethod(Enum):
-    NONE = 0
-    GZIP = 1
-    BROTLI = 2
+    """
+    Python 3.11 才支持 StrEnum
+        然后使用 auto() 生成期望的枚举值
+        并可以不使用 .value 做匹配
+    """
+
+    NONE = "none"
+    GZIP = "gzip"
+    ZSTD = "zstd"
 
 
 class DAVResponse:
@@ -44,7 +50,7 @@ class DAVResponse:
     headers: dict[bytes, bytes]
     compression_method: DAVCompressionMethod
 
-    def get_content(self):
+    def get_content(self) -> AsyncGenerator:
         return self._content
 
     def set_content(self, value: bytes | AsyncGenerator):
@@ -144,17 +150,23 @@ async def send_in_one_call(self, request: DAVRequest):
             config.compression.content_type_user_rule,
         ):
             if (
-                brotli is not None
-                and config.compression.enable_brotli
-                and request.accept_encoding.br
+                config.compression.enable_zstd
+                and DAVCompressionMethod.ZSTD.value in request.accept_encoding
             ):
-                self.compression_method = DAVCompressionMethod.BROTLI
-                await BrotliSender(self, config.compression.level).send(request)
+                self.compression_method = DAVCompressionMethod.ZSTD
+                await CompressionSenderZstd(self, config.compression.level).send(
+                    request
+                )
                 return
 
-            if config.compression.enable_gzip and request.accept_encoding.gzip:
+            if (
+                config.compression.enable_gzip
+                and DAVCompressionMethod.GZIP.value in request.accept_encoding
+            ):
                 self.compression_method = DAVCompressionMethod.GZIP
-                await GzipSender(self, config.compression.level).send(request)
+                await CompressionSenderGzip(self, config.compression.level).send(
+                    request
+                )
                 return
 
         self.compression_method = DAVCompressionMethod.NONE
@@ -228,12 +240,12 @@ class CompressionSenderAbc:
 
     def __init__(self, response: DAVResponse):
         self.response = response
-        self.buffer = BytesIO()
+        # self.buffer = BytesIO()
 
-    def write(self, body: bytes):
+    def compress(self, body: bytes) -> bytes:
         raise NotImplementedError
 
-    def close(self):
+    def flush(self) -> bytes:
         raise NotImplementedError
 
     async def send(self, request: DAVRequest):
@@ -250,13 +262,10 @@ async def send(self, request: DAVRequest):
         first = True
         async for body, more_body in self.response.content:
             # get and compress body
-            self.write(body)
-            if not more_body:
-                self.close()
-            body = self.buffer.getvalue()
 
-            self.buffer.seek(0)
-            self.buffer.truncate()
+            data = self.compress(body)
+            if not more_body:
+                data += self.flush()
 
             if first:
                 first = False
@@ -288,16 +297,17 @@ async def send(self, request: DAVRequest):
             await request.send(
                 {
                     "type": "http.response.body",
-                    "body": body,
+                    "body": data,
                     "more_body": more_body,
                 }
             )
 
 
-class GzipSender(CompressionSenderAbc):
+class CompressionSenderGzip(CompressionSenderAbc):
     """
     https://en.wikipedia.org/wiki/Gzip
     https://developer.mozilla.org/en-US/docs/Glossary/GZip_compression
+    https://docs.python.org/3.14/library/gzip.html
     """
 
     def __init__(self, response: DAVResponse, compress_level: DAVCompressLevel):
@@ -311,23 +321,21 @@ def __init__(self, response: DAVResponse, compress_level: DAVCompressLevel):
             level = 4
 
         self.name = b"gzip"
-        self.compressor = gzip.GzipFile(
-            mode="wb", compresslevel=level, fileobj=self.buffer
-        )
+        self._level = level
 
-    def write(self, body: bytes):
-        self.compressor.write(body)
+    def compress(self, body: bytes) -> bytes:
+        return gzip.compress(body, compresslevel=self._level)
 
-    def close(self):
-        self.compressor.close()
+    def flush(self) -> bytes:
+        return b""
 
 
-class BrotliSender(CompressionSenderAbc):
+class CompressionSenderZstd(CompressionSenderAbc):
     """
-    https://datatracker.ietf.org/doc/html/rfc7932
-    https://github.com/google/brotli
-    https://caniuse.com/brotli
-    https://developer.mozilla.org/en-US/docs/Glossary/brotli_compression
+    https://en.wikipedia.org/wiki/Zstd
+    https://facebook.github.io/zstd/
+    https://developer.mozilla.org/en-US/docs/Glossary/Zstandard_compression
+    https://docs.python.org/zh-cn/3.14/library/compression.zstd.html
     """
 
     def __init__(self, response: DAVResponse, compress_level: DAVCompressLevel):
@@ -336,19 +344,18 @@ def __init__(self, response: DAVResponse, compress_level: DAVCompressLevel):
         if compress_level == DAVCompressLevel.FAST:
             level = 1
         elif compress_level == DAVCompressLevel.BEST:
-            level = 11
+            level = 19
         else:
-            level = 4
+            level = 3  # compression.zstd.COMPRESSION_LEVEL_DEFAULT
 
-        self.name = b"br"
-        self.compressor = brotli.Compressor(mode=brotli.MODE_TEXT, quality=level)
+        self.name = b"zstd"
+        self._compressor = zstd.ZstdCompressor(level=level)
 
-    def write(self, body: bytes):
-        # https://github.com/google/brotli/blob/master/python/brotli.py
-        self.buffer.write(self.compressor.process(body))
+    def compress(self, body: bytes) -> bytes:
+        return self._compressor.compress(body)
 
-    def close(self):
-        self.buffer.write(self.compressor.finish())
+    def flush(self) -> bytes:
+        return self._compressor.flush()
 
 
 class DAVHideFileInDir:

docs/changelog.en.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.7.0
+
+- Broken change:
+  - remove brotli support
+- feat: support zstd compression in response
+
 ## 1.6.1 - 20251101
 
 - fix(docker): ldap depend miss

docs/index.en.md

@@ -25,7 +25,7 @@ An asynchronous WebDAV server implementation, Support multi-provider, multi-acco
 - Passed all [litmus(0.13)](http://www.webdav.org/neon/litmus) test, except 3 warning
 - Browse the file directory in the browser
 - Support HTTP Basic/Digest authentication
-- Support response in Gzip/Brotli
+- Support response in Gzip/Zstd
 - Compatible with macOS finder and Window10 Explorer
 
 ## Quick Start

docs/index.zh.md

@@ -25,7 +25,7 @@
 - 通过 WebDAV 官方的 [litmus(0.13)](http://www.webdav.org/neon/litmus) 测试, 仅有两个警告
 - 可在浏览器中浏览文件目录
 - 支持 HTTP Basic/Digest 认证
-- 支持 Gzip/Brotli 压缩
+- 支持 Gzip/Zstd 压缩
 - 兼容 macOS 访达/ Window10
   Explorer [等客户端](https://rexzhang.github.io/asgi-webdav/compatibility/#compatible-clients)