Add Addressables Report support #29

timt-unity3d · 2025-07-08T18:13:40Z

This PR adds support for reading Addressables build reports and adding them to the Analyzer sqlite database. This provides data that is only available at build time and can be useful when cross-referenced with built asset bundles.

It does a fairly major refactor of the code to add in a concept of a parser that can read different data types and then add their data to the database. SerializedFileParser encapsulates the old functionality and AddressablesBuildLayoutParser adds support for Addressables build reports.

You can point the analyzer at a mixture of build reports and asset bundles. An example of this sort of mixed directory:

buildlayout_2025.05.14.10.37.32.json
barbarian_assets_all_4b903e4b1543c7ba763f1af1ed4a93a9.bundle
d75049fa2e1f1a2a0778ee8c5bd6ca4a_monoscripts_2338978fc385860335d52af8af1b0937.bundle
d75049fa2e1f1a2a0778ee8c5bd6ca4a_unitybuiltinassets_2855ca7179c3f5c1bd47d03895d1d6f9.bundle
dungeon1_assets_all_9a0add2726c28c7741262c6c806a6104.bundle

Copilot

Pull Request Overview

This PR adds support for importing Unity Addressables build reports by parsing JSON build layout files and writing their data into new SQLite tables.

Introduce WriteAddressablesBuild in SQLiteWriter and register all related commands.
Add dozens of AbstractCommand subclasses to support addressables tables.
Update database schema (Init.sql) and analyzer tool to handle .json Addressables build reports.

Reviewed Changes

Copilot reviewed 32 out of 33 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
Analyzer/SQLite/SQLiteWriter.cs	Register and use new Addressables build commands; implement `WriteAddressablesBuild`.
Analyzer/SQLite/Commands/*.cs	Add command classes for each addressables-related table.
Analyzer/Resources/Init.sql	Create all `addr_build_*` tables for addressables data.
Analyzer/AnalyzerTool.cs	Detect `.json` files and route to `ProcessAddressablesBuild`.
Analyzer/Analyzer.csproj	Add `Newtonsoft.Json` package for JSON deserialization.

Comments suppressed due to low confidence (2)

Analyzer/SQLite/SQLiteWriter.cs:62

[nitpick] The field name 'm_AddressablesDataFromOtherAsset' is missing 'Build' after 'Addressables'. Consider renaming to 'm_AddressablesBuildDataFromOtherAsset' for consistency.

    private AddressablesBuildDataFromOtherAsset m_AddressablesDataFromOtherAsset = new AddressablesBuildDataFromOtherAsset();

Analyzer/SQLite/SQLiteWriter.cs:259

This new method contains substantial logic for parsing and inserting data; consider adding unit tests to cover key code paths and error handling.

    public void WriteAddressablesBuild(string filename, BuildLayout buildLayout)

Copilot · 2025-07-08T18:15:38Z

Analyzer/SQLite/Commands/AddressablesBuild.cs

+        {
+            { "name", SqliteType.Text },
+            { "build_target", SqliteType.Integer },
+            { "start_time", SqliteType.Integer },


The field mapping for 'start_time' is defined as SqliteType.Integer, but the table schema declares it as TEXT. Consider changing it to SqliteType.Text to match the schema and avoid type mismatches.

Suggested change

{ "start_time", SqliteType.Integer },

{ "start_time", SqliteType.Text },

Copilot · 2025-07-08T18:15:38Z

Analyzer/SQLite/SQLiteWriter.cs

 using UnityDataTools.FileSystem.TypeTreeReaders;
+using UnityDataTools.Analyzer.Build;
+using static System.Runtime.InteropServices.JavaScript.JSType;
+using System.Xml.Linq;


The 'System.Xml.Linq' namespace is not used in this file; you can remove this import to reduce clutter.

Suggested change

using System.Xml.Linq;

Copilot · 2025-07-08T18:15:39Z

Analyzer/SQLite/SQLiteWriter.cs

 using UnityDataTools.FileSystem;
 using UnityDataTools.FileSystem.TypeTreeReaders;
+using UnityDataTools.Analyzer.Build;
+using static System.Runtime.InteropServices.JavaScript.JSType;


The static import of 'JSType' is not used; removing it will improve clarity.

Suggested change

using static System.Runtime.InteropServices.JavaScript.JSType;

Copilot · 2025-07-08T18:15:39Z

Analyzer/SQLite/SQLiteWriter.cs

+        m_AddressablesBuildBundleFile.CreateCommand(m_Database);
+
+        // Data From Other Asset Tables
+        // Data From Other Asset Tables


[nitpick] This comment is duplicated on the previous line. Removing one occurrence will keep the code cleaner.

Suggested change

// Data From Other Asset Tables

SkowronskiAndrew · 2025-07-09T20:08:35Z

Analyzer/AnalyzerTool.cs

+            EraseProgressLine();
+            Console.Error.WriteLine();
+            Console.Error.WriteLine($"Error processing file: {file}");
+            Console.WriteLine($"{e.GetType()}: {e.Message}");


.json is a standard file, and there will be .json files in a player output.

For those we should ideally continue to be silent or a minor warning about ignoring it.

Maybe there is a way to first just sanity check that it really is a Addressables build report, perhaps by peeking at the start of the file to check for clear expected formatting?

Or attempting to parsing it but only logging the full error if further analysis proves it is a Addressable file?

SkowronskiAndrew · 2025-07-09T20:17:34Z

Analyzer/Resources/Init.sql

+    PRIMARY KEY (id)
+);
+
+create table addr_build_bundles


I'm not sure the short form will be immediately apparent to everyone "addr_build" as short for for Addressables Build.

Suggested change

create table addr_build_bundles

create table addressables_bundles

I wonder if there is any easy way to make all these tables optional, e.g. only created if we actually find Addressables file? I"m thinking now the dropdown of Tables will start with quite a long list of tables that will be all empty for some builds. Not the end of the world but if they are self contained maybe this can be a sql file that is only run when we discover the file?

SkowronskiAndrew

I took an initial peek at the code (but didn't try it out)
So far just a few suggestions about organizing the new functionality with a bit more structure, which probably could pay off as establishing a pattern for other build-pipeline-specific tables we might add in future.

SkowronskiAndrew · 2025-07-09T20:18:45Z

Analyzer/SQLite/Commands/AddressablesBuild.cs

+{
+    internal class AddressablesBuild : AbstractCommand
+    {
+        protected override string TableName { get => "addr_builds"; }


Suggested change

protected override string TableName { get => "addr_builds"; }

protected override string TableName { get => "addressables_builds"; }

SkowronskiAndrew · 2025-07-09T20:23:58Z

Analyzer/SQLite/SQLiteWriter.cs

+        m_AddressablesBuildSubFile.SetValue("size", reference.data.Size);
+        m_AddressablesBuildSubFile.ExecuteNonQuery();
+    }
+


The SQLiteWriter.cs starts to get quite large. Maybe the new Addressables support code can be in a helper class that has its own source file. I can imagine similar pattern would be followed in the future if we add some Player, AssetBundle .manifest, or ContentFile specific information

Maybe AI can help do the leg work for that refactoring :)

This refactors the code to have separate parsers for Asset Bundles and Addressables Build Layout files. The parser implements a CanParse and Parse method to handle applicability. Currently there's no overlap so we won't be double-parsing, but it's possible in the future.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Pull Request Overview

Copilot reviewed 87 out of 89 changed files in this pull request and generated 4 comments.

Files not reviewed (1)

Analyzer/Properties/Resources.Designer.cs: Language not supported

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Documentation/addressables-build-reports.md

Copilot · 2025-10-02T18:59:49Z

Documentation/addressables-build-reports.md

+-- Find cache name for an addressables bundle
+SELECT cached_name
+FROM addr_build_cached_bundles
+WHERE catalog_name = 'packedassets7_assets_all_61d3358060e969d3aad2d9c5c3a7d69b.bundle';


Missing closing SQL comment block. Add '```' after line 104 to properly close the SQL code block.

Suggested change

WHERE catalog_name = 'packedassets7_assets_all_61d3358060e969d3aad2d9c5c3a7d69b.bundle';

WHERE catalog_name = 'packedassets7_assets_all_61d3358060e969d3aad2d9c5c3a7d69b.bundle';

Analyzer/Properties/Resources.resx

Copilot

Pull Request Overview

Copilot reviewed 87 out of 89 changed files in this pull request and generated 4 comments.

Files not reviewed (1)

Analyzer/Properties/Resources.Designer.cs: Language not supported

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-06T16:26:05Z

Documentation/addressables-build-reports.md

+#### `addr_build_bundles`
+Bundle-level information including asset counts and file sizes.
+
+#### `addr_build_bundle_dependent_bundles


Missing closing backtick in table name reference.

Suggested change

#### `addr_build_bundle_dependent_bundles

#### `addr_build_bundle_dependent_bundles`

Copilot · 2025-10-06T16:26:06Z

Analyzer/SQLite/Commands/AddressablesBuildReport/AddressablesBuildSubFile.cs

+    {
+        protected override string TableName => "addr_build_sub_files";
+
+        protected override string DDLSource => Properties.Resources.AddrBuildSubFiles;


Inconsistent resource namespace usage. Other command classes use Properties.Resources while handlers use Resources. This should be Resources.AddrBuildSubFiles to match the pattern established in the codebase.

Suggested change

protected override string DDLSource => Properties.Resources.AddrBuildSubFiles;

protected override string DDLSource => Resources.AddrBuildSubFiles;

Copilot · 2025-10-06T16:26:06Z

Analyzer/AnalyzerTool.cs

+                if (parser.CanParse(file))
+                {
+                    foundParser = true;
+                    Console.Error.WriteLine(file);


Debug output should be conditional on verbose mode or removed before production. This will clutter output for every processed file.

Suggested change

Console.Error.WriteLine(file);

if (m_Verbose)

Console.Error.WriteLine(file);

Copilot · 2025-10-06T16:26:06Z

Analyzer/AnalyzerTool.cs

+    private bool ProcessFile(string file, string path, SQLiteWriter writer, int i, int length)
    {
-        // Check whether a file is a Unity Archive (AssetBundle) by looking for known signatures at the start of the file.
-        // "UnifyFS" is the current signature, but some older formats of the file are still supported
-        string[] signatures = { "UnityFS", "UnityWeb", "UnityRaw", "UnityArchive" };
-        int maxLen = 12; // "UnityArchive".Length
-        byte[] buffer = new byte[maxLen];
-
-        using (var fs = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.Read))
-        {
-            int read = fs.Read(buffer, 0, buffer.Length);
-            foreach (var sig in signatures)
-            {
-                if (read >= sig.Length)
-                {
-                    bool match = true;
-                    for (int i = 0; i < sig.Length; ++i)
-                    {
-                        if (buffer[i] != sig[i])
-                        {
-                            match = false;
-                            break;
-                        }
-                    }
-                    if (match)
-                        return true;
-                }
-            }
-            return false;
-        }
+        throw new NotImplementedException();
    }


Dead code should be removed. This method is no longer used after the refactoring to the parser architecture.

timt-unity3d requested a review from Copilot July 8, 2025 18:13

Copilot AI reviewed Jul 8, 2025

View reviewed changes

SkowronskiAndrew reviewed Jul 9, 2025

View reviewed changes

timt-unity3d added 7 commits September 30, 2025 11:07

add in explict assets from build layout files

8d345e2

added addressables build reports

bb1168f

initial import of several additional commands

e308210

add all addressable tables

6196d23

move to serialized file commands

3134ff5

move DDL into individual abstract commands

015472e

refactor sql files to individual files

6206b19

timt-unity3d force-pushed the add-buildlayout-support branch from 4ea43ea to 6206b19 Compare September 30, 2025 16:08

timt-unity3d added 3 commits October 1, 2025 11:22

fix initialization

0534f4d

added more thorough documentation

2ae27eb

timt-unity3d requested review from SkowronskiAndrew and Copilot October 2, 2025 17:05

Merge branch 'main' into add-buildlayout-support

f369382

timt-unity3d marked this pull request as ready for review October 2, 2025 17:17

Copilot AI reviewed Oct 2, 2025

View reviewed changes

timt-unity3d requested a review from Copilot October 2, 2025 18:58

Copilot AI reviewed Oct 2, 2025

View reviewed changes

typo fixes from code reviews

8303ae0

timt-unity3d force-pushed the add-buildlayout-support branch from f4832e3 to 8303ae0 Compare October 6, 2025 16:25

timt-unity3d requested a review from Copilot October 6, 2025 16:25

Copilot AI reviewed Oct 6, 2025

View reviewed changes

add missing build file

8a58036

	{ "start_time", SqliteType.Integer },
	{ "start_time", SqliteType.Text },

	create table addr_build_bundles
	create table addressables_bundles

	protected override string TableName { get => "addr_builds"; }
	protected override string TableName { get => "addressables_builds"; }

	WHERE catalog_name = 'packedassets7_assets_all_61d3358060e969d3aad2d9c5c3a7d69b.bundle';
	WHERE catalog_name = 'packedassets7_assets_all_61d3358060e969d3aad2d9c5c3a7d69b.bundle';

	#### `addr_build_bundle_dependent_bundles
	#### `addr_build_bundle_dependent_bundles`

	protected override string DDLSource => Properties.Resources.AddrBuildSubFiles;
	protected override string DDLSource => Resources.AddrBuildSubFiles;

	Console.Error.WriteLine(file);
	if (m_Verbose)
	Console.Error.WriteLine(file);

Add Addressables Report support #29

Are you sure you want to change the base?

Add Addressables Report support #29

Uh oh!

Conversation

timt-unity3d commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

SkowronskiAndrew Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

SkowronskiAndrew Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

SkowronskiAndrew left a comment

Choose a reason for hiding this comment

Uh oh!

SkowronskiAndrew Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

SkowronskiAndrew Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI Oct 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

timt-unity3d commented Jul 8, 2025 •

edited

Loading