Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: how dashboards are handled #1173

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

refactor: how dashboards are handled #1173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc2fdec
refactor: dashboards
de-sh Feb 7, 2025
58c6b70
Merge remote-tracking branch 'origin/main' into dashboard
de-sh Feb 19, 2025
5b0aad4
Merge remote-tracking branch 'origin/main' into dashboard
de-sh Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 20 additions & 50 deletions src/handlers/http/users/dashboards.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,23 @@
*
*/

use crate::{
handlers::http::rbac::RBACError,
parseable::PARSEABLE,
storage::{object_storage::dashboard_path, ObjectStorageError},
users::dashboards::{Dashboard, CURRENT_DASHBOARD_VERSION, DASHBOARDS},
utils::{actix::extract_session_key_from_req, get_hash, get_user_from_request},
};
use actix_web::{
http::header::ContentType,
web::{self, Json, Path},
HttpRequest, HttpResponse, Responder,
};
use bytes::Bytes;
use rand::distributions::DistString;

use chrono::Utc;
use http::StatusCode;
use serde_json::Error as SerdeError;

use crate::{
handlers::http::rbac::RBACError,
parseable::PARSEABLE,
storage::{object_storage::dashboard_path, ObjectStorageError},
users::dashboards::{Dashboard, DASHBOARDS},
utils::{actix::extract_session_key_from_req, get_hash, get_user_from_request},
};

pub async fn list(req: HttpRequest) -> Result<impl Responder, DashboardError> {
let key =
extract_session_key_from_req(&req).map_err(|e| DashboardError::Custom(e.to_string()))?;
Expand All @@ -50,14 +48,11 @@ pub async fn get(
let user_id = get_user_from_request(&req)?;
let dashboard_id = dashboard_id.into_inner();

if let Some(dashboard) = DASHBOARDS
.get_dashboard(&dashboard_id, &get_hash(&user_id))
.await
{
if let Some(dashboard) = DASHBOARDS.get(&dashboard_id, &get_hash(&user_id)).await {
return Ok((web::Json(dashboard), StatusCode::OK));
}

Err(DashboardError::Metadata("Dashboard does not exist"))
Err(DashboardError::DashboardDoesNotExist)
}

pub async fn post(
Expand All @@ -66,24 +61,10 @@ pub async fn post(
) -> Result<impl Responder, DashboardError> {
let mut user_id = get_user_from_request(&req)?;
user_id = get_hash(&user_id);
let dashboard_id = get_hash(Utc::now().timestamp_micros().to_string().as_str());
dashboard.dashboard_id = Some(dashboard_id.clone());
dashboard.version = Some(CURRENT_DASHBOARD_VERSION.to_string());

dashboard.user_id = Some(user_id.clone());
for tile in dashboard.tiles.iter_mut() {
tile.tile_id = Some(get_hash(
format!(
"{}{}",
rand::distributions::Alphanumeric.sample_string(&mut rand::thread_rng(), 8),
Utc::now().timestamp_micros()
)
.as_str(),
));
}
DASHBOARDS.update(&dashboard).await;

let path = dashboard_path(&user_id, &format!("{}.json", dashboard_id));
let path = dashboard_path(&user_id, &format!("{}.json", dashboard.dashboard_id));

let store = PARSEABLE.storage.get_object_store();
let dashboard_bytes = serde_json::to_vec(&dashboard)?;
Expand All @@ -103,21 +84,11 @@ pub async fn update(
user_id = get_hash(&user_id);
let dashboard_id = dashboard_id.into_inner();

if DASHBOARDS
.get_dashboard(&dashboard_id, &user_id)
.await
.is_none()
{
return Err(DashboardError::Metadata("Dashboard does not exist"));
if DASHBOARDS.get(&dashboard_id, &user_id).await.is_none() {
return Err(DashboardError::DashboardDoesNotExist);
}
dashboard.dashboard_id = Some(dashboard_id.to_string());
dashboard.dashboard_id = dashboard_id.to_string();
dashboard.user_id = Some(user_id.clone());
dashboard.version = Some(CURRENT_DASHBOARD_VERSION.to_string());
for tile in dashboard.tiles.iter_mut() {
if tile.tile_id.is_none() {
tile.tile_id = Some(get_hash(Utc::now().timestamp_micros().to_string().as_str()));
}
}
DASHBOARDS.update(&dashboard).await;

let path = dashboard_path(&user_id, &format!("{}.json", dashboard_id));
Expand All @@ -138,18 +109,14 @@ pub async fn delete(
let mut user_id = get_user_from_request(&req)?;
user_id = get_hash(&user_id);
let dashboard_id = dashboard_id.into_inner();
if DASHBOARDS
.get_dashboard(&dashboard_id, &user_id)
.await
.is_none()
{
return Err(DashboardError::Metadata("Dashboard does not exist"));
if DASHBOARDS.get(&dashboard_id, &user_id).await.is_none() {
return Err(DashboardError::DashboardDoesNotExist);
}
let path = dashboard_path(&user_id, &format!("{}.json", dashboard_id));
let store = PARSEABLE.storage.get_object_store();
store.delete_object(&path).await?;

DASHBOARDS.delete_dashboard(&dashboard_id).await;
DASHBOARDS.delete(&dashboard_id).await;

Ok(HttpResponse::Ok().finish())
}
Expand All @@ -162,6 +129,8 @@ pub enum DashboardError {
Serde(#[from] SerdeError),
#[error("Cannot perform this operation: {0}")]
Metadata(&'static str),
#[error("Dashboard does not exist")]
DashboardDoesNotExist,
#[error("User does not exist")]
UserDoesNotExist(#[from] RBACError),
#[error("Error: {0}")]
Expand All @@ -174,6 +143,7 @@ impl actix_web::ResponseError for DashboardError {
Self::ObjectStorage(_) => StatusCode::INTERNAL_SERVER_ERROR,
Self::Serde(_) => StatusCode::BAD_REQUEST,
Self::Metadata(_) => StatusCode::BAD_REQUEST,
Self::DashboardDoesNotExist => StatusCode::NOT_FOUND,
Self::UserDoesNotExist(_) => StatusCode::NOT_FOUND,
Self::Custom(_) => StatusCode::INTERNAL_SERVER_ERROR,
}
Expand Down
9 changes: 2 additions & 7 deletions src/prism/home/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,15 +117,10 @@ pub async fn generate_home_response(key: &SessionKey) -> Result<HomeResponse, Pr
let dashboard_titles = DASHBOARDS
.list_dashboards(key)
.await
.iter()
.into_iter()
.map(|dashboard| TitleAndId {
title: dashboard.name.clone(),
id: dashboard
.dashboard_id
.as_ref()
.ok_or_else(|| anyhow::Error::msg("Dashboard ID is null"))
.unwrap()
.clone(),
id: dashboard.dashboard_id,
})
.collect_vec();

Expand Down
48 changes: 34 additions & 14 deletions src/users/dashboards.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
*
*/

use chrono::Utc;
use once_cell::sync::Lazy;
use rand::distributions::DistString;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use tokio::sync::RwLock;
Expand All @@ -31,10 +33,22 @@ use super::TimeFilter;
pub static DASHBOARDS: Lazy<Dashboards> = Lazy::new(Dashboards::default);
pub const CURRENT_DASHBOARD_VERSION: &str = "v3";

fn gen_tile_id() -> String {
get_hash(
format!(
"{}{}",
rand::distributions::Alphanumeric.sample_string(&mut rand::thread_rng(), 8),
Utc::now().timestamp_micros()
)
.as_str(),
)
}

#[derive(Debug, Serialize, Deserialize, Default, Clone)]
pub struct Tiles {
name: String,
pub tile_id: Option<String>,
#[serde(default = "gen_tile_id")]
pub tile_id: String,
description: String,
query: String,
order: Option<u64>,
Expand Down Expand Up @@ -94,12 +108,22 @@ pub struct TickConfig {
unit: String,
}

fn default_version() -> String {
CURRENT_DASHBOARD_VERSION.to_owned()
}

fn gen_dashboard_id() -> String {
get_hash(Utc::now().timestamp_micros().to_string().as_str())
}

#[derive(Debug, Serialize, Deserialize, Default, Clone)]
pub struct Dashboard {
pub version: Option<String>,
#[serde(default = "default_version")]
pub version: String,
pub name: String,
description: String,
pub dashboard_id: Option<String>,
#[serde(default = "gen_dashboard_id")]
pub dashboard_id: String,
pub user_id: Option<String>,
pub time_filter: Option<TimeFilter>,
refresh_interval: u64,
Expand Down Expand Up @@ -183,19 +207,18 @@ impl Dashboards {
s.push(dashboard.clone());
}

pub async fn delete_dashboard(&self, dashboard_id: &str) {
pub async fn delete(&self, dashboard_id: &str) {
let mut s = self.0.write().await;
s.retain(|d| d.dashboard_id != Some(dashboard_id.to_string()));
s.retain(|d| d.dashboard_id != dashboard_id);
}

pub async fn get_dashboard(&self, dashboard_id: &str, user_id: &str) -> Option<Dashboard> {
pub async fn get(&self, dashboard_id: &str, user_id: &str) -> Option<Dashboard> {
self.0
.read()
.await
.iter()
.find(|d| {
d.dashboard_id == Some(dashboard_id.to_string())
&& d.user_id == Some(user_id.to_string())
d.dashboard_id == dashboard_id && d.user_id.as_ref().is_some_and(|id| id == user_id)
})
.cloned()
}
Expand All @@ -209,12 +232,9 @@ impl Dashboards {
let mut skip_dashboard = false;
for tile in d.tiles.iter() {
let query = &tile.query;
match user_auth_for_query(key, query).await {
Ok(_) => {}
Err(_) => {
skip_dashboard = true;
break;
}
if user_auth_for_query(key, query).await.is_err() {
skip_dashboard = true;
break;
}
}
if !skip_dashboard {
Expand Down
Loading