-
Notifications
You must be signed in to change notification settings - Fork 245
/
subscription.rs
1354 lines (1258 loc) 路 51.8 KB
/
subscription.rs
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
use std::collections::HashMap;
use std::collections::HashSet;
use std::ops::ControlFlow;
use std::task::Poll;
use std::time::Duration;
use bytes::Buf;
use futures::future::BoxFuture;
use hmac::Hmac;
use hmac::Mac;
use http::HeaderName;
use http::HeaderValue;
use http::Method;
use http::StatusCode;
use multimap::MultiMap;
use once_cell::sync::OnceCell;
use schemars::JsonSchema;
use serde::Deserialize;
use serde::Serialize;
use sha2::Digest;
use sha2::Sha256;
use tower::BoxError;
use tower::Service;
use tower::ServiceBuilder;
use tower::ServiceExt;
use tracing_futures::Instrument;
use uuid::Uuid;
use crate::context::Context;
use crate::graphql;
use crate::graphql::Response;
use crate::json_ext::Object;
use crate::layers::ServiceBuilderExt;
use crate::notification::Notify;
use crate::plugin::Plugin;
use crate::plugin::PluginInit;
use crate::protocols::websocket::WebSocketProtocol;
use crate::query_planner::OperationKind;
use crate::register_plugin;
use crate::services::router;
use crate::services::subgraph;
use crate::Endpoint;
use crate::ListenAddr;
type HmacSha256 = Hmac<sha2::Sha256>;
pub(crate) const APOLLO_SUBSCRIPTION_PLUGIN: &str = "apollo.subscription";
#[cfg(not(test))]
pub(crate) const APOLLO_SUBSCRIPTION_PLUGIN_NAME: &str = "subscription";
pub(crate) static SUBSCRIPTION_CALLBACK_HMAC_KEY: OnceCell<String> = OnceCell::new();
pub(crate) const SUBSCRIPTION_WS_CUSTOM_CONNECTION_PARAMS: &str =
"apollo.subscription.custom_connection_params";
const CALLBACK_SUBSCRIPTION_HEADER_NAME: &str = "subscription-protocol";
const CALLBACK_SUBSCRIPTION_HEADER_VALUE: &str = "callback/1.0";
#[derive(Debug, Clone)]
pub(crate) struct Subscription {
notify: Notify<String, graphql::Response>,
callback_hmac_key: Option<String>,
pub(crate) config: SubscriptionConfig,
}
/// Subscriptions configuration
#[derive(Debug, Clone, Deserialize, Serialize, JsonSchema)]
#[serde(deny_unknown_fields, default)]
pub(crate) struct SubscriptionConfig {
/// Enable subscription
pub(crate) enabled: bool,
/// Select a subscription mode (callback or passthrough)
pub(crate) mode: SubscriptionModeConfig,
/// Enable the deduplication of subscription (for example if we detect the exact same request to subgraph we won't open a new websocket to the subgraph in passthrough mode)
/// (default: true)
pub(crate) enable_deduplication: bool,
/// This is a limit to only have maximum X opened subscriptions at the same time. By default if it's not set there is no limit.
pub(crate) max_opened_subscriptions: Option<usize>,
/// It represent the capacity of the in memory queue to know how many events we can keep in a buffer
pub(crate) queue_capacity: Option<usize>,
}
impl Default for SubscriptionConfig {
fn default() -> Self {
Self {
enabled: true,
mode: Default::default(),
enable_deduplication: true,
max_opened_subscriptions: None,
queue_capacity: None,
}
}
}
#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize, Default, JsonSchema)]
#[serde(deny_unknown_fields)]
pub(crate) struct SubscriptionModeConfig {
/// Enable callback mode for subgraph(s)
pub(crate) callback: Option<CallbackMode>,
/// Enable passthrough mode for subgraph(s)
pub(crate) passthrough: Option<SubgraphPassthroughMode>,
}
impl SubscriptionModeConfig {
pub(crate) fn get_subgraph_config(&self, service_name: &str) -> Option<SubscriptionMode> {
if let Some(passthrough_cfg) = &self.passthrough {
if let Some(subgraph_cfg) = passthrough_cfg.subgraphs.get(service_name) {
return SubscriptionMode::Passthrough(subgraph_cfg.clone()).into();
}
if let Some(all_cfg) = &passthrough_cfg.all {
return SubscriptionMode::Passthrough(all_cfg.clone()).into();
}
}
if let Some(callback_cfg) = &self.callback {
if callback_cfg.subgraphs.contains(service_name) || callback_cfg.subgraphs.is_empty() {
let callback_cfg = CallbackMode {
public_url: callback_cfg.public_url.clone(),
heartbeat_interval: callback_cfg.heartbeat_interval.clone(),
listen: callback_cfg.listen.clone(),
path: callback_cfg.path.clone(),
subgraphs: HashSet::new(), // We don't need it
};
return SubscriptionMode::Callback(callback_cfg).into();
}
}
None
}
}
#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize, Default, JsonSchema)]
#[serde(deny_unknown_fields, default)]
pub(crate) struct SubgraphPassthroughMode {
/// Configuration for all subgraphs
pub(crate) all: Option<WebSocketConfiguration>,
/// Configuration for specific subgraphs
pub(crate) subgraphs: HashMap<String, WebSocketConfiguration>,
}
#[derive(Debug, Clone, PartialEq)]
pub(crate) enum SubscriptionMode {
/// Using a callback url
Callback(CallbackMode),
/// Using websocket to directly connect to subgraph
Passthrough(WebSocketConfiguration),
}
/// Using a callback url
#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
#[serde(deny_unknown_fields)]
pub(crate) struct CallbackMode {
#[schemars(with = "String")]
/// URL used to access this router instance, including the path configured on the Router
pub(crate) public_url: url::Url,
/// Heartbeat interval for callback mode (default: 5secs)
#[serde(default = "HeartbeatInterval::default")]
pub(crate) heartbeat_interval: HeartbeatInterval,
// `skip_serializing` We don't need it in the context
/// Listen address on which the callback must listen (default: 127.0.0.1:4000)
#[serde(skip_serializing)]
pub(crate) listen: Option<ListenAddr>,
// `skip_serializing` We don't need it in the context
/// Specify on which path you want to listen for callbacks (default: /callback)
#[serde(skip_serializing)]
pub(crate) path: Option<String>,
/// Specify on which subgraph we enable the callback mode for subscription
/// If empty it applies to all subgraphs (passthrough mode takes precedence)
#[serde(default)]
pub(crate) subgraphs: HashSet<String>,
}
#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
#[serde(rename_all = "snake_case", untagged)]
pub(crate) enum HeartbeatInterval {
Disabled(Disabled),
#[serde(with = "humantime_serde")]
#[schemars(with = "String")]
Duration(Duration),
}
#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub(crate) enum Disabled {
Disabled,
}
impl Default for HeartbeatInterval {
fn default() -> Self {
Self::Duration(Duration::from_secs(5))
}
}
/// Using websocket to directly connect to subgraph
#[derive(Debug, Clone, PartialEq, Eq, Default, Deserialize, Serialize, JsonSchema)]
#[serde(deny_unknown_fields, default)]
pub(crate) struct PassthroughMode {
/// WebSocket configuration for specific subgraphs
subgraph: SubgraphPassthroughMode,
}
#[derive(Debug, Clone, PartialEq, Eq, Default, Deserialize, Serialize, JsonSchema)]
#[serde(deny_unknown_fields, default)]
/// WebSocket configuration for a specific subgraph
pub(crate) struct WebSocketConfiguration {
/// Path on which WebSockets are listening
pub(crate) path: Option<String>,
/// Which WebSocket GraphQL protocol to use for this subgraph possible values are: 'graphql_ws' | 'graphql_transport_ws' (default: graphql_ws)
pub(crate) protocol: WebSocketProtocol,
}
fn default_path() -> String {
String::from("/callback")
}
fn default_listen_addr() -> ListenAddr {
ListenAddr::SocketAddr("127.0.0.1:4000".parse().expect("valid ListenAddr"))
}
#[async_trait::async_trait]
impl Plugin for Subscription {
type Config = SubscriptionConfig;
async fn new(init: PluginInit<Self::Config>) -> Result<Self, BoxError> {
let mut callback_hmac_key = None;
if init.config.mode.callback.is_some() {
callback_hmac_key = Some(
SUBSCRIPTION_CALLBACK_HMAC_KEY
.get_or_init(|| Uuid::new_v4().to_string())
.clone(),
);
#[cfg(not(test))]
match init
.config
.mode
.callback
.as_ref()
.expect("we checked in the condition the callback conf")
.heartbeat_interval
{
HeartbeatInterval::Duration(duration) => {
init.notify.set_ttl(Some(duration)).await?;
}
HeartbeatInterval::Disabled(_) => {
init.notify.set_ttl(None).await?;
}
}
}
Ok(Subscription {
notify: init.notify,
callback_hmac_key,
config: init.config,
})
}
fn subgraph_service(
&self,
_subgraph_name: &str,
service: subgraph::BoxService,
) -> subgraph::BoxService {
let enabled = self.config.enabled
&& (self.config.mode.callback.is_some() || self.config.mode.passthrough.is_some());
ServiceBuilder::new()
.checkpoint(move |req: subgraph::Request| {
if req.operation_kind == OperationKind::Subscription && !enabled {
Ok(ControlFlow::Break(subgraph::Response::builder().context(req.context).error(graphql::Error::builder().message("cannot execute a subscription if it's not enabled in the configuration").extension_code("SUBSCRIPTION_DISABLED").build()).extensions(Object::default()).build()))
} else {
Ok(ControlFlow::Continue(req))
}
}).service(service)
.boxed()
}
fn web_endpoints(&self) -> MultiMap<ListenAddr, Endpoint> {
let mut map = MultiMap::new();
if let Some(CallbackMode { listen, path, .. }) = &self.config.mode.callback {
let path = path.clone().unwrap_or_else(default_path);
let path = path.trim_end_matches('/');
let callback_hmac_key = self
.callback_hmac_key
.clone()
.expect("cannot run subscription in callback mode without a hmac key");
let endpoint = Endpoint::from_router_service(
format!("{path}/:callback"),
CallbackService::new(self.notify.clone(), path.to_string(), callback_hmac_key)
.boxed(),
);
map.insert(listen.clone().unwrap_or_else(default_listen_addr), endpoint);
}
map
}
}
#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(tag = "kind", rename = "lowercase")]
pub(crate) enum CallbackPayload {
#[serde(rename = "subscription")]
Subscription(SubscriptionPayload),
}
impl CallbackPayload {
fn id(&self) -> &String {
match self {
CallbackPayload::Subscription(subscription_payload) => subscription_payload.id(),
}
}
fn verifier(&self) -> &String {
match self {
CallbackPayload::Subscription(subscription_payload) => subscription_payload.verifier(),
}
}
}
#[derive(Debug, Clone, PartialEq, Eq, Default, Deserialize, Serialize, JsonSchema)]
#[serde(deny_unknown_fields, default)]
/// Callback payload when a subscription id is incorrect
pub(crate) struct InvalidIdsPayload {
/// List of invalid ids
pub(crate) invalid_ids: Vec<String>,
pub(crate) id: String,
pub(crate) verifier: String,
}
#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(tag = "action", rename = "lowercase")]
pub(crate) enum SubscriptionPayload {
#[serde(rename = "check")]
Check { id: String, verifier: String },
#[serde(rename = "heartbeat")]
Heartbeat {
/// Id sent with the corresponding verifier
id: String,
/// List of ids to heartbeat
ids: Vec<String>,
/// Verifier received with the corresponding id
verifier: String,
},
#[serde(rename = "next")]
Next {
id: String,
payload: Response,
verifier: String,
},
#[serde(rename = "complete")]
Complete {
id: String,
verifier: String,
errors: Option<Vec<graphql::Error>>,
},
}
impl SubscriptionPayload {
fn id(&self) -> &String {
match self {
SubscriptionPayload::Check { id, .. }
| SubscriptionPayload::Heartbeat { id, .. }
| SubscriptionPayload::Next { id, .. }
| SubscriptionPayload::Complete { id, .. } => id,
}
}
fn verifier(&self) -> &String {
match self {
SubscriptionPayload::Check { verifier, .. }
| SubscriptionPayload::Heartbeat { verifier, .. }
| SubscriptionPayload::Next { verifier, .. }
| SubscriptionPayload::Complete { verifier, .. } => verifier,
}
}
}
#[derive(Clone)]
pub(crate) struct CallbackService {
notify: Notify<String, graphql::Response>,
path: String,
callback_hmac_key: String,
}
impl CallbackService {
pub(crate) fn new(
notify: Notify<String, graphql::Response>,
path: String,
callback_hmac_key: String,
) -> Self {
Self {
notify,
path,
callback_hmac_key,
}
}
}
impl Service<router::Request> for CallbackService {
type Response = router::Response;
type Error = BoxError;
type Future = BoxFuture<'static, Result<Self::Response, Self::Error>>;
fn poll_ready(&mut self, _: &mut std::task::Context<'_>) -> Poll<Result<(), Self::Error>> {
Ok(()).into()
}
fn call(&mut self, req: router::Request) -> Self::Future {
let mut notify = self.notify.clone();
let path = self.path.clone();
let callback_hmac_key = self.callback_hmac_key.clone();
Box::pin(
async move {
let (parts, body) = req.router_request.into_parts();
let sub_id = parts
.uri
.path()
.trim_start_matches(&format!("{path}/"))
.to_string();
match parts.method {
Method::POST => {
let cb_body = hyper::body::to_bytes(body)
.await
.map_err(|e| format!("failed to get the request body: {e}"))
.and_then(|bytes| {
serde_json::from_reader::<_, CallbackPayload>(bytes.reader())
.map_err(|err| {
format!(
"failed to deserialize the request body into JSON: {err}"
)
})
});
let cb_body = match cb_body {
Ok(cb_body) => cb_body,
Err(err) => {
return Ok(router::Response {
response: http::Response::builder()
.status(StatusCode::BAD_REQUEST)
.body(err.into())
.map_err(BoxError::from)?,
context: req.context,
});
}
};
let id = cb_body.id().clone();
// Hash verifier to sha256 to mitigate timing attack
// Check verifier
let verifier = cb_body.verifier();
let mut verifier_hasher = Sha256::new();
verifier_hasher.update(verifier.as_bytes());
let hashed_verifier = verifier_hasher.finalize();
let mut mac = HmacSha256::new_from_slice(callback_hmac_key.as_bytes())?;
mac.update(id.as_bytes());
let result = mac.finalize();
let expected_verifier = hex::encode(result.into_bytes());
let mut verifier_hasher = Sha256::new();
verifier_hasher.update(expected_verifier.as_bytes());
let expected_hashed_verifier = verifier_hasher.finalize();
if hashed_verifier != expected_hashed_verifier {
return Ok(router::Response {
response: http::Response::builder()
.status(StatusCode::UNAUTHORIZED)
.body("verifier doesn't match".into())
.map_err(BoxError::from)?,
context: req.context,
});
}
if let Err(res) = ensure_id_consistency(&req.context, &sub_id, &id) {
return Ok(res);
}
match cb_body {
CallbackPayload::Subscription(SubscriptionPayload::Next {
mut payload,
..
}) => {
let mut handle = match notify.subscribe_if_exist(id).await? {
Some(handle) => handle.into_sink(),
None => {
return Ok(router::Response {
response: http::Response::builder()
.status(StatusCode::NOT_FOUND)
.body("suscription doesn't exist".into())
.map_err(BoxError::from)?,
context: req.context,
});
}
};
// Keep the subscription to the client opened
payload.subscribed = Some(true);
tracing::info!(
monotonic_counter.apollo.router.operations.subscriptions.events = 1u64,
subscriptions.mode="callback"
);
handle.send_sync(payload)?;
Ok(router::Response {
response: http::Response::builder()
.status(StatusCode::OK)
.body::<hyper::Body>("".into())
.map_err(BoxError::from)?,
context: req.context,
})
}
CallbackPayload::Subscription(SubscriptionPayload::Check {
..
}) => {
if notify.exist(id).await? {
Ok(router::Response {
response: http::Response::builder()
.status(StatusCode::NO_CONTENT)
.header(HeaderName::from_static(CALLBACK_SUBSCRIPTION_HEADER_NAME), HeaderValue::from_static(CALLBACK_SUBSCRIPTION_HEADER_VALUE))
.body::<hyper::Body>("".into())
.map_err(BoxError::from)?,
context: req.context,
})
} else {
Ok(router::Response {
response: http::Response::builder()
.status(StatusCode::NOT_FOUND)
.header(HeaderName::from_static(CALLBACK_SUBSCRIPTION_HEADER_NAME), HeaderValue::from_static(CALLBACK_SUBSCRIPTION_HEADER_VALUE))
.body("suscription doesn't exist".into())
.map_err(BoxError::from)?,
context: req.context,
})
}
}
CallbackPayload::Subscription(SubscriptionPayload::Heartbeat {
ids,
id,
verifier,
}) => {
if !ids.contains(&id) {
return Ok(router::Response {
response: http::Response::builder()
.status(StatusCode::UNAUTHORIZED)
.body("id used for the verifier is not part of ids array".into())
.map_err(BoxError::from)?,
context: req.context,
});
}
let (mut valid_ids, invalid_ids) = notify.invalid_ids(ids).await?;
if invalid_ids.is_empty() {
Ok(router::Response {
response: http::Response::builder()
.status(StatusCode::NO_CONTENT)
.body::<hyper::Body>("".into())
.map_err(BoxError::from)?,
context: req.context,
})
} else if valid_ids.is_empty() {
Ok(router::Response {
response: http::Response::builder()
.status(StatusCode::NOT_FOUND)
.body("suscriptions don't exist".into())
.map_err(BoxError::from)?,
context: req.context,
})
} else {
let (id, verifier) = if invalid_ids.contains(&id) {
(id, verifier)
} else {
let new_id = valid_ids.pop().expect("valid_ids is not empty, checked in the previous if block");
// Generate new verifier
let mut mac = HmacSha256::new_from_slice(
callback_hmac_key.as_bytes(),
)?;
mac.update(new_id.as_bytes());
let result = mac.finalize();
let verifier = hex::encode(result.into_bytes());
(new_id, verifier)
};
Ok(router::Response {
response: http::Response::builder()
.status(StatusCode::NOT_FOUND)
.body(serde_json::to_string_pretty(&InvalidIdsPayload{
invalid_ids,
id,
verifier,
})?.into())
.map_err(BoxError::from)?,
context: req.context,
})
}
}
CallbackPayload::Subscription(SubscriptionPayload::Complete {
errors,
..
}) => {
if let Some(errors) = errors {
let mut handle =
notify.subscribe(id.clone()).await?.into_sink();
tracing::info!(
monotonic_counter.apollo.router.operations.subscriptions.events = 1u64,
subscriptions.mode="callback",
subscriptions.complete=true
);
handle.send_sync(
graphql::Response::builder().errors(errors).build(),
)?;
}
notify.force_delete(id).await?;
Ok(router::Response {
response: http::Response::builder()
.status(StatusCode::ACCEPTED)
.body::<hyper::Body>("".into())
.map_err(BoxError::from)?,
context: req.context,
})
}
}
}
_ => Ok(router::Response {
response: http::Response::builder()
.status(StatusCode::METHOD_NOT_ALLOWED)
.body::<hyper::Body>("".into())
.map_err(BoxError::from)?,
context: req.context,
}),
}
}
.instrument(tracing::info_span!("subscription_callback")),
)
}
}
pub(crate) fn create_verifier(sub_id: &str) -> Result<String, BoxError> {
let callback_hmac_key = SUBSCRIPTION_CALLBACK_HMAC_KEY
.get()
.ok_or("subscription callback hmac key is not available")?;
let mut mac = HmacSha256::new_from_slice(callback_hmac_key.as_bytes())?;
mac.update(sub_id.as_bytes());
let result = mac.finalize();
let verifier = hex::encode(result.into_bytes());
Ok(verifier)
}
fn ensure_id_consistency(
context: &Context,
id_from_path: &str,
id_from_body: &str,
) -> Result<(), router::Response> {
(id_from_path != id_from_body)
.then(|| {
Err(router::Response {
response: http::Response::builder()
.status(StatusCode::BAD_REQUEST)
.body::<hyper::Body>("id from url path and id from body are different".into())
.expect("this body is valid"),
context: context.clone(),
})
})
.unwrap_or_else(|| Ok(()))
}
#[cfg(test)]
mod tests {
use std::str::FromStr;
use std::sync::Arc;
use futures::StreamExt;
use serde_json::Value;
use tower::util::BoxService;
use tower::Service;
use tower::ServiceExt;
use super::*;
use crate::graphql::Request;
use crate::http_ext;
use crate::plugin::test::MockSubgraphService;
use crate::plugin::DynPlugin;
use crate::services::SubgraphRequest;
use crate::services::SubgraphResponse;
use crate::Notify;
#[tokio::test(flavor = "multi_thread")]
async fn it_test_callback_endpoint() {
let mut notify = Notify::builder().build();
let dyn_plugin: Box<dyn DynPlugin> = crate::plugin::plugins()
.find(|factory| factory.name == APOLLO_SUBSCRIPTION_PLUGIN)
.expect("Plugin not found")
.create_instance(
&Value::from_str(
r#"{
"enabled": true,
"mode": {
"callback": {
"public_url": "http://localhost:4000/subscription/callback",
"path": "/subscription/callback",
"subgraphs": ["test"]
}
}
}"#,
)
.unwrap(),
Default::default(),
Arc::new(apollo_compiler::validation::Valid::assume_valid(
apollo_compiler::Schema::new(),
)),
notify.clone(),
)
.await
.unwrap();
let http_req_prom = http::Request::get("http://localhost:4000/subscription/callback")
.body(Default::default())
.unwrap();
let mut web_endpoint = dyn_plugin
.web_endpoints()
.into_iter()
.next()
.unwrap()
.1
.into_iter()
.next()
.unwrap()
.into_router();
let resp = web_endpoint
.ready()
.await
.unwrap()
.call(http_req_prom)
.await
.unwrap();
assert_eq!(resp.status(), http::StatusCode::NOT_FOUND);
let new_sub_id = uuid::Uuid::new_v4().to_string();
let (handler, _created) = notify
.create_or_subscribe(new_sub_id.clone(), true)
.await
.unwrap();
let verifier = create_verifier(&new_sub_id).unwrap();
let http_req = http::Request::post(format!(
"http://localhost:4000/subscription/callback/{new_sub_id}"
))
.body(hyper::Body::from(
serde_json::to_vec(&CallbackPayload::Subscription(SubscriptionPayload::Check {
id: new_sub_id.clone(),
verifier: verifier.clone(),
}))
.unwrap(),
))
.unwrap();
let resp = web_endpoint.clone().oneshot(http_req).await.unwrap();
assert_eq!(resp.status(), http::StatusCode::NO_CONTENT);
assert_eq!(
resp.headers()
.get(HeaderName::from_static(CALLBACK_SUBSCRIPTION_HEADER_NAME))
.unwrap(),
HeaderValue::from_static(CALLBACK_SUBSCRIPTION_HEADER_VALUE)
);
let http_req = http::Request::post(format!(
"http://localhost:4000/subscription/callback/{new_sub_id}"
))
.body(hyper::Body::from(
serde_json::to_vec(&CallbackPayload::Subscription(SubscriptionPayload::Next {
id: new_sub_id.clone(),
payload: graphql::Response::builder()
.data(serde_json_bytes::json!({"userWasCreated": {"username": "ada_lovelace"}}))
.build(),
verifier: verifier.clone(),
}))
.unwrap(),
))
.unwrap();
let resp = web_endpoint.clone().oneshot(http_req).await.unwrap();
assert_eq!(resp.status(), http::StatusCode::OK);
let mut handler = handler.into_stream();
let msg = handler.next().await.unwrap();
assert_eq!(
msg,
graphql::Response::builder()
.subscribed(true)
.data(serde_json_bytes::json!({"userWasCreated": {"username": "ada_lovelace"}}))
.build()
);
drop(handler);
// Should answer NOT FOUND because I dropped the only existing handler and so no one is still listening to the sub
let http_req = http::Request::post(format!(
"http://localhost:4000/subscription/callback/{new_sub_id}"
))
.body(hyper::Body::from(
serde_json::to_vec(&CallbackPayload::Subscription(SubscriptionPayload::Next {
id: new_sub_id.clone(),
payload: graphql::Response::builder()
.data(serde_json_bytes::json!({"userWasCreated": {"username": "ada_lovelace"}}))
.build(),
verifier: verifier.clone(),
}))
.unwrap(),
))
.unwrap();
let resp = web_endpoint.clone().oneshot(http_req).await.unwrap();
assert_eq!(resp.status(), http::StatusCode::NOT_FOUND);
// Should answer NOT FOUND because I dropped the only existing handler and so no one is still listening to the sub
let http_req = http::Request::post(format!(
"http://localhost:4000/subscription/callback/{new_sub_id}"
))
.body(hyper::Body::from(
serde_json::to_vec(&CallbackPayload::Subscription(
SubscriptionPayload::Heartbeat {
id: new_sub_id.clone(),
ids: vec![new_sub_id, "FAKE_SUB_ID".to_string()],
verifier: verifier.clone(),
},
))
.unwrap(),
))
.unwrap();
let resp = web_endpoint.oneshot(http_req).await.unwrap();
assert_eq!(resp.status(), http::StatusCode::NOT_FOUND);
}
#[tokio::test(flavor = "multi_thread")]
async fn it_test_callback_endpoint_with_bad_verifier() {
let mut notify = Notify::builder().build();
let dyn_plugin: Box<dyn DynPlugin> = crate::plugin::plugins()
.find(|factory| factory.name == APOLLO_SUBSCRIPTION_PLUGIN)
.expect("Plugin not found")
.create_instance(
&Value::from_str(
r#"{
"enabled": true,
"mode": {
"callback": {
"public_url": "http://localhost:4000/subscription/callback",
"path": "/subscription/callback",
"subgraphs": ["test"]
}
}
}"#,
)
.unwrap(),
Default::default(),
Arc::new(apollo_compiler::validation::Valid::assume_valid(
apollo_compiler::Schema::new(),
)),
notify.clone(),
)
.await
.unwrap();
let http_req_prom = http::Request::get("http://localhost:4000/subscription/callback")
.body(Default::default())
.unwrap();
let mut web_endpoint = dyn_plugin
.web_endpoints()
.into_iter()
.next()
.unwrap()
.1
.into_iter()
.next()
.unwrap()
.into_router();
let resp = web_endpoint
.ready()
.await
.unwrap()
.call(http_req_prom)
.await
.unwrap();
assert_eq!(resp.status(), http::StatusCode::NOT_FOUND);
let new_sub_id = uuid::Uuid::new_v4().to_string();
let (_handler, _created) = notify
.create_or_subscribe(new_sub_id.clone(), true)
.await
.unwrap();
let verifier = String::from("XXX");
let http_req = http::Request::post(format!(
"http://localhost:4000/subscription/callback/{new_sub_id}"
))
.body(hyper::Body::from(
serde_json::to_vec(&CallbackPayload::Subscription(SubscriptionPayload::Check {
id: new_sub_id.clone(),
verifier: verifier.clone(),
}))
.unwrap(),
))
.unwrap();
let resp = web_endpoint.clone().oneshot(http_req).await.unwrap();
assert_eq!(resp.status(), http::StatusCode::UNAUTHORIZED);
let http_req = http::Request::post(format!(
"http://localhost:4000/subscription/callback/{new_sub_id}"
))
.body(hyper::Body::from(
serde_json::to_vec(&CallbackPayload::Subscription(SubscriptionPayload::Next {
id: new_sub_id.clone(),
payload: graphql::Response::builder()
.data(serde_json_bytes::json!({"userWasCreated": {"username": "ada_lovelace"}}))
.build(),
verifier: verifier.clone(),
}))
.unwrap(),
))
.unwrap();
let resp = web_endpoint.clone().oneshot(http_req).await.unwrap();
assert_eq!(resp.status(), http::StatusCode::UNAUTHORIZED);
}
#[tokio::test(flavor = "multi_thread")]
async fn it_test_callback_endpoint_with_complete_subscription() {
let mut notify = Notify::builder().build();
let dyn_plugin: Box<dyn DynPlugin> = crate::plugin::plugins()
.find(|factory| factory.name == APOLLO_SUBSCRIPTION_PLUGIN)
.expect("Plugin not found")
.create_instance(
&Value::from_str(
r#"{
"enabled": true,
"mode": {
"callback": {
"public_url": "http://localhost:4000/subscription/callback",
"path": "/subscription/callback",
"subgraphs": ["test"]
}
}
}"#,
)
.unwrap(),
Default::default(),
Arc::new(apollo_compiler::validation::Valid::assume_valid(
apollo_compiler::Schema::new(),
)),
notify.clone(),
)
.await
.unwrap();
let http_req_prom = http::Request::get("http://localhost:4000/subscription/callback")
.body(Default::default())
.unwrap();
let mut web_endpoint = dyn_plugin
.web_endpoints()
.into_iter()
.next()
.unwrap()
.1
.into_iter()
.next()
.unwrap()
.into_router();
let resp = web_endpoint
.ready()
.await
.unwrap()
.call(http_req_prom)
.await
.unwrap();
assert_eq!(resp.status(), http::StatusCode::NOT_FOUND);
let new_sub_id = uuid::Uuid::new_v4().to_string();
let (handler, _created) = notify
.create_or_subscribe(new_sub_id.clone(), true)
.await
.unwrap();
let verifier = create_verifier(&new_sub_id).unwrap();
let http_req = http::Request::post(format!(
"http://localhost:4000/subscription/callback/{new_sub_id}"
))
.body(hyper::Body::from(
serde_json::to_vec(&CallbackPayload::Subscription(SubscriptionPayload::Check {
id: new_sub_id.clone(),
verifier: verifier.clone(),
}))
.unwrap(),
))
.unwrap();
let resp = web_endpoint.clone().oneshot(http_req).await.unwrap();
assert_eq!(resp.status(), http::StatusCode::NO_CONTENT);
assert_eq!(
resp.headers()
.get(HeaderName::from_static(CALLBACK_SUBSCRIPTION_HEADER_NAME))
.unwrap(),
HeaderValue::from_static(CALLBACK_SUBSCRIPTION_HEADER_VALUE)
);
let http_req = http::Request::post(format!(
"http://localhost:4000/subscription/callback/{new_sub_id}"
))
.body(hyper::Body::from(
serde_json::to_vec(&CallbackPayload::Subscription(SubscriptionPayload::Next {
id: new_sub_id.clone(),
payload: graphql::Response::builder()
.data(serde_json_bytes::json!({"userWasCreated": {"username": "ada_lovelace"}}))
.build(),
verifier: verifier.clone(),
}))
.unwrap(),
))
.unwrap();
let resp = web_endpoint.clone().oneshot(http_req).await.unwrap();