Source file implementation.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
open Core
open Async_kernel
open Protocol
open Implementation_types.Implementation

module Expert = struct
  module Responder = struct
    type t = Expert.Responder.t =
      { query_id : Query_id.t
      ; writer : Protocol_writer.t
      ; mutable responded : bool
      }
    [@@deriving sexp_of]

    let create query_id writer = { query_id; writer; responded = false }
  end

  type implementation_result = Expert.implementation_result =
    | Replied
    | Delayed_response of unit Deferred.t
end

module F = struct
  type 'a error_mode = 'a F.error_mode =
    | Always_ok : _ error_mode
    | Using_result : (_, _) Result.t error_mode
    | Using_result_result : ((_, _) Result.t, _) Result.t error_mode
    | Is_error : ('a -> bool) -> 'a error_mode
    | Streaming_initial_message : (_, _) Protocol.Stream_initial_message.t error_mode

  type ('a, 'b) result_mode = ('a, 'b) F.result_mode =
    | Blocking : ('a, 'a Or_not_authorized.t) result_mode
    | Deferred : ('a, 'a Or_not_authorized.t Deferred.t) result_mode

  type ('connection_state, 'query, 'init, 'update) streaming_impl =
        ('connection_state, 'query, 'init, 'update) F.streaming_impl =
    | Pipe of
        ('connection_state
         -> 'query
         -> ('init * 'update Pipe.Reader.t, 'init) Result.t Or_not_authorized.t Deferred.t)
    | Direct of
        ('connection_state
         -> 'query
         -> 'update Implementation_types.Direct_stream_writer.t
         -> ('init, 'init) Result.t Or_not_authorized.t Deferred.t)

  type ('connection_state, 'query, 'init, 'update) streaming_rpc =
        ('connection_state, 'query, 'init, 'update) F.streaming_rpc =
    { bin_query_reader : 'query Bin_prot.Type_class.reader
    ; bin_init_writer : 'init Bin_prot.Type_class.writer
    ; bin_update_writer : 'update Bin_prot.Type_class.writer
        (* 'init can be an error or an initial state *)
    ; impl : ('connection_state, 'query, 'init, 'update) streaming_impl
    ; error_mode : 'init error_mode
    }

  type 'connection_state t = 'connection_state F.t =
    | One_way :
        'msg Bin_prot.Type_class.reader
        * ('connection_state -> 'msg -> unit Or_not_authorized.t Deferred.t)
        -> 'connection_state t
    | One_way_expert :
        ('connection_state
         -> Bigstring.t
         -> pos:int
         -> len:int
         -> unit Or_not_authorized.t Deferred.t)
        -> 'connection_state t
    | Rpc :
        'query Bin_prot.Type_class.reader
        * 'response Bin_prot.Type_class.writer
        * ('connection_state -> 'query -> 'result)
        * 'response error_mode
        * ('response, 'result) result_mode
        -> 'connection_state t
    | Rpc_expert :
        ('connection_state
         -> Expert.Responder.t
         -> Bigstring.t
         -> pos:int
         -> len:int
         -> 'result)
        * (Expert.implementation_result, 'result) result_mode
        -> 'connection_state t
    | Streaming_rpc :
        ('connection_state, 'query, 'init, 'update) streaming_rpc
        -> 'connection_state t
    | Legacy_menu_rpc : Menu.Stable.V2.response Lazy.t -> 'connection_state t

  let sexp_of_t _ = function
    | One_way_expert _ | One_way _ -> [%message "one-way"]
    | Rpc_expert _ | Rpc _ | Legacy_menu_rpc _ -> [%message "rpc"]
    | Streaming_rpc _ -> [%message "streaming-rpc"]
  ;;

  let lift t ~f =
    match t with
    | One_way (bin_msg, impl) ->
      let impl state str =
        Or_not_authorized.bind_deferred (f state) ~f:(fun authorized_state ->
          impl authorized_state str)
      in
      One_way (bin_msg, impl)
    | One_way_expert impl ->
      One_way_expert
        (fun state buf ~pos ~len ->
          Or_not_authorized.bind_deferred (f state) ~f:(fun authorized_state ->
            impl authorized_state buf ~pos ~len))
    | Rpc (bin_query, bin_response, impl, error, Blocking) ->
      let impl state q =
        Or_not_authorized.bind (f state) ~f:(fun authorized_state ->
          impl authorized_state q)
      in
      Rpc (bin_query, bin_response, impl, error, Blocking)
    | Rpc (bin_query, bin_response, impl, error, Deferred) ->
      let impl state q =
        Or_not_authorized.bind_deferred (f state) ~f:(fun authorized_state ->
          impl authorized_state q)
      in
      Rpc (bin_query, bin_response, impl, error, Deferred)
    | Legacy_menu_rpc impl -> Legacy_menu_rpc impl
    | Rpc_expert (impl, Blocking) ->
      let impl state resp buf ~pos ~len =
        Or_not_authorized.bind (f state) ~f:(fun authorized_state ->
          impl authorized_state resp buf ~pos ~len)
      in
      Rpc_expert (impl, Blocking)
    | Rpc_expert (impl, Deferred) ->
      let impl state resp buf ~pos ~len =
        Or_not_authorized.bind_deferred (f state) ~f:(fun authorized_state ->
          impl authorized_state resp buf ~pos ~len)
      in
      Rpc_expert (impl, Deferred)
    | Streaming_rpc
        { bin_query_reader; bin_init_writer; bin_update_writer; impl; error_mode } ->
      let impl =
        match impl with
        | Pipe impl ->
          Pipe
            (fun state q ->
              Or_not_authorized.bind_deferred (f state) ~f:(fun authorized_state ->
                impl authorized_state q))
        | Direct impl ->
          Direct
            (fun state q w ->
              Or_not_authorized.bind_deferred (f state) ~f:(fun authorized_state ->
                impl authorized_state q w))
      in
      Streaming_rpc
        { bin_query_reader; bin_init_writer; bin_update_writer; impl; error_mode }
  ;;

  let lift_deferred (type a b) (t : b t) ~f:(lift : a -> b Or_not_authorized.t Deferred.t)
    : a t
    =
    let lift_and_bind x ~f =
      Eager_deferred.bind (lift x) ~f:(fun or_not_authorized ->
        Or_not_authorized.bind_deferred or_not_authorized ~f)
    in
    match t with
    | One_way (bin_msg, impl) ->
      One_way
        (bin_msg, fun state str -> lift_and_bind state ~f:(fun state -> impl state str))
    | One_way_expert impl ->
      One_way_expert
        (fun state buf ~pos ~len ->
          lift_and_bind state ~f:(fun state -> impl state buf ~pos ~len))
    | Rpc (bin_query, bin_response, impl, error, Blocking) ->
      Rpc
        ( bin_query
        , bin_response
        , (fun state q -> lift_and_bind state ~f:(fun state -> return (impl state q)))
        , error
        , Deferred )
    | Rpc (bin_query, bin_response, impl, error, Deferred) ->
      Rpc
        ( bin_query
        , bin_response
        , (fun state q -> lift_and_bind state ~f:(fun state -> impl state q))
        , error
        , Deferred )
    | Legacy_menu_rpc impl -> Legacy_menu_rpc impl
    | Rpc_expert (impl, Deferred) ->
      Rpc_expert
        ( (fun state resp buf ~pos ~len ->
            lift_and_bind state ~f:(fun state -> impl state resp buf ~pos ~len))
        , Deferred )
    | Rpc_expert (impl, Blocking) ->
      Rpc_expert
        ( (fun state resp buf ~pos ~len ->
            lift_and_bind state ~f:(fun state -> return (impl state resp buf ~pos ~len)))
        , Deferred )
    | Streaming_rpc
        { bin_query_reader; bin_init_writer; bin_update_writer; impl; error_mode } ->
      let impl =
        match impl with
        | Pipe impl ->
          Pipe (fun state q -> lift_and_bind state ~f:(fun state -> impl state q))
        | Direct impl ->
          Direct (fun state q w -> lift_and_bind state ~f:(fun state -> impl state q w))
      in
      Streaming_rpc
        { bin_query_reader; bin_init_writer; bin_update_writer; impl; error_mode }
  ;;
end

module Shapes_and_digests = struct
  (* The sexp of Rpc_shapes is the same as the sexp of the digests, so only include them
     once *)
  type t = Rpc_shapes.t * Rpc_shapes.Just_digests.t

  let sexp_of_t ((_, digests) : t) = [%sexp_of: Rpc_shapes.Just_digests.t] digests
end

type 'connection_state t = 'connection_state Implementation_types.Implementation.t =
  { tag : Rpc_tag.t
  ; version : int
  ; f : 'connection_state F.t
  ; shapes : Shapes_and_digests.t Lazy.t
  ; on_exception : On_exception.t
  }
[@@deriving sexp_of]

let description t = { Description.name = Rpc_tag.to_string t.tag; version = t.version }
let shapes t = fst (force t.shapes)
let digests t = snd (force t.shapes)

let lift (type a b) (t : a t) ~(f : b -> a) : b t =
  { t with f = F.lift t.f ~f:(fun b -> Or_not_authorized.Authorized (f b)) }
;;

let with_authorization t ~f = { t with f = F.lift t.f ~f }

let lift_deferred t ~f =
  { t with
    f =
      F.lift_deferred t.f ~f:(fun b ->
        Eager_deferred.map (f b) ~f:(fun x -> Or_not_authorized.Authorized x))
  }
;;

let with_authorization_deferred t ~f = { t with f = F.lift_deferred t.f ~f }
let update_on_exception t ~f = { t with on_exception = f t.on_exception }