ci: custom panic free audit tool #294

YassinEldeeb · 2024-01-08T03:49:24Z

helps with #291

pattern detection: Identify and count patterns like panic!(), unreachable!(), todo!(), unimplemented!(), array indexing, and expect() calls, which we wish to minimize as possible.
workspace toml: use the workspace toml to detect the files to audit and the files to exclude.
expected annotations: provide a way to specify a call as expected to remove it from the audit warnings, and flag it as an FYI in the audit report.
report generation: generate the report as markdown and push it to under a PR comment.
cleanup: don't override the comment for k6 performance, and don't post crates with zero panic audit issues

github-actions · 2024-01-08T04:17:24Z

✅ Benchmark Results

     data_received..................: 62 MB   776 kB/s
     data_sent......................: 98 MB   1.2 MB/s
     http_req_blocked...............: avg=2.37µs  min=732ns    med=1.97µs  max=13.84ms  p(90)=2.25µs  p(95)=2.45µs 
     http_req_connecting............: avg=173ns   min=0s       med=0s      max=13.79ms  p(90)=0s      p(95)=0s     
   ✓ http_req_duration..............: avg=27.31ms min=766.18µs med=26.73ms max=126.53ms p(90)=43.71ms p(95)=50.01ms
       { expected_response:true }...: avg=27.31ms min=766.18µs med=26.73ms max=126.53ms p(90)=43.71ms p(95)=50.01ms
   ✓ http_req_failed................: 0.00%   ✓ 0           ✗ 255506
     http_req_receiving.............: avg=31.29µs min=9.56µs   med=25.51µs max=17.65ms  p(90)=38µs    p(95)=41.84µs
     http_req_sending...............: avg=15.09µs min=4.87µs   med=11.16µs max=24.48ms  p(90)=13.63µs p(95)=21.16µs
     http_req_tls_handshaking.......: avg=0s      min=0s       med=0s      max=0s       p(90)=0s      p(95)=0s     
     http_req_waiting...............: avg=27.26ms min=731.16µs med=26.69ms max=126.49ms p(90)=43.66ms p(95)=49.94ms
     http_reqs......................: 255506  3193.788919/s
     iteration_duration.............: avg=27.41ms min=837.25µs med=26.83ms max=126.62ms p(90)=43.81ms p(95)=50.11ms
     iterations.....................: 255506  3193.788919/s
   ✓ valid_graphql_response.........: 100.00% ✓ 255506      ✗ 0     
   ✓ valid_http_code................: 100.00% ✓ 255506      ✗ 0     
     vus............................: 1       min=1         max=100 
     vus_max........................: 100     min=100       max=100

.github/workflows/ci.yaml

dotansimha

LGTM. I pushed some fixes

github-actions · 2024-01-08T07:33:55Z

🚨 Rust Panic Audit: 136 Potential Panic Points Detected 🚨

Crate: `vrl`

📊 Total Usages: 37

🚨 panic usages: 1
🔢 array_index usages: 3
🎁 unwrap usages: 32
🔎 expect usages: 1

Crate: `jwt_auth`

📊 Total Usages: 31

🎁 unwrap usages: 29
🔢 array_index usages: 2

Crate: `config`

📊 Total Usages: 14

🎁 unwrap usages: 8
🚨 panic usages: 3
🔎 expect usages: 3

Crate: `common`

📊 Total Usages: 12

🎁 unwrap usages: 12

Crate: `cors`

📊 Total Usages: 11

🎁 unwrap usages: 11

Crate: `engine`

📊 Total Usages: 10

🔢 array_index usages: 1
🚨 panic usages: 1
🎁 unwrap usages: 8

Crate: `cloudflare_worker`

📊 Total Usages: 8

🎁 unwrap usages: 8

Crate: `persisted_documents`

📊 Total Usages: 4

🔎 expect usages: 4

Crate: `conductor`

📊 Total Usages: 3

🔎 expect usages: 2
🚨 panic usages: 1

Crate: `graphiql`

📊 Total Usages: 3

🎁 unwrap usages: 3

Crate: `http_get`

📊 Total Usages: 1

🎁 unwrap usages: 1

Crate: `disable_introspection`

📊 Total Usages: 1

🚨 panic usages: 1

Crate: `napi`

📊 Total Usages: 1

🚨 panic usages: 1

Crate: `server`

📊 Total Usages: 0

Crate: `wasm_polyfills`

📊 Total Usages: 0

Crate: `match_content_type`

📊 Total Usages: 0

Co-authored-by: Dotan Simha <[email protected]> hmmm ok getting there with the Layers ok getting there with the plugin ok ok using latest deps now OK adjustments ok ok getting there ok use otel semantic convention for graphql jeager works, also otlp ok ok zipkin works fixes, added datadog added batch fix config handle shutdown make it work on WASM runtime doin some testin ok added some tests try stuff

Co-authored-by: Dotan Simha <[email protected]> hmmm ok getting there with the Layers ok getting there with the plugin ok ok using latest deps now OK adjustments ok ok getting there ok use otel semantic convention for graphql jeager works, also otlp ok ok zipkin works fixes, added datadog added batch fix config handle shutdown make it work on WASM runtime doin some testin ok added some tests try stuff ok try something ok try try try something ok getting there getting there maybe like this adjustments fix something else ok one more time try more finally

Co-authored-by: Dotan Simha <[email protected]> hmmm ok getting there with the Layers ok getting there with the plugin ok ok using latest deps now OK adjustments ok ok getting there ok use otel semantic convention for graphql jeager works, also otlp ok ok zipkin works fixes, added datadog added batch fix config handle shutdown make it work on WASM runtime doin some testin ok added some tests try stuff ok try something ok try try try something ok getting there getting there maybe like this adjustments fix something else ok one more time try more finally try something

Co-authored-by: Dotan Simha <[email protected]> hmmm ok getting there with the Layers ok getting there with the plugin ok ok using latest deps now OK adjustments ok ok getting there ok use otel semantic convention for graphql jeager works, also otlp ok ok zipkin works fixes, added datadog added batch fix config handle shutdown make it work on WASM runtime doin some testin ok added some tests try stuff ok try something ok try try try something ok getting there getting there maybe like this adjustments fix something else ok one more time try more finally try something ok fix try ok we need the sleep

Co-authored-by: Dotan Simha <[email protected]> hmmm ok getting there with the Layers ok getting there with the plugin ok ok using latest deps now OK adjustments ok ok getting there ok use otel semantic convention for graphql jeager works, also otlp ok ok zipkin works fixes, added datadog added batch fix config handle shutdown make it work on WASM runtime doin some testin ok added some tests try stuff ok try something ok try try try something ok getting there getting there maybe like this adjustments fix something else ok one more time try more finally try something ok fix try ok we need the sleep update config

Co-authored-by: Dotan Simha <[email protected]> hmmm ok getting there with the Layers ok getting there with the plugin ok ok using latest deps now OK adjustments ok ok getting there ok use otel semantic convention for graphql jeager works, also otlp ok ok zipkin works fixes, added datadog added batch fix config handle shutdown make it work on WASM runtime doin some testin ok added some tests try stuff ok try something ok try try try something ok getting there getting there maybe like this adjustments fix something else ok one more time try more finally try something ok fix try ok we need the sleep update config try maybe this will work test wasm works now ok better logger now fix zipkin missing http client ok i can compile wasm now fix try

YassinEldeeb added 2 commits January 8, 2024 03:29

conductor vscode extension

3b6fc68

feat: panic free audit

f52c182

YassinEldeeb changed the title ~~ci: panic free audit~~ ci: panic free audit tool Jan 8, 2024

YassinEldeeb requested a review from dotansimha January 8, 2024 03:50

YassinEldeeb added 2 commits January 8, 2024 05:50

cleanup vsc stuff

fa03e80

switch to commonjs

7e7f0f0

YassinEldeeb changed the title ~~ci: panic free audit tool~~ ci: custom panic free audit tool Jan 8, 2024

YassinEldeeb added 7 commits January 8, 2024 06:02

fix script

cc19784

import http

24e7095

fix http import

7fdd5ce

fix import

f57e025

switch to axios

5290929

setup pnpm

f94481b

edit content to be posted

4b1ef84

dotansimha reviewed Jan 8, 2024

View reviewed changes

.github/workflows/ci.yaml Outdated Show resolved Hide resolved

some fixes

1ef5bc3

dotansimha approved these changes Jan 8, 2024

View reviewed changes

the-guild-org deleted a comment from github-actions bot Jan 8, 2024

dotansimha merged commit e3080a5 into master Jan 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: custom panic free audit tool #294

ci: custom panic free audit tool #294

YassinEldeeb commented Jan 8, 2024 •

edited by dotansimha

Loading

github-actions bot commented Jan 8, 2024 •

edited

Loading

dotansimha left a comment

github-actions bot commented Jan 8, 2024

ci: custom panic free audit tool #294

ci: custom panic free audit tool #294

Conversation

YassinEldeeb commented Jan 8, 2024 • edited by dotansimha Loading

github-actions bot commented Jan 8, 2024 • edited Loading

✅ Benchmark Results

dotansimha left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 8, 2024

🚨 Rust Panic Audit: 136 Potential Panic Points Detected 🚨

Crate: vrl

Crate: jwt_auth

Crate: config

Crate: common

Crate: cors

Crate: engine

Crate: cloudflare_worker

Crate: persisted_documents

Crate: conductor

Crate: graphiql

Crate: http_get

Crate: disable_introspection

Crate: napi

Crate: server

Crate: wasm_polyfills

Crate: match_content_type

YassinEldeeb commented Jan 8, 2024 •

edited by dotansimha

Loading

github-actions bot commented Jan 8, 2024 •

edited

Loading

Crate: `vrl`

Crate: `jwt_auth`

Crate: `config`

Crate: `common`

Crate: `cors`

Crate: `engine`

Crate: `cloudflare_worker`

Crate: `persisted_documents`

Crate: `conductor`

Crate: `graphiql`

Crate: `http_get`

Crate: `disable_introspection`

Crate: `napi`

Crate: `server`

Crate: `wasm_polyfills`

Crate: `match_content_type`