Source file gapiRequest.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 GapiUtils.Infix
open GapiLens.Infix
module Option = GapiOption
exception Redirect of string * GapiConversation.Session.t
exception NotModified of GapiConversation.Session.t
exception
BadRequest of GapiConversation.Session.t * int * GapiPipe.OcamlnetPipe.t
exception
Unauthorized of GapiConversation.Session.t * int * GapiPipe.OcamlnetPipe.t
exception PermissionDenied of GapiConversation.Session.t
exception
Forbidden of GapiConversation.Session.t * int * GapiPipe.OcamlnetPipe.t
exception NotFound of GapiConversation.Session.t * int * GapiPipe.OcamlnetPipe.t
exception RequestTimeout of GapiConversation.Session.t
exception Conflict of GapiConversation.Session.t
exception Gone of GapiConversation.Session.t
exception PreconditionFailed of GapiConversation.Session.t
exception
TooManyRequests of GapiConversation.Session.t * int * GapiPipe.OcamlnetPipe.t
exception ResumeIncomplete of string * string * GapiConversation.Session.t
exception StartUpload of string * GapiConversation.Session.t
exception
InternalServerError of
GapiConversation.Session.t * int * GapiPipe.OcamlnetPipe.t
exception
BadGateway of GapiConversation.Session.t * int * GapiPipe.OcamlnetPipe.t
exception
ServiceUnavailable of
GapiConversation.Session.t * int * GapiPipe.OcamlnetPipe.t
exception
GatewayTimeout of GapiConversation.Session.t * int * GapiPipe.OcamlnetPipe.t
exception RefreshTokenFailed of GapiConversation.Session.t
type request_type = Query | Create | Update | Patch | Delete | QueryMeta
let string_of_request_type = function
| Query -> "Query"
| Create -> "Create"
| Update -> "Update"
| Patch -> "Patch"
| Delete -> "Delete"
| QueryMeta -> "QueryMeta"
let parse_empty_response _ = ()
let parse_response parse_output parse_error pipe response_code session =
let get_location () =
List.fold_left
(fun u h ->
match h with GapiCore.Header.Location value -> value | _ -> u)
"" headers
in
let get_reason_phrase () =
List.fold_left
(fun u h ->
match h with
| GapiCore.Header.HttpStatus (_, _, reason) -> reason
| _ -> u)
"" headers
in
match response_code with
| 200 ->
let location = get_location () in
if location = "" then parse_output pipe headers
else raise (StartUpload (location, session))
| 201 | 204 | 206 ->
parse_output pipe headers
| 301
| 302
| 303
| 307 ->
let url = get_location () in
raise (Redirect (url, session))
| 304 -> raise (NotModified session)
| 308 ->
let range, url =
List.fold_left
(fun ((r, u) as accu) h ->
match h with
| GapiCore.Header.Location value -> (r, value)
| GapiCore.Header.Range value -> (value, u)
| _ -> accu)
("", "") headers
in
raise (ResumeIncomplete (range, url, session))
| 400 -> raise (BadRequest (session, response_code, pipe))
| 401 -> (
let reason_phrase = get_reason_phrase () in
match reason_phrase with
| "Permission denied" ->
raise (PermissionDenied session)
| _ -> raise (Unauthorized (session, response_code, pipe)))
| 403 -> raise (Forbidden (session, response_code, pipe))
| 404 -> raise (NotFound (session, response_code, pipe))
| 408 -> raise (RequestTimeout session)
| 409 -> raise (Conflict session)
| 410 -> raise (Gone session)
| 412 -> raise (PreconditionFailed session)
| 429 ->
raise (TooManyRequests (session, response_code, pipe))
| 500 ->
raise (InternalServerError (session, response_code, pipe))
| 502 -> raise (BadGateway (session, response_code, pipe))
| 503 ->
raise (ServiceUnavailable (session, response_code, pipe))
| 504 ->
raise (GatewayTimeout (session, response_code, pipe))
| _ -> parse_error pipe response_code session
let build_auth_data session =
match session.GapiConversation.Session.config.GapiConfig.auth with
| GapiConfig.NoAuth -> GapiAuth.NoAuth
| GapiConfig.ClientLogin _ ->
let token =
session |. GapiConversation.Session.auth
|. GapiConversation.Session.client_login |. GapiLens.option_get
in
GapiAuth.ClientLogin token
| GapiConfig.OAuth1
{ GapiConfig.signature_method; consumer_key; consumer_secret } ->
let { GapiConversation.Session.token; secret } =
session |. GapiConversation.Session.auth
|. GapiConversation.Session.oauth1 |. GapiLens.option_get
in
GapiAuth.OAuth1
{
GapiAuth.signature_method;
consumer_key;
consumer_secret;
token;
secret;
}
| GapiConfig.OAuth2
{ GapiConfig.client_id; client_secret; refresh_access_token } ->
let { GapiConversation.Session.oauth2_token; refresh_token } =
session |. GapiConversation.Session.auth
|. GapiConversation.Session.oauth2 |. GapiLens.option_get
in
GapiAuth.OAuth2
{
GapiAuth.client_id;
client_secret;
oauth2_token;
refresh_token;
refresh_access_token;
}
| GapiConfig.OAuth2ServiceAccount
{
GapiConfig.service_account_credentials_json;
scopes;
user_to_impersonate;
refresh_service_account_access_token;
} ->
let { GapiConversation.Session.oauth2_token; _ } =
session |. GapiConversation.Session.auth
|. GapiConversation.Session.oauth2 |. GapiLens.option_get
in
GapiAuth.OAuth2ServiceAccount
{
GapiAuth.service_account_credentials_json;
scopes;
user_to_impersonate;
oauth2_service_account_token = oauth2_token;
refresh_service_account_access_token;
}
let single_request ?post_data ?version ?etag ?upload_state ?media_download
?( = []) request_type url parse_output parse_error session =
let auth_data = build_auth_data session in
let http_method =
match request_type with
| Query -> (
match post_data with
| None -> GapiCore.HttpMethod.GET
| Some _ -> GapiCore.HttpMethod.POST)
| Create -> GapiCore.HttpMethod.POST
| Update -> GapiCore.HttpMethod.PUT
| Patch -> GapiCore.HttpMethod.PATCH
| Delete -> GapiCore.HttpMethod.DELETE
| QueryMeta -> GapiCore.HttpMethod.HEAD
in
let oauth1_params =
match auth_data with
| GapiAuth.NoAuth | GapiAuth.ClientLogin _ | GapiAuth.OAuth2 _
| GapiAuth.OAuth2ServiceAccount _ ->
None
| GapiAuth.OAuth1 _ ->
let post_fields_to_sign =
match post_data with
| Some (GapiCore.PostData.Fields fields) -> fields
| _ -> []
in
Some { GapiAuth.http_method; url; post_fields_to_sign }
in
let =
Option.map
(fun a -> GapiCore.Header.Authorization a)
(GapiAuth.generate_authorization_header ?oauth1_params auth_data)
in
let =
Option.map (fun v -> GapiCore.Header.GdataVersion v) version
in
let =
Option.map
(fun e ->
match request_type with
| Query | QueryMeta -> Some (GapiCore.Header.IfNoneMatch e)
| Update | Patch | Delete ->
if GapiUtils.is_weak_etag e then None
else Some (GapiCore.Header.IfMatch e)
| Create -> None)
etag
|> Option.value ~default:None
in
let =
[ authorization_header; version_header; etag_header ]
|> List.filter Option.is_some |> List.map Option.get
in
let =
GapiUtils.option_map_default
(GapiMediaResource.generate_upload_headers http_method)
[] upload_state
in
let =
GapiUtils.option_map_default GapiMediaResource.generate_download_headers []
media_download
in
let =
headers @ upload_headers @ download_headers @ custom_headers
in
GapiConversation.request ~header_list ?post_data ?media_download http_method
session url
(parse_response parse_output parse_error)
let refresh_oauth2_token session =
let auth_data = build_auth_data session in
match auth_data with
| GapiAuth.OAuth2
{
GapiAuth.client_id;
client_secret;
refresh_token;
refresh_access_token;
_;
} ->
if
(client_id = "" || client_secret = "" || refresh_token = "")
&& refresh_access_token = None
then raise (RefreshTokenFailed session);
let access_token, new_session =
match refresh_access_token with
| None -> (
let response, new_session =
GapiOAuth2.refresh_access_token ~client_id ~client_secret
~refresh_token session
in
match response with
| GapiAuthResponse.OAuth2AccessToken token ->
(token.GapiAuthResponse.OAuth2.access_token, new_session)
| _ -> failwith "Not supported OAuth2 response")
| Some refresh ->
let access_token = refresh () in
(access_token, session)
in
new_session
|> GapiConversation.Session.auth ^%= GapiConversation.Session.oauth2
^%= GapiLens.option_get ^%= GapiConversation.Session.oauth2_token
^= access_token
| GapiAuth.OAuth2ServiceAccount
{
GapiAuth.service_account_credentials_json;
scopes;
user_to_impersonate;
refresh_service_account_access_token;
_;
} ->
if
(service_account_credentials_json = "" || List.length scopes = 0)
&& refresh_service_account_access_token = None
then raise (RefreshTokenFailed session);
let access_token, new_session =
match refresh_service_account_access_token with
| None -> (
let response, new_session =
GapiOAuth2ServiceAccount.get_access_token ?user_to_impersonate
~service_account_credentials_json ~scopes session
in
match response with
| GapiAuthResponse.OAuth2AccessToken token ->
(token.GapiAuthResponse.OAuth2.access_token, new_session)
| _ ->
failwith "Not supported OAuth2 (for service accounts) response")
| Some refresh ->
let access_token = refresh () in
(access_token, session)
in
new_session
|> GapiConversation.Session.auth ^%= GapiConversation.Session.oauth2
^%= GapiLens.option_get ^%= GapiConversation.Session.oauth2_token
^= access_token
| _ -> failwith "Bug: refresh_oauth2_token"
let gapi_request ?post_data ?version ?etag ?media_source ?media_download
? ?(parse_error = GapiConversation.parse_error) request_type
url parse_output session =
let rec request_loop ?post_data ?current_upload_state request_type
request_number url session =
let retry_on_error max_request_number exponential_backoff current_exception
update_session new_session =
if request_number > max_request_number then raise current_exception
else
let updated_session = update_session new_session in
let new_upload_state =
Option.map
(fun u ->
match u.GapiMediaResource.state with
| GapiMediaResource.Uploading ->
u |> GapiMediaResource.state ^= GapiMediaResource.Error
| _ -> u)
current_upload_state
in
let new_post_data =
match new_upload_state with
| Some u -> (
match u.GapiMediaResource.state with
| GapiMediaResource.Error -> None
| _ -> post_data)
| _ -> post_data
in
if exponential_backoff then
GapiUtils.wait_exponential_backoff request_number;
request_loop ?post_data:new_post_data
?current_upload_state:new_upload_state request_type
(succ request_number) url updated_session
in
try
let verified_session =
match session.GapiConversation.Session.auth with
| GapiConversation.Session.OAuth2
{ GapiConversation.Session.oauth2_token = ""; _ } ->
refresh_oauth2_token session
| _ -> session
in
single_request ?post_data ?version ?etag
?upload_state:current_upload_state ?media_download ?custom_headers
request_type url parse_output parse_error verified_session
with
| Redirect (target, new_session) ->
if url <> target then
request_loop ?post_data request_type (succ request_number) target
new_session
else failwith ("Redirection loop detected: url=" ^ url)
| Unauthorized (new_session, _, _) as e ->
retry_on_error 1 false e (fun s -> refresh_oauth2_token s) new_session
| ResumeIncomplete (range, location, new_session) ->
let target = if location = "" then url else location in
let upload_state = Option.get current_upload_state in
let new_upload_state =
GapiMediaResource.update_upload_state range upload_state
in
let new_post_data = GapiMediaResource.get_post_data new_upload_state in
request_loop ~post_data:new_post_data
~current_upload_state:new_upload_state Update 0 target new_session
| StartUpload (location, new_session) ->
let target = if location = "" then url else location in
let upload_state = Option.get current_upload_state in
let new_upload_state =
upload_state |> GapiMediaResource.state ^= GapiMediaResource.Uploading
in
let new_post_data = GapiMediaResource.get_post_data upload_state in
request_loop ~post_data:new_post_data
~current_upload_state:new_upload_state Update 0 target new_session
| InternalServerError (new_session, response_code, pipe)
| BadGateway (new_session, response_code, pipe)
| ServiceUnavailable (new_session, response_code, pipe)
| GatewayTimeout (new_session, response_code, pipe) ->
retry_on_error 4 true
(InternalServerError (new_session, response_code, pipe))
(fun s -> s)
new_session
in
let current_upload_state =
Option.map
(fun resource ->
let chunk_size =
session |. GapiConversation.Session.config
|. GapiConfig.upload_chunk_size
in
GapiMediaResource.setup_upload ~chunk_size resource)
media_source
in
request_loop ?post_data ?current_upload_state request_type 0 url session