fix(android): Ensure MCUMgr errors always have a message

Frustratingly, some of the Nordic defined errors do not have messages.
This causes react native to throw "Value is null, expected a String".

Author: ball-hayden

android/src/main/java/uk/co/playerdata/reactnativemcumanager/DeviceUpgrade.kt

@@ -14,19 +14,19 @@ import io.runtime.mcumgr.exception.McuMgrException
 import java.io.IOException
 
 val UpgradeModes =
-        mapOf(
-                1 to FirmwareUpgradeManager.Mode.TEST_AND_CONFIRM,
-                2 to FirmwareUpgradeManager.Mode.CONFIRM_ONLY,
-                3 to FirmwareUpgradeManager.Mode.TEST_ONLY
-        )
+    mapOf(
+        1 to FirmwareUpgradeManager.Mode.TEST_AND_CONFIRM,
+        2 to FirmwareUpgradeManager.Mode.CONFIRM_ONLY,
+        3 to FirmwareUpgradeManager.Mode.TEST_ONLY
+    )
 
 class DeviceUpgrade(
-        private val id: String,
-        device: BluetoothDevice,
-        private val context: Context,
-        private val updateFileUri: Uri,
-        private val updateOptions: UpdateOptions,
-        private val manager: ReactNativeMcuManagerModule
+    private val id: String,
+    device: BluetoothDevice,
+    private val context: Context,
+    private val updateFileUri: Uri,
+    private val updateOptions: UpdateOptions,
+    private val manager: ReactNativeMcuManagerModule
 ) : FirmwareUpgradeCallback {
     private val TAG = "DeviceUpdate"
     private var lastNotification = -1
@@ -53,7 +53,15 @@ class DeviceUpgrade(
         dfuManager.cancel()
         disconnectDevice()
         Log.v(this.TAG, "Cancel")
-        withSafePromise { promise -> promise.reject(CodedException("Update cancelled")) }
+        withSafePromise { promise ->
+            promise.reject(
+                CodedException(
+                    "UPGRADE_CANCELLED",
+                    "Upgrade cancelled",
+                    null
+                )
+            )
+        }
     }
 
     private fun disconnectDevice() {
@@ -84,15 +92,21 @@ class DeviceUpgrade(
             e.printStackTrace()
             disconnectDevice()
             Log.v(this.TAG, "mcu exception")
-            withSafePromise { promise -> promise.reject(CodedException(e)) }
+            withSafePromise { promise ->
+                promise.reject(
+                    ReactNativeMcuMgrException.fromMcuMgrException(
+                        e
+                    )
+                )
+            }
         }
     }
 
     override fun onUpgradeStarted(controller: FirmwareUpgradeController) {}
 
     override fun onStateChanged(
-            prevState: FirmwareUpgradeManager.State,
-            newState: FirmwareUpgradeManager.State
+        prevState: FirmwareUpgradeManager.State,
+        newState: FirmwareUpgradeManager.State
     ) {
         val stateMap: Map<String, Any?> = mapOf("id" to id, "state" to newState.name)
         manager.upgradeStateCB(stateMap)
@@ -105,12 +119,26 @@ class DeviceUpgrade(
 
     override fun onUpgradeFailed(state: FirmwareUpgradeManager.State, error: McuMgrException) {
         disconnectDevice()
-        withSafePromise { promise -> promise.reject(CodedException(error)) }
+        withSafePromise { promise ->
+            promise.reject(
+                ReactNativeMcuMgrException.fromMcuMgrException(
+                    error
+                )
+            )
+        }
     }
 
     override fun onUpgradeCanceled(state: FirmwareUpgradeManager.State) {
         disconnectDevice()
-        withSafePromise { promise -> promise.reject(CodedException("Update cancelled")) }
+        withSafePromise { promise ->
+            promise.reject(
+                CodedException(
+                    "UPGRADE_CANCELLED",
+                    "Upgrade cancelled",
+                    null
+                )
+            )
+        }
     }
 
     override fun onUploadProgressChanged(bytesSent: Int, imageSize: Int, timestamp: Long) {

android/src/main/java/uk/co/playerdata/reactnativemcumanager/ReactNativeMcuManagerModule.kt

@@ -11,6 +11,7 @@ import expo.modules.kotlin.modules.ModuleDefinition
 import expo.modules.kotlin.records.Field
 import expo.modules.kotlin.records.Record
 import io.runtime.mcumgr.ble.McuMgrBleTransport
+import io.runtime.mcumgr.exception.McuMgrException
 import io.runtime.mcumgr.managers.ImageManager
 
 private const val MODULE_NAME = "ReactNativeMcuManager"
@@ -52,8 +53,8 @@ class ReactNativeMcuManagerModule : Module() {
         imageManager.erase()
 
         promise.resolve(null)
-      } catch (e: Throwable) {
-        promise.reject(CodedException(e))
+      } catch (e: McuMgrException) {
+        promise.reject(ReactNativeMcuMgrException.fromMcuMgrException(e))
       }
     }
 
@@ -87,15 +88,15 @@ class ReactNativeMcuManagerModule : Module() {
 
     AsyncFunction("runUpgrade") { id: String, promise: Promise ->
       if (!upgrades.contains(id)) {
-        promise.reject(CodedException("update ID not present"))
+        promise.reject(CodedException("UPGRADE_ID_MISSING", "Upgrade ID $id not present", null))
       }
 
       upgrades[id]!!.startUpgrade(promise)
     }
 
     AsyncFunction("cancelUpgrade") { id: String, promise: Promise ->
       if (!upgrades.contains(id)) {
-        Log.w(TAG, "can't cancel update ID ($id} not present")
+        Log.w(TAG, "Can't cancel update ID ($id} not present")
         return@AsyncFunction
       }
 
@@ -104,7 +105,7 @@ class ReactNativeMcuManagerModule : Module() {
 
     Function("destroyUpgrade") { id: String ->
       if (!upgrades.contains(id)) {
-        Log.w(TAG, "can't destroy update ID ($id} not present")
+        Log.w(TAG, "Can't destroy update ID ($id} not present")
         return@Function
       }
 

android/src/main/java/uk/co/playerdata/reactnativemcumanager/ReactNativeMcuMgrException.kt

@@ -0,0 +1,53 @@
+package uk.co.playerdata.reactnativemcumanager
+
+import expo.modules.kotlin.exception.CodedException
+import io.runtime.mcumgr.ble.exception.McuMgrBluetoothDisabledException
+import io.runtime.mcumgr.ble.exception.McuMgrDisconnectedException
+import io.runtime.mcumgr.ble.exception.McuMgrNotSupportedException
+import io.runtime.mcumgr.exception.InsufficientMtuException
+import io.runtime.mcumgr.exception.McuMgrCoapException
+import io.runtime.mcumgr.exception.McuMgrErrorException
+import io.runtime.mcumgr.exception.McuMgrException
+import io.runtime.mcumgr.exception.McuMgrTimeoutException
+
+class ReactNativeMcuMgrException private constructor(
+    code: String, message: String?, cause: Throwable?
+) : CodedException(code, message, cause) {
+
+    companion object {
+        private fun getCode(e: McuMgrException): String {
+            return when (e) {
+                is McuMgrBluetoothDisabledException -> return "MCU_MGR_BLUETOOTH_DISABLED"
+                is McuMgrDisconnectedException -> return "MCU_MGR_DISCONNECTED"
+                is McuMgrNotSupportedException -> return "MCU_MGR_NOT_SUPPORTED"
+                is InsufficientMtuException -> return "MCU_MGR_INSUFFICIENT_MTU"
+                is McuMgrCoapException -> return "MCU_MGR_COAP"
+                is McuMgrErrorException -> return "MCU_MGR_ERROR_${e.code}"
+                is McuMgrTimeoutException -> return "MCU_MGR_TIMEOUT"
+                else -> "UNEXPECTED_MCU_MGR_EXCEPTION"
+            }
+        }
+
+        private fun getMessage(e: McuMgrException): String {
+            return when (e) {
+                is McuMgrBluetoothDisabledException -> return "Bluetooth disabled"
+                is McuMgrDisconnectedException -> return "Device disconnected"
+                is McuMgrNotSupportedException -> return "Device not supported by MCUMgr"
+                is McuMgrTimeoutException -> return "MCUMgr timeout"
+                else -> {
+                    if (e.localizedMessage != null) {
+                        return e.localizedMessage
+                    } else if (e.message != null) {
+                        return e.message!!
+                    } else {
+                        return e.toString()
+                    }
+                }
+            }
+        }
+
+        fun fromMcuMgrException(e: McuMgrException): ReactNativeMcuMgrException {
+            return ReactNativeMcuMgrException(this.getCode(e), this.getMessage(e), e)
+        }
+    }
+}