Merge 872764d into 52db94f

Author: john-mikhail

.gitignore

@@ -17,6 +17,7 @@ __pycache__/
 
 ### IDE generated files
 .vscode/
+**/.vs/
 
 # Unencrypted secret files
 google-services.json

analytics/generate_windows_stubs.py

@@ -262,7 +262,7 @@ def generate_function_pointers(dll_file_path, header_file_path, output_h_path, o
     )
     parser.add_argument(
         "--windows_dll",
-        default = os.path.join(os.path.dirname(sys.argv[0]), "windows/analytics_win.dll"),
+        default = os.path.join(os.path.dirname(sys.argv[0]), "windows/google_analytics.dll"),
         help="Path to the DLL file to calculate a hash."
     )
     parser.add_argument(

analytics/integration_test/CMakeLists.txt

@@ -211,7 +211,7 @@ else()
     )
   elseif(MSVC)
     set(ADDITIONAL_LIBS advapi32 ws2_32 crypt32)
-    set(ANALYTICS_WINDOWS_DLL "${FIREBASE_CPP_SDK_DIR}/analytics/windows/analytics_win.dll")
+    set(ANALYTICS_WINDOWS_DLL "${FIREBASE_CPP_SDK_DIR}/analytics/windows/google_analytics.dll")
 
     # For Windows, check if the Analytics DLL exists, and copy it in if so.
     if (EXISTS "${ANALYTICS_WINDOWS_DLL}")

analytics/integration_test/src/integration_test.cc

@@ -15,10 +15,12 @@
 #include <inttypes.h>
 
 #include <algorithm>
+#include <chrono>
 #include <cstdio>
 #include <cstdlib>
 #include <cstring>
 #include <ctime>
+#include <future>
 
 #include "app_framework.h"  // NOLINT
 #include "firebase/analytics.h"
@@ -242,6 +244,39 @@ TEST_F(FirebaseAnalyticsTest, TestSetProperties) {
       InitiateOnDeviceConversionMeasurementWithHashedPhoneNumber(hashed_phone);
 }
 
+#if defined(_WIN32)
+TEST_F(FirebaseAnalyticsTest, TestSetLogCallback) {
+  std::promise<void> finishedPromise;
+  std::future<void> finished = finishedPromise.get_future();
+  bool log_callback_called = false;
+
+  // Save the current log level, and set to verbose for this test.
+  firebase::LogLevel current_log_level = firebase::GetLogLevel();
+  firebase::SetLogLevel(firebase::LogLevel::kLogLevelVerbose);
+
+  firebase::analytics::SetLogCallback(
+      [&](firebase::LogLevel log_level, const char* message) {
+        log_callback_called = true;
+        finishedPromise.set_value();
+      });
+
+  //  Pass kUnknown to trigger a warning log directly from the DLL (on
+  //  Windows),
+  firebase::analytics::NotifyAppLifecycleChange(firebase::analytics::kUnknown);
+
+  if (finished.wait_for(std::chrono::seconds(10)) ==
+      std::future_status::timeout) {
+    ADD_FAILURE() << "Timed out waiting for log callback";
+  } else {
+    finished.get();
+  }
+
+  EXPECT_TRUE(log_callback_called);
+  firebase::analytics::SetLogCallback(nullptr);
+  firebase::SetLogLevel(current_log_level);
+}
+#endif  // defined(_WIN32)
+
 TEST_F(FirebaseAnalyticsTest, TestLogEvents) {
   // Log an event with no parameters.
   firebase::analytics::LogEvent(firebase::analytics::kEventLogin);
@@ -259,6 +294,14 @@ TEST_F(FirebaseAnalyticsTest, TestLogEvents) {
                                 "spoon_welders");
 }
 
+TEST_F(FirebaseAnalyticsTest, TestNotifyAppLifecycleChange) {
+  // Can't confirm that these do anything but just run them all to ensure the
+  // app doesn't crash.
+  firebase::analytics::NotifyAppLifecycleChange(firebase::analytics::kUnknown);
+  firebase::analytics::NotifyAppLifecycleChange(
+      firebase::analytics::kTermination);
+}
+
 TEST_F(FirebaseAnalyticsTest, TestLogEventWithMultipleParameters) {
   const firebase::analytics::Parameter kLevelUpParameters[] = {
       firebase::analytics::Parameter(firebase::analytics::kParameterLevel, 5),

analytics/src/analytics_android.cc

@@ -666,6 +666,12 @@ void ResetAnalyticsData() {
   util::CheckAndClearJniExceptions(env);
 }
 
+// NO-OP in Android and iOS. Only used in Windows.
+void SetLogCallback(const LogCallback&) {}
+
+// NO-OP in Android and iOS. Only used in Windows.
+void NotifyAppLifecycleChange(AppLifecycleState) {}
+
 Future<std::string> GetAnalyticsInstanceId() {
   FIREBASE_ASSERT_RETURN(GetAnalyticsInstanceIdLastResult(),
                          internal::IsInitialized());

analytics/src/analytics_desktop.cc

@@ -12,7 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#include <future>
 #include <map>
+#include <mutex>
 #include <sstream>
 #include <string>
 #include <vector>
@@ -25,6 +27,7 @@
 #include "app/src/include/firebase/future.h"
 #include "app/src/include/firebase/variant.h"
 #include "app/src/log.h"
+#include "firebase/log.h"
 
 #if defined(_WIN32)
 #include <windows.h>
@@ -36,14 +39,16 @@ namespace firebase {
 namespace analytics {
 
 #if defined(_WIN32)
-#define ANALYTICS_DLL_FILENAME L"analytics_win.dll"
+#define ANALYTICS_DLL_FILENAME L"google_analytics.dll"
 
 static HMODULE g_analytics_module = 0;
 #endif  // defined(_WIN32)
 
 // Future data for analytics.
 // This is initialized in `Initialize()` and cleaned up in `Terminate()`.
 static bool g_initialized = false;
+static LogCallback g_log_callback;
+static std::mutex g_log_callback_mutex;
 static int g_fake_instance_id = 0;
 static bool g_analytics_collection_enabled = true;
 static std::string g_app_id;
@@ -134,6 +139,10 @@ bool IsInitialized() { return g_initialized; }
 void Terminate() {
 #if defined(_WIN32)
   if (g_analytics_module) {
+    // Make sure to notify the SDK that the analytics is being terminated to
+    // upload any pending data.
+    NotifyAppLifecycleChange(AppLifecycleState::kTermination);
+
     FirebaseAnalytics_UnloadDynamicFunctions();
     FreeLibrary(g_analytics_module);
     g_analytics_module = 0;
@@ -386,6 +395,58 @@ void ResetAnalyticsData() {
   g_fake_instance_id++;
 }
 
+LogLevel ConvertAnalyticsLogLevelToFirebaseLogLevel(
+    GoogleAnalytics_LogLevel log_level) {
+  switch (log_level) {
+    case kDebug:
+      return kLogLevelDebug;
+    case kInfo:
+      return kLogLevelInfo;
+    case kWarning:
+      return kLogLevelWarning;
+    case kError:
+      return kLogLevelError;
+    default:
+      return kLogLevelInfo;
+  }
+}
+
+
+extern "C" void GoogleAnalyticsWrapperLogCallback(
+    GoogleAnalytics_LogLevel log_level, const char* message) {
+  LogCallback callback_to_call;
+
+  {
+    std::lock_guard<std::mutex> lock(g_log_callback_mutex);
+    callback_to_call = g_log_callback;
+  }
+
+  if (callback_to_call) {
+    LogLevel firebase_log_level =
+        ConvertAnalyticsLogLevelToFirebaseLogLevel(log_level);
+    callback_to_call(firebase_log_level, message);
+  }
+}
+
+// Allows the passing of a callback to be used when the SDK logs any
+// messages regarding its behavior. The callback must be thread-safe.
+void SetLogCallback(const LogCallback& callback) {
+  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
+  // The C API does not support user data, so we must use a global variable.
+  {
+    std::lock_guard<std::mutex> lock(g_log_callback_mutex);
+    g_log_callback = callback;
+  }
+  GoogleAnalytics_SetLogCallback(GoogleAnalyticsWrapperLogCallback);
+}
+
+// Notify the Analytics SDK about the current state of the app's lifecycle.
+void NotifyAppLifecycleChange(AppLifecycleState state) {
+  FIREBASE_ASSERT_RETURN_VOID(internal::IsInitialized());
+  GoogleAnalytics_NotifyAppLifecycleChange(
+      static_cast<GoogleAnalytics_AppLifecycleState>(state));
+}
+
 // Overloaded versions of LogEvent for convenience.
 
 void LogEvent(const char* name) {