From 32b18d674b9cb5e62b5c9a42f6f31391f339033c Mon Sep 17 00:00:00 2001 From: Forgind Date: Wed, 23 Mar 2022 08:58:47 -0700 Subject: [PATCH 1/9] Use changes from dotnet/msbuild#7484 --- .../BinaryLogger/BuildEventArgsReader.cs | 2 ++ src/StructuredLogger/Construction/Construction.cs | 14 ++++++++++++-- src/StructuredLogger/Strings/Strings.cs | 2 ++ 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/src/StructuredLogger/BinaryLogger/BuildEventArgsReader.cs b/src/StructuredLogger/BinaryLogger/BuildEventArgsReader.cs index 7d522aea8..be9511812 100644 --- a/src/StructuredLogger/BinaryLogger/BuildEventArgsReader.cs +++ b/src/StructuredLogger/BinaryLogger/BuildEventArgsReader.cs @@ -355,11 +355,13 @@ private BuildEventArgs ReadBuildFinishedEventArgs() { var fields = ReadBuildEventArgsFields(); var succeeded = ReadBoolean(); + var environmentProperties = fileFormatVersion >= 15 ? ReadStringDictionary() : null; var e = new BuildFinishedEventArgs( fields.Message, fields.HelpKeyword, succeeded, + environmentProperties, fields.Timestamp); SetCommonFields(e, fields); return e; diff --git a/src/StructuredLogger/Construction/Construction.cs b/src/StructuredLogger/Construction/Construction.cs index 5d5f866a7..a9d89bbc2 100644 --- a/src/StructuredLogger/Construction/Construction.cs +++ b/src/StructuredLogger/Construction/Construction.cs @@ -80,8 +80,15 @@ public void BuildStarted(object sender, BuildStartedEventArgs args) lock (syncLock) { Build.StartTime = args.Timestamp; - var properties = Build.GetOrCreateNodeWithName(Intern(Strings.Environment)); - AddProperties(properties, args.BuildEnvironment); + if (args.BuildEnvironment.Count > 0) + { + var properties = Build.GetOrCreateNodeWithName(Intern(Strings.Environment)); + AddProperties(properties, args.BuildEnvironment); + } + else + { + Build.GetOrCreateNodeWithName(Intern(Strings.NoEnvironment)); + } // realize the evaluation folder now so it is ordered before the main solution node _ = EvaluationFolder; @@ -117,6 +124,9 @@ public void BuildFinished(object sender, BuildFinishedEventArgs args) summary.Text = fullText; } + var properties = Build.GetOrCreateNodeWithName(Intern(Strings.EnvironmentDerivedProperties)); + AddProperties(properties, args.EnvironmentVariables); + //Build.VisitAllChildren(p => CalculateTargetGraph(p)); } } diff --git a/src/StructuredLogger/Strings/Strings.cs b/src/StructuredLogger/Strings/Strings.cs index 8bbec741d..4bbda5679 100644 --- a/src/StructuredLogger/Strings/Strings.cs +++ b/src/StructuredLogger/Strings/Strings.cs @@ -446,6 +446,8 @@ public static Match IsFoundConflicts(string text) public static string Evaluation => "Evaluation"; public static string Environment => "Environment"; + public static string NoEnvironment => "Define a value for MSBUILDLOGALLENVIRONMENTVARIABLES to log all environment variables. Only those used in evaluating properties are currently logged."; + public static string EnvironmentDerivedProperties => "Properties derived from environment variables"; public static string Imports => "Imports"; public static string DetailedSummary => "Detailed summary"; public static string Parameters => "Parameters"; From a853a3b7d4be68c2e04662a944a44541205ee644 Mon Sep 17 00:00:00 2001 From: Forgind Date: Wed, 23 Mar 2022 10:02:31 -0700 Subject: [PATCH 2/9] Null checks --- src/StructuredLogger/Construction/Construction.cs | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/StructuredLogger/Construction/Construction.cs b/src/StructuredLogger/Construction/Construction.cs index a9d89bbc2..3fc102590 100644 --- a/src/StructuredLogger/Construction/Construction.cs +++ b/src/StructuredLogger/Construction/Construction.cs @@ -80,7 +80,7 @@ public void BuildStarted(object sender, BuildStartedEventArgs args) lock (syncLock) { Build.StartTime = args.Timestamp; - if (args.BuildEnvironment.Count > 0) + if (args.BuildEnvironment?.Count > 0) { var properties = Build.GetOrCreateNodeWithName(Intern(Strings.Environment)); AddProperties(properties, args.BuildEnvironment); @@ -124,8 +124,11 @@ public void BuildFinished(object sender, BuildFinishedEventArgs args) summary.Text = fullText; } - var properties = Build.GetOrCreateNodeWithName(Intern(Strings.EnvironmentDerivedProperties)); - AddProperties(properties, args.EnvironmentVariables); + if (args.EnvironmentVariables is not null) + { + var properties = Build.GetOrCreateNodeWithName(Intern(Strings.EnvironmentDerivedProperties)); + AddProperties(properties, args.EnvironmentVariables); + } //Build.VisitAllChildren(p => CalculateTargetGraph(p)); } From 56fbf8cb63e57a2d42c650dee5d3028d0a6b9d8d Mon Sep 17 00:00:00 2001 From: Kirill Osenkov Date: Wed, 23 Mar 2022 10:11:36 -0700 Subject: [PATCH 3/9] Add BuildFinishedEventArgs2 Bump version to 15 --- .../BinaryLogger/BinaryLogger.cs | 2 +- .../BinaryLogger/BuildEventArgsReader.cs | 6 +-- .../BinaryLogger/BuildFinishedEventArgs2.cs | 41 +++++++++++++++++++ .../Construction/Construction.cs | 4 +- 4 files changed, 47 insertions(+), 6 deletions(-) create mode 100644 src/StructuredLogger/BinaryLogger/BuildFinishedEventArgs2.cs diff --git a/src/StructuredLogger/BinaryLogger/BinaryLogger.cs b/src/StructuredLogger/BinaryLogger/BinaryLogger.cs index 74bb38923..5a74b991b 100644 --- a/src/StructuredLogger/BinaryLogger/BinaryLogger.cs +++ b/src/StructuredLogger/BinaryLogger/BinaryLogger.cs @@ -55,7 +55,7 @@ public sealed class BinaryLogger : ILogger // - TargetSkippedEventArgs: added OriginallySucceeded, Condition, EvaluatedCondition // version 14: // - TargetSkippedEventArgs: added SkipReason, OriginalBuildEventContext - internal const int FileFormatVersion = 14; + internal const int FileFormatVersion = 15; private Stream stream; private BinaryWriter binaryWriter; diff --git a/src/StructuredLogger/BinaryLogger/BuildEventArgsReader.cs b/src/StructuredLogger/BinaryLogger/BuildEventArgsReader.cs index be9511812..9e59889b1 100644 --- a/src/StructuredLogger/BinaryLogger/BuildEventArgsReader.cs +++ b/src/StructuredLogger/BinaryLogger/BuildEventArgsReader.cs @@ -357,12 +357,12 @@ private BuildEventArgs ReadBuildFinishedEventArgs() var succeeded = ReadBoolean(); var environmentProperties = fileFormatVersion >= 15 ? ReadStringDictionary() : null; - var e = new BuildFinishedEventArgs( + var e = new BuildFinishedEventArgs2( fields.Message, fields.HelpKeyword, succeeded, - environmentProperties, - fields.Timestamp); + fields.Timestamp, + environmentProperties); SetCommonFields(e, fields); return e; } diff --git a/src/StructuredLogger/BinaryLogger/BuildFinishedEventArgs2.cs b/src/StructuredLogger/BinaryLogger/BuildFinishedEventArgs2.cs new file mode 100644 index 000000000..5af92cda3 --- /dev/null +++ b/src/StructuredLogger/BinaryLogger/BuildFinishedEventArgs2.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; + +namespace Microsoft.Build.Framework +{ + public class BuildFinishedEventArgs2 : BuildFinishedEventArgs + { + private IDictionary environmentVariables; + + public IDictionary EnvironmentVariables + { + get + { + return environmentVariables; + } + } + + /// + /// Constructor which allows environment variable-derived properties to be set + /// + /// text message + /// help keyword + /// True indicates a successful build + /// Timestamp when the event was created + /// Properties derived from environment variables + /// message arguments + public BuildFinishedEventArgs2 + ( + string message, + string helpKeyword, + bool succeeded, + DateTime eventTimestamp, + IDictionary environmentVariables, + params object[] messageArgs + ) + : base(message, helpKeyword, succeeded, eventTimestamp, messageArgs) + { + this.environmentVariables = environmentVariables; + } + } +} \ No newline at end of file diff --git a/src/StructuredLogger/Construction/Construction.cs b/src/StructuredLogger/Construction/Construction.cs index 3fc102590..13c317b9f 100644 --- a/src/StructuredLogger/Construction/Construction.cs +++ b/src/StructuredLogger/Construction/Construction.cs @@ -124,10 +124,10 @@ public void BuildFinished(object sender, BuildFinishedEventArgs args) summary.Text = fullText; } - if (args.EnvironmentVariables is not null) + if (args is BuildFinishedEventArgs2 args2 && args2.EnvironmentVariables is { Count: > 0}) { var properties = Build.GetOrCreateNodeWithName(Intern(Strings.EnvironmentDerivedProperties)); - AddProperties(properties, args.EnvironmentVariables); + AddProperties(properties, args2.EnvironmentVariables); } //Build.VisitAllChildren(p => CalculateTargetGraph(p)); From 09a921ce057a410ba524da7b75db2b418a8e0c5e Mon Sep 17 00:00:00 2001 From: Kirill Osenkov Date: Wed, 23 Mar 2022 10:34:04 -0700 Subject: [PATCH 4/9] Change the "NoEnvironment" message to a Note so it looks nicer --- src/StructuredLogger/Construction/Construction.cs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/StructuredLogger/Construction/Construction.cs b/src/StructuredLogger/Construction/Construction.cs index 13c317b9f..743558c07 100644 --- a/src/StructuredLogger/Construction/Construction.cs +++ b/src/StructuredLogger/Construction/Construction.cs @@ -87,7 +87,10 @@ public void BuildStarted(object sender, BuildStartedEventArgs args) } else { - Build.GetOrCreateNodeWithName(Intern(Strings.NoEnvironment)); + Build.AddChild(new Note + { + Text = Intern(Strings.NoEnvironment) + }); } // realize the evaluation folder now so it is ordered before the main solution node From 8a0cb7fb80e7051adae45313e7e3192a3b06408c Mon Sep 17 00:00:00 2001 From: Forgind Date: Wed, 23 Mar 2022 10:40:36 -0700 Subject: [PATCH 5/9] Update StructuredLog as well --- .../BinaryLogger/BuildEventArgsWriter.cs | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/src/StructuredLogger/BinaryLogger/BuildEventArgsWriter.cs b/src/StructuredLogger/BinaryLogger/BuildEventArgsWriter.cs index d33b03ac8..f518aa98d 100644 --- a/src/StructuredLogger/BinaryLogger/BuildEventArgsWriter.cs +++ b/src/StructuredLogger/BinaryLogger/BuildEventArgsWriter.cs @@ -191,6 +191,7 @@ private void WriteCore(BuildEventArgs e) case ProjectStartedEventArgs projectStarted: Write(projectStarted); break; case ProjectFinishedEventArgs projectFinished: Write(projectFinished); break; case BuildStartedEventArgs buildStarted: Write(buildStarted); break; + case BuildFinishedEventArgs2 buildFinished2: Write(buildFinished2); break; case BuildFinishedEventArgs buildFinished: Write(buildFinished); break; case ProjectEvaluationStartedEventArgs projectEvaluationStarted: Write(projectEvaluationStarted); break; case ProjectEvaluationFinishedEventArgs projectEvaluationFinished: Write(projectEvaluationFinished); break; @@ -250,7 +251,14 @@ private void Write(BuildStartedEventArgs e) { Write(BinaryLogRecordKind.BuildStarted); WriteBuildEventArgsFields(e); - Write(e.BuildEnvironment); + if (!string.IsNullOrEmpty(Environment.GetEnvironmentVariable("MSBUILDLOGALLENVIRONMENTVARIABLES"))) + { + Write(e.BuildEnvironment); + } + else + { + Write(0); + } } private void Write(BuildFinishedEventArgs e) @@ -260,6 +268,14 @@ private void Write(BuildFinishedEventArgs e) Write(e.Succeeded); } + private void Write(BuildFinishedEventArgs2 e) + { + Write(BinaryLogRecordKind.BuildFinished); + WriteBuildEventArgsFields(e); + Write(e.Succeeded); + Write(e.EnvironmentVariables); + } + private void Write(ProjectEvaluationStartedEventArgs e) { Write(BinaryLogRecordKind.ProjectEvaluationStarted); From 6b2b6315b14fb13c7608474d0014e4aaa78d958a Mon Sep 17 00:00:00 2001 From: Forgind Date: Thu, 7 Apr 2022 13:10:26 -0700 Subject: [PATCH 6/9] Adjust message --- src/StructuredLogger/Construction/MessageProcessor.cs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/StructuredLogger/Construction/MessageProcessor.cs b/src/StructuredLogger/Construction/MessageProcessor.cs index 8a2279fe2..6830a0737 100644 --- a/src/StructuredLogger/Construction/MessageProcessor.cs +++ b/src/StructuredLogger/Construction/MessageProcessor.cs @@ -395,6 +395,11 @@ public void AddMessage(LazyFormattedBuildEventArgs args, string message) var buildEventContext = args.BuildEventContext; + if (args is EnvironmentVariableReadEventArgs envArgs) + { + message = $"Environment variable '{envArgs.EnvironmentVariableName}' evaluated to '{message}'"; + } + if (buildEventContext.TaskId > 0) { parent = GetTask(args); From 8e459a61d2a357beee3dde300c62d56a834e7db1 Mon Sep 17 00:00:00 2001 From: Forgind Date: Thu, 7 Apr 2022 13:17:39 -0700 Subject: [PATCH 7/9] Switch to making a property --- src/StructuredLogger/Construction/MessageProcessor.cs | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/src/StructuredLogger/Construction/MessageProcessor.cs b/src/StructuredLogger/Construction/MessageProcessor.cs index 6830a0737..e0a9f43fa 100644 --- a/src/StructuredLogger/Construction/MessageProcessor.cs +++ b/src/StructuredLogger/Construction/MessageProcessor.cs @@ -395,11 +395,6 @@ public void AddMessage(LazyFormattedBuildEventArgs args, string message) var buildEventContext = args.BuildEventContext; - if (args is EnvironmentVariableReadEventArgs envArgs) - { - message = $"Environment variable '{envArgs.EnvironmentVariableName}' evaluated to '{message}'"; - } - if (buildEventContext.TaskId > 0) { parent = GetTask(args); @@ -566,7 +561,11 @@ public void AddMessage(LazyFormattedBuildEventArgs args, string message) } } - if (nodeToAdd == null) + if (args is EnvironmentVariableReadEventArgs envArgs) + { + nodeToAdd = new Property { Name = Intern(envArgs.EnvironmentVariableName), Value = Intern(message) }; + } + else if (nodeToAdd == null) { message = Intern(message); nodeToAdd = new Message From 47e75b63efa0bee55917865c5625a429549dbee0 Mon Sep 17 00:00:00 2001 From: Forgind Date: Mon, 11 Apr 2022 17:05:26 -0700 Subject: [PATCH 8/9] cleanup --- src/StructuredLogViewer/Entrypoint.cs | 2 + .../BinaryLogger/BuildEventArgsReader.cs | 6 +-- .../BinaryLogger/BuildEventArgsWriter.cs | 9 ---- .../BinaryLogger/BuildFinishedEventArgs2.cs | 41 ------------------- .../Construction/Construction.cs | 6 --- src/StructuredLogger/Strings/Strings.cs | 1 - 6 files changed, 4 insertions(+), 61 deletions(-) delete mode 100644 src/StructuredLogger/BinaryLogger/BuildFinishedEventArgs2.cs diff --git a/src/StructuredLogViewer/Entrypoint.cs b/src/StructuredLogViewer/Entrypoint.cs index cc18ac84e..bff5a9d91 100644 --- a/src/StructuredLogViewer/Entrypoint.cs +++ b/src/StructuredLogViewer/Entrypoint.cs @@ -1,4 +1,5 @@ using System; +using System.Diagnostics; using System.Windows; using System.Windows.Threading; using Microsoft.Build.Logging.StructuredLogger; @@ -10,6 +11,7 @@ public class Entrypoint [STAThread] public static void Main(string[] args) { + Debugger.Launch(); ExceptionHandler.Initialize(); DialogService.ShowMessageBoxEvent += message => MessageBox.Show(message); ClipboardService.Set += Clipboard.SetText; diff --git a/src/StructuredLogger/BinaryLogger/BuildEventArgsReader.cs b/src/StructuredLogger/BinaryLogger/BuildEventArgsReader.cs index 9e59889b1..7d522aea8 100644 --- a/src/StructuredLogger/BinaryLogger/BuildEventArgsReader.cs +++ b/src/StructuredLogger/BinaryLogger/BuildEventArgsReader.cs @@ -355,14 +355,12 @@ private BuildEventArgs ReadBuildFinishedEventArgs() { var fields = ReadBuildEventArgsFields(); var succeeded = ReadBoolean(); - var environmentProperties = fileFormatVersion >= 15 ? ReadStringDictionary() : null; - var e = new BuildFinishedEventArgs2( + var e = new BuildFinishedEventArgs( fields.Message, fields.HelpKeyword, succeeded, - fields.Timestamp, - environmentProperties); + fields.Timestamp); SetCommonFields(e, fields); return e; } diff --git a/src/StructuredLogger/BinaryLogger/BuildEventArgsWriter.cs b/src/StructuredLogger/BinaryLogger/BuildEventArgsWriter.cs index f518aa98d..8c754c03b 100644 --- a/src/StructuredLogger/BinaryLogger/BuildEventArgsWriter.cs +++ b/src/StructuredLogger/BinaryLogger/BuildEventArgsWriter.cs @@ -191,7 +191,6 @@ private void WriteCore(BuildEventArgs e) case ProjectStartedEventArgs projectStarted: Write(projectStarted); break; case ProjectFinishedEventArgs projectFinished: Write(projectFinished); break; case BuildStartedEventArgs buildStarted: Write(buildStarted); break; - case BuildFinishedEventArgs2 buildFinished2: Write(buildFinished2); break; case BuildFinishedEventArgs buildFinished: Write(buildFinished); break; case ProjectEvaluationStartedEventArgs projectEvaluationStarted: Write(projectEvaluationStarted); break; case ProjectEvaluationFinishedEventArgs projectEvaluationFinished: Write(projectEvaluationFinished); break; @@ -268,14 +267,6 @@ private void Write(BuildFinishedEventArgs e) Write(e.Succeeded); } - private void Write(BuildFinishedEventArgs2 e) - { - Write(BinaryLogRecordKind.BuildFinished); - WriteBuildEventArgsFields(e); - Write(e.Succeeded); - Write(e.EnvironmentVariables); - } - private void Write(ProjectEvaluationStartedEventArgs e) { Write(BinaryLogRecordKind.ProjectEvaluationStarted); diff --git a/src/StructuredLogger/BinaryLogger/BuildFinishedEventArgs2.cs b/src/StructuredLogger/BinaryLogger/BuildFinishedEventArgs2.cs deleted file mode 100644 index 5af92cda3..000000000 --- a/src/StructuredLogger/BinaryLogger/BuildFinishedEventArgs2.cs +++ /dev/null @@ -1,41 +0,0 @@ -using System; -using System.Collections.Generic; - -namespace Microsoft.Build.Framework -{ - public class BuildFinishedEventArgs2 : BuildFinishedEventArgs - { - private IDictionary environmentVariables; - - public IDictionary EnvironmentVariables - { - get - { - return environmentVariables; - } - } - - /// - /// Constructor which allows environment variable-derived properties to be set - /// - /// text message - /// help keyword - /// True indicates a successful build - /// Timestamp when the event was created - /// Properties derived from environment variables - /// message arguments - public BuildFinishedEventArgs2 - ( - string message, - string helpKeyword, - bool succeeded, - DateTime eventTimestamp, - IDictionary environmentVariables, - params object[] messageArgs - ) - : base(message, helpKeyword, succeeded, eventTimestamp, messageArgs) - { - this.environmentVariables = environmentVariables; - } - } -} \ No newline at end of file diff --git a/src/StructuredLogger/Construction/Construction.cs b/src/StructuredLogger/Construction/Construction.cs index 743558c07..01ba93289 100644 --- a/src/StructuredLogger/Construction/Construction.cs +++ b/src/StructuredLogger/Construction/Construction.cs @@ -127,12 +127,6 @@ public void BuildFinished(object sender, BuildFinishedEventArgs args) summary.Text = fullText; } - if (args is BuildFinishedEventArgs2 args2 && args2.EnvironmentVariables is { Count: > 0}) - { - var properties = Build.GetOrCreateNodeWithName(Intern(Strings.EnvironmentDerivedProperties)); - AddProperties(properties, args2.EnvironmentVariables); - } - //Build.VisitAllChildren(p => CalculateTargetGraph(p)); } } diff --git a/src/StructuredLogger/Strings/Strings.cs b/src/StructuredLogger/Strings/Strings.cs index 4bbda5679..a5362bed0 100644 --- a/src/StructuredLogger/Strings/Strings.cs +++ b/src/StructuredLogger/Strings/Strings.cs @@ -447,7 +447,6 @@ public static Match IsFoundConflicts(string text) public static string Evaluation => "Evaluation"; public static string Environment => "Environment"; public static string NoEnvironment => "Define a value for MSBUILDLOGALLENVIRONMENTVARIABLES to log all environment variables. Only those used in evaluating properties are currently logged."; - public static string EnvironmentDerivedProperties => "Properties derived from environment variables"; public static string Imports => "Imports"; public static string DetailedSummary => "Detailed summary"; public static string Parameters => "Parameters"; From 83e5dc5700b4da59ea28e580a870cc40c422d907 Mon Sep 17 00:00:00 2001 From: Forgind Date: Wed, 13 Apr 2022 10:25:57 -0700 Subject: [PATCH 9/9] PR comments --- src/StructuredLogViewer/Entrypoint.cs | 1 - src/StructuredLogger/BinaryLogger/BinaryLogger.cs | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/src/StructuredLogViewer/Entrypoint.cs b/src/StructuredLogViewer/Entrypoint.cs index bff5a9d91..81846ddd6 100644 --- a/src/StructuredLogViewer/Entrypoint.cs +++ b/src/StructuredLogViewer/Entrypoint.cs @@ -11,7 +11,6 @@ public class Entrypoint [STAThread] public static void Main(string[] args) { - Debugger.Launch(); ExceptionHandler.Initialize(); DialogService.ShowMessageBoxEvent += message => MessageBox.Show(message); ClipboardService.Set += Clipboard.SetText; diff --git a/src/StructuredLogger/BinaryLogger/BinaryLogger.cs b/src/StructuredLogger/BinaryLogger/BinaryLogger.cs index 5a74b991b..74bb38923 100644 --- a/src/StructuredLogger/BinaryLogger/BinaryLogger.cs +++ b/src/StructuredLogger/BinaryLogger/BinaryLogger.cs @@ -55,7 +55,7 @@ public sealed class BinaryLogger : ILogger // - TargetSkippedEventArgs: added OriginallySucceeded, Condition, EvaluatedCondition // version 14: // - TargetSkippedEventArgs: added SkipReason, OriginalBuildEventContext - internal const int FileFormatVersion = 15; + internal const int FileFormatVersion = 14; private Stream stream; private BinaryWriter binaryWriter;