1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
//! Grpc Simple resource Traits
pub use crate::common::ArrErr;
use std::collections::HashMap;
use std::str::FromStr;
use tokio_postgres::Row;
use tonic::{Code, Request, Response, Status};
use uuid::Uuid;
use super::server::*;
use super::GrpcDataObjectType;
use crate::postgres::linked_resource::PsqlType;
use crate::postgres::simple_resource::PsqlType as PsqlSimpleType;
use crate::postgres::PsqlSearch;
use crate::resources::base::linked_resource::{LinkedResource, ObjectType};
use crate::resources::base::simple_resource::SimpleResource;
use crate::resources::base::Resource;
/// Generic gRPC object traits to provide wrappers for common `Resource` functions
///
/// T: `ResourceObject<super::Data>` Resource type of 'super' resource being linked
/// U: `super::Data` Data type of 'super' resource being linked
/// V: `ResourceObject<Data>` combined resource Resource type
/// W: `Data` combined resource Data type
#[tonic::async_trait]
pub trait GrpcLinkService
where
<Self as GrpcLinkService>::LinkedResourceObject: ObjectType<Self::LinkedData>
+ PsqlType
+ PsqlSearch
+ LinkedResource<Self::LinkedData>
+ From<Ids>
+ From<Self::LinkedData>
+ Clone
+ Sync
+ Send
+ 'static,
<Self as GrpcLinkService>::LinkedData: GrpcDataObjectType + TryFrom<Row> + 'static,
<Self as GrpcLinkService>::ResourceObject: ObjectType<Self::Data>
+ PsqlType
+ PsqlSearch
+ SimpleResource<Self::Data>
+ From<Id>
+ From<Self::Data>
+ Clone
+ Sync
+ Send
+ 'static,
<Self as GrpcLinkService>::Data: GrpcDataObjectType + TryFrom<Row> + 'static,
<Self as GrpcLinkService>::OtherResourceObject: ObjectType<Self::OtherData>
+ PsqlType
+ PsqlSearch
+ SimpleResource<Self::OtherData>
+ From<Id>
+ From<Self::OtherData>
+ Clone
+ Sync
+ Send
+ 'static,
<Self as GrpcLinkService>::OtherData: GrpcDataObjectType + TryFrom<Row> + 'static,
<Self as GrpcLinkService>::OtherList: TryFrom<Vec<Row>>,
Status: From<<Self::LinkedData as TryFrom<Row>>::Error>
+ From<<Self::OtherList as TryFrom<Vec<Row>>>::Error>,
{
/// The type expected for the `ResourceObject<Data>` type of the linked resource.
/// Must implement; `ObjectType<Self::Data>`, PsqlType, PsqlSearch,
/// `LinkedResource<Self::Data>`, `From<Id>`, `From<Self::Data>`,
/// `From<Self::UpdateObject>`, Clone, sync, send
type LinkedResourceObject;
/// The type expected for the Data struct of the linked resource.
/// Must implement; GrpcDataObjectType, `TryFrom<Row>`
type LinkedData;
/// The type expected for the `ResourceObject<Data>` type of the 'main' resource.
/// Must implement; `ObjectType<Self::Data>`, PsqlType, PsqlSearch,
/// `SimpleResource<Self::Data>`, `From<Id>`, `From<Self::Data>`,
/// `From<Self::UpdateObject>`, Clone, sync, send
type ResourceObject;
/// The type expected for the Data struct of the 'main' resource.
/// Must implement; GrpcDataObjectType, `TryFrom<Row>`
type Data;
/// The type expected for the `ResourceObject<Data>` type of the 'other' resource.
/// Must implement; `ObjectType<Self::Data>`, PsqlType, PsqlSearch,
/// `SimpleResource<Self::Data>`, `From<Id>`, `From<Self::Data>`,
/// `From<Self::UpdateObject>`, Clone, sync, send
type OtherResourceObject;
/// The type expected for the List struct of the 'other' resource.
/// Must implement; `TryFrom<[Vec<Row>]>`
type OtherList;
/// The type expected for the Data struct of the 'other' resource.
/// Must implement; GrpcDataObjectType, `TryFrom<Row>`
type OtherData;
/// Returns an empty [`tonic`] gRCP [`Response`] on success
///
/// Inserts new entries into the database for each `id`, `other_id` combination if they don't exist yet.
/// When `replace` is set to `true`, all existing entries will be removed first.
/// The existence of the provided resource `id` will be validated before insert.
///
/// # Errors
///
/// Returns [`Status`] with [`Code::NotFound`] if no record exists for the given `id`.
/// Returns [`Status`] with [`Code::Internal`] if the provided Id can not be converted to a [`uuid::Uuid`].
/// Returns [`Status`] with [`Code::Internal`] if any error is returned from the db search result.
///
async fn generic_link(
&self,
id: String,
other_ids: Vec<Uuid>,
replace: bool,
) -> Result<Response<()>, Status> {
let id_field = Self::ResourceObject::try_get_id_field()?;
let other_id_field = Self::OtherResourceObject::try_get_id_field()?;
let id: Uuid = match Uuid::from_str(&id) {
Ok(uuid) => uuid,
Err(e) => {
let error = format!(
"Could not convert provided id String [{}] into uuid: {}",
id, e
);
grpc_error!("(generic_link) {}", error);
return Err(Status::new(Code::NotFound, error));
}
};
if Self::ResourceObject::get_by_id(&id).await.is_err() {
let error = format!(
"No [{}] found for specified uuid: {}",
Self::ResourceObject::get_psql_table(),
id
);
grpc_error!("(generic_link) {}", error);
return Err(Status::new(Code::NotFound, error));
}
let mut ids: Vec<HashMap<String, Uuid>> = vec![];
for other_id in other_ids {
ids.push(HashMap::from([
(id_field.clone(), id),
(other_id_field.clone(), other_id),
]));
}
let mut replace_id_fields: HashMap<String, Uuid> = HashMap::new();
if replace {
replace_id_fields.insert(id_field.clone(), id);
}
Self::LinkedResourceObject::link_ids(ids, replace_id_fields).await?;
Ok(tonic::Response::new(()))
}
/// Returns an empty [`tonic`] gRCP [`Response`] on success
///
/// Removes all entries from the link table for the given `id`.
/// The existence of the provided resource `id` will be validated before unlink.
///
/// # Errors
///
/// Returns [`Status`] with [`Code::NotFound`] if no record exists for the given `id`.
/// Returns [`Status`] with [`Code::Internal`] if the provided Id can not be converted to valid [`uuid::Uuid`].
/// Returns [`Status`] with [`Code::Internal`] if any error is returned from the db search result.
///
async fn generic_unlink(&self, request: Request<Id>) -> Result<Response<()>, Status> {
let id: Id = request.into_inner();
let resource: Self::ResourceObject = id.clone().into();
if Self::ResourceObject::get_by_id(&resource.try_get_uuid()?)
.await
.is_err()
{
let error = format!("No resource found for specified uuids: {:?}", id);
grpc_error!("(generic_unlink) {}", error);
return Err(Status::new(Code::NotFound, error));
}
match Self::LinkedResourceObject::delete_for_ids(
HashMap::from([(
Self::ResourceObject::try_get_id_field()?,
resource.try_get_uuid()?,
)]),
None,
)
.await
{
Ok(_) => Ok(tonic::Response::new(())),
Err(e) => Err(Status::new(Code::Internal, e.to_string())),
}
}
/// Returns a [`tonic`] gRCP [`Response`] with [`IdList`] of found ids on success
///
/// The existence of the provided resource `id` will be validated first.
///
/// # Errors
///
/// Returns [`Status`] with [`Code::NotFound`] if no record exists for the given `id`.
/// Returns [`Status`] with [`Code::Internal`] if the provided Id can not be converted to a [`uuid::Uuid`].
/// Returns [`Status`] with [`Code::Internal`] if any error is returned from the db search result.
async fn generic_get_linked_ids(&self, request: Request<Id>) -> Result<Response<IdList>, Status>
where
Self: Send + 'async_trait,
{
let id: Id = request.into_inner();
let ids = Self::_get_linked(id).await?;
Ok(tonic::Response::new(IdList { ids }))
}
/// Returns a [`tonic`] gRCP [`Response`] containing an object of provided type `[Self::OtherList]`.
///
/// The existence of the provided resource `id` will be validated first.
///
/// # Errors
///
/// Returns [`Status`] with [`Code::NotFound`] if no record exists for the given `id`.
/// Returns [`Status`] with [`Code::Internal`] if the provided Id can not be converted to a [`uuid::Uuid`].
/// Returns [`Status`] with [`Code::Internal`] if any error is returned from the db search result.
async fn generic_get_linked(
&self,
request: Request<Id>,
) -> Result<Response<Self::OtherList>, Status>
where
Self: Send + 'async_trait,
{
let id: Id = request.into_inner();
let ids = Self::_get_linked(id).await?;
let other_id_field = Self::OtherResourceObject::try_get_id_field()?;
let filter = AdvancedSearchFilter::search_in(other_id_field, ids);
match Self::OtherResourceObject::advanced_search(filter).await {
Ok(rows) => Ok(tonic::Response::new(rows.try_into()?)),
Err(e) => Err(Status::new(Code::Internal, e.to_string())),
}
}
/// Internal function used for `generic_get_linked_ids` and `generic_get_linked`
///
async fn _get_linked(id: Id) -> Result<Vec<String>, ArrErr> {
let resource: Self::ResourceObject = id.clone().into();
if Self::ResourceObject::get_by_id(&resource.try_get_uuid()?)
.await
.is_err()
{
let error = format!("No resource found for specified uuid: {}", id.id);
grpc_error!("(_get_linked) {}", error);
return Err(ArrErr::Error(error));
}
let id_field = Self::ResourceObject::try_get_id_field()?;
let filter = AdvancedSearchFilter::search_equals(id_field, id.id);
match Self::LinkedResourceObject::advanced_search(filter).await {
Ok(rows) => {
let other_id_field = Self::OtherResourceObject::try_get_id_field()?;
let mut ids = vec![];
for row in rows {
ids.push(row.get::<&str, Uuid>(other_id_field.as_str()).to_string());
}
Ok(ids)
}
Err(e) => Err(e),
}
}
/// Returns ready:true when service is available
async fn generic_is_ready(
&self,
_request: Request<ReadyRequest>,
) -> Result<Response<ReadyResponse>, Status> {
let response = ReadyResponse { ready: true };
Ok(Response::new(response))
}
}