Add latency and geolocalization provider

Author: genail

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.4.0
+
+### Added
+- Added support for geolocation and latency data collection.
+
+### Fixed
+- Logger: Fixed disposing of the logger when the application is closed.
+- VideoEncoder: Fix compilation warnings.
+
 ## 1.3.2
 
 ### Chnages

Documentation.html

@@ -263,6 +263,131 @@ <h3>Integration with Bug Reports</h3>
         <strong>Example Scene:</strong> The plugin includes <code>DeviceAuthExample.cs</code> in the Samples folder, demonstrating complete integration between device authentication and bug reporting systems.
     </div>
 
+    <h2>Optional Components</h2>
+
+    <p>The plugin includes two optional components that can enhance bug reports with additional diagnostic information. These components are <strong>not attached to the prefabs by default</strong> and must be manually added to provide enhanced debugging capabilities.</p>
+
+    <h3>GeolocationProvider</h3>
+
+    <div class="note">
+        <strong>Purpose:</strong> Automatically collects the user's country and ISP information based on their IP address to help identify location-specific issues and provide geographic context for bug reports.
+    </div>
+
+    <h4>How It Works</h4>
+
+    <ol>
+        <li><strong>Automatic Detection:</strong> Uses BetaHub's ping endpoint to detect the user's country and ISP via IP geolocation</li>
+        <li><strong>Header Parsing:</strong> Extracts geolocation information from response headers:
+            <ul>
+                <li>Country data from headers like <code>X-Viewer-Country</code>, <code>CF-IPCountry</code></li>
+                <li>ASN (Autonomous System Number) data from <code>X-Viewer-ASN</code> header</li>
+            </ul>
+        </li>
+        <li><strong>ISP Resolution:</strong> ASN data is automatically resolved to ISP/company names on the BetaHub dashboard for easier analysis</li>
+        <li><strong>Bug Report Integration:</strong> Country and ISP data are automatically included in bug reports as custom fields</li>
+    </ol>
+
+    <h4>Setup Instructions</h4>
+
+    <ol>
+        <li>In your scene, select the GameObject containing your <code>BugReportUI</code> component</li>
+        <li>Click <strong>Add Component</strong> and search for <code>GeolocationProvider</code>, or drag the script from the project window</li>
+        <li>Configure the provider in the inspector:
+            <ul>
+                <li><strong>Enable Geolocation:</strong> Toggle to enable/disable country code collection</li>
+                <li><strong>Enable ASN Collection:</strong> Toggle to enable/disable ISP/ASN data collection</li>
+                <li><strong>Geolocation Endpoint:</strong> API endpoint for geolocation (default: <code>https://ping.betahub.io/ping.txt</code>)</li>
+                <li><strong>Timeout Seconds:</strong> Request timeout (default: 5 seconds)</li>
+            </ul>
+        </li>
+        <li>The component will automatically link itself to the <code>BugReportUI</code> on the same GameObject</li>
+    </ol>
+
+    <div class="note">
+        <strong>Automatic Setup:</strong> When <code>GeolocationProvider</code> is attached to the same GameObject as <code>BugReportUI</code>, it will automatically configure itself and display a success message in the console. If placed on a different GameObject, you'll see a warning message with setup instructions.
+    </div>
+
+    <h3>LatencyProvider</h3>
+
+    <div class="note">
+        <strong>Purpose:</strong> Measures network latency to help diagnose network-related issues and provide connection quality context for bug reports.
+    </div>
+
+    <h4>How It Works</h4>
+
+    <ol>
+        <li><strong>Ping Methods:</strong> Supports two measurement methods:
+            <ul>
+                <li><strong>ICMP Ping:</strong> Uses Unity's built-in Ping class for traditional network ping (default)</li>
+                <li><strong>HTTP Ping:</strong> Uses UnityWebRequest for HTTP-based latency measurement</li>
+                <li><strong>Automatic Fallback:</strong> Automatically switches from ICMP to HTTP if ICMP fails consistently (after 3 consecutive failures per host)</li>
+            </ul>
+        </li>
+        <li><strong>Collection Modes:</strong> Two modes for data collection:
+            <ul>
+                <li><strong>OnBugReport:</strong> Collects pings only when bug report window opens (default)</li>
+                <li><strong>Continuous:</strong> Continuously collects pings in the background at regular intervals</li>
+            </ul>
+        </li>
+        <li><strong>Multiple Host Support:</strong> Can ping multiple ICMP target hosts simultaneously for comprehensive network analysis</li>
+        <li><strong>Multiple Requests:</strong> Performs up to 10 ping requests per host to calculate accurate statistics</li>
+        <li><strong>Early Termination:</strong> If user submits the bug report before all pings complete, uses available data</li>
+        <li><strong>Comprehensive Statistics:</strong> Calculates minimum, maximum, and average latency from successful requests, plus packet loss statistics</li>
+        <li><strong>Results Format:</strong> Includes detailed data like <code>"min/avg/max = 45ms/67ms/89ms (8/10 requests), Lost: 2/10 (20.0%)"</code> in bug reports</li>
+    </ol>
+
+    <h4>Setup Instructions</h4>
+
+    <ol>
+        <li>In your scene, select the GameObject containing your <code>BugReportUI</code> component</li>
+        <li>Click <strong>Add Component</strong> and search for <code>LatencyProvider</code>, or drag the script from the project window</li>
+        <li>Configure the provider in the inspector:
+            <ul>
+                <li><strong>Enable Latency:</strong> Toggle to enable/disable latency measurement</li>
+                <li><strong>Collection Mode:</strong> Choose between OnBugReport (default) or Continuous collection</li>
+                <li><strong>Ping Method:</strong> Select ICMP (default) or HTTP ping method</li>
+                <li><strong>ICMP Target Hosts:</strong> List of hosts for ICMP ping (default: ping.betahub.io)</li>
+                <li><strong>HTTP Endpoint:</strong> API endpoint for HTTP latency testing (default: <code>https://ping.betahub.io/ping.txt</code>)</li>
+                <li><strong>Min Ping Requests:</strong> Minimum number of ping requests per host (default: 10, range: 1-20)</li>
+                <li><strong>Timeout Seconds:</strong> Request timeout per ping (default: 5 seconds)</li>
+                <li><strong>Delay Between Requests:</strong> Delay between consecutive pings (default: 0.1 seconds)</li>
+                <li><strong>Ping Interval:</strong> Interval between background pings in continuous mode (default: 15 seconds)</li>
+            </ul>
+        </li>
+        <li>The component will automatically link itself to the <code>BugReportUI</code> on the same GameObject</li>
+    </ol>
+
+    <div class="warning">
+        <strong>Performance Considerations:</strong> Latency testing performs network requests while the bug report UI is open. The default settings (10 requests with 0.1s delays) complete in approximately 1-2 seconds under normal conditions. If users frequently submit reports very quickly, consider reducing <code>Max Ping Requests</code> or increasing <code>Delay Between Requests</code> to balance accuracy with responsiveness.
+    </div>
+
+    <h4>Troubleshooting</h4>
+
+    <ul>
+        <li><strong>"No latency data available":</strong> All ping requests failed. Check network connectivity and endpoint accessibility.</li>
+        <li><strong>"No country information found":</strong> Geolocation service didn't return expected headers. This may indicate network issues or endpoint changes.</li>
+        <li><strong>Warning messages in console:</strong> If components are not on the same GameObject as <code>BugReportUI</code>, you'll see warnings with setup instructions.</li>
+    </ul>
+
+    <h4>Data Integration</h4>
+
+    <p>When both components are enabled, bug reports will include custom fields like:</p>
+
+    <pre><code>Custom Fields:
+country=US
+asn=Cloudflare, Inc.
+latency=ping.betahub.io: min/avg/max = 45ms/67ms/89ms (10/10 requests)</code></pre>
+
+    <p>This data appears in the BetaHub dashboard and can be used for:</p>
+
+    <ul>
+        <li><strong>Geographic Analysis:</strong> Identifying region-specific issues and user distribution</li>
+        <li><strong>ISP Analysis:</strong> Understanding which internet service providers may be experiencing issues</li>
+        <li><strong>Network Diagnosis:</strong> Correlating bugs with connection quality and packet loss rates</li>
+        <li><strong>Performance Optimization:</strong> Understanding user network conditions across different providers</li>
+        <li><strong>Support Prioritization:</strong> Triaging issues based on user location, ISP, and connectivity quality</li>
+    </ul>
+
     <h3>Configuration</h3>
 
     <p>Adjust these settings in the BugReportingFormCanvas inspector:</p>

README.md

@@ -29,6 +29,7 @@ For continued use and more extensive testing, we strongly recommend creating you
 - **Video recording**: Record a video of the bug happening in-game. The video is automatically recorded and attached to the bug report.
 - **Log collection**: Collect logs from the game and attach them to the bug report. By default, Unity logs are collected, but you can also add custom logs.
 - **Screenshot of the game**: A screenshot of the game is automatically attached to the bug report when the user submits a bug.
+- **Geolocation and latency data**: Optional components for collecting user's country information and network latency measurements to help with debugging location-specific and network-related issues.
 - **Working Example Scene**: The plugin comes with a working example scene that demonstrates how to use the plugin, serving as a good starting point for your implementation.
 - **Customizable**: Customize the bug submission form to ask for more information or to change the look and feel of the form.
 
@@ -46,6 +47,8 @@ For continued use and more extensive testing, we strongly recommend creating you
 
 The installation and setup documentation is available [here](https://www.betahub.io/docs/integration-guides/).
 
+For detailed information about optional components like geolocation and latency collection, see the included [Documentation.html](Documentation.html) file.
+
 ## Device Authentication (Optional)
 
 The plugin supports an optional device authentication flow that provides a seamless user experience for bug reporting.

Runtime/Scripts/BugReportUI.cs

@@ -25,6 +25,7 @@ public enum MediaUploadType
         WaitForUpload
     }
 
+    [RequireComponent(typeof(CustomFieldValidator))]
     public class BugReportUI : MonoBehaviour
     {
         public const string DEMO_PROJECT_ID = "pr-5287510306";
@@ -77,6 +78,17 @@ public class BugReportUI : MonoBehaviour
         [Tooltip("Device Authentication (Optional). If set, the user may be authenticated via device auth.")]
         [SerializeField] private DeviceAuthManager deviceAuthManager;
 
+        // Geolocation provider for collecting location data
+        [Tooltip("Geolocation Provider (Optional). If set, location data will be included in bug reports.")]
+        [SerializeField] private GeolocationProvider geolocationProvider;
+
+        // Latency provider for collecting network latency data
+        [Tooltip("Latency Provider (Optional). If set, network latency data will be included in bug reports.")]
+        [SerializeField] private LatencyProvider latencyProvider;
+
+        // Custom field validator for validating provider requirements
+        private CustomFieldValidator customFieldValidator;
+
         // If set, this email address will be used as the default email address of the reporter.
         // This is a hidden field since it's purpose is to be pre-filled programmatically by the developer if the user is somehow already logged in with a specific email address.
         [HideInInspector, FormerlySerializedAs("defaultEmailAddress")]
@@ -168,6 +180,9 @@ void Start()
         {
             _gameRecorder = GetComponent<GameRecorder>();
 
+            // Get the required CustomFieldValidator component (automatically added by RequireComponent)
+            customFieldValidator = GetComponent<CustomFieldValidator>();
+            
             BugReportPanel.SetActive(false);
             SubmitButton.onClick.AddListener(SubmitBugReport);
             CloseButton.onClick.AddListener(() =>
@@ -218,6 +233,9 @@ void Start()
                 }
             }
 
+            // Validate custom fields for providers
+            ValidateProviderCustomFields();
+
             DontDestroyOnLoad(gameObject);
         }
 
@@ -240,6 +258,13 @@ void Update()
                 if (!_uiWasVisible)
                 {
                     OnBugReportWindowShown?.Invoke();
+                    
+                    // Start latency testing when bug report window is shown
+                    if (latencyProvider != null && latencyProvider.EnableLatency)
+                    {
+                        latencyProvider.StartLatencyTest();
+                    }
+                    
                     ModifyCursorState();
                 }
                 _uiWasVisible = true;
@@ -347,6 +372,11 @@ public void AddLogFile(string path, bool removeAfterUpload)
         }
 
         void SubmitBugReport()
+        {
+            StartCoroutine(SubmitBugReportCoroutine());
+        }
+
+        private IEnumerator SubmitBugReportCoroutine()
         {
             string description = DescriptionField.text;
             string steps = StepsField.text;
@@ -382,6 +412,76 @@ void SubmitBugReport()
                 gameRecorder = _gameRecorder;
             }
 
+            // Get geolocation and latency data if providers are available
+            var customFieldsData = new System.Collections.Generic.Dictionary<string, string>();
+            
+            // Get geolocation and ASN data
+            if (geolocationProvider != null && (geolocationProvider.EnableGeolocation || geolocationProvider.EnableAsnCollection))
+            {
+                bool locationReceived = false;
+                string locationError = null;
+                
+                yield return geolocationProvider.GetLocationDataAsync(
+                    (locationData) => {
+                        if (locationData != null)
+                        {
+                            if (geolocationProvider.EnableGeolocation && !string.IsNullOrEmpty(locationData.country))
+                            {
+                                customFieldsData["country"] = locationData.country;
+                                Debug.Log("BugReportUI: Including location data in bug report: " + locationData.country);
+                            }
+                            
+                            if (geolocationProvider.EnableAsnCollection && !string.IsNullOrEmpty(locationData.asn))
+                            {
+                                customFieldsData["asn"] = locationData.asn;
+                                Debug.Log("BugReportUI: Including ASN data in bug report: " + locationData.asn);
+                            }
+                        }
+                        locationReceived = true;
+                    },
+                    (error) => {
+                        locationError = error;
+                        locationReceived = true;
+                        Debug.LogWarning("BugReportUI: Failed to get location/ASN data: " + error);
+                    }
+                );
+                
+                // Wait for location request to complete (success or failure)
+                while (!locationReceived)
+                {
+                    yield return null;
+                }
+            }
+            
+            // Get latency data (stop any ongoing test and get current results)
+            if (latencyProvider != null && latencyProvider.EnableLatency)
+            {
+                // Stop the latency test and get whatever results we have
+                latencyProvider.StopLatencyTest();
+                var latencyData = latencyProvider.GetCurrentLatencyData();
+                
+                if (latencyData != null && latencyData.HasSuccessfulResults())
+                {
+                    customFieldsData["latency"] = latencyData.GetFormattedLatency();
+                    Debug.Log("BugReportUI: Including latency data in bug report: " + latencyData.GetFormattedLatency());
+                }
+                else
+                {
+                    Debug.LogWarning("BugReportUI: No latency data available for bug report.");
+                }
+            }
+            
+            // Log custom fields if any
+            if (customFieldsData.Count > 0)
+            {
+                var fieldsList = new System.Collections.Generic.List<string>();
+                foreach (var kvp in customFieldsData)
+                {
+                    fieldsList.Add($"{kvp.Key}={kvp.Value}");
+                }
+                Debug.Log("BugReportUI: Final custom fields: " + string.Join(", ", fieldsList.ToArray()));
+            }
+            
             // Create Issue instance and post it with authentication
             string effectiveAuthToken = GetEffectiveAuthToken();
             Issue issue = new Issue(SubmitEndpoint, ProjectID, effectiveAuthToken, MessagePanelUI, ReportSubmittedUI, gameRecorder);
@@ -447,7 +547,8 @@ void SubmitBugReport()
                 (error) =>
                 {
                     onIssueError(new ErrorMessage { error = error });
-                }
+                },
+                customFieldsData.Count > 0 ? customFieldsData : null
             ),
             (ex) => // done
             {
@@ -513,6 +614,16 @@ public void SetDeviceAuthManager(DeviceAuthManager authManager)
             deviceAuthManager = authManager;
         }
 
+        public void SetGeolocationProvider(GeolocationProvider provider)
+        {
+            geolocationProvider = provider;
+        }
+
+        public void SetLatencyProvider(LatencyProvider provider)
+        {
+            latencyProvider = provider;
+        }
+
         private bool IsUserAuthenticatedViaDeviceAuth()
         {
             return deviceAuthManager != null && deviceAuthManager.IsAuthenticated();
@@ -534,6 +645,42 @@ void OnDestroy()
             // Cleanup handled automatically since we don't subscribe to events
         }
 
+        private void ValidateProviderCustomFields()
+        {
+            // Skip validation if we don't have the necessary credentials
+            if (string.IsNullOrEmpty(SubmitEndpoint) || string.IsNullOrEmpty(ProjectID))
+            {
+                Debug.LogWarning("BugReportUI: Cannot validate custom fields - missing endpoint or project ID");
+                return;
+            }
+
+            string effectiveAuthToken = GetEffectiveAuthToken();
+            if (string.IsNullOrEmpty(effectiveAuthToken))
+            {
+                Debug.LogWarning("BugReportUI: Cannot validate custom fields - no auth token available");
+                return;
+            }
+
+            // Collect required fields from all attached providers
+            var requiredFields = new List<CustomFieldRequirement>();
+
+            if (geolocationProvider != null && geolocationProvider.RequiredCustomFields != null)
+            {
+                requiredFields.AddRange(geolocationProvider.RequiredCustomFields);
+            }
+
+            if (latencyProvider != null && latencyProvider.RequiredCustomFields != null)
+            {
+                requiredFields.AddRange(latencyProvider.RequiredCustomFields);
+            }
+
+            // Run validation if we have any required fields
+            if (requiredFields.Count > 0 && customFieldValidator != null)
+            {
+                customFieldValidator.ValidateCustomFields(SubmitEndpoint, ProjectID, effectiveAuthToken, requiredFields);
+            }
+        }
+
         #endregion
     }
 }