majra 1.0.3

Distributed queue & multiplex engine — pub/sub, priority queues, relay, IPC, heartbeat, and rate limiting for Rust
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340

//! Length-prefixed framing over local IPC sockets.
//!
//! Protocol: 4-byte big-endian u32 length prefix, then JSON payload.
//! Maximum frame size: 16 MiB.
//!
//! - **Unix**: Uses Unix domain sockets.
//! - **Windows**: Uses named pipes (`\\.\pipe\majra-*`).

use crate::error::IpcError;
use tracing::{debug, trace};

/// Maximum frame size (16 MiB).
const MAX_FRAME_SIZE: u32 = 16 * 1024 * 1024;

type Result<T> = std::result::Result<T, IpcError>;

// ---------------------------------------------------------------------------
// Unix implementation
// ---------------------------------------------------------------------------

#[cfg(unix)]
mod platform {
    use tokio::net::{UnixListener, UnixStream};

    pub(super) struct Listener {
        inner: UnixListener,
    }

    impl Listener {
        pub fn bind(path: &std::path::Path) -> std::io::Result<Self> {
            let _ = std::fs::remove_file(path);
            Ok(Self {
                inner: UnixListener::bind(path)?,
            })
        }

        pub async fn accept(&self) -> std::io::Result<Stream> {
            let (stream, _) = self.inner.accept().await?;
            Ok(Stream { inner: stream })
        }
    }

    pub(super) struct Stream {
        inner: UnixStream,
    }

    impl Stream {
        pub async fn connect(path: &std::path::Path) -> std::io::Result<Self> {
            Ok(Self {
                inner: UnixStream::connect(path).await?,
            })
        }

        pub async fn read_exact(&mut self, buf: &mut [u8]) -> std::io::Result<()> {
            use tokio::io::AsyncReadExt;
            self.inner.read_exact(buf).await.map(|_| ())
        }

        pub async fn write_all(&mut self, buf: &[u8]) -> std::io::Result<()> {
            use tokio::io::AsyncWriteExt;
            self.inner.write_all(buf).await
        }
    }
}

// ---------------------------------------------------------------------------
// Windows implementation (named pipes)
// ---------------------------------------------------------------------------

#[cfg(windows)]
mod platform {
    use tokio::net::windows::named_pipe::{ClientOptions, ServerOptions};

    pub(super) struct Listener {
        pipe_name: String,
    }

    impl Listener {
        pub fn bind(path: &std::path::Path) -> std::io::Result<Self> {
            // Convert filesystem path to named pipe path:
            // C:\Users\...\foo.sock → \\.\pipe\majra-<hash>
            let name = path.file_stem().and_then(|s| s.to_str()).unwrap_or("majra");
            let pipe_name = format!(r"\\.\pipe\majra-{}", name);
            // Create the first instance to verify the name is available.
            let _server = ServerOptions::new()
                .first_pipe_instance(true)
                .create(&pipe_name)?;
            Ok(Self { pipe_name })
        }

        pub async fn accept(&self) -> std::io::Result<Stream> {
            let server = ServerOptions::new().create(&self.pipe_name)?;
            server.connect().await?;
            Ok(Stream {
                inner: StreamInner::Server(server),
            })
        }
    }

    pub(super) struct Stream {
        inner: StreamInner,
    }

    enum StreamInner {
        Server(tokio::net::windows::named_pipe::NamedPipeServer),
        Client(tokio::net::windows::named_pipe::NamedPipeClient),
    }

    impl Stream {
        pub async fn connect(path: &std::path::Path) -> std::io::Result<Self> {
            let name = path.file_stem().and_then(|s| s.to_str()).unwrap_or("majra");
            let pipe_name = format!(r"\\.\pipe\majra-{}", name);
            let client = ClientOptions::new().open(&pipe_name)?;
            Ok(Self {
                inner: StreamInner::Client(client),
            })
        }

        pub async fn read_exact(&mut self, buf: &mut [u8]) -> std::io::Result<()> {
            use tokio::io::AsyncReadExt;
            match &mut self.inner {
                StreamInner::Server(s) => s.read_exact(buf).await.map(|_| ()),
                StreamInner::Client(c) => c.read_exact(buf).await.map(|_| ()),
            }
        }

        pub async fn write_all(&mut self, buf: &[u8]) -> std::io::Result<()> {
            use tokio::io::AsyncWriteExt;
            match &mut self.inner {
                StreamInner::Server(s) => s.write_all(buf).await,
                StreamInner::Client(c) => c.write_all(buf).await,
            }
        }
    }
}

// ---------------------------------------------------------------------------
// Public API (platform-agnostic)
// ---------------------------------------------------------------------------

/// A listening IPC server.
///
/// On Unix, binds to a Unix domain socket. On Windows, creates a named pipe.
pub struct IpcServer {
    listener: platform::Listener,
}

impl IpcServer {
    /// Bind to a local IPC endpoint.
    ///
    /// `path` is used as a Unix socket path on Unix, or converted to a
    /// named pipe name on Windows.
    pub fn bind(path: &std::path::Path) -> Result<Self> {
        let listener = platform::Listener::bind(path)?;
        debug!(path = %path.display(), "ipc: server bound");
        Ok(Self { listener })
    }

    /// Accept the next incoming connection.
    pub async fn accept(&self) -> Result<IpcConnection> {
        let stream = self.listener.accept().await?;
        debug!("ipc: connection accepted");
        Ok(IpcConnection { stream })
    }
}

/// A bidirectional IPC connection.
///
/// Used for both server-accepted and client-initiated connections.
pub struct IpcConnection {
    stream: platform::Stream,
}

impl IpcConnection {
    /// Connect to a local IPC endpoint (client-side).
    pub async fn connect(path: &std::path::Path) -> Result<Self> {
        let stream = platform::Stream::connect(path).await?;
        Ok(Self { stream })
    }

    /// Send a JSON value as a length-prefixed frame.
    pub async fn send(&mut self, payload: &serde_json::Value) -> Result<()> {
        let data = serde_json::to_vec(payload)?;
        let len = u32::try_from(data.len()).map_err(|_| IpcError::FrameTooLarge {
            size: u32::MAX,
            max: MAX_FRAME_SIZE,
        })?;
        if len > MAX_FRAME_SIZE {
            return Err(IpcError::FrameTooLarge {
                size: len,
                max: MAX_FRAME_SIZE,
            });
        }
        self.stream.write_all(&len.to_be_bytes()).await?;
        self.stream.write_all(&data).await?;
        trace!(bytes = len, "ipc: frame sent");
        Ok(())
    }

    /// Receive a JSON value from a length-prefixed frame.
    pub async fn recv(&mut self) -> Result<serde_json::Value> {
        let mut len_buf = [0u8; 4];
        match self.stream.read_exact(&mut len_buf).await {
            Ok(()) => {}
            Err(e) if e.kind() == std::io::ErrorKind::UnexpectedEof => {
                trace!("ipc: connection closed by peer");
                return Err(IpcError::ConnectionClosed);
            }
            Err(e) => return Err(e.into()),
        }
        let len = u32::from_be_bytes(len_buf);
        if len > MAX_FRAME_SIZE {
            return Err(IpcError::FrameTooLarge {
                size: len,
                max: MAX_FRAME_SIZE,
            });
        }
        let mut buf = vec![0u8; len as usize];
        self.stream.read_exact(&mut buf).await?;
        let value = serde_json::from_slice(&buf)?;
        trace!(bytes = len, "ipc: frame received");
        Ok(value)
    }
}

/// Backward-compatible alias — use [`IpcConnection`] directly.
pub type IpcClient = IpcConnection;

#[cfg(test)]
mod tests {
    use super::*;
    use std::path::PathBuf;

    fn tmp_socket() -> PathBuf {
        let id = uuid::Uuid::new_v4();
        std::env::temp_dir().join(format!("majra-test-{id}.sock"))
    }

    #[tokio::test]
    async fn roundtrip() {
        let path = tmp_socket();
        let server = IpcServer::bind(&path).unwrap();

        let handle = tokio::spawn({
            let path = path.clone();
            async move {
                let mut client = IpcClient::connect(&path).await.unwrap();
                client
                    .send(&serde_json::json!({"hello": "world"}))
                    .await
                    .unwrap();
                let resp = client.recv().await.unwrap();
                assert_eq!(resp["echo"], "world");
            }
        });

        let mut conn = server.accept().await.unwrap();
        let msg = conn.recv().await.unwrap();
        assert_eq!(msg["hello"], "world");
        conn.send(&serde_json::json!({"echo": "world"}))
            .await
            .unwrap();

        handle.await.unwrap();
        let _ = std::fs::remove_file(&path);
    }

    #[tokio::test]
    async fn connection_closed() {
        let path = tmp_socket();
        let server = IpcServer::bind(&path).unwrap();

        let handle = tokio::spawn({
            let path = path.clone();
            async move {
                let _client = IpcClient::connect(&path).await.unwrap();
                // Drop immediately.
            }
        });

        let mut conn = server.accept().await.unwrap();
        handle.await.unwrap();

        let result = conn.recv().await;
        assert!(matches!(result, Err(IpcError::ConnectionClosed)));
        let _ = std::fs::remove_file(&path);
    }

    #[tokio::test]
    async fn write_frame_too_large() {
        let path = tmp_socket();
        let server = IpcServer::bind(&path).unwrap();

        let handle = tokio::spawn({
            let path = path.clone();
            async move {
                let mut client = IpcConnection::connect(&path).await.unwrap();
                // Test a valid large-ish payload works.
                let big = serde_json::json!({"data": "x".repeat(1000)});
                client.send(&big).await.unwrap();
            }
        });

        let mut conn = server.accept().await.unwrap();
        let msg = conn.recv().await.unwrap();
        assert_eq!(msg["data"].as_str().unwrap().len(), 1000);

        handle.await.unwrap();
        let _ = std::fs::remove_file(&path);
    }

    // read_frame_too_large test uses platform-specific raw stream access,
    // so it's gated to Unix only.
    #[cfg(unix)]
    #[tokio::test]
    async fn read_frame_too_large() {
        use tokio::io::AsyncWriteExt;
        use tokio::net::UnixStream;

        let path = tmp_socket();
        let server = IpcServer::bind(&path).unwrap();

        let handle = tokio::spawn({
            let path = path.clone();
            async move {
                // Send a raw frame with a length header exceeding MAX_FRAME_SIZE.
                let mut stream = UnixStream::connect(&path).await.unwrap();
                let fake_len: u32 = super::MAX_FRAME_SIZE + 1;
                stream.write_all(&fake_len.to_be_bytes()).await.unwrap();
            }
        });

        let mut conn = server.accept().await.unwrap();
        let result = conn.recv().await;
        assert!(matches!(result, Err(IpcError::FrameTooLarge { .. })));

        handle.await.unwrap();
        let _ = std::fs::remove_file(&path);
    }
}