allframe-tauri 0.1.28

Tauri 2.x plugin for AllFrame - Expose handlers via IPC for offline-first desktop apps
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
//! Tauri 2.x plugin for AllFrame
//!
//! Exposes AllFrame Router handlers as Tauri IPC commands for desktop apps.
//! Designed for offline-first deployments where HTTP transport is unnecessary.
//!
//! # Rust (Tauri app)
//!
//! ```rust,ignore
//! use allframe_core::router::Router;
//!
//! fn main() {
//!     let mut router = Router::new();
//!     router.register("get_user", || async {
//!         r#"{"id":1,"name":"Alice"}"#.to_string()
//!     });
//!
//!     tauri::Builder::default()
//!         .plugin(allframe_tauri::init(router))
//!         .run(tauri::generate_context!())
//!         .unwrap();
//! }
//! ```
//!
//! # Frontend (TypeScript)
//!
//! ```text
//! import { invoke } from "@tauri-apps/api/core";
//!
//! // List available handlers
//! const handlers = await invoke("plugin:allframe-tauri|allframe_list");
//!
//! // Call a handler
//! const result = await invoke("plugin:allframe-tauri|allframe_call", {
//!     handler: "get_user",
//!     args: { id: 42 }
//! });
//! ```
//!
//! # In-Process Dispatch (Local LLM / Ollama)
//!
//! `TauriServer` also supports direct in-process calls without Tauri runtime,
//! useful for local LLM integration without opening a network port:
//!
//! ```rust
//! use allframe_core::router::Router;
//! use allframe_tauri::TauriServer;
//!
//! # async fn example() {
//! let mut router = Router::new();
//! router.register("skill", || async { "done".to_string() });
//!
//! let server = TauriServer::new(router);
//! let result = server.call_handler("skill", "{}").await.unwrap();
//! assert_eq!(result.result, "done");
//! # }
//! ```

pub mod boot;
pub mod commands;
pub mod error;
pub mod plugin;
pub mod server;
pub mod types;

pub use allframe_core::router::StreamReceiver;
pub use boot::{BootBuilder, BootContext, BootError, BootProgress};
pub use error::TauriServerError;
pub use plugin::{builder, init, init_with_state, PLUGIN_NAME};
pub use server::TauriServer;
pub use types::{CallResponse, HandlerInfo, HandlerKind, StreamStartResponse};

#[cfg(test)]
mod tests {
    use allframe_core::router::Router;

    use super::*;

    #[test]
    fn test_server_creation() {
        let router = Router::new();
        let server = TauriServer::new(router);
        assert_eq!(server.handler_count(), 0);
    }

    #[test]
    fn test_server_discovers_handlers() {
        let mut router = Router::new();
        router.register("get_user", || async { "User data".to_string() });
        router.register("create_user", || async { "Created".to_string() });
        router.register("delete_user", || async { "Deleted".to_string() });

        let server = TauriServer::new(router);
        assert_eq!(server.handler_count(), 3);
    }

    #[test]
    fn test_handler_info_fields() {
        let mut router = Router::new();
        router.register("my_handler", || async { "result".to_string() });

        let server = TauriServer::new(router);
        let handlers = server.list_handlers();

        assert_eq!(handlers.len(), 1);
        assert_eq!(handlers[0].name, "my_handler");
        assert!(!handlers[0].description.is_empty());
    }

    #[tokio::test]
    async fn test_call_handler_success() {
        let mut router = Router::new();
        router.register("echo", || async { "echoed".to_string() });

        let server = TauriServer::new(router);
        let result = server.call_handler("echo", "{}").await;

        assert!(result.is_ok());
        assert_eq!(result.unwrap().result, "echoed");
    }

    #[tokio::test]
    async fn test_call_handler_not_found() {
        let router = Router::new();
        let server = TauriServer::new(router);

        let result = server.call_handler("missing", "{}").await;
        assert!(result.is_err());

        let err = result.unwrap_err();
        match err {
            TauriServerError::HandlerNotFound(name) => {
                assert_eq!(name, "missing");
            }
            other => panic!("Expected HandlerNotFound, got: {other:?}"),
        }
    }

    #[tokio::test]
    async fn test_multiple_calls() {
        let mut router = Router::new();
        router.register("a", || async { "A".to_string() });
        router.register("b", || async { "B".to_string() });

        let server = TauriServer::new(router);

        let a = server.call_handler("a", "{}").await.unwrap();
        let b = server.call_handler("b", "{}").await.unwrap();

        assert_eq!(a.result, "A");
        assert_eq!(b.result, "B");
    }

    #[tokio::test]
    async fn test_handler_isolation() {
        let mut router = Router::new();
        router.register("x", || async { "X".to_string() });
        router.register("y", || async { "Y".to_string() });

        let server = TauriServer::new(router);

        let _ = server.call_handler("x", "{}").await;
        let y = server.call_handler("y", "{}").await.unwrap();
        assert_eq!(y.result, "Y");
    }

    #[test]
    fn test_empty_router() {
        let router = Router::new();
        let server = TauriServer::new(router);
        assert_eq!(server.handler_count(), 0);
        assert!(server.list_handlers().is_empty());
    }

    #[tokio::test]
    async fn test_list_empty() {
        let router = Router::new();
        let server = TauriServer::new(router);
        assert!(server.list_handlers().is_empty());
    }

    #[test]
    fn test_call_response_serialization() {
        let response = CallResponse {
            result: r#"{"id":1}"#.to_string(),
        };
        let json = serde_json::to_string(&response).unwrap();
        assert!(json.contains("id"));
    }

    #[test]
    fn test_handler_info_serialization() {
        let info = HandlerInfo {
            name: "test".to_string(),
            description: "A test handler".to_string(),
            kind: HandlerKind::RequestResponse,
        };
        let json = serde_json::to_string(&info).unwrap();
        assert!(json.contains("test"));
        assert!(json.contains("A test handler"));
        assert!(json.contains("request_response"));
    }

    #[test]
    fn test_error_serialization() {
        let err = TauriServerError::HandlerNotFound("missing".to_string());
        let json = serde_json::to_string(&err).unwrap();
        assert!(json.contains("missing"));
    }

    #[tokio::test]
    async fn test_typed_args_flow_through_tauri_server() {
        #[derive(serde::Deserialize)]
        struct Input {
            name: String,
        }

        let mut router = Router::new();
        router.register_with_args("greet", |args: Input| async move {
            format!(r#"{{"greeting":"Hello {}"}}"#, args.name)
        });

        let server = TauriServer::new(router);
        let result = server
            .call_handler("greet", r#"{"name":"Alice"}"#)
            .await
            .unwrap();

        assert_eq!(result.result, r#"{"greeting":"Hello Alice"}"#);
    }

    #[tokio::test]
    async fn test_tauri_compat_handler_through_server() {
        use allframe_macros::tauri_compat;

        #[tauri_compat]
        async fn greet(name: String, age: u32) -> String {
            format!(r#"{{"greeting":"Hello {}, age {}"}}"#, name, age)
        }

        let mut router = Router::new();
        router.register_with_args::<GreetArgs, _, _>("greet", greet);

        let server = TauriServer::new(router);
        let result = server
            .call_handler("greet", r#"{"name":"Alice","age":30}"#)
            .await
            .unwrap();

        assert_eq!(result.result, r#"{"greeting":"Hello Alice, age 30"}"#);
    }

    #[tokio::test]
    async fn test_tauri_compat_optional_param() {
        use allframe_macros::tauri_compat;

        #[tauri_compat]
        async fn greet_optional(name: String, title: Option<String>) -> String {
            match title {
                Some(t) => format!("{} {}", t, name),
                None => name,
            }
        }

        let mut router = Router::new();
        router
            .register_with_args::<GreetOptionalArgs, _, _>("greet_optional", greet_optional);

        let server = TauriServer::new(router);

        // With optional param
        let result = server
            .call_handler("greet_optional", r#"{"name":"Alice","title":"Dr."}"#)
            .await
            .unwrap();
        assert_eq!(result.result, "Dr. Alice");

        // Without optional param
        let result = server
            .call_handler("greet_optional", r#"{"name":"Bob"}"#)
            .await
            .unwrap();
        assert_eq!(result.result, "Bob");
    }

    #[tokio::test]
    async fn test_typed_return_struct() {
        #[derive(serde::Serialize)]
        struct UserResponse {
            id: u32,
            name: String,
        }

        let mut router = Router::new();
        router.register_typed("get_user", || async {
            UserResponse {
                id: 1,
                name: "Alice".to_string(),
            }
        });

        let server = TauriServer::new(router);
        let result = server.call_handler("get_user", "{}").await.unwrap();
        assert_eq!(result.result, r#"{"id":1,"name":"Alice"}"#);
    }

    #[tokio::test]
    async fn test_typed_return_with_args() {
        #[derive(serde::Deserialize)]
        struct Input {
            x: i32,
        }

        #[derive(serde::Serialize)]
        struct Output {
            doubled: i32,
        }

        let mut router = Router::new();
        router.register_typed_with_args("double", |args: Input| async move {
            Output { doubled: args.x * 2 }
        });

        let server = TauriServer::new(router);
        let result = server.call_handler("double", r#"{"x":21}"#).await.unwrap();
        assert_eq!(result.result, r#"{"doubled":42}"#);
    }

    #[tokio::test]
    async fn test_result_handler_ok() {
        #[derive(serde::Serialize)]
        struct Data {
            value: i32,
        }

        let mut router = Router::new();
        router.register_result("get_data", || async {
            Ok::<_, String>(Data { value: 42 })
        });

        let server = TauriServer::new(router);
        let result = server.call_handler("get_data", "{}").await.unwrap();
        assert_eq!(result.result, r#"{"value":42}"#);
    }

    #[tokio::test]
    async fn test_result_handler_err() {
        #[derive(serde::Serialize)]
        struct Data {
            value: i32,
        }

        let mut router = Router::new();
        router.register_result("fail", || async {
            Err::<Data, String>("not found".to_string())
        });

        let server = TauriServer::new(router);
        let result = server.call_handler("fail", "{}").await;
        assert!(result.is_err());
    }

    #[tokio::test]
    async fn test_typed_return_with_state() {
        use allframe_core::router::State;
        use std::sync::Arc;

        struct AppState {
            prefix: String,
        }

        #[derive(serde::Deserialize)]
        struct Input {
            name: String,
        }

        #[derive(serde::Serialize)]
        struct Greeting {
            message: String,
        }

        let mut router = Router::new().with_state(AppState {
            prefix: "Hey".to_string(),
        });
        router.register_typed_with_state::<AppState, Input, Greeting, _, _>(
            "greet",
            |state: State<Arc<AppState>>, args: Input| async move {
                Greeting {
                    message: format!("{} {}", state.prefix, args.name),
                }
            },
        );

        let server = TauriServer::new(router);
        let result = server
            .call_handler("greet", r#"{"name":"Dave"}"#)
            .await
            .unwrap();
        assert_eq!(result.result, r#"{"message":"Hey Dave"}"#);
    }

    #[tokio::test]
    async fn test_tauri_compat_no_args() {
        use allframe_macros::tauri_compat;

        #[tauri_compat]
        async fn health_check() -> String {
            "ok".to_string()
        }

        let mut router = Router::new();
        router.register("health_check", health_check);

        let server = TauriServer::new(router);
        let result = server.call_handler("health_check", "{}").await.unwrap();
        assert_eq!(result.result, "ok");
    }

    #[tokio::test]
    async fn test_state_injection_through_tauri_server() {
        use allframe_core::router::State;
        use std::sync::Arc;

        struct AppState {
            prefix: String,
        }

        #[derive(serde::Deserialize)]
        struct Input {
            name: String,
        }

        let mut router = Router::new().with_state(AppState {
            prefix: "Hey".to_string(),
        });
        router.register_with_state::<AppState, Input, _, _>(
            "greet",
            |state: State<Arc<AppState>>, args: Input| async move {
                format!("{} {}", state.prefix, args.name)
            },
        );

        let server = TauriServer::new(router);
        let result = server
            .call_handler("greet", r#"{"name":"Bob"}"#)
            .await
            .unwrap();

        assert_eq!(result.result, "Hey Bob");
    }

    #[tokio::test]
    async fn test_tauri_compat_streaming_with_args() {
        use allframe_core::router::StreamSender;
        use allframe_macros::tauri_compat;

        #[tauri_compat(streaming)]
        async fn stream_greet(name: String, count: u32, tx: StreamSender) -> String {
            for i in 0..count {
                tx.send(format!("Hello {} #{}", name, i)).await.ok();
            }
            "done".to_string()
        }

        let mut router = Router::new();
        router.register_streaming_with_args::<StreamGreetArgs, _, _, _>(
            "stream_greet",
            stream_greet,
        );

        let server = TauriServer::new(router);
        let (mut rx, handle) = server
            .call_streaming_handler("stream_greet", r#"{"name":"Alice","count":2}"#)
            .unwrap();

        let msg1 = rx.recv().await.unwrap();
        assert_eq!(msg1, "Hello Alice #0");
        let msg2 = rx.recv().await.unwrap();
        assert_eq!(msg2, "Hello Alice #1");

        let response = handle.await.unwrap().unwrap();
        assert_eq!(response.result, "done");
    }

    /// Tests the inject_state path that the Tauri plugin uses to inject AppHandle.
    /// We simulate it with a plain struct since we can't construct AppHandle in tests.
    #[tokio::test]
    async fn test_inject_state_simulates_app_handle_injection() {
        use allframe_core::router::State;
        use std::sync::Arc;

        // Simulates what plugin::init does: inject_state after router construction
        struct FakeAppHandle {
            app_name: String,
        }
        struct DbPool {
            url: String,
        }

        let mut router = Router::new().with_state(DbPool {
            url: "sqlite://db".to_string(),
        });

        // Register handler that needs the "app handle"
        router.register_with_state_only::<FakeAppHandle, _, _>(
            "emit_event",
            |app: State<Arc<FakeAppHandle>>| async move {
                format!("emitted from {}", app.app_name)
            },
        );

        // Register handler that needs the db pool
        router.register_with_state_only::<DbPool, _, _>(
            "db_url",
            |db: State<Arc<DbPool>>| async move { db.url.clone() },
        );

        // Simulate what the plugin setup closure does
        router.inject_state(FakeAppHandle {
            app_name: "MyTauriApp".to_string(),
        });

        let server = TauriServer::new(router);

        let result = server.call_handler("emit_event", "{}").await.unwrap();
        assert_eq!(result.result, "emitted from MyTauriApp");

        let result = server.call_handler("db_url", "{}").await.unwrap();
        assert_eq!(result.result, "sqlite://db");
    }

    #[tokio::test]
    async fn test_tauri_compat_streaming_no_args() {
        use allframe_core::router::StreamSender;
        use allframe_macros::tauri_compat;

        #[tauri_compat(streaming)]
        async fn stream_ping(tx: StreamSender) -> String {
            tx.send("pong".to_string()).await.ok();
            "done".to_string()
        }

        let mut router = Router::new();
        router.register_streaming("stream_ping", stream_ping);

        let server = TauriServer::new(router);
        let (mut rx, handle) = server
            .call_streaming_handler("stream_ping", "{}")
            .unwrap();

        let msg = rx.recv().await.unwrap();
        assert_eq!(msg, "pong");

        let response = handle.await.unwrap().unwrap();
        assert_eq!(response.result, "done");
    }
}