Modify heartbeat local storage to use wide strings on Windows. (#1313)

* Modify heartbeat local storage to use wide strings on Windows.

* Fix macro.

* Fix heartbeat test that uses filename.

* Format code.

* More format.

* Fix build error.

* Clean up GetFilename code.

* For debugging, add an international path to Windows runs.

* Fix Mkdir.

* Disable the i18n characters.

* Change codecvt use.

* Move heartbeats to a unique subdirectory.

* Move international characters.

* Ensure that the bug actually happens without the fix.

* Fix heartbeat path - and undo the international characters.

* Revert "Ensure that the bug actually happens without the fix."

This reverts commit cc6c164.

* Format code.

Author: jonsimantov

app/src/app_desktop.cc

@@ -143,10 +143,12 @@ App* App::Create(const AppOptions& options, const char* name) {  // NOLINT
     app = new App();
     app->name_ = name;
     app->options_ = options_with_defaults;
+    std::string unique_name =
+        std::string(app->options_.package_name()) + "." + app->name_;
     app = app_common::AddApp(app, &app->init_results_);
     app->internal_->heartbeat_controller_ =
         std::make_shared<heartbeat::HeartbeatController>(
-            name, *app_common::FindAppLoggerByName(name),
+            unique_name, *app_common::FindAppLoggerByName(name),
             app->internal_->date_provider_);
 #ifndef SWIG
     // Log a heartbeat after creating an App. In the Unity SDK this will happen

app/src/heartbeat/heartbeat_storage_desktop.cc

@@ -16,8 +16,11 @@
 
 #include "app/src/heartbeat/heartbeat_storage_desktop.h"
 
+#include <codecvt>
 #include <fstream>
+#include <locale>
 #include <regex>
+#include <string>
 #include <vector>
 
 #include "app/logged_heartbeats_generated.h"
@@ -41,23 +44,36 @@ namespace {
 const char kHeartbeatDir[] = "firebase-heartbeat";
 const char kHeartbeatFilenamePrefix[] = "heartbeats-";
 
+#if FIREBASE_PLATFORM_WINDOWS
+std::wstring CreateFilename(const std::string& app_id, const Logger& logger) {
+  const std::wstring empty_string;
+#else
 std::string CreateFilename(const std::string& app_id, const Logger& logger) {
+  const std::string empty_string;
+#endif  // FIREBASE_PLATFORM_WINDOWS
   std::string error;
   std::string app_dir =
       AppDataDir(kHeartbeatDir, /*should_create=*/true, &error);
   if (!error.empty()) {
     logger.LogError(error.c_str());
-    return "";
+    return empty_string;
   }
   if (app_dir.empty()) {
-    return "";
+    return empty_string;
   }
 
   // Remove any symbols from app_id that might not be allowed in filenames.
   auto app_id_without_symbols =
       std::regex_replace(app_id, std::regex("[/\\\\?%*:|\"<>.,;=]"), "");
   // Note: fstream will convert / to \ if needed on windows.
-  return app_dir + "/" + kHeartbeatFilenamePrefix + app_id_without_symbols;
+  std::string final_path_utf8 =
+      app_dir + "/" + kHeartbeatFilenamePrefix + app_id_without_symbols;
+#if FIREBASE_PLATFORM_WINDOWS
+  std::wstring_convert<std::codecvt_utf8<wchar_t>> final_path_w;
+  return final_path_w.from_bytes(final_path_utf8);
+#else
+  return final_path_utf8;
+#endif
 }
 
 }  // namespace
@@ -113,6 +129,12 @@ bool HeartbeatStorageDesktop::ReadTo(LoggedHeartbeats& heartbeats_output) {
   return true;
 }
 
+#if FIREBASE_PLATFORM_WINDOWS
+std::wstring HeartbeatStorageDesktop::GetFilename() const { return filename_; }
+#else
+std::string HeartbeatStorageDesktop::GetFilename() const { return filename_; }
+#endif  // FIREBASE_PLATFORM_WINDOWS
+
 bool HeartbeatStorageDesktop::Write(const LoggedHeartbeats& heartbeats) const {
   // Clear the file before writing.
   std::ofstream file(filename_, std::ios_base::trunc | std::ios_base::binary);
@@ -127,10 +149,6 @@ bool HeartbeatStorageDesktop::Write(const LoggedHeartbeats& heartbeats) const {
   return !file.fail();
 }
 
-const char* HeartbeatStorageDesktop::GetFilename() const {
-  return filename_.c_str();
-}
-
 LoggedHeartbeats HeartbeatStorageDesktop::LoggedHeartbeatsFromFlatbuffer(
     const LoggedHeartbeatsFlatbuffer& heartbeats_fb) const {
   LoggedHeartbeats heartbeats_struct;

app/src/heartbeat/heartbeat_storage_desktop.h

@@ -23,6 +23,7 @@
 #include <vector>
 
 #include "app/logged_heartbeats_generated.h"
+#include "app/src/include/firebase/internal/platform.h"
 #include "app/src/logger.h"
 
 namespace firebase {
@@ -52,7 +53,13 @@ class HeartbeatStorageDesktop {
   // write operation fails.
   bool Write(const LoggedHeartbeats& heartbeats) const;
 
-  const char* GetFilename() const;
+#if FIREBASE_PLATFORM_WINDOWS
+  // Use a wide string on Windows, to support international characters in the
+  // path.
+  std::wstring GetFilename() const;
+#else
+  std::string GetFilename() const;
+#endif  // FIREBASE_PLATFORM_WINDOWS
 
  private:
   LoggedHeartbeats LoggedHeartbeatsFromFlatbuffer(
@@ -61,7 +68,13 @@ class HeartbeatStorageDesktop {
       const LoggedHeartbeats& heartbeats_struct) const;
 
   // local variables for state
+#if FIREBASE_PLATFORM_WINDOWS
+  // Use a wide string on Windows, to support international characters in the
+  // path.
+  std::wstring filename_;
+#else
   std::string filename_;
+#endif  // FIREBASE_PLATFORM_WINDOWS
   const Logger& logger_;
 };
 

app/tests/heartbeat_storage_desktop_test.cc

@@ -22,6 +22,7 @@
 
 #include "app/logged_heartbeats_generated.h"
 #include "app/src/filesystem.h"
+#include "app/src/include/firebase/internal/platform.h"
 #include "gtest/gtest.h"
 
 namespace firebase {
@@ -129,10 +130,17 @@ TEST_F(HeartbeatStorageDesktopTest, ReadNonexistentFile) {
 TEST_F(HeartbeatStorageDesktopTest, FilenameIgnoresSymbolsInAppId) {
   std::string app_id = "idstart/\\?%*:|\"<>.,;=idend";
   HeartbeatStorageDesktop storage = HeartbeatStorageDesktop(app_id, logger_);
+#if FIREBASE_PLATFORM_WINDOWS
+  std::wstring filename = storage.GetFilename();
+  // Verify that the actual filename contains the non-symbol characters in
+  // app_id.
+  EXPECT_TRUE(filename.find(L"idstartidend") != std::string::npos) << filename;
+#else
   std::string filename = storage.GetFilename();
   // Verify that the actual filename contains the non-symbol characters in
   // app_id.
   EXPECT_TRUE(filename.find("idstartidend") != std::string::npos) << filename;
+#endif
 }
 
 TEST_F(HeartbeatStorageDesktopTest, ReadCorruptedData) {