hive-console-sdk 0.3.14

Rust SDK for Hive Console
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
use async_dropper_simple::{AsyncDrop, AsyncDropper};
use graphql_tools::parser::schema::Document;
use recloser::AsyncRecloser;
use reqwest_middleware::ClientWithMiddleware;
use std::{
    collections::{hash_map::Entry, BTreeMap, HashMap},
    sync::Arc,
    time::Duration,
};
use thiserror::Error;
use tokio_util::sync::CancellationToken;

use crate::expressions::lib::FromVrlValue;
use crate::{
    agent::{buffer::AddStatus, utils::OperationProcessor},
    expressions::ExecutableProgram,
};
use crate::{
    agent::{buffer::Buffer, builder::UsageAgentBuilder},
    expressions::values::boolean::BooleanConversionError,
};
use vrl::{compiler::Program as VrlProgram, core::Value as VrlValue, value::KeyString};

#[derive(Debug, Clone, Default)]
pub enum OperationType {
    #[default]
    Query,
    Mutation,
    Subscription,
}

#[derive(Debug, Default, Clone)]
pub struct ExecutionReport {
    pub schema: Arc<Document<'static, String>>,
    pub client_name: Option<String>,
    pub client_version: Option<String>,
    pub timestamp: u64,
    pub duration: Duration,
    pub ok: bool,
    pub errors: usize,
    pub operation_body: String,
    pub operation_name: Option<String>,
    pub operation_type: Option<OperationType>,
    pub persisted_document_hash: Option<String>,
}

typify::import_types!(schema = "./usage-report-v2.schema.json");

pub struct UsageAgentInner {
    pub(crate) endpoint: String,
    pub(crate) buffer: Buffer<ExecutionReport>,
    pub(crate) processor: OperationProcessor,
    pub(crate) client: ClientWithMiddleware,
    pub(crate) flush_interval: Duration,
    pub(crate) circuit_breaker: AsyncRecloser,
    pub(crate) exclude_expression: Option<VrlProgram>,
}

pub fn non_empty_string(value: Option<String>) -> Option<String> {
    value.filter(|str| !str.is_empty())
}

#[derive(Error, Debug)]
pub enum AgentError {
    #[error("unable to acquire lock: {0}")]
    Lock(String),
    #[error("unable to send report: unauthorized")]
    Unauthorized,
    #[error("unable to send report: no access")]
    Forbidden,
    #[error("unable to send report: rate limited")]
    RateLimited,
    #[error("missing token")]
    MissingToken,
    #[error("your access token requires providing a 'target_id' option.")]
    MissingTargetId,
    #[error("using 'target_id' with legacy tokens is not supported")]
    TargetIdWithLegacyToken,
    #[error("invalid token provided")]
    InvalidToken,
    #[error(
        "invalid target id provided: {0}, it should be either a slug like \"$organizationSlug/$projectSlug/$targetSlug\" or an UUID"
    )]
    InvalidTargetId(String),
    #[error("unable to instantiate the http client for reports sending: {0}")]
    HTTPClientCreationError(reqwest::Error),
    #[error("unable to create circuit breaker: {0}")]
    CircuitBreakerCreationError(#[from] crate::circuit_breaker::CircuitBreakerError),
    #[error("rejected by the circuit breaker")]
    CircuitBreakerRejected,
    #[error("unable to send report: {0}")]
    Unknown(String),
    #[error("failed to compile exclude expression: {0}")]
    ExcludeExpressionCompileError(#[from] crate::expressions::ExpressionCompileError),
    #[error("failed to execute exclude expression: {0}")]
    ExcludeExpressionExecutionError(#[from] crate::expressions::ExpressionExecutionError),
    #[error("failed to convert exclude expression result to boolean: {0}")]
    ExcludeExpressionResultConversionError(#[from] BooleanConversionError),
}

pub type UsageAgent = Arc<AsyncDropper<UsageAgentInner>>;

#[async_trait::async_trait]
pub trait UsageAgentExt {
    fn builder() -> UsageAgentBuilder {
        UsageAgentBuilder::default()
    }
    async fn flush(&self) -> Result<(), AgentError>;
    async fn start_flush_interval(&self, token: &CancellationToken);
    /// Deprecated: use [`add_report_with_request`] instead.
    /// This method will be removed in a future version major.
    #[deprecated(note = "use `add_report_with_request` instead")]
    async fn add_report(&self, execution_report: ExecutionReport) -> Result<(), AgentError>;

    async fn add_report_with_request(
        &self,
        execution_report: ExecutionReport,
        request: Option<RequestDetails>,
    ) -> Result<(), AgentError>;
}

impl UsageAgentInner {
    fn produce_report(&self, reports: Vec<ExecutionReport>) -> Result<Report, AgentError> {
        let mut report = Report {
            size: 0,
            map: HashMap::new(),
            operations: Vec::new(),
            subscription_operations: Vec::new(),
        };

        // iterate over reports and check if they are valid
        for op in reports {
            let operation = self.processor.process(&op.operation_body, &op.schema);
            match operation {
                Err(e) => {
                    tracing::warn!(
                        "Dropping operation \"{}\" (phase: PROCESSING): {}",
                        op.operation_name
                            .clone()
                            .or_else(|| Some("anonymous".to_string()))
                            .unwrap(),
                        e
                    );
                    continue;
                }
                Ok(operation) => match operation {
                    Some(operation) => {
                        let hash = operation.hash;

                        let client_name = non_empty_string(op.client_name);
                        let client_version = non_empty_string(op.client_version);

                        let metadata: Option<Metadata> =
                            if client_name.is_some() || client_version.is_some() {
                                Some(Metadata {
                                    client: Some(Client {
                                        name: client_name.unwrap_or_default(),
                                        version: client_version.unwrap_or_default(),
                                    }),
                                })
                            } else {
                                None
                            };
                        report.operations.push(RequestOperation {
                            operation_map_key: hash.clone(),
                            timestamp: op.timestamp,
                            execution: Execution {
                                ok: op.ok,
                                /*
                                    The conversion from u128 (from op.duration.as_nanos()) to u64 using try_into().unwrap() can panic if the duration is longer than u64::MAX nanoseconds (over 584 years).
                                    While highly unlikely, it's safer to handle this potential overflow gracefully in library code to prevent panics.
                                    A safe alternative is to convert the Result to an Option and provide a fallback value on failure,
                                    effectively saturating at u64::MAX.
                                */
                                duration: op
                                    .duration
                                    .as_nanos()
                                    .try_into()
                                    .ok()
                                    .unwrap_or(u64::MAX),
                                errors_total: op.errors.try_into().unwrap(),
                            },
                            persisted_document_hash: op
                                .persisted_document_hash
                                .map(PersistedDocumentHash),
                            metadata,
                        });
                        if let Entry::Vacant(e) = report.map.entry(ReportMapKey(hash)) {
                            e.insert(OperationMapRecord {
                                operation: operation.operation,
                                operation_name: non_empty_string(op.operation_name),
                                fields: operation.coordinates,
                            });
                        }
                        report.size += 1;
                    }
                    None => {
                        tracing::debug!(
                            "Dropping operation (phase: PROCESSING): probably introspection query"
                        );
                    }
                },
            }
        }

        Ok(report)
    }

    async fn send_report(&self, report: Report) -> Result<(), AgentError> {
        if report.size == 0 {
            return Ok(());
        }
        // Based on https://the-guild.dev/graphql/hive/docs/specs/usage-reports#data-structure
        let resp_fut = self.client.post(&self.endpoint).json(&report).send();

        let resp = self
            .circuit_breaker
            .call(resp_fut)
            .await
            .map_err(|e| match e {
                recloser::Error::Inner(e) => AgentError::Unknown(e.to_string()),
                recloser::Error::Rejected => AgentError::CircuitBreakerRejected,
            })?;

        match resp.status() {
            reqwest::StatusCode::OK => Ok(()),
            reqwest::StatusCode::UNAUTHORIZED => Err(AgentError::Unauthorized),
            reqwest::StatusCode::FORBIDDEN => Err(AgentError::Forbidden),
            reqwest::StatusCode::TOO_MANY_REQUESTS => Err(AgentError::RateLimited),
            _ => Err(AgentError::Unknown(format!(
                "({}) {}",
                resp.status(),
                resp.text().await.unwrap_or_default()
            ))),
        }
    }

    async fn handle_drained(&self, drained: Vec<ExecutionReport>) -> Result<(), AgentError> {
        if drained.is_empty() {
            return Ok(());
        }
        let report = self.produce_report(drained)?;
        self.send_report(report).await
    }

    async fn flush(&self) -> Result<(), AgentError> {
        let execution_reports = self.buffer.drain().await;

        self.handle_drained(execution_reports).await?;

        Ok(())
    }
}

#[derive(Debug, Clone)]
pub struct RequestDetails {
    pub method: http::Method,
    pub url: http::Uri,
    pub headers: Vec<(String, String)>,
}

#[async_trait::async_trait]
impl UsageAgentExt for UsageAgent {
    async fn flush(&self) -> Result<(), AgentError> {
        self.inner().flush().await
    }

    async fn start_flush_interval(&self, token: &CancellationToken) {
        loop {
            tokio::time::sleep(self.inner().flush_interval).await;
            if token.is_cancelled() {
                println!("Shutting down.");
                return;
            }
            self.flush()
                .await
                .unwrap_or_else(|e| tracing::error!("Failed to flush usage reports: {}", e));
        }
    }

    async fn add_report_with_request(
        &self,
        execution_report: ExecutionReport,
        request: Option<RequestDetails>,
    ) -> Result<(), AgentError> {
        let inner = self.inner();

        if let Some(exclude_program) = &inner.exclude_expression {
            let result = exclude_program.execute(
                get_vrl_value_from_execution_report_and_request(&execution_report, request),
            )?;
            let result_bool = bool::from_vrl_value(result)?;
            if result_bool {
                tracing::debug!(
                    "Excluding report for operation \"{}\" based on exclude expression evaluation",
                    execution_report
                        .operation_name
                        .clone()
                        .or_else(|| Some("anonymous".to_string()))
                        .unwrap()
                );
                return Ok(());
            }
        }

        if let AddStatus::Full { drained } = inner.buffer.add(execution_report).await {
            inner.handle_drained(drained).await?;
        }

        Ok(())
    }
    async fn add_report(&self, execution_report: ExecutionReport) -> Result<(), AgentError> {
        self.add_report_with_request(execution_report, None).await
    }
}

impl<'req, TBody> From<&'req http::Request<TBody>> for RequestDetails {
    fn from(req: &'req http::Request<TBody>) -> Self {
        let mut headers = Vec::with_capacity(req.headers().len());
        for (name, value) in req.headers().iter() {
            if let Ok(val_str) = value.to_str() {
                headers.push((name.to_string(), val_str.to_string()));
            }
        }

        RequestDetails {
            method: req.method().clone(),
            url: req.uri().clone(),
            headers,
        }
    }
}

impl From<RequestDetails> for VrlValue {
    fn from(details: RequestDetails) -> Self {
        let mut merged_headers: BTreeMap<String, String> = BTreeMap::new();
        for (header_name, header_value) in details.headers {
            if let Some(existing_value) = merged_headers.get_mut(&header_name) {
                existing_value.push_str(", ");
                existing_value.push_str(&header_value);
            } else {
                merged_headers.insert(header_name, header_value);
            }
        }

        let headers_value: BTreeMap<KeyString, VrlValue> = merged_headers
            .into_iter()
            .map(|(key, value)| (key.into(), value.into()))
            .collect();
        let headers_value = VrlValue::Object(headers_value);

        // .request.url
        let url_value = VrlValue::Object(BTreeMap::from([
            ("host".into(), details.url.host().unwrap_or_default().into()),
            ("path".into(), details.url.path().into()),
            (
                "port".into(),
                details
                    .url
                    .port_u16()
                    .map(|p| VrlValue::Integer(p.into()))
                    .unwrap_or(VrlValue::Null),
            ),
        ]));

        // .request
        VrlValue::Object(BTreeMap::from([
            ("method".into(), details.method.as_str().into()),
            ("headers".into(), headers_value),
            ("url".into(), url_value),
        ]))
    }
}

pub fn get_vrl_value_from_execution_report_and_request(
    report: &ExecutionReport,
    request: Option<RequestDetails>,
) -> VrlValue {
    let mut map = BTreeMap::from([("default".into(), VrlValue::Boolean(false))]);
    let mut request_map = BTreeMap::new();

    if let Some(request_details) = request {
        if let VrlValue::Object(request_object) = VrlValue::from(request_details) {
            request_map.extend(request_object);
        }
    }

    request_map.insert(
        "operation".into(),
        VrlValue::Object(BTreeMap::from([
            (
                "name".into(),
                report.operation_name.clone().unwrap_or_default().into(),
            ),
            (
                "type".into(),
                report
                    .operation_type
                    .as_ref()
                    .map(|operation_type| match operation_type {
                        OperationType::Query => "query",
                        OperationType::Mutation => "mutation",
                        OperationType::Subscription => "subscription",
                    })
                    .unwrap_or_default()
                    .into(),
            ),
            ("query".into(), report.operation_body.clone().into()),
        ])),
    );

    if let Ok(timestamp_integer) = report.timestamp.try_into() {
        let timestamp_value = VrlValue::Integer(timestamp_integer);
        map.insert("timestamp".into(), timestamp_value);
        request_map.insert("timestamp".into(), VrlValue::Integer(timestamp_integer));
    }

    map.insert("request".into(), VrlValue::Object(request_map));

    VrlValue::Object(map)
}

#[async_trait::async_trait]
impl AsyncDrop for UsageAgentInner {
    async fn async_drop(&mut self) {
        if let Err(e) = self.flush().await {
            tracing::error!("Failed to flush usage reports during drop: {}", e);
        }
    }
}

#[cfg(test)]
mod tests {
    use std::{sync::Arc, time::Duration};

    use graphql_tools::parser::{parse_query, parse_schema};
    use reqwest::{
        header::{AUTHORIZATION, CONTENT_TYPE, USER_AGENT},
        Method,
    };
    use vrl::core::Value as VrlValue;
    use vrl::value::KeyString;

    use crate::agent::usage_agent::{
        get_vrl_value_from_execution_report_and_request, ExecutionReport, OperationType, Report,
        UsageAgent, UsageAgentExt,
    };

    /// Helper to extract a nested VRL value from an Object using string keys.
    fn vrl_get<'a>(value: &'a VrlValue, keys: &[&str]) -> &'a VrlValue {
        let mut current = value;
        for key in keys {
            match current {
                VrlValue::Object(map) => {
                    let ks: KeyString = (*key).into();
                    current = map
                        .get(&ks)
                        .unwrap_or_else(|| panic!("key '{}' not found", key));
                }
                _ => panic!("expected Object at key '{}'", key),
            }
        }
        current
    }

    const CONTENT_TYPE_VALUE: &'static str = "application/json";
    const GRAPHQL_CLIENT_NAME: &'static str = "Hive Client";
    const GRAPHQL_CLIENT_VERSION: &'static str = "1.0.0";

    #[tokio::test(flavor = "multi_thread")]
    async fn should_send_data_to_hive() -> Result<(), Box<dyn std::error::Error>> {
        let token = "Token";

        let mut server = mockito::Server::new_async().await;

        let server_url = server.url();

        let timestamp = 1625247600;
        let duration = Duration::from_millis(20);
        let user_agent = "hive-router-sdk-test";

        let mock = server
            .mock("POST", "/200")
            .match_header(AUTHORIZATION, format!("Bearer {}", token).as_str())
            .match_header(CONTENT_TYPE, CONTENT_TYPE_VALUE)
            .match_header(USER_AGENT, user_agent)
            .match_header("X-Usage-API-Version", "2")
            .match_request(move |request| {
                let request_body = request.body().expect("Failed to extract body");
                let report: Report = serde_json::from_slice(request_body)
                    .expect("Failed to parse request body as JSON");
                assert_eq!(report.size, 1);
                let record = report.map.values().next().expect("No operation record");
                // operation
                assert!(record.operation.contains("mutation deleteProject"));
                assert_eq!(record.operation_name.as_deref(), Some("deleteProject"));
                // fields
                let expected_fields = vec![
                    "Mutation.deleteProject",
                    "Mutation.deleteProject.selector",
                    "DeleteProjectPayload.selector",
                    "ProjectSelector.organization",
                    "ProjectSelector.project",
                    "DeleteProjectPayload.deletedProject",
                    "Project.id",
                    "Project.cleanId",
                    "Project.name",
                    "Project.type",
                    "ProjectType.FEDERATION",
                    "ProjectType.STITCHING",
                    "ProjectType.SINGLE",
                    "ProjectType.CUSTOM",
                    "ProjectSelectorInput.organization",
                    "ID",
                    "ProjectSelectorInput.project",
                ];
                for field in &expected_fields {
                    assert!(
                        record.fields.contains(&field.to_string()),
                        "Missing field: {}",
                        field
                    );
                }
                assert_eq!(
                    record.fields.len(),
                    expected_fields.len(),
                    "Unexpected number of fields"
                );

                // Operations
                let operations = report.operations;
                assert_eq!(operations.len(), 1); // one operation

                let operation = &operations[0];
                let key = report.map.keys().next().expect("No operation key");
                assert_eq!(operation.operation_map_key, key.0);
                assert_eq!(operation.timestamp, timestamp);
                assert_eq!(operation.execution.duration, duration.as_nanos() as u64);
                assert_eq!(operation.execution.ok, true);
                assert_eq!(operation.execution.errors_total, 0);
                true
            })
            .expect(1)
            .with_status(200)
            .create_async()
            .await;
        let schema: graphql_tools::static_graphql::schema::Document = parse_schema(
            r#"
                type Query {
                    project(selector: ProjectSelectorInput!): Project
                    projectsByType(type: ProjectType!): [Project!]!
                    projects(filter: FilterInput): [Project!]!
                }

                type Mutation {
                    deleteProject(selector: ProjectSelectorInput!): DeleteProjectPayload!
                }

                input ProjectSelectorInput {
                    organization: ID!
                    project: ID!
                }

                input FilterInput {
                    type: ProjectType
                    pagination: PaginationInput
                }

                input PaginationInput {
                    limit: Int
                    offset: Int
                }

                type ProjectSelector {
                    organization: ID!
                    project: ID!
                }

                type DeleteProjectPayload {
                    selector: ProjectSelector!
                    deletedProject: Project!
                }

                type Project {
                    id: ID!
                    cleanId: ID!
                    name: String!
                    type: ProjectType!
                    buildUrl: String
                    validationUrl: String
                }

                enum ProjectType {
                    FEDERATION
                    STITCHING
                    SINGLE
                    CUSTOM
                }
        "#,
        )?;

        let op: graphql_tools::static_graphql::query::Document = parse_query(
            r#"
                mutation deleteProject($selector: ProjectSelectorInput!) {
                    deleteProject(selector: $selector) {
                    selector {
                        organization
                        project
                    }
                    deletedProject {
                        ...ProjectFields
                    }
                    }
                }

                fragment ProjectFields on Project {
                    id
                    cleanId
                    name
                    type
                }
        "#,
        )?;

        // Testing async drop
        {
            let usage_agent = UsageAgent::builder()
                .token(token.into())
                .endpoint(format!("{}/200", server_url))
                .user_agent(user_agent.into())
                .build()?;

            let request = http::Request::builder()
                .method(Method::POST)
                .uri("http://localhost/graphql")
                .body(())
                .unwrap();

            usage_agent
                .add_report_with_request(
                    ExecutionReport {
                        schema: Arc::new(schema),
                        operation_body: op.to_string(),
                        operation_name: Some("deleteProject".to_string()),
                        operation_type: Some(OperationType::Mutation),
                        client_name: Some(GRAPHQL_CLIENT_NAME.to_string()),
                        client_version: Some(GRAPHQL_CLIENT_VERSION.to_string()),
                        timestamp,
                        duration,
                        ok: true,
                        errors: 0,
                        persisted_document_hash: None,
                    },
                    Some((&request).into()),
                )
                .await?;
        }

        mock.assert_async().await;

        Ok(())
    }

    fn make_test_report(
        operation_name: Option<&str>,
        operation_type: OperationType,
        operation_body: &str,
    ) -> ExecutionReport {
        let schema: graphql_tools::static_graphql::schema::Document =
            parse_schema("type Query { hello: String }").unwrap();

        ExecutionReport {
            schema: Arc::new(schema),
            operation_body: operation_body.to_string(),
            operation_name: operation_name.map(|s| s.to_string()),
            operation_type: Some(operation_type),
            client_name: Some("test-client".to_string()),
            client_version: Some("1.0.0".to_string()),
            timestamp: 1625247600,
            duration: Duration::from_millis(10),
            ok: true,
            errors: 0,
            persisted_document_hash: None,
        }
    }

    fn make_simple_report(
        operation_name: Option<&str>,
        operation_type: OperationType,
    ) -> ExecutionReport {
        make_test_report(operation_name, operation_type, "query { hello }")
    }

    fn make_simple_request() -> http::Request<()> {
        http::Request::builder()
            .method(Method::GET)
            .uri("http://localhost/graphql")
            .body(())
            .unwrap()
    }

    #[test]
    fn vrl_value_contains_operation_name() {
        let report = make_simple_report(Some("MyQuery"), OperationType::Query);
        let request = make_simple_request();
        let value =
            get_vrl_value_from_execution_report_and_request(&report, Some((&request).into()));

        let name = vrl_get(&value, &["request", "operation", "name"]);
        assert_eq!(name, &VrlValue::from("MyQuery"));
    }

    #[test]
    fn vrl_value_contains_operation_type_query() {
        let report = make_simple_report(Some("Q"), OperationType::Query);
        let request = make_simple_request();
        let value =
            get_vrl_value_from_execution_report_and_request(&report, Some((&request).into()));

        let op_type = vrl_get(&value, &["request", "operation", "type"]);
        assert_eq!(op_type, &VrlValue::from("query"));
    }

    #[test]
    fn vrl_value_contains_operation_type_mutation() {
        let report = make_simple_report(Some("M"), OperationType::Mutation);
        let request = make_simple_request();
        let value =
            get_vrl_value_from_execution_report_and_request(&report, Some((&request).into()));

        let op_type = vrl_get(&value, &["request", "operation", "type"]);
        assert_eq!(op_type, &VrlValue::from("mutation"));
    }

    #[test]
    fn vrl_value_contains_operation_type_subscription() {
        let report = make_simple_report(Some("S"), OperationType::Subscription);
        let request = make_simple_request();
        let value =
            get_vrl_value_from_execution_report_and_request(&report, Some((&request).into()));

        let op_type = vrl_get(&value, &["request", "operation", "type"]);
        assert_eq!(op_type, &VrlValue::from("subscription"));
    }

    #[test]
    fn vrl_value_contains_operation_body() {
        let report = make_simple_report(Some("Q"), OperationType::Query);
        let request = make_simple_request();
        let value =
            get_vrl_value_from_execution_report_and_request(&report, Some((&request).into()));

        let query = vrl_get(&value, &["request", "operation", "query"]);
        assert_eq!(query, &VrlValue::from("query { hello }"));
    }

    #[test]
    fn vrl_value_contains_request_method() {
        let report = make_test_report(Some("Q"), OperationType::Query, "query { hello }");
        let request = http::Request::builder()
            .method(Method::GET)
            .uri("http://localhost/graphql")
            .body(())
            .unwrap();
        let value =
            get_vrl_value_from_execution_report_and_request(&report, Some((&request).into()));

        let method = vrl_get(&value, &["request", "method"]);
        assert_eq!(method, &VrlValue::from("GET"));
    }

    #[test]
    fn vrl_value_contains_url_details() {
        let report = make_test_report(Some("Q"), OperationType::Query, "query { hello }");
        let request = http::Request::builder()
            .method(Method::POST)
            .uri("http://api.example.com:8080/v1/graphql")
            .body(())
            .unwrap();
        let value =
            get_vrl_value_from_execution_report_and_request(&report, Some((&request).into()));

        assert_eq!(
            vrl_get(&value, &["request", "url", "host"]),
            &VrlValue::from("api.example.com")
        );
        assert_eq!(
            vrl_get(&value, &["request", "url", "port"]),
            &VrlValue::Integer(8080)
        );
        assert_eq!(
            vrl_get(&value, &["request", "url", "path"]),
            &VrlValue::from("/v1/graphql")
        );
    }

    #[test]
    fn vrl_value_contains_headers() {
        let request = http::Request::builder()
            .method(Method::POST)
            .uri("http://localhost/graphql")
            .header("x-custom-header", "custom-value")
            .header("authorization", "Bearer token123")
            .body(())
            .unwrap();
        let report = make_test_report(Some("Q"), OperationType::Query, "query { hello }");
        let value =
            get_vrl_value_from_execution_report_and_request(&report, Some((&request).into()));

        assert_eq!(
            vrl_get(&value, &["request", "headers", "x-custom-header"]),
            &VrlValue::from("custom-value")
        );
        assert_eq!(
            vrl_get(&value, &["request", "headers", "authorization"]),
            &VrlValue::from("Bearer token123")
        );
    }

    #[test]
    fn vrl_value_joins_duplicate_header_values() {
        let mut request = http::Request::builder()
            .method(Method::POST)
            .uri("http://localhost/graphql")
            .body(())
            .unwrap();

        request
            .headers_mut()
            .append("x-scope", http::HeaderValue::from_static("one"));
        request
            .headers_mut()
            .append("x-scope", http::HeaderValue::from_static("two"));

        let report = make_test_report(Some("Q"), OperationType::Query, "query { hello }");
        let value =
            get_vrl_value_from_execution_report_and_request(&report, Some((&request).into()));

        assert_eq!(
            vrl_get(&value, &["request", "headers", "x-scope"]),
            &VrlValue::from("one, two")
        );
    }

    #[test]
    fn vrl_value_anonymous_operation_has_empty_name() {
        let report = make_simple_report(None, OperationType::Query);
        let request = make_simple_request();
        let value =
            get_vrl_value_from_execution_report_and_request(&report, Some((&request).into()));

        let name = vrl_get(&value, &["request", "operation", "name"]);
        assert_eq!(name, &VrlValue::from(""));
    }

    #[test]
    fn vrl_value_has_default_false() {
        let report = make_simple_report(Some("Q"), OperationType::Query);
        let request = make_simple_request();
        let value =
            get_vrl_value_from_execution_report_and_request(&report, Some((&request).into()));

        let default_val = vrl_get(&value, &["default"]);
        assert_eq!(default_val, &VrlValue::Boolean(false));
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn exclude_expression_filters_by_operation_name() -> Result<(), Box<dyn std::error::Error>>
    {
        let token = "Token";
        let mut server = mockito::Server::new_async().await;
        let server_url = server.url();

        // The mock expects exactly 0 requests because the operation should be excluded
        let mock = server
            .mock("POST", "/200")
            .expect(0)
            .with_status(200)
            .create_async()
            .await;

        {
            let usage_agent = UsageAgent::builder()
                .token(token.into())
                .endpoint(format!("{}/200", server_url))
                .buffer_size(1) // flush on every report
                .exclude_expression(r#".request.operation.name == "ExcludeMe""#.to_string())
                .build()?;

            // This report should be excluded
            let report = make_simple_report(Some("ExcludeMe"), OperationType::Query);
            let request = make_simple_request();
            usage_agent
                .add_report_with_request(report, Some((&request).into()))
                .await?;
        }

        mock.assert_async().await;
        Ok(())
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn exclude_expression_allows_non_matching_operations(
    ) -> Result<(), Box<dyn std::error::Error>> {
        let token = "Token";
        let mut server = mockito::Server::new_async().await;
        let server_url = server.url();

        // This operation should NOT be excluded, so we expect 1 request (via async drop flush)
        let mock = server
            .mock("POST", "/200")
            .expect(1)
            .with_status(200)
            .create_async()
            .await;

        {
            let usage_agent = UsageAgent::builder()
                .token(token.into())
                .endpoint(format!("{}/200", server_url))
                .exclude_expression(r#".request.operation.name == "ExcludeMe""#.to_string())
                .build()?;

            let report = make_simple_report(Some("KeepMe"), OperationType::Query);
            let request = make_simple_request();
            usage_agent
                .add_report_with_request(report, Some((&request).into()))
                .await?;
        }

        mock.assert_async().await;
        Ok(())
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn exclude_expression_filters_by_operation_type() -> Result<(), Box<dyn std::error::Error>>
    {
        let token = "Token";
        let mut server = mockito::Server::new_async().await;
        let server_url = server.url();

        let mock = server
            .mock("POST", "/200")
            .expect(0)
            .with_status(200)
            .create_async()
            .await;

        {
            let usage_agent = UsageAgent::builder()
                .token(token.into())
                .endpoint(format!("{}/200", server_url))
                .buffer_size(1)
                .exclude_expression(r#".request.operation.type == "subscription""#.to_string())
                .build()?;

            let report = make_simple_report(Some("OnMessage"), OperationType::Subscription);
            let request = make_simple_request();
            usage_agent
                .add_report_with_request(report, Some((&request).into()))
                .await?;
        }

        mock.assert_async().await;
        Ok(())
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn exclude_expression_filters_by_header() -> Result<(), Box<dyn std::error::Error>> {
        let token = "Token";
        let mut server = mockito::Server::new_async().await;
        let server_url = server.url();

        let mock = server
            .mock("POST", "/200")
            .expect(0)
            .with_status(200)
            .create_async()
            .await;

        {
            let usage_agent = UsageAgent::builder()
                .token(token.into())
                .endpoint(format!("{}/200", server_url))
                .buffer_size(1)
                .exclude_expression(r#".request.headers."x-internal" == "true""#.to_string())
                .build()?;

            let request = http::Request::builder()
                .method(Method::POST)
                .uri("http://localhost/graphql")
                .header("x-internal", "true")
                .body(())
                .unwrap();

            let report = make_test_report(Some("Q"), OperationType::Query, "query { hello }");
            usage_agent
                .add_report_with_request(report, Some((&request).into()))
                .await?;
        }

        mock.assert_async().await;
        Ok(())
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn exclude_expression_complex_conditional() -> Result<(), Box<dyn std::error::Error>> {
        let token = "Token";
        let mut server = mockito::Server::new_async().await;
        let server_url = server.url();

        // The expression excludes IntrospectionQuery OR any mutation
        let exclude_expr = r#"
            if (.request.operation.name == "IntrospectionQuery") {
                true
            } else if (.request.operation.type == "mutation") {
                true
            } else {
                false
            }
        "#;

        let mock = server
            .mock("POST", "/200")
            .expect(0)
            .with_status(200)
            .create_async()
            .await;

        {
            let usage_agent = UsageAgent::builder()
                .token(token.into())
                .endpoint(format!("{}/200", server_url))
                .buffer_size(1)
                .exclude_expression(exclude_expr.to_string())
                .build()?;

            let request = make_simple_request();

            // Excluded: IntrospectionQuery
            let report = make_simple_report(Some("IntrospectionQuery"), OperationType::Query);
            usage_agent
                .add_report_with_request(report, Some((&request).into()))
                .await?;

            // Excluded: any mutation
            let report = make_simple_report(Some("CreateUser"), OperationType::Mutation);
            usage_agent
                .add_report_with_request(report, Some((&request).into()))
                .await?;
        }

        mock.assert_async().await;
        Ok(())
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn exclude_expression_allows_through_complex_conditional(
    ) -> Result<(), Box<dyn std::error::Error>> {
        let token = "Token";
        let mut server = mockito::Server::new_async().await;
        let server_url = server.url();

        let exclude_expr = r#"
            if (.request.operation.name == "IntrospectionQuery") {
                true
            } else if (.request.operation.type == "mutation") {
                true
            } else {
                false
            }
        "#;

        // A normal query should NOT be excluded
        let mock = server
            .mock("POST", "/200")
            .expect(1)
            .with_status(200)
            .create_async()
            .await;

        {
            let usage_agent = UsageAgent::builder()
                .token(token.into())
                .endpoint(format!("{}/200", server_url))
                .exclude_expression(exclude_expr.to_string())
                .build()?;

            let request = make_simple_request();

            let report = make_simple_report(Some("GetUsers"), OperationType::Query);
            usage_agent
                .add_report_with_request(report, Some((&request).into()))
                .await?;
        }

        mock.assert_async().await;
        Ok(())
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn exclude_expression_filters_by_url_path() -> Result<(), Box<dyn std::error::Error>> {
        let token = "Token";
        let mut server = mockito::Server::new_async().await;
        let server_url = server.url();

        let mock = server
            .mock("POST", "/200")
            .expect(0)
            .with_status(200)
            .create_async()
            .await;

        {
            let usage_agent = UsageAgent::builder()
                .token(token.into())
                .endpoint(format!("{}/200", server_url))
                .buffer_size(1)
                .exclude_expression(r#".request.url.path == "/internal/graphql""#.to_string())
                .build()?;

            let request = http::Request::builder()
                .method(Method::POST)
                .uri("http://localhost/internal/graphql")
                .body(())
                .unwrap();

            let report = make_test_report(Some("Q"), OperationType::Query, "query { hello }");
            usage_agent
                .add_report_with_request(report, Some((&request).into()))
                .await?;
        }

        mock.assert_async().await;
        Ok(())
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn no_exclude_expression_sends_all_reports() -> Result<(), Box<dyn std::error::Error>> {
        let token = "Token";
        let mut server = mockito::Server::new_async().await;
        let server_url = server.url();

        let mock = server
            .mock("POST", "/200")
            .expect(1)
            .with_status(200)
            .create_async()
            .await;

        {
            let usage_agent = UsageAgent::builder()
                .token(token.into())
                .endpoint(format!("{}/200", server_url))
                .build()?;

            let report = make_simple_report(Some("AnyOp"), OperationType::Query);
            let request = make_simple_request();
            usage_agent
                .add_report_with_request(report, Some((&request).into()))
                .await?;
        }

        mock.assert_async().await;
        Ok(())
    }

    #[test]
    fn builder_rejects_invalid_exclude_expression() {
        let result = UsageAgent::builder()
            .token("Token".into())
            .exclude_expression("this is not valid VRL }{".to_string())
            .build();

        assert!(result.is_err());
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn builder_ignores_empty_exclude_expression() {
        let result = UsageAgent::builder()
            .token("Token".into())
            .exclude_expression("".to_string())
            .build();

        assert!(result.is_ok());
    }
}