Cache middleware

Eghizio · Sep 16, 2021 · 67b062e · 67b062e
1 parent fdb5d2b
commit 67b062e
Show file tree

Hide file tree

Showing 11 changed files with 47 additions and 60 deletions.
diff --git a/src/api/alliances.ts b/src/api/alliances.ts
@@ -1,19 +1,16 @@
 // "/api/alliances"
 import express from "express";
 import fetch from "node-fetch";
+import { cache } from "../middlewares/cache";
 import { XMLParserService } from "../services/XMLParserService";
-import { CacheService } from "../services/CacheService";
 import { OGAME_API_ENDPOINTS, TEMP_SERVER_ID } from "../constants/endpoints";
 import { Alliances } from "../types/api";
 
 
 export const alliancesRouter = express.Router();
-const cache = new CacheService();
 
-alliancesRouter.get("/", (req, res) => {
 
-    if(cache.has(req.originalUrl))
-        return res.json(cache.get(req.originalUrl));
+alliancesRouter.get("/", cache(0), (req, res) => {
 
     fetch(OGAME_API_ENDPOINTS.alliances(TEMP_SERVER_ID))
         .then(response => response.text())
@@ -40,7 +37,6 @@ alliancesRouter.get("/", (req, res) => {
 
             return orderedJSON;
         })
-        .then(data => cache.set(req.originalUrl, data))
         .then(formatedJSON => res.json(formatedJSON))
         .catch(err => res.send(err));
 });
diff --git a/src/api/highscore.ts b/src/api/highscore.ts
@@ -1,13 +1,13 @@
 // "/api/highscore"
 import express from "express";
 import fetch from "node-fetch";
+import { cache } from "../middlewares/cache";
 import { XMLParserService } from "../services/XMLParserService";
-import { CacheService } from "../services/CacheService";
 import { OGAME_API_ENDPOINTS, TEMP_SERVER_ID } from "../constants/endpoints";
 
 
 export const highscoreRouter = express.Router();
-const cache = new CacheService();
+
 
 highscoreRouter.get("/", (req, res) => {
     const guide = {
@@ -29,10 +29,7 @@ highscoreRouter.get("/", (req, res) => {
 });
 
 
-highscoreRouter.get("/players", (req, res) => {
-
-    if(cache.has(req.originalUrl))
-        return res.json(cache.get(req.originalUrl));
+highscoreRouter.get("/players", cache(0), (req, res) => {
 
     const { query: q } = req;
     const type = (q.type && (Number(q.type) >= 0 && Number(q.type) <= 7)) ? q.type : "0";
@@ -54,15 +51,11 @@ highscoreRouter.get("/players", (req, res) => {
 
             return orderedJSON;
         })
-        .then(data => cache.set(req.originalUrl, data))
         .then(formatedJSON => res.json(formatedJSON))
         .catch(err => res.send(err));
 });
 
-highscoreRouter.get("/alliances", (req, res) => {
-
-    if(cache.has(req.originalUrl))
-        return res.json(cache.get(req.originalUrl));
+highscoreRouter.get("/alliances", cache(0), (req, res) => {
 
     const { query: q } = req;
     const type = (q.type && (Number(q.type) >= 0 && Number(q.type) <= 7)) ? q.type : "0";
@@ -82,7 +75,6 @@ highscoreRouter.get("/alliances", (req, res) => {
 
             return orderedJSON;
         })
-        .then(data => cache.set(req.originalUrl, data))
         .then(formatedJSON => res.json(formatedJSON))
         .catch(err => res.send(err));
 });
diff --git a/src/api/localization.ts b/src/api/localization.ts
@@ -1,19 +1,16 @@
 // "/api/localization"
 import express from "express";
 import fetch from "node-fetch";
+import { cache } from "../middlewares/cache";
 import { XMLParserService } from "../services/XMLParserService";
-import { CacheService } from "../services/CacheService";
 import { OGAME_API_ENDPOINTS, TEMP_SERVER_ID } from "../constants/endpoints";
 import { Localization } from "../types/api";
 
 
 export const localizationRouter = express.Router();
-const cache = new CacheService();
 
-localizationRouter.get("/", (req, res) => {
-
-    if(cache.has(req.originalUrl))
-        return res.json(cache.get(req.originalUrl));
+
+localizationRouter.get("/", cache(0), (req, res) => {
 
     const URL = OGAME_API_ENDPOINTS.localization(TEMP_SERVER_ID);
 
@@ -53,7 +50,6 @@ localizationRouter.get("/", (req, res) => {
 
             return orderedJSON;
         })
-        .then(data => cache.set(req.originalUrl, data))
         .then(formatedJSON => res.json(formatedJSON))
         .catch(err => res.send(err));
 });
diff --git a/src/api/playerData.ts b/src/api/playerData.ts
@@ -1,20 +1,16 @@
 // "/api/playerData"
 import express from "express";
 import fetch from "node-fetch";
+import { cache } from "../middlewares/cache";
 import { XMLParserService } from "../services/XMLParserService";
-import { CacheService } from "../services/CacheService";
 import { OGAME_API_ENDPOINTS, TEMP_SERVER_ID } from "../constants/endpoints";
 import { PlayerData } from "../types/api";
 
 
 export const playerDataRouter = express.Router();
-const cache = new CacheService();
 
 // TODO highscore and alliance (test for id=[1, 100013, 101421])
-playerDataRouter.get("/", (req, res) => {
-
-    if(cache.has(req.originalUrl))
-        return res.json(cache.get(req.originalUrl));
+playerDataRouter.get("/", cache(0), (req, res) => {
 
     const { query: q } = req;
     const id = q.id ? q.id : "1";
@@ -61,7 +57,6 @@ playerDataRouter.get("/", (req, res) => {
 
             return orderedJSON;
         })
-        .then(data => cache.set(req.originalUrl, data))
         .then(formatedJSON => res.json(formatedJSON))
         .catch(err => res.send(err));
 });
diff --git a/src/api/players.ts b/src/api/players.ts
@@ -1,21 +1,17 @@
 // "/api/players"
 import express from "express";
 import fetch from "node-fetch";
-import { CacheService } from "../services/CacheService";
+import { cache } from "../middlewares/cache";
 import { XMLParserService } from "../services/XMLParserService";
 import { OGAME_API_ENDPOINTS, TEMP_SERVER_ID } from "../constants/endpoints";
 import { Players } from "../types/api";
 
 
 export const playersRouter = express.Router();
-const cache = new CacheService();
 
-playersRouter.get("/", (req, res) => {
+playersRouter.get("/", cache(0), (req, res) => {
     // console.log(`Calling "${req.originalUrl}"...`); // need to npm morgan for logs
 
-    if(cache.has(req.originalUrl))
-        return res.json(cache.get(req.originalUrl));
-
     const URL = OGAME_API_ENDPOINTS.players(TEMP_SERVER_ID);
 
     fetch(URL)
@@ -30,7 +26,6 @@ playersRouter.get("/", (req, res) => {
 
             return orderedJSON;
         })
-        .then(data => cache.set(req.originalUrl, data))
         .then(formatedJSON => res.json(formatedJSON))
         .catch(err => res.send(err));
 });
diff --git a/src/api/serverData.ts b/src/api/serverData.ts
@@ -1,18 +1,14 @@
 // "/api/serverData"
 import express from "express";
 import fetch from "node-fetch";
+import { cache } from "../middlewares/cache";
 import { XMLParserService } from "../services/XMLParserService";
-import { CacheService } from "../services/CacheService";
 import { OGAME_API_ENDPOINTS, TEMP_SERVER_ID } from "../constants/endpoints";
 
 
 export const serverDataRouter = express.Router();
-const cache = new CacheService();
 
-serverDataRouter.get("/", (req, res) => {
-
-    if(cache.has(req.originalUrl))
-        return res.json(cache.get(req.originalUrl));
+serverDataRouter.get("/", cache(0), (req, res) => {
 
     const URL = OGAME_API_ENDPOINTS.serverData(TEMP_SERVER_ID);
 
@@ -32,7 +28,6 @@ serverDataRouter.get("/", (req, res) => {
 
             return orderedJSON;
         })
-        .then(data => cache.set(req.originalUrl, data))
         .then(formatedJSON => res.json(formatedJSON))
         .catch(err => res.send(err));
 });
diff --git a/src/api/universe.ts b/src/api/universe.ts
@@ -1,19 +1,16 @@
 // "/api/universe"
 import express from "express";
 import fetch from "node-fetch";
+import { cache } from "../middlewares/cache";
 import { XMLParserService } from "../services/XMLParserService";
-import { CacheService } from "../services/CacheService";
 import { OGAME_API_ENDPOINTS, TEMP_SERVER_ID } from "../constants/endpoints";
 import { Universe } from "../types/api";
 
 
 export const universeRouter = express.Router();
-const cache = new CacheService();
 
-universeRouter.get("/", (req, res) => {
-
-    if(cache.has(req.originalUrl))
-        return res.json(cache.get(req.originalUrl));
+// split into galaxies? filtering by galaxies, systems, positions?
+universeRouter.get("/", cache(0), (req, res) => {
 
     const URL = OGAME_API_ENDPOINTS.universe(TEMP_SERVER_ID);
 
@@ -36,7 +33,6 @@ universeRouter.get("/", (req, res) => {
 
             return orderedJSON;
         })
-        .then(data => cache.set(req.originalUrl, data))
         .then(formatedJSON => res.json(formatedJSON))
         .catch(err => res.send(err));
 });
diff --git a/src/api/universes.ts b/src/api/universes.ts
@@ -1,19 +1,15 @@
 // "/api/universes"
 import express from "express";
 import fetch from "node-fetch";
+import { cache } from "../middlewares/cache";
 import { XMLParserService } from "../services/XMLParserService";
-import { CacheService } from "../services/CacheService";
 import { OGAME_API_ENDPOINTS, TEMP_SERVER_ID } from "../constants/endpoints";
 import { Universes } from "../types/api";
 
 
 export const universesRouter = express.Router();
-const cache = new CacheService();
 
-universesRouter.get("/", (req, res) => {
-
-    if(cache.has(req.originalUrl))
-        return res.json(cache.get(req.originalUrl));
+universesRouter.get("/", cache(0), (req, res) => {
 
     const URL = OGAME_API_ENDPOINTS.universes(TEMP_SERVER_ID);
 
@@ -29,7 +25,6 @@ universesRouter.get("/", (req, res) => {
 
             return orderedJSON;
         })
-        .then(data => cache.set(req.originalUrl, data))
         .then(formatedJSON => res.json(formatedJSON))
         .catch(err => res.send(err));
 });
diff --git a/src/middlewares/cache.ts b/src/middlewares/cache.ts
@@ -0,0 +1,23 @@
+import { RequestHandler } from "express";
+import { CacheService } from "../services/CacheService";
+
+export const cache = (durationMS: number): RequestHandler => {
+    const cache = new CacheService();
+
+    return (req, res, next) => {
+        const key = req.originalUrl || req.url;
+        const cachedData = cache.get(key);
+
+        res.type("application/json"); // fixes type coz hack
+
+        if(cachedData) return res.send(cachedData);
+
+        const sendResponse = res.send.bind(res); // ts hack to not add sendResponse (res.sendResponse)
+        res.send = (data) => {
+            cache.set(key, data); //durationMS * 1000
+            return sendResponse(data);
+        };
+
+        next();
+    };
+};
diff --git a/src/routes/api.ts b/src/routes/api.ts
@@ -0,0 +1,3 @@
+import { Router } from "express";
+
+export const api = Router();
diff --git a/src/services/CacheService.ts b/src/services/CacheService.ts
@@ -3,6 +3,7 @@ export class CacheService{
     cache: Map<string, any>
     constructor(){
         this.cache = new Map();
+        console.log("Created cache") //debug test
     }
 
     set(key: string, value: any){
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import { Router } from "express";

		export const api = Router();