Merge pull request #96 from rollbar/pawel/extra_person

feat: Add support for extra fields on Person details

.gitignore

@@ -2,3 +2,4 @@ rollbar.test
 .env
 cover.out
 cover.html
+.idea

client.go

@@ -135,12 +135,25 @@ func (c *client) SetCustom(custom map[string]interface{}) {
 // SetPerson information for identifying a user associated with
 // any subsequent errors or messages. Only id is required to be
 // non-empty.
-func (c *client) SetPerson(id, username, email string) {
+
+type personOption func(*Person)
+
+func WithPersonExtra(extra map[string]string) personOption {
+	return func(p *Person) {
+		p.Extra = extra
+	}
+}
+func (c *client) SetPerson(id, username, email string, opts ...personOption) {
 	person := Person{
 		Id:       id,
 		Username: username,
 		Email:    email,
 	}
+	for _, opt := range opts {
+		// Call the option giving the instantiated
+		// *Person as the argument
+		opt(&person)
+	}
 
 	c.configuration.person = person
 }
@@ -634,6 +647,7 @@ type Person struct {
 	Id       string
 	Username string
 	Email    string
+	Extra    map[string]string
 }
 
 type pkey int

client_test.go

@@ -538,7 +538,9 @@ func TestSetPerson(t *testing.T) {
 	client := testClient()
 	id, username, email := "42", "bork", "bork@foobar.com"
 
-	client.SetPerson(id, username, email)
+	client.SetPerson(id, username, email, WithPersonExtra(map[string]string{
+		"person_extra1": "value1", "person_extra2": "value2", "id": "43"}))
+
 	client.ErrorWithLevel(ERR, errors.New("Person Bork"))
 
 	if transport, ok := client.Transport.(*TestTransport); ok {
@@ -554,6 +556,8 @@ func TestSetPerson(t *testing.T) {
 		errorIfNotEqual(id, person["id"], t)
 		errorIfNotEqual(username, person["username"], t)
 		errorIfNotEqual(email, person["email"], t)
+		errorIfNotEqual("value1", person["person_extra1"], t)
+		errorIfNotEqual("value2", person["person_extra2"], t)
 
 		configuredOptions := configuredOptionsFromData(data)
 		configuredPerson := configuredOptions["person"].(map[string]string)

rollbar.go

@@ -231,8 +231,8 @@ func SetCheckIgnore(checkIgnore func(string) bool) {
 // SetPerson information for identifying a user associated with
 // any subsequent errors or messages. Only id is required to be
 // non-empty.
-func SetPerson(id, username, email string) {
-	std.SetPerson(id, username, email)
+func SetPerson(id, username, email string, opts ...personOption) {
+	std.SetPerson(id, username, email, opts...)
 }
 
 // ClearPerson clears any previously set person information. See `SetPerson` for more information.

rollbar_test.go

@@ -62,6 +62,7 @@ func TestErrorClass(t *testing.T) {
 func TestEverything(t *testing.T) {
 	SetToken(os.Getenv("TOKEN"))
 	SetEnvironment("test")
+	SetPerson("1", "user", "email")
 	if Token() != os.Getenv("TOKEN") {
 		t.Error("Token should be as set")
 	}
@@ -106,6 +107,7 @@ type someNonstandardTypeForLogFailing struct{}
 func TestEverythingGeneric(t *testing.T) {
 	SetToken(os.Getenv("TOKEN"))
 	SetEnvironment("test")
+	SetPerson("1", "user", "email", WithPersonExtra(map[string]string{"v": "k"}))
 	SetCaptureIp(CaptureIpAnonymize)
 	if Token() != os.Getenv("TOKEN") {
 		t.Error("Token should be as set")

transforms.go

@@ -50,11 +50,19 @@ func buildBody(ctx context.Context, configuration configuration, diagnostic diag
 		person = &configuration.person
 	}
 	if person.Id != "" {
-		data["person"] = map[string]string{
+		personData := map[string]string{
 			"id":       person.Id,
 			"username": person.Username,
 			"email":    person.Email,
 		}
+		for key, value := range person.Extra {
+			// If the field on the extra map is already specified then skip it.
+			// This will prevent the extra map from overwriting fields like ID, Username or Email.
+			if _, ok := personData[key]; !ok {
+				personData[key] = value
+			}
+		}
+		data["person"] = personData
 	}
 
 	return map[string]interface{}{