chore: add tests for useProxyCache middleware

src/aws.ts

@@ -42,3 +42,14 @@ export async function get(key) {
     return false;
   }
 }
+
+export async function remove(key) {
+  try {
+    return await client.deleteObject({
+      Bucket: process.env.AWS_BUCKET_NAME,
+      Key: `public/${dir}/${key}`
+    });
+  } catch (e: any) {
+    return false;
+  }
+}

src/middlewares/useProxyCache.ts

@@ -2,8 +2,16 @@ import { capture } from '@snapshot-labs/snapshot-sentry';
 import { sha256, MAX } from '../utils';
 import { get, set } from '../aws';
 
+export function cacheKey(key: string) {
+  return sha256(key);
+}
+
+/**
+ * This middleware serves a cache if it exists, else it will process the controller
+ * and caches its results if it's less than 1MB
+ */
 export default async function useProxyCache(req, res, next) {
-  const key = sha256(req.originalUrl);
+  const key = cacheKey(req.originalUrl);
 
   const cache = await get(`cache/${key}`);
   if (cache) {

test/e2e/proxy.test.ts

@@ -1,16 +1,42 @@
 import request from 'supertest';
+import { cacheKey } from '../../src/middlewares/useProxyCache';
+import { set, get, remove } from '../../src/aws';
 
 const HOST = `http://localhost:${process.env.PORT || 3003}`;
 
 describe('GET /ipfs/*', () => {
   describe('when the IPFS cid exists', () => {
-    it('returns the JSON file', async () => {
-      const response = await request(HOST).get(
-        '/ipfs/bafkreib5epjzumf3omr7rth5mtcsz4ugcoh3ut4d46hx5xhwm4b3pqr2vi'
-      );
+    const path = '/ipfs/bafkreib5epjzumf3omr7rth5mtcsz4ugcoh3ut4d46hx5xhwm4b3pqr2vi';
+    const content = { status: 'OK' };
+    const key = `cache/${cacheKey(path)}`;
 
-      expect(response.statusCode).toBe(200);
-      expect(response.body).toEqual({ status: 'OK' });
+    afterEach(async () => {
+      await remove(key);
+    });
+
+    describe('when the file is cached', () => {
+      const cachedContent = { status: 'CACHED' };
+
+      it('returns the cache file', async () => {
+        await set(key, cachedContent);
+        const response = await request(HOST).get(path);
+
+        expect(response.body).toEqual(cachedContent);
+        expect(response.statusCode).toBe(200);
+        expect(response.headers['content-type']).toBe('application/json; charset=utf-8');
+        expect(await get(key)).toEqual(cachedContent);
+      });
+    });
+
+    describe('when the file is not cached', () => {
+      it('returns the file and caches it', async () => {
+        const response = await request(HOST).get(path);
+
+        expect(response.body).toEqual(content);
+        expect(response.statusCode).toBe(200);
+        expect(response.headers['content-type']).toBe('application/json; charset=utf-8');
+        expect(await get(key)).toEqual(response.body);
+      });
     });
   });