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
|
{-# LANGUAGE AllowAmbiguousTypes #-}
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DeriveAnyClass #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE ExtendedDefaultRules #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE QuasiQuotes #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE Strict #-}
{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE TupleSections #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE TypeOperators #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
-- Dragons.dev website and service
--
-- : out dragons
-- : sys cmark
module Biz.Dragons
( main,
test,
)
where
import Alpha hiding (rem, (<.>))
import qualified Biz.App as App
import qualified Biz.Auth as Auth
import qualified Biz.Cli as Cli
import Biz.Dragons.Analysis (Analysis (..), Commit (..))
import qualified Biz.Dragons.Analysis as Analysis
import qualified Biz.Id as Id
import qualified Biz.Log as Log
import qualified Biz.Look
import Biz.Test ((@=?), (@?!=), (@?=))
import qualified Biz.Test as Test
import qualified CMark as Cmark
import qualified CMark.Lucid as Cmark
import Clay (em, pct, px, rem, sec, (?))
import qualified Clay
import qualified Clay.Font
import qualified Clay.Render as Clay
import qualified Control.Concurrent.Async as Async
import qualified Control.Exception as Exception
import Data.Acid (makeAcidic)
import qualified Data.Acid as Acid
import qualified Data.Acid.Advanced as Acid
import qualified Data.Acid.Local as Acid
import qualified Data.Aeson as Aeson
import qualified Data.ByteString.Lazy as LBS
import Data.Data (Data)
import Data.IxSet (Indexable (..), IxSet, ixFun, ixSet, (&&&), (@=))
import qualified Data.IxSet as IxSet
import qualified Data.List as List
import qualified Data.Map as Map
import Data.SafeCopy (base, deriveSafeCopy, extension)
import qualified Data.SafeCopy as SafeCopy
import qualified Data.Set as Set
import qualified Data.Text as Text
import qualified Data.Text.Encoding as Encoding
import qualified Data.Time.Calendar as Time
import qualified Data.Time.Clock as Time
import Data.Vector (Vector)
import qualified Data.Vector as Vector
import qualified GitHub
import qualified Lucid
import qualified Lucid.Base as Lucid
import qualified Lucid.Servant as Lucid
import NeatInterpolation
import qualified Network.Wai as Wai
import qualified Network.Wai.Handler.Warp as Warp
import Servant
import Servant.API.Generic (ToServantApi, genericApi, toServant, (:-))
import qualified Servant.Auth as Auth
import qualified Servant.Auth.Server as Auth
import qualified Servant.HTML.Lucid as Lucid
import Servant.Server.Generic (AsServer)
import qualified System.Directory as Directory
import qualified System.Envy as Envy
import System.FilePath ((<.>), (</>))
import qualified System.Process as Process
import qualified Web.FormUrlEncoded as Web
-- * persistent data
-- This must go first because of template haskell splicing.
--
-- When changing a persisted type `T`, first copy the type `T == T0`, then make
-- the `SafeCopy.Migrate T` class compile, then make changes to `T`. If you
-- don't, there will be a runtime exception when you try to start the new
-- service. I'm not sure how to guard against this, except maybe run a test
-- deployment by copying a database backup locally, or something:
--
-- rm -rf _/var/dragons
-- rsync -avz /var/dragons _/var
newtype UserEmail = UserEmail {unUserEmail :: Maybe Text}
deriving (Eq, Ord, Data, Typeable, Generic, Show)
instance Aeson.ToJSON UserEmail
instance Aeson.FromJSON UserEmail
instance Auth.ToJWT UserEmail
instance Auth.FromJWT UserEmail
instance Lucid.ToHtml UserEmail where
toHtmlRaw = Lucid.toHtml
toHtml (UserEmail (Just email)) = Lucid.toHtml email
toHtml (UserEmail Nothing) = mempty
$(deriveSafeCopy 0 'base ''UserEmail)
-- | In 'GitHub.Data.Definitions' this is '(Id User)', but I don't want the
-- extra complexity of 'Id', so just store the underlying Int
newtype GitHubId = GitHubId {unGitHubId :: Int}
deriving (Eq, Ord, Data, Typeable, Generic, Show)
instance Aeson.ToJSON GitHubId
instance Aeson.FromJSON GitHubId
instance Auth.ToJWT GitHubId
instance Auth.FromJWT GitHubId
$(deriveSafeCopy 0 'base ''GitHubId)
newtype GitHubHandle = GitHubHandle {unGitHubHandle :: Text}
deriving (Eq, Ord, Data, Typeable, Generic, Show)
instance Aeson.ToJSON GitHubHandle
instance Aeson.FromJSON GitHubHandle
$(deriveSafeCopy 0 'base ''GitHubHandle)
data Subscription = Free | Invoice
deriving (Eq, Data, Typeable, Ord, Generic, Show)
instance Web.FromForm Subscription where
fromForm f = case Web.parseUnique "user-subscription" f of
Right "Free" -> Right Free
Right "Invoice" -> Right Invoice
Right x -> Left <| "could not parse form value: " <> x
Left x -> Left <| "could not parse form value: " <> x
instance Aeson.ToJSON Subscription
instance Aeson.FromJSON Subscription
instance Auth.ToJWT Subscription
instance Auth.FromJWT Subscription
$(deriveSafeCopy 0 'base ''Subscription)
newtype Password = NotHashed ByteString -- not secure, yet
deriving (Data, Ord, Eq, Typeable, Generic, Show)
instance Aeson.ToJSON Password where
toJSON (NotHashed bs) = Aeson.toJSON (str bs :: Text)
-- toJSON (NotHashed bs) = str bs
instance Aeson.FromJSON Password where
parseJSON = Aeson.withText "String" (str .> NotHashed .> pure)
instance Lucid.ToHtml Password where
toHtmlRaw = Lucid.toHtml
toHtml (NotHashed txt) = Lucid.toHtml txt
$(deriveSafeCopy 0 'base ''Password)
data APIKey = APIKey
{ -- | JWT token created with 'Servant.Auth.Server.makeJWT'
token :: Password,
created :: Time.UTCTime
}
deriving (Data, Ord, Eq, Typeable, Generic, Show)
instance Aeson.ToJSON APIKey
instance Aeson.FromJSON APIKey
$(deriveSafeCopy 0 'base ''APIKey)
data User0 = User0
{ userEmail :: UserEmail,
userGitHubId :: GitHubId,
userGitHubHandle :: GitHubHandle,
-- | So we can make GitHub API calls on their behalf.
userGitHubToken :: Text,
userSubscription :: Subscription,
userId :: Id.Id User0
}
deriving (Eq, Data, Typeable, Ord, Generic, Show)
$(deriveSafeCopy 0 'base ''Id.Id)
$(deriveSafeCopy 0 'base ''User0)
-- | The main representation of a user.
data User = User
{ userEmail :: UserEmail,
userGitHubId :: GitHubId,
userGitHubHandle :: GitHubHandle,
-- | So we can make GitHub API calls on their behalf.
userGitHubToken :: Text,
userSubscription :: Subscription,
userId :: Id.Id User,
userKeys :: [APIKey]
}
deriving (Data, Ord, Eq, Typeable, Generic, Show)
instance Aeson.ToJSON User
instance Aeson.FromJSON User
instance Auth.ToJWT User
instance Auth.FromJWT User
instance SafeCopy.Migrate User where
type MigrateFrom User = User0
migrate User0 {..} =
User
{ userId = Id.mk (Proxy :: Proxy User) <| Id.untag userId,
userKeys = mempty,
..
}
$(deriveSafeCopy 1 'extension ''User)
instance Indexable User where
empty =
ixSet
[ ixFun <| \User {..} -> [userEmail],
ixFun <| \User {..} -> [userGitHubId],
ixFun <| \User {..} -> [userSubscription]
]
instance Lucid.ToHtml Commit where
toHtmlRaw = Lucid.toHtml
toHtml (Sha txt) = Lucid.toHtml txt
$(deriveSafeCopy 0 'base ''Commit)
data Source
= -- | We got this from a code forge like GitHub or GitLab
ForgeURL Text
| -- | We got this from a dragons-cli upload
CLISubmission
deriving (Eq, Data, Typeable, Ord, Generic, Show)
instance Envy.Var Source where
toVar (ForgeURL txt) = str txt
toVar CLISubmission = "dragons-cli upload"
-- NOTE: this assumes forge URL!
fromVar = Just <. ForgeURL <. str
instance Lucid.ToHtml Source where
toHtmlRaw = Lucid.toHtml
toHtml (ForgeURL txt) = Lucid.toHtml txt
toHtml CLISubmission = Lucid.toHtml ("dragons-cli upload" :: Text)
$(deriveSafeCopy 0 'base ''Source)
data Visibility = Public | Private
deriving (Eq, Ord, Generic, Show, Data, Typeable)
$(deriveSafeCopy 0 'base ''Visibility)
instance Indexable Analysis where
empty =
ixSet
[ ixFun <| \Analysis {..} -> [commit]
]
instance App.HasCss AnalysisAction where
cssFor _ = do
"#analysis > *" ? do
Biz.Look.marginAll (rem 2)
".score" ? do
Clay.display Clay.grid
Biz.Look.gridTemplateAreas
[ "title quantity details-collapsed",
"preview-chart preview-chart preview-chart",
"details details details"
]
Clay.alignItems Clay.baseline
Clay.gridTemplateColumns [pct 30, 40, 30]
Biz.Look.gridTemplateRows ["auto"]
".title" ? do
Biz.Look.gridArea "title"
Clay.fontSize (rem 1.4)
Clay.lineHeight (rem 2.4)
".percentage" ? do
Biz.Look.gridArea "quantity"
Clay.display Clay.flex
Clay.alignItems Clay.baseline
".centum" ? do
Clay.fontSize (rem 1.2)
Clay.lineHeight (rem 1.2)
".quantity" ? do
Biz.Look.gridArea "quantity"
Clay.fontSize (rem 3)
Clay.lineHeight (rem 3)
".preview-chart" ? do
Biz.Look.gridArea "preview-chart"
"details" ? do
Biz.Look.gridArea "details-collapsed"
Biz.Look.justifySelf <| Clay.JustifyContentValue "self-end"
"details[open]" ? do
Biz.Look.gridArea "details"
Biz.Look.justifySelf <| Clay.JustifyContentValue "auto"
".preview-chart" ? do
Clay.height (px 2)
Clay.maxWidth (pct 100)
"table" ? do
Biz.Look.marginAll (px 0)
Clay.maxWidth (pct 100)
"#hotspots" ? do
".preview-chart" ? do
Clay.height (rem 1)
"table" ? do
Clay.height (rem 4)
Clay.marginTop (rem (-3))
Clay.zIndex (-1)
".bar" ? do
Clay.height (px 800)
instance Lucid.ToHtml AnalysisAction where
toHtmlRaw = Lucid.toHtml
toHtml AnalysisAction {..} =
Lucid.div_ [Lucid.id_ "analysis"] <| do
let Analysis {..} = analysis
Lucid.p_ [Lucid.class_ "analysisFor"] <| do
"Analysis for " <> Lucid.toHtml source
score_ <| do
title_ "Total Score"
percentage_ <| do
quantity_ <| Lucid.toHtml <| tshow score
centum_ "/100"
previewChart <| simpleBar score 100
Lucid.details_ <| do
Lucid.summary_ "Details"
desc
[text|
Your score is a weighted composite of the below metrics.
What your score means:
- 0-30: very high risk, most of your codebase is unknown or ephemeral
- 30-60: medium-high risk, tasks that involve working on this
codebase will take longer than they should, and we should expect
a few unforeseen bugs
- 60-80: medium-low risk, tasks in this codebase can be expected to
complete in the estimated time, and it probably doesn't have many bugs
- 80+: low risk, your codebase is super clean, give your devs a raise
|]
score_ <| do
title_ "Total Files"
quantity_ <| Lucid.toHtml <| tshow totalFiles
score_ <| do
title_ "Active authors"
quantity_ <| Lucid.toHtml <| slen activeAuthors
Lucid.details_ <| do
Lucid.summary_ "Details"
Lucid.ul_ <| forM_ activeAuthors <| \author -> do
Lucid.li_ <| Lucid.toHtml author
score_ <| do
title_ "Blackholes"
quantity_ <| Lucid.toHtml <| slen blackholes
previewChart <| simpleBar (len blackholes) totalFiles
Lucid.details_ <| do
Lucid.summary_ "Details"
desc
[text|
A blackhole has zero active contributors, so none of your current team
members have touched this code. These are very high risk. If there is
a problem with this area of the codebase, it will take longer for your
team to diagnose and fix the root cause; new features that interact
with a blackhole will take longer to deploy.
**What you can do:** Start a project to ensure these blackholes are
well-defined and documented. If anything is completely unknown, write
tests against that part of the code as it currently stands, then decide
if a rewrite is necessary.
|]
Lucid.ul_ <| do
traverse_ (Lucid.toHtml .> Lucid.li_) blackholes
score_ <| do
title_ "Liabilities"
quantity_ <| Lucid.toHtml <| slen liabilities
previewChart <| simpleBar (len liabilities) totalFiles
Lucid.details_ <| do
Lucid.summary_ "Details"
desc
[text|
Files with < 3 active contributors. These are at risk of becoming
blackholes if contributors change teams or leave the company.
**What you can do:** Next time a task involves one of these files,
pull in some team members that haven't worked on this area of the
codebase.
In general, when assigning tasks, ensure developers are occasionally
working on areas of the codebase that are new to them. Not only will
this decrease your liability, it will also improve your developers
by helping them learn new areas of the code and share techniques.
|]
Lucid.ul_ <| do
traverse_ (Lucid.toHtml .> Lucid.li_) liabilities
score_ <| do
title_ "Stale files"
quantity_ <| Lucid.toHtml <| tshow <| Map.size stale
previewChart <| simpleBar (Map.size stale) totalFiles
Lucid.details_ <| do
Lucid.summary_ "Details"
desc
[text|
Files that haven't been touched in 6 months. These aren't necessarily
a risk: unchanging files could just be really well-defined and stable.
On the other hand, they could also be places that nobody wants to go
because nobody knows how they work.
**What you can do:** Run this list by your team and find out who has
knowledge of this area. If nobody does, start a project to
investigate and re-define this part of the codebase, ensuring good
documentation practices along the way.
|]
Lucid.ul_ <| do
-- probably Map.mapWithKey is better?
forM_ (Map.toList stale) <| \(path, days) ->
Lucid.li_ <| Lucid.toHtml <| path <> " (" <> show days <> " days)"
Lucid.with score_ [Lucid.id_ "hotspots"] <| do
title_ "Hotspots"
quantity_ "" -- TODO: count files in 2nd sigma as identified "hotspots"
previewChart <| do
Lucid.table_ [Lucid.class_ "charts-css column"] <| do
Lucid.tr_ <| do
forM_ (Map.toList hotspotMap) <| \(_, n) -> do
Lucid.td_ [Lucid.style_ <| size n totalCommits] ""
Lucid.details_ <| do
Lucid.summary_ "Details"
desc
[text|
A hotspot is an over-active code module: developers are continually
reworking this part of the code, wasting time redoing work instead
of progressing.
The flamegraph below plots files by how often they are changed, a
longer horizontal line means more changes. Hover over the bars to
see filenames and change count.
**What you can do:** After identifying the hotspots, discuss with your
team how to improve the code. Why does the code change so often? Does
it need a more well-defined spec? Does it need a deep refactor? Maybe
part of it can be abstracted into a more solid module?
|]
Lucid.table_ [Lucid.class_ "charts-css bar"] <| do
Lucid.tr_ <| do
forM_ (Map.toList hotspotMap) <| \(path, n) -> do
Lucid.td_ [Lucid.style_ <| size n totalCommits] <| do
Lucid.span_ [Lucid.class_ "tooltip"]
<| Lucid.toHtml
<| path <> ": " <> show n <> " commits"
where
simpleBar :: (Show i, Monad m, Num i) => i -> Integer -> Lucid.HtmlT m ()
simpleBar n total = do
Lucid.table_ [Lucid.class_ "charts-css bar stacked multiple"] <| do
Lucid.tr_ <| do
Lucid.td_ [Lucid.style_ <| size n total] ""
<> Lucid.td_ [Lucid.style_ <| size total total] ""
len = toInteger <. length
slen = tshow <. length
div_ c = Lucid.with Lucid.div_ [Lucid.class_ c]
score_ = div_ "score"
title_ = div_ "title"
quantity_ = div_ "quantity"
centum_ = div_ "centum"
percentage_ = div_ "percentage"
size n total = "--size: calc(" <> show n <> "/" <> show total <> ")"
previewChart = div_ "preview-chart"
desc :: Monad m => Text -> Lucid.HtmlT m ()
desc = Lucid.p_ <. Cmark.renderNode [] <. Cmark.commonmarkToNode []
-- | Captures an 'Analysis' with metadata used in the webapp to track who asked
-- it and so on.
data AnalysisAction = AnalysisAction
{ -- | Monotonic incrementing integer id
analysisId :: Id.Id AnalysisAction,
-- | Who asked for this analysis
askedBy :: Id.Id User,
-- | Where is this coming from?
source :: Source,
-- | Is the URL publically visible?
repoVisibility :: Visibility,
-- | The actual analaysis
analysis :: Analysis
}
deriving (Eq, Ord, Generic, Show, Data, Typeable)
$(deriveSafeCopy 0 'base ''Analysis)
$(deriveSafeCopy 0 'base ''AnalysisAction)
instance Indexable AnalysisAction where
empty =
ixSet
[ ixFun <| \AnalysisAction {..} -> [analysisId],
ixFun <| \AnalysisAction {..} -> [askedBy],
ixFun <| \AnalysisAction {..} -> [source],
ixFun <| \AnalysisAction {..} -> [repoVisibility],
ixFun <| \AnalysisAction {..} -> [commit analysis]
]
-- | The database.
data Keep = Keep
{ users :: IxSet User,
nextUserId :: Id.Id User,
analyses :: IxSet AnalysisAction,
nextAnalysisId :: Id.Id AnalysisAction
}
deriving (Data, Typeable)
$(deriveSafeCopy 0 'base ''Keep)
createUser :: User -> Acid.Update Keep User
createUser User {..} = do
keep <- get
let newUser = User {userId = nextUserId keep, ..}
put
<| keep
{ users = IxSet.insert newUser (users keep),
nextUserId = succ <| nextUserId keep
}
pure newUser
updateUser :: User -> Acid.Update Keep User
updateUser u@User {..} = do
keep <- get
put <| keep {users = IxSet.updateIx userGitHubId u (users keep)}
pure u
createUserAPIKey :: APIKey -> User -> Acid.Update Keep User
createUserAPIKey key u@User {..} = do
keep <- get
let newUser = u {userKeys = key : userKeys}
put <| keep {users = IxSet.updateIx userGitHubId newUser <| users keep}
pure newUser
getUserByEmail :: UserEmail -> Acid.Query Keep (Maybe User)
getUserByEmail email = do
Keep {..} <- ask
pure <| IxSet.getOne <| users @= email
getUserByGitHubId :: GitHubId -> Acid.Query Keep (Maybe User)
getUserByGitHubId id = do
Keep {..} <- ask
pure <| IxSet.getOne <| users @= id
getUsers :: Acid.Query Keep [User]
getUsers = do
Keep {..} <- ask
pure <| IxSet.toList users
createAnalysis :: AnalysisAction -> Acid.Update Keep AnalysisAction
createAnalysis a = do
keep@Keep {..} <- get
let newAnalysis = a {analysisId = nextAnalysisId} :: AnalysisAction
put
<| keep
{ analyses = IxSet.insert newAnalysis analyses,
nextAnalysisId = succ nextAnalysisId
}
pure newAnalysis
getAnalysisById :: Id.Id AnalysisAction -> Acid.Query Keep (Maybe AnalysisAction)
getAnalysisById id = do
Keep {..} <- ask
pure <| IxSet.getOne <| analyses @= id
getAllAnalyses :: Acid.Query Keep [AnalysisAction]
getAllAnalyses = do
Keep {..} <- ask
pure <| IxSet.toList analyses
getAnalysesByAsker :: User -> Acid.Query Keep [AnalysisAction]
getAnalysesByAsker User {..} = do
Keep {..} <- ask
pure <| IxSet.toList <| analyses @= userId
getAnalysesBySource :: Source -> Acid.Query Keep [AnalysisAction]
getAnalysesBySource src = do
Keep {..} <- ask
pure <| IxSet.toList <| analyses @= src
getAnalysisBySourceAndCommit :: Source -> Commit -> Acid.Query Keep (Maybe AnalysisAction)
getAnalysisBySourceAndCommit src sha = do
Keep {..} <- ask
pure <| IxSet.getOne <| analyses @= src &&& analyses @= sha
$( makeAcidic
''Keep
[ 'createUser,
'updateUser,
'getUsers,
'getUserByEmail,
'getUserByGitHubId,
'createAnalysis,
'getAnalysisById,
'getAllAnalyses,
'getAnalysesByAsker,
'getAnalysesBySource,
'getAnalysisBySourceAndCommit,
'createUserAPIKey
]
)
upsertGitHubUser ::
Acid.AcidState Keep ->
ByteString ->
GitHub.User ->
IO (Either Text User)
upsertGitHubUser keep tok ghUser =
ghUser
|> GitHub.userId
|> GitHub.untagId
|> GitHubId
|> GetUserByGitHubId
|> Acid.query keep
+> \case
Just User {..} ->
-- if we already know this user, we need to refresh the token
User {userGitHubToken = Encoding.decodeUtf8 tok, ..}
|> UpdateUser
|> Acid.update keep
Nothing ->
CreateUser
User
{ userEmail = UserEmail <| GitHub.userEmail ghUser,
userGitHubId = GitHubId <. GitHub.untagId <| GitHub.userId ghUser,
userGitHubHandle =
GitHubHandle <| GitHub.untagName <| GitHub.userLogin ghUser,
userGitHubToken = Encoding.decodeUtf8 tok,
userSubscription = Free,
userId = mempty,
userKeys = mempty
}
|> Acid.update keep
/> Right
test_upsertGitHubUser :: IO (Config, Application, Acid.AcidState Keep) -> Test.Tree
test_upsertGitHubUser load =
Test.group
"upsertUser"
[ Test.unit "userId is not mempty" <| do
(_, _, k) <- load
Right User {..} <- upsertGitHubUser k "token" mock_ghUser
userId @?!= mempty,
Test.unit "creates user when email is empty" <| do
(_, _, k) <- load
Right User {..} <- upsertGitHubUser k "token" mock_ghUser {GitHub.userEmail = Nothing}
userEmail @?!= UserEmail Nothing
]
mock_ghUser :: GitHub.User
mock_ghUser =
GitHub.User
{ GitHub.userId = GitHub.mkId (Proxy :: Proxy GitHub.User) 123,
GitHub.userEmail = Just "user@example.com",
GitHub.userLogin = "user",
GitHub.userName = Nothing,
GitHub.userType = GitHub.OwnerUser,
GitHub.userCreatedAt =
Time.UTCTime (Time.ModifiedJulianDay 1) (Time.secondsToDiffTime 100),
GitHub.userPublicGists = 123,
GitHub.userAvatarUrl = GitHub.URL "http://example.com",
GitHub.userFollowers = 0,
GitHub.userFollowing = 0,
GitHub.userHireable = Nothing,
GitHub.userBlog = Nothing,
GitHub.userBio = Nothing,
GitHub.userPublicRepos = 0,
GitHub.userLocation = Nothing,
GitHub.userCompany = Nothing,
GitHub.userUrl = GitHub.URL "http://example.com",
GitHub.userHtmlUrl = GitHub.URL "http://example.com"
}
init :: Keep
init =
Keep
{ nextAnalysisId = Id.mk (Proxy :: Proxy AnalysisAction) 1,
nextUserId = Id.mk (Proxy :: Proxy User) 1,
users = IxSet.empty,
analyses = IxSet.empty
}
-- * main and test
main :: IO ()
main = Cli.main <| Cli.Plan help move test tidy
help :: Cli.Docopt
help =
[Cli.docopt|
dragons
Usage:
dragons [--quiet]
dragons test
|]
move :: Cli.Arguments -> IO ()
move args =
Exception.bracket
(startup <| args `Cli.has` Cli.longOption "quiet")
shutdown
run
startup :: Bool -> IO (Config, Application, Acid.AcidState Keep)
startup quiet = do
cfg <- Envy.decodeWithDefaults Envy.defConfig
oAuthArgs <- Envy.decodeWithDefaults Envy.defConfig
kp <- Acid.openLocalStateFrom (keep cfg) init :: IO (Acid.AcidState Keep)
jwk <- Auth.generateKey -- TODO: store this in a file somewhere
let ForgeURL url = homeExample cfg
unless quiet <| do
Log.info ["boot", "dragons"] >> Log.br
Log.info ["boot", "area", show <| area cfg] >> Log.br
Log.info ["boot", "port", show <| port cfg] >> Log.br
Log.info ["boot", "depo", Text.pack <| depo cfg] >> Log.br
Log.info ["boot", "keep", Text.pack <| keep cfg] >> Log.br
Log.info ["boot", "home", "example", url] >> Log.br
let jwtCfg = Auth.defaultJWTSettings jwk
let cooks = case area cfg of
Test -> testCookieSettings
Live -> liveCookieSettings
let ctx = cooks :. jwtCfg :. EmptyContext
let app = serveWithContext paths ctx (toServant <| htmlApp jwtCfg cooks kp cfg oAuthArgs)
unless quiet <| do Log.info ["boot", "ready"] >> Log.br
pure (cfg, app, kp)
shutdown :: (Config, Application, Acid.AcidState Keep) -> IO ()
shutdown (_, _, kp) = Acid.createCheckpointAndClose kp
tidy :: Config -> IO ()
tidy Config {..} = Directory.removeDirectoryRecursive keep
run :: (Config, Wai.Application, Acid.AcidState Keep) -> IO ()
run (cfg, app, _) = Warp.run (port cfg) (Log.wai app)
liveCookieSettings :: Auth.CookieSettings
liveCookieSettings =
Auth.defaultCookieSettings
{ Auth.cookieIsSecure = Auth.Secure,
-- disable XSRF protection because we don't use any javascript
Auth.cookieXsrfSetting = Nothing
}
testCookieSettings :: Auth.CookieSettings
testCookieSettings =
Auth.defaultCookieSettings
{ Auth.cookieIsSecure = Auth.NotSecure,
Auth.cookieXsrfSetting = Nothing
}
test :: Test.Tree
test =
Test.group
"Biz.Dragons"
[ test_spliceCreds,
Test.with
(startup True)
(\t@(c, _, _) -> shutdown t >> tidy c)
test_upsertGitHubUser,
Test.with
(startup True)
(\t@(c, _, _) -> shutdown t >> tidy c)
test_analyzeGitHub
]
-- * app configurations
data Area = Test | Live
deriving (Generic, Show)
instance Envy.Var Area where
toVar = show
fromVar "Test" = Just Test
fromVar "Live" = Just Live
fromVar _ = Just Test
data Config = Config
{ port :: Warp.Port,
-- | The repo depo! Depository of repositories!
depo :: FilePath,
keep :: FilePath,
area :: Area,
-- | A user token for the GitHub API to be used in testing and when getting
-- the homepage/example analyses. Get a token with 'repo' scope from GitHub
-- and set in .envrc.local
-- https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
tokn :: Text,
-- | The example shown on the homepage
homeExample :: Source
}
deriving (Generic, Show)
instance Envy.DefConfig Config where
defConfig =
Config
{ port = 8005,
depo = "_/var/dragons/depo",
keep = "_/var/dragons/keep",
area = Test,
tokn = mempty,
homeExample = ForgeURL "https://github.com/github/training-kit"
}
instance Envy.FromEnv Config
-- * paths and pages
-- | Wraps pages in default HTML
instance (Lucid.ToHtml a, App.HasCss a) => Lucid.ToHtml (App.Html a) where
toHtmlRaw = Lucid.toHtml
toHtml (App.Html x) =
Lucid.doctypehtml_ <| do
Lucid.head_ <| do
Lucid.title_ "Dragons.dev :: Know your codebase, know your team."
Lucid.meta_
[ Lucid.name_ "description",
Lucid.content_ "Know your codebase, know your team."
]
Lucid.meta_
[ Lucid.name_ "viewport",
Lucid.content_ "width=device-width, initial-scale=1"
]
Lucid.meta_ [Lucid.charset_ "utf-8"]
jsRef "//unpkg.com/turbolinks@5.2.0/dist/turbolinks.js"
-- base styles
style baseStyle
cssRef "//unpkg.com/charts.css/dist/charts.min.css"
-- page styles
style <| App.cssFor x
Lucid.body_ (Lucid.toHtml x)
where
style = Lucid.style_ <. toStrict <. Clay.renderWith Clay.compact []
jsRef _href =
Lucid.with
(Lucid.script_ mempty)
[ Lucid.makeAttribute "src" _href,
Lucid.makeAttribute "async" mempty,
Lucid.makeAttribute "defer" mempty
]
cssRef _href =
Lucid.with
(Lucid.link_ mempty)
[ Lucid.makeAttribute "rel" "stylesheet",
Lucid.makeAttribute "href" _href
]
-- | All of the routes in the app.
data Paths path = Paths
{ home ::
path
:- Get '[Lucid.HTML] (App.Html Home),
login ::
path
:- "login"
:> Verb 'GET 301 '[Lucid.HTML] (Headers '[Header "Location" Text] NoContent),
githubAuth ::
path
:- "auth"
:> "github"
:> "callback"
:> QueryParam "code" Text
:> Get '[Lucid.HTML] (Auth.SetCookies (App.Html UserAccount)),
getAccount ::
path
:- Auth.Auth '[Auth.Cookie] User
:> "account"
:> Get '[Lucid.HTML] (App.Html UserAccount),
postAccount ::
path
:- Auth.Auth '[Auth.Cookie] User
:> "account"
:> ReqBody '[FormUrlEncoded] Subscription
:> Post '[Lucid.HTML] (App.Html UserAccount),
postAPIKey ::
path
:- Auth.Auth '[Auth.Cookie] User
:> "account"
:> "api-key"
:> Post '[Lucid.HTML] (App.Html UserAccount),
selectRepo ::
path
:- Auth.Auth '[Auth.Cookie] User
:> "select-repo"
:> Get '[Lucid.HTML] (App.Html SelectRepo),
getAnalyses ::
path
:- Auth.Auth '[Auth.Cookie] User
:> "analysis"
:> Get '[Lucid.HTML] (App.Html Analyses),
getAnalysis ::
path
:- Auth.Auth '[Auth.Cookie] User
:> "analysis"
:> Capture "analysisId" (Id.Id AnalysisAction)
:> Get '[Lucid.HTML] (App.Html AnalysisDisplay),
postAnalysis ::
path
:- Auth.Auth '[Auth.Cookie] User
:> "analysis"
:> ReqBody '[FormUrlEncoded] SubmitAnalysis
:> Post '[Lucid.HTML] (App.Html AnalysisDisplay),
putAnalysis ::
path
:- Auth.Auth '[Auth.JWT] User
:> "analysis"
:> ReqBody '[JSON] Analysis
:> Put '[JSON] NoContent,
admin ::
path
:- Auth.Auth '[Auth.Cookie] User
:> "admin"
:> Get '[Lucid.HTML] (App.Html AdminDashboard)
}
deriving (Generic)
paths :: Proxy (ToServantApi Paths)
paths = genericApi (Proxy :: Proxy Paths)
-- | Ensures a user is authenticated, then returns the logged-in user for
-- authorization.
guardAuth ::
MonadError ServerError m =>
Auth.AuthResult a ->
m a
guardAuth = \case
Auth.NoSuchUser -> throwError err401 {errBody = "No such user"}
Auth.BadPassword -> throwError err401 {errBody = "Bad password"}
Auth.Indefinite -> throwError err401 {errBody = "No authentication found"}
Auth.Authenticated user -> pure user
guardAdmin ::
MonadError ServerError m =>
Auth.AuthResult User ->
m User
guardAdmin = \case
Auth.NoSuchUser -> throwError err401 {errBody = "No such user"}
Auth.BadPassword -> throwError err401 {errBody = "Bad password"}
Auth.Indefinite -> throwError err401 {errBody = "No authentication found"}
Auth.Authenticated user@User {..}
| userGitHubId == GitHubId 200617 -> pure user
| otherwise -> throwError err401 {errBody = "You're not admin..."}
requiredScopes :: Set Text
requiredScopes = Set.fromList ["repo"]
guardScope :: Text -> Servant.Handler ()
guardScope =
Text.split (== ',')
.> Set.fromList
.> Set.isSubsetOf requiredScopes
.> ( \ok ->
unless ok
<| throwError err503 {errBody = "Scopes are not correct"}
)
-- | Main HTML handlers for all paths.
htmlApp ::
Auth.JWTSettings ->
Auth.CookieSettings ->
Acid.AcidState Keep ->
Config ->
Auth.GitHub ->
Paths AsServer
htmlApp jwtCfg cooks kp cfg oAuthArgs =
Paths
{ home =
homeExample cfg
|> GetAnalysesBySource
|> Acid.query' kp
/> head
/> Home oAuthArgs
/> App.Html,
login =
pure <| addHeader (githubLoginUrl oAuthArgs) NoContent,
githubAuth = \case
Nothing -> throwError err503 {errBody = "Bad response from GitHub API"}
Just code -> do
Auth.OAuthResponse {..} <- Auth.githubOauth oAuthArgs code |> liftIO
guardScope scope
let warn :: Text -> Servant.Handler a
warn msg =
Log.warn [msg]
>> Log.br
|> liftIO
>> throwError err502 {errBody = str msg}
user <-
GitHub.userInfoCurrentR
|> GitHub.github (userGitHubAuth access_token)
|> liftIO
+> either (show .> warn) pure
+> upsertGitHubUser kp (Encoding.encodeUtf8 access_token)
.> liftIO
+> either warn pure
Auth.acceptLogin cooks jwtCfg user
|> liftIO
+> \case
Nothing -> throwError err502 {errBody = "login didn't work"}
-- I think this should redirect to instead of rendering UserAccount
Just applyCookies ->
UserAccount user
|> App.Html
|> applyCookies
|> pure,
getAccount =
guardAuth >=> UserAccount .> App.Html .> pure,
postAccount = \a subscription ->
guardAuth a
+> \User {..} ->
User {userSubscription = subscription, ..}
|> UpdateUser
|> Acid.update' kp
+> UserAccount
.> App.Html
.> pure,
postAPIKey =
guardAuth >=> \user -> do
created <- liftIO <| Time.getCurrentTime
token <-
Auth.makeJWT user jwtCfg (Just created)
|> liftIO
+> \case
Left error -> throwError <| err500 {errBody = str <| (show error :: String)}
Right token -> pure <| NotHashed <| LBS.toStrict token
let apiKey = APIKey {..}
newUser <- Acid.update' kp (CreateUserAPIKey apiKey user)
pure <| App.Html <| UserAccount <| newUser,
selectRepo =
guardAuth
>=> \user@User {..} ->
GitHub.github
(userGitHubAuth userGitHubToken)
(GitHub.currentUserReposR GitHub.RepoPublicityAll GitHub.FetchAll)
|> liftIO
+> \case
Left err -> throwError err502 {errBody = str <| (show err :: String)}
Right repos -> pure <. App.Html <| SelectRepo user repos,
getAnalyses =
guardAuth
>=> \user@User {} ->
GetAnalysesByAsker user
|> Acid.query' kp
+> Analyses user
.> App.Html
.> pure,
getAnalysis = \a analysisId ->
guardAuth a
+> \user ->
GetAnalysisById analysisId
|> Acid.query' kp
+> \case
Nothing -> throwError err404
Just analysis -> pure <| App.Html <| AnalysisDisplay user analysis,
postAnalysis = \a SubmitAnalysis {..} ->
guardAuth a
+> \user@User {..} -> do
-- we just assume github for now
analyzeGitHub
kp
user
(userGitHubAuth userGitHubToken)
(depo cfg)
owner
repo
|> liftIO
+> AnalysisDisplay user
.> App.Html
.> pure,
putAnalysis = \a analysis ->
guardAuth a
+> \User {..} ->
AnalysisAction {analysisId = mempty, askedBy = userId, source = CLISubmission, repoVisibility = Private, ..}
|> CreateAnalysis
|> Acid.update kp
|> liftIO
>> pure NoContent,
admin =
guardAdmin
>=> \user -> do
allUsers <- Acid.query' kp GetUsers
totalAnalyses <- length </ Acid.query' kp GetAllAnalyses
AdminDashboard {..}
|> App.Html
|> pure
}
baseStyle :: Clay.Css
baseStyle = do
Biz.Look.fuckingStyle
Biz.Look.whenDark <| do
"body" ? do
Clay.backgroundColor black
"a:link" <> "a:visited" ? do
Clay.textDecorationColor Clay.white
Clay.color Clay.white
"a:hover" ? do
Clay.textDecorationColor yellow
"select" <> "button" <> "input" ? do
Clay.backgroundColor black
Clay.color Clay.white
Biz.Look.whenLight <| do
"body" ? do
Clay.color black
"a:link" <> "a:visited" ? do
Clay.textDecorationColor black
Clay.color black
"a:hover" ? do
Clay.textDecorationColor yellow
"select" <> "button" <> "input" ? do
Clay.backgroundColor Clay.white
Clay.color black
"body" ? Biz.Look.fontStack
"header" ? do
Clay.maxWidth (pct 100)
"footer" ? do
Clay.fontStyle Clay.italic
Clay.fontSize (rem 0.8)
Clay.marginTop (em 6)
Clay.marginBottom (em 6)
"a" <> "input.link" ? do
Clay.transition "all" (sec 0.2) Clay.ease 0
Clay.transitionProperties
[ "text-decoration-color",
"text-decoration-thickness",
"text-decoration-width"
]
Clay.textDecoration Clay.underline
Biz.Look.textDecorationThickness (em 0.1)
Biz.Look.textDecorationWidth (em 0.1)
"a:hover" <> "input.link" ? do
Clay.textDecorationColor yellow
Clay.textDecoration Clay.underline
Biz.Look.textDecorationThickness (em 0.2)
Biz.Look.textDecorationWidth (em 0.2)
"select" <> "button" <> "input" ? do
Biz.Look.paddingAll (em 0.5)
Biz.Look.marginX (em 0.5)
Clay.borderColor yellow
Clay.borderStyle Clay.solid
-- for making POST requests with a form disguised as a link
"input.link" ? do
Clay.cursor Clay.pointer
Clay.borderWidth 0
Clay.fontSize (rem 1)
Biz.Look.marginAll (px 0)
Biz.Look.paddingAll (px 0)
".badge" ? do
Clay.borderWidth (px 1)
Clay.borderColor Clay.grey
Clay.borderStyle Clay.solid
Biz.Look.borderRadiusAll (rem 2)
Clay.fontSize (rem 0.8)
Biz.Look.marginAll (rem 1)
Biz.Look.paddingX (rem 0.5)
Biz.Look.paddingY (rem 0.25)
"label" ? do
Clay.display Clay.inlineBlock
Clay.width (px 100)
"nav" ? do
Clay.display Clay.flex
Clay.justifyContent Clay.spaceBetween
"a" ? do
Clay.padding (em 1) (em 1) (em 1) (em 1)
Clay.display Clay.block
"ul" ? do
Clay.display Clay.flex
Clay.justifyContent Clay.flexEnd
Clay.listStyleType Clay.none
Clay.margin (Clay.px 0) 0 0 0
"li" ? do
Clay.padding 0 (px 5) 0 (px 5)
"details" ? do
Clay.display Clay.inline
"summary" ? do
Clay.color "#6c757d"
Clay.display Clay.listItem
Clay.cursor Clay.pointer
yellow, black :: Clay.Color
yellow = "#ffe000"
black = "#121212"
data AdminDashboard = AdminDashboard
{ user :: User,
allUsers :: [User],
totalAnalyses :: Int
}
instance App.HasCss AdminDashboard where
cssFor _ = mempty
instance Lucid.ToHtml AdminDashboard where
toHtmlRaw = Lucid.toHtml
toHtml AdminDashboard {..} = do
header <| Just user
Lucid.main_ <| do
Lucid.section_ <| do
Lucid.h2_ <| Lucid.toHtml <| "Total Analyses: " <> tshow totalAnalyses
Lucid.section_ <| do
Lucid.h2_ "Post analysis"
Lucid.toHtml <| SubmitAnalysis "github" "training-kit"
Lucid.section_ <| do
Lucid.h2_ "All Users"
Lucid.ul_
<| forM_ allUsers
<| \User {..} -> do
Lucid.li_ <| do
Lucid.toHtml <| unGitHubHandle userGitHubHandle
footer
-- | The front page pitch. Eventually I'd like to load the content from markdown
-- files or some other store of data so I can A/B test.
data Home = Home Auth.GitHub (Maybe AnalysisAction)
instance App.HasCss Home where
cssFor (Home _ mAnalysis) = do
"p" ? Clay.textAlign Clay.center
"h1" ? do
Clay.fontSize (Clay.rem 3)
"h1" <> "h2" ? do
Clay.textAlign Clay.center
".example" ? do
Clay.borderStyle Clay.solid
Clay.borderWidth (px 2)
Clay.borderColor "#aaa"
Biz.Look.borderRadiusAll (px 10)
Biz.Look.paddingX (em 2)
Biz.Look.paddingY (em 1)
maybe mempty App.cssFor mAnalysis
"section" ? do
Clay.padding (rem 3) 0 (rem 3) 0
"a#try-button" <> "a#try-button:visited" ? do
Clay.transition "all" (sec 0.2) Clay.ease 0
Clay.transitionProperties
["color", "background-color", "border-color"]
Clay.padding (em 0.5) (em 1) (em 0.5) (em 1)
Clay.display Clay.flex
Clay.flexDirection Clay.column
Clay.margin (em 3) Clay.auto 0 Clay.auto
Clay.width (px 250)
Clay.borderWidth (px 1)
Clay.borderStyle Clay.solid
Clay.borderColor black
Clay.backgroundColor yellow
Clay.color black
Clay.textDecoration Clay.none
Clay.justifyContent Clay.center
Clay.alignItems Clay.center
Clay.fontWeight Clay.bold
"small" ? do
Clay.fontSize (px 10)
"a#try-button:hover" ? do
Clay.borderColor yellow
Clay.color yellow
Clay.backgroundColor black
instance Lucid.ToHtml Home where
toHtmlRaw = Lucid.toHtml
toHtml (Home oAuthArgs analysis) = do
header Nothing
Lucid.main_ <| do
section <| do
h1 "Know your codebase."
h1 "Know your team."
p "Dragons.dev analyzes your codebase trends, finds patterns in how your developers work, and protects against tech debt."
p "Just hook it up to your CI system - Dragons.dev warns you when it finds a problem."
Lucid.toHtml <| tryButton oAuthArgs "Give it a try with GitHub" mempty
section <| do
h2 "Slay your codebase dragons 🐉"
p "No more _`//here be dragons`_. Identify tech debt before it becomes a problem."
Lucid.toHtml demoButton
section <| do
h2 "Identify blackholes in your codebase"
p
"What if none of your active employees have touched some part of the codebase? \
\ This happens too often with legacy code, and then it turns into a huge source of tech debt. \
\ Dragons.dev finds these \"blackholes\" and warns you about them so you can be proactive in eliminating tech debt."
section <| do
h2 "Find developer hotspots"
p
"Which pieces of code get continually rewritten, taking up valuable dev time? \
\ Find these module hotspots before they become a costly time-sink."
section <| do
h2 "See an example analysis"
maybe
( Lucid.toHtml
<| tryButton oAuthArgs "Run a free complimentary analysis" mempty
)
(exampleWrapper <. Lucid.toHtml)
analysis
section <| do
h2 "Protect against lost knowledge"
p "Not everyone can know every part of a codebase. By finding pieces of code that only 1 or 2 people have touched, Dragons.dev identifes siloed knowledge. This allows you to protect against the risk of this knowledge leaving the company if an employee leaves."
section <| do
h2 "Don't just measure code coverage - also know your dev coverage"
p "No matter how smart your employees are, if you are under- or over-utilizing your developers then you will never get optimal performance from your team."
p "Know how your devs work best: which ones have depth of knowledge, and which ones have breadth?"
section <| do
h2 "See how your teams *actually* organize themselves with cluster analysis"
p "Does your team feel splintered or not cohesive? Which developers work best together? Dragons.dev analyzes the collaboration patterns between devs and helps you form optimal pairings and teams based on shared code and mindspace."
section <| do
h1 <| "Ready to get going?"
Lucid.toHtml
<| tryButton
oAuthArgs
"Give it a try with GitHub"
"It's free for a limited time!"
footer
where
section = Lucid.section_
markdown = Cmark.renderNode [] <. Cmark.commonmarkToNode []
p = Lucid.p_ <. markdown
h1 = Lucid.h1_
h2 = Lucid.h2_ <. markdown
exampleWrapper = Lucid.div_ [Lucid.class_ "example"]
data Analyses = Analyses User [AnalysisAction]
instance App.HasCss Analyses where
cssFor _ = mempty
instance Lucid.ToHtml Analyses where
toHtmlRaw = Lucid.toHtml
toHtml (Analyses user@User {} analyses) = do
header <| Just user
Lucid.main_ <| do
Lucid.section_ <| do
Lucid.h2_ "Your Analyses"
Lucid.p_
<| Lucid.a_
[Lucid.linkHref_ "/" <| fieldLink selectRepo]
"Analyze one of your repos"
Lucid.div_ <| do
forM_ analyses <| \AnalysisAction {..} ->
Lucid.a_
[ href analysisId,
css <| Biz.Look.marginAll (em 1)
<> Clay.textDecoration Clay.none
]
<| do
Lucid.div_ <| Lucid.toHtml source
Lucid.div_ [css <| Clay.fontSizeCustom Clay.Font.small]
<| Lucid.toHtml (commit analysis)
footer
where
href aid = Lucid.linkHref_ "/" <| fieldLink getAnalysis aid
newtype UserAccount = UserAccount User
instance App.HasCss UserAccount where
cssFor (UserAccount _) = do
"ul.apikeys" ? do
Clay.listStyleType Clay.none
Biz.Look.paddingAll (em 0)
"li" ? do
Clay.overflowX Clay.scroll
instance Lucid.ToHtml Subscription where
toHtmlRaw = Lucid.toHtml
toHtml Free = "Free"
toHtml Invoice = "Invoice me"
linkAction_ :: ToHttpApiData a => Text -> a -> Lucid.Attribute
linkAction_ baseUrl = Lucid.action_ <. (baseUrl <>) <. Servant.toUrlPiece
instance Lucid.ToHtml UserAccount where
toHtmlRaw = Lucid.toHtml
toHtml (UserAccount user@User {..}) = do
header <| Just user
Lucid.main_ <| do
Lucid.h1_ "Welcome!"
Lucid.section_ <| do
Lucid.h2_ "Subscription"
let action = linkAction_ "/" <| fieldLink postAccount
Lucid.form_ [action, Lucid.method_ "post"] <| do
let name = "user-subscription"
Lucid.label_ [Lucid.for_ name] "Your plan:"
Lucid.select_ [Lucid.name_ name] <| do
Lucid.option_
(Lucid.value_ "Free" : isSelected Free)
<| Lucid.toHtml Free
Lucid.option_
(Lucid.value_ "Invoice" : isSelected Invoice)
<| Lucid.toHtml Invoice
Lucid.input_ [Lucid.type_ "submit", Lucid.value_ "Save"]
when (userSubscription == Invoice) <| do
Lucid.p_ "Thanks! You will receive an invoice by email every month."
Lucid.section_ <| do
Lucid.h2_ "API Keys"
case userKeys of
[] -> Lucid.p_ "No keys yet!"
ks ->
Lucid.ul_ [Lucid.class_ "apikeys"] <| forM_ ks <| \APIKey {..} ->
Lucid.li_ <| Lucid.toHtml token
let action = linkAction_ "/" <| fieldLink postAPIKey
Lucid.form_ [action, Lucid.method_ "post"] <| do
Lucid.input_ [Lucid.type_ "submit", Lucid.value_ "Create"]
footer
where
isSelected sel =
if userSubscription == sel
then [Lucid.selected_ <| tshow sel]
else mempty
css :: Clay.Css -> Lucid.Attribute
css = Lucid.style_ <. toStrict <. Clay.renderWith Clay.htmlInline []
userGitHubAuth ::
-- | Token from `User.userGitHubToken` or `Config.tokn`
Text ->
GitHub.Auth
userGitHubAuth = GitHub.OAuth <. Encoding.encodeUtf8
-- GitHub OAuth endpoint. For what the parameters mean, see:
-- https://docs.github.com/en/developers/apps/authorizing-oauth-apps
githubLoginUrl :: Auth.GitHub -> Text
githubLoginUrl (Auth.GitHub Auth.OAuthArgs {..}) =
"https://github.com/login/oauth/authorize?"
<> encodeParams
[ ("client_id", clientId),
("state", clientState),
("scope", Text.intercalate " " <| Set.toList requiredScopes)
]
-- | This view presents a list of repos to select for analysis.
data SelectRepo = SelectRepo User (Vector GitHub.Repo)
instance App.HasCss SelectRepo where
cssFor (SelectRepo _ _) = do
"ul" ? do
Clay.listStyleType Clay.none
Clay.margin (px 0) 0 0 0
Clay.padding (px 0) 0 0 0
"li" ? do
Clay.borderBottomWidth (px 1)
Clay.borderBottomColor "#999"
Clay.borderBottomStyle Clay.solid
Clay.padding (em 1.5) 0 (em 1.5) 0
".link" ? do
Clay.fontSize (em 1.17)
instance Lucid.ToHtml SelectRepo where
toHtmlRaw = Lucid.toHtml
toHtml (SelectRepo user repos) = do
header <| Just user
Lucid.main_ <| do
Lucid.h2_ "Select a repo to analyze"
Lucid.ul_ <| Lucid.toHtml <| traverse_ displayRepo (Vector.toList repos)
footer
where
displayRepo :: GitHub.Repo -> Lucid.Html ()
displayRepo repo =
Lucid.li_ <| do
let action = linkAction_ "/" <| fieldLink postAnalysis
Lucid.form_ [action, Lucid.method_ "post"] <| do
Lucid.input_
[ Lucid.type_ "submit",
Lucid.class_ "link",
Lucid.value_ <| GitHub.untagName
<| GitHub.repoName repo
]
Lucid.input_
[ Lucid.type_ "hidden",
Lucid.name_ "owner",
Lucid.value_ <| GitHub.untagName <| GitHub.simpleOwnerLogin <| GitHub.repoOwner repo
]
Lucid.input_
[ Lucid.type_ "hidden",
Lucid.name_ "repo",
Lucid.value_ <| GitHub.untagName <| GitHub.repoName repo
]
when (GitHub.repoPrivate repo) <| privateBadge
maybe mempty (Lucid.p_ <. Lucid.toHtml) (GitHub.repoDescription repo)
privateBadge = Lucid.span_ [Lucid.class_ "badge"] "Private"
-- * parts
-- | Utility for turning a list of tuples into a URL querystring.
encodeParams :: [(Text, Text)] -> Text
encodeParams =
Encoding.decodeUtf8
<. LBS.toStrict
<. Web.urlEncodeParams
demoButton :: Lucid.Html ()
demoButton =
Lucid.a_
[ Lucid.id_ "try-button",
Lucid.href_
"https://calendly.com/bsima/15minutedragonsdemo"
]
<| Lucid.toHtml ("Schedule a 15 minute demo" :: Text)
-- | Login button for GitHub.
tryButton :: Auth.GitHub -> Text -> Text -> Lucid.Html ()
tryButton oAuthArgs title subtitle =
Lucid.a_
[Lucid.id_ "try-button", Lucid.href_ <| githubLoginUrl oAuthArgs]
<| do
Lucid.toHtml title
Lucid.small_ <| Lucid.toHtml subtitle
-- | Universal header
header :: Monad m => Maybe User -> Lucid.HtmlT m ()
header muser =
Lucid.header_ <| do
Lucid.nav_ <| do
a "Dragons.dev" <| fieldLink home
case muser of
Nothing ->
Lucid.ul_ <| do
li "Login" <| fieldLink login
Just _ ->
Lucid.ul_ <| do
li "Analyses" <| fieldLink getAnalyses
li "Account" <| fieldLink getAccount
where
a txt href =
Lucid.a_ [Lucid.linkHref_ "/" href] txt
li txt href = Lucid.li_ <| a txt href
-- | Universal footer
footer :: Monad m => Lucid.HtmlT m ()
footer =
Lucid.footer_ <| do
Lucid.p_ <| Lucid.i_ "Copyright ©2020-2021 Dragons.dev"
-- * analysis
data SubmitAnalysis = SubmitAnalysis
{ owner :: Text,
repo :: Text
}
deriving (Eq, Show, Generic)
instance Web.FromForm SubmitAnalysis
instance Lucid.ToHtml SubmitAnalysis where
toHtmlRaw = Lucid.toHtml
toHtml SubmitAnalysis {..} = do
let action = linkAction_ "/" <| fieldLink postAnalysis
Lucid.form_ [action, Lucid.method_ "post"] <| do
Lucid.input_
[ Lucid.type_ "text",
Lucid.name_ "owner",
Lucid.placeholder_ "owner",
Lucid.value_ owner
]
Lucid.input_
[ Lucid.type_ "text",
Lucid.name_ "repo",
Lucid.placeholder_ "repo",
Lucid.value_ repo
]
Lucid.input_
[ Lucid.type_ "submit"
]
-- | I need more information than just 'Analysis' has to render a full, useful
-- web page, hence this type.
data AnalysisDisplay = AnalysisDisplay User AnalysisAction
instance App.HasCss AnalysisDisplay where
cssFor (AnalysisDisplay _ analysis) = App.cssFor analysis
instance Lucid.ToHtml AnalysisDisplay where
toHtmlRaw = Lucid.toHtml
toHtml (AnalysisDisplay user anal) = do
header <| Just user
Lucid.main_ <| do
Lucid.h1_ "Analysis Results"
Lucid.toHtml anal
footer
-- | Run a full analysis on a git repo
analyze :: Acid.AcidState Keep -> Id.Id User -> [Text] -> Source -> FilePath -> Bool -> IO AnalysisAction
analyze keep askedBy activeAuthors src bareRepo repoPrivate = do
commit <- Sha </ Text.strip </ Text.pack </ Analysis.git bareRepo ["log", "-n1", "--format=%H"]
Acid.query keep (GetAnalysisBySourceAndCommit src commit) +> \case
Just analysis -> pure analysis
Nothing ->
Analysis.run activeAuthors bareRepo
/> ( \a ->
AnalysisAction
{ analysisId = mempty,
analysis = a,
repoVisibility = repoPrivate ?: (Private, Public),
source = src,
..
}
)
/> CreateAnalysis
+> Acid.update keep
spliceCreds :: User -> Text -> Text
spliceCreds User {..} url =
scheme <> "//" <> unGitHubHandle userGitHubHandle <> ":" <> userGitHubToken <> "@" <> Text.drop 2 rest
where
(scheme, rest) = Text.breakOn "//" url
test_spliceCreds :: Test.Tree
test_spliceCreds =
Test.group
"spliceCreds"
[ Test.unit "simple happy path"
<| "https://user:token@github.com/owner/repo"
@=? spliceCreds mock_user "https://github.com/owner/repo"
]
where
mock_user =
User
{ userEmail = UserEmail <| Just "user@example.com",
userGitHubHandle = GitHubHandle "user",
userGitHubId = GitHubId 0,
userGitHubToken = "token",
userSubscription = Free,
userId = mempty,
userKeys = mempty
}
-- | Clones a repo from GitHub and does the analysis.
analyzeGitHub ::
GitHub.AuthMethod ghAuth =>
Acid.AcidState Keep ->
-- | The User asking for the analysis, we auth as them
User ->
-- | How to auth with GitHub API
ghAuth ->
-- | The repo depo
FilePath ->
-- | GitHub owner
Text ->
-- | GitHub repo
Text ->
IO AnalysisAction
analyzeGitHub keep user@User {userId} ghAuth depo o r = do
activeAuthors <-
getPeople
/> Vector.map (GitHub.simpleUserLogin .> GitHub.userInfoForR)
/> Vector.toList
+> Async.mapConcurrently (GitHub.github ghAuth)
/> map (either (const Nothing) GitHub.userEmail)
/> catMaybes
/> List.nub
GitHub.github ghAuth (GitHub.repositoryR ghOwner ghRepo) +> \case
Left err -> throwIO <| toException err
Right repo -> do
let canonicalUrl = GitHub.getUrl <| GitHub.repoHtmlUrl repo
let cloningUrl = if GitHub.repoPrivate repo then spliceCreds user canonicalUrl else canonicalUrl
let worktree = depo </> removeScheme canonicalUrl <.> "git"
bareRepo <- fetchBareRepo cloningUrl worktree
analyze keep userId activeAuthors (ForgeURL canonicalUrl) bareRepo (GitHub.repoPrivate repo)
where
ghOwner = GitHub.mkName (Proxy :: Proxy GitHub.Owner) o
ghRepo = GitHub.mkName (Proxy :: Proxy GitHub.Repo) r
getPeople :: IO (Vector GitHub.SimpleUser)
getPeople =
Async.runConcurrently <| (Vector.++)
</ Concurrently getCollaborators
<*> Concurrently getTopContributors
getCollaborators :: IO (Vector GitHub.SimpleUser)
getCollaborators =
GitHub.collaboratorsOnR ghOwner ghRepo GitHub.FetchAll
|> GitHub.github ghAuth
/> either mempty identity
getTopContributors :: IO (Vector GitHub.SimpleUser)
getTopContributors =
-- 'False' means don't include anonymous contributors
GitHub.contributorsR ghOwner ghRepo False GitHub.FetchAll
|> GitHub.github ghAuth
/> either mempty identity
-- TODO: return top 10%; I can't figure out how to use this />
-- Vector.sortBy
-- ( \case
-- GitHub.KnownContributor n _ _ _ _ _ -> n
-- GitHub.AnonymousContributor n _ -> n
-- )
/> Vector.take 10
/> Vector.mapMaybe GitHub.contributorToSimpleUser
test_analyzeGitHub :: IO (Config, Application, Acid.AcidState Keep) -> Test.Tree
test_analyzeGitHub load =
Test.group
"analyzeGitHub"
[ Test.unit "can analyze a public repo (octocat/hello-world)" <| do
(c, _, k) <- load
let user@User {userGitHubToken} = mock_user c
AnalysisAction {..} <-
analyzeGitHub
k
user
(userGitHubAuth userGitHubToken)
(depo c)
"octocat"
"hello-world"
source @?= ForgeURL "https://github.com/octocat/Hello-World"
-- bareRepo @?= depo c <> "/github.com/octocat/Hello-World.git"
let Analysis {..} = analysis
length activeAuthors @?= 2
activeAuthors @?= ["hire@spacegho.st", "octocat@github.com"]
blackholes @?= ["README"]
liabilities @?= ["README"]
Map.member "README" stale @?= True
score @?= 20
totalFiles @?= 1
commit @?= Sha "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
Test.unit "can analyze a private repo (bsima/biz)" <| do
(c, _, k) <- load
let user@User {userGitHubToken} = mock_user c
AnalysisAction {..} <-
analyzeGitHub
k
user
(userGitHubAuth userGitHubToken)
(depo c)
"bsima"
"biz"
source @?= ForgeURL "https://github.com/bsima/biz"
-- bareRepo @?= depo c <> "/github.com/bsima/biz.git"
]
where
mock_user c =
User
{ userEmail = UserEmail <| Just "ben@bsima.me",
userGitHubHandle = GitHubHandle "bsima",
userGitHubId = GitHubId 0,
userGitHubToken = tokn c,
userSubscription = Free,
userId = mempty,
userKeys = mempty
}
-- | Clone the repo to @<Config.depo>/<url>@. If repo already exists, just do a
-- @git fetch@. pures the full path to the local repo.
fetchBareRepo :: Text -> String -> IO FilePath
fetchBareRepo url worktree =
Directory.doesPathExist worktree
+> fetchOrClone
>> pure worktree
where
fetchOrClone True =
Log.info ["git", "fetch", url]
>> Log.br
>> Process.callProcess "git" ["--git-dir", worktree, "fetch", "--quiet", "origin"]
fetchOrClone False =
Log.info ["git", "clone", url]
>> Log.br
>> Process.callProcess "git" ["clone", "--bare", "--quiet", "--", Text.unpack url, worktree]
removeScheme :: Text -> FilePath
removeScheme u = Text.unpack <. Text.dropWhile (== '/') <. snd <| Text.breakOn "//" u
|