[DRIVERS-2707] Relax the CMAP documentation requirement for durations in events Created: 25/Aug/23  Updated: 09/Jan/24

Status: Implementing
Project: Drivers
Component/s: CMAP
Fix Version/s: None

Type: Bug Priority: Unknown
Reporter: Maxim Katcharov Assignee: Valentin Kavalenka
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Gantt End to End
has to be finished together with DRIVERS-2469 Add durations to connection pool events Implementing
Issue split
split to GODRIVER-2961 Relax the CMAP documentation requirem... Backlog
split to PYTHON-3941 Relax the CMAP documentation requirem... Backlog
split to RUBY-3320 Relax the CMAP documentation requirem... Blocked
split to CDRIVER-4712 Relax the CMAP documentation requirem... Closed
split to CSHARP-4774 Relax the CMAP documentation requirem... Closed
split to CXX-2739 Relax the CMAP documentation requirem... Closed
split to MOTOR-1179 Relax the CMAP documentation requirem... Closed
split to NODE-5589 Relax the CMAP documentation requirem... Closed
split to PHPLIB-1222 Relax the CMAP documentation requirem... Closed
split to RUST-1742 Relax the CMAP documentation requirem... Closed
split to JAVA-5121 Relax the CMAP documentation requirem... Closed
Problem/Incident
is caused by DRIVERS-2469 Add durations to connection pool events Implementing
Driver Changes: Needed
Downstream Changes Summary:

Update the driver implementation and documentation of CMAP event durations according to the specification changes in https://github.com/mongodb/specifications/pull/1455.

Engineering Lead: Jeffrey Yemin Jeffrey Yemin
Program Manager: Tom Selander Tom Selander
Start date:
Driver Compliance:
Key Status/Resolution FixVersion
CDRIVER-4712 Won't Do
CXX-2739 Won't Do
CSHARP-4774 Works as Designed
GODRIVER-2961 Backlog
JAVA-5121 Done 5.0.0
NODE-5589 Duplicate
MOTOR-1179 Duplicate
PYTHON-3941 Backlog
PHPLIB-1222 Won't Do
RUBY-3320 Blocked
RUST-1742 Fixed 2.8.0

 Description   

Summary

In this commit, for DRIVERS-2469, we added the wording "The driver MUST document this behavior as well as explicitly warn users that the behavior may change in the future." Discussed in the Java implementation. It seems that specs should not require (or suggest) that a public API be documented as subject to change (or that implementation details be documented.

I propose that we commit to the (reasonable) specified behaviour. If not, then remove the requirement to doc it.

Motivation

Who is the affected end user?

Users who read driver docs

How does this affect the end user?

Cannot rely on documented behaviour

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

Unlikely

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

Trivial

Is this issue urgent?

No, but it is opportune to fix this now since it is in progress.

Is this ticket required by a downstream team?

No

Is this ticket only for tests?

Neither, just docs

Acceptance Criteria

The requirement to document public behaviour as tentative is removed.



 Comments   
Comment by Githook User [ 10/Oct/23 ]

Author:

{'name': 'Valentin Kovalenko', 'email': 'valentin.kovalenko@mongodb.com', 'username': 'stIncMale'}

Message: DRIVERS-2707 Relax the CMAP documentation requirement for durations in events (#1455)

DRIVERS-2707

---------

Co-authored-by: Bailey Pearson <bailey.pearson@gmail.com>
Branch: master
https://github.com/mongodb/specifications/commit/c6621d01b37df9c7a9ae2036f10d0b6597047bc3

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