Migrate from Lwt_log to Logs

This replaces all uses of the Lwt_log library by Logs. Lwt_log is
deprecated and its README suggest to use Logs instead so it seems like a
good choice.

The bulk of the change was done with the lwt-log-to-logs tool.

This is almost a 1 to 1 translation as the two libraries are very
similar but there are some differences:

- The "Fatal" log level doesn't exist in Logs. "Error" is used instead.

- Log messages are formatted with Format.

- Logs has no equivalent of "broadcast" and "dispatch" available out of
  the box. These operations are easily supported by generating more
  code.

- There is no equivalent for Lwt_log.add_rule in Logs. Luckily it can be
  avoided in this project. This might cause more work in Ocsigen
  applications that use their own log sections.

- Syslog support is done by the "logs-syslog" library.

- There is no equivalent for Lwt_log.close. Ocsigen_messages is still
  able to close its reporters, except for the syslog reporter, which
  doesn't support this operation.

Author: Julow

src/baselib/ocsigen_loader.ml

@@ -23,7 +23,7 @@ open Ocsigen_lib
 exception Dynlink_error of string * exn
 exception Findlib_error of string * exn
 
-let section = Lwt_log.Section.make "ocsigen:dynlink"
+let section = Logs.Src.create "ocsigen:dynlink"
 
 (************************************************************************)
 
@@ -68,22 +68,23 @@ let loadfile pre post force file =
     if force
     then (
       pre ();
-      Lwt_log.ign_info_f ~section "Loading %s (will be reloaded every times)"
-        file;
+      Logs.info ~src:section (fun fmt ->
+        fmt "Loading %s (will be reloaded every times)" file);
       try
         Dynlink_wrapper.loadfile file;
         post ()
       with e -> post (); raise e)
     else if not (isloaded file)
     then (
       pre ();
-      Lwt_log.ign_info_f ~section "Loading extension %s" file;
+      Logs.info ~src:section (fun fmt -> fmt "Loading extension %s" file);
       (try
          Dynlink_wrapper.loadfile file;
          post ()
        with e -> post (); raise e);
       addloaded file)
-    else Lwt_log.ign_info_f ~section "Extension %s already loaded" file
+    else
+      Logs.info ~src:section (fun fmt -> fmt "Extension %s already loaded" file)
   with e -> raise (Dynlink_error (file, e))
 
 let id () = ()
@@ -114,22 +115,25 @@ let init_module pre post force name =
       let l = List.rev @@ M.find name !init_functions in
       fun () -> List.iter (fun f -> f ()) l
     with Not_found ->
-      Lwt_log.ign_info_f ~section "No init function for named module %s." name;
+      Logs.info ~src:section (fun fmt ->
+        fmt "No init function for named module %s." name);
       fun () -> ()
   in
   if force
   then (
     pre ();
-    Lwt_log.ign_info_f ~section
-      "Initializing %s (will be initialized every time)" name;
+    Logs.info ~src:section (fun fmt ->
+      fmt "Initializing %s (will be initialized every time)" name);
     try f (); post () with e -> post (); raise e)
   else if not (isloaded name)
   then (
     pre ();
-    Lwt_log.ign_info_f ~section "Initializing module %s " name;
+    Logs.info ~src:section (fun fmt -> fmt "Initializing module %s " name);
     (try f (); post () with e -> post (); raise e);
     addloaded name)
-  else Lwt_log.ign_info_f ~section "Module %s already initialized." name
+  else
+    Logs.info ~src:section (fun fmt ->
+      fmt "Module %s already initialized." name)
 
 (************************************************************************)
 (* Manipulating Findlib's search path *)
@@ -170,8 +174,8 @@ let findfiles =
              not @@ String.Set.mem a Ocsigen_config_static.builtin_packages)
           (Findlib.package_deep_ancestors preds [package])
       in
-      Lwt_log.ign_info_f ~section "Dependencies of %s: %s" package
-        (String.concat ", " deps);
+      Logs.info ~src:section (fun fmt ->
+        fmt "Dependencies of %s: %s" package (String.concat ", " deps));
       let rec aux = function
         | [] -> []
         | a :: q ->
@@ -189,7 +193,8 @@ let findfiles =
             List.map (Findlib.resolve_path ~base) mods @ aux q
       in
       let res = aux deps in
-      Lwt_log.ign_info_f ~section "Needed: %s" (String.concat ", " res);
+      Logs.info ~src:section (fun fmt ->
+        fmt "Needed: %s" (String.concat ", " res));
       res
     with e -> raise (Findlib_error (package, e))
 

src/baselib/ocsigen_loader.mli

@@ -32,7 +32,7 @@
 exception Dynlink_error of string * exn
 exception Findlib_error of string * exn
 
-val section : Lwt_log_core.section
+val section : Logs.src
 (** use Lwt_log.Section.set_level in order to debug *)
 
 val translate : string -> string

src/extensions/accesscontrol.ml

@@ -23,7 +23,7 @@
 open Ocsigen_lib
 open Xml
 
-let section = Lwt_log.Section.make "ocsigen:ext:access-control"
+let section = Logs.Src.create "ocsigen:ext:access-control"
 
 type condition = Ocsigen_request.t -> bool
 
@@ -41,30 +41,28 @@ let ip s =
     let r = Ipaddr.Prefix.mem (Ocsigen_request.remote_ip_parsed ri) prefix in
     if r
     then
-      Lwt_log.ign_info_f ~section "IP: %a matches %s"
-        (fun () -> Ocsigen_request.remote_ip)
-        ri s
+      Logs.info ~src:section (fun fmt ->
+        fmt "IP: %s matches %s" (Ocsigen_request.remote_ip ri) s)
     else
-      Lwt_log.ign_info_f ~section "IP: %a does not match %s"
-        (fun () -> Ocsigen_request.remote_ip)
-        ri s;
+      Logs.info ~src:section (fun fmt ->
+        fmt "IP: %s does not match %s" (Ocsigen_request.remote_ip ri) s);
     r
 
 let port port ri =
   let r = Ocsigen_request.port ri = port in
   if r
-  then Lwt_log.ign_info_f ~section "PORT = %d: true" port
+  then Logs.info ~src:section (fun fmt -> fmt "PORT = %d: true" port)
   else
-    Lwt_log.ign_info_f ~section "PORT = %d: false (it is %a)" port
-      (fun () ri -> string_of_int (Ocsigen_request.port ri))
-      ri;
+    Logs.info ~src:section (fun fmt ->
+      fmt "PORT = %d: false (it is %s)" port
+        (string_of_int (Ocsigen_request.port ri)));
   r
 
 let ssl ri =
   let r = Ocsigen_request.ssl ri in
   if r
-  then Lwt_log.ign_info ~section "SSL: true"
-  else Lwt_log.ign_info ~section "SSL: false";
+  then Logs.info ~src:section (fun fmt -> fmt "SSL: true")
+  else Logs.info ~src:section (fun fmt -> fmt "SSL: false");
   r
 
 let header ~name ~regexp:re =
@@ -79,12 +77,15 @@ let header ~name ~regexp:re =
       List.exists
         (fun a ->
            let r = Netstring_pcre.string_match regexp a 0 <> None in
-           if r then Lwt_log.ign_info_f "HEADER: header %s matches %S" name re;
+           if r
+           then
+             Logs.info (fun fmt -> fmt "HEADER: header %s matches %S" name re);
            r)
         (Ocsigen_request.header_multi ri (Ocsigen_header.Name.of_string name))
     in
     if not r
-    then Lwt_log.ign_info_f "HEADER: header %s does not match %S" name re;
+    then
+      Logs.info (fun fmt -> fmt "HEADER: header %s does not match %S" name re);
     r
 
 let method_ m ri =
@@ -93,8 +94,9 @@ let method_ m ri =
   let s' = Cohttp.Code.string_of_method m' in
   let r = m = m' in
   if r
-  then Lwt_log.ign_info_f ~section "METHOD: %s matches %s" s' s
-  else Lwt_log.ign_info_f ~section "METHOD: %s does not match %s" s' s;
+  then Logs.info ~src:section (fun fmt -> fmt "METHOD: %s matches %s" s' s)
+  else
+    Logs.info ~src:section (fun fmt -> fmt "METHOD: %s does not match %s" s' s);
   r
 
 let protocol v ri =
@@ -103,8 +105,10 @@ let protocol v ri =
   let s' = Cohttp.Code.string_of_version v' in
   let r = v = v' in
   if r
-  then Lwt_log.ign_info_f ~section "PROTOCOL: %s matches %s" s' s
-  else Lwt_log.ign_info_f ~section "PROTOCOL: %s does not match %s" s' s;
+  then Logs.info ~src:section (fun fmt -> fmt "PROTOCOL: %s matches %s" s' s)
+  else
+    Logs.info ~src:section (fun fmt ->
+      fmt "PROTOCOL: %s does not match %s" s' s);
   r
 
 let path ~regexp:s =
@@ -118,8 +122,10 @@ let path ~regexp:s =
     let sps = Ocsigen_request.sub_path_string ri in
     let r = Netstring_pcre.string_match regexp sps 0 <> None in
     if r
-    then Lwt_log.ign_info_f ~section "PATH: \"%s\" matches %S" sps s
-    else Lwt_log.ign_info_f ~section "PATH: \"%s\" does not match %S" sps s;
+    then Logs.info ~src:section (fun fmt -> fmt "PATH: \"%s\" matches %S" sps s)
+    else
+      Logs.info ~src:section (fun fmt ->
+        fmt "PATH: \"%s\" does not match %S" sps s);
     r
 
 let and_ sub ri = List.for_all (fun cond -> cond ri) sub
@@ -167,8 +173,12 @@ let rec parse_condition = function
         let sps = Ocsigen_request.sub_path_string ri in
         let r = Netstring_pcre.string_match regexp sps 0 <> None in
         if r
-        then Lwt_log.ign_info_f ~section "PATH: \"%s\" matches %S" sps s
-        else Lwt_log.ign_info_f ~section "PATH: \"%s\" does not match %S" sps s;
+        then
+          Logs.info ~src:section (fun fmt ->
+            fmt "PATH: \"%s\" matches %S" sps s)
+        else
+          Logs.info ~src:section (fun fmt ->
+            fmt "PATH: \"%s\" does not match %S" sps s);
         r
   | Element (("path" as s), _, _) ->
       Ocsigen_extensions.badconfig "Bad syntax for tag %s" s
@@ -192,11 +202,11 @@ let rec parse_condition = function
 (*****************************************************************************)
 (* Parsing filters *)
 
-let comma_space_regexp = Netstring_pcre.regexp "\ *,\ *"
+let comma_space_regexp = Netstring_pcre.regexp " *, *"
 
 let allow_forward_for_handler ?(check_equal_ip = false) () =
   let apply ({Ocsigen_extensions.request_info; _} as request) code =
-    Lwt_log.ign_info ~section "Allowed proxy";
+    Logs.info ~src:section (fun fmt -> fmt "Allowed proxy");
     let request =
       let header =
         Ocsigen_request.header request_info Ocsigen_header.Name.x_forwarded_for
@@ -218,14 +228,15 @@ let allow_forward_for_handler ?(check_equal_ip = false) () =
                     ~remote_ip:original_ip request_info }
             else (
               (* the announced ip of the proxy is not its real ip *)
-              Lwt_log.ign_warning_f ~section
-                "X-Forwarded-For: host ip (%s) does not match the header (%s)"
-                (Ocsigen_request.remote_ip request_info)
-                header;
+              Logs.warn ~src:section (fun fmt ->
+                fmt
+                  "X-Forwarded-For: host ip (%s) does not match the header (%s)"
+                  (Ocsigen_request.remote_ip request_info)
+                  header);
               request)
         | _ ->
-            Lwt_log.ign_info_f ~section "Malformed X-Forwarded-For field: %s"
-              header;
+            Logs.info ~src:section (fun fmt ->
+              fmt "Malformed X-Forwarded-For field: %s" header);
             request)
       | None -> request
     in
@@ -240,7 +251,7 @@ let allow_forward_for_handler ?(check_equal_ip = false) () =
 
 let allow_forward_proto_handler =
   let apply ({Ocsigen_extensions.request_info; _} as request) code =
-    Lwt_log.ign_info ~section "Allowed proxy for ssl";
+    Logs.info ~src:section (fun fmt -> fmt "Allowed proxy for ssl");
     let request_info =
       let header =
         Ocsigen_request.header request_info
@@ -252,8 +263,8 @@ let allow_forward_proto_handler =
         | "http" -> Ocsigen_request.update ~ssl:false request_info
         | "https" -> Ocsigen_request.update ~ssl:true request_info
         | _ ->
-            Lwt_log.ign_info_f ~section "Malformed X-Forwarded-Proto field: %s"
-              header;
+            Logs.info ~src:section (fun fmt ->
+              fmt "Malformed X-Forwarded-Proto field: %s" header);
             request_info)
       | None -> request_info
     in
@@ -292,17 +303,19 @@ let parse_config parse_fun = function
           Lwt.return
             (if condition ri.Ocsigen_extensions.request_info
              then (
-               Lwt_log.ign_info ~section "COND: going into <then> branch";
+               Logs.info ~src:section (fun fmt ->
+                 fmt "COND: going into <then> branch");
                Ocsigen_extensions.Ext_sub_result ithen)
              else (
-               Lwt_log.ign_info ~section
-                 "COND: going into <else> branch, if any";
+               Logs.info ~src:section (fun fmt ->
+                 fmt "COND: going into <else> branch, if any");
                Ocsigen_extensions.Ext_sub_result ielse)))
   | Element (("if" as s), _, _) ->
       Ocsigen_extensions.badconfig "Bad syntax for tag %s" s
   | Element ("notfound", [], []) ->
       fun _rs ->
-        Lwt_log.ign_info ~section "NOT_FOUND: taking in charge 404";
+        Logs.info ~src:section (fun fmt ->
+          fmt "NOT_FOUND: taking in charge 404");
         Lwt.return
           (Ocsigen_extensions.Ext_stop_all (Ocsigen_cookie_map.empty, `Not_found))
   | Element (("notfound" as s), _, _) ->
@@ -340,7 +353,8 @@ let parse_config parse_fun = function
       Ocsigen_extensions.badconfig "Bad syntax for tag %s" s
   | Xml.Element ("forbidden", [], []) ->
       fun _rs ->
-        Lwt_log.ign_info ~section "FORBIDDEN: taking in charge 403";
+        Logs.info ~src:section (fun fmt ->
+          fmt "FORBIDDEN: taking in charge 403");
         Lwt.return
           (Ocsigen_extensions.Ext_stop_all (Ocsigen_cookie_map.empty, `Forbidden))
   | Element (("forbidden" as s), _, _) ->

src/extensions/accesscontrol.mli

@@ -88,5 +88,5 @@ val allow_forward_for :
 
 val allow_forward_proto : unit -> Ocsigen_server.instruction
 
-val section : Lwt_log_core.section
+val section : Logs.src
 (** Use Lwt_log.Section.set_level in order to change the log level *)

src/extensions/authbasic.ml

@@ -20,7 +20,7 @@
 
 open Lwt.Infix
 
-let section = Lwt_log.Section.make "ocsigen:ext:access-control"
+let section = Logs.Src.create "ocsigen:ext:access-control"
 
 type auth = string -> string -> bool Lwt.t
 
@@ -56,10 +56,10 @@ let gen ~realm ~auth rs =
       Cohttp.Header.init_with "WWW-Authenticate"
         (Printf.sprintf "Basic realm=\"%s\"" realm)
     in
-    Lwt_log.ign_info ~section "AUTH: invalid credentials!";
+    Logs.info ~src:section (fun fmt -> fmt "AUTH: invalid credentials!");
     Lwt.fail (Ocsigen_cohttp.Ext_http_error (`Unauthorized, None, Some h))
   and invalid_header () =
-    Lwt_log.ign_info ~section "AUTH: invalid Authorization header";
+    Logs.info ~src:section (fun fmt -> fmt "AUTH: invalid Authorization header");
     Lwt.fail
       (Ocsigen_cohttp.Ocsigen_http_error (Ocsigen_cookie_map.empty, `Bad_request))
   in

src/extensions/authbasic.mli

@@ -56,7 +56,7 @@ let _ =
     very naive one (authentication with a single user/password, given
     in the configuration file) is provided. *)
 
-val section : Lwt_log_core.section
+val section : Logs.src
 (** use [Lwt_log.Section.set_level] in order to set the log level *)
 
 type auth = string -> string -> bool Lwt.t

src/extensions/cors.ml

@@ -20,7 +20,7 @@
 
 (** Handle Cross-Origin Resource Sharing (CORS) headers *)
 
-let section = Lwt_log.Section.make "ocsigen:ext:cors"
+let section = Logs.Src.create "ocsigen:ext:cors"
 
 (*** MAIN FUNCTION ***)
 
@@ -40,7 +40,7 @@ let add_headers config r response =
   match Ocsigen_request.header r Ocsigen_header.Name.origin with
   | None -> Lwt.return Ocsigen_extensions.Ext_do_nothing
   | Some origin ->
-      Lwt_log.ign_info_f ~section "request with origin: %s" origin;
+      Logs.info ~src:section (fun fmt -> fmt "request with origin: %s" origin);
       let l = [Ocsigen_header.Name.access_control_allow_origin, origin] in
       let l =
         if config.credentials
@@ -65,7 +65,7 @@ let add_headers config r response =
               (Ocsigen_header.Name.access_control_allow_methods, request_method)
               :: l
             else (
-              Lwt_log.ign_info ~section "Method refused";
+              Logs.info ~src:section (fun fmt -> fmt "Method refused");
               raise Refused)
         | None -> l
       in
@@ -103,15 +103,15 @@ let main config = function
     -> (
     match Ocsigen_request.meth request_info with
     | `OPTIONS -> (
-        Lwt_log.ign_info ~section "OPTIONS request";
+        Logs.info ~src:section (fun fmt -> fmt "OPTIONS request");
         try add_headers config request_info (default_frame ())
         with Refused ->
-          Lwt_log.ign_info ~section "Refused request";
+          Logs.info ~src:section (fun fmt -> fmt "Refused request");
           Lwt.return Ocsigen_extensions.Ext_do_nothing)
     | _ -> Lwt.return Ocsigen_extensions.Ext_do_nothing)
   | Ocsigen_extensions.Req_found ({Ocsigen_extensions.request_info; _}, response)
     ->
-      Lwt_log.ign_info ~section "answered request";
+      Logs.info ~src:section (fun fmt -> fmt "answered request");
       add_headers config request_info response
 
 (* Register extension *)