SDK Behavior Settings

.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,6 @@
+## XX.XX.XX
+- ! 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.
+
 ## 23.2.4
 - Mitigated an issue where cached events were not queued when a user property was recorded.
 

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>

include/countly.hpp

@@ -24,6 +24,8 @@
 #include "countly/logger_module.hpp"
 #include "countly/storage_module_base.hpp"
 #include "countly/views_module.hpp"
+#include <countly/configuration_module.hpp>
+#include <countly/configuration_provider.hpp>
 #include <countly/crash_module.hpp>
 #include <countly/request_builder.hpp>
 #include <countly/request_module.hpp>
@@ -257,6 +259,8 @@ class Countly : public cly::CountlyDelegates {
     addEvent(event);
   }
 
+  void RecordLocation(const std::string &countryCode, const std::string &city, const std::string &gpsCoordinates, const std::string &ipAddress) override { setLocation(countryCode, city, gpsCoordinates, ipAddress); };
+
   /* Provide 'updateInterval' in seconds. */
   inline void setAutomaticSessionUpdateInterval(unsigned short updateInterval) {
     if (is_sdk_initialized) {
@@ -267,6 +271,35 @@ class Countly : public cly::CountlyDelegates {
     configuration->sessionDuration = updateInterval;
   }
 
+  /**
+   * Disable SDK behavior settings updates that SDK performs periodically from the server.
+   */
+  void disableSDKBehaviorSettingsUpdates() {
+    if (is_sdk_initialized) {
+      log(LogLevel::WARNING, "[Countly] disableSDKBehaviorSettingsUpdates, You can not disable SDK behavior settings updates after SDK initialization.");
+      return;
+    }
+
+    configuration->sdkBehaviorSettingsUpdatesDisabled = true;
+  }
+
+  /**
+   * Provide SDK behavior settings in JSON format string.
+   */
+  void setSDKBehaviorSettings(std::string &settings_json) {
+    if (is_sdk_initialized) {
+      log(LogLevel::WARNING, "[Countly] setSDKBehaviorSettings, You can not provide SDK behavior settings after SDK initialization.");
+      return;
+    }
+
+    if(settings_json.empty()) {
+      log(LogLevel::WARNING, "[Countly] setSDKBehaviorSettings, Provided SDK behavior settings is empty.");
+      return;
+    }
+
+    configuration->sdkBehaviorSettings = settings_json;
+  }
+
 #ifdef COUNTLY_BUILD_TESTS
   /**
    * Convert event queue into list.
@@ -345,6 +378,7 @@ class Countly : public cly::CountlyDelegates {
   std::shared_ptr<cly::RequestBuilder> requestBuilder;
   std::shared_ptr<cly::RequestModule> requestModule;
   std::shared_ptr<cly::StorageModuleBase> storageModule;
+  std::shared_ptr<cly::ConfigurationModule> configurationModule;
   std::shared_ptr<std::mutex> mutex = std::make_shared<std::mutex>();
 
   bool is_queue_being_processed = false;

include/countly/configuration_module.hpp

@@ -0,0 +1,42 @@
+#ifndef CONFIGURATION_MODULE_HPP_
+#define CONFIGURATION_MODULE_HPP_
+
+#include "countly/configuration_provider.hpp"
+#include "countly/constants.hpp"
+#include "countly/countly_configuration.hpp"
+#include "countly/logger_module.hpp"
+#include "countly/request_builder.hpp"
+#include "countly/request_module.hpp"
+#include "countly/storage_module_base.hpp"
+
+namespace cly {
+class ConfigurationModule : public ConfigurationProvider {
+
+public:
+  ~ConfigurationModule();
+  ConfigurationModule(cly::CountlyDelegates *cly, std::shared_ptr<CountlyConfiguration> config, std::shared_ptr<LoggerModule> logger, std::shared_ptr<RequestBuilder> requestBuilder, std::shared_ptr<StorageModuleBase> storageModule, std::shared_ptr<RequestModule> requestModule,
+                      std::shared_ptr<std::mutex> mutex);
+
+  void fetchConfigFromServer(nlohmann::json session_params);
+  void fetchConfigFromStorage();
+  void startServerConfigUpdateTimer(nlohmann::json session_params);
+  void stopTimer();
+  bool isTrackingEnabled() const override;
+  bool isNetworkingEnabled() const override;
+
+  bool isLocationTrackingEnabled();
+  bool isViewTrackingEnabled() const override;
+  bool isSessionTrackingEnabled();
+  bool isCustomEventTrackingEnabled();
+  bool isCrashReportingEnabled() const override;
+
+  unsigned int getRequestQueueSizeLimit() const override;
+  unsigned int getEventQueueSizeLimit();
+  unsigned int getSessionUpdateInterval();
+
+private:
+  class ConfigurationModuleImpl;
+  std::unique_ptr<ConfigurationModuleImpl> impl;
+};
+} // namespace cly
+#endif

include/countly/configuration_provider.hpp

@@ -0,0 +1,16 @@
+#ifndef CONFIGURATION_PROVIDER_HPP_
+#define CONFIGURATION_PROVIDER_HPP_
+namespace cly {
+
+class ConfigurationProvider {
+public:
+    virtual ~ConfigurationProvider() = default;
+
+    virtual bool isNetworkingEnabled() const = 0;
+    virtual bool isTrackingEnabled() const = 0;
+    virtual bool isCrashReportingEnabled() const = 0;
+    virtual bool isViewTrackingEnabled() const = 0;
+    virtual unsigned int getRequestQueueSizeLimit() const = 0;
+};
+} // namespace cly
+#endif

include/countly/constants.hpp

@@ -93,6 +93,8 @@ class CountlyDelegates {
   virtual void RecordEvent(const std::string &key, const std::map<std::string, std::string> &segmentation, int count, double sum) = 0;
 
   virtual void RecordEvent(const std::string &key, const std::map<std::string, std::string> &segmentation, int count, double sum, double duration) = 0;
+
+  virtual void RecordLocation(const std::string &countryCode, const std::string &city, const std::string &gpsCoordinates, const std::string &ipAddress) = 0;
 };
 
 } // namespace cly

include/countly/countly_configuration.hpp

@@ -76,6 +76,10 @@ struct CountlyConfiguration {
 
   nlohmann::json metrics;
 
+  bool sdkBehaviorSettingsUpdatesDisabled = false;
+
+  std::string sdkBehaviorSettings;
+
   CountlyConfiguration(const std::string appKey, std::string serverUrl) {
     this->appKey = appKey;
     this->serverUrl = serverUrl;

include/countly/crash_module.hpp

@@ -35,8 +35,10 @@ class CrashModule {
   void recordException(const std::string &title, const std::string &stackTrace, const bool fatal, const std::map<std::string, std::string> &crashMetrics, const std::map<std::string, std::string> &segmentation = {});
 
 private:
+  friend class Countly;
   class CrashModuleImpl;
   std::unique_ptr<CrashModuleImpl> impl;
+  void setConfigurationProvider(std::weak_ptr<ConfigurationProvider> provider); // try injecting
 };
 } // namespace cly
 #endif

include/countly/request_module.hpp

@@ -9,6 +9,7 @@
 #include "countly/logger_module.hpp"
 #include "countly/request_builder.hpp"
 #include "countly/storage_module_base.hpp"
+#include "countly/configuration_provider.hpp"
 
 namespace cly {
 class RequestModule {
@@ -36,10 +37,12 @@ class RequestModule {
   void clearRequestQueue();
 
   long long RQSize();
+  void setConfigurationProvider(std::weak_ptr<ConfigurationProvider> provider); // try injecting
 
 private:
   class RequestModuleImpl;
   std::unique_ptr<RequestModuleImpl> impl;
+  std::weak_ptr<ConfigurationProvider> _configProvider;
 };
 } // namespace cly
 #endif

include/countly/storage_module_base.hpp

@@ -94,6 +94,10 @@ class StorageModuleBase {
    * @param request: content of the request
    */
   virtual void RQInsertAtEnd(const std::string &request) = 0;
+
+  virtual void storeSDKBehaviorSettings(const std::string &sdk_behavior_settings) = 0;
+
+  virtual std::string getSDKBehaviorSettings() = 0;
 };
 
 } // namespace cly

include/countly/storage_module_db.hpp

@@ -24,6 +24,8 @@ class StorageModuleDB : public StorageModuleBase {
   std::vector<std::shared_ptr<DataEntry>> RQPeekAll() override;
   void RQRemoveFront(std::shared_ptr<DataEntry> request) override;
   void RQInsertAtEnd(const std::string &request) override;
+  void storeSDKBehaviorSettings(const std::string &sdk_behavior_settings) override;
+  std::string getSDKBehaviorSettings() override;
 };
 } // namespace cly
 #endif

include/countly/storage_module_memory.hpp

@@ -26,6 +26,8 @@ class StorageModuleMemory : public StorageModuleBase {
   std::vector<std::shared_ptr<DataEntry>> RQPeekAll() override;
   void RQRemoveFront(std::shared_ptr<DataEntry> request) override;
   void RQInsertAtEnd(const std::string &request) override;
+  void storeSDKBehaviorSettings(const std::string &sdk_behavior_settings) override;
+  std::string getSDKBehaviorSettings() override;
 };
 } // namespace cly
 #endif

include/countly/views_module.hpp

@@ -4,6 +4,7 @@
 #include <memory>
 #include <string>
 
+#include "countly/configuration_provider.hpp"
 #include "countly/constants.hpp"
 #include "countly/logger_module.hpp"
 
@@ -36,10 +37,13 @@ class ViewsModule {
    */
   std::string openView(const std::string &name, const std::map<std::string, std::string> &segmentation = {});
 
+
 private:
+  friend class Countly;
   void _recordView(std::string eventID);
   class ViewModuleImpl;
   std::unique_ptr<ViewModuleImpl> impl;
+  void setConfigurationProvider(std::weak_ptr<ConfigurationProvider> provider); // try injecting
 };
 } // namespace cly
 #endif