Set attribute (#240)

* Set attribute support * Do not allow empty attribute key --------- Co-authored-by: Konrad Dysput <[email protected]>
backtrace-labs · Jan 24, 2025 · e1dd858 · e1dd858
1 parent db6e086
commit e1dd858
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 6 deletions.
diff --git a/Runtime/BacktraceClient.cs b/Runtime/BacktraceClient.cs
@@ -142,11 +142,7 @@ public string this[string index]
             }
             set
             {
-                AttributeProvider[index] = value;
-                if (_nativeClient != null)
-                {
-                    _nativeClient.SetAttribute(index, value);
-                }
+                SetAttribute(index, value);
             }
         }
 
@@ -170,6 +166,27 @@ public IEnumerable<string> GetAttachments()
             return _clientReportAttachments;
         }
 
+        /// <summary>
+        /// Set a client attribute that will be included in every report
+        /// </summary>
+        /// <param name="key">Attribute name</param>
+        /// <param name="value">Attribute value</param>
+        /// <returns>True, if the value was added. Otherwise false.</returns>
+        public bool SetAttribute(string key, string value) 
+        {
+            if (string.IsNullOrEmpty(key)) 
+            {
+                return false;
+            }
+
+            AttributeProvider[key] = value;
+            if (_nativeClient != null)
+            {
+                _nativeClient.SetAttribute(key, value);
+            }
+            return true;
+        }
+
         /// <summary>
         /// Set client attributes that will be included in every report
         /// </summary>
@@ -182,7 +199,7 @@ public void SetAttributes(Dictionary<string, string> attributes)
             }
             foreach (var attribute in attributes)
             {
-                this[attribute.Key] = attribute.Value;
+                SetAttribute(attribute.Key, attribute.Value);
             }
         }
 

diff --git a/Tests/Runtime/BacktraceAttributeTests.cs b/Tests/Runtime/BacktraceAttributeTests.cs
@@ -68,6 +68,41 @@ public IEnumerator TesClientAttributes_ReportShouldntExtendClientAttributes_Clie
             yield return null;
         }
 
+        [UnityTest]
+        public IEnumerator TesClientAttributeMethod_BacktraceDataShouldIncludeClientAttribute_ClientAttributeAreAvailableInDiagnosticData()
+        {
+            var key = "attribute-key";
+            var value = "attribute-value";
+            BacktraceClient.SetAttribute(key, value);
+
+            BacktraceData data = null;
+            BacktraceClient.BeforeSend = (BacktraceData reportData) =>
+            {
+                data = reportData;
+                return null;
+            };
+            BacktraceClient.Send(new Exception("foo"));
+            yield return WaitForFrame.Wait();
+
+            Assert.IsNotNull(data);
+            Assert.AreEqual(data.Attributes.Attributes[key], value);
+            yield return null;
+        }
+
+        [UnityTest]
+        public IEnumerator TesClientAttributeMethod_ShouldNotAcceptNullableKey_AttributeIsNotAvailable()
+        {
+            Assert.IsFalse(BacktraceClient.SetAttribute(null, "attribute-value"));
+            yield return null;
+        }
+
+        [UnityTest]
+        public IEnumerator TesClientAttributeMethod_ShouldNotAcceptEmptyStringKey_AttributeIsNotAvailable()
+        {
+            Assert.IsFalse(BacktraceClient.SetAttribute(string.Empty, "attribute-value"));
+            yield return null;
+        }
+
 
         [UnityTest]
         public IEnumerator TesClientAttributesMethod_BacktraceDataShouldIncludeClientAttributes_ClientAttributesAreAvailableInDiagnosticData()