Added simple logging class to output errors to file

Author: JoshLmao

ArtifactAPI.MatchHistory/ArtifactAPI.MatchHistory.csproj

@@ -79,6 +79,7 @@
     <Compile Include="Enums\MatchMode.cs" />
     <Compile Include="Enums\Outcome.cs" />
     <Compile Include="Enums\Teams.cs" />
+    <Compile Include="Logger.cs" />
     <Compile Include="MatchDecoder.cs" />
     <Page Include="MainWindow.xaml">
       <Generator>MSBuild:Compile</Generator>

ArtifactAPI.MatchHistory/Converters/OutcomeToColorConverter.cs

@@ -20,7 +20,10 @@ public object Convert(object value, Type targetType, object parameter, CultureIn
                 case Outcome.Draw:
                     return Brushes.OrangeRed;
                 default:
-                    throw new NotImplementedException("Implement case");
+                    {
+                        Logger.OutputError($"Unable to Convert outcome to color - Unknown Outcome number '{value}'");
+                        throw new NotImplementedException("Implement case");
+                    }
             }
         }
 

ArtifactAPI.MatchHistory/Dtos/Match.cs

@@ -125,7 +125,7 @@ private async System.Threading.Tasks.Task LoadHeroUrl(string heroName, int heroI
             string url = await m_client.GetCardArtUrlAsync(heroName, ArtType.Ingame);
             if (string.IsNullOrEmpty(url))
             {
-                Console.WriteLine($"Cannot find URL for '{heroName}'");
+                Logger.OutputError($"Cannot find URL for '{heroName}'");
                 return;
             }
 

ArtifactAPI.MatchHistory/Logger.cs

@@ -0,0 +1,60 @@
+using System;
+using System.IO;
+
+namespace ArtifactAPI.MatchHistory
+{
+    /// <summary>
+    /// Simple logger class to track output messages like crashes and useful information
+    /// </summary>
+    public class Logger
+    {
+        private static string FILE_NAME = "output.txt";
+        private static string FILE_PATH = null;
+
+        static bool IS_CONFIGURED = false;
+
+        public Logger()
+        {
+            Setup();
+        }
+
+        public static void OutputInfo(string message)
+        {
+            if (!IS_CONFIGURED)
+                Setup();
+
+            string formatted = $"{DateTime.Now} -- Info -- {message}{Environment.NewLine}";
+            Append(formatted);
+        }
+
+        public static void OutputError(string message)
+        {
+            if (!IS_CONFIGURED)
+                Setup();
+
+            string formatted = $"{DateTime.Now} -- Error -- {message}{Environment.NewLine}";
+            Append(formatted);
+        }
+
+        private static void Append(string message)
+        {
+            File.AppendAllText(FILE_PATH, message);
+        }
+
+        private static void Setup()
+        {
+            FILE_PATH = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, FILE_NAME);
+            if (string.IsNullOrEmpty(FILE_PATH))
+                return;
+
+            if (!File.Exists(FILE_PATH))
+            {
+                File.Create(FILE_PATH).Close();
+            }
+
+            Append($"------{Environment.NewLine}");
+
+            IS_CONFIGURED = true;
+        }
+    }
+}

ArtifactAPI.MatchHistory/MainWindow.xaml

@@ -6,7 +6,7 @@
         xmlns:dtos="clr-namespace:ArtifactAPI.MatchHistory.Dtos"
         xmlns:converters="clr-namespace:ArtifactAPI.MatchHistory.Converters"
         mc:Ignorable="d"
-        Title="ArtifactAPI - Artifact Match History v0.2"
+        Title="ArtifactAPI - Artifact Match History"
         MinHeight="450" MinWidth="800"
         Height="500" Width="800"
         Icon="/Images/favicon.png" Background="#FF2E2E2E"

ArtifactAPI.MatchHistory/MainWindow.xaml.cs

@@ -17,10 +17,16 @@ public partial class MainWindow : Window
         private ArtifactClient m_client = null;
         private List<Match> m_matches = null;
 
+        private static string VERSION = "v0.3";
+
         public MainWindow()
         {
+            Logger.OutputInfo($"Program Start - Artifact API {VERSION}");
             InitializeComponent();
 
+            this.Title += $" {VERSION}";
+            Closed += OnProgramClosed;
+
             Loaded += OnViewLoaded;
             outputBox.TextChanged += OnOutputPasted;
             tb_javascriptCopy.GotFocus += OnHaveGotFocus;
@@ -32,6 +38,11 @@ public MainWindow()
             m_client.GetAllCards();
         }
 
+        private void OnProgramClosed(object sender, EventArgs e)
+        {
+            Logger.OutputInfo("Program Closed");
+        }
+
         private void OnHaveGotFocus(object sender, RoutedEventArgs e)
         {
             tb_javascriptCopy.SelectAll();

ArtifactAPI.MatchHistory/MatchDecoder.cs

@@ -10,6 +10,10 @@ public class MatchDecoder
         const char PROPERTY_SEPARATOR = '|';
         const char MATCH_SEPARATOR = ',';
 
+        public MatchDecoder()
+        {
+        }
+
         public static List<Match> DecodeMatch(string s, ArtifactClient client)
         {
             if (string.IsNullOrEmpty(s))
@@ -18,10 +22,10 @@ public static List<Match> DecodeMatch(string s, ArtifactClient client)
             s = RemoveFormatting(s);
 
             List<Match> matches = new List<Match>();
-            try
+            string[] matchArr = s.Split(MATCH_SEPARATOR);
+            foreach (string match in matchArr)
             {
-                string[] matchArr = s.Split(MATCH_SEPARATOR);
-                foreach (string match in matchArr)
+                try
                 {
                     if (string.IsNullOrEmpty(match))
                         continue;
@@ -33,7 +37,7 @@ public static List<Match> DecodeMatch(string s, ArtifactClient client)
                     {
                         if (string.IsNullOrEmpty(properties[i]))
                         {
-                            Console.WriteLine($"Empty property at value {i}");
+                            Logger.OutputError($"Empty property at value {i}");
                             continue;
                         }
 
@@ -133,25 +137,25 @@ public static List<Match> DecodeMatch(string s, ArtifactClient client)
                         }
                         else
                         {
-                            throw new NotImplementedException("Unknown property");
+                            throw new NotImplementedException($"Unknown property - '{properties[i]}'");
                         }
                     }
 
-                    //Only add one instance of the game Id to the list.
-                    //Currently an issue with duplicate games in the history (Check ReadMe.md)
+                    ///Only add one instance of the game Id to the list.
+                    ///Currently an issue with duplicate games in the history (Check ReadMe.md)
                     if (!matches.Exists(x => x.MatchId == m.MatchId))
                     {
                         matches.Add(m);
                     }
                 }
-
-                return matches;
-            }
-            catch (Exception e)
-            {
-                Console.WriteLine($"Unable to decode pasted content - '{e.ToString()}'");
-                return null;
+                catch (Exception e)
+                {
+                    Logger.OutputError($"Unable to decode pasted content - '{e.ToString()}'");
+                    return null;
+                }
             }
+
+            return matches;
         }
 
         private static string RemoveFormatting(string s)