4.1.0 (#22)

# Analytics SDK for C++ - Version 4.1.0

## ⚠️ Important Update
- **Version 4.0.0 is deprecated**. A **mandatory update** to version 4.1.0 is required to ensure continued support, optimal performance, and access to future updates.

## 🚀 New Features
- **Boot Time in Milliseconds**: Boot time now reported in milliseconds for precise performance metrics.

## 🐛 Bug Fixes
- **Design Event Values**: Improved the consistency of design event value handling, ensuring more accurate data delivery.

## ✨ Enhancements
- **Local Cache Path**: Refined the local cache path configuration to automatically use the default writable path, streamlining setup by making `configureWritablePath` optional.

Author: dorin-ga

.github/workflows/coverage.yml

@@ -34,7 +34,7 @@ jobs:
       run: cmake --build . --target cov_data
 
     - name: Report code coverage
-      uses: zgosalvez/github-actions-report-lcov@v3
+      uses: zgosalvez/github-actions-report-lcov@v4
       with:
         coverage-files: build/cov.info.cleaned
         minimum-coverage: 30

CHANGELOG.md

@@ -1,6 +1,21 @@
-Changelog
+# Changelog
+
+## 4.1.0
+
+### Added
+
+- **Boot Time in Milliseconds**: Boot time now reported in milliseconds for precise performance metrics.
+
+### Fixed
+
+- **Design Event Values**: Improved the consistency of design event value handling, ensuring more accurate data delivery.
+- **Local Cache Path**: Refined the local cache path configuration to automatically use the default writable path, streamlining setup by making `configureWritablePath` optional.
+- **Verbose Logging**: more logs are not visible when verbose logging is enabled.
+
 ---------
 
+## Older deprecated versions
+
 **4.0.0**
 
 * updated to C++17

CMakeLists.txt

@@ -273,9 +273,7 @@ if (ENABLE_COVERAGE)
         )
 
         target_link_libraries(
-            GameAnalytics
-            PRIVATE
-                --coverage
+            GameAnalytics PRIVATE -fprofile-arcs -ftest-coverage
         )
 
         set(covname cov)
@@ -289,13 +287,22 @@ if (ENABLE_COVERAGE)
             COMMAND GameAnalyticsUnitTests
 
             # Capturing lcov counters and generating report
-            COMMAND ${LCOV_PATH} --directory . --capture --output-file ${covname}.info
+
+            COMMAND echo "Processing code coverage counters and generating report."
+
+            COMMAND ${LCOV_PATH} --directory . --capture --output-file ${covname}.info --branch-coverage --rc geninfo_unexecuted_blocks=1 --rc no_exception_branch=1
+
+            COMMAND echo "Removing unwanted files from coverage report."
+            
             COMMAND ${LCOV_PATH} --remove ${covname}.info
                                 '${CMAKE_SOURCE_DIR}/source/dependencies/*'
                                 '${CMAKE_SOURCE_DIR}/test/*'
                                 '/usr/*'
                                 '/Applications/Xcode.app/*'
                                 --output-file ${covname}.info.cleaned
+                                --ignore-errors unused
+            
+            COMMAND echo "Finished processing code coverage counters and generating report."
         )
 
         if (GENHTML_PATH)

README.md

@@ -23,28 +23,7 @@ Dependencies
 Changelog
 ------------
 
-**4.0.0**
-
-* updated to C++17
-* public functions will now expect `std::string` instead of `const char*`
-* configureAvailableCustomDimensions, configureAvailableResourceCurrencies and configureAvailableItemTypes will now require a `std::vector<std::string>` as argument
-* removed duplicated public functions, replaced with default arguments
-* added argument for IRemoteConfigsListener callback
-* rewritten build scripts, now requires python3
-* changed user id logic to always use randomized id (except if custom id is set)
-* replaced usage of unsafe cstrings and functions with safer alternatives
-* refactored the internal codebase
-* rewritten threading logic
-* replaced RapidJson
-* removed Tizien support
-* added SDK init event
-* added health event
-* added external user id
-* safer handling of device properties retrieval
-* added exception handling
-* improved stability
-* various bug fixes
-* added sample app
+See the full [CHANGELOG](./CHANGELOG) for detailed version history.
 
 How to build
 ------------

sample/Main.cpp

@@ -4,8 +4,8 @@
 
 #include "GameAnalytics/GameAnalytics.h"
 
-constexpr const char* GAME_KEY   = "bd624ee6f8e6efb32a054f8d7ba11618";
-constexpr const char* SECRET_KEY = "7f5c3f682cbd217841efba92e92ffb1b3b6612bc";
+constexpr const char* GAME_KEY   = "INSERT_GAME_KEY";
+constexpr const char* SECRET_KEY = "INSERT_SECRET_KEY";
 
 struct RemoteConfigs:
     public gameanalytics::IRemoteConfigsListener

source/dependencies/crossguid/guid.h

@@ -36,6 +36,7 @@ THE SOFTWARE.
 #include <string_view>
 #include <utility>
 #include <iomanip>
+#include <cinttypes>
 
 #define BEGIN_XG_NAMESPACE namespace xg {
 #define END_XG_NAMESPACE }

source/gameanalytics/GACommon.h

@@ -85,7 +85,7 @@ namespace gameanalytics
         class GAState;
     }
 
-    constexpr const char* GA_VERSION_STR = "cpp 4.0.0-alpha";
+    constexpr const char* GA_VERSION_STR = "cpp 4.1.0";
 
     constexpr int MAX_CUSTOM_FIELDS_COUNT				 = 50;
     constexpr int MAX_CUSTOM_FIELDS_KEY_LENGTH			 = 64;

source/gameanalytics/GALogger.cpp

@@ -8,6 +8,7 @@
 #include "GAUtilities.h"
 #include "GAState.h"
 
+#define ZF_LOG_SRCLOC ZF_LOG_SRCLOC_NONE
 #define ZF_LOG_LEVEL ZF_LOG_VERBOSE
 #define ZF_LOG_BUF_SZ 2048
 #include "zf_log.h"

source/gameanalytics/GALogger.h

@@ -8,8 +8,7 @@
 #include "GACommon.h"
 #include "GAUtilities.h"
 
-#define ZF_LOG_SRCLOC ZF_LOG_SRCLOC_NONE
-#include "zf_log.h"
+struct zf_log_message;
 
 namespace gameanalytics
 {

source/gameanalytics/GAStore.cpp

@@ -207,32 +207,67 @@ namespace gameanalytics
             return sqlDatabase;
         }
 
-        bool GAStore::ensureDatabase(bool dropDatabase, std::string const& key)
+        bool GAStore::fixOldDatabase()
+        {
+            std::filesystem::path oldPath  = dbPath;
+            std::filesystem::path filename = oldPath.filename();
+            
+            oldPath = oldPath.parent_path() / ".." / filename;
+            
+            if(std::filesystem::exists(oldPath) && !std::filesystem::exists(dbPath))
+            {
+                try
+                {
+                    std::filesystem::rename(oldPath, dbPath);
+                }
+                catch(...)
+                {
+                    return false;
+                }
+                
+                return true;
+            }
+
+            return false;
+        }
+    
+        bool GAStore::initDatabaseLocation()
         {
-            // lazy creation of db path
-            if(getInstance().dbPath.empty())
+            constexpr const char* DATABASE_NAME = "ga.sqlite3";
+            
+            std::filesystem::path p = device::GADevice::getWritablePath();
+            
+            p /= state::GAState::getGameKey();
+            
+            dbPath = (p / DATABASE_NAME).string();
+            if(!std::filesystem::exists(p))
             {
-                std::string path = device::GADevice::getWritablePath();
-                path += "/ga.sqlite3";
+                if(!std::filesystem::create_directory(p))
+                    return false;
 
-                getInstance().dbPath = path;
+                fixOldDatabase();
             }
 
-            const std::string dbPath = getInstance().dbPath;
+            return true;
+        }
 
+        bool GAStore::ensureDatabase(bool dropDatabase, std::string const& key)
+        {
+            getInstance().initDatabaseLocation();
+            
             // Open database
-            if (sqlite3_open(dbPath.c_str(), &getInstance().sqlDatabase) != SQLITE_OK)
+            if (sqlite3_open(getInstance().dbPath.c_str(), &getInstance().sqlDatabase) != SQLITE_OK)
             {
                 getInstance().dbReady = false;
-                logging::GALogger::w("Could not open database: %s", dbPath.c_str());
+                logging::GALogger::w("Could not open database: %s", getInstance().dbPath.c_str());
                 return false;
             }
             else
             {
                 getInstance().dbReady = true;
-                logging::GALogger::i("Database opened: %s", dbPath.c_str());
+                logging::GALogger::i("Database opened: %s", getInstance().dbPath.c_str());
             }
-
+            
             if (dropDatabase)
             {
                 logging::GALogger::d("Drop tables");

source/gameanalytics/GAStore.h

@@ -50,7 +50,10 @@ namespace gameanalytics
 
             static GAStore& getInstance();
 
+            bool fixOldDatabase();
             bool trimEventTable();
+            
+            bool initDatabaseLocation();
 
             // set when calling "ensureDatabase"
             // using a "writablePath" that needs to be set into the C++ component before

source/gameanalytics/GameAnalytics.cpp

@@ -356,8 +356,7 @@ namespace gameanalytics
         {
             return;
         }
-
-
+        
         threading::GAThreading::performTaskOnGAThread([gameKey, gameSecret]()
         {
             if (isSdkReady(true, false))
@@ -517,7 +516,7 @@ namespace gameanalytics
             try
             {
                 json fieldsJson = utilities::parseFields(fields);
-                events::GAEvents::addDesignEvent(eventId, value, false, fieldsJson, mergeFields);
+                events::GAEvents::addDesignEvent(eventId, value, true, fieldsJson, mergeFields);
             }
             catch(json::exception const& e)
             {
@@ -739,11 +738,6 @@ namespace gameanalytics
         });
     }
 
-    std::string GameAnalytics::getRemoteConfigsValueAsString(std::string const& key)
-    {
-        return getRemoteConfigsValueAsString(key, "");
-    }
-
     std::string GameAnalytics::getRemoteConfigsValueAsString(std::string const& key, std::string const& defaultValue)
     {
         return state::GAState::getRemoteConfigsStringValue(key, defaultValue);

source/gameanalytics/Platform/GADevicePlatform.h

@@ -49,5 +49,3 @@ namespace gameanalytics
         return std::make_unique<GADevicePlatform>();
     }
 }
-
-

source/gameanalytics/Platform/GAMacOS.cpp

@@ -259,8 +259,9 @@ int64_t gameanalytics::GAPlatformMacOS::getBootTime() const
     struct timeval currentTime = {};
 
     gettimeofday(&currentTime, NULL);
-    
-    return currentTime.tv_sec - startTime.tv_sec;
+
+    int64_t remainingMs = static_cast<double>(currentTime.tv_usec - startTime.tv_usec) * 1e-3;
+    return (currentTime.tv_sec - startTime.tv_sec) * 1000 + remainingMs;
 }
 
 #endif

source/gameanalytics/Platform/GAWin32.cpp

@@ -332,7 +332,7 @@ int64_t GAPlatformWin32::getBootTime() const
 
         // filetime is expressed in 100s of nanoseconds
         std::chrono::nanoseconds timeInNs = std::chrono::nanoseconds(value * 100);
-        return std::chrono::duration_cast<std::chrono::seconds>(timeInNs).count();
+        return std::chrono::duration_cast<std::chrono::milliseconds>(timeInNs).count();
     }
 
     return 0ll;