mpp 0.15.0

Rust SDK for the Machine Payments Protocol (MPP)
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
//! Behaviour that `Fetch` and `PaymentMiddleware` must share.

use std::sync::atomic::{AtomicU32, Ordering};
use std::sync::{Arc, Mutex};

use axum::body::Body;
use axum::http::header::WWW_AUTHENTICATE;
use axum::http::{Request, StatusCode};
use axum::response::IntoResponse;
use axum::routing::{get, post};
use axum::Router;
use reqwest_middleware::ClientBuilder;
use tokio::net::TcpListener;

use crate::client::{
    AcceptPaymentPolicy, ClientEvents, Fetch, HttpError, PaymentContext, PaymentMiddleware,
    PaymentProvider,
};
use crate::error::MppError;
use crate::protocol::core::{
    format_www_authenticate, Base64UrlJson, PaymentChallenge, PaymentCredential, PaymentPayload,
};

const ACCEPT_PAYMENT: &str = "tempo/charge, tempo/session";

/// The two entry points into the payment flow.
#[derive(Clone, Copy, Debug)]
enum Via {
    Fetch,
    Middleware,
}

const BOTH: [Via; 2] = [Via::Fetch, Via::Middleware];

impl Via {
    async fn send(
        self,
        request: reqwest::RequestBuilder,
        provider: &TestProvider,
        events: ClientEvents,
    ) -> Result<reqwest::Response, HttpError> {
        match self {
            Self::Fetch => {
                request
                    .send_with_payment_options(provider, &AcceptPaymentPolicy::Always, events)
                    .await
            }
            Self::Middleware => {
                let (client, request) = request.build_split();
                ClientBuilder::new(client)
                    .with(PaymentMiddleware::new(provider.clone()).with_events(events))
                    .build()
                    .execute(request.unwrap())
                    .await
                    .map_err(|err| match err {
                        reqwest_middleware::Error::Middleware(err) => err.downcast().unwrap(),
                        reqwest_middleware::Error::Reqwest(err) => HttpError::Request(err),
                    })
            }
        }
    }
}

#[derive(Clone, Default)]
struct TestProvider {
    /// Ask for a fresh challenge the first time one is prepared.
    refresh_first_challenge: bool,
    prepared: Arc<AtomicU32>,
    paid: Arc<Mutex<Vec<String>>>,
    committed: Arc<AtomicU32>,
    rolled_back: Arc<AtomicU32>,
    invalidated: Arc<AtomicU32>,
}

impl TestProvider {
    fn paid(&self) -> Vec<String> {
        self.paid.lock().unwrap().clone()
    }
}

impl PaymentProvider for TestProvider {
    fn supports(&self, method: &str, _intent: &str) -> bool {
        method == "tempo"
    }

    async fn prepare_http_payment_challenge(
        &self,
        challenge: &PaymentChallenge,
        _context: PaymentContext,
    ) -> Result<Option<PaymentChallenge>, MppError> {
        let first = self.prepared.fetch_add(1, Ordering::SeqCst) == 0;
        Ok((!(first && self.refresh_first_challenge)).then(|| challenge.clone()))
    }

    async fn pay(&self, challenge: &PaymentChallenge) -> Result<PaymentCredential, MppError> {
        self.paid.lock().unwrap().push(challenge.id.clone());
        Ok(PaymentCredential::new(
            challenge.to_echo(),
            PaymentPayload::hash("0xproof"),
        ))
    }

    async fn commit_payment(
        &self,
        _: &PaymentChallenge,
        _: &PaymentCredential,
    ) -> Result<(), MppError> {
        self.committed.fetch_add(1, Ordering::SeqCst);
        Ok(())
    }

    async fn rollback_payment(
        &self,
        _: &PaymentChallenge,
        _: &PaymentCredential,
    ) -> Result<(), MppError> {
        self.rolled_back.fetch_add(1, Ordering::SeqCst);
        Ok(())
    }

    async fn invalidate_payment(
        &self,
        _: &PaymentChallenge,
        _: &PaymentCredential,
    ) -> Result<(), MppError> {
        self.invalidated.fetch_add(1, Ordering::SeqCst);
        Ok(())
    }

    fn accept_payment_header(&self) -> Option<String> {
        Some(ACCEPT_PAYMENT.to_owned())
    }
}

fn www_authenticate(id: &str, method: &str, intent: &str) -> String {
    let request = Base64UrlJson::from_value(&serde_json::json!({"amount": "1000"})).unwrap();
    let challenge = PaymentChallenge::new(id, "flow.example.com", method, intent, request);
    format_www_authenticate(&challenge).unwrap()
}

fn payment_required(id: &str, intent: &str) -> axum::response::Response {
    (
        StatusCode::PAYMENT_REQUIRED,
        [(WWW_AUTHENTICATE, www_authenticate(id, "tempo", intent))],
    )
        .into_response()
}

fn is_paid(request: &Request<Body>) -> bool {
    request.headers().contains_key("authorization")
}

async fn spawn_server(app: Router) -> String {
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    tokio::spawn(async move {
        axum::serve(listener, app).await.unwrap();
    });
    format!("http://{addr}")
}

/// A body that cannot be cloned for a retry.
fn streaming_body(content: &'static str) -> reqwest::Body {
    reqwest::Response::from(http_types::Response::new(content)).into()
}

#[tokio::test]
async fn unchallenged_402_after_payment_is_returned() {
    let app = Router::new().route(
        "/paid",
        get(|request: Request<Body>| async move {
            if is_paid(&request) {
                (StatusCode::PAYMENT_REQUIRED, "insufficient-balance").into_response()
            } else {
                payment_required("charge-1", "charge")
            }
        }),
    );
    let url = spawn_server(app).await;

    for via in BOTH {
        let provider = TestProvider::default();
        let request = reqwest::Client::new().get(format!("{url}/paid"));
        let response = via
            .send(request, &provider, ClientEvents::default())
            .await
            .unwrap_or_else(|err| panic!("{via:?}: {err}"));

        assert_eq!(response.status(), StatusCode::PAYMENT_REQUIRED, "{via:?}");
        assert_eq!(response.text().await.unwrap(), "insufficient-balance");
        assert_eq!(provider.paid(), ["charge-1"], "{via:?}");
        assert_eq!(provider.rolled_back.load(Ordering::SeqCst), 1, "{via:?}");
        assert_eq!(provider.committed.load(Ordering::SeqCst), 0, "{via:?}");
    }
}

#[tokio::test]
async fn unpayable_402_after_payment_is_returned() {
    let app = Router::new().route(
        "/paid",
        get(|request: Request<Body>| async move {
            if is_paid(&request) {
                (
                    StatusCode::PAYMENT_REQUIRED,
                    [(
                        WWW_AUTHENTICATE,
                        www_authenticate("stripe-1", "stripe", "charge"),
                    )],
                    "method-unsupported",
                )
                    .into_response()
            } else {
                payment_required("charge-1", "charge")
            }
        }),
    );
    let url = spawn_server(app).await;

    for via in BOTH {
        let provider = TestProvider::default();
        let request = reqwest::Client::new().get(format!("{url}/paid"));
        let response = via
            .send(request, &provider, ClientEvents::default())
            .await
            .unwrap_or_else(|err| panic!("{via:?}: {err}"));

        assert_eq!(response.status(), StatusCode::PAYMENT_REQUIRED, "{via:?}");
        assert_eq!(response.text().await.unwrap(), "method-unsupported");
        assert_eq!(provider.paid(), ["charge-1"], "{via:?}");
        assert_eq!(provider.rolled_back.load(Ordering::SeqCst), 1, "{via:?}");
    }
}

#[tokio::test]
async fn provider_can_ask_for_a_fresh_challenge() {
    for via in BOTH {
        let requests = Arc::new(AtomicU32::new(0));
        let app = Router::new().route(
            "/paid",
            get({
                let requests = requests.clone();
                move |request: Request<Body>| async move {
                    let count = requests.fetch_add(1, Ordering::SeqCst);
                    if is_paid(&request) {
                        StatusCode::OK.into_response()
                    } else if count == 0 {
                        payment_required("before-setup", "charge")
                    } else {
                        payment_required("after-setup", "charge")
                    }
                }
            }),
        );
        let url = spawn_server(app).await;
        let provider = TestProvider {
            refresh_first_challenge: true,
            ..Default::default()
        };

        let request = reqwest::Client::new().get(format!("{url}/paid"));
        let response = via
            .send(request, &provider, ClientEvents::default())
            .await
            .unwrap_or_else(|err| panic!("{via:?}: {err}"));

        assert_eq!(response.status(), StatusCode::OK, "{via:?}");
        assert_eq!(requests.load(Ordering::SeqCst), 3, "{via:?}");
        assert_eq!(provider.paid(), ["after-setup"], "{via:?}");
    }
}

#[tokio::test]
async fn stale_session_is_reopened_once() {
    for via in BOTH {
        let requests = Arc::new(AtomicU32::new(0));
        let app = Router::new().route(
            "/paid",
            get({
                let requests = requests.clone();
                move |request: Request<Body>| async move {
                    match (requests.fetch_add(1, Ordering::SeqCst), is_paid(&request)) {
                        (0 | 2, false) => payment_required("session-1", "session"),
                        (1, true) => StatusCode::GONE.into_response(),
                        (3, true) => StatusCode::OK.into_response(),
                        _ => StatusCode::INTERNAL_SERVER_ERROR.into_response(),
                    }
                }
            }),
        );
        let url = spawn_server(app).await;
        let provider = TestProvider::default();

        let request = reqwest::Client::new().get(format!("{url}/paid"));
        let response = via
            .send(request, &provider, ClientEvents::default())
            .await
            .unwrap_or_else(|err| panic!("{via:?}: {err}"));

        assert_eq!(response.status(), StatusCode::OK, "{via:?}");
        assert_eq!(requests.load(Ordering::SeqCst), 4, "{via:?}");
        assert_eq!(provider.paid().len(), 2, "{via:?}");
        assert_eq!(provider.invalidated.load(Ordering::SeqCst), 1, "{via:?}");
        assert_eq!(provider.committed.load(Ordering::SeqCst), 1, "{via:?}");
        assert_eq!(provider.rolled_back.load(Ordering::SeqCst), 0, "{via:?}");
    }
}

#[tokio::test]
async fn session_that_stays_gone_is_returned() {
    let app = Router::new().route(
        "/paid",
        get(|request: Request<Body>| async move {
            if is_paid(&request) {
                StatusCode::GONE.into_response()
            } else {
                payment_required("session-1", "session")
            }
        }),
    );
    let url = spawn_server(app).await;

    for via in BOTH {
        let provider = TestProvider::default();
        let request = reqwest::Client::new().get(format!("{url}/paid"));
        let response = via
            .send(request, &provider, ClientEvents::default())
            .await
            .unwrap_or_else(|err| panic!("{via:?}: {err}"));

        assert_eq!(response.status(), StatusCode::GONE, "{via:?}");
        assert_eq!(provider.paid().len(), 2, "{via:?}");
        assert_eq!(provider.invalidated.load(Ordering::SeqCst), 2, "{via:?}");
        assert_eq!(provider.rolled_back.load(Ordering::SeqCst), 0, "{via:?}");
    }
}

#[tokio::test]
async fn retries_repeat_accept_payment() {
    for via in BOTH {
        let advertised = Arc::new(Mutex::new(Vec::new()));
        let app = Router::new().route(
            "/paid",
            get({
                let advertised = advertised.clone();
                move |request: Request<Body>| async move {
                    advertised.lock().unwrap().push(
                        request
                            .headers()
                            .get("accept-payment")
                            .map(|value| value.to_str().unwrap().to_owned()),
                    );
                    if is_paid(&request) {
                        StatusCode::OK.into_response()
                    } else {
                        payment_required("charge-1", "charge")
                    }
                }
            }),
        );
        let url = spawn_server(app).await;
        let provider = TestProvider::default();

        let request = reqwest::Client::new().get(format!("{url}/paid"));
        let response = via
            .send(request, &provider, ClientEvents::default())
            .await
            .unwrap_or_else(|err| panic!("{via:?}: {err}"));

        assert_eq!(response.status(), StatusCode::OK, "{via:?}");
        assert_eq!(
            *advertised.lock().unwrap(),
            [
                Some(ACCEPT_PAYMENT.to_owned()),
                Some(ACCEPT_PAYMENT.to_owned())
            ],
            "{via:?}"
        );
    }
}

#[tokio::test]
async fn request_that_cannot_be_cloned_fails_only_when_challenged() {
    let app = Router::new()
        .route("/free", post(|body: String| async move { body }))
        .route(
            "/paid",
            post(|| async { payment_required("charge-1", "charge") }),
        );
    let url = spawn_server(app).await;

    for via in BOTH {
        let provider = TestProvider::default();
        let request = reqwest::Client::new()
            .post(format!("{url}/free"))
            .body(streaming_body("payload"));
        let response = via
            .send(request, &provider, ClientEvents::default())
            .await
            .unwrap_or_else(|err| panic!("{via:?}: {err}"));
        assert_eq!(response.text().await.unwrap(), "payload", "{via:?}");

        let events = ClientEvents::default();
        let failed = Arc::new(AtomicU32::new(0));
        let _subscription = events.on_payment_failed({
            let failed = failed.clone();
            move |_| {
                failed.fetch_add(1, Ordering::SeqCst);
                async {}
            }
        });
        let request = reqwest::Client::new()
            .post(format!("{url}/paid"))
            .body(streaming_body("payload"));
        let err = via.send(request, &provider, events).await.unwrap_err();

        assert!(matches!(err, HttpError::CloneFailed), "{via:?}: {err}");
        assert_eq!(failed.load(Ordering::SeqCst), 1, "{via:?}");
        assert!(provider.paid().is_empty(), "{via:?}");
    }
}