C#: MSBuild logs and panel enhancements #72061

paulloz · 2023-01-25T17:45:57Z

I'm continuing my quest about improving the C# experience.

Rename the current .NET related editor settings from mono to dotnet, as it become more and more confusing for people to see the word mono in the interface.
Add a button on the right of the MSBuild panel to directly open the logs folder, which is currently quite hard to pinpoint (since it uses an MD5 hash in its path).
Add a few settings, so the user is able to tune how MSBuild logs behave.
- Verbosity Level is tied to the -v flag.
- No Console Logging switches -noconlog on or off, basically either print to the console and the logfile or to the logfile alone.
- Create Binary Log switches -bl on or off, binary logs being a very useful tool to debug MSBuild issues.
Finally, as I suggested in Wrong Chinese encoding for MSBuild errors in the editor #71326, try to tie the language used by MSBuild with the language used by Godot. Won't solve that issue entirely, but is still a step in the right direction IMHO.

en fr ja

modules/mono/editor/GodotTools/GodotTools/Build/BuildSystem.cs

modules/mono/editor/GodotTools/GodotTools/Build/MSBuildPanel.cs

modules/mono/editor/GodotTools/GodotTools/GodotSharpEditor.cs

raulsntos · 2023-01-25T18:48:07Z

modules/mono/editor/GodotTools/GodotTools/GodotSharpEditor.cs

+        public override void _DisablePlugin()
+        {
+            base._DisablePlugin();
+
+            _editorSettings.SettingsChanged -= OnSettingsChanged;
+        }
+
+        private void OnSettingsChanged()
+        {
+            // We want to force NoConsoleLogging to true when the VerbosityLevel is at Detailed or above.
+            // At that point, there's so much info logged that it doesn't make sense to display it in
+            // the tiny editor window, and it'd make the editor hang or crash anyway.
+            var verbosityLevel = (VerbosityLevelId)(int)_editorSettings.GetSetting(Settings.VerbosityLevel);
+            var hideConsoleLog = (bool)_editorSettings.GetSetting(Settings.NoConsoleLogging);
+            if (verbosityLevel >= VerbosityLevelId.Detailed && !hideConsoleLog)
+                _editorSettings.SetSetting(Settings.NoConsoleLogging, Variant.From(true));
+        }


Would it make more sense to handle this in BuildSystem?

You mean forcing -noconlog regardless of Settings.NoConsoleLogging if the verbosity is too high? I thought about it, but it felt better to show the user the checkbox getting automatically set to true. Makes it more "intentional"?

Yes, that's what I meant. I'm not sure what's better to be honest.

raulsntos · 2023-01-25T19:00:14Z

modules/mono/editor/GodotTools/GodotTools/GodotSharpEditor.cs

@@ -171,7 +179,7 @@ public void ShowErrorDialog(string message, string title = "Error")
        [UsedImplicitly]
        public Error OpenInExternalEditor(Script script, int line, int col)
        {
-            var editorId = (ExternalEditorId)(int)_editorSettings.GetSetting("mono/editor/external_editor");
+            var editorId = (ExternalEditorId)(int)_editorSettings.GetSetting(Settings.ExternalEditor);


Users coming from previous betas will lose their settings.

How do you think this should be handled?

Edit: To be clear, I agree it's not ideal. But on the other hand: it's a single setting, and it's probably better now than after the beta?

I don't know if we have something in Godot to handle editor setting renames. If we don't, we may want to still look for the old name and, if found, set the new setting's value; at least for the betas/RCs.

cc @akien-mga

Unless there's a built-in way to do this, I think it may be too much work to bother with it. Otherwise, you could check if the old setting is present, move its value to the new one, and remove the old one to avoid repeating this.

Can you be more specific about what you mean by "not bother with it"? Are you implying we'd leave everything labelled "mono" or that we could afford to break settings compatibility between betas?

Sorry, I meant not bother about migrating from the old setting. It may be annoying, but it's a one-time thing and there are other breaking changes coming as well.

Asked in RC:

@raulsntos: Do we have a way to migrate EditorSettings? For example, if an user has configured settingA in beta 5, and it was renamed to settingB in beta 10, they now have to reconfigure it.

@akien-mga: Not currently, though I guess it could be handled in EditorSettings _get and _set like other properties. But usually we don't try to preserve compat for editor settings.

So I think it's fine as is.

modules/mono/editor/GodotTools/GodotTools/Build/BuildInfo.cs

neikeq · 2023-01-26T21:37:45Z

No Console Logging switches -noconlog on or off, basically either print to the console and the logfile or to the logfile alone.

What is the use case for this?

Create Binary Log switches -bl on or off, binary logs being a very useful tool to debug MSBuild issues.

Does this override our custom MSBuild logger? We rely on that one to show the list of errors and warnings after building.

paulloz · 2023-01-26T21:53:22Z

What is the use case for this?

Being able to produce useful build logs (on disk) without flooding the console.

Does this override our custom MSBuild logger? We rely on that one to show the list of errors and warnings after building.

This doesn't override anything, the custom logger hasn't been touched.

raulsntos

LGTM

- toggle creation of binary logs - manage log verbosity - toggle logging in console

paulloz · 2023-02-07T15:59:31Z

Rewrote the commit history as discussed. Shouldn't change anything behaviourwise.

akien-mga · 2023-02-07T18:38:49Z

Thanks!

DmitriySalnikov · 2023-02-08T16:55:56Z

is it related? #64276

paulloz · 2023-02-08T17:26:16Z

@DmitriySalnikov Do you mean "does it fix it?"? If so, not sure. All we're doing here is forcing the CLI language to the same locale as Godot. I didn't see any encoding issue with all the locales I had available to test, but didn't explicitly check ru.

paulloz requested a review from a team as a code owner January 25, 2023 17:45

raulsntos added enhancement topic:dotnet topic:editor labels Jan 25, 2023

raulsntos added this to the 4.0 milestone Jan 25, 2023

raulsntos reviewed Jan 25, 2023

View reviewed changes

modules/mono/editor/GodotTools/GodotTools/Build/BuildInfo.cs Outdated Show resolved Hide resolved

paulloz force-pushed the csharp/better-logs-management branch from 0ed87fa to 5137c94 Compare February 1, 2023 16:16

raulsntos approved these changes Feb 7, 2023

View reviewed changes

YuriSizov requested a review from neikeq February 7, 2023 15:21

paulloz added 4 commits February 7, 2023 16:48

Rename existing editor settings mono -> dotnet

e51a20b

Add button to open the msbuild logs folder

7cf42db

Add new settings about MSBuild

9bf2a0b

- toggle creation of binary logs - manage log verbosity - toggle logging in console

Try and match MSBuild and Godot UI languages

c70c82b

paulloz force-pushed the csharp/better-logs-management branch from 5137c94 to c70c82b Compare February 7, 2023 15:58

akien-mga approved these changes Feb 7, 2023

View reviewed changes

akien-mga merged commit 8be4fee into godotengine:master Feb 7, 2023

paulloz deleted the csharp/better-logs-management branch February 7, 2023 19:53

raulsntos mentioned this pull request Feb 9, 2023

Godot Mono External editor setting is broken #72933

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

C#: MSBuild logs and panel enhancements #72061

C#: MSBuild logs and panel enhancements #72061

paulloz commented Jan 25, 2023

raulsntos Jan 25, 2023

paulloz Jan 25, 2023

raulsntos Jan 25, 2023

raulsntos Jan 25, 2023

paulloz Jan 25, 2023 •

edited

Loading

raulsntos Jan 25, 2023

neikeq Jan 26, 2023

paulloz Jan 26, 2023

neikeq Jan 26, 2023

raulsntos Feb 1, 2023

neikeq commented Jan 26, 2023

paulloz commented Jan 26, 2023

raulsntos left a comment

paulloz commented Feb 7, 2023

akien-mga commented Feb 7, 2023

DmitriySalnikov commented Feb 8, 2023

paulloz commented Feb 8, 2023

C#: MSBuild logs and panel enhancements #72061

C#: MSBuild logs and panel enhancements #72061

Conversation

paulloz commented Jan 25, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paulloz Jan 25, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neikeq commented Jan 26, 2023

paulloz commented Jan 26, 2023

raulsntos left a comment

Choose a reason for hiding this comment

paulloz commented Feb 7, 2023

akien-mga commented Feb 7, 2023

DmitriySalnikov commented Feb 8, 2023

paulloz commented Feb 8, 2023

paulloz Jan 25, 2023 •

edited

Loading