Add StorageException, includes errorCode as property (#31)

Author: greenrobot-team

objectbox/CHANGELOG.md

@@ -10,6 +10,7 @@
 * Allow `analyzer` with major version 5. #487
 * Generator not longer warns that it can not find the package source root if the output directory is
   the package root directory.
+* Add `StorageException` which is a `ObjectBoxException` with an `errorCode` (a `OBX_ERROR` code).
 
 ## 1.6.2 (2022-08-24)
 

objectbox/lib/src/common.dart

@@ -28,6 +28,18 @@ class ObjectBoxException implements Exception {
   String toString() => 'ObjectBoxException: $message';
 }
 
+/// ObjectBox database exception with an OBX_ERROR code.
+class StorageException extends ObjectBoxException {
+  /// OBX_ERROR code as defined in [objectbox.h of the C library](https://github.com/objectbox/objectbox-c/blob/main/include/objectbox.h).
+  final int errorCode;
+
+  /// Create with a message and OBX_ERROR code.
+  StorageException(String message, this.errorCode) : super(message);
+
+  @override
+  String toString() => 'StorageException: $message (OBX_ERROR code $errorCode)';
+}
+
 /// A unique constraint would have been violated by this database operation.
 class UniqueViolationException extends ObjectBoxException {
   /// Create a new exception.

objectbox/lib/src/native/bindings/helpers.dart

@@ -57,25 +57,33 @@ class ObjectBoxNativeError {
 
   ObjectBoxNativeError(this.code, this.message, this.context);
 
-  String get fullMessage =>
-      context == null ? '$code $message' : '$context: $code $message';
+  String get messageWithContext =>
+      context == null ? message : '$context: $message';
+
+  String get messageWithErrorCode => code == 0
+      ? messageWithContext
+      : '$messageWithContext (OBX_ERROR code $code)';
 
   Never throwMapped() {
     switch (code) {
       case OBX_ERROR_ILLEGAL_STATE:
-        throw StateError(fullMessage);
+        throw StateError(messageWithErrorCode);
       case OBX_ERROR_ILLEGAL_ARGUMENT:
       case OBX_ERROR_STD_ILLEGAL_ARGUMENT:
-        throw ArgumentError(fullMessage);
+        throw ArgumentError(messageWithErrorCode);
       case OBX_ERROR_NUMERIC_OVERFLOW:
       case OBX_ERROR_STD_OUT_OF_RANGE:
       case OBX_ERROR_STD_RANGE:
       case OBX_ERROR_STD_OVERFLOW:
-        throw RangeError(fullMessage);
+        throw RangeError(messageWithErrorCode);
       case OBX_ERROR_UNIQUE_VIOLATED:
-        throw UniqueViolationException(fullMessage);
+        throw UniqueViolationException(messageWithContext);
       default:
-        throw ObjectBoxException(fullMessage);
+        if (code == 0) {
+          throw ObjectBoxException(messageWithContext);
+        } else {
+          throw StorageException(messageWithContext, code);
+        }
     }
   }
 }

objectbox/test/box_test.dart

@@ -660,7 +660,7 @@ void main() {
                   TxMode.write, () => box.putMany(param));
             }, simpleItems()),
         throwsA(predicate((StateError e) => e.toString().contains(
-            'Bad state: failed to create transaction: 10001 Cannot start a write transaction inside a read only transaction'))));
+            'Bad state: failed to create transaction: Cannot start a write transaction inside a read only transaction (OBX_ERROR code 10001)'))));
   }, skip: notAtLeastDart2_15_0());
 
   test('failing in recursive txn', () {

objectbox/test/store_test.dart

@@ -3,6 +3,7 @@ import 'dart:io';
 import 'dart:isolate';
 
 import 'package:async/async.dart';
+import 'package:objectbox/src/native/bindings/bindings.dart';
 import 'package:objectbox/src/store.dart';
 import 'package:test/test.dart';
 
@@ -247,8 +248,9 @@ void main() {
     expect(
         () => box.put(testEntity2),
         throwsA(predicate((e) =>
-            e is ObjectBoxException &&
-            e.message == 'object put failed: 10101 Could not put')));
+            e is StorageException &&
+            e.errorCode == OBX_ERROR_DB_FULL &&
+            e.message == 'object put failed: Could not put')));
 
     // Re-open with larger size.
     store.close();