Merge pull request #115 from bugsnag/next

Release v1.4.0

Author: richardelms

.buildkite/pipeline.full.yml

@@ -4,7 +4,7 @@ aliases:
   - &2022 "2022.3.22f1"
 
 agents:
-  queue: macos-12-arm-unity
+  queue: macos-14
 
 steps:
   - label: ':macos: Build macos test fixture for Unity 2020'
@@ -31,8 +31,6 @@ steps:
   - label: Run MacOS e2e tests for Unity 2020
     timeout_in_minutes: 60
     depends_on: build-macos-fixture-2020
-    agents:
-      queue: macos-12-arm-unity
     env:
       UNITY_PERFORMANCE_VERSION: *2020
     plugins:
@@ -71,8 +69,6 @@ steps:
   - label: Run MacOS e2e tests for Unity 2022
     timeout_in_minutes: 60
     depends_on: build-macos-fixture-2022
-    agents:
-      queue: macos-12-arm-unity
     env:
       UNITY_PERFORMANCE_VERSION: *2022
     plugins:
@@ -294,7 +290,7 @@ steps:
     key: build-ios-fixture-2020
     depends_on: generate-fixture-project-2020
     env:
-      DEVELOPER_DIR: /Applications/Xcode14.0.app
+      XCODE_VERSION: 15.3.0
       UNITY_PERFORMANCE_VERSION: *2020
     plugins:
       'artifacts#v1.9.0':
@@ -365,7 +361,7 @@ steps:
     key: build-ios-fixture-2022
     depends_on: generate-fixture-project-2022
     env:
-      DEVELOPER_DIR: /Applications/Xcode14.0.app
+      XCODE_VERSION: 15.3.0
       UNITY_PERFORMANCE_VERSION: *2022
     plugins:
       'artifacts#v1.9.0':

.gitignore

@@ -26,3 +26,4 @@ features/fixtures/mazerunner/mazerunner_BackUpThisFolder_ButDontShipItWithYourGa
 features/fixtures/minimalapp/Packages
 features/fixtures/minimalapp/minimal_with_xcode
 features/fixtures/minimalapp/minimal_without_xcode
+features/fixtures/mazerunner/mazerunner_macos_BackUpThisFolder_ButDontShipItWithYourGame

BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Internal/CacheManager.cs

@@ -8,6 +8,7 @@ namespace BugsnagUnityPerformance
     public class CacheManager : IPhasedStartup
     {
         private int _maxPersistedBatchAgeSeconds;
+        private bool _deviceAutoGenerateId;
         private string _cacheDirectory;
         private string _deviceidFilePath;
         private string _persistentStateFilePath;
@@ -32,6 +33,8 @@ public CacheManager(string basePath)
         public void Configure(PerformanceConfiguration config)
         {
             _maxPersistedBatchAgeSeconds = config.MaxPersistedBatchAgeSeconds;
+            _deviceAutoGenerateId = config.GenerateAnonymousId;
+
         }
 
         public void Start()
@@ -46,16 +49,24 @@ public string GetDeviceId()
         {
             try
             {
-                if (File.Exists(_deviceidFilePath))
+                //if generateAnonymousId is true then store/report/generate else don't 
+                if (_deviceAutoGenerateId)
                 {
-                    // return existing cached device id
-                    return File.ReadAllText(_deviceidFilePath);
+                    if (File.Exists(_deviceidFilePath))
+                    {
+                        // return existing cached device id
+                        return File.ReadAllText(_deviceidFilePath);
+                    }
+
+                    // create and cache new random device id
+                    var newDeviceId = Guid.NewGuid().ToString();
+                    WriteFile(_deviceidFilePath, _deviceidFilePath);
+                    return newDeviceId;
+                }
+                else
+                {
+                    return string.Empty;
                 }
-
-                // create and cache new random device id
-                var newDeviceId = Guid.NewGuid().ToString();
-                WriteFile(_deviceidFilePath, _deviceidFilePath);
-                return newDeviceId;
             }
             catch
             {

BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Internal/Sampler.cs

@@ -43,14 +43,14 @@ public void Start()
             }
         }
 
-        public bool Sampled(Span span)
+        public bool Sampled(Span span, bool shouldAddAttribute = true)
         {
             var p = Probability;
             var isSampled = IsSampled(span, GetUpperBound(p));
 #if BUGSNAG_DEBUG
             Logger.I(string.Format("Span {0} is sampled: {1} with p value: {2}",span.Name,isSampled,p));
 #endif
-            if (isSampled)
+            if (isSampled && shouldAddAttribute)
             {
                 span.UpdateSamplingProbability(p);
                 span.SetAttribute("bugsnag.sampling.p", p);

BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Internal/SpanFactory.cs

@@ -89,7 +89,7 @@ private Span CreateSpan(string name, SpanKind kind, SpanOptions spanOptions)
             {
                 AddToContextStack(newSpan);
             }
-
+            newSpan.SetAttribute("net.host.connection.type", GetConnectionType());
             return newSpan;
         }
 
@@ -105,7 +105,6 @@ internal Span CreateAutomaticNetworkSpan(BugsnagUnityWebRequest request,string u
             span.SetAttribute("bugsnag.span.category", "network");
             span.SetAttribute("http.url", url);
             span.SetAttribute("http.method", verb);
-            span.SetAttribute("net.host.connection.type", GetConnectionType());
             return span;
         }
 
@@ -126,7 +125,6 @@ internal Span CreateManualNetworkSpan(string url, HttpVerb httpVerb, SpanOptions
             span.SetAttribute("bugsnag.span.category", "network");
             span.SetAttribute("http.url", url);
             span.SetAttribute("http.method", httpVerb.ToString());
-            span.SetAttribute("net.host.connection.type", GetConnectionType());
             return span;
         }
 
@@ -171,7 +169,7 @@ internal Span CreateManualSceneLoadSpan(string sceneName, SpanOptions spanOption
             return span;
         }
 
-        private ISpanContext GetCurrentContext()
+        internal ISpanContext GetCurrentContext()
         {
             if (_contextStack == null || _contextStack.Count == 0)
             {

BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Internal/Version.cs

@@ -3,6 +3,6 @@
     internal static class Version
     {
         //TODO set this using sed or something in the release automation task
-        public const string VersionString = "1.3.4";
+        public const string VersionString = "1.4.0";
     }
 }

BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Public/BugsnagPerformance.cs

@@ -2,9 +2,11 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Text.RegularExpressions;
 using BugsnagNetworking;
 using UnityEngine;
 using UnityEngine.SceneManagement;
+using UnityEngine.Scripting;
 
 namespace BugsnagUnityPerformance
 {
@@ -27,6 +29,7 @@ public class BugsnagPerformance
         private PValueUpdater _pValueUpdater;
         private static List<Span> _potentiallyOpenSpans = new List<Span>();
         private Func<BugsnagNetworkRequestInfo, BugsnagNetworkRequestInfo> _networkRequestCallback;
+        private static string[] _tracePropagationUrlMatchPatterns;
 
         public static void Start(PerformanceConfiguration configuration)
         {
@@ -42,6 +45,10 @@ public static void Start(PerformanceConfiguration configuration)
                 }
                 IsStarted = true;
             }
+            if (configuration.TracePropagationUrlMatchPatterns != null)
+            {
+                _tracePropagationUrlMatchPatterns = configuration.TracePropagationUrlMatchPatterns.ToArray();
+            }
             ValidateApiKey(configuration.ApiKey);
             if (ReleaseStageEnabled(configuration))
             {
@@ -241,24 +248,80 @@ private void SetupNetworkListener()
         private void OnRequestSend(BugsnagUnityWebRequest request)
         {
             var url = request.url;
+            bool shouldCreateSpan = true;
             if (_networkRequestCallback != null)
             {
                 var callbackResult = _networkRequestCallback.Invoke(new BugsnagNetworkRequestInfo(url));
                 if (callbackResult == null || string.IsNullOrEmpty(callbackResult.Url))
                 {
-                    return;
+                    shouldCreateSpan = false;
                 }
 
                 url = callbackResult.Url;
             }
-            var span = _spanFactory.CreateAutomaticNetworkSpan(request, url);
-            lock (_networkSpansLock)
+
+            Span networkSpan = null;
+
+            if (shouldCreateSpan)
+            {
+                networkSpan = _spanFactory.CreateAutomaticNetworkSpan(request, url);
+                lock (_networkSpansLock)
+                {
+                    _networkSpans[request] = networkSpan;
+                }
+            }
+
+            if (ShouldAddTraceParentHeader(request.url))
+            {
+                string parentId = "";
+                string traceId = "";
+                bool sampled = false;
+
+                if (networkSpan != null)
+                {
+                    parentId = networkSpan.SpanId;
+                    traceId = networkSpan.TraceId;
+                    sampled = _sampler.Sampled(networkSpan,false);
+                }
+                else
+                {
+                    ISpanContext currentContext = _spanFactory.GetCurrentContext();
+                    if (currentContext != null)
+                    {
+                        parentId = currentContext.SpanId;
+                        traceId = currentContext.TraceId;
+                    }
+                }
+                if (string.IsNullOrEmpty(parentId))
+                {
+                    return;
+                }
+                request.SetRequestHeader("traceparent", BuildTraceParentHeader(traceId,parentId,sampled));
+            }
+        }
+
+        private static bool ShouldAddTraceParentHeader(string url)
+        {
+            if (_tracePropagationUrlMatchPatterns == null || _tracePropagationUrlMatchPatterns.Length == 0)
+            {
+                return true;
+            }
+            foreach (var pattern in _tracePropagationUrlMatchPatterns)
             {
-                _networkSpans[request] = span;
+                if (Regex.IsMatch(url, pattern))
+                {
+                    return true;
+                }
             }
+            return false;
+        }
+
+        private static string BuildTraceParentHeader(string traceId, string parentSpanId, bool sampled)
+        {
+            return $"00-{traceId}-{parentSpanId}-{(sampled ? "01" : "00")}";
         }
 
-       
+
 
         private void OnRequestAbort(BugsnagUnityWebRequest request)
         {
@@ -299,6 +362,11 @@ private Span StartSpanInternal(string name, SpanOptions spanOptions)
             }
         }
 
+        public static ISpanContext GetCurrentSpanContext()
+        {
+            return _sharedInstance._spanFactory.GetCurrentContext();
+        }
+
         public static void ReportAppStarted()
         {
             AppStartHandler.ReportAppStarted();
@@ -320,5 +388,32 @@ private static void CancelAllOpenSpans()
             }
         }
 
+        [Serializable]
+        private class PerformanceState
+        {
+            public string currentContextSpanId;
+            public string currentContextTraceId;
+            public PerformanceState(string currentContextSpanId, string currentContextTraceId)
+            {
+                this.currentContextSpanId = currentContextSpanId;
+                this.currentContextTraceId = currentContextTraceId;
+            }
+        } 
+
+        [Preserve]
+        internal static string GetPerformanceState()
+        {
+            var context = GetCurrentSpanContext();
+            if (context != null)
+            {
+                var performanceState = new PerformanceState(context.SpanId, context.TraceId);
+                var json = JsonUtility.ToJson(performanceState);
+                return json;
+            }
+            return string.Empty;
+        }
+
+
+
     }
 }

BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Public/BugsnagPerformanceSettingsObject.cs

@@ -26,6 +26,8 @@ public class BugsnagPerformanceSettingsObject : ScriptableObject
         public int VersionCode = -1;
         public string BundleVersion;
 
+        public bool GenerateAnonymousId = true;
+
         public static PerformanceConfiguration LoadConfiguration()
         {
             var settings = Resources.Load<BugsnagPerformanceSettingsObject>("Bugsnag/BugsnagPerformanceSettingsObject");
@@ -56,6 +58,8 @@ internal PerformanceConfiguration GetConfig()
             config.AutoInstrumentAppStart = AutoInstrumentAppStart;
 
             config.Endpoint = Endpoint;
+
+            config.GenerateAnonymousId = GenerateAnonymousId;
 
             return config;
         }
@@ -78,6 +82,7 @@ private PerformanceConfiguration GetStandaloneConfig()
             config.AppVersion = AppVersion;
             config.BundleVersion = BundleVersion;
             config.VersionCode = VersionCode;
+            config.GenerateAnonymousId = GenerateAnonymousId;
 
             return config;
         }
@@ -107,6 +112,8 @@ private PerformanceConfiguration GetSettingsFromNotifier(out bool autoStart)
             config.AppVersion = (string)GetValueFromNotifer(notifierSettings, "AppVersion");
             config.BundleVersion = (string)GetValueFromNotifer(notifierSettings, "BundleVersion");
             config.VersionCode = (int)GetValueFromNotifer(notifierSettings, "VersionCode");
+            config.GenerateAnonymousId = (bool)GetValueFromNotifer(notifierSettings, "GenerateAnonymousId");
+
 
             autoStart = (bool)GetValueFromNotifer(notifierSettings, "StartAutomaticallyAtLaunch");