fix: Setting atomic operation on Parse Object returns operation instead of prospective value (#860)

Author: Nidal-Bakir

packages/dart/CHANGELOG.md

@@ -1,12 +1,14 @@
-## [5.0.0](https://github.com/parse-community/Parse-SDK-Flutter/compare/dart-4.0.2...dart-5.0.0) (UNRELEASED)
+## [5.0.0](https://github.com/parse-community/Parse-SDK-Flutter/compare/dart-4.0.2...dart-5.0.0) (2023-05-14)
 
 ### BREAKING CHANGES
 
-* The minimum required Dart SDK version is 2.18.0 ([#867](https://github.com/parse-community/Parse-SDK-Flutter/pull/867))
+* The minimum required Dart SDK version is 2.18.0. ([#867](https://github.com/parse-community/Parse-SDK-Flutter/pull/867))
+* Performing an atomic update on a key of a Parse Object now returns the prospective value, instead of a map of the operation that will be sent to the server; for example for a Parse Object `obj` with a key `count`, the atomic update `obj.setIncrement('count', 1);` previously returned the value `{__op: Increment, amount: 1}` but now returns the prospective result of the operation, which would be `1` if the key's previous value was `0`. ([#860](https://github.com/parse-community/Parse-SDK-Flutter/pull/860))
 
 ### Bug Fixes
 
 * Incorrect Dart and Flutter SDKs compatibility range ([#867](https://github.com/parse-community/Parse-SDK-Flutter/pull/867))
+* Setting atomic operation on Parse Object returns operation instead of prospective value ([#860](https://github.com/parse-community/Parse-SDK-Flutter/pull/860))
 
 ## [4.0.2](https://github.com/parse-community/Parse-SDK-Flutter/compare/dart-4.0.1...dart-4.0.2) (2023-03-23)
 

packages/dart/lib/parse_server_sdk.dart

@@ -2,9 +2,10 @@ library flutter_parse_sdk;
 
 import 'dart:async';
 import 'dart:convert';
-import 'package:universal_io/io.dart';
 import 'dart:math';
 import 'dart:typed_data';
+
+import 'package:collection/collection.dart';
 import 'package:dio/dio.dart';
 import 'package:meta/meta.dart';
 import 'package:mime_type/mime_type.dart';
@@ -14,6 +15,7 @@ import 'package:sembast/sembast_io.dart';
 import 'package:sembast_web/sembast_web.dart';
 import 'package:timezone/data/latest.dart' as tz;
 import 'package:timezone/timezone.dart' as tz;
+import 'package:universal_io/io.dart';
 import 'package:uuid/uuid.dart';
 import 'package:web_socket_channel/web_socket_channel.dart';
 import 'package:xxtea/xxtea.dart';
@@ -34,20 +36,30 @@ part 'src/network/parse_connectivity.dart';
 part 'src/network/parse_live_query.dart';
 part 'src/network/parse_query.dart';
 part 'src/objects/parse_acl.dart';
+part 'src/objects/parse_array.dart';
 part 'src/objects/parse_base.dart';
 part 'src/objects/parse_cloneable.dart';
 part 'src/objects/parse_config.dart';
 part 'src/objects/parse_error.dart';
 part 'src/objects/parse_file.dart';
+part 'src/objects/parse_number.dart';
 part 'src/objects/parse_file_base.dart';
 part 'src/objects/parse_file_web.dart';
 part 'src/objects/parse_function.dart';
 part 'src/objects/parse_geo_point.dart';
 part 'src/objects/parse_installation.dart';
-part 'src/objects/parse_merge.dart';
 part 'src/objects/parse_object.dart';
+part 'src/objects/parse_exception.dart';
+part 'src/objects/parse_operation/parse_add_operation.dart';
+part 'src/objects/parse_operation/parse_add_relation_operation.dart';
+part 'src/objects/parse_operation/parse_add_unique_operation.dart';
+part 'src/objects/parse_operation/parse_increment_operation.dart';
+part 'src/objects/parse_operation/parse_operation.dart';
+part 'src/objects/parse_operation/parse_remove_operation.dart';
+part 'src/objects/parse_operation/parse_remove_relation_operation.dart';
 part 'src/objects/parse_relation.dart';
 part 'src/objects/parse_response.dart';
+part 'src/objects/parse_save_state_aware_child.dart';
 part 'src/objects/parse_session.dart';
 part 'src/objects/parse_user.dart';
 part 'src/objects/response/parse_error_response.dart';
@@ -66,6 +78,7 @@ part 'src/utils/parse_live_list.dart';
 part 'src/utils/parse_logger.dart';
 part 'src/utils/parse_login_helpers.dart';
 part 'src/utils/parse_utils.dart';
+part 'src/utils/valuable.dart';
 
 class Parse {
   bool _hasBeenInitialized = false;

packages/dart/lib/src/base/parse_constants.dart

@@ -1,7 +1,7 @@
 part of flutter_parse_sdk;
 
 // Library
-const String keySdkVersion = '4.0.2';
+const String keySdkVersion = '5.0.0';
 const String keyLibraryName = 'Flutter Parse SDK';
 
 // End Points

packages/dart/lib/src/network/parse_query.dart

@@ -50,6 +50,12 @@ class QueryBuilder<T extends ParseObject> {
   T object;
   List<MapEntry<String, dynamic>> queries = <MapEntry<String, dynamic>>[];
   final Map<String, dynamic> limiters = <String, dynamic>{};
+  final Map<String, dynamic> extraOptions = <String, dynamic>{};
+
+  /// Used by ParseRelation getQuery()
+  void setRedirectClassNameForKey(String key) {
+    extraOptions['redirectClassNameForKey'] = key;
+  }
 
   /// Adds a limit to amount of results return from Parse
   void setLimit(int limit) {
@@ -408,7 +414,7 @@ class QueryBuilder<T extends ParseObject> {
   /// Builds the query for Parse
   String buildQuery() {
     queries = _checkForMultipleColumnInstances(queries);
-    return 'where={${buildQueries(queries)}}${getLimiters(limiters)}';
+    return 'where={${buildQueries(queries)}}${getLimiters(limiters)}${getExtraOptions(extraOptions)}';
   }
 
   /// Builds the query relational for Parse
@@ -528,6 +534,15 @@ class QueryBuilder<T extends ParseObject> {
     return result;
   }
 
+  /// Adds extra options to the query
+  String getExtraOptions(Map<String, dynamic> map) {
+    String result = '';
+    map.forEach((String key, dynamic value) {
+      result = '$result&$key=$value';
+    });
+    return result;
+  }
+
   /// Adds the limiters to the query relational, i.e. skip=10, limit=10
   String getLimitersRelational(Map<String, dynamic> map) {
     String result = '';

packages/dart/lib/src/objects/parse_array.dart

@@ -0,0 +1,121 @@
+part of flutter_parse_sdk;
+
+class _ParseArray implements _Valuable<List>, _ParseSaveStateAwareChild {
+  _ParseArray({this.setMode = false});
+
+  bool setMode;
+
+  List _savedArray = [];
+  List estimatedArray = [];
+
+  set savedArray(List array) {
+    _savedArray = array.toList();
+    estimatedArray = array.toList();
+  }
+
+  List get savedArray => _savedArray;
+
+  _ParseArrayOperation? lastPreformedOperation;
+
+  _ParseArray preformArrayOperation(
+    _ParseArrayOperation arrayOperation,
+  ) {
+    arrayOperation.mergeWithPrevious(lastPreformedOperation ?? this);
+
+    lastPreformedOperation = arrayOperation;
+
+    estimatedArray = lastPreformedOperation!.value.toList();
+
+    if (setMode) {
+      lastPreformedOperation = null;
+    }
+
+    return this;
+  }
+
+  Object toJson({bool full = false}) {
+    if (full) {
+      return {
+        'className': 'ParseArray',
+        'estimatedArray': parseEncode(estimatedArray, full: full),
+        'savedArray': parseEncode(_savedArray, full: full),
+        'lastPreformedOperation': lastPreformedOperation?.toJson(full: full)
+      };
+    }
+
+    return lastPreformedOperation?.toJson(full: full) ??
+        parseEncode(estimatedArray, full: full);
+  }
+
+  factory _ParseArray.fromFullJson(Map<String, dynamic> json) {
+    return _ParseArray()
+      .._savedArray = parseDecode(json['savedArray'])
+      ..estimatedArray = parseDecode(json['estimatedArray'])
+      ..lastPreformedOperation = json['lastPreformedOperation'] == null
+          ? null
+          : _ParseArrayOperation.fromFullJson(json['lastPreformedOperation']);
+  }
+
+  @override
+  List getValue() {
+    return estimatedArray.toList();
+  }
+
+  _ParseArrayOperation? _lastPreformedOperationBeforeSaving;
+  List? _estimatedArrayBeforeSaving;
+
+  @override
+  @mustCallSuper
+  void onSaved() {
+    setMode = false;
+    _savedArray.clear();
+    _savedArray.addAll(_estimatedArrayBeforeSaving ?? []);
+    _estimatedArrayBeforeSaving = null;
+
+    if (_lastPreformedOperationBeforeSaving == lastPreformedOperation) {
+      // No operations were performed during the save process
+      lastPreformedOperation = null;
+    } else {
+      // remove the saved objects and keep the new added objects while saving
+      if (lastPreformedOperation is _ParseRemoveOperation) {
+        lastPreformedOperation?.valueForApiRequest
+            .retainWhere((e) => _savedArray.contains(e));
+      } else {
+        lastPreformedOperation?.valueForApiRequest
+            .removeWhere((e) => _savedArray.contains(e));
+      }
+    }
+
+    _lastPreformedOperationBeforeSaving = null;
+  }
+
+  @override
+  @mustCallSuper
+  void onSaving() {
+    _lastPreformedOperationBeforeSaving = lastPreformedOperation;
+    _estimatedArrayBeforeSaving = estimatedArray.toList();
+  }
+
+  @override
+  @mustCallSuper
+  void onRevertSaving() {
+    _lastPreformedOperationBeforeSaving = null;
+    _estimatedArrayBeforeSaving = null;
+  }
+
+  @override
+  @mustCallSuper
+  void onErrorSaving() {
+    _lastPreformedOperationBeforeSaving = null;
+    _estimatedArrayBeforeSaving = null;
+  }
+
+  @override
+  @mustCallSuper
+  void onClearUnsaved() {
+    estimatedArray = savedArray;
+    lastPreformedOperation = null;
+    _lastPreformedOperationBeforeSaving = null;
+    _estimatedArrayBeforeSaving = null;
+  }
+}