5b50279851
The new version of ocplib-resto : - uses jbuilder ; - is functorized over `Json_encoding` rather than `Json_repr` ; - handles query parameters ; - handles HTTP methods (GET, POST, DELETE, PUT, PATCH) ; - replaces `custom_service` by a more generic trailer argument ; - replaces generic answer `(code, body)` by a more ad-hoc sum type (allowing distinct encoding for success and error) ; - includes a minimal HTTP-server based on Cohttp (includings CORS and media type negotiation). - adds a function `Directory.transparent_lookup` to lookup/call a service handler without serializing the various parameters (path, query, request body). As a first consequences in Tezos, this patch allows binary communication between the client and the node. This patch tries to be minimal inside the tezos source code and therefore it introduces a minimal compatibility layer in `RPC.ml`. This code should be removed as soon as possible.
156 lines
5.3 KiB
OCaml
156 lines
5.3 KiB
OCaml
(**************************************************************************)
|
|
(* ocplib-resto *)
|
|
(* Copyright (C) 2016, OCamlPro. *)
|
|
(* *)
|
|
(* All rights reserved. This file is distributed under the terms *)
|
|
(* of the GNU Lesser General Public License version 2.1, with the *)
|
|
(* special exception on linking described in the file LICENSE. *)
|
|
(* *)
|
|
(**************************************************************************)
|
|
|
|
module Encoding = struct
|
|
|
|
include Json_encoding
|
|
type 'a t = 'a encoding
|
|
type schema = Json_schema.schema
|
|
|
|
module StringMap = Map.Make(String)
|
|
|
|
let arg_encoding =
|
|
let open Json_encoding in
|
|
conv
|
|
(fun {Resto.Arg.name; descr} -> (name, descr))
|
|
(fun (name, descr) -> {name; descr})
|
|
(obj2 (req "name" string) (opt "descr" string))
|
|
|
|
open Resto.Description
|
|
|
|
let meth_encoding =
|
|
Json_encoding.string_enum
|
|
[ "GET", `GET ;
|
|
"POST", `POST ;
|
|
"DELETE", `DELETE ;
|
|
"PUT", `PUT ;
|
|
"PATCH", `PATCH ]
|
|
|
|
let path_item_encoding =
|
|
let open Json_encoding in
|
|
union [
|
|
case string
|
|
(function PStatic s -> Some s | _ -> None)
|
|
(fun s -> PStatic s) ;
|
|
case arg_encoding
|
|
(function PDynamic s -> Some s | _ -> None)
|
|
(fun s -> PDynamic s) ;
|
|
]
|
|
|
|
let query_item_encoding =
|
|
let open Json_encoding in
|
|
conv
|
|
(fun {name ; description} -> (name, description))
|
|
(fun (name, description) -> {name ; description})
|
|
(obj2 (req "name" string) (opt "description" string))
|
|
|
|
let service_descr_encoding =
|
|
let open Json_encoding in
|
|
conv
|
|
(fun { meth ; path ; description ; query ; input ; output ; error } ->
|
|
(meth, path, description, query, input, output, error))
|
|
(fun (meth, path, description, query, input, output, error) ->
|
|
{ meth ; path ; description ; query ; input ; output ; error })
|
|
(obj7
|
|
(req "meth" meth_encoding)
|
|
(req "path" (list path_item_encoding))
|
|
(opt "description" string)
|
|
(req "query" (list query_item_encoding))
|
|
(opt "input" any_schema)
|
|
(req "output" any_schema)
|
|
(req "erro" any_schema))
|
|
|
|
let directory_descr_encoding =
|
|
let open Json_encoding in
|
|
mu "service_tree" @@ fun directory_descr_encoding ->
|
|
let static_subdirectories_descr_encoding =
|
|
union [
|
|
case (obj1 (req "suffixes"
|
|
(list (obj2 (req "name" string)
|
|
(req "tree" directory_descr_encoding)))))
|
|
(function Suffixes map ->
|
|
Some (Resto.StringMap.bindings map) | _ -> None)
|
|
(fun m ->
|
|
let add acc (n,t) = Resto.StringMap.add n t acc in
|
|
Suffixes (List.fold_left add Resto.StringMap.empty m)) ;
|
|
case (obj1 (req "dynamic_dispatch"
|
|
(obj2
|
|
(req "arg" arg_encoding)
|
|
(req "tree" directory_descr_encoding))))
|
|
(function Arg (ty, tree) -> Some (ty, tree) | _ -> None)
|
|
(fun (ty, tree) -> Arg (ty, tree))
|
|
] in
|
|
|
|
let static_directory_descr_encoding =
|
|
conv
|
|
(fun { services ; subdirs } ->
|
|
let find s =
|
|
try Some (Resto.MethMap.find s services) with Not_found -> None in
|
|
(find `GET, find `POST, find `DELETE,
|
|
find `PUT, find `PATCH, subdirs))
|
|
(fun (get, post, delete, put, patch, subdirs) ->
|
|
let add meth s services =
|
|
match s with
|
|
| None -> services
|
|
| Some s -> Resto.MethMap.add meth s services in
|
|
let services =
|
|
Resto.MethMap.empty
|
|
|> add `GET get
|
|
|> add `POST post
|
|
|> add `DELETE delete
|
|
|> add `PUT put
|
|
|> add `PATCH patch in
|
|
{ services ; subdirs })
|
|
(obj6
|
|
(opt "get_service" service_descr_encoding)
|
|
(opt "post_service" service_descr_encoding)
|
|
(opt "delete_service" service_descr_encoding)
|
|
(opt "put_service" service_descr_encoding)
|
|
(opt "patch_service" service_descr_encoding)
|
|
(opt "subdirs" static_subdirectories_descr_encoding)) in
|
|
union [
|
|
case (obj1 (req "static" static_directory_descr_encoding))
|
|
(function Static descr -> Some descr | _ -> None)
|
|
(fun descr -> Static descr) ;
|
|
case (obj1 (req "dynamic" (option string)))
|
|
(function Dynamic descr -> Some descr | _ -> None)
|
|
(fun descr -> Dynamic descr) ;
|
|
]
|
|
|
|
let description_request_encoding =
|
|
conv
|
|
(fun { recurse } -> recurse)
|
|
(function recurse -> { recurse })
|
|
(obj1 (dft "recursive" bool false))
|
|
|
|
let description_answer_encoding = directory_descr_encoding
|
|
|
|
end
|
|
|
|
module type VALUE = sig
|
|
type t
|
|
type 'a encoding
|
|
val construct: 'a encoding -> 'a -> t
|
|
val destruct: 'a encoding -> t -> 'a
|
|
end
|
|
|
|
module Ezjsonm = struct
|
|
type t = Json_repr.Ezjsonm.value
|
|
let construct = Json_encoding.construct
|
|
let destruct = Json_encoding.destruct
|
|
end
|
|
|
|
module Bson = struct
|
|
open Json_repr_bson
|
|
type t = Repr.value
|
|
let construct = Json_encoding.construct
|
|
let destruct = Json_encoding.destruct
|
|
end
|