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.

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

Jump to bottom

fix: set reply's default charset to utf8 #3789

Merged
merged 2 commits into from
Mar 22, 2022
Merged

fix: set reply's default charset to utf8 #3789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80f1eea
fix: bug fix https://github.com/fastify/fastify/issues/3788
xtx1130 Mar 22, 2022
7a1d9d9
test: delete unref, use teardown instead
xtx1130 Mar 22, 2022
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
1 change: 1 addition & 0 deletions docs/Reference/Reply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,7 @@ Sets the content type for the response. This is a shortcut for
```js
reply.type('text/html')
```
When set `Content-Type` with json type, if you don't set `charset`, it will use `utf-8` by default.
Copy link
Member

@Fdawgs Fdawgs Mar 22, 2022 •
edited

Choose a reason for hiding this comment

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

Suggested change
When set `Content-Type` with json type, if you don't set `charset`, it will use `utf-8` by default.
If the `Content-Type` has a JSON subtype, and the charset parameter is not set, `utf-8` will be used as the charset by default.

Copy link
Member

Choose a reason for hiding this comment

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

Ooops, I missed this. I'll amend on main.

Copy link
Member

Choose a reason for hiding this comment

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

Cheers @mcollina!


### .serializer(func)
<a id="serializer"></a>
Expand Down
20 changes: 6 additions & 14 deletions lib/reply.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,22 +158,14 @@ Reply.prototype.send = function (payload) {
if (hasContentType === false) {
this[kReplyHeaders]['content-type'] = CONTENT_TYPE.JSON
} else {
// If hasContentType === true, we have a JSON mimetype
// If user doesn't set charset, we will set charset to utf-8
if (contentType.indexOf('charset') === -1) {
// If we have simply application/json instead of a custom json mimetype
if (contentType.indexOf('/json') > -1) {
this[kReplyHeaders]['content-type'] = CONTENT_TYPE.JSON
const customContentType = contentType.trim()
if (customContentType.lastIndexOf(';') === customContentType.length - 1) {
// custom content-type is ended with ';'
this[kReplyHeaders]['content-type'] = `${customContentType} charset=utf-8`
} else {
const currContentType = this[kReplyHeaders]['content-type']
// We extract the custom mimetype part (e.g. 'hal+' from 'application/hal+json')
const customJsonType = currContentType.substring(
currContentType.indexOf('/'),
currContentType.indexOf('json') + 4
)

// We ensure we set the header to the proper JSON content-type if necessary
// (e.g. 'application/hal+json' instead of 'application/json')
this[kReplyHeaders]['content-type'] = CONTENT_TYPE.JSON.replace('/json', customJsonType)
this[kReplyHeaders]['content-type'] = `${customContentType}; charset=utf-8`
}
}
}
Expand Down
70 changes: 47 additions & 23 deletions test/internals/reply.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ test('within an instance', t => {

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

test('custom serializer should be used', t => {
t.plan(3)
Expand Down Expand Up @@ -424,7 +424,7 @@ test('buffer without content type should send a application/octet-stream and raw

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

sget({
method: 'GET',
Expand All @@ -449,7 +449,7 @@ test('buffer with content type should not send application/octet-stream', t => {

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

sget({
method: 'GET',
Expand Down Expand Up @@ -477,7 +477,7 @@ test('stream with content type should not send application/octet-stream', t => {

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))
sget({
method: 'GET',
url: 'http://localhost:' + fastify.server.address().port
Expand All @@ -503,7 +503,7 @@ test('stream without content type should not send application/octet-stream', t =

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))
sget({
method: 'GET',
url: 'http://localhost:' + fastify.server.address().port
Expand Down Expand Up @@ -538,7 +538,7 @@ test('stream using reply.raw.writeHead should return customize headers', t => {

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))
sget({
method: 'GET',
url: 'http://localhost:' + fastify.server.address().port
Expand All @@ -562,7 +562,7 @@ test('plain string without content type should send a text/plain', t => {

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

sget({
method: 'GET',
Expand All @@ -586,7 +586,7 @@ test('plain string with content type should be sent unmodified', t => {

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

sget({
method: 'GET',
Expand All @@ -613,7 +613,7 @@ test('plain string with content type and custom serializer should be serialized'

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

sget({
method: 'GET',
Expand All @@ -637,7 +637,7 @@ test('plain string with content type application/json should NOT be serialized a

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

sget({
method: 'GET',
Expand Down Expand Up @@ -690,7 +690,7 @@ test('plain string with custom json content type should NOT be serialized as jso

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

Object.keys(customSamples).forEach((path) => {
sget({
Expand All @@ -716,7 +716,7 @@ test('non-string with content type application/json SHOULD be serialized as json

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

sget({
method: 'GET',
Expand All @@ -729,6 +729,30 @@ test('non-string with content type application/json SHOULD be serialized as json
})
})

test('non-string with custom json\'s content-type SHOULD be serialized as json', t => {
t.plan(4)

const fastify = require('../..')()

fastify.get('/', function (req, reply) {
reply.type('application/json; version=2; ').send({ key: 'hello world!' })
})

fastify.listen({ port: 0 }, err => {
t.error(err)
t.teardown(fastify.close.bind(fastify))

sget({
method: 'GET',
url: 'http://localhost:' + fastify.server.address().port
}, (err, response, body) => {
t.error(err)
t.equal(response.headers['content-type'], 'application/json; version=2; charset=utf-8')
t.same(body.toString(), JSON.stringify({ key: 'hello world!' }))
})
})
})

test('non-string with custom json content type SHOULD be serialized as json', t => {
t.plan(16)

Expand Down Expand Up @@ -765,7 +789,7 @@ test('non-string with custom json content type SHOULD be serialized as json', t

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

Object.keys(customSamples).forEach((path) => {
sget({
Expand Down Expand Up @@ -830,7 +854,7 @@ test('undefined payload should be sent as-is', t => {

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

sget({
method: 'GET',
Expand Down Expand Up @@ -875,7 +899,7 @@ test('for HEAD method, no body should be sent but content-length should be', t =

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

sget({
method: 'HEAD',
Expand Down Expand Up @@ -923,7 +947,7 @@ test('reply.send(new NotFound()) should not invoke the 404 handler', t => {
fastify.listen({ port: 0 }, err => {
t.error(err)

fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

sget({
method: 'GET',
Expand Down Expand Up @@ -969,7 +993,7 @@ test('reply can set multiple instances of same header', t => {

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

sget({
method: 'GET',
Expand All @@ -996,7 +1020,7 @@ test('reply.hasHeader returns correct values', t => {

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))
sget({
method: 'GET',
url: 'http://localhost:' + fastify.server.address().port + '/headers'
Expand Down Expand Up @@ -1025,7 +1049,7 @@ test('reply.getHeader returns correct values', t => {

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))
sget({
method: 'GET',
url: 'http://localhost:' + fastify.server.address().port + '/headers'
Expand Down Expand Up @@ -1095,7 +1119,7 @@ test('reply.removeHeader can remove the value', t => {

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))
sget({
method: 'GET',
url: 'http://localhost:' + fastify.server.address().port + '/headers'
Expand All @@ -1122,7 +1146,7 @@ test('reply.header can reset the value', t => {

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))
sget({
method: 'GET',
url: 'http://localhost:' + fastify.server.address().port + '/headers'
Expand Down Expand Up @@ -1151,7 +1175,7 @@ test('reply.hasHeader computes raw and fastify headers', t => {

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))
sget({
method: 'GET',
url: 'http://localhost:' + fastify.server.address().port + '/headers'
Expand Down Expand Up @@ -1320,7 +1344,7 @@ test('reply.header setting multiple cookies as multiple Set-Cookie headers', t =

fastify.listen({ port: 0 }, err => {
t.error(err)
fastify.server.unref()
t.teardown(fastify.close.bind(fastify))

sget({
method: 'GET',
Expand Down