RetrieveStatus-take-so-long-time-about-5s - Add UpdateIndex to StatusOptions to improve performance for subsequent calls available on libgit2sharp API

Author: David van Luijk | IAI

LibGit2Sharp.Tests/StatusFixture.cs

@@ -660,5 +660,19 @@ public void UnalteredFilesDontMarkIndexAsDirty()
                 Assert.Equal(9, status.Count());
             }
         }
+
+        [Fact]
+        public void TestUpdateIndexDoesNotFail()
+        {
+            var path = SandboxStandardTestRepo();
+
+            using (var repo = new Repository(path))
+            {
+                // This option improves the performance of subsequent calls,
+                // but there isn't really an observable difference to assert
+                // Therefor enable the option and to ensure it doesn't trigger and exception is the only thing possible
+                repo.RetrieveStatus(new StatusOptions() { UpdateIndex = true });
+            }
+        }
     }
 }

LibGit2Sharp/RepositoryStatus.cs

@@ -139,6 +139,12 @@ private static GitStatusOptions CreateStatusOptions(StatusOptions options)
                     GitStatusOptionFlags.IncludeUnmodified;
             }
 
+            if (options.UpdateIndex)
+            {
+                coreOptions.Flags |=
+                    GitStatusOptionFlags.UpdateIndex;
+            }
+
             return coreOptions;
         }
 

LibGit2Sharp/StatusOptions.cs

@@ -105,5 +105,13 @@ public StatusOptions()
         /// Include untracked files when scanning for status
         /// </summary>
         public bool IncludeUntracked { get; set; }
+
+        /// <summary>
+        /// Refresh out of date index and save it in index
+        /// </summary>
+        /// <remarks>
+        /// Will result in less work being done in subsequent calls
+        /// </remarks>
+        public bool UpdateIndex { get; set; }
     }
 }