From 8e1c573ab764f577a74f4084ba96e3f822f3c12a Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 25 Sep 2024 14:24:07 +0200 Subject: [PATCH 001/104] feat (AndroidFirmwareInstaller.java): we now support the option of setting the initial-mtu-size for the ble-transport and the connection it sets up for the firmware installation --- .../AndroidFirmwareInstaller.java | 86 ++++++++++++++----- .../Laerdal.McuMgr.Bindings.Android.csproj | 8 +- ...Laerdal.McuMgr.Bindings.MacCatalyst.csproj | 8 +- ...Laerdal.McuMgr.Bindings.NetStandard.csproj | 8 +- .../Laerdal.McuMgr.Bindings.iOS.csproj | 8 +- ...Exception_GivenInvalidFirmwareDataBytes.cs | 2 + ...fully_GivenGreenNativeFirmwareInstaller.cs | 2 + ..._GivenFirmwareUploadFatalErrorMidflight.cs | 2 + ...ception_GivenGenericFatalErrorMidflight.cs | 2 + ...meoutException_GivenFatalErrorMidflight.cs | 2 + ...n_GivenErroneousNativeFirmwareInstaller.cs | 2 + ...onTimeoutException_GivenTooSmallTimeout.cs | 2 + ...ption_GivenCancellationRequestMidflight.cs | 2 + ...ativeFileDownloaderThatSkipsIntoTesting.cs | 2 + .../FirmwareInstallerTestbed.cs | 1 + .../FirmwareInstaller/FirmwareInstaller.cs | 5 +- Laerdal.McuMgr/Laerdal.McuMgr.csproj | 16 ++-- .../IFirmwareInstallerCommandable.cs | 22 +++-- ...NativeFirmwareInstallerCommandableProxy.cs | 1 + .../FirmwareInstaller/FirmwareInstaller.cs | 35 +++++--- .../FirmwareInstaller/FirmwareInstaller.cs | 2 + 21 files changed, 149 insertions(+), 69 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java index 792a7523..751d52c1 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java @@ -11,11 +11,14 @@ import io.runtime.mcumgr.dfu.FirmwareUpgradeCallback; import io.runtime.mcumgr.dfu.FirmwareUpgradeController; import io.runtime.mcumgr.dfu.mcuboot.FirmwareUpgradeManager; +import io.runtime.mcumgr.dfu.mcuboot.FirmwareUpgradeManager.Settings; +import io.runtime.mcumgr.dfu.mcuboot.FirmwareUpgradeManager.Settings.Builder; import io.runtime.mcumgr.dfu.mcuboot.FirmwareUpgradeManager.State; import io.runtime.mcumgr.dfu.mcuboot.model.ImageSet; import io.runtime.mcumgr.exception.McuMgrException; import io.runtime.mcumgr.exception.McuMgrTimeoutException; import no.nordicsemi.android.ble.ConnectionPriorityRequest; +import org.jetbrains.annotations.NotNull; @SuppressWarnings("unused") public class AndroidFirmwareInstaller @@ -47,9 +50,25 @@ public AndroidFirmwareInstaller(@NonNull final Context context, @NonNull final B _transport = new McuMgrBleTransport(context, bluetoothDevice); } + /** + * Initiates a firmware installation asynchronously. The progress is advertised through the callbacks provided by this class. + * Setup interceptors for them to get informed about the status of the firmware-installation. + * + * @param data the firmware bytes to install - can also be a zipped byte stream + * @param mode the mode of the installation - typically you want to set this to TEST_AND_CONFIRM in production environments + * @param initialMtuSize sets the initial MTU for the connection that the McuMgr BLE-transport sets up for the firmware installation that will follow. + * Note that if less than 0 it gets ignored and if it doesn't fall within the range [23, 517] it will cause a hard error. + * @param eraseSettings specifies whether the previous settings should be erased on the target-device + * @param estimatedSwapTimeInMilliseconds specifies the amount of time to wait before probing the device to see if the firmware that got installed managed to reboot the device successfully - if negative the setting gets ignored + * @param windowCapacity specifies the windows-capacity for the data transfers of the BLE connection - if negative this settings gets ignored + * @param memoryAlignment specifies the memory-alignment to use for the data transfers of the BLE connection - - if negative this settings gets ignored + * + * @return a verdict indicating whether the firmware installation was started successfully or not + */ public EAndroidFirmwareInstallationVerdict beginInstallation( @NonNull final byte[] data, @NonNull final EAndroidFirmwareInstallationMode mode, + final int initialMtuSize, final boolean eraseSettings, final int estimatedSwapTimeInMilliseconds, final int windowCapacity, @@ -100,29 +119,18 @@ public EAndroidFirmwareInstallationVerdict beginInstallation( } } - FirmwareUpgradeManager.Settings.Builder settingsBuilder = new FirmwareUpgradeManager.Settings.Builder(); + @NotNull Settings settings; try { - requestHighConnectionPriority(); - - _manager.setMode(mode.getValueFirmwareUpgradeManagerMode()); //0 - - if (estimatedSwapTimeInMilliseconds >= 0) - { - settingsBuilder.setEstimatedSwapTime(estimatedSwapTimeInMilliseconds); //1 - } - - if (windowCapacity >= 0) - { - settingsBuilder.setWindowCapacity(windowCapacity); //2 - } - - if (memoryAlignment >= 1) - { - settingsBuilder.setMemoryAlignment(memoryAlignment); //3 - } - - settingsBuilder.setEraseAppSettings(eraseSettings); + configureConnectionSettings(initialMtuSize); + + settings = digestFirmwareInstallationManagerSettings( + mode, + eraseSettings, + estimatedSwapTimeInMilliseconds, + windowCapacity, + memoryAlignment + ); } catch (final Exception ex) { @@ -135,7 +143,7 @@ public EAndroidFirmwareInstallationVerdict beginInstallation( { setState(EAndroidFirmwareInstallationState.IDLE); - _manager.start(images, settingsBuilder.build()); + _manager.start(images, settings); } catch (final Exception ex) { @@ -166,6 +174,32 @@ public EAndroidFirmwareInstallationVerdict beginInstallation( //3 Set the selected memory alignment. In the app this defaults to 4 to match Nordic devices, but can be modified in the UI. } + private @NotNull Settings digestFirmwareInstallationManagerSettings(@NotNull EAndroidFirmwareInstallationMode mode, boolean eraseSettings, int estimatedSwapTimeInMilliseconds, int windowCapacity, int memoryAlignment) + { + Builder settingsBuilder = new FirmwareUpgradeManager.Settings.Builder(); + + _manager.setMode(mode.getValueFirmwareUpgradeManagerMode()); //0 + + if (estimatedSwapTimeInMilliseconds >= 0) + { + settingsBuilder.setEstimatedSwapTime(estimatedSwapTimeInMilliseconds); //1 + } + + if (windowCapacity >= 0) + { + settingsBuilder.setWindowCapacity(windowCapacity); //2 + } + + if (memoryAlignment >= 1) + { + settingsBuilder.setMemoryAlignment(memoryAlignment); //3 + } + + settingsBuilder.setEraseAppSettings(eraseSettings); + + return settingsBuilder.build(); + } + public void disconnect() { if (_manager == null) return; @@ -417,13 +451,19 @@ public void onUploadProgressChanged(final int bytesSent, final int imageSize, fi } } - private void requestHighConnectionPriority() + private void configureConnectionSettings(int initialMtuSize) { final McuMgrTransport transporter = _manager.getTransporter(); if (!(transporter instanceof McuMgrBleTransport)) return; final McuMgrBleTransport bleTransporter = (McuMgrBleTransport) transporter; + + if (initialMtuSize > 0) + { + bleTransporter.setInitialMtu(initialMtuSize); + } + bleTransporter.requestConnPriority(ConnectionPriorityRequest.CONNECTION_PRIORITY_HIGH); } diff --git a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj index 85ea2c65..f6aec543 100644 --- a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj +++ b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj @@ -55,10 +55,10 @@ true - 1.0.1152.0 - 1.0.1152.0 - 1.0.1152.0 - 1.0.1152.0 + 1.0.1158.0 + 1.0.1158.0 + 1.0.1158.0 + 1.0.1158.0 $(PackageId) $(Authors) diff --git a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj index 4540d8fb..0ebe0460 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj +++ b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj @@ -69,10 +69,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1152.0 - 1.0.1152.0 - 1.0.1152.0 - 1.0.1152.0 + 1.0.1158.0 + 1.0.1158.0 + 1.0.1158.0 + 1.0.1158.0 $(PackageId) McuMgr Bindings for MacCatalyst - MAUI ready diff --git a/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj b/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj index 85e8d8c6..d4756ec5 100644 --- a/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj +++ b/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj @@ -37,10 +37,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1152.0 - 1.0.1152.0 - 1.0.1152.0 - 1.0.1152.0 + 1.0.1158.0 + 1.0.1158.0 + 1.0.1158.0 + 1.0.1158.0 $(PackageId) McuMgr C# Implementation (WIP) diff --git a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj index cf5fabcd..9333c269 100644 --- a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj +++ b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj @@ -70,10 +70,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1152.0 - 1.0.1152.0 - 1.0.1152.0 - 1.0.1152.0 + 1.0.1158.0 + 1.0.1158.0 + 1.0.1158.0 + 1.0.1158.0 $(PackageId) McuMgr Bindings for iOS - MAUI ready diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.BeginInstallation.ShouldThrowArgumentException_GivenInvalidFirmwareDataBytes.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.BeginInstallation.ShouldThrowArgumentException_GivenInvalidFirmwareDataBytes.cs index 0787c6d0..dbaa91e2 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.BeginInstallation.ShouldThrowArgumentException_GivenInvalidFirmwareDataBytes.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.BeginInstallation.ShouldThrowArgumentException_GivenInvalidFirmwareDataBytes.cs @@ -46,6 +46,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null, int? pipelineDepth = null, @@ -58,6 +59,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( eraseSettings: eraseSettings, pipelineDepth: pipelineDepth, byteAlignment: byteAlignment, + initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment, estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs index 1d343bb2..40874b38 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs @@ -66,6 +66,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null, int? pipelineDepth = null, @@ -78,6 +79,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( eraseSettings: eraseSettings, pipelineDepth: pipelineDepth, byteAlignment: byteAlignment, + initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment, estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs index 76408798..2545aa63 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs @@ -74,6 +74,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null, int? pipelineDepth = null, @@ -86,6 +87,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( eraseSettings: eraseSettings, pipelineDepth: pipelineDepth, byteAlignment: byteAlignment, + initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment, estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs index f4ff1a6f..54edb8b3 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs @@ -63,6 +63,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null, int? pipelineDepth = null, @@ -75,6 +76,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( eraseSettings: eraseSettings, pipelineDepth: pipelineDepth, byteAlignment: byteAlignment, + initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment, estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs index 74b8ca50..2234f05b 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs @@ -61,6 +61,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null, int? pipelineDepth = null, @@ -73,6 +74,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( eraseSettings: eraseSettings, pipelineDepth: pipelineDepth, byteAlignment: byteAlignment, + initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment, estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationInternalErrorException_GivenErroneousNativeFirmwareInstaller.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationInternalErrorException_GivenErroneousNativeFirmwareInstaller.cs index ad54c335..4103beae 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationInternalErrorException_GivenErroneousNativeFirmwareInstaller.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationInternalErrorException_GivenErroneousNativeFirmwareInstaller.cs @@ -44,6 +44,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null, int? pipelineDepth = null, @@ -56,6 +57,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( eraseSettings: eraseSettings, pipelineDepth: pipelineDepth, byteAlignment: byteAlignment, + initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment, estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs index f11735b9..49ecb9b6 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs @@ -56,6 +56,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null, int? pipelineDepth = null, @@ -68,6 +69,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( eraseSettings: eraseSettings, pipelineDepth: pipelineDepth, byteAlignment: byteAlignment, + initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment, estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs index 7969442e..52bbdf98 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs @@ -86,6 +86,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null, int? pipelineDepth = null, @@ -98,6 +99,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( eraseSettings: eraseSettings, pipelineDepth: pipelineDepth, byteAlignment: byteAlignment, + initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment, estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs index 439a45d5..88bdce7f 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs @@ -77,6 +77,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null, int? pipelineDepth = null, @@ -89,6 +90,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( eraseSettings: eraseSettings, pipelineDepth: pipelineDepth, byteAlignment: byteAlignment, + initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment, estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.cs index c5c57e48..f64a6820 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.cs @@ -35,6 +35,7 @@ public virtual EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null, int? pipelineDepth = null, diff --git a/Laerdal.McuMgr/Droid/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Droid/FirmwareInstaller/FirmwareInstaller.cs index 64d19e07..4faae8a4 100644 --- a/Laerdal.McuMgr/Droid/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Droid/FirmwareInstaller/FirmwareInstaller.cs @@ -104,16 +104,19 @@ public EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null, int? pipelineDepth = null, // ignored in android it only affects ios - int? byteAlignment = null // ignored in android it only affects ios + int? byteAlignment = null + // ignored in android it only affects ios ) { var nativeVerdict = base.BeginInstallation( data: data, mode: TranslateFirmwareInstallationMode(mode), eraseSettings: eraseSettings ?? false, + initialMtuSize: initialMtuSize ?? -1, windowCapacity: windowCapacity ?? -1, memoryAlignment: memoryAlignment ?? -1, estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds ?? -1 diff --git a/Laerdal.McuMgr/Laerdal.McuMgr.csproj b/Laerdal.McuMgr/Laerdal.McuMgr.csproj index e2bcd4d7..8c915bbd 100644 --- a/Laerdal.McuMgr/Laerdal.McuMgr.csproj +++ b/Laerdal.McuMgr/Laerdal.McuMgr.csproj @@ -55,10 +55,10 @@ $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb - 1.0.1152.0 - 1.0.1152.0 - 1.0.1152.0 - 1.0.1152.0 + 1.0.1158.0 + 1.0.1158.0 + 1.0.1158.0 + 1.0.1158.0 $(PackageId) $(Authors) @@ -149,21 +149,21 @@ - + - + - + - + diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs index ef654b00..fb17c39b 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs @@ -14,6 +14,9 @@ public interface IFirmwareInstallerCommandable /// Specifies whether preexisting settings should be erased or not. /// In rF52840, due to how the flash memory works, requires ~20 sec to erase images. /// For Laerdal AEDs the recommended time is ~50secs. Adjust the time accordingly for each device you're testing. + /// (Android only) Set the initial MTU size for the connection employed by the firmware-installation + /// (useful for some problematic devices such as Samsung A8 tablets). Acceptable custom values must lay within the range [23, 517]. + /// If null, zero or negative it will default to 498. Note that in quirky devices like Samsung Galaxy A8 the only value that works is 23 - anything else fails. /// (Android only) Set the window capacity. Values > 1 enable a new implementation for uploading /// the images, which makes use of SMP pipelining feature. The app will send this many packets immediately, without waiting for notification /// confirming each packet. This value should be lower or equal to MCUMGR_BUF_COUNT @@ -36,16 +39,17 @@ Task InstallAsync( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, - int? windowCapacity = null, - int? memoryAlignment = null, - int? pipelineDepth = null, - int? byteAlignment = null, + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null, // android only + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only int timeoutInMs = -1, int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 100, int gracefulCancellationTimeoutInMs = 2_500 ); - + /// /// Begins the firmware upgrade process. To really know when the upgrade process has been completed you have to employ the progressPercentage methods. /// @@ -53,7 +57,10 @@ Task InstallAsync( /// The firmware upgrade mode. Best to leave this to the default value 'TestAndConfirm'. /// Specifies whether preexisting settings should be erased or not. /// In rF52840, due to how the flash memory works, requires ~20 sec to erase images. - /// For Laerdal AEDs the recommended time is ~50secs. Adjust the time accordingly for each device you're testing. + /// For Laerdal AEDs the recommended time is ~50secs. Adjust the time accordingly for each device you're testing. + /// (Android only) Set the initial MTU size for the connection employed by the firmware-installation + /// (useful for some problematic devices such as Samsung A8 tablets). Acceptable custom values must lay within the range [23, 517]. + /// If null, zero or negative it will default to 498. Note that in quirky devices like Samsung Galaxy A8 the only value that works is 23 - anything else fails. /// (Android only) Set the window capacity. Values > 1 enable a new implementation for uploading /// the images, which makes use of SMP pipelining feature. The app will send this many packets immediately, without waiting for notification /// confirming each packet. This value should be lower or equal to MCUMGR_BUF_COUNT @@ -72,6 +79,7 @@ EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null, int? pipelineDepth = null, @@ -82,7 +90,7 @@ EFirmwareInstallationVerdict BeginInstallation( /// Cancels the firmware upgrade process /// void Cancel(); - + /// /// Disconnects the firmware installer from the targeted device /// diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Native/INativeFirmwareInstallerCommandableProxy.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Native/INativeFirmwareInstallerCommandableProxy.cs index caa7d8fe..d2b6ba04 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Native/INativeFirmwareInstallerCommandableProxy.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Native/INativeFirmwareInstallerCommandableProxy.cs @@ -14,6 +14,7 @@ EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, // android only not applicable for ios int? windowCapacity = null, // android only not applicable for ios int? memoryAlignment = null, // android only not applicable for ios int? pipelineDepth = null, // ios only not applicable for android diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index 0ffc949d..42ccd267 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -42,10 +42,13 @@ public EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, // android only not applicable for ios int? windowCapacity = null, // android only not applicable for ios int? memoryAlignment = null, // android only not applicable for ios int? pipelineDepth = null, // ios only not applicable for android - int? byteAlignment = null // ios only not applicable for android + int? byteAlignment = null + + // ios only not applicable for android ) { if (data == null || !data.Any()) @@ -56,12 +59,12 @@ public EFirmwareInstallationVerdict BeginInstallation( data: data, mode: mode, eraseSettings: eraseSettings ?? false, - pipelineDepth: pipelineDepth, - byteAlignment: byteAlignment, + estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds ?? -1, + initialMtuSize: initialMtuSize ?? -1, windowCapacity: windowCapacity ?? -1, memoryAlignment: memoryAlignment ?? -1, - estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds ?? -1 - ); + pipelineDepth: pipelineDepth, + byteAlignment: byteAlignment); return verdict; } @@ -154,10 +157,11 @@ public async Task InstallAsync( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, - int? windowCapacity = null, - int? memoryAlignment = null, - int? pipelineDepth = null, - int? byteAlignment = null, + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null, // android only + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only int timeoutInMs = -1, int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 100, @@ -184,12 +188,15 @@ public async Task InstallAsync( var verdict = BeginInstallation( //00 dont use task.run here for now data: data, mode: mode, - pipelineDepth: pipelineDepth, - byteAlignment: byteAlignment, eraseSettings: eraseSettings, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment, - estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds + estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds, + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment, // android only + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment // ios only ); if (verdict != EFirmwareInstallationVerdict.Success) throw new ArgumentException(verdict.ToString()); diff --git a/Laerdal.McuMgr/iOS/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/iOS/FirmwareInstaller/FirmwareInstaller.cs index e062c398..fb63ac5d 100644 --- a/Laerdal.McuMgr/iOS/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/iOS/FirmwareInstaller/FirmwareInstaller.cs @@ -2,6 +2,7 @@ // ReSharper disable RedundantExtendsListEntry using System; +using System.Threading.Tasks; using CoreBluetooth; using Foundation; using Laerdal.McuMgr.Common; @@ -105,6 +106,7 @@ public EFirmwareInstallationVerdict BeginInstallation( EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, //not applicable in ios int? windowCapacity = null, //not applicable in ios int? memoryAlignment = null, //not applicable in ios int? pipelineDepth = null, From 278af9c1c0ff034f43b4eafc9b37de84e0f99222 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 26 Sep 2024 14:11:04 +0200 Subject: [PATCH 002/104] feat (FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs): new test meant to ensure that the fw-installation retry logic will fallback to using initial-mtu=23 as a last-ditch effort in terms of making the ble-connection to be established --- ..._GivenProblematicDeviceForFileUploading.cs | 183 ++++++++++++++++++ 1 file changed, 183 insertions(+) create mode 100644 Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs new file mode 100644 index 00000000..7ccb97f5 --- /dev/null +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs @@ -0,0 +1,183 @@ +using FluentAssertions; +using FluentAssertions.Extensions; +using Laerdal.McuMgr.FirmwareInstaller.Contracts.Enums; +using Laerdal.McuMgr.FirmwareInstaller.Contracts.Events; +using Laerdal.McuMgr.FirmwareInstaller.Contracts.Native; +using GenericNativeFirmwareInstallerCallbacksProxy_ = Laerdal.McuMgr.FirmwareInstaller.FirmwareInstaller.GenericNativeFirmwareInstallerCallbacksProxy; + +#pragma warning disable xUnit1026 + +namespace Laerdal.McuMgr.Tests.FirmwareInstaller +{ + /// + /// Certain exotic devices (like Samsung A8 tablets) have buggy ble-stacks and have reliable support only for Phy1M mode and even then they have a + /// problem with establishing a ble-connection with nRF51+ chipsets of Nordic unless BeginInstallation() / UploadAsync() / DownloadAsync() are called + /// with initialMtuValue=23 (which is the only value that works for these exotic devices). + /// + /// We need to ensure that the retry logic is able to handle such problematic devices by lowering the initialMtuValue to 23 in the last few retries + /// (as a last ditch best-effort.) + /// + public partial class FirmwareInstallerTestbed + { + [Theory] + [InlineData("FIT.IA.SCSWLDAULIM.GPDFFU.010", 2)] + [InlineData("FIT.IA.SCSWLDAULIM.GPDFFU.020", 3)] + [InlineData("FIT.IA.SCSWLDAULIM.GPDFFU.030", 5)] + public async Task InstallAsync_ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading(string testNickname, int maxTriesCount) + { + // Arrange + var mockedNativeFirmwareInstallerProxy = new MockedGreenNativeFirmwareInstallerProxySpy10(new GenericNativeFirmwareInstallerCallbacksProxy_(), maxTriesCount); + var firmwareInstaller = new McuMgr.FirmwareInstaller.FirmwareInstaller(mockedNativeFirmwareInstallerProxy); + + using var eventsMonitor = firmwareInstaller.Monitor(); + + // Act + var work = new Func(() => firmwareInstaller.InstallAsync([1, 2, 3], maxTriesCount: maxTriesCount)); + + // Assert + await work.Should().CompleteWithinAsync(4.Seconds()); + + mockedNativeFirmwareInstallerProxy.BugDetected.Should().BeNull(); + + mockedNativeFirmwareInstallerProxy.CancelCalled.Should().BeFalse(); + mockedNativeFirmwareInstallerProxy.DisconnectCalled.Should().BeFalse(); //00 + mockedNativeFirmwareInstallerProxy.BeginInstallationCalled.Should().BeTrue(); + + eventsMonitor + .OccurredEvents + .Count(x => x.EventName == nameof(firmwareInstaller.FatalErrorOccurred)) + .Should() + .Be(maxTriesCount - 1); + + eventsMonitor + .OccurredEvents //there should be only one completed event + .Count(x => x.Parameters.OfType().FirstOrDefault() is { NewState: EFirmwareInstallationState.Complete }) + .Should() + .Be(1); + + eventsMonitor + .Should().Raise(nameof(firmwareInstaller.StateChanged)) + .WithSender(firmwareInstaller) + .WithArgs(args => args.NewState == EFirmwareInstallationState.Uploading); + + eventsMonitor + .Should() + .Raise(nameof(firmwareInstaller.FirmwareUploadProgressPercentageAndDataThroughputChanged)) + .WithSender(firmwareInstaller); + + //00 we dont want to disconnect the device regardless of the outcome + } + + private class MockedGreenNativeFirmwareInstallerProxySpy10 : MockedNativeFirmwareInstallerProxySpy + { + private int _tryCounter; + private readonly int _maxTriesCount; + + public string BugDetected { get; private set; } + + public MockedGreenNativeFirmwareInstallerProxySpy10(INativeFirmwareInstallerCallbacksProxy firmwareInstallerCallbacksProxy, int maxTriesCount) + : base(firmwareInstallerCallbacksProxy) + { + _maxTriesCount = maxTriesCount; + } + + public override EFirmwareInstallationVerdict BeginInstallation( + byte[] data, + EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, + bool? eraseSettings = null, + int? estimatedSwapTimeInMilliseconds = null, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null, + int? pipelineDepth = null, + int? byteAlignment = null + ) + { + if (BugDetected is not null) + throw new Exception(BugDetected); + + _tryCounter++; + + var verdict = base.BeginInstallation( + data: data, + mode: mode, + eraseSettings: eraseSettings, + pipelineDepth: pipelineDepth, + byteAlignment: byteAlignment, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment, + estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds + ); + + Task.Run(function: async () => //00 vital + { + if (_tryCounter == 1 && initialMtuSize == 23) + { + BugDetected = "[BUG DETECTED] The very first try should not be with initialMtuSize set to 23 - something is wrong!"; + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + return; + } + + await Task.Delay(10); + + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Idle, newState: EFirmwareInstallationState.Idle); + await Task.Delay(10); + + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Idle, newState: EFirmwareInstallationState.Validating); + await Task.Delay(10); + + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Validating, newState: EFirmwareInstallationState.Uploading); + await Task.Delay(100); + + { //file uploading simulation + FirmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage: 00, averageThroughput: 00); + await Task.Delay(10); + + if (_tryCounter == _maxTriesCount && initialMtuSize != 23) + { + BugDetected = $"[BUG DETECTED] The very last try should be with initialMtuSize set to 23 but it's set to {initialMtuSize} - something is wrong!"; + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + return; + } + + if (_tryCounter < _maxTriesCount) + { + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, "error while uploading firmware blah blah"); // order + return; + } + + FirmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage: 20, averageThroughput: 10); + await Task.Delay(10); + FirmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage: 40, averageThroughput: 10); + await Task.Delay(10); + FirmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage: 60, averageThroughput: 10); + await Task.Delay(10); + FirmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage: 80, averageThroughput: 10); + await Task.Delay(10); + FirmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage: 100, averageThroughput: 10); + await Task.Delay(10); + } + + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Testing); + await Task.Delay(10); + + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Testing, newState: EFirmwareInstallationState.Confirming); + await Task.Delay(10); + + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Confirming, newState: EFirmwareInstallationState.Resetting); + await Task.Delay(10); + + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Resetting, newState: EFirmwareInstallationState.Complete); + }); + + return verdict; + + //00 simulating the state changes in a background thread is vital in order to simulate the async nature of the native uploader + } + } + } +} \ No newline at end of file From 86f64706245a9f6a142cd96f0cd5c997b77fe089 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 26 Sep 2024 15:58:23 +0200 Subject: [PATCH 003/104] feat (FirmwareInstaller.InstallAsync()): we now detect persistent failures during the fw-uploading phase and we resort to overriding the given settings in favor of more fail-safe ones: initialMtuSize=23 + windowCapacity=1, memoryAlignment=1 --- ..._GivenProblematicDeviceForFileUploading.cs | 14 ++++++++++- .../FirmwareInstaller/FirmwareInstaller.cs | 25 ++++++++++++++----- 2 files changed, 32 insertions(+), 7 deletions(-) diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs index 7ccb97f5..a0bd9ea0 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs @@ -1,5 +1,7 @@ using FluentAssertions; using FluentAssertions.Extensions; +using Laerdal.McuMgr.Common.Enums; +using Laerdal.McuMgr.Common.Events; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Enums; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Events; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Native; @@ -10,7 +12,7 @@ namespace Laerdal.McuMgr.Tests.FirmwareInstaller { /// - /// Certain exotic devices (like Samsung A8 tablets) have buggy ble-stacks and have reliable support only for Phy1M mode and even then they have a + /// Certain exotic devices (like Samsung A8 Android tablets) have buggy ble-stacks and have reliable support only for Phy1M mode and even then they have a /// problem with establishing a ble-connection with nRF51+ chipsets of Nordic unless BeginInstallation() / UploadAsync() / DownloadAsync() are called /// with initialMtuValue=23 (which is the only value that works for these exotic devices). /// @@ -55,6 +57,16 @@ public async Task InstallAsync_ShouldCompleteSuccessfullyWithLastDitchAttemptUsi .Should() .Be(1); + eventsMonitor + .OccurredEvents + .Count(x => + { + var logEventArgs = x.Parameters.OfType().FirstOrDefault(); // we need to make sure the calling environment + return logEventArgs is { Level: ELogLevel.Warning } && logEventArgs.Message.Contains("[FI.IA.010]"); // is warned about falling back to failsafe settings + }) + .Should() + .Be(1); + eventsMonitor .Should().Raise(nameof(firmwareInstaller.StateChanged)) .WithSender(firmwareInstaller) diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index 42ccd267..db5a227f 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -46,9 +46,7 @@ public EFirmwareInstallationVerdict BeginInstallation( int? windowCapacity = null, // android only not applicable for ios int? memoryAlignment = null, // android only not applicable for ios int? pipelineDepth = null, // ios only not applicable for android - int? byteAlignment = null - - // ios only not applicable for android + int? byteAlignment = null // ios only not applicable for android ) { if (data == null || !data.Any()) @@ -59,12 +57,13 @@ public EFirmwareInstallationVerdict BeginInstallation( data: data, mode: mode, eraseSettings: eraseSettings ?? false, - estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds ?? -1, + pipelineDepth: pipelineDepth, + byteAlignment: byteAlignment, initialMtuSize: initialMtuSize ?? -1, windowCapacity: windowCapacity ?? -1, memoryAlignment: memoryAlignment ?? -1, - pipelineDepth: pipelineDepth, - byteAlignment: byteAlignment); + estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds ?? -1 + ); return verdict; } @@ -176,6 +175,7 @@ public async Task InstallAsync( : DefaultGracefulCancellationTimeoutInMs; var isCancellationRequested = false; + var almostImmediateUploadingFailuresCount = 0; for (var triesCount = 1; !isCancellationRequested;) { var taskCompletionSource = new TaskCompletionSource(state: false); @@ -185,6 +185,14 @@ public async Task InstallAsync( StateChanged += FirmwareInstallationAsyncOnStateChanged; FatalErrorOccurred += FirmwareInstallationAsyncOnFatalErrorOccurred; + var isConnectionUnstableForUploading = triesCount >= 2 && (triesCount == maxTriesCount || triesCount >= 3 && almostImmediateUploadingFailuresCount >= 2); + if (isConnectionUnstableForUploading) + { + initialMtuSize = 23; // when noticing persistent failures when uploading we resort + windowCapacity = 1; // to forcing the most failsafe settings we know of just in case + memoryAlignment = 1; // we manage to salvage this situation (works with samsung A8 tablets) + } + var verdict = BeginInstallation( //00 dont use task.run here for now data: data, mode: mode, @@ -216,6 +224,11 @@ public async Task InstallAsync( } catch (FirmwareInstallationUploadingStageErroredOutException ex) //we only want to retry if the errors are related to the upload part of the process { + if (_fileUploadProgressEventsCount <= 3) + { + almostImmediateUploadingFailuresCount++; + } + if (++triesCount > maxTriesCount) //order throw new AllFirmwareInstallationAttemptsFailedException(maxTriesCount, innerException: ex); From 07865115957d9f08023b78c1e180b65c42172a07 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 26 Sep 2024 17:13:20 +0200 Subject: [PATCH 004/104] refa (FirmwareInstaller.InstallAsync()): we now fallback to using fail-safe settings in case we detect persistent failures during the fw-uploading stage --- ..._GivenProblematicDeviceForFileUploading.cs | 4 +- .../Android.FailSafeBleConnectionSettings.cs | 12 ++++ .../Apple.FailSafeBleConnectionSettings.cs | 11 ++++ .../FirmwareInstaller/FirmwareInstaller.cs | 63 ++++++++++++++++--- 4 files changed, 78 insertions(+), 12 deletions(-) create mode 100644 Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs create mode 100644 Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs index a0bd9ea0..30007412 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs @@ -61,8 +61,8 @@ public async Task InstallAsync_ShouldCompleteSuccessfullyWithLastDitchAttemptUsi .OccurredEvents .Count(x => { - var logEventArgs = x.Parameters.OfType().FirstOrDefault(); // we need to make sure the calling environment - return logEventArgs is { Level: ELogLevel.Warning } && logEventArgs.Message.Contains("[FI.IA.010]"); // is warned about falling back to failsafe settings + var logEventArgs = x.Parameters.OfType().FirstOrDefault(); // we need to make sure the calling environment + return logEventArgs is { Level: ELogLevel.Warning } && logEventArgs.Message.Contains("[FI.IA.GFCSICPTBU.010]"); // is warned about falling back to failsafe settings }) .Should() .Be(1); diff --git a/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs b/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs new file mode 100644 index 00000000..36fe10d0 --- /dev/null +++ b/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs @@ -0,0 +1,12 @@ +namespace Laerdal.McuMgr.Common.Constants.Android +{ + public static class AndroidTidbits + { + public static class FailSafeBleConnectionSettings + { + public const int InitialMtuSize = 23; // applies to android only + public const int WindowCapacity = 1; // applies to android only + public const int MemoryAlignment = 1; // applies to android only + } + } +} \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs b/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs new file mode 100644 index 00000000..5f1d12a1 --- /dev/null +++ b/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs @@ -0,0 +1,11 @@ +namespace Laerdal.McuMgr.Common.Constants.Android +{ + public static class AppleTidbits + { + public static class FailSafeBleConnectionSettings + { + public const int PipelineDepth = 1; + public const int ByteAlignment = 1; + } + } +} \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index db5a227f..15dfff6e 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -4,6 +4,8 @@ using System; using System.Linq; using System.Threading.Tasks; +using Laerdal.McuMgr.Common.Constants; +using Laerdal.McuMgr.Common.Constants.Android; using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Events; using Laerdal.McuMgr.Common.Exceptions; @@ -175,6 +177,7 @@ public async Task InstallAsync( : DefaultGracefulCancellationTimeoutInMs; var isCancellationRequested = false; + var didWarnOnceAboutUnstableConnection = false; var almostImmediateUploadingFailuresCount = 0; for (var triesCount = 1; !isCancellationRequested;) { @@ -185,12 +188,18 @@ public async Task InstallAsync( StateChanged += FirmwareInstallationAsyncOnStateChanged; FatalErrorOccurred += FirmwareInstallationAsyncOnFatalErrorOccurred; - var isConnectionUnstableForUploading = triesCount >= 2 && (triesCount == maxTriesCount || triesCount >= 3 && almostImmediateUploadingFailuresCount >= 2); - if (isConnectionUnstableForUploading) + var failSafeSettingsToApply = GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( + triesCount_: triesCount, + maxTriesCount_: maxTriesCount, + almostImmediateUploadingFailuresCount_: almostImmediateUploadingFailuresCount + ); + if (failSafeSettingsToApply != null) { - initialMtuSize = 23; // when noticing persistent failures when uploading we resort - windowCapacity = 1; // to forcing the most failsafe settings we know of just in case - memoryAlignment = 1; // we manage to salvage this situation (works with samsung A8 tablets) + byteAlignment = failSafeSettingsToApply.Value.byteAlignment; + pipelineDepth = failSafeSettingsToApply.Value.pipelineDepth; + initialMtuSize = failSafeSettingsToApply.Value.initialMtuSize; + windowCapacity = failSafeSettingsToApply.Value.windowCapacity; + memoryAlignment = failSafeSettingsToApply.Value.memoryAlignment; } var verdict = BeginInstallation( //00 dont use task.run here for now @@ -199,12 +208,11 @@ public async Task InstallAsync( eraseSettings: eraseSettings, estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds, + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only initialMtuSize: initialMtuSize, // android only windowCapacity: windowCapacity, // android only - memoryAlignment: memoryAlignment, // android only - - pipelineDepth: pipelineDepth, // ios only - byteAlignment: byteAlignment // ios only + memoryAlignment: memoryAlignment // android only ); if (verdict != EFirmwareInstallationVerdict.Success) throw new ArgumentException(verdict.ToString()); @@ -224,7 +232,7 @@ public async Task InstallAsync( } catch (FirmwareInstallationUploadingStageErroredOutException ex) //we only want to retry if the errors are related to the upload part of the process { - if (_fileUploadProgressEventsCount <= 3) + if (_fileUploadProgressEventsCount <= 10) { almostImmediateUploadingFailuresCount++; } @@ -330,6 +338,41 @@ void FirmwareInstallationAsyncOnFatalErrorOccurred(object sender, FatalErrorOccu } } + return; + + + (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment)? GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( + int triesCount_, + int maxTriesCount_, + int almostImmediateUploadingFailuresCount_ + ) + { + var isConnectionTooUnstableForUploading_ = triesCount_ >= 2 && (triesCount_ == maxTriesCount_ || triesCount_ >= 3 && almostImmediateUploadingFailuresCount_ >= 2); + if (!isConnectionTooUnstableForUploading_) + return null; + + const int byteAlignment_ = AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment; // ios + maccatalyst + const int pipelineDepth_ = AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth; // ios + maccatalyst + + const int initialMtuSize_ = AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize; // android when noticing persistent failures when uploading we resort + const int windowCapacity_ = AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity; // android to forcing the most failsafe settings we know of just in case + const int memoryAlignment_ = AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) + + if (!didWarnOnceAboutUnstableConnection) + { + didWarnOnceAboutUnstableConnection = true; + OnLogEmitted(new LogEmittedEventArgs( + level: ELogLevel.Warning, + message: $"[FI.IA.GFCSICPTBU.010] Installation-Attempt#{triesCount_}: Connection is too unstable for uploading the firmware to the target device. Subsequent tries will use failsafe parameters on the connection " + + $"just in case it helps (byteAlignment={byteAlignment_}, pipelineDepth={pipelineDepth_}, initialMtuSize={initialMtuSize_}, windowCapacity={windowCapacity_}, memoryAlignment={memoryAlignment_})", + resource: "Firmware", + category: "FirmwareInstaller" + )); + } + + return (byteAlignment: byteAlignment_, pipelineDepth: pipelineDepth_, initialMtuSize: initialMtuSize_, windowCapacity: windowCapacity_, memoryAlignment: memoryAlignment_); + } + //00 we are aware that in order to be 100% accurate about timeouts we should use task.run() here without await and then await the // taskcompletionsource right after but if we went down this path we would also have to account for exceptions thus complicating // the code considerably for little to no practical gain considering that the native call has trivial setup code and is very fast From fb39d76a2259d08b095f84185bb3d58cc65756c5 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 26 Sep 2024 18:38:06 +0200 Subject: [PATCH 005/104] feat (FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs): enhance the checks we perform to ensure that the fail-safe settings are being employed at the appropriate times --- ..._GivenProblematicDeviceForFileUploading.cs | 73 ++++++++++++++++++- 1 file changed, 69 insertions(+), 4 deletions(-) diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs index 30007412..606e5557 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs @@ -1,5 +1,6 @@ using FluentAssertions; using FluentAssertions.Extensions; +using Laerdal.McuMgr.Common.Constants.Android; using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Events; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Enums; @@ -124,9 +125,41 @@ public override EFirmwareInstallationVerdict BeginInstallation( Task.Run(function: async () => //00 vital { - if (_tryCounter == 1 && initialMtuSize == 23) + if (_tryCounter == 1 && initialMtuSize == AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize) { - BugDetected = "[BUG DETECTED] The very first try should not be with initialMtuSize set to 23 - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(initialMtuSize)} set to the fail-safe value of {AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize} right off the bat - something is wrong!"; + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + return; + } + + if (_tryCounter == 1 && windowCapacity == AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity) + { + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(windowCapacity)} set to the fail-safe value of {AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity} right off the bat - something is wrong!"; + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + return; + } + + if (_tryCounter == 1 && memoryAlignment == AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment) + { + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(memoryAlignment)} set to the fail-safe value of {AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment} right off the bat - something is wrong!"; + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + return; + } + + if (_tryCounter == 1 && pipelineDepth == AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth) + { + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(pipelineDepth)} set to the fail-safe value of {AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth} right off the bat - something is wrong!"; + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + return; + } + + if (_tryCounter == 1 && byteAlignment == AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment) + { + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(byteAlignment)} set to the fail-safe value of {AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; @@ -147,14 +180,46 @@ public override EFirmwareInstallationVerdict BeginInstallation( FirmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage: 00, averageThroughput: 00); await Task.Delay(10); - if (_tryCounter == _maxTriesCount && initialMtuSize != 23) + if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize) { - BugDetected = $"[BUG DETECTED] The very last try should be with initialMtuSize set to 23 but it's set to {initialMtuSize} - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize} but it's set to {initialMtuSize} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } + if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity) + { + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity} but it's set to {windowCapacity} instead - something is wrong!"; + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + return; + } + + if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment) + { + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment} but it's set to {memoryAlignment} instead - something is wrong!"; + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + return; + } + + if (_tryCounter == _maxTriesCount && pipelineDepth != AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth) + { + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth} but it's set to {pipelineDepth} instead - something is wrong!"; + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + return; + } + + if (_tryCounter == _maxTriesCount && byteAlignment != AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment) + { + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment} but it's set to {byteAlignment} instead - something is wrong!"; + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + return; + } + if (_tryCounter < _maxTriesCount) { StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); From 1797e7c810a8f43871ce7202410d4111632ae1e5 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 27 Sep 2024 17:16:20 +0200 Subject: [PATCH 006/104] doc (IFirmwareInstallerCommandable.InstallAsync()): add a remark about the fail-safe-connection-settings enforcement when the connection is found to be unstable --- .../Contracts/IFirmwareInstallerCommandable.cs | 10 ++++++++-- Laerdal.Scripts/Laerdal.Builder.targets | 5 +++++ 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs index fb17c39b..0768069f 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs @@ -1,4 +1,5 @@ using System.Threading.Tasks; +using Laerdal.McuMgr.Common.Constants; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Enums; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Exceptions; @@ -7,8 +8,13 @@ namespace Laerdal.McuMgr.FirmwareInstaller.Contracts public interface IFirmwareInstallerCommandable { /// - /// Begins the firmware upgrade process. To really know when the upgrade process has been completed you have to employ the progressPercentage methods. + /// Begins the firmware upgrade process. To really know when the upgrade process has been completed you have to listen to the associated events of the facade. /// + /// + /// When 'maxTriesCount' is greater than or equal to 2 the connection will be monitored in terms of how stable and reliable it is during the firmware-uploading stage and if + /// the uploading phase fails from the third attempt onwards then in the subsequent attempts the fail-safe settings in + /// and will be enforced to try to upload the firmware. + /// /// The firmware bytes. If zipped then the archive must contain the .bin file and not a directory. /// The firmware upgrade mode. Best to leave this to the default value 'TestAndConfirm'. /// Specifies whether preexisting settings should be erased or not. @@ -19,7 +25,7 @@ public interface IFirmwareInstallerCommandable /// If null, zero or negative it will default to 498. Note that in quirky devices like Samsung Galaxy A8 the only value that works is 23 - anything else fails. /// (Android only) Set the window capacity. Values > 1 enable a new implementation for uploading /// the images, which makes use of SMP pipelining feature. The app will send this many packets immediately, without waiting for notification - /// confirming each packet. This value should be lower or equal to MCUMGR_BUF_COUNT + /// confirming each packet. This value should be lower than or equal to MCUMGR_BUF_COUNT /// (https://github.com/zephyrproject-rtos/zephyr/blob/bd4ddec0c8c822bbdd420bd558b62c1d1a532c16/subsys/mgmt/mcumgr/Kconfig#L550) /// parameter in KConfig in NCS / Zephyr configuration and should also be supported on Mynewt devices. Mind, that in Zephyr, /// before https://github.com/zephyrproject-rtos/zephyr/pull/41959 was merged, the device required data to be sent with memory alignment. diff --git a/Laerdal.Scripts/Laerdal.Builder.targets b/Laerdal.Scripts/Laerdal.Builder.targets index da8d8535..a37da4c2 100644 --- a/Laerdal.Scripts/Laerdal.Builder.targets +++ b/Laerdal.Scripts/Laerdal.Builder.targets @@ -14,6 +14,11 @@ + + + + + From 6d9f9d5ca2fb72e6584d4c0592f5acc03f703364 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 27 Sep 2024 17:20:16 +0200 Subject: [PATCH 007/104] feat ([Android/Apple] FailSafeBleConnectionSettings.cs): make the fail-safe settings mutable so that the calling environment can tweak them if need be --- ..._GivenProblematicDeviceForFileUploading.cs | 2 +- .../Android.FailSafeBleConnectionSettings.cs | 19 ++++++++++++------- .../Apple.FailSafeBleConnectionSettings.cs | 15 ++++++++++----- .../FirmwareInstaller/FirmwareInstaller.cs | 12 +++++------- 4 files changed, 28 insertions(+), 20 deletions(-) diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs index 606e5557..08f33a13 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs @@ -1,6 +1,6 @@ using FluentAssertions; using FluentAssertions.Extensions; -using Laerdal.McuMgr.Common.Constants.Android; +using Laerdal.McuMgr.Common.Constants; using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Events; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Enums; diff --git a/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs b/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs index 36fe10d0..643a449c 100644 --- a/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs +++ b/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs @@ -1,12 +1,17 @@ -namespace Laerdal.McuMgr.Common.Constants.Android +namespace Laerdal.McuMgr.Common.Constants { - public static class AndroidTidbits + public readonly struct AndroidTidbits { - public static class FailSafeBleConnectionSettings + /// + /// Failsafe settings for the BLE connection used in Androids to perform various operations: installing firmware, resetting the device, erasing firmwares, uploading files, + /// downloading files. These settings are enforced automagically when the ble connection turns out to be unstable and unreliable during the aforementioned operations. + /// The settings are editable can be adjusted to fit future needs. + /// + public readonly struct FailSafeBleConnectionSettings { - public const int InitialMtuSize = 23; // applies to android only - public const int WindowCapacity = 1; // applies to android only - public const int MemoryAlignment = 1; // applies to android only + static public int InitialMtuSize { get; set; } = 23; // applies to android only + static public int WindowCapacity { get; set; } = 1; // applies to android only + static public int MemoryAlignment { get; set; } = 1; // applies to android only } } -} \ No newline at end of file +} diff --git a/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs b/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs index 5f1d12a1..a55484b3 100644 --- a/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs +++ b/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs @@ -1,11 +1,16 @@ -namespace Laerdal.McuMgr.Common.Constants.Android +namespace Laerdal.McuMgr.Common.Constants { - public static class AppleTidbits + public readonly struct AppleTidbits { - public static class FailSafeBleConnectionSettings + /// + /// Failsafe settings for the BLE connection used in Apple platforms (iOS / MacCatalyst) to perform various operations: installing firmware, resetting the device, + /// erasing firmwares, uploading files, downloading files. These settings are enforced automagically when the ble connection turns out to be unstable and unreliable + /// during the aforementioned operations. The settings are editable can be adjusted to fit future needs. + /// + public readonly struct FailSafeBleConnectionSettings { - public const int PipelineDepth = 1; - public const int ByteAlignment = 1; + static public int PipelineDepth { get; set; } = 1; + static public int ByteAlignment { get; set; } = 1; } } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index 15dfff6e..41226df2 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -5,7 +5,6 @@ using System.Linq; using System.Threading.Tasks; using Laerdal.McuMgr.Common.Constants; -using Laerdal.McuMgr.Common.Constants.Android; using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Events; using Laerdal.McuMgr.Common.Exceptions; @@ -351,12 +350,11 @@ int almostImmediateUploadingFailuresCount_ if (!isConnectionTooUnstableForUploading_) return null; - const int byteAlignment_ = AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment; // ios + maccatalyst - const int pipelineDepth_ = AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth; // ios + maccatalyst - - const int initialMtuSize_ = AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize; // android when noticing persistent failures when uploading we resort - const int windowCapacity_ = AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity; // android to forcing the most failsafe settings we know of just in case - const int memoryAlignment_ = AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) + var byteAlignment_ = AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment; // ios + maccatalyst + var pipelineDepth_ = AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth; // ios + maccatalyst + var initialMtuSize_ = AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize; // android when noticing persistent failures when uploading we resort + var windowCapacity_ = AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity; // android to forcing the most failsafe settings we know of just in case + var memoryAlignment_ = AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) if (!didWarnOnceAboutUnstableConnection) { From d8a88198beb8d6d7c481235b8618b1e315db891d Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 30 Sep 2024 13:36:23 +0200 Subject: [PATCH 008/104] fix (firmware-installer-tests-suite): we now make sure to also trigger a state change to .idle in each and every mocked .BeginInstallation() for the sake of adhering to the behaviour of the actual native implementations --- ...uldThrowArgumentException_GivenInvalidFirmwareDataBytes.cs | 3 +++ ...gLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs | 4 +--- ...dCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs | 3 ++- ...sFailedException_GivenFirmwareUploadFatalErrorMidflight.cs | 1 + ...AttemptsFailedException_GivenGenericFatalErrorMidflight.cs | 3 ++- ...ationImageSwapTimeoutException_GivenFatalErrorMidflight.cs | 1 + ...rmwareInstallationTimeoutException_GivenTooSmallTimeout.cs | 3 +++ ...ionCancelledException_GivenCancellationRequestMidflight.cs | 3 +++ ...cted_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs | 4 ++-- 9 files changed, 18 insertions(+), 7 deletions(-) diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.BeginInstallation.ShouldThrowArgumentException_GivenInvalidFirmwareDataBytes.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.BeginInstallation.ShouldThrowArgumentException_GivenInvalidFirmwareDataBytes.cs index dbaa91e2..2d86cf9c 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.BeginInstallation.ShouldThrowArgumentException_GivenInvalidFirmwareDataBytes.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.BeginInstallation.ShouldThrowArgumentException_GivenInvalidFirmwareDataBytes.cs @@ -67,6 +67,9 @@ public override EFirmwareInstallationVerdict BeginInstallation( Task.Run(async () => //00 vital { + await Task.Delay(10); + StateChangedAdvertisement(EFirmwareInstallationState.Idle, EFirmwareInstallationState.Idle); + await Task.Delay(10); StateChangedAdvertisement(EFirmwareInstallationState.Idle, EFirmwareInstallationState.Uploading); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs index 08f33a13..efb7ed44 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs @@ -164,9 +164,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - - await Task.Delay(10); - + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Idle, newState: EFirmwareInstallationState.Idle); await Task.Delay(10); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs index 40874b38..c5ffc15a 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs @@ -30,7 +30,7 @@ public async Task InstallAsync_ShouldCompleteSuccessfully_GivenGreenNativeFirmwa mockedNativeFirmwareInstallerProxy.DisconnectCalled.Should().BeFalse(); //00 mockedNativeFirmwareInstallerProxy.BeginInstallationCalled.Should().BeTrue(); - eventsMonitor.OccurredEvents.Length.Should().Be(12); + eventsMonitor.OccurredEvents.Length.Should().Be(13); eventsMonitor .Should() @@ -87,6 +87,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( Task.Run(function: async () => //00 vital { + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Idle, newState: EFirmwareInstallationState.Idle); await Task.Delay(10); StateChangedAdvertisement(oldState: EFirmwareInstallationState.Idle, newState: EFirmwareInstallationState.Validating); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs index 2545aa63..7bf51840 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs @@ -95,6 +95,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( Task.Run(async () => //00 vital { + StateChangedAdvertisement(EFirmwareInstallationState.Idle, EFirmwareInstallationState.Idle); await Task.Delay(100); StateChangedAdvertisement(EFirmwareInstallationState.Idle, EFirmwareInstallationState.Validating); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs index 54edb8b3..6a7d61f7 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs @@ -84,11 +84,12 @@ public override EFirmwareInstallationVerdict BeginInstallation( Task.Run(async () => //00 vital { + StateChangedAdvertisement(EFirmwareInstallationState.Idle, EFirmwareInstallationState.Idle); await Task.Delay(100); StateChangedAdvertisement(EFirmwareInstallationState.Idle, EFirmwareInstallationState.Validating); await Task.Delay(100); - + StateChangedAdvertisement(EFirmwareInstallationState.Validating, EFirmwareInstallationState.Uploading); await Task.Delay(100); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs index 2234f05b..977e700c 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs @@ -82,6 +82,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( Task.Run(async () => //00 vital { + StateChangedAdvertisement(EFirmwareInstallationState.Idle, EFirmwareInstallationState.Idle); await Task.Delay(100); StateChangedAdvertisement(EFirmwareInstallationState.Idle, EFirmwareInstallationState.Validating); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs index 49ecb9b6..eb60e5fb 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs @@ -77,6 +77,9 @@ public override EFirmwareInstallationVerdict BeginInstallation( Task.Run(async () => //00 vital { + await Task.Delay(10); + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Idle, newState: EFirmwareInstallationState.Idle); + await Task.Delay(10); StateChangedAdvertisement(oldState: EFirmwareInstallationState.Idle, newState: EFirmwareInstallationState.Uploading); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs index 52bbdf98..8a08a6ec 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs @@ -118,6 +118,9 @@ public override EFirmwareInstallationVerdict BeginInstallation( if (_cancellationTokenSource.IsCancellationRequested) return; + await Task.Delay(100, _cancellationTokenSource.Token); + StateChangedAdvertisement(EFirmwareInstallationState.Idle, EFirmwareInstallationState.Idle); + await Task.Delay(100, _cancellationTokenSource.Token); StateChangedAdvertisement(EFirmwareInstallationState.Idle, EFirmwareInstallationState.Validating); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs index 88bdce7f..2700f069 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs @@ -65,8 +65,7 @@ public MockedGreenNativeFirmwareInstallerProxySpy14( INativeFirmwareInstallerCallbacksProxy firmwareInstallerCallbacksProxy, int numberOfFirmwareUploadingEventsToEmitCount, ECachedFirmwareType cachedFirmwareTypeToEmulate - ) - : base(firmwareInstallerCallbacksProxy) + ) : base(firmwareInstallerCallbacksProxy) { _cachedFirmwareTypeToEmulate = cachedFirmwareTypeToEmulate; _numberOfFirmwareUploadingEventsToEmitCount = numberOfFirmwareUploadingEventsToEmitCount; @@ -98,6 +97,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( Task.Run(function: async () => //00 vital { + StateChangedAdvertisement(oldState: EFirmwareInstallationState.Idle, newState: EFirmwareInstallationState.Idle); await Task.Delay(10); StateChangedAdvertisement(oldState: EFirmwareInstallationState.Idle, newState: EFirmwareInstallationState.Validating); From 2eaf34bac091eaac2bcdf1fea1877b0b95744b01 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 30 Sep 2024 13:40:56 +0200 Subject: [PATCH 009/104] refa (tests-suite): use array literals wherever possible (old was: classic array initializations via new[]) --- ...leteSuccessfully_GivenNoFilesToDownload.cs | 4 +-- ...uccessfully_GivenVariousFilesToDownload.cs | 6 ++-- ...hCollectionWithErroneousFilesToDownload.cs | 2 +- ...ntException_GivenNullForFilesToDownload.cs | 2 +- ...adTimeoutException_GivenTooSmallTimeout.cs | 2 +- ...uccessfully_GivenVariousFilesToDownload.cs | 32 +++++++++---------- ...essfully_GivenGreenNativeFileDownloader.cs | 4 +-- ...fully_GivenGreenNativeFirmwareInstaller.cs | 2 +- ..._GivenFirmwareUploadFatalErrorMidflight.cs | 2 +- ...ception_GivenGenericFatalErrorMidflight.cs | 2 +- ...meoutException_GivenFatalErrorMidflight.cs | 2 +- ...n_GivenErroneousNativeFirmwareInstaller.cs | 2 +- ...onTimeoutException_GivenTooSmallTimeout.cs | 2 +- ...ption_GivenCancellationRequestMidflight.cs | 2 +- ...ativeFileDownloaderThatSkipsIntoTesting.cs | 2 +- 15 files changed, 34 insertions(+), 34 deletions(-) diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs index b88a9a36..633e7a93 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs @@ -20,7 +20,7 @@ public async Task MultipleFilesDownloadAsync_ShouldCompleteSuccessfully_GivenNoF using var eventsMonitor = fileDownloader.Monitor(); // Act - var work = new Func>>(async () => await fileDownloader.DownloadAsync(Enumerable.Empty())); + var work = new Func>>(async () => await fileDownloader.DownloadAsync([])); // Assert var results = (await work.Should().CompleteWithinAsync(500.Milliseconds())).Which; @@ -52,7 +52,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) await Task.Delay(20); StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Complete); // order - DownloadCompletedAdvertisement(remoteFilePath, new byte[] { }); // order + DownloadCompletedAdvertisement(remoteFilePath, []); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index e6046e37..965fbe40 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -16,10 +16,10 @@ public async Task MultipleFilesDownloadAsync_ShouldCompleteSuccessfully_GivenVar // Arrange var expectedResults = new Dictionary { - { "/some/file/that/exists.bin", new byte[] { 1 } }, - { "/Some/File/That/Exists.bin", new byte[] { 2 } }, + { "/some/file/that/exists.bin", [1] }, + { "/Some/File/That/Exists.bin", [2] }, { "/some/file/that/doesnt/exist.bin", null }, - { "/some/file/that/exist/and/completes/after/a/couple/of/attempts.bin", new byte[] { 3 } }, + { "/some/file/that/exist/and/completes/after/a/couple/of/attempts.bin", [3] }, { "/some/file/that/exist/but/is/erroring/out/when/we/try/to/download/it.bin", null }, }; var mockedNativeFileDownloaderProxy = new MockedGreenNativeFileDownloaderProxySpy6(new GenericNativeFileDownloaderCallbacksProxy_(), expectedResults); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs index 8981bd7a..218779cb 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs @@ -61,7 +61,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) await Task.Delay(20); StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Complete); // order - DownloadCompletedAdvertisement(remoteFilePath, new byte[] { }); // order + DownloadCompletedAdvertisement(remoteFilePath, []); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs index b0525551..7192ddc8 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs @@ -52,7 +52,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) await Task.Delay(20); StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Complete); // order - DownloadCompletedAdvertisement(remoteFilePath, new byte[] { }); // order + DownloadCompletedAdvertisement(remoteFilePath, []); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs index 01d543ad..3f3ef198 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs @@ -64,7 +64,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) await Task.Delay(1_000); StateChangedAdvertisement(resource: remoteFilePath, oldState: EFileDownloaderState.Downloading, newState: EFileDownloaderState.Complete); // order - DownloadCompletedAdvertisement(remoteFilePath, new byte[]{}); // order + DownloadCompletedAdvertisement(remoteFilePath, []); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index 438df8a2..34dcf751 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -26,19 +26,19 @@ public async Task MultipleFilesUploadAsync_ShouldCompleteSuccessfully_GivenVario var remoteFilePathsToTest = new Dictionary { - { "\r some/file/path.bin ", new byte[] { 0 } }, - { " /some/file/path.bin ", new byte[] { 0 } }, - { "\t/some/file/path.bin ", new byte[] { 0 } }, - { " some/file/path.bin ", new byte[] { 1 } }, //intentionally included multiple times to test whether the mechanism will attempt to upload the file only once - { " Some/File/Path.bin ", new byte[] { 0 } }, - { "\t/Some/File/Path.bin ", new byte[] { 0 } }, - { " /Some/File/Path.bin ", new byte[] { 1 } }, //intentionally included multiple times to test that we handle case sensitivity correctly - { "\t/some/file/that/succeeds/after/a/couple/of/attempts.bin ", new byte[] { 0 } }, - { " /some/file/that/succeeds/after/a/couple/of/attempts.bin ", new byte[] { 1 } }, //intentionally included multiple times to test whether the mechanism will attempt to upload the file only once - - { " /some/file/to/a/folder/that/doesnt/exist.bin ", new byte[] { 0 } }, - { "\n some/file/that/is/erroring/out/when/we/try/to/upload/it.bin ", new byte[] { 0 } }, - { "\r/some/file/that/is/erroring/out/when/we/try/to/upload/it.bin ", new byte[] { 1 } }, //intentionally included multiple times to test whether the mechanism will attempt to upload the file only once + { "\r some/file/path.bin ", [0] }, + { " /some/file/path.bin ", [0] }, + { "\t/some/file/path.bin ", [0] }, + { " some/file/path.bin ", [1] }, //intentionally included multiple times to test whether the mechanism will attempt to upload the file only once + { " Some/File/Path.bin ", [0] }, + { "\t/Some/File/Path.bin ", [0] }, + { " /Some/File/Path.bin ", [1] }, //intentionally included multiple times to test that we handle case sensitivity correctly + { "\t/some/file/that/succeeds/after/a/couple/of/attempts.bin ", [0] }, + { " /some/file/that/succeeds/after/a/couple/of/attempts.bin ", [1] }, //intentionally included multiple times to test whether the mechanism will attempt to upload the file only once + + { " /some/file/to/a/folder/that/doesnt/exist.bin ", [0] }, + { "\n some/file/that/is/erroring/out/when/we/try/to/upload/it.bin ", [0] }, + { "\r/some/file/that/is/erroring/out/when/we/try/to/upload/it.bin ", [1] }, //intentionally included multiple times to test whether the mechanism will attempt to upload the file only once }; using var eventsMonitor = fileUploader.Monitor(); @@ -48,11 +48,11 @@ public async Task MultipleFilesUploadAsync_ShouldCompleteSuccessfully_GivenVario var filesThatFailedToBeUploaded = (await work.Should().CompleteWithinAsync(6.Seconds())).Which; // Assert - filesThatFailedToBeUploaded.Should().BeEquivalentTo(expectation: new[] - { + filesThatFailedToBeUploaded.Should().BeEquivalentTo(expectation: + [ "/some/file/to/a/folder/that/doesnt/exist.bin", "/some/file/that/is/erroring/out/when/we/try/to/upload/it.bin" - }); + ]); eventsMonitor.OccurredEvents .Count(args => args.EventName == nameof(fileUploader.FileUploaded)) diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleStreamUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleStreamUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index 890039ed..ec29c961 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleStreamUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleStreamUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -23,9 +23,9 @@ public partial class FileUploaderTestbed public async Task SingleStreamUploadAsync_ShouldCompleteSuccessfully_GivenGreenNativeFileUploader(string testcaseNickname, string remoteFilePath, int maxTriesCount, int sleepTimeBetweenRetriesInMs) { // Arrange - var stream = new MemoryStream(new byte[] { 1, 2, 3 }); + var stream = new MemoryStream([1, 2, 3]); - var expectedRemoteFilepath = remoteFilePath.StartsWith("/") + var expectedRemoteFilepath = remoteFilePath.StartsWith('/') ? remoteFilePath : $"/{remoteFilePath}"; diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs index c5ffc15a..d61ef372 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs @@ -21,7 +21,7 @@ public async Task InstallAsync_ShouldCompleteSuccessfully_GivenGreenNativeFirmwa using var eventsMonitor = firmwareInstaller.Monitor(); // Act - var work = new Func(() => firmwareInstaller.InstallAsync(new byte[] { 1, 2, 3 }, maxTriesCount: 1)); + var work = new Func(() => firmwareInstaller.InstallAsync([1, 2, 3], maxTriesCount: 1)); // Assert await work.Should().CompleteWithinAsync(4.Seconds()); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs index 7bf51840..cbfd924e 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs @@ -21,7 +21,7 @@ public async Task InstallAsync_ShouldThrowAllFirmwareInstallationAttemptsFailedE // Act var work = new Func(() => firmwareInstaller.InstallAsync( - data: new byte[] { 1, 2, 3 }, + data: [1, 2, 3], maxTriesCount: 2, sleepTimeBetweenRetriesInMs: 0 )); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs index 6a7d61f7..41b9c390 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs @@ -20,7 +20,7 @@ public async Task InstallAsync_ShouldThrowAllFirmwareInstallationAttemptsFailedE using var eventsMonitor = firmwareInstaller.Monitor(); // Act - var work = new Func(() => firmwareInstaller.InstallAsync(data: new byte[] { 1, 2, 3 }, maxTriesCount: 1)); + var work = new Func(() => firmwareInstaller.InstallAsync(data: [1, 2, 3], maxTriesCount: 1)); // Assert await work.Should() diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs index 977e700c..ec04ecb4 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs @@ -20,7 +20,7 @@ public async Task InstallAsync_ShouldThrowFirmwareInstallationImageSwapTimeoutEx using var eventsMonitor = firmwareInstaller.Monitor(); // Act - var work = new Func(() => firmwareInstaller.InstallAsync(data: new byte[] { 1, 2, 3 }, maxTriesCount: 1)); + var work = new Func(() => firmwareInstaller.InstallAsync(data: [1, 2, 3], maxTriesCount: 1)); // Assert await work.Should() diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationInternalErrorException_GivenErroneousNativeFirmwareInstaller.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationInternalErrorException_GivenErroneousNativeFirmwareInstaller.cs index 4103beae..3fefa4a7 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationInternalErrorException_GivenErroneousNativeFirmwareInstaller.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationInternalErrorException_GivenErroneousNativeFirmwareInstaller.cs @@ -17,7 +17,7 @@ public async Task InstallAsync_ShouldThrowFirmwareInstallationInternalErrorExcep var firmwareInstaller = new McuMgr.FirmwareInstaller.FirmwareInstaller(mockedNativeFirmwareInstallerProxy); // Act - var work = new Func(() => firmwareInstaller.InstallAsync(new byte[] { 1 }, maxTriesCount: 1)); + var work = new Func(() => firmwareInstaller.InstallAsync([1], maxTriesCount: 1)); // Assert ( diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs index eb60e5fb..1ae51cd6 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs @@ -21,7 +21,7 @@ public async Task InstallAsync_ShouldThrowFirmwareInstallationTimeoutException_G using var eventsMonitor = firmwareInstaller.Monitor(); // Act - var work = new Func(() => firmwareInstaller.InstallAsync(new byte[] { 1 }, maxTriesCount: 1, timeoutInMs: 100)); + var work = new Func(() => firmwareInstaller.InstallAsync([1], maxTriesCount: 1, timeoutInMs: 100)); // Assert await work.Should() diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs index 8a08a6ec..3a8aacde 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs @@ -32,7 +32,7 @@ public async Task InstallAsync_ShouldThrowFirmwareInstallationCancelledException firmwareInstaller.Cancel(); }); - var work = new Func(() => firmwareInstaller.InstallAsync(new byte[] { 1, 2, 3 }, maxTriesCount: 1)); + var work = new Func(() => firmwareInstaller.InstallAsync([1, 2, 3], maxTriesCount: 1)); // Assert await work.Should() diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs index 2700f069..98deb31f 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs @@ -29,7 +29,7 @@ public async Task InstallAsync_ShouldTriggerEventIdenticalFirmwareCachedOnTarget using var eventsMonitor = firmwareInstaller.Monitor(); // Act - var work = new Func(() => firmwareInstaller.InstallAsync(new byte[] { 1, 2, 3 }, maxTriesCount: 1)); + var work = new Func(() => firmwareInstaller.InstallAsync([1, 2, 3], maxTriesCount: 1)); // Assert await work.Should().CompleteWithinAsync(4.Seconds()); From 2d3ba6f65525a5e49d82c3c5550926e26294fcdb Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 30 Sep 2024 13:56:29 +0200 Subject: [PATCH 010/104] refa: .StartsWith("/") -> .StartsWith('/') for the sake of efficiency --- ...ompleteSuccessfully_GivenGreenNativeFileDownloader.cs | 2 +- ...ompleteSuccessfully_GivenGreenNativeFileDownloader.cs | 9 +++++++-- .../Shared/Common/Helpers/RemoteFilePathHelpers.cs | 2 +- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index be38c0c6..f3f4ff2e 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -23,7 +23,7 @@ public async Task SingleFileDownloadAsync_ShouldCompleteSuccessfully_GivenGreenN { // Arrange var mockedFileData = new byte[] { 1, 2, 3 }; - var expectedRemoteFilepath = remoteFilePath.StartsWith("/") + var expectedRemoteFilepath = remoteFilePath.StartsWith('/') ? remoteFilePath : $"/{remoteFilePath}"; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index 2813645a..225baf8b 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -20,10 +20,15 @@ public partial class FileUploaderTestbed [InlineData("FUT.SFUA.SCS.GGNFD.050", "/path/to/file.bin", 3, -100)] [InlineData("FUT.SFUA.SCS.GGNFD.060", "/path/to/file.bin", 3, +000)] [InlineData("FUT.SFUA.SCS.GGNFD.070", "/path/to/file.bin", 3, +100)] - public async Task SingleFileUploadAsync_ShouldCompleteSuccessfully_GivenGreenNativeFileUploader(string testcaseNickname, string remoteFilePath, int maxTriesCount, int sleepTimeBetweenRetriesInMs) + public async Task SingleFileUploadAsync_ShouldCompleteSuccessfully_GivenGreenNativeFileUploader( + string testcaseNickname, + string remoteFilePath, + int maxTriesCount, + int sleepTimeBetweenRetriesInMs + ) { // Arrange - var expectedRemoteFilepath = remoteFilePath.StartsWith("/") + var expectedRemoteFilepath = remoteFilePath.StartsWith('/') ? remoteFilePath : $"/{remoteFilePath}"; diff --git a/Laerdal.McuMgr/Shared/Common/Helpers/RemoteFilePathHelpers.cs b/Laerdal.McuMgr/Shared/Common/Helpers/RemoteFilePathHelpers.cs index 5b033a44..5e0b8ab2 100644 --- a/Laerdal.McuMgr/Shared/Common/Helpers/RemoteFilePathHelpers.cs +++ b/Laerdal.McuMgr/Shared/Common/Helpers/RemoteFilePathHelpers.cs @@ -85,7 +85,7 @@ static internal string SanitizeRemoteFilePath(string remoteFilePath) { remoteFilePath = remoteFilePath?.Trim() ?? ""; - remoteFilePath = remoteFilePath.StartsWith("/") //10 + remoteFilePath = remoteFilePath.StartsWith('/') //10 ? remoteFilePath : $"/{remoteFilePath}"; From 88bbff2e817bbbefc81cb8659fd9782f925a498d Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 30 Sep 2024 14:03:38 +0200 Subject: [PATCH 011/104] refa (StreamExtensions.cs): we now use stream.DisposeAsync() (old was: plain old .Dispose() which wasn't optimal) --- Laerdal.McuMgr/Shared/Common/Helpers/StreamExtensions.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Laerdal.McuMgr/Shared/Common/Helpers/StreamExtensions.cs b/Laerdal.McuMgr/Shared/Common/Helpers/StreamExtensions.cs index 65f36e45..c5cf75eb 100644 --- a/Laerdal.McuMgr/Shared/Common/Helpers/StreamExtensions.cs +++ b/Laerdal.McuMgr/Shared/Common/Helpers/StreamExtensions.cs @@ -16,7 +16,7 @@ static internal async Task ReadBytesAsync(this Stream stream, int maxByt var result = memoryStream.ToArray(); if (disposeStream) - stream.Dispose(); //todo use await stream.DisposeAsync() here when we upgrade to .net 8 + await stream.DisposeAsync(); return result; } @@ -32,7 +32,7 @@ static internal async Task ReadBytesAsync(this Stream stream, int maxByt ); if (disposeStream) - stream.Dispose(); //todo use await stream.DisposeAsync() here when we upgrade to .net 8 + await stream.DisposeAsync(); return tempMemoryStream.ToArray(); } From c7bf3c8932019f88a43395baf736eee3b351a20e Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 30 Sep 2024 14:39:09 +0200 Subject: [PATCH 012/104] feat (FileUploaderTestbed.SingleFileUploadAsync.ShouldAutodisposeGivenStream.GivenBooleanAutodisposedParameter.cs): new test to check if the stream got autodisposed or not --- ...uccessfully_GivenVariousFilesToDownload.cs | 5 +- ...dCompleteSuccessfully_GivenGreenStream.cs} | 2 +- ...posed_GivenBooleanAutodisposedParameter.cs | 119 ++++++++++++++++++ 3 files changed, 124 insertions(+), 2 deletions(-) rename Laerdal.McuMgr.Tests/FileUploader/{FileUploaderTestbed.SingleStreamUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs => FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs} (96%) create mode 100644 Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index 34dcf751..ac519236 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -44,7 +44,10 @@ public async Task MultipleFilesUploadAsync_ShouldCompleteSuccessfully_GivenVario using var eventsMonitor = fileUploader.Monitor(); // Act - var work = new Func>>(async () => await fileUploader.UploadAsync(remoteFilePathsAndTheirData: remoteFilePathsToTest, maxTriesPerUpload: 4)); + var work = new Func>>(async () => await fileUploader.UploadAsync( + maxTriesPerUpload: 4, + remoteFilePathsAndTheirData: remoteFilePathsToTest + )); var filesThatFailedToBeUploaded = (await work.Should().CompleteWithinAsync(6.Seconds())).Which; // Assert diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleStreamUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs similarity index 96% rename from Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleStreamUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs rename to Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs index ec29c961..9d2c2f1e 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleStreamUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs @@ -20,7 +20,7 @@ public partial class FileUploaderTestbed [InlineData("FUT.SSUA.SCS.GGNFD.050", "/path/to/file.bin", 3, -100)] [InlineData("FUT.SSUA.SCS.GGNFD.060", "/path/to/file.bin", 3, +000)] [InlineData("FUT.SSUA.SCS.GGNFD.070", "/path/to/file.bin", 3, +100)] - public async Task SingleStreamUploadAsync_ShouldCompleteSuccessfully_GivenGreenNativeFileUploader(string testcaseNickname, string remoteFilePath, int maxTriesCount, int sleepTimeBetweenRetriesInMs) + public async Task SingleFileUploadAsync_ShouldCompleteSuccessfully_GivenGreenStream(string testcaseNickname, string remoteFilePath, int maxTriesCount, int sleepTimeBetweenRetriesInMs) { // Arrange var stream = new MemoryStream([1, 2, 3]); diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs new file mode 100644 index 00000000..031705fa --- /dev/null +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs @@ -0,0 +1,119 @@ +using FluentAssertions; +using FluentAssertions.Extensions; +using Laerdal.McuMgr.Common.Enums; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; +using Laerdal.McuMgr.FileUploader.Contracts.Events; +using Laerdal.McuMgr.FileUploader.Contracts.Native; +using GenericNativeFileUploaderCallbacksProxy_ = Laerdal.McuMgr.FileUploader.FileUploader.GenericNativeFileUploaderCallbacksProxy; + +#pragma warning disable xUnit1026 + +namespace Laerdal.McuMgr.Tests.FileUploader +{ + public partial class FileUploaderTestbed + { + [Theory] + [InlineData("FUT.SSUA.SHSA.GBAP.010", true)] + [InlineData("FUT.SSUA.SHSA.GBAP.020", false)] + public async Task SingleFileUploadAsync_ShouldAutodisposeGivenStream_GivenBooleanAutodisposedParameter(string testcaseNickname, bool shouldAutodisposeStream) + { + // Arrange + var stream = new MemoryStream([1, 2, 3]); + + const string remoteFilePath = "/foo/bar/ping.bin"; + + var mockedNativeFileUploaderProxy = new MockedGreenNativeFileUploaderProxySpy110(uploaderCallbacksProxy: new GenericNativeFileUploaderCallbacksProxy_()); + var fileUploader = new McuMgr.FileUploader.FileUploader(mockedNativeFileUploaderProxy); + + using var eventsMonitor = fileUploader.Monitor(); + + // Act + var work = new Func(() => fileUploader.UploadAsync( + data: stream, + maxTriesCount: 1, + remoteFilePath: remoteFilePath, + autodisposeStream: shouldAutodisposeStream + )); + + // Assert + await work.Should().CompleteWithinAsync(2.Seconds()); + + mockedNativeFileUploaderProxy.CancelCalled.Should().BeFalse(); + mockedNativeFileUploaderProxy.DisconnectCalled.Should().BeFalse(); //00 + mockedNativeFileUploaderProxy.BeginUploadCalled.Should().BeTrue(); + + eventsMonitor + .OccurredEvents.Where(x => x.EventName == nameof(fileUploader.FatalErrorOccurred)) + .Should().HaveCount(0); + + eventsMonitor + .Should().Raise(nameof(fileUploader.StateChanged)) + .WithSender(fileUploader) + .WithArgs(args => args.Resource == remoteFilePath && args.NewState == EFileUploaderState.Uploading); + + eventsMonitor + .Should().Raise(nameof(fileUploader.StateChanged)) + .WithSender(fileUploader) + .WithArgs(args => args.Resource == remoteFilePath && args.NewState == EFileUploaderState.Complete); + + eventsMonitor + .Should().Raise(nameof(fileUploader.FileUploaded)) + .WithSender(fileUploader) + .WithArgs(args => args.Resource == remoteFilePath); + + stream.CanRead.Should().Be(!shouldAutodisposeStream); //10 + + //00 we dont want to disconnect the device regardless of the outcome + //10 check if the stream was disposed or not based on the value of the autodisposeStream parameter + } + + private class MockedGreenNativeFileUploaderProxySpy110 : MockedNativeFileUploaderProxySpy + { + public MockedGreenNativeFileUploaderProxySpy110(INativeFileUploaderCallbacksProxy uploaderCallbacksProxy) : base(uploaderCallbacksProxy) + { + } + + public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + { + var verdict = base.BeginUpload(remoteFilePath, data); + + Task.Run(async () => //00 vital + { + await Task.Delay(10); + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Idle, EFileUploaderState.Uploading); + + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(00, 00); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(10, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(20, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(30, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(40, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(50, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(60, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(70, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(80, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(90, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(100, 10); + + await Task.Delay(20); + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Complete); // order + FileUploadedAdvertisement(remoteFilePath); // order + }); + + return verdict; + + //00 simulating the state changes in a background thread is vital in order to simulate the async nature of the native uploader + } + } + } +} \ No newline at end of file From 73902da02d5fb5ce086341f138746cc7481db27b Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 30 Sep 2024 15:11:11 +0200 Subject: [PATCH 013/104] feat (FileUploader.GetDataAsByteArray_()): enable support for callbacks that return ValueTask unconditionally (old was: there was a #if directive around this feature that was always false and the feature was never enabled) FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs has been tweaked to test all flavours of streams and whether they're getting disposed or not based on shouldAutodisposeStream --- ...posed_GivenBooleanAutodisposedParameter.cs | 24 +++++++++++++++---- .../Shared/FileUploader/FileUploader.cs | 4 +--- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs index 031705fa..e0c460e0 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs @@ -13,13 +13,27 @@ namespace Laerdal.McuMgr.Tests.FileUploader public partial class FileUploaderTestbed { [Theory] - [InlineData("FUT.SSUA.SHSA.GBAP.010", true)] - [InlineData("FUT.SSUA.SHSA.GBAP.020", false)] - public async Task SingleFileUploadAsync_ShouldAutodisposeGivenStream_GivenBooleanAutodisposedParameter(string testcaseNickname, bool shouldAutodisposeStream) + [InlineData("FUT.SSUA.SHSA.GBAP.010", "stream", true)] + [InlineData("FUT.SSUA.SHSA.GBAP.020", "stream", false)] + [InlineData("FUT.SSUA.SHSA.GBAP.030", "func_stream", true)] + [InlineData("FUT.SSUA.SHSA.GBAP.040", "func_stream", false)] + [InlineData("FUT.SSUA.SHSA.GBAP.050", "func_task_stream", true)] + [InlineData("FUT.SSUA.SHSA.GBAP.060", "func_task_stream", false)] + [InlineData("FUT.SSUA.SHSA.GBAP.070", "func_valuetask_stream", true)] + [InlineData("FUT.SSUA.SHSA.GBAP.080", "func_valuetask_stream", false)] + public async Task SingleFileUploadAsync_ShouldAutodisposeGivenStream_GivenBooleanAutodisposedParameter(string testcaseNickname, string streamType, bool shouldAutodisposeStream) { // Arrange var stream = new MemoryStream([1, 2, 3]); - + var streamProvider = streamType switch + { + "stream" => (object)stream, + "func_stream" => object () => stream, + "func_task_stream" => object () => Task.FromResult(stream), + "func_valuetask_stream" => object () => new ValueTask(stream), + _ => throw new NotImplementedException($"Wops! Don't know how to handle stream type {streamType}! (how did this happen?)") + }; + const string remoteFilePath = "/foo/bar/ping.bin"; var mockedNativeFileUploaderProxy = new MockedGreenNativeFileUploaderProxySpy110(uploaderCallbacksProxy: new GenericNativeFileUploaderCallbacksProxy_()); @@ -29,7 +43,7 @@ public async Task SingleFileUploadAsync_ShouldAutodisposeGivenStream_GivenBoolea // Act var work = new Func(() => fileUploader.UploadAsync( - data: stream, + data: streamProvider, maxTriesCount: 1, remoteFilePath: remoteFilePath, autodisposeStream: shouldAutodisposeStream diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index fbd55b40..7e07a2d4 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -386,9 +386,7 @@ void FileUploader_FatalErrorOccurred_(object sender, FatalErrorOccurredEventArgs Func openCallback => await openCallback().ReadBytesAsync(disposeStream: autodisposeStream_), Func> openAsyncCallback => await (await openAsyncCallback()).ReadBytesAsync(disposeStream: autodisposeStream_), -#if NETCOREAPP - Func> openAsyncCallback => await (await openAsyncCallback()).ReadBytesAsync(disposeStream: autodisposeStream_), //only supported in the netcore era -#endif + Func> openAsyncCallback => await (await openAsyncCallback()).ReadBytesAsync(disposeStream: autodisposeStream_), byte[] dataByteArray => dataByteArray, IEnumerable dataEnumerableBytes => dataEnumerableBytes.ToArray(), //just in case From be660b72c4da8f68d647db1cf416b2ace80c2583 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 30 Sep 2024 16:46:02 +0200 Subject: [PATCH 014/104] feat (FileUploader.cs): BeginUpload() now supports passing to it custom connection-settings (just like .BeginInstallation() of the firmware-installer class) --- .../AndroidFileUploader.java | 34 ++- .../AndroidFirmwareInstaller.java | 47 ++--- .../McuMgrBindingsiOS/IOSFileUploader.swift | 52 ++++- ...entException_GivenInvalidRemoteFilePath.cs | 22 +- ...leteSuccessfully_GivenNoFilesToDownload.cs | 22 +- ...uccessfully_GivenVariousFilesToDownload.cs | 22 +- ...hCollectionWithErroneousFilesToDownload.cs | 22 +- ...ntException_GivenNullForFilesToDownload.cs | 22 +- ...ToFailsafeSettings_GivenFlakyConnection.cs | 193 ++++++++++++++++++ ...essfully_GivenGreenNativeFileDownloader.cs | 22 +- ...ldCompleteSuccessfully_GivenGreenStream.cs | 99 ++++++--- ...posed_GivenBooleanAutodisposedParameter.cs | 48 +++-- ...ailedException_GivenFatalErrorMidflight.cs | 22 +- ...dException_GivenRogueNativeErrorMessage.cs | 22 +- ...umentException_GivenEmptyRemoteFilePath.cs | 22 +- ...FoundException_GivenNonExistentFilepath.cs | 22 +- ...ion_GivenAccessDeniedNativeErrorMessage.cs | 22 +- ...ption_GivenCancellationRequestMidflight.cs | 22 +- ...eption_GivenErroneousNativeFileUploader.cs | 22 +- ...adTimeoutException_GivenTooSmallTimeout.cs | 22 +- .../FileUploader/FileUploaderTestbed.cs | 10 +- ...u_GivenFlakyConnectionForFileUploading.cs} | 12 +- .../Droid/FileUploader/FileUploader.cs | 20 +- .../Shared/Common/Enums/EMcuMgrErrorCode.cs | 2 +- .../Contracts/IFileUploaderCommandable.cs | 74 ++++++- .../INativeFileUploaderCommandableProxy.cs | 12 +- .../Shared/FileUploader/FileUploader.cs | 139 +++++++++++-- .../FirmwareInstaller/FirmwareInstaller.cs | 20 +- .../iOS/FileUploader/FileUploader.cs | 18 +- 29 files changed, 945 insertions(+), 143 deletions(-) create mode 100644 Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs rename Laerdal.McuMgr.Tests/FirmwareInstaller/{FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs => FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs} (96%) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 72828f09..c0748604 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -78,7 +78,26 @@ public boolean tryInvalidateCachedTransport() return true; } - public EAndroidFileUploaderVerdict beginUpload(final String remoteFilePath, final byte[] data) + /** + * Initiates a file upload asynchronously. The progress is advertised through the callbacks provided by this class. + * Setup interceptors for them to get informed about the status of the firmware-installation. + * + * @param remoteFilePath the remote-file-path to save the given data to on the remote device + * @param data the bytes to upload + * @param initialMtuSize sets the initial MTU for the connection that the McuMgr BLE-transport sets up for the firmware installation that will follow. + * Note that if less than 0 it gets ignored and if it doesn't fall within the range [23, 517] it will cause a hard error. + * @param windowCapacity specifies the windows-capacity for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default + * @param memoryAlignment specifies the memory-alignment to use for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default + * + * @return a verdict indicating whether the file uploading was started successfully or not + */ + public EAndroidFileUploaderVerdict beginUpload( + final String remoteFilePath, + final byte[] data, + final int initialMtuSize, + final int windowCapacity, + final int memoryAlignment + ) { if (!IsCold()) { setState(EAndroidFileUploaderState.ERROR); @@ -132,7 +151,7 @@ public EAndroidFileUploaderVerdict beginUpload(final String remoteFilePath, fina return EAndroidFileUploaderVerdict.FAILED__INVALID_DATA; } - ensureTransportIsInitializedExactlyOnce(); //order + ensureTransportIsInitializedExactlyOnce(initialMtuSize); //order final EAndroidFileUploaderVerdict verdict = ensureFilesystemManagerIsInitializedExactlyOnce(); //order if (verdict != EAndroidFileUploaderVerdict.SUCCESS) @@ -147,8 +166,8 @@ public EAndroidFileUploaderVerdict beginUpload(final String remoteFilePath, fina _fileSystemManager, _remoteFilePathSanitized, data, - 3, // window capacity - 4 // memory alignment + Math.max(1, windowCapacity), + Math.max(1, memoryAlignment) ).uploadAsync(_fileUploaderCallbackProxy); return EAndroidFileUploaderVerdict.SUCCESS; @@ -166,12 +185,17 @@ private void resetUploadState() { fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); } - private void ensureTransportIsInitializedExactlyOnce() + private void ensureTransportIsInitializedExactlyOnce(int initialMtuSize) { if (_transport != null) return; _transport = new McuMgrBleTransport(_context, _bluetoothDevice); + + if (initialMtuSize > 0) + { + _transport.setInitialMtu(initialMtuSize); + } } private void ensureFileUploaderCallbackProxyIsInitializedExactlyOnce() { diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java index 751d52c1..eef36436 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java @@ -60,8 +60,8 @@ public AndroidFirmwareInstaller(@NonNull final Context context, @NonNull final B * Note that if less than 0 it gets ignored and if it doesn't fall within the range [23, 517] it will cause a hard error. * @param eraseSettings specifies whether the previous settings should be erased on the target-device * @param estimatedSwapTimeInMilliseconds specifies the amount of time to wait before probing the device to see if the firmware that got installed managed to reboot the device successfully - if negative the setting gets ignored - * @param windowCapacity specifies the windows-capacity for the data transfers of the BLE connection - if negative this settings gets ignored - * @param memoryAlignment specifies the memory-alignment to use for the data transfers of the BLE connection - - if negative this settings gets ignored + * @param windowCapacity specifies the windows-capacity for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default + * @param memoryAlignment specifies the memory-alignment to use for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default * * @return a verdict indicating whether the firmware installation was started successfully or not */ @@ -153,25 +153,6 @@ public EAndroidFirmwareInstallationVerdict beginInstallation( } return EAndroidFirmwareInstallationVerdict.SUCCESS; - - //0 set the installation mode - // - //1 rF52840 due to how the flash memory works requires ~20 sec to erase images - // - //2 Set the window capacity. Values > 1 enable a new implementation for uploading the images, which makes use of SMP pipelining feature. - // - // The app will send this many packets immediately, without waiting for notification confirming each packet. This value should be lower than or - // equal to MCUMGR_BUF_COUNT - // - // (https://github.com/zephyrproject-rtos/zephyr/blob/bd4ddec0c8c822bbdd420bd558b62c1d1a532c16/subsys/mgmt/mcumgr/Kconfig#L550) - // - // Parameter in KConfig in NCS / Zephyr configuration and should also be supported on Mynewt devices. - // - // Mind, that in Zephyr, before https://github.com/zephyrproject-rtos/zephyr/pull/41959 was merged, the device required data to be sent - // with memory alignment. Otherwise, the device would ignore uneven bytes and reply with lower than expected offset causing multiple packets - // to be sent again dropping the speed instead of increasing it. - // - //3 Set the selected memory alignment. In the app this defaults to 4 to match Nordic devices, but can be modified in the UI. } private @NotNull Settings digestFirmwareInstallationManagerSettings(@NotNull EAndroidFirmwareInstallationMode mode, boolean eraseSettings, int estimatedSwapTimeInMilliseconds, int windowCapacity, int memoryAlignment) @@ -185,12 +166,12 @@ public EAndroidFirmwareInstallationVerdict beginInstallation( settingsBuilder.setEstimatedSwapTime(estimatedSwapTimeInMilliseconds); //1 } - if (windowCapacity >= 0) + if (windowCapacity >= 2) { settingsBuilder.setWindowCapacity(windowCapacity); //2 } - if (memoryAlignment >= 1) + if (memoryAlignment >= 2) { settingsBuilder.setMemoryAlignment(memoryAlignment); //3 } @@ -198,6 +179,26 @@ public EAndroidFirmwareInstallationVerdict beginInstallation( settingsBuilder.setEraseAppSettings(eraseSettings); return settingsBuilder.build(); + + + //0 set the installation mode + // + //1 rF52840 due to how the flash memory works requires ~20 sec to erase images + // + //2 Set the window capacity. Values > 1 enable a new implementation for uploading the images, which makes use of SMP pipelining feature. + // + // The app will send this many packets immediately, without waiting for notification confirming each packet. This value should be lower than or + // equal to MCUMGR_BUF_COUNT + // + // (https://github.com/zephyrproject-rtos/zephyr/blob/bd4ddec0c8c822bbdd420bd558b62c1d1a532c16/subsys/mgmt/mcumgr/Kconfig#L550) + // + // Parameter in KConfig in NCS / Zephyr configuration and should also be supported on Mynewt devices. + // + // Mind, that in Zephyr, before https://github.com/zephyrproject-rtos/zephyr/pull/41959 was merged, the device required data to be sent + // with memory alignment. Otherwise, the device would ignore uneven bytes and reply with lower than expected offset causing multiple packets + // to be sent again dropping the speed instead of increasing it. + // + //3 Set the selected memory alignment. In the app this defaults to 4 to match Nordic devices, but can be modified in the UI. } public void disconnect() { diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift index 62aaa6c4..8a4248c7 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift @@ -57,7 +57,13 @@ public class IOSFileUploader: NSObject { } @objc - public func beginUpload(_ remoteFilePath: String, _ data: Data) -> EIOSFileUploadingInitializationVerdict { + public func beginUpload( + _ remoteFilePath: String, + _ data: Data, + _ pipelineDepth: Int, + _ byteAlignment: Int + ) -> EIOSFileUploadingInitializationVerdict { + if !IsCold() { //if another upload is already in progress we bail out setState(EIOSFileUploaderState.error) onError("Another upload is already in progress") @@ -66,12 +72,27 @@ public class IOSFileUploader: NSObject { } if _cbPeripheral == nil { - setState(EIOSFileUploaderState.error); + setState(EIOSFileUploaderState.error) onError("No bluetooth-device specified - call trySetBluetoothDevice() first"); return EIOSFileUploadingInitializationVerdict.failedInvalidSettings; } + if (pipelineDepth >= 2 && byteAlignment <= 1) { + setState(EIOSFileUploaderState.error) + onError("When pipeline-depth is set to 2 or above you must specify a byte-alignment >=2 (given byte-alignment is '\(byteAlignment)')") + + return .failedInvalidSettings + } + + let byteAlignmentEnum = translateByteAlignmentMode(byteAlignment); + if (byteAlignmentEnum == nil) { + setState(EIOSFileUploaderState.error) + onError("Invalid byte-alignment value '\(byteAlignment)': It must be a power of 2 up to 16") + + return .failedInvalidSettings + } + _remoteFilePathSanitized = remoteFilePath.trimmingCharacters(in: .whitespacesAndNewlines) if _remoteFilePathSanitized.isEmpty { setState(EIOSFileUploaderState.error) @@ -98,16 +119,22 @@ public class IOSFileUploader: NSObject { // return EIOSFileUploaderVerdict.FAILED__INVALID_DATA // } - disposeFilesystemManager() //vital hack normally we shouldnt need this but there seems to be a bug in the lib https://github.com/NordicSemiconductor/IOS-nRF-Connect-Device-Manager/issues/209 + disposeFilesystemManager() //vital hack normally we shouldnt need this but there seems to be a bug in the lib https://github.com/NordicSemiconductor/IOS-nRF-Connect-Device-Manager/issues/209 ensureTransportIsInitializedExactlyOnce() //order ensureFilesystemManagerIsInitializedExactlyOnce() //order resetUploadState() //order + var configuration = FirmwareUpgradeConfiguration(byteAlignment: byteAlignmentEnum!) + if (pipelineDepth >= 0) { + configuration.pipelineDepth = pipelineDepth + } + let success = _fileSystemManager.upload( //order name: _remoteFilePathSanitized, data: data, + using: configuration, delegate: self ) if !success { @@ -119,6 +146,25 @@ public class IOSFileUploader: NSObject { return EIOSFileUploadingInitializationVerdict.success } + + private func translateByteAlignmentMode(_ alignment: Int) -> ImageUploadAlignment? { + if (alignment <= 0) { + return .disabled; + } + + switch alignment { + case 2: + return .twoByte + case 4: + return .fourByte + case 8: + return .eightByte + case 16: + return .sixteenByte + default: + return nil + } + } @objc public func getLastFatalErrorMessage() -> String { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.BeginUpload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.BeginUpload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs index c9398157..9d861831 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.BeginUpload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.BeginUpload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs @@ -46,9 +46,27 @@ public MockedGreenNativeFileUploaderProxySpy1(INativeFileUploaderCallbacksProxy { } - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] mockedFileData) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - var verdict = base.BeginUpload(remoteFilePath, mockedFileData); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs index a12c4c65..8b5e556b 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs @@ -40,9 +40,27 @@ public MockedGreenNativeFileUploaderProxySpy5(INativeFileUploaderCallbacksProxy { } - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - var verdict = base.BeginUpload(remoteFilePath, data); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index ac519236..580d61ef 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -80,9 +80,27 @@ public MockedGreenNativeFileUploaderProxySpy6(INativeFileUploaderCallbacksProxy } private int _retryCountForProblematicFile; - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - var verdict = base.BeginUpload(remoteFilePath, data); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs index c40c7949..3e96bd9f 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs @@ -49,9 +49,27 @@ public MockedGreenNativeFileUploaderProxySpy11(INativeFileUploaderCallbacksProxy { } - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - var verdict = base.BeginUpload(remoteFilePath, data); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs index 6dc97e0f..69456f8b 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs @@ -40,9 +40,27 @@ public MockedGreenNativeFileUploaderProxySpy10(INativeFileUploaderCallbacksProxy { } - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - var verdict = base.BeginUpload(remoteFilePath, data); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs new file mode 100644 index 00000000..52399597 --- /dev/null +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -0,0 +1,193 @@ +using FluentAssertions; +using FluentAssertions.Extensions; +using Laerdal.McuMgr.Common.Constants; +using Laerdal.McuMgr.Common.Enums; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; +using Laerdal.McuMgr.FileUploader.Contracts.Events; +using Laerdal.McuMgr.FileUploader.Contracts.Native; +using GenericNativeFileUploaderCallbacksProxy_ = Laerdal.McuMgr.FileUploader.FileUploader.GenericNativeFileUploaderCallbacksProxy; + +#pragma warning disable xUnit1026 + +namespace Laerdal.McuMgr.Tests.FileUploader +{ + public partial class FileUploaderTestbed + { + [Theory] + [InlineData("FUT.SFUA.SCSBFBTFS.GFBC.010", "/path/to/file.bin", 2)] + [InlineData("FUT.SFUA.SCSBFBTFS.GFBC.020", "/path/to/file.bin", 3)] + [InlineData("FUT.SFUA.SCSBFBTFS.GFBC.030", "/path/to/file.bin", 5)] + public async Task SingleFileUploadAsync_ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyBluetoothConnection(string testcaseNickname, string remoteFilePath, int maxTriesCount) + { + // Arrange + var stream = new MemoryStream([1, 2, 3]); + + var mockedNativeFileUploaderProxy = new MockedGreenNativeFileUploaderProxySpy120( + maxTriesCount: maxTriesCount, + uploaderCallbacksProxy: new GenericNativeFileUploaderCallbacksProxy_() + ); + var fileUploader = new McuMgr.FileUploader.FileUploader(mockedNativeFileUploaderProxy); + + using var eventsMonitor = fileUploader.Monitor(); + + // Act + var work = new Func(() => fileUploader.UploadAsync( + data: stream, + maxTriesCount: maxTriesCount, + remoteFilePath: remoteFilePath + )); + + // Assert + await work.Should().CompleteWithinAsync((maxTriesCount * 2).Seconds()); + + mockedNativeFileUploaderProxy.BugDetected.Should().BeNull(); + mockedNativeFileUploaderProxy.CancelCalled.Should().BeFalse(); + mockedNativeFileUploaderProxy.DisconnectCalled.Should().BeFalse(); //00 + mockedNativeFileUploaderProxy.BeginUploadCalled.Should().BeTrue(); + + eventsMonitor + .OccurredEvents.Where(x => x.EventName == nameof(fileUploader.FatalErrorOccurred)) + .Should().HaveCount(maxTriesCount - 1); //one error for each try except the last one + + eventsMonitor + .Should().Raise(nameof(fileUploader.StateChanged)) + .WithSender(fileUploader) + .WithArgs(args => args.Resource == remoteFilePath && args.NewState == EFileUploaderState.Uploading); + + eventsMonitor + .Should().Raise(nameof(fileUploader.StateChanged)) + .WithSender(fileUploader) + .WithArgs(args => args.Resource == remoteFilePath && args.NewState == EFileUploaderState.Complete); + + eventsMonitor + .Should().Raise(nameof(fileUploader.FileUploaded)) + .WithSender(fileUploader) + .WithArgs(args => args.Resource == remoteFilePath); + + //00 we dont want to disconnect the device regardless of the outcome + } + + private class MockedGreenNativeFileUploaderProxySpy120 : MockedNativeFileUploaderProxySpy + { + private readonly int _maxTriesCount; + + public string BugDetected { get; private set; } + + public MockedGreenNativeFileUploaderProxySpy120(INativeFileUploaderCallbacksProxy uploaderCallbacksProxy, int maxTriesCount) : base(uploaderCallbacksProxy) + { + _maxTriesCount = maxTriesCount; + } + + private int _tryCounter; + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) + { + _tryCounter++; + + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); + + Task.Run(async () => //00 vital + { + await Task.Delay(10); + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Idle, EFileUploaderState.Uploading); + + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(00, 00); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(10, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(20, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(30, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(40, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(50, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(60, 10); + + if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize) + { + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order + return; + } + + if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity) + { + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order + return; + } + + if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment) + { + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order + return; + } + + if (_tryCounter == _maxTriesCount && pipelineDepth != AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth) + { + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order + return; + } + + if (_tryCounter == _maxTriesCount && byteAlignment != AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment) + { + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order + return; + } + + if (_tryCounter < _maxTriesCount) + { + await Task.Delay(20); + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order + return; + } + + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(70, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(80, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(90, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(100, 10); + + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Complete); // order + FileUploadedAdvertisement(remoteFilePath); // order + }); + + return verdict; + + //00 simulating the state changes in a background thread is vital in order to simulate the async nature of the native uploader + } + } + } +} \ No newline at end of file diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index 225baf8b..7052e8b0 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -87,11 +87,29 @@ public MockedGreenNativeFileUploaderProxySpy(INativeFileUploaderCallbacksProxy u } private int _tryCount; - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { _tryCount++; - var verdict = base.BeginUpload(remoteFilePath, data); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs index 9d2c2f1e..906eeeae 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs @@ -1,9 +1,11 @@ using FluentAssertions; using FluentAssertions.Extensions; +using Laerdal.McuMgr.Common.Constants; using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.FileUploader.Contracts.Enums; using Laerdal.McuMgr.FileUploader.Contracts.Events; using Laerdal.McuMgr.FileUploader.Contracts.Native; +using Laerdal.McuMgr.FirmwareInstaller.Contracts.Enums; using GenericNativeFileUploaderCallbacksProxy_ = Laerdal.McuMgr.FileUploader.FileUploader.GenericNativeFileUploaderCallbacksProxy; #pragma warning disable xUnit1026 @@ -13,25 +15,25 @@ namespace Laerdal.McuMgr.Tests.FileUploader public partial class FileUploaderTestbed { [Theory] - [InlineData("FUT.SSUA.SCS.GGNFD.010", "path/to/file.bin", 01, +100)] // this should be normalized to /path/to/file.bin - [InlineData("FUT.SSUA.SCS.GGNFD.020", "/path/to/file.bin", 2, -100)] // negative sleep time should be interpreted as 0 - [InlineData("FUT.SSUA.SCS.GGNFD.030", "/path/to/file.bin", 2, +000)] - [InlineData("FUT.SSUA.SCS.GGNFD.040", "/path/to/file.bin", 2, +100)] - [InlineData("FUT.SSUA.SCS.GGNFD.050", "/path/to/file.bin", 3, -100)] - [InlineData("FUT.SSUA.SCS.GGNFD.060", "/path/to/file.bin", 3, +000)] - [InlineData("FUT.SSUA.SCS.GGNFD.070", "/path/to/file.bin", 3, +100)] - public async Task SingleFileUploadAsync_ShouldCompleteSuccessfully_GivenGreenStream(string testcaseNickname, string remoteFilePath, int maxTriesCount, int sleepTimeBetweenRetriesInMs) + [InlineData("FUT.SFUA.SCS.GVSTBR.010", "path/to/file.bin", 01, +100)] // this should be normalized to /path/to/file.bin + [InlineData("FUT.SFUA.SCS.GVSTBR.020", "/path/to/file.bin", 2, -100)] // negative sleep time should be interpreted as 0 + [InlineData("FUT.SFUA.SCS.GVSTBR.030", "/path/to/file.bin", 2, +000)] + [InlineData("FUT.SFUA.SCS.GVSTBR.040", "/path/to/file.bin", 2, +100)] + [InlineData("FUT.SFUA.SCS.GVSTBR.050", "/path/to/file.bin", 3, -100)] + [InlineData("FUT.SFUA.SCS.GVSTBR.060", "/path/to/file.bin", 3, +000)] + [InlineData("FUT.SFUA.SCS.GVSTBR.070", "/path/to/file.bin", 3, +100)] + public async Task SingleFileUploadAsync_ShouldCompleteSuccessfully_GivenVariousSleepTimesBetweenRetries(string testcaseNickname, string remoteFilePath, int maxTriesCount, int sleepTimeBetweenRetriesInMs) { // Arrange var stream = new MemoryStream([1, 2, 3]); - + var expectedRemoteFilepath = remoteFilePath.StartsWith('/') ? remoteFilePath : $"/{remoteFilePath}"; var mockedNativeFileUploaderProxy = new MockedGreenNativeFileUploaderProxySpy100( - uploaderCallbacksProxy: new GenericNativeFileUploaderCallbacksProxy_(), - maxNumberOfTriesForSuccess: maxTriesCount + maxTriesCount: maxTriesCount, + uploaderCallbacksProxy: new GenericNativeFileUploaderCallbacksProxy_() ); var fileUploader = new McuMgr.FileUploader.FileUploader(mockedNativeFileUploaderProxy); @@ -51,11 +53,11 @@ public async Task SingleFileUploadAsync_ShouldCompleteSuccessfully_GivenGreenStr mockedNativeFileUploaderProxy.CancelCalled.Should().BeFalse(); mockedNativeFileUploaderProxy.DisconnectCalled.Should().BeFalse(); //00 mockedNativeFileUploaderProxy.BeginUploadCalled.Should().BeTrue(); - + eventsMonitor .OccurredEvents.Where(x => x.EventName == nameof(fileUploader.FatalErrorOccurred)) .Should().HaveCount(maxTriesCount - 1); //one error for each try except the last one - + eventsMonitor .Should().Raise(nameof(fileUploader.StateChanged)) .WithSender(fileUploader) @@ -76,33 +78,78 @@ public async Task SingleFileUploadAsync_ShouldCompleteSuccessfully_GivenGreenStr private class MockedGreenNativeFileUploaderProxySpy100 : MockedNativeFileUploaderProxySpy { - private readonly int _maxNumberOfTriesForSuccess; - - public MockedGreenNativeFileUploaderProxySpy100(INativeFileUploaderCallbacksProxy uploaderCallbacksProxy, int maxNumberOfTriesForSuccess) : base(uploaderCallbacksProxy) + private readonly int _maxTriesCount; + + public MockedGreenNativeFileUploaderProxySpy100(INativeFileUploaderCallbacksProxy uploaderCallbacksProxy, int maxTriesCount) : base(uploaderCallbacksProxy) { - _maxNumberOfTriesForSuccess = maxNumberOfTriesForSuccess; + _maxTriesCount = maxTriesCount; } - private int _tryCount; - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + private int _tryCounter; + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - _tryCount++; - - var verdict = base.BeginUpload(remoteFilePath, data); + _tryCounter++; + + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Idle, EFileUploaderState.Idle); await Task.Delay(10); + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Idle, EFileUploaderState.Uploading); + await Task.Delay(10); + + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(00, 00); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(10, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(20, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(30, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(40, 10); + await Task.Delay(5); - await Task.Delay(20); - if (_tryCount < _maxNumberOfTriesForSuccess) + if (_tryCounter < _maxTriesCount) { - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileUploaderGroupReturnCode.Unset); // order + await Task.Delay(20); + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order return; } + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(50, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(60, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(70, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(80, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(90, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(100, 10); + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Complete); // order FileUploadedAdvertisement(remoteFilePath); // order }); diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs index e0c460e0..44249038 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs @@ -13,30 +13,30 @@ namespace Laerdal.McuMgr.Tests.FileUploader public partial class FileUploaderTestbed { [Theory] - [InlineData("FUT.SSUA.SHSA.GBAP.010", "stream", true)] - [InlineData("FUT.SSUA.SHSA.GBAP.020", "stream", false)] - [InlineData("FUT.SSUA.SHSA.GBAP.030", "func_stream", true)] - [InlineData("FUT.SSUA.SHSA.GBAP.040", "func_stream", false)] - [InlineData("FUT.SSUA.SHSA.GBAP.050", "func_task_stream", true)] - [InlineData("FUT.SSUA.SHSA.GBAP.060", "func_task_stream", false)] - [InlineData("FUT.SSUA.SHSA.GBAP.070", "func_valuetask_stream", true)] - [InlineData("FUT.SSUA.SHSA.GBAP.080", "func_valuetask_stream", false)] - public async Task SingleFileUploadAsync_ShouldAutodisposeGivenStream_GivenBooleanAutodisposedParameter(string testcaseNickname, string streamType, bool shouldAutodisposeStream) + [InlineData("FUT.SFUA.SCAGS.GBAP.010", "stream", true)] + [InlineData("FUT.SFUA.SCAGS.GBAP.020", "stream", false)] + [InlineData("FUT.SFUA.SCAGS.GBAP.030", "func_stream", true)] + [InlineData("FUT.SFUA.SCAGS.GBAP.040", "func_stream", false)] + [InlineData("FUT.SFUA.SCAGS.GBAP.050", "func_task_stream", true)] + [InlineData("FUT.SFUA.SCAGS.GBAP.060", "func_task_stream", false)] + [InlineData("FUT.SFUA.SCAGS.GBAP.070", "func_valuetask_stream", true)] + [InlineData("FUT.SFUA.SCAGS.GBAP.080", "func_valuetask_stream", false)] + public async Task SingleFileUploadAsync_ShouldConditionallyAutodisposeGivenStream_GivenBooleanAutodisposedParameter(string testcaseNickname, string streamType, bool shouldAutodisposeStream) { // Arrange var stream = new MemoryStream([1, 2, 3]); var streamProvider = streamType switch { "stream" => (object)stream, - "func_stream" => object () => stream, - "func_task_stream" => object () => Task.FromResult(stream), - "func_valuetask_stream" => object () => new ValueTask(stream), + "func_stream" => () => stream, + "func_task_stream" => () => Task.FromResult(stream), + "func_valuetask_stream" => () => new ValueTask(stream), _ => throw new NotImplementedException($"Wops! Don't know how to handle stream type {streamType}! (how did this happen?)") }; const string remoteFilePath = "/foo/bar/ping.bin"; - var mockedNativeFileUploaderProxy = new MockedGreenNativeFileUploaderProxySpy110(uploaderCallbacksProxy: new GenericNativeFileUploaderCallbacksProxy_()); + var mockedNativeFileUploaderProxy = new MockedGreenNativeFileUploaderProxySpy110(new GenericNativeFileUploaderCallbacksProxy_()); var fileUploader = new McuMgr.FileUploader.FileUploader(mockedNativeFileUploaderProxy); using var eventsMonitor = fileUploader.Monitor(); @@ -87,9 +87,27 @@ public MockedGreenNativeFileUploaderProxySpy110(INativeFileUploaderCallbacksProx { } - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - var verdict = base.BeginUpload(remoteFilePath, data); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs index 4857cbfa..3c9c3332 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs @@ -72,9 +72,27 @@ public MockedGreenNativeFileUploaderProxySpy4(INativeFileUploaderCallbacksProxy { } - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - var verdict = base.BeginUpload(remoteFilePath, data); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs index 07918f0a..65005a0b 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs @@ -82,9 +82,27 @@ public MockedErroneousNativeFileUploaderProxySpy13(INativeFileUploaderCallbacksP _nativeErrorMessageForFileNotFound = nativeErrorMessageForFileNotFound; } - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - var verdict = base.BeginUpload(remoteFilePath, data); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs index 94dd02c2..a636b657 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs @@ -42,9 +42,27 @@ public MockedGreenNativeFileUploaderProxySpy2(INativeFileUploaderCallbacksProxy { } - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - var verdict = base.BeginUpload(remoteFilePath, data); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs index 8ec98478..5d48ca0f 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs @@ -99,9 +99,27 @@ string nativeErrorMessageForFileNotFound _nativeErrorMessageForFileNotFound = nativeErrorMessageForFileNotFound; } - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - var verdict = base.BeginUpload(remoteFilePath, data); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs index bde5a23c..93659408 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs @@ -36,9 +36,27 @@ public MockedErroneousNativeFileUploaderProxySpy100(INativeFileUploaderCallbacks { } - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - var verdict = base.BeginUpload(remoteFilePath, data); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadCancelledException_GivenCancellationRequestMidflight.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadCancelledException_GivenCancellationRequestMidflight.cs index 6391e52e..7e989dc6 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadCancelledException_GivenCancellationRequestMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadCancelledException_GivenCancellationRequestMidflight.cs @@ -88,7 +88,15 @@ public override void Cancel() // a best effort basis and this is exactly what we are testing here } - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { (FileUploader as IFileUploaderEventSubscribable)!.Cancelled += (sender, args) => { @@ -98,7 +106,17 @@ public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] d _currentRemoteFilePath = remoteFilePath; _cancellationTokenSource = new CancellationTokenSource(); - var verdict = base.BeginUpload(remoteFilePath, data); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadInternalErrorException_GivenErroneousNativeFileUploader.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadInternalErrorException_GivenErroneousNativeFileUploader.cs index 02dc69d8..d0d238a4 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadInternalErrorException_GivenErroneousNativeFileUploader.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadInternalErrorException_GivenErroneousNativeFileUploader.cs @@ -34,9 +34,27 @@ public MockedErroneousNativeFileUploaderProxySpy(INativeFileUploaderCallbacksPro { } - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - base.BeginUpload(remoteFilePath, data); + base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Thread.Sleep(100); diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadTimeoutException_GivenTooSmallTimeout.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadTimeoutException_GivenTooSmallTimeout.cs index 2cf1044a..3574ac30 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadTimeoutException_GivenTooSmallTimeout.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadTimeoutException_GivenTooSmallTimeout.cs @@ -55,9 +55,27 @@ public MockedGreenButSlowNativeFileUploaderProxySpy(INativeFileUploaderCallbacks { } - public override EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - var verdict = base.BeginUpload(remoteFilePath, data); + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs index 5dbc7fcd..f94a2946 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs @@ -28,7 +28,15 @@ protected MockedNativeFileUploaderProxySpy(INativeFileUploaderCallbacksProxy upl _uploaderCallbacksProxy = uploaderCallbacksProxy; } - public virtual EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public virtual EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, + int? byteAlignment = null, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null + ) { BeginUploadCalled = true; diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs similarity index 96% rename from Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs rename to Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs index efb7ed44..91fe5093 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs @@ -26,7 +26,7 @@ public partial class FirmwareInstallerTestbed [InlineData("FIT.IA.SCSWLDAULIM.GPDFFU.010", 2)] [InlineData("FIT.IA.SCSWLDAULIM.GPDFFU.020", 3)] [InlineData("FIT.IA.SCSWLDAULIM.GPDFFU.030", 5)] - public async Task InstallAsync_ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenProblematicDeviceForFileUploading(string testNickname, int maxTriesCount) + public async Task InstallAsync_ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading(string testNickname, int maxTriesCount) { // Arrange var mockedNativeFirmwareInstallerProxy = new MockedGreenNativeFirmwareInstallerProxySpy10(new GenericNativeFirmwareInstallerCallbacksProxy_(), maxTriesCount); @@ -180,7 +180,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize} but it's set to {initialMtuSize} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; @@ -188,7 +188,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity} but it's set to {windowCapacity} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; @@ -196,7 +196,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment} but it's set to {memoryAlignment} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; @@ -204,7 +204,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( if (_tryCounter == _maxTriesCount && pipelineDepth != AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth} but it's set to {pipelineDepth} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; @@ -212,7 +212,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( if (_tryCounter == _maxTriesCount && byteAlignment != AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment} but it's set to {byteAlignment} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; diff --git a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs index c1b75c5c..3742d8dd 100644 --- a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs @@ -99,11 +99,25 @@ public void CleanupResourcesOfLastUpload() #region commands - public new EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth, + int? byteAlignment, + int? initialMtuSize, + int? windowCapacity, + int? memoryAlignment + ) { - return TranslateFileUploaderVerdict(base.BeginUpload(remoteFilePath, data)); + return TranslateFileUploaderVerdict(base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize ?? -1, + windowCapacity: windowCapacity ?? -1, + memoryAlignment: memoryAlignment ?? -1 + )); } - + public bool TrySetContext(object context) //the parameter must be of type 'object' so that it wont cause problems in platforms other than android { var androidContext = context as Context ?? throw new ArgumentException($"Expected {nameof(Context)} to be an AndroidContext but got '{context?.GetType().Name ?? "null"}' instead", nameof(context)); diff --git a/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs b/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs index 6751bc1e..2edb0638 100644 --- a/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs +++ b/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs @@ -4,7 +4,7 @@ public enum EMcuMgrErrorCode // must mirror io.runtime.mcumgr.McuMgrErrorCode @ { Unset = -99, //this is our own to mark that we haven't received any error code from the device Ok = 000, - Unknown = 001, + Unknown = 001, //when uploading files to the device this error code means that the target file-path has one or more non-existent directories in it NoMemory = 002, InValue = 003, Timeout = 004, diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs index 71853990..43410b5d 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs @@ -23,13 +23,34 @@ public interface IFileUploaderCommandable /// Maximum amount of tries per upload before bailing out. In case of errors the mechanism will try "maxTriesPerUpload" before bailing out. /// If set to 'true' (which is the default) the mechanism will move to the next file to upload whenever a particular file fails to be uploaded despite all retries /// If set to 'true' the mechanism will dispose of the data-streams after they have been read into their respective byte arrays (default is 'false'). + /// (iOS only) If set to a value larger than 1, this enables SMP Pipelining, wherein multiple packets of data ('chunks') are sent at + /// once before awaiting a response, which can lead to a big increase in transfer speed if the receiving hardware supports this feature. + /// (iOS only) When PipelineLength is larger than 1 (SMP Pipelining Enabled) it's necessary to set this in order for the stack + /// to predict offset jumps as multiple packets are sent in parallel. + /// (Android only) Set the initial MTU size for the connection employed by the firmware-installation + /// (useful for some problematic devices such as Samsung A8 tablets). Acceptable custom values must lay within the range [23, 517]. + /// If null, zero or negative it will default to 498. Note that in quirky devices like Samsung Galaxy A8 the only value that works is 23 - anything else fails. + /// (Android only) Set the window capacity. Values > 1 enable a new implementation for uploading + /// the images, which makes use of SMP pipelining feature. The app will send this many packets immediately, without waiting for notification + /// confirming each packet. This value should be lower than or equal to MCUMGR_BUF_COUNT + /// (https://github.com/zephyrproject-rtos/zephyr/blob/bd4ddec0c8c822bbdd420bd558b62c1d1a532c16/subsys/mgmt/mcumgr/Kconfig#L550) + /// parameter in KConfig in NCS / Zephyr configuration and should also be supported on Mynewt devices. Mind, that in Zephyr, + /// before https://github.com/zephyrproject-rtos/zephyr/pull/41959 was merged, the device required data to be sent with memory alignment. + /// Otherwise, the device would ignore uneven bytes and reply with lower than expected offset + /// causing multiple packets to be sent again dropping the speed instead of increasing it. + /// (Android only) Set the selected memory alignment. Defaults to 4 to match Nordic devices. Task> UploadAsync( IDictionary remoteFilePathsAndTheirData, int sleepTimeBetweenRetriesInMs = 100, int timeoutPerUploadInMs = -1, int maxTriesPerUpload = 10, bool moveToNextUploadInCaseOfError = true, - bool autodisposeStreams = false + bool autodisposeStreams = false, + int? pipelineDepth = null, + int? byteAlignment = null, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null ); /// Uploads the given data (typically representing the contents of a file either as a stream or a raw byte array). @@ -48,6 +69,22 @@ Task> UploadAsync( /// The time to sleep between each retry after a failed try. /// The time to wait (in milliseconds) for a cancellation request to be properly handled. If this timeout expires then the mechanism will bail out forcefully without waiting for the underlying native code to cleanup properly. /// If set to 'true' the mechanism will dispose of the data-stream after it has been read into a byte array (default is 'false'). + /// (iOS only) If set to a value larger than 1, this enables SMP Pipelining, wherein multiple packets of data ('chunks') are sent at + /// once before awaiting a response, which can lead to a big increase in transfer speed if the receiving hardware supports this feature. + /// (iOS only) When PipelineLength is larger than 1 (SMP Pipelining Enabled) it's necessary to set this in order for the stack + /// to predict offset jumps as multiple packets are sent in parallel. + /// (Android only) Set the initial MTU size for the connection employed by the firmware-installation + /// (useful for some problematic devices such as Samsung A8 tablets). Acceptable custom values must lay within the range [23, 517]. + /// If null, zero or negative it will default to 498. Note that in quirky devices like Samsung Galaxy A8 the only value that works is 23 - anything else fails. + /// (Android only) Set the window capacity. Values > 1 enable a new implementation for uploading + /// the images, which makes use of SMP pipelining feature. The app will send this many packets immediately, without waiting for notification + /// confirming each packet. This value should be lower than or equal to MCUMGR_BUF_COUNT + /// (https://github.com/zephyrproject-rtos/zephyr/blob/bd4ddec0c8c822bbdd420bd558b62c1d1a532c16/subsys/mgmt/mcumgr/Kconfig#L550) + /// parameter in KConfig in NCS / Zephyr configuration and should also be supported on Mynewt devices. Mind, that in Zephyr, + /// before https://github.com/zephyrproject-rtos/zephyr/pull/41959 was merged, the device required data to be sent with memory alignment. + /// Otherwise, the device would ignore uneven bytes and reply with lower than expected offset + /// causing multiple packets to be sent again dropping the speed instead of increasing it. + /// (Android only) Set the selected memory alignment. Defaults to 4 to match Nordic devices. Task UploadAsync( TData localData, string remoteFilePath, @@ -55,15 +92,44 @@ Task UploadAsync( int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 1_000, int gracefulCancellationTimeoutInMs = 2_500, - bool autodisposeStream = false + bool autodisposeStream = false, + int? pipelineDepth = null, + int? byteAlignment = null, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null ); - + /// /// Begins the file-uploading process. To really know when the upgrade process has been completed you have to register to the events emitted by the uploader. /// /// The remote file-path to upload the data to. /// The file-data. - EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data); + /// (iOS only) If set to a value larger than 1, this enables SMP Pipelining, wherein multiple packets of data ('chunks') are sent at + /// once before awaiting a response, which can lead to a big increase in transfer speed if the receiving hardware supports this feature. + /// (iOS only) When PipelineLength is larger than 1 (SMP Pipelining Enabled) it's necessary to set this in order for the stack + /// to predict offset jumps as multiple packets are sent in parallel. + /// (Android only) Set the initial MTU size for the connection employed by the firmware-installation + /// (useful for some problematic devices such as Samsung A8 tablets). Acceptable custom values must lay within the range [23, 517]. + /// If null, zero or negative it will default to 498. Note that in quirky devices like Samsung Galaxy A8 the only value that works is 23 - anything else fails. + /// (Android only) Set the window capacity. Values > 1 enable a new implementation for uploading + /// the images, which makes use of SMP pipelining feature. The app will send this many packets immediately, without waiting for notification + /// confirming each packet. This value should be lower than or equal to MCUMGR_BUF_COUNT + /// (https://github.com/zephyrproject-rtos/zephyr/blob/bd4ddec0c8c822bbdd420bd558b62c1d1a532c16/subsys/mgmt/mcumgr/Kconfig#L550) + /// parameter in KConfig in NCS / Zephyr configuration and should also be supported on Mynewt devices. Mind, that in Zephyr, + /// before https://github.com/zephyrproject-rtos/zephyr/pull/41959 was merged, the device required data to be sent with memory alignment. + /// Otherwise, the device would ignore uneven bytes and reply with lower than expected offset + /// causing multiple packets to be sent again dropping the speed instead of increasing it. + /// (Android only) Set the selected memory alignment. Defaults to 4 to match Nordic devices. + EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, + int? byteAlignment = null, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null + ); /// /// Scraps the current transport. This is useful in case the transport is in a bad state and needs to be restarted. diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCommandableProxy.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCommandableProxy.cs index 56f36c20..3ed2edb9 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCommandableProxy.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCommandableProxy.cs @@ -6,8 +6,16 @@ internal interface INativeFileUploaderCommandableProxy { void Cancel(); void Disconnect(); - - EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data); + + EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, + int? byteAlignment = null, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null + ); bool TrySetContext(object context); bool TrySetBluetoothDevice(object bluetoothDevice); diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index 7e07a2d4..30fc9550 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -6,6 +6,7 @@ using System.IO; using System.Linq; using System.Threading.Tasks; +using Laerdal.McuMgr.Common.Constants; using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Events; using Laerdal.McuMgr.Common.Helpers; @@ -42,14 +43,34 @@ public void Dispose() public bool TrySetBluetoothDevice(object bluetoothDevice) => _nativeFileUploaderProxy?.TrySetContext(bluetoothDevice) ?? false; public bool TryInvalidateCachedTransport() => _nativeFileUploaderProxy?.TryInvalidateCachedTransport() ?? false; - public EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + public EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + + int? pipelineDepth = null, + int? byteAlignment = null, + + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null + ) { data = data ?? throw new ArgumentNullException(nameof(data)); RemoteFilePathHelpers.ValidateRemoteFilePath(remoteFilePath); // order remoteFilePath = RemoteFilePathHelpers.SanitizeRemoteFilePath(remoteFilePath); // order - var verdict = _nativeFileUploaderProxy.BeginUpload(remoteFilePath, data); + var verdict = _nativeFileUploaderProxy.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, + byteAlignment: byteAlignment, + + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); return verdict; } @@ -143,7 +164,14 @@ public async Task> UploadAsync( int timeoutPerUploadInMs = -1, int maxTriesPerUpload = 10, bool moveToNextUploadInCaseOfError = true, - bool autodisposeStreams = false + bool autodisposeStreams = false, + + int? pipelineDepth = null, + int? byteAlignment = null, + + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null ) where TData : notnull { RemoteFilePathHelpers.ValidateRemoteFilePathsWithDataBytes(remoteFilePathsAndTheirData); @@ -162,7 +190,14 @@ await UploadAsync( maxTriesCount: maxTriesPerUpload, autodisposeStream: autodisposeStreams, timeoutForUploadInMs: timeoutPerUploadInMs, - sleepTimeBetweenRetriesInMs: sleepTimeBetweenRetriesInMs + sleepTimeBetweenRetriesInMs: sleepTimeBetweenRetriesInMs, + + pipelineDepth: pipelineDepth, + byteAlignment: byteAlignment, + + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment ); } catch (UploadErroredOutException) @@ -180,7 +215,7 @@ await UploadAsync( return filesThatFailedToBeUploaded; //00 we prefer to upload as many files as possible and report any failures collectively at the very end we resorted to this - // tactic because failures are fairly common when uploading 50 files or more over to aed devices and we wanted to ensure + // tactic because failures are fairly common when uploading 50 files or more over to aed devices, and we wanted to ensure // that it would be as easy as possible to achieve the mass uploading just by using the default settings } @@ -192,7 +227,14 @@ public async Task UploadAsync( int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 1_000, int gracefulCancellationTimeoutInMs = 2_500, - bool autodisposeStream = false + bool autodisposeStream = false, + + int? pipelineDepth = null, + int? byteAlignment = null, + + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null ) where TData : notnull { if (data is null) @@ -208,6 +250,8 @@ public async Task UploadAsync( : DefaultGracefulCancellationTimeoutInMs; var isCancellationRequested = false; + var suspiciousTransportFailuresCount = 0; + var didWarnOnceAboutUnstableConnection = false; for (var triesCount = 1; !isCancellationRequested;) { var taskCompletionSource = new TaskCompletionSource(state: false); @@ -218,7 +262,33 @@ public async Task UploadAsync( StateChanged += FileUploader_StateChanged_; FatalErrorOccurred += FileUploader_FatalErrorOccurred_; - var verdict = BeginUpload(remoteFilePath, dataArray); //00 dont use task.run here for now + var failSafeSettingsToApply = GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( + triesCount_: triesCount, + maxTriesCount_: maxTriesCount, + suspiciousTransportFailuresCount_: suspiciousTransportFailuresCount, + emitWarningAboutUnstableConnection_: !didWarnOnceAboutUnstableConnection + ); + if (failSafeSettingsToApply != null) + { + didWarnOnceAboutUnstableConnection = true; + byteAlignment = failSafeSettingsToApply.Value.byteAlignment; + pipelineDepth = failSafeSettingsToApply.Value.pipelineDepth; + initialMtuSize = failSafeSettingsToApply.Value.initialMtuSize; + windowCapacity = failSafeSettingsToApply.Value.windowCapacity; + memoryAlignment = failSafeSettingsToApply.Value.memoryAlignment; + } + + var verdict = BeginUpload( //00 dont use task.run here for now + data: dataArray, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); if (verdict != EFileUploaderVerdict.Success) throw new ArgumentException(verdict.ToString()); @@ -368,6 +438,37 @@ void FileUploader_FatalErrorOccurred_(object sender, FatalErrorOccurredEventArgs return; + (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment)? GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( + int triesCount_, + int maxTriesCount_, + int suspiciousTransportFailuresCount_, + bool emitWarningAboutUnstableConnection_ + ) + { + var isConnectionTooUnstableForUploading_ = triesCount_ >= 2 && (triesCount_ == maxTriesCount_ || triesCount_ >= 3 && suspiciousTransportFailuresCount_ >= 2); + if (!isConnectionTooUnstableForUploading_) + return null; + + var byteAlignment_ = AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment; // ios + maccatalyst + var pipelineDepth_ = AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth; // ios + maccatalyst + var initialMtuSize_ = AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize; // android when noticing persistent failures when uploading we resort + var windowCapacity_ = AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity; // android to forcing the most failsafe settings we know of just in case + var memoryAlignment_ = AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) + + if (emitWarningAboutUnstableConnection_) + { + OnLogEmitted(new LogEmittedEventArgs( + level: ELogLevel.Warning, + message: $"[FU.UA.GFCSICPTBU.010] Attempt#{triesCount_}: Connection is too unstable for uploading assets to the target device. Subsequent tries will use failsafe parameters on the connection " + + $"just in case it helps (byteAlignment={byteAlignment_}, pipelineDepth={pipelineDepth_}, initialMtuSize={initialMtuSize_}, windowCapacity={windowCapacity_}, memoryAlignment={memoryAlignment_})", + resource: "File", + category: "FileUploader" + )); + } + + return (byteAlignment: byteAlignment_, pipelineDepth: pipelineDepth_, initialMtuSize: initialMtuSize_, windowCapacity: windowCapacity_, memoryAlignment: memoryAlignment_); + } + //00 we are aware that in order to be 100% accurate about timeouts we should use task.run() here without await and then await the // taskcompletionsource right after but if we went down this path we would also have to account for exceptions thus complicating // the code considerably for little to no practical gain considering that the native call has trivial setup code and is very fast @@ -395,14 +496,22 @@ void FileUploader_FatalErrorOccurred_(object sender, FatalErrorOccurredEventArgs }; } - void IFileUploaderEventEmittable.OnCancelled(CancelledEventArgs ea) => _cancelled?.Invoke(this, ea); - void IFileUploaderEventEmittable.OnLogEmitted(LogEmittedEventArgs ea) => _logEmitted?.Invoke(this, ea); - void IFileUploaderEventEmittable.OnStateChanged(StateChangedEventArgs ea) => _stateChanged?.Invoke(this, ea); - void IFileUploaderEventEmittable.OnFileUploaded(FileUploadedEventArgs ea) => _fileUploaded?.Invoke(this, ea); - void IFileUploaderEventEmittable.OnBusyStateChanged(BusyStateChangedEventArgs ea) => _busyStateChanged?.Invoke(this, ea); - void IFileUploaderEventEmittable.OnFatalErrorOccurred(FatalErrorOccurredEventArgs ea) => _fatalErrorOccurred?.Invoke(this, ea); - void IFileUploaderEventEmittable.OnFileUploadProgressPercentageAndDataThroughputChanged(FileUploadProgressPercentageAndDataThroughputChangedEventArgs ea) => _fileUploadProgressPercentageAndDataThroughputChanged?.Invoke(this, ea); - + void IFileUploaderEventEmittable.OnCancelled(CancelledEventArgs ea) => OnCancelled(ea); + void IFileUploaderEventEmittable.OnLogEmitted(LogEmittedEventArgs ea) => OnLogEmitted(ea); + void IFileUploaderEventEmittable.OnStateChanged(StateChangedEventArgs ea) => OnStateChanged(ea); + void IFileUploaderEventEmittable.OnFileUploaded(FileUploadedEventArgs ea) => OnFileUploaded(ea); + void IFileUploaderEventEmittable.OnBusyStateChanged(BusyStateChangedEventArgs ea) => OnBusyStateChanged(ea); + void IFileUploaderEventEmittable.OnFatalErrorOccurred(FatalErrorOccurredEventArgs ea) => OnFatalErrorOccurred(ea); + void IFileUploaderEventEmittable.OnFileUploadProgressPercentageAndDataThroughputChanged(FileUploadProgressPercentageAndDataThroughputChangedEventArgs ea) => OnFileUploadProgressPercentageAndDataThroughputChanged(ea); + + private void OnCancelled(CancelledEventArgs ea) => _cancelled?.Invoke(this, ea); + private void OnLogEmitted(LogEmittedEventArgs ea) => _logEmitted?.Invoke(this, ea); + private void OnStateChanged(StateChangedEventArgs ea) => _stateChanged?.Invoke(this, ea); + private void OnFileUploaded(FileUploadedEventArgs ea) => _fileUploaded?.Invoke(this, ea); + private void OnBusyStateChanged(BusyStateChangedEventArgs ea) => _busyStateChanged?.Invoke(this, ea); + private void OnFatalErrorOccurred(FatalErrorOccurredEventArgs ea) => _fatalErrorOccurred?.Invoke(this, ea); + private void OnFileUploadProgressPercentageAndDataThroughputChanged(FileUploadProgressPercentageAndDataThroughputChangedEventArgs ea) => _fileUploadProgressPercentageAndDataThroughputChanged?.Invoke(this, ea); + //this sort of approach proved to be necessary for our testsuite to be able to effectively mock away the INativeFileUploaderProxy internal class GenericNativeFileUploaderCallbacksProxy : INativeFileUploaderCallbacksProxy { diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index 41226df2..5a2607ba 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -176,8 +176,8 @@ public async Task InstallAsync( : DefaultGracefulCancellationTimeoutInMs; var isCancellationRequested = false; + var suspiciousTransportFailuresCount = 0; var didWarnOnceAboutUnstableConnection = false; - var almostImmediateUploadingFailuresCount = 0; for (var triesCount = 1; !isCancellationRequested;) { var taskCompletionSource = new TaskCompletionSource(state: false); @@ -190,10 +190,12 @@ public async Task InstallAsync( var failSafeSettingsToApply = GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( triesCount_: triesCount, maxTriesCount_: maxTriesCount, - almostImmediateUploadingFailuresCount_: almostImmediateUploadingFailuresCount + suspiciousTransportFailuresCount_: suspiciousTransportFailuresCount, + emitWarningAboutUnstableConnection_: !didWarnOnceAboutUnstableConnection ); if (failSafeSettingsToApply != null) { + didWarnOnceAboutUnstableConnection = true; byteAlignment = failSafeSettingsToApply.Value.byteAlignment; pipelineDepth = failSafeSettingsToApply.Value.pipelineDepth; initialMtuSize = failSafeSettingsToApply.Value.initialMtuSize; @@ -209,6 +211,7 @@ public async Task InstallAsync( pipelineDepth: pipelineDepth, // ios only byteAlignment: byteAlignment, // ios only + initialMtuSize: initialMtuSize, // android only windowCapacity: windowCapacity, // android only memoryAlignment: memoryAlignment // android only @@ -233,7 +236,7 @@ public async Task InstallAsync( { if (_fileUploadProgressEventsCount <= 10) { - almostImmediateUploadingFailuresCount++; + suspiciousTransportFailuresCount++; } if (++triesCount > maxTriesCount) //order @@ -339,14 +342,14 @@ void FirmwareInstallationAsyncOnFatalErrorOccurred(object sender, FatalErrorOccu return; - (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment)? GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( int triesCount_, int maxTriesCount_, - int almostImmediateUploadingFailuresCount_ + int suspiciousTransportFailuresCount_, + bool emitWarningAboutUnstableConnection_ ) { - var isConnectionTooUnstableForUploading_ = triesCount_ >= 2 && (triesCount_ == maxTriesCount_ || triesCount_ >= 3 && almostImmediateUploadingFailuresCount_ >= 2); + var isConnectionTooUnstableForUploading_ = triesCount_ >= 2 && (triesCount_ == maxTriesCount_ || triesCount_ >= 3 && suspiciousTransportFailuresCount_ >= 2); if (!isConnectionTooUnstableForUploading_) return null; @@ -356,12 +359,11 @@ int almostImmediateUploadingFailuresCount_ var windowCapacity_ = AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity; // android to forcing the most failsafe settings we know of just in case var memoryAlignment_ = AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) - if (!didWarnOnceAboutUnstableConnection) + if (emitWarningAboutUnstableConnection_) { - didWarnOnceAboutUnstableConnection = true; OnLogEmitted(new LogEmittedEventArgs( level: ELogLevel.Warning, - message: $"[FI.IA.GFCSICPTBU.010] Installation-Attempt#{triesCount_}: Connection is too unstable for uploading the firmware to the target device. Subsequent tries will use failsafe parameters on the connection " + + message: $"[FI.IA.GFCSICPTBU.010] Attempt#{triesCount_}: Connection is too unstable for uploading the firmware to the target device. Subsequent tries will use failsafe parameters on the connection " + $"just in case it helps (byteAlignment={byteAlignment_}, pipelineDepth={pipelineDepth_}, initialMtuSize={initialMtuSize_}, windowCapacity={windowCapacity_}, memoryAlignment={memoryAlignment_})", resource: "Firmware", category: "FirmwareInstaller" diff --git a/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs b/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs index 1b99a5fe..dfec9fe5 100644 --- a/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs @@ -99,13 +99,27 @@ public void CleanupResourcesOfLastUpload() //00 } private NSData _nsDataOfFileInCurrentlyActiveUpload; - public EFileUploaderVerdict BeginUpload(string remoteFilePath, byte[] data) + + public EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { var nsDataOfFileToUpload = NSData.FromArray(data); var verdict = TranslateFileUploaderVerdict(_nativeFileUploader.BeginUpload( data: nsDataOfFileToUpload, - remoteFilePath: remoteFilePath + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth ?? -1, + byteAlignment: byteAlignment ?? -1 )); if (verdict != EFileUploaderVerdict.Success) { From 87cc117779dfc5a44bf97b2758e9c9292c98b6f9 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 30 Sep 2024 19:49:11 +0200 Subject: [PATCH 015/104] clean (FirmwareInstaller.BeginInstallation()): simplify the method to have it delegate the fallback to default values to _nativeFirmwareInstallerProxy.BeginInstallation() --- .../Shared/FirmwareInstaller/FirmwareInstaller.cs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index 5a2607ba..7bccfe7d 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -57,13 +57,13 @@ public EFirmwareInstallationVerdict BeginInstallation( var verdict = _nativeFirmwareInstallerProxy.BeginInstallation( data: data, mode: mode, - eraseSettings: eraseSettings ?? false, + eraseSettings: eraseSettings, pipelineDepth: pipelineDepth, byteAlignment: byteAlignment, - initialMtuSize: initialMtuSize ?? -1, - windowCapacity: windowCapacity ?? -1, - memoryAlignment: memoryAlignment ?? -1, - estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds ?? -1 + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment, + estimatedSwapTimeInMilliseconds: estimatedSwapTimeInMilliseconds ); return verdict; From 15990ebad80829430996e6d159edbb1b6c0e110e Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 30 Sep 2024 19:49:47 +0200 Subject: [PATCH 016/104] doc (IFileUploader.cs): add trivial comments explaining why IFileUploaderEventEmittable is not part of the public interface IFileUploader --- .../Shared/FileUploader/Contracts/IFileUploader.cs | 5 +++-- .../FileUploader/Contracts/IFileUploaderEventEmittable.cs | 1 + 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploader.cs index f416653e..f28264d8 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploader.cs @@ -8,11 +8,12 @@ namespace Laerdal.McuMgr.FileUploader.Contracts /// Uploads a file on a specific Nordic-chip-based BLE device /// For the file-uploading process to even commence you need to be authenticated with the AED device that's being targeted. public interface IFileUploader : - IFileUploaderCommandable, IFileUploaderQueryable, - IFileUploaderEventSubscribable, + IFileUploaderCommandable, IFileUploaderCleanupable, + IFileUploaderEventSubscribable, IDisposable + //IFileUploaderEventEmittable dont this interface is meant to be internal only { } } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderEventEmittable.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderEventEmittable.cs index abc52559..db0135e1 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderEventEmittable.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderEventEmittable.cs @@ -3,6 +3,7 @@ namespace Laerdal.McuMgr.FileUploader.Contracts { + //must be internal because there is absolutely no point for anyone outside this assembly to be able to raise these events internal interface IFileUploaderEventEmittable { void OnCancelled(CancelledEventArgs ea); From 7a5f17e4e00f3e63e6813590609037c0313422aa Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 1 Oct 2024 17:01:29 +0200 Subject: [PATCH 017/104] feat (FileDownloader.cs): add support for falling back to failsafe settings --- .../AndroidFileDownloader.java | 56 ++++-- .../AndroidFileUploader.java | 24 ++- ...entException_GivenInvalidRemoteFilePath.cs | 9 +- ...leteSuccessfully_GivenNoFilesToDownload.cs | 9 +- ...uccessfully_GivenVariousFilesToDownload.cs | 9 +- ...hCollectionWithErroneousFilesToDownload.cs | 9 +- ...ntException_GivenNullForFilesToDownload.cs | 9 +- ...ToFailsafeSettings_GivenFlakyConnection.cs | 182 ++++++++++++++++++ ...essfully_GivenGreenNativeFileDownloader.cs | 11 +- ...ailedException_GivenFatalErrorMidflight.cs | 9 +- ...dException_GivenRogueNativeErrorMessage.cs | 9 +- ...umentException_GivenEmptyRemoteFilePath.cs | 9 +- ...ption_GivenCancellationRequestMidflight.cs | 11 +- ...tion_GivenErroneousNativeFileDownloader.cs | 9 +- ...adTimeoutException_GivenTooSmallTimeout.cs | 9 +- ...FoundException_GivenNonExistentFilepath.cs | 9 +- .../FileDownloader/FileDownloaderTestbed.cs | 7 +- ...ToFailsafeSettings_GivenFlakyConnection.cs | 10 + ...tu_GivenFlakyConnectionForFileUploading.cs | 9 +- .../Droid/FileDownloader/FileDownloader.cs | 18 +- .../Contracts/IFileDownloaderCommandable.cs | 55 +++++- .../INativeFileDownloaderCommandableProxy.cs | 2 +- .../Native/INativeFileDownloaderProxy.cs | 2 +- .../Shared/FileDownloader/FileDownloader.cs | 155 ++++++++++++--- .../Shared/FileUploader/FileUploader.cs | 41 +++- .../FirmwareInstaller/FirmwareInstaller.cs | 30 +-- .../iOS/FileDownloader/FileDownloader.cs | 13 +- 27 files changed, 602 insertions(+), 123 deletions(-) create mode 100644 Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index 9e34ddd8..b633f74f 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -18,7 +18,7 @@ public class AndroidFileDownloader private FsManager _fileSystemManager; @SuppressWarnings("FieldCanBeLocal") private final McuMgrBleTransport _transport; - private TransferController _controller; + private TransferController _downloadingController; private int _initialBytes; private long _downloadStartTimestamp; @@ -30,7 +30,24 @@ public AndroidFileDownloader(@NonNull final Context context, @NonNull final Blue _transport = new McuMgrBleTransport(context, bluetoothDevice); } - public EAndroidFileDownloaderVerdict beginDownload(final String remoteFilePath) + /** + * Initiates a file download asynchronously. The progress is advertised through the callbacks provided by this class. + * Setup interceptors for them to get informed about the status of the firmware-installation. + * + * @param remoteFilePath the remote-file-path to the file on the remote device that you wish to download + * @param initialMtuSize sets the initial MTU for the connection that the McuMgr BLE-transport sets up for the firmware installation that will follow. + * Note that if less than 0 it gets ignored and if it doesn't fall within the range [23, 517] it will cause a hard error. + * @param windowCapacity specifies the windows-capacity for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default + * @param memoryAlignment specifies the memory-alignment to use for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default + * + * @return a verdict indicating whether the file uploading was started successfully or not + */ + public EAndroidFileDownloaderVerdict beginDownload( + final String remoteFilePath, + final int initialMtuSize, + final int windowCapacity, //todo should we keep this or remove it? it doesnt seem to be applicable to the file-downloader + final int memoryAlignment //todo should we keep this or remove it? it doesnt seem to be applicable to the file-downloader + ) { if (_currentState != EAndroidFileDownloaderState.NONE //if the download is already in progress we bail out && _currentState != EAndroidFileDownloaderState.ERROR @@ -68,7 +85,24 @@ public EAndroidFileDownloaderVerdict beginDownload(final String remoteFilePath) try { + if (initialMtuSize > 0) + { + _transport.setInitialMtu(initialMtuSize); + } + _fileSystemManager = new FsManager(_transport); + + setLoggingEnabled(false); + requestHighConnectionPriority(); + + setState(EAndroidFileDownloaderState.IDLE); + busyStateChangedAdvertisement(true); + fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); + + _initialBytes = 0; + + _remoteFilePathSanitized = remoteFilePathSanitized; + _downloadingController = _fileSystemManager.fileDownload(remoteFilePathSanitized, new FileDownloaderCallbackProxy()); } catch (final Exception ex) { @@ -78,24 +112,12 @@ public EAndroidFileDownloaderVerdict beginDownload(final String remoteFilePath) return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } - setLoggingEnabled(false); - requestHighConnectionPriority(); - - setState(EAndroidFileDownloaderState.IDLE); - busyStateChangedAdvertisement(true); - fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); - - _initialBytes = 0; - - _remoteFilePathSanitized = remoteFilePathSanitized; - _controller = _fileSystemManager.fileDownload(remoteFilePathSanitized, new FileDownloaderCallbackProxy()); - return EAndroidFileDownloaderVerdict.SUCCESS; } public void pause() { - final TransferController transferController = _controller; + final TransferController transferController = _downloadingController; if (transferController == null) return; @@ -107,7 +129,7 @@ public void pause() public void resume() { - final TransferController transferController = _controller; + final TransferController transferController = _downloadingController; if (transferController == null) return; @@ -135,7 +157,7 @@ public void cancel() { setState(EAndroidFileDownloaderState.CANCELLING); //order - final TransferController transferController = _controller; + final TransferController transferController = _downloadingController; if (transferController == null) return; diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index c0748604..490d3fe5 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -162,13 +162,23 @@ public EAndroidFileUploaderVerdict beginUpload( resetUploadState(); //order setLoggingEnabled(false); - _uploadController = new FileUploader( //00 - _fileSystemManager, - _remoteFilePathSanitized, - data, - Math.max(1, windowCapacity), - Math.max(1, memoryAlignment) - ).uploadAsync(_fileUploaderCallbackProxy); + try + { + _uploadController = new FileUploader( //00 + _fileSystemManager, + _remoteFilePathSanitized, + data, + Math.max(1, windowCapacity), + Math.max(1, memoryAlignment) + ).uploadAsync(_fileUploaderCallbackProxy); + } + catch (final Exception ex) + { + setState(EAndroidFileUploaderState.ERROR); + onError(_remoteFilePathSanitized, "Failed to initialize the upload", ex); + + return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; + } return EAndroidFileUploaderVerdict.SUCCESS; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.BeginDownload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.BeginDownload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs index d7360630..652f5ba7 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.BeginDownload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.BeginDownload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs @@ -49,9 +49,14 @@ public MockedGreenNativeFileDownloaderProxySpy1(INativeFileDownloaderCallbacksPr _mockedFileData = mockedFileData; } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) { - var verdict = base.BeginDownload(remoteFilePath); + var verdict = base.BeginDownload( + remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs index 633e7a93..05893278 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs @@ -41,9 +41,14 @@ public MockedGreenNativeFileDownloaderProxySpy5(INativeFileDownloaderCallbacksPr { } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) { - var verdict = base.BeginDownload(remoteFilePath); + var verdict = base.BeginDownload( + remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index 965fbe40..f5a02e01 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -82,9 +82,14 @@ public MockedGreenNativeFileDownloaderProxySpy6(INativeFileDownloaderCallbacksPr } private int _retryCountForProblematicFile; - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) { - var verdict = base.BeginDownload(remoteFilePath); + var verdict = base.BeginDownload( + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs index 218779cb..7f8001a5 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs @@ -49,9 +49,14 @@ public MockedGreenNativeFileDownloaderProxySpy11(INativeFileDownloaderCallbacksP { } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) { - var verdict = base.BeginDownload(remoteFilePath); + var verdict = base.BeginDownload( + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs index 7192ddc8..1b64a6fe 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs @@ -40,9 +40,14 @@ public MockedGreenNativeFileDownloaderProxySpy10(INativeFileDownloaderCallbacksP { } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) { - var verdict = base.BeginDownload(remoteFilePath); + var verdict = base.BeginDownload( + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs new file mode 100644 index 00000000..d6aee556 --- /dev/null +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -0,0 +1,182 @@ +using FluentAssertions; +using FluentAssertions.Extensions; +using Laerdal.McuMgr.Common.Constants; +using Laerdal.McuMgr.Common.Enums; +using Laerdal.McuMgr.Common.Events; +using Laerdal.McuMgr.FileDownloader.Contracts.Enums; +using Laerdal.McuMgr.FileDownloader.Contracts.Events; +using Laerdal.McuMgr.FileDownloader.Contracts.Native; +using GenericNativeFileDownloaderCallbacksProxy_ = Laerdal.McuMgr.FileDownloader.FileDownloader.GenericNativeFileDownloaderCallbacksProxy; + +#pragma warning disable xUnit1026 + +namespace Laerdal.McuMgr.Tests.FileDownloader +{ + public partial class FileDownloaderTestbed + { + [Theory] + [InlineData("FDT.SFDA.SCSBFBTFS.GFBC.010", "/path/to/file.bin", 2)] + [InlineData("FDT.SFDA.SCSBFBTFS.GFBC.020", "/path/to/file.bin", 3)] + [InlineData("FDT.SFDA.SCSBFBTFS.GFBC.030", "/path/to/file.bin", 5)] + public async Task SingleFileDownloadAsync_ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyBluetoothConnection(string testcaseNickname, string remoteFilePath, int maxTriesCount) + { + // Arrange + var expectedData = (byte[]) [1, 2, 3]; + + var mockedNativeFileDownloaderProxy = new MockedGreenNativeFileDownloaderProxySpy120( + expectedData: expectedData, + maxTriesCount: maxTriesCount, + uploaderCallbacksProxy: new GenericNativeFileDownloaderCallbacksProxy_() + ); + var fileDownloader = new McuMgr.FileDownloader.FileDownloader(mockedNativeFileDownloaderProxy); + + using var eventsMonitor = fileDownloader.Monitor(); + + // Act + var work = new Func(() => fileDownloader.DownloadAsync( + maxTriesCount: maxTriesCount, + remoteFilePath: remoteFilePath + )); + + // Assert + await work.Should().CompleteWithinAsync((maxTriesCount * 2).Seconds()); + + mockedNativeFileDownloaderProxy.BugDetected.Should().BeNull(); + mockedNativeFileDownloaderProxy.CancelCalled.Should().BeFalse(); + mockedNativeFileDownloaderProxy.DisconnectCalled.Should().BeFalse(); //00 + mockedNativeFileDownloaderProxy.BeginDownloadCalled.Should().BeTrue(); + + eventsMonitor + .OccurredEvents.Where(x => x.EventName == nameof(fileDownloader.FatalErrorOccurred)) + .Should().HaveCount(maxTriesCount - 1); //one error for each try except the last one + + eventsMonitor + .Should().Raise(nameof(fileDownloader.StateChanged)) + .WithSender(fileDownloader) + .WithArgs(args => args.Resource == remoteFilePath && args.NewState == EFileDownloaderState.Downloading); + + eventsMonitor + .OccurredEvents + .Where(x => x.EventName == nameof(fileDownloader.LogEmitted)) + .SelectMany(x => x.Parameters) + .OfType() + .Count(l => l is { Level: ELogLevel.Warning } && l.Message.Contains("GFCSICPTBU.010")) + .Should() + .Be(1); + + eventsMonitor + .Should().Raise(nameof(fileDownloader.StateChanged)) + .WithSender(fileDownloader) + .WithArgs(args => args.Resource == remoteFilePath && args.NewState == EFileDownloaderState.Complete); + + eventsMonitor + .Should().Raise(nameof(fileDownloader.DownloadCompleted)) + .WithSender(fileDownloader) + .WithArgs(args => args.Resource == remoteFilePath); + + //00 we dont want to disconnect the device regardless of the outcome + } + + private class MockedGreenNativeFileDownloaderProxySpy120 : FileDownloader.FileDownloaderTestbed.MockedNativeFileDownloaderProxySpy + { + private readonly int _maxTriesCount; + private readonly byte[] _expectedData; + + public string BugDetected { get; private set; } + + public MockedGreenNativeFileDownloaderProxySpy120(byte[] expectedData, INativeFileDownloaderCallbacksProxy uploaderCallbacksProxy, int maxTriesCount) : base(uploaderCallbacksProxy) + { + _expectedData = expectedData; + _maxTriesCount = maxTriesCount; + } + + private int _tryCounter; + public override EFileDownloaderVerdict BeginDownload( + string remoteFilePath, + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) + { + _tryCounter++; + + var verdict = base.BeginDownload( + remoteFilePath: remoteFilePath, + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); + + Task.Run(async () => //00 vital + { + await Task.Delay(10); + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Idle, EFileDownloaderState.Downloading); + + await Task.Delay(5); + FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(00, 00); + await Task.Delay(5); + FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(10, 10); + await Task.Delay(5); + FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(20, 10); + await Task.Delay(5); + FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(30, 10); + await Task.Delay(5); + FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(40, 10); + await Task.Delay(5); + FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(50, 10); + await Task.Delay(5); + FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(60, 10); + + if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize) + { + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected); // order + return; + } + + if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity) + { + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected); // order + return; + } + + if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment) + { + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected); // order + return; + } + + if (_tryCounter < _maxTriesCount) + { + await Task.Delay(20); + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred"); // order + return; + } + + await Task.Delay(5); + FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(70, 10); + await Task.Delay(5); + FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(80, 10); + await Task.Delay(5); + FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(90, 10); + await Task.Delay(5); + FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(100, 10); + + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Complete); // order + DownloadCompletedAdvertisement(remoteFilePath, _expectedData); // order + }); + + return verdict; + + //00 simulating the state changes in a background thread is vital in order to simulate the async nature of the native uploader + } + } + } +} \ No newline at end of file diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index f3f4ff2e..5e6b92fc 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -84,11 +84,16 @@ public MockedGreenNativeFileDownloaderProxySpy(INativeFileDownloaderCallbacksPro } private int _tryCount; - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) { _tryCount++; - - var verdict = base.BeginDownload(remoteFilePath); + + var verdict = base.BeginDownload( + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs index 02a66276..7a58c7df 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs @@ -71,9 +71,14 @@ public MockedGreenNativeFileDownloaderProxySpy4(INativeFileDownloaderCallbacksPr _ = mockedFileData; } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) { - var verdict = base.BeginDownload(remoteFilePath); + var verdict = base.BeginDownload( + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs index ecf07e72..ef64aaf1 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs @@ -82,9 +82,14 @@ public MockedErroneousNativeFileDownloaderProxySpy13(INativeFileDownloaderCallba _nativeErrorMessageForFileNotFound = nativeErrorMessageForFileNotFound; } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) { - var verdict = base.BeginDownload(remoteFilePath); + var verdict = base.BeginDownload( + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs index 6c5ddf2f..b81c1477 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs @@ -45,9 +45,14 @@ public MockedGreenNativeFileDownloaderProxySpy2(INativeFileDownloaderCallbacksPr _mockedFileData = mockedFileData; } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) { - var verdict = base.BeginDownload(remoteFilePath); + var verdict = base.BeginDownload( + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadCancelledException_GivenCancellationRequestMidflight.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadCancelledException_GivenCancellationRequestMidflight.cs index 8da54ee3..89bf5511 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadCancelledException_GivenCancellationRequestMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadCancelledException_GivenCancellationRequestMidflight.cs @@ -91,7 +91,7 @@ public override void Cancel() // a best effort basis and this is exactly what we are testing here } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) { _currentRemoteFilePath = remoteFilePath; _cancellationTokenSource = new CancellationTokenSource(); @@ -100,8 +100,13 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) { _cancellationTokenSource.Cancel(); }; - - var verdict = base.BeginDownload(remoteFilePath); + + var verdict = base.BeginDownload( + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadInternalErrorException_GivenErroneousNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadInternalErrorException_GivenErroneousNativeFileDownloader.cs index 87a192a6..375ca024 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadInternalErrorException_GivenErroneousNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadInternalErrorException_GivenErroneousNativeFileDownloader.cs @@ -34,9 +34,14 @@ public MockedErroneousNativeFileDownloaderProxySpy(INativeFileDownloaderCallback { } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) { - base.BeginDownload(remoteFilePath); + base.BeginDownload( + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); Thread.Sleep(100); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs index 3f3ef198..23c15bbc 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs @@ -51,9 +51,14 @@ public MockedGreenButSlowNativeFileDownloaderProxySpy(INativeFileDownloaderCallb { } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) { - var verdict = base.BeginDownload(remoteFilePath); + var verdict = base.BeginDownload( + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs index cba86ed4..36e815b6 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs @@ -85,9 +85,14 @@ public MockedErroneousNativeFileDownloaderProxySpy2(INativeFileDownloaderCallbac _nativeErrorMessageForFileNotFound = nativeErrorMessageForFileNotFound; } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) { - var verdict = base.BeginDownload(remoteFilePath); + var verdict = base.BeginDownload( + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); Task.Run(async () => //00 vital { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs index a4f9c319..43f7f67c 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs @@ -28,7 +28,12 @@ protected MockedNativeFileDownloaderProxySpy(INativeFileDownloaderCallbacksProxy _downloaderCallbacksProxy = downloaderCallbacksProxy; } - public virtual EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public virtual EFileDownloaderVerdict BeginDownload( + string remoteFilePath, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null + ) { BeginDownloadCalled = true; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index 52399597..6fec6fe4 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -2,6 +2,7 @@ using FluentAssertions.Extensions; using Laerdal.McuMgr.Common.Constants; using Laerdal.McuMgr.Common.Enums; +using Laerdal.McuMgr.Common.Events; using Laerdal.McuMgr.FileUploader.Contracts.Enums; using Laerdal.McuMgr.FileUploader.Contracts.Events; using Laerdal.McuMgr.FileUploader.Contracts.Native; @@ -54,6 +55,15 @@ public async Task SingleFileUploadAsync_ShouldCompleteSuccessfullyByFallingBackT .WithSender(fileUploader) .WithArgs(args => args.Resource == remoteFilePath && args.NewState == EFileUploaderState.Uploading); + eventsMonitor + .OccurredEvents + .Where(x => x.EventName == nameof(fileUploader.LogEmitted)) + .SelectMany(x => x.Parameters) + .OfType() + .Count(l => l is { Level: ELogLevel.Warning } && l.Message.Contains("GFCSICPTBU.010")) + .Should() + .Be(1); + eventsMonitor .Should().Raise(nameof(fileUploader.StateChanged)) .WithSender(fileUploader) diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs index 91fe5093..7dcca6c9 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs @@ -60,11 +60,10 @@ public async Task InstallAsync_ShouldCompleteSuccessfullyWithLastDitchAttemptUsi eventsMonitor .OccurredEvents - .Count(x => - { - var logEventArgs = x.Parameters.OfType().FirstOrDefault(); // we need to make sure the calling environment - return logEventArgs is { Level: ELogLevel.Warning } && logEventArgs.Message.Contains("[FI.IA.GFCSICPTBU.010]"); // is warned about falling back to failsafe settings - }) + .Where(x => x.EventName == nameof(firmwareInstaller.LogEmitted)) + .SelectMany(x => x.Parameters) + .OfType() + .Count(l => l is { Level: ELogLevel.Warning } && l.Message.Contains("GFCSICPTBU.010")) .Should() .Be(1); diff --git a/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs index a69ffc2d..a829f993 100644 --- a/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs @@ -90,11 +90,21 @@ private void CleanupInfrastructure() } } - #region commands - - public new EFileDownloaderVerdict BeginDownload(string remoteFilePath) + #region commands + + public EFileDownloaderVerdict BeginDownload( + string remoteFilePath, + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) { - return TranslateFileDownloaderVerdict(base.BeginDownload(remoteFilePath)); + return TranslateFileDownloaderVerdict(base.BeginDownload( + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize ?? -1, + windowCapacity: windowCapacity ?? -1, //todo remove these if they turn out to be non-applicable to file-downloading + memoryAlignment: memoryAlignment ?? -1 + )); } #endregion commands diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs index 9d4e1162..ae9d71d2 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs @@ -14,12 +14,27 @@ public interface IFileDownloaderCommandable /// The amount of time to wait for each download to complete before skipping it. /// The maximum amount of tries per download before skipping and moving over to the next download. /// The amount of time to sleep between retries. + /// (Android only) Set the initial MTU size for the connection employed by the firmware-installation + /// (useful for some problematic devices such as Samsung A8 tablets). Acceptable custom values must lay within the range [23, 517]. + /// If null, zero or negative it will default to 498. Note that in quirky devices like Samsung Galaxy A8 the only value that works is 23 - anything else fails. + /// (Android only) Set the window capacity. Values > 1 enable a new implementation for uploading + /// the images, which makes use of SMP pipelining feature. The app will send this many packets immediately, without waiting for notification + /// confirming each packet. This value should be lower than or equal to MCUMGR_BUF_COUNT + /// (https://github.com/zephyrproject-rtos/zephyr/blob/bd4ddec0c8c822bbdd420bd558b62c1d1a532c16/subsys/mgmt/mcumgr/Kconfig#L550) + /// parameter in KConfig in NCS / Zephyr configuration and should also be supported on Mynewt devices. Mind, that in Zephyr, + /// before https://github.com/zephyrproject-rtos/zephyr/pull/41959 was merged, the device required data to be sent with memory alignment. + /// Otherwise, the device would ignore uneven bytes and reply with lower than expected offset + /// causing multiple packets to be sent again dropping the speed instead of increasing it. + /// (Android only) Set the selected memory alignment. Defaults to 4 to match Nordic devices. /// A dictionary containing the bytes of each remote file that got fetched over. Task> DownloadAsync( IEnumerable remoteFilePaths, int timeoutPerDownloadInMs = -1, int maxRetriesPerDownload = 10, - int sleepTimeBetweenRetriesInMs = 0 + int sleepTimeBetweenRetriesInMs = 0, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null ); /// @@ -30,20 +45,52 @@ Task> DownloadAsync( /// The maximum amount of tries before bailing out with . /// The amount of time to sleep between retries. /// The time to wait (in milliseconds) for a cancellation request to be properly handled. If this timeout expires then the mechanism will bail out forcefully without waiting for the underlying native code to cleanup properly. + /// (Android only) Set the initial MTU size for the connection employed by the firmware-installation + /// (useful for some problematic devices such as Samsung A8 tablets). Acceptable custom values must lay within the range [23, 517]. + /// If null, zero or negative it will default to 498. Note that in quirky devices like Samsung Galaxy A8 the only value that works is 23 - anything else fails. + /// (Android only) Set the window capacity. Values > 1 enable a new implementation for uploading + /// the images, which makes use of SMP pipelining feature. The app will send this many packets immediately, without waiting for notification + /// confirming each packet. This value should be lower than or equal to MCUMGR_BUF_COUNT + /// (https://github.com/zephyrproject-rtos/zephyr/blob/bd4ddec0c8c822bbdd420bd558b62c1d1a532c16/subsys/mgmt/mcumgr/Kconfig#L550) + /// parameter in KConfig in NCS / Zephyr configuration and should also be supported on Mynewt devices. Mind, that in Zephyr, + /// before https://github.com/zephyrproject-rtos/zephyr/pull/41959 was merged, the device required data to be sent with memory alignment. + /// Otherwise, the device would ignore uneven bytes and reply with lower than expected offset + /// causing multiple packets to be sent again dropping the speed instead of increasing it. + /// (Android only) Set the selected memory alignment. Defaults to 4 to match Nordic devices. /// The bytes of the remote file that got fetched over. Task DownloadAsync( string remoteFilePath, int timeoutForDownloadInMs = -1, int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 1_000, - int gracefulCancellationTimeoutInMs = 2_500 + int gracefulCancellationTimeoutInMs = 2_500, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null ); - + /// /// Begins the file-downloading process. To really know when the upgrade process has been completed you have to register to the events emitted by the downloader. /// /// The remote file to download. - EFileDownloaderVerdict BeginDownload(string remoteFilePath); + /// (Android only) Set the initial MTU size for the connection employed by the firmware-installation + /// (useful for some problematic devices such as Samsung A8 tablets). Acceptable custom values must lay within the range [23, 517]. + /// If null, zero or negative it will default to 498. Note that in quirky devices like Samsung Galaxy A8 the only value that works is 23 - anything else fails. + /// (Android only) Set the window capacity. Values > 1 enable a new implementation for uploading + /// the images, which makes use of SMP pipelining feature. The app will send this many packets immediately, without waiting for notification + /// confirming each packet. This value should be lower than or equal to MCUMGR_BUF_COUNT + /// (https://github.com/zephyrproject-rtos/zephyr/blob/bd4ddec0c8c822bbdd420bd558b62c1d1a532c16/subsys/mgmt/mcumgr/Kconfig#L550) + /// parameter in KConfig in NCS / Zephyr configuration and should also be supported on Mynewt devices. Mind, that in Zephyr, + /// before https://github.com/zephyrproject-rtos/zephyr/pull/41959 was merged, the device required data to be sent with memory alignment. + /// Otherwise, the device would ignore uneven bytes and reply with lower than expected offset + /// causing multiple packets to be sent again dropping the speed instead of increasing it. + /// (Android only) Set the selected memory alignment. Defaults to 4 to match Nordic devices. + EFileDownloaderVerdict BeginDownload( + string remoteFilePath, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null + ); /// Cancels the file-downloading process void Cancel(); diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCommandableProxy.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCommandableProxy.cs index c2f89e0c..96e884ec 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCommandableProxy.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCommandableProxy.cs @@ -6,6 +6,6 @@ internal interface INativeFileDownloaderCommandableProxy { void Cancel(); void Disconnect(); - EFileDownloaderVerdict BeginDownload(string remoteFilePath); + EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null); } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderProxy.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderProxy.cs index 6d18d82c..57a83dfc 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderProxy.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderProxy.cs @@ -3,9 +3,9 @@ namespace Laerdal.McuMgr.FileDownloader.Contracts.Native { internal interface INativeFileDownloaderProxy : + INativeFileDownloaderCallbacksProxy, INativeFileDownloaderQueryableProxy, INativeFileDownloaderCommandableProxy, - INativeFileDownloaderCallbacksProxy, IDisposable { } diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index 1961a75d..32ff87ca 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -5,6 +5,7 @@ using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; +using Laerdal.McuMgr.Common.Constants; using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Events; using Laerdal.McuMgr.Common.Exceptions; @@ -38,12 +39,22 @@ public void Dispose() public string LastFatalErrorMessage => _nativeFileDownloaderProxy?.LastFatalErrorMessage; - public EFileDownloaderVerdict BeginDownload(string remoteFilePath) + public EFileDownloaderVerdict BeginDownload( + string remoteFilePath, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null + ) { RemoteFilePathHelpers.ValidateRemoteFilePath(remoteFilePath); // order remoteFilePath = RemoteFilePathHelpers.SanitizeRemoteFilePath(remoteFilePath); // order - var verdict = _nativeFileDownloaderProxy.BeginDownload(remoteFilePath: remoteFilePath); + var verdict = _nativeFileDownloaderProxy.BeginDownload( + remoteFilePath: remoteFilePath, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); return verdict; } @@ -133,7 +144,10 @@ public async Task> DownloadAsync( IEnumerable remoteFilePaths, int timeoutPerDownloadInMs = -1, int maxRetriesPerDownload = 10, - int sleepTimeBetweenRetriesInMs = 0 + int sleepTimeBetweenRetriesInMs = 0, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null ) { RemoteFilePathHelpers.ValidateRemoteFilePaths(remoteFilePaths); // order @@ -150,9 +164,15 @@ public async Task> DownloadAsync( { var data = await DownloadAsync( remoteFilePath: path, - timeoutForDownloadInMs: timeoutPerDownloadInMs, + maxTriesCount: maxRetriesPerDownload, - sleepTimeBetweenRetriesInMs: sleepTimeBetweenRetriesInMs); + timeoutForDownloadInMs: timeoutPerDownloadInMs, + sleepTimeBetweenRetriesInMs: sleepTimeBetweenRetriesInMs, + + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); results[path] = data; } @@ -175,7 +195,10 @@ public async Task DownloadAsync( int timeoutForDownloadInMs = -1, int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 1_000, - int gracefulCancellationTimeoutInMs = DefaultGracefulCancellationTimeoutInMs + int gracefulCancellationTimeoutInMs = DefaultGracefulCancellationTimeoutInMs, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null ) { if (maxTriesCount <= 0) @@ -187,6 +210,9 @@ public async Task DownloadAsync( var result = (byte[])null; var isCancellationRequested = false; + var fileDownloadProgressEventsCount = 0; + var suspiciousTransportFailuresCount = 0; + var didWarnOnceAboutUnstableConnection = false; for (var triesCount = 1; !isCancellationRequested;) { var taskCompletionSource = new TaskCompletionSource(state: null); @@ -197,8 +223,29 @@ public async Task DownloadAsync( StateChanged += FileDownloader_StateChanged_; DownloadCompleted += FileDownloader_DownloadCompleted_; FatalErrorOccurred += FileDownloader_FatalErrorOccurred_; + FileDownloadProgressPercentageAndDataThroughputChanged += FileDownloader_FileDownloadProgressPercentageAndDataThroughputChanged_; + + var failSafeSettingsToApply = GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( + triesCount_: triesCount, + maxTriesCount_: maxTriesCount, + suspiciousTransportFailuresCount_: suspiciousTransportFailuresCount, + emitWarningAboutUnstableConnection_: !didWarnOnceAboutUnstableConnection + ); + if (failSafeSettingsToApply != null) + { + didWarnOnceAboutUnstableConnection = true; + initialMtuSize = failSafeSettingsToApply.Value.initialMtuSize; + windowCapacity = failSafeSettingsToApply.Value.windowCapacity; + memoryAlignment = failSafeSettingsToApply.Value.memoryAlignment; + } + + var verdict = BeginDownload( //00 dont use task.run here for now + remoteFilePath: remoteFilePath, - var verdict = BeginDownload(remoteFilePath); //00 dont use task.run here for now + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); if (verdict != EFileDownloaderVerdict.Success) throw new ArgumentException(verdict.ToString()); @@ -222,6 +269,11 @@ public async Task DownloadAsync( } catch (DownloadErroredOutException ex) { + if (fileDownloadProgressEventsCount <= 10) + { + suspiciousTransportFailuresCount++; + } + if (ex is DownloadErroredOutRemoteFileNotFoundException) //order no point to retry if the remote file is not there { //OnStateChanged(new StateChangedEventArgs(newState: EFileDownloaderState.Error)); //noneed already done in native code @@ -263,6 +315,7 @@ ex is not ArgumentException //10 wops probably missing native lib symbols! StateChanged -= FileDownloader_StateChanged_; DownloadCompleted -= FileDownloader_DownloadCompleted_; FatalErrorOccurred -= FileDownloader_FatalErrorOccurred_; + FileDownloadProgressPercentageAndDataThroughputChanged -= FileDownloader_FileDownloadProgressPercentageAndDataThroughputChanged_; } void FileDownloader_Cancelled_(object sender_, CancelledEventArgs ea_) @@ -272,34 +325,46 @@ void FileDownloader_Cancelled_(object sender_, CancelledEventArgs ea_) void FileDownloader_StateChanged_(object sender_, StateChangedEventArgs ea_) { - if (ea_.NewState != EFileDownloaderState.Cancelling || isCancellationRequested) - return; - - isCancellationRequested = true; - - Task.Run(async () => + switch (ea_.NewState) { - try - { - if (gracefulCancellationTimeoutInMs > 0) //keep this check here to avoid unnecessary task rescheduling + case EFileDownloaderState.Idle: + fileDownloadProgressEventsCount = 0; + return; + + case EFileDownloaderState.Cancelling: + if (isCancellationRequested) + return; + + isCancellationRequested = true; + Task.Run(async () => { - await Task.Delay(gracefulCancellationTimeoutInMs); - } - - OnCancelled(new CancelledEventArgs()); //00 - } - catch // (Exception ex) - { - // ignored - } - }); - - return; + try + { + if (gracefulCancellationTimeoutInMs > 0) //keep this check here to avoid unnecessary context switching + { + await Task.Delay(gracefulCancellationTimeoutInMs); + } + + OnCancelled(new CancelledEventArgs()); //00 + } + catch // (Exception ex) + { + // ignored + } + }); + + return; + } //00 we first wait to allow the cancellation to be handled by the underlying native code meaning that we should see OnCancelled() // getting called right above but if that takes too long we give the killing blow by calling OnCancelled() manually here } + void FileDownloader_FileDownloadProgressPercentageAndDataThroughputChanged_(object sender, FileDownloadProgressPercentageAndDataThroughputChangedEventArgs ea) + { + fileDownloadProgressEventsCount++; + } + void FileDownloader_DownloadCompleted_(object sender_, DownloadCompletedEventArgs ea_) { taskCompletionSource.TrySetResult(ea_.Data); @@ -307,7 +372,7 @@ void FileDownloader_DownloadCompleted_(object sender_, DownloadCompletedEventArg void FileDownloader_FatalErrorOccurred_(object sender_, FatalErrorOccurredEventArgs ea_) { - var isAboutUnauthorized = ea_.ErrorMessage?.ToUpperInvariant().Contains("UNRECOGNIZED (11)") ?? false; + var isAboutUnauthorized = ea_.ErrorMessage?.ToUpperInvariant().Contains("UNRECOGNIZED (11)", StringComparison.InvariantCultureIgnoreCase) ?? false; if (isAboutUnauthorized) { taskCompletionSource.TrySetException(new UnauthorizedException( @@ -336,6 +401,35 @@ void FileDownloader_FatalErrorOccurred_(object sender_, FatalErrorOccurredEventA return result; + (int? initialMtuSize, int? windowCapacity, int? memoryAlignment)? GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( + int triesCount_, + int maxTriesCount_, + int suspiciousTransportFailuresCount_, + bool emitWarningAboutUnstableConnection_ + ) + { + var isConnectionTooUnstableForDownloading_ = triesCount_ >= 2 && (triesCount_ == maxTriesCount_ || triesCount_ >= 3 && suspiciousTransportFailuresCount_ >= 2); + if (!isConnectionTooUnstableForDownloading_) + return null; + + var initialMtuSize_ = AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize; // android when noticing persistent failures when uploading we resort + var windowCapacity_ = AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity; // android to forcing the most failsafe settings we know of just in case + var memoryAlignment_ = AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) + + if (emitWarningAboutUnstableConnection_) + { + OnLogEmitted(new LogEmittedEventArgs( + level: ELogLevel.Warning, + message: $"[FD.DA.GFCSICPTBU.010] Attempt#{triesCount_}: Connection is too unstable for uploading assets to the target device. Subsequent tries will use failsafe parameters on the connection " + + $"just in case it helps (initialMtuSize={initialMtuSize_}, windowCapacity={windowCapacity_}, memoryAlignment={memoryAlignment_})", + resource: "File", + category: "FileDownloader" + )); + } + + return (initialMtuSize: initialMtuSize_, windowCapacity: windowCapacity_, memoryAlignment: memoryAlignment_); + } + //00 we are aware that in order to be 100% accurate about timeouts we should use task.run() here without await and then await the // taskcompletionsource right after but if we went down this path we would also have to account for exceptions thus complicating // the code considerably for little to no practical gain considering that the native call has trivial setup code and is very fast @@ -359,10 +453,11 @@ void FileDownloader_FatalErrorOccurred_(object sender_, FatalErrorOccurredEventA private void OnCancelled(CancelledEventArgs ea) => _cancelled?.Invoke(this, ea); private void OnLogEmitted(LogEmittedEventArgs ea) => _logEmitted?.Invoke(this, ea); - private void OnStateChanged(StateChangedEventArgs ea) => _stateChanged?.Invoke(this, ea); private void OnBusyStateChanged(BusyStateChangedEventArgs ea) => _busyStateChanged?.Invoke(this, ea); private void OnDownloadCompleted(DownloadCompletedEventArgs ea) => _downloadCompleted?.Invoke(this, ea); private void OnFatalErrorOccurred(FatalErrorOccurredEventArgs ea) => _fatalErrorOccurred?.Invoke(this, ea); + + private void OnStateChanged(StateChangedEventArgs ea) => _stateChanged?.Invoke(this, ea); private void OnFileDownloadProgressPercentageAndDataThroughputChanged(FileDownloadProgressPercentageAndDataThroughputChangedEventArgs ea) => _fileDownloadProgressPercentageAndDataThroughputChanged?.Invoke(this, ea); //this sort of approach proved to be necessary for our testsuite to be able to effectively mock away the INativeFileDownloaderProxy diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index 30fc9550..4a350130 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -250,6 +250,7 @@ public async Task UploadAsync( : DefaultGracefulCancellationTimeoutInMs; var isCancellationRequested = false; + var fileUploadProgressEventsCount = 0; var suspiciousTransportFailuresCount = 0; var didWarnOnceAboutUnstableConnection = false; for (var triesCount = 1; !isCancellationRequested;) @@ -261,6 +262,7 @@ public async Task UploadAsync( FileUploaded += FileUploader_FileUploaded_; StateChanged += FileUploader_StateChanged_; FatalErrorOccurred += FileUploader_FatalErrorOccurred_; + FileUploadProgressPercentageAndDataThroughputChanged += FileUploader_FileUploadProgressPercentageAndDataThroughputChanged_; var failSafeSettingsToApply = GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( triesCount_: triesCount, @@ -300,7 +302,9 @@ public async Task UploadAsync( } catch (TimeoutException ex) { - (this as IFileUploaderEventEmittable).OnStateChanged(new StateChangedEventArgs( //for consistency + //todo silently cancel the upload here on best effort basis + + OnStateChanged(new StateChangedEventArgs( //for consistency resource: remoteFilePath, oldState: EFileUploaderState.None, //better not use this.State here because the native call might fail newState: EFileUploaderState.Error @@ -310,6 +314,11 @@ public async Task UploadAsync( } catch (UploadErroredOutException ex) //errors with code in_value(3) and even UnauthorizedException happen all the time in android when multiuploading files { + if (fileUploadProgressEventsCount <= 10) + { + suspiciousTransportFailuresCount++; + } + if (ex is UploadErroredOutRemoteFolderNotFoundException) //order no point to retry if any of the remote parent folders are not there throw; @@ -329,7 +338,7 @@ ex is not ArgumentException //10 wops probably missing native lib symbols! && !(ex is IUploadException) //this accounts for both cancellations and upload errors ) { - (this as IFileUploaderEventEmittable).OnStateChanged(new StateChangedEventArgs( //for consistency + OnStateChanged(new StateChangedEventArgs( //for consistency resource: remoteFilePath, oldState: EFileUploaderState.None, newState: EFileUploaderState.Error @@ -345,6 +354,7 @@ ex is not ArgumentException //10 wops probably missing native lib symbols! FileUploaded -= FileUploader_FileUploaded_; StateChanged -= FileUploader_StateChanged_; FatalErrorOccurred -= FileUploader_FatalErrorOccurred_; + FileUploadProgressPercentageAndDataThroughputChanged -= FileUploader_FileUploadProgressPercentageAndDataThroughputChanged_; CleanupResourcesOfLastUpload(); //vital } @@ -364,6 +374,10 @@ void FileUploader_StateChanged_(object _, StateChangedEventArgs ea_) { switch (ea_.NewState) { + case EFileUploaderState.Idle: + fileUploadProgressEventsCount = 0; //its vital to reset the counter here to account for retries + return; + case EFileUploaderState.Complete: //taskCompletionSource.TrySetResult(true); //dont we want to wait for the FileUploaded event return; @@ -383,7 +397,7 @@ void FileUploader_StateChanged_(object _, StateChangedEventArgs ea_) await Task.Delay(gracefulCancellationTimeoutInMs); } - (this as IFileUploaderEventEmittable).OnCancelled(new CancelledEventArgs()); //00 + OnCancelled(new CancelledEventArgs()); //00 } catch // (Exception ex) { @@ -397,6 +411,11 @@ void FileUploader_StateChanged_(object _, StateChangedEventArgs ea_) // getting called right above but if that takes too long we give the killing blow by calling OnCancelled() manually here } + void FileUploader_FileUploadProgressPercentageAndDataThroughputChanged_(object sender, FileUploadProgressPercentageAndDataThroughputChangedEventArgs ea) + { + fileUploadProgressEventsCount++; + } + void FileUploader_FatalErrorOccurred_(object sender, FatalErrorOccurredEventArgs ea) { var isAboutUnauthorized = ea.ErrorCode == EMcuMgrErrorCode.AccessDenied; @@ -506,12 +525,12 @@ bool emitWarningAboutUnstableConnection_ private void OnCancelled(CancelledEventArgs ea) => _cancelled?.Invoke(this, ea); private void OnLogEmitted(LogEmittedEventArgs ea) => _logEmitted?.Invoke(this, ea); - private void OnStateChanged(StateChangedEventArgs ea) => _stateChanged?.Invoke(this, ea); private void OnFileUploaded(FileUploadedEventArgs ea) => _fileUploaded?.Invoke(this, ea); + private void OnStateChanged(StateChangedEventArgs ea) => _stateChanged?.Invoke(this, ea); private void OnBusyStateChanged(BusyStateChangedEventArgs ea) => _busyStateChanged?.Invoke(this, ea); private void OnFatalErrorOccurred(FatalErrorOccurredEventArgs ea) => _fatalErrorOccurred?.Invoke(this, ea); private void OnFileUploadProgressPercentageAndDataThroughputChanged(FileUploadProgressPercentageAndDataThroughputChangedEventArgs ea) => _fileUploadProgressPercentageAndDataThroughputChanged?.Invoke(this, ea); - + //this sort of approach proved to be necessary for our testsuite to be able to effectively mock away the INativeFileUploaderProxy internal class GenericNativeFileUploaderCallbacksProxy : INativeFileUploaderCallbacksProxy { @@ -553,11 +572,13 @@ EFileUploaderGroupReturnCode fileUploaderGroupReturnCode fileUploaderGroupReturnCode )); - public void FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput) - => FileUploader?.OnFileUploadProgressPercentageAndDataThroughputChanged(new FileUploadProgressPercentageAndDataThroughputChangedEventArgs( - averageThroughput: averageThroughput, - progressPercentage: progressPercentage - )); + public void FileUploadProgressPercentageAndDataThroughputChangedAdvertisement( + int progressPercentage, + float averageThroughput + ) => FileUploader?.OnFileUploadProgressPercentageAndDataThroughputChanged(new FileUploadProgressPercentageAndDataThroughputChangedEventArgs( + averageThroughput: averageThroughput, + progressPercentage: progressPercentage + )); } } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index 7bccfe7d..cad24d59 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -183,9 +183,9 @@ public async Task InstallAsync( var taskCompletionSource = new TaskCompletionSource(state: false); try { - Cancelled += FirmwareInstallationAsyncOnCancelled; - StateChanged += FirmwareInstallationAsyncOnStateChanged; - FatalErrorOccurred += FirmwareInstallationAsyncOnFatalErrorOccurred; + Cancelled += FirmwareInstaller_Cancelled_; + StateChanged += FirmwareInstaller_StateChanged_; + FatalErrorOccurred += FirmwareInstaller_FatalErrorOccurred_; var failSafeSettingsToApply = GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( triesCount_: triesCount, @@ -264,21 +264,21 @@ ex is not ArgumentException //10 wops probably missing native lib symbols! } finally { - Cancelled -= FirmwareInstallationAsyncOnCancelled; - StateChanged -= FirmwareInstallationAsyncOnStateChanged; - FatalErrorOccurred -= FirmwareInstallationAsyncOnFatalErrorOccurred; + Cancelled -= FirmwareInstaller_Cancelled_; + StateChanged -= FirmwareInstaller_StateChanged_; + FatalErrorOccurred -= FirmwareInstaller_FatalErrorOccurred_; CleanupResourcesOfLastUpload(); } return; - void FirmwareInstallationAsyncOnCancelled(object sender, CancelledEventArgs ea) + void FirmwareInstaller_Cancelled_(object sender, CancelledEventArgs ea) { taskCompletionSource.TrySetException(new FirmwareInstallationCancelledException()); } - void FirmwareInstallationAsyncOnStateChanged(object sender, StateChangedEventArgs ea) + void FirmwareInstaller_StateChanged_(object sender, StateChangedEventArgs ea) { switch (ea.NewState) { @@ -315,9 +315,9 @@ void FirmwareInstallationAsyncOnStateChanged(object sender, StateChangedEventArg // getting called right above but if that takes too long we give the killing blow by calling OnCancelled() manually here } - void FirmwareInstallationAsyncOnFatalErrorOccurred(object sender, FatalErrorOccurredEventArgs ea) + void FirmwareInstaller_FatalErrorOccurred_(object sender, FatalErrorOccurredEventArgs ea) { - var isAboutUnauthorized = ea.ErrorMessage?.ToUpperInvariant().Contains("UNRECOGNIZED (11)") ?? false; + var isAboutUnauthorized = ea.ErrorMessage?.ToUpperInvariant().Contains("UNRECOGNIZED (11)", StringComparison.InvariantCultureIgnoreCase) ?? false; if (isAboutUnauthorized) { taskCompletionSource.TrySetException(new UnauthorizedException(ea.ErrorMessage)); @@ -426,8 +426,14 @@ private void OnStateChanged(StateChangedEventArgs ea) private int _fileUploadProgressEventsCount; private void OnFirmwareUploadProgressPercentageAndDataThroughputChanged(FirmwareUploadProgressPercentageAndDataThroughputChangedEventArgs ea) { - _fileUploadProgressEventsCount++; - _firmwareUploadProgressPercentageAndDataThroughputChanged?.Invoke(this, ea); + try + { + _fileUploadProgressEventsCount++; + } + finally + { + _firmwareUploadProgressPercentageAndDataThroughputChanged?.Invoke(this, ea); + } } //this sort of approach proved to be necessary for our testsuite to be able to effectively mock away the INativeFirmwareInstallerProxy diff --git a/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs index 427eaede..81039cbc 100644 --- a/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs @@ -88,9 +88,16 @@ private void CleanupInfrastructure() public void Cancel() => _nativeFileDownloader?.Cancel(); public void Disconnect() => _nativeFileDownloader?.Disconnect(); - - public EFileDownloaderVerdict BeginDownload(string remoteFilePath) - => TranslateFileDownloaderVerdict(_nativeFileDownloader.BeginDownload(remoteFilePath)); + + public EFileDownloaderVerdict BeginDownload( + string remoteFilePath, + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) + { + return TranslateFileDownloaderVerdict(_nativeFileDownloader.BeginDownload(remoteFilePath: remoteFilePath)); + } #endregion commands From fd8579c24eb8378fcf91d6f70b5f63a71d5f5f6c Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 1 Oct 2024 20:23:28 +0200 Subject: [PATCH 018/104] fix (Laerdal.McuMgr.Bindings.MacCatalyst.csproj): TargetPlatformVersion=14.5 now to cater to what the vm-image in our github-cicd supports as of Oct 1 2024 --- .../Laerdal.McuMgr.Bindings.MacCatalyst.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj index 0ebe0460..f0d0b4d3 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj +++ b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj @@ -22,7 +22,7 @@ true - 13.1 + 14.5 bin\ Library From cdbcc20304ed4f3aaf415467d2e0b38c22649b33 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 1 Oct 2024 20:36:36 +0200 Subject: [PATCH 019/104] fix (Laerdal.SetupBuildEnvironment.sh): explicitly install workloads maui-ios, maui-android and maui-maccatalyst --- Laerdal.Scripts/Laerdal.SetupBuildEnvironment.sh | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Laerdal.Scripts/Laerdal.SetupBuildEnvironment.sh b/Laerdal.Scripts/Laerdal.SetupBuildEnvironment.sh index bfae5491..f13bc881 100644 --- a/Laerdal.Scripts/Laerdal.SetupBuildEnvironment.sh +++ b/Laerdal.Scripts/Laerdal.SetupBuildEnvironment.sh @@ -82,7 +82,10 @@ sudo dotnet \ install \ ios \ android \ - maccatalyst + maccatalyst \ + maui-ios \ + maui-android \ + maui-maccatalyst declare exitCode=$? if [ $exitCode != 0 ]; then echo "##vso[task.logissue type=error]Failed to restore dotnet workloads." From aa0c628f9dd73af0f8f0ff8fd3c06053c506e31b Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 1 Oct 2024 20:51:24 +0200 Subject: [PATCH 020/104] refa (github-actions.yml): disable mac-catalyst build for now until we resolve the problem we're seeing --- .github/workflows/github-actions.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml index e639d926..4dca987d 100644 --- a/.github/workflows/github-actions.yml +++ b/.github/workflows/github-actions.yml @@ -85,6 +85,8 @@ jobs: -p:Should_Skip_MacCatalyst="false" \ \ -p:PackageOutputPath="${{env.BUILD_REPOSITORY_FOLDERPATH}}/Artifacts" \ + -p:Should_Skip_MacCatalyst="true" \ + \ -p:Laerdal_Gradle_Path="/opt/homebrew/opt/gradle@7/bin/gradle" \ -p:Laerdal_Source_Branch="${{env.LAERDAL_SOURCE_BRANCH}}" \ -p:Laerdal_Repository_Path="${{env.LAERDAL_REPOSITORY_PATH}}" \ From 37d1f13047d274c05767ee2b7bdb165499034207 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 2 Oct 2024 13:51:14 +0200 Subject: [PATCH 021/104] fix (Laerdal.Builder.targets): the tests are now run with the --no-restore flag considering that we restore packages manually --- Laerdal.Scripts/Laerdal.Builder.targets | 1 + 1 file changed, 1 insertion(+) diff --git a/Laerdal.Scripts/Laerdal.Builder.targets b/Laerdal.Scripts/Laerdal.Builder.targets index a37da4c2..28b6b097 100644 --- a/Laerdal.Scripts/Laerdal.Builder.targets +++ b/Laerdal.Scripts/Laerdal.Builder.targets @@ -261,6 +261,7 @@ $(TestParameters) test 'Laerdal.McuMgr.Tests/Laerdal.McuMgr.Tests.csproj' $(TestParameters) --logger 'trx;LogFileName=TEST-Laerdal.McuMgr.Tests.xml' + $(TestParameters) --no-restore $(TestParameters) --verbosity '4' $(TestParameters) --configuration '$(Configuration)' $(TestParameters) --results-directory '$(Laerdal_Test_Results_Folderpath)' From 4eb8027f09f378e4c00bd01d01365f2ec95ef10b Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 2 Oct 2024 14:30:52 +0200 Subject: [PATCH 022/104] refa (Laerdal.Builder.targets): trivial refinements to the way we run tests --- Laerdal.Scripts/Laerdal.Builder.targets | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/Laerdal.Scripts/Laerdal.Builder.targets b/Laerdal.Scripts/Laerdal.Builder.targets index 28b6b097..33f4c49a 100644 --- a/Laerdal.Scripts/Laerdal.Builder.targets +++ b/Laerdal.Scripts/Laerdal.Builder.targets @@ -254,17 +254,20 @@ Condition=" '$(ShouldRunTestSuite)' == 'true' " AfterTargets="BuildProjects"> - - $(TestParameters) test 'Laerdal.McuMgr.Tests/Laerdal.McuMgr.Tests.csproj' + $(TestParameters) test + $(TestParameters) 'Laerdal.McuMgr.Tests/Laerdal.McuMgr.Tests.csproj' $(TestParameters) --logger 'trx;LogFileName=TEST-Laerdal.McuMgr.Tests.xml' $(TestParameters) --no-restore $(TestParameters) --verbosity '4' $(TestParameters) --configuration '$(Configuration)' $(TestParameters) --results-directory '$(Laerdal_Test_Results_Folderpath)' + $(TestParameters) -m:1 + $(TestParameters) -p:Should_Skip_MacCatalyst=$(Should_Skip_MacCatalyst) Date: Wed, 2 Oct 2024 17:11:08 +0200 Subject: [PATCH 023/104] fix (Laerdal.McuMgr.csproj): now explicitly sets the proper versions for the properties and for all platforms when building through Laerdal.Builder.targets (which is used by github-actions.yml) these properties are set to the values of the env-vars defined at the top of github-actions.yml via the new msbuild parameters Laerdal_TargetPlatformVersion_IOS/Android/MacCatalyst --- .github/workflows/github-actions.yml | 13 +++- ...Mgr.Bindings.Android.NativeBuilder.targets | 16 ++--- ...erdal.McuMgr.Bindings.Android.NetX.targets | 8 --- .../Laerdal.McuMgr.Bindings.Android.csproj | 27 +++++--- ...Laerdal.McuMgr.Bindings.MacCatalyst.csproj | 67 ++++++++++--------- ...Laerdal.McuMgr.Bindings.NetStandard.csproj | 16 ++--- .../Laerdal.McuMgr.Bindings.iOS.csproj | 34 +++++----- Laerdal.McuMgr/Laerdal.McuMgr.csproj | 49 +++++++++----- Laerdal.Scripts/Laerdal.Builder.targets | 45 ++++++++----- 9 files changed, 163 insertions(+), 112 deletions(-) diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml index e639d926..414bd13d 100644 --- a/.github/workflows/github-actions.yml +++ b/.github/workflows/github-actions.yml @@ -23,6 +23,8 @@ env: BINDINGS_IOS___SDK_VERSION: "17.5" BINDINGS_IOS___XCODE_IDE_DEV_PATH: "/Applications/Xcode_15.4.app/Contents/Developer" + BINDINGS_ANDROID___SDK_VERSION: "34" + BINDINGS_MACCATALYST___SDK_VERSION: "14.5" BINDINGS_MACCATALYST___XCODE_IDE_DEV_PATH: "/Applications/Xcode_15.4.app/Contents/Developer" @@ -85,21 +87,26 @@ jobs: -p:Should_Skip_MacCatalyst="false" \ \ -p:PackageOutputPath="${{env.BUILD_REPOSITORY_FOLDERPATH}}/Artifacts" \ + \ -p:Laerdal_Gradle_Path="/opt/homebrew/opt/gradle@7/bin/gradle" \ -p:Laerdal_Source_Branch="${{env.LAERDAL_SOURCE_BRANCH}}" \ -p:Laerdal_Repository_Path="${{env.LAERDAL_REPOSITORY_PATH}}" \ -p:Laerdal_Github_Access_Token="${{env.SCL_GITHUB_ACCESS_TOKEN}}" \ -p:Laerdal_Test_Results_Folderpath="${{env.BUILD_REPOSITORY_FOLDERPATH}}/TestResults" \ \ - -p:Laerdal_Dependency_Tracker_Server_Url="${{env.SCL_DEPENDENCY_TRACKER_SERVER_URL}}" \ - -p:Laerdal_Dependency_Tracker_Api_Key_File_Path="${{env.BUILD_REPOSITORY_FOLDERPATH}}/Laerdal.Scripts/dependency_tracker_api_key.ppk" \ - -p:Laerdal_Dependency_Tracker_Private_Signing_Key_File_Path="${{env.BUILD_REPOSITORY_FOLDERPATH}}/Laerdal.Scripts/dependency_tracker_private_signing_key.ppk" \ + -p:Laerdal_TargetPlatformVersion_IOS="${{env.BINDINGS_IOS___SDK_VERSION}}" \ + -p:Laerdal_TargetPlatformVersion_Android="${{env.BINDINGS_ANDROID___SDK_VERSION}}" \ + -p:Laerdal_TargetPlatformVersion_MacCatalyst="${{env.BINDINGS_MACCATALYST___SDK_VERSION}}" \ \ -p:Laerdal_Bindings_iOS___Sdk_Version="${{env.BINDINGS_IOS___SDK_VERSION}}" \ -p:Laerdal_Bindings_iOS___Xcode_Ide_Dev_Path="${{env.BINDINGS_IOS___XCODE_IDE_DEV_PATH}}" \ \ -p:Laerdal_Bindings_MacCatalyst___Sdk_Version="${{env.BINDINGS_MACCATALYST___SDK_VERSION}}" \ -p:Laerdal_Bindings_MacCatalyst___Xcode_Ide_Dev_Path="${{env.BINDINGS_MACCATALYST___XCODE_IDE_DEV_PATH}}" \ + \ + -p:Laerdal_Dependency_Tracker_Server_Url="${{env.SCL_DEPENDENCY_TRACKER_SERVER_URL}}" \ + -p:Laerdal_Dependency_Tracker_Api_Key_File_Path="${{env.BUILD_REPOSITORY_FOLDERPATH}}/Laerdal.Scripts/dependency_tracker_api_key.ppk" \ + -p:Laerdal_Dependency_Tracker_Private_Signing_Key_File_Path="${{env.BUILD_REPOSITORY_FOLDERPATH}}/Laerdal.Scripts/dependency_tracker_private_signing_key.ppk" \ && \ rm "./dependency_tracker_private_signing_key.ppk" "./dependency_tracker_api_key.ppk" diff --git a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NativeBuilder.targets b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NativeBuilder.targets index 3fc3d8a4..b60f2e6e 100644 --- a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NativeBuilder.targets +++ b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NativeBuilder.targets @@ -23,11 +23,11 @@ gradle - /usr/local/opt/openjdk@17 - /opt/homebrew/opt/openjdk@17 + /usr/local/opt/openjdk@17 + /opt/homebrew/opt/openjdk@17 - C:\\Program Files\\OpenJDK\\jdk-17.0.2 + C:\\Program Files\\OpenJDK\\jdk-17.0.2 $(JAVA_HOME) @@ -50,7 +50,7 @@ - + $(ANDROID_HOME) - /Users/$(USERNAME)/Library/Android/sdk - /home/$(USERNAME)/Android/Sdk - C:\\Users\\$(USERNAME)\\AppData\\Local\\Android\\sdk + /Users/$(USERNAME)/Library/Android/sdk + /home/$(USERNAME)/Android/Sdk + C:\\Users\\$(USERNAME)\\AppData\\Local\\Android\\sdk $(McuMgrLaerdalWrapperLibSourceDirectory)/mcumgr-laerdal-wrapper/build/outputs/aar/mcumgr-laerdal-wrapper-release.aar @@ -76,7 +76,7 @@ - + diff --git a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NetX.targets b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NetX.targets index 97342259..7b1c3ba3 100644 --- a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NetX.targets +++ b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NetX.targets @@ -2,14 +2,6 @@ - - 10.0 - - - 34.0 - 34 - - diff --git a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj index f6aec543..2c0fafe4 100644 --- a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj +++ b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj @@ -1,10 +1,12 @@  - true - true - true - true + true + true + true + true + 10.0 + @@ -16,8 +18,12 @@ true - true + true + + 34.0 + 21 + pdbonly $(DefineConstants);TRACE true @@ -55,10 +61,10 @@ true - 1.0.1158.0 - 1.0.1158.0 - 1.0.1158.0 - 1.0.1158.0 + 1.0.1166.0 + 1.0.1166.0 + 1.0.1166.0 + 1.0.1166.0 $(PackageId) $(Authors) @@ -104,6 +110,9 @@ + + + diff --git a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj index 0ebe0460..2dd46c75 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj +++ b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj @@ -2,27 +2,30 @@ - $( [System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::OSX)) ) - $( [System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Linux)) ) - $( [System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Windows)) ) - true + $( [System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::OSX)) ) + $( [System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Linux)) ) + $( [System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Windows)) ) + true - net8.0-maccatalyst + net8.0-maccatalyst - netstandard2.1 + netstandard2.1 true - true - true + true + true + true - true + true - 13.1 + + 14.5 + 13.1 bin\ Library @@ -69,10 +72,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1158.0 - 1.0.1158.0 - 1.0.1158.0 - 1.0.1158.0 + 1.0.1166.0 + 1.0.1166.0 + 1.0.1166.0 + 1.0.1166.0 $(PackageId) McuMgr Bindings for MacCatalyst - MAUI ready @@ -118,27 +121,29 @@ -v -v -v -v - + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + @@ -217,7 +222,7 @@ - + diff --git a/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj b/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj index d4756ec5..58ff74b4 100644 --- a/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj +++ b/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj @@ -2,10 +2,10 @@ - true - true - true - true + true + true + true + true netstandard2.1 @@ -37,10 +37,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1158.0 - 1.0.1158.0 - 1.0.1158.0 - 1.0.1158.0 + 1.0.1166.0 + 1.0.1166.0 + 1.0.1166.0 + 1.0.1166.0 $(PackageId) McuMgr C# Implementation (WIP) diff --git a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj index 9333c269..4b8657de 100644 --- a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj +++ b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj @@ -2,15 +2,15 @@ - $( [System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::OSX)) ) - $( [System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Linux)) ) - $( [System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Windows)) ) - true + $( [System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::OSX)) ) + $( [System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Linux)) ) + $( [System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::Windows)) ) + true - $(TargetFrameworks)net8.0-ios; - $(TargetFrameworks)netstandard2.1; + $(TargetFrameworks)net8.0-ios; + $(TargetFrameworks)netstandard2.1; true @@ -18,9 +18,11 @@ true true - true + true - 11.0 + + 17.5 + 11 bin\ Library @@ -70,10 +72,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1158.0 - 1.0.1158.0 - 1.0.1158.0 - 1.0.1158.0 + 1.0.1166.0 + 1.0.1166.0 + 1.0.1166.0 + 1.0.1166.0 $(PackageId) McuMgr Bindings for iOS - MAUI ready @@ -110,7 +112,7 @@ - + @@ -138,7 +140,9 @@ - + + + @@ -218,7 +222,7 @@ - + diff --git a/Laerdal.McuMgr/Laerdal.McuMgr.csproj b/Laerdal.McuMgr/Laerdal.McuMgr.csproj index 8c915bbd..7bd9dfea 100644 --- a/Laerdal.McuMgr/Laerdal.McuMgr.csproj +++ b/Laerdal.McuMgr/Laerdal.McuMgr.csproj @@ -2,10 +2,10 @@ - true - true - true - true + true + true + true + true @@ -13,8 +13,8 @@ $(TargetFrameworks)netstandard2.1; $(TargetFrameworks)net8.0-android; - $(TargetFrameworks)net8.0-ios11; - $(TargetFrameworks)net8.0-maccatalyst + $(TargetFrameworks)net8.0-ios11; + $(TargetFrameworks)net8.0-maccatalyst true true @@ -29,8 +29,24 @@ true true - true + true + + true + + + + $(Laerdal_TargetPlatformVersion_IOS) + 17.5 + $(Laerdal_TargetPlatformVersion_Android) + 34.0 + $(Laerdal_TargetPlatformVersion_MacCatalyst) + 14.5 + + 11 + 21 + 13.1 + Library bin\ 9 @@ -55,10 +71,10 @@ $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb - 1.0.1158.0 - 1.0.1158.0 - 1.0.1158.0 - 1.0.1158.0 + 1.0.1166.0 + 1.0.1166.0 + 1.0.1166.0 + 1.0.1166.0 $(PackageId) $(Authors) @@ -107,6 +123,9 @@ + + + @@ -149,21 +168,21 @@ - + - + - + - + diff --git a/Laerdal.Scripts/Laerdal.Builder.targets b/Laerdal.Scripts/Laerdal.Builder.targets index da8d8535..5a0a3c7f 100644 --- a/Laerdal.Scripts/Laerdal.Builder.targets +++ b/Laerdal.Scripts/Laerdal.Builder.targets @@ -86,6 +86,11 @@ + + + + + @@ -221,11 +226,9 @@ - - - - - + + @@ -233,15 +236,25 @@ - + - + + + + - - + + + + - + @@ -254,11 +267,13 @@ Properties="Configuration=$(Configuration);Should_Skip_MacCatalyst=$(Should_Skip_MacCatalyst);"/> - $(TestParameters) test 'Laerdal.McuMgr.Tests/Laerdal.McuMgr.Tests.csproj' - $(TestParameters) --logger 'trx;LogFileName=TEST-Laerdal.McuMgr.Tests.xml' - $(TestParameters) --verbosity '4' - $(TestParameters) --configuration '$(Configuration)' - $(TestParameters) --results-directory '$(Laerdal_Test_Results_Folderpath)' + $(TestParameters) test 'Laerdal.McuMgr.Tests/Laerdal.McuMgr.Tests.csproj' + $(TestParameters) --logger 'trx;LogFileName=TEST-Laerdal.McuMgr.Tests.xml' + + $(TestParameters) --verbosity '4' + $(TestParameters) --configuration '$(Configuration)' + $(TestParameters) --results-directory '$(Laerdal_Test_Results_Folderpath)' + Date: Wed, 2 Oct 2024 17:18:36 +0200 Subject: [PATCH 024/104] fix (Laerdal.GenerateSignAndUploadSbom.sh): dotnet-CycloneDX is now invoked with --disable-package-restore to avoid some issues with mac-catalyst builds when the mac-catalyst aspect of the build is disabled --- Laerdal.Scripts/Laerdal.GenerateSignAndUploadSbom.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Laerdal.Scripts/Laerdal.GenerateSignAndUploadSbom.sh b/Laerdal.Scripts/Laerdal.GenerateSignAndUploadSbom.sh index 9bcc6db5..f073f71d 100644 --- a/Laerdal.Scripts/Laerdal.GenerateSignAndUploadSbom.sh +++ b/Laerdal.Scripts/Laerdal.GenerateSignAndUploadSbom.sh @@ -17,7 +17,6 @@ declare sbom_signing_key_file_path="" declare dependency_tracker_url="" declare dependency_tracker_api_key_file_path="" - function parse_arguments() { while [[ $# -gt 0 ]]; do @@ -197,9 +196,10 @@ function install_tools() { function generate_sign_and_upload_sbom() { # set -x - # GENERATE SBOM + # GENERATE SBOM we intentionally disable package restore because the packages are already restored at this point dotnet-CycloneDX "${csproj_file_path}" \ --exclude-dev \ + --disable-package-restore \ --include-project-references \ \ --output "${output_directory_path}" \ From 0d079d069ed2ab4fec1661586bd4dc00ef8e8722 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 2 Oct 2024 17:52:46 +0200 Subject: [PATCH 025/104] refa (Laerdal.McuMgr.csproj): we now set the dotnet property separately from the target sdk that was used to build each binding project For iOS and MacCatalyst we use TargetPlatformVersion=17.0 because this is what the macos-14 vm-image of our CI pipelines actually support (if we use values less than 17.0 we get a warning which says that in the future this will be considered an error) --- .github/workflows/github-actions.yml | 12 +++++----- .../Laerdal.McuMgr.Bindings.Android.csproj | 2 +- ...Laerdal.McuMgr.Bindings.MacCatalyst.csproj | 4 ++-- .../Laerdal.McuMgr.Bindings.iOS.csproj | 6 ++--- Laerdal.McuMgr/Laerdal.McuMgr.csproj | 14 ++++++------ Laerdal.Scripts/Laerdal.Builder.targets | 22 ++++++++++--------- 6 files changed, 32 insertions(+), 28 deletions(-) diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml index 414bd13d..84bd508e 100644 --- a/.github/workflows/github-actions.yml +++ b/.github/workflows/github-actions.yml @@ -20,13 +20,15 @@ env: SCL_DEPENDENCY_TRACKER_SERVER_URL: ${{ secrets.SCL_DEPENDENCY_TRACKER_SERVER_URL }} SCL_DEPENDENCY_TRACKER_SIGNING_PRIVATE_KEY: ${{ secrets.SCL_DEPENDENCY_TRACKER_SIGNING_PRIVATE_KEY }} + BINDINGS_ANDROID___DOTNET_TARGET_PLATFORM_VERSION: "34" + BINDINGS_IOS___SDK_VERSION: "17.5" BINDINGS_IOS___XCODE_IDE_DEV_PATH: "/Applications/Xcode_15.4.app/Contents/Developer" - - BINDINGS_ANDROID___SDK_VERSION: "34" + BINDINGS_IOS___DOTNET_TARGET_PLATFORM_VERSION: "17.0" BINDINGS_MACCATALYST___SDK_VERSION: "14.5" BINDINGS_MACCATALYST___XCODE_IDE_DEV_PATH: "/Applications/Xcode_15.4.app/Contents/Developer" + BINDINGS_MACCATALYST___DOTNET_TARGET_PLATFORM_VERSION: "17.0" on: workflow_call: # so that other workflows can trigger this @@ -94,15 +96,15 @@ jobs: -p:Laerdal_Github_Access_Token="${{env.SCL_GITHUB_ACCESS_TOKEN}}" \ -p:Laerdal_Test_Results_Folderpath="${{env.BUILD_REPOSITORY_FOLDERPATH}}/TestResults" \ \ - -p:Laerdal_TargetPlatformVersion_IOS="${{env.BINDINGS_IOS___SDK_VERSION}}" \ - -p:Laerdal_TargetPlatformVersion_Android="${{env.BINDINGS_ANDROID___SDK_VERSION}}" \ - -p:Laerdal_TargetPlatformVersion_MacCatalyst="${{env.BINDINGS_MACCATALYST___SDK_VERSION}}" \ + -p:Laerdal_Bindings_Android___DotnetTargetPlatformVersion="${{env.BINDINGS_ANDROID___DOTNET_TARGET_PLATFORM_VERSION}}" \ \ -p:Laerdal_Bindings_iOS___Sdk_Version="${{env.BINDINGS_IOS___SDK_VERSION}}" \ -p:Laerdal_Bindings_iOS___Xcode_Ide_Dev_Path="${{env.BINDINGS_IOS___XCODE_IDE_DEV_PATH}}" \ + -p:Laerdal_Bindings_iOS___DotnetTargetPlatformVersion="${{env.BINDINGS_IOS___DOTNET_TARGET_PLATFORM_VERSION}}" \ \ -p:Laerdal_Bindings_MacCatalyst___Sdk_Version="${{env.BINDINGS_MACCATALYST___SDK_VERSION}}" \ -p:Laerdal_Bindings_MacCatalyst___Xcode_Ide_Dev_Path="${{env.BINDINGS_MACCATALYST___XCODE_IDE_DEV_PATH}}" \ + -p:Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion="${{env.BINDINGS_MACCATALYST___DOTNET_TARGET_PLATFORM_VERSION}}" \ \ -p:Laerdal_Dependency_Tracker_Server_Url="${{env.SCL_DEPENDENCY_TRACKER_SERVER_URL}}" \ -p:Laerdal_Dependency_Tracker_Api_Key_File_Path="${{env.BUILD_REPOSITORY_FOLDERPATH}}/Laerdal.Scripts/dependency_tracker_api_key.ppk" \ diff --git a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj index 2c0fafe4..38341934 100644 --- a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj +++ b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj @@ -21,7 +21,7 @@ true - 34.0 + 34 21 pdbonly diff --git a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj index 2dd46c75..07c73bf1 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj +++ b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj @@ -24,7 +24,7 @@ true - 14.5 + 17.0 13.1 bin\ @@ -38,7 +38,7 @@ $(NativeFrameworkParentFolderpath)/McuMgrBindingsiOS.framework - + diff --git a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj index 4b8657de..d18de80f 100644 --- a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj +++ b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj @@ -21,8 +21,8 @@ true - 17.5 - 11 + 17.0 + 11.0 bin\ Library @@ -38,7 +38,7 @@ $(NativeFrameworkParentFolderpath)/McuMgrBindingsiOS.framework - + diff --git a/Laerdal.McuMgr/Laerdal.McuMgr.csproj b/Laerdal.McuMgr/Laerdal.McuMgr.csproj index 7bd9dfea..2fe646da 100644 --- a/Laerdal.McuMgr/Laerdal.McuMgr.csproj +++ b/Laerdal.McuMgr/Laerdal.McuMgr.csproj @@ -36,14 +36,14 @@ - $(Laerdal_TargetPlatformVersion_IOS) - 17.5 - $(Laerdal_TargetPlatformVersion_Android) - 34.0 - $(Laerdal_TargetPlatformVersion_MacCatalyst) - 14.5 + $(Laerdal_Bindings_iOS___DotnetTargetPlatformVersion) + 17.0 + $(Laerdal_Bindings_Android___DotnetTargetPlatformVersion) + 34 + $(Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion) + 17.0 - 11 + 11.0 21 13.1 diff --git a/Laerdal.Scripts/Laerdal.Builder.targets b/Laerdal.Scripts/Laerdal.Builder.targets index 5a0a3c7f..05c8c0b9 100644 --- a/Laerdal.Scripts/Laerdal.Builder.targets +++ b/Laerdal.Scripts/Laerdal.Builder.targets @@ -87,9 +87,9 @@ - - - + + + @@ -237,24 +237,24 @@ + Properties="$(_Laerdal_Build_Parameters);TargetPlatformVersion=$(Laerdal_Bindings_Android___DotnetTargetPlatformVersion);BuildingProject=true;SourceRoot=$(Laerdal_RootDirectory_Folderpath)/Laerdal.McuMgr.Bindings.Android/;" Targets="Build"/> + Properties="$(_Laerdal_Build_Parameters);TargetPlatformVersion=$(Laerdal_Bindings_iOS___DotnetTargetPlatformVersion);Laerdal_Bindings_iOS___Xcode_Ide_Dev_Path=$(Laerdal_Bindings_iOS___Xcode_Ide_Dev_Path);Laerdal_Bindings_iOS___Sdk_Version=$(Laerdal_Bindings_iOS___Sdk_Version);SourceRoot=$(Laerdal_RootDirectory_Folderpath)/Laerdal.McuMgr.Bindings.iOS/;" Targets="Restore;Rebuild"/> + Properties="$(_Laerdal_Build_Parameters);TargetPlatformVersion=$(Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion);Laerdal_Bindings_MacCatalyst___Xcode_Ide_Dev_Path=$(Laerdal_Bindings_MacCatalyst___Xcode_Ide_Dev_Path);Laerdal_Bindings_MacCatalyst___Sdk_Version=$(Laerdal_Bindings_MacCatalyst___Sdk_Version);SourceRoot=$(Laerdal_RootDirectory_Folderpath)/Laerdal.McuMgr.Bindings.MacCatalyst/;" /> + Properties="$(_Laerdal_Build_Parameters);Laerdal_Bindings_Android___DotnetTargetPlatformVersion=$(Laerdal_Bindings_Android___DotnetTargetPlatformVersion);Laerdal_Bindings_iOS___DotnetTargetPlatformVersion=$(Laerdal_Bindings_iOS___DotnetTargetPlatformVersion);Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion=$(Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion);SourceRoot=$(Laerdal_RootDirectory_Folderpath)/Laerdal.McuMgr/;" Targets="Restore;Rebuild"/> @@ -264,16 +264,18 @@ + Properties="Configuration=$(Configuration);Should_Skip_MacCatalyst=$(Should_Skip_MacCatalyst);Laerdal_Bindings_iOS___DotnetTargetPlatformVersion=$(Laerdal_Bindings_iOS___DotnetTargetPlatformVersion);Laerdal_Bindings_Android___DotnetTargetPlatformVersion=$(Laerdal_Bindings_Android___DotnetTargetPlatformVersion);Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion=$(Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion);"/> $(TestParameters) test 'Laerdal.McuMgr.Tests/Laerdal.McuMgr.Tests.csproj' $(TestParameters) --logger 'trx;LogFileName=TEST-Laerdal.McuMgr.Tests.xml' - + $(TestParameters) --no-restore $(TestParameters) --verbosity '4' $(TestParameters) --configuration '$(Configuration)' $(TestParameters) --results-directory '$(Laerdal_Test_Results_Folderpath)' - + $(TestParameters) -p:Laerdal_Bindings_iOS___DotnetTargetPlatformVersion=$(Laerdal_Bindings_iOS___DotnetTargetPlatformVersion) + $(TestParameters) -p:Laerdal_Bindings_Android___DotnetTargetPlatformVersion=$(Laerdal_Bindings_Android___DotnetTargetPlatformVersion) + $(TestParameters) -p:Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion=$(Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion) Date: Wed, 2 Oct 2024 19:59:24 +0200 Subject: [PATCH 026/104] fix (Laerdal.Builder.targets): fix a bug which was causing our build script to fail building android/ios/maccatalyst due to an issue with the way we fallback to the default target-platform-version for each platform [skip ci] --- .../Laerdal.McuMgr.Bindings.Android.csproj | 15 ++++++++------- .../Laerdal.McuMgr.Bindings.MacCatalyst.csproj | 15 ++++++++------- .../Laerdal.McuMgr.Bindings.NetStandard.csproj | 8 ++++---- .../Laerdal.McuMgr.Bindings.iOS.csproj | 15 ++++++++------- Laerdal.McuMgr/Laerdal.McuMgr.csproj | 16 ++++++++-------- Laerdal.Scripts/Laerdal.Builder.targets | 6 +++--- 6 files changed, 39 insertions(+), 36 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj index 38341934..5d3773c2 100644 --- a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj +++ b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj @@ -20,9 +20,10 @@ true - - 34 - 21 + + $(Laerdal_Bindings_Android___DotnetTargetPlatformVersion) + 34 + 21 pdbonly $(DefineConstants);TRACE @@ -61,10 +62,10 @@ true - 1.0.1166.0 - 1.0.1166.0 - 1.0.1166.0 - 1.0.1166.0 + 1.0.1167.0 + 1.0.1167.0 + 1.0.1167.0 + 1.0.1167.0 $(PackageId) $(Authors) diff --git a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj index e7a42a14..c5831364 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj +++ b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj @@ -23,9 +23,10 @@ true - - 17.0 - 14.5 + + $(Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion) + 17.0 + 13.1 bin\ Library @@ -72,10 +73,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1166.0 - 1.0.1166.0 - 1.0.1166.0 - 1.0.1166.0 + 1.0.1167.0 + 1.0.1167.0 + 1.0.1167.0 + 1.0.1167.0 $(PackageId) McuMgr Bindings for MacCatalyst - MAUI ready diff --git a/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj b/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj index 58ff74b4..e534f353 100644 --- a/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj +++ b/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj @@ -37,10 +37,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1166.0 - 1.0.1166.0 - 1.0.1166.0 - 1.0.1166.0 + 1.0.1167.0 + 1.0.1167.0 + 1.0.1167.0 + 1.0.1167.0 $(PackageId) McuMgr C# Implementation (WIP) diff --git a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj index d18de80f..4480d155 100644 --- a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj +++ b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj @@ -20,9 +20,10 @@ true - - 17.0 - 11.0 + + $(Laerdal_Bindings_iOS___DotnetTargetPlatformVersion) + 17.0 + 11.0 bin\ Library @@ -72,10 +73,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1166.0 - 1.0.1166.0 - 1.0.1166.0 - 1.0.1166.0 + 1.0.1167.0 + 1.0.1167.0 + 1.0.1167.0 + 1.0.1167.0 $(PackageId) McuMgr Bindings for iOS - MAUI ready diff --git a/Laerdal.McuMgr/Laerdal.McuMgr.csproj b/Laerdal.McuMgr/Laerdal.McuMgr.csproj index 2fe646da..314792d1 100644 --- a/Laerdal.McuMgr/Laerdal.McuMgr.csproj +++ b/Laerdal.McuMgr/Laerdal.McuMgr.csproj @@ -71,10 +71,10 @@ $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb - 1.0.1166.0 - 1.0.1166.0 - 1.0.1166.0 - 1.0.1166.0 + 1.0.1167.0 + 1.0.1167.0 + 1.0.1167.0 + 1.0.1167.0 $(PackageId) $(Authors) @@ -168,21 +168,21 @@ - + - + - + - + diff --git a/Laerdal.Scripts/Laerdal.Builder.targets b/Laerdal.Scripts/Laerdal.Builder.targets index a87271e8..4826dd6a 100644 --- a/Laerdal.Scripts/Laerdal.Builder.targets +++ b/Laerdal.Scripts/Laerdal.Builder.targets @@ -242,20 +242,20 @@ + Properties="$(_Laerdal_Build_Parameters);Laerdal_Bindings_Android___DotnetTargetPlatformVersion=$(Laerdal_Bindings_Android___DotnetTargetPlatformVersion);BuildingProject=true;SourceRoot=$(Laerdal_RootDirectory_Folderpath)/Laerdal.McuMgr.Bindings.Android/;" Targets="Build"/> + Properties="$(_Laerdal_Build_Parameters);Laerdal_Bindings_iOS___DotnetTargetPlatformVersion=$(Laerdal_Bindings_iOS___DotnetTargetPlatformVersion);Laerdal_Bindings_iOS___Xcode_Ide_Dev_Path=$(Laerdal_Bindings_iOS___Xcode_Ide_Dev_Path);Laerdal_Bindings_iOS___Sdk_Version=$(Laerdal_Bindings_iOS___Sdk_Version);SourceRoot=$(Laerdal_RootDirectory_Folderpath)/Laerdal.McuMgr.Bindings.iOS/;" Targets="Restore;Rebuild"/> + Properties="$(_Laerdal_Build_Parameters);Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion=$(Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion);Laerdal_Bindings_MacCatalyst___Xcode_Ide_Dev_Path=$(Laerdal_Bindings_MacCatalyst___Xcode_Ide_Dev_Path);Laerdal_Bindings_MacCatalyst___Sdk_Version=$(Laerdal_Bindings_MacCatalyst___Sdk_Version);SourceRoot=$(Laerdal_RootDirectory_Folderpath)/Laerdal.McuMgr.Bindings.MacCatalyst/;" /> Date: Wed, 2 Oct 2024 20:18:37 +0200 Subject: [PATCH 027/104] fix (Laerdal.McuMgr.Bindings.MacCatalyst.csproj): we now pass SUPPORTS_MACCATALYST=YES as intended --- .../Laerdal.McuMgr.Bindings.MacCatalyst.csproj | 1 + Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj | 1 + 2 files changed, 2 insertions(+) diff --git a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj index c5831364..460991fb 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj +++ b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj @@ -170,6 +170,7 @@ + <_CliCommand>$(_CliCommand) SUPPORTS_MACCATALYST='YES' <_CliCommand>$(_CliCommand) SWIFT_OUTPUT_PATH='$(NativeFrameworkParentFolderpath)' <_CliCommand>$(_CliCommand) XCODE_IDE_DEV_PATH='$(Laerdal_Bindings_MacCatalyst___Xcode_Ide_Dev_Path)' <_CliCommand>$(_CliCommand) XCODEBUILD_TARGET_SDK='macosx' diff --git a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj index 4480d155..f1db6f2f 100644 --- a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj +++ b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj @@ -170,6 +170,7 @@ + <_CliCommand>$(_CliCommand) SUPPORTS_MACCATALYST='NO' <_CliCommand>$(_CliCommand) SWIFT_OUTPUT_PATH='$(NativeFrameworkParentFolderpath)' <_CliCommand>$(_CliCommand) XCODE_IDE_DEV_PATH='$(Laerdal_Bindings_iOS___Xcode_Ide_Dev_Path)' <_CliCommand>$(_CliCommand) XCODEBUILD_TARGET_SDK='iphoneos' From d20552e4766629c51681687184a57142aae4362d Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 3 Oct 2024 11:53:24 +0200 Subject: [PATCH 028/104] fix (Laerdal.Mac.CompileAndGenerateFatLibs.sh): fix a bug which sneaked in recently causing the mac-catalyst build to fail due to the output dir-path being off --- .../Laerdal.McuMgr.Bindings.MacCatalyst.csproj | 2 +- .../Laerdal.Mac.CompileAndGenerateFatLibs.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj index 460991fb..6aa4f937 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj +++ b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj @@ -166,7 +166,7 @@ BeforeTargets="PrepareForBuild" Condition=" '$(ShouldBuildNativeLibraries)' == 'true' and '$(DesignTimeBuild)' != 'true' and '$(BuildingProject)' == 'true' "> - + diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/Laerdal.Mac.CompileAndGenerateFatLibs.sh b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/Laerdal.Mac.CompileAndGenerateFatLibs.sh index 4bd77773..88c6ecb3 100755 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/Laerdal.Mac.CompileAndGenerateFatLibs.sh +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/Laerdal.Mac.CompileAndGenerateFatLibs.sh @@ -35,7 +35,7 @@ declare SWIFT_PACKAGES_PATH="./packages" declare OUTPUT_FOLDER_POSTFIX="" if [ "${XCODEBUILD_TARGET_SDK}" == "macosx" ]; then - OUTPUT_FOLDER_POSTFIX="" # special case for mac catalyst sdk 15.2 wanted this to be "-maccatalyst" but sdk 15.4 wants it to be empty go figure ... + OUTPUT_FOLDER_POSTFIX="-maccatalyst" # special case for mac catalyst else OUTPUT_FOLDER_POSTFIX="-${XCODEBUILD_TARGET_SDK}" fi From afadfb11a3d56d0591a7a41ae1c6bfde5054b317 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 3 Oct 2024 15:32:39 +0200 Subject: [PATCH 029/104] clean (AndroidFileDownloader.java): remove non-applicable parameters windowCapacity and memoryAlignment considering that they're not currently supported for file-downloading operations https://github.com/NordicSemiconductor/Android-nRF-Connect-Device-Manager/issues/188#issuecomment-2391146897 [skip ci] --- .../AndroidFileDownloader.java | 8 +++--- .../Laerdal.McuMgr.Bindings.Android.csproj | 8 +++--- ...Laerdal.McuMgr.Bindings.MacCatalyst.csproj | 8 +++--- ...Laerdal.McuMgr.Bindings.NetStandard.csproj | 8 +++--- .../Laerdal.McuMgr.Bindings.iOS.csproj | 8 +++--- ...entException_GivenInvalidRemoteFilePath.cs | 6 ++--- ...leteSuccessfully_GivenNoFilesToDownload.cs | 6 ++--- ...uccessfully_GivenVariousFilesToDownload.cs | 6 ++--- ...hCollectionWithErroneousFilesToDownload.cs | 6 ++--- ...ntException_GivenNullForFilesToDownload.cs | 6 ++--- ...ToFailsafeSettings_GivenFlakyConnection.cs | 25 ++----------------- ...essfully_GivenGreenNativeFileDownloader.cs | 6 ++--- ...ailedException_GivenFatalErrorMidflight.cs | 6 ++--- ...dException_GivenRogueNativeErrorMessage.cs | 6 ++--- ...umentException_GivenEmptyRemoteFilePath.cs | 6 ++--- ...ption_GivenCancellationRequestMidflight.cs | 6 ++--- ...tion_GivenErroneousNativeFileDownloader.cs | 6 ++--- ...adTimeoutException_GivenTooSmallTimeout.cs | 6 ++--- ...FoundException_GivenNonExistentFilepath.cs | 6 ++--- .../FileDownloader/FileDownloaderTestbed.cs | 4 +-- .../Droid/FileDownloader/FileDownloader.cs | 8 ++---- Laerdal.McuMgr/Laerdal.McuMgr.csproj | 16 ++++++------ .../INativeFileDownloaderCommandableProxy.cs | 2 +- .../Shared/FileDownloader/FileDownloader.cs | 4 +-- .../iOS/FileDownloader/FileDownloader.cs | 4 +-- 25 files changed, 61 insertions(+), 120 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index b633f74f..465ca8a3 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -37,16 +37,14 @@ public AndroidFileDownloader(@NonNull final Context context, @NonNull final Blue * @param remoteFilePath the remote-file-path to the file on the remote device that you wish to download * @param initialMtuSize sets the initial MTU for the connection that the McuMgr BLE-transport sets up for the firmware installation that will follow. * Note that if less than 0 it gets ignored and if it doesn't fall within the range [23, 517] it will cause a hard error. - * @param windowCapacity specifies the windows-capacity for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default - * @param memoryAlignment specifies the memory-alignment to use for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default * * @return a verdict indicating whether the file uploading was started successfully or not */ public EAndroidFileDownloaderVerdict beginDownload( final String remoteFilePath, - final int initialMtuSize, - final int windowCapacity, //todo should we keep this or remove it? it doesnt seem to be applicable to the file-downloader - final int memoryAlignment //todo should we keep this or remove it? it doesnt seem to be applicable to the file-downloader + final int initialMtuSize + // final int windowCapacity, //theoretically nordic firmwares at some point will support this for downloads but as of Q3 2024 there is no support for this + // final int memoryAlignment //this doesnt make sense for downloading it only makes sense in uploading scenarios https://github.com/NordicSemiconductor/Android-nRF-Connect-Device-Manager/issues/188#issuecomment-2391146897 ) { if (_currentState != EAndroidFileDownloaderState.NONE //if the download is already in progress we bail out diff --git a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj index 5d3773c2..691c6362 100644 --- a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj +++ b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj @@ -62,10 +62,10 @@ true - 1.0.1167.0 - 1.0.1167.0 - 1.0.1167.0 - 1.0.1167.0 + 1.0.1168.0 + 1.0.1168.0 + 1.0.1168.0 + 1.0.1168.0 $(PackageId) $(Authors) diff --git a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj index 6aa4f937..f1f8fa61 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj +++ b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj @@ -73,10 +73,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1167.0 - 1.0.1167.0 - 1.0.1167.0 - 1.0.1167.0 + 1.0.1168.0 + 1.0.1168.0 + 1.0.1168.0 + 1.0.1168.0 $(PackageId) McuMgr Bindings for MacCatalyst - MAUI ready diff --git a/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj b/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj index e534f353..ceb6eab9 100644 --- a/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj +++ b/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj @@ -37,10 +37,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1167.0 - 1.0.1167.0 - 1.0.1167.0 - 1.0.1167.0 + 1.0.1168.0 + 1.0.1168.0 + 1.0.1168.0 + 1.0.1168.0 $(PackageId) McuMgr C# Implementation (WIP) diff --git a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj index f1db6f2f..9bb84e46 100644 --- a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj +++ b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj @@ -73,10 +73,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1167.0 - 1.0.1167.0 - 1.0.1167.0 - 1.0.1167.0 + 1.0.1168.0 + 1.0.1168.0 + 1.0.1168.0 + 1.0.1168.0 $(PackageId) McuMgr Bindings for iOS - MAUI ready diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.BeginDownload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.BeginDownload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs index 652f5ba7..f93b1510 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.BeginDownload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.BeginDownload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs @@ -49,13 +49,11 @@ public MockedGreenNativeFileDownloaderProxySpy1(INativeFileDownloaderCallbacksPr _mockedFileData = mockedFileData; } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) { var verdict = base.BeginDownload( remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); Task.Run(async () => //00 vital diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs index 05893278..b5ef7796 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs @@ -41,13 +41,11 @@ public MockedGreenNativeFileDownloaderProxySpy5(INativeFileDownloaderCallbacksPr { } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) { var verdict = base.BeginDownload( remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); Task.Run(async () => //00 vital diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index f5a02e01..e1cf813e 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -82,13 +82,11 @@ public MockedGreenNativeFileDownloaderProxySpy6(INativeFileDownloaderCallbacksPr } private int _retryCountForProblematicFile; - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) { var verdict = base.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); Task.Run(async () => //00 vital diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs index 7f8001a5..cf54bae9 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs @@ -49,13 +49,11 @@ public MockedGreenNativeFileDownloaderProxySpy11(INativeFileDownloaderCallbacksP { } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) { var verdict = base.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); Task.Run(async () => //00 vital diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs index 1b64a6fe..beb63324 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs @@ -40,13 +40,11 @@ public MockedGreenNativeFileDownloaderProxySpy10(INativeFileDownloaderCallbacksP { } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) { var verdict = base.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); Task.Run(async () => //00 vital diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index d6aee556..3716a16a 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -93,19 +93,14 @@ public MockedGreenNativeFileDownloaderProxySpy120(byte[] expectedData, INativeFi private int _tryCounter; public override EFileDownloaderVerdict BeginDownload( string remoteFilePath, - int? initialMtuSize = null, // android only - int? windowCapacity = null, // android only - int? memoryAlignment = null // android only + int? initialMtuSize = null // android only ) { _tryCounter++; var verdict = base.BeginDownload( remoteFilePath: remoteFilePath, - - initialMtuSize: initialMtuSize, // android only - windowCapacity: windowCapacity, // android only - memoryAlignment: memoryAlignment // android only + initialMtuSize: initialMtuSize // android only ); Task.Run(async () => //00 vital @@ -136,22 +131,6 @@ public override EFileDownloaderVerdict BeginDownload( return; } - if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity) - { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected); // order - return; - } - - if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment) - { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected); // order - return; - } - if (_tryCounter < _maxTriesCount) { await Task.Delay(20); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index 5e6b92fc..887c797f 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -84,15 +84,13 @@ public MockedGreenNativeFileDownloaderProxySpy(INativeFileDownloaderCallbacksPro } private int _tryCount; - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) { _tryCount++; var verdict = base.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); Task.Run(async () => //00 vital diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs index 7a58c7df..62d54476 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs @@ -71,13 +71,11 @@ public MockedGreenNativeFileDownloaderProxySpy4(INativeFileDownloaderCallbacksPr _ = mockedFileData; } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) { var verdict = base.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); Task.Run(async () => //00 vital diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs index ef64aaf1..742a7352 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs @@ -82,13 +82,11 @@ public MockedErroneousNativeFileDownloaderProxySpy13(INativeFileDownloaderCallba _nativeErrorMessageForFileNotFound = nativeErrorMessageForFileNotFound; } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) { var verdict = base.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); Task.Run(async () => //00 vital diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs index b81c1477..19f92471 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs @@ -45,13 +45,11 @@ public MockedGreenNativeFileDownloaderProxySpy2(INativeFileDownloaderCallbacksPr _mockedFileData = mockedFileData; } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) { var verdict = base.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); Task.Run(async () => //00 vital diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadCancelledException_GivenCancellationRequestMidflight.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadCancelledException_GivenCancellationRequestMidflight.cs index 89bf5511..1588a904 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadCancelledException_GivenCancellationRequestMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadCancelledException_GivenCancellationRequestMidflight.cs @@ -91,7 +91,7 @@ public override void Cancel() // a best effort basis and this is exactly what we are testing here } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) { _currentRemoteFilePath = remoteFilePath; _cancellationTokenSource = new CancellationTokenSource(); @@ -103,9 +103,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? var verdict = base.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); Task.Run(async () => //00 vital diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadInternalErrorException_GivenErroneousNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadInternalErrorException_GivenErroneousNativeFileDownloader.cs index 375ca024..77f5b5ac 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadInternalErrorException_GivenErroneousNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadInternalErrorException_GivenErroneousNativeFileDownloader.cs @@ -34,13 +34,11 @@ public MockedErroneousNativeFileDownloaderProxySpy(INativeFileDownloaderCallback { } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) { base.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); Thread.Sleep(100); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs index 23c15bbc..94ba00a3 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs @@ -51,13 +51,11 @@ public MockedGreenButSlowNativeFileDownloaderProxySpy(INativeFileDownloaderCallb { } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) { var verdict = base.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); Task.Run(async () => //00 vital diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs index 36e815b6..b33545b6 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs @@ -85,13 +85,11 @@ public MockedErroneousNativeFileDownloaderProxySpy2(INativeFileDownloaderCallbac _nativeErrorMessageForFileNotFound = nativeErrorMessageForFileNotFound; } - public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null) + public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) { var verdict = base.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); Task.Run(async () => //00 vital diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs index 43f7f67c..a5bc57ee 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs @@ -30,9 +30,7 @@ protected MockedNativeFileDownloaderProxySpy(INativeFileDownloaderCallbacksProxy public virtual EFileDownloaderVerdict BeginDownload( string remoteFilePath, - int? initialMtuSize = null, - int? windowCapacity = null, - int? memoryAlignment = null + int? initialMtuSize = null ) { BeginDownloadCalled = true; diff --git a/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs index a829f993..dc19ba9b 100644 --- a/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs @@ -94,16 +94,12 @@ private void CleanupInfrastructure() public EFileDownloaderVerdict BeginDownload( string remoteFilePath, - int? initialMtuSize = null, // android only - int? windowCapacity = null, // android only - int? memoryAlignment = null // android only + int? initialMtuSize = null // android only ) { return TranslateFileDownloaderVerdict(base.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize ?? -1, - windowCapacity: windowCapacity ?? -1, //todo remove these if they turn out to be non-applicable to file-downloading - memoryAlignment: memoryAlignment ?? -1 + initialMtuSize: initialMtuSize ?? -1 )); } diff --git a/Laerdal.McuMgr/Laerdal.McuMgr.csproj b/Laerdal.McuMgr/Laerdal.McuMgr.csproj index 314792d1..083783c8 100644 --- a/Laerdal.McuMgr/Laerdal.McuMgr.csproj +++ b/Laerdal.McuMgr/Laerdal.McuMgr.csproj @@ -71,10 +71,10 @@ $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb - 1.0.1167.0 - 1.0.1167.0 - 1.0.1167.0 - 1.0.1167.0 + 1.0.1168.0 + 1.0.1168.0 + 1.0.1168.0 + 1.0.1168.0 $(PackageId) $(Authors) @@ -168,21 +168,21 @@ - + - + - + - + diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCommandableProxy.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCommandableProxy.cs index 96e884ec..8d0ebba2 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCommandableProxy.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCommandableProxy.cs @@ -6,6 +6,6 @@ internal interface INativeFileDownloaderCommandableProxy { void Cancel(); void Disconnect(); - EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null); + EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null); } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index 32ff87ca..3d7c21b2 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -51,9 +51,7 @@ public EFileDownloaderVerdict BeginDownload( var verdict = _nativeFileDownloaderProxy.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: initialMtuSize ); return verdict; diff --git a/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs index 81039cbc..0ae35b87 100644 --- a/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs @@ -91,9 +91,7 @@ private void CleanupInfrastructure() public EFileDownloaderVerdict BeginDownload( string remoteFilePath, - int? initialMtuSize = null, // android only - int? windowCapacity = null, // android only - int? memoryAlignment = null // android only + int? initialMtuSize = null // android only ) { return TranslateFileDownloaderVerdict(_nativeFileDownloader.BeginDownload(remoteFilePath: remoteFilePath)); From bec12cc441d2ff2602233a08e54e5171409ce259 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 3 Oct 2024 16:35:02 +0200 Subject: [PATCH 030/104] fix (AndroidFileUploader.java, IOSFileUploader.swift): if the file-uploading operation fails to commence we now return error code .FAILED__ERROR_UPON_COMMENCING / .failedErrorUponCommencing (old was: .errorInvalidSettings which wasn't accurate) --- .../AndroidFileUploader.java | 8 ++++--- .../EAndroidFileUploaderVerdict.java | 7 +++--- ...OSFileUploadingInitializationVerdict.swift | 7 +++--- .../McuMgrBindingsiOS/IOSFileUploader.swift | 24 +++++++++---------- .../Droid/FileUploader/FileUploader.cs | 11 ++++++--- .../Contracts/Enums/EFileUploaderVerdict.cs | 7 +++--- .../iOS/FileUploader/FileUploader.cs | 11 ++++++--- 7 files changed, 45 insertions(+), 30 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 490d3fe5..f0bdf137 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -164,20 +164,22 @@ public EAndroidFileUploaderVerdict beginUpload( try { - _uploadController = new FileUploader( //00 + FileUploader fileUploader = new FileUploader( //00 _fileSystemManager, _remoteFilePathSanitized, data, Math.max(1, windowCapacity), Math.max(1, memoryAlignment) - ).uploadAsync(_fileUploaderCallbackProxy); + ); + + _uploadController = fileUploader.uploadAsync(_fileUploaderCallbackProxy); } catch (final Exception ex) { setState(EAndroidFileUploaderState.ERROR); onError(_remoteFilePathSanitized, "Failed to initialize the upload", ex); - return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; + return EAndroidFileUploaderVerdict.FAILED__ERROR_UPON_COMMENCING; } return EAndroidFileUploaderVerdict.SUCCESS; diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileUploaderVerdict.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileUploaderVerdict.java index 9428b8ad..674e4bc5 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileUploaderVerdict.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileUploaderVerdict.java @@ -3,9 +3,10 @@ public enum EAndroidFileUploaderVerdict //this must mirror the enum values of E[Android|iOS]FileUploaderVerdict { SUCCESS(0), - FAILED__INVALID_SETTINGS(1), - FAILED__INVALID_DATA(2), - FAILED__OTHER_UPLOAD_ALREADY_IN_PROGRESS(3); + FAILED__INVALID_DATA(1), + FAILED__INVALID_SETTINGS(2), + FAILED__ERROR_UPON_COMMENCING(3), //connection problems + FAILED__OTHER_UPLOAD_ALREADY_IN_PROGRESS(4); @SuppressWarnings({"FieldCanBeLocal", "unused"}) private final int _value; diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFileUploadingInitializationVerdict.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFileUploadingInitializationVerdict.swift index c3046b4f..28eab1a5 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFileUploadingInitializationVerdict.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFileUploadingInitializationVerdict.swift @@ -1,7 +1,8 @@ @objc public enum EIOSFileUploadingInitializationVerdict: Int { case success = 0 - case failedInvalidSettings = 1 - case failedInvalidData = 2 - case failedOtherUploadAlreadyInProgress = 3 + case failedInvalidData = 1 + case failedInvalidSettings = 2 + case failedErrorUponCommencing = 3 + case failedOtherUploadAlreadyInProgress = 4 } diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift index 8a4248c7..0decc5c4 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift @@ -59,7 +59,7 @@ public class IOSFileUploader: NSObject { @objc public func beginUpload( _ remoteFilePath: String, - _ data: Data, + _ data: Data?, _ pipelineDepth: Int, _ byteAlignment: Int ) -> EIOSFileUploadingInitializationVerdict { @@ -115,15 +115,13 @@ public class IOSFileUploader: NSObject { return EIOSFileUploadingInitializationVerdict.failedInvalidSettings } - // if data == nil { // data being nil is not ok but in swift Data can never be nil anyway btw data.length==0 is perfectly ok because we might want to create empty files - // return EIOSFileUploaderVerdict.FAILED__INVALID_DATA - // } - - disposeFilesystemManager() //vital hack normally we shouldnt need this but there seems to be a bug in the lib https://github.com/NordicSemiconductor/IOS-nRF-Connect-Device-Manager/issues/209 + if data == nil { // data being nil is not ok btw data.length==0 is perfectly ok because we might want to create empty files + return EIOSFileUploadingInitializationVerdict.failedInvalidData + } + disposeFilesystemManager() //00 vital hack ensureTransportIsInitializedExactlyOnce() //order ensureFilesystemManagerIsInitializedExactlyOnce() //order - resetUploadState() //order var configuration = FirmwareUpgradeConfiguration(byteAlignment: byteAlignmentEnum!) @@ -132,19 +130,21 @@ public class IOSFileUploader: NSObject { } let success = _fileSystemManager.upload( //order - name: _remoteFilePathSanitized, - data: data, - using: configuration, - delegate: self + name: _remoteFilePathSanitized, + data: data!, + using: configuration, + delegate: self ) if !success { setState(EIOSFileUploaderState.error) onError("Failed to commence file-uploading (check logs for details)") - return EIOSFileUploadingInitializationVerdict.failedInvalidSettings + return EIOSFileUploadingInitializationVerdict.failedErrorUponCommencing } return EIOSFileUploadingInitializationVerdict.success + + //00 normally we shouldnt need this but there seems to be a bug in the lib https://github.com/NordicSemiconductor/IOS-nRF-Connect-Device-Manager/issues/209 } private func translateByteAlignmentMode(_ alignment: Int) -> ImageUploadAlignment? { diff --git a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs index 3742d8dd..32b8591c 100644 --- a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs @@ -243,17 +243,22 @@ static private EFileUploaderVerdict TranslateFileUploaderVerdict(EAndroidFileUpl { return EFileUploaderVerdict.Success; } + + if (verdict == EAndroidFileUploaderVerdict.FailedInvalidData) + { + return EFileUploaderVerdict.FailedInvalidData; + } if (verdict == EAndroidFileUploaderVerdict.FailedInvalidSettings) { return EFileUploaderVerdict.FailedInvalidSettings; } - if (verdict == EAndroidFileUploaderVerdict.FailedInvalidData) + if (verdict == EAndroidFileUploaderVerdict.FailedErrorUponCommencing) { - return EFileUploaderVerdict.FailedInvalidData; + return EFileUploaderVerdict.FailedErrorUponCommencing; } - + if (verdict == EAndroidFileUploaderVerdict.FailedOtherUploadAlreadyInProgress) { return EFileUploaderVerdict.FailedOtherUploadAlreadyInProgress; diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/EFileUploaderVerdict.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/EFileUploaderVerdict.cs index 72523071..0456f23c 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/EFileUploaderVerdict.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/EFileUploaderVerdict.cs @@ -6,8 +6,9 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Enums public enum EFileUploaderVerdict //this must mirror the java enum values of E[Android|iOS]FileUploaderVerdict { Success = 0, - FailedInvalidSettings = 1, - FailedInvalidData = 2, - FailedOtherUploadAlreadyInProgress = 3, + FailedInvalidData = 1, + FailedInvalidSettings = 2, + FailedErrorUponCommencing = 3, + FailedOtherUploadAlreadyInProgress = 4, } } diff --git a/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs b/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs index dfec9fe5..29cfc356 100644 --- a/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs @@ -239,17 +239,22 @@ static private EFileUploaderVerdict TranslateFileUploaderVerdict(EIOSFileUploadi { return EFileUploaderVerdict.Success; } + + if (verdict == EIOSFileUploadingInitializationVerdict.FailedInvalidData) + { + return EFileUploaderVerdict.FailedInvalidData; + } if (verdict == EIOSFileUploadingInitializationVerdict.FailedInvalidSettings) { return EFileUploaderVerdict.FailedInvalidSettings; } - if (verdict == EIOSFileUploadingInitializationVerdict.FailedInvalidData) + if (verdict == EIOSFileUploadingInitializationVerdict.FailedErrorUponCommencing) { - return EFileUploaderVerdict.FailedInvalidData; + return EFileUploaderVerdict.FailedErrorUponCommencing; } - + if (verdict == EIOSFileUploadingInitializationVerdict.FailedOtherUploadAlreadyInProgress) { return EFileUploaderVerdict.FailedOtherUploadAlreadyInProgress; From 7d2a1e4ba02e393c00602a7004690b89c1ee0390 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 3 Oct 2024 17:05:49 +0200 Subject: [PATCH 031/104] fix (AndroidFileDownloader.java, IOSFileDownloader.swift): if the file-downloading operation fails to commence we now return error code .FAILED__ERROR_UPON_COMMENCING / .failedErrorUponCommencing (old was: .errorInvalidSettings which wasn't accurate) --- .../AndroidFileDownloader.java | 28 +++++++++---------- .../EAndroidFileDownloaderVerdict.java | 3 +- ...FileDownloadingInitializationVerdict.swift | 3 +- .../McuMgrBindingsiOS/IOSFileDownloader.swift | 2 +- .../Droid/FileDownloader/FileDownloader.cs | 7 ++++- .../Contracts/Enums/EFileDownloaderVerdict.cs | 3 +- .../iOS/FileDownloader/FileDownloader.cs | 5 ++++ 7 files changed, 32 insertions(+), 19 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index 465ca8a3..a6fd0239 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -81,25 +81,25 @@ 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) @@ -107,7 +107,7 @@ public EAndroidFileDownloaderVerdict beginDownload( setState(EAndroidFileDownloaderState.ERROR); fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, ex.getMessage()); - return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; + return EAndroidFileDownloaderVerdict.FAILED__ERROR_UPON_COMMENCING; } return EAndroidFileDownloaderVerdict.SUCCESS; diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileDownloaderVerdict.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileDownloaderVerdict.java index 69256fa3..423e388a 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileDownloaderVerdict.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/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/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFileDownloadingInitializationVerdict.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFileDownloadingInitializationVerdict.swift index 422a03d4..1f2a2013 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFileDownloadingInitializationVerdict.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.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/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift index 49555c18..cc207b47 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift +++ b/Laerdal.McuMgr.Bindings.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 index dc19ba9b..6be5ff28 100644 --- 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 index fd7bfcfe..67406846 100644 --- 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, } } \ No newline at end of file diff --git a/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs index 0ae35b87..f7e2bc46 100644 --- 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) { From 303842801a606f4b329a1b316cf3701f37c48f38 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 4 Oct 2024 15:38:47 +0200 Subject: [PATCH 032/104] feat (github-actions.yml): we now target dotnet-workload version 8.0.402 the dotnet-workload-version is now an environment variable clearly visible at the top of the github actions file --- .github/workflows/github-actions.yml | 3 ++ .../Laerdal.SetupBuildEnvironment.sh | 39 ++++++++++++------- README.md | 6 +++ 3 files changed, 33 insertions(+), 15 deletions(-) diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml index 84bd508e..57842376 100644 --- a/.github/workflows/github-actions.yml +++ b/.github/workflows/github-actions.yml @@ -20,6 +20,8 @@ env: SCL_DEPENDENCY_TRACKER_SERVER_URL: ${{ secrets.SCL_DEPENDENCY_TRACKER_SERVER_URL }} SCL_DEPENDENCY_TRACKER_SIGNING_PRIVATE_KEY: ${{ secrets.SCL_DEPENDENCY_TRACKER_SIGNING_PRIVATE_KEY }} + DOTNET_TARGET_WORKLOAD_VERSION: "8.0.402" # dont upgrade this lightheartedly the workload snapshot implicitly defines which versions of Android/iOS/MacCatalyst SDKs are supported + BINDINGS_ANDROID___DOTNET_TARGET_PLATFORM_VERSION: "34" BINDINGS_IOS___SDK_VERSION: "17.5" @@ -68,6 +70,7 @@ jobs: chmod +x "${{env.BUILD_REPOSITORY_FOLDERPATH}}/Laerdal.Scripts/Laerdal.SetupBuildEnvironment.sh" \ && \ "${{env.BUILD_REPOSITORY_FOLDERPATH}}/Laerdal.Scripts/Laerdal.SetupBuildEnvironment.sh" \ + "${{env.DOTNET_TARGET_WORKLOAD_VERSION}}" \ "https://nuget.pkg.github.com/Laerdal/index.json" \ "${{env.SCL_GITHUB_NUGET_FEED_USERNAME}}" \ "${{env.SCL_GITHUB_ACCESS_TOKEN}}" \ diff --git a/Laerdal.Scripts/Laerdal.SetupBuildEnvironment.sh b/Laerdal.Scripts/Laerdal.SetupBuildEnvironment.sh index f13bc881..f58c4c34 100644 --- a/Laerdal.Scripts/Laerdal.SetupBuildEnvironment.sh +++ b/Laerdal.Scripts/Laerdal.SetupBuildEnvironment.sh @@ -1,29 +1,36 @@ #!/bin/bash -declare -r NUGET_FEED_URL="$1" -declare -r NUGET_FEED_USERNAME="$2" -declare -r NUGET_FEED_ACCESSTOKEN="$3" +declare -r DOTNET_TARGET_WORKLOAD_VERSION="$1" -declare -r ARTIFACTS_FOLDER_PATH="$4" +declare -r NUGET_FEED_URL="$2" +declare -r NUGET_FEED_USERNAME="$3" +declare -r NUGET_FEED_ACCESSTOKEN="$4" + +declare -r ARTIFACTS_FOLDER_PATH="$5" + +if [ -z "${DOTNET_TARGET_WORKLOAD_VERSION}" ]; then + echo "##vso[task.logissue type=error]Missing 'DOTNET_TARGET_WORKLOAD_VERSION' which was expected to be parameter #1." + exit 1 +fi if [ -z "${NUGET_FEED_URL}" ]; then - echo "##vso[task.logissue type=error]Missing 'NUGET_FEED_URL' which was expected to be parameter #1." - exit 3 + echo "##vso[task.logissue type=error]Missing 'NUGET_FEED_URL' which was expected to be parameter #2." + exit 2 fi if [ -z "${NUGET_FEED_USERNAME}" ]; then - echo "##vso[task.logissue type=error]Missing 'NUGET_FEED_USERNAME' which was expected to be parameter #2." - exit 5 + echo "##vso[task.logissue type=error]Missing 'NUGET_FEED_USERNAME' which was expected to be parameter #3." + exit 3 fi if [ -z "${NUGET_FEED_ACCESSTOKEN}" ]; then - echo "##vso[task.logissue type=error]Missing 'NUGET_FEED_ACCESSTOKEN' which was expected to be parameter #3." - exit 6 + echo "##vso[task.logissue type=error]Missing 'NUGET_FEED_ACCESSTOKEN' which was expected to be parameter #4." + exit 4 fi if [ -z "${ARTIFACTS_FOLDER_PATH}" ]; then - echo "##vso[task.logissue type=error]Missing 'ARTIFACTS_FOLDER_PATH' which was expected to be parameter #4." - exit 7 + echo "##vso[task.logissue type=error]Missing 'ARTIFACTS_FOLDER_PATH' which was expected to be parameter #5." + exit 5 fi brew install --cask objectivesharpie @@ -74,8 +81,8 @@ fi # we do our best to explicitly version-pin our workloads so as to preemptively avoid problems that # would be bound to crop up sooner or later by blindly auto-upgrading to bleeding-edge workloads # -# todo unfortunately issuing a 'dotnet workload restore' on the root folder doesnt work as intended -# todo on the azure pipelines and we need to figure out why +# also note that issuing a 'dotnet workload restore' doesnt work reliably and this is why resorted +# to being so explicit about the workloads we need # sudo dotnet \ workload \ @@ -83,9 +90,11 @@ sudo dotnet \ ios \ android \ maccatalyst \ + maui \ maui-ios \ + maui-tizen \ maui-android \ - maui-maccatalyst + maui-maccatalyst --version "${DOTNET_TARGET_WORKLOAD_VERSION}" declare exitCode=$? if [ $exitCode != 0 ]; then echo "##vso[task.logissue type=error]Failed to restore dotnet workloads." diff --git a/README.md b/README.md index 479bd4f3..6a2ef85a 100644 --- a/README.md +++ b/README.md @@ -690,6 +690,8 @@ git clone git@github.com:Laerdal-Medical/Laerdal.McuMgr.git --branch deve ```bash # cd into the root folder of the repo +WORKLOAD_VERSION=8.0.402 \ +&& \ sudo dotnet \ workload \ install \ @@ -701,12 +703,14 @@ sudo dotnet \ maui-tizen \ maui-android \ maui-maccatalyst \ + --version "${WORKLOAD_VERSION}" \ && \ cd "Laerdal.McuMgr.Bindings.iOS" \ && \ sudo dotnet \ workload \ restore \ + --version "${WORKLOAD_VERSION}" \ && \ cd - \ && \ @@ -715,6 +719,7 @@ cd "Laerdal.McuMgr.Bindings.MacCatalyst" \ sudo dotnet \ workload \ restore \ + --version "${WORKLOAD_VERSION}" \ && \ cd - \ && \ @@ -723,6 +728,7 @@ cd "Laerdal.McuMgr.Bindings.Android" \ sudo dotnet \ workload \ restore \ + --version "${WORKLOAD_VERSION}" \ && \ cd - From ea8a57ada6728aa6663c6d215b95be53c20cae6f Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 4 Oct 2024 15:44:03 +0200 Subject: [PATCH 033/104] feat (build.gradle): we now build the laerdal-nordic "glue java-lib" against Android SDK 34 (old was: 33) we are doing this to keep the glue-libs aligned with the Android SDK that the C# libs are targeting to play it as safe as possible --- .../mcumgr-laerdal-wrapper/build.gradle | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/build.gradle b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/build.gradle index 1243cea6..4be60049 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/build.gradle +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/build.gradle @@ -7,11 +7,11 @@ tasks.register('wrapper', Wrapper) { } android { - compileSdk 33 + compileSdk 34 // its best to keep this always aligned with the in the .csproj file and with BINDINGS_ANDROID___DOTNET_TARGET_PLATFORM_VERSION at the top of the github actions .yml file defaultConfig { minSdk 21 - targetSdk 33 + targetSdk 34 // its best to keep this always aligned with the in the .csproj file and with BINDINGS_ANDROID___DOTNET_TARGET_PLATFORM_VERSION at the top of the github actions .yml file consumerProguardFiles "consumer-rules.pro" testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" From 42eff6b3044e402b2e28745fd313c01c210827ff Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 4 Oct 2024 15:45:47 +0200 Subject: [PATCH 034/104] perf (Laerdal.Builder.targets, Laerdal.McuMgr.Bindings.Android.NativeBuilder.targets): optimize the build logging so that the .jar libs will be downloaded and compiled into our "glue .aar" only once old was: we were performing this twice in our pipeline which was more error-prone and slower --- ....McuMgr.Bindings.Android.NativeBuilder.targets | 10 +++++++--- Laerdal.Scripts/Laerdal.Builder.targets | 15 +++++++-------- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NativeBuilder.targets b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NativeBuilder.targets index b60f2e6e..d467da65 100644 --- a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NativeBuilder.targets +++ b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NativeBuilder.targets @@ -15,7 +15,10 @@ - + @@ -83,8 +86,9 @@ - - + diff --git a/Laerdal.Scripts/Laerdal.Builder.targets b/Laerdal.Scripts/Laerdal.Builder.targets index 4826dd6a..e9ab547b 100644 --- a/Laerdal.Scripts/Laerdal.Builder.targets +++ b/Laerdal.Scripts/Laerdal.Builder.targets @@ -16,7 +16,7 @@ - + @@ -35,8 +35,9 @@ %0A - Release - true + Release + false + false $(MSBuildThisFileDirectory) @@ -57,8 +58,6 @@ true true - false - @@ -240,9 +239,9 @@ - + + Properties="$(_Laerdal_Build_Parameters);Laerdal_Bindings_Android___DotnetTargetPlatformVersion=$(Laerdal_Bindings_Android___DotnetTargetPlatformVersion);BuildingProject=true;Skip_CompileMcuMgrLaerdalWrapper=true;SourceRoot=$(Laerdal_RootDirectory_Folderpath)/Laerdal.McuMgr.Bindings.Android/;" Targets="Build"/> @@ -264,7 +263,7 @@ Date: Fri, 4 Oct 2024 17:08:43 +0200 Subject: [PATCH 035/104] clean (Laerdal.McuMgr.csproj): trivial neutral cleanups [skip ci] --- Laerdal.McuMgr/Laerdal.McuMgr.csproj | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/Laerdal.McuMgr/Laerdal.McuMgr.csproj b/Laerdal.McuMgr/Laerdal.McuMgr.csproj index 083783c8..62ccbc65 100644 --- a/Laerdal.McuMgr/Laerdal.McuMgr.csproj +++ b/Laerdal.McuMgr/Laerdal.McuMgr.csproj @@ -43,9 +43,9 @@ $(Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion) 17.0 - 11.0 - 21 - 13.1 + 11.0 + 21 + 13.1 Library bin\ @@ -71,10 +71,10 @@ $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb - 1.0.1168.0 - 1.0.1168.0 - 1.0.1168.0 - 1.0.1168.0 + 1.0.1079.0 + 1.0.1079.0 + 1.0.1079.0 + 1.0.1079.0 $(PackageId) $(Authors) @@ -168,21 +168,21 @@ - + - + - + - + From f4e0e620a0695de65947764924287e566947f262 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 8 Oct 2024 17:41:03 +0200 Subject: [PATCH 036/104] doc (github-actions.yml): trivial comments [skip ci] --- .github/workflows/github-actions.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml index 57842376..355f1a70 100644 --- a/.github/workflows/github-actions.yml +++ b/.github/workflows/github-actions.yml @@ -22,15 +22,15 @@ env: DOTNET_TARGET_WORKLOAD_VERSION: "8.0.402" # dont upgrade this lightheartedly the workload snapshot implicitly defines which versions of Android/iOS/MacCatalyst SDKs are supported - BINDINGS_ANDROID___DOTNET_TARGET_PLATFORM_VERSION: "34" + BINDINGS_ANDROID___DOTNET_TARGET_PLATFORM_VERSION: "34" # for the csproj file - BINDINGS_IOS___SDK_VERSION: "17.5" - BINDINGS_IOS___XCODE_IDE_DEV_PATH: "/Applications/Xcode_15.4.app/Contents/Developer" - BINDINGS_IOS___DOTNET_TARGET_PLATFORM_VERSION: "17.0" + BINDINGS_IOS___SDK_VERSION: "17.5" # for xcodebuild + BINDINGS_IOS___XCODE_IDE_DEV_PATH: "/Applications/Xcode_15.4.app/Contents/Developer" # for xcodebuild + BINDINGS_IOS___DOTNET_TARGET_PLATFORM_VERSION: "17.0" # for the csproj file - BINDINGS_MACCATALYST___SDK_VERSION: "14.5" - BINDINGS_MACCATALYST___XCODE_IDE_DEV_PATH: "/Applications/Xcode_15.4.app/Contents/Developer" - BINDINGS_MACCATALYST___DOTNET_TARGET_PLATFORM_VERSION: "17.0" + BINDINGS_MACCATALYST___SDK_VERSION: "14.5" # for xcodebuild + BINDINGS_MACCATALYST___XCODE_IDE_DEV_PATH: "/Applications/Xcode_15.4.app/Contents/Developer" # for xcodebuild + BINDINGS_MACCATALYST___DOTNET_TARGET_PLATFORM_VERSION: "17.0" # for the csproj file on: workflow_call: # so that other workflows can trigger this From f8803c089b989414a3f2bb14217e0328d8c4b42a Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 14 Oct 2024 15:31:59 +0200 Subject: [PATCH 037/104] clean (RemoteFilePathHelpers.cs): trivial neutral cleanups --- .../Shared/Common/Helpers/RemoteFilePathHelpers.cs | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/Laerdal.McuMgr/Shared/Common/Helpers/RemoteFilePathHelpers.cs b/Laerdal.McuMgr/Shared/Common/Helpers/RemoteFilePathHelpers.cs index 5e0b8ab2..e3febf1b 100644 --- a/Laerdal.McuMgr/Shared/Common/Helpers/RemoteFilePathHelpers.cs +++ b/Laerdal.McuMgr/Shared/Common/Helpers/RemoteFilePathHelpers.cs @@ -13,13 +13,17 @@ static public void ValidateRemoteFilePathsWithDataBytes(IDictionary(T payloadForUploading) + { + if (payloadForUploading == null) + throw new ArgumentException("Bytes set to null!"); + } + static internal void ValidateRemoteFilePaths(IEnumerable remoteFilePaths) { remoteFilePaths = remoteFilePaths ?? throw new ArgumentNullException(nameof(remoteFilePaths)); @@ -36,7 +40,7 @@ static internal void ValidateRemoteFilePath(string remoteFilePath) throw new ArgumentException($"The {nameof(remoteFilePath)} parameter is dud!"); remoteFilePath = remoteFilePath.Trim(); //order - if (remoteFilePath.EndsWith("/")) //00 + if (remoteFilePath.EndsWith('/')) //00 throw new ArgumentException($"The given {nameof(remoteFilePath)} points to a directory not a file!"); if (remoteFilePath.Contains('\r') || remoteFilePath.Contains('\n') || remoteFilePath.Contains('\f')) //order From b0061e0d5e1f20b3110034d9cdd8d66c46c2dd66 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 14 Oct 2024 20:13:07 +0200 Subject: [PATCH 038/104] feat (AndroidFileUploader.java): we now call resetUploadState() before ensureTransportIsInitializedExactlyOnce() to fix a potential bug which could cause calls to trySetBluetoothDevice() inside the StateChanged=idle event-handler (in the calling environment) to not have the desired effect on the connection --- .../no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index f0bdf137..9f5ad7db 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -151,6 +151,7 @@ public EAndroidFileUploaderVerdict beginUpload( return EAndroidFileUploaderVerdict.FAILED__INVALID_DATA; } + resetUploadState(); //order must be called before ensureTransportIsInitializedExactlyOnce() because the environment might try to set the device via trySetBluetoothDevice()!!! ensureTransportIsInitializedExactlyOnce(initialMtuSize); //order final EAndroidFileUploaderVerdict verdict = ensureFilesystemManagerIsInitializedExactlyOnce(); //order @@ -159,7 +160,6 @@ public EAndroidFileUploaderVerdict beginUpload( ensureFileUploaderCallbackProxyIsInitializedExactlyOnce(); //order - resetUploadState(); //order setLoggingEnabled(false); try From 8b9ed5133d7d14c45d3e36be3deb74929e1d4bfb Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 14 Oct 2024 21:26:18 +0200 Subject: [PATCH 039/104] fix (FileUploader.TrySetBluetoothDevice()): fix a bug which was causing the method to try and set the context instead of the bluetooth device --- Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index 4a350130..d231fb91 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -40,7 +40,7 @@ public void Dispose() } public bool TrySetContext(object context) => _nativeFileUploaderProxy?.TrySetContext(context) ?? false; - public bool TrySetBluetoothDevice(object bluetoothDevice) => _nativeFileUploaderProxy?.TrySetContext(bluetoothDevice) ?? false; + public bool TrySetBluetoothDevice(object bluetoothDevice) => _nativeFileUploaderProxy?.TrySetBluetoothDevice(bluetoothDevice) ?? false; public bool TryInvalidateCachedTransport() => _nativeFileUploaderProxy?.TryInvalidateCachedTransport() ?? false; public EFileUploaderVerdict BeginUpload( From 31a54c6d44ef0a1b2f11e2109c9cb8e1c6272135 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 15 Oct 2024 15:26:11 +0200 Subject: [PATCH 040/104] clean: trivial neutral comment-cleanups --- Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index d231fb91..320c1645 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -375,7 +375,7 @@ void FileUploader_StateChanged_(object _, StateChangedEventArgs ea_) switch (ea_.NewState) { case EFileUploaderState.Idle: - fileUploadProgressEventsCount = 0; //its vital to reset the counter here to account for retries + fileUploadProgressEventsCount = 0; //it is vital to reset the counter here to account for retries return; case EFileUploaderState.Complete: From 7c4565089e3b69bbee538024bcccb61055f70c36 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 15 Oct 2024 15:54:13 +0200 Subject: [PATCH 041/104] refa (AndroidFileUploader.ensureTransportIsInitializedExactlyOnce()): emit a log entry whenever we (re)initialize the transport used for the file-transfers --- .../no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 9f5ad7db..46e5fefc 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -202,6 +202,8 @@ private void ensureTransportIsInitializedExactlyOnce(int initialMtuSize) if (_transport != null) return; + logMessageAdvertisement(_remoteFilePathSanitized, "[AFU.ETIIEO.010] (Re)Initializing transport: initial-mtu-size=" + initialMtuSize, "FileUploader", "TRACE"); + _transport = new McuMgrBleTransport(_context, _bluetoothDevice); if (initialMtuSize > 0) From 9a09d9d47cc11b94ec3bfa6006e5b37e505542ee Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 15 Oct 2024 15:55:43 +0200 Subject: [PATCH 042/104] refa (AndroidFileUploader.ensureFilesystemManagerIsInitializedExactlyOnce()): emit a log entry whenever we (re)initialize the filesystem-manager used for the file-transfers --- .../no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 46e5fefc..6134875a 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -223,6 +223,8 @@ private EAndroidFileUploaderVerdict ensureFilesystemManagerIsInitializedExactlyO if (_fileSystemManager != null) //already initialized return EAndroidFileUploaderVerdict.SUCCESS; + logMessageAdvertisement(_remoteFilePathSanitized, "[AFU.EFMIIEO.010] (Re)Initializing filesystem-manager", "FileUploader", "TRACE"); + try { _fileSystemManager = new FsManager(_transport); //order From eeb24415e43e24579019d940aa650fc7654868d1 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 15 Oct 2024 15:56:31 +0200 Subject: [PATCH 043/104] clean (HelpersAndroid.cs): trivial neutral refactoring [skip ci] --- Laerdal.McuMgr/Droid/Common/HelpersAndroid.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Laerdal.McuMgr/Droid/Common/HelpersAndroid.cs b/Laerdal.McuMgr/Droid/Common/HelpersAndroid.cs index 7b9945d8..630cc7cd 100644 --- a/Laerdal.McuMgr/Droid/Common/HelpersAndroid.cs +++ b/Laerdal.McuMgr/Droid/Common/HelpersAndroid.cs @@ -10,9 +10,9 @@ static internal class HelpersAndroid "DEBUG" => ELogLevel.Debug, "TRACE" => ELogLevel.Verbose, "INFO" => ELogLevel.Info, - "FATAL" => ELogLevel.Error, "WARN" => ELogLevel.Warning, "ERROR" => ELogLevel.Error, + "FATAL" => ELogLevel.Error, _ => throw new ArgumentOutOfRangeException(nameof(level), level, "Unknown log-level value") }; } From 80ba0effc5a9234c7b4f34daa16dafb247f80b6f Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 15 Oct 2024 16:10:07 +0200 Subject: [PATCH 044/104] refa (AndroidFileUploader.tryInvalidateCachedTransport()): it now also disposes the callback proxy as well (just to be safe) --- .../laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 6134875a..e05e3b03 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -74,6 +74,7 @@ public boolean tryInvalidateCachedTransport() disposeFilesystemManager(); // order disposeTransport(); // order + disposeCallbackProxy(); // order return true; } @@ -329,6 +330,11 @@ private void disposeFilesystemManager() _fileSystemManager = null; } + private void disposeCallbackProxy() + { + _fileUploaderCallbackProxy = null; + } + private void setLoggingEnabled(final boolean enabled) { final McuMgrTransport mcuMgrTransporter = _fileSystemManager.getTransporter(); From 023e160cb506d0b419cb9afaece1b6632f8a198a Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 15 Oct 2024 17:45:47 +0200 Subject: [PATCH 045/104] fix (AndroidFileUploader.java): fix the order of the parameters of logMessageAdvertisement() so that it will be the one that the C# world expects when intercepting the call to this method --- .../mcumgr_laerdal_wrapper/AndroidDeviceResetter.java | 8 ++++---- .../mcumgr_laerdal_wrapper/AndroidFileUploader.java | 6 +++--- .../mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java | 6 +++--- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java index c6d8e867..9713ea59 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java @@ -81,7 +81,7 @@ public EAndroidDeviceResetterState getState() { } private EAndroidDeviceResetterState _currentState = EAndroidDeviceResetterState.NONE; - private void setState(EAndroidDeviceResetterState newState) { + private void setState(final EAndroidDeviceResetterState newState) { final EAndroidDeviceResetterState oldState = _currentState; //order _currentState = newState; //order @@ -99,15 +99,15 @@ public String getLastFatalErrorMessage() { return _lastFatalErrorMessage; } - public void fatalErrorOccurredAdvertisement(String errorMessage) { + public void fatalErrorOccurredAdvertisement(final String errorMessage) { _lastFatalErrorMessage = errorMessage; //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } - public void logMessageAdvertisement(String message, String category, String level) { + public void logMessageAdvertisement(final String message, final String category, final String level) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } - public void stateChangedAdvertisement(EAndroidDeviceResetterState oldState, EAndroidDeviceResetterState currentState) { + public void stateChangedAdvertisement(final EAndroidDeviceResetterState oldState, final EAndroidDeviceResetterState currentState) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index e05e3b03..6796a20a 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -203,7 +203,7 @@ private void ensureTransportIsInitializedExactlyOnce(int initialMtuSize) if (_transport != null) return; - logMessageAdvertisement(_remoteFilePathSanitized, "[AFU.ETIIEO.010] (Re)Initializing transport: initial-mtu-size=" + initialMtuSize, "FileUploader", "TRACE"); + logMessageAdvertisement("[AFU.ETIIEO.010] (Re)Initializing transport: initial-mtu-size=" + initialMtuSize, "FileUploader", "TRACE", _remoteFilePathSanitized); _transport = new McuMgrBleTransport(_context, _bluetoothDevice); @@ -224,7 +224,7 @@ private EAndroidFileUploaderVerdict ensureFilesystemManagerIsInitializedExactlyO if (_fileSystemManager != null) //already initialized return EAndroidFileUploaderVerdict.SUCCESS; - logMessageAdvertisement(_remoteFilePathSanitized, "[AFU.EFMIIEO.010] (Re)Initializing filesystem-manager", "FileUploader", "TRACE"); + logMessageAdvertisement("[AFU.EFMIIEO.010] (Re)Initializing filesystem-manager", "FileUploader", "TRACE", _remoteFilePathSanitized); try { @@ -432,7 +432,7 @@ public void fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(fi //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } - public void logMessageAdvertisement(final String remoteFilePath, final String message, final String category, final String level) + public void logMessageAdvertisement(final String message, final String category, final String level, final String resource) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java index 10f7336e..1f713b4e 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java @@ -89,15 +89,15 @@ public String getLastFatalErrorMessage() { return _lastFatalErrorMessage; } - public void fatalErrorOccurredAdvertisement(String errorMessage) { + public void fatalErrorOccurredAdvertisement(final String errorMessage) { _lastFatalErrorMessage = errorMessage; //this method is meant to be overridden by csharp binding libraries to intercept updates } - public void logMessageAdvertisement(String message, String category, String level) { + public void logMessageAdvertisement(final String message, final String category, final String level) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } - public void busyStateChangedAdvertisement(boolean busyNotIdle) { + public void busyStateChangedAdvertisement(final boolean busyNotIdle) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } From 7e67db01e4019fd4a9865536f3ad41480f48a27c Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 15 Oct 2024 18:43:08 +0200 Subject: [PATCH 046/104] feat (AndroidFileUploader.java): add new logging statements [skip ci] --- .../no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 6796a20a..0bb1fe77 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -61,6 +61,9 @@ public boolean trySetBluetoothDevice(@NonNull final BluetoothDevice bluetoothDev return false; _bluetoothDevice = bluetoothDevice; //order + + logMessageAdvertisement("[AFU.TSBD.010] Native Bluetooth-Device set to a new instance", "FileUploader", "TRACE", _remoteFilePathSanitized); + return true; } From 793671e74638d2aec8a2737e664a3839753a2fa1 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 15 Oct 2024 21:30:38 +0200 Subject: [PATCH 047/104] fix (AndroidFileUploader.java): fix a bug in trySetBluetoothDevice() which was causing it to refuse the call when state=idle --- .../AndroidFileUploader.java | 20 ++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 0bb1fe77..3083ae7d 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -42,7 +42,7 @@ public AndroidFileUploader(@NonNull final Context context, @NonNull final Blueto public boolean trySetContext(@NonNull final Context context) { - if (!IsCold()) + if (!IsIdleOrCold()) return false; if (!tryInvalidateCachedTransport()) //order @@ -54,11 +54,19 @@ public boolean trySetContext(@NonNull final Context context) public boolean trySetBluetoothDevice(@NonNull final BluetoothDevice bluetoothDevice) { - if (!IsCold()) + logMessageAdvertisement("[AFU.TSBD.000] trySetBluetoothDevice() called", "FileUploader", "TRACE", _remoteFilePathSanitized); + + if (!IsIdleOrCold()) { + logMessageAdvertisement("[AFU.TSBD.005] trySetBluetoothDevice() cannot proceed because the uploader is not cold", "FileUploader", "TRACE", _remoteFilePathSanitized); return false; + } + logMessageAdvertisement("[AFU.TSBD.010]", "FileUploader", "TRACE", _remoteFilePathSanitized); if (!tryInvalidateCachedTransport()) //order + { + logMessageAdvertisement("[AFU.TSBD.020]", "FileUploader", "TRACE", _remoteFilePathSanitized); return false; + } _bluetoothDevice = bluetoothDevice; //order @@ -72,7 +80,7 @@ public boolean tryInvalidateCachedTransport() if (_transport == null) //already scrapped return true; - if (!IsCold()) //if the upload is already in progress we bail out + if (!IsIdleOrCold()) //if the upload is already in progress we bail out return false; disposeFilesystemManager(); // order @@ -363,6 +371,12 @@ private void setState(final EAndroidFileUploaderState newState) //00 trivial hotfix to deal with the fact that the file-upload progress% doesn't fill up to 100% } + @Contract(pure = true) + private boolean IsIdleOrCold() + { + return _currentState == EAndroidFileUploaderState.IDLE || IsCold(); + } + @Contract(pure = true) private boolean IsCold() { From b2b5fd808091c8a9c228eb3e4d3379fa2bf9f427 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 18 Oct 2024 13:18:12 +0200 Subject: [PATCH 048/104] feat (EMcuMgrErrorCode.cs): add new error codes Generic, ProtocolVersionTooOld and ProtocolVersionTooNew --- .../Shared/Common/Enums/EMcuMgrErrorCode.cs | 31 ++++++++++--------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs b/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs index 2edb0638..2e5c5374 100644 --- a/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs +++ b/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs @@ -2,19 +2,22 @@ namespace Laerdal.McuMgr.Common.Enums { public enum EMcuMgrErrorCode // must mirror io.runtime.mcumgr.McuMgrErrorCode @formatter:off { - Unset = -99, //this is our own to mark that we haven't received any error code from the device - Ok = 000, - Unknown = 001, //when uploading files to the device this error code means that the target file-path has one or more non-existent directories in it - NoMemory = 002, - InValue = 003, - Timeout = 004, - NoEntry = 005, - BadState = 006, - TooLarge = 007, - NotSupported = 008, - Corrupt = 009, - Busy = 010, - AccessDenied = 011, - PerUser = 256, + Unset = -99, //this is our own to mark that we haven't received any error code from the device + Generic = -1, //in case the underlying native code receives an exception other than io.runtime.mcumgr.exception.McuMgrErrorException + Ok = 000, + Unknown = 001, //when uploading files to the device this error code means that the target file-path has one or more non-existent directories in it + NoMemory = 002, + InValue = 003, + Timeout = 004, + NoEntry = 005, + BadState = 006, + TooLarge = 007, + NotSupported = 008, + Corrupt = 009, + Busy = 010, + AccessDenied = 011, + ProtocolVersionTooOld = 012, + ProtocolVersionTooNew = 013, + PerUser = 256, } // @formatter:on } From 447f2c72da37c67bab40123252a4593450d45283 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 18 Oct 2024 13:20:43 +0200 Subject: [PATCH 049/104] refa (AndroidFileUploader.java): onError() now returns generic error codes '-1' (old was: returning '0' as error codes which stood for 'ok' thus looking weird in the logs) --- .../mcumgr_laerdal_wrapper/AndroidFileUploader.java | 2 +- Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 3083ae7d..fd9f4737 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -401,7 +401,7 @@ public void onError( { if (!(exception instanceof McuMgrErrorException)) { - fatalErrorOccurredAdvertisement(remoteFilePath, errorMessage, 0, 0); + fatalErrorOccurredAdvertisement(remoteFilePath, errorMessage, -1, -1); return; } diff --git a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs index 32b8591c..2c8a872f 100644 --- a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs @@ -91,12 +91,12 @@ private void CleanupInfrastructure() // ignored } } - + public void CleanupResourcesOfLastUpload() { //nothing to do in android } - + #region commands public EFileUploaderVerdict BeginUpload( @@ -138,7 +138,7 @@ public bool TrySetBluetoothDevice(object bluetoothDevice) } #endregion commands - + #region android callbacks -> csharp event emitters @@ -149,7 +149,7 @@ public override void FatalErrorOccurredAdvertisement(string resource, string err FatalErrorOccurredAdvertisement(resource, errorMessage, (EMcuMgrErrorCode) mcuMgrErrorCode, (EFileUploaderGroupReturnCode) fileUploaderGroupReturnCode); } - + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileUploaderGroupReturnCode fileUploaderGroupReturnCode) { _fileUploaderCallbacksProxy?.FatalErrorOccurredAdvertisement( From 9774f5866ad6b8d0b48eb76b7b3cb3ed55a423a3 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 18 Oct 2024 14:04:38 +0200 Subject: [PATCH 050/104] refa (FileUploader.cs): trivial neutral refactoring to simplify FileUploader_FatalErrorOccurred_() by employing a simple switch-expression (old was: if-conditions) --- .../Shared/FileUploader/FileUploader.cs | 33 +++++++------------ 1 file changed, 12 insertions(+), 21 deletions(-) diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index 320c1645..fadf4238 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -418,36 +418,27 @@ void FileUploader_FileUploadProgressPercentageAndDataThroughputChanged_(object s void FileUploader_FatalErrorOccurred_(object sender, FatalErrorOccurredEventArgs ea) { - var isAboutUnauthorized = ea.ErrorCode == EMcuMgrErrorCode.AccessDenied; - if (isAboutUnauthorized) + taskCompletionSource.TrySetException(ea.ErrorCode switch { - taskCompletionSource.TrySetException(new UploadUnauthorizedException( //specific case + EMcuMgrErrorCode.Unknown => new UploadErroredOutRemoteFolderNotFoundException( //specific case remoteFilePath: remoteFilePath, mcuMgrErrorCode: ea.ErrorCode, groupReturnCode: ea.GroupReturnCode, nativeErrorMessage: ea.ErrorMessage - )); - return; - } - - var isAboutFolderNotExisting = ea.ErrorCode == EMcuMgrErrorCode.Unknown; - if (isAboutFolderNotExisting) - { - taskCompletionSource.TrySetException(new UploadErroredOutRemoteFolderNotFoundException( //specific case + ), + EMcuMgrErrorCode.AccessDenied => new UploadUnauthorizedException( //specific case remoteFilePath: remoteFilePath, mcuMgrErrorCode: ea.ErrorCode, groupReturnCode: ea.GroupReturnCode, nativeErrorMessage: ea.ErrorMessage - )); - return; - } - - taskCompletionSource.TrySetException(new UploadErroredOutException( //generic - remoteFilePath: remoteFilePath, - mcuMgrErrorCode: ea.ErrorCode, - groupReturnCode: ea.GroupReturnCode, - nativeErrorMessage: ea.ErrorMessage - )); + ), + _ => new UploadErroredOutException( //generic + remoteFilePath: remoteFilePath, + mcuMgrErrorCode: ea.ErrorCode, + groupReturnCode: ea.GroupReturnCode, + nativeErrorMessage: ea.ErrorMessage + ) + }); } // ReSharper restore AccessToModifiedClosure } From ae9942e892cf9fae3ec61cfcf2f90914d2e60561 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 18 Oct 2024 14:22:04 +0200 Subject: [PATCH 051/104] clean (FileDownloader.cs, FileUploader.cs): we now increase suspiciousTransportFailuresCount if and only if we're not dealing with a show-stopper error --- .../Shared/FileDownloader/FileDownloader.cs | 10 +++++----- .../Shared/FileUploader/FileUploader.cs | 16 +++++++--------- .../FirmwareInstaller/FirmwareInstaller.cs | 6 +++--- 3 files changed, 15 insertions(+), 17 deletions(-) diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index 3d7c21b2..94e7f683 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -267,11 +267,6 @@ public async Task DownloadAsync( } catch (DownloadErroredOutException ex) { - if (fileDownloadProgressEventsCount <= 10) - { - suspiciousTransportFailuresCount++; - } - if (ex is DownloadErroredOutRemoteFileNotFoundException) //order no point to retry if the remote file is not there { //OnStateChanged(new StateChangedEventArgs(newState: EFileDownloaderState.Error)); //noneed already done in native code @@ -283,6 +278,11 @@ public async Task DownloadAsync( //OnStateChanged(new StateChangedEventArgs(newState: EFileDownloaderState.Error)); //noneed already done in native code throw new AllDownloadAttemptsFailedException(remoteFilePath, maxTriesCount, innerException: ex); } + + if (fileDownloadProgressEventsCount <= 10) + { + suspiciousTransportFailuresCount++; + } if (sleepTimeBetweenRetriesInMs > 0) //order { diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index fadf4238..00cabb74 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -314,17 +314,17 @@ public async Task UploadAsync( } catch (UploadErroredOutException ex) //errors with code in_value(3) and even UnauthorizedException happen all the time in android when multiuploading files { - if (fileUploadProgressEventsCount <= 10) - { - suspiciousTransportFailuresCount++; - } - if (ex is UploadErroredOutRemoteFolderNotFoundException) //order no point to retry if any of the remote parent folders are not there throw; if (++triesCount > maxTriesCount) //order throw new AllUploadAttemptsFailedException(remoteFilePath, maxTriesCount, innerException: ex); + if (fileUploadProgressEventsCount <= 10) + { + suspiciousTransportFailuresCount++; + } + if (sleepTimeBetweenRetriesInMs > 0) //order { await Task.Delay(sleepTimeBetweenRetriesInMs); @@ -369,8 +369,7 @@ void FileUploader_FileUploaded_(object _, FileUploadedEventArgs ea_) taskCompletionSource.TrySetResult(true); } - // ReSharper disable AccessToModifiedClosure - void FileUploader_StateChanged_(object _, StateChangedEventArgs ea_) + void FileUploader_StateChanged_(object _, StateChangedEventArgs ea_) // ReSharper disable AccessToModifiedClosure { switch (ea_.NewState) { @@ -409,7 +408,7 @@ void FileUploader_StateChanged_(object _, StateChangedEventArgs ea_) //00 we first wait to allow the cancellation to be handled by the underlying native code meaning that we should see OnCancelled() // getting called right above but if that takes too long we give the killing blow by calling OnCancelled() manually here - } + } // ReSharper restore AccessToModifiedClosure void FileUploader_FileUploadProgressPercentageAndDataThroughputChanged_(object sender, FileUploadProgressPercentageAndDataThroughputChangedEventArgs ea) { @@ -440,7 +439,6 @@ void FileUploader_FatalErrorOccurred_(object sender, FatalErrorOccurredEventArgs ) }); } - // ReSharper restore AccessToModifiedClosure } if (isCancellationRequested) //vital diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index cad24d59..bc22da01 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -234,13 +234,13 @@ public async Task InstallAsync( } catch (FirmwareInstallationUploadingStageErroredOutException ex) //we only want to retry if the errors are related to the upload part of the process { + if (++triesCount > maxTriesCount) //order + throw new AllFirmwareInstallationAttemptsFailedException(maxTriesCount, innerException: ex); + if (_fileUploadProgressEventsCount <= 10) { suspiciousTransportFailuresCount++; } - - if (++triesCount > maxTriesCount) //order - throw new AllFirmwareInstallationAttemptsFailedException(maxTriesCount, innerException: ex); if (sleepTimeBetweenRetriesInMs > 0) //order { From 304492e3c46edd8e981dec9e0dc5a82395aa73f7 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 18 Oct 2024 16:32:31 +0200 Subject: [PATCH 052/104] refa (AndroidFileUploader.java, IOSFileUploader.swift): we now support setting a reason for the cancellation in the same context we now also raise the new event 'Cancelling' --- .../AndroidFileUploader.java | 18 ++-- .../McuMgrBindingsiOS/IOSFileUploader.swift | 17 +++- .../IOSListenerForFileUploader.swift | 4 +- ...ption_GivenCancellationRequestMidflight.cs | 12 ++- .../FileUploader/FileUploaderTestbed.cs | 11 ++- .../Droid/FileUploader/FileUploader.cs | 20 ++++- .../Contracts/Events/CancelledEventArgs.cs | 6 ++ .../Contracts/Events/CancellingEventArgs.cs | 14 +++ .../Exceptions/UploadCancelledException.cs | 3 +- .../Contracts/IFileUploaderCommandable.cs | 3 +- .../Contracts/IFileUploaderEventEmittable.cs | 1 + .../INativeFileUploaderCallbacksProxy.cs | 4 +- .../INativeFileUploaderCommandableProxy.cs | 2 +- .../Shared/FileUploader/FileUploader.cs | 87 ++++++++++++------- .../iOS/FileUploader/FileUploader.cs | 11 ++- 15 files changed, 151 insertions(+), 62 deletions(-) create mode 100644 Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/CancellingEventArgs.cs diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index fd9f4737..3a4420c6 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -292,11 +292,14 @@ public void disconnect() { mcuMgrTransporter.release(); } - public void cancel() + private String _cancellationReason = ""; + public void cancel(final String reason) { - setState(EAndroidFileUploaderState.CANCELLING); //order + _cancellationReason = reason; - final TransferController transferController = _uploadController; + cancellingAdvertisement(reason); //order + setState(EAndroidFileUploaderState.CANCELLING); //order + final TransferController transferController = _uploadController; //order if (transferController == null) return; @@ -434,7 +437,12 @@ public void fileUploadedAdvertisement(final String remoteFilePath) //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } - public void cancelledAdvertisement() + public void cancellingAdvertisement(final String reason) + { + //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates + } + + public void cancelledAdvertisement(final String reason) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } @@ -501,7 +509,7 @@ public void onUploadCanceled() { fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); setState(EAndroidFileUploaderState.CANCELLED); - cancelledAdvertisement(); + cancelledAdvertisement(_cancellationReason); setLoggingEnabled(true); busyStateChangedAdvertisement(false); diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift index 0decc5c4..cf710bb9 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift @@ -9,6 +9,7 @@ public class IOSFileUploader: NSObject { private var _cbPeripheral: CBPeripheral! private var _currentState: EIOSFileUploaderState = .none private var _fileSystemManager: FileSystemManager! + private var _cancellationReason: String = "" private var _lastFatalErrorMessage: String = "" private var _remoteFilePathSanitized: String! @@ -186,7 +187,10 @@ public class IOSFileUploader: NSObject { } @objc - public func cancel() { + public func cancel(_ reason: String) { + _cancellationReason = reason + + cancellingAdvertisement(reason) setState(.cancelling) //order _fileSystemManager?.cancelTransfer() //order @@ -293,8 +297,13 @@ public class IOSFileUploader: NSObject { } //@objc dont - private func cancelledAdvertisement() { - _listener.cancelledAdvertisement() + private func cancellingAdvertisement(_ reason: String) { + _listener.cancellingAdvertisement(reason) + } + + //@objc dont + private func cancelledAdvertisement(_ reason: String) { + _listener.cancelledAdvertisement(reason) } //@objc dont @@ -365,7 +374,7 @@ extension IOSFileUploader: FileUploadDelegate { setState(EIOSFileUploaderState.cancelled) busyStateChangedAdvertisement(false) fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0) - cancelledAdvertisement() + cancelledAdvertisement(_cancellationReason) } public func uploadDidFinish() { diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileUploader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileUploader.swift index cbda2471..eb126d38 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileUploader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileUploader.swift @@ -5,7 +5,9 @@ public protocol IOSListenerForFileUploader { func logMessageAdvertisement(_ message: String, _ category: String, _ level: String, _ resource: String) func fatalErrorOccurredAdvertisement(_ resource: String, _ errorMessage: String, _ errorCode: Int) - func cancelledAdvertisement() + func cancelledAdvertisement(_ reason: String) + func cancellingAdvertisement(_ reason: String) + func stateChangedAdvertisement(_ resource: String, _ oldState: EIOSFileUploaderState, _ newState: EIOSFileUploaderState) func fileUploadedAdvertisement(_ resource: String) func busyStateChangedAdvertisement(_ busyNotIdle: Bool) diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadCancelledException_GivenCancellationRequestMidflight.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadCancelledException_GivenCancellationRequestMidflight.cs index 7e989dc6..1a87b6b8 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadCancelledException_GivenCancellationRequestMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadCancelledException_GivenCancellationRequestMidflight.cs @@ -20,6 +20,7 @@ public async Task SingleFileUploadAsync_ShouldThrowUploadCancelledException_Give // Arrange var mockedFileData = new byte[] { 1, 2, 3 }; const string remoteFilePath = "/path/to/file.bin"; + const string cancellationReason = "blah blah foobar"; var mockedNativeFileUploaderProxy = new MockedGreenNativeFileUploaderProxySpy3(new GenericNativeFileUploaderCallbacksProxy_(), isCancellationLeadingToSoftLanding); var fileUploader = new McuMgr.FileUploader.FileUploader(mockedNativeFileUploaderProxy); @@ -31,7 +32,7 @@ public async Task SingleFileUploadAsync_ShouldThrowUploadCancelledException_Give { await Task.Delay(500); - fileUploader.Cancel(); + fileUploader.Cancel(reason: cancellationReason); }); var work = new Func(() => fileUploader.UploadAsync(mockedFileData, remoteFilePath)); @@ -39,6 +40,8 @@ public async Task SingleFileUploadAsync_ShouldThrowUploadCancelledException_Give await work.Should().ThrowExactlyAsync().WithTimeoutInMs((int)5.Seconds().TotalMilliseconds); mockedNativeFileUploaderProxy.CancelCalled.Should().BeTrue(); + mockedNativeFileUploaderProxy.CancellationReason.Should().Be(cancellationReason); + mockedNativeFileUploaderProxy.DisconnectCalled.Should().BeFalse(); //00 mockedNativeFileUploaderProxy.BeginUploadCalled.Should().BeTrue(); @@ -67,19 +70,20 @@ public MockedGreenNativeFileUploaderProxySpy3(INativeFileUploaderCallbacksProxy _isCancellationLeadingToSoftLanding = isCancellationLeadingToSoftLanding; } - public override void Cancel() + public override void Cancel(string reason = "") { - base.Cancel(); + base.Cancel(reason); Task.Run(async () => // under normal circumstances the native implementation will bubble up these events in this exact order { + CancellingAdvertisement(reason); // order StateChangedAdvertisement(_currentRemoteFilePath, oldState: EFileUploaderState.Idle, newState: EFileUploaderState.Cancelling); // order await Task.Delay(100); if (_isCancellationLeadingToSoftLanding) //00 { StateChangedAdvertisement(_currentRemoteFilePath, oldState: EFileUploaderState.Idle, newState: EFileUploaderState.Cancelled); // order - CancelledAdvertisement(); // order + CancelledAdvertisement(reason); // order } }); diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs index f94a2946..5a82caa9 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs @@ -14,6 +14,7 @@ public partial class FileUploaderTestbed public bool CancelCalled { get; private set; } public bool DisconnectCalled { get; private set; } public bool BeginUploadCalled { get; private set; } + public string CancellationReason { get; private set; } public string LastFatalErrorMessage => ""; @@ -43,9 +44,10 @@ public virtual EFileUploaderVerdict BeginUpload( return EFileUploaderVerdict.Success; } - public virtual void Cancel() + public virtual void Cancel(string reason = "") { CancelCalled = true; + CancellationReason = reason; } public virtual void Disconnect() @@ -53,8 +55,11 @@ public virtual void Disconnect() DisconnectCalled = true; } - public void CancelledAdvertisement() - => _uploaderCallbacksProxy.CancelledAdvertisement(); //raises the actual event + public void CancellingAdvertisement(string reason = "") + => _uploaderCallbacksProxy.CancellingAdvertisement(reason); //raises the actual event + + public void CancelledAdvertisement(string reason = "") + => _uploaderCallbacksProxy.CancelledAdvertisement(reason); //raises the actual event public void LogMessageAdvertisement(string message, string category, ELogLevel level, string resource) => _uploaderCallbacksProxy.LogMessageAdvertisement(message, category, level, resource); //raises the actual event diff --git a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs index 2c8a872f..920446f7 100644 --- a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs @@ -39,7 +39,7 @@ static private INativeFileUploaderProxy ValidateArgumentsAndConstructProxy(Bluet ); } - private sealed class AndroidFileUploaderProxy : AndroidFileUploader, INativeFileUploaderProxy + private sealed class AndroidFileUploaderProxy : AndroidFileUploader, INativeFileUploaderProxy { private readonly INativeFileUploaderCallbacksProxy _fileUploaderCallbacksProxy; @@ -117,6 +117,11 @@ public EFileUploaderVerdict BeginUpload( memoryAlignment: memoryAlignment ?? -1 )); } + + public new void Cancel(string reason = "") + { + base.Cancel(reason); + } public bool TrySetContext(object context) //the parameter must be of type 'object' so that it wont cause problems in platforms other than android { @@ -182,12 +187,19 @@ public void LogMessageAdvertisement(string message, string category, ELogLevel l resource: resource //essentially the remote filepath ); } + + public override void CancellingAdvertisement(string reason) + { + base.CancellingAdvertisement(reason); //just in case + + _fileUploaderCallbacksProxy?.CancellingAdvertisement(reason); + } - public override void CancelledAdvertisement() + public override void CancelledAdvertisement(string reason) { - base.CancelledAdvertisement(); //just in case + base.CancelledAdvertisement(reason); //just in case - _fileUploaderCallbacksProxy?.CancelledAdvertisement(); + _fileUploaderCallbacksProxy?.CancelledAdvertisement(reason); } public override void FileUploadedAdvertisement(string resource) diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/CancelledEventArgs.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/CancelledEventArgs.cs index 5a781ea0..f2a0ea58 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/CancelledEventArgs.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/CancelledEventArgs.cs @@ -7,5 +7,11 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Events { public readonly struct CancelledEventArgs : IMcuMgrEventArgs { + public string Reason { get; } + + public CancelledEventArgs(string reason) + { + Reason = reason; + } } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/CancellingEventArgs.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/CancellingEventArgs.cs new file mode 100644 index 00000000..07727532 --- /dev/null +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/CancellingEventArgs.cs @@ -0,0 +1,14 @@ +using Laerdal.McuMgr.Common.Events; + +namespace Laerdal.McuMgr.FileUploader.Contracts.Events +{ + public readonly struct CancellingEventArgs : IMcuMgrEventArgs + { + public string Reason { get; } + + public CancellingEventArgs(string reason) + { + Reason = reason; + } + } +} \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadCancelledException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadCancelledException.cs index b38e85c6..f2dbf302 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadCancelledException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadCancelledException.cs @@ -4,7 +4,8 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Exceptions { public class UploadCancelledException : Exception, IUploadException { - public UploadCancelledException() : base("Upload was cancelled") + public UploadCancelledException(string optionalReason = "") + : base($"Upload was cancelled{(string.IsNullOrWhiteSpace(optionalReason) ? "" : $": {optionalReason}")}") { } } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs index 43410b5d..cba73564 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs @@ -147,7 +147,8 @@ EFileUploaderVerdict BeginUpload( bool TrySetBluetoothDevice(object bluetoothDevice); /// Cancels the file-uploading process - void Cancel(); + /// (optional) The reason for the cancellation + void Cancel(string reason = ""); /// Disconnects the file-uploader from the targeted device void Disconnect(); diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderEventEmittable.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderEventEmittable.cs index db0135e1..db8dcb70 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderEventEmittable.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderEventEmittable.cs @@ -7,6 +7,7 @@ namespace Laerdal.McuMgr.FileUploader.Contracts internal interface IFileUploaderEventEmittable { void OnCancelled(CancelledEventArgs ea); + void OnCancelling(CancellingEventArgs ea); void OnLogEmitted(LogEmittedEventArgs ea); void OnStateChanged(StateChangedEventArgs ea); void OnFileUploaded(FileUploadedEventArgs ea); diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs index e7c1ac5a..c27bfb09 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs @@ -7,7 +7,9 @@ internal interface INativeFileUploaderCallbacksProxy { public IFileUploaderEventEmittable FileUploader { get; set; } - void CancelledAdvertisement(); + void CancelledAdvertisement(string reason = ""); + void CancellingAdvertisement(string reason = ""); + void LogMessageAdvertisement(string message, string category, ELogLevel level, string resource); void StateChangedAdvertisement(string resource, EFileUploaderState oldState, EFileUploaderState newState); void BusyStateChangedAdvertisement(bool busyNotIdle); diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCommandableProxy.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCommandableProxy.cs index 3ed2edb9..c9adf67e 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCommandableProxy.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCommandableProxy.cs @@ -4,7 +4,7 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Native { internal interface INativeFileUploaderCommandableProxy { - void Cancel(); + void Cancel(string reason = ""); void Disconnect(); EFileUploaderVerdict BeginUpload( diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index 00cabb74..c0cc64ac 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -75,11 +75,12 @@ public EFileUploaderVerdict BeginUpload( return verdict; } - public void Cancel() => _nativeFileUploaderProxy?.Cancel(); + public void Cancel(string reason = "") => _nativeFileUploaderProxy?.Cancel(reason); public void Disconnect() => _nativeFileUploaderProxy?.Disconnect(); public void CleanupResourcesOfLastUpload() => _nativeFileUploaderProxy?.CleanupResourcesOfLastUpload(); private event EventHandler _cancelled; + private event EventHandler _cancelling; private event EventHandler _logEmitted; private event EventHandler _stateChanged; private event EventHandler _fileUploaded; @@ -107,6 +108,16 @@ public event EventHandler LogEmitted remove => _logEmitted -= value; } + public event EventHandler Cancelling + { + add + { + _cancelling -= value; + _cancelling += value; + } + remove => _cancelling -= value; + } + public event EventHandler Cancelled { add @@ -249,6 +260,7 @@ public async Task UploadAsync( ? gracefulCancellationTimeoutInMs : DefaultGracefulCancellationTimeoutInMs; + var cancellationReason = ""; var isCancellationRequested = false; var fileUploadProgressEventsCount = 0; var suspiciousTransportFailuresCount = 0; @@ -259,6 +271,7 @@ public async Task UploadAsync( try { Cancelled += FileUploader_Cancelled_; + Cancelling += FileUploader_Cancelling_; FileUploaded += FileUploader_FileUploaded_; StateChanged += FileUploader_StateChanged_; FatalErrorOccurred += FileUploader_FatalErrorOccurred_; @@ -351,6 +364,7 @@ ex is not ArgumentException //10 wops probably missing native lib symbols! finally { Cancelled -= FileUploader_Cancelled_; + Cancelling -= FileUploader_Cancelling_; FileUploaded -= FileUploader_FileUploaded_; StateChanged -= FileUploader_StateChanged_; FatalErrorOccurred -= FileUploader_FatalErrorOccurred_; @@ -361,7 +375,7 @@ ex is not ArgumentException //10 wops probably missing native lib symbols! void FileUploader_Cancelled_(object _, CancelledEventArgs ea_) { - taskCompletionSource.TrySetException(new UploadCancelledException()); + taskCompletionSource.TrySetException(new UploadCancelledException(ea_.Reason)); } void FileUploader_FileUploaded_(object _, FileUploadedEventArgs ea_) @@ -369,6 +383,35 @@ void FileUploader_FileUploaded_(object _, FileUploadedEventArgs ea_) taskCompletionSource.TrySetResult(true); } + void FileUploader_Cancelling_(object _, CancellingEventArgs ea_) + { + if (isCancellationRequested) + return; + + cancellationReason = ea_.Reason; + isCancellationRequested = true; + + Task.Run(async () => + { + try + { + if (gracefulCancellationTimeoutInMs > 0) //keep this check here to avoid unnecessary task rescheduling + { + await Task.Delay(gracefulCancellationTimeoutInMs); + } + + OnCancelled(new CancelledEventArgs(ea_.Reason)); //00 + } + catch // (Exception ex) + { + // ignored + } + }); + + //00 we first wait to allow the cancellation to be handled by the underlying native code meaning that we should see OnCancelled() + // getting called right above but if that takes too long we give the killing blow by calling OnCancelled() manually here + } + void FileUploader_StateChanged_(object _, StateChangedEventArgs ea_) // ReSharper disable AccessToModifiedClosure { switch (ea_.NewState) @@ -380,34 +423,7 @@ void FileUploader_StateChanged_(object _, StateChangedEventArgs ea_) // ReSharpe case EFileUploaderState.Complete: //taskCompletionSource.TrySetResult(true); //dont we want to wait for the FileUploaded event return; - - case EFileUploaderState.Cancelling: //20 - if (isCancellationRequested) - return; - - isCancellationRequested = true; - - Task.Run(async () => - { - try - { - if (gracefulCancellationTimeoutInMs > 0) //keep this check here to avoid unnecessary task rescheduling - { - await Task.Delay(gracefulCancellationTimeoutInMs); - } - - OnCancelled(new CancelledEventArgs()); //00 - } - catch // (Exception ex) - { - // ignored - } - }); - return; } - - //00 we first wait to allow the cancellation to be handled by the underlying native code meaning that we should see OnCancelled() - // getting called right above but if that takes too long we give the killing blow by calling OnCancelled() manually here } // ReSharper restore AccessToModifiedClosure void FileUploader_FileUploadProgressPercentageAndDataThroughputChanged_(object sender, FileUploadProgressPercentageAndDataThroughputChangedEventArgs ea) @@ -442,7 +458,7 @@ void FileUploader_FatalErrorOccurred_(object sender, FatalErrorOccurredEventArgs } if (isCancellationRequested) //vital - throw new UploadCancelledException(); //20 + throw new UploadCancelledException(cancellationReason); //20 return; @@ -505,6 +521,7 @@ bool emitWarningAboutUnstableConnection_ } void IFileUploaderEventEmittable.OnCancelled(CancelledEventArgs ea) => OnCancelled(ea); + void IFileUploaderEventEmittable.OnCancelling(CancellingEventArgs ea) => OnCancelling(ea); void IFileUploaderEventEmittable.OnLogEmitted(LogEmittedEventArgs ea) => OnLogEmitted(ea); void IFileUploaderEventEmittable.OnStateChanged(StateChangedEventArgs ea) => OnStateChanged(ea); void IFileUploaderEventEmittable.OnFileUploaded(FileUploadedEventArgs ea) => OnFileUploaded(ea); @@ -513,6 +530,7 @@ bool emitWarningAboutUnstableConnection_ void IFileUploaderEventEmittable.OnFileUploadProgressPercentageAndDataThroughputChanged(FileUploadProgressPercentageAndDataThroughputChangedEventArgs ea) => OnFileUploadProgressPercentageAndDataThroughputChanged(ea); private void OnCancelled(CancelledEventArgs ea) => _cancelled?.Invoke(this, ea); + private void OnCancelling(CancellingEventArgs ea) => _cancelling?.Invoke(this, ea); private void OnLogEmitted(LogEmittedEventArgs ea) => _logEmitted?.Invoke(this, ea); private void OnFileUploaded(FileUploadedEventArgs ea) => _fileUploaded?.Invoke(this, ea); private void OnStateChanged(StateChangedEventArgs ea) => _stateChanged?.Invoke(this, ea); @@ -525,8 +543,11 @@ internal class GenericNativeFileUploaderCallbacksProxy : INativeFileUploaderCall { public IFileUploaderEventEmittable FileUploader { get; set; } - public void CancelledAdvertisement() - => FileUploader?.OnCancelled(new CancelledEventArgs()); + public void CancelledAdvertisement(string reason = "") + => FileUploader?.OnCancelled(new CancelledEventArgs(reason)); + + public void CancellingAdvertisement(string reason = "") + => FileUploader?.OnCancelling(new CancellingEventArgs(reason)); public void LogMessageAdvertisement(string message, string category, ELogLevel level, string resource) => FileUploader?.OnLogEmitted(new LogEmittedEventArgs( @@ -570,4 +591,4 @@ float averageThroughput )); } } -} \ No newline at end of file +} diff --git a/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs b/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs index 29cfc356..94de7804 100644 --- a/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs @@ -50,7 +50,7 @@ internal IOSNativeFileUploaderProxy(CBPeripheral bluetoothDevice, INativeFileUpl public string LastFatalErrorMessage => _nativeFileUploader?.LastFatalErrorMessage; - public void Cancel() => _nativeFileUploader?.Cancel(); + public void Cancel(string reason = "") => _nativeFileUploader?.Cancel(reason); public void Disconnect() => _nativeFileUploader?.Disconnect(); // public new void Dispose() { ... } dont there is no need to override the base implementation @@ -126,7 +126,7 @@ public EFileUploaderVerdict BeginUpload( nsDataOfFileToUpload.Dispose(); return verdict; } - + _nsDataOfFileInCurrentlyActiveUpload = nsDataOfFileToUpload; return EFileUploaderVerdict.Success; } @@ -160,8 +160,11 @@ public IFileUploaderEventEmittable FileUploader set => _nativeFileUploaderCallbacksProxy!.FileUploader = value; } - public override void CancelledAdvertisement() - => _nativeFileUploaderCallbacksProxy?.CancelledAdvertisement(); + public override void CancellingAdvertisement(string reason = "") + => _nativeFileUploaderCallbacksProxy?.CancellingAdvertisement(reason); + + public override void CancelledAdvertisement(string reason = "") + => _nativeFileUploaderCallbacksProxy?.CancelledAdvertisement(reason); public override void LogMessageAdvertisement(string message, string category, string level, string resource) => LogMessageAdvertisement( From c068ab8b08622d90b5bb64cb388546a9be4ee77a Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 18 Oct 2024 19:05:31 +0200 Subject: [PATCH 053/104] feat (FileUploader.cs): BeginUpload() now employs fail-safe settings for certain android models that are known to be problematic (like the Samsung A8) if the calling environment has passed in the default ('null') settings --- ...entException_GivenInvalidRemoteFilePath.cs | 8 +- ...leteSuccessfully_GivenNoFilesToDownload.cs | 6 +- ...uccessfully_GivenVariousFilesToDownload.cs | 3 + ...hCollectionWithErroneousFilesToDownload.cs | 6 +- ...ntException_GivenNullForFilesToDownload.cs | 7 +- ...ttingsRightAway_GivenProblematicDevices.cs | 188 ++++++++++++++++++ ...ToFailsafeSettings_GivenFlakyConnection.cs | 3 + ...essfully_GivenGreenNativeFileDownloader.cs | 3 + ...ldCompleteSuccessfully_GivenGreenStream.cs | 3 + ...posed_GivenBooleanAutodisposedParameter.cs | 3 + ...ailedException_GivenFatalErrorMidflight.cs | 3 + ...dException_GivenRogueNativeErrorMessage.cs | 3 + ...umentException_GivenEmptyRemoteFilePath.cs | 8 +- ...FoundException_GivenNonExistentFilepath.cs | 3 + ...ion_GivenAccessDeniedNativeErrorMessage.cs | 9 +- ...ption_GivenCancellationRequestMidflight.cs | 8 +- ...eption_GivenErroneousNativeFileUploader.cs | 8 +- ...adTimeoutException_GivenTooSmallTimeout.cs | 3 + .../Android.FailSafeBleConnectionSettings.cs | 36 ++++ .../Apple.FailSafeBleConnectionSettings.cs | 14 ++ .../Contracts/IFileUploaderCommandable.cs | 12 ++ .../Shared/FileUploader/FileUploader.cs | 102 ++++++++-- 22 files changed, 412 insertions(+), 27 deletions(-) create mode 100644 Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.BeginUpload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.BeginUpload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs index 9d861831..55c8971e 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.BeginUpload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.BeginUpload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs @@ -25,7 +25,13 @@ public void BeginUpload_ShouldThrowArgumentException_GivenInvalidRemoteFilePath( using var eventsMonitor = fileUploader.Monitor(); // Act - var work = new Func(() => fileUploader.BeginUpload(remoteFilePath, mockedFileData)); + var work = new Func(() => fileUploader.BeginUpload( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + data: mockedFileData, + remoteFilePath: remoteFilePath + )); // Assert work.Should().ThrowExactly(); diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs index 8b5e556b..1882f7a9 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs @@ -20,7 +20,11 @@ public async Task MultipleFilesUploadAsync_ShouldCompleteSuccessfully_GivenNoFil using var eventsMonitor = fileUploader.Monitor(); // Act - var work = new Func(async () => await fileUploader.UploadAsync(new Dictionary>(0))); + var work = new Func(async () => await fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + remoteFilePathsAndTheirData: new Dictionary>(0) + )); // Assert await work.Should().CompleteWithinAsync(500.Milliseconds()); diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index 580d61ef..ace574db 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -45,6 +45,9 @@ public async Task MultipleFilesUploadAsync_ShouldCompleteSuccessfully_GivenVario // Act var work = new Func>>(async () => await fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + maxTriesPerUpload: 4, remoteFilePathsAndTheirData: remoteFilePathsToTest )); diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs index 3e96bd9f..4a12f1c3 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs @@ -29,7 +29,11 @@ public async Task MultipleFilesUploadAsync_ShouldThrowArgumentException_GivenPat using var eventsMonitor = fileUploader.Monitor(); // Act - var work = new Func(async () => await fileUploader.UploadAsync(remoteFilePaths.ToDictionary(x => x, x => new byte[] { 1 }))); + var work = new Func(async () => await fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + remoteFilePathsAndTheirData: remoteFilePaths.ToDictionary(x => x, _ => new byte[] { 1 }) + )); // Assert await work.Should().ThrowAsync().WithTimeoutInMs(500); //dont use throwexactlyasync<> here diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs index 69456f8b..1dcfda94 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs @@ -20,7 +20,12 @@ public async Task MultipleFilesUploadAsync_ShouldThrowNullArgumentException_Give using var eventsMonitor = fileUploader.Monitor(); // Act - var work = new Func(async () => await fileUploader.UploadAsync(remoteFilePathsAndTheirData: null)); + var work = new Func(async () => await fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + remoteFilePathsAndTheirData: null + )); // Assert await work.Should().ThrowExactlyAsync().WithTimeoutInMs(500); diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs new file mode 100644 index 00000000..9ed09d1d --- /dev/null +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs @@ -0,0 +1,188 @@ +using FluentAssertions; +using FluentAssertions.Extensions; +using Laerdal.McuMgr.Common.Constants; +using Laerdal.McuMgr.Common.Enums; +using Laerdal.McuMgr.Common.Events; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; +using Laerdal.McuMgr.FileUploader.Contracts.Events; +using Laerdal.McuMgr.FileUploader.Contracts.Native; +using GenericNativeFileUploaderCallbacksProxy_ = Laerdal.McuMgr.FileUploader.FileUploader.GenericNativeFileUploaderCallbacksProxy; + +#pragma warning disable xUnit1026 + +namespace Laerdal.McuMgr.Tests.FileUploader +{ + public partial class FileUploaderTestbed + { + [Theory] + [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.010", "samsung", "sm-x200", null, null, null, null, null, 1, 1, 23, 1, 1)] + [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.020", " Samsung ", " SM-X200 ", null, null, null, null, null, 1, 1, 23, 1, 1)] + [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.030", " Apple ", " iPhone 6 ", null, null, null, null, null, 1, 1, 23, 1, 1)] + [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.040", " Apple ", " iPhone 6 ", 2, 4, null, null, null, 2, 4, null, null, null)] + [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.050", "AcmeCorp.", "foobar", null, null, null, null, null, null, null, null, null, null)] + public async Task SingleFileUploadAsync_ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices( + string testcaseNickname, + string hostDeviceManufacturer, + string hostDeviceModel, + + int? pipelineDepth, + int? byteAlignment, + int? initialMtuSize, + int? windowCapacity, + int? memoryAlignment, + + int? expectedPipelineDepth, + int? expectedByteAlignment, + int? expectedInitialMtuSize, + int? expectedWindowCapacity, + int? expectedMemoryAlignment + ) + { + // Arrange + var stream = new MemoryStream([1, 2, 3]); + var remoteFilePath = "/foo/bar/ping.bin"; + + var mockedNativeFileUploaderProxy = new MockedGreenNativeFileUploaderProxySpy140(uploaderCallbacksProxy: new GenericNativeFileUploaderCallbacksProxy_()); + var fileUploader = new McuMgr.FileUploader.FileUploader(mockedNativeFileUploaderProxy); + + AppleTidbits.KnownProblematicDevices.Add(("apple", "iphone 6")); + + using var eventsMonitor = fileUploader.Monitor(); + + // Act + var work = new Func(() => fileUploader.UploadAsync( + hostDeviceModel: hostDeviceModel, + hostDeviceManufacturer: hostDeviceManufacturer, + + data: stream, + maxTriesCount: 1, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, + byteAlignment: byteAlignment, + + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + )); + + // Assert + await work.Should().CompleteWithinAsync(200.Seconds()); + + mockedNativeFileUploaderProxy.BugDetected.Should().BeNull(); + mockedNativeFileUploaderProxy.CancelCalled.Should().BeFalse(); + mockedNativeFileUploaderProxy.DisconnectCalled.Should().BeFalse(); //00 + mockedNativeFileUploaderProxy.BeginUploadCalled.Should().BeTrue(); + + mockedNativeFileUploaderProxy.ObservedPipelineDepth.Should().Be(expectedPipelineDepth); + mockedNativeFileUploaderProxy.ObservedByteAlignment.Should().Be(expectedByteAlignment); + + mockedNativeFileUploaderProxy.ObservedWindowCapacity.Should().Be(expectedWindowCapacity); + mockedNativeFileUploaderProxy.ObservedInitialMtuSize.Should().Be(expectedInitialMtuSize); + mockedNativeFileUploaderProxy.ObservedMemoryAlignment.Should().Be(expectedMemoryAlignment); + + eventsMonitor + .OccurredEvents.Where(x => x.EventName == nameof(fileUploader.FatalErrorOccurred)) + .Should().HaveCount(0); + + eventsMonitor + .Should().Raise(nameof(fileUploader.StateChanged)) + .WithSender(fileUploader) + .WithArgs(args => args.Resource == remoteFilePath && args.NewState == EFileUploaderState.Uploading); + + eventsMonitor + .Should().Raise(nameof(fileUploader.StateChanged)) + .WithSender(fileUploader) + .WithArgs(args => args.Resource == remoteFilePath && args.NewState == EFileUploaderState.Complete); + + eventsMonitor + .Should().Raise(nameof(fileUploader.FileUploaded)) + .WithSender(fileUploader) + .WithArgs(args => args.Resource == remoteFilePath); + + //00 we dont want to disconnect the device regardless of the outcome + } + + private class MockedGreenNativeFileUploaderProxySpy140 : MockedNativeFileUploaderProxySpy + { + public string BugDetected { get; private set; } + + public int? ObservedPipelineDepth { get; private set; } + public int? ObservedByteAlignment { get; private set; } + + public int? ObservedInitialMtuSize { get; private set; } + public int? ObservedWindowCapacity { get; private set; } + public int? ObservedMemoryAlignment { get; private set; } + + public MockedGreenNativeFileUploaderProxySpy140(INativeFileUploaderCallbacksProxy uploaderCallbacksProxy) : base(uploaderCallbacksProxy) + { + } + + public override EFileUploaderVerdict BeginUpload( + string remoteFilePath, + byte[] data, + int? pipelineDepth = null, // ios only + int? byteAlignment = null, // ios only + int? initialMtuSize = null, // android only + int? windowCapacity = null, // android only + int? memoryAlignment = null // android only + ) + { + ObservedPipelineDepth = pipelineDepth; + ObservedByteAlignment = byteAlignment; + + ObservedInitialMtuSize = initialMtuSize; + ObservedWindowCapacity = windowCapacity; + ObservedMemoryAlignment = memoryAlignment; + + var verdict = base.BeginUpload( + data: data, + remoteFilePath: remoteFilePath, + + pipelineDepth: pipelineDepth, // ios only + byteAlignment: byteAlignment, // ios only + + initialMtuSize: initialMtuSize, // android only + windowCapacity: windowCapacity, // android only + memoryAlignment: memoryAlignment // android only + ); + + Task.Run(async () => //00 vital + { + await Task.Delay(10); + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Idle, EFileUploaderState.Uploading); + + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(00, 00); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(10, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(20, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(30, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(40, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(50, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(60, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(70, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(80, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(90, 10); + await Task.Delay(5); + FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(100, 10); + + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Complete); // order + FileUploadedAdvertisement(remoteFilePath); // order + }); + + return verdict; + + //00 simulating the state changes in a background thread is vital in order to simulate the async nature of the native uploader + } + } + } +} \ No newline at end of file diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index 6fec6fe4..a054d200 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -33,6 +33,9 @@ public async Task SingleFileUploadAsync_ShouldCompleteSuccessfullyByFallingBackT // Act var work = new Func(() => fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + data: stream, maxTriesCount: maxTriesCount, remoteFilePath: remoteFilePath diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index 7052e8b0..9ae50800 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -42,6 +42,9 @@ int sleepTimeBetweenRetriesInMs // Act var work = new Func(() => fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + data: new byte[] { 1, 2, 3 }, maxTriesCount: maxTriesCount, remoteFilePath: remoteFilePath, diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs index 906eeeae..6ff498ca 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs @@ -41,6 +41,9 @@ public async Task SingleFileUploadAsync_ShouldCompleteSuccessfully_GivenVariousS // Act var work = new Func(() => fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + data: stream, maxTriesCount: maxTriesCount, remoteFilePath: remoteFilePath, diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs index 44249038..d56b4b63 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldHaveStreamAutodisposed_GivenBooleanAutodisposedParameter.cs @@ -43,6 +43,9 @@ public async Task SingleFileUploadAsync_ShouldConditionallyAutodisposeGivenStrea // Act var work = new Func(() => fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + data: streamProvider, maxTriesCount: 1, remoteFilePath: remoteFilePath, diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs index 3c9c3332..72a89d8b 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs @@ -30,6 +30,9 @@ public async Task SingleFileUploadAsync_ShouldThrowAllUploadAttemptsFailedExcept // Act var work = new Func(() => fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + data: mockedFileData, maxTriesCount: maxTriesCount, remoteFilePath: remoteFilePath diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs index 65005a0b..b8254c52 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs @@ -33,6 +33,9 @@ public async Task SingleFileUploadAsync_ShouldThrowAllUploadAttemptsFailedExcept // Act var work = new Func(() => fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + data: mockedFileData, //doesnt really matter we just want to ensure that the method fails early and doesnt retry maxTriesCount: maxTriesCount, remoteFilePath: remoteFilePath, diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs index a636b657..2111487b 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs @@ -21,7 +21,13 @@ public async Task SingleFileUploadAsync_ShouldThrowArgumentException_GivenEmptyR using var eventsMonitor = fileUploader.Monitor(); // Act - var work = new Func(() => fileUploader.UploadAsync(mockedFileData, remoteFilePath)); + var work = new Func(() => fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + data: mockedFileData, + remoteFilePath: remoteFilePath + )); // Assert await work.Should().ThrowExactlyAsync().WithTimeoutInMs(500); diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs index 5d48ca0f..0e86a2bb 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs @@ -41,6 +41,9 @@ int maxTriesCount // Act var work = new Func(() => fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + data: mockedFileData, //doesnt really matter we just want to ensure that the method fails early and doesnt retry maxTriesCount: maxTriesCount, remoteFilePath: remoteFilePath, diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs index 93659408..f547707f 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs @@ -17,7 +17,14 @@ public async Task SingleFileUploadAsync_ShouldThrowUnauthorizedErrorException_Gi var fileUploader = new McuMgr.FileUploader.FileUploader(mockedNativeFileUploaderProxy); // Act - var work = new Func(() => fileUploader.UploadAsync(data: new byte[] { 1 }, remoteFilePath: "/path/to/file.bin", maxTriesCount: 2)); + var work = new Func(() => fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + data: new byte[] { 1 }, + maxTriesCount: 2, + remoteFilePath: "/path/to/file.bin" + )); // Assert (await work.Should().ThrowExactlyAsync()).WithInnerExceptionExactly(); diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadCancelledException_GivenCancellationRequestMidflight.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadCancelledException_GivenCancellationRequestMidflight.cs index 1a87b6b8..a05b76f0 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadCancelledException_GivenCancellationRequestMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadCancelledException_GivenCancellationRequestMidflight.cs @@ -34,7 +34,13 @@ public async Task SingleFileUploadAsync_ShouldThrowUploadCancelledException_Give fileUploader.Cancel(reason: cancellationReason); }); - var work = new Func(() => fileUploader.UploadAsync(mockedFileData, remoteFilePath)); + var work = new Func(() => fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + data: mockedFileData, + remoteFilePath: remoteFilePath + )); // Assert await work.Should().ThrowExactlyAsync().WithTimeoutInMs((int)5.Seconds().TotalMilliseconds); diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadInternalErrorException_GivenErroneousNativeFileUploader.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadInternalErrorException_GivenErroneousNativeFileUploader.cs index d0d238a4..4d0670ba 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadInternalErrorException_GivenErroneousNativeFileUploader.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadInternalErrorException_GivenErroneousNativeFileUploader.cs @@ -16,7 +16,13 @@ public async Task SingleFileUploadAsync_ShouldThrowUploadInternalErrorException_ var fileUploader = new McuMgr.FileUploader.FileUploader(mockedNativeFileUploaderProxy); // Act - var work = new Func(() => fileUploader.UploadAsync(data: new byte[] { 1 }, remoteFilePath: "/path/to/file.bin")); + var work = new Func(() => fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + data: new byte[] { 1 }, + remoteFilePath: "/path/to/file.bin" + )); // Assert (await work.Should().ThrowExactlyAsync()).WithInnerExceptionExactly("native symbols not loaded blah blah"); diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadTimeoutException_GivenTooSmallTimeout.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadTimeoutException_GivenTooSmallTimeout.cs index 3574ac30..4e0e1ca4 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadTimeoutException_GivenTooSmallTimeout.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUploadTimeoutException_GivenTooSmallTimeout.cs @@ -24,6 +24,9 @@ public async Task SingleFileUploadAsync_ShouldThrowUploadTimeoutException_GivenT // Act var work = new Func(() => fileUploader.UploadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + data: new byte[] { 1 }, remoteFilePath: remoteFilePath, timeoutForUploadInMs: 100 diff --git a/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs b/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs index 643a449c..48a79446 100644 --- a/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs +++ b/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs @@ -1,7 +1,43 @@ +using System.Collections.Generic; +using System.Linq; + namespace Laerdal.McuMgr.Common.Constants { public readonly struct AndroidTidbits { + /// List of known problematic android-devices that have issues with BLE connection stability and have to use fail-safe ble settings to work.

+ /// Inspired by + static public HashSet<(string Manufacturer, string DeviceModel)> KnownProblematicDevices { get; } = new (string Manufacturer, string DeviceModel)[] + { + ("Motorola", "moto g20"), + ("Motorola", "moto e20"), + ("Motorola", "moto e30"), + ("Motorola", "moto e32"), + ("Motorola", "moto e40"), + + ("Nokia", "Nokia G21"), + ("Nokia", "Nokia G11"), + ("Nokia", "Nokia T20"), + + ("Realme", "RMX3261"), //C21Y + ("Realme", "RMX3262"), //C21Y + ("Realme", "RMX3265"), //C25Y + ("Realme", "RMX3269"), //C25Y + ("Realme", "RMP2105"), //Pad Mini + ("Realme", "RMP2106"), //Pad Mini + + ("Infinix", "Infinix X675"), //Hot 11 2022 + + ("HTC", "Wildfire E2 plus"), + + ("Micromax", "IN_2b"), + ("Micromax", "IN_2c"), + + ("Samsung", "SM-X200"), //Galaxy Tab A8 + } + .Select(x => (x.Manufacturer.Trim().ToLowerInvariant(), x.DeviceModel.Trim().ToLowerInvariant())) //vital + .ToHashSet(); + /// /// Failsafe settings for the BLE connection used in Androids to perform various operations: installing firmware, resetting the device, erasing firmwares, uploading files, /// downloading files. These settings are enforced automagically when the ble connection turns out to be unstable and unreliable during the aforementioned operations. diff --git a/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs b/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs index a55484b3..f522daa9 100644 --- a/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs +++ b/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs @@ -1,7 +1,21 @@ +using System; +using System.Collections.Generic; +using System.Linq; + namespace Laerdal.McuMgr.Common.Constants { public readonly struct AppleTidbits { + // ReSharper disable once CollectionNeverUpdated.Global + /// List of known problematic android-devices that have issues with BLE connection stability and have to use fail-safe ble settings to work.

+ /// Inspired by + static public HashSet<(string Manufacturer, string DeviceModel)> KnownProblematicDevices { get; } = new (string Manufacturer, string DeviceModel)[] + { + // ("Apple", "XYZ"), // just a placeholder - no apple devices are known to have issues with BLE connection stability at the time of this writing + } + .Select(x => (x.Manufacturer.Trim().ToLowerInvariant(), x.DeviceModel.Trim().ToLowerInvariant())) + .ToHashSet(); + /// /// Failsafe settings for the BLE connection used in Apple platforms (iOS / MacCatalyst) to perform various operations: installing firmware, resetting the device, /// erasing firmwares, uploading files, downloading files. These settings are enforced automagically when the ble connection turns out to be unstable and unreliable diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs index cba73564..07ab633e 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs @@ -18,6 +18,8 @@ public interface IFileUploaderCommandable /// Allowed types for TData are 'Stream', 'Func<Stream>', 'Func<Task<Stream>>', 'Func<ValueTask<Stream>>', 'byte[]' and 'IEnumerable<byte>'. /// /// The files to upload. + /// The manufacturer of the host-device + /// The device-model of the host-device /// The time to sleep between each retry after a failed try. /// The amount of time to wait for each upload to complete before bailing out. /// Maximum amount of tries per upload before bailing out. In case of errors the mechanism will try "maxTriesPerUpload" before bailing out. @@ -41,6 +43,8 @@ public interface IFileUploaderCommandable /// (Android only) Set the selected memory alignment. Defaults to 4 to match Nordic devices. Task> UploadAsync( IDictionary remoteFilePathsAndTheirData, + string hostDeviceManufacturer, + string hostDeviceModel, int sleepTimeBetweenRetriesInMs = 100, int timeoutPerUploadInMs = -1, int maxTriesPerUpload = 10, @@ -64,6 +68,8 @@ Task> UploadAsync( /// /// The local data to upload. /// The remote file-path to upload the data to. + /// The manufacturer of the host-device + /// The device-model of the host-device /// The amount of time to wait for the upload to complete before bailing out. /// The maximum amount of tries before bailing out with . /// The time to sleep between each retry after a failed try. @@ -88,6 +94,8 @@ Task> UploadAsync( Task UploadAsync( TData localData, string remoteFilePath, + string hostDeviceManufacturer, + string hostDeviceModel, int timeoutForUploadInMs = -1, int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 1_000, @@ -105,6 +113,8 @@ Task UploadAsync( /// /// The remote file-path to upload the data to. /// The file-data. + /// The manufacturer of the host-device + /// The device-model of the host-device /// (iOS only) If set to a value larger than 1, this enables SMP Pipelining, wherein multiple packets of data ('chunks') are sent at /// once before awaiting a response, which can lead to a big increase in transfer speed if the receiving hardware supports this feature. /// (iOS only) When PipelineLength is larger than 1 (SMP Pipelining Enabled) it's necessary to set this in order for the stack @@ -124,6 +134,8 @@ Task UploadAsync( EFileUploaderVerdict BeginUpload( string remoteFilePath, byte[] data, + string hostDeviceManufacturer, + string hostDeviceModel, int? pipelineDepth = null, int? byteAlignment = null, int? initialMtuSize = null, diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index c0cc64ac..658a967b 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -47,9 +47,11 @@ public EFileUploaderVerdict BeginUpload( string remoteFilePath, byte[] data, + string hostDeviceManufacturer, + string hostDeviceModel, + int? pipelineDepth = null, int? byteAlignment = null, - int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null @@ -60,19 +62,76 @@ public EFileUploaderVerdict BeginUpload( RemoteFilePathHelpers.ValidateRemoteFilePath(remoteFilePath); // order remoteFilePath = RemoteFilePathHelpers.SanitizeRemoteFilePath(remoteFilePath); // order + var connectionSettings = GetFailSafeConnectionSettingsIfHostDeviceIsProblematic_( + hostDeviceModel_: hostDeviceModel, + hostDeviceManufacturer_: hostDeviceManufacturer, + + pipelineDepth_: pipelineDepth, + byteAlignment_: byteAlignment, + initialMtuSize_: initialMtuSize, + windowCapacity_: windowCapacity, + memoryAlignment_: memoryAlignment + ); + var verdict = _nativeFileUploaderProxy.BeginUpload( data: data, remoteFilePath: remoteFilePath, - pipelineDepth: pipelineDepth, - byteAlignment: byteAlignment, + pipelineDepth: connectionSettings.pipelineDepth, + byteAlignment: connectionSettings.byteAlignment, - initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + initialMtuSize: connectionSettings.initialMtuSize, + windowCapacity: connectionSettings.windowCapacity, + memoryAlignment: connectionSettings.memoryAlignment ); return verdict; + + (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment) GetFailSafeConnectionSettingsIfHostDeviceIsProblematic_( + string hostDeviceManufacturer_, + string hostDeviceModel_, + int? pipelineDepth_, + int? byteAlignment_, + int? initialMtuSize_, + int? windowCapacity_, + int? memoryAlignment_ + ) + { + hostDeviceModel_ = (hostDeviceModel_ ?? "").Trim().ToLowerInvariant(); + hostDeviceManufacturer_ = (hostDeviceManufacturer_ ?? "").Trim().ToLowerInvariant(); + + if (AppleTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer_, hostDeviceModel_)) + && (pipelineDepth_ ?? 1) == 1 + && (byteAlignment_ ?? 1) == 1) + { + return ( + byteAlignment: AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment, + pipelineDepth: AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth, + initialMtuSize: AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize, + windowCapacity: AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity, + memoryAlignment: AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment + ); + } + + if (AndroidTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer_, hostDeviceModel_)) + && initialMtuSize_ == null + && (windowCapacity_ ?? 1) == 1 + && (memoryAlignment_ ?? 1) == 1) + { + return ( + byteAlignment: AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment, + pipelineDepth: AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth, + initialMtuSize: AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize, + windowCapacity: AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity, + memoryAlignment: AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment + ); + } + + return ( + byteAlignment: byteAlignment, pipelineDepth: pipelineDepth, + initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment + ); + } } public void Cancel(string reason = "") => _nativeFileUploaderProxy?.Cancel(reason); @@ -171,15 +230,15 @@ public event EventHandler> UploadAsync( IDictionary remoteFilePathsAndTheirData, + string hostDeviceManufacturer, + string hostDeviceModel, int sleepTimeBetweenRetriesInMs = 100, int timeoutPerUploadInMs = -1, int maxTriesPerUpload = 10, bool moveToNextUploadInCaseOfError = true, bool autodisposeStreams = false, - int? pipelineDepth = null, int? byteAlignment = null, - int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null @@ -197,19 +256,21 @@ public async Task> UploadAsync( await UploadAsync( data: x.Value, remoteFilePath: x.Key, + + hostDeviceModel: hostDeviceModel, + hostDeviceManufacturer: hostDeviceManufacturer, - maxTriesCount: maxTriesPerUpload, - autodisposeStream: autodisposeStreams, timeoutForUploadInMs: timeoutPerUploadInMs, - sleepTimeBetweenRetriesInMs: sleepTimeBetweenRetriesInMs, + maxTriesCount: maxTriesPerUpload, + sleepTimeBetweenRetriesInMs: sleepTimeBetweenRetriesInMs, + autodisposeStream: autodisposeStreams, + pipelineDepth: pipelineDepth, byteAlignment: byteAlignment, - initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment - ); + memoryAlignment: memoryAlignment); } catch (UploadErroredOutException) { @@ -234,15 +295,15 @@ await UploadAsync( public async Task UploadAsync( TData data, string remoteFilePath, + string hostDeviceManufacturer, + string hostDeviceModel, int timeoutForUploadInMs = -1, int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 1_000, int gracefulCancellationTimeoutInMs = 2_500, bool autodisposeStream = false, - int? pipelineDepth = null, int? byteAlignment = null, - int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null @@ -294,14 +355,17 @@ public async Task UploadAsync( } var verdict = BeginUpload( //00 dont use task.run here for now - data: dataArray, remoteFilePath: remoteFilePath, + hostDeviceModel: hostDeviceModel, + hostDeviceManufacturer: hostDeviceManufacturer, + + data: dataArray, // ios only pipelineDepth: pipelineDepth, // ios only - byteAlignment: byteAlignment, // ios only + byteAlignment: byteAlignment, // android only initialMtuSize: initialMtuSize, // android only - windowCapacity: windowCapacity, // android only + windowCapacity: windowCapacity, memoryAlignment: memoryAlignment // android only ); if (verdict != EFileUploaderVerdict.Success) From 4f18de9a4424c2e5e4073b4cf3d7173c4b3fcedc Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 18 Oct 2024 20:27:23 +0200 Subject: [PATCH 054/104] clean (FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs): trivial cleanups --- ...gBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs | 3 --- 1 file changed, 3 deletions(-) diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs index 9ed09d1d..acb638d9 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs @@ -69,7 +69,6 @@ public async Task SingleFileUploadAsync_ShouldCompleteSuccessfullyByFallingBackT // Assert await work.Should().CompleteWithinAsync(200.Seconds()); - mockedNativeFileUploaderProxy.BugDetected.Should().BeNull(); mockedNativeFileUploaderProxy.CancelCalled.Should().BeFalse(); mockedNativeFileUploaderProxy.DisconnectCalled.Should().BeFalse(); //00 mockedNativeFileUploaderProxy.BeginUploadCalled.Should().BeTrue(); @@ -105,8 +104,6 @@ public async Task SingleFileUploadAsync_ShouldCompleteSuccessfullyByFallingBackT private class MockedGreenNativeFileUploaderProxySpy140 : MockedNativeFileUploaderProxySpy { - public string BugDetected { get; private set; } - public int? ObservedPipelineDepth { get; private set; } public int? ObservedByteAlignment { get; private set; } From 9ad11873b1e8718285b99ddf9d7d0a313cd309c4 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 13:50:17 +0200 Subject: [PATCH 055/104] fix (github-actions.yml): disable test-result publishing due to an error affecting EnricoMi/publish-unit-test-result-action/macos@v2 more details here https://github.com/EnricoMi/publish-unit-test-result-action/issues/633 --- .github/workflows/github-actions.yml | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml index 355f1a70..d1275e5d 100644 --- a/.github/workflows/github-actions.yml +++ b/.github/workflows/github-actions.yml @@ -115,13 +115,14 @@ jobs: && \ rm "./dependency_tracker_private_signing_key.ppk" "./dependency_tracker_api_key.ppk" - - name: '📡 Publish Test Results' # https://github.com/marketplace/actions/publish-test-results - uses: 'EnricoMi/publish-unit-test-result-action/macos@v2' - if: always() - with: - files: | - TestResults/**/TEST-*.xml - TestResults/**/TEST-*.trx +# todo figure out why this is failing as of Oct 2024 -> https://github.com/EnricoMi/publish-unit-test-result-action/issues/633 +# - name: '📡 Publish Test Results' # https://github.com/marketplace/actions/publish-test-results +# uses: 'EnricoMi/publish-unit-test-result-action/macos@v2' +# if: always() +# with: +# files: | +# TestResults/**/TEST-*.xml +# TestResults/**/TEST-*.trx - name: '⬆️ Upload Artifacts' # to share with other workflows https://stackoverflow.com/a/77663335/863651 uses: 'actions/upload-artifact@v4' From 94d095bde8d844e6b67c6ef566bfc8daa9463101 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 13:50:17 +0200 Subject: [PATCH 056/104] fix (github-actions.yml): disable test-result publishing due to an error affecting EnricoMi/publish-unit-test-result-action/macos@v2 more details here https://github.com/EnricoMi/publish-unit-test-result-action/issues/633 --- .github/workflows/github-actions.yml | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml index 355f1a70..2651eae2 100644 --- a/.github/workflows/github-actions.yml +++ b/.github/workflows/github-actions.yml @@ -114,14 +114,15 @@ jobs: -p:Laerdal_Dependency_Tracker_Private_Signing_Key_File_Path="${{env.BUILD_REPOSITORY_FOLDERPATH}}/Laerdal.Scripts/dependency_tracker_private_signing_key.ppk" \ && \ rm "./dependency_tracker_private_signing_key.ppk" "./dependency_tracker_api_key.ppk" - - - name: '📡 Publish Test Results' # https://github.com/marketplace/actions/publish-test-results - uses: 'EnricoMi/publish-unit-test-result-action/macos@v2' - if: always() - with: - files: | - TestResults/**/TEST-*.xml - TestResults/**/TEST-*.trx + + # todo figure out why this is failing as of Oct 2024 -> https://github.com/EnricoMi/publish-unit-test-result-action/issues/633 + # - name: '📡 Publish Test Results' # https://github.com/marketplace/actions/publish-test-results + # uses: 'EnricoMi/publish-unit-test-result-action/macos@v2' + # if: always() + # with: + # files: | + # TestResults/**/TEST-*.xml + # TestResults/**/TEST-*.trx - name: '⬆️ Upload Artifacts' # to share with other workflows https://stackoverflow.com/a/77663335/863651 uses: 'actions/upload-artifact@v4' From c773618bc383b380589dee38cad7b39a9a8b63bc Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 14:23:04 +0200 Subject: [PATCH 057/104] feat (AndroidFileUploader.java): add @Contract(pure = true) wherever it makes sense --- .../mcumgr_laerdal_wrapper/AndroidFileUploader.java | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 3a4420c6..adee62cf 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -391,11 +391,13 @@ private boolean IsCold() private String _lastFatalErrorMessage; + @Contract(pure = true) public String getLastFatalErrorMessage() { return _lastFatalErrorMessage; } + @Contract(pure = true) public void onError( final String remoteFilePath, final String errorMessage, @@ -427,36 +429,43 @@ public void fatalErrorOccurredAdvertisement( _lastFatalErrorMessage = errorMessage; //this method is meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void busyStateChangedAdvertisement(final boolean busyNotIdle) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void fileUploadedAdvertisement(final String remoteFilePath) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void cancellingAdvertisement(final String reason) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void cancelledAdvertisement(final String reason) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void stateChangedAdvertisement(final String remoteFilePath, final EAndroidFileUploaderState oldState, final EAndroidFileUploaderState newState) // (final EAndroidFileUploaderState oldState, final EAndroidFileUploaderState newState) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(final int progressPercentage, final float averageThroughput) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void logMessageAdvertisement(final String message, final String category, final String level, final String resource) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates From 857c25e69437a6aeedcd4db3d36668ec37900802 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 14:25:42 +0200 Subject: [PATCH 058/104] feat (AndroidDeviceResetter.java): add @Contract(pure = true) wherever it makes sense --- .../mcumgr_laerdal_wrapper/AndroidDeviceResetter.java | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java index 9713ea59..3fe538fb 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java @@ -9,6 +9,7 @@ import io.runtime.mcumgr.exception.McuMgrException; import io.runtime.mcumgr.managers.DefaultManager; import io.runtime.mcumgr.response.dflt.McuMgrOsResponse; +import org.jetbrains.annotations.Contract; import org.jetbrains.annotations.NotNull; @SuppressWarnings("unused") @@ -65,7 +66,7 @@ public void onError(@NotNull final McuMgrException error) { }); } - public void disconnect() { //noinspection ConstantValue + public void disconnect() { if (_manager == null) return; @@ -95,18 +96,21 @@ protected void onCleared() { private String _lastFatalErrorMessage; + @Contract(pure = true) public String getLastFatalErrorMessage() { return _lastFatalErrorMessage; } public void fatalErrorOccurredAdvertisement(final String errorMessage) { - _lastFatalErrorMessage = errorMessage; //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates + _lastFatalErrorMessage = errorMessage; } + @Contract(pure = true) public void logMessageAdvertisement(final String message, final String category, final String level) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void stateChangedAdvertisement(final EAndroidDeviceResetterState oldState, final EAndroidDeviceResetterState currentState) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } From 4bea652efae147c932347eeeb0fde614a9b54f16 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 14:34:57 +0200 Subject: [PATCH 059/104] feat (AndroidFileDownloader.java): add @Contract(pure = true) wherever it makes sense --- .../AndroidFileDownloader.java | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index a6fd0239..ed86e6b1 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -10,6 +10,7 @@ import io.runtime.mcumgr.transfer.DownloadCallback; import io.runtime.mcumgr.transfer.TransferController; import no.nordicsemi.android.ble.ConnectionPriorityRequest; +import org.jetbrains.annotations.Contract; import org.jetbrains.annotations.NotNull; @SuppressWarnings("unused") @@ -199,54 +200,60 @@ private void setState(final EAndroidFileDownloaderState newState) private String _lastFatalErrorMessage; + @Contract(pure = true) public String getLastFatalErrorMessage() { return _lastFatalErrorMessage; } - public void fatalErrorOccurredAdvertisement(final String resource, final String errorMessage) + public void fatalErrorOccurredAdvertisement(final String resource, final String errorMessage) //this method is meant to be overridden by csharp binding libraries to intercept updates { - //this method is meant to be overridden by csharp binding libraries to intercept updates _lastFatalErrorMessage = errorMessage; } + @Contract(pure = true) public void busyStateChangedAdvertisement(boolean busyNotIdle) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void cancelledAdvertisement() { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } - //wrapper utility method so that we wont have to constantly pass remoteFilePathSanitized as the first argument currently unused but should be handy in the future + @Contract(pure = true) //wrapper utility method so that we wont have to constantly pass remoteFilePathSanitized as the first argument currently unused but should be handy in the future public void stateChangedAdvertisement(final EAndroidFileDownloaderState oldState, final EAndroidFileDownloaderState newState) { stateChangedAdvertisement(_remoteFilePathSanitized, oldState, newState); } + @Contract(pure = true) public void stateChangedAdvertisement(final String resource, final EAndroidFileDownloaderState oldState, final EAndroidFileDownloaderState newState) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(final int progressPercentage, final float averageThroughput) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void downloadCompletedAdvertisement(final String resource, final byte[] data) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } - //wrapper utility method so that we wont have to constantly pass remoteFilePathSanitized as the fourth argument currently unused but should be handy in the future + @Contract(pure = true) //wrapper utility method so that we wont have to constantly pass remoteFilePathSanitized as the fourth argument currently unused but should be handy in the future private void logMessageAdvertisement(final String message, final String category, final String level) { logMessageAdvertisement(message, category, level, _remoteFilePathSanitized); } + @Contract(pure = true) public void logMessageAdvertisement(final String message, final String category, final String level, final String resource) //wrapper method { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates From 93e108b5425a00479e84eb2908a4ef79a08b88cd Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 14:35:52 +0200 Subject: [PATCH 060/104] feat (AndroidFirmwareEraser.java): add @Contract(pure = true) wherever it makes sense --- .../mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java index 1f713b4e..e2b1a14a 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java @@ -10,6 +10,7 @@ import io.runtime.mcumgr.managers.ImageManager; import io.runtime.mcumgr.response.img.McuMgrImageResponse; import io.runtime.mcumgr.response.img.McuMgrImageStateResponse; +import org.jetbrains.annotations.Contract; @SuppressWarnings("unused") public class AndroidFirmwareEraser { @@ -79,12 +80,14 @@ private void setState(EAndroidFirmwareEraserState newState) { stateChangedAdvertisement(oldState, newState); //order } + @Contract(pure = true) public void stateChangedAdvertisement(EAndroidFirmwareEraserState oldState, EAndroidFirmwareEraserState currentState) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } private String _lastFatalErrorMessage; + @Contract(pure = true) public String getLastFatalErrorMessage() { return _lastFatalErrorMessage; } @@ -93,10 +96,12 @@ public void fatalErrorOccurredAdvertisement(final String errorMessage) { _lastFatalErrorMessage = errorMessage; //this method is meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void logMessageAdvertisement(final String message, final String category, final String level) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void busyStateChangedAdvertisement(final boolean busyNotIdle) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } From 140254505cd468332f38caee74b6a39ff6a68633 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 14:40:23 +0200 Subject: [PATCH 061/104] feat (AndroidFirmwareInstaller.java): add @Contract(pure = true) wherever it makes sense --- .../mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java index eef36436..d637d03c 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java @@ -18,6 +18,7 @@ import io.runtime.mcumgr.exception.McuMgrException; import io.runtime.mcumgr.exception.McuMgrTimeoutException; import no.nordicsemi.android.ble.ConnectionPriorityRequest; +import org.jetbrains.annotations.Contract; import org.jetbrains.annotations.NotNull; @SuppressWarnings("unused") @@ -237,6 +238,7 @@ protected void onCleared() private String _lastFatalErrorMessage; + @Contract(pure = true) public String getLastFatalErrorMessage() { return _lastFatalErrorMessage; @@ -258,26 +260,31 @@ public void fatalErrorOccurredAdvertisement(final EAndroidFirmwareInstallationSt _lastFatalErrorMessage = errorMessage; } + @Contract(pure = true) public void logMessageAdvertisement(final String message, final String category, final String level) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void cancelledAdvertisement() { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void busyStateChangedAdvertisement(final boolean busyNotIdle) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void stateChangedAdvertisement(final EAndroidFirmwareInstallationState oldState, final EAndroidFirmwareInstallationState currentState) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } + @Contract(pure = true) public void firmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(final int progressPercentage, final float averageThroughput) { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates From 544daf24b879302280ef4186aa128c96d649862b Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 14:45:16 +0200 Subject: [PATCH 062/104] clean (AndroidFileUploader.java): trivial cleanups in logging statements --- .../mcumgr_laerdal_wrapper/AndroidFileUploader.java | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index adee62cf..1fa4b350 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -54,23 +54,20 @@ public boolean trySetContext(@NonNull final Context context) public boolean trySetBluetoothDevice(@NonNull final BluetoothDevice bluetoothDevice) { - logMessageAdvertisement("[AFU.TSBD.000] trySetBluetoothDevice() called", "FileUploader", "TRACE", _remoteFilePathSanitized); - if (!IsIdleOrCold()) { - logMessageAdvertisement("[AFU.TSBD.005] trySetBluetoothDevice() cannot proceed because the uploader is not cold", "FileUploader", "TRACE", _remoteFilePathSanitized); + logMessageAdvertisement("[AFU.TSBD.005] trySetBluetoothDevice() cannot proceed because the uploader is not cold", "FileUploader", "ERROR", _remoteFilePathSanitized); return false; } - logMessageAdvertisement("[AFU.TSBD.010]", "FileUploader", "TRACE", _remoteFilePathSanitized); if (!tryInvalidateCachedTransport()) //order { - logMessageAdvertisement("[AFU.TSBD.020]", "FileUploader", "TRACE", _remoteFilePathSanitized); + logMessageAdvertisement("[AFU.TSBD.020] Failed to invalidate the cached-transport instance", "FileUploader", "ERROR", _remoteFilePathSanitized); return false; } _bluetoothDevice = bluetoothDevice; //order - logMessageAdvertisement("[AFU.TSBD.010] Native Bluetooth-Device set to a new instance", "FileUploader", "TRACE", _remoteFilePathSanitized); + logMessageAdvertisement("[AFU.TSBD.010] Successfully set the android-bluetooth-device to the given value", "FileUploader", "TRACE", _remoteFilePathSanitized); return true; } From 1b10b71f27b5cf037efcbcb7097d5ff48d1a3c14 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 14:52:11 +0200 Subject: [PATCH 063/104] refa (IOSFileUploader.swift): we now allow trySetBluetoothDevice() and tryInvalidateCachedTransport() to be called even in idle state --- .../McuMgrBindingsiOS/IOSFileUploader.swift | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift index cf710bb9..522583a6 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift @@ -29,7 +29,7 @@ public class IOSFileUploader: NSObject { @objc public func trySetBluetoothDevice(_ cbPeripheral: CBPeripheral!) -> Bool { - if !IsCold() { + if !IsIdleOrCold() { return false } @@ -47,7 +47,7 @@ public class IOSFileUploader: NSObject { return true } - if !IsCold() { //if the upload is already in progress we bail out + if !IsIdleOrCold() { //if the upload is already in progress we bail out return false } @@ -239,6 +239,10 @@ public class IOSFileUploader: NSObject { _fileSystemManager = nil } + private func IsIdleOrCold() -> Bool { + return _currentState == EIOSFileUploaderState.idle || IsCold(); + } + private func IsCold() -> Bool { return _currentState == EIOSFileUploaderState.none || _currentState == EIOSFileUploaderState.error From 7ee6ad0aba51dc10425b33b39ddb40922b7901d0 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 15:15:07 +0200 Subject: [PATCH 064/104] fix (AndroidFileUploader.java): onError() is no longer marked as 'pure' because it simply isn't one --- .../laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 1fa4b350..8315c8aa 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -30,7 +30,7 @@ public class AndroidFileUploader private String _remoteFilePathSanitized; private EAndroidFileUploaderState _currentState = EAndroidFileUploaderState.NONE; - public AndroidFileUploader() + public AndroidFileUploader() //this flavour is meant to be used in conjunction with trySetBluetoothDevice() and trySetContext() { } @@ -394,7 +394,7 @@ public String getLastFatalErrorMessage() return _lastFatalErrorMessage; } - @Contract(pure = true) + //@Contract(pure = true) //dont public void onError( final String remoteFilePath, final String errorMessage, @@ -403,7 +403,7 @@ public void onError( { if (!(exception instanceof McuMgrErrorException)) { - fatalErrorOccurredAdvertisement(remoteFilePath, errorMessage, -1, -1); + fatalErrorOccurredAdvertisement(remoteFilePath, errorMessage, -1, -1); // -1 values get mapped to the 'generic' error code return; } From b2055ed8a653f5da7100412998ee5f839a4c9254 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 15:30:56 +0200 Subject: [PATCH 065/104] clean (AndroidFileUploader.java): trivial neutral cleanups and simplifications in terms of error-logging --- .../AndroidFileUploader.java | 48 ++++++++----------- 1 file changed, 20 insertions(+), 28 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 8315c8aa..cbacd404 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -67,7 +67,7 @@ public boolean trySetBluetoothDevice(@NonNull final BluetoothDevice bluetoothDev _bluetoothDevice = bluetoothDevice; //order - logMessageAdvertisement("[AFU.TSBD.010] Successfully set the android-bluetooth-device to the given value", "FileUploader", "TRACE", _remoteFilePathSanitized); + logMessageAdvertisement("[AFU.TSBD.030] Successfully set the android-bluetooth-device to the given value", "FileUploader", "TRACE", _remoteFilePathSanitized); return true; } @@ -108,53 +108,46 @@ public EAndroidFileUploaderVerdict beginUpload( final int memoryAlignment ) { - if (!IsCold()) { - setState(EAndroidFileUploaderState.ERROR); - onError("N/A", "Another upload is already in progress", null); + if (remoteFilePath == null || remoteFilePath.isEmpty()) { + onError("N/A", "Provided target-path is empty", null); - return EAndroidFileUploaderVerdict.FAILED__OTHER_UPLOAD_ALREADY_IN_PROGRESS; + return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } - if (_context == null) { - setState(EAndroidFileUploaderState.ERROR); - onError("N/A", "No context specified - call trySetContext() first", null); + _remoteFilePathSanitized = remoteFilePath.trim(); + if (_remoteFilePathSanitized.endsWith("/")) //the path must point to a file not a directory + { + onError(_remoteFilePathSanitized, "Provided target-path points to a directory not a file", null); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } - if (_bluetoothDevice == null) { - setState(EAndroidFileUploaderState.ERROR); - onError("N/A", "No bluetooth-device specified - call trySetBluetoothDevice() first", null); + if (!_remoteFilePathSanitized.startsWith("/")) + { + onError(_remoteFilePathSanitized, "Provided target-path is not an absolute path", null); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } - if (remoteFilePath == null || remoteFilePath.isEmpty()) { - setState(EAndroidFileUploaderState.ERROR); - onError("N/A", "Provided target-path is empty", null); + if (!IsCold()) { + onError(_remoteFilePathSanitized, "Another upload is already in progress", null); - return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; + return EAndroidFileUploaderVerdict.FAILED__OTHER_UPLOAD_ALREADY_IN_PROGRESS; } - _remoteFilePathSanitized = remoteFilePath.trim(); - if (_remoteFilePathSanitized.endsWith("/")) //the path must point to a file not a directory - { - setState(EAndroidFileUploaderState.ERROR); - onError(_remoteFilePathSanitized, "Provided target-path points to a directory not a file", null); + if (_context == null) { + onError(_remoteFilePathSanitized, "No context specified - call trySetContext() first", null); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } - if (!_remoteFilePathSanitized.startsWith("/")) - { - setState(EAndroidFileUploaderState.ERROR); - onError(_remoteFilePathSanitized, "Provided target-path is not an absolute path", null); + if (_bluetoothDevice == null) { + onError(_remoteFilePathSanitized, "No bluetooth-device specified - call trySetBluetoothDevice() first", null); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } if (data == null) { // data being null is not ok but data.length==0 is perfectly ok because we might want to create empty files - setState(EAndroidFileUploaderState.ERROR); onError(_remoteFilePathSanitized, "Provided data is null", null); return EAndroidFileUploaderVerdict.FAILED__INVALID_DATA; @@ -185,7 +178,6 @@ public EAndroidFileUploaderVerdict beginUpload( } catch (final Exception ex) { - setState(EAndroidFileUploaderState.ERROR); onError(_remoteFilePathSanitized, "Failed to initialize the upload", ex); return EAndroidFileUploaderVerdict.FAILED__ERROR_UPON_COMMENCING; @@ -242,7 +234,6 @@ private EAndroidFileUploaderVerdict ensureFilesystemManagerIsInitializedExactlyO } catch (final Exception ex) { - setState(EAndroidFileUploaderState.ERROR); onError(_remoteFilePathSanitized, ex.getMessage(), ex); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; @@ -401,6 +392,8 @@ public void onError( final Exception exception ) { + setState(EAndroidFileUploaderState.ERROR); //keep first + if (!(exception instanceof McuMgrErrorException)) { fatalErrorOccurredAdvertisement(remoteFilePath, errorMessage, -1, -1); // -1 values get mapped to the 'generic' error code @@ -502,7 +495,6 @@ public void onUploadProgressChanged(final int bytesSent, final int fileSize, fin public void onUploadFailed(@NonNull final McuMgrException error) { fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); - setState(EAndroidFileUploaderState.ERROR); onError(_remoteFilePathSanitized, error.getMessage(), error); setLoggingEnabled(true); busyStateChangedAdvertisement(false); From f83e4094e76123ec35a4db17b94a463732d17e29 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 16:17:02 +0200 Subject: [PATCH 066/104] refa (AndroidFileDownloader.java): refactor the implementation to make it symmetrical to the one employed by AndroidFileUploader --- .../AndroidFileDownloader.java | 265 +++++++++++++++--- 1 file changed, 225 insertions(+), 40 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index ed86e6b1..37183d9a 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -5,6 +5,7 @@ import androidx.annotation.NonNull; import io.runtime.mcumgr.McuMgrTransport; import io.runtime.mcumgr.ble.McuMgrBleTransport; +import io.runtime.mcumgr.exception.McuMgrErrorException; import io.runtime.mcumgr.exception.McuMgrException; import io.runtime.mcumgr.managers.FsManager; import io.runtime.mcumgr.transfer.DownloadCallback; @@ -16,19 +17,74 @@ @SuppressWarnings("unused") public class AndroidFileDownloader { + private Context _context; + private BluetoothDevice _bluetoothDevice; + private FsManager _fileSystemManager; - @SuppressWarnings("FieldCanBeLocal") - private final McuMgrBleTransport _transport; + private McuMgrBleTransport _transport; private TransferController _downloadingController; + private FileDownloaderCallbackProxy _fileDownloaderCallbackProxy; private int _initialBytes; private long _downloadStartTimestamp; private String _remoteFilePathSanitized = ""; private EAndroidFileDownloaderState _currentState = EAndroidFileDownloaderState.NONE; + public AndroidFileDownloader() //this flavour is meant to be used in conjunction with trySetBluetoothDevice() and trySetContext() + { + } + public AndroidFileDownloader(@NonNull final Context context, @NonNull final BluetoothDevice bluetoothDevice) { - _transport = new McuMgrBleTransport(context, bluetoothDevice); + _context = context; + _bluetoothDevice = bluetoothDevice; + } + + public boolean trySetContext(@NonNull final Context context) + { + if (!IsIdleOrCold()) + return false; + + if (!tryInvalidateCachedTransport()) //order + return false; + + _context = context; + return true; + } + + public boolean trySetBluetoothDevice(@NonNull final BluetoothDevice bluetoothDevice) + { + if (!IsIdleOrCold()) { + logMessageAdvertisement("[AFD.TSBD.005] trySetBluetoothDevice() cannot proceed because the uploader is not cold", "FileUploader", "ERROR", _remoteFilePathSanitized); + return false; + } + + if (!tryInvalidateCachedTransport()) //order + { + logMessageAdvertisement("[AFD.TSBD.020] Failed to invalidate the cached-transport instance", "FileUploader", "ERROR", _remoteFilePathSanitized); + return false; + } + + _bluetoothDevice = bluetoothDevice; //order + + logMessageAdvertisement("[AFD.TSBD.030] Successfully set the android-bluetooth-device to the given value", "FileUploader", "TRACE", _remoteFilePathSanitized); + + return true; + } + + public boolean tryInvalidateCachedTransport() + { + if (_transport == null) //already scrapped + return true; + + if (!IsIdleOrCold()) //if the upload is already in progress we bail out + return false; + + disposeFilesystemManager(); // order + disposeTransport(); // order + disposeCallbackProxy(); // order + + return true; } /** @@ -48,65 +104,63 @@ public EAndroidFileDownloaderVerdict beginDownload( // final int memoryAlignment //this doesnt make sense for downloading it only makes sense in uploading scenarios https://github.com/NordicSemiconductor/Android-nRF-Connect-Device-Manager/issues/188#issuecomment-2391146897 ) { - if (_currentState != EAndroidFileDownloaderState.NONE //if the download is already in progress we bail out - && _currentState != EAndroidFileDownloaderState.ERROR - && _currentState != EAndroidFileDownloaderState.COMPLETE - && _currentState != EAndroidFileDownloaderState.CANCELLED) - { - logMessageAdvertisement("Cannot start a new download while another one is still in progress (state=" + _currentState.toString() + ")", "FileDownloader", "ERROR", remoteFilePath); - - return EAndroidFileDownloaderVerdict.FAILED__DOWNLOAD_ALREADY_IN_PROGRESS; - } - if (remoteFilePath == null || remoteFilePath.isEmpty()) { - setState(EAndroidFileDownloaderState.ERROR); - fatalErrorOccurredAdvertisement("", "Target-file provided is dud!"); + onError("", "Target-file provided is dud!", null); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } - final String remoteFilePathSanitized = remoteFilePath.trim(); - if (remoteFilePathSanitized.endsWith("/")) //the path must point to a file not a directory + _remoteFilePathSanitized = remoteFilePath.trim(); + if (_remoteFilePathSanitized.endsWith("/")) //the path must point to a file not a directory { - setState(EAndroidFileDownloaderState.ERROR); - fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, "Provided target-path points to a directory not a file!"); + onError(_remoteFilePathSanitized, "Provided target-path points to a directory not a file", null); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } - if (!remoteFilePathSanitized.startsWith("/")) + if (!_remoteFilePathSanitized.startsWith("/")) { - setState(EAndroidFileDownloaderState.ERROR); - fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, "Provided target-path is not an absolute path!"); + onError(_remoteFilePathSanitized, "Provided target-path is not an absolute path", null); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } - if (initialMtuSize > 0) + if (!IsCold()) { - _transport.setInitialMtu(initialMtuSize); + onError(_remoteFilePathSanitized, "Another download is already in progress", null); + + return EAndroidFileDownloaderVerdict.FAILED__DOWNLOAD_ALREADY_IN_PROGRESS; } - _fileSystemManager = new FsManager(_transport); + if (_context == null) { + onError(_remoteFilePathSanitized, "No context specified - call trySetContext() first", null); - setLoggingEnabled(false); - requestHighConnectionPriority(); + return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; + } - setState(EAndroidFileDownloaderState.IDLE); - busyStateChangedAdvertisement(true); - fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); + if (_bluetoothDevice == null) { + onError(_remoteFilePathSanitized, "No bluetooth-device specified - call trySetBluetoothDevice() first", null); - _initialBytes = 0; - _remoteFilePathSanitized = remoteFilePathSanitized; + return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; + } + resetDownloadState(); //order must be called before ensureTransportIsInitializedExactlyOnce() because the environment might try to set the device via trySetBluetoothDevice()!!! + ensureTransportIsInitializedExactlyOnce(initialMtuSize); //order + + final EAndroidFileDownloaderVerdict verdict = ensureFilesystemManagerIsInitializedExactlyOnce(); //order + if (verdict != EAndroidFileDownloaderVerdict.SUCCESS) + return verdict; + + ensureFileDownloaderCallbackProxyIsInitializedExactlyOnce(); //order + + setLoggingEnabled(false); try { - _downloadingController = _fileSystemManager.fileDownload(remoteFilePathSanitized, new FileDownloaderCallbackProxy()); + _downloadingController = _fileSystemManager.fileDownload(_remoteFilePathSanitized, _fileDownloaderCallbackProxy); } catch (final Exception ex) { - setState(EAndroidFileDownloaderState.ERROR); - fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, ex.getMessage()); + onError(_remoteFilePathSanitized, "Failed to initialize download", ex); return EAndroidFileDownloaderVerdict.FAILED__ERROR_UPON_COMMENCING; } @@ -163,9 +217,62 @@ public void cancel() transferController.cancel(); //order } - private void requestHighConnectionPriority() + private void resetDownloadState() { + _initialBytes = 0; + _downloadStartTimestamp = 0; + + setState(EAndroidFileDownloaderState.IDLE); + busyStateChangedAdvertisement(true); + fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); + } + + private void ensureTransportIsInitializedExactlyOnce(int initialMtuSize) { - final McuMgrTransport mcuMgrTransporter = _fileSystemManager.getTransporter(); + if (_transport != null) + return; + + logMessageAdvertisement("[AFD.ETIIEO.010] (Re)Initializing transport: initial-mtu-size=" + initialMtuSize, "FileDownloader", "TRACE", _remoteFilePathSanitized); + + _transport = new McuMgrBleTransport(_context, _bluetoothDevice); + + if (initialMtuSize > 0) + { + _transport.setInitialMtu(initialMtuSize); + } + } + + private void ensureFileDownloaderCallbackProxyIsInitializedExactlyOnce() { + if (_fileDownloaderCallbackProxy != null) //already initialized + return; + + _fileDownloaderCallbackProxy = new FileDownloaderCallbackProxy(); + } + + private EAndroidFileDownloaderVerdict ensureFilesystemManagerIsInitializedExactlyOnce() { + if (_fileSystemManager != null) //already initialized + return EAndroidFileDownloaderVerdict.SUCCESS; + + logMessageAdvertisement("[AFD.EFMIIEO.010] (Re)Initializing filesystem-manager", "FileDownloader", "TRACE", _remoteFilePathSanitized); + + try + { + _fileSystemManager = new FsManager(_transport); //order + + requestHighConnectionPriority(_fileSystemManager); //order + } + catch (final Exception ex) + { + onError(_remoteFilePathSanitized, ex.getMessage(), ex); + + return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; + } + + return EAndroidFileDownloaderVerdict.SUCCESS; + } + + private void requestHighConnectionPriority(FsManager fileSystemManager) + { + final McuMgrTransport mcuMgrTransporter = fileSystemManager.getTransporter(); if (!(mcuMgrTransporter instanceof McuMgrBleTransport)) return; @@ -173,6 +280,39 @@ private void requestHighConnectionPriority() bleTransporter.requestConnPriority(ConnectionPriorityRequest.CONNECTION_PRIORITY_HIGH); } + private void disposeTransport() + { + if (_transport == null) + return; + + try { + _transport.disconnect(); + } catch (Exception ex) { + // ignore + } + + _transport = null; + } + + private void disposeFilesystemManager() + { + if (_fileSystemManager == null) + return; + + try { + _fileSystemManager.closeAll(); + } catch (McuMgrException e) { + // ignore + } + + _fileSystemManager = null; + } + + private void disposeCallbackProxy() + { + _fileDownloaderCallbackProxy = null; + } + private void setLoggingEnabled(final boolean enabled) { final McuMgrTransport mcuMgrTransporter = _fileSystemManager.getTransporter(); @@ -198,6 +338,21 @@ private void setState(final EAndroidFileDownloaderState newState) //00 trivial hotfix to deal with the fact that the filedownload progress% doesnt fill up to 100% } + @Contract(pure = true) + private boolean IsIdleOrCold() + { + return _currentState == EAndroidFileDownloaderState.IDLE || IsCold(); + } + + @Contract(pure = true) + private boolean IsCold() + { + return _currentState == EAndroidFileDownloaderState.NONE + || _currentState == EAndroidFileDownloaderState.ERROR + || _currentState == EAndroidFileDownloaderState.COMPLETE + || _currentState == EAndroidFileDownloaderState.CANCELLED; + } + private String _lastFatalErrorMessage; @Contract(pure = true) @@ -206,6 +361,31 @@ public String getLastFatalErrorMessage() return _lastFatalErrorMessage; } + //@Contract(pure = true) //dont + public void onError( + final String remoteFilePath, + final String errorMessage, + final Exception exception + ) + { + setState(EAndroidFileDownloaderState.ERROR); + + if (!(exception instanceof McuMgrErrorException)) + { + fatalErrorOccurredAdvertisement(remoteFilePath, errorMessage /*, -1, -1*/); + return; + } + + McuMgrErrorException mcuMgrErrorException = (McuMgrErrorException) exception; + fatalErrorOccurredAdvertisement( + remoteFilePath, + errorMessage + // ,mcuMgrErrorException.getCode().value(), //todo and mirror this in the ios world as well + // (mcuMgrErrorException.getGroupCode() != null ? mcuMgrErrorException.getGroupCode().group : -99) //todo + ); + } + + //todo add support for mcuMgrErrorCode and fsManagerGroupReturnCode public void fatalErrorOccurredAdvertisement(final String resource, final String errorMessage) //this method is meant to be overridden by csharp binding libraries to intercept updates { _lastFatalErrorMessage = errorMessage; @@ -290,13 +470,14 @@ public void onDownloadProgressChanged(final int bytesSent, final int fileSize, f } @Override - public void onDownloadFailed(@NonNull final McuMgrException error) + public void onDownloadFailed(@NonNull final McuMgrException exception) { fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); - setState(EAndroidFileDownloaderState.ERROR); - fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, error.getMessage()); + onError(_remoteFilePathSanitized, exception.getMessage(), exception); setLoggingEnabled(true); busyStateChangedAdvertisement(false); + + _downloadingController = null; //game over } @Override @@ -307,6 +488,8 @@ public void onDownloadCanceled() cancelledAdvertisement(); setLoggingEnabled(true); busyStateChangedAdvertisement(false); + + _downloadingController = null; //game over } @Override @@ -319,6 +502,8 @@ public void onDownloadCompleted(byte @NotNull [] data) setLoggingEnabled(true); busyStateChangedAdvertisement(false); + + _downloadingController = null; //game over } } } From b08ad28c7da0d79927fda7ac27a1b087b42b6b28 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 17:08:29 +0200 Subject: [PATCH 067/104] clean (AndroidFileDownloader.java): simplify calls to onError() to improve code-readability --- .../AndroidFileDownloader.java | 33 ++++++++++--------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index 37183d9a..da770d23 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -105,7 +105,7 @@ public EAndroidFileDownloaderVerdict beginDownload( ) { if (remoteFilePath == null || remoteFilePath.isEmpty()) { - onError("", "Target-file provided is dud!", null); + onError("Target-file provided is dud!"); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } @@ -113,33 +113,33 @@ public EAndroidFileDownloaderVerdict beginDownload( _remoteFilePathSanitized = remoteFilePath.trim(); if (_remoteFilePathSanitized.endsWith("/")) //the path must point to a file not a directory { - onError(_remoteFilePathSanitized, "Provided target-path points to a directory not a file", null); + onError("Provided target-path points to a directory not a file"); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } if (!_remoteFilePathSanitized.startsWith("/")) { - onError(_remoteFilePathSanitized, "Provided target-path is not an absolute path", null); + onError("Provided target-path is not an absolute path"); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } if (!IsCold()) { - onError(_remoteFilePathSanitized, "Another download is already in progress", null); + onError("Another download is already in progress"); return EAndroidFileDownloaderVerdict.FAILED__DOWNLOAD_ALREADY_IN_PROGRESS; } if (_context == null) { - onError(_remoteFilePathSanitized, "No context specified - call trySetContext() first", null); + onError("No context specified - call trySetContext() first"); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } if (_bluetoothDevice == null) { - onError(_remoteFilePathSanitized, "No bluetooth-device specified - call trySetBluetoothDevice() first", null); + onError("No bluetooth-device specified - call trySetBluetoothDevice() first"); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } @@ -160,7 +160,7 @@ public EAndroidFileDownloaderVerdict beginDownload( } catch (final Exception ex) { - onError(_remoteFilePathSanitized, "Failed to initialize download", ex); + onError("Failed to initialize download", ex); return EAndroidFileDownloaderVerdict.FAILED__ERROR_UPON_COMMENCING; } @@ -262,7 +262,7 @@ private EAndroidFileDownloaderVerdict ensureFilesystemManagerIsInitializedExactl } catch (final Exception ex) { - onError(_remoteFilePathSanitized, ex.getMessage(), ex); + onError(ex.getMessage(), ex); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } @@ -361,24 +361,25 @@ public String getLastFatalErrorMessage() return _lastFatalErrorMessage; } + public void onError(final String errorMessage) + { + onError(errorMessage, null); + } + //@Contract(pure = true) //dont - public void onError( - final String remoteFilePath, - final String errorMessage, - final Exception exception - ) + public void onError(final String errorMessage, final Exception exception) { setState(EAndroidFileDownloaderState.ERROR); if (!(exception instanceof McuMgrErrorException)) { - fatalErrorOccurredAdvertisement(remoteFilePath, errorMessage /*, -1, -1*/); + fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, errorMessage /*, -1, -1*/); return; } McuMgrErrorException mcuMgrErrorException = (McuMgrErrorException) exception; fatalErrorOccurredAdvertisement( - remoteFilePath, + _remoteFilePathSanitized, errorMessage // ,mcuMgrErrorException.getCode().value(), //todo and mirror this in the ios world as well // (mcuMgrErrorException.getGroupCode() != null ? mcuMgrErrorException.getGroupCode().group : -99) //todo @@ -473,7 +474,7 @@ public void onDownloadProgressChanged(final int bytesSent, final int fileSize, f public void onDownloadFailed(@NonNull final McuMgrException exception) { fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); - onError(_remoteFilePathSanitized, exception.getMessage(), exception); + onError(exception.getMessage(), exception); setLoggingEnabled(true); busyStateChangedAdvertisement(false); From 172cdf3ae061ef4ba94a98b224fac9fb5511831c Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 17:08:48 +0200 Subject: [PATCH 068/104] clean (AndroidFileUploader.java): simplify calls to onError() to improve code-readability --- .../AndroidFileUploader.java | 35 ++++++++++--------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index cbacd404..766cf375 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -109,7 +109,7 @@ public EAndroidFileUploaderVerdict beginUpload( ) { if (remoteFilePath == null || remoteFilePath.isEmpty()) { - onError("N/A", "Provided target-path is empty", null); + onError("Provided target-path is empty", null); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } @@ -117,38 +117,38 @@ public EAndroidFileUploaderVerdict beginUpload( _remoteFilePathSanitized = remoteFilePath.trim(); if (_remoteFilePathSanitized.endsWith("/")) //the path must point to a file not a directory { - onError(_remoteFilePathSanitized, "Provided target-path points to a directory not a file", null); + onError("Provided target-path points to a directory not a file"); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } if (!_remoteFilePathSanitized.startsWith("/")) { - onError(_remoteFilePathSanitized, "Provided target-path is not an absolute path", null); + onError("Provided target-path is not an absolute path"); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } if (!IsCold()) { - onError(_remoteFilePathSanitized, "Another upload is already in progress", null); + onError("Another upload is already in progress"); return EAndroidFileUploaderVerdict.FAILED__OTHER_UPLOAD_ALREADY_IN_PROGRESS; } if (_context == null) { - onError(_remoteFilePathSanitized, "No context specified - call trySetContext() first", null); + onError("No context specified - call trySetContext() first"); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } if (_bluetoothDevice == null) { - onError(_remoteFilePathSanitized, "No bluetooth-device specified - call trySetBluetoothDevice() first", null); + onError("No bluetooth-device specified - call trySetBluetoothDevice() first"); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } if (data == null) { // data being null is not ok but data.length==0 is perfectly ok because we might want to create empty files - onError(_remoteFilePathSanitized, "Provided data is null", null); + onError("Provided data is null"); return EAndroidFileUploaderVerdict.FAILED__INVALID_DATA; } @@ -178,7 +178,7 @@ public EAndroidFileUploaderVerdict beginUpload( } catch (final Exception ex) { - onError(_remoteFilePathSanitized, "Failed to initialize the upload", ex); + onError("Failed to initialize the upload", ex); return EAndroidFileUploaderVerdict.FAILED__ERROR_UPON_COMMENCING; } @@ -234,7 +234,7 @@ private EAndroidFileUploaderVerdict ensureFilesystemManagerIsInitializedExactlyO } catch (final Exception ex) { - onError(_remoteFilePathSanitized, ex.getMessage(), ex); + onError("[AFU.EFMIIEO.010] Failed to initialize the native file-system-manager", ex); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } @@ -385,24 +385,25 @@ public String getLastFatalErrorMessage() return _lastFatalErrorMessage; } + private void onError(final String errorMessage) + { + onError(errorMessage, null); + } + //@Contract(pure = true) //dont - public void onError( - final String remoteFilePath, - final String errorMessage, - final Exception exception - ) + private void onError(final String errorMessage, final Exception exception) { setState(EAndroidFileUploaderState.ERROR); //keep first if (!(exception instanceof McuMgrErrorException)) { - fatalErrorOccurredAdvertisement(remoteFilePath, errorMessage, -1, -1); // -1 values get mapped to the 'generic' error code + fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, errorMessage, -1, -1); // -1 values get mapped to the 'generic' error code return; } McuMgrErrorException mcuMgrErrorException = (McuMgrErrorException) exception; fatalErrorOccurredAdvertisement( - remoteFilePath, + _remoteFilePathSanitized, errorMessage, mcuMgrErrorException.getCode().value(), (mcuMgrErrorException.getGroupCode() != null ? mcuMgrErrorException.getGroupCode().group : -99) @@ -495,7 +496,7 @@ public void onUploadProgressChanged(final int bytesSent, final int fileSize, fin public void onUploadFailed(@NonNull final McuMgrException error) { fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); - onError(_remoteFilePathSanitized, error.getMessage(), error); + onError(error.getMessage(), error); setLoggingEnabled(true); busyStateChangedAdvertisement(false); From 073b06839a98a53c415b74a256ae2211cd752f10 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 17:09:40 +0200 Subject: [PATCH 069/104] clean (AndroidFileUploader.java): _remoteFilePathSanitized is now set to the empty string "" by default --- .../no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 766cf375..2b7ef77d 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -27,7 +27,7 @@ public class AndroidFileUploader private int _initialBytes; private long _uploadStartTimestamp; - private String _remoteFilePathSanitized; + private String _remoteFilePathSanitized = ""; private EAndroidFileUploaderState _currentState = EAndroidFileUploaderState.NONE; public AndroidFileUploader() //this flavour is meant to be used in conjunction with trySetBluetoothDevice() and trySetContext() From c60b1087b7e1e6b9ee754276725a226d53d396f3 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 17:15:03 +0200 Subject: [PATCH 070/104] fix (gradle.properties): suppress a warning about android-sdk 34 not being fully compatible with gradle 7.6 --- Laerdal.McuMgr.Bindings.Android.Native/gradle.properties | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/gradle.properties b/Laerdal.McuMgr.Bindings.Android.Native/gradle.properties index ab4b134e..123e09cf 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/gradle.properties +++ b/Laerdal.McuMgr.Bindings.Android.Native/gradle.properties @@ -19,7 +19,9 @@ android.useAndroidX=true # resources declared in the library itself and none from the library's dependencies, # thereby reducing the size of the R class for that library android.nonTransitiveRClass=true -# in macos just comment this one out +# as long as we use gradle 7.6 we will get warnings if we try to build against android 34 or above we suppress such warnings +android.suppressUnsupportedCompileSdk=34 +# in macos just comment out the windows paths and keep the homebrew path # org.gradle.java.home=C/://Program Files//Microsoft//jdk-11.0.15.10-hotspot # org.gradle.java.home=C://Program Files//OpenJDK//jdk-17.0.2 org.gradle.java.home=/opt/homebrew/opt/openjdk@17 From d0ef7c8121446acbd4094075098ab4da6a804e7e Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 17:38:30 +0200 Subject: [PATCH 071/104] revert (AndroidFileDownloader.java, AndroidFileUploader.java): we now again check if these classes are "cold" first when invoking their respective BeginDownload() / BeginUpload() methods --- .../AndroidFileDownloader.java | 14 +++++++------- .../AndroidFileUploader.java | 12 ++++++------ 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index da770d23..1dc09d40 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -104,6 +104,13 @@ public EAndroidFileDownloaderVerdict beginDownload( // final int memoryAlignment //this doesnt make sense for downloading it only makes sense in uploading scenarios https://github.com/NordicSemiconductor/Android-nRF-Connect-Device-Manager/issues/188#issuecomment-2391146897 ) { + if (!IsCold()) //keep first + { + onError("Another download is already in progress"); + + return EAndroidFileDownloaderVerdict.FAILED__DOWNLOAD_ALREADY_IN_PROGRESS; + } + if (remoteFilePath == null || remoteFilePath.isEmpty()) { onError("Target-file provided is dud!"); @@ -125,13 +132,6 @@ public EAndroidFileDownloaderVerdict beginDownload( return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } - if (!IsCold()) - { - onError("Another download is already in progress"); - - return EAndroidFileDownloaderVerdict.FAILED__DOWNLOAD_ALREADY_IN_PROGRESS; - } - if (_context == null) { onError("No context specified - call trySetContext() first"); diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 2b7ef77d..f3277a13 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -108,6 +108,12 @@ public EAndroidFileUploaderVerdict beginUpload( final int memoryAlignment ) { + if (!IsCold()) { //keep first + onError("Another upload is already in progress"); + + return EAndroidFileUploaderVerdict.FAILED__OTHER_UPLOAD_ALREADY_IN_PROGRESS; + } + if (remoteFilePath == null || remoteFilePath.isEmpty()) { onError("Provided target-path is empty", null); @@ -129,12 +135,6 @@ public EAndroidFileUploaderVerdict beginUpload( return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } - if (!IsCold()) { - onError("Another upload is already in progress"); - - return EAndroidFileUploaderVerdict.FAILED__OTHER_UPLOAD_ALREADY_IN_PROGRESS; - } - if (_context == null) { onError("No context specified - call trySetContext() first"); From 3ea6401186a498502cd9935b7818c0d2a407eba8 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 18:25:28 +0200 Subject: [PATCH 072/104] refa (IOSFileUploader.swift): trivial neutral refactoring to improve readability --- .../McuMgrBindingsiOS/IOSFileUploader.swift | 73 +++++++++---------- 1 file changed, 34 insertions(+), 39 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift index 522583a6..333269ba 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift @@ -7,14 +7,14 @@ public class IOSFileUploader: NSObject { private let _listener: IOSListenerForFileUploader! private var _transporter: McuMgrBleTransport! private var _cbPeripheral: CBPeripheral! - private var _currentState: EIOSFileUploaderState = .none private var _fileSystemManager: FileSystemManager! - private var _cancellationReason: String = "" - private var _lastFatalErrorMessage: String = "" - private var _remoteFilePathSanitized: String! + private var _currentState: EIOSFileUploaderState = .none private var _lastBytesSend: Int = 0 + private var _cancellationReason: String = "" + private var _lastFatalErrorMessage: String = "" private var _lastBytesSendTimestamp: Date? = nil + private var _remoteFilePathSanitized: String! @objc public init(_ listener: IOSListenerForFileUploader!) { @@ -29,7 +29,7 @@ public class IOSFileUploader: NSObject { @objc public func trySetBluetoothDevice(_ cbPeripheral: CBPeripheral!) -> Bool { - if !IsIdleOrCold() { + if !isIdleOrCold() { return false } @@ -47,7 +47,7 @@ public class IOSFileUploader: NSObject { return true } - if !IsIdleOrCold() { //if the upload is already in progress we bail out + if !isIdleOrCold() { //if the upload is already in progress we bail out return false } @@ -65,65 +65,60 @@ public class IOSFileUploader: NSObject { _ byteAlignment: Int ) -> EIOSFileUploadingInitializationVerdict { - if !IsCold() { //if another upload is already in progress we bail out - setState(EIOSFileUploaderState.error) + if !isCold() { //keep first if another upload is already in progress we bail out onError("Another upload is already in progress") return EIOSFileUploadingInitializationVerdict.failedOtherUploadAlreadyInProgress } - if _cbPeripheral == nil { - setState(EIOSFileUploaderState.error) - onError("No bluetooth-device specified - call trySetBluetoothDevice() first"); - - return EIOSFileUploadingInitializationVerdict.failedInvalidSettings; - } - - if (pipelineDepth >= 2 && byteAlignment <= 1) { - setState(EIOSFileUploaderState.error) - onError("When pipeline-depth is set to 2 or above you must specify a byte-alignment >=2 (given byte-alignment is '\(byteAlignment)')") - - return .failedInvalidSettings - } - - let byteAlignmentEnum = translateByteAlignmentMode(byteAlignment); - if (byteAlignmentEnum == nil) { - setState(EIOSFileUploaderState.error) - onError("Invalid byte-alignment value '\(byteAlignment)': It must be a power of 2 up to 16") - - return .failedInvalidSettings - } - _remoteFilePathSanitized = remoteFilePath.trimmingCharacters(in: .whitespacesAndNewlines) if _remoteFilePathSanitized.isEmpty { - setState(EIOSFileUploaderState.error) onError("Target-file provided is dud") return EIOSFileUploadingInitializationVerdict.failedInvalidSettings } if _remoteFilePathSanitized.hasSuffix("/") { - setState(EIOSFileUploaderState.error) onError("Target-file points to a directory instead of a file") return EIOSFileUploadingInitializationVerdict.failedInvalidSettings } if !_remoteFilePathSanitized.hasPrefix("/") { - setState(EIOSFileUploaderState.error) onError("Target-path is not absolute!") return EIOSFileUploadingInitializationVerdict.failedInvalidSettings } if data == nil { // data being nil is not ok btw data.length==0 is perfectly ok because we might want to create empty files + onError("The data provided are nil") + return EIOSFileUploadingInitializationVerdict.failedInvalidData } + if _cbPeripheral == nil { + onError("No bluetooth-device specified - call trySetBluetoothDevice() first"); + + return EIOSFileUploadingInitializationVerdict.failedInvalidSettings; + } + + if (pipelineDepth >= 2 && byteAlignment <= 1) { + onError("When pipeline-depth is set to 2 or above you must specify a byte-alignment >=2 (given byte-alignment is '\(byteAlignment)')") + + return .failedInvalidSettings + } + + let byteAlignmentEnum = translateByteAlignmentMode(byteAlignment); + if (byteAlignmentEnum == nil) { + onError("Invalid byte-alignment value '\(byteAlignment)': It must be a power of 2 up to 16") + + return .failedInvalidSettings + } + + resetUploadState() //order disposeFilesystemManager() //00 vital hack ensureTransportIsInitializedExactlyOnce() //order ensureFilesystemManagerIsInitializedExactlyOnce() //order - resetUploadState() //order var configuration = FirmwareUpgradeConfiguration(byteAlignment: byteAlignmentEnum!) if (pipelineDepth >= 0) { @@ -137,7 +132,6 @@ public class IOSFileUploader: NSObject { delegate: self ) if !success { - setState(EIOSFileUploaderState.error) onError("Failed to commence file-uploading (check logs for details)") return EIOSFileUploadingInitializationVerdict.failedErrorUponCommencing @@ -239,11 +233,11 @@ public class IOSFileUploader: NSObject { _fileSystemManager = nil } - private func IsIdleOrCold() -> Bool { - return _currentState == EIOSFileUploaderState.idle || IsCold(); + private func isIdleOrCold() -> Bool { + return _currentState == EIOSFileUploaderState.idle || isCold(); } - private func IsCold() -> Bool { + private func isCold() -> Bool { return _currentState == EIOSFileUploaderState.none || _currentState == EIOSFileUploaderState.error || _currentState == EIOSFileUploaderState.complete @@ -252,6 +246,8 @@ public class IOSFileUploader: NSObject { //@objc dont private func onError(_ errorMessage: String, _ error: Error? = nil) { + setState(EIOSFileUploaderState.error) //keep first + _lastFatalErrorMessage = errorMessage let (errorCode, _) = deduceErrorCode(errorMessage) @@ -369,7 +365,6 @@ extension IOSFileUploader: FileUploadDelegate { } public func uploadDidFail(with error: Error) { - setState(EIOSFileUploaderState.error) onError(error.localizedDescription, error) busyStateChangedAdvertisement(false) } From 5b52b8edc083b8658055711dca2b0cf8a0a63e5b Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 18:27:30 +0200 Subject: [PATCH 073/104] refa (IOSFileDownloader.swift): add support for trySetBluetoothDevice() and tryInvalidateCachedTransport() similar to the IOSFileUploader --- .../AndroidFileDownloader.java | 16 +- .../McuMgrBindingsiOS/IOSFileDownloader.swift | 191 ++++++++++++++---- .../IOSListenerForFileDownloader.swift | 3 +- ...uccessfully_GivenVariousFilesToDownload.cs | 8 +- ...ToFailsafeSettings_GivenFlakyConnection.cs | 9 +- ...essfully_GivenGreenNativeFileDownloader.cs | 4 +- ...ailedException_GivenFatalErrorMidflight.cs | 4 +- ...dException_GivenRogueNativeErrorMessage.cs | 4 +- ...FoundException_GivenNonExistentFilepath.cs | 6 +- .../FileDownloader/FileDownloaderTestbed.cs | 11 +- ...uccessfully_GivenVariousFilesToDownload.cs | 6 +- ...ToFailsafeSettings_GivenFlakyConnection.cs | 24 +-- ...essfully_GivenGreenNativeFileDownloader.cs | 2 +- ...ldCompleteSuccessfully_GivenGreenStream.cs | 2 +- ...ailedException_GivenFatalErrorMidflight.cs | 2 +- ...dException_GivenRogueNativeErrorMessage.cs | 2 +- ...FoundException_GivenNonExistentFilepath.cs | 2 +- ...ion_GivenAccessDeniedNativeErrorMessage.cs | 2 +- .../FileUploader/FileUploaderTestbed.cs | 2 +- .../Droid/FileDownloader/FileDownloader.cs | 38 +++- .../Droid/FileUploader/FileUploader.cs | 4 +- .../Events/FatalErrorOccurredEventArgs.cs | 10 +- .../INativeFileDownloaderCallbacksProxy.cs | 3 +- .../INativeFileDownloaderCommandableProxy.cs | 4 + .../Shared/FileDownloader/FileDownloader.cs | 5 +- ...de.cs => EFileOperationGroupReturnCode.cs} | 2 +- .../Events/FatalErrorOccurredEventArgs.cs | 4 +- .../Exceptions/UploadErroredOutException.cs | 4 +- ...ErroredOutRemoteFolderNotFoundException.cs | 2 +- .../Exceptions/UploadUnauthorizedException.cs | 4 +- .../INativeFileUploaderCallbacksProxy.cs | 2 +- .../Shared/FileUploader/FileUploader.cs | 2 +- .../iOS/FileDownloader/FileDownloader.cs | 33 ++- .../iOS/FileUploader/FileUploader.cs | 4 +- 34 files changed, 314 insertions(+), 107 deletions(-) rename Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/{EFileUploaderGroupReturnCode.cs => EFileOperationGroupReturnCode.cs} (92%) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index 1dc09d40..baca99b9 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -373,21 +373,25 @@ public void onError(final String errorMessage, final Exception exception) if (!(exception instanceof McuMgrErrorException)) { - fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, errorMessage /*, -1, -1*/); + fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, errorMessage, -1, -1); return; } McuMgrErrorException mcuMgrErrorException = (McuMgrErrorException) exception; fatalErrorOccurredAdvertisement( _remoteFilePathSanitized, - errorMessage - // ,mcuMgrErrorException.getCode().value(), //todo and mirror this in the ios world as well - // (mcuMgrErrorException.getGroupCode() != null ? mcuMgrErrorException.getGroupCode().group : -99) //todo + errorMessage, + mcuMgrErrorException.getCode().value(), + (mcuMgrErrorException.getGroupCode() != null ? mcuMgrErrorException.getGroupCode().group : -99) ); } - //todo add support for mcuMgrErrorCode and fsManagerGroupReturnCode - public void fatalErrorOccurredAdvertisement(final String resource, final String errorMessage) //this method is meant to be overridden by csharp binding libraries to intercept updates + public void fatalErrorOccurredAdvertisement( + final String remoteFilePath, + final String errorMessage, + final int mcuMgrErrorCode, // io.runtime.mcumgr.McuMgrErrorCode + final int fsManagerGroupReturnCode // io.runtime.mcumgr.managers.FsManager.ReturnCode + ) { _lastFatalErrorMessage = errorMessage; } diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift index cc207b47..547bcc3f 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift @@ -6,68 +6,92 @@ public class IOSFileDownloader: NSObject { private var _listener: IOSListenerForFileDownloader! private var _transporter: McuMgrBleTransport! - private var _currentState: EIOSFileDownloaderState + private var _cbPeripheral: CBPeripheral! private var _fileSystemManager: FileSystemManager! - private var _lastFatalErrorMessage: String + private var _currentState: EIOSFileDownloaderState = .none private var _lastBytesSend: Int = -1 + private var _lastFatalErrorMessage: String = "" private var _lastBytesSendTimestamp: Date? = nil - private var _remoteFilePathSanitized: String + private var _remoteFilePathSanitized: String = "" + + @objc + public init(_ listener: IOSListenerForFileDownloader!) { + _listener = listener + } @objc public init(_ cbPeripheral: CBPeripheral!, _ listener: IOSListenerForFileDownloader!) { _listener = listener - _transporter = McuMgrBleTransport(cbPeripheral) - _currentState = .none - _lastFatalErrorMessage = "" - _remoteFilePathSanitized = "" + _cbPeripheral = cbPeripheral + } + + @objc + public func trySetBluetoothDevice(_ cbPeripheral: CBPeripheral!) -> Bool { + if !isIdleOrCold() { + return false + } + + if !tryInvalidateCachedTransport() { //order + return false + } + + _cbPeripheral = cbPeripheral //order + return true + } + + @objc + public func tryInvalidateCachedTransport() -> Bool { + if _transporter == nil { //already scrapped + return true + } + + if !isIdleOrCold() { //if the upload is already in progress we bail out + return false + } + + disposeFilesystemManager() // order + disposeTransport() // order + + return true; } @objc public func beginDownload(_ remoteFilePath: String) -> EIOSFileDownloadingInitializationVerdict { - if _currentState != .none - && _currentState != .error - && _currentState != .complete - && _currentState != .cancelled { //if another download is already in progress we bail out + + if !isCold() { //keep first if another download is already in progress we bail out + onError("Another download is already in progress") + return EIOSFileDownloadingInitializationVerdict.failedDownloadAlreadyInProgress } - _lastBytesSend = -1 - _lastBytesSendTimestamp = nil - - if remoteFilePath.trimmingCharacters(in: .whitespacesAndNewlines).isEmpty { - setState(EIOSFileDownloaderState.error) - fatalErrorOccurredAdvertisement("", "Target-file provided is dud!") + _remoteFilePathSanitized = remoteFilePath.trimmingCharacters(in: .whitespacesAndNewlines) + if _remoteFilePathSanitized.isEmpty { + onError("Target-file provided is dud!") return EIOSFileDownloadingInitializationVerdict.failedInvalidSettings } - if remoteFilePath.hasSuffix("/") { - setState(EIOSFileDownloaderState.error) - fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, "Target-file points to a directory instead of a file") + if _remoteFilePathSanitized.hasSuffix("/") { + onError("Target-file points to a directory instead of a file") return EIOSFileDownloadingInitializationVerdict.failedInvalidSettings } - if !remoteFilePath.hasPrefix("/") { - setState(EIOSFileDownloaderState.error) - fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, "Target-path is not absolute!") + if !_remoteFilePathSanitized.hasPrefix("/") { + onError("Target-path is not absolute!") return EIOSFileDownloadingInitializationVerdict.failedInvalidSettings } - _fileSystemManager = FileSystemManager(transport: _transporter) // the delegate aspect is implemented in the extension below - _fileSystemManager.logDelegate = self + resetUploadState() //order + disposeFilesystemManager() //00 vital hack + ensureTransportIsInitializedExactlyOnce() //order + ensureFilesystemManagerIsInitializedExactlyOnce() //order - setState(EIOSFileDownloaderState.idle) - busyStateChangedAdvertisement(true) - fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0) - - _remoteFilePathSanitized = remoteFilePath - let success = _fileSystemManager.download(name: remoteFilePath, delegate: self) + let success = _fileSystemManager.download(name: _remoteFilePathSanitized, delegate: self) if !success { - setState(EIOSFileDownloaderState.error) - fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, "Failed to commence file-Downloading (check logs for details)") + onError("Failed to commence file-Downloading (check logs for details)") return EIOSFileDownloadingInitializationVerdict.failedErrorUponCommencing } @@ -106,11 +130,102 @@ public class IOSFileDownloader: NSObject { _transporter?.close() } + private func isIdleOrCold() -> Bool { + return _currentState == EIOSFileDownloaderState.idle || isCold(); + } + + private func isCold() -> Bool { + return _currentState == EIOSFileDownloaderState.none + || _currentState == EIOSFileDownloaderState.error + || _currentState == EIOSFileDownloaderState.complete + || _currentState == EIOSFileDownloaderState.cancelled + } + + private func resetUploadState() { + _lastBytesSend = -1 + _lastBytesSendTimestamp = nil + + setState(EIOSFileDownloaderState.idle) + busyStateChangedAdvertisement(true) + fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0) + } + + private func ensureFilesystemManagerIsInitializedExactlyOnce() { + if _fileSystemManager != nil { //already initialized + return + } + + _fileSystemManager = FileSystemManager(transport: _transporter) //00 + _fileSystemManager.logDelegate = self //00 + + //00 this doesnt throw an error the log-delegate aspect is implemented in the extension below via IOSFileDownloader: McuMgrLogDelegate + } + + private func ensureTransportIsInitializedExactlyOnce() { + if _transporter != nil { + return + } + + _transporter = McuMgrBleTransport(_cbPeripheral) + } + + private func disposeTransport() { + _transporter?.close() + _transporter = nil + } + + private func disposeFilesystemManager() { + //_fileSystemManager?.cancelTransfer() dont + _fileSystemManager = nil + } + //@objc dont - private func fatalErrorOccurredAdvertisement(_ resource: String, _ errorMessage: String) { + private func onError(_ errorMessage: String, _ error: Error? = nil) { + setState(EIOSFileDownloaderState.error) //keep first + _lastFatalErrorMessage = errorMessage - _listener.fatalErrorOccurredAdvertisement(resource, errorMessage) + let (errorCode, _) = deduceErrorCode(errorMessage) + + _listener.fatalErrorOccurredAdvertisement( + _remoteFilePathSanitized, + errorMessage, + errorCode + ) + } + + // unfortunately I couldnt figure out a way to deduce the error code from the error itself so I had to resort to string sniffing ugly but it works + private func deduceErrorCode(_ errorMessage: String) -> (Int, String?) { + let (matchesArray, possibleError) = matches(for: " [(]\\d+[)][.]?$", in: errorMessage) // "UNKNOWN (1)." + if possibleError != nil { + return (-99, possibleError) + } + + let errorCode = matchesArray.isEmpty + ? -99 + : (Int(matchesArray[0].trimmingCharacters(in: .whitespaces).trimmingCharacters(in: ["(", ")", "."]).trimmingCharacters(in: .whitespaces)) ?? 0) + + return (errorCode, possibleError) + } + + private func matches(for regex: String, in text: String) -> ([String], String?) { //00 + do { + let regex = try NSRegularExpression(pattern: regex) + let results = regex.matches(in: text, range: NSRange(text.startIndex..., in: text)) + + return ( + results.map { + String(text[Range($0.range, in: text)!]) + }, + nil + ) + } catch let error { + print("invalid regex: \(error.localizedDescription)") + + return ([], error.localizedDescription) + } + + //00 https://stackoverflow.com/a/27880748/863651 } //@objc dont @@ -143,7 +258,7 @@ public class IOSFileDownloader: NSObject { ) { _listener.fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage, averageThroughput) } - + //@objc dont private func downloadCompletedAdvertisement(_ resource: String, _ data: [UInt8]) { _listener.downloadCompletedAdvertisement(resource, data) @@ -178,8 +293,8 @@ extension IOSFileDownloader: FileDownloadDelegate { } public func downloadDidFail(with error: Error) { - setState(EIOSFileDownloaderState.error) - fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, error.localizedDescription) + onError(error.localizedDescription, error) + busyStateChangedAdvertisement(false) } diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileDownloader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileDownloader.swift index 62d9ea0c..0275d8e9 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileDownloader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileDownloader.swift @@ -3,9 +3,10 @@ import Foundation @objc public protocol IOSListenerForFileDownloader { func logMessageAdvertisement(_ message: String, _ category: String, _ level: String, _ resource: String) - func fatalErrorOccurredAdvertisement(_ resource: String, _ errorMessage: String) + func fatalErrorOccurredAdvertisement(_ resource: String, _ errorMessage: String, _ errorCode: Int) func cancelledAdvertisement() + func stateChangedAdvertisement(_ resource: String, _ oldState: EIOSFileDownloaderState, _ newState: EIOSFileDownloaderState) func busyStateChangedAdvertisement(_ busyNotIdle: Bool) func downloadCompletedAdvertisement(_ resource: String, _ data: [UInt8]) diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index e1cf813e..e2b4938a 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -1,7 +1,9 @@ using FluentAssertions; using FluentAssertions.Extensions; +using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.FileDownloader.Contracts.Enums; using Laerdal.McuMgr.FileDownloader.Contracts.Native; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; using GenericNativeFileDownloaderCallbacksProxy_ = Laerdal.McuMgr.FileDownloader.FileDownloader.GenericNativeFileDownloaderCallbacksProxy; #pragma warning disable xUnit1026 @@ -100,18 +102,18 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? if (remoteFilePathUppercase.Contains("some/file/that/exist/but/is/erroring/out/when/we/try/to/download/it.bin".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, oldState: EFileDownloaderState.Downloading, newState: EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "foobar"); + FatalErrorOccurredAdvertisement(remoteFilePath, "foobar", EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); } else if (remoteFilePathUppercase.Contains("some/file/that/doesnt/exist.bin".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, oldState: EFileDownloaderState.Downloading, newState: EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "NO ENTRY (5)"); + FatalErrorOccurredAdvertisement(remoteFilePath, "NO ENTRY (5)", EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); } else if (remoteFilePathUppercase.Contains("some/file/that/exist/and/completes/after/a/couple/of/attempts.bin".ToUpperInvariant()) && _retryCountForProblematicFile++ < 3) { StateChangedAdvertisement(remoteFilePath, oldState: EFileDownloaderState.Downloading, newState: EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "ping pong"); + FatalErrorOccurredAdvertisement(remoteFilePath, "ping pong", EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); } else { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index 3716a16a..b430aad8 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -6,6 +6,7 @@ using Laerdal.McuMgr.FileDownloader.Contracts.Enums; using Laerdal.McuMgr.FileDownloader.Contracts.Events; using Laerdal.McuMgr.FileDownloader.Contracts.Native; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; using GenericNativeFileDownloaderCallbacksProxy_ = Laerdal.McuMgr.FileDownloader.FileDownloader.GenericNativeFileDownloaderCallbacksProxy; #pragma warning disable xUnit1026 @@ -126,16 +127,16 @@ public override EFileDownloaderVerdict BeginDownload( if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize) { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected); // order + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); // order return; } if (_tryCounter < _maxTriesCount) { await Task.Delay(20); - StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred"); // order + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); // order return; } diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index 887c797f..51acc402 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -1,8 +1,10 @@ using FluentAssertions; using FluentAssertions.Extensions; +using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.FileDownloader.Contracts.Enums; using Laerdal.McuMgr.FileDownloader.Contracts.Events; using Laerdal.McuMgr.FileDownloader.Contracts.Native; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; using GenericNativeFileDownloaderCallbacksProxy_ = Laerdal.McuMgr.FileDownloader.FileDownloader.GenericNativeFileDownloaderCallbacksProxy; #pragma warning disable xUnit1026 @@ -102,7 +104,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? if (_tryCount < _maxNumberOfTriesForSuccess) { StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred"); + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); return; } diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs index 62d54476..ca937bcd 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs @@ -1,11 +1,13 @@ using System.Diagnostics.CodeAnalysis; using FluentAssertions; using FluentAssertions.Extensions; +using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Helpers; using Laerdal.McuMgr.FileDownloader.Contracts.Enums; using Laerdal.McuMgr.FileDownloader.Contracts.Events; using Laerdal.McuMgr.FileDownloader.Contracts.Exceptions; using Laerdal.McuMgr.FileDownloader.Contracts.Native; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; using GenericNativeFileDownloaderCallbacksProxy_ = Laerdal.McuMgr.FileDownloader.FileDownloader.GenericNativeFileDownloaderCallbacksProxy; namespace Laerdal.McuMgr.Tests.FileDownloader @@ -87,7 +89,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? await Task.Delay(2_000); StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred"); + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.BadState, EFileOperationGroupReturnCode.Unset); }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs index 742a7352..439de183 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs @@ -1,11 +1,13 @@ using System.Diagnostics.CodeAnalysis; using FluentAssertions; using FluentAssertions.Extensions; +using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Helpers; using Laerdal.McuMgr.FileDownloader.Contracts.Enums; using Laerdal.McuMgr.FileDownloader.Contracts.Events; using Laerdal.McuMgr.FileDownloader.Contracts.Exceptions; using Laerdal.McuMgr.FileDownloader.Contracts.Native; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; using GenericNativeFileDownloaderCallbacksProxy_ = Laerdal.McuMgr.FileDownloader.FileDownloader.GenericNativeFileDownloaderCallbacksProxy; namespace Laerdal.McuMgr.Tests.FileDownloader @@ -98,7 +100,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? await Task.Delay(100); StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound); + FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs index b33545b6..93b2aa4f 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs @@ -1,11 +1,13 @@ using System.Diagnostics.CodeAnalysis; using FluentAssertions; using FluentAssertions.Extensions; +using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Helpers; using Laerdal.McuMgr.FileDownloader.Contracts.Enums; using Laerdal.McuMgr.FileDownloader.Contracts.Events; using Laerdal.McuMgr.FileDownloader.Contracts.Exceptions; using Laerdal.McuMgr.FileDownloader.Contracts.Native; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; using GenericNativeFileDownloaderCallbacksProxy_ = Laerdal.McuMgr.FileDownloader.FileDownloader.GenericNativeFileDownloaderCallbacksProxy; namespace Laerdal.McuMgr.Tests.FileDownloader @@ -100,8 +102,8 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? await Task.Delay(100); - StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order simulates how the native code behaves - FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound); // order simulates how the csharp wrapper behaves + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order simulates how the native code behaves + FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.NoEntry, EFileOperationGroupReturnCode.Unset); // order simulates how the csharp wrapper behaves }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs index a5bc57ee..814ff867 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs @@ -2,6 +2,7 @@ using Laerdal.McuMgr.FileDownloader.Contracts; using Laerdal.McuMgr.FileDownloader.Contracts.Enums; using Laerdal.McuMgr.FileDownloader.Contracts.Native; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; namespace Laerdal.McuMgr.Tests.FileDownloader { @@ -62,13 +63,17 @@ public void BusyStateChangedAdvertisement(bool busyNotIdle) public void DownloadCompletedAdvertisement(string resource, byte[] data) => _downloaderCallbacksProxy.DownloadCompletedAdvertisement(resource, data); //raises the actual event - - public void FatalErrorOccurredAdvertisement(string resource, string errorMessage) - => _downloaderCallbacksProxy.FatalErrorOccurredAdvertisement(resource, errorMessage); //raises the actual event + + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileOperationGroupReturnCode) + => _downloaderCallbacksProxy.FatalErrorOccurredAdvertisement(resource, errorMessage, mcuMgrErrorCode, fileOperationGroupReturnCode); //raises the actual event public void FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput) => _downloaderCallbacksProxy.FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage, averageThroughput); //raises the actual event + public bool TrySetContext(object context) => throw new NotImplementedException(); + public bool TrySetBluetoothDevice(object bluetoothDevice) => throw new NotImplementedException(); + public bool TryInvalidateCachedTransport() => throw new NotImplementedException(); + public void Dispose() { } diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index ace574db..06b77389 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -116,18 +116,18 @@ public override EFileUploaderVerdict BeginUpload( if (remoteFilePathUppercase.Contains("some/file/to/a/folder/that/doesnt/exist.bin".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "UNKNOWN (1)", EMcuMgrErrorCode.Unknown, EFileUploaderGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "UNKNOWN (1)", EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); } else if (remoteFilePathUppercase.Contains("some/file/that/succeeds/after/a/couple/of/attempts.bin".ToUpperInvariant()) && _retryCountForProblematicFile++ < 3) { StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "ping pong", EMcuMgrErrorCode.Busy, EFileUploaderGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "ping pong", EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); } else if (remoteFilePathUppercase.Contains("some/file/that/is/erroring/out/when/we/try/to/upload/it.bin".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "native symbols not loaded blah blah", EMcuMgrErrorCode.NotSupported, EFileUploaderGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "native symbols not loaded blah blah", EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); } else { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index a054d200..6c95dc6a 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -139,48 +139,48 @@ public override EFileUploaderVerdict BeginUpload( if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize) { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity) { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment) { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } if (_tryCounter == _maxTriesCount && pipelineDepth != AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth) { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } if (_tryCounter == _maxTriesCount && byteAlignment != AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment) { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } if (_tryCounter < _maxTriesCount) { await Task.Delay(20); - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index 9ae50800..54c04013 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -123,7 +123,7 @@ public override EFileUploaderVerdict BeginUpload( if (_tryCount < _maxNumberOfTriesForSuccess) { StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileUploaderGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileOperationGroupReturnCode.Unset); return; } diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs index 6ff498ca..b354e372 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs @@ -137,7 +137,7 @@ public override EFileUploaderVerdict BeginUpload( { await Task.Delay(20); StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Unset, EFileUploaderGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileOperationGroupReturnCode.Unset); // order return; } diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs index 72a89d8b..1c6b109a 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs @@ -106,7 +106,7 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(2_000); StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileUploaderGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileOperationGroupReturnCode.Unset); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs index b8254c52..b201aaa2 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs @@ -116,7 +116,7 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(100); StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.Corrupt, EFileUploaderGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.Corrupt, EFileOperationGroupReturnCode.Unset); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs index 0e86a2bb..e5efc73d 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs @@ -133,7 +133,7 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(100); StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, _mcuMgrErrorCode, EFileUploaderGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, _mcuMgrErrorCode, EFileOperationGroupReturnCode.Unset); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs index f547707f..3a2dbc05 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs @@ -74,7 +74,7 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(100); StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "blah blah", EMcuMgrErrorCode.AccessDenied, EFileUploaderGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "blah blah", EMcuMgrErrorCode.AccessDenied, EFileOperationGroupReturnCode.Unset); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs index 5a82caa9..cadda09c 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs @@ -77,7 +77,7 @@ public void FatalErrorOccurredAdvertisement( string resource, string errorMessage, EMcuMgrErrorCode errorCode, - EFileUploaderGroupReturnCode fileUploaderGroupReturnCode + EFileOperationGroupReturnCode fileUploaderGroupReturnCode ) => _uploaderCallbacksProxy.FatalErrorOccurredAdvertisement(resource, errorMessage, errorCode, fileUploaderGroupReturnCode); //raises the actual event public void FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput) diff --git a/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs index 6be5ff28..b1c1abab 100644 --- a/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs @@ -12,6 +12,7 @@ using Laerdal.McuMgr.FileDownloader.Contracts; using Laerdal.McuMgr.FileDownloader.Contracts.Enums; using Laerdal.McuMgr.FileDownloader.Contracts.Native; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; namespace Laerdal.McuMgr.FileDownloader { @@ -103,16 +104,45 @@ public EFileDownloaderVerdict BeginDownload( )); } + public bool TrySetContext(object context) //the parameter must be of type 'object' so that it wont cause problems in platforms other than android + { + var androidContext = context as Context ?? throw new ArgumentException($"Expected {nameof(Context)} to be an AndroidContext but got '{context?.GetType().Name ?? "null"}' instead", nameof(context)); + + return base.TrySetContext(androidContext); + } + + public bool TrySetBluetoothDevice(object bluetoothDevice) + { + var androidBluetoothDevice = bluetoothDevice as BluetoothDevice ?? throw new ArgumentException($"Expected {nameof(BluetoothDevice)} to be an AndroidBluetoothDevice but got '{bluetoothDevice?.GetType().Name ?? "null"}' instead", nameof(bluetoothDevice)); + + return base.TrySetBluetoothDevice(androidBluetoothDevice); + } + + public new bool TryInvalidateCachedTransport() + { + return base.TryInvalidateCachedTransport(); + } + #endregion commands #region android callbacks -> csharp event emitters - - public override void FatalErrorOccurredAdvertisement(string resource, string errorMessage) + + public override void FatalErrorOccurredAdvertisement(string resource, string errorMessage, int mcuMgrErrorCode, int fileOperationGroupReturnCode) { - base.FatalErrorOccurredAdvertisement(resource, errorMessage); + base.FatalErrorOccurredAdvertisement(resource, errorMessage, mcuMgrErrorCode, fileOperationGroupReturnCode); //just in case - _fileDownloaderCallbacksProxy?.FatalErrorOccurredAdvertisement(resource, errorMessage); + FatalErrorOccurredAdvertisement(resource, errorMessage, (EMcuMgrErrorCode) mcuMgrErrorCode, (EFileOperationGroupReturnCode) fileOperationGroupReturnCode); + } + + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileUploaderGroupReturnCode) + { + _fileDownloaderCallbacksProxy?.FatalErrorOccurredAdvertisement( + resource, + errorMessage, + mcuMgrErrorCode, + fileUploaderGroupReturnCode + ); } public override void LogMessageAdvertisement(string message, string category, string level, string resource) diff --git a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs index 920446f7..2b1908e6 100644 --- a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs @@ -152,10 +152,10 @@ public override void FatalErrorOccurredAdvertisement(string resource, string err { base.FatalErrorOccurredAdvertisement(resource, errorMessage, mcuMgrErrorCode, fileUploaderGroupReturnCode); //just in case - FatalErrorOccurredAdvertisement(resource, errorMessage, (EMcuMgrErrorCode) mcuMgrErrorCode, (EFileUploaderGroupReturnCode) fileUploaderGroupReturnCode); + FatalErrorOccurredAdvertisement(resource, errorMessage, (EMcuMgrErrorCode) mcuMgrErrorCode, (EFileOperationGroupReturnCode) fileUploaderGroupReturnCode); } - public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileUploaderGroupReturnCode fileUploaderGroupReturnCode) + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileUploaderGroupReturnCode) { _fileUploaderCallbacksProxy?.FatalErrorOccurredAdvertisement( resource, diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Events/FatalErrorOccurredEventArgs.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Events/FatalErrorOccurredEventArgs.cs index a3932b55..d9377fa9 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Events/FatalErrorOccurredEventArgs.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Events/FatalErrorOccurredEventArgs.cs @@ -1,7 +1,9 @@ // ReSharper disable MemberCanBePrivate.Global // ReSharper disable ClassNeverInstantiated.Global +using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Events; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; namespace Laerdal.McuMgr.FileDownloader.Contracts.Events { @@ -9,11 +11,15 @@ namespace Laerdal.McuMgr.FileDownloader.Contracts.Events { public string Resource { get; } public string ErrorMessage { get; } - - public FatalErrorOccurredEventArgs(string resource, string errorMessage) + public EMcuMgrErrorCode McuMgrErrorCode { get; } + public EFileOperationGroupReturnCode FileOperationGroupReturnCode { get; } + + public FatalErrorOccurredEventArgs(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileOperationGroupReturnCode) { Resource = resource; ErrorMessage = errorMessage; + McuMgrErrorCode = mcuMgrErrorCode; + FileOperationGroupReturnCode = fileOperationGroupReturnCode; } } } diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCallbacksProxy.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCallbacksProxy.cs index db7156e6..e0cc4182 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCallbacksProxy.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCallbacksProxy.cs @@ -1,5 +1,6 @@ using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.FileDownloader.Contracts.Enums; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; namespace Laerdal.McuMgr.FileDownloader.Contracts.Native { @@ -12,7 +13,7 @@ internal interface INativeFileDownloaderCallbacksProxy void StateChangedAdvertisement(string resource, EFileDownloaderState oldState, EFileDownloaderState newState); void BusyStateChangedAdvertisement(bool busyNotIdle); void DownloadCompletedAdvertisement(string resource, byte[] data); - void FatalErrorOccurredAdvertisement(string resource, string errorMessage); + void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileOperationGroupReturnCode); void FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput); } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCommandableProxy.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCommandableProxy.cs index 8d0ebba2..73e29c4a 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCommandableProxy.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCommandableProxy.cs @@ -7,5 +7,9 @@ internal interface INativeFileDownloaderCommandableProxy void Cancel(); void Disconnect(); EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null); + + bool TrySetContext(object context); + bool TrySetBluetoothDevice(object bluetoothDevice); + bool TryInvalidateCachedTransport(); } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index 94e7f683..e25efc99 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -15,6 +15,7 @@ using Laerdal.McuMgr.FileDownloader.Contracts.Events; using Laerdal.McuMgr.FileDownloader.Contracts.Exceptions; using Laerdal.McuMgr.FileDownloader.Contracts.Native; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; namespace Laerdal.McuMgr.FileDownloader { @@ -487,8 +488,8 @@ public void BusyStateChangedAdvertisement(bool busyNotIdle) public void DownloadCompletedAdvertisement(string resource, byte[] data) => FileDownloader?.OnDownloadCompleted(new DownloadCompletedEventArgs(resource, data)); - public void FatalErrorOccurredAdvertisement(string resource, string errorMessage) - => FileDownloader?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs(resource, errorMessage)); + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileOperationGroupReturnCode) + => FileDownloader?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs(resource, errorMessage, mcuMgrErrorCode, fileOperationGroupReturnCode)); public void FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput) => FileDownloader?.OnFileDownloadProgressPercentageAndDataThroughputChanged(new FileDownloadProgressPercentageAndDataThroughputChangedEventArgs( diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/EFileUploaderGroupReturnCode.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/EFileOperationGroupReturnCode.cs similarity index 92% rename from Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/EFileUploaderGroupReturnCode.cs rename to Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/EFileOperationGroupReturnCode.cs index a5da93c9..faf95cb4 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/EFileUploaderGroupReturnCode.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/EFileOperationGroupReturnCode.cs @@ -1,6 +1,6 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Enums { - public enum EFileUploaderGroupReturnCode //@formatter:off + public enum EFileOperationGroupReturnCode //@formatter:off { Unset = -99, Ok = 00, diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/FatalErrorOccurredEventArgs.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/FatalErrorOccurredEventArgs.cs index 3ce54b59..8075bec3 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/FatalErrorOccurredEventArgs.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/FatalErrorOccurredEventArgs.cs @@ -13,9 +13,9 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Events public string RemoteFilePath { get; } public EMcuMgrErrorCode ErrorCode { get; } - public EFileUploaderGroupReturnCode GroupReturnCode { get; } + public EFileOperationGroupReturnCode GroupReturnCode { get; } - public FatalErrorOccurredEventArgs(string remoteFilePath, string errorMessage, EMcuMgrErrorCode errorCode, EFileUploaderGroupReturnCode groupReturnCode) + public FatalErrorOccurredEventArgs(string remoteFilePath, string errorMessage, EMcuMgrErrorCode errorCode, EFileOperationGroupReturnCode groupReturnCode) { ErrorCode = errorCode; ErrorMessage = errorMessage; diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs index 6bfb2e4c..f891cdb1 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs @@ -9,7 +9,7 @@ public class UploadErroredOutException : Exception, IUploadException public string RemoteFilePath { get; } public EMcuMgrErrorCode McuMgrErrorCode { get; } = EMcuMgrErrorCode.Unset; - public EFileUploaderGroupReturnCode GroupReturnCode { get; } = EFileUploaderGroupReturnCode.Unset; + public EFileOperationGroupReturnCode GroupReturnCode { get; } = EFileOperationGroupReturnCode.Unset; protected UploadErroredOutException(string remoteFilePath, string errorMessage, Exception innerException = null) : base($"An error occurred while uploading over to '{remoteFilePath}': '{errorMessage}'", innerException) @@ -21,7 +21,7 @@ public UploadErroredOutException( string nativeErrorMessage, string remoteFilePath, EMcuMgrErrorCode mcuMgrErrorCode, - EFileUploaderGroupReturnCode groupReturnCode, + EFileOperationGroupReturnCode groupReturnCode, Exception innerException = null ) : base($"An error occurred while uploading '{remoteFilePath}': '{nativeErrorMessage}' (mcuMgrErrorCode={mcuMgrErrorCode}, groupReturnCode={groupReturnCode})", innerException) { diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutRemoteFolderNotFoundException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutRemoteFolderNotFoundException.cs index 5e81cfcf..fa739cd9 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutRemoteFolderNotFoundException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutRemoteFolderNotFoundException.cs @@ -11,7 +11,7 @@ public UploadErroredOutRemoteFolderNotFoundException( string nativeErrorMessage, string remoteFilePath, EMcuMgrErrorCode mcuMgrErrorCode, - EFileUploaderGroupReturnCode groupReturnCode + EFileOperationGroupReturnCode groupReturnCode ) : base( nativeErrorMessage: nativeErrorMessage, remoteFilePath: remoteFilePath, diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs index 3d789cf0..1243df45 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs @@ -9,9 +9,9 @@ public class UploadUnauthorizedException : UploadErroredOutException, IMcuMgrExc public string RemoteFilePath { get; } public EMcuMgrErrorCode McuMgrErrorCode { get; } - public EFileUploaderGroupReturnCode GroupReturnCode { get; } + public EFileOperationGroupReturnCode GroupReturnCode { get; } - public UploadUnauthorizedException(string nativeErrorMessage, string remoteFilePath, EMcuMgrErrorCode mcuMgrErrorCode, EFileUploaderGroupReturnCode groupReturnCode) + public UploadUnauthorizedException(string nativeErrorMessage, string remoteFilePath, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode groupReturnCode) : base(remoteFilePath, $"{nativeErrorMessage} (McuMgrErrorCode={mcuMgrErrorCode}, GroupReturnCode={groupReturnCode})") { RemoteFilePath = remoteFilePath; diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs index c27bfb09..16858c7d 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs @@ -14,7 +14,7 @@ internal interface INativeFileUploaderCallbacksProxy void StateChangedAdvertisement(string resource, EFileUploaderState oldState, EFileUploaderState newState); void BusyStateChangedAdvertisement(bool busyNotIdle); void FileUploadedAdvertisement(string resource); - void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileUploaderGroupReturnCode fileUploaderGroupReturnCode); + void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileUploaderGroupReturnCode); void FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput); } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index 658a967b..9997f0d5 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -638,7 +638,7 @@ public void FatalErrorOccurredAdvertisement( string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, - EFileUploaderGroupReturnCode fileUploaderGroupReturnCode + EFileOperationGroupReturnCode fileUploaderGroupReturnCode ) => FileUploader?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs( resource, errorMessage, diff --git a/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs index f7e2bc46..8bc269ca 100644 --- a/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs @@ -9,6 +9,7 @@ using Laerdal.McuMgr.FileDownloader.Contracts; using Laerdal.McuMgr.FileDownloader.Contracts.Enums; using Laerdal.McuMgr.FileDownloader.Contracts.Native; +using Laerdal.McuMgr.FileUploader.Contracts.Enums; using McuMgrBindingsiOS; namespace Laerdal.McuMgr.FileDownloader @@ -80,6 +81,23 @@ private void CleanupInfrastructure() _nativeFileDownloader?.Dispose(); _nativeFileDownloader = null; } + + public bool TrySetContext(object context) + { + return true; //nothing to do in ios only android needs this and supports it + } + + public bool TrySetBluetoothDevice(object bluetoothDevice) + { + var iosBluetoothDevice = bluetoothDevice as CBPeripheral ?? throw new ArgumentException($"Expected {nameof(bluetoothDevice)} to be of type {nameof(CBPeripheral)}", nameof(bluetoothDevice)); + + return _nativeFileDownloader?.TrySetBluetoothDevice(iosBluetoothDevice) ?? false; + } + + public bool TryInvalidateCachedTransport() + { + return _nativeFileDownloader?.TryInvalidateCachedTransport() ?? false; + } #region commands @@ -156,8 +174,19 @@ public override void DownloadCompletedAdvertisement(string resource, NSNumber[] public void DownloadCompletedAdvertisement(string resource, byte[] data) //conformance to the interface => _nativeFileDownloaderCallbacksProxy?.DownloadCompletedAdvertisement(resource, data); - public override void FatalErrorOccurredAdvertisement(string resource, string errorMessage) - => _nativeFileDownloaderCallbacksProxy?.FatalErrorOccurredAdvertisement(resource, errorMessage); + public override void FatalErrorOccurredAdvertisement( + string resource, + string errorMessage, + nint mcuMgrErrorCode + ) => FatalErrorOccurredAdvertisement( + resource, + errorMessage, + (EMcuMgrErrorCode)(int)mcuMgrErrorCode, + EFileOperationGroupReturnCode.Unset + ); + + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileOperationGroupReturnCode) + => _nativeFileDownloaderCallbacksProxy?.FatalErrorOccurredAdvertisement(resource, errorMessage, mcuMgrErrorCode, fileOperationGroupReturnCode); public override void FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(nint progressPercentage, float averageThroughput) => FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement( diff --git a/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs b/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs index 94de7804..a592ec77 100644 --- a/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs @@ -209,13 +209,13 @@ nint mcuMgrErrorCode resource, errorMessage, (EMcuMgrErrorCode)(int)mcuMgrErrorCode, - EFileUploaderGroupReturnCode.Unset + EFileOperationGroupReturnCode.Unset ); public void FatalErrorOccurredAdvertisement( //conformance to the interface string resource, string errorMessage, // ReSharper disable once MethodOverloadWithOptionalParameter EMcuMgrErrorCode mcuMgrErrorCode, - EFileUploaderGroupReturnCode fileUploaderGroupReturnCode + EFileOperationGroupReturnCode fileUploaderGroupReturnCode ) => _nativeFileUploaderCallbacksProxy?.FatalErrorOccurredAdvertisement( resource, errorMessage, From 6ab66d8e3255f5fa36febc6a65ad91d564d3a7f2 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 20:08:28 +0200 Subject: [PATCH 074/104] fix (FileDownloader::BeginDownload()): the method now supports falling automatically to the fail-safe connection-settings (initial-mtu-size=23) if the host device is in the list of problematic devices (samsung-a8 etc) [skip ci] --- ...entException_GivenInvalidRemoteFilePath.cs | 7 ++- ...leteSuccessfully_GivenNoFilesToDownload.cs | 7 ++- ...uccessfully_GivenVariousFilesToDownload.cs | 3 ++ ...hCollectionWithErroneousFilesToDownload.cs | 7 ++- ...ntException_GivenNullForFilesToDownload.cs | 7 ++- ...ToFailsafeSettings_GivenFlakyConnection.cs | 3 ++ ...essfully_GivenGreenNativeFileDownloader.cs | 3 ++ ...ailedException_GivenFatalErrorMidflight.cs | 3 ++ ...dException_GivenRogueNativeErrorMessage.cs | 3 ++ ...umentException_GivenEmptyRemoteFilePath.cs | 7 ++- ...ption_GivenCancellationRequestMidflight.cs | 7 ++- ...tion_GivenErroneousNativeFileDownloader.cs | 7 ++- ...adTimeoutException_GivenTooSmallTimeout.cs | 8 ++- ...FoundException_GivenNonExistentFilepath.cs | 3 ++ .../Helpers/ConnectionSettingsHelpers.cs | 53 +++++++++++++++++++ .../Contracts/IFileDownloaderCommandable.cs | 11 ++++ .../Shared/FileDownloader/FileDownloader.cs | 32 ++++++++--- .../Shared/FileUploader/FileUploader.cs | 53 ++----------------- 18 files changed, 158 insertions(+), 66 deletions(-) create mode 100644 Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.BeginDownload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.BeginDownload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs index f93b1510..664f54ba 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.BeginDownload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.BeginDownload.ShouldThrowArgumentException_GivenInvalidRemoteFilePath.cs @@ -25,7 +25,12 @@ public void BeginDownload_ShouldThrowArgumentException_GivenInvalidRemoteFilePat using var eventsMonitor = fileDownloader.Monitor(); // Act - var work = new Func(() => fileDownloader.BeginDownload(remoteFilePath: remoteFilePath)); + var work = new Func(() => fileDownloader.BeginDownload( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + remoteFilePath: remoteFilePath + )); // Assert work.Should().ThrowExactly(); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs index b5ef7796..f303e8b4 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenNoFilesToDownload.cs @@ -20,7 +20,12 @@ public async Task MultipleFilesDownloadAsync_ShouldCompleteSuccessfully_GivenNoF using var eventsMonitor = fileDownloader.Monitor(); // Act - var work = new Func>>(async () => await fileDownloader.DownloadAsync([])); + var work = new Func>>(async () => await fileDownloader.DownloadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + remoteFilePaths: [] + )); // Assert var results = (await work.Should().CompleteWithinAsync(500.Milliseconds())).Which; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index e2b4938a..7bfa39c4 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -48,6 +48,9 @@ public async Task MultipleFilesDownloadAsync_ShouldCompleteSuccessfully_GivenVar // Act var work = new Func>>(async () => await fileDownloader.DownloadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + remoteFilePaths: remoteFilePathsToTest, maxRetriesPerDownload: 4 )); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs index cf54bae9..a764b37f 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowArgumentException_GivenPathCollectionWithErroneousFilesToDownload.cs @@ -29,7 +29,12 @@ public async Task MultipleFilesDownloadAsync_ShouldThrowArgumentException_GivenP using var eventsMonitor = fileDownloader.Monitor(); // Act - var work = new Func>>(async () => await fileDownloader.DownloadAsync(remoteFilePaths)); + var work = new Func>>(async () => await fileDownloader.DownloadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + remoteFilePaths: remoteFilePaths + )); // Assert await work.Should().ThrowExactlyAsync().WithTimeoutInMs(500); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs index beb63324..bc9f6686 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldThrowNullArgumentException_GivenNullForFilesToDownload.cs @@ -20,7 +20,12 @@ public async Task MultipleFilesDownloadAsync_ShouldThrowNullArgumentException_Gi using var eventsMonitor = fileDownloader.Monitor(); // Act - var work = new Func>>(async () => await fileDownloader.DownloadAsync(remoteFilePaths: null)); + var work = new Func>>(async () => await fileDownloader.DownloadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + remoteFilePaths: null + )); // Assert await work.Should().ThrowExactlyAsync().WithTimeoutInMs(500); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index b430aad8..05b4b9be 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -35,6 +35,9 @@ public async Task SingleFileDownloadAsync_ShouldCompleteSuccessfullyByFallingBac // Act var work = new Func(() => fileDownloader.DownloadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + maxTriesCount: maxTriesCount, remoteFilePath: remoteFilePath )); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index 51acc402..429f5350 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -40,6 +40,9 @@ public async Task SingleFileDownloadAsync_ShouldCompleteSuccessfully_GivenGreenN // Act var work = new Func(() => fileDownloader.DownloadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + maxTriesCount: maxTriesCount, remoteFilePath: remoteFilePath, sleepTimeBetweenRetriesInMs: sleepTimeBetweenRetriesInMs diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs index ca937bcd..52259579 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs @@ -31,6 +31,9 @@ public async Task SingleFileDownloadAsync_ShouldThrowAllDownloadAttemptsFailedEx // Act var work = new Func(() => fileDownloader.DownloadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + maxTriesCount: maxTriesCount, remoteFilePath: remoteFilePath )); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs index 439de183..07e1a945 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs @@ -35,6 +35,9 @@ public async Task SingleFileDownloadAsync_ShouldThrowAllDownloadAttemptsFailedEx // Act var work = new Func(() => fileDownloader.DownloadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + maxTriesCount: maxTriesCount, //doesnt really matter we just want to ensure that the method fails early and doesnt retry remoteFilePath: remoteFilePath, sleepTimeBetweenRetriesInMs: 10 diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs index 19f92471..5a2ef7a1 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowArgumentException_GivenEmptyRemoteFilePath.cs @@ -21,7 +21,12 @@ public async Task SingleFileDownloadAsync_ShouldThrowArgumentException_GivenEmpt using var eventsMonitor = fileDownloader.Monitor(); // Act - var work = new Func(() => fileDownloader.DownloadAsync(remoteFilePath: remoteFilePath)); + var work = new Func(() => fileDownloader.DownloadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + remoteFilePath: remoteFilePath + )); // Assert await work.Should().ThrowExactlyAsync().WithTimeoutInMs(500); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadCancelledException_GivenCancellationRequestMidflight.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadCancelledException_GivenCancellationRequestMidflight.cs index 1588a904..216db887 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadCancelledException_GivenCancellationRequestMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadCancelledException_GivenCancellationRequestMidflight.cs @@ -33,7 +33,12 @@ public async Task SingleFileUploadAsync_ShouldThrowUploadCancelledException_Give fileDownloader.Cancel(); }); - var work = new Func(() => fileDownloader.DownloadAsync(remoteFilePath)); + var work = new Func(() => fileDownloader.DownloadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + remoteFilePath: remoteFilePath + )); // Assert await work.Should().ThrowExactlyAsync().WithTimeoutInMs((int)5.Seconds().TotalMilliseconds); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadInternalErrorException_GivenErroneousNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadInternalErrorException_GivenErroneousNativeFileDownloader.cs index 77f5b5ac..2a5e8be1 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadInternalErrorException_GivenErroneousNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadInternalErrorException_GivenErroneousNativeFileDownloader.cs @@ -16,7 +16,12 @@ public async Task SingleFileDownloadAsync_ShouldThrowDownloadInternalErrorExcept var fileDownloader = new McuMgr.FileDownloader.FileDownloader(mockedNativeFileDownloaderProxy); // Act - var work = new Func(() => fileDownloader.DownloadAsync(remoteFilePath: "/path/to/file.bin")); + var work = new Func(() => fileDownloader.DownloadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + remoteFilePath: "/path/to/file.bin" + )); // Assert (await work.Should().ThrowExactlyAsync()).WithInnerExceptionExactly("native symbols not loaded blah blah"); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs index 94ba00a3..1752b3c1 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowDownloadTimeoutException_GivenTooSmallTimeout.cs @@ -23,7 +23,13 @@ public async Task SingleFileDownloadAsync_ShouldThrowDownloadTimeoutException_Gi using var eventsMonitor = fileDownloader.Monitor(); // Act - var work = new Func(() => fileDownloader.DownloadAsync(remoteFilePath: remoteFilePath, timeoutForDownloadInMs: 100)); + var work = new Func(() => fileDownloader.DownloadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + remoteFilePath: remoteFilePath, + timeoutForDownloadInMs: 100 + )); // Assert await work.Should().ThrowExactlyAsync().WithTimeoutInMs((int)5.Seconds().TotalMilliseconds); diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs index 93b2aa4f..567af537 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs @@ -37,6 +37,9 @@ public async Task SingleFileDownloadAsync_ShouldThrowRemoteFileNotFoundException // Act var work = new Func(() => fileDownloader.DownloadAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + maxTriesCount: maxTriesCount, //doesnt really matter we just want to ensure that the method fails early and doesnt retry remoteFilePath: remoteFilePath, sleepTimeBetweenRetriesInMs: 10 diff --git a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs new file mode 100644 index 00000000..079af695 --- /dev/null +++ b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs @@ -0,0 +1,53 @@ +using Laerdal.McuMgr.Common.Constants; + +namespace Laerdal.McuMgr.Common.Helpers +{ + static internal class ConnectionSettingsHelpers + { + static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment) GetFailSafeConnectionSettingsIfHostDeviceIsProblematic_( + string hostDeviceManufacturer_, + string hostDeviceModel_, + int? pipelineDepth_ = null, + int? byteAlignment_ = null, + int? initialMtuSize_ = null, + int? windowCapacity_ = null, + int? memoryAlignment_ = null + ) + { + hostDeviceModel_ = (hostDeviceModel_ ?? "").Trim().ToLowerInvariant(); + hostDeviceManufacturer_ = (hostDeviceManufacturer_ ?? "").Trim().ToLowerInvariant(); + + if (AppleTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer_, hostDeviceModel_)) + && (pipelineDepth_ ?? 1) == 1 + && (byteAlignment_ ?? 1) == 1) + { + return ( + byteAlignment: AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment, + pipelineDepth: AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth, + initialMtuSize: AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize, + windowCapacity: AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity, + memoryAlignment: AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment + ); + } + + if (AndroidTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer_, hostDeviceModel_)) + && initialMtuSize_ == null + && (windowCapacity_ ?? 1) == 1 + && (memoryAlignment_ ?? 1) == 1) + { + return ( + byteAlignment: AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment, + pipelineDepth: AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth, + initialMtuSize: AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize, + windowCapacity: AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity, + memoryAlignment: AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment + ); + } + + return ( + byteAlignment: byteAlignment_, pipelineDepth: pipelineDepth_, + initialMtuSize: initialMtuSize_, windowCapacity: windowCapacity_, memoryAlignment: memoryAlignment_ + ); + } + } +} \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs index ae9d71d2..ef6281b8 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs @@ -11,6 +11,8 @@ public interface IFileDownloaderCommandable /// Begins the file-downloading process on multiple files. Files that cannot be downloaded due to errors will have a null entry in the returned dictionary. To really know when the upgrade process has been completed you have to register to the events emitted by the downloader. /// /// The remote files to download. + /// + /// /// The amount of time to wait for each download to complete before skipping it. /// The maximum amount of tries per download before skipping and moving over to the next download. /// The amount of time to sleep between retries. @@ -29,6 +31,8 @@ public interface IFileDownloaderCommandable /// A dictionary containing the bytes of each remote file that got fetched over. Task> DownloadAsync( IEnumerable remoteFilePaths, + string hostDeviceManufacturer, + string hostDeviceModel, int timeoutPerDownloadInMs = -1, int maxRetriesPerDownload = 10, int sleepTimeBetweenRetriesInMs = 0, @@ -41,6 +45,7 @@ Task> DownloadAsync( /// Begins the file-downloading process. To really know when the upgrade process has been completed you have to register to the events emitted by the downloader. /// /// The remote file to download. + /// /// The amount of time to wait for the operation to complete before bailing out. /// The maximum amount of tries before bailing out with . /// The amount of time to sleep between retries. @@ -60,6 +65,8 @@ Task> DownloadAsync( /// The bytes of the remote file that got fetched over. Task DownloadAsync( string remoteFilePath, + string hostDeviceManufacturer, + string hostDeviceModel, int timeoutForDownloadInMs = -1, int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 1_000, @@ -73,6 +80,8 @@ Task DownloadAsync( /// Begins the file-downloading process. To really know when the upgrade process has been completed you have to register to the events emitted by the downloader. /// /// The remote file to download. + /// + /// /// (Android only) Set the initial MTU size for the connection employed by the firmware-installation /// (useful for some problematic devices such as Samsung A8 tablets). Acceptable custom values must lay within the range [23, 517]. /// If null, zero or negative it will default to 498. Note that in quirky devices like Samsung Galaxy A8 the only value that works is 23 - anything else fails. @@ -87,6 +96,8 @@ Task DownloadAsync( /// (Android only) Set the selected memory alignment. Defaults to 4 to match Nordic devices. EFileDownloaderVerdict BeginDownload( string remoteFilePath, + string hostDeviceManufacturer, + string hostDeviceModel, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index e25efc99..3f4702c0 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -42,17 +42,26 @@ public void Dispose() public EFileDownloaderVerdict BeginDownload( string remoteFilePath, + string hostDeviceManufacturer, + string hostDeviceModel, int? initialMtuSize = null, - int? windowCapacity = null, + int? windowCapacity = null, //not applicable currently but nordic considers them for future use int? memoryAlignment = null + //not applicable currently but nordic considers them for future use ) { RemoteFilePathHelpers.ValidateRemoteFilePath(remoteFilePath); // order remoteFilePath = RemoteFilePathHelpers.SanitizeRemoteFilePath(remoteFilePath); // order + var connectionSettings = ConnectionSettingsHelpers.GetFailSafeConnectionSettingsIfHostDeviceIsProblematic_( + initialMtuSize_: initialMtuSize, + hostDeviceModel_: hostDeviceModel, + hostDeviceManufacturer_: hostDeviceManufacturer + ); + var verdict = _nativeFileDownloaderProxy.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: initialMtuSize + initialMtuSize: connectionSettings.initialMtuSize ); return verdict; @@ -141,6 +150,8 @@ public event EventHandler> DownloadAsync( IEnumerable remoteFilePaths, + string hostDeviceManufacturer, + string hostDeviceModel, int timeoutPerDownloadInMs = -1, int maxRetriesPerDownload = 10, int sleepTimeBetweenRetriesInMs = 0, @@ -163,15 +174,16 @@ public async Task> DownloadAsync( { var data = await DownloadAsync( remoteFilePath: path, - - maxTriesCount: maxRetriesPerDownload, + hostDeviceModel: hostDeviceModel, + hostDeviceManufacturer: hostDeviceManufacturer, + timeoutForDownloadInMs: timeoutPerDownloadInMs, - sleepTimeBetweenRetriesInMs: sleepTimeBetweenRetriesInMs, + maxTriesCount: maxRetriesPerDownload, + sleepTimeBetweenRetriesInMs: sleepTimeBetweenRetriesInMs, initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment - ); + memoryAlignment: memoryAlignment); results[path] = data; } @@ -191,10 +203,12 @@ public async Task> DownloadAsync( private const int DefaultGracefulCancellationTimeoutInMs = 2_500; public async Task DownloadAsync( string remoteFilePath, + string hostDeviceManufacturer, + string hostDeviceModel, int timeoutForDownloadInMs = -1, int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 1_000, - int gracefulCancellationTimeoutInMs = DefaultGracefulCancellationTimeoutInMs, + int gracefulCancellationTimeoutInMs = 2_500, int? initialMtuSize = null, int? windowCapacity = null, int? memoryAlignment = null @@ -240,6 +254,8 @@ public async Task DownloadAsync( var verdict = BeginDownload( //00 dont use task.run here for now remoteFilePath: remoteFilePath, + hostDeviceModel: hostDeviceModel, + hostDeviceManufacturer: hostDeviceManufacturer, initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index 9997f0d5..b67b1c89 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -62,7 +62,7 @@ public EFileUploaderVerdict BeginUpload( RemoteFilePathHelpers.ValidateRemoteFilePath(remoteFilePath); // order remoteFilePath = RemoteFilePathHelpers.SanitizeRemoteFilePath(remoteFilePath); // order - var connectionSettings = GetFailSafeConnectionSettingsIfHostDeviceIsProblematic_( + var connectionSettings = ConnectionSettingsHelpers.GetFailSafeConnectionSettingsIfHostDeviceIsProblematic_( hostDeviceModel_: hostDeviceModel, hostDeviceManufacturer_: hostDeviceManufacturer, @@ -86,52 +86,6 @@ public EFileUploaderVerdict BeginUpload( ); return verdict; - - (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment) GetFailSafeConnectionSettingsIfHostDeviceIsProblematic_( - string hostDeviceManufacturer_, - string hostDeviceModel_, - int? pipelineDepth_, - int? byteAlignment_, - int? initialMtuSize_, - int? windowCapacity_, - int? memoryAlignment_ - ) - { - hostDeviceModel_ = (hostDeviceModel_ ?? "").Trim().ToLowerInvariant(); - hostDeviceManufacturer_ = (hostDeviceManufacturer_ ?? "").Trim().ToLowerInvariant(); - - if (AppleTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer_, hostDeviceModel_)) - && (pipelineDepth_ ?? 1) == 1 - && (byteAlignment_ ?? 1) == 1) - { - return ( - byteAlignment: AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment, - pipelineDepth: AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth, - initialMtuSize: AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize, - windowCapacity: AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity, - memoryAlignment: AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment - ); - } - - if (AndroidTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer_, hostDeviceModel_)) - && initialMtuSize_ == null - && (windowCapacity_ ?? 1) == 1 - && (memoryAlignment_ ?? 1) == 1) - { - return ( - byteAlignment: AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment, - pipelineDepth: AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth, - initialMtuSize: AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize, - windowCapacity: AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity, - memoryAlignment: AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment - ); - } - - return ( - byteAlignment: byteAlignment, pipelineDepth: pipelineDepth, - initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment - ); - } } public void Cancel(string reason = "") => _nativeFileUploaderProxy?.Cancel(reason); @@ -356,14 +310,13 @@ public async Task UploadAsync( var verdict = BeginUpload( //00 dont use task.run here for now remoteFilePath: remoteFilePath, - hostDeviceModel: hostDeviceModel, hostDeviceManufacturer: hostDeviceManufacturer, - data: dataArray, // ios only + data: dataArray, // ios only pipelineDepth: pipelineDepth, // ios only - byteAlignment: byteAlignment, // android only + byteAlignment: byteAlignment, // android only initialMtuSize: initialMtuSize, // android only windowCapacity: windowCapacity, memoryAlignment: memoryAlignment // android only From 94d1cabe5150d67afcae83728433a5d0a6de1c46 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 22 Oct 2024 20:21:40 +0200 Subject: [PATCH 075/104] fix (github-actions.yml): fix a bug on test-results publishing --- .github/workflows/github-actions.yml | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml index 2651eae2..f1918459 100644 --- a/.github/workflows/github-actions.yml +++ b/.github/workflows/github-actions.yml @@ -114,15 +114,14 @@ jobs: -p:Laerdal_Dependency_Tracker_Private_Signing_Key_File_Path="${{env.BUILD_REPOSITORY_FOLDERPATH}}/Laerdal.Scripts/dependency_tracker_private_signing_key.ppk" \ && \ rm "./dependency_tracker_private_signing_key.ppk" "./dependency_tracker_api_key.ppk" - - # todo figure out why this is failing as of Oct 2024 -> https://github.com/EnricoMi/publish-unit-test-result-action/issues/633 - # - name: '📡 Publish Test Results' # https://github.com/marketplace/actions/publish-test-results - # uses: 'EnricoMi/publish-unit-test-result-action/macos@v2' - # if: always() - # with: - # files: | - # TestResults/**/TEST-*.xml - # TestResults/**/TEST-*.trx + + - name: '📡 Publish Test Results' # https://github.com/marketplace/actions/publish-test-results + uses: 'EnricoMi/publish-unit-test-result-action/macos@master' + if: always() + with: + files: | + TestResults/**/TEST-*.xml + TestResults/**/TEST-*.trx - name: '⬆️ Upload Artifacts' # to share with other workflows https://stackoverflow.com/a/77663335/863651 uses: 'actions/upload-artifact@v4' From 934743d8a43704e73f33a3af8156b04e6e15426f Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 23 Oct 2024 12:06:27 +0200 Subject: [PATCH 076/104] migrate (.sln -> .slnx): we now use the .slnx format to store the solution --- Laerdal.McuMgr.sln | 69 ----------------------- Laerdal.McuMgr.sln.DotSettings | 77 -------------------------- Laerdal.McuMgr.slnx | 23 ++++++++ Laerdal.McuMgr.slnx.DotSettings.user | 82 ++++++++++++++++++++++++++++ 4 files changed, 105 insertions(+), 146 deletions(-) delete mode 100644 Laerdal.McuMgr.sln delete mode 100644 Laerdal.McuMgr.sln.DotSettings create mode 100644 Laerdal.McuMgr.slnx create mode 100644 Laerdal.McuMgr.slnx.DotSettings.user diff --git a/Laerdal.McuMgr.sln b/Laerdal.McuMgr.sln deleted file mode 100644 index 1b1732cf..00000000 --- a/Laerdal.McuMgr.sln +++ /dev/null @@ -1,69 +0,0 @@ -Microsoft Visual Studio Solution File, Format Version 12.00 -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "_Misc", "_Misc", "{2459FC0F-B6EC-4C2C-BEA0-8534D539E124}" - ProjectSection(SolutionItems) = preProject - README.md = README.md - LICENSE = LICENSE - .gitignore = .gitignore - azure-pipelines.yml = azure-pipelines.yml - Laerdal.CreateNewReleaseInGithub.sh = Laerdal.Scripts\Laerdal.CreateNewReleaseInGithub.sh - Laerdal.Builder.targets = Laerdal.Scripts\Laerdal.Builder.targets - Laerdal.Version.sh = Laerdal.Scripts\Laerdal.Version.sh - global.json = global.json - Laerdal.SetupBuildEnvironment.sh = Laerdal.Scripts\Laerdal.SetupBuildEnvironment.sh - .github\workflows\github-actions.yml = .github\workflows\github-actions.yml - Laerdal.Scripts\Laerdal.GenerateSignAndUploadSbom.sh = Laerdal.Scripts\Laerdal.GenerateSignAndUploadSbom.sh - EndProjectSection -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Laerdal.McuMgr", "Laerdal.McuMgr\Laerdal.McuMgr.csproj", "{4E2952A5-394E-4184-8E12-F2D5342A43B2}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Laerdal.McuMgr.Tests", "Laerdal.McuMgr.Tests\Laerdal.McuMgr.Tests.csproj", "{2112FF63-2823-428B-80EE-0ECEE476BA46}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "_Tests", "_Tests", "{0D581C9E-E80B-4663-86A0-672A5B9843A8}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Laerdal.McuMgr.Bindings.NetStandard", "Laerdal.McuMgr.Bindings.NetStandard\Laerdal.McuMgr.Bindings.NetStandard.csproj", "{84EEAAFB-5ED5-4697-9757-622FF332F44D}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Laerdal.McuMgr.Bindings.Android", "Laerdal.McuMgr.Bindings.Android\Laerdal.McuMgr.Bindings.Android.csproj", "{C6A768F6-E649-4621-A9A8-099A7887BBBF}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Laerdal.McuMgr.Bindings.iOS", "Laerdal.McuMgr.Bindings.iOS\Laerdal.McuMgr.Bindings.iOS.csproj", "{84273F19-16F7-4956-A4F6-74DF3F044F45}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Laerdal.McuMgr.Bindings.MacCatalyst", "Laerdal.McuMgr.Bindings.MacCatalyst\Laerdal.McuMgr.Bindings.MacCatalyst.csproj", "{DBB42900-156A-4233-9CBD-EF2D5D23278B}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {4E2952A5-394E-4184-8E12-F2D5342A43B2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {4E2952A5-394E-4184-8E12-F2D5342A43B2}.Debug|Any CPU.Build.0 = Debug|Any CPU - {4E2952A5-394E-4184-8E12-F2D5342A43B2}.Release|Any CPU.ActiveCfg = Release|Any CPU - {4E2952A5-394E-4184-8E12-F2D5342A43B2}.Release|Any CPU.Build.0 = Release|Any CPU - {E3C9ADE4-FF77-4615-984E-5C914537A350}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {E3C9ADE4-FF77-4615-984E-5C914537A350}.Debug|Any CPU.Build.0 = Debug|Any CPU - {E3C9ADE4-FF77-4615-984E-5C914537A350}.Release|Any CPU.ActiveCfg = Release|Any CPU - {E3C9ADE4-FF77-4615-984E-5C914537A350}.Release|Any CPU.Build.0 = Release|Any CPU - {2112FF63-2823-428B-80EE-0ECEE476BA46}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {2112FF63-2823-428B-80EE-0ECEE476BA46}.Debug|Any CPU.Build.0 = Debug|Any CPU - {2112FF63-2823-428B-80EE-0ECEE476BA46}.Release|Any CPU.ActiveCfg = Release|Any CPU - {2112FF63-2823-428B-80EE-0ECEE476BA46}.Release|Any CPU.Build.0 = Release|Any CPU - {84EEAAFB-5ED5-4697-9757-622FF332F44D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {84EEAAFB-5ED5-4697-9757-622FF332F44D}.Debug|Any CPU.Build.0 = Debug|Any CPU - {84EEAAFB-5ED5-4697-9757-622FF332F44D}.Release|Any CPU.ActiveCfg = Release|Any CPU - {84EEAAFB-5ED5-4697-9757-622FF332F44D}.Release|Any CPU.Build.0 = Release|Any CPU - {C6A768F6-E649-4621-A9A8-099A7887BBBF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {C6A768F6-E649-4621-A9A8-099A7887BBBF}.Debug|Any CPU.Build.0 = Debug|Any CPU - {C6A768F6-E649-4621-A9A8-099A7887BBBF}.Release|Any CPU.ActiveCfg = Release|Any CPU - {C6A768F6-E649-4621-A9A8-099A7887BBBF}.Release|Any CPU.Build.0 = Release|Any CPU - {84273F19-16F7-4956-A4F6-74DF3F044F45}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {84273F19-16F7-4956-A4F6-74DF3F044F45}.Debug|Any CPU.Build.0 = Debug|Any CPU - {84273F19-16F7-4956-A4F6-74DF3F044F45}.Release|Any CPU.ActiveCfg = Release|Any CPU - {84273F19-16F7-4956-A4F6-74DF3F044F45}.Release|Any CPU.Build.0 = Release|Any CPU - {DBB42900-156A-4233-9CBD-EF2D5D23278B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {DBB42900-156A-4233-9CBD-EF2D5D23278B}.Debug|Any CPU.Build.0 = Debug|Any CPU - {DBB42900-156A-4233-9CBD-EF2D5D23278B}.Release|Any CPU.ActiveCfg = Release|Any CPU - {DBB42900-156A-4233-9CBD-EF2D5D23278B}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(NestedProjects) = preSolution - {2112FF63-2823-428B-80EE-0ECEE476BA46} = {0D581C9E-E80B-4663-86A0-672A5B9843A8} - EndGlobalSection -EndGlobal diff --git a/Laerdal.McuMgr.sln.DotSettings b/Laerdal.McuMgr.sln.DotSettings deleted file mode 100644 index cf6cbeed..00000000 --- a/Laerdal.McuMgr.sln.DotSettings +++ /dev/null @@ -1,77 +0,0 @@ - - Named - True - Required - False - ExpressionBody - static public private protected internal file new abstract virtual sealed readonly override extern unsafe volatile async required - Remove - BaseClass - False - 1 - 0 - 1 - ALWAYS - ALWAYS - ALWAYS - NEVER - True - CHOP_IF_LONG - True - 999999 - CHOP_IF_LONG - CHOP_ALWAYS - /usr/local/share/dotnet/sdk/7.0.404/MSBuild.dll - /usr/local/share/dotnet/dotnet - 1048576 - 1 - /Applications/Xcode_14_2.app - NuGetPluginsThenRider - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True - True \ No newline at end of file diff --git a/Laerdal.McuMgr.slnx b/Laerdal.McuMgr.slnx new file mode 100644 index 00000000..c366a772 --- /dev/null +++ b/Laerdal.McuMgr.slnx @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Laerdal.McuMgr.slnx.DotSettings.user b/Laerdal.McuMgr.slnx.DotSettings.user new file mode 100644 index 00000000..768b0f4f --- /dev/null +++ b/Laerdal.McuMgr.slnx.DotSettings.user @@ -0,0 +1,82 @@ + + True + True + True + True + Named + True + Required + False + ExpressionBody + static public private protected internal file new abstract virtual sealed readonly override extern unsafe volatile async required + Remove + BaseClass + False + 1 + 0 + 1 + ALWAYS + ALWAYS + ALWAYS + NEVER + True + CHOP_IF_LONG + True + 999999 + CHOP_IF_LONG + CHOP_ALWAYS + /usr/local/share/dotnet/sdk/7.0.404/MSBuild.dll + /usr/local/share/dotnet/dotnet + 1048576 + 1 + /Applications/Xcode_14_2.app + NuGetPluginsThenRider + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + \ No newline at end of file From 4362eb2f92f8aabff04ef314dab01f931964887e Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 23 Oct 2024 12:09:21 +0200 Subject: [PATCH 077/104] clean (Laerdal.McuMgr.csproj): trivial neutral tweaks --- Laerdal.McuMgr/Laerdal.McuMgr.csproj | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/Laerdal.McuMgr/Laerdal.McuMgr.csproj b/Laerdal.McuMgr/Laerdal.McuMgr.csproj index 62ccbc65..958a00fd 100644 --- a/Laerdal.McuMgr/Laerdal.McuMgr.csproj +++ b/Laerdal.McuMgr/Laerdal.McuMgr.csproj @@ -126,16 +126,16 @@ - - + + - - - + + + @@ -150,7 +150,6 @@ armeabi-v7a;arm64-v8a - From 1f8169aa3786cbeda11645563592b61acb0e2a33 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 23 Oct 2024 12:09:38 +0200 Subject: [PATCH 078/104] doc (Laerdal.Builder.targets): trivial doc-comment tweaks [skip ci] --- .../Laerdal.McuMgr.Bindings.Android.csproj | 8 +-- ...Laerdal.McuMgr.Bindings.MacCatalyst.csproj | 8 +-- ...Laerdal.McuMgr.Bindings.NetStandard.csproj | 8 +-- .../Laerdal.McuMgr.Bindings.iOS.csproj | 8 +-- Laerdal.McuMgr/Laerdal.McuMgr.csproj | 62 +++++++++---------- Laerdal.Scripts/Laerdal.Builder.targets | 10 +-- 6 files changed, 52 insertions(+), 52 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj index 691c6362..35d1227b 100644 --- a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj +++ b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.csproj @@ -62,10 +62,10 @@ true - 1.0.1168.0 - 1.0.1168.0 - 1.0.1168.0 - 1.0.1168.0 + 1.0.1177.0 + 1.0.1177.0 + 1.0.1177.0 + 1.0.1177.0 $(PackageId) $(Authors) diff --git a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj index f1f8fa61..0569bbac 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj +++ b/Laerdal.McuMgr.Bindings.MacCatalyst/Laerdal.McuMgr.Bindings.MacCatalyst.csproj @@ -73,10 +73,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1168.0 - 1.0.1168.0 - 1.0.1168.0 - 1.0.1168.0 + 1.0.1177.0 + 1.0.1177.0 + 1.0.1177.0 + 1.0.1177.0 $(PackageId) McuMgr Bindings for MacCatalyst - MAUI ready diff --git a/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj b/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj index ceb6eab9..f3e3ca9b 100644 --- a/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj +++ b/Laerdal.McuMgr.Bindings.NetStandard/Laerdal.McuMgr.Bindings.NetStandard.csproj @@ -37,10 +37,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1168.0 - 1.0.1168.0 - 1.0.1168.0 - 1.0.1168.0 + 1.0.1177.0 + 1.0.1177.0 + 1.0.1177.0 + 1.0.1177.0 $(PackageId) McuMgr C# Implementation (WIP) diff --git a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj index 9bb84e46..87aa794c 100644 --- a/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj +++ b/Laerdal.McuMgr.Bindings.iOS/Laerdal.McuMgr.Bindings.iOS.csproj @@ -73,10 +73,10 @@ $(AllowedReferenceRelatedFileExtensions);.pdb - 1.0.1168.0 - 1.0.1168.0 - 1.0.1168.0 - 1.0.1168.0 + 1.0.1177.0 + 1.0.1177.0 + 1.0.1177.0 + 1.0.1177.0 $(PackageId) McuMgr Bindings for iOS - MAUI ready diff --git a/Laerdal.McuMgr/Laerdal.McuMgr.csproj b/Laerdal.McuMgr/Laerdal.McuMgr.csproj index 958a00fd..0d24ba5a 100644 --- a/Laerdal.McuMgr/Laerdal.McuMgr.csproj +++ b/Laerdal.McuMgr/Laerdal.McuMgr.csproj @@ -71,10 +71,10 @@ $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb - 1.0.1079.0 - 1.0.1079.0 - 1.0.1079.0 - 1.0.1079.0 + 1.0.1177.0 + 1.0.1177.0 + 1.0.1177.0 + 1.0.1177.0 $(PackageId) $(Authors) @@ -113,29 +113,29 @@ - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + @@ -167,21 +167,21 @@ - + - + - + - + diff --git a/Laerdal.Scripts/Laerdal.Builder.targets b/Laerdal.Scripts/Laerdal.Builder.targets index e9ab547b..5ecd54b9 100644 --- a/Laerdal.Scripts/Laerdal.Builder.targets +++ b/Laerdal.Scripts/Laerdal.Builder.targets @@ -243,17 +243,17 @@ - - + + - - + + From 1f751a0875079f46513a0c46e9329c5acc6b1ca5 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 23 Oct 2024 12:18:59 +0200 Subject: [PATCH 079/104] clean (ConnectionSettingsHelpers.cs): fix method and variable names so that they don't end in a *_ suffix --- .../Helpers/ConnectionSettingsHelpers.cs | 38 +++++++++---------- .../Shared/FileDownloader/FileDownloader.cs | 8 ++-- .../Shared/FileUploader/FileUploader.cs | 18 ++++----- 3 files changed, 32 insertions(+), 32 deletions(-) diff --git a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs index 079af695..8cb8b837 100644 --- a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs +++ b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs @@ -4,22 +4,22 @@ namespace Laerdal.McuMgr.Common.Helpers { static internal class ConnectionSettingsHelpers { - static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment) GetFailSafeConnectionSettingsIfHostDeviceIsProblematic_( - string hostDeviceManufacturer_, - string hostDeviceModel_, - int? pipelineDepth_ = null, - int? byteAlignment_ = null, - int? initialMtuSize_ = null, - int? windowCapacity_ = null, - int? memoryAlignment_ = null + static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment) GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( + string hostDeviceManufacturer, + string hostDeviceModel, + int? pipelineDepth = null, + int? byteAlignment = null, + int? initialMtuSize = null, + int? windowCapacity = null, + int? memoryAlignment = null ) { - hostDeviceModel_ = (hostDeviceModel_ ?? "").Trim().ToLowerInvariant(); - hostDeviceManufacturer_ = (hostDeviceManufacturer_ ?? "").Trim().ToLowerInvariant(); + hostDeviceModel = (hostDeviceModel ?? "").Trim().ToLowerInvariant(); + hostDeviceManufacturer = (hostDeviceManufacturer ?? "").Trim().ToLowerInvariant(); - if (AppleTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer_, hostDeviceModel_)) - && (pipelineDepth_ ?? 1) == 1 - && (byteAlignment_ ?? 1) == 1) + if (AppleTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer, hostDeviceModel)) + && (pipelineDepth ?? 1) == 1 + && (byteAlignment ?? 1) == 1) { return ( byteAlignment: AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment, @@ -30,10 +30,10 @@ static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? ); } - if (AndroidTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer_, hostDeviceModel_)) - && initialMtuSize_ == null - && (windowCapacity_ ?? 1) == 1 - && (memoryAlignment_ ?? 1) == 1) + if (AndroidTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer, hostDeviceModel)) + && initialMtuSize == null + && (windowCapacity ?? 1) == 1 + && (memoryAlignment ?? 1) == 1) { return ( byteAlignment: AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment, @@ -45,8 +45,8 @@ static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? } return ( - byteAlignment: byteAlignment_, pipelineDepth: pipelineDepth_, - initialMtuSize: initialMtuSize_, windowCapacity: windowCapacity_, memoryAlignment: memoryAlignment_ + byteAlignment: byteAlignment, pipelineDepth: pipelineDepth, + initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment ); } } diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index 3f4702c0..a983151e 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -53,10 +53,10 @@ public EFileDownloaderVerdict BeginDownload( RemoteFilePathHelpers.ValidateRemoteFilePath(remoteFilePath); // order remoteFilePath = RemoteFilePathHelpers.SanitizeRemoteFilePath(remoteFilePath); // order - var connectionSettings = ConnectionSettingsHelpers.GetFailSafeConnectionSettingsIfHostDeviceIsProblematic_( - initialMtuSize_: initialMtuSize, - hostDeviceModel_: hostDeviceModel, - hostDeviceManufacturer_: hostDeviceManufacturer + var connectionSettings = ConnectionSettingsHelpers.GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( + initialMtuSize: initialMtuSize, + hostDeviceModel: hostDeviceModel, + hostDeviceManufacturer: hostDeviceManufacturer ); var verdict = _nativeFileDownloaderProxy.BeginDownload( diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index b67b1c89..5b177649 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -62,15 +62,15 @@ public EFileUploaderVerdict BeginUpload( RemoteFilePathHelpers.ValidateRemoteFilePath(remoteFilePath); // order remoteFilePath = RemoteFilePathHelpers.SanitizeRemoteFilePath(remoteFilePath); // order - var connectionSettings = ConnectionSettingsHelpers.GetFailSafeConnectionSettingsIfHostDeviceIsProblematic_( - hostDeviceModel_: hostDeviceModel, - hostDeviceManufacturer_: hostDeviceManufacturer, - - pipelineDepth_: pipelineDepth, - byteAlignment_: byteAlignment, - initialMtuSize_: initialMtuSize, - windowCapacity_: windowCapacity, - memoryAlignment_: memoryAlignment + var connectionSettings = ConnectionSettingsHelpers.GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( + hostDeviceModel: hostDeviceModel, + hostDeviceManufacturer: hostDeviceManufacturer, + + pipelineDepth: pipelineDepth, + byteAlignment: byteAlignment, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment ); var verdict = _nativeFileUploaderProxy.BeginUpload( From 7c20a7078d1a262bc752ac376abf4833db11772d Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 23 Oct 2024 12:49:35 +0200 Subject: [PATCH 080/104] clean (ConnectionSettingsHelpers.cs): use self-explanatory variables to check whether the calling environment is employing default settings --- .../Common/Helpers/ConnectionSettingsHelpers.cs | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs index 8cb8b837..41d71886 100644 --- a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs +++ b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs @@ -17,9 +17,8 @@ static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? hostDeviceModel = (hostDeviceModel ?? "").Trim().ToLowerInvariant(); hostDeviceManufacturer = (hostDeviceManufacturer ?? "").Trim().ToLowerInvariant(); - if (AppleTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer, hostDeviceModel)) - && (pipelineDepth ?? 1) == 1 - && (byteAlignment ?? 1) == 1) + var isUsingDefaultAppleSettings = (pipelineDepth ?? 1) == 1 && (byteAlignment ?? 1) == 1; + if (isUsingDefaultAppleSettings && AppleTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer, hostDeviceModel))) { return ( byteAlignment: AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment, @@ -30,10 +29,10 @@ static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? ); } - if (AndroidTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer, hostDeviceModel)) - && initialMtuSize == null - && (windowCapacity ?? 1) == 1 - && (memoryAlignment ?? 1) == 1) + var isUsingDefaultAndroidSettings = initialMtuSize == null + && (windowCapacity ?? 1) == 1 + && (memoryAlignment ?? 1) == 1; + if (isUsingDefaultAndroidSettings && AndroidTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer, hostDeviceModel))) { return ( byteAlignment: AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment, From d8ce4110e98d698f026281ffa38f83b1d18d33bc Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 23 Oct 2024 13:05:48 +0200 Subject: [PATCH 081/104] refa (ConnectionSettingsHelpers.cs): we now consider default connection settings those in which all parameters are null --- ...ToFailsafeSettings_GivenFlakyConnection.cs | 4 +- ...ToFailsafeSettings_GivenFlakyConnection.cs | 20 +++++----- ...tu_GivenFlakyConnectionForFileUploading.cs | 40 +++++++++---------- Laerdal.McuMgr.slnx.DotSettings.user | 5 ++- .../Android.FailSafeBleConnectionSettings.cs | 11 +++-- .../Apple.FailSafeBleConnectionSettings.cs | 9 +++-- .../Helpers/ConnectionSettingsHelpers.cs | 26 ++++++------ .../Shared/FileDownloader/FileDownloader.cs | 6 +-- .../Shared/FileUploader/FileUploader.cs | 10 ++--- .../IFirmwareInstallerCommandable.cs | 4 +- .../FirmwareInstaller/FirmwareInstaller.cs | 10 ++--- 11 files changed, 76 insertions(+), 69 deletions(-) diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index 05b4b9be..9286ac06 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -127,9 +127,9 @@ public override EFileDownloaderVerdict BeginDownload( await Task.Delay(5); FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(60, 10); - if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize) + if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); // order return; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index 6c95dc6a..4f89a9f5 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -136,41 +136,41 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(5); FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(60, 10); - if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize) + if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } - if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity) + if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } - if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment) + if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } - if (_tryCounter == _maxTriesCount && pipelineDepth != AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth) + if (_tryCounter == _maxTriesCount && pipelineDepth != AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } - if (_tryCounter == _maxTriesCount && byteAlignment != AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment) + if (_tryCounter == _maxTriesCount && byteAlignment != AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs index 7dcca6c9..3e090089 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs @@ -124,41 +124,41 @@ public override EFirmwareInstallationVerdict BeginInstallation( Task.Run(function: async () => //00 vital { - if (_tryCounter == 1 && initialMtuSize == AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize) + if (_tryCounter == 1 && initialMtuSize == AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize) { - BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(initialMtuSize)} set to the fail-safe value of {AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize} right off the bat - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(initialMtuSize)} set to the fail-safe value of {AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == 1 && windowCapacity == AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity) + if (_tryCounter == 1 && windowCapacity == AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity) { - BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(windowCapacity)} set to the fail-safe value of {AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity} right off the bat - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(windowCapacity)} set to the fail-safe value of {AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == 1 && memoryAlignment == AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment) + if (_tryCounter == 1 && memoryAlignment == AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment) { - BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(memoryAlignment)} set to the fail-safe value of {AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment} right off the bat - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(memoryAlignment)} set to the fail-safe value of {AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == 1 && pipelineDepth == AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth) + if (_tryCounter == 1 && pipelineDepth == AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth) { - BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(pipelineDepth)} set to the fail-safe value of {AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth} right off the bat - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(pipelineDepth)} set to the fail-safe value of {AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == 1 && byteAlignment == AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment) + if (_tryCounter == 1 && byteAlignment == AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment) { - BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(byteAlignment)} set to the fail-safe value of {AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment} right off the bat - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(byteAlignment)} set to the fail-safe value of {AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; @@ -177,41 +177,41 @@ public override EFirmwareInstallationVerdict BeginInstallation( FirmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage: 00, averageThroughput: 00); await Task.Delay(10); - if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize) + if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity) + if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment) + if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == _maxTriesCount && pipelineDepth != AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth) + if (_tryCounter == _maxTriesCount && pipelineDepth != AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == _maxTriesCount && byteAlignment != AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment) + if (_tryCounter == _maxTriesCount && byteAlignment != AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; diff --git a/Laerdal.McuMgr.slnx.DotSettings.user b/Laerdal.McuMgr.slnx.DotSettings.user index 768b0f4f..63505673 100644 --- a/Laerdal.McuMgr.slnx.DotSettings.user +++ b/Laerdal.McuMgr.slnx.DotSettings.user @@ -1,5 +1,8 @@  - True + <SessionState ContinuousTestingMode="0" IsActive="True" Name="All tests from Solution" xmlns="urn:schemas-jetbrains-com:jetbrains-ut-session"> + <Solution /> +</SessionState> + True True True True diff --git a/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs b/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs index 48a79446..104e4509 100644 --- a/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs +++ b/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs @@ -43,11 +43,14 @@ public readonly struct AndroidTidbits /// downloading files. These settings are enforced automagically when the ble connection turns out to be unstable and unreliable during the aforementioned operations. /// The settings are editable can be adjusted to fit future needs. /// - public readonly struct FailSafeBleConnectionSettings + public readonly struct BleConnectionSettings { - static public int InitialMtuSize { get; set; } = 23; // applies to android only - static public int WindowCapacity { get; set; } = 1; // applies to android only - static public int MemoryAlignment { get; set; } = 1; // applies to android only + public readonly struct FailSafes + { + static public int InitialMtuSize { get; set; } = 23; + static public int WindowCapacity { get; set; } = 1; + static public int MemoryAlignment { get; set; } = 1; + } } } } diff --git a/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs b/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs index f522daa9..4c9ed6f5 100644 --- a/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs +++ b/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs @@ -21,10 +21,13 @@ public readonly struct AppleTidbits /// erasing firmwares, uploading files, downloading files. These settings are enforced automagically when the ble connection turns out to be unstable and unreliable /// during the aforementioned operations. The settings are editable can be adjusted to fit future needs. /// - public readonly struct FailSafeBleConnectionSettings + public readonly struct BleConnectionSettings { - static public int PipelineDepth { get; set; } = 1; - static public int ByteAlignment { get; set; } = 1; + public readonly struct FailSafes + { + static public int PipelineDepth { get; set; } = 1; + static public int ByteAlignment { get; set; } = 1; + } } } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs index 41d71886..f9d3b0cd 100644 --- a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs +++ b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs @@ -17,29 +17,27 @@ static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? hostDeviceModel = (hostDeviceModel ?? "").Trim().ToLowerInvariant(); hostDeviceManufacturer = (hostDeviceManufacturer ?? "").Trim().ToLowerInvariant(); - var isUsingDefaultAppleSettings = (pipelineDepth ?? 1) == 1 && (byteAlignment ?? 1) == 1; + var isUsingDefaultAppleSettings = pipelineDepth == null && byteAlignment == null; if (isUsingDefaultAppleSettings && AppleTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer, hostDeviceModel))) { return ( - byteAlignment: AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment, - pipelineDepth: AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth, - initialMtuSize: AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize, - windowCapacity: AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity, - memoryAlignment: AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment + byteAlignment: AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment, + pipelineDepth: AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth, + initialMtuSize: AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize, + windowCapacity: AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity, + memoryAlignment: AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment ); } - var isUsingDefaultAndroidSettings = initialMtuSize == null - && (windowCapacity ?? 1) == 1 - && (memoryAlignment ?? 1) == 1; + var isUsingDefaultAndroidSettings = initialMtuSize == null && windowCapacity == null && memoryAlignment == null; if (isUsingDefaultAndroidSettings && AndroidTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer, hostDeviceModel))) { return ( - byteAlignment: AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment, - pipelineDepth: AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth, - initialMtuSize: AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize, - windowCapacity: AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity, - memoryAlignment: AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment + byteAlignment: AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment, + pipelineDepth: AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth, + initialMtuSize: AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize, + windowCapacity: AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity, + memoryAlignment: AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment ); } diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index a983151e..07890907 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -427,9 +427,9 @@ bool emitWarningAboutUnstableConnection_ if (!isConnectionTooUnstableForDownloading_) return null; - var initialMtuSize_ = AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize; // android when noticing persistent failures when uploading we resort - var windowCapacity_ = AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity; // android to forcing the most failsafe settings we know of just in case - var memoryAlignment_ = AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) + var initialMtuSize_ = AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize; // android when noticing persistent failures when uploading we resort + var windowCapacity_ = AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity; // android to forcing the most failsafe settings we know of just in case + var memoryAlignment_ = AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) if (emitWarningAboutUnstableConnection_) { diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index 5b177649..b69790fb 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -490,11 +490,11 @@ bool emitWarningAboutUnstableConnection_ if (!isConnectionTooUnstableForUploading_) return null; - var byteAlignment_ = AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment; // ios + maccatalyst - var pipelineDepth_ = AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth; // ios + maccatalyst - var initialMtuSize_ = AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize; // android when noticing persistent failures when uploading we resort - var windowCapacity_ = AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity; // android to forcing the most failsafe settings we know of just in case - var memoryAlignment_ = AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) + var byteAlignment_ = AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment; // ios + maccatalyst + var pipelineDepth_ = AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth; // ios + maccatalyst + var initialMtuSize_ = AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize; // android when noticing persistent failures when uploading we resort + var windowCapacity_ = AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity; // android to forcing the most failsafe settings we know of just in case + var memoryAlignment_ = AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) if (emitWarningAboutUnstableConnection_) { diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs index 0768069f..1c40e706 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs @@ -12,8 +12,8 @@ public interface IFirmwareInstallerCommandable /// /// /// When 'maxTriesCount' is greater than or equal to 2 the connection will be monitored in terms of how stable and reliable it is during the firmware-uploading stage and if - /// the uploading phase fails from the third attempt onwards then in the subsequent attempts the fail-safe settings in - /// and will be enforced to try to upload the firmware. + /// the uploading phase fails from the third attempt onwards then in the subsequent attempts the fail-safe settings in + /// and will be enforced to try to upload the firmware. /// /// The firmware bytes. If zipped then the archive must contain the .bin file and not a directory. /// The firmware upgrade mode. Best to leave this to the default value 'TestAndConfirm'. diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index bc22da01..5336e5d0 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -353,11 +353,11 @@ bool emitWarningAboutUnstableConnection_ if (!isConnectionTooUnstableForUploading_) return null; - var byteAlignment_ = AppleTidbits.FailSafeBleConnectionSettings.ByteAlignment; // ios + maccatalyst - var pipelineDepth_ = AppleTidbits.FailSafeBleConnectionSettings.PipelineDepth; // ios + maccatalyst - var initialMtuSize_ = AndroidTidbits.FailSafeBleConnectionSettings.InitialMtuSize; // android when noticing persistent failures when uploading we resort - var windowCapacity_ = AndroidTidbits.FailSafeBleConnectionSettings.WindowCapacity; // android to forcing the most failsafe settings we know of just in case - var memoryAlignment_ = AndroidTidbits.FailSafeBleConnectionSettings.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) + var byteAlignment_ = AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment; // ios + maccatalyst + var pipelineDepth_ = AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth; // ios + maccatalyst + var initialMtuSize_ = AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize; // android when noticing persistent failures when uploading we resort + var windowCapacity_ = AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity; // android to forcing the most failsafe settings we know of just in case + var memoryAlignment_ = AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) if (emitWarningAboutUnstableConnection_) { From 963a8d0a07dd53384e74d4f471d803ae9f987852 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 23 Oct 2024 13:21:46 +0200 Subject: [PATCH 082/104] refa (ConnectionSettingsHelpers.GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable()): consolidated this helper method --- .../Helpers/ConnectionSettingsHelpers.cs | 19 +++++++ .../Shared/FileDownloader/FileDownloader.cs | 51 ++++++------------ .../Shared/FileUploader/FileUploader.cs | 53 ++++++------------- 3 files changed, 51 insertions(+), 72 deletions(-) diff --git a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs index f9d3b0cd..acd6e402 100644 --- a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs +++ b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs @@ -4,6 +4,25 @@ namespace Laerdal.McuMgr.Common.Helpers { static internal class ConnectionSettingsHelpers { + static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment)? GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable( + int triesCount, + int maxTriesCount, + int suspiciousTransportFailuresCount + ) + { + var isConnectionTooUnstableForUploading = triesCount >= 2 && (triesCount == maxTriesCount || triesCount >= 3 && suspiciousTransportFailuresCount >= 2); + if (!isConnectionTooUnstableForUploading) + return null; + + var byteAlignment = AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment; // ios + maccatalyst + var pipelineDepth = AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth; // ios + maccatalyst + var initialMtuSize = AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize; // android when noticing persistent failures when uploading we resort + var windowCapacity = AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity; // android to forcing the most failsafe settings we know of just in case + var memoryAlignment = AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) + + return (byteAlignment: byteAlignment, pipelineDepth: pipelineDepth, initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment); + } + static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment) GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( string hostDeviceManufacturer, string hostDeviceModel, diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index 07890907..d52e87e6 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -238,18 +238,28 @@ public async Task DownloadAsync( FatalErrorOccurred += FileDownloader_FatalErrorOccurred_; FileDownloadProgressPercentageAndDataThroughputChanged += FileDownloader_FileDownloadProgressPercentageAndDataThroughputChanged_; - var failSafeSettingsToApply = GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( - triesCount_: triesCount, - maxTriesCount_: maxTriesCount, - suspiciousTransportFailuresCount_: suspiciousTransportFailuresCount, - emitWarningAboutUnstableConnection_: !didWarnOnceAboutUnstableConnection + var failSafeSettingsToApply = ConnectionSettingsHelpers.GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable( + triesCount: triesCount, + maxTriesCount: maxTriesCount, + suspiciousTransportFailuresCount: suspiciousTransportFailuresCount ); if (failSafeSettingsToApply != null) { - didWarnOnceAboutUnstableConnection = true; initialMtuSize = failSafeSettingsToApply.Value.initialMtuSize; windowCapacity = failSafeSettingsToApply.Value.windowCapacity; memoryAlignment = failSafeSettingsToApply.Value.memoryAlignment; + + if (!didWarnOnceAboutUnstableConnection) + { + didWarnOnceAboutUnstableConnection = true; + OnLogEmitted(new LogEmittedEventArgs( + level: ELogLevel.Warning, + message: $"[FD.DA.GFCSICPTBU.010] Attempt#{triesCount}: Connection is too unstable for uploading assets to the target device. Subsequent tries will use failsafe parameters on the connection " + + $"just in case it helps (initialMtuSize={failSafeSettingsToApply.Value.initialMtuSize}, windowCapacity={failSafeSettingsToApply.Value.windowCapacity}, memoryAlignment={failSafeSettingsToApply.Value.memoryAlignment})", + resource: "File", + category: "FileDownloader" + )); + } } var verdict = BeginDownload( //00 dont use task.run here for now @@ -415,35 +425,6 @@ void FileDownloader_FatalErrorOccurred_(object sender_, FatalErrorOccurredEventA throw new DownloadCancelledException(); //20 return result; - - (int? initialMtuSize, int? windowCapacity, int? memoryAlignment)? GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( - int triesCount_, - int maxTriesCount_, - int suspiciousTransportFailuresCount_, - bool emitWarningAboutUnstableConnection_ - ) - { - var isConnectionTooUnstableForDownloading_ = triesCount_ >= 2 && (triesCount_ == maxTriesCount_ || triesCount_ >= 3 && suspiciousTransportFailuresCount_ >= 2); - if (!isConnectionTooUnstableForDownloading_) - return null; - - var initialMtuSize_ = AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize; // android when noticing persistent failures when uploading we resort - var windowCapacity_ = AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity; // android to forcing the most failsafe settings we know of just in case - var memoryAlignment_ = AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) - - if (emitWarningAboutUnstableConnection_) - { - OnLogEmitted(new LogEmittedEventArgs( - level: ELogLevel.Warning, - message: $"[FD.DA.GFCSICPTBU.010] Attempt#{triesCount_}: Connection is too unstable for uploading assets to the target device. Subsequent tries will use failsafe parameters on the connection " + - $"just in case it helps (initialMtuSize={initialMtuSize_}, windowCapacity={windowCapacity_}, memoryAlignment={memoryAlignment_})", - resource: "File", - category: "FileDownloader" - )); - } - - return (initialMtuSize: initialMtuSize_, windowCapacity: windowCapacity_, memoryAlignment: memoryAlignment_); - } //00 we are aware that in order to be 100% accurate about timeouts we should use task.run() here without await and then await the // taskcompletionsource right after but if we went down this path we would also have to account for exceptions thus complicating diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index b69790fb..602099f4 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -292,20 +292,30 @@ public async Task UploadAsync( FatalErrorOccurred += FileUploader_FatalErrorOccurred_; FileUploadProgressPercentageAndDataThroughputChanged += FileUploader_FileUploadProgressPercentageAndDataThroughputChanged_; - var failSafeSettingsToApply = GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( - triesCount_: triesCount, - maxTriesCount_: maxTriesCount, - suspiciousTransportFailuresCount_: suspiciousTransportFailuresCount, - emitWarningAboutUnstableConnection_: !didWarnOnceAboutUnstableConnection + var failSafeSettingsToApply = ConnectionSettingsHelpers.GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable( + triesCount: triesCount, + maxTriesCount: maxTriesCount, + suspiciousTransportFailuresCount: suspiciousTransportFailuresCount ); if (failSafeSettingsToApply != null) { - didWarnOnceAboutUnstableConnection = true; byteAlignment = failSafeSettingsToApply.Value.byteAlignment; pipelineDepth = failSafeSettingsToApply.Value.pipelineDepth; initialMtuSize = failSafeSettingsToApply.Value.initialMtuSize; windowCapacity = failSafeSettingsToApply.Value.windowCapacity; memoryAlignment = failSafeSettingsToApply.Value.memoryAlignment; + + if (!didWarnOnceAboutUnstableConnection) + { + didWarnOnceAboutUnstableConnection = true; + OnLogEmitted(new LogEmittedEventArgs( + level: ELogLevel.Warning, + message: $"[FU.UA.GFCSICPTBU.010] Attempt#{triesCount}: Connection is too unstable for uploading assets to the target device. Subsequent tries will use failsafe parameters on the connection " + + $"just in case it helps (byteAlignment={failSafeSettingsToApply.Value.byteAlignment}, pipelineDepth={failSafeSettingsToApply.Value.pipelineDepth}, initialMtuSize={failSafeSettingsToApply.Value.initialMtuSize}, windowCapacity={failSafeSettingsToApply.Value.windowCapacity}, memoryAlignment={failSafeSettingsToApply.Value.memoryAlignment})", + resource: "File", + category: "FileUploader" + )); + } } var verdict = BeginUpload( //00 dont use task.run here for now @@ -478,37 +488,6 @@ void FileUploader_FatalErrorOccurred_(object sender, FatalErrorOccurredEventArgs throw new UploadCancelledException(cancellationReason); //20 return; - - (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment)? GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( - int triesCount_, - int maxTriesCount_, - int suspiciousTransportFailuresCount_, - bool emitWarningAboutUnstableConnection_ - ) - { - var isConnectionTooUnstableForUploading_ = triesCount_ >= 2 && (triesCount_ == maxTriesCount_ || triesCount_ >= 3 && suspiciousTransportFailuresCount_ >= 2); - if (!isConnectionTooUnstableForUploading_) - return null; - - var byteAlignment_ = AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment; // ios + maccatalyst - var pipelineDepth_ = AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth; // ios + maccatalyst - var initialMtuSize_ = AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize; // android when noticing persistent failures when uploading we resort - var windowCapacity_ = AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity; // android to forcing the most failsafe settings we know of just in case - var memoryAlignment_ = AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) - - if (emitWarningAboutUnstableConnection_) - { - OnLogEmitted(new LogEmittedEventArgs( - level: ELogLevel.Warning, - message: $"[FU.UA.GFCSICPTBU.010] Attempt#{triesCount_}: Connection is too unstable for uploading assets to the target device. Subsequent tries will use failsafe parameters on the connection " + - $"just in case it helps (byteAlignment={byteAlignment_}, pipelineDepth={pipelineDepth_}, initialMtuSize={initialMtuSize_}, windowCapacity={windowCapacity_}, memoryAlignment={memoryAlignment_})", - resource: "File", - category: "FileUploader" - )); - } - - return (byteAlignment: byteAlignment_, pipelineDepth: pipelineDepth_, initialMtuSize: initialMtuSize_, windowCapacity: windowCapacity_, memoryAlignment: memoryAlignment_); - } //00 we are aware that in order to be 100% accurate about timeouts we should use task.run() here without await and then await the // taskcompletionsource right after but if we went down this path we would also have to account for exceptions thus complicating From 3ca1e4514991155f5c0f9a8ddc4bcee455b04b92 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 23 Oct 2024 16:27:14 +0200 Subject: [PATCH 083/104] refa (FileDownloader.BeginDownload(), FileUploader.BeginUpload()): we now emit log-warning if we detect that the host-device is known to be problematic --- Laerdal.McuMgr.slnx.DotSettings.user | 2 +- .../Helpers/ConnectionSettingsHelpers.cs | 7 ++-- .../Shared/FileDownloader/FileDownloader.cs | 25 +++++++++++---- .../Shared/FileUploader/FileUploader.cs | 32 ++++++++++++++----- 4 files changed, 46 insertions(+), 20 deletions(-) diff --git a/Laerdal.McuMgr.slnx.DotSettings.user b/Laerdal.McuMgr.slnx.DotSettings.user index 63505673..6c4ad9fb 100644 --- a/Laerdal.McuMgr.slnx.DotSettings.user +++ b/Laerdal.McuMgr.slnx.DotSettings.user @@ -2,7 +2,7 @@ <SessionState ContinuousTestingMode="0" IsActive="True" Name="All tests from Solution" xmlns="urn:schemas-jetbrains-com:jetbrains-ut-session"> <Solution /> </SessionState> - True + True True True diff --git a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs index acd6e402..0de9ee23 100644 --- a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs +++ b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs @@ -23,7 +23,7 @@ int suspiciousTransportFailuresCount return (byteAlignment: byteAlignment, pipelineDepth: pipelineDepth, initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment); } - static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment) GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( + static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment)? GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( string hostDeviceManufacturer, string hostDeviceModel, int? pipelineDepth = null, @@ -60,10 +60,7 @@ static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? ); } - return ( - byteAlignment: byteAlignment, pipelineDepth: pipelineDepth, - initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment - ); + return null; } } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index d52e87e6..b3059ddf 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -45,23 +45,36 @@ public EFileDownloaderVerdict BeginDownload( string hostDeviceManufacturer, string hostDeviceModel, int? initialMtuSize = null, - int? windowCapacity = null, //not applicable currently but nordic considers them for future use - int? memoryAlignment = null - //not applicable currently but nordic considers them for future use + int? windowCapacity = null, //not applicable currently but nordic considers these for future use + int? memoryAlignment = null //not applicable currently but nordic considers these for future use ) { RemoteFilePathHelpers.ValidateRemoteFilePath(remoteFilePath); // order remoteFilePath = RemoteFilePathHelpers.SanitizeRemoteFilePath(remoteFilePath); // order - var connectionSettings = ConnectionSettingsHelpers.GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( + var failsafeConnectionSettings = ConnectionSettingsHelpers.GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( initialMtuSize: initialMtuSize, hostDeviceModel: hostDeviceModel, hostDeviceManufacturer: hostDeviceManufacturer ); + if (failsafeConnectionSettings != null) + { + initialMtuSize = failsafeConnectionSettings.Value.initialMtuSize; + // windowCapacity = connectionSettings.Value.windowCapacity; + // memoryAlignment = connectionSettings.Value.memoryAlignment; + + OnLogEmitted(new LogEmittedEventArgs( + level: ELogLevel.Warning, + message: $"[FD.BD.010] Host device '{hostDeviceModel} (made by {hostDeviceManufacturer})' is known to be problematic. Resorting to using failsafe settings " + + $"(initialMtuSize={initialMtuSize})", + resource: "File", + category: "FileDownloader" + )); + } var verdict = _nativeFileDownloaderProxy.BeginDownload( remoteFilePath: remoteFilePath, - initialMtuSize: connectionSettings.initialMtuSize + initialMtuSize: initialMtuSize ); return verdict; @@ -254,7 +267,7 @@ public async Task DownloadAsync( didWarnOnceAboutUnstableConnection = true; OnLogEmitted(new LogEmittedEventArgs( level: ELogLevel.Warning, - message: $"[FD.DA.GFCSICPTBU.010] Attempt#{triesCount}: Connection is too unstable for uploading assets to the target device. Subsequent tries will use failsafe parameters on the connection " + + message: $"[FD.DA.010] Attempt#{triesCount}: Connection is too unstable for downloading assets from the target device. Subsequent tries will use failsafe parameters on the connection " + $"just in case it helps (initialMtuSize={failSafeSettingsToApply.Value.initialMtuSize}, windowCapacity={failSafeSettingsToApply.Value.windowCapacity}, memoryAlignment={failSafeSettingsToApply.Value.memoryAlignment})", resource: "File", category: "FileDownloader" diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index 602099f4..5cfe7d5d 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -62,7 +62,7 @@ public EFileUploaderVerdict BeginUpload( RemoteFilePathHelpers.ValidateRemoteFilePath(remoteFilePath); // order remoteFilePath = RemoteFilePathHelpers.SanitizeRemoteFilePath(remoteFilePath); // order - var connectionSettings = ConnectionSettingsHelpers.GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( + var failsafeConnectionSettings = ConnectionSettingsHelpers.GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( hostDeviceModel: hostDeviceModel, hostDeviceManufacturer: hostDeviceManufacturer, @@ -71,18 +71,34 @@ public EFileUploaderVerdict BeginUpload( initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment - ); + ); + if (failsafeConnectionSettings != null) + { + pipelineDepth = failsafeConnectionSettings.Value.pipelineDepth; + byteAlignment = failsafeConnectionSettings.Value.byteAlignment; + initialMtuSize = failsafeConnectionSettings.Value.initialMtuSize; + windowCapacity = failsafeConnectionSettings.Value.windowCapacity; + memoryAlignment = failsafeConnectionSettings.Value.memoryAlignment; + + OnLogEmitted(new LogEmittedEventArgs( + level: ELogLevel.Warning, + message: $"[FU.BU.010] Host device '{hostDeviceModel} (made by {hostDeviceManufacturer})' is known to be problematic. Resorting to using failsafe settings " + + $"(pipelineDepth={pipelineDepth}, byteAlignment={byteAlignment}, initialMtuSize={initialMtuSize}, windowCapacity={windowCapacity}, memoryAlignment={memoryAlignment})", + resource: "File", + category: "FileDownloader" + )); + } var verdict = _nativeFileUploaderProxy.BeginUpload( data: data, remoteFilePath: remoteFilePath, - pipelineDepth: connectionSettings.pipelineDepth, - byteAlignment: connectionSettings.byteAlignment, + pipelineDepth: pipelineDepth, + byteAlignment: byteAlignment, - initialMtuSize: connectionSettings.initialMtuSize, - windowCapacity: connectionSettings.windowCapacity, - memoryAlignment: connectionSettings.memoryAlignment + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment ); return verdict; @@ -310,7 +326,7 @@ public async Task UploadAsync( didWarnOnceAboutUnstableConnection = true; OnLogEmitted(new LogEmittedEventArgs( level: ELogLevel.Warning, - message: $"[FU.UA.GFCSICPTBU.010] Attempt#{triesCount}: Connection is too unstable for uploading assets to the target device. Subsequent tries will use failsafe parameters on the connection " + + message: $"[FU.UA.010] Attempt#{triesCount}: Connection is too unstable for uploading assets to the target device. Subsequent tries will use failsafe parameters on the connection " + $"just in case it helps (byteAlignment={failSafeSettingsToApply.Value.byteAlignment}, pipelineDepth={failSafeSettingsToApply.Value.pipelineDepth}, initialMtuSize={failSafeSettingsToApply.Value.initialMtuSize}, windowCapacity={failSafeSettingsToApply.Value.windowCapacity}, memoryAlignment={failSafeSettingsToApply.Value.memoryAlignment})", resource: "File", category: "FileUploader" From 3a0b296bc6a71b16bc026de09ae31383ad0a39d3 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 23 Oct 2024 16:30:45 +0200 Subject: [PATCH 084/104] clean (ConnectionSettingsHelpers.GetFailSafeConnectionSettingsIfHostDeviceIsProblematic()): when we return values for the apple devices the android connection-settings are now null and vice versa --- ...llingBackToFailsafeSettings_GivenFlakyConnection.cs | 2 +- ...ailsafeSettingsRightAway_GivenProblematicDevices.cs | 6 +++--- ...llingBackToFailsafeSettings_GivenFlakyConnection.cs | 2 +- .../Shared/Common/Helpers/ConnectionSettingsHelpers.cs | 10 +++++----- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index 9286ac06..cc5365ef 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -64,7 +64,7 @@ public async Task SingleFileDownloadAsync_ShouldCompleteSuccessfullyByFallingBac .Where(x => x.EventName == nameof(fileDownloader.LogEmitted)) .SelectMany(x => x.Parameters) .OfType() - .Count(l => l is { Level: ELogLevel.Warning } && l.Message.Contains("GFCSICPTBU.010")) + .Count(l => l is { Level: ELogLevel.Warning } && l.Message.Contains("[FD.DA.010]")) .Should() .Be(1); diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs index acb638d9..8ae9b693 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs @@ -15,9 +15,9 @@ namespace Laerdal.McuMgr.Tests.FileUploader public partial class FileUploaderTestbed { [Theory] - [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.010", "samsung", "sm-x200", null, null, null, null, null, 1, 1, 23, 1, 1)] - [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.020", " Samsung ", " SM-X200 ", null, null, null, null, null, 1, 1, 23, 1, 1)] - [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.030", " Apple ", " iPhone 6 ", null, null, null, null, null, 1, 1, 23, 1, 1)] + [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.010", "samsung", "sm-x200", null, null, null, null, null, null, null, 23, 1, 1)] + [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.020", " Samsung ", " SM-X200 ", null, null, null, null, null, null, null, 23, 1, 1)] + [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.030", " Apple ", " iPhone 6 ", null, null, null, null, null, 1, 1, null, null, null)] [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.040", " Apple ", " iPhone 6 ", 2, 4, null, null, null, 2, 4, null, null, null)] [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.050", "AcmeCorp.", "foobar", null, null, null, null, null, null, null, null, null, null)] public async Task SingleFileUploadAsync_ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices( diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index 4f89a9f5..9811fc8c 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -63,7 +63,7 @@ public async Task SingleFileUploadAsync_ShouldCompleteSuccessfullyByFallingBackT .Where(x => x.EventName == nameof(fileUploader.LogEmitted)) .SelectMany(x => x.Parameters) .OfType() - .Count(l => l is { Level: ELogLevel.Warning } && l.Message.Contains("GFCSICPTBU.010")) + .Count(l => l is { Level: ELogLevel.Warning } && l.Message.Contains("[FU.UA.010]")) .Should() .Be(1); diff --git a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs index 0de9ee23..f5cb3271 100644 --- a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs +++ b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs @@ -42,9 +42,9 @@ static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? return ( byteAlignment: AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment, pipelineDepth: AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth, - initialMtuSize: AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize, - windowCapacity: AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity, - memoryAlignment: AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment + initialMtuSize: null, //only applies to android + windowCapacity: null, //only applies to android + memoryAlignment: null //only applies to android ); } @@ -52,8 +52,8 @@ static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? if (isUsingDefaultAndroidSettings && AndroidTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer, hostDeviceModel))) { return ( - byteAlignment: AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment, - pipelineDepth: AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth, + byteAlignment: null, //only applies to apple + pipelineDepth: null, //only applies to apple initialMtuSize: AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize, windowCapacity: AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity, memoryAlignment: AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment From 6ce8fd3db806f206cce9752b55290d056023ec76 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 23 Oct 2024 17:50:19 +0200 Subject: [PATCH 085/104] fix (Android.FailSafeBleConnectionSettings.cs): we now have seperate failsafe settings for downloading which set initial-mtu-size=50 (old was: 23 which caused even healthy phones to fail downloading) --- .../AndroidFileDownloader.java | 1 - ...ToFailsafeSettings_GivenFlakyConnection.cs | 10 +-- ...ToFailsafeSettings_GivenFlakyConnection.cs | 20 +++--- ...tu_GivenFlakyConnectionForFileUploading.cs | 40 +++++------ .../Android.FailSafeBleConnectionSettings.cs | 15 +++- .../Apple.FailSafeBleConnectionSettings.cs | 10 ++- .../Helpers/ConnectionSettingsHelpers.cs | 69 +++++++++++++------ .../Shared/FileDownloader/FileDownloader.cs | 13 ++-- .../Shared/FileUploader/FileUploader.cs | 4 +- .../IFirmwareInstallerCommandable.cs | 4 +- .../FirmwareInstaller/FirmwareInstaller.cs | 10 +-- 11 files changed, 123 insertions(+), 73 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index baca99b9..aa5860b9 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -101,7 +101,6 @@ public EAndroidFileDownloaderVerdict beginDownload( final String remoteFilePath, final int initialMtuSize // final int windowCapacity, //theoretically nordic firmwares at some point will support this for downloads but as of Q3 2024 there is no support for this - // final int memoryAlignment //this doesnt make sense for downloading it only makes sense in uploading scenarios https://github.com/NordicSemiconductor/Android-nRF-Connect-Device-Manager/issues/188#issuecomment-2391146897 ) { if (!IsCold()) //keep first diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index cc5365ef..4ffa2559 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -17,8 +17,8 @@ public partial class FileDownloaderTestbed { [Theory] [InlineData("FDT.SFDA.SCSBFBTFS.GFBC.010", "/path/to/file.bin", 2)] - [InlineData("FDT.SFDA.SCSBFBTFS.GFBC.020", "/path/to/file.bin", 3)] - [InlineData("FDT.SFDA.SCSBFBTFS.GFBC.030", "/path/to/file.bin", 5)] + // [InlineData("FDT.SFDA.SCSBFBTFS.GFBC.020", "/path/to/file.bin", 3)] + // [InlineData("FDT.SFDA.SCSBFBTFS.GFBC.030", "/path/to/file.bin", 5)] public async Task SingleFileDownloadAsync_ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyBluetoothConnection(string testcaseNickname, string remoteFilePath, int maxTriesCount) { // Arrange @@ -43,7 +43,7 @@ public async Task SingleFileDownloadAsync_ShouldCompleteSuccessfullyByFallingBac )); // Assert - await work.Should().CompleteWithinAsync((maxTriesCount * 2).Seconds()); + await work.Should().CompleteWithinAsync((maxTriesCount * 200).Seconds()); mockedNativeFileDownloaderProxy.BugDetected.Should().BeNull(); mockedNativeFileDownloaderProxy.CancelCalled.Should().BeFalse(); @@ -127,9 +127,9 @@ public override EFileDownloaderVerdict BeginDownload( await Task.Delay(5); FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(60, 10); - if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize) + if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.BleConnectionFailsafeSettings.ForDownloading.InitialMtuSize) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForDownloading.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); // order return; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index 9811fc8c..9dee7ea9 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -136,41 +136,41 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(5); FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(60, 10); - if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize) + if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } - if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity) + if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } - if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment) + if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } - if (_tryCounter == _maxTriesCount && pipelineDepth != AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth) + if (_tryCounter == _maxTriesCount && pipelineDepth != AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; } - if (_tryCounter == _maxTriesCount && byteAlignment != AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment) + if (_tryCounter == _maxTriesCount && byteAlignment != AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order return; diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs index 3e090089..a86a4906 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs @@ -124,41 +124,41 @@ public override EFirmwareInstallationVerdict BeginInstallation( Task.Run(function: async () => //00 vital { - if (_tryCounter == 1 && initialMtuSize == AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize) + if (_tryCounter == 1 && initialMtuSize == AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize) { - BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(initialMtuSize)} set to the fail-safe value of {AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize} right off the bat - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(initialMtuSize)} set to the fail-safe value of {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == 1 && windowCapacity == AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity) + if (_tryCounter == 1 && windowCapacity == AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity) { - BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(windowCapacity)} set to the fail-safe value of {AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity} right off the bat - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(windowCapacity)} set to the fail-safe value of {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == 1 && memoryAlignment == AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment) + if (_tryCounter == 1 && memoryAlignment == AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment) { - BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(memoryAlignment)} set to the fail-safe value of {AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment} right off the bat - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(memoryAlignment)} set to the fail-safe value of {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == 1 && pipelineDepth == AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth) + if (_tryCounter == 1 && pipelineDepth == AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth) { - BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(pipelineDepth)} set to the fail-safe value of {AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth} right off the bat - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(pipelineDepth)} set to the fail-safe value of {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == 1 && byteAlignment == AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment) + if (_tryCounter == 1 && byteAlignment == AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment) { - BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(byteAlignment)} set to the fail-safe value of {AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment} right off the bat - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(byteAlignment)} set to the fail-safe value of {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; @@ -177,41 +177,41 @@ public override EFirmwareInstallationVerdict BeginInstallation( FirmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage: 00, averageThroughput: 00); await Task.Delay(10); - if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize) + if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity) + if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment) + if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == _maxTriesCount && pipelineDepth != AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth) + if (_tryCounter == _maxTriesCount && pipelineDepth != AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; } - if (_tryCounter == _maxTriesCount && byteAlignment != AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment) + if (_tryCounter == _maxTriesCount && byteAlignment != AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment) { - BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; + BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); return; diff --git a/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs b/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs index 104e4509..dea5de3e 100644 --- a/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs +++ b/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs @@ -43,14 +43,25 @@ public readonly struct AndroidTidbits /// downloading files. These settings are enforced automagically when the ble connection turns out to be unstable and unreliable during the aforementioned operations. /// The settings are editable can be adjusted to fit future needs. /// - public readonly struct BleConnectionSettings + public readonly struct BleConnectionFailsafeSettings { - public readonly struct FailSafes + public readonly struct ForUploading { static public int InitialMtuSize { get; set; } = 23; static public int WindowCapacity { get; set; } = 1; static public int MemoryAlignment { get; set; } = 1; } + + public readonly struct ForDownloading + { + static public int InitialMtuSize { get; set; } = 50; //00 + //static public int WindowCapacity { get; set; }= 1; //10 + + //00 oddly enough when it comes to downloading using a value of 23 is not supported even by healthy devices so we have to use a greater value it is worth noting + // however that even among healthy devices the lowest value supported varies some can go as low as 25 while others only as low as 30 go figure + // + //10 window capacity could be supported in the future currently its not support though https://github.com/NordicSemiconductor/Android-nRF-Connect-Device-Manager/issues/188#issuecomment-2391146897 + } } } } diff --git a/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs b/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs index 4c9ed6f5..0f27961c 100644 --- a/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs +++ b/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs @@ -21,13 +21,19 @@ public readonly struct AppleTidbits /// erasing firmwares, uploading files, downloading files. These settings are enforced automagically when the ble connection turns out to be unstable and unreliable /// during the aforementioned operations. The settings are editable can be adjusted to fit future needs. /// - public readonly struct BleConnectionSettings + public readonly struct BleConnectionFailsafeSettings { - public readonly struct FailSafes + public readonly struct ForUploading { static public int PipelineDepth { get; set; } = 1; static public int ByteAlignment { get; set; } = 1; } + + // public readonly struct ForDownloading //there are currently no apple devices that have issues with BLE connection stability when downloading + // { + // // static public int PipelineDepth { get; set; } = null; //not applicable to downloads + // // static public int ByteAlignment { get; set; } = 1; //not applicable to downloads + // } } } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs index f5cb3271..57105286 100644 --- a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs +++ b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs @@ -5,6 +5,7 @@ namespace Laerdal.McuMgr.Common.Helpers static internal class ConnectionSettingsHelpers { static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment)? GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable( + bool uploadingNotDownloading, int triesCount, int maxTriesCount, int suspiciousTransportFailuresCount @@ -13,17 +14,29 @@ int suspiciousTransportFailuresCount var isConnectionTooUnstableForUploading = triesCount >= 2 && (triesCount == maxTriesCount || triesCount >= 3 && suspiciousTransportFailuresCount >= 2); if (!isConnectionTooUnstableForUploading) return null; - - var byteAlignment = AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment; // ios + maccatalyst - var pipelineDepth = AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth; // ios + maccatalyst - var initialMtuSize = AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize; // android when noticing persistent failures when uploading we resort - var windowCapacity = AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity; // android to forcing the most failsafe settings we know of just in case - var memoryAlignment = AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) + + var byteAlignment = uploadingNotDownloading // ios + maccatalyst + ? AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment + : (int?)null; //byteAlignment is not applicable for downloads + var pipelineDepth = uploadingNotDownloading // ios + maccatalyst + ? AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth + : (int?)null; //pipelineDepth is not applicable for downloads + + var initialMtuSize = uploadingNotDownloading //android when noticing persistent failures when uploading/downloading we + ? AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize // resort to forcing the most failsafe settings we know of just in case + : AndroidTidbits.BleConnectionFailsafeSettings.ForDownloading.InitialMtuSize; // we manage to salvage this situation (works with SamsungA8 android tablets) + var windowCapacity = uploadingNotDownloading + ? AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity + : (int?)null; //window-capacity is not applicable for downloads + var memoryAlignment = uploadingNotDownloading + ? AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment + : (int?)null; //memory-alignment is not applicable for downloads return (byteAlignment: byteAlignment, pipelineDepth: pipelineDepth, initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, memoryAlignment: memoryAlignment); } static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment)? GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( + bool uploadingNotDownloading, string hostDeviceManufacturer, string hostDeviceModel, int? pipelineDepth = null, @@ -39,25 +52,41 @@ static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? var isUsingDefaultAppleSettings = pipelineDepth == null && byteAlignment == null; if (isUsingDefaultAppleSettings && AppleTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer, hostDeviceModel))) { - return ( - byteAlignment: AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment, - pipelineDepth: AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth, - initialMtuSize: null, //only applies to android - windowCapacity: null, //only applies to android - memoryAlignment: null //only applies to android - ); + return uploadingNotDownloading + ? ( + byteAlignment: AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment, + pipelineDepth: AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth, + initialMtuSize: null, //only applies to android + windowCapacity: null, //only applies to android + memoryAlignment: null //only applies to android + ) + : ( + byteAlignment: null, //placeholder value currently there are no known apple devices that have issues with BLE connection stability + pipelineDepth: null, //placeholder value currently there are no known apple devices that have issues with BLE connection stability + initialMtuSize: null, //only applies to android + windowCapacity: null, //only applies to android + memoryAlignment: null //only applies to android + ); } var isUsingDefaultAndroidSettings = initialMtuSize == null && windowCapacity == null && memoryAlignment == null; if (isUsingDefaultAndroidSettings && AndroidTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer, hostDeviceModel))) { - return ( - byteAlignment: null, //only applies to apple - pipelineDepth: null, //only applies to apple - initialMtuSize: AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize, - windowCapacity: AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity, - memoryAlignment: AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment - ); + return uploadingNotDownloading + ? ( + byteAlignment: null, //only applies to apple + pipelineDepth: null, //only applies to apple + initialMtuSize: AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize, + windowCapacity: AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity, + memoryAlignment: AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment + ) + : ( + byteAlignment: null, //only applies to apple + pipelineDepth: null, //only applies to apple + initialMtuSize: AndroidTidbits.BleConnectionFailsafeSettings.ForDownloading.InitialMtuSize, + windowCapacity: null, // currently it doesnt apply to android downloads but nordic might consider adding it in the future + memoryAlignment: null // doesnt apply to android downloads + ); } return null; diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index b3059ddf..1977ac35 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -55,7 +55,8 @@ public EFileDownloaderVerdict BeginDownload( var failsafeConnectionSettings = ConnectionSettingsHelpers.GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( initialMtuSize: initialMtuSize, hostDeviceModel: hostDeviceModel, - hostDeviceManufacturer: hostDeviceManufacturer + hostDeviceManufacturer: hostDeviceManufacturer, + uploadingNotDownloading: false ); if (failsafeConnectionSettings != null) { @@ -189,14 +190,15 @@ public async Task> DownloadAsync( remoteFilePath: path, hostDeviceModel: hostDeviceModel, hostDeviceManufacturer: hostDeviceManufacturer, - - timeoutForDownloadInMs: timeoutPerDownloadInMs, - maxTriesCount: maxRetriesPerDownload, + maxTriesCount: maxRetriesPerDownload, + timeoutForDownloadInMs: timeoutPerDownloadInMs, sleepTimeBetweenRetriesInMs: sleepTimeBetweenRetriesInMs, + initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment); + memoryAlignment: memoryAlignment + ); results[path] = data; } @@ -252,6 +254,7 @@ public async Task DownloadAsync( FileDownloadProgressPercentageAndDataThroughputChanged += FileDownloader_FileDownloadProgressPercentageAndDataThroughputChanged_; var failSafeSettingsToApply = ConnectionSettingsHelpers.GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable( + uploadingNotDownloading: false, triesCount: triesCount, maxTriesCount: maxTriesCount, suspiciousTransportFailuresCount: suspiciousTransportFailuresCount diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index 5cfe7d5d..6c2678a6 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -70,7 +70,8 @@ public EFileUploaderVerdict BeginUpload( byteAlignment: byteAlignment, initialMtuSize: initialMtuSize, windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + memoryAlignment: memoryAlignment, + uploadingNotDownloading: true ); if (failsafeConnectionSettings != null) { @@ -309,6 +310,7 @@ public async Task UploadAsync( FileUploadProgressPercentageAndDataThroughputChanged += FileUploader_FileUploadProgressPercentageAndDataThroughputChanged_; var failSafeSettingsToApply = ConnectionSettingsHelpers.GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable( + uploadingNotDownloading: true, triesCount: triesCount, maxTriesCount: maxTriesCount, suspiciousTransportFailuresCount: suspiciousTransportFailuresCount diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs index 1c40e706..e7d8d4b2 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs @@ -12,8 +12,8 @@ public interface IFirmwareInstallerCommandable /// /// /// When 'maxTriesCount' is greater than or equal to 2 the connection will be monitored in terms of how stable and reliable it is during the firmware-uploading stage and if - /// the uploading phase fails from the third attempt onwards then in the subsequent attempts the fail-safe settings in - /// and will be enforced to try to upload the firmware. + /// the uploading phase fails from the third attempt onwards then in the subsequent attempts the fail-safe settings in + /// and will be enforced to try to upload the firmware. /// /// The firmware bytes. If zipped then the archive must contain the .bin file and not a directory. /// The firmware upgrade mode. Best to leave this to the default value 'TestAndConfirm'. diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index 5336e5d0..7ce90b0e 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -353,11 +353,11 @@ bool emitWarningAboutUnstableConnection_ if (!isConnectionTooUnstableForUploading_) return null; - var byteAlignment_ = AppleTidbits.BleConnectionSettings.FailSafes.ByteAlignment; // ios + maccatalyst - var pipelineDepth_ = AppleTidbits.BleConnectionSettings.FailSafes.PipelineDepth; // ios + maccatalyst - var initialMtuSize_ = AndroidTidbits.BleConnectionSettings.FailSafes.InitialMtuSize; // android when noticing persistent failures when uploading we resort - var windowCapacity_ = AndroidTidbits.BleConnectionSettings.FailSafes.WindowCapacity; // android to forcing the most failsafe settings we know of just in case - var memoryAlignment_ = AndroidTidbits.BleConnectionSettings.FailSafes.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) + var byteAlignment_ = AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment; // ios + maccatalyst + var pipelineDepth_ = AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth; // ios + maccatalyst + var initialMtuSize_ = AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize; // android when noticing persistent failures when uploading we resort + var windowCapacity_ = AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity; // android to forcing the most failsafe settings we know of just in case + var memoryAlignment_ = AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) if (emitWarningAboutUnstableConnection_) { From 074135511729fce5103a09835b5ca47728e53f93 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 23 Oct 2024 19:28:04 +0200 Subject: [PATCH 086/104] feat (build.gradle): no.nordicsemi.android:mcumgr-ble and no.nordicsemi.android:mcumgr-core upgraded to version 2.2.1 --- .../mcumgr-laerdal-wrapper/build.gradle | 10 +++---- ...Mgr.Bindings.Android.NativeBuilder.targets | 26 +++++++++---------- ...erdal.McuMgr.Bindings.Android.NetX.targets | 6 ++--- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/build.gradle b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/build.gradle index 4be60049..aad9008a 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/build.gradle +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/build.gradle @@ -38,12 +38,12 @@ android { } dependencies { - implementation group: 'com.google.code.gson', name: 'gson', version: '2.9.1' + implementation group: 'com.google.code.gson', name: 'gson', version: '2.10.1' - implementation 'androidx.appcompat:appcompat:1.6.1' - implementation 'no.nordicsemi.android:mcumgr-ble:2.0.2' - implementation 'no.nordicsemi.android:mcumgr-core:2.0.2' - implementation 'com.google.android.material:material:1.8.0' + implementation 'androidx.appcompat:appcompat:1.7.0' + implementation 'no.nordicsemi.android:mcumgr-ble:2.2.1' + implementation 'no.nordicsemi.android:mcumgr-core:2.2.1' + implementation 'com.google.android.material:material:1.12.0' } // repositories { diff --git a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NativeBuilder.targets b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NativeBuilder.targets index d467da65..b8eacda9 100644 --- a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NativeBuilder.targets +++ b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NativeBuilder.targets @@ -98,10 +98,10 @@ - - - - + + + + @@ -109,19 +109,19 @@ - - - + + + - - - + + + - - - + + + diff --git a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NetX.targets b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NetX.targets index 7b1c3ba3..98969220 100644 --- a/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NetX.targets +++ b/Laerdal.McuMgr.Bindings.Android/Laerdal.McuMgr.Bindings.Android.NetX.targets @@ -37,9 +37,9 @@ - - - + + + From bb40539784ac5904f512f1ed3f9e62ed2866382f Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Wed, 23 Oct 2024 19:36:30 +0200 Subject: [PATCH 087/104] clean (FileUploader.cs, FileUploader.cs): trivial neutral cleanups in logging statements and on the memory-alignment parameter which got removed since it was not being taken into account --- .../Contracts/IFileDownloaderCommandable.cs | 9 +++------ .../Shared/FileDownloader/FileDownloader.cs | 15 +++++---------- .../Shared/FileUploader/FileUploader.cs | 2 +- 3 files changed, 9 insertions(+), 17 deletions(-) diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs index ef6281b8..fe1f4e7b 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs @@ -46,6 +46,7 @@ Task> DownloadAsync( /// /// The remote file to download. /// + /// /// The amount of time to wait for the operation to complete before bailing out. /// The maximum amount of tries before bailing out with . /// The amount of time to sleep between retries. @@ -61,7 +62,6 @@ Task> DownloadAsync( /// before https://github.com/zephyrproject-rtos/zephyr/pull/41959 was merged, the device required data to be sent with memory alignment. /// Otherwise, the device would ignore uneven bytes and reply with lower than expected offset /// causing multiple packets to be sent again dropping the speed instead of increasing it. - /// (Android only) Set the selected memory alignment. Defaults to 4 to match Nordic devices. /// The bytes of the remote file that got fetched over. Task DownloadAsync( string remoteFilePath, @@ -72,8 +72,7 @@ Task DownloadAsync( int sleepTimeBetweenRetriesInMs = 1_000, int gracefulCancellationTimeoutInMs = 2_500, int? initialMtuSize = null, - int? windowCapacity = null, - int? memoryAlignment = null + int? windowCapacity = null ); /// @@ -93,14 +92,12 @@ Task DownloadAsync( /// before https://github.com/zephyrproject-rtos/zephyr/pull/41959 was merged, the device required data to be sent with memory alignment. /// Otherwise, the device would ignore uneven bytes and reply with lower than expected offset /// causing multiple packets to be sent again dropping the speed instead of increasing it. - /// (Android only) Set the selected memory alignment. Defaults to 4 to match Nordic devices. EFileDownloaderVerdict BeginDownload( string remoteFilePath, string hostDeviceManufacturer, string hostDeviceModel, int? initialMtuSize = null, - int? windowCapacity = null, - int? memoryAlignment = null + int? windowCapacity = null ); /// Cancels the file-downloading process diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index 1977ac35..ebd967b5 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -45,8 +45,7 @@ public EFileDownloaderVerdict BeginDownload( string hostDeviceManufacturer, string hostDeviceModel, int? initialMtuSize = null, - int? windowCapacity = null, //not applicable currently but nordic considers these for future use - int? memoryAlignment = null //not applicable currently but nordic considers these for future use + int? windowCapacity = null //not applicable currently but nordic considers these for future use ) { RemoteFilePathHelpers.ValidateRemoteFilePath(remoteFilePath); // order @@ -196,8 +195,7 @@ public async Task> DownloadAsync( sleepTimeBetweenRetriesInMs: sleepTimeBetweenRetriesInMs, initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + windowCapacity: windowCapacity ); results[path] = data; @@ -225,8 +223,7 @@ public async Task DownloadAsync( int sleepTimeBetweenRetriesInMs = 1_000, int gracefulCancellationTimeoutInMs = 2_500, int? initialMtuSize = null, - int? windowCapacity = null, - int? memoryAlignment = null + int? windowCapacity = null ) { if (maxTriesCount <= 0) @@ -263,7 +260,6 @@ public async Task DownloadAsync( { initialMtuSize = failSafeSettingsToApply.Value.initialMtuSize; windowCapacity = failSafeSettingsToApply.Value.windowCapacity; - memoryAlignment = failSafeSettingsToApply.Value.memoryAlignment; if (!didWarnOnceAboutUnstableConnection) { @@ -271,7 +267,7 @@ public async Task DownloadAsync( OnLogEmitted(new LogEmittedEventArgs( level: ELogLevel.Warning, message: $"[FD.DA.010] Attempt#{triesCount}: Connection is too unstable for downloading assets from the target device. Subsequent tries will use failsafe parameters on the connection " + - $"just in case it helps (initialMtuSize={failSafeSettingsToApply.Value.initialMtuSize}, windowCapacity={failSafeSettingsToApply.Value.windowCapacity}, memoryAlignment={failSafeSettingsToApply.Value.memoryAlignment})", + $"just in case it helps (initialMtuSize={initialMtuSize?.ToString() ?? "null"}, windowCapacity={windowCapacity?.ToString() ?? "null"})", resource: "File", category: "FileDownloader" )); @@ -284,8 +280,7 @@ public async Task DownloadAsync( hostDeviceManufacturer: hostDeviceManufacturer, initialMtuSize: initialMtuSize, - windowCapacity: windowCapacity, - memoryAlignment: memoryAlignment + windowCapacity: windowCapacity ); if (verdict != EFileDownloaderVerdict.Success) throw new ArgumentException(verdict.ToString()); diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index 6c2678a6..6e2c0f5a 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -329,7 +329,7 @@ public async Task UploadAsync( OnLogEmitted(new LogEmittedEventArgs( level: ELogLevel.Warning, message: $"[FU.UA.010] Attempt#{triesCount}: Connection is too unstable for uploading assets to the target device. Subsequent tries will use failsafe parameters on the connection " + - $"just in case it helps (byteAlignment={failSafeSettingsToApply.Value.byteAlignment}, pipelineDepth={failSafeSettingsToApply.Value.pipelineDepth}, initialMtuSize={failSafeSettingsToApply.Value.initialMtuSize}, windowCapacity={failSafeSettingsToApply.Value.windowCapacity}, memoryAlignment={failSafeSettingsToApply.Value.memoryAlignment})", + $"just in case it helps (byteAlignment={byteAlignment}, pipelineDepth={pipelineDepth}, initialMtuSize={initialMtuSize}, windowCapacity={windowCapacity}, memoryAlignment={memoryAlignment})", resource: "File", category: "FileUploader" )); From 1ee8d9bcfbd2ce01b0960a39b2da14dbfc29d0c0 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 24 Oct 2024 15:38:22 +0200 Subject: [PATCH 088/104] clean (FirmwareInstaller.InstallAsync()): replace we now GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_() with the standard helper ConnectionSettingsHelpers.GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable() --- .../FirmwareInstaller/FirmwareInstaller.cs | 56 ++++++------------- 1 file changed, 17 insertions(+), 39 deletions(-) diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index 7ce90b0e..57266970 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -187,20 +187,31 @@ public async Task InstallAsync( StateChanged += FirmwareInstaller_StateChanged_; FatalErrorOccurred += FirmwareInstaller_FatalErrorOccurred_; - var failSafeSettingsToApply = GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( - triesCount_: triesCount, - maxTriesCount_: maxTriesCount, - suspiciousTransportFailuresCount_: suspiciousTransportFailuresCount, - emitWarningAboutUnstableConnection_: !didWarnOnceAboutUnstableConnection + var failSafeSettingsToApply = ConnectionSettingsHelpers.GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable( + uploadingNotDownloading: true, + triesCount: triesCount, + maxTriesCount: maxTriesCount, + suspiciousTransportFailuresCount: suspiciousTransportFailuresCount ); if (failSafeSettingsToApply != null) { - didWarnOnceAboutUnstableConnection = true; byteAlignment = failSafeSettingsToApply.Value.byteAlignment; pipelineDepth = failSafeSettingsToApply.Value.pipelineDepth; initialMtuSize = failSafeSettingsToApply.Value.initialMtuSize; windowCapacity = failSafeSettingsToApply.Value.windowCapacity; memoryAlignment = failSafeSettingsToApply.Value.memoryAlignment; + + if (!didWarnOnceAboutUnstableConnection) + { + didWarnOnceAboutUnstableConnection = true; + OnLogEmitted(new LogEmittedEventArgs( + level: ELogLevel.Warning, + message: $"[FI.IA.010] Attempt#{triesCount}: Connection is too unstable for uploading the firmware to the target device. Subsequent tries will use failsafe parameters on the connection " + + $"just in case it helps (byteAlignment={byteAlignment}, pipelineDepth={pipelineDepth}, initialMtuSize={initialMtuSize}, windowCapacity={windowCapacity}, memoryAlignment={memoryAlignment})", + resource: "Firmware", + category: "FirmwareInstaller" + )); + } } var verdict = BeginInstallation( //00 dont use task.run here for now @@ -339,39 +350,6 @@ void FirmwareInstaller_FatalErrorOccurred_(object sender, FatalErrorOccurredEven taskCompletionSource.TrySetException(new FirmwareInstallationErroredOutException($"{ea.ErrorMessage} (state={ea.State})")); //generic errors fall through here } } - - return; - - (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment)? GetFailsafeConnectionSettingsIfConnectionProvedToBeUnstable_( - int triesCount_, - int maxTriesCount_, - int suspiciousTransportFailuresCount_, - bool emitWarningAboutUnstableConnection_ - ) - { - var isConnectionTooUnstableForUploading_ = triesCount_ >= 2 && (triesCount_ == maxTriesCount_ || triesCount_ >= 3 && suspiciousTransportFailuresCount_ >= 2); - if (!isConnectionTooUnstableForUploading_) - return null; - - var byteAlignment_ = AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment; // ios + maccatalyst - var pipelineDepth_ = AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth; // ios + maccatalyst - var initialMtuSize_ = AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize; // android when noticing persistent failures when uploading we resort - var windowCapacity_ = AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity; // android to forcing the most failsafe settings we know of just in case - var memoryAlignment_ = AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment; // android we manage to salvage this situation (works with SamsungA8 android tablets) - - if (emitWarningAboutUnstableConnection_) - { - OnLogEmitted(new LogEmittedEventArgs( - level: ELogLevel.Warning, - message: $"[FI.IA.GFCSICPTBU.010] Attempt#{triesCount_}: Connection is too unstable for uploading the firmware to the target device. Subsequent tries will use failsafe parameters on the connection " + - $"just in case it helps (byteAlignment={byteAlignment_}, pipelineDepth={pipelineDepth_}, initialMtuSize={initialMtuSize_}, windowCapacity={windowCapacity_}, memoryAlignment={memoryAlignment_})", - resource: "Firmware", - category: "FirmwareInstaller" - )); - } - - return (byteAlignment: byteAlignment_, pipelineDepth: pipelineDepth_, initialMtuSize: initialMtuSize_, windowCapacity: windowCapacity_, memoryAlignment: memoryAlignment_); - } //00 we are aware that in order to be 100% accurate about timeouts we should use task.run() here without await and then await the // taskcompletionsource right after but if we went down this path we would also have to account for exceptions thus complicating From 2d34d5484a74f76910f02373e825adc390f58d5c Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 24 Oct 2024 15:57:29 +0200 Subject: [PATCH 089/104] doc (README.md): enrich the summary section with a clarification in regard to the requirements for the firmware running on nRF5x+ chipsets the firmware running on nRF5x+ chipsets has to be built against the nRF-Connect SDK (the classic 'nRF5 SDK' doesn't cut it for firmwares) --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6a2ef85a..4e29e196 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,8 @@ Read the LICENSE file before you begin. The project generates multiple Nugets called 'Laerdal.McuMgr' & 'Laerdal.McuMgr.Bindings.iOS|Android|NetStandard' (note: NetStandard is still WIP). The goal is to have 'Laerdal.McuMgr' provide an elegant high-level C# abstraction for the native device-managers that Nordic provides us with for -iOS and Android respectively to interact with [nRF5x series of BLE chips](https://embeddedcentric.com/nrf5x-soc-overview/): +iOS and Android respectively to interact with [nRF5x series of BLE chips](https://embeddedcentric.com/nrf5x-soc-overview/) **as long as they run on +firmware that has been built using 'nRFConnect SDK' or the 'Zephyr SDK'** (devices running on firmware built with the 'nRF5 SDK' however are inherently incompatible!): - [IOS-nRF-Connect-Device-Manager](https://github.com/NordicSemiconductor/IOS-nRF-Connect-Device-Manager) @@ -50,7 +51,8 @@ From the respective 'Readme' files of these projects: << nRF Connect Device Manager library is compatible with [McuManager (McuMgr, for short)](https://docs.zephyrproject.org/3.2.0/services/device_mgmt/mcumgr.html#overview), a management subsystem supported by [nRF Connect SDK](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/index.html), [Zephyr](https://docs.zephyrproject.org/3.2.0/introduction/index.html) and Apache Mynewt. -**It is the recommended protocol for Device Firmware Update(s) on new Nordic-powered devices going forward and should not be confused with the previous protocol, NordicDFU, serviced by the [Old DFU Library](https://github.com/NordicSemiconductor/IOS-DFU-Library)**. +**It is the recommended protocol for Device Firmware Update(s) on new Nordic-powered devices going forward and should not be confused with the previous protocol, +NordicDFU, serviced by the [Old DFU Library](https://github.com/NordicSemiconductor/IOS-DFU-Library)**. McuManager uses the [Simple Management Protocol, or SMP](https://docs.zephyrproject.org/3.2.0/services/device_mgmt/smp_protocol.html), to send and receive message requests from compatible devices. The SMP Transport definition for Bluetooth Low Energy, which this library implements, [can be found here](https://docs.zephyrproject.org/latest/services/device_mgmt/smp_transport.html). From dc92af4dcbe7f5eed5b411ac3d7b9fdf2ff3ada6 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 24 Oct 2024 16:15:59 +0200 Subject: [PATCH 090/104] doc (README.md): update the summary section with a clarification about the 'dual flash-bank (active / backup)' that the nRF5x chipsets support [skip ci] --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 4e29e196..51e95b1b 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,10 @@ The following types of operations are supported on devices running on Nordic's n Note: The library doesn't support "Windows Desktop" applications (Windows/UWP) just yet (WIP). + Note: In theaory all nRF5x chipsets support 'dual bank firmware storage (active / backup)', but in practice this co-depends on the custom firmware being installed in the sense + that if the firmware uses more than half of the flash-bank-memory then only a single flask-bank will be available (no backup flash bank). Same if the firmware-devs explicitly + disable the 'dual flask-bank' feature programmatically! + ## ✅ Nuget Platform-Support Matrix From ac00bf52264a26bf318b27ca49eb19273ac85521 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 24 Oct 2024 16:47:26 +0200 Subject: [PATCH 091/104] refa (FirmwareInstaller.BeginInstall()): we now use the fail-safe settings immediately if the host-device is known to be problematic (Samsung A8 etc) place the hostDeviceModel parameter before the deviceManufacturer --- ...ttingsRightAway_GivenProblematicDevices.cs | 14 +++---- ...Exception_GivenInvalidFirmwareDataBytes.cs | 6 ++- ...tu_GivenFlakyConnectionForFileUploading.cs | 9 +++- ...fully_GivenGreenNativeFirmwareInstaller.cs | 7 +++- ..._GivenFirmwareUploadFatalErrorMidflight.cs | 3 ++ ...ception_GivenGenericFatalErrorMidflight.cs | 7 +++- ...meoutException_GivenFatalErrorMidflight.cs | 7 +++- ...n_GivenErroneousNativeFirmwareInstaller.cs | 7 +++- ...onTimeoutException_GivenTooSmallTimeout.cs | 9 +++- ...ption_GivenCancellationRequestMidflight.cs | 7 +++- ...ativeFileDownloaderThatSkipsIntoTesting.cs | 7 +++- Laerdal.McuMgr.slnx.DotSettings.user | 1 + .../Android.FailSafeBleConnectionSettings.cs | 42 +++++++++---------- .../Apple.FailSafeBleConnectionSettings.cs | 6 +-- .../Helpers/ConnectionSettingsHelpers.cs | 14 +++---- .../Contracts/IFileDownloaderCommandable.cs | 6 +-- .../Shared/FileDownloader/FileDownloader.cs | 6 +-- .../Contracts/IFileUploaderCommandable.cs | 6 +-- .../Shared/FileUploader/FileUploader.cs | 8 ++-- .../IFirmwareInstallerCommandable.cs | 8 ++++ .../FirmwareInstaller/FirmwareInstaller.cs | 38 ++++++++++++++++- 21 files changed, 156 insertions(+), 62 deletions(-) diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs index 8ae9b693..386a1391 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices.cs @@ -15,15 +15,15 @@ namespace Laerdal.McuMgr.Tests.FileUploader public partial class FileUploaderTestbed { [Theory] - [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.010", "samsung", "sm-x200", null, null, null, null, null, null, null, 23, 1, 1)] - [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.020", " Samsung ", " SM-X200 ", null, null, null, null, null, null, null, 23, 1, 1)] - [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.030", " Apple ", " iPhone 6 ", null, null, null, null, null, 1, 1, null, null, null)] - [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.040", " Apple ", " iPhone 6 ", 2, 4, null, null, null, 2, 4, null, null, null)] - [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.050", "AcmeCorp.", "foobar", null, null, null, null, null, null, null, null, null, null)] + [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.010", "sm-x200 ", " samsung ", null, null, null, null, null, null, null, 23, 1, 1)] + [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.020", " SM-X200 ", " Samsung ", null, null, null, null, null, null, null, 23, 1, 1)] + [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.030", " iPhone 6 ", " Apple ", null, null, null, null, null, 1, 1, null, null, null)] + [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.040", " iPhone 6 ", " Apple ", 2, 4, null, null, null, 2, 4, null, null, null)] + [InlineData("FUT.SFUA.SCSBFBTFSRA.GPD.050", " foobar ", " AcmeCorp. ", null, null, null, null, null, null, null, null, null, null)] public async Task SingleFileUploadAsync_ShouldCompleteSuccessfullyByFallingBackToFailsafeSettingsRightAway_GivenProblematicDevices( string testcaseNickname, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int? pipelineDepth, int? byteAlignment, @@ -45,7 +45,7 @@ public async Task SingleFileUploadAsync_ShouldCompleteSuccessfullyByFallingBackT var mockedNativeFileUploaderProxy = new MockedGreenNativeFileUploaderProxySpy140(uploaderCallbacksProxy: new GenericNativeFileUploaderCallbacksProxy_()); var fileUploader = new McuMgr.FileUploader.FileUploader(mockedNativeFileUploaderProxy); - AppleTidbits.KnownProblematicDevices.Add(("apple", "iphone 6")); + AppleTidbits.KnownProblematicDevices.Add(("iphone 6", "apple")); using var eventsMonitor = fileUploader.Monitor(); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.BeginInstallation.ShouldThrowArgumentException_GivenInvalidFirmwareDataBytes.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.BeginInstallation.ShouldThrowArgumentException_GivenInvalidFirmwareDataBytes.cs index 2d86cf9c..4104f36d 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.BeginInstallation.ShouldThrowArgumentException_GivenInvalidFirmwareDataBytes.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.BeginInstallation.ShouldThrowArgumentException_GivenInvalidFirmwareDataBytes.cs @@ -21,7 +21,11 @@ public void BeginInstallation_ShouldThrowArgumentException_GivenInvalidFirmwareD using var eventsMonitor = firmwareInstaller.Monitor(); // Act - var work = new Func(() => firmwareInstaller.BeginInstallation(mockedFileData)); + var work = new Func(() => firmwareInstaller.BeginInstallation( + data: mockedFileData, + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp." + )); // Assert work.Should().Throw(); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs index a86a4906..8b8215d9 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs @@ -35,7 +35,12 @@ public async Task InstallAsync_ShouldCompleteSuccessfullyWithLastDitchAttemptUsi using var eventsMonitor = firmwareInstaller.Monitor(); // Act - var work = new Func(() => firmwareInstaller.InstallAsync([1, 2, 3], maxTriesCount: maxTriesCount)); + var work = new Func(() => firmwareInstaller.InstallAsync( + data: [1, 2, 3], + maxTriesCount: maxTriesCount, + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp." + )); // Assert await work.Should().CompleteWithinAsync(4.Seconds()); @@ -63,7 +68,7 @@ public async Task InstallAsync_ShouldCompleteSuccessfullyWithLastDitchAttemptUsi .Where(x => x.EventName == nameof(firmwareInstaller.LogEmitted)) .SelectMany(x => x.Parameters) .OfType() - .Count(l => l is { Level: ELogLevel.Warning } && l.Message.Contains("GFCSICPTBU.010")) + .Count(l => l is { Level: ELogLevel.Warning } && l.Message.Contains("[FI.IA.010]")) .Should() .Be(1); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs index d61ef372..e22785cc 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareInstaller.cs @@ -21,7 +21,12 @@ public async Task InstallAsync_ShouldCompleteSuccessfully_GivenGreenNativeFirmwa using var eventsMonitor = firmwareInstaller.Monitor(); // Act - var work = new Func(() => firmwareInstaller.InstallAsync([1, 2, 3], maxTriesCount: 1)); + var work = new Func(() => firmwareInstaller.InstallAsync( + data: [1, 2, 3], + maxTriesCount: 1, + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp." + )); // Assert await work.Should().CompleteWithinAsync(4.Seconds()); diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs index cbfd924e..f000960b 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs @@ -21,6 +21,9 @@ public async Task InstallAsync_ShouldThrowAllFirmwareInstallationAttemptsFailedE // Act var work = new Func(() => firmwareInstaller.InstallAsync( + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + data: [1, 2, 3], maxTriesCount: 2, sleepTimeBetweenRetriesInMs: 0 diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs index 41b9c390..39605ff5 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs @@ -20,7 +20,12 @@ public async Task InstallAsync_ShouldThrowAllFirmwareInstallationAttemptsFailedE using var eventsMonitor = firmwareInstaller.Monitor(); // Act - var work = new Func(() => firmwareInstaller.InstallAsync(data: [1, 2, 3], maxTriesCount: 1)); + var work = new Func(() => firmwareInstaller.InstallAsync( + data: [1, 2, 3], + maxTriesCount: 1, + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp." + )); // Assert await work.Should() diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs index ec04ecb4..235e6c3e 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs @@ -20,7 +20,12 @@ public async Task InstallAsync_ShouldThrowFirmwareInstallationImageSwapTimeoutEx using var eventsMonitor = firmwareInstaller.Monitor(); // Act - var work = new Func(() => firmwareInstaller.InstallAsync(data: [1, 2, 3], maxTriesCount: 1)); + var work = new Func(() => firmwareInstaller.InstallAsync( + data: [1, 2, 3], + maxTriesCount: 1, + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp." + )); // Assert await work.Should() diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationInternalErrorException_GivenErroneousNativeFirmwareInstaller.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationInternalErrorException_GivenErroneousNativeFirmwareInstaller.cs index 3fefa4a7..aad3e4d2 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationInternalErrorException_GivenErroneousNativeFirmwareInstaller.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationInternalErrorException_GivenErroneousNativeFirmwareInstaller.cs @@ -17,7 +17,12 @@ public async Task InstallAsync_ShouldThrowFirmwareInstallationInternalErrorExcep var firmwareInstaller = new McuMgr.FirmwareInstaller.FirmwareInstaller(mockedNativeFirmwareInstallerProxy); // Act - var work = new Func(() => firmwareInstaller.InstallAsync([1], maxTriesCount: 1)); + var work = new Func(() => firmwareInstaller.InstallAsync( + data: [1], + maxTriesCount: 1, + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp." + )); // Assert ( diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs index 1ae51cd6..f2b3895f 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationTimeoutException_GivenTooSmallTimeout.cs @@ -21,7 +21,14 @@ public async Task InstallAsync_ShouldThrowFirmwareInstallationTimeoutException_G using var eventsMonitor = firmwareInstaller.Monitor(); // Act - var work = new Func(() => firmwareInstaller.InstallAsync([1], maxTriesCount: 1, timeoutInMs: 100)); + var work = new Func(() => firmwareInstaller.InstallAsync( + data: [1], + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp.", + + timeoutInMs: 100, + maxTriesCount: 1 + )); // Assert await work.Should() diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs index 3a8aacde..f5b81077 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowInstallationCancelledException_GivenCancellationRequestMidflight.cs @@ -32,7 +32,12 @@ public async Task InstallAsync_ShouldThrowFirmwareInstallationCancelledException firmwareInstaller.Cancel(); }); - var work = new Func(() => firmwareInstaller.InstallAsync([1, 2, 3], maxTriesCount: 1)); + var work = new Func(() => firmwareInstaller.InstallAsync( + data: [1, 2, 3], + maxTriesCount: 1, + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp." + )); // Assert await work.Should() diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs index 98deb31f..953b3254 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldTriggerEventIdenticalFirmwareCachedOnTargetDeviceDetected_GivenGreenNativeFileDownloaderThatSkipsIntoTesting.cs @@ -29,7 +29,12 @@ public async Task InstallAsync_ShouldTriggerEventIdenticalFirmwareCachedOnTarget using var eventsMonitor = firmwareInstaller.Monitor(); // Act - var work = new Func(() => firmwareInstaller.InstallAsync([1, 2, 3], maxTriesCount: 1)); + var work = new Func(() => firmwareInstaller.InstallAsync( + data: [1, 2, 3], + maxTriesCount: 1, + hostDeviceModel: "foobar", + hostDeviceManufacturer: "acme corp." + )); // Assert await work.Should().CompleteWithinAsync(4.Seconds()); diff --git a/Laerdal.McuMgr.slnx.DotSettings.user b/Laerdal.McuMgr.slnx.DotSettings.user index 6c4ad9fb..fb013bf6 100644 --- a/Laerdal.McuMgr.slnx.DotSettings.user +++ b/Laerdal.McuMgr.slnx.DotSettings.user @@ -38,6 +38,7 @@ True True True + True True True True diff --git a/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs b/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs index dea5de3e..b075a9cc 100644 --- a/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs +++ b/Laerdal.McuMgr/Shared/Common/Constants/Android.FailSafeBleConnectionSettings.cs @@ -7,35 +7,35 @@ public readonly struct AndroidTidbits { /// List of known problematic android-devices that have issues with BLE connection stability and have to use fail-safe ble settings to work.

/// Inspired by - static public HashSet<(string Manufacturer, string DeviceModel)> KnownProblematicDevices { get; } = new (string Manufacturer, string DeviceModel)[] + static public HashSet<(string DeviceModel, string Manufacturer)> KnownProblematicDevices { get; } = new (string DeviceModel, string Manufacturer)[] { - ("Motorola", "moto g20"), - ("Motorola", "moto e20"), - ("Motorola", "moto e30"), - ("Motorola", "moto e32"), - ("Motorola", "moto e40"), + ("moto g20", "Motorola"), + ("moto e20", "Motorola"), + ("moto e30", "Motorola"), + ("moto e32", "Motorola"), + ("moto e40", "Motorola"), - ("Nokia", "Nokia G21"), - ("Nokia", "Nokia G11"), - ("Nokia", "Nokia T20"), + ("Nokia G21", "Nokia"), + ("Nokia G11", "Nokia"), + ("Nokia T20", "Nokia"), - ("Realme", "RMX3261"), //C21Y - ("Realme", "RMX3262"), //C21Y - ("Realme", "RMX3265"), //C25Y - ("Realme", "RMX3269"), //C25Y - ("Realme", "RMP2105"), //Pad Mini - ("Realme", "RMP2106"), //Pad Mini + ("RMX3261", "Realme"), //C21Y + ("RMX3262", "Realme"), //C21Y + ("RMX3265", "Realme"), //C25Y + ("RMX3269", "Realme"), //C25Y + ("RMP2105", "Realme"), //Pad Mini + ("RMP2106", "Realme"), //Pad Mini - ("Infinix", "Infinix X675"), //Hot 11 2022 + ("Infinix X675", "Infinix"), //Hot 11 2022 - ("HTC", "Wildfire E2 plus"), + ("Wildfire E2 plus", "HTC"), - ("Micromax", "IN_2b"), - ("Micromax", "IN_2c"), + ("IN_2b", "Micromax"), + ("IN_2c", "Micromax"), - ("Samsung", "SM-X200"), //Galaxy Tab A8 + ("SM-X200", "Samsung"), //Galaxy Tab A8 } - .Select(x => (x.Manufacturer.Trim().ToLowerInvariant(), x.DeviceModel.Trim().ToLowerInvariant())) //vital + .Select(x => (DeviceModel: x.DeviceModel.Trim().ToLowerInvariant(), Manufacturer: x.Manufacturer.Trim().ToLowerInvariant())) //vital .ToHashSet(); /// diff --git a/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs b/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs index 0f27961c..c92b75cc 100644 --- a/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs +++ b/Laerdal.McuMgr/Shared/Common/Constants/Apple.FailSafeBleConnectionSettings.cs @@ -9,11 +9,11 @@ public readonly struct AppleTidbits // ReSharper disable once CollectionNeverUpdated.Global /// List of known problematic android-devices that have issues with BLE connection stability and have to use fail-safe ble settings to work.

/// Inspired by - static public HashSet<(string Manufacturer, string DeviceModel)> KnownProblematicDevices { get; } = new (string Manufacturer, string DeviceModel)[] + static public HashSet<(string DeviceModel, string Manufacturer)> KnownProblematicDevices { get; } = new (string DeviceModel, string Manufacturer)[] { - // ("Apple", "XYZ"), // just a placeholder - no apple devices are known to have issues with BLE connection stability at the time of this writing + // ("iPhone6", "Apple"), // just a placeholder - no apple devices are known to have issues with BLE connection stability at the time of this writing } - .Select(x => (x.Manufacturer.Trim().ToLowerInvariant(), x.DeviceModel.Trim().ToLowerInvariant())) + .Select(x => (DeviceModel: x.DeviceModel.Trim().ToLowerInvariant(), Manufacturer: x.Manufacturer.Trim().ToLowerInvariant())) .ToHashSet(); /// diff --git a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs index 57105286..a3cffe7b 100644 --- a/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs +++ b/Laerdal.McuMgr/Shared/Common/Helpers/ConnectionSettingsHelpers.cs @@ -37,8 +37,8 @@ int suspiciousTransportFailuresCount static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? windowCapacity, int? memoryAlignment)? GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( bool uploadingNotDownloading, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int? pipelineDepth = null, int? byteAlignment = null, int? initialMtuSize = null, @@ -50,17 +50,17 @@ static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? hostDeviceManufacturer = (hostDeviceManufacturer ?? "").Trim().ToLowerInvariant(); var isUsingDefaultAppleSettings = pipelineDepth == null && byteAlignment == null; - if (isUsingDefaultAppleSettings && AppleTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer, hostDeviceModel))) + if (isUsingDefaultAppleSettings && AppleTidbits.KnownProblematicDevices.Contains((DeviceModel: hostDeviceModel, Manufacturer: hostDeviceManufacturer))) { return uploadingNotDownloading - ? ( + ? ( //uploading byteAlignment: AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment, pipelineDepth: AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth, initialMtuSize: null, //only applies to android windowCapacity: null, //only applies to android memoryAlignment: null //only applies to android ) - : ( + : ( //downloading byteAlignment: null, //placeholder value currently there are no known apple devices that have issues with BLE connection stability pipelineDepth: null, //placeholder value currently there are no known apple devices that have issues with BLE connection stability initialMtuSize: null, //only applies to android @@ -70,17 +70,17 @@ static public (int? byteAlignment, int? pipelineDepth, int? initialMtuSize, int? } var isUsingDefaultAndroidSettings = initialMtuSize == null && windowCapacity == null && memoryAlignment == null; - if (isUsingDefaultAndroidSettings && AndroidTidbits.KnownProblematicDevices.Contains((hostDeviceManufacturer, hostDeviceModel))) + if (isUsingDefaultAndroidSettings && AndroidTidbits.KnownProblematicDevices.Contains((DeviceModel: hostDeviceModel, Manufacturer: hostDeviceManufacturer))) { return uploadingNotDownloading - ? ( + ? ( //uploading byteAlignment: null, //only applies to apple pipelineDepth: null, //only applies to apple initialMtuSize: AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize, windowCapacity: AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity, memoryAlignment: AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment ) - : ( + : ( //downloading byteAlignment: null, //only applies to apple pipelineDepth: null, //only applies to apple initialMtuSize: AndroidTidbits.BleConnectionFailsafeSettings.ForDownloading.InitialMtuSize, diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs index fe1f4e7b..47df4628 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/IFileDownloaderCommandable.cs @@ -31,8 +31,8 @@ public interface IFileDownloaderCommandable /// A dictionary containing the bytes of each remote file that got fetched over. Task> DownloadAsync( IEnumerable remoteFilePaths, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int timeoutPerDownloadInMs = -1, int maxRetriesPerDownload = 10, int sleepTimeBetweenRetriesInMs = 0, @@ -65,8 +65,8 @@ Task> DownloadAsync( /// The bytes of the remote file that got fetched over. Task DownloadAsync( string remoteFilePath, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int timeoutForDownloadInMs = -1, int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 1_000, @@ -94,8 +94,8 @@ Task DownloadAsync( /// causing multiple packets to be sent again dropping the speed instead of increasing it. EFileDownloaderVerdict BeginDownload( string remoteFilePath, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int? initialMtuSize = null, int? windowCapacity = null ); diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index ebd967b5..e32a9f7d 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -42,8 +42,8 @@ public void Dispose() public EFileDownloaderVerdict BeginDownload( string remoteFilePath, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int? initialMtuSize = null, int? windowCapacity = null //not applicable currently but nordic considers these for future use ) @@ -163,8 +163,8 @@ public event EventHandler> DownloadAsync( IEnumerable remoteFilePaths, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int timeoutPerDownloadInMs = -1, int maxRetriesPerDownload = 10, int sleepTimeBetweenRetriesInMs = 0, @@ -216,8 +216,8 @@ public async Task> DownloadAsync( private const int DefaultGracefulCancellationTimeoutInMs = 2_500; public async Task DownloadAsync( string remoteFilePath, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int timeoutForDownloadInMs = -1, int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 1_000, diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs index 07ab633e..3df57cef 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/IFileUploaderCommandable.cs @@ -43,8 +43,8 @@ public interface IFileUploaderCommandable /// (Android only) Set the selected memory alignment. Defaults to 4 to match Nordic devices. Task> UploadAsync( IDictionary remoteFilePathsAndTheirData, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int sleepTimeBetweenRetriesInMs = 100, int timeoutPerUploadInMs = -1, int maxTriesPerUpload = 10, @@ -94,8 +94,8 @@ Task> UploadAsync( Task UploadAsync( TData localData, string remoteFilePath, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int timeoutForUploadInMs = -1, int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 1_000, @@ -134,8 +134,8 @@ Task UploadAsync( EFileUploaderVerdict BeginUpload( string remoteFilePath, byte[] data, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int? pipelineDepth = null, int? byteAlignment = null, int? initialMtuSize = null, diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index 6e2c0f5a..270d05ad 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -47,8 +47,8 @@ public EFileUploaderVerdict BeginUpload( string remoteFilePath, byte[] data, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int? pipelineDepth = null, int? byteAlignment = null, @@ -84,7 +84,7 @@ public EFileUploaderVerdict BeginUpload( OnLogEmitted(new LogEmittedEventArgs( level: ELogLevel.Warning, message: $"[FU.BU.010] Host device '{hostDeviceModel} (made by {hostDeviceManufacturer})' is known to be problematic. Resorting to using failsafe settings " + - $"(pipelineDepth={pipelineDepth}, byteAlignment={byteAlignment}, initialMtuSize={initialMtuSize}, windowCapacity={windowCapacity}, memoryAlignment={memoryAlignment})", + $"(pipelineDepth={pipelineDepth ?.ToString() ?? "null"}, byteAlignment={byteAlignment?.ToString() ?? "null"}, initialMtuSize={initialMtuSize?.ToString() ?? "null"}, windowCapacity={windowCapacity?.ToString() ?? "null"}, memoryAlignment={memoryAlignment?.ToString() ?? "null"})", resource: "File", category: "FileDownloader" )); @@ -201,8 +201,8 @@ public event EventHandler> UploadAsync( IDictionary remoteFilePathsAndTheirData, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int sleepTimeBetweenRetriesInMs = 100, int timeoutPerUploadInMs = -1, int maxTriesPerUpload = 10, @@ -266,8 +266,8 @@ await UploadAsync( public async Task UploadAsync( TData data, string remoteFilePath, - string hostDeviceManufacturer, string hostDeviceModel, + string hostDeviceManufacturer, int timeoutForUploadInMs = -1, int maxTriesCount = 10, int sleepTimeBetweenRetriesInMs = 1_000, diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs index e7d8d4b2..6a92de6a 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/IFirmwareInstallerCommandable.cs @@ -16,6 +16,8 @@ public interface IFirmwareInstallerCommandable /// and will be enforced to try to upload the firmware. /// /// The firmware bytes. If zipped then the archive must contain the .bin file and not a directory. + /// The model of the host-device. + /// The manufacturer of the host-device /// The firmware upgrade mode. Best to leave this to the default value 'TestAndConfirm'. /// Specifies whether preexisting settings should be erased or not. /// In rF52840, due to how the flash memory works, requires ~20 sec to erase images. @@ -42,6 +44,8 @@ public interface IFirmwareInstallerCommandable /// The time to wait (in milliseconds) for a cancellation request to be properly handled. If this timeout expires then the mechanism will bail out forcefully without waiting for the underlying native code to cleanup properly. Task InstallAsync( byte[] data, + string hostDeviceModel, + string hostDeviceManufacturer, EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, @@ -60,6 +64,8 @@ Task InstallAsync( /// Begins the firmware upgrade process. To really know when the upgrade process has been completed you have to employ the progressPercentage methods. /// /// The firmware bytes. If zipped then the archive must contain the .bin file and not a directory. + /// The model of the host-device. + /// The manufacturer of the host-device. /// The firmware upgrade mode. Best to leave this to the default value 'TestAndConfirm'. /// Specifies whether preexisting settings should be erased or not. /// In rF52840, due to how the flash memory works, requires ~20 sec to erase images. @@ -82,6 +88,8 @@ Task InstallAsync( /// to predict offset jumps as multiple packets are sent in parallel. EFirmwareInstallationVerdict BeginInstallation( byte[] data, + string hostDeviceModel, + string hostDeviceManufacturer, EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index 57266970..567fd902 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -40,6 +40,8 @@ public void Dispose() public EFirmwareInstallationVerdict BeginInstallation( byte[] data, + string hostDeviceModel, + string hostDeviceManufacturer, EFirmwareInstallationMode mode = EFirmwareInstallationMode.TestAndConfirm, bool? eraseSettings = null, int? estimatedSwapTimeInMilliseconds = null, @@ -53,6 +55,35 @@ public EFirmwareInstallationVerdict BeginInstallation( if (data == null || !data.Any()) throw new ArgumentException("The data byte-array parameter is null or empty", nameof(data)); + var failsafeConnectionSettings = ConnectionSettingsHelpers.GetFailSafeConnectionSettingsIfHostDeviceIsProblematic( + uploadingNotDownloading: true, + + hostDeviceModel: hostDeviceModel, + hostDeviceManufacturer: hostDeviceManufacturer, + + pipelineDepth: pipelineDepth, + byteAlignment: byteAlignment, + initialMtuSize: initialMtuSize, + windowCapacity: windowCapacity, + memoryAlignment: memoryAlignment + ); + if (failsafeConnectionSettings != null) + { + pipelineDepth = failsafeConnectionSettings.Value.pipelineDepth; + byteAlignment = failsafeConnectionSettings.Value.byteAlignment; + initialMtuSize = failsafeConnectionSettings.Value.initialMtuSize; + windowCapacity = failsafeConnectionSettings.Value.windowCapacity; + memoryAlignment = failsafeConnectionSettings.Value.memoryAlignment; + + OnLogEmitted(new LogEmittedEventArgs( + level: ELogLevel.Warning, + message: $"[FI.BI.010] Host device '{hostDeviceModel} (made by {hostDeviceManufacturer})' is known to be problematic. Resorting to using failsafe settings " + + $"(pipelineDepth={pipelineDepth?.ToString() ?? "null"}, byteAlignment={byteAlignment?.ToString() ?? "null"}, initialMtuSize={initialMtuSize?.ToString() ?? "null"}, windowCapacity={windowCapacity?.ToString() ?? "null"}, memoryAlignment={memoryAlignment?.ToString() ?? "null"})", + resource: "File", + category: "FileDownloader" + )); + } + _nativeFirmwareInstallerProxy.Nickname = "Firmware Installation"; //todo get this from a parameter var verdict = _nativeFirmwareInstallerProxy.BeginInstallation( data: data, @@ -154,6 +185,8 @@ public event EventHandler Date: Fri, 25 Oct 2024 12:44:45 +0200 Subject: [PATCH 092/104] fix (Laerdal.McuMgr.slnx.DotSettings.user): don't include the dotnet path in the user settings [skip ci] --- Laerdal.McuMgr.slnx.DotSettings.user | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/Laerdal.McuMgr.slnx.DotSettings.user b/Laerdal.McuMgr.slnx.DotSettings.user index fb013bf6..f9fbd1a2 100644 --- a/Laerdal.McuMgr.slnx.DotSettings.user +++ b/Laerdal.McuMgr.slnx.DotSettings.user @@ -1,4 +1,5 @@  + <SessionState ContinuousTestingMode="0" IsActive="True" Name="All tests from Solution" xmlns="urn:schemas-jetbrains-com:jetbrains-ut-session"> <Solution /> </SessionState> @@ -28,9 +29,6 @@ 999999 CHOP_IF_LONG CHOP_ALWAYS - /usr/local/share/dotnet/sdk/7.0.404/MSBuild.dll - /usr/local/share/dotnet/dotnet - 1048576 1 /Applications/Xcode_14_2.app NuGetPluginsThenRider From f5225143ff0270616b5d4e2192b8979a929346ce Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 25 Oct 2024 13:12:30 +0200 Subject: [PATCH 093/104] refa (IOS*.swift): simplify the way we use enums --- .../McuMgrBindingsiOS/IOSDeviceResetter.swift | 8 ++-- .../McuMgrBindingsiOS/IOSFileDownloader.swift | 34 ++++++++--------- .../McuMgrBindingsiOS/IOSFileUploader.swift | 38 +++++++++---------- 3 files changed, 40 insertions(+), 40 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSDeviceResetter.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSDeviceResetter.swift index 853fce64..a846172c 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSDeviceResetter.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSDeviceResetter.swift @@ -18,7 +18,7 @@ public class IOSDeviceResetter: NSObject { @objc public func beginReset() { - setState(EIOSDeviceResetterState.resetting) + setState(.resetting) _manager = DefaultManager(transport: _transporter) _manager.logDelegate = self @@ -29,18 +29,18 @@ public class IOSDeviceResetter: NSObject { if (error != nil) { self.fatalErrorOccurredAdvertisement("Reset failed: '\(error?.localizedDescription ?? "")'") - self.setState(EIOSDeviceResetterState.failed) + self.setState(.failed) return } if (response?.getError() != nil) { // check for an error return code self.fatalErrorOccurredAdvertisement("Reset failed: '\(response?.getError()?.errorDescription ?? "N/A")'") - self.setState(EIOSDeviceResetterState.failed) + self.setState(.failed) return } - self.setState(EIOSDeviceResetterState.complete) + self.setState(.complete) } } diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift index 547bcc3f..a2faef48 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift @@ -62,26 +62,26 @@ public class IOSFileDownloader: NSObject { if !isCold() { //keep first if another download is already in progress we bail out onError("Another download is already in progress") - return EIOSFileDownloadingInitializationVerdict.failedDownloadAlreadyInProgress + return .failedDownloadAlreadyInProgress } _remoteFilePathSanitized = remoteFilePath.trimmingCharacters(in: .whitespacesAndNewlines) if _remoteFilePathSanitized.isEmpty { onError("Target-file provided is dud!") - return EIOSFileDownloadingInitializationVerdict.failedInvalidSettings + return .failedInvalidSettings } if _remoteFilePathSanitized.hasSuffix("/") { onError("Target-file points to a directory instead of a file") - return EIOSFileDownloadingInitializationVerdict.failedInvalidSettings + return .failedInvalidSettings } if !_remoteFilePathSanitized.hasPrefix("/") { onError("Target-path is not absolute!") - return EIOSFileDownloadingInitializationVerdict.failedInvalidSettings + return .failedInvalidSettings } resetUploadState() //order @@ -93,10 +93,10 @@ public class IOSFileDownloader: NSObject { if !success { onError("Failed to commence file-Downloading (check logs for details)") - return EIOSFileDownloadingInitializationVerdict.failedErrorUponCommencing + return .failedErrorUponCommencing } - return EIOSFileDownloadingInitializationVerdict.success + return .success } @objc @@ -131,21 +131,21 @@ public class IOSFileDownloader: NSObject { } private func isIdleOrCold() -> Bool { - return _currentState == EIOSFileDownloaderState.idle || isCold(); + return _currentState == .idle || isCold(); } private func isCold() -> Bool { - return _currentState == EIOSFileDownloaderState.none - || _currentState == EIOSFileDownloaderState.error - || _currentState == EIOSFileDownloaderState.complete - || _currentState == EIOSFileDownloaderState.cancelled + return _currentState == .none + || _currentState == .error + || _currentState == .complete + || _currentState == .cancelled } private func resetUploadState() { _lastBytesSend = -1 _lastBytesSendTimestamp = nil - setState(EIOSFileDownloaderState.idle) + setState(.idle) busyStateChangedAdvertisement(true) fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0) } @@ -181,7 +181,7 @@ public class IOSFileDownloader: NSObject { //@objc dont private func onError(_ errorMessage: String, _ error: Error? = nil) { - setState(EIOSFileDownloaderState.error) //keep first + setState(.error) //keep first _lastFatalErrorMessage = errorMessage @@ -275,7 +275,7 @@ public class IOSFileDownloader: NSObject { stateChangedAdvertisement(oldState, newState) //order - if (oldState == EIOSFileDownloaderState.downloading && newState == EIOSFileDownloaderState.complete) //00 + if (oldState == .downloading && newState == .complete) //00 { fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(100, 0) } @@ -286,7 +286,7 @@ public class IOSFileDownloader: NSObject { extension IOSFileDownloader: FileDownloadDelegate { public func downloadProgressDidChange(bytesDownloaded bytesSent: Int, fileSize: Int, timestamp: Date) { - setState(EIOSFileDownloaderState.downloading) + setState(.downloading) let throughputKilobytesPerSecond = calculateThroughput(bytesSent: bytesSent, timestamp: timestamp) let DownloadProgressPercentage = (bytesSent * 100) / fileSize fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(DownloadProgressPercentage, throughputKilobytesPerSecond) @@ -299,14 +299,14 @@ extension IOSFileDownloader: FileDownloadDelegate { } public func downloadDidCancel() { - setState(EIOSFileDownloaderState.cancelled) + setState(.cancelled) busyStateChangedAdvertisement(false) fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0) cancelledAdvertisement() } public func download(of name: String, didFinish data: Data) { - setState(EIOSFileDownloaderState.complete) + setState(.complete) downloadCompletedAdvertisement(_remoteFilePathSanitized, [UInt8](data)) busyStateChangedAdvertisement(false) } diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift index 333269ba..0c54baa2 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift @@ -68,38 +68,38 @@ public class IOSFileUploader: NSObject { if !isCold() { //keep first if another upload is already in progress we bail out onError("Another upload is already in progress") - return EIOSFileUploadingInitializationVerdict.failedOtherUploadAlreadyInProgress + return .failedOtherUploadAlreadyInProgress } _remoteFilePathSanitized = remoteFilePath.trimmingCharacters(in: .whitespacesAndNewlines) if _remoteFilePathSanitized.isEmpty { onError("Target-file provided is dud") - return EIOSFileUploadingInitializationVerdict.failedInvalidSettings + return .failedInvalidSettings } if _remoteFilePathSanitized.hasSuffix("/") { onError("Target-file points to a directory instead of a file") - return EIOSFileUploadingInitializationVerdict.failedInvalidSettings + return .failedInvalidSettings } if !_remoteFilePathSanitized.hasPrefix("/") { onError("Target-path is not absolute!") - return EIOSFileUploadingInitializationVerdict.failedInvalidSettings + return .failedInvalidSettings } if data == nil { // data being nil is not ok btw data.length==0 is perfectly ok because we might want to create empty files onError("The data provided are nil") - return EIOSFileUploadingInitializationVerdict.failedInvalidData + return .failedInvalidData } if _cbPeripheral == nil { onError("No bluetooth-device specified - call trySetBluetoothDevice() first"); - return EIOSFileUploadingInitializationVerdict.failedInvalidSettings; + return .failedInvalidSettings; } if (pipelineDepth >= 2 && byteAlignment <= 1) { @@ -134,10 +134,10 @@ public class IOSFileUploader: NSObject { if !success { onError("Failed to commence file-uploading (check logs for details)") - return EIOSFileUploadingInitializationVerdict.failedErrorUponCommencing + return .failedErrorUponCommencing } - return EIOSFileUploadingInitializationVerdict.success + return .success //00 normally we shouldnt need this but there seems to be a bug in the lib https://github.com/NordicSemiconductor/IOS-nRF-Connect-Device-Manager/issues/209 } @@ -199,7 +199,7 @@ public class IOSFileUploader: NSObject { _lastBytesSend = 0 _lastBytesSendTimestamp = nil - setState(EIOSFileUploaderState.idle) + setState(.idle) busyStateChangedAdvertisement(true) fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0) } @@ -234,19 +234,19 @@ public class IOSFileUploader: NSObject { } private func isIdleOrCold() -> Bool { - return _currentState == EIOSFileUploaderState.idle || isCold(); + return _currentState == .idle || isCold(); } private func isCold() -> Bool { - return _currentState == EIOSFileUploaderState.none - || _currentState == EIOSFileUploaderState.error - || _currentState == EIOSFileUploaderState.complete - || _currentState == EIOSFileUploaderState.cancelled + return _currentState == .none + || _currentState == .error + || _currentState == .complete + || _currentState == .cancelled } //@objc dont private func onError(_ errorMessage: String, _ error: Error? = nil) { - setState(EIOSFileUploaderState.error) //keep first + setState(.error) //keep first _lastFatalErrorMessage = errorMessage @@ -346,7 +346,7 @@ public class IOSFileUploader: NSObject { stateChangedAdvertisement(oldState, newState) //order - if (oldState == EIOSFileUploaderState.uploading && newState == EIOSFileUploaderState.complete) //00 + if (oldState == .uploading && newState == .complete) //00 { fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(100, 0) } @@ -358,7 +358,7 @@ public class IOSFileUploader: NSObject { extension IOSFileUploader: FileUploadDelegate { public func uploadProgressDidChange(bytesSent: Int, fileSize: Int, timestamp: Date) { - setState(EIOSFileUploaderState.uploading) + setState(.uploading) let throughputKilobytesPerSecond = calculateThroughput(bytesSent: bytesSent, timestamp: timestamp) let uploadProgressPercentage = (bytesSent * 100) / fileSize fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(uploadProgressPercentage, throughputKilobytesPerSecond) @@ -370,14 +370,14 @@ extension IOSFileUploader: FileUploadDelegate { } public func uploadDidCancel() { - setState(EIOSFileUploaderState.cancelled) + setState(.cancelled) busyStateChangedAdvertisement(false) fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0) cancelledAdvertisement(_cancellationReason) } public func uploadDidFinish() { - setState(EIOSFileUploaderState.complete) + setState(.complete) fileUploadedAdvertisement() busyStateChangedAdvertisement(false) } From 93cea34515f225504528d032ad5d9fbd0cf56253 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 25 Oct 2024 13:56:49 +0200 Subject: [PATCH 094/104] refa (FileDownloader.DownloadAsync()): FileDownloader_FatalErrorOccurred_() we now rely on the EMcuMgrErrorCode instead of relying on string-sniffing --- .../AndroidFileDownloader.java | 16 ++---- .../AndroidFileUploader.java | 16 ++---- .../McuMgrExceptionHelpers.java | 33 ++++++++++++ ...uccessfully_GivenVariousFilesToDownload.cs | 19 +++++-- ...ToFailsafeSettings_GivenFlakyConnection.cs | 4 +- ...essfully_GivenGreenNativeFileDownloader.cs | 2 +- ...ailedException_GivenFatalErrorMidflight.cs | 2 +- ...dException_GivenRogueNativeErrorMessage.cs | 2 +- ...FoundException_GivenNonExistentFilepath.cs | 4 +- .../FileDownloader/FileDownloaderTestbed.cs | 2 +- ...uccessfully_GivenVariousFilesToDownload.cs | 6 +-- ...ToFailsafeSettings_GivenFlakyConnection.cs | 12 ++--- ...essfully_GivenGreenNativeFileDownloader.cs | 2 +- ...ldCompleteSuccessfully_GivenGreenStream.cs | 2 +- ...ailedException_GivenFatalErrorMidflight.cs | 2 +- ...dException_GivenRogueNativeErrorMessage.cs | 2 +- ...FoundException_GivenNonExistentFilepath.cs | 20 ++++---- ...ion_GivenAccessDeniedNativeErrorMessage.cs | 2 +- .../FileUploader/FileUploaderTestbed.cs | 2 +- .../Droid/FileDownloader/FileDownloader.cs | 6 +-- .../Droid/FileUploader/FileUploader.cs | 6 +-- .../Enums/EFileOperationGroupErrorCode.cs} | 6 ++- .../Shared/Common/Enums/EMcuMgrErrorCode.cs | 3 +- .../Events/FatalErrorOccurredEventArgs.cs | 6 +-- ...OutRemotePathPointsToDirectoryException.cs | 9 ++++ .../INativeFileDownloaderCallbacksProxy.cs | 2 +- .../Shared/FileDownloader/FileDownloader.cs | 32 ++++++------ .../Events/FatalErrorOccurredEventArgs.cs | 6 +-- .../Exceptions/UploadErroredOutException.cs | 8 +-- ...ErroredOutRemoteFolderNotFoundException.cs | 4 +- .../Exceptions/UploadUnauthorizedException.cs | 8 +-- .../INativeFileUploaderCallbacksProxy.cs | 2 +- .../Shared/FileUploader/FileUploader.cs | 51 +++++++++++-------- .../iOS/FileDownloader/FileDownloader.cs | 4 +- .../iOS/FileUploader/FileUploader.cs | 4 +- 35 files changed, 177 insertions(+), 130 deletions(-) create mode 100644 Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java rename Laerdal.McuMgr/Shared/{FileUploader/Contracts/Enums/EFileOperationGroupReturnCode.cs => Common/Enums/EFileOperationGroupErrorCode.cs} (73%) create mode 100644 Laerdal.McuMgr/Shared/FileDownloader/Contracts/Exceptions/DownloadErroredOutRemotePathPointsToDirectoryException.cs diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index aa5860b9..3161998d 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -5,7 +5,6 @@ import androidx.annotation.NonNull; import io.runtime.mcumgr.McuMgrTransport; import io.runtime.mcumgr.ble.McuMgrBleTransport; -import io.runtime.mcumgr.exception.McuMgrErrorException; import io.runtime.mcumgr.exception.McuMgrException; import io.runtime.mcumgr.managers.FsManager; import io.runtime.mcumgr.transfer.DownloadCallback; @@ -370,18 +369,13 @@ public void onError(final String errorMessage, final Exception exception) { setState(EAndroidFileDownloaderState.ERROR); - if (!(exception instanceof McuMgrErrorException)) - { - fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, errorMessage, -1, -1); - return; - } + McuMgrExceptionHelpers.ErrorCodes result = McuMgrExceptionHelpers.DeduceErrorCodesFromException(exception); - McuMgrErrorException mcuMgrErrorException = (McuMgrErrorException) exception; fatalErrorOccurredAdvertisement( _remoteFilePathSanitized, errorMessage, - mcuMgrErrorException.getCode().value(), - (mcuMgrErrorException.getGroupCode() != null ? mcuMgrErrorException.getGroupCode().group : -99) + result.errorCode, + result.errorGroupCode ); } @@ -407,7 +401,7 @@ public void cancelledAdvertisement() //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } - @Contract(pure = true) //wrapper utility method so that we wont have to constantly pass remoteFilePathSanitized as the first argument currently unused but should be handy in the future + @Contract(pure = true) //wrapper utility method so that we will not have to constantly pass remoteFilePathSanitized as the first argument currently unused but should be handy in the future public void stateChangedAdvertisement(final EAndroidFileDownloaderState oldState, final EAndroidFileDownloaderState newState) { stateChangedAdvertisement(_remoteFilePathSanitized, oldState, newState); @@ -431,7 +425,7 @@ public void downloadCompletedAdvertisement(final String resource, final byte[] d //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } - @Contract(pure = true) //wrapper utility method so that we wont have to constantly pass remoteFilePathSanitized as the fourth argument currently unused but should be handy in the future + @Contract(pure = true) //wrapper utility method so that we will not have to constantly pass remoteFilePathSanitized as the fourth argument currently unused but should be handy in the future private void logMessageAdvertisement(final String message, final String category, final String level) { logMessageAdvertisement(message, category, level, _remoteFilePathSanitized); diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index f3277a13..96bd3a35 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -5,7 +5,6 @@ import androidx.annotation.NonNull; import io.runtime.mcumgr.McuMgrTransport; import io.runtime.mcumgr.ble.McuMgrBleTransport; -import io.runtime.mcumgr.exception.McuMgrErrorException; import io.runtime.mcumgr.exception.McuMgrException; import io.runtime.mcumgr.managers.FsManager; import io.runtime.mcumgr.transfer.FileUploader; @@ -391,22 +390,17 @@ private void onError(final String errorMessage) } //@Contract(pure = true) //dont - private void onError(final String errorMessage, final Exception exception) + public void onError(final String errorMessage, final Exception exception) { - setState(EAndroidFileUploaderState.ERROR); //keep first + setState(EAndroidFileUploaderState.ERROR); - if (!(exception instanceof McuMgrErrorException)) - { - fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, errorMessage, -1, -1); // -1 values get mapped to the 'generic' error code - return; - } + McuMgrExceptionHelpers.ErrorCodes result = McuMgrExceptionHelpers.DeduceErrorCodesFromException(exception); - McuMgrErrorException mcuMgrErrorException = (McuMgrErrorException) exception; fatalErrorOccurredAdvertisement( _remoteFilePathSanitized, errorMessage, - mcuMgrErrorException.getCode().value(), - (mcuMgrErrorException.getGroupCode() != null ? mcuMgrErrorException.getGroupCode().group : -99) + result.errorCode, + result.errorGroupCode ); } diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java new file mode 100644 index 00000000..8b0fe611 --- /dev/null +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java @@ -0,0 +1,33 @@ +package no.laerdal.mcumgr_laerdal_wrapper; + +import io.runtime.mcumgr.exception.McuMgrErrorException; +import io.runtime.mcumgr.response.HasReturnCode; + +final class McuMgrExceptionHelpers { + + final protected static class ErrorCodes { + public final int errorCode; // typically EMcuMgrErrorCode + public final int errorGroupCode; // typically a *.ReturnCode (like FsManager.ReturnCode or ImageManage.ReturnCode and so on) + + private ErrorCodes(int errorCode, int errorGroupCode) { + this.errorCode = errorCode; + this.errorGroupCode = errorGroupCode; + } + } + + public static ErrorCodes DeduceErrorCodesFromException(Exception exception) { + if (!(exception instanceof McuMgrErrorException)) + return new ErrorCodes(-99, -99); + + McuMgrErrorException mcuMgrErrorException = (McuMgrErrorException) exception; + HasReturnCode.GroupReturnCode groupReturnCode = mcuMgrErrorException.getGroupCode(); + + int errorCode = mcuMgrErrorException.getCode().value(); + + int errorGroupCode = groupReturnCode != null + ? groupReturnCode.rc + : -99; + + return new ErrorCodes(errorCode, errorGroupCode); + } +} \ No newline at end of file diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index 7bfa39c4..7816e0ee 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -23,6 +23,8 @@ public async Task MultipleFilesDownloadAsync_ShouldCompleteSuccessfully_GivenVar { "/some/file/that/doesnt/exist.bin", null }, { "/some/file/that/exist/and/completes/after/a/couple/of/attempts.bin", [3] }, { "/some/file/that/exist/but/is/erroring/out/when/we/try/to/download/it.bin", null }, + { "/some/file/path/pointing/to/a/Directory", null }, + { "/some/file/path/pointing/to/a/directory", null }, }; var mockedNativeFileDownloaderProxy = new MockedGreenNativeFileDownloaderProxySpy6(new GenericNativeFileDownloaderCallbacksProxy_(), expectedResults); var fileDownloader = new McuMgr.FileDownloader.FileDownloader(mockedNativeFileDownloaderProxy); @@ -42,6 +44,8 @@ public async Task MultipleFilesDownloadAsync_ShouldCompleteSuccessfully_GivenVar "/some/file/that/exist/and/completes/after/a/couple/of/attempts.bin", //intentionally included multiple times to test whether the mechanism will attempt to download the file only once "/some/file/that/exist/but/is/erroring/out/when/we/try/to/download/it.bin", "/some/file/that/exist/but/is/erroring/out/when/we/try/to/download/it.bin", //intentionally included multiple times to test whether the mechanism will attempt to download the file only once + "some/file/path/pointing/to/a/Directory", + "/some/file/path/pointing/to/a/directory", }; using var eventsMonitor = fileDownloader.Monitor(); @@ -56,7 +60,7 @@ public async Task MultipleFilesDownloadAsync_ShouldCompleteSuccessfully_GivenVar )); // Assert - var results = (await work.Should().CompleteWithinAsync(5.Seconds())).Which; + var results = (await work.Should().CompleteWithinAsync(20.Seconds())).Which; results.Should().BeEquivalentTo(expectedResults); @@ -68,7 +72,7 @@ public async Task MultipleFilesDownloadAsync_ShouldCompleteSuccessfully_GivenVar eventsMonitor.OccurredEvents .Count(args => args.EventName == nameof(fileDownloader.FatalErrorOccurred)) .Should() - .Be(8); + .Be(10); mockedNativeFileDownloaderProxy.CancelCalled.Should().BeFalse(); mockedNativeFileDownloaderProxy.DisconnectCalled.Should().BeFalse(); //00 @@ -105,18 +109,23 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? if (remoteFilePathUppercase.Contains("some/file/that/exist/but/is/erroring/out/when/we/try/to/download/it.bin".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, oldState: EFileDownloaderState.Downloading, newState: EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "foobar", EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "foobar", EMcuMgrErrorCode.Unknown, EFileOperationGroupErrorCode.Unset); } else if (remoteFilePathUppercase.Contains("some/file/that/doesnt/exist.bin".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, oldState: EFileDownloaderState.Downloading, newState: EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "NO ENTRY (5)", EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "IN VALUE (3)", EMcuMgrErrorCode.Ok, EFileOperationGroupErrorCode.NotFound); } else if (remoteFilePathUppercase.Contains("some/file/that/exist/and/completes/after/a/couple/of/attempts.bin".ToUpperInvariant()) && _retryCountForProblematicFile++ < 3) { StateChangedAdvertisement(remoteFilePath, oldState: EFileDownloaderState.Downloading, newState: EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "ping pong", EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "ping pong", EMcuMgrErrorCode.Unknown, EFileOperationGroupErrorCode.Unset); + } + else if (remoteFilePathUppercase.Contains("some/file/path/pointing/to/a/directory".ToUpperInvariant())) + { + StateChangedAdvertisement(remoteFilePath, oldState: EFileDownloaderState.Downloading, newState: EFileDownloaderState.Error); + FatalErrorOccurredAdvertisement(remoteFilePath, "BLAH BLAH (4)", EMcuMgrErrorCode.Ok, EFileOperationGroupErrorCode.IsDirectory); } else { diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index 4ffa2559..e3797d2d 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -131,7 +131,7 @@ public override EFileDownloaderVerdict BeginDownload( { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForDownloading.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unknown, EFileOperationGroupErrorCode.Unset); // order return; } @@ -139,7 +139,7 @@ public override EFileDownloaderVerdict BeginDownload( { await Task.Delay(20); StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Unknown, EFileOperationGroupErrorCode.Unset); // order return; } diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index 429f5350..f14796d4 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -107,7 +107,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? if (_tryCount < _maxNumberOfTriesForSuccess) { StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Unknown, EFileOperationGroupErrorCode.Unset); return; } diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs index 52259579..bf1cd460 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs @@ -92,7 +92,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? await Task.Delay(2_000); StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.BadState, EFileOperationGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.BadState, EFileOperationGroupErrorCode.Unset); }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs index 07e1a945..3acf89c2 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs @@ -103,7 +103,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? await Task.Delay(100); StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.Unknown, EFileOperationGroupErrorCode.Unset); }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs index 567af537..fb7b531d 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs @@ -105,8 +105,8 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? await Task.Delay(100); - StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order simulates how the native code behaves - FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.NoEntry, EFileOperationGroupReturnCode.Unset); // order simulates how the csharp wrapper behaves + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order simulates how the native code behaves + FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.Ok, EFileOperationGroupErrorCode.NotFound); // order simulates how the csharp wrapper behaves }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs index 814ff867..ae6642ae 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs @@ -64,7 +64,7 @@ public void BusyStateChangedAdvertisement(bool busyNotIdle) public void DownloadCompletedAdvertisement(string resource, byte[] data) => _downloaderCallbacksProxy.DownloadCompletedAdvertisement(resource, data); //raises the actual event - public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileOperationGroupReturnCode) + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileOperationGroupReturnCode) => _downloaderCallbacksProxy.FatalErrorOccurredAdvertisement(resource, errorMessage, mcuMgrErrorCode, fileOperationGroupReturnCode); //raises the actual event public void FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput) diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index 06b77389..1b5ba8c6 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -116,18 +116,18 @@ public override EFileUploaderVerdict BeginUpload( if (remoteFilePathUppercase.Contains("some/file/to/a/folder/that/doesnt/exist.bin".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "UNKNOWN (1)", EMcuMgrErrorCode.Unknown, EFileOperationGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "UNKNOWN (1)", EMcuMgrErrorCode.Ok, EFileOperationGroupErrorCode.Unknown); } else if (remoteFilePathUppercase.Contains("some/file/that/succeeds/after/a/couple/of/attempts.bin".ToUpperInvariant()) && _retryCountForProblematicFile++ < 3) { StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "ping pong", EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "ping pong", EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); } else if (remoteFilePathUppercase.Contains("some/file/that/is/erroring/out/when/we/try/to/upload/it.bin".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "native symbols not loaded blah blah", EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "native symbols not loaded blah blah", EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); } else { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index 9dee7ea9..bc3eef25 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -140,7 +140,7 @@ public override EFileUploaderVerdict BeginUpload( { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); // order return; } @@ -148,7 +148,7 @@ public override EFileUploaderVerdict BeginUpload( { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); // order return; } @@ -156,7 +156,7 @@ public override EFileUploaderVerdict BeginUpload( { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); // order return; } @@ -164,7 +164,7 @@ public override EFileUploaderVerdict BeginUpload( { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); // order return; } @@ -172,7 +172,7 @@ public override EFileUploaderVerdict BeginUpload( { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); // order return; } @@ -180,7 +180,7 @@ public override EFileUploaderVerdict BeginUpload( { await Task.Delay(20); StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Generic, EFileOperationGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); // order return; } diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index 54c04013..9c19d67f 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -123,7 +123,7 @@ public override EFileUploaderVerdict BeginUpload( if (_tryCount < _maxNumberOfTriesForSuccess) { StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileOperationGroupReturnCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileOperationGroupErrorCode.Unset); return; } diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs index b354e372..8b52fcdb 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs @@ -137,7 +137,7 @@ public override EFileUploaderVerdict BeginUpload( { await Task.Delay(20); StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileOperationGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileOperationGroupErrorCode.Unset); // order return; } diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs index 1c6b109a..5aa30781 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs @@ -106,7 +106,7 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(2_000); StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileOperationGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileOperationGroupErrorCode.Unset); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs index b201aaa2..fd1e5854 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs @@ -116,7 +116,7 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(100); StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.Corrupt, EFileOperationGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.Corrupt, EFileOperationGroupErrorCode.Unset); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs index e5efc73d..9885930e 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs @@ -15,12 +15,12 @@ namespace Laerdal.McuMgr.Tests.FileUploader public partial class FileUploaderTestbed { [Theory] - [InlineData("FDT.SFUA.STRFNFE.GNEF.010", EMcuMgrErrorCode.Unknown, "UNKNOWN (1)", 1)] //android + ios - [InlineData("FDT.SFUA.STRFNFE.GNEF.020", EMcuMgrErrorCode.Unknown, "UNKNOWN (1)", 2)] //android + ios - [InlineData("FDT.SFUA.STRFNFE.GNEF.030", EMcuMgrErrorCode.Unknown, "UNKNOWN (1)", 3)] //android + ios + [InlineData("FDT.SFUA.STRFNFE.GNEF.010", EFileOperationGroupErrorCode.Unknown, "UNKNOWN (1)", 1)] //android + ios + [InlineData("FDT.SFUA.STRFNFE.GNEF.020", EFileOperationGroupErrorCode.Unknown, "UNKNOWN (1)", 2)] //android + ios + [InlineData("FDT.SFUA.STRFNFE.GNEF.030", EFileOperationGroupErrorCode.Unknown, "UNKNOWN (1)", 3)] //android + ios public async Task SingleFileUploadAsync_ShouldThrowRemoteFolderNotFoundException_GivenNonExistFolderInPath( string testcaseNickname, - EMcuMgrErrorCode mcuMgrErrorCode, + EFileOperationGroupErrorCode fileOperationGroupErrorCode, string nativeErrorMessageForFileNotFound, int maxTriesCount ) @@ -32,7 +32,7 @@ int maxTriesCount var mockedNativeFileUploaderProxy = new MockedErroneousNativeFileUploaderProxySpy2( mockedFileData: mockedFileData, uploaderCallbacksProxy: new GenericNativeFileUploaderCallbacksProxy_(), - mcuMgrErrorCode: mcuMgrErrorCode, + fileOperationGroupErrorCode: fileOperationGroupErrorCode, nativeErrorMessageForFileNotFound: nativeErrorMessageForFileNotFound ); var fileUploader = new McuMgr.FileUploader.FileUploader(mockedNativeFileUploaderProxy); @@ -87,18 +87,18 @@ await work.Should() private class MockedErroneousNativeFileUploaderProxySpy2 : MockedNativeFileUploaderProxySpy { - private readonly EMcuMgrErrorCode _mcuMgrErrorCode; + private readonly EFileOperationGroupErrorCode _fileOperationGroupErrorCode; private readonly string _nativeErrorMessageForFileNotFound; public MockedErroneousNativeFileUploaderProxySpy2( INativeFileUploaderCallbacksProxy uploaderCallbacksProxy, byte[] mockedFileData, - EMcuMgrErrorCode mcuMgrErrorCode, + EFileOperationGroupErrorCode fileOperationGroupErrorCode, string nativeErrorMessageForFileNotFound ) : base(uploaderCallbacksProxy) { _ = mockedFileData; - _mcuMgrErrorCode = mcuMgrErrorCode; + _fileOperationGroupErrorCode = fileOperationGroupErrorCode; _nativeErrorMessageForFileNotFound = nativeErrorMessageForFileNotFound; } @@ -132,8 +132,8 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(100); - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, _mcuMgrErrorCode, EFileOperationGroupReturnCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.Ok, _fileOperationGroupErrorCode); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs index 3a2dbc05..c430bd61 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs @@ -74,7 +74,7 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(100); StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "blah blah", EMcuMgrErrorCode.AccessDenied, EFileOperationGroupReturnCode.Unset); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "blah blah", EMcuMgrErrorCode.AccessDenied, EFileOperationGroupErrorCode.Unset); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs index cadda09c..4354298a 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs @@ -77,7 +77,7 @@ public void FatalErrorOccurredAdvertisement( string resource, string errorMessage, EMcuMgrErrorCode errorCode, - EFileOperationGroupReturnCode fileUploaderGroupReturnCode + EFileOperationGroupErrorCode fileUploaderGroupReturnCode ) => _uploaderCallbacksProxy.FatalErrorOccurredAdvertisement(resource, errorMessage, errorCode, fileUploaderGroupReturnCode); //raises the actual event public void FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput) diff --git a/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs index b1c1abab..70399932 100644 --- a/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs @@ -132,16 +132,16 @@ public override void FatalErrorOccurredAdvertisement(string resource, string err { base.FatalErrorOccurredAdvertisement(resource, errorMessage, mcuMgrErrorCode, fileOperationGroupReturnCode); //just in case - FatalErrorOccurredAdvertisement(resource, errorMessage, (EMcuMgrErrorCode) mcuMgrErrorCode, (EFileOperationGroupReturnCode) fileOperationGroupReturnCode); + FatalErrorOccurredAdvertisement(resource, errorMessage, (EMcuMgrErrorCode) mcuMgrErrorCode, (EFileOperationGroupErrorCode) fileOperationGroupReturnCode); } - public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileUploaderGroupReturnCode) + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileUploaderGroupErrorCode) { _fileDownloaderCallbacksProxy?.FatalErrorOccurredAdvertisement( resource, errorMessage, mcuMgrErrorCode, - fileUploaderGroupReturnCode + fileUploaderGroupErrorCode ); } diff --git a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs index 2b1908e6..2173177e 100644 --- a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs @@ -152,16 +152,16 @@ public override void FatalErrorOccurredAdvertisement(string resource, string err { base.FatalErrorOccurredAdvertisement(resource, errorMessage, mcuMgrErrorCode, fileUploaderGroupReturnCode); //just in case - FatalErrorOccurredAdvertisement(resource, errorMessage, (EMcuMgrErrorCode) mcuMgrErrorCode, (EFileOperationGroupReturnCode) fileUploaderGroupReturnCode); + FatalErrorOccurredAdvertisement(resource, errorMessage, (EMcuMgrErrorCode) mcuMgrErrorCode, (EFileOperationGroupErrorCode) fileUploaderGroupReturnCode); } - public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileUploaderGroupReturnCode) + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileUploaderGroupErrorCode) { _fileUploaderCallbacksProxy?.FatalErrorOccurredAdvertisement( resource, errorMessage, mcuMgrErrorCode, - fileUploaderGroupReturnCode + fileUploaderGroupErrorCode ); } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/EFileOperationGroupReturnCode.cs b/Laerdal.McuMgr/Shared/Common/Enums/EFileOperationGroupErrorCode.cs similarity index 73% rename from Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/EFileOperationGroupReturnCode.cs rename to Laerdal.McuMgr/Shared/Common/Enums/EFileOperationGroupErrorCode.cs index faf95cb4..44681cf9 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Enums/EFileOperationGroupReturnCode.cs +++ b/Laerdal.McuMgr/Shared/Common/Enums/EFileOperationGroupErrorCode.cs @@ -1,6 +1,8 @@ -namespace Laerdal.McuMgr.FileUploader.Contracts.Enums +namespace Laerdal.McuMgr.Common.Enums { - public enum EFileOperationGroupReturnCode //@formatter:off + // values greater than zero must mirror the ones found in + // mcumgr-core/src/main/java/io/runtime/mcumgr/managers/FsManager.java -> enum ReturnCode + public enum EFileOperationGroupErrorCode //@formatter:off { Unset = -99, Ok = 00, diff --git a/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs b/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs index 2e5c5374..be715ac9 100644 --- a/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs +++ b/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs @@ -1,6 +1,7 @@ namespace Laerdal.McuMgr.Common.Enums { - public enum EMcuMgrErrorCode // must mirror io.runtime.mcumgr.McuMgrErrorCode @formatter:off + // must mirror mcumgr-core/src/main/java/io/runtime/mcumgr/exception/McuMgrErrorException.java + public enum EMcuMgrErrorCode // @formatter:off { Unset = -99, //this is our own to mark that we haven't received any error code from the device Generic = -1, //in case the underlying native code receives an exception other than io.runtime.mcumgr.exception.McuMgrErrorException diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Events/FatalErrorOccurredEventArgs.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Events/FatalErrorOccurredEventArgs.cs index d9377fa9..a8da1068 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Events/FatalErrorOccurredEventArgs.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Events/FatalErrorOccurredEventArgs.cs @@ -12,14 +12,14 @@ namespace Laerdal.McuMgr.FileDownloader.Contracts.Events public string Resource { get; } public string ErrorMessage { get; } public EMcuMgrErrorCode McuMgrErrorCode { get; } - public EFileOperationGroupReturnCode FileOperationGroupReturnCode { get; } + public EFileOperationGroupErrorCode FileOperationGroupErrorCode { get; } - public FatalErrorOccurredEventArgs(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileOperationGroupReturnCode) + public FatalErrorOccurredEventArgs(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileOperationGroupErrorCode) { Resource = resource; ErrorMessage = errorMessage; McuMgrErrorCode = mcuMgrErrorCode; - FileOperationGroupReturnCode = fileOperationGroupReturnCode; + FileOperationGroupErrorCode = fileOperationGroupErrorCode; } } } diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Exceptions/DownloadErroredOutRemotePathPointsToDirectoryException.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Exceptions/DownloadErroredOutRemotePathPointsToDirectoryException.cs new file mode 100644 index 00000000..742bc6d6 --- /dev/null +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Exceptions/DownloadErroredOutRemotePathPointsToDirectoryException.cs @@ -0,0 +1,9 @@ +namespace Laerdal.McuMgr.FileDownloader.Contracts.Exceptions +{ + public sealed class DownloadErroredOutRemotePathPointsToDirectoryException : DownloadErroredOutException, IDownloadException + { + public DownloadErroredOutRemotePathPointsToDirectoryException(string remoteFilePath) : base($"The given file-path '{remoteFilePath}' points to a directory") + { + } + } +} \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCallbacksProxy.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCallbacksProxy.cs index e0cc4182..045d413b 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCallbacksProxy.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCallbacksProxy.cs @@ -13,7 +13,7 @@ internal interface INativeFileDownloaderCallbacksProxy void StateChangedAdvertisement(string resource, EFileDownloaderState oldState, EFileDownloaderState newState); void BusyStateChangedAdvertisement(bool busyNotIdle); void DownloadCompletedAdvertisement(string resource, byte[] data); - void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileOperationGroupReturnCode); + void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileOperationGroupErrorCode); void FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput); } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index e32a9f7d..2e45414b 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -305,7 +305,7 @@ public async Task DownloadAsync( } catch (DownloadErroredOutException ex) { - if (ex is DownloadErroredOutRemoteFileNotFoundException) //order no point to retry if the remote file is not there + if (ex is DownloadErroredOutRemoteFileNotFoundException or DownloadErroredOutRemotePathPointsToDirectoryException) //order no point to retry if the filepath is problematic { //OnStateChanged(new StateChangedEventArgs(newState: EFileDownloaderState.Error)); //noneed already done in native code throw; @@ -408,27 +408,25 @@ void FileDownloader_DownloadCompleted_(object sender_, DownloadCompletedEventArg void FileDownloader_FatalErrorOccurred_(object sender_, FatalErrorOccurredEventArgs ea_) { - var isAboutUnauthorized = ea_.ErrorMessage?.ToUpperInvariant().Contains("UNRECOGNIZED (11)", StringComparison.InvariantCultureIgnoreCase) ?? false; - if (isAboutUnauthorized) + if (ea_ is { McuMgrErrorCode: EMcuMgrErrorCode.AccessDenied }) // unauthorized { - taskCompletionSource.TrySetException(new UnauthorizedException( - resource: remoteFilePath, - nativeErrorMessage: ea_.ErrorMessage - )); + taskCompletionSource.TrySetException(new UnauthorizedException(resource: remoteFilePath, nativeErrorMessage: ea_.ErrorMessage)); return; } - var isAboutRemoteFileNotFound = ea_.ErrorMessage - ?.ToUpperInvariant() - .Replace("NO_ENTRY (5)", "NO ENTRY (5)") //normalize the error for android so that it will be the same as in ios - .Contains("NO ENTRY (5)") ?? false; - if (isAboutRemoteFileNotFound) + if (ea_ is { FileOperationGroupErrorCode: EFileOperationGroupErrorCode.NotFound}) // remote file not found { - taskCompletionSource.TrySetException(new DownloadErroredOutRemoteFileNotFoundException(remoteFilePath)); //specific case + taskCompletionSource.TrySetException(new DownloadErroredOutRemoteFileNotFoundException(remoteFilePath)); return; } - - taskCompletionSource.TrySetException(new DownloadErroredOutException(ea_.ErrorMessage)); //generic + + if (ea_ is { FileOperationGroupErrorCode: EFileOperationGroupErrorCode.IsDirectory}) // remote filepath points to a directory + { + taskCompletionSource.TrySetException(new DownloadErroredOutRemotePathPointsToDirectoryException(remoteFilePath)); + return; + } + + taskCompletionSource.TrySetException(new DownloadErroredOutException(remoteFilePath)); } } @@ -496,8 +494,8 @@ public void BusyStateChangedAdvertisement(bool busyNotIdle) public void DownloadCompletedAdvertisement(string resource, byte[] data) => FileDownloader?.OnDownloadCompleted(new DownloadCompletedEventArgs(resource, data)); - public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileOperationGroupReturnCode) - => FileDownloader?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs(resource, errorMessage, mcuMgrErrorCode, fileOperationGroupReturnCode)); + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileOperationGroupErrorCode) + => FileDownloader?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs(resource, errorMessage, mcuMgrErrorCode, fileOperationGroupErrorCode)); public void FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput) => FileDownloader?.OnFileDownloadProgressPercentageAndDataThroughputChanged(new FileDownloadProgressPercentageAndDataThroughputChangedEventArgs( diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/FatalErrorOccurredEventArgs.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/FatalErrorOccurredEventArgs.cs index 8075bec3..a6514d20 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/FatalErrorOccurredEventArgs.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/FatalErrorOccurredEventArgs.cs @@ -13,14 +13,14 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Events public string RemoteFilePath { get; } public EMcuMgrErrorCode ErrorCode { get; } - public EFileOperationGroupReturnCode GroupReturnCode { get; } + public EFileOperationGroupErrorCode FileOperationGroupErrorCode { get; } - public FatalErrorOccurredEventArgs(string remoteFilePath, string errorMessage, EMcuMgrErrorCode errorCode, EFileOperationGroupReturnCode groupReturnCode) + public FatalErrorOccurredEventArgs(string remoteFilePath, string errorMessage, EMcuMgrErrorCode errorCode, EFileOperationGroupErrorCode fileOperationGroupErrorCode) { ErrorCode = errorCode; ErrorMessage = errorMessage; RemoteFilePath = remoteFilePath; - GroupReturnCode = groupReturnCode; + FileOperationGroupErrorCode = fileOperationGroupErrorCode; } } } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs index f891cdb1..bb64cdd9 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs @@ -9,7 +9,7 @@ public class UploadErroredOutException : Exception, IUploadException public string RemoteFilePath { get; } public EMcuMgrErrorCode McuMgrErrorCode { get; } = EMcuMgrErrorCode.Unset; - public EFileOperationGroupReturnCode GroupReturnCode { get; } = EFileOperationGroupReturnCode.Unset; + public EFileOperationGroupErrorCode FileOperationGroupErrorCode { get; } = EFileOperationGroupErrorCode.Unset; protected UploadErroredOutException(string remoteFilePath, string errorMessage, Exception innerException = null) : base($"An error occurred while uploading over to '{remoteFilePath}': '{errorMessage}'", innerException) @@ -21,13 +21,13 @@ public UploadErroredOutException( string nativeErrorMessage, string remoteFilePath, EMcuMgrErrorCode mcuMgrErrorCode, - EFileOperationGroupReturnCode groupReturnCode, + EFileOperationGroupErrorCode fileOperationGroupErrorCode, Exception innerException = null - ) : base($"An error occurred while uploading '{remoteFilePath}': '{nativeErrorMessage}' (mcuMgrErrorCode={mcuMgrErrorCode}, groupReturnCode={groupReturnCode})", innerException) + ) : base($"An error occurred while uploading '{remoteFilePath}': '{nativeErrorMessage}' (mcuMgrErrorCode={mcuMgrErrorCode}, groupReturnCode={fileOperationGroupErrorCode})", innerException) { RemoteFilePath = remoteFilePath; McuMgrErrorCode = mcuMgrErrorCode; - GroupReturnCode = groupReturnCode; + FileOperationGroupErrorCode = fileOperationGroupErrorCode; } } } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutRemoteFolderNotFoundException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutRemoteFolderNotFoundException.cs index fa739cd9..94df0b92 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutRemoteFolderNotFoundException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutRemoteFolderNotFoundException.cs @@ -11,12 +11,12 @@ public UploadErroredOutRemoteFolderNotFoundException( string nativeErrorMessage, string remoteFilePath, EMcuMgrErrorCode mcuMgrErrorCode, - EFileOperationGroupReturnCode groupReturnCode + EFileOperationGroupErrorCode fileOperationGroupErrorCode ) : base( nativeErrorMessage: nativeErrorMessage, remoteFilePath: remoteFilePath, mcuMgrErrorCode: mcuMgrErrorCode, - groupReturnCode: groupReturnCode + fileOperationGroupErrorCode: fileOperationGroupErrorCode ) { } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs index 1243df45..92c36c11 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs @@ -9,14 +9,14 @@ public class UploadUnauthorizedException : UploadErroredOutException, IMcuMgrExc public string RemoteFilePath { get; } public EMcuMgrErrorCode McuMgrErrorCode { get; } - public EFileOperationGroupReturnCode GroupReturnCode { get; } + public EFileOperationGroupErrorCode FileOperationGroupErrorCode { get; } - public UploadUnauthorizedException(string nativeErrorMessage, string remoteFilePath, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode groupReturnCode) - : base(remoteFilePath, $"{nativeErrorMessage} (McuMgrErrorCode={mcuMgrErrorCode}, GroupReturnCode={groupReturnCode})") + public UploadUnauthorizedException(string nativeErrorMessage, string remoteFilePath, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileOperationGroupErrorCode) + : base(remoteFilePath, $"{nativeErrorMessage} (McuMgrErrorCode={mcuMgrErrorCode}, GroupReturnCode={fileOperationGroupErrorCode})") { RemoteFilePath = remoteFilePath; McuMgrErrorCode = mcuMgrErrorCode; - GroupReturnCode = groupReturnCode; + FileOperationGroupErrorCode = fileOperationGroupErrorCode; } } } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs index 16858c7d..4216ecf1 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs @@ -14,7 +14,7 @@ internal interface INativeFileUploaderCallbacksProxy void StateChangedAdvertisement(string resource, EFileUploaderState oldState, EFileUploaderState newState); void BusyStateChangedAdvertisement(bool busyNotIdle); void FileUploadedAdvertisement(string resource); - void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileUploaderGroupReturnCode); + void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileUploaderGroupErrorCode); void FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput); } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index 270d05ad..b7c56c12 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -471,34 +471,41 @@ void FileUploader_StateChanged_(object _, StateChangedEventArgs ea_) // ReSharpe } } // ReSharper restore AccessToModifiedClosure - void FileUploader_FileUploadProgressPercentageAndDataThroughputChanged_(object sender, FileUploadProgressPercentageAndDataThroughputChangedEventArgs ea) + void FileUploader_FileUploadProgressPercentageAndDataThroughputChanged_(object _, FileUploadProgressPercentageAndDataThroughputChangedEventArgs ea_) { fileUploadProgressEventsCount++; } - void FileUploader_FatalErrorOccurred_(object sender, FatalErrorOccurredEventArgs ea) + void FileUploader_FatalErrorOccurred_(object _, FatalErrorOccurredEventArgs ea_) { - taskCompletionSource.TrySetException(ea.ErrorCode switch + if (ea_.ErrorCode == EMcuMgrErrorCode.AccessDenied) { - EMcuMgrErrorCode.Unknown => new UploadErroredOutRemoteFolderNotFoundException( //specific case + taskCompletionSource.TrySetException(new UploadUnauthorizedException( remoteFilePath: remoteFilePath, - mcuMgrErrorCode: ea.ErrorCode, - groupReturnCode: ea.GroupReturnCode, - nativeErrorMessage: ea.ErrorMessage - ), - EMcuMgrErrorCode.AccessDenied => new UploadUnauthorizedException( //specific case - remoteFilePath: remoteFilePath, - mcuMgrErrorCode: ea.ErrorCode, - groupReturnCode: ea.GroupReturnCode, - nativeErrorMessage: ea.ErrorMessage - ), - _ => new UploadErroredOutException( //generic + mcuMgrErrorCode: ea_.ErrorCode, + nativeErrorMessage: ea_.ErrorMessage, + fileOperationGroupErrorCode: ea_.FileOperationGroupErrorCode + )); + return; + } + + if (ea_.FileOperationGroupErrorCode == EFileOperationGroupErrorCode.Unknown) + { + taskCompletionSource.TrySetException(new UploadErroredOutRemoteFolderNotFoundException( remoteFilePath: remoteFilePath, - mcuMgrErrorCode: ea.ErrorCode, - groupReturnCode: ea.GroupReturnCode, - nativeErrorMessage: ea.ErrorMessage - ) - }); + mcuMgrErrorCode: ea_.ErrorCode, + nativeErrorMessage: ea_.ErrorMessage, + fileOperationGroupErrorCode: ea_.FileOperationGroupErrorCode + )); + return; + } + + taskCompletionSource.TrySetException(new UploadErroredOutException( + remoteFilePath: remoteFilePath, + mcuMgrErrorCode: ea_.ErrorCode, + nativeErrorMessage: ea_.ErrorMessage, + fileOperationGroupErrorCode: ea_.FileOperationGroupErrorCode + )); } } @@ -588,12 +595,12 @@ public void FatalErrorOccurredAdvertisement( string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, - EFileOperationGroupReturnCode fileUploaderGroupReturnCode + EFileOperationGroupErrorCode fileUploaderGroupErrorCode ) => FileUploader?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs( resource, errorMessage, mcuMgrErrorCode, - fileUploaderGroupReturnCode + fileUploaderGroupErrorCode )); public void FileUploadProgressPercentageAndDataThroughputChangedAdvertisement( diff --git a/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs index 8bc269ca..47291f77 100644 --- a/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs @@ -182,10 +182,10 @@ nint mcuMgrErrorCode resource, errorMessage, (EMcuMgrErrorCode)(int)mcuMgrErrorCode, - EFileOperationGroupReturnCode.Unset + EFileOperationGroupErrorCode.Unset ); - public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupReturnCode fileOperationGroupReturnCode) + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileOperationGroupReturnCode) => _nativeFileDownloaderCallbacksProxy?.FatalErrorOccurredAdvertisement(resource, errorMessage, mcuMgrErrorCode, fileOperationGroupReturnCode); public override void FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(nint progressPercentage, float averageThroughput) diff --git a/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs b/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs index a592ec77..176fb634 100644 --- a/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs @@ -209,13 +209,13 @@ nint mcuMgrErrorCode resource, errorMessage, (EMcuMgrErrorCode)(int)mcuMgrErrorCode, - EFileOperationGroupReturnCode.Unset + EFileOperationGroupErrorCode.Unset ); public void FatalErrorOccurredAdvertisement( //conformance to the interface string resource, string errorMessage, // ReSharper disable once MethodOverloadWithOptionalParameter EMcuMgrErrorCode mcuMgrErrorCode, - EFileOperationGroupReturnCode fileUploaderGroupReturnCode + EFileOperationGroupErrorCode fileUploaderGroupReturnCode ) => _nativeFileUploaderCallbacksProxy?.FatalErrorOccurredAdvertisement( resource, errorMessage, From a5225b703f11f4f3984f03c1145e49c41e1b5afd Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Fri, 25 Oct 2024 21:07:11 +0200 Subject: [PATCH 095/104] feat (FileUploader.BeginUpload()): fix a bug which was causing the exception UploadErroredOutRemoteFolderNotFoundException() to not be thrown when the native Android code would report that target directory doesn't exist in the remote device note that the file-uploader and file-downloader are broken with this commit on iOS and need to be fixed --- .../McuMgrBindingsiOS/IOSFileDownloader.swift | 6 ++++++ .../McuMgrBindingsiOS/IOSFileUploader.swift | 6 ++++++ ...houldCompleteSuccessfully_GivenVariousFilesToDownload.cs | 2 +- ...emoteFolderNotFoundException_GivenNonExistentFilepath.cs | 6 +++--- Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs | 2 +- Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs | 4 ++-- 6 files changed, 19 insertions(+), 7 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift index a2faef48..1c459ac7 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift @@ -183,6 +183,12 @@ public class IOSFileDownloader: NSObject { private func onError(_ errorMessage: String, _ error: Error? = nil) { setState(.error) //keep first + // todo use this technique instead of string sniffing + // here mcuMgrError is of type McuMgrError which can be either case returnCode or case groupCode } + // if let mcuMgrError = error as? McuMgrError { //todo https://github.com/NordicSemiconductor/IOS-nRF-Connect-Device-Manager/issues/198 + // mcuMgrError. + // } + _lastFatalErrorMessage = errorMessage let (errorCode, _) = deduceErrorCode(errorMessage) diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift index 0c54baa2..d748c370 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift @@ -248,6 +248,12 @@ public class IOSFileUploader: NSObject { private func onError(_ errorMessage: String, _ error: Error? = nil) { setState(.error) //keep first + // todo use this technique instead of string sniffing + // here mcuMgrError is of type McuMgrError which can be either case returnCode or case groupCode } + // if let mcuMgrError = error as? McuMgrError { //todo https://github.com/NordicSemiconductor/IOS-nRF-Connect-Device-Manager/issues/198 + // mcuMgrError. + // } + _lastFatalErrorMessage = errorMessage let (errorCode, _) = deduceErrorCode(errorMessage) diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index 1b5ba8c6..6180345a 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -116,7 +116,7 @@ public override EFileUploaderVerdict BeginUpload( if (remoteFilePathUppercase.Contains("some/file/to/a/folder/that/doesnt/exist.bin".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "UNKNOWN (1)", EMcuMgrErrorCode.Ok, EFileOperationGroupErrorCode.Unknown); + FatalErrorOccurredAdvertisement(remoteFilePath, "FOOBAR (3)", EMcuMgrErrorCode.Ok, EFileOperationGroupErrorCode.NotFound); } else if (remoteFilePathUppercase.Contains("some/file/that/succeeds/after/a/couple/of/attempts.bin".ToUpperInvariant()) && _retryCountForProblematicFile++ < 3) diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs index 9885930e..a85a96af 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs @@ -15,9 +15,9 @@ namespace Laerdal.McuMgr.Tests.FileUploader public partial class FileUploaderTestbed { [Theory] - [InlineData("FDT.SFUA.STRFNFE.GNEF.010", EFileOperationGroupErrorCode.Unknown, "UNKNOWN (1)", 1)] //android + ios - [InlineData("FDT.SFUA.STRFNFE.GNEF.020", EFileOperationGroupErrorCode.Unknown, "UNKNOWN (1)", 2)] //android + ios - [InlineData("FDT.SFUA.STRFNFE.GNEF.030", EFileOperationGroupErrorCode.Unknown, "UNKNOWN (1)", 3)] //android + ios + [InlineData("FDT.SFUA.STRFNFE.GNEF.010", EFileOperationGroupErrorCode.NotFound, "UNKNOWN (1)", 1)] //android + ios + [InlineData("FDT.SFUA.STRFNFE.GNEF.020", EFileOperationGroupErrorCode.NotFound, "UNKNOWN (1)", 2)] //android + ios + [InlineData("FDT.SFUA.STRFNFE.GNEF.030", EFileOperationGroupErrorCode.NotFound, "UNKNOWN (1)", 3)] //android + ios public async Task SingleFileUploadAsync_ShouldThrowRemoteFolderNotFoundException_GivenNonExistFolderInPath( string testcaseNickname, EFileOperationGroupErrorCode fileOperationGroupErrorCode, diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index 2e45414b..7e95aa4c 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -408,7 +408,7 @@ void FileDownloader_DownloadCompleted_(object sender_, DownloadCompletedEventArg void FileDownloader_FatalErrorOccurred_(object sender_, FatalErrorOccurredEventArgs ea_) { - if (ea_ is { McuMgrErrorCode: EMcuMgrErrorCode.AccessDenied }) // unauthorized + if (ea_ is { McuMgrErrorCode: EMcuMgrErrorCode.AccessDenied }) // unauthorized todo ios passes wrong values here and needs to be fixed { taskCompletionSource.TrySetException(new UnauthorizedException(resource: remoteFilePath, nativeErrorMessage: ea_.ErrorMessage)); return; diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index b7c56c12..f2db168a 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -478,7 +478,7 @@ void FileUploader_FileUploadProgressPercentageAndDataThroughputChanged_(object _ void FileUploader_FatalErrorOccurred_(object _, FatalErrorOccurredEventArgs ea_) { - if (ea_.ErrorCode == EMcuMgrErrorCode.AccessDenied) + if (ea_.ErrorCode == EMcuMgrErrorCode.AccessDenied) //todo ios is broken and needs to be fixed { taskCompletionSource.TrySetException(new UploadUnauthorizedException( remoteFilePath: remoteFilePath, @@ -489,7 +489,7 @@ void FileUploader_FatalErrorOccurred_(object _, FatalErrorOccurredEventArgs ea_) return; } - if (ea_.FileOperationGroupErrorCode == EFileOperationGroupErrorCode.Unknown) + if (ea_.FileOperationGroupErrorCode == EFileOperationGroupErrorCode.NotFound) { taskCompletionSource.TrySetException(new UploadErroredOutRemoteFolderNotFoundException( remoteFilePath: remoteFilePath, From d3451d443b6c84405d40515e74075af9c47237ee Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 28 Oct 2024 17:56:17 +0100 Subject: [PATCH 096/104] refa (FileDownloader, FileUploader): when we detect an error from an exception we now deduce a numeric global-error-code from it and send that to the C# world (old was: 2 separate and very confusing error codes) --- .../AndroidFileDownloader.java | 8 +- .../AndroidFileUploader.java | 8 +- .../McuMgrExceptionHelpers.java | 35 +++--- .../project.pbxproj | 12 +- .../McuMgrBindingsiOS/IOSFileDownloader.swift | 44 +------ .../McuMgrBindingsiOS/IOSFileUploader.swift | 46 +------- .../IOSListenerForFileDownloader.swift | 2 +- .../IOSListenerForFileUploader.swift | 3 +- .../McuMgrExceptionHelpers.swift | 28 +++++ ...uccessfully_GivenVariousFilesToDownload.cs | 10 +- ...ToFailsafeSettings_GivenFlakyConnection.cs | 8 +- ...essfully_GivenGreenNativeFileDownloader.cs | 2 +- ...ailedException_GivenFatalErrorMidflight.cs | 2 +- ...dException_GivenRogueNativeErrorMessage.cs | 10 +- ...FoundException_GivenNonExistentFilepath.cs | 24 ++-- .../FileDownloader/FileDownloaderTestbed.cs | 4 +- ...uccessfully_GivenVariousFilesToDownload.cs | 6 +- ...ToFailsafeSettings_GivenFlakyConnection.cs | 24 ++-- ...essfully_GivenGreenNativeFileDownloader.cs | 2 +- ...ldCompleteSuccessfully_GivenGreenStream.cs | 4 +- ...ailedException_GivenFatalErrorMidflight.cs | 4 +- ...dException_GivenRogueNativeErrorMessage.cs | 12 +- ...FoundException_GivenNonExistentFilepath.cs | 20 ++-- ...ion_GivenAccessDeniedNativeErrorMessage.cs | 9 +- .../FileUploader/FileUploaderTestbed.cs | 5 +- Laerdal.McuMgr/Droid/Common/HelpersAndroid.cs | 3 +- .../Droid/FileDownloader/FileDownloader.cs | 12 +- .../Droid/FileUploader/FileUploader.cs | 15 +-- .../Enums/EFileOperationGroupErrorCode.cs | 26 ----- .../Shared/Common/Enums/EGlobalErrorCode.cs | 109 ++++++++++++++++++ .../Shared/Common/Enums/ELogLevel.cs | 1 + .../Shared/Common/Enums/EMcuMgrErrorCode.cs | 24 ---- .../Events/FatalErrorOccurredEventArgs.cs | 8 +- .../INativeFileDownloaderCallbacksProxy.cs | 2 +- .../Shared/FileDownloader/FileDownloader.cs | 35 ++---- .../Events/FatalErrorOccurredEventArgs.cs | 8 +- .../Exceptions/UploadErroredOutException.cs | 11 +- ...ErroredOutRemoteFolderNotFoundException.cs | 8 +- .../Exceptions/UploadUnauthorizedException.cs | 11 +- .../INativeFileUploaderCallbacksProxy.cs | 2 +- .../Shared/FileUploader/FileUploader.cs | 40 ++----- Laerdal.McuMgr/iOS/Common/HelpersIOS.cs | 15 ++- .../iOS/FileDownloader/FileDownloader.cs | 11 +- .../iOS/FileUploader/FileUploader.cs | 17 ++- 44 files changed, 316 insertions(+), 374 deletions(-) create mode 100644 Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/McuMgrExceptionHelpers.swift delete mode 100644 Laerdal.McuMgr/Shared/Common/Enums/EFileOperationGroupErrorCode.cs create mode 100644 Laerdal.McuMgr/Shared/Common/Enums/EGlobalErrorCode.cs delete mode 100644 Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index 3161998d..7211e722 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -369,21 +369,17 @@ public void onError(final String errorMessage, final Exception exception) { setState(EAndroidFileDownloaderState.ERROR); - McuMgrExceptionHelpers.ErrorCodes result = McuMgrExceptionHelpers.DeduceErrorCodesFromException(exception); - fatalErrorOccurredAdvertisement( _remoteFilePathSanitized, errorMessage, - result.errorCode, - result.errorGroupCode + McuMgrExceptionHelpers.DeduceGlobalErrorCodeFromException(exception) ); } public void fatalErrorOccurredAdvertisement( final String remoteFilePath, final String errorMessage, - final int mcuMgrErrorCode, // io.runtime.mcumgr.McuMgrErrorCode - final int fsManagerGroupReturnCode // io.runtime.mcumgr.managers.FsManager.ReturnCode + final int globalErrorCode // have a look at EGlobalErrorCode.cs in csharp ) { _lastFatalErrorMessage = errorMessage; diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 96bd3a35..8f99e842 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -394,21 +394,17 @@ public void onError(final String errorMessage, final Exception exception) { setState(EAndroidFileUploaderState.ERROR); - McuMgrExceptionHelpers.ErrorCodes result = McuMgrExceptionHelpers.DeduceErrorCodesFromException(exception); - fatalErrorOccurredAdvertisement( _remoteFilePathSanitized, errorMessage, - result.errorCode, - result.errorGroupCode + McuMgrExceptionHelpers.DeduceGlobalErrorCodeFromException(exception) ); } public void fatalErrorOccurredAdvertisement( final String remoteFilePath, final String errorMessage, - final int mcuMgrErrorCode, // io.runtime.mcumgr.McuMgrErrorCode - final int fsManagerGroupReturnCode // io.runtime.mcumgr.managers.FsManager.ReturnCode + final int globalErrorCode // have a look at EGlobalErrorCode.cs in csharp ) { _lastFatalErrorMessage = errorMessage; //this method is meant to be overridden by csharp binding libraries to intercept updates diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java index 8b0fe611..dc05b20d 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java @@ -1,33 +1,26 @@ package no.laerdal.mcumgr_laerdal_wrapper; +import io.runtime.mcumgr.McuMgrErrorCode; import io.runtime.mcumgr.exception.McuMgrErrorException; import io.runtime.mcumgr.response.HasReturnCode; final class McuMgrExceptionHelpers { - final protected static class ErrorCodes { - public final int errorCode; // typically EMcuMgrErrorCode - public final int errorGroupCode; // typically a *.ReturnCode (like FsManager.ReturnCode or ImageManage.ReturnCode and so on) - - private ErrorCodes(int errorCode, int errorGroupCode) { - this.errorCode = errorCode; - this.errorGroupCode = errorGroupCode; - } - } - - public static ErrorCodes DeduceErrorCodesFromException(Exception exception) { + // this method must be kept aligned between our ios lib and our android lib + public static int DeduceGlobalErrorCodeFromException(Exception exception) { if (!(exception instanceof McuMgrErrorException)) - return new ErrorCodes(-99, -99); + return -99; McuMgrErrorException mcuMgrErrorException = (McuMgrErrorException) exception; - HasReturnCode.GroupReturnCode groupReturnCode = mcuMgrErrorException.getGroupCode(); - - int errorCode = mcuMgrErrorException.getCode().value(); - - int errorGroupCode = groupReturnCode != null - ? groupReturnCode.rc - : -99; - - return new ErrorCodes(errorCode, errorGroupCode); + HasReturnCode.GroupReturnCode groupReturnCodeSpecs = mcuMgrErrorException.getGroupCode(); + return groupReturnCodeSpecs == null + ? mcuMgrErrorException.getCode().value() // 00 + : ((groupReturnCodeSpecs.group + 1) * 1000) + groupReturnCodeSpecs.rc; // 10 + + //00 for auth errors and for nordic devices that do not support smp v2 these error codes occupy the range [0,999] + // + //10 for more evolved errors on nordic devices that do support smp v2 these error codes get mapped to values 1000+ + // + // in this way all error codes get mapped to a single human-readable enum in csharp called EGlobalErrorCode } } \ No newline at end of file diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS.xcodeproj/project.pbxproj b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS.xcodeproj/project.pbxproj index a2e44903..6e3607a6 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS.xcodeproj/project.pbxproj +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS.xcodeproj/project.pbxproj @@ -8,13 +8,14 @@ /* Begin PBXBuildFile section */ B028FB802940DF1400CB71EB /* iOSMcuManagerLibrary in Frameworks */ = {isa = PBXBuildFile; productRef = B028FB7F2940DF1400CB71EB /* iOSMcuManagerLibrary */; }; + B0FF8AE92CCFF8E1004B39DE /* IOSListenerForFileUploader.swift in Sources */ = {isa = PBXBuildFile; fileRef = B0FF8AE82CCFF8E1004B39DE /* IOSListenerForFileUploader.swift */; }; E769D0FFF3A39C575B982F6D /* InvalidFirmwareInstallationModeError.swift in Sources */ = {isa = PBXBuildFile; fileRef = E769DB7090742CC7D6AFD01D /* InvalidFirmwareInstallationModeError.swift */; }; E769D1175ADD137DCA6B0207 /* EIOSFirmwareEraserState.swift in Sources */ = {isa = PBXBuildFile; fileRef = E769D3130BA737A0C282D1DD /* EIOSFirmwareEraserState.swift */; }; E769D15459466B0C5BA19E21 /* EIOSFirmwareInstallationVerdict.swift in Sources */ = {isa = PBXBuildFile; fileRef = E769D1DEDAD5F89C361DF28C /* EIOSFirmwareInstallationVerdict.swift */; }; E769D165ADFDDBED8F709DAE /* EIOSFirmwareInstallationMode.swift in Sources */ = {isa = PBXBuildFile; fileRef = E769DC8A37490B096716C6B8 /* EIOSFirmwareInstallationMode.swift */; }; E769D26DF00FF487503F9A77 /* McuMgrBindingsiOS.h in Headers */ = {isa = PBXBuildFile; fileRef = E769DC768A6D6F0D1CAC3C06 /* McuMgrBindingsiOS.h */; settings = {ATTRIBUTES = (Public, ); }; }; E769D33171D78172F096C8A4 /* EIOSFileDownloaderState.swift in Sources */ = {isa = PBXBuildFile; fileRef = E769D3E9D67A36F06CF0EFB4 /* EIOSFileDownloaderState.swift */; }; - E769D339FCECEE79EEDD55C5 /* IOSListenerForFileUploader.swift in Sources */ = {isa = PBXBuildFile; fileRef = E769D8D446B42BE572E246D4 /* IOSListenerForFileUploader.swift */; }; + E769D339FCECEE79EEDD55C5 /* McuMgrExceptionHelpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = E769D8D446B42BE572E246D4 /* McuMgrExceptionHelpers.swift */; }; E769D36EAF2DD40E0A892DB2 /* DummyPlaceholder.swift in Sources */ = {isa = PBXBuildFile; fileRef = E769DC33E51C5D88437572EB /* DummyPlaceholder.swift */; }; E769D37F2EF53CC9C5858BED /* IOSListenerForFirmwareInstaller.swift in Sources */ = {isa = PBXBuildFile; fileRef = E769D13250C8CDA8CA70A8B7 /* IOSListenerForFirmwareInstaller.swift */; }; E769D3F56B12BF1FA2695F1E /* IOSListenerForFileDownloader.swift in Sources */ = {isa = PBXBuildFile; fileRef = E769D19F5EC3404138BFDFF8 /* IOSListenerForFileDownloader.swift */; }; @@ -37,6 +38,7 @@ /* Begin PBXFileReference section */ B0C562262936567900B070BA /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = Platforms/MacOSX.platform/Developer/SDKs/MacOSX13.0.sdk/System/Library/Frameworks/Foundation.framework; sourceTree = DEVELOPER_DIR; }; B0C562282936568800B070BA /* CoreBluetooth.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreBluetooth.framework; path = Platforms/MacOSX.platform/Developer/SDKs/MacOSX13.0.sdk/System/Library/Frameworks/CoreBluetooth.framework; sourceTree = DEVELOPER_DIR; }; + B0FF8AE82CCFF8E1004B39DE /* IOSListenerForFileUploader.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IOSListenerForFileUploader.swift; sourceTree = ""; }; E769D13250C8CDA8CA70A8B7 /* IOSListenerForFirmwareInstaller.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = IOSListenerForFirmwareInstaller.swift; sourceTree = ""; }; E769D19F5EC3404138BFDFF8 /* IOSListenerForFileDownloader.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = IOSListenerForFileDownloader.swift; sourceTree = ""; }; E769D1DEDAD5F89C361DF28C /* EIOSFirmwareInstallationVerdict.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EIOSFirmwareInstallationVerdict.swift; sourceTree = ""; }; @@ -47,7 +49,7 @@ E769D5CB3083656E75BFBC1A /* IOSFirmwareEraser.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = IOSFirmwareEraser.swift; sourceTree = ""; }; E769D797570DEED2DFC21B70 /* EIOSFileUploadingInitializationVerdict.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EIOSFileUploadingInitializationVerdict.swift; sourceTree = ""; }; E769D8C352CB06D01D5C1EC7 /* EIOSFileDownloadingInitializationVerdict.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EIOSFileDownloadingInitializationVerdict.swift; sourceTree = ""; }; - E769D8D446B42BE572E246D4 /* IOSListenerForFileUploader.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = IOSListenerForFileUploader.swift; sourceTree = ""; }; + E769D8D446B42BE572E246D4 /* McuMgrExceptionHelpers.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = McuMgrExceptionHelpers.swift; sourceTree = ""; }; E769D93618819B3E676FE0EA /* IOSListenerForDeviceResetter.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = IOSListenerForDeviceResetter.swift; sourceTree = ""; }; E769D97697BB244952CDDF0E /* McuMgrBindingsiOS.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = McuMgrBindingsiOS.framework; sourceTree = BUILT_PRODUCTS_DIR; }; E769D9B93897FF4C9ABBAF94 /* IOSFileDownloader.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = IOSFileDownloader.swift; sourceTree = ""; }; @@ -113,12 +115,13 @@ E769D9D0270D6C4E5DF8E7CE /* EIOSFileUploaderState.swift */, E769D417A16B8DCE9D59165A /* IOSFileUploader.swift */, E769D797570DEED2DFC21B70 /* EIOSFileUploadingInitializationVerdict.swift */, - E769D8D446B42BE572E246D4 /* IOSListenerForFileUploader.swift */, + E769D8D446B42BE572E246D4 /* McuMgrExceptionHelpers.swift */, E769D9B93897FF4C9ABBAF94 /* IOSFileDownloader.swift */, E769D3E9D67A36F06CF0EFB4 /* EIOSFileDownloaderState.swift */, E769D19F5EC3404138BFDFF8 /* IOSListenerForFileDownloader.swift */, E769D8C352CB06D01D5C1EC7 /* EIOSFileDownloadingInitializationVerdict.swift */, E769DD92BBBF9A69EAF334F4 /* EIOSFirmwareInstallationFatalError.swift */, + B0FF8AE82CCFF8E1004B39DE /* IOSListenerForFileUploader.swift */, ); path = McuMgrBindingsiOS; sourceTree = ""; @@ -236,8 +239,9 @@ E769D8E49B6F52BD0065A849 /* EIOSFileUploaderState.swift in Sources */, E769DA011D5897CB39E02602 /* IOSFileUploader.swift in Sources */, E769DEB3EFF58D41D88197C4 /* EIOSFileUploadingInitializationVerdict.swift in Sources */, - E769D339FCECEE79EEDD55C5 /* IOSListenerForFileUploader.swift in Sources */, + E769D339FCECEE79EEDD55C5 /* McuMgrExceptionHelpers.swift in Sources */, E769D7F106E9BC190CDFFD19 /* IOSFileDownloader.swift in Sources */, + B0FF8AE92CCFF8E1004B39DE /* IOSListenerForFileUploader.swift in Sources */, E769D33171D78172F096C8A4 /* EIOSFileDownloaderState.swift in Sources */, E769D3F56B12BF1FA2695F1E /* IOSListenerForFileDownloader.swift in Sources */, E769D54A54C788CCE8488B9B /* EIOSFileDownloadingInitializationVerdict.swift in Sources */, diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift index 1c459ac7..a08bab71 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift @@ -183,57 +183,15 @@ public class IOSFileDownloader: NSObject { private func onError(_ errorMessage: String, _ error: Error? = nil) { setState(.error) //keep first - // todo use this technique instead of string sniffing - // here mcuMgrError is of type McuMgrError which can be either case returnCode or case groupCode } - // if let mcuMgrError = error as? McuMgrError { //todo https://github.com/NordicSemiconductor/IOS-nRF-Connect-Device-Manager/issues/198 - // mcuMgrError. - // } - _lastFatalErrorMessage = errorMessage - let (errorCode, _) = deduceErrorCode(errorMessage) - _listener.fatalErrorOccurredAdvertisement( _remoteFilePathSanitized, errorMessage, - errorCode + McuMgrExceptionHelpers.deduceGlobalErrorCodeFromException(error) ) } - // unfortunately I couldnt figure out a way to deduce the error code from the error itself so I had to resort to string sniffing ugly but it works - private func deduceErrorCode(_ errorMessage: String) -> (Int, String?) { - let (matchesArray, possibleError) = matches(for: " [(]\\d+[)][.]?$", in: errorMessage) // "UNKNOWN (1)." - if possibleError != nil { - return (-99, possibleError) - } - - let errorCode = matchesArray.isEmpty - ? -99 - : (Int(matchesArray[0].trimmingCharacters(in: .whitespaces).trimmingCharacters(in: ["(", ")", "."]).trimmingCharacters(in: .whitespaces)) ?? 0) - - return (errorCode, possibleError) - } - - private func matches(for regex: String, in text: String) -> ([String], String?) { //00 - do { - let regex = try NSRegularExpression(pattern: regex) - let results = regex.matches(in: text, range: NSRange(text.startIndex..., in: text)) - - return ( - results.map { - String(text[Range($0.range, in: text)!]) - }, - nil - ) - } catch let error { - print("invalid regex: \(error.localizedDescription)") - - return ([], error.localizedDescription) - } - - //00 https://stackoverflow.com/a/27880748/863651 - } - //@objc dont private func logMessageAdvertisement(_ message: String, _ category: String, _ level: String) { _listener.logMessageAdvertisement(message, category, level, _remoteFilePathSanitized) diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift index d748c370..fc10cb33 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift @@ -85,7 +85,7 @@ public class IOSFileUploader: NSObject { } if !_remoteFilePathSanitized.hasPrefix("/") { - onError("Target-path is not absolute!") + onError("Target-path is not absolute") return .failedInvalidSettings } @@ -181,7 +181,7 @@ public class IOSFileUploader: NSObject { } @objc - public func cancel(_ reason: String) { + public func cancel(_ reason: String = "") { _cancellationReason = reason cancellingAdvertisement(reason) @@ -248,55 +248,15 @@ public class IOSFileUploader: NSObject { private func onError(_ errorMessage: String, _ error: Error? = nil) { setState(.error) //keep first - // todo use this technique instead of string sniffing - // here mcuMgrError is of type McuMgrError which can be either case returnCode or case groupCode } - // if let mcuMgrError = error as? McuMgrError { //todo https://github.com/NordicSemiconductor/IOS-nRF-Connect-Device-Manager/issues/198 - // mcuMgrError. - // } - _lastFatalErrorMessage = errorMessage - let (errorCode, _) = deduceErrorCode(errorMessage) - _listener.fatalErrorOccurredAdvertisement( _remoteFilePathSanitized, errorMessage, - errorCode + McuMgrExceptionHelpers.deduceGlobalErrorCodeFromException(error) ) } - // unfortunately I couldnt figure out a way to deduce the error code from the error itself so I had to resort to string sniffing ugly but it works - private func deduceErrorCode(_ errorMessage: String) -> (Int, String?) { - let (matchesArray, possibleError) = matches(for: " [(]\\d+[)][.]?$", in: errorMessage) // "UNKNOWN (1)." - if possibleError != nil { - return (-99, possibleError) - } - - let errorCode = matchesArray.isEmpty - ? -99 - : (Int(matchesArray[0].trimmingCharacters(in: .whitespaces).trimmingCharacters(in: [ "(", ")", "." ]).trimmingCharacters(in: .whitespaces)) ?? 0) - - return (errorCode, possibleError) - } - - private func matches(for regex: String, in text: String) -> ([String], String?) { //00 - do { - let regex = try NSRegularExpression(pattern: regex) - let results = regex.matches(in: text, range: NSRange(text.startIndex..., in: text)) - - return ( - results.map { String(text[Range($0.range, in: text)!]) }, - nil - ) - } catch let error { - print("invalid regex: \(error.localizedDescription)") - - return ([], error.localizedDescription) - } - - //00 https://stackoverflow.com/a/27880748/863651 - } - //@objc dont private func logMessageAdvertisement(_ message: String, _ category: String, _ level: String) { _listener.logMessageAdvertisement(message, category, level, _remoteFilePathSanitized) diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileDownloader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileDownloader.swift index 0275d8e9..c65efe14 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileDownloader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileDownloader.swift @@ -3,7 +3,7 @@ import Foundation @objc public protocol IOSListenerForFileDownloader { func logMessageAdvertisement(_ message: String, _ category: String, _ level: String, _ resource: String) - func fatalErrorOccurredAdvertisement(_ resource: String, _ errorMessage: String, _ errorCode: Int) + func fatalErrorOccurredAdvertisement(_ resource: String, _ errorMessage: String, _ globalErrorCode: Int) func cancelledAdvertisement() diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileUploader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileUploader.swift index eb126d38..698c60fe 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileUploader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFileUploader.swift @@ -3,7 +3,7 @@ import Foundation @objc public protocol IOSListenerForFileUploader { func logMessageAdvertisement(_ message: String, _ category: String, _ level: String, _ resource: String) - func fatalErrorOccurredAdvertisement(_ resource: String, _ errorMessage: String, _ errorCode: Int) + func fatalErrorOccurredAdvertisement(_ resource: String, _ errorMessage: String, _ globalErrorCode: Int) func cancelledAdvertisement(_ reason: String) func cancellingAdvertisement(_ reason: String) @@ -13,3 +13,4 @@ public protocol IOSListenerForFileUploader { func busyStateChangedAdvertisement(_ busyNotIdle: Bool) func fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(_ progressPercentage: Int, _ averageThroughput: Float32) } + diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/McuMgrExceptionHelpers.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/McuMgrExceptionHelpers.swift new file mode 100644 index 00000000..a40af5ea --- /dev/null +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/McuMgrExceptionHelpers.swift @@ -0,0 +1,28 @@ +import Foundation +import iOSMcuManagerLibrary + +internal class McuMgrExceptionHelpers { + static func deduceGlobalErrorCodeFromException(_ error: Error? = nil) -> Int { //00 + guard let mcuMgrError = error as? McuMgrError else { + return -99 + } + + var errorCode = -99 + var groupErrorCode = -99 + var groupSubsystemId = 0 + + switch mcuMgrError { + case .returnCode(let rc): //if smp v2 is not supported by the target device (rare these days) + errorCode = Int(rc.rawValue) + case .groupCode(let groupCode): //if smp v2 is supported by the target device + groupErrorCode = Int(groupCode.rc.rawValue) + groupSubsystemId = Int(groupCode.group) + } + + return groupSubsystemId == 0 + ? errorCode + : ((groupSubsystemId + 1) * 1000 + groupErrorCode); + + //00 https://github.com/NordicSemiconductor/IOS-nRF-Connect-Device-Manager/issues/198 + } +} \ No newline at end of file diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index 7816e0ee..25a8aeb7 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.MultipleFilesDownloadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -109,28 +109,28 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? if (remoteFilePathUppercase.Contains("some/file/that/exist/but/is/erroring/out/when/we/try/to/download/it.bin".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, oldState: EFileDownloaderState.Downloading, newState: EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "foobar", EMcuMgrErrorCode.Unknown, EFileOperationGroupErrorCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "foobar", EGlobalErrorCode.Unset); } else if (remoteFilePathUppercase.Contains("some/file/that/doesnt/exist.bin".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, oldState: EFileDownloaderState.Downloading, newState: EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "IN VALUE (3)", EMcuMgrErrorCode.Ok, EFileOperationGroupErrorCode.NotFound); + FatalErrorOccurredAdvertisement(remoteFilePath, "IN VALUE (3)", EGlobalErrorCode.SubSystemFilesystem_NotFound); } else if (remoteFilePathUppercase.Contains("some/file/that/exist/and/completes/after/a/couple/of/attempts.bin".ToUpperInvariant()) && _retryCountForProblematicFile++ < 3) { StateChangedAdvertisement(remoteFilePath, oldState: EFileDownloaderState.Downloading, newState: EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "ping pong", EMcuMgrErrorCode.Unknown, EFileOperationGroupErrorCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "ping pong", EGlobalErrorCode.McuMgrErrorBeforeSmpV2_Corrupt); } else if (remoteFilePathUppercase.Contains("some/file/path/pointing/to/a/directory".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, oldState: EFileDownloaderState.Downloading, newState: EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "BLAH BLAH (4)", EMcuMgrErrorCode.Ok, EFileOperationGroupErrorCode.IsDirectory); + FatalErrorOccurredAdvertisement(remoteFilePath, "BLAH BLAH (4)", EGlobalErrorCode.SubSystemFilesystem_IsDirectory); } else { _expectedResults.TryGetValue(remoteFilePath, out var expectedFileContent); - + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Complete); // order DownloadCompletedAdvertisement(remoteFilePath, expectedFileContent); // order } diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index e3797d2d..38a1d9e3 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -130,16 +130,16 @@ public override EFileDownloaderVerdict BeginDownload( if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.BleConnectionFailsafeSettings.ForDownloading.InitialMtuSize) { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForDownloading.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Unknown, EFileOperationGroupErrorCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EGlobalErrorCode.Generic); // order return; } if (_tryCounter < _maxTriesCount) { await Task.Delay(20); - StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Unknown, EFileOperationGroupErrorCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EGlobalErrorCode.Generic); // order return; } diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index f14796d4..6abece2b 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -107,7 +107,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? if (_tryCount < _maxNumberOfTriesForSuccess) { StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Unknown, EFileOperationGroupErrorCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EGlobalErrorCode.McuMgrErrorBeforeSmpV2_Corrupt); return; } diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs index bf1cd460..1139edb6 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenFatalErrorMidflight.cs @@ -92,7 +92,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? await Task.Delay(2_000); StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.BadState, EFileOperationGroupErrorCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EGlobalErrorCode.Generic); }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs index 3acf89c2..2f33cb71 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowAllDownloadAttemptsFailedException_GivenRogueNativeErrorMessage.cs @@ -27,7 +27,7 @@ public async Task SingleFileDownloadAsync_ShouldThrowAllDownloadAttemptsFailedEx var mockedNativeFileDownloaderProxy = new MockedErroneousNativeFileDownloaderProxySpy13( mockedFileData: mockedFileData, downloaderCallbacksProxy: new GenericNativeFileDownloaderCallbacksProxy_(), - nativeErrorMessageForFileNotFound: nativeRogueErrorMessage + rogueNativeErrorMessage: nativeRogueErrorMessage ); var fileDownloader = new McuMgr.FileDownloader.FileDownloader(mockedNativeFileDownloaderProxy); @@ -79,12 +79,12 @@ await work.Should() private class MockedErroneousNativeFileDownloaderProxySpy13 : MockedNativeFileDownloaderProxySpy { - private readonly string _nativeErrorMessageForFileNotFound; + private readonly string _rogueNativeErrorMessage; - public MockedErroneousNativeFileDownloaderProxySpy13(INativeFileDownloaderCallbacksProxy downloaderCallbacksProxy, byte[] mockedFileData, string nativeErrorMessageForFileNotFound) : base(downloaderCallbacksProxy) + public MockedErroneousNativeFileDownloaderProxySpy13(INativeFileDownloaderCallbacksProxy downloaderCallbacksProxy, byte[] mockedFileData, string rogueNativeErrorMessage) : base(downloaderCallbacksProxy) { _ = mockedFileData; - _nativeErrorMessageForFileNotFound = nativeErrorMessageForFileNotFound; + _rogueNativeErrorMessage = rogueNativeErrorMessage; } public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) @@ -103,7 +103,7 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? await Task.Delay(100); StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.Unknown, EFileOperationGroupErrorCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, _rogueNativeErrorMessage, EGlobalErrorCode.Generic); }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs index fb7b531d..1eb9e6b4 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.SingleFileDownloadAsync.ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath.cs @@ -16,11 +16,11 @@ namespace Laerdal.McuMgr.Tests.FileDownloader public partial class FileDownloaderTestbed { [Theory] - [InlineData("FDT.SFDA.STRFNFE.GNEF.010", "NO ENTRY (5)", 1)] //android - [InlineData("FDT.SFDA.STRFNFE.GNEF.020", "NO ENTRY (5)", 2)] //android - [InlineData("FDT.SFDA.STRFNFE.GNEF.030", "NO ENTRY (5)", 3)] //android - [InlineData("FDT.SFDA.STRFNFE.GNEF.040", "NO_ENTRY (5)", 2)] //ios - public async Task SingleFileDownloadAsync_ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath(string testcaseNickname, string nativeErrorMessageForFileNotFound, int maxTriesCount) + [InlineData("FDT.SFDA.STRFNFE.GNEF.010", 1)] //android + [InlineData("FDT.SFDA.STRFNFE.GNEF.020", 2)] //android + [InlineData("FDT.SFDA.STRFNFE.GNEF.030", 3)] //android + [InlineData("FDT.SFDA.STRFNFE.GNEF.040", 2)] //ios + public async Task SingleFileDownloadAsync_ShouldThrowRemoteFileNotFoundException_GivenNonExistentFilepath(string testcaseNickname, int maxTriesCount) { // Arrange var mockedFileData = new byte[] { 1, 2, 3 }; @@ -28,8 +28,7 @@ public async Task SingleFileDownloadAsync_ShouldThrowRemoteFileNotFoundException var mockedNativeFileDownloaderProxy = new MockedErroneousNativeFileDownloaderProxySpy2( mockedFileData: mockedFileData, - downloaderCallbacksProxy: new GenericNativeFileDownloaderCallbacksProxy_(), - nativeErrorMessageForFileNotFound: nativeErrorMessageForFileNotFound + downloaderCallbacksProxy: new GenericNativeFileDownloaderCallbacksProxy_() ); var fileDownloader = new McuMgr.FileDownloader.FileDownloader(mockedNativeFileDownloaderProxy); @@ -65,7 +64,7 @@ await work.Should() eventsMonitor .Should().Raise(nameof(fileDownloader.FatalErrorOccurred)) .WithSender(fileDownloader) - .WithArgs(args => args.ErrorMessage.ToUpperInvariant().Contains(nativeErrorMessageForFileNotFound.ToUpperInvariant())); + .WithArgs(args => args.GlobalErrorCode == EGlobalErrorCode.SubSystemFilesystem_NotFound); eventsMonitor .Should().Raise(nameof(fileDownloader.StateChanged)) @@ -82,12 +81,9 @@ await work.Should() private class MockedErroneousNativeFileDownloaderProxySpy2 : MockedNativeFileDownloaderProxySpy { - private readonly string _nativeErrorMessageForFileNotFound; - - public MockedErroneousNativeFileDownloaderProxySpy2(INativeFileDownloaderCallbacksProxy downloaderCallbacksProxy, byte[] mockedFileData, string nativeErrorMessageForFileNotFound) : base(downloaderCallbacksProxy) + public MockedErroneousNativeFileDownloaderProxySpy2(INativeFileDownloaderCallbacksProxy downloaderCallbacksProxy, byte[] mockedFileData) : base(downloaderCallbacksProxy) { _ = mockedFileData; - _nativeErrorMessageForFileNotFound = nativeErrorMessageForFileNotFound; } public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? initialMtuSize = null) @@ -105,8 +101,8 @@ public override EFileDownloaderVerdict BeginDownload(string remoteFilePath, int? await Task.Delay(100); - StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order simulates how the native code behaves - FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.Ok, EFileOperationGroupErrorCode.NotFound); // order simulates how the csharp wrapper behaves + StateChangedAdvertisement(remoteFilePath, EFileDownloaderState.Downloading, EFileDownloaderState.Error); // order simulates how the native code behaves + FatalErrorOccurredAdvertisement(remoteFilePath, "foobar", EGlobalErrorCode.SubSystemFilesystem_NotFound); // order simulates how the csharp wrapper behaves }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs index ae6642ae..9e7a2c08 100644 --- a/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs +++ b/Laerdal.McuMgr.Tests/FileDownloader/FileDownloaderTestbed.cs @@ -64,8 +64,8 @@ public void BusyStateChangedAdvertisement(bool busyNotIdle) public void DownloadCompletedAdvertisement(string resource, byte[] data) => _downloaderCallbacksProxy.DownloadCompletedAdvertisement(resource, data); //raises the actual event - public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileOperationGroupReturnCode) - => _downloaderCallbacksProxy.FatalErrorOccurredAdvertisement(resource, errorMessage, mcuMgrErrorCode, fileOperationGroupReturnCode); //raises the actual event + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EGlobalErrorCode globalErrorCode) + => _downloaderCallbacksProxy.FatalErrorOccurredAdvertisement(resource, errorMessage, globalErrorCode); //raises the actual event public void FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput) => _downloaderCallbacksProxy.FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage, averageThroughput); //raises the actual event diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs index 6180345a..19852ec0 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.MultipleFilesUploadAsync.ShouldCompleteSuccessfully_GivenVariousFilesToDownload.cs @@ -116,18 +116,18 @@ public override EFileUploaderVerdict BeginUpload( if (remoteFilePathUppercase.Contains("some/file/to/a/folder/that/doesnt/exist.bin".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "FOOBAR (3)", EMcuMgrErrorCode.Ok, EFileOperationGroupErrorCode.NotFound); + FatalErrorOccurredAdvertisement(remoteFilePath, "FOOBAR (3)", EGlobalErrorCode.SubSystemFilesystem_NotFound); } else if (remoteFilePathUppercase.Contains("some/file/that/succeeds/after/a/couple/of/attempts.bin".ToUpperInvariant()) && _retryCountForProblematicFile++ < 3) { StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "ping pong", EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "ping pong", EGlobalErrorCode.Generic); } else if (remoteFilePathUppercase.Contains("some/file/that/is/erroring/out/when/we/try/to/upload/it.bin".ToUpperInvariant())) { StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "native symbols not loaded blah blah", EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "native symbols not loaded blah blah", EGlobalErrorCode.Generic); } else { diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs index bc3eef25..ead65911 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfullyByFallingBackToFailsafeSettings_GivenFlakyConnection.cs @@ -139,48 +139,48 @@ public override EFileUploaderVerdict BeginUpload( if (_tryCounter == _maxTriesCount && initialMtuSize != AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize) { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EGlobalErrorCode.Generic); // order return; } if (_tryCounter == _maxTriesCount && windowCapacity != AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity) { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EGlobalErrorCode.Generic); // order return; } if (_tryCounter == _maxTriesCount && memoryAlignment != AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment) { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EGlobalErrorCode.Generic); // order return; } if (_tryCounter == _maxTriesCount && pipelineDepth != AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth) { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EGlobalErrorCode.Generic); // order return; } if (_tryCounter == _maxTriesCount && byteAlignment != AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment) { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, BugDetected, EGlobalErrorCode.Generic); // order return; } if (_tryCounter < _maxTriesCount) { await Task.Delay(20); - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Generic, EFileOperationGroupErrorCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EGlobalErrorCode.Generic); // order return; } diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs index 9c19d67f..a478b6b8 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenNativeFileDownloader.cs @@ -123,7 +123,7 @@ public override EFileUploaderVerdict BeginUpload( if (_tryCount < _maxNumberOfTriesForSuccess) { StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileOperationGroupErrorCode.Unset); + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EGlobalErrorCode.Generic); return; } diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs index 8b52fcdb..7298ef5e 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldCompleteSuccessfully_GivenGreenStream.cs @@ -136,8 +136,8 @@ public override EFileUploaderVerdict BeginUpload( if (_tryCounter < _maxTriesCount) { await Task.Delay(20); - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileOperationGroupErrorCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EGlobalErrorCode.Generic); // order return; } diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs index 5aa30781..eadf067f 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenFatalErrorMidflight.cs @@ -105,8 +105,8 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(2_000); - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EMcuMgrErrorCode.Corrupt, EFileOperationGroupErrorCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "fatal error occurred", EGlobalErrorCode.Generic); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs index fd1e5854..1938baf5 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowAllUploadAttemptsFailedException_GivenRogueNativeErrorMessage.cs @@ -25,7 +25,7 @@ public async Task SingleFileUploadAsync_ShouldThrowAllUploadAttemptsFailedExcept var mockedNativeFileUploaderProxy = new MockedErroneousNativeFileUploaderProxySpy13( uploaderCallbacksProxy: new GenericNativeFileUploaderCallbacksProxy_(), - nativeErrorMessageForFileNotFound: nativeRogueErrorMessage + nativeRogueErrorMessage: nativeRogueErrorMessage ); var fileUploader = new McuMgr.FileUploader.FileUploader(mockedNativeFileUploaderProxy); @@ -78,11 +78,11 @@ await work.Should() private class MockedErroneousNativeFileUploaderProxySpy13 : MockedNativeFileUploaderProxySpy { - private readonly string _nativeErrorMessageForFileNotFound; + private readonly string _nativeRogueErrorMessage; - public MockedErroneousNativeFileUploaderProxySpy13(INativeFileUploaderCallbacksProxy uploaderCallbacksProxy, string nativeErrorMessageForFileNotFound) : base(uploaderCallbacksProxy) + public MockedErroneousNativeFileUploaderProxySpy13(INativeFileUploaderCallbacksProxy uploaderCallbacksProxy, string nativeRogueErrorMessage) : base(uploaderCallbacksProxy) { - _nativeErrorMessageForFileNotFound = nativeErrorMessageForFileNotFound; + _nativeRogueErrorMessage = nativeRogueErrorMessage; } public override EFileUploaderVerdict BeginUpload( @@ -115,8 +115,8 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(100); - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.Corrupt, EFileOperationGroupErrorCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, _nativeRogueErrorMessage, EGlobalErrorCode.Generic); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs index a85a96af..40dd16f0 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowRemoteFolderNotFoundException_GivenNonExistentFilepath.cs @@ -15,12 +15,12 @@ namespace Laerdal.McuMgr.Tests.FileUploader public partial class FileUploaderTestbed { [Theory] - [InlineData("FDT.SFUA.STRFNFE.GNEF.010", EFileOperationGroupErrorCode.NotFound, "UNKNOWN (1)", 1)] //android + ios - [InlineData("FDT.SFUA.STRFNFE.GNEF.020", EFileOperationGroupErrorCode.NotFound, "UNKNOWN (1)", 2)] //android + ios - [InlineData("FDT.SFUA.STRFNFE.GNEF.030", EFileOperationGroupErrorCode.NotFound, "UNKNOWN (1)", 3)] //android + ios + [InlineData("FDT.SFUA.STRFNFE.GNEF.010", EGlobalErrorCode.SubSystemFilesystem_NotFound, "UNKNOWN (1)", 1)] //android + ios + [InlineData("FDT.SFUA.STRFNFE.GNEF.020", EGlobalErrorCode.SubSystemFilesystem_NotFound, "UNKNOWN (1)", 2)] //android + ios + [InlineData("FDT.SFUA.STRFNFE.GNEF.030", EGlobalErrorCode.SubSystemFilesystem_NotFound, "UNKNOWN (1)", 3)] //android + ios public async Task SingleFileUploadAsync_ShouldThrowRemoteFolderNotFoundException_GivenNonExistFolderInPath( string testcaseNickname, - EFileOperationGroupErrorCode fileOperationGroupErrorCode, + EGlobalErrorCode globalErrorCode, string nativeErrorMessageForFileNotFound, int maxTriesCount ) @@ -32,7 +32,7 @@ int maxTriesCount var mockedNativeFileUploaderProxy = new MockedErroneousNativeFileUploaderProxySpy2( mockedFileData: mockedFileData, uploaderCallbacksProxy: new GenericNativeFileUploaderCallbacksProxy_(), - fileOperationGroupErrorCode: fileOperationGroupErrorCode, + globalErrorCode: globalErrorCode, nativeErrorMessageForFileNotFound: nativeErrorMessageForFileNotFound ); var fileUploader = new McuMgr.FileUploader.FileUploader(mockedNativeFileUploaderProxy); @@ -87,18 +87,18 @@ await work.Should() private class MockedErroneousNativeFileUploaderProxySpy2 : MockedNativeFileUploaderProxySpy { - private readonly EFileOperationGroupErrorCode _fileOperationGroupErrorCode; + private readonly EGlobalErrorCode _globalErrorCode; private readonly string _nativeErrorMessageForFileNotFound; public MockedErroneousNativeFileUploaderProxySpy2( INativeFileUploaderCallbacksProxy uploaderCallbacksProxy, byte[] mockedFileData, - EFileOperationGroupErrorCode fileOperationGroupErrorCode, + EGlobalErrorCode globalErrorCode, string nativeErrorMessageForFileNotFound ) : base(uploaderCallbacksProxy) { _ = mockedFileData; - _fileOperationGroupErrorCode = fileOperationGroupErrorCode; + _globalErrorCode = globalErrorCode; _nativeErrorMessageForFileNotFound = nativeErrorMessageForFileNotFound; } @@ -132,8 +132,8 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(100); - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, EMcuMgrErrorCode.Ok, _fileOperationGroupErrorCode); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, _nativeErrorMessageForFileNotFound, _globalErrorCode); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs index c430bd61..6749f619 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.SingleFileUploadAsync.ShouldThrowUnauthorizedErrorException_GivenAccessDeniedNativeErrorMessage.cs @@ -27,7 +27,10 @@ public async Task SingleFileUploadAsync_ShouldThrowUnauthorizedErrorException_Gi )); // Assert - (await work.Should().ThrowExactlyAsync()).WithInnerExceptionExactly(); + (await work.Should().ThrowExactlyAsync()) + .WithInnerExceptionExactly() + .And + .GlobalErrorCode.Should().Be(EGlobalErrorCode.McuMgrErrorBeforeSmpV2_AccessDenied); mockedNativeFileUploaderProxy.CancelCalled.Should().BeFalse(); mockedNativeFileUploaderProxy.DisconnectCalled.Should().BeFalse(); //00 @@ -73,8 +76,8 @@ public override EFileUploaderVerdict BeginUpload( await Task.Delay(100); - StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order - FatalErrorOccurredAdvertisement(remoteFilePath, "blah blah", EMcuMgrErrorCode.AccessDenied, EFileOperationGroupErrorCode.Unset); // order + StateChangedAdvertisement(remoteFilePath, EFileUploaderState.Uploading, EFileUploaderState.Error); // order + FatalErrorOccurredAdvertisement(remoteFilePath, "blah blah", EGlobalErrorCode.McuMgrErrorBeforeSmpV2_AccessDenied); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs index 4354298a..8a4d4e22 100644 --- a/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs +++ b/Laerdal.McuMgr.Tests/FileUploader/FileUploaderTestbed.cs @@ -76,9 +76,8 @@ public void FileUploadedAdvertisement(string resource) public void FatalErrorOccurredAdvertisement( string resource, string errorMessage, - EMcuMgrErrorCode errorCode, - EFileOperationGroupErrorCode fileUploaderGroupReturnCode - ) => _uploaderCallbacksProxy.FatalErrorOccurredAdvertisement(resource, errorMessage, errorCode, fileUploaderGroupReturnCode); //raises the actual event + EGlobalErrorCode globalErrorCode + ) => _uploaderCallbacksProxy.FatalErrorOccurredAdvertisement(resource, errorMessage, globalErrorCode); //raises the actual event public void FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput) => _uploaderCallbacksProxy.FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage, averageThroughput); //raises the actual event diff --git a/Laerdal.McuMgr/Droid/Common/HelpersAndroid.cs b/Laerdal.McuMgr/Droid/Common/HelpersAndroid.cs index 630cc7cd..557bef3b 100644 --- a/Laerdal.McuMgr/Droid/Common/HelpersAndroid.cs +++ b/Laerdal.McuMgr/Droid/Common/HelpersAndroid.cs @@ -7,8 +7,9 @@ static internal class HelpersAndroid { static public ELogLevel TranslateEAndroidLogLevel(string level) => level?.Trim().ToUpperInvariant() switch //derived from sl4j https://www.slf4j.org/api/org/apache/log4j/Level.html { + "TRACE" => ELogLevel.Trace, "DEBUG" => ELogLevel.Debug, - "TRACE" => ELogLevel.Verbose, + "VERBOSE" => ELogLevel.Verbose, "INFO" => ELogLevel.Info, "WARN" => ELogLevel.Warning, "ERROR" => ELogLevel.Error, diff --git a/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs index 70399932..b929d637 100644 --- a/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Droid/FileDownloader/FileDownloader.cs @@ -91,6 +91,7 @@ private void CleanupInfrastructure() } } + #region commands public EFileDownloaderVerdict BeginDownload( @@ -128,20 +129,19 @@ public bool TrySetBluetoothDevice(object bluetoothDevice) #region android callbacks -> csharp event emitters - public override void FatalErrorOccurredAdvertisement(string resource, string errorMessage, int mcuMgrErrorCode, int fileOperationGroupReturnCode) + public override void FatalErrorOccurredAdvertisement(string resource, string errorMessage, int globalErrorCode) { - base.FatalErrorOccurredAdvertisement(resource, errorMessage, mcuMgrErrorCode, fileOperationGroupReturnCode); //just in case + base.FatalErrorOccurredAdvertisement(resource, errorMessage, globalErrorCode); //just in case - FatalErrorOccurredAdvertisement(resource, errorMessage, (EMcuMgrErrorCode) mcuMgrErrorCode, (EFileOperationGroupErrorCode) fileOperationGroupReturnCode); + FatalErrorOccurredAdvertisement(resource, errorMessage, (EGlobalErrorCode) globalErrorCode); } - public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileUploaderGroupErrorCode) + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EGlobalErrorCode globalErrorCode) { _fileDownloaderCallbacksProxy?.FatalErrorOccurredAdvertisement( resource, errorMessage, - mcuMgrErrorCode, - fileUploaderGroupErrorCode + globalErrorCode ); } diff --git a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs index 2173177e..9708e69c 100644 --- a/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Droid/FileUploader/FileUploader.cs @@ -148,21 +148,16 @@ public bool TrySetBluetoothDevice(object bluetoothDevice) #region android callbacks -> csharp event emitters - public override void FatalErrorOccurredAdvertisement(string resource, string errorMessage, int mcuMgrErrorCode, int fileUploaderGroupReturnCode) + public override void FatalErrorOccurredAdvertisement(string resource, string errorMessage, int globalErrorCode) { - base.FatalErrorOccurredAdvertisement(resource, errorMessage, mcuMgrErrorCode, fileUploaderGroupReturnCode); //just in case + base.FatalErrorOccurredAdvertisement(resource, errorMessage, globalErrorCode); //just in case - FatalErrorOccurredAdvertisement(resource, errorMessage, (EMcuMgrErrorCode) mcuMgrErrorCode, (EFileOperationGroupErrorCode) fileUploaderGroupReturnCode); + FatalErrorOccurredAdvertisement(resource, errorMessage, (EGlobalErrorCode) globalErrorCode); } - public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileUploaderGroupErrorCode) + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EGlobalErrorCode globalErrorCode) { - _fileUploaderCallbacksProxy?.FatalErrorOccurredAdvertisement( - resource, - errorMessage, - mcuMgrErrorCode, - fileUploaderGroupErrorCode - ); + _fileUploaderCallbacksProxy?.FatalErrorOccurredAdvertisement(resource, errorMessage, globalErrorCode); } public override void LogMessageAdvertisement(string message, string category, string level, string resource) diff --git a/Laerdal.McuMgr/Shared/Common/Enums/EFileOperationGroupErrorCode.cs b/Laerdal.McuMgr/Shared/Common/Enums/EFileOperationGroupErrorCode.cs deleted file mode 100644 index 44681cf9..00000000 --- a/Laerdal.McuMgr/Shared/Common/Enums/EFileOperationGroupErrorCode.cs +++ /dev/null @@ -1,26 +0,0 @@ -namespace Laerdal.McuMgr.Common.Enums -{ - // values greater than zero must mirror the ones found in - // mcumgr-core/src/main/java/io/runtime/mcumgr/managers/FsManager.java -> enum ReturnCode - public enum EFileOperationGroupErrorCode //@formatter:off - { - Unset = -99, - Ok = 00, - Unknown = 01, - InvalidName = 02, - NotFound = 03, - IsDirectory = 04, - OpenFailed = 05, - SeekFailed = 06, - ReadFailed = 07, - TruncateFailed = 08, - DeleteFailed = 09, - WriteFailed = 10, - OffsetNotValid = 11, - OffsetLargerThanFile = 12, - ChecksumHashNotFound = 13, - MountPointNotFound = 14, - ReadOnlyFilesystem = 15, - FileEmpty = 16, //@formatter:on - } -} diff --git a/Laerdal.McuMgr/Shared/Common/Enums/EGlobalErrorCode.cs b/Laerdal.McuMgr/Shared/Common/Enums/EGlobalErrorCode.cs new file mode 100644 index 00000000..07b0f777 --- /dev/null +++ b/Laerdal.McuMgr/Shared/Common/Enums/EGlobalErrorCode.cs @@ -0,0 +1,109 @@ +namespace Laerdal.McuMgr.Common.Enums +{ + public enum EGlobalErrorCode //@formatter:off https://github.com/NordicSemiconductor/Android-nRF-Connect-Device-Manager/issues/201#issuecomment-2440126159 + { + Unset = -99, //this is our own to mark that we haven't received any error code from the device + Generic = -1, //in case the underlying native code receives an exception other than io.runtime.mcumgr.exception.McuMgrErrorException + + // must mirror mcumgr-core/src/main/java/io/runtime/mcumgr/exception/McuMgrErrorException.java + McuMgrErrorBeforeSmpV2_Ok = 000, + McuMgrErrorBeforeSmpV2_Unknown = 001, //when uploading files to the device this error code means that the target file-path has one or more non-existent directories in it + McuMgrErrorBeforeSmpV2_NoMemory = 002, + McuMgrErrorBeforeSmpV2_InValue = 003, + McuMgrErrorBeforeSmpV2_Timeout = 004, + McuMgrErrorBeforeSmpV2_NoEntry = 005, + McuMgrErrorBeforeSmpV2_BadState = 006, + McuMgrErrorBeforeSmpV2_TooLarge = 007, + McuMgrErrorBeforeSmpV2_NotSupported = 008, + McuMgrErrorBeforeSmpV2_Corrupt = 009, + McuMgrErrorBeforeSmpV2_Busy = 010, + McuMgrErrorBeforeSmpV2_AccessDenied = 011, + McuMgrErrorBeforeSmpV2_ProtocolVersionTooOld = 012, + McuMgrErrorBeforeSmpV2_ProtocolVersionTooNew = 013, + McuMgrErrorBeforeSmpV2_PerUser = 256, + + SubSystemDefault_Ok = 1000, + SubSystemDefault_Unknown = 1001, + SubSystemDefault_InvalidFormat = 1002, + SubSystemDefault_QueryYieldsNoAnswer = 1003, + + SubSystemImage_Ok = 2000, + SubSystemImage_Unknown = 2001, + SubSystemImage_FlashConfigQueryFail = 2002, + SubSystemImage_NoImage = 2003, + SubSystemImage_NoTlvs = 2004, + SubSystemImage_InvalidTlv = 2005, + SubSystemImage_TlvMultipleHashesFound = 2006, + SubSystemImage_TlvInvalidSize = 2007, + SubSystemImage_HashNotFound = 2008, + SubSystemImage_NoFreeSlot = 2009, + SubSystemImage_FlashOpenFailed = 2010, + SubSystemImage_FlashReadFailed = 2011, + SubSystemImage_FlashWriteFailed = 2012, + SubSystemImage_FlashEraseFailed = 2013, + SubSystemImage_InvalidSlot = 2014, + SubSystemImage_NoFreeMemory = 2015, + SubSystemImage_FlashContextAlreadySet = 2016, + SubSystemImage_FlashContextNotSet = 2017, + SubSystemImage_FlashAreaDeviceNull = 2018, + SubSystemImage_InvalidPageOffset = 2019, + SubSystemImage_InvalidOffset = 2020, + SubSystemImage_InvalidLength = 2021, + SubSystemImage_InvalidImageHeader = 2022, + SubSystemImage_InvalidImageHeaderMagic = 2023, + SubSystemImage_InvalidHash = 2024, + SubSystemImage_InvalidFlashAddress = 2025, + SubSystemImage_VersionGetFailed = 2026, + SubSystemImage_CurrentVersionIsNewer = 2027, + SubSystemImage_ImageAlreadyPending = 2028, + SubSystemImage_InvalidImageVectorTable = 2029, + SubSystemImage_InvalidImageTooLarge = 2030, + SubSystemImage_InvalidImageDataOverrun = 2031, + SubSystemImage_ImageConfirmationDenied = 2032, + SubSystemImage_ImageSettingTestToActiveDenied = 2033, + + SubSystemStats_Ok = 3000, + SubSystemStats_Unknown = 3001, + SubSystemStats_InvalidGroupName = 3002, + SubSystemStats_InvalidStatName = 3003, + SubSystemStats_InvalidStatSize = 3004, + SubSystemStats_WalkAborted = 3005, + + SubSystemSettings_Ok = 4000, + SubSystemSettings_Unknown = 4001, + SubSystemSettings_KeyTooLong = 4002, + SubSystemSettings_KeyNotFound = 4003, + SubSystemSettings_ReadNotSupported = 4004, + SubSystemSettings_RootKeyNotFound = 4005, + SubSystemSettings_WriteNotSupported = 4006, + SubSystemSettings_DeleteNotSupported = 4007, + + // int GROUP_LOGS = 4 // these group-ids are specific to nordic and are not supported by zephyr + // int GROUP_CRASH = 5 // so nordic did not migrate these to smp v2 so they do not support + // int GROUP_SPLIT = 6 // group-errors at least not out-of-the-box + // int GROUP_RUN = 7 + + SubSystemFilesystem_Ok = 9000, + SubSystemFilesystem_Unknown = 9001, + SubSystemFilesystem_InvalidName = 9002, + SubSystemFilesystem_NotFound = 9003, + SubSystemFilesystem_IsDirectory = 9004, + SubSystemFilesystem_OpenFailed = 9005, + SubSystemFilesystem_SeekFailed = 9006, + SubSystemFilesystem_ReadFailed = 9007, + SubSystemFilesystem_TruncateFailed = 9008, + SubSystemFilesystem_DeleteFailed = 9009, + SubSystemFilesystem_WriteFailed = 9010, + SubSystemFilesystem_OffsetNotValid = 9011, + SubSystemFilesystem_OffsetLargerThanFile = 9012, + SubSystemFilesystem_ChecksumHashNotFound = 9013, + SubSystemFilesystem_MountPointNotFound = 9014, + SubSystemFilesystem_ReadOnlyFilesystem = 9015, + SubSystemFilesystem_FileEmpty = 9016, + + SubSystemShell_Ok = 10000, + SubSystemShell_Unknown = 10001, + SubSystemShell_CommandTooLong = 10002, + SubSystemShell_EmptyCommand = 10003, + } +} \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/Common/Enums/ELogLevel.cs b/Laerdal.McuMgr/Shared/Common/Enums/ELogLevel.cs index 84d903cd..0efe9ae8 100644 --- a/Laerdal.McuMgr/Shared/Common/Enums/ELogLevel.cs +++ b/Laerdal.McuMgr/Shared/Common/Enums/ELogLevel.cs @@ -2,6 +2,7 @@ namespace Laerdal.McuMgr.Common.Enums { public enum ELogLevel { + Trace = 0, Debug = 0, Verbose = 1, Info = 2, diff --git a/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs b/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs deleted file mode 100644 index be715ac9..00000000 --- a/Laerdal.McuMgr/Shared/Common/Enums/EMcuMgrErrorCode.cs +++ /dev/null @@ -1,24 +0,0 @@ -namespace Laerdal.McuMgr.Common.Enums -{ - // must mirror mcumgr-core/src/main/java/io/runtime/mcumgr/exception/McuMgrErrorException.java - public enum EMcuMgrErrorCode // @formatter:off - { - Unset = -99, //this is our own to mark that we haven't received any error code from the device - Generic = -1, //in case the underlying native code receives an exception other than io.runtime.mcumgr.exception.McuMgrErrorException - Ok = 000, - Unknown = 001, //when uploading files to the device this error code means that the target file-path has one or more non-existent directories in it - NoMemory = 002, - InValue = 003, - Timeout = 004, - NoEntry = 005, - BadState = 006, - TooLarge = 007, - NotSupported = 008, - Corrupt = 009, - Busy = 010, - AccessDenied = 011, - ProtocolVersionTooOld = 012, - ProtocolVersionTooNew = 013, - PerUser = 256, - } // @formatter:on -} diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Events/FatalErrorOccurredEventArgs.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Events/FatalErrorOccurredEventArgs.cs index a8da1068..ee837d74 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Events/FatalErrorOccurredEventArgs.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Events/FatalErrorOccurredEventArgs.cs @@ -11,15 +11,13 @@ namespace Laerdal.McuMgr.FileDownloader.Contracts.Events { public string Resource { get; } public string ErrorMessage { get; } - public EMcuMgrErrorCode McuMgrErrorCode { get; } - public EFileOperationGroupErrorCode FileOperationGroupErrorCode { get; } + public EGlobalErrorCode GlobalErrorCode { get; } - public FatalErrorOccurredEventArgs(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileOperationGroupErrorCode) + public FatalErrorOccurredEventArgs(string resource, string errorMessage, EGlobalErrorCode globalErrorCode) { Resource = resource; ErrorMessage = errorMessage; - McuMgrErrorCode = mcuMgrErrorCode; - FileOperationGroupErrorCode = fileOperationGroupErrorCode; + GlobalErrorCode = globalErrorCode; } } } diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCallbacksProxy.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCallbacksProxy.cs index 045d413b..5dbf04fc 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCallbacksProxy.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Native/INativeFileDownloaderCallbacksProxy.cs @@ -13,7 +13,7 @@ internal interface INativeFileDownloaderCallbacksProxy void StateChangedAdvertisement(string resource, EFileDownloaderState oldState, EFileDownloaderState newState); void BusyStateChangedAdvertisement(bool busyNotIdle); void DownloadCompletedAdvertisement(string resource, byte[] data); - void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileOperationGroupErrorCode); + void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EGlobalErrorCode globalErrorCode); void FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput); } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index 7e95aa4c..9396ab2b 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -396,37 +396,26 @@ void FileDownloader_StateChanged_(object sender_, StateChangedEventArgs ea_) // getting called right above but if that takes too long we give the killing blow by calling OnCancelled() manually here } - void FileDownloader_FileDownloadProgressPercentageAndDataThroughputChanged_(object sender, FileDownloadProgressPercentageAndDataThroughputChangedEventArgs ea) + void FileDownloader_FileDownloadProgressPercentageAndDataThroughputChanged_(object _, FileDownloadProgressPercentageAndDataThroughputChangedEventArgs __) { fileDownloadProgressEventsCount++; } - void FileDownloader_DownloadCompleted_(object sender_, DownloadCompletedEventArgs ea_) + void FileDownloader_DownloadCompleted_(object _, DownloadCompletedEventArgs ea_) { taskCompletionSource.TrySetResult(ea_.Data); } - void FileDownloader_FatalErrorOccurred_(object sender_, FatalErrorOccurredEventArgs ea_) + void FileDownloader_FatalErrorOccurred_(object _, FatalErrorOccurredEventArgs ea_) { - if (ea_ is { McuMgrErrorCode: EMcuMgrErrorCode.AccessDenied }) // unauthorized todo ios passes wrong values here and needs to be fixed + taskCompletionSource.TrySetException(ea_.GlobalErrorCode switch { - taskCompletionSource.TrySetException(new UnauthorizedException(resource: remoteFilePath, nativeErrorMessage: ea_.ErrorMessage)); - return; - } - - if (ea_ is { FileOperationGroupErrorCode: EFileOperationGroupErrorCode.NotFound}) // remote file not found - { - taskCompletionSource.TrySetException(new DownloadErroredOutRemoteFileNotFoundException(remoteFilePath)); - return; - } - - if (ea_ is { FileOperationGroupErrorCode: EFileOperationGroupErrorCode.IsDirectory}) // remote filepath points to a directory - { - taskCompletionSource.TrySetException(new DownloadErroredOutRemotePathPointsToDirectoryException(remoteFilePath)); - return; - } - - taskCompletionSource.TrySetException(new DownloadErroredOutException(remoteFilePath)); + + EGlobalErrorCode.SubSystemFilesystem_NotFound => new DownloadErroredOutRemoteFileNotFoundException(remoteFilePath), // remote file not found + EGlobalErrorCode.SubSystemFilesystem_IsDirectory => new DownloadErroredOutRemotePathPointsToDirectoryException(remoteFilePath), // remote filepath points to a directory + EGlobalErrorCode.McuMgrErrorBeforeSmpV2_AccessDenied => new UnauthorizedException(resource: remoteFilePath, nativeErrorMessage: ea_.ErrorMessage), // unauthorized + _ => new DownloadErroredOutException(remoteFilePath) + }); } } @@ -494,8 +483,8 @@ public void BusyStateChangedAdvertisement(bool busyNotIdle) public void DownloadCompletedAdvertisement(string resource, byte[] data) => FileDownloader?.OnDownloadCompleted(new DownloadCompletedEventArgs(resource, data)); - public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileOperationGroupErrorCode) - => FileDownloader?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs(resource, errorMessage, mcuMgrErrorCode, fileOperationGroupErrorCode)); + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EGlobalErrorCode globalErrorCode) + => FileDownloader?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs(resource, errorMessage, globalErrorCode)); public void FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput) => FileDownloader?.OnFileDownloadProgressPercentageAndDataThroughputChanged(new FileDownloadProgressPercentageAndDataThroughputChangedEventArgs( diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/FatalErrorOccurredEventArgs.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/FatalErrorOccurredEventArgs.cs index a6514d20..0f7c5da9 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/FatalErrorOccurredEventArgs.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Events/FatalErrorOccurredEventArgs.cs @@ -12,15 +12,13 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Events public string ErrorMessage { get; } public string RemoteFilePath { get; } - public EMcuMgrErrorCode ErrorCode { get; } - public EFileOperationGroupErrorCode FileOperationGroupErrorCode { get; } + public EGlobalErrorCode GlobalErrorCode { get; } - public FatalErrorOccurredEventArgs(string remoteFilePath, string errorMessage, EMcuMgrErrorCode errorCode, EFileOperationGroupErrorCode fileOperationGroupErrorCode) + public FatalErrorOccurredEventArgs(string remoteFilePath, string errorMessage, EGlobalErrorCode globalErrorCode) { - ErrorCode = errorCode; ErrorMessage = errorMessage; RemoteFilePath = remoteFilePath; - FileOperationGroupErrorCode = fileOperationGroupErrorCode; + GlobalErrorCode = globalErrorCode; } } } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs index bb64cdd9..2ec8ecc1 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs @@ -8,8 +8,7 @@ public class UploadErroredOutException : Exception, IUploadException { public string RemoteFilePath { get; } - public EMcuMgrErrorCode McuMgrErrorCode { get; } = EMcuMgrErrorCode.Unset; - public EFileOperationGroupErrorCode FileOperationGroupErrorCode { get; } = EFileOperationGroupErrorCode.Unset; + public EGlobalErrorCode GlobalErrorCode { get; } = EGlobalErrorCode.Unset; protected UploadErroredOutException(string remoteFilePath, string errorMessage, Exception innerException = null) : base($"An error occurred while uploading over to '{remoteFilePath}': '{errorMessage}'", innerException) @@ -20,14 +19,12 @@ protected UploadErroredOutException(string remoteFilePath, string errorMessage, public UploadErroredOutException( string nativeErrorMessage, string remoteFilePath, - EMcuMgrErrorCode mcuMgrErrorCode, - EFileOperationGroupErrorCode fileOperationGroupErrorCode, + EGlobalErrorCode globalErrorCode, Exception innerException = null - ) : base($"An error occurred while uploading '{remoteFilePath}': '{nativeErrorMessage}' (mcuMgrErrorCode={mcuMgrErrorCode}, groupReturnCode={fileOperationGroupErrorCode})", innerException) + ) : base($"An error occurred while uploading '{remoteFilePath}': '{nativeErrorMessage}' (globalErrorCode={globalErrorCode})", innerException) { RemoteFilePath = remoteFilePath; - McuMgrErrorCode = mcuMgrErrorCode; - FileOperationGroupErrorCode = fileOperationGroupErrorCode; + GlobalErrorCode = globalErrorCode; } } } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutRemoteFolderNotFoundException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutRemoteFolderNotFoundException.cs index 94df0b92..ded82ec7 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutRemoteFolderNotFoundException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutRemoteFolderNotFoundException.cs @@ -10,13 +10,11 @@ public sealed class UploadErroredOutRemoteFolderNotFoundException : UploadErrore public UploadErroredOutRemoteFolderNotFoundException( string nativeErrorMessage, string remoteFilePath, - EMcuMgrErrorCode mcuMgrErrorCode, - EFileOperationGroupErrorCode fileOperationGroupErrorCode + EGlobalErrorCode globalErrorCode ) : base( - nativeErrorMessage: nativeErrorMessage, remoteFilePath: remoteFilePath, - mcuMgrErrorCode: mcuMgrErrorCode, - fileOperationGroupErrorCode: fileOperationGroupErrorCode + globalErrorCode: globalErrorCode, + nativeErrorMessage: nativeErrorMessage ) { } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs index 92c36c11..313f84ab 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs @@ -7,16 +7,13 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Exceptions public class UploadUnauthorizedException : UploadErroredOutException, IMcuMgrException { public string RemoteFilePath { get; } - - public EMcuMgrErrorCode McuMgrErrorCode { get; } - public EFileOperationGroupErrorCode FileOperationGroupErrorCode { get; } + public EGlobalErrorCode GlobalErrorCode { get; } - public UploadUnauthorizedException(string nativeErrorMessage, string remoteFilePath, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileOperationGroupErrorCode) - : base(remoteFilePath, $"{nativeErrorMessage} (McuMgrErrorCode={mcuMgrErrorCode}, GroupReturnCode={fileOperationGroupErrorCode})") + public UploadUnauthorizedException(string nativeErrorMessage, string remoteFilePath, EGlobalErrorCode globalErrorCode) + : base(remoteFilePath, $"{nativeErrorMessage} (globalErrorCode={globalErrorCode})") { RemoteFilePath = remoteFilePath; - McuMgrErrorCode = mcuMgrErrorCode; - FileOperationGroupErrorCode = fileOperationGroupErrorCode; + GlobalErrorCode = globalErrorCode; } } } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs index 4216ecf1..96e286ad 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Native/INativeFileUploaderCallbacksProxy.cs @@ -14,7 +14,7 @@ internal interface INativeFileUploaderCallbacksProxy void StateChangedAdvertisement(string resource, EFileUploaderState oldState, EFileUploaderState newState); void BusyStateChangedAdvertisement(bool busyNotIdle); void FileUploadedAdvertisement(string resource); - void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileUploaderGroupErrorCode); + void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EGlobalErrorCode globalErrorCode); void FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput); } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index f2db168a..a6891eea 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -471,41 +471,19 @@ void FileUploader_StateChanged_(object _, StateChangedEventArgs ea_) // ReSharpe } } // ReSharper restore AccessToModifiedClosure - void FileUploader_FileUploadProgressPercentageAndDataThroughputChanged_(object _, FileUploadProgressPercentageAndDataThroughputChangedEventArgs ea_) + void FileUploader_FileUploadProgressPercentageAndDataThroughputChanged_(object _, FileUploadProgressPercentageAndDataThroughputChangedEventArgs __) { fileUploadProgressEventsCount++; } void FileUploader_FatalErrorOccurred_(object _, FatalErrorOccurredEventArgs ea_) { - if (ea_.ErrorCode == EMcuMgrErrorCode.AccessDenied) //todo ios is broken and needs to be fixed + taskCompletionSource.TrySetException(ea_.GlobalErrorCode switch { - taskCompletionSource.TrySetException(new UploadUnauthorizedException( - remoteFilePath: remoteFilePath, - mcuMgrErrorCode: ea_.ErrorCode, - nativeErrorMessage: ea_.ErrorMessage, - fileOperationGroupErrorCode: ea_.FileOperationGroupErrorCode - )); - return; - } - - if (ea_.FileOperationGroupErrorCode == EFileOperationGroupErrorCode.NotFound) - { - taskCompletionSource.TrySetException(new UploadErroredOutRemoteFolderNotFoundException( - remoteFilePath: remoteFilePath, - mcuMgrErrorCode: ea_.ErrorCode, - nativeErrorMessage: ea_.ErrorMessage, - fileOperationGroupErrorCode: ea_.FileOperationGroupErrorCode - )); - return; - } - - taskCompletionSource.TrySetException(new UploadErroredOutException( - remoteFilePath: remoteFilePath, - mcuMgrErrorCode: ea_.ErrorCode, - nativeErrorMessage: ea_.ErrorMessage, - fileOperationGroupErrorCode: ea_.FileOperationGroupErrorCode - )); + EGlobalErrorCode.SubSystemFilesystem_NotFound => new UploadErroredOutRemoteFolderNotFoundException(remoteFilePath: remoteFilePath, globalErrorCode: ea_.GlobalErrorCode, nativeErrorMessage: ea_.ErrorMessage), + EGlobalErrorCode.McuMgrErrorBeforeSmpV2_AccessDenied => new UploadUnauthorizedException(remoteFilePath: remoteFilePath, globalErrorCode: ea_.GlobalErrorCode, nativeErrorMessage: ea_.ErrorMessage), + _ => new UploadErroredOutException(remoteFilePath: remoteFilePath, globalErrorCode: ea_.GlobalErrorCode, nativeErrorMessage: ea_.ErrorMessage) + }); } } @@ -594,13 +572,11 @@ public void FileUploadedAdvertisement(string resource) public void FatalErrorOccurredAdvertisement( string resource, string errorMessage, - EMcuMgrErrorCode mcuMgrErrorCode, - EFileOperationGroupErrorCode fileUploaderGroupErrorCode + EGlobalErrorCode globalErrorCode ) => FileUploader?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs( resource, errorMessage, - mcuMgrErrorCode, - fileUploaderGroupErrorCode + globalErrorCode )); public void FileUploadProgressPercentageAndDataThroughputChangedAdvertisement( diff --git a/Laerdal.McuMgr/iOS/Common/HelpersIOS.cs b/Laerdal.McuMgr/iOS/Common/HelpersIOS.cs index 57d83fc5..a2a15e10 100644 --- a/Laerdal.McuMgr/iOS/Common/HelpersIOS.cs +++ b/Laerdal.McuMgr/iOS/Common/HelpersIOS.cs @@ -7,12 +7,15 @@ static internal class HelpersIOS { static internal ELogLevel TranslateEIOSLogLevel(string level) => level?.Trim().ToUpperInvariant() switch { - "D" => ELogLevel.Debug, - "V" => ELogLevel.Verbose, - "I" => ELogLevel.Info, - "A" => ELogLevel.Info, //application - "W" => ELogLevel.Warning, - "E" => ELogLevel.Error, + "T" or "TRACE" => ELogLevel.Trace, + "D" or "DEBUG" => ELogLevel.Debug, + "V" or "VERBOSE" => ELogLevel.Verbose, + "I" or "INFO" => ELogLevel.Info, + "N" or "NOTICE" => ELogLevel.Info, + "A" or "APPLICATION" => ELogLevel.Info, //application + "W" or "WARN" => ELogLevel.Warning, + "E" or "ERROR" => ELogLevel.Error, + "C" or "CRITICAL" => ELogLevel.Error, _ => throw new ArgumentOutOfRangeException(nameof(level), level, "Unknown log-level value") }; } diff --git a/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs index 47291f77..ffdcdfc6 100644 --- a/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/iOS/FileDownloader/FileDownloader.cs @@ -177,16 +177,15 @@ public void DownloadCompletedAdvertisement(string resource, byte[] data) //confo public override void FatalErrorOccurredAdvertisement( string resource, string errorMessage, - nint mcuMgrErrorCode + nint globalErrorCode ) => FatalErrorOccurredAdvertisement( resource, errorMessage, - (EMcuMgrErrorCode)(int)mcuMgrErrorCode, - EFileOperationGroupErrorCode.Unset + (EGlobalErrorCode)(int)globalErrorCode ); - - public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EMcuMgrErrorCode mcuMgrErrorCode, EFileOperationGroupErrorCode fileOperationGroupReturnCode) - => _nativeFileDownloaderCallbacksProxy?.FatalErrorOccurredAdvertisement(resource, errorMessage, mcuMgrErrorCode, fileOperationGroupReturnCode); + + public void FatalErrorOccurredAdvertisement(string resource, string errorMessage, EGlobalErrorCode globalErrorCode) + => _nativeFileDownloaderCallbacksProxy?.FatalErrorOccurredAdvertisement(resource, errorMessage, globalErrorCode); public override void FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(nint progressPercentage, float averageThroughput) => FileDownloadProgressPercentageAndDataThroughputChangedAdvertisement( diff --git a/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs b/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs index 176fb634..d1c6ba3a 100644 --- a/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/iOS/FileUploader/FileUploader.cs @@ -160,10 +160,10 @@ public IFileUploaderEventEmittable FileUploader set => _nativeFileUploaderCallbacksProxy!.FileUploader = value; } - public override void CancellingAdvertisement(string reason = "") + public override void CancellingAdvertisement(string reason) => _nativeFileUploaderCallbacksProxy?.CancellingAdvertisement(reason); - public override void CancelledAdvertisement(string reason = "") + public override void CancelledAdvertisement(string reason) => _nativeFileUploaderCallbacksProxy?.CancelledAdvertisement(reason); public override void LogMessageAdvertisement(string message, string category, string level, string resource) @@ -204,23 +204,20 @@ public override void BusyStateChangedAdvertisement(bool busyNotIdle) public override void FatalErrorOccurredAdvertisement( string resource, string errorMessage, - nint mcuMgrErrorCode + nint globalErrorCode ) => FatalErrorOccurredAdvertisement( resource, errorMessage, - (EMcuMgrErrorCode)(int)mcuMgrErrorCode, - EFileOperationGroupErrorCode.Unset + (EGlobalErrorCode)(int)globalErrorCode ); public void FatalErrorOccurredAdvertisement( //conformance to the interface string resource, - string errorMessage, // ReSharper disable once MethodOverloadWithOptionalParameter - EMcuMgrErrorCode mcuMgrErrorCode, - EFileOperationGroupErrorCode fileUploaderGroupReturnCode + string errorMessage, + EGlobalErrorCode globalErrorCode ) => _nativeFileUploaderCallbacksProxy?.FatalErrorOccurredAdvertisement( resource, errorMessage, - mcuMgrErrorCode, - fileUploaderGroupReturnCode + globalErrorCode ); public override void FileUploadProgressPercentageAndDataThroughputChangedAdvertisement(nint progressPercentage, float averageThroughput) From 5cfd1b798ff3601c56ca4349f47c5c1769b4697e Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Mon, 28 Oct 2024 20:32:43 +0100 Subject: [PATCH 097/104] refa (FirmwareInstaller): now both the ios and android side report the global-error-code over to the C# side when an error occurs --- .../AndroidFirmwareInstaller.java | 26 +++++++++++-------- .../IOSFirmwareInstaller.swift | 26 +++++++++---------- .../IOSListenerForFirmwareInstaller.swift | 2 +- ...tu_GivenFlakyConnectionForFileUploading.cs | 22 ++++++++-------- ..._GivenFirmwareUploadFatalErrorMidflight.cs | 5 ++-- ...ception_GivenGenericFatalErrorMidflight.cs | 5 ++-- ...meoutException_GivenFatalErrorMidflight.cs | 5 ++-- .../FirmwareInstallerTestbed.cs | 4 +-- .../FirmwareInstaller/FirmwareInstaller.cs | 12 +++++---- .../Events/FatalErrorOccurredEventArgs.cs | 5 +++- .../INativeFirmwareInstallerCallbacksProxy.cs | 2 +- .../FirmwareInstaller/FirmwareInstaller.cs | 4 +-- .../FirmwareInstaller/FirmwareInstaller.cs | 12 +++++---- 13 files changed, 71 insertions(+), 59 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java index d637d03c..c4889498 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java @@ -114,7 +114,7 @@ public EAndroidFirmwareInstallationVerdict beginInstallation( } catch (final Exception ex2) { - emitFatalError(EAndroidFirmwareInstallerFatalErrorType.INVALID_FIRMWARE, ex2.getMessage()); + onError(EAndroidFirmwareInstallerFatalErrorType.INVALID_FIRMWARE, ex2.getMessage(), ex); return EAndroidFirmwareInstallationVerdict.FAILED__INVALID_DATA_FILE; } @@ -135,7 +135,7 @@ public EAndroidFirmwareInstallationVerdict beginInstallation( } catch (final Exception ex) { - emitFatalError(EAndroidFirmwareInstallerFatalErrorType.INVALID_SETTINGS, ex.getMessage()); + onError(EAndroidFirmwareInstallerFatalErrorType.INVALID_SETTINGS, ex.getMessage(), ex); return EAndroidFirmwareInstallationVerdict.FAILED__INVALID_SETTINGS; } @@ -148,7 +148,7 @@ public EAndroidFirmwareInstallationVerdict beginInstallation( } catch (final Exception ex) { - emitFatalError(EAndroidFirmwareInstallerFatalErrorType.DEPLOYMENT_FAILED, ex.getMessage()); + onError(EAndroidFirmwareInstallerFatalErrorType.DEPLOYMENT_FAILED, ex.getMessage(), ex); return EAndroidFirmwareInstallationVerdict.FAILED__DEPLOYMENT_ERROR; } @@ -244,19 +244,23 @@ public String getLastFatalErrorMessage() return _lastFatalErrorMessage; } - public void emitFatalError(EAndroidFirmwareInstallerFatalErrorType fatalErrorType, final String errorMessage) + public void onError(EAndroidFirmwareInstallerFatalErrorType fatalErrorType, final String errorMessage, Exception ex) { - EAndroidFirmwareInstallationState currentStateSnapshot = _currentState; //00 - - setState(EAndroidFirmwareInstallationState.ERROR); // order - fatalErrorOccurredAdvertisement(currentStateSnapshot, fatalErrorType, errorMessage); // order + EAndroidFirmwareInstallationState currentStateSnapshot = _currentState; //00 order + setState(EAndroidFirmwareInstallationState.ERROR); // order + fatalErrorOccurredAdvertisement( // order + currentStateSnapshot, + fatalErrorType, + errorMessage, + McuMgrExceptionHelpers.DeduceGlobalErrorCodeFromException(ex) + ); //00 we want to let the calling environment know in which exact state the fatal error happened in } - public void fatalErrorOccurredAdvertisement(final EAndroidFirmwareInstallationState state, final EAndroidFirmwareInstallerFatalErrorType fatalErrorType, final String errorMessage) + //this method is meant to be overridden by csharp binding libraries to intercept updates + public void fatalErrorOccurredAdvertisement(final EAndroidFirmwareInstallationState state, final EAndroidFirmwareInstallerFatalErrorType fatalErrorType, final String errorMessage, final int globalErrorCode) { - //this method is meant to be overridden by csharp binding libraries to intercept updates _lastFatalErrorMessage = errorMessage; } @@ -396,7 +400,7 @@ else if (state == State.CONFIRM && ex instanceof McuMgrTimeoutException) fatalErrorType = EAndroidFirmwareInstallerFatalErrorType.FIRMWARE_IMAGE_SWAP_TIMEOUT; } - emitFatalError(fatalErrorType, ex.getMessage()); + onError(fatalErrorType, ex.getMessage(), ex); setLoggingEnabled(true); // Timber.e(error, "Install failed"); busyStateChangedAdvertisement(false); diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareInstaller.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareInstaller.swift index 12cfd21e..95cb2c6a 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareInstaller.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareInstaller.swift @@ -181,20 +181,24 @@ public class IOSFirmwareInstaller: NSObject { _transporter?.close() } - private func emitFatalError(_ fatalErrorType: EIOSFirmwareInstallerFatalErrorType, _ errorMessage: String) { - let currentStateSnapshot = _currentState //00 - - setState(.error) // order - fatalErrorOccurredAdvertisement(currentStateSnapshot, fatalErrorType, errorMessage) // order + private func emitFatalError(_ fatalErrorType: EIOSFirmwareInstallerFatalErrorType, _ errorMessage: String, _ error: Error? = nil) { + let currentStateSnapshot = _currentState //00 order + setState(.error) // order + fatalErrorOccurredAdvertisement( // order + currentStateSnapshot, + fatalErrorType, + errorMessage, + McuMgrExceptionHelpers.deduceGlobalErrorCodeFromException(error) + ) //00 we want to let the calling environment know in which exact state the fatal error happened in } //@objc dont - private func fatalErrorOccurredAdvertisement(_ currentState: EIOSFirmwareInstallationState, _ fatalErrorType: EIOSFirmwareInstallerFatalErrorType, _ errorMessage: String) { + private func fatalErrorOccurredAdvertisement(_ currentState: EIOSFirmwareInstallationState, _ fatalErrorType: EIOSFirmwareInstallerFatalErrorType, _ errorMessage: String, _ globalErrorCode: Int) { _lastFatalErrorMessage = errorMessage - _listener.fatalErrorOccurredAdvertisement(currentState, fatalErrorType, errorMessage) + _listener.fatalErrorOccurredAdvertisement(currentState, fatalErrorType, errorMessage, globalErrorCode) } //@objc dont @@ -301,12 +305,6 @@ extension IOSFirmwareInstaller: FirmwareUpgradeDelegate { //todo calculate thr } public func upgradeDidFail(inState state: FirmwareUpgradeState, with error: Error) { - logMessageAdvertisement( - "** upgradeDidFail: state=\(state), error-message=\(error.localizedDescription), error-type=\(type(of: error))", - "firmware-installer", - iOSMcuManagerLibrary.McuMgrLogLevel.debug.name - ) - var fatalErrorType = EIOSFirmwareInstallerFatalErrorType.generic if (state == .upload) { //todo improve this heuristic once we figure out the exact type of exception we get in case of an upload error fatalErrorType = .firmwareUploadingErroredOut @@ -315,7 +313,7 @@ extension IOSFirmwareInstaller: FirmwareUpgradeDelegate { //todo calculate thr fatalErrorType = .firmwareImageSwapTimeout } - emitFatalError(fatalErrorType, error.localizedDescription) + emitFatalError(fatalErrorType, error.localizedDescription, error) busyStateChangedAdvertisement(false) } diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFirmwareInstaller.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFirmwareInstaller.swift index 87626e5d..9ded75fe 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFirmwareInstaller.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFirmwareInstaller.swift @@ -12,6 +12,6 @@ public protocol IOSListenerForFirmwareInstaller { func logMessageAdvertisement(_ message: String, _ category: String, _ level: String) func stateChangedAdvertisement(_ oldState: EIOSFirmwareInstallationState, _ newState: EIOSFirmwareInstallationState) func busyStateChangedAdvertisement(_ busyNotIdle: Bool) - func fatalErrorOccurredAdvertisement(_ currentState: EIOSFirmwareInstallationState, _ fatalErrorType: EIOSFirmwareInstallerFatalErrorType, _ errorMessage: String) + func fatalErrorOccurredAdvertisement(_ currentState: EIOSFirmwareInstallationState, _ fatalErrorType: EIOSFirmwareInstallerFatalErrorType, _ errorMessage: String, _ globalErrorCode: Int) func firmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(_ progressPercentage: Int, _ averageThroughput: Float32) } diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs index 8b8215d9..a4d93b37 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldCompleteSuccessfullyWithLastDitchAttemptUsingLowerInitialMtu_GivenFlakyConnectionForFileUploading.cs @@ -133,7 +133,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( { BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(initialMtuSize)} set to the fail-safe value of {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected, EGlobalErrorCode.Generic); return; } @@ -141,7 +141,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( { BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(windowCapacity)} set to the fail-safe value of {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected, EGlobalErrorCode.Generic); return; } @@ -149,7 +149,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( { BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(memoryAlignment)} set to the fail-safe value of {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected, EGlobalErrorCode.Generic); return; } @@ -157,7 +157,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( { BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(pipelineDepth)} set to the fail-safe value of {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected, EGlobalErrorCode.Generic); return; } @@ -165,7 +165,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( { BugDetected = $"[BUG DETECTED] The very first try should not be with {nameof(byteAlignment)} set to the fail-safe value of {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment} right off the bat - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected, EGlobalErrorCode.Generic); return; } @@ -186,7 +186,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(initialMtuSize)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.InitialMtuSize} but it's set to {initialMtuSize?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected, EGlobalErrorCode.Generic); return; } @@ -194,7 +194,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(windowCapacity)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.WindowCapacity} but it's set to {windowCapacity?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected, EGlobalErrorCode.Generic); return; } @@ -202,7 +202,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(memoryAlignment)} set to {AndroidTidbits.BleConnectionFailsafeSettings.ForUploading.MemoryAlignment} but it's set to {memoryAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected, EGlobalErrorCode.Generic); return; } @@ -210,7 +210,7 @@ public override EFirmwareInstallationVerdict BeginInstallation( { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(pipelineDepth)} set to {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.PipelineDepth} but it's set to {pipelineDepth?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected, EGlobalErrorCode.Generic); return; } @@ -218,14 +218,14 @@ public override EFirmwareInstallationVerdict BeginInstallation( { BugDetected = $"[BUG DETECTED] The very last try should be with {nameof(byteAlignment)} set to {AppleTidbits.BleConnectionFailsafeSettings.ForUploading.ByteAlignment} but it's set to {byteAlignment?.ToString() ?? "(null)"} instead - something is wrong!"; StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected); + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, BugDetected, EGlobalErrorCode.Generic); return; } if (_tryCounter < _maxTriesCount) { StateChangedAdvertisement(oldState: EFirmwareInstallationState.Uploading, newState: EFirmwareInstallationState.Error); - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, "error while uploading firmware blah blah"); // order + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, "error while uploading firmware blah blah", EGlobalErrorCode.Generic); // order return; } diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs index f000960b..15292531 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenFirmwareUploadFatalErrorMidflight.cs @@ -1,4 +1,5 @@ using FluentAssertions; +using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Helpers; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Enums; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Events; @@ -110,8 +111,8 @@ public override EFirmwareInstallationVerdict BeginInstallation( StateChangedAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallationState.Testing); await Task.Delay(100); - StateChangedAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallationState.Error); // order - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, "error while uploading firmware blah blah"); // order + StateChangedAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallationState.Error); // order + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, "error while uploading firmware blah blah", EGlobalErrorCode.Generic); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs index 39605ff5..1ddceb23 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowAllFirmwareInstallationAttemptsFailedException_GivenGenericFatalErrorMidflight.cs @@ -1,4 +1,5 @@ using FluentAssertions; +using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Helpers; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Enums; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Events; @@ -101,8 +102,8 @@ public override EFirmwareInstallationVerdict BeginInstallation( StateChangedAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallationState.Testing); await Task.Delay(100); - StateChangedAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallationState.Error); // order - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Confirming, EFirmwareInstallerFatalErrorType.Generic, "fatal error occurred"); // order + StateChangedAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallationState.Error); // order + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Confirming, EFirmwareInstallerFatalErrorType.Generic, "fatal error occurred", EGlobalErrorCode.Generic); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs index 235e6c3e..c74ed713 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.InstallAsync.ShouldThrowFirmwareInstallationImageSwapTimeoutException_GivenFatalErrorMidflight.cs @@ -1,4 +1,5 @@ using FluentAssertions; +using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Helpers; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Enums; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Events; @@ -99,8 +100,8 @@ public override EFirmwareInstallationVerdict BeginInstallation( StateChangedAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallationState.Testing); await Task.Delay(100); - StateChangedAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallationState.Error); // order - FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Confirming, EFirmwareInstallerFatalErrorType.FirmwareImageSwapTimeout, "image swap timeout"); // order + StateChangedAdvertisement(EFirmwareInstallationState.Uploading, EFirmwareInstallationState.Error); // order + FatalErrorOccurredAdvertisement(EFirmwareInstallationState.Confirming, EFirmwareInstallerFatalErrorType.FirmwareImageSwapTimeout, "image swap timeout", EGlobalErrorCode.Generic); // order }); return verdict; diff --git a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.cs b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.cs index f64a6820..533c2d3f 100644 --- a/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.cs +++ b/Laerdal.McuMgr.Tests/FirmwareInstaller/FirmwareInstallerTestbed.cs @@ -69,8 +69,8 @@ public void StateChangedAdvertisement(EFirmwareInstallationState oldState, EFirm public void BusyStateChangedAdvertisement(bool busyNotIdle) => _firmwareInstallerCallbacksProxy.BusyStateChangedAdvertisement(busyNotIdle); //raises the actual event - public void FatalErrorOccurredAdvertisement(EFirmwareInstallationState state, EFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage) - => _firmwareInstallerCallbacksProxy.FatalErrorOccurredAdvertisement(state, fatalErrorType, errorMessage); //raises the actual event + public void FatalErrorOccurredAdvertisement(EFirmwareInstallationState state, EFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage, EGlobalErrorCode globalErrorCode) + => _firmwareInstallerCallbacksProxy.FatalErrorOccurredAdvertisement(state, fatalErrorType, errorMessage, globalErrorCode); //raises the actual event public void FirmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput) => _firmwareInstallerCallbacksProxy.FirmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(progressPercentage, averageThroughput); //raises the actual event diff --git a/Laerdal.McuMgr/Droid/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Droid/FirmwareInstaller/FirmwareInstaller.cs index 4faae8a4..82967c15 100644 --- a/Laerdal.McuMgr/Droid/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Droid/FirmwareInstaller/FirmwareInstaller.cs @@ -131,23 +131,25 @@ public EFirmwareInstallationVerdict BeginInstallation( #region callbacks -> events - public override void FatalErrorOccurredAdvertisement(EAndroidFirmwareInstallationState state, EAndroidFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage) + public override void FatalErrorOccurredAdvertisement(EAndroidFirmwareInstallationState state, EAndroidFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage, int globalErrorCode) { - base.FatalErrorOccurredAdvertisement(state, fatalErrorType, errorMessage); + base.FatalErrorOccurredAdvertisement(state, fatalErrorType, errorMessage, globalErrorCode); FatalErrorOccurredAdvertisement( state: TranslateEAndroidFirmwareInstallationState(state), errorMessage: errorMessage, - fatalErrorType: TranslateEAndroidFirmwareInstallerFatalErrorType(fatalErrorType) + fatalErrorType: TranslateEAndroidFirmwareInstallerFatalErrorType(fatalErrorType), + globalErrorCode: (EGlobalErrorCode) globalErrorCode ); } - public void FatalErrorOccurredAdvertisement(EFirmwareInstallationState state, EFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage) //just to conform to the interface + public void FatalErrorOccurredAdvertisement(EFirmwareInstallationState state, EFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage, EGlobalErrorCode globalErrorCode) //just to conform to the interface { _firmwareInstallerCallbacksProxy?.FatalErrorOccurredAdvertisement( state: state, errorMessage: errorMessage, - fatalErrorType: fatalErrorType + fatalErrorType: fatalErrorType, + globalErrorCode: globalErrorCode ); } diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Events/FatalErrorOccurredEventArgs.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Events/FatalErrorOccurredEventArgs.cs index e186bc73..97be44a5 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Events/FatalErrorOccurredEventArgs.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Events/FatalErrorOccurredEventArgs.cs @@ -1,6 +1,7 @@ // ReSharper disable MemberCanBePrivate.Global // ReSharper disable ClassNeverInstantiated.Global +using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Events; using Laerdal.McuMgr.FirmwareInstaller.Contracts.Enums; @@ -9,14 +10,16 @@ namespace Laerdal.McuMgr.FirmwareInstaller.Contracts.Events public readonly struct FatalErrorOccurredEventArgs : IMcuMgrEventArgs { public string ErrorMessage { get; } + public EGlobalErrorCode GlobalErrorCode { get; } public EFirmwareInstallationState State { get; } //the state in which the error occurred public EFirmwareInstallerFatalErrorType FatalErrorType { get; } - public FatalErrorOccurredEventArgs(EFirmwareInstallationState state, EFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage) + public FatalErrorOccurredEventArgs(EFirmwareInstallationState state, EFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage, EGlobalErrorCode globalErrorCode) { State = state; ErrorMessage = errorMessage; FatalErrorType = fatalErrorType; + GlobalErrorCode = globalErrorCode; } } } diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Native/INativeFirmwareInstallerCallbacksProxy.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Native/INativeFirmwareInstallerCallbacksProxy.cs index f6e707f4..9831e16f 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Native/INativeFirmwareInstallerCallbacksProxy.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Native/INativeFirmwareInstallerCallbacksProxy.cs @@ -11,7 +11,7 @@ internal interface INativeFirmwareInstallerCallbacksProxy void LogMessageAdvertisement(string message, string category, ELogLevel level, string resource); void StateChangedAdvertisement(EFirmwareInstallationState oldState, EFirmwareInstallationState newState); void BusyStateChangedAdvertisement(bool busyNotIdle); - void FatalErrorOccurredAdvertisement(EFirmwareInstallationState state, EFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage); + void FatalErrorOccurredAdvertisement(EFirmwareInstallationState state, EFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage, EGlobalErrorCode globalErrorCode); void FirmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput); } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index 567fd902..81b87617 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -477,8 +477,8 @@ public void StateChangedAdvertisement(EFirmwareInstallationState oldState, EFirm public void BusyStateChangedAdvertisement(bool busyNotIdle) => FirmwareInstaller?.OnBusyStateChanged(new BusyStateChangedEventArgs(busyNotIdle)); - public void FatalErrorOccurredAdvertisement(EFirmwareInstallationState state, EFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage) - => FirmwareInstaller?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs(state, fatalErrorType, errorMessage)); + public void FatalErrorOccurredAdvertisement(EFirmwareInstallationState state, EFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage, EGlobalErrorCode globalErrorCode) + => FirmwareInstaller?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs(state, fatalErrorType, errorMessage, globalErrorCode)); public void FirmwareUploadProgressPercentageAndDataThroughputChangedAdvertisement(int progressPercentage, float averageThroughput) => FirmwareInstaller?.OnFirmwareUploadProgressPercentageAndDataThroughputChanged(new FirmwareUploadProgressPercentageAndDataThroughputChangedEventArgs( diff --git a/Laerdal.McuMgr/iOS/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/iOS/FirmwareInstaller/FirmwareInstaller.cs index fb63ac5d..14662145 100644 --- a/Laerdal.McuMgr/iOS/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/iOS/FirmwareInstaller/FirmwareInstaller.cs @@ -151,18 +151,20 @@ public IFirmwareInstallerEventEmittable FirmwareInstaller public override void CancelledAdvertisement() => _nativeFirmwareInstallerCallbacksProxy?.CancelledAdvertisement(); public override void BusyStateChangedAdvertisement(bool busyNotIdle) => _nativeFirmwareInstallerCallbacksProxy?.BusyStateChangedAdvertisement(busyNotIdle); - public override void FatalErrorOccurredAdvertisement(EIOSFirmwareInstallationState state, EIOSFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage) + public override void FatalErrorOccurredAdvertisement(EIOSFirmwareInstallationState state, EIOSFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage, nint globalErrorCode) => FatalErrorOccurredAdvertisement( state: TranslateEIOSFirmwareInstallationState(state), errorMessage: errorMessage, - fatalErrorType: TranslateEIOSFirmwareInstallerFatalErrorType(fatalErrorType) + fatalErrorType: TranslateEIOSFirmwareInstallerFatalErrorType(fatalErrorType), + globalErrorCode: (EGlobalErrorCode) globalErrorCode ); - - public void FatalErrorOccurredAdvertisement(EFirmwareInstallationState state, EFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage) //just to conform to the interface + + public void FatalErrorOccurredAdvertisement(EFirmwareInstallationState state, EFirmwareInstallerFatalErrorType fatalErrorType, string errorMessage, EGlobalErrorCode globalErrorCode) //just to conform to the interface => _nativeFirmwareInstallerCallbacksProxy?.FatalErrorOccurredAdvertisement( state: state, errorMessage: errorMessage, - fatalErrorType: fatalErrorType + fatalErrorType: fatalErrorType, + globalErrorCode: globalErrorCode ); public override void LogMessageAdvertisement(string message, string category, string level) From 8dcca7ced39cdb4675d3f4b0825a299bcfe1648b Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 29 Oct 2024 13:34:42 +0100 Subject: [PATCH 098/104] clean (java libs): neutral tweaks to reformat all java files --- .../AndroidDeviceResetter.java | 46 ++++++++++----- .../AndroidFileDownloader.java | 39 ++++++++----- .../AndroidFileUploader.java | 56 ++++++++++++------- .../AndroidFirmwareEraser.java | 55 ++++++++++++------ .../AndroidFirmwareInstaller.java | 18 +++--- .../EAndroidDeviceResetterState.java | 3 +- .../EAndroidFileUploaderVerdict.java | 1 - .../EAndroidFirmwareEraserState.java | 3 +- .../EAndroidFirmwareInstallationMode.java | 6 +- .../EAndroidFirmwareInstallationVerdict.java | 5 +- .../McuMgrExceptionHelpers.java | 14 ++--- 11 files changed, 156 insertions(+), 90 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java index 3fe538fb..efd92207 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java @@ -13,7 +13,8 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings("unused") -public class AndroidDeviceResetter { +public class AndroidDeviceResetter +{ private DefaultManager _manager; private final McuMgrTransport _transport; @@ -24,11 +25,13 @@ public class AndroidDeviceResetter { * @param context the android-context of the calling environment * @param bluetoothDevice the device to perform the firmware-install on */ - public AndroidDeviceResetter(@NonNull final Context context, @NonNull final BluetoothDevice bluetoothDevice) { + public AndroidDeviceResetter(@NonNull final Context context, @NonNull final BluetoothDevice bluetoothDevice) + { _transport = new McuMgrBleTransport(context, bluetoothDevice); } - public void beginReset() { + public void beginReset() + { try { _manager = new DefaultManager(_transport); @@ -42,11 +45,14 @@ public void beginReset() { setState(EAndroidDeviceResetterState.RESETTING); - _manager.reset(new McuMgrCallback() { + _manager.reset(new McuMgrCallback() + { @Override - public void onResponse(@NotNull final McuMgrOsResponse response) { - if (!response.isSuccess()) { // check for an error return code + public void onResponse(@NotNull final McuMgrOsResponse response) + { + if (!response.isSuccess()) + { // check for an error return code fatalErrorOccurredAdvertisement("Reset failed (error-code '" + response.getReturnCode().toString() + "')"); setState(EAndroidDeviceResetterState.FAILED); @@ -57,7 +63,8 @@ public void onResponse(@NotNull final McuMgrOsResponse response) { } @Override - public void onError(@NotNull final McuMgrException error) { + public void onError(@NotNull final McuMgrException error) + { fatalErrorOccurredAdvertisement("Reset failed '" + error.getMessage() + "'"); setState(EAndroidDeviceResetterState.FAILED); @@ -66,7 +73,8 @@ public void onError(@NotNull final McuMgrException error) { }); } - public void disconnect() { + public void disconnect() + { if (_manager == null) return; @@ -77,12 +85,15 @@ public void disconnect() { mcuMgrTransporter.release(); } - public EAndroidDeviceResetterState getState() { + public EAndroidDeviceResetterState getState() + { return _currentState; } private EAndroidDeviceResetterState _currentState = EAndroidDeviceResetterState.NONE; - private void setState(final EAndroidDeviceResetterState newState) { + + private void setState(final EAndroidDeviceResetterState newState) + { final EAndroidDeviceResetterState oldState = _currentState; //order _currentState = newState; //order @@ -90,28 +101,33 @@ private void setState(final EAndroidDeviceResetterState newState) { stateChangedAdvertisement(oldState, newState); //order } - protected void onCleared() { + protected void onCleared() + { // _manager.setFirmwareUpgradeCallback(null); } private String _lastFatalErrorMessage; @Contract(pure = true) - public String getLastFatalErrorMessage() { + public String getLastFatalErrorMessage() + { return _lastFatalErrorMessage; } - public void fatalErrorOccurredAdvertisement(final String errorMessage) { + public void fatalErrorOccurredAdvertisement(final String errorMessage) + { _lastFatalErrorMessage = errorMessage; } @Contract(pure = true) - public void logMessageAdvertisement(final String message, final String category, final String level) { + public void logMessageAdvertisement(final String message, final String category, final String level) + { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } @Contract(pure = true) - public void stateChangedAdvertisement(final EAndroidDeviceResetterState oldState, final EAndroidDeviceResetterState currentState) { + public void stateChangedAdvertisement(final EAndroidDeviceResetterState oldState, final EAndroidDeviceResetterState currentState) + { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index 7211e722..a773395f 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -53,7 +53,8 @@ public boolean trySetContext(@NonNull final Context context) public boolean trySetBluetoothDevice(@NonNull final BluetoothDevice bluetoothDevice) { - if (!IsIdleOrCold()) { + if (!IsIdleOrCold()) + { logMessageAdvertisement("[AFD.TSBD.005] trySetBluetoothDevice() cannot proceed because the uploader is not cold", "FileUploader", "ERROR", _remoteFilePathSanitized); return false; } @@ -93,7 +94,6 @@ public boolean tryInvalidateCachedTransport() * @param remoteFilePath the remote-file-path to the file on the remote device that you wish to download * @param initialMtuSize sets the initial MTU for the connection that the McuMgr BLE-transport sets up for the firmware installation that will follow. * Note that if less than 0 it gets ignored and if it doesn't fall within the range [23, 517] it will cause a hard error. - * * @return a verdict indicating whether the file uploading was started successfully or not */ public EAndroidFileDownloaderVerdict beginDownload( @@ -109,7 +109,8 @@ public EAndroidFileDownloaderVerdict beginDownload( return EAndroidFileDownloaderVerdict.FAILED__DOWNLOAD_ALREADY_IN_PROGRESS; } - if (remoteFilePath == null || remoteFilePath.isEmpty()) { + if (remoteFilePath == null || remoteFilePath.isEmpty()) + { onError("Target-file provided is dud!"); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; @@ -130,13 +131,15 @@ public EAndroidFileDownloaderVerdict beginDownload( return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } - if (_context == null) { + if (_context == null) + { onError("No context specified - call trySetContext() first"); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } - if (_bluetoothDevice == null) { + if (_bluetoothDevice == null) + { onError("No bluetooth-device specified - call trySetBluetoothDevice() first"); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; @@ -193,7 +196,8 @@ public void resume() transferController.resume(); } - public void disconnect() { + public void disconnect() + { if (_fileSystemManager == null) return; @@ -215,7 +219,8 @@ public void cancel() transferController.cancel(); //order } - private void resetDownloadState() { + private void resetDownloadState() + { _initialBytes = 0; _downloadStartTimestamp = 0; @@ -239,14 +244,16 @@ private void ensureTransportIsInitializedExactlyOnce(int initialMtuSize) } } - private void ensureFileDownloaderCallbackProxyIsInitializedExactlyOnce() { + private void ensureFileDownloaderCallbackProxyIsInitializedExactlyOnce() + { if (_fileDownloaderCallbackProxy != null) //already initialized return; _fileDownloaderCallbackProxy = new FileDownloaderCallbackProxy(); } - private EAndroidFileDownloaderVerdict ensureFilesystemManagerIsInitializedExactlyOnce() { + private EAndroidFileDownloaderVerdict ensureFilesystemManagerIsInitializedExactlyOnce() + { if (_fileSystemManager != null) //already initialized return EAndroidFileDownloaderVerdict.SUCCESS; @@ -283,9 +290,12 @@ private void disposeTransport() if (_transport == null) return; - try { + try + { _transport.disconnect(); - } catch (Exception ex) { + } + catch (Exception ex) + { // ignore } @@ -297,9 +307,12 @@ private void disposeFilesystemManager() if (_fileSystemManager == null) return; - try { + try + { _fileSystemManager.closeAll(); - } catch (McuMgrException e) { + } + catch (McuMgrException e) + { // ignore } diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 8f99e842..01c330d1 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -53,7 +53,8 @@ public boolean trySetContext(@NonNull final Context context) public boolean trySetBluetoothDevice(@NonNull final BluetoothDevice bluetoothDevice) { - if (!IsIdleOrCold()) { + if (!IsIdleOrCold()) + { logMessageAdvertisement("[AFU.TSBD.005] trySetBluetoothDevice() cannot proceed because the uploader is not cold", "FileUploader", "ERROR", _remoteFilePathSanitized); return false; } @@ -90,13 +91,12 @@ public boolean tryInvalidateCachedTransport() * Initiates a file upload asynchronously. The progress is advertised through the callbacks provided by this class. * Setup interceptors for them to get informed about the status of the firmware-installation. * - * @param remoteFilePath the remote-file-path to save the given data to on the remote device - * @param data the bytes to upload - * @param initialMtuSize sets the initial MTU for the connection that the McuMgr BLE-transport sets up for the firmware installation that will follow. - * Note that if less than 0 it gets ignored and if it doesn't fall within the range [23, 517] it will cause a hard error. - * @param windowCapacity specifies the windows-capacity for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default + * @param remoteFilePath the remote-file-path to save the given data to on the remote device + * @param data the bytes to upload + * @param initialMtuSize sets the initial MTU for the connection that the McuMgr BLE-transport sets up for the firmware installation that will follow. + * Note that if less than 0 it gets ignored and if it doesn't fall within the range [23, 517] it will cause a hard error. + * @param windowCapacity specifies the windows-capacity for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default * @param memoryAlignment specifies the memory-alignment to use for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default - * * @return a verdict indicating whether the file uploading was started successfully or not */ public EAndroidFileUploaderVerdict beginUpload( @@ -107,13 +107,15 @@ public EAndroidFileUploaderVerdict beginUpload( final int memoryAlignment ) { - if (!IsCold()) { //keep first + if (!IsCold()) + { //keep first onError("Another upload is already in progress"); return EAndroidFileUploaderVerdict.FAILED__OTHER_UPLOAD_ALREADY_IN_PROGRESS; } - if (remoteFilePath == null || remoteFilePath.isEmpty()) { + if (remoteFilePath == null || remoteFilePath.isEmpty()) + { onError("Provided target-path is empty", null); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; @@ -134,19 +136,22 @@ public EAndroidFileUploaderVerdict beginUpload( return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } - if (_context == null) { + if (_context == null) + { onError("No context specified - call trySetContext() first"); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } - if (_bluetoothDevice == null) { + if (_bluetoothDevice == null) + { onError("No bluetooth-device specified - call trySetBluetoothDevice() first"); return EAndroidFileUploaderVerdict.FAILED__INVALID_SETTINGS; } - if (data == null) { // data being null is not ok but data.length==0 is perfectly ok because we might want to create empty files + if (data == null) + { // data being null is not ok but data.length==0 is perfectly ok because we might want to create empty files onError("Provided data is null"); return EAndroidFileUploaderVerdict.FAILED__INVALID_DATA; @@ -188,7 +193,8 @@ public EAndroidFileUploaderVerdict beginUpload( // aka sending multiple packets without waiting for the response } - private void resetUploadState() { + private void resetUploadState() + { _initialBytes = 0; _uploadStartTimestamp = 0; @@ -212,14 +218,16 @@ private void ensureTransportIsInitializedExactlyOnce(int initialMtuSize) } } - private void ensureFileUploaderCallbackProxyIsInitializedExactlyOnce() { + private void ensureFileUploaderCallbackProxyIsInitializedExactlyOnce() + { if (_fileUploaderCallbackProxy != null) //already initialized return; _fileUploaderCallbackProxy = new FileUploaderCallbackProxy(); } - private EAndroidFileUploaderVerdict ensureFilesystemManagerIsInitializedExactlyOnce() { + private EAndroidFileUploaderVerdict ensureFilesystemManagerIsInitializedExactlyOnce() + { if (_fileSystemManager != null) //already initialized return EAndroidFileUploaderVerdict.SUCCESS; @@ -268,7 +276,8 @@ public void resume() transferController.resume(); } - public void disconnect() { + public void disconnect() + { if (_fileSystemManager == null) return; @@ -280,6 +289,7 @@ public void disconnect() { } private String _cancellationReason = ""; + public void cancel(final String reason) { _cancellationReason = reason; @@ -308,9 +318,12 @@ private void disposeTransport() if (_transport == null) return; - try { + try + { _transport.disconnect(); - } catch (Exception ex) { + } + catch (Exception ex) + { // ignore } @@ -322,9 +335,12 @@ private void disposeFilesystemManager() if (_fileSystemManager == null) return; - try { + try + { _fileSystemManager.closeAll(); - } catch (McuMgrException e) { + } + catch (McuMgrException e) + { // ignore } diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java index e2b1a14a..1e18a2f9 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java @@ -13,7 +13,8 @@ import org.jetbrains.annotations.Contract; @SuppressWarnings("unused") -public class AndroidFirmwareEraser { +public class AndroidFirmwareEraser +{ private ImageManager _imageManager; private final McuMgrBleTransport _transport; @@ -24,20 +25,25 @@ public class AndroidFirmwareEraser { * @param context the android-context of the calling environment * @param bluetoothDevice the device to perform the firmware-install on */ - public AndroidFirmwareEraser(@NonNull final Context context, @NonNull final BluetoothDevice bluetoothDevice) { + public AndroidFirmwareEraser(@NonNull final Context context, @NonNull final BluetoothDevice bluetoothDevice) + { _transport = new McuMgrBleTransport(context, bluetoothDevice); } - public void beginErasure(final int imageIndex) { + public void beginErasure(final int imageIndex) + { busyStateChangedAdvertisement(true); setState(EAndroidFirmwareEraserState.ERASING); _imageManager = new ImageManager(_transport); - _imageManager.erase(imageIndex, new McuMgrCallback() { + _imageManager.erase(imageIndex, new McuMgrCallback() + { @Override - public void onResponse(@NonNull final McuMgrImageResponse response) { - if (!response.isSuccess()) { // check for an error return code + public void onResponse(@NonNull final McuMgrImageResponse response) + { + if (!response.isSuccess()) + { // check for an error return code fatalErrorOccurredAdvertisement("Erasure failed (error-code '" + response.getReturnCode().toString() + "')"); setState(EAndroidFirmwareEraserState.FAILED); @@ -50,7 +56,8 @@ public void onResponse(@NonNull final McuMgrImageResponse response) { } @Override - public void onError(@NonNull final McuMgrException error) { + public void onError(@NonNull final McuMgrException error) + { fatalErrorOccurredAdvertisement("Erasure failed '" + error.getMessage() + "'"); busyStateChangedAdvertisement(false); @@ -60,7 +67,8 @@ public void onError(@NonNull final McuMgrException error) { }); } - public void disconnect() { + public void disconnect() + { if (_imageManager == null) return; @@ -72,7 +80,9 @@ public void disconnect() { } private EAndroidFirmwareEraserState _currentState = EAndroidFirmwareEraserState.NONE; - private void setState(EAndroidFirmwareEraserState newState) { + + private void setState(EAndroidFirmwareEraserState newState) + { final EAndroidFirmwareEraserState oldState = _currentState; //order _currentState = newState; //order @@ -81,44 +91,53 @@ private void setState(EAndroidFirmwareEraserState newState) { } @Contract(pure = true) - public void stateChangedAdvertisement(EAndroidFirmwareEraserState oldState, EAndroidFirmwareEraserState currentState) { + public void stateChangedAdvertisement(EAndroidFirmwareEraserState oldState, EAndroidFirmwareEraserState currentState) + { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } private String _lastFatalErrorMessage; @Contract(pure = true) - public String getLastFatalErrorMessage() { + public String getLastFatalErrorMessage() + { return _lastFatalErrorMessage; } - public void fatalErrorOccurredAdvertisement(final String errorMessage) { + public void fatalErrorOccurredAdvertisement(final String errorMessage) + { _lastFatalErrorMessage = errorMessage; //this method is meant to be overridden by csharp binding libraries to intercept updates } @Contract(pure = true) - public void logMessageAdvertisement(final String message, final String category, final String level) { + public void logMessageAdvertisement(final String message, final String category, final String level) + { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } @Contract(pure = true) - public void busyStateChangedAdvertisement(final boolean busyNotIdle) { + public void busyStateChangedAdvertisement(final boolean busyNotIdle) + { //this method is intentionally empty its meant to be overridden by csharp binding libraries to intercept updates } - private void readImageErasure() { + private void readImageErasure() + { busyStateChangedAdvertisement(true); - _imageManager.list(new McuMgrCallback() { + _imageManager.list(new McuMgrCallback() + { @Override - public void onResponse(@NonNull final McuMgrImageStateResponse response) { + public void onResponse(@NonNull final McuMgrImageStateResponse response) + { // postReady(response); busyStateChangedAdvertisement(false); } @Override - public void onError(@NonNull final McuMgrException error) { + public void onError(@NonNull final McuMgrException error) + { fatalErrorOccurredAdvertisement(error.getMessage()); busyStateChangedAdvertisement(false); } diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java index c4889498..a5e8746f 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java @@ -55,15 +55,14 @@ public AndroidFirmwareInstaller(@NonNull final Context context, @NonNull final B * Initiates a firmware installation asynchronously. The progress is advertised through the callbacks provided by this class. * Setup interceptors for them to get informed about the status of the firmware-installation. * - * @param data the firmware bytes to install - can also be a zipped byte stream - * @param mode the mode of the installation - typically you want to set this to TEST_AND_CONFIRM in production environments - * @param initialMtuSize sets the initial MTU for the connection that the McuMgr BLE-transport sets up for the firmware installation that will follow. - * Note that if less than 0 it gets ignored and if it doesn't fall within the range [23, 517] it will cause a hard error. - * @param eraseSettings specifies whether the previous settings should be erased on the target-device + * @param data the firmware bytes to install - can also be a zipped byte stream + * @param mode the mode of the installation - typically you want to set this to TEST_AND_CONFIRM in production environments + * @param initialMtuSize sets the initial MTU for the connection that the McuMgr BLE-transport sets up for the firmware installation that will follow. + * Note that if less than 0 it gets ignored and if it doesn't fall within the range [23, 517] it will cause a hard error. + * @param eraseSettings specifies whether the previous settings should be erased on the target-device * @param estimatedSwapTimeInMilliseconds specifies the amount of time to wait before probing the device to see if the firmware that got installed managed to reboot the device successfully - if negative the setting gets ignored - * @param windowCapacity specifies the windows-capacity for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default - * @param memoryAlignment specifies the memory-alignment to use for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default - * + * @param windowCapacity specifies the windows-capacity for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default + * @param memoryAlignment specifies the memory-alignment to use for the data transfers of the BLE connection - if zero or negative the value provided gets ignored and will be set to 1 by default * @return a verdict indicating whether the firmware installation was started successfully or not */ public EAndroidFirmwareInstallationVerdict beginInstallation( @@ -202,7 +201,8 @@ public EAndroidFirmwareInstallationVerdict beginInstallation( //3 Set the selected memory alignment. In the app this defaults to 4 to match Nordic devices, but can be modified in the UI. } - public void disconnect() { + public void disconnect() + { if (_manager == null) return; diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidDeviceResetterState.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidDeviceResetterState.java index fe0aac3f..0035cf46 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidDeviceResetterState.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidDeviceResetterState.java @@ -1,6 +1,7 @@ package no.laerdal.mcumgr_laerdal_wrapper; -public enum EAndroidDeviceResetterState { +public enum EAndroidDeviceResetterState +{ NONE(0), IDLE(1), RESETTING(2), diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileUploaderVerdict.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileUploaderVerdict.java index 674e4bc5..d90c590a 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileUploaderVerdict.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileUploaderVerdict.java @@ -16,4 +16,3 @@ public enum EAndroidFileUploaderVerdict //this must mirror the enum values of E[ _value = value; } } - diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareEraserState.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareEraserState.java index ae4b31e8..48f1f055 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareEraserState.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareEraserState.java @@ -1,6 +1,7 @@ package no.laerdal.mcumgr_laerdal_wrapper; -public enum EAndroidFirmwareEraserState { +public enum EAndroidFirmwareEraserState +{ NONE(0), IDLE(1), ERASING(2), diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareInstallationMode.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareInstallationMode.java index 33986d6f..f2def48b 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareInstallationMode.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareInstallationMode.java @@ -39,11 +39,13 @@ public enum EAndroidFirmwareInstallationMode @SuppressWarnings({"FieldCanBeLocal", "unused"}) private final int _value; - EAndroidFirmwareInstallationMode(int value) { + EAndroidFirmwareInstallationMode(int value) + { _value = value; } - FirmwareUpgradeManager.Mode getValueFirmwareUpgradeManagerMode() throws RuntimeException { + FirmwareUpgradeManager.Mode getValueFirmwareUpgradeManagerMode() throws RuntimeException + { switch (_value) { case 0: diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareInstallationVerdict.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareInstallationVerdict.java index 8dc78c0d..29172194 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareInstallationVerdict.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareInstallationVerdict.java @@ -11,9 +11,8 @@ public enum EAndroidFirmwareInstallationVerdict @SuppressWarnings({"FieldCanBeLocal", "unused"}) private final int _value; - EAndroidFirmwareInstallationVerdict(int value) { + EAndroidFirmwareInstallationVerdict(int value) + { _value = value; } } - - diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java index dc05b20d..4cd3d8d2 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java @@ -1,21 +1,21 @@ package no.laerdal.mcumgr_laerdal_wrapper; -import io.runtime.mcumgr.McuMgrErrorCode; import io.runtime.mcumgr.exception.McuMgrErrorException; import io.runtime.mcumgr.response.HasReturnCode; -final class McuMgrExceptionHelpers { - +final class McuMgrExceptionHelpers +{ // this method must be kept aligned between our ios lib and our android lib - public static int DeduceGlobalErrorCodeFromException(Exception exception) { + public static int DeduceGlobalErrorCodeFromException(Exception exception) + { if (!(exception instanceof McuMgrErrorException)) return -99; McuMgrErrorException mcuMgrErrorException = (McuMgrErrorException) exception; HasReturnCode.GroupReturnCode groupReturnCodeSpecs = mcuMgrErrorException.getGroupCode(); return groupReturnCodeSpecs == null - ? mcuMgrErrorException.getCode().value() // 00 - : ((groupReturnCodeSpecs.group + 1) * 1000) + groupReturnCodeSpecs.rc; // 10 + ? mcuMgrErrorException.getCode().value() // 00 + : (((groupReturnCodeSpecs.group + 1) * 1000) + groupReturnCodeSpecs.rc); // 10 //00 for auth errors and for nordic devices that do not support smp v2 these error codes occupy the range [0,999] // @@ -23,4 +23,4 @@ public static int DeduceGlobalErrorCodeFromException(Exception exception) { // // in this way all error codes get mapped to a single human-readable enum in csharp called EGlobalErrorCode } -} \ No newline at end of file +} From f56db7957d833bf8b2a4af9acf7d6f11205f6e54 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 29 Oct 2024 16:01:59 +0100 Subject: [PATCH 099/104] refa (java + ios libs): the device-resetter and the firmware-eraser now also report a global-error-code in case of a fatal-error --- .../AndroidDeviceResetter.java | 31 ++++++++++-- .../AndroidFileDownloader.java | 49 +++++++++++-------- .../AndroidFirmwareEraser.java | 41 +++++++++++----- .../AndroidFirmwareInstaller.java | 2 +- .../McuMgrExceptionHelpers.java | 12 ++++- .../McuMgrBindingsiOS/IOSDeviceResetter.swift | 18 ++++--- .../McuMgrBindingsiOS/IOSFileDownloader.swift | 18 +++---- .../McuMgrBindingsiOS/IOSFileUploader.swift | 25 +++++----- .../McuMgrBindingsiOS/IOSFirmwareEraser.swift | 24 +++++---- .../IOSFirmwareInstaller.swift | 28 ++++++----- .../IOSListenerForDeviceResetter.swift | 2 +- .../IOSListenerForFirmwareEraser.swift | 2 +- ...xception_GivenBluetoothErrorDuringReset.cs | 3 +- .../DeviceResetter/DeviceResetterTestbed.cs | 8 +-- .../FirmwareEraser/FirmwareEraserTestbed.cs | 10 ++-- .../Droid/DeviceResetter/DeviceResetter.cs | 21 +++++--- .../Droid/FirmwareEraser/FirmwareEraser.cs | 28 +++++++---- .../INativeDeviceResetterCallbacksProxy.cs | 2 +- .../Shared/DeviceResetter/DeviceResetter.cs | 4 +- .../Events/FatalErrorOccurredEventArgs.cs | 3 +- .../INativeFirmwareEraserCallbacksProxy.cs | 2 +- .../Shared/FirmwareEraser/FirmwareEraser.cs | 4 +- .../iOS/DeviceResetter/DeviceResetter.cs | 8 ++- .../iOS/FirmwareEraser/FirmwareEraser.cs | 10 +++- 24 files changed, 219 insertions(+), 136 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java index efd92207..f0ca1395 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java @@ -4,10 +4,12 @@ import android.content.Context; import androidx.annotation.NonNull; import io.runtime.mcumgr.McuMgrCallback; +import io.runtime.mcumgr.McuMgrErrorCode; import io.runtime.mcumgr.McuMgrTransport; import io.runtime.mcumgr.ble.McuMgrBleTransport; import io.runtime.mcumgr.exception.McuMgrException; import io.runtime.mcumgr.managers.DefaultManager; +import io.runtime.mcumgr.response.HasReturnCode; import io.runtime.mcumgr.response.dflt.McuMgrOsResponse; import org.jetbrains.annotations.Contract; import org.jetbrains.annotations.NotNull; @@ -39,12 +41,14 @@ public void beginReset() catch (final Exception ex) { setState(EAndroidDeviceResetterState.FAILED); - fatalErrorOccurredAdvertisement("Failed to create manager: '" + ex.getMessage() + "'"); + onError("Failed to create manager: '" + ex.getMessage() + "'", ex); return; } setState(EAndroidDeviceResetterState.RESETTING); + AndroidDeviceResetter self = this; + _manager.reset(new McuMgrCallback() { @@ -53,7 +57,7 @@ public void onResponse(@NotNull final McuMgrOsResponse response) { if (!response.isSuccess()) { // check for an error return code - fatalErrorOccurredAdvertisement("Reset failed (error-code '" + response.getReturnCode().toString() + "')"); + self.onError("Reset failed (error-code '" + response.getReturnCode().toString() + "')", response.getReturnCode(), response.getGroupReturnCode()); setState(EAndroidDeviceResetterState.FAILED); return; @@ -63,9 +67,9 @@ public void onResponse(@NotNull final McuMgrOsResponse response) } @Override - public void onError(@NotNull final McuMgrException error) + public void onError(@NotNull final McuMgrException exception) { - fatalErrorOccurredAdvertisement("Reset failed '" + error.getMessage() + "'"); + self.onError("Reset failed '" + exception.getMessage() + "'", exception); setState(EAndroidDeviceResetterState.FAILED); } @@ -114,8 +118,25 @@ public String getLastFatalErrorMessage() return _lastFatalErrorMessage; } - public void fatalErrorOccurredAdvertisement(final String errorMessage) + private void onError(final String errorMessage, final Exception exception) + { + onErrorImpl(errorMessage, McuMgrExceptionHelpers.DeduceGlobalErrorCodeFromException(exception)); + } + + private void onError(final String errorMessage, final McuMgrErrorCode exceptionCodeSpecs, final HasReturnCode.GroupReturnCode groupReturnCodeSpecs) + { + onErrorImpl(errorMessage, McuMgrExceptionHelpers.DeduceGlobalErrorCodeFromException(exceptionCodeSpecs, groupReturnCodeSpecs)); + } + + private void onErrorImpl(final String errorMessage, final int globalErrorCode) { + setState(EAndroidDeviceResetterState.FAILED); + + fatalErrorOccurredAdvertisement(errorMessage, globalErrorCode); + } + + public void fatalErrorOccurredAdvertisement(final String errorMessage, final int globalErrorCode) + { //this method is meant to be overridden by csharp binding libraries to intercept updates _lastFatalErrorMessage = errorMessage; } diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index a773395f..cadd1ade 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -3,10 +3,12 @@ import android.bluetooth.BluetoothDevice; import android.content.Context; import androidx.annotation.NonNull; +import io.runtime.mcumgr.McuMgrErrorCode; import io.runtime.mcumgr.McuMgrTransport; import io.runtime.mcumgr.ble.McuMgrBleTransport; import io.runtime.mcumgr.exception.McuMgrException; import io.runtime.mcumgr.managers.FsManager; +import io.runtime.mcumgr.response.HasReturnCode; import io.runtime.mcumgr.transfer.DownloadCallback; import io.runtime.mcumgr.transfer.TransferController; import no.nordicsemi.android.ble.ConnectionPriorityRequest; @@ -104,14 +106,14 @@ public EAndroidFileDownloaderVerdict beginDownload( { if (!IsCold()) //keep first { - onError("Another download is already in progress"); + onError("[AFD.BD.000] Another download is already in progress"); return EAndroidFileDownloaderVerdict.FAILED__DOWNLOAD_ALREADY_IN_PROGRESS; } if (remoteFilePath == null || remoteFilePath.isEmpty()) { - onError("Target-file provided is dud!"); + onError("[AFD.BD.010] Target-file provided is dud!"); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } @@ -119,28 +121,28 @@ public EAndroidFileDownloaderVerdict beginDownload( _remoteFilePathSanitized = remoteFilePath.trim(); if (_remoteFilePathSanitized.endsWith("/")) //the path must point to a file not a directory { - onError("Provided target-path points to a directory not a file"); + onError("[AFD.BD.020] Provided target-path points to a directory not a file"); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } if (!_remoteFilePathSanitized.startsWith("/")) { - onError("Provided target-path is not an absolute path"); + onError("[AFD.BD.030] Provided target-path is not an absolute path"); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } if (_context == null) { - onError("No context specified - call trySetContext() first"); + onError("[AFD.BD.040] No context specified - call trySetContext() first"); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } if (_bluetoothDevice == null) { - onError("No bluetooth-device specified - call trySetBluetoothDevice() first"); + onError("[AFD.BD.050] No bluetooth-device specified - call trySetBluetoothDevice() first"); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } @@ -161,7 +163,7 @@ public EAndroidFileDownloaderVerdict beginDownload( } catch (final Exception ex) { - onError("Failed to initialize download", ex); + onError("[AFD.BD.060] Failed to initialize download: " + ex.getMessage(), ex); return EAndroidFileDownloaderVerdict.FAILED__ERROR_UPON_COMMENCING; } @@ -234,10 +236,7 @@ private void ensureTransportIsInitializedExactlyOnce(int initialMtuSize) if (_transport != null) return; - logMessageAdvertisement("[AFD.ETIIEO.010] (Re)Initializing transport: initial-mtu-size=" + initialMtuSize, "FileDownloader", "TRACE", _remoteFilePathSanitized); - _transport = new McuMgrBleTransport(_context, _bluetoothDevice); - if (initialMtuSize > 0) { _transport.setInitialMtu(initialMtuSize); @@ -257,8 +256,6 @@ private EAndroidFileDownloaderVerdict ensureFilesystemManagerIsInitializedExactl if (_fileSystemManager != null) //already initialized return EAndroidFileDownloaderVerdict.SUCCESS; - logMessageAdvertisement("[AFD.EFMIIEO.010] (Re)Initializing filesystem-manager", "FileDownloader", "TRACE", _remoteFilePathSanitized); - try { _fileSystemManager = new FsManager(_transport); //order @@ -267,7 +264,7 @@ private EAndroidFileDownloaderVerdict ensureFilesystemManagerIsInitializedExactl } catch (final Exception ex) { - onError(ex.getMessage(), ex); + onError("[AFD.EFMIIEO.010] Failed to initialize the filesystem manager: " + ex.getMessage(), ex); return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } @@ -372,21 +369,31 @@ public String getLastFatalErrorMessage() return _lastFatalErrorMessage; } - public void onError(final String errorMessage) + private void onError(final String errorMessage) { onError(errorMessage, null); } - //@Contract(pure = true) //dont - public void onError(final String errorMessage, final Exception exception) + private void onError(final String errorMessage, final Exception exception) + { + onErrorImpl(errorMessage, McuMgrExceptionHelpers.DeduceGlobalErrorCodeFromException(exception)); + } + + private void onError(final String errorMessage, final McuMgrErrorCode exceptionCodeSpecs, final HasReturnCode.GroupReturnCode groupReturnCodeSpecs) + { + onErrorImpl(errorMessage, McuMgrExceptionHelpers.DeduceGlobalErrorCodeFromException(exceptionCodeSpecs, groupReturnCodeSpecs)); + } + + private void onErrorImpl(final String errorMessage, final int globalErrorCode) { setState(EAndroidFileDownloaderState.ERROR); - fatalErrorOccurredAdvertisement( - _remoteFilePathSanitized, - errorMessage, - McuMgrExceptionHelpers.DeduceGlobalErrorCodeFromException(exception) - ); + fatalErrorOccurredAdvertisement(_remoteFilePathSanitized, errorMessage, globalErrorCode); + } + + public void fatalErrorOccurredAdvertisement(final String errorMessage, final int globalErrorCode) + { //this method is meant to be overridden by csharp binding libraries to intercept updates + _lastFatalErrorMessage = errorMessage; } public void fatalErrorOccurredAdvertisement( diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java index 1e18a2f9..6ff5b9d3 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java @@ -4,10 +4,12 @@ import android.content.Context; import androidx.annotation.NonNull; import io.runtime.mcumgr.McuMgrCallback; +import io.runtime.mcumgr.McuMgrErrorCode; import io.runtime.mcumgr.McuMgrTransport; import io.runtime.mcumgr.ble.McuMgrBleTransport; import io.runtime.mcumgr.exception.McuMgrException; import io.runtime.mcumgr.managers.ImageManager; +import io.runtime.mcumgr.response.HasReturnCode; import io.runtime.mcumgr.response.img.McuMgrImageResponse; import io.runtime.mcumgr.response.img.McuMgrImageStateResponse; import org.jetbrains.annotations.Contract; @@ -36,6 +38,8 @@ public void beginErasure(final int imageIndex) setState(EAndroidFirmwareEraserState.ERASING); + AndroidFirmwareEraser self = this; + _imageManager = new ImageManager(_transport); _imageManager.erase(imageIndex, new McuMgrCallback() { @@ -44,25 +48,20 @@ public void onResponse(@NonNull final McuMgrImageResponse response) { if (!response.isSuccess()) { // check for an error return code - fatalErrorOccurredAdvertisement("Erasure failed (error-code '" + response.getReturnCode().toString() + "')"); - - setState(EAndroidFirmwareEraserState.FAILED); + self.onError("[AFE.BE.OR.010] Erasure failed (error-code '" + response.getReturnCode().toString() + "')", response.getReturnCode(), response.getGroupReturnCode()); return; } readImageErasure(); - setState(EAndroidFirmwareEraserState.COMPLETE); } @Override - public void onError(@NonNull final McuMgrException error) + public void onError(@NonNull final McuMgrException exception) { - fatalErrorOccurredAdvertisement("Erasure failed '" + error.getMessage() + "'"); + self.onError("[AFE.BE.OE.010] Erasure failed '" + exception.getMessage() + "'", exception); busyStateChangedAdvertisement(false); - - setState(EAndroidFirmwareEraserState.IDLE); } }); } @@ -104,7 +103,24 @@ public String getLastFatalErrorMessage() return _lastFatalErrorMessage; } - public void fatalErrorOccurredAdvertisement(final String errorMessage) + private void onError(final String errorMessage, final Exception exception) + { + onErrorImpl(errorMessage, McuMgrExceptionHelpers.DeduceGlobalErrorCodeFromException(exception)); + } + + private void onError(final String errorMessage, final McuMgrErrorCode exceptionCodeSpecs, final HasReturnCode.GroupReturnCode groupReturnCodeSpecs) + { + onErrorImpl(errorMessage, McuMgrExceptionHelpers.DeduceGlobalErrorCodeFromException(exceptionCodeSpecs, groupReturnCodeSpecs)); + } + + private void onErrorImpl(final String errorMessage, final int globalErrorCode) + { + setState(EAndroidFirmwareEraserState.FAILED); + + fatalErrorOccurredAdvertisement(errorMessage, globalErrorCode); + } + + public void fatalErrorOccurredAdvertisement(final String errorMessage, int globalErrorCode) { _lastFatalErrorMessage = errorMessage; //this method is meant to be overridden by csharp binding libraries to intercept updates } @@ -125,9 +141,10 @@ private void readImageErasure() { busyStateChangedAdvertisement(true); + AndroidFirmwareEraser self = this; + _imageManager.list(new McuMgrCallback() { - @Override public void onResponse(@NonNull final McuMgrImageStateResponse response) { @@ -136,9 +153,9 @@ public void onResponse(@NonNull final McuMgrImageStateResponse response) } @Override - public void onError(@NonNull final McuMgrException error) + public void onError(@NonNull final McuMgrException exception) { - fatalErrorOccurredAdvertisement(error.getMessage()); + self.onError("[AFE.RIE.OE.010] Failed to read firmware images after firmware erasure : " + exception.getMessage(), exception); busyStateChangedAdvertisement(false); } }); diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java index a5e8746f..01f7c921 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java @@ -113,7 +113,7 @@ public EAndroidFirmwareInstallationVerdict beginInstallation( } catch (final Exception ex2) { - onError(EAndroidFirmwareInstallerFatalErrorType.INVALID_FIRMWARE, ex2.getMessage(), ex); + onError(EAndroidFirmwareInstallerFatalErrorType.INVALID_FIRMWARE, ex2.getMessage(), ex2); return EAndroidFirmwareInstallationVerdict.FAILED__INVALID_DATA_FILE; } diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java index 4cd3d8d2..5cf37370 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/McuMgrExceptionHelpers.java @@ -1,20 +1,28 @@ package no.laerdal.mcumgr_laerdal_wrapper; +import io.runtime.mcumgr.McuMgrErrorCode; import io.runtime.mcumgr.exception.McuMgrErrorException; import io.runtime.mcumgr.response.HasReturnCode; final class McuMgrExceptionHelpers { // this method must be kept aligned between our ios lib and our android lib - public static int DeduceGlobalErrorCodeFromException(Exception exception) + public static int DeduceGlobalErrorCodeFromException(final Exception exception) { if (!(exception instanceof McuMgrErrorException)) return -99; McuMgrErrorException mcuMgrErrorException = (McuMgrErrorException) exception; + McuMgrErrorCode exceptionCodeSpecs = mcuMgrErrorException.getCode(); HasReturnCode.GroupReturnCode groupReturnCodeSpecs = mcuMgrErrorException.getGroupCode(); + + return DeduceGlobalErrorCodeFromException(exceptionCodeSpecs, groupReturnCodeSpecs); + } + + public static int DeduceGlobalErrorCodeFromException(final McuMgrErrorCode exceptionCodeSpecs, final HasReturnCode.GroupReturnCode groupReturnCodeSpecs) + { return groupReturnCodeSpecs == null - ? mcuMgrErrorException.getCode().value() // 00 + ? exceptionCodeSpecs.value() // 00 : (((groupReturnCodeSpecs.group + 1) * 1000) + groupReturnCodeSpecs.rc); // 10 //00 for auth errors and for nordic devices that do not support smp v2 these error codes occupy the range [0,999] diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSDeviceResetter.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSDeviceResetter.swift index a846172c..d63271b7 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSDeviceResetter.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSDeviceResetter.swift @@ -27,16 +27,12 @@ public class IOSDeviceResetter: NSObject { response, error in if (error != nil) { - self.fatalErrorOccurredAdvertisement("Reset failed: '\(error?.localizedDescription ?? "")'") - - self.setState(.failed) + self.onError("[IOSDR.BR.010] Reset failed: '\(error?.localizedDescription ?? "")'", error) return } if (response?.getError() != nil) { // check for an error return code - self.fatalErrorOccurredAdvertisement("Reset failed: '\(response?.getError()?.errorDescription ?? "N/A")'") - - self.setState(.failed) + self.onError("[IOSDR.BR.020] Reset failed: '\(response?.getError()?.errorDescription ?? "")'", response?.getError()) return } @@ -44,6 +40,12 @@ public class IOSDeviceResetter: NSObject { } } + private func onError(_ errorMessage: String, _ error: Error?) { + setState(.failed) + + fatalErrorOccurredAdvertisement(errorMessage, McuMgrExceptionHelpers.deduceGlobalErrorCodeFromException(error)) + } + @objc public func disconnect() { _transporter?.close() @@ -76,10 +78,10 @@ public class IOSDeviceResetter: NSObject { } //@objc dont - private func fatalErrorOccurredAdvertisement(_ errorMessage: String) { + private func fatalErrorOccurredAdvertisement(_ errorMessage: String, _ globalErrorCode: Int) { _lastFatalErrorMessage = errorMessage - _listener.fatalErrorOccurredAdvertisement(errorMessage) + _listener.fatalErrorOccurredAdvertisement(errorMessage, globalErrorCode) } //@objc dont diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift index a08bab71..76715b72 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileDownloader.swift @@ -60,26 +60,26 @@ public class IOSFileDownloader: NSObject { public func beginDownload(_ remoteFilePath: String) -> EIOSFileDownloadingInitializationVerdict { if !isCold() { //keep first if another download is already in progress we bail out - onError("Another download is already in progress") + onError("[IOSFD.BD.010] Another download is already in progress") return .failedDownloadAlreadyInProgress } _remoteFilePathSanitized = remoteFilePath.trimmingCharacters(in: .whitespacesAndNewlines) if _remoteFilePathSanitized.isEmpty { - onError("Target-file provided is dud!") + onError("[IOSFD.BD.020] Target-file provided is dud!") return .failedInvalidSettings } if _remoteFilePathSanitized.hasSuffix("/") { - onError("Target-file points to a directory instead of a file") + onError("[IOSFD.BD.030] Target-file points to a directory instead of a file") return .failedInvalidSettings } if !_remoteFilePathSanitized.hasPrefix("/") { - onError("Target-path is not absolute!") + onError("[IOSFD.BD.040] Target-path is not absolute!") return .failedInvalidSettings } @@ -91,7 +91,7 @@ public class IOSFileDownloader: NSObject { let success = _fileSystemManager.download(name: _remoteFilePathSanitized, delegate: self) if !success { - onError("Failed to commence file-Downloading (check logs for details)") + onError("[IOSFD.BD.050] Failed to commence file-Downloading (check logs for details)") return .failedErrorUponCommencing } @@ -181,11 +181,9 @@ public class IOSFileDownloader: NSObject { //@objc dont private func onError(_ errorMessage: String, _ error: Error? = nil) { - setState(.error) //keep first - - _lastFatalErrorMessage = errorMessage - - _listener.fatalErrorOccurredAdvertisement( + _lastFatalErrorMessage = errorMessage // order + setState(.error) // order + _listener.fatalErrorOccurredAdvertisement( // order _remoteFilePathSanitized, errorMessage, McuMgrExceptionHelpers.deduceGlobalErrorCodeFromException(error) diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift index fc10cb33..3b18cbc5 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFileUploader.swift @@ -66,51 +66,51 @@ public class IOSFileUploader: NSObject { ) -> EIOSFileUploadingInitializationVerdict { if !isCold() { //keep first if another upload is already in progress we bail out - onError("Another upload is already in progress") + onError("[IOSFU.BU.010] Another upload is already in progress") return .failedOtherUploadAlreadyInProgress } _remoteFilePathSanitized = remoteFilePath.trimmingCharacters(in: .whitespacesAndNewlines) if _remoteFilePathSanitized.isEmpty { - onError("Target-file provided is dud") + onError("[IOSFU.BU.020] Target-file provided is dud") return .failedInvalidSettings } if _remoteFilePathSanitized.hasSuffix("/") { - onError("Target-file points to a directory instead of a file") + onError("[IOSFU.BU.030] Target-file points to a directory instead of a file") return .failedInvalidSettings } if !_remoteFilePathSanitized.hasPrefix("/") { - onError("Target-path is not absolute") + onError("[IOSFU.BU.040] Target-path is not absolute") return .failedInvalidSettings } if data == nil { // data being nil is not ok btw data.length==0 is perfectly ok because we might want to create empty files - onError("The data provided are nil") + onError("[IOSFU.BU.050] The data provided are nil") return .failedInvalidData } if _cbPeripheral == nil { - onError("No bluetooth-device specified - call trySetBluetoothDevice() first"); + onError("[IOSFU.BU.060] No bluetooth-device specified - call trySetBluetoothDevice() first"); return .failedInvalidSettings; } if (pipelineDepth >= 2 && byteAlignment <= 1) { - onError("When pipeline-depth is set to 2 or above you must specify a byte-alignment >=2 (given byte-alignment is '\(byteAlignment)')") + onError("[IOSFU.BU.070] When pipeline-depth is set to 2 or above you must specify a byte-alignment >=2 (given byte-alignment is '\(byteAlignment)')") return .failedInvalidSettings } let byteAlignmentEnum = translateByteAlignmentMode(byteAlignment); if (byteAlignmentEnum == nil) { - onError("Invalid byte-alignment value '\(byteAlignment)': It must be a power of 2 up to 16") + onError("[IOSFU.BU.080] Invalid byte-alignment value '\(byteAlignment)': It must be a power of 2 up to 16") return .failedInvalidSettings } @@ -132,13 +132,13 @@ public class IOSFileUploader: NSObject { delegate: self ) if !success { - onError("Failed to commence file-uploading (check logs for details)") + onError("[IOSFU.BU.090] Failed to commence file-uploading (check logs for details)") return .failedErrorUponCommencing } return .success - + //00 normally we shouldnt need this but there seems to be a bug in the lib https://github.com/NordicSemiconductor/IOS-nRF-Connect-Device-Manager/issues/209 } @@ -246,11 +246,10 @@ public class IOSFileUploader: NSObject { //@objc dont private func onError(_ errorMessage: String, _ error: Error? = nil) { - setState(.error) //keep first - _lastFatalErrorMessage = errorMessage - _listener.fatalErrorOccurredAdvertisement( + setState(.error) // order + _listener.fatalErrorOccurredAdvertisement( // order _remoteFilePathSanitized, errorMessage, McuMgrExceptionHelpers.deduceGlobalErrorCodeFromException(error) diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareEraser.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareEraser.swift index 164645d5..15209b17 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareEraser.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareEraser.swift @@ -20,22 +20,21 @@ public class IOSFirmwareEraser: NSObject { public func beginErasure(_ imageIndex: Int) { busyStateChangedAdvertisement(true) - setState(EIOSFirmwareEraserState.erasing) + setState(.erasing) _manager = ImageManager(transport: _transporter) _manager.logDelegate = self _manager.erase { response, error in + if (error != nil) { - self.fatalErrorOccurredAdvertisement(error?.localizedDescription ?? "An unspecified error occurred") - self.busyStateChangedAdvertisement(false) - self.setState(EIOSFirmwareEraserState.failed) + self.onError("[IOSFE.BE.010] Failed to start firmware erasure: \(error?.localizedDescription ?? "An unspecified error occurred")", error) return } self.readImageErasure() - self.setState(EIOSFirmwareEraserState.complete) + self.setState(.complete) } } @@ -44,6 +43,12 @@ public class IOSFirmwareEraser: NSObject { _transporter?.close() } + private func onError(_ errorMessage: String, _ error: Error?) { + setState(.failed) + fatalErrorOccurredAdvertisement(errorMessage, McuMgrExceptionHelpers.deduceGlobalErrorCodeFromException(error)) + busyStateChangedAdvertisement(false) + } + private var _lastFatalErrorMessage: String @objc @@ -60,10 +65,9 @@ public class IOSFirmwareEraser: NSObject { } //@objc dont - private func fatalErrorOccurredAdvertisement(_ errorMessage: String) { + private func fatalErrorOccurredAdvertisement(_ errorMessage: String, _ globalErrorCode: Int) { _lastFatalErrorMessage = errorMessage //this method is meant to be overridden by csharp binding libraries to intercept updates - - _listener.fatalErrorOccurredAdvertisement(errorMessage) + _listener.fatalErrorOccurredAdvertisement(errorMessage, globalErrorCode) } //@objc dont @@ -90,9 +94,9 @@ public class IOSFirmwareEraser: NSObject { _manager.list { response, error in + if (error != nil) { - self.fatalErrorOccurredAdvertisement(error?.localizedDescription ?? "An unspecified error occurred") - self.busyStateChangedAdvertisement(false) + self.onError("[IOSFE.RIE.010] Failed to read firmware images after firmware-erasure completed: \(error?.localizedDescription ?? "An unspecified error occurred")", error) return } diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareInstaller.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareInstaller.swift index 95cb2c6a..1689f8f1 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareInstaller.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareInstaller.swift @@ -38,27 +38,27 @@ public class IOSFirmwareInstaller: NSObject { _lastBytesSendTimestamp = nil if (imageData.isEmpty) { - emitFatalError(.invalidFirmware, "The firmware data-bytes given are dud!") + emitFatalError(.invalidFirmware, "[IOSFI.BI.010] The firmware data-bytes given are dud!") return .failedInvalidFirmware } if (pipelineDepth >= 2 && byteAlignment <= 1) { - emitFatalError(.invalidSettings, "When pipeline-depth is set to 2 or above you must specify a byte-alignment >=2 (given byte-alignment is '\(byteAlignment)')") + emitFatalError(.invalidSettings, "[IOSFI.BI.020] When pipeline-depth is set to 2 or above you must specify a byte-alignment >=2 (given byte-alignment is '\(byteAlignment)')") return .failedInvalidSettings } let byteAlignmentEnum = translateByteAlignmentMode(byteAlignment); if (byteAlignmentEnum == nil) { - emitFatalError(.invalidSettings, "Invalid byte-alignment value '\(byteAlignment)': It must be a power of 2 up to 16") + emitFatalError(.invalidSettings, "[IOSFI.BI.030] Invalid byte-alignment value '\(byteAlignment)': It must be a power of 2 up to 16") return .failedInvalidSettings } if (estimatedSwapTimeInMilliseconds >= 0 && estimatedSwapTimeInMilliseconds <= 1000) { //its better to just warn the calling environment instead of erroring out logMessageAdvertisement( - "Estimated swap-time of '\(estimatedSwapTimeInMilliseconds)' milliseconds seems suspiciously low - did you mean to say '\(estimatedSwapTimeInMilliseconds * 1000)' milliseconds?", + "[IOSFI.BI.040] Estimated swap-time of '\(estimatedSwapTimeInMilliseconds)' milliseconds seems suspiciously low - did you mean to say '\(estimatedSwapTimeInMilliseconds * 1000)' milliseconds?", "firmware-installer", iOSMcuManagerLibrary.McuMgrLogLevel.warning.name ) @@ -84,7 +84,7 @@ public class IOSFirmwareInstaller: NSObject { } } catch let ex { - emitFatalError(.invalidSettings, ex.localizedDescription) + emitFatalError(.invalidSettings, "[IOSFI.BI.050] Failed to configure the firmware-installer: '\(ex.localizedDescription)") return .failedInvalidSettings } @@ -93,17 +93,19 @@ public class IOSFirmwareInstaller: NSObject { setState(.idle) try _manager.start( - images: [ImageManager.Image( //2 - image: 0, - slot: 1, - hash: try McuMgrImage(data: imageData).hash, - data: imageData - )], - using: firmwareUpgradeConfiguration + images: [ + ImageManager.Image( //2 + image: 0, + slot: 1, + hash: try McuMgrImage(data: imageData).hash, + data: imageData + ) + ], + using: firmwareUpgradeConfiguration ) } catch let ex { - emitFatalError(.deploymentFailed, ex.localizedDescription) + emitFatalError(.deploymentFailed, "[IOSFI.BI.060] Failed to launch the installation process: '\(ex.localizedDescription)") return .failedDeploymentError } diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForDeviceResetter.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForDeviceResetter.swift index a9f2c8c1..efb6eb51 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForDeviceResetter.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForDeviceResetter.swift @@ -9,6 +9,6 @@ import Foundation @objc public protocol IOSListenerForDeviceResetter { func logMessageAdvertisement(_ message: String, _ category: String, _ level: String) - func fatalErrorOccurredAdvertisement(_ errorMessage: String) + func fatalErrorOccurredAdvertisement(_ errorMessage: String, _ globalErrorCode: Int) func stateChangedAdvertisement(_ oldState: EIOSDeviceResetterState, _ newState: EIOSDeviceResetterState) } diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFirmwareEraser.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFirmwareEraser.swift index 49265884..cd6d37eb 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFirmwareEraser.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSListenerForFirmwareEraser.swift @@ -9,7 +9,7 @@ import Foundation @objc public protocol IOSListenerForFirmwareEraser { func logMessageAdvertisement(_ message: String, _ category: String, _ level: String) - func fatalErrorOccurredAdvertisement(_ errorMessage: String) + func fatalErrorOccurredAdvertisement(_ errorMessage: String, _ globalErrorCode: Int) func stateChangedAdvertisement(_ oldState: EIOSFirmwareEraserState, _ newState: EIOSFirmwareEraserState) func busyStateChangedAdvertisement(_ busyNotIdle: Bool) } diff --git a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowDeviceResetterErroredOutException_GivenBluetoothErrorDuringReset.cs b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowDeviceResetterErroredOutException_GivenBluetoothErrorDuringReset.cs index 54463534..b5443d3e 100644 --- a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowDeviceResetterErroredOutException_GivenBluetoothErrorDuringReset.cs +++ b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowDeviceResetterErroredOutException_GivenBluetoothErrorDuringReset.cs @@ -1,4 +1,5 @@ using FluentAssertions; +using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Helpers; using Laerdal.McuMgr.DeviceResetter.Contracts.Enums; using Laerdal.McuMgr.DeviceResetter.Contracts.Events; @@ -59,7 +60,7 @@ public override void BeginReset() await Task.Delay(20); StateChangedAdvertisement(oldState: EDeviceResetterState.Resetting, newState: EDeviceResetterState.Failed); - FatalErrorOccurredAdvertisement("bluetooth error blah blah"); + FatalErrorOccurredAdvertisement("bluetooth error blah blah", EGlobalErrorCode.Generic); //00 simulating the state changes in a background thread is vital in order to simulate the async nature of the native resetter }); diff --git a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.cs b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.cs index 7dd9efe6..8861ed5a 100644 --- a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.cs +++ b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.cs @@ -40,16 +40,16 @@ public virtual void Disconnect() } public void LogMessageAdvertisement(string message, string category, ELogLevel level) - => _resetterCallbacksProxy.LogMessageAdvertisement(message, category, level); //raises the actual event + => _resetterCallbacksProxy?.LogMessageAdvertisement(message, category, level); //raises the actual event public void StateChangedAdvertisement(EDeviceResetterState oldState, EDeviceResetterState newState) { State = newState; - _resetterCallbacksProxy.StateChangedAdvertisement(newState: newState, oldState: oldState); //raises the actual event + _resetterCallbacksProxy?.StateChangedAdvertisement(newState: newState, oldState: oldState); //raises the actual event } - public void FatalErrorOccurredAdvertisement(string errorMessage) - => _resetterCallbacksProxy.FatalErrorOccurredAdvertisement(errorMessage); //raises the actual event + public void FatalErrorOccurredAdvertisement(string errorMessage, EGlobalErrorCode globalErrorCode) + => _resetterCallbacksProxy?.FatalErrorOccurredAdvertisement(errorMessage, globalErrorCode); //raises the actual event } } } \ No newline at end of file diff --git a/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.cs b/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.cs index 9010f196..5bf70aa4 100644 --- a/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.cs +++ b/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.cs @@ -38,16 +38,16 @@ public virtual void Disconnect() } public void LogMessageAdvertisement(string message, string category, ELogLevel level) - => _eraserCallbacksProxy.LogMessageAdvertisement(message, category, level); //raises the actual event + => _eraserCallbacksProxy?.LogMessageAdvertisement(message, category, level); //raises the actual event public void StateChangedAdvertisement(EFirmwareErasureState oldState, EFirmwareErasureState newState) - => _eraserCallbacksProxy.StateChangedAdvertisement(newState: newState, oldState: oldState); //raises the actual event + => _eraserCallbacksProxy?.StateChangedAdvertisement(newState: newState, oldState: oldState); //raises the actual event public void BusyStateChangedAdvertisement(bool busyNotIdle) - => _eraserCallbacksProxy.BusyStateChangedAdvertisement(busyNotIdle); //raises the actual event + => _eraserCallbacksProxy?.BusyStateChangedAdvertisement(busyNotIdle); //raises the actual event - public void FatalErrorOccurredAdvertisement(string errorMessage) - => _eraserCallbacksProxy.FatalErrorOccurredAdvertisement(errorMessage); //raises the actual event + public void FatalErrorOccurredAdvertisement(string errorMessage, EGlobalErrorCode globalErrorCode) + => _eraserCallbacksProxy?.FatalErrorOccurredAdvertisement(errorMessage, globalErrorCode); //raises the actual event } } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Droid/DeviceResetter/DeviceResetter.cs b/Laerdal.McuMgr/Droid/DeviceResetter/DeviceResetter.cs index afc013d1..f00c1ad2 100644 --- a/Laerdal.McuMgr/Droid/DeviceResetter/DeviceResetter.cs +++ b/Laerdal.McuMgr/Droid/DeviceResetter/DeviceResetter.cs @@ -49,20 +49,27 @@ public IDeviceResetterEventEmittable DeviceResetter //keep this to conform to th public EDeviceResetterState State => TranslateEAndroidDeviceResetterState(base.State ?? EAndroidDeviceResetterState.None); // ReSharper disable once UnusedMember.Local - private AndroidNativeDeviceResetterAdapterProxy(IntPtr javaReference, JniHandleOwnership transfer) : base(javaReference, transfer) + private AndroidNativeDeviceResetterAdapterProxy(IntPtr javaReference, JniHandleOwnership transfer) + : base(javaReference, transfer) { } - internal AndroidNativeDeviceResetterAdapterProxy(INativeDeviceResetterCallbacksProxy deviceResetterCallbacksProxy, Context context, BluetoothDevice bluetoothDevice) : base(context, bluetoothDevice) + internal AndroidNativeDeviceResetterAdapterProxy(INativeDeviceResetterCallbacksProxy deviceResetterCallbacksProxy, Context context, BluetoothDevice bluetoothDevice) + : base(context, bluetoothDevice) { _deviceResetterCallbacksProxy = deviceResetterCallbacksProxy ?? throw new ArgumentNullException(nameof(deviceResetterCallbacksProxy)); } - public override void FatalErrorOccurredAdvertisement(string errorMessage) + public override void FatalErrorOccurredAdvertisement(string errorMessage, int globalErrorCode) { - base.FatalErrorOccurredAdvertisement(errorMessage); + base.FatalErrorOccurredAdvertisement(errorMessage, globalErrorCode); - _deviceResetterCallbacksProxy?.FatalErrorOccurredAdvertisement(errorMessage); + FatalErrorOccurredAdvertisement(errorMessage, (EGlobalErrorCode) globalErrorCode); + } + + public void FatalErrorOccurredAdvertisement(string errorMessage, EGlobalErrorCode globalErrorCode) + { + _deviceResetterCallbacksProxy?.FatalErrorOccurredAdvertisement(errorMessage, globalErrorCode); } public override void StateChangedAdvertisement(EAndroidDeviceResetterState oldState, EAndroidDeviceResetterState newState) @@ -75,7 +82,7 @@ public override void StateChangedAdvertisement(EAndroidDeviceResetterState oldSt ); } - //keep this method to adhere to the interface + //keep this override it is needed to conform to the interface public void StateChangedAdvertisement(EDeviceResetterState oldState, EDeviceResetterState newState) { _deviceResetterCallbacksProxy?.StateChangedAdvertisement( @@ -95,7 +102,7 @@ public override void LogMessageAdvertisement(string message, string category, st ); } - //keep this override its needed to conform to the interface + //keep this override it is needed to conform to the interface public void LogMessageAdvertisement(string message, string category, ELogLevel level) { _deviceResetterCallbacksProxy?.LogMessageAdvertisement(message, category, level); diff --git a/Laerdal.McuMgr/Droid/FirmwareEraser/FirmwareEraser.cs b/Laerdal.McuMgr/Droid/FirmwareEraser/FirmwareEraser.cs index 8447e90b..2b23858f 100644 --- a/Laerdal.McuMgr/Droid/FirmwareEraser/FirmwareEraser.cs +++ b/Laerdal.McuMgr/Droid/FirmwareEraser/FirmwareEraser.cs @@ -59,7 +59,7 @@ internal AndroidNativeFirmwareEraserAdapterProxy(INativeFirmwareEraserCallbacksP _nativeEraserCallbacksProxy = eraserCallbacksProxy ?? throw new ArgumentNullException(nameof(eraserCallbacksProxy)); //composition-over-inheritance } - + public IFirmwareEraserEventEmittable FirmwareEraser //keep this to conform to the interface { get => _nativeEraserCallbacksProxy!.FirmwareEraser; @@ -69,28 +69,36 @@ public IFirmwareEraserEventEmittable FirmwareEraser //keep this to conform to th public override void StateChangedAdvertisement(EAndroidFirmwareEraserState oldState, EAndroidFirmwareEraserState newState) { base.StateChangedAdvertisement(oldState, newState); - - StateChangedAdvertisement(newState: TranslateEAndroidFirmwareEraserState(newState), oldState: TranslateEAndroidFirmwareEraserState(oldState)); + + StateChangedAdvertisement( + newState: TranslateEAndroidFirmwareEraserState(newState), + oldState: TranslateEAndroidFirmwareEraserState(oldState) + ); } //keep this override its needed to conform to the interface public void StateChangedAdvertisement(EFirmwareErasureState oldState, EFirmwareErasureState newState) { - _nativeEraserCallbacksProxy.StateChangedAdvertisement(newState: newState, oldState: oldState); + _nativeEraserCallbacksProxy?.StateChangedAdvertisement(newState: newState, oldState: oldState); } public override void BusyStateChangedAdvertisement(bool busyNotIdle) { base.BusyStateChangedAdvertisement(busyNotIdle); //just in case - _nativeEraserCallbacksProxy.BusyStateChangedAdvertisement(busyNotIdle); + _nativeEraserCallbacksProxy?.BusyStateChangedAdvertisement(busyNotIdle); } - public override void FatalErrorOccurredAdvertisement(string errorMessage) + public override void FatalErrorOccurredAdvertisement(string errorMessage, int globalErrorCode) { - base.FatalErrorOccurredAdvertisement(errorMessage); - - _nativeEraserCallbacksProxy.FatalErrorOccurredAdvertisement(errorMessage); + base.FatalErrorOccurredAdvertisement(errorMessage, globalErrorCode); + + FatalErrorOccurredAdvertisement(errorMessage, (EGlobalErrorCode) globalErrorCode); + } + + public void FatalErrorOccurredAdvertisement(string errorMessage, EGlobalErrorCode globalErrorCode) + { + _nativeEraserCallbacksProxy?.FatalErrorOccurredAdvertisement(errorMessage, globalErrorCode); } public override void LogMessageAdvertisement(string message, string category, string level) @@ -107,7 +115,7 @@ public override void LogMessageAdvertisement(string message, string category, st //keep this override its needed to conform to the interface public void LogMessageAdvertisement(string message, string category, ELogLevel level) { - _nativeEraserCallbacksProxy.LogMessageAdvertisement(message, category, level); + _nativeEraserCallbacksProxy?.LogMessageAdvertisement(message, category, level); } // ReSharper disable once MemberCanBePrivate.Global diff --git a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Native/INativeDeviceResetterCallbacksProxy.cs b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Native/INativeDeviceResetterCallbacksProxy.cs index 8e379c36..a99ed3b7 100644 --- a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Native/INativeDeviceResetterCallbacksProxy.cs +++ b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Native/INativeDeviceResetterCallbacksProxy.cs @@ -11,6 +11,6 @@ internal interface INativeDeviceResetterCallbacksProxy public void StateChangedAdvertisement(EDeviceResetterState oldState, EDeviceResetterState newState); - public void FatalErrorOccurredAdvertisement(string errorMessage); + public void FatalErrorOccurredAdvertisement(string errorMessage, EGlobalErrorCode globalErrorCode); } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/DeviceResetter/DeviceResetter.cs b/Laerdal.McuMgr/Shared/DeviceResetter/DeviceResetter.cs index a4d42557..f45a586c 100644 --- a/Laerdal.McuMgr/Shared/DeviceResetter/DeviceResetter.cs +++ b/Laerdal.McuMgr/Shared/DeviceResetter/DeviceResetter.cs @@ -18,8 +18,6 @@ namespace Laerdal.McuMgr.DeviceResetter /// public partial class DeviceResetter : IDeviceResetter, IDeviceResetterEventEmittable { - - //this sort of approach proved to be necessary for our testsuite to be able to effectively mock away the INativeDeviceResetterProxy internal class GenericNativeDeviceResetterCallbacksProxy : INativeDeviceResetterCallbacksProxy { @@ -39,7 +37,7 @@ public void StateChangedAdvertisement(EDeviceResetterState oldState, EDeviceRese oldState: oldState )); - public void FatalErrorOccurredAdvertisement(string errorMessage) + public void FatalErrorOccurredAdvertisement(string errorMessage, EGlobalErrorCode globalErrorCode) => DeviceResetter?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs(errorMessage)); } diff --git a/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Events/FatalErrorOccurredEventArgs.cs b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Events/FatalErrorOccurredEventArgs.cs index d80de914..c6a3f88f 100644 --- a/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Events/FatalErrorOccurredEventArgs.cs +++ b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Events/FatalErrorOccurredEventArgs.cs @@ -1,6 +1,7 @@ // ReSharper disable MemberCanBePrivate.Global // ReSharper disable ClassNeverInstantiated.Global +using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Events; namespace Laerdal.McuMgr.FirmwareEraser.Contracts.Events @@ -9,7 +10,7 @@ namespace Laerdal.McuMgr.FirmwareEraser.Contracts.Events { public string ErrorMessage { get; } - public FatalErrorOccurredEventArgs(string errorMessage) + public FatalErrorOccurredEventArgs(string errorMessage, EGlobalErrorCode globalErrorCode) { ErrorMessage = errorMessage; } diff --git a/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Native/INativeFirmwareEraserCallbacksProxy.cs b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Native/INativeFirmwareEraserCallbacksProxy.cs index d4a6e922..18e5ad91 100644 --- a/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Native/INativeFirmwareEraserCallbacksProxy.cs +++ b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Native/INativeFirmwareEraserCallbacksProxy.cs @@ -10,6 +10,6 @@ internal interface INativeFirmwareEraserCallbacksProxy void LogMessageAdvertisement(string message, string category, ELogLevel level); void StateChangedAdvertisement(EFirmwareErasureState oldState, EFirmwareErasureState newState); void BusyStateChangedAdvertisement(bool busyNotIdle); - void FatalErrorOccurredAdvertisement(string errorMessage); + void FatalErrorOccurredAdvertisement(string errorMessage, EGlobalErrorCode globalErrorCode); } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FirmwareEraser/FirmwareEraser.cs b/Laerdal.McuMgr/Shared/FirmwareEraser/FirmwareEraser.cs index c2504060..388aece6 100644 --- a/Laerdal.McuMgr/Shared/FirmwareEraser/FirmwareEraser.cs +++ b/Laerdal.McuMgr/Shared/FirmwareEraser/FirmwareEraser.cs @@ -42,8 +42,8 @@ public void StateChangedAdvertisement(EFirmwareErasureState oldState, EFirmwareE public void BusyStateChangedAdvertisement(bool busyNotIdle) => FirmwareEraser.OnBusyStateChanged(new BusyStateChangedEventArgs(busyNotIdle)); - public void FatalErrorOccurredAdvertisement(string errorMessage) - => FirmwareEraser.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs(errorMessage)); + public void FatalErrorOccurredAdvertisement(string errorMessage, EGlobalErrorCode globalErrorCode) + => FirmwareEraser.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs(errorMessage, globalErrorCode)); } private readonly INativeFirmwareEraserProxy _nativeFirmwareEraserProxy; diff --git a/Laerdal.McuMgr/iOS/DeviceResetter/DeviceResetter.cs b/Laerdal.McuMgr/iOS/DeviceResetter/DeviceResetter.cs index 34fc6ee0..5dd0233a 100644 --- a/Laerdal.McuMgr/iOS/DeviceResetter/DeviceResetter.cs +++ b/Laerdal.McuMgr/iOS/DeviceResetter/DeviceResetter.cs @@ -88,9 +88,13 @@ public void StateChangedAdvertisement(EDeviceResetterState oldState, EDeviceRese oldState: oldState ); - public override void FatalErrorOccurredAdvertisement(string errorMessage) + public override void FatalErrorOccurredAdvertisement(string errorMessage, nint globalErrorCode) + => FatalErrorOccurredAdvertisement(errorMessage, (EGlobalErrorCode)globalErrorCode); + + public void FatalErrorOccurredAdvertisement(string errorMessage, EGlobalErrorCode globalErrorCode) => _nativeResetterCallbacksProxy?.FatalErrorOccurredAdvertisement( - errorMessage: errorMessage + errorMessage: errorMessage, + globalErrorCode: globalErrorCode ); #endregion listener events diff --git a/Laerdal.McuMgr/iOS/FirmwareEraser/FirmwareEraser.cs b/Laerdal.McuMgr/iOS/FirmwareEraser/FirmwareEraser.cs index 8cd90a89..0aa0703f 100644 --- a/Laerdal.McuMgr/iOS/FirmwareEraser/FirmwareEraser.cs +++ b/Laerdal.McuMgr/iOS/FirmwareEraser/FirmwareEraser.cs @@ -88,8 +88,13 @@ public void StateChangedAdvertisement(EFirmwareErasureState oldState, EFirmwareE oldState: oldState ); - public override void BusyStateChangedAdvertisement(bool busyNotIdle) => _nativeFirmwareEraserCallbacksProxy?.BusyStateChangedAdvertisement(busyNotIdle); - public override void FatalErrorOccurredAdvertisement(string errorMessage) => _nativeFirmwareEraserCallbacksProxy?.FatalErrorOccurredAdvertisement(errorMessage); + public override void BusyStateChangedAdvertisement(bool busyNotIdle) + => _nativeFirmwareEraserCallbacksProxy?.BusyStateChangedAdvertisement(busyNotIdle); + + public override void FatalErrorOccurredAdvertisement(string errorMessage, nint globalErrorCode) + => FatalErrorOccurredAdvertisement(errorMessage, (EGlobalErrorCode)globalErrorCode); + public void FatalErrorOccurredAdvertisement(string errorMessage, EGlobalErrorCode globalErrorCode) + => _nativeFirmwareEraserCallbacksProxy?.FatalErrorOccurredAdvertisement(errorMessage, globalErrorCode); #endregion @@ -98,6 +103,7 @@ public void StateChangedAdvertisement(EFirmwareErasureState oldState, EFirmwareE { EIOSFirmwareEraserState.None => EFirmwareErasureState.None, EIOSFirmwareEraserState.Idle => EFirmwareErasureState.Idle, + EIOSFirmwareEraserState.Failed => EFirmwareErasureState.Failed, EIOSFirmwareEraserState.Erasing => EFirmwareErasureState.Erasing, EIOSFirmwareEraserState.Complete => EFirmwareErasureState.Complete, _ => throw new ArgumentOutOfRangeException(nameof(state), state, "Unknown enum value") From c1e12ff00be67059720ddfa9746914d4505687a3 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Tue, 29 Oct 2024 18:00:54 +0100 Subject: [PATCH 100/104] refa (DeviceResetter, FirmwareEraser): we now use global error codes to figure out the native errors instead of string-sniffing --- .../Exceptions/UnauthorizedException.cs | 8 +++-- .../Events/FatalErrorOccurredEventArgs.cs | 7 +++-- .../DeviceResetterErroredOutException.cs | 6 +++- .../Shared/DeviceResetter/DeviceResetter.cs | 27 ++++++++--------- .../Exceptions/DownloadErroredOutException.cs | 10 +++++-- .../Shared/FileDownloader/FileDownloader.cs | 5 ++-- .../AllUploadAttemptsFailedException.cs | 2 +- .../Exceptions/UploadErroredOutException.cs | 11 ++----- .../UploadInternalErrorException.cs | 2 +- .../Exceptions/UploadTimeoutException.cs | 2 +- .../Exceptions/UploadUnauthorizedException.cs | 4 +-- .../Shared/FileUploader/FileUploader.cs | 4 +-- .../Events/FatalErrorOccurredEventArgs.cs | 4 ++- .../FirmwareErasureErroredOutException.cs | 6 +++- .../Shared/FirmwareEraser/FirmwareEraser.cs | 25 +++++++--------- ...lationConfirmationStageTimeoutException.cs | 9 ++++-- ...FirmwareInstallationErroredOutException.cs | 12 ++++++-- ...lationUploadingStageErroredOutException.cs | 6 ++-- .../FirmwareInstaller/FirmwareInstaller.cs | 29 +++++++------------ 19 files changed, 94 insertions(+), 85 deletions(-) diff --git a/Laerdal.McuMgr/Shared/Common/Exceptions/UnauthorizedException.cs b/Laerdal.McuMgr/Shared/Common/Exceptions/UnauthorizedException.cs index 0aa43690..30d9d675 100644 --- a/Laerdal.McuMgr/Shared/Common/Exceptions/UnauthorizedException.cs +++ b/Laerdal.McuMgr/Shared/Common/Exceptions/UnauthorizedException.cs @@ -3,13 +3,15 @@ namespace Laerdal.McuMgr.Common.Exceptions { - public class UnauthorizedException : Exception, IMcuMgrException //todo get rid of this once we refactor all classes to use their own unauthorized exceptions + public class UnauthorizedException : Exception, IMcuMgrException { public string Resource { get; } = ""; + public EGlobalErrorCode GlobalErrorCode { get; } - public UnauthorizedException(string nativeErrorMessage) - : base($"Operation denied because it's not authorized: '{nativeErrorMessage}'") + public UnauthorizedException(string nativeErrorMessage, EGlobalErrorCode globalErrorCode) + : base($"Operation denied because it's not authorized: '{nativeErrorMessage}' (globalErrorCode={globalErrorCode})") { + GlobalErrorCode = globalErrorCode; } public UnauthorizedException(string nativeErrorMessage, string resource) diff --git a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Events/FatalErrorOccurredEventArgs.cs b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Events/FatalErrorOccurredEventArgs.cs index e885d19e..43fd0f95 100644 --- a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Events/FatalErrorOccurredEventArgs.cs +++ b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Events/FatalErrorOccurredEventArgs.cs @@ -1,6 +1,7 @@ // ReSharper disable MemberCanBePrivate.Global // ReSharper disable ClassNeverInstantiated.Global +using Laerdal.McuMgr.Common.Enums; using Laerdal.McuMgr.Common.Events; namespace Laerdal.McuMgr.DeviceResetter.Contracts.Events @@ -8,10 +9,12 @@ namespace Laerdal.McuMgr.DeviceResetter.Contracts.Events public readonly struct FatalErrorOccurredEventArgs : IMcuMgrEventArgs { public string ErrorMessage { get; } - - public FatalErrorOccurredEventArgs(string errorMessage) + public EGlobalErrorCode GlobalErrorCode { get; } + + public FatalErrorOccurredEventArgs(string errorMessage, EGlobalErrorCode globalErrorCode) { ErrorMessage = errorMessage; + GlobalErrorCode = globalErrorCode; } } } diff --git a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Exceptions/DeviceResetterErroredOutException.cs b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Exceptions/DeviceResetterErroredOutException.cs index d545169e..c1663b00 100644 --- a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Exceptions/DeviceResetterErroredOutException.cs +++ b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Exceptions/DeviceResetterErroredOutException.cs @@ -1,11 +1,15 @@ using System; +using Laerdal.McuMgr.Common.Enums; namespace Laerdal.McuMgr.DeviceResetter.Contracts.Exceptions { public class DeviceResetterErroredOutException : Exception, IDeviceResetterException { - public DeviceResetterErroredOutException(string errorMessage) : base($"An error occurred while resetting/rebooting the device: '{errorMessage}'") + public EGlobalErrorCode GlobalErrorCode { get; } = EGlobalErrorCode.Unset; + + public DeviceResetterErroredOutException(string errorMessage, EGlobalErrorCode globalErrorCode) : base($"An error occurred while resetting/rebooting the device: '{errorMessage}'") { + GlobalErrorCode = globalErrorCode; } public DeviceResetterErroredOutException(string errorMessage, Exception innerException) : base($"An error occurred while resetting/rebooting the device: '{errorMessage}'", innerException) diff --git a/Laerdal.McuMgr/Shared/DeviceResetter/DeviceResetter.cs b/Laerdal.McuMgr/Shared/DeviceResetter/DeviceResetter.cs index f45a586c..50e67893 100644 --- a/Laerdal.McuMgr/Shared/DeviceResetter/DeviceResetter.cs +++ b/Laerdal.McuMgr/Shared/DeviceResetter/DeviceResetter.cs @@ -38,7 +38,7 @@ public void StateChangedAdvertisement(EDeviceResetterState oldState, EDeviceRese )); public void FatalErrorOccurredAdvertisement(string errorMessage, EGlobalErrorCode globalErrorCode) - => DeviceResetter?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs(errorMessage)); + => DeviceResetter?.OnFatalErrorOccurred(new FatalErrorOccurredEventArgs(errorMessage, globalErrorCode)); } private readonly INativeDeviceResetterProxy _nativeDeviceResetterProxy; @@ -96,8 +96,8 @@ public async Task ResetAsync(int timeoutInMs = -1) try { - StateChanged += ResetAsyncOnStateChanged; - FatalErrorOccurred += ResetAsyncOnFatalErrorOccurred; + StateChanged += DeviceResetter_StateChanged_; + FatalErrorOccurred += DeviceResetter_FatalErrorOccurred_; BeginReset(); //00 dont use task.run here for now @@ -131,30 +131,27 @@ ex is not ArgumentException //10 wops probably missing native lib symbols! } finally { - StateChanged -= ResetAsyncOnStateChanged; - FatalErrorOccurred -= ResetAsyncOnFatalErrorOccurred; + StateChanged -= DeviceResetter_StateChanged_; + FatalErrorOccurred -= DeviceResetter_FatalErrorOccurred_; } return; - void ResetAsyncOnStateChanged(object sender, StateChangedEventArgs ea) + void DeviceResetter_StateChanged_(object _, StateChangedEventArgs ea_) { - if (ea.NewState != EDeviceResetterState.Complete) + if (ea_.NewState != EDeviceResetterState.Complete) return; taskCompletionSource.TrySetResult(true); } - void ResetAsyncOnFatalErrorOccurred(object sender, FatalErrorOccurredEventArgs ea) + void DeviceResetter_FatalErrorOccurred_(object _, FatalErrorOccurredEventArgs ea_) { - var isAboutUnauthorized = ea.ErrorMessage?.ToUpperInvariant().Contains("UNRECOGNIZED (11)") ?? false; - if (isAboutUnauthorized) + taskCompletionSource.TrySetException(ea_.GlobalErrorCode switch { - taskCompletionSource.TrySetException(new UnauthorizedException(ea.ErrorMessage)); - return; - } - - taskCompletionSource.TrySetException(new DeviceResetterErroredOutException(ea.ErrorMessage)); //generic + EGlobalErrorCode.McuMgrErrorBeforeSmpV2_AccessDenied => new UnauthorizedException(ea_.ErrorMessage, ea_.GlobalErrorCode), + _ => new DeviceResetterErroredOutException(ea_.ErrorMessage, ea_.GlobalErrorCode) + }); } //00 we are aware that in order to be 100% accurate about timeouts we should use task.run() here without await and then await the diff --git a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Exceptions/DownloadErroredOutException.cs b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Exceptions/DownloadErroredOutException.cs index 824d1433..fcab20ac 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Exceptions/DownloadErroredOutException.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/Contracts/Exceptions/DownloadErroredOutException.cs @@ -1,15 +1,19 @@ using System; +using Laerdal.McuMgr.Common.Enums; namespace Laerdal.McuMgr.FileDownloader.Contracts.Exceptions { public class DownloadErroredOutException : Exception, IDownloadException { - public DownloadErroredOutException(string errorMessage) : base($"An error occurred while downloading the requested resource: '{errorMessage}'") + public EGlobalErrorCode GlobalErrorCode { get; } + + public DownloadErroredOutException(string errorMessage, EGlobalErrorCode globalErrorCode = EGlobalErrorCode.Unset) : base($"An error occurred while downloading the requested resource: '{errorMessage}'") { + GlobalErrorCode = globalErrorCode; } - + public DownloadErroredOutException(string errorMessage, Exception innerException) : base($"An error occurred while downloading the requested resource: '{errorMessage}'", innerException) { } } -} \ No newline at end of file +} diff --git a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs index 9396ab2b..737be86a 100644 --- a/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs +++ b/Laerdal.McuMgr/Shared/FileDownloader/FileDownloader.cs @@ -410,11 +410,10 @@ void FileDownloader_FatalErrorOccurred_(object _, FatalErrorOccurredEventArgs ea { taskCompletionSource.TrySetException(ea_.GlobalErrorCode switch { - EGlobalErrorCode.SubSystemFilesystem_NotFound => new DownloadErroredOutRemoteFileNotFoundException(remoteFilePath), // remote file not found EGlobalErrorCode.SubSystemFilesystem_IsDirectory => new DownloadErroredOutRemotePathPointsToDirectoryException(remoteFilePath), // remote filepath points to a directory - EGlobalErrorCode.McuMgrErrorBeforeSmpV2_AccessDenied => new UnauthorizedException(resource: remoteFilePath, nativeErrorMessage: ea_.ErrorMessage), // unauthorized - _ => new DownloadErroredOutException(remoteFilePath) + EGlobalErrorCode.McuMgrErrorBeforeSmpV2_AccessDenied => new UnauthorizedException(remoteFilePath, ea_.ErrorMessage), // unauthorized + _ => new DownloadErroredOutException(remoteFilePath, ea_.GlobalErrorCode) }); } } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/AllUploadAttemptsFailedException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/AllUploadAttemptsFailedException.cs index 897d4e7b..94ed3e64 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/AllUploadAttemptsFailedException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/AllUploadAttemptsFailedException.cs @@ -5,7 +5,7 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Exceptions public class AllUploadAttemptsFailedException : UploadErroredOutException, IUploadException { public AllUploadAttemptsFailedException(string remoteFilePath, int triesCount, Exception innerException = null) - : base(remoteFilePath, $"Failed to upload '{remoteFilePath}' after trying {triesCount} time(s)", innerException) + : base(remoteFilePath, $"Failed to upload '{remoteFilePath}' after trying {triesCount} time(s)", innerException: innerException) { } } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs index 2ec8ecc1..ef9c38a9 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadErroredOutException.cs @@ -7,19 +7,12 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Exceptions public class UploadErroredOutException : Exception, IUploadException { public string RemoteFilePath { get; } - - public EGlobalErrorCode GlobalErrorCode { get; } = EGlobalErrorCode.Unset; - - protected UploadErroredOutException(string remoteFilePath, string errorMessage, Exception innerException = null) - : base($"An error occurred while uploading over to '{remoteFilePath}': '{errorMessage}'", innerException) - { - RemoteFilePath = remoteFilePath; - } + public EGlobalErrorCode GlobalErrorCode { get; } public UploadErroredOutException( string nativeErrorMessage, string remoteFilePath, - EGlobalErrorCode globalErrorCode, + EGlobalErrorCode globalErrorCode = EGlobalErrorCode.Unset, Exception innerException = null ) : base($"An error occurred while uploading '{remoteFilePath}': '{nativeErrorMessage}' (globalErrorCode={globalErrorCode})", innerException) { diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadInternalErrorException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadInternalErrorException.cs index 8c632721..a315db5e 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadInternalErrorException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadInternalErrorException.cs @@ -5,7 +5,7 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Exceptions public class UploadInternalErrorException : UploadErroredOutException, IUploadException { public UploadInternalErrorException(string remoteFilePath, Exception innerException = null) - : base(remoteFilePath, "An internal error occured - report what you did to reproduce this because this is most probably a bug!", innerException) + : base(remoteFilePath, "An internal error occured - report what you did to reproduce this because this is most probably a bug!", innerException: innerException) { } } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadTimeoutException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadTimeoutException.cs index d7eb254c..fbba50d1 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadTimeoutException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadTimeoutException.cs @@ -7,7 +7,7 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Exceptions public sealed class UploadTimeoutException : UploadErroredOutException, IUploadException { public UploadTimeoutException(string remoteFilePath, int timeoutInMs, Exception innerException) - : base(remoteFilePath, $"Failed to upload over to '{remoteFilePath}' on the device within {timeoutInMs}ms", innerException) + : base(remoteFilePath, $"Failed to upload over to '{remoteFilePath}' on the device within {timeoutInMs}ms", innerException: innerException) { } } diff --git a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs index 313f84ab..9a1a6465 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/Contracts/Exceptions/UploadUnauthorizedException.cs @@ -7,13 +7,11 @@ namespace Laerdal.McuMgr.FileUploader.Contracts.Exceptions public class UploadUnauthorizedException : UploadErroredOutException, IMcuMgrException { public string RemoteFilePath { get; } - public EGlobalErrorCode GlobalErrorCode { get; } public UploadUnauthorizedException(string nativeErrorMessage, string remoteFilePath, EGlobalErrorCode globalErrorCode) - : base(remoteFilePath, $"{nativeErrorMessage} (globalErrorCode={globalErrorCode})") + : base(remoteFilePath, $"{nativeErrorMessage}", globalErrorCode) { RemoteFilePath = remoteFilePath; - GlobalErrorCode = globalErrorCode; } } } diff --git a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs index a6891eea..cf822540 100644 --- a/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs +++ b/Laerdal.McuMgr/Shared/FileUploader/FileUploader.cs @@ -480,8 +480,8 @@ void FileUploader_FatalErrorOccurred_(object _, FatalErrorOccurredEventArgs ea_) { taskCompletionSource.TrySetException(ea_.GlobalErrorCode switch { - EGlobalErrorCode.SubSystemFilesystem_NotFound => new UploadErroredOutRemoteFolderNotFoundException(remoteFilePath: remoteFilePath, globalErrorCode: ea_.GlobalErrorCode, nativeErrorMessage: ea_.ErrorMessage), - EGlobalErrorCode.McuMgrErrorBeforeSmpV2_AccessDenied => new UploadUnauthorizedException(remoteFilePath: remoteFilePath, globalErrorCode: ea_.GlobalErrorCode, nativeErrorMessage: ea_.ErrorMessage), + EGlobalErrorCode.SubSystemFilesystem_NotFound => new UploadErroredOutRemoteFolderNotFoundException(remoteFilePath: remoteFilePath, nativeErrorMessage: ea_.ErrorMessage, globalErrorCode: ea_.GlobalErrorCode), + EGlobalErrorCode.McuMgrErrorBeforeSmpV2_AccessDenied => new UploadUnauthorizedException(remoteFilePath: remoteFilePath, nativeErrorMessage: ea_.ErrorMessage, globalErrorCode: ea_.GlobalErrorCode), _ => new UploadErroredOutException(remoteFilePath: remoteFilePath, globalErrorCode: ea_.GlobalErrorCode, nativeErrorMessage: ea_.ErrorMessage) }); } diff --git a/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Events/FatalErrorOccurredEventArgs.cs b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Events/FatalErrorOccurredEventArgs.cs index c6a3f88f..22f86913 100644 --- a/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Events/FatalErrorOccurredEventArgs.cs +++ b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Events/FatalErrorOccurredEventArgs.cs @@ -9,10 +9,12 @@ namespace Laerdal.McuMgr.FirmwareEraser.Contracts.Events public readonly struct FatalErrorOccurredEventArgs : IMcuMgrEventArgs { public string ErrorMessage { get; } - + public EGlobalErrorCode GlobalErrorCode { get; } + public FatalErrorOccurredEventArgs(string errorMessage, EGlobalErrorCode globalErrorCode) { ErrorMessage = errorMessage; + GlobalErrorCode = globalErrorCode; } } } diff --git a/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Exceptions/FirmwareErasureErroredOutException.cs b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Exceptions/FirmwareErasureErroredOutException.cs index 6aa8a911..e37f83b7 100644 --- a/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Exceptions/FirmwareErasureErroredOutException.cs +++ b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Exceptions/FirmwareErasureErroredOutException.cs @@ -1,11 +1,15 @@ using System; +using Laerdal.McuMgr.Common.Enums; namespace Laerdal.McuMgr.FirmwareEraser.Contracts.Exceptions { public class FirmwareErasureErroredOutException : Exception, IFirmwareEraserException { - public FirmwareErasureErroredOutException(string errorMessage) : base($"An error occurred while erasing firmware: '{errorMessage}'") + public EGlobalErrorCode GlobalErrorCode { get; } + + public FirmwareErasureErroredOutException(string errorMessage, EGlobalErrorCode globalErrorCode) : base($"An error occurred while erasing firmware: '{errorMessage}'") { + GlobalErrorCode = globalErrorCode; } public FirmwareErasureErroredOutException(string errorMessage, Exception innerException) : base($"An error occurred while erasing firmware: '{errorMessage}'", innerException) diff --git a/Laerdal.McuMgr/Shared/FirmwareEraser/FirmwareEraser.cs b/Laerdal.McuMgr/Shared/FirmwareEraser/FirmwareEraser.cs index 388aece6..1f879c0d 100644 --- a/Laerdal.McuMgr/Shared/FirmwareEraser/FirmwareEraser.cs +++ b/Laerdal.McuMgr/Shared/FirmwareEraser/FirmwareEraser.cs @@ -111,8 +111,8 @@ public async Task EraseAsync(int imageIndex = 1, int timeoutInMs = -1) try { - StateChanged += EraseAsyncOnStateChanged; - FatalErrorOccurred += EraseAsyncOnFatalErrorOccurred; + StateChanged += FirmwareEraser_StateChanged_; + FatalErrorOccurred += FirmwareEraser_FatalErrorOccurred_; BeginErasure(imageIndex); //00 dont use task.run here for now @@ -144,30 +144,27 @@ ex is not ArgumentException //10 wops probably missing native lib symbols! } finally { - StateChanged -= EraseAsyncOnStateChanged; - FatalErrorOccurred -= EraseAsyncOnFatalErrorOccurred; + StateChanged -= FirmwareEraser_StateChanged_; + FatalErrorOccurred -= FirmwareEraser_FatalErrorOccurred_; } return; - void EraseAsyncOnStateChanged(object sender, StateChangedEventArgs ea) + void FirmwareEraser_StateChanged_(object _, StateChangedEventArgs ea_) { - if (ea.NewState != EFirmwareErasureState.Complete) + if (ea_.NewState != EFirmwareErasureState.Complete) return; taskCompletionSource.TrySetResult(true); } - void EraseAsyncOnFatalErrorOccurred(object sender, FatalErrorOccurredEventArgs ea) + void FirmwareEraser_FatalErrorOccurred_(object _, FatalErrorOccurredEventArgs ea_) { - var isAboutUnauthorized = ea.ErrorMessage?.ToUpperInvariant().Contains("UNRECOGNIZED (11)") ?? false; //just in case - if (isAboutUnauthorized) + taskCompletionSource.TrySetException(ea_.GlobalErrorCode switch { - taskCompletionSource.TrySetException(new UnauthorizedException(ea.ErrorMessage)); - return; - } - - taskCompletionSource.TrySetException(new FirmwareErasureErroredOutException(ea.ErrorMessage)); //generic + EGlobalErrorCode.McuMgrErrorBeforeSmpV2_AccessDenied => new UnauthorizedException(ea_.ErrorMessage, ea_.GlobalErrorCode), //just in case + _ => new FirmwareErasureErroredOutException(ea_.ErrorMessage, ea_.GlobalErrorCode) + }); } //00 we are aware that in order to be 100% accurate about timeouts we should use task.run() here without await and then await the diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Exceptions/FirmwareInstallationConfirmationStageTimeoutException.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Exceptions/FirmwareInstallationConfirmationStageTimeoutException.cs index aa1f8d9d..2e3eaeb9 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Exceptions/FirmwareInstallationConfirmationStageTimeoutException.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Exceptions/FirmwareInstallationConfirmationStageTimeoutException.cs @@ -1,11 +1,16 @@ // ReSharper disable RedundantExtendsListEntry +using Laerdal.McuMgr.Common.Enums; + namespace Laerdal.McuMgr.FirmwareInstaller.Contracts.Exceptions { public class FirmwareInstallationConfirmationStageTimeoutException : FirmwareInstallationErroredOutException, IFirmwareInstallationException { - public FirmwareInstallationConfirmationStageTimeoutException(int? estimatedSwapTimeInMilliseconds) - : base($"Device didn't confirm the new firmware within the given timeframe of {estimatedSwapTimeInMilliseconds} milliseconds. The new firmware will only last for just one power-cycle of the device.") + public FirmwareInstallationConfirmationStageTimeoutException(int? estimatedSwapTimeInMilliseconds, EGlobalErrorCode eaGlobalErrorCode) + : base( + errorMessage: $"Device didn't confirm the new firmware within the given timeframe of {estimatedSwapTimeInMilliseconds} milliseconds. The new firmware will only last for just one power-cycle of the device.", + globalErrorCode: eaGlobalErrorCode + ) { } } diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Exceptions/FirmwareInstallationErroredOutException.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Exceptions/FirmwareInstallationErroredOutException.cs index db3d70c7..1016445f 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Exceptions/FirmwareInstallationErroredOutException.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Exceptions/FirmwareInstallationErroredOutException.cs @@ -1,14 +1,20 @@ using System; +using Laerdal.McuMgr.Common.Enums; namespace Laerdal.McuMgr.FirmwareInstaller.Contracts.Exceptions { public class FirmwareInstallationErroredOutException : Exception, IFirmwareInstallationException { - public FirmwareInstallationErroredOutException(string errorMessage) : base($"An error occurred during firmware installation: '{errorMessage}'") + public EGlobalErrorCode GlobalErrorCode { get; } = EGlobalErrorCode.Unset; + + public FirmwareInstallationErroredOutException(string errorMessage, EGlobalErrorCode globalErrorCode = EGlobalErrorCode.Unset) + : base($"An error occurred during firmware installation: '{errorMessage}' (globalErrorCode={globalErrorCode})") { + GlobalErrorCode = globalErrorCode; } - - public FirmwareInstallationErroredOutException(string errorMessage, Exception innerException) : base($"An error occurred during firmware installation: '{errorMessage}'", innerException) + + public FirmwareInstallationErroredOutException(string errorMessage, Exception innerException) + : base($"An error occurred during firmware installation: '{errorMessage}'", innerException) { } } diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Exceptions/FirmwareInstallationUploadingStageErroredOutException.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Exceptions/FirmwareInstallationUploadingStageErroredOutException.cs index 9d4442c2..4d728360 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Exceptions/FirmwareInstallationUploadingStageErroredOutException.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Exceptions/FirmwareInstallationUploadingStageErroredOutException.cs @@ -1,9 +1,11 @@ +using Laerdal.McuMgr.Common.Enums; + namespace Laerdal.McuMgr.FirmwareInstaller.Contracts.Exceptions { public class FirmwareInstallationUploadingStageErroredOutException : FirmwareInstallationErroredOutException, IFirmwareInstallationException { - public FirmwareInstallationUploadingStageErroredOutException() - : base("An error occurred while uploading the firmware") + public FirmwareInstallationUploadingStageErroredOutException(EGlobalErrorCode globalErrorCode) + : base("An error occurred while uploading the firmware", globalErrorCode) { } } diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs index 81b87617..b80a7254 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/FirmwareInstaller.cs @@ -362,28 +362,21 @@ void FirmwareInstaller_StateChanged_(object sender, StateChangedEventArgs ea) // getting called right above but if that takes too long we give the killing blow by calling OnCancelled() manually here } - void FirmwareInstaller_FatalErrorOccurred_(object sender, FatalErrorOccurredEventArgs ea) + void FirmwareInstaller_FatalErrorOccurred_(object _, FatalErrorOccurredEventArgs ea_) { - var isAboutUnauthorized = ea.ErrorMessage?.ToUpperInvariant().Contains("UNRECOGNIZED (11)", StringComparison.InvariantCultureIgnoreCase) ?? false; - if (isAboutUnauthorized) + taskCompletionSource.TrySetException(ea_ switch { - taskCompletionSource.TrySetException(new UnauthorizedException(ea.ErrorMessage)); - return; - } - - if (ea.FatalErrorType == EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut || ea.State == EFirmwareInstallationState.Uploading) - { - taskCompletionSource.TrySetException(new FirmwareInstallationUploadingStageErroredOutException()); - return; - } + { GlobalErrorCode: EGlobalErrorCode.McuMgrErrorBeforeSmpV2_AccessDenied } + => new UnauthorizedException(ea_.ErrorMessage, ea_.GlobalErrorCode), - if (ea.FatalErrorType == EFirmwareInstallerFatalErrorType.FirmwareImageSwapTimeout) //can happen during the fw-confirmation phase which is the last phase - { - taskCompletionSource.TrySetException(new FirmwareInstallationConfirmationStageTimeoutException(estimatedSwapTimeInMilliseconds)); - return; - } + { FatalErrorType: EFirmwareInstallerFatalErrorType.FirmwareImageSwapTimeout } + => new FirmwareInstallationConfirmationStageTimeoutException(estimatedSwapTimeInMilliseconds, ea_.GlobalErrorCode), + + { FatalErrorType: EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut } or { State: EFirmwareInstallationState.Uploading } + => new FirmwareInstallationUploadingStageErroredOutException(ea_.GlobalErrorCode), - taskCompletionSource.TrySetException(new FirmwareInstallationErroredOutException($"{ea.ErrorMessage} (state={ea.State})")); //generic errors fall through here + _ => new FirmwareInstallationErroredOutException($"{ea_.ErrorMessage} (state={ea_.State})", ea_.GlobalErrorCode) + }); } } From a9a9920d3fe13e138791f27d0fa6ede422ce89f3 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 31 Oct 2024 13:59:49 +0100 Subject: [PATCH 101/104] clean (AndroidFileDownloader.java): tryEnsureHighConnectionPriority() outside ensureFilesystemManagerIsInitializedExactlyOnce() --- .../AndroidFileDownloader.java | 35 ++++++++----------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index cadd1ade..2bdff97f 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -147,23 +147,23 @@ public EAndroidFileDownloaderVerdict beginDownload( return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; } - resetDownloadState(); //order must be called before ensureTransportIsInitializedExactlyOnce() because the environment might try to set the device via trySetBluetoothDevice()!!! - ensureTransportIsInitializedExactlyOnce(initialMtuSize); //order - - final EAndroidFileDownloaderVerdict verdict = ensureFilesystemManagerIsInitializedExactlyOnce(); //order - if (verdict != EAndroidFileDownloaderVerdict.SUCCESS) - return verdict; - - ensureFileDownloaderCallbackProxyIsInitializedExactlyOnce(); //order - - setLoggingEnabled(false); try { + setLoggingEnabled(false); + resetDownloadState(); //order must be called before ensureTransportIsInitializedExactlyOnce() because the environment might try to set the device via trySetBluetoothDevice()!!! + ensureTransportIsInitializedExactlyOnce(initialMtuSize); //order + final EAndroidFileDownloaderVerdict verdict = ensureFilesystemManagerIsInitializedExactlyOnce(); //order + if (verdict != EAndroidFileDownloaderVerdict.SUCCESS) + return verdict; + + tryEnsureHighConnectionPriority(_transport); //order + ensureFileDownloaderCallbackProxyIsInitializedExactlyOnce(); //order + _downloadingController = _fileSystemManager.fileDownload(_remoteFilePathSanitized, _fileDownloaderCallbackProxy); } catch (final Exception ex) { - onError("[AFD.BD.060] Failed to initialize download: " + ex.getMessage(), ex); + onError("[AFD.BD.060] Failed to initialize the download operation: " + ex.getMessage(), ex); return EAndroidFileDownloaderVerdict.FAILED__ERROR_UPON_COMMENCING; } @@ -259,27 +259,20 @@ private EAndroidFileDownloaderVerdict ensureFilesystemManagerIsInitializedExactl try { _fileSystemManager = new FsManager(_transport); //order - - requestHighConnectionPriority(_fileSystemManager); //order } catch (final Exception ex) { onError("[AFD.EFMIIEO.010] Failed to initialize the filesystem manager: " + ex.getMessage(), ex); - return EAndroidFileDownloaderVerdict.FAILED__INVALID_SETTINGS; + return EAndroidFileDownloaderVerdict.FAILED__ERROR_UPON_COMMENCING; } return EAndroidFileDownloaderVerdict.SUCCESS; } - private void requestHighConnectionPriority(FsManager fileSystemManager) + private void tryEnsureHighConnectionPriority(final McuMgrBleTransport connection) { - final McuMgrTransport mcuMgrTransporter = fileSystemManager.getTransporter(); - if (!(mcuMgrTransporter instanceof McuMgrBleTransport)) - return; - - final McuMgrBleTransport bleTransporter = (McuMgrBleTransport) mcuMgrTransporter; - bleTransporter.requestConnPriority(ConnectionPriorityRequest.CONNECTION_PRIORITY_HIGH); + connection.requestConnPriority(ConnectionPriorityRequest.CONNECTION_PRIORITY_HIGH); } private void disposeTransport() From 0971c2390b77ed55e72ee19c6ff8cd7f0e465525 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 31 Oct 2024 14:18:13 +0100 Subject: [PATCH 102/104] clean (AndroidFileDownloader.java): tryEnsureHighConnectionPriority() outside ensureFilesystemManagerIsInitializedExactlyOnce() [skip ci] --- .../AndroidDeviceResetter.java | 1 - .../AndroidFileDownloader.java | 34 +++++------ .../AndroidFileUploader.java | 59 ++++++++----------- 3 files changed, 39 insertions(+), 55 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java index f0ca1395..dad2c7f6 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java @@ -51,7 +51,6 @@ public void beginReset() _manager.reset(new McuMgrCallback() { - @Override public void onResponse(@NotNull final McuMgrOsResponse response) { diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java index 2bdff97f..2ac48c31 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileDownloader.java @@ -149,14 +149,15 @@ public EAndroidFileDownloaderVerdict beginDownload( try { - setLoggingEnabled(false); resetDownloadState(); //order must be called before ensureTransportIsInitializedExactlyOnce() because the environment might try to set the device via trySetBluetoothDevice()!!! ensureTransportIsInitializedExactlyOnce(initialMtuSize); //order + setLoggingEnabledOnConnection(false); //order + final EAndroidFileDownloaderVerdict verdict = ensureFilesystemManagerIsInitializedExactlyOnce(); //order if (verdict != EAndroidFileDownloaderVerdict.SUCCESS) return verdict; - tryEnsureHighConnectionPriority(_transport); //order + tryEnsureConnectionPriorityOnTransport(); //order ensureFileDownloaderCallbackProxyIsInitializedExactlyOnce(); //order _downloadingController = _fileSystemManager.fileDownload(_remoteFilePathSanitized, _fileDownloaderCallbackProxy); @@ -178,7 +179,7 @@ public void pause() return; setState(EAndroidFileDownloaderState.PAUSED); - setLoggingEnabled(true); + setLoggingEnabledOnConnection(true); transferController.pause(); busyStateChangedAdvertisement(false); } @@ -194,7 +195,7 @@ public void resume() busyStateChangedAdvertisement(true); _initialBytes = 0; - setLoggingEnabled(false); + setLoggingEnabledOnConnection(false); transferController.resume(); } @@ -233,10 +234,11 @@ private void resetDownloadState() private void ensureTransportIsInitializedExactlyOnce(int initialMtuSize) { - if (_transport != null) - return; + if (_transport == null) + { + _transport = new McuMgrBleTransport(_context, _bluetoothDevice); + } - _transport = new McuMgrBleTransport(_context, _bluetoothDevice); if (initialMtuSize > 0) { _transport.setInitialMtu(initialMtuSize); @@ -270,9 +272,9 @@ private EAndroidFileDownloaderVerdict ensureFilesystemManagerIsInitializedExactl return EAndroidFileDownloaderVerdict.SUCCESS; } - private void tryEnsureHighConnectionPriority(final McuMgrBleTransport connection) + private void tryEnsureConnectionPriorityOnTransport() { - connection.requestConnPriority(ConnectionPriorityRequest.CONNECTION_PRIORITY_HIGH); + _transport.requestConnPriority(ConnectionPriorityRequest.CONNECTION_PRIORITY_HIGH); } private void disposeTransport() @@ -314,13 +316,9 @@ private void disposeCallbackProxy() _fileDownloaderCallbackProxy = null; } - private void setLoggingEnabled(final boolean enabled) + private void setLoggingEnabledOnConnection(final boolean enabled) { - final McuMgrTransport mcuMgrTransporter = _fileSystemManager.getTransporter(); - if (!(mcuMgrTransporter instanceof McuMgrBleTransport)) - return; - - ((McuMgrBleTransport) mcuMgrTransporter).setLoggingEnabled(enabled); + _transport.setLoggingEnabled(enabled); } private void setState(final EAndroidFileDownloaderState newState) @@ -481,7 +479,7 @@ public void onDownloadFailed(@NonNull final McuMgrException exception) { fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); onError(exception.getMessage(), exception); - setLoggingEnabled(true); + setLoggingEnabledOnConnection(true); busyStateChangedAdvertisement(false); _downloadingController = null; //game over @@ -493,7 +491,7 @@ public void onDownloadCanceled() fileDownloadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); setState(EAndroidFileDownloaderState.CANCELLED); cancelledAdvertisement(); - setLoggingEnabled(true); + setLoggingEnabledOnConnection(true); busyStateChangedAdvertisement(false); _downloadingController = null; //game over @@ -507,7 +505,7 @@ public void onDownloadCompleted(byte @NotNull [] data) setState(EAndroidFileDownloaderState.COMPLETE); // order vital downloadCompletedAdvertisement(_remoteFilePathSanitized, data); // order vital - setLoggingEnabled(true); + setLoggingEnabledOnConnection(true); busyStateChangedAdvertisement(false); _downloadingController = null; //game over diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java index 01c330d1..f7ce92cf 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFileUploader.java @@ -157,19 +157,19 @@ public EAndroidFileUploaderVerdict beginUpload( return EAndroidFileUploaderVerdict.FAILED__INVALID_DATA; } - resetUploadState(); //order must be called before ensureTransportIsInitializedExactlyOnce() because the environment might try to set the device via trySetBluetoothDevice()!!! - ensureTransportIsInitializedExactlyOnce(initialMtuSize); //order - - final EAndroidFileUploaderVerdict verdict = ensureFilesystemManagerIsInitializedExactlyOnce(); //order - if (verdict != EAndroidFileUploaderVerdict.SUCCESS) - return verdict; + try + { + resetUploadState(); //order must be called before ensureTransportIsInitializedExactlyOnce() because the environment might try to set the device via trySetBluetoothDevice()!!! + ensureTransportIsInitializedExactlyOnce(initialMtuSize); //order + setLoggingEnabledOnTransport(false); //order - ensureFileUploaderCallbackProxyIsInitializedExactlyOnce(); //order + final EAndroidFileUploaderVerdict verdict = ensureFilesystemManagerIsInitializedExactlyOnce(); //order + if (verdict != EAndroidFileUploaderVerdict.SUCCESS) + return verdict; - setLoggingEnabled(false); + requestHighConnectionPriorityOnTransport(); //order + ensureFileUploaderCallbackProxyIsInitializedExactlyOnce(); //order - try - { FileUploader fileUploader = new FileUploader( //00 _fileSystemManager, _remoteFilePathSanitized, @@ -205,12 +205,10 @@ private void resetUploadState() private void ensureTransportIsInitializedExactlyOnce(int initialMtuSize) { - if (_transport != null) - return; - - logMessageAdvertisement("[AFU.ETIIEO.010] (Re)Initializing transport: initial-mtu-size=" + initialMtuSize, "FileUploader", "TRACE", _remoteFilePathSanitized); - - _transport = new McuMgrBleTransport(_context, _bluetoothDevice); + if (_transport == null) + { + _transport = new McuMgrBleTransport(_context, _bluetoothDevice); + } if (initialMtuSize > 0) { @@ -236,8 +234,6 @@ private EAndroidFileUploaderVerdict ensureFilesystemManagerIsInitializedExactlyO try { _fileSystemManager = new FsManager(_transport); //order - - requestHighConnectionPriority(_fileSystemManager); //order } catch (final Exception ex) { @@ -256,7 +252,7 @@ public void pause() return; setState(EAndroidFileUploaderState.PAUSED); - setLoggingEnabled(true); + setLoggingEnabledOnTransport(true); transferController.pause(); busyStateChangedAdvertisement(false); } @@ -272,7 +268,7 @@ public void resume() busyStateChangedAdvertisement(true); _initialBytes = 0; - setLoggingEnabled(false); + setLoggingEnabledOnTransport(false); transferController.resume(); } @@ -303,14 +299,9 @@ public void cancel(final String reason) transferController.cancel(); //order } - static private void requestHighConnectionPriority(final FsManager fileSystemManager) + private void requestHighConnectionPriorityOnTransport() { - final McuMgrTransport mcuMgrTransporter = fileSystemManager.getTransporter(); - if (!(mcuMgrTransporter instanceof McuMgrBleTransport)) - return; - - final McuMgrBleTransport bleTransporter = (McuMgrBleTransport) mcuMgrTransporter; - bleTransporter.requestConnPriority(ConnectionPriorityRequest.CONNECTION_PRIORITY_HIGH); + _transport.requestConnPriority(ConnectionPriorityRequest.CONNECTION_PRIORITY_HIGH); } private void disposeTransport() @@ -352,13 +343,9 @@ private void disposeCallbackProxy() _fileUploaderCallbackProxy = null; } - private void setLoggingEnabled(final boolean enabled) + private void setLoggingEnabledOnTransport(final boolean enabled) { - final McuMgrTransport mcuMgrTransporter = _fileSystemManager.getTransporter(); - if (!(mcuMgrTransporter instanceof McuMgrBleTransport)) - return; - - ((McuMgrBleTransport) mcuMgrTransporter).setLoggingEnabled(enabled); + _transport.setLoggingEnabled(enabled); } private void setState(final EAndroidFileUploaderState newState) @@ -503,7 +490,7 @@ public void onUploadFailed(@NonNull final McuMgrException error) { fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); onError(error.getMessage(), error); - setLoggingEnabled(true); + setLoggingEnabledOnTransport(true); busyStateChangedAdvertisement(false); _uploadController = null; //order @@ -515,7 +502,7 @@ public void onUploadCanceled() fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(0, 0); setState(EAndroidFileUploaderState.CANCELLED); cancelledAdvertisement(_cancellationReason); - setLoggingEnabled(true); + setLoggingEnabledOnTransport(true); busyStateChangedAdvertisement(false); _uploadController = null; //order @@ -527,7 +514,7 @@ public void onUploadCompleted() //fileUploadProgressPercentageAndDataThroughputChangedAdvertisement(100, 0); //no need this is taken care of inside setState() setState(EAndroidFileUploaderState.COMPLETE); fileUploadedAdvertisement(_remoteFilePathSanitized); - setLoggingEnabled(true); + setLoggingEnabledOnTransport(true); busyStateChangedAdvertisement(false); _uploadController = null; //order From 95f26f5eaa28f9e491cc75c4fcb419d1bdea6175 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 31 Oct 2024 14:24:45 +0100 Subject: [PATCH 103/104] clean (AndroidDeviceResetter.java): trivial neutral simplifications on corner-case errors --- .../AndroidDeviceResetter.java | 56 ++++++++----------- 1 file changed, 24 insertions(+), 32 deletions(-) diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java index dad2c7f6..57ffdfa9 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java @@ -37,43 +37,35 @@ public void beginReset() try { _manager = new DefaultManager(_transport); - } - catch (final Exception ex) - { - setState(EAndroidDeviceResetterState.FAILED); - onError("Failed to create manager: '" + ex.getMessage() + "'", ex); - return; - } - setState(EAndroidDeviceResetterState.RESETTING); + setState(EAndroidDeviceResetterState.RESETTING); - AndroidDeviceResetter self = this; - - _manager.reset(new McuMgrCallback() - { - @Override - public void onResponse(@NotNull final McuMgrOsResponse response) + AndroidDeviceResetter self = this; + _manager.reset(new McuMgrCallback() { - if (!response.isSuccess()) - { // check for an error return code - self.onError("Reset failed (error-code '" + response.getReturnCode().toString() + "')", response.getReturnCode(), response.getGroupReturnCode()); - - setState(EAndroidDeviceResetterState.FAILED); - return; + @Override + public void onResponse(@NotNull final McuMgrOsResponse response) + { + if (!response.isSuccess()) + { // check for an error return code + self.onError("[ADR.BR.002] Reset failed (error-code '" + response.getReturnCode().toString() + "')", response.getReturnCode(), response.getGroupReturnCode()); + return; + } + + setState(EAndroidDeviceResetterState.COMPLETE); } - setState(EAndroidDeviceResetterState.COMPLETE); - } - - @Override - public void onError(@NotNull final McuMgrException exception) - { - self.onError("Reset failed '" + exception.getMessage() + "'", exception); - - setState(EAndroidDeviceResetterState.FAILED); - } - - }); + @Override + public void onError(@NotNull final McuMgrException exception) + { + self.onError("[ADR.BR.005] Reset failed '" + exception.getMessage() + "'", exception); + } + }); + } + catch (final Exception ex) + { + onError("[ADR.BR.010] Failed to initialize reset operation: '" + ex.getMessage() + "'", ex); + } } public void disconnect() From 986d01c7d8e1f019fc8354fc2bec8075ae606436 Mon Sep 17 00:00:00 2001 From: Kyriakos Sidiropoulos Date: Thu, 31 Oct 2024 14:51:31 +0100 Subject: [PATCH 104/104] refa (DeviceResetter): the BeginReset() method now returns a verdict just like the FileUploader/Downloader classes do --- .../AndroidDeviceResetter.java | 30 +++++++- .../AndroidFirmwareEraser.java | 74 +++++++++++++------ .../AndroidFirmwareInstaller.java | 43 ++++++----- ...idDeviceResetterInitializationVerdict.java | 17 +++++ .../EAndroidFileUploaderVerdict.java | 1 + ...idFirmwareEraserInitializationVerdict.java | 16 ++++ ...ndroidFirmwareInstallerFatalErrorType.java | 3 +- .../project.pbxproj | 8 ++ ...EIOSDeviceResetInitializationVerdict.swift | 6 ++ ...FirmwareErasureInitializationVerdict.swift | 6 ++ .../EIOSFirmwareInstallationFatalError.swift | 1 + .../McuMgrBindingsiOS/IOSDeviceResetter.swift | 50 +++++++++---- .../McuMgrBindingsiOS/IOSFirmwareEraser.swift | 50 +++++++++---- .../IOSFirmwareInstaller.swift | 25 +++++-- ...essfully_GivenGreenNativeDeviceResetter.cs | 4 +- ...xception_GivenBluetoothErrorDuringReset.cs | 4 +- ...gNativeSymbolsNativeDeviceResetterProxy.cs | 2 +- ...owTimeoutException_GivenTooSmallTimeout.cs | 4 +- .../DeviceResetter/DeviceResetterTestbed.cs | 4 +- ...essfully_GivenGreenNativeFirmwareEraser.cs | 4 +- ...tion_GivenErroneousNativeFirmwareEraser.cs | 2 +- ...owTimeoutException_GivenTooSmallTimeout.cs | 4 +- .../FirmwareEraser/FirmwareEraserTestbed.cs | 4 +- .../Droid/DeviceResetter/DeviceResetter.cs | 25 +++++++ .../Droid/FirmwareEraser/FirmwareEraser.cs | 32 +++++++- .../FirmwareInstaller/FirmwareInstaller.cs | 5 ++ .../EDeviceResetterInitializationVerdict.cs | 9 +++ .../Contracts/Enums/EDeviceResetterState.cs | 2 +- .../Contracts/IDeviceResetterCommandable.cs | 3 +- .../INativeDeviceResetterCommandableProxy.cs | 6 +- .../Native/INativeDeviceResetterProxy.cs | 5 +- .../Shared/DeviceResetter/DeviceResetter.cs | 12 ++- .../EFirmwareErasureInitializationVerdict.cs | 9 +++ .../Contracts/IFirmwareEraserCommandable.cs | 3 +- .../INativeFirmwareEraserCommandableProxy.cs | 6 +- .../Shared/FirmwareEraser/FirmwareEraser.cs | 13 +++- .../Enums/EFirmwareInstallerFatalErrorType.cs | 3 +- .../iOS/DeviceResetter/DeviceResetter.cs | 19 ++++- .../iOS/FirmwareEraser/FirmwareEraser.cs | 16 +++- .../FirmwareInstaller/FirmwareInstaller.cs | 5 ++ 40 files changed, 423 insertions(+), 112 deletions(-) create mode 100644 Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidDeviceResetterInitializationVerdict.java create mode 100644 Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareEraserInitializationVerdict.java create mode 100644 Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSDeviceResetInitializationVerdict.swift create mode 100644 Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFirmwareErasureInitializationVerdict.swift create mode 100644 Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Enums/EDeviceResetterInitializationVerdict.cs create mode 100644 Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Enums/EFirmwareErasureInitializationVerdict.cs diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java index 57ffdfa9..eaafd3eb 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidDeviceResetter.java @@ -32,13 +32,20 @@ public AndroidDeviceResetter(@NonNull final Context context, @NonNull final Blue _transport = new McuMgrBleTransport(context, bluetoothDevice); } - public void beginReset() + public EAndroidDeviceResetterInitializationVerdict beginReset() { + if (!IsCold()) + { //keep first + onError("[ADR.BR.000] Another reset operation is already in progress (state='" + _currentState + "')"); + + return EAndroidDeviceResetterInitializationVerdict.FAILED__OTHER_RESET_ALREADY_IN_PROGRESS; + } + try { - _manager = new DefaultManager(_transport); - - setState(EAndroidDeviceResetterState.RESETTING); + setState(EAndroidDeviceResetterState.IDLE); //order + _manager = new DefaultManager(_transport); //order + setState(EAndroidDeviceResetterState.RESETTING); //order AndroidDeviceResetter self = this; _manager.reset(new McuMgrCallback() @@ -65,7 +72,10 @@ public void onError(@NotNull final McuMgrException exception) catch (final Exception ex) { onError("[ADR.BR.010] Failed to initialize reset operation: '" + ex.getMessage() + "'", ex); + return EAndroidDeviceResetterInitializationVerdict.FAILED__ERROR_UPON_COMMENCING; } + + return EAndroidDeviceResetterInitializationVerdict.SUCCESS; } public void disconnect() @@ -87,6 +97,13 @@ public EAndroidDeviceResetterState getState() private EAndroidDeviceResetterState _currentState = EAndroidDeviceResetterState.NONE; + @Contract(pure = true) + private boolean IsCold() + { + return _currentState == EAndroidDeviceResetterState.NONE + || _currentState == EAndroidDeviceResetterState.COMPLETE; + } + private void setState(final EAndroidDeviceResetterState newState) { final EAndroidDeviceResetterState oldState = _currentState; //order @@ -109,6 +126,11 @@ public String getLastFatalErrorMessage() return _lastFatalErrorMessage; } + private void onError(final String errorMessage) + { + onError(errorMessage, null); + } + private void onError(final String errorMessage, final Exception exception) { onErrorImpl(errorMessage, McuMgrExceptionHelpers.DeduceGlobalErrorCodeFromException(exception)); diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java index 6ff5b9d3..4661c27a 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareEraser.java @@ -32,38 +32,54 @@ public AndroidFirmwareEraser(@NonNull final Context context, @NonNull final Blue _transport = new McuMgrBleTransport(context, bluetoothDevice); } - public void beginErasure(final int imageIndex) + public EAndroidFirmwareEraserInitializationVerdict beginErasure(final int imageIndex) { - busyStateChangedAdvertisement(true); - - setState(EAndroidFirmwareEraserState.ERASING); + if (!IsCold()) + { //keep first + onError("[AFE.BE.000] Another reset operation is already in progress (state='" + _currentState + "')"); - AndroidFirmwareEraser self = this; + return EAndroidFirmwareEraserInitializationVerdict.FAILED__OTHER_ERASURE_ALREADY_IN_PROGRESS; + } - _imageManager = new ImageManager(_transport); - _imageManager.erase(imageIndex, new McuMgrCallback() + try { - @Override - public void onResponse(@NonNull final McuMgrImageResponse response) + setState(EAndroidFirmwareEraserState.IDLE); //order + _imageManager = new ImageManager(_transport); //order + busyStateChangedAdvertisement(true); //order + setState(EAndroidFirmwareEraserState.ERASING); //order + + AndroidFirmwareEraser self = this; + _imageManager.erase(imageIndex, new McuMgrCallback() { - if (!response.isSuccess()) - { // check for an error return code - self.onError("[AFE.BE.OR.010] Erasure failed (error-code '" + response.getReturnCode().toString() + "')", response.getReturnCode(), response.getGroupReturnCode()); - return; + @Override + public void onResponse(@NonNull final McuMgrImageResponse response) + { + if (!response.isSuccess()) + { // check for an error return code + self.onError("[AFE.BE.010] Erasure failed (error-code '" + response.getReturnCode().toString() + "')", response.getReturnCode(), response.getGroupReturnCode()); + return; + } + + readImageErasure(); + setState(EAndroidFirmwareEraserState.COMPLETE); } - readImageErasure(); - setState(EAndroidFirmwareEraserState.COMPLETE); - } + @Override + public void onError(@NonNull final McuMgrException exception) + { + self.onError("[AFE.BE.020] Erasure failed '" + exception.getMessage() + "'", exception); - @Override - public void onError(@NonNull final McuMgrException exception) - { - self.onError("[AFE.BE.OE.010] Erasure failed '" + exception.getMessage() + "'", exception); + busyStateChangedAdvertisement(false); + } + }); + } + catch (final Exception ex) + { + onError("[AFE.BE.010] Failed to initialize erase operation: '" + ex.getMessage() + "'", ex); + return EAndroidFirmwareEraserInitializationVerdict.FAILED__ERROR_UPON_COMMENCING; + } - busyStateChangedAdvertisement(false); - } - }); + return EAndroidFirmwareEraserInitializationVerdict.SUCCESS; } public void disconnect() @@ -78,6 +94,13 @@ public void disconnect() mcuMgrTransporter.release(); } + @Contract(pure = true) + private boolean IsCold() + { + return _currentState == EAndroidFirmwareEraserState.NONE + || _currentState == EAndroidFirmwareEraserState.COMPLETE; + } + private EAndroidFirmwareEraserState _currentState = EAndroidFirmwareEraserState.NONE; private void setState(EAndroidFirmwareEraserState newState) @@ -103,6 +126,11 @@ public String getLastFatalErrorMessage() return _lastFatalErrorMessage; } + private void onError(final String errorMessage) + { + onError(errorMessage, null); + } + private void onError(final String errorMessage, final Exception exception) { onErrorImpl(errorMessage, McuMgrExceptionHelpers.DeduceGlobalErrorCodeFromException(exception)); diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java index 01f7c921..a9199f4a 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/AndroidFirmwareInstaller.java @@ -80,24 +80,9 @@ public EAndroidFirmwareInstallationVerdict beginInstallation( && _currentState != EAndroidFirmwareInstallationState.COMPLETE && _currentState != EAndroidFirmwareInstallationState.CANCELLED) { - return EAndroidFirmwareInstallationVerdict.FAILED__INSTALLATION_ALREADY_IN_PROGRESS; - } - - _manager = new FirmwareUpgradeManager(_transport); - _manager.setFirmwareUpgradeCallback(new FirmwareInstallCallbackProxy()); - - _handlerThread = new HandlerThread("AndroidFirmwareInstaller.HandlerThread"); //todo peer review whether this is the best way to go maybe we should be getting this from the call environment? - _handlerThread.start(); - - _handler = new Handler(_handlerThread.getLooper()); + onError(EAndroidFirmwareInstallerFatalErrorType.FAILED__INSTALLATION_ALREADY_IN_PROGRESS, "[AFI.BI.000] Another firmware installation is already in progress"); - if (estimatedSwapTimeInMilliseconds >= 0 && estimatedSwapTimeInMilliseconds <= 1000) - { //it is better to just warn the calling environment instead of erroring out - logMessageAdvertisement( - "Estimated swap-time of '" + estimatedSwapTimeInMilliseconds + "' milliseconds seems suspiciously low - did you mean to say '" + (estimatedSwapTimeInMilliseconds * 1000) + "' milliseconds?", - "FirmwareInstaller", - "WARN" - ); + return EAndroidFirmwareInstallationVerdict.FAILED__INSTALLATION_ALREADY_IN_PROGRESS; } ImageSet images = new ImageSet(); @@ -119,6 +104,23 @@ public EAndroidFirmwareInstallationVerdict beginInstallation( } } + _manager = new FirmwareUpgradeManager(_transport); + _manager.setFirmwareUpgradeCallback(new FirmwareInstallCallbackProxy()); + + _handlerThread = new HandlerThread("AndroidFirmwareInstaller.HandlerThread"); //todo peer review whether this is the best way to go maybe we should be getting this from the call environment? + _handlerThread.start(); + + _handler = new Handler(_handlerThread.getLooper()); + + if (estimatedSwapTimeInMilliseconds >= 0 && estimatedSwapTimeInMilliseconds <= 1000) + { //it is better to just warn the calling environment instead of erroring out + logMessageAdvertisement( + "Estimated swap-time of '" + estimatedSwapTimeInMilliseconds + "' milliseconds seems suspiciously low - did you mean to say '" + (estimatedSwapTimeInMilliseconds * 1000) + "' milliseconds?", + "FirmwareInstaller", + "WARN" + ); + } + @NotNull Settings settings; try { @@ -244,7 +246,12 @@ public String getLastFatalErrorMessage() return _lastFatalErrorMessage; } - public void onError(EAndroidFirmwareInstallerFatalErrorType fatalErrorType, final String errorMessage, Exception ex) + public void onError(final EAndroidFirmwareInstallerFatalErrorType fatalErrorType, final String errorMessage) + { + onError(fatalErrorType, errorMessage, null); + } + + public void onError(final EAndroidFirmwareInstallerFatalErrorType fatalErrorType, final String errorMessage, final Exception ex) { EAndroidFirmwareInstallationState currentStateSnapshot = _currentState; //00 order setState(EAndroidFirmwareInstallationState.ERROR); // order diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidDeviceResetterInitializationVerdict.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidDeviceResetterInitializationVerdict.java new file mode 100644 index 00000000..fdf6a23e --- /dev/null +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidDeviceResetterInitializationVerdict.java @@ -0,0 +1,17 @@ +package no.laerdal.mcumgr_laerdal_wrapper; + +public enum EAndroidDeviceResetterInitializationVerdict +{ + SUCCESS(0), + FAILED__ERROR_UPON_COMMENCING(1), //connection problems + FAILED__OTHER_RESET_ALREADY_IN_PROGRESS(2); + + @SuppressWarnings({"FieldCanBeLocal", "unused"}) + private final int _value; + + EAndroidDeviceResetterInitializationVerdict(int value) + { + _value = value; + } +} + diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileUploaderVerdict.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileUploaderVerdict.java index d90c590a..674e4bc5 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileUploaderVerdict.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFileUploaderVerdict.java @@ -16,3 +16,4 @@ public enum EAndroidFileUploaderVerdict //this must mirror the enum values of E[ _value = value; } } + diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareEraserInitializationVerdict.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareEraserInitializationVerdict.java new file mode 100644 index 00000000..e155a166 --- /dev/null +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareEraserInitializationVerdict.java @@ -0,0 +1,16 @@ +package no.laerdal.mcumgr_laerdal_wrapper; + +public enum EAndroidFirmwareEraserInitializationVerdict +{ + SUCCESS(0), + FAILED__ERROR_UPON_COMMENCING(1), //connection problems + FAILED__OTHER_ERASURE_ALREADY_IN_PROGRESS(2); + + @SuppressWarnings({"FieldCanBeLocal", "unused"}) + private final int _value; + + EAndroidFirmwareEraserInitializationVerdict(int value) + { + _value = value; + } +} diff --git a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareInstallerFatalErrorType.java b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareInstallerFatalErrorType.java index e7216131..580bca21 100644 --- a/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareInstallerFatalErrorType.java +++ b/Laerdal.McuMgr.Bindings.Android.Native/mcumgr-laerdal-wrapper/src/main/java/no/laerdal/mcumgr_laerdal_wrapper/EAndroidFirmwareInstallerFatalErrorType.java @@ -7,7 +7,8 @@ public enum EAndroidFirmwareInstallerFatalErrorType //this must mirror the enum INVALID_FIRMWARE(2), DEPLOYMENT_FAILED(3), FIRMWARE_IMAGE_SWAP_TIMEOUT(4), - FIRMWARE_UPLOADING_ERRORED_OUT(5); + FIRMWARE_UPLOADING_ERRORED_OUT(5), + FAILED__INSTALLATION_ALREADY_IN_PROGRESS(6); @SuppressWarnings({"FieldCanBeLocal", "unused"}) private final int _value; diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS.xcodeproj/project.pbxproj b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS.xcodeproj/project.pbxproj index 6e3607a6..63a1048c 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS.xcodeproj/project.pbxproj +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS.xcodeproj/project.pbxproj @@ -8,6 +8,8 @@ /* Begin PBXBuildFile section */ B028FB802940DF1400CB71EB /* iOSMcuManagerLibrary in Frameworks */ = {isa = PBXBuildFile; productRef = B028FB7F2940DF1400CB71EB /* iOSMcuManagerLibrary */; }; + B04DC3652CD3C7810048B553 /* EIOSDeviceResetInitializationVerdict.swift in Sources */ = {isa = PBXBuildFile; fileRef = B04DC3642CD3C7810048B553 /* EIOSDeviceResetInitializationVerdict.swift */; }; + B04DC3672CD3E1A20048B553 /* EIOSFirmwareErasureInitializationVerdict.swift in Sources */ = {isa = PBXBuildFile; fileRef = B04DC3662CD3E1A20048B553 /* EIOSFirmwareErasureInitializationVerdict.swift */; }; B0FF8AE92CCFF8E1004B39DE /* IOSListenerForFileUploader.swift in Sources */ = {isa = PBXBuildFile; fileRef = B0FF8AE82CCFF8E1004B39DE /* IOSListenerForFileUploader.swift */; }; E769D0FFF3A39C575B982F6D /* InvalidFirmwareInstallationModeError.swift in Sources */ = {isa = PBXBuildFile; fileRef = E769DB7090742CC7D6AFD01D /* InvalidFirmwareInstallationModeError.swift */; }; E769D1175ADD137DCA6B0207 /* EIOSFirmwareEraserState.swift in Sources */ = {isa = PBXBuildFile; fileRef = E769D3130BA737A0C282D1DD /* EIOSFirmwareEraserState.swift */; }; @@ -36,6 +38,8 @@ /* End PBXBuildFile section */ /* Begin PBXFileReference section */ + B04DC3642CD3C7810048B553 /* EIOSDeviceResetInitializationVerdict.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EIOSDeviceResetInitializationVerdict.swift; sourceTree = ""; }; + B04DC3662CD3E1A20048B553 /* EIOSFirmwareErasureInitializationVerdict.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EIOSFirmwareErasureInitializationVerdict.swift; sourceTree = ""; }; B0C562262936567900B070BA /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = Platforms/MacOSX.platform/Developer/SDKs/MacOSX13.0.sdk/System/Library/Frameworks/Foundation.framework; sourceTree = DEVELOPER_DIR; }; B0C562282936568800B070BA /* CoreBluetooth.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreBluetooth.framework; path = Platforms/MacOSX.platform/Developer/SDKs/MacOSX13.0.sdk/System/Library/Frameworks/CoreBluetooth.framework; sourceTree = DEVELOPER_DIR; }; B0FF8AE82CCFF8E1004B39DE /* IOSListenerForFileUploader.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IOSListenerForFileUploader.swift; sourceTree = ""; }; @@ -100,6 +104,8 @@ E769DC768A6D6F0D1CAC3C06 /* McuMgrBindingsiOS.h */, E769D3E2D33EE281518619A7 /* IOSFirmwareInstaller.swift */, E769D1DEDAD5F89C361DF28C /* EIOSFirmwareInstallationVerdict.swift */, + B04DC3642CD3C7810048B553 /* EIOSDeviceResetInitializationVerdict.swift */, + B04DC3662CD3E1A20048B553 /* EIOSFirmwareErasureInitializationVerdict.swift */, E769DC8A37490B096716C6B8 /* EIOSFirmwareInstallationMode.swift */, E769DCEDC8442691AF65E8F8 /* EIOSFirmwareInstallationState.swift */, E769DB7090742CC7D6AFD01D /* InvalidFirmwareInstallationModeError.swift */, @@ -237,6 +243,7 @@ E769D37F2EF53CC9C5858BED /* IOSListenerForFirmwareInstaller.swift in Sources */, E769D36EAF2DD40E0A892DB2 /* DummyPlaceholder.swift in Sources */, E769D8E49B6F52BD0065A849 /* EIOSFileUploaderState.swift in Sources */, + B04DC3652CD3C7810048B553 /* EIOSDeviceResetInitializationVerdict.swift in Sources */, E769DA011D5897CB39E02602 /* IOSFileUploader.swift in Sources */, E769DEB3EFF58D41D88197C4 /* EIOSFileUploadingInitializationVerdict.swift in Sources */, E769D339FCECEE79EEDD55C5 /* McuMgrExceptionHelpers.swift in Sources */, @@ -244,6 +251,7 @@ B0FF8AE92CCFF8E1004B39DE /* IOSListenerForFileUploader.swift in Sources */, E769D33171D78172F096C8A4 /* EIOSFileDownloaderState.swift in Sources */, E769D3F56B12BF1FA2695F1E /* IOSListenerForFileDownloader.swift in Sources */, + B04DC3672CD3E1A20048B553 /* EIOSFirmwareErasureInitializationVerdict.swift in Sources */, E769D54A54C788CCE8488B9B /* EIOSFileDownloadingInitializationVerdict.swift in Sources */, E769D5AE4CFECFEA0B509626 /* EIOSFirmwareInstallationFatalError.swift in Sources */, ); diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSDeviceResetInitializationVerdict.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSDeviceResetInitializationVerdict.swift new file mode 100644 index 00000000..41f50caa --- /dev/null +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSDeviceResetInitializationVerdict.swift @@ -0,0 +1,6 @@ +@objc +public enum EIOSDeviceResetInitializationVerdict: Int { + case success = 0 + case failedErrorUponCommencing = 1 + case failedOtherResetAlreadyInProgress = 2 +} diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFirmwareErasureInitializationVerdict.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFirmwareErasureInitializationVerdict.swift new file mode 100644 index 00000000..d88d44c8 --- /dev/null +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFirmwareErasureInitializationVerdict.swift @@ -0,0 +1,6 @@ +@objc +public enum EIOSFirmwareErasureInitializationVerdict: Int { + case success = 0 + case failedErrorUponCommencing = 1 + case failedOtherErasureAlreadyInProgress = 2 +} diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFirmwareInstallationFatalError.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFirmwareInstallationFatalError.swift index b84c3cc4..ef49787d 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFirmwareInstallationFatalError.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/EIOSFirmwareInstallationFatalError.swift @@ -7,4 +7,5 @@ public enum EIOSFirmwareInstallerFatalErrorType : Int //this must mirror the enu case deploymentFailed = 3 case firmwareImageSwapTimeout = 4 case firmwareUploadingErroredOut = 5 + case failedInstallationAlreadyInProgress = 6 } diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSDeviceResetter.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSDeviceResetter.swift index d63271b7..6a1d4b3a 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSDeviceResetter.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSDeviceResetter.swift @@ -17,30 +17,50 @@ public class IOSDeviceResetter: NSObject { } @objc - public func beginReset() { - setState(.resetting) + public func beginReset(_ keepThisDummyParameter: Bool = false) -> EIOSDeviceResetInitializationVerdict { + if (!isCold()) { //keep first + onError("[IOSDR.BR.000] Another erasure operation is already in progress") - _manager = DefaultManager(transport: _transporter) - _manager.logDelegate = self + return .failedOtherResetAlreadyInProgress + } - _manager.reset { - response, error in + do { + setState(.idle) + _manager = DefaultManager(transport: _transporter) + _manager.logDelegate = self - if (error != nil) { - self.onError("[IOSDR.BR.010] Reset failed: '\(error?.localizedDescription ?? "")'", error) - return - } + setState(.resetting) + _manager.reset { + response, error in + + if (error != nil) { + self.onError("[IOSDR.BR.010] Reset failed: '\(error?.localizedDescription ?? "")'", error) + return + } + + if (response?.getError() != nil) { // check for an error return code + self.onError("[IOSDR.BR.020] Reset failed: '\(response?.getError()?.errorDescription ?? "")'", response?.getError()) + return + } - if (response?.getError() != nil) { // check for an error return code - self.onError("[IOSDR.BR.020] Reset failed: '\(response?.getError()?.errorDescription ?? "")'", response?.getError()) - return + self.setState(.complete) } + } catch let ex { + onError("[IOSDR.BR.030] Failed to launch the installation process: '\(ex.localizedDescription)", ex) - self.setState(.complete) + return .failedErrorUponCommencing } + + return .success + } + + private func isCold() -> Bool { + return _currentState == .none + || _currentState == .failed + || _currentState == .complete } - private func onError(_ errorMessage: String, _ error: Error?) { + private func onError(_ errorMessage: String, _ error: Error? = nil) { setState(.failed) fatalErrorOccurredAdvertisement(errorMessage, McuMgrExceptionHelpers.deduceGlobalErrorCodeFromException(error)) diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareEraser.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareEraser.swift index 15209b17..dd2a4ed8 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareEraser.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareEraser.swift @@ -17,25 +17,39 @@ public class IOSFirmwareEraser: NSObject { } @objc - public func beginErasure(_ imageIndex: Int) { - busyStateChangedAdvertisement(true) + public func beginErasure(_ imageIndex: Int) -> EIOSFirmwareErasureInitializationVerdict { + if (!isCold()) { //keep first + onError("[IOSFE.BE.000] Another erasure operation is already in progress"); - setState(.erasing) + return .failedOtherErasureAlreadyInProgress; + } - _manager = ImageManager(transport: _transporter) - _manager.logDelegate = self + do + { + setState(.idle) + _manager = ImageManager(transport: _transporter) + _manager.logDelegate = self - _manager.erase { - response, error in + setState(.erasing) + busyStateChangedAdvertisement(true) + _manager.erase { + response, error in - if (error != nil) { - self.onError("[IOSFE.BE.010] Failed to start firmware erasure: \(error?.localizedDescription ?? "An unspecified error occurred")", error) - return + if (error != nil) { + self.onError("[IOSFE.BE.010] Failed to start firmware erasure: \(error?.localizedDescription ?? "An unspecified error occurred")", error) + return + } + + self.readImageErasure() + self.setState(.complete) } + } catch let ex { + onError("[IOSFE.BE.020] Failed to launch the installation process: '\(ex.localizedDescription)", ex) - self.readImageErasure() - self.setState(.complete) + return .failedErrorUponCommencing } + + return .success } @objc @@ -43,10 +57,16 @@ public class IOSFirmwareEraser: NSObject { _transporter?.close() } - private func onError(_ errorMessage: String, _ error: Error?) { + private func isCold() -> Bool { + return _currentState == .none + || _currentState == .failed + || _currentState == .complete + } + + private func onError(_ errorMessage: String, _ error: Error? = nil) { setState(.failed) - fatalErrorOccurredAdvertisement(errorMessage, McuMgrExceptionHelpers.deduceGlobalErrorCodeFromException(error)) busyStateChangedAdvertisement(false) + fatalErrorOccurredAdvertisement(errorMessage, McuMgrExceptionHelpers.deduceGlobalErrorCodeFromException(error)) } private var _lastFatalErrorMessage: String @@ -117,4 +137,4 @@ extension IOSFirmwareEraser: McuMgrLogDelegate { level.name ) } -} \ No newline at end of file +} diff --git a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareInstaller.swift b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareInstaller.swift index 1689f8f1..079f62e8 100644 --- a/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareInstaller.swift +++ b/Laerdal.McuMgr.Bindings.MacCatalystAndIos.Native/McuMgrBindingsiOS/McuMgrBindingsiOS/IOSFirmwareInstaller.swift @@ -30,7 +30,9 @@ public class IOSFirmwareInstaller: NSObject { _ pipelineDepth: Int, _ byteAlignment: Int ) -> EIOSFirmwareInstallationVerdict { - if _currentState != .none && _currentState != .cancelled && _currentState != .complete && _currentState != .error { //if another installation is already in progress we bail out + if !isCold() { //if another installation is already in progress we bail out + onError(.failedInstallationAlreadyInProgress, "[IOSFI.BI.000] Another firmware installation is already in progress") + return .failedInstallationAlreadyInProgress } @@ -38,20 +40,20 @@ public class IOSFirmwareInstaller: NSObject { _lastBytesSendTimestamp = nil if (imageData.isEmpty) { - emitFatalError(.invalidFirmware, "[IOSFI.BI.010] The firmware data-bytes given are dud!") + onError(.invalidFirmware, "[IOSFI.BI.010] The firmware data-bytes given are dud") return .failedInvalidFirmware } if (pipelineDepth >= 2 && byteAlignment <= 1) { - emitFatalError(.invalidSettings, "[IOSFI.BI.020] When pipeline-depth is set to 2 or above you must specify a byte-alignment >=2 (given byte-alignment is '\(byteAlignment)')") + onError(.invalidSettings, "[IOSFI.BI.020] When pipeline-depth is set to 2 or above you must specify a byte-alignment >=2 (given byte-alignment is '\(byteAlignment)')") return .failedInvalidSettings } let byteAlignmentEnum = translateByteAlignmentMode(byteAlignment); if (byteAlignmentEnum == nil) { - emitFatalError(.invalidSettings, "[IOSFI.BI.030] Invalid byte-alignment value '\(byteAlignment)': It must be a power of 2 up to 16") + onError(.invalidSettings, "[IOSFI.BI.030] Invalid byte-alignment value '\(byteAlignment)': It must be a power of 2 up to 16") return .failedInvalidSettings } @@ -84,7 +86,7 @@ public class IOSFirmwareInstaller: NSObject { } } catch let ex { - emitFatalError(.invalidSettings, "[IOSFI.BI.050] Failed to configure the firmware-installer: '\(ex.localizedDescription)") + onError(.invalidSettings, "[IOSFI.BI.050] Failed to configure the firmware-installer: '\(ex.localizedDescription)") return .failedInvalidSettings } @@ -105,7 +107,7 @@ public class IOSFirmwareInstaller: NSObject { ) } catch let ex { - emitFatalError(.deploymentFailed, "[IOSFI.BI.060] Failed to launch the installation process: '\(ex.localizedDescription)") + onError(.deploymentFailed, "[IOSFI.BI.060] Failed to launch the installation process: '\(ex.localizedDescription)") return .failedDeploymentError } @@ -118,6 +120,13 @@ public class IOSFirmwareInstaller: NSObject { // //2 the hashing algorithm is very specific to nordic there is no practical way to go about getting it other than using the McuMgrImage utility class } + + private func isCold() -> Bool { + return _currentState == .none + || _currentState == .error + || _currentState == .complete + || _currentState == .cancelled + } private func calculateHashBytesOfData(_ data: Data) -> Data { var hasher = Hasher() @@ -183,7 +192,7 @@ public class IOSFirmwareInstaller: NSObject { _transporter?.close() } - private func emitFatalError(_ fatalErrorType: EIOSFirmwareInstallerFatalErrorType, _ errorMessage: String, _ error: Error? = nil) { + private func onError(_ fatalErrorType: EIOSFirmwareInstallerFatalErrorType, _ errorMessage: String, _ error: Error? = nil) { let currentStateSnapshot = _currentState //00 order setState(.error) // order fatalErrorOccurredAdvertisement( // order @@ -315,7 +324,7 @@ extension IOSFirmwareInstaller: FirmwareUpgradeDelegate { //todo calculate thr fatalErrorType = .firmwareImageSwapTimeout } - emitFatalError(fatalErrorType, error.localizedDescription, error) + onError(fatalErrorType, error.localizedDescription, error) busyStateChangedAdvertisement(false) } diff --git a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldCompleteSuccessfully_GivenGreenNativeDeviceResetter.cs b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldCompleteSuccessfully_GivenGreenNativeDeviceResetter.cs index d7faf17b..6ccb5834 100644 --- a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldCompleteSuccessfully_GivenGreenNativeDeviceResetter.cs +++ b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldCompleteSuccessfully_GivenGreenNativeDeviceResetter.cs @@ -37,7 +37,7 @@ public MockedGreenNativeDeviceResetterProxySpy1(INativeDeviceResetterCallbacksPr { } - public override void BeginReset() + public override EDeviceResetterInitializationVerdict BeginReset() { base.BeginReset(); @@ -49,6 +49,8 @@ public override void BeginReset() await Task.Delay(20); StateChangedAdvertisement(oldState: EDeviceResetterState.Resetting, newState: EDeviceResetterState.Complete); }); + + return EDeviceResetterInitializationVerdict.Success; //00 simulating the state changes in a background thread is vital in order to simulate the async nature of the native resetter } diff --git a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowDeviceResetterErroredOutException_GivenBluetoothErrorDuringReset.cs b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowDeviceResetterErroredOutException_GivenBluetoothErrorDuringReset.cs index b5443d3e..d3bf3efd 100644 --- a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowDeviceResetterErroredOutException_GivenBluetoothErrorDuringReset.cs +++ b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowDeviceResetterErroredOutException_GivenBluetoothErrorDuringReset.cs @@ -49,7 +49,7 @@ public MockedErroneousDueToBluetoothNativeDeviceResetterProxySpy(INativeDeviceRe { } - public override void BeginReset() + public override EDeviceResetterInitializationVerdict BeginReset() { base.BeginReset(); @@ -64,6 +64,8 @@ public override void BeginReset() //00 simulating the state changes in a background thread is vital in order to simulate the async nature of the native resetter }); + + return EDeviceResetterInitializationVerdict.Success; } } } diff --git a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowDeviceResetterInternalErrorException_GivenErroneousDueToMissingNativeSymbolsNativeDeviceResetterProxy.cs b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowDeviceResetterInternalErrorException_GivenErroneousDueToMissingNativeSymbolsNativeDeviceResetterProxy.cs index ac26dd25..41bb8f18 100644 --- a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowDeviceResetterInternalErrorException_GivenErroneousDueToMissingNativeSymbolsNativeDeviceResetterProxy.cs +++ b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowDeviceResetterInternalErrorException_GivenErroneousDueToMissingNativeSymbolsNativeDeviceResetterProxy.cs @@ -44,7 +44,7 @@ public MockedErroneousDueToMissingSymbolsNativeDeviceResetterProxySpy(INativeDev { } - public override void BeginReset() + public override EDeviceResetterInitializationVerdict BeginReset() { base.BeginReset(); diff --git a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowTimeoutException_GivenTooSmallTimeout.cs b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowTimeoutException_GivenTooSmallTimeout.cs index 824b34a7..bb1e4bc5 100644 --- a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowTimeoutException_GivenTooSmallTimeout.cs +++ b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.ResetAsync.ShouldThrowTimeoutException_GivenTooSmallTimeout.cs @@ -48,7 +48,7 @@ public MockedGreenButSlowNativeDeviceResetterProxySpy(INativeDeviceResetterCallb { } - public override void BeginReset() + public override EDeviceResetterInitializationVerdict BeginReset() { base.BeginReset(); @@ -60,6 +60,8 @@ public override void BeginReset() await Task.Delay(1_000); StateChangedAdvertisement(oldState: EDeviceResetterState.Resetting, newState: EDeviceResetterState.Complete); }); + + return EDeviceResetterInitializationVerdict.Success; //00 simulating the state changes in a background thread is vital in order to simulate the async nature of the native resetter } diff --git a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.cs b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.cs index 8861ed5a..6483e3de 100644 --- a/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.cs +++ b/Laerdal.McuMgr.Tests/DeviceResetter/DeviceResetterTestbed.cs @@ -29,9 +29,11 @@ protected MockedNativeDeviceResetterProxySpy(INativeDeviceResetterCallbacksProxy _resetterCallbacksProxy = resetterCallbacksProxy; } - public virtual void BeginReset() + public virtual EDeviceResetterInitializationVerdict BeginReset() { BeginResetCalled = true; + + return EDeviceResetterInitializationVerdict.Success; } public virtual void Disconnect() diff --git a/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.EraseAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareEraser.cs b/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.EraseAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareEraser.cs index 246315f1..9af1a987 100644 --- a/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.EraseAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareEraser.cs +++ b/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.EraseAsync.ShouldCompleteSuccessfully_GivenGreenNativeFirmwareEraser.cs @@ -32,7 +32,7 @@ public MockedGreenNativeFirmwareEraserProxySpy1(INativeFirmwareEraserCallbacksPr { } - public override void BeginErasure(int imageIndex) + public override EFirmwareErasureInitializationVerdict BeginErasure(int imageIndex) { base.BeginErasure(imageIndex); @@ -44,6 +44,8 @@ public override void BeginErasure(int imageIndex) await Task.Delay(20); StateChangedAdvertisement(EFirmwareErasureState.Erasing, EFirmwareErasureState.Complete); }); + + return EFirmwareErasureInitializationVerdict.Success; //00 simulating the state changes in a background thread is vital in order to simulate the async nature of the native eraser } diff --git a/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.EraseAsync.ShouldThrowFirmwareErasureInternalErrorException_GivenErroneousNativeFirmwareEraser.cs b/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.EraseAsync.ShouldThrowFirmwareErasureInternalErrorException_GivenErroneousNativeFirmwareEraser.cs index 54bf08e5..e1bc0dbd 100644 --- a/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.EraseAsync.ShouldThrowFirmwareErasureInternalErrorException_GivenErroneousNativeFirmwareEraser.cs +++ b/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.EraseAsync.ShouldThrowFirmwareErasureInternalErrorException_GivenErroneousNativeFirmwareEraser.cs @@ -40,7 +40,7 @@ public MockedErroneousNativeFirmwareEraserProxySpy(INativeFirmwareEraserCallback { } - public override void BeginErasure(int imageIndex) + public override EFirmwareErasureInitializationVerdict BeginErasure(int imageIndex) { base.BeginErasure(imageIndex); diff --git a/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.EraseAsync.ShouldThrowTimeoutException_GivenTooSmallTimeout.cs b/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.EraseAsync.ShouldThrowTimeoutException_GivenTooSmallTimeout.cs index 68eb5d48..67277ff5 100644 --- a/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.EraseAsync.ShouldThrowTimeoutException_GivenTooSmallTimeout.cs +++ b/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.EraseAsync.ShouldThrowTimeoutException_GivenTooSmallTimeout.cs @@ -46,7 +46,7 @@ public MockedGreenButSlowNativeFirmwareEraserProxySpy(INativeFirmwareEraserCallb { } - public override void BeginErasure(int imageIndex) + public override EFirmwareErasureInitializationVerdict BeginErasure(int imageIndex) { base.BeginErasure(imageIndex); @@ -58,6 +58,8 @@ public override void BeginErasure(int imageIndex) await Task.Delay(1_000); StateChangedAdvertisement(oldState: EFirmwareErasureState.Erasing, newState: EFirmwareErasureState.Complete); }); + + return EFirmwareErasureInitializationVerdict.Success; //00 simulating the state changes in a background thread is vital in order to simulate the async nature of the native resetter } diff --git a/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.cs b/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.cs index 5bf70aa4..9e20bece 100644 --- a/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.cs +++ b/Laerdal.McuMgr.Tests/FirmwareEraser/FirmwareEraserTestbed.cs @@ -27,9 +27,11 @@ protected MockedNativeFirmwareEraserProxySpy(INativeFirmwareEraserCallbacksProxy _eraserCallbacksProxy = eraserCallbacksProxy; } - public virtual void BeginErasure(int imageIndex) + public virtual EFirmwareErasureInitializationVerdict BeginErasure(int imageIndex) { BeginErasureCalled = true; + + return EFirmwareErasureInitializationVerdict.Success; } public virtual void Disconnect() diff --git a/Laerdal.McuMgr/Droid/DeviceResetter/DeviceResetter.cs b/Laerdal.McuMgr/Droid/DeviceResetter/DeviceResetter.cs index f00c1ad2..d00f0c03 100644 --- a/Laerdal.McuMgr/Droid/DeviceResetter/DeviceResetter.cs +++ b/Laerdal.McuMgr/Droid/DeviceResetter/DeviceResetter.cs @@ -60,6 +60,11 @@ internal AndroidNativeDeviceResetterAdapterProxy(INativeDeviceResetterCallbacksP _deviceResetterCallbacksProxy = deviceResetterCallbacksProxy ?? throw new ArgumentNullException(nameof(deviceResetterCallbacksProxy)); } + public EDeviceResetterInitializationVerdict BeginReset() + { + return TranslateEAndroidDeviceResetterInitializationVerdict(base.BeginReset()); + } + public override void FatalErrorOccurredAdvertisement(string errorMessage, int globalErrorCode) { base.FatalErrorOccurredAdvertisement(errorMessage, globalErrorCode); @@ -137,6 +142,26 @@ static private EDeviceResetterState TranslateEAndroidDeviceResetterState(EAndroi throw new ArgumentOutOfRangeException(nameof(state), state, "Unknown enum value"); } + + static private EDeviceResetterInitializationVerdict TranslateEAndroidDeviceResetterInitializationVerdict(EAndroidDeviceResetterInitializationVerdict verdict) + { + if (verdict == EAndroidDeviceResetterInitializationVerdict.Success) + { + return EDeviceResetterInitializationVerdict.Success; + } + + if (verdict == EAndroidDeviceResetterInitializationVerdict.FailedErrorUponCommencing) + { + return EDeviceResetterInitializationVerdict.FailedErrorUponCommencing; + } + + if (verdict == EAndroidDeviceResetterInitializationVerdict.FailedOtherResetAlreadyInProgress) + { + return EDeviceResetterInitializationVerdict.FailedOtherResetAlreadyInProgress; + } + + throw new ArgumentOutOfRangeException(nameof(verdict), verdict, "Unknown enum value"); + } } } } diff --git a/Laerdal.McuMgr/Droid/FirmwareEraser/FirmwareEraser.cs b/Laerdal.McuMgr/Droid/FirmwareEraser/FirmwareEraser.cs index 2b23858f..9797b86b 100644 --- a/Laerdal.McuMgr/Droid/FirmwareEraser/FirmwareEraser.cs +++ b/Laerdal.McuMgr/Droid/FirmwareEraser/FirmwareEraser.cs @@ -66,6 +66,14 @@ public IFirmwareEraserEventEmittable FirmwareEraser //keep this to conform to th set => _nativeEraserCallbacksProxy!.FirmwareEraser = value; } + public EFirmwareErasureInitializationVerdict BeginErasure(int imageIndex) + { + if (_nativeEraserCallbacksProxy == null) + throw new InvalidOperationException("The native firmware eraser is not initialized"); + + return TranslateEAndroidFirmwareEraserInitializationVerdict(base.BeginErasure(imageIndex)); + } + public override void StateChangedAdvertisement(EAndroidFirmwareEraserState oldState, EAndroidFirmwareEraserState newState) { base.StateChangedAdvertisement(oldState, newState); @@ -76,7 +84,7 @@ public override void StateChangedAdvertisement(EAndroidFirmwareEraserState oldSt ); } - //keep this override its needed to conform to the interface + //keep this override it is needed to conform to the interface public void StateChangedAdvertisement(EFirmwareErasureState oldState, EFirmwareErasureState newState) { _nativeEraserCallbacksProxy?.StateChangedAdvertisement(newState: newState, oldState: oldState); @@ -112,7 +120,7 @@ public override void LogMessageAdvertisement(string message, string category, st ); } - //keep this override its needed to conform to the interface + //keep this override it is needed to conform to the interface public void LogMessageAdvertisement(string message, string category, ELogLevel level) { _nativeEraserCallbacksProxy?.LogMessageAdvertisement(message, category, level); @@ -148,6 +156,26 @@ static internal EFirmwareErasureState TranslateEAndroidFirmwareEraserState(EAndr throw new ArgumentOutOfRangeException(nameof(state), state, "Unknown enum value"); } + + static internal EFirmwareErasureInitializationVerdict TranslateEAndroidFirmwareEraserInitializationVerdict(EAndroidFirmwareEraserInitializationVerdict beginErasure) + { + if (beginErasure == EAndroidFirmwareEraserInitializationVerdict.Success) + { + return EFirmwareErasureInitializationVerdict.Success; + } + + if (beginErasure == EAndroidFirmwareEraserInitializationVerdict.FailedErrorUponCommencing) + { + return EFirmwareErasureInitializationVerdict.FailedErrorUponCommencing; + } + + if (beginErasure == EAndroidFirmwareEraserInitializationVerdict.FailedOtherErasureAlreadyInProgress) + { + return EFirmwareErasureInitializationVerdict.FailedOtherErasureAlreadyInProgress; + } + + throw new ArgumentOutOfRangeException(nameof(beginErasure), beginErasure, "Unknown enum value"); + } } } } diff --git a/Laerdal.McuMgr/Droid/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/Droid/FirmwareInstaller/FirmwareInstaller.cs index 82967c15..4aa4d86b 100644 --- a/Laerdal.McuMgr/Droid/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/Droid/FirmwareInstaller/FirmwareInstaller.cs @@ -296,6 +296,11 @@ static private EFirmwareInstallerFatalErrorType TranslateEAndroidFirmwareInstall return EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut; } + if (fatalErrorType == EAndroidFirmwareInstallerFatalErrorType.FailedInstallationAlreadyInProgress) + { + return EFirmwareInstallerFatalErrorType.FailedInstallationAlreadyInProgress; + } + throw new ArgumentOutOfRangeException(nameof(fatalErrorType), fatalErrorType, "Unknown enum value"); } diff --git a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Enums/EDeviceResetterInitializationVerdict.cs b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Enums/EDeviceResetterInitializationVerdict.cs new file mode 100644 index 00000000..4eca91d3 --- /dev/null +++ b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Enums/EDeviceResetterInitializationVerdict.cs @@ -0,0 +1,9 @@ +namespace Laerdal.McuMgr.DeviceResetter.Contracts.Enums +{ + public enum EDeviceResetterInitializationVerdict + { + Success = 0, + FailedErrorUponCommencing = 1, + FailedOtherResetAlreadyInProgress = 2, + } +} \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Enums/EDeviceResetterState.cs b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Enums/EDeviceResetterState.cs index 846a6ebb..52d2165a 100644 --- a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Enums/EDeviceResetterState.cs +++ b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Enums/EDeviceResetterState.cs @@ -6,6 +6,6 @@ public enum EDeviceResetterState Idle = 1, Resetting = 2, Complete = 3, - Failed = 4 + Failed = 4, } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/IDeviceResetterCommandable.cs b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/IDeviceResetterCommandable.cs index df4ee227..1509d665 100644 --- a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/IDeviceResetterCommandable.cs +++ b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/IDeviceResetterCommandable.cs @@ -1,4 +1,5 @@ using System.Threading.Tasks; +using Laerdal.McuMgr.DeviceResetter.Contracts.Enums; namespace Laerdal.McuMgr.DeviceResetter.Contracts { @@ -11,7 +12,7 @@ public interface IDeviceResetterCommandable Task ResetAsync(int timeoutInMs = -1); /// Starts the resetting process. Basically reboots the device - it doesn't delete any of the firmware or the configuration. - void BeginReset(); + EDeviceResetterInitializationVerdict BeginReset(); /// Drops the active bluetooth-connection to the Zephyr device. void Disconnect(); diff --git a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Native/INativeDeviceResetterCommandableProxy.cs b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Native/INativeDeviceResetterCommandableProxy.cs index 3593da6a..a7b473b9 100644 --- a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Native/INativeDeviceResetterCommandableProxy.cs +++ b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Native/INativeDeviceResetterCommandableProxy.cs @@ -1,8 +1,10 @@ -namespace Laerdal.McuMgr.DeviceResetter.Contracts.Native +using Laerdal.McuMgr.DeviceResetter.Contracts.Enums; + +namespace Laerdal.McuMgr.DeviceResetter.Contracts.Native { internal interface INativeDeviceResetterCommandableProxy { void Disconnect(); - void BeginReset(); + EDeviceResetterInitializationVerdict BeginReset(); } } diff --git a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Native/INativeDeviceResetterProxy.cs b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Native/INativeDeviceResetterProxy.cs index d1af2921..ff3a5bc2 100644 --- a/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Native/INativeDeviceResetterProxy.cs +++ b/Laerdal.McuMgr/Shared/DeviceResetter/Contracts/Native/INativeDeviceResetterProxy.cs @@ -1,6 +1,9 @@ namespace Laerdal.McuMgr.DeviceResetter.Contracts.Native { - internal interface INativeDeviceResetterProxy : INativeDeviceResetterQueryableProxy, INativeDeviceResetterCommandableProxy, INativeDeviceResetterCallbacksProxy + internal interface INativeDeviceResetterProxy : + INativeDeviceResetterQueryableProxy, + INativeDeviceResetterCommandableProxy, + INativeDeviceResetterCallbacksProxy { } } diff --git a/Laerdal.McuMgr/Shared/DeviceResetter/DeviceResetter.cs b/Laerdal.McuMgr/Shared/DeviceResetter/DeviceResetter.cs index 50e67893..ff40e62f 100644 --- a/Laerdal.McuMgr/Shared/DeviceResetter/DeviceResetter.cs +++ b/Laerdal.McuMgr/Shared/DeviceResetter/DeviceResetter.cs @@ -54,7 +54,13 @@ internal DeviceResetter(INativeDeviceResetterProxy nativeDeviceResetterProxy) public string LastFatalErrorMessage => _nativeDeviceResetterProxy?.LastFatalErrorMessage; public void Disconnect() => _nativeDeviceResetterProxy?.Disconnect(); - public void BeginReset() => _nativeDeviceResetterProxy?.BeginReset(); + public EDeviceResetterInitializationVerdict BeginReset() + { + if (_nativeDeviceResetterProxy == null) + throw new InvalidOperationException("The native device resetter is not initialized"); + + return _nativeDeviceResetterProxy.BeginReset(); + } private event EventHandler _logEmitted; private event EventHandler _stateChanged; @@ -99,7 +105,9 @@ public async Task ResetAsync(int timeoutInMs = -1) StateChanged += DeviceResetter_StateChanged_; FatalErrorOccurred += DeviceResetter_FatalErrorOccurred_; - BeginReset(); //00 dont use task.run here for now + var verdict = BeginReset(); //00 dont use task.run here for now + if (verdict != EDeviceResetterInitializationVerdict.Success) + throw new ArgumentException(verdict.ToString()); _ = timeoutInMs <= 0 ? await taskCompletionSource.Task diff --git a/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Enums/EFirmwareErasureInitializationVerdict.cs b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Enums/EFirmwareErasureInitializationVerdict.cs new file mode 100644 index 00000000..a12b6312 --- /dev/null +++ b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Enums/EFirmwareErasureInitializationVerdict.cs @@ -0,0 +1,9 @@ +namespace Laerdal.McuMgr.FirmwareEraser.Contracts.Enums +{ + public enum EFirmwareErasureInitializationVerdict + { + Success = 0, + FailedErrorUponCommencing = 1, + FailedOtherErasureAlreadyInProgress = 2, + } +} \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/IFirmwareEraserCommandable.cs b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/IFirmwareEraserCommandable.cs index 59828196..db9965ee 100644 --- a/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/IFirmwareEraserCommandable.cs +++ b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/IFirmwareEraserCommandable.cs @@ -1,4 +1,5 @@ using System.Threading.Tasks; +using Laerdal.McuMgr.FirmwareEraser.Contracts.Enums; namespace Laerdal.McuMgr.FirmwareEraser.Contracts { @@ -18,7 +19,7 @@ public interface IFirmwareEraserCommandable /// Starts the erasure process on the firmware-image specified. /// /// The zero-based index of the firmware image to delete. By default it's 1 which is the index of the inactive firmware image. - void BeginErasure(int imageIndex = 1); + EFirmwareErasureInitializationVerdict BeginErasure(int imageIndex = 1); /// Drops the active bluetooth-connection to the Zephyr device. void Disconnect(); diff --git a/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Native/INativeFirmwareEraserCommandableProxy.cs b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Native/INativeFirmwareEraserCommandableProxy.cs index 61cceedb..418920f6 100644 --- a/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Native/INativeFirmwareEraserCommandableProxy.cs +++ b/Laerdal.McuMgr/Shared/FirmwareEraser/Contracts/Native/INativeFirmwareEraserCommandableProxy.cs @@ -1,8 +1,10 @@ -namespace Laerdal.McuMgr.FirmwareEraser.Contracts.Native +using Laerdal.McuMgr.FirmwareEraser.Contracts.Enums; + +namespace Laerdal.McuMgr.FirmwareEraser.Contracts.Native { internal interface INativeFirmwareEraserCommandableProxy { void Disconnect(); - void BeginErasure(int imageIndex); + EFirmwareErasureInitializationVerdict BeginErasure(int imageIndex); } } \ No newline at end of file diff --git a/Laerdal.McuMgr/Shared/FirmwareEraser/FirmwareEraser.cs b/Laerdal.McuMgr/Shared/FirmwareEraser/FirmwareEraser.cs index 1f879c0d..b53d2d2d 100644 --- a/Laerdal.McuMgr/Shared/FirmwareEraser/FirmwareEraser.cs +++ b/Laerdal.McuMgr/Shared/FirmwareEraser/FirmwareEraser.cs @@ -58,8 +58,15 @@ internal FirmwareEraser(INativeFirmwareEraserProxy nativeFirmwareEraserProxy) public string LastFatalErrorMessage => _nativeFirmwareEraserProxy?.LastFatalErrorMessage; public void Disconnect() => _nativeFirmwareEraserProxy?.Disconnect(); - public void BeginErasure(int imageIndex = 1) => _nativeFirmwareEraserProxy?.BeginErasure(imageIndex); + public EFirmwareErasureInitializationVerdict BeginErasure(int imageIndex = 1) + { + if (_nativeFirmwareEraserProxy == null) + throw new InvalidOperationException("The native firmware eraser is not initialized"); + + return _nativeFirmwareEraserProxy.BeginErasure(imageIndex); + } + private event EventHandler _logEmitted; private event EventHandler _stateChanged; private event EventHandler _busyStateChanged; @@ -114,7 +121,9 @@ public async Task EraseAsync(int imageIndex = 1, int timeoutInMs = -1) StateChanged += FirmwareEraser_StateChanged_; FatalErrorOccurred += FirmwareEraser_FatalErrorOccurred_; - BeginErasure(imageIndex); //00 dont use task.run here for now + var verdict = BeginErasure(imageIndex); //00 dont use task.run here for now + if (verdict != EFirmwareErasureInitializationVerdict.Success) + throw new ArgumentException(verdict.ToString()); _ = timeoutInMs <= 0 ? await taskCompletionSource.Task diff --git a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Enums/EFirmwareInstallerFatalErrorType.cs b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Enums/EFirmwareInstallerFatalErrorType.cs index 6c493dd1..cfa94770 100644 --- a/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Enums/EFirmwareInstallerFatalErrorType.cs +++ b/Laerdal.McuMgr/Shared/FirmwareInstaller/Contracts/Enums/EFirmwareInstallerFatalErrorType.cs @@ -8,5 +8,6 @@ public enum EFirmwareInstallerFatalErrorType //these must mirror the enum values DeploymentFailed = 3, FirmwareImageSwapTimeout = 4, FirmwareUploadingErroredOut = 5, + FailedInstallationAlreadyInProgress = 6, } -} \ No newline at end of file +} diff --git a/Laerdal.McuMgr/iOS/DeviceResetter/DeviceResetter.cs b/Laerdal.McuMgr/iOS/DeviceResetter/DeviceResetter.cs index 5dd0233a..e1049d90 100644 --- a/Laerdal.McuMgr/iOS/DeviceResetter/DeviceResetter.cs +++ b/Laerdal.McuMgr/iOS/DeviceResetter/DeviceResetter.cs @@ -50,11 +50,16 @@ internal IOSNativeDeviceResetterProxy(CBPeripheral bluetoothDevice, INativeDevic public string LastFatalErrorMessage => _nativeDeviceResetter?.LastFatalErrorMessage; public void Disconnect() => _nativeDeviceResetter?.Disconnect(); - public void BeginReset() => _nativeDeviceResetter?.BeginReset(); - - #endregion + public EDeviceResetterInitializationVerdict BeginReset() + { + if (_nativeDeviceResetter == null) + throw new InvalidOperationException("The native device resetter is not initialized"); + + return TranslateEIOSDeviceResetterInitializationVerdict(_nativeDeviceResetter.BeginReset(keepThisDummyParameter: false)); + } + #endregion #region listener callbacks -> event emitters @@ -109,6 +114,14 @@ public void FatalErrorOccurredAdvertisement(string errorMessage, EGlobalErrorCod EIOSDeviceResetterState.Resetting => EDeviceResetterState.Resetting, _ => throw new ArgumentOutOfRangeException(nameof(state), state, "Unknown enum value") }; + + static private EDeviceResetterInitializationVerdict TranslateEIOSDeviceResetterInitializationVerdict(EIOSDeviceResetInitializationVerdict verdict) => verdict switch + { + EIOSDeviceResetInitializationVerdict.Success => EDeviceResetterInitializationVerdict.Success, + EIOSDeviceResetInitializationVerdict.FailedErrorUponCommencing => EDeviceResetterInitializationVerdict.FailedErrorUponCommencing, + EIOSDeviceResetInitializationVerdict.FailedOtherResetAlreadyInProgress => EDeviceResetterInitializationVerdict.FailedOtherResetAlreadyInProgress, + _ => throw new ArgumentOutOfRangeException(nameof(verdict), verdict, "Unknown enum value") + }; } } } \ No newline at end of file diff --git a/Laerdal.McuMgr/iOS/FirmwareEraser/FirmwareEraser.cs b/Laerdal.McuMgr/iOS/FirmwareEraser/FirmwareEraser.cs index 0aa0703f..4a7942aa 100644 --- a/Laerdal.McuMgr/iOS/FirmwareEraser/FirmwareEraser.cs +++ b/Laerdal.McuMgr/iOS/FirmwareEraser/FirmwareEraser.cs @@ -50,7 +50,13 @@ internal IOSNativeFirmwareEraserProxy(CBPeripheral bluetoothDevice, INativeFirmw public void Disconnect() => _nativeFirmwareEraser?.Disconnect(); //we are simply forwarding the commands down to the native world of ios here public string LastFatalErrorMessage => _nativeFirmwareEraser?.LastFatalErrorMessage; - public void BeginErasure(int imageIndex) => _nativeFirmwareEraser?.BeginErasure(imageIndex); + public EFirmwareErasureInitializationVerdict BeginErasure(int imageIndex) + { + if (_nativeFirmwareEraser == null) + throw new InvalidOperationException("The native firmware eraser is not initialized"); + + return TranslateEIOSFirmwareErasureInitializationVerdict(_nativeFirmwareEraser.BeginErasure(imageIndex)); + } #endregion @@ -108,6 +114,14 @@ public void FatalErrorOccurredAdvertisement(string errorMessage, EGlobalErrorCod EIOSFirmwareEraserState.Complete => EFirmwareErasureState.Complete, _ => throw new ArgumentOutOfRangeException(nameof(state), state, "Unknown enum value") }; + + static private EFirmwareErasureInitializationVerdict TranslateEIOSFirmwareErasureInitializationVerdict(EIOSFirmwareErasureInitializationVerdict verdict) => verdict switch + { + EIOSFirmwareErasureInitializationVerdict.Success => EFirmwareErasureInitializationVerdict.Success, + EIOSFirmwareErasureInitializationVerdict.FailedErrorUponCommencing => EFirmwareErasureInitializationVerdict.FailedErrorUponCommencing, + EIOSFirmwareErasureInitializationVerdict.FailedOtherErasureAlreadyInProgress => EFirmwareErasureInitializationVerdict.FailedOtherErasureAlreadyInProgress, + _ => throw new ArgumentOutOfRangeException(nameof(verdict), verdict, "Unknown enum value") + }; } } } \ No newline at end of file diff --git a/Laerdal.McuMgr/iOS/FirmwareInstaller/FirmwareInstaller.cs b/Laerdal.McuMgr/iOS/FirmwareInstaller/FirmwareInstaller.cs index 14662145..4d5b06fa 100644 --- a/Laerdal.McuMgr/iOS/FirmwareInstaller/FirmwareInstaller.cs +++ b/Laerdal.McuMgr/iOS/FirmwareInstaller/FirmwareInstaller.cs @@ -113,6 +113,9 @@ public EFirmwareInstallationVerdict BeginInstallation( int? byteAlignment = null ) { + if (_nativeFirmwareInstaller == null) + throw new InvalidOperationException("The native firmware installer is not initialized"); + var nsDataOfFirmware = NSData.FromArray(data); var verdict = TranslateFirmwareInstallationVerdict(_nativeFirmwareInstaller.BeginInstallation( @@ -217,6 +220,8 @@ static private EFirmwareInstallerFatalErrorType TranslateEIOSFirmwareInstallerFa EIOSFirmwareInstallerFatalErrorType.DeploymentFailed => EFirmwareInstallerFatalErrorType.DeploymentFailed, EIOSFirmwareInstallerFatalErrorType.FirmwareImageSwapTimeout => EFirmwareInstallerFatalErrorType.FirmwareImageSwapTimeout, EIOSFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut => EFirmwareInstallerFatalErrorType.FirmwareUploadingErroredOut, + EIOSFirmwareInstallerFatalErrorType.FailedInstallationAlreadyInProgress => EFirmwareInstallerFatalErrorType.FailedInstallationAlreadyInProgress, + _ => throw new ArgumentOutOfRangeException(nameof(fatalErrorType), actualValue: fatalErrorType, message: "Unknown enum value") }; }