refactor: additional data now can be modified by filter hook

Author: shuvomohajan

readme.md

@@ -22,6 +22,7 @@ function initialize_telemetry_client() {
   TelemetryConfig::setTitle($slug);
   TelemetryConfig::setPrefix($prefix);
   TelemetryConfig::setVersion($version);
+  TelemetryConfig::setServerBaseUrl( 'https://api.example.com/' );
 
   // initialize tracking and reporting
   Telemetry::report()->init();
@@ -41,12 +42,6 @@ All the configuration should be done in the `initialize_telemetry_client()` func
 
 ### # Telemetry Client Config
 
-Set custom server URL
-
-```php
-TelemetryConfig::setServerBaseUrl( 'https://example.com' );
-```
-
 Set custom terms URL
 
 ```php
@@ -59,7 +54,7 @@ Set custom privacy policy URL
 TelemetryConfig::setPolicyUrl( 'https://example.com/privacy' );
 ```
 
-### # Tracking Report Config
+### # Tracking Report Modify
 
 Add plugin information in tracking data
 
@@ -69,14 +64,32 @@ TelemetryConfig::report()
                 ->init();
 ```
 
-Add extra information in tracking data
+Add additional data in tracking data
 
 ```php
-TelemetryConfig::report()
-                ->addExtraInfo([
-                  'my_plugin_logs' => Log::get(),
-                ])
-                ->init();
+$plugin_prefix = 'my_plugin_prefix_';
+
+add_filter($plugin_prefix . 'tracking_additional_data', function($additional_data) {
+
+  // example: add custom data
+  $additional_data['my_custom_data'] = 'My Custom Data';
+
+  return $additional_data;
+});
+```
+
+Filter tracking data before sending
+
+```php
+$plugin_prefix = 'my_plugin_prefix_';
+
+add_filter($plugin_prefix . 'tracking_data', function($tracking_data) {
+
+  // example: remove some data
+  unset($tracking_data['some_data']);
+
+  return $tracking_data;
+});
 ```
 
 ### # Deactivate Feedback Config

src/Telemetry/Report/Report.php

@@ -7,8 +7,6 @@
 
 class Report
 {
-    private $extraInfo = [];
-
     private $addPluginData = false;
 
     public function init()
@@ -27,13 +25,6 @@ public function addPluginData()
         return $this;
     }
 
-    public function addExtraInfo($data = [])
-    {
-        $this->extraInfo = $data;
-
-        return $this;
-    }
-
     public function initCommonHooks()
     {
         if (!$this->isTrackingNoticeDismissed()) {
@@ -210,15 +201,13 @@ public function getTrackingData()
             $data['plugins'] = $reportInfo->getPluginInfo($allPlugins['activePlugins'], TelemetryConfig::getSlug());
         }
 
-        if (\is_array($this->extraInfo) && !empty($this->extraInfo)) {
-            $data['extra'] = $this->extraInfo;
-        }
-
         if (get_option(TelemetryConfig::getPrefix() . 'tracking_skipped')) {
             delete_option(TelemetryConfig::getPrefix() . 'tracking_skipped');
             $data['previously_skipped'] = true;
         }
 
+        $data['additional_data'] = apply_filters(TelemetryConfig::getPrefix() . 'tracker_additional_data', []);
+
         return apply_filters(TelemetryConfig::getPrefix() . 'tracker_data', $data);
     }
 

src/Telemetry/Telemetry.php

@@ -46,7 +46,7 @@ public static function sendReport($route, $data, $blocking = false)
         $apiUrl = trailingslashit(TelemetryConfig::getServerBaseUrl()) . $route;
 
         $headers = [
-            'host-user'    => 'BitApps/' . md5(esc_url(home_url())),
+            'host-user'    => md5(esc_url(home_url())),
             'Content-Type' => 'application/json',
         ];
 

src/Telemetry/TelemetryConfig.php

@@ -12,11 +12,11 @@ class TelemetryConfig
 
     private static $version;
 
-    private static $termsUrl = 'https://bitapps.pro/terms';
+    private static $termsUrl = '';
 
-    private static $policyUrl = 'https://bitapps.pro/privacy-policy';
+    private static $policyUrl = '';
 
-    private static $serverBaseUrl = 'https://wp-api.bitapps.pro/public/';
+    private static $serverBaseUrl = '';
 
     public static function setTitle($title)
     {