Add additionalCheck for android rollout (#1908)

* Add additionalCheck for android rollout

* Add test case

* Simplify test case

* Lint fix

* Continue in the loop instead of return

Author: jonathanKingston

injected/docs/features-guide.md

@@ -8,10 +8,12 @@ Features are files stored in the `features/` directory that must include an `ini
 
 The [ConfigFeature](https://github.com/duckduckgo/content-scope-scripts/blob/main/injected/src/config-feature.js) class is extended by each feature to implement remote config handling. It provides the following methods:
 
-### `getFeatureSettingEnabled()`
+### `getFeatureSettingEnabled(settingKeyName)`
 
 For simple boolean settings, returns `true` if the setting is 'enabled'
 
+For default Enabled use: `this.getFeatureSettingEnabled(settingKeyName, 'enabled')`
+
 ### `getFeatureSetting()`
 
 Returns a specific setting from the feature settings

injected/src/config-feature.js

@@ -325,11 +325,12 @@ export default class ConfigFeature {
      * ```
      * This also supports domain overrides as per `getFeatureSetting`.
      * @param {string} featureKeyName
+     * @param {'enabled' | 'disabled'} [defaultState]
      * @param {string} [featureName]
      * @returns {boolean}
      */
-    getFeatureSettingEnabled(featureKeyName, featureName) {
-        const result = this.getFeatureSetting(featureKeyName, featureName);
+    getFeatureSettingEnabled(featureKeyName, defaultState, featureName) {
+        const result = this.getFeatureSetting(featureKeyName, featureName) || defaultState;
         if (typeof result === 'object') {
             return result.state === 'enabled';
         }

injected/src/content-scope-features.js

@@ -56,6 +56,10 @@ export function load(args) {
         if (featuresToLoad.includes(featureName)) {
             const ContentFeature = platformFeatures['ddg_feature_' + featureName];
             const featureInstance = new ContentFeature(featureName, importConfig, args);
+            // Short term fix to disable the feature whilst we roll out Android adsjs
+            if (!featureInstance.getFeatureSettingEnabled('additionalCheck', 'enabled')) {
+                continue;
+            }
             featureInstance.callLoad();
             features.push({ featureName, featureInstance });
         }
@@ -74,6 +78,10 @@ export async function init(args) {
     const resolvedFeatures = await Promise.all(features);
     resolvedFeatures.forEach(({ featureInstance, featureName }) => {
         if (!isFeatureBroken(args, featureName) || alwaysInitExtensionFeatures(args, featureName)) {
+            // Short term fix to disable the feature whilst we roll out Android adsjs
+            if (!featureInstance.getFeatureSettingEnabled('additionalCheck', 'enabled')) {
+                return;
+            }
             featureInstance.callInit(args);
             // Either listenForUrlChanges or urlChanged ensures the feature listens.
             if (featureInstance.listenForUrlChanges || featureInstance.urlChanged) {

injected/unit-test/content-feature.js

@@ -11,9 +11,13 @@ describe('ContentFeature class', () => {
                 expect(this.getFeatureSetting('arrayTest')).toBe('enabledArray');
                 // Following key doesn't exist so it should return false
                 expect(this.getFeatureSettingEnabled('someNonExistantKey')).toBe(false);
+                expect(this.getFeatureSettingEnabled('someNonExistantKey', 'enabled')).toBe(true);
+                expect(this.getFeatureSettingEnabled('someNonExistantKey', 'disabled')).toBe(false);
                 expect(this.getFeatureSettingEnabled('disabledStatus')).toBe(false);
                 expect(this.getFeatureSettingEnabled('internalStatus')).toBe(false);
                 expect(this.getFeatureSettingEnabled('enabledStatus')).toBe(true);
+                expect(this.getFeatureSettingEnabled('enabledStatus', 'enabled')).toBe(true);
+                expect(this.getFeatureSettingEnabled('enabledStatus', 'disabled')).toBe(true);
                 expect(this.getFeatureSettingEnabled('overridenStatus')).toBe(false);
                 expect(this.getFeatureSettingEnabled('disabledOverridenStatus')).toBe(true);
                 expect(this.getFeatureSettingEnabled('statusObject')).toBe(true);