adsjs ping changes (#1922)

* Initial move

* Trigger args updating

* Add config listener

* Add listener to web compat

* Make idempotent and remove old code path

* Rename method

* Add updateFeatureArgs to integration test

Author: jonathanKingston

injected/entry-points/android-adsjs.js

@@ -1,9 +1,54 @@
 /**
  * @module Android AdsJS integration
  */
-import { load, init } from '../src/content-scope-features.js';
-import { processConfig } from './../src/utils';
-import { AndroidAdsjsMessagingConfig } from '../../messaging/index.js';
+import { load, init, updateFeatureArgs } from '../src/content-scope-features.js';
+import { processConfig, isBeingFramed } from './../src/utils';
+import { AndroidAdsjsMessagingConfig, MessagingContext, Messaging } from '../../messaging/index.js';
+
+/**
+ * Send initial ping once per frame to establish communication with the platform.
+ * This replaces the per-feature ping that was previously sent in AndroidAdsjsMessagingTransport.
+ * When response is received, updates all loaded feature configurations.
+ *
+ * @param {AndroidAdsjsMessagingConfig} messagingConfig
+ * @param {object} processedConfig - The base configuration
+ */
+async function sendInitialPingAndUpdate(messagingConfig, processedConfig) {
+    // Only send ping in top context, not in frames
+    if (isBeingFramed()) {
+        return;
+    }
+
+    try {
+        // Create messaging context for the initial ping
+        const messagingContext = new MessagingContext({
+            context: 'contentScopeScripts',
+            env: processedConfig.debug ? 'development' : 'production',
+            featureName: 'messaging',
+        });
+
+        // Create messaging instance - handles all the subscription/error boilerplate
+        const messaging = new Messaging(messagingContext, messagingConfig);
+
+        if (processedConfig.debug) {
+            console.log('AndroidAdsjs: Sending initial ping...');
+        }
+
+        // Send the ping request
+        const response = await messaging.request('initialPing', {});
+
+        // Update all loaded features with merged configuration
+        if (response && typeof response === 'object') {
+            const updatedConfig = { ...processedConfig, ...response };
+
+            await updateFeatureArgs(updatedConfig);
+        }
+    } catch (error) {
+        if (processedConfig.debug) {
+            console.error('AndroidAdsjs: Initial ping failed:', error);
+        }
+    }
+}
 
 function initCode() {
     // @ts-expect-error https://app.asana.com/0/1201614831475344/1203979574128023/f
@@ -24,6 +69,10 @@ function initCode() {
         debug: processedConfig.debug,
     });
 
+    // Send initial ping asynchronously to update feature configurations when response arrives
+    sendInitialPingAndUpdate(processedConfig.messagingConfig, processedConfig);
+
+    // Load and init features immediately with base configuration
     load({
         platform: processedConfig.platform,
         site: processedConfig.site,

injected/entry-points/integration.js

@@ -1,4 +1,4 @@
-import { load, init } from '../src/content-scope-features.js';
+import { load, init, updateFeatureArgs } from '../src/content-scope-features.js';
 import { TestTransportConfig } from '../../messaging/index.js';
 import { getTabUrl } from '../src/utils.js';
 
@@ -120,6 +120,7 @@ async function initCode() {
             window.__testContentScopeArgs = merged;
             // init features
             await init(merged);
+            await updateFeatureArgs(merged);
 
             // set status to initialized so that tests can resume
             setStatus('initialized');

injected/src/content-feature.js

@@ -42,6 +42,12 @@ export default class ContentFeature extends ConfigFeature {
      */
     listenForUpdateChanges = false;
 
+    /**
+     * Set this to true if you wish to receive configuration updates from initial ping responses (Android only).
+     * @type {boolean}
+     */
+    listenForConfigUpdates = false;
+
     /** @type {ImportMeta} */
     #importConfig;
 
@@ -223,6 +229,17 @@ export default class ContentFeature extends ConfigFeature {
      */
     update() {}
 
+    /**
+     * Called when user preferences are merged from initial ping response. (Android only)
+     * Override this method in your feature to handle user preference updates.
+     * This only happens once during initialization when the platform responds with user-specific settings.
+     * @param {object} _updatedConfig - The configuration with merged user preferences
+     */
+    onUserPreferencesMerged(_updatedConfig) {
+        // Default implementation does nothing
+        // Features can override this to handle user preference updates
+    }
+
     /**
      * Register a flag that will be added to page breakage reports
      */

injected/src/content-scope-features.js

@@ -117,6 +117,34 @@ export function update(args) {
     updateFeaturesInner(args);
 }
 
+/**
+ * Update the args for feature instances that opt in to configuration updates.
+ * This is useful for applying configuration updates received after initial loading.
+ *
+ * @param {object} updatedArgs - The new arguments to apply to opted-in features
+ */
+export async function updateFeatureArgs(updatedArgs) {
+    if (!isHTMLDocument) {
+        return;
+    }
+
+    const resolvedFeatures = await Promise.all(features);
+    resolvedFeatures.forEach(({ featureInstance }) => {
+        // Only update features that have opted in to config updates
+        if (featureInstance && featureInstance.listenForConfigUpdates) {
+            // Update the feature's args
+            if (typeof featureInstance.setArgs === 'function') {
+                featureInstance.setArgs(updatedArgs);
+            }
+
+            // Call the optional onUserPreferencesMerged method if it exists
+            if (typeof featureInstance.onUserPreferencesMerged === 'function') {
+                featureInstance.onUserPreferencesMerged(updatedArgs);
+            }
+        }
+    });
+}
+
 function alwaysInitExtensionFeatures(args, featureName) {
     return args.platform.name === 'extension' && alwaysInitFeatures.has(featureName);
 }

injected/src/features/web-compat.js

@@ -87,6 +87,9 @@ export class WebCompat extends ContentFeature {
     /** @type {Promise<any> | null} */
     #activeScreenLockRequest = null;
 
+    // Opt in to receive configuration updates from initial ping responses
+    listenForConfigUpdates = true;
+
     init() {
         if (this.getFeatureSettingEnabled('windowSizing')) {
             windowSizingFix();
@@ -123,10 +126,6 @@ export class WebCompat extends ContentFeature {
             this.shimWebShare();
         }
 
-        if (this.getFeatureSettingEnabled('viewportWidth')) {
-            this.viewportWidthFix();
-        }
-
         if (this.getFeatureSettingEnabled('screenLock')) {
             this.screenLockFix();
         }
@@ -146,6 +145,21 @@ export class WebCompat extends ContentFeature {
         }
     }
 
+    /**
+     * Handle user preference updates when merged during initialization.
+     * Re-applies viewport fixes if viewport configuration has changed.
+     * @param {object} _updatedConfig - The configuration with merged user preferences
+     */
+    onUserPreferencesMerged(_updatedConfig) {
+        // Re-apply viewport width fix if viewport settings might have changed
+        if (this.getFeatureSettingEnabled('viewportWidth')) {
+            if (!this._viewportWidthFixApplied) {
+                this.viewportWidthFix();
+                this._viewportWidthFixApplied = true;
+            }
+        }
+    }
+
     /** Shim Web Share API in Android WebView */
     shimWebShare() {
         if (typeof navigator.canShare === 'function' || typeof navigator.share === 'function') return;

messaging/lib/android-adsjs.js

@@ -33,9 +33,6 @@ export class AndroidAdsjsMessagingTransport {
     constructor(config, messagingContext) {
         this.messagingContext = messagingContext;
         this.config = config;
-
-        // Send initial ping when transport is first created.
-        this.config.sendInitialPing(messagingContext);
     }
 
     /**