Revert "alpinejs: Remove the custom memory patch"

This reverts commit 6ccb109. The above removal didn't fix my problem, so keep the patch, as it solves a real problem.
gohugoio · Nov 17, 2023 · af8d4a5 · af8d4a5
1 parent 6ccb109
commit af8d4a5
Show file tree

Hide file tree

Showing 11 changed files with 94 additions and 32 deletions.
diff --git a/alpinejs/packages/alpinejs/dist/cdn.js b/alpinejs/packages/alpinejs/dist/cdn.js
@@ -519,7 +519,12 @@
         enumerable: false
       });
     });
-    return obj;
+    return {
+      obj,
+      cleanup: () => {
+        el = null;
+      }
+    };
   }
 
   // packages/alpinejs/src/utils/error.js
@@ -563,7 +568,8 @@ ${expression ? 'Expression: "' + expression + '"\n\n' : ""}`, el);
   }
   function normalEvaluator(el, expression) {
     let overriddenMagics = {};
-    injectMagics(overriddenMagics, el);
+    let cleanup2 = injectMagics(overriddenMagics, el).cleanup;
+    onAttributeRemoved(el, "evaluator", cleanup2);
     let dataStack = [overriddenMagics, ...closestDataStack(el)];
     let evaluator = typeof expression === "function" ? generateEvaluatorFromFunction(dataStack, expression) : generateEvaluatorFromString(dataStack, expression, el);
     return tryCatch.bind(null, el, expression, evaluator);
@@ -2915,20 +2921,22 @@ ${expression ? 'Expression: "' + expression + '"\n\n' : ""}`, el);
       return;
     expression = expression === "" ? "{}" : expression;
     let magicContext = {};
-    injectMagics(magicContext, el);
+    let cleanup1 = injectMagics(magicContext, el).cleanup;
     let dataProviderContext = {};
     injectDataProviders(dataProviderContext, magicContext);
     let data2 = evaluate(el, expression, { scope: dataProviderContext });
     if (data2 === void 0 || data2 === true)
       data2 = {};
-    injectMagics(data2, el);
+    let cleanup22 = injectMagics(data2, el).cleanup;
     let reactiveData = reactive(data2);
     initInterceptors2(reactiveData);
     let undo = addScopeToNode(el, reactiveData);
     reactiveData["init"] && evaluate(el, reactiveData["init"]);
     cleanup2(() => {
       reactiveData["destroy"] && evaluate(el, reactiveData["destroy"]);
       undo();
+      cleanup1();
+      cleanup22();
     });
   });
 

diff --git a/alpinejs/packages/alpinejs/dist/cdn.min.js b/alpinejs/packages/alpinejs/dist/cdn.min.js
diff --git a/alpinejs/packages/alpinejs/dist/module.cjs.js b/alpinejs/packages/alpinejs/dist/module.cjs.js
@@ -1931,7 +1931,12 @@ function injectMagics(obj, el) {
       enumerable: false
     });
   });
-  return obj;
+  return {
+    obj,
+    cleanup: () => {
+      el = null;
+    }
+  };
 }
 
 // packages/alpinejs/src/utils/error.js
@@ -1975,7 +1980,8 @@ function setEvaluator(newEvaluator) {
 }
 function normalEvaluator(el, expression) {
   let overriddenMagics = {};
-  injectMagics(overriddenMagics, el);
+  let cleanup = injectMagics(overriddenMagics, el).cleanup;
+  onAttributeRemoved(el, "evaluator", cleanup);
   let dataStack = [overriddenMagics, ...closestDataStack(el)];
   let evaluator = typeof expression === "function" ? generateEvaluatorFromFunction(dataStack, expression) : generateEvaluatorFromString(dataStack, expression, el);
   return tryCatch.bind(null, el, expression, evaluator);
@@ -3622,20 +3628,22 @@ directive("data", (el, { expression }, { cleanup }) => {
     return;
   expression = expression === "" ? "{}" : expression;
   let magicContext = {};
-  injectMagics(magicContext, el);
+  let cleanup1 = injectMagics(magicContext, el).cleanup;
   let dataProviderContext = {};
   injectDataProviders(dataProviderContext, magicContext);
   let data2 = evaluate(el, expression, { scope: dataProviderContext });
   if (data2 === void 0 || data2 === true)
     data2 = {};
-  injectMagics(data2, el);
+  let cleanup2 = injectMagics(data2, el).cleanup;
   let reactiveData = reactive(data2);
   initInterceptors2(reactiveData);
   let undo = addScopeToNode(el, reactiveData);
   reactiveData["init"] && evaluate(el, reactiveData["init"]);
   cleanup(() => {
     reactiveData["destroy"] && evaluate(el, reactiveData["destroy"]);
     undo();
+    cleanup1();
+    cleanup2();
   });
 });
 

diff --git a/alpinejs/packages/alpinejs/dist/module.esm.js b/alpinejs/packages/alpinejs/dist/module.esm.js
@@ -518,7 +518,12 @@ function injectMagics(obj, el) {
       enumerable: false
     });
   });
-  return obj;
+  return {
+    obj,
+    cleanup: () => {
+      el = null;
+    }
+  };
 }
 
 // packages/alpinejs/src/utils/error.js
@@ -562,7 +567,8 @@ function setEvaluator(newEvaluator) {
 }
 function normalEvaluator(el, expression) {
   let overriddenMagics = {};
-  injectMagics(overriddenMagics, el);
+  let cleanup2 = injectMagics(overriddenMagics, el).cleanup;
+  onAttributeRemoved(el, "evaluator", cleanup2);
   let dataStack = [overriddenMagics, ...closestDataStack(el)];
   let evaluator = typeof expression === "function" ? generateEvaluatorFromFunction(dataStack, expression) : generateEvaluatorFromString(dataStack, expression, el);
   return tryCatch.bind(null, el, expression, evaluator);
@@ -2914,20 +2920,22 @@ directive("data", (el, { expression }, { cleanup: cleanup2 }) => {
     return;
   expression = expression === "" ? "{}" : expression;
   let magicContext = {};
-  injectMagics(magicContext, el);
+  let cleanup1 = injectMagics(magicContext, el).cleanup;
   let dataProviderContext = {};
   injectDataProviders(dataProviderContext, magicContext);
   let data2 = evaluate(el, expression, { scope: dataProviderContext });
   if (data2 === void 0 || data2 === true)
     data2 = {};
-  injectMagics(data2, el);
+  let cleanup22 = injectMagics(data2, el).cleanup;
   let reactiveData = reactive(data2);
   initInterceptors2(reactiveData);
   let undo = addScopeToNode(el, reactiveData);
   reactiveData["init"] && evaluate(el, reactiveData["init"]);
   cleanup2(() => {
     reactiveData["destroy"] && evaluate(el, reactiveData["destroy"]);
     undo();
+    cleanup1();
+    cleanup22();
   });
 });
 

diff --git a/alpinejs/packages/alpinejs/src/directives/x-data.js b/alpinejs/packages/alpinejs/src/directives/x-data.js
@@ -16,7 +16,7 @@ directive('data', ((el, { expression }, { cleanup }) => {
     expression = expression === '' ? '{}' : expression
 
     let magicContext = {}
-    injectMagics(magicContext, el)
+    let cleanup1 = injectMagics(magicContext, el).cleanup
 
     let dataProviderContext = {}
     injectDataProviders(dataProviderContext, magicContext)
@@ -25,7 +25,7 @@ directive('data', ((el, { expression }, { cleanup }) => {
 
     if (data === undefined || data === true) data = {}
 
-    injectMagics(data, el)
+    let cleanup2 = injectMagics(data, el).cleanup
 
     let reactiveData = reactive(data)
 
@@ -39,5 +39,9 @@ directive('data', ((el, { expression }, { cleanup }) => {
         reactiveData['destroy'] && evaluate(el, reactiveData['destroy'])
 
         undo()
+
+         // MemLeak1: Issue #2140
+         cleanup1()
+         cleanup2()
     })
 }))
diff --git a/alpinejs/packages/alpinejs/src/evaluator.js b/alpinejs/packages/alpinejs/src/evaluator.js
@@ -1,6 +1,7 @@
 import { closestDataStack, mergeProxies } from './scope'
 import { injectMagics } from './magics'
 import { tryCatch, handleError } from './utils/error'
+import { onAttributeRemoved } from './mutation'
 
 let shouldAutoEvaluateFunctions = true
 
@@ -37,7 +38,10 @@ export function setEvaluator(newEvaluator) {
 export function normalEvaluator(el, expression) {
     let overriddenMagics = {}
 
-    injectMagics(overriddenMagics, el)
+    let cleanup = injectMagics(overriddenMagics, el).cleanup
+
+     // MemLeak1: Issue #2140 (note: there are other uses of injectMagics)
+     onAttributeRemoved(el, "evaluator", cleanup)
 
     let dataStack = [overriddenMagics, ...closestDataStack(el)]
 

diff --git a/alpinejs/packages/alpinejs/src/magics.js b/alpinejs/packages/alpinejs/src/magics.js
@@ -33,5 +33,11 @@ export function injectMagics(obj, el) {
         })
     })
 
-    return obj
+    return {
+        obj,
+        cleanup: () => {
+            // MemLeak1: Issue #2140
+            el = null;
+        }
+    };
 }
diff --git a/alpinejs/packages/csp/dist/cdn.js b/alpinejs/packages/csp/dist/cdn.js
@@ -519,7 +519,12 @@
         enumerable: false
       });
     });
-    return obj;
+    return {
+      obj,
+      cleanup: () => {
+        el = null;
+      }
+    };
   }
 
   // packages/alpinejs/src/utils/error.js
@@ -563,7 +568,8 @@ ${expression ? 'Expression: "' + expression + '"\n\n' : ""}`, el);
   }
   function normalEvaluator(el, expression) {
     let overriddenMagics = {};
-    injectMagics(overriddenMagics, el);
+    let cleanup2 = injectMagics(overriddenMagics, el).cleanup;
+    onAttributeRemoved(el, "evaluator", cleanup2);
     let dataStack = [overriddenMagics, ...closestDataStack(el)];
     let evaluator = typeof expression === "function" ? generateEvaluatorFromFunction(dataStack, expression) : generateEvaluatorFromString(dataStack, expression, el);
     return tryCatch.bind(null, el, expression, evaluator);
@@ -2915,20 +2921,22 @@ ${expression ? 'Expression: "' + expression + '"\n\n' : ""}`, el);
       return;
     expression = expression === "" ? "{}" : expression;
     let magicContext = {};
-    injectMagics(magicContext, el);
+    let cleanup1 = injectMagics(magicContext, el).cleanup;
     let dataProviderContext = {};
     injectDataProviders(dataProviderContext, magicContext);
     let data2 = evaluate(el, expression, { scope: dataProviderContext });
     if (data2 === void 0 || data2 === true)
       data2 = {};
-    injectMagics(data2, el);
+    let cleanup22 = injectMagics(data2, el).cleanup;
     let reactiveData = reactive(data2);
     initInterceptors2(reactiveData);
     let undo = addScopeToNode(el, reactiveData);
     reactiveData["init"] && evaluate(el, reactiveData["init"]);
     cleanup2(() => {
       reactiveData["destroy"] && evaluate(el, reactiveData["destroy"]);
       undo();
+      cleanup1();
+      cleanup22();
     });
   });