Allow a custom equals parameter for observable collections

amondnet · amondnet · commit 076d509b45ac · 2023-12-15T18:51:09.000+09:00
diff --git a/mobx/CHANGELOG.md b/mobx/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 2.2.4
+
+- Allow a custom equals parameter for observable collections( ObservableList, ObservableMap, ObservableSet ) - [@amondnet](https://github.com/amondnet)
+
 ## 2.2.3
 
 - Avoid unnecessary observable notifications of `@observable` `Iterable` or `Map` fields of Stores by [@amondnet](https://github.com/amondnet)  in [#951](https://github.com/mobxjs/mobx.dart/pull/951)
diff --git a/mobx/lib/src/api/observable_collections.dart b/mobx/lib/src/api/observable_collections.dart
@@ -3,6 +3,7 @@ import 'dart:math';
 
 import 'package:meta/meta.dart';
 import 'package:mobx/mobx.dart';
+import 'package:mobx/src/utils.dart';
 
 part 'observable_collections/observable_list.dart';
 part 'observable_collections/observable_map.dart';
diff --git a/mobx/lib/src/api/observable_collections/observable_list.dart b/mobx/lib/src/api/observable_collections/observable_list.dart
@@ -25,20 +25,23 @@ class ObservableList<T>
         ListMixin<T>
     implements
         Listenable<ListChange<T>> {
-  ObservableList({ReactiveContext? context, String? name})
-      : this._wrap(context, _observableListAtom<T>(context, name), []);
+  ObservableList(
+      {ReactiveContext? context, String? name, EqualityComparer<T>? equals})
+      : this._wrap(context, _observableListAtom<T>(context, name), [], equals);
 
   ObservableList.of(Iterable<T> elements,
-      {ReactiveContext? context, String? name})
+      {ReactiveContext? context, String? name, EqualityComparer<T>? equals})
       : this._wrap(context, _observableListAtom<T>(context, name),
-            List<T>.of(elements, growable: true));
+            List<T>.of(elements, growable: true), equals);
 
-  ObservableList._wrap(ReactiveContext? context, this._atom, this._list)
+  ObservableList._wrap(
+      ReactiveContext? context, this._atom, this._list, this._equals)
       : _context = context ?? mainContext;
 
   final ReactiveContext _context;
   final Atom _atom;
   final List<T> _list;
+  final EqualityComparer<T>? _equals;
 
   List<T> get nonObservableInner => _list;
 
@@ -96,7 +99,7 @@ class ObservableList<T>
     _context.conditionallyRunInAction(() {
       final oldValue = _list[index];
 
-      if (oldValue != value) {
+      if (_areEquals(oldValue, value)) {
         _list[index] = value;
         _notifyElementUpdate(index, value, oldValue);
       }
@@ -167,10 +170,18 @@ class ObservableList<T>
   }
 
   @override
-  Map<int, T> asMap() => ObservableMap._wrap(_context, _list.asMap(), _atom);
+  Map<int, T> asMap() =>
+      ObservableMap._wrap(_context, _list.asMap(), _atom, _equals);
 
   @override
-  List<R> cast<R>() => ObservableList._wrap(_context, _atom, _list.cast<R>());
+  List<R> cast<R>([EqualityComparer<R>? equals]) => ObservableList._wrap(
+      _context,
+      _atom,
+      _list.cast<R>(),
+      equals ??
+          (_equals != null
+              ? (R? a, R? b) => _equals!(a as T?, b as T?)
+              : null));
 
   @override
   List<T> toList({bool growable = true}) {
@@ -184,7 +195,7 @@ class ObservableList<T>
   set first(T value) {
     _context.conditionallyRunInAction(() {
       final oldValue = _list.first;
-      if (oldValue != value) {
+      if (_areEquals(oldValue, value)) {
         _list.first = value;
         _notifyElementUpdate(0, value, oldValue);
       }
@@ -376,7 +387,7 @@ class ObservableList<T>
         for (var i = 0; i < _list.length; ++i) {
           final oldValue = oldList[i];
           final newValue = _list[i];
-          if (newValue != oldValue) {
+          if (_areEquals(oldValue, newValue)) {
             changes.add(ElementChange(
                 index: i, oldValue: oldValue, newValue: newValue));
           }
@@ -398,7 +409,7 @@ class ObservableList<T>
         for (var i = 0; i < _list.length; ++i) {
           final oldValue = oldList[i];
           final newValue = _list[i];
-          if (newValue != oldValue) {
+          if (_areEquals(oldValue, newValue)) {
             changes.add(ElementChange(
                 index: i, oldValue: oldValue, newValue: newValue));
           }
@@ -456,6 +467,14 @@ class ObservableList<T>
 
     _listeners.notifyListeners(change);
   }
+
+  bool _areEquals(T? a, T? b) {
+    if (_equals != null) {
+      return _equals!(a, b);
+    } else {
+      return equatable(a, b);
+    }
+  }
 }
 
 typedef ListChangeListener<TNotification> = void Function(
@@ -520,4 +539,4 @@ class ListChange<T> {
 /// Used during testing for wrapping a regular `List<T>` as an `ObservableList<T>`
 @visibleForTesting
 ObservableList<T> wrapInObservableList<T>(Atom atom, List<T> list) =>
-    ObservableList._wrap(mainContext, atom, list);
+    ObservableList._wrap(mainContext, atom, list, null);
diff --git a/mobx/lib/src/api/observable_collections/observable_map.dart b/mobx/lib/src/api/observable_collections/observable_map.dart
@@ -26,37 +26,45 @@ class ObservableMap<K, V>
         MapMixin<K, V>
     implements
         Listenable<MapChange<K, V>> {
-  ObservableMap({ReactiveContext? context, String? name})
+  ObservableMap(
+      {ReactiveContext? context, String? name, EqualityComparer<V>? equals})
       : _context = context ?? mainContext,
         _atom = _observableMapAtom<K, V>(context, name),
-        _map = <K, V>{};
+        _map = <K, V>{},
+        _equals = equals;
 
-  ObservableMap.of(Map<K, V> other, {ReactiveContext? context, String? name})
+  ObservableMap.of(Map<K, V> other,
+      {ReactiveContext? context, String? name, EqualityComparer<V>? equals})
       : _context = context ?? mainContext,
         _atom = _observableMapAtom<K, V>(context, name),
-        _map = Map.of(other);
+        _map = Map.of(other),
+        _equals = equals;
 
   ObservableMap.linkedHashMapFrom(Map<K, V> other,
-      {ReactiveContext? context, String? name})
+      {ReactiveContext? context, String? name, EqualityComparer<V>? equals})
       : _context = context ?? mainContext,
         _atom = _observableMapAtom<K, V>(context, name),
-        _map = LinkedHashMap.from(other);
+        _map = LinkedHashMap.from(other),
+        _equals = equals;
 
   ObservableMap.splayTreeMapFrom(Map<K, V> other,
       {int Function(K, K)? compare,
       // ignore: avoid_annotating_with_dynamic
       bool Function(dynamic)? isValidKey,
       ReactiveContext? context,
-      String? name})
+      String? name,
+      EqualityComparer<V>? equals})
       : _context = context ?? mainContext,
         _atom = _observableMapAtom<K, V>(context, name),
-        _map = SplayTreeMap.from(other, compare, isValidKey);
+        _map = SplayTreeMap.from(other, compare, isValidKey),
+        _equals = equals;
 
-  ObservableMap._wrap(this._context, this._map, this._atom);
+  ObservableMap._wrap(this._context, this._map, this._atom, this._equals);
 
   final ReactiveContext _context;
   final Atom _atom;
   final Map<K, V> _map;
+  final EqualityComparer<V>? _equals;
 
   Map<K, V> get nonObservableInner => _map;
 
@@ -94,7 +102,7 @@ class ObservableMap<K, V>
         }
       }
 
-      if (!_map.containsKey(key) || value != oldValue) {
+      if (!_map.containsKey(key) || _areEquals(value, oldValue)) {
         _map[key] = value;
         if (type == 'update') {
           _reportUpdate(key, value, oldValue);
@@ -127,8 +135,15 @@ class ObservableMap<K, V>
   Iterable<K> get keys => MapKeysIterable(_map.keys, _atom);
 
   @override
-  Map<RK, RV> cast<RK, RV>() =>
-      ObservableMap._wrap(_context, super.cast(), _atom);
+  Map<RK, RV> cast<RK, RV>([EqualityComparer<RV>? equals]) =>
+      ObservableMap._wrap(
+          _context,
+          super.cast(),
+          _atom,
+          equals ??
+              (_equals == null
+                  ? null
+                  : (RV? a, RV? b) => _equals!(a as V?, b as V?)));
 
   @override
   V? remove(Object? key) {
@@ -231,13 +246,21 @@ class ObservableMap<K, V>
     }
     return _listeners.add(listener);
   }
+
+  bool _areEquals(V? a, V? b) {
+    if (_equals != null) {
+      return _equals!(a, b);
+    } else {
+      return equatable(a, b);
+    }
+  }
 }
 
 /// A convenience method to wrap the standard `Map<K,V>` in an `ObservableMap<K,V>`.
 /// This is mostly to aid in testing.
 @visibleForTesting
 ObservableMap<K, V> wrapInObservableMap<K, V>(Atom atom, Map<K, V> map) =>
-    ObservableMap._wrap(mainContext, map, atom);
+    ObservableMap._wrap(mainContext, map, atom, null);
 
 typedef MapChangeListener<K, V> = void Function(MapChange<K, V>);
 
diff --git a/mobx/lib/src/api/observable_collections/observable_set.dart b/mobx/lib/src/api/observable_collections/observable_set.dart
@@ -21,30 +21,36 @@ class ObservableSet<T>
         SetMixin<T>
     implements
         Listenable<SetChange<T>> {
-  ObservableSet({ReactiveContext? context, String? name})
-      : this._(context ?? mainContext, <T>{}, name);
+  ObservableSet(
+      {ReactiveContext? context, String? name, EqualityComparer<T>? equals})
+      : this._(context ?? mainContext, <T>{}, name, equals);
 
-  ObservableSet.of(Iterable<T> other, {ReactiveContext? context, String? name})
-      : this._(context ?? mainContext, Set<T>.of(other), name);
+  ObservableSet.of(Iterable<T> other,
+      {ReactiveContext? context, String? name, EqualityComparer<T>? equals})
+      : this._(context ?? mainContext, Set<T>.of(other), name, equals);
 
   ObservableSet.splayTreeSetFrom(Iterable<T> other,
       {int Function(T, T)? compare,
       // ignore:avoid_annotating_with_dynamic
       bool Function(dynamic)? isValidKey,
       ReactiveContext? context,
-      String? name})
+      String? name,
+      EqualityComparer<T>? equals})
       : this._(context ?? mainContext,
-            SplayTreeSet.of(other, compare, isValidKey), name);
+            SplayTreeSet.of(other, compare, isValidKey), name, equals);
 
-  ObservableSet._wrap(this._context, this._atom, this._set);
+  ObservableSet._wrap(this._context, this._atom, this._set, this._equals);
 
-  ObservableSet._(this._context, Set<T> wrapped, String? name)
+  ObservableSet._(
+      this._context, Set<T> wrapped, String? name, EqualityComparer<T>? equals)
       : _atom = _observableSetAtom(_context, name),
-        _set = wrapped;
+        _set = wrapped,
+        _equals = equals;
 
   final ReactiveContext _context;
   final Atom _atom;
   final Set<T> _set;
+  final EqualityComparer<T>? _equals;
 
   Set<T> get nonObservableInner => _set;
 
@@ -138,7 +144,14 @@ class ObservableSet<T>
   }
 
   @override
-  Set<R> cast<R>() => ObservableSet<R>._wrap(_context, _atom, _set.cast<R>());
+  Set<R> cast<R>([EqualityComparer<R>? equals]) => ObservableSet<R>._wrap(
+      _context,
+      _atom,
+      _set.cast<R>(),
+      equals ??
+          (_equals == null
+              ? null
+              : (R? a, R? b) => _equals!(a as T?, b as T?)));
 
   @override
   Set<T> toSet() {
@@ -180,13 +193,21 @@ class ObservableSet<T>
       value: value,
     ));
   }
+
+  bool _areEquals(T? a, T? b) {
+    if (_equals != null) {
+      return _equals!(a, b);
+    } else {
+      return equatable(a, b);
+    }
+  }
 }
 
 /// A convenience method used during unit testing. It creates an [ObservableSet] with a custom instance
 /// of an [Atom]
 @visibleForTesting
 ObservableSet<T> wrapInObservableSet<T>(Atom atom, Set<T> set) =>
-    ObservableSet._wrap(mainContext, atom, set);
+    ObservableSet._wrap(mainContext, atom, set, null);
 
 /// An internal iterator used to ensure that every read is tracked as part of the
 /// MobX reactivity system.
diff --git a/mobx/lib/version.dart b/mobx/lib/version.dart
@@ -1,4 +1,4 @@
 // Generated via set_version.dart. !!!DO NOT MODIFY BY HAND!!!
 
 /// The current version as per `pubspec.yaml`.
-const version = '2.2.3';
+const version = '2.2.4';
