moqtail 0.13.1

// Copyright 2025 The MOQtail Authors
//
// 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 super::constant::{ControlMessageType, PublishDoneStatusCode};
use super::control_message::ControlMessageTrait;
use crate::model::common::reason_phrase::ReasonPhrase;
use crate::model::common::varint::{BufMutVarIntExt, BufVarIntExt};
use crate::model::error::ParseError;
use bytes::{BufMut, Bytes, BytesMut};

#[derive(Debug, PartialEq, Clone)]
pub struct PublishDone {
  pub request_id: u64,
  pub status_code: PublishDoneStatusCode,
  pub stream_count: u64,
  pub reason_phrase: ReasonPhrase,
}

impl PublishDone {
  pub fn new(
    request_id: u64,
    status_code: PublishDoneStatusCode,
    stream_count: u64,
    reason_phrase: ReasonPhrase,
  ) -> Self {
    Self {
      request_id,
      status_code,
      stream_count,
      reason_phrase,
    }
  }
}

impl ControlMessageTrait for PublishDone {
  fn serialize(&self) -> Result<Bytes, ParseError> {
    let mut buf = BytesMut::new();
    buf.put_vi(ControlMessageType::PublishDone)?;

    let mut payload = BytesMut::new();
    payload.put_vi(self.request_id)?;
    payload.put_vi(self.status_code)?;
    payload.put_vi(self.stream_count)?;
    payload.extend_from_slice(&self.reason_phrase.serialize()?);

    let payload_len: u16 = payload
      .len()
      .try_into()
      .map_err(|e: std::num::TryFromIntError| ParseError::CastingError {
        context: "PublishDone::serialize(payload_length)",
        from_type: "usize",
        to_type: "u16",
        details: e.to_string(),
      })?;

    buf.put_u16(payload_len);
    buf.extend_from_slice(&payload);
    Ok(buf.freeze())
  }

  fn parse_payload(payload: &mut Bytes) -> Result<Box<Self>, ParseError> {
    let request_id = payload.get_vi()?;
    let status_code_raw = payload.get_vi()?;
    let status_code = PublishDoneStatusCode::try_from(status_code_raw)?;
    let stream_count = payload.get_vi()?;
    let reason_phrase = ReasonPhrase::deserialize(payload)?;

    Ok(Box::new(PublishDone {
      request_id,
      status_code,
      stream_count,
      reason_phrase,
    }))
  }

  fn get_type(&self) -> ControlMessageType {
    ControlMessageType::PublishDone
  }
}

#[cfg(test)]
mod tests {

  use super::*;
  use bytes::Buf;

  #[test]
  fn test_roundtrip() {
    let request_id = 209455;
    let status_code = PublishDoneStatusCode::SubscriptionEnded;
    let stream_count = 9;
    let reason_phrase = ReasonPhrase::try_new("It's not you, it's me.".to_string()).unwrap();
    let subscribe_done = PublishDone {
      request_id,
      status_code,
      stream_count,
      reason_phrase,
    };
    let mut buf = subscribe_done.serialize().unwrap();
    let msg_type = buf.get_vi().unwrap();
    assert_eq!(msg_type, ControlMessageType::PublishDone as u64);
    let msg_length = buf.get_u16();
    assert_eq!(msg_length as usize, buf.remaining());
    let deserialized = PublishDone::parse_payload(&mut buf).unwrap();
    assert_eq!(*deserialized, subscribe_done);
    assert!(!buf.has_remaining());
  }

  #[test]
  fn test_excess_roundtrip() {
    let request_id = 209455;
    let status_code = PublishDoneStatusCode::SubscriptionEnded;
    let stream_count = 9;
    let reason_phrase = ReasonPhrase::try_new("It's not you, it's me.".to_string()).unwrap();
    let subscribe_done = PublishDone {
      request_id,
      status_code,
      stream_count,
      reason_phrase,
    };
    let serialized = subscribe_done.serialize().unwrap();
    let mut excess = BytesMut::new();
    excess.extend_from_slice(&serialized);
    excess.extend_from_slice(&[9u8, 1u8, 1u8]);
    let mut buf = excess.freeze();

    let msg_type = buf.get_vi().unwrap();
    assert_eq!(msg_type, ControlMessageType::PublishDone as u64);
    let msg_length = buf.get_u16();

    assert_eq!(msg_length as usize, buf.remaining() - 3);
    let deserialized = PublishDone::parse_payload(&mut buf).unwrap();
    assert_eq!(*deserialized, subscribe_done);
    assert_eq!(buf.chunk(), &[9u8, 1u8, 1u8]);
  }

  #[test]
  fn test_partial_message() {
    let request_id = 209455;
    let status_code = PublishDoneStatusCode::SubscriptionEnded;
    let stream_count = 9;
    let reason_phrase = ReasonPhrase::try_new("It's not you, it's me.".to_string()).unwrap();
    let subscribe_done = PublishDone {
      request_id,
      status_code,
      stream_count,
      reason_phrase,
    };
    let mut buf = subscribe_done.serialize().unwrap();
    let msg_type = buf.get_vi().unwrap();
    assert_eq!(msg_type, ControlMessageType::PublishDone as u64);
    let msg_length = buf.get_u16();
    assert_eq!(msg_length as usize, buf.remaining());

    let upper = buf.remaining() / 2;
    let mut partial = buf.slice(..upper);
    let deserialized = PublishDone::parse_payload(&mut partial);
    assert!(deserialized.is_err());
  }
}