feat: add overseerr version and update availability status to sidebar

sort of experimental so may be kinda broken. :)

server/api/github.ts

@@ -0,0 +1,133 @@
+import cacheManager from '../lib/cache';
+import logger from '../logger';
+import ExternalAPI from './externalapi';
+
+interface GitHubRelease {
+  url: string;
+  assets_url: string;
+  upload_url: string;
+  html_url: string;
+  id: number;
+  node_id: string;
+  tag_name: string;
+  target_commitish: string;
+  name: string;
+  draft: boolean;
+  prerelease: boolean;
+  created_at: string;
+  published_at: string;
+  tarball_url: string;
+  zipball_url: string;
+  body: string;
+}
+
+interface GithubCommit {
+  sha: string;
+  node_id: string;
+  commit: {
+    author: {
+      name: string;
+      email: string;
+      date: string;
+    };
+    committer: {
+      name: string;
+      email: string;
+      date: string;
+    };
+    message: string;
+    tree: {
+      sha: string;
+      url: string;
+    };
+    url: string;
+    comment_count: number;
+    verification: {
+      verified: boolean;
+      reason: string;
+      signature: string;
+      payload: string;
+    };
+  };
+  url: string;
+  html_url: string;
+  comments_url: string;
+  parents: [
+    {
+      sha: string;
+      url: string;
+      html_url: string;
+    }
+  ];
+}
+
+class GithubAPI extends ExternalAPI {
+  constructor() {
+    super(
+      'https://api.github.com',
+      {},
+      {
+        headers: {
+          'Content-Type': 'application/json',
+          Accept: 'application/json',
+        },
+        nodeCache: cacheManager.getCache('github').data,
+      }
+    );
+  }
+
+  public async getOverseerrReleases({
+    take = 20,
+  }: {
+    take?: number;
+  } = {}): Promise<GitHubRelease[]> {
+    try {
+      const data = await this.get<GitHubRelease[]>(
+        '/repos/sct/overseerr/releases',
+        {
+          params: {
+            per_page: take,
+          },
+        }
+      );
+
+      return data;
+    } catch (e) {
+      logger.warn(
+        "Failed to retrieve GitHub releases. This may be an issue on GitHub's end. Overseerr can't check if it's on the latest version.",
+        { label: 'GitHub API', errorMessage: e.message }
+      );
+      return [];
+    }
+  }
+
+  public async getOverseerrCommits({
+    take = 20,
+    branch = 'develop',
+  }: {
+    take?: number;
+    branch?: string;
+  } = {}): Promise<GithubCommit[]> {
+    try {
+      const data = await this.get<GithubCommit[]>(
+        '/repos/sct/overseerr/commits',
+        {
+          params: {
+            per_page: take,
+            branch,
+          },
+        }
+      );
+
+      return data;
+    } catch (e) {
+      logger.warn(
+        "Failed to retrieve GitHub commits. This may be an issue on GitHub's end. Overseerr can't check if it's on the latest version.",
+        { label: 'GitHub API', errorMessage: e.message }
+      );
+      return [];
+    }
+  }
+}
+
+export default GithubAPI;

server/interfaces/api/settingsInterfaces.ts

@@ -43,3 +43,10 @@ export interface CacheItem {
     vsize: number;
   };
 }
+
+export interface StatusResponse {
+  version: string;
+  commitTag: string;
+  updateAvailable: boolean;
+  commitsBehind: number;
+}

server/lib/cache.ts

@@ -1,6 +1,6 @@
 import NodeCache from 'node-cache';
 
-export type AvailableCacheIds = 'tmdb' | 'radarr' | 'sonarr' | 'rt';
+export type AvailableCacheIds = 'tmdb' | 'radarr' | 'sonarr' | 'rt' | 'github';
 
 const DEFAULT_TTL = 300;
 const DEFAULT_CHECK_PERIOD = 120;
@@ -44,6 +44,10 @@ class CacheManager {
       stdTtl: 43200,
       checkPeriod: 60 * 30,
     }),
+    github: new Cache('github', 'GitHub API', {
+      stdTtl: 21600,
+      checkPeriod: 60 * 30,
+    }),
   };
 
   public getCache(id: AvailableCacheIds): Cache {

server/routes/index.ts

@@ -1,33 +1,75 @@
 import { Router } from 'express';
-import user from './user';
-import authRoutes from './auth';
-import { checkUser, isAuthenticated } from '../middleware/auth';
-import settingsRoutes from './settings';
+import GithubAPI from '../api/github';
+import TheMovieDb from '../api/themoviedb';
+import { StatusResponse } from '../interfaces/api/settingsInterfaces';
 import { Permission } from '../lib/permissions';
 import { getSettings } from '../lib/settings';
-import searchRoutes from './search';
-import discoverRoutes from './discover';
-import requestRoutes from './request';
-import movieRoutes from './movie';
-import tvRoutes from './tv';
-import mediaRoutes from './media';
-import personRoutes from './person';
-import collectionRoutes from './collection';
-import { getAppVersion, getCommitTag } from '../utils/appVersion';
-import serviceRoutes from './service';
-import { appDataStatus, appDataPath } from '../utils/appDataVolume';
-import TheMovieDb from '../api/themoviedb';
+import { checkUser, isAuthenticated } from '../middleware/auth';
 import { mapProductionCompany } from '../models/Movie';
 import { mapNetwork } from '../models/Tv';
+import { appDataPath, appDataStatus } from '../utils/appDataVolume';
+import { getAppVersion, getCommitTag } from '../utils/appVersion';
+import authRoutes from './auth';
+import collectionRoutes from './collection';
+import discoverRoutes from './discover';
+import mediaRoutes from './media';
+import movieRoutes from './movie';
+import personRoutes from './person';
+import requestRoutes from './request';
+import searchRoutes from './search';
+import serviceRoutes from './service';
+import settingsRoutes from './settings';
+import tvRoutes from './tv';
+import user from './user';
 
 const router = Router();
 
 router.use(checkUser);
 
-router.get('/status', (req, res) => {
+router.get<unknown, StatusResponse>('/status', async (req, res) => {
+  const githubApi = new GithubAPI();
+
+  const currentVersion = getAppVersion();
+  const commitTag = getCommitTag();
+  let updateAvailable = false;
+  let commitsBehind = 0;
+
+  if (currentVersion.startsWith('develop-') && commitTag !== 'local') {
+    const commits = await githubApi.getOverseerrCommits();
+
+    if (commits.length) {
+      const filteredCommits = commits.filter(
+        (commit) => !commit.commit.message.includes('[skip ci]')
+      );
+      if (filteredCommits[0].sha !== commitTag) {
+        updateAvailable = true;
+      }
+
+      const commitIndex = filteredCommits.findIndex(
+        (commit) => commit.sha === commitTag
+      );
+
+      if (updateAvailable) {
+        commitsBehind = commitIndex;
+      }
+    }
+  } else if (commitTag !== 'local') {
+    const releases = await githubApi.getOverseerrReleases();
+
+    if (releases.length) {
+      const latestVersion = releases[0];
+
+      if (latestVersion.name !== currentVersion) {
+        updateAvailable = true;
+      }
+    }
+  }
+
   return res.status(200).json({
     version: getAppVersion(),
     commitTag: getCommitTag(),
+    updateAvailable,
+    commitsBehind,
   });
 });
 
@@ -39,7 +81,7 @@ router.get('/status/appdata', (_req, res) => {
 });
 
 router.use('/user', isAuthenticated(), user);
-router.get('/settings/public', (_req, res) => {
+router.get('/settings/public', async (_req, res) => {
   const settings = getSettings();
 
   return res.status(200).json(settings.fullPublicSettings);