Merge remote-tracking branch 'overseerr/develop' into develop

server/api/animelist.ts

@@ -1,8 +1,8 @@
+import logger from '@server/logger';
 import axios from 'axios';
-import xml2js from 'xml2js';
 import fs, { promises as fsp } from 'fs';
 import path from 'path';
-import logger from '../logger';
+import xml2js from 'xml2js';
 
 const UPDATE_INTERVAL_MSEC = 24 * 3600 * 1000; // how often to download new mapping in milliseconds
 // originally at https://raw.githubusercontent.com/ScudLee/anime-lists/master/anime-list.xml
@@ -14,7 +14,7 @@ const LOCAL_PATH = process.env.CONFIG_DIRECTORY
 
 const mappingRegexp = new RegExp(/;[0-9]+-([0-9]+)/g);
 
-// Anime-List xml files are community maintained mappings that Hama agent uses to map AniDB IDs to TVDB/TMDb IDs
+// Anime-List xml files are community maintained mappings that Hama agent uses to map AniDB IDs to TVDB/TMDB IDs
 // https://github.com/Anime-Lists/anime-lists/
 
 interface AnimeMapping {

server/api/externalapi.ts

@@ -1,5 +1,7 @@
-import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
-import NodeCache from 'node-cache';
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
+import axios from 'axios';
+import rateLimit from 'axios-rate-limit';
+import type NodeCache from 'node-cache';
 
 // 5 minute default TTL (in seconds)
 const DEFAULT_TTL = 300;
@@ -10,6 +12,10 @@ const DEFAULT_ROLLING_BUFFER = 10000;
 interface ExternalAPIOptions {
   nodeCache?: NodeCache;
   headers?: Record<string, unknown>;
+  rateLimit?: {
+    maxRPS: number;
+    maxRequests: number;
+  };
 }
 
 class ExternalAPI {
@@ -31,6 +37,14 @@ class ExternalAPI {
         ...options.headers,
       },
     });
+
+    if (options.rateLimit) {
+      this.axios = rateLimit(this.axios, {
+        maxRequests: options.rateLimit.maxRequests,
+        maxRPS: options.rateLimit.maxRPS,
+      });
+    }
+
     this.baseUrl = baseUrl;
     this.cache = options.nodeCache;
   }

server/api/github.ts

@@ -1,5 +1,5 @@
-import cacheManager from '../lib/cache';
-import logger from '../logger';
+import cacheManager from '@server/lib/cache';
+import logger from '@server/logger';
 import ExternalAPI from './externalapi';
 
 interface GitHubRelease {

server/api/plexapi.ts

@@ -1,6 +1,7 @@
+import type { Library, PlexSettings } from '@server/lib/settings';
+import { getSettings } from '@server/lib/settings';
+import logger from '@server/logger';
 import NodePlexAPI from 'plex-api';
-import { getSettings, Library, PlexSettings } from '../lib/settings';
-import logger from '../logger';
 
 export interface PlexLibraryItem {
   ratingKey: string;
@@ -130,7 +131,6 @@ class PlexAPI {
     });
   }
 
-  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
   public async getStatus() {
     return await this.plexClient.query('/');
   }

server/api/plextv.ts

@@ -1,8 +1,9 @@
-import axios, { AxiosInstance } from 'axios';
+import type { PlexDevice } from '@server/interfaces/api/plexInterfaces';
+import cacheManager from '@server/lib/cache';
+import { getSettings } from '@server/lib/settings';
+import logger from '@server/logger';
 import xml2js from 'xml2js';
-import { PlexDevice } from '../interfaces/api/plexInterfaces';
-import { getSettings } from '../lib/settings';
-import logger from '../logger';
+import ExternalAPI from './externalapi';
 
 interface PlexAccountResponse {
   user: PlexUser;
@@ -111,20 +112,54 @@ interface UsersResponse {
   };
 }
 
-class PlexTvAPI {
+interface WatchlistResponse {
+  MediaContainer: {
+    totalSize: number;
+    Metadata?: {
+      ratingKey: string;
+    }[];
+  };
+}
+
+interface MetadataResponse {
+  MediaContainer: {
+    Metadata: {
+      ratingKey: string;
+      type: 'movie' | 'show';
+      title: string;
+      Guid: {
+        id: `imdb://tt${number}` | `tmdb://${number}` | `tvdb://${number}`;
+      }[];
+    }[];
+  };
+}
+
+export interface PlexWatchlistItem {
+  ratingKey: string;
+  tmdbId: number;
+  tvdbId?: number;
+  type: 'movie' | 'show';
+  title: string;
+}
+
+class PlexTvAPI extends ExternalAPI {
   private authToken: string;
-  private axios: AxiosInstance;
 
   constructor(authToken: string) {
+    super(
+      'https://plex.tv',
+      {},
+      {
+        headers: {
+          'X-Plex-Token': authToken,
+          'Content-Type': 'application/json',
+          Accept: 'application/json',
+        },
+        nodeCache: cacheManager.getCache('plextv').data,
+      }
+    );
+
     this.authToken = authToken;
-    this.axios = axios.create({
-      baseURL: 'https://plex.tv',
-      headers: {
-        'X-Plex-Token': this.authToken,
-        'Content-Type': 'application/json',
-        Accept: 'application/json',
-      },
-    });
   }
 
   public async getDevices(): Promise<PlexDevice[]> {
@@ -252,6 +287,83 @@ class PlexTvAPI {
     )) as UsersResponse;
     return parsedXml;
   }
+
+  public async getWatchlist({
+    offset = 0,
+    size = 20,
+  }: { offset?: number; size?: number } = {}): Promise<{
+    offset: number;
+    size: number;
+    totalSize: number;
+    items: PlexWatchlistItem[];
+  }> {
+    try {
+      const response = await this.axios.get<WatchlistResponse>(
+        '/library/sections/watchlist/all',
+        {
+          params: {
+            'X-Plex-Container-Start': offset,
+            'X-Plex-Container-Size': size,
+          },
+          baseURL: 'https://metadata.provider.plex.tv',
+        }
+      );
+
+      const watchlistDetails = await Promise.all(
+        (response.data.MediaContainer.Metadata ?? []).map(
+          async (watchlistItem) => {
+            const detailedResponse = await this.getRolling<MetadataResponse>(
+              `/library/metadata/${watchlistItem.ratingKey}`,
+              {
+                baseURL: 'https://metadata.provider.plex.tv',
+              }
+            );
+
+            const metadata = detailedResponse.MediaContainer.Metadata[0];
+
+            const tmdbString = metadata.Guid.find((guid) =>
+              guid.id.startsWith('tmdb')
+            );
+            const tvdbString = metadata.Guid.find((guid) =>
+              guid.id.startsWith('tvdb')
+            );
+
+            return {
+              ratingKey: metadata.ratingKey,
+              // This should always be set? But I guess it also cannot be?
+              // We will filter out the 0's afterwards
+              tmdbId: tmdbString ? Number(tmdbString.id.split('//')[1]) : 0,
+              tvdbId: tvdbString
+                ? Number(tvdbString.id.split('//')[1])
+                : undefined,
+              title: metadata.title,
+              type: metadata.type,
+            };
+          }
+        )
+      );
+
+      const filteredList = watchlistDetails.filter((detail) => detail.tmdbId);
+
+      return {
+        offset,
+        size,
+        totalSize: response.data.MediaContainer.totalSize,
+        items: filteredList,
+      };
+    } catch (e) {
+      logger.error('Failed to retrieve watchlist items', {
+        label: 'Plex.TV Metadata API',
+        errorMessage: e.message,
+      });
+      return {
+        offset,
+        size,
+        totalSize: 0,
+        items: [],
+      };
+    }
+  }
 }
 
 export default PlexTvAPI;

server/api/rottentomatoes.ts

@@ -1,4 +1,4 @@
-import cacheManager from '../lib/cache';
+import cacheManager from '@server/lib/cache';
 import ExternalAPI from './externalapi';
 
 interface RTSearchResult {

server/api/servarr/base.ts

@@ -1,6 +1,7 @@
-import cacheManager, { AvailableCacheIds } from '../../lib/cache';
-import { DVRSettings } from '../../lib/settings';
-import ExternalAPI from '../externalapi';
+import ExternalAPI from '@server/api/externalapi';
+import type { AvailableCacheIds } from '@server/lib/cache';
+import cacheManager from '@server/lib/cache';
+import type { DVRSettings } from '@server/lib/settings';
 
 export interface SystemStatus {
   version: string;

server/api/servarr/radarr.ts

@@ -1,4 +1,4 @@
-import logger from '../../logger';
+import logger from '@server/logger';
 import ServarrBase from './base';
 
 export interface RadarrMovieOptions {
@@ -69,7 +69,7 @@ class RadarrAPI extends ServarrBase<{ movieId: number }> {
 
       return response.data[0];
     } catch (e) {
-      logger.error('Error retrieving movie by TMDb ID', {
+      logger.error('Error retrieving movie by TMDB ID', {
         label: 'Radarr API',
         errorMessage: e.message,
         tmdbId: id,

server/api/servarr/sonarr.ts

@@ -1,4 +1,4 @@
-import logger from '../../logger';
+import logger from '@server/logger';
 import ServarrBase from './base';
 
 interface SonarrSeason {

server/api/tautulli.ts

@@ -1,8 +1,9 @@
-import axios, { AxiosInstance } from 'axios';
+import type { User } from '@server/entity/User';
+import type { TautulliSettings } from '@server/lib/settings';
+import logger from '@server/logger';
+import type { AxiosInstance } from 'axios';
+import axios from 'axios';
 import { uniqWith } from 'lodash';
-import { User } from '../entity/User';
-import { TautulliSettings } from '../lib/settings';
-import logger from '../logger';
 
 export interface TautulliHistoryRecord {
   date: number;

server/api/themoviedb/index.ts

@@ -1,7 +1,7 @@
+import ExternalAPI from '@server/api/externalapi';
+import cacheManager from '@server/lib/cache';
 import { sortBy } from 'lodash';
-import cacheManager from '../../lib/cache';
-import ExternalAPI from '../externalapi';
-import {
+import type {
   TmdbCollection,
   TmdbExternalIdResponse,
   TmdbGenre,
@@ -92,6 +92,10 @@ class TheMovieDb extends ExternalAPI {
       },
       {
         nodeCache: cacheManager.getCache('tmdb').data,
+        rateLimit: {
+          maxRequests: 20,
+          maxRPS: 50,
+        },
       }
     );
     this.region = region;
@@ -192,7 +196,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch person details: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch person details: ${e.message}`);
     }
   };
 
@@ -214,7 +218,7 @@ class TheMovieDb extends ExternalAPI {
       return data;
     } catch (e) {
       throw new Error(
-        `[TMDb] Failed to fetch person combined credits: ${e.message}`
+        `[TMDB] Failed to fetch person combined credits: ${e.message}`
       );
     }
   };
@@ -241,7 +245,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch movie details: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch movie details: ${e.message}`);
     }
   };
 
@@ -267,7 +271,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch TV show details: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch TV show details: ${e.message}`);
     }
   };
 
@@ -293,7 +297,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch TV show details: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch TV show details: ${e.message}`);
     }
   };
 
@@ -319,7 +323,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch discover movies: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch discover movies: ${e.message}`);
     }
   }
 
@@ -345,7 +349,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch discover movies: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch discover movies: ${e.message}`);
     }
   }
 
@@ -371,7 +375,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch movies by keyword: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch movies by keyword: ${e.message}`);
     }
   }
 
@@ -398,7 +402,7 @@ class TheMovieDb extends ExternalAPI {
       return data;
     } catch (e) {
       throw new Error(
-        `[TMDb] Failed to fetch TV recommendations: ${e.message}`
+        `[TMDB] Failed to fetch TV recommendations: ${e.message}`
       );
     }
   }
@@ -422,7 +426,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch TV similar: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch TV similar: ${e.message}`);
     }
   }
 
@@ -455,7 +459,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch discover movies: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch discover movies: ${e.message}`);
     }
   };
 
@@ -488,7 +492,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch discover TV: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch discover TV: ${e.message}`);
     }
   };
 
@@ -514,7 +518,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch upcoming movies: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch upcoming movies: ${e.message}`);
     }
   };
 
@@ -541,7 +545,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch all trending: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch all trending: ${e.message}`);
     }
   };
 
@@ -564,7 +568,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch all trending: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch all trending: ${e.message}`);
     }
   };
 
@@ -587,7 +591,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch all trending: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch all trending: ${e.message}`);
     }
   };
 
@@ -619,7 +623,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to find by external ID: ${e.message}`);
+      throw new Error(`[TMDB] Failed to find by external ID: ${e.message}`);
     }
   }
 
@@ -657,7 +661,7 @@ class TheMovieDb extends ExternalAPI {
       throw new Error(`No movie or show returned from API for ID ${imdbId}`);
     } catch (e) {
       throw new Error(
-        `[TMDb] Failed to find media using external IMDb ID: ${e.message}`
+        `[TMDB] Failed to find media using external IMDb ID: ${e.message}`
       );
     }
   }
@@ -687,7 +691,7 @@ class TheMovieDb extends ExternalAPI {
       throw new Error(`No show returned from API for ID ${tvdbId}`);
     } catch (e) {
       throw new Error(
-        `[TMDb] Failed to get TV show using the external TVDB ID: ${e.message}`
+        `[TMDB] Failed to get TV show using the external TVDB ID: ${e.message}`
       );
     }
   }
@@ -711,7 +715,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch collection: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch collection: ${e.message}`);
     }
   }
 
@@ -727,7 +731,7 @@ class TheMovieDb extends ExternalAPI {
 
       return regions;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch countries: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch countries: ${e.message}`);
     }
   }
 
@@ -743,7 +747,7 @@ class TheMovieDb extends ExternalAPI {
 
       return languages;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch langauges: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch langauges: ${e.message}`);
     }
   }
 
@@ -755,7 +759,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch movie studio: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch movie studio: ${e.message}`);
     }
   }
 
@@ -765,7 +769,7 @@ class TheMovieDb extends ExternalAPI {
 
       return data;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch TV network: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch TV network: ${e.message}`);
     }
   }
 
@@ -816,7 +820,7 @@ class TheMovieDb extends ExternalAPI {
 
       return movieGenres;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch movie genres: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch movie genres: ${e.message}`);
     }
   }
 
@@ -867,7 +871,7 @@ class TheMovieDb extends ExternalAPI {
 
       return tvGenres;
     } catch (e) {
-      throw new Error(`[TMDb] Failed to fetch TV genres: ${e.message}`);
+      throw new Error(`[TMDB] Failed to fetch TV genres: ${e.message}`);
     }
   }
 }