Uploaded image for project: 'Go Driver'
  1. Go Driver
  2. GODRIVER-2691

Deprecate "description.Server" fields that don't come from a handshake

    • Type: Icon: Improvement Improvement
    • Resolution: Won't Do
    • Priority: Icon: Unknown Unknown
    • None
    • Affects Version/s: None
    • Component/s: None
    • None
    • Hide

      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?

      Show
      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?

      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.

            Assignee:
            Unassigned Unassigned
            Reporter:
            matt.dale@mongodb.com Matt Dale
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: