Merge pull request #1674 from github/fixes/1670-avoid-multiple-writes

Avoid overlapping writes to metrics.json

Author: jcansdale

src/GitHub.VisualStudio/Services/UsageService.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel.Composition;
-using System.Globalization;
 using System.IO;
 using System.Text;
 using System.Threading;
@@ -17,14 +16,15 @@
 namespace GitHub.Services
 {
     [Export(typeof(IUsageService))]
-    public class UsageService : IUsageService
+    public sealed class UsageService : IUsageService, IDisposable
     {
         const string StoreFileName = "metrics.json";
         const string UserStoreFileName = "user.json";
         static readonly ILogger log = LogManager.ForContext<UsageService>();
 
         readonly IGitHubServiceProvider serviceProvider;
         readonly IEnvironment environment;
+        readonly SemaphoreSlim writeSemaphoreSlim = new SemaphoreSlim(1, 1);
 
         string storePath;
         string userStorePath;
@@ -37,6 +37,11 @@ public UsageService(IGitHubServiceProvider serviceProvider, IEnvironment environ
             this.environment = environment;
         }
 
+        public void Dispose()
+        {
+            writeSemaphoreSlim.Dispose();
+        }
+
         public async Task<Guid> GetUserGuid()
         {
             await Initialize();
@@ -102,7 +107,7 @@ public async Task<UsageData> ReadLocalData()
                     SimpleJson.DeserializeObject<UsageData>(json) :
                     new UsageData { Reports = new List<UsageModel>() };
             }
-            catch(Exception ex)
+            catch (Exception ex)
             {
                 log.Error(ex, "Error deserializing usage");
                 return new UsageData { Reports = new List<UsageModel>() };
@@ -115,11 +120,12 @@ public async Task WriteLocalData(UsageData data)
             {
                 Directory.CreateDirectory(Path.GetDirectoryName(storePath));
                 var json = SimpleJson.SerializeObject(data);
+
                 await WriteAllTextAsync(storePath, json);
             }
             catch (Exception ex)
             {
-                log.Error(ex,"Failed to write usage data");
+                log.Error(ex, "Failed to write usage data");
             }
         }
 
@@ -149,10 +155,19 @@ async Task<string> ReadAllTextAsync(string path)
 
         async Task WriteAllTextAsync(string path, string text)
         {
-            using (var s = new FileStream(path, FileMode.Create))
-            using (var w = new StreamWriter(s, Encoding.UTF8))
+            // Avoid IOException when metrics updated multiple times in quick succession
+            await writeSemaphoreSlim.WaitAsync();
+            try
+            {
+                using (var s = new FileStream(path, FileMode.Create))
+                using (var w = new StreamWriter(s, Encoding.UTF8))
+                {
+                    await w.WriteAsync(text);
+                }
+            }
+            finally
             {
-                await w.WriteAsync(text);
+                writeSemaphoreSlim.Release();
             }
         }