Code Search este un instrument care își propune să le faciliteze dezvoltatorilor navigarea prin baze de coduri uriașe, folosind o interfață sofisticată care oferă sugestii de căutare instantanee. Dezvoltat la Centrul de Inginerie Bosch din Cluj, în ultimii patru ani, și lansat în producție de la începutul anului 2023, acest index global îmbunătățește eficiența dezvoltatorilor printr-un ciclu rapid de explorare a codului. Deși componentele de bază au fost create de un singur inginer, trecerea de la zero linii de cod la prezentări la nivel de VP și lansarea globală au fost posibile doar cu sprijinul multor persoane din cadrul companiei. Astăzi, Code Search este utilizat de angajați din cincisprezece țări.
În timp ce contribuie la un proiect software, dezvoltatorii trebuie frecvent să acceseze baza globală de cunoștințe pentru a răspunde la diverse întrebări. Accesul la un instrument care le permite să caute exemple de cod în câteva milisecunde este un avantaj semnificativ, considerat standard în companiile de software cu performanțe de top, precum Google, Meta, Uber, Mozilla și Stripe, printre altele. Înainte de Code Search nu se putea căuta în tipare precise de cod la scară largă, deoarece nici Bitbucket, nici GitHub Enterprise nu oferă capabilități de căutare regex (chiar și interogările literale simple precum "function()" nu ar funcționa din cauza modului în care aceste platforme gestionează tokenizarea). De asemenea, căutările simbolice bazate pe extragerea semantică în timpul indexării nu sunt posibile în aceste servicii de găzduire a codului.
În esență, proiectul Code Search încearcă să rezolve două probleme:
Problema navigării absolute > Căutarea și navigarea: Unde? Ce? Cum?
Unde este localizată o anumită bucată de cod?
Câte instanțe ale unui pattern sunt prezente într-un repozitoriu sau în mai multe repozitorii?
Ce fișiere conțin o anumită versiune a unei dependențe?
Problema navigării relative > Răspunsul la întrebări despre cod cu un singur clic: De ce? Cine și când?
Cum este utilizat un simbol sau cine apelează această funcție?
Code Search cuprinde trei componente principale:
Un motor de pattern matching de înaltă performanță care permite utilizatorilor să efectueze aproape instantaneu căutări cu regex în corpusuri mari de cod sursă.
Un sistem de indexare care ne permite să extragem informații simbolice precise pentru aproape orice limbaj.
Performanța este tratată ca element esențial.
Pagina cu rezultatele căutării
Primul prototip utilizabil pentru Code Search a fost dezvoltat în mai puțin de zece săptămâni, bazându-ne inițial pe biblioteci terțe pentru a gestiona părți ale procesului de indexare și căutare. De exemplu, am folosit google/zoekt pentru a gestiona expresiile regulate și PostgreSQL (cu suport pentru indexul RUM ) pentru a stoca și a gestiona căutările peste identificatorii de simboluri. Cu toate acestea, acum aproximativ un an, am ajuns la concluzia că este necesar să controlăm întregul sistem de sus până jos pentru a debloca următoarea etapă în performanță și utilizabilitate. Astfel, versiunea actuală a Code Search este liberă de orice dependințe terțe care afectează calea critică. Nu mai există glue code între diverse subsisteme care sunt scrise în limbaje diferite. 99% din backend este un monolit scris într-un singur limbaj de programare. Acum controlăm întregul flow - de la clicul utilizatorului până la modul în care motorul de căutare preia datele de pe disc, modul în care fișierul de index este organizat în memorie și cum sunt generate liniile de context ale rezultatelor de căutare.
Datorită acestui efort, acum suntem utilizatori fericiți ai unuia dintre cele mai rapide motoare de căutare cu expresii regulate, optimizat special pentru cod. De exemplu, căutările literale și regex pe întregul kernel Linux (37M LOC) durează cel mult 100ms pe un hardware foarte modest (o interogare de tipul /TODO|FIXME/ -file:/.c$/ limit:500 se finalizează în mai puțin de 15ms).
Folosește cineva această metodă? Putem să o deprecăm?
Utilizăm un sistem pe niveluri pentru a sprijini repozitoriile interne în funcție de nevoile lor. Pentru repozitoriile Tier 1, integrăm informații la nivel de compilator pentru a oferi o navigare asemănătoare unui IDE direct în browser. Utilizăm Kythe pentru a realiza acest lucru. Pentru miile de repozitorii Tier 2, folosim simbolurile extrase de ctags și tree-sitter pentru a sprijini navigarea aproximativă. Utilizările simbolurilor sunt recuperate utilizând filtrul de căutare is:call.
Simbolurile sunt stocate într-un index unificat care servește căutărilor după cale, conținut și identificatori semantici.
Abilitatea de a naviga rapid prin codul global al companiei accelerează înțelegerea și încurajează reutilizarea, sporind în cele din urmă productivitatea generală. Procesul de integrare a noilor ingineri devine mult mai rapid, deoarece nu mai este nevoie să aștepte ca IDE-urile să genereze indexurile la pornire - Code Search este întotdeauna la un tab distanță. Pentru o inițiere și mai rapidă a dezvoltatorilor, echipele pot partaja link-uri canonice către diferite părți ale proiectelor lor, ca o primă trecere peste componentele majore.
Deoarece experiența utilizatorului este concepută mai degrabă pentru citire decât pentru scrierea de cod, putem defini mai clar semnificația fiecărei acțiuni efectuate de utilizator.
Această fundație tehnologică deschide calea pentru instrumente avansate care ne vor permite să extragem informații valoroase din codul companiei noastre. Proiectul Code Search nu mai este realizat de o singură persoană și lucrăm cu sârguință pentru a extinde utilitatea acestui instrument în trei direcții:
Indexare exhaustivă - Cu cât indexăm mai mult cod, cu atât Code Search devine mai valoros. Un alt obiectiv al acestei arhitecturi a fost indexarea eficientă a repozitoriilor la mai multe versiuni. De exemplu, indexarea golang/go la 'master^HEAD', 'commit:e3f3083' și 'branch:dev/cc'.
Instrumente de raportare - Indexarea multi-revizie permite dezvoltarea unor instrumente valoroase de raportare, cum ar fi: - Reprezentați grafic numărul de TODO-uri din acest repozitoriu între aceste puncte din istoric. - Monitorizarea progresului tranziției de la lib:A la lib:B prin reprezentarea grafică a utilizării acestora. - Am deprecat acest API, să vedem cât de repede s-au adaptat proiectele și au trecut la noul API recomandat. - Deja descoperim aspecte care nu au fost niciodată evidențiate explicit de la începutul găzduirii interne a codului nostru.
Pe măsură ce Code Search continuă să evolueze, obiectivul nostru rămâne același: să oferim dezvoltatorilor acces instant și intuitiv la codul de care au nevoie. Ceea ce a început ca un proiect mic a crescut într-un instrument global, redefinind modul în care inginerii Bosch navighează și înțeleg bazele de cod.
Dacă sunteți interesați de sisteme optimizate pentru performanță, ne-ar plăcea să vă auzim părerile.
de Ovidiu Mățan
de Ioana Barboș
