From 341d4fb8059f6aad5d371514fb851256add327cf Mon Sep 17 00:00:00 2001 From: Matthew Holt Date: Tue, 24 Mar 2020 10:37:47 -0600 Subject: [PATCH] Remove some non-essential plugins from this repo (#2780) Brotli encoder, jsonc and json5 config adapters, and the unfinished HTTP cache handler are removed. They will be available in separate repos. --- caddyconfig/json5/json5.go | 43 ---- caddyconfig/jsonc/jsonc.go | 49 ---- go.mod | 12 +- go.sum | 24 +- modules/caddyhttp/encode/brotli/brotli.go | 95 ------- modules/caddyhttp/encode/caddyfile.go | 1 - modules/caddyhttp/httpcache/httpcache.go | 242 ------------------ modules/caddyhttp/requestbody/requestbody.go | 2 +- .../caddyhttp/reverseproxy/circuitbreaker.go | 20 +- modules/caddyhttp/standard/imports.go | 2 - modules/standard/import.go | 2 - 11 files changed, 27 insertions(+), 465 deletions(-) delete mode 100644 caddyconfig/json5/json5.go delete mode 100644 caddyconfig/jsonc/jsonc.go delete mode 100644 modules/caddyhttp/encode/brotli/brotli.go delete mode 100644 modules/caddyhttp/httpcache/httpcache.go diff --git a/caddyconfig/json5/json5.go b/caddyconfig/json5/json5.go deleted file mode 100644 index 2c863013..00000000 --- a/caddyconfig/json5/json5.go +++ /dev/null @@ -1,43 +0,0 @@ -// Copyright 2015 Matthew Holt and The Caddy Authors -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package json5adapter - -import ( - "encoding/json" - - "github.com/caddyserver/caddy/v2/caddyconfig" - "github.com/ilibs/json5" -) - -func init() { - caddyconfig.RegisterAdapter("json5", Adapter{}) -} - -// Adapter adapts JSON5 to Caddy JSON. -type Adapter struct{} - -// Adapt converts the JSON5 config in body to Caddy JSON. -func (a Adapter) Adapt(body []byte, options map[string]interface{}) (result []byte, warnings []caddyconfig.Warning, err error) { - var decoded interface{} - err = json5.Unmarshal(body, &decoded) - if err != nil { - return - } - result, err = json.Marshal(decoded) - return -} - -// Interface guard -var _ caddyconfig.Adapter = (*Adapter)(nil) diff --git a/caddyconfig/jsonc/jsonc.go b/caddyconfig/jsonc/jsonc.go deleted file mode 100644 index 4f72c054..00000000 --- a/caddyconfig/jsonc/jsonc.go +++ /dev/null @@ -1,49 +0,0 @@ -// Copyright 2015 Matthew Holt and The Caddy Authors -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package jsoncadapter - -import ( - "encoding/json" - - "github.com/caddyserver/caddy/v2/caddyconfig" - "github.com/muhammadmuzzammil1998/jsonc" -) - -func init() { - caddyconfig.RegisterAdapter("jsonc", Adapter{}) -} - -// Adapter adapts JSON-C to Caddy JSON. -type Adapter struct{} - -// Adapt converts the JSON-C config in body to Caddy JSON. -func (a Adapter) Adapt(body []byte, options map[string]interface{}) (result []byte, warnings []caddyconfig.Warning, err error) { - result = jsonc.ToJSON(body) - - // any errors in the JSON will be - // reported during config load, but - // we can at least warn here that - // it is not valid JSON - if !json.Valid(result) { - warnings = append(warnings, caddyconfig.Warning{ - Message: "Resulting JSON is invalid.", - }) - } - - return -} - -// Interface guard -var _ caddyconfig.Adapter = (*Adapter)(nil) diff --git a/go.mod b/go.mod index 3949910a..06dd81f1 100644 --- a/go.mod +++ b/go.mod @@ -5,32 +5,28 @@ go 1.14 require ( github.com/Masterminds/sprig/v3 v3.0.2 github.com/alecthomas/chroma v0.7.2-0.20200305040604-4f3623dce67a - github.com/andybalholm/brotli v1.0.0 github.com/caddyserver/certmagic v0.10.4 github.com/dustin/go-humanize v1.0.1-0.20200219035652-afde56e7acac github.com/go-acme/lego/v3 v3.5.0 - github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e github.com/google/cel-go v0.4.0 - github.com/ilibs/json5 v1.0.1 github.com/jsternberg/zap-logfmt v1.2.0 github.com/klauspost/compress v1.10.3 github.com/klauspost/cpuid v1.2.3 github.com/lucas-clemente/quic-go v0.15.2 github.com/manifoldco/promptui v0.7.0 // indirect github.com/miekg/dns v1.1.29 // indirect - github.com/muhammadmuzzammil1998/jsonc v0.0.0-20200303171503-1e787b591db7 github.com/naoina/go-stringutil v0.1.0 // indirect github.com/naoina/toml v0.1.1 github.com/smallstep/certificates v0.14.0-rc.5 github.com/smallstep/cli v0.14.0-rc.3 github.com/smallstep/truststore v0.9.4 - github.com/vulcand/oxy v1.0.0 + github.com/vulcand/oxy v1.1.0 github.com/yuin/goldmark v1.1.25 github.com/yuin/goldmark-highlighting v0.0.0-20200307114337-60d527fdb691 go.uber.org/zap v1.14.1 - golang.org/x/crypto v0.0.0-20200317142112-1b76d66859c6 - golang.org/x/net v0.0.0-20200319234117-63522dbf7eec - google.golang.org/genproto v0.0.0-20200305110556-506484158171 + golang.org/x/crypto v0.0.0-20200323165209-0ec3e9974c59 + golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e + google.golang.org/genproto v0.0.0-20200323114720-3f67cca34472 gopkg.in/natefinch/lumberjack.v2 v2.0.0 gopkg.in/square/go-jose.v2 v2.4.1 // indirect gopkg.in/yaml.v2 v2.2.8 diff --git a/go.sum b/go.sum index 3df1a909..2eea89d7 100644 --- a/go.sum +++ b/go.sum @@ -100,8 +100,6 @@ github.com/alecthomas/units v0.0.0-20190717042225-c3de453c63f4/go.mod h1:ybxpYRF github.com/aliyun/alibaba-cloud-sdk-go v0.0.0-20190808125512-07798873deee h1:NYqDBPkhVYt68W3yoGoRRi32i3MLx2ey7SFkJ1v/UI0= github.com/aliyun/alibaba-cloud-sdk-go v0.0.0-20190808125512-07798873deee/go.mod h1:myCDvQSzCW+wB1WAlocEru4wMGJxy+vlxHdhegi1CDQ= github.com/aliyun/aliyun-oss-go-sdk v0.0.0-20190307165228-86c17b95fcd5/go.mod h1:T/Aws4fEfogEE9v+HPhhw+CntffsBHJ8nXQCwKr0/g8= -github.com/andybalholm/brotli v1.0.0 h1:7UCwP93aiSfvWpapti8g88vVVGp2qqtGyePsSuDafo4= -github.com/andybalholm/brotli v1.0.0/go.mod h1:loMXtMfwqflxFJPmdbJO0a3KNoPuLBgiu3qAvBg8x/Y= github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239/go.mod h1:2FmKhYUyUczH0OGQWaF5ceTx0UBShxjsH6f8oGKYe2c= github.com/antihax/optional v0.0.0-20180407024304-ca021399b1a6/go.mod h1:V8iCPQYkqmusNa815XgQio277wI47sdRh1dUOLdyC6Q= github.com/antlr/antlr4 v0.0.0-20190819145818-b43a4c3a8015 h1:StuiJFxQUsxSCzcby6NFZRdEhPkXD5vxN7TZ4MD6T84= @@ -344,6 +342,7 @@ github.com/gorilla/mux v1.7.3/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2z github.com/gorilla/securecookie v1.1.1/go.mod h1:ra0sb63/xPlUeL+yeDciTfxMRAA+MP+HVt/4epWDjd4= github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ= github.com/gorilla/websocket v1.4.1/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= +github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= github.com/gostaticanalysis/analysisutil v0.0.0-20190318220348-4088753ea4d3/go.mod h1:eEOZF4jCKGi+aprrirO9e7WKB3beBRtWgqGunKl6pKE= github.com/gostaticanalysis/analysisutil v0.0.3/go.mod h1:eEOZF4jCKGi+aprrirO9e7WKB3beBRtWgqGunKl6pKE= github.com/gravitational/trace v0.0.0-20190726142706-a535a178675f/go.mod h1:RvdOUHE4SHqR3oXlFFKnGzms8a5dugHygGw1bqDstYI= @@ -368,8 +367,6 @@ github.com/huandu/xstrings v1.2.0/go.mod h1:DvyZB1rfVYsBIigL8HwpZgxHwXozlTgGqn63 github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= github.com/icrowley/fake v0.0.0-20180203215853-4178557ae428/go.mod h1:uhpZMVGznybq1itEKXj6RYw9I71qK4kH+OGMjRC4KEo= github.com/iij/doapi v0.0.0-20190504054126-0bbf12d6d7df/go.mod h1:QMZY7/J/KSQEhKWFeDesPjMj+wCHReeknARU3wqlyN4= -github.com/ilibs/json5 v1.0.1 h1:3e14wUQM8PyK6Hf1bM+zAQFxfG+N5oZj35x5vCNeQ58= -github.com/ilibs/json5 v1.0.1/go.mod h1:kXsGuzHMPuZZTN15l0IQzy5PR8DrDhPB24tFgwpdKME= github.com/imdario/mergo v0.3.7/go.mod h1:2EnlNZ0deacrJVfApfmtdGgDfMuh/nq6Ok1EcJh5FfA= github.com/imdario/mergo v0.3.8 h1:CGgOkSJeqMRmt0D9XLWExdT4m4F1vd3FV3VPt+0VxkQ= github.com/imdario/mergo v0.3.8/go.mod h1:2EnlNZ0deacrJVfApfmtdGgDfMuh/nq6Ok1EcJh5FfA= @@ -498,8 +495,6 @@ github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3Rllmb github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826/go.mod h1:TaXosZuwdSHYgviHp1DAtfrULt5eUgsSMsZf+YrPgl8= github.com/mozilla/tls-observatory v0.0.0-20180409132520-8791a200eb40/go.mod h1:SrKMQvPiws7F7iqYp8/TX+IhxCYhzr6N/1yb8cwHsGk= github.com/mozilla/tls-observatory v0.0.0-20190404164649-a3c1b6cfecfd/go.mod h1:SrKMQvPiws7F7iqYp8/TX+IhxCYhzr6N/1yb8cwHsGk= -github.com/muhammadmuzzammil1998/jsonc v0.0.0-20200303171503-1e787b591db7 h1:IhnWtz7gaLvL0wn8xr86ERSvSmwNAsaHMRAqgsu/CVQ= -github.com/muhammadmuzzammil1998/jsonc v0.0.0-20200303171503-1e787b591db7/go.mod h1:saF2fIVw4banK0H4+/EuqfFLpRnoy5S+ECwTOCcRcSU= github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= github.com/namedotcom/go v0.0.0-20180403034216-08470befbe04/go.mod h1:5sN+Lt1CaY4wsPvgQH/jsuJi4XO2ssZbdsIizr4CVC8= github.com/naoina/go-stringutil v0.1.0 h1:rCUeRUHjBjGTSHl0VC00jUPLz8/F9dDzYI70Hzifhks= @@ -750,8 +745,8 @@ github.com/valyala/quicktemplate v1.2.0/go.mod h1:EH+4AkTd43SvgIbQHYu59/cJyxDoOV github.com/valyala/tcplisten v0.0.0-20161114210144-ceec8f93295a/go.mod h1:v3UYOV9WzVtRmSR+PDvWpU/qWl4Wa5LApYYX4ZtKbio= github.com/viant/assertly v0.4.8/go.mod h1:aGifi++jvCrUaklKEKT0BU95igDNaqkvz+49uaYMPRU= github.com/viant/toolbox v0.24.0/go.mod h1:OxMCG57V0PXuIP2HNQrtJf2CjqdmbrOx5EkMILuUhzM= -github.com/vulcand/oxy v1.0.0 h1:7vL5/pjDFzHGbtBEhmlHITUi6KLH4xXTDF33/wrdRKw= -github.com/vulcand/oxy v1.0.0/go.mod h1:6EXgOAl6CRa46/2ZGcDJKf3ywJUp5WtT7vSlGSkvecI= +github.com/vulcand/oxy v1.1.0 h1:DbBijGo1+6cFqR9jarkMxasdj0lgWwrrFtue6ijek4Q= +github.com/vulcand/oxy v1.1.0/go.mod h1:ADiMYHi8gkGl2987yQIzDRoXZilANF4WtKaQ92OppKY= github.com/vulcand/predicate v1.1.0/go.mod h1:mlccC5IRBoc2cIFmCB8ZM62I3VDb6p2GXESMHa3CnZg= github.com/vultr/govultr v0.1.4/go.mod h1:9H008Uxr/C4vFNGLqKx232C206GL0PBHzOP0809bGNA= github.com/weppos/publicsuffix-go v0.4.0/go.mod h1:z3LCPQ38eedDQSwmsSRW4Y7t2L8Ln16JPQ02lHAdn5k= @@ -824,8 +819,8 @@ golang.org/x/crypto v0.0.0-20191227163750-53104e6ec876/go.mod h1:LzIPMQfyMNhhGPh golang.org/x/crypto v0.0.0-20200221231518-2aa609cf4a9d/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073 h1:xMPOj6Pz6UipU1wXLkrtqpHbR0AVFnyPEQq/wRWz9lM= golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= -golang.org/x/crypto v0.0.0-20200317142112-1b76d66859c6 h1:TjszyFsQsyZNHwdVdZ5m7bjmreu0znc2kRYsEml9/Ww= -golang.org/x/crypto v0.0.0-20200317142112-1b76d66859c6/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/crypto v0.0.0-20200323165209-0ec3e9974c59 h1:3zb4D3T4G8jdExgVU/95+vQXfpEPiMdCaZgmGVxjNHM= +golang.org/x/crypto v0.0.0-20200323165209-0ec3e9974c59/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8= @@ -896,8 +891,8 @@ golang.org/x/net v0.0.0-20200222125558-5a598a2470a0/go.mod h1:z5CRVTTTmAJ677TzLL golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200301022130-244492dfa37a h1:GuSPYbZzB5/dcLNCwLQLsg3obCJtX9IJhpXkvY7kzk0= golang.org/x/net v0.0.0-20200301022130-244492dfa37a/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= -golang.org/x/net v0.0.0-20200319234117-63522dbf7eec h1:w0SItUiQ4sBiXBAwWNkyu8Fu2Qpn/dtDIcoPkPDqjRw= -golang.org/x/net v0.0.0-20200319234117-63522dbf7eec/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e h1:3G+cUijn7XD+S4eJFddp53Pv7+slrESplyjG25HgL+k= +golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20181017192945-9dcd33a902f4/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20181203162652-d668ce993890/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= @@ -963,6 +958,8 @@ golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae h1:/WDfKMnPU+m5M4xB+6x4kaepx golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527 h1:uYVVQ9WP/Ds2ROhcaGPeIdVq0RIXVLwsHlnvJ+cT1So= golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd h1:xhmwyvizuTgC2qz7ZlMluP20uW+C3Rm0FD/WLDX8884= +golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.0.0-20170915090833-1cbadb444a80/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= @@ -1089,6 +1086,8 @@ google.golang.org/genproto v0.0.0-20200212174721-66ed5ce911ce/go.mod h1:55QSHmfG google.golang.org/genproto v0.0.0-20200224152610-e50cd9704f63/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= google.golang.org/genproto v0.0.0-20200305110556-506484158171 h1:xes2Q2k+d/+YNXVw0FpZkIDJiaux4OVrRKXRAzH6A0U= google.golang.org/genproto v0.0.0-20200305110556-506484158171/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= +google.golang.org/genproto v0.0.0-20200323114720-3f67cca34472 h1:XRuIAeTRoXziYGYTVer+YGxVXQBiOhZ8+SpNELP73oQ= +google.golang.org/genproto v0.0.0-20200323114720-3f67cca34472/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= google.golang.org/grpc v1.14.0/go.mod h1:yo6s7OP7yaDglbqo1J04qKzAhqBH6lvTonzMVmEdcZw= google.golang.org/grpc v1.16.0/go.mod h1:0JHn/cJsOMiMfNA9+DeHDlAU7KAAB5GDlYFpa9MZMio= google.golang.org/grpc v1.17.0/go.mod h1:6QZJwpn2B+Zp71q/5VxRsJ6NXXVCE5NRUHRo+f3cWCs= @@ -1158,6 +1157,7 @@ honnef.co/go/tools v0.0.1-2020.1.3 h1:sXmLre5bzIR6ypkjXCDI3jHPssRhc8KD/Ome589sc3 honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= howett.net/plist v0.0.0-20181124034731-591f970eefbb h1:jhnBjNi9UFpfpl8YZhA9CrOqpnJdvzuiHsl/dnxl11M= howett.net/plist v0.0.0-20181124034731-591f970eefbb/go.mod h1:vMygbs4qMhSZSc4lCUl2OEE+rDiIIJAIdR4m7MiMcm0= +launchpad.net/gocheck v0.0.0-20140225173054-000000000087/go.mod h1:hj7XX3B/0A+80Vse0e+BUHsHMTEhd0O4cpUHr/e/BUM= mvdan.cc/interfacer v0.0.0-20180901003855-c20040233aed/go.mod h1:Xkxe497xwlCKkIaQYRfC7CSLworTXY9RMqwhhCm+8Nc= mvdan.cc/lint v0.0.0-20170908181259-adc824a0674b/go.mod h1:2odslEg/xrtNQqCYg2/jCoyKnw3vv5biOc3JnIcYfL4= mvdan.cc/unparam v0.0.0-20190209190245-fbb59629db34/go.mod h1:H6SUd1XjIs+qQCyskXg5OFSrilMRUkD8ePJpHKDPaeY= diff --git a/modules/caddyhttp/encode/brotli/brotli.go b/modules/caddyhttp/encode/brotli/brotli.go deleted file mode 100644 index fababd38..00000000 --- a/modules/caddyhttp/encode/brotli/brotli.go +++ /dev/null @@ -1,95 +0,0 @@ -// Copyright 2015 Matthew Holt and The Caddy Authors -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package caddybrotli - -import ( - "fmt" - "strconv" - - "github.com/andybalholm/brotli" - "github.com/caddyserver/caddy/v2" - "github.com/caddyserver/caddy/v2/caddyconfig/caddyfile" - "github.com/caddyserver/caddy/v2/modules/caddyhttp/encode" -) - -func init() { - caddy.RegisterModule(Brotli{}) -} - -// Brotli can create brotli encoders. Note that brotli -// is not known for great encoding performance, and -// its use during requests is discouraged; instead, -// pre-compress the content instead. -type Brotli struct { - Quality *int `json:"quality,omitempty"` -} - -// CaddyModule returns the Caddy module information. -func (Brotli) CaddyModule() caddy.ModuleInfo { - return caddy.ModuleInfo{ - ID: "http.encoders.brotli", - New: func() caddy.Module { return new(Brotli) }, - } -} - -// UnmarshalCaddyfile sets up the handler from Caddyfile tokens. -func (b *Brotli) UnmarshalCaddyfile(d *caddyfile.Dispenser) error { - for d.Next() { - if !d.NextArg() { - continue - } - qualityStr := d.Val() - quality, err := strconv.Atoi(qualityStr) - if err != nil { - return err - } - b.Quality = &quality - } - return nil -} - -// Validate validates b's configuration. -func (b Brotli) Validate() error { - if b.Quality != nil { - quality := *b.Quality - if quality < brotli.BestSpeed { - return fmt.Errorf("quality too low; must be >= %d", brotli.BestSpeed) - } - if quality > brotli.BestCompression { - return fmt.Errorf("quality too high; must be <= %d", brotli.BestCompression) - } - } - return nil -} - -// AcceptEncoding returns the name of the encoding as -// used in the Accept-Encoding request headers. -func (Brotli) AcceptEncoding() string { return "br" } - -// NewEncoder returns a new brotli writer. -func (b Brotli) NewEncoder() encode.Encoder { - quality := brotli.DefaultCompression - if b.Quality != nil { - quality = *b.Quality - } - return brotli.NewWriterLevel(nil, quality) -} - -// Interface guards -var ( - _ encode.Encoding = (*Brotli)(nil) - _ caddy.Validator = (*Brotli)(nil) - _ caddyfile.Unmarshaler = (*Brotli)(nil) -) diff --git a/modules/caddyhttp/encode/caddyfile.go b/modules/caddyhttp/encode/caddyfile.go index 629f0e20..9d9646c0 100644 --- a/modules/caddyhttp/encode/caddyfile.go +++ b/modules/caddyhttp/encode/caddyfile.go @@ -42,7 +42,6 @@ func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) // encode [] { // gzip [] // zstd -// brotli [] // } // // Specifying the formats on the first line will use those formats' defaults. diff --git a/modules/caddyhttp/httpcache/httpcache.go b/modules/caddyhttp/httpcache/httpcache.go deleted file mode 100644 index 605a1836..00000000 --- a/modules/caddyhttp/httpcache/httpcache.go +++ /dev/null @@ -1,242 +0,0 @@ -// Copyright 2015 Matthew Holt and The Caddy Authors -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package httpcache - -import ( - "bytes" - "context" - "encoding/gob" - "fmt" - "io" - "log" - "net/http" - "sync" - - "github.com/caddyserver/caddy/v2" - "github.com/caddyserver/caddy/v2/modules/caddyhttp" - "github.com/golang/groupcache" -) - -func init() { - caddy.RegisterModule(Cache{}) -} - -// Cache implements a simple distributed cache. -// -// NOTE: This module is a work-in-progress. It is -// not finished and is NOT ready for production use. -// [We need your help to finish it! Please volunteer -// in this issue.](https://github.com/caddyserver/caddy/issues/2820) -// Until it is finished, this module is subject to -// breaking changes. -// -// Caches only GET and HEAD requests. Honors the Cache-Control: no-cache header. -// -// Still TODO: -// -// - Eviction policies and API -// - Use single cache per-process -// - Preserve cache through config reloads -// - More control over what gets cached -type Cache struct { - // The network address of this cache instance; required. - Self string `json:"self,omitempty"` - - // A list of network addresses of cache instances in the group. - Peers []string `json:"peers,omitempty"` - - // Maximum size of the cache, in bytes. Default is 512 MB. - MaxSize int64 `json:"max_size,omitempty"` - - group *groupcache.Group -} - -// CaddyModule returns the Caddy module information. -func (Cache) CaddyModule() caddy.ModuleInfo { - return caddy.ModuleInfo{ - ID: "http.handlers.cache", - New: func() caddy.Module { return new(Cache) }, - } -} - -// Provision provisions c. -func (c *Cache) Provision(ctx caddy.Context) error { - // TODO: use UsagePool so that cache survives config reloads - TODO: a single cache for whole process? - maxSize := c.MaxSize - if maxSize == 0 { - const maxMB = 512 - maxSize = int64(maxMB << 20) - } - poolMu.Lock() - if pool == nil { - pool = groupcache.NewHTTPPool(c.Self) - c.group = groupcache.NewGroup(groupName, maxSize, groupcache.GetterFunc(c.getter)) - } else { - c.group = groupcache.GetGroup(groupName) - } - pool.Set(append(c.Peers, c.Self)...) - poolMu.Unlock() - - return nil -} - -// Validate validates c. -func (c *Cache) Validate() error { - if c.Self == "" { - return fmt.Errorf("address of this instance (self) is required") - } - if c.MaxSize < 0 { - return fmt.Errorf("size must be greater than 0") - } - return nil -} - -func (c *Cache) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error { - // TODO: proper RFC implementation of cache control headers... - if r.Header.Get("Cache-Control") == "no-cache" || (r.Method != "GET" && r.Method != "HEAD") { - return next.ServeHTTP(w, r) - } - - getterCtx := getterContext{w, r, next} - ctx := context.WithValue(r.Context(), getterContextCtxKey, getterCtx) - - // TODO: rigorous performance testing - - // TODO: pretty much everything else to handle the nuances of HTTP caching... - - // TODO: groupcache has no explicit cache eviction, so we need to embed - // all information related to expiring cache entries into the key; right - // now we just use the request URI as a proof-of-concept - key := r.RequestURI - - var cachedBytes []byte - err := c.group.Get(ctx, key, groupcache.AllocatingByteSliceSink(&cachedBytes)) - if err == errUncacheable { - return nil - } - if err != nil { - return err - } - - // the cached bytes consists of two parts: first a - // gob encoding of the status and header, immediately - // followed by the raw bytes of the response body - rdr := bytes.NewReader(cachedBytes) - - // read the header and status first - var hs headerAndStatus - err = gob.NewDecoder(rdr).Decode(&hs) - if err != nil { - return err - } - - // set and write the cached headers - for k, v := range hs.Header { - w.Header()[k] = v - } - w.WriteHeader(hs.Status) - - // write the cached response body - io.Copy(w, rdr) - - return nil -} - -func (c *Cache) getter(ctx context.Context, key string, dest groupcache.Sink) error { - combo := ctx.Value(getterContextCtxKey).(getterContext) - - // the buffer will store the gob-encoded header, then the body - buf := bufPool.Get().(*bytes.Buffer) - buf.Reset() - defer bufPool.Put(buf) - - // we need to record the response if we are to cache it; only cache if - // request is successful (TODO: there's probably much more nuance needed here) - rr := caddyhttp.NewResponseRecorder(combo.rw, buf, func(status int, header http.Header) bool { - shouldBuf := status < 300 - - if shouldBuf { - // store the header before the body, so we can efficiently - // and conveniently use a single buffer for both; gob - // decoder will only read up to end of gob message, and - // the rest will be the body, which will be written - // implicitly for us by the recorder - err := gob.NewEncoder(buf).Encode(headerAndStatus{ - Header: header, - Status: status, - }) - if err != nil { - log.Printf("[ERROR] Encoding headers for cache entry: %v; not caching this request", err) - return false - } - } - - return shouldBuf - }) - - // execute next handlers in chain - err := combo.next.ServeHTTP(rr, combo.req) - if err != nil { - return err - } - - // if response body was not buffered, response was - // already written and we are unable to cache - if !rr.Buffered() { - return errUncacheable - } - - // add to cache - dest.SetBytes(buf.Bytes()) - - return nil -} - -type headerAndStatus struct { - Header http.Header - Status int -} - -type getterContext struct { - rw http.ResponseWriter - req *http.Request - next caddyhttp.Handler -} - -var bufPool = sync.Pool{ - New: func() interface{} { - return new(bytes.Buffer) - }, -} - -var ( - pool *groupcache.HTTPPool - poolMu sync.Mutex -) - -var errUncacheable = fmt.Errorf("uncacheable") - -const groupName = "http_requests" - -type ctxKey string - -const getterContextCtxKey ctxKey = "getter_context" - -// Interface guards -var ( - _ caddy.Provisioner = (*Cache)(nil) - _ caddy.Validator = (*Cache)(nil) - _ caddyhttp.MiddlewareHandler = (*Cache)(nil) -) diff --git a/modules/caddyhttp/requestbody/requestbody.go b/modules/caddyhttp/requestbody/requestbody.go index dcebd8c5..76cd2743 100644 --- a/modules/caddyhttp/requestbody/requestbody.go +++ b/modules/caddyhttp/requestbody/requestbody.go @@ -34,7 +34,7 @@ type RequestBody struct { // CaddyModule returns the Caddy module information. func (RequestBody) CaddyModule() caddy.ModuleInfo { return caddy.ModuleInfo{ - ID: "http.handlers.request_body", // TODO: better name for this? + ID: "http.handlers.request_body", New: func() caddy.Module { return new(RequestBody) }, } } diff --git a/modules/caddyhttp/reverseproxy/circuitbreaker.go b/modules/caddyhttp/reverseproxy/circuitbreaker.go index 00b38a82..830ab439 100644 --- a/modules/caddyhttp/reverseproxy/circuitbreaker.go +++ b/modules/caddyhttp/reverseproxy/circuitbreaker.go @@ -24,12 +24,12 @@ import ( ) func init() { - caddy.RegisterModule(localCircuitBreaker{}) + caddy.RegisterModule(internalCircuitBreaker{}) } -// localCircuitBreaker implements circuit breaking functionality +// internalCircuitBreaker implements circuit breaking functionality // for requests within this process over a sliding time window. -type localCircuitBreaker struct { +type internalCircuitBreaker struct { tripped int32 cbFactor int32 threshold float64 @@ -39,15 +39,15 @@ type localCircuitBreaker struct { } // CaddyModule returns the Caddy module information. -func (localCircuitBreaker) CaddyModule() caddy.ModuleInfo { +func (internalCircuitBreaker) CaddyModule() caddy.ModuleInfo { return caddy.ModuleInfo{ - ID: "http.reverse_proxy.circuit_breakers.local", - New: func() caddy.Module { return new(localCircuitBreaker) }, + ID: "http.reverse_proxy.circuit_breakers.internal", + New: func() caddy.Module { return new(internalCircuitBreaker) }, } } // Provision sets up a configured circuit breaker. -func (c *localCircuitBreaker) Provision(ctx caddy.Context) error { +func (c *internalCircuitBreaker) Provision(ctx caddy.Context) error { f, ok := typeCB[c.Factor] if !ok { return fmt.Errorf("type is not defined") @@ -77,19 +77,19 @@ func (c *localCircuitBreaker) Provision(ctx caddy.Context) error { } // Ok returns whether the circuit breaker is tripped or not. -func (c *localCircuitBreaker) Ok() bool { +func (c *internalCircuitBreaker) Ok() bool { tripped := atomic.LoadInt32(&c.tripped) return tripped == 0 } // RecordMetric records a response status code and execution time of a request. This function should be run in a separate goroutine. -func (c *localCircuitBreaker) RecordMetric(statusCode int, latency time.Duration) { +func (c *internalCircuitBreaker) RecordMetric(statusCode int, latency time.Duration) { c.metrics.Record(statusCode, latency) c.checkAndSet() } // Ok checks our metrics to see if we should trip our circuit breaker, or if the fallback duration has completed. -func (c *localCircuitBreaker) checkAndSet() { +func (c *internalCircuitBreaker) checkAndSet() { var isTripped bool switch c.cbFactor { diff --git a/modules/caddyhttp/standard/imports.go b/modules/caddyhttp/standard/imports.go index 1effb5ad..a0ccf6e7 100644 --- a/modules/caddyhttp/standard/imports.go +++ b/modules/caddyhttp/standard/imports.go @@ -5,12 +5,10 @@ import ( _ "github.com/caddyserver/caddy/v2/modules/caddyhttp" _ "github.com/caddyserver/caddy/v2/modules/caddyhttp/caddyauth" _ "github.com/caddyserver/caddy/v2/modules/caddyhttp/encode" - _ "github.com/caddyserver/caddy/v2/modules/caddyhttp/encode/brotli" _ "github.com/caddyserver/caddy/v2/modules/caddyhttp/encode/gzip" _ "github.com/caddyserver/caddy/v2/modules/caddyhttp/encode/zstd" _ "github.com/caddyserver/caddy/v2/modules/caddyhttp/fileserver" _ "github.com/caddyserver/caddy/v2/modules/caddyhttp/headers" - _ "github.com/caddyserver/caddy/v2/modules/caddyhttp/httpcache" _ "github.com/caddyserver/caddy/v2/modules/caddyhttp/requestbody" _ "github.com/caddyserver/caddy/v2/modules/caddyhttp/reverseproxy" _ "github.com/caddyserver/caddy/v2/modules/caddyhttp/reverseproxy/fastcgi" diff --git a/modules/standard/import.go b/modules/standard/import.go index a88200fb..dddf712b 100644 --- a/modules/standard/import.go +++ b/modules/standard/import.go @@ -3,8 +3,6 @@ package standard import ( // standard Caddy modules _ "github.com/caddyserver/caddy/v2/caddyconfig/caddyfile" - _ "github.com/caddyserver/caddy/v2/caddyconfig/json5" - _ "github.com/caddyserver/caddy/v2/caddyconfig/jsonc" _ "github.com/caddyserver/caddy/v2/modules/caddyhttp/standard" _ "github.com/caddyserver/caddy/v2/modules/caddypki" _ "github.com/caddyserver/caddy/v2/modules/caddytls"