Feature: Support no-cache requests (#21)

* code cleanup * require url * no mjml * code cleanup * fixed tests, rm sinon, ported mocks to jest * port chai assert -> jest expect * bump dependencies * renamed client.server -> client.connection * prettier code-style * skip cache is $nocache is specified in requestData
swellstores · Sep 18, 2023 · b7dd15c · b7dd15c
1 parent 68f20b2
commit b7dd15c
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 1 deletion.
diff --git a/lib/client.js b/lib/client.js
@@ -283,7 +283,10 @@ class Client extends EventEmitter {
       });
     }
 
-    if (this.cache && this.sentVersions) {
+    // Indicates whether to check the request cache or not
+    const isRequestCacheable = data?.$nocache === undefined;
+
+    if (this.cache && this.sentVersions && isRequestCacheable) {
       const cacheResult = this.cache.get(url, data);
       if (cacheResult?.$data !== undefined) {
         return new Promise((resolve) => {

diff --git a/lib/client.test.js b/lib/client.test.js
@@ -556,6 +556,7 @@ describe('Client', () => {
         client.authed = true;
         client.sentVersions = true;
 
+        // simulate a cache hit
         getCacheStub = jest
           .spyOn(Cache.prototype, 'get')
           .mockImplementation(() => {
@@ -586,6 +587,42 @@ describe('Client', () => {
         expect(response).toEqual(returnValue);
         expect(headers).toEqual({ $data: returnValue });
       });
+
+      it('returns the cached response on cache hit', async () => {
+        const result = await client.get('url', 'data');
+
+        expect(result).toEqual(returnValue);
+        expect(getCacheStub).toHaveBeenCalledTimes(1);
+        expect(getCacheStub).toHaveBeenCalledWith('url', 'data');
+        expect(requestStub).not.toHaveBeenCalled();
+      });
+
+      it('sends a request on cache miss', async () => {
+        // simulate a cache miss
+        getCacheStub.mockImplementationOnce(() => {
+          return null;
+        });
+
+        await client.get('url', 'data');
+
+        expect(getCacheStub).toHaveBeenCalledTimes(1);
+        expect(getCacheStub).toHaveBeenCalledWith('url', 'data');
+        expect(requestStub).toHaveBeenCalledTimes(1);
+        expect(requestStub).toHaveBeenCalledWith('get', 'url', 'data', undefined);
+      });
+
+      it('skips the cache if $nocache is specified', async () => {
+        await client.get('url', { $nocache: true });
+
+        expect(getCacheStub).not.toHaveBeenCalled();
+        expect(requestStub).toHaveBeenCalledTimes(1);
+        expect(requestStub).toHaveBeenCalledWith(
+          'get',
+          'url',
+          { $nocache: true },
+          undefined
+        );
+      });
     });
   });