feat(usersettings): add separate setting for streaming region (#993)

* feat: add separate setting for streaming region Currently, the "Currently Streaming On" information is based on the Discover Region setting. This PR adds a new setting to specify which region should be used to display the streaming region. re #890 * fix: add missing newline * fix: rename migration function
Fallenbagel · Dec 8, 2024 · 89831f7 · 89831f7
1 parent 84fd884
commit 89831f7
Show file tree

Hide file tree

Showing 23 changed files with 243 additions and 78 deletions.
diff --git a/cypress/config/settings.cypress.json b/cypress/config/settings.cypress.json
@@ -16,7 +16,8 @@
     "hideAvailable": false,
     "localLogin": true,
     "newPlexLogin": true,
-    "region": "",
+    "discoverRegion": "",
+    "streamingRegion": "",
     "originalLanguage": "",
     "trustProxy": false,
     "mediaServerType": 1,

diff --git a/docs/using-jellyseerr/settings/general.md b/docs/using-jellyseerr/settings/general.md
@@ -58,9 +58,9 @@ You should enable this if you are having issues with loading images directly fro
 
 Set the default display language for Jellyseerr. Users can override this setting in their user settings.
 
-## Discover Region & Discover Language
+## Discover Region, Discover Language & Streaming Region
 
-These settings filter content shown on the "Discover" home page based on regional availability and original language, respectively. Users can override these global settings by configuring these same options in their user settings.
+These settings filter content shown on the "Discover" home page based on regional availability and original language, respectively. The Streaming Region filters the available streaming providers on the media page. Users can override these global settings by configuring these same options in their user settings.
 
 ## Hide Available Media
 

diff --git a/docs/using-jellyseerr/users/editing-users.md b/docs/using-jellyseerr/users/editing-users.md
@@ -35,7 +35,7 @@ Users can override the [global display language](/using-jellyseerr/settings/gene
 
 ### Discover Region & Discover Language
 
-Users can override the [global filter settings](/using-jellyseerr/settings/general#discover-region--discover-language) to suit their own preferences.
+Users can override the [global filter settings](/using-jellyseerr/settings/general#discover-region-discover-language--streaming-region) to suit their own preferences.
 
 ### Movie Request Limit & Series Request Limit
 

diff --git a/overseerr-api.yml b/overseerr-api.yml
@@ -143,10 +143,12 @@ components:
       properties:
         locale:
           type: string
-        region:
+        discoverRegion:
           type: string
         originalLanguage:
           type: string
+        streamingRegion:
+          type: string
     MainSettings:
       type: object
       properties:

diff --git a/server/api/themoviedb/index.ts b/server/api/themoviedb/index.ts
@@ -99,12 +99,12 @@ interface DiscoverTvOptions {
 }
 
 class TheMovieDb extends ExternalAPI {
-  private region?: string;
+  private discoverRegion?: string;
   private originalLanguage?: string;
   constructor({
-    region,
+    discoverRegion,
     originalLanguage,
-  }: { region?: string; originalLanguage?: string } = {}) {
+  }: { discoverRegion?: string; originalLanguage?: string } = {}) {
     super(
       'https://api.themoviedb.org/3',
       {
@@ -118,7 +118,7 @@ class TheMovieDb extends ExternalAPI {
         },
       }
     );
-    this.region = region;
+    this.discoverRegion = discoverRegion;
     this.originalLanguage = originalLanguage;
   }
 
@@ -469,7 +469,7 @@ class TheMovieDb extends ExternalAPI {
         page: page.toString(),
         include_adult: includeAdult ? 'true' : 'false',
         language,
-        region: this.region || '',
+        region: this.discoverRegion || '',
         with_original_language:
           originalLanguage && originalLanguage !== 'all'
             ? originalLanguage
@@ -541,7 +541,7 @@ class TheMovieDb extends ExternalAPI {
         sort_by: sortBy,
         page: page.toString(),
         language,
-        region: this.region || '',
+        region: this.discoverRegion || '',
         // Set our release date values, but check if one is set and not the other,
         // so we can force a past date or a future date. TMDB Requires both values if one is set!
         'first_air_date.gte':
@@ -594,7 +594,7 @@ class TheMovieDb extends ExternalAPI {
         {
           page: page.toString(),
           language,
-          region: this.region || '',
+          region: this.discoverRegion || '',
           originalLanguage: this.originalLanguage || '',
         }
       );
@@ -620,7 +620,7 @@ class TheMovieDb extends ExternalAPI {
         {
           page: page.toString(),
           language,
-          region: this.region || '',
+          region: this.discoverRegion || '',
         }
       );
 

diff --git a/server/entity/UserSettings.ts b/server/entity/UserSettings.ts
@@ -31,7 +31,10 @@ export class UserSettings {
   public locale?: string;
 
   @Column({ nullable: true })
-  public region?: string;
+  public discoverRegion?: string;
+
+  @Column({ nullable: true })
+  public streamingRegion?: string;
 
   @Column({ nullable: true })
   public originalLanguage?: string;

diff --git a/server/interfaces/api/settingsInterfaces.ts b/server/interfaces/api/settingsInterfaces.ts
@@ -32,7 +32,8 @@ export interface PublicSettingsResponse {
   localLogin: boolean;
   movie4kEnabled: boolean;
   series4kEnabled: boolean;
-  region: string;
+  discoverRegion: string;
+  streamingRegion: string;
   originalLanguage: string;
   mediaServerType: number;
   partialRequestsEnabled: boolean;

diff --git a/server/interfaces/api/userSettingsInterfaces.ts b/server/interfaces/api/userSettingsInterfaces.ts
@@ -5,7 +5,8 @@ export interface UserSettingsGeneralResponse {
   email?: string;
   discordId?: string;
   locale?: string;
-  region?: string;
+  discoverRegion?: string;
+  streamingRegion?: string;
   originalLanguage?: string;
   movieQuotaLimit?: number;
   movieQuotaDays?: number;

diff --git a/server/lib/settings/index.ts b/server/lib/settings/index.ts
@@ -124,7 +124,8 @@ export interface MainSettings {
   hideAvailable: boolean;
   localLogin: boolean;
   newPlexLogin: boolean;
-  region: string;
+  discoverRegion: string;
+  streamingRegion: string;
   originalLanguage: string;
   trustProxy: boolean;
   mediaServerType: number;
@@ -144,7 +145,8 @@ interface FullPublicSettings extends PublicSettings {
   localLogin: boolean;
   movie4kEnabled: boolean;
   series4kEnabled: boolean;
-  region: string;
+  discoverRegion: string;
+  streamingRegion: string;
   originalLanguage: string;
   mediaServerType: number;
   jellyfinExternalHost?: string;
@@ -333,7 +335,8 @@ class Settings {
         hideAvailable: false,
         localLogin: true,
         newPlexLogin: true,
-        region: '',
+        discoverRegion: '',
+        streamingRegion: '',
         originalLanguage: '',
         trustProxy: false,
         mediaServerType: MediaServerType.NOT_CONFIGURED,
@@ -576,7 +579,8 @@ class Settings {
       series4kEnabled: this.data.sonarr.some(
         (sonarr) => sonarr.is4k && sonarr.isDefault
       ),
-      region: this.data.main.region,
+      discoverRegion: this.data.main.discoverRegion,
+      streamingRegion: this.data.main.streamingRegion,
       originalLanguage: this.data.main.originalLanguage,
       mediaServerType: this.main.mediaServerType,
       partialRequestsEnabled: this.data.main.partialRequestsEnabled,

diff --git a/server/lib/settings/migrations/0004_migrate_region_setting.ts b/server/lib/settings/migrations/0004_migrate_region_setting.ts
@@ -0,0 +1,17 @@
+import type { AllSettings } from '@server/lib/settings';
+
+const migrateRegionSetting = (settings: any): AllSettings => {
+  const oldRegion = settings.main.region;
+  if (oldRegion) {
+    settings.main.discoverRegion = oldRegion;
+    settings.main.streamingRegion = oldRegion;
+  } else {
+    settings.main.discoverRegion = '';
+    settings.main.streamingRegion = 'US';
+  }
+  delete settings.main.region;
+
+  return settings;
+};
+
+export default migrateRegionSetting;
diff --git a/server/migration/1727907530757-AddUserSettingsStreamingRegion.ts b/server/migration/1727907530757-AddUserSettingsStreamingRegion.ts
@@ -0,0 +1,53 @@
+import type { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class AddUserSettingsStreamingRegion1727907530757
+  implements MigrationInterface
+{
+  name = 'AddUserSettingsStreamingRegion1727907530757';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TABLE "temporary_user_settings" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "notificationTypes" text, "discordId" varchar, "userId" integer, "originalLanguage" varchar, "telegramChatId" varchar, "telegramSendSilently" boolean, "pgpKey" varchar, "locale" varchar NOT NULL DEFAULT (''), "pushbulletAccessToken" varchar, "pushoverApplicationToken" varchar, "pushoverUserKey" varchar, "watchlistSyncMovies" boolean, "watchlistSyncTv" boolean, "pushoverSound" varchar, CONSTRAINT "UQ_986a2b6d3c05eb4091bb8066f78" UNIQUE ("userId"), CONSTRAINT "FK_986a2b6d3c05eb4091bb8066f78" FOREIGN KEY ("userId") REFERENCES "user" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`
+    );
+    await queryRunner.query(
+      `INSERT INTO "temporary_user_settings"("id", "notificationTypes", "discordId", "userId", "originalLanguage", "telegramChatId", "telegramSendSilently", "pgpKey", "locale", "pushbulletAccessToken", "pushoverApplicationToken", "pushoverUserKey", "watchlistSyncMovies", "watchlistSyncTv", "pushoverSound") SELECT "id", "notificationTypes", "discordId", "userId", "originalLanguage", "telegramChatId", "telegramSendSilently", "pgpKey", "locale", "pushbulletAccessToken", "pushoverApplicationToken", "pushoverUserKey", "watchlistSyncMovies", "watchlistSyncTv", "pushoverSound" FROM "user_settings"`
+    );
+    await queryRunner.query(`DROP TABLE "user_settings"`);
+    await queryRunner.query(
+      `ALTER TABLE "temporary_user_settings" RENAME TO "user_settings"`
+    );
+    await queryRunner.query(
+      `CREATE TABLE "temporary_user_settings" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "notificationTypes" text, "discordId" varchar, "userId" integer, "originalLanguage" varchar, "telegramChatId" varchar, "telegramSendSilently" boolean, "pgpKey" varchar, "locale" varchar NOT NULL DEFAULT (''), "pushbulletAccessToken" varchar, "pushoverApplicationToken" varchar, "pushoverUserKey" varchar, "watchlistSyncMovies" boolean, "watchlistSyncTv" boolean, "pushoverSound" varchar, "discoverRegion" varchar, "streamingRegion" varchar, CONSTRAINT "UQ_986a2b6d3c05eb4091bb8066f78" UNIQUE ("userId"), CONSTRAINT "FK_986a2b6d3c05eb4091bb8066f78" FOREIGN KEY ("userId") REFERENCES "user" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`
+    );
+    await queryRunner.query(
+      `INSERT INTO "temporary_user_settings"("id", "notificationTypes", "discordId", "userId", "originalLanguage", "telegramChatId", "telegramSendSilently", "pgpKey", "locale", "pushbulletAccessToken", "pushoverApplicationToken", "pushoverUserKey", "watchlistSyncMovies", "watchlistSyncTv", "pushoverSound") SELECT "id", "notificationTypes", "discordId", "userId", "originalLanguage", "telegramChatId", "telegramSendSilently", "pgpKey", "locale", "pushbulletAccessToken", "pushoverApplicationToken", "pushoverUserKey", "watchlistSyncMovies", "watchlistSyncTv", "pushoverSound" FROM "user_settings"`
+    );
+    await queryRunner.query(`DROP TABLE "user_settings"`);
+    await queryRunner.query(
+      `ALTER TABLE "temporary_user_settings" RENAME TO "user_settings"`
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "user_settings" RENAME TO "temporary_user_settings"`
+    );
+    await queryRunner.query(
+      `CREATE TABLE "user_settings" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "notificationTypes" text, "discordId" varchar, "userId" integer, "originalLanguage" varchar, "telegramChatId" varchar, "telegramSendSilently" boolean, "pgpKey" varchar, "locale" varchar NOT NULL DEFAULT (''), "pushbulletAccessToken" varchar, "pushoverApplicationToken" varchar, "pushoverUserKey" varchar, "watchlistSyncMovies" boolean, "watchlistSyncTv" boolean, "pushoverSound" varchar, CONSTRAINT "UQ_986a2b6d3c05eb4091bb8066f78" UNIQUE ("userId"), CONSTRAINT "FK_986a2b6d3c05eb4091bb8066f78" FOREIGN KEY ("userId") REFERENCES "user" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`
+    );
+    await queryRunner.query(
+      `INSERT INTO "user_settings"("id", "notificationTypes", "discordId", "userId", "originalLanguage", "telegramChatId", "telegramSendSilently", "pgpKey", "locale", "pushbulletAccessToken", "pushoverApplicationToken", "pushoverUserKey", "watchlistSyncMovies", "watchlistSyncTv", "pushoverSound") SELECT "id", "notificationTypes", "discordId", "userId", "originalLanguage", "telegramChatId", "telegramSendSilently", "pgpKey", "locale", "pushbulletAccessToken", "pushoverApplicationToken", "pushoverUserKey", "watchlistSyncMovies", "watchlistSyncTv", "pushoverSound" FROM "temporary_user_settings"`
+    );
+    await queryRunner.query(`DROP TABLE "temporary_user_settings"`);
+    await queryRunner.query(
+      `ALTER TABLE "user_settings" RENAME TO "temporary_user_settings"`
+    );
+    await queryRunner.query(
+      `CREATE TABLE "user_settings" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "notificationTypes" text, "discordId" varchar, "userId" integer, "originalLanguage" varchar, "telegramChatId" varchar, "telegramSendSilently" boolean, "pgpKey" varchar, "locale" varchar NOT NULL DEFAULT (''), "pushbulletAccessToken" varchar, "pushoverApplicationToken" varchar, "pushoverUserKey" varchar, "watchlistSyncMovies" boolean, "watchlistSyncTv" boolean, "pushoverSound" varchar, "region" varchar, CONSTRAINT "UQ_986a2b6d3c05eb4091bb8066f78" UNIQUE ("userId"), CONSTRAINT "FK_986a2b6d3c05eb4091bb8066f78" FOREIGN KEY ("userId") REFERENCES "user" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`
+    );
+    await queryRunner.query(
+      `INSERT INTO "user_settings"("id", "notificationTypes", "discordId", "userId", "originalLanguage", "telegramChatId", "telegramSendSilently", "pgpKey", "locale", "pushbulletAccessToken", "pushoverApplicationToken", "pushoverUserKey", "watchlistSyncMovies", "watchlistSyncTv", "pushoverSound") SELECT "id", "notificationTypes", "discordId", "userId", "originalLanguage", "telegramChatId", "telegramSendSilently", "pgpKey", "locale", "pushbulletAccessToken", "pushoverApplicationToken", "pushoverUserKey", "watchlistSyncMovies", "watchlistSyncTv", "pushoverSound" FROM "temporary_user_settings"`
+    );
+    await queryRunner.query(`DROP TABLE "temporary_user_settings"`);
+  }
+}
diff --git a/server/routes/discover.ts b/server/routes/discover.ts
@@ -29,12 +29,12 @@ import { z } from 'zod';
 export const createTmdbWithRegionLanguage = (user?: User): TheMovieDb => {
   const settings = getSettings();
 
-  const region =
-    user?.settings?.region === 'all'
+  const discoverRegion =
+    user?.settings?.streamingRegion === 'all'
       ? ''
-      : user?.settings?.region
-      ? user?.settings?.region
-      : settings.main.region;
+      : user?.settings?.streamingRegion
+      ? user?.settings?.streamingRegion
+      : settings.main.discoverRegion;
 
   const originalLanguage =
     user?.settings?.originalLanguage === 'all'
@@ -44,7 +44,7 @@ export const createTmdbWithRegionLanguage = (user?: User): TheMovieDb => {
       : settings.main.originalLanguage;
 
   return new TheMovieDb({
-    region,
+    discoverRegion,
     originalLanguage,
   });
 };

diff --git a/server/routes/user/usersettings.ts b/server/routes/user/usersettings.ts
@@ -57,7 +57,8 @@ userSettingsRoutes.get<{ id: string }, UserSettingsGeneralResponse>(
         email: user.email,
         discordId: user.settings?.discordId,
         locale: user.settings?.locale,
-        region: user.settings?.region,
+        discoverRegion: user.settings?.discoverRegion,
+        streamingRegion: user.settings?.streamingRegion,
         originalLanguage: user.settings?.originalLanguage,
         movieQuotaLimit: user.movieQuotaLimit,
         movieQuotaDays: user.movieQuotaDays,
@@ -147,15 +148,17 @@ userSettingsRoutes.post<
         user: req.user,
         discordId: req.body.discordId,
         locale: req.body.locale,
-        region: req.body.region,
+        discoverRegion: req.body.discoverRegion,
+        streamingRegion: req.body.streamingRegion,
         originalLanguage: req.body.originalLanguage,
         watchlistSyncMovies: req.body.watchlistSyncMovies,
         watchlistSyncTv: req.body.watchlistSyncTv,
       });
     } else {
       user.settings.discordId = req.body.discordId;
       user.settings.locale = req.body.locale;
-      user.settings.region = req.body.region;
+      user.settings.discoverRegion = req.body.discoverRegion;
+      user.settings.streamingRegion = req.body.streamingRegion;
       user.settings.originalLanguage = req.body.originalLanguage;
       user.settings.watchlistSyncMovies = req.body.watchlistSyncMovies;
       user.settings.watchlistSyncTv = req.body.watchlistSyncTv;
@@ -167,7 +170,8 @@ userSettingsRoutes.post<
       username: savedUser.username,
       discordId: savedUser.settings?.discordId,
       locale: savedUser.settings?.locale,
-      region: savedUser.settings?.region,
+      discoverRegion: savedUser.settings?.discoverRegion,
+      streamingRegion: savedUser.settings?.streamingRegion,
       originalLanguage: savedUser.settings?.originalLanguage,
       watchlistSyncMovies: savedUser.settings?.watchlistSyncMovies,
       watchlistSyncTv: savedUser.settings?.watchlistSyncTv,

diff --git a/src/components/MovieDetails/index.tsx b/src/components/MovieDetails/index.tsx
@@ -222,14 +222,14 @@ const MovieDetails = ({ movie }: MovieDetailsProps) => {
     });
   }
 
-  const region = user?.settings?.region
-    ? user.settings.region
-    : settings.currentSettings.region
-    ? settings.currentSettings.region
+  const discoverRegion = user?.settings?.discoverRegion
+    ? user.settings.discoverRegion
+    : settings.currentSettings.discoverRegion
+    ? settings.currentSettings.discoverRegion
     : 'US';
 
   const releases = data.releases.results.find(
-    (r) => r.iso_3166_1 === region
+    (r) => r.iso_3166_1 === discoverRegion
   )?.release_dates;
 
   // Release date types:
@@ -282,9 +282,15 @@ const MovieDetails = ({ movie }: MovieDetailsProps) => {
     );
   }
 
+  const streamingRegion = user?.settings?.streamingRegion
+    ? user.settings.streamingRegion
+    : settings.currentSettings.streamingRegion
+    ? settings.currentSettings.streamingRegion
+    : 'US';
   const streamingProviders =
-    data?.watchProviders?.find((provider) => provider.iso_3166_1 === region)
-      ?.flatrate ?? [];
+    data?.watchProviders?.find(
+      (provider) => provider.iso_3166_1 === streamingRegion
+    )?.flatrate ?? [];
 
   function getAvalaibleMediaServerName() {
     if (settings.currentSettings.mediaServerType === MediaServerType.EMBY) {