@eyeo/webext-ad-filtering-solution - npm Package Versions

1.16.0

🐱 1.16.0 - 2024-10-10 🐱

General

• Added -p/--pretty-print argument (default: false) to subs-convert script to specify whether generated JSON files should be pretty-printed or minified (EXT-395).
• Ruleset files no longer include "isUrlFilterCaseSensitive": false for filters that don't specify $match-case because it is no longer needed (EXT-383).
• Added 2 more events for smart allowlisting, that are sending the filter with it's metadata (EXT-376):
  • EWE.filters.onRenewed emitted when a smart allowlist filter is extended.
  • EWE.filters.onExpired emitted when a smart allowlist filter has expired.

Updating your code

• If JSON files generated via the subs-convert script should not be minified, pass the -p/--pretty-print argument to the subs-convert script.

1.15.0

🎄 1.15.0 - 2024-10-01 🎄

General

• Add a force flag to EWE.subscriptions.addDefaults(), to allow re-adding the default subscriptions regardless of any current subscriptions or user filters. (EXT-375)
• Now passing web extension id as extension_name CDP phase 3 pings. (EXT-74)

Fixes

• Fix a bug where dynamic rule state was not being properly persisted when a subscription is removed, potentially causing issues if the subscription is readded.

1.14.0

🏇 1.14.0 - 2024-09-26 🏇

General

• Add a type of exported code to the SDK: utilities which can run in any Javascript context. These are exported in the @eyeo/webext-ad-filtering-solution/all/* namespace. See the "Module bundlers" section of the readme for more details. (EXT-121)
  • The Scheduler utility can be used for repeatedly calling functions with a large timeout.
  • The Errors utility has functionality for suppressing communication errors between the background script and pages which may no longer exist.
• Now using the actual timestamp instead of request timestamp for CDP. (EXT-266)
• Now if user was inactive for more than 30 minutes on a website and then became active, we consider it as a new CDP session. (EXT-323)
• Now user cursor move does not extend the CDP session. (EXT-328)
• Now eyeometry request includes UCID (unique client identifier). A new feature flag for it is introduced while staying disabled by default. (EXT-347)

1.13.0

👕 1.13.0 - 2024-09-12 👕

General

• Now tracking all the domains sessions for CDP and apply all the phase 3 logics including domains trimming, splitting and data encryption. A new feature flag for it is introduced while staying disabled by default. (EXT-175)

Fixes

• EWE.filters.getMigrationErrors() and EWE.subscriptions.getMigrationErrors() will now always return a promise that resolves to an array. Previously, if the user had the wrong type in storage, then the wrong type could be returned, which lead to type errors downstream in the extensions. (EXT-118)

1.12.0

🗃 1.12.0 - 2024-08-27 🗃

General

• Now we count Expedia visitors for CDP. (EXT-132)
• Enable using the browser.scripting API for injecting snippets in Firefox MV2 extensions. This allows injecting snippets in pages which set a restrictive content security policy against inline scripts. If the scripting API is not available, the engine will still fallback to the previous approach. This requires adding the scripting permission. The browser.scripting API is not available MV2 for Chromium-based browsers, so this is only needed for Firefox. (CV-3174)

Updating your code

• Add the scripting permission for Firefox MV2 extensions, to allow snippets to be injected using the browser.scripting API. (CV-3174)

1.11.0

:camel: 1.11.0 - 2024-08-08 :camel:

General

• Reverted a new query parameter in downloader. (EE-511, EE-837)

Fixes

• In MV3, use the requestDomains condition in DNR rules for main frames, so that $document filters work correctly together with the $domain filter option. (EXT-55)
• Fixed the CDP sessions counting (now using the correct time frame and deferring the browser events processing until the sessions data is loaded). (EXT-10)
• Fix issue where diff updates in MV3 would sometimes get into a state where diffs would no longer be applied because the system had stored that update had already been applied. The diff update mechanism will now always apply the diff to the base version of the subscription that is bundled with the extension. If the base version cannot be loaded, then the update will fail with a downloadStatus of synchronize_diff_error. (EXT-54)

1.10.0

🙈 1.10.0 - 2024-07-09 🙈

Smart Allowlisting

• Added 2 special optional properties to the filter's metadata. metadata?.expiresAt allows to set an expiration timestamp for the associated filter. (EE-735) metadata?.autoExtendMs used together with metadata?.expiresAt (applicable only to allowlisting filters), this property will automatically extend the filter's expiration time by the specified number of milliseconds if the user visits the associated allowlisted website before filter expiration. (EE-735)

One Click Allowlisting

• Added support for time bound filters added via 1 click allowlisting. Pages can send an additional options object which contains an expiresAt timestamp. The default allowlisting callback will add this as filter metadata, so that the filter will automatically expire. (EE-752)
• Added a new reason invalid_options for AllowlistingAuthorizationError. (EE-752)

General

• Attempting to add a filter that has already been added no longer throws an error. Instead, those filters are ignored and not added again. If the new filter has different metadata from an existing filter, the metadata will not be updated. The error reason storage_duplicate_filters is no longer used. (EE-361)
• User counting telemetry now has an opt-out mechanism. Users are opted out of telemetry by default, to avoid accidentally sending pings for users who have opted out before an extension can set the opt-out status. Set opt-out by calling EWE.telemetry.setOptOut. (EE-579)

Updating your code

• All extensions that provide telemetry credentials to EWE.start should now be calling EWE.telemetry.setOptOut as well to opt users in for sending user counting telemetry. (EE-579)
• If you provide your own 1 click allowlisting callback with EWE.allowlisting.setAllowlistingCallback, then your callback should be updated to accept the new optional options parameter, and add options.expiresAt as metadata on the allowlisting filter it creates. (EE-752)

1.9.0

:nail_care: 1.9.0 - 2024-06-25 :nail_care:

General

• Implemented a new query parameter in downloader to support safe filter lists. (EE-511)

Updating your code

• This change will require rebuilding on the rules list to apply new safe query parameter for easylist.

Fixes

• Fixed failing npm run build -- --force-subscription-update script.
• When updating subscriptions in MV3 (both diff updates and full updates), no longer fail the update if there are invalid filters. Valid filters will now be applied, and the invalid filters will be ignored. (EE-565)
• Fix validation of regex filters in DNR rule conversion. It was previously marking all regexes as valid when using the browser's isRegexSupported function, which would then result in an unexpected error later in the process when trying to add the resulting DNR rules. (EE-565)

1.8.0

🏰 1.8.0 - 2024-06-11 🏰

Fixes

• Now we handle "Failed to fetch subscription content" and eyeometry is started anyway. (EE-556)

CDP

• The CDP feature flag has been removed. It is now enabled by default. See https://gitlab.com/adblockinc/ext/adblockplus/adblockplus/-/issues/1683 for more information on CDP.
• A new property has been added to the argument object passed to EWE.start(). The cdp property is used to specify URLs and credentials for the CDP telemetry server. (EE-473)
• A ping is made to the telemetry server the first time a partner's domain is visited each day, to allow tracking the number of users who visit partners' domains. (EE-474)
• The number of sessions for configured partner's domains is now gathered to be sent to the CDP telemetry server. (EE-473)
• Exported EWE.cdp namespace with onCdpItem dispatcher, setOptOut(), and isOptOut() methods for allowing users to opt out of data collection. (EE-461)
• Firefox users are opted out of CDP by default. Chrome and other browser users are opted in by default. (EE-461)
• Now we count amazon visitors for CDP. (EE-474)
• Now we count yahoo visitors for CDP. (EE-529)
• CDP events performance improvement (debouncing). (EE-473)
• Count only CDP events for outer most frames. (EE-473)

1.7.0

Tag message

🍿 1.7.0 - 2024-05-20 🍿

General

• Restrict the syntax for inline CSS filters to only values known to be safe. Inline CSS filters are still restricted to privileged filter lists, and are still behind a feature flag which disables them by default. (EE-341)
  • Two new reasons have been added for InvalidFilter
    • filter_elemhide_invalid_selector indicates that an element hiding or element hiding emulation filter's selector is invalid. Currently, selectors that begin with an @ are considered invalid.
    • filter_elemhide_invalid_inline_css indicates that the inline CSS is invalid. This could be from using invalid syntax, or by using a CSS value which is not allowed.
  • See the filter syntax spec for details on which values are allowed: https://gitlab.com/eyeo/adblockplus/ad-filtering-working-group/-/blob/da0f0d97a5e7b4717788676c6c0091cdd1ec8bee/filter-syntax.md#element-hiding
• Removed declarativeNetRequest.updateStaticRules checks, since Chrome 124 is the minimum required version for MV3. (!1036)
• We no longer rerun the snippets on History event pushed to prevent performance drop. (EE-507)
• Introduced CDP feature flag and "user opted out" setting (opted out by default). It does not have an effect if turned on. (EE-473)

Fixes

• We now save the sitekeys in browser.storage.local to avoid filling browser.storage.session fully and clean the outdated frames sitekeys early. (EE-64)
• Fixed adding dynamic rules twice after subscription enabling. (EE-428)
• Fixed issue where EWE.filters.validate reported filters as invalid when in fact the filters were just not normalized. (EE-444)