adblock 0.8.8

Native Rust module for Adblock Plus syntax (e.g. EasyList, EasyPrivacy) filter parsing and matching.
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

#![cfg(any())] // This attribute disables the entire module
use criterion::*;

use adblock::cosmetic_filter_cache::CosmeticFilterCache;
use adblock::lists::{parse_filters, FilterFormat};

#[path = "../tests/test_utils.rs"]
mod test_utils;
use test_utils::rules_from_lists;

fn by_hostname(c: &mut Criterion) {
    let mut group = c.benchmark_group("cosmetic-hostname-match");

    group.throughput(Throughput::Elements(1));
    group.sample_size(20);

    group.bench_function("easylist", move |b| {
        let rules = rules_from_lists(&["data/easylist.to/easylist/easylist.txt"]);
        let (_, cosmetic_filters) = parse_filters(&rules, false, FilterFormat::Standard);
        let cfcache = CosmeticFilterCache::from_rules(cosmetic_filters);
        b.iter(|| cfcache.hostname_cosmetic_resources("google.com"))
    });
    group.bench_function("many lists", move |b| {
        let rules = rules_from_lists(&[
            "data/easylist.to/easylist/easylist.txt",
            "data/easylist.to/easylistgermany/easylistgermany.txt",
            "data/uBlockOrigin/filters.txt",
            "data/uBlockOrigin/unbreak.txt",
        ]);
        let (_, cosmetic_filters) = parse_filters(&rules, false, FilterFormat::Standard);
        let cfcache = CosmeticFilterCache::from_rules(cosmetic_filters);
        b.iter(|| cfcache.hostname_cosmetic_resources("google.com"))
    });
    group.bench_function("complex_hostname", move |b| {
        let rules = rules_from_lists(&[
            "data/easylist.to/easylist/easylist.txt",
            "data/easylist.to/easylistgermany/easylistgermany.txt",
            "data/uBlockOrigin/filters.txt",
            "data/uBlockOrigin/unbreak.txt",
        ]);
        let (_, cosmetic_filters) = parse_filters(&rules, false, FilterFormat::Standard);
        let cfcache = CosmeticFilterCache::from_rules(cosmetic_filters);
        b.iter(|| cfcache.hostname_cosmetic_resources("ads.serve.1.domain.google.com"))
    });

    group.finish();
}

fn by_classes_ids(c: &mut Criterion) {
    let mut group = c.benchmark_group("cosmetic-class-id-match");

    group.throughput(Throughput::Elements(1));
    group.sample_size(20);

    group.bench_function("easylist", move |b| {
        let rules = rules_from_lists(&["data/easylist.to/easylist/easylist.txt"]);
        let (_, cosmetic_filters) = parse_filters(&rules, false, FilterFormat::Standard);
        let cfcache = CosmeticFilterCache::from_rules(cosmetic_filters);
        let exceptions = Default::default();
        b.iter(|| {
            cfcache.hidden_class_id_selectors(
                &["ad"],
                &["ad"],
                &exceptions,
            )
        })
    });
    group.bench_function("many lists", move |b| {
        let rules = rules_from_lists(&[
            "data/easylist.to/easylist/easylist.txt",
            "data/easylist.to/easylistgermany/easylistgermany.txt",
            "data/uBlockOrigin/filters.txt",
            "data/uBlockOrigin/unbreak.txt",
        ]);
        let (_, cosmetic_filters) = parse_filters(&rules, false, FilterFormat::Standard);
        let cfcache = CosmeticFilterCache::from_rules(cosmetic_filters);
        let exceptions = Default::default();
        b.iter(|| {
            cfcache.hidden_class_id_selectors(
                &["ad"],
                &["ad"],
                &exceptions,
            )
        })
    });
    group.bench_function("many matching classes and ids", move |b| {
        let rules = rules_from_lists(&[
            "data/easylist.to/easylist/easylist.txt",
            "data/easylist.to/easylistgermany/easylistgermany.txt",
            "data/uBlockOrigin/filters.txt",
            "data/uBlockOrigin/unbreak.txt",
        ]);
        let (_, cosmetic_filters) = parse_filters(&rules, false, FilterFormat::Standard);
        let cfcache = CosmeticFilterCache::from_rules(cosmetic_filters);
        let exceptions = Default::default();
        let class_list = [
            "block-bg-advertisement-region-1",
            "photobox-adbox",
            "headerad-720",
            "rscontainer",
            "rail-article-sponsored",
            "fbPhotoSnowboxAds",
            "sidebar_ad_module",
            "ad-728x90_forum",
            "commercial-unit-desktop-rhs",
            "sponsored-editorial",
            "rr-300x600-ad",
            "adfoot",
            "lads",
        ];
        let id_list = [
            "footer-adspace",
            "adsponsored_links_box",
            "lsadvert-top",
            "mn",
            "col-right-ad",
            "view_ads_bottom_bg_middle",
            "ad_468x60",
            "rightAdColumn",
            "content",
            "rhs_block",
            "center_col",
            "header",
            "advertisingModule160x600",
        ];
        b.iter(|| cfcache.hidden_class_id_selectors(&class_list, &id_list, &exceptions))
    });

    group.finish();
}

criterion_group!(cosmetic_benches, by_hostname, by_classes_ids,);
criterion_main!(cosmetic_benches);