Feedback addressed!

Added documentation about the documentation
documentation system open api spec.
2026-10-24 18:59:28 -04:00 · 2023-12-05 20:26:07 -05:00 · 2023-12-05 19:14:02 -05:00 · 2023-12-05 19:00:44 -05:00
27 changed files with 247 additions and 649 deletions
@@ -2964,6 +2964,7 @@ checksum = "d530e1a18b1cb4c484e6e34556a0d948706958449fca0cab753d649f2bce3d1f"
 dependencies = [
 "equivalent",
 "hashbrown 0.14.2",
+ "serde",
 ]

 [[package]]
@@ -4393,6 +4394,30 @@ dependencies = [
 "termtree",
 ]

+[[package]]
+name = "proc-macro-error"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "da25490ff9892aab3fcf7c36f08cfb902dd3e71ca0f9f9517bea02a73a5ce38c"
+dependencies = [
+ "proc-macro-error-attr",
+ "proc-macro2",
+ "quote",
+ "syn 1.0.109",
+ "version_check",
+]
+
+[[package]]
+name = "proc-macro-error-attr"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a1be40180e52ecc98ad80b184934baf3d0d29f979574e439af5a55274b35f869"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "version_check",
+]
+
 [[package]]
 name = "proc-macro2"
 version = "1.0.69"
@@ -4876,6 +4901,41 @@ dependencies = [
 "quick-xml 0.30.0",
 ]

+[[package]]
+name = "rust-embed"
+version = "8.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b1e7d90385b59f0a6bf3d3b757f3ca4ece2048265d70db20a2016043d4509a40"
+dependencies = [
+ "rust-embed-impl",
+ "rust-embed-utils",
+ "walkdir",
+]
+
+[[package]]
+name = "rust-embed-impl"
+version = "8.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3c3d8c6fd84090ae348e63a84336b112b5c3918b3bf0493a581f7bd8ee623c29"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "rust-embed-utils",
+ "shellexpand",
+ "syn 2.0.39",
+ "walkdir",
+]
+
+[[package]]
+name = "rust-embed-utils"
+version = "8.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "873feff8cb7bf86fdf0a71bb21c95159f4e4a37dd7a4bd1855a940909b583ada"
+dependencies = [
+ "sha2 0.10.8",
+ "walkdir",
+]
+
 [[package]]
 name = "rust-ini"
 version = "0.18.0"
@@ -5411,6 +5471,15 @@ dependencies = [
 "digest 0.10.7",
 ]

+[[package]]
+name = "shellexpand"
+version = "2.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7ccc8076840c4da029af4f87e4e8daeb0fca6b87bbb02e10cb60b791450e11e4"
+dependencies = [
+ "dirs",
+]
+
 [[package]]
 name = "signal-hook-registry"
 version = "1.4.1"
@@ -5894,6 +5963,8 @@ dependencies = [
 "url_config",
 "user_input_common",
 "users_component",
+ "utoipa",
+ "utoipa-swagger-ui",
 "uuid 0.8.2",
 ]

@@ -6387,6 +6458,7 @@ dependencies = [
 "sqlx-core",
 "strum",
 "toml",
+ "utoipa",
 ]

 [[package]]
@@ -7025,6 +7097,47 @@ version = "0.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a"

+[[package]]
+name = "utoipa"
+version = "4.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0ff05e3bac2c9428f57ade702667753ca3f5cf085e2011fe697de5bfd49aa72d"
+dependencies = [
+ "indexmap",
+ "serde",
+ "serde_json",
+ "utoipa-gen",
+]
+
+[[package]]
+name = "utoipa-gen"
+version = "4.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5f0b6f4667edd64be0e820d6631a60433a269710b6ee89ac39525b872b76d61d"
+dependencies = [
+ "proc-macro-error",
+ "proc-macro2",
+ "quote",
+ "regex",
+ "syn 2.0.39",
+]
+
+[[package]]
+name = "utoipa-swagger-ui"
+version = "5.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f839caa8e09dddc3ff1c3112a91ef7da0601075ba5025d9f33ae99c4cb9b6e51"
+dependencies = [
+ "actix-web",
+ "mime_guess",
+ "regex",
+ "rust-embed",
+ "serde",
+ "serde_json",
+ "utoipa",
+ "zip",
+]
+
 [[package]]
 name = "uuid"
 version = "0.8.2"
@@ -29,7 +29,9 @@ Web API Overview
        * `tts-inference-job` - (*deprecated*) Async TTS inference of Tacotron2 models only
        * `w2l-download-job` - (*deprecated*) Async download of videos and images
        * `w2l-inference-job` - (*deprecated*) Async W2L inference
-
+    * Documentation Server:
+        * `docs` - this will run a local swagger server with the endpoints that you have access to, http://127.0.0.1:8989/api-docs/openapi.json use this to port everything over to the post man.
+        
 ### PowerStream

 * [PowerStream](https://power.stream) (deprecated) is powered by the following applications:
@@ -380,3 +380,16 @@ of this error message. You can essentially ignore it.
 ### [Fix] Can't connect to local MySQL after install on Ubuntu

 - If MySql in local dev can't be connected to, [reset the accounts](https://linuxconfig.org/how-to-reset-root-mysql-mariadb-password-on-ubuntu-20-04-focal-fossa-linux).
+
+### API Server
+```
+cargo run --bin docs
+```
+This setups an api server with swagger docs to show you responses and requests with each associated endpoint
+It is run at http://127.0.0.1:8989/
+To obtain the json for the postman collection go to this url http://127.0.0.1:8989/api-docs/openapi.json
+We use this: `https://github.com/juhaku/utoipa`
+The documentation example is in: 
+`crates/service/web/storyteller_web/src/http_server/endpoints/voice_designer/inference/enqueue_tts_request.rs`
+Write into the api doc to: 
+`crates/service/web/storyteller_web/src/api_doc.rs`
@@ -1,5 +1,4 @@
 use std::collections::BTreeSet;
-
 use serde::Deserialize;
 use serde::Serialize;
 #[cfg(test)]
@@ -30,7 +29,6 @@ pub enum MediaFileOriginCategory {
 // TODO(bt, 2022-12-21): This desperately needs MySQL integration tests!
 impl_enum_display_and_debug_using_to_str!(MediaFileOriginCategory);
 impl_mysql_enum_coders!(MediaFileOriginCategory);
-impl_mysql_from_row!(MediaFileOriginCategory);

 /// NB: Legacy API for older code.
 impl MediaFileOriginCategory {
@@ -24,7 +24,6 @@ pub enum MediaFileOriginModelType {
  /// so-vits-svc voice conversion models
  #[serde(rename = "so_vits_svc")]
  SoVitsSvc,
-
  #[serde(rename = "vall_e_x")]
  VallEX,
 }
@@ -32,7 +31,6 @@ pub enum MediaFileOriginModelType {
 // TODO(bt, 2022-12-21): This desperately needs MySQL integration tests!
 impl_enum_display_and_debug_using_to_str!(MediaFileOriginModelType);
 impl_mysql_enum_coders!(MediaFileOriginModelType);
-impl_mysql_from_row!(MediaFileOriginModelType);

 /// NB: Legacy API for older code.
 impl MediaFileOriginModelType {
@@ -39,7 +39,6 @@ pub enum MediaFileOriginProductCategory {
 // TODO(bt, 2022-12-21): This desperately needs MySQL integration tests!
 impl_enum_display_and_debug_using_to_str!(MediaFileOriginProductCategory);
 impl_mysql_enum_coders!(MediaFileOriginProductCategory);
-impl_mysql_from_row!(MediaFileOriginProductCategory);

 /// NB: Legacy API for older code.
 impl MediaFileOriginProductCategory {
@@ -25,7 +25,6 @@ pub enum MediaFileType {
 // TODO(bt, 2022-12-21): This desperately needs MySQL integration tests!
 impl_enum_display_and_debug_using_to_str!(MediaFileType);
 impl_mysql_enum_coders!(MediaFileType);
-impl_mysql_from_row!(MediaFileType);

 /// NB: Legacy API for older code.
 impl MediaFileType {
@@ -38,7 +38,6 @@ pub enum Visibility {


 impl_enum_display_and_debug_using_to_str!(Visibility);
-impl_mysql_from_row!(Visibility);

 // For reference, here's what the serde implementation might be if manually written.
 // This may be useful for designing composite types in the future:
@@ -32,4 +32,3 @@ mod macros;

 pub mod by_table;
 pub mod common;
-pub mod traits;
@@ -1,63 +0,0 @@
-
-/// Implement `MySqlFromRow` on a type.
-macro_rules! impl_mysql_from_row {
-  ($t:ident) => {
-
-    // Try to convert a MySQL row and named field into the value type (for non-nullable fields).
-    impl crate::traits::mysql_from_row::MySqlFromRow<$t> for $t {
-      fn try_from_mysql_row(row: &sqlx_mysql::MySqlRow, field_name: &str) -> Result<$t, sqlx::Error> {
-        use sqlx::{Error, Row};
-
-        // NB(bt,2023-12-05): For now only string encodings are considered.
-        // We may want to revisit in the future if we deal with binary data.
-        let value : String = row.try_get(field_name)?;
-
-        let output_type = Self::from_str(&value)
-            .map_err(|err| {
-              Error::ColumnDecode {
-                index: format!("mysql_from_row failure on field {}: {:?}", field_name, err),
-                source: format!("mysql_from_row failure on field {}: {:?}", field_name, err).into(),
-              }
-            })?;
-
-        Ok(output_type)
-      }
-
-      // Try to convert a MySQL row and named field into the value type (for nullable fields).
-      fn try_from_mysql_row_nullable(row: &sqlx_mysql::MySqlRow, field_name: &str) -> Result<Option<$t>, sqlx::Error> {
-        use sqlx::{Error, Row};
-
-        // NB(bt,2023-12-05): For now only string encodings are considered.
-        // We may want to revisit in the future if we deal with binary data.
-        // NB(2): Nullable fields decode as Option<T>.
-        let maybe_value : Option<String> = row.try_get(field_name)?;
-
-        let value = match maybe_value {
-          Some(value) => value,
-          None => return Ok(None),
-        };
-
-        let output_type = Self::from_str(&value)
-            .map_err(|err| {
-              Error::ColumnDecode {
-                index: format!("mysql_from_row failure on field {}: {:?}", field_name, err),
-                source: format!("mysql_from_row failure on field {}: {:?}", field_name, err).into(),
-              }
-            })?;
-
-        Ok(Some(output_type))
-      }
-    }
-
-    //// TODO: Tests.
-    //#[cfg(test)]
-    //#[test]
-    //fn test_name() {
-    //  use strum::IntoEnumIterator;
-    //  for variant in $t::iter() {
-    //    assert_eq!(format!("{}", variant), variant.to_str());
-    //  }
-    //}
-
-  }
-}
@@ -1,4 +1,3 @@
 #[macro_use] pub mod impl_enum_display_and_debug_using_to_str;
 #[macro_use] pub mod impl_mysql_enum_coders;
-#[macro_use] pub mod impl_mysql_from_row;
 #[macro_use] pub mod impl_sqlite_enum_coders;
@@ -1 +0,0 @@
-pub mod mysql_from_row;
@@ -1,11 +0,0 @@
-use sqlx_mysql::MySqlRow;
-
-/// This is a trait (in conjunction with the macro implementation) that makes up for sqlx's
-/// QueryBuilder not playing well with FromRow implementation or derivation of named types.
-pub trait MySqlFromRow<T> {
-
-  /// Attempt to parse a named column from a MySqlRow into the type.
-  fn try_from_mysql_row(row: &MySqlRow, field_name: &str) -> Result<T, sqlx::Error>;
-
-  fn try_from_mysql_row_nullable(row: &MySqlRow, field_name: &str) -> Result<Option<T>, sqlx::Error>;
-}
@@ -28,6 +28,8 @@ sqlx = { version = "0.7.2", features = [ "mysql", "runtime-tokio", "tls-rustls",
 sqlx-core = { version = "0.7.2" }
 my-workspace-hack = { version = "0.1", path = "../../../my-workspace-hack" }

+utoipa = { version = "4", features = ["actix_extras"] }
+
 [dev-dependencies]

 # Enum utilities
@@ -4,9 +4,10 @@ use serde::Deserialize;
 use serde::Serialize;

 use crate::prefixes::TokenPrefix;
+use utoipa::ToSchema;

 /// The primary key for "generic" inference jobs.
-#[derive(Clone, PartialEq, Eq, sqlx::Type, Debug, Serialize, Deserialize)]
+#[derive(Clone, PartialEq, Eq, sqlx::Type, Debug, Serialize, Deserialize,ToSchema)]
 #[sqlx(transparent)]
 pub struct InferenceJobToken(String);

@@ -1,242 +0,0 @@
-use chrono::{DateTime, Utc};
-use sqlx::{FromRow, MySql, MySqlPool, QueryBuilder, Row};
-use sqlx::mysql::MySqlRow;
-
-use enums::by_table::media_files::media_file_origin_category::MediaFileOriginCategory;
-use enums::by_table::media_files::media_file_origin_model_type::MediaFileOriginModelType;
-use enums::by_table::media_files::media_file_origin_product_category::MediaFileOriginProductCategory;
-use enums::by_table::media_files::media_file_type::MediaFileType;
-use enums::common::visibility::Visibility;
-use enums::traits::mysql_from_row::MySqlFromRow;
-use errors::AnyhowResult;
-use tokens::tokens::media_files::MediaFileToken;
-
-pub struct MediaFileListPage {
-  pub records: Vec<MediaFileListItem>,
-
-  pub sort_ascending: bool,
-
-  /// ID of the first record.
-  pub first_id: Option<i64>,
-
-  /// ID of the last record.
-  pub last_id: Option<i64>,
-}
-
-pub struct MediaFileListItem {
-  pub token: MediaFileToken,
-
-  pub origin_category: MediaFileOriginCategory,
-  pub origin_product_category: MediaFileOriginProductCategory,
-  pub maybe_origin_model_type: Option<MediaFileOriginModelType>,
-  pub maybe_origin_model_token: Option<String>,
-
-  pub media_type: MediaFileType,
-  pub public_bucket_directory_hash: String,
-  pub maybe_public_bucket_prefix: Option<String>,
-  pub maybe_public_bucket_extension: Option<String>,
-
-  pub creator_set_visibility: Visibility,
-
-  pub created_at: DateTime<Utc>,
-  pub updated_at: DateTime<Utc>,
-}
-
-#[derive(Clone, Copy)]
-pub enum ViewAs {
-  Author,
-  Moderator,
-  AnotherUser,
-}
-
-pub struct ListMediaFileForUserArgs<'a> {
-  pub username: &'a str,
-  pub limit: usize,
-  pub maybe_filter_media_type: Option<MediaFileType>,
-  pub maybe_offset: Option<usize>,
-  pub cursor_is_reversed: bool,
-  pub view_as: ViewAs,
-  pub mysql_pool: &'a MySqlPool,
-}
-
-pub async fn list_media_files_for_user(args: ListMediaFileForUserArgs<'_>) -> AnyhowResult<MediaFileListPage> {
-
-  let mut query = query_builder(
-    args.maybe_filter_media_type,
-    args.username,
-    args.limit,
-    args.maybe_offset,
-    args.cursor_is_reversed,
-    args.view_as,
-  );
-
-  let query = query.build_query_as::<MediaFileListItemInternal>();
-
-  let results = query.fetch_all(args.mysql_pool).await?;
-
-  let first_id = results.first()
-      .map(|raw_result| raw_result.id);
-
-  let last_id = results.last()
-      .map(|raw_result| raw_result.id);
-
-  let results = results.into_iter()
-      .map(|record| {
-        MediaFileListItem {
-          token: record.token,
-          origin_category: record.origin_category,
-          origin_product_category: record.origin_product_category,
-          maybe_origin_model_type: record.maybe_origin_model_type,
-          maybe_origin_model_token: record.maybe_origin_model_token,
-          media_type: record.media_type,
-          public_bucket_directory_hash: record.public_bucket_directory_hash,
-          maybe_public_bucket_prefix: record.maybe_public_bucket_prefix,
-          maybe_public_bucket_extension: record.maybe_public_bucket_extension,
-          creator_set_visibility: record.creator_set_visibility,
-          created_at: record.created_at,
-          updated_at: record.updated_at,
-        }
-      })
-      .collect::<Vec<_>>();
-
-  Ok(MediaFileListPage {
-    records: results,
-    sort_ascending: !args.cursor_is_reversed,
-    first_id,
-    last_id,
-  })
-}
-
-fn query_builder<'a>(
-  maybe_filter_media_type: Option<MediaFileType>,
-  username: &'a str,
-  limit: usize,
-  maybe_offset: Option<usize>,
-  cursor_is_reversed: bool,
-  view_as: ViewAs,
-) -> QueryBuilder<'a, MySql> {
-
-  // NB: Query cannot be statically checked by sqlx
-  let mut query_builder: QueryBuilder<MySql> = QueryBuilder::new(
-    r#"
-SELECT
-  m.id,
-  m.token,
-
-  m.origin_category,
-  m.origin_product_category,
-
-  m.maybe_origin_model_type,
-  m.maybe_origin_model_token,
-
-  m.media_type,
-
-  m.public_bucket_directory_hash,
-  m.maybe_public_bucket_prefix,
-  m.maybe_public_bucket_extension,
-
-  m.creator_set_visibility,
-  m.created_at,
-  m.updated_at
-
-FROM media_files AS m
-LEFT OUTER JOIN users AS u
-    ON m.maybe_creator_user_token = u.token
-
-WHERE m.user_deleted_at IS NULL
-  AND m.mod_deleted_at IS NULL
-    "#
-  );
-
-  query_builder.push(" AND u.username = ");
-  query_builder.push_bind(username);
-
-  if let Some(media_type) = maybe_filter_media_type {
-    // FIXME: Binding shouldn't require to_str().
-    //  Otherwise, it's calling the Display trait on the raw type which is resulting in an
-    //  incorrect binding and runtime error.
-    query_builder.push(" AND m.media_file_type = ");
-  }
-
-  match view_as {
-    ViewAs::Author => {}
-    ViewAs::Moderator => {}
-    ViewAs::AnotherUser => {
-      // FIXME: Binding shouldn't require to_str().
-      //  Otherwise, it's calling the Display trait on the raw type which is resulting in an
-      //  incorrect binding and runtime error.
-      query_builder.push(" AND m.creator_set_visibility = ");
-      query_builder.push_bind(Visibility::Public.to_str());
-    }
-  }
-
-  if let Some(offset) = maybe_offset {
-    if cursor_is_reversed {
-      query_builder.push(format!(" AND m.id < {offset} "));
-    } else {
-      query_builder.push(format!(" AND m.id > {offset} "));
-    }
-  }
-
-  if cursor_is_reversed {
-    query_builder.push(" ORDER BY m.id ASC ");
-  } else {
-    query_builder.push(" ORDER BY m.id DESC ");
-  }
-
-  query_builder.push(format!(" LIMIT {limit} "));
-
-  query_builder
-}
-
-struct MediaFileListItemInternal {
-  id: i64,
-  token: MediaFileToken,
-
-  origin_category: MediaFileOriginCategory,
-  origin_product_category: MediaFileOriginProductCategory,
-  maybe_origin_model_type: Option<MediaFileOriginModelType>,
-  maybe_origin_model_token: Option<String>,
-
-  media_type: MediaFileType,
-  public_bucket_directory_hash: String,
-  maybe_public_bucket_prefix: Option<String>,
-  maybe_public_bucket_extension: Option<String>,
-
-  creator_set_visibility: Visibility,
-
-  created_at: DateTime<Utc>,
-  updated_at: DateTime<Utc>,
-}
-
-// NB(bt,2023-12-05): There's an issue with type hinting in the `as` clauses with QueryBuilder (or
-// raw query strings) and sqlx::FromRow, regardless of whether it is derived of manually
-// implemented. Perhaps this will improve in the future, but for now manually constructed queries
-// cannot have type hints, eg. the following:
-//
-//    m.token as `token: tokens::tokens::media_files::MediaFileToken`,
-//    m.origin_category as `origin_category: enums::by_table::media_files::media_file_origin_category::MediaFileOriginCategory`,
-//    m.creator_set_visibility as `creator_set_visibility: enums::common::visibility::Visibility`,
-//
-// This results in the automatic mapping not being able to be found by name (for macro derive), and
-// in the manual case `row.try_get()` etc. won't have the correct column name (since the name is the
-// full "as" clause).
-impl FromRow<'_, MySqlRow> for MediaFileListItemInternal {
-  fn from_row(row: &MySqlRow) -> Result<Self, sqlx::Error> {
-    Ok(Self {
-      id: row.try_get("id")?,
-      token: MediaFileToken::new(row.try_get("token")?),
-      origin_category: MediaFileOriginCategory::try_from_mysql_row(row, "origin_category")?,
-      origin_product_category: MediaFileOriginProductCategory::try_from_mysql_row(row, "origin_product_category")?,
-      maybe_origin_model_type: MediaFileOriginModelType::try_from_mysql_row_nullable(row, "maybe_origin_model_type")?,
-      maybe_origin_model_token: row.try_get("maybe_origin_model_token")?,
-      media_type: MediaFileType::try_from_mysql_row(row, "media_type")?,
-      public_bucket_directory_hash: row.try_get("public_bucket_directory_hash")?,
-      maybe_public_bucket_prefix: row.try_get("maybe_public_bucket_prefix")?,
-      maybe_public_bucket_extension: row.try_get("maybe_public_bucket_extension")?,
-      creator_set_visibility: Visibility::try_from_mysql_row(row, "creator_set_visibility")?,
-      created_at: row.try_get("created_at")?,
-      updated_at: row.try_get("updated_at")?,
-    })
-  }
-}
@@ -1,8 +1,7 @@
-pub mod delete_media_file;
 pub mod get_media_file;
-pub mod insert_media_file_from_cli_tool;
 pub mod insert_media_file_from_face_animation;
-pub mod insert_media_file_from_voice_conversion;
 pub mod insert_media_file_from_zero_shot_tts;
-pub mod list_media_files_for_user;
+pub mod insert_media_file_from_cli_tool;
+pub mod insert_media_file_from_voice_conversion;
+pub mod delete_media_file;
 pub mod update_media_file;
@@ -13,6 +13,10 @@ publish = false
 name = "storyteller-web"
 path = "src/main.rs"

+[[bin]]
+name = "docs"
+path = "src/api_doc_server.rs"
+
 [dependencies]

 # Internal
@@ -160,6 +164,8 @@ pulldown-cmark = "0.9.3"
 # include support for async fn in traits.
 async-trait = "0.1.58"
 my-workspace-hack = { version = "0.1", path = "../../../../my-workspace-hack" }
+utoipa = { version = "4", features = ["actix_extras"] }
+utoipa-swagger-ui = { version = "5", features = ["actix-web"] }

 [build-dependencies]
 # NB: Only using diesel for migrations support
@@ -0,0 +1,11 @@
+
+use crate::http_server::endpoints::voice_designer::inference::enqueue_tts_request::EnqueueTTSRequest;
+use crate::http_server::endpoints::voice_designer::inference::enqueue_tts_request::EnqueueTTSRequestSuccessResponse;
+use crate::http_server::endpoints::voice_designer::inference::enqueue_tts_request::EnqueueTTSRequestError;
+use tokens::tokens::generic_inference_jobs::InferenceJobToken;
+
+use utoipa::OpenApi;
+#[derive(OpenApi)]
+#[openapi(paths(crate::http_server::endpoints::voice_designer::inference::enqueue_tts_request::enqueue_tts_request),
+ components(schemas(EnqueueTTSRequest,EnqueueTTSRequestSuccessResponse,EnqueueTTSRequestError,InferenceJobToken)))]
+pub struct ApiDoc;
@@ -0,0 +1,73 @@
+// Never allow these
+#![forbid(private_in_public)]
+#![forbid(unused_must_use)] // NB: It's unsafe to not close/check some things
+
+// Okay to toggle
+//#![forbid(warnings)]
+#![allow(unreachable_patterns)]
+#![allow(unused_imports)]
+#![allow(unused_mut)]
+#![allow(unused_variables)]
+
+// Always allow
+#![allow(dead_code)]
+#![allow(non_snake_case)]
+
+#[macro_use] extern crate lazy_static;
+#[macro_use] extern crate magic_crypt;
+#[macro_use] extern crate serde_derive;
+
+use utoipa_swagger_ui::SwaggerUi;
+
+use actix_web::{App, HttpServer, middleware, web};
+use actix_web::middleware::{DefaultHeaders, Logger};
+
+use r2d2_redis::r2d2;
+use r2d2_redis::redis::Commands;
+use r2d2_redis::RedisConnectionManager;
+use sqlx::mysql::MySqlPoolOptions;
+use sqlx::MySqlPool;
+use tokio::runtime::Runtime;
+
+use errors::AnyhowResult;
+
+use crate::configs::static_api_tokens::{StaticApiTokenConfig, StaticApiTokens, StaticApiTokenSet};
+use crate::server_state::{DurableInMemoryCaches, EnvConfig, EphemeralInMemoryCaches, InMemoryCaches, RedisRateLimiters, ServerInfo, ServerState, StaticFeatureFlags, StripeSettings, TrollBans, TwitchOauth, TwitchOauthSecrets};
+
+pub mod billing;
+pub mod configs;
+pub mod cookies;
+pub mod http_server;
+pub mod memory_cache;
+pub mod model;
+pub mod routes;
+pub mod server_state;
+pub mod subscriptions;
+pub mod threads;
+pub mod user_avatars;
+pub mod util;
+pub mod validations;
+
+use std::{
+  error::Error,
+  future::{self, Ready},
+  net::Ipv4Addr,
+};
+
+pub mod api_doc;
+use api_doc::ApiDoc;
+
+use futures::future::LocalBoxFuture;
+use utoipa::OpenApi;
+#[actix_web::main]
+async fn main() -> Result<(), impl Error> {
+  HttpServer::new(move || {
+      App::new()
+          .service(
+              SwaggerUi::new("/{_:.*}")
+                  .url("/api-docs/openapi.json", ApiDoc::openapi()),
+          )
+  })
+  .bind(("localhost", 8989)).unwrap()
+  .run().await
+}
@@ -1,3 +1 @@
-pub mod pagination_cursors;
-pub mod pagination_page;
 pub mod user_details_lite;
@@ -1,53 +0,0 @@
-/// Pagination by cursors
-/// These types of pagination are for "infinite scrolling", which do not reveal a number of pages.
-/// This is good so that investors and competitors cannot reveal how many database records we have.
-/// This is typically used for "discovery" type pages, not user profiles.
-///
-/// See `PaginationPage` for the other type of pagination.
-#[derive(Serialize)]
-pub struct PaginationCursors {
-
-  /// The "next" cursor.
-  /// This is an opaque (typically even encrypted) handle.
-  pub maybe_next: Option<String>,
-
-  /// The "previous" cursor.
-  /// This is an opaque (typically even encrypted) handle.
-  pub maybe_previous: Option<String>,
-
-  /// Details whether we're walking forward or backward.
-  pub cursor_is_reversed: bool,
-}
-
-#[cfg(test)]
-mod tests {
-  use crate::http_server::common_responses::pagination_cursors::PaginationCursors;
-
-  #[test]
-  fn test_serialize_empty_json() {
-    // Make sure this interface doesn't change.
-    let pagination = PaginationCursors {
-      maybe_next: None,
-      maybe_previous: None,
-      cursor_is_reversed: false,
-    };
-
-    let json = serde_json::to_string(&pagination).expect("serialization");
-
-    assert_eq!(json, "{\"maybe_next\":null,\"maybe_previous\":null,\"cursor_is_reversed\":false}")
-  }
-
-  #[test]
-  fn test_serialize_full_json() {
-    // Make sure this interface doesn't change.
-    let pagination = PaginationCursors {
-      maybe_next: Some("foo".to_string()),
-      maybe_previous: Some("bar".to_string()),
-      cursor_is_reversed: true,
-    };
-
-    let json = serde_json::to_string(&pagination).expect("serialization");
-
-    assert_eq!(json, "{\"maybe_next\":\"foo\",\"maybe_previous\":\"bar\",\"cursor_is_reversed\":true}")
-  }
-}
@@ -1,33 +0,0 @@
-/// Pagination by page id
-/// This type of pagination is by "page id" and "page count".
-/// This should never be used to walk the entire public database as competitors and investors
-/// can use it to glean information about the scale of our service.
-/// This is best used for user profiles and scoped down results.
-///
-/// See `PaginationCursors` for the other type of pagination.
-#[derive(Serialize)]
-pub struct PaginationPage {
-  /// The current page number
-  pub current: u64,
-
-  /// How many pages there are in total
-  pub total_page_count: u64,
-}
-
-#[cfg(test)]
-mod tests {
-  use crate::http_server::common_responses::pagination_page::PaginationPage;
-
-  #[test]
-  fn test_serialize() {
-    let pagination = PaginationPage {
-      current: 5,
-      total_page_count: 123,
-
-    };
-
-    let json = serde_json::to_string(&pagination).expect("serialization");
-
-    assert_eq!(json, "{\"current\":5,\"total_page_count\":123}")
-  }
-}
@@ -1,218 +0,0 @@
-use std::sync::Arc;
-
-use actix_web::{HttpMessage, HttpRequest, HttpResponse, web};
-use actix_web::error::ResponseError;
-use actix_web::http::StatusCode;
-use actix_web::web::{Path, Query};
-use chrono::{DateTime, Utc};
-use log::{info, warn};
-
-use enums::by_table::media_files::media_file_origin_category::MediaFileOriginCategory;
-use enums::by_table::media_files::media_file_origin_model_type::MediaFileOriginModelType;
-use enums::by_table::media_files::media_file_origin_product_category::MediaFileOriginProductCategory;
-use enums::by_table::media_files::media_file_type::MediaFileType;
-use enums::common::visibility::Visibility;
-use mysql_queries::queries::media_files::list_media_files_for_user::{list_media_files_for_user, ListMediaFileForUserArgs, ViewAs};
-use tokens::tokens::media_files::MediaFileToken;
-
-use crate::http_server::common_responses::pagination_cursors::PaginationCursors;
-use crate::http_server::web_utils::response_error_helpers::to_simple_json_error;
-use crate::server_state::ServerState;
-
-#[derive(Deserialize)]
-pub struct PathInfo {
-  username: String,
-}
-
-#[derive(Deserialize)]
-pub struct QueryParams {
-  pub sort_ascending: Option<bool>,
-  pub limit: Option<usize>,
-  pub cursor: Option<String>,
-  pub cursor_is_reversed: Option<bool>,
-  pub filter_media_type: Option<MediaFileType>,
-}
-
-#[derive(Serialize)]
-pub struct SuccessResponse {
-  pub success: bool,
-  pub results: Vec<MediaFileListItem>,
-  pub pagination: PaginationCursors,
-}
-
-#[derive(Serialize)]
-pub struct MediaFileListItem {
-  pub token: MediaFileToken,
-
-  pub origin_category: MediaFileOriginCategory,
-  pub origin_product_category: MediaFileOriginProductCategory,
-  pub maybe_origin_model_type: Option<MediaFileOriginModelType>,
-  pub maybe_origin_model_token: Option<String>,
-
-  pub media_type: MediaFileType,
-  pub public_bucket_directory_hash: String,
-  pub maybe_public_bucket_prefix: Option<String>,
-  pub maybe_public_bucket_extension: Option<String>,
-
-  pub creator_set_visibility: Visibility,
-
-  pub created_at: DateTime<Utc>,
-  pub updated_at: DateTime<Utc>,
-}
-
-#[derive(Debug)]
-pub enum ErrorResponse {
-  ServerError,
-}
-
-impl ResponseError for ErrorResponse {
-  fn status_code(&self) -> StatusCode {
-    match *self {
-      ErrorResponse::ServerError => StatusCode::INTERNAL_SERVER_ERROR,
-    }
-  }
-
-  fn error_response(&self) -> HttpResponse {
-    let error_reason = match self {
-      ErrorResponse::ServerError => "server error".to_string(),
-    };
-
-    to_simple_json_error(&error_reason, self.status_code())
-  }
-}
-
-impl std::fmt::Display for ErrorResponse {
-  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-    write!(f, "{:?}", self)
-  }
-}
-
-pub async fn list_media_files_for_user_handler(
-  http_request: HttpRequest,
-  path: Path<PathInfo>,
-  query: Query<QueryParams>,
-  server_state: web::Data<Arc<ServerState>>
-) -> Result<HttpResponse, ErrorResponse>
-{
-  info!("Fetching inference results for user: {}", &path.username);
-
-  let maybe_user_session = server_state
-      .session_checker
-      .maybe_get_user_session(&http_request, &server_state.mysql_pool)
-      .await
-      .map_err(|e| {
-        warn!("Session checker error: {:?}", e);
-        ErrorResponse::ServerError
-      })?;
-
-  let mut is_author = false;
-  let mut is_mod = false;
-
-  match maybe_user_session {
-    None => {},
-    Some(session) => {
-      is_author = session.username == path.username;
-      is_mod = session.can_ban_users;
-    },
-  };
-
-  // TODO(bt,2023-12-04): Enforce real maximums and defaults
-  let limit = query.limit.unwrap_or(25);
-
-  let sort_ascending = query.sort_ascending.unwrap_or(false);
-  let cursor_is_reversed = query.cursor_is_reversed.unwrap_or(false);
-
-  let cursor = if let Some(cursor) = query.cursor.as_deref() {
-    let cursor = server_state.sort_key_crypto.decrypt_id(cursor)
-        .map_err(|e| {
-          warn!("crypto error: {:?}", e);
-          ErrorResponse::ServerError
-        })?;
-    Some(cursor as usize)
-  } else {
-    None
-  };
-
-  let view_as = if is_author {
-    ViewAs::Author
-  } else if is_mod {
-    ViewAs::Moderator
-  } else {
-    ViewAs::AnotherUser
-  };
-
-  let query_results = list_media_files_for_user(ListMediaFileForUserArgs {
-    username: &path.username,
-    limit,
-    maybe_filter_media_type: query.filter_media_type,
-    maybe_offset: cursor,
-    cursor_is_reversed,
-    view_as,
-    mysql_pool: &server_state.mysql_pool,
-  }).await;
-
-
-  let results_page = match query_results {
-    Ok(results) => results,
-    Err(e) => {
-      warn!("Query error: {:?}", e);
-      return Err(ErrorResponse::ServerError);
-    }
-  };
-
-  let cursor_next = if let Some(id) = results_page.last_id {
-    let cursor = server_state.sort_key_crypto.encrypt_id(id as u64)
-        .map_err(|e| {
-          warn!("crypto error: {:?}", e);
-          ErrorResponse::ServerError
-        })?;
-    Some(cursor)
-  } else {
-    None
-  };
-
-  let cursor_previous = if let Some(id) = results_page.first_id {
-    let cursor = server_state.sort_key_crypto.encrypt_id(id as u64)
-        .map_err(|e| {
-          warn!("crypto error: {:?}", e);
-          ErrorResponse::ServerError
-        })?;
-    Some(cursor)
-  } else {
-    None
-  };
-
-  let results = results_page.records.into_iter()
-      .map(|record| MediaFileListItem {
-        token: record.token,
-        origin_category: record.origin_category,
-        origin_product_category: record.origin_product_category,
-        maybe_origin_model_type: record.maybe_origin_model_type,
-        maybe_origin_model_token: record.maybe_origin_model_token,
-        media_type: record.media_type,
-        public_bucket_directory_hash: record.public_bucket_directory_hash,
-        maybe_public_bucket_prefix: record.maybe_public_bucket_prefix,
-        maybe_public_bucket_extension: record.maybe_public_bucket_extension,
-        creator_set_visibility: record.creator_set_visibility,
-        created_at: record.created_at,
-        updated_at: record.updated_at,
-      })
-      .collect::<Vec<_>>();
-
-  let response = SuccessResponse {
-    success: true,
-    results,
-    pagination: PaginationCursors {
-      maybe_next: cursor_next,
-      maybe_previous: cursor_previous,
-      cursor_is_reversed,
-    }
-  };
-
-  let body = serde_json::to_string(&response)
-      .map_err(|e| ErrorResponse::ServerError)?;
-
-  Ok(HttpResponse::Ok()
-      .content_type("application/json")
-      .body(body))
-}
@@ -1,4 +1,3 @@
-pub mod delete_media_file;
 pub mod drain_multipart_request;
 pub mod get_media_file;
-pub mod list_media_files_for_user;
+pub mod delete_media_file;
@@ -1,8 +1,8 @@
 #![forbid(unused_imports)]
 #![forbid(unused_mut)]
 #![forbid(unused_variables)]
+use utoipa::ToSchema;

-// TODO MOVE into own file.
 use std::fmt::Debug;
 use std::sync::Arc;

@@ -42,7 +42,9 @@ const DEBUG_HEADER_NAME: &str = "enable-debug-mode";
 /// This is useful for catching the live logs or intercepting the job.
 const ROUTING_TAG_HEADER_NAME: &str = "routing-tag";

+
 #[derive(Deserialize)]
+#[derive(ToSchema)]
 pub struct EnqueueTTSRequest {
    uuid_idempotency_token: String,
    text: String,
@@ -50,12 +52,14 @@ pub struct EnqueueTTSRequest {
 }

 #[derive(Serialize)]
+#[derive(ToSchema)]
 pub struct EnqueueTTSRequestSuccessResponse {
    pub success: bool,
    pub inference_job_token: InferenceJobToken,
 }

 #[derive(Debug)]
+#[derive(ToSchema)]
 pub enum EnqueueTTSRequestError {
    BadInput(String),
    NotAuthorized,
@@ -95,13 +99,26 @@ impl std::fmt::Display for EnqueueTTSRequestError {
 // Reference enqueue_infer_tts_handler.rs for checks: rate limiting / user sessions
 // insert generic inference job.rs
 // Need to convert it to generic inference job.
+#[utoipa::path(
+    post,
+    path = "/inference/enqueue_tts/",
+    responses(
+        (status = 200, description = "Enqueue TTS generically", body = EnqueueTTSRequestSuccessResponse),
+        (status = 400, description = "Bad input", body = EnqueueTTSRequestError),
+        (status = 401, description = "Not authorized", body = EnqueueTTSRequestError),
+        (status = 429, description = "Rate limited", body = EnqueueTTSRequestError),
+        (status = 500, description = "Server error", body = EnqueueTTSRequestError)
+    ),
+    params(
+        ("request" = EnqueueTTSRequest, description = "Payload for TTS Request")
+    )
+)]
 pub async fn enqueue_tts_request(
    http_request: HttpRequest,
    request: web::Json<EnqueueTTSRequest>,
    server_state: web::Data<Arc<ServerState>>
 ) -> Result<HttpResponse, EnqueueTTSRequestError> {
-    println!("Received payload");
-
+    
    let mut maybe_user_token: Option<UserToken> = None;

    let mut mysql_connection = server_state.mysql_pool.acquire().await.map_err(|err| {
@@ -44,7 +44,6 @@ use crate::http_server::endpoints::investor_demo::enable_demo_mode_handler::enab
 use crate::http_server::endpoints::leaderboard::get_leaderboard::leaderboard_handler;
 use crate::http_server::endpoints::media_files::delete_media_file::delete_media_file_handler;
 use crate::http_server::endpoints::media_files::get_media_file::get_media_file_handler;
-use crate::http_server::endpoints::media_files::list_media_files_for_user::list_media_files_for_user_handler;
 use crate::http_server::endpoints::media_uploads::list_user_media_uploads_of_type::list_user_media_uploads_of_type_handler;
 use crate::http_server::endpoints::media_uploads::upload_audio::upload_audio_handler;
 use crate::http_server::endpoints::media_uploads::upload_image::upload_image_handler;
@@ -162,7 +161,6 @@ pub fn add_routes<T, B> (app: App<T>, server_environment: ServerEnvironment) ->
        InitError = (),
      >,
 {
-  
  let mut app = add_moderator_routes(app); /* /moderation */
  app = add_tts_routes(app); /* /tts */
  app = add_w2l_routes(app); /* /w2l */
@@ -1007,10 +1005,6 @@ fn add_media_file_routes<T, B> (app: App<T>) -> App<T>
          .route(web::delete().to(delete_media_file_handler))
          .route(web::head().to(|| HttpResponse::Ok()))
      )
-      .service(web::resource("/user/{username}")
-          .route(web::get().to(list_media_files_for_user_handler))
-          .route(web::head().to(|| HttpResponse::Ok()))
-      )
  )
 }
Author	SHA1	Message	Date
Michael Chung	0033af73ce	Feedback addressed!	2023-12-05 20:26:07 -05:00
Michael Chung	b5fcc3cdfa	Added documentation about the documentation	2023-12-05 19:14:02 -05:00
Michael Chung	e986a44e9d	documentation system open api spec.	2023-12-05 19:00:44 -05:00