[Rust] Update the Saphir benchmark (#8249)

* Updated Saphir benchmark

* Fixed saphir benchmark run

* Updated the readme

frameworks/Rust/saphir/Cargo.toml

@@ -1,15 +1,24 @@
 [package]
 name = "saphir-techempower"
-version = "0.2.0"
-authors = ["richer <[email protected]>"]
-edition = "2018"
+version = "0.3.0"
+authors = [
+    "richer <[email protected]>",
+    "Kaz <[email protected]>"
+]
+edition = "2021"
 
 [profile.release]
 lto = true
+opt-level = 3
 codegen-units = 1
 
 [dependencies]
-saphir = { version = "2.0.1", features = ["macro", "json"] }
+saphir = { version = "3.1.1", features = ["full"] }
 serde = "1.0"
 serde_derive = "1.0"
-tokio = { version = "0.2", features = ["full"] }
+tokio = { version = "1.17", features = ["macros", "rt-multi-thread"] }
+futures = "0.3.21"
+mongodm = { version = "0.9.0", default-features = false, features = ["tokio-runtime"] }
+rand = { version = "0.8", features = ["small_rng"] }
+sailfish = "0.6.1"
+cached = { version = "0.44.0", features = ["async"] }

frameworks/Rust/saphir/README.md

@@ -8,13 +8,13 @@ Saphir is a fast and lightweight web framework that aims to give lowlevel contro
 
 ### Test Type Implementation Source Code
 
-* [JSON](src/json.rs)
-* [PLAINTEXT](src/plain.rs)
-* [DB](src/main.rs)
-* [QUERY](src/main.rs)
-* [CACHED QUERY](src/main.rs)
-* [UPDATE](src/main.rs)
-* [FORTUNES](src/main.rs)
+* [JSON](src/controller.rs)
+* [PLAINTEXT](src/controller.rs)
+* [DB](src/controller.rs)
+* [QUERY](src/controller.rs)
+* [CACHED QUERY](src/controller.rs)
+* [UPDATE](src/controller.rs)
+* [FORTUNES](src/controller.rs)
 
 ## Test URLs
 ### JSON
@@ -35,11 +35,11 @@ http://localhost:8080/plaintext
 
 ### ~~CACHED QUERY~~
 
-~~http://localhost:8080/cached_query?queries=~~
+~~http://localhost:8080/cached-worlds?count=~~
 
 ### ~~UPDATE~~
 
-~~http://localhost:8080/update?queries=~~
+~~http://localhost:8080/bulk-update?queries=~~
 
 ### ~~FORTUNES~~
 

frameworks/Rust/saphir/benchmark_config.json

@@ -5,22 +5,26 @@
       "default": {
         "json_url": "/json",
         "plaintext_url": "/plaintext",
+        "db_url": "/db",
+        "query_url": "/queries?queries=",
+        "fortune_url": "/fortunes",
+        "update_url": "/bulk-updates?queries=",
+        "cached_query_url": "/cached-worlds?count=",
         "port": 8080,
         "approach": "Realistic",
         "classification": "Micro",
-        "database": "None",
+        "database": "MongoDB",
         "framework": "Saphir",
         "language": "Rust",
         "flavor": "None",
-        "orm": "None",
+        "orm": "Raw",
         "platform": "None",
         "webserver": "None",
         "os": "Linux",
         "database_os": "Linux",
         "display_name": "Saphir",
         "notes": "",
-        "versus": "Rocket",
-        "tags": ["broken"]
+        "versus": "Rocket"
       }
     }
   ]

frameworks/Rust/saphir/config.toml

@@ -4,12 +4,17 @@ name = "saphir"
 [main]
 urls.plaintext = "/plaintext"
 urls.json = "/json"
+urls.db = "/db"
+urls.query = "/queries?queries="
+urls.fortune = "/fortunes"
+urls.update = "/bulk-updates?queries="
+urls.cached_query = "/cached-worlds?count="
 approach = "Realistic"
 classification = "Micro"
-database = "None"
+database = "MongoDB"
 database_os = "Linux"
 os = "Linux"
-orm = "None"
+orm = "Raw"
 platform = "None"
 webserver = "None"
 versus = "Rocket"

frameworks/Rust/saphir/saphir.dockerfile

@@ -1,4 +1,4 @@
-FROM rust:1.44
+FROM rust:latest
 
 WORKDIR /saphir
 

frameworks/Rust/saphir/src/cache.rs

@@ -0,0 +1,15 @@
+use mongodm::prelude::*;
+use cached::proc_macro::cached;
+use cached::TimedCache;
+use crate::models::*;
+use crate::errors::BenchmarkControllerError;
+
+#[cached(
+    type = "TimedCache<i32, Option<CachedWorld>>",
+    create = "{ TimedCache::with_lifespan(120) }",
+    convert = r#"{ id }"#,
+    result = true
+)]
+pub async fn find_cached_world_by_id(collection: MongoCollection<CachedWorld>, id: i32) -> Result<Option<CachedWorld>, BenchmarkControllerError> {
+    Ok(collection.find_one(doc! { "_id": id }, None).await?)
+}

frameworks/Rust/saphir/src/controller.rs

@@ -0,0 +1,250 @@
+use rand::{distributions::{Uniform, Distribution}};
+use saphir::prelude::*;
+use mongodm::prelude::*;
+use futures::{TryStreamExt, stream::FuturesUnordered};
+use tokio::task::JoinHandle;
+use crate::models::*;
+use crate::templates::*;
+use crate::cache::*;
+use crate::errors::BenchmarkControllerError;
+
+pub static HELLO_WORLD: &'static str = "Hello, world!";
+
+pub struct BenchmarkController {
+    db: MongoDatabase,
+    worlds: MongoCollection<World>,
+    fortunes: MongoCollection<Fortune>,
+    cached_worlds: MongoCollection<CachedWorld>,
+    range: Uniform<i32>,
+}
+
+impl BenchmarkController {
+    pub fn new(db: MongoDatabase) -> Self {
+        let worlds = db.collection("world");
+        let cached_worlds = db.collection("world");
+        let fortunes = db.collection("fortune");
+        Self {
+            db,
+            worlds,
+            fortunes,
+            cached_worlds,
+            range: Uniform::from(1..10_001),
+        }
+    }
+
+    #[inline]
+    async fn find_random_world(&self) -> Result<Option<World>, BenchmarkControllerError> {
+        let random_id = self.range.sample(&mut rand::thread_rng());
+        Ok(self.worlds.find_one(doc! { "_id": random_id }, None).await?)
+    }
+
+    #[inline]
+    async fn find_random_world_cached(&self) -> Result<Option<CachedWorld>, BenchmarkControllerError> {
+        let random_id = self.range.sample(&mut rand::thread_rng());
+        find_cached_world_by_id(self.cached_worlds.clone(), random_id).await
+    }
+
+    #[inline]
+    async fn update_one_random_world(&self) -> Result<(World, JoinHandle<Result<MongoUpdateResult, mongodm::prelude::MongoError>>), BenchmarkControllerError> {
+        let mut world = self.find_random_world().await?.ok_or(BenchmarkControllerError::CannotFindRandomWorld)?;
+        world.randomNumber = self.range.sample(&mut rand::thread_rng()) as f32;
+
+        let worlds_collection = self.worlds.clone();
+        let world_update = world.clone();
+        Ok((
+            world,
+            tokio::spawn(async move {
+                worlds_collection.replace_one(doc!{ "_id": world_update.id }, world_update, None).await
+            })
+        ))
+    }
+
+    #[inline]
+    async fn update_random_worlds(&self, count: i32, worlds: &mut Vec<World>) -> Result<JoinHandle<Result<BulkUpdateResult, mongodm::prelude::MongoError>>, BenchmarkControllerError> {
+        let mut updates = vec![];
+        for _ in 0..count {
+            if let Some(mut world) = self.find_random_world().await? {
+                world.randomNumber = self.range.sample(&mut rand::thread_rng()) as f32;
+                updates.push(BulkUpdate {
+                    query: doc!{ "_id": world.id },
+                    update: doc! { Set: { f!(randomNumber in World): world.randomNumber } },
+                    options: None,
+                });
+                worlds.push(world);
+            }
+        }
+
+        let worlds_collection = self.worlds.clone();
+        let db = self.db.clone();
+        let join_handle = tokio::spawn(async move {
+            worlds_collection.bulk_update(&db, updates).await
+        });
+        Ok(join_handle)
+    }
+}
+
+// The Saphir-idiomatic way of doing this would be to have an empty controller macro, which would
+// route all the requests to /<controller_name>/<route>, for example /benchmark/plaintext .
+//
+// However, in order to expose the API at the root, we use a specifically un-nammed controller.
+#[controller(name = "")]
+impl BenchmarkController {
+    #[get("/plaintext")]
+    async fn return_plain(&self) -> &str {
+        HELLO_WORLD
+    }
+
+    #[get("/json")]
+    async fn return_json(&self) -> Json<JsonMessage> {
+        Json(JsonMessage { message: HELLO_WORLD })
+    }
+
+    #[get("/db")]
+    async fn single_query(&self) -> Result<Json<Option<World>>, BenchmarkControllerError> {
+        Ok(Json(self.find_random_world().await?))
+    }
+
+    #[get("/queries")]
+    async fn multiple_queries(&self, queries: Option<String>) -> Result<Json<Vec<World>>, BenchmarkControllerError> {
+        let nb_queries: usize = queries.and_then(|q| q.parse::<usize>().ok()).unwrap_or(1).max(1).min(500);
+
+        let mut worlds = Vec::with_capacity(nb_queries);
+        for _ in 0..nb_queries {
+            if let Some(world) = self.find_random_world().await? {
+                worlds.push(world);
+            }
+        }
+
+        Ok(Json(worlds))
+    }
+
+    #[get("/fortunes")]
+    async fn fortune(&self) -> Result<FortunesTemplate, BenchmarkControllerError> {
+        let mut fortunes: Vec<_> = self.fortunes.find(None, None).await?.try_collect().await?;
+        fortunes.push(Fortune {
+            id: 0.0,
+            message: "Additional fortune added at request time.".to_string(),
+        });
+        fortunes.sort_unstable_by(|a, b| a.message.cmp(&b.message));
+        Ok(FortunesTemplate::new(fortunes))
+    }
+
+    #[get("/cached-worlds")]
+    async fn cached_queries(&self, count: Option<String>) -> Result<Json<Vec<CachedWorld>>, BenchmarkControllerError> {
+        let nb_queries: usize = count.and_then(|q| q.parse::<usize>().ok()).unwrap_or(1).max(1).min(500);
+
+        let mut worlds = Vec::with_capacity(nb_queries);
+        for _ in 0..nb_queries {
+            if let Some(world) = self.find_random_world_cached().await? {
+                worlds.push(world);
+            }
+        }
+
+        Ok(Json(worlds))
+    }
+
+    // Real-world implementation #1
+    // Pros: start updating as soon as the first world is queried
+    // Cons: Do as many updates as requests
+    #[get("/updates")]
+    async fn updates(&self, queries: Option<String>) -> Result<Json<Vec<World>>, BenchmarkControllerError> {
+        let nb_queries: usize = queries.and_then(|q| q.parse::<usize>().ok()).unwrap_or(1).max(1).min(500);
+
+        let mut futures = FuturesUnordered::new();
+
+        let mut worlds = Vec::with_capacity(nb_queries);
+        for _ in 0..nb_queries {
+            if let Some(mut world) = self.find_random_world().await? {
+                world.randomNumber = self.range.sample(&mut rand::thread_rng()) as f32;
+
+                let worlds_collection = self.worlds.clone();
+                let world_update = world.clone();
+                futures.push(tokio::spawn(async move {
+                    worlds_collection.replace_one(doc!{ "_id": world_update.id }, world_update, None).await
+                }));
+
+                worlds.push(world);
+            }
+        }
+
+        while let Some(r) = futures.try_next().await? { r?; }
+
+        Ok(Json(worlds))
+    }
+
+    // Real-world implementation #2
+    // Pros: A single bulk update request instead of many updates
+    // Cons: only start updating after all data was queried
+    #[get("/bulk-updates")]
+    async fn bulk_updates(&self, queries: Option<String>) -> Result<Json<Vec<World>>, BenchmarkControllerError> {
+        let nb_queries: usize = queries.and_then(|q| q.parse::<usize>().ok()).unwrap_or(1).max(1).min(500);
+
+        let mut worlds = Vec::with_capacity(nb_queries);
+
+        let mut updates = vec![];
+        for _ in 0..nb_queries {
+            if let Some(mut world) = self.find_random_world().await? {
+                world.randomNumber = self.range.sample(&mut rand::thread_rng()) as f32;
+                updates.push(BulkUpdate {
+                    query: doc!{ "_id": world.id },
+                    update: doc! { Set: { f!(randomNumber in World): world.randomNumber } },
+                    options: None,
+                });
+                worlds.push(world);
+            }
+        }
+
+        self.worlds.bulk_update(&self.db, updates).await?;
+
+        Ok(Json(worlds))
+    }
+
+    // Possible alternative bulk update implementation.
+    // Not included in the benchmark because it is a bit overkill for a "realistic" approach.
+    //
+    // Pros: get the pros of both previous methods (start updating quickly and less update requests)
+    // Cons: more complex implementation than both previous methods
+    #[get("/fast-bulk-updates")]
+    async fn fast_bulk_updates(&self, queries: Option<String>) -> Result<Json<Vec<World>>, BenchmarkControllerError> {
+        let nb_queries: usize = queries.and_then(|q| q.parse::<usize>().ok()).unwrap_or(1).max(1).min(500);
+
+        let mut worlds = Vec::with_capacity(nb_queries);
+
+        // Submit first update immediately
+        let (world, first_fut) = self.update_one_random_world().await?;
+        worlds.push(world);
+
+        if nb_queries > 1 {
+            let mut futures = FuturesUnordered::new();
+
+            let mut nb_remaining = nb_queries - 1;
+            let batches_sizes = [2, 5, 10, 100];
+
+            let mut batch_index = 0;
+            for i in 0..batches_sizes.len() {
+                batch_index = i;
+
+                let batch_size = batches_sizes[batch_index].min(nb_remaining);
+                let fut = self.update_random_worlds(batch_size as i32, &mut worlds).await?;
+                futures.push(fut);
+                nb_remaining -= batch_size;
+                if nb_remaining <= 0 {
+                    break;
+                }
+            }
+
+            while nb_remaining > 0 {
+                let batch_size = batches_sizes[batch_index].min(nb_remaining);
+                let fut = self.update_random_worlds(batch_size as i32, &mut worlds).await?;
+                futures.push(fut);
+                nb_remaining -= batch_size;
+            }
+
+            while let Some(r) = futures.try_next().await? { r?; }
+        }
+
+        first_fut.await??;
+
+        Ok(Json(worlds))
+    }
+}

frameworks/Rust/saphir/src/errors.rs

@@ -0,0 +1,37 @@
+
+use saphir::prelude::*;
+use mongodm::prelude::*;
+use std::num::ParseIntError;
+use tokio::task::JoinError;
+
+pub enum BenchmarkControllerError {
+    MongodbError(MongoError),
+    ParseError,
+    JoinError(JoinError),
+    CannotFindRandomWorld,
+}
+
+impl Responder for BenchmarkControllerError {
+    fn respond_with_builder(self, builder: Builder, _ctx: &HttpContext) -> Builder {
+        builder.status(500)
+    }
+}
+
+
+impl From<MongoError> for BenchmarkControllerError {
+    fn from(e: MongoError) -> Self {
+        BenchmarkControllerError::MongodbError(e)
+    }
+}
+
+impl From<ParseIntError> for BenchmarkControllerError {
+    fn from(_: ParseIntError) -> Self {
+        BenchmarkControllerError::ParseError
+    }
+}
+
+impl From<JoinError> for BenchmarkControllerError {
+    fn from(e: JoinError) -> Self {
+        BenchmarkControllerError::JoinError(e)
+    }
+}

frameworks/Rust/saphir/src/json.rs

@@ -1,17 +0,0 @@
-use saphir::prelude::*;
-use serde_derive::Serialize;
-
-#[derive(Serialize)]
-struct RspMessage<'t0> {
-    message: &'t0 str,
-}
-
-pub struct JsonController;
-
-#[controller]
-impl JsonController {
-    #[get("/")]
-    async fn return_json(&self) -> (u16, Json<RspMessage<'static>>) {
-        (200, Json(RspMessage { message: crate::HELLO_WORLD }))
-    }
-}

frameworks/Rust/saphir/src/main.rs

@@ -1,20 +1,34 @@
+use std::time::Duration;
 use saphir::prelude::*;
+use mongodm::prelude::*;
 
-mod json;
-mod plain;
+mod controller;
+mod errors;
+mod models;
+mod templates;
+mod cache;
 
-pub static HELLO_WORLD: &'static str = "Hello, world!";
-
-#[tokio::main]
+#[tokio::main(flavor = "multi_thread")]
 async fn main() -> Result<(), SaphirError> {
+    // let mut client_options = MongoClientOptions::parse("mongodb://localhost:27017")
+    let mut client_options = MongoClientOptions::parse("mongodb://tfb-database:27017")
+        .await
+        .map_err(|e| SaphirError::Custom(Box::new(e)))?;
+
+    client_options.min_pool_size = Some(64);
+    client_options.max_pool_size = Some(512);
+
+    client_options.connect_timeout = Some(Duration::from_millis(200));
+    let client = MongoClient::with_options(client_options).map_err(|e| SaphirError::Custom(Box::new(e)))?;
+    let db = client.database("hello_world");
+
     let server = Server::builder()
         .configure_listener(|l| {
             l.interface("0.0.0.0:8080")
         })
         .configure_router(|r| {
             r
-                .controller(json::JsonController)
-                .controller(plain::PlainController)
+                .controller(controller::BenchmarkController::new(db))
         })
         .build();
 

frameworks/Rust/saphir/src/models.rs

@@ -0,0 +1,26 @@
+use serde_derive::{Serialize, Deserialize};
+
+#[derive(Serialize)]
+pub struct JsonMessage {
+    pub message: &'static str,
+}
+
+#[allow(non_snake_case)]
+#[derive(Serialize, Deserialize, Clone)]
+pub struct World {
+    pub id: f32,
+    pub randomNumber: f32,
+}
+
+#[derive(Deserialize, Serialize)]
+pub struct Fortune {
+    pub id: f32,
+    pub message: String
+}
+
+#[allow(non_snake_case)]
+#[derive(Serialize, Deserialize, Clone)]
+pub struct CachedWorld {
+    pub id: f32,
+    pub randomNumber: f32,
+}

frameworks/Rust/saphir/src/plain.rs

@@ -1,11 +0,0 @@
-use saphir::prelude::*;
-
-pub struct PlainController;
-
-#[controller(name = "plaintext")]
-impl PlainController {
-    #[get("/")]
-    async fn return_plain(&self) -> (u16, &'static str) {
-        (200, crate::HELLO_WORLD)
-    }
-}

frameworks/Rust/saphir/src/templates.rs

@@ -0,0 +1,24 @@
+use saphir::responder::Responder;
+use sailfish::TemplateOnce;
+use crate::models::Fortune;
+
+#[derive(TemplateOnce)]
+#[template(path = "fortune.stpl")]
+pub struct FortunesTemplate {
+    fortunes: Vec<Fortune>,
+}
+
+impl FortunesTemplate {
+    pub fn new(fortunes: Vec<Fortune>) -> Self {
+        Self { fortunes }
+    }
+}
+
+impl Responder for FortunesTemplate {
+    fn respond_with_builder(self, builder: saphir::prelude::Builder, _ctx: &saphir::http_context::HttpContext) -> saphir::prelude::Builder {
+        match self.render_once() {
+            Ok(r) => builder.body(r).header("Content-Type", "text/html; charset=utf-8"),
+            Err(_) => builder.status(500),
+        }
+    }
+}

frameworks/Rust/saphir/templates/fortune.stpl

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head><title>Fortunes</title></head>
+<body>
+<table>
+<tr><th>id</th><th>message</th></tr>
+<% for f in &fortunes { %>
+<tr><td><%= f.id as u32 %></td><td><%= &*f.message %></td></tr>
+<% } %>
+</table>
+</body>
+</html>