Update cache name, add comments

WordPress · Dec 14, 2023 · 6434535 · 6434535
1 parent 940e68b
commit 6434535
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 17 deletions.
diff --git a/packages/block-library/src/pattern/edit.js b/packages/block-library/src/pattern/edit.js
@@ -15,7 +15,7 @@ import { __, sprintf } from '@wordpress/i18n';
 /**
  * Internal dependencies
  */
-import { usePatternRecursionDetector } from './recursion-detector';
+import { useParsePatternDependencies } from './recursion-detector';
 
 const PatternEdit = ( { attributes, clientId } ) => {
 	const selectedPattern = useSelect(
@@ -40,7 +40,7 @@ const PatternEdit = ( { attributes, clientId } ) => {
 		useSelect( blockEditorStore );
 
 	const [ hasRecursionError, setHasRecursionError ] = useState( false );
-	const parsePatternDependencies = usePatternRecursionDetector();
+	const parsePatternDependencies = useParsePatternDependencies();
 
 	// Duplicated in packages/edit-site/src/components/start-template-options/index.js.
 	function injectThemeAttributeInBlockTemplateContent( block ) {

diff --git a/packages/block-library/src/pattern/recursion-detector.js b/packages/block-library/src/pattern/recursion-detector.js
@@ -15,15 +15,41 @@
  */
 import { useRegistry } from '@wordpress/data';
 
-const patternDependenciesRegistry = new WeakMap();
+// Naming is hard.
+//
+// @see useParsePatternDependencies
+const cache = new WeakMap();
+
+/**
+ * Hook that returns a function, `parsePatternDependencies`, but bound
+ * specifically to the context's registry:
+ *
+ * @example
+ * ```js
+ * const parsePatternDependencies = useParsePatternDependencies();
+ * parsePatternDependencies( selectedPattern );
+ * ```
+ *
+ * @see parsePatternDependencies
+ *
+ * @return {Function} A bound function
+ */
+export function useParsePatternDependencies() {
+	const registry = useRegistry();
+
+	if ( ! cache.has( registry ) ) {
+		cache.set( registry, parsePatternDependencies.bind( null, new Map() ) );
+	}
+	return cache.get( registry );
+}
 
 /**
  * Parse a given pattern and traverse its contents to detect any subsequent
  * patterns on which it may depend. Such occurrences will be added to an
  * internal dependency graph. If a circular dependency is detected, an
  * error will be thrown.
  *
- * Exported for testing purposes only.
+ * EXPORTED FOR TESTING PURPOSES ONLY.
  *
  * @param {Map<string, Set<string>>} deps           Map of pattern dependencies.
  * @param {Object}                   pattern        Pattern.
@@ -49,7 +75,7 @@ export function parsePatternDependencies( deps, { name, blocks } ) {
  * Declare that pattern `a` depends on pattern `b`. If a circular
  * dependency is detected, an error will be thrown.
  *
- * Exported for testing purposes only.
+ * EXPORTED FOR TESTING PURPOSES ONLY.
  *
  * @param {Map<string, Set<string>>} deps Map of pattern dependencies.
  * @param {string}                   a    Slug for pattern A.
@@ -106,15 +132,3 @@ function hasCycle(
 	currentPath.delete( slug );
 	return false;
 }
-
-export function usePatternRecursionDetector() {
-	const registry = useRegistry();
-
-	if ( ! patternDependenciesRegistry.has( registry ) ) {
-		patternDependenciesRegistry.set(
-			registry,
-			parsePatternDependencies.bind( null, new Map() )
-		);
-	}
-	return patternDependenciesRegistry.get( registry );
-}