feat: configuration manager offline mode (MAPCO-7262)

.github/workflows/test-and-build.yaml

@@ -27,7 +27,7 @@ jobs:
 
   format_check:
     uses: ./.github/workflows/format.yaml
-  
+
   test:
     name: Run Unity Tests
     needs: [checklicense, format_check]
@@ -80,7 +80,7 @@ jobs:
       - uses: ./.github/actions/nugetforunity-restore
         with:
           working-directory: .
-      
+
       # Build project.
       - uses: game-ci/unity-builder@v4
         env:

.gitignore

@@ -106,5 +106,7 @@ InitTestScene*.unity*
 # Auto-generated scenes by play mode tests
 /[Aa]ssets/[Ii]nit[Tt]est[Ss]cene*.unity*
 
+# NuGet Packages
 /[Aa]ssets/Packages
-/[Aa]ssets/Packages.meta
+/[Aa]ssets/Packages.meta
+

Assets/PlayModeTests/Utilities/FileUtilityPlayModeTests.cs

@@ -1,8 +1,8 @@
 using System;
 using System.Collections;
 using System.IO;
-using System.Threading.Tasks;
 using com.mapcolonies.core.Utilities;
+using Cysharp.Threading.Tasks;
 using NUnit.Framework;
 using UnityEngine;
 using UnityEngine.TestTools;
@@ -11,17 +11,16 @@ namespace PlayModeTests.Utilities
 {
     public class FileUtilityPlayModeTests
     {
-        private static IEnumerator Await(Task t)
+        private static async UniTask Await(UniTask t)
         {
-            while (!t.IsCompleted) yield return null;
-            if (t.IsFaulted) throw t.Exception;
+            await t;
         }
 
         [UnityTest]
         public IEnumerator SetupFilePath_Creates_Directory_And_FilePath()
         {
             var dirName = "FileUtility_Setup";
-            var path = FileUtility.GetFullPath(dirName, "minimal.log");
+            var path = FileIOUtility.GetFullPath(dirName, "minimal.log");
 
             Assert.IsNotNull(path);
             Assert.IsTrue(Directory.Exists(Path.Combine(Application.persistentDataPath, dirName)), "Directory should be created");
@@ -32,10 +31,10 @@ public IEnumerator SetupFilePath_Creates_Directory_And_FilePath()
         [UnityTest]
         public IEnumerator Append_Writes_Single_Line()
         {
-            var dir = FileUtility.GetFullPath("FileUtility_Append");
+            var dir = FileIOUtility.GetFullPath("FileUtility_Append");
             var file = Path.Combine(dir, $"session-{Guid.NewGuid():N}.log");
 
-            yield return Await(FileUtility.AppendLineToFileAsync("hello", file));
+            yield return Await(FileIOUtility.AppendLineToFileAsync("hello", file));
 
             Assert.IsTrue(File.Exists(file), "File should be created");
             StringAssert.Contains("hello", File.ReadAllText(file));
@@ -54,7 +53,7 @@ public IEnumerator Append_Skips_When_FilePath_Null()
             }
 
             string nullPath = null;
-            yield return Await(FileUtility.AppendLineToFileAsync("ignored", nullPath));
+            yield return Await(FileIOUtility.AppendLineToFileAsync("ignored", nullPath));
 
             Assert.IsFalse(Directory.Exists(dir), "Directory should not be created when path is null");
             yield return null;

Assets/Scenes/MainAppScene.unity

@@ -464,19 +464,19 @@ PrefabInstance:
       objectReference: {fileID: 0}
     - target: {fileID: 6106143874565215203, guid: c6e6123243f885144bd66074063abc03, type: 3}
       propertyPath: m_LocalRotation.y
-      value: 7.230792e-18
+      value: 7.260869e-18
       objectReference: {fileID: 0}
     - target: {fileID: 6106143874565215203, guid: c6e6123243f885144bd66074063abc03, type: 3}
       propertyPath: m_LocalRotation.z
-      value: 9.279935e-19
+      value: 9.02991e-19
       objectReference: {fileID: 0}
     - target: {fileID: 7591503138926735995, guid: c6e6123243f885144bd66074063abc03, type: 3}
       propertyPath: m_Name
       value: CesiumGeoreference
       objectReference: {fileID: 0}
     - target: {fileID: 8800104130311657506, guid: c6e6123243f885144bd66074063abc03, type: 3}
       propertyPath: _localToGlobeFixedMatrix.c0.z
-      value: -9.934400909822153e-18
+      value: -0.000000000000000010012625101410276
       objectReference: {fileID: 0}
     m_RemovedComponents: []
     m_RemovedGameObjects: []

Assets/StreamingAssets/DataManagement/app_settings.json

@@ -0,0 +1,6 @@
+{
+  "userSettingsFile": "DataManagement/UserSettings/user_settings.json",
+  "offlineConfigurationFile": "DataManagement/offline_config.json",
+  "workspacesDirectory": "DataManagement/workspaces",
+  "remoteConfigurationUrl": "https://example.com/config/getConfig?v=10"
+}

Assets/StreamingAssets/DataManagement/offline_config.json

@@ -0,0 +1,3 @@
+{
+  "url": "https://www.google.com"
+}

Assets/com.mapcolonies.core/BaseMvvmView.cs

@@ -1,3 +1,4 @@
+using R3;
 using UnityEngine;
 using UnityEngine.UIElements;
 using VContainer;
@@ -7,7 +8,17 @@ namespace com.mapcolonies.core
     [RequireComponent(typeof(UIDocument))]
     public abstract class BaseMvvmView<T> : MonoBehaviour where T : class
     {
-        private T _viewModel;
+        protected CompositeDisposable Disposables
+        {
+            get;
+        } = new CompositeDisposable();
+
+        protected T ViewModel
+        {
+            get;
+            private set;
+        }
+
         [SerializeField] private UIDocument _uiDocument;
 
         protected VisualElement RootVisualElement
@@ -20,15 +31,20 @@ protected VisualElement RootVisualElement
         public void Construct(T viewModel)
         {
             Debug.Log($"Construct view for {typeof(T)}");
-            _viewModel = viewModel;
+            ViewModel = viewModel;
         }
 
         private void OnEnable()
         {
-            if (_viewModel == null) return;
+            if (ViewModel == null) return;
 
             RootVisualElement = _uiDocument.rootVisualElement;
-            RootVisualElement.dataSource = _viewModel;
+            RootVisualElement.dataSource = ViewModel;
+        }
+
+        private void OnDestroy()
+        {
+            Disposables.Dispose();
         }
     }
 }

Assets/com.mapcolonies.core/Services/Analytics/Managers/AnalyticsManager.cs

@@ -75,7 +75,7 @@ public void Initialize()
 
         private void SetupLogFile()
         {
-            _logFilePath = FileUtility.GetFullPath(AnalyticsFileName, $"session-{SessionId}.log");
+            _logFilePath = FileIOUtility.GetFullPath(AnalyticsFileName, $"session-{SessionId}.log");
         }
 
         private async UniTask PublishAnalytics(LogObject logObject)
@@ -104,7 +104,7 @@ private async UniTask WriteLogToFileAsync(string logContent)
 
             try
             {
-                await FileUtility.AppendLineToFileAsync(logContent, _logFilePath);
+                await FileIOUtility.AppendLineToFileAsync(logContent, _logFilePath);
             }
             catch (Exception e)
             {

Assets/com.mapcolonies.core/Services/Analytics/Model/LogObject.cs

@@ -1,6 +1,5 @@
 using System;
 using com.mapcolonies.core.Services.Analytics.Enums;
-using com.mapcolonies.core.Services.Analytics.Managers;
 using UnityEngine;
 
 namespace com.mapcolonies.core.Services.Analytics.Model

Assets/com.mapcolonies.core/Utilities/FileUtility.cs → Assets/com.mapcolonies.core/Utilities/FileIOUtility.cs

@@ -1,12 +1,11 @@
 using System;
 using System.IO;
-using System.Threading;
-using System.Threading.Tasks;
+using Cysharp.Threading.Tasks;
 using UnityEngine;
 
 namespace com.mapcolonies.core.Utilities
 {
-    public class FileUtility
+    public class FileIOUtility
     {
         public static string GetFullPath(string folderName, string fileName = null)
         {
@@ -22,7 +21,6 @@ public static string GetFullPath(string folderName, string fileName = null)
 
                 if (string.IsNullOrEmpty(fileName))
                 {
-                    Debug.Log($"Directory ready: {directoryPath}");
                     return directoryPath;
                 }
 
@@ -37,7 +35,7 @@ public static string GetFullPath(string folderName, string fileName = null)
             }
         }
 
-        public static async Task AppendLineToFileAsync(string line, string filePath)
+        public static async UniTask AppendLineToFileAsync(string line, string filePath)
         {
             if (string.IsNullOrEmpty(filePath))
             {
@@ -47,5 +45,29 @@ public static async Task AppendLineToFileAsync(string line, string filePath)
 
             await File.AppendAllTextAsync(filePath, line + Environment.NewLine);
         }
+
+        public static async UniTask<string> ReadTextFileAsync(string path)
+        {
+            if (!File.Exists(path))
+                throw new FileNotFoundException($"File not found: {path}");
+
+            using StreamReader reader = new StreamReader(path);
+            return await reader.ReadToEndAsync();
+        }
+
+        public static async UniTask WriteTextFileAsync(string path, string text)
+        {
+            string? directory = Path.GetDirectoryName(path);
+            if (!string.IsNullOrEmpty(directory) && !Directory.Exists(directory))
+                Directory.CreateDirectory(directory);
+
+            await using StreamWriter writer = new StreamWriter(path, false);
+            await writer.WriteAsync(text);
+        }
+
+        public static async UniTask<bool> FileExistsAsync(string path)
+        {
+            return await UniTask.RunOnThreadPool(() => File.Exists(path));
+        }
     }
 }

Assets/com.mapcolonies.core/Utilities/JsonUtilityEx.cs

@@ -0,0 +1,89 @@
+using System.IO;
+using Cysharp.Threading.Tasks;
+using Newtonsoft.Json;
+using UnityEngine;
+using UnityEngine.Networking;
+
+namespace com.mapcolonies.core.Utilities
+{
+    public enum FileLocation
+    {
+        StreamingAssets = 0,
+        PersistentData = 1
+    }
+
+    public static class JsonUtilityEx
+    {
+        public static async UniTask<T> FromJsonFileAsync<T>(string path)
+        {
+            string json = await FileIOUtility.ReadTextFileAsync(path);
+            return JsonConvert.DeserializeObject<T>(json);
+        }
+
+        public static async UniTask SaveJsonToFileAsync<T>(string path, T data)
+        {
+            string json = JsonConvert.SerializeObject(data, Formatting.Indented);
+            await FileIOUtility.WriteTextFileAsync(path, json);
+        }
+
+        public static async UniTask<T> LoadRemoteJsonAsync<T>(string url)
+        {
+            using UnityWebRequest request = UnityWebRequest.Get(url);
+            await request.SendWebRequest();
+
+            if (request.result != UnityWebRequest.Result.Success)
+                throw new IOException($"Failed to load remote JSON: {request.error}");
+
+            return JsonConvert.DeserializeObject<T>(request.downloadHandler.text);
+        }
+
+
+        public static async UniTask<T> LoadJsonAsync<T>(string relativePath, FileLocation location = FileLocation.StreamingAssets)
+        {
+            string path;
+
+            switch (location)
+            {
+                case FileLocation.PersistentData:
+                    path = Path.Combine(Application.persistentDataPath, relativePath);
+                    break;
+                case FileLocation.StreamingAssets:
+                    path = Path.Combine(Application.streamingAssetsPath, relativePath);
+                    break;
+                default:
+                    Debug.LogWarning($"Unknown file location {location}. Using streaming assets as default.");
+                    path = Path.Combine(Application.streamingAssetsPath, relativePath);
+                    break;
+            }
+
+            return await FromJsonFileAsync<T>(path);
+        }
+
+        public static async UniTask SaveJsonAsync<T>(string relativePath, T data)
+        {
+            string path = Path.Combine(Application.persistentDataPath, relativePath);
+            await SaveJsonToFileAsync(path, data);
+        }
+
+        public static async UniTask<bool> DoesJsonExistAsync(string relativePath, FileLocation location = FileLocation.PersistentData)
+        {
+            string path;
+
+            switch (location)
+            {
+                case FileLocation.PersistentData:
+                    path = Path.Combine(Application.persistentDataPath, relativePath);
+                    break;
+                case FileLocation.StreamingAssets:
+                    path = Path.Combine(Application.streamingAssetsPath, relativePath);
+                    break;
+                default:
+                    Debug.LogWarning($"Unknown file location {location}. Using persistent data as default.");
+                    path = Path.Combine(Application.persistentDataPath, relativePath);
+                    break;
+            }
+
+            return await FileIOUtility.FileExistsAsync(path);
+        }
+    }
+}