namespace_api.rs

// Copyright 2020 Datafuse Labs.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

use std::convert::TryFrom;

use common_exception::ErrorCode;
use common_exception::Result;

#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
pub struct NodeInfo {
    #[serde(default)]
    pub id: String,
    #[serde(default)]
    pub cpu_nums: u64,
    #[serde(default)]
    pub version: u32,
    #[serde(default)]
    pub flight_address: String,
}

impl TryFrom<Vec<u8>> for NodeInfo {
    type Error = ErrorCode;

    fn try_from(value: Vec<u8>) -> Result<Self> {
        match serde_json::from_slice(&value) {
            Ok(user_info) => Ok(user_info),
            Err(serialize_error) => Err(ErrorCode::IllegalUserInfoFormat(format!(
                "Cannot deserialize namespace from bytes. cause {}",
                serialize_error
            ))),
        }
    }
}

impl NodeInfo {
    pub fn create(id: String, cpu_nums: u64, flight_address: String) -> NodeInfo {
        NodeInfo {
            id,
            cpu_nums,
            version: 0,
            flight_address,
        }
    }
}

#[async_trait::async_trait]
pub trait NamespaceApi: Sync + Send {
    // Add a new node info to /tenant/namespace/node-name.
    async fn add_node(&self, node: NodeInfo) -> Result<u64>;

    // Get the tenant's namespace all nodes.
    async fn get_nodes(&self) -> Result<Vec<NodeInfo>>;

    // Drop the tenant's namespace one node by node.id.
    async fn drop_node(&self, node_id: String, seq: Option<u64>) -> Result<()>;

    // Keep the tenant's namespace node alive.
    async fn heartbeat(&self, node_id: String, seq: Option<u64>) -> Result<u64>;
}