Skip to content

Commit

Permalink
encode: good defaults (#6737)
Browse files Browse the repository at this point in the history
* feat: good default for encode

* fix tests and add a new one
  • Loading branch information
dunglas authored Dec 10, 2024
1 parent 290cfea commit d0e209e
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 15 deletions.
13 changes: 13 additions & 0 deletions caddytest/integration/caddyfile_adapt/encode_options.caddyfiletest
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ encode {
zstd
gzip 5
}

encode
----------
{
"apps": {
Expand Down Expand Up @@ -76,6 +78,17 @@ encode {
"zstd",
"gzip"
]
},
{
"encodings": {
"gzip": {},
"zstd": {}
},
"handler": "encode",
"prefer": [
"zstd",
"gzip"
]
}
]
}
Expand Down
36 changes: 21 additions & 15 deletions modules/caddyhttp/encode/caddyfile.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,21 +57,7 @@ func (enc *Encode) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
d.Next() // consume directive name

prefer := []string{}
for _, arg := range d.RemainingArgs() {
mod, err := caddy.GetModule("http.encoders." + arg)
if err != nil {
return d.Errf("finding encoder module '%s': %v", mod, err)
}
encoding, ok := mod.New().(Encoding)
if !ok {
return d.Errf("module %s is not an HTTP encoding", mod)
}
if enc.EncodingsRaw == nil {
enc.EncodingsRaw = make(caddy.ModuleMap)
}
enc.EncodingsRaw[arg] = caddyconfig.JSON(encoding, nil)
prefer = append(prefer, arg)
}
remainingArgs := d.RemainingArgs()

responseMatchers := make(map[string]caddyhttp.ResponseMatcher)
for d.NextBlock(0) {
Expand Down Expand Up @@ -111,6 +97,26 @@ func (enc *Encode) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
}
}

if len(prefer) == 0 && len(remainingArgs) == 0 {
remainingArgs = []string{"zstd", "gzip"}
}

for _, arg := range remainingArgs {
mod, err := caddy.GetModule("http.encoders." + arg)
if err != nil {
return d.Errf("finding encoder module '%s': %v", mod, err)
}
encoding, ok := mod.New().(Encoding)
if !ok {
return d.Errf("module %s is not an HTTP encoding", mod)
}
if enc.EncodingsRaw == nil {
enc.EncodingsRaw = make(caddy.ModuleMap)
}
enc.EncodingsRaw[arg] = caddyconfig.JSON(encoding, nil)
prefer = append(prefer, arg)
}

// use the order in which the encoders were defined.
enc.Prefer = prefer

Expand Down

0 comments on commit d0e209e

Please sign in to comment.