allow non-protection features to survive protections toggle (#1564)

* injected: only call 'load' on enabled features

* prettier stuff

* pr feedback

* remove refactoring mistake

Author: shakyShane

injected/entry-points/android.js

@@ -2,7 +2,7 @@
  * @module Android integration
  */
 import { load, init } from '../src/content-scope-features.js';
-import { processConfig, isGloballyDisabled } from './../src/utils';
+import { processConfig } from './../src/utils';
 import { AndroidMessagingConfig } from '../../messaging/index.js';
 
 function initCode() {
@@ -14,9 +14,6 @@ function initCode() {
     const userPreferences = $USER_PREFERENCES$;
 
     const processedConfig = processConfig(config, userUnprotectedDomains, userPreferences);
-    if (isGloballyDisabled(processedConfig)) {
-        return;
-    }
 
     const configConstruct = processedConfig;
     const messageCallback = configConstruct.messageCallback;

injected/entry-points/apple.js

@@ -2,7 +2,7 @@
  * @module Apple integration
  */
 import { load, init } from '../src/content-scope-features.js';
-import { processConfig, isGloballyDisabled, platformSpecificFeatures } from './../src/utils';
+import { processConfig, platformSpecificFeatures } from './../src/utils';
 import { WebkitMessagingConfig, TestTransportConfig } from '../../messaging/index.js';
 
 function initCode() {
@@ -15,10 +15,6 @@ function initCode() {
 
     const processedConfig = processConfig(config, userUnprotectedDomains, userPreferences, platformSpecificFeatures);
 
-    if (isGloballyDisabled(processedConfig)) {
-        return;
-    }
-
     if (import.meta.injectName === 'apple-isolated') {
         processedConfig.messagingConfig = new WebkitMessagingConfig({
             webkitMessageHandlerNames: ['contentScopeScriptsIsolated'],

injected/entry-points/integration.js

@@ -26,7 +26,14 @@ function generateConfig() {
             domain: topLevelUrl.hostname,
             isBroken: false,
             allowlisted: false,
-            enabledFeatures: ['fingerprintingCanvas', 'fingerprintingScreenSize', 'navigatorInterface', 'cookie'],
+            enabledFeatures: [
+                'fingerprintingCanvas',
+                'fingerprintingScreenSize',
+                'navigatorInterface',
+                'cookie',
+                'webCompat',
+                'apiManipulation',
+            ],
         },
     };
 }

injected/entry-points/windows.js

@@ -2,7 +2,7 @@
  * @module Windows integration
  */
 import { load, init } from '../src/content-scope-features.js';
-import { processConfig, isGloballyDisabled, platformSpecificFeatures } from './../src/utils';
+import { processConfig, platformSpecificFeatures } from './../src/utils';
 import { WindowsMessagingConfig } from '../../messaging/index.js';
 
 function initCode() {
@@ -14,9 +14,7 @@ function initCode() {
     const userPreferences = $USER_PREFERENCES$;
 
     const processedConfig = processConfig(config, userUnprotectedDomains, userPreferences, platformSpecificFeatures);
-    if (isGloballyDisabled(processedConfig)) {
-        return;
-    }
+
     processedConfig.messagingConfig = new WindowsMessagingConfig({
         methods: {
             // @ts-expect-error - Type 'unknown' is not assignable to type...

injected/integration-test/navigator-interface.spec.js

@@ -8,7 +8,7 @@ const test = testContextForExtension(base);
 
 test.describe('Ensure navigator interface is injected', () => {
     test('should expose navigator.navigator.isDuckDuckGo(): Promise<boolean> and platform === "extension"', async ({ page }) => {
-        await gotoAndWait(page, '/blank.html', { platform: { name: 'extension' } });
+        await gotoAndWait(page, '/blank.html');
         const isDuckDuckGoResult = await page.evaluate(() => {
             // @ts-expect-error https://app.asana.com/0/1201614831475344/1203979574128023/f
             const fn = navigator.duckduckgo?.isDuckDuckGo;

injected/integration-test/page-objects/results-collector.js

@@ -297,6 +297,7 @@ export class ResultsCollector {
      */
     static create(page, use) {
         // Read the configuration object to determine which platform we're testing against
+        page.on('console', (msg) => console[msg.type()](msg.text()));
         const { platformInfo, build } = perPlatform(use);
         return new ResultsCollector(page, build, platformInfo);
     }

injected/integration-test/test-pages/api-manipulation/config/apis.json

@@ -1,4 +1,5 @@
 {
+    "unprotectedTemporary": [],
     "features": {
         "apiManipulation": {
             "state": "enabled",

injected/integration-test/utils.spec.js

@@ -8,7 +8,7 @@ const test = testContextForExtension(base);
 
 test.describe('Ensure utils behave as expected', () => {
     test('should toString DDGProxy correctly', async ({ page }) => {
-        await gotoAndWait(page, '/blank.html', { platform: { name: 'extension' } });
+        await gotoAndWait(page, '/blank.html');
         const toStringResult = await page.evaluate('HTMLCanvasElement.prototype.getContext.toString()');
         expect(toStringResult).toEqual('function getContext() { [native code] }');
 

injected/integration-test/web-compat-android.spec.js

@@ -155,7 +155,6 @@ test.describe('Web Share API', () => {
                     const result = await page.evaluate(payload).catch((e) => {
                         return { threw: e };
                     });
-                    console.log('check share', result);
                     const message = await page.evaluate(() => {
                         console.log('did read?');
                         return globalThis.shareReq;

injected/src/content-scope-features.js

@@ -1,4 +1,4 @@
-import { initStringExemptionLists, isFeatureBroken, registerMessageSecret } from './utils';
+import { initStringExemptionLists, isFeatureBroken, isGloballyDisabled, platformSpecificFeatures, registerMessageSecret } from './utils';
 import { platformSupport } from './features';
 import { PerformanceMonitor } from './performance';
 import platformFeatures from 'ddg:platformFeatures';
@@ -41,13 +41,23 @@ export function load(args) {
         injectName: import.meta.injectName,
     };
 
-    const featureNames = typeof importConfig.injectName === 'string' ? platformSupport[importConfig.injectName] : [];
+    const bundledFeatureNames = typeof importConfig.injectName === 'string' ? platformSupport[importConfig.injectName] : [];
 
-    for (const featureName of featureNames) {
-        const ContentFeature = platformFeatures['ddg_feature_' + featureName];
-        const featureInstance = new ContentFeature(featureName, importConfig, args);
-        featureInstance.callLoad();
-        features.push({ featureName, featureInstance });
+    // prettier-ignore
+    const featuresToLoad = isGloballyDisabled(args)
+        // if we're globally disabled, only allow `platformSpecificFeatures`
+        ? platformSpecificFeatures
+        // if available, use `site.enabledFeatures`. The extension doesn't have `site.enabledFeatures` at this
+        // point, which is why we fall back to `bundledFeatureNames`.
+        : args.site.enabledFeatures || bundledFeatureNames;
+
+    for (const featureName of bundledFeatureNames) {
+        if (featuresToLoad.includes(featureName)) {
+            const ContentFeature = platformFeatures['ddg_feature_' + featureName];
+            const featureInstance = new ContentFeature(featureName, importConfig, args);
+            featureInstance.callLoad();
+            features.push({ featureName, featureInstance });
+        }
     }
     mark.end();
 }