Change "Recieve" methods so that failures return null packets (#350)

Wraith2 · cheenamalhotra · commit c95b0b391d3c · 2019-12-12T13:42:11.000-08:00
diff --git a/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SNI/SNINpHandle.cs b/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SNI/SNINpHandle.cs
@@ -146,6 +146,7 @@ public override void Dispose()
 
         public override uint Receive(out SNIPacket packet, int timeout)
         {
+            SNIPacket errorPacket;
             lock (this)
             {
                 packet = null;
@@ -156,17 +157,23 @@ public override uint Receive(out SNIPacket packet, int timeout)
 
                     if (packet.Length == 0)
                     {
+                        errorPacket = packet;
+                        packet = null;
                         var e = new Win32Exception();
-                        return ReportErrorAndReleasePacket(packet, (uint)e.NativeErrorCode, 0, e.Message);
+                        return ReportErrorAndReleasePacket(errorPacket, (uint)e.NativeErrorCode, 0, e.Message);
                     }
                 }
                 catch (ObjectDisposedException ode)
                 {
-                    return ReportErrorAndReleasePacket(packet, ode);
+                    errorPacket = packet;
+                    packet = null;
+                    return ReportErrorAndReleasePacket(errorPacket, ode);
                 }
                 catch (IOException ioe)
                 {
-                    return ReportErrorAndReleasePacket(packet, ioe);
+                    errorPacket = packet;
+                    packet = null;
+                    return ReportErrorAndReleasePacket(errorPacket, ioe);
                 }
 
                 return TdsEnums.SNI_SUCCESS;
@@ -175,6 +182,7 @@ public override uint Receive(out SNIPacket packet, int timeout)
 
         public override uint ReceiveAsync(ref SNIPacket packet)
         {
+            SNIPacket errorPacket;
             packet = new SNIPacket(headerSize: 0, dataSize: _bufferSize);
             
             try
@@ -184,11 +192,15 @@ public override uint ReceiveAsync(ref SNIPacket packet)
             }
             catch (ObjectDisposedException ode)
             {
-                return ReportErrorAndReleasePacket(packet, ode);
+                errorPacket = packet;
+                packet = null;
+                return ReportErrorAndReleasePacket(errorPacket, ode);
             }
             catch (IOException ioe)
             {
-                return ReportErrorAndReleasePacket(packet, ioe);
+                errorPacket = packet;
+                packet = null;
+                return ReportErrorAndReleasePacket(errorPacket, ioe);
             }
         }
 
diff --git a/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SNI/SNITcpHandle.cs b/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SNI/SNITcpHandle.cs
@@ -462,6 +462,7 @@ public override uint Send(SNIPacket packet)
         /// <returns>SNI error code</returns>
         public override uint Receive(out SNIPacket packet, int timeoutInMilliseconds)
         {
+            SNIPacket errorPacket;
             lock (this)
             {
                 packet = null;
@@ -487,24 +488,32 @@ public override uint Receive(out SNIPacket packet, int timeoutInMilliseconds)
 
                     if (packet.Length == 0)
                     {
+                        errorPacket = packet;
+                        packet = null;
                         var e = new Win32Exception();
-                        return ReportErrorAndReleasePacket(packet, (uint)e.NativeErrorCode, 0, e.Message);
+                        return ReportErrorAndReleasePacket(errorPacket, (uint)e.NativeErrorCode, 0, e.Message);
                     }
 
                     return TdsEnums.SNI_SUCCESS;
                 }
                 catch (ObjectDisposedException ode)
                 {
-                    return ReportErrorAndReleasePacket(packet, ode);
+                    errorPacket = packet;
+                    packet = null;
+                    return ReportErrorAndReleasePacket(errorPacket, ode);
                 }
                 catch (SocketException se)
                 {
-                    return ReportErrorAndReleasePacket(packet, se);
+                    errorPacket = packet;
+                    packet = null;
+                    return ReportErrorAndReleasePacket(errorPacket, se);
                 }
                 catch (IOException ioe)
                 {
-                    uint errorCode = ReportErrorAndReleasePacket(packet, ioe);
-                    if (ioe.InnerException is SocketException && ((SocketException)(ioe.InnerException)).SocketErrorCode == SocketError.TimedOut)
+                    errorPacket = packet;
+                    packet = null;
+                    uint errorCode = ReportErrorAndReleasePacket(errorPacket, ioe);
+                    if (ioe.InnerException is SocketException socketException && socketException.SocketErrorCode == SocketError.TimedOut)
                     {
                         errorCode = TdsEnums.SNI_WAIT_TIMEOUT;
                     }
@@ -553,6 +562,7 @@ public override uint SendAsync(SNIPacket packet, bool disposePacketAfterSendAsyn
         /// <returns>SNI error code</returns>
         public override uint ReceiveAsync(ref SNIPacket packet)
         {
+            SNIPacket errorPacket;
             packet = new SNIPacket(headerSize: 0, dataSize: _bufferSize);
 
             try
@@ -562,7 +572,9 @@ public override uint ReceiveAsync(ref SNIPacket packet)
             }
             catch (Exception e) when (e is ObjectDisposedException || e is SocketException || e is IOException)
             {
-                return ReportErrorAndReleasePacket(packet, e);
+                errorPacket = packet;
+                packet = null;
+                return ReportErrorAndReleasePacket(errorPacket, e);
             }
         }
 

Original file line number	Diff line number	Diff line change
`@@ -146,6 +146,7 @@ public override void Dispose()`
`146`	`146`
`147`	`147`	`public override uint Receive(out SNIPacket packet, int timeout)`
`148`	`148`	`{`
	`149`	`+ SNIPacket errorPacket;`
`149`	`150`	`lock (this)`
`150`	`151`	`{`
`151`	`152`	`packet = null;`
`@@ -156,17 +157,23 @@ public override uint Receive(out SNIPacket packet, int timeout)`
`156`	`157`
`157`	`158`	`if (packet.Length == 0)`
`158`	`159`	`{`
	`160`	`+ errorPacket = packet;`
	`161`	`+ packet = null;`
`159`	`162`	`var e = new Win32Exception();`
`160`		`- return ReportErrorAndReleasePacket(packet, (uint)e.NativeErrorCode, 0, e.Message);`
	`163`	`+ return ReportErrorAndReleasePacket(errorPacket, (uint)e.NativeErrorCode, 0, e.Message);`
`161`	`164`	`}`
`162`	`165`	`}`
`163`	`166`	`catch (ObjectDisposedException ode)`
`164`	`167`	`{`
`165`		`- return ReportErrorAndReleasePacket(packet, ode);`
	`168`	`+ errorPacket = packet;`
	`169`	`+ packet = null;`
	`170`	`+ return ReportErrorAndReleasePacket(errorPacket, ode);`
`166`	`171`	`}`
`167`	`172`	`catch (IOException ioe)`
`168`	`173`	`{`
`169`		`- return ReportErrorAndReleasePacket(packet, ioe);`
	`174`	`+ errorPacket = packet;`
	`175`	`+ packet = null;`
	`176`	`+ return ReportErrorAndReleasePacket(errorPacket, ioe);`
`170`	`177`	`}`
`171`	`178`
`172`	`179`	`return TdsEnums.SNI_SUCCESS;`
`@@ -175,6 +182,7 @@ public override uint Receive(out SNIPacket packet, int timeout)`
`175`	`182`
`176`	`183`	`public override uint ReceiveAsync(ref SNIPacket packet)`
`177`	`184`	`{`
	`185`	`+ SNIPacket errorPacket;`
`178`	`186`	`packet = new SNIPacket(headerSize: 0, dataSize: _bufferSize);`
`179`	`187`
`180`	`188`	`try`
`@@ -184,11 +192,15 @@ public override uint ReceiveAsync(ref SNIPacket packet)`
`184`	`192`	`}`
`185`	`193`	`catch (ObjectDisposedException ode)`
`186`	`194`	`{`
`187`		`- return ReportErrorAndReleasePacket(packet, ode);`
	`195`	`+ errorPacket = packet;`
	`196`	`+ packet = null;`
	`197`	`+ return ReportErrorAndReleasePacket(errorPacket, ode);`
`188`	`198`	`}`
`189`	`199`	`catch (IOException ioe)`
`190`	`200`	`{`
`191`		`- return ReportErrorAndReleasePacket(packet, ioe);`
	`201`	`+ errorPacket = packet;`
	`202`	`+ packet = null;`
	`203`	`+ return ReportErrorAndReleasePacket(errorPacket, ioe);`
`192`	`204`	`}`
`193`	`205`	`}`
`194`	`206`
Original file line number	Diff line number	Diff line change
`@@ -462,6 +462,7 @@ public override uint Send(SNIPacket packet)`
`462`	`462`	`/// <returns>SNI error code</returns>`
`463`	`463`	`public override uint Receive(out SNIPacket packet, int timeoutInMilliseconds)`
`464`	`464`	`{`
	`465`	`+ SNIPacket errorPacket;`
`465`	`466`	`lock (this)`
`466`	`467`	`{`
`467`	`468`	`packet = null;`
`@@ -487,24 +488,32 @@ public override uint Receive(out SNIPacket packet, int timeoutInMilliseconds)`
`487`	`488`
`488`	`489`	`if (packet.Length == 0)`
`489`	`490`	`{`
	`491`	`+ errorPacket = packet;`
	`492`	`+ packet = null;`
`490`	`493`	`var e = new Win32Exception();`
`491`		`- return ReportErrorAndReleasePacket(packet, (uint)e.NativeErrorCode, 0, e.Message);`
	`494`	`+ return ReportErrorAndReleasePacket(errorPacket, (uint)e.NativeErrorCode, 0, e.Message);`
`492`	`495`	`}`
`493`	`496`
`494`	`497`	`return TdsEnums.SNI_SUCCESS;`
`495`	`498`	`}`
`496`	`499`	`catch (ObjectDisposedException ode)`
`497`	`500`	`{`
`498`		`- return ReportErrorAndReleasePacket(packet, ode);`
	`501`	`+ errorPacket = packet;`
	`502`	`+ packet = null;`
	`503`	`+ return ReportErrorAndReleasePacket(errorPacket, ode);`
`499`	`504`	`}`
`500`	`505`	`catch (SocketException se)`
`501`	`506`	`{`
`502`		`- return ReportErrorAndReleasePacket(packet, se);`
	`507`	`+ errorPacket = packet;`
	`508`	`+ packet = null;`
	`509`	`+ return ReportErrorAndReleasePacket(errorPacket, se);`
`503`	`510`	`}`
`504`	`511`	`catch (IOException ioe)`
`505`	`512`	`{`
`506`		`- uint errorCode = ReportErrorAndReleasePacket(packet, ioe);`
`507`		`- if (ioe.InnerException is SocketException && ((SocketException)(ioe.InnerException)).SocketErrorCode == SocketError.TimedOut)`
	`513`	`+ errorPacket = packet;`
	`514`	`+ packet = null;`
	`515`	`+ uint errorCode = ReportErrorAndReleasePacket(errorPacket, ioe);`
	`516`	`+ if (ioe.InnerException is SocketException socketException && socketException.SocketErrorCode == SocketError.TimedOut)`
`508`	`517`	`{`
`509`	`518`	`errorCode = TdsEnums.SNI_WAIT_TIMEOUT;`
`510`	`519`	`}`
`@@ -553,6 +562,7 @@ public override uint SendAsync(SNIPacket packet, bool disposePacketAfterSendAsyn`
`553`	`562`	`/// <returns>SNI error code</returns>`
`554`	`563`	`public override uint ReceiveAsync(ref SNIPacket packet)`
`555`	`564`	`{`
	`565`	`+ SNIPacket errorPacket;`
`556`	`566`	`packet = new SNIPacket(headerSize: 0, dataSize: _bufferSize);`
`557`	`567`
`558`	`568`	`try`
`@@ -562,7 +572,9 @@ public override uint ReceiveAsync(ref SNIPacket packet)`
`562`	`572`	`}`
`563`	`573`	`catch (Exception e) when (e is ObjectDisposedException \|\| e is SocketException \|\| e is IOException)`
`564`	`574`	`{`
`565`		`- return ReportErrorAndReleasePacket(packet, e);`
	`575`	`+ errorPacket = packet;`
	`576`	`+ packet = null;`
	`577`	`+ return ReportErrorAndReleasePacket(errorPacket, e);`
`566`	`578`	`}`
`567`	`579`	`}`
`568`	`580`