[DRIVERS-2402] Clarify the behavior of `comment` on database helpers on <4.4 servers Created: 28/Jul/22  Updated: 28/Oct/23  Resolved: 26/Sep/22

Status: Closed
Project: Drivers
Component/s: None
Fix Version/s: None

Type: Spec Change Priority: Minor - P4
Reporter: Bailey Pearson Assignee: Bailey Pearson
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Driver Changes: 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.



 Comments   
Comment by Jeffrey Yemin [ 26/Sep/22 ]

Spec change is merged.

Comment by Githook User [ 15/Sep/22 ]

Author:

{'name': 'Bailey Pearson', 'email': 'bailey.pearson@mongodb.com', 'username': 'baileympearson'}

Message: DRIVERS-2402: Clarify the behavior of comments on pre-4.4 servers (#1294)
Branch: master
https://github.com/mongodb/specifications/commit/3d13d39aea4eeed590989cf6fd649d09c0b72cd2

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