Internal server error when saving a widget with German characters in name by weltenwort · Pull Request #8705 · elastic/kibana

weltenwort · 2016-10-19T09:18:46Z

Kibana version:
5.0-rc2 snapshot, build 14376

Elasticsearch version:
5.0-rc1

Server OS version:
MacOS, El Capitan 10.11.6 (15G31)

Browser version:
Version 53.0.2785.143 (64-bit)

Browser OS version:
MacOS, El Capitan 10.11.6 (15G31)

Original install method (e.g. download page, yum, from source, etc.):
Manual tar

Description of the problem including expected versus actual behavior:
When creating widgets with special German characters (and m

Steps to reproduce:

Create any widget
Set name to something that has an umlaut (üäö) or German ß
Get internal server error

Errors in browser console (if relevant):

Error: Request to Elasticsearch failed: "Internal Server Error"
    at http://localhost:5601/bundles/kibana.bundle.js?v=14376:26:14736
    at processQueue (http://localhost:5601/bundles/commons.bundle.js?v=14376:38:23621)
    at http://localhost:5601/bundles/commons.bundle.js?v=14376:38:23888
    at Scope.$eval (http://localhost:5601/bundles/commons.bundle.js?v=14376:39:4619)
    at Scope.$digest (http://localhost:5601/bundles/commons.bundle.js?v=14376:39:2359)
    at Scope.$apply (http://localhost:5601/bundles/commons.bundle.js?v=14376:39:5037)
    at done (http://localhost:5601/bundles/commons.bundle.js?v=14376:37:25027)
    at completeRequest (http://localhost:5601/bundles/commons.bundle.js?v=14376:37:28702)
    at XMLHttpRequest.xhr.onload (http://localhost:5601/bundles/commons.bundle.js?v=14376:37:29634)

Error from Kibana log:

 error  [15:08:01.633]  Error: Uncaught error: Header value cannot contain or convert into non-ascii characters: location
    at Object.exports.assert (/Users/tanya/kibana-5.0.0-rc2-SNAPSHOT-darwin-x86_64/node_modules/hapi/node_modules/hoek/lib/index.js:736:11)
    at internals.Response._header (/Users/tanya/kibana-5.0.0-rc2-SNAPSHOT-darwin-x86_64/node_modules/hapi/lib/response.js:141:22)
    at internals.Response.header (/Users/tanya/kibana-5.0.0-rc2-SNAPSHOT-darwin-x86_64/node_modules/hapi/lib/response.js:119:17)
    at internals.Response._passThrough (/Users/tanya/kibana-5.0.0-rc2-SNAPSHOT-darwin-x86_64/node_modules/hapi/lib/response.js:502:26)
    at internals.Response._prepare (/Users/tanya/kibana-5.0.0-rc2-SNAPSHOT-darwin-x86_64/node_modules/hapi/lib/response.js:457:10)
    at process.nextTick (/Users/tanya/kibana-5.0.0-rc2-SNAPSHOT-darwin-x86_64/node_modules/hapi/lib/reply.js:152:22)
    at _combinedTickCallback (internal/process/next_tick.js:67:7)
    at process._tickDomainCallback (internal/process/next_tick.js:122:9)
Debug: internal, implementation, error 
    Error: Uncaught error: Header value cannot contain or convert into non-ascii characters: location
    at Object.exports.assert (/Users/tanya/kibana-5.0.0-rc2-SNAPSHOT-darwin-x86_64/node_modules/hapi/node_modules/hoek/lib/index.js:736:11)
    at internals.Response._header (/Users/tanya/kibana-5.0.0-rc2-SNAPSHOT-darwin-x86_64/node_modules/hapi/lib/response.js:141:22)
    at internals.Response.header (/Users/tanya/kibana-5.0.0-rc2-SNAPSHOT-darwin-x86_64/node_modules/hapi/lib/response.js:119:17)
    at internals.Response._passThrough (/Users/tanya/kibana-5.0.0-rc2-SNAPSHOT-darwin-x86_64/node_modules/hapi/lib/response.js:502:26)
    at internals.Response._prepare (/Users/tanya/kibana-5.0.0-rc2-SNAPSHOT-darwin-x86_64/node_modules/hapi/lib/response.js:457:10)
    at process.nextTick (/Users/tanya/kibana-5.0.0-rc2-SNAPSHOT-darwin-x86_64/node_modules/hapi/lib/reply.js:152:22)
    at _combinedTickCallback (internal/process/next_tick.js:67:7)
    at process._tickDomainCallback (internal/process/next_tick.js:122:9)

Interestingly, visualization is still saved on refresh.

Note: It's possible other languages and special characters are affected... I tested Russian, Japanese, and Bengali and didn't run into the same problem, but it was not thorough testing.

weltenwort · 2016-10-18T15:00:20Z

According to my analysis this error is caused by missing url encoding of the Location header in the response by ElasticSearch, which Kibana tries to forward to the browser. This fails because hapi < 15.0.0 applies strict header validation that only allows 7-bit encoded strings. From version 15.0.0 on hapi has removed that validation in favor of Node.js's less restrictive built-in validation (see hapijs/hapi#3065).

Possible workarounds and solutions would be to...

update to hapi >= 15.0.0 (probably feasable mid-term)
uri-encode the Location header manually before sending it on (quick workaround)
uri-encode the Location header in ElasticSearch before sending it

weltenwort · 2016-10-18T15:09:01Z

To add a few more details about the Location header as returned by ElasticSearch: Characters with code <= 255 seem to be returned as-is without encoding and everything else seems to be replaced with a ?.

spalger · 2016-10-18T15:25:53Z

@weltenwort I would rather not transform the headers coming back from Elasticsearch, but if @tylersmalley had a good reason for not going to 15+ it might be necessary. Either way it would be great if you would file an issue at elastic/elasticsearch.

weltenwort · 2016-10-18T18:15:55Z

@spalger I totally agree with header rewriting not being a great solution. But if we want this to be fixed before 5.0.0 GA I would feel apprehensive of making as big a change as upgrading to hapi.

tylersmalley · 2016-10-18T18:29:36Z

I agree with @weltenwort that upgrading to Hapi 15 would be a large change to get in at the last minute before GA. I will work on the upgrade path and see what is necessary. @weltenwort, do you want to go down the rewrite path?

kobelb · 2016-10-18T18:35:56Z

It would also theoretically be possible for us to fork hapijs@14 and cherry-pick this commit onto it, if the rewriting path doesn't work out hapijs/hapi@9f2bd3d

I tried this out locally, and it seemed to resolve the issue.

weltenwort · 2016-10-18T18:47:57Z

Yes, that's another possibility. I have a re-encode PR almost done though - just want to add some tests. Thanks for all your input! 🙇‍♂️

tylersmalley · 2016-10-18T21:12:10Z

I have a PR up, but still have quite a bit of testing to do: #8737

Right now there are situations in which ElasticSearch puts characters in the character code range between 128 and 255 into the `Location` header. This leads to an exception when trying to pass on that header through the hapi proxy in versions before 15.0.0, because it validates that only US-ASCII characters are used in headers. To work around that situation, the `Location` header is encoded using `encodeURI()` for now. Closes elastic#8705

Relates to elastic#8705

tylersmalley

LGTM

jbudz

spalger · 2016-10-19T17:36:05Z

src/core_plugins/elasticsearch/lib/create_proxy.js

        timeout: server.config().get('elasticsearch.requestTimeout'),
        onResponse: function (err, responseFromUpstream, request, reply) {
-          reply(err, responseFromUpstream);
+          const upstreamLocation = responseFromUpstream.headers.location;


I don't think we can depend on responseFromUpstream being defined if there was an error. We should probably early return if there was an error and then read the location header from the responseFromUpstream

--------- **Commit 1:** URI-encode forwarded location header in proxy Right now there are situations in which ElasticSearch puts characters in the character code range between 128 and 255 into the `Location` header. This leads to an exception when trying to pass on that header through the hapi proxy in versions before 15.0.0, because it validates that only US-ASCII characters are used in headers. To work around that situation, the `Location` header is encoded using `encodeURI()` for now. Closes #8705 * Original sha: 18c23c1 * Authored by Felix Stürmer <stuermer@weltenwort.de> on 2016-10-18T17:55:31Z **Commit 2:** Add test to verify umlaut in vis name Relates to #8705 * Original sha: e100e1f * Authored by Felix Stürmer <stuermer@weltenwort.de> on 2016-10-19T09:01:46Z **Commit 3:** [elasticsearch/proxy] use different code path with erorr * Original sha: fec5e1a * Authored by spalger <email@spalger.com> on 2016-10-19T19:06:39Z

Right now there are situations in which ElasticSearch puts characters in the character code range between 128 and 255 into the `Location` header. This leads to an exception when trying to pass on that header through the hapi proxy in versions before 15.0.0, because it validates that only US-ASCII characters are used in headers. To work around that situation, the `Location` header is encoded using `encodeURI()` for now. Closes elastic#8705

Relates to elastic#8705

--------- **Commit 1:** URI-encode forwarded location header in proxy Right now there are situations in which ElasticSearch puts characters in the character code range between 128 and 255 into the `Location` header. This leads to an exception when trying to pass on that header through the hapi proxy in versions before 15.0.0, because it validates that only US-ASCII characters are used in headers. To work around that situation, the `Location` header is encoded using `encodeURI()` for now. Closes elastic#8705 * Original sha: 03ccb8ec56eb92c86162e307a286305384ba92c3 [formerly 18c23c1] * Authored by Felix Stürmer <stuermer@weltenwort.de> on 2016-10-18T17:55:31Z **Commit 2:** Add test to verify umlaut in vis name Relates to elastic#8705 * Original sha: 238f6f64a55d113f30fd8f61f5330c1c97f23627 [formerly e100e1f] * Authored by Felix Stürmer <stuermer@weltenwort.de> on 2016-10-19T09:01:46Z **Commit 3:** [elasticsearch/proxy] use different code path with erorr * Original sha: 0f7e4548c7808d845bf0df661d9a3742b81f14da [formerly fec5e1a] * Authored by spalger <email@spalger.com> on 2016-10-19T19:06:39Z Former-commit-id: afbc790

`102.3.0` ⏩ `103.0.0` [Questions? Please see our Kibana upgrade FAQ.](https://github.com/elastic/eui/blob/main/wiki/eui-team-processes/upgrading-kibana.md#faq-for-kibana-teams) ## Changes [#8736](elastic/eui#8736), [#8732](elastic/eui#8732), and [#8732](elastic/eui#8732) include a number of small style tweaks `EuiResizableCollapseButton`, `EuiTitle`, and `EuiListGroupItem`. [#8756](elastic/eui#8756) and [#8744](elastic/eui#8744) rename a couple of icons: `questionInCircle` -> `question` `iInCircle` > `info` In both cases, the old name is **backwards-compatible** (unless importing directly from `assets` folder (see more in the release notes regarding that). However, the old name will eventually be deprecated as a part of a larger set of deprecations. **No action is required at this time to handle this renaming. We will issue a dedicated PR to Kibana to replace the old names with the new names in the future** [#8725](elastic/eui#8725) adds Sky Blue, Yellow, and Orange palettes to EUI's [color palettes](https://eui.elastic.co/docs/utilities/color-palettes/#recommended-quantitative-palettes), as well as new tokens for Risk, Neutral, and Warning. **[Breaking change]** Please note that as part of this change, the following tokens have been renamed: `euiColorVisNeutral0` -> `euiColorVisBase0` `euiColorVisWarning0` -> `euiColorVisWarning1` The original tokens still exist, but have been updated to use new colors in a way that would be breaking. This PR updates the existing references in 0b21d2d. ## Package updates ### `@elastic/eui` ## [`v103.0.0`](https://github.com/elastic/eui/releases/v103.0.0) - Replaced `question` icon glyph ([#8756](elastic/eui#8756)) - Updated `EuiResizableCollapseButton` to use an empty button ([#8736](elastic/eui#8736)) - Added `info` icon glyph ([#8744](elastic/eui#8744)) - Removed uppercase styling from `EuiText` `h6` headings to match `EuiTitle` ([#8732](elastic/eui#8732)) - Removed heavier font weight from `xs` and `s` `EuiListGroupItem` sizes for consistency ([#8732](elastic/eui#8732)) - Updated the `font-weight` of default `EuiFilterButton` and `EuiButtonGroupButton` to `450` ([#8734](elastic/eui#8734)) - Added color pallete functions and related hooks: ([#8725](elastic/eui#8725)) - `euiPaletteSkyBlue`, `useEuiPaletteSkyBlue` - `euiPaletteYellow`, `useEuiPaletteYellow` - `euiPaletteOrange`, `useEuiPaletteOrange` - Added new tokens on `colors.vis`: ([#8725](elastic/eui#8725)) - `euiColorVisNeutral0` - `euiColorVisNeutral1` - `euiColorVisWarning1` - `euiColorVisRisk0` - `euiColorVisRisk1` - Updated the value of token `colors.vis.euiColorVisWarning0` ([#8725](elastic/eui#8725)) - Updated EuiFilterButton's `numActiveFilters` prop to accept percentage values ([#8705](elastic/eui#8705)) **Bug fixes** - Fixed visual positioning issue for notifications in `EuiHeaderSectionItemButton` ([#8736](elastic/eui#8736)) - Fixed a visual issue where `EuiCollabsibleNavItem` did not have a visible selected state ([#8736](elastic/eui#8736)) - Fixed handling of unregistered code block languages in `EuiMarkdownFormat` ([#8729](elastic/eui#8729)) **Breaking changes** - Renamed `colors.vis.euiColorVisNeutral0` to `euiColorVisBase0` ([#8725](elastic/eui#8725)) ### `@elastic/eui-theme-borealis` ## [`v2.0.0`](https://github.com/elastic/eui/blob/main/packages/eui-theme-borealis/changelogs/CHANGELOG_2025.md#v200) - Added new tokens on `colors.vis`: ([#8725](elastic/eui#8725)) - `euiColorVisNeutral0` - `euiColorVisNeutral1` - `euiColorVisWarning1` - `euiColorVisRisk0` - `euiColorVisRisk1` - Updated the value of token `colors.vis.euiColorVisWarning0` ([#8725](elastic/eui#8725)) **Bug fixes** - Fixed missing source map warnings emitted by some bundlers by excluding source maps from being published ([#8764](elastic/eui#8764)) - To align with `@elastic/eui` and many other popular packages, we made a call to not ship source maps anymore **Breaking changes** - Renamed `colors.vis.euiColorVisNeutral0` to `euiColorVisBase0` ([#8725](elastic/eui#8725))  --------- Co-authored-by: Lene Gadewoll <lene.gadewoll@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

# Backport This will backport the following commits from `main` to `8.19`: - [Upgrade EUI to v103.0.0 (#223414)](#223414)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)

tbragin added bug Fixes for quality problems that affect the customer experience v5.0.0 labels Oct 16, 2016

weltenwort self-assigned this Oct 17, 2016

weltenwort added 2 commits October 19, 2016 11:16

Add test to verify umlaut in vis name

e100e1f

Relates to elastic#8705

weltenwort added v5.1.0 v6.0.0 review labels Oct 19, 2016

tylersmalley self-assigned this Oct 19, 2016

tylersmalley approved these changes Oct 19, 2016

View reviewed changes

jbudz self-assigned this Oct 19, 2016

jbudz approved these changes Oct 19, 2016

View reviewed changes

spalger suggested changes Oct 19, 2016

View reviewed changes

spalger mentioned this pull request Oct 19, 2016

Internal server error when saving a widget with German characters in name #8758

Merged

spalger closed this in #8758 Oct 19, 2016

This was referenced Oct 19, 2016

[backport] PR #8758 to 5.x - Internal server error when saving a widget with German characters in name #8761

Merged

[backport] PR #8758 to 5.0 - Internal server error when saving a widget with German characters in name #8762

Merged

nreese pushed a commit to nreese/kibana that referenced this pull request Nov 10, 2016

Add test to verify umlaut in vis name

c109113

Relates to elastic#8705

epixa added v5.1.1 and removed v5.1.0 labels Dec 8, 2016

weltenwort mentioned this pull request Dec 20, 2016

Remove Location header encoding workaround from ES proxy handler #9567

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Internal server error when saving a widget with German characters in name#8705

Internal server error when saving a widget with German characters in name#8705
weltenwort wants to merge 2 commits intoelastic:masterfrom
weltenwort:issue-8705-header-encoding

weltenwort commented Oct 19, 2016 •

edited by tbragin

Loading

Uh oh!

weltenwort commented Oct 18, 2016

Uh oh!

weltenwort commented Oct 18, 2016 •

edited

Loading

Uh oh!

spalger commented Oct 18, 2016

Uh oh!

weltenwort commented Oct 18, 2016

Uh oh!

tylersmalley commented Oct 18, 2016

Uh oh!

kobelb commented Oct 18, 2016

Uh oh!

weltenwort commented Oct 18, 2016

Uh oh!

tylersmalley commented Oct 18, 2016

Uh oh!

tylersmalley left a comment

Uh oh!

jbudz left a comment

Uh oh!

spalger Oct 19, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

weltenwort commented Oct 19, 2016 • edited by tbragin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

weltenwort commented Oct 18, 2016

Uh oh!

weltenwort commented Oct 18, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

spalger commented Oct 18, 2016

Uh oh!

weltenwort commented Oct 18, 2016

Uh oh!

tylersmalley commented Oct 18, 2016

Uh oh!

kobelb commented Oct 18, 2016

Uh oh!

weltenwort commented Oct 18, 2016

Uh oh!

tylersmalley commented Oct 18, 2016

Uh oh!

tylersmalley left a comment

Choose a reason for hiding this comment

Uh oh!

jbudz left a comment

Choose a reason for hiding this comment

Uh oh!

spalger Oct 19, 2016

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

weltenwort commented Oct 19, 2016 •

edited by tbragin

Loading

weltenwort commented Oct 18, 2016 •

edited

Loading