From f5ee6f8555c1c026071ad7e4316c2856d1c458e6 Mon Sep 17 00:00:00 2001 From: zhaoyingbo Date: Thu, 8 Aug 2024 11:04:09 +0000 Subject: [PATCH] =?UTF-8?q?feat:=20=E4=BF=AE=E6=94=B9=E7=9B=91=E6=8E=A7Sta?= =?UTF-8?q?ge=E7=9A=84=E6=96=B9=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- bun.lockb | Bin 105340 -> 105738 bytes controllers/managePipeLine/index.ts | 9 + controllers/managePipelineEvent/index.ts | 312 +++++++++++++------ controllers/manageProject/index.ts | 19 +- controllers/manageRobot/index.ts | 19 +- controllers/manageUser/index.ts | 9 +- db/index.ts | 2 + db/monitor/index.ts | 57 ++++ db/notify/index.ts | 17 +- db/pipeline/index.ts | 29 +- db/project/index.ts | 21 +- db/user/index.ts | 35 +-- db/view/index.ts | 33 +- package.json | 1 + readme.md | 11 +- routes/ci/index.ts | 6 +- routes/event/index.ts | 8 +- schedule/index.ts | 11 +- schedule/monitorJob.ts | 84 +++++ schedule/{syncPipLine.ts => syncPipeLine.ts} | 14 +- script/pipline/jobs.json | 181 +++++++++++ service/gitlab/badge.ts | 18 +- service/gitlab/commit.ts | 11 +- service/gitlab/pipeline.ts | 38 ++- service/gitlab/project.ts | 8 +- service/gitlab/tools.ts | 15 + service/message/index.ts | 40 ++- service/netTool.ts | 94 +++--- types/db.ts | 11 +- types/gitlab.ts | 6 + utils/pathTools.ts | 18 +- utils/pbTools.ts | 9 + utils/robotTools.ts | 12 +- utils/timeTools.ts | 22 +- 34 files changed, 896 insertions(+), 284 deletions(-) create mode 100644 db/monitor/index.ts create mode 100644 schedule/monitorJob.ts rename schedule/{syncPipLine.ts => syncPipeLine.ts} (59%) create mode 100644 script/pipline/jobs.json diff --git a/bun.lockb b/bun.lockb index 4c6db08833ea51547fae0e4787ac001d7d1445a2..2ea389c0e86726047df63730c4f6d2b7d03d2732 100755 GIT binary patch delta 18836 zcmeI4d0bW1`v1>5a?GRRjEoLAgMxq}D9Ax`-fEf>l~bswAjoXu1lXjNB`tGnlS5fz zSrL^(Wtv$w-SXO?m6qKGsjRHLS-0%_e)ircy}h{K-~GLQfBjyswtjflXRT+g^*qlS z_F{AP`St0>H}7e@CN}EMQJGUD*%6uVNDs0td@?c=nT~9S?BmD~M~)6~xxD1R(8T3xiR=LpBSMfZkh8OA zmd(Y0{1V&H67+(|ciNAxJWB(u$oPg@QgMEE`9e{hjp<_joV={k((Ku;&vcavzN!m` zi&;M)#RngbNw@!iNGtC+t#zVr(aSA~DbLE!b7d9JEzBw|$!<%&)EiADk*P?D&3pQc z>ZJDQ*6!enb*){lF!EL)#pRu}DSea`=fvdVMq$~4@>vD5vtM%ZYmnmVy+~=Z+L4h| zwnBlF5Zy?=c(lZkIVCZ3^9p9VCJ_(OE41?~DzBZFGix3p$SKKQl#P531u0kJG(F@r^GcBou;k| zVxF^Lc1&5JD~2$L#a$f9%qp0bRf_h%&#>&0veKNq5?6LfQCW6zxog(Eti1U&=8do; zGcT(ohH;#GKHP5aF!|z0=MJ_(ry99jo#AgHLn}zEW-4|=euF|MWEmV|D-XgY#CTzO z^5@xClAXUWyV&KDxXvthx#A-24tpZS(>kO?;Ae-=EY6yhEkoMH&VL#?PR6oHSGz)f zcJbWo1eeP{X0vmOtwB5Ml$YdXmB>&9VxV|%7z6oVxf4&s;AeGFKybx_J?xpZ7TJc} zrAR5AgOn9{8IrN99E6m`(Gw}Nw>^?cShQw>=L+ zN&{Y`)bmgI-{NfUH{b`j82lwt+WE6Vlcas^Y1})kOQLP^T%@!Zij*2%67`tI9ldRm zTrO;^+@*^e2Ui3n+l7i;8G!HMOpQubvb7S+*-w}@uJMEHavxGwXg{Ph?vJ-We*So8 zm(0q_%bJ}%D=()khx+~jE00gMR_J#Ftrc5QnV++Okd~B254IaFDa^|$WrXvy3$CS} zYqn!R5alvs{44ggG&^qpr2_3hA!V<-8`(hyY>iXUf=xjJyaFka$VSQp z&n_-5D2~ZqbnT^f1CyQd7Q^g4CkNRDy#S=tzXmDc_HPaT`$>aaglqwS-XlD8APwZ^ zluG1WWf;hI^2bgdILhw$myz}i`VuL31Oh4Qt|92N?NnyvTDKS1>Cv{Hf0v(=RZ<$m z7C#NW3R#?QIU%~qus#13DIuyy%Hn(vDT_IDoL%lkN{2s>wPn2{k2!Lo)6SXkw&A6h z*>hzdQsz!BQX(~Ff@`?tY3aP;g0i{uTt}$D_ELEb4ajb>7sI6EC(n+*?CQp`=bl&} zH*nxf`{K_|n{exIC9g*JeJE|;=Qqq;R+sKQ+PJQBtFdm+0Mr}n+VCXr1jT&-rgTx8 zBz2q4Y2#DB>6$h^??kuDh3}OvtE5^-we_htbxvEKTQ$<#+orh(G}2!p@*3&rc4_XQ z0G-<|P5n*RwDWn=8@pT?dPlnyb*GLB^10oY=-i+*_k>II_MkNHhD%(o3A7xbi@GLx z>tREzernq!xucut-1cc|rLJl3Q-^hZd!ILsVNSIb+9kR3ygD~HO+Bt_f_>gkDC$Fz zTi3Qva<^!zqeIfXR}wWsvjHyuB#OmxEOxg<2wcV0cGaVh8<}GMuhoF(JZI`5W z=$cTU`iHI$^?4JUyIlRyCO9-duer_*OH=phnlPXGUDt>C+~WgvbaDA>WHoh z_jwaq*u6KBuz7ETNwDdUV7~}s=MZz-C3$~^Nr34W%?!p|m=zSyov@)2K+ngd2I(E) zDc&$joGbSY=b`M;*{P9ewW3t@ZYfY3@m_^_LyfypOY5 zr=mgM;Ysf1ZFFv@H22gtdV8ld?-r(yv`pWflDzN294qOk1#^1@WlF~fCAlZJ)!RF# zsr9RJha`DFa#&-lUI+FoCq$i- zJkwyQI=@YdcLOP@bBV6)oaB|6o&a-ObrSwywIh=QAR}~s*A(wgQbSQ9_DrmwVd959 z67j+QS#%~W$(!#m76Bts=P*oX27Ifdy8GN$hUnbxX`W3i{WzW9DaHF1DSH}9Aex8j z=pJeAQK34wN1As7bR+Obl#q^4V`mYrO#$yRC>sS#GHhE%%V(I!Qm z)lq$X-uTY;;CpoucF%{&46^!Cdv!e;-;*cvwVAapQX*~JthwnehYg~PaqF0*p40U) zKCiororgwfk|!0`U+?Ig;$2KiEWgBBZ7;&ae`_4Qt-IQFC?m!OtUqO}W#)JVOrn7% zaeEFXk+OCG?|G-59k=9ec7&}t<;jKFvDrszg5`ay?oJ%MSCA6Rt+k>y>6&<-`b5{q z`#gI%xsB4N<5N8Dp4dn#HGsqfD{CF8u~zC6Qsb>uTrZbvjFnnUYJ`>AM{1~~-0h-t zbpJGWVU*78pXS{Z<)0=5%=6PT|5^cNPM8`7}x4^_e28NIvhS|ZB=@r=9 zX7-X84U@HPO(oAZ7`BF`c+ZjYkW1w2YL5%Dxjk0}}&ieQa_Qh%@0Cm3Zzr;;0?B zxv)Q)^KOKtP}W?>k4$a?p{CPsb0)VihL+oCT7SJgEzMg-W{#y#raGacd_H$fqR#cD zxl0oDc3+x$QrG)@>XeR3_qihn=-l))ckTeaJv~i5sO!^x-c;@}OKE{c6rALF5oWs+ zh*4sf<+Nuw$^Mp`<)rK-ATz8ECbOljwTHLkpu+F3PSmf1i7%94F!#9VOVd0vs5?fs ze@_i5c6IK1-;$C8LXfq_`UwpZd0l5aCk0x6?iE;bX1F=Lto z%dp$y2(lN(z9F-VdxmR_-HLr684q(jW4!N!*}ll>;$7G{s}-@MtHHSG)9ESR^`sb5 zv6j|bjdgL(7bY_%14hUlwjL%cz}AeWF`5+nxfhngxJL)2c%PM&l`pmj;Nk@~_7BEl z^R9(m=(+i2+}o*V&yz}+L=C@^lbb+@x&%2W$s2@+&H!-Un+=lzU^qgPI2Gqy;q$&t z-fZ%$iS9|B=yHt~S5=jc%1p^>=dyld;-@VYl0%+#iEIQyZ2E6f^f*gdS3@#@k`ADY zej_uu!cB@`S=aw2r8lOZOIj!JE~&@-v961yloLqnYDh{sGsCLSh*nq)GGNwqv6K!7 zyj4zItxKfj6DceIax2&6x>$P2o8sh)ln$plT%^=z{H$v_{aXq%oQ#H~cs>(IL$e$` zkrKzb4sS?`{yeArKg#APh()=gsPnH1u8?YZKx96UOQe`l2qeD<$R$#Eu@J6?q?DIf zrM7HLy4>L+rS~O3^p?ti$VI}s8j@0Bxl=AuDoQPpm5!`J%5|}n@)bbpUk`-e0OS%W z{6_zP+$6bNBAbCbfLOjBGy$7{G_(cCB~lu=UkH~-;SV@+D^f0z($2#|xI}uu<3QSb zLIy;xCxFsHQ+iqh^0Y9p6UcS3lxn+yG_%){2as}IEXC~Ctla-AX%EQ76`Rt?J5ECl zN%8Lk&(ve>wCI2*#OQe*4BZTXJlTzAVot*zhiY31}`u~j-{qsO95;ue^`C&_YmvTD=jT{-^ zD2SAbjh*~U9PV{^Q>0uMOVMxclm{X&fy`@2`V~6^R@8De?O2pkYspi_R7HmT^&rwUsw?z>unv|JOmonoIx90YgG2 zdNTL^I%r&c;E;&?bbc>#K8v zv%eYsQ*uVXrX?AdFWx=)jRRq;yKVja)?L5U4qdkM(?xghYaM>%mpNyTHXWb%{Z|j| zzk@lVT<2S!M>f*?pUl*~as%}ZIfnA+!#SDyC@eA8P?zYc+)TZ4exUvg=GF1@Gj(!a zpuTgy!5=SA!cM`4=NT$cSLbEw_4$GNEUcv-lAozZEeO&Mq`msIGBDqLq3W$Jmwf%+h< zgKk}%sY6Nvby=~YI_dqeL$K~8hKkfhC7F6rX`p@w)>TKA;$Ip5l^UwMJ`6hwODr=~ zPhC}pe+%&s7Nz4C;@`FSx6n|%^-0(%*zju&6{D-K#lJ=P2kWbcEW*EX{99zGczp(T z4wg}FsD65LIsPrizr}`1)Dsuu-xB{1w2>+tV-{JYLj6ZIL`IatQ^ zhMJ@|Uypw`;NJ~~%Fq*Uz`q;u50=3N`Dnn)IqE+~JGycJ5>ByV$?-u;K*-+W~FzhHS@fL%}x>dK} z->vuu%hB<-;@@igyVX$h^-0(%*znbc%GcGa@$WYLgB9o@x8dLI_;;J3iu4)SIatQ+ zhAPpUZ^yqi__xMTWqRTo{Hw-4*tJ?!vDeHpby`PZ|m@FouO{hRqHbO zAi^cg<3u*A)VdPrAo zX56+gZm=31zlCwTpK;q_sE74Q*eTfX`wc!0QGGxDJ%E3($Mlc~@NX;rJz%I>eFk<8 zma)}Pb$atw{Cg1p9yHWbdg6ol_YnTUc53wy{%ym*hYYn_*TQzeg0>mz8J)Ea|7!3L z_MC2AgMZucuf|Z%>;14puJj|gfq$@9bo>tddldh680s~B5_SqU{82-_p{pOozsK+o_NE^482&wue~%e_{NxPm z94zB;gO7J?ejNX5@vqiU@92rO`1b_Dg1*id&*EJ^((MNPY3Flrwu-WQvNjl?F`h%VV~)!o%jb^ zz0*)%=wq;zy8`v#U52XHt9Iev?m&GS_LUyE8~uWAM?24SVqK znLzy;?2I1$4F17(JY%RI^v|$u&j#vg&l>z8zvfx|doEB1K4++(^i|K{-`+s|9PDT9 z-HU&){JnsxEcd;dmoruSI&~;m>F-+i(w*A`=!jRE zc$)CbX<*&NBU9Xx<@JAHxKdZY_Od6qH6J>wJN#CrvI;-vsRB=jD!;4S|3)h@r-R8(3b)s(Ek<5T*cuy$bUyvPDcBs< zR;8L%ZIw?2n)}*UEVKK+4Q{{&JjPwrC9*6nCQ9)rns z4oFg-XUa1;xqb$cl*eRJF4r$W@|uAlGfSGtBq^6X?3AKF;Qv+3|9eCW@{R(z{J&GQ zB>lcwD^2XT3OF%QUz%VrTx*@Y04J{vdLsvy<2V!5N<#3^C`|9G$~ zPd8=E+JkR_SlGh`Vc8rw{r5rNFTTJDy+bZVmP=5 zv;u7$#R$^!i-XwP*2(KYT7HjhCvfsQl0FH<&>$yIPOb7JTdwxxi6fms4Uj9u(xatF z$XJM6p;o5#!A$E(s2C9D6d2TCJx`A;dB9ReDdA`GBw;p0jSts)N@9F_A zCn0&AoxGl;Go(YQAkTC8?|Lg(e!5&&Mwsi`s~+aA_G)aDxGyno0VJ*xN13k@CJBoS zt4x9OW_+;f>5Sq{zV})4=QCP4E^t4E_#|fVa)V!79As6_T%lP#}XNV<8hk z;wb|yv6cs&*vuR9 z0g6B&mL$EHDd91M*ORBp3xo zgT6pEi5qETI+zFy@G+3JR|mF&hrl)8K zBgYKX!=mvU$9-t=>ul&v=kQRqxKyM)JMuR?}FNg(kAd&v98@^bY2nGT1BpD=u z6fgv&JCLXh2L_PEH4=;hV}LBUNgxAE2A2Z~vn)o*7cTNDa3zqPr(y~}rh;@Z6I=tb zz$`Euh!>S07f5);UEB5tOmD&`@t5l8LS5;SOeAp4XVK%;7+jC;hT_m zgAES%>)!~FnAOE4ZH?k1+RcZU>tY@ zybh#H_*+1xnx7vf?QidG(nr91;9dH+ZiUB?AA%3S``|b@0UCkdfE&YpLP{fI@ISyO z;3P-`AA^4aaYV}IgR>w8^ah`T-?{3MUx3fSXQ1K~KfVTEf^WcShku3q9()JB1!uqy z;71?^i6Q?2zkr{?Iq)lx{PSQSP#7&c=I;nOJ<3rl0Emvh0!X+EbXqs+?NNKYr3lt_tXIM)-)9oF(<&f zJ5^>JJK4KUCu1?a#o4_T2AC(%4EMh|c;AiBT)OSI77wB^AQl~t6=v%m*i&uxMuhv{ z9$oPBz;okrFAulu9w2%(<_r`P{jZ^h9;)^pzv1zRQRs)u{kW}SL`!@KYE}Ep;@cOj zrzAeMzxeQuxkK9i424!GJm2T;_fs-L##jmovB}I%^CSvxkH<{!jXVCgdQU`#wrM)J zg&V~>QRekh`Wd`kwi?uy%GhXkhqMLrv*t%0zmNZ${OC|V6K)qm&>xEW` z*KCo%81(R(D=1dqm{0Xm<0AYo4ChC6oVk7N%*))WABNGmt4njUW0V@J{$b9KQlSz4 zcZYAfB0*?C#XUyjgf^OLH$%A>9A=@Ym;N z9-q;+N&gE$c+Wf&t@=gmA=+L7zJ6``i*N6`G6aRh*nTpYcBG@#Z|3~oDw0{ax;F!~ zqO~2>V=H@{Pn)vRi+&s^0q@CSh)(epbN3IV&YxRhKoEX}ft@;oRN18+X zFij@~nbZ3an)l4=K5CrWZhq7U$NldIU#;%>V8l-w3oWax5cLi*ACF;<_lZ$q5&qYL z_qF(8(%SZuw@}bte`}#5m{BQbJ?>ulIr%U|G3meBb=3!cL2X-{Src3pv*(r|wrp&DE zufi@a3Q?=g&2j2(ncr#gDn!{PT&x-Hye41y#iQlbnV%H>guVTUBa6PwEQ(j5=FxaY z?1d)w25{B$-+1mhak|$9zwNbB>Fyb6u3^n2#zoru=HEVju5kTrXFswutr+^>puc7I z+S+H|f5k4b_NmXz;|ch)B)~kEfIoF+?|%66vpJ)m3LW5ob9(R(`)Xfpl{k+E*+6CH z%DdDpSOWo9CQN>#@%Dq1B-#tINmujHeze5qLlYPKYsL~Ie;n+9+d-1}iN9|4lGpn) zZS3eeA?z37e^dIKb(5~li|BtMKv}mE7Jttk=J-T5F8{mLk-vADG$HS<=PzjZ-@fiu zQJ$nf>2>Nt$($bMJ=6{Nzps7Q)-%1%H`?O8pt06`GZ7aaH0u*pKlh|4v*Q3Y);%@K z%o|{ZYU2R1v!l$np#%IcL4RG^Yw^Hax{o6w&fYmQ+Mbr)->WxXQ+iTa!$R=mT=S#N z)FkG{A~Pe2sIM^hC)3|~^8*nF&F7Mc2{)tkWOQoGGf=h4Y$kyZvcCK;ce_^X-F9e1@k-+fT|S zD;qi*KbSFtxFI^t~C2?JvLi$>*trNQ1|b{@<`^S_0jzuP!@s`TAE z9GAFn>@rm^GhyB>{sfS;AemV8x2Xe!SbG>CArk?uP z{0b4_ykB1V(b;XCye&fZ*m?;pSKETS7@ndu)xHx!^uNnKc-EDC} ztE*^HhLkZsZ$3{;wt4L$t)cRN%Rz@OC%f+RcG-=xGlhZ%n=O0{qU}@yPuR_=K6O{3 z|9dR1nE2ZGtX5CHY&CDK0ss5*BbT<_JahU*2A|9b)+{^6%BaqoP4h`yZ7*#AuekFDGo zJ95|OZ&)SPNqjWtzhOkoKa@>}bGO=Qb|0?#B{pz`b0&!Yn+B$Yzx?!~#PeU$o}89g z)Yq7+hqFBV-waT7;;Zb-jtq=IfjJ{P*-hqt6#V^#`@eEv_mf}bwS4iH8!srv3X3~oB(w(4AnYBWBD4^Kl5))~6jZ6X zWF%+Oeda48Rd4Ua3HGo}F@KXnXPff}cnoXB@4dBfnx@NhRIbV~=9W=vsCjCXiVLgn zWN*ROCnvtH7PUD4xT92j&(4I=YJxI9o~7ET0p<_0)F`vVD%EZ0iZQA@)VwxZg`165 Ysj!_Xv(=$)<~3_o;Lh=@RBW670Yb=Y#sB~S delta 18405 zcmeI3d2|(3*7oaM2;>4`3XlnbAY&kbOk^Utgc%Bis2D&|0|_P=2qXa$rX(N;C<-32 z7!(OKq9Q0pKqeugGC0t*6R4?;7k|eE7+GYtq^;yeo6yT|cK6Uh}sW*#|p*v052& zwOXFtHa;WRA$E?@z%VKglN7rL8-&fLLM!YI*hbi_<-2-RLif>}~VI?-Bweqx8X*$vqQW4V3Fv7{J zgB8ii^eJOZFD{6lgp8@vr<6}9%FP?(=0{;gY8$Nd+1$13alj4*Rzg&td{K0PkcllQ ziN2+yFMOvukEyp_&YL^zSj&nby! z9&cF!m-^#cJ3=1Eihu$fZigL-4XYp##!~Enoq2^}w8biTC^ic&A*PYt@LyM7N#5ic zdBuhyaUEZ77<=he2CTt~QeULgZUI*K_~M)ic}(dAH@|Ot!x%1ec^?U>FgdUImb^GB z;F)xkTTpCITGf?Kc}ZbTiA>ch9Ak{iaajIUCR1M=9;~bChE&9La#m71Y;$r0u~Paq zJ5P4xJ6PtT@R%Q_MP(KR61R5U97kGWr9=OO6i>{ZK)*&^>Ji(@`Q06R1S^h}ySzBsnb7C4(!OX) zUTMMPJYzD;VM6r8DU+$!i2NVAIuraQ)+;OOLlRQ(uN|L3iNu+OJ|PDOw)S+CS7T+V zufR$>|B_$qa=!x=aB+ABR{Hr@hu)X|b<29)!nYKzsj$mB%LAJ9IYfn;J$%<>Z1XgtVk|M{lR&lBtCSrOfc;yrSD^ zXXLsLR8uZ1#=m2;Gn}~nPj_yiGhpTYeVpjb!?utK%OfERd8}J-BGU=SK%^IQE&;n|A_G4SN?ERRQ!jt;uwxd2a^g) zC4zmrSZ_$pXzz)7fju^59Qb6x_&GH_ zn-22?Fa?z!UE4fK&DANvKJVX@VIZc`u=AShUBNyzQvVd}^UU+;)D{_@ogO_CbJnAG zWA3k`&$q}>BXmkjUqEeuVT{u0Ez?vhy{o0qGryib-!j8NmEjGqZy0!4SyyL< zC3z>om>tH+3{LWFuCLFx%1~aN65>-=>+%qvcUz!guwbP^%Oua)Kz%+WL&fTpP@i{# z*D$(Mfm5uF4)?)!B!Wzg}s=xlJjn7lvRHwGh@Vwqs&up9F zjb#(wKn;)7@GNbn&r^1)nNDq&;k}aOC_UHJs$G&d8|He-IQPH?Ql@k*;d`UGPL0e^ zVY)oh=N-dp77>A3g(i6)he@1q4@qZW;yRLG?OFd4ZWa_ZZ+2NdyWLut6Q<0_B=37L z>BU}--f)g8X;)uMSrshKE|c+Ueq*wfK8A^#gcp{~a_J5N?=t?)w??SJSRi+`HmR@k?icA`eNHOZx$)1y#!=wsNUTv!*e85 zpYN36trO;Gv2}V|BT==9(;Ri$@z_j&ih zQ|ZsERqG`04={I{i11Kd9_{naZRf1rhW0)=1QVV1I`sxb`gee8o1}*5@))1@ZZ{8q z!;=CI!xD6QWSX~Ld&l$o_U;=A6aB=J{q`VCykH?Q2XDa=VC-?$d&4W85vfVshQK6J z_Q~K~0+V)5+@6O?gzaS&@IB0l&9DxfYPR|ZNZE1len?7M+WSUz*C}znfGIqlCFqNB zz3X<8V9tq43%Hw9e>?RzQX}nD`_6_j%uY=qb(NjkOKPZ{s>c(`Ksz;zR9{JX)^*Xl z6EZv(y6E!>8Q$(){Y!OQyG63goOp-S!#*yaCTtAr1oU?Lf!Ng(5l|8V& zFncw4F2?AYsTtnn9!?c!a?4;cDpk592SUUlyU5d^r%nyY@b*WHOn;yqky_YQFz1YE z68qZ#xS0i$!Rd<)wjB2R<~!n+IVY8u4n>f2lNbaOADj{9!(?`x5%$4k9-a7o1N*(t zZt;eZMp+|!<|e`@c1K_7GOuh4&(V0D>dWvd)@ACOPyAt$yUxw$`1fAL^ zL-o<+eSE4^@9N|8Y)RDT`(${&Pt>WI87fYfXZpN{@ntqW)VB}uk=%+zup?>}Oq_G% zABV}3bIJlJaQ21Frw=B}C)hsV*TM3fc9be{RP0!${;*|t{`s0^JRmKLy#RI*MFN%I~iB@uJtejY{> z=de%-I%S~Go6EGMlNT&2JKzOavYr#3=DkR2AoPHok%51W`Zi6w|%nH7GAAvbz zRAnRwLI&C0NfaVk0W!7D>68nTwaSL2*~2hdAjFcIe|MR4s<$U}5@%;gjD<-r&YE53 z)4Q8zcwZ%xvG5y@RJHzTh|l{zp&4mcRP53ogl#;`8DKd~hV$CPeF#G!Wzu?_PBDGn zP537D?c>+$?dQ0_9_OqX29ws@|2ie9B|2r8FW?M$JkAVD3mC;do+v5r9#Yb;(pBln zfe;C|?Ke+%<->Wp8{oJ|x7;;qU{t~lHI#b@OjJADq6g8JA-TCT$_{Wo%+*4l>tMs3Uhv~A zEM3pZO!JO6FWn_?!w7-w8CFEwVTM73T{a#j+rZgR-@@obBFmjJgRZ%Q^IW-5Qg*)h z{^}oCD_nI|a&+AY`+a}D3A>SY&QcjV;tzWsCL4h$qvU;ems;tc zDYDC%gbKR?3A-T?vZ-FjlBU4hHR3ZJB>jSr3$SEjf*MOeASN{y*Pxc*@EgX2Rg z>XCb!UFKLBuN+9LnQs1nvQmGxTTiUCo8#KKu63rzKTVF6dX@6_S2~#IR-BKOORUmc z#)hOcB()5PoA-l2uog(GbwI9lK)S02a*0*?;@FTO(&|yk;u0GGwgPGWB#=w2wBF|0 zr(9cumCLp|D7SNkwAu-zm%Xm7#maT56(5h-x&J%cfIePx`@uRF01CY){w53gHqf%P`I5ms&aDeB_Hm{jtIayY&X= z`V&}54sp3y37LtN1|!`3%UMx&wOcM$lGnIgtkTgph1fzzxw&Fx&tLEI%ULOs-^z=w9s%grr;pzp{O4nUg!s?L0D>UbpN|3dA@W1-2f4bQ<=76$22lTFo7S5MB?gC_^+fGMU5 z(pgio^^dUauqIj+W$Q<#1nImYQ#I4uV55tIbjzux3f4JOvvuIqApHWYrEWGYTR#Jv zKFw4ix)zo{El77PHu)9UwBl?XS{$U`fJNxYl5Bk#wxGmRSLoxgvXUU3SZeai!>ZD3 z-K8{0e+-M%vD35l3D}D1rn*v}hAoegeKSqor)`6co{7F$ri#}&v(PsSeXvB` zY&QB}(`TD1N!P;iXQOY9sZ#W`Ip~{%J{W)KG#7oa1#?Z6u8+gY=Ay5{R6bo*fxZg# z!7_DhCHi11Doxc-pN1`}L|>Ju2I%Eg=&M2>Y>>{Jhd$WGc_zQxIR{%g4}J4Z-U3z6 zN8fz(-EOMkI_q}y!M4LjXte-+x1(=?sj~Do*ysi5TWG3lbk0KbEkqw|lx}th`e4)V zFjcm$h2`IYzD1@Qqo*xG-y-zEuGf)^(Fa?w*yKg$aah@6^er*fO}c6c`j(&%mZM|u zL?3L$ou-PoobuOGn;^KG=f$Of^Rzhn3xjz7?jb&{ZqYw*q~zDjj=&wwk9G z^K-sF&ClC)ij}Pv=;apLEVNmsxl+bh8K11)Kh$sVrR!%YP7E zYfZIEPg{$wwdjJa(UA|K3%1}PQ$47U!^$2)*E&-@q^s7UYaO~^)jGDCd4sK}Hq{1w z8n&pKd0TI)je7Zdw5>-QY?IF1z`VgWZZOrO`W$TK2IlQArrNBl|AM~1pl_q8w&<*l z=!0#CJ)zaZ=-Y_ChfTFjZ-b3~7=4>eRikq@p>GrVVB2-GN6-hG{)nk|>RMR-Bj|h7 zRJ-)FN745v`e1u>G*< z7Cnx>Ev9-wFW-W`E$D+C(wSS)2iv&SR7dnV*vhTwd%{#N>FOuY_XPT$G}S9Q>q+#% zw!@BTwGDkwqHmk2j_Yl((c94Xl&N0RIZvVQDfGeK(9LSl2b*4Fs<(74EWZYQPn+tb zp7u2Qo<<++9UZwHeXs@FO?67ga@v<|57MV#@9VBR(6=Kw_n>c2kPg~ws&jhGUi9q^()(cFXzxDs?F-VA_nGQDy$kjX?22bi z^@A>W7JbhK=~rMs>9GCi+aILo>^IfV`UvbWEc$?{F6#0F=sSSE1E%L!Lr2wKr@Pc5 zu+~&cpR7e7Ed4pT@hyH1fzKfj7NAoOBJdyr56X@2GuRo}@aN^mx9WKWK94|HLp|gL z1ipa47v#qG6YNLWxEJNd_vniVd=Y_%!|daEyri6maRKFf8!)~_oA}Gf+?lE{nzQQ)p+jiqQ8DERZXgiem%Qxqkt5rHGl6G zqhsIerVqS&O2+i;=v}k+a$LPos48$#^ML2{k$IJ(}2{ z()|PHyINTTTBzRE?fg&;t=bkUI6cUH6Y(wnNK#&dG;#C3bMxd42*0qiukZOO#qv5V z)oRv~F8nW-esqiEEujAmm%I&>>hjV_n#v__03}b}1qWL>(gnXUvabvLl%gQue=~Z~ z&1;N(6UZfR0wsb?zzJ)cbg`eLTya1<0zE>%E`+>sV8q#qAb-) z1y}fAeaibl>75BQ&I0j9-U&*cym1+MUA}T6W@6GXg8MErSAiAO6HS)@@Ithi(QP-f(&u64cH_Z zT&>)CZAlN623#R-UOUqA+EB&{wexuO6bX?x#L}_66%N9uI~^14szw{!EJ5l?05^^UL}3sIe{*F)6c zdJV~Jq^vffs#P<4TH&%n#O2o3fKb&rpfkxX*0fM{O~p}?uYgy*l^74amFiE}$!r6GE0+1dx4N z59E4!DKK66oIMW zCXfTJ2mQeSFc1s^(V#xKoj&G(8^8#eg&`!~180Ez_Gtsy2p$HTz#~9j0M7(vK;E6p zt{e>JQuY*h8VrM91ul|40xC!+0x!4*o(|*`lV1kN`6`?3dYS*TkPpE};3Rk(yaVKX zSqpBaq8uyT!I$u_z$x%P_!xWw-UX5;wi?J0A!#`k{sA@vISpj@e@=P?R(5!n90NUp zZ0)PTwIE+6kSjk@c6IxT0@BZez2I7~2kZvhK?5M_Yk)*zF{lKxuDl=+)CV3Qy#|1~ zpbn@9=73x<0Z3m7fN8OJNeDJpy6QpV25>!)9Uwa;7>F~nZe$n8Zs-p(K_4LD?hVpF z5=aG|K|2ru!a;M;3^WBzKoDpI8iK|^910UD;)x8{0?1Bj2|__@&=y<)+JGxTBxnyh zfexS}5LK=k`HM1JP&aH>ApLd$Q6L(02QeTX#DQ=LrI2JGN_v4rkOF)l!-Yhp9~c4# zfdOD37z|`rWr1tJ)nFu$Fw2gUeBolV!F52+7ul6#L4^!(Gq@4l1aiQ5Ak#7z z%%y~JHkb%z0STeZuc*HT`1A8fOPS~^p19pI&VAmz~Inw*Uv!E92 zm(6g1#6chtkjio+^nmwB{}o6hiO37!7DQFD*k!wO)o@eCgRpwXf7P?j$6u8f$ZcK=Yi|NV9ZC&i3!c@K$(ow~$Wb6H&DlEeO z@{Q^fPx_u36`lOCMzofREblJXp_V=e2dLao1cQsJK0>R4ZNQlXwxb*xGs z_R~66yUr>!(fx$5a^&2?z3*p7Z|M!-8b3ePSc+BZdw2F_36~8Ce zb^eREzx$fE(?*33r6iUBBy$v5>0MNqXJK9If$l1_wf{@f_aeiZH%M>np<+)*`KU>Ze9soO5gxH4<=*LEflq9iT>{|EtxKy`wg7^)xwW*RZ4Q|E@JP*1R^n z>V1g_?#0B)f0u%~I&O67s-ha?*RyYgmEYF4Zs@Aw{PFJ9FVH^4E642rGT?#t&UUdo zh>c-g`af~a&U$_LxUY|#cDu%{O@Y>X^r4EZW>IRm=i>&}%~8zKhKAP6C^am?|FPub26b{# zr(ZIzU*x5Oo-qj$uMq2sXcgajRj~aeQuj_duDV%iF)FOJ|4Y@e>VbC#{_xOLI!Sb9FvO};<+zQ}{kk9gEv z(Sob~8vYMkugiMrs+^`zAEFQ071Y=oW|j6(!&>`4arJ*;MGaPuEBDI(}M*^ga!nB)gsx)5lv|H&R0lww7}Ws4Q!<7-w&} zM}x;%<1N~XTmH{Wm+w4yu%LbHqTi2+nbx#K=5^H-*5Ft=9BIvpWww>|L@XUTg%SRb zRHwB0X8#)}I;8yGI?TEltJXyLKc{W$`S8Z9FTa#&Ng*5wJPbLW{jtA=Y;jgY<)>TA zmuG)C?FXvI6W@3aY6e%6S1@hs4q6t5~hHSMe~;#FwG-geFb`Rd>IOnkdF?rU!~NTgYnl}@Ps5Sw^^=$+$O+3|407oLF3Hpu+L;bJeN{}Rx6&-#wm zvR*2*m;Zy_Uj3VlUszv{uB%w6;+ou{1Cq@N}GTo-PB~o$QN!Jvb**j5#JjO|MJnShu_Dt{ zi%2Go=(IXN1f_@pg$F3d&bD| z(ax%(g51%heuV!^;?#+cmFUhlPNHHj=l)r49iw7v|Chv>H~9wD-Mr?j|9{9o_}R|( z)Bip0<3+Jg7k)WmEsaDQd(|0U6G`5pF0^w?xh6k-`t>C)C~D-8cW6hh4V{+pLH5~)zOz}E617~ zCqSldMt0m4OJ`qo)OOz9G1Wb-M!h+CxAwF;^;Q!-8xyR%;l2FdJTLDtc4?>W>1_D9 zak#-<*#8x@x2X4v|HxXshmypYxL$1atqE4sbdI(ETEnxnm$hyXQ|143dh#yw^qJB( z@5L|op`*VwE}c1DmSmNst6|)1UPvdn?g$Y>Q|$k8R`&n4$@a}h_RpnVY>K@WZm^>H zC^5qSaq`GRz3+SY>(#QOsUWxY*;Wn}To2-`tr;r6*JUP2p126D|EuiuTmG6m`;JL+ zyNu&tU_M?-v4-*d)Y|_Y_uo%t9V$3`#f?(KIXm1Zti;PKT$xg))+;_| zNy|eT`$qM#_e}(*^<~|)XOkgE_Q5Itx7`yGc9f+a%dY3hm!6%-$MF{3dZv$B-TE@O zu_R}+a2uPF$=KP}9hqu)#AWVg3@N@gw7$w@<#z64|4+X1!52Dhidy_K&!G}>so|p} zg4Jg%{r=#lzCWLEO2lDz9awJ<;j|xXP3w!uJnK$O#5@|cpwYVHyQdy+Jmqd0$!Wtq z+I^_J-#XdXSrU!=;pSMYb3f>@OzQ@yJpat-$MesLOzSbMYGa+ESoN@)^=FJ>RyRy* z|Ci_APq}|yiv|y0$rwEG%4U1DpLKJ8x;fF$n%SS`QPvh3c-(9iZ=IHImRLVaH~tUM z2OOL*;g!zc6w^(jy%>$!x>nBtm%ok2#tR%?mI#BZw&Rc_0j-(_J4`K`I{fs z_k824!)_30_tv2M2jbt+##Z=1WcmX+aUg-TpR?m5F7rI*&e%@t7!Tr!{;$D1JbC^8 ztM`5KS9-TMNu1G#|3Nk*_*L(Ho;TvPl-5oOr!5Qfib20^pHNk8WkFSqbt|T||NHjz z1~+~1$=d;4{LTCm{hOa^gLRe$5&jR{kG^$R{gv^vp0)MaH{OF*L z3D!OaQ5n`-gL%MQVs#v%x?LGD(s>x@i1iYK%JDnRq4giL&lqQCxM!0;<`1)Yf13bV z$qml9|IzC*#QJ53>dSxetc;;5E_`}h=NP^{Iq_vx*7%pv@&=Ua@2ht%8LCFAonwZn m@-XW=Q}x+df1*0v!8)6#!mY$%s)N} - 返回包含详细信息的pipeline列表 */ const getFullPipelineList = async (project: DB.Project) => { // 先获取最新的pipelineID @@ -46,6 +48,13 @@ const getFullPipelineList = async (project: DB.Project) => { })[] } +/** + * 插入全部的pipeline列表到数据库 + * @param {(Gitlab.PipelineDetail & { created_at: string })[][]} fullPipelineList - 包含详细信息的pipeline列表 + * @param {Record} fullUserMap - 用户映射表 + * @param {Record} fullProjectMap - 项目映射表 + * @returns {Promise} + */ const insertFullPipelineList = async ( fullPipelineList: (Gitlab.PipelineDetail & { created_at: string })[][], fullUserMap: Record, diff --git a/controllers/managePipelineEvent/index.ts b/controllers/managePipelineEvent/index.ts index d928175..9d8e1f1 100644 --- a/controllers/managePipelineEvent/index.ts +++ b/controllers/managePipelineEvent/index.ts @@ -7,67 +7,79 @@ import { sec2minStr } from "../../utils/timeTools" /** * 判断是否是合并请求 - * @param pipeline - * @returns + * @param {Gitlab.PipelineEvent} pipeline - GitLab 流水线事件对象 + * @returns {boolean} - 如果提交信息符合合并请求的格式，返回 true；否则返回 false */ -const checkIsMergeCommit = (pipeline: Gitlab.PipelineEvent) => { +const checkIsMergeCommit = (pipeline: Gitlab.PipelineEvent): boolean => { const regex = /^Merge branch '.*' into '.*'$/ return regex.test(pipeline.commit.title) } -/** - * 判断是否是成功的CI - * @param pipeline - * @returns - */ -const checkIsSuccess = async ( - pipeline: Gitlab.PipelineEvent, - stage?: string | null -) => { - /** - * 创建结果对象 - * @param buildId 构建ID - * @param continueFlag 是否继续 - * @returns 结果对象 - */ - const makeResult = (buildId: string, continueFlag: boolean) => ({ - buildId: continueFlag ? buildId : "", - continueFlag, - }) +enum NEXT_ACTION { + SKIP, + NOTIFY, + ADD_MONITOR, + REMOVE_MONITOR, + NOTIFY_AND_REMOVE_MONITOR, +} +/** + * 获取下一步操作 + * @param {Gitlab.PipelineEvent} pipeline - GitLab 流水线事件对象 + * @param {string | null} [targetStage] - 目标阶段，可选 + * @returns {Promise} - 返回下一步操作的枚举值 + */ +const getNextAction = async ( + pipeline: Gitlab.PipelineEvent, + targetStage?: string | null +): Promise => { // 没有指定Stage则整个流水线成功即为成功 - if (!stage) - return makeResult( - pipeline.builds - .sort((a, b) => - (a.finished_at || "").localeCompare(b.finished_at || "") - )[0] - .id.toString(), - pipeline.object_attributes.status === "success" + if (!targetStage) { + if (pipeline.object_attributes.status === "success") { + return NEXT_ACTION.NOTIFY + } + return NEXT_ACTION.SKIP + } + // 指定了stage，但是流水线非成功状态，删除监控 + if ( + ["failed", "canceled", "skipped"].includes( + pipeline.object_attributes.status ) - // 指定了Stage，该Stage是否全部成功 - const builds = pipeline.builds.filter((build) => build.stage === stage) - // 没有该Stage的构建 - if (builds.length === 0) return makeResult("", false) - // 有该Stage的构建，但不全成功 - if (!builds.every((build) => build.status === "success")) - return makeResult("", false) - // 按finished_at排序，获取最后一个运行的id - const lastId = builds.sort((a, b) => - (a.finished_at || "").localeCompare(b.finished_at || "") - )[0].id - // 该ID的通知是否已经发送过 - const notify = await db.notify.getOne(lastId.toString()) - if (notify) return makeResult("", false) - return makeResult(lastId.toString(), true) + ) { + return NEXT_ACTION.REMOVE_MONITOR + } + // 指定了Stage，且流水线成功了，删除监控并发送通知 + if (pipeline.object_attributes.status === "success") { + return NEXT_ACTION.NOTIFY_AND_REMOVE_MONITOR + } + // 在流水线为`running`时，且该stage全部的job有非结束状态时即`created`、`pending`、`running`、`manual`、`scheduled`时，添加监控 + if (pipeline.object_attributes.status === "running") { + const jobs = await service.gitlab.pipeline.getJobs( + pipeline.project.id, + pipeline.object_attributes.id + ) + if ( + jobs.some( + (job) => + job.stage === targetStage && + !["success", "failed", "canceled", "skipped"].includes(job.status) + ) + ) { + return NEXT_ACTION.ADD_MONITOR + } + } + // 其他情况都跳过 + return NEXT_ACTION.SKIP } /** * 获取合并请求 - * @param pipeline - * @returns + * @param {Gitlab.PipelineEvent} pipeline - GitLab 流水线事件对象 + * @returns {Promise} - 返回合并请求对象或 null */ -const getMergeRequest = async (pipeline: Gitlab.PipelineEvent) => { +const getMergeRequest = async ( + pipeline: Gitlab.PipelineEvent +): Promise => { if (!checkIsMergeCommit(pipeline)) return null const res = await service.gitlab.commit.getMr( pipeline.project.id, @@ -79,14 +91,14 @@ const getMergeRequest = async (pipeline: Gitlab.PipelineEvent) => { /** * 获取用户信息 - * @param pipeline - * @param mergeRequest - * @returns + * @param {Gitlab.PipelineEvent} pipeline - GitLab 流水线事件对象 + * @param {Gitlab.MergeRequest | null} mergeRequest - 合并请求对象或 null + * @returns {{ participant: string, receiver: string[] }} - 返回包含参与者和接收者信息的对象 */ const getUserInfo = ( pipeline: Gitlab.PipelineEvent, mergeRequest: Gitlab.MergeRequest | null -) => { +): { participant: string; receiver: string[] } => { let participant = pipeline.user.name const receiver = [pipeline.user.username] // 有MR且用户不同 @@ -98,39 +110,16 @@ const getUserInfo = ( } /** - * 获取机器人消息 - * @param variable 模板变量 - * @returns + * 生成消息模板变量 + * @param {Gitlab.PipelineEvent} pipeline - GitLab 流水线事件对象 + * @returns {Promise<{ receiver: string[], variable: EggMessage.CardVariable }>} - 返回包含接收者和模板变量的对象 */ -const getRobotMsg = async (variable: EggMessage.CardVariable) => - JSON.stringify({ - type: "template", - data: { - config: { - update_multi: true, - }, - template_id: "ctp_AA36QafWyob2", - template_variable: variable, - }, - }) - -/** - * 发送通知消息 - * @param pipeline - * @param apiKey - * @returns - */ -const sendNotifyMsg = async ( - pipeline: Gitlab.PipelineEvent, - apiKey: string, - params: URLSearchParams -) => { - const { continueFlag, buildId } = await checkIsSuccess( - pipeline, - params.get("stage") - ) - // 只处理成功的CICD - if (!continueFlag) return netTool.ok() +const genCardVariable = async ( + pipeline: Gitlab.PipelineEvent +): Promise<{ + receiver: string[] + variable: EggMessage.CardVariable +}> => { // 获取对应的合并请求 const mergeRequest = await getMergeRequest(pipeline) // 获取用户信息 @@ -156,18 +145,167 @@ const sendNotifyMsg = async ( mr_link: mergeRequest ? mergeRequest.web_url : "", sonar_link: `https://sonarqube.mioffice.cn/dashboard?${sonarParams}`, } + return { + receiver, + variable, + } +} + +/** + * 生成机器人消息 + * @param {EggMessage.CardVariable} variable - 模板变量 + * @returns {string} - 返回生成的机器人消息内容 + */ +const genLarkRobotMsgContent = (variable: EggMessage.CardVariable): string => + JSON.stringify({ + type: "template", + data: { + config: { + update_multi: true, + }, + template_id: "ctp_AA36QafWyob2", + template_variable: variable, + }, + }) + +/** + * 发送提醒消息 + * @param {Gitlab.PipelineEvent} pipeline - 流水线信息 + * @param {string} apiKey - API 密钥 + * @returns {Promise} - 无返回值 + */ +const sendNotify = async ( + pipeline: Gitlab.PipelineEvent, + apiKey: string +): Promise => { + // 获取消息信息 + const { receiver, variable } = await genCardVariable(pipeline) // 获取机器人消息 - const robotMsg = await getRobotMsg(variable) + const robotMsg = genLarkRobotMsgContent(variable) // 发送消息 service.message.byUserIdList(receiver, robotMsg, apiKey) // 记录日志 - await db.notify.create({ ...variable, build_id: buildId }) + await db.notify.create({ ...variable }) +} + +/** + * 添加监控 + * @param {Gitlab.PipelineEvent} pipeline - 流水线信息 + * @param {string} apiKey - API 密钥 + * @param {string} stage - 阶段名称 + * @returns {Promise} - 无返回值 + */ +const addMonitor = async ( + pipeline: Gitlab.PipelineEvent, + apiKey: string, + stage: string +): Promise => { + const monitor = await db.monitor.getOne( + pipeline.project.id.toString(), + pipeline.object_attributes.id.toString(), + stage, + apiKey + ) + if (monitor) return + // 获取消息信息 + const { receiver, variable } = await genCardVariable(pipeline) + await db.monitor.create({ + project_id: pipeline.project.id.toString(), + pipeline_id: pipeline.object_attributes.id.toString(), + stage, + api_key: apiKey, + receiver, + variable, + }) +} + +/** + * 移除监控 + * @param {Gitlab.PipelineEvent} pipeline - 流水线信息 + * @param {string} apiKey - API 密钥 + * @param {string} stage - 阶段名称 + * @returns {Promise} - 无返回值 + */ +const removeMonitor = async ( + pipeline: Gitlab.PipelineEvent, + apiKey: string, + stage: string +): Promise => { + const monitor = await db.monitor.getOne( + pipeline.project.id.toString(), + pipeline.object_attributes.id.toString(), + stage, + apiKey + ) + if (!monitor) return + await db.monitor.del(monitor.id) +} + +/** + * 移除监控并发送提醒消息 + * @param {Gitlab.PipelineEvent} pipeline - 流水线信息 + * @param {string} apiKey - API 密钥 + * @param {string} stage - 阶段名称 + * @returns {Promise} - 无返回值 + */ +const removeMonitorAndNotify = async ( + pipeline: Gitlab.PipelineEvent, + apiKey: string, + stage: string +): Promise => { + const monitor = await db.monitor.getOne( + pipeline.project.id.toString(), + pipeline.object_attributes.id.toString(), + stage, + apiKey + ) + if (!monitor) return + db.monitor.del(monitor.id) + sendNotify(pipeline, apiKey) +} + +/** + * 发送通知消息 + * @param {Gitlab.PipelineEvent} pipeline - GitLab 流水线事件对象 + * @param {string} apiKey - API 密钥 + * @param {URLSearchParams} params - URL 查询参数 + * @returns {Promise} - 返回操作结果 + */ +const manageRawEvent = async ( + pipeline: Gitlab.PipelineEvent, + apiKey: string, + params: URLSearchParams +): Promise => { + // 获取Stage参数 + const stage = params.get("stage") + // 获取下一步操作 + const action = await getNextAction(pipeline, stage) + // 发送通知 + if (action === NEXT_ACTION.NOTIFY) { + sendNotify(pipeline, apiKey) + } + // 添加监控 + if (action === NEXT_ACTION.ADD_MONITOR) { + addMonitor(pipeline, apiKey, stage!) + } + // 删除监控 + if (action === NEXT_ACTION.REMOVE_MONITOR) { + removeMonitor(pipeline, apiKey, stage!) + } + // 删除监控并发送通知 + if (action === NEXT_ACTION.NOTIFY_AND_REMOVE_MONITOR) { + removeMonitorAndNotify(pipeline, apiKey, stage!) + } // 返回成功 return netTool.ok() } +/** + * 管理流水线事件 + */ const managePipelineEvent = { - sendNotifyMsg, + manageRawEvent, + genLarkRobotMsgContent, } export default managePipelineEvent diff --git a/controllers/manageProject/index.ts b/controllers/manageProject/index.ts index 987f11a..7ece550 100644 --- a/controllers/manageProject/index.ts +++ b/controllers/manageProject/index.ts @@ -4,8 +4,10 @@ import { DB } from "../../types/db" /** * 填充项目信息 + * @param {DB.Project} project - 项目对象 + * @returns {Promise} - 返回填充后的项目对象 */ -const fillProj = async (project: DB.Project) => { +const fillProj = async (project: DB.Project): Promise => { const projDetail = await service.gitlab.project.getDetail(project.project_id) if (!projDetail) { return project @@ -22,10 +24,10 @@ const fillProj = async (project: DB.Project) => { } /** - * 获取到当前所有的项目列表 - * 并把信息不全的项目送给fillProj填充内容 + * 获取到当前所有的项目列表，并把信息不全的项目送给 fillProj 填充内容 + * @returns {Promise} - 返回完整的项目列表 */ -const getFullProjList = async () => { +const getFullProjList = async (): Promise => { const fullList = await db.project.getFullList() // 把信息不全的项目送过去填充 const filledProjList = await Promise.all( @@ -38,7 +40,14 @@ const getFullProjList = async () => { return filledFullProjList } -const getFullProjectMap = (fullProjList: DB.Project[]) => { +/** + * 获取完整的项目映射表 + * @param {DB.Project[]} fullProjList - 完整的项目列表 + * @returns {Record} - 返回项目映射表 + */ +const getFullProjectMap = ( + fullProjList: DB.Project[] +): Record => { const fullProjectMap: Record = {} fullProjList.forEach((item) => { fullProjectMap[item.project_id] = item.id diff --git a/controllers/manageRobot/index.ts b/controllers/manageRobot/index.ts index 88e55bc..ad14acc 100644 --- a/controllers/manageRobot/index.ts +++ b/controllers/manageRobot/index.ts @@ -3,6 +3,10 @@ import service from "../../service" import { calculateWeeklyRate } from "../../utils/robotTools" import { getPrevWeekWithYear, getWeekTimeWithYear } from "../../utils/timeTools" +/** + * 获取新的CI/CD状态 + * @returns {Promise<{ has_new_cicd_count: string, without_new_cicd_count: string }>} - 返回包含有新CI/CD和无新CI/CD的项目数量 + */ const getNewCicdStatus = async () => { const fullProjList = await db.project.getFullList() const has_new_cicd_count = String( @@ -21,6 +25,10 @@ const getNewCicdStatus = async () => { } } +/** + * 获取统计信息 + * @returns {Promise} - 返回包含统计信息的对象 + */ const getStatisticsInfo = async () => { const curWeekInfo = await db.view.getFullStatisticsByWeek( getWeekTimeWithYear() @@ -48,6 +56,10 @@ const getStatisticsInfo = async () => { } } +/** + * 获取项目差异信息 + * @returns {Promise} - 返回包含项目差异信息的数组 + */ const getProjDiffInfo = async () => { const curWeekInfo = (await db.view.getProjStatisticsByWeek(getWeekTimeWithYear())) || [] @@ -95,7 +107,7 @@ const getProjDiffInfo = async () => { /** * 获取机器人消息 - * @returns + * @returns {Promise} - 返回机器人消息的JSON字符串 */ const getRobotMsg = async () => JSON.stringify({ @@ -115,7 +127,8 @@ const getRobotMsg = async () => /** * 通过ChatID发送CI报告 - * @param chat_id + * @param {string} chat_id - ChatID + * @returns {Promise} */ const sendCIReportByChatId = async (chat_id: string) => { await service.message.byChatId(chat_id, await getRobotMsg()) @@ -123,7 +136,7 @@ const sendCIReportByChatId = async (chat_id: string) => { /** * 通过定时任务发送CI报告 - * @returns + * @returns {Promise} */ const sendCIReportByCron = async () => await service.message.byGroupId("52usf3w8l6z4vs1", await getRobotMsg()) diff --git a/controllers/manageUser/index.ts b/controllers/manageUser/index.ts index f027f98..3406ccc 100644 --- a/controllers/manageUser/index.ts +++ b/controllers/manageUser/index.ts @@ -1,7 +1,14 @@ import db from "../../db" import { Gitlab } from "../../types/gitlab" -const getFullUserMap = async (fullPipelineList: Gitlab.PipelineDetail[][]) => { +/** + * 获取完整的用户映射表 + * @param {Gitlab.PipelineDetail[][]} fullPipelineList - 完整的pipeline列表 + * @returns {Promise>} - 返回用户映射表 + */ +const getFullUserMap = async ( + fullPipelineList: Gitlab.PipelineDetail[][] +): Promise> => { const userList: Gitlab.User[] = [] fullPipelineList.forEach((fullPipeline) => { fullPipeline.forEach((item) => { diff --git a/db/index.ts b/db/index.ts index 7c59dab..e36b6d6 100644 --- a/db/index.ts +++ b/db/index.ts @@ -1,3 +1,4 @@ +import monitor from "./monitor" import notify from "./notify" import pipeline from "./pipeline" import project from "./project" @@ -10,6 +11,7 @@ const db = { user, view, notify, + monitor, } export default db diff --git a/db/monitor/index.ts b/db/monitor/index.ts new file mode 100644 index 0000000..4a61993 --- /dev/null +++ b/db/monitor/index.ts @@ -0,0 +1,57 @@ +import { DB } from "../../types/db" +import { managePb404 } from "../../utils/pbTools" +import pbClient from "../pbClient" + +/** + * 获取一个监控项 + * @param {string} project_id - 项目ID + * @param {string} pipeline_id - 流水线ID + * @param {string} stage - 阶段 + * @param {string} api_key - API密钥 + * @returns {Promise} - 返回监控项或null + */ +const getOne = ( + project_id: string, + pipeline_id: string, + stage: string, + api_key: string +) => + managePb404(() => + pbClient + .collection("monitor") + .getFirstListItem( + `project_id="${project_id}" && pipeline_id="${pipeline_id}" && stage="${stage}" && api_key="${api_key}"` + ) + ) + +/** + * 获取所有监控项的完整列表 + * @returns {Promise} - 返回监控项的完整列表 + */ +const getFullList = async (): Promise => + await pbClient.collection("monitor").getFullList() + +/** + * 创建一个监控项 + * @param {Partial} data - 监控项数据 + * @returns {Promise} - 返回创建的监控项 + */ +const create = async (data: Partial): Promise => + await pbClient.collection("monitor").create(data) + +/** + * 删除一个监控项 + * @param {string} id - 监控项ID + * @returns {Promise} + */ +const del = async (id: string): Promise => + await pbClient.collection("monitor").delete(id) + +const monitor = { + create, + getOne, + del, + getFullList, +} + +export default monitor diff --git a/db/notify/index.ts b/db/notify/index.ts index 3e7d93b..814cfc9 100644 --- a/db/notify/index.ts +++ b/db/notify/index.ts @@ -1,29 +1,16 @@ import { DB } from "../../types/db" -import { managePb404 } from "../../utils/pbTools" import pbClient from "../pbClient" -/** - * 从数据库检索一个通知。 - * @param id 要检索的通知的ID。 - * @returns 如果找到，返回解析为通知对象的promise；如果未找到，抛出404错误。 - */ -const getOne = (id: string) => - managePb404( - async () => - await pbClient.collection("notify").getFirstListItem(`build_id="${id}"`) - ) - /** * 创建一个新的通知。 - * @param data 新通知的数据。 - * @returns 返回解析为已创建通知对象的promise。 + * @param {Partial} data - 新通知的数据。 + * @returns {Promise} - 返回解析为已创建通知对象的promise。 */ const create = async (data: Partial) => await pbClient.collection("notify").create(data) const notify = { create, - getOne, } export default notify diff --git a/db/pipeline/index.ts b/db/pipeline/index.ts index 2008b67..2bf356a 100644 --- a/db/pipeline/index.ts +++ b/db/pipeline/index.ts @@ -4,34 +4,31 @@ import pbClient from "../pbClient" /** * 通过其 ID 检索一个管道。 - * @param id 管道的 ID。 - * @returns 一个解析为管道对象的 promise。 + * @param {string} id - 管道的 ID。 + * @returns {Promise} - 一个解析为管道对象的 promise。 */ const getOne = (id: string) => - managePb404( - async () => await pbClient.collection("pipeline").getOne(id) - ) + managePb404(() => pbClient.collection("pipeline").getOne(id)) /** * 检索项目的最新管道。 - * @param project_id 项目的 ID。 - * @returns 一个解析为最新管道对象的 promise。 + * @param {string} project_id - 项目的 ID。 + * @returns {Promise} - 一个解析为最新管道对象的 promise。 */ const getLatestOne = (project_id: string) => { - return managePb404( - async () => - await pbClient - .collection("pipeline") - .getFirstListItem(`project_id="${project_id}"`, { - sort: "-created_at", - }) + return managePb404(() => + pbClient + .collection("pipeline") + .getFirstListItem(`project_id="${project_id}"`, { + sort: "-created_at", + }) ) } /** * 创建一个新的管道。 - * @param data 新管道的数据。 - * @returns 一个解析为创建的管道对象的 promise。 + * @param {Partial} data - 新管道的数据。 + * @returns {Promise} - 一个解析为创建的管道对象的 promise。 */ const create = async (data: Partial) => await pbClient.collection("pipeline").create(data) diff --git a/db/project/index.ts b/db/project/index.ts index f2c574b..00b6458 100644 --- a/db/project/index.ts +++ b/db/project/index.ts @@ -4,28 +4,29 @@ import pbClient from "../pbClient" /** * 通过其 ID 检索单个项目。 - * @param id - 项目的 ID。 - * @returns 一个解析为项目对象的 promise。 + * @param {string} id - 项目的 ID。 + * @returns {Promise} - 一个解析为项目对象的 promise。 */ const getOne = (id: string) => - managePb404( - async () => await pbClient.collection("project").getOne(id) - ) + managePb404(() => pbClient.collection("project").getOne(id)) /** * 检索项目的完整列表。 - * @returns 一个解析为项目对象数组的 promise。 + * @returns {Promise} - 一个解析为项目对象数组的 promise。 */ const getFullList = async () => await pbClient.collection("project").getFullList() /** * 使用新数据更新项目。 - * @param id - 要更新的项目的 ID。 - * @param data - 用于更新项目的部分数据。 - * @returns 一个解析为更新后的项目对象的 promise。 + * @param {string} id - 要更新的项目的 ID。 + * @param {Partial} data - 用于更新项目的部分数据。 + * @returns {Promise} - 一个解析为更新后的项目对象的 promise。 */ -const update = async (id: string, data: Partial) => +const update = async ( + id: string, + data: Partial +): Promise => await pbClient.collection("project").update(id, data) /** diff --git a/db/user/index.ts b/db/user/index.ts index 52e8b00..061b143 100644 --- a/db/user/index.ts +++ b/db/user/index.ts @@ -4,32 +4,28 @@ import pbClient from "../pbClient" /** * 根据提供的ID从数据库检索单个用户。 - * @param id 要检索的用户的ID。 - * @returns 如果找到，返回解析为用户对象的promise；如果未找到，抛出404错误。 + * @param {string} id - 要检索的用户的ID。 + * @returns {Promise} - 如果找到，返回解析为用户对象的promise；如果未找到，抛出404错误。 */ const getOne = (id: string) => - managePb404(async () => await pbClient.collection("user").getOne(id)) + managePb404(() => pbClient.collection("user").getOne(id)) /** * 根据提供的用户ID从数据库检索单个用户。 - * @param user_id 要检索的用户的用户ID。 - * @returns 如果找到，返回解析为用户对象的promise；如果未找到，抛出404错误。 + * @param {number} user_id - 要检索的用户的用户ID。 + * @returns {Promise} - 如果找到，返回解析为用户对象的promise；如果未找到，抛出404错误。 */ -const getOneByUserId = (user_id: number) => { - return managePb404( - async () => - await pbClient - .collection("user") - .getFirstListItem(`user_id="${user_id}"`, { - sort: "-created", - }) +const getOneByUserId = (user_id: number) => + managePb404(() => + pbClient.collection("user").getFirstListItem(`user_id="${user_id}"`, { + sort: "-created", + }) ) -} /** * 在数据库中创建一个新用户。 - * @param data 新用户的数据。 - * @returns 返回解析为已创建用户对象的promise。 + * @param {Partial} data - 新用户的数据。 + * @returns {Promise} - 返回解析为已创建用户对象的promise。 */ const create = async (data: Partial) => await pbClient.collection("user").create(data) @@ -38,11 +34,10 @@ const create = async (data: Partial) => * 在数据库中插入或更新一个用户。 * 如果具有相同用户ID的用户已存在，则更新现有用户。 * 如果具有相同用户ID的用户不存在，则创建一个新用户。 - * @param data 要插入或更新的用户数据。 - * @returns 返回解析为插入或更新的用户对象的promise。 - * 如果数据不包含用户ID，则返回null。 + * @param {Partial} data - 要插入或更新的用户数据。 + * @returns {Promise} - 返回解析为插入或更新的用户对象的promise。如果数据不包含用户ID，则返回null。 */ -const upsert = async (data: Partial) => { +const upsert = async (data: Partial): Promise => { if (!data.user_id) return null const userInfo = await getOneByUserId(data.user_id) if (userInfo) return userInfo diff --git a/db/view/index.ts b/db/view/index.ts index fae65b6..ec5fee8 100644 --- a/db/view/index.ts +++ b/db/view/index.ts @@ -4,32 +4,29 @@ import pbClient from "../pbClient" /** * 根据给定的周来检索完整的统计信息。 - * @param week - 需要检索统计信息的周。 - * @returns 一个解析为指定周的完整统计信息的promise。 + * @param {string} week - 需要检索统计信息的周。 + * @returns {Promise} - 一个解析为指定周的完整统计信息的promise。 */ -const getFullStatisticsByWeek = (week: string) => { - return managePb404( - async () => - await pbClient - .collection("statisticsPerWeek") - .getFirstListItem(`week="${week}"`) +const getFullStatisticsByWeek = (week: string) => + managePb404(() => + pbClient.collection("statisticsPerWeek").getFirstListItem(`week="${week}"`) ) -} /** * 根据给定的周来检索项目统计信息。 - * @param week - 需要检索统计信息的周。 - * @returns 一个解析为指定周的项目统计信息数组的promise。 + * @param {string} week - 需要检索统计信息的周。 + * @returns {Promise} - 一个解析为指定周的项目统计信息数组的promise。 */ -const getProjStatisticsByWeek = (week: string) => { - return managePb404( - async () => - await pbClient - .collection("statisticsPerProj") - .getFullList({ filter: `week="${week}"` }) +const getProjStatisticsByWeek = (week: string) => + managePb404(() => + pbClient + .collection("statisticsPerProj") + .getFullList({ filter: `week="${week}"` }) ) -} +/** + * 提供与视图相关的数据库操作。 + */ const view = { getFullStatisticsByWeek, getProjStatisticsByWeek, diff --git a/package.json b/package.json index 09f5ec3..b727c31 100644 --- a/package.json +++ b/package.json @@ -38,6 +38,7 @@ "lodash": "^4.17.21", "moment": "^2.30.1", "node-schedule": "^2.1.1", + "p-limit": "^6.1.0", "pocketbase": "^0.21.1" } } \ No newline at end of file diff --git a/readme.md b/readme.md index 4a8f3f3..fb58f09 100644 --- a/readme.md +++ b/readme.md @@ -19,7 +19,16 @@ 组织卡片信息，给 Commit的用户以及 可能的 MR发起者发送通知 ## 处理在中间Stage需要提醒的情况 -在stage全部成功的情况下，按finish_at时间排序，找到最后一个stage，如果stage的状态是成功，且该build的id没有发送过通知，则发送通知 + +~~在stage全部成功的情况下，按finish_at时间排序，找到最后一个stage，如果stage的状态是成功，且该build的id没有发送过通知，则发送通知~~ + +流水线通知只是在Pipeline纬度上，所以某个stage的变化不会触发通知 + +在流水线为`running`时，如果需要监听Stage，且该stage全部的job有非结束状态时即`created`、`pending`、`running`、`manual`、`scheduled`时 + +加入数据库监控列表，每10s检查一次，如果stage状态全部成功的时候则发送通知，并删除监控 + +在流水线结束，即状态为`failed`、`canceled`、`skipped`、`success`，的时候，删除监控，并在状态为`success`的时候，发送通知 # 数据库表信息 diff --git a/routes/ci/index.ts b/routes/ci/index.ts index ea471ef..9cd1727 100644 --- a/routes/ci/index.ts +++ b/routes/ci/index.ts @@ -3,10 +3,10 @@ import netTool from "../../service/netTool" /** * 处理管理CI监视器的请求。 - * @param req - 请求对象。 - * @returns 响应对象。 + * @param {Request} req - 请求对象。 + * @returns {Response} - 响应对象。 */ -export const manageCIMonitorReq = (req: Request) => { +export const manageCIMonitorReq = (req: Request): Response => { const url = new URL(req.url) const chat_id = url.searchParams.get("chat_id") if (!chat_id) return netTool.badRequest("chat_id is required!") diff --git a/routes/event/index.ts b/routes/event/index.ts index b75970b..6344e05 100644 --- a/routes/event/index.ts +++ b/routes/event/index.ts @@ -4,10 +4,10 @@ import { Gitlab } from "../../types/gitlab" /** * 处理管理Gitlab事件的请求。 - * @param req - 请求对象。 - * @returns 响应对象。 + * @param {Request} req - 请求对象。 + * @returns {Promise} - 响应对象。 */ -export const manageGitlabEventReq = async (req: Request) => { +export const manageGitlabEventReq = async (req: Request): Promise => { const apiKey = req.headers.get("x-gitlab-token") if (!apiKey) return netTool.badRequest("x-gitlab-token is required!") const eventType = req.headers.get("x-gitlab-event") @@ -15,7 +15,7 @@ export const manageGitlabEventReq = async (req: Request) => { if (eventType === "Pipeline Hook") { const body = (await req.json()) as Gitlab.PipelineEvent const params = new URLSearchParams(req.url.split("?")[1]) - return managePipelineEvent.sendNotifyMsg(body, apiKey, params) + return managePipelineEvent.manageRawEvent(body, apiKey, params) } return netTool.ok() } diff --git a/schedule/index.ts b/schedule/index.ts index 1af9c6d..adbfa25 100644 --- a/schedule/index.ts +++ b/schedule/index.ts @@ -1,15 +1,20 @@ import { scheduleJob } from "node-schedule" import manageRobot from "../controllers/manageRobot" -import syncPipLine from "./syncPipLine" +import monitorJob from "./monitorJob" +import syncPipeLine from "./syncPipeLine" const initSchedule = async () => { // 每周五早上10点发送CI报告 scheduleJob("0 10 * * 5", manageRobot.sendCIReportByCron) // 每15分钟同步一次CI数据 - scheduleJob("*/15 * * * *", syncPipLine) + scheduleJob("*/15 * * * *", syncPipeLine) + // 每10秒执行一次监控任务 + scheduleJob("*/10 * * * * *", monitorJob) // 立即同步一次 - syncPipLine() + syncPipeLine() + // 立即执行一次监控任务 + monitorJob() } export default initSchedule diff --git a/schedule/monitorJob.ts b/schedule/monitorJob.ts new file mode 100644 index 0000000..880dfef --- /dev/null +++ b/schedule/monitorJob.ts @@ -0,0 +1,84 @@ +import pLimit from "p-limit" + +import managePipelineEvent from "../controllers/managePipelineEvent" +import db from "../db" +import service from "../service" +import { DB } from "../types/db" +import { sec2minStr } from "../utils/timeTools" + +/** + * 执行监控任务 + * @param {DB.Monitor} monitor - 监控项 + * @returns {Promise} + */ +const doMonitor = async (monitor: DB.Monitor): Promise => { + const { project_id, pipeline_id, api_key, stage, receiver, variable } = + monitor + // 获取Job列表 + const jobList = await service.gitlab.pipeline.getJobs( + Number(project_id), + Number(pipeline_id) + ) + // 是否所有Stage关联的Job都成功了 + const isAllSuccess = jobList.every( + (job) => job.stage === stage && job.status === "success" + ) + // 没全部成功跳过 + if (!isAllSuccess) return + // 先删除监控 + await db.monitor.del(monitor.id) + // 获取最新的执行时长 + const pipelineDetail = await service.gitlab.pipeline.getDetail( + Number(project_id), + Number(pipeline_id) + ) + if (pipelineDetail) { + variable["duration"] = sec2minStr(pipelineDetail.duration) + } + // 获取机器人消息 + const robotMsg = managePipelineEvent.genLarkRobotMsgContent(variable) + // 发送消息 + await service.message.byUserIdList(receiver, robotMsg, api_key) + // 记录日志 + await db.notify.create({ ...variable }) +} + +/** + * 移除超过24小时的监控项 + * @async + * @function removeOverTimeMonitor + * @returns {Promise} 无返回值 + * @description 该函数从数据库中获取所有监控项，并移除创建时间超过24小时的监控项。 + */ +const removeOverTimeMonitor = async (): Promise => { + const fullMonitorList = await db.monitor.getFullList() + const now = Date.now() + await Promise.all( + fullMonitorList.map(async (monitor) => { + const createdAtTimestamp = new Date(monitor.created_at).getTime() + if (now - createdAtTimestamp > 24 * 60 * 60 * 1000) { + await db.monitor.del(monitor.id) + } + }) + ) +} + +/** + * 监控任务的主函数 + * @returns {Promise} + */ +const monitorJob = async (): Promise => { + // 获取全部监控项 + const fullMonitorList = await db.monitor.getFullList() + if (fullMonitorList.length === 0) return + // 并发限制 + const limit = pLimit(3) + // 并发处理 + await Promise.all( + fullMonitorList.map((monitor) => limit(() => doMonitor(monitor))) + ) + // 移除超过24小时的监控项 + await removeOverTimeMonitor() +} + +export default monitorJob diff --git a/schedule/syncPipLine.ts b/schedule/syncPipeLine.ts similarity index 59% rename from schedule/syncPipLine.ts rename to schedule/syncPipeLine.ts index 8b7bc57..2aee567 100644 --- a/schedule/syncPipLine.ts +++ b/schedule/syncPipeLine.ts @@ -2,7 +2,17 @@ import managePipeline from "../controllers/managePipeLine" import manageProject from "../controllers/manageProject" import manageUser from "../controllers/manageUser" -const syncPipLine = async () => { +/** + * 同步管道函数 + * + * 该函数首先获取完整的项目列表，然后获取每个项目的完整管道列表。 + * 接着，它获取完整的用户映射和项目映射，最后将这些数据插入到管道列表中。 + * + * @async + * @function syncPipLine + * @returns {Promise} 不返回任何内容 + */ +const syncPipeLine = async (): Promise => { const fullProjList = await manageProject.getFullProjList() const fullPipelineList = await Promise.all( fullProjList.map((v) => managePipeline.getFullPipelineList(v)) @@ -16,4 +26,4 @@ const syncPipLine = async () => { ) } -export default syncPipLine +export default syncPipeLine diff --git a/script/pipline/jobs.json b/script/pipline/jobs.json new file mode 100644 index 0000000..58de391 --- /dev/null +++ b/script/pipline/jobs.json @@ -0,0 +1,181 @@ +[ + { + "id": 25820911, + "status": "running", + "stage": "deploy", + "name": "DEPLOY_STAGING", + "ref": "staging", + "tag": false, + "coverage": null, + "allow_failure": false, + "created_at": "2024-08-08T16:19:15.798+08:00", + "started_at": "2024-08-08T16:19:21.461+08:00", + "finished_at": null, + "duration": 19.551757848, + "queued_duration": 5.623183, + "user": { + "id": 10011, + "username": "zhaoyingbo", + "name": "赵英博", + "state": "active", + "avatar_url": "https://git.n.xiaomi.com/uploads/-/system/user/avatar/10011/avatar.png", + "web_url": "https://git.n.xiaomi.com/zhaoyingbo", + "created_at": "2020-08-24T19:34:30.822+08:00", + "bio": "", + "location": "", + "public_email": "zhaoyingbo@live.cn", + "skype": "", + "linkedin": "", + "twitter": "", + "website_url": "", + "organization": "", + "job_title": "", + "pronouns": null, + "bot": false, + "work_information": null, + "followers": 0, + "following": 0, + "bio_html": "" + }, + "commit": { + "id": "748dfce35d9f04c2da3ddde2f68f1c0b9a7f751f", + "short_id": "748dfce3", + "created_at": "2024-08-08T14:52:03.000+08:00", + "parent_ids": [ + "cbbdf145bd5fbc631803bd9243bc4bdf8a6fa959", + "156d2b1c527f01976ce1b122452e8be1c8b5b199" + ], + "title": "Merge branch 'feature/modelService-ApprovalDeletion' into staging", + "message": "Merge branch 'feature/modelService-ApprovalDeletion' into staging\n", + "author_name": "jiangtong", + "author_email": "jiangtong@xiaomi.com", + "authored_date": "2024-08-08T14:52:03.000+08:00", + "committer_name": "jiangtong", + "committer_email": "jiangtong@xiaomi.com", + "committed_date": "2024-08-08T14:52:03.000+08:00", + "trailers": {}, + "web_url": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/commit/748dfce35d9f04c2da3ddde2f68f1c0b9a7f751f" + }, + "pipeline": { + "id": 8936993, + "project_id": 139032, + "sha": "748dfce35d9f04c2da3ddde2f68f1c0b9a7f751f", + "ref": "staging", + "status": "running", + "source": "push", + "created_at": "2024-08-08T14:52:11.425+08:00", + "updated_at": "2024-08-08T16:19:16.880+08:00", + "web_url": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/pipelines/8936993" + }, + "web_url": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/jobs/25820911", + "artifacts": [], + "runner": { + "id": 9134, + "description": "cloudml-fe-bj", + "ip_address": "10.142.18.13", + "active": true, + "is_shared": false, + "runner_type": "group_type", + "name": "gitlab-runner", + "online": true, + "status": "online" + }, + "artifacts_expire_at": null, + "tag_list": [ + "cloudml-fe-bj" + ] + }, + { + "id": 25815806, + "status": "success", + "stage": "sonar_scan", + "name": "SONAR_SCAN", + "ref": "staging", + "tag": false, + "coverage": null, + "allow_failure": true, + "created_at": "2024-08-08T14:52:11.564+08:00", + "started_at": "2024-08-08T14:54:57.403+08:00", + "finished_at": "2024-08-08T14:57:57.990+08:00", + "duration": 180.587239, + "queued_duration": 6.876928, + "user": { + "id": 18608, + "username": "jiangtong", + "name": "姜通", + "state": "active", + "avatar_url": "https://git.n.xiaomi.com/uploads/-/system/user/avatar/18608/avatar.png", + "web_url": "https://git.n.xiaomi.com/jiangtong", + "created_at": "2021-12-09T12:43:41.266+08:00", + "bio": "", + "location": "", + "public_email": "", + "skype": "", + "linkedin": "", + "twitter": "", + "website_url": "", + "organization": "", + "job_title": "", + "pronouns": null, + "bot": false, + "work_information": null, + "followers": 0, + "following": 0, + "bio_html": "" + }, + "commit": { + "id": "748dfce35d9f04c2da3ddde2f68f1c0b9a7f751f", + "short_id": "748dfce3", + "created_at": "2024-08-08T14:52:03.000+08:00", + "parent_ids": [ + "cbbdf145bd5fbc631803bd9243bc4bdf8a6fa959", + "156d2b1c527f01976ce1b122452e8be1c8b5b199" + ], + "title": "Merge branch 'feature/modelService-ApprovalDeletion' into staging", + "message": "Merge branch 'feature/modelService-ApprovalDeletion' into staging\n", + "author_name": "jiangtong", + "author_email": "jiangtong@xiaomi.com", + "authored_date": "2024-08-08T14:52:03.000+08:00", + "committer_name": "jiangtong", + "committer_email": "jiangtong@xiaomi.com", + "committed_date": "2024-08-08T14:52:03.000+08:00", + "trailers": {}, + "web_url": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/commit/748dfce35d9f04c2da3ddde2f68f1c0b9a7f751f" + }, + "pipeline": { + "id": 8936993, + "project_id": 139032, + "sha": "748dfce35d9f04c2da3ddde2f68f1c0b9a7f751f", + "ref": "staging", + "status": "running", + "source": "push", + "created_at": "2024-08-08T14:52:11.425+08:00", + "updated_at": "2024-08-08T16:19:16.880+08:00", + "web_url": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/pipelines/8936993" + }, + "web_url": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/jobs/25815806", + "artifacts": [ + { + "file_type": "trace", + "size": 57859, + "filename": "job.log", + "file_format": null + } + ], + "runner": { + "id": 9134, + "description": "cloudml-fe-bj", + "ip_address": "10.142.18.13", + "active": true, + "is_shared": false, + "runner_type": "group_type", + "name": "gitlab-runner", + "online": true, + "status": "online" + }, + "artifacts_expire_at": null, + "tag_list": [ + "cloudml-fe-bj" + ] + } +] \ No newline at end of file diff --git a/service/gitlab/badge.ts b/service/gitlab/badge.ts index 64e93d8..07e7423 100644 --- a/service/gitlab/badge.ts +++ b/service/gitlab/badge.ts @@ -11,10 +11,10 @@ export type BadgeSetParams = Omit & { /** * 为特定项目检索 GitLab 徽章。 - * @param project_id 项目的 ID。 - * @returns 一个承诺，解析为 GitLab 徽章的数组。 + * @param {number} project_id - 项目的 ID。 + * @returns {Promise} 一个承诺，解析为 GitLab 徽章的数组。 */ -const get = async (project_id: number) => { +const get = async (project_id: number): Promise => { const URL = `${GITLAB_BASE_URL}/projects/${project_id}/badges` return gitlabReqWarp( () => netTool.get(URL, {}, GITLAB_AUTH_HEADER), @@ -24,10 +24,10 @@ const get = async (project_id: number) => { /** * 设置 GitLab 徽章。 - * @param badge 徽章参数。 - * @returns 一个承诺，解析为更新后的徽章。 + * @param {BadgeSetParams} badge - 徽章参数。 + * @returns {Promise} 一个承诺，解析为更新后的徽章。 */ -const set = async (badge: BadgeSetParams) => { +const set = async (badge: BadgeSetParams): Promise => { const URL = `${GITLAB_BASE_URL}/projects/${badge.id}/badges/${badge.badge_id}` return gitlabReqWarp( () => netTool.put(URL, badge, {}, GITLAB_AUTH_HEADER), @@ -37,10 +37,10 @@ const set = async (badge: BadgeSetParams) => { /** * 添加 GitLab 徽章。 - * @param badge 徽章参数。 - * @returns 一个承诺，解析为添加的徽章。 + * @param {BadgeSetParams} badge - 徽章参数。 + * @returns {Promise} 一个承诺，解析为添加的徽章。 */ -const add = async (badge: BadgeSetParams) => { +const add = async (badge: BadgeSetParams): Promise => { const URL = `${GITLAB_BASE_URL}/projects/${badge.id}/badges` return gitlabReqWarp( () => netTool.post(URL, badge, {}, GITLAB_AUTH_HEADER), diff --git a/service/gitlab/commit.ts b/service/gitlab/commit.ts index ff794ec..4e14532 100644 --- a/service/gitlab/commit.ts +++ b/service/gitlab/commit.ts @@ -4,11 +4,14 @@ import { GITLAB_AUTH_HEADER, GITLAB_BASE_URL, gitlabReqWarp } from "./tools" /** * 检索与特定提交关联的合并请求。 - * @param project_id - 项目的ID。 - * @param sha - 提交的SHA。 - * @returns 一个解析为合并请求数组的promise。 + * @param {number} project_id - 项目的ID。 + * @param {string} sha - 提交的SHA。 + * @returns {Promise} 一个解析为合并请求数组的promise。 */ -const getMr = async (project_id: number, sha: string) => { +const getMr = async ( + project_id: number, + sha: string +): Promise => { const URL = `${GITLAB_BASE_URL}/projects/${project_id}/repository/commits/${sha}/merge_requests` return gitlabReqWarp( () => netTool.get(URL, {}, GITLAB_AUTH_HEADER), diff --git a/service/gitlab/pipeline.ts b/service/gitlab/pipeline.ts index e83c4f5..273d6ae 100644 --- a/service/gitlab/pipeline.ts +++ b/service/gitlab/pipeline.ts @@ -4,15 +4,14 @@ import { GITLAB_AUTH_HEADER, GITLAB_BASE_URL, gitlabReqWarp } from "./tools" /** * 获取特定GitLab流水线的详细信息。 - * @param project_id - 项目的ID。 - * @param pipeline_id - 流水线的ID。 - * @param created_at - 流水线的创建日期。 - * @returns 一个解析为流水线详细信息的promise。 + * @param {number} project_id - 项目的ID。 + * @param {number} pipeline_id - 流水线的ID。 + * @param {string} created_at - 流水线的创建日期。 */ const getDetail = async ( project_id: number, pipeline_id: number, - created_at: string + created_at?: string ) => { const URL = `${GITLAB_BASE_URL}/projects/${project_id}/pipelines/${pipeline_id}` const res = await gitlabReqWarp( @@ -25,11 +24,14 @@ const getDetail = async ( /** * 获取特定项目的GitLab流水线列表。 - * @param project_id - 项目的ID。 - * @param page - 结果的页码（默认值：1）。 - * @returns 一个解析为流水线数组的promise。 + * @param {number} project_id - 项目的ID。 + * @param {number} [page=1] - 结果的页码（默认值：1）。 + * @returns {Promise} 一个解析为流水线数组的promise。 */ -const getList = async (project_id: number, page = 1) => { +const getList = async ( + project_id: number, + page = 1 +): Promise => { const URL = `${GITLAB_BASE_URL}/projects/${project_id}/pipelines` const params = { scope: "finished", per_page: 100, page } return gitlabReqWarp( @@ -38,9 +40,27 @@ const getList = async (project_id: number, page = 1) => { ) } +/** + * 获取特定GitLab流水线的任务列表。 + * @param {number} project_id - 项目的ID。 + * @param {number} pipeline_id - 流水线的ID。 + * @returns {Promise} 一个解析为任务数组的promise。 + */ +const getJobs = async ( + project_id: number, + pipeline_id: number +): Promise => { + const URL = `${GITLAB_BASE_URL}/projects/${project_id}/pipelines/${pipeline_id}/jobs` + return gitlabReqWarp( + () => netTool.get(URL, {}, GITLAB_AUTH_HEADER), + [] + ) +} + const pipeline = { getDetail, getList, + getJobs, } export default pipeline diff --git a/service/gitlab/project.ts b/service/gitlab/project.ts index 243709a..7e61529 100644 --- a/service/gitlab/project.ts +++ b/service/gitlab/project.ts @@ -4,10 +4,12 @@ import { GITLAB_AUTH_HEADER, GITLAB_BASE_URL, gitlabReqWarp } from "./tools" /** * 获取 GitLab 项目的详细信息。 - * @param project_id - 项目的 ID 或 URL-encoded 路径。 - * @returns 一个解析为项目详细信息的 promise。 + * @param {number | string} project_id - 项目的 ID 或 URL-encoded 路径。 + * @returns {Promise} 一个解析为项目详细信息的 promise。 */ -const getDetail = async (project_id: number | string) => { +const getDetail = async ( + project_id: number | string +): Promise => { if (typeof project_id === "string") project_id = encodeURIComponent(project_id) const URL = `${GITLAB_BASE_URL}/projects/${project_id}` diff --git a/service/gitlab/tools.ts b/service/gitlab/tools.ts index 470763c..3424b95 100644 --- a/service/gitlab/tools.ts +++ b/service/gitlab/tools.ts @@ -1,5 +1,12 @@ import { Gitlab } from "../../types/gitlab" +/** + * 包装一个 GitLab 请求函数，处理错误并返回默认值。 + * @template T + * @param {() => Promise} func - 要执行的请求函数。 + * @param {any} default_value - 请求失败时返回的默认值。 + * @returns {Promise} 一个解析为请求结果或默认值的 promise。 + */ export const gitlabReqWarp = async ( func: () => Promise, default_value: any @@ -14,6 +21,14 @@ export const gitlabReqWarp = async ( } } +/** + * GitLab API 的基础 URL。 + * @type {string} + */ export const GITLAB_BASE_URL = "https://git.n.xiaomi.com/api/v4" +/** + * GitLab API 的认证头。 + * @type {object} + */ export const GITLAB_AUTH_HEADER = { "PRIVATE-TOKEN": "Zd1UASPcMwVox5tNS6ep" } diff --git a/service/message/index.ts b/service/message/index.ts index b582523..7543eea 100644 --- a/service/message/index.ts +++ b/service/message/index.ts @@ -3,7 +3,12 @@ import netTool from "../netTool" const API_KEY = "1dfz4wlpbbgiky0" const URL = "https://lark-egg.ai.xiaomi.com/message" -const message = async (body: any) => { +/** + * 发送消息到指定的 URL。 + * @param {object} body - 消息体。 + * @returns {Promise} 一个解析为响应的 promise。 + */ +const message = async (body: any): Promise => { try { const res = await netTool.post(URL, { api_key: API_KEY, @@ -15,7 +20,13 @@ const message = async (body: any) => { } } -message.byGroupId = async (group_id: string, content: string) => { +/** + * 通过群组 ID 发送消息。 + * @param {string} group_id - 群组 ID。 + * @param {string} content - 消息内容。 + * @returns {Promise} 一个解析为响应的 promise。 + */ +message.byGroupId = async (group_id: string, content: string): Promise => { return message({ group_id, msg_type: "interactive", @@ -23,7 +34,13 @@ message.byGroupId = async (group_id: string, content: string) => { }) } -message.byChatId = async (chat_id: string, content: string) => { +/** + * 通过聊天 ID 发送消息。 + * @param {string} chat_id - 聊天 ID。 + * @param {string} content - 消息内容。 + * @returns {Promise} 一个解析为响应的 promise。 + */ +message.byChatId = async (chat_id: string, content: string): Promise => { return message({ receive_id: chat_id, receive_id_type: "chat_id", @@ -32,7 +49,13 @@ message.byChatId = async (chat_id: string, content: string) => { }) } -message.byUserId = async (user_id: string, content: string) => { +/** + * 通过用户 ID 发送消息。 + * @param {string} user_id - 用户 ID。 + * @param {string} content - 消息内容。 + * @returns {Promise} 一个解析为响应的 promise。 + */ +message.byUserId = async (user_id: string, content: string): Promise => { return message({ receive_id: user_id, receive_id_type: "user_id", @@ -41,11 +64,18 @@ message.byUserId = async (user_id: string, content: string) => { }) } +/** + * 通过用户 ID 列表发送消息。 + * @param {string[]} user_id_list - 用户 ID 列表。 + * @param {string} content - 消息内容。 + * @param {string} [api_key] - 可选的 API 密钥。 + * @returns {Promise} 一个解析为响应的 promise。 + */ message.byUserIdList = async ( user_id_list: string[], content: string, api_key?: string -) => { +): Promise => { return message({ receive_id: user_id_list.join(","), receive_id_type: "user_id", diff --git a/service/netTool.ts b/service/netTool.ts index 082a37f..e059f9b 100644 --- a/service/netTool.ts +++ b/service/netTool.ts @@ -8,12 +8,12 @@ interface NetRequestParams { /** * 记录响应详情并返回响应日志对象。 - * @param response - 响应对象。 - * @param method - 请求使用的HTTP方法。 - * @param headers - 请求头。 - * @param requestBody - 请求体。 - * @param responseBody - 响应体。 - * @returns 响应日志对象。 + * @param {Response} response - 响应对象。 + * @param {string} method - 请求使用的HTTP方法。 + * @param {any} headers - 请求头。 + * @param {any} requestBody - 请求体。 + * @param {any} responseBody - 响应体。 + * @returns {object} 响应日志对象。 */ const logResponse = ( response: Response, @@ -39,12 +39,8 @@ const logResponse = ( /** * 发送网络请求并返回一个解析为响应数据的Promise。 - * @param url - 要发送请求的URL。 - * @param method - 请求使用的HTTP方法。 - * @param queryParams - 要包含在URL中的查询参数。 - * @param payload - 请求的有效负载数据。 - * @param additionalHeaders - 要包含在请求中的附加头。 - * @returns 一个解析为响应数据的Promise。 + * @param {NetRequestParams} params - 请求参数对象。 + * @returns {Promise} 一个解析为响应数据的Promise。 * @throws 如果网络响应不成功或存在解析错误，则抛出错误。 */ const netTool = async ({ @@ -109,10 +105,10 @@ const netTool = async ({ /** * 发送GET请求并返回一个解析为响应数据的Promise。 * - * @param url - 要发送请求的URL。 - * @param queryParams - 要包含在URL中的查询参数。 - * @param additionalHeaders - 要包含在请求中的附加头。 - * @returns 一个解析为响应数据的Promise。 + * @param {string} url - 要发送请求的URL。 + * @param {any} [queryParams] - 要包含在URL中的查询参数。 + * @param {any} [additionalHeaders] - 要包含在请求中的附加头。 + * @returns {Promise} 一个解析为响应数据的Promise。 */ netTool.get = ( url: string, @@ -123,11 +119,11 @@ netTool.get = ( /** * 发送POST请求并返回一个解析为响应数据的Promise。 * - * @param url - 要发送请求的URL。 - * @param payload - 请求的有效负载数据。 - * @param queryParams - 要包含在URL中的查询参数。 - * @param additionalHeaders - 要包含在请求中的附加头。 - * @returns 一个解析为响应数据的Promise。 + * @param {string} url - 要发送请求的URL。 + * @param {any} [payload] - 请求的有效负载数据。 + * @param {any} [queryParams] - 要包含在URL中的查询参数。 + * @param {any} [additionalHeaders] - 要包含在请求中的附加头。 + * @returns {Promise} 一个解析为响应数据的Promise。 */ netTool.post = ( url: string, @@ -140,11 +136,11 @@ netTool.post = ( /** * 发送PUT请求并返回一个解析为响应数据的Promise。 * - * @param url - 要发送请求的URL。 - * @param payload - 请求的有效负载数据。 - * @param queryParams - 要包含在URL中的查询参数。 - * @param additionalHeaders - 要包含在请求中的附加头。 - * @returns 一个解析为响应数据的Promise。 + * @param {string} url - 要发送请求的URL。 + * @param {any} payload - 请求的有效负载数据。 + * @param {any} [queryParams] - 要包含在URL中的查询参数。 + * @param {any} [additionalHeaders] - 要包含在请求中的附加头。 + * @returns {Promise} 一个解析为响应数据的Promise。 */ netTool.put = ( url: string, @@ -157,11 +153,11 @@ netTool.put = ( /** * 发送DELETE请求并返回一个解析为响应数据的Promise。 * - * @param url - 要发送请求的URL。 - * @param payload - 请求的有效负载数据。 - * @param queryParams - 要包含在URL中的查询参数。 - * @param additionalHeaders - 要包含在请求中的附加头。 - * @returns 一个解析为响应数据的Promise。 + * @param {string} url - 要发送请求的URL。 + * @param {any} payload - 请求的有效负载数据。 + * @param {any} [queryParams] - 要包含在URL中的查询参数。 + * @param {any} [additionalHeaders] - 要包含在请求中的附加头。 + * @returns {Promise} 一个解析为响应数据的Promise。 */ netTool.del = ( url: string, @@ -174,11 +170,11 @@ netTool.del = ( /** * 发送PATCH请求并返回一个解析为响应数据的Promise。 * - * @param url - 要发送请求的URL。 - * @param payload - 请求的有效负载数据。 - * @param queryParams - 要包含在URL中的查询参数。 - * @param additionalHeaders - 要包含在请求中的附加头。 - * @returns 一个解析为响应数据的Promise。 + * @param {string} url - 要发送请求的URL。 + * @param {any} payload - 请求的有效负载数据。 + * @param {any} [queryParams] - 要包含在URL中的查询参数。 + * @param {any} [additionalHeaders] - 要包含在请求中的附加头。 + * @returns {Promise} 一个解析为响应数据的Promise。 */ netTool.patch = ( url: string, @@ -191,9 +187,9 @@ netTool.patch = ( /** * 创建一个表示400 Bad Request的响应对象。 * - * @param msg - 错误消息。 - * @param requestId - 请求ID。 - * @returns 一个表示400 Bad Request的响应对象。 + * @param {string} msg - 错误消息。 + * @param {string} [requestId] - 请求ID。 + * @returns {Response} 一个表示400 Bad Request的响应对象。 */ netTool.badRequest = (msg: string, requestId?: string) => Response.json({ code: 400, msg, requestId }, { status: 400 }) @@ -201,9 +197,9 @@ netTool.badRequest = (msg: string, requestId?: string) => /** * 创建一个表示404 Not Found的响应对象。 * - * @param msg - 错误消息。 - * @param requestId - 请求ID。 - * @returns 一个表示404 Not Found的响应对象。 + * @param {string} msg - 错误消息。 + * @param {string} [requestId] - 请求ID。 + * @returns {Response} 一个表示404 Not Found的响应对象。 */ netTool.notFound = (msg: string, requestId?: string) => Response.json({ code: 404, msg, requestId }, { status: 404 }) @@ -211,10 +207,10 @@ netTool.notFound = (msg: string, requestId?: string) => /** * 创建一个表示500 Internal Server Error的响应对象。 * - * @param msg - 错误消息。 - * @param data - 错误数据。 - * @param requestId - 请求ID。 - * @returns 一个表示500 Internal Server Error的响应对象。 + * @param {string} msg - 错误消息。 + * @param {any} [data] - 错误数据。 + * @param {string} [requestId] - 请求ID。 + * @returns {Response} 一个表示500 Internal Server Error的响应对象。 */ netTool.serverError = (msg: string, data?: any, requestId?: string) => Response.json({ code: 500, msg, data, requestId }, { status: 500 }) @@ -222,9 +218,9 @@ netTool.serverError = (msg: string, data?: any, requestId?: string) => /** * 创建一个表示200 OK的响应对象。 * - * @param data - 响应数据。 - * @param requestId - 请求ID。 - * @returns 一个表示200 OK的响应对象。 + * @param {any} [data] - 响应数据。 + * @param {string} [requestId] - 请求ID。 + * @returns {Response} 一个表示200 OK的响应对象。 */ netTool.ok = (data?: any, requestId?: string) => Response.json({ code: 0, msg: "success", data, requestId }) diff --git a/types/db.ts b/types/db.ts index 2a215a2..a33b630 100644 --- a/types/db.ts +++ b/types/db.ts @@ -52,7 +52,14 @@ export namespace DB { ref: string } - export interface Notify extends RecordModel, EggMessage.CardVariable { - build_id: string + export type Notify = RecordModel & EggMessage.CardVariable + + export interface Monitor extends RecordModel { + project_id: string + pipeline_id: string + stage: string + receiver: string[] + api_key: string + variable: EggMessage.CardVariable } } diff --git a/types/gitlab.ts b/types/gitlab.ts index b9f32d3..6535915 100644 --- a/types/gitlab.ts +++ b/types/gitlab.ts @@ -154,6 +154,12 @@ export namespace Gitlab { web_url: string } + /* 任务 */ + export interface Job { + status: string + stage: string + } + /* 徽章 */ export interface Badge { /** diff --git a/utils/pathTools.ts b/utils/pathTools.ts index 6253f7c..aebd26f 100644 --- a/utils/pathTools.ts +++ b/utils/pathTools.ts @@ -1,12 +1,26 @@ +/** + * 创建一个路径检查工具，用于精确匹配和前缀匹配路径。 + * @param {string} url - 要检查的基础 URL。 + * @param {string} [prefix] - 可选的路径前缀。 + * @returns {object} 包含路径检查方法的对象。 + */ export const makeCheckPathTool = (url: string, prefix?: string) => { const { pathname } = new URL(url) const makePath = (path: string) => `${prefix || ""}${path}` return { - // 精确匹配 + /** + * 检查路径是否与基础 URL 的路径精确匹配。 + * @param {string} path - 要检查的路径。 + * @returns {boolean} 如果路径精确匹配则返回 true，否则返回 false。 + */ exactCheck: (path: string) => { return pathname === makePath(path) }, - // 前缀匹配 + /** + * 检查路径是否以基础 URL 的路径为前缀。 + * @param {string} path - 要检查的路径。 + * @returns {boolean} 如果路径以基础 URL 的路径为前缀则返回 true，否则返回 false。 + */ startsWithCheck: (path: string) => pathname.startsWith(makePath(path)), } } diff --git a/utils/pbTools.ts b/utils/pbTools.ts index ce6f962..5fc3de0 100644 --- a/utils/pbTools.ts +++ b/utils/pbTools.ts @@ -1,3 +1,12 @@ +/** + * 管理数据库函数的 404 错误。 + * 如果捕获到特定的 "The requested resource wasn't found." 错误消息，则返回 null。 + * 否则，重新抛出错误。 + * + * @template T + * @param {() => Promise} dbFunc - 要执行的数据库函数。 + * @returns {Promise} 一个解析为数据库函数结果或 null 的 promise。 + */ export const managePb404 = async ( dbFunc: () => Promise ): Promise => { diff --git a/utils/robotTools.ts b/utils/robotTools.ts index 1d152d8..b01aa99 100644 --- a/utils/robotTools.ts +++ b/utils/robotTools.ts @@ -1,7 +1,8 @@ /** * 计算百分比变化 - * @param a - * @param b + * @param {number} cur - 当前值。 + * @param {number} prev - 之前的值。 + * @returns {{ diff: number, percentage: string }} 包含差值和百分比变化的对象。 */ export const calculatePercentageChange = (cur: number, prev: number) => { // 计算差值 @@ -24,9 +25,10 @@ export const calculatePercentageChange = (cur: number, prev: number) => { /** * 计算周同比 - * @param cur - * @param prev - * @param needCN + * @param {string | number} cur - 当前值。 + * @param {string | number} prev - 之前的值。 + * @param {boolean} [needCN=true] - 是否需要中文描述。 + * @returns {{ text: string, diff: number, percentage: string }} 包含描述文本、差值和百分比变化的对象。 */ export const calculateWeeklyRate = ( cur: string | number, diff --git a/utils/timeTools.ts b/utils/timeTools.ts index 9552cdc..2056761 100644 --- a/utils/timeTools.ts +++ b/utils/timeTools.ts @@ -1,30 +1,36 @@ import moment from "moment" /** - * 获取今天是今年的第几周，like 2024-05 + * 获取今天是今年的第几周，格式为 YYYY-WW。 + * @returns {string} 今天是今年的第几周。 */ -export const getWeekTimeWithYear = () => { +export const getWeekTimeWithYear = (): string => { return moment().format("YYYY-WW") } /** - * 获取上周是今年的第几周，like 2024-04 + * 获取上周是今年的第几周，格式为 YYYY-WW。 + * @returns {string} 上周是今年的第几周。 */ -export const getPrevWeekWithYear = () => { +export const getPrevWeekWithYear = (): string => { return moment().subtract(1, "weeks").format("YYYY-WW") } /** - * 秒转分钟，保留一位小数 + * 将秒数转换为分钟，保留一位小数。 + * @param {number} sec - 秒数。 + * @returns {string} 转换后的分钟数，保留一位小数。 */ -export const sec2min = (sec: number) => { +export const sec2min = (sec: number): string => { return (sec / 60).toFixed(1) } /** - * 秒转分钟，格式为 1m 30s + * 将秒数转换为分钟和秒数，格式为 Xm Ys。 + * @param {number} sec - 秒数。 + * @returns {string} 转换后的分钟和秒数，格式为 Xm Ys。 */ -export const sec2minStr = (sec: number) => { +export const sec2minStr = (sec: number): string => { const min = Math.floor(sec / 60) const s = sec % 60 return `${min}m ${s}s`