Merge pull request #106 from onelogin/fix/role-empty-arrays

fix: ensure empty arrays are properly serialized in Role updates

Author: Subterrane

changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [4.5.1]
+
+### Fixed
+- Fixed issue with empty arrays in Role updates by ensuring empty arrays are properly serialized in JSON
+- Added documentation example for removing all users from a role
+
 ## [4.5.0]
 
 ### Improved

docs/usage_examples.md

@@ -74,6 +74,15 @@ func main() {
 		fmt.Println(err)
 	}
 	fmt.Printf("Updated role: %+v\n", updatedRole)
+	
+	// Remove all users from a role by passing an empty array
+	roleWithNoUsers, err := client.UpdateRole(roleID, &models.Role{
+		Users: []int32{}, // Empty array will remove all users
+	})
+	if err != nil {
+		fmt.Println(err)
+	}
+	fmt.Printf("Updated role with no users: %+v\n", roleWithNoUsers)
 }
 ```
 

pkg/onelogin/models/role.go

@@ -1,19 +1,51 @@
 package models
 
+import "encoding/json"
+
 // RoleQuery represents available query parameters
 type RoleQuery struct {
 	Limit  string `json:"limit,omitempty"`
 	Page   string `json:"page,omitempty"`
 	Cursor string `json:"cursor,omitempty"`
 }
 
+// initSlice ensures that a nil slice is initialized as an empty slice
+// This helper is needed for the Role.MarshalJSON method
+func initSlice(s []int32) []int32 {
+	if s == nil {
+		return []int32{}
+	}
+	return s
+}
+
 // Role represents the Role resource in OneLogin
 type Role struct {
 	ID     *int32  `json:"id,omitempty"`
 	Name   *string `json:"name,omitempty"`
-	Admins []int32 `json:"admins,omitempty"`
-	Apps   []int32 `json:"apps,omitempty"`
-	Users  []int32 `json:"users,omitempty"`
+	Admins []int32 `json:"admins"`
+	Apps   []int32 `json:"apps"`
+	Users  []int32 `json:"users"`
+}
+
+// MarshalJSON provides custom JSON marshaling to ensure empty arrays are included in the JSON output
+func (r *Role) MarshalJSON() ([]byte, error) {
+	// Create a map to hold the serialized fields
+	m := make(map[string]interface{})
+	
+	// Add ID and Name if they are not nil
+	if r.ID != nil {
+		m["id"] = *r.ID
+	}
+	if r.Name != nil {
+		m["name"] = *r.Name
+	}
+	
+	// Always include the arrays, even if they're nil (as empty arrays)
+	m["admins"] = initSlice(r.Admins)
+	m["apps"] = initSlice(r.Apps)
+	m["users"] = initSlice(r.Users)
+	
+	return json.Marshal(m)
 }
 
 func (r *Role) GetKeyValidators() map[string]func(interface{}) bool {

tests/api_test.go

@@ -2,12 +2,14 @@ package tests
 
 import (
 	"bytes"
+	"encoding/json"
 	"io"
 	"net/http"
 	"testing"
 
 	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/api"
 	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/authentication"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/models"
 )
 
 type MockHttpClient struct {
@@ -142,3 +144,60 @@ func TestClientDeleteWithBody(t *testing.T) {
 		t.Fatalf("Expected ``, got %s", string(body))
 	}
 }
+
+func TestRoleEmptyArraysSerialization(t *testing.T) {
+	// Create role with empty arrays
+	role := &models.Role{
+		Name:   new(string),
+		Users:  []int32{}, // Empty array
+		Admins: []int32{}, // Empty array
+		Apps:   []int32{}, // Empty array
+	}
+	*role.Name = "Test Role"
+
+	// Serialize to JSON
+	jsonData, err := json.Marshal(role)
+	if err != nil {
+		t.Fatalf("Failed to marshal role: %v", err)
+	}
+
+	// Verify that empty arrays are included in JSON
+	jsonStr := string(jsonData)
+	t.Logf("Serialized JSON: %s", jsonStr)
+
+	// Check for empty arrays in the JSON
+	if !bytes.Contains(jsonData, []byte(`"users":[]`)) {
+		t.Error("JSON should contain empty users array")
+	}
+	if !bytes.Contains(jsonData, []byte(`"admins":[]`)) {
+		t.Error("JSON should contain empty admins array")
+	}
+	if !bytes.Contains(jsonData, []byte(`"apps":[]`)) {
+		t.Error("JSON should contain empty apps array")
+	}
+
+	// Also check with nil slices
+	roleWithNil := &models.Role{
+		Name: role.Name,
+		// All arrays are nil by default
+	}
+
+	jsonData, err = json.Marshal(roleWithNil)
+	if err != nil {
+		t.Fatalf("Failed to marshal role with nil arrays: %v", err)
+	}
+
+	jsonStr = string(jsonData)
+	t.Logf("Serialized JSON with nil arrays: %s", jsonStr)
+
+	// Check for empty arrays in the JSON
+	if !bytes.Contains(jsonData, []byte(`"users":[]`)) {
+		t.Error("JSON should contain empty users array for nil slice")
+	}
+	if !bytes.Contains(jsonData, []byte(`"admins":[]`)) {
+		t.Error("JSON should contain empty admins array for nil slice")
+	}
+	if !bytes.Contains(jsonData, []byte(`"apps":[]`)) {
+		t.Error("JSON should contain empty apps array for nil slice")
+	}
+}