feat: dns caching manager (#1294)

* feat(dns): implement dns caching

* feat: simple implementation of dnscaching

* feat: dynamic ttl which is revalidated while using stale dns cache

This is done as tmdb ttl is very less like 40 seconds so to make sure
any issues wont be caused due to cached dns (previously we were caching
for 5 minutes no matter what ttl)

* feat(dns): improve DNS cache with multi-strategy fallback system

- multiple DNS resolution strategie
- graceful fallbacks between IPv6 and IPv4 addresses
- network error reporting in fetch fix
- compatibility with cypress testing (I HOPE)

* fix: typos

* feat: dns cache stats in jobs & cache page (and cleanup)

* feat(networksettings): cache dns off by default

* feat: make dnsCache optional and enable-able through network settings

* chore(i18n): extract translation keys

* test(cypress): fix cypress testing

* feat(dnscache): dns cache entries are now flushable

* style(cypress): run prettier

* chore(cypresssettings): git ignore cypress json settings

* chore: ignore cypress/config/settings.json

* fix(dnscache): use entry specific hits and misses not global

* refactor: clean up console logs

* fix(dnscache): fix miss counter

* feat(dnscache): global stats

* chore(i18n): extract translation keys

* refactor: use date-fns for formatting age and remove useless code

* refactor: remove cypress testing options in dnsCacheManager

* refactor: remove console logs

* refactor: removed useless condition when its always truthy

* fix: remove FetchAPI-related code

* fix: remove old ipv4first setting

* refactor: use our own dns-caching package instead

* fix: correct dns-caching module configuration

* fix: correct dns-caching module configuration

* fix: remove useless lru-cache dependency

* fix: update dns-caching to v0.2.0

* fix: add env variable for min/max ttl & update dns-caching

* fix: update dns-caching package

* fix: add force min/max TTL in network settings

* docs: add docs for dns caching

---------

Co-authored-by: Gauthier <[email protected]>

Author: fallenbagel

.prettierignore

@@ -4,6 +4,7 @@ dist/
 config/
 CHANGELOG.md
 pnpm-lock.yaml
+cypress/config/settings.cypress.json
 
 # assets
 src/assets/

.prettierrc.js

@@ -21,5 +21,11 @@ module.exports = {
         rangeEnd: 0, // default: Infinity
       },
     },
+    {
+      files: 'cypress/config/settings.cypress.json',
+      options: {
+        rangeEnd: 0,
+      },
+    },
   ],
 };

cypress/config/settings.cypress.json

@@ -6,7 +6,6 @@
     "apiKey": "testkey",
     "applicationTitle": "Jellyseerr",
     "applicationUrl": "",
-    "csrfProtection": false,
     "cacheImages": false,
     "defaultPermissions": 32,
     "defaultQuotas": {
@@ -180,5 +179,26 @@
     "image-cache-cleanup": {
       "schedule": "0 0 5 * * *"
     }
+  },
+  "network": {
+    "csrfProtection": false,
+    "trustProxy": false,
+    "forceIpv4First": false,
+    "dnsServers": "",
+    "proxy": {
+      "enabled": false,
+      "hostname": "",
+      "port": 8080,
+      "useSsl": false,
+      "user": "",
+      "password": "",
+      "bypassFilter": "",
+      "bypassLocalAddresses": true
+    },
+    "dnsCache": {
+      "enabled": false,
+      "forceMinTtl": 0,
+      "forceMaxTtl": -1
+    }
   }
 }

docs/using-jellyseerr/settings/dns-caching.md

@@ -0,0 +1,16 @@
+---
+title: DNS Caching
+description: Configure DNS caching settings.
+sidebar_position: 7
+---
+
+# DNS Caching
+
+Jellyseerr uses DNS caching to improve performance and reduce the number of DNS lookups required for external API calls. This can help speed up response times and reduce load on DNS servers, when something like a Pi-hole is used as a DNS resolver.
+
+## Configuration
+
+You can enable the DNS caching settings in the Network tab of the Jellyseerr settings. The default values follow the standard DNS caching behavior.
+
+- **Force Minimum TTL**: Set a minimum time-to-live (TTL) in seconds for DNS cache entries. This ensures that frequently accessed DNS records are cached for a longer period, reducing the need for repeated lookups. Default is 0.
+- **Force Maximum TTL**: Set a maximum time-to-live (TTL) in seconds for DNS cache entries. This prevents infrequently accessed DNS records from being cached indefinitely, allowing for more up-to-date information to be retrieved. Default is -1 (unlimited).

docs/using-jellyseerr/settings/jobs&cache.md

@@ -1,6 +1,7 @@
 ---
 title: Jobs & Cache
 description: Configure jobs and cache settings.
+sidebar_position: 6
 ---
 
 # Jobs & Cache

jellyseerr-api.yml

@@ -260,9 +260,51 @@ components:
         csrfProtection:
           type: boolean
           example: false
+        forceIpv4First:
+          type: boolean
+          example: false
         trustProxy:
           type: boolean
-          example: true
+          example: false
+        proxy:
+          type: object
+          properties:
+            enabled:
+              type: boolean
+              example: false
+            hostname:
+              type: string
+              example: ''
+            port:
+              type: number
+              example: 8080
+            useSsl:
+              type: boolean
+              example: false
+            user:
+              type: string
+              example: ''
+            password:
+              type: string
+              example: ''
+            bypassFilter:
+              type: string
+              example: ''
+            bypassLocalAddresses:
+              type: boolean
+              example: true
+        dnsCache:
+          type: object
+          properties:
+            enabled:
+              type: boolean
+              example: false
+            forceMinTtl:
+              type: number
+              example: 0
+            forceMaxTtl:
+              type: number
+              example: -1
     PlexLibrary:
       type: object
       properties:
@@ -2967,6 +3009,68 @@ paths:
                           imageCount:
                             type: number
                             example: 123
+                  dnsCache:
+                    type: object
+                    properties:
+                      stats:
+                        type: object
+                        properties:
+                          size:
+                            type: number
+                            example: 1
+                          maxSize:
+                            type: number
+                            example: 500
+                          hits:
+                            type: number
+                            example: 19
+                          misses:
+                            type: number
+                            example: 1
+                          failures:
+                            type: number
+                            example: 0
+                          ipv4Fallbacks:
+                            type: number
+                            example: 0
+                          hitRate:
+                            type: number
+                            example: 0.95
+                      entries:
+                        type: array
+                        additionalProperties:
+                          type: object
+                          properties:
+                            addresses:
+                              type: object
+                              properties:
+                                ipv4:
+                                  type: number
+                                  example: 1
+                                ipv6:
+                                  type: number
+                                  example: 1
+                            activeAddress:
+                              type: string
+                              example: 127.0.0.1
+                            family:
+                              type: number
+                              example: 4
+                            age:
+                              type: number
+                              example: 10
+                            ttl:
+                              type: number
+                              example: 10
+                            networkErrors:
+                              type: number
+                              example: 0
+                            hits:
+                              type: number
+                              example: 1
+                            misses:
+                              type: number
+                              example: 1
                   apiCaches:
                     type: array
                     items:
@@ -3006,6 +3110,21 @@ paths:
       responses:
         '204':
           description: 'Flushed cache'
+  /settings/cache/dns/{dnsEntry}/flush:
+    post:
+      summary: Flush a specific DNS cache entry
+      description: Flushes a specific DNS cache entry
+      tags:
+        - settings
+      parameters:
+        - in: path
+          name: dnsEntry
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: 'Flushed dns cache'
   /settings/logs:
     get:
       summary: Returns logs

package.json

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