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.

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

[API Implementation]: Expose CookieException constructors #109026

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ public void SetCookies(System.Uri uri, string cookieHeader) { }
public partial class CookieException : System.FormatException, System.Runtime.Serialization.ISerializable
{
public CookieException() { }
public CookieException(string? message) { }
public CookieException(string? message, System.Exception? innerException) { }
[System.ObsoleteAttribute("This API supports obsolete formatter-based serialization. It should not be called or extended by application code.", DiagnosticId = "SYSLIB0051", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
protected CookieException(System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext) { }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,28 @@ public CookieException() : base()
{
}

internal CookieException(string? message) : base(message)
/// <summary>
/// Initializes a new instance of the <see cref='CookieException'/> class with the specified error message.
/// </summary>
/// <param name="message">A <see cref="string"/> that describes the error that occurred.</param>
/// <remarks>
/// The value of <paramref name="message"/> is stored in the <see cref="Exception.Message"/> property of the new instance.
/// </remarks>
Comment on lines +21 to +23
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// <remarks>
/// The value of <paramref name="message"/> is stored in the <see cref="Exception.Message"/> property of the new instance.
/// </remarks>

public CookieException(string? message) : base(message)
{
}

internal CookieException(string? message, Exception? inner) : base(message, inner)
/// <summary>
/// Initializes a new instance of the <see cref='CookieException'/> class with the specified error message
/// and a reference to the inner exception that is the cause of this exception.
/// </summary>
/// <param name="message">A <see cref="string"/> that describes the error that occurred.</param>
/// <param name="innerException">A nested <see cref="Exception"/>.</param>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// <param name="innerException">A nested <see cref="Exception"/>.</param>
/// <param name="innerException">The exception that is the cause of the current exception.</param>

/// <remarks>
/// The value of <paramref name="message"/> is stored in the <see cref="Exception.Message"/> property of the new instance.
/// The value of <paramref name="message"/> is stored in the <see cref="Exception.InnerException"/> property of the new instance.
/// </remarks>
Comment on lines +34 to +37
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// <remarks>
/// The value of <paramref name="message"/> is stored in the <see cref="Exception.Message"/> property of the new instance.
/// The value of <paramref name="message"/> is stored in the <see cref="Exception.InnerException"/> property of the new instance.
/// </remarks>

public CookieException(string? message, Exception? innerException) : base(message, innerException)
{
}

Expand Down
Copy link
Member

Choose a reason for hiding this comment

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

I think you'll have to include a reference to the new file in the test csproj.

Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using Xunit;

namespace System.Net.Primitives.UnitTests.Tests;

public sealed class CookieExceptionTest
{
[Theory]
[InlineData("Testing the CookieException")]
[InlineData(null)]
public void Constructor_Message(string? message)
{
var exception = new CookieException(message);
Assert.Equal(message, exception.Message);
}

[Theory]
[InlineData("Testing the CookieException", true)]
[InlineData("Testing the CookieException", false)]
[InlineData(null, true)]
[InlineData(null, false)]
public void Constructor_Message_InnerException(string? message, bool innerException)
{
var inner = innerException ? new Exception() : null;
var exception = new CookieException(message, inner);

Assert.Equal(message, exception.Message);
Assert.Equal(inner, exception.InnerException);
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Assert.Equal(inner, exception.InnerException);
Assert.Same(inner, exception.InnerException);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There would be no difference in result, if I use Same.
Exception is an reference type with no Equals overload, so it already compares the reference.

https://sharplab.io/#v2:EYLgtghglgdgNAFxAJwK4wD4AEBMBGAWAChiA3CZAAgFMBHVCAGz0oF5KZqB3SgUQA8AxtQAOCKAHsYACgBEAQVkBKANxkKNekxxsO3PkNHipcxauLEseAJzSAJLN5bGISgG86DZm3aftAX2U1IitbBycvVzcAJWoAM2pkahhhCKYAZ2k/ZjhNLxwlQNUgA=

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace System.Net
public class CookieException : FormatException
{
public CookieException() : base() { }
internal CookieException(string message) : base(message) { }
internal CookieException(string message, Exception inner) : base(message, inner) { }
public CookieException(string message) : base(message) { }
public CookieException(string message, Exception inner) : base(message, inner) { }
}
}
Loading