Integration tests and configurations for QueryInfo support

Author: nakirekommula

app/CMakeLists.txt

@@ -546,6 +546,7 @@ if (IOS)
     ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/ad_view.h
     ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/interstitial_ad.h
     ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/internal/native_ad.h
+    ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/internal/query_info.h
     ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/rewarded_ad.h
     ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/types.h
     ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/ump.h

gma/CMakeLists.txt

@@ -26,6 +26,8 @@ set(common_SRCS
     src/common/full_screen_ad_event_listener.cc
     src/common/native_ad.cc
     src/common/native_ad_internal.cc
+    src/common/query_info.cc
+    src/common/query_info_internal.cc
     src/common/rewarded_ad.cc
     src/common/rewarded_ad_internal.cc)
 
@@ -49,6 +51,7 @@ set(android_SRCS
     src/android/interstitial_ad_internal_android.cc
     src/android/native_ad_image_android.cc
     src/android/native_ad_internal_android.cc
+    src/android/query_info_internal_android.cc
     src/android/response_info_android.cc
     src/android/rewarded_ad_internal_android.cc)
 
@@ -68,6 +71,7 @@ set(ios_SRCS
     src/ios/interstitial_ad_internal_ios.mm
     src/ios/native_ad_image_ios.mm
     src/ios/native_ad_internal_ios.mm
+    src/ios/query_info_internal_ios.mm
     src/ios/response_info_ios.mm
     src/ios/rewarded_ad_internal_ios.mm)
 
@@ -78,6 +82,7 @@ set(stub_SRCS
     src/stub/adapter_response_info_stub.cc
     src/stub/gma_stub.cc
     src/stub/native_ad_image_stub.cc
+    src/stub/query_info_internal_stub.cc
     src/stub/response_info_stub.cc)
 
 if(ANDROID)

gma/integration_test/src/integration_test.cc

@@ -993,6 +993,72 @@ TEST_F(FirebaseGmaTest, TestNativeAdLoad) {
   delete native_ad;
 }
 
+TEST_F(FirebaseGmaTest, TestCreateQueryInfo) {
+  SKIP_TEST_ON_DESKTOP;
+  SKIP_TEST_ON_SIMULATOR;
+
+  firebase::gma::QueryInfo* query_info = new firebase::gma::QueryInfo();
+
+  WaitForCompletion(query_info->Initialize(app_framework::GetWindowContext()),
+                    "Initialize");
+
+  firebase::gma::AdRequest request = GetAdRequest();
+  // Set the requester type to 8. QueryInfo gets generated without a
+  // query_info_type set, but throws a warning that it is missing.
+  request.add_extra(kAdNetworkExtrasClassName, "query_info_type",
+                    "requester_type_8");
+  // When the QueryInfo is initialized, generate a query info string.
+  firebase::Future<firebase::gma::QueryInfoResult> create_query_info_future =
+      query_info->CreateQueryInfo(firebase::gma::kAdFormatNative, request);
+
+  WaitForCompletion(create_query_info_future, "CreateQueryInfo");
+
+  if (create_query_info_future.error() == firebase::gma::kAdErrorCodeNone) {
+    const firebase::gma::QueryInfoResult* result_ptr =
+        create_query_info_future.result();
+    ASSERT_NE(result_ptr, nullptr);
+    EXPECT_TRUE(result_ptr->is_successful());
+    EXPECT_FALSE(result_ptr->query_info().empty());
+  }
+
+  create_query_info_future.Release();
+  delete query_info;
+}
+
+TEST_F(FirebaseGmaTest, TestCreateQueryInfoWithAdUnit) {
+  SKIP_TEST_ON_DESKTOP;
+  SKIP_TEST_ON_SIMULATOR;
+
+  firebase::gma::QueryInfo* query_info = new firebase::gma::QueryInfo();
+
+  WaitForCompletion(query_info->Initialize(app_framework::GetWindowContext()),
+                    "Initialize");
+
+  firebase::gma::AdRequest request = GetAdRequest();
+  // Set the requester type to 8. QueryInfo gets generated without a
+  // query_info_type set, but throws a warning that it is missing.
+  request.add_extra(kAdNetworkExtrasClassName, "query_info_type",
+                    "requester_type_8");
+  // When the QueryInfo is initialized, generate a query info string.
+  // Providing a bad/empty ad unit does not affect the query info generation.
+  firebase::Future<firebase::gma::QueryInfoResult> create_query_info_future =
+      query_info->CreateQueryInfoWithAdUnit(firebase::gma::kAdFormatNative,
+                                            request, kNativeAdUnit);
+
+  WaitForCompletion(create_query_info_future, "CreateQueryInfoWithAdUnit");
+
+  if (create_query_info_future.error() == firebase::gma::kAdErrorCodeNone) {
+    const firebase::gma::QueryInfoResult* result_ptr =
+        create_query_info_future.result();
+    ASSERT_NE(result_ptr, nullptr);
+    EXPECT_TRUE(result_ptr->is_successful());
+    EXPECT_FALSE(result_ptr->query_info().empty());
+  }
+
+  create_query_info_future.Release();
+  delete query_info;
+}
+
 // Interactive test section.  These have been placed up front so that the
 // tester doesn't get bored waiting for them.
 TEST_F(FirebaseGmaUITest, TestAdViewAdOpenedAdClosed) {

gma/src/stub/query_info_internal_stub.h

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FIREBASE_GMA_SRC_STUB_QUERY_INFO_INTERNAL_STUB_H_
+#define FIREBASE_GMA_SRC_STUB_QUERY_INFO_INTERNAL_STUB_H_
+
+#include "gma/src/common/query_info_internal.h"
+
+namespace firebase {
+namespace gma {
+namespace internal {
+
+/// Stub version of QueryInfoInternal, for use on desktop platforms. GMA
+/// is forbidden on desktop, so this version creates and immediately completes
+/// the Future for each method.
+class QueryInfoInternalStub : public QueryInfoInternal {
+ public:
+  explicit QueryInfoInternalStub(QueryInfo* base) : QueryInfoInternal(base) {}
+
+  ~QueryInfoInternalStub() override {}
+
+  Future<void> Initialize(AdParent parent) override {
+    return CreateAndCompleteFutureStub(kQueryInfoFnInitialize);
+  }
+
+  Future<QueryInfoResult> CreateQueryInfo(AdFormat format,
+                                          const AdRequest& request) override {
+    return CreateAndCompleteQueryInfoFutureStub(kQueryInfoFnCreateQueryInfo);
+  }
+
+  Future<QueryInfoResult> CreateQueryInfoWithAdUnit(
+      AdFormat format, const AdRequest& request,
+      const char* ad_unit_id) override {
+    return CreateAndCompleteQueryInfoFutureStub(
+        kQueryInfoFnCreateQueryInfoWithAdUnit);
+  }
+
+  bool is_initialized() const override { return true; }
+
+ private:
+  Future<void> CreateAndCompleteFutureStub(QueryInfoFn fn) {
+    CreateAndCompleteFuture(fn, kAdErrorCodeNone, nullptr, &future_data_);
+    return GetLastResult(fn);
+  }
+
+  Future<QueryInfoResult> CreateAndCompleteQueryInfoFutureStub(QueryInfoFn fn) {
+    return CreateAndCompleteFutureWithQueryInfoResult(
+        fn, kAdErrorCodeNone, nullptr, &future_data_, QueryInfoResult());
+  }
+};
+
+}  // namespace internal
+}  // namespace gma
+}  // namespace firebase
+
+#endif  // FIREBASE_GMA_SRC_STUB_QUERY_INFO_INTERNAL_STUB_H_