sessionmanager: add tracing

Add basic tracing to the `ISessionManager` implementations.

This will help us identify why we think we're in a desktop session, or
have a web browser available (or not).

Signed-off-by: Matthew John Cheetham <mjcheetham@outlook.com>

Author: mjcheetham

src/shared/Core/CommandContext.cs

@@ -103,7 +103,7 @@ public CommandContext()
             {
                 FileSystem        = new WindowsFileSystem();
                 Environment       = new WindowsEnvironment(FileSystem);
-                SessionManager    = new WindowsSessionManager(Environment, FileSystem);
+                SessionManager    = new WindowsSessionManager(Trace, Environment, FileSystem);
                 ProcessManager    = new WindowsProcessManager(Trace2);
                 Terminal          = new WindowsTerminal(Trace, Trace2);
                 string gitPath    = GetGitPath(Environment, FileSystem, Trace);
@@ -120,7 +120,7 @@ public CommandContext()
             {
                 FileSystem        = new MacOSFileSystem();
                 Environment       = new MacOSEnvironment(FileSystem);
-                SessionManager    = new MacOSSessionManager(Environment, FileSystem);
+                SessionManager    = new MacOSSessionManager(Trace, Environment, FileSystem);
                 ProcessManager    = new ProcessManager(Trace2);
                 Terminal          = new MacOSTerminal(Trace, Trace2);
                 string gitPath    = GetGitPath(Environment, FileSystem, Trace);
@@ -137,7 +137,7 @@ public CommandContext()
             {
                 FileSystem        = new LinuxFileSystem();
                 Environment       = new PosixEnvironment(FileSystem);
-                SessionManager    = new LinuxSessionManager(Environment, FileSystem);
+                SessionManager    = new LinuxSessionManager(Trace, Environment, FileSystem);
                 ProcessManager    = new ProcessManager(Trace2);
                 Terminal          = new LinuxTerminal(Trace, Trace2);
                 string gitPath    = GetGitPath(Environment, FileSystem, Trace);

src/shared/Core/ISessionManager.cs

@@ -40,14 +40,17 @@ public static void OpenBrowser(this ISessionManager sm, string url)
 
     public abstract class SessionManager : ISessionManager
     {
+        protected ITrace Trace { get; }
         protected IEnvironment Environment { get; }
         protected IFileSystem FileSystem { get; }
 
-        protected SessionManager(IEnvironment env, IFileSystem fs)
+        protected SessionManager(ITrace trace, IEnvironment env, IFileSystem fs)
         {
+            EnsureArgument.NotNull(trace, nameof(trace));
             EnsureArgument.NotNull(env, nameof(env));
             EnsureArgument.NotNull(fs, nameof(fs));
 
+            Trace = trace;
             Environment = env;
             FileSystem = fs;
         }
@@ -69,6 +72,7 @@ public void OpenBrowser(Uri uri)
 
         protected virtual void OpenBrowserInternal(string url)
         {
+            Trace.WriteLine("Opening browser using framework shell-execute: " + url);
             var psi = new ProcessStartInfo(url) { UseShellExecute = true };
             Process.Start(psi);
         }

src/shared/Core/Interop/Linux/LinuxSessionManager.cs

@@ -8,7 +8,7 @@ public class LinuxSessionManager : PosixSessionManager
 {
     private bool? _isWebBrowserAvailable;
 
-    public LinuxSessionManager(IEnvironment env, IFileSystem fs) : base(env, fs)
+    public LinuxSessionManager(ITrace trace, IEnvironment env, IFileSystem fs) : base(trace, env, fs)
     {
         PlatformUtils.EnsureLinux();
     }
@@ -41,6 +41,8 @@ protected override void OpenBrowserInternal(string url)
             throw new Exception("Failed to locate a utility to launch the default web browser.");
         }
 
+        Trace.WriteLine("Opening browser using URL handler: " + shellExecPath);
+
         var psi = new ProcessStartInfo(shellExecPath, url)
         {
             RedirectStandardOutput = true,
@@ -56,6 +58,7 @@ private bool GetWebBrowserAvailable()
         // We need a shell execute handler to be able to launch to browser
         if (!TryGetShellExecuteHandler(Environment, out _))
         {
+            Trace.WriteLine("Could not locate a shell execute handler for Linux - browser is not available.");
             return false;
         }
 
@@ -82,6 +85,7 @@ private bool GetWebBrowserAvailable()
         if (WslUtils.IsWslDistribution(Environment, FileSystem, out _) &&
             WslUtils.GetWindowsSessionId(FileSystem) == 0)
         {
+            Trace.WriteLine("This is a WSL distribution, but Windows session 0 was detected - browser is not available.");
             return false;
         }
 

src/shared/Core/Interop/MacOS/MacOSSessionManager.cs

@@ -5,7 +5,7 @@ namespace GitCredentialManager.Interop.MacOS
 {
     public class MacOSSessionManager : PosixSessionManager
     {
-        public MacOSSessionManager(IEnvironment env, IFileSystem fs) : base(env, fs)
+        public MacOSSessionManager(ITrace trace, IEnvironment env, IFileSystem fs) : base(trace, env, fs)
         {
             PlatformUtils.EnsureMacOS();
         }

src/shared/Core/Interop/Posix/PosixSessionManager.cs

@@ -2,7 +2,7 @@ namespace GitCredentialManager.Interop.Posix
 {
     public abstract class PosixSessionManager : SessionManager
     {
-        protected PosixSessionManager(IEnvironment env, IFileSystem fs) : base(env, fs)
+        protected PosixSessionManager(ITrace trace, IEnvironment env, IFileSystem fs) : base(trace, env, fs)
         {
             PlatformUtils.EnsurePosix();
         }

src/shared/Core/Interop/Windows/WindowsSessionManager.cs

@@ -5,7 +5,7 @@ namespace GitCredentialManager.Interop.Windows
 {
     public class WindowsSessionManager : SessionManager
     {
-        public WindowsSessionManager(IEnvironment env, IFileSystem fs) : base(env, fs)
+        public WindowsSessionManager(ITrace trace, IEnvironment env, IFileSystem fs) : base(trace, env, fs)
         {
             PlatformUtils.EnsureWindows();
         }