Move models to owning services and simplify lib imports

cronback-api-model/src/run.rs

@@ -2,7 +2,7 @@ use chrono::{DateTime, Utc};
 #[cfg(feature = "dto")]
 use dto::{FromProto, IntoProto};
 #[cfg(feature = "dto")]
-use lib::types::RunId;
+use lib::prelude::*;
 use serde::{Deserialize, Serialize};
 use serde_with::{serde_as, skip_serializing_none};
 use strum::Display;

cronback-api-model/src/trigger.rs

@@ -56,7 +56,7 @@ pub struct Trigger {
     // or outputed in the API. This is here just for IntoProto to work
     #[cfg_attr(feature = "server", serde(skip))]
     #[cfg(feature = "dto")]
-    pub id: Option<lib::types::TriggerId>,
+    pub id: Option<lib::prelude::TriggerId>,
     #[cfg_attr(
         feature = "validation",
         validate(length(

cronback-lib/clients/mod.rs

@@ -1,3 +1,7 @@
-pub mod dispatcher_client;
-pub mod metadata_srv_client;
-pub mod scheduler_client;
+mod dispatcher_client;
+mod metadata_srv_client;
+mod scheduler_client;
+
+pub use dispatcher_client::*;
+pub use metadata_srv_client::*;
+pub use scheduler_client::*;

cronback-lib/database/mod.rs

@@ -1,11 +1,9 @@
-pub mod attempt_log_store;
 mod errors;
-pub mod models;
-pub mod pagination;
-pub mod run_store;
+mod pagination;
 
 pub use errors::DatabaseError;
 use migration::{Migrator, MigratorTrait};
+pub use pagination::*;
 use sea_orm::TransactionTrait;
 
 #[derive(Clone)]

cronback-lib/events.rs

@@ -1,4 +1,3 @@
-pub use proto::events::*;
 ///  e!(context = ctx, TriggerRunCreated { meta: run.meta().into() });
 #[macro_export]
 macro_rules! e {
@@ -31,7 +30,7 @@ macro_rules! e {
 }
 
 /// Emits the event to the current events subscriber
-pub fn log_event(event: Event) {
+pub fn log_event(event: proto::events::Event) {
     // serialize the event to JSON and log it to target `events`
     let event = serde_json::to_string(&event).unwrap();
     tracing::info!(target: "events", "{}", event);

cronback-lib/grpc_client_provider.rs

@@ -180,7 +180,7 @@ impl<T: GrpcClientType> GrpcClientFactory for GrpcClientProvider<T> {
     }
 }
 
-pub mod test_helpers {
+pub mod grpc_test_helpers {
     use std::sync::Arc;
 
     use hyper::Uri;

cronback-lib/lib.rs

@@ -1,23 +1,32 @@
-pub mod clients;
-pub mod config;
+mod config;
 mod consts;
-pub mod database;
-pub mod grpc_client_provider;
+mod database;
+mod grpc_client_provider;
 mod grpc_helpers;
-pub mod model;
+mod model;
+mod rpc_middleware;
+mod shutdown;
+mod types;
+
+pub mod clients;
+pub mod events;
 pub mod netutils;
-pub mod rpc_middleware;
 pub mod service;
-pub mod shutdown;
-pub mod types;
 
-pub mod events;
 mod ext;
 
+pub use grpc_client_provider::*;
+pub use rpc_middleware::*;
+pub use shutdown::*;
+
+pub use crate::config::*;
+
 pub mod prelude {
     pub use crate::consts::*;
+    pub use crate::database::*;
     pub use crate::events::e;
     pub use crate::ext::*;
     pub use crate::grpc_helpers::*;
     pub use crate::model::*;
+    pub use crate::types::*;
 }

cronback-lib/types/mod.rs

@@ -9,14 +9,3 @@ pub use ids::*;
 pub use payload::*;
 pub use request::*;
 pub use webhook::*;
-
-// Re-export the database models from this lib as well to reduce the amount
-// of changes in the same PR. TODO: Move the models out of the shared lib
-// and into their own components
-pub use crate::database::models::attempts::{
-    AttemptDetails,
-    AttemptStatus,
-    Model as Attempt,
-    WebhookAttemptDetails,
-};
-pub use crate::database::models::runs::{Model as Run, RunStatus};

cronback-services/src/api/auth.rs

@@ -4,10 +4,7 @@ use std::str::FromStr;
 use base64::Engine;
 use chrono::Utc;
 use cronback_api_model::admin::CreateAPIkeyRequest;
-use lib::database::models::api_keys;
-use lib::database::DatabaseError;
-use lib::prelude::ValidShardedId;
-use lib::types::ProjectId;
+use lib::prelude::*;
 use once_cell::sync::Lazy;
 use regex::Regex;
 use sha2::{Digest, Sha512};
@@ -16,6 +13,7 @@ use tracing::error;
 use uuid::Uuid;
 
 use super::auth_store::AuthStore;
+use super::db_model::{api_keys, ApiKey};
 use super::errors::ApiError;
 
 pub static API_KEY_PREFIX: &str = "sk_";
@@ -63,7 +61,7 @@ impl Authenticator {
         let key = SecretApiKey::generate();
         let hashed = key.hash(HashVersion::default());
 
-        let model = api_keys::Model {
+        let model = ApiKey {
             key_id: hashed.key_id,
             hash: hashed.hash,
             hash_version: hashed.hash_version.to_string(),
@@ -123,7 +121,7 @@ impl Authenticator {
     pub async fn list_keys(
         &self,
         project: &ValidShardedId<ProjectId>,
-    ) -> Result<Vec<api_keys::Model>, AuthError> {
+    ) -> Result<Vec<ApiKey>, AuthError> {
         let res = self.store.list_keys(project).await?;
         Ok(res)
     }
@@ -235,8 +233,6 @@ mod tests {
     use std::str::FromStr;
 
     use cronback_api_model::admin::CreateAPIkeyRequest;
-    use lib::database::Database;
-    use lib::types::ProjectId;
 
     use super::*;
     use crate::api::auth_store::SqlAuthStore;

cronback-services/src/api/auth_middleware.rs

@@ -4,8 +4,7 @@ use axum::extract::State;
 use axum::http::{self, HeaderMap, HeaderValue, Request};
 use axum::middleware::Next;
 use axum::response::IntoResponse;
-use lib::model::{ModelId, ValidShardedId};
-use lib::types::ProjectId;
+use lib::prelude::*;
 
 use super::auth::{AuthError, SecretApiKey};
 use super::errors::ApiError;

cronback-services/src/api/auth_store.rs

@@ -1,24 +1,19 @@
 use async_trait::async_trait;
-use lib::database::models::api_keys;
-use lib::database::models::prelude::ApiKeys;
-use lib::database::{Database, DatabaseError};
-use lib::model::ValidShardedId;
-use lib::types::ProjectId;
+use lib::prelude::*;
 use sea_orm::{ColumnTrait, EntityTrait, QueryFilter};
 
+use crate::api::db_model::{api_keys, ApiKey, ApiKeys};
+
 pub type AuthStoreError = DatabaseError;
 
 #[async_trait]
 pub trait AuthStore {
-    async fn save_key(
-        &self,
-        key: api_keys::Model,
-    ) -> Result<(), AuthStoreError>;
+    async fn save_key(&self, key: ApiKey) -> Result<(), AuthStoreError>;
 
     async fn get_key(
         &self,
         key: &str,
-    ) -> Result<Option<api_keys::Model>, AuthStoreError>;
+    ) -> Result<Option<ApiKey>, AuthStoreError>;
 
     /// Returns true if the key got deleted, false if the key didn't exist
     async fn delete_key(
@@ -30,7 +25,7 @@ pub trait AuthStore {
     async fn list_keys(
         &self,
         project: &ValidShardedId<ProjectId>,
-    ) -> Result<Vec<api_keys::Model>, AuthStoreError>;
+    ) -> Result<Vec<ApiKey>, AuthStoreError>;
 }
 
 pub struct SqlAuthStore {
@@ -45,21 +40,16 @@ impl SqlAuthStore {
 
 #[async_trait]
 impl AuthStore for SqlAuthStore {
-    async fn save_key(
-        &self,
-        key: api_keys::Model,
-    ) -> Result<(), AuthStoreError> {
+    async fn save_key(&self, key: ApiKey) -> Result<(), AuthStoreError> {
         let active_model: api_keys::ActiveModel = key.into();
-        api_keys::Entity::insert(active_model)
-            .exec(&self.db.orm)
-            .await?;
+        ApiKeys::insert(active_model).exec(&self.db.orm).await?;
         Ok(())
     }
 
     async fn get_key(
         &self,
         key_id: &str,
-    ) -> Result<Option<api_keys::Model>, AuthStoreError> {
+    ) -> Result<Option<ApiKey>, AuthStoreError> {
         let res = ApiKeys::find_by_id(key_id).one(&self.db.orm).await?;
         Ok(res)
     }
@@ -80,7 +70,7 @@ impl AuthStore for SqlAuthStore {
     async fn list_keys(
         &self,
         project: &ValidShardedId<ProjectId>,
-    ) -> Result<Vec<api_keys::Model>, AuthStoreError> {
+    ) -> Result<Vec<ApiKey>, AuthStoreError> {
         let results = ApiKeys::find()
             .filter(api_keys::Column::ProjectId.eq(project.clone()))
             .all(&self.db.orm)
@@ -91,27 +81,22 @@ impl AuthStore for SqlAuthStore {
 
 #[cfg(test)]
 mod tests {
-
     use chrono::Utc;
-    use lib::database::models::api_keys::{self, Metadata};
-    use lib::database::Database;
-    use lib::prelude::ValidShardedId;
-    use lib::types::ProjectId;
 
-    use super::{AuthStore, SqlAuthStore};
+    use super::*;
 
     fn build_model(
         key_id: &str,
         project: &ValidShardedId<ProjectId>,
-    ) -> api_keys::Model {
-        api_keys::Model {
+    ) -> ApiKey {
+        ApiKey {
             key_id: key_id.to_string(),
             hash: "hashash".to_string(),
             hash_version: "v1".to_string(),
             project_id: project.clone(),
             name: key_id.to_string(),
             created_at: Utc::now(),
-            metadata: Metadata {
+            metadata: api_keys::Metadata {
                 creator_user_id: None,
             },
         }

cronback-lib/database/models/api_keys.rs → cronback-services/src/api/db_model/api_keys.rs

@@ -1,12 +1,10 @@
 //! `SeaORM` Entity. Generated by sea-orm-codegen 0.11.3
 
 use chrono::{DateTime, Utc};
+use lib::prelude::*;
 use sea_orm::entity::prelude::*;
 use serde::{Deserialize, Serialize};
 
-use crate::model::ValidShardedId;
-use crate::types::ProjectId;
-
 #[derive(Clone, Debug, PartialEq, DeriveEntityModel, Eq)]
 #[sea_orm(table_name = "api_keys")]
 pub struct Model {

cronback-services/src/api/db_model/mod.rs

@@ -0,0 +1,2 @@
+pub(crate) mod api_keys;
+pub(crate) use api_keys::{Entity as ApiKeys, Model as ApiKey};

cronback-services/src/api/errors.rs

@@ -5,7 +5,7 @@ use axum::extract::rejection::JsonRejection;
 use axum::http::StatusCode;
 use axum::response::{IntoResponse, Response};
 use axum::Json;
-use lib::grpc_client_provider::GrpcClientError;
+use lib::GrpcClientError;
 use serde::Serialize;
 use serde_with::skip_serializing_none;
 use thiserror::Error;

cronback-services/src/api/extractors.rs

@@ -4,7 +4,7 @@ use axum::extract::{FromRequest, FromRequestParts, Path};
 use axum::http::request::Parts;
 use axum::http::Request;
 use axum::Json;
-use lib::model::{ModelId, ValidShardedId};
+use lib::prelude::*;
 use serde::de::DeserializeOwned;
 use validator::Validate;
 

cronback-services/src/api/handlers/admin/api_keys.rs

@@ -9,8 +9,7 @@ use cronback_api_model::admin::{
     CreateAPIKeyResponse,
     CreateAPIkeyRequest,
 };
-use lib::model::ValidShardedId;
-use lib::types::ProjectId;
+use lib::prelude::*;
 use proto::common::PaginationOut;
 
 use crate::api::errors::ApiError;

cronback-services/src/api/handlers/admin/projects.rs

@@ -5,8 +5,7 @@ use axum::response::IntoResponse;
 use axum::{Extension, Json};
 use cronback_api_model::admin::CreateProjectResponse as CreateProjectHttpResponse;
 use hyper::StatusCode;
-use lib::prelude::ModelId;
-use lib::types::{ProjectId, RequestId};
+use lib::prelude::*;
 use proto::metadata_svc::{CreateProjectRequest, SetProjectStatusRequest};
 use proto::projects::ProjectStatus;
 

cronback-services/src/api/handlers/triggers/cancel.rs

@@ -2,12 +2,11 @@ use std::sync::Arc;
 
 use axum::extract::{Path, State};
 use axum::{Extension, Json};
-use lib::model::ValidShardedId;
-use lib::types::{ProjectId, RequestId};
+use lib::prelude::*;
 use proto::scheduler_svc::CancelTriggerRequest;
 
+use crate::api::api_model::Trigger;
 use crate::api::errors::ApiError;
-use crate::api::model::Trigger;
 use crate::api::AppState;
 
 #[tracing::instrument(skip(state))]

cronback-services/src/api/handlers/triggers/delete.rs

@@ -4,8 +4,7 @@ use axum::extract::{Path, State};
 use axum::http::StatusCode;
 use axum::response::IntoResponse;
 use axum::{debug_handler, Extension};
-use lib::model::ValidShardedId;
-use lib::types::{ProjectId, RequestId};
+use lib::prelude::*;
 use proto::scheduler_svc::DeleteTriggerRequest;
 
 use crate::api::errors::ApiError;

cronback-services/src/api/handlers/triggers/get.rs

@@ -5,13 +5,12 @@ use axum::http::StatusCode;
 use axum::response::IntoResponse;
 use axum::{debug_handler, Extension, Json};
 use axum_extra::extract::Query;
-use lib::model::ValidShardedId;
-use lib::types::{ProjectId, RequestId};
+use lib::prelude::*;
 use proto::scheduler_svc::{GetTriggerRequest, ListTriggersRequest};
 use validator::Validate;
 
+use crate::api::api_model::{Trigger, TriggersFilter};
 use crate::api::errors::ApiError;
-use crate::api::model::{Trigger, TriggersFilter};
 use crate::api::paginated::{Paginated, Pagination};
 use crate::api::AppState;