refactor: rename blacklist to blocklist (#2157)

Signed-off-by: 0xsysr3ll <0xsysr3ll@pm.me>
Co-authored-by: fallenbagel <98979876+Fallenbagel@users.noreply.github.com>
Co-authored-by: 0xsysr3ll <0xsysr3ll@pm.me>
Co-authored-by: gauthier-th <mail@gauthierth.fr>

server/lib/settings/index.ts

@@ -132,15 +132,15 @@ export interface MainSettings {
     tv: Quota;
   };
   hideAvailable: boolean;
-  hideBlacklisted: boolean;
+  hideBlocklisted: boolean;
   localLogin: boolean;
   mediaServerLogin: boolean;
   newPlexLogin: boolean;
   discoverRegion: string;
   streamingRegion: string;
   originalLanguage: string;
-  blacklistedTags: string;
-  blacklistedTagsLimit: number;
+  blocklistedTags: string;
+  blocklistedTagsLimit: number;
   mediaServerType: number;
   partialRequestsEnabled: boolean;
   enableSpecialEpisodes: boolean;
@@ -181,7 +181,7 @@ interface FullPublicSettings extends PublicSettings {
   applicationTitle: string;
   applicationUrl: string;
   hideAvailable: boolean;
-  hideBlacklisted: boolean;
+  hideBlocklisted: boolean;
   localLogin: boolean;
   mediaServerLogin: boolean;
   movie4kEnabled: boolean;
@@ -346,7 +346,7 @@ export type JobId =
   | 'jellyfin-full-scan'
   | 'image-cache-cleanup'
   | 'availability-sync'
-  | 'process-blacklisted-tags';
+  | 'process-blocklisted-tags';
 
 export interface AllSettings {
   clientId: string;
@@ -389,15 +389,15 @@ class Settings {
           tv: {},
         },
         hideAvailable: false,
-        hideBlacklisted: false,
+        hideBlocklisted: false,
         localLogin: true,
         mediaServerLogin: true,
         newPlexLogin: true,
         discoverRegion: '',
         streamingRegion: '',
         originalLanguage: '',
-        blacklistedTags: '',
-        blacklistedTagsLimit: 50,
+        blocklistedTags: '',
+        blocklistedTagsLimit: 50,
         mediaServerType: MediaServerType.NOT_CONFIGURED,
         partialRequestsEnabled: true,
         enableSpecialEpisodes: false,
@@ -570,7 +570,7 @@ class Settings {
         'image-cache-cleanup': {
           schedule: '0 0 5 * * *',
         },
-        'process-blacklisted-tags': {
+        'process-blocklisted-tags': {
           schedule: '0 30 1 */7 * *',
         },
       },
@@ -671,7 +671,7 @@ class Settings {
       applicationTitle: this.data.main.applicationTitle,
       applicationUrl: this.data.main.applicationUrl,
       hideAvailable: this.data.main.hideAvailable,
-      hideBlacklisted: this.data.main.hideBlacklisted,
+      hideBlocklisted: this.data.main.hideBlocklisted,
       localLogin: this.data.main.localLogin,
       mediaServerLogin: this.data.main.mediaServerLogin,
       jellyfinExternalHost: this.data.jellyfin.externalHostname,

server/lib/settings/migrations/0008_migrate_blacklist_to_blocklist.ts

@@ -0,0 +1,40 @@
+import type { AllSettings } from '@server/lib/settings';
+
+const migrateBlacklistToBlocklist = (settings: any): AllSettings => {
+  if (
+    Array.isArray(settings.migrations) &&
+    settings.migrations.includes('0008_migrate_blacklist_to_blocklist')
+  ) {
+    return settings;
+  }
+
+  if (settings.main?.hideBlacklisted !== undefined) {
+    settings.main.hideBlocklisted = settings.main.hideBlacklisted;
+    delete settings.main.hideBlacklisted;
+  }
+
+  if (settings.main?.blacklistedTags !== undefined) {
+    settings.main.blocklistedTags = settings.main.blacklistedTags;
+    delete settings.main.blacklistedTags;
+  }
+
+  if (settings.main?.blacklistedTagsLimit !== undefined) {
+    settings.main.blocklistedTagsLimit = settings.main.blacklistedTagsLimit;
+    delete settings.main.blacklistedTagsLimit;
+  }
+
+  if (settings.jobs?.['process-blacklisted-tags']) {
+    settings.jobs['process-blocklisted-tags'] =
+      settings.jobs['process-blacklisted-tags'];
+    delete settings.jobs['process-blacklisted-tags'];
+  }
+
+  if (!Array.isArray(settings.migrations)) {
+    settings.migrations = [];
+  }
+  settings.migrations.push('0008_migrate_blacklist_to_blocklist');
+
+  return settings;
+};
+
+export default migrateBlacklistToBlocklist;