Rename DimensionsProvider.onHotRestart to .close, and slightly improve docs.

Author: ditman

lib/web_ui/lib/src/engine/view_embedder/dimensions_provider/custom_element_dimensions_provider.dart

@@ -54,7 +54,7 @@ class CustomElementDimensionsProvider extends DimensionsProvider {
   }
 
   @override
-  void onHotRestart() {
+  void close() {
     _hostElementResizeObserver?.disconnect();
     // ignore:unawaited_futures
     _onResizeStreamController.close();

lib/web_ui/lib/src/engine/view_embedder/dimensions_provider/dimensions_provider.dart

@@ -57,6 +57,9 @@ abstract class DimensionsProvider {
   /// Returns a Stream with the changes to [ui.Size] (when cheap to get).
   Stream<ui.Size?> get onResize;
 
-  /// Clears all the resources grabbed by the DimensionsProvider instance.
-  void onHotRestart();
+  /// Clears any resources grabbed by the DimensionsProvider instance.
+  ///
+  /// All internal event handlers will be disconnected, and the [onResize] Stream
+  /// will be closed.
+  void close();
 }

lib/web_ui/lib/src/engine/view_embedder/dimensions_provider/full_page_dimensions_provider.dart

@@ -53,7 +53,7 @@ class FullPageDimensionsProvider extends DimensionsProvider {
   }
 
   @override
-  void onHotRestart() {
+  void close() {
     _domResizeSubscription.cancel();
     // ignore:unawaited_futures
     _onResizeStreamController.close();

lib/web_ui/lib/src/engine/window.dart

@@ -54,7 +54,7 @@ class EngineFlutterWindow extends ui.SingletonFlutterWindow {
     registerHotRestartListener(() {
       _browserHistory?.dispose();
       renderer.clearFragmentProgramCache();
-      _dimensionsProvider.onHotRestart();
+      _dimensionsProvider.close();
     });
   }
 

lib/web_ui/test/engine/view_embedder/dimensions_provider/custom_element_dimensions_provider_test.dart

@@ -33,7 +33,7 @@ void doTests() {
     });
 
     tearDown(() {
-      provider.onHotRestart(); // cleanup
+      provider.close(); // cleanup
       sizeSource.remove();
     });
 
@@ -67,7 +67,7 @@ void doTests() {
     });
 
     tearDown(() {
-      provider.onHotRestart(); // cleanup
+      provider.close(); // cleanup
       sizeSource.remove();
     });
 
@@ -105,7 +105,7 @@ void doTests() {
     });
 
     tearDown(() {
-      provider.onHotRestart(); // cleanup
+      provider.close(); // cleanup
       sizeSource.remove();
     });
 
@@ -155,7 +155,7 @@ void doTests() {
       });
 
       // Should close the stream
-      provider.onHotRestart();
+      provider.close();
 
       sizeSource
         ..style.width = '100px'

lib/web_ui/test/engine/view_embedder/dimensions_provider/full_page_dimensions_provider_test.dart

@@ -96,7 +96,7 @@ void doTests() {
       });
 
       // Should close the stream
-      provider.onHotRestart();
+      provider.close();
 
       resizeEventTarget.dispatchEvent(createDomEvent('Event', 'resize'));