kf_protocol_api/

error.rs

use flv_util::string_helper::upper_cammel_case_to_sentence;
use serde::{Serialize, Deserialize};

use kf_protocol_derive::Decode;
use kf_protocol_derive::Encode;

/// kafka error
/// https://kafka.apache.org/protocol#protocol_types

#[fluvio_kf(encode_discriminant)]
#[fluvio_kf(default)]
#[repr(i16)]
#[derive(PartialEq, Debug, Clone, Copy, Serialize, Deserialize, Encode, Decode)]
pub enum ErrorCode {
    // The server experienced an unexpected error when processing the request
    UnknownServerError = -1,

    None = 0,

    // The requested offset is not within the range of offsets maintained by the server.
    OffsetOutOfRange = 1,

    // This message has failed its CRC checksum, exceeds the valid size, or is otherwise corrupt.
    CorruptMessage = 2,

    //This server does not host this topic-partition.
    UnknownTopicOrPartition = 3,

    // The requested fetch size is invalid.
    InvalidFetchSize = 4,

    // There is no leader for this topic-partition as we are in the middle of a leadership election.
    LeaderNotAvailable = 5,

    // This server is not the leader for that topic-partition.
    NotLeaderForPartition = 6,

    // The request timed out.
    RequestTimedOut = 7,

    // The broker is not available.
    BrokerNotAvailable = 8,

    // The replica is not available for the requested topic-partition
    ReplicaNotAvailable = 9,

    // The request included a message larger than the max message size the server will accept.
    MessageTooLarge = 10,

    // The controller moved to another broker.
    StaleControllerEpoch = 11,

    // The metadata field of the offset request was too large.
    OffsetMetadataTooLarge = 12,

    // The server disconnected before a response was received.
    NetworkException = 13,

    // The coordinator is loading and hence can't process requests.
    CoordinatorLoadInProgress = 14,

    // The coordinator is not available.
    CoordinatorNotAvailable = 15,

    // This is not the correct coordinato
    NotCoordinator = 16,

    // The request attempted to perform an operation on an invalid topic.
    InvalidTopicException = 17,

    // The request included message batch larger than the configured segment size on the server.
    RecordListTooLarge = 18,

    // Messages are rejected since there are fewer in-sync replicas than required.
    NotEnoughReplicas = 19,

    // Messages are written to the log, but to fewer in-sync replicas than required.
    NotEnougReplicasAfterAppend = 20,

    // Produce request specified an invalid value for required acks.
    InvalidRequiredAcks = 21,

    // Specified group generation id is not valid
    IllegalGeneration = 22,

    // The group member's supported protocols are incompatible with those of existing members or first group member tried to join with empty protocol type or empty protocol list.
    InconsistentGroupProtocol = 23,

    // The configured groupId is invalid
    InvalidGroupId = 24,

    // The coordinator is not aware of this member.
    UnknownMemberId = 25,

    // The session timeout is not within the range allowed by the broker (as configured by group.min.session.timeout.ms and group.max.session.timeout.ms).
    InvalidSessionTimeout = 26,

    // The group is rebalancing, so a rejoin is needed.
    RebalanceInProgress = 27,

    // The committing offset data size is not valid
    InvalidCommitOffsetSize = 28,

    // Not authorized to access topics: [Topic authorization failed.]
    TopicAuthorizationFailed = 29,

    // Not authorized to access group: Group authorization failed.
    GroupAuthorizationFailed = 30,

    // Cluster authorization failed.
    ClusterAuthorizationFailed = 31,

    // The timestamp of the message is out of acceptable range.
    InvalidTimestamp = 32,

    // The broker does not support the requested SASL mechanism.
    UnsupportedSaslMechanism = 33,

    // Request is not valid given the current SASL state.
    IllegalSaslState = 34,

    // The version of API is not supported.
    UnsupportedVersion = 35,

    // Topic with this name already exists.
    TopicAlreadyExists = 36,

    // Number of partitions is invalid.
    InvalidPartitions = 37,

    // Replication-factor is invalid.
    InvalidReplicationFactor = 38,

    // Replica assignment is invalid.
    InvalidReplicaAssignment = 39,

    // Configuration is invalid.
    InvalidConfig = 40,

    // This is not the correct controller for this cluster.
    NotController = 41,

    // This most likely occurs because of a request being malformed by the client library or the message was sent to an incompatible broker. See the broker logs for more details
    InvalidRequest = 42,

    // The message format version on the broker does not support the request.
    UnsupportedForMessageFormat = 43,

    // Request parameters do not satisfy the configured policy.
    PolicyViolation = 44,

    // The broker received an out of order sequence number
    OutOfOrderSequenceNumber = 45,

    // The broker received a duplicate sequence number
    DuplicateSequenceNumber = 46,

    // Producer attempted an operation with an old epoch. Either there is a newer producer with the same transactionalId, or the producer's transaction has been expired by the broker.
    InvalidProducerEpoch = 47,

    // The producer attempted a transactional operation in an invalid state
    InvalidTxnState = 48,

    // The producer attempted to use a producer id which is not currently assigned to its transactional id
    InvalidProducerIdMapping = 49,

    // The transaction timeout is larger than the maximum value allowed by the broker (as configured by transaction.max.timeout.ms).
    InvalidTransactionTimeout = 50,

    // The producer attempted to update a transaction while another concurrent operation on the same transaction was ongoing
    ConcurrentTransactions = 51,

    // Indicates that the transaction coordinator sending a WriteTxnMarker is no longer the current coordinator for a given producer
    TransactionCoordinatorFenced = 52,

    // Transactional Id authorization failed
    TransactionalIdAuthorizationFailed = 53,

    // Security features are disabled.
    SecurityDisabled = 54,

    // The broker did not attempt to execute this operation. This may happen for batched RPCs where some operations in the batch failed, causing the broker to respond without trying the rest.
    OperationNotAttempted = 55,

    // Disk error when trying to access log file on the disk.
    KafkaStorageError = 56,

    // The user-specified log directory is not found in the broker config.
    LogDirNotFound = 57,

    // SASL Authentication failed
    SaslAuthenticationFailed = 58,

    // This exception is raised by the broker if it could not locate the producer metadata associated with the producerId in question. This could happen if, for instance, the producer's records were deleted because their retention time had elapsed. Once the last records of the producerId are removed, the producer's metadata is removed from the broker, and future appends by the producer will return this exception.
    UnknownProducerId = 59,

    // A partition reassignment is in progress
    ReassignmentInProgress = 60,

    // Delegation Token feature is not enabled.
    DelegationTokenAuthDisabled = 61,

    // Delegation Token is not found on server.
    DelegationTokenNotFound = 62,

    // Specified Principal is not valid Owner/Renewer.
    DelegationTokenOwnerMismatch = 63,

    // Delegation Token requests are not allowed on PLAINTEXT/1-way SSL channels and on delegation token authenticated channels.
    DelegationTokenRequestNotAllowed = 64,

    // Delegation Token authorization failed.
    DelegationTokenAuthorizationFailed = 65,

    // Delegation Token is expired.
    DelegationTokenExpired = 66,

    // Supplied principalType is not supported
    InvalidPrincipleType = 67,

    // The group The group is not empty is not empty
    NonEmptyGroup = 68,

    // The group id The group id does not exist was not found
    GroupIdNotFound = 69,

    // The fetch session ID was not found
    FetchSessionIdNotFound = 70,

    // The fetch session epoch is invalid
    InvalidFetchSessionEpoch = 71,

    // There is no listener on the leader broker that matches the listener
    // on which metadata request was processed.
    ListenerNotFound = 72,

    // Topic deletion is disabled
    TopicDeletionDisabled = 73,

    // The leader epoch in the request is older than the epoch on the broker
    FencedLeaderEpoch = 74,

    // The leader epoch in the request is newer than the epoch on the broker
    UnknownLeaderEpoch = 75,

    // The requesting client does not support the compression type of given partition
    UnsupportedCompressionType = 76,

    // Broker epoch has changed
    StaleBrokerEpoch = 77,

    // The leader high watermark has not caught up from a recent leader election
    // so the offsets cannot be guaranteed to be monotonically increasing
    OffsetNotAvailable = 78,

    // The group member needs to have a valid member id before actually
    // entering a consumer group
    MemberIdRequired = 79,

    // The preferred leader was not available
    PreferredLeaderNotAvailable = 80,

    // Consumer group The consumer group has reached maximum number of members allowed
    GroupMaxSizeReached = 81,
}

impl Default for ErrorCode {
    fn default() -> ErrorCode {
        ErrorCode::None
    }
}

impl ErrorCode {

    pub fn is_ok(&self) -> bool {
        match self {
            Self::None => true,
            _ => false
        }
    }

    pub fn to_string(&self) -> String {
        match self {
            ErrorCode::None => "Ok".to_owned(),
            _ => format!("{:?}", self),
        }
    }

    pub fn to_sentence(&self) -> String {
        match self {
            ErrorCode::None => "".to_owned(),
            _ => upper_cammel_case_to_sentence(format!("{:?}", self), false),
        }
    }

    pub fn is_error(&self) -> bool {
        match self {
            ErrorCode::None => false,
            _ => true,
        }
    }
}

#[cfg(test)]
mod test {

    use std::convert::TryInto;

    use super::ErrorCode;
    #[test]
    fn test_error_code_from_conversion() {
        let val: i16 = 6;
        let erro_code: ErrorCode = val.try_into().expect("convert");
        assert_eq!(erro_code, ErrorCode::NotLeaderForPartition);
    }

}