fix(dnscaching): display stats for DNS caching (#1858)

* fix(dnscaching): display stats for DNS caching

* fix: add missing translation

Author: gauthier-th

package.json

@@ -57,7 +57,7 @@
     "cronstrue": "2.23.0",
     "date-fns": "2.29.3",
     "dayjs": "1.11.7",
-    "dns-caching": "^0.2.4",
+    "dns-caching": "^0.2.5",
     "email-templates": "12.0.1",
     "email-validator": "2.0.4",
     "express": "4.21.2",

pnpm-lock.yaml

@@ -1,3 +1,4 @@
+import type { DnsEntries, DnsStats } from 'dns-caching';
 import type { PaginatedResponse } from './common';
 
 export type LogMessage = {
@@ -61,38 +62,12 @@ export interface CacheItem {
   };
 }
 
-export interface DNSAddresses {
-  ipv4: number;
-  ipv6: number;
-}
-
-export interface DNSRecord {
-  addresses: DNSAddresses;
-  activeAddress: string;
-  family: number;
-  age: number;
-  ttl: number;
-  networkErrors: number;
-  hits: number;
-  misses: number;
-}
-
-export interface DNSStats {
-  size: number;
-  maxSize: number;
-  hits: number;
-  misses: number;
-  failures: number;
-  ipv4Fallbacks: number;
-  hitRate: number;
-}
-
 export interface CacheResponse {
   apiCaches: CacheItem[];
   imageCache: Record<'tmdb' | 'avatar', { size: number; imageCount: number }>;
   dnsCache: {
-    entries: Record<string, DNSRecord>;
-    stats: DNSStats;
+    stats: DnsStats | undefined;
+    entries: DnsEntries | undefined;
   };
 }
 

server/interfaces/api/settingsInterfaces.ts

@@ -28,8 +28,9 @@ import discoverSettingRoutes from '@server/routes/settings/discover';
 import { ApiError } from '@server/types/error';
 import { appDataPath } from '@server/utils/appDataVolume';
 import { getAppVersion } from '@server/utils/appVersion';
-import dnsCache from '@server/utils/dnsCache';
+import { dnsCache } from '@server/utils/dnsCache';
 import { getHostname } from '@server/utils/getHostname';
+import type { DnsEntries, DnsStats } from 'dns-caching';
 import { Router } from 'express';
 import rateLimit from 'express-rate-limit';
 import fs from 'fs';
@@ -756,8 +757,8 @@ settingsRoutes.get('/cache', async (_req, res) => {
   const tmdbImageCache = await ImageProxy.getImageStats('tmdb');
   const avatarImageCache = await ImageProxy.getImageStats('avatar');
 
-  const stats = dnsCache?.getStats();
-  const entries = dnsCache?.getCacheEntries();
+  const stats: DnsStats | undefined = dnsCache?.getStats();
+  const entries: DnsEntries | undefined = dnsCache?.getCacheEntries();
 
   return res.status(200).json({
     apiCaches,

server/routes/settings/index.ts

@@ -1,7 +1,7 @@
 import logger from '@server/logger';
 import { DnsCacheManager } from 'dns-caching';
 
-let dnsCache: DnsCacheManager | undefined;
+export let dnsCache: DnsCacheManager | undefined;
 
 export function initializeDnsCache({
   forceMinTtl,
@@ -24,5 +24,3 @@ export function initializeDnsCache({
   });
   dnsCache.initialize();
 }
-
-export default dnsCache;

server/utils/dnsCache.ts

@@ -65,7 +65,6 @@ const messages: { [messageName: string]: MessageDescriptor } = defineMessages(
     dnscachehits: 'Hits',
     dnscachemisses: 'Misses',
     dnscacheage: 'Age',
-    dnscachenetworkerrors: 'Network Errors',
     flushdnscache: 'Flush DNS Cache',
     dnsCacheGlobalStats: 'Global DNS Cache Stats',
     dnsCacheGlobalStatsDescription:
@@ -629,9 +628,6 @@ const SettingsJobs = () => {
               <Table.TH>{intl.formatMessage(messages.dnscachehits)}</Table.TH>
               <Table.TH>{intl.formatMessage(messages.dnscachemisses)}</Table.TH>
               <Table.TH>{intl.formatMessage(messages.dnscacheage)}</Table.TH>
-              <Table.TH>
-                {intl.formatMessage(messages.dnscachenetworkerrors)}
-              </Table.TH>
               <Table.TH></Table.TH>
             </tr>
           </thead>
@@ -644,7 +640,6 @@ const SettingsJobs = () => {
                   <Table.TD>{intl.formatNumber(data.hits)}</Table.TD>
                   <Table.TD>{intl.formatNumber(data.misses)}</Table.TD>
                   <Table.TD>{formatAge(data.age)}</Table.TD>
-                  <Table.TD>{intl.formatNumber(data.networkErrors)}</Table.TD>
                   <Table.TD alignText="right">
                     <Button
                       buttonType="danger"

src/components/Settings/SettingsJobsCache/index.tsx

@@ -104,7 +104,6 @@
   "components.Discover.StudioSlider.studios": "Studios",
   "components.Discover.TvGenreList.seriesgenres": "Series Genres",
   "components.Discover.TvGenreSlider.tvgenres": "Series Genres",
-  "components.DiscoverTvUpcoming.upcomingtv": "Upcoming Series",
   "components.Discover.createnewslider": "Create New Slider",
   "components.Discover.customizediscover": "Customize Discover",
   "components.Discover.discover": "Discover",
@@ -138,6 +137,7 @@
   "components.Discover.upcomingtv": "Upcoming Series",
   "components.Discover.updatefailed": "Something went wrong updating the discover customization settings.",
   "components.Discover.updatesuccess": "Updated discover customization settings.",
+  "components.DiscoverTvUpcoming.upcomingtv": "Upcoming Series",
   "components.DownloadBlock.estimatedtime": "Estimated {time}",
   "components.DownloadBlock.formattedTitle": "{title}: Season {seasonNumber} Episode {episodeNumber}",
   "components.IssueDetails.IssueComment.areyousuredelete": "Are you sure you want to delete this comment?",
@@ -883,7 +883,6 @@
   "components.Settings.SettingsJobsCache.dnscachehits": "Hits",
   "components.Settings.SettingsJobsCache.dnscachemisses": "Misses",
   "components.Settings.SettingsJobsCache.dnscachename": "Hostname",
-  "components.Settings.SettingsJobsCache.dnscachenetworkerrors": "Network Errors",
   "components.Settings.SettingsJobsCache.download-sync": "Download Sync",
   "components.Settings.SettingsJobsCache.download-sync-reset": "Download Sync Reset",
   "components.Settings.SettingsJobsCache.editJobSchedule": "Modify Job",
@@ -988,6 +987,8 @@
   "components.Settings.SettingsNetwork.csrfProtectionHoverTip": "Do NOT enable this setting unless you understand what you are doing!",
   "components.Settings.SettingsNetwork.csrfProtectionTip": "Set external API access to read-only (requires HTTPS)",
   "components.Settings.SettingsNetwork.dnsCache": "DNS Cache",
+  "components.Settings.SettingsNetwork.dnsCacheForceMaxTtl": "DNS Cache Maximum TTL",
+  "components.Settings.SettingsNetwork.dnsCacheForceMinTtl": "DNS Cache Minimum TTL",
   "components.Settings.SettingsNetwork.dnsCacheHoverTip": "Do NOT enable this if you are experiencing issues with DNS lookups",
   "components.Settings.SettingsNetwork.dnsCacheTip": "Enable caching of DNS lookups to optimize performance and avoid making unnecessary API calls",
   "components.Settings.SettingsNetwork.docs": "documentation",
@@ -1224,7 +1225,7 @@
   "components.Setup.librarieserror": "Validation failed. Please toggle the libraries again to continue.",
   "components.Setup.servertype": "Choose Server Type",
   "components.Setup.setup": "Setup",
-  "components.Setup.signin": "Sign In",
+  "components.Setup.signin": "Sign in to your account",
   "components.Setup.signinMessage": "Get started by signing in",
   "components.Setup.signinWithEmby": "Enter your Emby details",
   "components.Setup.signinWithJellyfin": "Enter your Jellyfin details",