Unity-Technologies / Unity-Technologies/UnityDataTools

Support calculating TypeTree overhead

オープン
#127 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
C#
スター
821
フォーク
71
平均マージ
3時間 13分
マージ済み PR(30日)
9

説明

Some AssetBundle or content directory builds can have a high overhead from the TypeTree data in the SerializedFile header.
This is particularly true if there is a very high granularity of files, and the project contains large MonoBehaivours (large in term of serialization description, the data size is not important)

This task is to update UnityDataTool to make it easier to "see" this overhead and pinpoint details about it (such as the existence of large MonoBehaviours, or widely repeated types). We do expose the raw information about TypeTrees through the serializd-file command, but it is very low level so far.

Option 1: update the Analysis database and capture the data during analysis so that TypeTrees have dedicated table in the database.

From the raw table data it should be made clear how to extract the overall size and duplication statistics (either based on queries in the docs or a custom view)

A POC already exists in this branch:
https://github.com/Unity-Technologies/UnityDataTools/compare/main...typetreeanalysis

That branch is out of data with the recent changed in UnityDataTool and probably needs some design adjustments, but can be a great starting point.

Option 2: update the serialized-file command to print TypeTree stats information in a convenient summary format, and to publish example in the documentation for how to do analysis based on that raw data. E.g. example script.

Option 3: Really low level would be to make use of the data already exposed by serialized-file and have a script that show how to populate that into a dedicated database.

Because the data could get pretty large for large builds i think the first is probably best.

Question: how should we handle a build that has external typetrees? In that case the serialized file have no typetrees so the new tables would be empty. There is probably minimal value to calculating a lot of stats for this case, because by design they are already deduplicated.
Detail: For builds with external typetrees then we can potentially skip creating the typetree tables and views (to avoid extra noise in the analyze database for builds where those stats don't apply)

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

既存のtypetreeanalysisブランチと、serialized-fileコマンドによって公開される生のTypeTreeデータの確認から始めてください。analysis-database、summary-output、scriptingの各オプションを比較し、外部TypeTreeをどのように扱うべきかも含めて検討してください; TypeTreeのオーバーヘッドと重複の詳細を分析しやすくするアプローチが選ばれれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
csharp
領域
database, tooling
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
静か
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。