YCR: validate 'mobileEntrypointSections' query key

Author: mrtnzlml

src/ya-comiste-rust/Cargo.lock

@@ -1,5 +1,7 @@
 [workspace]
 members = [
   "crates/arangodb",
+  "crates/graphql",
+  "crates/sdui",
   "crates/server",
 ]

src/ya-comiste-rust/Cargo.toml

@@ -9,7 +9,6 @@ This server is written in Rust, exposes GraphQL API (via Warp) and works with Ar
 ```text
 (cd src/ya-comiste-rust && cargo run)
 (cd src/ya-comiste-rust && cargo fmt)
-(cd src/ya-comiste-rust && cargo check)
 (cd src/ya-comiste-rust && cargo clippy)
 (cd src/ya-comiste-rust && cargo test --offline)
 ```
@@ -26,13 +25,13 @@ brew services start arangodb
 /usr/local/opt/arangodb/sbin/arangod
 ```
 
-- http://127.0.0.1:8529/ (user `ya-comiste`, no password)
+- http://127.0.0.1:8529/ (user `ya-comiste-rust`, no password)
 
 Example query:
 
 ```graphql
 {
-  mobileEntrypointSections(id: "entrypoints/com.yaComiste.Explore") {
+  mobileEntrypointSections(key: "com.yaComiste.Explore") {
     id
     title
   }
@@ -58,6 +57,10 @@ RETURN vertex
 
 See graph traversals: https://www.arangodb.com/docs/stable/aql/graphs-traversals.html
 
+- `_id` - document handle (uniquely identifies a document in the database)
+- `_key` - document's primary key (uniquely identifies a document in the collection it is stored in)
+- `_rev` - document revision
+
 ## Arangodump & Arangorestore
 
 Database backup (empty password):

src/ya-comiste-rust/README.md

@@ -2,12 +2,40 @@ const ARANGODB_HOST: &str = "http://127.0.0.1:8529/";
 const NORMAL_USERNAME: &str = "ya-comiste-rust"; // TODO: change!
 const NORMAL_PASSWORD: &str = ""; // TODO: change!
 
+/// Default ArangoDB (normal) user:
+///
+/// ```
+/// use arangodb::get_normal_user;
+/// assert_eq!(get_normal_user(), "ya-comiste-rust")
+/// ```
+///
+/// Custom ArangoDB (normal) user (via ENV):
+///
+/// ```
+/// use arangodb::get_normal_user;
+/// std::env::set_var("ARANGO_USER", "yadada");
+/// assert_eq!(get_normal_user(), "yadada")
+/// ```
 pub fn get_normal_user() -> String {
-    std::env::var("ARANGO_USER").unwrap_or(NORMAL_USERNAME.to_owned())
+    std::env::var("ARANGO_USER").unwrap_or_else(|_| NORMAL_USERNAME.to_owned())
 }
 
+/// Default ArangoDB (normal) password:
+///
+/// ```
+/// use arangodb::get_normal_password;
+/// assert_eq!(get_normal_password(), "")
+/// ```
+///
+/// Custom ArangoDB (normal) password (via ENV):
+///
+/// ```
+/// use arangodb::get_normal_password;
+/// std::env::set_var("ARANGO_PASSWORD", "custom_pswd");
+/// assert_eq!(get_normal_password(), "custom_pswd")
+/// ```
 pub fn get_normal_password() -> String {
-    std::env::var("ARANGO_PASSWORD").unwrap_or(NORMAL_PASSWORD.to_owned())
+    std::env::var("ARANGO_PASSWORD").unwrap_or_else(|_| NORMAL_PASSWORD.to_owned())
 }
 
 /// Default ArangoDB host:
@@ -27,7 +55,7 @@ pub fn get_normal_password() -> String {
 pub fn get_arangodb_host() -> String {
     std::env::var("ARANGODB_HOST")
         .map(|s| format!("http://{}", s))
-        .unwrap_or(ARANGODB_HOST.to_owned())
+        .unwrap_or_else(|_| ARANGODB_HOST.to_owned())
 }
 
 pub async fn connection() -> arangors::Connection {

src/ya-comiste-rust/crates/arangodb/src/lib.rs

@@ -0,0 +1,11 @@
+[package]
+name = "graphql"
+version = "0.0.0"
+authors = ["Martin Zlámal <[email protected]>"]
+edition = "2018"
+publish = false
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+juniper = { git = "https://github.com/graphql-rust/juniper" }

src/ya-comiste-rust/crates/graphql/Cargo.toml

@@ -0,0 +1 @@
+pub mod graphql_context;

src/ya-comiste-rust/crates/server/src/graphql_context.rs renamed to src/ya-comiste-rust/crates/graphql/src/graphql_context.rs

@@ -0,0 +1,15 @@
+[package]
+name = "sdui"
+version = "0.0.0"
+authors = ["Martin Zlámal <[email protected]>"]
+edition = "2018"
+publish = false
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+arangodb = { path = "../arangodb" }
+arangors = "0.4.5"
+graphql = { path = "../graphql" }
+juniper = { git = "https://github.com/graphql-rust/juniper" }
+serde = "1.0.117"

src/ya-comiste-rust/crates/graphql/src/lib.rs

@@ -0,0 +1 @@
+This package is responsible for managing Server Driven UI (SDUI).

src/ya-comiste-rust/crates/sdui/Cargo.toml

@@ -0,0 +1,15 @@
+use graphql::graphql_context::Context;
+
+/// TODO: maybe `MobileEntrypoint` would be a better name so we are future proof?
+#[derive(Clone, Debug, serde::Deserialize)]
+pub struct Entrypoint {
+    pub _id: juniper::ID,
+    pub _key: String,
+}
+
+#[juniper::graphql_object(context = Context)]
+impl Entrypoint {
+    fn id(&self) -> &str {
+        &self._id
+    }
+}