[GODRIVER-2691] Deprecate "description.Server" fields that don't come from a handshake Created: 14/Dec/22  Updated: 26/May/23  Resolved: 26/May/23

Status: Closed
Project: Go Driver
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Unknown
Reporter: Matt Dale Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
is depended on by GODRIVER-2617 Remove or un-export all currently dep... Closed
Related
related to GODRIVER-2694 Return errors from "description.NewSe... Backlog
related to DRIVERS-2552 Remove average and 90th percentile RT... Closed
Epic Link: Go Driver 2.0 Prep
Quarter: FY24Q1
Documentation Changes Summary:

1. What would you like to communicate to the user about this feature?
2. Would you like the user to see examples of the syntax and/or executable code and its output?
3. Which versions of the driver/connector does this apply to?


 Description   

Some fields on a description.Server are not part of a handshake response and can become stale, leading to confusion and bugs.

Fields that should be deprecated:

  • AverageRTT, AverageRTTSet - The average RTT and the "set=true" fields are set after handshake to the value of the current average RTT for the server. These can be very misleading because the average RTT changes over time, but these fields are never updated after handshake. Also, not all instances of description.Server are guaranteed to have these fields set, leading to additional confusion. All driver code should fetch the current RTT values from the RTTMonitor. There is no known external use case.
  • HeartbeatInterval - The heartbeat interval is set to the Client's heartbeat interval after handshake and is used in the server selection functions in the description package. There is no known external use case.
    Note: We may want to keep this field around, but as an unexported field.

Definition of done:

  • Deprecate AverageRTT, AverageRTTSet, and HeartbeatInterval.


 Comments   
Comment by Matt Dale [ 26/May/23 ]

Based on the current feedback in DRIVERS-2552, we aren't going to do this right now. Will re-open if the conclusion to DRIVERS-2552 suggests we should do this.

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