mara 0.2.0

A high-performance scraper that clears challenges over a rotating pool of egress IPs.
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

//! The leasing surface over the exit pool. "Egress" is the way out to the origin; there is
//! exactly one implementation — [`ExitPool`](crate::pool::ExitPool) — and *direct* (no
//! proxy) is just a pool of one always-ready exit. An worker takes an exclusive [`Lease`],
//! works it, and hands it back with an [`ExitStatus`].

use std::sync::Arc;
use std::time::Duration;

use crate::pool::ExitPool;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Availability {
    Available,
    Resting(Option<Duration>),
}

/// The verdict a worker hands back when it returns a lease. `Ok` = the exit is clean and
/// immediately reusable; `Cooled` = it was just penalized and a cooldown is already recorded
/// in its data (so it stays unleasable until the cooldown expires); `Dead` = it's broken.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ExitStatus {
    Ok,
    Cooled,
    Dead,
}

/// An exclusive hold on one exit. Dropping it without an explicit [`Lease::release`] returns
/// the exit healthy (`ExitStatus::Ok`).
pub struct Lease {
    url: Option<String>,
    code: String,
    pool: Arc<ExitPool>,
    returned: bool,
}

impl Lease {
    pub(crate) fn new(url: Option<String>, code: String, pool: Arc<ExitPool>) -> Lease {
        Lease {
            url,
            code,
            pool,
            returned: false,
        }
    }

    /// The store/exit key: the proxy URL, or `""` for direct.
    pub fn key(&self) -> String {
        self.url.clone().unwrap_or_default()
    }

    pub fn code(&self) -> &str {
        &self.code
    }

    pub fn release(mut self, status: ExitStatus) {
        self.pool.return_lease(&self.code, status);
        self.returned = true;
    }
}

impl Drop for Lease {
    fn drop(&mut self) {
        if !self.returned {
            self.pool.return_lease(&self.code, ExitStatus::Ok);
        }
    }
}