Pull request 2244: AG-27492-client-storage-usage

Squashed commit of the following: commit 46956d0f5a36fbcd2324125bcc146bdb57cb3f7e Merge: 85ccad786 3993f4c47 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Mon Jul 1 16:11:59 2024 +0300 Merge branch 'master' into AG-27492-client-storage-usage commit 85ccad7862a35cbebc935776ac057f6bb6cfc75f Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Fri Jun 28 18:05:37 2024 +0300 all: imp docs commit e7043efcda32635b4260344f11b5a61b5120a9d2 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Thu Jun 27 20:10:26 2024 +0300 all: client storage usage
2024-07-01 17:34:47 +03:00
parent 3993f4c476
commit 9d1c45fd94
11 changed files with 255 additions and 312 deletions
--- a/internal/client/index.go
+++ b/internal/client/index.go
@@ -30,8 +30,8 @@ func macToKey(mac net.HardwareAddr) (key macKey) {
 	}
 }

-// Index stores all information about persistent clients.
-type Index struct {
+// index stores all information about persistent clients.
+type index struct {
 	// nameToUID maps client name to UID.
 	nameToUID map[string]UID

@@ -51,9 +51,9 @@ type Index struct {
 	subnetToUID aghalg.SortedMap[netip.Prefix, UID]
 }

-// NewIndex initializes the new instance of client index.
-func NewIndex() (ci *Index) {
-	return &Index{
+// newIndex initializes the new instance of client index.
+func newIndex() (ci *index) {
+	return &index{
 		nameToUID:     map[string]UID{},
 		clientIDToUID: map[string]UID{},
 		ipToUID:       map[netip.Addr]UID{},
@@ -63,9 +63,9 @@ func NewIndex() (ci *Index) {
 	}
 }

-// Add stores information about a persistent client in the index.  c must be
+// add stores information about a persistent client in the index.  c must be
 // non-nil, have a UID, and contain at least one identifier.
-func (ci *Index) Add(c *Persistent) {
+func (ci *index) add(c *Persistent) {
 	if (c.UID == UID{}) {
 		panic("client must contain uid")
 	}
@@ -92,9 +92,9 @@ func (ci *Index) Add(c *Persistent) {
 	ci.uidToClient[c.UID] = c
 }

-// ClashesUID returns existing persistent client with the same UID as c.  Note
+// clashesUID returns existing persistent client with the same UID as c.  Note
 // that this is only possible when configuration contains duplicate fields.
-func (ci *Index) ClashesUID(c *Persistent) (err error) {
+func (ci *index) clashesUID(c *Persistent) (err error) {
 	p, ok := ci.uidToClient[c.UID]
 	if ok {
 		return fmt.Errorf("another client %q uses the same uid", p.Name)
@@ -103,9 +103,9 @@ func (ci *Index) ClashesUID(c *Persistent) (err error) {
 	return nil
 }

-// Clashes returns an error if the index contains a different persistent client
+// clashes returns an error if the index contains a different persistent client
 // with at least a single identifier contained by c.  c must be non-nil.
-func (ci *Index) Clashes(c *Persistent) (err error) {
+func (ci *index) clashes(c *Persistent) (err error) {
 	if p := ci.clashesName(c); p != nil {
 		return fmt.Errorf("another client uses the same name %q", p.Name)
 	}
@@ -139,8 +139,8 @@ func (ci *Index) Clashes(c *Persistent) (err error) {

 // clashesName returns existing persistent client with the same name as c or
 // nil.  c must be non-nil.
-func (ci *Index) clashesName(c *Persistent) (existing *Persistent) {
-	existing, ok := ci.FindByName(c.Name)
+func (ci *index) clashesName(c *Persistent) (existing *Persistent) {
+	existing, ok := ci.findByName(c.Name)
 	if !ok {
 		return nil
 	}
@@ -154,7 +154,7 @@ func (ci *Index) clashesName(c *Persistent) (existing *Persistent) {

 // clashesIP returns a previous client with the same IP address as c.  c must be
 // non-nil.
-func (ci *Index) clashesIP(c *Persistent) (p *Persistent, ip netip.Addr) {
+func (ci *index) clashesIP(c *Persistent) (p *Persistent, ip netip.Addr) {
 	for _, ip := range c.IPs {
 		existing, ok := ci.ipToUID[ip]
 		if ok && existing != c.UID {
@@ -167,7 +167,7 @@ func (ci *Index) clashesIP(c *Persistent) (p *Persistent, ip netip.Addr) {

 // clashesSubnet returns a previous client with the same subnet as c.  c must be
 // non-nil.
-func (ci *Index) clashesSubnet(c *Persistent) (p *Persistent, s netip.Prefix) {
+func (ci *index) clashesSubnet(c *Persistent) (p *Persistent, s netip.Prefix) {
 	for _, s = range c.Subnets {
 		var existing UID
 		var ok bool
@@ -193,7 +193,7 @@ func (ci *Index) clashesSubnet(c *Persistent) (p *Persistent, s netip.Prefix) {

 // clashesMAC returns a previous client with the same MAC address as c.  c must
 // be non-nil.
-func (ci *Index) clashesMAC(c *Persistent) (p *Persistent, mac net.HardwareAddr) {
+func (ci *index) clashesMAC(c *Persistent) (p *Persistent, mac net.HardwareAddr) {
 	for _, mac = range c.MACs {
 		k := macToKey(mac)
 		existing, ok := ci.macToUID[k]
@@ -205,9 +205,9 @@ func (ci *Index) clashesMAC(c *Persistent) (p *Persistent, mac net.HardwareAddr)
 	return nil, nil
 }

-// Find finds persistent client by string representation of the client ID, IP
+// find finds persistent client by string representation of the client ID, IP
 // address, or MAC.
-func (ci *Index) Find(id string) (c *Persistent, ok bool) {
+func (ci *index) find(id string) (c *Persistent, ok bool) {
 	uid, found := ci.clientIDToUID[id]
 	if found {
 		return ci.uidToClient[uid], true
@@ -224,14 +224,14 @@ func (ci *Index) Find(id string) (c *Persistent, ok bool) {

 	mac, err := net.ParseMAC(id)
 	if err == nil {
-		return ci.FindByMAC(mac)
+		return ci.findByMAC(mac)
 	}

 	return nil, false
 }

-// FindByName finds persistent client by name.
-func (ci *Index) FindByName(name string) (c *Persistent, found bool) {
+// findByName finds persistent client by name.
+func (ci *index) findByName(name string) (c *Persistent, found bool) {
 	uid, found := ci.nameToUID[name]
 	if found {
 		return ci.uidToClient[uid], true
@@ -241,7 +241,7 @@ func (ci *Index) FindByName(name string) (c *Persistent, found bool) {
 }

 // findByIP finds persistent client by IP address.
-func (ci *Index) findByIP(ip netip.Addr) (c *Persistent, found bool) {
+func (ci *index) findByIP(ip netip.Addr) (c *Persistent, found bool) {
 	uid, found := ci.ipToUID[ip]
 	if found {
 		return ci.uidToClient[uid], true
@@ -266,8 +266,8 @@ func (ci *Index) findByIP(ip netip.Addr) (c *Persistent, found bool) {
 	return nil, false
 }

-// FindByMAC finds persistent client by MAC.
-func (ci *Index) FindByMAC(mac net.HardwareAddr) (c *Persistent, found bool) {
+// findByMAC finds persistent client by MAC.
+func (ci *index) findByMAC(mac net.HardwareAddr) (c *Persistent, found bool) {
 	k := macToKey(mac)
 	uid, found := ci.macToUID[k]
 	if found {
@@ -277,13 +277,13 @@ func (ci *Index) FindByMAC(mac net.HardwareAddr) (c *Persistent, found bool) {
 	return nil, false
 }

-// FindByIPWithoutZone finds a persistent client by IP address without zone.  It
+// findByIPWithoutZone finds a persistent client by IP address without zone.  It
 // strips the IPv6 zone index from the stored IP addresses before comparing,
 // because querylog entries don't have it.  See TODO on [querylog.logEntry.IP].
 //
 // Note that multiple clients can have the same IP address with different zones.
 // Therefore, the result of this method is indeterminate.
-func (ci *Index) FindByIPWithoutZone(ip netip.Addr) (c *Persistent) {
+func (ci *index) findByIPWithoutZone(ip netip.Addr) (c *Persistent) {
 	if (ip == netip.Addr{}) {
 		return nil
 	}
@@ -297,9 +297,9 @@ func (ci *Index) FindByIPWithoutZone(ip netip.Addr) (c *Persistent) {
 	return nil
 }

-// Delete removes information about persistent client from the index.  c must be
+// remove removes information about persistent client from the index.  c must be
 // non-nil.
-func (ci *Index) Delete(c *Persistent) {
+func (ci *index) remove(c *Persistent) {
 	delete(ci.nameToUID, c.Name)

 	for _, id := range c.ClientIDs {
@@ -322,24 +322,14 @@ func (ci *Index) Delete(c *Persistent) {
 	delete(ci.uidToClient, c.UID)
 }

-// Size returns the number of persistent clients.
-func (ci *Index) Size() (n int) {
+// size returns the number of persistent clients.
+func (ci *index) size() (n int) {
 	return len(ci.uidToClient)
 }

-// Range calls f for each persistent client, unless cont is false.  The order is
-// undefined.
-func (ci *Index) Range(f func(c *Persistent) (cont bool)) {
-	for _, c := range ci.uidToClient {
-		if !f(c) {
-			return
-		}
-	}
-}
-
-// RangeByName is like [Index.Range] but sorts the persistent clients by name
+// rangeByName is like [Index.Range] but sorts the persistent clients by name
 // before iterating ensuring a predictable order.
-func (ci *Index) RangeByName(f func(c *Persistent) (cont bool)) {
+func (ci *index) rangeByName(f func(c *Persistent) (cont bool)) {
 	cs := maps.Values(ci.uidToClient)
 	slices.SortFunc(cs, func(a, b *Persistent) (n int) {
 		return strings.Compare(a.Name, b.Name)
@@ -352,10 +342,10 @@ func (ci *Index) RangeByName(f func(c *Persistent) (cont bool)) {
 	}
 }

-// CloseUpstreams closes upstream configurations of persistent clients.
-func (ci *Index) CloseUpstreams() (err error) {
+// closeUpstreams closes upstream configurations of persistent clients.
+func (ci *index) closeUpstreams() (err error) {
 	var errs []error
-	ci.RangeByName(func(c *Persistent) (cont bool) {
+	ci.rangeByName(func(c *Persistent) (cont bool) {
 		err = c.CloseUpstreams()
 		if err != nil {
 			errs = append(errs, err)
--- a/internal/client/index_internal_test.go
+++ b/internal/client/index_internal_test.go
@@ -11,12 +11,12 @@ import (

 // newIDIndex is a helper function that returns a client index filled with
 // persistent clients from the m.  It also generates a UID for each client.
-func newIDIndex(m []*Persistent) (ci *Index) {
-	ci = NewIndex()
+func newIDIndex(m []*Persistent) (ci *index) {
+	ci = newIndex()

 	for _, c := range m {
 		c.UID = MustNewUID()
-		ci.Add(c)
+		ci.add(c)
 	}

 	return ci
@@ -110,7 +110,7 @@ func TestClientIndex_Find(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			for _, id := range tc.ids {
-				c, ok := ci.Find(id)
+				c, ok := ci.find(id)
 				require.True(t, ok)

 				assert.Equal(t, tc.want, c)
@@ -119,7 +119,7 @@ func TestClientIndex_Find(t *testing.T) {
 	}

 	t.Run("not_found", func(t *testing.T) {
-		_, ok := ci.Find(cliIPNone)
+		_, ok := ci.find(cliIPNone)
 		assert.False(t, ok)
 	})
 }
@@ -171,11 +171,11 @@ func TestClientIndex_Clashes(t *testing.T) {
 			clone := tc.client.ShallowClone()
 			clone.UID = MustNewUID()

-			err := ci.Clashes(clone)
+			err := ci.clashes(clone)
 			require.Error(t, err)

-			ci.Delete(tc.client)
-			err = ci.Clashes(clone)
+			ci.remove(tc.client)
+			err = ci.clashes(clone)
 			require.NoError(t, err)
 		})
 	}
@@ -293,7 +293,7 @@ func TestIndex_FindByIPWithoutZone(t *testing.T) {

 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			c := ci.FindByIPWithoutZone(tc.ip.WithZone(""))
+			c := ci.findByIPWithoutZone(tc.ip.WithZone(""))
 			require.Equal(t, tc.want, c)
 		})
 	}
@@ -339,7 +339,7 @@ func TestClientIndex_RangeByName(t *testing.T) {
 			ci := newIDIndex(tc.want)

 			var got []*Persistent
-			ci.RangeByName(func(c *Persistent) (cont bool) {
+			ci.rangeByName(func(c *Persistent) (cont bool) {
 				got = append(got, c)

 				return true
--- a/internal/client/persistent.go
+++ b/internal/client/persistent.go
@@ -65,6 +65,7 @@ type Persistent struct {
 	// upstream must be used.
 	UpstreamConfig *proxy.CustomUpstreamConfig

+	// SafeSearch handles search engine hosts rewrites.
 	SafeSearch filtering.SafeSearch

 	// BlockedServices is the configuration of blocked services of a client.  It
@@ -74,29 +75,62 @@ type Persistent struct {
 	// Name of the persistent client.  Must not be empty.
 	Name string

-	Tags      []string
+	// Tags is a list of client tags that categorize the client.
+	Tags []string
+
+	// Upstreams is a list of custom upstream DNS servers for the client.
 	Upstreams []string

+	// IPs is a list of IP addresses that identify the client.  The client must
+	// have at least one ID (IP, subnet, MAC, or ClientID).
 	IPs []netip.Addr
+
+	// Subnets identifying the client.  The client must have at least one ID
+	// (IP, subnet, MAC, or ClientID).
+	//
 	// TODO(s.chzhen):  Use netutil.Prefix.
-	Subnets   []netip.Prefix
-	MACs      []net.HardwareAddr
+	Subnets []netip.Prefix
+
+	// MACs identifying the client.  The client must have at least one ID (IP,
+	// subnet, MAC, or ClientID).
+	MACs []net.HardwareAddr
+
+	// ClientIDs identifying the client.  The client must have at least one ID
+	// (IP, subnet, MAC, or ClientID).
 	ClientIDs []string

 	// UID is the unique identifier of the persistent client.
 	UID UID

-	UpstreamsCacheSize    uint32
+	// UpstreamsCacheSize is the cache size for custom upstreams.
+	UpstreamsCacheSize uint32
+
+	// UpstreamsCacheEnabled specifies whether custom upstreams are used.
 	UpstreamsCacheEnabled bool

-	UseOwnSettings        bool
-	FilteringEnabled      bool
-	SafeBrowsingEnabled   bool
-	ParentalEnabled       bool
-	UseOwnBlockedServices bool
-	IgnoreQueryLog        bool
-	IgnoreStatistics      bool
+	// UseOwnSettings specifies whether custom filtering settings are used.
+	UseOwnSettings bool

+	// FilteringEnabled specifies whether filtering is enabled.
+	FilteringEnabled bool
+
+	// SafeBrowsingEnabled specifies whether safe browsing is enabled.
+	SafeBrowsingEnabled bool
+
+	// ParentalEnabled specifies whether parental control is enabled.
+	ParentalEnabled bool
+
+	// UseOwnBlockedServices specifies whether custom services are blocked.
+	UseOwnBlockedServices bool
+
+	// IgnoreQueryLog specifies whether the client requests are logged.
+	IgnoreQueryLog bool
+
+	// IgnoreStatistics  specifies whether the client requests are counted.
+	IgnoreStatistics bool
+
+	// SafeSearchConf is the safe search filtering configuration.
+	//
 	// TODO(d.kolyshev): Make SafeSearchConf a pointer.
 	SafeSearchConf filtering.SafeSearchConfig
 }
@@ -134,21 +168,6 @@ func (c *Persistent) validate(allTags *container.MapSet[string]) (err error) {
 	return nil
 }

-// SetTags sets the tags if they are known, otherwise logs an unknown tag.
-func (c *Persistent) SetTags(tags []string, known *container.MapSet[string]) {
-	for _, t := range tags {
-		if !known.Has(t) {
-			log.Info("skipping unknown tag %q", t)
-
-			continue
-		}
-
-		c.Tags = append(c.Tags, t)
-	}
-
-	slices.Sort(c.Tags)
-}
-
 // SetIDs parses a list of strings into typed fields and returns an error if
 // there is one.
 func (c *Persistent) SetIDs(ids []string) (err error) {
--- a/internal/client/persistent_internal_test.go
+++ b/internal/client/persistent_internal_test.go
@@ -4,6 +4,7 @@ import (
 	"net/netip"
 	"testing"

+	"github.com/AdguardTeam/golibs/container"
 	"github.com/AdguardTeam/golibs/testutil"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -126,13 +127,19 @@ func TestPersistent_EqualIDs(t *testing.T) {
 }

 func TestPersistent_Validate(t *testing.T) {
-	// TODO(s.chzhen):  Add test cases.
+	const (
+		allowedTag    = "allowed_tag"
+		notAllowedTag = "not_allowed_tag"
+	)
+
+	allowedTags := container.NewMapSet(allowedTag)
+
 	testCases := []struct {
 		name       string
 		cli        *Persistent
 		wantErrMsg string
 	}{{
-		name: "basic",
+		name: "success",
 		cli: &Persistent{
 			Name: "basic",
 			IPs: []netip.Addr{
@@ -162,11 +169,24 @@ func TestPersistent_Validate(t *testing.T) {
 			},
 		},
 		wantErrMsg: "uid required",
+	}, {
+		name: "not_allowed_tag",
+		cli: &Persistent{
+			Name: "basic",
+			IPs: []netip.Addr{
+				netip.MustParseAddr("1.2.3.4"),
+			},
+			UID: MustNewUID(),
+			Tags: []string{
+				notAllowedTag,
+			},
+		},
+		wantErrMsg: `invalid tag: "` + notAllowedTag + `"`,
 	}}

 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			err := tc.cli.validate(nil)
+			err := tc.cli.validate(allowedTags)
 			testutil.AssertErrorMsg(t, tc.wantErrMsg, err)
 		})
 	}
--- a/internal/client/storage.go
+++ b/internal/client/storage.go
@@ -11,6 +11,14 @@ import (
 	"github.com/AdguardTeam/golibs/log"
 )

+// Config is the client storage configuration structure.
+//
+// TODO(s.chzhen):  Expand.
+type Config struct {
+	// AllowedTags is a list of all allowed client tags.
+	AllowedTags []string
+}
+
 // Storage contains information about persistent and runtime clients.
 type Storage struct {
 	// allowedTags is a set of all allowed tags.
@@ -20,18 +28,22 @@ type Storage struct {
 	mu *sync.Mutex

 	// index contains information about persistent clients.
-	index *Index
+	index *index

 	// runtimeIndex contains information about runtime clients.
+	//
+	// TODO(s.chzhen):  Use it.
 	runtimeIndex *RuntimeIndex
 }

-// NewStorage returns initialized client storage.
-func NewStorage(allowedTags *container.MapSet[string]) (s *Storage) {
+// NewStorage returns initialized client storage.  conf must not be nil.
+func NewStorage(conf *Config) (s *Storage) {
+	allowedTags := container.NewMapSet(conf.AllowedTags...)
+
 	return &Storage{
 		allowedTags:  allowedTags,
 		mu:           &sync.Mutex{},
-		index:        NewIndex(),
+		index:        newIndex(),
 		runtimeIndex: NewRuntimeIndex(),
 	}
 }
@@ -49,40 +61,45 @@ func (s *Storage) Add(p *Persistent) (err error) {
 	s.mu.Lock()
 	defer s.mu.Unlock()

-	err = s.index.ClashesUID(p)
+	err = s.index.clashesUID(p)
 	if err != nil {
 		// Don't wrap the error since there is already an annotation deferred.
 		return err
 	}

-	err = s.index.Clashes(p)
+	err = s.index.clashes(p)
 	if err != nil {
 		// Don't wrap the error since there is already an annotation deferred.
 		return err
 	}

-	s.index.Add(p)
+	s.index.add(p)

-	log.Debug("client storage: added %q: IDs: %q [%d]", p.Name, p.IDs(), s.index.Size())
+	log.Debug("client storage: added %q: IDs: %q [%d]", p.Name, p.IDs(), s.index.size())

 	return nil
 }

-// FindByName finds persistent client by name.
-func (s *Storage) FindByName(name string) (c *Persistent, found bool) {
+// FindByName finds persistent client by name.  And returns its shallow copy.
+func (s *Storage) FindByName(name string) (p *Persistent, ok bool) {
 	s.mu.Lock()
 	defer s.mu.Unlock()

-	return s.index.FindByName(name)
+	p, ok = s.index.findByName(name)
+	if ok {
+		return p.ShallowClone(), ok
+	}
+
+	return nil, false
 }

 // Find finds persistent client by string representation of the client ID, IP
-// address, or MAC.  And returns it shallow copy.
+// address, or MAC.  And returns its shallow copy.
 func (s *Storage) Find(id string) (p *Persistent, ok bool) {
 	s.mu.Lock()
 	defer s.mu.Unlock()

-	p, ok = s.index.Find(id)
+	p, ok = s.index.find(id)
 	if ok {
 		return p.ShallowClone(), ok
 	}
@@ -101,12 +118,12 @@ func (s *Storage) FindLoose(ip netip.Addr, id string) (p *Persistent, ok bool) {
 	s.mu.Lock()
 	defer s.mu.Unlock()

-	p, ok = s.index.Find(id)
+	p, ok = s.index.find(id)
 	if ok {
 		return p.ShallowClone(), ok
 	}

-	p = s.index.FindByIPWithoutZone(ip)
+	p = s.index.findByIPWithoutZone(ip)
 	if p != nil {
 		return p.ShallowClone(), true
 	}
@@ -114,12 +131,17 @@ func (s *Storage) FindLoose(ip netip.Addr, id string) (p *Persistent, ok bool) {
 	return nil, false
 }

-// FindByMAC finds persistent client by MAC.
-func (s *Storage) FindByMAC(mac net.HardwareAddr) (c *Persistent, found bool) {
+// FindByMAC finds persistent client by MAC and returns its shallow copy.
+func (s *Storage) FindByMAC(mac net.HardwareAddr) (p *Persistent, ok bool) {
 	s.mu.Lock()
 	defer s.mu.Unlock()

-	return s.index.FindByMAC(mac)
+	p, ok = s.index.findByMAC(mac)
+	if ok {
+		return p.ShallowClone(), ok
+	}
+
+	return nil, false
 }

 // RemoveByName removes persistent client information.  ok is false if no such
@@ -128,7 +150,7 @@ func (s *Storage) RemoveByName(name string) (ok bool) {
 	s.mu.Lock()
 	defer s.mu.Unlock()

-	p, ok := s.index.FindByName(name)
+	p, ok := s.index.findByName(name)
 	if !ok {
 		return false
 	}
@@ -137,7 +159,7 @@ func (s *Storage) RemoveByName(name string) (ok bool) {
 		log.Error("client storage: removing client %q: %s", p.Name, err)
 	}

-	s.index.Delete(p)
+	s.index.remove(p)

 	return true
 }
@@ -156,7 +178,7 @@ func (s *Storage) Update(name string, p *Persistent) (err error) {
 	s.mu.Lock()
 	defer s.mu.Unlock()

-	stored, ok := s.index.FindByName(name)
+	stored, ok := s.index.findByName(name)
 	if !ok {
 		return fmt.Errorf("client %q is not found", name)
 	}
@@ -166,14 +188,14 @@ func (s *Storage) Update(name string, p *Persistent) (err error) {
 	// TODO(s.chzhen):  Remove when frontend starts handling UIDs.
 	p.UID = stored.UID

-	err = s.index.Clashes(p)
+	err = s.index.clashes(p)
 	if err != nil {
 		// Don't wrap the error since there is already an annotation deferred.
 		return err
 	}

-	s.index.Delete(stored)
-	s.index.Add(p)
+	s.index.remove(stored)
+	s.index.add(p)

 	return nil
 }
@@ -184,7 +206,7 @@ func (s *Storage) RangeByName(f func(c *Persistent) (cont bool)) {
 	s.mu.Lock()
 	defer s.mu.Unlock()

-	s.index.RangeByName(f)
+	s.index.rangeByName(f)
 }

 // Size returns the number of persistent clients.
@@ -192,7 +214,7 @@ func (s *Storage) Size() (n int) {
 	s.mu.Lock()
 	defer s.mu.Unlock()

-	return s.index.Size()
+	return s.index.size()
 }

 // CloseUpstreams closes upstream configurations of persistent clients.
@@ -200,11 +222,13 @@ func (s *Storage) CloseUpstreams() (err error) {
 	s.mu.Lock()
 	defer s.mu.Unlock()

-	return s.index.CloseUpstreams()
+	return s.index.closeUpstreams()
 }

 // ClientRuntime returns a copy of the saved runtime client by ip.  If no such
 // client exists, returns nil.
+//
+// TODO(s.chzhen):  Use it.
 func (s *Storage) ClientRuntime(ip netip.Addr) (rc *Runtime) {
 	s.mu.Lock()
 	defer s.mu.Unlock()
@@ -214,6 +238,8 @@ func (s *Storage) ClientRuntime(ip netip.Addr) (rc *Runtime) {

 // AddRuntime saves the runtime client information in the storage.  IP address
 // of a client must be unique.  rc must not be nil.
+//
+// TODO(s.chzhen):  Use it.
 func (s *Storage) AddRuntime(rc *Runtime) {
 	s.mu.Lock()
 	defer s.mu.Unlock()
@@ -222,6 +248,8 @@ func (s *Storage) AddRuntime(rc *Runtime) {
 }

 // SizeRuntime returns the number of the runtime clients.
+//
+// TODO(s.chzhen):  Use it.
 func (s *Storage) SizeRuntime() (n int) {
 	s.mu.Lock()
 	defer s.mu.Unlock()
@@ -230,6 +258,8 @@ func (s *Storage) SizeRuntime() (n int) {
 }

 // RangeRuntime calls f for each runtime client in an undefined order.
+//
+// TODO(s.chzhen):  Use it.
 func (s *Storage) RangeRuntime(f func(rc *Runtime) (cont bool)) {
 	s.mu.Lock()
 	defer s.mu.Unlock()
@@ -238,6 +268,8 @@ func (s *Storage) RangeRuntime(f func(rc *Runtime) (cont bool)) {
 }

 // DeleteRuntime removes the runtime client by ip.
+//
+// TODO(s.chzhen):  Use it.
 func (s *Storage) DeleteRuntime(ip netip.Addr) {
 	s.mu.Lock()
 	defer s.mu.Unlock()
@@ -247,6 +279,8 @@ func (s *Storage) DeleteRuntime(ip netip.Addr) {

 // DeleteBySource removes all runtime clients that have information only from
 // the specified source and returns the number of removed clients.
+//
+// TODO(s.chzhen):  Use it.
 func (s *Storage) DeleteBySource(src Source) (n int) {
 	s.mu.Lock()
 	defer s.mu.Unlock()
--- a/internal/client/storage_test.go
+++ b/internal/client/storage_test.go
@@ -16,7 +16,9 @@ import (
 func newStorage(tb testing.TB, m []*client.Persistent) (s *client.Storage) {
 	tb.Helper()

-	s = client.NewStorage(nil)
+	s = client.NewStorage(&client.Config{
+		AllowedTags: nil,
+	})

 	for _, c := range m {
 		c.UID = client.MustNewUID()
@@ -57,7 +59,9 @@ func TestStorage_Add(t *testing.T) {
 		UID:       existingClientUID,
 	}

-	s := client.NewStorage(nil)
+	s := client.NewStorage(&client.Config{
+		AllowedTags: nil,
+	})
 	err := s.Add(existingClient)
 	require.NoError(t, err)

@@ -137,7 +141,9 @@ func TestStorage_RemoveByName(t *testing.T) {
 		UID:  client.MustNewUID(),
 	}

-	s := client.NewStorage(nil)
+	s := client.NewStorage(&client.Config{
+		AllowedTags: nil,
+	})
 	err := s.Add(existingClient)
 	require.NoError(t, err)

@@ -162,7 +168,9 @@ func TestStorage_RemoveByName(t *testing.T) {
 	}

 	t.Run("duplicate_remove", func(t *testing.T) {
-		s = client.NewStorage(nil)
+		s = client.NewStorage(&client.Config{
+			AllowedTags: nil,
+		})
 		err = s.Add(existingClient)
 		require.NoError(t, err)