Including ads-client in the megazord (#6966)

Including ads-client in iOS build

Updating AdsClient API error name to avoid collisions

Updating changelog

Including ads_client to megazord_stub

Resetting glean submodule

Correct ordering of projects in buildconfig-android

Author: luc-lisi

.buildconfig-android.yml

@@ -1,5 +1,12 @@
 groupId: org.mozilla.appservices
 projects:
+  ads-client:
+    path: components/ads-client/android
+    artifactId: ads-client
+    publications:
+    - name: ads-client
+      type: aar
+    description: for fetching ads via UAPI
   autofill:
     path: components/autofill/android
     artifactId: autofill
@@ -165,3 +172,4 @@ projects:
     - name: relay
       type: aar
     description: Client for Firefox Relay.
+

CHANGELOG.md

@@ -4,6 +4,9 @@
 
 ### Swift
 - Added `@unchecked Sendable` to classes that conform to `FeatureManifestInterface`. ([#6963](https://github.com/mozilla/application-services/pull/6963)
+### Ads Client
+- Added the Ads Client component to the Megazord.
+- Updated the ApiError enum to AdsClientApiError to avoid naming collision.
 
 # v144.0 (_2025-09-15_)
 

Cargo.lock

@@ -0,0 +1,10 @@
+apply from: "$appServicesRootDir/build-scripts/component-common.gradle"
+apply from: "$appServicesRootDir/publish.gradle"
+
+android {
+    namespace 'org.mozilla.appservices.ads_client'
+}
+
+ext.configureUniFFIBindgen("ads_client")
+ext.dependsOnTheMegazord()
+ext.configurePublish()

components/ads-client/android/build.gradle

@@ -0,0 +1,22 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile
+

components/ads-client/android/proguard-rules.pro

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"/>
+

components/ads-client/android/src/main/AndroidManifest.xml

@@ -6,10 +6,10 @@
 use error_support::{error, ErrorHandling, GetErrorHandling};
 use viaduct::Response;
 
-pub type ApiResult<T> = std::result::Result<T, ApiError>;
+pub type AdsClientApiResult<T> = std::result::Result<T, AdsClientApiError>;
 
 #[derive(Debug, thiserror::Error, uniffi::Error)]
-pub enum ApiError {
+pub enum AdsClientApiError {
     #[error("Something unexpected occurred.")]
     Other { reason: String },
 }
@@ -30,10 +30,10 @@ pub enum ComponentError {
 }
 
 impl GetErrorHandling for ComponentError {
-    type ExternalError = ApiError;
+    type ExternalError = AdsClientApiError;
 
     fn get_error_handling(&self) -> ErrorHandling<Self::ExternalError> {
-        ErrorHandling::convert(ApiError::Other {
+        ErrorHandling::convert(AdsClientApiError::Other {
             reason: self.to_string(),
         })
     }

components/ads-client/src/error.rs

@@ -5,7 +5,7 @@
 
 use std::collections::{HashMap, HashSet};
 
-use error::ApiResult;
+use error::AdsClientApiResult;
 use error::{
     BuildPlacementsError, BuildRequestError, ComponentError, RecordClickError,
     RecordImpressionError, ReportAdError, RequestAdsError,
@@ -24,7 +24,7 @@ mod models;
 #[cfg(test)]
 mod test_utils;
 
-uniffi::setup_scaffolding!("adsclient");
+uniffi::setup_scaffolding!("ads_client");
 
 /// Top-level API for the mac component
 #[derive(uniffi::Object)]
@@ -51,7 +51,7 @@ impl MozAdsClient {
     pub fn request_ads(
         &self,
         moz_ad_configs: Vec<MozAdsPlacementConfig>,
-    ) -> ApiResult<HashMap<String, MozAdsPlacement>> {
+    ) -> AdsClientApiResult<HashMap<String, MozAdsPlacement>> {
         let inner = self.inner.lock();
         let placements = inner
             .request_ads(&moz_ad_configs)
@@ -60,7 +60,7 @@ impl MozAdsClient {
     }
 
     #[handle_error(ComponentError)]
-    pub fn record_impression(&self, placement: MozAdsPlacement) -> ApiResult<()> {
+    pub fn record_impression(&self, placement: MozAdsPlacement) -> AdsClientApiResult<()> {
         let inner = self.inner.lock();
         inner
             .record_impression(&placement)
@@ -69,7 +69,7 @@ impl MozAdsClient {
     }
 
     #[handle_error(ComponentError)]
-    pub fn record_click(&self, placement: MozAdsPlacement) -> ApiResult<()> {
+    pub fn record_click(&self, placement: MozAdsPlacement) -> AdsClientApiResult<()> {
         let inner = self.inner.lock();
         inner
             .record_click(&placement)
@@ -78,21 +78,21 @@ impl MozAdsClient {
     }
 
     #[handle_error(ComponentError)]
-    pub fn report_ad(&self, placement: MozAdsPlacement) -> ApiResult<()> {
+    pub fn report_ad(&self, placement: MozAdsPlacement) -> AdsClientApiResult<()> {
         let inner = self.inner.lock();
         inner
             .report_ad(&placement)
             .map_err(ComponentError::ReportAd)
             .emit_telemetry_if_error()
     }
 
-    pub fn cycle_context_id(&self) -> ApiResult<String> {
+    pub fn cycle_context_id(&self) -> AdsClientApiResult<String> {
         let mut inner = self.inner.lock();
         let previous_context_id = inner.cycle_context_id();
         Ok(previous_context_id)
     }
 
-    pub fn clear_cache(&self) -> ApiResult<()> {
+    pub fn clear_cache(&self) -> AdsClientApiResult<()> {
         let mut inner = self.inner.lock();
         inner.clear_cache();
         Ok(())

components/ads-client/src/lib.rs

@@ -1,6 +1,6 @@
 [bindings.kotlin]
-package_name = "mozilla.appservices.adsclient"
+package_name = "mozilla.appservices.ads_client"
 
 [bindings.swift]
 ffi_module_name = "MozillaRustComponents"
-ffi_module_filename = "adsclientFFI"
+ffi_module_filename = "ads_clientFFI"

components/ads-client/uniffi.toml

@@ -10,6 +10,7 @@
 // but here we are.
 // To get the symbols from our static lib we need to refer to a symbol from each crate within it.
 // This is an arbitrary choice - any symbol will do, but we chose these because every uniffi crate has it.
+extern int MOZ_EXPORT ffi_ads_client_uniffi_contract_version();
 extern int MOZ_EXPORT ffi_autofill_uniffi_contract_version();
 extern int MOZ_EXPORT ffi_crashtest_uniffi_contract_version();
 extern int MOZ_EXPORT ffi_fxa_client_uniffi_contract_version();
@@ -37,6 +38,7 @@ extern int MOZ_EXPORT ffi_tabs_uniffi_contract_version();
 extern int MOZ_EXPORT uniffi_search_checksum_constructor_searchengineselector_new();
 
 void _local_megazord_dummy_symbol() {
+    ffi_ads_client_uniffi_contract_version();
     ffi_autofill_uniffi_contract_version();
     ffi_crashtest_uniffi_contract_version();
     ffi_fxa_client_uniffi_contract_version();