refactor: parameterize trackerLookup

Author: dbajpeyi

injected/entry-points/android.js

@@ -3,7 +3,6 @@
  */
 import { load, init } from '../src/content-scope-features.js';
 import { processConfig, isGloballyDisabled } from './../src/utils';
-import { isTrackerOrigin } from '../src/trackers';
 import { AndroidMessagingConfig } from '../../messaging/index.js';
 
 function initCode() {
@@ -31,10 +30,14 @@ function initCode() {
         debug: processedConfig.debug,
     });
 
+    const importConfig = {
+        trackerLookup: import.meta.trackerLookup,
+        injectName: import.meta.injectName,
+    };
+
     load({
         platform: processedConfig.platform,
-        trackerLookup: processedConfig.trackerLookup,
-        documentOriginIsTracker: isTrackerOrigin(processedConfig.trackerLookup),
+        importConfig,
         site: processedConfig.site,
         bundledConfig: processedConfig.bundledConfig,
         messagingConfig: processedConfig.messagingConfig,

injected/entry-points/apple.js

@@ -3,7 +3,6 @@
  */
 import { load, init } from '../src/content-scope-features.js';
 import { processConfig, isGloballyDisabled, platformSpecificFeatures } from './../src/utils';
-import { isTrackerOrigin } from '../src/trackers';
 import { WebkitMessagingConfig, TestTransportConfig } from '../../messaging/index.js';
 
 function initCode() {
@@ -42,10 +41,14 @@ function initCode() {
         });
     }
 
+    const importConfig = {
+        trackerLookup: import.meta.trackerLookup,
+        injectName: import.meta.injectName,
+    };
+
     load({
         platform: processedConfig.platform,
-        trackerLookup: processedConfig.trackerLookup,
-        documentOriginIsTracker: isTrackerOrigin(processedConfig.trackerLookup),
+        importConfig,
         site: processedConfig.site,
         bundledConfig: processedConfig.bundledConfig,
         messagingConfig: processedConfig.messagingConfig,

injected/entry-points/extension-mv3.js

@@ -2,19 +2,20 @@
  * @module main world integration for Chrome MV3 and Firefox (enhanced) MV2
  */
 import { load, init, update } from '../src/content-scope-features.js';
-import { isTrackerOrigin } from '../src/trackers.js';
 import { computeLimitedSiteObject } from '../src/utils.js';
 
 const secret = (crypto.getRandomValues(new Uint32Array(1))[0] / 2 ** 32).toString().replace('0.', '');
 
-const trackerLookup = import.meta.trackerLookup;
+const importConfig = {
+    trackerLookup: import.meta.trackerLookup,
+    injectName: import.meta.injectName,
+};
 
 load({
     platform: {
         name: 'extension',
     },
-    trackerLookup,
-    documentOriginIsTracker: isTrackerOrigin(trackerLookup),
+    importConfig,
     site: computeLimitedSiteObject(),
     // @ts-expect-error https://app.asana.com/0/1201614831475344/1203979574128023/f
     bundledConfig: $BUNDLED_CONFIG$,

injected/entry-points/integration.js

@@ -1,5 +1,4 @@
 import { load, init } from '../src/content-scope-features.js';
-import { isTrackerOrigin } from '../src/trackers';
 import { TestTransportConfig } from '../../messaging/index.js';
 function getTopLevelURL() {
     try {
@@ -84,11 +83,16 @@ async function initCode() {
             };
         },
     });
+
+    const importConfig = {
+        trackerLookup: processedConfig.trackerLookup,
+        injectName: import.meta.injectName,
+    };
+
     load({
         // @ts-expect-error Types of property 'name' are incompatible.
         platform: processedConfig.platform,
-        trackerLookup: processedConfig.trackerLookup,
-        documentOriginIsTracker: isTrackerOrigin(processedConfig.trackerLookup),
+        importConfig,
         site: processedConfig.site,
         messagingConfig: processedConfig.messagingConfig,
     });

injected/entry-points/windows.js

@@ -3,7 +3,6 @@
  */
 import { load, init } from '../src/content-scope-features.js';
 import { processConfig, isGloballyDisabled, platformSpecificFeatures } from './../src/utils';
-import { isTrackerOrigin } from '../src/trackers';
 import { WindowsMessagingConfig } from '../../messaging/index.js';
 
 function initCode() {
@@ -29,10 +28,14 @@ function initCode() {
         },
     });
 
+    const importConfig = {
+        trackerLookup: processedConfig.trackerLookup,
+        injectName: import.meta.injectName,
+    };
+
     load({
         platform: processedConfig.platform,
-        trackerLookup: processedConfig.trackerLookup,
-        documentOriginIsTracker: isTrackerOrigin(processedConfig.trackerLookup),
+        importConfig,
         site: processedConfig.site,
         bundledConfig: processedConfig.bundledConfig,
         messagingConfig: processedConfig.messagingConfig,

injected/src/content-feature.js

@@ -6,6 +6,7 @@ import { defineProperty, shimInterface, shimProperty, wrapMethod, wrapProperty,
 import { Proxy, Reflect } from './captured-globals.js';
 import { Messaging, MessagingContext } from '../../messaging/index.js';
 import { extensionConstructMessagingConfig } from './sendmessage-transport.js';
+import { isTrackerOrigin } from './trackers.js';
 
 /**
  * @typedef {object} AssetConfig
@@ -59,8 +60,8 @@ class ConfigParser {
             const enabledFeatures = computeEnabledFeatures(bundledConfig, site.domain, platform.version);
             this.#featureSettings = parseFeatureSettings(bundledConfig, enabledFeatures);
         }
-        this.#trackerLookup = loadArgs.trackerLookup;
-        this.#documentOriginIsTracker = loadArgs.documentOriginIsTracker;
+        this.#trackerLookup = loadArgs.importConfig.trackerLookup;
+        this.#documentOriginIsTracker = isTrackerOrigin(this.#trackerLookup);
     }
 
     /**

injected/src/content-scope-features.js

@@ -22,10 +22,9 @@ const isHTMLDocument =
  * @typedef {object} LoadArgs
  * @property {import('./content-feature').Site} site
  * @property {import('./utils.js').Platform} platform
- * @property {boolean} documentOriginIsTracker
  * @property {import('./utils.js').RemoteConfig} bundledConfig
  * @property {string} [injectName]
- * @property {object} trackerLookup - provided currently only by the extension
+ * @property {object} importConfig - contains trackerLookup and injectName, trackerLookup is provided currently only by the extension
  * @property {import('@duckduckgo/messaging').MessagingConfig} [messagingConfig]
  * @property {string} [messageSecret] - optional, used in the messageBridge creation
  */
@@ -39,7 +38,7 @@ export function load(args) {
         return;
     }
 
-    const featureNames = typeof import.meta.injectName === 'string' ? platformSupport[import.meta.injectName] : [];
+    const featureNames = typeof args.importConfig.injectName === 'string' ? platformSupport[args.importConfig.injectName] : [];
 
     for (const featureName of featureNames) {
         const ContentFeature = platformFeatures['ddg_feature_' + featureName];

injected/src/features/element-hiding.js

@@ -320,12 +320,10 @@ export default class ElementHiding extends ContentFeature {
 
         // determine whether strict hide rules should be injected as a style tag
         if (shouldInjectStyleTag) {
-            // @ts-expect-error: Accessing private method
             shouldInjectStyleTag = this.matchDomainFeatureSetting('styleTagExceptions').length === 0;
         }
 
         // collect all matching rules for domain
-        // @ts-expect-error: Accessing private method
         const activeDomainRules = this.matchDomainFeatureSetting('domains').flatMap((item) => item.rules);
 
         const overrideRules = activeDomainRules.filter((rule) => {

injected/src/features/navigator-interface.js

@@ -4,7 +4,6 @@ import { createPageWorldBridge } from './message-bridge/create-page-world-bridge
 
 export default class NavigatorInterface extends ContentFeature {
     load(args) {
-        // @ts-expect-error: Accessing private method
         if (this.matchDomainFeatureSetting('privilegedDomains').length) {
             this.injectNavigatorInterface(args);
         }

injected/src/utils.js

@@ -642,7 +642,6 @@ export function processConfig(data, userList, preferences, platformSpecificFeatu
 
     // Copy feature settings from remote config to preferences object
     output.featureSettings = parseFeatureSettings(data, enabledFeatures);
-    output.trackerLookup = import.meta.trackerLookup;
     output.bundledConfig = data;
 
     return output;