aboutsummaryrefslogtreecommitdiff
path: root/guix-build-coordinator/agent-messaging/http.scm
blob: dae94b504fa6fb29debad6c3184d313ca27e7f23 (plain)
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
;;; Guix Build Coordinator
;;;
;;; Copyright © 2020 Christopher Baines <mail@cbaines.net>
;;;
;;; This file is part of the guix-build-coordinator.
;;;
;;; The Guix Build Coordinator is free software; you can redistribute
;;; it and/or modify it under the terms of the GNU General Public
;;; License as published by the Free Software Foundation; either
;;; version 3 of the License, or (at your option) any later version.
;;;
;;; The Guix Build Coordinator is distributed in the hope that it will
;;; be useful, but WITHOUT ANY WARRANTY; without even the implied
;;; warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
;;; See the GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with the guix-data-service.  If not, see
;;; <http://www.gnu.org/licenses/>.

(define-module (guix-build-coordinator agent-messaging http)
  #:use-module (srfi srfi-11)
  #:use-module (srfi srfi-19)
  #:use-module (ice-9 match)
  #:use-module (ice-9 format)
  #:use-module (ice-9 threads)
  #:use-module (ice-9 exceptions)
  #:use-module (ice-9 textual-ports)
  #:use-module (ice-9 binary-ports)
  #:use-module (system repl error-handling)
  #:use-module (rnrs bytevectors)
  #:use-module (oop goops)
  #:use-module (logging logger)
  #:use-module (json)
  #:use-module (web http)
  #:use-module (web client)
  #:use-module (web request)
  #:use-module (web response)
  #:use-module (web uri)
  #:use-module (lzlib)
  #:use-module ((gnutls) #:select (gnutls-version))
  #:use-module ((guix config) #:select (%guix-version))
  #:use-module ((guix utils) #:select (version>=?))
  #:use-module (prometheus)
  #:use-module (guix store)
  #:use-module (guix base64)
  #:use-module (guix serialization)
  #:use-module (guix build utils)
  #:use-module (guix-build-coordinator utils)
  #:use-module (guix-build-coordinator agent-messaging abstract)
  #:export (make-http-agent-interface

            fetch-session-credentials

            submit-status
            submit-log-file
            submit-build-result
            report-build-start
            report-setup-failure
            submit-output
            fetch-builds-for-agent))

(define-class <http-agent-interface> ()
  (coordinator-uri #:init-keyword #:coordinator-uri)
  (agent-uuid #:init-keyword #:agent-uuid)
  (password #:init-keyword #:password))

(define (make-http-agent-interface coordinator-uri
                                   agent-uuid
                                   password)
  (let* ((gnutls-ver (gnutls-version))
         (guix-ver   %guix-version)
         (gnutls-probably-retries-on-gc?
          (or (version>=? gnutls-ver "3.7.3")
              ;; guix patched gnutls to retry when interrupted by gc before
              ;; gnutls released the change
              (version>=? guix-ver "1.3.0-14"))))
    (simple-format (current-error-port)
                   "gc protection ~A (gnutls version: ~A, guix version: ~A)\n"
                   (if gnutls-probably-retries-on-gc?
                       "disabled"
                       "enabled")
                   gnutls-ver
                   guix-ver)
    (use-gc-protection? (not gnutls-probably-retries-on-gc?)))

  (make <http-agent-interface>
    #:coordinator-uri coordinator-uri
    #:agent-uuid agent-uuid
    #:password password))

(define* (coordinator-uri-for-path base-uri-string agent-path
                                   #:key query)
  (let* ((base-uri (string->uri base-uri-string))
         (scheme (uri-scheme base-uri))
         (host   (uri-host base-uri))
         (port   (uri-port base-uri))
         (path   (uri-path base-uri)))
    (build-uri scheme
               #:host host
               #:port port
               #:path
               (string-append
                path
                (if (string-suffix? path "/")
                    agent-path
                    (string-drop agent-path 1)))
               #:query query)))

(define (default-log level . components)
  (apply log-msg level components))

(define* (coordinator-handle-failed-request log method path response body
                                            #:key first-request-failed?)
  (log 'ERROR
       "coordinator-http-request: "
       method " " path " "
       (response-code response))

  (catch #t
    (lambda ()
      (if (equal? '(application/json (charset . "utf-8"))
                  (response-content-type response))
          (json-string->scm (utf8->string body))
          (utf8->string body)))
    (lambda (key . args)
      (log 'ERROR
           "error decoding body " key " " args)
      #f)))

(define* (coordinator-http-request log
                                   interface
                                   path
                                   #:key method body (headers '())
                                   succeed-on-access-denied-retry?)
  (define auth-value
    (string-append
     "Basic "
     (base64-encode
      (string->utf8
       (string-append (slot-ref interface 'agent-uuid)
                      ":"
                      (slot-ref interface 'password))))))

  (define uri
    (coordinator-uri-for-path (slot-ref interface 'coordinator-uri)
                              path))

  (define first-request-failed? #f)

  (define (make-request)
    (let-values (((response body)
                  (http-request uri
                                #:method method
                                #:body (scm->json-string body)
                                #:decode-body? #f
                                #:headers
                                `((Authorization . ,auth-value)
                                  ,@headers))))
      (let ((code (response-code response)))
        (cond
         ((eq? code 400)
          (and=> (coordinator-handle-failed-request log
                                                    method
                                                    path
                                                    response
                                                    body)
                 (lambda (error)
                   (raise-exception
                    (make-agent-error-from-coordinator
                     (assoc-ref error "error"))))))

         ((eq? code 404)
          (values
           (and body (json-string->scm (utf8->string body)))
           response))

         ((>= (response-code response) 400)
          (let ((body
                 (coordinator-handle-failed-request log
                                                    method
                                                    path
                                                    response
                                                    body)))
            (if (and first-request-failed?
                     succeed-on-access-denied-retry?
                     (equal? body
                             '(("error" . "access denied"))))
                (begin
                  (log 'WARN
                       "treating access denied response as success")
                  (values body response))
                (begin
                  (set! first-request-failed? #t)
                  (raise-exception
                   (make-exception-with-message
                    body))))))
         (else
          (values
           (and body (json-string->scm (utf8->string body)))
           response))))))

  (retry-on-error (lambda ()
                    (with-gc-protection make-request))
                  #:times 9
                  #:delay 10
                  #:ignore agent-error-from-coordinator?))

(define* (fetch-session-credentials coordinator
                                    name
                                    token
                                    #:key (log default-log))
  (define method 'POST)
  (define path "/agent/fetch-session-credentials")
  (define uri (coordinator-uri-for-path coordinator path
                                        #:query
                                        (simple-format #f "name=~A&token=~A"
                                                       name token)))

  (let-values (((response body)
                (http-request uri
                              #:method method
                              #:decode-body? #f)))
    (let ((code (response-code response)))
      (cond
       ((eq? code 400)
        (and=> (coordinator-handle-failed-request log
                                                  method
                                                  path
                                                  response
                                                  body)
               (lambda (error)
                 (raise-exception
                  (make-agent-error-from-coordinator
                   (assoc-ref error "error"))))))

       ((>= (response-code response) 400)
        (let ((body
               (coordinator-handle-failed-request log
                                                  method
                                                  path
                                                  response
                                                  body)))
          (raise-exception
           (make-exception-with-message
            body))))
       (else
        (values
         (json-string->scm (utf8->string body))
         response))))))

(define-method (submit-status
                (interface <http-agent-interface>)
                .
                args)
  (apply
   (lambda* (status #:key (log default-log))
     (coordinator-http-request
      log
      interface
      (string-append "/agent/" (slot-ref interface 'agent-uuid))
      #:method 'PUT                     ; TODO Should be PATCH
      #:body `((status . ,status))))
   args))

(define-method (submit-output
                (interface <http-agent-interface>)
                .
                args)
  (apply
   (lambda* (build-id output-name file
                      #:key
                      (log default-log)
                      report-bytes-sent)
     (define file-size
       (stat:size (stat file)))

     (define (get-partial-upload-bytes)
       (let-values (((body response)
                     (coordinator-http-request
                      log
                      interface
                      (string-append "/build/" build-id
                                     "/output/" output-name
                                     "/partial")
                      #:method 'HEAD)))
         (if (eq? (response-code response)
                  404)
             #f
             (response-content-length response))))

     (define (get-completed-upload-bytes)
       (let-values (((body response)
                     (coordinator-http-request
                      log
                      interface
                      (string-append "/build/" build-id
                                     "/output/" output-name)
                      #:method 'HEAD)))
         (if (eq? (response-code response)
                  404)
             #f
             (response-content-length response))))

     (define auth-value
       (string-append
        "Basic "
        (base64-encode
         (string->utf8
          (string-append (slot-ref interface 'agent-uuid)
                         ":"
                         (slot-ref interface 'password))))))

     (define* (uri #:key resume?)
       (coordinator-uri-for-path
        (slot-ref interface 'coordinator-uri)
        (string-append "/build/" build-id "/output/" output-name
                       (if resume? "/partial" ""))))

     (define (perform-upload)
       (let* ((partial-upload-bytes (get-partial-upload-bytes))
              (completed-upload-bytes (get-completed-upload-bytes))
              (bytes (or partial-upload-bytes
                         completed-upload-bytes)))
         ;; Check if the server has all the bytes
         (unless (and bytes
                      (eq? bytes file-size))
           (when bytes
             (log 'DEBUG "still more to send (bytes: " file-size
                  ", partial upload bytes: " partial-upload-bytes
                  ", completed upload bytes: " completed-upload-bytes ")"))

           ;; Still more to send
           (call-with-input-file file
             (lambda (file-port)
               (when bytes
                 (seek file-port bytes SEEK_SET)
                 (log 'INFO "resuming upload from byte " bytes))

               (with-timeout (* 20 60) ; 20 minutes
                 (raise-exception
                  (make-exception-with-message "timeout submitting output"))
                 (let-values (((response body)
                               (call-with-streaming-http-request
                                (uri #:resume? (integer? bytes))
                                (lambda (port)
                                  (with-time-logging
                                      (simple-format #f "sending ~A" file)
                                    (dump-port file-port port
                                               #:buffer-size 65536)))
                                #:headers `((Authorization . ,auth-value))
                                #:method (if bytes 'POST 'PUT)
                                #:report-bytes-sent report-bytes-sent)))
                   (when (>= (response-code response) 400)
                     (raise-exception
                      (make-exception-with-message
                       (coordinator-handle-failed-request
                        log
                        'PUT
                        (uri-path
                         (uri #:resume? (integer? bytes)))
                        response
                        body)))))))))))

     (unless (get-completed-upload-bytes)
       (retry-on-error perform-upload
                       #:times 100
                       #:delay (random 15))))
   args))

(define-method (submit-log-file
                (interface <http-agent-interface>)
                .
                args)
  (apply
   (lambda* (build-id file #:key (log default-log))
     (define auth-value
       (string-append
        "Basic "
        (base64-encode
         (string->utf8
          (string-append (slot-ref interface 'agent-uuid)
                         ":"
                         (slot-ref interface 'password))))))

     (define format
       (cond
        ((string-suffix? ".bz2" file) "bzip2")
        ((string-suffix? ".gz" file)  "gzip")
        (else
         (error "unsupported log format for" file))))

     (define uri
       (coordinator-uri-for-path
        (slot-ref interface 'coordinator-uri)
        (string-append "/build/" build-id "/log/" format)))

     (retry-on-error
      (lambda ()
        (let-values (((response body)
                      (call-with-streaming-http-request
                       uri
                       (lambda (request-port)
                         (call-with-input-file file
                           (lambda (file-port)
                             (dump-port file-port request-port
                                        #:buffer-size (expt 2 20)))
                           #:binary #t))
                       #:headers `((Authorization . ,auth-value)))))
          (if (>= (response-code response) 400)
              (raise-exception
               (make-exception-with-message
                (coordinator-handle-failed-request log
                                                   'PUT
                                                   (uri-path uri)
                                                   response
                                                   body)))
              (begin
                (log 'INFO
                     "successfully uploaded log file ("
                     (response-code response)
                     ")")
                #t))))
      #:times 12
      #:delay (random 15)))
   args))

(define-method (submit-build-result
                (interface <http-agent-interface>)
                .
                args)
  (apply
   (lambda* (build-id result #:key (log default-log))
     (coordinator-http-request
      log
      interface
      (string-append "/build/" build-id)
      #:method 'PUT                     ; TODO Should be PATCH
      #:body result))
   args))

(define-method (report-build-start
                (interface <http-agent-interface>)
                .
                args)
  (apply
   (lambda* (build-id #:key (log default-log))
     (coordinator-http-request
      log
      interface
      (string-append "/build/" build-id "/report-build-start")
      #:method 'POST))
   args))

(define-method (report-setup-failure
                (interface <http-agent-interface>)
                .
                args)
  (apply
   (lambda* (build-id report #:key (log default-log))
     (coordinator-http-request
      log
      interface
      (string-append "/build/" build-id "/report-setup-failure")
      #:method 'POST
      #:body report
      #:succeed-on-access-denied-retry? #t))
   args))

(define-method (fetch-builds-for-agent
                (interface <http-agent-interface>)
                .
                args)
  (apply
   (lambda* (systems target-count #:key (log default-log))
     (vector->list
      (assoc-ref (coordinator-http-request
                  log
                  interface
                  (string-append "/agent/"
                                 (slot-ref interface 'agent-uuid)
                                 "/fetch-builds")
                  #:body `((target_count . ,target-count)
                           (systems      . ,(list->vector systems)))
                  #:method 'POST)
                 "builds")))
   args))