telltale-runtime 17.0.0

Choreographic programming for Telltale - effect-based distributed protocols
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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
//! TopologyHandler: Topology-aware protocol handler.
//!
//! This module provides a handler that automatically selects and manages
//! transports based on the topology configuration.

use super::{
    InMemoryChannelTransport, Location, Topology, TopologyError, Transport, TransportError,
    TransportResult,
};
use crate::identifiers::RoleName;
use crate::util::sync::RwLock;
use crate::{read_lock, write_lock};
use std::collections::{BTreeMap, BTreeSet};
use std::sync::{Arc, Mutex, OnceLock};
use thiserror::Error;

#[derive(Default)]
struct SharedLocalTopologyState {
    transports: BTreeMap<RoleName, Arc<InMemoryChannelTransport>>,
    connected_pairs: BTreeSet<(RoleName, RoleName)>,
}

type SharedLocalRegistry = BTreeMap<String, SharedLocalTopologyState>;

fn shared_local_registry() -> &'static Mutex<SharedLocalRegistry> {
    static REGISTRY: OnceLock<Mutex<SharedLocalRegistry>> = OnceLock::new();
    REGISTRY.get_or_init(|| Mutex::new(BTreeMap::new()))
}

fn topology_signature(topology: &Topology) -> String {
    let mut parts = Vec::new();
    parts.push(format!("mode:{:?}", topology.mode));
    for (role, location) in &topology.locations {
        parts.push(format!("role:{role}:{location}"));
    }
    for ((sender, receiver), capacity) in &topology.channel_capacities {
        parts.push(format!("capacity:{sender}:{receiver}:{}", capacity.get()));
    }
    for constraint in &topology.constraints {
        parts.push(format!("constraint:{constraint}"));
    }
    parts.join("|")
}

#[derive(Clone)]
struct SharedInMemoryTransport {
    inner: Arc<InMemoryChannelTransport>,
}

impl SharedInMemoryTransport {
    fn new(inner: Arc<InMemoryChannelTransport>) -> Self {
        Self { inner }
    }
}

#[async_trait::async_trait]
impl Transport for SharedInMemoryTransport {
    async fn send(&self, to_role: &RoleName, message: Vec<u8>) -> TransportResult<()> {
        self.inner.send(to_role, message).await
    }

    async fn recv(&self, from_role: &RoleName) -> TransportResult<Vec<u8>> {
        self.inner.recv(from_role).await
    }

    fn is_connected(&self, role: &RoleName) -> bool {
        self.inner.is_connected(role)
    }

    async fn close(&self) -> TransportResult<()> {
        Ok(())
    }
}

/// A topology-aware protocol handler.
///
/// `TopologyHandler` wraps transport selection and routing based on the
/// topology configuration. It automatically creates appropriate transports
/// for each peer role based on their locations (local, remote, colocated).
///
/// # Example
///
/// ```ignore
/// let topology = Topology::builder()
///     .local_role(RoleName::from_static("Alice"))
///     .remote_role(
///         RoleName::from_static("Bob"),
///         TopologyEndpoint::new("localhost:8080").unwrap(),
///     )
///     .build();
///
/// let handler = TopologyHandler::new(topology, RoleName::from_static("Alice"));
///
/// // Send to Bob - automatically uses TCP
/// handler
///     .send(&RoleName::from_static("Bob"), b"Hello".to_vec())
///     .await?;
/// ```
pub struct TopologyHandler {
    /// The topology configuration.
    topology: Topology,
    /// Stable signature used to share deterministic local transports.
    topology_signature: String,
    /// The role this handler represents.
    role: RoleName,
    /// Transports for each peer role.
    transports: Arc<RwLock<BTreeMap<RoleName, Box<dyn Transport>>>>,
    /// Whether the handler is initialized.
    initialized: Arc<RwLock<bool>>,
}

impl TopologyHandler {
    /// Create a new topology handler.
    pub fn new(topology: Topology, role: RoleName) -> Self {
        let topology_signature = topology_signature(&topology);
        Self {
            topology,
            topology_signature,
            role,
            transports: Arc::new(RwLock::new(BTreeMap::new())),
            initialized: Arc::new(RwLock::new(false)),
        }
    }

    /// Create a handler from a parsed topology.
    pub fn from_parsed(parsed: super::ParsedTopology, role: RoleName) -> Self {
        Self::new(parsed.topology, role)
    }

    /// Get the role this handler represents.
    pub fn role(&self) -> &RoleName {
        &self.role
    }

    /// Get the topology configuration.
    pub fn topology(&self) -> &Topology {
        &self.topology
    }

    async fn ensure_connected_transport(&self, peer: &RoleName) -> Arc<InMemoryChannelTransport> {
        let (local, remote, should_connect) = {
            let mut registry = shared_local_registry()
                .lock()
                .unwrap_or_else(|poisoned| poisoned.into_inner());
            let entry = registry.entry(self.topology_signature.clone()).or_default();

            let local = entry
                .transports
                .entry(self.role.clone())
                .or_insert_with(|| Arc::new(InMemoryChannelTransport::new(self.role.clone())))
                .clone();
            let remote = entry
                .transports
                .entry(peer.clone())
                .or_insert_with(|| Arc::new(InMemoryChannelTransport::new(peer.clone())))
                .clone();

            let pair = if self.role <= *peer {
                (self.role.clone(), peer.clone())
            } else {
                (peer.clone(), self.role.clone())
            };
            let should_connect = entry.connected_pairs.insert(pair);
            (local, remote, should_connect)
        };

        if should_connect {
            local.connect(&remote).await;
        }
        local
    }

    async fn ensure_transport(&self, role: &RoleName) -> TransportResult<Box<dyn Transport>> {
        let self_location = self
            .topology
            .get_location(&self.role)
            .map_err(|_| TransportError::UnknownRole(self.role.clone()))?;
        let peer_location = self
            .topology
            .get_location(role)
            .map_err(|_| TransportError::UnknownRole(role.clone()))?;
        if matches!(self_location, Location::Remote(_))
            || matches!(peer_location, Location::Remote(_))
        {
            #[cfg(target_arch = "wasm32")]
            {
                return Err(TransportError::NotReady);
            }
            #[cfg(not(target_arch = "wasm32"))]
            {
                return super::transport::create_peer_transport(
                    &self.topology,
                    &self.topology_signature,
                    &self.role,
                    role,
                )
                .await;
            }
        }
        let shared = self.ensure_connected_transport(role).await;
        Ok(Box::new(SharedInMemoryTransport::new(shared)))
    }

    /// Initialize transports for all roles.
    pub async fn initialize(&self) -> TransportResult<()> {
        let mut transports = write_lock!(self.transports);
        let mut initialized = write_lock!(self.initialized);

        if *initialized {
            return Ok(());
        }

        // Create transports for each role in the topology
        for role in self.topology.locations.keys() {
            if role != &self.role {
                let transport = self.ensure_transport(role).await?;
                transports.insert(role.clone(), transport);
            }
        }

        *initialized = true;
        Ok(())
    }

    /// Send a message to a role.
    pub async fn send(&self, to_role: &RoleName, message: Vec<u8>) -> TransportResult<()> {
        let transports = read_lock!(self.transports);

        // If we don't have a transport, create one on-demand
        if let Some(transport) = transports.get(to_role) {
            transport.send(to_role, message).await
        } else {
            drop(transports);

            // Create transport on-demand
            let mut transports = write_lock!(self.transports);
            let transport = self.ensure_transport(to_role).await?;
            transports.insert(to_role.clone(), transport);

            transports
                .get(to_role)
                .ok_or_else(|| TransportError::UnknownRole(to_role.clone()))?
                .send(to_role, message)
                .await
        }
    }

    /// Receive a message from a role.
    pub async fn recv(&self, from_role: &RoleName) -> TransportResult<Vec<u8>> {
        let transports = read_lock!(self.transports);

        if let Some(transport) = transports.get(from_role) {
            transport.recv(from_role).await
        } else {
            drop(transports);

            let mut transports = write_lock!(self.transports);
            let transport = self.ensure_transport(from_role).await?;
            transports.insert(from_role.clone(), transport);

            transports
                .get(from_role)
                .ok_or_else(|| TransportError::UnknownRole(from_role.clone()))?
                .recv(from_role)
                .await
        }
    }

    /// Check if connected to a role.
    pub async fn is_connected(&self, role: &RoleName) -> Result<bool, TopologyError> {
        if self.topology.is_local(role)? {
            return Ok(true);
        }

        let transports = read_lock!(self.transports);
        if let Some(transport) = transports.get(role) {
            Ok(transport.is_connected(role))
        } else {
            Ok(false)
        }
    }

    /// Get the location of a role.
    pub fn get_location(&self, role: &RoleName) -> Result<Location, TopologyError> {
        self.topology.get_location(role)
    }

    /// Close all transports.
    pub async fn close(&self) -> TransportResult<()> {
        let mut transports = write_lock!(self.transports);

        for (_, transport) in transports.iter() {
            transport.close().await?;
        }

        transports.clear();
        *write_lock!(self.initialized) = false;

        Ok(())
    }
}

/// Builder for TopologyHandler with fluent API.
pub struct TopologyHandlerBuilder {
    topology: Topology,
    role: Option<RoleName>,
}

/// Errors that can occur while building a TopologyHandler.
#[derive(Debug, Error)]
pub enum TopologyHandlerBuildError {
    #[error("role not specified for topology handler")]
    MissingRole,
}

impl TopologyHandlerBuilder {
    /// Create a new builder with a topology.
    pub fn new(topology: Topology) -> Self {
        Self {
            topology,
            role: None,
        }
    }

    /// Set the role for this handler.
    pub fn with_role(mut self, role: RoleName) -> Self {
        self.role = Some(role);
        self
    }

    /// Build the handler.
    pub fn build(self) -> Result<TopologyHandler, TopologyHandlerBuildError> {
        let role = self.role.ok_or(TopologyHandlerBuildError::MissingRole)?;
        Ok(TopologyHandler::new(self.topology, role))
    }
}

/// Quick constructor for common cases.
impl TopologyHandler {
    /// Create a handler for local-only mode.
    ///
    /// All roles run in-process using channels.
    pub fn local(role: RoleName) -> Self {
        Self::new(Topology::local_mode(), role)
    }

    /// Create a handler builder.
    pub fn builder(topology: Topology) -> TopologyHandlerBuilder {
        TopologyHandlerBuilder::new(topology)
    }
}

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

    #[test]
    fn test_topology_handler_creation() {
        let topology = Topology::builder()
            .local_role(RoleName::from_static("Alice"))
            .local_role(RoleName::from_static("Bob"))
            .build();

        let handler = TopologyHandler::new(topology, RoleName::from_static("Alice"));
        assert_eq!(handler.role(), &RoleName::from_static("Alice"));
    }

    #[test]
    fn test_local_handler() {
        let handler = TopologyHandler::local(RoleName::from_static("Alice"));
        assert_eq!(handler.role(), &RoleName::from_static("Alice"));
        assert!(handler.topology().mode.is_some());
    }

    #[test]
    fn test_handler_builder() {
        let topology = Topology::builder()
            .remote_role(
                RoleName::from_static("Alice"),
                crate::identifiers::Endpoint::new("localhost:8080").unwrap(),
            )
            .remote_role(
                RoleName::from_static("Bob"),
                crate::identifiers::Endpoint::new("localhost:8081").unwrap(),
            )
            .build();

        let handler = TopologyHandler::builder(topology)
            .with_role(RoleName::from_static("Alice"))
            .build()
            .unwrap();

        assert_eq!(handler.role(), &RoleName::from_static("Alice"));
    }

    #[test]
    fn test_get_location() {
        let topology = Topology::builder()
            .local_role(RoleName::from_static("Alice"))
            .remote_role(
                RoleName::from_static("Bob"),
                crate::identifiers::Endpoint::new("localhost:8080").unwrap(),
            )
            .build();

        let handler = TopologyHandler::new(topology, RoleName::from_static("Alice"));

        assert_eq!(
            handler
                .get_location(&RoleName::from_static("Alice"))
                .unwrap(),
            Location::Local
        );
        assert_eq!(
            handler.get_location(&RoleName::from_static("Bob")).unwrap(),
            Location::Remote(crate::identifiers::Endpoint::new("localhost:8080").unwrap())
        );
    }

    #[cfg(not(target_arch = "wasm32"))]
    #[tokio::test]
    async fn local_handlers_share_deterministic_message_routing() {
        let topology = Topology::builder()
            .local_role(RoleName::from_static("Alice"))
            .local_role(RoleName::from_static("Bob"))
            .build();
        let alice = TopologyHandler::new(topology.clone(), RoleName::from_static("Alice"));
        let bob = TopologyHandler::new(topology, RoleName::from_static("Bob"));

        alice.initialize().await.unwrap();
        bob.initialize().await.unwrap();

        alice
            .send(&RoleName::from_static("Bob"), b"ping".to_vec())
            .await
            .unwrap();
        assert_eq!(
            bob.recv(&RoleName::from_static("Alice")).await.unwrap(),
            b"ping".to_vec()
        );

        bob.send(&RoleName::from_static("Alice"), b"pong".to_vec())
            .await
            .unwrap();
        assert_eq!(
            alice.recv(&RoleName::from_static("Bob")).await.unwrap(),
            b"pong".to_vec()
        );
    }
}