Fix remote configs hash caching, custom fields validation; add event tests

.github/workflows/cmake.yml

@@ -105,6 +105,14 @@ jobs:
         echo "check lld..."
         ldd --version
 
+    - name: Cache vcpkg binaries
+      if: matrix.dependency_mode != 'no_deps'
+      uses: actions/cache@v5
+      with:
+        path: ${{ runner.os == 'Windows' && '~/AppData/Local/vcpkg/archives' || '~/.cache/vcpkg/archives' }}
+        key: vcpkg-${{ runner.os }}-${{ hashFiles('vcpkg.json', 'vcpkg-configuration.json') }}
+        restore-keys: vcpkg-${{ runner.os }}-
+
     - name: Install vcpkg (Linux/macOS)
       if: runner.os != 'Windows' && matrix.dependency_mode != 'no_deps'
       shell: bash

.github/workflows/coverage.yml

@@ -1,63 +1,102 @@
 name: Test Coverage
 
-on: [pull_request, workflow_dispatch]
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+concurrency:
+  group: coverage-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
 
 jobs:
-  build:
+  coverage:
     name: Report Test Coverage
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+      id-token: write
 
     steps:
     - uses: actions/checkout@v6
       with:
         submodules: true
 
-    - name: Install vcpkg (Linux/macOS)
-      if: runner.os != 'Windows'
-      shell: bash
+    - name: Cache vcpkg binaries
+      uses: actions/cache@v5
+      with:
+        path: ~/.cache/vcpkg/archives
+        key: vcpkg-${{ runner.os }}-${{ hashFiles('vcpkg.json', 'vcpkg-configuration.json') }}
+        restore-keys: vcpkg-${{ runner.os }}-
+
+    - name: Install vcpkg
       run: |
         git clone https://github.com/microsoft/vcpkg.git "$HOME/vcpkg"
         "$HOME/vcpkg/bootstrap-vcpkg.sh" -disableMetrics
         echo "VCPKG_ROOT=$HOME/vcpkg" >> "$GITHUB_ENV"
         echo "$HOME/vcpkg" >> "$GITHUB_PATH"
 
-    - name: Install vcpkg (Windows)
-      if: runner.os == 'Windows'
-      shell: pwsh
+    - name: Build and test with coverage instrumentation
+      id: build
+      run: |
+        python3 setup.py --platform linux_x64 --compiler gcc --build --test --coverage --no_cov_report
+        mkdir -p coverage
+
+    - name: Generate coverage report
+      uses: threeal/gcovr-action@v1.2.0
+      with:
+        fail-under-line: 60
+        fail-under-branch: 50
+        fail-under-function: 80
+        print-summary: true
+        txt-out: coverage/coverage.txt
+        html-out: coverage/index.html
+        html-details: true
+        cobertura-out: coverage/cobertura.xml
+
+    - name: Publish coverage summary
+      if: ${{ !cancelled() && steps.build.outcome == 'success' }}
       run: |
-        git clone https://github.com/microsoft/vcpkg.git "$env:USERPROFILE\vcpkg"
-        & "$env:USERPROFILE\vcpkg\bootstrap-vcpkg.bat" -disableMetrics
-        echo "VCPKG_ROOT=$env:USERPROFILE\vcpkg" >> $env:GITHUB_ENV
-        echo "$env:USERPROFILE\vcpkg" >> $env:GITHUB_PATH
-
-    - name: Create Build Environment     
-      run: cmake -E make_directory ${{github.workspace}}/build
-
-    - name: Setup LCOV
-      uses: hrishikesh-kadam/setup-lcov@v1
-
-    - name: Configure CMake    
-      shell: bash
-      working-directory: ${{github.workspace}}/build   
-      run: cmake -DENABLE_COVERAGE=ON ..
-
-    - name: Build
-      working-directory: ${{github.workspace}}/build
-      shell: bash
-      run: cmake --build .
-
-    - name: Prepare coverage data
-      working-directory: ${{github.workspace}}/build
-      shell: bash
-      run: cmake --build . --target cov_data
-
-    - name: Report code coverage
-      uses: zgosalvez/github-actions-report-lcov@v4
+        {
+          echo '```'
+          cat coverage/coverage.txt
+          echo '```'
+        } >> "$GITHUB_STEP_SUMMARY"
+
+    - name: Upload to Codecov
+      if: ${{ !cancelled() && steps.build.outcome == 'success' }}
+      uses: codecov/codecov-action@v5
+      with:
+        files: coverage/cobertura.xml
+        use_oidc: true
+
+    - name: Upload coverage report
+      if: ${{ !cancelled() && steps.build.outcome == 'success' }}
+      uses: actions/upload-artifact@v7
       with:
-        coverage-files: build/cov.info.cleaned
-        minimum-coverage: 30
-        artifact-name: code-coverage-report
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        working-directory: ${{github.workspace}}
-        update-comment: true
+        name: code-coverage-report
+        path: coverage/
 
+    - name: Upload Pages artifact
+      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+      uses: actions/upload-pages-artifact@v4
+      with:
+        path: coverage/
+
+  publish-pages:
+    name: Publish Report to GitHub Pages
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: coverage
+    runs-on: ubuntu-24.04
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+    - id: deployment
+      uses: actions/deploy-pages@v4

.gitignore

@@ -36,3 +36,4 @@
 [Bb]uild_old/
 /gtest_build
 .DS_Store
+*.pyc

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 5.4.1
+
+### Fixed
+
+- **Remote configs caching** — fixed cached configs being re-downloaded on every launch instead of reused across sessions.
+- **Remote configs listeners** — fixed a possible crash when adding or removing a listener during session start.
+- **Custom fields** — fixed one invalid field dropping all other custom fields on the event.
+- **Resource leaks** — fixed curl handle and header list leaks, and a per-event socket leak on Linux.
+
 ## 5.4.0
 
 ### Added

CMakeLists.txt

@@ -15,7 +15,7 @@ include("create_source_groups_macro")
 include("eval_condition_macro")
 
 # --------------------------- Options --------------------------- #
-option(ENABLE_COVERAGE "Enable code coverage reporting" OFF)
+option(ENABLE_COVERAGE "Build with code coverage instrumentation" OFF)
 option(GA_SHARED_LIB "Build GA as a shared library" OFF)
 option(GA_UWP_BUILD  "Build GA for UWP (if targeting windows)" OFF)
 option(GA_BUILD_SAMPLE "Builds the GA Sample app" ON)
@@ -275,93 +275,12 @@ else()
     message(STATUS "Skipping unit tests (not available for shared library builds)")
 endif()
 
-# --------------------------- Code Coverage Setup --------------------------- #
+# --------------------------- Code Coverage Instrumentation --------------------------- #
 
-# Coverage requires tests, which are only available for static library builds
-if (ENABLE_COVERAGE AND NOT GA_SHARED_LIB)
-    find_program(GCOV_PATH gcov)
-    if (NOT GCOV_PATH)
-        message(WARNING "program gcov not found")
-    endif()
-
-    find_program(LCOV_PATH lcov)
-    if (NOT LCOV_PATH)
-        message(WARNING "program lcov not found")
-    endif()
-
-    find_program(GENHTML_PATH genhtml)
-    if (NOT GENHTML_PATH)
-        message(WARNING "program genhtml not found")
-    endif()
-
-    if (LCOV_PATH AND GCOV_PATH)
-
-        target_compile_options(
-            GameAnalytics
-            PRIVATE
-                -g -O0 -fprofile-arcs -ftest-coverage
-        )
-
-        target_link_libraries(
-            GameAnalytics PRIVATE -fprofile-arcs -ftest-coverage
-        )
-
-        set(covname cov)
-
-        add_custom_target(cov_data
-            # Cleanup lcov
-            COMMENT "Resetting code coverage counters to zero."
-            ${LCOV_PATH} --directory . --zerocounters
-
-            # Run tests
-            COMMAND GameAnalyticsUnitTests
-
-            # Capturing lcov counters and generating report
-
-            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)
-            add_custom_target(cov
-
-                # Cleanup lcov
-                ${LCOV_PATH} --directory . --zerocounters
-
-                # Run tests
-                COMMAND GameAnalyticsUnitTests
-
-                # Capturing lcov counters and generating report
-                COMMAND ${LCOV_PATH} --directory . --capture --output-file ${covname}.info --rc lcov_branch_coverage=1 --rc derive_function_end_line=0
-                COMMAND ${LCOV_PATH} --remove ${covname}.info
-                                    '${CMAKE_SOURCE_DIR}/source/dependencies/*'
-                                    '/usr/*'
-                                    --output-file ${covname}.info.cleaned
-                                    --rc lcov_branch_coverage=1 
-                                    --rc derive_function_end_line=0
-                COMMAND ${GENHTML_PATH} -o ${covname} ${covname}.info.cleaned --rc lcov_branch_coverage=1 --rc derive_function_end_line=0
-                COMMAND ${CMAKE_COMMAND} -E remove ${covname}.info ${covname}.info.cleaned
-
-                COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."
-            )
-        else()
-            message(WARNING "unable to generate coverage report: missing genhtml")
-        endif()
-
-    else()
-        message(WARNING "unable to add coverage targets: missing coverage tools")
+if(ENABLE_COVERAGE)
+    if(GA_SHARED_LIB)
+        message(FATAL_ERROR "ENABLE_COVERAGE requires a static library build (coverage is measured through the unit tests)")
     endif()
+    target_compile_options(GameAnalytics PRIVATE -g -O0 --coverage -fprofile-update=atomic)
+    target_link_options(GameAnalytics PUBLIC --coverage)
 endif()

README.md

@@ -1,6 +1,8 @@
 GA-SDK-CPP
 ==========
 
+[![codecov](https://codecov.io/gh/GameAnalytics/gameanalytics-sdk-cpp/branch/main/graph/badge.svg)](https://codecov.io/gh/GameAnalytics/gameanalytics-sdk-cpp)
+
 GameAnalytics C++ SDK
 
 Documentation can be found [here](https://gameanalytics.com/docs/cpp-sdk).
@@ -42,7 +44,7 @@ python setup.py --platform {linux_x64,linux_x86,osx,win32,win64,uwp} [--cfg {Rel
 | `--shared` | — | Build a shared library (`.dll`/`.so`/`.dylib`) instead of a static library |
 | `--build` | — | Execute the build step |
 | `--test` | — | Execute the test step (not available with `--shared`) |
-| `--coverage` | — | Generate code coverage report (not available with `--shared`) |
+| `--coverage` | — | Build with coverage instrumentation and generate an HTML report in `build/coverage/` (requires `--build --test`; not available with `--shared`; needs [gcovr](https://gcovr.com) installed) |
 
 #### Examples
 

gcovr.cfg

@@ -0,0 +1,4 @@
+filter = source/gameanalytics/
+filter = include/GameAnalytics/
+exclude = source/gameanalytics/Platform/
+exclude-throw-branches = yes

setup.py

@@ -4,6 +4,7 @@
 import shutil
 import glob
 import platform as Platform
+import webbrowser
 
 def run_command(command, shell=True, cwd=None):
 	if os.name == 'nt':  # Check if the OS is Windows
@@ -34,7 +35,8 @@ def main():
 	parser.add_argument('--shared', action='store_true', help='Build shared library instead of static')
 	parser.add_argument('--build', action='store_true', help='Execute the build step')
 	parser.add_argument('--test', action='store_true', help='Execute the test step')
-	parser.add_argument('--coverage', action='store_true', help='Generate code coverage report')
+	parser.add_argument('--coverage', action='store_true', help='Build with coverage instrumentation and generate a coverage report')
+	parser.add_argument('--no_cov_report', action='store_true', help='Skip the local coverage report generation (used on CI where gcovr runs separately)')
 	parser.add_argument('--no_vcpkg', action='store_true', help='Do not download vcpkg packages')
 	parser.add_argument('--no_curl', action='store_true', help='Compile the SDK without CURL (you will need to provide a custom HTTP client implementation)')
 
@@ -44,10 +46,15 @@ def main():
 	if args.compiler and not args.platform.startswith('linux'):
 		parser.error('--compiler can only be used with Linux platforms')
 
-	# Validate coverage is not used with shared library
 	if args.coverage and args.shared:
 		parser.error('--coverage cannot be used with --shared (coverage requires tests which need static library)')
 
+	if args.coverage and not (args.build and args.test):
+		parser.error('--coverage requires --build and --test')
+
+	if args.no_cov_report and not args.coverage:
+		parser.error('--no_cov_report requires --coverage')
+
 	# Get compiler configuration for this platform (single compiler, like cmake.yml)
 	compiler_config = get_compiler_for_platform(args.platform, args.compiler)
 	c_compiler = compiler_config.get('c', '')
@@ -123,7 +130,7 @@ def main():
 		cmake_command += f' -DPLATFORM:STRING={args.platform}'
 	if args.coverage:
 		cmake_command += ' -DENABLE_COVERAGE=ON'
-  
+
 	run_command(cmake_command)
 
 	# Build
@@ -138,10 +145,19 @@ def main():
 	else:
 		exit(0)
 
-	# Code Coverage
-	if args.coverage:
-		# Prepare coverage data
-		run_command(f'cmake --build {build_output_dir} --target cov', cwd=build_output_dir)
+	# Code Coverage Report
+	if args.coverage and not args.no_cov_report:
+		coverage_dir = os.path.join(build_output_dir, 'coverage')
+		os.makedirs(coverage_dir, exist_ok=True)
+		report_path = os.path.join(coverage_dir, 'index.html')
+		gcovr_command = f'gcovr --print-summary --html-details {report_path}'
+		if args.platform == 'osx':
+			gcovr_command += ' --gcov-executable "xcrun llvm-cov gcov"'
+		elif cxx_compiler == 'clang++':
+			gcovr_command += ' --gcov-executable "llvm-cov gcov"'
+		run_command(gcovr_command)
+		print(f"\nCoverage report: {report_path}\n")
+		webbrowser.open(f'file://{report_path}')
 
 	# Package Build Artifacts
 	package_dir = os.path.join(build_output_dir, 'package')

source/gameanalytics/GACommon.h

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