Implement LRU cache for property filters

.tool-versions

@@ -0,0 +1 @@
+nodejs 16.20.0

packages/property/README.md

@@ -31,6 +31,8 @@ const pvs1valid = PropertyFilter.isValid(pvs1, pf); // false
 const pvs2valid = PropertyFilter.isValid(pvs2, pf); // true
 ```
 
+The library uses an LRU (Least Recently Used) cache to improve performance. The size of this cache is controlled by the `process.env.PROPERTY_FILTER_CACHE_SIZE` environment variable on node. By default the LRU cache can store up to 20000 items.
+
 [version-image]: https://img.shields.io/npm/v/@promaster-sdk/property.svg?style=flat
 [version-url]: https://www.npmjs.com/package/@promaster-sdk/property
 [prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat

packages/property/package.json

@@ -21,6 +21,7 @@
     "promaster-sdk"
   ],
   "dependencies": {
+    "lru-cache": "^7.18.3",
     "uom": "^6.0.0"
   }
 }

packages/property/src/property-filter.ts

@@ -1,4 +1,5 @@
 import { UnitMap } from "uom";
+import LRUCache from "lru-cache";
 import * as PropertyValueSet from "./property-value-set";
 import * as PropertyValue from "./property-value";
 import * as Ast from "./property-filter-ast/index";
@@ -9,7 +10,14 @@ export interface PropertyFilter {
   readonly _evaluate: Ast.CompiledFilterFunction;
 }
 
-const _cache: { [key: string]: PropertyFilter } = {}; //eslint-disable-line
+const maxLRUCacheSize = globalThis.process?.env?.PROPERTY_FILTER_CACHE_SIZE
+  ? Number(process.env.PROPERTY_FILTER_CACHE_SIZE)
+  : 20000;
+
+const LRUCacheOptions = {
+  max: maxLRUCacheSize, // Arbitrary number. Uses on average up to 400mb
+};
+const _cache = new LRUCache<string, PropertyFilter>(LRUCacheOptions);
 
 export const Empty: PropertyFilter = {
   text: "",
@@ -25,8 +33,7 @@ export function fromString(filter: string, unitLookup: UnitMap.UnitLookup): Prop
   if (filter === null || filter === undefined) {
     throw new Error("Argument 'filter' must be defined.");
   }
-  // eslint-disable-next-line no-prototype-builtins
-  if (!_cache.hasOwnProperty(filter)) {
+  if (!_cache.has(filter)) {
     if (filter === "" || filter.trim().length === 0) {
       return Empty;
     }
@@ -36,9 +43,10 @@ export function fromString(filter: string, unitLookup: UnitMap.UnitLookup): Prop
       console.warn("Invalid property filter syntax: " + filter);
       return undefined;
     }
-    _cache[filter] = create(filter, ast);
+    _cache.set(filter, create(filter, ast));
   }
-  return _cache[filter];
+
+  return _cache.get(filter);
 }
 
 export function fromStringOrEmpty(filterString: string, unitLookup: UnitMap.UnitLookup): PropertyFilter {

packages/react-property-selectors/src/__tests__/properties-selector/discrete-select-test-component.tsx

@@ -7,6 +7,8 @@ import {
 } from "../../discrete/use-discrete-property-selector";
 import { usePropertiesSelector, UsePropertiesSelectorOptions } from "../../properties-selector/use-properties-selector";
 
+const unitLookup: UnitMap.UnitLookup = (unitString) => (BaseUnits as UnitMap.UnitMap)[unitString];
+
 type PropertyValueDef = {
   readonly sortNo: number;
   readonly value: PropertyValue.PropertyValue | undefined | null;
@@ -84,8 +86,6 @@ function getExampleProductProperties(): {
 }
 const propInfo = getExampleProductProperties();
 
-const unitLookup: UnitMap.UnitLookup = (unitString) => (BaseUnits as UnitMap.UnitMap)[unitString];
-
 type UnitLabels = {
   readonly [unitName: string]: string;
 };

packages/tsconfig.settings.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     // From the lern-a
-    "target": "es5",
+    "target": "es6",
     "module": "commonjs",
     "declaration": true,
     "declarationMap": true,

yarn.lock

@@ -10972,6 +10972,11 @@ lru-cache@^6.0.0:
   dependencies:
     yallist "^4.0.0"
 
+lru-cache@^7.18.3:
+  version "7.18.3"
+  resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-7.18.3.tgz#f793896e0fd0e954a59dfdd82f0773808df6aa89"
+  integrity sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==
+
 lz-string@^1.4.4:
   version "1.4.4"
   resolved "https://registry.yarnpkg.com/lz-string/-/lz-string-1.4.4.tgz#c0d8eaf36059f705796e1e344811cf4c498d3a26"