Skip to content

Clarify some points about Tracker Allowlist #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Clarify some points about Tracker Allowlist #121

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a20496e
Combine platform exceptions sections
GuiltyDolphin Nov 22, 2023
33267b8
Add warning about file names
GuiltyDolphin Nov 22, 2023
760ec7f
Add note about tracker allowlist
GuiltyDolphin Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions tracker-radar-tests/TR-domain-matching/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ This folder contains tests for the following features:
- Tracker allowlist feature in the Privacy Configuration - https://app.asana.com/0/1198207348643509/1199981227466169
- Surrogates - https://app.asana.com/0/1198207348643509/1199093921854088/f

⚠️ Please note! There are some similarly-named files in this directory. Please
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd skip that, I don't think there would be any confusion here if people read the whole doc and I hope they will. I agree that files are named in a confusing way, but after reading this doc it should be clear.

refer to the following sections to identify whether the file belongs to the
blocklist tests, or tracker allowlist tests.

## Structure

### Tracker blocking, CNAME cloaking and surrogates
Expand All @@ -28,12 +32,14 @@ Test suite specific fields:

For tests with `expectAction == redirect` to be valid you need to assert either `expectRedirect` and/or `expectExpression` (at least one). The reason we have two different fields is because some platforms (like macOS/iOS) cannot assert against `expectRedirect`.

#### Platform exceptions

- "ports are ignored when matching rules" disabled for Apple platform ([bug report](https://app.asana.com/0/1163321984198618/1201849181617632/f))

### Privacy config allowlist

These tests are intended to check correct behaviour of the Tracker Allowlist,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work summarizing it in an easy and understandable way 👍

which is part of the remote configuration, and can be found in the
[privacy-configuration](https://github.com/duckduckgo/privacy-configuration/blob/main/features/tracker-allowlist.json).
The Tracker Allowlist is intended as a means of quickly mitigating breakage by
disabling blocking of particular request patterns, on one or more sites.

Files in the folder:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hm, this "folder" thing seems to add confusion - should we drop it?

I know you'd like to move things to actual folders to make things more clear but that'd require adjusting all implementations so probably not worth it 💀

- `tracker_allowlist_matching_tests.json` - test for tracker allowlist feature - ⚠️ those tests don't follow the format used by other tests ⚠️
- `tracker_allowlist_tds_references.json` - reference blocklist file that should be used with `tracker_allowlist_matching_tests.json` tests
Expand All @@ -48,3 +54,4 @@ Test suite specific fields:

- android-browser: Blocks when CNAME is same-entity. https://app.asana.com/0/414730916066338/1203532296782616/f
- ios-browser: Exceptions for options2 trackers caused by inability to construct rules from current tds as the last ignore rule invalidates all previous rules. https://app.asana.com/0/1203790657351911/1204149290597759/f; One exception for tracker.test is because Apple platforms are not going to receive any trackers with default action block and options - it is again due to inability to construct rules with the current algorithm. We will follow up in https://app.asana.com/0/1200443608678338/1204431436175798/f; Some exceptions for tests that use request types other than image or stylesheet. Scoped to be fixed: https://app.asana.com/0/0/1204643428963159/f
- "ports are ignored when matching rules" disabled for Apple platform ([bug report](https://app.asana.com/0/1163321984198618/1201849181617632/f))