Source file chatoyant_native.ml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
module Clock = struct
let make ~clock =
(module struct
let now_ms () = Eio.Time.now clock *. 1000. |> Float.round |> int_of_float
end : Chatoyant_runtime.Effect.CLOCK)
end
module Env = struct
let get = Sys.getenv_opt
end
module Http = struct
type multipart_part = {
name : string;
filename : string option;
content_type : string option;
body : string;
}
type body =
| Empty
| Text of string
| Json of Chatoyant_runtime.Json.t
| Multipart of multipart_part list
type request = {
method_ : string;
url : string;
headers : (string * string) list;
body : body;
timeout_ms : int option;
}
type response = {
status : int;
headers : (string * string) list;
body : string;
}
type error = Timeout of int | Network of string | Invalid_response of string
let error_to_string = function
| Timeout ms -> Printf.sprintf "timeout after %d ms" ms
| Network message -> "network error: " ^ message
| Invalid_response message -> "invalid response: " ^ message
module type EFFECT =
Chatoyant_runtime.Effect.HTTP
with type multipart_part = multipart_part
and type body = body
and type request = request
and type response = response
and type error = error
type client_certificate = {
certificate_pem : string;
private_key_pem : string;
authenticator : X509.Authenticator.t option;
}
type https =
| System
| Authenticator of X509.Authenticator.t
| Mutual_tls of client_certificate
| Tls_config of Tls.Config.client
| Disabled
let default_max_response_size = 100 * 1024 * 1024
let tls_config ?authenticator () =
let authenticator =
match authenticator with
| Some authenticator -> Ok authenticator
| None -> Ca_certs.authenticator ()
in
match authenticator with
| Error (`Msg message) -> Error message
| Ok authenticator -> (
match Tls.Config.client ~authenticator () with
| Ok config -> Ok config
| Error (`Msg message) -> Error message)
let mtls_config ?authenticator ~certificate_pem ~private_key_pem () =
let authenticator =
match authenticator with
| Some authenticator -> Ok authenticator
| None -> Ca_certs.authenticator ()
in
match authenticator with
| Error (`Msg message) -> Error message
| Ok authenticator -> (
match
( X509.Certificate.decode_pem_multiple certificate_pem,
X509.Private_key.decode_pem private_key_pem )
with
| Error (`Msg message), _ | _, Error (`Msg message) -> Error message
| Ok certificates, Ok private_key -> (
match
Tls.Config.client ~authenticator
~certificates:(`Single (certificates, private_key))
()
with
| Ok config -> Ok config
| Error (`Msg message) -> Error message))
let tls_config_exn mode =
match mode with
| Disabled -> None
| Tls_config config -> Some config
| Mutual_tls cert -> (
match
mtls_config ?authenticator:cert.authenticator
~certificate_pem:cert.certificate_pem
~private_key_pem:cert.private_key_pem ()
with
| Ok config -> Some config
| Error message -> invalid_arg ("Chatoyant.Http: " ^ message))
| Authenticator authenticator -> (
match tls_config ~authenticator () with
| Ok config -> Some config
| Error message -> invalid_arg ("Chatoyant.Http: " ^ message))
| System -> (
match tls_config () with
| Ok config -> Some config
| Error message -> invalid_arg ("Chatoyant.Http: " ^ message))
let https_wrapper config uri raw =
let host =
Uri.host uri
|> Option.map (fun value -> Domain_name.(host_exn (of_string_exn value)))
in
Tls_eio.client_of_flow config ?host raw
let lower_ascii value = value |> String.lowercase_ascii
let name =
let expected = lower_ascii name in
List.exists (fun (key, _) -> lower_ascii key = expected) headers
let name value =
if has_header name headers then headers else (name, value) :: headers
let multipart_boundary () =
"chatoyant-eio-"
^ Int.to_string (Random.bits ())
^ Int.to_string (Random.bits ())
let escape_disposition_value value =
let buffer = Buffer.create (String.length value) in
String.iter
(function
| '"' -> Buffer.add_string buffer "\\\""
| '\\' -> Buffer.add_string buffer "\\\\"
| '\r' | '\n' -> Buffer.add_char buffer '_'
| char -> Buffer.add_char buffer char)
value;
Buffer.contents buffer
let make ?(https = System) ?(max_response_size = default_max_response_size)
~net ~clock () =
Mirage_crypto_rng_unix.use_default ();
let https =
tls_config_exn https |> Option.map (fun config -> https_wrapper config)
in
(module struct
type nonrec multipart_part = multipart_part = {
name : string;
filename : string option;
content_type : string option;
body : string;
}
type nonrec body = body =
| Empty
| Text of string
| Json of Chatoyant_runtime.Json.t
| Multipart of multipart_part list
type nonrec request = request = {
method_ : string;
url : string;
headers : (string * string) list;
body : body;
timeout_ms : int option;
}
type nonrec response = response = {
status : int;
headers : (string * string) list;
body : string;
}
type nonrec error = error =
| Timeout of int
| Network of string
| Invalid_response of string
let client = Cohttp_eio.Client.make ~https net
let encode_multipart parts =
let boundary = multipart_boundary () in
let buffer = Buffer.create 1024 in
let add = Buffer.add_string buffer in
let name value =
add name;
add ": ";
add value;
add "\r\n"
in
let add_part part =
add "--";
add boundary;
add "\r\n";
let disposition =
match part.filename with
| None ->
"form-data; name=\"" ^ escape_disposition_value part.name ^ "\""
| Some filename ->
"form-data; name=\""
^ escape_disposition_value part.name
^ "\"; filename=\""
^ escape_disposition_value filename
^ "\""
in
add_header "Content-Disposition" disposition;
(match part.content_type with
| None -> ()
| Some content_type -> add_header "Content-Type" content_type);
add "\r\n";
add part.body;
add "\r\n"
in
List.iter add_part parts;
add "--";
add boundary;
add "--\r\n";
(boundary, Buffer.contents buffer)
let prepare_body body =
match body with
| Empty -> (headers, None)
| Text text -> (headers, Some (Cohttp_eio.Body.of_string text))
| Json json ->
let =
add_header_unless_exists "content-type" "application/json" headers
in
( headers,
Some
(json |> Chatoyant_runtime.Json.to_string
|> Cohttp_eio.Body.of_string) )
| Multipart parts ->
let boundary, body = encode_multipart parts in
let =
add_header_unless_exists "content-type"
("multipart/form-data; boundary=" ^ boundary)
headers
in
(headers, Some (Cohttp_eio.Body.of_string body))
let perform request =
try
let uri = Uri.of_string request.url in
let , body = prepare_body request.headers request.body in
let = Http.Header.of_list headers in
Eio.Switch.run @@ fun sw ->
let response, body =
Cohttp_eio.Client.call client ~sw ~headers ?body
(Http.Method.of_string request.method_)
uri
in
let body =
body
|> Eio.Buf_read.of_flow ~max_size:max_response_size
|> Eio.Buf_read.take_all
in
Ok
{
status = response |> Http.Response.status |> Http.Status.to_int;
headers = response |> Http.Response.headers |> Http.Header.to_list;
body;
}
with
| Eio.Time.Timeout -> raise Eio.Time.Timeout
| Failure message | Invalid_argument message ->
Error (Invalid_response message)
| exn -> Error (Network (Printexc.to_string exn))
let send request =
match request.timeout_ms with
| Some timeout_ms when timeout_ms > 0 -> (
let seconds = float_of_int timeout_ms /. 1000. in
try
Eio.Time.with_timeout_exn clock seconds (fun () ->
perform request)
with Eio.Time.Timeout -> Error (Timeout timeout_ms))
| _ -> perform request
end : EFFECT)
let send ?https ?max_response_size ~net ~clock request =
let module Http = (val make ?https ?max_response_size ~net ~clock ()) in
Http.send request
let get ?https ?max_response_size ?( = []) ?timeout_ms ~net ~clock url
=
send ?https ?max_response_size ~net ~clock
{ method_ = "GET"; url; headers; body = Empty; timeout_ms }
let get_json ?https ?max_response_size ? ?timeout_ms ~net ~clock url =
match
get ?https ?max_response_size ?headers ?timeout_ms ~net ~clock url
with
| Error _ as err -> err
| Ok response when response.status < 200 || response.status >= 300 ->
Error
(Invalid_response
(Printf.sprintf "HTTP %d: %s" response.status response.body))
| Ok response -> (
match Chatoyant_runtime.Json.parse response.body with
| Ok json -> Ok json
| Error message -> Error (Invalid_response message))
let post_json ?https ?max_response_size ?( = []) ?timeout_ms ~net
~clock url json =
send ?https ?max_response_size ~net ~clock
{ method_ = "POST"; url; headers; body = Json json; timeout_ms }
end
module Websocket = struct
type message = Text of string | Binary of string
type close = { code : int; reason : string }
type request = {
url : string;
headers : (string * string) list;
protocols : string list;
timeout_ms : int option;
}
type error =
| Timeout of int
| Network of string
| Invalid_response of string
| Closed of close option
type connection =
| Connection : {
flow : 'flow Eio.Flow.two_way;
reader : Eio.Buf_read.t;
max_frame_size : int;
mutable closed : close option;
}
-> connection
let error_to_string = function
| Timeout ms -> Printf.sprintf "timeout after %d ms" ms
| Network message -> "network error: " ^ message
| Invalid_response message -> "invalid response: " ^ message
| Closed None -> "websocket closed"
| Closed (Some close) ->
Printf.sprintf "websocket closed with code %d: %s" close.code
close.reason
module type EFFECT =
Chatoyant_runtime.Effect.WEBSOCKET
with type message = message
and type close = close
and type request = request
and type error = error
let default_max_frame_size = 64 * 1024 * 1024
let websocket_guid = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
let lower_ascii = String.lowercase_ascii
let name =
let expected = lower_ascii name in
headers
|> List.find_opt (fun (key, _) -> lower_ascii key = expected)
|> Option.map snd
let contains_token token value =
value |> String.split_on_char ','
|> List.exists (fun item -> lower_ascii (String.trim item) = token)
let random_key () =
Mirage_crypto_rng_unix.use_default ();
Mirage_crypto_rng.generate 16 |> Base64.encode_string
let expected_accept key =
Digestif.SHA1.digest_string (key ^ websocket_guid)
|> Digestif.SHA1.to_raw_string |> Base64.encode_string
let uri =
let host = Option.value (Uri.host uri) ~default:"" in
match Uri.port uri with
| None -> host
| Some port -> host ^ ":" ^ string_of_int port
let endpoint uri =
let path = Uri.path_and_query uri in
if path = "" then "/" else path
let write_flow flow data = Eio.Flow.copy_string data flow
let handshake flow reader request uri key =
let host = host_header uri in
let =
match request.protocols with
| [] -> []
| protocols ->
[ ("Sec-WebSocket-Protocol", String.concat ", " protocols) ]
in
let =
[
("Host", host);
("Upgrade", "websocket");
("Connection", "Upgrade");
("Sec-WebSocket-Key", key);
("Sec-WebSocket-Version", "13");
]
@ protocol_headers @ request.headers
in
let request_text =
"GET " ^ endpoint uri ^ " HTTP/1.1\r\n"
^ (headers
|> List.map (fun (name, value) -> name ^ ": " ^ value ^ "\r\n")
|> String.concat "")
^ "\r\n"
in
write_flow flow request_text;
let status = Eio.Buf_read.line reader in
let rec acc =
match Eio.Buf_read.line reader with
| "" -> List.rev acc
| line -> (
match String.index_opt line ':' with
| None -> read_headers acc
| Some index ->
let name = String.sub line 0 index |> String.trim in
let value =
String.sub line (index + 1) (String.length line - index - 1)
|> String.trim
in
read_headers ((name, value) :: acc))
in
let = read_headers [] in
if
not
(String.starts_with ~prefix:"HTTP/" status && String.contains status '1')
then Error (Invalid_response ("invalid websocket status line: " ^ status))
else if not (String.contains status ' ') then
Error (Invalid_response ("invalid websocket status line: " ^ status))
else if not (String.contains status '1' && String.contains status '0') then
Error (Invalid_response ("websocket upgrade failed: " ^ status))
else
let status_code =
match String.split_on_char ' ' status with
| _http :: code :: _ -> code
| _ -> ""
in
if status_code <> "101" then
Error (Invalid_response ("websocket upgrade failed: " ^ status))
else
match
( header "upgrade" response_headers,
header "connection" response_headers,
header "sec-websocket-accept" response_headers )
with
| Some upgrade, Some connection, Some accept
when lower_ascii upgrade = "websocket"
&& contains_token "upgrade" connection
&& String.trim accept = expected_accept key ->
Ok ()
| _ -> Error (Invalid_response "invalid websocket upgrade response")
let byte value = String.make 1 (Char.chr (value land 0xff))
let uint16 value = byte (value lsr 8) ^ byte value
let uint64 value =
let buffer = Bytes.create 8 in
for index = 0 to 7 do
let shift = (7 - index) * 8 in
Bytes.set buffer index
(Char.chr
(Int64.to_int (Int64.shift_right_logical value shift) land 0xff))
done;
Bytes.unsafe_to_string buffer
let mask_payload mask payload =
let bytes = Bytes.of_string payload in
for index = 0 to Bytes.length bytes - 1 do
let masked =
Char.code (Bytes.get bytes index) lxor Char.code mask.[index mod 4]
in
Bytes.set bytes index (Char.chr masked)
done;
Bytes.unsafe_to_string bytes
let frame ?(mask = true) opcode payload =
let len = String.length payload in
let =
if len < 126 then byte ((if mask then 0x80 else 0) lor len)
else if len <= 0xffff then
byte ((if mask then 0x80 else 0) lor 126) ^ uint16 len
else byte ((if mask then 0x80 else 0) lor 127) ^ uint64 (Int64.of_int len)
in
let first = byte (0x80 lor opcode) in
if mask then
let mask_key = Mirage_crypto_rng.generate 4 in
first ^ length_header ^ mask_key ^ mask_payload mask_key payload
else first ^ length_header ^ payload
let close_payload code reason = uint16 code ^ reason
let send_frame (Connection connection) opcode payload =
if Option.is_some connection.closed then Error (Closed connection.closed)
else
try
write_flow connection.flow (frame opcode payload);
Ok ()
with exn -> Error (Network (Printexc.to_string exn))
let send connection = function
| Text text -> send_frame connection 0x1 text
| Binary bytes -> send_frame connection 0x2 bytes
let parse_close payload =
if String.length payload < 2 then { code = 1005; reason = "" }
else
let code = (Char.code payload.[0] lsl 8) lor Char.code payload.[1] in
let reason = String.sub payload 2 (String.length payload - 2) in
{ code; reason }
let rec read_frame (Connection connection as conn) =
try
let first = Eio.Buf_read.uint8 connection.reader in
let second = Eio.Buf_read.uint8 connection.reader in
let fin = first land 0x80 <> 0 in
let opcode = first land 0x0f in
let masked = second land 0x80 <> 0 in
let length_code = second land 0x7f in
let length =
match length_code with
| value when value < 126 -> Int64.of_int value
| 126 -> Int64.of_int (Eio.Buf_read.BE.uint16 connection.reader)
| 127 -> Eio.Buf_read.BE.uint64 connection.reader
| _ -> 0L
in
if length > Int64.of_int connection.max_frame_size then
Error (Invalid_response "websocket frame exceeds max_frame_size")
else
let mask =
if masked then Some (Eio.Buf_read.take 4 connection.reader) else None
in
let payload =
Eio.Buf_read.take (Int64.to_int length) connection.reader
in
let payload =
match mask with
| None -> payload
| Some mask -> mask_payload mask payload
in
match opcode with
| 0x8 ->
let close = parse_close payload in
connection.closed <- Some close;
Error (Closed (Some close))
| 0x9 ->
ignore (send_frame conn 0xA payload);
read_frame conn
| 0xA -> read_frame conn
| _ -> Ok (fin, opcode, payload)
with
| End_of_file -> Error (Closed None)
| Failure message | Invalid_argument message ->
Error (Invalid_response message)
| exn -> Error (Network (Printexc.to_string exn))
let recv connection =
let rec collect opcode parts =
match read_frame connection with
| Error _ as err -> err
| Ok (fin, frame_opcode, payload) ->
let opcode = if frame_opcode = 0x0 then opcode else frame_opcode in
let parts = payload :: parts in
if fin then
let payload = parts |> List.rev |> String.concat "" in
match opcode with
| 0x1 -> Ok (Text payload)
| 0x2 -> Ok (Binary payload)
| _ -> Error (Invalid_response "unsupported websocket frame opcode")
else collect opcode parts
in
collect 0 []
let close ?(code = 1000) ?(reason = "") (Connection connection as conn) =
match connection.closed with
| Some _ as close -> Error (Closed close)
| None ->
connection.closed <- Some { code; reason };
send_frame conn 0x8 (close_payload code reason)
let with_connection ?(https = Http.System)
?(max_frame_size = default_max_frame_size) ~net ~clock request fn =
let perform () =
Mirage_crypto_rng_unix.use_default ();
let uri = Uri.of_string request.url in
let scheme = uri |> Uri.scheme |> Option.map lower_ascii in
let host =
match Uri.host uri with
| Some host -> host
| None -> invalid_arg "websocket URL must include a host"
in
let service =
match (Uri.port uri, scheme) with
| Some port, _ -> string_of_int port
| None, Some "ws" -> "80"
| None, Some "wss" -> "443"
| _ -> invalid_arg "websocket URL must use ws:// or wss://"
in
Eio.Net.with_tcp_connect ~host ~service net @@ fun raw ->
let with_flow flow =
let reader = Eio.Buf_read.of_flow ~max_size:max_frame_size flow in
let key = random_key () in
match handshake flow reader request uri key with
| Error error -> Error error
| Ok () ->
let connection =
Connection { flow; reader; max_frame_size; closed = None }
in
let result =
try Ok (fn connection)
with exn -> Error (Network (Printexc.to_string exn))
in
ignore (close connection);
result
in
match scheme with
| Some "ws" -> with_flow raw
| Some "wss" -> (
match Http.tls_config_exn https with
| None -> invalid_arg "HTTPS is disabled for wss:// URL"
| Some config -> with_flow (Http.https_wrapper config uri raw))
| _ -> invalid_arg "websocket URL must use ws:// or wss://"
in
match request.timeout_ms with
| Some timeout_ms when timeout_ms > 0 -> (
let seconds = float_of_int timeout_ms /. 1000. in
try Eio.Time.with_timeout_exn clock seconds perform with
| Eio.Time.Timeout -> Error (Timeout timeout_ms)
| Failure message | Invalid_argument message ->
Error (Invalid_response message)
| exn -> Error (Network (Printexc.to_string exn)))
| _ -> (
try perform () with
| Failure message | Invalid_argument message ->
Error (Invalid_response message)
| exn -> Error (Network (Printexc.to_string exn)))
let make ?https ?max_frame_size ~net ~clock () =
(module struct
type nonrec message = message = Text of string | Binary of string
type nonrec close = close = { code : int; reason : string }
type nonrec request = request = {
url : string;
headers : (string * string) list;
protocols : string list;
timeout_ms : int option;
}
type nonrec error = error =
| Timeout of int
| Network of string
| Invalid_response of string
| Closed of close option
type nonrec connection = connection
let with_connection request fn =
with_connection ?https ?max_frame_size ~net ~clock request fn
let send = send
let recv = recv
let close = close
end : EFFECT)
end
module Error = struct
let provider = Chatoyant_provider.Provider.error_to_string
let http = Http.error_to_string
let websocket = Websocket.error_to_string
end
module Noop_http : Chatoyant_runtime.Effect.HTTP = struct
type multipart_part = {
name : string;
filename : string option;
content_type : string option;
body : string;
}
type body =
| Empty
| Text of string
| Json of Chatoyant_runtime.Json.t
| Multipart of multipart_part list
type request = {
method_ : string;
url : string;
headers : (string * string) list;
body : body;
timeout_ms : int option;
}
type response = {
status : int;
headers : (string * string) list;
body : string;
}
type error = Timeout of int | Network of string | Invalid_response of string
let send _ =
Error (Network "noop HTTP module is only used for provider defaults")
end
module Openai_defaults = Chatoyant_provider.Openai.Make_client (Noop_http)
module Anthropic_defaults = Chatoyant_provider.Anthropic.Make_client (Noop_http)
module Xai_defaults = Chatoyant_provider.Xai.Make_client (Noop_http)
module Provider = struct
let http ?https ?max_response_size ~net ~clock () =
Http.make ?https ?max_response_size ~net ~clock ()
let openai ?https ?max_response_size
?(base_url = Openai_defaults.default_base_url) ?timeout_ms ~net ~clock
~api_key () =
let module Http = (val http ?https ?max_response_size ~net ~clock ()) in
let module Provider =
Chatoyant_provider.Openai.Make_provider
(Http)
(struct
let api_key = api_key
let base_url = base_url
let timeout_ms = timeout_ms
end) in
(module Provider : Chatoyant_provider.Provider.CHAT)
let anthropic ?https ?max_response_size
?(base_url = Anthropic_defaults.default_base_url) ?timeout_ms
?( = []) ~net ~clock ~api_key () =
let module Http = (val http ?https ?max_response_size ~net ~clock ()) in
let module Provider =
Chatoyant_provider.Anthropic.Make_provider
(Http)
(struct
let api_key = api_key
let base_url = base_url
let timeout_ms = timeout_ms
let = beta_headers
end) in
(module Provider : Chatoyant_provider.Provider.CHAT)
let xai ?https ?max_response_size ?(base_url = Xai_defaults.default_base_url)
?timeout_ms ~net ~clock ~api_key () =
let module Http = (val http ?https ?max_response_size ~net ~clock ()) in
let module Provider =
Chatoyant_provider.Xai.Make_provider
(Http)
(struct
let api_key = api_key
let base_url = base_url
let timeout_ms = timeout_ms
end) in
(module Provider : Chatoyant_provider.Provider.CHAT)
let openrouter ?https ?max_response_size ?timeout_ms ?http_referer ?title
?( = []) ~net ~clock ~api_key () =
let module Http = (val http ?https ?max_response_size ~net ~clock ()) in
let module Provider =
Chatoyant_provider.Openrouter.Make_provider
(Http)
(struct
let api_key = api_key
let timeout_ms = timeout_ms
let http_referer = http_referer
let title = title
let = headers
end) in
(module Provider : Chatoyant_provider.Provider.CHAT)
let local ?https ?max_response_size ?api_key ?timeout_ms ?( = []) ~net
~clock ~base_url () =
let module Http = (val http ?https ?max_response_size ~net ~clock ()) in
let module Provider =
Chatoyant_provider.Local.Make_provider
(Http)
(struct
let base_url = base_url
let api_key = api_key
let timeout_ms = timeout_ms
let = headers
end) in
(module Provider : Chatoyant_provider.Provider.CHAT)
end
let nonempty = function Some value when value <> "" -> Some value | _ -> None
let api_key_or_env env_key api_key =
match nonempty api_key with
| Some _ as key -> key
| None -> Env.get env_key |> nonempty
let missing_api_key_provider provider env_key =
(module struct
let id = provider
let generate _messages _options =
Error (Chatoyant_provider.Provider.Missing_api_key { provider; env_key })
end : Chatoyant_provider.Provider.CHAT)
module Chat = struct
module type SESSION = sig
type t
val create :
?model:string -> ?defaults:Chatoyant_core.Options.t -> unit -> t
val model : t -> string
val set_model : string -> t -> t
val messages : t -> Chatoyant_core.Message.t list
val tools : t -> Chatoyant_core.Tool.t list
val last_result : t -> Chatoyant_core.Result.generation option
val system : string -> t -> t
val user : string -> t -> t
val assistant : string -> t -> t
val add_message : Chatoyant_core.Message.t -> t -> t
val add_messages : Chatoyant_core.Message.t list -> t -> t
val clear_messages : t -> t
val add_tool : Chatoyant_core.Tool.t -> t -> t
val add_tools : Chatoyant_core.Tool.t list -> t -> t
val clear_tools : t -> t
val generate_with_result :
?options:Chatoyant_core.Options.t ->
t ->
( Chatoyant_core.Result.generation,
Chatoyant_provider.Provider.error )
result
val generate :
?options:Chatoyant_core.Options.t ->
t ->
(string, Chatoyant_provider.Provider.error) result
val stream_accumulate :
?options:Chatoyant_core.Options.t ->
Chatoyant_core.Stream.frame list ->
t ->
Chatoyant_core.Result.generation
val to_json : t -> Chatoyant_runtime.Json.t
val stringify : ?pretty:bool -> t -> string
val load_json : Chatoyant_runtime.Json.t -> t -> (t, string) result
val clone : t -> t
val fork : t -> t
end
type t = {
provider_ : unit -> Chatoyant_provider.Provider.id;
model_ : unit -> string;
set_model_ : string -> t;
messages_ : unit -> Chatoyant_core.Message.t list;
tools_ : unit -> Chatoyant_core.Tool.t list;
last_result_ : unit -> Chatoyant_core.Result.generation option;
system_ : string -> t;
user_ : string -> t;
assistant_ : string -> t;
add_message_ : Chatoyant_core.Message.t -> t;
add_messages_ : Chatoyant_core.Message.t list -> t;
clear_messages_ : unit -> t;
add_tool_ : Chatoyant_core.Tool.t -> t;
add_tools_ : Chatoyant_core.Tool.t list -> t;
clear_tools_ : unit -> t;
generate_with_result_ :
?options:Chatoyant_core.Options.t ->
unit ->
( Chatoyant_core.Result.generation,
Chatoyant_provider.Provider.error )
result;
generate_ :
?options:Chatoyant_core.Options.t ->
unit ->
(string, Chatoyant_provider.Provider.error) result;
stream_accumulate_ :
?options:Chatoyant_core.Options.t ->
Chatoyant_core.Stream.frame list ->
Chatoyant_core.Result.generation;
to_json_ : unit -> Chatoyant_runtime.Json.t;
stringify_ : ?pretty:bool -> unit -> string;
load_json_ : Chatoyant_runtime.Json.t -> (t, string) result;
clone_ : unit -> t;
fork_ : unit -> t;
}
let rec pack_session : type session.
provider_id:Chatoyant_provider.Provider.id ->
(module SESSION with type t = session) ->
session ->
t =
fun ~provider_id (module Session) session ->
let rec chat =
{
provider_ = (fun () -> provider_id);
model_ = (fun () -> Session.model session);
set_model_ =
(fun model ->
ignore (Session.set_model model session);
chat);
messages_ = (fun () -> Session.messages session);
tools_ = (fun () -> Session.tools session);
last_result_ = (fun () -> Session.last_result session);
system_ =
(fun content ->
ignore (Session.system content session);
chat);
user_ =
(fun content ->
ignore (Session.user content session);
chat);
assistant_ =
(fun content ->
ignore (Session.assistant content session);
chat);
add_message_ =
(fun message ->
ignore (Session.add_message message session);
chat);
add_messages_ =
(fun messages ->
ignore (Session.add_messages messages session);
chat);
clear_messages_ =
(fun () ->
ignore (Session.clear_messages session);
chat);
add_tool_ =
(fun tool ->
ignore (Session.add_tool tool session);
chat);
add_tools_ =
(fun tools ->
ignore (Session.add_tools tools session);
chat);
clear_tools_ =
(fun () ->
ignore (Session.clear_tools session);
chat);
generate_with_result_ =
(fun ?options () -> Session.generate_with_result ?options session);
generate_ = (fun ?options () -> Session.generate ?options session);
stream_accumulate_ =
(fun ?options frames ->
Session.stream_accumulate ?options frames session);
to_json_ = (fun () -> Session.to_json session);
stringify_ = (fun ?pretty () -> Session.stringify ?pretty session);
load_json_ =
(fun json ->
match Session.load_json json session with
| Ok _ -> Ok chat
| Error _ as err -> err);
clone_ =
(fun () ->
pack_session ~provider_id (module Session) (Session.clone session));
fork_ =
(fun () ->
pack_session ~provider_id (module Session) (Session.fork session));
}
in
chat
let with_provider ?model ?defaults ~clock provider =
let module Provider = (val provider : Chatoyant_provider.Provider.CHAT) in
let module Clock = (val Clock.make ~clock) in
let module Session_impl = Chatoyant_core.Session.Make (Provider) (Clock) in
let module Session = struct
type t = Chatoyant_core.Session.t
include Session_impl
end in
pack_session ~provider_id:Provider.id
(module Session)
(Session.create ?model ?defaults ())
let openai ?https ?max_response_size ?base_url ?timeout_ms ?model ?defaults
env ?api_key () =
let net = env#net in
let clock = env#clock in
let provider =
match api_key_or_env "OPENAI_API_KEY" api_key with
| Some api_key ->
Provider.openai ?https ?max_response_size ?base_url ?timeout_ms ~net
~clock ~api_key ()
| None -> missing_api_key_provider Openai "OPENAI_API_KEY"
in
with_provider ?model ?defaults ~clock provider
let anthropic ?https ?max_response_size ?base_url ?timeout_ms ?
?model ?defaults env ?api_key () =
let net = env#net in
let clock = env#clock in
let provider =
match api_key_or_env "ANTHROPIC_API_KEY" api_key with
| Some api_key ->
Provider.anthropic ?https ?max_response_size ?base_url ?timeout_ms
?beta_headers ~net ~clock ~api_key ()
| None -> missing_api_key_provider Anthropic "ANTHROPIC_API_KEY"
in
with_provider ?model ?defaults ~clock provider
let xai ?https ?max_response_size ?base_url ?timeout_ms ?model ?defaults env
?api_key () =
let net = env#net in
let clock = env#clock in
let provider =
match api_key_or_env "XAI_API_KEY" api_key with
| Some api_key ->
Provider.xai ?https ?max_response_size ?base_url ?timeout_ms ~net
~clock ~api_key ()
| None -> missing_api_key_provider Xai "XAI_API_KEY"
in
with_provider ?model ?defaults ~clock provider
let openrouter ?https ?max_response_size ?timeout_ms ?http_referer ?title
? ?model ?defaults env ?api_key () =
let net = env#net in
let clock = env#clock in
let provider =
match api_key_or_env "OPENROUTER_API_KEY" api_key with
| Some api_key ->
Provider.openrouter ?https ?max_response_size ?timeout_ms
?http_referer ?title ?headers ~net ~clock ~api_key ()
| None -> missing_api_key_provider Openrouter "OPENROUTER_API_KEY"
in
with_provider ?model ?defaults ~clock provider
let local ?https ?max_response_size ?api_key ?timeout_ms ? ?model
?defaults env ~base_url () =
let net = env#net in
let clock = env#clock in
Provider.local ?https ?max_response_size ?api_key ?timeout_ms ?headers ~net
~clock ~base_url ()
|> with_provider ?model ?defaults ~clock
let provider chat = chat.provider_ ()
let model chat = chat.model_ ()
let set_model model chat = chat.set_model_ model
let messages chat = chat.messages_ ()
let tools chat = chat.tools_ ()
let last_result chat = chat.last_result_ ()
let system content chat = chat.system_ content
let user content chat = chat.user_ content
let assistant content chat = chat.assistant_ content
let add_message message chat = chat.add_message_ message
let add_messages messages chat = chat.add_messages_ messages
let clear_messages chat = chat.clear_messages_ ()
let add_tool tool chat = chat.add_tool_ tool
let add_tools tools chat = chat.add_tools_ tools
let with_tool = add_tool
let with_tools = add_tools
let clear_tools chat = chat.clear_tools_ ()
let options_override ?options ?timeout_ms ?temperature ?max_tokens ? () =
let options =
Option.value options ~default:Chatoyant_core.Options.default
in
{
options with
timeout_ms =
(match timeout_ms with
| Some _ -> timeout_ms
| None -> options.timeout_ms);
temperature =
(match temperature with
| Some _ -> temperature
| None -> options.temperature);
max_tokens =
(match max_tokens with
| Some _ -> max_tokens
| None -> options.max_tokens);
extra = (match extra with Some _ -> extra | None -> options.extra);
}
let generate_with_result ?options ?timeout_ms ?temperature ?max_tokens ?
chat =
let options =
options_override ?options ?timeout_ms ?temperature ?max_tokens ?extra ()
in
chat.generate_with_result_ ~options ()
let generate ?options ?timeout_ms ?temperature ?max_tokens ? chat =
let options =
options_override ?options ?timeout_ms ?temperature ?max_tokens ?extra ()
in
chat.generate_ ~options ()
let prepare_ask ?system:system_prompt ?tools prompt chat =
let chat =
match system_prompt with
| None -> chat
| Some content -> chat.system_ content
in
let chat =
match tools with None -> chat | Some tools -> with_tools tools chat
in
user prompt chat
let ask ?system ?tools ?options ?timeout_ms ?temperature ?max_tokens ?
prompt chat =
chat
|> prepare_ask ?system ?tools prompt
|> generate_with_result ?options ?timeout_ms ?temperature ?max_tokens ?extra
let ask_text ?system ?tools ?options ?timeout_ms ?temperature ?max_tokens
? prompt chat =
chat
|> prepare_ask ?system ?tools prompt
|> generate ?options ?timeout_ms ?temperature ?max_tokens ?extra
let stream_accumulate ?options frames chat =
chat.stream_accumulate_ ?options frames
let to_json chat = chat.to_json_ ()
let stringify ?pretty chat = chat.stringify_ ?pretty ()
let load_json json chat = chat.load_json_ json
let clone chat = chat.clone_ ()
let fork chat = chat.fork_ ()
end
type client = Chat.t
let add_default_messages ?system ?tools chat =
let chat =
match system with None -> chat | Some content -> Chat.system content chat
in
match tools with None -> chat | Some tools -> Chat.with_tools tools chat
let openai ?https ?max_response_size ?base_url ?timeout_ms ?model ?defaults
?api_key ?system ?tools env =
Chat.openai ?https ?max_response_size ?base_url ?timeout_ms ?model ?defaults
env ?api_key ()
|> add_default_messages ?system ?tools
let anthropic ?https ?max_response_size ?base_url ?timeout_ms ?
?model ?defaults ?api_key ?system ?tools env =
Chat.anthropic ?https ?max_response_size ?base_url ?timeout_ms ?beta_headers
?model ?defaults env ?api_key ()
|> add_default_messages ?system ?tools
let xai ?https ?max_response_size ?base_url ?timeout_ms ?model ?defaults
?api_key ?system ?tools env =
Chat.xai ?https ?max_response_size ?base_url ?timeout_ms ?model ?defaults env
?api_key ()
|> add_default_messages ?system ?tools
let openrouter ?https ?max_response_size ?timeout_ms ?http_referer ?title
? ?model ?defaults ?api_key ?system ?tools env =
Chat.openrouter ?https ?max_response_size ?timeout_ms ?http_referer ?title
?headers ?model ?defaults env ?api_key ()
|> add_default_messages ?system ?tools
let local ?https ?max_response_size ?api_key ?timeout_ms ? ?model
?defaults ?system ?tools env ~base_url =
Chat.local ?https ?max_response_size ?api_key ?timeout_ms ?headers ?model
?defaults env ~base_url ()
|> add_default_messages ?system ?tools
let gen_result ?system ?tools ?options ?timeout_ms ?temperature ?max_tokens
? client prompt =
client |> Chat.fork
|> Chat.ask ?system ?tools ?options ?timeout_ms ?temperature ?max_tokens
?extra prompt
let gen_text ?system ?tools ?options ?timeout_ms ?temperature ?max_tokens ?
client prompt =
client |> Chat.fork
|> Chat.ask_text ?system ?tools ?options ?timeout_ms ?temperature ?max_tokens
?extra prompt
let json_string value = Chatoyant_runtime.Json.String value
let json_bool value = Chatoyant_runtime.Json.Bool value
let object_fields = function
| Some (Chatoyant_runtime.Json.Object fields) -> fields
| _ -> []
let remove_json_field name fields =
List.filter (fun (field_name, _) -> field_name <> name) fields
let strict_schema_json schema =
let json = Chatoyant_schema.Schema.to_json_schema schema in
match Chatoyant_schema.Json_schema.Ast.of_json json with
| Error _ -> json
| Ok ast ->
(Chatoyant_schema.Json_schema.Project.openai_strict ast).schema
|> Chatoyant_schema.Json_schema.Ast.to_json
let structured_schema_json ~strict schema =
if strict then strict_schema_json schema
else Chatoyant_schema.Schema.to_json_schema schema
let json_schema_envelope ~name ?description ~strict schema_json =
[
("name", json_string name);
("schema", schema_json);
("strict", json_bool strict);
]
|> (fun fields ->
match description with
| None -> fields
| Some description -> ("description", json_string description) :: fields)
|> List.rev
let openai_text_format ~name ?description ~strict schema_json =
Chatoyant_runtime.Json.Object
[
( "format",
Chatoyant_runtime.Json.Object
([
("type", json_string "json_schema");
("name", json_string name);
("schema", schema_json);
("strict", json_bool strict);
]
|> (fun fields ->
match description with
| None -> fields
| Some description ->
("description", json_string description) :: fields)
|> List.rev) );
]
let chat_response_format ~name ?description ~strict schema_json =
Chatoyant_runtime.Json.Object
[
("type", json_string "json_schema");
( "json_schema",
Chatoyant_runtime.Json.Object
(json_schema_envelope ~name ?description ~strict schema_json) );
]
let provider ?name ?description ~strict schema =
let name = Option.value name ~default:"data" in
let schema_json = structured_schema_json ~strict schema in
match provider with
| Chatoyant_provider.Provider.Openai ->
let fields = extra |> object_fields |> remove_json_field "text" in
Some
(Chatoyant_runtime.Json.Object
(("text", openai_text_format ~name ?description ~strict schema_json)
:: fields))
| Xai | Local | Openrouter ->
let fields =
extra |> object_fields |> remove_json_field "response_format"
in
Some
(Chatoyant_runtime.Json.Object
(( "response_format",
chat_response_format ~name ?description ~strict schema_json )
:: fields))
| Anthropic -> extra
let structured_instruction schema =
let schema_json = Chatoyant_schema.Schema.to_json_schema schema in
"Return only valid JSON matching this JSON Schema. Do not wrap it in Markdown.\n"
^ Chatoyant_runtime.Json.to_string schema_json
let append_system base addition =
match base with
| None -> Some addition
| Some base when String.trim base = "" -> Some addition
| Some base -> Some (base ^ "\n\n" ^ addition)
let parse_json_text text =
let trimmed = String.trim text in
match Chatoyant_runtime.Json.parse trimmed with
| Ok _ as ok -> ok
| Error first_error ->
let len = String.length trimmed in
if
len >= 6
&& String.sub trimmed 0 3 = "```"
&& String.sub trimmed (len - 3) 3 = "```"
then
match String.index_opt trimmed '\n' with
| Some start when len > start + 4 ->
let body =
String.sub trimmed (start + 1) (len - start - 4) |> String.trim
in
Chatoyant_runtime.Json.parse body
| _ -> Error first_error
else Error first_error
let gen_data ?name ?description ?(strict = true) ~codec ?system ?tools ?options
?timeout_ms ?temperature ?max_tokens ? client prompt =
let schema = Chatoyant_schema.Codec.schema codec in
let provider = Chat.provider client in
let =
structured_extra provider ?name ?description ~strict schema extra
in
let system =
match provider with
| Chatoyant_provider.Provider.Anthropic | Local ->
append_system system (structured_instruction schema)
| Openai | Xai | Openrouter -> system
in
match
gen_text ?system ?tools ?options ?timeout_ms ?temperature ?max_tokens ?extra
client prompt
with
| Error _ as err -> err
| Ok text -> (
match parse_json_text text with
| Error message ->
Error (Chatoyant_provider.Provider.Decode_error message)
| Ok json -> (
match Chatoyant_schema.Value.validate schema json with
| Error error ->
Error
(Chatoyant_provider.Provider.Decode_error
(Chatoyant_schema.Value.error_to_string error))
| Ok () -> (
match Chatoyant_schema.Codec.decode codec json with
| Ok value -> Ok value
| Error message ->
Error (Chatoyant_provider.Provider.Decode_error message))))
module Generate = struct
let with_provider ?(options = Chatoyant_core.Options.default) ~clock ~provider
chat =
let module Provider = (val provider : Chatoyant_provider.Provider.CHAT) in
let module Clock = (val Clock.make ~clock) in
let module Generator = Chatoyant_core.Generator.Make (Provider) (Clock) in
Generator.generate ~options chat
end