Add support for Protobuf format response and unit test #1479

salamer · 2018-08-12T15:26:01Z

Gin now have the protobufBinding function to check the request format, but didn't have a protobuf response function like c.YAML().
In our company ByteDance, the largest internet company using golang in China, we use gin to transfer Protobuf instead of Json, we have to write some internal library to make some wrappers to achieve that, and the code is not elegant. So we really want such a feature.

codecov · 2018-08-12T15:31:18Z

Codecov Report

Merging #1479 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #1479      +/-   ##
==========================================
+ Coverage   99.15%   99.16%   +<.01%     
==========================================
  Files          36       37       +1     
  Lines        1894     1905      +11     
==========================================
+ Hits         1878     1889      +11     
  Misses         13       13              
  Partials        3        3

Impacted Files	Coverage Δ
render/render.go	`100% <ø> (ø)`	⬆️
context.go	`99.49% <100%> (ø)`	⬆️
render/protobuf.go	`100% <100%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f856aa8...47a973a. Read the comment docs.

salamer · 2018-08-12T16:26:24Z

Oh my god, the codecov is too strict 😂

thinkerou · 2018-08-15T04:03:02Z

@salamer please add some test case, thanks a lot!

thinkerou · 2018-08-15T04:04:50Z

context_test.go

@@ -17,11 +17,12 @@ import (
 	"testing"
 	"time"

+	"io"


order by first character.

salamer · 2018-08-15T04:13:40Z

I'm sorry, I'm too busy these days.
I will add some tests in this weekend. and can I generate a single proto file instead of using the proto from grpc exmaple

all code coverage > 99%

mkdir a test data dir.

"not match neither" means that it will match.

* add issue/pr template explain * add issue/pr template explain

…-gonic#1478) * docs: add changelog for v1.3.0, update authors and version const * add link for every referenced pull request (gin-gonic#1481) * docs: add changelog for v1.3.0, update authors and version const * add link for pr

upgrade lib version, and upgrade `github.com/json-iterator/go` to add two libs.

Add BindXML AND ShouldBindXML gin-gonic#1484

salamer · 2018-08-18T04:43:13Z

Oh my god, the 99.15% coverage is too strict. I have already filled all my new function test. could it be a little bit lower?
And thanks for the test data.

appleboy · 2018-08-18T04:55:47Z

context_test.go

+	protoData, err := proto.Marshal(data)
+	assert.NoError(t, err)
+
+	assert.Equal(t, 201, w.Code)


Please change 201 to http status code in net/http package.

appleboy · 2018-08-18T04:57:11Z

render/protobuf.go

+// Copyright 2014 Manu Martinez-Almeida.  All rights reserved.
+// Use of this source code is governed by a MIT style
+// license that can be found in the LICENSE file.
+


Please change to

// Copyright 2018 Gin Core Team. All rights reserved. // Use of this source code is governed by a MIT style // license that can be found in the LICENSE file.

fixed missed code bug replace 201 with http lib and update annotation

salamer · 2018-08-18T10:22:59Z

@appleboy Hi, I have already go pass all the test and update my code as what you commented.
I wanna know would it be a feature for Gin v1.4? I think maybe I can add some example in the README

appleboy · 2018-08-18T10:31:32Z

@salamer Yes. It would be a feature in v1.4 now. Please add an example in README.

…date some annotations

salamer · 2018-08-18T16:04:39Z

@appleboy @thinkerou Hi, I'm sorry I'm too busy these days, I can only submit code intermittently 😔. and I have already finished this feature and add clear example and annotation. I hope it can be merged😂😂

appleboy · 2018-08-19T01:30:55Z

@thinkerou need your approval.

thinkerou · 2018-08-19T02:39:39Z

@appleboy done

salamer added 2 commits August 12, 2018 14:46

Add support for Protobuf format response

5682f53

add TestRenderProtoBuf

42dd325

thinkerou mentioned this pull request Aug 13, 2018

Add support for Protobuf format response and test #1477

Closed

appleboy added this to the 1.4 milestone Aug 14, 2018

appleboy added the feature label Aug 14, 2018

appleboy requested review from appleboy, javierprovecho and thinkerou August 14, 2018 09:21

thinkerou reviewed Aug 15, 2018

View reviewed changes

context_test.go Outdated

@@ -17,11 +17,12 @@ import (

"testing"

"time"

"io"

Copy link

Member

thinkerou Aug 15, 2018

Choose a reason for hiding this comment

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

order by first character.

salamer and others added 17 commits August 18, 2018 11:07

add protobuf render test

11e1ba3

chore: add return or remove else for reduce indent (gin-gonic#1470)

1aa0e18

improve utils code coverage (gin-gonic#1473)

7d89b71

improve render code coverage (gin-gonic#1474)

df04038

all code coverage > 99%

unify test data (gin-gonic#1417)

a712509

mkdir a test data dir.

docs: remove double negative in README.md (gin-gonic#1480)

9ce5f61

"not match neither" means that it will match.

chore: use http.Status* instead of hard code (gin-gonic#1482)

85d33ff

add issue and pull request template explain (gin-gonic#1483)

06d50f1

* add issue/pr template explain * add issue/pr template explain

Fix typo in readme (gin-gonic#1490)

95fdb35

chore: upgrade dependency library version (gin-gonic#1491)

3cce9fb

upgrade lib version, and upgrade `github.com/json-iterator/go` to add two libs.

Add BindXML AND ShouldBindXML gin-gonic#1484 (gin-gonic#1485)

4e28f1e

Add BindXML AND ShouldBindXML gin-gonic#1484

Set default time format in form binding (gin-gonic#1487)

64ecab2

readme: fix users link (gin-gonic#1493)

b62f951

Fix typo in README [ci skip] (gin-gonic#1492)

6af1a17

Update readme about the version of gin (gin-gonic#1494)

65a97e1

add full protobuf rendering test

b6cb77e

salamer force-pushed the ProtobufResponseTest branch from eafd9bf to b6cb77e Compare August 18, 2018 03:51

fixed typo

86fe335

salamer force-pushed the ProtobufResponseTest branch from d5902a6 to 86fe335 Compare August 18, 2018 04:01

appleboy requested changes Aug 18, 2018

View reviewed changes

appleboy requested review from appleboy and thinkerou August 18, 2018 04:58

salamer added 2 commits August 18, 2018 18:04

fixed missed code

8ba804b

fixed missed code bug replace 201 with http lib and update annotation

filled test

75aa0c0

salamer force-pushed the ProtobufResponseTest branch from da3709c to 75aa0c0 Compare August 18, 2018 10:05

update annotation of protobuf

5be19bd

add some protobuf rendering examples in README, add some tests and up…

e51d726

…date some annotations

salamer force-pushed the ProtobufResponseTest branch from 9488723 to e51d726 Compare August 18, 2018 15:31

update the README code annotations, make it more clear

47a973a

appleboy approved these changes Aug 19, 2018

View reviewed changes

thinkerou approved these changes Aug 19, 2018

View reviewed changes

appleboy merged commit efdd3c8 into gin-gonic:master Aug 19, 2018

This was referenced Aug 19, 2018

I need change default binding and render #1445

Closed

not use protobuf on context but use it on render #1496

Merged

dmarkham mentioned this pull request Apr 15, 2019

Huge dependency #1847

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Protobuf format response and unit test #1479

Add support for Protobuf format response and unit test #1479

salamer commented Aug 12, 2018 •

edited

Loading

codecov bot commented Aug 12, 2018 •

edited

Loading

salamer commented Aug 12, 2018

thinkerou commented Aug 15, 2018

thinkerou Aug 15, 2018

salamer commented Aug 15, 2018

salamer commented Aug 18, 2018

appleboy Aug 18, 2018

appleboy Aug 18, 2018

salamer commented Aug 18, 2018

appleboy commented Aug 18, 2018

salamer commented Aug 18, 2018

appleboy commented Aug 19, 2018

thinkerou commented Aug 19, 2018

Add support for Protobuf format response and unit test #1479

Add support for Protobuf format response and unit test #1479

Conversation

salamer commented Aug 12, 2018 • edited Loading

codecov bot commented Aug 12, 2018 • edited Loading

Codecov Report

salamer commented Aug 12, 2018

thinkerou commented Aug 15, 2018

thinkerou Aug 15, 2018

Choose a reason for hiding this comment

salamer commented Aug 15, 2018

salamer commented Aug 18, 2018

appleboy Aug 18, 2018

Choose a reason for hiding this comment

appleboy Aug 18, 2018

Choose a reason for hiding this comment

salamer commented Aug 18, 2018

appleboy commented Aug 18, 2018

salamer commented Aug 18, 2018

appleboy commented Aug 19, 2018

thinkerou commented Aug 19, 2018

salamer commented Aug 12, 2018 •

edited

Loading

codecov bot commented Aug 12, 2018 •

edited

Loading