microsoft / MixedRealityToolkit-Unity

This repository is for the legacy Mixed Reality Toolkit (MRTK) v2. For the latest version of the MRTK please visit https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity
https://aka.ms/mrtkdocs
MIT License
6k stars 2.12k forks source link

Migration window logging is highly verbose #8547

Closed wiwei closed 9 months ago

wiwei commented 4 years ago

Trying out the upgrade instructions:

https://microsoft.github.io/MixedRealityToolkit-Unity/version/prerelease/2.5.0_stabilization/Documentation/Updating.html

Two things I found:

Verbose messages

The last step of the migration involves running the migration tool, which is super helpful but is also very verbose in a way that tends to drown out the actual useful information:

For example, there are a lot of messages like this:

SceneDescriptionPanel does not support ObjectManipulatorMigrationHandler migration. Could not add object for migration UnityEngine.Debug:Log(Object) Microsoft.MixedReality.Toolkit.Utilities.MigrationTool:TryAddObjectForMigration(Type, Object) (at Assets/MRTK/SDK/Editor/Migration/Tools/MigrationTool.cs:106) Microsoft.MixedReality.Toolkit.Utilities.MigrationTool:AddAllAssetsOfTypeForMigration(Type, Type[]) (at Assets/MRTK/SDK/Editor/Migration/Tools/MigrationTool.cs:292) Microsoft.MixedReality.Toolkit.Utilities.MigrationTool:TryAddProjectForMigration(Type) (at Assets/MRTK/SDK/Editor/Migration/Tools/MigrationTool.cs:160) Microsoft.MixedReality.Toolkit.Utilities.MigrationWindow:DrawObjectSelection() (at Assets/MRTK/Tools/MigrationWindow/MigrationWindow.cs:188) Microsoft.MixedReality.Toolkit.Utilities.MigrationWindow:OnGUI() (at Assets/MRTK/Tools/MigrationWindow/MigrationWindow.cs:114) UnityEngine.GUIUtility:ProcessEvent(Int32, IntPtr) (at C:/buildslave/unity/build/Modules/IMGUI/GUIUtility.cs:179)

This is pretty useful for developers (us working on this) because we can see what it chooses to migrate and what it doesn't, though in a scene where most of the things are not, for example, ObjectManipulator related, then having 300+ lines where things don't match up isn't super helpful (it also drowns out the interesting messages that tell you what did get migrated)

Migrated object

There's also a lot of messages about objects that were migrated - I think it might be helpful to actually list the GUID of the object that was migrated (or any other information about it so that it's easier to understand specifically what was changed). Right now the only information you get is the name (which in some cases, can be great, but in some cases, it's just "Quad", for example)

Successfully migrated Quad object

UnityEngine.Debug:Log(Object) Microsoft.MixedReality.Toolkit.Utilities.MigrationTool:MigrateSelection(Type, Boolean) (at Assets/MRTK/SDK/Editor/Migration/Tools/MigrationTool.cs:253) Microsoft.MixedReality.Toolkit.Utilities.MigrationWindow:DrawObjectsForMigration() (at Assets/MRTK/Tools/MigrationWindow/MigrationWindow.cs:276) Microsoft.MixedReality.Toolkit.Utilities.MigrationWindow:OnGUI() (at Assets/MRTK/Tools/MigrationWindow/MigrationWindow.cs:115) UnityEngine.GUIUtility:ProcessEvent(Int32, IntPtr) (at C:/buildslave/unity/build/Modules/IMGUI/GUIUtility.cs:179)

stale[bot] commented 2 years ago

This issue has been marked as stale by an automated process because it has not had any recent activity. It will be automatically closed in 30 days if no further activity occurs. If this is still an issue please add a new comment with more recent details and repro steps.

IssueSyncBot commented 9 months ago

We appreciate your feedback and thank you for reporting this issue.

Microsoft Mixed Reality Toolkit version 2 (MRTK2) is currently in limited support. This means that Microsoft is only fixing high priority security issues. Unfortunately, this issue does not meet the necessary priority and will be closed. If you strongly feel that this issue deserves more attention, please open a new issue and explain why it is important.

Microsoft recommends that all new HoloLens 2 Unity applications use MRTK3 instead of MRTK2.

Please note that MRTK3 was released in August 2023. It features an all-new architecture for developing rich mixed reality experiences and has a minimum requirement of Unity 2021.3 LTS. For more information about MRTK3, please visit https://www.mixedrealitytoolkit.org.

Thank you for your continued support of the Mixed Reality Toolkit!