concord 2.4.7

A terminal user interface client for Discord
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

use serde_json::{Map, Value, json};

use crate::discord::ids::{
    Id,
    marker::{ChannelMarker, MessageMarker},
};
use crate::{AppError, Result};

use super::DiscordRest;

/// `read-states/ack-bulk` accepts at most 100 read states per request.
const ACK_BULK_MAX_TARGETS: usize = 100;

impl DiscordRest {
    /// `token: null` is the legacy anti-spam echo field. Modern clients
    /// always send null.
    pub async fn ack_channel(
        &self,
        channel_id: Id<ChannelMarker>,
        message_id: Id<MessageMarker>,
        flags: Option<u64>,
        last_viewed: u64,
    ) -> Result<()> {
        self.send_unit(
            self.raw_http
                .post(format!(
                    "https://discord.com/api/v9/channels/{}/messages/{}/ack",
                    channel_id.get(),
                    message_id.get()
                ))
                .json(&ack_channel_request_body(flags, last_viewed)),
            "ack channel",
        )
        .await
    }

    pub async fn ack_channels(
        &self,
        targets: &[(Id<ChannelMarker>, Id<MessageMarker>)],
    ) -> Result<()> {
        let mut failures = Vec::new();
        for (index, body) in ack_bulk_request_bodies(targets).into_iter().enumerate() {
            if let Err(error) = self
                .send_unit(
                    self.raw_http
                        .post("https://discord.com/api/v9/read-states/ack-bulk")
                        .json(&body),
                    "ack channels",
                )
                .await
            {
                failures.push(format!("chunk {}: {}", index + 1, error.log_detail()));
            }
        }

        if failures.is_empty() {
            Ok(())
        } else {
            Err(AppError::DiscordRequest(format!(
                "{} read-state acknowledgement chunk(s) failed: {}",
                failures.len(),
                failures.join(", ")
            )))
        }
    }
}

fn ack_channel_request_body(flags: Option<u64>, last_viewed: u64) -> Value {
    let mut body = Map::new();
    body.insert("token".to_owned(), Value::Null);
    body.insert("last_viewed".to_owned(), Value::from(last_viewed));
    if let Some(flags) = flags {
        body.insert("flags".to_owned(), Value::from(flags));
    }
    Value::Object(body)
}

fn ack_bulk_request_bodies(targets: &[(Id<ChannelMarker>, Id<MessageMarker>)]) -> Vec<Value> {
    targets
        .chunks(ACK_BULK_MAX_TARGETS)
        .map(|chunk| {
            let read_states = chunk
                .iter()
                .map(|(channel_id, message_id)| {
                    json!({
                        "read_state_type": 0,
                        "channel_id": channel_id.to_string(),
                        "message_id": message_id.to_string(),
                    })
                })
                .collect::<Vec<_>>();
            json!({ "read_states": read_states })
        })
        .collect()
}

#[cfg(test)]
mod tests {
    use super::{ACK_BULK_MAX_TARGETS, ack_bulk_request_bodies, ack_channel_request_body};
    use crate::discord::ids::{
        Id,
        marker::{ChannelMarker, MessageMarker},
    };
    use serde_json::json;

    #[test]
    fn single_ack_payload_only_includes_known_flags() {
        assert_eq!(
            ack_channel_request_body(Some(3), 4_223),
            json!({
                "token": null,
                "flags": 3,
                "last_viewed": 4_223,
            })
        );
        assert_eq!(
            ack_channel_request_body(None, 4_223),
            json!({
                "token": null,
                "last_viewed": 4_223,
            })
        );
    }

    #[test]
    fn bulk_ack_payloads_chunk_all_targets() {
        let targets = (1..=ACK_BULK_MAX_TARGETS * 2 + 5)
            .map(|value| {
                (
                    Id::<ChannelMarker>::new(value as u64),
                    Id::<MessageMarker>::new((value + 1_000) as u64),
                )
            })
            .collect::<Vec<_>>();

        let bodies = ack_bulk_request_bodies(&targets);

        assert_eq!(bodies.len(), 3);
        assert_eq!(
            bodies[0]["read_states"]
                .as_array()
                .expect("read states should be an array")
                .len(),
            ACK_BULK_MAX_TARGETS
        );
        assert_eq!(
            bodies[2]["read_states"]
                .as_array()
                .expect("read states should be an array")
                .len(),
            5
        );
        assert_eq!(bodies[0]["read_states"][0]["read_state_type"], 0);
        assert_eq!(bodies[0]["read_states"][0]["channel_id"], "1");
        assert_eq!(bodies[0]["read_states"][0]["message_id"], "1001");
    }
}