Add logging to queue clients

Author: ethanhann

src/InEngine.Core/Queuing/Clients/FileClient.cs

@@ -3,14 +3,15 @@
 using System.IO;
 using System.Linq;
 using System.Threading;
-using System.Threading.Tasks;
 using InEngine.Core.Exceptions;
+using InEngine.Core.Logging;
 using InEngine.Core.Queuing.Message;
 
 namespace InEngine.Core.Queuing.Clients
 {
     public class FileClient : IQueueClient
     {
+        public ILog Log { get; set; } = new Log();
         public int Id { get; set; } = 0;
         public string QueueBaseName { get; set; }
         public string QueueName { get; set; }
@@ -72,13 +73,14 @@ public void Consume(CancellationToken cancellationToken)
                     cancellationToken.ThrowIfCancellationRequested();
                 }
             }
-            catch (OperationCanceledException)
+            catch (OperationCanceledException exception)
             {
+                Log.Debug(exception);
                 return;
             }
             catch (Exception exception)
             {
-                Console.WriteLine(exception.Message);
+                Log.Error(exception);
             }
         }
 
@@ -96,9 +98,10 @@ public ICommandEnvelope Consume()
             {
                 fileInfo.MoveTo(inProgressFilePath);
             }
-            catch (FileNotFoundException)
+            catch (FileNotFoundException exception)
             {
                 // Another process probably consumed the file when it was read and moved.
+                Log.Debug(exception);
                 return null;
             }
 
@@ -114,6 +117,7 @@ public ICommandEnvelope Consume()
             }
             catch (Exception exception)
             {
+                Log.Error(exception);
                 if (command.CommandLifeCycle.ShouldRetry())
                     File.Move(inProgressFilePath, Path.Combine(PendingQueuePath, fileInfo.Name));
                 else
@@ -127,6 +131,7 @@ public ICommandEnvelope Consume()
             }
             catch (Exception exception)
             {
+                Log.Error(exception);
                 throw new CommandFailedException("Failed to move command from in-progress queue.", exception);
             }
 

src/InEngine.Core/Queuing/Clients/RedisClient.cs

@@ -4,13 +4,15 @@
 using System.Threading;
 using System.Threading.Tasks;
 using InEngine.Core.Exceptions;
+using InEngine.Core.Logging;
 using InEngine.Core.Queuing.Message;
 using StackExchange.Redis;
 
 namespace InEngine.Core.Queuing.Clients
 {
     public class RedisClient : IQueueClient
     {
+        public ILog Log { get; set; } = new Log();
         public int Id { get; set; } = 0;
         public string QueueBaseName { get; set; } = "InEngineQueue";
         public string QueueName { get; set; } = "Primary";
@@ -78,13 +80,14 @@ public void Consume(CancellationToken cancellationToken)
                     Task.Factory.StartNew(Consume, cancellationToken, TaskCreationOptions.LongRunning, TaskScheduler.Default);
                 });
             }
-            catch (OperationCanceledException)
+            catch (OperationCanceledException exception)
             {
+                Log.Debug(exception);
                 return;
             }
             catch (Exception exception)
             {
-                Console.WriteLine(exception.Message);
+                Log.Error(exception);
             }
         }
 
@@ -108,6 +111,7 @@ public ICommandEnvelope Consume()
             }
             catch (Exception exception)
             {
+                Log.Error(exception);
                 Redis.ListRemove(InProgressQueueName, serializedMessage, 1);
                 if (command.CommandLifeCycle.ShouldRetry())
                     Redis.ListLeftPush(PendingQueueName, commandEnvelope.SerializeToJson());
@@ -124,6 +128,7 @@ public ICommandEnvelope Consume()
             }
             catch (Exception exception)
             {
+                Log.Error(exception);
                 throw new CommandFailedException($"Failed to remove completed commandEnvelope from queue: {InProgressQueueName}", exception);
             }
 

src/InEngine.Core/Queuing/Clients/SyncClient.cs

@@ -1,12 +1,14 @@
 using System;
 using System.Collections.Generic;
 using System.Threading;
+using InEngine.Core.Logging;
 using InEngine.Core.Queuing.Message;
 
 namespace InEngine.Core.Queuing.Clients
 {
     public class SyncClient : IQueueClient
     {
+        public ILog Log { get; set; } = new Log();
         public int Id { get; set; } = 0;
         public string QueueBaseName { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
         public string QueueName { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }

src/InEngine.Core/Queuing/Dequeue.cs

@@ -24,7 +24,7 @@ public async Task StartAsync()
         {
             if (QueueSettings == null)
                 QueueSettings = InEngineSettings.Make().Queue;
-            
+
             var allTasks = new List<Task>();
             Log.Debug("Start dequeue tasks for primary queue...");
             allTasks.AddRange(MakeTasks(true, QueueSettings.PrimaryQueueConsumers));
@@ -44,6 +44,7 @@ IList<Task> MakeTasks(bool useSecondaryQueue = false, int numberOfTasks = 0)
                 return Task.Factory.StartNew(() => {
                     var queue = QueueAdapter.Make(useSecondaryQueue, QueueSettings);
                     queue.Id = i;
+                    queue.Log = Log;
                     queueAdapters.Add(queue);
                     queue.Consume(CancellationTokenSource.Token);
                 }, TaskCreationOptions.LongRunning);

src/InEngine.Core/Queuing/IQueueClient.cs

@@ -1,11 +1,13 @@
 using System.Collections.Generic;
 using System.Threading;
+using InEngine.Core.Logging;
 using InEngine.Core.Queuing.Message;
 
 namespace InEngine.Core.Queuing
 {
     public interface IQueueClient
     {
+        ILog Log { get; set; }
         int Id { get; set; }
         string QueueBaseName { get; set; }
         string QueueName { get; set; }

src/InEngine.Core/Queuing/QueueAdapter.cs

@@ -1,15 +1,16 @@
 using System;
 using System.Collections.Generic;
-using System.Reflection;
 using System.Threading;
 using InEngine.Core.Exceptions;
+using InEngine.Core.Logging;
 using InEngine.Core.Queuing.Clients;
 using InEngine.Core.Queuing.Message;
 
 namespace InEngine.Core.Queuing
 {
     public class QueueAdapter : IQueueClient
     {
+        public ILog Log { get; set; } = new Log();
         public int Id { get { return QueueClient.Id; } set { QueueClient.Id = value; } }
         public IQueueClient QueueClient { get; set; }
         public string QueueBaseName { get => QueueClient.QueueBaseName; set => QueueClient.QueueBaseName = value; }