A Swiss Army knife for developers.
C# blazorcross-platformcsharpdesktopdesktop-appdesktop-applicationdeveloper-toolsextensiblefluentfluent-designlinuxmacosmicasyntax-highlightingtypescriptwindowswindows-10windows-11winui
Improved unit tests reliability
Etienne Baudoux0bef79efb82e
diff --git a/chocolatey/DevToys/tools/chocolateyinstall.ps1 b/chocolatey/DevToys/tools/chocolateyinstall.ps1index b06b3bf24..6300ac126 100644--- a/chocolatey/DevToys/tools/chocolateyinstall.ps1+++ b/chocolatey/DevToys/tools/chocolateyinstall.ps1@@ -1,7 +1,7 @@$ErrorActionPreference = 'Stop';$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"-$url64 = 'https://github.com/veler/DevToys/releases/download/v1.0.4.0/64360VelerSoftware.DevToys_1.0.4.0_neutral___j80j2txgjg9dj.Msixbundle'-$checksum64 = '8d97757333df6337c27166b8a6bf95d1160e0856a91867ce3487f2598ad9c2aa'+$url64 = 'https://github.com/veler/DevToys/releases/download/v1.0.5.0/64360VelerSoftware.DevToys_1.0.5.0_neutral___j80j2txgjg9dj.Msixbundle'+$checksum64 = '0602a5733691f0239373fc75690f15553673271f94eb8c58148bc3b5c87856a9'$WindowsVersion = [Environment]::OSVersion.Version;$InstallDir = Split-Path $MyInvocation.MyCommand.Definition;$AppxPackageName = "64360VelerSoftware.DevToys"diff --git a/src/dev/impl/DevToys/Core/QueueWorkerViewModelBase.cs b/src/dev/impl/DevToys/Core/QueueWorkerViewModelBase.csnew file mode 100644index 000000000..93df06b86--- /dev/null+++ b/src/dev/impl/DevToys/Core/QueueWorkerViewModelBase.cs@@ -0,0 +1,53 @@+#nullable enable++using System.Collections.Generic;+using System.Threading.Tasks;+using DevToys.Shared.Core.Threading;+using Microsoft.Toolkit.Mvvm.ComponentModel;++namespace DevToys.Core+{+ public abstract class QueueWorkerViewModelBase<T> : ObservableRecipient where T : class+ {+ private readonly object _lock = new();+ private readonly Queue<T> _computationQueue = new();++ private bool _computationInProgress;++ internal Task ComputationTask { get; private set; } = Task.CompletedTask;++ protected void EnqueueComputation(T value)+ {+ lock (_lock)+ {+ _computationQueue.Enqueue(value);++ if (!_computationInProgress)+ {+ _computationInProgress = true;+ ComputationTask = TreatComputationQueueAsync();+ }+ }+ }++ protected abstract Task TreatComputationQueueAsync(T value);++ private async Task TreatComputationQueueAsync()+ {+ await TaskScheduler.Default;++ while (_computationQueue.TryDequeue(out T value))+ {+ await TreatComputationQueueAsync(value).ConfigureAwait(false);++ lock (_lock)+ {+ if (_computationQueue.Count == 0)+ {+ _computationInProgress = false;+ }+ }+ }+ }+ }+}diff --git a/src/dev/impl/DevToys/DevToys.csproj b/src/dev/impl/DevToys/DevToys.csprojindex 44b3ed415..ce32e665f 100644--- a/src/dev/impl/DevToys/DevToys.csproj+++ b/src/dev/impl/DevToys/DevToys.csproj@@ -28,6 +28,7 @@<Compile Include="Api\Tools\NotSearchableAttribute.cs" /><Compile Include="Api\Tools\ParentAttribute.cs" /><Compile Include="Core\OOP\AppService.cs" />+ <Compile Include="Core\QueueWorkerViewModelBase.cs" /><Compile Include="Core\Threading\AsyncLazy.cs" /><Compile Include="Helpers\StorageFileHelper.cs" /><Compile Include="Helpers\ImageHelper.cs" />diff --git a/src/dev/impl/DevToys/ViewModels/Tools/EncodersDecoders/Base64EncoderDecoder/Base64EncoderDecoderToolViewModel.cs b/src/dev/impl/DevToys/ViewModels/Tools/EncodersDecoders/Base64EncoderDecoder/Base64EncoderDecoderToolViewModel.csindex 42fe5d72c..a871c5db1 100644--- a/src/dev/impl/DevToys/ViewModels/Tools/EncodersDecoders/Base64EncoderDecoder/Base64EncoderDecoderToolViewModel.cs+++ b/src/dev/impl/DevToys/ViewModels/Tools/EncodersDecoders/Base64EncoderDecoder/Base64EncoderDecoderToolViewModel.cs@@ -13,12 +13,11 @@ using DevToys.Core;using DevToys.Core.Threading;using DevToys.Shared.Core.Threading;using DevToys.Views.Tools.Base64EncoderDecoder;-using Microsoft.Toolkit.Mvvm.ComponentModel;namespace DevToys.ViewModels.Tools.Base64EncoderDecoder{[Export(typeof(Base64EncoderDecoderToolViewModel))]- public class Base64EncoderDecoderToolViewModel : ObservableRecipient, IToolViewModel+ public class Base64EncoderDecoderToolViewModel : QueueWorkerViewModelBase<string>, IToolViewModel{/// <summary>/// Whether the tool should encode or decode Base64.@@ -46,7 +45,6 @@ namespace DevToys.ViewModels.Tools.Base64EncoderDecoderprivate string? _inputValue;private string? _outputValue;- private bool _conversionInProgress;private bool _setPropertyInProgress;private bool _toolSuccessfullyWorked;@@ -127,46 +125,31 @@ namespace DevToys.ViewModels.Tools.Base64EncoderDecoderprivate void QueueConversionCalculation(){- _conversionQueue.Enqueue(InputValue ?? string.Empty);- TreatQueueAsync().Forget();+ EnqueueComputation(InputValue ?? string.Empty);}- private async Task TreatQueueAsync()+ protected override async Task TreatComputationQueueAsync(string value){- if (_conversionInProgress)+ string conversionResult;+ if (IsEncodeMode){- return;+ conversionResult = await EncodeBase64DataAsync(value).ConfigureAwait(false);+ }+ else+ {+ conversionResult = await DecodeBase64DataAsync(value).ConfigureAwait(false);}- _conversionInProgress = true;-- await TaskScheduler.Default;-- while (_conversionQueue.TryDequeue(out string? text))+ await ThreadHelper.RunOnUIThreadAsync(ThreadPriority.Low, () =>{- string conversionResult;- if (IsEncodeMode)- {- conversionResult = await EncodeBase64DataAsync(text).ConfigureAwait(false);- }- else- {- conversionResult = await DecodeBase64DataAsync(text).ConfigureAwait(false);- }+ OutputValue = conversionResult;- ThreadHelper.RunOnUIThreadAsync(ThreadPriority.Low, () =>+ if (!_toolSuccessfullyWorked){- OutputValue = conversionResult;-- if (!_toolSuccessfullyWorked)- {- _toolSuccessfullyWorked = true;- _marketingService.NotifyToolSuccessfullyWorked();- }- }).ForgetSafely();- }-- _conversionInProgress = false;+ _toolSuccessfullyWorked = true;+ _marketingService.NotifyToolSuccessfullyWorked();+ }+ });}private async Task<string> EncodeBase64DataAsync(string? data)diff --git a/src/dev/impl/DevToys/ViewModels/Tools/Generators/HashGenerator/HashGeneratorToolViewModel.cs b/src/dev/impl/DevToys/ViewModels/Tools/Generators/HashGenerator/HashGeneratorToolViewModel.csindex dfaa184ed..e8837200a 100644--- a/src/dev/impl/DevToys/ViewModels/Tools/Generators/HashGenerator/HashGeneratorToolViewModel.cs+++ b/src/dev/impl/DevToys/ViewModels/Tools/Generators/HashGenerator/HashGeneratorToolViewModel.cs@@ -1,7 +1,6 @@#nullable enableusing System;-using System.Collections.Generic;using System.Composition;using System.Threading.Tasks;using DevToys.Api.Core;@@ -11,7 +10,6 @@ using DevToys.Core;using DevToys.Core.Threading;using DevToys.Shared.Core.Threading;using DevToys.Views.Tools.HashGenerator;-using Microsoft.Toolkit.Mvvm.ComponentModel;using Windows.Security.Cryptography;using Windows.Security.Cryptography.Core;using Windows.Storage.Streams;@@ -19,7 +17,7 @@ using Windows.Storage.Streams;namespace DevToys.ViewModels.Tools.HashGenerator{[Export(typeof(HashGeneratorToolViewModel))]- public sealed class HashGeneratorToolViewModel : ObservableRecipient, IToolViewModel+ public sealed class HashGeneratorToolViewModel : QueueWorkerViewModelBase<string>, IToolViewModel{/// <summary>/// Whether the generated hash should be uppercase or lowercase.@@ -41,10 +39,8 @@ namespace DevToys.ViewModels.Tools.HashGeneratorprivate readonly IMarketingService _marketingService;private readonly ISettingsProvider _settingsProvider;- private readonly Queue<string> _hashCalculationQueue = new();private bool _toolSuccessfullyWorked;- private bool _calculationInProgress;private string? _input;private string? _md5;private string? _sha1;@@ -129,46 +125,31 @@ namespace DevToys.ViewModels.Tools.HashGeneratorprivate void QueueHashCalculation(){- _hashCalculationQueue.Enqueue(Input ?? string.Empty);- TreatQueueAsync().Forget();+ EnqueueComputation(Input ?? string.Empty);}- private async Task TreatQueueAsync()+ protected override async Task TreatComputationQueueAsync(string value){- if (_calculationInProgress)- {- return;- }+ Task<string> md5CalculationTask = CalculateHashAsync(HashAlgorithmNames.Md5, value);+ Task<string> sha1CalculationTask = CalculateHashAsync(HashAlgorithmNames.Sha1, value);+ Task<string> sha256CalculationTask = CalculateHashAsync(HashAlgorithmNames.Sha256, value);+ Task<string> sha512CalculationTask = CalculateHashAsync(HashAlgorithmNames.Sha512, value);- _calculationInProgress = true;-- await TaskScheduler.Default;+ await Task.WhenAll(md5CalculationTask).ConfigureAwait(false);- while (_hashCalculationQueue.TryDequeue(out string? text))+ await ThreadHelper.RunOnUIThreadAsync(() =>{- Task<string> md5CalculationTask = CalculateHashAsync(HashAlgorithmNames.Md5, text);- Task<string> sha1CalculationTask = CalculateHashAsync(HashAlgorithmNames.Sha1, text);- Task<string> sha256CalculationTask = CalculateHashAsync(HashAlgorithmNames.Sha256, text);- Task<string> sha512CalculationTask = CalculateHashAsync(HashAlgorithmNames.Sha512, text);+ MD5 = md5CalculationTask.Result;+ SHA1 = sha1CalculationTask.Result;+ SHA256 = sha256CalculationTask.Result;+ SHA512 = sha512CalculationTask.Result;- await Task.WhenAll(md5CalculationTask).ConfigureAwait(false);-- ThreadHelper.RunOnUIThreadAsync(() =>+ if (!_toolSuccessfullyWorked){- MD5 = md5CalculationTask.Result;- SHA1 = sha1CalculationTask.Result;- SHA256 = sha256CalculationTask.Result;- SHA512 = sha512CalculationTask.Result;-- if (!_toolSuccessfullyWorked)- {- _toolSuccessfullyWorked = true;- _marketingService.NotifyToolSuccessfullyWorked();- }- }).ForgetSafely();- }-- _calculationInProgress = false;+ _toolSuccessfullyWorked = true;+ _marketingService.NotifyToolSuccessfullyWorked();+ }+ });}private async Task<string> CalculateHashAsync(string alrogithmName, string text)@@ -187,7 +168,7 @@ namespace DevToys.ViewModels.Tools.HashGeneratorIBuffer buffer = CryptographicBuffer.ConvertStringToBinary(text, BinaryStringEncoding.Utf8);buffer = algorithmProvider.HashData(buffer);- string? hash="";+ string? hash = "";if (string.Equals(OutputType, HexOutput)){hash = IsUppercasediff --git a/src/dev/impl/DevToys/ViewModels/Tools/Text/StringUtilities/StringUtilitiesToolViewModel.cs b/src/dev/impl/DevToys/ViewModels/Tools/Text/StringUtilities/StringUtilitiesToolViewModel.csindex 61fae9d6e..85af36424 100644--- a/src/dev/impl/DevToys/ViewModels/Tools/Text/StringUtilities/StringUtilitiesToolViewModel.cs+++ b/src/dev/impl/DevToys/ViewModels/Tools/Text/StringUtilities/StringUtilitiesToolViewModel.cs@@ -9,16 +9,16 @@ using System.Text.RegularExpressions;using System.Threading.Tasks;using DevToys.Api.Core;using DevToys.Api.Tools;+using DevToys.Core;using DevToys.Core.Threading;using DevToys.Shared.Core.Threading;using DevToys.Views.Tools.StringUtilities;-using Microsoft.Toolkit.Mvvm.ComponentModel;using Microsoft.Toolkit.Mvvm.Input;namespace DevToys.ViewModels.Tools.StringUtilities{[Export(typeof(StringUtilitiesToolViewModel))]- public sealed class StringUtilitiesToolViewModel : ObservableRecipient, IToolViewModel+ public sealed class StringUtilitiesToolViewModel : QueueWorkerViewModelBase<string>, IToolViewModel{private static readonly object _lockObject = new();@@ -667,7 +667,7 @@ namespace DevToys.ViewModels.Tools.StringUtilitiesprivate void QueueTextStatisticCalculation(){- CalculateTextStatisticsAsync(Text).Forget();+ EnqueueComputation(Text ?? string.Empty);}private void QueueSelectionStatisticCalculation()@@ -682,7 +682,7 @@ namespace DevToys.ViewModels.Tools.StringUtilitiesCalculateSelectionStatisticsAsync(Text!, SelectionStart).Forget();}- private async Task CalculateTextStatisticsAsync(string? text)+ protected override async Task TreatComputationQueueAsync(string text){await TaskScheduler.Default;diff --git a/src/tests/DevToys.Tests/Providers/Tools/Base64EncoderDecoderTests.cs b/src/tests/DevToys.Tests/Providers/Tools/Base64EncoderDecoderTests.csindex 4fd92c5fd..3f1a1d1af 100644--- a/src/tests/DevToys.Tests/Providers/Tools/Base64EncoderDecoderTests.cs+++ b/src/tests/DevToys.Tests/Providers/Tools/Base64EncoderDecoderTests.cs@@ -44,7 +44,7 @@ namespace DevToys.Tests.Providers.ToolsviewModel.InputValue = input;});- await Task.Delay(100);+ await viewModel.ComputationTask;Assert.AreEqual(expectedResult, viewModel.OutputValue);}@@ -65,7 +65,7 @@ namespace DevToys.Tests.Providers.ToolsviewModel.InputValue = input;});- await Task.Delay(100);+ await viewModel.ComputationTask;Assert.AreEqual(expectedResult, viewModel.OutputValue);}diff --git a/src/tests/DevToys.Tests/Providers/Tools/HashGeneratorTests.cs b/src/tests/DevToys.Tests/Providers/Tools/HashGeneratorTests.csindex 31e426c3b..52ce31c57 100644--- a/src/tests/DevToys.Tests/Providers/Tools/HashGeneratorTests.cs+++ b/src/tests/DevToys.Tests/Providers/Tools/HashGeneratorTests.cs@@ -23,7 +23,7 @@ namespace DevToys.Tests.Providers.ToolsviewModel.Input = input;});- await Task.Delay(100);+ await viewModel.ComputationTask;Assert.AreEqual(expectedResult, viewModel.SHA512);}@@ -43,7 +43,7 @@ namespace DevToys.Tests.Providers.ToolsviewModel.Input = input;});- await Task.Delay(100);+ await viewModel.ComputationTask;Assert.AreEqual(expectedResult, viewModel.SHA512);}diff --git a/src/tests/DevToys.Tests/Providers/Tools/StringUtilitiesTests.cs b/src/tests/DevToys.Tests/Providers/Tools/StringUtilitiesTests.csindex a53925ec7..334754f19 100644--- a/src/tests/DevToys.Tests/Providers/Tools/StringUtilitiesTests.cs+++ b/src/tests/DevToys.Tests/Providers/Tools/StringUtilitiesTests.cs@@ -78,7 +78,7 @@ Let's look at these in more detail.";viewModel.Text = Text;- await Task.Delay(100);+ await viewModel.ComputationTask;Assert.AreEqual(1666, viewModel.Characters);Assert.AreEqual(288, viewModel.Words);