Skip to content

feat: Add support for MsgPack #118

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

Merged
merged 3 commits into from
Jul 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ require (
require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/shamaton/msgpack/v2 v2.2.3
github.com/x448/float16 v0.8.4 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/shamaton/msgpack/v2 v2.2.3 h1:uDOHmxQySlvlUYfQwdjxyybAOzjlQsD1Vjy+4jmO9NM=
github.com/shamaton/msgpack/v2 v2.2.3/go.mod h1:6khjYnkx73f7VQU7wjcFS9DFjs+59naVWJv1TB7qdOI=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
github.com/x448/float16 v0.8.4 h1:qLwI1I70+NjRFUR3zs1JPUCgaCXSh3SW62uAKT1mSBM=
Expand Down
2 changes: 2 additions & 0 deletions http.go
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ var statusMessage = []string{
// MIME types were copied from https://github.com/nginx/nginx/blob/67d2a9541826ecd5db97d604f23460210fd3e517/conf/mime.types with the following updates:
// - Use "application/xml" instead of "text/xml" as recommended per https://datatracker.ietf.org/doc/html/rfc7303#section-4.1
// - Use "text/javascript" instead of "application/javascript" as recommended per https://www.rfc-editor.org/rfc/rfc9239#name-text-javascript
// - Use "application/vnd.msgpack" from https://www.iana.org/assignments/media-types/application/vnd.msgpack
var mimeExtensions = map[string]string{
"html": "text/html",
"htm": "text/html",
Expand Down Expand Up @@ -187,6 +188,7 @@ var mimeExtensions = map[string]string{
"war": "application/java-archive",
"ear": "application/java-archive",
"json": "application/json",
"msgpack": "application/vnd.msgpack",
"hqx": "application/mac-binhex40",
"doc": "application/msword",
"pdf": "application/pdf",
Expand Down
9 changes: 9 additions & 0 deletions msgpack.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package utils

// MsgPackMarshal returns the MsgPack encoding of v.
type MsgPackMarshal func(v any) ([]byte, error)

// MsgPackUnmarshal parses the MsgPack-encoded data and stores the result
// in the value pointed to by v. If v is nil or not a pointer,
// Unmarshal returns an InvalidUnmarshalError.
type MsgPackUnmarshal func(data []byte, v any) error
51 changes: 51 additions & 0 deletions msgpack_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
package utils

import (
"testing"

"github.com/shamaton/msgpack/v2"
"github.com/stretchr/testify/require"
)

type sampleMsgPackStructure struct {
ImportantString string `msgpack:"important_string"`
}

func Test_MsgpackEncoder(t *testing.T) {
t.Parallel()

var (
ss = &sampleStructure{
ImportantString: "Hello World",
}
msgpackEncoder = msgpack.Marshal
)

raw, err := msgpackEncoder(ss)
require.NoError(t, err)

var decoded sampleStructure
err = msgpack.Unmarshal(raw, &decoded)
require.NoError(t, err)
require.Equal(t, ss.ImportantString, decoded.ImportantString)
}

func Test_MsgpackDecoder(t *testing.T) {
t.Parallel()

var (
ss = &sampleMsgPackStructure{
ImportantString: "Hello World",
}
msgpackEncoder = msgpack.Marshal
msgpackDecoder = msgpack.Unmarshal
)

raw, err := msgpackEncoder(ss)
require.NoError(t, err)

var decoded sampleMsgPackStructure
err = msgpackDecoder(raw, &decoded)
require.NoError(t, err)
require.Equal(t, "Hello World", decoded.ImportantString)
}
Loading