v1.1.1 - Add Random Character Route (#36)

k-wilmeth · web-flow · commit 93afa618bcb5 · 2025-09-04T19:13:58.000-05:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jetsetradio-api",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "A Data Provider relating to the JSR/JSRF universe",
   "type": "module",
   "main": "src/app.js",
diff --git a/src/controllers/characterController.js b/src/controllers/characterController.js
@@ -1,3 +1,4 @@
+import {all} from "axios";
 import {
   performJSRAction,
   performJSRFAction,
@@ -30,6 +31,28 @@ export const getAllCharacters = async (req, res) => {
   }
 };
 
+export const getRandomCharacter = async (req, res) => {
+  try {
+    const jsrCharacters = await fetchJSRCharacters(req);
+    const jsrfCharacters = await fetchJSRFCharacters(req);
+    const brcCharacters = await fetchBRCCharacters(req);
+
+    const allCharacters = [
+      ...jsrCharacters,
+      ...jsrfCharacters,
+      ...brcCharacters,
+    ];
+
+    const randomCharacter =
+      allCharacters[Math.floor(Math.random() * allCharacters.length)];
+
+    res.json(randomCharacter);
+  } catch (err) {
+    LOGGER.error(`Could not fetch random character \n${err}`);
+    res.status(500).json({error: "Failed to fetch random character"});
+  }
+};
+
 export const getJSRCharacters = async (req, res) => {
   try {
     res.send(await fetchJSRCharacters(req));
diff --git a/src/managers/MiddlewareManager.js b/src/managers/MiddlewareManager.js
@@ -1,111 +1,143 @@
-import express from 'express';
-import listEndpoints from 'express-list-endpoints';
-import { fileURLToPath } from 'url';
-import path, { dirname } from 'path';
-import cors from 'cors';
-import * as bcrypt from 'bcrypt';
-import swaggerUi from 'swagger-ui-express';
-import rateLimit from 'express-rate-limit';
-import MemoryCache from 'memory-cache';
-import favicon from 'serve-favicon';
-import { createRequire } from 'module';
+import express from "express";
+import listEndpoints from "express-list-endpoints";
+import {fileURLToPath} from "url";
+import path, {dirname} from "path";
+import cors from "cors";
+import * as bcrypt from "bcrypt";
+import swaggerUi from "swagger-ui-express";
+import rateLimit from "express-rate-limit";
+import MemoryCache from "memory-cache";
+import favicon from "serve-favicon";
+import {createRequire} from "module";
 const require = createRequire(import.meta.url);
-const data = require('../utils/swagger-docs.json');
-import dotenv from 'dotenv';
+const data = require("../utils/swagger-docs.json");
+import dotenv from "dotenv";
 dotenv.config();
 
-import Constants from '../constants/dbConstants.js';
-import HealthCheckManager from './HealthCheckManager.js';
-import router from '../routes/router.js';
-import { renderHome, renderDocs } from '../controllers/indexController.js';
-import { listCollections } from '../config/db.js';
-import LOGGER from '../utils/logger.js';
-import { Actions } from '../config/dbActions.js';
-import { performCoreAdminAction } from '../config/db.js';
-
+import Constants from "../constants/dbConstants.js";
+import HealthCheckManager from "./HealthCheckManager.js";
+import router from "../routes/router.js";
+import {renderHome, renderDocs} from "../controllers/indexController.js";
+import {listCollections} from "../config/db.js";
+import LOGGER from "../utils/logger.js";
+import {Actions} from "../config/dbActions.js";
+import {performCoreAdminAction} from "../config/db.js";
 
 const cache = new MemoryCache.Cache();
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const healthCheckManager = new HealthCheckManager();
-const { CORE_DB, JSR_DB, JSRF_DB } = Constants;
+const {CORE_DB, JSR_DB, JSRF_DB, BRC_DB} = Constants;
 
 class MiddlewareManager {
-
   setMiddleware(app) {
-    app.set('views', path.join(__dirname, '..', 'views'));
-    app.set('view engine', 'ejs');
-  
+    app.set("views", path.join(__dirname, "..", "views"));
+    app.set("view engine", "ejs");
+
     app.use(cors());
-    app.use(express.static(path.join(__dirname, '..', 'public')));
-    app.use(express.urlencoded({ extended: true }));
+    app.use(express.static(path.join(__dirname, "..", "public")));
+    app.use(express.urlencoded({extended: true}));
     app.use(express.json());
-    app.use(favicon(path.join(__dirname, '..', 'public', 'img', 'favicon.ico')));
-
-    app.get('/', (req, res) => renderHome(req, res));
-    app.get('/docs', (req, res) => renderDocs(req, res));
-    app.get('/health', (req, res) => res.send(healthCheckManager.getAppHealth()));
-    app.get('/endpoints', async (req, res) => res.send(await filterPipeRoutes(req, listEndpoints(app))));
-    app.post('/cache/clear', async (req, res) => await clearCache(req, res));
-    app.use('/v1/api', [limiter, cacheMiddleware], router);
-    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(data))
+    app.use(
+      favicon(path.join(__dirname, "..", "public", "img", "favicon.ico"))
+    );
+
+    app.get("/", (req, res) => renderHome(req, res));
+    app.get("/docs", (req, res) => renderDocs(req, res));
+    app.get("/health", (req, res) =>
+      res.send(healthCheckManager.getAppHealth())
+    );
+    app.get("/endpoints", async (req, res) =>
+      res.send(await filterPipeRoutes(req, listEndpoints(app)))
+    );
+    app.post("/cache/clear", async (req, res) => await clearCache(req, res));
+    app.use("/v1/api", [limiter, cacheMiddleware], router);
+    app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(data));
   }
-
 }
 
 /**
  * Return a list of Available Endpoints
  * Pass pipe=true to filter the results to just the routes needed to populate a development database
- * 
+ *
  * @param {*} req : the express request object
  * @param {*} endpoints : the unfiltered endpoints object list
- * @returns 
+ * @returns
  */
 const filterPipeRoutes = async (req, endpoints) => {
   const pipe = req?.query?.pipe;
   const coreCollectionsObj = await listCollections(CORE_DB);
   const jsrCollectionsObj = await listCollections(JSR_DB);
   const jsrfCollectionsObj = await listCollections(JSRF_DB);
-  const coreCollections = coreCollectionsObj.map(col => { return `${col.name.toLowerCase()}s` });
-  const jsrCollections = jsrCollectionsObj.map(col => { return `${col.name.toLowerCase()}s` });
-  const jsrfCollections = jsrfCollectionsObj.map(col => { return `${col.name.toLowerCase()}s` });
+  const brcCollectionsObj = await listCollections(BRC_DB);
+
+  const coreCollections = coreCollectionsObj.map((col) => {
+    return `${col.name.toLowerCase()}s`;
+  });
+  const jsrCollections = jsrCollectionsObj.map((col) => {
+    return `${col.name.toLowerCase()}s`;
+  });
+  const jsrfCollections = jsrfCollectionsObj.map((col) => {
+    return `${col.name.toLowerCase()}s`;
+  });
+  const brcCollections = brcCollectionsObj.map((col) => {
+    return `${col.name.toLowerCase()}s`;
+  });
 
   endpoints = endpoints
-    .filter(endpoint => pipe 
-      ? !endpoint.path.includes(':') && endpoint.path.includes('/v1/api') 
-      : endpoint)
-    .map(endpoint => { return endpoint.path })
+    .filter((endpoint) =>
+      pipe
+        ? !endpoint.path.includes(":") && endpoint.path.includes("/v1/api")
+        : endpoint
+    )
+    .map((endpoint) => {
+      return endpoint.path;
+    });
 
   if (pipe) {
     const filteredEndpoints = [];
     for (const endpoint of endpoints) {
-      const model = endpoint.split('/')[3].replace('-', '');
+      const model = endpoint.split("/")[3].replace("-", "");
+      console.log("processing model: ", model, " and endpoint: ", endpoint);
       if (coreCollections.includes(model)) {
         filteredEndpoints.push(endpoint);
       }
-      if (jsrCollections.includes(model) && endpoint.includes('jsr')) {
+      if (jsrCollections.includes(model) && endpoint.includes("jsr")) {
         filteredEndpoints.push(endpoint);
       }
-      if (jsrfCollections.includes(model) && endpoint.includes('jsrf')) {
+      if (jsrfCollections.includes(model) && endpoint.includes("jsrf")) {
+        filteredEndpoints.push(endpoint);
+      }
+      if (
+        brcCollections.includes(model) &&
+        (endpoint.includes("brc") || endpoint.includes("collectibles"))
+      ) {
         filteredEndpoints.push(endpoint);
       }
     }
     endpoints = filteredEndpoints;
   }
   return [...new Set(endpoints)];
-}
+};
 
+/* Rate Limiting */
 const limiter = rateLimit({
   windowMs: 60 * 60 * 1000, // 1 hour time range
   max: 1000, // 1000 requests limit
-  keyGenerator: (req) => { 
+  keyGenerator: (req) => {
     return req.ip;
   },
 });
 
+/* Set Cache */
 const cacheMiddleware = (req, res, next) => {
-  const clientIp = req.ip; 
+  const clientIp = req.ip;
   const cacheKey = `cache_${clientIp}_${req.originalUrl || req.url}`;
 
+  /* Don't cache 'Random' routes */
+  if (req?.path.includes("random")) {
+    return next();
+  }
+
   const cachedData = cache.get(cacheKey);
   if (cachedData) {
     LOGGER.info(`Cache hit for url ${req.url}`);
@@ -128,33 +160,34 @@ const cacheMiddleware = (req, res, next) => {
   next();
 };
 
+/* Clear Cache */
 const clearCache = async (req, res) => {
   const username = req?.body?.username;
   const password = req?.body?.password;
   const adminUser = await performCoreAdminAction(Actions.fetchAdmin, username);
   if (!adminUser) {
-    LOGGER.error('Admin User Not Found');
-    return res.status(400).send()
+    LOGGER.error("Admin User Not Found");
+    return res.status(400).send();
   }
   const authenticated = await validatePassword(password, adminUser?.password);
   if (!authenticated) {
-    LOGGER.error('Invalid Admin Creds!');
-    return res.status(401).send('Unauthorized');
+    LOGGER.error("Invalid Admin Creds!");
+    return res.status(401).send("Unauthorized");
   }
   if (adminUser && authenticated) {
     cache.clear();
-    LOGGER.info('All Caches Cleared');
-    return res.send('Cache Cleared');
+    LOGGER.info("All Caches Cleared");
+    return res.send("Cache Cleared");
   }
-  res.status(500).send('Unexpected Behavior');
-}
+  res.status(500).send("Unexpected Behavior");
+};
 
 const validatePassword = async (password, hashedPassword) => {
   try {
     return await bcrypt.compare(password, hashedPassword);
   } catch (err) {
     LOGGER.warn(`Error validating Admin password ${err}`);
   }
-}
+};
 
-export default MiddlewareManager;
+export default MiddlewareManager;
diff --git a/src/routes/characterRouter.js b/src/routes/characterRouter.js
@@ -1,10 +1,11 @@
 import express from 'express';
-import { getAllCharacters, getJSRCharacters, getJSRFCharacters, getJSRCharacterById, getJSRFCharacterById, getBRCCharacters, getBRCCharacterById } from '../controllers/characterController.js';
+import { getAllCharacters, getRandomCharacter, getJSRCharacters, getJSRFCharacters, getJSRCharacterById, getJSRFCharacterById, getBRCCharacters, getBRCCharacterById } from '../controllers/characterController.js';
 
 
 const characters = express.Router();
 
 characters.get('/', async (req, res) => /* #swagger.tags = ['Characters'] */ await getAllCharacters(req, res));
+characters.get('/random', async (req, res) => /* #swagger.tags = ['Characters'] */ await getRandomCharacter(req, res));
 characters.get('/jsr', async (req, res) => /* #swagger.tags = ['Characters'] */ await getJSRCharacters(req, res));
 characters.get('/jsr/:id', async (req, res) => /* #swagger.tags = ['Characters'] */ await getJSRCharacterById(req, res));
 characters.get('/jsrf', async (req, res) => /* #swagger.tags = ['Characters'] */ await getJSRFCharacters(req, res));
diff --git a/src/routes/collectibleRouter.js b/src/routes/collectibleRouter.js
@@ -6,7 +6,7 @@ import {
 
 const collectibles = express.Router();
 
-collectibles.get("/", async (req, res) => /* #swagger.tags = ['Collectible'] */ await getAllCollectibles(req, res));
-collectibles.get("/:id", async (req, res) => /* #swagger.tags = ['Collectible'] */ await getBRCCollectibleById(req, res));
+collectibles.get("/", async (req, res) => /* #swagger.tags = ['Collectibles'] */ await getAllCollectibles(req, res));
+collectibles.get("/:id", async (req, res) => /* #swagger.tags = ['Collectibles'] */ await getBRCCollectibleById(req, res));
 
 export default collectibles;
diff --git a/src/utils/swagger-docs.json b/src/utils/swagger-docs.json

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "jetsetradio-api",`
`3`		`- "version": "1.1.0",`
	`3`	`+ "version": "1.1.1",`
`4`	`4`	`"description": "A Data Provider relating to the JSR/JSRF universe",`
`5`	`5`	`"type": "module",`
`6`	`6`	`"main": "src/app.js",`