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
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
|
// file : mod/mod-ci-github.cxx -*- C++ -*-
// license : MIT; see accompanying LICENSE file
#include <mod/mod-ci-github.hxx>
#include <libbutl/json/parser.hxx>
#include <web/xhtml/serialization.hxx>
#include <web/server/mime-url-encoding.hxx> // mime_url_encode()
#include <mod/jwt.hxx>
#include <mod/hmac.hxx>
#include <mod/build.hxx> // build_log_url()
#include <mod/module-options.hxx>
#include <mod/mod-ci-github-gq.hxx>
#include <mod/mod-ci-github-post.hxx>
#include <mod/mod-ci-github-service-data.hxx>
#include <stdexcept>
// @@ Remaining TODOs
//
// - Rerequested checks
//
// - check_suite (action: rerequested): received when user re-runs all
// checks.
//
// - check_run (action: rerequested): received when user re-runs a
// specific check or all failed checks.
//
// @@ TMP I have confirmed that the above is accurate.
//
// Will need to extract a few more fields from check_runs, but the layout
// is very similar to that of check_suite.
//
// - Choose strong webhook secret (when deploying).
//
// - Check that delivery UUID has not been received before (replay attack).
//
// Resources:
//
// Creating an App:
// https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app
//
// Webhooks:
// https://docs.github.com/en/webhooks/using-webhooks/best-practices-for-using-webhooks
// https://docs.github.com/en/webhooks/using-webhooks/validating-webhook-deliveries
//
// REST API:
// All docs: https://docs.github.com/en/rest#all-docs
// Best practices: https://docs.github.com/en/rest/using-the-rest-api/best-practices-for-using-the-rest-api
//
// GraphQL API:
// Reference: https://docs.github.com/en/graphql/reference
//
using namespace std;
using namespace butl;
using namespace web;
using namespace brep::cli;
namespace brep
{
ci_github::
ci_github (tenant_service_map& tsm)
: tenant_service_map_ (tsm)
{
}
ci_github::
ci_github (const ci_github& r, tenant_service_map& tsm)
: database_module (r),
ci_start (r),
options_ (r.initialized_ ? r.options_ : nullptr),
tenant_service_map_ (tsm)
{
}
void ci_github::
init (scanner& s)
{
{
shared_ptr<tenant_service_base> ts (
dynamic_pointer_cast<tenant_service_base> (shared_from_this ()));
assert (ts != nullptr); // By definition.
tenant_service_map_["ci-github"] = move (ts);
}
options_ = make_shared<options::ci_github> (
s, unknown_mode::fail, unknown_mode::fail);
// Prepare for the CI requests handling, if configured.
//
if (options_->build_config_specified () &&
options_->ci_github_app_webhook_secret_specified ())
{
ci_start::init (make_shared<options::ci_start> (*options_));
database_module::init (*options_, options_->build_db_retry ());
}
}
bool ci_github::
handle (request& rq, response&)
{
using namespace bpkg;
HANDLER_DIAG;
if (build_db_ == nullptr)
throw invalid_request (501, "GitHub CI submission not implemented");
// Process headers.
//
string event; // Webhook event.
string hmac; // Received HMAC.
try
{
bool content_type (false);
for (const name_value& h: rq.headers ())
{
// HMAC authenticating this request. Note that it won't be present
// unless a webhook secret has been set in the GitHub app's settings.
//
if (icasecmp (h.name, "x-hub-signature-256") == 0)
{
if (!h.value)
throw invalid_request (400, "missing x-hub-signature-256 value");
// Parse the x-hub-signature-256 header value. For example:
//
// sha256=5e82258...
//
// Check for the presence of the "sha256=" prefix and then strip it
// to leave only the HMAC value.
//
if (h.value->find ("sha256=", 0, 7) == string::npos)
throw invalid_request (400, "invalid x-hub-signature-256 value");
hmac = h.value->substr (7);
}
// This event's UUID.
//
else if (icasecmp (h.name, "x-github-delivery") == 0)
{
// @@ TODO Check that delivery UUID has not been received before
// (replay attack).
}
else if (icasecmp (h.name, "content-type") == 0)
{
if (!h.value)
throw invalid_request (400, "missing content-type value");
if (icasecmp (*h.value, "application/json") != 0)
{
throw invalid_request (400,
"invalid content-type value: '" + *h.value +
'\'');
}
content_type = true;
}
// The webhook event.
//
else if (icasecmp (h.name, "x-github-event") == 0)
{
if (!h.value)
throw invalid_request (400, "missing x-github-event value");
event = *h.value;
}
}
if (!content_type)
throw invalid_request (400, "missing content-type header");
if (event.empty ())
throw invalid_request (400, "missing x-github-event header");
if (hmac.empty ())
throw invalid_request (400, "missing x-hub-signature-256 header");
}
catch (const invalid_request& e)
{
error << "request header error: " << e.content;
throw;
}
// Read the entire request body into a buffer because we need to compute
// an HMAC over it and then parse it as JSON. The alternative of reading
// from the stream twice works out to be more complicated (see also a TODO
// item in web/server/module.hxx).
//
string body;
{
// Note that even though we may not need caching right now, we may later
// (e.g., to support cancel) so let's just enable it right away.
//
size_t limit (128 * 1024);
istream& is (rq.content (limit, limit));
try
{
getline (is, body, '\0');
}
catch (const io_error& e)
{
fail << "unable to read request body: " << e;
}
}
// Verify the received HMAC.
//
// Compute the HMAC value over the request body using the configured
// webhook secret as key and compare it to the received HMAC.
//
try
{
string h (
compute_hmac (*options_,
body.data (), body.size (),
options_->ci_github_app_webhook_secret ().c_str ()));
if (!icasecmp (h, hmac))
{
string m ("computed HMAC does not match received HMAC");
error << m;
throw invalid_request (400, move (m));
}
}
catch (const system_error& e)
{
fail << "unable to compute request HMAC: " << e;
}
// Process the `warning` webhook request query parameter.
//
bool warning_success;
{
const name_values& rps (rq.parameters (1024, true /* url_only */));
auto i (find_if (rps.begin (), rps.end (),
[] (auto&& rp) {return rp.name == "warning";}));
if (i == rps.end ())
throw invalid_request (400,
"missing 'warning' webhook query parameter");
if (!i->value)
throw invalid_request (
400, "missing 'warning' webhook query parameter value");
const string& v (*i->value);
if (v == "success") warning_success = true;
else if (v == "failure") warning_success = false;
else
{
throw invalid_request (
400,
"invalid 'warning' webhook query parameter value: '" + v + '\'');
}
}
// There is a webhook event (specified in the x-github-event header) and
// each event contains a bunch of actions (specified in the JSON request
// body).
//
// Note: "GitHub continues to add new event types and new actions to
// existing event types." As a result we ignore known actions that we are
// not interested in and log and ignore unknown actions. The thinking here
// is that we want be "notified" of new actions at which point we can
// decide whether to ignore them or to handle.
//
// @@ There is also check_run even (re-requested by user, either
// individual check run or all the failed check runs).
//
if (event == "check_suite")
{
gh_check_suite_event cs;
try
{
json::parser p (body.data (), body.size (), "check_suite event");
cs = gh_check_suite_event (p);
}
catch (const json::invalid_json_input& e)
{
string m ("malformed JSON in " + e.name + " request body");
error << m << ", line: " << e.line << ", column: " << e.column
<< ", byte offset: " << e.position << ", error: " << e;
throw invalid_request (400, move (m));
}
if (cs.action == "requested")
{
return handle_check_suite_request (move (cs), warning_success);
}
else if (cs.action == "rerequested")
{
// Someone manually requested to re-run all the check runs in this
// check suite. Treat as a new request.
//
return handle_check_suite_request (move (cs), warning_success);
}
else if (cs.action == "completed")
{
// GitHub thinks that "all the check runs in this check suite have
// completed and a conclusion is available". Looks like this one we
// ignore?
//
// What if our bookkeeping says otherwise? But then we can't even
// access the service data easily here. @@ TODO: maybe/later.
//
return true;
}
else
{
// Ignore unknown actions by sending a 200 response with empty body
// but also log as an error since we want to notice new actions.
//
error << "unknown action '" << cs.action << "' in check_suite event";
return true;
}
}
else if (event == "check_run")
{
gh_check_run_event cr;
try
{
json::parser p (body.data (), body.size (), "check_run event");
cr = gh_check_run_event (p);
}
catch (const json::invalid_json_input& e)
{
string m ("malformed JSON in " + e.name + " request body");
error << m << ", line: " << e.line << ", column: " << e.column
<< ", byte offset: " << e.position << ", error: " << e;
throw invalid_request (400, move (m));
}
if (cr.action == "rerequested")
{
// Someone manually requested to re-run a specific check run.
//
return handle_check_run_rerequest (move (cr), warning_success);
}
#if 0
// It looks like we shouldn't be receiving these since we are not
// subscribed to them.
//
else if (cr.action == "created" ||
cr.action == "completed" ||
cr.action == "requested_action")
{
}
#endif
else
{
// Ignore unknown actions by sending a 200 response with empty body
// but also log as an error since we want to notice new actions.
//
error << "unknown action '" << cr.action << "' in check_run event";
return true;
}
}
else if (event == "pull_request")
{
gh_pull_request_event pr;
try
{
json::parser p (body.data (), body.size (), "pull_request event");
pr = gh_pull_request_event (p);
}
catch (const json::invalid_json_input& e)
{
string m ("malformed JSON in " + e.name + " request body");
error << m << ", line: " << e.line << ", column: " << e.column
<< ", byte offset: " << e.position << ", error: " << e;
throw invalid_request (400, move (m));
}
if (pr.action == "opened" || pr.action == "synchronize")
{
// opened
// A pull request was opened.
//
// synchronize
// A pull request's head branch was updated from the base branch or
// new commits were pushed to the head branch. (Note that there is
// no equivalent event for the base branch. That case gets handled
// in handle_check_suite_request() instead. @@ Not anymore.)
//
// Note that both cases are handled the same: we start a new CI
// request which will be reported on the new commit id.
//
return handle_pull_request (move (pr), warning_success);
}
else
{
// Ignore the remaining actions by sending a 200 response with empty
// body.
//
// @@ Ignore known but log unknown, as in check_suite above?
//
return true;
}
}
else
{
// Log to investigate.
//
error << "unexpected event '" << event << "'";
throw invalid_request (400, "unexpected event: '" + event + "'");
}
}
// Let's capitalize the synthetic conclusion check run name to make it
// easier to distinguish from the regular ones.
//
static string conclusion_check_run_name ("CONCLUSION");
// Return the colored circle corresponding to a result_status.
//
static string
circle (result_status rs)
{
switch (rs)
{
case result_status::success: return "\U0001F7E2"; // Green circle.
case result_status::warning: return "\U0001F7E0"; // Orange circle.
case result_status::error:
case result_status::abort:
case result_status::abnormal: return "\U0001F534"; // Red circle.
// Valid values we should never encounter.
//
case result_status::skip:
case result_status::interrupt:
throw invalid_argument ("unexpected result_status value: " +
to_string (rs));
}
return ""; // Should never reach.
}
// Make a check run summary from a CI start_result.
//
static string
to_check_run_summary (const optional<ci_start::start_result>& r)
{
string s;
s = "```\n";
if (r) s += r->message;
else s += "Internal service error";
s += "\n```";
return s;
}
bool ci_github::
handle_check_suite_request (gh_check_suite_event cs, bool warning_success)
{
HANDLER_DIAG;
l3 ([&]{trace << "check_suite event { " << cs << " }";});
// While we don't need the installation access token in this request,
// let's obtain it to flush out any permission issues early. Also, it is
// valid for an hour so we will most likely make use of it.
//
optional<string> jwt (generate_jwt (trace, error));
if (!jwt)
throw server_error ();
optional<gh_installation_access_token> iat (
obtain_installation_access_token (cs.installation.id,
move (*jwt),
error));
if (!iat)
throw server_error ();
l3 ([&]{trace << "installation_access_token { " << *iat << " }";});
// @@ What happens if we call this functions with an already existing
// node_id (e.g., replay attack). See the UUID header above.
//
// While it would have been nice to cancel CIs of PRs with this branch as
// base not to waste resources, there are complications: Firsty, we can
// only do this for remote PRs (since local PRs may share the result with
// branch push). Secondly, we try to do our best even if the branch
// protection rule for head behind is not enabled. In this case, it would
// be good to complete the CI. So maybe/later.
// Service id that uniquely identifies the CI tenant.
//
string sid (cs.repository.node_id + ":" + cs.check_suite.head_sha);
// If the user requests a rebuild of the (entire) PR, then this manifests
// as the check_suite rather than pull_request event. Specifically:
//
// - For a local PR, this event is shared with the branch push and all we
// need to do is restart the CI for the head commit.
//
// - For a remote PR, this event will have no gh_check_suite::head_branch.
// In this case we need to load the existing service data for this head
// commit, extract the test merge commit, and restart the CI for that.
//
// Note that it's possible the base branch has moved in the meantime and
// ideally we would want to re-request the test merge commit, etc.
// However, this will only be necessary if the user does not follow our
// recommendation of enabling the head-behind-base protection. And it
// seems all this extra complexity would not be warranted.
//
string check_sha;
service_data::kind_type kind;
bool re_requested (cs.action == "rerequested");
if (re_requested && !cs.check_suite.head_branch)
{
kind = service_data::remote;
if (optional<pair<tenant_service, bool>> p =
find (*build_db_, "ci-github", sid))
{
tenant_service& ts (p->first);
try
{
service_data sd (*ts.data);
check_sha = move (sd.check_sha); // Test merge commit.
}
catch (const invalid_argument& e)
{
fail << "failed to parse service data: " << e;
}
}
else
{
error << "check suite " << cs.check_suite.node_id
<< " for remote pull request:"
<< " re-requested but tenant_service with id " << sid
<< " did not exist";
return true;
}
}
else
{
// Branch push or local PR rebuild.
//
kind = service_data::local;
check_sha = cs.check_suite.head_sha;
}
service_data sd (warning_success,
iat->token,
iat->expires_at,
cs.installation.id,
move (cs.repository.node_id),
move (cs.repository.clone_url),
kind, false /* pre_check */, re_requested,
move (check_sha),
move (cs.check_suite.head_sha) /* report_sha */);
// If this check suite is being re-run, replace the existing CI tenant if
// it exists; otherwise create a new one, doing nothing if a tenant
// already exists (which could've been created by handle_pull_request()).
//
// Note that GitHub UI does not allow re-running the entire check suite
// until all the check runs are completed.
//
duplicate_tenant_mode dtm (re_requested
? duplicate_tenant_mode::replace
: duplicate_tenant_mode::ignore);
// Create an unloaded CI tenant.
//
// Note: use no delay since we need to (re)create the synthetic conclusion
// check run as soon as possible.
//
// Note that we use the create() API instead of start() since duplicate
// management is not available in start().
//
// After this call we will start getting the build_unloaded()
// notifications until (1) we load the tenant, (2) we cancel it, or (3)
// it gets archived after some timeout.
//
auto pr (create (error,
warn,
verb_ ? &trace : nullptr,
*build_db_, retry_,
tenant_service (sid, "ci-github", sd.json ()),
chrono::seconds (30) /* interval */,
chrono::seconds (0) /* delay */,
dtm));
if (!pr)
{
fail << "check suite " << cs.check_suite.node_id
<< ": unable to create unloaded CI tenant";
}
if (dtm == duplicate_tenant_mode::replace &&
pr->second == duplicate_tenant_result::created)
{
error << "check suite " << cs.check_suite.node_id
<< ": re-requested but tenant_service with id " << sid
<< " did not exist";
return true;
}
return true;
}
// Create a gq_built_result.
//
static gq_built_result
make_built_result (result_status rs, bool warning_success, string message)
{
return {gh_to_conclusion (rs, warning_success),
circle (rs) + ' ' + ucase (to_string (rs)),
move (message)};
}
// Parse a check run details URL into a build_id.
//
// Return nullopt if the URL is invalid.
//
static optional<build_id>
parse_details_url (const string& details_url);
// Note that GitHub always posts a message to their GUI saying "You have
// successfully requested <check_run_name> be rerun", regardless of what
// HTTP status code we respond with. However we do return error status codes
// when there is no better option (like failing the conclusion) in case they
// start handling them someday.
//
bool ci_github::
handle_check_run_rerequest (const gh_check_run_event& cr,
bool warning_success)
{
HANDLER_DIAG;
l3 ([&]{trace << "check_run event { " << cr << " }";});
// The overall plan is as follows:
//
// 1. Load service data.
//
// 2. If the tenant is archived, then fail (re-create) both the check run
// and the conclusion with appropriate diagnostics.
//
// 3. If the check run is in the queued state, then do nothing.
//
// 4. Re-create the check run in the queued state and the conclusion in
// the building state. Note: do in a single request to make sure we
// either "win" or "loose" the potential race for both (important
// for #7).
//
// 5. Call the rebuild() function to attempt to schedule a rebuild. Pass
// the update function that does the following (if called):
//
// a. Save new node ids.
//
// b. Update the check run state (may also not exist).
//
// c. Clear the completed flag if true.
//
// 6. If the result of rebuild() indicates the tenant is archived, then
// fail (update) both the check run and conclusion with appropriate
// diagnostics.
//
// 7. If original state is queued (no rebuild was scheduled), then fail
// (update) both the check run and the conclusion.
//
// Note that while conceptually we are updating existing check runs, in
// practice we have to re-create as new check runs in order to replace the
// existing ones because GitHub does not allow transitioning out of the
// built state.
// Get a new installation access token.
//
auto get_iat = [this, &trace, &error, &cr] ()
-> optional<gh_installation_access_token>
{
optional<string> jwt (generate_jwt (trace, error));
if (!jwt)
return nullopt;
optional<gh_installation_access_token> iat (
obtain_installation_access_token (cr.installation.id,
move (*jwt),
error));
if (iat)
l3 ([&]{trace << "installation_access_token { " << *iat << " }";});
return iat;
};
const string& repo_node_id (cr.repository.node_id);
const string& head_sha (cr.check_run.check_suite.head_sha);
// Prepare the build and conclusion check runs. They are sent to GitHub in
// a single request (unless something goes wrong) so store them together
// from the outset.
//
vector<check_run> check_runs (2);
check_run& bcr (check_runs[0]); // Build check run
check_run& ccr (check_runs[1]); // Conclusion check run
ccr.name = conclusion_check_run_name;
// Load the service data, failing the check runs if the tenant has been
// archived.
//
service_data sd;
{
// Service id that uniquely identifies the CI tenant.
//
string sid (repo_node_id + ':' + head_sha);
if (optional<pair<tenant_service, bool>> p =
find (*build_db_, "ci-github", sid))
{
if (p->second) // Tenant is archived
{
// Fail (re-create) the check runs.
//
optional<gh_installation_access_token> iat (get_iat ());
if (!iat)
throw server_error ();
gq_built_result br (
make_built_result (
result_status::error, warning_success,
"Unable to rebuild individual configuration: build has "
"been archived"));
// Try to update the conclusion check run even if the first update
// fails.
//
bool f (false); // Failed.
if (gq_create_check_run (error, bcr, iat->token,
repo_node_id, head_sha,
cr.check_run.details_url,
build_state::built, br))
{
l3 ([&]{trace << "created check_run { " << bcr << " }";});
}
else
{
error << "check_run " << cr.check_run.node_id
<< ": unable to re-create check run";
f = true;
}
if (gq_create_check_run (error, ccr, iat->token,
repo_node_id, head_sha,
nullopt /* details_url */,
build_state::built, move (br)))
{
l3 ([&]{trace << "created conclusion check_run { " << ccr << " }";});
}
else
{
error << "check_run " << cr.check_run.node_id
<< ": unable to re-create conclusion check run";
f = true;
}
// Fail the handler if either of the check runs could not be
// updated.
//
if (f)
throw server_error ();
return true;
}
tenant_service& ts (p->first);
try
{
sd = service_data (*ts.data);
}
catch (const invalid_argument& e)
{
fail << "failed to parse service data: " << e;
}
}
else
{
// No such tenant.
//
fail << "check run " << cr.check_run.node_id
<< " re-requested but tenant_service with id " << sid
<< " does not exist";
}
}
// Get a new IAT if the one from the service data has expired.
//
const gh_installation_access_token* iat (nullptr);
optional<gh_installation_access_token> new_iat;
if (system_clock::now () > sd.installation_access.expires_at)
{
if ((new_iat = get_iat ()))
iat = &*new_iat;
else
throw server_error ();
}
else
iat = &sd.installation_access;
// Fail if it's the conclusion check run that is being re-requested.
//
if (cr.check_run.name == conclusion_check_run_name)
{
l3 ([&]{trace << "re-requested conclusion check_run";});
if (!sd.conclusion_node_id)
fail << "no conclusion node id for check run " << cr.check_run.node_id;
gq_built_result br (
make_built_result (result_status::error, warning_success,
"Conclusion check run cannot be rebuilt"));
// Fail (update) the conclusion check run.
//
if (gq_update_check_run (error, ccr, iat->token,
repo_node_id, *sd.conclusion_node_id,
nullopt /* details_url */,
build_state::built, move (br)))
{
l3 ([&]{trace << "updated conclusion check_run { " << ccr << " }";});
}
else
{
fail << "check run " << cr.check_run.node_id
<< ": unable to update conclusion check run "
<< *sd.conclusion_node_id;
}
return true;
}
// Parse the check_run's details_url to extract build id.
//
// While this is a bit hackish, there doesn't seem to be a better way
// (like associating custom data with a check run). Note that the GitHub
// UI only allows rebuilding completed check runs, so the details URL
// should be there.
//
optional<build_id> bid (parse_details_url (cr.check_run.details_url));
if (!bid)
{
fail << "check run " << cr.check_run.node_id
<< ": failed to extract build id from details_url";
}
// Initialize the check run (`bcr`) with state from the service data.
//
{
// Search for the check run in the service data.
//
// Note that we look by name in case node id got replaced by a racing
// re-request (in which case we ignore this request).
//
auto i (find_if (sd.check_runs.begin (), sd.check_runs.end (),
[&cr] (const check_run& scr)
{
return scr.name == cr.check_run.name;
}));
if (i == sd.check_runs.end ())
fail << "check_run " << cr.check_run.node_id
<< " (" << cr.check_run.name << "): "
<< "re-requested but does not exist in service data";
// Do nothing if node ids don't match.
//
if (i->node_id && *i->node_id != cr.check_run.node_id)
{
l3 ([&]{trace << "check_run " << cr.check_run.node_id
<< " (" << cr.check_run.name << "): "
<< "node id has changed in service data";});
return true;
}
// Do nothing if the build is already queued.
//
if (i->state == build_state::queued)
{
l3 ([&]{trace << "ignoring already-queued check run";});
return true;
}
bcr.name = i->name;
bcr.build_id = i->build_id;
bcr.state = i->state;
}
// Transition the build and conclusion check runs out of the built state
// (or any other state) by re-creating them.
//
bcr.state = build_state::queued;
bcr.state_synced = false;
bcr.details_url = cr.check_run.details_url;
ccr.state = build_state::building;
ccr.state_synced = false;
if (gq_create_check_runs (error, check_runs, iat->token,
repo_node_id, head_sha))
{
assert (bcr.state == build_state::queued);
assert (ccr.state == build_state::building);
l3 ([&]{trace << "created check_run { " << bcr << " }";});
l3 ([&]{trace << "created conclusion check_run { " << ccr << " }";});
}
else
{
fail << "check run " << cr.check_run.node_id
<< ": unable to re-create build and conclusion check runs";
}
// Request the rebuild and update service data.
//
bool race (false);
// Callback function called by rebuild() to update the service data (but
// only if the build is actually restarted).
//
auto update_sd = [&error, &new_iat, &race,
&cr, &bcr, &ccr] (const tenant_service& ts,
build_state) -> optional<string>
{
// NOTE: this lambda may be called repeatedly (e.g., due to transaction
// being aborted) and so should not move out of its captures.
race = false; // Reset.
service_data sd;
try
{
sd = service_data (*ts.data);
}
catch (const invalid_argument& e)
{
error << "failed to parse service data: " << e;
return nullopt;
}
// Note that we again look by name in case node id got replaced by a
// racing re-request. In this case, however, it's impossible to decide
// who won that race, so let's fail the check suite to be on the safe
// side (in a sense, similar to the rebuild() returning queued below).
//
auto i (find_if (
sd.check_runs.begin (), sd.check_runs.end (),
[&cr] (const check_run& scr)
{
return scr.name == cr.check_run.name;
}));
if (i == sd.check_runs.end ())
{
error << "check_run " << cr.check_run.node_id
<< " (" << cr.check_run.name << "): "
<< "re-requested but does not exist in service data";
return nullopt;
}
if (i->node_id && *i->node_id != cr.check_run.node_id)
{
// Keep the old conclusion node id to make sure any further state
// transitions are ignored. A bit of a hack.
//
race = true;
return nullopt;
}
*i = bcr; // Update with new node_id, state, state_synced.
sd.conclusion_node_id = ccr.node_id;
sd.completed = false;
// Save the IAT if we created a new one.
//
if (new_iat)
sd.installation_access = *new_iat;
return sd.json ();
};
optional<build_state> bs (rebuild (*build_db_, retry_, *bid, update_sd));
// If the build has been archived or re-enqueued since we loaded the
// service data, fail (by updating) both the build check run and the
// conclusion check run. Otherwise the build has been successfully
// re-enqueued so do nothing further.
//
if (!race && bs && *bs != build_state::queued)
return true;
gq_built_result br; // Built result for both check runs.
if (race || bs) // Race or re-enqueued.
{
// The re-enqueued case: this build has been re-enqueued since we first
// loaded the service data. This could happen if the user clicked
// "re-run" multiple times and another handler won the rebuild() race.
//
// However the winner of the check runs race cannot be determined.
//
// Best case the other handler won the check runs race as well and
// thus everything will proceed normally. Our check runs will be
// invisible and disregarded.
//
// Worst case we won the check runs race and the other handler's check
// runs -- the ones that will be updated by the build_*() notifications
// -- are no longer visible, leaving things quite broken.
//
// Either way, we fail our check runs. In the best case scenario it
// will have no effect; in the worst case scenario it lets the user
// know something has gone wrong.
//
br = make_built_result (result_status::error, warning_success,
"Unable to rebuild, try again");
}
else // Archived.
{
// The build has expired since we loaded the service data. Most likely
// the tenant has been archived.
//
br = make_built_result (
result_status::error, warning_success,
"Unable to rebuild individual configuration: build has been archived");
}
// Try to update the conclusion check run even if the first update fails.
//
bool f (false); // Failed.
// Fail the build check run.
//
if (gq_update_check_run (error, bcr, iat->token,
repo_node_id, *bcr.node_id,
nullopt /* details_url */,
build_state::built, br))
{
l3 ([&]{trace << "updated check_run { " << bcr << " }";});
}
else
{
error << "check run " << cr.check_run.node_id
<< ": unable to update (replacement) check run "
<< *bcr.node_id;
f = true;
}
// Fail the conclusion check run.
//
if (gq_update_check_run (error, ccr, iat->token,
repo_node_id, *ccr.node_id,
nullopt /* details_url */,
build_state::built, move (br)))
{
l3 ([&]{trace << "updated conclusion check_run { " << ccr << " }";});
}
else
{
error << "check run " << cr.check_run.node_id
<< ": unable to update conclusion check run " << *ccr.node_id;
f = true;
}
// Fail the handler if either of the check runs could not be updated.
//
if (f)
throw server_error ();
return true;
}
// @@ TMP
//
#if 0
bool ci_github::
handle_check_run_rerequest (const gh_check_run_event& cr,
bool warning_success)
{
HANDLER_DIAG;
l3 ([&]{trace << "check_run event { " << cr << " }";});
// Fail if this is the conclusion check run.
//
if (cr.check_run.name == conclusion_check_run_name)
{
// @@ Fail conclusion check run with appropriate message and reurn
// true.
l3 ([&]{trace << "ignoring conclusion check_run";});
// 422 Unprocessable Content: The request was well-formed (i.e.,
// syntactically correct) but could not be processed.
//
throw invalid_request (422, "Conclusion check run cannot be rebuilt");
}
// Get a new installation access token.
//
auto get_iat = [this, &trace, &error, &cr] ()
-> optional<gh_installation_access_token>
{
optional<string> jwt (generate_jwt (trace, error));
if (!jwt)
return nullopt;
optional<gh_installation_access_token> iat (
obtain_installation_access_token (cr.installation.id,
move (*jwt),
error));
if (iat)
l3 ([&]{trace << "installation_access_token { " << *iat << " }";});
return iat;
};
// Create a new conclusion check run, replacing the existing one.
//
// Return the check run on success or nullopt on failure.
//
auto create_conclusion_cr =
[&cr, &error, warning_success] (const gh_installation_access_token& iat,
build_state bs,
optional<result_status> rs = nullopt,
optional<string> msg = nullopt)
-> optional<check_run>
{
optional<gq_built_result> br;
if (rs)
{
assert (msg);
br = make_built_result (*rs, warning_success, move (*msg));
}
check_run r;
r.name = conclusion_check_run_name;
if (gq_create_check_run (error, r, iat.token,
rni, hs,
nullopt /* details_url */,
bs, move (br)))
{
return r;
}
else
return nullopt;
};
// The overall plan is as follows:
//
// 1. Call the rebuild() function to attempt to schedule a rebuild. Pass
// the update function that does the following (if called):
//
// a. Update the check run being rebuilt (may also not exist).
//
// b. Clear the completed flag if true.
//
// c. "Return" the service data to be used after the call.
//
// 2. If the result of rebuild() indicates the tenant is archived, fail
// the conclusion check run with appropriate diagnostics.
//
// 3. If original state is queued, then no rebuild was scheduled and we do
// nothing.
//
// 4. Otherwise (the original state is building or built):
//
// a. Change the check run state to queued.
//
// b. Change the conclusion check run to building (do unconditionally
// to mitigate races).
//
// Note that while conceptually we are updating existing check runs, in
// practice we have to create new check runs to replace the existing ones
// because GitHub does not allow transitioning out of the built state.
//
// This results in a new node id for each check run but we can't save them
// to the service data after the rebuild() call. As a workaround, when
// updating the service data we 1) clear the re-requested check run's node
// id and set the state_synced flag to true to signal to build_building()
// and build_built() that it needs to create a new check run; and 2) clear
// the conclusion check run's node id to cause build_built() to create a
// new conclusion check run. And these two check runs' node ids will be
// saved to the service data.
// Parse the check_run's details_url to extract build id.
//
// While this is a bit hackish, there doesn't seem to be a better way
// (like associating custom data with a check run). Note that the GitHub
// UI only allows rebuilding completed check runs, so the details URL
// should be there.
//
optional<build_id> bid (parse_details_url (cr.check_run.details_url));
if (!bid)
{
fail << "check run " << cr.check_run.node_id
<< ": failed to extract build id from details_url";
}
// The IAT retrieved from the service data.
//
optional<gh_installation_access_token> iat;
// True if the check run exists in the service data.
//
bool cr_found (false);
// Update the state of the check run in the service data. Return (via
// captured references) the IAT and whether the check run was found.
//
// Called by rebuild(), but only if the build is actually restarted.
//
auto update_sd = [&iat,
&cr_found,
&error,
&cr] (const tenant_service& ts, build_state)
-> optional<string>
{
// NOTE: this lambda may be called repeatedly (e.g., due to transaction
// being aborted) and so should not move out of its captures.
service_data sd;
try
{
sd = service_data (*ts.data);
}
catch (const invalid_argument& e)
{
error << "failed to parse service data: " << e;
return nullptr;
}
if (!iat)
iat = sd.installation_access;
// If the re-requested check run is found, update it in the service
// data.
//
const string& nid (cr.check_run.node_id);
for (check_run& cr: sd.check_runs)
{
if (cr.node_id && *cr.node_id == nid)
{
cr_found = true;
cr.state = build_state::queued;
sd.completed = false;
// Clear the check run node ids and set state_synced to true to
// cause build_building() and/or build_built() to create new check
// runs (see the plan above for details).
//
cr.node_id = nullopt;
cr.state_synced = true;
sd.conclusion_node_id = nullopt;
return sd.json ();
}
}
return nullopt;
};
optional<build_state> bs (rebuild (*build_db_, retry_, *bid, update_sd));
if (!bs)
{
// Build has expired (most probably the tenant has been archived).
//
// Update the conclusion check run to notify the user (but have to
// replace it with a new one because we don't know the existing one's
// node id).
//
optional<gh_installation_access_token> iat (get_iat ());
if (!iat)
throw server_error ();
if (optional<check_run> ccr = create_conclusion_cr (
*iat,
build_state::built,
result_status::error,
"Unable to rebuild: tenant has been archived or no such build"))
{
l3 ([&]{trace << "created conclusion check_run { " << *ccr << " }";});
}
else
{
// Log the error and return failure to GitHub which will presumably
// indicate this in its GUI.
//
fail << "check run " << cr.check_run.node_id
<< ": unable to create conclusion check run";
}
}
else if (*bs == build_state::queued)
{
// The build was already queued so nothing to be done. This might happen
// if the user clicked "re-run" multiple times before we managed to
// update the check run.
}
else
{
// The build has been requeued.
//
assert (*bs == build_state::building || *bs == build_state::built);
if (!cr_found)
{
// Respond with an error otherwise GitHub will post a message in its
// GUI saying "you have successfully requested a rebuild of ..."
//
fail << "check_run " << cr.check_run.node_id
<< ": build restarted but check run does not exist "
<< "in service data";
}
// Get a new IAT if the one from the service data has expired.
//
assert (iat.has_value ());
if (system_clock::now () > iat->expires_at)
{
iat = get_iat ();
if (!iat)
throw server_error ();
}
// Update (by replacing) the re-requested and conclusion check runs to
// queued and building, respectively.
//
// If either fails we can only log the error but build_building() and/or
// build_built() should correct the situation (see above for details).
//
// Update re-requested check run.
//
{
check_run ncr; // New check run.
ncr.name = cr.check_run.name;
if (gq_create_check_run (error,
ncr,
iat->token,
cr.repository.node_id,
cr.check_run.check_suite.head_sha,
cr.check_run.details_url,
build_state::queued))
{
l3 ([&]{trace << "created check_run { " << ncr << " }";});
}
else
{
error << "check_run " << cr.check_run.node_id
<< ": unable to create (to update) check run in queued state";
}
}
// Update conclusion check run.
//
if (optional<check_run> ccr =
create_conclusion_cr (*iat, build_state::building))
{
l3 ([&]{trace << "created conclusion check_run { " << *ccr << " }";});
}
else
{
error << "check_run " << cr.check_run.node_id
<< ": unable to create (to update) conclusion check run";
}
}
return true;
}
#endif
// Miscellaneous pull request facts
//
// - Although some of the GitHub documentation makes it sound like they
// expect check runs to be added to both the PR head commit and the merge
// commit, the PR UI does not react to the merge commit's check runs
// consistently. It actually seems to be quite broken. The only thing it
// does seem to do reliably is blocking the PR merge if the merge commit's
// check runs are not successful (i.e, overriding the PR head commit's
// check runs). But the UI looks quite messed up generally in this state.
//
// - When new commits are added to a PR base branch, pull_request.base.sha
// does not change, but the test merge commit will be updated to include
// the new commits to the base branch.
//
// - When new commits are added to a PR head branch, pull_request.head.sha
// gets updated with the head commit's SHA and check_suite.pull_requests[]
// will contain all PRs with this branch as head.
//
// Remaining TODOs
//
// - @@ TODO? PR base branch changed (to a different branch)
//
// => pull_request(edited)
//
// - PR closed @@ TODO
//
// Also received if base branch is deleted. (And presumably same for head
// branch.)
//
// => pull_request(closed)
//
// Cancel CI?
//
// - PR merged @@ TODO
//
// => pull_request(merged)
//
// => check_suite(PR_base)
//
// Probably wouldn't want to CI the base again because the PR CI would've
// done the equivalent already.
//
bool ci_github::
handle_pull_request (gh_pull_request_event pr, bool warning_success)
{
HANDLER_DIAG;
l3 ([&]{trace << "pull_request event { " << pr << " }";});
// While we don't need the installation access token in this request,
// let's obtain it to flush out any permission issues early. Also, it is
// valid for an hour so we will most likely make use of it.
//
optional<string> jwt (generate_jwt (trace, error));
if (!jwt)
throw server_error ();
optional<gh_installation_access_token> iat (
obtain_installation_access_token (pr.installation.id,
move (*jwt),
error));
if (!iat)
throw server_error ();
l3 ([&]{trace << "installation_access_token { " << *iat << " }";});
// Note that similar to the branch push case above, while it would have
// been nice to cancel the previous CI job once the PR head moves (the
// "synchronize" event), due to the head sharing problem the previous CI
// job might actually still be relevant (in both local and remote PR
// cases).
// Distinguish between local and remote PRs by comparing the head and base
// repositories' paths.
//
service_data::kind_type kind (
pr.pull_request.head_path == pr.pull_request.base_path
? service_data::local
: service_data::remote);
// Note: for remote PRs the check_sha will be set later, in
// build_unloaded_pre_check(), to test merge commit id.
//
string check_sha (kind == service_data::local
? pr.pull_request.head_sha
: "");
// Note that PR rebuilds (re-requested) are handled by check_suite().
//
// Note that, in the case of a remote PR, GitHub will copy the PR head
// commit from the head (forked) repository into the base repository. So
// the check runs must always be added to the base repository, whether the
// PR is local or remote. The head commit refs are located at
// refs/pull/<PR-number>/head.
//
service_data sd (warning_success,
move (iat->token),
iat->expires_at,
pr.installation.id,
move (pr.repository.node_id),
move (pr.repository.clone_url),
kind, true /* pre_check */, false /* re_request */,
move (check_sha),
move (pr.pull_request.head_sha) /* report_sha */,
pr.pull_request.node_id,
pr.pull_request.number);
// Create an unloaded CI tenant for the pre-check phase (during which we
// wait for the PR's merge commit and behindness to become available).
//
// Create with an empty service id so that the generated tenant id is used
// instead during the pre-check phase (so as not to clash with a proper
// service id for this head commit, potentially created in
// handle_check_suite() or as another PR).
//
tenant_service ts ("", "ci-github", sd.json ());
// Note: use no delay since we need to start the actual CI (which in turn
// (re)creates the synthetic conclusion check run) as soon as possible.
//
// After this call we will start getting the build_unloaded()
// notifications -- which will be routed to build_unloaded_pre_check() --
// until we cancel the tenant or it gets archived after some timeout.
// (Note that we never actually load this request, we always cancel it;
// see build_unloaded_pre_check() for details.)
//
if (!create (error,
warn,
verb_ ? &trace : nullptr,
*build_db_, retry_,
move (ts),
chrono::seconds (30) /* interval */,
chrono::seconds (0) /* delay */))
{
fail << "pull request " << pr.pull_request.node_id
<< ": unable to create unloaded pre-check tenant";
}
return true;
}
function<optional<string> (const tenant_service&)> ci_github::
build_unloaded (tenant_service&& ts,
const diag_epilogue& log_writer) const noexcept
{
NOTIFICATION_DIAG (log_writer);
service_data sd;
try
{
sd = service_data (*ts.data);
}
catch (const invalid_argument& e)
{
error << "failed to parse service data: " << e;
return nullptr;
}
return sd.pre_check
? build_unloaded_pre_check (move (ts), move (sd), log_writer)
: build_unloaded_load (move (ts), move (sd), log_writer);
}
function<optional<string> (const tenant_service&)> ci_github::
build_unloaded_pre_check (tenant_service&& ts,
service_data&& sd,
const diag_epilogue& log_writer) const noexcept
{
NOTIFICATION_DIAG (log_writer);
// We get here for PRs only (but both local and remote). The overall
// plan is as follows:
//
// 1. Ask for the mergeability/behind status/test merge commit.
//
// 2. If not ready, get called again.
//
// 3. If not mergeable, behind, or different head (head changed while
// waiting for merge commit and thus differs from what's in the
// service_data), cancel the pre-check tenant and do nothing.
//
// 4. Otherwise, create an unloaded CI tenant and cancel ourselves. Note
// that all re-requested cases are handled elsewhere.
//
// Note that in case of a mixed local/remote case, whether we CI the head
// commit or test merge commit will be racy and there is nothing we can do
// about (the purely local case can get "upgraded" to mixed after we have
// started the CI job).
//
// Request PR pre-check info (triggering the generation of the test merge
// commit on the GitHub's side).
//
optional<gq_pr_pre_check_info> pc (
gq_fetch_pull_request_pre_check_info (error,
sd.installation_access.token,
*sd.pr_node_id));
if (!pc)
{
// Test merge commit not available yet: get called again to retry.
//
return nullptr;
}
// Create the CI tenant if nothing is wrong, otherwise issue diagnostics.
//
if (pc->behind)
{
l3 ([&]{trace << "ignoring pull request " << *sd.pr_node_id
<< ": head is behind base";});
}
else if (!pc->merge_commit_sha)
{
l3 ([&]{trace << "ignoring pull request " << *sd.pr_node_id
<< ": not auto-mergeable";});
}
else if (pc->head_sha != sd.report_sha)
{
l3 ([&]{trace << "ignoring pull request " << *sd.pr_node_id
<< ": head commit has changed";});
}
else
{
// Create the CI tenant by reusing the pre-check service data.
//
sd.pre_check = false;
// Set the service data's check_sha if this is a remote PR. The test
// merge commit refs are located at refs/pull/<PR-number>/merge.
//
if (sd.kind == service_data::remote)
sd.check_sha = *pc->merge_commit_sha;
// Service id that will uniquely identify the CI tenant.
//
string sid (sd.repository_node_id + ":" + sd.report_sha);
// Create an unloaded CI tenant, doing nothing if one already exists
// (which could've been created by a head branch push or another PR
// sharing the same head commit).
//
// Note: use no delay since we need to (re)create the synthetic
// conclusion check run as soon as possible.
//
// Note that we use the create() API instead of start() since duplicate
// management is not available in start().
//
// After this call we will start getting the build_unloaded()
// notifications until (1) we load the tenant, (2) we cancel it, or (3)
// it gets archived after some timeout.
//
if (auto pr = create (error, warn, verb_ ? &trace : nullptr,
*build_db_, retry_,
tenant_service (sid, "ci-github", sd.json ()),
chrono::seconds (30) /* interval */,
chrono::seconds (0) /* delay */,
duplicate_tenant_mode::ignore))
{
if (pr->second == duplicate_tenant_result::ignored)
{
// This PR is sharing a head commit with something else.
//
// If this is a local PR then it's probably the branch push, which
// is expected, so do nothing.
//
// If this is a remote PR then it could be anything (branch push,
// local PR, or another remote PR) which in turn means the CI result
// may end up being for head, not merge commit. There is nothing we
// can do about it on our side (the user can enable the head-behind-
// base protection on their side).
//
if (sd.kind == service_data::remote)
{
l3 ([&]{trace << "remote pull request " << *sd.pr_node_id
<< ": CI tenant already exists for " << sid;});
}
}
}
else
{
error << "pull request " << *sd.pr_node_id
<< ": unable to create unloaded CI tenant "
<< "with tenant_service id " << sid;
// Fall through to cancel.
}
}
// Cancel the pre-check tenant.
//
if (!cancel (error, warn, verb_ ? &trace : nullptr,
*build_db_, retry_,
ts.type,
ts.id))
{
// Should never happen (no such tenant).
//
error << "pull request " << *sd.pr_node_id
<< ": failed to cancel pre-check tenant with tenant_service id "
<< ts.id;
}
return nullptr;
}
function<optional<string> (const tenant_service&)> ci_github::
build_unloaded_load (tenant_service&& ts,
service_data&& sd,
const diag_epilogue& log_writer) const noexcept
{
NOTIFICATION_DIAG (log_writer);
// Load the tenant, which is essentially the same for both branch push and
// PR. The overall plan is as follows:
//
// - Create synthetic conclusion check run with the in-progress state. If
// unable to, get called again to re-try.
//
// - Load the tenant. If unable to, fail the conclusion check run.
//
// - Update service data.
//
// Get a new installation access token if the current one has expired.
//
const gh_installation_access_token* iat (nullptr);
optional<gh_installation_access_token> new_iat;
if (system_clock::now () > sd.installation_access.expires_at)
{
if (optional<string> jwt = generate_jwt (trace, error))
{
new_iat = obtain_installation_access_token (sd.installation_id,
move (*jwt),
error);
if (new_iat)
iat = &*new_iat;
}
}
else
iat = &sd.installation_access;
if (iat == nullptr)
return nullptr; // Try again on the next call.
// Create a synthetic check run with an in-progress state. Return the
// check run on success or nullopt on failure.
//
auto create_synthetic_cr = [iat,
&sd,
&error] (string name) -> optional<check_run>
{
check_run cr;
cr.name = move (name);
if (gq_create_check_run (error,
cr,
iat->token,
sd.repository_node_id,
sd.report_sha,
nullopt /* details_url */,
build_state::building))
{
return cr;
}
else
return nullopt;
};
// Update a synthetic check run with success or failure. Return the check
// run on success or nullopt on failure.
//
auto update_synthetic_cr = [iat,
&sd,
&error] (const string& node_id,
const string& name,
result_status rs,
string summary) -> optional<check_run>
{
assert (!node_id.empty ());
gq_built_result br (
make_built_result (rs, sd.warning_success, move (summary)));
check_run cr;
cr.name = name; // For display purposes only.
if (gq_update_check_run (error,
cr,
iat->token,
sd.repository_node_id,
node_id,
nullopt /* details_url */,
build_state::built,
move (br)))
{
assert (cr.state == build_state::built);
return cr;
}
else
return nullopt;
};
// Note that there is a window between receipt of a check_suite or
// pull_request event and the first bot/worker asking for a task, which
// could be substantial. We could probably (also) try to (re)create the
// conclusion checkrun in the webhook handler. @@ Maybe/later.
// (Re)create the synthetic conclusion check run first in order to convert
// a potentially completed check suite to building as early as possible.
//
string conclusion_node_id; // Conclusion check run node ID.
if (auto cr = create_synthetic_cr (conclusion_check_run_name))
{
l3 ([&]{trace << "created check_run { " << *cr << " }";});
conclusion_node_id = move (*cr->node_id);
}
// Load the CI tenant if the conclusion check run was created.
//
if (!conclusion_node_id.empty ())
{
string ru; // Repository URL.
// CI the test merge commit for remote PRs and the head commit for
// everything else (branch push or local PRs).
//
if (sd.kind == service_data::remote)
{
// E.g. #pull/28/merge@1b6c9a361086ed93e6f1e67189e82d52de91c49b
//
ru = sd.repository_clone_url + "#pull/" + to_string (*sd.pr_number) +
"/merge@" + sd.check_sha;
}
else
ru = sd.repository_clone_url + '#' + sd.check_sha;
repository_location rl (move (ru), repository_type::git);
optional<start_result> r (load (error, warn, verb_ ? &trace : nullptr,
*build_db_, retry_,
move (ts),
move (rl)));
if (!r || r->status != 200)
{
if (auto cr = update_synthetic_cr (conclusion_node_id,
conclusion_check_run_name,
result_status::error,
to_check_run_summary (r)))
{
l3 ([&]{trace << "updated check_run { " << *cr << " }";});
}
else
{
// Nothing really we can do in this case since we will not receive
// any further notifications. Log the error as a last resort.
error << "failed to load CI tenant " << ts.id
<< " and unable to update conclusion";
}
return nullptr; // No need to update service data in this case.
}
}
else if (!new_iat)
return nullptr; // Nothing to save (but retry on next call).
return [&error,
iat = move (new_iat),
cni = move (conclusion_node_id)]
(const tenant_service& ts) -> optional<string>
{
// NOTE: this lambda may be called repeatedly (e.g., due to
// transaction being aborted) and so should not move out of its
// captures.
service_data sd;
try
{
sd = service_data (*ts.data);
}
catch (const invalid_argument& e)
{
error << "failed to parse service data: " << e;
return nullopt;
}
if (iat)
sd.installation_access = *iat;
if (!cni.empty ())
sd.conclusion_node_id = cni;
return sd.json ();
};
}
// Build state change notifications (see tenant-services.hxx for
// background). Mapping our state transitions to GitHub pose multiple
// problems:
//
// 1. In our model we have the building->queued (interrupted) and
// built->queued (rebuild) transitions. We are going to ignore both of
// them when notifying GitHub. The first is not important (we expect the
// state to go back to building shortly). The second should normally not
// happen and would mean that a completed check suite may go back on its
// conclusion (which would be pretty confusing for the user). @@@ This
// can/will happen on check run rebuild. Distinguish between internal
// and external rebuilds?
//
// So, for GitHub notifications, we only have the following linear
// transition sequence:
//
// -> queued -> building -> built
//
// Note, however, that because we ignore certain transitions, we can now
// observe "degenerate" state changes that we need to ignore:
//
// building -> [queued] -> building
// built -> [queued] -> ...
//
// 2. As mentioned in tenant-services.hxx, we may observe the notifications
// as arriving in the wrong order. Unfortunately, GitHub provides no
// mechanisms to help with that. In fact, GitHub does not even prevent
// the creation of multiple check runs with the same name (it will always
// use the last created instance, regardless of the status, timestamps,
// etc). As a result, we cannot, for example, rely on the failure to
// create a new check run in response to the queued notification as an
// indication of a subsequent notification (e.g., building) having
// already occurred.
//
// The only aid in this area that GitHub provides is that it prevents
// updating a check run in the built state to a former state (queued or
// building). But one can still create a new check run with the same name
// and a former state.
//
// (Note that we should also be careful if trying to take advantage of
// this "check run override" semantics: each created check run gets a new
// URL and while the GitHub UI will always point to the last created when
// showing the list of check runs, if the user is already on the previous
// check run's URL, nothing will automatically cause them to be
// redirected to the new URL. And so the user may sit on the abandoned
// check run waiting forever for it to be completed.)
//
// As a result, we will deal with the out of order problem differently
// depending on the notification:
//
// queued Skip if there is already a check run in service data,
// otherwise create new.
//
// building Skip if there is no check run in service data or it's
// not in the queued state, otherwise update.
//
// built Update if there is check run in service data unless its
// state is built, otherwise create new.
//
// The rationale for this semantics is as follows: the building
// notification is a "nice to have" and can be skipped if things are not
// going normally. In contrast, the built notification cannot be skipped
// and we must either update the existing check run or create a new one
// (hopefully overriding the one created previously, if any). Note that
// the likelihood of the built notification being performed at the same
// time as queued/building is quite low (unlike queued and building).
//
// Note also that with this semantics it's unlikely but possible that we
// attempt to update the service data in the wrong order. Specifically, it
// feels like this should not be possible in the ->building transition
// since we skip the building notification unless the check run in the
// service data is already in the queued state. But it is theoretically
// possible in the ->built transition. For example, we may be updating
// the service data for the queued notification after it has already been
// updated by the built notification. In such cases we should not be
// overriding the latter state (built) with the former (queued).
//
// 3. We may not be able to "conclusively" notify GitHub, for example, due
// to a transient network error. The "conclusively" part means that the
// notification may or may not have gone through (though it feels the
// common case will be the inability to send the request rather than
// receive the reply).
//
// In such cases, we record in the service data that the notification was
// not synchronized and in subsequent notifications we do the best we can:
// if we have node_id, then we update, otherwise, we create (potentially
// overriding the check run created previously).
//
function<optional<string> (const tenant_service&)> ci_github::
build_queued (const tenant_service& ts,
const vector<build>& builds,
optional<build_state> istate,
const build_queued_hints& hs,
const diag_epilogue& log_writer) const noexcept
{
NOTIFICATION_DIAG (log_writer);
service_data sd;
try
{
sd = service_data (*ts.data);
}
catch (const invalid_argument& e)
{
error << "failed to parse service data: " << e;
return nullptr;
}
// Ignore attempts to add new builds to a completed check suite. This can
// happen, for example, if a new build configuration is added before
// the tenant is archived.
//
if (sd.completed)
return nullptr;
// The builds for which we will be creating check runs.
//
vector<reference_wrapper<const build>> bs;
vector<check_run> crs; // Parallel to bs.
// Exclude the builds for which we won't be creating check runs.
//
for (const build& b: builds)
{
string bid (gh_check_run_name (b)); // Full build id.
if (const check_run* scr = sd.find_check_run (bid))
{
// Another notification has already stored this check run.
//
if (!istate)
{
// Out of order queued notification.
//
warn << "check run " << bid << ": out of order queued "
<< "notification; existing state: " << scr->state_string ();
}
else if (*istate == build_state::built)
{
// Unexpected built->queued transition (rebuild).
//
warn << "check run " << bid << ": unexpected rebuild";
}
else
{
// Ignore interrupted.
//
assert (*istate == build_state::building);
}
}
else
{
// No stored check run for this build so prepare to create one.
//
bs.push_back (b);
crs.emplace_back (move (bid),
gh_check_run_name (b, &hs),
nullopt, /* node_id */
build_state::queued,
false /* state_synced */);
}
}
if (bs.empty ()) // Nothing to do.
return nullptr;
// Get a new installation access token if the current one has expired.
//
const gh_installation_access_token* iat (nullptr);
optional<gh_installation_access_token> new_iat;
if (system_clock::now () > sd.installation_access.expires_at)
{
if (optional<string> jwt = generate_jwt (trace, error))
{
new_iat = obtain_installation_access_token (sd.installation_id,
move (*jwt),
error);
if (new_iat)
iat = &*new_iat;
}
}
else
iat = &sd.installation_access;
// Note: we treat the failure to obtain the installation access token the
// same as the failure to notify GitHub (state is updated by not marked
// synced).
//
if (iat != nullptr)
{
// Create a check_run for each build as a single request.
//
if (gq_create_check_runs (error,
crs,
iat->token,
sd.repository_node_id, sd.report_sha))
{
for (const check_run& cr: crs)
{
// We can only create a check run in the queued state.
//
assert (cr.state == build_state::queued);
l3 ([&]{trace << "created check_run { " << cr << " }";});
}
}
}
return [bs = move (bs),
iat = move (new_iat),
crs = move (crs),
error = move (error),
warn = move (warn)] (const tenant_service& ts) -> optional<string>
{
// NOTE: this lambda may be called repeatedly (e.g., due to transaction
// being aborted) and so should not move out of its captures.
service_data sd;
try
{
sd = service_data (*ts.data);
}
catch (const invalid_argument& e)
{
error << "failed to parse service data: " << e;
return nullopt;
}
if (iat)
sd.installation_access = *iat;
for (size_t i (0); i != bs.size (); ++i)
{
const check_run& cr (crs[i]);
// Note that this service data may not be the same as what we observed
// in the build_queued() function above. For example, some check runs
// that we have queued may have already transitioned to built. So we
// skip any check runs that are already present.
//
if (const check_run* scr = sd.find_check_run (cr.build_id))
{
// Doesn't looks like printing new/existing check run node_id will
// be of any help.
//
warn << "check run " << cr.build_id << ": out of order queued "
<< "notification service data update; existing state: "
<< scr->state_string ();
}
else
sd.check_runs.push_back (cr);
}
return sd.json ();
};
}
function<optional<string> (const tenant_service&)> ci_github::
build_building (const tenant_service& ts,
const build& b,
const diag_epilogue& log_writer) const noexcept
{
NOTIFICATION_DIAG (log_writer);
service_data sd;
try
{
sd = service_data (*ts.data);
}
catch (const invalid_argument& e)
{
error << "failed to parse service data: " << e;
return nullptr;
}
// Similar to build_queued(), ignore attempts to add new builds to a
// completed check suite.
//
if (sd.completed)
return nullptr;
optional<check_run> cr; // Updated check run.
string bid (gh_check_run_name (b)); // Full build id.
if (check_run* scr = sd.find_check_run (bid)) // Stored check run.
{
// Update the check run if it exists on GitHub and the queued
// notification updated the service data, otherwise do nothing.
//
if (scr->state == build_state::queued)
{
if (scr->node_id)
{
cr = move (*scr);
cr->state_synced = false;
}
else
{
// Network error during queued notification, ignore.
}
}
else
warn << "check run " << bid << ": out of order building "
<< "notification; existing state: " << scr->state_string ();
}
else
warn << "check run " << bid << ": out of order building "
<< "notification; no check run state in service data";
if (!cr)
return nullptr;
// Get a new installation access token if the current one has expired.
//
const gh_installation_access_token* iat (nullptr);
optional<gh_installation_access_token> new_iat;
if (system_clock::now () > sd.installation_access.expires_at)
{
if (optional<string> jwt = generate_jwt (trace, error))
{
new_iat = obtain_installation_access_token (sd.installation_id,
move (*jwt),
error);
if (new_iat)
iat = &*new_iat;
}
}
else
iat = &sd.installation_access;
// Note: we treat the failure to obtain the installation access token the
// same as the failure to notify GitHub (state is updated but not marked
// synced).
//
if (iat != nullptr)
{
if (gq_update_check_run (error,
*cr,
iat->token,
sd.repository_node_id,
*cr->node_id,
details_url (b),
build_state::building))
{
// Do nothing further if the state was already built on GitHub (note
// that this is based on the above-mentioned special GitHub semantics
// of preventing changes to the built status).
//
if (cr->state == build_state::built)
{
warn << "check run " << bid << ": already in built state on GitHub";
return nullptr;
}
assert (cr->state == build_state::building);
l3 ([&]{trace << "updated check_run { " << *cr << " }";});
}
}
return [iat = move (new_iat),
cr = move (*cr),
error = move (error),
warn = move (warn)] (const tenant_service& ts) -> optional<string>
{
// NOTE: this lambda may be called repeatedly (e.g., due to transaction
// being aborted) and so should not move out of its captures.
service_data sd;
try
{
sd = service_data (*ts.data);
}
catch (const invalid_argument& e)
{
error << "failed to parse service data: " << e;
return nullopt;
}
if (iat)
sd.installation_access = *iat;
// Update the check run only if it is in the queued state.
//
if (check_run* scr = sd.find_check_run (cr.build_id))
{
if (scr->state == build_state::queued)
*scr = cr;
else
{
warn << "check run " << cr.build_id << ": out of order building "
<< "notification service data update; existing state: "
<< scr->state_string ();
}
}
else
warn << "check run " << cr.build_id << ": service data state has "
<< "disappeared";
return sd.json ();
};
}
function<optional<string> (const tenant_service&)> ci_github::
build_built (const tenant_service& ts,
const build& b,
const diag_epilogue& log_writer) const noexcept
{
// @@ TODO Include service_data::event_node_id and perhaps ts.id in
// diagnostics? E.g. when failing to update check runs we print the
// build ID only.
//
NOTIFICATION_DIAG (log_writer);
service_data sd;
try
{
sd = service_data (*ts.data);
}
catch (const invalid_argument& e)
{
error << "failed to parse service data: " << e;
return nullptr;
}
// Similar to build_queued(), ignore attempts to add new builds to a
// completed check suite.
//
if (sd.completed)
return nullptr;
// Here we need to update the state of this check run and, if there are no
// more unbuilt ones, update the synthetic conclusion check run and mark
// the check suite as completed.
//
// Absent means we still have unbuilt check runs.
//
optional<result_status> conclusion (*b.status);
check_run cr; // Updated check run.
{
string bid (gh_check_run_name (b)); // Full build id.
optional<check_run> scr;
for (check_run& cr: sd.check_runs)
{
if (cr.build_id == bid)
{
assert (!scr);
scr = move (cr);
}
else
{
if (cr.state == build_state::built)
{
assert (cr.status);
if (conclusion)
*conclusion |= *cr.status;
}
else
conclusion = nullopt;
}
if (scr && !conclusion.has_value ())
break;
}
if (scr)
{
if (scr->state != build_state::building)
{
warn << "check run " << bid << ": out of order built notification; "
<< "existing state: " << scr->state_string ();
}
// Do nothing if already built (e.g., rebuild).
//
if (scr->state == build_state::built)
return nullptr;
cr = move (*scr);
}
else
{
warn << "check run " << bid << ": out of order built notification; "
<< "no check run state in service data";
// Note that we have no hints here and so have to use the full build
// id for name.
//
cr.build_id = move (bid);
cr.name = cr.build_id;
}
cr.state_synced = false;
}
// Get a new installation access token if the current one has expired.
//
const gh_installation_access_token* iat (nullptr);
optional<gh_installation_access_token> new_iat;
if (system_clock::now () > sd.installation_access.expires_at)
{
if (optional<string> jwt = generate_jwt (trace, error))
{
new_iat = obtain_installation_access_token (sd.installation_id,
move (*jwt),
error);
if (new_iat)
iat = &*new_iat;
}
}
else
iat = &sd.installation_access;
bool completed (false);
// Note: we treat the failure to obtain the installation access token the
// same as the failure to notify GitHub (state is updated but not marked
// synced).
//
if (iat != nullptr)
{
// Prepare the check run's summary field (the build information in an
// XHTML table).
//
string sm; // Summary.
{
using namespace web::xhtml;
ostringstream os;
xml::serializer s (os, "check_run_summary");
// This hack is required to disable XML element name prefixes (which
// GitHub does not like). Note that this adds an xmlns declaration for
// the XHTML namespace which for now GitHub appears to ignore. If that
// ever becomes a problem, then we should redo this with raw XML
// serializer calls.
//
struct table: element
{
table (): element ("table") {}
void
start (xml::serializer& s) const override
{
s.start_element (xmlns, name);
s.namespace_decl (xmlns, "");
}
} TABLE;
// Serialize a result row (colored circle, result text, log URL) for
// an operation and result_status.
//
auto tr_result = [this, &b] (xml::serializer& s,
const string& op,
result_status rs)
{
// The log URL.
//
string lu (build_log_url (options_->host (),
options_->root (),
b,
op != "result" ? &op : nullptr));
s << TR
<< TD << EM << op << ~EM << ~TD
<< TD
<< circle (rs) << ' '
<< CODE << to_string (rs) << ~CODE
<< " (" << A << HREF << lu << ~HREF << "log" << ~A << ')'
<< ~TD
<< ~TR;
};
// Serialize the summary to an XHTML table.
//
s << TABLE
<< TBODY;
tr_result (s, "result", *b.status);
s << TR
<< TD << EM << "package" << ~EM << ~TD
<< TD << CODE << b.package_name << ~CODE << ~TD
<< ~TR
<< TR
<< TD << EM << "version" << ~EM << ~TD
<< TD << CODE << b.package_version << ~CODE << ~TD
<< ~TR
<< TR
<< TD << EM << "toolchain" << ~EM << ~TD
<< TD
<< CODE
<< b.toolchain_name << '-' << b.toolchain_version.string ()
<< ~CODE
<< ~TD
<< ~TR
<< TR
<< TD << EM << "target" << ~EM << ~TD
<< TD << CODE << b.target.string () << ~CODE << ~TD
<< ~TR
<< TR
<< TD << EM << "target config" << ~EM << ~TD
<< TD << CODE << b.target_config_name << ~CODE << ~TD
<< ~TR
<< TR
<< TD << EM << "package config" << ~EM << ~TD
<< TD << CODE << b.package_config_name << ~CODE << ~TD
<< ~TR;
for (const operation_result& r: b.results)
tr_result (s, r.operation, r.status);
s << ~TBODY
<< ~TABLE;
sm = os.str ();
}
gq_built_result br (
make_built_result (*b.status, sd.warning_success, move (sm)));
if (cr.node_id)
{
// Update existing check run to built.
//
if (gq_update_check_run (error,
cr,
iat->token,
sd.repository_node_id,
*cr.node_id,
details_url (b),
build_state::built,
move (br)))
{
assert (cr.state == build_state::built);
l3 ([&]{trace << "updated check_run { " << cr << " }";});
}
}
else
{
// Create new check run.
//
// Note that we don't have build hints so will be creating this check
// run with the full build id as name. In the unlikely event that an
// out of order build_queued() were to run before we've saved this
// check run to the service data it will create another check run with
// the shortened name which will never get to the built state.
//
if (gq_create_check_run (error,
cr,
iat->token,
sd.repository_node_id,
sd.report_sha,
details_url (b),
build_state::built,
move (br)))
{
assert (cr.state == build_state::built);
l3 ([&]{trace << "created check_run { " << cr << " }";});
}
}
if (cr.state_synced)
{
// Check run was created/updated successfully to built (with
// status we specified).
//
cr.status = b.status;
// Update the conclusion check run if all check runs are now built.
//
if (conclusion)
{
assert (sd.conclusion_node_id);
result_status rs (*conclusion);
gq_built_result br (
make_built_result (rs, sd.warning_success,
"All configurations are built"));
check_run cr;
// Set some fields for display purposes.
//
cr.node_id = *sd.conclusion_node_id;
cr.name = conclusion_check_run_name;
if (gq_update_check_run (error,
cr,
iat->token,
sd.repository_node_id,
*sd.conclusion_node_id,
nullopt /* details_url */,
build_state::built,
move (br)))
{
assert (cr.state == build_state::built);
l3 ([&]{trace << "updated conclusion check_run { " << cr << " }";});
}
else
{
// Nothing we can do here except log the error.
//
error << "tenant_service id " << ts.id
<< ": unable to update conclusion check run "
<< *sd.conclusion_node_id;
}
completed = true;
}
}
}
return [iat = move (new_iat),
cr = move (cr),
completed = completed,
error = move (error),
warn = move (warn)] (const tenant_service& ts) -> optional<string>
{
// NOTE: this lambda may be called repeatedly (e.g., due to transaction
// being aborted) and so should not move out of its captures.
service_data sd;
try
{
sd = service_data (*ts.data);
}
catch (const invalid_argument& e)
{
error << "failed to parse service data: " << e;
return nullopt;
}
if (iat)
sd.installation_access = *iat;
// Only update the check_run state in service data if it matches the
// state (specifically, status) on GitHub.
//
if (cr.state_synced)
{
if (check_run* scr = sd.find_check_run (cr.build_id))
{
// This will most commonly generate a duplicate warning (see above).
// We could save the old state and only warn if it differs but let's
// not complicate things for now.
//
#if 0
if (scr->state != build_state::building)
{
warn << "check run " << cr.build_id << ": out of order built "
<< "notification service data update; existing state: "
<< scr->state_string ();
}
#endif
*scr = cr; // Note: also updates node id if created.
}
else
sd.check_runs.push_back (cr);
if (bool c = completed)
{
// Note that this can be racy: while we calculated the completed
// value based on the snapshot of the service data, it could have
// been changed (e.g., by handle_check_run_rerequest()). So we
// re-calculate it based on the check run states and only update if
// it matches. Otherwise, we log an error.
//
for (const check_run& scr: sd.check_runs)
{
if (scr.state != build_state::built)
{
string sid (sd.repository_node_id + ':' + sd.report_sha);
error << "tenant_service id " << sid
<< ": out of order built notification service data update; "
<< "check suite is no longer complete";
c = false;
break;
}
}
if (c)
sd.completed = true;
}
}
return sd.json ();
};
}
string ci_github::
details_url (const build& b) const
{
// This code is based on build_force_url() in mod/build.cxx.
//
return options_->host () +
"/@" + b.tenant +
"?builds=" + mime_url_encode (b.package_name.string ()) +
"&pv=" + b.package_version.string () +
"&tg=" + mime_url_encode (b.target.string ()) +
"&tc=" + mime_url_encode (b.target_config_name) +
"&pc=" + mime_url_encode (b.package_config_name) +
"&th=" + mime_url_encode (b.toolchain_name) + '-' +
b.toolchain_version.string ();
}
static optional<build_id>
parse_details_url (const string& details_url)
try
{
// See details_url() above for an idea of what the URL looks like.
url u (details_url);
build_id r;
// Extract the tenant from the URL path.
//
// Example path: @d2586f57-21dc-40b7-beb2-6517ad7917dd
//
if (!u.path || u.path->size () != 37 || (*u.path)[0] != '@')
return nullopt;
r.package.tenant = u.path->substr (1);
// Extract the rest of the build_id members from the URL query.
//
if (!u.query)
return nullopt;
bool pn (false), pv (false), tg (false), tc (false), pc (false),
th (false);
// This URL query parsing code is based on
// web::apache::request::parse_url_parameters().
//
for (const char* qp (u.query->c_str ()); qp != nullptr; )
{
const char* vp (strchr (qp, '='));
const char* ep (strchr (qp, '&'));
if (vp == nullptr || (ep != nullptr && ep < vp))
return nullopt; // Missing value.
string n (mime_url_decode (qp, vp)); // Name.
++vp; // Skip '='
const char* ve (ep != nullptr ? ep : vp + strlen (vp)); // Value end.
// Get the value as-is or URL-decode it.
//
auto rawval = [vp, ve] () { return string (vp, ve); };
auto decval = [vp, ve] () { return mime_url_decode (vp, ve); };
auto make_version = [] (string&& v)
{
return canonical_version (brep::version (move (v)));
};
auto c = [&n] (bool& b, const char* s)
{
return n == s ? (b = true) : false;
};
if (c (pn, "builds")) r.package.name = package_name (decval ());
else if (c (pv, "pv")) r.package.version = make_version (rawval ());
else if (c (tg, "tg")) r.target = target_triplet (decval ());
else if (c (tc, "tc")) r.target_config_name = decval ();
else if (c (pc, "pc")) r.package_config_name = decval ();
else if (c (th, "th"))
{
// Toolchain name and version. E.g. "public-0.17.0"
string v (rawval ());
// Note: parsing code based on mod/mod-builds.cxx.
//
size_t p (v.find_first_of ('-'));
if (p >= v.size () - 1)
return nullopt; // Invalid format.
r.toolchain_name = v.substr (0, p);
r.toolchain_version = make_version (v.substr (p + 1));
}
qp = ep != nullptr ? ep + 1 : nullptr;
}
if (!pn || !pv || !tg || !tc || !pc || !th)
return nullopt; // Fail if any query parameters are absent.
return r;
}
catch (const invalid_argument&) // Invalid url, brep::version, etc.
{
return nullopt;
}
optional<string> ci_github::
generate_jwt (const basic_mark& trace,
const basic_mark& error) const
{
string jwt;
try
{
// Set token's "issued at" time 60 seconds in the past to combat clock
// drift (as recommended by GitHub).
//
jwt = brep::generate_jwt (
*options_,
options_->ci_github_app_private_key (),
to_string (options_->ci_github_app_id ()),
chrono::seconds (options_->ci_github_jwt_validity_period ()),
chrono::seconds (60));
l3 ([&]{trace << "JWT: " << jwt;});
}
catch (const system_error& e)
{
error << "unable to generate JWT (errno=" << e.code () << "): " << e;
return nullopt;
}
return jwt;
}
// There are three types of GitHub API authentication:
//
// 1) Authenticating as an app. Used to access parts of the API concerning
// the app itself such as getting the list of installations. (Need to
// authenticate as an app as part of authenticating as an app
// installation.)
//
// 2) Authenticating as an app installation (on a user or organisation
// account). Used to access resources belonging to the user/repository
// or organisation the app is installed in.
//
// 3) Authenticating as a user. Used to perform actions as the user.
//
// We need to authenticate as an app installation (2).
//
// How to authenticate as an app installation
//
// Reference:
// https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation
//
// The final authentication token we need is an installation access token
// (IAT), valid for one hour, which we will pass in the `Authentication`
// header of our Github API requests:
//
// Authorization: Bearer <INSTALLATION_ACCESS_TOKEN>
//
// To generate an IAT:
//
// - Generate a JSON Web Token (JWT)
//
// - Get the installation ID. This will be included in the webhook request
// in our case
//
// - Send a POST to /app/installations/<INSTALLATION_ID>/access_tokens which
// includes the JWT (`Authorization: Bearer <JWT>`). The response will
// include the IAT. Can pass the name of the repository included in the
// webhook request to restrict access, otherwise we get access to all
// repos covered by the installation if installed on an organisation for
// example.
//
optional<gh_installation_access_token> ci_github::
obtain_installation_access_token (uint64_t iid,
string jwt,
const basic_mark& error) const
{
gh_installation_access_token iat;
try
{
// API endpoint.
//
string ep ("app/installations/" + to_string (iid) + "/access_tokens");
uint16_t sc (
github_post (iat, ep, strings {"Authorization: Bearer " + jwt}));
// Possible response status codes from the access_tokens endpoint:
//
// 201 Created
// 401 Requires authentication
// 403 Forbidden
// 404 Resource not found
// 422 Validation failed, or the endpoint has been spammed.
//
// Note that the payloads of non-201 status codes are undocumented.
//
if (sc != 201)
{
error << "unable to get installation access token: error HTTP "
<< "response status " << sc;
return nullopt;
}
// Create a clock drift safety window.
//
iat.expires_at -= chrono::minutes (5);
}
catch (const json::invalid_json_input& e)
{
// Note: e.name is the GitHub API endpoint.
//
error << "malformed JSON in response from " << e.name << ", line: "
<< e.line << ", column: " << e.column << ", byte offset: "
<< e.position << ", error: " << e;
return nullopt;
}
catch (const invalid_argument& e)
{
error << "malformed header(s) in response: " << e;
return nullopt;
}
catch (const system_error& e)
{
error << "unable to get installation access token (errno=" << e.code ()
<< "): " << e.what ();
return nullopt;
}
return iat;
}
}
|