safer file handling

Author: jackbrookes

Assets/UXF/Scripts/DataHandling/FileSaver.cs

@@ -41,7 +41,7 @@ public class FileSaver : LocalFileDataHander
 
 
         /// <summary>
-        /// Starts the FileIOManager Worker thread.
+        /// Starts the FileSaver Worker thread.
         /// </summary>
         public override void SetUp()
         {
@@ -71,7 +71,7 @@ public void ManageInWorker(System.Action action)
             {
                 throw new System.InvalidOperationException(
                     string.Format(
-                        "Cant add action to FileIOManager, is currently quitting. Action: {0}.{1}",
+                        "Cannot add action to FileSaver, is currently quitting. Action: {0}.{1}",
                         action.Method.ReflectedType.FullName,
                         action.Method.Name
                         )
@@ -160,7 +160,7 @@ public override string HandleJSONSerializableObject(List<object> serializableObj
             Directory.CreateDirectory(directory);
             string savePath = Path.Combine(directory, string.Format("{0}.json", dataName));
 
-             if (verboseDebug) Debug.LogFormat("Queuing save of file: {0}", savePath);
+            if (verboseDebug) Debug.LogFormat("Queuing save of file: {0}", savePath);
 
             ManageInWorker(() => { File.WriteAllText(savePath, text); });
             return savePath;
@@ -233,7 +233,7 @@ public static string SessionNumToName(int num)
         }
 
         /// <summary>
-        /// Aborts the FileIOManager's thread and joins the thread to the calling thread.
+        /// Aborts the FileSaver's thread and joins the thread to the calling thread.
         /// </summary>
         public override void CleanUp()
         {

Assets/UXF/Scripts/Session.cs

@@ -642,8 +642,12 @@ public void End()
                     SaveDataTable(ppDetailsTable, "participant_details", dataType: UXFDataType.ParticipantDetails);
                 }
 
-                // end DataHandler - forces completion of tasks
-                foreach (var dataHandler in ActiveDataHandlers) dataHandler.CleanUp();
+                // end DataHandlers - forces completion of tasks
+                foreach (var dataHandler in ActiveDataHandlers)
+                {
+                    try { dataHandler.CleanUp(); }
+                    catch (Exception e) { Debug.LogException(e); }
+                }
 
                 try { onSessionEnd.Invoke(this); }
                 catch (Exception e) { Debug.LogException(e); }

Assets/UXF/Tests/Editor/TestFileIOManager.cs

@@ -43,25 +43,29 @@ public void WriteManyFiles()
             // generate a large dictionary
 			var dict = new Dictionary<string, object>();
 
-            var largeArray = new int[10000];
-			for (int i = 0; i < largeArray.Length; i++)
-                largeArray[i] = i;
-
-			dict["large_array"] = largeArray;
+            var largeArray = new string[100];
+            string largeString = new string('*', 50000);
 
 			// write lots and lots of JSON files
 			int n = 100;
             string[] fpaths = new string[n];
 			for (int i = 0; i < n; i++)
 			{
-				string fileName = string.Format("{0:000}", i);
+				string fileName = string.Format("{0}", i);
 				Debug.LogFormat("Queueing {0}", fileName);
-            	string fpath = fileSaver.HandleJSONSerializableObject(dict, experiment, ppid, sessionNum, fileName, UXFDataType.OtherSessionData);
+            	string fpath = fileSaver.HandleText(largeString, experiment, ppid, sessionNum, fileName, UXFDataType.OtherSessionData);
                 fpaths[i] = fpath;
 			}
 
+            Debug.Log("###########################################");
+            Debug.Log("############## CLEANING UP ################");
+            Debug.Log("###########################################");
             fileSaver.CleanUp();
 
+            Assert.Throws<System.InvalidOperationException>(() => {
+                fileSaver.HandleText(largeString, experiment, ppid, sessionNum, "0", UXFDataType.OtherSessionData);
+            });
+
 			// cleanup files
             foreach (var fpath in fpaths)
             {

Assets/UXF/Tests/Editor/TestSessionBehaviour.cs

@@ -67,6 +67,20 @@ public void TestEndAfterLastTrial()
             Assert.AreEqual(6, lines.Length);
         }
 
+
+        [Test]
+        public void TestEndMultipleTimes()
+        {
+            (Session session, FileSaver fileSaver) = CreateSession("endmultipletimes");
+            foreach (var trial in session.Trials)
+            {
+                trial.Begin();
+                trial.End();
+            }
+            session.End();
+            session.End();
+        }
+
         Tuple<Session, FileSaver> CreateSession(string ppidExtra)
         {
             GameObject gameObject = new GameObject();

example_output/unit_test/test_behaviour_endafterlasttrial/S001/trial_results.csv

@@ -1,6 +1,6 @@
 experiment,ppid,session_num,trial_num,block_num,trial_num_in_block,start_time,end_time
-unit_test,test_behaviour_endafterlasttrial,1,1,1,1,2.747739,2.747739
-unit_test,test_behaviour_endafterlasttrial,1,2,1,2,2.747739,2.747739
-unit_test,test_behaviour_endafterlasttrial,1,3,2,1,2.747739,2.747739
-unit_test,test_behaviour_endafterlasttrial,1,4,2,2,2.747739,2.747739
-unit_test,test_behaviour_endafterlasttrial,1,5,2,3,2.747739,2.747739
+unit_test,test_behaviour_endafterlasttrial,1,1,1,1,1.48592,1.48592
+unit_test,test_behaviour_endafterlasttrial,1,2,1,2,1.48592,1.48592
+unit_test,test_behaviour_endafterlasttrial,1,3,2,1,1.48592,1.48592
+unit_test,test_behaviour_endafterlasttrial,1,4,2,2,1.48592,1.48592
+unit_test,test_behaviour_endafterlasttrial,1,5,2,3,1.48592,1.48592