perf: replace Map with WeakMap for better memory management (#1057)

Author: Rel1cx

packages/plugins/eslint-plugin-react-hooks-extra/src/hooks/use-no-direct-set-state-in-use-effect.ts

@@ -59,10 +59,10 @@ export function useNoDirectSetStateInUseEffect<Ctx extends RuleContext>(
   const setupFunctionIdentifiers: TSESTree.Identifier[] = [];
 
   const indFunctionCalls: TSESTree.CallExpression[] = [];
-  const indSetStateCalls = new Map<AST.TSESTreeFunction, TSESTree.CallExpression[]>();
-  const indSetStateCallsInUseEffectArg0 = new Map<TSESTree.CallExpression, TSESTree.Identifier[]>();
+  const indSetStateCalls = new WeakMap<AST.TSESTreeFunction, TSESTree.CallExpression[]>();
+  const indSetStateCallsInUseEffectArg0 = new WeakMap<TSESTree.CallExpression, TSESTree.Identifier[]>();
   const indSetStateCallsInUseEffectSetup = new Map<TSESTree.CallExpression, TSESTree.Identifier[]>();
-  const indSetStateCallsInUseMemoOrCallback = new Map<TSESTree.Node, TSESTree.CallExpression[]>();
+  const indSetStateCallsInUseMemoOrCallback = new WeakMap<TSESTree.Node, TSESTree.CallExpression[]>();
 
   const onSetupFunctionEnter = (node: AST.TSESTreeFunction) => {
     setupFunctionRef.current = node;

packages/plugins/eslint-plugin-react-x/src/rules/no-duplicate-key.ts

@@ -40,7 +40,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
   if (!context.sourceCode.getText().includes("key=")) {
     return {};
   }
-  const keyedEntries: Map<TSESTree.Node, KeyedEntry> = new Map();
+  const keyedEntries = new Map<TSESTree.Node, KeyedEntry>();
   function isKeyValueEqual(
     a: TSESTree.JSXAttribute,
     b: TSESTree.JSXAttribute,

packages/plugins/eslint-plugin-react-x/src/rules/no-unstable-context-value.ts

@@ -40,7 +40,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
   const { version } = getSettingsFromContext(context);
   const isReact18OrBelow = compare(version, "19.0.0", "<");
   const { ctx, listeners } = ER.useComponentCollector(context);
-  const constructions = new Map<AST.TSESTreeFunction, VAR.Construction[]>();
+  const constructions = new WeakMap<AST.TSESTreeFunction, VAR.Construction[]>();
 
   return {
     ...listeners,

packages/plugins/eslint-plugin-react-x/src/rules/no-unstable-default-props.ts

@@ -37,7 +37,7 @@ export default createRule<[], MessageID>({
 
 export function create(context: RuleContext<MessageID, []>): RuleListener {
   const { ctx, listeners } = ER.useComponentCollector(context);
-  const declarators = new Map<
+  const declarators = new WeakMap<
     AST.TSESTreeFunction,
     SEL.ObjectDestructuringVariableDeclarator[]
   >();

packages/utilities/eff/docs/functions/getOrUpdate.md

@@ -6,41 +6,85 @@
 
 # Function: getOrUpdate()
 
+## Call Signature
+
+> **getOrUpdate**\<`K`, `V`\>(`map`, `key`, `callback`): `V`
+
+Retrieves a value from a Map or WeakMap if the key exists, or computes and stores a new value if it doesn't.
+
+### Type Parameters
+
+#### K
+
+`K` *extends* `WeakKey`
+
+#### V
+
+`V`
+
+### Parameters
+
+#### map
+
+[`WeakMap`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakMap)\<`K`, `V`\>
+
+The Map or WeakMap to get from or update
+
+#### key
+
+`K`
+
+The key to look up in the Map or WeakMap
+
+#### callback
+
+() => `V`
+
+The function to call to generate a new value if the key doesn't exist
+
+### Returns
+
+`V`
+
+The existing value for the key, or the newly computed value
+
+## Call Signature
+
 > **getOrUpdate**\<`K`, `V`\>(`map`, `key`, `callback`): `V`
 
-Retrieves a value from a Map if the key exists, or computes and stores a new value if it doesn't.
+Retrieves a value from a Map or WeakMap if the key exists, or computes and stores a new value if it doesn't.
 
-## Type Parameters
+### Type Parameters
 
-### K
+#### K
 
 `K`
 
-### V
+#### V
 
 `V`
 
-## Parameters
+### Parameters
 
-### map
+#### map
 
 [`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)\<`K`, `V`\>
 
-The Map to get from or update
+The Map or WeakMap to get from or update
 
-### key
+#### key
 
 `K`
 
-The key to look up in the Map
+The key to look up in the Map or WeakMap
 
-### callback
+#### callback
 
 () => `V`
 
 The function to call to generate a new value if the key doesn't exist
 
-## Returns
+### Returns
 
 `V`
 

packages/utilities/eff/src/index.ts

@@ -1188,13 +1188,27 @@ export function zipWith<T, U, V>(
 // #region Map & Set
 
 /**
- * Retrieves a value from a Map if the key exists, or computes and stores a new value if it doesn't.
- * @param map - The Map to get from or update
- * @param key - The key to look up in the Map
+ * Retrieves a value from a Map or WeakMap if the key exists, or computes and stores a new value if it doesn't.
+ * @param map - The Map or WeakMap to get from or update
+ * @param key - The key to look up in the Map or WeakMap
  * @param callback - The function to call to generate a new value if the key doesn't exist
  * @returns The existing value for the key, or the newly computed value
  */
-export function getOrUpdate<K, V>(map: Map<K, V>, key: K, callback: () => V): V {
+export function getOrUpdate<K extends WeakKey, V>(
+  map: WeakMap<K, V>,
+  key: K,
+  callback: () => V,
+): V;
+export function getOrUpdate<K, V>(
+  map: Map<K, V>,
+  key: K,
+  callback: () => V,
+): V;
+export function getOrUpdate<K extends WeakKey, V>(
+  map: Map<K, V> | WeakMap<K, V>,
+  key: K,
+  callback: () => V,
+): V {
   if (map.has(key)) {
     return map.get(key)!;
   }

packages/utilities/kit/src/JsxConfig/JsxConfig.ts

@@ -1,5 +1,5 @@
-/* eslint-disable perfectionist/sort-variable-declarations */
 import type { RuleContext } from "../types";
+import { getOrUpdate } from "@eslint-react/eff";
 import { type CompilerOptions, JsxEmit } from "typescript";
 import * as RE from "../RE";
 
@@ -49,21 +49,26 @@ const cache = new WeakMap<RuleContext["sourceCode"], JsxConfig>();
  * @returns JsxConfig
  */
 export function getFromAnnotation(context: RuleContext) {
-  if (cache.has(context.sourceCode)) return cache.get(context.sourceCode);
-  if (!context.sourceCode.text.includes("@jsx")) return {};
-  let jsx, jsxFrag, jsxRuntime, jsxImportSource;
-  for (const comment of context.sourceCode.getAllComments().reverse()) {
-    const value = comment.value;
-    jsx ??= value.match(RE.ANNOTATION_JSX)?.[1];
-    jsxFrag ??= value.match(RE.ANNOTATION_JSX_FRAG)?.[1];
-    jsxRuntime ??= value.match(RE.ANNOTATION_JSX_RUNTIME)?.[1];
-    jsxImportSource ??= value.match(RE.ANNOTATION_JSX_IMPORT_SOURCE)?.[1];
-  }
-  const options = make();
-  if (jsx != null) options.jsxFactory = jsx;
-  if (jsxFrag != null) options.jsxFragmentFactory = jsxFrag;
-  if (jsxRuntime != null) options.jsx = jsxRuntime === "classic" ? JsxEmit.React : JsxEmit.ReactJSX;
-  if (jsxImportSource != null) options.jsxImportSource = jsxImportSource;
-  cache.set(context.sourceCode, options);
-  return options;
+  return getOrUpdate(
+    cache,
+    context.sourceCode,
+    () => {
+      const options = make();
+      if (!context.sourceCode.text.includes("@jsx")) return options;
+      // eslint-disable-next-line perfectionist/sort-variable-declarations
+      let jsx, jsxFrag, jsxRuntime, jsxImportSource;
+      for (const comment of context.sourceCode.getAllComments().reverse()) {
+        const value = comment.value;
+        jsx ??= value.match(RE.ANNOTATION_JSX)?.[1];
+        jsxFrag ??= value.match(RE.ANNOTATION_JSX_FRAG)?.[1];
+        jsxRuntime ??= value.match(RE.ANNOTATION_JSX_RUNTIME)?.[1];
+        jsxImportSource ??= value.match(RE.ANNOTATION_JSX_IMPORT_SOURCE)?.[1];
+      }
+      if (jsx != null) options.jsxFactory = jsx;
+      if (jsxFrag != null) options.jsxFragmentFactory = jsxFrag;
+      if (jsxRuntime != null) options.jsx = jsxRuntime === "classic" ? JsxEmit.React : JsxEmit.ReactJSX;
+      if (jsxImportSource != null) options.jsxImportSource = jsxImportSource;
+      return options;
+    },
+  );
 }