Pull request 2346: AGDNS-2686-client-upstream-manager
Merge in DNS/adguard-home from AGDNS-2686-client-upstream-manager to master Squashed commit of the following: commit 563cb583f01c26434fa04d0e37dcbe2ba15c0912 Merge: f4b0caf5c61fe269cbAuthor: Stanislav Chzhen <s.chzhen@adguard.com> Date: Mon Mar 3 19:07:35 2025 +0300 Merge branch 'master' into AGDNS-2686-client-upstream-manager commit f4b0caf5c8bc48ee8be97f031cd1aa1399eb461c Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Thu Feb 27 21:52:51 2025 +0300 client: imp docs commit e7d74931b1cc9b62eeadbe1168ae5781d57d6c73 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Wed Feb 26 21:44:04 2025 +0300 client: imp code commit 1cba38c1bc3b6b5afb7829c230c4e831f789647e Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Wed Feb 26 18:06:17 2025 +0300 client: fix typo commit 65b6b1e8c0fde47f367c428a78fefc4c63bc45f9 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Wed Feb 26 17:52:02 2025 +0300 all: imp code, docs commit ed158ef09fc26bc9c57c91dbfa04d89fede583d0 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Wed Feb 26 14:34:50 2025 +0300 client: imp code commit ab897f64c8751ea158408521116d5b689e6d39a9 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Tue Feb 25 18:26:16 2025 +0300 all: upd chlog commit a2c30e3ede6fb61f6d23fd392cc3035dc96f77af Merge: bdb08ee0ed8ce5b453Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Tue Feb 25 17:40:32 2025 +0300 Merge branch 'master' into AGDNS-2686-client-upstream-manager commit bdb08ee0e6122de727f2749a44f5df7e29d0eee2 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Tue Feb 25 17:16:31 2025 +0300 all: imp tests commit 00f0eb60474a2297567acf5a3a27e8b5c2d99229 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Thu Feb 20 21:37:58 2025 +0300 all: imp code, docs commit 13934176636dd70a17e53bc1956d6cf51602760a Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Wed Feb 19 15:58:11 2025 +0300 all: client upstream manager
This commit is contained in:
Stanislav Chzhen
219
internal/client/upstreammanager.go
Normal file
219
internal/client/upstreammanager.go
Normal file
@@ -0,0 +1,219 @@
|
||||
package client
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"slices"
|
||||
"time"
|
||||
|
||||
"github.com/AdguardTeam/AdGuardHome/internal/aghnet"
|
||||
"github.com/AdguardTeam/dnsproxy/proxy"
|
||||
"github.com/AdguardTeam/dnsproxy/upstream"
|
||||
"github.com/AdguardTeam/golibs/errors"
|
||||
"github.com/AdguardTeam/golibs/logutil/slogutil"
|
||||
"github.com/AdguardTeam/golibs/stringutil"
|
||||
)
|
||||
|
||||
// CommonUpstreamConfig contains common settings for custom client upstream
|
||||
// configurations.
|
||||
type CommonUpstreamConfig struct {
|
||||
Bootstrap upstream.Resolver
|
||||
UpstreamTimeout time.Duration
|
||||
BootstrapPreferIPv6 bool
|
||||
EDNSClientSubnetEnabled bool
|
||||
UseHTTP3Upstreams bool
|
||||
}
|
||||
|
||||
// customUpstreamConfig contains custom client upstream configuration and the
|
||||
// timestamp of the latest configuration update.
|
||||
type customUpstreamConfig struct {
|
||||
// proxyConf is the constructed upstream configuration for the [proxy],
|
||||
// derived from the fields below. It is initialized on demand with
|
||||
// [newCustomUpstreamConfig].
|
||||
proxyConf *proxy.CustomUpstreamConfig
|
||||
|
||||
// commonConfUpdate is the timestamp of the latest configuration update,
|
||||
// used to check against [upstreamManager.confUpdate] to determine if the
|
||||
// configuration is up to date.
|
||||
commonConfUpdate time.Time
|
||||
|
||||
// upstreams is the cached list of custom upstream DNS servers used for the
|
||||
// configuration of proxyConf.
|
||||
upstreams []string
|
||||
|
||||
// upstreamsCacheSize is the cached value of the cache size of the
|
||||
// upstreams, used for the configuration of proxyConf.
|
||||
upstreamsCacheSize uint32
|
||||
|
||||
// upstreamsCacheEnabled is the cached value indicating whether the cache of
|
||||
// the upstreams is enabled for the configuration of proxyConf.
|
||||
upstreamsCacheEnabled bool
|
||||
|
||||
// isChanged indicates whether the proxyConf needs to be updated.
|
||||
isChanged bool
|
||||
}
|
||||
|
||||
// upstreamManager stores and updates custom client upstream configurations.
|
||||
type upstreamManager struct {
|
||||
// logger is used for logging the operation of the upstream manager. It
|
||||
// must not be nil.
|
||||
//
|
||||
// TODO(s.chzhen): Consider using a logger with its own prefix.
|
||||
logger *slog.Logger
|
||||
|
||||
// uidToCustomConf maps persistent client UID to the custom client upstream
|
||||
// configuration. Stored UIDs must be in sync with the [index.uidToClient].
|
||||
uidToCustomConf map[UID]*customUpstreamConfig
|
||||
|
||||
// commonConf is the common upstream configuration.
|
||||
commonConf *CommonUpstreamConfig
|
||||
|
||||
// confUpdate is the timestamp of the latest common upstream configuration
|
||||
// update.
|
||||
confUpdate time.Time
|
||||
}
|
||||
|
||||
// newUpstreamManager returns the new properly initialized upstream manager.
|
||||
func newUpstreamManager(logger *slog.Logger) (m *upstreamManager) {
|
||||
return &upstreamManager{
|
||||
logger: logger,
|
||||
uidToCustomConf: make(map[UID]*customUpstreamConfig),
|
||||
}
|
||||
}
|
||||
|
||||
// updateCommonUpstreamConfig updates the common upstream configuration and the
|
||||
// timestamp of the latest configuration update.
|
||||
func (m *upstreamManager) updateCommonUpstreamConfig(conf *CommonUpstreamConfig) {
|
||||
m.commonConf = conf
|
||||
m.confUpdate = time.Now()
|
||||
}
|
||||
|
||||
// updateCustomUpstreamConfig updates the stored custom client upstream
|
||||
// configuration associated with the persistent client. It also sets
|
||||
// [customUpstreamConfig.isChanged] to true so [customUpstreamConfig.proxyConf]
|
||||
// can be updated later in [upstreamManager.customUpstreamConfig].
|
||||
func (m *upstreamManager) updateCustomUpstreamConfig(c *Persistent) {
|
||||
cliConf, ok := m.uidToCustomConf[c.UID]
|
||||
if !ok {
|
||||
cliConf = &customUpstreamConfig{
|
||||
commonConfUpdate: m.confUpdate,
|
||||
}
|
||||
|
||||
m.uidToCustomConf[c.UID] = cliConf
|
||||
}
|
||||
|
||||
// TODO(s.chzhen): Compare before cloning.
|
||||
cliConf.upstreams = slices.Clone(c.Upstreams)
|
||||
cliConf.upstreamsCacheSize = c.UpstreamsCacheSize
|
||||
cliConf.upstreamsCacheEnabled = c.UpstreamsCacheEnabled
|
||||
cliConf.isChanged = true
|
||||
}
|
||||
|
||||
// customUpstreamConfig returns the custom client upstream configuration.
|
||||
func (m *upstreamManager) customUpstreamConfig(uid UID) (proxyConf *proxy.CustomUpstreamConfig) {
|
||||
cliConf, ok := m.uidToCustomConf[uid]
|
||||
if !ok {
|
||||
// TODO(s.chzhen): Consider panic.
|
||||
m.logger.Error("no associated custom client upstream config")
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
if !m.isConfigChanged(cliConf) {
|
||||
return cliConf.proxyConf
|
||||
}
|
||||
|
||||
if cliConf.proxyConf != nil {
|
||||
err := cliConf.proxyConf.Close()
|
||||
if err != nil {
|
||||
// TODO(s.chzhen): Pass context.
|
||||
m.logger.Debug("closing custom upstream config", slogutil.KeyError, err)
|
||||
}
|
||||
}
|
||||
|
||||
proxyConf = newCustomUpstreamConfig(cliConf, m.commonConf)
|
||||
cliConf.proxyConf = proxyConf
|
||||
cliConf.isChanged = false
|
||||
|
||||
return proxyConf
|
||||
}
|
||||
|
||||
// isConfigChanged returns true if the update is necessary for the custom client
|
||||
// upstream configuration.
|
||||
func (m *upstreamManager) isConfigChanged(cliConf *customUpstreamConfig) (ok bool) {
|
||||
return !m.confUpdate.Equal(cliConf.commonConfUpdate) || cliConf.isChanged
|
||||
}
|
||||
|
||||
// clearUpstreamCache clears the upstream cache for each stored custom client
|
||||
// upstream configuration.
|
||||
func (m *upstreamManager) clearUpstreamCache() {
|
||||
for _, c := range m.uidToCustomConf {
|
||||
c.proxyConf.ClearCache()
|
||||
}
|
||||
}
|
||||
|
||||
// remove deletes the custom client upstream configuration and closes
|
||||
// [customUpstreamConfig.proxyConf] if necessary.
|
||||
func (m *upstreamManager) remove(uid UID) (err error) {
|
||||
cliConf, ok := m.uidToCustomConf[uid]
|
||||
if !ok {
|
||||
// TODO(s.chzhen): Consider panic.
|
||||
return errors.Error("no associated custom client upstream config")
|
||||
}
|
||||
|
||||
delete(m.uidToCustomConf, uid)
|
||||
|
||||
if cliConf.proxyConf != nil {
|
||||
return cliConf.proxyConf.Close()
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// close shuts down each stored custom client upstream configuration.
|
||||
func (m *upstreamManager) close() (err error) {
|
||||
var errs []error
|
||||
for _, c := range m.uidToCustomConf {
|
||||
if c.proxyConf == nil {
|
||||
continue
|
||||
}
|
||||
|
||||
errs = append(errs, c.proxyConf.Close())
|
||||
}
|
||||
|
||||
return errors.Join(errs...)
|
||||
}
|
||||
|
||||
// newCustomUpstreamConfig returns the new properly initialized custom proxy
|
||||
// upstream configuration for the client.
|
||||
func newCustomUpstreamConfig(
|
||||
cliConf *customUpstreamConfig,
|
||||
conf *CommonUpstreamConfig,
|
||||
) (proxyConf *proxy.CustomUpstreamConfig) {
|
||||
upstreams := stringutil.FilterOut(cliConf.upstreams, aghnet.IsCommentOrEmpty)
|
||||
if len(upstreams) == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
upsConf, err := proxy.ParseUpstreamsConfig(
|
||||
upstreams,
|
||||
&upstream.Options{
|
||||
Bootstrap: conf.Bootstrap,
|
||||
Timeout: time.Duration(conf.UpstreamTimeout),
|
||||
HTTPVersions: aghnet.UpstreamHTTPVersions(conf.UseHTTP3Upstreams),
|
||||
PreferIPv6: conf.BootstrapPreferIPv6,
|
||||
},
|
||||
)
|
||||
if err != nil {
|
||||
// Should not happen because upstreams are already validated. See
|
||||
// [Persistent.validate].
|
||||
panic(fmt.Errorf("creating custom upstream config: %w", err))
|
||||
}
|
||||
|
||||
return proxy.NewCustomUpstreamConfig(
|
||||
upsConf,
|
||||
cliConf.upstreamsCacheEnabled,
|
||||
int(cliConf.upstreamsCacheSize),
|
||||
conf.EDNSClientSubnetEnabled,
|
||||
)
|
||||
}
|
||||
Reference in New Issue
Block a user