qdrant/lib/common/issues/src/dashboard.rs

use std::any::TypeId;
use std::collections::HashSet;
use std::sync::{Arc, OnceLock};

use dashmap::DashMap;

use crate::issue::{Issue, IssueRecord};

#[derive(Hash, Eq, PartialEq, Clone)]
pub struct Code {
    pub issue_type: TypeId,
    pub instance_id: String,
}

impl Code {
    pub fn new<T: 'static>(instance_id: impl Into<String>) -> Self {
        Self {
            issue_type: TypeId::of::<T>(),
            instance_id: instance_id.into(),
        }
    }

    /// Internal code for the issue
    fn of<I: Issue + 'static>(issue: &I) -> Self
    where
        Self: std::marker::Sized + 'static,
    {
        Code::new::<I>(issue.instance_id())
    }
}

impl AsRef<Code> for Code {
    fn as_ref(&self) -> &Code {
        self
    }
}

#[derive(Default)]
pub(crate) struct Dashboard {
    pub issues: DashMap<Code, IssueRecord>,
}

impl Dashboard {
    /// Activates an issue, returning true if the issue was not active before
    pub(crate) fn add_issue<I: Issue + 'static>(&self, issue: I) -> bool {
        let code = Code::of(&issue);
        if self.issues.contains_key(&code) {
            return false;
        }
        let issue = IssueRecord::from(issue);
        self.issues.insert(code, issue).is_none()
    }

    /// Deactivates an issue by its code, returning true if the issue was active before
    pub(crate) fn remove_issue<S: AsRef<Code>>(&self, code: S) -> bool {
        if self.issues.contains_key(code.as_ref()) {
            return self.issues.remove(code.as_ref()).is_some();
        }
        false
    }

    /// Returns all issues in the dashboard. This operation clones every issue, so it is more expensive.
    pub(crate) fn get_all_issues(&self) -> Vec<IssueRecord> {
        self.issues.iter().map(|kv| kv.value().clone()).collect()
    }

    pub(crate) fn get_all_collection_issues(&self, collection_name: &str) -> Vec<IssueRecord> {
        self.issues
            .iter()
            .filter(|kv| {
                kv.value()
                    .related_collection
                    .as_ref()
                    .is_some_and(|c| c == collection_name)
            })
            .map(|kv| kv.value().clone())
            .collect()
    }

    fn get_codes<I: 'static>(&self) -> HashSet<Code> {
        let type_id = TypeId::of::<I>();
        self.issues
            .iter()
            .filter(|kv| kv.key().issue_type == type_id)
            .map(|kv| kv.key().clone())
            .collect()
    }
}

fn dashboard() -> Arc<Dashboard> {
    static DASHBOARD: OnceLock<Arc<Dashboard>> = OnceLock::new();
    DASHBOARD
        .get_or_init(|| Arc::new(Dashboard::default()))
        .clone()
}

/// Submits an issue to the dashboard, returning true if the issue code was not active before
pub fn submit(issue: impl Issue + 'static) -> bool {
    dashboard().add_issue(issue)
}

/// Solves an issue by its code, returning true if the issue code was active before
pub fn solve<C: AsRef<Code>>(code: C) -> bool {
    dashboard().remove_issue(code)
}

pub fn all_issues() -> Vec<IssueRecord> {
    dashboard().get_all_issues()
}

pub fn all_collection_issues(collection_name: &str) -> Vec<IssueRecord> {
    dashboard().get_all_collection_issues(collection_name)
}

/// Clears all issues from the dashboard
pub fn clear() {
    dashboard().issues.clear();
}

/// Solves all issues of the given type that match the given predicate
pub fn solve_by_filter<I: Issue + 'static, F: Fn(&Code) -> bool>(filter: F) {
    let codes = dashboard().get_codes::<I>();
    for code in codes {
        if filter(&code) {
            solve(code);
        }
    }
}

#[cfg(test)]
mod tests {
    use serial_test::serial;

    use super::*;
    use crate::issue::DummyIssue;

    #[test]
    fn test_dashboard() {
        let dashboard = Dashboard::default();
        let issue = DummyIssue {
            distinctive: "test".to_string(),
        };
        assert!(dashboard.add_issue(issue.clone()));
        assert!(!dashboard.add_issue(issue.clone()));
        assert!(dashboard.remove_issue(Code::of(&issue)));
        assert!(!dashboard.remove_issue(Code::of(&issue)));
    }

    #[test]
    #[serial]
    fn test_singleton() -> std::thread::Result<()> {
        clear();

        let handle1 = std::thread::spawn(|| {
            submit(DummyIssue::new("issue1"));
            submit(DummyIssue::new("issue2"));
            submit(DummyIssue::new("issue3"));
        });

        let handle2 = std::thread::spawn(|| {
            submit(DummyIssue::new("issue4"));
            submit(DummyIssue::new("issue5"));
            submit(DummyIssue::new("issue6"));
        });

        handle1.join()?;
        handle2.join()?;

        assert_eq!(all_issues().len(), 6);
        assert!(solve(Code::new::<DummyIssue>("issue1")));
        assert!(solve(Code::new::<DummyIssue>("issue2")));
        assert!(solve(Code::new::<DummyIssue>("issue3")));
        assert!(solve(Code::new::<DummyIssue>("issue4")));
        assert!(solve(Code::new::<DummyIssue>("issue5")));
        assert!(solve(Code::new::<DummyIssue>("issue6")));

        clear();
        Ok(())
    }

    #[test]
    #[serial]
    fn test_solve_by_filter() {
        crate::clear();

        submit(DummyIssue::new("my_collection:issue1"));
        submit(DummyIssue::new("my_collection:issue2"));
        submit(DummyIssue::new("my_collection:issue3"));
        submit(DummyIssue::new("my_other_collection:issue2"));
        submit(DummyIssue::new("my_other_collection:issue2"));
        submit(DummyIssue::new("issue2"));
        submit(DummyIssue::new("issue3"));

        // Solve all dummy issues that contain "my_collection"
        solve_by_filter::<DummyIssue, _>(|code| code.instance_id.contains("my_collection"));
        assert_eq!(all_issues().len(), 3);
        assert!(solve(Code::new::<DummyIssue>("issue2")));
    }
}