Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-2402

Clarify the behavior of `comment` on database helpers on <4.4 servers

    XMLWordPrintableJSON

Details

    • Icon: Spec Change Spec Change
    • Resolution: Fixed
    • Icon: Minor - P4 Minor - P4
    • None
    • None
    • None
    • Not Needed

    Description

      Summary

      DRIVERS-742 added support for the comment field in servers >=4.4 for a number of database helpers (listIndexes, listDatabase, listCollections).  The Node driver interpreted the spec to mean that comment should not be attached in servers <4.4, but a better user experience would be to attach the comment and let the server return an error.  This is also the approach taken by the distinct helper in DRIVERS-2334.

      Motivation

      Who is the affected end user?

      Users specifying a comment on listIndexes, listDatabase, listCollections on servers <4.4.

      How does this affect the end user?

      Users might expect a comment to be attached to their commands, but if other drivers interpreted the spec as Node did, a user might be confused as to why their comment isn't present in server logs.

      How likely is it that this problem or use case will occur?

      Unlikely.  It's a small set of commands on a small set of old server versions.

      If the problem does occur, what are the consequences and how severe are they?

      Consequences are not severe - users might be confused as to why their comment isn't present in server logs.

      Is this issue urgent?

      No.

      Is this ticket required by a downstream team?

      No.

      Is this ticket only for tests?

      No.

      Attachments

        Activity

          People

            bailey.pearson@mongodb.com Bailey Pearson
            bailey.pearson@mongodb.com Bailey Pearson
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: