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

use std::fmt::Debug;

use chrono::{DateTime, Utc};
use schemars::JsonSchema;
use serde::Serialize;

use crate::solution::Solution;

pub trait Issue {
    /// Differentiates issues of the same type. This can hold any information that makes the issue unique and filterable.
    fn instance_id(&self) -> &str;

    /// The codename for all issues of this type
    fn name() -> &'static str;

    /// The name of the collection that this issue is related to
    /// If none, collection is not relevant to any particular collection
    fn related_collection(&self) -> Option<String>;

    /// A human-readable description of the issue
    fn description(&self) -> String;

    /// Actionable solution to the issue
    fn solution(&self) -> Solution;

    /// Submits the issue to the dashboard singleton
    fn submit(self) -> bool
    where
        Self: std::marker::Sized + 'static,
    {
        crate::dashboard::submit(self)
    }
}

/// An issue that can be identified by its code
#[derive(Debug, Serialize, JsonSchema, Clone)]
pub struct IssueRecord {
    pub id: String,
    pub description: String,
    pub solution: Solution,
    pub timestamp: DateTime<Utc>,
    pub related_collection: Option<String>,
}

impl<I: Issue> From<I> for IssueRecord {
    fn from(val: I) -> Self {
        let id = format!("{}/{}", I::name(), val.instance_id());
        Self {
            id,
            description: val.description(),
            solution: val.solution(),
            timestamp: Utc::now(),
            related_collection: val.related_collection(),
        }
    }
}

#[cfg(test)]
#[derive(Clone)]
pub(crate) struct DummyIssue {
    pub distinctive: String,
}

#[cfg(test)]
impl DummyIssue {
    #[cfg(test)]
    pub fn new(distinctive: impl Into<String>) -> Self {
        Self {
            distinctive: distinctive.into(),
        }
    }
}

#[cfg(test)]
impl Issue for DummyIssue {
    fn instance_id(&self) -> &str {
        &self.distinctive
    }

    fn name() -> &'static str {
        "DUMMY"
    }

    fn related_collection(&self) -> Option<String> {
        None
    }

    fn description(&self) -> String {
        "".to_string()
    }

    fn solution(&self) -> Solution {
        Solution::Refactor("".to_string())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_issue_record() {
        let issue = DummyIssue::new("test");

        let record = IssueRecord::from(issue);

        assert_eq!(record.id, "DUMMY/test");
    }
}