add topics manager skeleton

Summary: - add topics manager into android sdk at skeleton level

Reviewed By: jjiang10

Differential Revision:
D71073660

Privacy Context Container: L1220306

fbshipit-source-id: 461214a98775ad7b6fda271cc3ce667e2610dae3

Author: Teng Chen

facebook-core/src/main/AndroidManifest.xml

@@ -45,4 +45,5 @@
     <uses-permission android:name="android.permission.ACCESS_ADSERVICES_ATTRIBUTION" />
     <uses-permission android:name="android.permission.ACCESS_ADSERVICES_AD_ID" />
     <uses-permission android:name="android.permission.ACCESS_ADSERVICES_CUSTOM_AUDIENCE" />
+    <uses-permission android:name="android.permission.ACCESS_ADSERVICES_TOPICS" />
 </manifest>

facebook-core/src/main/java/android/adservices/topics/GetTopicsRequest.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ * All rights reserved.
+ *
+ * This source code is licensed under the license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+package android.adservices.topics;
+
+import androidx.annotation.NonNull;
+
+public final class GetTopicsRequest {
+    GetTopicsRequest() {
+        throw new RuntimeException("Stub!");
+    }
+
+    @NonNull
+    public String getAdsSdkName() {
+        throw new RuntimeException("Stub!");
+    }
+
+    public boolean shouldRecordObservation() {
+        throw new RuntimeException("Stub!");
+    }
+
+    public static final class Builder {
+        public Builder() {
+            throw new RuntimeException("Stub!");
+        }
+
+        @NonNull
+        public Builder setAdsSdkName(@NonNull String adsSdkName) {
+            throw new RuntimeException("Stub!");
+        }
+
+        @NonNull
+        public Builder setShouldRecordObservation(boolean recordObservation) {
+            throw new RuntimeException("Stub!");
+        }
+
+        @NonNull
+        public GetTopicsRequest build() {
+            throw new RuntimeException("Stub!");
+        }
+    }
+}

facebook-core/src/main/java/android/adservices/topics/GetTopicsResponse.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ * All rights reserved.
+ *
+ * This source code is licensed under the license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+package android.adservices.topics;
+
+import androidx.annotation.NonNull;
+import java.util.List;
+
+public final class GetTopicsResponse {
+    GetTopicsResponse() {
+        throw new RuntimeException("Stub!");
+    }
+
+    @NonNull
+    public List<Topic> getTopics() {
+        throw new RuntimeException("Stub!");
+    }
+
+    public boolean equals(Object o) {
+        throw new RuntimeException("Stub!");
+    }
+
+    public int hashCode() {
+        throw new RuntimeException("Stub!");
+    }
+
+    public static final class Builder {
+        public Builder(@NonNull List<Topic> topics) {
+            throw new RuntimeException("Stub!");
+        }
+
+        @NonNull
+        public GetTopicsResponse build() {
+            throw new RuntimeException("Stub!");
+        }
+    }
+}

facebook-core/src/main/java/android/adservices/topics/Topic.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ * All rights reserved.
+ *
+ * This source code is licensed under the license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+package android.adservices.topics;
+
+import androidx.annotation.NonNull;
+
+import java.util.List;
+
+public final class Topic {
+    Topic() {
+        throw new RuntimeException("Stub!");
+    }
+
+    @NonNull
+    public List<Topic> getTopics() {
+        throw new RuntimeException("Stub!");
+    }
+
+    public boolean equals(Object o) {
+        throw new RuntimeException("Stub!");
+    }
+
+    public int hashCode() {
+        throw new RuntimeException("Stub!");
+    }
+
+    public static final class Builder {
+        public Builder(@NonNull List<Topic> topics) {
+            throw new RuntimeException("Stub!");
+        }
+
+        @NonNull
+        public Topic build() {
+            throw new RuntimeException("Stub!");
+        }
+    }
+}

facebook-core/src/main/java/android/adservices/topics/TopicsManager.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ * All rights reserved.
+ *
+ * This source code is licensed under the license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+package android.adservices.topics;
+
+import androidx.annotation.NonNull;
+import android.content.Context;
+import android.os.OutcomeReceiver;
+import java.util.concurrent.Executor;
+
+public final class TopicsManager {
+    TopicsManager() {
+        throw new RuntimeException("Stub!");
+    }
+
+    @NonNull
+    public static TopicsManager get(@NonNull Context context) {
+        throw new RuntimeException("Stub!");
+    }
+
+    @NonNull
+    public void getTopics(@NonNull GetTopicsRequest getTopicsRequest, @NonNull Executor executor, @NonNull OutcomeReceiver<GetTopicsResponse, Exception> callback) {
+        throw new RuntimeException("Stub!");
+    }
+}

facebook-core/src/main/java/com/facebook/appevents/gps/topics/GpsTopicsManager.kt

@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ * All rights reserved.
+ *
+ * This source code is licensed under the license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+package com.facebook.appevents.gps.topics
+
+import android.adservices.topics.GetTopicsRequest
+import android.adservices.topics.GetTopicsResponse
+import android.adservices.topics.TopicsManager
+import android.annotation.TargetApi
+import android.os.OutcomeReceiver
+import android.util.Log
+import com.facebook.FacebookSdk
+import com.facebook.internal.instrument.crashshield.AutoHandleExceptions
+import java.util.concurrent.Executor
+import java.util.concurrent.Executors
+
+@AutoHandleExceptions
+object GpsTopicsManager {
+    private const val RECORD_OBSERVATION = true
+    private val TAG = GpsTopicsManager::class.java.toString()
+    private val executor: Executor by lazy { Executors.newCachedThreadPool() }
+
+    @JvmStatic
+    @TargetApi(34)
+    fun getTopics(): List<String> {
+        if (!shouldObserveTopics()) return emptyList()
+
+        val context = FacebookSdk.getApplicationContext()
+        var topicsResult: ArrayList<String> = ArrayList()
+        try {
+            val callback: OutcomeReceiver<GetTopicsResponse, Exception> =
+                object : OutcomeReceiver<GetTopicsResponse, Exception> {
+                    override fun onResult(response: GetTopicsResponse) {
+                        try {
+                            topicsResult.addAll(processObservedTopics(response))
+                        } catch (e: Exception) {
+                            // TODO - customized error handling
+                            Log.w(TAG, "GPS_TOPICS_PROCESSING_FAILED")
+                        }
+                    }
+
+                    override fun onError(error: java.lang.Exception) {
+                        // TODO - customized error handling
+                        Log.w(TAG, "GPS_TOPICS_OBSERVATION_ERROR")
+                    }
+                }
+
+            val topicsRequestBuilder: GetTopicsRequest.Builder = GetTopicsRequest.Builder()
+            topicsRequestBuilder.setShouldRecordObservation(RECORD_OBSERVATION)
+            topicsRequestBuilder.setAdsSdkName(context.packageName)
+            context.getSystemService(TopicsManager::class.java)?.getTopics(
+                    topicsRequestBuilder.build(),
+                    executor,
+                    callback)
+        } catch (e: Exception) {
+            // TODO - customized error handling
+            Log.w(TAG, "GPS_TOPICS_OBSERVATION_FAILED")
+            return emptyList()
+        }
+
+        return topicsResult
+    }
+
+    private fun shouldObserveTopics(): Boolean {
+        // TODO - default in false for fetcher skeleton
+        return false
+    }
+
+    @TargetApi(34)
+    private fun processObservedTopics(response: GetTopicsResponse): List<String> {
+        // TODO - topics parser to process
+        if (response.topics.isEmpty()) return emptyList()
+        return response.topics.map { it.toString() }
+    }
+}

facebook-core/src/main/res/xml/ad_services_config.xml

@@ -25,4 +25,6 @@
     <attribution allowAllToAccess="true" />
     <!-- Protected Audience on Android API -->
     <custom-audiences allowAllToAccess="true" />
+    <!-- Topics API -->
+    <topics allowAllToAccess="true" />
 </ad-services-config>

facebook-core/src/test/kotlin/com/facebook/appevents/gps/topics/GpsTopicsManagerTest.kt

@@ -0,0 +1,55 @@
+package com.facebook.appevents.gps.topics
+
+import android.adservices.topics.GetTopicsResponse
+import android.adservices.topics.Topic
+import android.adservices.topics.TopicsManager
+import android.content.Context
+import android.os.OutcomeReceiver
+import com.facebook.FacebookPowerMockTestCase
+import com.facebook.FacebookSdk
+import org.junit.Before
+import org.junit.Test
+import org.mockito.kotlin.any
+import org.mockito.kotlin.mock
+import org.mockito.kotlin.whenever
+import org.powermock.api.mockito.PowerMockito
+import org.powermock.core.classloader.annotations.PrepareForTest
+import org.robolectric.annotation.Config
+import kotlin.test.assertNotNull
+
+@PrepareForTest(
+    FacebookSdk::class,
+    TopicsManager::class,
+    GetTopicsResponse::class,
+    Topic::class,
+)
+@Config(sdk = [23])
+class GpsTopicsManagerTest : FacebookPowerMockTestCase() {
+    private lateinit var mockContext: Context
+    private lateinit var mockTopicsManager: TopicsManager
+
+    @Before
+    fun setUp() {
+        mockContext = mock()
+        mockTopicsManager = mock()
+        whenever(mockContext.applicationContext).thenReturn(mockContext)
+        PowerMockito.mockStatic(FacebookSdk::class.java)
+        whenever(FacebookSdk.getApplicationContext()).thenReturn(mockContext)
+        PowerMockito.mockStatic(TopicsManager::class.java)
+        whenever(mockContext.getSystemService(TopicsManager::class.java)).thenReturn(
+            mockTopicsManager
+        )
+        whenever(mockTopicsManager.getTopics(any(), any(), any())).thenAnswer { invocation ->
+            val callback = invocation.getArgument<OutcomeReceiver<GetTopicsResponse, Exception>>(2)
+            val getTopicsResponse = GetTopicsResponse.Builder(listOf()).build()
+            callback.onResult(getTopicsResponse)
+        }
+    }
+
+    @Test
+    fun testGetTopicsSkeleton() {
+        // TODO - skeleton workflow validation pending detailed test cases
+        val topics = GpsTopicsManager.getTopics()
+        assertNotNull(topics)
+    }
+}