refactor(Learnocaml_store): Move Json_codec (& 2 fcts) to Learnocaml_api

Motivation:
- Learnocaml_store contained Json_codec
- learnocaml_client.ml relies on Json_codec
- Learnocaml_store depends on Learnocaml_api
- Learnocaml_store pulls irmin-git.unix and cryptokit
  - unlike Learnocaml_api
  - and these two dependencies are unneeded for compiling learnocaml_client.ml

Author: erikmd

src/main/dune

@@ -43,7 +43,6 @@
             cohttp-lwt-unix
             grading_cli
             learnocaml_data
-	    learnocaml_store
             learnocaml_api)
 )
 (install

src/main/learnocaml_client.ml

@@ -452,7 +452,7 @@ let console_report ?(verbose=false) ex report =
   List.iter (fun i -> print_endline (format_item i)) report;
   print_newline ()
 
-module Api_client = Learnocaml_api.Client (Learnocaml_store.Json_codec)
+module Api_client = Learnocaml_api.Client (Learnocaml_api.Json_codec)
 
 let fetch server_url req =
   let url path args =

src/main/learnocaml_main.ml

@@ -451,13 +451,13 @@ let main o =
        Random.self_init ();
        Lwt.catch
          (fun () ->
-           Learnocaml_store.get_from_file ServerData.preconfig_enc server_config)
+           Learnocaml_api.get_from_file ServerData.preconfig_enc server_config)
          (function 
            | Unix.Unix_error (Unix.ENOENT, _, _) -> Lwt.return ServerData.empty_preconfig
            | exn -> Lwt.fail exn) 
        >>= fun preconfig ->
          let json_config = ServerData.build_config preconfig in
-         Learnocaml_store.write_to_file ServerData.config_enc json_config www_server_config
+         Learnocaml_api.write_to_file ServerData.config_enc json_config www_server_config
        >>= fun () ->
          if o.builder.Builder.base_url <> "" then
            Printf.printf "Base URL: %s\n%!" o.builder.Builder.base_url;

src/server/learnocaml_server.ml

@@ -754,7 +754,7 @@ module Request_handler = struct
 
 end
 
-module Api_server = Api.Server (Json_codec) (Request_handler)
+module Api_server = Api.Server (Api.Json_codec) (Request_handler)
 
 let init_teacher_token () =
   Token.Index.get () >>= function tokens ->

src/state/dune

@@ -33,6 +33,7 @@
  (libraries json-data-encoding
             ezjsonm
             conduit
+            lwt.unix
             learnocaml_data)
 )
 

src/state/learnocaml_api.ml

@@ -253,6 +253,34 @@ module type JSON_CODEC = sig
   val encode: ?minify:bool -> 'a J.encoding -> 'a -> string
 end
 
+(* Erik: Json_codec, get_from_file, write_to_file
+   were initially in learnocaml_store.ml, which induced unneeded dependencies:
+   learn-ocaml-client -> irmin-git.unix, cryptokit *)
+module Json_codec = struct
+  let decode enc s =
+    (match s with
+     | "" -> `O []
+     | s -> Ezjsonm.from_string s)
+    |> J.destruct enc
+
+  let encode ?minify enc x =
+    match J.construct enc x with
+    | `A _ | `O _ as json -> Ezjsonm.to_string ?minify json
+    | `Null -> ""
+    | _ -> assert false
+end
+
+let get_from_file enc p =
+  let open Lwt.Infix in
+  Lwt_io.(with_file ~mode: Input p read) >|=
+    Json_codec.decode enc
+
+let write_to_file enc s p =
+  let open Lwt.Infix in
+  let open Lwt_io in
+  let s = Json_codec.encode enc s in
+  with_file ~mode:output p @@ fun oc -> write oc s
+
 module Conversions (Json: JSON_CODEC) = struct
 
   let response_codec

src/state/learnocaml_api.mli

@@ -196,6 +196,11 @@ module type JSON_CODEC = sig
   val encode: ?minify:bool -> 'a Json_encoding.encoding -> 'a -> string
 end
 
+(** Used both for file i/o and request handling *)
+module Json_codec: JSON_CODEC
+val get_from_file : 'a Json_encoding.encoding -> string -> 'a Lwt.t
+val write_to_file : 'a Json_encoding.encoding -> 'a -> string -> unit Lwt.t
+
 module type REQUEST_HANDLER = sig
   type 'resp ret
 

src/state/learnocaml_store.ml

@@ -17,28 +17,6 @@ let sync_dir = ref (Filename.concat (Sys.getcwd ()) "sync")
 
 let data_dir = ref (Filename.concat !sync_dir "data")
 
-module Json_codec = struct
-  let decode enc s =
-    (match s with
-     | "" -> `O []
-     | s -> Ezjsonm.from_string s)
-    |> J.destruct enc
-
-  let encode ?minify enc x =
-    match J.construct enc x with
-    | `A _ | `O _ as json -> Ezjsonm.to_string ?minify json
-    | `Null -> ""
-    | _ -> assert false
-end
-let get_from_file enc p =
-  Lwt_io.(with_file ~mode: Input p read) >|=
-    Json_codec.decode enc
-
-let write_to_file enc s p =
-  let open Lwt_io in
-  let s = Json_codec.encode enc s in
-  with_file ~mode:output p @@ fun oc -> write oc s
-
 let sanitise_path prefix subpath =
   let rec resolve acc = function
     | [] -> List.rev acc
@@ -54,7 +32,7 @@ let sanitise_path prefix subpath =
 
 let read_static_file path enc =
   let path = String.split_on_char '/' path in
-  get_from_file enc (sanitise_path !static_dir path)
+  Learnocaml_api.get_from_file enc (sanitise_path !static_dir path)
 
 let with_git_register =
   let dir_mutex = Lwt_utils.gen_mutex_table () in
@@ -201,7 +179,7 @@ module Exercise = struct
     let tbl = lazy (
       let tbl = Hashtbl.create 223 in
       Lwt.catch (fun () ->
-          get_from_file (J.list enc) (store_file ()) >|= fun l ->
+          Learnocaml_api.get_from_file (J.list enc) (store_file ())>|= fun l ->
           List.iter (fun st -> Hashtbl.add tbl st.id st) l;
           tbl)
       @@ function
@@ -217,7 +195,7 @@ module Exercise = struct
     let save () =
       Lazy.force tbl >>= fun tbl ->
       let l = Hashtbl.fold (fun _ s acc -> s::acc) tbl [] in
-      let s = Json_codec.encode (J.list enc) l in
+      let s = Learnocaml_api.Json_codec.encode (J.list enc) l in
       write (store_file ()) s
 
     let get id =
@@ -472,7 +450,7 @@ module Save = struct
 
   let get token =
     Token.find_save token >>= function
-    | Some save -> get_from_file (J.option enc) save
+    | Some save -> Learnocaml_api.get_from_file (J.option enc) save
     | None -> Lwt.return_none
 
   let set token save =
@@ -503,7 +481,7 @@ module Save = struct
     in
     Lwt.catch (fun () ->
         write ~no_create:(Token.is_teacher token) ~extra file
-          (Json_codec.encode ~minify:false enc save))
+          (Learnocaml_api.Json_codec.encode ~minify:false enc save))
       (function
         | Not_found -> Lwt.fail_with "Unregistered teacher token"
         | e -> Lwt.fail e)
@@ -557,7 +535,7 @@ module Student = struct
 
     let load () =
       Lwt.catch
-        (fun () -> get_from_file store_enc (store_file ()))
+        (fun () -> Learnocaml_api.get_from_file store_enc (store_file ()))
         (function
           | Unix.Unix_error (Unix.ENOENT, _, _) -> Lwt.return Token.Map.empty
           | e -> Lwt.fail e)
@@ -566,7 +544,7 @@ module Student = struct
 
     let save () =
       Lazy.force map >>= fun map ->
-      let s = Json_codec.encode store_enc !map in
+      let s = Learnocaml_api.Json_codec.encode store_enc !map in
       write (store_file ()) s
 
     let get_student map token =

src/state/learnocaml_store.mli

@@ -19,11 +19,6 @@ val data_dir: string ref
 
 (** {2 Utility server-side conversion functions} *)
 
-(** Used both for file i/o and request handling *)
-module Json_codec: Learnocaml_api.JSON_CODEC
-val get_from_file : 'a Json_encoding.encoding -> string -> 'a Lwt.t
-val write_to_file : 'a Json_encoding.encoding -> 'a -> string -> unit Lwt.t
-
 (* [sanitise_path prefix subdir] simplifies "." and ".." references in [subdir],
    and returns the concatenation, but guaranteeing the result remains below
    [prefix] (not accounting for symlinks of course, this is purely syntaxical)