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
//! This module provides the Warpgrapher client. use crate::engine::context::{GlobalContext, RequestContext}; use crate::{Engine, Error}; use inflector::Inflector; use juniper::http::GraphQLRequest; use log::{debug, trace}; use reqwest::header::{HeaderMap, HeaderName, HeaderValue}; use serde_json::{from_value, json, Value}; use std::collections::HashMap; use std::fmt::Display; use std::str::FromStr; use std::sync::mpsc; use std::thread; /// A Warpgrapher GraphQL client /// /// The [`Client`] provides a set of CRUD operations that will /// automatically generate GraphQL queries that conform to the wargrapher API /// /// [`Client`]: ./enum.Client.html /// /// # Examples /// /// ```rust /// # use warpgrapher::Client; /// /// let client = Client::<(), ()>::new_with_http("http://localhost:5000/graphql", None).unwrap(); /// ``` #[derive(Clone, Debug)] pub enum Client<GlobalCtx, RequestCtx> where GlobalCtx: GlobalContext, RequestCtx: RequestContext, { Http { endpoint: String, headers: HeaderMap, }, Local { engine: Box<Engine<GlobalCtx, RequestCtx>>, metadata: Option<HashMap<String, String>>, }, } impl<GlobalCtx, RequestCtx> Client<GlobalCtx, RequestCtx> where GlobalCtx: GlobalContext, RequestCtx: RequestContext, { /// Takes the URL of a Warpgrapher service endpoint and returns a new ['Client'] initialized to /// query that endpoint. The type parameters are only relevant for a local instance of the /// Warpgrapher engine, not for a remote HTTP client, so pass () for both type parameters, as /// shown in the example below. /// /// [`Client`]: ./enum.Client.html /// /// /// # Examples /// /// ```rust /// # use warpgrapher::Client; /// /// let mut client = Client::<(), ()>::new_with_http("http://localhost:5000/graphql", None).unwrap(); /// ``` pub fn new_with_http( endpoint: &str, headers_opt: Option<HashMap<&str, &str>>, ) -> Result<Client<(), ()>, Error> { trace!("Client::new_with_http called -- endpoint: {}", endpoint); let mut header_map = HeaderMap::new(); if let Some(headers) = headers_opt { for (key, value) in headers { let header_name = HeaderName::from_str(key) .map_err(|e| Error::InvalidHeaderName { source: e })?; let header_value = HeaderValue::from_str(value) .map_err(|e| Error::InvalidHeaderValue { source: e })?; header_map.insert(header_name, header_value); } } Ok(Client::Http { endpoint: endpoint.to_string(), headers: header_map, }) } /// Takes a Warpgrapher engine and returns a new ['Client'] initialized to query that engine. /// The type parameters are the [`GlobalContext`] and [`RequestContext`] used by the engine. /// /// [`Client`]: ./enum.Client.html /// [`GlobalContext`]: ../engine/context/trait.GlobalContext.html /// [`RequestContext`]: ../engine/context/trait.RequestContext.html /// /// # Examples /// /// ```rust /// # use warpgrapher::{Client, Configuration, DatabasePool, Engine}; /// /// # fn main() -> Result<(), Box<dyn std::error::Error>> { /// let c = Configuration::new(1, Vec::new(), Vec::new()); /// let engine = Engine::new(c, DatabasePool::NoDatabase).build()?; /// /// let mut client = Client::<(), ()>::new_with_engine(engine, None); /// # Ok(()) /// # } /// ``` pub fn new_with_engine( engine: Engine<GlobalCtx, RequestCtx>, metadata: Option<HashMap<String, String>>, ) -> Client<GlobalCtx, RequestCtx> { trace!("Client::new_with_engine called"); Client::Local { engine: Box::new(engine), metadata, } } /// Executes a graphql query /// /// # Arguments /// /// * query - text of the query statement, parameterized to avoid query injection attacks /// * partition_key - used to scope a query to a Cosmos DB partition. In future, when Neo4J is /// supported, it is anticipated that the partition_key will be used to select among Neo4J /// fabric shards. /// * input - a [`serde_json::Value`], specifically a Value::Object, containing the arguments /// to the graph query /// * result_field - an optional name of a field under 'data' that holds the GraphQL response. /// If present, the object with name `result_field` under `data` will be returned. If `None`, /// the `data` object will be returned. /// /// [`Client`]: ./enum.Client.html /// /// # Return /// /// A [`serde_json::Value`] containing the query response /// /// # Errors /// /// * [`ClientRequestFailed`] - if the HTTP response is a non-OK /// * [`ClientRequestUnexepctedPayload`] - if the JSON response body is not a valid GraphQL /// response /// /// [`ClientRequestFailed`]: ../enum.Error.html#variant.ClientRequestFailed /// [`ClientRequestUnexpectedPayload`]: ../enum.Error.html#variant.ClientRequestUnexpectedPayload /// /// # Examples /// /// ```rust,no_run /// # use warpgrapher::Client;; /// /// # #[tokio::main] /// # async fn main() { /// let mut client = Client::<(), ()>::new_with_http("http://localhost:5000/graphql", None).unwrap(); /// /// let query = "query { Project { id name } }"; /// let results = client.graphql("query { Project { id name } }", Some("1234"), None, /// Some("Project")).await; /// # } /// ``` pub async fn graphql( &mut self, query: &str, partition_key: Option<&str>, input: Option<&Value>, result_field_opt: Option<&str>, ) -> Result<Value, Error> { trace!( "Client::graphql called -- query: {} | partition_key: {:#?} | input: {:#?} | result_field: {:#?}", query, partition_key, input, result_field_opt, ); // format request body let req_body = json!({ "query": query.to_string(), "variables": { "partitionKey": partition_key, "input": input } }); debug!("Client::graphql making request -- req_body: {}", req_body); let mut body = match self { Client::Http { endpoint, headers } => { let client = reqwest::Client::new(); let response = client .post(endpoint.as_str()) .headers(headers.clone()) .json(&req_body) .send() .await?; response.json::<serde_json::Value>().await? } Client::Local { engine, metadata } => { let metadata: HashMap<String, String> = metadata.clone().unwrap_or_default(); let engine = engine.clone(); let (tx, rx) = mpsc::channel(); thread::spawn(move || { let result = from_value::<GraphQLRequest>(req_body) .map_err(|e| e.into()) .and_then(|req| engine.execute(&req, &metadata)); let _ = tx.send(result); }) .join() .expect("Thread panicked"); rx.recv()?? } }; debug!("Client::graphql -- response body: {:#?}", body); if let Some(result_field) = result_field_opt { body.as_object_mut() .and_then(|m| m.remove("data")) .and_then(|mut d| d.as_object_mut().and_then(|dm| dm.remove(result_field))) .ok_or_else(|| Error::PayloadNotFound { response: body.to_owned(), }) } else { body.as_object_mut() .and_then(|m| m.remove("data")) .ok_or_else(|| Error::PayloadNotFound { response: body.to_owned(), }) } } /// Creates a node /// /// # Arguments /// /// * type_name - the name of the [`Type`] for which to create a node /// * shape - the GraphQL query shape, meaning the selection of objects and properties to be /// returned in the query result /// * partition_key - the partition_key is used to scope a query to a Cosmos DB partition. In /// future, when Neo4J is supported, it is anticipated that the partition_key will be used to /// select among Neo4J fabric shards. /// * input - a [`serde_json::Value`], specifically a Value::Object, containing the arguments /// to the graph query /// /// [`Type`]: ../engine/config/struct.Type.html /// /// # Return /// /// A [`serde_json::Value`] containing the query response /// /// # Errors /// /// Returns an [`Error`] of the following kinds: /// /// * [`ClientRequestFailed`] - if the HTTP response is a non-OK /// * [`ClientRequestUnexepctedPayload`] - if the JSON response body is not a valid GraphQL /// response /// /// [`ClientRequestFailed`]: ../enum.Error.html#variant.ClientRequestFailed /// [`ClientRequestUnexpectedPayload`]: ../enum.Error.html#variant.ClientRequestUnexpectedPayload /// /// # Examples /// /// ```no_run /// # use serde_json::json; /// # use warpgrapher::Client;; /// /// # #[tokio::main] /// # async fn main() { /// let mut client = Client::<(), ()>::new_with_http("http://localhost:5000/graphql", None).unwrap(); /// /// let projects = client.create_node("Project", "id name description", Some("1234"), /// &json!({"name": "TodoApp", "description": "TODO list tracking application"})).await; /// # } /// ``` pub async fn create_node( &mut self, type_name: &str, shape: &str, partition_key: Option<&str>, input: &Value, ) -> Result<Value, Error> { trace!( "Client::create_node called -- type_name: {} | shape: {} | partition_key: {:#?} | input: {:#?}", type_name, shape, partition_key, input ); let query = Client::<(), ()>::fmt_create_node_query(type_name, shape); let result_field = type_name.to_string() + "Create"; self.graphql(&query, partition_key, Some(input), Some(&result_field)) .await } /// Creates one or more relationships /// /// # Arguments /// /// * type_name - the name of the [`Type`] for which to create a relationship /// * rel_name - the name of the [`Relationship`] to create /// * shape - the GraphQL query shape, meaning the selection of objects and properties to be /// returned in the query result /// * partition_key - the partition_key is used to scope a query to a Cosmos DB partition. In /// future, when Neo4J is supported, it is anticipated that the partition_key will be used to /// select among Neo4J fabric shards. /// * match_input - a [`serde_json::Value`], specifically a Value::Object, containing the /// arguments to the graph query to select the node(s) on which to create the relationship /// * create_input - a [`serde_json::Value`], specifically a Value::Object, containing the /// arguments to the graph query to use in creating the relationship /// /// [`Relationship`]: ../engine/config/struct.Relationship.html /// [`Type`]: ../engine/config/struct.Type.html /// /// # Return /// /// A [`serde_json::Value`] containing the query response /// /// # Errors /// /// Returns an [`Error`] of the following kinds: /// /// * [`ClientRequestFailed`] - if the HTTP response is a non-OK /// * [`ClientRequestUnexepctedPayload`] - if the JSON response body is not a valid GraphQL /// response /// /// [`ClientRequestFailed`]: ../enum.Error.html#variant.ClientRequestFailed /// [`ClientRequestUnexpectedPayload`]: ../enum.Error.html#variant.ClientRequestUnexpectedPayload /// /// # Examples /// /// ```no_run /// # use serde_json::json; /// # use warpgrapher::Client;; /// /// # #[tokio::main] /// # async fn main() { /// let mut client = Client::<(), ()>::new_with_http("http:://localhost:5000/graphql", None).unwrap(); /// /// let proj_issues = client.create_rel("Project", /// "issues", /// "id props { since } src { id name } dst { id name }", /// Some("1234"), /// &json!({"name": "ProjectName"}), /// &json!({"props": {"since": "2000"}, /// "dst": {"Feature": {"NEW": {"name": "NewFeature"}}}}) /// ).await; /// # } /// ``` pub async fn create_rel( &mut self, type_name: &str, rel_name: &str, shape: &str, partition_key: Option<&str>, match_input: &Value, create_input: &Value, ) -> Result<Value, Error> { trace!( "Client::create_rel called -- type_name: {} | rel_name: {} | shape: {} | partition_key: {:#?} | match_input: {:#?} | create_input: {:#?}", type_name, rel_name, shape, partition_key, match_input, create_input ); let query = Client::<(), ()>::fmt_create_rel_query(type_name, rel_name, shape); let input = json!({"match": match_input, "create": create_input}); let result_field = type_name.to_string() + &((&rel_name.to_string().to_title_case()) .split_whitespace() .collect::<String>()) + "Create"; self.graphql(&query, partition_key, Some(&input), Some(&result_field)) .await } /// Deletes one or more nodes /// /// # Arguments /// /// * type_name - the name of the [`Type`] of the node to delete /// * partition_key - the partition_key is used to scope a query to a Cosmos DB partition. In /// future, when Neo4J is supported, it is anticipated that the partition_key will be used to /// select among Neo4J fabric shards. /// * match_input - a [`serde_json::Value`], specifically a Value::Object, containing the /// arguments to the graph query to select the node(s) on which to create the relationship /// * delete_input - a [`serde_json::Value`], specifically a Value::Object, containing the /// arguments to the graph query to use in deleting the relationship. By default, all /// relationships incoming to and outgoing from the node are deleted. The delete input argument /// allows for extending the delete operation through relationships to destination nodes. /// /// [`Type`]: ../engine/config/struct.Type.html /// /// # Return /// /// A [`serde_json::Value`] containing the query response, a count of the nodes deleted /// /// # Errors /// /// Returns an [`Error`] of the following kinds: /// /// * [`ClientRequestFailed`] - if the HTTP response is a non-OK /// * [`ClientRequestUnexepctedPayload`] - if the JSON response body is not a valid GraphQL /// response /// /// [`ClientRequestFailed`]: ../enum.Error.html#variant.ClientRequestFailed /// [`ClientRequestUnexpectedPayload`]: ../enum.Error.html#variant.ClientRequestUnexpectedPayload /// /// # Examples /// /// ```no_run /// # use warpgrapher::Client;; /// # use serde_json::json; /// /// # #[tokio::main] /// # async fn main() { /// let mut client = Client::<(), ()>::new_with_http("http://localhost:5000/graphql", None).unwrap(); /// /// let projects = client.delete_node("Project", Some("1234"), /// Some(&json!({"name": "MJOLNIR"})), None).await; /// # } /// ``` pub async fn delete_node( &mut self, type_name: &str, partition_key: Option<&str>, match_input: Option<&Value>, delete_input: Option<&Value>, ) -> Result<Value, Error> { trace!( "Client::delete_node called -- type_name: {} | partition_key: {:#?} | match_input: {:#?} | delete_input: {:#?}", type_name, partition_key, match_input, delete_input ); let query = Client::<(), ()>::fmt_delete_node_query(type_name); let input = json!({"match": match_input, "delete": delete_input}); let result_field = type_name.to_string() + "Delete"; self.graphql(&query, partition_key, Some(&input), Some(&result_field)) .await } /// Deletes one or more relationships /// /// # Arguments /// /// * type_name - the name of the [`Type`] for which to delete a relationship /// * rel_name - the name of the [`Relationship`] to delete /// * partition_key - the partition_key is used to scope a query to a Cosmos DB partition. In /// future, when Neo4J is supported, it is anticipated that the partition_key will be used to /// select among Neo4J fabric shards. /// * match_input - a [`serde_json::Value`], specifically a Value::Object, containing the /// arguments to the graph query to select the relationship(s) to delete /// * src_input - a [`serde_json::Value`], specifically a Value::Object, containing the /// arguments to the graph query to use in deleting the src node. By default, nodes are not /// deleted along with a relationship, but this parameter can be used to delete the source of /// the relationship as well. /// * dst_input - a [`serde_json::Value`], specifically a Value::Object, containing the /// arguments to the graph query to use in deleting the destination node. By default, nodes are /// not deleted along with a relationship, but this parameter can be used to delete the /// destination node of the relationship as well. /// /// [`Relationship`]: ../engine/config/struct.Relationship.html /// [`Type`]: ../engine/config/struct.Type.html /// /// # Return /// /// A [`serde_json::Value`] containing the query response, a count of the relationships deleted /// /// # Errors /// /// Returns an [`Error`] of the following kinds: /// /// * [`ClientRequestFailed`] - if the HTTP response is a non-OK /// * [`ClientRequestUnexepctedPayload`] - if the JSON response body is not a valid GraphQL /// response /// /// [`ClientRequestFailed`]: ../enum.Error.html#variant.ClientRequestFailed /// [`ClientRequestUnexpectedPayload`]: ../enum.Error.html#variant.ClientRequestUnexpectedPayload /// /// # Examples /// /// ```no_run /// # use serde_json::json; /// # use warpgrapher::Client;; /// /// # #[tokio::main] /// # async fn main() { /// let mut client = Client::<(), ()>::new_with_http("http:://localhost:5000/graphql", None).unwrap(); /// /// let proj_issues = client.delete_rel("Project", "issues", /// Some("1234"), /// Some(&json!({"props": {"since": "2000"}})), /// None, /// Some(&json!({"Bug": {}})) /// ).await; /// # } /// ``` pub async fn delete_rel( &mut self, type_name: &str, rel_name: &str, partition_key: Option<&str>, match_input: Option<&Value>, src_input: Option<&Value>, dst_input: Option<&Value>, ) -> Result<Value, Error> { trace!( "Client::delete_rel called -- type_name: {} | rel_name: {} | partition_key: {:#?} | match_input: {:#?} | src_input: {:#?} | dst_input: {:#?}", type_name, rel_name, partition_key, match_input, src_input, dst_input ); let query = Client::<(), ()>::fmt_delete_rel_query(type_name, rel_name); let mut m = HashMap::new(); if let Some(mi) = match_input { m.insert("match".to_string(), mi); } if let Some(src) = src_input { m.insert("src".to_string(), src); } if let Some(dst) = dst_input { m.insert("dst".to_string(), dst); } let value: serde_json::Value; let input = if m.is_empty() { None } else { value = json!(m); Some(&value) }; let result_field = type_name.to_string() + &((&rel_name.to_string().to_title_case()) .split_whitespace() .collect::<String>()) + "Delete"; self.graphql(&query, partition_key, input, Some(&result_field)) .await } /// Queries to retrieve one or more nodes /// /// # Arguments /// /// * type_name - the name of the [`Type`] to be retrieved /// * shape - the GraphQL query shape, meaning the selection of objects and properties to be /// returned in the query result /// * partition_key - the partition_key is used to scope a query to a Cosmos DB partition. In /// future, when Neo4J is supported, it is anticipated that the partition_key will be used to /// select among Neo4J fabric shards. /// * input - a [`serde_json::Value`], specifically a Value::Object, containing the arguments /// to the graph query /// /// [`Type`]: ../engine/config/struct.Type.html /// /// # Return /// /// A [`Value`] containing the query response /// /// # Errors /// /// Returns an [`Error`] of the following kinds: /// /// * [`ClientRequestFailed`] - if the HTTP response is a non-OK /// * [`ClientRequestUnexepctedPayload`] - if the JSON response body is not a valid GraphQL /// response /// /// [`ClientRequestFailed`]: ../enum.Error.html#variant.ClientRequestFailed /// [`ClientRequestUnexpectedPayload`]: ../enum.Error.html#variant.ClientRequestUnexpectedPayload /// /// # Examples /// /// ```no_run /// # use warpgrapher::Client;; /// /// # #[tokio::main] /// # async fn main() { /// let mut client = Client::<(), ()>::new_with_http("http://localhost:5000/graphql", None).unwrap(); /// /// let projects = client.read_node("Project", "id name description", Some("1234"), /// None).await; /// # } /// ``` pub async fn read_node( &mut self, type_name: &str, shape: &str, partition_key: Option<&str>, input: Option<&Value>, ) -> Result<Value, Error> { trace!( "Client::read_node called -- type_name: {} | shape: {} | partition_key: {:#?} | input: {:#?} ", type_name, shape, partition_key, input, ); let query = Client::<(), ()>::fmt_read_node_query(type_name, shape); self.graphql(&query, partition_key, input, Some(type_name)) .await } /// Queries for one or more relationships /// /// # Arguments /// /// * type_name - the name of the [`Type`] for the source node in the relationship /// * rel_name - the name of the [`Relationship`] to find /// * shape - the GraphQL query shape, meaning the selection of objects and properties to be /// returned in the query result /// * partition_key - the partition_key is used to scope a query to a Cosmos DB partition. In /// future, when Neo4J is supported, it is anticipated that the partition_key will be used to /// select among Neo4J fabric shards. /// * input - a [`serde_json::Value`], specifically a Value::Object, containing the arguments /// to the graph query to select the relationship(s) to return /// /// [`Relationship`]: ../engine/config/struct.Relationship.html /// [`Type`]: ../engine/config/struct.Type.html /// /// # Return /// /// A [`serde_json::Value`] containing the query response /// /// # Errors /// /// Returns an [`Error`] of the following kinds: /// /// * [`ClientRequestFailed`] - if the HTTP response is a non-OK /// * [`ClientRequestUnexepctedPayload`] - if the JSON response body is not a valid GraphQL /// response /// /// [`ClientRequestFailed`]: ../enum.Error.html#variant.ClientRequestFailed /// [`ClientRequestUnexpectedPayload`]: ../enum.Error.html#variant.ClientRequestUnexpectedPayload /// /// # Examples /// /// ```rust,no_run /// # use serde_json::json; /// # use warpgrapher::Client;; /// /// # #[tokio::main] /// # async fn main() { /// let mut client = Client::<(), ()>::new_with_http("http:://localhost:5000/graphql", None).unwrap(); /// /// let proj_issues = client.read_rel("Project", "issues", "id props { since }", /// Some("1234"), Some(&json!({"props": {"since": "2000"}}))).await; /// # } /// ``` pub async fn read_rel( &mut self, type_name: &str, rel_name: &str, shape: &str, partition_key: Option<&str>, input: Option<&Value>, ) -> Result<Value, Error> { trace!( "Client::read_rel called -- type_name: {} | rel_name: {} | shape: {} | partition_key: {:#?} | input: {:#?} ", type_name, rel_name, shape, partition_key, input, ); let query = Client::<(), ()>::fmt_read_rel_query(type_name, rel_name, shape); let result_field = type_name.to_string() + &((&rel_name.to_string().to_title_case()) .split_whitespace() .collect::<String>()); self.graphql(&query, partition_key, input, Some(&result_field)) .await } /// Updates one or more nodes /// /// # Arguments /// /// * type_name - the name of the [`Type`] to be updated /// * shape - the GraphQL query shape, meaning the selection of objects and properties to be /// returned in the query result /// * partition_key - the partition_key is used to scope a query to a Cosmos DB partition. In /// future, when Neo4J is supported, it is anticipated that the partition_key will be used to /// select among Neo4J fabric shards. /// * match_input - a [`serde_json::Value`], specifically a Value::Object, containing the /// arguments to the graph query used to select the set of nodes to update /// * update_input - a [`serde_json::Value`], specifically a Value::Object, containing the /// arugments to the graph query used to change the properties of the nodes being updated /// /// [`Type`]: ../engine/config/struct.Type.html /// /// # Return /// /// A [`serde_json::Value`] containing the query response /// /// # Errors /// /// Returns an [`Error`] of the following kinds: /// /// * [`ClientRequestFailed`] - if the HTTP response is a non-OK /// * [`ClientRequestUnexepctedPayload`] - if the JSON response body is not a valid GraphQL /// response /// /// [`ClientRequestFailed`]: ../enum.Error.html#variant.ClientRequestFailed /// [`ClientRequestUnexpectedPayload`]: ../enum.Error.html#variant.ClientRequestUnexpectedPayload /// /// # Examples /// /// ```rust,no_run /// # use serde_json::json; /// # use warpgrapher::Client;; /// /// # #[tokio::main] /// # async fn main() { /// let mut client = Client::<(), ()>::new_with_http("http://localhost:5000/graphql", None).unwrap(); /// /// let projects = client.update_node("Project", "id name status", Some("1234"), /// Some(&json!({"name": "TodoApp"})), &json!({"status": "ACTIVE"})).await; /// # } /// ``` pub async fn update_node( &mut self, type_name: &str, shape: &str, partition_key: Option<&str>, match_input: Option<&Value>, update_input: &Value, ) -> Result<Value, Error> { trace!( "Client::update_node called -- type_name: {} | shape: {} | | partition_key: {:#?} | match_input: {:#?} | update_input: {:#?}", type_name, shape, partition_key, match_input, update_input ); let query = Client::<(), ()>::fmt_update_node_query(type_name, shape); let input = json!({"match": match_input, "modify": update_input}); let result_field = type_name.to_string() + "Update"; self.graphql(&query, partition_key, Some(&input), Some(&result_field)) .await } /// Updates one or more relationships /// /// # Arguments /// /// * type_name - the name of the [`Type`] for the source node in the relationship(s) to update /// * rel_name - the name of the [`Relationship`] to find and update /// * shape - the GraphQL query shape, meaning the selection of objects and properties to be /// returned in the query result /// * partition_key - the partition_key is used to scope a query to a Cosmos DB partition. In /// future, when Neo4J is supported, it is anticipated that the partition_key will be used to /// select among Neo4J fabric shards. /// * match_input - a [`serde_json::Value`], specifically a Value::Object, containing the /// arguments to the graph query used to select the set of relationships to update /// * update_input - a [`serde_json::Value`], specifically a Value::Object, containing the /// arguments to the graph query used to change the properties of the items being updated /// /// [`Relationship`]: ../engine/config/struct.Relationship.html /// [`Type`]: ../engine/config/struct.Type.html /// /// # Return /// /// A [`serde_json::Value`] containing the query response /// /// # Errors /// /// Returns an [`Error`] of the following kinds: /// /// * [`ClientRequestFailed`] - if the HTTP response is a non-OK /// * [`ClientRequestUnexepctedPayload`] - if the JSON response body is not a valid GraphQL /// response /// /// [`ClientRequestFailed`]: ../enum.Error.html#variant.ClientRequestFailed /// [`ClientRequestUnexpectedPayload`]: ../enum.Error.html#variant.ClientRequestUnexpectedPayload /// /// # Examples /// /// ```rust,no_run /// # use serde_json::json; /// # use warpgrapher::Client;; /// /// # #[tokio::main] /// # async fn main() { /// let mut client = Client::<(), ()>::new_with_http("http:://localhost:5000/graphql", None).unwrap(); /// /// let proj_issues = client.update_rel("Project", "issues", /// "id props {since} src {id name} dst {id name}", /// Some("1234"), /// Some(&json!({"props": {"since": "2000"}})), /// &json!({"props": {"since": "2010"}}) /// ).await; /// # } /// ``` pub async fn update_rel( &mut self, type_name: &str, rel_name: &str, shape: &str, partition_key: Option<&str>, match_input: Option<&Value>, update_input: &Value, ) -> Result<Value, Error> { trace!( "Client::update_rel called -- type_name: {} | rel_name: {} | shape: {} | | partition_key: {:#?} | match_input: {:#?} | update_input: {:#?}", type_name, rel_name, shape, partition_key, match_input, update_input ); let query = Client::<(), ()>::fmt_update_rel_query(type_name, rel_name, shape); let input = json!({"match": match_input, "update": update_input}); let result_field = type_name.to_string() + &((&rel_name.to_string().to_title_case()) .split_whitespace() .collect::<String>()) + "Update"; self.graphql(&query, partition_key, Some(&input), Some(&result_field)) .await } fn fmt_create_node_query(type_name: &str, shape: &str) -> String { format!( "mutation Create($partitionKey: String, $input: {type_name}CreateMutationInput!) {{ {type_name}Create(partitionKey: $partitionKey, input: $input) {{ {shape} }} }}", type_name = type_name, shape = shape ) } fn fmt_create_rel_query(type_name: &str, rel_name: &str, shape: &str) -> String { format!( "mutation Create($partitionKey: String, $input: {type_name}{rel_name}CreateInput!) {{ {type_name}{rel_name}Create(partitionKey: $partitionKey, input: $input) {{ {shape} }} }}", type_name = type_name, rel_name = (&rel_name.to_string().to_title_case()) .split_whitespace() .collect::<String>(), shape = shape ) } fn fmt_delete_node_query(type_name: &str) -> String { format!( "mutation Delete($partitionKey: String, $input: {type_name}DeleteInput!) {{ {type_name}Delete(partitionKey: $partitionKey, input: $input) }}", type_name = type_name ) } fn fmt_delete_rel_query(type_name: &str, rel_name: &str) -> String { format!( "mutation Delete($partitionKey: String, $input: {type_name}{rel_name}DeleteInput!) {{ {type_name}{rel_name}Delete(partitionKey: $partitionKey, input: $input) }}", type_name = type_name, rel_name = (&rel_name.to_string().to_title_case()) .split_whitespace() .collect::<String>(), ) } fn fmt_read_node_query(type_name: &str, shape: &str) -> String { format!( "query Read($partitionKey: String, $input: {type_name}QueryInput) {{ {type_name}(partitionKey: $partitionKey, input: $input) {{ {shape} }} }}", type_name = type_name, shape = shape ) } fn fmt_read_rel_query(type_name: &str, rel_name: &str, shape: &str) -> String { format!( "query Read($partitionKey: String, $input: {type_name}{rel_name}QueryInput) {{ {type_name}{rel_name}(partitionKey: $partitionKey, input: $input) {{ {shape} }} }}", type_name = type_name, rel_name = (&rel_name.to_string().to_title_case()) .split_whitespace() .collect::<String>(), shape = shape ) } fn fmt_update_node_query(type_name: &str, shape: &str) -> String { format!( "mutation Update($partitionKey: String, $input: {type_name}UpdateInput!) {{ {type_name}Update(partitionKey: $partitionKey, input: $input) {{ {shape} }} }}", type_name = type_name, shape = shape ) } fn fmt_update_rel_query(type_name: &str, rel_name: &str, shape: &str) -> String { format!( "mutation Update($partitionKey: String, $input: {type_name}{rel_name}UpdateInput!) {{ {type_name}{rel_name}Update(partitionKey: $partitionKey, input: $input) {{ {shape} }} }}", type_name = type_name, rel_name = (&rel_name.to_string().to_title_case()) .split_whitespace() .collect::<String>(), shape = shape ) } } impl<G, R> Display for Client<G, R> where G: GlobalContext, R: RequestContext, { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::result::Result<(), std::fmt::Error> { match self { Self::Http { endpoint, headers } => write!(f, "{}, metadata = {:#?}", endpoint, headers), Self::Local { engine, metadata } => write!(f, "{}, metadata = {:#?}", engine, metadata), } } } #[cfg(test)] mod tests { use super::Client; /// Passes if a new client is created with the endpoint passed into the constructor #[test] fn new() { let ep = "http://localhost:5000/graphql"; let client = Client::<(), ()>::new_with_http(ep, None); if let Ok(Client::Http { endpoint, .. }) = client { assert_eq!(ep, endpoint); } else { unreachable!() } } /// Passes if a client formats a read node query correctly #[test] fn fmt_read_node_query() { let actual = Client::<(), ()>::fmt_read_node_query("Project", "id"); let expected = r#"query Read($partitionKey: String, $input: ProjectQueryInput) { Project(partitionKey: $partitionKey, input: $input) { id } }"#; assert_eq!(actual, expected); } /// Passes if a client formats a create node query correctly #[test] fn fmt_create_node_query() { let actual = Client::<(), ()>::fmt_create_node_query("Project", "id"); let expected = r#"mutation Create($partitionKey: String, $input: ProjectCreateMutationInput!) { ProjectCreate(partitionKey: $partitionKey, input: $input) { id } }"#; assert_eq!(actual, expected); } /// Passes if Client implements the Send trait #[test] fn test_send() { fn assert_send<T: Send>() {} assert_send::<Client<(), ()>>(); } /// Passes if Client implements the Sync trait #[test] fn test_sync() { fn assert_sync<T: Sync>() {} assert_sync::<Client<(), ()>>(); } }