[SERVER-60814] Need better way to avoid accidental additions to the stable API Created: 19/Oct/21  Updated: 29/Oct/23  Resolved: 22/Nov/21

Status: Closed
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: 5.2.0

Type: Improvement Priority: Major - P3
Reporter: Geert Bosch Assignee: Huayu Ouyang
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to SERVER-64821 Change unstable to true for fields th... Closed
Backwards Compatibility: Fully Compatible
Sprint: Replication 2021-11-15, Replication 2021-11-29
Participants:

 Description   

Currently, it is very easy to unintentionally add a new option to an existing command through a change in a .idl file, or similar. There apparently is a way to flag IDL changes as unstable, but it is not widely known and there definitely is a likelihood of accidental changes to the stable API at the moment.



 Comments   
Comment by Githook User [ 22/Nov/21 ]

Author:

{'name': 'Huayu Ouyang', 'email': 'huayu.ouyang@mongodb.com', 'username': 'huayu-ouyang'}

Message: SERVER-60814 Require 'unstable' field to avoid accidental additions to the stable API
Branch: master
https://github.com/mongodb/mongo/commit/e818cd876ed3b492517400a3da3f687fbe13d8aa

Comment by Judah Schvimer [ 15/Nov/21 ]

I think we should add this to commands that already exist for consistency.

Comment by Huayu Ouyang [ 15/Nov/21 ]

Should the field be required for commands that already exist (in apiVersion "1") as well, or just in newly added fields in the next apiVersion? 

Comment by Judah Schvimer [ 09/Nov/21 ]

Works for me!

Comment by A. Jesse Jiryu Davis [ 09/Nov/21 ]

SGTM. Require the field only for commands with non-empty apiVersion, to avoid noise in other IDLs?

Comment by Judah Schvimer [ 25/Oct/21 ]

Making "unstable" a required field is probably the most straightforward solution. (And we may want to switch it to "stable" with reversed semantics).

Generated at Thu Feb 08 05:50:48 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.