feat(settings): make the feature optionnal

Signed-off-by: 0xsysr3ll <0xsysr3ll@pm.me>

Author: 0xSysR3ll

cypress/config/settings.cypress.json

@@ -24,6 +24,7 @@
     "mediaServerType": 1,
     "partialRequestsEnabled": true,
     "enableSpecialEpisodes": false,
+    "enableEpisodeAvailability": false,
     "locale": "en"
   },
   "plex": {
@@ -201,4 +202,4 @@
       "forceMaxTtl": -1
     }
   }
-}
+}

jellyseerr-api.yml

@@ -254,6 +254,9 @@ components:
         enableSpecialEpisodes:
           type: boolean
           example: false
+        enableEpisodeAvailability:
+          type: boolean
+          example: false
     NetworkSettings:
       type: object
       properties:

server/interfaces/api/settingsInterfaces.ts

@@ -41,6 +41,7 @@ export interface PublicSettingsResponse {
   mediaServerType: number;
   partialRequestsEnabled: boolean;
   enableSpecialEpisodes: boolean;
+  enableEpisodeAvailability: boolean;
   cacheImages: boolean;
   vapidPublic: string;
   enablePushRegistration: boolean;

server/lib/availabilitySync.ts

@@ -14,7 +14,7 @@ import MediaRequest from '@server/entity/MediaRequest';
 import type Season from '@server/entity/Season';
 import { User } from '@server/entity/User';
 import type { RadarrSettings, SonarrSettings } from '@server/lib/settings';
-import { getSettings } from '@server/lib/settings';
+import { getSettings, MetadataProviderType } from '@server/lib/settings';
 import logger from '@server/logger';
 import { getHostname } from '@server/utils/getHostname';
 
@@ -807,6 +807,12 @@ class AvailabilitySync {
     let seasonExists = false;
     const episodeRepository = getRepository(Episode);
 
+    const settings = getSettings();
+    const shouldTrackEpisodes =
+      settings.main.enableEpisodeAvailability &&
+      (settings.metadataSettings.tv === MetadataProviderType.TVDB ||
+        settings.metadataSettings.anime === MetadataProviderType.TVDB);
+
     // Check each sonarr instance to see if the media still exists
     // If found, we will assume the media exists and prevent removal
     // We can use the cache we built when we fetched the series with mediaExistsInSonarr
@@ -855,48 +861,50 @@ class AvailabilitySync {
             return seasonExists;
           }
 
-          const episodes = await sonarrApi.getEpisodesBySeriesId(serviceId);
+          if (shouldTrackEpisodes) {
+            const episodes = await sonarrApi.getEpisodesBySeriesId(serviceId);
 
-          for (const ep of episodes) {
-            if (ep.seasonNumber === season.seasonNumber) {
-              const existingEpisode = await episodeRepository.findOne({
-                where: {
-                  episodeNumber: ep.episodeNumber,
-                  season: { id: season.id },
-                },
-                relations: ['season'],
-              });
+            for (const ep of episodes) {
+              if (ep.seasonNumber === season.seasonNumber) {
+                const existingEpisode = await episodeRepository.findOne({
+                  where: {
+                    episodeNumber: ep.episodeNumber,
+                    season: { id: season.id },
+                  },
+                  relations: ['season'],
+                });
 
-              if (existingEpisode) {
-                existingEpisode[is4k ? 'status4k' : 'status'] = ep.hasFile
-                  ? MediaStatus.AVAILABLE
-                  : MediaStatus.UNKNOWN;
-                await episodeRepository.save(existingEpisode);
-              } else {
-                const newEpisode = new Episode();
-                newEpisode.episodeNumber = ep.episodeNumber;
-                newEpisode.status = is4k
-                  ? MediaStatus.UNKNOWN
-                  : ep.hasFile
-                  ? MediaStatus.AVAILABLE
-                  : MediaStatus.UNKNOWN;
-                newEpisode.status4k = is4k
-                  ? ep.hasFile
+                if (existingEpisode) {
+                  existingEpisode[is4k ? 'status4k' : 'status'] = ep.hasFile
                     ? MediaStatus.AVAILABLE
-                    : MediaStatus.UNKNOWN
-                  : MediaStatus.UNKNOWN;
-                newEpisode.season = Promise.resolve(season);
-
-                try {
-                  await episodeRepository.save(newEpisode);
-                } catch (saveError) {
-                  logger.error('Failed to save new episode', {
-                    label: 'Availability Sync',
-                    errorMessage: saveError.message,
-                    tvId: media.tmdbId,
-                    seasonNumber: season.seasonNumber,
-                    episodeNumber: ep.episodeNumber,
-                  });
+                    : MediaStatus.UNKNOWN;
+                  await episodeRepository.save(existingEpisode);
+                } else {
+                  const newEpisode = new Episode();
+                  newEpisode.episodeNumber = ep.episodeNumber;
+                  newEpisode.status = is4k
+                    ? MediaStatus.UNKNOWN
+                    : ep.hasFile
+                    ? MediaStatus.AVAILABLE
+                    : MediaStatus.UNKNOWN;
+                  newEpisode.status4k = is4k
+                    ? ep.hasFile
+                      ? MediaStatus.AVAILABLE
+                      : MediaStatus.UNKNOWN
+                    : MediaStatus.UNKNOWN;
+                  newEpisode.season = Promise.resolve(season);
+
+                  try {
+                    await episodeRepository.save(newEpisode);
+                  } catch (saveError) {
+                    logger.error('Failed to save new episode', {
+                      label: 'Availability Sync',
+                      errorMessage: saveError.message,
+                      tvId: media.tmdbId,
+                      seasonNumber: season.seasonNumber,
+                      episodeNumber: ep.episodeNumber,
+                    });
+                  }
                 }
               }
             }

server/lib/settings/index.ts

@@ -144,6 +144,7 @@ export interface MainSettings {
   mediaServerType: number;
   partialRequestsEnabled: boolean;
   enableSpecialEpisodes: boolean;
+  enableEpisodeAvailability: boolean;
   locale: string;
   youtubeUrl: string;
 }
@@ -195,6 +196,7 @@ interface FullPublicSettings extends PublicSettings {
   jellyfinServerName?: string;
   partialRequestsEnabled: boolean;
   enableSpecialEpisodes: boolean;
+  enableEpisodeAvailability: boolean;
   cacheImages: boolean;
   vapidPublic: string;
   enablePushRegistration: boolean;
@@ -398,6 +400,7 @@ class Settings {
         mediaServerType: MediaServerType.NOT_CONFIGURED,
         partialRequestsEnabled: true,
         enableSpecialEpisodes: false,
+        enableEpisodeAvailability: false,
         locale: 'en',
         youtubeUrl: '',
       },
@@ -674,6 +677,7 @@ class Settings {
       mediaServerType: this.main.mediaServerType,
       partialRequestsEnabled: this.data.main.partialRequestsEnabled,
       enableSpecialEpisodes: this.data.main.enableSpecialEpisodes,
+      enableEpisodeAvailability: this.data.main.enableEpisodeAvailability,
       cacheImages: this.data.main.cacheImages,
       vapidPublic: this.vapidPublic,
       enablePushRegistration: this.data.notifications.agents.webpush.enabled,

src/components/Settings/SettingsMain/index.tsx

@@ -64,6 +64,9 @@ const messages = defineMessages('components.Settings.SettingsMain', {
   validationApplicationUrlTrailingSlash: 'URL must not end in a trailing slash',
   partialRequestsEnabled: 'Allow Partial Series Requests',
   enableSpecialEpisodes: 'Allow Special Episodes Requests',
+  enableEpisodeAvailability: 'Enable Episode Availability Tracking',
+  enableEpisodeAvailabilityTip:
+    'Track individual episode availability status (requires TVDB as metadata provider for TV shows or anime)',
   locale: 'Display Language',
   youtubeUrl: 'YouTube URL',
   youtubeUrlTip:
@@ -82,6 +85,7 @@ const SettingsMain = () => {
     error,
     mutate: revalidate,
   } = useSWR<MainSettings>('/api/v1/settings/main');
+
   const { data: userData } = useSWR<UserSettingsGeneralResponse>(
     currentUser ? `/api/v1/user/${currentUser.id}/settings/main` : null
   );
@@ -173,6 +177,7 @@ const SettingsMain = () => {
             blacklistedTagsLimit: data?.blacklistedTagsLimit || 50,
             partialRequestsEnabled: data?.partialRequestsEnabled,
             enableSpecialEpisodes: data?.enableSpecialEpisodes,
+            enableEpisodeAvailability: data?.enableEpisodeAvailability,
             cacheImages: data?.cacheImages,
             youtubeUrl: data?.youtubeUrl,
           }}
@@ -193,6 +198,7 @@ const SettingsMain = () => {
                 blacklistedTagsLimit: values.blacklistedTagsLimit,
                 partialRequestsEnabled: values.partialRequestsEnabled,
                 enableSpecialEpisodes: values.enableSpecialEpisodes,
+                enableEpisodeAvailability: values.enableEpisodeAvailability,
                 cacheImages: values.cacheImages,
                 youtubeUrl: values.youtubeUrl,
               });
@@ -535,6 +541,34 @@ const SettingsMain = () => {
                     />
                   </div>
                 </div>
+                <div className="form-row">
+                  <label
+                    htmlFor="enableEpisodeAvailability"
+                    className="checkbox-label"
+                  >
+                    <span className="mr-2">
+                      {intl.formatMessage(messages.enableEpisodeAvailability)}
+                    </span>
+                    <span className="label-tip">
+                      {intl.formatMessage(
+                        messages.enableEpisodeAvailabilityTip
+                      )}
+                    </span>
+                  </label>
+                  <div className="form-input-area">
+                    <Field
+                      type="checkbox"
+                      id="enableEpisodeAvailability"
+                      name="enableEpisodeAvailability"
+                      onChange={() => {
+                        setFieldValue(
+                          'enableEpisodeAvailability',
+                          !values.enableEpisodeAvailability
+                        );
+                      }}
+                    />
+                  </div>
+                </div>
                 <div className="form-row">
                   <label htmlFor="youtubeUrl" className="text-label">
                     {intl.formatMessage(messages.youtubeUrl)}

src/context/SettingsContext.tsx

@@ -24,6 +24,7 @@ const defaultSettings = {
   mediaServerType: MediaServerType.NOT_CONFIGURED,
   partialRequestsEnabled: true,
   enableSpecialEpisodes: false,
+  enableEpisodeAvailability: false,
   cacheImages: false,
   vapidPublic: '',
   enablePushRegistration: false,

src/i18n/locale/en.json

@@ -962,6 +962,8 @@
   "components.Settings.SettingsMain.cacheImagesTip": "Cache externally sourced images (requires a significant amount of disk space)",
   "components.Settings.SettingsMain.discoverRegion": "Discover Region",
   "components.Settings.SettingsMain.discoverRegionTip": "Filter content by regional availability",
+  "components.Settings.SettingsMain.enableEpisodeAvailability": "Enable Episode Availability Tracking",
+  "components.Settings.SettingsMain.enableEpisodeAvailabilityTip": "Track individual episode availability status (requires TVDB as metadata provider for TV shows or anime)",
   "components.Settings.SettingsMain.enableSpecialEpisodes": "Allow Special Episodes Requests",
   "components.Settings.SettingsMain.general": "General",
   "components.Settings.SettingsMain.generalsettings": "General Settings",
@@ -1158,6 +1160,7 @@
   "components.Settings.menuServices": "Services",
   "components.Settings.menuUsers": "Users",
   "components.Settings.metadataProviderSelection": "Metadata Provider Selection",
+  "components.Settings.metadataProviderSettings": "Metadata Providers",
   "components.Settings.metadataSettings": "Settings for metadata provider",
   "components.Settings.metadataSettingsSaved": "Metadata provider settings saved",
   "components.Settings.no": "No",

src/pages/_app.tsx

@@ -242,6 +242,7 @@ CoreApp.getInitialProps = async (initialProps) => {
     mediaServerType: MediaServerType.NOT_CONFIGURED,
     partialRequestsEnabled: true,
     enableSpecialEpisodes: false,
+    enableEpisodeAvailability: false,
     cacheImages: false,
     vapidPublic: '',
     enablePushRegistration: false,