DOCSP-49002 Auto-downloaded C Driver incorrectly inherits BUILD_VERSION #124
Conversation
✅ Deploy Preview for docs-cpp ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -42,6 +42,18 @@ The v4.0 driver release includes the following new features: | |||
| - Adds a getter method for the ``start_at_operation_time`` field of a | |||
| ``mongocxx::options::change_stream`` instance. | |||
|
|
|||
| The release includes the following bug: | |||
There was a problem hiding this comment.
S: I would make this more visible, such as in an admonition at the top of this release, in case it changes someone's mind about upgrading to this version
There was a problem hiding this comment.
For technical reviewer: Is this bug critical enough that it needs to be more visible? @eramongodb
There was a problem hiding this comment.
Difficult to say. This bug only manifests if all of the following conditions are met:
- the user is auto-downloading the C Driver instead of using an existing installation, and
- the user's build system or application is sensitive to the C Driver's API version number (that is, the version number itself), and
- the user runs the CMake configure step more than once OR sets an explicit
BUILD_VERSIONfor the C++ Driver on initial configuration, and/or - the user installs the C Driver libraries (alongside the C++ Driver libraries) to be used by other programs which expect a valid API version number.
I expect it is unlikely there are many users who satisfy all of these requirements, as either:
- they are using prebuild C and/or C++ libraries (i.e. via system package manager), or
- they are running the CMake configure step only once (configure, build, install) and without setting an explicit
BUILD_VERSION(why would they?), or - they are not using the C Driver libraries in a way that is sensitive to the API version number itself (e.g. CMake package config files for C++ Driver will identify the C Driver packages even with the incorrect package/API version number).
The inclusion of this bug notice is to encourage users using these version to at least check the C Driver libraries' API version numbers are as expected out of goodwill, but given nobody (including us) have noticed this bug since the Oct 2 release of 3.11, it's likely the actual user impact of this bug is either minimal, or not enough time has passed for usage experience to reveal this bug.
There was a problem hiding this comment.
Thanks for the additional context! Will leave where it is. If issue becomes more prevalent, another ticket can be filed to make the bug notice more visible/give more guidance.
lindseymoore
requested review from
a team and
eramongodb
and removed request for
a team
| @@ -42,6 +42,18 @@ The v4.0 driver release includes the following new features: | |||
| - Adds a getter method for the ``start_at_operation_time`` field of a | |||
| ``mongocxx::options::change_stream`` instance. | |||
|
|
|||
| The release includes the following bug: | |||
There was a problem hiding this comment.
Difficult to say. This bug only manifests if all of the following conditions are met:
- the user is auto-downloading the C Driver instead of using an existing installation, and
- the user's build system or application is sensitive to the C Driver's API version number (that is, the version number itself), and
- the user runs the CMake configure step more than once OR sets an explicit
BUILD_VERSIONfor the C++ Driver on initial configuration, and/or - the user installs the C Driver libraries (alongside the C++ Driver libraries) to be used by other programs which expect a valid API version number.
I expect it is unlikely there are many users who satisfy all of these requirements, as either:
- they are using prebuild C and/or C++ libraries (i.e. via system package manager), or
- they are running the CMake configure step only once (configure, build, install) and without setting an explicit
BUILD_VERSION(why would they?), or - they are not using the C Driver libraries in a way that is sensitive to the API version number itself (e.g. CMake package config files for C++ Driver will identify the C Driver packages even with the incorrect package/API version number).
The inclusion of this bug notice is to encourage users using these version to at least check the C Driver libraries' API version numbers are as expected out of goodwill, but given nobody (including us) have noticed this bug since the Oct 2 release of 3.11, it's likely the actual user impact of this bug is either minimal, or not enough time has passed for usage experience to reveal this bug.
…ON (#124) (#125) * DOCSP-49002 Auto-downloaded C Driver incorrectly inherits BUILD_VERSION * edit * edit * MW review * tech review * vale check * remove build version mention * edit (cherry picked from commit ff0ddd8) Co-authored-by: lindseymoore <[email protected]>
…ON (#124) (#126) * DOCSP-49002 Auto-downloaded C Driver incorrectly inherits BUILD_VERSION * edit * edit * MW review * tech review * vale check * remove build version mention * edit (cherry picked from commit ff0ddd8) Co-authored-by: lindseymoore <[email protected]>
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-49002
Staging Links
Self-Review Checklist