settings: Avoid redundant updates in setBool

Author: sm-sayedi

lib/model/settings.dart

@@ -376,8 +376,13 @@ class GlobalSettingsStore extends ChangeNotifier {
   /// A value of null means the setting will revert to following
   /// the app's default.
   ///
+  /// If [value] equals the setting's current value, the database operation
+  /// and [notifyListeners] are skipped.
+  ///
   /// See also [getBool].
   Future<void> setBool(BoolGlobalSetting setting, bool? value) async {
+    if (value == _boolData[setting]) return;
+
     await _backend.doSetBoolGlobalSetting(setting, value);
     if (value == null) {
       _boolData.remove(setting);

test/model/settings_test.dart

@@ -125,5 +125,66 @@ void main() {
         .isFalse();
       assert(!BoolGlobalSetting.placeholderIgnore.default_);
     });
+
+    group('set avoids redundant updates', () {
+      int notifiedCount = 0;
+      tearDown(() => notifiedCount = 0);
+
+      test('null to null -> no update', () async {
+        final globalSettings = eg.globalStore(boolGlobalSettings: {}).settings;
+        globalSettings.addListener(() => notifiedCount++);
+
+        await globalSettings.setBool(BoolGlobalSetting.placeholderIgnore, null);
+        check(notifiedCount).equals(0);
+      });
+
+      test('true to true -> no update', () async {
+        final globalSettings = eg.globalStore(boolGlobalSettings: {
+          BoolGlobalSetting.placeholderIgnore: true,
+        }).settings;
+        globalSettings.addListener(() => notifiedCount++);
+
+        await globalSettings.setBool(BoolGlobalSetting.placeholderIgnore, true);
+        check(notifiedCount).equals(0);
+      });
+
+      test('false to false -> no update', () async {
+        final globalSettings = eg.globalStore(boolGlobalSettings: {
+          BoolGlobalSetting.placeholderIgnore: false,
+        }).settings;
+        globalSettings.addListener(() => notifiedCount++);
+
+        await globalSettings.setBool(BoolGlobalSetting.placeholderIgnore, false);
+        check(notifiedCount).equals(0);
+      });
+
+      test('null to false -> does the update', () async {
+        final globalSettings = eg.globalStore(boolGlobalSettings: {}).settings;
+        globalSettings.addListener(() => notifiedCount++);
+
+        await globalSettings.setBool(BoolGlobalSetting.placeholderIgnore, false);
+        check(notifiedCount).equals(1);
+      });
+
+      test('true to null -> does the update', () async {
+        final globalSettings = eg.globalStore(boolGlobalSettings: {
+          BoolGlobalSetting.placeholderIgnore: true,
+        }).settings;
+        globalSettings.addListener(() => notifiedCount++);
+
+        await globalSettings.setBool(BoolGlobalSetting.placeholderIgnore, null);
+        check(notifiedCount).equals(1);
+      });
+
+      test('false to true -> does the update', () async {
+        final globalSettings = eg.globalStore(boolGlobalSettings: {
+          BoolGlobalSetting.placeholderIgnore: false,
+        }).settings;
+        globalSettings.addListener(() => notifiedCount++);
+
+        await globalSettings.setBool(BoolGlobalSetting.placeholderIgnore, true);
+        check(notifiedCount).equals(1);
+      });
+    });
   });
 }