Make default_role mandatory and reorganise GraphQL fields

Author: paulnoirel

libs/labelbox/src/labelbox/schema/user_group.py

@@ -162,18 +162,19 @@ def __init__(
         )
 
     def model_post_init(self, __context: Any) -> None:
-        """Set default_role to LABELER if not specified.
+        """Validate that default_role is set when users field is used.
 
         Args:
             __context: Pydantic context (unused).
+
+        Raises:
+            ValueError: If users is set but default_role is not provided.
         """
-        if self.default_role is None:
-            try:
-                roles = self.client.get_roles()
-                self.default_role = roles.get("LABELER")
-            except Exception:
-                # Silently fail if roles cannot be retrieved
-                pass
+        # Validate that default_role is set when legacy users field is used
+        if self.users and self.default_role is None:
+            raise ValueError(
+                "default_role must be set when using the 'users' field."
+            )
 
     def get(self) -> UserGroup:
         """Reload the user group information from the server.
@@ -245,35 +246,34 @@ def update(self) -> UserGroup:
                     f"Project {project.uid} not found or inaccessible"
                 )
 
-        # Get default role if not set
-        if not self.default_role:
-            roles = self.client.get_roles()
-            self.default_role = roles.get("LABELER")
-            if not self.default_role:
-                raise ValueError("Unable to get default role for users")
+        # Validate default_role is set when legacy users field is used
+        if self.users and self.default_role is None:
+            raise ValueError(
+                "default_role must be set when using the 'users' field."
+            )
 
         # Filter eligible users and build user roles
         eligible_users = self._filter_project_based_users()
         user_roles = self._build_user_roles(eligible_users)
 
         query = """
-        mutation UpdateUserGroupPyApi($id: ID!, $name: String!, $color: String!, $projectIds: [ID!]!, $userRoles: [UserRoleInput!], $description: String, $notifyMembers: Boolean) {
+        mutation UpdateUserGroupPyApi($id: ID!, $name: String!, $description: String, $color: String!, $projectIds: [ID!]!, $userRoles: [UserRoleInput!], $notifyMembers: Boolean) {
             updateUserGroupV3(
                 where: { id: $id }
                 data: {
                     name: $name
+                    description: $description
                     color: $color
                     projectIds: $projectIds
                     userRoles: $userRoles
-                    description: $description
                     notifyMembers: $notifyMembers
                 }
             ) {
                 group {
                     id
                     name
-                    color
                     description
+                    color
                     projects { nodes { id name } totalCount }
                     members { 
                         nodes { id email orgRole { id name } } 
@@ -287,10 +287,10 @@ def update(self) -> UserGroup:
         params = {
             "id": self.id,
             "name": self.name,
+            "description": self.description,
             "color": self.color.value,
             "projectIds": [project.uid for project in self.projects],
             "userRoles": user_roles,
-            "description": self.description,
             "notifyMembers": self.notify_members,
         }
 
@@ -334,56 +334,54 @@ def create(self) -> UserGroup:
                     f"Project {project.uid} not found or inaccessible"
                 )
 
-        # Get default role if not set
-        if not self.default_role:
-            roles = self.client.get_roles()
-            self.default_role = roles.get("LABELER")
-            if not self.default_role:
-                raise ValueError("Unable to get default role for users")
+        # Validate default_role is set when legacy users field is used
+        if self.users and self.default_role is None:
+            raise ValueError(
+                "default_role must be explicitly set when using the 'users' field. "
+                "This ensures you are aware of what role will be assigned to legacy users."
+            )
 
         # Filter eligible users and build user roles
         eligible_users = self._filter_project_based_users()
         user_roles = self._build_user_roles(eligible_users)
 
         query = """
-        mutation CreateUserGroupPyApi($description: String, $color: String!, $name: String!, $projectIds: [ID!], $userRoles: [UserRoleInput!], $roleId: String, $searchQuery: AlignerrSearchServiceQuery, $notifyMembers: Boolean) {
+        mutation CreateUserGroupPyApi($name: String!, $description: String, $color: String!, $projectIds: [ID!], $userRoles: [UserRoleInput!], $notifyMembers: Boolean, $roleId: String, $searchQuery: AlignerrSearchServiceQuery) {
             createUserGroupV3(
                 data: {
                     name: $name
                     description: $description
                     color: $color
                     projectIds: $projectIds
                     userRoles: $userRoles
-                    searchQuery: $searchQuery
-                    roleId: $roleId
                     notifyMembers: $notifyMembers
+                    roleId: $roleId
+                    searchQuery: $searchQuery
                 }
             ) {
                 group {
                     id
                     name
+                    description
                     color
                     updatedAt
                     createdByUserName
-                    description
-                    __typename
                     projects { nodes { id name } totalCount }
                     members { 
                         nodes { id email orgRole { id name } } 
                         totalCount 
                     }
                 }
-                __typename
             }
         }
         """
 
         params = {
             "name": self.name,
+            "description": self.description,
             "color": self.color.value,
             "projectIds": [project.uid for project in self.projects],
             "userRoles": user_roles,
-            "description": self.description,
             "notifyMembers": self.notify_members,
             "roleId": None,
             "searchQuery": None,
@@ -505,7 +503,7 @@ def _filter_project_based_users(self) -> Set[User]:
 
         user_ids = [user.uid for user in all_users]
         query = """
-        query CheckUserOrgRoles($userIds: [ID!]!) {
+        query CheckUserOrgRolesPyApi($userIds: [ID!]!) {
             users(where: {id_in: $userIds}) {
                 id
                 orgRole { id name }

libs/labelbox/tests/integration/schema/test_user_group.py

@@ -145,6 +145,10 @@ def test_create_user_group_advanced(client, project_pack):
     projects = project_pack
     user = users[0]
     project = projects[0]
+
+    # Must set default_role when using users field
+    roles = client.get_roles()
+    user_group.default_role = roles["LABELER"]
     user_group.users.add(user)
     user_group.projects.add(project)
 
@@ -182,6 +186,8 @@ def test_create_user_group_advanced(client, project_pack):
             or "internal server error" in creation_error.lower()
             or "workspace wide role" in creation_error.lower()
             or "conflicts with the group role" in creation_error.lower()
+            or "default_role must be"
+            in creation_error.lower()  # New validation error
         )
 
 
@@ -498,6 +504,31 @@ def test_usergroup_functionality_demonstration(client, project_pack):
             pass
 
 
+def test_validation_users_without_default_role(client, project_pack):
+    """Test that using users field without default_role raises ValidationError."""
+    if not list(client.get_users()):
+        pytest.skip("No users available for testing")
+
+    group_name = f"{data.name()}_{int(time.time())}"
+    user_group = UserGroup(client)
+    user_group.name = group_name
+    user_group.color = (
+        UserGroupColor.RED
+        if hasattr(UserGroupColor, "RED")
+        else UserGroupColor.PINK
+    )
+    user_group.projects.add(project_pack[0])
+
+    users = list(client.get_users())
+    user_group.users.add(users[0])
+    # Deliberately NOT setting default_role
+
+    with pytest.raises(
+        ValueError, match="default_role must be.*when using the 'users' field"
+    ):
+        user_group.create()
+
+
 if __name__ == "__main__":
     import subprocess