Staging 23.2.2

.github/workflows/release_notice.yml

@@ -0,0 +1,39 @@
+name: Release Notice
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # To check the github context
+      - name: Dump Github context
+        env:
+          GITHUB_CONTEXT: ${{ toJSON(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - name: Send custom JSON data to Slack workflow
+        id: slack
+        uses: slackapi/[email protected]
+        with:
+          # This data can be any valid JSON from a previous step in the GitHub Action
+          payload: |
+            {
+              "repository": "${{ github.repository }}",
+              "tag_name": "${{ github.event.release.tag_name }}",
+              "actor": "${{ github.actor }}",
+              "body": ${{ toJSON(github.event.release.body) }},
+              "html_url": "${{ github.event.release.html_url }}"
+            }
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_RELEASE }}
+      - name: Send custom JSON data to Discord
+        uses: sarisia/[email protected]
+        with:
+          webhook: ${{ secrets.DISCORD_WEBHOOK_URL }}
+          nodetail: true
+          title: New ${{ github.repository }} version ${{ github.event.release.tag_name }} published by ${{ github.actor }}
+          description: |
+            Release URL: ${{ github.event.release.html_url }}
+            Click [here](https://github.com/Countly/countly-server/blob/master/CHANGELOG.md) to view the change log.
+            `${{ github.event.release.body }}`

.github/workflows/tests.yml

@@ -14,26 +14,26 @@ jobs:
       fail-fast: false
       matrix:
         os:
-          - ubuntu-20.04
-          - macos-11.0
-          - windows-2019
+          - ubuntu-22.04
+          - macos-15
+          - windows-2022
 
         include:
-          - os: windows-2019
-            cmake-generator: -G "Visual Studio 16 2019" -A x64
-            cmake-install: "choco install -y cmake"
-            dependencies: |
-              choco install -y openssl
-              choco install -y visualstudio2017-workload-vctools
-              choco upgrade -y visualstudio2017-workload-vctools
-            make: msbuild  countly-tests.vcxproj -t:rebuild -verbosity:diag -property:Configuration=Release && .\Release\countly-tests.exe
-          - os: macos-11.0
-            cmake-install: "brew install cmake"
-            dependencies: "brew install openssl"
+          - 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-20.04
-            cmake-install: "sudo apt-get update && sudo apt-get install -y cmake"
-            dependencies: "sudo apt-get update && sudo apt-get install -y libcurl4-openssl-dev"
+          - 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
 
     steps:
@@ -52,11 +52,13 @@ jobs:
         run: ${{ matrix.dependencies }}
 
       - name: Set up MSVC
-        if: matrix.os == 'windows-2019'
+        if: matrix.os == 'windows-2022'
         uses: microsoft/setup-msbuild@v1
 
       - name: Build and run tests
         run: |
           cmake -DCOUNTLY_BUILD_TESTS=1 -B build . ${{ matrix.cmake-generator }}
           cd build
           ${{ matrix.make }}
+        env:
+          CMAKE_POLICY_VERSION_MINIMUM: 3.31

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 23.2.2
+- Mitigated a mutex issue that can happen during update loop.
+
+## 23.2.1
+- Added manual session control via "Countly::enableManualSessionControl". When enabled, automatic session calls are ignored, while manual calls remain usable for finer control.
+- Added "checkRQSize" function to return the current number of requests in the queue.
+
 ## 23.2.0
 - Request queue processing now is limited to 100 requests at a time
 - Added 'setEventsToRQThreshold' method that sets the number of events after which all events will be sent to the RQ. Default value is set to 100.

README.md

@@ -1,4 +1,4 @@
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/f3268a85b0034b68aa4fc47c9dce596c)](https://www.codacy.com/gh/Countly/countly-sdk-cpp/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Countly/countly-sdk-cpp&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/f3268a85b0034b68aa4fc47c9dce596c)](https://app.codacy.com/gh/Countly/countly-sdk-cpp/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 
 # Countly C++ SDK
 

examples/example_integration.cpp

@@ -30,6 +30,115 @@ void printLog(LogLevel level, const string &msg) {
   cout << lvl << msg << endl;
 }
 
+// // Callback function to write response data
+// static size_t WriteCallback(void *contents, size_t size, size_t nmemb, void *userp) {
+//     ((std::string*)userp)->append((char*)contents, size * nmemb);
+//     return size * nmemb;
+// }
+
+// // Custom HTTP client for macOS
+// HTTPResponse customClient(bool use_post, const std::string &path, const std::string &data) {
+//   HTTPResponse response;
+//   response.success = false;
+//   cout << "Making real HTTP request to: " << path << endl;
+
+//   CURL *curl;
+//   CURLcode res;
+//   std::string readBuffer;
+
+//   curl = curl_easy_init();
+//   if(curl) {
+//     // Set URL
+//     curl_easy_setopt(curl, CURLOPT_URL, path.c_str());
+
+//     // Set callback function to write data
+//     curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
+//     curl_easy_setopt(curl, CURLOPT_WRITEDATA, &readBuffer);
+
+//     // Set timeout
+//     curl_easy_setopt(curl, CURLOPT_TIMEOUT, 30L);
+
+//     // Follow redirects
+//     curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
+
+//     // SSL verification (set to 0 for testing, 1 for production)
+//     curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);
+//     curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L);
+
+//     // Set User-Agent
+//     curl_easy_setopt(curl, CURLOPT_USERAGENT, "Countly-SDK-CPP/1.0");
+
+//     if (use_post) {
+//       // Set POST method
+//       curl_easy_setopt(curl, CURLOPT_POST, 1L);
+
+//       if (!data.empty()) {
+//         // Set POST data
+//         curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data.c_str());
+//         curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, data.length());
+//       }
+
+//       // Set content type for POST
+//       struct curl_slist *headers = NULL;
+//       headers = curl_slist_append(headers, "Content-Type: application/x-www-form-urlencoded");
+//       curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
+//     } else {
+//       // For GET requests, append data as query parameters
+//       if (!data.empty()) {
+//         std::string fullUrl = path;
+//         fullUrl += (path.find('?') != std::string::npos) ? "&" : "?";
+//         fullUrl += data;
+//         curl_easy_setopt(curl, CURLOPT_URL, fullUrl.c_str());
+//       }
+//     }
+
+//     // Perform the request
+//     res = curl_easy_perform(curl);
+
+//     if(res != CURLE_OK) {
+//       cout << "curl_easy_perform() failed: " << curl_easy_strerror(res) << endl;
+//     } else {
+//       // Get response code
+//       long response_code;
+//       curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &response_code);
+
+//       cout << "HTTP Response Code: " << response_code << endl;
+//       cout << "Raw response: " << readBuffer << endl;
+
+//       // Check if HTTP request was successful (2xx status codes)
+//       if (response_code >= 200 && response_code < 300) {
+//         // Check if response contains { result: 'Success' } or {"result":"Success"}
+//         if (readBuffer.find("\"result\"") != std::string::npos && 
+//             (readBuffer.find("\"Success\"") != std::string::npos || 
+//              readBuffer.find("'Success'") != std::string::npos)) {
+//           response.success = true;
+//           cout << "Success response detected!" << endl;
+//         } else {
+//           cout << "Response does not indicate success" << endl;
+//         }
+
+//         // Parse as JSON
+//         try {
+//           response.data = nlohmann::json::parse(readBuffer);
+//         } catch (const std::exception& e) {
+//           cout << "Failed to parse JSON response: " << e.what() << endl;
+//           response.data = nlohmann::json::object();
+//         }
+//       } else {
+//         cout << "HTTP request failed with code: " << response_code << endl;
+//       }
+//     }
+
+//     // Cleanup
+//     curl_easy_cleanup(curl);
+//   } else {
+//     cout << "Failed to initialize curl" << endl;
+//   }
+
+//   cout << "Request completed. Success: " << (response.success ? "true" : "false") << endl;
+//   return response;
+// }
+
 int main() {
   cout << "Sample App" << endl;
   Countly &ct = Countly::getInstance();
@@ -38,7 +147,10 @@ int main() {
   // Please refer to the documentation for more information:
   // https://support.count.ly/hc/en-us/articles/4416163384857-C-
 
-  ct.alwaysUsePost(true);
+  // Custom HTTP client
+  // HTTPClientFunction clientPtr = customClient;
+  // ct.setHTTPClient(clientPtr);
+  // ct.alwaysUsePost(true);
   ct.setLogger(printLog);
   ct.SetPath("databaseFileName.db"); // this will be only built into account if the correct configurations are set
   ct.setDeviceID("test-device-id");
@@ -47,7 +159,14 @@ int main() {
   ct.SetMetrics("Windows 10", "10.22", "Mac", "800x600", "Carrier", "1.0");
 
   // start the SDK (initialize the SDK)
-  ct.start("YOUR_APP_KEY", "https://try.count.ly", 443, true);
+  string _appKey = "YOUR_APP_KEY";
+  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;
+  }
+
+  ct.start(_appKey, _serverUrl, 443, true);
 
   ct.setAutomaticSessionUpdateInterval(5);// The value is set so low just for internal validation.
   ct.setMaxRQProcessingBatchSize(2); // in most cases not needed to be set. The value is set so low just for internal validation

include/countly.hpp

@@ -56,6 +56,8 @@ class Countly : public cly::CountlyDelegates {
 
   void setSha256(cly::SHA256Function fun);
 
+  void enableManualSessionControl();
+
   void setHTTPClient(HTTPClientFunction fun);
 
   void setMetrics(const std::string &os, const std::string &os_version, const std::string &device, const std::string &resolution, const std::string &carrier, const std::string &app_version);
@@ -105,6 +107,11 @@ class Countly : public cly::CountlyDelegates {
    */
   int checkEQSize();
 
+  /*
+   * Checks and returns the size of the request queue in memory or persistent storage.
+   */
+  int checkRQSize();
+
   /**
    * Checks and returns the size of the event queue in persistent storage.
    */
@@ -319,6 +326,7 @@ class Countly : public cly::CountlyDelegates {
   std::chrono::system_clock::duration getSessionDuration();
 
   void updateLoop();
+  void packEvents();
   bool began_session = false;
   bool is_being_disposed = false;
   bool is_sdk_initialized = false;

include/countly/constants.hpp

@@ -13,7 +13,7 @@
 #include <string>
 
 #define COUNTLY_SDK_NAME "cpp-native-unknown"
-#define COUNTLY_SDK_VERSION "23.2.0"
+#define COUNTLY_SDK_VERSION "23.2.2"
 #define COUNTLY_POST_THRESHOLD 2000
 #define COUNTLY_KEEPALIVE_INTERVAL 3000
 #define COUNTLY_MAX_EVENTS_DEFAULT 200

include/countly/countly_configuration.hpp

@@ -68,6 +68,8 @@ struct CountlyConfiguration {
 
   SHA256Function sha256_function = nullptr;
 
+  bool manualSessionControl = false;
+
   HTTPClientFunction http_client_function = nullptr;
 
   nlohmann::json metrics;

include/countly/request_module.hpp

@@ -35,6 +35,8 @@ class RequestModule {
    */
   void clearRequestQueue();
 
+  long long RQSize();
+
 private:
   class RequestModuleImpl;
   std::unique_ptr<RequestModuleImpl> impl;