farmap 0.9.1

A library for working with Farcaster label datasets
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

use chrono::Datelike;
use chrono::{Days, Duration, NaiveDate};
use farmap::fid_score_shift::ShiftSource;
use farmap::fid_score_shift::ShiftTarget;
use farmap::spam_score::SpamScore;
use farmap::subset::UsersSubset;
use farmap::user::{User, UserError};
use farmap::user_collection::UserCollection;
use farmap::FidScoreShift;
use std::collections::HashSet;

/// Create n users by incrementing fid and incrementing one day from 20200101, all with spam label
/// one.
fn create_users_with_spam_label_one(n: usize) -> Result<UserCollection, UserError> {
    let start_date = NaiveDate::from_ymd_opt(2020, 1, 1).unwrap();
    let mut users = UserCollection::default();
    let mut date = start_date;
    for i in 0..n {
        let mut user = User::new_without_labels(i);
        user.add_spam_record((SpamScore::One, date)).unwrap();
        let cloned_user = user.clone();
        users
            .add_user(user)
            .map_err(|_| UserError::DifferentFidMerge {
                fid_1: cloned_user.fid(),
                fid_2: cloned_user.fid(),
            })?;
        date = date.checked_add_signed(Duration::days(1)).unwrap();
    }

    Ok(users)
}

#[allow(deprecated)]
fn every_other_user_has_spam_label_one_and_two(n: usize) -> Result<UserCollection, UserError> {
    let start_date = NaiveDate::from_ymd_opt(2020, 1, 1).unwrap();
    let mut users = UserCollection::default();
    let mut date = start_date;

    for i in 0..n {
        date = date.checked_add_signed(Duration::days(1)).unwrap();
        if i % 2 == 0 {
            let mut user = User::new_without_labels(i);
            user.add_spam_record((SpamScore::One, date)).unwrap();
            users.push_with_res(user)?;
        } else {
            let mut user = User::new_without_labels(i);
            user.add_spam_record((SpamScore::Two, date)).unwrap();
            users.push_with_res(user)?;
        }
    }

    Ok(users)
}

/// Create n users by increminting fid and incrementing one day from 20200101, all with spam label
/// one.
fn create_users_with_spam_label_one_then_two(
    n: usize,
    start_date: NaiveDate,
) -> Result<UserCollection, UserError> {
    let start_date =
        NaiveDate::from_ymd_opt(start_date.year(), start_date.month(), start_date.day()).unwrap();
    let mut users = UserCollection::default();
    let mut date = start_date;
    for i in 0..n {
        let mut user = User::new_without_labels(i);
        user.add_spam_record((SpamScore::One, date)).unwrap();
        user.add_spam_record((
            SpamScore::Two,
            date.checked_add_signed(Duration::days(n as i64)).unwrap(),
        ))
        .unwrap();
        users.add_user(user).unwrap();
        date = date.checked_add_signed(Duration::days(1)).unwrap();
    }

    Ok(users)
}

#[test]
fn distribution_should_be_ones() {
    let users = create_users_with_spam_label_one(10).unwrap();
    let subset = UsersSubset::from(&users);
    assert_eq!(subset.user_count(), 10);
    assert_eq!(
        subset.current_spam_score_distribution().unwrap(),
        [0.0, 1.0, 0.0]
    );
}

#[test]
fn distribution_should_be_ones_and_twos() {
    let n: u64 = 2;
    let users = every_other_user_has_spam_label_one_and_two(n as usize).unwrap();
    let subset = UsersSubset::from(&users);
    assert_eq!(subset.user_count(), n as usize);
    assert_eq!(
        subset.current_spam_score_distribution().unwrap(),
        [0.0, 0.5, 0.5]
    );
}

#[test]
fn distribution_should_be_ones_and_twos_with_n_100() {
    let n: u64 = 100;
    let users = every_other_user_has_spam_label_one_and_two(n as usize).unwrap();
    let subset = UsersSubset::from(&users);
    assert_eq!(subset.user_count(), n as usize);
    assert_eq!(
        subset.current_spam_score_distribution().unwrap(),
        [0.0, 0.5, 0.5]
    );
}

#[test]
fn distribution_should_be_ones_and_twos_with_n_5() {
    let n: u64 = 5;
    let users = every_other_user_has_spam_label_one_and_two(n as usize).unwrap();
    let subset = UsersSubset::from(&users);
    assert_eq!(subset.user_count(), n as usize);
    assert_eq!(
        subset.current_spam_score_distribution().unwrap(),
        [0.0, 0.6, 0.4]
    );
}

#[test]
fn distribution_should_be_twos() {
    let n: u64 = 10;
    let start_date = NaiveDate::from_ymd_opt(2020, 1, 1).unwrap();

    let users = create_users_with_spam_label_one_then_two(n as usize, start_date).unwrap();
    let subset = UsersSubset::from(&users);

    assert_eq!(subset.user_count(), n as usize);

    assert_eq!(
        subset.current_spam_score_distribution().unwrap(),
        [0.0, 0.0, 1.0]
    );

    // check that spam record for each fid is stored correctly
    for i in 0..10 {
        let spam_record = subset.user(i).unwrap().all_spam_records_with_opt().unwrap();
        assert_eq!(
            spam_record[0].1,
            NaiveDate::from_ymd_opt(2020, 1, 1)
                .unwrap()
                .checked_add_days(Days::new(i.try_into().unwrap()))
                .unwrap()
        );

        assert_eq!(spam_record[0].0, SpamScore::One);

        assert_eq!(
            spam_record[1].1,
            NaiveDate::from_ymd_opt(2020, 1, 1)
                .unwrap()
                .checked_add_days(Days::new(n + i as u64))
                .unwrap()
        );

        assert_eq!(spam_record[1].0, SpamScore::Two);
    }
}

#[test]
fn fid_shift_test_for_one_then_two_data() {
    let n: u64 = 10;
    let start_date = NaiveDate::from_ymd_opt(2021, 1, 1).unwrap();

    let users = create_users_with_spam_label_one_then_two(n as usize, start_date).unwrap();
    let subset = UsersSubset::from(&users);
    let shifts = subset.spam_changes_with_fid_score_shift(
        NaiveDate::from_ymd_opt(2021, 1, 1)
            .unwrap()
            .checked_add_days(Days::new(n - 1))
            .unwrap(),
        Days::new(0),
    );

    let expected_shift = FidScoreShift::new(ShiftSource::One, ShiftTarget::One, n as usize);
    assert_eq!(shifts[0], expected_shift);
    assert_eq!(shifts.len(), 1);

    let shifts = subset.spam_changes_with_fid_score_shift(
        NaiveDate::from_ymd_opt(2021, 1, 1)
            .unwrap()
            .checked_add_days(Days::new(n - 1))
            .unwrap(),
        Days::new(n),
    );
    let expected_shift = FidScoreShift::new(ShiftSource::One, ShiftTarget::Two, n as usize);
    assert_eq!(expected_shift, shifts[0]);
    //assert_eq!(matrix, [[0, 0, 0], [0, 0, n as usize], [0, 0, 0]]);
}

#[test]
fn shift_struct_should_be_n_in_one_to_one() {
    let n = 10;
    let users = create_users_with_spam_label_one(n).unwrap();
    let subset = UsersSubset::from(&users);
    assert_eq!(
        subset.spam_changes_with_fid_score_shift(
            NaiveDate::from_ymd_opt(2020, 12, 5).unwrap(),
            Days::new(1)
        )[0],
        FidScoreShift::new(ShiftSource::One, ShiftTarget::One, n)
    );
    assert_eq!(
        subset
            .spam_changes_with_fid_score_shift(
                NaiveDate::from_ymd_opt(2020, 12, 5).unwrap(),
                Days::new(1)
            )
            .len(),
        1
    )
}

#[test]
fn test_weekly_spam_score_count() {
    let n = 365;
    let users = create_users_with_spam_label_one(n).unwrap();
    let set = UsersSubset::from(&users);

    let results = set.weekly_spam_score_counts();

    // check that all dates are unique
    let mut uniques = HashSet::<NaiveDate>::new();
    for r in &results {
        uniques.insert(r.date());
    }
    assert_eq!(uniques.len(), results.len());

    //check first date
    assert_eq!(
        results[0].date(),
        NaiveDate::from_ymd_opt(2020, 1, 1).unwrap()
    );

    let mut previous_date: Option<NaiveDate> = None;
    //check that the time between each date expect last is seven days.
    for (i, r) in results.iter().enumerate() {
        if previous_date.is_none() {
            previous_date = Some(r.date());
            continue;
        } else if i == results.len() - 1 {
            assert!(
                r.date()
                    <= previous_date
                        .unwrap()
                        .checked_add_days(Days::new(7))
                        .unwrap(),
            );

            break;
        };

        assert_eq!(
            r.date(),
            previous_date
                .unwrap()
                .checked_add_days(Days::new(7))
                .unwrap()
        );
        previous_date = Some(r.date());
    }
}

#[test]
pub fn update_count_should_be_one_per_day() {
    let n = 365;
    let users = create_users_with_spam_label_one(n).unwrap();
    let set = UsersSubset::from(&users);
    let sum: usize = set.count_updates().values().sum();
    assert_eq!(sum, n);
    assert!(set.count_updates().values().all(|n| *n == 1));
}

#[test]
pub fn fid_score_shift_on() {
    let n = 365;
    let start_date = NaiveDate::from_ymd_opt(2021, 1, 1).unwrap();
    let users = create_users_with_spam_label_one_then_two(n, start_date).unwrap();
    let set = UsersSubset::from(&users);
    let result = set.spam_changes_with_fid_score_shift(
        NaiveDate::from_ymd_opt(2021, 12, 31).unwrap(),
        Days::new(366),
    );
    assert_eq!(result[0].source(), ShiftSource::One);
    assert_eq!(result[0].target(), ShiftTarget::Two);
    assert_eq!(result[0].count(), 365);
}