Add PureJSON renderer #694

ffigiel · 2016-08-31T18:02:49Z

Closes #693

ffigiel · 2016-08-31T18:03:42Z

Looks like it's not compiling 😆
The error is:

@PureJSON $ ~/gin > go test
# _/home/filip/gin
./context.go:427: undefined: render.PureJSON
FAIL    _/home/filip/gin [build failed]

could someone help me out? The code looks good to me.

Edit: error logs from travis were more helpful, will fix

coveralls · 2016-08-31T19:15:48Z

Coverage decreased (-0.1%) to 93.971% when pulling bcf1052 on megapctr:PureJSON into f931d1e on gin-gonic:develop.

cristaloleg · 2016-09-05T13:45:33Z

@megapctr Maybe you should add PureJSON interface{} here: https://github.com/rikuayanokozy/gin/blob/743cdd1a39fefa28e4e6f86d81a02b82512b433d/context.go#L499

ffigiel · 2016-09-05T15:24:16Z

@cristaloleg the problem is that this feature is available in go 1.7 only. I don't know how to handle that for earlier versions. Any tips?

ffigiel · 2016-09-05T15:26:39Z

I'm referring to encoder.SetEscapeHTML specifically

robvdl · 2016-09-06T18:50:43Z

Sorry for being a bit blunt, but the way you could be dealing with the Go 1.7 issue is by first releasing version 1.0 of Gin, it's about time to put a line in the sand and doing a 1.0 release (Gin to me seems a bit "stuck" to me as 1.0 never comes out). Then any Gin releases after 1.0 making them for Go 1.7 only. Then users of Go 1.6 and below can still use the 1.0 release if they want.

ffigiel · 2016-09-06T20:29:02Z

I see. It's ok for me to wait until gin is ready for the next step. Besides, this PR isn't any crucial feature at all. Sending a json works fine either way. With PureJSON you cut a few bytes off from the response size, which may be helpful in some rare cases

appleboy · 2017-03-12T06:33:52Z

@megapctr Could you fix the conflicts?

appleboy · 2018-08-17T01:43:07Z

@megapctr conflicts.

thinkerou · 2018-08-17T07:26:06Z

render/render_test.go

+		t,
+		w.Body.String(),
+		"{\"foo\":\"bar\",\"html\":\"\\u003cb\\u003e\"}\n")
+	assert.Equal(t, w.Header().Get("Content-Type"), "application/json; charset=utf-8")


should be assert.Equal(t, expect, actual)

thinkerou · 2018-08-17T07:27:52Z

@megapctr can you help to add example to readme? thanks!

thinkerou · 2018-08-17T07:35:40Z

compile error: render.PureJSON does not implement render.Render (missing WriteContentType method) @megapctr

ffigiel · 2018-08-17T07:41:25Z

I have trouble running tests locally so I'll rely on travis

ffigiel · 2018-08-17T07:52:19Z

@thinkerou you mean the main readme? I think it would be identical to the existing example, except it would use c.PureJSON instead of c.JSON.

What should I do to support go 1.6?

thinkerou · 2018-08-17T08:07:51Z

@megapctr add https://github.com/gin-gonic/gin#jsonp after. Now still support go1.6.

ffigiel · 2018-08-17T09:05:08Z

@appleboy What should I do about go 1.6?

appleboy · 2018-08-18T02:21:51Z

https://golang.org/doc/go1.7

maybe we should create new file and add build tag in top of file

// +build go1.7

ffigiel · 2018-08-18T19:35:08Z

Travis hates me today 😢 Apart from that is everything looking ok?

appleboy · 2018-08-19T01:28:10Z

context_17.go

@@ -0,0 +1,17 @@
+// 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.


appleboy · 2018-08-19T01:28:19Z

context_17_test.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.
+


appleboy · 2018-08-19T01:28:43Z

render/json_17.go

@@ -0,0 +1,28 @@
+// 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.


appleboy · 2018-08-19T01:28:53Z

render/render_17_test.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.
+


appleboy · 2018-08-19T15:06:49Z

@thinkerou I don't know why make vet only can't work on go latest version. maybe we can ignore the error from Travis.

thinkerou · 2018-08-20T01:34:16Z

Oh....@appleboy Makefile not update lead to the error, because the pull request commit to develop branch. so recommit to master branch or change it(how change?).

thinkerou · 2018-08-18T23:26:38Z

context_17_test.go

+func TestContextRenderPureJSON(t *testing.T) {
+	w := httptest.NewRecorder()
+	c, _ := CreateTestContext(w)
+	c.PureJSON(201, H{"foo": "bar", "html": "<b>"})


please change 201 to http status code

thinkerou · 2018-08-18T23:27:23Z

context_test.go

 func TestContextRenderJSON(t *testing.T) {
 	w := httptest.NewRecorder()
 	c, _ := CreateTestContext(w)

-	c.JSON(201, H{"foo": "bar"})
+	c.JSON(201, H{"foo": "bar", "html": "<b>"})

 	assert.Equal(t, 201, w.Code)


please change 201 to http status code

thinkerou · 2018-08-18T23:27:51Z

render/json_17.go

@@ -0,0 +1,28 @@
+// 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.

thinkerou · 2018-08-18T23:28:33Z

render/render_17_test.go

@@ -0,0 +1,26 @@
+// 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.

thinkerou · 2018-08-18T23:55:45Z

context_17_test.go

+	c, _ := CreateTestContext(w)
+	c.PureJSON(201, H{"foo": "bar", "html": "<b>"})
+	assert.Equal(t, 201, w.Code)
+	assert.Equal(t, "{\"foo\":\"bar\",\"html\":\"<b>\"}\n", w.Body.String())


thinkerou · 2018-08-18T23:56:21Z

context_test.go

+	assert.Equal(
+		t,
+		"{\"foo\":\"bar\",\"html\":\"\\u003cb\\u003e\"}",
+		w.Body.String())


suggest to use one line

thinkerou · 2018-08-18T23:56:42Z

render/render_test.go

+	assert.Equal(
+		t,
+		"{\"foo\":\"bar\",\"html\":\"\\u003cb\\u003e\"}\n",
+		w.Body.String())


suggest to use one line

thinkerou · 2018-08-20T01:41:25Z

@megapctr thanks a lot, firstly, can you fix some code according to my review result, secondly, please recommit the pull request to master branch, because it will error which pointed above. thanks again.

thinkerou

LGTM and thanks a lot!

appleboy

LGTM

bjm88 · 2018-12-17T01:46:26Z

Hi, specifically for context.PureJSON - in latest gin version dont see this as option...did I miss something or this never got into release from master? How to render json without escaping?

winjeg · 2019-01-22T04:21:25Z

Hi, specifically for context.PureJSON - in latest gin version dont see this as option...did I miss something or this never got into release from master? How to render json without escaping?

The latest release is on 14 Aug 2018.

v1.3.0
@javierprovecho javierprovecho released this on 14 Aug 2018 · 99 commits to master since this release

The feature is merged on 20 Aug 2018

appleboy merged commit c6110f9 into gin-gonic:master  on 20 Aug 2018

So you don't see the c.PureJSON() Method.
It took two years for those guys to solve this problem, but not yet released!

fix cleanPath spell (#969)

6613cdb

javierprovecho added the need-review label Jul 16, 2017

javierprovecho added this to the 1.x milestone Jul 16, 2017

javierprovecho mentioned this pull request Jul 17, 2017

Not escaping JSON when rendering responses #894

Closed

Merge branch 'master' into develop

79478c0

thinkerou added the feature label Aug 15, 2018

ffigiel added 2 commits August 17, 2018 09:12

Add PureJSON for rendering unescaped json data

ddb175b

Gofmt

5676689

thinkerou reviewed Aug 17, 2018

View reviewed changes

Fix missing NewEncoder

5c70490

thinkerou requested review from appleboy and thinkerou August 17, 2018 07:28

Fix tests style

f019519

Extract a method for writing content type

2000a13

ffigiel added 2 commits August 17, 2018 09:42

Create test context properly

fa2e05a

Update expected json content

147b479

appleboy added this to the 1.4 milestone Aug 17, 2018

ffigiel added 4 commits August 18, 2018 20:48

Don't include PureJSON in Go 1.6 and lower

a682226

Remove unused imports

df00f24

Remove unused imports

ac48b84

Re-run CI build

4152da4

appleboy requested changes Aug 19, 2018

View reviewed changes

Update copyrights for new files

a84483b

appleboy previously approved these changes Aug 19, 2018

View reviewed changes

thinkerou previously approved these changes Aug 20, 2018

View reviewed changes

ffigiel added 2 commits August 20, 2018 08:50

Apply requested changes

fbe37a5

Merge remote-tracking branch 'upstream/master' into PureJSON

ee988b5

ffigiel changed the base branch from develop to master August 20, 2018 06:52

Fix test

b1cf3bf

ffigiel dismissed stale reviews from thinkerou and appleboy via b1cf3bf August 20, 2018 06:55

Fix test

a847321

thinkerou approved these changes Aug 20, 2018

View reviewed changes

appleboy approved these changes Aug 20, 2018

View reviewed changes

appleboy merged commit c6110f9 into gin-gonic:master Aug 20, 2018

thinkerou mentioned this pull request Aug 20, 2018

fix compile error for -tags=jsoniter #1500

Merged

david7482 mentioned this pull request Jul 30, 2020

🚀 Add ctx.PureJSON() to response json without HTML escape gofiber/fiber#690

Closed

Add PureJSON renderer #694

Add PureJSON renderer #694

Conversation

ffigiel commented Aug 31, 2016

ffigiel commented Aug 31, 2016 • edited

coveralls commented Aug 31, 2016

cristaloleg commented Sep 5, 2016

ffigiel commented Sep 5, 2016

ffigiel commented Sep 5, 2016

robvdl commented Sep 6, 2016

ffigiel commented Sep 6, 2016

appleboy commented Mar 12, 2017

appleboy commented Aug 17, 2018

Choose a reason for hiding this comment

thinkerou commented Aug 17, 2018

thinkerou commented Aug 17, 2018 • edited

ffigiel commented Aug 17, 2018

ffigiel commented Aug 17, 2018

thinkerou commented Aug 17, 2018

ffigiel commented Aug 17, 2018 • edited

appleboy commented Aug 18, 2018

ffigiel commented Aug 18, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

appleboy commented Aug 19, 2018

thinkerou commented Aug 20, 2018

thinkerou Aug 18, 2018 • edited

Choose a reason for hiding this comment

thinkerou Aug 18, 2018 • edited

Choose a reason for hiding this comment

thinkerou Aug 18, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thinkerou commented Aug 20, 2018

thinkerou left a comment

Choose a reason for hiding this comment

appleboy left a comment

Choose a reason for hiding this comment

bjm88 commented Dec 17, 2018

winjeg commented Jan 22, 2019

ffigiel commented Aug 31, 2016 •

edited

thinkerou commented Aug 17, 2018 •

edited

ffigiel commented Aug 17, 2018 •

edited

thinkerou Aug 18, 2018 •

edited

thinkerou Aug 18, 2018 •

edited

thinkerou Aug 18, 2018 •

edited