//! KitsuneP2p Wire Protocol Encoding Decoding

use crate::actor::BroadcastData;
use crate::agent_store::AgentInfoSigned;
use crate::types::*;
use derive_more::*;
use kitsune_p2p_fetch::FetchKey;
use kitsune_p2p_types::dht_arc::DhtLocation;
use std::sync::Arc;

/// Type used for content data of wire messages.
#[derive(
    Debug,
    Clone,
    PartialEq,
    Eq,
    Hash,
    Deref,
    AsRef,
    From,
    Into,
    serde::Serialize,
    serde::Deserialize,
)]
pub struct WireData(#[serde(with = "serde_bytes")] pub Vec<u8>);

/// Enum containing the individual metric exchange messages used by clients
#[derive(Debug, Clone, PartialEq, Eq, serde::Deserialize, serde::Serialize)]
#[serde(tag = "type", rename_all = "camelCase")]
pub enum MetricExchangeMsg {
    /// To start off, let's use a naive single message sending
    /// everything we care about.
    V1UniBlast {
        /// The extrapolated coverage calculated by this node
        /// note this is NOT the aggregate the node has collected,
        /// just the direct extrapolation based on known peer infos.
        extrap_cov_f32_le: WireData,
    },

    /// Future proof by having an unknown message catch-all variant
    /// that we can ignore for any future variants that are added
    #[serde(other)]
    UnknownMessage,
}

/// An individual op item within a "PushOpData" wire message.
#[derive(Debug, Clone, PartialEq, Eq, serde::Deserialize, serde::Serialize)]
#[serde(tag = "type", rename_all = "camelCase")]
pub struct PushOpItem {
    /// The payload of this op.
    pub op_data: Arc<KitsuneOpData>,

    /// If this op is a response to a "region" request,
    /// includes the region coords and a bool that, if true,
    /// indicates this is the final op in the region list.
    /// NOTE: we may want to just ignore this bool, as out-of-order
    /// messages could lead us to ignore valid ops coming in for the region.
    pub region: Option<(dht::prelude::RegionCoords, bool)>,
}

kitsune_p2p_types::write_codec_enum! {
    /// KitsuneP2p Wire Protocol Top-Level Enum.
    codec Wire {
        /// Failure
        Failure(0x00) {
            reason.0: String,
        },

        /// "Call" to the remote.
        Call(0x10) {
            space.0: Arc<KitsuneSpace>,
            to_agent.1: Arc<KitsuneAgent>,
            data.2: WireData,
        },

        /// "Call" response from the remote.
        CallResp(0x11) {
            data.0: WireData,
        },

        /// "DelegateBroadcast" to the remote.
        /// Remote should in turn connect to nodes in neighborhood,
        /// and call "Notify" per broadcast algorithm.
        /// uses low-level notify, not request
        DelegateBroadcast(0x22) {
            space.0: Arc<KitsuneSpace>,
            basis.1: Arc<KitsuneBasis>,
            to_agent.2: Arc<KitsuneAgent>,

            /// If `tgt_agent.get_loc() % mod_cnt == mod_idx`,
            /// we are responsible for broadcasting to tgt_agent.
            mod_idx.3: u32,

            /// see mod_idx description
            mod_cnt.4: u32,

            data.5: BroadcastData,
        },

        /// Fire-and-forget broadcast message.
        /// uses low-level notify, not request
        Broadcast(0x23) {
            space.0: Arc<KitsuneSpace>,
            to_agent.1: Arc<KitsuneAgent>,
            data.2: BroadcastData,
        },

        /// Gossip op with opaque data section,
        /// to be forwarded to gossip module.
        /// uses low-level notify, not request
        Gossip(0x42) {
            space.0: Arc<KitsuneSpace>,
            data.1: WireData,
            module.2: gossip::GossipModuleType,
        },

        /// Ask a remote node if they know about a specific agent
        PeerGet(0x50) {
            space.0: Arc<KitsuneSpace>,
            agent.1: Arc<KitsuneAgent>,
        },

        /// Response to a peer get. If the agent isn't known, None will be returned.
        PeerGetResp(0x51) {
            agent_info_signed.0: Option<AgentInfoSigned>,
        },

        /// Query a remote node for peers holding
        /// or nearest to holding a u32 location.
        PeerQuery(0x52) {
            space.0: Arc<KitsuneSpace>,
            basis_loc.1: DhtLocation,
        },

        /// Response to a peer query. May be empty if no matching agents are known.
        PeerQueryResp(0x53) {
            peer_list.0: Vec<AgentInfoSigned>,
        },

        /// Nodes can just send peer info without prompting.
        /// Notably they may want to send their own peer info to prevent being
        /// inadvertantly blocked.
        PeerUnsolicited(0x54) {
            peer_list.0: Vec<AgentInfoSigned>,
        },

        /// Request the peer send op data.
        /// This is sent as a fire-and-forget Notify message.
        /// The "response" is "PushOpData" below.
        FetchOp(0x60) {
            fetch_list.0: Vec<(Arc<KitsuneSpace>, Vec<FetchKey>)>,
        },

        /// This is a fire-and-forget "response" to the
        /// fire-and-forget "FetchOp" request, also sent via Notify.
        PushOpData(0x61) {
            op_data_list.0: Vec<(Arc<KitsuneSpace>, Vec<PushOpItem>)>,
        },

        /// MetricsExchangeMessage
        MetricExchange(0xa0) {
            space.0: Arc<KitsuneSpace>,
            msgs.1: Vec<MetricExchangeMsg>,
        },
    }
}

impl Wire {
    pub fn maybe_space(&self) -> Option<Arc<KitsuneSpace>> {
        match self {
            Wire::Call(Call { space, .. })
            | Wire::DelegateBroadcast(DelegateBroadcast { space, .. })
            | Wire::Broadcast(Broadcast { space, .. })
            | Wire::Gossip(Gossip { space, .. })
            | Wire::PeerGet(PeerGet { space, .. })
            | Wire::PeerQuery(PeerQuery { space, .. })
            | Wire::MetricExchange(MetricExchange { space, .. }) => Some(space.clone()),
            Wire::Failure(_)
            | Wire::CallResp(_)
            | Wire::PeerGetResp(_)
            | Wire::PeerQueryResp(_)
            | Wire::FetchOp(_)
            | Wire::PushOpData(_)
            | Wire::PeerUnsolicited(_) => None,
        }
    }
}