adblock-fast: update to 1.2.2-r6

2026-02-27T01:00:05Z

Update adblock-fast from 1.2.1-r7 to 1.2.2-r6. This is a major architectural rewrite that ports the core business logic from a ~2,700-line monolithic shell script (`/etc/init.d/adblock-fast`) to a ~2,850-line ucode module (`/lib/adblock-fast/adblock-fast.uc`), reducing the init script to a thin ~130-line procd wrapper. The rewrite also introduces a comprehensive test suite and adds the AGPL-3.0-or-later LICENSE file. --- - **36 files changed**, +5,787 / -2,836 lines (net +2,951) - **1 commit**: `0263b2b` — `adblock-fast: update to 1.2.2-r6` --- The previous implementation embedded all business logic (download pipeline, domain processing, resolver configuration, status reporting, caching) inside the init.d script as a ~2,700-line POSIX shell script. This made the code difficult to test, maintain, and extend. Shell limitations (no native data structures, reliance on subshell `eval`, global namespace pollution) also introduced fragility and performance overhead from repeated subprocess spawning for UCI/ubus operations. ``` /etc/init.d/adblock-fast (131 lines) — Thin procd wrapper /lib/adblock-fast/adblock-fast.uc (2849 lines) — Core logic (ucode) /lib/adblock-fast/cli.uc (95 lines) — CLI action dispatcher ``` The init script now delegates all operations to the ucode module via: ```sh readonly _ucode="ucode -S -L /lib/${packageName} /lib/${packageName}/cli.uc --" ``` The CLI dispatcher (`cli.uc`) maps init script actions (start, stop, status, allow, check, pause, etc.) to the module's exported functions. The init script retains only procd lifecycle glue (`start_service`, `stop_service`, `service_triggers`, `service_data`) and UCI validation schemas. 1. **Native UCI/ubus bindings** — Direct `cursor()` and `connect()` calls replace subprocess-heavy `uci get/set` and `jsonfilter` pipelines 2. **Proper data structures** — Objects and arrays for config, status tracking, DNS mode definitions; no more string-concatenation state management 3. **Streaming I/O** — 64KB chunked file reads for blocklist processing instead of loading entire files into memory via pipes 4. **Memoized environment detection** — Platform capabilities (installed resolvers, ipset/nftset support, downloader detection) cached on first call 5. **Centralized trigger logic** — Config diff comparison (`adb_config_cache()`) determines download/restart/skip in one place 6. **Testable** — Module exports enable direct unit testing without mocking an entire init system --- - `+ucode` — ucode interpreter runtime - `+ucode-mod-fs` — Filesystem operations (readfile, writefile, popen, stat, etc.) - `+ucode-mod-uci` — Native UCI cursor API - `+ucode-mod-ubus` — Native ubus RPC API - `+jshn` — No longer needed (was used for JSON parsing in shell) - URL updated from `github.com/stangri/adblock-fast/` to `github.com/mossdef-org/adblock-fast/` - Install target now installs `/lib/adblock-fast/adblock-fast.uc` and `/lib/adblock-fast/cli.uc` alongside the init script - Version stamp now patches the ucode module (`version:` field) instead of init script (`PKG_VERSION` variable) - `postinst` script removed (service enable handled elsewhere) - `prerm` script simplified: only purges cache, no longer stops service or removes rc.d symlinks (handled by procd) --- The module supports all existing DNS resolver integrations through a unified `dns_modes{}` configuration map. Each mode defines output file paths, gzip cache names, sed format/parse filters, and grep patterns: | Mode | Output Format | |----------------------|--------------------------------------------------| | `dnsmasq.addnhosts` | `127.0.0.1 domain` (+ `:: domain` with IPv6) | | `dnsmasq.conf` | `local=/domain/` | | `dnsmasq.ipset` | `ipset=/domain/adb` | | `dnsmasq.nftset` | `nftset=/domain/4#inet#fw4#adb4[,6#...]` | | `dnsmasq.servers` | `server=/domain/` (block) / `server=/domain/#` (allow) | | `smartdns.domainset` | Raw domain (with smartdns conf wrapper) | | `smartdns.ipset` | Raw domain (with smartdns ipset conf) | | `smartdns.nftset` | Raw domain (with smartdns nftset conf) | | `unbound.adb_list` | `local-zone: "domain." always_nxdomain` | The download pipeline auto-detects blocklist format from content: | Format | Detection | Example | |--------------|-------------------------------------|----------------------------| | AdBlock Plus | `[Adblock Plus]` header / `^||` | `\|\|example.com^` | | dnsmasq | `^server=` | `server=/example.com/` | | dnsmasq2 | `^local=` | `local=/example.com/` | | dnsmasq3 | `^address=` | `address=/example.com/0.0.0.0` | | hosts | `^0.0.0.0\s` or `^127.0.0.1\s` | `0.0.0.0 example.com` | | domains | (fallback — plain domain list) | `example.com` | ``` For each file_url UCI section: → Download URL (curl with retries, timeout, optional max-file-size) → Auto-detect format → Apply format-specific sed filter → Extract domains → Append to accumulator (blocked or allowed) Merge phase: → sort -u (deduplicate) → Subdomain optimization (awk label-reverse → sort → dedup → reverse) → Remove allowed domains (sed -f generated_script) → Inject canary domains (iCloud Private Relay, Mozilla DoH) → Inject manually blocked_domain entries from config → Format for target DNS resolver → Optional validity check (remove malformed entries) → Atomic rename to output file Resolver phase: → Update resolver config (UCI: addnhosts, conf-dir, server files) → Sanity check (dnsmasq --test) → Restart resolver service → Heartbeat probe (resolve canary domain to verify blocking) → Revert on failure ``` | Function | Purpose | |-----------------------|------------------------------------------------------| | `start(args)` | Main lifecycle: download, restore from cache, or restart | | `stop()` | Disable blocking, flush kernel state, cleanup | | `status_service()` | Report status to syslog/ubus | | `allow(domain)` | Whitelist domain in live blocklist + UCI config | | `check(pattern)` | Search current blocklist for domain | | `check_tld()` | Detect TLD entries (sanity check) | | `check_leading_dot()` | Detect leading-dot errors | | `check_lists(domain)` | Search upstream list URLs for domain | | `dl()` | Force re-download all lists | | `killcache()` | Purge all cached files | | `pause(seconds)` | Temporarily disable blocking | | `show_blocklist()` | Output parsed blocklist to stdout | | `sizes()` | Fetch/display configured blocklist file sizes | | `get_init_status()` | Full service state for UI/RPC clients | | `get_init_list()` | Enabled/disabled status | | `get_platform_support()` | Detect installed resolvers and features | | `get_file_url_filesizes()` | Return cached/live URL metadata | - 40+ localized message codes (e.g., `errorDownloadingList`, `errorConfigValidationFail`, `warningSanityCheckTLD`) - Errors/warnings accumulated in `status_data{}` arrays - Synced atomically to ubus service data for UI consumption - Status states: `statusSuccess`, `statusFail`, `statusDownloading`, `statusProcessing`, `statusRestarting`, `statusPaused` --- The init script (`/etc/init.d/adblock-fast`) is reduced from ~2,700 to ~130 lines. It now serves exclusively as a procd service wrapper: - **procd lifecycle**: `start_service()` calls ucode `start`, captures shell output for `service_data()`; `stop_service()` calls ucode `stop` - **Service triggers**: WAN interface triggers, config change triggers, UCI validation (unchanged from previous version) - **Extra commands**: `allow`, `check`, `check_tld`, `check_leading_dot`, `check_lists`, `dl`, `killcache`, `pause`, `show_blocklist`, `sizes`, `version` — all delegate directly to ucode CLI dispatcher - **procd data bridge**: `emit_procd_shell()` in ucode generates shell statements that the init script `eval`s for `service_data()` and `service_stopped()`/`service_started()` hooks (firewall restart flag) --- The `90-adblock-fast` uci-defaults script is simplified from 181 to 65 lines: - **Removed**: Entire `simple-adblock` migration path (config, cache files, URL lists). This migration was for the initial transition from simple-adblock to adblock-fast and is no longer needed. - **Retained**: List name migration (adds `name` option to `file_url` sections that lack one, using pristine default config as reference), config key renames (`debug` → `debug_init_script`, `proc_debug` → `debug_performance`, `sanity_check` → `dnsmasq_sanity_check`) - **Simplified**: Uses direct `uci` commands instead of sourcing the init script for `uci_get`/`uci_set` helpers. Pristine config lookup now supports both apk (`.apk-new`) and opkg (`-opkg`) package manager conventions. --- A full test suite is added in `net/adblock-fast/tests/` (16 new files, ~1,800 lines) mock-and-expect pattern. - **Module patching**: Converts ES6 imports to CommonJS requires, redirects hardcoded system paths to temp directories for isolation - **Resolver stubs**: Mock binaries for dnsmasq (v2.89), smartdns, unbound, ipset, nft, resolveip - **Test case format**: Markup-based (`-- Testcase --`, `-- Environment --`, `-- Expect stdout --`, `-- File path --`) with support for inline test data and per-test environment overrides - **Assertion model**: Compares stdout, stderr, and exit code against expected values using `diff -u` - **Shell validation**: Syntax-checks init.d and uci-defaults scripts via `sh -n` - **Automatic cleanup**: Trap-based temp directory removal **UCI Mock** (`tests/lib/mocklib/uci.uc`): - Full `cursor()` interface: `load`, `get`, `get_all`, `foreach`, `set`, `delete`, `list_add`, `list_remove`, `commit`, `changes` - Loads JSON fixtures from `tests/mocks/uci/` (adblock-fast, dhcp, network, smartdns, unbound configs) - Supports `@type[index]` extended section addressing **ubus Mock** (`tests/lib/mocklib/ubus.uc`): - `connect()` → `call(object, method, args)` with signature-based fixture lookup - Fixtures in `tests/mocks/ubus/` (system info, network interface dump/status, dnsmasq service list) **System Call Interception** (`tests/lib/mocklib.uc`): - Blocks service operations: `/etc/init.d/*`, `logger`, `sleep`, `dnsmasq --test` - Passes through data processing: `sed`, `sort`, `grep`, `awk` - Fixed timestamp (`1615382640`) for reproducible output - Null `getenv()` for environment isolation **01_pipeline** — Data processing pipeline (9 tests): 1. `01_all_dns_modes` — Verifies all 9 DNS output modes produce valid, deduplicated output (~162-165 domains from 2 input lists) 2. `02_input_format_detection` — Validates auto-detection of domains, hosts, AdBlock Plus, and dnsmasq input formats 3. `03_subdomain_dedup` — Confirms parent domains retained, child subdomains removed (e.g., blocks `example.com`, skips `sub.example.com`) 4. `04_allowed_domains` — Verifies `allowed_domain` config removes domains from output while preserving others 5. `05_canary_domains` — Confirms iCloud Private Relay and Mozilla DoH canary domain injection when enabled 6. `06_servers_mode_allow` — Validates dnsmasq.servers mode prepends explicit allow entries (`server=/domain/#` format) 7. `07_ipv6_addnhosts` — Verifies dual-stack output (both `127.0.0.1` and `::` entries) in addnhosts mode with IPv6 enabled 8. `08_ipv6_nftset` — Confirms nftset mode includes IPv6 set references (`4#inet#fw4#adb4,6#inet#fw4#adb6`) when IPv6 enabled 9. `09_unbound_header` — Validates `server:` header line prepended in unbound output mode **02_config** — Configuration handling (1 test): 1. `01_blocked_domain_injection` — Verifies `blocked_domain` config entries appear in output **03_functional** — CLI command tests (2 tests): 1. `01_check_domain` — Tests `check()` correctly identifies blocked vs. unblocked domains with appropriate output messages 2. `02_show_blocklist` — Tests `show_blocklist()` outputs parsed domain list (162 domains, correct format) 5 curated test data files with ~160+ unique test domains across multiple formats (plain domains, hosts, AdBlock Plus, dnsmasq), including: - Valid tracking/ad domains for positive matching - Overlapping domains across files for deduplication testing - Parent/child domain pairs for subdomain optimization testing - Invalid entries (IPs, malformed, special chars) for filter robustness - Mock UCI/ubus fixtures simulating a standard OpenWrt environment (512MB RAM, WAN interface up, dnsmasq running) --- Adds the full AGPL-3.0-or-later license text (661 lines), matching the `PKG_LICENSE` field already declared in the Makefile. --- - Package compat bumped from `11` to `13` (in the ucode module's `pkg.compat` constant), reflecting the architectural change - All existing UCI configuration options preserved (same validation schema) - All existing extra_commands preserved (same CLI interface) - All existing DNS resolver modes preserved (same output formats) - procd service triggers and config triggers unchanged - `simple-adblock` migration path removed from uci-defaults (obsolete) --- ```sh cd net/adblock-fast/tests && sh run_tests.sh ``` Requires: `ucode`, `ucode-mod-fs`, `ucode-mod-uci`, `ucode-mod-ubus`, `sed`, `sort`, `grep`, `awk` (standard OpenWrt buildroot tools). Signed-off-by: Stan Grishin

packages/net/adblock-fast/tests/data, branch master

adblock-fast: update to 1.2.2-r6