ironclaw 0.24.0

Secure personal AI assistant that protects your data and expands its capabilities on the fly
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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
//! Channel trait implementation for channel-relay webhook callbacks.
//!
//! `RelayChannel` receives events from channel-relay via HTTP POST callbacks
//! (pushed through an mpsc channel by the webhook handler), converts them
//! to `IncomingMessage`s, and sends responses via the relay's provider-specific
//! proxy API (Slack).

use std::collections::HashMap;

use async_trait::async_trait;
use tokio::sync::mpsc;

use crate::channels::relay::client::{ChannelEvent, RelayClient};
use crate::channels::{Channel, IncomingMessage, MessageStream, OutgoingResponse, StatusUpdate};
use crate::error::ChannelError;

/// Default channel name for the Slack relay integration.
pub const DEFAULT_RELAY_NAME: &str = "slack-relay";

/// The messaging provider backing a relay channel.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RelayProvider {
    Slack,
}

impl RelayProvider {
    /// Provider string used in proxy API routes and metadata.
    pub fn as_str(&self) -> &'static str {
        match self {
            Self::Slack => "slack",
        }
    }

    /// The default channel name for this provider.
    pub fn channel_name(&self) -> &'static str {
        match self {
            Self::Slack => DEFAULT_RELAY_NAME,
        }
    }
}

/// Channel implementation that receives events from channel-relay via webhook callbacks.
pub struct RelayChannel {
    client: RelayClient,
    provider: RelayProvider,
    team_id: String,
    instance_id: String,
    /// Sender side of the event channel — shared with the webhook handler.
    event_tx: mpsc::Sender<ChannelEvent>,
    /// Receiver side — taken once by `start()`.
    event_rx: tokio::sync::Mutex<Option<mpsc::Receiver<ChannelEvent>>>,
}

impl RelayChannel {
    /// Create a new relay channel for Slack (default provider).
    pub fn new(
        client: RelayClient,
        team_id: String,
        instance_id: String,
        event_tx: mpsc::Sender<ChannelEvent>,
        event_rx: mpsc::Receiver<ChannelEvent>,
    ) -> Self {
        Self::new_with_provider(
            client,
            RelayProvider::Slack,
            team_id,
            instance_id,
            event_tx,
            event_rx,
        )
    }

    /// Create a new relay channel with a specific provider.
    pub fn new_with_provider(
        client: RelayClient,
        provider: RelayProvider,
        team_id: String,
        instance_id: String,
        event_tx: mpsc::Sender<ChannelEvent>,
        event_rx: mpsc::Receiver<ChannelEvent>,
    ) -> Self {
        Self {
            client,
            provider,
            team_id,
            instance_id,
            event_tx,
            event_rx: tokio::sync::Mutex::new(Some(event_rx)),
        }
    }

    /// Get a clone of the event sender for wiring into the webhook endpoint.
    pub fn event_sender(&self) -> mpsc::Sender<ChannelEvent> {
        self.event_tx.clone()
    }

    /// Build a provider-appropriate proxy body for sending a message.
    fn build_send_body(
        &self,
        channel_id: &str,
        text: &str,
        thread_id: Option<&str>,
    ) -> (String, serde_json::Value) {
        match self.provider {
            RelayProvider::Slack => {
                let mut body = serde_json::json!({
                    "channel": channel_id,
                    "text": text,
                });
                if let Some(tid) = thread_id {
                    body["thread_ts"] = serde_json::Value::String(tid.to_string());
                }
                ("chat.postMessage".to_string(), body)
            }
        }
    }

    /// Send a message via the provider proxy.
    async fn proxy_send(
        &self,
        team_id: &str,
        method: &str,
        body: serde_json::Value,
    ) -> Result<serde_json::Value, crate::channels::relay::client::RelayError> {
        self.client
            .proxy_provider(self.provider.as_str(), team_id, method, body)
            .await
    }
}

#[async_trait]
impl Channel for RelayChannel {
    fn name(&self) -> &str {
        self.provider.channel_name()
    }

    async fn start(&self) -> Result<MessageStream, ChannelError> {
        let channel_name = self.name().to_string();

        // Take the receiver (can only start once)
        let mut event_rx =
            self.event_rx
                .lock()
                .await
                .take()
                .ok_or_else(|| ChannelError::StartupFailed {
                    name: channel_name.clone(),
                    reason: "RelayChannel already started".to_string(),
                })?;

        let (tx, rx) = mpsc::channel(64);
        let provider_str = self.provider.as_str().to_string();
        let relay_name = channel_name.clone();

        // Spawn a task that reads events from the webhook handler and converts to IncomingMessage
        tokio::spawn(async move {
            while let Some(event) = event_rx.recv().await {
                // Validate required fields
                if event.sender_id.is_empty()
                    || event.channel_id.is_empty()
                    || event.provider_scope.is_empty()
                {
                    tracing::debug!(
                        event_type = %event.event_type,
                        sender_id = %event.sender_id,
                        channel_id = %event.channel_id,
                        "Relay: skipping event with missing required fields"
                    );
                    continue;
                }

                // Skip non-message events
                if !event.is_message() {
                    tracing::debug!(
                        event_type = %event.event_type,
                        "Relay: skipping non-message event"
                    );
                    continue;
                }

                tracing::info!(
                    event_type = %event.event_type,
                    sender = %event.sender_id,
                    channel = %event.channel_id,
                    provider = %provider_str,
                    "Relay: received message from {}", provider_str
                );

                let msg = IncomingMessage::new(&relay_name, &event.sender_id, event.text())
                    .with_user_name(event.display_name())
                    .with_metadata(serde_json::json!({
                        "team_id": event.team_id(),
                        "channel_id": event.channel_id,
                        "sender_id": event.sender_id,
                        "sender_name": event.display_name(),
                        "event_type": event.event_type,
                        "thread_id": event.thread_id,
                        "provider": event.provider,
                    }));

                let msg = if let Some(ref thread_id) = event.thread_id {
                    msg.with_thread(thread_id)
                } else {
                    msg.with_thread(&event.channel_id)
                };

                if tx.send(msg).await.is_err() {
                    tracing::info!("Relay channel receiver dropped, stopping");
                    return;
                }
            }

            tracing::info!("Relay event channel closed");
        });

        let stream = tokio_stream::wrappers::ReceiverStream::new(rx);
        Ok(Box::pin(stream))
    }

    async fn respond(
        &self,
        msg: &IncomingMessage,
        response: OutgoingResponse,
    ) -> Result<(), ChannelError> {
        let channel_name = self.name().to_string();
        let metadata = &msg.metadata;
        let team_id = metadata
            .get("team_id")
            .and_then(|v| v.as_str())
            .unwrap_or(&self.team_id);
        let channel_id = metadata
            .get("channel_id")
            .and_then(|v| v.as_str())
            .ok_or_else(|| ChannelError::SendFailed {
                name: channel_name.clone(),
                reason: "Missing channel_id in message metadata".to_string(),
            })?;

        // Determine thread_id from response or metadata
        let thread_id = response
            .thread_id
            .as_deref()
            .or_else(|| metadata.get("thread_id").and_then(|v| v.as_str()));

        let (method, body) = self.build_send_body(channel_id, &response.content, thread_id);

        self.proxy_send(team_id, &method, body)
            .await
            .map_err(|e| ChannelError::SendFailed {
                name: channel_name,
                reason: e.to_string(),
            })?;

        Ok(())
    }

    async fn send_status(
        &self,
        status: StatusUpdate,
        metadata: &serde_json::Value,
    ) -> Result<(), ChannelError> {
        // Only handle ApprovalNeeded — all other variants are no-ops
        let StatusUpdate::ApprovalNeeded {
            request_id,
            tool_name,
            description,
            parameters,
            allow_always: _,
        } = status
        else {
            return Ok(());
        };

        // Only send buttons in DMs (dispatcher gates upstream, but guard here too)
        let event_type = metadata
            .get("event_type")
            .and_then(|v| v.as_str())
            .unwrap_or("");
        if event_type != "direct_message" {
            tracing::warn!(
                tool = %tool_name,
                event_type,
                "Approval requested in non-DM, skipping buttons"
            );
            return Ok(());
        }

        // Extract required metadata — error if missing
        let channel_id = metadata
            .get("channel_id")
            .and_then(|v| v.as_str())
            .ok_or_else(|| ChannelError::SendFailed {
                name: self.name().to_string(),
                reason: "Missing channel_id for approval buttons".into(),
            })?;
        let thread_id = metadata.get("thread_id").and_then(|v| v.as_str());
        let team_id = metadata
            .get("team_id")
            .and_then(|v| v.as_str())
            .unwrap_or(&self.team_id);

        // Register server-side approval record and get opaque token.
        // The button value contains ONLY the token — no routing fields.
        let approval_token = self
            .client
            .create_approval(team_id, channel_id, thread_id, &request_id)
            .await
            .map_err(|e| ChannelError::SendFailed {
                name: self.name().to_string(),
                reason: format!("Failed to register approval: {e}"),
            })?;
        let value_payload = serde_json::json!({
            "approval_token": approval_token,
        });
        let value_str = value_payload.to_string();

        // Parameters are already redacted via redact_params() in dispatcher.rs
        let params_display =
            serde_json::to_string_pretty(&parameters).unwrap_or_else(|_| parameters.to_string());

        let blocks = serde_json::json!([
            {
                "type": "section",
                "text": {
                    "type": "mrkdwn",
                    "text": format!(
                        "*Tool approval required*\n`{tool_name}`: {description}\n```{params_display}```"
                    )
                }
            },
            {
                "type": "actions",
                "elements": [
                    {
                        "type": "button",
                        "text": { "type": "plain_text", "text": "Approve" },
                        "style": "primary",
                        "action_id": "approve_tool",
                        "value": value_str,
                    },
                    {
                        "type": "button",
                        "text": { "type": "plain_text", "text": "Deny" },
                        "style": "danger",
                        "action_id": "deny_tool",
                        "value": value_str,
                    }
                ]
            }
        ]);

        let mut body = serde_json::json!({
            "channel": channel_id,
            "text": format!("Tool approval required: {tool_name} - {description}"),
            "blocks": blocks,
        });
        if let Some(tid) = thread_id {
            body["thread_ts"] = serde_json::Value::String(tid.to_string());
        }

        self.proxy_send(team_id, "chat.postMessage", body)
            .await
            .map_err(|e| ChannelError::SendFailed {
                name: self.name().to_string(),
                reason: e.to_string(),
            })?;

        Ok(())
    }

    async fn broadcast(
        &self,
        target: &str,
        response: OutgoingResponse,
    ) -> Result<(), ChannelError> {
        let channel_name = self.name().to_string();

        // Determine thread_id from response or metadata
        let thread_id = response
            .thread_id
            .as_deref()
            .or_else(|| response.metadata.get("thread_ts").and_then(|v| v.as_str()));

        let (method, body) = self.build_send_body(target, &response.content, thread_id);

        self.proxy_send(&self.team_id, &method, body)
            .await
            .map_err(|e| ChannelError::SendFailed {
                name: channel_name,
                reason: e.to_string(),
            })?;

        Ok(())
    }

    async fn health_check(&self) -> Result<(), ChannelError> {
        self.client
            .list_connections(&self.instance_id)
            .await
            .map_err(|_| ChannelError::HealthCheckFailed {
                name: self.name().to_string(),
            })?;
        Ok(())
    }

    fn conversation_context(&self, metadata: &serde_json::Value) -> HashMap<String, String> {
        let mut ctx = HashMap::new();

        if let Some(sender) = metadata.get("sender_name").and_then(|v| v.as_str()) {
            ctx.insert("sender".to_string(), sender.to_string());
        }
        if let Some(sender_id) = metadata.get("sender_id").and_then(|v| v.as_str()) {
            ctx.insert("sender_uuid".to_string(), sender_id.to_string());
        }
        if let Some(channel_id) = metadata.get("channel_id").and_then(|v| v.as_str()) {
            ctx.insert("group".to_string(), channel_id.to_string());
        }
        ctx.insert("platform".to_string(), self.provider.as_str().to_string());

        ctx
    }

    async fn shutdown(&self) -> Result<(), ChannelError> {
        // Relay cleanup is driven by the extension manager dropping the shared
        // sender and removing the channel from the channel manager.
        Ok(())
    }
}

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

    fn test_client() -> RelayClient {
        RelayClient::new(
            "http://localhost:3001".into(),
            secrecy::SecretString::from("key".to_string()),
            30,
        )
        .expect("client")
    }

    fn make_channel() -> RelayChannel {
        let (tx, rx) = mpsc::channel(64);
        RelayChannel::new(test_client(), "T123".into(), "inst1".into(), tx, rx)
    }

    #[test]
    fn relay_channel_name() {
        let channel = make_channel();
        assert_eq!(channel.name(), DEFAULT_RELAY_NAME);
    }

    #[test]
    fn conversation_context_extracts_metadata() {
        let channel = make_channel();

        let metadata = serde_json::json!({
            "sender_name": "bob",
            "sender_id": "U123",
            "channel_id": "C456",
        });
        let ctx = channel.conversation_context(&metadata);
        assert_eq!(ctx.get("sender"), Some(&"bob".to_string()));
        assert_eq!(ctx.get("sender_uuid"), Some(&"U123".to_string()));
        assert_eq!(ctx.get("platform"), Some(&"slack".to_string()));
    }

    #[test]
    fn metadata_shape_includes_event_type_and_sender_name() {
        let metadata = serde_json::json!({
            "team_id": "T123",
            "channel_id": "C456",
            "sender_id": "U789",
            "sender_name": "alice",
            "event_type": "direct_message",
            "thread_id": null,
            "provider": "slack",
        });
        assert_eq!(
            metadata.get("event_type").and_then(|v| v.as_str()),
            Some("direct_message")
        );
        assert_eq!(
            metadata.get("sender_name").and_then(|v| v.as_str()),
            Some("alice")
        );
    }

    #[test]
    fn build_send_body_slack() {
        let channel = make_channel();
        let (method, body) = channel.build_send_body("C456", "hello", Some("1234567.890"));
        assert_eq!(method, "chat.postMessage");
        assert_eq!(body["channel"], "C456");
        assert_eq!(body["text"], "hello");
        assert_eq!(body["thread_ts"], "1234567.890");
    }

    #[tokio::test]
    async fn start_processes_events() {
        let (tx, rx) = mpsc::channel(64);
        let channel =
            RelayChannel::new(test_client(), "T123".into(), "inst1".into(), tx.clone(), rx);

        let mut stream = channel.start().await.unwrap();

        // Send an event
        tx.send(ChannelEvent {
            id: "1".into(),
            event_type: "message".into(),
            provider: "slack".into(),
            provider_scope: "T123".into(),
            channel_id: "C456".into(),
            sender_id: "U789".into(),
            sender_name: Some("alice".into()),
            content: Some("hello".into()),
            thread_id: None,
            raw: serde_json::Value::Null,
            timestamp: None,
        })
        .await
        .unwrap();

        use futures::StreamExt;
        let msg = tokio::time::timeout(std::time::Duration::from_secs(1), stream.next())
            .await
            .unwrap()
            .unwrap();

        assert_eq!(msg.content, "hello");
        assert_eq!(msg.user_id, "U789");
    }

    #[tokio::test]
    async fn start_skips_non_message_events() {
        let (tx, rx) = mpsc::channel(64);
        let channel =
            RelayChannel::new(test_client(), "T123".into(), "inst1".into(), tx.clone(), rx);

        let mut stream = channel.start().await.unwrap();

        // Send a non-message event (should be skipped)
        tx.send(ChannelEvent {
            id: "1".into(),
            event_type: "reaction".into(),
            provider: "slack".into(),
            provider_scope: "T123".into(),
            channel_id: "C456".into(),
            sender_id: "U789".into(),
            sender_name: None,
            content: None,
            thread_id: None,
            raw: serde_json::Value::Null,
            timestamp: None,
        })
        .await
        .unwrap();

        // Send a real message
        tx.send(ChannelEvent {
            id: "2".into(),
            event_type: "message".into(),
            provider: "slack".into(),
            provider_scope: "T123".into(),
            channel_id: "C456".into(),
            sender_id: "U789".into(),
            sender_name: None,
            content: Some("real message".into()),
            thread_id: None,
            raw: serde_json::Value::Null,
            timestamp: None,
        })
        .await
        .unwrap();

        use futures::StreamExt;
        let msg = tokio::time::timeout(std::time::Duration::from_secs(1), stream.next())
            .await
            .unwrap()
            .unwrap();

        assert_eq!(msg.content, "real message");
    }

    #[tokio::test]
    async fn test_send_status_non_approval_is_noop() {
        let channel = make_channel();
        let metadata = serde_json::json!({});
        let result = channel
            .send_status(
                StatusUpdate::ToolStarted {
                    name: "echo".into(),
                },
                &metadata,
            )
            .await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_send_status_approval_non_dm_skips() {
        let channel = make_channel();
        let metadata = serde_json::json!({
            "event_type": "message",
            "channel_id": "C456",
            "sender_id": "U789",
        });
        let result = channel
            .send_status(
                StatusUpdate::ApprovalNeeded {
                    request_id: "req1".into(),
                    tool_name: "shell".into(),
                    description: "run command".into(),
                    parameters: serde_json::json!({}),
                    allow_always: true,
                },
                &metadata,
            )
            .await;
        // Non-DM approval requests are silently skipped (no HTTP call)
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_send_status_approval_dm_missing_channel_id_errors() {
        let channel = make_channel();
        let metadata = serde_json::json!({
            "event_type": "direct_message",
            "sender_id": "U789",
        });
        let result = channel
            .send_status(
                StatusUpdate::ApprovalNeeded {
                    request_id: "req1".into(),
                    tool_name: "shell".into(),
                    description: "run command".into(),
                    parameters: serde_json::json!({}),
                    allow_always: true,
                },
                &metadata,
            )
            .await;
        assert!(result.is_err());
        let err = result.unwrap_err().to_string();
        assert!(
            err.contains("channel_id"),
            "expected channel_id error, got: {err}"
        );
    }

    #[tokio::test]
    async fn test_send_status_approval_dm_without_sender_id_is_ok() {
        let channel = make_channel();
        let metadata = serde_json::json!({
            "event_type": "direct_message",
            "channel_id": "C456",
        });
        let result = channel
            .send_status(
                StatusUpdate::ApprovalNeeded {
                    request_id: "req1".into(),
                    tool_name: "shell".into(),
                    description: "run command".into(),
                    parameters: serde_json::json!({}),
                    allow_always: true,
                },
                &metadata,
            )
            .await;
        assert!(result.is_err());
        let err = result.unwrap_err().to_string();
        assert!(
            !err.contains("sender_id"),
            "sender_id should not be required anymore, got: {err}"
        );
    }
}