feat: customizable cache implementation (#2527)

* customizable cache implementation * remove console * jsdoc * lint * review remarks * public api check * Cache methods return promise * rename interface * lint * new destination interface * update jsdoc + other fixes * review remarks * review remarks * remove generic because we initialize with the DefaultCacheType so varialbe would be CacheType<any> and then you can leave it out. * add chagelog Co-authored-by: d068544 <[email protected]>
SAP · Jun 15, 2022 · 0909460 · 0909460
1 parent ffeeb94
commit 0909460
Show file tree

Hide file tree

Showing 14 changed files with 347 additions and 153 deletions.
diff --git a/.changeset/long-tables-yawn.md b/.changeset/long-tables-yawn.md
@@ -0,0 +1,5 @@
+---
+'@sap-cloud-sdk/connectivity': minor
+---
+
+[New Functionality] Add interface `DestinationCacheInterface` and method `setDestinationCache` to support implementation of custom destination cache.
diff --git a/packages/connectivity/src/index.ts b/packages/connectivity/src/index.ts
@@ -8,6 +8,8 @@ export {
   parseDestination,
   toDestinationNameUrl,
   sanitizeDestination,
+  DestinationCacheInterface,
+  CacheEntry,
   CachingOptions,
   getDestination,
   useOrFetchDestination,
@@ -35,7 +37,8 @@ export {
   buildHeadersForDestination,
   getClientCredentialsToken,
   getUserToken,
-  registerDestination
+  registerDestination,
+  setDestinationCache
 } from './scp-cf';
 
 export type {

diff --git a/packages/connectivity/src/scp-cf/cache.spec.ts b/packages/connectivity/src/scp-cf/cache.spec.ts
@@ -27,27 +27,26 @@ const cacheOne = new Cache<Destination>({ hours: 0, minutes: 5, seconds: 0 });
 const cacheTwo = new Cache<ClientCredentialsResponse>();
 
 describe('Cache', () => {
-  afterEach(() => {
+  afterEach(async () => {
     cacheOne.clear();
     cacheTwo.clear();
-    destinationCache.clear();
+    await destinationCache.clear();
     clientCredentialsTokenCache.clear();
   });
 
-  it('non-existing item in cache should return undefined', () => {
-    const actual = cacheOne.get('notExistingDest');
-    expect(actual).toBeUndefined();
+  it('non-existing item in cache should return undefined', async () => {
+    expect(cacheOne.get('notExistingDest')).toBeUndefined();
   });
 
   it('item should be retrieved correctly', () => {
-    cacheOne.set('one', destinationOne);
+    cacheOne.set('one', { entry: destinationOne });
     const actual = cacheOne.get('one');
     expect(actual).toEqual(destinationOne);
   });
 
   it('retrieving expired item should return undefined', () => {
     jest.useFakeTimers('modern');
-    cacheOne.set('one', destinationOne);
+    cacheOne.set('one', { entry: destinationOne });
 
     const minutesToExpire = 6;
     // Shift time to expire the set item
@@ -56,7 +55,7 @@ describe('Cache', () => {
   });
 
   it('clear() should remove all entries in cache', () => {
-    cacheOne.set('one', destinationOne);
+    cacheOne.set('one', { entry: destinationOne });
     cacheOne.clear();
     expect(cacheOne.hasKey('one')).toBeFalsy();
   });
@@ -69,7 +68,7 @@ describe('Cache', () => {
       jti: '',
       scope: ''
     };
-    cacheTwo.set('someToken', dummyToken);
+    cacheTwo.set('someToken', { entry: dummyToken });
     expect(cacheTwo.get('someToken')).toEqual(dummyToken);
   });
 
@@ -81,14 +80,17 @@ describe('Cache', () => {
       jti: '',
       scope: ''
     };
-    cacheTwo.set('expiredToken', dummyToken, 10);
-    cacheTwo.set('validToken', dummyToken, Date.now() + 5000);
+    cacheTwo.set('expiredToken', { entry: dummyToken, expires: 10 });
+    cacheTwo.set('validToken', {
+      entry: dummyToken,
+      expires: Date.now() + 5000
+    });
     expect(cacheTwo.get('expiredToken')).toBeUndefined();
     expect(cacheTwo.get('validToken')).toBe(dummyToken);
   });
 
   it('should not hit cache for undefined key', () => {
-    cacheOne.set(undefined, {} as Destination);
+    cacheOne.set(undefined, { entry: {} as Destination });
     const actual = cacheOne.get(undefined);
     expect(actual).toBeUndefined();
   });

diff --git a/packages/connectivity/src/scp-cf/cache.ts b/packages/connectivity/src/scp-cf/cache.ts
@@ -1,18 +1,22 @@
 interface CacheInterface<T> {
   hasKey(key: string): boolean;
-  get(key: string): T | undefined;
-  set(key: string, item: T, expirationTime?: number): void;
+  get(key: string | undefined): T | undefined;
+  set(key: string | undefined, item: CacheEntry<T>): void;
+  clear(): void;
 }
 
-interface DateInputObject {
+/**
+ * @internal
+ */
+export interface DateInputObject {
   hours?: number;
   minutes?: number;
   seconds?: number;
   milliseconds?: number;
 }
 
 /**
- * @internal
+ * Respresentation of a cached object.
  */
 export interface CacheEntry<T> {
   expires?: number;
@@ -81,15 +85,13 @@ export class Cache<T> implements CacheInterface<T> {
   /**
    * Setter of entries in cache.
    * @param key - The entry's key.
-   * @param entry - The entry to cache.
-   * @param expirationTime - The time expressed in UTC in which the given entry expires.
+   * @param item - The entry to cache.
    */
-  set(key: string | undefined, entry: T, expirationTime?: number): void {
+  set(key: string | undefined, item: CacheEntry<T>): void {
     if (key) {
-      const expires = expirationTime
-        ? expirationTime
-        : inferExpirationTime(this.defaultValidityTime);
-      this.cache[key] = { entry, expires };
+      const expires =
+        item.expires ?? inferExpirationTime(this.defaultValidityTime);
+      this.cache[key] = { entry: item.entry, expires };
     }
   }
 }

diff --git a/packages/connectivity/src/scp-cf/client-credentials-token-cache.ts b/packages/connectivity/src/scp-cf/client-credentials-token-cache.ts
@@ -18,11 +18,12 @@ const ClientCredentialsTokenCache = (
     clientId: string,
     token: ClientCredentialsResponse
   ): void => {
-    cache.set(
-      getCacheKey(url, clientId),
-      token,
-      token.expires_in ? Date.now() + token.expires_in * 1000 : undefined
-    );
+    cache.set(getCacheKey(url, clientId), {
+      entry: token,
+      expires: token.expires_in
+        ? Date.now() + token.expires_in * 1000
+        : undefined
+    });
   },
   clear: (): void => {
     cache.clear();

diff --git a/...ages/connectivity/src/scp-cf/destination/destination-accessor-loading-precendence.spec.ts b/...ages/connectivity/src/scp-cf/destination/destination-accessor-loading-precendence.spec.ts
@@ -83,7 +83,7 @@ describe('destination loading precedence', () => {
 
   it('retrieves service binding destinations third', async () => {
     delete process.env['destinations'];
-    registerDestinationCache.clear();
+    await registerDestinationCache.clear();
     const actual = await getDestination({
       destinationName
     });
@@ -92,7 +92,7 @@ describe('destination loading precedence', () => {
 
   it('retrieves destinations from destination-service last', async () => {
     delete process.env['destinations'];
-    registerDestinationCache.clear();
+    await registerDestinationCache.clear();
     mockServiceBindings();
 
     await expect(

diff --git a/packages/connectivity/src/scp-cf/destination/destination-accessor.ts b/packages/connectivity/src/scp-cf/destination/destination-accessor.ts
@@ -45,7 +45,7 @@ export async function getDestination(
 ): Promise<Destination | null> {
   return (
     searchEnvVariablesForDestination(options) ||
-    searchRegisteredDestination(options) ||
+    (await searchRegisteredDestination(options)) ||
     searchServiceBindingForDestination(options.destinationName) ||
     getDestinationFromDestinationService(options)
   );