iggy_common 0.11.0-edge.2

Iggy is the persistent message streaming platform written in Rust, supporting QUIC, TCP and HTTP transport protocols, capable of processing millions of messages per second.
Documentation
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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 crate::traits::binary_auth::fail_if_not_authenticated;
use crate::wire_conversions::personal_access_tokens_from_wire;
use crate::{
    BinaryClient, ClientState, DiagnosticEvent, IdentityInfo, IggyError, PersonalAccessTokenClient,
    PersonalAccessTokenExpiry, PersonalAccessTokenInfo, RawPersonalAccessToken,
};
use iggy_binary_protocol::MAX_WIRE_NAME_LENGTH;
use iggy_binary_protocol::WireName;
use iggy_binary_protocol::codec::WireEncode;
use iggy_binary_protocol::codes::LOGIN_REGISTER_WITH_PAT_CODE;
use iggy_binary_protocol::codes::{
    CREATE_PERSONAL_ACCESS_TOKEN_CODE, DELETE_PERSONAL_ACCESS_TOKEN_CODE,
    GET_PERSONAL_ACCESS_TOKENS_CODE,
};
use iggy_binary_protocol::requests::personal_access_tokens::{
    CreatePersonalAccessTokenRequest, DeletePersonalAccessTokenRequest,
    GetPersonalAccessTokensRequest,
};
use iggy_binary_protocol::requests::users::LoginRegisterWithPatRequest;
use iggy_binary_protocol::responses::personal_access_tokens::create_personal_access_token::RawPersonalAccessTokenResponse;
use iggy_binary_protocol::responses::personal_access_tokens::get_personal_access_tokens::GetPersonalAccessTokensResponse;
use iggy_binary_protocol::responses::users::LoginRegisterResponse;
use secrecy::SecretString;

#[async_trait::async_trait]
impl<B: BinaryClient> PersonalAccessTokenClient for B {
    async fn get_personal_access_tokens(&self) -> Result<Vec<PersonalAccessTokenInfo>, IggyError> {
        fail_if_not_authenticated(self).await?;
        let response = self
            .send_raw_with_response(
                GET_PERSONAL_ACCESS_TOKENS_CODE,
                GetPersonalAccessTokensRequest.to_bytes(),
            )
            .await?;
        if response.is_empty() {
            return Ok(Vec::new());
        }
        let wire_resp = super::decode_response::<GetPersonalAccessTokensResponse>(&response)?;
        Ok(personal_access_tokens_from_wire(wire_resp))
    }

    async fn create_personal_access_token(
        &self,
        name: &str,
        expiry: PersonalAccessTokenExpiry,
    ) -> Result<RawPersonalAccessToken, IggyError> {
        fail_if_not_authenticated(self).await?;
        let wire_name = WireName::new(name).map_err(|_| IggyError::InvalidFormat)?;
        let response = self
            .send_raw_with_response(
                CREATE_PERSONAL_ACCESS_TOKEN_CODE,
                CreatePersonalAccessTokenRequest {
                    name: wire_name,
                    expiry: u64::from(expiry),
                }
                .to_bytes(),
            )
            .await?;
        let wire_resp = super::decode_response::<RawPersonalAccessTokenResponse>(&response)?;
        Ok(RawPersonalAccessToken::from(wire_resp))
    }

    async fn delete_personal_access_token(&self, name: &str) -> Result<(), IggyError> {
        fail_if_not_authenticated(self).await?;
        let wire_name = WireName::new(name).map_err(|_| IggyError::InvalidFormat)?;
        self.send_raw_with_response(
            DELETE_PERSONAL_ACCESS_TOKEN_CODE,
            DeletePersonalAccessTokenRequest { name: wire_name }.to_bytes(),
        )
        .await?;
        Ok(())
    }

    async fn login_with_personal_access_token(
        &self,
        token: &str,
    ) -> Result<IdentityInfo, IggyError> {
        super::logout_before_relogin(self).await?;
        // The request stores a `SecretString` rather than a `WireName`, so the
        // `WireName` bounds are enforced here to keep the u8 length prefix
        // consistent with the realized bytes.
        if token.is_empty() || token.len() > MAX_WIRE_NAME_LENGTH {
            return Err(IggyError::InvalidFormat);
        }
        let response = match self
            .send_raw_with_response(
                LOGIN_REGISTER_WITH_PAT_CODE,
                LoginRegisterWithPatRequest {
                    version_info: super::rust_sdk_version_info(self.sdk_version())?,
                    token: SecretString::from(token.to_string()),
                    client_context: None,
                }
                .to_bytes(),
            )
            .await
        {
            Ok(response) => response,
            Err(error) => {
                self.reset_vsr_session().await?;
                return Err(error);
            }
        };
        let wire_resp = match super::decode_response::<LoginRegisterResponse>(&response) {
            Ok(wire_resp) => wire_resp,
            Err(error) => {
                self.reset_vsr_session().await?;
                return Err(error);
            }
        };
        if let Err(error) = self.bind_vsr_session(wire_resp.session).await {
            self.reset_vsr_session().await?;
            return Err(error);
        }
        tracing::debug!(
            server_version = %wire_resp.server_version,
            server_protocol_version = wire_resp.server_protocol_version,
            "authenticated against iggy server"
        );
        self.set_state(ClientState::Authenticated).await;
        self.publish_event(DiagnosticEvent::SignedIn).await;
        Ok(IdentityInfo {
            user_id: wire_resp.user_id,
            access_token: None,
        })
    }
}