Better Error reporting. Rename Hash field

Author: SkowronskiAndrew

TextDumper/TextDumper.csproj

@@ -17,6 +17,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\Analyzer\Analyzer.csproj" />
     <ProjectReference Include="..\UnityFileSystem\UnityFileSystem.csproj" />
   </ItemGroup>
 

TextDumper/TextDumperTool.cs

@@ -1,6 +1,7 @@
 using System;
 using System.IO;
 using System.Text;
+using UnityDataTools.Analyzer.Util;
 using UnityDataTools.FileSystem;
 
 namespace UnityDataTools.TextDumper;
@@ -19,10 +20,15 @@ public int Dump(string path, string outputPath, bool skipLargeArrays, long objec
 
         try
         {
-            try
+            if (!File.Exists(path))
             {
-                // Try the input as an unity archive, e.g. an AssetBundle
-                // In that case we dump each serialized file contained inside it.
+                Console.WriteLine($"Error: File not found: {path}");
+                return 1;
+            }
+
+            if (ArchiveDetector.IsUnityArchive(path))
+            {
+                // The input is a Unity archive (e.g. AssetBundle); dump each serialized file inside it.
                 using var archive = UnityFileSystem.MountArchive(path, "/");
                 foreach (var node in archive.Nodes)
                 {
@@ -37,27 +43,70 @@ public int Dump(string path, string outputPath, bool skipLargeArrays, long objec
                     }
                 }
             }
-            catch (NotSupportedException)
+            else if (YamlSerializedFileDetector.IsYamlSerializedFile(path))
             {
-                // Try as SerializedFile
-                using (m_Writer = new StreamWriter(Path.Combine(outputPath, Path.GetFileName(path) + ".txt"), false))
+                Console.WriteLine("Error: The file is a YAML-format SerializedFile, which is not supported.");
+                Console.WriteLine("UnityDataTool only supports binary-format SerializedFiles.");
+                return 1;
+            }
+            else if (SerializedFileDetector.TryDetectSerializedFile(path, out var fileInfo))
+            {
+                // The input is a binary SerializedFile; dump it directly.
+                try
                 {
-                    OutputSerializedFile(path, objectId);
+                    using (m_Writer = new StreamWriter(Path.Combine(outputPath, Path.GetFileName(path) + ".txt"), false))
+                    {
+                        OutputSerializedFile(path, objectId);
+                    }
+                }
+                catch (Exception e)
+                {
+                    PrintExceptionIfUseful(e);
+
+                    // Post-analysis: check if the failure is due to missing TypeTrees.
+                    if (SerializedFileDetector.TryParseMetadata(path, fileInfo, out var metadata, out _))
+                    {
+                        if (!metadata.EnableTypeTree)
+                        {
+                            Console.WriteLine();
+                            Console.WriteLine("Note: This file does not have TypeTrees and can only be opened if all the types it");
+                            Console.WriteLine("uses exactly match the types available inside the build of UnityFileSystemApi being used.");
+                        }
+                    }
+
+                    return 1;
                 }
             }
+            else
+            {
+                Console.WriteLine("Error: The file does not appear to be a valid Unity SerializedFile or Unity Archive.");
+                Console.WriteLine($"File: {path}");
+                return 1;
+            }
         }
         catch (Exception e)
         {
-            Console.WriteLine("Error!");
-            Console.Write($"{e.GetType()}: ");
-            Console.WriteLine(e.Message);
-            Console.WriteLine(e.StackTrace);
+            PrintExceptionIfUseful(e);
             return 1;
         }
 
         return 0;
     }
 
+    static void PrintExceptionIfUseful(Exception e)
+    {
+        // Avoid printing noisy messages if it is just the generic "we don't know why it failed"
+        // fallback in UnityFileSystem.HandleErrors
+        if (e.GetType().ToString() != "System.Exception")
+            Console.Write($"Error: {e.GetType()}: ");
+        if (!e.Message.Contains("Unknown error"))
+            Console.WriteLine(e.Message);
+        var stackTrace = e.StackTrace;
+        if (!stackTrace.Contains("UnityFileSystem.HandleErrors"))
+            Console.WriteLine(e.StackTrace);
+    }
+
+
     void RecursiveDump(TypeTreeNode node, ref long offset, int level, int arrayIndex = -1)
     {
         bool skipChildren = false;

UnityDataTool.Tests/WebBundleSupportTests.cs

@@ -40,14 +40,14 @@ public void Teardown()
     public void IsWebBundle_True()
     {
         var webBundlePath = Path.Combine(m_TestDataFolder, "WebBundles", "HelloWorld.data");
-        Assert.IsTrue(Archive.IsWebBundle(new FileInfo(webBundlePath)));
+        Assert.IsTrue(Archive.IsWebBundle(webBundlePath));
     }
 
     [Test]
     public void IsWebBundle_False()
     {
         var nonWebBundlePath = Path.Combine(m_TestDataFolder, "WebBundles", "NotAWebBundle.txt");
-        Assert.IsFalse(Archive.IsWebBundle(new FileInfo(nonWebBundlePath)));
+        Assert.IsFalse(Archive.IsWebBundle(nonWebBundlePath));
     }
 
     [Test]

UnityDataTool/Archive.cs

@@ -4,6 +4,7 @@
 using System.IO.Compression;
 using System.Linq;
 using System.Text;
+using UnityDataTools.Analyzer.Util;
 using UnityDataTools.FileSystem;
 
 namespace UnityDataTools.UnityDataTool;
@@ -16,14 +17,20 @@ public static int HandleExtract(FileInfo filename, DirectoryInfo outputFolder)
     {
         try
         {
-            if (IsWebBundle(filename))
+            var path = filename.ToString();
+            if (IsWebBundle(path))
             {
                 ExtractWebBundle(filename, outputFolder);
             }
-            else
+            else if (ArchiveDetector.IsUnityArchive(path))
             {
                 ExtractAssetBundle(filename, outputFolder);
             }
+            else
+            {
+                Console.Error.WriteLine("File is not a supported archive type.");
+                return 1;
+            }
         }
         catch (Exception err) when (
             err is NotSupportedException
@@ -40,14 +47,20 @@ public static int HandleList(FileInfo filename)
     {
         try
         {
-            if (IsWebBundle(filename))
+            var path = filename.ToString();
+            if (IsWebBundle(path))
             {
                 ListWebBundle(filename);
             }
-            else
+            else if (ArchiveDetector.IsUnityArchive(path))
             {
                 ListAssetBundle(filename);
             }
+            else
+            {
+                Console.Error.WriteLine("File is not a supported archive type.");
+                return 1;
+            }
         }
         catch (Exception err) when (
             err is NotSupportedException
@@ -62,9 +75,8 @@ err is NotSupportedException
     }
 
 
-    public static bool IsWebBundle(FileInfo filename)
+    public static bool IsWebBundle(string path)
     {
-        var path = filename.ToString();
         return (
             path.EndsWith(".data")
             || path.EndsWith(".data.gz")

UnityDataTool/SerializedFileCommands.cs

@@ -286,7 +286,7 @@ private static object TypeTreeInfoToJson(TypeTreeInfo info)
             isStrippedType = info.IsStrippedType,
             scriptTypeIndex = info.ScriptTypeIndex,
             scriptID = info.ScriptID.ToString(),
-            oldTypeHash = info.OldTypeHash.ToString(),
+            typeTreeStructureHash = info.TypeTreeStructureHash.ToString(),
             typeTreeContentHash = info.TypeTreeContentHash.ToString(),
             typeTreeSerializedSize = info.TypeTreeSerializedSize,
             inlineTypeTree = info.InlineTypeTree,