Do not keep log messages before initialization if the code is ran through a library

Author: kit-ty-kate

master_changes.md

@@ -127,3 +127,5 @@ users)
 ## opam-format
 
 ## opam-core
+  * `OpamConsole.log`: does not keep log messages before initialization if the code is ran through a library [#6487 @kit-ty-kate]
+  * `OpamCoreConfig.in_opam`: was added [#6487 @kit-ty-kate]

src/client/opamCliMain.ml

@@ -483,6 +483,7 @@ let json_out () =
         (Printexc.to_string e)
 
 let main () =
+  OpamCoreConfig.set_in_opam ();
   if Sys.win32 then begin
     (* Disable the critical error handling dialog *)
     ignore (OpamStubs.setErrorMode (1 lor OpamStubs.getErrorMode ()));

src/core/opamConsole.ml

@@ -562,7 +562,7 @@ let log section ?(level=1) fmt =
       | None -> debug_level
       | exception Not_found -> 0
   in
-  if not OpamCoreConfig.(!r.set) then
+  if not OpamCoreConfig.(!r.set) && OpamCoreConfig.(!r.in_opam) then
     let b = Buffer.create 128 in
     let timestamp = timestamp () ^ "  " in
     let k _ = Queue.push (level, timestamp, Buffer.contents b) pending in

src/core/opamCoreConfig.ml

@@ -67,6 +67,7 @@ type t = {
   cygbin: string option;
   git_location: string option;
   set: bool;
+  in_opam: bool;
 }
 
 type 'a options_fun =
@@ -109,6 +110,7 @@ let default = {
   cygbin = None;
   git_location = None;
   set = false;
+  in_opam = false;
 }
 
 let setk k t
@@ -151,6 +153,7 @@ let setk k t
     cygbin = (match cygbin with Some _ -> cygbin | None -> t.cygbin);
     git_location = (match git_location with Some _ -> git_location | None -> t.git_location);
     set = true;
+    in_opam = t.in_opam;
   }
 
 let set t = setk (fun x () -> x) t
@@ -212,3 +215,5 @@ let answer_is_yes () =
   | _ -> false
 
 let developer = not (String.equal OpamCoreConfigDeveloper.value "")
+
+let set_in_opam () = r := {default with in_opam = true}

src/core/opamCoreConfig.mli

@@ -78,6 +78,8 @@ type t = private {
   (** Windows specific: the full path of the git binary to use on Windows. *)
   set : bool;
   (** Options have not yet been initialised (i.e. defaults are active) *)
+  in_opam : bool;
+  (** Indicates that the code is running inside of opam and not as a library *)
 }
 
 type 'a options_fun =
@@ -136,3 +138,7 @@ val answer: unit -> OpamStd.Config.answer
 
 (** [true] if OPAM was compiled in developer mode *)
 val developer : bool
+
+(** Indicates that the code currently runs inside opam, not a library.
+    Internal use only. *)
+val set_in_opam : unit -> unit