apostrophe 4.5.1 → 4.5.2

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 4.5.2 (2024-07-11)
+
+### Fixes
+
+* Ensure that `apos.doc.walk` never gets caught in an infinite loop even if circular references are present in the data. This is a hotfix for an issue that can arise when the new support for breadcrumbs in search results is combined with a more inclusive projection for page ancestors.
+* Correct a longstanding bug in `apos.doc.walk` that led items to be listed twice in the `ancestors` array passed to the iterator.
+* Correct a longstanding bug in `apos.doc.walk` that led ancestors that are themselves arrays to be misrepresented as a series of objects in the `ancestors` array passed to the iterator.
+* For additional guarantees of reliability the `_dotPath` and `_ancestors` arguments to `apos.doc.walk`, which were always clearly documented as for internal use only, can no longer be passed in externally.
+
 ## 4.5.1 (2024-07-11)
 
 ### Changes

package/modules/@apostrophecms/doc/index.js

@@ -786,39 +786,40 @@ module.exports = {
       // will be `b`, the value will be `5`, the dotPath
       // will be the string `a.b`, and ancestors will be
       // [ { a: { b: 5 } } ].
-      //
-      // You do not need to pass the `_dotPath` and `_ancestors` arguments.
-      // They are used for recursive invocation.
-      walk(doc, iterator, _dotPath, _ancestors) {
-        // We do not use lodash here because of
-        // performance issues.
-        //
-        // Pruning big nested objects is not something we
-        // can afford to do slowly. -Tom
-        if (_dotPath !== undefined) {
-          _dotPath += '.';
-        } else {
-          _dotPath = '';
-        }
-        _ancestors = (_ancestors || []).concat(doc);
-        const remove = [];
-        for (const key in doc) {
-          const __dotPath = _dotPath + key.toString();
-          const ow = '_originalWidgets';
-          if (__dotPath === ow || __dotPath.substring(0, ow.length) === ow + '.') {
-            continue;
+      walk(doc, iterator) {
+        return walkBody(doc, iterator, undefined, []);
+        function walkBody(doc, iterator, _dotPath, _ancestors) {
+          if (_ancestors.includes(doc)) {
+            // No infinite loops on circular references
+            return;
           }
-          if (iterator(doc, key, doc[key], __dotPath, _ancestors) === false) {
-            remove.push(key);
+          // Don't use concat, doc can be an array in which case
+          // it is important to preserve the nesting
+          _ancestors = [ ..._ancestors, doc ];
+          if (_dotPath !== undefined) {
+            _dotPath += '.';
           } else {
-            const val = doc[key];
-            if (typeof val === 'object') {
-              self.walk(val, iterator, __dotPath, _ancestors.concat([ doc ]));
+            _dotPath = '';
+          }
+          const remove = [];
+          for (const key in doc) {
+            const __dotPath = _dotPath + key.toString();
+            const ow = '_originalWidgets';
+            if (__dotPath === ow || __dotPath.substring(0, ow.length) === ow + '.') {
+              continue;
+            }
+            if (iterator(doc, key, doc[key], __dotPath, _ancestors) === false) {
+              remove.push(key);
+            } else {
+              const val = doc[key];
+              if (typeof val === 'object') {
+                walkBody(val, iterator, __dotPath, _ancestors);
+              }
             }
           }
-        }
-        for (const key of remove) {
-          delete doc[key];
+          for (const key of remove) {
+            delete doc[key];
+          }
         }
       },
       // Retry the given "actor" async function until it

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apostrophe",
-  "version": "4.5.1",
+  "version": "4.5.2",
   "description": "The Apostrophe Content Management System.",
   "main": "index.js",
   "scripts": {
@@ -148,4 +148,4 @@
   "browserslist": [
     "ie >= 10"
   ]
-}
+}