fix: improve UserBuilder validation and add error for isAnonymous=false with no userId (#228)

* fix: improve UserBuilder validation and add error for isAnonymous=false with no userId

* fix: remove trim whitespace

* fix: add 15 min timeout to all the tests

Author: jonathannorris

.github/workflows/ios.yaml

@@ -27,3 +27,4 @@ jobs:
 
       - name: Fastlane iOS Tests
         run: fastlane ios tests
+        timeout-minutes: 15

.github/workflows/macos.yaml

@@ -30,6 +30,7 @@ jobs:
 
       - name: Fastlane macOS Tests
         run: fastlane mac tests
+        timeout-minutes: 15
         env:
           MATCH_GIT_BASIC_AUTHORIZATION: "${{ env.FASTLANE_GIT_BASIC_AUTHORIZATION }}"
           DEVELOPER_APP_ID: "${{ secrets.DEVELOPER_APP_ID }}"

.github/workflows/tvos.yaml

@@ -27,3 +27,4 @@ jobs:
 
       - name: Fastlane tvOS Tests
         run: fastlane tvos tests
+        timeout-minutes: 15

.github/workflows/watchos.yaml

@@ -27,3 +27,4 @@ jobs:
 
       - name: Fastlane watchOS Tests
         run: fastlane watchos tests
+        timeout-minutes: 15

DevCycle/DevCycleUser.swift

@@ -30,16 +30,11 @@ public class UserBuilder {
 
     public func userId(_ userId: String) -> UserBuilder {
         self.user.userId = userId
-        self.user.isAnonymous = false
         return self
     }
 
     public func isAnonymous(_ isAnonymous: Bool) -> UserBuilder {
-        if self.user.isAnonymous != nil { return self }
         self.user.isAnonymous = isAnonymous
-        if isAnonymous {
-            self.user.userId = self.cacheService.getOrCreateAnonUserId()
-        }
         return self
     }
 
@@ -74,12 +69,18 @@ public class UserBuilder {
     }
 
     public func build() throws -> DevCycleUser {
-        guard self.user.userId?.trimmingCharacters(in: .whitespacesAndNewlines) != ""
-        else {
-            throw UserError.InvalidUser
+        // Validate the userId
+        let hasValidUserId = self.user.userId != nil && !self.user.userId!.isEmpty
+
+        // Handle the different cases based on isAnonymous and userId
+        if self.user.isAnonymous == false && !hasValidUserId {
+            throw UserError.MissingUserIdAndIsAnonymousFalse
         }
 
-        if self.user.userId == nil {
+        if self.user.isAnonymous == true && !hasValidUserId {
+            self.user.userId = self.cacheService.getOrCreateAnonUserId()
+        } else if !hasValidUserId {
+            // Default case: no userId and isAnonymous not explicitly set to false, make anonymous
             self.user.userId = self.cacheService.getOrCreateAnonUserId()
             self.user.isAnonymous = true
         }

DevCycleTests/Models/DevCycleUserTest.swift

@@ -51,20 +51,31 @@ class DevCycleUserTest: XCTestCase {
         XCTAssertTrue(user.isAnonymous!)
     }
 
-    func testBuilderReturnsAnonUserIfNoUserIdAndIsAnonymousIsFalse() {
-        let user = try! DevCycleUser.builder()
-            .isAnonymous(false)
-            .build()
+    func testBuilderReturnsAnonUserIfEmptyStringUserId() {
+        let user = try! DevCycleUser.builder().userId("").build()
         XCTAssertNotNil(user)
         XCTAssert(UUID(uuidString: user.userId!) != nil)
         XCTAssertTrue(user.isAnonymous!)
     }
 
+    func testBuilderThrowsErrorIfNoUserIdAndIsAnonymousIsFalse() {
+        XCTAssertThrowsError(
+            try DevCycleUser.builder()
+                .isAnonymous(false)
+                .build()
+        ) { error in
+            XCTAssertTrue(error is UserError)
+            if let userError = error as? UserError {
+                XCTAssertEqual(userError, UserError.MissingUserIdAndIsAnonymousFalse)
+            }
+        }
+    }
+
     func testBuilderReturnsUserIfUserIdSet() {
         let user = try! DevCycleUser.builder().userId("my_user").build()
         XCTAssertNotNil(user)
         XCTAssert(user.userId == "my_user")
-        XCTAssert(!user.isAnonymous!)
+        XCTAssertNil(user.isAnonymous)
     }
 
     func testBuilderReturnsUserIfIsAnonymousSet() {
@@ -74,14 +85,24 @@ class DevCycleUserTest: XCTestCase {
         XCTAssert(UUID(uuidString: user.userId!) != nil)
     }
 
-    func testBuilderReturnsNilIfUserIdIsEmptyString() {
-        let user = try? DevCycleUser.builder().userId("").build()
-        XCTAssertNil(user)
+    func testBuilderWithUserIdAndIsAnonymousTrue() {
+        let user = try! DevCycleUser.builder()
+            .userId("my_user")
+            .isAnonymous(true)
+            .build()
+        XCTAssertNotNil(user)
+        XCTAssert(user.userId == "my_user")
+        XCTAssertTrue(user.isAnonymous!)
     }
 
-    func testBuilderReturnsNilIfUserIdOnlyContainsWhitespaces() {
-        let user = try? DevCycleUser.builder().userId(" ").build()
-        XCTAssertNil(user)
+    func testBuilderWithUserIdAndIsAnonymousFalse() {
+        let user = try! DevCycleUser.builder()
+            .userId("my_user")
+            .isAnonymous(false)
+            .build()
+        XCTAssertNotNil(user)
+        XCTAssert(user.userId == "my_user")
+        XCTAssertFalse(user.isAnonymous!)
     }
 
     func testToStringOnlyOutputsNonNilProperties() {