new find_by for overarching goals

Author: calebbourg

domain/src/overarching_goal.rs

@@ -1 +1,20 @@
-pub use entity_api::overarching_goal::{create, find_by, find_by_id, update, update_status};
+use crate::error::Error;
+use crate::overarching_goals::Model;
+use entity_api::IntoQueryFilterMap;
+use entity_api::{overarching_goals, query};
+use sea_orm::DatabaseConnection;
+
+pub use entity_api::overarching_goal::{create, find_by_id, update, update_status};
+
+pub async fn find_by(
+    db: &DatabaseConnection,
+    params: impl IntoQueryFilterMap,
+) -> Result<Vec<Model>, Error> {
+    let overarching_goals = query::find_by::<overarching_goals::Entity, overarching_goals::Column>(
+        db,
+        params.into_query_filter_map(),
+    )
+    .await?;
+
+    Ok(overarching_goals)
+}

entity_api/src/overarching_goal.rs

@@ -1,6 +1,5 @@
 use super::error::{EntityApiErrorKind, Error};
-use crate::uuid_parse_str;
-use entity::overarching_goals::{self, ActiveModel, Entity, Model};
+use entity::overarching_goals::{ActiveModel, Entity, Model};
 use entity::{status::Status, Id};
 use sea_orm::ActiveValue;
 use sea_orm::{
@@ -9,7 +8,6 @@ use sea_orm::{
     ActiveValue::{Set, Unchanged},
     DatabaseConnection, TryIntoModel,
 };
-use std::collections::HashMap;
 
 use log::*;
 
@@ -136,32 +134,6 @@ pub async fn find_by_id(db: &DatabaseConnection, id: Id) -> Result<Model, Error>
     })
 }
 
-pub async fn find_by(
-    db: &DatabaseConnection,
-    query_params: HashMap<String, String>,
-) -> Result<Vec<Model>, Error> {
-    let mut query = Entity::find();
-
-    for (key, value) in query_params {
-        match key.as_str() {
-            "coaching_session_id" => {
-                let coaching_session_id = uuid_parse_str(&value)?;
-
-                query = query
-                    .filter(overarching_goals::Column::CoachingSessionId.eq(coaching_session_id));
-            }
-            _ => {
-                return Err(Error {
-                    source: None,
-                    error_kind: EntityApiErrorKind::InvalidQueryTerm,
-                });
-            }
-        }
-    }
-
-    Ok(query.all(db).await?)
-}
-
 #[cfg(test)]
 // We need to gate seaORM's mock feature behind conditional compilation because
 // the feature removes the Clone trait implementation from seaORM's DatabaseConnection.
@@ -170,7 +142,7 @@ pub async fn find_by(
 mod tests {
     use super::*;
     use entity::{overarching_goals::Model, Id};
-    use sea_orm::{DatabaseBackend, MockDatabase, Transaction};
+    use sea_orm::{DatabaseBackend, MockDatabase};
 
     #[tokio::test]
     async fn create_returns_a_new_overarching_goal_model() -> Result<(), Error> {
@@ -292,30 +264,4 @@ mod tests {
 
         Ok(())
     }
-
-    #[tokio::test]
-    async fn find_by_returns_all_overarching_goals_associated_with_coaching_session(
-    ) -> Result<(), Error> {
-        let db = MockDatabase::new(DatabaseBackend::Postgres).into_connection();
-        let mut query_params = HashMap::new();
-        let coaching_session_id = Id::new_v4();
-
-        query_params.insert(
-            "coaching_session_id".to_owned(),
-            coaching_session_id.to_string(),
-        );
-
-        let _ = find_by(&db, query_params).await;
-
-        assert_eq!(
-            db.into_transaction_log(),
-            [Transaction::from_sql_and_values(
-                DatabaseBackend::Postgres,
-                r#"SELECT "overarching_goals"."id", "overarching_goals"."coaching_session_id", "overarching_goals"."user_id", "overarching_goals"."title", "overarching_goals"."body", CAST("overarching_goals"."status" AS text), "overarching_goals"."status_changed_at", "overarching_goals"."completed_at", "overarching_goals"."created_at", "overarching_goals"."updated_at" FROM "refactor_platform"."overarching_goals" WHERE "overarching_goals"."coaching_session_id" = $1"#,
-                [coaching_session_id.into()]
-            )]
-        );
-
-        Ok(())
-    }
 }

web/src/controller/overarching_goal_controller.rs

@@ -2,6 +2,7 @@ use crate::controller::ApiResponse;
 use crate::extractors::{
     authenticated_user::AuthenticatedUser, compare_api_version::CompareApiVersion,
 };
+use crate::params::overarching_goal::IndexParams;
 use crate::{AppState, Error};
 use axum::extract::{Path, Query, State};
 use axum::http::StatusCode;
@@ -10,7 +11,6 @@ use axum::Json;
 use domain::overarching_goal as OverarchingGoalApi;
 use domain::{overarching_goals::Model, Id};
 use service::config::ApiVersion;
-use std::collections::HashMap;
 
 use log::*;
 
@@ -188,7 +188,7 @@ pub async fn index(
     // TODO: create a new Extractor to authorize the user to access
     // the data requested
     State(app_state): State<AppState>,
-    Query(params): Query<HashMap<String, String>>,
+    Query(params): Query<IndexParams>,
 ) -> Result<impl IntoResponse, Error> {
     debug!("GET all Overarching Goals");
     debug!("Filter Params: {:?}", params);

web/src/params/mod.rs

@@ -15,3 +15,4 @@ pub(crate) mod action;
 pub(crate) mod agreement;
 pub(crate) mod coaching_session;
 pub(crate) mod jwt;
+pub(crate) mod overarching_goal;

web/src/params/overarching_goal.rs

@@ -0,0 +1,23 @@
+use domain::Id;
+use sea_orm::Value;
+use serde::Deserialize;
+use utoipa::IntoParams;
+
+use domain::{IntoQueryFilterMap, QueryFilterMap};
+
+#[derive(Debug, Deserialize, IntoParams)]
+pub(crate) struct IndexParams {
+    pub(crate) coaching_session_id: Id,
+}
+
+impl IntoQueryFilterMap for IndexParams {
+    fn into_query_filter_map(self) -> QueryFilterMap {
+        let mut query_filter_map = QueryFilterMap::new();
+        query_filter_map.insert(
+            "coaching_session_id".to_string(),
+            Some(Value::Uuid(Some(Box::new(self.coaching_session_id)))),
+        );
+
+        query_filter_map
+    }
+}