fix (AndroidFileDownloader.java, IOSFileDownloader.swift): if the fil…

…e-downloading operation fails to commence we now return error code .FAILED__ERROR_UPON_COMMENCING / .failedErrorUponCommencing (old was: .errorInvalidSettings which wasn't accurate)
Laerdal · Oct 3, 2024 · 7d2a1e4 · 7d2a1e4
1 parent bec12cc
commit 7d2a1e4
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 19 deletions.
diff --git a/...aerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/...aerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java
@@ -81,33 +81,33 @@ public EAndroidFileDownloaderVerdict beginDownload(
             return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS;
         }
 
-        try
+        if (initialMtuSize > 0)
         {
-            if (initialMtuSize > 0)
-            {
-                _transport.setInitialMtu(initialMtuSize);
-            }
+            _transport.setInitialMtu(initialMtuSize);
+        }
 
-            _fileSystemManager = new FsManager(_transport);
+        _fileSystemManager = new FsManager(_transport);
 
-            setLoggingEnabled(false);
-            requestHighConnectionPriority();
+        setLoggingEnabled(false);
+        requestHighConnectionPriority();
 
-            setState(EAndroidFileDownloaderState.IDLE);
-            busyStateChangedAdvertisement(true);
-            fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0);
+        setState(EAndroidFileDownloaderState.IDLE);
+        busyStateChangedAdvertisement(true);
+        fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0);
 
-            _initialBytes = 0;
+        _initialBytes = 0;
+        _remoteFilePathSanitized = remoteFilePathSanitized;
 
-            _remoteFilePathSanitized = remoteFilePathSanitized;
+        try
+        {
             _downloadingController = _fileSystemManager.fileDownload(remoteFilePathSanitized, new FileDownloaderCallbackProxy());
         }
         catch (final Exception ex)
         {
             setState(EAndroidFileDownloaderState.ERROR);
             fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, ex.getMessage());
 
-            return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS;
+            return EAndroidFileDownloaderVerdict.FAILED__ERROR_UPON_COMMENCING;
         }
 
         return EAndroidFileDownloaderVerdict.SUCCESS;

diff --git a/...rapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileDownloaderVerdict.java b/...rapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileDownloaderVerdict.java
@@ -4,7 +4,8 @@ public enum EAndroidFileDownloaderVerdict //this must mirror the enum values of
 {
     SUCCESS(0),
     FAILED__INVALID_SETTINGS(1),
-    FAILED__DOWNLOAD_ALREADY_IN_PROGRESS(2);
+    FAILED__ERROR_UPON_COMMENCING(2),
+    FAILED__DOWNLOAD_ALREADY_IN_PROGRESS(3);
 
     @SuppressWarnings({"FieldCanBeLocal", "unused"})
     private final int _value;

diff --git a/...Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFileDownloadingInitializationVerdict.swift b/...Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFileDownloadingInitializationVerdict.swift
@@ -2,5 +2,6 @@
 public enum EIOSFileDownloadingInitializationVerdict: Int {
     case success = 0
     case failedInvalidSettings = 1
-    case failedDownloadAlreadyInProgress = 2
+    case failedErrorUponCommencing = 2
+    case failedDownloadAlreadyInProgress = 3
 }
diff --git a/...ings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift b/...ings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift
@@ -69,7 +69,7 @@ public class IOSFileDownloader: NSObject {
             setState(EIOSFileDownloaderState.error)
             fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, "Failed to commence file-Downloading (check logs for details)")
 
-            return EIOSFileDownloadingInitializationVerdict.failedInvalidSettings
+            return EIOSFileDownloadingInitializationVerdict.failedErrorUponCommencing
         }
 
         return EIOSFileDownloadingInitializationVerdict.success

diff --git a/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs
@@ -201,7 +201,12 @@ static private EFileDownloaderVerdict TranslateFileDownloaderVerdict(EAndroidFil
                 {
                     return EFileDownloaderVerdict.FailedInvalidSettings;
                 }
-
+
+                if (verdict == EAndroidFileDownloaderVerdict.FailedErrorUponCommencing)
+                {
+                    return EFileDownloaderVerdict.FailedErrorUponCommencing;
+                }
+
                 if (verdict == EAndroidFileDownloaderVerdict.FailedDownloadAlreadyInProgress)
                 {
                     return EFileDownloaderVerdict.FailedDownloadAlreadyInProgress;

diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Enums/EFileDownloaderVerdict.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Enums/EFileDownloaderVerdict.cs
@@ -7,6 +7,7 @@ public enum EFileDownloaderVerdict //this must mirror the java enum values of E[
     {
         Success = 0,
         FailedInvalidSettings = 1,
-        FailedDownloadAlreadyInProgress = 2,
+        FailedErrorUponCommencing = 2,
+        FailedDownloadAlreadyInProgress = 3,
     }
 }
diff --git a/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs
@@ -184,6 +184,11 @@ static private EFileDownloaderVerdict TranslateFileDownloaderVerdict(EIOSFileDow
                 {
                     return EFileDownloaderVerdict.FailedInvalidSettings;
                 }
+
+                if (verdict == EIOSFileDownloadingInitializationVerdict.FailedErrorUponCommencing)
+                {
+                    return EFileDownloaderVerdict.FailedErrorUponCommencing;
+                }
 
                 if (verdict == EIOSFileDownloadingInitializationVerdict.FailedDownloadAlreadyInProgress)
                 {