catala/compiler/plugins/json_schema.ml

(* This file is part of the Catala compiler, a specification language for tax
   and social benefits computation rules. Copyright (C) 2020 Inria,
   contributors: Emile Rolley <emile.rolley@tuta.io>, Louis Gesbert
   <louis.gesbert@inria.fr>.

   Licensed under the Apache License, Version 2.0 (the "License"); you may not
   use this file except in compliance with the License. You may obtain a copy of
   the License at

   http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
   License for the specific language governing permissions and limitations under
   the License. *)

(** Catala plugin for generating {{:https://json-schema.org} JSON schemas} used
    to build forms. *)

let name = "json_schema"
let extension = "_schema.json"

open Utils
open Lcalc.Ast
open Lcalc.Backends
open Lcalc.To_ocaml
module D = Dcalc.Ast

(** Contains all format functions used to format a Lcalc Catala program
    representation to a JSON schema describing the corresponding web form. *)
module To_json = struct
  let to_camel_case (s : string) : string =
    String.split_on_char '_' s
    |> (function
         | hd :: tl -> hd :: List.map String.capitalize_ascii tl | l -> l)
    |> String.concat ""

  let format_struct_field_name_camel_case
      (fmt : Format.formatter)
      (v : Dcalc.Ast.StructFieldName.t) : unit =
    let s =
      Format.asprintf "%a" Dcalc.Ast.StructFieldName.format_t v
      |> to_ascii |> to_lowercase |> avoid_keywords |> to_camel_case
    in
    Format.fprintf fmt "%s" s

  let rec find_scope_def (target_name : string) :
      ('m expr, 'm) D.scopes -> ('m expr, 'm) D.scope_def option = function
    | D.Nil -> None
    | D.ScopeDef scope_def ->
      let name =
        Format.asprintf "%a" D.ScopeName.format_t scope_def.scope_name
      in
      if name = target_name then Some scope_def
      else
        let _, next_scope = Bindlib.unbind scope_def.scope_next in
        find_scope_def target_name next_scope

  let fmt_tlit fmt (tlit : D.typ_lit) =
    match tlit with
    | TUnit -> Format.fprintf fmt "\"type\": \"null\",@\n\"default\": null"
    | TInt | TRat -> Format.fprintf fmt "\"type\": \"number\",@\n\"default\": 0"
    | TMoney ->
      Format.fprintf fmt
        "\"type\": \"number\",@\n\"minimum\": 0,@\n\"default\": 0"
    | TBool -> Format.fprintf fmt "\"type\": \"boolean\",@\n\"default\": false"
    | TDate -> Format.fprintf fmt "\"type\": \"string\",@\n\"format\": \"date\""
    | TDuration -> failwith "TODO: tlit duration"

  let rec fmt_type fmt (typ : D.marked_typ) =
    match Marked.unmark typ with
    | D.TLit tlit -> fmt_tlit fmt tlit
    | D.TTuple (_, Some sname) ->
      Format.fprintf fmt "\"$ref\": \"#/definitions/%a\"" format_struct_name
        sname
    | D.TEnum (_, ename) ->
      Format.fprintf fmt "\"$ref\": \"#/definitions/%a\"" format_enum_name ename
    | D.TArray t ->
      Format.fprintf fmt
        "\"type\": \"array\",@\n\
         \"default\": [],@\n\
         @[<hov 2>\"items\": {@\n\
         %a@]@\n\
         }"
        fmt_type t
    | _ -> ()

  let fmt_struct_properties
      (ctx : D.decl_ctx)
      (fmt : Format.formatter)
      (sname : D.StructName.t) =
    Format.fprintf fmt "%a"
      (Format.pp_print_list
         ~pp_sep:(fun fmt () -> Format.fprintf fmt ",@\n")
         (fun fmt (field_name, field_type) ->
           Format.fprintf fmt "@[<hov 2>\"%a\": {@\n%a@]@\n}"
             format_struct_field_name_camel_case field_name fmt_type field_type))
      (find_struct sname ctx)

  let fmt_definitions
      (ctx : D.decl_ctx)
      (fmt : Format.formatter)
      (scope_def : ('m expr, 'm) D.scope_def) =
    let get_name t =
      match Marked.unmark t with
      | D.TTuple (_, Some sname) ->
        Format.asprintf "%a" format_struct_name sname
      | D.TEnum (_, ename) -> Format.asprintf "%a" format_enum_name ename
      | _ -> failwith "unreachable: only structs and enums are collected."
    in
    let rec collect_required_type_defs_from_scope_input
        (input_struct : D.StructName.t) : D.marked_typ list =
      let rec collect (acc : D.marked_typ list) (t : D.marked_typ) :
          D.marked_typ list =
        match Marked.unmark t with
        | D.TTuple (_, Some s) ->
          (* Scope's input is a struct. *)
          (t :: acc) @ collect_required_type_defs_from_scope_input s
        | D.TEnum (ts, _) -> List.fold_left collect (t :: acc) ts
        | D.TArray t -> collect acc t
        | _ -> acc
      in
      find_struct input_struct ctx
      |> List.fold_left (fun acc (_, field_typ) -> collect acc field_typ) []
      |> List.sort_uniq (fun t t' -> String.compare (get_name t) (get_name t'))
    in
    let fmt_enum_properties fmt ename =
      let enum_def = find_enum ename ctx in
      Format.fprintf fmt
        "@[<hov 2>\"kind\": {@\n\
         \"type\": \"string\",@\n\
         @[<hov 2>\"anyOf\": [@\n\
         %a@]@\n\
         ]@]@\n\
         }@\n\
         },@\n\
         @[<hov 2>\"allOf\": [@\n\
         %a@]@\n\
         ]@]@\n\
         }"
        (Format.pp_print_list
           ~pp_sep:(fun fmt () -> Format.fprintf fmt ",@\n")
           (fun fmt (enum_cons, _) ->
             Format.fprintf fmt
               "@[<hov 2>{@\n\"type\": \"string\",@\n\"enum\": [\"%a\"]@]@\n}"
               format_enum_cons_name enum_cons))
        enum_def
        (Format.pp_print_list
           ~pp_sep:(fun fmt () -> Format.fprintf fmt ",@\n")
           (fun fmt (enum_cons, payload_type) ->
             Format.fprintf fmt
               "@[<hov 2>{@\n\
                @[<hov 2>\"if\": {@\n\
                @[<hov 2>\"properties\": {@\n\
                @[<hov 2>\"kind\": {@\n\
                \"const\": \"%a\"@]@\n\
                }@]@\n\
                }@]@\n\
                },@\n\
                @[<hov 2>\"then\": {@\n\
                @[<hov 2>\"properties\": {@\n\
                @[<hov 2>\"payload\": {@\n\
                %a@]@\n\
                }@]@\n\
                }@]@\n\
                }@]@\n\
                }"
               format_enum_cons_name enum_cons fmt_type payload_type))
        enum_def
    in

    Format.fprintf fmt "@\n%a"
      (Format.pp_print_list
         ~pp_sep:(fun fmt () -> Format.fprintf fmt ",@\n")
         (fun fmt typ ->
           match Marked.unmark typ with
           | D.TTuple (_, Some sname) ->
             Format.fprintf fmt
               "@[<hov 2>\"%a\": {@\n\
                \"type\": \"object\",@\n\
                @[<hov 2>\"properties\": {@\n\
                %a@]@\n\
                }@]@\n\
                }"
               format_struct_name sname
               (fmt_struct_properties ctx)
               sname
           | D.TEnum (_, ename) ->
             Format.fprintf fmt
               "@[<hov 2>\"%a\": {@\n\
                \"type\": \"object\",@\n\
                @[<hov 2>\"properties\": {@\n\
                %a@]@]@\n"
               format_enum_name ename fmt_enum_properties ename
           | _ -> ()))
      (collect_required_type_defs_from_scope_input
         scope_def.scope_body.scope_body_input_struct)

  let format_program
      (fmt : Format.formatter)
      (scope : string)
      (prgm : 'm Lcalc.Ast.program) =
    match find_scope_def scope prgm.scopes with
    | None -> Cli.error_print "Internal error: scope '%s' not found." scope
    | Some scope_def ->
      Cli.call_unstyled (fun _ ->
          Format.fprintf fmt
            "{@[<hov 2>@\n\
             \"type\": \"object\",@\n\
             \"@[<hov 2>definitions\": {%a@]@\n\
             },@\n\
             \"@[<hov 2>properties\": {@\n\
             %a@]@\n\
             }@]@\n\
             }"
            (fmt_definitions prgm.decl_ctx)
            scope_def
            (fmt_struct_properties prgm.decl_ctx)
            scope_def.scope_body.scope_body_input_struct)
end

let apply
    ~(source_file : Pos.input_file)
    ~(output_file : string option)
    ~(scope : string option)
    (prgm : 'm Lcalc.Ast.program)
    (type_ordering : Scopelang.Dependency.TVertex.t list) =
  ignore type_ordering;
  let output_file, with_formatter =
    File.get_formatter_of_out_channel ~source_file ~output_file ~ext:extension
      ()
  in
  match scope with
  | Some s ->
    with_formatter (fun fmt ->
        Cli.debug_print
          "Writing JSON schema corresponding to the scope '%s' to the file \
           %s..."
          s
          (Option.value ~default:"stdout" output_file);
        To_json.format_program fmt s prgm)
  | None -> Cli.error_print "A scope must be specified for the plugin: %s" name

let () = Driver.Plugin.register_lcalc ~name ~extension apply