simple vrl primitive for config #439

dotansimha · 2024-02-12T09:59:13Z

closes #222

so we can still use VrlConfigReference and just do .program() to quickly compile it as part of the plugin creation process.

github-actions · 2024-02-12T09:59:43Z

🚨 Rust Panic Audit: 86 Potential Panic Points Detected 🚨

Crate: `federation_query_planner`

📊 Total Usages: 50

🔎 expect usages: 8
🚨 panic u 8000 sages: 3
🔢 array_index usages: 10
🎁 unwrap usages: 29

Crate: `engine`

📊 Total Usages: 11

🎁 unwrap usages: 7
🔎 expect usages: 1
🚨 panic usages: 3

Crate: `telemetry`

📊 Total Usages: 9

🎁 unwrap usages: 4
🔢 array_index usages: 5

Crate: `cloudflare_worker`

📊 Total Usages: 6

🚨 panic usages: 1
🎁 unwrap usages: 5

Crate: `tracing`

📊 Total Usages: 6

🎁 unwrap usages: 5
🔎 expect usages: 1

Crate: `conductor`

📊 Total Usages: 3

🔎 expect usages: 1
🎁 unwrap usages: 1
🚨 panic usages: 1

Crate: `config`

📊 Total Usages: 1

🚨 panic usages: 1

📌 Expected Annotations

Crate: `engine`

📊 Total Expected Usages: 5

expand details

Reason: "if we are unable to construct the endpoints and attach them onto the gateway's http server, we have to exit"

Code: Err(e) => panic!("failed to construct endpoint: {:?}", e),
Location: ./libs/engine/src/gateway.rs:145

Reason: "we can safely index here, it's inside a test with constant defined fixtures."

Code: ConductorGateway::execute(request, &gw.routes[0].route_data).await
Location: ./libs/engine/src/gateway.rs:177

Reason: "without a fetcher, there's no executor, without an executor, there's no gateway."

Code: panic!("Failed while initializing the executor's fetcher for Federation source");
Location: ./libs/engine/src/source/federation_source.rs:109

Reason: "without a fetcher, there's no executor, without an executor, there's no gateway."

Code: panic!("Failed while initializing the executor's fetcher for Federation source");
Location: ./libs/engine/src/source/federation_source.rs:140

Reason: "without a fetcher, there's no executor, without an executor, there's no gateway."

Code: panic!(
Location: ./libs/engine/src/source/graphql_source.rs:30

Crate: `vrl`

📊 Total Expected Usages: 2

expand details

Reason: "if the provided VRL code in the config file can't compile, we have to exit."

Code: panic!("failed to compile vrl program");
Location: ./plugins/vrl/src/plugin.rs:122

Reason: "states is a non-user provided variable"

Code: .expect("can't merge states when states is an empty vector!")
Location: ./plugins/vrl/src/plugin.rs:139

Crate: `napi`

📊 Total Expected Usages: 1

expand details

Reason: "we need this"

Code: panic!("Exited process!")
Location: ./libs/napi/src/lib.rs:18

Crate: `common`

📊 Total Expected Usages: 1

expand details

Reason: "we're parsing a statically defined constant, we know it works ;)"

Code: .unwrap()
Location: ./libs/common/src/graphql.rs:23

Crate: `conductor`

📊 Total Expected Usages: 2

expand details

Reason: "we need to exit the process, if the logger can't be correctly set."

Code: tracing::subscriber::set_global_default(subscriber).expect("failed to set up tracing");
Location: ./bin/conductor/src/lib.rs:37

Reason: "we need to exit the process, if the provided configuration file is incorrect."

Code: panic!("Failed to initialize gateway: {:?}", e);
Location: ./bin/conductor/src/lib.rs:75

Crate: `cloudflare_worker`

📊 Total Expected Usages: 4

expand details

Reason: "it panics only if the header name is not valid, and we know it is."

Code: .unwrap()
Location: ./bin/cloudflare_worker/src/http_tracing.rs:20

Reason: "it panics only if the URL source is not valid, and it's already validated before."

Code: let url = req.url().unwrap();
Location: ./bin/cloudflare_worker/src/http_tracing.rs:23

Reason: "it only panics if we are not running in a CF context, should be safe."

Code: let cf_info = req.cf().unwrap();
Location: ./bin/cloudflare_worker/src/http_tracing.rs:27

Reason: "unwraps only in special cases where "data:text" is used."

Code: let http_host = url.host().unwrap().to_string();
Location: ./bin/cloudflare_worker/src/http_tracing.rs:36

Crate: `jwt_auth`

📊 Total Expected Usages: 1

expand details

Reason: "if initiating an http client fails, then we have to exit."

Code: let client = wasm_polyfills::create_http_client().build().unwrap();
Location: ./plugins/jwt_auth/src/jwks_provider.rs:49

Crate: `config`

📊 Total Expected Usages: 9

expand details

Reason: "statically defined regex pattern, we know it works ;)"

Code: .unwrap();
Location: ./libs/config/src/interpolate.rs:18

Reason: "👇"

Code: let raw_contents = read_to_string(file_path)
Location: ./libs/config/src/lib.rs:576

Reason: "👇"

Code: panic!("Failed to interpolate config file, please resolve the above errors");
Location: ./libs/config/src/lib.rs:608

Reason: "👇"

Code: parse_config_from_json(&config_string).expect("Failed to parse JSON config file")
Location: ./libs/config/src/lib.rs:615

Reason: "👇"

Code: parse_config_from_yaml(&config_string).expect("Failed to parse YAML config file")
Location: ./libs/config/src/lib.rs:619

Reason: "👇"

Code: _ => panic!("Unsupported config file extension"),
Location: ./libs/config/src/lib.rs:636

Reason: "👇"

Code: None => panic!("Config file has no extension"),
Location: ./libs/config/src/lib.rs:639

Reason: "part of development docgen CLI"

Code: .expect("Failed to serialize json schema for config file!");
Location: ./libs/config/src/generate-json-schema.rs:50

Reason: "part of development docgen CLI"

Code: .expect("Failed to write the json schema to the file system!");
Location: ./libs/config/src/generate-json-schema.rs:54

github-actions · 2024-02-12T10:07:53Z

🐋 This PR was built and pushed to the following Docker images:

Docker Bake metadata

{
"conductor": {
  "containerimage.config.digest": "sha256:9bada02a160e6c48b5dd211c237af07dfa3e696dc016d727df01b68ac951e722",
  "containerimage.descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.v2+json",
    "digest": "sha256:4b8fa656c1302da89f0dffeda3c662a273160fc6d68974183604d8856a35d7b6",
    "size": 902,
    "platform": {
      "architecture": "amd64",
      "os": "linux"
    }
  },
  "containerimage.digest": "sha256:4b8fa656c1302da89f0dffeda3c662a273160fc6d68974183604d8856a35d7b6",
  "image.name": "ghcr.io/the-guild-org/conductor/conductor:545ea4d1b01565f784f50529c6e00b8ed7f04b72"
}
}

github-actions · 2024-02-12T10:08:13Z

✅ Benchmark Results

     data_received..................: 13 MB   221 kB/s
     data_sent......................: 22 MB   363 kB/s
     http_req_blocked...............: min=1.26µs   avg=3.18µs   med=2.36µs   max=835.36µs p(95)=3.48µs   p(99)=12.76µs 
     http_req_connecting............: min=0s       avg=384ns    med=0s       max=768.95µs p(95)=0s       p(99)=0s      
     http_req_duration..............: min=304.8µs  avg=416.17µs med=390.85µs max=15.2ms   p(95)=511.17µs p(99)=608.57µs
       { expected_response:true }...: min=304.8µs  avg=416.17µs med=390.85µs max=15.2ms   p(95)=511.17µs p(99)=608.57µs
     ✓ { scenario:rps_1000 }........: min=304.8µs  avg=416.17µs med=390.85µs max=15.2ms   p(95)=511.17µs p(99)=608.57µs
     http_req_failed................: 0.00%   ✓ 0         ✗ 60001
     ✓ { scenario:rps_1000 }........: 0.00%   ✓ 0         ✗ 60001
     http_req_receiving.............: min=10.67µs  avg=27.08µs  med=26.11µs  max=1.07ms   p(95)=35.94µs  p(99)=46.03µs 
     http_req_sending...............: min=6.8µs    avg=15.63µs  med=14.23µs  max=2.22ms   p(95)=23.84µs  p(99)=35.84µs 
     http_req_tls_handshaking.......: min=0s       avg=0s       med=0s       max=0s       p(95)=0s       p(99)=0s      
     http_req_waiting...............: min=276.56µs avg=373.45µs med=349.51µs max=15.14ms  p(95)=465.29µs p(99)=560.23µs
     http_reqs......................: 60001   999.99717/s
     ✓ { scenario:rps_1000 }........: 60001   999.99717/s
     iteration_duration.............: min=387.6µs  avg=509.07µs med=480.63µs max=15.46ms  p(95)=609.16µs p(99)=756.88µs
     iterations.....................: 60001   999.99717/s
     ✓ { scenario:rps_1000 }........: 60001   999.99717/s
     valid_graphql_response.........: 100.00% ✓ 60001     ✗ 0    
     ✓ { scenario:rps_1000 }........: 100.00% ✓ 60001     ✗ 0    
     valid_http_code................: 100.00% ✓ 60001     ✗ 0    
     ✓ { scenario:rps_1000 }........: 100.00% ✓ 60001     ✗ 0    
     vus............................: 1       min=0       max=2  
     vus_max........................: 200     min=200     max=200

simple vrl primitive for config

daf30a6

ok

545ea4d

dotansimha merged commit b57026f into master Feb 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

simple vrl primitive for config #439

simple vrl primitive for config #439

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

simple vrl primitive for config #439

simple vrl primitive for config #439

Uh oh!

Conversation

Uh oh!

Uh oh!

Uh oh!

🚨 Rust Panic Audit: 86 Potential Panic Points Detected 🚨

Crate: federation_query_planner

Crate: engine

Crate: telemetry

Crate: cloudflare_worker

Crate: tracing

Crate: conductor

Crate: config

📌 Expected Annotations

Crate: engine

Crate: vrl

Crate: napi

Crate: common

Crate: conductor

Crate: cloudflare_worker

Crate: jwt_auth

Crate: config

Uh oh!

Uh oh!

Uh oh!

Uh oh!

✅ Benchmark Results

Uh oh!

Uh oh!

Crate: `federation_query_planner`

Crate: `engine`

Crate: `telemetry`

Crate: `cloudflare_worker`

Crate: `tracing`

Crate: `conductor`

Crate: `config`

Crate: `engine`

Crate: `vrl`

Crate: `napi`

Crate: `common`

Crate: `conductor`

Crate: `cloudflare_worker`

Crate: `jwt_auth`

Crate: `config`