chore: keepAliveTimeoutCache changed to timeFrameTimeoutCache (#14)

* chore: keepAliveTimeoutCache changed to timeFrameTimeoutCache Co-authored-by: Carmelo Badalamenti <[email protected]>
JointlyTech · Jan 16, 2023 · 821ffe8 · 821ffe8
1 parent 9a57d94
commit 821ffe8
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 32 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -49,7 +49,8 @@
     "prettier": "^2.8.1",
     "rimraf": "^3.0.2",
     "ts-jest": "^29.0.3",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.4",
+    "@jointly/cache-candidate-plugin-base": "^1.0.0"
   },
   "lint-staged": {
     "src/**/*.{js,jsx,ts,tsx}": [
@@ -64,7 +65,6 @@
   "license": "MIT",
   "author": "Jointly <[email protected]>",
   "dependencies": {
-    "@jointly/cache-candidate-plugin-base": "^1.0.0",
     "hook-fn": "^1.0.3"
   }
 }
diff --git a/src/internal.ts b/src/internal.ts
@@ -4,7 +4,7 @@ import {
   CacheCandidateOptions,
   DataCacheRecordNotFound,
   Events,
-  KeepAliveCache,
+  TimeFrameTimeoutCache,
   RunningQueryCache,
   RunningQueryRecordNotFound,
   TimeFrameCache
@@ -123,7 +123,7 @@ async function handleResult({
   executionStart,
   options,
   timeframeCache,
-  keepAliveTimeoutCache,
+  timeFrameTimeoutCache,
   args,
   HookPayload
 }: {
@@ -133,7 +133,7 @@ async function handleResult({
   executionStart: number;
   options: CacheCandidateOptions;
   timeframeCache: TimeFrameCache;
-  keepAliveTimeoutCache: KeepAliveCache;
+  timeFrameTimeoutCache: TimeFrameTimeoutCache;
   args: any[];
   HookPayload: PluginPayload;
 }): Promise<void> {
@@ -173,7 +173,7 @@ async function handleResult({
       })
       .finally(() => {
         runningQueryCache.delete(key);
-        keepAliveTimeoutCache.set(
+        timeFrameTimeoutCache.set(
           key,
           setTimeout(() => {
             deleteDataCacheRecord({ options, key, HookPayload });
@@ -245,17 +245,17 @@ function getExceedingAmountFromCandidateFunction(
     exceedingAmount = options.requestsThreshold;
   return exceedingAmount;
 }
-function refreshKeepAliveRecord({
-  keepAliveTimeoutCache,
+function refreshTimeframeTimeoutCacheRecord({
+  timeFrameTimeoutCache,
   key,
   options
 }: {
-  keepAliveTimeoutCache: KeepAliveCache;
+  timeFrameTimeoutCache: TimeFrameTimeoutCache;
   key: string;
   options: CacheCandidateOptions;
 }) {
-  clearTimeout(keepAliveTimeoutCache.get(key));
-  keepAliveTimeoutCache.set(
+  clearTimeout(timeFrameTimeoutCache.get(key));
+  timeFrameTimeoutCache.set(
     key,
     setTimeout(() => {
       options.cache.delete(key);
@@ -272,15 +272,15 @@ export function uniqid(length = 10) {
 export async function letsCandidate({
   options,
   key,
-  keepAliveTimeoutCache,
+  timeFrameTimeoutCache,
   runningQueryCache,
   timeframeCache,
   args,
   originalMethod
 }: {
   options: CacheCandidateOptions;
   key: string;
-  keepAliveTimeoutCache: KeepAliveCache;
+  timeFrameTimeoutCache: TimeFrameTimeoutCache;
   runningQueryCache: RunningQueryCache;
   timeframeCache: TimeFrameCache;
   args: any[];
@@ -289,7 +289,7 @@ export async function letsCandidate({
   const HookPayload = {
     options: { ...options, plugins: undefined },
     key,
-    keepAliveTimeoutCache,
+    timeFrameTimeoutCache,
     runningQueryCache,
     timeframeCache,
     fnArgs: args
@@ -299,8 +299,8 @@ export async function letsCandidate({
   const cachedData = await getDataCacheRecord({ options, key, HookPayload });
   if (cachedData !== DataCacheRecordNotFound) {
     if (options.keepAlive) {
-      refreshKeepAliveRecord({
-        keepAliveTimeoutCache,
+      refreshTimeframeTimeoutCacheRecord({
+        timeFrameTimeoutCache,
         key,
         options
       });
@@ -351,7 +351,7 @@ export async function letsCandidate({
       executionStart,
       options,
       timeframeCache,
-      keepAliveTimeoutCache,
+      timeFrameTimeoutCache,
       args,
       HookPayload
     });
@@ -367,7 +367,7 @@ export async function letsCandidate({
       executionStart,
       options,
       timeframeCache,
-      keepAliveTimeoutCache,
+      timeFrameTimeoutCache,
       args,
       HookPayload
     })
@@ -386,7 +386,7 @@ export function getInitialState(_options: Partial<CacheCandidateOptions>) {
   // Generate a uniqid
   const uniqueIdentifier = uniqid();
 
-  const keepAliveTimeoutCache: KeepAliveCache = new Map();
+  const timeFrameTimeoutCache: TimeFrameTimeoutCache = new Map();
 
   const options: CacheCandidateOptions = {
     ...CacheCandidateOptionsDefault,
@@ -397,7 +397,7 @@ export function getInitialState(_options: Partial<CacheCandidateOptions>) {
     timeframeCache,
     runningQueryCache,
     uniqueIdentifier,
-    keepAliveTimeoutCache,
+    timeFrameTimeoutCache,
     options
   };
 }
diff --git a/src/lib.ts b/src/lib.ts
@@ -7,7 +7,7 @@ export function CacheCandidate(_options: Partial<CacheCandidateOptions> = {}) {
     timeframeCache,
     runningQueryCache,
     uniqueIdentifier,
-    keepAliveTimeoutCache,
+    timeFrameTimeoutCache,
     options
   } = getInitialState(_options);
 
@@ -32,7 +32,7 @@ export function CacheCandidate(_options: Partial<CacheCandidateOptions> = {}) {
       return letsCandidate({
         options,
         key: dataCacheKey,
-        keepAliveTimeoutCache,
+        timeFrameTimeoutCache,
         runningQueryCache,
         timeframeCache,
         args,
@@ -50,15 +50,15 @@ export function cacheCandidate(
     timeframeCache,
     runningQueryCache,
     uniqueIdentifier,
-    keepAliveTimeoutCache,
+    timeFrameTimeoutCache,
     options
   } = getInitialState(_options);
 
   return async (...args: any[]) =>
     letsCandidate({
       options,
       key: getDataCacheKey([uniqueIdentifier, JSON.stringify(args)]),
-      keepAliveTimeoutCache,
+      timeFrameTimeoutCache,
       runningQueryCache,
       timeframeCache,
       args,

diff --git a/src/models.ts b/src/models.ts
@@ -49,7 +49,7 @@ export interface TimeFrameCacheRecord {
 
 export type TimeFrameCache = Map<string, Array<TimeFrameCacheRecord>>;
 export type RunningQueryCache = Map<string, Promise<any>>;
-export type KeepAliveCache = Map<string, NodeJS.Timeout>;
+export type TimeFrameTimeoutCache = Map<string, NodeJS.Timeout>;
 
 export enum Events {
   RUNNING_QUERY = 'RUNNING_QUERY',