hexser 0.4.7

Zero-boilerplate hexagonal architecture with graph-based introspection
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

//! Port-specific error types and utilities.
//!
//! Provides PortError type alias for port communication failures.
//! Port errors represent failures in interfaces between domain and adapters.
//! Includes error chaining, rich context, and actionable guidance via RichError trait.
//!
//! Revision History
//! - 2025-10-06T02:00:00Z @AI: Fix merge conflict, remove duplicates.
//! - 2025-10-06T02:00:00Z @AI: Add helper functions for Phase 2.
//! - 2025-10-06T01:00:00Z @AI: Refactor to use LayerError generic for Phase 1.
//! - 2025-10-06T00:00:00Z @AI: Implement PortError struct for Phase 1.
//! - 2025-10-01T00:00:00Z @AI: Initial placeholder for port error utilities.

use crate::error::RichError;

/// Port layer error type
pub type PortError =
  crate::error::layer_error::LayerError<crate::error::layer_error::layer_markers::PortLayer>;

/// Create communication failure error
pub fn communication_failure(details: impl Into<String>) -> PortError {
  PortError::new(crate::error::codes::port::COMMUNICATION_FAILURE, details)
    .with_next_step("Check port implementation and connectivity")
    .with_suggestion("Verify port configuration and network status")
}

/// Create port not found error
pub fn port_not_found(port_name: impl Into<String>) -> PortError {
  PortError::new(
    crate::error::codes::port::PORT_NOT_FOUND,
    format!("Port not found: {}", port_name.into()),
  )
  .with_next_step("Ensure the port is properly registered")
  .with_suggestion("Check port registration in container or registry")
}

/// Create port timeout error
pub fn port_timeout(port_name: impl Into<String>) -> PortError {
  PortError::new(
    crate::error::codes::port::PORT_TIMEOUT,
    format!("Port operation timed out: {}", port_name.into()),
  )
  .with_next_step("Increase timeout or check port responsiveness")
  .with_suggestion("Verify network connectivity and port availability")
}

#[cfg(test)]
mod tests {
  use super::*;
  use crate::error::rich_error::RichError;
  use std::error::Error;

  #[test]
  fn test_port_error_creation() {
    let err = PortError::new("E_HEX_100", "Communication failure");
    assert_eq!(err.code(), "E_HEX_100");
    assert_eq!(err.message(), "Communication failure");
  }

  #[test]
  fn test_port_error_builder() {
    let err = PortError::new("E_HEX_101", "Port not found")
      .with_next_step("Register port")
      .with_suggestion("Check port configuration");

    assert_eq!(err.next_steps().len(), 1);
    assert_eq!(err.suggestions().len(), 1);
  }

  #[test]
  fn test_port_error_with_source() {
    let inner = std::io::Error::new(std::io::ErrorKind::TimedOut, "timeout");
    let err = PortError::new("E_HEX_102", "Port timeout").with_source(inner);

    assert!(err.source().is_some());
  }
}