feat(logger): work with the new Pollination.Logger

Author: MingboPeng

src/PollinationSDK/Helper/AuthHelper.cs

@@ -4,11 +4,13 @@
 using System.Threading.Tasks;
 using System.Collections.Specialized;
 using PollinationSDK.Client;
+using Pollination;
 
 namespace PollinationSDK
 {
     public static class AuthHelper
     {
+        private static Microsoft.Extensions.Logging.ILogger Logger => LogUtils.GetLogger(nameof(AuthHelper));
         public struct AuthResult
         {
             public string IDToken;
@@ -71,7 +73,7 @@ public static async Task SignInAsync(Action ActionWhenDone = default, bool devEn
             }
             catch (Exception e)
             {
-                LogHelper.LogThrowError(e);
+                Logger.ThrowError(e);
             }
 
         }
@@ -87,18 +89,18 @@ public static async Task SignInWithApiAuthAsync(string apiAuth, Action ActionWhe
                     Configuration.Default.BasePath = devEnv ? ApiURL_Dev : ApiURL;
                     Configuration.Default.AddApiKey("x-pollination-token", apiAuth);
                     Helper.CurrentUser = Helper.GetUser();
-                    LogHelper.LogInfo($"Logged in as {Helper.CurrentUser.Username}");
+                    Logger.Info($"Logged in as {Helper.CurrentUser.Username}");
                 }
                 else
                 {
-                    LogHelper.LogWarning($"Invalid apiAuth");
+                    Logger.Warning($"Invalid apiAuth");
                 }
 
                 ActionWhenDone?.Invoke();
             }
             catch (Exception e)
             {
-                LogHelper.LogThrowError(e);
+                Logger.ThrowError(e);
             }
 
         }
@@ -107,10 +109,10 @@ public static async Task SignInWithApiAuthAsync(string apiAuth, Action ActionWhe
         private static async Task<AuthResult> PollinationSignInAsync(bool devEnv = false)
         {
             if (!HttpListener.IsSupported) 
-                LogHelper.LogThrowError($"HttpListener is not supported on this system");
+                Logger.ThrowError($"HttpListener is not supported on this system");
 
             if (!System.Net.NetworkInformation.NetworkInterface.GetIsNetworkAvailable())
-                LogHelper.LogThrowError($"Network is not available, please double check with your connection or firewall!");
+                Logger.ThrowError($"Network is not available, please double check with your connection or firewall!");
 
             var redirectUrl = "http://localhost:8645/";
             var loginUrl = devEnv ? LoginURL_Dev : LoginURL;
@@ -131,9 +133,9 @@ private static async Task<AuthResult> PollinationSignInAsync(bool devEnv = false
                 {
                     //it is already listening the port, but users didn't login
                     if (e.ErrorCode == 183) 
-                        LogHelper.LogWarning($"It is still waiting for users to login from last time.\n{e.Message}");
+                        Logger.Warning($"It is still waiting for users to login from last time.\n{e.Message}");
                     else 
-                        LogHelper.LogThrowError($"Failed to start the listener.\n{e.Message}");
+                        Logger.ThrowError($"Failed to start the listener.\n{e.Message}");
 
                 }
 
@@ -143,7 +145,7 @@ private static async Task<AuthResult> PollinationSignInAsync(bool devEnv = false
                     UseShellExecute = true
                 };
                 System.Diagnostics.Process.Start(psi);
-                LogHelper.LogInfo($"Login from {loginUrl}");
+                Logger.Info($"Login from {loginUrl}");
 
                 // wait for the authorization response.
                 var context = await listener.GetContextAsync();
@@ -153,7 +155,7 @@ private static async Task<AuthResult> PollinationSignInAsync(bool devEnv = false
 
                 var returnUrl = request.RawUrl.Contains("?token=") ? request.RawUrl : request.UrlReferrer?.PathAndQuery;
                 if (string.IsNullOrEmpty(returnUrl)) 
-                    LogHelper.LogThrowError($"Failed to authorize the login: \n{request.RawUrl}");
+                    Logger.ThrowError($"Failed to authorize the login: \n{request.RawUrl}");
 
                 var auth = AuthResult.From(request.QueryString);
                 var loggedIn = CheckGetUser(auth, out var error, devEnv);
@@ -176,7 +178,7 @@ private static async Task<AuthResult> PollinationSignInAsync(bool devEnv = false
                 responseOutput.Flush();
                 responseOutput.Close();
 
-                LogHelper.LogInfo($"Closed listener");
+                Logger.Info($"Closed listener");
 
                 return auth;
             }
@@ -203,7 +205,7 @@ private static bool CheckGetUser(AuthResult auth, out string errorMessage, bool
                     refreshToken: auth.RefreshToken
                 );
                 Helper.CurrentUser = Helper.GetUser();
-                LogHelper.LogInfo($"Logged in as {Helper.CurrentUser.Username}");
+                Logger.Info($"Logged in as {Helper.CurrentUser.Username}");
 
                 return true;
 
@@ -212,7 +214,7 @@ private static bool CheckGetUser(AuthResult auth, out string errorMessage, bool
             {
                 Configuration.Default.TokenRepo = null;
                 Helper.CurrentUser = null;
-                LogHelper.LogError(e);
+                Logger.Error(e);
                 errorMessage = e.Message;
                 return false;
                 //throw;

src/PollinationSDK/Helper/HandlerChecker.cs

@@ -6,6 +6,7 @@
 using System.Linq;
 using System.Reflection;
 using System.Text;
+using Pollination;
 
 namespace PollinationSDK
 {
@@ -15,6 +16,8 @@ namespace PollinationSDK
     /// </summary>
     public abstract class HandlerChecker
     {
+        private static Microsoft.Extensions.Logging.ILogger Logger => LogUtils.GetLogger<HandlerChecker>();
+
         public object CheckWithHandlers(object inputData, List<IOAliasHandler> handlers)
         {
             if (inputData == null) return inputData;
@@ -34,7 +37,7 @@ public object CheckWithHandlers(object inputData, List<IOAliasHandler> handlers)
                 }
                 catch (Exception e)
                 {
-                    LogHelper.LogError(e);
+                    Logger.Error(e);
                     errors.Add($"{e?.Message}{Environment.NewLine}From {item.Function}(Handler-{item.Language})");
                     break;
                     //throw;
@@ -159,7 +162,7 @@ private static Assembly LoadDll(string csProjName)
             }
             catch (Exception ex)
             {
-                throw LogHelper.LogReturnError(ex, $"PollinationSDK: cannot find handler libraries.");
+                throw Logger.ReturnError($"Cannot find handler libraries.\n{ex}");
             }
         }
 

src/PollinationSDK/Helper/Helper.cs

@@ -10,12 +10,14 @@
 using System.Net;
 using System.Threading;
 using System.Threading.Tasks;
+using Pollination;
 
 namespace PollinationSDK
 {
     public static class Helper
     {
-        public static Serilog.ILogger Logger { get; set; } = Serilog.Log.Logger;
+        private static Microsoft.Extensions.Logging.ILogger Logger => LogUtils.GetLogger(nameof(Helper));
+
         public static UserPrivate CurrentUser { get; set; }
 
         public static UserPrivate GetUser()
@@ -67,13 +69,13 @@ public static Project GetAProject(string userName, string projectName)
                 // Project not found and person account, create a default demo project.
                 if (e.ErrorCode == 404 && userName == Helper.CurrentUser.Username)
                 {
-                    Logger.Information($"Project {projectName} is not found in account {userName}. Now creating this project.");
+                    Logger.Info($"Project {projectName} is not found in account {userName}. Now creating this project.");
                     var ifPublic = projectName == "demo";
                     var res = api.CreateProject(userName, new ProjectCreate(projectName, _public: ifPublic));
                     return GetAProject(userName, projectName);
                 }
-                LogHelper.LogError(e, $"Failed to get the project {userName}/{projectName}");
-                throw e;
+                Logger.Error($"Failed to get the project {userName}/{projectName}" + "{e}", new[] { e });
+                throw;
             }
 
 
@@ -90,14 +92,14 @@ public static Project GetWritableProject(string projectSlug)
 
         public static async Task<bool> UploadDirectoryAsync(Project project, string directory, Action<int> reportProgressAction = default, CancellationToken cancellationToken = default)
         {
-            LogHelper.LogInfo($"Uploading a directory {directory}");
-            LogHelper.LogInfo($"Timeout: {Configuration.Default.Timeout}");
+            Logger.Info($"Uploading a directory {directory}");
+            Logger.Info($"Timeout: {Configuration.Default.Timeout}");
 
             var files = Directory.GetFiles(directory, "*", SearchOption.AllDirectories);
             var api = new ArtifactsApi();
 
             var total = files.Count();
-            LogHelper.LogInfo($"Uploading {total} assets for project {project.Name}");
+            Logger.Info($"Uploading {total} assets for project {project.Name}");
 
             var finished = 0;
             var finishedPercent = 0;
@@ -125,7 +127,7 @@ public static async Task<bool> UploadDirectoryAsync(Project project, string dire
                 finished += chunk.Count;
             }
 
-            LogHelper.LogInfo($"Finished uploading assets for project {project.Name}");
+            Logger.Info($"Finished uploading assets for project {project.Name}");
 
             // canceled by user
             if (cancellationToken.IsCancellationRequested) return false;
@@ -143,7 +145,7 @@ private static async Task<bool> BatchExecute(ArtifactsApi api, Project project,
                 // canceled by user
                 if (cancellationToken.IsCancellationRequested)
                 {
-                    LogHelper.LogInfo($"Canceled uploading by user");
+                    Logger.Info($"Canceled uploading by user");
                     break;
                 }
 
@@ -152,7 +154,7 @@ private static async Task<bool> BatchExecute(ArtifactsApi api, Project project,
 
                 if (finishedTask.IsFaulted || finishedTask.Exception != null)
                 {
-                    LogHelper.LogError($"Upload exception: {finishedTask.Exception}");
+                    Logger.Error($"Upload exception: {finishedTask.Exception}");
                     throw finishedTask.Exception;
                 }
 
@@ -200,18 +202,18 @@ public static async Task<bool> UploadArtifactAsync(ArtifactsApi api, Project pro
 
             restRequest.AddFile("file", filePath);
 
-            LogHelper.LogInfo($"Started upload of {fileRelativePath}");
+            Logger.Info($"Started upload of {fileRelativePath}");
             var response = await restClient.ExecuteAsync(restRequest);
 
             if (response.StatusCode == HttpStatusCode.NoContent)
             {
-                LogHelper.LogInfo($"Done uploading {fileRelativePath}");
+                Logger.Info($"Done uploading {fileRelativePath}");
                 return true;
             }
             else
             {
-                LogHelper.LogInfo($"Received response code: {response.StatusCode}");
-                LogHelper.LogInfo($"{response.Content}");
+                Logger.Info($"Received response code: {response.StatusCode}");
+                Logger.Info($"{response.Content}");
             }
             return false;
         }
@@ -533,13 +535,13 @@ public static async Task<string> DownloadArtifactAsync(ArtifactsApi api, string
 
             var url = (await api.DownloadArtifactAsync(projOwner, projName, fileRelativePath))?.ToString();
 
-            LogHelper.LogInfo($"Downloading {fileRelativePath} from \n  -{url}\n");
+            Logger.Info($"Downloading {fileRelativePath} from \n  -{url}\n");
             // get relative path correct
             saveAsDir = Path.GetDirectoryName(Path.Combine(saveAsDir, relativePath));
             saveAsDir = Path.GetFullPath(saveAsDir);
             var path = await Helper.DownloadUrlAsync(url.ToString(), saveAsDir, reportProgressAction, null, cancelToken);
 
-            LogHelper.LogInfo($"Saved {fileRelativePath} to {path}");
+            Logger.Info($"Saved {fileRelativePath} to {path}");
             return path;
         }
 
@@ -551,13 +553,13 @@ public static async Task<string> DownloadArtifactAsync(JobsApi api, string projO
 
             var url = (await api.DownloadJobArtifactAsync(projOwner, projName, jobId, fileRelativePath, cancelToken))?.ToString();
 
-            LogHelper.LogInfo($"Downloading {fileRelativePath} from \n  -{url}\n");
+            Logger.Info($"Downloading {fileRelativePath} from \n  -{url}\n");
             // get relative path correct
             saveAsDir = Path.GetDirectoryName(Path.Combine(saveAsDir, relativePath));
             saveAsDir = Path.GetFullPath(saveAsDir);
             var path = await Helper.DownloadUrlAsync(url.ToString(), saveAsDir, reportProgressAction, null, cancelToken);
 
-            LogHelper.LogInfo($"Saved {fileRelativePath} to {path}");
+            Logger.Info($"Saved {fileRelativePath} to {path}");
             return path;
         }
 
@@ -646,7 +648,7 @@ public static async Task<string> DownloadUrlAsync(string url, string saveAsDir,
 
             Directory.CreateDirectory(saveAsDir);
             var file = Path.Combine(saveAsDir, fileName);
-            LogHelper.LogInfo($"Downloading {url}");
+            Logger.Info($"Downloading {url}");
             using (WebClient wc = new WebClient())
             {
                 var prog = 0;
@@ -669,7 +671,7 @@ public static async Task<string> DownloadUrlAsync(string url, string saveAsDir,
                     await t;
                     if (t.IsFaulted && t.Exception != null)
                         throw t.Exception;
-                    LogHelper.LogInfo($"Saved {fileName} to {file}");
+                    Logger.Info($"Saved {fileName} to {file}");
                 }
                 catch (WebException ex) when (ex.Status == WebExceptionStatus.RequestCanceled)
                 {
@@ -689,7 +691,7 @@ public static async Task<string> DownloadUrlAsync(string url, string saveAsDir,
 
             if (!File.Exists(file))
             {
-                throw LogHelper.LogReturnError($"Failed to download {fileName}");
+                throw Logger.ReturnError($"Failed to download {fileName}");
             }
             var outputDirOrFile = file;
 
@@ -700,7 +702,7 @@ public static async Task<string> DownloadUrlAsync(string url, string saveAsDir,
             }
             catch (Exception e)
             {
-                throw LogHelper.LogReturnError(e, $"Unable to unzip file {Path.GetFileName(file)}");
+                throw Logger.ReturnError($"Unable to unzip file {Path.GetFileName(file)}\n {e}");
             }
 
             return outputDirOrFile;

src/PollinationSDK/Helper/LogUtils.cs

@@ -0,0 +1,22 @@
+using Microsoft.Extensions.Logging;
+using System;
+
+namespace PollinationSDK
+{
+    internal static class LogUtils
+    {
+        private static string _namespaceName = System.Reflection.MethodBase.GetCurrentMethod()?.DeclaringType?.Namespace ?? "Unknown Namespace";
+        private static string _className = System.Reflection.MethodBase.GetCurrentMethod()?.DeclaringType?.Name ?? "Unknown Class";
+        private static string _logCatagory = $"{_namespaceName}.{_className}";
+
+        private static Pollination.LogHelper? _helper;
+        internal static Pollination.LogHelper Helper => _helper ??= new Pollination.LogHelper(_logCatagory);
+
+        internal static ILogger GetLogger<T>() => Helper.GetLogger<T>();
+        internal static ILogger GetLogger(Type type) => Helper.GetLogger(type);
+        internal static ILogger GetLogger(string catName) => Helper.GetLogger(catName);
+
+        internal static ILogger Logger => GetLogger(_logCatagory);
+    }
+
+}