jmap-base-client 0.4.2

RFC 8620 JMAP base client — auth-agnostic, session fetch, blob, SSE, WebSocket
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

//! Typed DID capability accessors on `Session` and `AccountInfo`
//! (draft-atwood-jmap-did-00 §Capability, jmap-chat-spec
//! draft-atwood-jmap-did-00.md L109-170).
//!
//! Oracle: the Session and account capability examples published in the
//! draft (L126-134 and L155-169), with the RFC 8620 §2 Session and
//! Account members those fragments omit filled in, plus the field
//! definitions quoted per test.

use jmap_base_client::{ClientError, Session};
use jmap_did_types::KeyCustody;
use serde_json::{Value, json};

/// Wraps the draft's `capabilities` and `accounts` fragments in the
/// remaining RFC 8620 §2 Session members, which the fragments omit.
fn session(capabilities: Value, accounts: Value) -> Session {
    serde_json::from_value(json!({
        "capabilities": capabilities,
        "accounts": accounts,
        "primaryAccounts": {},
        "username": "u@example.com",
        "apiUrl": "https://jmap.example.com/api/",
        "downloadUrl": "https://jmap.example.com/dl/{accountId}/{blobId}/{name}?accept={type}",
        "uploadUrl": "https://jmap.example.com/ul/{accountId}/",
        "eventSourceUrl": "https://jmap.example.com/sse/?types={types}&closeafter={closeafter}&ping={ping}",
        "state": "s1"
    }))
    .expect("Session must deserialize")
}

/// draft L126-134 (session-level example) and L155-169 (account-level
/// example); `name`, `isPersonal` and `isReadOnly` are the RFC 8620 §2
/// Account members the draft fragment omits.
fn draft_example_session() -> Session {
    session(
        json!({
            "urn:ietf:params:jmap:core": {},
            "urn:ietf:params:jmap:did": {
                "supportedMethods": ["key", "web"],
                "verificationEndpoint": null
            }
        }),
        json!({
            "acct-001": {
                "name": "acct-001@example.com",
                "isPersonal": true,
                "isReadOnly": false,
                "accountCapabilities": {
                    "urn:ietf:params:jmap:did": {
                        "did": "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK",
                        "didDocumentUri": null,
                        "previousDid": null,
                        "keyCustody": "user"
                    }
                }
            }
        }),
    )
}

// L115: "The value of `capabilities["urn:ietf:params:jmap:did"]` is a JSON
// object"; L130-131: `"supportedMethods": ["key", "web"]`,
// `"verificationEndpoint": null`. L121: "`null` if the server does not
// offer a verification endpoint."
#[test]
fn session_did_capability_parses_draft_example() {
    let cap = draft_example_session()
        .did_capability()
        .expect("well-formed")
        .expect("advertised");
    assert_eq!(cap.supported_methods, ["key", "web"]);
    assert_eq!(cap.verification_endpoint, None);
}

// L139: "The value of `accountCapabilities["urn:ietf:params:jmap:did"]` is
// a JSON object"; values from the L155-169 example.
#[test]
fn account_did_capability_parses_draft_example() {
    let s = draft_example_session();
    let cap = s.accounts["acct-001"]
        .did_capability()
        .expect("well-formed")
        .expect("advertised");
    assert_eq!(
        cap.did,
        "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"
    );
    assert_eq!(cap.did_document_uri, None);
    assert_eq!(cap.previous_did, None);
    // L195 (jmap-chat-spec 33702a5): "`"user"` means the server holds none of them."
    assert_eq!(cap.key_custody, Some(KeyCustody::User));
}

// L111: a server supporting the extension "MUST advertise the
// `urn:ietf:params:jmap:did` capability"; a server that does not support
// it advertises nothing, which is not an error.
#[test]
fn did_capability_absent_is_none() {
    let s = session(
        json!({ "urn:ietf:params:jmap:core": {} }),
        json!({
            "a1": {
                "name": "a1@example.com",
                "isPersonal": true,
                "isReadOnly": false,
                "accountCapabilities": {}
            }
        }),
    );
    assert!(matches!(s.did_capability(), Ok(None)));
    assert!(matches!(s.accounts["a1"].did_capability(), Ok(None)));
}

// L118: "Servers MUST support at least one method."
#[test]
fn session_did_capability_empty_methods_is_parse_error() {
    let s = session(
        json!({
            "urn:ietf:params:jmap:did": {
                "supportedMethods": [],
                "verificationEndpoint": null
            }
        }),
        json!({}),
    );
    assert!(matches!(s.did_capability(), Err(ClientError::Parse(_))));
}

// L141-142: "`did` (String): The DID bound to this account." — required,
// so an account capability without it is malformed.
#[test]
fn account_did_capability_missing_did_is_parse_error() {
    let s = session(
        json!({}),
        json!({
            "a1": {
                "name": "a1@example.com",
                "isPersonal": true,
                "isReadOnly": false,
                "accountCapabilities": {
                    "urn:ietf:params:jmap:did": {
                        "didDocumentUri": null,
                        "previousDid": null,
                        "keyCustody": null
                    }
                }
            }
        }),
    );
    assert!(matches!(
        s.accounts["a1"].did_capability(),
        Err(ClientError::Parse(_))
    ));
}