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

Add back IHtmlString to System.Web.HttpUtility #85673

Merged
merged 2 commits into from
May 3, 2023
Merged

Add back IHtmlString to System.Web.HttpUtility #85673

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01527b0
Add back IHtmlString to System.Web.HttpUtility
stephentoub Apr 28, 2023
8709f04
Update src/libraries/System.Web.HttpUtility/tests/HttpUtility/HttpUti…
stephentoub May 2, 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
4 changes: 4 additions & 0 deletions src/libraries/System.Web.HttpUtility/ref/System.Web.HttpUtility.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,8 @@ public static void HtmlEncode(string? s, System.IO.TextWriter output) { }
[return: System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute("str")]
public static string? UrlPathEncode(string? str) { throw null; }
}
public partial interface IHtmlString
{
string ToHtmlString();
}
}
1 change: 1 addition & 0 deletions src/libraries/System.Web.HttpUtility/src/System.Web.HttpUtility.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<TargetFramework>$(NetCoreAppCurrent)</TargetFramework>
</PropertyGroup>
<ItemGroup>
<Compile Include="System\Web\IHtmlString.cs" />
<Compile Include="System\Web\HttpUtility.cs" />
<Compile Include="System\Web\Util\HttpEncoder.cs" />
<Compile Include="System\Web\Util\HttpEncoderUtility.cs" />
Expand Down
7 changes: 6 additions & 1 deletion src/libraries/System.Web.HttpUtility/src/System/Web/HttpUtility.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,12 @@ public static NameValueCollection ParseQueryString(string query, Encoding encodi

[return: NotNullIfNotNull(nameof(value))]
public static string? HtmlEncode(object? value) =>
value == null ? null : HtmlEncode(Convert.ToString(value, CultureInfo.CurrentCulture) ?? string.Empty);
value switch
{
null => null,
IHtmlString ihs => ihs.ToHtmlString() ?? string.Empty,
Copy link
Member

Choose a reason for hiding this comment

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

Nit: the Framework implementation doesn't alter null to string.Empty.

Copy link
Member Author

Choose a reason for hiding this comment

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

I went back and forth on it... part of the problem is since .NET Framework we've annotated the method as returning non-null.

Also, even for the non-IHtmlString case, Framework allows null to be returned and core doesn't, right? I'd need to double check but I believe that's what I saw. In which case this is just staying consistent with what the API is doing for other inputs.

Copy link
Member

Choose a reason for hiding this comment

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

Also, even for the non-IHtmlString case, Framework allows null to be returned and core doesn't, right?

Yes - a class that returns a null value from .ToString() returns a null value on framework, but a string.Empty on core.

Copy link
Member

Choose a reason for hiding this comment

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

Also - should IHtmlstring.ToHtmlString() be nullable since we're checking it here?

Copy link
Member Author

@stephentoub stephentoub May 3, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

You tell me :-) My assumption was we don't expect null to be valid; the check is just in case. But if null is valid, then yes, this should be nullable. In all the implementations you've seen, is null expected?

Copy link
Member

Choose a reason for hiding this comment

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

Sorry - I'm out sick and slow responding :) I found a number of implementations in the wild and there are no checks to validate if it is null or not, and the equivalent type on ASP.NET Core accepts a nullable string. Seems like it should be nullable.

Copy link
Member

Choose a reason for hiding this comment

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

I don't have a strong opinion here, though, as the type itself is the important thing.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've changed it in #85742.

_ => HtmlEncode(Convert.ToString(value, CultureInfo.CurrentCulture) ?? string.Empty),
};

public static void HtmlEncode(string? s, TextWriter output) => HttpEncoder.HtmlEncode(s, output);

Expand Down
13 changes: 13 additions & 0 deletions src/libraries/System.Web.HttpUtility/src/System/Web/IHtmlString.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

namespace System.Web
{
/// <summary>Represents an HTML-encoded string that should not be encoded again.</summary>
public interface IHtmlString
{
/// <summary>Returns an HTML-encoded string.</summary>
/// <returns>An HTML-encoded string.</returns>
string ToHtmlString();
}
}
14 changes: 14 additions & 0 deletions src/libraries/System.Web.HttpUtility/tests/HttpUtility/HttpUtilityTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,20 @@ public void HtmlEncode_TextWriter_null()
});
}

[Fact]
public void HtmlEncode_IHtmlString_UseToHtmlString()
{
Assert.Equal(string.Empty, HttpUtility.HtmlEncode(new ActionHtmlString(() => null)));
Assert.Equal(string.Empty, HttpUtility.HtmlEncode(new ActionHtmlString(() => string.Empty)));
Assert.Equal("42", HttpUtility.HtmlEncode(new ActionHtmlString(() => "42")));
stephentoub marked this conversation as resolved.
Show resolved Hide resolved
Assert.Throws<FormatException>(() => HttpUtility.HtmlEncode(new ActionHtmlString(() => throw new FormatException())));
}

private sealed class ActionHtmlString(Func<string> toHtmlString) : IHtmlString
{
public string ToHtmlString() => toHtmlString();
}

#endregion HtmlEncode

#region JavaScriptStringEncode
Expand Down