Merge branch 'master' into ADG-10291

Author: IldarKamalov

CHANGELOG.md

@@ -17,6 +17,42 @@ See also the [v0.107.65 GitHub milestone][ms-v0.107.65].
 
 NOTE: Add new changes BELOW THIS COMMENT.
 -->
+
+### Added
+
+- A separate checkbox in the Web UI to enable or disable the global DNS response cache without losing the configured cache size.
+
+- A new `"cache_enabled"` field to the HTTP API (`GET /control/dns_info` and `POST /control/dns_config`).  See `openapi/openapi.yaml` for the full description.
+
+### Changed
+
+#### Configuration changes
+
+In this release, the schema version has changed from 29 to 30.
+
+- Added a new boolean field `dns.cache_enabled` to the configuration.  This field explicitly controls whether DNS caching is enabled, replacing the previous implicit logic based on `dns.cache_size`.
+
+    ```yaml
+    # BEFORE:
+    'dns':
+        # …
+        'cache_size': 123456
+
+    # AFTER:
+    'dns':
+        # …
+        'cache_enabled': true
+        'cache_size': 123456
+    ```
+
+    To roll back this change, set the schema_version back to `29`.
+
+### Fixed
+
+- Disabled state of Top clients action button in web UI ([#7923]).
+
+[#7923]: https://github.com/AdguardTeam/AdGuardHome/issues/7923
+
 <!--
 NOTE: Add new changes ABOVE THIS COMMENT.
 -->

client/src/__locales/en.json

@@ -655,7 +655,10 @@
     "safe_search": "Safe Search",
     "blocklist": "Blocklist",
     "milliseconds_abbreviation": "ms",
+    "cache_enabled": "Enable cache",
+    "cache_enabled_desc": "Store DNS responses locally.",
     "cache_size": "Cache size",
+    "cache_size_validation": "The cache size must be greater than zero when enabled.",
     "cache_size_desc": "DNS cache size (in bytes). To disable caching, set to 0.",
     "cache_ttl_min_override": "Override minimum TTL",
     "cache_ttl_max_override": "Override maximum TTL",

client/src/components/Logs/Logs.css

@@ -337,7 +337,8 @@
 }
 
 .button-action--arrow-option:disabled {
-    display: none;
+    opacity: 0.5;
+    cursor: default;
 }
 
 .tooltip-custom__container .button-action--arrow-option {

client/src/components/Settings/Dns/Cache/Form.tsx

@@ -32,6 +32,7 @@ const INPUTS_FIELDS = [
 ];
 
 type FormData = {
+    cache_enabled: boolean;
     cache_size: number;
     cache_ttl_min: number;
     cache_ttl_max: number;
@@ -54,21 +55,25 @@ const Form = ({ initialValues, onSubmit }: CacheFormProps) => {
         handleSubmit,
         watch,
         control,
-        formState: { isSubmitting, isDirty },
+        formState: { isSubmitting },
     } = useForm<FormData>({
         mode: 'onBlur',
         defaultValues: {
+            cache_enabled: initialValues?.cache_enabled || false,
             cache_size: initialValues?.cache_size || 0,
             cache_ttl_min: initialValues?.cache_ttl_min || 0,
             cache_ttl_max: initialValues?.cache_ttl_max || 0,
             cache_optimistic: initialValues?.cache_optimistic || false,
         },
     });
 
+    const cache_enabled = watch('cache_enabled');
+    const cache_size = watch('cache_size');
     const cache_ttl_min = watch('cache_ttl_min');
     const cache_ttl_max = watch('cache_ttl_max');
 
     const minExceedsMax = cache_ttl_min > 0 && cache_ttl_max > 0 && cache_ttl_min > cache_ttl_max;
+    const cacheSizeZeroWhenEnabled = cache_enabled && cache_size === 0;
 
     const handleClearCache = () => {
         if (window.confirm(t('confirm_dns_cache_clear'))) {
@@ -79,6 +84,24 @@ const Form = ({ initialValues, onSubmit }: CacheFormProps) => {
     return (
         <form onSubmit={handleSubmit(onSubmit)}>
             <div className="row">
+                <div className="col-12 col-md-7">
+                    <div className="form__group form__group--settings">
+                        <Controller
+                            name="cache_enabled"
+                            control={control}
+                            render={({ field }) => (
+                                <Checkbox
+                                    {...field}
+                                    data-testid="dns_cache_enabled"
+                                    title={t('cache_enabled')}
+                                    subtitle={t('cache_enabled_desc')}
+                                    disabled={processingSetConfig}
+                                />
+                            )}
+                        />
+                    </div>
+                </div>
+
                 {INPUTS_FIELDS.map(({ name, title, description, placeholder }) => (
                     <div className="col-12" key={name}>
                         <div className="col-12 col-md-7 p-0">
@@ -102,6 +125,12 @@ const Form = ({ initialValues, onSubmit }: CacheFormProps) => {
                                         setValueAs: (value) => replaceZeroWithEmptyString(value),
                                     })}
                                 />
+
+                                {name === CACHE_CONFIG_FIELDS.cache_size && cacheSizeZeroWhenEnabled && (
+                                    <span className="form__message form__message--error">
+                                        {t('cache_size_validation')}
+                                    </span>
+                                )}
                             </div>
                         </div>
                     </div>
@@ -133,7 +162,7 @@ const Form = ({ initialValues, onSubmit }: CacheFormProps) => {
                 type="submit"
                 data-testid="dns_save"
                 className="btn btn-success btn-standard btn-large"
-                disabled={isSubmitting || !isDirty || processingSetConfig || minExceedsMax}>
+                disabled={isSubmitting || processingSetConfig || minExceedsMax || cacheSizeZeroWhenEnabled}>
                 {t('save_btn')}
             </button>
 

client/src/components/Settings/Dns/Cache/index.tsx

@@ -13,7 +13,7 @@ import { RootState } from '../../../../initialState';
 const CacheConfig = () => {
     const { t } = useTranslation();
     const dispatch = useDispatch();
-    const { cache_size, cache_ttl_max, cache_ttl_min, cache_optimistic } = useSelector(
+    const { cache_enabled, cache_size, cache_ttl_max, cache_ttl_min, cache_optimistic } = useSelector(
         (state: RootState) => state.dnsConfig,
         shallowEqual,
     );
@@ -32,6 +32,7 @@ const CacheConfig = () => {
             <div className="form">
                 <Form
                     initialValues={{
+                        cache_enabled,
                         cache_size: replaceZeroWithEmptyString(cache_size),
                         cache_ttl_max: replaceZeroWithEmptyString(cache_ttl_max),
                         cache_ttl_min: replaceZeroWithEmptyString(cache_ttl_min),

client/src/initialState.ts

@@ -322,6 +322,7 @@ export type DnsConfigData = {
     ratelimit_subnet_len_ipv6?: number;
     edns_cs_use_custom?: boolean;
     edns_cs_custom_ip?: string;
+    cache_enabled?: boolean;
     cache_size?: number;
     cache_ttl_max?: number;
     cache_ttl_min?: number;

internal/agh/agh.go

@@ -0,0 +1,22 @@
+// Package agh contains common entities and interfaces of AdGuard Home.
+package agh
+
+import (
+	"context"
+)
+
+// ConfigModifier defines an interface for updating the global configuration.
+type ConfigModifier interface {
+	// Apply applies changes to the global configuration.
+	Apply(ctx context.Context)
+}
+
+// EmptyConfigModifier is an empty [ConfigModifier] implementation that does
+// nothing.
+type EmptyConfigModifier struct{}
+
+// type check
+var _ ConfigModifier = EmptyConfigModifier{}
+
+// Apply implements the [ConfigModifier] for EmptyConfigModifier.
+func (em EmptyConfigModifier) Apply(ctx context.Context) {}

internal/aghtest/interface.go

@@ -6,8 +6,9 @@ import (
 	"net/netip"
 	"time"
 
+	"github.com/AdguardTeam/AdGuardHome/internal/agh"
 	"github.com/AdguardTeam/AdGuardHome/internal/aghos"
-	"github.com/AdguardTeam/AdGuardHome/internal/next/agh"
+	nextagh "github.com/AdguardTeam/AdGuardHome/internal/next/agh"
 	"github.com/AdguardTeam/AdGuardHome/internal/rdns"
 	"github.com/AdguardTeam/AdGuardHome/internal/whois"
 	"github.com/AdguardTeam/dnsproxy/upstream"
@@ -53,31 +54,32 @@ func (w *FSWatcher) Add(name string) (err error) {
 	return w.OnAdd(name)
 }
 
-// Package agh
+// Package nextagh
 
-// ServiceWithConfig is a fake [agh.ServiceWithConfig] implementation for tests.
+// ServiceWithConfig is a fake [nextagh.ServiceWithConfig] implementation for
+// tests.
 type ServiceWithConfig[ConfigType any] struct {
 	OnStart    func(ctx context.Context) (err error)
 	OnShutdown func(ctx context.Context) (err error)
 	OnConfig   func() (c ConfigType)
 }
 
 // type check
-var _ agh.ServiceWithConfig[struct{}] = (*ServiceWithConfig[struct{}])(nil)
+var _ nextagh.ServiceWithConfig[struct{}] = (*ServiceWithConfig[struct{}])(nil)
 
-// Start implements the [agh.ServiceWithConfig] interface for
+// Start implements the [nextagh.ServiceWithConfig] interface for
 // *ServiceWithConfig.
 func (s *ServiceWithConfig[_]) Start(ctx context.Context) (err error) {
 	return s.OnStart(ctx)
 }
 
-// Shutdown implements the [agh.ServiceWithConfig] interface for
+// Shutdown implements the [nextagh.ServiceWithConfig] interface for
 // *ServiceWithConfig.
 func (s *ServiceWithConfig[_]) Shutdown(ctx context.Context) (err error) {
 	return s.OnShutdown(ctx)
 }
 
-// Config implements the [agh.ServiceWithConfig] interface for
+// Config implements the [nextagh.ServiceWithConfig] interface for
 // *ServiceWithConfig.
 func (s *ServiceWithConfig[ConfigType]) Config() (c ConfigType) {
 	return s.OnConfig()
@@ -178,3 +180,16 @@ func (u *UpstreamMock) Exchange(req *dns.Msg) (resp *dns.Msg, err error) {
 func (u *UpstreamMock) Close() (err error) {
 	return u.OnClose()
 }
+
+// ConfigModifier is a fake [agh.ConfigModifier] implementation for tests.
+type ConfigModifier struct {
+	OnApply func(ctx context.Context)
+}
+
+// type check
+var _ agh.ConfigModifier = (*ConfigModifier)(nil)
+
+// Apply implements the [ConfigModifier] interface for *ConfigModifier.
+func (m *ConfigModifier) Apply(ctx context.Context) {
+	m.OnApply(ctx)
+}

internal/configmigrate/configmigrate.go

@@ -2,4 +2,4 @@
 package configmigrate
 
 // LastSchemaVersion is the most recent schema version.
-const LastSchemaVersion uint = 29
+const LastSchemaVersion uint = 30

internal/configmigrate/migrator.go

@@ -125,6 +125,7 @@ func (m *Migrator) upgradeConfigSchema(current, target uint, diskConf yobj) (err
 		26: migrateTo27,
 		27: migrateTo28,
 		28: m.migrateTo29,
+		29: m.migrateTo30,
 	}
 
 	for i, migrate := range upgrades[current:target] {