fix(core): avoid leaking memory if component throws during creation (#57546)

crisbeto · alxhub · commit 106917af8786 · 2024-08-27T13:29:09.000-07:00
When we create the LView for a component, we track it in the `TRACKED_LVIEWS` map. It gets untracked when it is destroy, but if it throws during creation, the user won't have access to a `ComponentRef` in order to clean it up. These changes automatically untrack the related LViews if the component couldn't be created. PR Close #57546
diff --git a/packages/core/src/render3/component_ref.ts b/packages/core/src/render3/component_ref.ts
@@ -88,6 +88,7 @@ import {debugStringifyTypeForError, stringifyForError} from './util/stringify_ut
 import {getComponentLViewByIndex, getNativeByTNode, getTNode} from './util/view_utils';
 import {ViewRef} from './view_ref';
 import {ChainedInjector} from './chained_injector';
+import {unregisterLView} from './interfaces/lview_tracking';
 
 export class ComponentFactoryResolver extends AbstractComponentFactoryResolver {
   /**
@@ -333,6 +334,7 @@ export class ComponentFactory<T> extends AbstractComponentFactory<T> {
 
       let component: T;
       let tElementNode: TElementNode;
+      let componentView: LView | null = null;
 
       try {
         const rootComponentDef = this.componentDef;
@@ -354,7 +356,7 @@ export class ComponentFactory<T> extends AbstractComponentFactory<T> {
         }
 
         const hostTNode = createRootComponentTNode(rootLView, hostRNode);
-        const componentView = createRootComponentView(
+        componentView = createRootComponentView(
           hostTNode,
           hostRNode,
           rootComponentDef,
@@ -388,6 +390,14 @@ export class ComponentFactory<T> extends AbstractComponentFactory<T> {
           [LifecycleHooksFeature],
         );
         renderView(rootTView, rootLView, null);
+      } catch (e) {
+        // Stop tracking the views if creation failed since
+        // the consumer won't have a way to dereference them.
+        if (componentView !== null) {
+          unregisterLView(componentView);
+        }
+        unregisterLView(rootLView);
+        throw e;
       } finally {
         leaveView();
       }
diff --git a/packages/core/test/bundling/animations-standalone/bundle.golden_symbols.json b/packages/core/test/bundling/animations-standalone/bundle.golden_symbols.json
@@ -1478,6 +1478,9 @@
   {
     "name": "uniqueIdCounter"
   },
+  {
+    "name": "unregisterLView"
+  },
   {
     "name": "unwrapRNode"
   },
diff --git a/packages/core/test/bundling/animations/bundle.golden_symbols.json b/packages/core/test/bundling/animations/bundle.golden_symbols.json
@@ -1553,6 +1553,9 @@
   {
     "name": "uniqueIdCounter"
   },
+  {
+    "name": "unregisterLView"
+  },
   {
     "name": "unwrapRNode"
   },
diff --git a/packages/core/test/bundling/cyclic_import/bundle.golden_symbols.json b/packages/core/test/bundling/cyclic_import/bundle.golden_symbols.json
@@ -1253,6 +1253,9 @@
   {
     "name": "uniqueIdCounter"
   },
+  {
+    "name": "unregisterLView"
+  },
   {
     "name": "unwrapRNode"
   },
diff --git a/packages/core/test/bundling/defer/bundle.golden_symbols.json b/packages/core/test/bundling/defer/bundle.golden_symbols.json
@@ -2498,6 +2498,9 @@
   {
     "name": "uniqueIdCounter"
   },
+  {
+    "name": "unregisterLView"
+  },
   {
     "name": "unwrapRNode"
   },
diff --git a/packages/core/test/bundling/forms_reactive/bundle.golden_symbols.json b/packages/core/test/bundling/forms_reactive/bundle.golden_symbols.json
@@ -1889,6 +1889,9 @@
   {
     "name": "uniqueIdCounter"
   },
+  {
+    "name": "unregisterLView"
+  },
   {
     "name": "untracked"
   },
diff --git a/packages/core/test/bundling/forms_template_driven/bundle.golden_symbols.json b/packages/core/test/bundling/forms_template_driven/bundle.golden_symbols.json
@@ -1871,6 +1871,9 @@
   {
     "name": "uniqueIdCounter"
   },
+  {
+    "name": "unregisterLView"
+  },
   {
     "name": "untracked"
   },
diff --git a/packages/core/test/bundling/hello_world/bundle.golden_symbols.json b/packages/core/test/bundling/hello_world/bundle.golden_symbols.json
@@ -995,6 +995,9 @@
   {
     "name": "uniqueIdCounter"
   },
+  {
+    "name": "unregisterLView"
+  },
   {
     "name": "unwrapRNode"
   },
diff --git a/packages/core/test/bundling/hydration/bundle.golden_symbols.json b/packages/core/test/bundling/hydration/bundle.golden_symbols.json
@@ -1385,6 +1385,9 @@
   {
     "name": "uniqueIdCounter"
   },
+  {
+    "name": "unregisterLView"
+  },
   {
     "name": "unwrapRNode"
   },
diff --git a/packages/core/test/bundling/router/bundle.golden_symbols.json b/packages/core/test/bundling/router/bundle.golden_symbols.json
@@ -2108,6 +2108,9 @@
   {
     "name": "uniqueIdCounter"
   },
+  {
+    "name": "unregisterLView"
+  },
   {
     "name": "unwrapElementRef"
   },
diff --git a/packages/core/test/bundling/standalone_bootstrap/bundle.golden_symbols.json b/packages/core/test/bundling/standalone_bootstrap/bundle.golden_symbols.json
@@ -1103,6 +1103,9 @@
   {
     "name": "uniqueIdCounter"
   },
+  {
+    "name": "unregisterLView"
+  },
   {
     "name": "unwrapRNode"
   },
diff --git a/packages/core/test/bundling/todo/bundle.golden_symbols.json b/packages/core/test/bundling/todo/bundle.golden_symbols.json
@@ -1505,6 +1505,9 @@
   {
     "name": "uniqueIdCounter"
   },
+  {
+    "name": "unregisterLView"
+  },
   {
     "name": "unwrapRNode"
   },

Original file line number	Diff line number	Diff line change
`@@ -1478,6 +1478,9 @@`
`1478`	`1478`	`{`
`1479`	`1479`	`"name": "uniqueIdCounter"`
`1480`	`1480`	`},`
	`1481`	`+ {`
	`1482`	`+ "name": "unregisterLView"`
	`1483`	`+ },`
`1481`	`1484`	`{`
`1482`	`1485`	`"name": "unwrapRNode"`
`1483`	`1486`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1553,6 +1553,9 @@`
`1553`	`1553`	`{`
`1554`	`1554`	`"name": "uniqueIdCounter"`
`1555`	`1555`	`},`
	`1556`	`+ {`
	`1557`	`+ "name": "unregisterLView"`
	`1558`	`+ },`
`1556`	`1559`	`{`
`1557`	`1560`	`"name": "unwrapRNode"`
`1558`	`1561`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1253,6 +1253,9 @@`
`1253`	`1253`	`{`
`1254`	`1254`	`"name": "uniqueIdCounter"`
`1255`	`1255`	`},`
	`1256`	`+ {`
	`1257`	`+ "name": "unregisterLView"`
	`1258`	`+ },`
`1256`	`1259`	`{`
`1257`	`1260`	`"name": "unwrapRNode"`
`1258`	`1261`	`},`
Original file line number	Diff line number	Diff line change
`@@ -2498,6 +2498,9 @@`
`2498`	`2498`	`{`
`2499`	`2499`	`"name": "uniqueIdCounter"`
`2500`	`2500`	`},`
	`2501`	`+ {`
	`2502`	`+ "name": "unregisterLView"`
	`2503`	`+ },`
`2501`	`2504`	`{`
`2502`	`2505`	`"name": "unwrapRNode"`
`2503`	`2506`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1889,6 +1889,9 @@`
`1889`	`1889`	`{`
`1890`	`1890`	`"name": "uniqueIdCounter"`
`1891`	`1891`	`},`
	`1892`	`+ {`
	`1893`	`+ "name": "unregisterLView"`
	`1894`	`+ },`
`1892`	`1895`	`{`
`1893`	`1896`	`"name": "untracked"`
`1894`	`1897`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1871,6 +1871,9 @@`
`1871`	`1871`	`{`
`1872`	`1872`	`"name": "uniqueIdCounter"`
`1873`	`1873`	`},`
	`1874`	`+ {`
	`1875`	`+ "name": "unregisterLView"`
	`1876`	`+ },`
`1874`	`1877`	`{`
`1875`	`1878`	`"name": "untracked"`
`1876`	`1879`	`},`
Original file line number	Diff line number	Diff line change
`@@ -995,6 +995,9 @@`
`995`	`995`	`{`
`996`	`996`	`"name": "uniqueIdCounter"`
`997`	`997`	`},`
	`998`	`+ {`
	`999`	`+ "name": "unregisterLView"`
	`1000`	`+ },`
`998`	`1001`	`{`
`999`	`1002`	`"name": "unwrapRNode"`
`1000`	`1003`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1385,6 +1385,9 @@`
`1385`	`1385`	`{`
`1386`	`1386`	`"name": "uniqueIdCounter"`
`1387`	`1387`	`},`
	`1388`	`+ {`
	`1389`	`+ "name": "unregisterLView"`
	`1390`	`+ },`
`1388`	`1391`	`{`
`1389`	`1392`	`"name": "unwrapRNode"`
`1390`	`1393`	`},`
Original file line number	Diff line number	Diff line change
`@@ -2108,6 +2108,9 @@`
`2108`	`2108`	`{`
`2109`	`2109`	`"name": "uniqueIdCounter"`
`2110`	`2110`	`},`
	`2111`	`+ {`
	`2112`	`+ "name": "unregisterLView"`
	`2113`	`+ },`
`2111`	`2114`	`{`
`2112`	`2115`	`"name": "unwrapElementRef"`
`2113`	`2116`	`},`