semiont 0.7.2

Semiont's Rust SDK: the protocol's types, the transport contract and a client of the bus over it, and what a client needs to name its principals and hold its roles, as protocol/specs/ states it.
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
//! What a consumer's tests are built on (`semiont::testing`): a real client
//! and a real session over doubles, and a factory of scripted sessions for a
//! registry. A double answers what a test told it to and refuses the rest by
//! name. It never answers with a value of its own making.

use base64::Engine;
use base64::engine::general_purpose::URL_SAFE_NO_PAD;
use semiont::bus::{Bus, operation};
use semiont::client::{ClientOptions, ClientTiming};
use semiont::errors::{SemiontError, SessionError, SessionErrorCode};
use semiont::session::{
    SessionFactory, SessionFactoryOptions, SessionSignals, StoredSession, store_session,
};
use semiont::state_unit::StateUnit;
use semiont::storage::InMemorySessionStorage;
use semiont::testing::as_id;
use semiont::testing::{
    FaultyTransport, InMemoryContent, ScriptedSessions, StubGateway, TestClientOptions,
    TestSessionOptions, create_test_client, create_test_session,
};
use semiont::transport::{ConnectionState, Content, Transport};
use semiont::types::{
    AnchoredTextAnswer, GatherResourceRequestOptions, HttpEndpoint, HttpEndpointProtocol,
    KbEndpoint, KbTarget, KnowledgeBase, ResourceId, UserResponse,
};
use serde_json::{Value, json};
use std::sync::{Arc, Mutex};
use std::time::Duration;

fn message(error: SemiontError) -> String {
    match error {
        SemiontError::Bus(error) => error.message,
        SemiontError::Transport(error) => error.message,
        SemiontError::Job(error) => error.message,
    }
}

// ── A client ────────────────────────────────────────────────────────────

#[tokio::test(start_paused = true)]
async fn a_test_client_given_nothing_refuses_every_request_by_name() {
    let test = create_test_client(TestClientOptions::default());

    let refused = test
        .client
        .browse
        .kb()
        .await
        .expect_err("nothing was scripted");
    assert!(
        message(refused).contains("No response scripted for bus operation \"browse:kb-requested\""),
    );
    // It was asked: the transport that came back is the client's.
    assert_eq!(test.transport.request_log().len(), 1);
    // A client over a transport with no gateway has neither namespace.
    assert!(test.client.auth.is_none() && test.client.system.is_none());
    // And nothing was stored for it to read.
    let unread = test
        .client
        .browse
        .resource_content(&as_id("res-1"))
        .await
        .expect_err("nothing was stored");
    assert!(message(unread).contains("res-1"));
}

#[tokio::test(start_paused = true)]
async fn a_test_client_is_built_over_what_the_test_gives_it() {
    let transport = FaultyTransport::new(vec![]);
    transport.queue_reply(
        "browse:kb-requested",
        [Some(
            json!({ "name": "A knowledge base", "domain": "example.org" }),
        )],
    );
    let gateway = StubGateway::new();
    let content = InMemoryContent::new();
    let timing = ClientTiming {
        bus_request: Duration::from_secs(3),
        ..ClientTiming::default()
    };

    let test = create_test_client(TestClientOptions {
        transport: Some(transport.clone()),
        content: Some(content.clone()),
        gateway: Some(Arc::new(gateway.clone())),
        client: ClientOptions {
            timing,
            cache_persistence: None,
        },
    });

    let description = test.client.browse.kb().await.expect("it was scripted");
    assert_eq!(description.name, "A knowledge base");
    assert_eq!(transport.request_log().len(), 1);

    // The content is the one given: what the test stored in it is read.
    content.seed(
        &as_id("res-1"),
        Content {
            bytes: bytes::Bytes::from_static(b"hello"),
            content_type: "text/plain".to_owned(),
        },
    );
    assert_eq!(
        test.client
            .browse
            .resource_content(&as_id("res-1"))
            .await
            .expect("it was stored"),
        "hello"
    );

    // The gateway is the one given, and it too answers only what it was told.
    let auth = test.client.auth.as_ref().expect("a gateway was given");
    let refused = auth.me().await.expect_err("nothing was scripted");
    assert!(message(refused).contains("not scripted: get_current_user"));
    assert_eq!(gateway.calls(), ["get_current_user"]);

    // The deadline is the one given: a request nobody answers is given up
    // on after three seconds, not the client's thirty.
    let silent =
        FaultyTransport::answering(vec![semiont::testing::FaultAction::DropReply], |_, _| {
            Ok(None)
        });
    let impatient = create_test_client(TestClientOptions {
        transport: Some(silent),
        client: ClientOptions {
            timing,
            cache_persistence: None,
        },
        ..TestClientOptions::default()
    });
    let started = tokio::time::Instant::now();
    impatient.client.browse.kb().await.expect_err("no answer");
    assert_eq!(started.elapsed(), Duration::from_secs(3));
}

#[tokio::test(start_paused = true)]
async fn an_anchored_text_is_read_from_the_content_as_the_test_seeded_it() {
    let test = create_test_client(TestClientOptions::default());
    let resource: ResourceId = as_id("res-1");

    // One nobody seeded is refused by name, and not answered as unknown.
    let unread = test
        .client
        .browse
        .resource_anchored_text(&resource)
        .await
        .expect_err("nothing was seeded");
    assert!(message(unread).contains("anchored text stored for res-1"));

    for answer in [
        json!({ "kind": "not-yet" }),
        json!({ "kind": "declined", "declined": "no-text-layer" }),
        json!({ "kind": "extracted", "method": "pdf-text-layer", "text": "Hi", "items": [] }),
    ] {
        let seeded: AnchoredTextAnswer = serde_json::from_value(answer).expect("an answer");
        test.content.seed_anchored_text(&resource, seeded.clone());
        let read = test
            .client
            .browse
            .resource_anchored_text(&resource)
            .await
            .expect("it was seeded");
        assert_eq!(read, seeded);
    }

    // It is a read of content: nothing was asked of the bus.
    assert!(test.transport.emitted().is_empty());
}

// ── A session ───────────────────────────────────────────────────────────

#[tokio::test(start_paused = true)]
async fn a_test_session_is_ready_at_once_and_signed_in_as_nobody() {
    let test = create_test_session(TestSessionOptions::default());

    tokio::time::timeout(Duration::from_millis(1), test.session.ready())
        .await
        .expect("it is ready at once");
    assert_eq!(*test.session.token().borrow(), None);
    assert_eq!(*test.session.user().borrow(), None);
    assert_eq!(
        *test.session.kb(),
        KbTarget::http(
            "test-kb",
            "Test KB",
            "localhost",
            4000,
            HttpEndpointProtocol::Http,
        )
    );
    // Its client is the one that came back, over the transport that did.
    assert!(Arc::ptr_eq(test.session.client(), &test.client));
    test.client
        .browse
        .kb()
        .await
        .expect_err("nothing was scripted");
    assert_eq!(test.transport.request_log().len(), 1);
}

#[tokio::test(start_paused = true)]
async fn a_test_session_holds_the_token_its_storage_held_and_then_the_one_the_test_sends() {
    let kb = KbTarget::http(
        "mine",
        "Mine",
        "example.org",
        443,
        HttpEndpointProtocol::Https,
    );
    let storage = Arc::new(InMemorySessionStorage::new());
    let stored = token();
    store_session(
        storage.as_ref(),
        "mine",
        &StoredSession {
            access: stored.clone(),
            refresh: "r".to_owned(),
            client_id: "semiont-cli".to_owned(),
            token_endpoint: "https://issuer.test/token".to_owned(),
            revocation_endpoint: None,
        },
    )
    .expect("stored");

    let test = create_test_session(TestSessionOptions {
        kb: Some(kb.clone()),
        storage: Some(storage.clone()),
        ..TestSessionOptions::default()
    });
    test.session.ready().await;

    assert_eq!(*test.session.kb(), kb);
    assert!(Arc::ptr_eq(&test.storage, &storage));
    assert_eq!(*test.session.token().borrow(), Some(stored));
    // Nobody is asked who it is: no gateway was scripted to say.
    assert_eq!(*test.session.user().borrow(), None);

    test.token.send_replace(Some("another".to_owned()));
    assert_eq!(test.session.token().borrow().as_deref(), Some("another"));

    // The session only uses the client: the test, which built both, closes it.
    test.session.dispose();
    test.client.close().await;
    assert_eq!(*test.transport.state().borrow(), ConnectionState::Closed);
}

// ── Scripted sessions ───────────────────────────────────────────────────

fn alice() -> UserResponse {
    serde_json::from_value(json!({
        "did": "did:web:example.org:users:alice", "email": "alice@example.org",
        "name": "Alice", "image": null, "domain": "example.org",
    }))
    .expect("a user")
}

fn kb(id: &str) -> KnowledgeBase {
    let endpoint = HttpEndpoint::new("localhost", 4000, HttpEndpointProtocol::Http);
    KnowledgeBase {
        id: id.to_owned(),
        label: id.to_owned(),
        did: format!("did:web:example.org:{id}"),
        endpoint: KbEndpoint::HttpEndpoint(endpoint),
        last_read: None,
    }
}

/// A token that is good for an hour.
fn token() -> String {
    let exp = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .expect("after 1970")
        .as_secs()
        + 3600;
    format!(
        "{}.{}.sig",
        URL_SAFE_NO_PAD.encode(r#"{"alg":"none"}"#),
        URL_SAFE_NO_PAD.encode(json!({ "exp": exp }).to_string())
    )
}

struct Asked {
    storage: Arc<InMemorySessionStorage>,
    signals: Arc<SessionSignals>,
    errors: Arc<Mutex<Vec<SessionError>>>,
}

impl Asked {
    fn new() -> Asked {
        Asked {
            storage: Arc::new(InMemorySessionStorage::new()),
            signals: Arc::new(SessionSignals::new()),
            errors: Arc::default(),
        }
    }

    /// What a registry asks a factory with.
    fn of(&self, kb_id: &str) -> SessionFactoryOptions {
        let errors = self.errors.clone();
        SessionFactoryOptions {
            kb: kb(kb_id),
            storage: self.storage.clone(),
            signals: self.signals.clone(),
            on_error: Arc::new(move |error| errors.lock().expect("errors").push(error)),
        }
    }

    fn signed_in(&self, kb_id: &str) {
        store_session(
            self.storage.as_ref(),
            kb_id,
            &StoredSession {
                access: token(),
                refresh: "r".to_owned(),
                client_id: "semiont-browser".to_owned(),
                token_endpoint: "https://issuer.test/token".to_owned(),
                revocation_endpoint: None,
            },
        )
        .expect("stored");
    }

    fn errors(&self) -> Vec<SessionError> {
        self.errors.lock().expect("errors").clone()
    }
}

#[tokio::test(start_paused = true)]
async fn scripted_sessions_answer_what_each_knowledge_base_was_told_to_and_refuse_the_rest_by_name()
{
    let sessions = ScriptedSessions::answering(
        |kb_id, operation, _| match (kb_id, operation) {
            ("kb-a", "browse:kb-requested") => {
                Ok(Some(json!({ "name": "A", "domain": "a.example" })))
            }
            _ => Err(format!("{kb_id} does not answer {operation}")),
        },
        None,
    );
    let asked = Asked::new();
    let of_a = sessions.session(asked.of("kb-a")).expect("a session");
    let of_b = sessions.session(asked.of("kb-b")).expect("a session");
    of_a.ready().await;
    of_b.ready().await;

    assert_eq!(of_a.client().browse.kb().await.expect("scripted").name, "A");
    let refused = of_b.client().browse.kb().await.expect_err("not scripted");
    assert!(message(refused).contains("kb-b does not answer browse:kb-requested"));

    // Each session has a transport of its own, kept by knowledge base.
    assert_eq!(sessions.transports("kb-a").len(), 1);
    assert_eq!(sessions.transports("kb-b").len(), 1);
    assert_eq!(sessions.transports("kb-a")[0].request_log().len(), 1);
    assert_eq!(sessions.transports("kb-c").len(), 0);

    // One built with nothing to answer refuses everything, naming both.
    let silent = ScriptedSessions::new(None);
    let of_c = silent.session(asked.of("kb-c")).expect("a session");
    let refused = of_c.client().browse.kb().await.expect_err("not scripted");
    assert!(
        message(refused).contains(
            "No response scripted for \"browse:kb-requested\" of knowledge base \"kb-c\""
        ),
    );

    // And a refusal a knowledge base was told to give is the one given.
    sessions.refuse_when(|kb_id, operation, _| {
        (kb_id == "kb-a" && operation == "browse:kb-requested")
            .then(|| json!({ "message": "it will not say" }))
    });
    let refused = of_a.client().browse.kb().await.expect_err("refused");
    assert!(message(refused).contains("it will not say"));
}

#[tokio::test(start_paused = true)]
async fn scripted_sessions_say_who_a_token_is_only_when_told_and_after_as_long_as_told() {
    let sessions = ScriptedSessions::new(None);
    let asked = Asked::new();
    asked.signed_in("kb-a");

    // Nobody said who: the session is ready, knows nobody, and says why.
    let unnamed = sessions.session(asked.of("kb-a")).expect("a session");
    unnamed.ready().await;
    assert_eq!(*unnamed.user().borrow(), None);
    let said = asked.errors();
    assert_eq!(said.len(), 1, "{said:?}");
    assert!(
        said[0]
            .message
            .contains("ScriptedSessions: not scripted: who a token of \"kb-a\" is"),
        "{said:?}"
    );

    sessions.says_who(alice());
    sessions.answers_after(Duration::from_secs(2));
    let started = tokio::time::Instant::now();
    let named = sessions.session(asked.of("kb-a")).expect("a session");
    named.ready().await;
    assert_eq!(started.elapsed(), Duration::from_secs(2));
    assert_eq!(*named.user().borrow(), Some(alice()));
}

#[tokio::test(start_paused = true)]
async fn scripted_sessions_renew_as_told_in_order_and_refuse_a_renewal_nobody_scripted() {
    let sessions = ScriptedSessions::new(None);
    sessions.says_who(alice());
    let asked = Asked::new();
    asked.signed_in("kb-a");
    let session = sessions.session(asked.of("kb-a")).expect("a session");
    session.ready().await;
    sessions.queue_renewals([Ok(Some("renewed".to_owned()))]);

    let held = session.token().borrow().clone();
    assert_eq!(
        session.refresh(held.as_deref()).await.as_deref(),
        Some("renewed")
    );
    assert_eq!(sessions.renewed(), 1);
    assert!(asked.signals.session_ended().borrow().is_none());

    // A renewal nobody scripted is a renewal that failed, and says so: the
    // session holds no token, as when its issuer cannot be reached.
    let held = session.token().borrow().clone();
    assert_eq!(session.refresh(held.as_deref()).await, None);
    assert_eq!(sessions.renewed(), 2);
    let said = asked.errors();
    assert!(
        said.iter().any(|error| error
            .message
            .contains("ScriptedSessions: not scripted: a renewal of \"kb-a\"")),
        "{said:?}"
    );
    // Nobody refused it, so the session is not over.
    assert!(asked.signals.session_ended().borrow().is_none());
}

#[tokio::test(start_paused = true)]
async fn scripted_sessions_can_refuse_to_build_and_keep_what_was_revoked() {
    let sessions = ScriptedSessions::new(None);
    let asked = Asked::new();

    sessions.refuse_to_build(Some("this knowledge base cannot be reached"));
    let refused = sessions
        .session(asked.of("kb-a"))
        .err()
        .expect("it refuses");
    assert_eq!(refused.code, SessionErrorCode::ConstructFailed);
    assert_eq!(refused.message, "this knowledge base cannot be reached");
    assert_eq!(refused.kb_id.as_deref(), Some("kb-a"));
    assert!(sessions.transports("kb-a").is_empty());

    sessions.refuse_to_build(None);
    sessions.session(asked.of("kb-a")).expect("a session");
    assert_eq!(sessions.transports("kb-a").len(), 1);

    let stored = StoredSession {
        access: "a".to_owned(),
        refresh: "r".to_owned(),
        client_id: "semiont-browser".to_owned(),
        token_endpoint: "https://issuer.test/token".to_owned(),
        revocation_endpoint: Some("https://issuer.test/revoke".to_owned()),
    };
    sessions.revoke(stored.clone()).await;
    assert_eq!(sessions.revoked(), [stored]);
}

// ── A reply that names what it answers for ──────────────────────────────

/// Three replies carry an id beside their response: the one their request
/// stated, as a gateway's do. So a test queues the response, and the reply is
/// whole.
#[tokio::test(start_paused = true)]
async fn a_reply_that_names_what_it_answers_for_names_what_its_request_named() {
    let test = create_test_client(TestClientOptions::default());
    let gathered = json!({
        "focus": { "kind": "resource", "resource": {
            "@context": "https://schema.org", "@id": "res-1",
            "name": "A resource", "representations": []
        } },
        "graph": { "nodes": [], "edges": [] },
        "metadata": {}
    });

    // A client's own call is answered by what the test queued, with nothing
    // delivered by hand.
    test.transport
        .queue_reply("gather:resource-requested", [Some(gathered.clone())]);
    let context = test
        .client
        .gather
        .resource(&as_id("res-1"), GatherResourceRequestOptions::default())
        .await
        .expect("the queued reply answers it");
    assert_eq!(
        context,
        serde_json::from_value(gathered).expect("a gathered context")
    );

    let bus = Bus::new(Arc::new(test.transport.clone()));
    let within = Duration::from_secs(5);
    let object = |value: Value| value.as_object().cloned().expect("an object");
    for (request, named, asked) in [
        (
            "gather:resource-requested",
            "resourceId",
            json!({ "resourceId": "res-1", "options": {} }),
        ),
        (
            "gather:requested",
            "annotationId",
            json!({ "annotationId": "ann-1", "resourceId": "res-1" }),
        ),
        (
            "match:search-requested",
            "referenceId",
            json!({ "resourceId": "res-1", "referenceId": "ann-1", "context": {} }),
        ),
    ] {
        let op = operation(request).expect("a registry operation");
        let mut replies = test.client.bus().frames(op.result);
        test.transport
            .queue_reply(request, [Some(json!("scripted"))]);
        bus.request_of(op, object(asked.clone()), within)
            .await
            .expect("it was scripted");
        let reply = tokio::time::timeout(Duration::from_millis(1), replies.next())
            .await
            .expect("the reply reached the client's bus")
            .expect("the bus is open")
            .expect("no frame was missed")
            .expect("it is no refusal");
        assert_eq!(
            Value::Object(reply.payload),
            json!({ named: asked[named], "response": "scripted" }),
            "the reply to {request}"
        );
    }

    // A reply that names nothing is its response and no more.
    let read = operation("browse:resource-requested").expect("a registry operation");
    let mut replies = test.client.bus().frames(read.result);
    test.transport
        .queue_reply(read.request, [Some(json!("scripted"))]);
    bus.request_of(read, object(json!({ "resourceId": "res-1" })), within)
        .await
        .expect("it was scripted");
    let reply = tokio::time::timeout(Duration::from_millis(1), replies.next())
        .await
        .expect("the reply reached the client's bus")
        .expect("the bus is open")
        .expect("no frame was missed")
        .expect("it is no refusal");
    assert_eq!(
        Value::Object(reply.payload),
        json!({ "response": "scripted" })
    );

    // A request that does not state what its reply names cannot be answered,
    // and that is said.
    let gather = operation("gather:resource-requested").expect("a registry operation");
    test.transport
        .queue_reply(gather.request, [Some(json!("scripted"))]);
    let unanswerable = bus
        .request_of(gather, object(json!({ "options": {} })), within)
        .await
        .expect_err("the request states no resourceId");
    assert!(
        message(unanswerable)
            .contains("the reply to gather:resource-requested names \"resourceId\""),
    );
}