Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add feature switch to control XmlResolver.IsNetworkingEnabledByDefault #34412

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

Merged
merged 4 commits into from
Aug 11, 2023
Merged

Add feature switch to control XmlResolver.IsNetworkingEnabledByDefault #34412

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9caa161
Update TestApp.csproj
MichalStrehovsky Aug 2, 2023
effb616
Update Microsoft.NET.Sdk.targets
MichalStrehovsky Aug 2, 2023
7225f3b
Update GivenThatWeWantToPublishAProjectWithAllFeatures.cs
MichalStrehovsky Aug 2, 2023
6d19d39
Apply suggestions from code review
MichalStrehovsky Aug 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Apply suggestions from code review
  • Loading branch information
@MichalStrehovsky
MichalStrehovsky authored Aug 11, 2023
commit 6d19d39b58047813c06f1916095a51d8f823acc8
2 changes: 1 addition & 1 deletion src/Assets/TestProjects/KitchenSink/TestApp/TestApp.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<CustomResourceTypesSupport>false</CustomResourceTypesSupport>
<UseSystemResourceKeys>true</UseSystemResourceKeys>
<DynamicCodeSupport>true</DynamicCodeSupport>
<XmlResolverNetworkingSupport>false</XmlResolverNetworkingSupport>
<XmlResolverIsNetworkingEnabledByDefault>false</XmlResolverIsNetworkingEnabledByDefault>
<JsonSerializerIsReflectionEnabledByDefault>false</JsonSerializerIsReflectionEnabledByDefault>
<BuiltInComInteropSupport>false</BuiltInComInteropSupport>
<_EnableConsumingManagedCodeFromNativeHosting>false</_EnableConsumingManagedCodeFromNativeHosting>
Expand Down
4 changes: 2 additions & 2 deletions src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -628,8 +628,8 @@ Copyright (c) .NET Foundation. All rights reserved.
Value="$(ThreadPoolMaxThreads)" />

<RuntimeHostConfigurationOption Include="System.Xml.XmlResolver.IsNetworkingEnabledByDefault"
Copy link
Member

@eiriktsarpalis eiriktsarpalis Aug 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

The STJ property controlling the System.Text.Json.JsonSerializer.IsReflectionEnabledByDefault swich was named JsonSerializerIsReflectionEnabledByDefault. Echoing that naming convention, shouldn't this also be named XmlResolverIsNetworkingEnabledByDefault?

Typically this needs to go through API review but maybe we can fast-track this. cc @eerhardt @bartonjs @terrajobst

Copy link
Member Author

@MichalStrehovsky MichalStrehovsky Aug 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

We've not done API review on these or they would be consistent.

The XXXSupport is a prevalent theme for things that disable support for something

DebuggerSupport, EventSourceSupport, HttpActivityPropagationSupport, MetadataUpdaterSupport, NullabilityInfoContextSupport, CustomResourceTypesSupport, DynamicCodeSupport, BuiltInComInteropSupport,...

(The Json one is the odd one out)

Copy link
Member

Choose a reason for hiding this comment

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

One difference between the existing XXXSupoort flags and the JsonSerializerIsReflectionEnabledByDefault flag is that the XXXSupport flags completely remove the ability for doing XXX. Where the JsonSerializer is still capable of doing reflection, it just won’t do it by default when the flag is set. Thus the verbose naming (it’s trying to be correct/precise).

I don’t know exactly which case the new XML flag falls into, but if the XmlResolver can still use networking even if the flag is set, I wouldn’t name it XXXSupport. Because it can still do it, even though the flag is set.

Copy link
Member Author

Choose a reason for hiding this comment

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

@jozkee @krwq do you know which side IsNetworkingEnabledByDefault is on so we can finalize the name?

Copy link
Member

@eiriktsarpalis eiriktsarpalis Aug 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I'm not familiar with the code, but looking at this change suggests that it falls on the same boat as the STJ switch. It picks the XmlUrlResolver implementation if the switch is turned on, which is a public class. The behavior of XmlUrlResolver itself doesn't seem to be affected by the feature switch.

The choice of name for the feature switch also suggests similarity with the STJ one, so we might want to emulate naming convention for the property as well.

Copy link
Member Author

Choose a reason for hiding this comment

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

@eiriktsarpalis @eerhardt if this updated name looks good, could you please merge? I'm off work through end of August. It would be nice to have this in 8.0.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks!

Condition="'$(XmlResolverNetworkingSupport)' != ''"
Value="$(XmlResolverNetworkingSupport)"
Condition="'$(XmlResolverIsNetworkingEnabledByDefault)' != ''"
Value="$(XmlResolverIsNetworkingEnabledByDefault)"
Trim="true" />
</ItemGroup>

Expand Down