all: imp code; fix chlog

This commit is contained in:
Stanislav Chzhen 2023-02-28 16:16:40 +03:00
parent df22de91f5
commit d54022baa6
9 changed files with 65 additions and 27 deletions

View File

@ -53,19 +53,15 @@ In this release, the schema version has changed from 16 to 17.
- The `GET /control/stats_info` HTTP API; use the new `GET - The `GET /control/stats_info` HTTP API; use the new `GET
/control/stats/config` API instead. /control/stats/config` API instead.
**NOTE:** If `interval` was configured by editing configuration file or new **NOTE:** If interval is custom then it will be equal to `90` days for
HTTP API call `PUT /control/stats/config/update` and it's not equal to compatibility reasons. See openapi/openapi.yaml and `openapi/CHANGELOG.md`.
previous allowed enum values then it will be equal to `90` days for
compatibility reasons.
- The `POST /control/stats_config` HTTP API; use the new `PUT - The `POST /control/stats_config` HTTP API; use the new `PUT
/control/stats/config/update` API instead. /control/stats/config/update` API instead.
- The `GET /control/querylog_info` HTTP API; use the new `GET - The `GET /control/querylog_info` HTTP API; use the new `GET
/control/querylog/config` API instead. /control/querylog/config` API instead.
**NOTE:** If `interval` was configured by editing configuration file or new **NOTE:** If interval is custom then it will be equal to `90` days for
HTTP API call `PUT /control/querylog/config/update` and it's not equal to compatibility reasons. See openapi/openapi.yaml and `openapi/CHANGELOG.md`.
previous allowed enum values then it will be equal to `90` days for
compatibility reasons.
- The `POST /control/querylog_config` HTTP API; use the new `PUT - The `POST /control/querylog_config` HTTP API; use the new `PUT
/control/querylog/config/update` API instead. /control/querylog/config/update` API instead.

View File

@ -932,7 +932,7 @@ func upgradeSchema16to17(diskConf yobj) (err error) {
const field = "interval" const field = "interval"
// Set the initial value from home.initConfig function. // Set the initial value from the global configuration structure.
statsIvl := 1 statsIvl := 1
statsIvlVal, ok := stats[field] statsIvlVal, ok := stats[field]
if ok { if ok {

View File

@ -164,7 +164,8 @@ func (l *queryLog) handleQueryLogConfig(w http.ResponseWriter, r *http.Request)
return return
} }
ivl := time.Duration(float64(timeutil.Day) * newConf.Interval) ivl := time.Duration(newConf.Interval) * timeutil.Day
hasIvl := !math.IsNaN(newConf.Interval) hasIvl := !math.IsNaN(newConf.Interval)
if hasIvl && !checkInterval(ivl) { if hasIvl && !checkInterval(ivl) {
aghhttp.Error(r, w, http.StatusBadRequest, "unsupported interval") aghhttp.Error(r, w, http.StatusBadRequest, "unsupported interval")
@ -214,8 +215,9 @@ func (l *queryLog) handlePutQueryLogConfig(w http.ResponseWriter, r *http.Reques
ivl := time.Duration(float64(time.Millisecond) * newConf.Interval) ivl := time.Duration(float64(time.Millisecond) * newConf.Interval)
if ivl < time.Hour || ivl > timeutil.Day*365 { err = validateIvl(ivl)
aghhttp.Error(r, w, http.StatusUnprocessableEntity, "unsupported interval") if err != nil {
aghhttp.Error(r, w, http.StatusUnprocessableEntity, "unsupported interval: %s", err)
return return
} }
@ -254,7 +256,7 @@ func (l *queryLog) handlePutQueryLogConfig(w http.ResponseWriter, r *http.Reques
if len(newConf.Ignored) > 0 { if len(newConf.Ignored) > 0 {
set, serr := aghnet.NewDomainNameSet(newConf.Ignored) set, serr := aghnet.NewDomainNameSet(newConf.Ignored)
if serr != nil { if serr != nil {
aghhttp.Error(r, w, http.StatusUnprocessableEntity, "ignored: duplicate or empty host") aghhttp.Error(r, w, http.StatusUnprocessableEntity, "ignored: %s", serr)
return return
} }

View File

@ -132,6 +132,20 @@ func checkInterval(ivl time.Duration) (ok bool) {
return ivl == quarterDay || ivl == day || ivl == week || ivl == month || ivl == threeMonths return ivl == quarterDay || ivl == day || ivl == week || ivl == month || ivl == threeMonths
} }
// validateIvl returns an error if ivl is less than an hour or more than a
// year.
func validateIvl(ivl time.Duration) (err error) {
if ivl < time.Hour {
return errors.Error("less than an hour")
}
if ivl > timeutil.Day*365 {
return errors.Error("more than a year")
}
return nil
}
func (l *queryLog) WriteDiskConfig(c *Config) { func (l *queryLog) WriteDiskConfig(c *Config) {
*c = *l.conf *c = *l.conf
} }

View File

@ -1,6 +1,7 @@
package querylog package querylog
import ( import (
"fmt"
"net" "net"
"path/filepath" "path/filepath"
"time" "time"
@ -10,7 +11,6 @@ import (
"github.com/AdguardTeam/AdGuardHome/internal/filtering" "github.com/AdguardTeam/AdGuardHome/internal/filtering"
"github.com/AdguardTeam/golibs/errors" "github.com/AdguardTeam/golibs/errors"
"github.com/AdguardTeam/golibs/stringutil" "github.com/AdguardTeam/golibs/stringutil"
"github.com/AdguardTeam/golibs/timeutil"
"github.com/miekg/dns" "github.com/miekg/dns"
) )
@ -157,8 +157,9 @@ func newQueryLog(conf Config) (l *queryLog, err error) {
l.conf = &Config{} l.conf = &Config{}
*l.conf = conf *l.conf = conf
if conf.RotationIvl < time.Hour || conf.RotationIvl > timeutil.Day*365 { err = validateIvl(conf.RotationIvl)
return nil, errors.Error("unsupported interval") if err != nil {
return nil, fmt.Errorf("unsupported interval: %w", err)
} }
return l, nil return l, nil

View File

@ -11,7 +11,6 @@ import (
"github.com/AdguardTeam/AdGuardHome/internal/aghhttp" "github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
"github.com/AdguardTeam/AdGuardHome/internal/aghnet" "github.com/AdguardTeam/AdGuardHome/internal/aghnet"
"github.com/AdguardTeam/golibs/log" "github.com/AdguardTeam/golibs/log"
"github.com/AdguardTeam/golibs/timeutil"
"golang.org/x/exp/slices" "golang.org/x/exp/slices"
) )
@ -163,8 +162,9 @@ func (s *StatsCtx) handlePutStatsConfig(w http.ResponseWriter, r *http.Request)
ivl := time.Duration(float64(time.Millisecond) * reqData.Interval) ivl := time.Duration(float64(time.Millisecond) * reqData.Interval)
if ivl < time.Hour || ivl > timeutil.Day*365 { err = validateIvl(ivl)
aghhttp.Error(r, w, http.StatusUnprocessableEntity, "unsupported interval") if err != nil {
aghhttp.Error(r, w, http.StatusUnprocessableEntity, "unsupported interval: %s", err)
return return
} }
@ -187,7 +187,7 @@ func (s *StatsCtx) handlePutStatsConfig(w http.ResponseWriter, r *http.Request)
if len(reqData.Ignored) > 0 { if len(reqData.Ignored) > 0 {
set, serr := aghnet.NewDomainNameSet(reqData.Ignored) set, serr := aghnet.NewDomainNameSet(reqData.Ignored)
if serr != nil { if serr != nil {
aghhttp.Error(r, w, http.StatusUnprocessableEntity, "ignored: duplicate or empty host") aghhttp.Error(r, w, http.StatusUnprocessableEntity, "ignored: %s", serr)
return return
} }

View File

@ -53,7 +53,7 @@ func TestHandleStatsConfig(t *testing.T) {
Ignored: []string{}, Ignored: []string{},
}, },
wantCode: http.StatusUnprocessableEntity, wantCode: http.StatusUnprocessableEntity,
wantErr: "unsupported interval\n", wantErr: "unsupported interval: less than an hour\n",
}, { }, {
name: "big_interval", name: "big_interval",
body: getConfigResp{ body: getConfigResp{
@ -62,7 +62,7 @@ func TestHandleStatsConfig(t *testing.T) {
Ignored: []string{}, Ignored: []string{},
}, },
wantCode: http.StatusUnprocessableEntity, wantCode: http.StatusUnprocessableEntity,
wantErr: "unsupported interval\n", wantErr: "unsupported interval: more than a year\n",
}, { }, {
name: "set_ignored_ivl_1_maxIvl", name: "set_ignored_ivl_1_maxIvl",
body: getConfigResp{ body: getConfigResp{
@ -85,7 +85,7 @@ func TestHandleStatsConfig(t *testing.T) {
}, },
}, },
wantCode: http.StatusUnprocessableEntity, wantCode: http.StatusUnprocessableEntity,
wantErr: "ignored: duplicate or empty host\n", wantErr: "ignored: duplicate host name \"ignor.ed\" at index 1\n",
}, { }, {
name: "ignored_empty", name: "ignored_empty",
body: getConfigResp{ body: getConfigResp{
@ -96,7 +96,7 @@ func TestHandleStatsConfig(t *testing.T) {
}, },
}, },
wantCode: http.StatusUnprocessableEntity, wantCode: http.StatusUnprocessableEntity,
wantErr: "ignored: duplicate or empty host\n", wantErr: "ignored: host name is empty\n",
}, { }, {
name: "enabled_is_null", name: "enabled_is_null",
body: getConfigResp{ body: getConfigResp{

View File

@ -26,6 +26,20 @@ func checkInterval(days uint32) (ok bool) {
return days == 0 || days == 1 || days == 7 || days == 30 || days == 90 return days == 0 || days == 1 || days == 7 || days == 30 || days == 90
} }
// validateIvl returns an error if ivl is less than an hour or more than a
// year.
func validateIvl(ivl time.Duration) (err error) {
if ivl < time.Hour {
return errors.Error("less than an hour")
}
if ivl > timeutil.Day*365 {
return errors.Error("more than a year")
}
return nil
}
// Config is the configuration structure for the statistics collecting. // Config is the configuration structure for the statistics collecting.
type Config struct { type Config struct {
// UnitID is the function to generate the identifier for current unit. If // UnitID is the function to generate the identifier for current unit. If
@ -127,8 +141,9 @@ func New(conf Config) (s *StatsCtx, err error) {
ignored: conf.Ignored, ignored: conf.Ignored,
} }
if conf.Limit < time.Hour || conf.Limit > timeutil.Day*365 { err = validateIvl(conf.Limit)
return nil, errors.Error("unsupported interval") if err != nil {
return nil, fmt.Errorf("unsupported interval: %w", err)
} }
s.limit = conf.Limit s.limit = conf.Limit
@ -445,7 +460,7 @@ func (s *StatsCtx) periodicFlush() {
func (s *StatsCtx) setLimitLocked(limitDays int) { func (s *StatsCtx) setLimitLocked(limitDays int) {
if limitDays != 0 { if limitDays != 0 {
s.enabled = true s.enabled = true
s.limit = time.Duration(int(timeutil.Day) * limitDays) s.limit = time.Duration(limitDays) * timeutil.Day
log.Debug("stats: set limit: %d days", limitDays) log.Debug("stats: set limit: %d days", limitDays)
return return

View File

@ -13,6 +13,11 @@
* The `GET /control/stats_info` HTTP API; use the new `GET * The `GET /control/stats_info` HTTP API; use the new `GET
/control/stats/config` API instead. /control/stats/config` API instead.
**NOTE:** If `interval` was configured by editing configuration file or new
HTTP API call `PUT /control/stats/config/update` and it's not equal to
previous allowed enum values then it will be equal to `90` days for
compatibility reasons.
* The `POST /control/stats_config` HTTP API; use the new `PUT * The `POST /control/stats_config` HTTP API; use the new `PUT
/control/stats/config/update` API instead. /control/stats/config/update` API instead.
@ -38,6 +43,11 @@ return a JSON object with the following format:
* The `GET /control/querylog_info` HTTP API; use the new `GET * The `GET /control/querylog_info` HTTP API; use the new `GET
/control/querylog/config` API instead. /control/querylog/config` API instead.
**NOTE:** If `interval` was configured by editing configuration file or new
HTTP API call `PUT /control/querylog/config/update` and it's not equal to
previous allowed enum values then it will be equal to `90` days for
compatibility reasons.
* The `POST /control/querylog_config` HTTP API; use the new `PUT * The `POST /control/querylog_config` HTTP API; use the new `PUT
/control/querylog/config/update` API instead. /control/querylog/config/update` API instead.