chore(commons): extract lru-cache into commons (#2899)

aws-powertools · Aug 7, 2024 · b064408 · b064408
1 parent a9d4a9c
commit b064408
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 9 deletions.
diff --git a/packages/commons/package.json b/packages/commons/package.json
@@ -45,6 +45,10 @@
       "import": "./lib/esm/fromBase64.js",
       "require": "./lib/cjs/fromBase64.js"
     },
+    "./utils/lru-cache": {
+      "import": "./lib/esm/LRUCache.js",
+      "require": "./lib/cjs/LRUCache.js"
+    },
     "./types": {
       "import": "./lib/esm/types/index.js",
       "require": "./lib/cjs/types/index.js"
@@ -60,6 +64,10 @@
         "lib/cjs/fromBase64.d.ts",
         "lib/esm/fromBase64.d.ts"
       ],
+      "utils/lru-cache": [
+        "lib/cjs/LRUCache.d.ts",
+        "lib/esm/LRUCache.d.ts"
+      ],
       "types": [
         "lib/cjs/types/index.d.ts",
         "lib/esm/types/index.d.ts"
@@ -88,4 +96,4 @@
   "devDependencies": {
     "@aws-lambda-powertools/testing-utils": "file:../testing"
   }
-}
+}
diff --git a/...s/idempotency/src/persistence/LRUCache.ts → packages/commons/src/LRUCache.ts b/...s/idempotency/src/persistence/LRUCache.ts → packages/commons/src/LRUCache.ts
@@ -1,4 +1,4 @@
-import type { LRUCacheOptions } from '../types/LRUCache.js';
+import type { LRUCacheOptions } from './types/LRUCache.js';
 
 const DEFAULT_MAX_SIZE = 100;
 const NEWER = Symbol('newer');
@@ -213,7 +213,7 @@ class LRUCache<K, V> {
    */
   private trackItemUse(item: Item<K, V>): void {
     // If the item is already the newest, we don't need to do anything
-    if (this.mostRecentlyUsed === item) return; // TODO: check this
+    if (this.mostRecentlyUsed === item) return;
 
     // If the item is not the newest, we need to mark it as the newest
     if (item[NEWER]) {

diff --git a/packages/idempotency/src/types/LRUCache.ts → packages/commons/src/types/LRUCache.ts b/packages/idempotency/src/types/LRUCache.ts → packages/commons/src/types/LRUCache.ts
diff --git a/...y/tests/unit/persistence/LRUCache.test.ts → packages/commons/tests/unit/LRUCache.test.ts b/...y/tests/unit/persistence/LRUCache.test.ts → packages/commons/tests/unit/LRUCache.test.ts
@@ -1,9 +1,9 @@
 /**
  * Test LRUCache class
  *
- * @group unit/idempotency/persistence/lru-cache
+ * @group unit/commons/lru-cache
  */
-import { LRUCache } from '../../../src/persistence/LRUCache.js';
+import { LRUCache } from '../../src/LRUCache.js';
 
 describe('Class: LRUMap', () => {
   describe('Method: add', () => {

diff --git a/packages/commons/typedoc.json b/packages/commons/typedoc.json
@@ -1,5 +1,13 @@
 {
-  "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["./src/index.ts", "./src/types/index.ts"],
+  "extends": [
+    "../../typedoc.base.json"
+  ],
+  "entryPoints": [
+    "./src/index.ts",
+    "./src/types/index.ts",
+    "./src/typeUtils.ts",
+    "./src/fromBase64.ts",
+    "./src/LRUCache.ts"
+  ],
   "readme": "./README.md"
-}
+}
diff --git a/packages/idempotency/src/persistence/BasePersistenceLayer.ts b/packages/idempotency/src/persistence/BasePersistenceLayer.ts
@@ -1,5 +1,6 @@
 import { type Hash, createHash } from 'node:crypto';
 import type { JSONValue } from '@aws-lambda-powertools/commons/types';
+import { LRUCache } from '@aws-lambda-powertools/commons/utils/lru-cache';
 import { search } from '@aws-lambda-powertools/jmespath';
 import type { JMESPathParsingOptions } from '@aws-lambda-powertools/jmespath/types';
 import { EnvironmentVariablesService } from '../config/EnvironmentVariablesService.js';
@@ -15,7 +16,6 @@ import type {
   BasePersistenceLayerOptions,
 } from '../types/BasePersistenceLayer.js';
 import { IdempotencyRecord } from './IdempotencyRecord.js';
-import { LRUCache } from './LRUCache.js';
 
 /**
  * Base class for all persistence layers. This class provides the basic functionality for