Staging 26.1.0

.github/workflows/tests.yml

@@ -7,58 +7,271 @@ on:
     branches: [master, staging]
 
 jobs:
-  doctests:
+  # ──────────────────────────────────────────────
+  # Core test matrix: OS × SQLite
+  # ──────────────────────────────────────────────
+  tests:
     runs-on: ${{ matrix.os }}
     timeout-minutes: 120
     strategy:
       fail-fast: false
       matrix:
-        os:
-          - ubuntu-22.04
-          - macos-15
-          - windows-2022
-
-        include:
+        os: [ubuntu-22.04, ubuntu-24.04, macos-15, windows-2022]
+        sqlite: [OFF, ON]
+        exclude:
+          # Windows has no system sqlite3.lib
           - os: windows-2022
-            cmake-generator: -G "Visual Studio 17 2022" -A x64
-            cmake-install: "" #Already installed on hosted runner
-            dependencies: "" #Already installed on hosted runner
-            make: msbuild countly-tests.vcxproj -t:rebuild -verbosity:diag -property:Configuration=Release && .\Release\countly-tests.exe
-          - os: macos-15
-            cmake-install: "" #Already installed on hosted runner
-            dependencies: "" #Already installed on hosted runner
-            make: make ./countly-tests && ./countly-tests
-          - os: ubuntu-22.04
-            cmake-install: "" #Already installed on hosted runner
-            dependencies: |
-              sudo apt-get update && sudo apt-get install -y \
-                libcurl4-openssl-dev \
-                libssl-dev
-            make: make ./countly-tests && ./countly-tests
+            sqlite: ON
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           submodules: "recursive"
 
-      - name: Update submodules
-        run: git submodule update --init --recursive
+      - name: Install dependencies (Ubuntu)
+        if: startsWith(matrix.os, 'ubuntu')
+        run: |
+          sudo apt-get update && sudo apt-get install -y \
+            libcurl4-openssl-dev \
+            libssl-dev \
+            libsqlite3-dev
 
-      - name: Install CMake
-        run: ${{ matrix.cmake-install }}
+      - name: Set up MSVC
+        if: matrix.os == 'windows-2022'
+        uses: microsoft/setup-msbuild@v2
 
-      - name: Install dependencies
-        run: ${{ matrix.dependencies }}
+      - name: Configure (Unix)
+        if: matrix.os != 'windows-2022'
+        run: cmake -DCOUNTLY_BUILD_TESTS=1 -DCOUNTLY_USE_SQLITE=${{ matrix.sqlite }} -B build .
+        env:
+          CMAKE_POLICY_VERSION_MINIMUM: "3.31"
 
-      - name: Set up MSVC
+      - name: Configure (Windows)
         if: matrix.os == 'windows-2022'
-        uses: microsoft/setup-msbuild@v1
+        run: cmake -DCOUNTLY_BUILD_TESTS=1 -DCOUNTLY_USE_SQLITE=${{ matrix.sqlite }} -G "Visual Studio 17 2022" -A x64 -B build .
+        env:
+          CMAKE_POLICY_VERSION_MINIMUM: "3.31"
+
+      - name: Build (Unix)
+        if: matrix.os != 'windows-2022'
+        run: cd build && make ./countly-tests
+
+      - name: Build (Windows)
+        if: matrix.os == 'windows-2022'
+        run: cd build && msbuild countly-tests.vcxproj -t:rebuild -verbosity:minimal -property:Configuration=Release
+
+      - name: Run tests (Unix)
+        if: matrix.os != 'windows-2022'
+        run: cd build && ./countly-tests
+
+      - name: Run tests (Windows)
+        if: matrix.os == 'windows-2022'
+        run: cd build && .\Release\countly-tests.exe
+
+  # ──────────────────────────────────────────────
+  # Sanitizers (Linux only, with SQLite)
+  # ──────────────────────────────────────────────
+  sanitizer-asan:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 120
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update && sudo apt-get install -y \
+            libcurl4-openssl-dev \
+            libssl-dev \
+            libsqlite3-dev
+
+      - name: Configure with ASAN
+        run: |
+          cmake -DCOUNTLY_BUILD_TESTS=1 -DCOUNTLY_USE_SQLITE=ON \
+            -DCMAKE_CXX_FLAGS="-fsanitize=address -fno-omit-frame-pointer" \
+            -DCMAKE_EXE_LINKER_FLAGS="-fsanitize=address" \
+            -DCMAKE_SHARED_LINKER_FLAGS="-fsanitize=address" \
+            -B build .
+        env:
+          CMAKE_POLICY_VERSION_MINIMUM: "3.31"
+
+      - name: Build
+        run: cd build && make ./countly-tests
+
+      - name: Run tests
+        run: cd build && ./countly-tests
+        env:
+          ASAN_OPTIONS: "detect_leaks=1"
+
+  sanitizer-tsan:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 120
+    # TSAN detects known threading issues tracked for future refactor.
+    # Runs for visibility but does not block the pipeline.
+    continue-on-error: true
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update && sudo apt-get install -y \
+            libcurl4-openssl-dev \
+            libssl-dev \
+            libsqlite3-dev
+
+      - name: Configure with TSAN
+        run: |
+          cmake -DCOUNTLY_BUILD_TESTS=1 -DCOUNTLY_USE_SQLITE=ON \
+            -DCMAKE_CXX_FLAGS="-fsanitize=thread" \
+            -DCMAKE_EXE_LINKER_FLAGS="-fsanitize=thread" \
+            -DCMAKE_SHARED_LINKER_FLAGS="-fsanitize=thread" \
+            -B build .
+        env:
+          CMAKE_POLICY_VERSION_MINIMUM: "3.31"
+
+      - name: Build
+        run: cd build && make ./countly-tests
+
+      - name: Run tests
+        run: cd build && ./countly-tests
+        env:
+          TSAN_OPTIONS: "second_deadlock_stack=1"
+
+  sanitizer-ubsan:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 120
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update && sudo apt-get install -y \
+            libcurl4-openssl-dev \
+            libssl-dev \
+            libsqlite3-dev
 
-      - name: Build and run tests
+      - name: Configure with UBSAN
         run: |
-          cmake -DCOUNTLY_BUILD_TESTS=1 -B build . ${{ matrix.cmake-generator }}
-          cd build
-          ${{ matrix.make }}
+          cmake -DCOUNTLY_BUILD_TESTS=1 -DCOUNTLY_USE_SQLITE=ON \
+            -DCMAKE_CXX_FLAGS="-fsanitize=undefined -fno-sanitize-recover=all" \
+            -DCMAKE_EXE_LINKER_FLAGS="-fsanitize=undefined" \
+            -DCMAKE_SHARED_LINKER_FLAGS="-fsanitize=undefined" \
+            -B build .
+        env:
+          CMAKE_POLICY_VERSION_MINIMUM: "3.31"
+
+      - name: Build
+        run: cd build && make ./countly-tests
+
+      - name: Run tests
+        run: cd build && ./countly-tests
         env:
-          CMAKE_POLICY_VERSION_MINIMUM: 3.31
+          UBSAN_OPTIONS: "print_stacktrace=1"
+
+  # ──────────────────────────────────────────────
+  # Static library build (custom HTTP, no curl)
+  # ──────────────────────────────────────────────
+  static-build:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 120
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update && sudo apt-get install -y \
+            libssl-dev \
+            libsqlite3-dev
+
+      - name: Configure static build
+        run: |
+          cmake -DCOUNTLY_BUILD_TESTS=1 -DCOUNTLY_USE_SQLITE=ON \
+            -DBUILD_SHARED_LIBS=OFF -DCOUNTLY_USE_CUSTOM_HTTP=ON \
+            -B build .
+        env:
+          CMAKE_POLICY_VERSION_MINIMUM: "3.31"
+
+      - name: Build
+        run: cd build && make ./countly-tests
+
+      - name: Run tests
+        run: cd build && ./countly-tests
+
+  # ──────────────────────────────────────────────
+  # C++17 compatibility check
+  # ──────────────────────────────────────────────
+  cpp17:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 120
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update && sudo apt-get install -y \
+            libcurl4-openssl-dev \
+            libssl-dev \
+            libsqlite3-dev
+
+      - name: Configure with C++17
+        run: |
+          cmake -DCOUNTLY_BUILD_TESTS=1 -DCOUNTLY_USE_SQLITE=ON \
+            -DCMAKE_CXX_STANDARD=17 \
+            -B build .
+        env:
+          CMAKE_POLICY_VERSION_MINIMUM: "3.31"
+
+      - name: Build
+        run: cd build && make ./countly-tests
+
+      - name: Run tests
+        run: cd build && ./countly-tests
+
+  # ──────────────────────────────────────────────
+  # Clang on Linux
+  # ──────────────────────────────────────────────
+  clang-linux:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 120
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update && sudo apt-get install -y \
+            clang \
+            libcurl4-openssl-dev \
+            libssl-dev \
+            libsqlite3-dev
+
+      - name: Configure with Clang
+        run: |
+          cmake -DCOUNTLY_BUILD_TESTS=1 -DCOUNTLY_USE_SQLITE=ON \
+            -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ \
+            -B build .
+        env:
+          CMAKE_POLICY_VERSION_MINIMUM: "3.31"
+
+      - name: Build
+        run: cd build && make ./countly-tests
+
+      - name: Run tests
+        run: cd build && ./countly-tests

.gitignore

@@ -20,3 +20,7 @@ compile_commands.json
 CTestTestfile.cmake
 _deps
 cmake-build-debug/
+
+.DS_Store
+test_results_*.log
+*.db

CHANGELOG.md

@@ -1,3 +1,17 @@
+## 26.1.0
+- ! Minor breaking change ! SDK Behavior Settings is now enabled by default. Changes made on SDK Manager > SDK Behavior Settings on your server will affect SDK behavior directly.
+
+- Added `enableImmediateRequestOnStop` configuration option. When enabled, the update loop uses a condition variable instead of polling, allowing `stop()` and `setUpdateInterval()` to take effect immediately rather than waiting for the current sleep interval to expire.
+- Added init config method "disableSDKBehaviorSettingsUpdates" to disable periodic SBS updates from the server.
+- Added init config method "setSDKBehaviorSettings" to provide server configuration in JSON format during initialization.
+
+- Fixed OpenSSL discovery in CMakeLists.txt to dynamically resolve the Homebrew prefix, supporting both Apple Silicon and Intel Macs.
+- Added `dow` (day of week) and `hour` fields to every event.
+- Added `dow`, `hour`, and `tz` (timezone offset in minutes) fields to every request.
+
+## 23.2.4
+- Mitigated an issue where cached events were not queued when a user property was recorded.
+
 ## 23.2.3
 - Mitigated an issue where the new device ID was used when ending a session if device ID was changed without merging.
 

CMakeLists.txt

@@ -48,7 +48,8 @@ add_library(countly
   ${CMAKE_CURRENT_SOURCE_DIR}/src/request_builder.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/src/storage_module_db.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/src/storage_module_memory.cpp
-  ${CMAKE_CURRENT_SOURCE_DIR}/src/event.cpp)
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/event.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/configuration_module.cpp)
 
 target_include_directories(countly
   PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
@@ -75,7 +76,10 @@ if (COUNTLY_USE_CUSTOM_SHA256)
 else()
 if (APPLE)
   message("Setting openssl root for Mac")
-  set(OPENSSL_ROOT_DIR "/usr/local/opt/openssl")
+  execute_process(COMMAND brew --prefix openssl OUTPUT_VARIABLE OPENSSL_ROOT_DIR OUTPUT_STRIP_TRAILING_WHITESPACE)
+  if(NOT OPENSSL_ROOT_DIR)
+    set(OPENSSL_ROOT_DIR "/usr/local/opt/openssl")
+  endif()
 endif()
 find_package(OpenSSL REQUIRED)
 target_include_directories(countly PRIVATE ${OPENSSL_INCLUDE_DIR})
@@ -113,7 +117,9 @@ if(COUNTLY_BUILD_TESTS)
     ${CMAKE_CURRENT_SOURCE_DIR}/tests/event.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/tests/crash.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/tests/request.cpp
-    ${CMAKE_CURRENT_SOURCE_DIR}/tests/config.cpp)
+    ${CMAKE_CURRENT_SOURCE_DIR}/tests/config.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/tests/immediate_stop.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/tests/sbs.cpp)
 
     target_compile_options(countly-tests PRIVATE -g)
     target_compile_definitions(countly-tests PRIVATE COUNTLY_BUILD_TESTS)
@@ -154,4 +160,4 @@ endif()
     CXX_EXTENSIONS NO)
 endif()
 
-install(TARGETS countly ARCHIVE DESTINATION lib PUBLIC_HEADER DESTINATION include/countly)
+install(TARGETS countly ARCHIVE DESTINATION lib PUBLIC_HEADER DESTINATION include/countly)

examples/example_integration.cpp

@@ -163,7 +163,7 @@ int main() {
   string _serverUrl = "https://your.server.ly";
 
   if(_appKey.compare("YOUR_APP_KEY") == 0 || _serverUrl.compare("https://your.server.ly") == 0) {
-    cerr << "Please do not use default set of app key and server url" << endl;
+    printLog(LogLevel::WARNING, "[ExampleIntegration] Please do not use default set of app key and server url");
   }
 
   ct.start(_appKey, _serverUrl, 443, true);
@@ -276,7 +276,7 @@ int main() {
       flag = false;
       break;
     default:
-      cout << "Option not found!" << endl;
+      printLog(LogLevel::DEBUG, "[ExampleIntegration] Please do not use default set of app key and server url");
       break;
     }
   }