autumn-plugin-shopify 0.2.0

Autumn plugin: Shopify apps — signed webhooks routed by topic, OAuth install with expiring tokens, and a throttle-aware Admin GraphQL client.
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

//! Token store tests.

#![allow(clippy::expect_used)]

use super::*;

fn shop(name: &str) -> ShopDomain {
    ShopDomain::parse(&format!("{name}.myshopify.com")).expect("valid shop")
}

fn expiring(expires_at: i64, refresh_expires_at: i64) -> ShopToken {
    ShopToken::non_expiring("shpat_a", "read_orders,write_products").with_refresh(
        expires_at,
        "shprt_r",
        Some(refresh_expires_at),
    )
}

#[test]
fn non_expiring_tokens_never_need_refresh() {
    let token = ShopToken::non_expiring("shpat_a", "read_orders");
    assert!(!token.needs_refresh(i64::MAX - 100, 60));
    assert!(!token.can_refresh(0));
}

#[test]
fn needs_refresh_uses_the_margin() {
    let token = expiring(1_000, 10_000);
    assert!(!token.needs_refresh(939, 60));
    assert!(token.needs_refresh(940, 60));
    assert!(token.needs_refresh(2_000, 60));
}

#[test]
fn can_refresh_checks_refresh_expiry() {
    let token = expiring(1_000, 10_000);
    assert!(token.can_refresh(9_999));
    assert!(!token.can_refresh(10_000));
    let mut no_expiry = token.clone();
    no_expiry.refresh_token_expires_at = None;
    assert!(no_expiry.can_refresh(i64::MAX));
    let mut no_refresh = token;
    no_refresh.refresh_token = None;
    assert!(!no_refresh.can_refresh(0));
}

#[test]
fn is_expired_uses_the_expiry_time() {
    let token = expiring(1_000, 10_000);
    assert!(!token.is_expired(999));
    assert!(token.is_expired(1_000));
    assert!(!ShopToken::non_expiring("t", "s").is_expired(i64::MAX));
}

#[test]
fn old_records_without_installed_at_still_parse() {
    let json = r#"{"access_token":"t","scope":"s","expires_at":null,"refresh_token":null,"refresh_token_expires_at":null}"#;
    let token: ShopToken = serde_json::from_str(json).expect("parses");
    assert_eq!(token.installed_at, None);
    assert_eq!(token.with_installed_at(5).installed_at, Some(5));
}

#[test]
fn scopes_split_on_commas() {
    let token = ShopToken::non_expiring("t", "read_orders, write_products,,");
    assert_eq!(token.scopes(), vec!["read_orders", "write_products"]);
}

#[test]
fn debug_redacts_tokens() {
    let debug = format!("{:?}", expiring(1, 2));
    assert!(!debug.contains("shpat_a"), "{debug}");
    assert!(!debug.contains("shprt_r"), "{debug}");
}

#[test]
fn tokens_round_trip_through_serde() {
    let token = expiring(1, 2);
    let json = serde_json::to_string(&token).expect("serializes");
    let back: ShopToken = serde_json::from_str(&json).expect("parses");
    assert_eq!(back, token);
}

#[tokio::test]
async fn in_memory_store_puts_gets_and_deletes() {
    let store = InMemoryTokenStore::new();
    let a = shop("a");
    let b = shop("b");
    assert!(store.is_empty().expect("is_empty"));
    assert!(store.get(&a).await.expect("get").is_none());

    store
        .put(&a, ShopToken::non_expiring("one", "read_orders"))
        .await
        .expect("put");
    store
        .put(&a, ShopToken::non_expiring("two", "read_orders"))
        .await
        .expect("replace");
    store
        .put(&b, ShopToken::non_expiring("three", "read_orders"))
        .await
        .expect("put");
    assert_eq!(store.len().expect("len"), 2);
    assert_eq!(
        store
            .get(&a)
            .await
            .expect("get")
            .expect("present")
            .access_token,
        "two"
    );

    store.delete(&a).await.expect("delete");
    store.delete(&a).await.expect("delete twice is fine");
    assert!(store.get(&a).await.expect("get").is_none());
    assert_eq!(store.len().expect("len"), 1);
}