Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Optimize RAR's GetReferenceItems method #5929

Merged
merged 23 commits into from Feb 6, 2021
Merged

Optimize RAR's GetReferenceItems method #5929

Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
cfe147c
Iterate over dictionary once
Forgind Dec 2, 2020
17015af
Avoid unnecessary initializations
Forgind Dec 2, 2020
fec708e
Set copy local more efficiently
Forgind Dec 2, 2020
ed2bc5c
referenceItem should have no metadata initially
Forgind Dec 2, 2020
2fc517f
Update larger metadata dictionary
Forgind Dec 2, 2020
1dc3bc5
Set fusionName at end
Forgind Dec 2, 2020
77b1038
Slightly simplify referenceItem creation
Forgind Dec 2, 2020
507214d
Fix typos
Forgind Dec 2, 2020
4945ad2
Addition to setting fusionName at end
Forgind Dec 2, 2020
cf314ab
Shift other types of removed metadata later so they only have to be r…
Forgind Dec 2, 2020
7077b0e
Tests should permit case-insensitive metadata checks
Forgind Dec 3, 2020
afe2cf0
Use ternary operators
Forgind Dec 4, 2020
9dccb26
Set items as a group
Forgind Dec 4, 2020
147ef43
PR comments
Forgind Dec 4, 2020
2901929
Revert "Tests should permit case-insensitive metadata checks"
Forgind Dec 4, 2020
fd0a93d
PR comments
Forgind Dec 6, 2020
74cf67c
PR feedback
Forgind Dec 7, 2020
8a45a46
Update src/MSBuildTaskHost/Immutable/ImmutableDictionary.cs
Forgind Dec 7, 2020
2a8893c
Correct setting items
Forgind Dec 7, 2020
04e72ed
Make align with old way
Forgind Jan 26, 2021
2bb3210
Use _metadata directly
Forgind Feb 1, 2021
ff501aa
Merge https://github.com/dotnet/msbuild into optimize-rar
Forgind Feb 2, 2021
2f23808
Access remote metadata indirectly
Forgind Feb 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 10 additions & 20 deletions src/Tasks/AssemblyDependency/ReferenceTable.cs
View file
Open in desktop
Expand Up @@ -2598,9 +2598,6 @@ private ITaskItem SetItemMetadata(List<ITaskItem> relatedItems, List<ITaskItem>
// Set the CopyLocal metadata.
referenceItem.SetMetadata(ItemMetadataNames.copyLocal, reference.IsCopyLocal.ToString());
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Convert to ternary operator


// Set the FusionName metadata.
referenceItem.SetMetadata(ItemMetadataNames.fusionName, fusionName);

// Set the Redist name metadata.
if (!String.IsNullOrEmpty(reference.RedistName))
{
Expand Down Expand Up @@ -2654,20 +2651,11 @@ private ITaskItem SetItemMetadata(List<ITaskItem> relatedItems, List<ITaskItem>
}
}

// Set the IsRedistRoot metadata
if (reference.IsRedistRoot == true)
{
referenceItem.SetMetadata(ItemMetadataNames.isRedistRoot, "true");
}
else if (reference.IsRedistRoot == false)
{
referenceItem.SetMetadata(ItemMetadataNames.isRedistRoot, "false");
}
else
// The redist root is "null" when there was no IsRedistRoot flag in the Redist XML
// (or there was no redist XML at all for this item).
if (reference.IsRedistRoot != null)
{
// This happens when the redist root is "null". This means there
// was no IsRedistRoot flag in the Redist XML (or there was no
// redist XML at all for this item).
referenceItem.SetMetadata(ItemMetadataNames.isRedistRoot, reference.IsRedistRoot.ToString());
}

// If there was a primary source item, then forward metadata from it.
Expand Down Expand Up @@ -2726,14 +2714,16 @@ private ITaskItem SetItemMetadata(List<ITaskItem> relatedItems, List<ITaskItem>
referenceItem.SetMetadata(ItemMetadataNames.version, String.Empty);
}

// Unset fusionName so we don't have to unset it later.
referenceItem.RemoveMetadata(ItemMetadataNames.fusionName);

// Now clone all properties onto the related files.
foreach (string relatedFileExtension in reference.GetRelatedFileExtensions())
{
ITaskItem item = new TaskItem(reference.FullPathWithoutExtension + relatedFileExtension);
// Clone metadata.
referenceItem.CopyMetadataTo(item);
// Related files don't have a fusion name.
item.SetMetadata(ItemMetadataNames.fusionName, "");
RemoveNonForwardableMetadata(item);

// Add the related item.
Expand All @@ -2749,7 +2739,6 @@ private ITaskItem SetItemMetadata(List<ITaskItem> relatedItems, List<ITaskItem>
// Set the destination directory.
item.SetMetadata(ItemMetadataNames.destinationSubDirectory, FileUtilities.EnsureTrailingSlash(Path.GetDirectoryName(satelliteFile)));
// Satellite files don't have a fusion name.
item.SetMetadata(ItemMetadataNames.fusionName, "");
RemoveNonForwardableMetadata(item);

// Add the satellite item.
Expand All @@ -2763,7 +2752,6 @@ private ITaskItem SetItemMetadata(List<ITaskItem> relatedItems, List<ITaskItem>
// Clone metadata.
referenceItem.CopyMetadataTo(item);
// serialization assemblies files don't have a fusion name.
item.SetMetadata(ItemMetadataNames.fusionName, "");
RemoveNonForwardableMetadata(item);

// Add the serialization assembly item.
Expand All @@ -2777,7 +2765,6 @@ private ITaskItem SetItemMetadata(List<ITaskItem> relatedItems, List<ITaskItem>
// Clone metadata.
referenceItem.CopyMetadataTo(item);
// We don't have a fusion name for scatter files.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove these comments please.

item.SetMetadata(ItemMetadataNames.fusionName, "");
RemoveNonForwardableMetadata(item);

// Add the satellite item.
Expand All @@ -2798,6 +2785,9 @@ private ITaskItem SetItemMetadata(List<ITaskItem> relatedItems, List<ITaskItem>
}
}

// Set the FusionName metadata properly.
referenceItem.SetMetadata(ItemMetadataNames.fusionName, fusionName);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "properly" mean? In general, how do you know this is safe? Is the local variable fusionName guaranteed to be empty for all the paths where it was previously unset? How do you know?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If any of reference.GetSourceItems() has a fusionName, or reference.PrimarySourceItem has one, fusionName may have been set to an invalid value at this point. We remove it before forwarding referenceItem's metadata to other items, but we still need to set it properly at the end, i.e., give it the right fusionName.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you mind clarifying what you meant about fusionName being guaranteed to be empty? Previously, fusionName was set to a value near the top of this method, that value was passed on to a variety of "relatedItems," "satelliteItems," etc., and then it was unset from all of those other items. Here, instead, I'm unsetting it prior to using fusionName for any of those, and only giving it its value at the bottom, so CopyMetadataTo automatically skips fusionName.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The meta comment is: "properly" is basically useless in a code comment. Comments describe what you want the code to do/why it's done, and of course you want to do things "properly". Instead, describe details. Here, you might have a comment that fusionName should be set last, so that it doesn't get copied to the derived items but is still available on the primary item.


return referenceItem;
}

Expand Down