A Swiss Army knife for developers.
C# blazorcross-platformcsharpdesktopdesktop-appdesktop-applicationdeveloper-toolsextensiblefluentfluent-designlinuxmacosmicasyntax-highlightingtypescriptwindowswindows-10windows-11winui
Safely handle misconfigured extensions (#1161)
Etienne Baudoux8d4ea06742b0
diff --git a/src/app/dev/DevToys.Business/ViewModels/MainWindowViewModel.cs b/src/app/dev/DevToys.Business/ViewModels/MainWindowViewModel.csindex 5eaaf42b3..5cb640d1a 100644--- a/src/app/dev/DevToys.Business/ViewModels/MainWindowViewModel.cs+++ b/src/app/dev/DevToys.Business/ViewModels/MainWindowViewModel.cs@@ -200,7 +200,11 @@ internal sealed partial class MainWindowViewModel : ObservableRecipienttry{- using var cancellationTokenSource = new CancellationTokenSource(TimeSpan.FromSeconds(2));+ using var cancellationTokenSource+ = new CancellationTokenSource(+ Debugger.IsAttached ? TimeSpan.FromHours(1) : TimeSpan.FromSeconds(2));++ CancellationToken cancellationToken = cancellationTokenSource.Token;INotifyPropertyChanged? selectedMenuBeforeSmartDetection = SelectedMenuItem;Guard.IsNotNull(selectedMenuBeforeSmartDetection);@@ -208,14 +212,14 @@ internal sealed partial class MainWindowViewModel : ObservableRecipientobject? rawClipboardData = await _clipboard.GetClipboardDataAsync();// If the clipboard content has changed since the last time- if (!cancellationTokenSource.Token.IsCancellationRequested && !AreOldAndNewClipboardDataEqual(_oldRawClipboardData, rawClipboardData))+ if (!cancellationToken.IsCancellationRequested && !AreOldAndNewClipboardDataEqual(_oldRawClipboardData, rawClipboardData)){// Reset recommended tools._guiToolProvider.ForEachToolViewItem(toolViewItem => toolViewItem.IsRecommended = false);// Detect tools to recommend.IReadOnlyList<SmartDetectedTool> detectedTools- = await _smartDetectionService.DetectAsync(rawClipboardData, strict: true, cancellationTokenSource.Token)+ = await _smartDetectionService.DetectAsync(rawClipboardData, strict: true, cancellationToken).ConfigureAwait(true);GuiToolViewItem? firstToolViewItem = null;diff --git a/src/app/dev/DevToys.Core/Tools/GuiToolInstance.cs b/src/app/dev/DevToys.Core/Tools/GuiToolInstance.csindex 05ee6989f..284c6ca53 100644--- a/src/app/dev/DevToys.Core/Tools/GuiToolInstance.cs+++ b/src/app/dev/DevToys.Core/Tools/GuiToolInstance.cs@@ -55,7 +55,7 @@ public sealed partial class GuiToolInstance : ObservableObject, IDisposablepublic string LongDisplayTitle => _longDisplayTitle.Value;- public string LongOrShortDisplayTitle => string.IsNullOrWhiteSpace(_longDisplayTitle.Value) ? ShortDisplayTitle : _longDisplayTitle.Value;+ public string LongOrShortDisplayTitle => string.IsNullOrWhiteSpace(LongDisplayTitle) ? ShortDisplayTitle : LongDisplayTitle;public string Description => _descriptionDisplayTitle.Value;@@ -164,9 +164,25 @@ public sealed partial class GuiToolInstance : ObservableObject, IDisposableprivate string GetDisplayString(string resourceName){- return _resourceManager.Value is not null && !string.IsNullOrWhiteSpace(resourceName)- ? _resourceManager.Value.GetString(resourceName) ?? string.Empty- : string.Empty;+ if (_resourceManager.Value is null)+ {+ LogGetMetadataStringFailed(resourceName, InternalComponentName);+ return $"[Unable to get the text for '{resourceName}', " ++ $"likely because we couldn't find a proper '{nameof(IResourceAssemblyIdentifier)}' " ++ $"for the tool '{_guiToolDefinition.Metadata.InternalComponentName}'.]";+ }++ try+ {+ return _resourceManager.Value is not null && !string.IsNullOrWhiteSpace(resourceName)+ ? _resourceManager.Value.GetString(resourceName) ?? $"[Unable to find '{resourceName}' in '{_guiToolDefinition.Metadata.ResourceManagerBaseName}']"+ : string.Empty;+ }+ catch+ {+ LogGetMetadataStringFailed(resourceName, InternalComponentName);+ return $"[Unable to find '{resourceName}' in '{_guiToolDefinition.Metadata.ResourceManagerBaseName}']";+ }}[LoggerMessage(0, LogLevel.Information, "Initialized '{toolName}' tool instance manager.")]@@ -183,4 +199,7 @@ public sealed partial class GuiToolInstance : ObservableObject, IDisposable[LoggerMessage(4, LogLevel.Error, "Unexpectedly failed to dispose '{toolName}'.")]partial void LogDisposingToolFailed(Exception ex, string toolName);++ [LoggerMessage(5, LogLevel.Error, "Unable to get the string for '{metadataName}' for the tool '{toolName}'.")]+ partial void LogGetMetadataStringFailed(string metadataName, string toolName);}diff --git a/src/app/dev/DevToys.Core/Tools/GuiToolProvider.cs b/src/app/dev/DevToys.Core/Tools/GuiToolProvider.csindex 1b7fd83e0..fb563ece4 100644--- a/src/app/dev/DevToys.Core/Tools/GuiToolProvider.cs+++ b/src/app/dev/DevToys.Core/Tools/GuiToolProvider.cs@@ -440,7 +440,7 @@ public sealed partial class GuiToolProviderAssembly? resourceManagerAssembly = null;if (!string.IsNullOrEmpty(guiToolDefinition.Metadata.ResourceManagerAssemblyIdentifier)){- resourceManagerAssembly = GetResourceManagerAssembly(guiToolDefinition.Metadata.ResourceManagerAssemblyIdentifier);+ resourceManagerAssembly = GetResourceManagerAssembly(guiToolDefinition.Metadata);}// Create the tool instance and store it in a menu placement list.@@ -584,8 +584,8 @@ public sealed partial class GuiToolProviderif (toolGroup is null){- ThrowHelper.ThrowInvalidDataException($"Unable to find the group named '{tool.GroupName}' that the tool '{tool.InternalComponentName}' is pointing to.");- return null;+ LogGroupNotFound(tool.GroupName, tool.InternalComponentName);+ continue;}// Create a group view presentation, if needed.@@ -619,17 +619,18 @@ public sealed partial class GuiToolProviderreturn groups.Values.Select(g => g.Value);}- private Assembly GetResourceManagerAssembly(string resourceManagerAssemblyIdentifier)+ private Assembly? GetResourceManagerAssembly(GuiToolMetadata guiToolMetadata){foreach (Lazy<IResourceAssemblyIdentifier, ResourceAssemblyIdentifierMetadata> item in _resourceAssemblyIdentifiers){- if (string.Equals(item.Metadata.InternalComponentName, resourceManagerAssemblyIdentifier, StringComparison.Ordinal))+ if (string.Equals(item.Metadata.InternalComponentName, guiToolMetadata.ResourceManagerAssemblyIdentifier, StringComparison.Ordinal)){return item.Value.GetType().Assembly;}}- throw new InvalidDataException($"Unable to find the {nameof(ToolDisplayInformationAttribute.ResourceManagerAssemblyIdentifier)} '{resourceManagerAssemblyIdentifier}'.");+ LogResourceManagerAssemblyIdentifierFound(guiToolMetadata.InternalComponentName, guiToolMetadata.ResourceManagerAssemblyIdentifier);+ return null;}private GroupViewItem CreateFavoriteGroupViewItem(IReadOnlyList<GuiToolViewItem> favoriteTools)@@ -777,4 +778,10 @@ public sealed partial class GuiToolProvider[LoggerMessage(3, LogLevel.Information, "Instantiated {toolCount} tools in {duration}ms")]partial void LogToolInstancesCreated(int toolCount, double duration);++ [LoggerMessage(4, LogLevel.Error, "Unable to find the group named '{groupName}' that the tool '{toolName}' is pointing to.")]+ partial void LogGroupNotFound(string groupName, string toolName);++ [LoggerMessage(5, LogLevel.Error, "Unable to find the ResourceManagerAssemblyIdentifier '{resourceManagerAssemblyIdentifier}' that the tool '{toolName}' is pointing to.")]+ partial void LogResourceManagerAssemblyIdentifierFound(string toolName, string resourceManagerAssemblyIdentifier);}diff --git a/src/app/dev/DevToys.Core/Tools/SmartDetectionService.cs b/src/app/dev/DevToys.Core/Tools/SmartDetectionService.csindex bad905f63..84d550915 100644--- a/src/app/dev/DevToys.Core/Tools/SmartDetectionService.cs+++ b/src/app/dev/DevToys.Core/Tools/SmartDetectionService.cs@@ -22,7 +22,7 @@ public sealed partial class SmartDetectionService_detectorHierarchy = BuildDetectorNodeHierarchy(dataTypeDetectors);// Create a map of data types to tools.- _dataTypeToToolInstanceMap = BuildDataTypeToToolInstanceMap(guiToolProvider);+ _dataTypeToToolInstanceMap = BuildDataTypeToToolInstanceMap(guiToolProvider, dataTypeDetectors);}/// <summary>@@ -231,8 +231,11 @@ public sealed partial class SmartDetectionService/// Builds a dictionary that maps data types to a list of GUI tool instances that accept them./// </summary>/// <param name="guiToolProvider">The GUI tool provider.</param>+ /// <param name="detectors">The collection of detectors.</param>/// <returns>A dictionary that maps data types to a list of GUI tool instances that accept them.</returns>- private static Dictionary<string, List<GuiToolInstance>> BuildDataTypeToToolInstanceMap(GuiToolProvider guiToolProvider)+ private Dictionary<string, List<GuiToolInstance>> BuildDataTypeToToolInstanceMap(+ GuiToolProvider guiToolProvider,+ IEnumerable<Lazy<IDataTypeDetector, DataTypeDetectorMetadata>> dataTypeDetectors){// Create a new dictionary with case-insensitive string keysvar dataTypeToToolInstanceMap = new Dictionary<string, List<GuiToolInstance>>(StringComparer.OrdinalIgnoreCase);@@ -246,13 +249,24 @@ public sealed partial class SmartDetectionServicefor (int j = 0; j < tool.AcceptedDataTypeNames.Count; j++){string dataType = tool.AcceptedDataTypeNames[j];- if (!dataTypeToToolInstanceMap.TryGetValue(dataType, out List<GuiToolInstance>? toolList))++ if (!string.IsNullOrWhiteSpace(dataType)){- toolList = new();- dataTypeToToolInstanceMap[dataType] = toolList;- }+ if (dataTypeDetectors.Any(detector => string.Equals(detector.Metadata.DataTypeName, dataType, StringComparison.CurrentCultureIgnoreCase)))+ {+ if (!dataTypeToToolInstanceMap.TryGetValue(dataType, out List<GuiToolInstance>? toolList))+ {+ toolList = new();+ dataTypeToToolInstanceMap[dataType] = toolList;+ }- toolList.Add(tool);+ toolList.Add(tool);+ }+ else+ {+ LogDataDetectorNotFound(tool.InternalComponentName, dataType);+ }+ }}}@@ -265,6 +279,9 @@ public sealed partial class SmartDetectionService[LoggerMessage(1, LogLevel.Error, $"Error while building data detectors.")]partial void LogBuildDetectorNodeHierarchyError(Exception ex);+ [LoggerMessage(2, LogLevel.Warning, "Unable to find the data type detector '{dataTypeName}' for the tool '{toolName}'.")]+ partial void LogDataDetectorNotFound(string toolName, string dataTypeName);+private sealed class DetectorNode{/// <summary>diff --git a/src/app/dev/platforms/desktop/DevToys.CLI/CommandToICommandLineToolMap.cs b/src/app/dev/platforms/desktop/DevToys.CLI/CommandToICommandLineToolMap.csindex c44141d2e..69b819e3f 100644--- a/src/app/dev/platforms/desktop/DevToys.CLI/CommandToICommandLineToolMap.cs+++ b/src/app/dev/platforms/desktop/DevToys.CLI/CommandToICommandLineToolMap.cs@@ -2,16 +2,21 @@using System.Reflection;using System.Resources;using DevToys.Api;+using Microsoft.Extensions.Logging;namespace DevToys.CLI;-internal sealed class CommandToICommandLineToolMap+internal sealed partial class CommandToICommandLineToolMap{+ private readonly ILogger _logger;+internal CommandToICommandLineToolMap(ICommandLineTool commandLineTool, CommandLineToolMetadata metadata){Guard.IsNotNull(commandLineTool);Guard.IsNotNull(metadata);+ _logger = this.Log();+// Get the resource manager, if possible.ResourceManager? resourceManager = GetResourceManager(commandLineTool, metadata);@@ -61,13 +66,31 @@ internal sealed class CommandToICommandLineToolMapreturn resourceManager;}- private static string GetCommandDescription(ResourceManager? resourceManager, CommandLineToolMetadata metadata)+ private string GetCommandDescription(ResourceManager? resourceManager, CommandLineToolMetadata metadata){- string? commandDescription- = resourceManager is not null && !string.IsNullOrWhiteSpace(metadata.DescriptionResourceName)- ? resourceManager.GetString(metadata.DescriptionResourceName) ?? string.Empty- : string.Empty;+ if (resourceManager is null)+ {+ LogGetMetadataStringFailed(metadata.DescriptionResourceName, metadata.InternalComponentName);+ return $"[Unable to get the text for '{metadata.DescriptionResourceName}', " ++ $"likely because we couldn't find a proper '{nameof(IResourceAssemblyIdentifier)}' " ++ $"for the tool '{metadata.InternalComponentName}'.]";+ }- return commandDescription;+ try+ {+ string? commandDescription+ = !string.IsNullOrWhiteSpace(metadata.DescriptionResourceName)+ ? resourceManager.GetString(metadata.DescriptionResourceName) ?? $"[Unable to find '{metadata.DescriptionResourceName}' in '{metadata.ResourceManagerBaseName}']"+ : string.Empty;+ return commandDescription;+ }+ catch+ {+ LogGetMetadataStringFailed(metadata.DescriptionResourceName, metadata.InternalComponentName);+ return $"[Unable to find '{metadata.DescriptionResourceName}' in '{metadata.ResourceManagerBaseName}']";+ }}++ [LoggerMessage(0, LogLevel.Error, "Unable to get the string for '{metadataName}' for the tool '{toolName}'.")]+ partial void LogGetMetadataStringFailed(string metadataName, string toolName);}diff --git a/src/app/dev/platforms/desktop/DevToys.CLI/OptionToICommandLineToolMap.cs b/src/app/dev/platforms/desktop/DevToys.CLI/OptionToICommandLineToolMap.csindex 8cb3b0aa3..d0cfa9ec6 100644--- a/src/app/dev/platforms/desktop/DevToys.CLI/OptionToICommandLineToolMap.cs+++ b/src/app/dev/platforms/desktop/DevToys.CLI/OptionToICommandLineToolMap.cs@@ -4,11 +4,13 @@ using System.Reflection;using System.Resources;using DevToys.Api;using DevToys.CLI.Core;+using Microsoft.Extensions.Logging;namespace DevToys.CLI;-internal sealed class OptionToICommandLineToolMap+internal sealed partial class OptionToICommandLineToolMap{+ private readonly ILogger _logger;private static readonly Type optionType = typeof(Option<>);private readonly ICommandLineTool _commandLineTool;@@ -24,6 +26,7 @@ internal sealed class OptionToICommandLineToolMapGuard.IsNotNull(property);Guard.IsNotNull(commandLineOptionAttribute);+ _logger = this.Log();_property = property;_commandLineTool = commandLineTool;@@ -59,7 +62,7 @@ internal sealed class OptionToICommandLineToolMap_property.SetValue(_commandLineTool, value);}- private static string? GetOptionDescription(ICommandLineTool commandLineTool, CommandLineOptionAttribute commandLineOptionAttribute, ResourceManager? parentResourceManager)+ private string? GetOptionDescription(ICommandLineTool commandLineTool, CommandLineOptionAttribute commandLineOptionAttribute, ResourceManager? parentResourceManager){string? optionDescription = null;if (!string.IsNullOrWhiteSpace(commandLineOptionAttribute.DescriptionResourceName))@@ -78,6 +81,12 @@ internal sealed class OptionToICommandLineToolMap{optionDescription = optionResourceManager.GetString(commandLineOptionAttribute.DescriptionResourceName);}++ if (optionDescription is null)+ {+ LogGetMetadataStringFailed(commandLineOptionAttribute.DescriptionResourceName);+ optionDescription = $"[Unable to find '{commandLineOptionAttribute.DescriptionResourceName}' in '{commandLineOptionAttribute.ResourceManagerBaseName}']";+ }}return optionDescription;@@ -223,4 +232,7 @@ internal sealed class OptionToICommandLineToolMapresult.ErrorMessage = result.LocalizationResources.ArgumentConversionCannotParse(result.ToString(), typeof(OneOfOption));return null;}++ [LoggerMessage(0, LogLevel.Error, "Unable to get the string for '{metadataName}'.")]+ partial void LogGetMetadataStringFailed(string metadataName);}diff --git a/src/app/dev/platforms/desktop/DevToys.CLI/Program.cs b/src/app/dev/platforms/desktop/DevToys.CLI/Program.csindex ddf525dce..c9dd2ab7b 100644--- a/src/app/dev/platforms/desktop/DevToys.CLI/Program.cs+++ b/src/app/dev/platforms/desktop/DevToys.CLI/Program.cs@@ -54,6 +54,11 @@ internal partial class ProgramLogAppShuttingDown(logger);loggerFactory.Dispose();++ if (Debugger.IsAttached)+ {+ Console.ReadKey();+ }}private static async Task MainAsync(string[] args)