refactor: parameterize trackerLookup

dbajpeyi · dbajpeyi · commit e7e6721e95ae · 2025-03-05T18:26:27.000+01:00
diff --git a/injected/entry-points/android.js b/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,
diff --git a/injected/entry-points/apple.js b/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,
diff --git a/injected/entry-points/extension-mv3.js b/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$,
diff --git a/injected/entry-points/integration.js b/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,
     });
diff --git a/injected/entry-points/windows.js b/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,
diff --git a/injected/src/content-feature.js b/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
@@ -40,6 +41,9 @@ class ConfigParser {
     /** @type {boolean | undefined} */
     #documentOriginIsTracker;
 
+    /** @type {string} */
+    #injectName;
+
     /**
      * @param {any} name
      */
@@ -53,14 +57,15 @@ class ConfigParser {
     initLoadArgs(loadArgs) {
         const { bundledConfig, site, platform } = loadArgs;
         this.#bundledConfig = bundledConfig;
+        this.#injectName = loadArgs.importConfig.injectName;
         // If we have a bundled config, treat it as a regular config
         // This will be overriden by the remote config if it is available
         if (this.#bundledConfig) {
             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);
     }
 
     /**
@@ -197,6 +202,13 @@ class ConfigParser {
     set documentOriginIsTracker(value) {
         this.#documentOriginIsTracker = value;
     }
+
+    /**
+     * @returns {string}
+     */
+    get injectName() {
+        return this.#injectName;
+    }
 }
 
 export default class ContentFeature extends ConfigParser {
@@ -252,8 +264,7 @@ export default class ContentFeature extends ConfigParser {
      * @return {MessagingContext}
      */
     _createMessagingContext() {
-        const injectName = import.meta.injectName;
-        const contextName = injectName === 'apple-isolated' ? 'contentScopeScriptsIsolated' : 'contentScopeScripts';
+        const contextName = this.injectName === 'apple-isolated' ? 'contentScopeScriptsIsolated' : 'contentScopeScripts';
 
         return new MessagingContext({
             context: contextName,
@@ -432,7 +443,7 @@ export default class ContentFeature extends ConfigParser {
      * @param {import('./wrapper-utils').DefineInterfaceOptions} options
      */
     shimInterface(interfaceName, ImplClass, options) {
-        return shimInterface(interfaceName, ImplClass, options, this.defineProperty.bind(this));
+        return shimInterface(interfaceName, ImplClass, options, this.defineProperty.bind(this), this.injectName);
     }
 
     /**
@@ -447,6 +458,6 @@ export default class ContentFeature extends ConfigParser {
      * @param {boolean} [readOnly] - whether the property should be read-only (default: false)
      */
     shimProperty(instanceHost, instanceProp, implInstance, readOnly = false) {
-        return shimProperty(instanceHost, instanceProp, implInstance, readOnly, this.defineProperty.bind(this));
+        return shimProperty(instanceHost, instanceProp, implInstance, readOnly, this.defineProperty.bind(this), this.injectName);
     }
 }
diff --git a/injected/src/content-scope-features.js b/injected/src/content-scope-features.js
@@ -22,10 +22,8 @@ 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 +37,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];
diff --git a/injected/src/features/element-hiding.js b/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) => {
diff --git a/injected/src/features/navigator-interface.js b/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);
         }
diff --git a/injected/src/features/web-compat.js b/injected/src/features/web-compat.js
@@ -463,7 +463,7 @@ export class WebCompat extends ContentFeature {
 
     mediaSessionFix() {
         try {
-            if (window.navigator.mediaSession && import.meta.injectName !== 'integration') {
+            if (window.navigator.mediaSession && this.injectName !== 'integration') {
                 return;
             }
 
@@ -509,7 +509,7 @@ export class WebCompat extends ContentFeature {
     presentationFix() {
         try {
             // @ts-expect-error due to: Property 'presentation' does not exist on type 'Navigator'
-            if (window.navigator.presentation && import.meta.injectName !== 'integration') {
+            if (window.navigator.presentation && this.injectName !== 'integration') {
                 return;
             }
 
diff --git a/injected/src/utils.js b/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;
diff --git a/injected/src/wrapper-utils.js b/injected/src/wrapper-utils.js
@@ -194,8 +194,8 @@ export function wrapMethod(object, propertyName, wrapperFn, definePropertyFn) {
  * @param {DefineInterfaceOptions} options - options for defining the interface
  * @param {DefinePropertyFn} definePropertyFn - function to use for defining the property
  */
-export function shimInterface(interfaceName, ImplClass, options, definePropertyFn) {
-    if (import.meta.injectName === 'integration') {
+export function shimInterface(interfaceName, ImplClass, options, definePropertyFn, injectName) {
+    if (injectName === 'integration') {
         if (!globalThis.origInterfaceDescriptors) globalThis.origInterfaceDescriptors = {};
         const descriptor = Object.getOwnPropertyDescriptor(globalThis, interfaceName);
         globalThis.origInterfaceDescriptors[interfaceName] = descriptor;
@@ -270,7 +270,7 @@ export function shimInterface(interfaceName, ImplClass, options, definePropertyF
         }
     }
 
-    if (import.meta.injectName === 'integration') {
+    if (injectName === 'integration') {
         // mark the class as a shimmed class
         // we do it only in test mode, to avoid potential side effects in production. See the playwright test in integration-test/test-pages/webcompat/pages/shims.html
         definePropertyFn(ImplClass, ddgShimMark, {
@@ -305,11 +305,11 @@ export function shimInterface(interfaceName, ImplClass, options, definePropertyF
  * @param {boolean} readOnly - whether the property should be read-only
  * @param {DefinePropertyFn} definePropertyFn - function to use for defining the property
  */
-export function shimProperty(baseObject, propertyName, implInstance, readOnly, definePropertyFn) {
+export function shimProperty(baseObject, propertyName, implInstance, readOnly, definePropertyFn, injectName) {
     // @ts-expect-error - implInstance is a class instance
     const ImplClass = implInstance.constructor;
 
-    if (import.meta.injectName === 'integration') {
+    if (injectName === 'integration') {
         if (!globalThis.origPropDescriptors) globalThis.origPropDescriptors = [];
         const descriptor = Object.getOwnPropertyDescriptor(baseObject, propertyName);
         globalThis.origPropDescriptors.push([baseObject, propertyName, descriptor]);
diff --git a/injected/unit-test/wrapper-utils.js b/injected/unit-test/wrapper-utils.js

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@ import { createPageWorldBridge } from './message-bridge/create-page-world-bridge`
`4`	`4`
`5`	`5`	`export default class NavigatorInterface extends ContentFeature {`
`6`	`6`	`load(args) {`
`7`		`- // @ts-expect-error: Accessing private method`
`8`	`7`	`if (this.matchDomainFeatureSetting('privilegedDomains').length) {`
`9`	`8`	`this.injectNavigatorInterface(args);`
`10`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -463,7 +463,7 @@ export class WebCompat extends ContentFeature {`
`463`	`463`
`464`	`464`	`mediaSessionFix() {`
`465`	`465`	`try {`
`466`		`- if (window.navigator.mediaSession && import.meta.injectName !== 'integration') {`
	`466`	`+ if (window.navigator.mediaSession && this.injectName !== 'integration') {`
`467`	`467`	`return;`
`468`	`468`	`}`
`469`	`469`
`@@ -509,7 +509,7 @@ export class WebCompat extends ContentFeature {`
`509`	`509`	`presentationFix() {`
`510`	`510`	`try {`
`511`	`511`	`// @ts-expect-error due to: Property 'presentation' does not exist on type 'Navigator'`
`512`		`- if (window.navigator.presentation && import.meta.injectName !== 'integration') {`
	`512`	`+ if (window.navigator.presentation && this.injectName !== 'integration') {`
`513`	`513`	`return;`
`514`	`514`	`}`
`515`	`515`