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
|
;;; 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 server)
#:use-module (srfi srfi-11)
#:use-module (srfi srfi-19)
#:use-module (ice-9 match)
#:use-module (ice-9 ftw)
#:use-module (ice-9 format)
#: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 (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 (gcrypt base16)
#:use-module (gcrypt hash)
#:use-module (prometheus)
#:use-module (guix base32)
#:use-module (guix base64)
#:use-module (guix build utils)
#:use-module (guix-build-coordinator utils)
#:use-module (guix-build-coordinator utils fibers)
#:use-module (guix-build-coordinator datastore)
#:use-module (guix-build-coordinator coordinator)
#:export (http-agent-messaging-start-server))
(define (bad-request message . args)
(throw 'bad-request message args))
(define (fixed/read-request-body r)
"Reads the request body from R, as a bytevector. Return ‘#f’
if there was no request body."
(cond
((member '(chunked) (request-transfer-encoding r))
(make-chunked-input-port* (request-port r)
;; closing the port is handled elsewhere
#:keep-alive? #t))
(else
(let ((nbytes (request-content-length r)))
(and nbytes
(let ((bv (get-bytevector-n (request-port r) nbytes)))
(if (= (bytevector-length bv) nbytes)
bv
(bad-request "EOF while reading request body: ~a bytes of ~a"
(bytevector-length bv) nbytes))))))))
(module-set! (resolve-module '(web request))
'read-request-body
fixed/read-request-body)
(define (http-agent-messaging-start-server port host secret-key-base
build-coordinator
chunked-request-channel)
(define gc-metrics-updater
(get-gc-metrics-updater
(build-coordinator-metrics-registry build-coordinator)))
(define datastore-metrics-updater
(base-datastore-metrics-updater build-coordinator))
(define (update-managed-metrics!)
(call-with-delay-logging datastore-metrics-updater)
(call-with-delay-logging gc-metrics-updater))
(call-with-error-handling
(lambda ()
(run-server/patched
(lambda (request body)
(log-msg (build-coordinator-logger build-coordinator)
'INFO
(format #f "~4a ~a\n"
(request-method request)
(uri-path (request-uri request))))
(apply values
(controller request
(cons (request-method request)
(split-and-decode-uri-path
(uri-path (request-uri request))))
body
secret-key-base
build-coordinator
chunked-request-channel
update-managed-metrics!)))
#:host host
#:port port))
#:on-error 'backtrace
#:post-error (lambda (key . args)
(when (eq? key 'system-error)
(match args
(("bind" "~A" ("Address already in use") _)
(simple-format
(current-error-port)
"\n
error: guix-build-coordinator could not start, as it could not bind to port ~A
Check if it's already running, or whether another process is using that
port. Also, the port used can be changed by passing the --port option.\n"
port)))))))
(define* (render-json json #:key (extra-headers '())
(code 200))
(list (build-response
#:code code
#:headers (append extra-headers
'((content-type . (application/json))
(vary . (accept)))))
(scm->json-string json)))
(define* (render-text text #:key (extra-headers '())
(code 200))
(list (build-response
#:code code
#:headers (append extra-headers
'((content-type . (text/plain))
(vary . (accept)))))
text))
(define (no-content)
(list (build-response #:code 204)
""))
(define (base-datastore-metrics-updater build-coordinator)
(define datastore
(build-coordinator-datastore build-coordinator))
(define registry
(build-coordinator-metrics-registry build-coordinator))
(let ((internal-real-time
(make-gauge-metric registry "guile_internal_real_time"))
(internal-run-time
(make-gauge-metric registry "guile_internal_run_time"))
(allocated-builds-total
(make-gauge-metric registry
"allocated_builds_total"
#:labels '(agent_id)))
(unprocessed-hook-events-total
(make-gauge-metric registry
"unprocessed_hook_events_total"
#:labels '(event))))
(define (zero-metric-for-agents metric)
(for-each (lambda (agent-details)
(metric-set metric
0
#:label-values
`((agent_id . ,(assq-ref agent-details 'uuid)))))
(datastore-list-agents datastore)))
(lambda ()
(metric-set internal-real-time
(get-internal-real-time))
(metric-set internal-run-time
(get-internal-run-time))
;; These are the db size metrics
(datastore-update-metrics! datastore)
(zero-metric-for-agents allocated-builds-total)
(for-each (match-lambda
((agent-id . count)
(metric-set allocated-builds-total
count
#:label-values
`((agent_id . ,agent-id)))))
(datastore-count-allocated-builds datastore))
(for-each (match-lambda
((event . _)
(metric-set unprocessed-hook-events-total
0
#:label-values
`((event . ,event)))))
(build-coordinator-hooks build-coordinator))
(for-each (lambda (event-count)
(metric-set unprocessed-hook-events-total
(assq-ref event-count 'count)
#:label-values
`((event . ,(assq-ref event-count 'event)))))
(datastore-count-unprocessed-hook-events datastore)))))
(define (controller request
method-and-path-components
body
secret-key-base
build-coordinator
chunked-request-channel
update-managed-metrics!)
(define (authenticated? uuid request)
(let* ((authorization-base64
(match (assq-ref (request-headers request)
'authorization)
(('basic . s) s)))
(authorization
(utf8->string
(base64-decode authorization-base64))))
(match (string-split authorization #\:)
((auth-uuid auth-password)
(and
(string? uuid)
(string=? auth-uuid uuid)
(datastore-agent-password-exists? datastore
uuid
auth-password)))
(_ #f))))
(define datastore
(build-coordinator-datastore build-coordinator))
(define logger
(build-coordinator-logger build-coordinator))
(define (controller-thunk)
(match method-and-path-components
(('GET "agent" uuid)
(let ((agent (datastore-find-agent datastore uuid)))
(if agent
(render-json
`((agent . ,uuid)
,@agent))
(render-json
(simple-format #f "no agent found with id: ~A"
uuid)
#:code 404))))
(('PUT "agent" uuid)
(if (authenticated? uuid request)
(begin
(let* ((json-body (json-string->scm (utf8->string body)))
(status (assoc-ref json-body "status"))
(1min-load-average (and=> (assoc-ref json-body "load_average")
(lambda (load-average)
(assoc-ref load-average 1)))))
(update-agent-status build-coordinator uuid
status 1min-load-average))
(render-json
(agent-details datastore uuid)))
(render-json
'(("error" . "access denied"))
#:code 403)))
(('POST "agent" "fetch-session-credentials")
(let* ((query-parameters (request-query-parameters request))
(name (assq-ref query-parameters 'name))
(token (assq-ref query-parameters 'token)))
(if (and (string? name)
(string? token))
(if (datastore-dynamic-auth-token-exists? datastore token)
(let ((agent-uuid (or (datastore-find-agent-by-name
datastore
name)
(new-agent datastore
#:name name))))
(let ((password
(match (datastore-agent-list-passwords datastore
agent-uuid)
(()
(new-agent-password datastore #:agent agent-uuid))
((password . rest)
password))))
(render-json
`((id . ,agent-uuid)
(password . ,password)))))
(render-json
'(("error" . "token not recognised"))
#:code 403))
(render-json
'(("error" . "access denied"))
#:code 403))))
(('POST "agent" uuid "fetch-builds")
(if (authenticated? uuid request)
(let* ((json-body (json-string->scm (utf8->string body)))
;; count is deprecated, use target_count instead
(count (assoc-ref json-body "count"))
(target-count (assoc-ref json-body "target_count"))
(systems (assoc-ref json-body "systems"))
(builds (fetch-builds build-coordinator uuid
(vector->list systems)
target-count
count)))
(render-json
`((builds . ,(list->vector builds)))))
(render-json
'(("error" . "access denied"))
#:code 403)))
(('PUT "build" uuid)
(let ((agent-id-for-build
(datastore-agent-for-build datastore uuid)))
(if (authenticated? agent-id-for-build request)
(begin
(handle-build-result build-coordinator
agent-id-for-build uuid
(json-string->scm (utf8->string body)))
(render-json
"message received"))
(render-json
'(("error" . "access denied"))
#:code 403))))
(('POST "build" uuid "report-build-start")
(let ((agent-id-for-build
(datastore-agent-for-build datastore uuid)))
(if (authenticated? agent-id-for-build request)
(begin
(handle-build-start-report build-coordinator
agent-id-for-build
uuid)
(render-json
"message received"))
(render-json
'(("error" . "access denied"))
#:code 403))))
(('POST "build" uuid "report-setup-failure")
(let ((agent-id-for-build
(datastore-agent-for-build datastore uuid)))
(if (authenticated? agent-id-for-build request)
(begin
(handle-setup-failure-report
build-coordinator
agent-id-for-build uuid
(json-string->scm (utf8->string body)))
(render-json
"message received"))
(render-json
'(("error" . "access denied"))
#:code 403))))
(('PUT "build" uuid "log" format)
(let ((agent-id-for-build
(datastore-agent-for-build datastore uuid)))
(if (authenticated? agent-id-for-build request)
(let* ((output-file-name
(build-log-file-destination uuid format))
(tmp-output-file-name
(string-append output-file-name ".tmp")))
(mkdir-p (dirname output-file-name))
(when (file-exists? tmp-output-file-name)
(delete-file tmp-output-file-name))
(for-each
(lambda (file)
(log-msg logger 'WARN uuid ": removing stale log file " file)
(delete-file (string-append (dirname output-file-name)
"/"
file)))
(scandir (dirname output-file-name)
(lambda (file)
(not (member file '("." ".."))))))
(if (bytevector? body)
(call-with-output-file tmp-output-file-name
(lambda (output-port)
(put-bytevector output-port body)))
(call-with-worker-thread
chunked-request-channel
(lambda ()
(call-with-output-file tmp-output-file-name
(lambda (output-port)
(let loop ((bv (get-bytevector-some body)))
(unless (eof-object? bv)
(put-bytevector output-port bv)
(loop (get-bytevector-some body)))))))))
(rename-file tmp-output-file-name
output-file-name)
(no-content))
(render-json
'(("error" . "access denied"))
#:code 403))))
(('HEAD "build" uuid "output" output-name)
(let ((agent-id-for-build
(datastore-agent-for-build datastore uuid)))
(if (authenticated? agent-id-for-build request)
(let* ((output-file-name
(build-output-file-location datastore uuid output-name)))
(if (file-exists? output-file-name)
(let ((bytes (stat:size (stat output-file-name))))
(list (build-response
#:code 200
#:headers `((content-length . ,bytes)))
#f))
(list (build-response #:code 404)
#f)))
(list (build-response #:code 403)
#f))))
(('PUT "build" uuid "output" output-name)
(let ((agent-id-for-build
(datastore-agent-for-build datastore uuid)))
(define (compute-hash file-name)
(bytevector->nix-base32-string
(with-exception-handler
(lambda (exn)
(log-msg logger
'WARN
"error computing hash: " exn)
(when (file-exists? file-name)
(let ((md5-hash
(bytevector->base16-string
(file-hash (hash-algorithm md5) file-name)))
(file-bytes
(stat:size (stat file-name))))
;; I've seen exceptions happen here from lzip, so try
;; deleting the tmp file so that it's re-uploaded.
(log-msg logger 'WARN "deleting " file-name)
(delete-file file-name)
(raise-exception
(make-exception
exn
(make-exception-with-irritants
`((file-bytes . ,file-bytes)
(md5-hash . ,md5-hash)))))))
(raise-exception exn))
(lambda ()
(call-with-input-file file-name
(lambda (compressed-port)
(call-with-lzip-input-port compressed-port
port-sha256))))
#:unwind? #t)))
(define (receive-file output-file-name tmp-output-file-name)
(call-with-worker-thread
chunked-request-channel
(lambda ()
(call-with-output-file tmp-output-file-name
(lambda (output-port)
(let ((start-time (current-time time-utc)))
(let loop ((bv (get-bytevector-some body))
(bytes-read 0)
(last-progress-update-bytes-read 0))
(if (eof-object? bv)
(let* ((end-time (current-time time-utc))
(elapsed (time-difference end-time
start-time))
(seconds-elapsed
(+ (time-second elapsed)
(/ (time-nanosecond elapsed) 1e9))))
(display
(simple-format
#f
"received ~A
took ~A seconds
data transfered: ~AMB (~A bytes)
speed (MB/s): ~A
"
(basename output-file-name)
seconds-elapsed
(format #f "~2,2f" (/ bytes-read 1000000))
bytes-read
(format #f "~2,2f" (/ (/ bytes-read 1000000)
seconds-elapsed)))))
(begin
(put-bytevector output-port bv)
(loop (get-bytevector-some body)
(+ bytes-read
(bytevector-length bv))
(if (> (- bytes-read
last-progress-update-bytes-read)
50000000) ; ~50MB
(begin
(display
(simple-format
#f
"receiving ~A
~AMB read so far...
"
(basename output-file-name)
(format #f "~2,2f"
(/ bytes-read
1000000))))
bytes-read)
last-progress-update-bytes-read))))))))
;; Compute the hash of the file
(let ((hash (compute-hash tmp-output-file-name)))
(log-msg logger
'DEBUG
"computed the hash of " tmp-output-file-name ", renaming")
(rename-file tmp-output-file-name
output-file-name)
hash))))
(if (authenticated? agent-id-for-build request)
(let* ((output-file-name
(build-output-file-location datastore uuid output-name))
(tmp-output-file-name
(string-append output-file-name ".tmp")))
(mkdir-p (dirname output-file-name))
(when (file-exists? output-file-name)
(log-msg logger
'WARN
"PUT /build/" uuid "/output/" output-name ": "
"deleting " output-file-name)
(delete-file output-file-name))
(when (file-exists? tmp-output-file-name)
(log-msg logger
'WARN
"PUT /build/" uuid "/output/" output-name ": "
"deleting " tmp-output-file-name)
(delete-file tmp-output-file-name))
(let ((hash
(if (bytevector? body)
(begin
(call-with-output-file tmp-output-file-name
(lambda (output-port)
(put-bytevector output-port body)))
(let ((hash (compute-hash tmp-output-file-name)))
(log-msg logger
'DEBUG
"computed the hash of " tmp-output-file-name
", renaming")
(rename-file tmp-output-file-name
output-file-name)
hash))
(receive-file output-file-name
tmp-output-file-name))))
(call-with-output-file (string-append output-file-name ".hash")
(lambda (port)
(simple-format port "~A\n" hash)))
(no-content)))
(render-json
'(("error" . "access denied"))
#:code 403))))
(('HEAD "build" uuid "output" output-name "partial")
(let ((agent-id-for-build
(datastore-agent-for-build datastore uuid)))
(if (authenticated? agent-id-for-build request)
(let* ((output-file-name
(build-output-file-location datastore uuid output-name))
(tmp-output-file-name
(string-append output-file-name ".tmp")))
(if (file-exists? tmp-output-file-name)
(let ((bytes (stat:size (stat tmp-output-file-name))))
(list (build-response
#:code 200
#:headers `((content-length . ,bytes)))
#f))
(list (build-response #:code 404)
#f)))
(list (build-response #:code 403)
#f))))
(('POST "build" uuid "output" output-name "partial")
(let ((agent-id-for-build
(datastore-agent-for-build datastore uuid)))
(define (compute-hash file-name)
(bytevector->nix-base32-string
(with-exception-handler
(lambda (exn)
(log-msg logger 'WARN "error computing hash: " exn)
(when (file-exists? file-name)
(let ((md5-hash
(bytevector->base16-string
(file-hash (hash-algorithm md5) file-name)))
(file-bytes
(stat:size (stat file-name))))
;; I've seen exceptions happen here from lzip, so try
;; deleting the tmp file so that it's re-uploaded.
(log-msg logger 'WARN "deleting " file-name)
(delete-file file-name)
(raise-exception
(make-exception
exn
(make-exception-with-irritants
`((file-bytes . ,file-bytes)
(md5-hash . ,md5-hash)))))))
(raise-exception exn))
(lambda ()
(call-with-input-file file-name
(lambda (compressed-port)
(call-with-lzip-input-port compressed-port
port-sha256))))
#:unwind? #t)))
(define (receive-file output-file-name tmp-output-file-name)
(call-with-worker-thread
chunked-request-channel
(lambda ()
(let ((output-port (open-file tmp-output-file-name "a")))
(let ((start-time (current-time time-utc)))
(let loop ((bv (get-bytevector-some body))
(bytes-read 0)
(last-progress-update-bytes-read 0))
(if (eof-object? bv)
(let* ((end-time (current-time time-utc))
(elapsed (time-difference end-time
start-time))
(seconds-elapsed
(+ (time-second elapsed)
(/ (time-nanosecond elapsed) 1e9))))
(display
(simple-format
#f
"received ~A
took ~A seconds
data transfered: ~AMB (~A bytes)
speed (MB/s): ~A
"
(basename output-file-name)
seconds-elapsed
(format #f "~2,2f"
(/ bytes-read 1000000))
bytes-read
(format #f "~2,2f" (/ (/ bytes-read 1000000)
seconds-elapsed)))))
(begin
(put-bytevector output-port bv)
(loop (get-bytevector-some body)
(+ bytes-read
(bytevector-length bv))
(if (> (- bytes-read
last-progress-update-bytes-read)
50000000) ; ~50MB
(begin
(display
(simple-format
#f
"receiving ~A
~AMB read so far...
"
(basename output-file-name)
(format #f "~2,2f"
(/ bytes-read
1000000))))
bytes-read)
last-progress-update-bytes-read))))))
(close-port output-port))
;; Compute the hash of the file
(let ((hash (compute-hash tmp-output-file-name)))
(log-msg logger
'DEBUG
"computed the hash of " tmp-output-file-name
", renaming")
(rename-file tmp-output-file-name
output-file-name)
hash))))
(if (authenticated? agent-id-for-build request)
(let* ((output-file-name
(build-output-file-location datastore uuid output-name))
(tmp-output-file-name
(string-append output-file-name ".tmp")))
;; If the output file exists, delete it, as it's being uploaded
;; again
(when (file-exists? output-file-name)
(log-msg logger
'WARN
"POST /build/" uuid "/output/" output-name "/partial: "
"deleting " output-file-name)
(delete-file output-file-name))
(let ((hash
(if (bytevector? body)
(let ((output-port (open-file tmp-output-file-name "a")))
(put-bytevector output-port body)
(close-port output-port)
(let ((hash (compute-hash tmp-output-file-name)))
(log-msg logger
'DEBUG
"computed the hash of " tmp-output-file-name
", renaming")
(rename-file tmp-output-file-name
output-file-name)
hash))
(receive-file output-file-name
tmp-output-file-name))))
(call-with-output-file (string-append output-file-name ".hash")
(lambda (port)
(simple-format port "~A\n" hash)))
(no-content)))
(render-json
'(("error" . "access denied"))
#:code 403))))
(('GET "metrics")
(call-with-delay-logging update-managed-metrics!
#:threshold 0.5)
(list (build-response
#:code 200
#:headers '((content-type . (text/plain))
(vary . (accept))))
(lambda (port)
(write-metrics (build-coordinator-metrics-registry
build-coordinator)
port))))
(_
(render-json
"not-found"
#:code 404))))
(with-exception-handler
(lambda (exn)
(cond
((agent-error? exn)
(render-json
`((error . ,(agent-error-details exn)))
#:code 400))
((chunked-input-ended-prematurely-error? exn)
(render-json
`((error . chunked-input-ended-prematurely))
#:code 400))
(else
(render-json
`((error . ,(simple-format #f "~A" exn)))
#:code 500))))
(lambda ()
(with-throw-handler #t
controller-thunk
(lambda (key . args)
(unless (and (eq? '%exception key)
(or (agent-error? (car args))
(chunked-input-ended-prematurely-error? (car args))))
(match method-and-path-components
((method path-components ...)
(simple-format
(current-error-port)
"error: when processing: /~A ~A\n ~A ~A"
method (string-join path-components "/")
key args)))
(backtrace)))))
#:unwind? #t))
|