wip basic error response

This commit is contained in:
Swrup 2025-09-28 22:12:16 +02:00
parent 4cbf3c722c
commit 0549bb098a
4 changed files with 72 additions and 41 deletions

View file

@ -100,6 +100,9 @@ let is_supported_lang lang = Array.mem lang supported_lang_arr
let is_supported_ext ext = Array.mem ext supported_ext_arr let is_supported_ext ext = Array.mem ext supported_ext_arr
let is_supported_mimetype mime = Array.mem mime supported_mimetype_arr let is_supported_mimetype mime = Array.mem mime supported_mimetype_arr
(* todo
- put content in a matrix instead?
- better types to force valid params? *)
(* ! lang and mime must be supported *) (* ! lang and mime must be supported *)
let get_content ~lang ~mime t = let get_content ~lang ~mime t =
let etag = Headers_lib.Etag.to_raw_string (etag t) in let etag = Headers_lib.Etag.to_raw_string (etag t) in

View file

@ -1,6 +1,9 @@
let accept_header_value =
let s = Fmt.str "%a" Util.(pp_array pp_mime) Assets.supported_mimetype_arr in
s
let avail_languages_header_value = let avail_languages_header_value =
let pp_array = Fmt.array ~sep:(Fmt.any ", ") Fmt.string in let s = Fmt.str "%a" (Util.pp_array Fmt.string) Assets.supported_lang_arr in
let s = Fmt.str "%a" pp_array Assets.supported_lang_arr in
s s
let select_mimetype headers = let select_mimetype headers =
@ -9,7 +12,6 @@ let select_mimetype headers =
|> Cohttp.Accept.qsort |> Cohttp.Accept.qsort
|> List.filter_map (fun (_q, (m, _p)) -> Util.media_to_known_mimetype m) |> List.filter_map (fun (_q, (m, _p)) -> Util.media_to_known_mimetype m)
|> List.find_opt Assets.is_supported_mimetype |> List.find_opt Assets.is_supported_mimetype
|> Option.to_result ~none:"no acceptable mimetype"
let select_language headers = let select_language headers =
let accept_language = Vif.Headers.get headers "accept-language" in let accept_language = Vif.Headers.get headers "accept-language" in
@ -24,7 +26,7 @@ let select_language headers =
| [] -> assert false | [] -> assert false
| primary_tag :: _ -> primary_tag)) | primary_tag :: _ -> primary_tag))
|> List.find_opt Assets.is_supported_lang |> List.find_opt Assets.is_supported_lang
|> Option.to_result ~none:"no acceptable language" |> Option.value ~default:Config.default_lang
let select_encoding headers = let select_encoding headers =
Vif.Headers.get headers "accept-encoding" Vif.Headers.get headers "accept-encoding"

View file

@ -13,6 +13,29 @@
You should have received a copy of the GNU Affero General Public License You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>. *) along with this program. If not, see <https://www.gnu.org/licenses/>. *)
(* TODO *)
(* https://docs.taler.net/core/api-common.html#tsref-type-ErrorDetail *)
let error_detail ?hint status =
let _ = (hint, status) in
"{}"
module Respond_with = struct
open Vif.Response
open Syntax
let not_modified () =
let* () = empty in
respond `Not_modified
let unsupported_media_type req =
let body =
error_detail ~hint:"no acceptable mimetype" `Unsupported_media_type
in
let* () = with_string ?compression:None req body in
let* () = add ~field:"accept" Headers.accept_header_value in
respond `Unsupported_media_type
end
(* TODO check for mathcing ETAG with a middleware instead? *) (* TODO check for mathcing ETAG with a middleware instead? *)
(* /terms + /privacy (* /terms + /privacy
- try to find a response with an acceptable mime-type - try to find a response with an acceptable mime-type
@ -24,7 +47,7 @@
- When returning a full response (not a "304 Not Modified"), - When returning a full response (not a "304 Not Modified"),
include a "Avail-Languages" header: a comma-separated list of the languages available *) include a "Avail-Languages" header: a comma-separated list of the languages available *)
module Static = struct module Static = struct
let static kind req _server _env = let f kind req _server _env =
let get_ok = function let get_ok = function
| Error e -> Fmt.failwith "TODO handle me, %s" e | Error e -> Fmt.failwith "TODO handle me, %s" e
| Ok v -> v | Ok v -> v
@ -38,46 +61,45 @@ module Static = struct
Headers_lib.Etag.parse s |> get_ok |> Headers_lib.Etag.evaluate etag Headers_lib.Etag.parse s |> get_ok |> Headers_lib.Etag.evaluate etag
in in
match has_matching_etag with match has_matching_etag with
| true -> | true -> Respond_with.not_modified ()
let open Vif.Response.Syntax in | false -> (
let* () = Vif.Response.empty in match Headers.select_mimetype headers with
Vif.Response.respond `Not_modified | None -> Respond_with.unsupported_media_type req
| false -> | Some mime ->
let mime = Headers.select_mimetype headers |> get_ok in let lang = Headers.select_language headers in
let lang = Headers.select_language headers |> get_ok in
let compression = Headers.select_encoding headers in let compression = Headers.select_encoding headers in
let data = Assets.get_content ~mime ~lang kind in let data = Assets.get_content ~mime ~lang kind in
(* -- *) (* -- *)
let open Vif.Response.Syntax in let open Vif.Response in
let* () = Vif.Response.with_string ?compression req data in let open Syntax in
let* () = with_string ?compression req data in
let* () = let* () =
let etag_field_value = Headers_lib.Etag.to_field_value etag in let etag_field_value = Headers_lib.Etag.to_field_value etag in
Vif.Response.add ~field:"etag" etag_field_value add ~field:"etag" etag_field_value
in in
let* () = let* () =
(* todo: is it "taler-privacy-version" for /policy ? *) (* todo: is it "taler-privacy-version" for /policy ? *)
Vif.Response.add ~field:"taler-terms-version" add ~field:"taler-terms-version" Config.terms_legal_version
Config.terms_legal_version
in in
let* () = let* () =
Vif.Response.add ~field:"avail-languages" add ~field:"avail-languages" Headers.avail_languages_header_value
Headers.avail_languages_header_value
in in
let* () = let* () =
let content_type = Fmt.str "%s/%s" (fst mime) (snd mime) in let content_type = Fmt.str "%a" Util.pp_mime mime in
Vif.Response.add ~field:"content-type" content_type add ~field:"content-type" content_type
in in
Vif.Response.respond `OK respond `OK)
let terms = static Assets.Terms let terms = f Assets.Terms
let privacy = static Assets.Privacy let privacy = f Assets.Privacy
end end
let hello req _server _env = let hello req _server _env =
let open Vif.Response.Syntax in let open Vif.Response in
let* () = Vif.Response.with_string req "Hello~~\n" in let open Syntax in
let* () = Vif.Response.add ~field:"content-type" "text/plain" in let* () = with_string req "Hello~~\n" in
Vif.Response.respond `OK let* () = add ~field:"content-type" "text/plain" in
respond `OK
let routes = let routes =
let open Vif.Uri in let open Vif.Uri in

View file

@ -28,3 +28,7 @@ let extension_to_mimetype ext =
(fun (mime, ext') -> (fun (mime, ext') ->
match String.equal ext ext' with false -> None | true -> Some mime) match String.equal ext ext' with false -> None | true -> Some mime)
mimetype_ext_assoc mimetype_ext_assoc
(* -- pretty printers -- *)
let pp_mime fmt mime = Fmt.pf fmt "%s/%s" (fst mime) (snd mime)
let pp_array pp_item item = Fmt.array ~sep:(Fmt.any ", ") pp_item item