Extend property assignment event (The feature is opted-out by default)

[YuliiaKovalova]

Fixes #2711
and connected to KirillOsenkov/MSBuildStructuredLog#839

Context

The feature is opted-out by default due to perf considerations !
This implementation covers cases:

• property coming from a command-line argument (e.g. /p:) (previously had a Global source)
• as an output of a target
• as an output of a task
• exact property location if it comes from xml during evaluation

Also, the message formatting logic was changed for PropertyReassignmentEventArgs and PropertyInitialValueSetEventArgs to have it optimized for existing deduplication logic.
The event save all the unique data and format it on the receiving side (e.g. LogViewer).

The measurements were taken for the latest OrchardCode

	No property init/reassignment logged	Property init/reassignment logged
Binlog Size	162.932 KB	196.269 KB
Build Time	533.4s	579.0s
BinLog allocations	Total opening time: 1:00.416, Loading: 27.490 s, Analyzing: 7.036 s, Indexing: 21.540 s, Reading files: 400 ms, Allocated: 35,920,765,696 bytes, Nodes: 219,551,777, Strings: 436,574	Total opening time: 1:28.087, Loading: 39.449 s, Analyzing: 6.991 s, Indexing: 37.275 s, Reading files: 403 ms, Allocated: 39,507,530,416 bytes, Nodes: 224,560,814, Strings: 489,542

Conclusions:

Metric	Analysis
Binlog Size	The binlog size increased from 162.932 KB to 196.269 KB, an increase of about 20%.
Build Time	The build time increased from 533.4s to 579.0s, an increase of approximately 8.5%.
BinLog allocations	Memory Allocation: Increased from ~35.9 GB to ~39.5 GB (+10% memory usage), Node and String Count: Nodes increased by 2.3% and Strings increased by 12.1%, Loading time increased significantly (from 27.5s to 39.4s), Indexing time increased (from 21.5s to 37.3s)

[JanKrivanek]

I have couple comments to consider.

The main thing before signoff - this is currently not a default behavior (neither with /bl) - correct? Property tracking needs to be explicitly opted in - right?
Please add that info into the PR description (as otherwise the 8.5% perf hit might be bit concerning and might need a bit more deeper look)

[KirillOsenkov]

How do I enable the feature for testing? What setting value did you use for perf testing?

[KirillOsenkov]

I'm seeing something weird, and it's not because of your PR.

Location for property reassignment is being logged as null, so the property reassignment messages end up looking like this:

But with your PR the location is there:

I don't understand what's going on.

[KirillOsenkov]

There are two things I did to investigate the binlog size increase:

1. use File -> Statistics in the viewer, then right-click on the Statistics node (the last one in the tree) and click Copy children, then diff for an old binlog and new binlog
2. under Statistics -> Strings, expand and select the only node under Strings, then press Space (this will view all the strings in the text editor) - diff those, I notice a lot of new strings with this change (primarily strings for file, line and column appended) - these shouldn't be added

For diffing, pick a simple console application, and do an incremental build (not clean build), setting MsBuildLogPropertyTracking to the right value. What is the default value for it currently? Why are property reassignment messages even logged when the value is 0 (the current default)?

[KirillOsenkov]

Ah, I see:

msbuild/src/Build/Evaluation/PropertyTrackingEvaluatorDataWrapper.cs

Lines 320 to 323 in 4042363

	// Either we want to specifically track property reassignments
	// or we do not want to track nothing - in which case the prop reassignment is enabled by default.
	if ((_settings & PropertyTrackingSetting.PropertyReassignment) == PropertyTrackingSetting.PropertyReassignment ||
	(_settings == 0 && ChangeWaves.AreFeaturesEnabled(ChangeWaves.Wave17_10)))

[KirillOsenkov]

I'm not quite sure, but I think we might have lost the location for property reassignment with #10102 (FYI @JanKrivanek)

[KirillOsenkov]

MSBuild 17.12 (the one I use) doesn't log PropertyReassignmentEventArgs, it logs a message, which the viewer than parses, and there is no location there

[KirillOsenkov]

Wait, no, I'm super confused. The location was only null for properties coming from toolset. For properties coming from XML the location is there and was passed as a string argument (one of 4 args). This is good, we have an opportunity to be better than the current state.

[JanKrivanek]

Wait, no, I'm super confused. The location was only null for properties coming from toolset. For properties coming from XML the location is there and was passed as a string argument (one of 4 args). This is good, we have an opportunity to be better than the current state.

Did we have the location for props comming from toolset before? Or is that regression?

[YuliiaKovalova]

How do I enable the feature for testing? What setting value did you use for perf testing?

please set MsBuildLogPropertyTracking=15