Files
meshcore-analyzer/cmd/server/compress_test.go
T
efiten caf3851ff8 feat(server): add opt-in HTTP gzip and WebSocket permessage-deflate compression (#934)
## Summary

- Adds `"compression": {"gzip": true, "websocket": true}` config option
(both `false` by default — no behavior change)
- HTTP gzip middleware wraps the entire router; skips WebSocket upgrade
requests and clients without `Accept-Encoding: gzip`
- WebSocket permessage-deflate enabled via
`hub.upgrader.EnableCompression` when `websocket: true`
- `CompressionConfig` struct and `GZipEnabled()` /
`WSCompressionEnabled()` helpers on `Config`
- `Hub.upgrader` moved from package-level var to struct field so tests
using `NewHub()` don't need changes

## Why opt-in / off by default

Operators behind a reverse proxy that already compresses (nginx, Caddy
with `encode gzip`) should leave this off to avoid double-compression.
Only enable when the proxy does **not** compress.

## Test plan

- [x] `TestCompressionConfigDefaults` — both helpers return false when
`Compression` is nil
- [x] `TestCompressionConfigExplicitFalse` — both helpers return false
when set to false
- [x] `TestCompressionConfigEnabled` — both helpers return true when set
to true
- [x] `TestGZipMiddlewareCompresses` — response body is valid gzip,
headers set correctly
- [x] `TestGZipMiddlewareSkipsNoAcceptEncoding` — passthrough when
client doesn't send Accept-Encoding: gzip
- [x] `TestGZipMiddlewareSkipsWebSocket` — WebSocket upgrades are never
gzip-wrapped

All 6 tests pass (`go test ./...` in `cmd/server`).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: OpenClaw Bot <bot@openclaw.local>
Co-authored-by: efiten-bot <bot@efiten.dev>
2026-05-21 11:39:49 -07:00

110 lines
3.0 KiB
Go

package main
import (
"compress/gzip"
"io"
"net/http"
"net/http/httptest"
"testing"
)
func TestCompressionConfigDefaults(t *testing.T) {
cfg := &Config{}
if cfg.GZipEnabled() {
t.Error("GZipEnabled should be false when compression is nil")
}
if cfg.WSCompressionEnabled() {
t.Error("WSCompressionEnabled should be false when compression is nil")
}
}
func TestCompressionConfigExplicitFalse(t *testing.T) {
cfg := &Config{Compression: &CompressionConfig{GZip: false, Websocket: false}}
if cfg.GZipEnabled() {
t.Error("GZipEnabled should be false")
}
if cfg.WSCompressionEnabled() {
t.Error("WSCompressionEnabled should be false")
}
}
func TestCompressionConfigEnabled(t *testing.T) {
cfg := &Config{Compression: &CompressionConfig{GZip: true, Websocket: true}}
if !cfg.GZipEnabled() {
t.Error("GZipEnabled should be true")
}
if !cfg.WSCompressionEnabled() {
t.Error("WSCompressionEnabled should be true")
}
}
func TestGZipMiddlewareCompresses(t *testing.T) {
body := `{"nodes":[{"id":"abc"}]}`
handler := gzipMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
w.Write([]byte(body))
}))
req := httptest.NewRequest("GET", "/api/nodes", nil)
req.Header.Set("Accept-Encoding", "gzip")
rr := httptest.NewRecorder()
handler.ServeHTTP(rr, req)
if rr.Header().Get("Content-Encoding") != "gzip" {
t.Errorf("expected Content-Encoding: gzip, got %q", rr.Header().Get("Content-Encoding"))
}
if rr.Header().Get("Vary") != "Accept-Encoding" {
t.Errorf("expected Vary: Accept-Encoding, got %q", rr.Header().Get("Vary"))
}
gz, err := gzip.NewReader(rr.Body)
if err != nil {
t.Fatalf("response is not valid gzip: %v", err)
}
defer gz.Close()
decoded, err := io.ReadAll(gz)
if err != nil {
t.Fatalf("reading gzip: %v", err)
}
if string(decoded) != body {
t.Errorf("decompressed body = %q, want %q", string(decoded), body)
}
}
func TestGZipMiddlewareSkipsNoAcceptEncoding(t *testing.T) {
handler := gzipMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("hello"))
}))
req := httptest.NewRequest("GET", "/api/nodes", nil)
rr := httptest.NewRecorder()
handler.ServeHTTP(rr, req)
if rr.Header().Get("Content-Encoding") != "" {
t.Errorf("expected no Content-Encoding, got %q", rr.Header().Get("Content-Encoding"))
}
if rr.Body.String() != "hello" {
t.Errorf("expected plain body, got %q", rr.Body.String())
}
}
func TestGZipMiddlewareSkipsWebSocket(t *testing.T) {
called := false
handler := gzipMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
called = true
w.Write([]byte("ws"))
}))
req := httptest.NewRequest("GET", "/ws", nil)
req.Header.Set("Accept-Encoding", "gzip")
req.Header.Set("Upgrade", "websocket")
rr := httptest.NewRecorder()
handler.ServeHTTP(rr, req)
if !called {
t.Error("expected next handler to be called")
}
if rr.Header().Get("Content-Encoding") != "" {
t.Errorf("WebSocket should not be gzip-encoded, got %q", rr.Header().Get("Content-Encoding"))
}
}