[gui] Replace StateProvider with NotifierProvider

The recommended way to update StateProviders to riverpod v3
is to create a Notifier that is provided by a NotifierProvider
This also removes the dependency on legacy.dart

Author: levkropp

src/client/gui/lib/catalogue/image_card.dart

@@ -79,7 +79,7 @@ class ImageCard extends ConsumerWidget {
                 const SizedBox(width: 16),
                 OutlinedButton(
                   onPressed: () {
-                    ref.read(launchingImageProvider.notifier).state = image;
+                    ref.read(launchingImageProvider.notifier).set(image);
                     Scaffold.of(context).openEndDrawer();
                   },
                   child: SvgPicture.asset(

src/client/gui/lib/catalogue/launch_form.dart

@@ -3,7 +3,6 @@ import 'dart:async';
 import 'package:basics/basics.dart';
 import 'package:flutter/material.dart' hide Switch, ImageInfo;
 import 'package:flutter_riverpod/flutter_riverpod.dart';
-import 'package:flutter_riverpod/legacy.dart';
 import 'package:protobuf/protobuf.dart';
 import 'package:rxdart/rxdart.dart';
 
@@ -20,7 +19,21 @@ import '../vm_details/mount_points.dart';
 import '../vm_details/ram_slider.dart';
 import '../vm_details/spec_input.dart';
 
-final launchingImageProvider = StateProvider<ImageInfo>((_) => ImageInfo());
+class LaunchingImageNotifier extends Notifier<ImageInfo> {
+  @override
+  ImageInfo build() {
+    return ImageInfo();
+  }
+
+  void set(ImageInfo imageInfo) {
+    state = imageInfo;
+  }
+}
+
+final launchingImageProvider =
+    NotifierProvider<LaunchingImageNotifier, ImageInfo>(
+  LaunchingImageNotifier.new,
+);
 
 final randomNameProvider = Provider.autoDispose(
   (ref) => generatePetname(ref.watch(vmNamesProvider)),

src/client/gui/lib/extensions.dart

@@ -1,14 +1,29 @@
 import 'package:flutter/gestures.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
-import 'package:flutter_riverpod/legacy.dart';
 
 import 'sidebar.dart';
 
-final _hoveredLinkProvider = StateProvider.autoDispose<TextSpan?>((ref) {
-  ref.watch(sidebarKeyProvider);
-  return null;
-});
+class HoveredLinkNotifier extends Notifier<TextSpan?> {
+  @override
+  TextSpan? build() {
+    ref.watch(sidebarKeyProvider);
+    return null;
+  }
+
+  void set(TextSpan? value) {
+    state = value;
+  }
+
+  void clear() {
+    state = null;
+  }
+}
+
+final _hoveredLinkProvider =
+    NotifierProvider.autoDispose<HoveredLinkNotifier, TextSpan?>(
+  HoveredLinkNotifier.new,
+);
 
 extension TextSpanFromStringExt on String {
   TextSpan get span => TextSpan(
@@ -72,7 +87,7 @@ extension TextSpanExt on TextSpan {
         decorationColor: Colors.blue,
       ),
       recognizer: TapGestureRecognizer()..onTap = callback,
-      onEnter: (_) => ref.read(_hoveredLinkProvider.notifier).state = this,
+      onEnter: (_) => ref.read(_hoveredLinkProvider.notifier).set(this),
       onExit: (_) {
         if (ref.context.mounted) ref.invalidate(_hoveredLinkProvider);
       },

src/client/gui/lib/sidebar.dart

@@ -3,7 +3,6 @@ import 'dart:async';
 import 'package:basics/basics.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
-import 'package:flutter_riverpod/legacy.dart';
 import 'package:flutter_svg/flutter_svg.dart';
 
 import 'catalogue/catalogue.dart';
@@ -31,7 +30,7 @@ class SidebarKeyNotifier extends Notifier<String> {
 
   void set(String key) {
     if (key.sidebarVmName != null) {
-      ref.read(vmVisitedProvider(key).notifier).state = true;
+      ref.read(vmVisitedProvider(key).notifier).setVisited();
     }
     state = key;
   }
@@ -41,9 +40,55 @@ final sidebarKeyProvider = NotifierProvider<SidebarKeyNotifier, String>(
   SidebarKeyNotifier.new,
 );
 
-final vmVisitedProvider = StateProvider.family<bool, String>((_, __) => false);
-final sidebarExpandedProvider = StateProvider((_) => false);
-final sidebarPushContentProvider = StateProvider((_) => false);
+class VmVisitedNotifier extends Notifier<bool> {
+  VmVisitedNotifier(this.arg);
+  final String arg;
+
+  @override
+  bool build() {
+    return false;
+  }
+
+  void setVisited() {
+    state = true;
+  }
+}
+
+final vmVisitedProvider =
+    NotifierProvider.family<VmVisitedNotifier, bool, String>(
+  VmVisitedNotifier.new,
+);
+
+class SidebarExpandedNotifier extends Notifier<bool> {
+  @override
+  bool build() {
+    return false;
+  }
+
+  void setExpanded(bool value) {
+    state = value;
+  }
+}
+
+final sidebarExpandedProvider = NotifierProvider<SidebarExpandedNotifier, bool>(
+  SidebarExpandedNotifier.new,
+);
+
+class SidebarPushContentNotifier extends Notifier<bool> {
+  @override
+  bool build() {
+    return false;
+  }
+
+  void setPushContent(bool value) {
+    state = value;
+  }
+}
+
+final sidebarPushContentProvider =
+    NotifierProvider<SidebarPushContentNotifier, bool>(
+  SidebarPushContentNotifier.new,
+);
 Timer? sidebarExpandTimer;
 
 class SideBar extends ConsumerWidget {
@@ -113,7 +158,7 @@ class SideBar extends ConsumerWidget {
         ),
         onPressed: () => ref
             .read(sidebarPushContentProvider.notifier)
-            .update((state) => !state),
+            .setPushContent(!pushContent),
       ),
     );
 
@@ -169,13 +214,13 @@ class SideBar extends ConsumerWidget {
         if (pushContent) return;
         sidebarExpandTimer?.cancel();
         sidebarExpandTimer = Timer(const Duration(milliseconds: 200), () {
-          ref.read(sidebarExpandedProvider.notifier).state = true;
+          ref.read(sidebarExpandedProvider.notifier).setExpanded(true);
         });
       },
       onExit: (_) {
         if (pushContent) return;
         sidebarExpandTimer?.cancel();
-        ref.read(sidebarExpandedProvider.notifier).state = false;
+        ref.read(sidebarExpandedProvider.notifier).setExpanded(false);
       },
       child: AnimatedContainer(
         duration: SideBar.animationDuration,

src/client/gui/lib/vm_details/terminal.dart

@@ -8,7 +8,6 @@ import 'package:dartssh2/dartssh2.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
-import 'package:flutter_riverpod/legacy.dart';
 import 'package:flutter_svg/flutter_svg.dart';
 import 'package:synchronized/synchronized.dart';
 import 'package:xterm/xterm.dart';
@@ -19,12 +18,28 @@ import '../platform/platform.dart';
 import '../providers.dart';
 import '../vm_action.dart';
 
-final runningShellsProvider = StateProvider.autoDispose.family<int, String>((
-  _,
-  __,
-) {
-  return 0;
-});
+class RunningShellsNotifier extends Notifier<int> {
+  RunningShellsNotifier(this.arg);
+  final String arg;
+
+  @override
+  int build() {
+    return 0;
+  }
+
+  void increment() {
+    state = state + 1;
+  }
+
+  void decrement() {
+    state = state - 1;
+  }
+}
+
+final runningShellsProvider =
+    NotifierProvider.autoDispose.family<RunningShellsNotifier, int, String>(
+  RunningShellsNotifier.new,
+);
 
 class ShellId {
   final int id;
@@ -123,9 +138,7 @@ class TerminalNotifier extends Notifier<Terminal?> {
       errorsAreFatal: true,
     );
 
-    ref.read(runningShellsProvider(arg.vmName).notifier).update((state) {
-      return state + 1;
-    });
+    ref.read(runningShellsProvider(arg.vmName).notifier).increment();
     return terminal;
   }
 
@@ -141,9 +154,7 @@ class TerminalNotifier extends Notifier<Terminal?> {
   void _dispose() {
     isolate?.kill(priority: Isolate.immediate);
     if (isolate != null) {
-      ref
-          .read(runningShellsProvider(arg.vmName).notifier)
-          .update((state) => state - 1);
+      ref.read(runningShellsProvider(arg.vmName).notifier).decrement();
     }
     isolate = null;
   }

src/client/gui/lib/vm_table/header_selection.dart

@@ -1,13 +1,24 @@
 import 'package:built_collection/built_collection.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
-import 'package:flutter_riverpod/legacy.dart';
 import 'package:flutter_svg/flutter_svg.dart';
 
 import 'vm_table_headers.dart';
 
-final enabledHeadersProvider = StateProvider(
-  (_) => {for (final h in headers) h.name: true}.build(),
+class EnabledHeadersNotifier extends Notifier<BuiltMap<String, bool>> {
+  @override
+  BuiltMap<String, bool> build() {
+    return {for (final h in headers) h.name: true}.build();
+  }
+
+  void toggleHeader(String name, bool isSelected) {
+    state = state.rebuild((set) => set[name] = isSelected);
+  }
+}
+
+final enabledHeadersProvider =
+    NotifierProvider<EnabledHeadersNotifier, BuiltMap<String, bool>>(
+  EnabledHeadersNotifier.new,
 );
 
 class HeaderSelectionTile extends ConsumerWidget {
@@ -25,7 +36,7 @@ class HeaderSelectionTile extends ConsumerWidget {
       value: enabledHeaders[name],
       onChanged: (isSelected) => ref
           .read(enabledHeadersProvider.notifier)
-          .update((state) => state.rebuild((set) => set[name] = isSelected!)),
+          .toggleHeader(name, isSelected!),
     );
   }
 }

src/client/gui/lib/vm_table/search_box.dart

@@ -1,8 +1,20 @@
 import 'package:flutter/material.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
-import 'package:flutter_riverpod/legacy.dart';
 
-final searchNameProvider = StateProvider((_) => '');
+class SearchNameNotifier extends Notifier<String> {
+  @override
+  String build() {
+    return '';
+  }
+
+  void set(String value) {
+    state = value;
+  }
+}
+
+final searchNameProvider = NotifierProvider<SearchNameNotifier, String>(
+  SearchNameNotifier.new,
+);
 
 class SearchBox extends ConsumerWidget {
   const SearchBox({super.key});
@@ -16,7 +28,7 @@ class SearchBox extends ConsumerWidget {
           hintText: 'Search instances...',
           suffixIcon: Icon(Icons.search),
         ),
-        onChanged: (name) => ref.read(searchNameProvider.notifier).state = name,
+        onChanged: (name) => ref.read(searchNameProvider.notifier).set(name),
       ),
     );
   }

src/client/gui/lib/vm_table/vms.dart

@@ -3,7 +3,6 @@ import 'package:built_collection/built_collection.dart';
 import 'package:collection/collection.dart';
 import 'package:flutter/material.dart' hide Table, Switch;
 import 'package:flutter_riverpod/flutter_riverpod.dart';
-import 'package:flutter_riverpod/legacy.dart';
 
 import '../catalogue/catalogue.dart';
 import '../providers.dart';
@@ -16,7 +15,20 @@ import 'search_box.dart';
 import 'table.dart';
 import 'vm_table_headers.dart';
 
-final runningOnlyProvider = StateProvider((_) => false);
+class RunningOnlyNotifier extends Notifier<bool> {
+  @override
+  bool build() {
+    return false;
+  }
+
+  void set(bool value) {
+    state = value;
+  }
+}
+
+final runningOnlyProvider = NotifierProvider<RunningOnlyNotifier, bool>(
+  RunningOnlyNotifier.new,
+);
 
 final selectedVmsProvider =
     NotifierProvider<SelectedVmsNotifier, BuiltSet<String>>(
@@ -82,7 +94,7 @@ class Vms extends ConsumerWidget {
         Switch(
           label: 'Show running instances only',
           value: runningOnly,
-          onChanged: (v) => ref.read(runningOnlyProvider.notifier).state = v,
+          onChanged: (v) => ref.read(runningOnlyProvider.notifier).set(v),
         ),
         const Spacer(),
         const SearchBox(),