Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
GitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
module assignment enables use of deprecated values without a warning #7444
Original bug ID: 7444
A module assignment can remove deprecation warnings from a value, by specifying a signature that does not have them. This means you can have a codebase where some value is deprecated, there are no usage warnings, but removing it breaks your build.
The behaviour I would expect would probably be that if a field of a module is necessary to satisfy the signature it is being constrained to, and that field is deprecated, then you should get a deprecation warning at that location.
You could also imagine refusing to match a deprecated value against an undeprecated signature, but that means adding deprecation attributes can break your build even if you don't treat deprecation warnings as errors, which is IMO also undesirable. (It's also presumably the case that you want module signatures to be permitted to add deprecation warnings, so that you can deprecate access to value x via module Y).
Steps to reproduce
module X : sig
module Y : sig val x : int end = X
let _ = Y.x (* no warning *)
(* or similarly: *)
module A : sig
module F(A : sig val x : int end) = struct
module B = F(A)
Comment author: @alainfrisch
A POC implementation as as simple as:
diff --git a/parsing/builtin_attributes.ml b/parsing/builtin_attributes.ml index bdbefcd..7280cbf 100755 --- a/parsing/builtin_attributes.ml +++ b/parsing/builtin_attributes.ml @@ -69,6 +69,13 @@ let check_deprecated loc attrs s = | Some txt -> Location.prerr_warning loc (Warnings.Deprecated (s ^ "\n" ^ txt)) +let check_deprecated_inclusion loc attrs1 attrs2 s = + match deprecated_of_attrs attrs1, deprecated_of_attrs attrs2 with + | None, _ | Some _, Some _ -> () + | Some "", None -> Location.prerr_warning loc (Warnings.Deprecated s) + | Some txt, None -> + Location.prerr_warning loc (Warnings.Deprecated (s ^ "\n" ^ txt)) + let rec check_deprecated_mutable loc attrs s = match attrs with |  -> () diff --git a/parsing/builtin_attributes.mli b/parsing/builtin_attributes.mli index 9add637..47a9bdf 100755 --- a/parsing/builtin_attributes.mli +++ b/parsing/builtin_attributes.mli @@ -29,6 +29,8 @@ val check_deprecated: Location.t -> Parsetree.attributes -> string -> unit +val check_deprecated_inclusion: + Location.t -> Parsetree.attributes -> Parsetree.attributes -> string -> unit val deprecated_of_attrs: Parsetree.attributes -> string option val deprecated_of_sig: Parsetree.signature -> string option val deprecated_of_str: Parsetree.structure -> string option diff --git a/typing/includemod.ml b/typing/includemod.ml index deafeb0..cf4f8bb 100644 --- a/typing/includemod.ml +++ b/typing/includemod.ml @@ -57,6 +57,8 @@ let value_descriptions env cxt subst id vd1 vd2 = Cmt_format.record_value_dependency vd1 vd2; Env.mark_value_used env (Ident.name id) vd1; let vd2 = Subst.value_description subst vd2 in + Builtin_attributes.check_deprecated_inclusion vd2.val_loc vd1.val_attributes vd2.val_attributes + (Ident.name id); try Includecore.value_descriptions env vd1 vd2 with Includecore.Dont_match ->
Easy to extend to other kinds of items than values. But the real trouble is how/where to report the warning. We have the current context, which is a kind of path (within this module inclusion check), but not the location of the module check itself.