all: impl stats api intervals

Author: masterkusok

CHANGELOG.md

@@ -20,6 +20,8 @@ NOTE: Add new changes BELOW THIS COMMENT.
 
 ### Added
 
+- New query parameter `recent` in `GET /control/stats/` defines statistics lookback period in millieseconds.  See `openapi/openapi.yaml` for details.
+
 - New field `"ignored_enabled"` in `GetStatsConfigResponse` or `GetQueryLogConfigResponse`.  See `openapi/openapi.yaml` for details.
 
 #### Configuration changes

internal/stats/http.go

@@ -5,14 +5,20 @@ package stats
 import (
 	"encoding/json"
 	"net/http"
+	"strconv"
 	"time"
 
 	"github.com/AdguardTeam/AdGuardHome/internal/aghalg"
 	"github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
 	"github.com/AdguardTeam/AdGuardHome/internal/aghnet"
 	"github.com/AdguardTeam/golibs/timeutil"
+	"github.com/AdguardTeam/golibs/validate"
 )
 
+// queryKeyRecent is the key of the query parameter that contains the lookback
+// interval for statistics.
+const queryKeyRecent = "recent"
+
 // topAddrs is an alias for the types of the TopFoo fields of statsResponse.
 // The key is either a client's address or a requested address.
 type topAddrs = map[string]uint64
@@ -53,6 +59,32 @@ func (s *StatsCtx) handleStats(w http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 	l := s.logger
 
+	limit := s.limit
+
+	recent := r.URL.Query().Get(queryKeyRecent)
+	if recent != "" {
+		recentMs, err := strconv.ParseInt(recent, 10, 64)
+		if err != nil {
+			aghhttp.ErrorAndLog(ctx, l, r, w, http.StatusBadRequest, "parsing interval: %s", err)
+
+			return
+		}
+
+		err = validate.InRange(
+			queryKeyRecent,
+			recentMs,
+			time.Hour.Milliseconds(),
+			limit.Milliseconds(),
+		)
+		if err != nil {
+			aghhttp.ErrorAndLog(ctx, l, r, w, http.StatusBadRequest, "%s", err)
+
+			return
+		}
+
+		limit = time.Duration(recentMs) * time.Millisecond
+	}
+
 	var (
 		resp *StatsResp
 		ok   bool
@@ -61,7 +93,7 @@ func (s *StatsCtx) handleStats(w http.ResponseWriter, r *http.Request) {
 		s.confMu.RLock()
 		defer s.confMu.RUnlock()
 
-		resp, ok = s.getData(uint32(s.limit.Hours()))
+		resp, ok = s.getData(uint32(limit.Hours()))
 	}()
 
 	l.DebugContext(ctx, "prepared data", "elapsed", time.Since(start))

internal/stats/http_internal_test.go

@@ -3,6 +3,7 @@ package stats
 import (
 	"bytes"
 	"encoding/json"
+	"fmt"
 	"net/http"
 	"net/http/httptest"
 	"path/filepath"
@@ -13,12 +14,22 @@ import (
 	"github.com/AdguardTeam/AdGuardHome/internal/aghalg"
 	"github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
 	"github.com/AdguardTeam/golibs/logutil/slogutil"
+	"github.com/AdguardTeam/golibs/netutil"
 	"github.com/AdguardTeam/golibs/testutil"
 	"github.com/AdguardTeam/golibs/timeutil"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
+// testLogger is the common logger for tests.
+var testLogger = slogutil.NewDiscardLogger()
+
+// Common domain values for tests.
+const (
+	TestDomain1 = "example.com"
+	TestDomain2 = "example.org"
+)
+
 func TestHandleStatsConfig(t *testing.T) {
 	const (
 		smallIvl = 1 * time.Minute
@@ -27,13 +38,13 @@ func TestHandleStatsConfig(t *testing.T) {
 	)
 
 	conf := Config{
-		Logger:            slogutil.NewDiscardLogger(),
+		Logger:            testLogger,
 		UnitID:            func() (id uint32) { return 0 },
 		ConfigModifier:    agh.EmptyConfigModifier{},
 		ShouldCountClient: func([]string) bool { return true },
 		HTTPReg:           aghhttp.EmptyRegistrar{},
 		Filename:          filepath.Join(t.TempDir(), "stats.db"),
-		Limit:             time.Hour * 24,
+		Limit:             24 * time.Hour,
 		Enabled:           true,
 	}
 
@@ -138,3 +149,117 @@ func TestHandleStatsConfig(t *testing.T) {
 		})
 	}
 }
+
+// populateTestData is a helper that creates test entries in db.  s must not be
+// nil.
+func populateTestData(tb testing.TB, s *StatsCtx) {
+	tb.Helper()
+
+	oldUnitID := newUnitID() - 1
+	oldUnit := &unitDB{
+		NResult: make([]uint64, resultLast),
+		Domains: []countPair{{Name: TestDomain1, Count: 1}},
+		NTotal:  1,
+	}
+
+	db := s.db.Load()
+	tx, err := db.Begin(true)
+	require.NoError(tb, err)
+
+	err = s.flushUnitToDB(oldUnit, tx, uint32(oldUnitID))
+	require.NoError(tb, err)
+
+	err = finishTxn(tx, true)
+	require.NoError(tb, err)
+
+	s.Update(&Entry{
+		Client:         netutil.IPv4Localhost().String(),
+		Domain:         TestDomain2,
+		ProcessingTime: 3 * time.Minute,
+		Result:         RNotFiltered,
+	})
+}
+
+func TestStatsCtx_handleStats(t *testing.T) {
+	conf := Config{
+		Logger:            testLogger,
+		UnitID:            newUnitID,
+		ConfigModifier:    agh.EmptyConfigModifier{},
+		ShouldCountClient: func([]string) bool { return true },
+		HTTPReg:           aghhttp.EmptyRegistrar{},
+		Filename:          filepath.Join(t.TempDir(), "stats.db"),
+		Limit:             24 * time.Hour,
+		Enabled:           true,
+	}
+
+	testCases := []struct {
+		name                  string
+		wantErr               string
+		wantTopQueriedDomains []topAddrs
+		wantDNSQueries        uint64
+		wantCode              int
+		recent                int64
+	}{{
+		name:     "short_interval",
+		wantErr:  "recent: out of range: must be no less than 3600000, got 240000\n",
+		wantCode: http.StatusBadRequest,
+		recent:   4 * time.Minute.Milliseconds(),
+	}, {
+		name:     "long_interval",
+		wantErr:  "recent: out of range: must be no greater than 86400000, got 259200000\n",
+		wantCode: http.StatusBadRequest,
+		recent:   72 * time.Hour.Milliseconds(),
+	}, {
+		name:           "no_interval",
+		wantCode:       http.StatusOK,
+		wantDNSQueries: 2,
+		wantTopQueriedDomains: []topAddrs{{
+			TestDomain1: 1,
+		}, {
+			TestDomain2: 1,
+		}},
+	}, {
+		name:           "valid_interval",
+		wantCode:       http.StatusOK,
+		wantDNSQueries: 1,
+		wantTopQueriedDomains: []topAddrs{{
+			TestDomain2: 1,
+		}},
+		recent: time.Hour.Milliseconds(),
+	}}
+
+	s, err := New(conf)
+	require.NoError(t, err)
+
+	s.Start()
+	defer testutil.CleanupAndRequireSuccess(t, s.Close)
+
+	populateTestData(t, s)
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			url := "/control/stats"
+			if tc.recent != 0 {
+				url += fmt.Sprintf("?recent=%d", tc.recent)
+			}
+
+			req := httptest.NewRequest(http.MethodGet, url, nil)
+			rw := httptest.NewRecorder()
+
+			s.handleStats(rw, req)
+			require.Equal(t, tc.wantCode, rw.Code)
+
+			if rw.Code != http.StatusOK {
+				require.Equal(t, tc.wantErr, rw.Body.String())
+
+				return
+			}
+
+			ans := StatsResp{}
+			err = json.Unmarshal(rw.Body.Bytes(), &ans)
+			require.NoError(t, err)
+
+			assert.Equal(t, tc.wantDNSQueries, ans.NumDNSQueries)
+			assert.ElementsMatch(t, tc.wantTopQueriedDomains, ans.TopQueried)
+		})
+	}
+}

internal/stats/stats.go

@@ -72,6 +72,9 @@ type Config struct {
 	Ignored *aghnet.IgnoreEngine
 
 	// Filename is the name of the database file.
+	//
+	// TODO(f.setrakov): Move the work with DB into a separate entity with
+	// interface.
 	Filename string
 
 	// Limit is an upper limit for collecting statistics.

openapi/CHANGELOG.md

@@ -4,6 +4,10 @@
 
 ## v0.107.72: API changes
 
+## New `recent` query parameter in 'GET /control/stats/'
+
+- New query parameter `recent` defines the statistics lookback period in millieseconds.
+
 ### New `ignored_enabled` field in `GetStatsConfigResponse` and  `GetQueryLogConfigResponse`
 
 - The new field `ignored_enabled` indicates whether the host names in the ignored array should be ignored.  This field has been added for the following endpoints:

openapi/openapi.yaml

@@ -323,13 +323,26 @@
       - 'stats'
       'operationId': 'stats'
       'summary': 'Get DNS server statistics'
+      'parameters':
+      - 'name': 'recent'
+        'in': 'query'
+        'description': |
+          The lookback period for statistics in milliseconds.  The interval must
+          be a multiple of one hour and must not be greater than the value of
+          `statistics.interval`.
+        'required': false
+        'example': 604800000
+        'schema':
+          'type': 'integer'
       'responses':
         '200':
           'description': 'Returns statistics data'
           'content':
             'application/json':
               'schema':
                 '$ref': '#/components/schemas/Stats'
+        '400':
+          'description': 'Invalid value of parameter `recent`'
   '/stats_reset':
     'post':
       'tags':