refactor: adjust caching

Author: Randoooom

Cargo.toml

@@ -16,7 +16,7 @@ aliri_traits = "0.1.1"
 async-trait = "0.1.80"
 bincode = { version = "1.3.3", optional = true }
 bb8 = { version = "0.8.5", optional = true }
-cached = { version = "0.52.0", features = ["async", "proc_macro"], optional = true }
+cached = { version = "0.52.0", features = ["async", "proc_macro"] }
 chrono = { version = "0.4.38", features = ["serde"] }
 derivative = "2.2.0"
 envy = "0.4.2"
@@ -73,9 +73,9 @@ reqwest = { version = "0.12.3", features = ["json"] }
 test-log = "0.2.15"
 
 [features]
-default = ["all-databases", "otlp", "caching-skytable", "bincode"]
+default = ["all-databases", "otlp", "caching-skytable"]
 
-caching-skytable = ["skytable", "cached", "bb8"]
+caching-skytable = ["skytable", "bb8", "bincode"]
 otlp = [
   "opentelemetry",
   "opentelemetry-otlp",

Makefile

@@ -67,7 +67,7 @@ integration_test:
 cleanup:
 	docker rm -f database;docker rm -f oidc-server-mock;docker rm -f feedback-fusion;docker rm -f skytable;docker network rm feedback-fusion; echo ""
 
-bench: cleanup docker_network skytable oidc-server-mock postgres_database postgres_backend 
+bench: cleanup docker_network oidc-server-mock postgres_database postgres_backend 
 	GRPC_ENDPOINT=http://localhost:8000 OIDC_CLIENT_ID=client OIDC_CLIENT_SECRET=secret OIDC_PROVIDER=http://localhost:5151 cargo bench
 	${MAKE} cleanup
 

src/cache.rs

@@ -24,27 +24,39 @@ use crate::{
     database::schema::feedback::{Field, Prompt},
     prelude::*,
 };
+#[cfg(feature = "caching-skytable")]
 use bb8::ManageConnection;
+#[cfg(feature = "caching-skytable")]
 use cached::IOCachedAsync;
+#[cfg(feature = "caching-skytable")]
 use chrono::Utc;
 use feedback_fusion_codegen::dynamic_cache;
+
+#[cfg(feature = "caching-skytable")]
 use serde::{de::DeserializeOwned, Serialize};
+#[cfg(feature = "caching-skytable")]
 use skytable::{
     aio::TcpConnection,
     pool::{ConnectionMgrTcp, ConnectionMgrTls},
     query, ClientResult, Pipeline, Query, Response,
 };
+
+#[cfg(feature = "caching-skytable")]
 use std::{
     fmt::{Debug, Display},
     marker::PhantomData,
     ops::DerefMut,
     time::Duration,
 };
+#[cfg(feature = "caching-skytable")]
 use thiserror::Error;
+#[cfg(feature = "caching-skytable")]
 use tokio::io::{AsyncRead, AsyncWrite};
+#[cfg(feature = "caching-skytable")]
 use tracing::{instrument, Instrument};
 
 // may publish this as crate or submit as pr for cached
+#[cfg(feature = "caching-skytable")]
 pub struct SkytableCacheBuilder<'a, K, V> {
     username: &'a str,
     password: &'a str,
@@ -57,6 +69,7 @@ pub struct SkytableCacheBuilder<'a, K, V> {
     _phantom: PhantomData<(K, V)>,
 }
 
+#[cfg(feature = "caching-skytable")]
 impl<'a, K, V> SkytableCacheBuilder<'a, K, V>
 where
     K: Display,
@@ -122,6 +135,7 @@ where
     }
 }
 
+#[cfg(feature = "caching-skytable")]
 pub struct SkytableTlsCacheBuilder<'a, K, V> {
     username: &'a str,
     password: &'a str,
@@ -135,6 +149,7 @@ pub struct SkytableTlsCacheBuilder<'a, K, V> {
     _phantom: PhantomData<(K, V)>,
 }
 
+#[cfg(feature = "caching-skytable")]
 impl<'a, K, V> SkytableTlsCacheBuilder<'a, K, V>
 where
     K: Display,
@@ -208,6 +223,7 @@ where
     }
 }
 
+#[cfg(feature = "caching-skytable")]
 #[derive(Error, Debug)]
 pub enum SkytableCacheError {
     #[error(transparent)]
@@ -218,6 +234,7 @@ pub enum SkytableCacheError {
     PoolError(String),
 }
 
+#[cfg(feature = "caching-skytable")]
 impl<E> From<bb8::RunError<E>> for SkytableCacheError
 where
     E: Debug,
@@ -227,18 +244,22 @@ where
     }
 }
 
+#[cfg(feature = "caching-skytable")]
 #[derive(Clone, Query, Response)]
 struct CachedSkytableValue {
     pub ckey: String,
     pub cvalue: Vec<u8>,
     pub ttl: i64,
 }
+
+#[cfg(feature = "caching-skytable")]
 impl CachedSkytableValue {
     fn new(ckey: String, cvalue: Vec<u8>, ttl: i64) -> Self {
         Self { ckey, cvalue, ttl }
     }
 }
 
+#[cfg(feature = "caching-skytable")]
 pub struct SkytableCache<'a, C: ManageConnection, K, V> {
     space: &'a str,
     model: &'a str,
@@ -248,6 +269,7 @@ pub struct SkytableCache<'a, C: ManageConnection, K, V> {
     _phantom: PhantomData<(K, V)>,
 }
 
+#[cfg(feature = "caching-skytable")]
 impl<'a, C, I, S, K, V> SkytableCache<'a, C, K, V>
 where
     S: AsyncRead + AsyncWrite + Send + Sync + Unpin,
@@ -274,6 +296,7 @@ where
     }
 }
 
+#[cfg(feature = "caching-skytable")]
 #[async_trait::async_trait]
 impl<'a, C, I, S, K, V> IOCachedAsync<K, V> for SkytableCache<'a, C, K, V>
 where

src/main.rs

@@ -42,7 +42,6 @@ use tonic_web::GrpcWebLayer;
 use tower_http::trace::TraceLayer;
 use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
 
-#[cfg(feature = "caching-skytable")]
 pub mod cache;
 pub mod config;
 pub mod database;

src/services/v1/field.rs

@@ -22,8 +22,7 @@
 
 use super::{FeedbackFusionV1Context, PublicFeedbackFusionV1Context};
 use crate::{
-    database::schema::feedback::{Field, FieldOptions, FieldType},
-    prelude::*,
+    cache::fetch_prompt, database::schema::feedback::{Field, FieldOptions, FieldType}, prelude::*
 };
 use feedback_fusion_common::proto::{
     CreateFieldRequest, DeleteFieldRequest, Field as ProtoField, FieldPage, GetFieldsRequest,
@@ -62,12 +61,6 @@ pub async fn get_active_fields(
     let connection = context.connection();
 
     // fetch the prompt
-    #[cfg(not(feature = "caching-skytable"))]
-    let prompt = database_request!(
-        Prompt::select_by_id(connection, data.prompt.as_str()).await,
-        "Fetch prompt by id"
-    )?;
-    #[cfg(feature = "caching-skytable")]
     let prompt = fetch_prompt(connection, data.prompt.as_str()).await?;
 
     let prompt = prompt.ok_or(FeedbackFusionError::BadRequest(

src/services/v1/prompt.rs

@@ -48,7 +48,6 @@ pub async fn create_prompt(
     Ok(Response::new(prompt.into()))
 }
 
-
 #[instrument(skip_all)]
 pub async fn get_prompt(
     context: &PublicFeedbackFusionV1Context,
@@ -57,12 +56,6 @@ pub async fn get_prompt(
     let data = request.into_inner();
     let connection = context.connection();
 
-    #[cfg(not(feature = "caching-skytable"))]
-    let prompt: Option<Prompt> = database_request!(
-        Prompt::select_by_id(connection, data.id.as_str()).await,
-        "Select prompt by id"
-    )?;
-    #[cfg(feature = "caching-skytable")]
     let prompt = fetch_prompt(connection, data.id.as_str()).await?;
 
     match prompt {

src/services/v1/response.rs

@@ -22,8 +22,7 @@
 
 use super::{FeedbackFusionV1Context, PublicFeedbackFusionV1Context};
 use crate::{
-    database::schema::feedback::{FieldData, FieldResponse, PromptResponse},
-    prelude::*,
+    cache::fields_by_prompt, database::schema::feedback::{FieldData, FieldResponse, PromptResponse}, prelude::*
 };
 use feedback_fusion_common::proto::{
     CreateResponsesRequest, FieldResponse as ProtoFieldResponse, FieldResponseList,
@@ -47,13 +46,7 @@ pub async fn create_responses(
     });
 
     // fetch the fields of the prompt
-    #[cfg(feature = "caching-skytable")]
     let fields = fields_by_prompt(context.connection(), data.prompt.as_str()).await?;
-    #[cfg(not(feature = "caching-skytable"))]
-    let fields = database_request!(
-        Field::select_by_column(&transaction, "prompt", data.prompt.as_str()).await,
-        "Select fields by prompt"
-    )?;
     // as we can assume a prompt has to have at least 1 field we can throw the 400 here
     if fields.is_empty() {
         return Err(FeedbackFusionError::BadRequest("invalid prompt".to_owned()));