[DRIVERS-2708] Refactor client metadata transmission to overflow to the hello command comment field Created: 28/Aug/23  Updated: 27/Sep/23

Status: Investigating
Project: Drivers
Component/s: Handshake
Fix Version/s: None

Type: Improvement Priority: Major - P3
Reporter: Alex Bevilacqua Assignee: Shubham Ranjan
Resolution: Unresolved Votes: 1
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Duplicate
is duplicated by DRIVERS-2483 Optimize Handshake Client Metadata Closed
Related
Driver Changes: Needed
Product Manager: Shubham Ranjan Shubham Ranjan

 Description   

When a driver performs the initial handshake with the server the initial payload includes a client document that identifies the system the driver is running on.

This metadata doesn't factor into the success of a handshake, though if the transmitted size exceeds 512 bytes, it can result in a failed handshake.

Recently there have been a number of initiatives (DRIVERS-2209, DRIVERS-2570) that have required additional information to be included in the handshake metadata. Furthermore, DRIVERS-2483 was identified as an opportunity to optimize the payload to further reduce the size and improve handling of client.platform, which is a "free for all" (not ideal, but justified by the design rationale).

To better ensure the success of an initial handshake, as well as support the continued evolution of the metadata being captured the metadata included in the handshake transmission should be refactored.

This would include:

This would not include:

  • Moving all client metadata to the command field (client metadata would continue to be used)

Generated at Thu Feb 08 08:26:14 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.