From 5a9211e8c7832700ae4f58cea25ad38ccba98efa Mon Sep 17 00:00:00 2001
From: Stanislav Chzhen <s.chzhen@adguard.com>
Date: Thu, 22 Feb 2024 19:08:35 +0300
Subject: [PATCH] all: add todo

---
 internal/aghtest/interface_test.go     | 4 ++++
 internal/client/index.go               | 4 ++--
 internal/client/index_internal_test.go | 2 +-
 internal/client/persistent.go          | 3 ++-
 internal/home/clients.go               | 2 +-
 5 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/internal/aghtest/interface_test.go b/internal/aghtest/interface_test.go
index b233df46a37..f0f55451090 100644
--- a/internal/aghtest/interface_test.go
+++ b/internal/aghtest/interface_test.go
@@ -16,7 +16,11 @@ var _ filtering.Resolver = (*aghtest.Resolver)(nil)
 var _ dnsforward.ClientsContainer = (*aghtest.ClientsContainer)(nil)
 
 // type check
+//
+// TODO(s.chzhen):  It's here to avoid the import cycle.  Remove it.
 var _ client.AddressProcessor = (*aghtest.AddressProcessor)(nil)
 
 // type check
+//
+// TODO(s.chzhen):  It's here to avoid the import cycle.  Remove it.
 var _ client.AddressUpdater = (*aghtest.AddressUpdater)(nil)
diff --git a/internal/client/index.go b/internal/client/index.go
index a3a100695c4..c6a17cb3703 100644
--- a/internal/client/index.go
+++ b/internal/client/index.go
@@ -225,9 +225,9 @@ func (ci *Index) findByMAC(mac net.HardwareAddr) (c *Persistent, found bool) {
 	return nil, false
 }
 
-// Del removes information about persistent client from the index.  c must be
+// Delete removes information about persistent client from the index.  c must be
 // non-nil.
-func (ci *Index) Del(c *Persistent) {
+func (ci *Index) Delete(c *Persistent) {
 	for _, id := range c.ClientIDs {
 		delete(ci.clientIDToUID, id)
 	}
diff --git a/internal/client/index_internal_test.go b/internal/client/index_internal_test.go
index 6cfd5e139e4..abf38710427 100644
--- a/internal/client/index_internal_test.go
+++ b/internal/client/index_internal_test.go
@@ -146,7 +146,7 @@ func TestClientIndex_Clashes(t *testing.T) {
 			err := ci.Clashes(clone)
 			require.Error(t, err)
 
-			ci.Del(tc.client)
+			ci.Delete(tc.client)
 			err = ci.Clashes(clone)
 			require.NoError(t, err)
 		})
diff --git a/internal/client/persistent.go b/internal/client/persistent.go
index c56d9435de4..d70966d791b 100644
--- a/internal/client/persistent.go
+++ b/internal/client/persistent.go
@@ -193,7 +193,8 @@ func (c *Persistent) setID(id string) (err error) {
 
 // ValidateClientID returns an error if id is not a valid ClientID.
 //
-// Keep in sync with [dnsforward.ValidateClientID].
+// TODO(s.chzhen):  It's an exact copy of the [dnsforward.ValidateClientID] to
+// avoid the import cycle.  Remove it.
 func ValidateClientID(id string) (err error) {
 	err = netutil.ValidateHostnameLabel(id)
 	if err != nil {
diff --git a/internal/home/clients.go b/internal/home/clients.go
index decb62cabff..fb627a2e14a 100644
--- a/internal/home/clients.go
+++ b/internal/home/clients.go
@@ -681,7 +681,7 @@ func (clients *clientsContainer) removeLocked(c *client.Persistent) {
 	delete(clients.list, c.Name)
 
 	// Update the ID index.
-	clients.clientIndex.Del(c)
+	clients.clientIndex.Delete(c)
 }
 
 // update updates a client by its name.