From 038be9fffa65a42a7bcd066d0a5d726fd3ab59b1 Mon Sep 17 00:00:00 2001 From: Stan Hu Date: Wed, 29 Aug 2018 09:38:17 -0700 Subject: [PATCH] Fix Error 500s due to encoding issues when Wiki hooks fire Saved Wiki content goes through the GitalyClient::WikiService, which calls StringIO#set_encoding on the input stream. The problem is that this call mutates the encoding of the given string object to ASCII-88BIT, which causes problems for models expecting the data to still be in UTF-8. Freezing the input disables this behavior: https://github.com/ruby/ruby/blob/v2_4_4/ext/stringio/stringio.c#L1583 Closes #50590 --- .../unreleased/sh-fix-error-500-updating-wikis.yml | 5 +++++ lib/gitlab/encoding_helper.rb | 2 +- spec/lib/gitlab/encoding_helper_spec.rb | 12 ++++++++++++ 3 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 changelogs/unreleased/sh-fix-error-500-updating-wikis.yml diff --git a/changelogs/unreleased/sh-fix-error-500-updating-wikis.yml b/changelogs/unreleased/sh-fix-error-500-updating-wikis.yml new file mode 100644 index 00000000000..cf7ca05914f --- /dev/null +++ b/changelogs/unreleased/sh-fix-error-500-updating-wikis.yml @@ -0,0 +1,5 @@ +--- +title: Fix Error 500s due to encoding issues when Wiki hooks fire +merge_request: +author: +type: fixed diff --git a/lib/gitlab/encoding_helper.rb b/lib/gitlab/encoding_helper.rb index d1fd5dfe0cb..0f336fbaa10 100644 --- a/lib/gitlab/encoding_helper.rb +++ b/lib/gitlab/encoding_helper.rb @@ -75,7 +75,7 @@ module Gitlab end def binary_stringio(str) - StringIO.new(str || '').tap { |io| io.set_encoding(Encoding::ASCII_8BIT) } + StringIO.new(str.freeze || '').tap { |io| io.set_encoding(Encoding::ASCII_8BIT) } end private diff --git a/spec/lib/gitlab/encoding_helper_spec.rb b/spec/lib/gitlab/encoding_helper_spec.rb index e68c9850f6b..a5bf2f2b3df 100644 --- a/spec/lib/gitlab/encoding_helper_spec.rb +++ b/spec/lib/gitlab/encoding_helper_spec.rb @@ -1,3 +1,4 @@ +# coding: utf-8 require "spec_helper" describe Gitlab::EncodingHelper do @@ -187,4 +188,15 @@ describe Gitlab::EncodingHelper do end end end + + describe '#binary_stringio' do + it 'does not mutate the original string encoding' do + test = 'my-test' + + io_stream = ext_class.binary_stringio(test) + + expect(io_stream.external_encoding.name).to eq('ASCII-8BIT') + expect(test.encoding.name).to eq('UTF-8') + end + end end