Skip to content

Fix for new handshake and unit test. (#866) #870

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 1 commit into from
Sep 30, 2025
Merged

Fix for new handshake and unit test. (#866) #870

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 39 additions & 5 deletions Neo4j.Driver/Neo4j.Driver.Tests/Connector/BoltHandshakerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

using System;
using System.IO;
using System.Threading;
using System.Threading.Tasks;
Expand Down Expand Up @@ -81,16 +82,15 @@ private async Task DoHandshakeAsyncShouldReturnBoltVersion(byte[] streamData, in

[Fact]
private async Task DoHandshakeAsyncShouldSelectBoltVersionInRange()
{
{
var minorVersionPlus = (byte)(BoltProtocolVersion.LatestVersion.MinorVersion + 3);
var majorVersion = (byte)BoltProtocolVersion.LatestVersion.MajorVersion;
var inputData = new byte[]
{
0x00, 0x00, 0x01, 0xFF, //Identifies this as a modern negotiation with manifest v1
0x02, //2 versions to follow
0x00, 0x04, 0x04, 0x04,
0x00, majorVersion,
minorVersionPlus, majorVersion, //set to higher than actually supported
0x00, 0x04, 0x04, 0x04, //4.4 -> 4.0 (range 4)
0x00, minorVersionPlus, minorVersionPlus, majorVersion, //set to higher than actually supported. latest version + 3 minors -> latest version first major release (e.g. 6.3 -> 6.0 where 6.0 is the current highest supported version).
0x00, //no capability flags set
};

Expand All @@ -109,6 +109,40 @@ private async Task DoHandshakeAsyncShouldSelectBoltVersionInRange()
boltProtocolVersion.Should().Be(new BoltProtocolVersion(BoltProtocolVersion.LatestVersion.MajorVersion,
BoltProtocolVersion.LatestVersion.MinorVersion));
}

[Fact]
public async Task DoHandShakeAsyncShouldThrowIfRangeIsTooLarge()
{
//Range should not be more than the supplied minor version. This would mean that the driver will try
//to select a -ve minor versioned protocol version.
var majorVersion = (byte)BoltProtocolVersion.LatestVersion.MajorVersion;
var minorVersion = (byte)BoltProtocolVersion.LatestVersion.MinorVersion;
var range = (byte)(BoltProtocolVersion.LatestVersion.MinorVersion + 3); //Set the range to be too large

var inputData = new byte[]
{
0x00, 0x00, 0x01, 0xFF, //Identifies this as a modern negotiation with manifest v1
0x01, //1 versions to follow
0x00, range, minorVersion, majorVersion,
0x00, //no capability flags set
};

var readerStream = new MemoryStream(inputData);
var socket = new Mock<ITcpSocketClient>();
var writerStream = new MemoryStream();

socket.SetupGet(x => x.WriterStream).Returns(writerStream);
socket.SetupGet(x => x.ReaderStream).Returns(readerStream);

var exception = await Record.ExceptionAsync(
() => BoltHandshaker.Default.DoHandshakeAsync(
socket.Object,
new Mock<ILogger>().Object,
CancellationToken.None))
.ConfigureAwait(false);

exception.Should().BeOfType<NotSupportedException>();
}

[Fact]
public async Task DoHandshakeAsyncShouldThrowIfNotCorrectLengthResult()
Expand Down Expand Up @@ -142,7 +176,7 @@ public async Task DoHandshakeAsyncShouldThrowIfNotCorrectLengthResult()
[InlineData(
new byte[]
{
0x00, 0x00, 0x02, 0xFF, //Identifies this as a modern negotiation with manifest v2
0x00, 0x00, 0x01, 0xFF, //Identifies this as a modern negotiation with manifest v1
0x00 //0 versions to follow - ERROR
})]
private async Task DoHandshakeAsyncShouldThrowProtocolException(
Expand Down
6 changes: 4 additions & 2 deletions Neo4j.Driver/Neo4j.Driver/Internal/Connector/BoltHandshaker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ private static async Task<List<BoltProtocolVersion>> ParseSupportedProtocolVersi
var lowestVersion = new BoltProtocolVersion(protocolVersionAndRange.version.MajorVersion,
protocolVersionAndRange.version.MinorVersion - protocolVersionAndRange.range);

//If the protocol version from the server is one that this driver knows about add it to the list.
foreach (var protocol in BoltProtocolFactory.SupportedVersions)
{
if (protocol >= lowestVersion && protocol <= protocolVersionAndRange.version)
Expand All @@ -155,8 +156,9 @@ private static async Task<long> ParseCapabilityBitmask(

private static BoltProtocolVersion SelectProtocolVersion(List<BoltProtocolVersion> protocolVersions)
{
//We iterate through the versions supplied by the server in the manifest and select the newest one (highest version number)
return protocolVersions.Max();
//We now select the highest version that is in the list. This list contains the set of versions that both
//the server and the driver know about.
return protocolVersions.Max();
}

private static async Task EncodeAndSendHandshakeResponseAsync(
Expand Down