package async_kernel
Monadic concurrency library
Install
Dune Dependency
Authors
Maintainers
Sources
v0.17.0.tar.gz
sha256=01ced973dbc70535f692f38bed524ae82dba17e26e58791b2fbf0d647b160d2e
doc/src/async_kernel.persistent_connection_kernel/persistent_connection_kernel.ml.html
Source file persistent_connection_kernel.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
open! Core open! Async_kernel open! Async_kernel_require_explicit_time_source include Persistent_connection_kernel_intf module Event = Event module Event_handler = struct type ('conn, 'conn_error, 'address) t = { server_name : string ; on_event : ('conn, 'conn_error, 'address) Event.t -> unit Deferred.t } [@@deriving sexp_of] let handle t { server_name = _; on_event } = on_event t end (* This position shows up in tests in a way that is difficult to suppress, so we define it here in a place that is unlikely to change very often *) let dummy_src_pos_that_shows_up_in_tests = [%here] module Make' (Conn_err : Connection_error) (Conn : Closable) = struct module Conn = struct include Conn let sexp_of_t (_ : t) : Sexp.t = Atom "<Conn.t>" end type conn = Conn.t type conn_error = Conn_err.t [@@deriving sexp_of] module Event = struct type 'address t = (Conn.t, Conn_err.t, 'address) Event.t [@@deriving sexp_of] end (* We use this helper type instead of calling [Conn_err.of_exception_error] so that we can reliably call [same_error] on exceptions raised in [connect]: If [Conn_err.to_error (Conn_err.of_exception_error err)] doesn't roundtrip then [same_error] may not correctly discard the backtrace and we could have noisy logs *) module Conn_error_or_exception = struct type t = | Conn_error of conn_error | Exception of Error.t [@@deriving sexp_of] (* This function focuses in on the the error itself, discarding information about which monitor caught the error, if any. If we don't do this, we sometimes end up with noisy logs which report the same error again and again, differing only as to what monitor caught them. *) let same_error e1 e2 = let to_sexp e = Exn.sexp_of_t (Monitor.extract_exn (Error.to_exn e)) in Sexp.equal (to_sexp e1) (to_sexp e2) ;; let equal e1 e2 = match e1, e2 with | Conn_error e1, Conn_error e2 -> Conn_err.equal e1 e2 | Exception e1, Exception e2 -> same_error e1 e2 | _ -> false ;; let join = function | Ok (Ok result) -> Ok result | Ok (Error conn_error) -> Error (Conn_error conn_error) | Error exn -> Error (Exception exn) ;; let to_conn_error = function | Conn_error conn_error -> conn_error | Exception err -> Conn_err.of_exception_error err ;; let to_error = function | Conn_error conn_error -> Conn_err.to_error conn_error | Exception err -> err ;; end (* A persistent connection that is polymorphic in the address type. We hide away this type later since it only appears in the type of [create]. *) module Poly = struct type 'address t = { get_address : unit -> ('address, conn_error) Result.t Deferred.t ; connect : 'address -> (Conn.t, conn_error) Result.t Deferred.t ; retry_delay : unit -> unit Deferred.t ; mutable conn : [ `Ok of Conn.t | `Close_started ] Ivar.t ; mutable next_connect_result : (Conn.t, Conn_error_or_exception.t) Result.t Ivar.t ; event_handler : (Conn.t, conn_error, 'address) Event_handler.t ; event_bus : (unit Event.t -> unit, read_write) Bus.t ; close_started : unit Ivar.t ; close_finished : unit Ivar.t ; don't_reconnect : unit Ivar.t ; address_equal : 'address -> 'address -> bool ; sexp_of_address : 'address -> Sexp.t } [@@deriving sexp_of] let server_name t = t.event_handler.server_name let handle_event (type address) t (event : address Event.t) = Bus.write t.event_bus (match event with | Obtained_address (_ : address) -> Obtained_address () | Attempting_to_connect -> Attempting_to_connect | Failed_to_connect e -> Failed_to_connect e | Connected conn -> Connected conn | Disconnected -> Disconnected); Event_handler.handle event t.event_handler ;; (* Continue trying to connect until we are able to do so, in which case we return both the new connection and a deferred that will become determined once we are ready for the next reconnection attempt. *) let try_connecting_until_successful t = (* We take care not to spam logs with the same message over and over by comparing each log message the the previous one of the same type. *) let previous_address = ref None in let previous_error = ref None in let connect () = t.get_address () >>= function | Error e -> return (Error e) | Ok addr -> let same_as_previous_address = match !previous_address with | None -> false | Some previous_address -> t.address_equal addr previous_address in previous_address := Some addr; (if same_as_previous_address then Deferred.unit else handle_event t (Obtained_address addr)) >>= fun () -> t.connect addr in let connect () = (* Catch exceptions raised by the user-provided [t.get_address] or [t.connect] *) Deferred.Or_error.try_with ~extract_exn:am_running_test connect >>| Conn_error_or_exception.join in let rec loop () = if Ivar.is_full t.close_started then ( Ivar.fill_exn t.conn `Close_started; return `Close_started) else if Ivar.is_full t.don't_reconnect then return `Don't_reconnect else ( let ready_to_retry_connecting = t.retry_delay () in let%bind connect_result = connect () in Ivar.fill_exn t.next_connect_result connect_result; t.next_connect_result <- Ivar.create (); match connect_result with | Ok conn -> Ivar.fill_exn t.conn (`Ok conn); return (`Ok (conn, ready_to_retry_connecting)) | Error err -> let same_as_previous_error = match !previous_error with | None -> false | Some previous_err -> Conn_error_or_exception.equal err previous_err in previous_error := Some err; (if same_as_previous_error then Deferred.unit else ( let err = Conn_error_or_exception.to_conn_error err in handle_event t (Failed_to_connect err))) >>= fun () -> Deferred.any [ ready_to_retry_connecting ; Ivar.read t.close_started ; Ivar.read t.don't_reconnect ] >>= fun () -> loop ()) in loop () ;; let abort_reconnecting_with_no_active_connection t = Ivar.fill_exn t.close_started (); Ivar.fill_exn t.close_finished (); Ivar.fill_exn t.conn `Close_started ;; let create (type address) ~server_name ?(on_event = fun _ -> Deferred.unit) ?retry_delay ?(random_state = `State Random.State.default) ?(time_source = Time_source.wall_clock ()) ~connect ~address:(module Address : Address with type t = address) get_address = let event_handler = { Event_handler.server_name; on_event } in let default_retry_delay = Fn.const (Time_ns.Span.of_sec (if am_running_test then 0.1 else 10.)) in let non_randomized_delay = Option.value retry_delay ~default:default_retry_delay in let retry_delay_span = match random_state with | `Non_random -> non_randomized_delay | `State random_state -> fun () -> let span = non_randomized_delay () in let span = Time_ns.Span.to_sec span in let distance = Random.State.float random_state (span *. 0.3) in let wait = if Random.State.bool random_state then span +. distance else span -. distance in Time_ns.Span.of_sec wait in let retry_delay () = Time_source.after time_source (retry_delay_span ()) in let t = { event_handler ; event_bus = Bus.create_exn (if am_running_test then dummy_src_pos_that_shows_up_in_tests else [%here]) Arity1 ~on_subscription_after_first_write:Allow_and_send_last_value ~on_callback_raise:ignore ; get_address ; connect ; next_connect_result = Ivar.create () ; retry_delay ; conn = Ivar.create () ; close_started = Ivar.create () ; close_finished = Ivar.create () ; don't_reconnect = Ivar.create () ; address_equal = Address.equal ; sexp_of_address = Address.sexp_of_t } in (* this loop finishes once [close t] has been called, in which case it makes sure to leave [t.conn] filled with [`Close_started]. *) don't_wait_for @@ Deferred.repeat_until_finished () (fun () -> let%bind () = handle_event t Attempting_to_connect in match%bind try_connecting_until_successful t with | `Close_started -> return (`Finished ()) | `Don't_reconnect -> abort_reconnecting_with_no_active_connection t; return (`Finished ()) | `Ok (conn, ready_to_retry_connecting) -> let%bind () = handle_event t (Connected conn) in let%bind () = Conn.close_finished conn in t.conn <- Ivar.create (); let%bind () = handle_event t Disconnected in (* waits until [retry_delay ()] time has passed since the time just before we last tried to connect rather than the time we noticed being disconnected, so that if a long-lived connection dies, we will attempt to reconnect immediately. *) let%map () = Deferred.any [ ready_to_retry_connecting ; Ivar.read t.close_started ; Ivar.read t.don't_reconnect ] in if Ivar.is_full t.close_started then ( Ivar.fill_exn t.conn `Close_started; `Finished ()) else if Ivar.is_full t.don't_reconnect then ( abort_reconnecting_with_no_active_connection t; `Finished ()) else `Repeat ()); t ;; let connected t = (* Take care not to return a connection that is known to be closed at the time [connected] was called. This could happen in client code that behaves like {[ Persistent_connection.Rpc.connected t >>= fun c1 -> ... Rpc.Connection.close_finished c1 (* at this point we are in a race with the same call inside persistent_client.ml *) >>= fun () -> Persistent_connection.Rpc.connected t (* depending on how the race turns out, we don't want to get a closed connection here *) >>= fun c2 -> ... ]} This doesn't remove the race condition, but it makes it less likely to happen. *) let rec loop () = let d = Ivar.read t.conn in match Deferred.peek d with | None -> d >>= (function | `Close_started -> Deferred.never () | `Ok conn -> return conn) | Some `Close_started -> Deferred.never () | Some (`Ok conn) -> if Conn.is_closed conn then (* give the reconnection loop a chance to overwrite the ivar *) Conn.close_finished conn >>= loop else return conn in loop () ;; let current_connection t = match Deferred.peek (Ivar.read t.conn) with | None | Some `Close_started -> None | Some (`Ok conn) -> Some conn ;; let close_finished t = Ivar.read t.close_finished let is_closed t = Ivar.is_full t.close_started let close t = if Ivar.is_full t.close_started then (* Another call to close is already in progress. Wait for it to finish. *) close_finished t else ( Ivar.fill_exn t.close_started (); Ivar.read t.conn >>= fun conn_opt -> (match conn_opt with | `Close_started -> Deferred.unit | `Ok conn -> Conn.close conn) >>| fun () -> Ivar.fill_exn t.close_finished ()) ;; let connected_or_failed_to_connect_connection_closed = Or_error.error_s [%message "Persistent connection closed"] ;; let connected_or_failed_to_connect t = if is_closed t then return connected_or_failed_to_connect_connection_closed else ( match current_connection t with | Some x when not (Conn.is_closed x) -> return (Ok x) | Some (_ : Conn.t) | None -> Deferred.choose [ choice (Ivar.read t.close_started) (fun () -> connected_or_failed_to_connect_connection_closed) ; choice (Ivar.read t.next_connect_result) (Result.map_error ~f:Conn_error_or_exception.to_error) ]) ;; let close_when_current_connection_is_closed t = Ivar.fill_if_empty t.don't_reconnect () ;; end type t = T : 'address Poly.t -> t [@@unboxed] let sexp_of_t (T t) = Poly.sexp_of_t t.sexp_of_address t let close_when_current_connection_is_closed (T t) = Poly.close_when_current_connection_is_closed t ;; let close_finished (T t) = Poly.close_finished t let is_closed (T t) = Poly.is_closed t let event_bus (T t) = Bus.read_only t.event_bus let close (T t) = Poly.close t let server_name (T t) = Poly.server_name t let current_connection (T t) = Poly.current_connection t let connected_or_failed_to_connect (T t) = Poly.connected_or_failed_to_connect t let connected (T t) = Poly.connected t let create ~server_name ?on_event ?retry_delay ?random_state ?time_source ~connect ~address get_address = T (Poly.create ~server_name ?on_event ?retry_delay ?random_state ?time_source ~connect ~address get_address) ;; end module Make (Conn : Closable) = Make' (struct type t = Error.t [@@deriving equal, sexp_of] let of_exception_error e = e let to_error e = e end) (Conn)
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>