Skip to content

Commit 810e411

Browse files
trevor-scheertrevor-scheer
committed
update API and usage
1 parent d906226 commit 810e411

File tree

5 files changed

+48
-47
lines changed

5 files changed

+48
-47
lines changed

‎federation-2/router-bridge/benches/query_planning.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
use criterion::criterion_group;
22
use criterion::criterion_main;
33
use criterion::Criterion;
4+
use router_bridge::planner::PlanOptions;
45
use router_bridge::planner::Planner;
56
use router_bridge::planner::QueryPlannerConfig;
67

@@ -19,7 +20,7 @@ fn from_elem(c: &mut Criterion) {
1920

2021
b.to_async(runtime).iter(|| async {
2122
planner
22-
.plan(QUERY.to_string(), None, None)
23+
.plan(QUERY.to_string(), None, PlanOptions::default())
2324
.await
2425
.unwrap()
2526
.into_result()

‎federation-2/router-bridge/js-src/plan.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export interface QueryPlanResult {
5252
}
5353

5454
export interface PlanOptions {
55-
overrideLabels?: string[];
55+
overriddenLabels?: string[];
5656
}
5757

5858
export class BridgeQueryPlanner {
@@ -93,7 +93,7 @@ export class BridgeQueryPlanner {
9393
let operation = operationResult.data;
9494
const operationName = operation?.name;
9595
const buildQueryPlanOptions = options
96-
? { overrideLabels: new Set(options.overrideLabels) }
96+
? { overriddenLabels: new Set(options.overriddenLabels) }
9797
: undefined;
9898
const queryPlan = this.planner.buildQueryPlan(
9999
operation,

‎federation-2/router-bridge/package-lock.json

Lines changed: 11 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎federation-2/router-bridge/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
},
2929
"dependencies": {
3030
"@apollo/core-schema": "^0.3.0",
31-
"@apollo/federation-internals": "https://pkg.csb.dev/apollographql/federation/commit/f73f8a8c/@apollo/federation-internals",
32-
"@apollo/query-planner": "https://pkg.csb.dev/apollographql/federation/commit/f73f8a8c/@apollo/query-planner",
31+
"@apollo/federation-internals": "https://pkg.csb.dev/apollographql/federation/commit/bd1d73c3/@apollo/federation-internals",
32+
"@apollo/query-planner": "https://pkg.csb.dev/apollographql/federation/commit/bd1d73c3/@apollo/query-planner",
3333
"@apollo/usage-reporting-protobuf": "^4.0.0",
3434
"@apollo/utils.usagereporting": "^3.0.0",
3535
"graphql": "16.6.0"

‎federation-2/router-bridge/src/planner.rs

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -530,7 +530,7 @@ where
530530
&self,
531531
query: String,
532532
operation_name: Option<String>,
533-
options: Option<PlanOptions>,
533+
options: PlanOptions,
534534
) -> Result<PlanResult<T>, crate::error::Error> {
535535
self.worker
536536
.request(PlanCmd::Plan {
@@ -611,11 +611,11 @@ where
611611
}
612612

613613
/// Options for planning a query
614-
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Hash)]
614+
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Hash, Default)]
615615
#[serde(rename_all = "camelCase")]
616616
pub struct PlanOptions {
617617
/// TODO
618-
pub override_labels: Option<Vec<String>>,
618+
pub overridden_labels: Vec<String>,
619619
}
620620

621621
#[derive(Serialize, Debug, Clone, PartialEq, Eq, Hash)]
@@ -632,7 +632,7 @@ enum PlanCmd {
632632
query: String,
633633
operation_name: Option<String>,
634634
schema_id: u64,
635-
options: Option<PlanOptions>,
635+
options: PlanOptions,
636636
},
637637
#[serde(rename_all = "camelCase")]
638638
ApiSchema { schema_id: u64 },
@@ -790,7 +790,7 @@ mod tests {
790790
.unwrap();
791791

792792
let payload = planner
793-
.plan(QUERY.to_string(), None, None)
793+
.plan(QUERY.to_string(), None, PlanOptions::default())
794794
.await
795795
.unwrap()
796796
.into_result()
@@ -818,9 +818,9 @@ mod tests {
818818
.plan(
819819
query.to_string(),
820820
None,
821-
Some(PlanOptions {
822-
override_labels: Some(vec!["foo".to_string()]),
823-
}),
821+
PlanOptions {
822+
overridden_labels: vec!["foo".to_string()],
823+
},
824824
)
825825
.await
826826
.unwrap()
@@ -829,7 +829,7 @@ mod tests {
829829
insta::assert_snapshot!(serde_json::to_string_pretty(&payload1.data).unwrap());
830830

831831
let payload2 = planner
832-
.plan(query.to_string(), None, None)
832+
.plan(query.to_string(), None, PlanOptions::default())
833833
.await
834834
.unwrap()
835835
.into_result()
@@ -845,7 +845,7 @@ mod tests {
845845
.unwrap();
846846

847847
let payload = planner
848-
.plan(NAMED_QUERY.to_string(), None, None)
848+
.plan(NAMED_QUERY.to_string(), None, PlanOptions::default())
849849
.await
850850
.unwrap()
851851
.into_result()
@@ -867,7 +867,7 @@ mod tests {
867867
.plan(
868868
MULTIPLE_QUERIES.to_string(),
869869
Some("MyFirstName".to_string()),
870-
None,
870+
PlanOptions::default(),
871871
)
872872
.await
873873
.unwrap()
@@ -890,7 +890,7 @@ mod tests {
890890
.plan(
891891
NAMED_QUERY.to_string(),
892892
Some("MyFirstAndLastName".to_string()),
893-
None,
893+
PlanOptions::default(),
894894
)
895895
.await
896896
.unwrap()
@@ -909,7 +909,7 @@ mod tests {
909909
.unwrap();
910910

911911
let payload = planner
912-
.plan(QUERY_REUSE_QUERY_FRAGMENTS.to_string(), None, None)
912+
.plan(QUERY_REUSE_QUERY_FRAGMENTS.to_string(), None, PlanOptions::default())
913913
.await
914914
.unwrap()
915915
.into_result()
@@ -930,7 +930,7 @@ mod tests {
930930
.unwrap();
931931

932932
let payload = planner
933-
.plan(QUERY_REUSE_QUERY_FRAGMENTS.to_string(), None, None)
933+
.plan(QUERY_REUSE_QUERY_FRAGMENTS.to_string(), None, PlanOptions::default())
934934
.await
935935
.unwrap()
936936
.into_result()
@@ -951,7 +951,7 @@ mod tests {
951951
.unwrap();
952952

953953
let payload = planner
954-
.plan(QUERY_REUSE_QUERY_FRAGMENTS.to_string(), None, None)
954+
.plan(QUERY_REUSE_QUERY_FRAGMENTS.to_string(), None, PlanOptions::default())
955955
.await
956956
.unwrap()
957957
.into_result()
@@ -970,7 +970,7 @@ mod tests {
970970
.plan(
971971
"this query will definitely not parse".to_string(),
972972
None,
973-
None,
973+
PlanOptions::default(),
974974
)
975975
.await
976976
.unwrap()
@@ -1009,7 +1009,7 @@ mod tests {
10091009
query { me { id ...thatUserFragment1 } }"
10101010
.to_string(),
10111011
None,
1012-
None,
1012+
PlanOptions::default(),
10131013
)
10141014
.await
10151015
.unwrap()
@@ -1037,7 +1037,7 @@ mod tests {
10371037
.plan(
10381038
QUERY.to_string(),
10391039
Some("ThisOperationNameDoesntExist".to_string()),
1040-
None,
1040+
PlanOptions::default(),
10411041
)
10421042
.await
10431043
.unwrap()
@@ -1062,7 +1062,7 @@ mod tests {
10621062
.unwrap();
10631063

10641064
let payload = planner
1065-
.plan(MULTIPLE_QUERIES.to_string(), None, None)
1065+
.plan(MULTIPLE_QUERIES.to_string(), None, PlanOptions::default())
10661066
.await
10671067
.unwrap()
10681068
.into_result()
@@ -1086,7 +1086,7 @@ mod tests {
10861086
.unwrap();
10871087

10881088
let payload = planner
1089-
.plan(MULTIPLE_ANONYMOUS_QUERIES.to_string(), None, None)
1089+
.plan(MULTIPLE_ANONYMOUS_QUERIES.to_string(), None, PlanOptions::default())
10901090
.await
10911091
.unwrap()
10921092
.into_result()
@@ -1110,7 +1110,7 @@ mod tests {
11101110
.unwrap();
11111111

11121112
let payload = planner
1113-
.plan(NO_OPERATION.to_string(), None, None)
1113+
.plan(NO_OPERATION.to_string(), None, PlanOptions::default())
11141114
.await
11151115
.unwrap()
11161116
.into_result()
@@ -1330,7 +1330,7 @@ mod tests {
13301330
.await
13311331
.unwrap();
13321332

1333-
let actual = planner.plan(query, operation_name, None).await.unwrap();
1333+
let actual = planner.plan(query, operation_name, PlanOptions::default()).await.unwrap();
13341334

13351335
assert_eq!(expected_errors, actual.errors.unwrap());
13361336
}
@@ -1343,24 +1343,24 @@ mod tests {
13431343
.unwrap();
13441344

13451345
let query_1_response = planner
1346-
.plan(QUERY.to_string(), None, None)
1346+
.plan(QUERY.to_string(), None, PlanOptions::default())
13471347
.await
13481348
.unwrap()
13491349
.data
13501350
.unwrap();
13511351

13521352
let query_2_response = planner
1353-
.plan(QUERY2.to_string(), None, None)
1353+
.plan(QUERY2.to_string(), None, PlanOptions::default())
13541354
.await
13551355
.unwrap()
13561356
.data
13571357
.unwrap();
13581358

13591359
let all_futures = stream::iter((0..1000).map(|i| {
13601360
let (query, fut) = if i % 2 == 0 {
1361-
(QUERY, planner.plan(QUERY.to_string(), None, None))
1361+
(QUERY, planner.plan(QUERY.to_string(), None, PlanOptions::default()))
13621362
} else {
1363-
(QUERY2, planner.plan(QUERY2.to_string(), None, None))
1363+
(QUERY2, planner.plan(QUERY2.to_string(), None, PlanOptions::default()))
13641364
};
13651365

13661366
async move { (query, fut.await.unwrap()) }
@@ -1674,7 +1674,7 @@ ofType {
16741674
.await
16751675
.unwrap();
16761676
let query_plan1 = planner
1677-
.plan(query.to_string(), None, None)
1677+
.plan(query.to_string(), None, PlanOptions::default())
16781678
.await
16791679
.unwrap()
16801680
.into_result()
@@ -1689,7 +1689,7 @@ ofType {
16891689
.await
16901690
.unwrap();
16911691
let query_plan2 = updated_planner
1692-
.plan(query.to_string(), None, None)
1692+
.plan(query.to_string(), None, PlanOptions::default())
16931693
.await
16941694
.unwrap()
16951695
.into_result()
@@ -1716,7 +1716,7 @@ ofType {
17161716
assert_eq!(
17171717
query_plan2.data,
17181718
updated_planner
1719-
.plan(query.to_string(), None, None)
1719+
.plan(query.to_string(), None, PlanOptions::default())
17201720
.await
17211721
.unwrap()
17221722
.into_result()
@@ -2029,7 +2029,7 @@ feature https://specs.apollo.dev/unsupported-feature/v0.1 is for: SECURITY but i
20292029
}"#
20302030
.to_string(),
20312031
None,
2032-
None,
2032+
PlanOptions::default(),
20332033
)
20342034
.await
20352035
.unwrap()
@@ -2100,7 +2100,7 @@ feature https://specs.apollo.dev/unsupported-feature/v0.1 is for: SECURITY but i
21002100
"query { currentUser { activeOrganization { id suborga { id ...@defer { nonNullId } } } } }"
21012101
.to_string(),
21022102
None,
2103-
None,
2103+
PlanOptions::default(),
21042104
)
21052105
.await
21062106
.unwrap()

0 commit comments

Comments
 (0)