fix: suggestions callback being called even when closed

CHANGELOG.md

@@ -8,6 +8,9 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ### Added
 - force refreshing suggestions with `SuggestionsController.refresh`
 
+### Fixed
+- suggestionsCallback getting called even when closed
+
 ## 5.1.0 - 2024-01-27
 ### Added
 - Returning null from `suggestionsCallback` hides the box

lib/src/common/base/suggestions_controller.dart

@@ -52,8 +52,19 @@ class SuggestionsController<T> extends ChangeNotifier {
 
   List<T>? _suggestions;
 
+  /// A stream of events that occur when the suggestions list should be refreshed.
+  ///
+  /// For internal use only.
+  Stream<void> get $refreshes => _refreshesController.stream;
+  final StreamController<void> _refreshesController =
+      StreamController<void>.broadcast();
+
   /// Resets the suggestions so that they are requested again.
-  void refresh() => suggestions = null;
+  void refresh() {
+    ChangeNotifier.debugAssertNotDisposed(this);
+    _suggestions = null;
+    _refreshesController.add(null);
+  }
 
   /// Whether the suggestions box is loading.
   bool get isLoading => _isLoading;
@@ -132,10 +143,18 @@ class SuggestionsController<T> extends ChangeNotifier {
   /// A stream of events that occur when the suggestions box should be resized.
   ///
   /// For internal use only.
-  Stream<void> get resizes => _resizesController.stream;
+  Stream<void> get $resizes => _resizesController.stream;
   final StreamController<void> _resizesController =
       StreamController<void>.broadcast();
 
+  /// Resizes the suggestions box.
+  ///
+  /// You usually don't need to call this method manually.
+  void resize() {
+    ChangeNotifier.debugAssertNotDisposed(this);
+    _resizesController.add(null);
+  }
+
   /// A stream of selected suggestions.
   Stream<T> get selections => _selectionsController.stream;
   final StreamController<T> _selectionsController =
@@ -146,14 +165,6 @@ class SuggestionsController<T> extends ChangeNotifier {
   /// This notifies potential listeners of the selection.
   void select(T suggestion) => _selectionsController.add(suggestion);
 
-  /// Resizes the suggestions box.
-  ///
-  /// You usually don't need to call this method manually.
-  void resize() {
-    ChangeNotifier.debugAssertNotDisposed(this);
-    _resizesController.add(null);
-  }
-
   /// Focuses the suggestions box.
   void focusBox() {
     if (_focusState == SuggestionsFocusState.box) return;
@@ -204,7 +215,9 @@ class SuggestionsController<T> extends ChangeNotifier {
   @override
   void dispose() {
     close();
+    _refreshesController.close();
     _resizesController.close();
+    _selectionsController.close();
     super.dispose();
   }
 }

lib/src/common/field/suggestions_field.dart

@@ -273,7 +273,7 @@ class _SuggestionsFieldState<T> extends State<SuggestionsField<T>> {
           link: link,
           child: ConnectorWidget(
             value: controller,
-            connect: (value) => value.resizes.listen((_) => onResize()),
+            connect: (value) => value.$resizes.listen((_) => onResize()),
             disconnect: (value, key) => key?.cancel(),
             child: SuggestionsFieldFocusConnector<T>(
               controller: controller,

lib/src/common/search/suggestions_search.dart

@@ -65,20 +65,14 @@ class SuggestionsSearch<T> extends StatefulWidget {
 
 class _SuggestionsSearchState<T> extends State<SuggestionsSearch<T>> {
   bool isQueued = false;
-  late String search;
-  late bool wasOpen;
-  late bool hadSuggestions;
+  late String search = widget.textEditingController.text;
+  late bool wasOpen = widget.controller.isOpen;
+  late bool hadSuggestions = widget.controller.suggestions != null;
 
   @override
   void initState() {
     super.initState();
-    search = widget.textEditingController.text;
-    wasOpen = widget.controller.isOpen;
-    hadSuggestions = widget.controller.suggestions != null;
-    WidgetsBinding.instance.addPostFrameCallback((_) {
-      if (!mounted) return;
-      if (wasOpen) load();
-    });
+    WidgetsBinding.instance.addPostFrameCallback((_) => load());
   }
 
   void onChange() {
@@ -91,14 +85,14 @@ class _SuggestionsSearchState<T> extends State<SuggestionsSearch<T>> {
     bool isOpen = widget.controller.isOpen;
     if (wasOpen == isOpen) return;
     wasOpen = isOpen;
-    if (isOpen) load();
+    load();
   }
 
   void onSuggestionsChange() {
     bool hasSuggestions = widget.controller.suggestions != null;
     if (hadSuggestions == hasSuggestions) return;
     hadSuggestions = hasSuggestions;
-    if (!hasSuggestions) load();
+    load();
   }
 
   /// Loads suggestions if not already loaded.
@@ -110,6 +104,7 @@ class _SuggestionsSearchState<T> extends State<SuggestionsSearch<T>> {
   /// Loads suggestions. Discards any previously loaded suggestions.
   Future<void> reload() async {
     if (!mounted) return;
+    if (!wasOpen) return;
 
     if (widget.controller.isLoading) {
       isQueued = true;
@@ -151,13 +146,21 @@ class _SuggestionsSearchState<T> extends State<SuggestionsSearch<T>> {
         debounceDuration: widget.debounceDuration,
         onChanged: (value) {
           search = value;
-          reload();
+          widget.controller.refresh();
         },
         child: ConnectorWidget(
           value: widget.controller,
           connect: (value) => value.addListener(onChange),
           disconnect: (value, key) => value.removeListener(onChange),
-          child: widget.child,
+          child: ConnectorWidget(
+            value: widget.controller,
+            connect: (value) => value.$refreshes.listen((_) {
+              hadSuggestions = false; // prevents double load
+              reload();
+            }),
+            disconnect: (value, key) => key?.cancel(),
+            child: widget.child,
+          ),
         ),
       ),
     );

test/common/base/suggestions_controller_test.dart

@@ -20,11 +20,15 @@ void main() {
       expect(controller.suggestions, equals(['a', 'b', 'c']));
     });
 
-    test('refreshes the suggestions', () {
+    test('refreshes the suggestions', () async {
       expect(controller.suggestions, isNull);
       controller.suggestions = ['a', 'b', 'c'];
+      bool called = false;
+      controller.$refreshes.listen((_) => called = true);
       controller.refresh();
+      await Future<void>.value();
       expect(controller.suggestions, null);
+      expect(called, isTrue);
     });
 
     test('sets loading state', () {
@@ -88,7 +92,7 @@ void main() {
 
     test('sends resize event', () async {
       bool called = false;
-      controller.resizes.listen((_) => called = true);
+      controller.$resizes.listen((_) => called = true);
       controller.resize();
       await Future<void>.value();
       expect(called, isTrue);

test/common/search/suggestions_search_test.dart

@@ -154,6 +154,8 @@ void main() {
     });
 
     testWidgets('loads when queued up', (WidgetTester tester) async {
+      controller.open();
+
       await tester.pumpWidget(
         MaterialApp(
           home: Material(