[#68] Generalize AssetBundle to Archive in analyze schema and code (#89)

* [#68] ANALYZE SCHEMA CHANGE - Generalize AssetBundle to Archive

Unity Archives back AssetBundles, Player builds, Content Archives and
ContentDirectory builds, so names that said "AssetBundle" where the concept
is really "any Unity Archive" were misleading (notably for ContentDirectory
builds). Rename those to "Archive", leaving genuinely AssetBundle-object-
specific names (assetbundle_assets, AssetBundleHandler, etc.) untouched.

Schema (user_version 2 -> 3):
- Table asset_bundles -> archives; serialized_files.asset_bundle -> archive.
- The asset_bundle view alias -> archive across object_view and the views
  that build on it (material/shader/texture/dep aliases, monoscript views,
  in_bundles -> in_archives).
- build_report_archive_contents.assetbundle/assetbundle_content ->
  archive/archive_content.

Code:
- AddAssetBundle -> AddArchive; Begin/EndAssetBundle -> Begin/EndArchive;
  Context.AssetBundleId -> ArchiveId; ExtractAssetBundle/ListAssetBundle ->
  ExtractArchive/ListArchive; FileListAssetBundleHelper -> FileListArchiveHelper.
- ReferenceFinder query column and output labels ("Archive:").
- Stripped the stale auto-generated SQL snapshot comments from
  Resources.Designer.cs (they drift; the .sql files are the source of truth).

Tests, compare scripts and documentation updated to match; test key
asset_bundles_count -> archives_count.

Author: SkowronskiAndrew

Analyzer/Properties/Resources.Designer.cs

@@ -1,7 +1,7 @@
 -- tables related to the AssetBundle and PreloadData objects
 
 -- Do not confuse the AssetBundle Unity object (the source of much of this data)
--- with the asset_bundles table, which is general to any Unity Archive.
+-- with the archives table, which is general to any Unity Archive.
 
 -- The "assets" that an AssetBundle explicitly exposes: each m_Container entry of the AssetBundle
 -- object names an object (the addressable/asset name -> object it maps to). Populated only from
@@ -34,7 +34,7 @@ SELECT
 FROM assetbundle_assets a INNER JOIN object_view o ON o.id = a.object;
 
 CREATE VIEW IF NOT EXISTS preload_dependencies_view AS
-SELECT a.id, a.asset_name, a.asset_bundle, a.type, od.id dep_id, od.asset_bundle dep_asset_bundle, od.name dep_name, od.type dep_type
+SELECT a.id, a.asset_name, a.archive, a.type, od.id dep_id, od.archive dep_archive, od.name dep_name, od.type dep_type
 FROM assetbundle_asset_view a
 INNER JOIN preload_dependencies d ON a.id = d.object
 INNER JOIN object_view od ON od.id = d.dependency;

Analyzer/Resources/AssetBundle.sql

@@ -30,9 +30,9 @@ CREATE TABLE IF NOT EXISTS build_report_files(
 
 CREATE TABLE IF NOT EXISTS build_report_archive_contents(
     build_report_id INTEGER NOT NULL,
-    assetbundle TEXT NOT NULL,
-    assetbundle_content TEXT NOT NULL,
-    PRIMARY KEY (build_report_id, assetbundle_content),
+    archive TEXT NOT NULL,
+    archive_content TEXT NOT NULL,
+    PRIMARY KEY (build_report_id, archive_content),
     FOREIGN KEY (build_report_id) REFERENCES build_reports(id)
 );
 

Analyzer/Resources/BuildReport.sql

@@ -8,9 +8,7 @@ CREATE TABLE IF NOT EXISTS types
 -- Describes a unity archive that contains serialized files and other built content.
 -- A common use of the unity archive is for AssetBundles but it can also be used for
 -- Player, Content Archive and ContentDirectory builds.
---
--- See issue 68 for proposed rename
-CREATE TABLE IF NOT EXISTS asset_bundles
+CREATE TABLE IF NOT EXISTS archives
 (
     id INTEGER,
     name TEXT,
@@ -26,12 +24,12 @@ CREATE TABLE IF NOT EXISTS asset_bundles
 --     "BuildPlayer-<SceneName>"; the Scriptable Build Pipeline / Addressables uses
 --     "CAB-<hash of scene path>"; the Multi-Process Build Pipeline uses "CAB-<scene GUID>".
 --   * Player builds name scenes "level0", "level1", ... in scene-list order.
--- asset_bundle references the row from asset_bundles table of the unity archive containing this file,
+-- archive references the row from archives table of the unity archive containing this file,
 -- or is '' when the file is not inside an unity archive; object_view turns that '' into NULL.
 CREATE TABLE IF NOT EXISTS serialized_files
 (
     id INTEGER,
-    asset_bundle INTEGER,
+    archive INTEGER,
     name TEXT,
     PRIMARY KEY (id)
 );
@@ -91,7 +89,7 @@ INNER JOIN property_names pn ON r.property_path = pn.id
 INNER JOIN property_types pt ON r.property_type = pt.id;
 
 CREATE VIEW object_view AS
-SELECT o.id, o.object_id, ab.name AS asset_bundle, sf.name AS serialized_file, t.name AS type, o.name, o.game_object, o.size,
+SELECT o.id, o.object_id, ab.name AS archive, sf.name AS serialized_file, t.name AS type, o.name, o.game_object, o.size,
 CASE
     WHEN size < 1024 THEN printf('%!5.1f B', size * 1.0)
     WHEN size >=  1024 AND size < (1024 * 1024) THEN printf('%!5.1f KB', size / 1024.0)
@@ -101,7 +99,7 @@ END AS pretty_size, o.crc32
 FROM objects o
 INNER JOIN types t ON o.type = t.id
 INNER JOIN serialized_files sf ON o.serialized_file = sf.id
-LEFT JOIN asset_bundles ab ON sf.asset_bundle = ab.id;
+LEFT JOIN archives ab ON sf.archive = ab.id;
 
 CREATE VIEW view_breakdown_by_type AS
 SELECT *,
@@ -128,21 +126,21 @@ END AS pretty_total_size,
 sum(size) AS total_size,
 size,
 pretty_size,
-REPLACE(GROUP_CONCAT(DISTINCT IIF(asset_bundle IS NULL, serialized_file, asset_bundle)), ',', ',' || CHAR(13)) AS in_files
+REPLACE(GROUP_CONCAT(DISTINCT IIF(archive IS NULL, serialized_file, archive)), ',', ',' || CHAR(13)) AS in_files
 FROM object_view
 GROUP BY name, type, size, crc32
 HAVING instances > 1
 ORDER BY size DESC, instances DESC;
 
 CREATE VIEW view_material_shader_refs AS
-SELECT m.id material_id, m.name material_name, a.name material_path, m.asset_bundle material_asset_bundle, s.id shader_id, s.name shader_name, s.asset_bundle shader_asset_bundle
+SELECT m.id material_id, m.name material_name, a.name material_path, m.archive material_archive, s.id shader_id, s.name shader_name, s.archive shader_archive
 FROM object_view m
 INNER JOIN refs_view r ON m.id = r.object AND r.property_path = 'm_Shader'
 INNER JOIN object_view s ON r.referenced_object = s.id
 LEFT JOIN assetbundle_assets a ON m.id = a.object;
 
 CREATE VIEW view_material_texture_refs AS
-SELECT m.id material_id, m.name material_name, a.name material_path, m.asset_bundle material_asset_bundle, t.id texture_id, t.name texture_name, t.asset_bundle texture_asset_bundle
+SELECT m.id material_id, m.name material_name, a.name material_path, m.archive material_archive, t.id texture_id, t.name texture_name, t.archive texture_archive
 FROM object_view m
 INNER JOIN refs_view r ON r.object = m.id AND property_type = 'Texture'
 INNER JOIN object_view t ON r.referenced_object = t.id
@@ -156,8 +154,9 @@ INSERT INTO types (id, name) VALUES (-1, 'Scene');
 -- Database schema version. Bump when the schema changes in a way that tools relying on it
 -- (e.g. find-refs) cannot read from an older database. 1 = normalized refs table (issue #44);
 -- 2 = renamed assets/asset_dependencies tables to assetbundle_assets/preload_dependencies
--- (issue #82); databases produced before versioning report 0.
-PRAGMA user_version = 2;
+-- (issue #82); 3 = renamed asset_bundles table to archives and the asset_bundle column/alias
+-- to archive (issue #68); databases produced before versioning report 0.
+PRAGMA user_version = 3;
 
 PRAGMA synchronous = OFF;
 PRAGMA journal_mode = MEMORY;

Analyzer/Resources/Init.sql

@@ -10,7 +10,7 @@ CREATE VIEW monoscript_view AS
 SELECT
     o.id,
     o.object_id,
-    o.asset_bundle,
+    o.archive,
     o.serialized_file,
     m.class_name,
     m.namespace,
@@ -21,7 +21,7 @@ CREATE VIEW script_object_view AS
 SELECT
     mb.id,
     mb.object_id,
-    mb.asset_bundle,
+    mb.archive,
     mb.serialized_file,
     ms.class_name,
     ms.namespace,

Analyzer/Resources/MonoScript.sql

@@ -27,7 +27,7 @@ CREATE VIEW build_report_packed_assets_view AS
 SELECT
     pa.id,
     o.object_id,
-    brac.assetbundle,
+    brac.archive,
     pa.path,
     pa.file_header_size,
     br_obj.id as build_report_id,
@@ -36,12 +36,12 @@ FROM build_report_packed_assets pa
 INNER JOIN objects o ON pa.id = o.id
 INNER JOIN serialized_files sf ON o.serialized_file = sf.id
 LEFT JOIN objects br_obj ON o.serialized_file = br_obj.serialized_file AND br_obj.type = 1125
-LEFT JOIN build_report_archive_contents brac ON br_obj.id = brac.build_report_id AND pa.path = brac.assetbundle_content;
+LEFT JOIN build_report_archive_contents brac ON br_obj.id = brac.build_report_id AND pa.path = brac.archive_content;
 
 CREATE VIEW build_report_packed_asset_contents_view AS
 SELECT
     sf.name as serialized_file,
-    brac.assetbundle,
+    brac.archive,
     pa.path,
     pac.packed_assets_id,
     pac.object_id,
@@ -57,5 +57,5 @@ LEFT JOIN objects o ON o.id = pa.id
 INNER JOIN serialized_files sf ON o.serialized_file = sf.id
 LEFT JOIN build_report_source_assets sa ON pac.source_asset_id = sa.id
 LEFT JOIN objects br_obj ON o.serialized_file = br_obj.serialized_file AND br_obj.type = 1125
-LEFT JOIN build_report_archive_contents brac ON br_obj.id = brac.build_report_id AND pa.path = brac.assetbundle_content;
+LEFT JOIN build_report_archive_contents brac ON br_obj.id = brac.build_report_id AND pa.path = brac.archive_content;
 

Analyzer/Resources/PackedAssets.sql

@@ -63,7 +63,7 @@ CASE
     WHEN sum(size) >= (1024 * 1024)  AND sum(size) < (1024 * 1024 * 1024) THEN printf('%!5.1f MB', sum(size) / 1024.0 / 1024)
     WHEN sum(size) >= (1024 * 1024 * 1024) THEN printf('%!5.1f GB', sum(size) / 1024.0 / 1024 / 1024)
 END AS pretty_total_size,
-sum(size) AS total_size, GROUP_CONCAT(asset_bundle, ',' || CHAR(13)) AS in_bundles
+sum(size) AS total_size, GROUP_CONCAT(archive, ',' || CHAR(13)) AS in_archives
 FROM shader_view
 GROUP BY name
 ORDER BY total_size DESC, instances DESC;

Analyzer/Resources/Shader.sql

@@ -4,17 +4,17 @@
 namespace UnityDataTools.Analyzer.SQLite.Commands.SerializedFile
 {
     /* TABLE DEFINITION:
-    create table asset_bundles
+    create table archives
     (
         id INTEGER,
         name TEXT,
         file_size INTEGER,
         PRIMARY KEY (id)
     );
     */
-    internal class AddAssetBundle : AbstractCommand
+    internal class AddArchive : AbstractCommand
     {
-        protected override string TableName => "asset_bundles";
+        protected override string TableName => "archives";
 
         protected override string DDLSource => null;
 

…ommands/SerializedFile/AddAssetBundle.cs …te/Commands/SerializedFile/AddArchive.csAnalyzer/SQLite/Commands/SerializedFile/AddAssetBundle.cs renamed to Analyzer/SQLite/Commands/SerializedFile/AddArchive.cs Analyzer/SQLite/Commands/SerializedFile/AddAssetBundle.cs renamed to Analyzer/SQLite/Commands/SerializedFile/AddArchive.cs

@@ -8,7 +8,7 @@ namespace UnityDataTools.Analyzer.SQLite.Commands.SerializedFile
     create table serialized_files
     (
         id INTEGER,
-        asset_bundle INTEGER,
+        archive INTEGER,
         name TEXT,
         PRIMARY KEY (id)
     );
@@ -22,7 +22,7 @@ internal class AddSerializedFile : AbstractCommand
         protected override Dictionary<string, SqliteType> Fields => new()
         {
             { "id", SqliteType.Integer },
-            { "asset_bundle", SqliteType.Integer },
+            { "archive", SqliteType.Integer },
             { "name", SqliteType.Text }
         };
     }

Analyzer/SQLite/Commands/SerializedFile/AddSerializedFile.cs

@@ -60,14 +60,14 @@ public void Init(SqliteConnection db)
 
         m_InsertArchiveContentCommand = db.CreateCommand();
         m_InsertArchiveContentCommand.CommandText = @"INSERT INTO build_report_archive_contents(
-            build_report_id, assetbundle, assetbundle_content
+            build_report_id, archive, archive_content
         ) VALUES(
-            @build_report_id, @assetbundle, @assetbundle_content
+            @build_report_id, @archive, @archive_content
         )";
 
         m_InsertArchiveContentCommand.Parameters.Add("@build_report_id", SqliteType.Integer);
-        m_InsertArchiveContentCommand.Parameters.Add("@assetbundle", SqliteType.Text);
-        m_InsertArchiveContentCommand.Parameters.Add("@assetbundle_content", SqliteType.Text);
+        m_InsertArchiveContentCommand.Parameters.Add("@archive", SqliteType.Text);
+        m_InsertArchiveContentCommand.Parameters.Add("@archive_content", SqliteType.Text);
     }
 
     public void Process(Context ctx, long objectId, RandomAccessReader reader, out string name, out long streamDataSize)
@@ -106,12 +106,12 @@ public void Process(Context ctx, long objectId, RandomAccessReader reader, out s
         }
 
         // Insert archive contents mapping
-        foreach (var mapping in buildReport.fileListAssetBundleHelper.internalNameToArchiveMapping)
+        foreach (var mapping in buildReport.fileListArchiveHelper.internalNameToArchiveMapping)
         {
             m_InsertArchiveContentCommand.Transaction = ctx.Transaction;
             m_InsertArchiveContentCommand.Parameters["@build_report_id"].Value = objectId;
-            m_InsertArchiveContentCommand.Parameters["@assetbundle"].Value = mapping.Value;
-            m_InsertArchiveContentCommand.Parameters["@assetbundle_content"].Value = mapping.Key;
+            m_InsertArchiveContentCommand.Parameters["@archive"].Value = mapping.Value;
+            m_InsertArchiveContentCommand.Parameters["@archive_content"].Value = mapping.Key;
             m_InsertArchiveContentCommand.ExecuteNonQuery();
         }