store_api/manifest/
action.rs

// Copyright 2023 Greptime Team
//
// 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.

//! Common actions for manifest
use serde::{Deserialize, Serialize};

use crate::manifest::ManifestVersion;

pub type ProtocolVersion = u16;

/// Current reader and writer versions
/// TODO(dennis): configurable
const READER_VERSION: ProtocolVersion = 0;
const WRITER_VERSION: ProtocolVersion = 0;

/// The maximum protocol version we are currently allowed to use,
/// TODO(dennis): reading from configuration.
pub fn supported_protocol_version() -> (ProtocolVersion, ProtocolVersion) {
    (READER_VERSION, WRITER_VERSION)
}

/// Protocol action that used to block older clients from reading or writing the log when backwards
/// incompatible changes are made to the protocol.
///
/// clients should be tolerant of messages and fields that they do not understand.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct ProtocolAction {
    pub min_reader_version: ProtocolVersion,
    pub min_writer_version: ProtocolVersion,
}

impl std::fmt::Display for ProtocolAction {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "Protocol({}, {})",
            &self.min_reader_version, &self.min_writer_version,
        )
    }
}

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct VersionHeader {
    pub prev_version: ManifestVersion,
}

impl Default for ProtocolAction {
    fn default() -> Self {
        let (min_reader_version, min_writer_version) = supported_protocol_version();
        Self {
            min_reader_version,
            min_writer_version,
        }
    }
}

impl ProtocolAction {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn is_readable(&self, reader_version: ProtocolVersion) -> bool {
        reader_version >= self.min_reader_version
    }

    pub fn is_writable(&self, writer_version: ProtocolVersion) -> bool {
        writer_version >= self.min_writer_version
    }
}

#[cfg(test)]
mod tests {
    use serde_json as json;

    use super::*;

    #[test]
    fn test_protocol_action() {
        let mut action = ProtocolAction::new();

        assert!(action.is_readable(0));
        assert!(action.is_writable(0));
        action.min_reader_version = 2;
        action.min_writer_version = 3;
        assert!(!action.is_readable(0));
        assert!(!action.is_writable(0));
        assert!(action.is_readable(2));
        assert!(action.is_writable(3));
        assert!(action.is_readable(3));
        assert!(action.is_writable(4));

        let s = json::to_string(&action).unwrap();
        assert_eq!("{\"min_reader_version\":2,\"min_writer_version\":3}", s);

        let action_decoded: ProtocolAction = json::from_str(&s).unwrap();
        assert!(!action_decoded.is_readable(0));
        assert!(!action_decoded.is_writable(0));
        assert!(action_decoded.is_readable(2));
        assert!(action_decoded.is_writable(3));
        assert!(action_decoded.is_readable(3));
        assert!(action_decoded.is_writable(4));
    }
}
store_api/manifest/action.rs

store_api/manifest/
action.rs
