refactor: add description for prompt and move field description from …

…input into schema
OneLiteFeatherNET · Mar 17, 2024 · 76b1e85 · 76b1e85
1 parent ddbe535
commit 76b1e85
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 15 deletions.
diff --git a/Makefile.toml b/Makefile.toml
@@ -67,7 +67,7 @@ script = "docker compose -f tests/_common/oidc-mock/docker-compose.yaml up -d"
 script = "docker run --name postgres -e POSTGRES_PASSWORD=password -e POSTGRES_USERNAME=postgres -p 5150:5432 -d postgres && sleep 1"
 
 [tasks.postgres_tests]
-env = { DATABASE = "POSTGRES", POSTGRES_USERNAME = "postgres", POSTGRES_PASSWORD = "password", POSTGRES_ENDPOINT = "localhost:5150", POSTGRES_DATABASE = "postgres", "OIDC_DISCOVERY_URL" = "http://localhost:5151", OIDC_CLIENT_ID = "client", OIDC_CLIENT_SECRET = "secret", OIDC_SCOPE = "api:feedback-fusion" }
+env = { DATABASE = "POSTGRES", POSTGRES_USERNAME = "postgres", POSTGRES_PASSWORD = "password", POSTGRES_ENDPOINT = "localhost:5150", POSTGRES_DATABASE = "postgres", "OIDC_DISCOVERY_URL" = "http://localhost:5151", OIDC_CLIENT_ID = "client", OIDC_CLIENT_SECRET = "secret", OIDC_SCOPE = "api:feedback-fusion", RUST_LOG = "INFO" }
 command = "cargo"
 args = [
   "test",

diff --git a/src/database/postgres.sql b/src/database/postgres.sql
@@ -9,6 +9,7 @@ CREATE TABLE IF NOT EXISTS feedback_target (
 CREATE TABLE IF NOT EXISTS feedback_prompt (
   id          VARCHAR(32) UNIQUE NOT NULL,
   title       VARCHAR(32) NOT NULL,
+  description VARCHAR(255) NOT NULL,
   target      VARCHAR(32) REFERENCES feedback_target(id) NOT NULL,
   active      BOOLEAN NOT NULL,
   updated_at  TIMESTAMP,
@@ -17,7 +18,8 @@ CREATE TABLE IF NOT EXISTS feedback_prompt (
 
 CREATE TABLE IF NOT EXISTS feedback_prompt_field (
   id          VARCHAR(32) UNIQUE NOT NULL,
-  title       VARCHAR(255) NOT NULL,
+  title       VARCHAR(32) NOT NULL,
+  description VARCHAR(255),
   prompt      VARCHAR(32) REFERENCES feedback_prompt(id) NOT NULL,
   type        VARCHAR(32) NOT NULL,
   options     JSON NOT NULL,

diff --git a/src/database/schema/feedback/input.rs b/src/database/schema/feedback/input.rs
@@ -48,8 +48,6 @@ impl PartialEq<FeedbackPromptInputOptions> for FeedbackPromptInputType {
 #[builder(field_defaults(setter(into)))]
 #[cfg_attr(feature = "bindings", derive(TS))]
 pub struct TextOptions {
-    #[validate(length(max = 255))]
-    description: String,
     #[validate(length(max = 255))]
     placeholder: String,
 }
@@ -58,8 +56,6 @@ pub struct TextOptions {
 #[builder(field_defaults(setter(into)))]
 #[cfg_attr(feature = "bindings", derive(TS))]
 pub struct RatingOptions {
-    #[validate(length(max = 255))]
-    description: String,
     max: u8,
 }
 

diff --git a/src/database/schema/feedback/prompt.rs b/src/database/schema/feedback/prompt.rs
@@ -47,6 +47,8 @@ pub struct FeedbackPrompt {
     id: String,
     #[validate(length(max = 255))]
     title: String,
+    #[validate(length(max = 255))]
+    description: String,
     target: String,
     #[builder(default = true)]
     active: bool,
@@ -92,8 +94,10 @@ pub enum FeedbackPromptInputType {
 pub struct FeedbackPromptField {
     #[builder(default_code = r#"nanoid::nanoid!()"#)]
     id: String,
-    #[validate(length(max = 255))]
+    #[validate(length(max = 32))]
     title: String,
+    #[validate(length(max = 255))]
+    description: Option<String>,
     prompt: String,
     r#type: FeedbackPromptInputType,
     #[cfg(not(feature = "bindings"))]

diff --git a/src/routes/v1/prompt.rs b/src/routes/v1/prompt.rs
@@ -41,10 +41,12 @@ pub async fn router(state: FeedbackFusionState) -> Router<FeedbackFusionState> {
 #[derive(ToSchema, Deserialize, Debug, Clone, Validate)]
 #[cfg_attr(feature = "bindings", derive(TS))]
 pub struct CreateFeedbackPromptRequest {
-    #[validate(length(max = 255))]
+    #[validate(length(max = 32))]
     title: String,
     #[serde(default = "bool_true")]
     active: bool,
+    #[validate(length(max = 255))]
+    description: String,
 }
 
 fn bool_true() -> bool {
@@ -66,6 +68,7 @@ pub async fn post_prompt(
     // build the prompt
     let prompt = FeedbackPrompt::builder()
         .title(data.title)
+        .description(data.description)
         .active(data.active)
         .target(target)
         .build();
@@ -166,8 +169,10 @@ pub async fn delete_prompt(
 #[derive(Debug, Clone, ToSchema, Deserialize, Validate)]
 #[cfg_attr(feature = "bindings", derive(TS))]
 pub struct CreateFeedbackPromptFieldRequest {
-    #[validate(length(max = 255))]
+    #[validate(length(max = 32))]
     title: String,
+    #[validate(length(max = 255))]
+    description: Option<String>,
     r#type: FeedbackPromptInputType,
     options: FeedbackPromptInputOptions,
 }
@@ -197,6 +202,7 @@ pub async fn post_field(
     let options = data.options;
     let field = FeedbackPromptField::builder()
         .title(data.title)
+        .description(data.description)
         .r#type(data.r#type)
         .options(options)
         .prompt(prompt)

diff --git a/tests/common.rs b/tests/common.rs
@@ -34,7 +34,7 @@ use std::{
     path::Path,
     process::{Child, Command, Stdio},
 };
-use tracing::debug;
+use tracing::{debug, info};
 
 pub const HTTP_ENDPOINT: &'static str = "http://localhost:8000";
 
@@ -62,7 +62,7 @@ pub fn run_server() -> BackendServer {
     let stderr = Stdio::from(
         File::create(Path::new(env!("OUT_DIR")).join(format!("{}stderr", seed))).unwrap(),
     );
-    debug!("OUT={} SEED={}", env!("OUT_DIR"), seed);
+    info!("OUT={} SEED={}", env!("OUT_DIR"), seed);
 
     command.stdin(Stdio::piped());
     command.stdout(stdout);

diff --git a/tests/http_tests.rs b/tests/http_tests.rs
@@ -224,7 +224,8 @@ async fn test_prompt_endpoints() {
         let response = client
             .post(format!("{}/v1/target/{}/prompt", HTTP_ENDPOINT, &target.id))
             .json(&serde_json::json!({
-                "title": "title"
+                "title": "title",
+                "description": "description"
             }))
             .send()
             .await
@@ -362,7 +363,8 @@ async fn test_prompt_field_endpoints() {
             let response = client
                 .post(format!("{}/v1/target/{}/prompt", HTTP_ENDPOINT, &target.id))
                 .json(&serde_json::json!({
-                    "title": "title"
+                    "title": "title",
+                    "description": "description"
                 }))
                 .send()
                 .await
@@ -375,7 +377,8 @@ async fn test_prompt_field_endpoints() {
                 .post(format!("{}/v1/target/{}/prompt", HTTP_ENDPOINT, &target.id))
                 .json(&serde_json::json!({
                     "title": "title",
-                    "active": false
+                    "active": false,
+                    "description": "description"
                 }))
                 .send()
                 .await
@@ -602,7 +605,8 @@ async fn test_response_endpoints() {
             let response = client
                 .post(format!("{}/v1/target/{}/prompt", HTTP_ENDPOINT, &target.id))
                 .json(&serde_json::json!({
-                    "title": "title"
+                    "title": "title",
+                    "description": "description"
                 }))
                 .send()
                 .await