Merge pull request #46 from justinhartman/develop

Merge home caching and robots from develop into main

Author: justinhartman

controllers/appController.spec.ts

@@ -2,6 +2,7 @@ import appController from './appController';
 import http from '../helpers/httpClient';
 import { fetchOmdbData, fetchAndUpdatePosters, getSeriesDetail } from '../helpers/appHelper';
 import History from '../models/History';
+import { getLatest, setLatest, invalidateLatest } from '../helpers/cache';
 
 jest.mock('../helpers/httpClient', () => ({
   __esModule: true,
@@ -13,6 +14,12 @@ jest.mock('../helpers/appHelper', () => ({
   getSeriesDetail: jest.fn(),
 }));
 
+jest.mock('../helpers/cache', () => ({
+  getLatest: jest.fn(),
+  setLatest: jest.fn(),
+  invalidateLatest: jest.fn(),
+}));
+
 jest.mock('../models/History', () => ({
   findOne: jest.fn(),
   findOneAndUpdate: jest.fn(),
@@ -41,6 +48,7 @@ describe('controllers/appController', () => {
       .mockResolvedValueOnce({ data: { result: [{ imdb_id: '1' }] } })
       .mockResolvedValueOnce({ data: { result: [{ imdb_id: '2' }] } });
     (fetchAndUpdatePosters as jest.Mock).mockResolvedValue(undefined);
+    (getLatest as jest.Mock).mockReturnValue(undefined);
 
     const req: any = { query: {}, user: { id: 1 } };
     const res: any = { locals: { APP_URL: 'http://app', CARD_TYPE: 'card' }, render: jest.fn() };
@@ -49,6 +57,7 @@ describe('controllers/appController', () => {
 
     expect(http.get).toHaveBeenCalledTimes(2);
     expect(fetchAndUpdatePosters).toHaveBeenCalledTimes(2);
+    expect(setLatest).toHaveBeenCalledWith({ movies: [{ imdb_id: '1' }], series: [{ imdb_id: '2' }] });
     expect(res.render).toHaveBeenCalledWith('index', expect.objectContaining({
       newMovies: [{ imdb_id: '1' }],
       newSeries: [{ imdb_id: '2' }],
@@ -62,6 +71,7 @@ describe('controllers/appController', () => {
       .mockResolvedValueOnce({ data: {} })
       .mockResolvedValueOnce({ data: {} });
     (fetchAndUpdatePosters as jest.Mock).mockResolvedValue(undefined);
+    (getLatest as jest.Mock).mockReturnValue(undefined);
 
     const req: any = { query: {}, user: {} };
     const res: any = {
@@ -77,6 +87,34 @@ describe('controllers/appController', () => {
     }));
   });
 
+  test('getHome returns cached results when available', async () => {
+    (getLatest as jest.Mock).mockReturnValue({
+      movies: [{ imdb_id: 'm1' }],
+      series: [{ imdb_id: 's1' }],
+    });
+    const req: any = { query: {}, user: {} };
+    const res: any = { locals: { APP_URL: 'http://app', CARD_TYPE: 'card' }, render: jest.fn() };
+
+    await appController.getHome(req, res, jest.fn());
+
+    expect(http.get).not.toHaveBeenCalled();
+    expect(fetchAndUpdatePosters).not.toHaveBeenCalled();
+    expect(res.render).toHaveBeenCalledWith('index', expect.objectContaining({
+      newMovies: [{ imdb_id: 'm1' }],
+      newSeries: [{ imdb_id: 's1' }],
+    }));
+  });
+
+  test('clearCache invalidates cache', async () => {
+    const req: any = {};
+    const res: any = { json: jest.fn() };
+
+    await appController.clearCache(req, res, jest.fn());
+
+    expect(invalidateLatest).toHaveBeenCalled();
+    expect(res.json).toHaveBeenCalledWith({ cleared: true });
+  });
+
   test('getView renders series view', async () => {
     (fetchOmdbData as jest.Mock).mockResolvedValue({});
     const req: any = { params: { q: '', id: 'tt', type: 'series', season: '1', episode: '2' }, user: { id: 'u1' } };

controllers/appController.ts

@@ -11,6 +11,7 @@ import { fetchOmdbData, fetchAndUpdatePosters, getSeriesDetail } from '../helper
 import http from '../helpers/httpClient';
 import History from '../models/History';
 import type { AuthRequest } from '../types/interfaces';
+import { getLatest, setLatest, invalidateLatest } from '../helpers/cache';
 
 /**
  * @namespace appController
@@ -58,19 +59,33 @@ const appController = {
     const query = (req.query.q as string) || '';
     const type = (req.query.type as string) || 'movie';
     const canonical = res.locals.APP_URL;
+    const cached = getLatest();
+    if (cached) {
+      return res.render('index', {
+        newMovies: cached.movies,
+        newSeries: cached.series,
+        query,
+        type,
+        canonical,
+        card: res.locals.CARD_TYPE,
+        user: req.user,
+      });
+    }
+
+    const [axiosMovieResponse, axiosSeriesResponse] = await Promise.all([
+      http.get(`https://${appConfig.VIDSRC_DOMAIN}/movies/latest/page-1.json`),
+      http.get(`https://${appConfig.VIDSRC_DOMAIN}/tvshows/latest/page-1.json`),
+    ]);
 
-    const axiosMovieResponse = await http.get(
-      `https://${appConfig.VIDSRC_DOMAIN}/movies/latest/page-1.json`
-    );
     let newMovies = axiosMovieResponse.data.result || [];
-    await fetchAndUpdatePosters(newMovies);
+    let newSeries = axiosSeriesResponse.data.result || [];
 
-    const axiosSeriesResponse = await http.get(
-      `https://${appConfig.VIDSRC_DOMAIN}/tvshows/latest/page-1.json`
-    );
+    await Promise.all([
+      fetchAndUpdatePosters(newMovies),
+      fetchAndUpdatePosters(newSeries),
+    ]);
 
-    let newSeries = axiosSeriesResponse.data.result || [];
-    await fetchAndUpdatePosters(newSeries);
+    setLatest({ movies: newMovies, series: newSeries });
 
     res.render('index', {
       newMovies,
@@ -83,6 +98,15 @@ const appController = {
     });
   }),
 
+  /**
+   * Invalidates the cached latest movies and series.
+   * Useful for deployments or scheduled cache refreshes.
+   */
+  clearCache: asyncHandler(async (_req: AuthRequest, res: Response) => {
+    invalidateLatest();
+    res.json({ cleared: true });
+  }),
+
   /**
    * Handles the "getView" route for rendering a view page based on the provided query parameters.
    *

helpers/cache.spec.ts

@@ -0,0 +1,17 @@
+import { getLatest, setLatest, invalidateLatest } from './cache';
+
+describe('helpers/cache', () => {
+  afterEach(() => invalidateLatest());
+
+  test('stores and retrieves latest content', () => {
+    const data = { movies: [1], series: [2] } as any;
+    setLatest(data);
+    expect(getLatest()).toEqual(data);
+  });
+
+  test('invalidateLatest clears cache', () => {
+    setLatest({ movies: [1], series: [2] } as any);
+    invalidateLatest();
+    expect(getLatest()).toBeUndefined();
+  });
+});

helpers/cache.ts

@@ -0,0 +1,52 @@
+/**
+ * @module helpers/cache
+ * @description In-memory caching utilities for storing latest movies and series.
+ */
+
+import NodeCache from 'node-cache';
+
+/**
+ * TTL for cache entries in seconds (24 hours).
+ */
+const TTL_SECONDS = 60 * 60 * 24;
+
+/**
+ * Internal NodeCache instance.
+ */
+const cache = new NodeCache({ stdTTL: TTL_SECONDS });
+
+const HOME_KEY = 'latest_home';
+
+export interface LatestContent {
+  movies: any[];
+  series: any[];
+}
+
+/**
+ * Retrieves latest movies and series from cache.
+ * @returns {LatestContent | undefined} Cached content if available.
+ */
+export const getLatest = (): LatestContent | undefined => {
+  return cache.get<LatestContent>(HOME_KEY);
+};
+
+/**
+ * Stores latest movies and series in cache.
+ * @param data Latest content to cache.
+ */
+export const setLatest = (data: LatestContent): void => {
+  cache.set(HOME_KEY, data);
+};
+
+/**
+ * Manually clears the cached latest content.
+ */
+export const invalidateLatest = (): void => {
+  cache.del(HOME_KEY);
+};
+
+export default {
+  getLatest,
+  setLatest,
+  invalidateLatest,
+};

package.json

@@ -45,6 +45,7 @@
     "express-session": "^1.18.2",
     "mongodb": "^6.18.0",
     "mongoose": "^8.17.1",
+    "node-cache": "^5.1.2",
     "passport": "^0.7.0",
     "passport-local": "^1.0.0"
   },

public/robots.txt

@@ -0,0 +1,23 @@
+# NOTICE: The collection of content and other data on
+# this site through automated means, including any
+# device, tool, or process designed to data mine or
+# scrape content, is prohibited except (1) as provided by
+# the below Content Usage directives or (2) with express
+# written permission from this website's owner.
+
+# To request permission to license our intellectual
+# property and/or other materials, please contact us at
+# hello@binger.uk
+
+User-Agent: AhrefsBot
+Disallow: /
+
+User-Agent: AhrefsSiteAudit
+Disallow: /
+
+User-agent: CensysInspect
+Disallow: /
+
+User-Agent: *
+Content-Usage: tdm=n, search=y, inference=y
+Allow: /