feat(vsix): Update error handling on startup (#416)

* feat(vsix): Add wider exception handling on startup * feat(vsix): Add alert for unauthorized file delete
Plac3hold3r · Jun 1, 2019 · fe62fef · fe62fef
1 parent efc18da
commit fe62fef
Show file tree

Hide file tree

Showing 11 changed files with 128 additions and 34 deletions.
diff --git a/src/MvxScaffolding.Core/Contexts/MvxScaffoldingContext.cs b/src/MvxScaffolding.Core/Contexts/MvxScaffoldingContext.cs
@@ -6,6 +6,7 @@
 using System;
 using System.Diagnostics;
 using MvxScaffolding.Core.Dialogs.Interfaces;
+using MvxScaffolding.Core.Files;
 using MvxScaffolding.Core.Properties;
 using MvxScaffolding.Core.Template;
 
@@ -31,6 +32,8 @@ public static class MvxScaffoldingContext
 
         public static string SolutionName { get; set; } = "SolutionProject";
 
+        public static FileDeleteStatus RemoveOldSolutionDirectoryStatus { get; set; } = FileDeleteStatus.Unknown;
+
         public static bool CanCreateSolutionDirectory { get; set; }
 
         public static Version LastKnownVersion

diff --git a/src/MvxScaffolding.Core/Files/FileDeleteStatus.cs b/src/MvxScaffolding.Core/Files/FileDeleteStatus.cs
@@ -0,0 +1,15 @@
+//---------------------------------------------------------------------------------
+// Copyright © 2018, Jonathan Froon, Plac3hold3r+github@outlook.com
+// MvxScaffolding is licensed using the MIT License
+//---------------------------------------------------------------------------------
+
+namespace MvxScaffolding.Core.Files
+{
+    public enum FileDeleteStatus
+    {
+        Unknown,
+        Success,
+        UnauthorizedAccessError,
+        Error
+    }
+}
diff --git a/src/MvxScaffolding.Core/Files/FileSystemUtils.cs b/src/MvxScaffolding.Core/Files/FileSystemUtils.cs
@@ -1,4 +1,4 @@
-//---------------------------------------------------------------------------------
+//---------------------------------------------------------------------------------
 // Copyright © 2018, Jonathan Froon, Plac3hold3r+github@outlook.com
 // MvxScaffolding is licensed using the MIT License
 //---------------------------------------------------------------------------------
@@ -12,19 +12,30 @@ namespace MvxScaffolding.Core.Files
 {
     public static class FileSystemUtils
     {
-        public static void SafeDeleteDirectory(string dir)
+        public static FileDeleteStatus SafeDeleteDirectory(string dir)
         {
             try
             {
                 if (Directory.Exists(dir))
                 {
                     Directory.Delete(dir, true);
                 }
+
+                return FileDeleteStatus.Success;
+            }
+            catch (UnauthorizedAccessException ex)
+            {
+                Logger.Current.Info.TrackAsync("Unauthorized access to deleting directory", ex)
+                    .FireAndForget();
+
+                return FileDeleteStatus.UnauthorizedAccessError;
             }
             catch (Exception ex)
             {
                 Logger.Current.Exception.TrackAsync(ex, "Error deleting directory")
                     .FireAndForget();
+
+                return FileDeleteStatus.Error;
             }
         }
     }

diff --git a/src/MvxScaffolding.Core/MvxScaffolding.Core.csproj b/src/MvxScaffolding.Core/MvxScaffolding.Core.csproj
@@ -114,6 +114,7 @@
     <Compile Include="Extensions\GitHubDownloadExtensions.cs" />
     <Compile Include="Extensions\TaskExtensions.cs" />
     <Compile Include="Extensions\WebClientExtensions.cs" />
+    <Compile Include="Files\FileDeleteStatus.cs" />
     <Compile Include="Files\FileSystemUtils.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Properties\Settings.Designer.cs">

diff --git a/src/MvxScaffolding.Core/Template/TemplateLinks.cs b/src/MvxScaffolding.Core/Template/TemplateLinks.cs
@@ -1,4 +1,4 @@
-//---------------------------------------------------------------------------------
+//---------------------------------------------------------------------------------
 // Copyright © 2018, Jonathan Froon, Plac3hold3r+github@outlook.com
 // MvxScaffolding is licensed using the MIT License
 //---------------------------------------------------------------------------------
@@ -25,6 +25,8 @@ public static class TemplateLinks
 
         public const string EditorConfig = "EditorConfig";
 
+        public const string UnauthorizedAccessError = "UnauthorizedAccessError";
+
         public const string FluentLayout = "FluentLayout";
 
         public const string HyperioniOS = "HyperioniOS";

diff --git a/src/MvxScaffolding.Core/ViewModels/Dialogs/SimpleInfoViewModel.cs b/src/MvxScaffolding.Core/ViewModels/Dialogs/SimpleInfoViewModel.cs
@@ -51,5 +51,15 @@ public static SimpleInfoViewModel EditorConfigInfo()
                 TemplateLink = TemplateLinks.EditorConfig
             };
         }
+
+        public static SimpleInfoViewModel UnauthorizedAccessErrorInfo()
+        {
+            return new SimpleInfoViewModel
+            {
+                Title = LocalResources.SimpleInfo_UnauthorizedAccess_Title,
+                Message = LocalResources.SimpleInfo_UnauthorizedAccess_Message,
+                TemplateLink = TemplateLinks.UnauthorizedAccessError
+            };
+        }
     }
 }
diff --git a/src/MvxScaffolding.Localization/Resources/LocalResources.Designer.cs b/src/MvxScaffolding.Localization/Resources/LocalResources.Designer.cs
diff --git a/src/MvxScaffolding.Localization/Resources/LocalResources.resx b/src/MvxScaffolding.Localization/Resources/LocalResources.resx
@@ -59,46 +59,46 @@
             : using a System.ComponentModel.TypeConverter
             : and then encoded with base64 encoding.
     -->
-  <xsd:schema xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" id="root">
-    <xsd:import namespace="http://www.w3.org/XML/1998/namespace"/>
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
     <xsd:element name="root" msdata:IsDataSet="true">
       <xsd:complexType>
         <xsd:choice maxOccurs="unbounded">
           <xsd:element name="metadata">
             <xsd:complexType>
               <xsd:sequence>
-                <xsd:element name="value" type="xsd:string" minOccurs="0"/>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" />
               </xsd:sequence>
-              <xsd:attribute name="name" use="required" type="xsd:string"/>
-              <xsd:attribute name="type" type="xsd:string"/>
-              <xsd:attribute name="mimetype" type="xsd:string"/>
-              <xsd:attribute ref="xml:space"/>
+              <xsd:attribute name="name" use="required" type="xsd:string" />
+              <xsd:attribute name="type" type="xsd:string" />
+              <xsd:attribute name="mimetype" type="xsd:string" />
+              <xsd:attribute ref="xml:space" />
             </xsd:complexType>
           </xsd:element>
           <xsd:element name="assembly">
             <xsd:complexType>
-              <xsd:attribute name="alias" type="xsd:string"/>
-              <xsd:attribute name="name" type="xsd:string"/>
+              <xsd:attribute name="alias" type="xsd:string" />
+              <xsd:attribute name="name" type="xsd:string" />
             </xsd:complexType>
           </xsd:element>
           <xsd:element name="data">
             <xsd:complexType>
               <xsd:sequence>
-                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1"/>
-                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2"/>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
               </xsd:sequence>
-              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1"/>
-              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3"/>
-              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4"/>
-              <xsd:attribute ref="xml:space"/>
+              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
+              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
+              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
+              <xsd:attribute ref="xml:space" />
             </xsd:complexType>
           </xsd:element>
           <xsd:element name="resheader">
             <xsd:complexType>
               <xsd:sequence>
-                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1"/>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
               </xsd:sequence>
-              <xsd:attribute name="name" type="xsd:string" use="required"/>
+              <xsd:attribute name="name" type="xsd:string" use="required" />
             </xsd:complexType>
           </xsd:element>
         </xsd:choice>
@@ -453,4 +453,10 @@
   <data name="AppDetails_Create_Solution_Directory" xml:space="preserve">
     <value>Create directory for solution</value>
   </data>
-</root>
+  <data name="SimpleInfo_UnauthorizedAccess_Message" xml:space="preserve">
+    <value>MvxScaffolding can not delete the default Visual Studio generated project folder due to the choice of file location requiring elevated privileges. You will need to either run Visual Studio as an Administrator or manually clean up the directory after project has been generated.</value>
+  </data>
+  <data name="SimpleInfo_UnauthorizedAccess_Title" xml:space="preserve">
+    <value>Unauthorized Access Error</value>
+  </data>
+</root>
diff --git a/src/MvxScaffolding.UI/Views/MainWindow.xaml.cs b/src/MvxScaffolding.UI/Views/MainWindow.xaml.cs
@@ -3,11 +3,13 @@
 // MvxScaffolding is licensed using the MIT License
 //---------------------------------------------------------------------------------
 
+using System;
 using System.Windows.Input;
 using System.Windows.Media;
 using MahApps.Metro.Controls;
 using MaterialDesignThemes.Wpf;
 using MvxScaffolding.Core.Contexts;
+using MvxScaffolding.Core.Files;
 using MvxScaffolding.Core.Template;
 using MvxScaffolding.Core.ViewModels;
 using MvxScaffolding.Core.ViewModels.Dialogs;
@@ -37,6 +39,17 @@ public MainWindow()
 #endif
         }
 
+        protected override void OnContentRendered(EventArgs e)
+        {
+            base.OnContentRendered(e);
+
+            if (MvxScaffoldingContext.RemoveOldSolutionDirectoryStatus == FileDeleteStatus.UnauthorizedAccessError
+                && DataContext is MainViewModel mainViewModel)
+            {
+                mainViewModel.ShowDialogCommand.Execute(SimpleInfoViewModel.UnauthorizedAccessErrorInfo());
+            }
+        }
+
         private void OnDialogClosing(object sender, DialogClosingEventArgs eventArgs)
         {
             if (eventArgs.Parameter is SimpleInfoViewModel infoViewModel

diff --git a/src/MvxScaffolding.Vsix/MvxScaffolding.config.json b/src/MvxScaffolding.Vsix/MvxScaffolding.config.json
@@ -51,7 +51,6 @@
         "Type": "Blank",
         "Platforms": [ "iOS", "Android", "UWP" ]
       }
-
     ]
   }
 }
diff --git a/src/MvxScaffolding.Vsix/Wizards/MvxScaffoldingBase.cs b/src/MvxScaffolding.Vsix/Wizards/MvxScaffoldingBase.cs
@@ -6,6 +6,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Windows;
 using EnvDTE;
 using EnvDTE80;
 using Microsoft.Internal.VisualStudio.PlatformUI;
@@ -54,17 +55,17 @@ public void RunStarted(object automationObject, Dictionary<string, string> repla
         {
             if (runKind == WizardRunKind.AsNewProject || runKind == WizardRunKind.AsMultiProject)
             {
-                MvxScaffoldingContext.WizardVersion = new Version(ThisAssembly.Vsix.Version);
-                MvxScaffoldingContext.WizardName = ThisAssembly.Vsix.Name;
-                MvxScaffoldingContext.ProjectName = replacementsDictionary[VSTemplateKeys.ProjectName];
-                MvxScaffoldingContext.SafeProjectName = replacementsDictionary[VSTemplateKeys.SafeProjectName];
-                MvxScaffoldingContext.CanCreateSolutionDirectory = !string.IsNullOrWhiteSpace(replacementsDictionary[VSTemplateKeys.SpecifiedSolutionName]);
-                MvxScaffoldingContext.SolutionName = replacementsDictionary[VSTemplateKeys.SpecifiedSolutionName];
-
-                RemoveOldSolutionDirectory(automationObject, replacementsDictionary);
-
                 try
                 {
+                    MvxScaffoldingContext.WizardVersion = new Version(ThisAssembly.Vsix.Version);
+                    MvxScaffoldingContext.WizardName = ThisAssembly.Vsix.Name;
+                    MvxScaffoldingContext.ProjectName = replacementsDictionary[VSTemplateKeys.ProjectName];
+                    MvxScaffoldingContext.SafeProjectName = replacementsDictionary[VSTemplateKeys.SafeProjectName];
+                    MvxScaffoldingContext.CanCreateSolutionDirectory = !string.IsNullOrWhiteSpace(replacementsDictionary[VSTemplateKeys.SpecifiedSolutionName]);
+                    MvxScaffoldingContext.SolutionName = replacementsDictionary[VSTemplateKeys.SpecifiedSolutionName];
+
+                    MvxScaffoldingContext.RemoveOldSolutionDirectoryStatus = RemoveOldSolutionDirectory(automationObject, replacementsDictionary);
+
                     ShowModal(Startup.FirstView());
 
                     MvxScaffoldingContext.RunningTimer.Stop();
@@ -87,6 +88,19 @@ public void RunStarted(object automationObject, Dictionary<string, string> repla
                         MvxScaffoldingContext.UserSelectedOptions = null;
                     }
                 }
+                catch (Exception ex) when (ex.GetType() != typeof(WizardBackoutException))
+                {
+                    Logger.Current.Exception.TrackAsync(ex, "Error running wizard")
+                        .FireAndForget();
+
+                    var messageBoxText = $"There was an error trying to run MvxScaffolding. Please log an issue on GitHub if the error persists.\n\nError Message: {ex.Message}\nError StackTrace:{ex.StackTrace}";
+                    var caption = "MvxScaffolding error";
+                    MessageBoxButton button = MessageBoxButton.OK;
+                    MessageBoxImage icon = MessageBoxImage.Error;
+                    MessageBox.Show(messageBoxText, caption, button, icon);
+
+                    throw new WizardBackoutException("Error running wizard, closing application", ex);
+                }
                 finally
                 {
                     Logger.Current.Telemetry.TrackEndSessionAsync()
@@ -95,7 +109,7 @@ public void RunStarted(object automationObject, Dictionary<string, string> repla
             }
         }
 
-        private static void RemoveOldSolutionDirectory(object automationObject, Dictionary<string, string> replacementsDictionary)
+        private static FileDeleteStatus RemoveOldSolutionDirectory(object automationObject, Dictionary<string, string> replacementsDictionary)
         {
             var dte = (DTE)automationObject;
             var solution = (Solution2)dte.Solution;
@@ -107,11 +121,13 @@ private static void RemoveOldSolutionDirectory(object automationObject, Dictiona
                 ? oldDestinationDirectory
                 : Path.GetFullPath(Path.Combine(oldDestinationDirectory, @"..\"));
 
-            FileSystemUtils.SafeDeleteDirectory(solutionRootDirectory);
+            FileDeleteStatus deleteStatus = FileSystemUtils.SafeDeleteDirectory(solutionRootDirectory);
 
             var rootFolderDictionary = Path.GetFullPath(Path.Combine(solutionRootDirectory, @"..\"));
             replacementsDictionary[VSTemplateKeys.DestinationDirectory] = rootFolderDictionary;
             replacementsDictionary[VSTemplateKeys.SolutionDirectory] = rootFolderDictionary;
+
+            return deleteStatus;
         }
 
         public bool ShouldAddProjectItem(string filePath)