Merge pull request #17809 from MinaProtocol/lyh/bootstrap-controller-move-time-span-to-mina-stdlib

move time span related fns from bootstrap controller -> stdlib

Author: glyh

src/lib/bootstrap_controller/bootstrap_controller.ml

@@ -2,11 +2,12 @@
 open Core
 open Async
 open Mina_base
-module Ledger = Mina_ledger.Ledger
-module Sync_ledger = Mina_ledger.Sync_ledger
 open Mina_state
 open Pipe_lib.Strict_pipe
 open Network_peer
+open Mina_stdlib
+module Ledger = Mina_ledger.Ledger
+module Sync_ledger = Mina_ledger.Sync_ledger
 module Transition_cache = Transition_cache
 
 module type CONTEXT = sig
@@ -36,27 +37,14 @@ type t =
   ; mutable num_of_root_snarked_ledger_retargeted : int
   }
 
-type time = Time.Span.t
-
-let time_to_yojson span =
-  `String (Printf.sprintf "%f seconds" (Time.Span.to_sec span))
-
-type opt_time = time option
-
-let opt_time_to_yojson = function
-  | Some time ->
-      time_to_yojson time
-  | None ->
-      `Null
-
 (** An auxiliary data structure for collecting various metrics for bootstrap controller. *)
 type bootstrap_cycle_stats =
   { cycle_result : string
-  ; sync_ledger_time : time
-  ; staged_ledger_data_download_time : time
-  ; staged_ledger_construction_time : opt_time
+  ; sync_ledger_time : Time.Span.t
+  ; staged_ledger_data_download_time : Time.Span.t
+  ; staged_ledger_construction_time : Time.Span.t option
   ; local_state_sync_required : bool
-  ; local_state_sync_time : opt_time
+  ; local_state_sync_time : Time.Span.t option
   }
 [@@deriving to_yojson]
 
@@ -695,7 +683,7 @@ let run ~context:(module Context : CONTEXT) ~trust_system ~verifier ~network
   in
   [%log info] "Bootstrap completed in $time_elapsed: $bootstrap_stats"
     ~metadata:
-      [ ("time_elapsed", time_to_yojson time_elapsed)
+      [ ("time_elapsed", Time.Span.to_yojson_hum time_elapsed)
       ; ( "bootstrap_stats"
         , `List (List.map ~f:bootstrap_cycle_stats_to_yojson cycles) )
       ] ;

src/lib/bootstrap_controller/bootstrap_controller.mli

@@ -23,7 +23,7 @@ type Structured_log_events.t += Bootstrap_complete [@@deriving register_event]
     it would return a transition frontier with the root breadcrumb and a list
     of transitions collected during bootstrap.
 
-    Bootstrap controller would do the following steps to contrust the
+    Bootstrap controller would do the following steps to construct the
     transition frontier:
     1. Download the root snarked_ledger.
     2. Download the scan state and pending coinbases.

src/lib/mina_stdlib/time.ml

@@ -1,4 +1,5 @@
 open Core_kernel
+include Core_kernel.Time
 
 module Span = struct
   [%%versioned
@@ -10,6 +11,9 @@ module Span = struct
       *)
       type t = Core_kernel.Time.Stable.Span.V3.t [@@deriving sexp]
 
+      let to_yojson_hum span =
+        `String (Printf.sprintf "%f seconds" (Time.Span.to_sec span))
+
       let to_yojson span = `Float (Time.Span.to_sec span)
 
       let of_yojson = function
@@ -22,7 +26,7 @@ module Span = struct
     end
   end]
 
-  [%%define_locally Stable.Latest.(to_yojson, of_yojson)]
+  [%%define_locally Stable.Latest.(to_yojson_hum, to_yojson, of_yojson)]
 
   include Core_kernel.Time.Span
 end