Skip to content

rename safeMarshal to mustMarshal #326

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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

rename safeMarshal to mustMarshal #326

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f199c6
safeMarshal should escape the error message
shogo82148 Sep 19, 2020
e1c6654
rename safeMarshal to mustMarshal
shogo82148 Sep 23, 2020
4ce5148
add a comment for mustMarshal
shogo82148 Sep 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions lambda/invoke_loop.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ import (
)

const (
serializationErrorFormat = `{"errorType": "Runtime.SerializationError", "errorMessage": "%s"}`
msPerS = int64(time.Second / time.Millisecond)
nsPerMS = int64(time.Millisecond / time.Nanosecond)
msPerS = int64(time.Second / time.Millisecond)
nsPerMS = int64(time.Millisecond / time.Nanosecond)
)

// startRuntimeAPILoop will return an error if handling a particular invoke resulted in a non-recoverable error
Expand Down Expand Up @@ -48,7 +47,7 @@ func handleInvoke(invoke *invoke, function *Function) error {
}

if functionResponse.Error != nil {
payload := safeMarshal(functionResponse.Error)
payload := mustMarshal(functionResponse.Error)
if err := invoke.failure(payload, contentTypeJSON); err != nil {
return fmt.Errorf("unexpected error occured when sending the function error to the API: %v", err)
}
Expand Down Expand Up @@ -100,10 +99,13 @@ func convertInvokeRequest(invoke *invoke) (*messages.InvokeRequest, error) {
return res, nil
}

func safeMarshal(v interface{}) []byte {
// mustMarshal is like json.Marshal but panics if the v cannot be marshaled.
// use this if you know the v doesn't contain values that json.Marshal can't marshal,
// such as Channel, complex, and function values.
func mustMarshal(v interface{}) []byte {
payload, err := json.Marshal(v)
if err != nil {
return []byte(fmt.Sprintf(serializationErrorFormat, err.Error()))
panic("lambda: " + err.Error())
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, I've misunderstood.
json.Marshal(v) doesn't return any error, because we know *messages.InvokeResponse_Error can be marshaled.
So, we don't need to treat this case, and just enough to panic.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"Must"-prefix is usually used in Go (e.g. https://golang.org/pkg/regexp/#MustCompile https://golang.org/pkg/html/template/#Must )

}
return payload
}