Merge pull request #1089 from PlayEveryWare/fix/file-io-sharing

fix: Resolve race conditions for file IO.

Author: paulhazen

Assets/Plugins/Source/Editor/ConfigEditors/ConfigEditor.cs

@@ -179,7 +179,12 @@ public void Load()
             Task.Run(LoadAsync).GetAwaiter().GetResult();
         }
 
-        public async Task Save(bool prettyPrint = true)
+        public void Save(bool prettyPrint = true)
+        {
+            config.Write(prettyPrint);
+        }
+
+        public async Task SaveAsync(bool prettyPrint = true)
         {
             await config.WriteAsync(prettyPrint);
         }

Assets/Plugins/Source/Editor/ConfigEditors/IConfigEditor.cs

@@ -61,12 +61,20 @@ public interface IConfigEditor : IDisposable
         void Load();
 
         /// <summary>
-        /// Saves the configuration to disk.
+        /// Saves the configuration to disk synchronously.
+        /// </summary>
+        /// <param name="prettyPrint">
+        /// Whether to format the JSON in a more human-readable manner.
+        /// </param>
+        void Save(bool prettyPrint = true);
+
+        /// <summary>
+        /// Saves the configuration to disk asynchronously.
         /// </summary>
         /// <param name="prettyPrint">
         /// Whether or not to format the JSON in a more human-readable manner.
         /// </param>
-        Task Save(bool prettyPrint = true);
+        Task SaveAsync(bool prettyPrint = true);
 
         /// <summary>
         /// Render the editor for the configuration values.

Assets/Plugins/Source/Editor/EditorWindows/EOSPluginSettingsWindow.cs

@@ -155,7 +155,7 @@ private void Save()
         {
             foreach (var configurationSectionEditor in configEditors)
             {
-                configurationSectionEditor.Save();
+                configurationSectionEditor.SaveAsync();
             }
 
             AssetDatabase.SaveAssets();

Assets/Plugins/Source/Editor/EditorWindows/EOSSettingsWindow.cs

@@ -173,15 +173,15 @@ protected override void RenderWindow()
             }
         }
 
-        private async void Save()
+        private void Save()
         {
             // Save the product config editor
-            await _productConfigEditor.Save();
+            _productConfigEditor.Save();
 
             // Save each of the platform config editors.
             foreach (IConfigEditor editor in _platformConfigEditors)
             {
-                await editor.Save();
+                editor.Save();
             }
         }
     }

Assets/Plugins/Source/Editor/EditorWindows/EOSSettingsWindow_DEPRECATED.cs

@@ -204,7 +204,7 @@ private async Task Save(bool usePrettyFormat)
 
             foreach (var platformSpecificConfigEditor in platformSpecificConfigEditors)
             {
-                await platformSpecificConfigEditor.Save(usePrettyFormat);
+                await platformSpecificConfigEditor.SaveAsync(usePrettyFormat);
             }
 
 #if ALLOW_CREATION_OF_EOS_CONFIG_AS_C_FILE

Assets/Plugins/Source/Editor/EditorWindows/EOSUnitTestSettingsWindow.cs

@@ -57,7 +57,7 @@ protected async override void RenderWindow()
 
             if (GUILayout.Button("Save", GUILayout.Width(100)))
             {
-                await _testConfigEditor.Save();
+                await _testConfigEditor.SaveAsync();
             }
         }
     }

com.playeveryware.eos/Runtime/Core/Utility/FileSystemUtility.cs

@@ -511,9 +511,12 @@ public static async Task<string> ReadAllTextAsync(string path)
             try
             {
 #if NET_STANDARD_2_0
-                return await File.ReadAllTextAsync(path);
+                await using FileStream fileStream = new(path, FileMode.Open, FileAccess.Read, FileShare.Read);
+                using StreamReader reader = new(fileStream);
+                string content = await reader.ReadToEndAsync();
+                return content;
 #else
-                return await Task.Run(() => File.ReadAllText(path));
+                return await Task.Run(() => ReadAllText(path));
 #endif
             }
             catch (Exception e)
@@ -535,9 +538,13 @@ public static string ReadAllText(string path)
 #else
             try
             {
-                return File.ReadAllText(path);
+                // Open the file with explicit FileStream and sharing options
+                using FileStream fileStream = new(path, FileMode.Open, FileAccess.Read, FileShare.Read);
+                using StreamReader reader = new(fileStream);
+                string content = reader.ReadToEnd();
+                return content;
             }
-            catch (Exception e)
+            catch (IOException e)
             {
                 Debug.LogException(e);
                 throw;