http-cache tests

Author: nebarf

CONTRIBUTING.md

@@ -31,8 +31,8 @@ Contributing
 7. Link react peer deps to local library
   ```sh
   $ cd ../react-http-fetch
-  $ yarn link ../react-http-fetch-sandbox/node_modules/react
-  $ yarn link ../react-http-fetch-sandbox/node_modules/react-dom
+  $ npm link ../react-http-fetch-sandbox/node_modules/react
+  $ npm link ../react-http-fetch-sandbox/node_modules/react-dom
   ```
 8. Start library build in watch mode:
   ```sh

README.md

@@ -580,8 +580,8 @@ export class HttpSessionStorageCacheStore {
    * @inheritdoc
    */
   flush() {
-    this._keys().forEach((entry) => {
-      this.delete(entry.identifier);
+    this._keys().forEach((itemKey) => {
+      this.delete(itemKey);
     });
   }
 }

jest.config.js

@@ -19,8 +19,8 @@ module.exports = {
 
   // Test spec file resolution pattern
   // Matches parent folder `__tests__` and filename
-  // should contain `test` or `spec`.
-  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
+  // should contain `spec`.
+  testRegex: '/__tests__/.*.spec.(ts|tsx)?$',
 
   // Module file extensions for importing
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],

src/__tests__/fixtures/http-cache.fixture.ts

@@ -0,0 +1,14 @@
+import { HttpCacheService, HttpInMemoryCacheStore } from '../..';
+import { HttpCacheStorePrefixDecorator } from '../../cache/prefix-decorator';
+
+export class HttpCacheFixture {
+  static defaultStore: HttpCacheStorePrefixDecorator = new HttpCacheStorePrefixDecorator(
+    new HttpInMemoryCacheStore()
+  );
+
+  static create(store?: HttpCacheStorePrefixDecorator): HttpCacheService {
+    const fallenbackStore =
+      store || new HttpCacheStorePrefixDecorator(new HttpInMemoryCacheStore());
+    return new HttpCacheService(fallenbackStore);
+  }
+}

src/__tests__/fixtures/http-request.fixture.ts

@@ -0,0 +1,15 @@
+import { HttpMethod, HttpRequest, HttpRequestProps } from '../..';
+
+export class HttpRequestFixture {
+  static defaultOptions: HttpRequestProps = {
+    baseUrl: 'http://rhf.com',
+    method: HttpMethod.Get,
+    relativeUrl: 'comments',
+  };
+
+  static create(options?: HttpRequestProps): HttpRequest {
+    const fallenbackOptions: HttpRequestProps = options || HttpRequestFixture.defaultOptions;
+
+    return new HttpRequest(fallenbackOptions);
+  }
+}

src/__tests__/http-cache.spec.ts

@@ -0,0 +1,125 @@
+import { HttpCacheFixture } from './fixtures/http-cache.fixture';
+import { HttpRequestFixture } from './fixtures/http-request.fixture';
+
+describe('http-fetch', () => {
+  afterEach(() => {
+    jest.useRealTimers();
+  });
+
+  beforeEach(() => {
+    jest.useFakeTimers();
+    jest.spyOn(global, 'setTimeout');
+  });
+
+  test('should return undefined if no cached entry is found for the given identifier', () => {
+    const httpCache = HttpCacheFixture.create();
+    const httpRequest = HttpRequestFixture.create();
+    const cachedEntry = httpCache.get(httpRequest);
+
+    expect(cachedEntry).toBeUndefined();
+  });
+
+  test('should return the cached entry corresponding to the provided identifier', () => {
+    const httpCache = HttpCacheFixture.create();
+    const httpRequest = HttpRequestFixture.create({
+      ...HttpRequestFixture.defaultOptions,
+      maxAge: 6000,
+    });
+
+    const cachedResponse = { name: 'Phelony' };
+
+    httpCache.put(httpRequest, cachedResponse);
+    const expiredCachedResponse = httpCache.get<{ name: string }>(httpRequest);
+
+    expect(expiredCachedResponse).toEqual(cachedResponse);
+    expect(setTimeout).toHaveBeenCalledTimes(1);
+    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 6000);
+  });
+
+  test('should remove the cached entry once expired', () => {
+    const httpCache = HttpCacheFixture.create();
+    const httpRequest = HttpRequestFixture.create({
+      ...HttpRequestFixture.defaultOptions,
+      maxAge: 6000,
+    });
+
+    const httpResponse = { name: 'Phelony' };
+
+    httpCache.put(httpRequest, httpResponse);
+    const cachedResponse = httpCache.get<{ name: string }>(httpRequest);
+
+    expect(cachedResponse).toEqual(httpResponse);
+    expect(setTimeout).toHaveBeenCalledTimes(1);
+    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 6000);
+
+    jest.runOnlyPendingTimers();
+    const expiredCachedResponse = httpCache.get<{ name: string }>(httpRequest);
+    expect(expiredCachedResponse).toBeUndefined();
+  });
+
+  test('should tell if a cached response for a given request is expired', () => {
+    const httpCache = HttpCacheFixture.create();
+    const httpRequest = HttpRequestFixture.create({
+      ...HttpRequestFixture.defaultOptions,
+      maxAge: 6000,
+    });
+
+    httpCache.put(httpRequest, {});
+    expect(httpCache.isExpired(httpRequest)).toBe(false);
+
+    jest.runOnlyPendingTimers();
+    expect(httpCache.isExpired(httpRequest)).toBe(true);
+  });
+
+  test('should tell if there is a cached response for the given request', () => {
+    const httpCache = HttpCacheFixture.create();
+    const httpRequest = HttpRequestFixture.create({
+      ...HttpRequestFixture.defaultOptions,
+      maxAge: 6000,
+    });
+
+    httpCache.put(httpRequest, {});
+    expect(httpCache.has(httpRequest)).toBe(true);
+
+    jest.runOnlyPendingTimers();
+    expect(httpCache.has(httpRequest)).toBe(false);
+  });
+
+  test('should prune the cache by removing any expired entry', () => {
+    const httpCache = HttpCacheFixture.create();
+    const httpRequest = HttpRequestFixture.create({
+      ...HttpRequestFixture.defaultOptions,
+      maxAge: 6000,
+    });
+
+    httpCache.put(httpRequest, {});
+    expect(httpCache.has(httpRequest)).toBe(true);
+
+    jest.runOnlyPendingTimers();
+    expect(httpCache.has(httpRequest)).toBe(false);
+  });
+
+  test('should flush the cache by removing all entries', () => {
+    const httpCache = HttpCacheFixture.create();
+    const firstHttpRequest = HttpRequestFixture.create({
+      ...HttpRequestFixture.defaultOptions,
+      maxAge: 6000,
+      relativeUrl: 'posts',
+    });
+    const secondHttpRequest = HttpRequestFixture.create({
+      ...HttpRequestFixture.defaultOptions,
+      maxAge: 6000,
+      relativeUrl: 'comments',
+    });
+
+    httpCache.put(firstHttpRequest, {});
+    httpCache.put(secondHttpRequest, {});
+
+    expect(httpCache.has(firstHttpRequest)).toBe(true);
+    expect(httpCache.has(secondHttpRequest)).toBe(true);
+
+    httpCache.flush();
+    expect(httpCache.has(firstHttpRequest)).toBe(false);
+    expect(httpCache.has(secondHttpRequest)).toBe(false);
+  });
+});

src/__tests__/index.spec.ts renamed to src/__tests__/http-client-config-provider.spec.ts

@@ -0,0 +1,5 @@
+describe('', () => {
+  test('', () => {
+    expect(1).toBe(1);
+  });
+});

src/__tests__/use-http-client.spec.ts

@@ -0,0 +1,5 @@
+describe('', () => {
+  test('', () => {
+    expect(1).toBe(1);
+  });
+});

src/__tests__/use-http-delete.spec.ts

@@ -0,0 +1,5 @@
+describe('', () => {
+  test('', () => {
+    expect(1).toBe(1);
+  });
+});