comments

Author: matus.hudec

src/httpClient/redisStorage.ts

@@ -3,31 +3,39 @@ import type { StorageValue } from 'axios-cache-interceptor';
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { createClient } from 'redis';
 
-const keyPrefix = 'axios-cache-';
+const KEY_PREFIX = 'axios-cache-';
+
+const MIN_TTL = 60000;
 
 export default function createRedisStorage(client: ReturnType<typeof createClient>) {
   // source https://axios-cache-interceptor.js.org/guide/storages#node-redis-storage
   return buildStorage({
     async find(key) {
-      const result = await client.get(`${keyPrefix}${key}`);
+      const result = await client.get(`${KEY_PREFIX}${key}`);
       return result ? (JSON.parse(result) as StorageValue) : undefined;
     },
 
     // eslint-disable-next-line complexity
     async set(key, value, req) {
-      await client.set(`${keyPrefix}${key}`, JSON.stringify(value), {
+      await client.set(`${KEY_PREFIX}${key}`, JSON.stringify(value), {
         PXAT:
+          // We don't want to keep indefinitely values in the storage if
+          // their request don't finish somehow. Either set its value as
+          // the TTL or 1 minute (MIN_TTL).
           value.state === 'loading'
-            ? Date.now() + (req?.cache && typeof req.cache.ttl === 'number' ? req.cache.ttl : 60000)
+            ? Date.now() +
+              (req?.cache && typeof req.cache.ttl === 'number' ? req.cache.ttl : MIN_TTL)
             : (value.state === 'stale' && value.ttl) ||
               (value.state === 'cached' && !canStale(value))
             ? value.createdAt + value.ttl!
-            : undefined,
+            : // otherwise, we can't determine when it should expire, so we keep
+              //   it indefinitely.
+              undefined,
       });
     },
 
     async remove(key) {
-      await client.del(`${keyPrefix}${key}`);
+      await client.del(`${KEY_PREFIX}${key}`);
     },
   });
 }

src/logger/logger.ts

@@ -5,9 +5,9 @@ import stringify from 'fast-safe-stringify';
 import isError from 'is-error';
 import { redactSecret } from '../util';
 
-const defaultPayloadLimit = 32768;
+const DEFAULT_PAYLOAD_LIMIT = 32768;
 
-const minPayloadLimit = 10000;
+const MIN_PAYLOAD_LIMIT = 10000;
 
 export default class Logger {
   public invocationId: string;
@@ -24,9 +24,9 @@ export default class Logger {
     this.logFunction = configuration?.logFunction ?? console.log;
     this.jsonSpace = configuration?.jsonSpace ?? 2;
     this.payloadLimit = !configuration?.payloadLimit
-      ? defaultPayloadLimit
-      : configuration?.payloadLimit < minPayloadLimit
-      ? minPayloadLimit
+      ? DEFAULT_PAYLOAD_LIMIT
+      : configuration?.payloadLimit < MIN_PAYLOAD_LIMIT
+      ? MIN_PAYLOAD_LIMIT
       : configuration.payloadLimit;
 
     this.invocationId = 'none';