-
Type:
Improvement
-
Resolution: Unresolved
-
Priority:
Minor - P4
-
Affects Version/s: bson-4.15.1, bson-5.1.0
-
Component/s: BSON
-
None
-
Ruby Drivers
-
None
-
None
-
None
-
None
-
None
-
None
Per https://github.com/mongodb/bson-ruby/pull/346 – BSON::Document explicitly fails when symbolize_keys! is called (instructing you to convert the document to a hash first), but deep_symbolize_keys! is not similarly forbidden.
As this is a breaking change (removing a function from the public API, even though it was never intentionally part of the public API), it needs to be part of an eventual 6.0 release.
The OP is adjusting the proposed PR to issue a deprecation warning instead, for now, but when it's time for 6.0, we should explicitly remove deep_symbolize_keys! from the BSON::Document interface (similar to how we did for symbolize_keys!).