Update @eyeo/webext-sdk dependency to @eyeo/webext-ad-filtering-solution 1.1.1
Background / User story
The engine we're using for blocking ads has made it to version 1.0, which signals its readyness for Manifest v3, while also adopting a new name. Therefore we should upgrade to that version to bring in and benefit from those changes.
See also related AdBlock issue at adblockinc/ext/adblock/adblock#454 (closed).
Dependency changes
- Name: @eyeo/webext-ad-filtering-solution (previously @eyeo/webext-sdk)
- New version: 1.1.1 (incl. 0.11.0, 0.12.0, 0.13.0, 0.13.1, 0.13.2, 1.0.0, 1.1.0)
-
Breaking changes:
- 0.11.0
- Added filter list diff updating for Manifest v3.
- Added
--recommended-subscriptionsCLI argument tosubs-convertfilter generation script. -
eyeo/adblockplus/abc/webext-ad-filtering-solution#524 (closed) -
filters.onChangedalso triggers when filter meta data changed. - eyeo/adblockplus/abc/webext-ad-filtering-solution#528 (closed) - Added filter mapping.
- eyeo/adblockplus/abc/webext-ad-filtering-solution#563 (closed) - Upgraded minimum supported Chromium version for Manifest v3 to 111.
-
https://jira.eyeo.com/browse/EE-13 -
filters.add()enables filter, if it already exists. -
https://jira.eyeo.com/browse/EE-17 -
filters.getMetadatareturnnullinsteda of throwing, if missing meta data.
- 0.13.0
-
https://jira.eyeo.com/browse/EE-138 -
hide-if-classifiessnippet no longer requires a domain.
-
https://jira.eyeo.com/browse/EE-138 -
- 1.0.0
-
https://jira.eyeo.com/browse/EE-85 - Added new
Subscription.downloadStatusvalues:- synchronize_diff_error
- synchronize_diff_too_many_filters
- https://jira.eyeo.com/browse/EE-159 - "alarms" permission required for telemetry request retries, if enabled.
- https://jira.eyeo.com/browse/EE-189 - Renamed package to @eyeo/webext-ad-filtering-solution.
- https://jira.eyeo.com/browse/EE-192 - Filter list generation scripts now require Node 18.
-
https://jira.eyeo.com/browse/EE-85 - Added new
- 1.1.0
- https://jira.eyeo.com/browse/EE-44 - APIs now await storage modifications.
-
https://jira.eyeo.com/browse/EE-220 - Fixed:
Filter.thirdPartyproperty was set incorrectly.
- 0.11.0
-
Other changes:
- 0.11.0
-
eyeo/adblockplus/abc/webext-ad-filtering-solution#188 (closed) - The following functions now accept a single filter text string:
filters.add()filters.disable()filters.enable()filters.remove()
- eyeo/adblockplus/abc/webext-ad-filtering-solution#440 (closed) - Removed requirement for "declarativeNetRequestFeedback" permission for Manifest v3.
- https://jira.eyeo.com/browse/EE-25 - Fixed: CSP filters ignored if no domain in filter text.
-
eyeo/adblockplus/abc/webext-ad-filtering-solution#188 (closed) - The following functions now accept a single filter text string:
- 0.12.0
- https://jira.eyeo.com/browse/EE-157 - Fixed: Subscription properties were not updated under Manifest v3.
- https://jira.eyeo.com/browse/EE-159 - Added support for eyeometry.
- 0.13.0
- https://jira.eyeo.com/browse/EE-167 - Attached optional "expires" property to recommended filter list list.
- 0.13.2
- 1.0.0
-
https://jira.eyeo.com/browse/EE-141 - Fixed: Results returned from
filters.isResourceAllowlisted()andfilters.getAllowingFilters()are now consistent. - https://jira.eyeo.com/browse/EE-153 - Added "firstVersion" and "lastVersion" parameters to filter list diff requests.
- https://jira.eyeo.com/browse/EE-159 - Increased telemetry requests frequency to every 12 hours.
-
https://jira.eyeo.com/browse/EE-159 - Added
telemetry.onError. - https://jira.eyeo.com/browse/EE-185 - Fixed: Element hiding filter hits broke when invalid CSS selector was used (see #1471 (closed)).
- https://jira.eyeo.com/browse/EE-204 - Fixed: Element hiding functionality doesn't work.
-
https://jira.eyeo.com/browse/EE-141 - Fixed: Results returned from
- 1.1.0
- https://jira.eyeo.com/browse/EE-159 - Removed "alarms" permission requirement for optional telemetry functionality.
-
https://jira.eyeo.com/browse/EE-182 - Added support for privileged subscriptions.
- Added
privilegedoption toEWE.filters.add(). - Added
Recommendation.privilegedandSubscription.privilegedproperties.
- Added
- 0.11.0
Integration changes
- Legal: TBD
-
Development:
- 0.11.0
- Reach out to Data team (see contact information in release notes).
Internal ticket: https://jira.eyeo.com/browse/DATA-2256
Ping Data team (see internal channel) when entering feature freeze. -
Follow-up to #1328 (closed): Show "Bundled" text for any bundled filter list that hasn't been updated yet.(see #1472 (closed)) - Remove temporary
filters.getMetadata()workaround from #1421 (closed). - Regenerate rules files and verify that they include "diff_url" property.
- Include
.mapfiles for rules in extension build. - Update minimium supported browser version for Manifest v3:
- Chrome: 111
- Microsoft Edge: 111
- Opera: 97
- Handle filter meta data changes using
filters.onChanged. - Remove "declarativeNetRequestFeedback" permission for Manifest v3.
-
Use(see adblockinc/ext/rules#6)--recommended-subscriptionsCLI argument when callingsubs-convertfilter generation script to generate the recommendation file for use in the extension.
- Reach out to Data team (see contact information in release notes).
- 0.12.0
- Verify that eyeometry is not active by default, and that it's compatible with AMO policies (e.g. "opt-out" Firefox users).
- 0.13.0
- Verify that EWE's telemetry isn't active by default (see https://jira.eyeo.com/browse/EE-159).
- 1.0.0
- Upgrade to Node 18 / npm 9 (incl. @adblockinc/rules).
- Adjust references to files and modules from @eyeo/webext-sdk dependency.
-
Add respective strings for new(see #1553 (closed))Subscription.downloadStatusvalues.
- 0.11.0
Hints for testers
- Increased oldest supported browser versions for Manifest v3 to:
- Chrome: 111
- Microsoft Edge: 111
- Opera: 97
- Verify that the extension behaves correctly under EWE 0.11 with a custom filter with no metadata (see #1421 (closed)).
- Verify that eyeometry is not active.
- This dependency update should fix the problem in #1471 (closed).
- Manifest v3: Filter lists are now downloaded via diff updates. Those will fail if extension build bundles filter list versions that's too outdated (i.e. either too old, or has too many differences to the latest version). Therefore filter list downloads are going to break for any build after some time.
- Manifest v3: Filter lists cannot be updated manually due to https://jira.eyeo.com/browse/EE-212. This will be fixed in #1552 (closed).
Edited by Thomas Greiner