Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix logentry.channel json marshaling/unmarshaling #264

Merged
merged 2 commits into from
Feb 24, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 20 additions & 1 deletion log_entry.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ type CommonLogEntryField struct {
// LogEntry is a list of all of the events that happened to an incident.
type LogEntry struct {
CommonLogEntryField
Incident Incident
Incident Incident `json:"incident"`
}

// ListLogEntryResponse is the response data when calling the ListLogEntry API endpoint.
Expand Down Expand Up @@ -115,8 +115,27 @@ func (c *Channel) UnmarshalJSON(b []byte) error {
ct, ok := raw["type"]
if ok {
c.Type = ct.(string)
delete(raw, "type")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I'm going to be a real pain in your rear here... For some reason it didn't dawn on me that removing this would also be a breaking change, and also make it not the raw object anymore. Would you have the spare moment to squash out this line? If not I can fix it after merging this PR.

Thank you so much for this contribution.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a problem at all. I'll send update shortly

c.Raw = raw
}

return nil
}

// MarshalJSON Expands the LogEntry.Channel object to correctly marshal it back
func (c *Channel) MarshalJSON() ([]byte, error) {
raw := map[string]interface{}{}
if c != nil && c.Type != "" {
raw["type"] = c.Type
for k, v := range c.Raw {
raw[k] = v
}
}

b, err := json.Marshal(raw)
if err != nil {
return nil, err
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suspect json.Marshal() effectively does the same thing. How would you feel about simplifying this error handling block all down to return json.Marshal(raw)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch. I'll fix it

}

return b, nil
}
48 changes: 48 additions & 0 deletions log_entry_test.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package pagerduty

import (
"encoding/json"
"net/http"
"testing"
)
Expand Down Expand Up @@ -72,3 +73,50 @@ func TestLogEntry_Get(t *testing.T) {
}
testEqual(t, want, res)
}

func TestChannel_MarhalUnmarshal(t *testing.T) {
logEntryRaw := []byte(`{
"id": "1",
"type": "trigger_log_entry",
"summary": "foo",
"channel": {
"type": "web_trigger",
"summary": "My new incident",
"details_omitted": false
}
}`)
want := &LogEntry{
CommonLogEntryField: CommonLogEntryField{
APIObject: APIObject{
ID: "1",
Type: "trigger_log_entry",
Summary: "foo",
},
Channel: Channel{
Type: "web_trigger",
Raw: map[string]interface{}{
"summary": "My new incident",
"details_omitted": false,
},
},
},
}

logEntry := &LogEntry{}
if err := json.Unmarshal(logEntryRaw, logEntry); err != nil {
t.Fatal(err)
}

testEqual(t, want, logEntry)

newLogEntryRaw, err := json.Marshal(logEntry)
if err != nil {
t.Fatal(err)
}

newLogEntry := &LogEntry{}
if err := json.Unmarshal(newLogEntryRaw, newLogEntry); err != nil {
t.Fatal(err)
}
testEqual(t, want, newLogEntry)
}