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

Fix: NetworkStream throwing inconsistent exceptions #40772

Merged
merged 5 commits into from
Nov 4, 2020
Merged

Fix: NetworkStream throwing inconsistent exceptions #40772

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7d2d6aa
fix: NetworkStream throwing inconsistent exceptions
antonfirsov Aug 13, 2020
3c847a5
no more nested NetworkExceptions
antonfirsov Aug 13, 2020
875be8d
Merge branch 'exp/SendToRecvFrom_Datagram_UDP' into af/fix-NetworkStr…
antonfirsov Nov 3, 2020
b90a9a8
fix exception message and update code
antonfirsov Nov 3, 2020
94e243c
fix test
antonfirsov Nov 3, 2020
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
32 changes: 23 additions & 9 deletions src/libraries/System.Net.Sockets/src/System/Net/Sockets/NetworkStream.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,13 +264,20 @@ public override int Read(Span<byte> buffer)
ThrowIfDisposed();
if (!CanRead) throw new InvalidOperationException(SR.net_writeonlystream);

int bytesRead = _streamSocket.Receive(buffer, SocketFlags.None, out SocketError errorCode);
if (errorCode != SocketError.Success)
try
{
var exception = new SocketException((int)errorCode);
throw NetworkErrorHelper.MapSocketException(exception);
int bytesRead = _streamSocket.Receive(buffer, SocketFlags.None, out SocketError errorCode);
if (errorCode != SocketError.Success)
{
var exception = new SocketException((int)errorCode);
throw NetworkErrorHelper.MapSocketException(exception);
Copy link
Contributor

Choose a reason for hiding this comment

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

This combined with the catch below is going to result in two NetworkExceptions, one inside the other, isn't it?

Same issue below in ReadByte

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, good catch.

}
return bytesRead;
}
catch (Exception exception) when (!(exception is OutOfMemoryException))
Copy link
Member

Choose a reason for hiding this comment

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

If the goal is consistency with the array-based overload, why do the catch blocks differ?

Copy link
Member Author

Choose a reason for hiding this comment

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

These overloads do not throw SocketException, but return SocketError as out parameter instead.

Copy link
Member Author

Choose a reason for hiding this comment

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

We can refactor all overloads to use either the throwing or the out variant if we really care, but I would do it in a separate PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

I do think it would be better to be consistent here, and use the throwing versions consistently. That said, I'm fine not doing this in this PR.

{
throw GetCustomNetworkException(SR.Format(SR.net_io_writefailure, exception.Message), exception);
Copy link
Contributor

@geoffkizer geoffkizer Aug 14, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Presumably this should be SR.net_io_readfailure, right? Similarly below.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

}
return bytesRead;
}

public override unsafe int ReadByte()
Expand Down Expand Up @@ -348,11 +355,18 @@ public override void Write(ReadOnlySpan<byte> buffer)
ThrowIfDisposed();
if (!CanWrite) throw new InvalidOperationException(SR.net_readonlystream);

_streamSocket.Send(buffer, SocketFlags.None, out SocketError errorCode);
if (errorCode != SocketError.Success)
try
{
var exception = new SocketException((int)errorCode);
throw NetworkErrorHelper.MapSocketException(exception);
_streamSocket.Send(buffer, SocketFlags.None, out SocketError errorCode);
if (errorCode != SocketError.Success)
{
var exception = new SocketException((int)errorCode);
throw NetworkErrorHelper.MapSocketException(exception);
}
}
catch (Exception exception) when (!(exception is OutOfMemoryException))
{
throw GetCustomNetworkException(SR.Format(SR.net_io_writefailure, exception.Message), exception);
}
}

Expand Down
30 changes: 17 additions & 13 deletions src/libraries/System.Net.Sockets/tests/FunctionalTests/NetworkStreamTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,8 +301,10 @@ await RunWithConnectedNetworkStreamsAsync((server, _) =>
});
}

[Fact]
public async Task DisposeSocketDirectly_ReadWriteThrowNetworkException()
[Theory]
[InlineData(true)]
[InlineData(false)]
public async Task DisposeSocketDirectly_ReadWriteThrowNetworkException(bool derivedNetworkStream)
{
using (Socket listener = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp))
using (Socket client = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp))
Expand All @@ -312,20 +314,22 @@ public async Task DisposeSocketDirectly_ReadWriteThrowNetworkException()

Task<Socket> acceptTask = listener.AcceptAsync();
await Task.WhenAll(acceptTask, client.ConnectAsync(new IPEndPoint(IPAddress.Loopback, ((IPEndPoint)listener.LocalEndPoint).Port)));
using (Socket serverSocket = await acceptTask)
using (DerivedNetworkStream server = new DerivedNetworkStream(serverSocket))
{
serverSocket.Dispose();
using Socket serverSocket = await acceptTask;
using NetworkStream server = derivedNetworkStream ? (NetworkStream)new DerivedNetworkStream(serverSocket) : new NetworkStream(serverSocket);

serverSocket.Dispose();

Assert.Throws<NetworkException>(() => server.Read(new byte[1], 0, 1));
Assert.Throws<NetworkException>(() => server.Write(new byte[1], 0, 1));
Assert.Throws<NetworkException>(() => server.Read(new byte[1], 0, 1));
Assert.Throws<NetworkException>(() => server.Write(new byte[1], 0, 1));

Assert.Throws<NetworkException>(() => server.BeginRead(new byte[1], 0, 1, null, null));
Assert.Throws<NetworkException>(() => server.BeginWrite(new byte[1], 0, 1, null, null));
Assert.Throws<NetworkException>(() => server.Read(new byte[1]));
Assert.Throws<NetworkException>(() => server.Write(new byte[1]));

Assert.Throws<NetworkException>(() => { server.ReadAsync(new byte[1], 0, 1); });
Assert.Throws<NetworkException>(() => { server.WriteAsync(new byte[1], 0, 1); });
}
Assert.Throws<NetworkException>(() => server.BeginRead(new byte[1], 0, 1, null, null));
Assert.Throws<NetworkException>(() => server.BeginWrite(new byte[1], 0, 1, null, null));

Assert.Throws<NetworkException>(() => { server.ReadAsync(new byte[1], 0, 1); });
Assert.Throws<NetworkException>(() => { server.WriteAsync(new byte[1], 0, 1); });
}
}

Expand Down