Set missing SyncError codes to Unknown (#1052)

* Set missing SyncError codes to Unknown * Update changelog * Update CHANGELOG.md Co-authored-by: blagoev <lubo@blagoev.com> * Code review changes * Fix changelog * Change API doc Co-authored-by: blagoev <lubo@blagoev.com>
realm · Dec 2, 2022 · 669ea09 · 669ea09
1 parent e1d0fa5
commit 669ea09
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 31 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@
 * Support setting `maxNumberOfActiveVersions` when creating a `Configuration`. ([#1036](https://github.com/realm/realm-dart/pull/1036))
 * Add List.move extension method that moves an element from one index to another. Delegates to ManagedRealmList.move for managed lists. This allows notifications to correctly report moves, as opposed to reporting moves as deletes + inserts. ([#1037](https://github.com/realm/realm-dart/issues/1037))
 * Support setting `shouldDeleteIfMigrationNeeded` when creating a `Configuration.local`. ([#1049](https://github.com/realm/realm-dart/issues/1049))
+* Add `unknown` error code to all SyncErrors: `SyncSessionErrorCode.unknown`, `SyncConnectionErrorCode.unknown`, `SyncClientErrorCode.unknown`, `GeneralSyncErrorCode.unknown`. Use `unknown` error code instead of throwing a RealmError. ([#1052](https://github.com/realm/realm-dart/pull/1052))
 
 ### Fixed
 * Support mapping into `SyncSessionErrorCode` for "Compensating write" with error code 231. ([#1022](https://github.com/realm/realm-dart/pull/1022))

diff --git a/common/lib/src/realm_types.dart b/common/lib/src/realm_types.dart
@@ -250,17 +250,15 @@ enum SyncClientErrorCode {
   httpTunnelFailed(131),
 
   /// A fatal error was encountered which prevents completion of a client reset
-  autoClientResetFailure(132);
+  autoClientResetFailure(132),
+
+  /// Unknown Sync client error code
+  unknown(9999);
 
   static final Map<int, SyncClientErrorCode> _valuesMap = {for (var value in SyncClientErrorCode.values) value.code: value};
 
   static SyncClientErrorCode fromInt(int code) {
-    final mappedCode = SyncClientErrorCode._valuesMap[code];
-    if (mappedCode == null) {
-      throw RealmError("Unknown SyncClientErrorCode");
-    }
-
-    return mappedCode;
+    return SyncClientErrorCode._valuesMap[code] ?? SyncClientErrorCode.unknown;
   }
 
   final int code;
@@ -316,17 +314,15 @@ enum SyncConnectionErrorCode {
   switchToFlxSync(113),
 
   /// Connected with wrong wire protocol - should switch to PBS
-  switchToPbs(114);
+  switchToPbs(114),
+
+  /// Unknown Sync connection error code
+  unknown(9999);
 
   static final Map<int, SyncConnectionErrorCode> _valuesMap = {for (var value in SyncConnectionErrorCode.values) value.code: value};
 
   static SyncConnectionErrorCode fromInt(int code) {
-    final mappedCode = SyncConnectionErrorCode._valuesMap[code];
-    if (mappedCode == null) {
-      throw RealmError("Unknown SyncConnectionErrorCode");
-    }
-
-    return mappedCode;
+    return SyncConnectionErrorCode._valuesMap[code] ?? SyncConnectionErrorCode.unknown;
   }
 
   final int code;
@@ -430,17 +426,15 @@ enum SyncSessionErrorCode {
 
   /// Client attempted a write that is disallowed by permissions, or modifies an object
   /// outside the current query, and the server undid the modification (UPLOAD)
-  compensatingWrite(231);
+  compensatingWrite(231),
+
+  /// Unknown Sync session error code
+  unknown(9999);
 
   static final Map<int, SyncSessionErrorCode> _valuesMap = {for (var value in SyncSessionErrorCode.values) value.code: value};
 
   static SyncSessionErrorCode fromInt(int code) {
-    final mappedCode = SyncSessionErrorCode._valuesMap[code];
-    if (mappedCode == null) {
-      throw RealmError("Unknown SyncSessionErrorCode");
-    }
-
-    return mappedCode;
+    return SyncSessionErrorCode._valuesMap[code] ?? SyncSessionErrorCode.unknown;
   }
 
   final int code;

diff --git a/lib/src/configuration.dart b/lib/src/configuration.dart
@@ -114,7 +114,7 @@ abstract class Configuration implements Finalizable {
     String? path,
     this.fifoFilesFallbackPath,
     this.encryptionKey,
-    this.maxNumberOfActiveVersions
+    this.maxNumberOfActiveVersions,
   }) {
     _validateEncryptionKey(encryptionKey);
     this.path = path ?? _path.join(_path.dirname(_defaultPath), _path.basename(defaultRealmName));
@@ -228,7 +228,7 @@ abstract class Configuration implements Finalizable {
         path: path,
         fifoFilesFallbackPath: fifoFilesFallbackPath,
         encryptionKey: encryptionKey,
-        maxNumberOfActiveVersions: maxNumberOfActiveVersions
+        maxNumberOfActiveVersions: maxNumberOfActiveVersions,
       );
 
   void _validateEncryptionKey(List<int>? key) {
@@ -264,7 +264,7 @@ class LocalConfiguration extends Configuration {
     this.shouldCompactCallback,
     this.migrationCallback,
     super.maxNumberOfActiveVersions,
-    this.shouldDeleteIfMigrationNeeded = false
+    this.shouldDeleteIfMigrationNeeded = false,
   }) : super._();
 
   /// The schema version used to open the `Realm`. If omitted, the default value is `0`.
@@ -743,18 +743,13 @@ class GeneralSyncError extends SyncError {
 
 /// General sync error codes
 enum GeneralSyncErrorCode {
-  // A general sync error code
+  /// Unknown Sync error code
   unknown(9999);
 
   static final Map<int, GeneralSyncErrorCode> _valuesMap = {for (var value in GeneralSyncErrorCode.values) value.code: value};
 
   static GeneralSyncErrorCode fromInt(int code) {
-    final mappedCode = GeneralSyncErrorCode._valuesMap[code];
-    if (mappedCode == null) {
-      throw RealmError("Unknown GeneralSyncErrorCode");
-    }
-
-    return mappedCode;
+    return GeneralSyncErrorCode._valuesMap[code] ?? GeneralSyncErrorCode.unknown;
   }
 
   final int code;