Merge pull request #36 from getsentry/feat/has-user-on-scope

feat: HasUser on scope
getsentry · May 14, 2019 · 1b1da4e · 1b1da4e
2 parents 1e6346e + cfec6ee
commit 1b1da4e
Show file tree

Hide file tree

Showing 3 changed files with 84 additions and 7 deletions.
diff --git a/src/Sentry.Protocol/BaseScopeExtensions.cs b/src/Sentry.Protocol/BaseScopeExtensions.cs
@@ -12,6 +12,19 @@ namespace Sentry
     [EditorBrowsable(EditorBrowsableState.Never)]
     public static class BaseScopeExtensions
     {
+        /// <summary>
+        /// Whether a <see cref="User"/> has been set to the scope with any of its fields non null.
+        /// </summary>
+        /// <param name="scope"></param>
+        /// <returns>True if a User was set to the scope. Otherwise, false.</returns>
+        public static bool HasUser(this BaseScope scope)
+            => scope.InternalUser != null
+               && (scope.InternalUser.Email != null
+                   || scope.InternalUser.Id != null
+                   || scope.InternalUser.Username != null
+                   || scope.InternalUser.InternalOther?.Count > 0
+                   || scope.InternalUser.IpAddress != null);
+
 #if HAS_VALUE_TUPLE
         /// <summary>
         /// Adds a breadcrumb to the scope

diff --git a/src/Sentry.Protocol/SentryEventExtensions.cs b/src/Sentry.Protocol/SentryEventExtensions.cs
diff --git a/test/Sentry.Protocol.Tests/BaseScopeExtensionsTests.cs b/test/Sentry.Protocol.Tests/BaseScopeExtensionsTests.cs
@@ -22,6 +22,77 @@ public Fixture()
 
         private readonly Fixture _fixture = new Fixture();
 
+        [Fact]
+        public void HasUser_DefaultScope_ReturnsFalse()
+        {
+            var sut = _fixture.GetSut();
+            Assert.False(sut.HasUser());
+        }
+
+        [Fact]
+        public void HasUser_NullUser_ReturnsFalse()
+        {
+            var sut = _fixture.GetSut();
+            sut.User = null;
+            Assert.False(sut.HasUser());
+        }
+
+        [Fact]
+        public void HasUser_EmptyUser_ReturnsFalse()
+        {
+            var sut = _fixture.GetSut();
+            sut.User = new User();
+            Assert.False(sut.HasUser());
+        }
+
+        [Fact]
+        public void HasUser_UserWithId_ReturnsTrue()
+        {
+            var sut = _fixture.GetSut();
+            sut.User.Id = "test";
+            Assert.True(sut.HasUser());
+        }
+
+        [Fact]
+        public void HasUser_UserWithUserName_ReturnsTrue()
+        {
+            var sut = _fixture.GetSut();
+            sut.User.Username = "test";
+            Assert.True(sut.HasUser());
+        }
+
+        [Fact]
+        public void HasUser_UserWithIpAddress_ReturnsTrue()
+        {
+            var sut = _fixture.GetSut();
+            sut.User.IpAddress = "test";
+            Assert.True(sut.HasUser());
+        }
+
+        [Fact]
+        public void HasUser_UserWithEmail_ReturnsTrue()
+        {
+            var sut = _fixture.GetSut();
+            sut.User.Email = "test";
+            Assert.True(sut.HasUser());
+        }
+
+        [Fact]
+        public void HasUser_UserWithOther_ReturnsTrue()
+        {
+            var sut = _fixture.GetSut();
+            sut.User.Other.Add("other", "val");
+            Assert.True(sut.HasUser());
+        }
+
+        [Fact]
+        public void HasUser_UserWithEmptyOther_ReturnsFalse()
+        {
+            var sut = _fixture.GetSut();
+            sut.User.Other = new Dictionary<string, string>();
+            Assert.False(sut.HasUser());
+        }
+
         [Fact]
         public void SetFingerprint_NullArgument_ReplacesCurrentWithNull()
         {