Task/Cache Jenga 2: Fixing initialization and git installation and other fixes

src/GitHub.Api/Application/ApplicationManagerBase.cs

@@ -12,9 +12,17 @@ abstract class ApplicationManagerBase : IApplicationManager
         protected static ILogging Logger { get; } = LogHelper.GetLogger<IApplicationManager>();
 
         private RepositoryManager repositoryManager;
+        private Progress progressReporter;
+        protected bool isBusy;
+        public event Action<IProgress> OnProgress
+        {
+            add { progressReporter.OnProgress += value; }
+            remove { progressReporter.OnProgress -= value; }
+        }
 
         public ApplicationManagerBase(SynchronizationContext synchronizationContext)
         {
+            progressReporter = new Progress();
             SynchronizationContext = synchronizationContext;
             SynchronizationContext.SetSynchronizationContext(SynchronizationContext);
             ThreadingHelper.SetUIThread();
@@ -47,7 +55,7 @@ public void Run(bool firstRun)
         {
             Logger.Trace("Run - CurrentDirectory {0}", NPath.CurrentDirectory);
 
-            var gitExecutablePath = SystemSettings.Get(Constants.GitInstallPathKey)?.ToNPath();            
+            var gitExecutablePath = SystemSettings.Get(Constants.GitInstallPathKey)?.ToNPath();
             if (gitExecutablePath != null && gitExecutablePath.FileExists()) // we have a git path
             {
                 Logger.Trace("Using git install path from settings: {0}", gitExecutablePath);
@@ -57,9 +65,12 @@ public void Run(bool firstRun)
             {
                 Logger.Trace("No git path found in settings");
 
-                var initEnvironmentTask = new ActionTask<NPath>(CancellationToken, (b, path) => InitializeEnvironment(path)) { Affinity = TaskAffinity.UI };
+                isBusy = true;
+                var initEnvironmentTask = new ActionTask<NPath>(CancellationToken,
+                    (b, path) => InitializeEnvironment(path)) { Affinity = TaskAffinity.UI };
                 var findExecTask = new FindExecTask("git", CancellationToken)
-                    .FinallyInUI((b, ex, path) => {
+                    .FinallyInUI((b, ex, path) =>
+                    {
                         if (b && path != null)
                         {
                             Logger.Trace("FindExecTask Success: {0}", path);
@@ -70,13 +81,21 @@ public void Run(bool firstRun)
                             Logger.Warning("FindExecTask Failure");
                             Logger.Error("Git not found");
                         }
+                        isBusy = false;
                     });
 
-                var installDetails = new GitInstallDetails(Environment.UserCachePath, true);
-                var gitInstaller = new GitInstaller(Environment, CancellationToken, installDetails);
+                var gitInstaller = new GitInstaller(Environment, CancellationToken);
 
                 // if successful, continue with environment initialization, otherwise try to find an existing git installation
-                gitInstaller.SetupGitIfNeeded(initEnvironmentTask, findExecTask);
+                var setupTask = gitInstaller.SetupGitIfNeeded();
+                setupTask.Progress(progressReporter.UpdateProgress);
+                setupTask.OnEnd += (thisTask, result, success, exception) =>
+                {
+                    if (success && result != null)
+                        thisTask.Then(initEnvironmentTask);
+                    else
+                        thisTask.Then(findExecTask);
+                };
             }
         }
 
@@ -131,6 +150,7 @@ public void RestartRepository()
                 repositoryManager.Initialize();
                 Environment.Repository.Initialize(repositoryManager);
                 repositoryManager.Start();
+                Environment.Repository.Start();
                 Logger.Trace($"Got a repository? {Environment.Repository}");
             }
         }
@@ -171,34 +191,34 @@ protected void SetupMetrics(string unityVersion, bool firstRun)
         /// <param name="gitExecutablePath"></param>
         private void InitializeEnvironment(NPath gitExecutablePath)
         {
-            var afterGitSetup = new ActionTask(CancellationToken, RestartRepository)
-                .ThenInUI(InitializeUI);
-
             Environment.GitExecutablePath = gitExecutablePath;
             Environment.User.Initialize(GitClient);
 
+            var afterGitSetup = new ActionTask(CancellationToken, RestartRepository)
+                .ThenInUI(InitializeUI);
+
+            ITask task = afterGitSetup;
             if (Environment.IsWindows)
             {
-                var task = GitClient
-                    .GetConfig("credential.helper", GitConfigSource.Global)
-                    .Then((b, credentialHelper) => {
-                        if (string.IsNullOrEmpty(credentialHelper))
+                var credHelperTask = GitClient.GetConfig("credential.helper", GitConfigSource.Global);
+                credHelperTask.OnEnd += (thisTask, credentialHelper, success, exception) =>
+                    {
+                        if (!success || string.IsNullOrEmpty(credentialHelper))
                         {
                             Logger.Warning("No Windows CredentialHelper found: Setting to wincred");
-                            throw new ArgumentNullException(nameof(credentialHelper));
+                            thisTask
+                                .Then(GitClient.SetConfig("credential.helper", "wincred", GitConfigSource.Global))
+                                .Then(afterGitSetup);
                         }
-                    });
-                // if there's no credential helper, set it before restarting the repository
-                task.Then(GitClient.SetConfig("credential.helper", "wincred", GitConfigSource.Global), TaskRunOptions.OnFailure)
-                    .Then(afterGitSetup, taskIsTopOfChain: true);
-
-                // if there's a credential helper, we're good, restart the repository
-                task.Then(afterGitSetup, TaskRunOptions.OnSuccess, taskIsTopOfChain: true);
+                        else
+                            thisTask.Then(afterGitSetup);
+                    };
+                task = credHelperTask;
             }
-
-            afterGitSetup.Start();
+            task.Start();
         }
 
+
         private bool disposed = false;
         protected virtual void Dispose(bool disposing)
         {
@@ -228,6 +248,7 @@ public void Dispose()
         public ISettings SystemSettings { get; protected set; }
         public ISettings UserSettings { get; protected set; }
         public IUsageTracker UsageTracker { get; protected set; }
+        public bool IsBusy { get { return isBusy || (RepositoryManager?.IsBusy ?? false); } }
         protected TaskScheduler UIScheduler { get; private set; }
         protected SynchronizationContext SynchronizationContext { get; private set; }
         protected IRepositoryManager RepositoryManager { get { return repositoryManager; } }

src/GitHub.Api/Application/IApplicationManager.cs

@@ -17,9 +17,10 @@ public interface IApplicationManager : IDisposable
         ITaskManager TaskManager { get; }
         IGitClient GitClient { get; }
         IUsageTracker UsageTracker { get; }
-
+        bool IsBusy { get; }
         void Run(bool firstRun);
         void RestartRepository();
         ITask InitializeRepository();
+        event Action<IProgress> OnProgress;
     }
 }

src/GitHub.Api/Cache/CacheInterfaces.cs

@@ -84,7 +84,7 @@ public interface IConfigRemoteDictionary : IDictionary<string, ConfigRemote>
     public interface IBranchCache : IManagedCache
     {
         ConfigRemote? CurrentConfigRemote { get; set; }
-        ConfigBranch? CurentConfigBranch { get; set; }
+        ConfigBranch? CurrentConfigBranch { get; set; }
 
         GitBranch[] LocalBranches { get; set; }
         GitBranch[] RemoteBranches { get; set; }
@@ -105,7 +105,7 @@ public interface IBranchCache : IManagedCache
     public interface IRepositoryInfoCache : IManagedCache
     {
         GitRemote? CurrentGitRemote { get; set; }
-        GitBranch? CurentGitBranch { get; set; }
+        GitBranch? CurrentGitBranch { get; set; }
     }
 
     public interface IGitLogCache : IManagedCache

src/GitHub.Api/Git/IRepository.cs

@@ -78,5 +78,6 @@ public interface IRepository : IEquatable<IRepository>
         event Action<CacheUpdateEvent> LocksChanged;
         event Action<CacheUpdateEvent> RemoteBranchListChanged;
         event Action<CacheUpdateEvent> LocalAndRemoteBranchListChanged;
+        void Start();
     }
 }

src/GitHub.Api/Git/Repository.cs

@@ -15,6 +15,7 @@ class Repository : IEquatable<Repository>, IRepository
         private ICacheContainer cacheContainer;
         private UriString cloneUrl;
         private string name;
+        private HashSet<CacheType> cacheInvalidationRequests = new HashSet<CacheType>();
 
         public event Action<CacheUpdateEvent> LogChanged;
         public event Action<CacheUpdateEvent> TrackingStatusChanged;
@@ -39,7 +40,7 @@ public Repository(NPath localPath, ICacheContainer container)
             LocalPath = localPath;
 
             cacheContainer = container;
-            cacheContainer.CacheInvalidated += CacheContainer_OnCacheInvalidated;
+            cacheContainer.CacheInvalidated += InvalidateCache;
             cacheContainer.CacheUpdated += CacheContainer_OnCacheUpdated;
         }
 
@@ -58,6 +59,14 @@ public void Initialize(IRepositoryManager initRepositoryManager)
             repositoryManager.RemoteBranchesUpdated += RepositoryManagerOnRemoteBranchesUpdated;
         }
 
+        public void Start()
+        {
+            foreach (var req in cacheInvalidationRequests)
+            {
+                InvalidateCache(req);
+            }
+        }
+
         public ITask SetupRemote(string remote, string remoteUrl)
         {
             Guard.ArgumentNotNullOrWhiteSpace(remote, "remote");
@@ -275,8 +284,16 @@ private void CheckBranchCacheEvent(CacheUpdateEvent cacheUpdateEvent)
             }
         }
 
-        private void CacheContainer_OnCacheInvalidated(CacheType cacheType)
+        private void InvalidateCache(CacheType cacheType)
         {
+            if (repositoryManager == null)
+            {
+                if (!cacheInvalidationRequests.Contains(cacheType))
+                    cacheInvalidationRequests.Add(cacheType);
+                return;
+            }
+
+
             switch (cacheType)
             {
                 case CacheType.BranchCache:
@@ -298,6 +315,7 @@ private void CacheContainer_OnCacheInvalidated(CacheType cacheType)
                     break;
 
                 case CacheType.RepositoryInfoCache:
+                    repositoryManager?.UpdateRepositoryInfo();
                     break;
 
                 case CacheType.GitStatusEntriesCache:
@@ -523,8 +541,8 @@ public GitBranch[] RemoteBranches
 
         private ConfigBranch? CurrentConfigBranch
         {
-            get { return this.cacheContainer.BranchCache.CurentConfigBranch; }
-            set { cacheContainer.BranchCache.CurentConfigBranch = value; }
+            get { return this.cacheContainer.BranchCache.CurrentConfigBranch; }
+            set { cacheContainer.BranchCache.CurrentConfigBranch = value; }
         }
 
         private ConfigRemote? CurrentConfigRemote
@@ -553,8 +571,8 @@ public List<GitStatusEntry> CurrentChanges
 
         public GitBranch? CurrentBranch
         {
-            get { return cacheContainer.RepositoryInfoCache.CurentGitBranch; }
-            private set { cacheContainer.RepositoryInfoCache.CurentGitBranch = value; }
+            get { return cacheContainer.RepositoryInfoCache.CurrentGitBranch; }
+            private set { cacheContainer.RepositoryInfoCache.CurrentGitBranch = value; }
         }
 
         public string CurrentBranchName => CurrentConfigBranch?.Name;

src/GitHub.Api/Git/RepositoryManager.cs

@@ -42,6 +42,7 @@ public interface IRepositoryManager : IDisposable
         void UpdateGitAheadBehindStatus();
         void UpdateLocks();
         int WaitForEvents();
+        void UpdateRepositoryInfo();
 
         IGitConfig Config { get; }
         IGitClient GitClient { get; }
@@ -331,10 +332,9 @@ public ITask DiscardChanges(GitStatusEntry[] gitStatusEntries)
                     if (itemsToRevert.Any())
                     {
                         gitDiscardTask = GitClient.Discard(itemsToRevert);
-                        task
-                            .Then(gitDiscardTask)
-                            // we're appending a new continuation, we need to reset the finally handler
-                            // so it runs after the discard task
+                        task.Then(gitDiscardTask)
+                            // we're appending a new continuation after HookupHandlers has run,
+                            // we need to set the finally handler manually so it runs at the end of everything
                             .Finally(s =>
                             {
                                 watcher.Start();
@@ -379,7 +379,7 @@ public void UpdateGitAheadBehindStatus()
         public void UpdateLocks()
         {
             GitClient.ListLocks(false)
-                .Finally((success, locks) =>
+                .Then((success, locks) =>
                 {
                     if (success)
                     {
@@ -399,7 +399,7 @@ private ITask HookupHandlers(ITask task, bool filesystemChangesExpected)
             var isExclusive = task.IsChainExclusive();
             task.GetTopOfChain().OnStart += t =>
             {
-                if (t.Affinity == TaskAffinity.Exclusive)
+                if (isExclusive)
                 {
                     Logger.Trace("Starting Operation - Setting Busy Flag");
                     IsBusy = true;
@@ -443,7 +443,7 @@ private void SetupWatcher()
         private void UpdateHead()
         {
             Logger.Trace("UpdateHead");
-            UpdateCurrentBranchAndRemote();
+            UpdateRepositoryInfo();
             UpdateGitLog();
         }
 
@@ -452,7 +452,7 @@ private string GetCurrentHead()
             return repositoryPaths.DotGitHead.ReadAllLines().FirstOrDefault();
         }
 
-        private void UpdateCurrentBranchAndRemote()
+        public void UpdateRepositoryInfo()
         {
             ConfigBranch? branch;
             ConfigRemote? remote;

src/GitHub.Api/Helpers/Progress.cs

@@ -1,3 +1,4 @@
+using GitHub.Logging;
 using System;
 
 namespace GitHub.Unity
@@ -11,25 +12,41 @@ public interface IProgress
         float Percentage { get; }
         long Value { get; }
         long Total { get; }
+        string Message { get; }
+        event Action<IProgress> OnProgress;
     }
 
     public class Progress : IProgress
     {
+        private static ILogging Logger = LogHelper.GetLogger<Progress>(); 
         public ITask Task { get; internal set; }
         public float Percentage { get { return Total > 0 ? (float)(double)Value / Total : 0f; } }
         public long Value { get; internal set; }
         public long Total { get; internal set; }
+        public string Message { get; internal set; }
 
         private long previousValue;
         private float averageSpeed = -1f;
         private float lastSpeed = 0f;
         private float smoothing = 0.005f;
+        public event Action<IProgress> OnProgress;
 
-        public void UpdateProgress(long value, long total)
+        public void UpdateProgress(IProgress progress)
+        {
+            Task = progress.Task;
+            UpdateProgress(progress.Value, progress.Total, progress.Message);
+        }
+
+        public void UpdateProgress(long value, long total, string message = null)
         {
-            previousValue = Value;
             Total = total;
             Value = value;
+            Message = message ?? Message;
+            if (Total == 0 || ((float)(double)Value / Total) - ((float)(double)previousValue / Total) > 1f / 100f)
+            { // signal progress in 1% increments or if we don't know what the total is
+                previousValue = Value;
+                OnProgress?.Invoke(this);
+            }
         }
     }
 }

src/GitHub.Api/IO/Utils.cs

@@ -14,7 +14,6 @@ public static bool Copy(Stream source, Stream destination,
             Func<long, long, bool> progress = null,
             int progressUpdateRate = 100)
         {
-            var logger = LogHelper.GetLogger("Copy");
             byte[] buffer = new byte[chunkSize];
             int bytesRead = 0;
             long totalRead = 0;
@@ -62,7 +61,6 @@ public static bool Copy(Stream source, Stream destination,
                             timeToFinish = Math.Max(1L,
                                 (long)((totalSize - totalRead) / (averageSpeed / progressUpdateRate)));
 
-                            logger.Trace($"totalRead: {totalRead} of {totalSize}");
                             success = progress(totalRead, timeToFinish);
                             if (!success)
                                 break;