Unity-Technologies / Unity-Technologies/UnityDataTools

Support calculating TypeTree overhead

Abierto
#127 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
C#
Estrellas
821
Forks
71
Merge medio
3 h 13 min
PR fusionados (30 d)
9

Descripción

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)

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza revisando la rama typetreeanalysis existente y los datos TypeTree sin procesar expuestos por el comando serialized-file. Compara las opciones analysis-database, summary-output y scripting, incluido cómo deberían gestionarse los TypeTrees externos; se considera terminado cuando un enfoque elegido facilita el análisis de los detalles de sobrecarga y duplicación de TypeTree.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
csharp
Área
database, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Tranquilo
Claridad
Necesita aclaración
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.