list tags endpoint, mount routes

crates/service/web/storyteller_web/src/http_server/endpoints/tags/list_tags_for_entity_handler.rs

@@ -0,0 +1,151 @@
+//// NB: Incrementally getting rid of build warnings...
+//#![forbid(unused_imports)]
+//#![forbid(unused_mut)]
+//#![forbid(unused_variables)]
+
+use std::fmt;
+use std::sync::Arc;
+
+use crate::http_server::endpoints::comments::list_comments_handler::ListCommentsPathInfo;
+use crate::http_server::endpoints::media_files::edit::set_media_file_cover_image_handler::SetMediaFileCoverImageError;
+use crate::http_server::endpoints::users::edit_username_handler::EditUsernameError;
+use crate::http_server::web_utils::response_error_helpers::to_simple_json_error;
+use crate::http_server::web_utils::user_session::require_user_session_using_connection::require_user_session_using_connection;
+use crate::state::server_state::ServerState;
+use actix_web::error::ResponseError;
+use actix_web::http::StatusCode;
+use actix_web::web::{Json, Path};
+use actix_web::{web, HttpRequest, HttpResponse};
+use composite_identifiers::by_table::tag_uses::tag_use_entity::TagUseEntity;
+use enums::by_table::comments::comment_entity_type::CommentEntityType;
+use enums::by_table::tag_uses::tag_use_entity_type::TagUseEntityType;
+use http_server_common::request::get_request_ip::get_request_ip;
+use log::warn;
+use markdown::simple_markdown_to_html::simple_markdown_to_html;
+use mysql_queries::queries::comments::comment_entity_token::CommentEntityToken;
+use mysql_queries::queries::comments::insert_comment::{insert_comment, InsertCommentArgs};
+use mysql_queries::queries::media_files::get::get_media_file::{get_media_file, get_media_file_with_transactor};
+use mysql_queries::queries::model_weights::get::get_weight::get_weight_by_token_with_transactor;
+use mysql_queries::queries::tags::create_tag::create_tag;
+use mysql_queries::queries::tags::list_tags_for_entity::list_tags_for_entity;
+use mysql_queries::queries::tags::select_matching_tags::select_matching_tags;
+use mysql_queries::queries::tags::update_tags_for_entity::update_tags_for_entity;
+use mysql_queries::utils::transactor::Transactor;
+use sqlx::MySqlConnection;
+use tokens::tokens::comments::CommentToken;
+use tokens::tokens::media_files::MediaFileToken;
+use tokens::tokens::model_weights::ModelWeightToken;
+use tokens::tokens::tags::TagToken;
+use tokens::tokens::tts_models::TtsModelToken;
+use tokens::tokens::tts_results::TtsResultToken;
+use tokens::tokens::users::UserToken;
+use tokens::tokens::w2l_results::W2lResultToken;
+use tokens::tokens::w2l_templates::W2lTemplateToken;
+use user_input_common::check_for_slurs::contains_slurs;
+use utoipa::ToSchema;
+
+/// For the URL PathInfo
+#[derive(Deserialize, ToSchema)]
+pub struct ListTagsForEntityPathInfo {
+  entity_type: TagUseEntityType,
+  entity_token: String,
+}
+
+#[derive(Serialize, ToSchema)]
+pub struct ListTagsForEntitySuccessResponse {
+  pub success: bool,
+  pub tags: Vec<String>,
+}
+
+#[derive(Debug, ToSchema)]
+pub enum ListTagsForEntityError {
+  NotFound,
+  ServerError,
+  BadInput(String),
+}
+
+impl ResponseError for ListTagsForEntityError {
+  fn status_code(&self) -> StatusCode {
+    match *self {
+      ListTagsForEntityError::NotFound => StatusCode::NOT_FOUND,
+      ListTagsForEntityError::ServerError => StatusCode::INTERNAL_SERVER_ERROR,
+      ListTagsForEntityError::BadInput(_) => StatusCode::BAD_REQUEST,
+    }
+  }
+
+  fn error_response(&self) -> HttpResponse {
+    let error_reason = match self {
+      ListTagsForEntityError::NotFound => "not found".to_string(),
+      ListTagsForEntityError::ServerError => "server error".to_string(),
+      ListTagsForEntityError::BadInput(ref reason) => reason.clone(),
+    };
+
+    to_simple_json_error(&error_reason, self.status_code())
+  }
+}
+
+// NB: Not using derive_more::Display since Clion doesn't understand it.
+impl fmt::Display for ListTagsForEntityError {
+  fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+    write!(f, "{:?}", self)
+  }
+}
+
+/// List the tags for an entity
+#[utoipa::path(
+  post,
+  tag = "Tags",
+  path = "/v1/tags/list/{entity_type}/{entity_token}",
+  responses(
+    (status = 200, description = "Success", body = ListTagsForEntitySuccessResponse),
+    (status = 400, description = "Bad input", body = ListTagsForEntityError),
+    (status = 401, description = "Not authorized", body = ListTagsForEntityError),
+    (status = 500, description = "Server error", body = ListTagsForEntityError),
+  ),
+  params(
+    ("request" = ListTagsForEntityRequest, description = "Payload for Request"),
+  )
+)]
+pub async fn list_tags_for_entity_handler(
+  http_request: HttpRequest,
+  path: Path<ListTagsForEntityPathInfo>,
+  server_state: web::Data<Arc<ServerState>>,
+) -> Result<Json<ListTagsForEntitySuccessResponse>, ListTagsForEntityError>
+{
+  let token = path.entity_token.as_str();
+  let token_prefix_matches = match path.entity_type {
+    TagUseEntityType::MediaFile => token.starts_with(MediaFileToken::token_prefix()),
+    TagUseEntityType::ModelWeight => token.starts_with(ModelWeightToken::token_prefix()),
+  };
+
+  if !token_prefix_matches {
+    warn!("invalid token prefix: {:?} for {:?}", path.entity_token, path.entity_type);
+    return Err(ListTagsForEntityError::BadInput("invalid token prefix".to_string()));
+  }
+
+  let mut mysql_connection = server_state.mysql_pool
+      .acquire()
+      .await
+      .map_err(|err| {
+        warn!("MySql pool error: {:?}", err);
+        ListTagsForEntityError::ServerError
+      })?;
+
+  let entity = TagUseEntity::from_entity_type_and_token(
+    path.entity_type, &path.entity_token);
+
+  let tags = list_tags_for_entity(entity, Transactor::for_connection(&mut *mysql_connection))
+      .await
+      .map_err(|e| {
+        warn!("error listing tags: {:?}", e);
+        ListTagsForEntityError::ServerError
+      })?;
+
+  Ok(Json(ListTagsForEntitySuccessResponse {
+    success: true,
+    tags: tags
+        .into_iter()
+        .map(|tag| tag.tag_value)
+        .collect(),
+  }))
+}

crates/service/web/storyteller_web/src/http_server/endpoints/tags/mod.rs

@@ -1 +1,2 @@
+pub mod list_tags_for_entity_handler;
 pub mod set_tags_for_entity_handler;

crates/service/web/storyteller_web/src/http_server/endpoints/tags/set_tags_for_entity_handler.rs

@@ -34,6 +34,7 @@ use sqlx::MySqlConnection;
 use tokens::tokens::comments::CommentToken;
 use tokens::tokens::media_files::MediaFileToken;
 use tokens::tokens::model_weights::ModelWeightToken;
+use tokens::tokens::tags::TagToken;
 use tokens::tokens::tts_models::TtsModelToken;
 use tokens::tokens::tts_results::TtsResultToken;
 use tokens::tokens::users::UserToken;
@@ -41,7 +42,6 @@ use tokens::tokens::w2l_results::W2lResultToken;
 use tokens::tokens::w2l_templates::W2lTemplateToken;
 use user_input_common::check_for_slurs::contains_slurs;
 use utoipa::ToSchema;
-use tokens::tokens::tags::TagToken;
 
 /// For the URL PathInfo
 #[derive(Deserialize, ToSchema)]

crates/service/web/storyteller_web/src/http_server/routes/add_routes.rs

@@ -128,6 +128,7 @@ use crate::http_server::routes::job_routes::add_job_routes;
 use crate::http_server::routes::media_files_routes::add_media_file_routes;
 use crate::http_server::routes::model_download_routes::add_model_download_routes;
 use crate::http_server::routes::moderation_routes::add_moderator_routes;
+use crate::http_server::routes::tag_routes::add_tag_routes;
 use crate::http_server::routes::user_routes::add_user_routes;
 use crate::http_server::routes::weights_routes::add_weights_routes;
 use crate::http_server::routes::workflow_routes::add_workflow_routes;
@@ -165,6 +166,7 @@ pub fn add_routes<T, B> (app: App<T>, server_environment: ServerEnvironment) ->
   app = add_voice_designer_routes(app); /* /v1/voice_designer */
   app = add_beta_key_routes(app); /* /v1/beta_keys */
   app = add_weights_routes(app);
+  app = add_tag_routes(app); /* /v1/tags */
   app = add_model_download_routes(app);
   app = add_workflow_routes(app);
   app = add_job_routes(app);

crates/service/web/storyteller_web/src/http_server/routes/mod.rs

@@ -6,4 +6,5 @@ pub mod model_download_routes;
 pub mod moderation_routes;
 pub mod user_routes;
 pub mod weights_routes;
-pub mod workflow_routes;
+pub mod workflow_routes;
+mod tag_routes;

crates/service/web/storyteller_web/src/http_server/routes/tag_routes.rs

@@ -0,0 +1,31 @@
+use crate::http_server::endpoints::tags::list_tags_for_entity_handler::list_tags_for_entity_handler;
+use crate::http_server::endpoints::tags::set_tags_for_entity_handler::set_tags_for_entity_handler;
+use actix_http::body::MessageBody;
+use actix_service::ServiceFactory;
+use actix_web::dev::{ServiceRequest, ServiceResponse};
+use actix_web::{web, App, Error, HttpResponse};
+
+pub fn add_tag_routes<T, B>(app: App<T>) -> App<T>
+where
+    B: MessageBody,
+    T: ServiceFactory<
+      ServiceRequest,
+      Config = (),
+      Response = ServiceResponse<B>,
+      Error = Error,
+      InitError = ()
+    >
+{
+  app.service(
+    web
+    ::scope("/v1/tags")
+        .service(web::resource("/list/{entity_type}{entity_token}")
+            .route(web::get().to(list_tags_for_entity_handler))
+            .route(web::head().to(|| HttpResponse::Ok()))
+        )
+        .service(web::resource("/edit/{entity_type}{entity_token}")
+            .route(web::post().to(set_tags_for_entity_handler))
+            .route(web::head().to(|| HttpResponse::Ok()))
+        )
+  )
+}