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 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
//! Psql Simple resource Traits
use super::get_psql_client;
use super::{util::*, ArrErr, PsqlData, PsqlField, PsqlFieldSend};
use crate::grpc::server::ValidationResult;
use crate::grpc::{GrpcDataObjectType, GrpcField};
use crate::resources::base::simple_resource::*;
use chrono::{DateTime, Utc};
use deadpool_postgres::Transaction;
use geo_types::{LineString, Point, Polygon};
use std::collections::HashMap;
use std::vec;
use tokio_postgres::types::Type as PsqlFieldType;
use tokio_postgres::Row;
use uuid::Uuid;
/// Generic PostgreSQL trait to provide wrappers for common `Resource` functions
#[tonic::async_trait]
pub trait PsqlType
where
Self: Resource + Clone + Sized,
{
/// Generic get for id function to get rows for the provided key fields
/// Since this is a linked resource, the id is expected to be given as a [Vec\<FieldValuePair\>]
/// to specify the id_column / value pairs to match
/// The provided ids should be a combined primary key, so just one result should
/// returned.
async fn get_for_ids(ids: HashMap<String, Uuid>) -> Result<Row, ArrErr> {
psql_debug!("(get_for_ids) Start [{:?}].", ids);
super::queries::get_for_ids::<Self>(&ids).await
}
/// Generic delete for ids function to delete rows for the provided key fields
/// Since this is a linked resource, the id is expected to be given as a [Vec\<FieldValuePair\>]
/// to specify the id_column / value pairs to match
/// An optional transaction handle can be provided, which will be used if present.
/// This function will not commit, so the caller is responsible for committing the transaction when done.
async fn delete_for_ids(
ids: HashMap<String, Uuid>,
transaction: Option<&Transaction>,
) -> Result<(), ArrErr> {
psql_debug!("(delete_for_ids) Start [{:?}].", ids);
let definition = Self::get_definition();
let mut params: Vec<Box<PsqlFieldSend>> = vec![];
let mut query = format!(r#"DELETE FROM "{}""#, definition.get_psql_table());
let mut search_operator = "WHERE";
let mut next_param_index: i32 = 1;
for (field, value) in ids.clone() {
if Self::has_id_col(&field) {
query.push_str(&format!(
r#" {} "{}" = ${}"#,
search_operator, field, next_param_index
));
params.push(Box::new(value));
search_operator = "AND";
next_param_index += 1;
}
}
psql_debug!("(delete_for_ids) [{}].", &query);
psql_debug!("(delete_for_ids) [{:?}].", ¶ms);
psql_info!(
"(delete_for_ids) Deleting rows for table [{}]. uuids: {:?}",
definition.psql_table,
ids
);
let mut ref_params: Vec<&PsqlField> = vec![];
for field in params.iter() {
ref_params.push(field.as_ref());
}
// TODO(R4): Move this to 2 separate functions which can be used in other places as well
match transaction {
Some(client) => {
let stmt = client.prepare_cached(&query).await?;
match client.execute(&stmt, &ref_params[..]).await {
Ok(rows) => {
psql_debug!(
"(delete_for_ids) Removed [{}] entries from [{}].",
rows,
definition.get_psql_table()
);
Ok(())
}
Err(e) => Err(e.into()),
}
}
None => {
let client = get_psql_client().await?;
let stmt = client.prepare_cached(&query).await?;
match client.execute(&stmt, &ref_params[..]).await {
Ok(rows) => {
psql_debug!(
"(delete_for_ids) Removed [{}] entries from [{}].",
rows,
definition.get_psql_table()
);
Ok(())
}
Err(e) => Err(e.into()),
}
}
}
}
/// Generic create function based on resource definition and provided data.
///
/// The data will be validated first, returning all possible errors at once.
/// If no validation errors are found, a new row will be inserted in the database.
async fn create<'a, T>(row_data: &T) -> Result<ValidationResult, ArrErr>
where
T: GrpcDataObjectType,
{
psql_debug!("(create) Start [{:?}].", row_data);
let (psql_data, validation_result) = validate::<Self>(row_data)?;
if !validation_result.success {
return Ok(validation_result);
}
let definition = Self::get_definition();
let (inserts, fields, params) = get_insert_vars(row_data, &psql_data, &definition, true)?;
let insert_sql = &format!(
r#"INSERT INTO "{}" ({}) VALUES ({})"#,
definition.psql_table,
fields.join(", "),
inserts.join(", "),
);
psql_info!(
"(create) Inserting new entry for table [{}].",
definition.psql_table
);
psql_debug!("(create) [{}].", insert_sql);
psql_debug!("(create) [{:?}].", ¶ms);
let client = get_psql_client().await?;
client
.execute(insert_sql, ¶ms[..])
.await
.map_err(ArrErr::from)?;
Ok(validation_result)
}
}
/// Generic trait for the Arrow Resources that are stored in the CockroachDB backend.
/// TODO Rust 1.74: use `#![feature(async_fn_in_trait)]` once available: <https://blog.rust-lang.org/inside-rust/2023/05/03/stabilizing-async-fn-in-trait.html>
#[tonic::async_trait]
pub trait PsqlObjectType<T>
where
Self: PsqlType + ObjectType<T> + Send + SimpleResource<T>,
T: GrpcDataObjectType,
{
/// get data from the database using the Object's UUID
///
/// # Errors
///
/// returns [Row] on success
async fn read(&self) -> Result<Row, ArrErr> {
psql_debug!("(read) Start [{:?}].", self.try_get_uuid());
//TODO(R4): implement shared memcache here to get object data if present
let id = self.try_get_uuid()?;
Self::get_by_id(&id).await
}
/// Update the Object's database record using provided data
///
/// returns [Option(Row)] and [ValidationResult]
///
/// # Errors
/// Returns [`ArrErr`] Validation "'GrpcField::Option'" mismatch error if the database scheme does not match the gRPC struct.
/// Returns [`ArrErr`] Validation "Conversion error, unknown field type" if the provided field type could not be matched.
/// Returns [`ArrErr`] "No id column configured for table" id_col could not be found
/// Returns [`ArrErr`] if the `id` [`String`] could not be converted to a valid [`Uuid`]
/// Returns [`ArrErr`] from [`PoolError`](deadpool::managed::PoolError) if no client connection could be returned from the connection [`Pool`](deadpool::managed::Pool)
/// Returns [`ArrErr`] Database Error if database query execution failed
async fn update<'a>(&self, data: &T) -> Result<(Option<Row>, ValidationResult), ArrErr> {
psql_debug!("(update) Start [{:?}].", data);
let (psql_data, validation_result) = validate::<Self>(data)?;
if !validation_result.success {
return Ok((None, validation_result));
}
let definition = Self::get_definition();
let id_col = Self::try_get_id_field()?;
let id = self.try_get_uuid()?;
let (mut updates, mut params) = Self::get_update_vars(data, &psql_data)?;
if definition.has_field("updated_at") {
updates.push(r#""updated_at" = NOW()"#.to_string());
}
let update_sql = &format!(
"UPDATE {} SET {} WHERE {} = ${}",
definition.psql_table,
updates.join(", "),
id_col,
params.len() + 1
);
params.push(&id);
psql_info!(
"(update) Updating entry in table [{}]. uuid: {}",
definition.psql_table,
id
);
psql_debug!("(update) [{}].", update_sql);
psql_debug!("(update) [{:?}].", ¶ms);
let client = get_psql_client().await?;
client.execute(update_sql, ¶ms[..]).await?;
//TODO(R4): flush shared memcache for this resource when memcache is implemented
Ok((Some(self.read().await?), validation_result))
}
/// Returns `true` if the resource has a `deleted_at` field and if it's [`Some`]
///
/// Returns `false` otherwise
async fn is_archived(&self) -> bool {
let data = match self.read().await {
Ok(data) => data,
Err(_) => {
return false;
}
};
match data.try_get::<&str, Option<DateTime<Utc>>>("deleted_at") {
Ok(value) => value.is_some(),
Err(_) => false,
}
}
/// Calls [set_deleted_at_now](PsqlObjectType::set_deleted_at_now) if the Object has a `deleted_at` field
///
/// Calls [delete_row](PsqlObjectType::delete_row) otherwise
async fn delete(&self) -> Result<(), ArrErr> {
psql_debug!("(delete) Start.");
let definition = Self::get_definition();
if definition.fields.contains_key("deleted_at") {
self.set_deleted_at_now().await
} else {
self.delete_row().await
}
}
/// Updates the database record setting the `deleted_at` field to current timestamp using the Object's UUID
///
/// # Errors
///
/// Returns [`ArrErr`] "No id column configured for table" id_col could not be found
/// Returns [`ArrErr`] if the `id` [`String`] could not be converted to a valid [`Uuid`]
/// Returns [`ArrErr`] "\[deleted_at\] column is already set" if [`is_archived`](Self::is_archived) returned `true`
/// Returns [`ArrErr`] from [`PoolError`](deadpool::managed::PoolError) if no client connection could be returned from the connection [`Pool`](deadpool::managed::Pool)
/// Returns [`ArrErr`] "Failed to update \[deleted_at\] col" if database query execution returns zero updated rows
/// Returns [`ArrErr`] Database Error if database query execution failed
async fn set_deleted_at_now(&self) -> Result<(), ArrErr> {
psql_debug!("(set_deleted_at_now) Start [{:?}].", self.try_get_uuid());
let definition = Self::get_definition();
let id_col = Self::try_get_id_field()?;
let id = self.try_get_uuid()?;
if self.is_archived().await {
psql_info!(
"(set_deleted_at_now) [deleted_at] column is already set, refusing to overwrite for [{}]. uuid: {}",
definition.psql_table,
id
);
return Err(ArrErr::Error(
"(set_deleted_at_now) [deleted_at] column is already set, will not overwrite."
.to_owned(),
));
}
psql_info!(
"(set_deleted_at_now) Updating [deleted_at] field for [{}]. uuid: {}",
definition.psql_table,
id
);
let client = get_psql_client().await?;
let query = format!(
r#"UPDATE "{}" SET "deleted_at" = NOW() WHERE "{}" = $1"#,
definition.psql_table, id_col
);
let stmt = client.prepare_cached(&query).await?;
match client.execute(&stmt, &[&id]).await {
Ok(num_rows) => {
if num_rows == 1 {
//TODO(R4): flush shared memcache for this resource when memcache is implemented
Ok(())
} else {
let error = format!(
"Failed to update [deleted_at] col for [{}] with id [{}] (does not exist?).",
definition.psql_table, id
);
psql_info!("(set_deleted_at_now) {}", error);
Err(ArrErr::Error(error))
}
}
Err(e) => Err(e.into()),
}
}
/// Delete database record from the database using the Object's UUID
///
/// # Errors
///
/// Returns [`ArrErr`] "No id column configured for table" id_col could not be found
/// Returns [`ArrErr`] if the `id` [`String`] could not be converted to a valid [`Uuid`]
/// Returns [`ArrErr`] from [`PoolError`](deadpool::managed::PoolError) if no client connection could be returned from the connection [`Pool`](deadpool::managed::Pool)
/// Returns [`ArrErr`] "Failed to delete entry" if database query execution returns zero updated rows
/// Returns [`ArrErr`] Database Error if database query execution failed
async fn delete_row(&self) -> Result<(), ArrErr> {
psql_debug!("(set_deleted_at_now) Start: [{:?}].", self.try_get_uuid());
let definition = Self::get_definition();
let id_col = Self::try_get_id_field()?;
let id = self.try_get_uuid()?;
psql_info!(
"(set_deleted_at_now) Deleting entry from table [{}]. uuid: {}",
definition.psql_table,
id
);
let client = get_psql_client().await?;
let query = format!(
r#"DELETE FROM "{}" WHERE "{}" = $1"#,
definition.psql_table, id_col
);
let stmt = client.prepare_cached(&query).await?;
match client.execute(&stmt, &[&id]).await {
Ok(num_rows) => {
if num_rows == 1 {
//TODO(R4): flush shared memcache for this resource when memcache is implemented
Ok(())
} else {
let error = format!(
"Failed to delete entry for [{}] with id [{}] (does not exist?).",
definition.psql_table, id
);
psql_info!("(set_deleted_at_now) {}", error);
Err(ArrErr::Error(error))
}
}
Err(e) => Err(e.into()),
}
}
/// Generates the update statements and list of variables for the provided data
fn get_update_vars<'a>(
data: &'a T,
psql_data: &'a PsqlData,
) -> Result<(Vec<String>, Vec<&'a PsqlField>), ArrErr> {
let mut params: Vec<&PsqlField> = vec![];
let mut updates = vec![];
let mut index = 1;
let definition = Self::get_definition();
for key in definition.fields.keys() {
let field_definition = match definition.fields.get(key) {
Some(val) => val,
None => {
let error = format!("No field definition found for field: {}", key);
psql_error!("(get_update_vars) {}", error);
psql_debug!(
"(get_update_vars) got definition for fields: {:?}",
definition.fields
);
return Err(ArrErr::Error(error));
}
};
match psql_data.get(&*key.to_string()) {
Some(value) => {
match field_definition.field_type {
// Since we're using CockroachDB, we can't directly pass
// the POINT type. We need to converted into a GEOMETRY
PsqlFieldType::POINT => {
if let Ok(point_option) = data.get_field_value(key) {
match get_point_sql_val(point_option) {
Some(val) => updates.push(format!(r#""{}" = {}"#, key, val)),
None => continue,
};
} else {
let error = format!(
"Could not convert value into a geo_types::Point for field: {}",
key
);
psql_error!("(get_update_vars) {}", error);
psql_debug!("(get_update_vars) field_value: {:?}", value);
return Err(ArrErr::Error(error));
}
}
// Since we're using CockroachDB, we can't directly pass
// the POLYGON type. We need to converted into a GEOMETRY
PsqlFieldType::POLYGON => {
if let Ok(polygon_option) = data.get_field_value(key) {
match get_polygon_sql_val(polygon_option) {
Some(val) => updates.push(format!(r#""{}" = {}"#, key, val)),
None => continue,
};
} else {
let error = format!(
"Could not convert value into a geo_types::Polygon for field: {}",
key
);
psql_error!("(get_update_vars) {}", error);
psql_debug!("(get_update_vars) field_value: {:?}", value);
return Err(ArrErr::Error(error));
}
}
// Since we're using CockroachDB, we can't directly pass
// the PATH type. We need to converted into a GEOMETRY
PsqlFieldType::PATH => {
if let Ok(path_option) = data.get_field_value(key) {
match get_path_sql_val(path_option) {
Some(val) => updates.push(format!(r#""{}" = {}"#, key, val)),
None => continue,
};
} else {
let error = format!(
"Could not convert value into a geo_types::Path for field: {}",
key
);
psql_error!("(get_update_vars) {}", error);
psql_debug!("(get_update_vars) field_value: {:?}", value);
return Err(ArrErr::Error(error));
}
}
// In any other case, we can just allow tokio_postgres
// to handle the conversion
_ => {
let val: &PsqlField = <&Box<PsqlFieldSend>>::clone(&value).as_ref();
updates.push(format!(r#""{}" = ${}"#, key, index));
params.push(val);
index += 1;
}
}
}
None => {
psql_debug!(
"(get_update_vars) Skipping update [{}] for [{}], no value provided.",
key,
definition.psql_table,
);
}
}
}
Ok((updates, params))
}
}
fn get_point_sql_val(point_option: GrpcField) -> Option<String> {
match point_option {
GrpcField::Option(val) => {
let point: Option<GrpcField> = val.into();
match point {
Some(val) => {
let val: Point = val.into();
// POINT expects (x y) which is (long lat)
// geo_types::geometry::point::Point has a x and y which
// we've aligned with the POINT(x y)/POINT(long lat)
Some(format!(
"ST_GeomFromText('POINT({:.15} {:.15})')",
val.x(),
val.y()
))
}
None => None,
}
}
_ => None,
}
}
fn get_polygon_sql_val(polygon_option: GrpcField) -> Option<String> {
match polygon_option {
GrpcField::Option(val) => {
let polygon: Option<GrpcField> = val.into();
match polygon {
Some(val) => {
let val: Polygon = val.into();
let mut coord_str_pairs: Vec<String> = vec![];
for coord in val.exterior().coords() {
coord_str_pairs.push(format!("{:.15} {:.15}", coord.x, coord.y));
}
let mut line_str_pairs: Vec<String> = vec![];
line_str_pairs.push(format!("({})", coord_str_pairs.join(",")));
for line in val.interiors() {
let mut coord_str_pairs: Vec<String> = vec![];
for coord in line.coords() {
coord_str_pairs.push(format!("{:.15} {:.15}", coord.x, coord.y));
}
let coord_str = format!("({})", coord_str_pairs.join(","));
line_str_pairs.push(coord_str);
}
Some(format!(
"ST_GeomFromText('POLYGON({})')",
line_str_pairs.join(",")
))
}
None => None,
}
}
_ => None,
}
}
fn get_path_sql_val(path_option: GrpcField) -> Option<String> {
match path_option {
GrpcField::Option(val) => {
let path: Option<GrpcField> = val.into();
match path {
Some(val) => {
let val: LineString = val.into();
let mut coord_str_pairs: Vec<String> = vec![];
for coord in val.coords() {
coord_str_pairs.push(format!("{:.15} {:.15}", coord.x, coord.y));
}
Some(format!(
"ST_GeomFromText('LINESTRING({})')",
coord_str_pairs.join(",")
))
}
None => None,
}
}
_ => None,
}
}