allow setting first class (#107)

richardelms · web-flow · commit 2aca61a12b3e · 2024-04-24T08:39:26.000+02:00
diff --git a/BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Internal/SpanFactory.cs b/BugsnagPerformance/Assets/BugsnagPerformance/Scripts/Internal/SpanFactory.cs
@@ -51,8 +51,10 @@ private string ByteArrayToHex(byte[] barray)
 
         internal Span StartCustomSpan(string name, SpanOptions spanOptions)
         {
-            // custom spans are always first class
-            spanOptions.IsFirstClass = true;
+            if (spanOptions.IsFirstClass == null)
+            {
+                spanOptions.IsFirstClass = true;
+            }
             var span = CreateSpan(name, SpanKind.SPAN_KIND_INTERNAL, spanOptions);
             span.SetAttribute("bugsnag.span.category", "custom");
             return span;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## TBD
+
+### Bug Fixes
+
+- Fixed issue where custom spans with the SpanOption IsFirstClass set to false still had it reported as true. [#107](https://github.com/bugsnag/bugsnag-unity-performance/pull/107)
+
+
 ## v1.3.3 (2024-03-07)
 
 ### Bug Fixes
diff --git a/features/fixtures/mazerunner/Assets/Scenes/MainScene.unity b/features/fixtures/mazerunner/Assets/Scenes/MainScene.unity
@@ -151,6 +151,7 @@ RectTransform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 1513513353}
   m_RootOrder: 0
@@ -284,6 +285,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 1294582014}
   m_RootOrder: 0
@@ -331,6 +333,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 1294582014}
   m_RootOrder: 2
@@ -425,6 +428,7 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 4f231c4fb786f3946a6b90b886c48677, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
+  m_SendPointerHoverToParent: 1
   m_HorizontalAxis: Horizontal
   m_VerticalAxis: Vertical
   m_SubmitButton: Submit
@@ -457,6 +461,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 0}
   m_RootOrder: 3
@@ -540,6 +545,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: -10}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 0}
   m_RootOrder: 0
@@ -574,6 +580,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 1294582014}
   m_RootOrder: 5
@@ -654,6 +661,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 1294582014}
   m_RootOrder: 7
@@ -709,6 +717,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 1294582014}
   m_RootOrder: 3
@@ -751,6 +760,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children:
   - {fileID: 259057445}
   - {fileID: 1452957866}
@@ -798,6 +808,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 1294582014}
   m_RootOrder: 1
@@ -974,6 +985,7 @@ Canvas:
   m_OverrideSorting: 0
   m_OverridePixelPerfect: 0
   m_SortingBucketNormalizedSize: 0
+  m_VertexColorAlwaysGammaSpace: 0
   m_AdditionalShaderChannelsFlag: 25
   m_SortingLayerID: 0
   m_SortingOrder: 0
@@ -988,6 +1000,7 @@ RectTransform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 0, y: 0, z: 0}
+  m_ConstrainProportionsScale: 0
   m_Children:
   - {fileID: 41935981}
   m_Father: {fileID: 0}
@@ -1011,6 +1024,7 @@ GameObject:
   - component: {fileID: 1609554507}
   - component: {fileID: 1609554508}
   - component: {fileID: 1609554509}
+  - component: {fileID: 1609554510}
   m_Layer: 0
   m_Name: NestedSpans
   m_TagString: Untagged
@@ -1028,6 +1042,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 1294582014}
   m_RootOrder: 6
@@ -1080,6 +1095,18 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 7dd649800dec840e9976f9e905c3c236, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
+--- !u!114 &1609554510
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 1609554504}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 8b054c11fc1404cd6ad894798aa074cd, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
 --- !u!1 &2053587485
 GameObject:
   m_ObjectHideFlags: 0
@@ -1109,6 +1136,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 1294582014}
   m_RootOrder: 8
@@ -1191,6 +1219,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children:
   - {fileID: 1294582014}
   m_Father: {fileID: 0}
@@ -1241,6 +1270,7 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 1294582014}
   m_RootOrder: 4
diff --git a/features/fixtures/mazerunner/Assets/Scripts/Scenarios/NestedSpans/IsFirstClass.cs b/features/fixtures/mazerunner/Assets/Scripts/Scenarios/NestedSpans/IsFirstClass.cs
@@ -0,0 +1,21 @@
+using System.Collections;
+using System.Collections.Generic;
+using BugsnagUnityPerformance;
+using System.Threading;
+using UnityEngine;
+
+public class IsFirstClass : Scenario
+{
+    public override void PrepareConfig(string apiKey, string host)
+    {
+        base.PrepareConfig(apiKey, host);
+        SetMaxBatchSize(3);
+    }
+
+    public override void Run()
+    {
+        BugsnagPerformance.StartSpan("FirstClass not set").End();
+        BugsnagPerformance.StartSpan("FirstClass true", new SpanOptions { IsFirstClass = true }).End();
+        BugsnagPerformance.StartSpan("FirstClass false", new SpanOptions { IsFirstClass = false }).End();
+    }
+}
diff --git a/features/fixtures/mazerunner/Assets/Scripts/Scenarios/NestedSpans/IsFirstClass.cs.meta b/features/fixtures/mazerunner/Assets/Scripts/Scenarios/NestedSpans/IsFirstClass.cs.meta
diff --git a/features/nested_spans.feature b/features/nested_spans.feature
@@ -67,4 +67,22 @@ Feature: Nested Spans
     * the trace payload field "resourceSpans.0.scopeSpans.0.spans.0.parentSpanId" is null
     * the trace payload field "resourceSpans.0.scopeSpans.0.spans.1.parentSpanId" is null
 
+  Scenario: IsFirstClass
+    When I run the game in the "IsFirstClass" state
+    And I wait for 2 spans
+    Then the trace Bugsnag-Integrity header is valid
+    And the trace "Bugsnag-Api-Key" header equals "a35a2a72bd230ac0aa0f52715bbdc6aa"
+    * the trace "Bugsnag-Sent-At" header matches the regex "^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\dZ$"
+    * the trace "Bugsnag-Span-Sampling" header equals "1:3"
+   
+    * the trace payload field "resourceSpans.0.scopeSpans.0.spans.0.name" equals "FirstClass not set"
+    * the trace payload field "resourceSpans.0.scopeSpans.0.spans.0" bool attribute "bugsnag.span.first_class" is true
+   
+    * the trace payload field "resourceSpans.0.scopeSpans.0.spans.1.name" equals "FirstClass true"
+    * the trace payload field "resourceSpans.0.scopeSpans.0.spans.1" bool attribute "bugsnag.span.first_class" is true
+   
+    * the trace payload field "resourceSpans.0.scopeSpans.0.spans.2.name" equals "FirstClass false"
+    * the trace payload field "resourceSpans.0.scopeSpans.0.spans.2" bool attribute "bugsnag.span.first_class" is false
+
+
 
