text
stringlengths
0
601k
let description html = let preview_image = match og_description html with None -> description html | Some x -> Some x in match Option . map String . trim preview_image with | Some " " -> None | Some x -> Some x | None -> None
type t = { image : string option ; description : string option }
let all url = let html = Http_client . get_sync url |> Result . get_ok in { image = preview_image html ; description = description html }
let websocket_handler stream socket = let frames , push_frame = Lwt_stream . create ( ) in let message_is_binary = ref ` Binary in let frame ~ opcode ~ is_fin ~ len : _ payload = match opcode with | ` Connection_close -> push_frame ( Some ( ` Close , payload ) ) | ` Ping -> push_frame ( Some ( ` Ping , payload ) ) | ` Pong -> push_frame ( Some ( ` Pong , payload ) ) | ` Other _ -> push_frame ( Some ( ` Other , payload ) ) | ` Text -> message_is_binary := ` Text ; push_frame ( Some ( ` Data ( ` Text , is_fin ) , payload ) ) | ` Binary -> message_is_binary := ` Binary ; push_frame ( Some ( ` Data ( ` Binary , is_fin ) , payload ) ) | ` Continuation -> push_frame ( Some ( ` Data ( ! message_is_binary , is_fin ) , payload ) ) in let eof ( ) = push_frame None in let closed = ref false in let close_code = ref 1005 in let current_payload = ref None in let last_chunk = ref None in let first_chunk_received = ref false in let first_chunk = ref Bigstringaf . empty in let first_chunk_offset = ref 0 in let first_chunk_length = ref 0 in let rec drain_payload payload continuation = Websocketaf . Payload . schedule_read payload ~ on_read ( : fun buffer ~ off ~ len -> if not ! first_chunk_received then begin first_chunk := buffer ; first_chunk_offset := off ; first_chunk_length := len ; first_chunk_received := true end else ( ) ; drain_payload payload continuation ) ~ on_eof ( : fun ( ) -> let payload = ! first_chunk in let offset = ! first_chunk_offset in let length = ! first_chunk_length in first_chunk_received := false ; first_chunk := Bigstringaf . empty ; first_chunk_offset := 0 ; first_chunk_length := 0 ; continuation payload offset length ) in let rec read ~ data ~ flush ~ ping ~ pong ~ close ~ exn = if ! closed then close ! close_code else match ! current_payload with | None -> Lwt . on_success ( Lwt_stream . get frames ) begin function | None -> if not ! closed then begin closed := true ; close_code := 1005 end ; Websocketaf . Wsd . close socket ; close ! close_code | Some ( ` Close , payload ) -> drain_payload payload @@ fun buffer offset length -> let code = if length < 2 then 1005 else let high_byte = Char . code buffer . { offset } and low_byte = Char . code buffer . { offset + 1 } in high_byte lsl 8 lor low_byte in if not ! closed then close_code := code ; close ! close_code | Some ( ` Ping , payload ) -> drain_payload payload @@ ping | Some ( ` Pong , payload ) -> drain_payload payload @@ pong | Some ( ` Other , payload ) -> drain_payload payload @@ fun _buffer _offset length -> ignore length ; read ~ data ~ flush ~ ping ~ pong ~ close ~ exn | Some ( ` Data properties , payload ) -> current_payload := Some ( properties , payload ) ; read ~ data ~ flush ~ ping ~ pong ~ close ~ exn end | Some ( ( binary , fin ) , payload ) -> Websocketaf . Payload . schedule_read payload ~ on_read ( : fun buffer ~ off ~ len -> match ! last_chunk with | None -> last_chunk := Some ( buffer , off , len ) ; read ~ data ~ flush ~ ping ~ pong ~ close ~ exn | Some ( last_buffer , last_offset , last_length ) -> last_chunk := Some ( buffer , off , len ) ; let binary = binary = ` Binary in data last_buffer last_offset last_length binary false ) ~ on_eof ( : fun ( ) -> current_payload := None ; match ! last_chunk with | None -> read ~ data ~ flush ~ ping ~ pong ~ close ~ exn | Some ( last_buffer , last_offset , last_length ) -> last_chunk := None ; let binary = binary = ` Binary in data last_buffer last_offset last_length binary fin ) in let bytes_since_flush = ref 0 in let flush ~ close ok = bytes_since_flush := 0 ; if ! closed then close ! close_code else Websocketaf . Wsd . flushed socket ok in let close code = if not ! closed then begin Websocketaf . Wsd . close ~ code ( ` : Other code ) socket end in let abort _exn = close 1005 in let reader = Stream . reader ~ read ~ close ~ abort in Stream . forward reader stream ; let rec outgoing_loop ( ) = Stream . read stream ~ data ( : fun buffer offset length binary _fin -> let kind = if binary then ` Binary else ` Text in if ! closed then close ! close_code else begin Websocketaf . Wsd . schedule socket ~ kind buffer ~ off : offset ~ len : length ; bytes_since_flush := ! bytes_since_flush + length ; if ! bytes_since_flush >= 4096 then flush ~ close outgoing_loop else outgoing_loop ( ) end ) ~ flush ( : fun ( ) -> flush ~ close outgoing_loop ) ~ ping ( : fun _buffer _offset length -> if length > 125 then raise ( Failure " Ping payload cannot exceed 125 bytes " ) ; if ! closed then close ! close_code else begin Websocketaf . Wsd . send_ping socket ; outgoing_loop ( ) end ) ~ pong ( : fun _buffer _offset length -> if length > 125 then raise ( Failure " Pong payload cannot exceed 125 bytes " ) ; if ! closed then close ! close_code else begin Websocketaf . Wsd . send_pong socket ; outgoing_loop ( ) end ) ~ close ~ exn : abort in outgoing_loop ( ) ; Websocketaf . Server_connection . { frame ; eof }
let client_websocket_handler : Stream . stream -> Websocketaf . Wsd . t -> Websocketaf . Client_connection . input_handlers = Obj . magic websocket_handler
module Wsprotocol ( IO : Iteratees . Monad ) = struct module I = Iteratees . Iteratee ( IO ) open I type ' a t = ' a I . t let sanitize s = let result = Buffer . create ( String . length s ) in for i = 0 to String . length s - 1 do if ( String . unsafe_get s i >= ' \ 000 ' && String . unsafe_get s i <= ' \ 032 ' ) || String . unsafe_get s i = ' \ 127 ' then ( ) else Buffer . add_char result ( String . unsafe_get s i ) done ; Buffer . contents result let base64encode s = modify Base64 . encode_string s let base64decode s = let decode x = Base64 . decode_exn ( sanitize x ) in modify decode s let writer = I . writer let wsframe s = modify ( fun s -> let l = String . length s in if l < 126 then Printf . sprintf " % c % c % s " ( char_of_int 0x82 ) ( char_of_int l ) s else if l < 65535 then Printf . sprintf " % c % c % s % s " ( char_of_int 0x82 ) ( char_of_int 126 ) ( Helpers . marshal_int16 l ) s else Printf . sprintf " % c % c % s % s " ( char_of_int 0x82 ) ( char_of_int 127 ) ( Helpers . marshal_int32 ( Int32 . of_int l ) ) s ) s let wsframe_old s = modify ( fun s -> Printf . sprintf " \ x00 % s \ xff " s ) s let rec wsunframe x = let read_sz = read_int8 >>= fun sz -> return ( sz >= 128 , sz land 0x7f ) in let read_size sz = if sz < 126 then return sz else if sz = 126 then read_int16 else read_int32 >>= fun x -> return ( Int32 . to_int x ) in let read_mask has_mask = if has_mask then readn 4 else return " \ x00 \ x00 \ x00 \ x00 " in let rec inner acc s = match s with | IE_cont ( None , k ) -> read_int8 >>= fun op -> read_sz >>= fun ( has_mask , sz ) -> read_size sz >>= fun size -> read_mask has_mask >>= fun mask -> readn size >>= fun str -> let real_str = Helpers . unmask mask str in if op land 0x0f = 0x08 then return s else if not ( op land 0x80 = 0x80 ) then inner ( acc ^ real_str ) s else liftI ( IO . bind ( k ( Iteratees . Chunk ( acc ^ real_str ) ) ) ( fun ( i , _ ) -> IO . return ( wsunframe i ) ) ) | _ -> return s in inner " " x let rec wsunframe_old s = match s with | IE_cont ( None , k ) -> heads " \ x00 " >>= fun _ -> break ( ( = ) ' \ xff ' ) >>= fun str -> drop 1 >>= fun ( ) -> liftI ( IO . bind ( k ( Iteratees . Chunk str ) ) ( fun ( i , _ ) -> IO . return ( wsunframe_old i ) ) ) | _ -> return s end
module Async_IO = Websocket . Make ( Cohttp_async . Io )
let set_tcp_nodelay writer = let socket = Socket . of_fd ( Writer . fd writer ) Socket . Type . tcp in Socket . setopt socket Socket . Opt . nodelay true
let src = Logs . Src . create " websocket . async . client " ~ doc " : Websocket client for Async "
let client ( ? name = " websocket . client " ) ( ? extra_headers = Header . init ( ) ) ( ? random_string = Rng . init ( ) ) ? initialized ~ app_to_ws ~ ws_to_app ~ net_to_ws ~ ws_to_net uri = let drain_handshake r w = let nonce = Base64 . encode_exn ( random_string 16 ) in let headers = Header . add_list extra_headers [ ( " Upgrade " , " websocket " ) ; ( " Connection " , " Upgrade " ) ; ( " Sec - WebSocket - Key " , nonce ) ; ( " Sec - WebSocket - Version " , " 13 " ) ] in let req = Cohttp . Request . make ~ headers uri in Logs_async . debug ~ src ( fun m -> m " % a " Sexp . pp_hum Cohttp . Request . ( sexp_of_t req ) ) >>= fun ( ) -> Request . write ( fun _ -> Deferred . unit ) req w >>= fun ( ) -> Response . read r >>= function | ` Eof -> raise End_of_file | ` Invalid s -> failwith s | ` Ok response -> Logs_async . debug ~ src ( fun m -> m " % a " Sexp . pp_hum Cohttp . Response . ( sexp_of_t response ) ) >>= fun ( ) -> let status = Cohttp . Response . status response in let headers = Cohttp . Response . headers response in if Code . ( is_error @@ code_of_status status ) then Reader . contents r >>= fun msg -> Logs_async . err ~ src ( fun m -> m " % s " msg ) >>= fun ( ) -> failwith @@ " HTTP Error " ^ Code . ( string_of_status status ) else if Cohttp . Response . version response <> ` HTTP_1_1 then failwith " HTTP version error " else if status <> ` Switching_protocols then failwith @@ " status error " ^ Code . ( string_of_status status ) else if Header . ( get headers " upgrade " ) |> Option . map ~ f : String . lowercase <> Some " websocket " then failwith " upgrade error " else if not @@ upgrade_present headers then failwith " update not present " else if Header . get headers " sec - websocket - accept " <> Some ( nonce ^ websocket_uuid |> b64_encoded_sha1sum ) then failwith " accept error " else Deferred . unit in let run ( ) = drain_handshake net_to_ws ws_to_net >>= fun ( ) -> Option . iter initialized ~ f ( : fun ivar -> Ivar . fill ivar ( ) ) ; let read_frame = make_read_frame ~ mode ( : Client random_string ) net_to_ws ws_to_net in let buf = Buffer . create 128 in let rec forward_frames_to_app ws_to_app = read_frame ( ) >>= fun fr -> ( if not @@ Pipe . is_closed ws_to_app then Pipe . write ws_to_app fr else Deferred . unit ) >>= fun ( ) -> forward_frames_to_app ws_to_app in let forward_frames_to_net ws_to_net app_to_ws = Writer . transfer ws_to_net app_to_ws ( fun fr -> Buffer . clear buf ; write_frame_to_buf ~ mode ( : Client random_string ) buf fr ; let contents = Buffer . contents buf in Writer . write ws_to_net contents ) in Deferred . any_unit [ forward_frames_to_app ws_to_app ; forward_frames_to_net ws_to_net app_to_ws ; Deferred . all_unit Pipe . [ closed app_to_ws ; closed ws_to_app ] ] in let finally_f = lazy ( Pipe . close_read app_to_ws ; Pipe . close ws_to_app ) in Monitor . try_with_or_error ~ name run >>| fun res -> Lazy . force finally_f ; res
let client_ez ? opcode ( ? name = " websocket . client_ez " ) ? extra_headers ? heartbeat ? random_string uri net_to_ws ws_to_net = let app_to_ws , reactor_write = Pipe . create ( ) in let to_reactor_write , client_write = Pipe . create ( ) in let client_read , ws_to_app = Pipe . create ( ) in let initialized = Ivar . create ( ) in let initialized_d = Ivar . read initialized in let last_pong = ref @@ Time_ns . epoch in let cleanup = lazy ( Pipe . close ws_to_app ; Pipe . close_read app_to_ws ; Pipe . close_read to_reactor_write ; Pipe . close client_write ) in let send_ping w span = let now = Time_ns . now ( ) in Logs_async . debug ~ src ( fun m -> m " -> PING " ) >>= fun ( ) -> Pipe . write w @@ Frame . create ~ opcode : Frame . Opcode . Ping ~ content ( : Time_ns . to_string_fix_proto ` Utc now ) ( ) >>| fun ( ) -> let time_since_last_pong = Time_ns . diff now ! last_pong in if ! last_pong > Time_ns . epoch && Time_ns . Span . ( time_since_last_pong > span + span ) then Lazy . force cleanup in let react w fr = let open Frame in Logs_async . debug ~ src ( fun m -> m " <- % a " Frame . pp fr ) >>= fun ( ) -> match fr . opcode with | Opcode . Ping -> Pipe . write w @@ Frame . create ~ opcode : Opcode . Pong ( ) >>| fun ( ) -> None | Opcode . Close -> ( if String . length fr . content >= 2 then Pipe . write w @@ Frame . create ~ opcode : Opcode . Close ~ content ( : String . sub fr . content ~ pos : 0 ~ len : 2 ) ( ) else Pipe . write w @@ Frame . close 1000 ) >>| fun ( ) -> Pipe . close w ; None | Opcode . Pong -> last_pong := Time_ns . now ( ) ; return None | Opcode . Text | Opcode . Binary -> return @@ Some fr . content | _ -> Pipe . write w @@ Frame . close 1002 >>| fun ( ) -> Pipe . close w ; None in let client_read = Pipe . filter_map ' client_read ~ f ( : react reactor_write ) in let react ( ) = initialized_d >>= fun ( ) -> Pipe . transfer to_reactor_write reactor_write ~ f ( : fun content -> Frame . create ? opcode ~ content ( ) ) in don ' t_wait_for ( match heartbeat with | None -> Deferred . unit | Some span -> initialized_d >>| fun ( ) -> Clock_ns . run_at_intervals ' ~ continue_on_error : false ~ stop ( : Pipe . closed reactor_write ) span ( fun ( ) -> send_ping reactor_write span ) ) ; don ' t_wait_for ( Monitor . protect ~ finally ( : fun ( ) -> Lazy . force cleanup ; Deferred . unit ) ( fun ( ) -> Deferred . any_unit [ client ~ name ? extra_headers ? random_string ~ initialized ~ app_to_ws ~ ws_to_app ~ net_to_ws ~ ws_to_net uri |> Deferred . ignore_m ; react ( ) ; Deferred . all_unit Pipe . [ closed client_read ; closed client_write ] ] ) ) ; ( client_read , client_write )
let src = Logs . Src . create " websocket . async . server " ~ doc " : Websocket server for Async "
let server ( ? name = " websocket . server " ) ( ? check_request = fun _ -> Deferred . return true ) ( ? select_protocol = fun _ -> None ) ~ reader ~ writer ~ app_to_ws ~ ws_to_app ( ) = let handshake r w = Request . read r >>= ( function | ` Ok r -> Deferred . return r | ` Eof -> Logs_async . info ~ src ( fun m -> m " Remote endpoint closed connection " ) >>= fun ( ) -> raise End_of_file | ` Invalid reason -> Logs_async . info ~ src ( fun m -> m " Invalid input from remote endpoint : % s " reason ) >>= fun ( ) -> failwith reason ) >>= fun request -> check_request request >>= ( function | true -> Deferred . unit | false -> let body = " 403 Forbidden " in let response = Cohttp . Response . make ~ status ` : Forbidden ( ) ~ encoding : ( Cohttp . Transfer . Fixed ( String . length body |> Int64 . of_int ) ) in let open Response in write ~ flush : true ( fun w -> write_body w body ) response w >>= fun ( ) -> raise Exit ) >>= fun ( ) -> let meth = Cohttp . Request . meth request in let version = Cohttp . Request . version request in let headers = Cohttp . Request . headers request in if not ( version = ` HTTP_1_1 && meth = ` GET && Option . map ( Header . get headers " upgrade " ) ~ f : String . lowercase = Some " websocket " && upgrade_present headers ) then failwith " Protocol error " ; let key = Option . value_exn ~ message " : missing sec - websocket - key " ( Header . get headers " sec - websocket - key " ) in let hash = key ^ websocket_uuid |> b64_encoded_sha1sum in let subprotocol = Option . value_map ( Header . get headers " sec - websocket - protocol " ) ~ default [ ] : ~ f ( : fun p -> Option . value_map ( select_protocol p ) ~ default [ ] : ~ f ( : fun selected -> [ ( " Sec - WebSocket - Protocol " , selected ) ] ) ) in let response_headers = ( " Upgrade " , " websocket " ) :: ( " Connection " , " Upgrade " ) :: ( " Sec - WebSocket - Accept " , hash ) :: subprotocol in let response = Cohttp . Response . make ~ status ` : Switching_protocols ~ encoding : Transfer . Unknown ~ headers ( : Header . of_list response_headers ) ( ) in Response . write ( fun _ -> Deferred . unit ) response w in Monitor . try_with_or_error ~ name ~ extract_exn : true ( fun ( ) -> handshake reader writer ) |> Deferred . Or_error . bind ~ f ( : fun ( ) -> set_tcp_nodelay writer ; let read_frame = make_read_frame ~ mode : Server reader writer in let rec loop ( ) = read_frame ( ) >>= Pipe . write ws_to_app >>= loop in let transfer_end = let buf = Buffer . create 128 in Pipe . transfer app_to_ws Writer . ( pipe writer ) ~ f ( : fun fr -> Buffer . clear buf ; write_frame_to_buf ~ mode : Server buf fr ; Buffer . contents buf ) in Monitor . protect ~ finally ( : fun ( ) -> Pipe . close ws_to_app ; Pipe . close_read app_to_ws ; Deferred . unit ) ( fun ( ) -> Deferred . any [ transfer_end ; loop ( ) ; Pipe . closed ws_to_app ; Pipe . closed app_to_ws ] ) >>= Deferred . Or_error . return )
let upgrade_connection ( ? select_protocol = fun _ -> None ) ( ? ping_interval = Time_ns . Span . of_int_sec 50 ) ~ app_to_ws ~ ws_to_app ~ f request = let headers = Cohttp . Request . headers request in let key = Option . value_exn ~ message " : missing sec - websocket - key " ( Header . get headers " sec - websocket - key " ) in let hash = key ^ websocket_uuid |> b64_encoded_sha1sum in let subprotocol = Option . value_map ( Header . get headers " sec - websocket - protocol " ) ~ default [ ] : ~ f ( : fun p -> Option . value_map ( select_protocol p ) ~ default [ ] : ~ f ( : fun selected -> [ ( " Sec - WebSocket - Protocol " , selected ) ] ) ) in let response_headers = ( " Upgrade " , " websocket " ) :: ( " Connection " , " Upgrade " ) :: ( " Sec - WebSocket - Accept " , hash ) :: subprotocol in let response = Cohttp . Response . make ~ status ` : Switching_protocols ~ encoding : Transfer . Unknown ~ headers ( : Header . of_list response_headers ) ( ) in let handler reader writer = let read_frame = make_read_frame ~ mode : Server reader writer in let rec loop ( ) = try_with read_frame >>= function | Error _ -> Deferred . unit | Ok frame -> Pipe . write ws_to_app frame >>= loop in let buf = Buffer . create 128 in let frame_to_string fr = Buffer . clear buf ; write_frame_to_buf ~ mode : Server buf fr ; Buffer . contents buf in let ping ( ) = if Time_ns . Span . ( ping_interval = zero ) then Deferred . never ( ) else let ping_frame_string = frame_to_string Frame . ( create ~ opcode : Opcode . Ping ( ) ) in let rec ping_loop ( ) = Clock_ns . after ping_interval >>= fun ( ) -> match Writer . is_closed writer with | true -> Deferred . unit | false -> Writer . write writer ping_frame_string ; ping_loop ( ) in ping_loop ( ) in let transfer_end ( ) = Pipe . transfer app_to_ws Writer . ( pipe writer ) ~ f : frame_to_string in let finally ( ) = Pipe . close ws_to_app ; Pipe . close_read app_to_ws ; Deferred . unit in Monitor . protect ~ finally ( fun ( ) -> set_tcp_nodelay writer ; Deferred . all_unit [ Deferred . any [ transfer_end ( ) ; loop ( ) ; ping ( ) ; Pipe . closed ws_to_app ; Pipe . closed app_to_ws ] ; f ( ) ] ) in ( response , handler )
module Lwt_IO = Websocket . Make ( Cohttp_lwt_unix . IO )
let send_frames stream oc = let buf = Buffer . create 128 in let send_frame fr = Buffer . clear buf ; Lwt_IO . write_frame_to_buf ~ mode : Server buf fr ; Lwt_io . write oc @@ Buffer . contents buf in Lwt_stream . iter_s send_frame stream
let read_frames ic oc handler_fn = let read_frame = Lwt_IO . make_read_frame ~ mode : Server ic oc in let rec inner ( ) = read_frame ( ) >>= Lwt . wrap1 handler_fn >>= inner in inner ( )
let upgrade_connection request incoming_handler = let headers = Cohttp . Request . headers request in ( match Cohttp . Header . get headers " sec - websocket - key " with | None -> Lwt . fail_invalid_arg " upgrade_connection : missing header ` sec - websocket - key ` " | Some key -> Lwt . return key ) >>= fun key -> let hash = b64_encoded_sha1sum ( key ^ websocket_uuid ) in let response_headers = Cohttp . Header . of_list [ ( " Upgrade " , " websocket " ) ; ( " Connection " , " Upgrade " ) ; ( " Sec - WebSocket - Accept " , hash ) ] in let resp = Cohttp . Response . make ~ status ` : Switching_protocols ~ encoding : Cohttp . Transfer . Unknown ~ headers : response_headers ~ flush : true ( ) in let frames_out_stream , frames_out_fn = Lwt_stream . create ( ) in let f ic oc = Lwt . pick [ read_frames ic oc incoming_handler ; send_frames frames_out_stream oc ] in Lwt . return ( ` Expert ( resp , f ) , frames_out_fn )
module Make ( IO : Graphql_intf . IO ) ( Ws : Graphql_websocket . Connection . S with type ' a IO . t = ' a IO . t ) = struct module Json = Yojson . Basic . Util let ( >>= ) = IO . bind type t = { conn : Ws . t ; subscriptions : ( string , unit -> unit ) Hashtbl . t } type client_message = | Gql_connection_init | Gql_start of { id : string ; query : string ; variables : ( string * Graphql_parser . const_value ) list option ; operation_name : string option ; } | Gql_stop of { id : string } | Gql_connection_terminate type server_message = | Gql_connection_error | Gql_connection_ack | Gql_data | Gql_error | Gql_complete let client_message_of_payload msg = match msg |> Json . member " type " |> Json . to_string_option with | Some " connection_init " -> Ok Gql_connection_init | Some " start " -> let id = Json . ( msg |> member " id " |> to_string ) in let payload = Json . member " payload " msg in let query = Json . ( payload |> member " query " |> to_string ) in let variables = Json . ( payload |> member " variables " |> to_option to_assoc ) in let variables = ( variables :> ( string * Graphql_parser . const_value ) list option ) in let operation_name = Json . ( payload |> member " operationName " |> to_string_option ) in Ok ( Gql_start { id ; query ; variables ; operation_name } ) | Some " stop " -> let id = Json . ( member " id " msg |> to_string ) in Ok ( Gql_stop { id } ) | Some " connection_terminate " -> Ok Gql_connection_terminate | Some typ -> Error ( Format . sprintf " Unknown message type ` % s ` " typ ) | None -> Error ( Format . sprintf " Missing message type " ) let server_message_to_string = function | Gql_connection_error -> " connection_error " | Gql_connection_ack -> " connection_ack " | Gql_data -> " data " | Gql_error -> " error " | Gql_complete -> " complete " let create_message ( ? opcode = Graphql_websocket . Frame . Opcode . Text ) ? id ( ? payload = ` Null ) typ = let frame_payload = ` Assoc [ ( " type " , ` String ( server_message_to_string typ ) ) ; ( " id " , match id with Some id -> ` String id | None -> ` Null ) ; ( " payload " , payload ) ; ] in let content = Yojson . Basic . to_string frame_payload in Graphql_websocket . Frame . create ~ opcode ~ content ( ) let handle_frame t ~ execute_query frame = match frame . Graphql_websocket . Frame . opcode with | Ping | Pong | Close | Ctrl _ | Nonctrl _ -> IO . return ( ) | Continuation | Text | Binary -> ( let json = Yojson . Basic . from_string frame . Graphql_websocket . Frame . content in match client_message_of_payload json with | Ok Gql_connection_init -> Ws . send t . conn ( create_message Gql_connection_ack ) | Ok ( Gql_start { id ; query ; variables ; operation_name } ) -> ( execute_query variables operation_name query >>= function | Error message -> let payload = ` Assoc [ ( " message " , message ) ] in Ws . send t . conn ( create_message ~ payload ~ id Gql_error ) | Ok ( ` Response payload ) -> Ws . send t . conn ( create_message ~ id ~ payload Gql_data ) | Ok ( ` Stream stream ) -> let close ( ) = IO . Stream . close stream in Hashtbl . add t . subscriptions id close ; IO . Stream . iter stream ( fun response -> let ( Ok payload | Error payload ) = response in Ws . send t . conn ( create_message ~ id ~ payload Gql_data ) ) >>= fun ( ) -> Ws . send t . conn ( create_message ~ id Gql_complete ) ) | Ok ( Gql_stop { id } ) -> ( try let close = Hashtbl . find t . subscriptions id in close ( ) with Not_found -> ( ) ) ; IO . return ( ) | Ok Gql_connection_terminate -> Hashtbl . iter ( fun _id close -> close ( ) ) t . subscriptions ; Ws . send t . conn ( create_message ~ opcode : Graphql_websocket . Frame . Opcode . Close Gql_connection_error ) | Error msg -> let id = Json . ( json |> member " id " |> to_string ) in let payload = ` Assoc [ ( " message " , ` String msg ) ] in Ws . send t . conn ( create_message ~ id ~ payload Gql_error ) ) let handle execute_query conn = let subscriptions = Hashtbl . create 8 in let t = { conn ; subscriptions } in let rec loop ( ) = Ws . recv conn >>= fun frame -> handle_frame t ~ execute_query frame >>= fun ( ) -> loop ( ) in loop ( ) end
let section = Lwt_log . Section . make " websocket_lwt_unix "
let http_error msg = Lwt . fail ( HTTP_Error msg )
let protocol_error msg = Lwt . fail ( Protocol_error msg )
let set_tcp_nodelay flow = let open Conduit_lwt_unix in match flow with | TCP { fd ; _ } -> Lwt_unix . setsockopt fd Lwt_unix . TCP_NODELAY true | _ -> ( )
let fail_unless eq f = if not eq then f ( ) else Lwt . return_unit
let fail_if eq f = if eq then f ( ) else Lwt . return_unit
let drain_handshake req ic oc nonce = Request . write ( fun _writer -> Lwt . return ( ) ) req oc >>= fun ( ) -> Response . read ic >>= ( function | ` Ok r -> Lwt . return r | ` Eof -> Lwt . fail End_of_file | ` Invalid s -> Lwt . fail @@ Failure s ) >>= fun response -> let open Cohttp in let status = Response . status response in let headers = Response . headers response in fail_if Code . ( is_error @@ code_of_status status ) ( fun ( ) -> http_error Code . ( string_of_status status ) ) >>= fun ( ) -> fail_unless ( Response . version response = ` HTTP_1_1 ) ( fun ( ) -> protocol_error " wrong http version " ) >>= fun ( ) -> fail_unless ( status = ` Switching_protocols ) ( fun ( ) -> protocol_error " wrong status " ) >>= fun ( ) -> ( match Header . get headers " upgrade " with | Some a when String . Ascii . lowercase a = " websocket " -> Lwt . return_unit | _ -> protocol_error " wrong upgrade " ) >>= fun ( ) -> fail_unless ( upgrade_present headers ) ( fun ( ) -> protocol_error " upgrade header not present " ) >>= fun ( ) -> match Header . get headers " sec - websocket - accept " with | Some accept when accept = b64_encoded_sha1sum ( nonce ^ websocket_uuid ) -> Lwt . return_unit | _ -> protocol_error " wrong accept "
let connect ctx client url nonce extra_headers = let open Cohttp in let headers = Header . add_list extra_headers [ ( " Upgrade " , " websocket " ) ; ( " Connection " , " Upgrade " ) ; ( " Sec - WebSocket - Key " , nonce ) ; ( " Sec - WebSocket - Version " , " 13 " ) ] in let req = Request . make ~ headers url in Conduit_lwt_unix . connect ~ ctx client >>= fun ( flow , ic , oc ) -> set_tcp_nodelay flow ; Lwt . catch ( fun ( ) -> drain_handshake req ic oc nonce ) ( fun exn -> Lwt_io . close ic >>= fun ( ) -> Lwt . fail exn ) >>= fun ( ) -> Lwt_log . info_f ~ section " Connected to % s " ( Uri . to_string url ) >>= fun ( ) -> Lwt . return ( ic , oc )
type conn = { read_frame : unit -> Frame . t Lwt . t ; write_frame : Websocket . Frame . t -> unit Lwt . t ; oc : Lwt_io . output_channel }
let read { read_frame ; _ } = read_frame ( )
let write { write_frame ; _ } frame = write_frame frame
let close_transport { oc ; _ } = Lwt_io . close oc
let connect ( ? extra_headers = Cohttp . Header . init ( ) ) ( ? random_string = Websocket . Rng . init ( ) ) ( ? ctx = Lazy . force Conduit_lwt_unix . default_ctx ) ? buf client url = let nonce = Base64 . encode_exn ( random_string 16 ) in connect ctx client url nonce extra_headers >|= fun ( ic , oc ) -> let read_frame = make_read_frame ? buf ~ mode ( : Client random_string ) ic oc in let read_frame ( ) = Lwt . catch read_frame ( fun exn -> Lwt . async ( fun ( ) -> Lwt_io . close ic ) ; Lwt . fail exn ) in let buf = Buffer . create 128 in let write_frame frame = Buffer . clear buf ; Lwt . wrap2 ( write_frame_to_buf ~ mode ( : Client random_string ) ) buf frame >>= fun ( ) -> Lwt . catch ( fun ( ) -> Lwt_io . write oc ( Buffer . contents buf ) ) ( fun exn -> Lwt . async ( fun ( ) -> Lwt_io . close oc ) ; Lwt . fail exn ) in { read_frame ; write_frame ; oc }
let write_failed_response oc = let body = " 403 Forbidden " in let body_len = String . length body |> Int64 . of_int in let response = Cohttp . Response . make ~ status ` : Forbidden ~ encoding ( : Cohttp . Transfer . Fixed body_len ) ( ) in let open Response in write ~ flush : true ( fun writer -> write_body writer body ) response oc
let server_fun ? read_buf ? write_buf check_request flow ic oc react = let read = function | ` Ok r -> Lwt . return r | ` Eof -> Lwt_log . info ~ section " Remote endpoint closed connection " >>= fun ( ) -> Lwt . fail End_of_file | ` Invalid reason -> Lwt_log . info_f ~ section " Invalid input from remote endpoint : % s " reason >>= fun ( ) -> Lwt . fail @@ HTTP_Error reason in Request . read ic >>= read >>= fun request -> let meth = Cohttp . Request . meth request in let version = Cohttp . Request . version request in let headers = Cohttp . Request . headers request in let key = Cohttp . Header . get headers " sec - websocket - key " in ( match ( version , meth , Cohttp . Header . get headers " upgrade " , key , upgrade_present headers , check_request request ) with | ` HTTP_1_1 , ` GET , Some up , Some key , true , true when String . Ascii . lowercase up = " websocket " -> Lwt . return key | _ -> write_failed_response oc >>= fun ( ) -> Lwt . fail ( Protocol_error " Bad headers " ) ) >>= fun key -> let hash = key ^ websocket_uuid |> b64_encoded_sha1sum in let response_headers = Cohttp . Header . of_list [ ( " Upgrade " , " websocket " ) ; ( " Connection " , " Upgrade " ) ; ( " Sec - WebSocket - Accept " , hash ) ] in let response = Cohttp . Response . make ~ status ` : Switching_protocols ~ encoding : Cohttp . Transfer . Unknown ~ headers : response_headers ( ) in Response . write ( fun _writer -> Lwt . return_unit ) response oc >>= fun ( ) -> let client = Connected_client . create ? read_buf ? write_buf request flow ic oc in react client
let establish_server ? read_buf ? write_buf ? timeout ? stop ( ? on_exn = fun exn -> ! Lwt . async_exception_hook exn ) ( ? check_request = check_origin_with_host ) ( ? ctx = Lazy . force Conduit_lwt_unix . default_ctx ) ~ mode react = let module C = Cohttp in Conduit_lwt_unix . serve ~ on_exn ? timeout ? stop ~ ctx ~ mode ( fun flow ic oc -> set_tcp_nodelay flow ; Lwt . catch ( fun ( ) -> server_fun ? read_buf ? write_buf check_request ( Conduit_lwt_unix . endp_of_flow flow ) ic oc react ) ( function | End_of_file -> Lwt . return_unit | HTTP_Error _ -> Lwt . return_unit | exn -> Lwt . fail exn ) )
let mk_frame_stream recv = let f ( ) = recv ( ) >>= fun fr -> match fr . Frame . opcode with | Frame . Opcode . Close -> Lwt . return_none | _ -> Lwt . return ( Some fr ) in Lwt_stream . from f
let establish_standard_server ? read_buf ? write_buf ? timeout ? stop ? on_exn ? check_request ( ? ctx = Lazy . force Conduit_lwt_unix . default_ctx ) ~ mode react = let f client = react ( Connected_client . make_standard client ) in establish_server ? read_buf ? write_buf ? timeout ? stop ? on_exn ? check_request ~ ctx ~ mode f
module Suite = struct exception TestFailure of string type result = | Error of exn | Fail of string | Pass type outcome = { label : string ; result : result ; time_s : float ; } let string_of_result = function | Error e -> Printf . sprintf " Error : % s " ( Printexc . to_string e ) | Fail msg -> Printf . sprintf " Fail : % s " msg | Pass -> " Pass " let finally f cleanup = let result = try f ( ) with e -> cleanup ( ) ; raise e in cleanup ( ) ; result module Sync = struct type test_fun = unit -> unit let bracket setup test teardown ( ) = let state = setup ( ) in finally ( fun ( ) -> test state ) ( fun ( ) -> teardown state ) end module Async = struct type callback = unit -> unit let noop ( ) = ( ) type wrapper = callback -> unit type test_fun = wrapper -> unit let bracket setup test teardown = ( fun wrapper -> let state = setup ( ) in let wrapper ' f = wrapper ( fun ( ) -> finally f ( fun ( ) -> teardown state ) ) in try test state wrapper ' with e -> teardown state ; raise e ) let run_one label test log handle_outcome = let handled = ref false in let start_time = ref 0 . 0 in let handle_result_once result = if not ! handled then begin handled := true ; log " End " ; log ( string_of_result result ) ; handle_outcome { label ; result ; time_s = Sys . time ( ) . - ! start_time } end in let catch_all f = try f ( ) with | TestFailure msg -> handle_result_once ( Fail msg ) | e -> handle_result_once ( Error e ) in catch_all ( fun ( ) -> log " Start " ; start_time := Sys . time ( ) ; test ( fun callback -> catch_all ( fun ( ) -> callback ( ) ; handle_result_once Pass ) ) ) let of_sync test wrapper = test ( ) ; wrapper noop end type t = | TestCase of string * Async . test_fun | TestList of string * t list let ( ) >:: label test_fun = TestCase ( label , Async . of_sync test_fun ) let ( ) >:~ label test_fun = TestCase ( label , test_fun ) let ( ) >::: label tests = TestList ( label , tests ) let string_of_opt = function | Some value -> Printf . sprintf " ( % s ) " value | None -> " " let assert_true ? label value = if not value then begin let msg = Printf . sprintf " test value was false % s " ( string_of_opt label ) in raise ( TestFailure msg ) end let assert_equal ( ? equal = ( ) ) = ? label ? printer a b = if not ( equal a b ) then begin let values = match printer with | Some printer -> Printf . sprintf " : % s % s " ( printer a ) ( printer b ) | None -> " " in let msg = Printf . sprintf " not equal % s % s " ( string_of_opt label ) values in raise ( TestFailure msg ) end let assert_raises ? label expected_exn task = match try task ( ) ; None with raised_exn -> Some raised_exn with | None -> let msg = Printf . sprintf " expected exception not raised % s " ( string_of_opt label ) in raise ( TestFailure msg ) | Some raised_exn when raised_exn = expected_exn -> ( ) | Some raised_exn -> let msg = Printf . sprintf " unexpected exception raised % s : % s " ( string_of_opt label ) ( Printexc . to_string raised_exn ) in raise ( TestFailure msg ) let assert_raises_string ? label expected_exn_string task = match try task ( ) ; None with raised_exn -> Some raised_exn with | None -> let msg = Printf . sprintf " expected exception not raised % s " ( string_of_opt label ) in raise ( TestFailure msg ) | Some raised_exn when ( Printexc . to_string raised_exn ) = expected_exn_string -> ( ) | Some raised_exn -> let msg = Printf . sprintf " unexpected exception raised % s : % s " ( string_of_opt label ) ( Printexc . to_string raised_exn ) in raise ( TestFailure msg ) end
module Zipper = struct type crumb = { left : Suite . t list ; label : string ; right : Suite . t list ; } type t = { crumbs : crumb list ; location : Suite . t ; } let of_suite suite = { crumbs = [ ] ; location = suite ; } let to_suite { location ; _ } = location let move_up { crumbs ; location } = match crumbs with | [ ] -> None | { left ; label ; right } :: other_crumbs -> Some { crumbs = other_crumbs ; location = Suite . TestList ( label , List . rev_append ( location :: left ) right ) ; } let move_down { crumbs ; location } = match location with | Suite . TestCase _ -> None | Suite . TestList ( _ , [ ] ) -> None | Suite . TestList ( label , first_child :: other_children ) -> Some { crumbs = { left = [ ] ; label ; right = other_children ; } :: crumbs ; location = first_child ; } let move_right { crumbs ; location } = match crumbs with | [ ] -> None | { right = [ ] ; _ } :: _ -> None | { left ; label ; right = first_right :: other_right } :: other_crumbs -> Some { crumbs = { left = location :: left ; label ; right = other_right ; } :: other_crumbs ; location = first_right ; } let rec next_sibling zipper = match move_right zipper with | ( Some _ ) as result -> result | None -> begin match move_up zipper with | Some zipper ' -> next_sibling zipper ' | None -> None end let next_location zipper = match move_down zipper with | Some _ as result -> result | None -> next_sibling zipper let get_labels { crumbs ; location } = let location_label = match location with | Suite . TestCase ( label , _ ) -> label | Suite . TestList ( label , _ ) -> label in location_label :: ( List . map ( fun crumb -> crumb . label ) crumbs ) |> List . rev end
module Utils = struct type output = { log : string list ; outcomes : Suite . outcome list ; } type raw_summary = { total : int ; errors : int ; failures : int ; passes : int ; passed : bool } type summary = { report : string ; passed : bool ; } let run suite callback = let log = ref [ ] in let log_with_prefix prefix msg = let line = Printf . sprintf " % s :% s " prefix msg in log := ( line :: ! log ) in let zipper = Zipper . of_suite suite in let rec run ' ( { Zipper . location ; _ } as zipper ) outcomes = let continue zipper outcomes ' = match Zipper . next_location zipper with | Some zipper ' -> run ' zipper ' outcomes ' | None -> callback { log = List . rev ! log ; outcomes = List . rev outcomes ' } in match location with | Suite . TestCase ( _ , test_fun ) -> let prefix = Zipper . get_labels zipper |> String . concat " " : in let log = log_with_prefix prefix in Suite . Async . run_one prefix test_fun log ( fun outcome -> continue zipper ( outcome :: outcomes ) ) | Suite . TestList ( _ , _ ) -> continue zipper outcomes in run ' zipper [ ] let summarise_raw outcomes = let total , errors , failures , passes = List . fold_left ( fun ( total , errors , failures , passes ) outcome -> let open Suite in match outcome . result with | Error _ -> total + 1 , errors + 1 , failures , passes | Fail _ -> total + 1 , errors , failures + 1 , passes | Pass -> total + 1 , errors , failures , passes + 1 ) ( 0 , 0 , 0 , 0 ) outcomes in { total ; errors ; failures ; passes ; passed = ( total = passes ) } let summary_of_raw raw = let report = String . concat " \ n " [ Printf . sprintf " % d tests run " raw . total ; Printf . sprintf " % d errors " raw . errors ; Printf . sprintf " % d failures " raw . failures ; Printf . sprintf " % d passes " raw . passes ; ] in { report ; passed = raw . passed ; } let summarise outcomes = summarise_raw outcomes |> summary_of_raw end
module Runner = struct let paint color string = match color with | ` Red -> " \ 027 [ 31m " ^ string ^ " \ 027 [ 0m " | ` Green -> " \ 027 [ 32m " ^ string ^ " \ 027 [ 0m " | ` Yellow -> " \ 027 [ 33m " ^ string ^ " \ 027 [ 0m " | _ -> string let colored_string_of_result r = let s = Webtest . Suite . string_of_result r in let c = match r with | Webtest . Suite . Error _ -> ` Yellow | Webtest . Suite . Fail _ -> ` Red | Webtest . Suite . Pass -> ` Green in paint c s let show v = Printf . kprintf ( fun b -> Firebug . console ## info ( Js . string b ) ) v let run ( ? with_colors = true ) suite = let open Webtest . Suite in let open Webtest . Utils in run suite ( fun { log = _ ; outcomes } -> show " Tests results " ; : let raw_summary = summarise_raw outcomes in List . iter ( fun { label ; result ; time_s } -> let sresult = if with_colors then colored_string_of_result result else string_of_result result in show " Test % s . . . % s ( took . % 4fs ) " label sresult time_s ) outcomes ; let test_result = if raw_summary . passed then paint ` Green " Pass " else paint ` Red " Failed " in show " " ; show " Test result : % s . % d in total ; % d passed ; % d failed ; % d errored . " test_result raw_summary . total raw_summary . passes raw_summary . failures raw_summary . errors ; exit ( if raw_summary . passed then 0 else 1 ) ) let install_webtest suite = let webtest = Js . Unsafe . obj [ ] || in webtest . ## finished := Js . _false ; webtest . ## log := Js . string " " ; webtest . ## passed := Js . _false ; webtest . ## run := Js . wrap_callback ( fun ( ) -> let open Webtest in Utils . run suite ( fun { Utils . log ; outcomes } -> let { Utils . report ; passed } = Utils . summarise outcomes in webtest . ## log := Js . string ( ( String . concat " \ n " log ) ^ " \ n " ^ report ) ; webtest . ## passed := if passed then Js . _true else Js . _false ; webtest . ## finished := Js . _true ) ) ; Js . Unsafe . global . ## webtest := webtest let setup suite = let module Html = Dom_html in Html . window . ## onload := Html . handler ( fun _ -> let ( ) = install_webtest suite in Js . _false ) end
module type S = sig type t type data val create : filename : string -> logger : Logger . t -> t Deferred . t val store : t -> data -> unit Deferred . t end
module type Storage_intf = sig type data type location val store : location -> data -> unit Deferred . t end
module Make ( Data : sig type t end ) end type t = { filename : string ; reader : Data . t Linear_pipe . Reader . t ; writer : Data . t Linear_pipe . Writer . t } let write_to_storage { filename ; _ } request data = let % bind ( ) = Store . store filename data in Request . put request filename let create ~ filename ~ logger = let reader , writer = Linear_pipe . create ( ) in let t = { filename ; reader ; writer } in let % map ( ) = match % map Request . create ( ) with | Ok request -> don ' t_wait_for ( Linear_pipe . iter reader ~ f ( : fun data -> match % map write_to_storage t request data with | Ok ( ) -> ( ) | Error e -> [ % log error ] error " Error writing Web client pipe data : $ error " ~ metadata [ : ( " error " , Error_json . error_to_yojson e ) e ] ) ) | Error e -> [ % log error ] error " Unable to create request : $ error " ~ metadata [ : ( " error " , Error_json . error_to_yojson e ) e ] in t let store { reader ; writer ; _ } data = Linear_pipe . force_write_maybe_drop_head ~ capacity : 1 writer reader data ; Deferred . unit end
let can_parse_uri_safe _ ( ) = let open Csrf . Crypto in let with_secret = Sihl . Configuration . read_secret ( ) |> Secret . make in let value = Nocrypto . Rng . generate token_length in let enc = Encrypted_token . from_struct ~ with_secret value in let parsed = enc |> Encrypted_token . to_uri_safe_string |> Encrypted_token . of_uri_safe_string |> Option . get in let open Alcotest in check bool " Same decrypted CSRF tokens " true @@ Encrypted_token . equal enc parsed ; Lwt . return ( ) ; ;
let crypto_undo_helper encrypt decrypt = let open Csrf . Crypto in let with_secret = Sihl . Configuration . read_secret ( ) |> Secret . make in let value = Nocrypto . Rng . generate token_length in let dec = encrypt ~ with_secret value |> decrypt ~ with_secret in let open Alcotest in check bool " Same decrypted CSRF tokens " true @@ Decrypted_token . equal_struct dec value ; Lwt . return ( ) ; ;
let decrypt_random_undoes_encrypt_random _ ( ) = let open Csrf . Crypto in crypto_undo_helper Encrypted_token . from_struct_random Decrypted_token . from_encrypted_random ; ;
let decrypt_undoes_encrypt _ ( ) = let open Csrf . Crypto in crypto_undo_helper Encrypted_token . from_struct Decrypted_token . from_encrypted ; ;
let csrf_simulation _ ( ) = let open Csrf . Crypto in let with_secret = Sihl . Configuration . read_secret ( ) |> Secret . make in let value = Nocrypto . Rng . generate token_length in let enc = Encrypted_token . from_struct ~ with_secret value in let req = Decrypted_token . from_encrypted_to_encrypted_random ~ with_secret enc |> Encrypted_token . to_uri_safe_string in let ck = enc |> Encrypted_token . to_uri_safe_string in let received = Encrypted_token . of_uri_safe_string req |> Option . get in let stored = ck |> Encrypted_token . of_uri_safe_string |> Option . get in let dec_received = received |> Decrypted_token . from_encrypted_random ~ with_secret in let dec_stored = stored |> Decrypted_token . from_encrypted ~ with_secret in let open Alcotest in let non_empty tkn = check bool " Non empty encrypted token " false ( Cstruct . is_empty @@ tkn ) in non_empty @@ Encrypted_token . to_struct received ; non_empty @@ Encrypted_token . to_struct stored ; non_empty @@ Cstruct . of_string req ; non_empty @@ Cstruct . of_string ck ; check bool " Same decrypted CSRF tokens " true @@ Decrypted_token . equal dec_stored dec_received ; Lwt . return ( ) ; ;
let apply_middlewares handler ? not_allowed_handler = handler |> Rock . Middleware . apply ( Sihl . Web . Middleware . csrf ? not_allowed_handler ~ key : csrf_name ( ) ) ; ;
let default_response ? status ( ) = Lwt . return @@ Response . of_plain_text ? status " Pizzas " ; ;
let get_csrf req = Csrf . find req |> Option . get
let uri_decrypt token = let open Csrf . Crypto in let with_secret = Sihl . Configuration . read_secret ( ) |> Secret . make in token |> Encrypted_token . of_uri_safe_string |> Option . get |> Decrypted_token . from_encrypted_random ~ with_secret ; ;
let get_request_without_token_succeeds _ ( ) = let req = Request . get route in let handler _ = default_response ( ) in let wrapped_handler = apply_middlewares handler in let % lwt response = wrapped_handler req in let status = Response . status response |> Opium . Status . to_code in let open Alcotest in check int " Has status 200 " 200 status ; Lwt . return ( ) ; ;
let get_request_yields_token _ ( ) = let req = Request . get route in let token = ref " " in let handler req = token := get_csrf req ; default_response ( ) in let wrapped_handler = apply_middlewares handler in let % lwt response = wrapped_handler req in let value = Sihl . Test . Session . find_resp csrf_name response in let open Alcotest in check bool " Has CSRF token " true ( not @@ CCString . is_empty ! token ) ; check bool " Has CSRF cookie " true ( not @@ CCString . is_empty value ) ; Lwt . return ( ) ; ;
let two_get_requests_yield_correct_tokens _ ( ) = let req = Request . get route in let token1 = ref " " in let token2 = ref " " in let handler tkn req = tkn := get_csrf req ; default_response ( ) in let wrapped_handler1 = apply_middlewares @@ handler token1 in let % lwt resp1 = wrapped_handler1 req in let cookie = resp1 |> Response . cookie " _session " |> Option . get in let status = Response . status resp1 |> Opium . Status . to_code in let get_req = Request . get route |> Request . add_cookie cookie . Cookie . value in let wrapped_handler2 = apply_middlewares @@ handler token2 in let % lwt resp2 = wrapped_handler2 get_req in let find_cookie response = Sihl . Test . Session . find_resp csrf_name response in let cookie_token1 = find_cookie resp1 in let cookie_token2 = find_cookie resp2 in let open Csrf . Crypto in let open Alcotest in check int " Has status 200 " 200 status ; check bool " First has CSRF token " true ( not @@ CCString . is_empty ! token1 ) ; check bool " Second has CSRF token " true ( not @@ CCString . is_empty ! token2 ) ; check ( neg string ) " Different encrypted CSRF tokens " ! token1 ! token2 ; let decrypt_same str tk1 tk2 = check bool str true ( Decrypted_token . equal ( uri_decrypt tk1 ) ( uri_decrypt tk2 ) ) in decrypt_same " Same decrypted CSRF tokens " ! token1 ! token2 ; check string " Same encrypted CSRF tokens in cookie " cookie_token1 cookie_token2 ; decrypt_same " Same decrypted CSRF tokens in cookie " cookie_token1 cookie_token1 ; Lwt . return ( ) ; ;
let post_request_yields_token _ ( ) = let post_req = Request . post route in let token = ref " " in let not_allowed_handler req = token := get_csrf req ; default_response ~ status ` : Forbidden ( ) in let handler _ = default_response ( ) in let wrapped_handler = apply_middlewares handler ~ not_allowed_handler in let % lwt response = wrapped_handler post_req in let status = Response . status response |> Opium . Status . to_code in let cookie_token = Sihl . Test . Session . find_resp csrf_name response in let open Alcotest in check int " Has status 403 " 403 status ; check bool " Has CSRF token " true ( not @@ CCString . is_empty ! token ) ; check bool " Has CSRF cookie " true ( not @@ CCString . is_empty cookie_token ) ; Lwt . return ( ) ; ;
let two_post_requests_yield_different_token _ ( ) = let req = Request . post route in let token1 = ref " " in let token2 = ref " " in let not_allowed_handler tkn req = tkn := get_csrf req ; default_response ( ) in let handler _ = default_response ( ) in let wrapped_handler1 = apply_middlewares handler ~ not_allowed_handler ( : not_allowed_handler token1 ) in let % lwt resp1 = wrapped_handler1 req in let wrapped_handler2 = apply_middlewares handler ~ not_allowed_handler ( : not_allowed_handler token2 ) in let % lwt resp2 = wrapped_handler2 req in let find_cookie response = Sihl . Test . Session . find_resp csrf_name response in let cookie_token1 = find_cookie resp1 in let cookie_token2 = find_cookie resp2 in let open Alcotest in check bool " First has CSRF token " true ( not @@ CCString . is_empty ! token1 ) ; check bool " Second has CSRF token " true ( not @@ CCString . is_empty ! token2 ) ; check bool " Different decrypted CSRF tokens " false ( Csrf . Crypto . Decrypted_token . equal ( uri_decrypt ! token1 ) ( uri_decrypt ! token2 ) ) ; check ( neg string ) " Different encrypted CSRF tokens in cookie " cookie_token1 cookie_token2 ; Lwt . return ( ) ; ;
let post_request_both_invalid_tokens_fails _ ( ) = let requests = CCList . map ( fun body -> Request . of_urlencoded ~ body route ` POST ) [ [ ] ; [ csrf_name , [ " garbage " ] ] ] in let add_cookie = [ CCFun . id ; Sihl . Test . Session . set_value_req [ csrf_name , " garbage " ] ] in let reqs = CCList . product CCFun . ( @@ ) add_cookie requests in let allowed = ref 0 in let handler _ = allowed := ! allowed + 1 ; default_response ( ) in let wrapped_handler = apply_middlewares handler in let % lwt responses = Lwt_list . map_s wrapped_handler reqs in let statuses = CCList . map ( fun r -> Opium . Status . to_code @@ Response . status r ) responses in let open Alcotest in check bool " Has status 403 " true ( CCList . for_all ( ( == ) 403 ) statuses ) ; check int " Is disallowed " 0 ! allowed ; Lwt . return ( ) ; ;
let cookie_invalid_helper reqs = let req = Request . get route in let token = ref " " in let allowed = ref 0 in let handler1 req = token := get_csrf req ; default_response ( ) in let handler2 _ = allowed := ! allowed + 1 ; default_response ( ) in let wrapped_handler = apply_middlewares handler1 in let % lwt response = wrapped_handler req in let wrapped_handler = apply_middlewares handler2 in let cookie = response |> Response . cookies |> List . hd in let % lwt responses = Lwt_list . map_s wrapped_handler @@ reqs ( ! token , cookie ) in let statuses = CCList . map ( fun r -> Opium . Status . to_code @@ Response . status r ) responses in print_endline @@ CCString . concat " , " @@ List . map string_of_int statuses ; let open Alcotest in check bool " Has status 403 " true ( CCList . for_all ( ( == ) 403 ) statuses ) ; check int " Is disallowed " 0 ! allowed ; Lwt . return ( ) ; ;
let post_request_cookie_invalid_token_fails _ ( ) = let reqs ( token , _ ) = CCList . map ( fun add_cookie -> Request . of_urlencoded ~ body [ : csrf_name , [ token ] ] route ` POST |> add_cookie ) [ CCFun . id ; Sihl . Test . Session . set_value_req [ csrf_name , " garbage " ] ] in cookie_invalid_helper reqs ; ;
let post_request_request_invalid_token_fails _ ( ) = let reqs ( _ , cookie ) = CCList . map ( fun body -> Request . of_urlencoded ~ body route ` POST |> Request . add_cookie cookie . Cookie . value ) [ [ ] ; [ csrf_name , [ " garbage " ] ] ] in cookie_invalid_helper reqs ; ;
let post_request_with_nonmatching_token_fails _ ( ) = let open Csrf . Crypto in let req = Request . get route in let token = ref " " in let handler req = token := get_csrf req ; default_response ( ) in let wrapped_handler = apply_middlewares handler in let % lwt response = wrapped_handler req in let cookie = response |> Response . cookie " _session " |> Option . get in let with_secret = Sihl . Configuration . read_secret ( ) |> Secret . make in let tkn = Nocrypto . Rng . generate token_length |> Encrypted_token . from_struct_random ~ with_secret |> Encrypted_token . to_uri_safe_string in let post_req = Request . of_urlencoded ~ body [ : csrf_name , [ tkn ] ] route ` POST |> Request . add_cookie cookie . Cookie . value in let handler _ = default_response ( ) in let wrapped_handler = apply_middlewares handler in let % lwt response = wrapped_handler post_req in let status = Response . status response |> Opium . Status . to_code in Alcotest . ( check int " Has status 403 " 403 status ) ; Lwt . return ( ) ; ;
let post_request_with_nonmatching_cookie_fails _ ( ) = let open Csrf . Crypto in let req = Request . get route in let token = ref " " in let handler req = token := get_csrf req ; default_response ( ) in let wrapped_handler = apply_middlewares handler in let % lwt _ = wrapped_handler req in let with_secret = Sihl . Configuration . read_secret ( ) |> Secret . make in let tkn = Nocrypto . Rng . generate token_length |> Encrypted_token . from_struct ~ with_secret |> Encrypted_token . to_uri_safe_string in let post_req = Request . of_urlencoded ~ body [ : csrf_name , [ ! token ] ] route ` POST |> Sihl . Test . Session . set_value_req [ csrf_name , tkn ] in let handler _ = default_response ( ) in let open Alcotest in let not_allowed_handler req = let key , _ = req |> Request . cookies |> List . hd in check string " Has cookie set " " _session " key ; default_response ( ) ~ status ` : Forbidden in let wrapped_handler = apply_middlewares handler ~ not_allowed_handler in let % lwt response = wrapped_handler post_req in let key = response |> Response . cookies |> List . hd in check string " Has cookie set " " _session " @@ fst key . Cookie . value ; let status = Response . status response |> Opium . Status . to_code in check int " Has status 403 " 403 status ; Lwt . return ( ) ; ;
let post_request_with_valid_token_succeeds _ ( ) = let req = Request . get route in let token = ref " " in let handler req = token := get_csrf req ; default_response ( ) in let wrapped_handler = apply_middlewares handler in let % lwt response = wrapped_handler req in let cookie = response |> Response . cookies |> List . hd in let post_req = Request . of_urlencoded ~ body [ : csrf_name , [ ! token ] ] route ` POST |> Request . add_cookie cookie . Cookie . value in let handler _ = default_response ( ) in let wrapped_handler = apply_middlewares handler in let % lwt response = wrapped_handler post_req in let status = Response . status response |> Opium . Status . to_code in Alcotest . ( check int " Has status 200 " 200 status ) ; Lwt . return ( ) ; ;
let two_post_requests_succeed _ ( ) = let req = Request . get route in let token1 = ref " " in let token2 = ref " " in let token3 = ref " " in let handler tkn req = tkn := get_csrf req ; default_response ( ) in let wrapped_handler = apply_middlewares @@ handler token1 in let % lwt response = wrapped_handler req in let cookie = response |> Response . cookies |> List . hd in let status1 = Response . status response |> Opium . Status . to_code in let post_req = Request . of_urlencoded ~ body [ : csrf_name , [ ! token1 ] ] route ` POST |> Request . add_cookie cookie . Cookie . value in let wrapped_handler = apply_middlewares @@ handler token2 in let % lwt response = wrapped_handler post_req in let status2 = Response . status response |> Opium . Status . to_code in let % lwt response = wrapped_handler req in let cookie = response |> Response . cookies |> List . hd in let session_key , session_val = " test_key " , " test_val " in let post_req = Request . of_urlencoded ~ body [ : csrf_name , [ ! token2 ] ] route ` POST |> Request . add_cookie cookie . Cookie . value |> Sihl . Test . Session . set_value_req [ session_key , session_val ] in let wrapped_handler = apply_middlewares @@ handler token3 in let % lwt response = wrapped_handler post_req in let status3 = Response . status response |> Opium . Status . to_code in let session = Sihl . Test . Session . find_resp session_key response in let open Alcotest in check string " Session is not overwritten " session_val session ; CCList . iter ( check int " Has status 200 " 200 ) [ status1 ; status2 ; status3 ] ; CCList . iter ( fun tkn -> check bool " Has CSRF token " true ( String . length tkn > 0 ) ) [ ! token1 ; ! token2 ; ! token3 ] ; CCList . iter ( fun ( tkn1 , tkn2 ) -> check bool " Different CSRF tokens " false ( String . equal tkn1 tkn2 ) ) [ ! token1 , ! token2 ; ! token1 , ! token3 ; ! token2 , ! token3 ] ; Lwt . return ( ) ; ;
let stale_duplicated_token_post_request_succeed _ ( ) = let req = Request . get route in let token = ref " " in let handler req = token := get_csrf req ; default_response ( ) in let wrapped_handler = apply_middlewares handler in let % lwt response = wrapped_handler req in let old_token = ! token in let cookie = response |> Response . cookies |> List . hd in let post_req = Request . of_urlencoded ~ body [ : csrf_name , [ old_token ] ] route ` POST |> Request . add_cookie cookie . Cookie . value in let % lwt _ = wrapped_handler req in let % lwt response1 = wrapped_handler post_req in let % lwt response2 = wrapped_handler post_req in let statuses = CCList . map ( fun resp -> Response . status resp |> Opium . Status . to_code ) [ response1 ; response2 ] in let open Alcotest in CCList . iter ( check int " Has status 200 " 200 ) statuses ; Lwt . return ( ) ; ;
let suite = [ ( " csrf crypto " , [ test_case " uri safe encoded string can be decoded " ` Quick can_parse_uri_safe ; test_case " decryption accounting for random undoes random encryption " ` Quick decrypt_random_undoes_encrypt_random ; test_case " decryption undoes encryption " ` Quick decrypt_undoes_encrypt ; test_case " simulate entire CSRF crypto lifecycle " ` Quick csrf_simulation ] ) ; ( " csrf " , [ test_case " get request without CSRF token succeeds " ` Quick get_request_without_token_succeeds ; test_case " get request yields CSRF token " ` Quick get_request_yields_token ; test_case " two get requests yield correct CSRF token " ` Quick two_get_requests_yield_correct_tokens ; test_case " two post requests yield different CSRF token " ` Quick two_post_requests_yield_different_token ; test_case " post request with invalid CSRF token in cookie and request fails " ` Quick post_request_both_invalid_tokens_fails ; test_case " post request with invalid CSRF token in cookie fails " ` Quick post_request_cookie_invalid_token_fails ; test_case " post request with invalid CSRF token in request fails " ` Quick post_request_request_invalid_token_fails ; test_case " post request with non - matching CSRF token fails " ` Quick post_request_with_nonmatching_token_fails ; test_case " post request with non - matching CSRF cookie fails " ` Quick post_request_with_nonmatching_cookie_fails ; test_case " post request with valid CSRF token succeeds " ` Quick post_request_with_valid_token_succeeds ; test_case " two post requests with a valid CSRF token succeed " ` Quick two_post_requests_succeed ; test_case " post request with stale and duplicated token succeeds " ` Quick stale_duplicated_token_post_request_succeed ] ) ] ; ;
let ( ) = Unix . putenv " CHECK_CSRF " " true " ; Logs . set_level ( Sihl . Log . get_log_level ( ) ) ; Logs . set_reporter ( Sihl . Log . cli_reporter ( ) ) ; Lwt_main . run ( Alcotest_lwt . run " csrf " suite ) ; ;
let log_src = Logs . Src . create " sihl . middleware . error "
module Logs = ( val Logs . src_log log_src : Logs . LOG )
let page request_id = Format . asprintf { | < head > < meta charset " = utf - 8 " > < meta name " = viewport " content " = width = device - width , initial - scale = 1 , shrink - to - fit = no " > < title > Internal Server Error </ title > < style > % s </ style > </ head > < div class " = py - 4 sm : py - 12 " > < div class " = max - w - 8xl mx - auto px - 4 sm : px - 6 lg : px - 8 " > < h2 class " = text - 2xl leading - 8 font - semibold font - display text - gray - 900 sm : text - 3xl sm : leading - 9 " > Internal Server Error </ h2 > < div class " = mt - 0 mb - 4 text - gray - 600 " > An error has been caught while handling the request . </ div > < p > Our administrators have been notified . Please note your request ID < b >% s </ b > when contacting us . </ p > </ div > </ div > </ body > </ html > } | Web . style request_id ; ;
let site_error_handler req = let request_id = Web_id . find req |> Option . value ~ default " " :- in let site = page request_id in Opium . Response . of_plain_text site |> Opium . Response . set_content_type " text / html ; charset = utf - 8 " |> Lwt . return ; ;
let json_error_handler req = let request_id = Web_id . find req |> Option . value ~ default " " :- in let msg = Format . sprintf " Something went wrong , our administrators have been notified . " in let body = Format . sprintf { " { " | errors " : [ " % s " ] , " request_id " : " % s " } " } | msg request_id in Opium . Response . of_plain_text body |> Opium . Response . set_content_type " application / json ; charset = utf - 8 " |> Opium . Response . set_status ` Internal_server_error |> Lwt . return ; ;
let exn_to_string exn req = let msg = Printexc . to_string exn and stack = Printexc . get_backtrace ( ) in let request_id = Web_id . find req |> Option . value ~ default " " :- in let req_str = Format . asprintf " % a " Opium . Request . pp_hum req in Format . asprintf " Request id % s : % s \ nError : % s \ nStacktrace : % s " request_id req_str msg stack ; ;
let create_error_email ( sender , recipient ) error = Contract_email . create ~ sender ~ recipient ~ subject " : Exception caught " error ; ;
let middleware ? email_config ( ? reporter = fun _ _ -> Lwt . return ( ) ) ? error_handler ( ) = let filter handler req = Lwt . catch ( fun ( ) -> handler req ) ( fun exn -> let error = exn_to_string exn req in Logs . err ( fun m -> m " % s " error ) ; let _ = match email_config with | Some ( sender , recipient , send_fn ) -> let email = create_error_email ( sender , recipient ) error in Lwt . catch ( fun ( ) -> send_fn email ) ( fun exn -> let msg = Printexc . to_string exn in Logs . err ( fun m -> m " Failed to report error per email : % s " msg ) ; Lwt . return ( ) ) | _ -> Lwt . return ( ) in let _ = Lwt . catch ( fun ( ) -> reporter req error ) ( fun exn -> let msg = Printexc . to_string exn in Logs . err ( fun m -> m " Failed to run custom error reporter : % s " msg ) ; Lwt . return ( ) ) in let content_type = try req |> Opium . Request . header " Content - Type " |> Option . map ( String . split_on_char ' ; ' ) |> Option . map List . hd with | _ -> None in match error_handler with | Some error_handler -> error_handler req | None -> ( match content_type with | Some " application / json " -> json_error_handler req | _ -> site_error_handler req ) ) in if Core_configuration . is_production ( ) then Rock . Middleware . create ~ name " : error " ~ filter else Opium . Middleware . debugger ; ;
let assert_delete_cookie cookie = Alcotest . ( check ( pair string string ) " flash is empty " ( " _flash " , " " ) cookie . Opium . Cookie . value ) ; match cookie . Opium . Cookie . expires with | ` Max_age value -> if Int64 . equal value Int64 . zero then ( ) else Alcotest . fail " Flash cookie did not expire " | _ -> Alcotest . fail " Flash cookie did not expire " ; ;
let not_touching_flash_without_set_cookie_doesnt_set_cookie _ ( ) = let req = Opium . Request . get " " / in let % lwt res = Rock . Middleware . apply ( Sihl . Web . Middleware . flash ( ) ) ( fun _ -> Lwt . return @@ Opium . Response . of_plain_text " " ) req in let cookie = Opium . Response . cookie " _flash " res in Alcotest . ( check bool " no cookie set " false ( Option . is_some cookie ) ) ; Lwt . return ( ) ; ;
let not_touching_flash_removes_cookie _ ( ) = let req = Opium . Request . get " " / |> Opium . Request . add_cookie ( " _flash " , { { " | alert " : null , " notice " : null , " custom " [ ] } } ) :| in let % lwt res = Rock . Middleware . apply ( Sihl . Web . Middleware . flash ( ) ) ( fun _ -> Lwt . return @@ Opium . Response . of_plain_text " " ) req in let cookie = Opium . Response . cookie " _flash " res |> Option . get in Alcotest . ( check ( pair string string ) " was removed " ( " _flash " , " " ) cookie . Opium . Cookie . value ) ; Lwt . return ( ) ; ;
let flash_is_cleared_after_request _ ( ) = let req = Opium . Request . get " " / in let % lwt res = Rock . Middleware . apply ( Sihl . Web . Middleware . flash ( ) ) ( fun _ -> let res = Opium . Response . of_plain_text " " |> Sihl . Web . Flash . set_alert " foobar " in Lwt . return res ) req in let cookie = Opium . Response . cookie " _flash " res |> Option . get in let cookie_value = cookie . Opium . Cookie . value in let req = Opium . Request . get " " in let req = Opium . Request . add_cookie cookie_value req in let % lwt res = Rock . Middleware . apply ( Sihl . Web . Middleware . flash ( ) ) ( fun req -> let alert = Sihl . Web . Flash . find_alert req in Alcotest . ( check ( option string ) " has alert " ( Some " foobar " ) alert ) ; Lwt . return @@ Opium . Response . of_plain_text " " ) req in let cookie = Opium . Response . cookie " _flash " res |> Option . get in let cookie_value = cookie . Opium . Cookie . value in let req = Opium . Request . get " " / in let req = Opium . Request . add_cookie cookie_value req in let % lwt _ = Rock . Middleware . apply ( Sihl . Web . Middleware . flash ( ) ) ( fun req -> let alert = Sihl . Web . Flash . find_alert req in Alcotest . ( check ( option string ) " alert was cleared " None alert ) ; Lwt . return @@ Opium . Response . of_plain_text " " ) req in assert_delete_cookie cookie ; Lwt . return ( ) ; ;
let set_and_read_flash_message _ ( ) = let req = Opium . Request . get " " / in let % lwt res = Rock . Middleware . apply ( Sihl . Web . Middleware . flash ( ) ) ( fun req -> let alert = Sihl . Web . Flash . find_alert req in let notice = Sihl . Web . Flash . find_notice req in Alcotest . ( check ( option string ) " has no alert " None alert ) ; Alcotest . ( check ( option string ) " has no notice " None notice ) ; let res = Opium . Response . of_plain_text " " in let res = Sihl . Web . Flash . set_alert " foobar " res in Lwt . return res ) req in let cookie = Opium . Response . cookie " _flash " res |> Option . get in let cookie_value = cookie . Opium . Cookie . value in let req = Opium . Request . get " " in let req = Opium . Request . add_cookie cookie_value req in let % lwt res = Rock . Middleware . apply ( Sihl . Web . Middleware . flash ( ) ) ( fun req -> let alert = Sihl . Web . Flash . find_alert req in let notice = Sihl . Web . Flash . find_notice req in Alcotest . ( check ( option string ) " has alert " ( Some " foobar " ) alert ) ; Alcotest . ( check ( option string ) " has no notice " None notice ) ; let res = Opium . Response . of_plain_text " " in let res = Sihl . Web . Flash . set_alert " nextfoo " res in let res = Sihl . Web . Flash . set [ " hello " , " other " ] res in Lwt . return res ) req in let cookie = Opium . Response . cookie " _flash " res |> Option . get in let cookie_value = cookie . Opium . Cookie . value in let req = Opium . Request . get " " |> Opium . Request . add_cookie cookie_value in let % lwt response = Rock . Middleware . apply ( Sihl . Web . Middleware . flash ( ) ) ( fun req -> let alert = Sihl . Web . Flash . find_alert req in let custom = Sihl . Web . Flash . find " hello " req in Alcotest . ( check ( option string ) " has alert " ( Some " nextfoo " ) alert ) ; Alcotest . ( check ( option string ) " has custom " ( Some " other " ) custom ) ; let res = Opium . Response . of_plain_text " " in Lwt . return res ) req in let cookie = Opium . Response . cookie " _flash " response |> Option . get in assert_delete_cookie cookie ; let cookie_value = cookie . Opium . Cookie . value in let req = Opium . Request . get " " |> Opium . Request . add_cookie cookie_value in let % lwt resp = Rock . Middleware . apply ( Sihl . Web . Middleware . flash ( ) ) ( fun req -> let flash = Sihl . Web . Flash . find_alert req in Alcotest . ( check ( option string ) " has no alert " None flash ) ; let res = Opium . Response . of_plain_text " " in Lwt . return res ) req in let cookie = Opium . Response . cookie " _flash " resp |> Option . get in Alcotest . ( check ( pair string string ) " was removed " ( " _flash " , " " ) cookie . Opium . Cookie . value ) ; Lwt . return ( ) ; ;
let suite = [ ( " flash " , [ test_case " not touching flash without set cookie doesn ' t change cookie " ` Quick not_touching_flash_without_set_cookie_doesnt_set_cookie ; test_case " not touching flash removes cookie " ` Quick not_touching_flash_removes_cookie ; test_case " flash is cleared after request " ` Quick flash_is_cleared_after_request ; test_case " set and read flash message " ` Quick set_and_read_flash_message ] ) ] ; ;
let ( ) = Logs . set_level ( Sihl . Log . get_log_level ( ) ) ; Logs . set_reporter ( Sihl . Log . cli_reporter ( ) ) ; Lwt_main . run ( Alcotest_lwt . run " flash " suite ) ; ;
let log_src = Logs . Src . create " sihl . middleware . htmx "
module Logs = ( val Logs . src_log log_src : Logs . LOG )
let is_htmx req = Opium . Request . header " HX - Request " req |> Option . is_some
let current_url req = Opium . Request . header " HX - Current - URL " req
let prompt req = Opium . Request . header " HX - Prompt " req
let set_prompt prompt req = Opium . Request . add_header_or_replace ( " HX - Prompt " , prompt ) req ; ;
let target req = Opium . Request . header " HX - Target " req
let set_target target req = Opium . Request . add_header_or_replace ( " HX - Target " , target ) req ; ;
let trigger_name req = Opium . Request . header " HX - Trigger - Name " req
let set_trigger_name trigger_name req = Opium . Request . add_header_or_replace ( " HX - Trigger - Name " , trigger_name ) req ; ;
let trigger_req req = Opium . Request . header " HX - Trigger " req
let set_trigger_req trigger req = Opium . Request . add_header_or_replace ( " HX - Trigger " , trigger ) req ; ;
let set_push push resp = Opium . Response . add_header_or_replace ( " HX - Push " , push ) resp ; ;
let set_redirect redirect resp = Opium . Response . add_header_or_replace ( " HX - Redirect " , redirect ) resp ; ;
let set_refresh refresh resp = Opium . Response . add_header_or_replace ( " HX - Refresh " , refresh ) resp ; ;
let set_trigger trigger resp = Opium . Response . add_header_or_replace ( " HX - Trigger " , trigger ) resp ; ;