acorns 1.2.4

/*
acorns: Generate an AsciiDoc release notes document from tracking tickets.
Copyright (C) 2022  Marek Suchánek  <msuchane@redhat.com>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

use std::fmt;
use std::rc::Rc;
use std::string::ToString;
use std::sync::Arc;

use bugzilla_query::Bug;
use color_eyre::eyre::{bail, Result};
use jira_query::Issue;
use serde::ser::SerializeStruct;
use serde::{Serialize, Serializer};

use crate::config::{tracker, TicketQuery};
use crate::extra_fields::{DocTextStatus, DocsContact, ExtraFields};
use crate::tracker_access::{self, AnnotatedTicket};

/// An abstract ticket representation that generalizes over Bugzilla, Jira, and any other issue trackers.
#[derive(Clone, Debug)]
pub struct AbstractTicket {
    pub id: Rc<TicketId>,
    pub summary: String,
    // TODO: Find out how to get the bug description from comment#0 with Bugzilla
    pub description: Option<String>,
    pub doc_type: String,
    pub doc_text: String,
    pub docs_contact: DocsContact,
    pub status: String,
    pub resolution: Option<String>,
    pub is_open: bool,
    pub priority: String,
    pub url: String,
    pub assignee: Option<String>,
    pub components: Vec<String>,
    pub product: String,
    pub labels: Option<Vec<String>>,
    pub flags: Option<Vec<String>>,
    pub target_releases: Vec<String>,
    // `AbstractTicket` derives cloning, but the `Result` from `eyre` doesn't implement it.
    // To work around the limitation, replace the `eyre` `Result` with the standard
    // `Result` and store just the `eyre` text description in it.
    // It's not such a nice solution anymore, but it works and clones.
    pub subsystems: Result<Vec<String>, String>,
    pub groups: Option<Vec<String>>,
    pub public: bool,
    pub doc_text_status: DocTextStatus,
    pub references: Option<Vec<String>>,
}

// This is a manual implementation of serde serialization purely because we can't
// automatically derive Serialize on Rc<TicketId>.
impl Serialize for AbstractTicket {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        // 3 is the number of fields in the struct.
        let mut state = serializer.serialize_struct("Color", 3)?;
        state.serialize_field("id", &self.id.to_string())?;
        state.serialize_field("summary", &self.summary)?;
        state.serialize_field("description", &self.description)?;
        state.serialize_field("doc_type", &self.doc_type)?;
        state.serialize_field("doc_text", &self.doc_text)?;
        state.serialize_field("docs_contact", &self.docs_contact.as_str())?;
        state.serialize_field("doc_text_status", &self.doc_text_status.to_string())?;
        state.serialize_field("status", &self.status)?;
        state.serialize_field("is_open", &self.is_open)?;
        state.serialize_field("priority", &self.priority)?;
        state.serialize_field("url", &self.url)?;
        state.serialize_field("assignee", &self.assignee)?;
        state.serialize_field("components", &self.components)?;
        state.serialize_field("product", &self.product)?;
        state.serialize_field("labels", &self.labels)?;
        state.serialize_field("flags", &self.flags)?;
        state.serialize_field("target_releases", &self.target_releases)?;
        state.serialize_field("subsystems", &self.subsystems)?;
        state.serialize_field("groups", &self.groups)?;
        state.serialize_field("public", &self.public)?;
        state.serialize_field("references", &self.references)?;
        state.end()
    }
}

/// An identification of the original ticket on the issue tracker.
#[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize)]
pub struct TicketId {
    pub key: String,
    pub tracker: tracker::Service,
}

impl fmt::Display for TicketId {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}:{}", &self.tracker, &self.key)
    }
}

pub trait IntoAbstract {
    /// Converts a Bugzilla bug or a Jira ticket to `AbstractTicket`.
    /// Consumes the original ticket.
    fn into_abstract(
        self,
        references: Option<Vec<String>>,
        config: &tracker::Config,
    ) -> Result<AbstractTicket>;
}

impl IntoAbstract for Bug {
    fn into_abstract(
        self,
        references: Option<Vec<String>>,
        config: &tracker::Config,
    ) -> Result<AbstractTicket> {
        let bz_fields = &config.bugzilla;
        let ticket = AbstractTicket {
            id: Rc::new(TicketId {
                key: self.id.to_string(),
                tracker: tracker::Service::Bugzilla,
            }),
            // TODO: Find out how to get the bug description from comment#0 with Bugzilla
            description: None,
            doc_type: self.doc_type(bz_fields)?,
            doc_text: self.doc_text(bz_fields)?,
            target_releases: self.target_releases(bz_fields),
            subsystems: self.subsystems(bz_fields).map_err(|e| e.to_string()),
            doc_text_status: self.doc_text_status(bz_fields),
            docs_contact: self.docs_contact(bz_fields),
            url: self.url(bz_fields),
            summary: self.summary,
            status: self.status,
            resolution: Some(self.resolution),
            is_open: self.is_open,
            priority: self.priority,
            // Bugs are always assigned to someone.
            assignee: Some(self.assigned_to),
            components: self.component.into_vec(),
            product: self.product,
            // Bugzilla has no labels
            labels: None,
            // Convert all flags to `name: value` strings.
            flags: self
                .flags
                .map(|flags| flags.into_iter().map(|flag| flag.to_string()).collect()),
            // A bug is public if no groups are set for it.
            public: self.groups.is_empty(),
            groups: Some(self.groups),
            references,
        };

        Ok(ticket)
    }
}

impl IntoAbstract for Issue {
    fn into_abstract(
        self,
        references: Option<Vec<String>>,
        config: &tracker::Config,
    ) -> Result<AbstractTicket> {
        let jira_fields = &config.jira;
        let ticket = AbstractTicket {
            doc_type: self.doc_type(jira_fields)?,
            doc_text: self.doc_text(jira_fields)?,
            // The target release is non-essential. Discard the error and store as Option.
            target_releases: self.target_releases(jira_fields),
            doc_text_status: self.doc_text_status(jira_fields),
            docs_contact: self.docs_contact(jira_fields),
            subsystems: self.subsystems(jira_fields).map_err(|e| e.to_string()),
            url: self.url(jira_fields),
            // The ID in particular is wrapped in Rc because it's involved in various filters
            // and comparisons where ownership is complicated.
            id: Rc::new(TicketId {
                key: self.key,
                tracker: tracker::Service::Jira,
            }),
            summary: self.fields.summary,
            description: self.fields.description,
            is_open: &self.fields.status.name != "Closed",
            status: self.fields.status.name,
            resolution: self.fields.resolution.map(|resolution| resolution.name),
            priority: self
                .fields
                .priority
                .map_or_else(|| "Missing".to_string(), |p| p.name),
            // Issues might not be assigned to anyone.
            assignee: self.fields.assignee.and_then(|a| a.name),
            components: self.fields.components.into_iter().map(|c| c.name).collect(),
            // The project name isn't exactly the product name, but it's the closest equivalent at hand.
            product: self.fields.project.name,
            labels: Some(self.fields.labels),
            // Jira does not support flags
            flags: None,
            // Jira does not recognize groups in the Bugzilla way. This might change.
            groups: None,
            // If there are no s`fields.security` settings, the ticket is public. If there are some, it's private.
            // However, the project as a whole can be public or private, which affects the ticket visibility.
            // All projects are considered public unless you configure them in `JiraInstance::private_projects`.
            public: {
                self.fields.security.is_none()
                    && !config
                        .jira
                        .private_projects
                        .contains(&self.fields.project.key)
            },
            references,
        };

        Ok(ticket)
    }
}

/// Process the configured ticket queries into abstract tickets,
/// sorted in the original order as found in the config file.
pub fn from_queries(
    queries: &[Arc<TicketQuery>],
    trackers: &tracker::Config,
) -> Result<Vec<AbstractTicket>> {
    let annotated_tickets = tracker_access::unsorted_tickets(queries, trackers)?;

    // Sort the tickets according to the order in the config file.
    let sorted_tickets = sort_tickets(queries, &annotated_tickets)?;

    // Strip the query from the ticket. The query has served its full purpose.
    Ok(sorted_tickets.into_iter().map(|at| at.ticket).collect())
}

/// Sort tickets to the order specified in the tickets configuration file.
pub fn sort_tickets(
    queries: &[Arc<TicketQuery>],
    tickets: &[AnnotatedTicket],
) -> Result<Vec<AnnotatedTicket>> {
    let mut sorted_tickets: Vec<AnnotatedTicket> = Vec::new();

    // Go query by query. Queries are still sorted the same as in the config file. Use their order.
    for query in queries {
        // Find the indices of all tickets that match this query.
        // We're dealing with indices because that enables us to move a ticket from one Vec to another
        // using the Vec::swap_remove method, which takes an index as its argument.
        let mut matching_tickets: Vec<AnnotatedTicket> = tickets
            .iter()
            .filter(|at| query == &at.query)
            // TODO: Revisit whether this clone is necessary.
            // Note to self: Do not use Vec::swap_remove, it changes the Vec ordering and size at runtime.
            .cloned()
            .collect();

        // A query might result in no tickets. For example, Bugzilla silently ignores nonexistent IDs.
        // In that case, report the error and immediately exit the program.
        if matching_tickets.is_empty() {
            bail!("Query produced no tickets: {:#?}", query);
        }

        // Insert tickets that match this query into the sorted Vec.
        sorted_tickets.append(&mut matching_tickets);
    }

    Ok(sorted_tickets)
}