[Files] Cannot preview or download files with special characters #173138
Assignees
Labels
bug
Fixes for quality problems that affect the customer experience
Feature:Cases
Cases feature
feature:Files
Team:SharedUX
Team label for AppEx-SharedUX (formerly Global Experience)
v8.10.4
v8.11.3
v8.12.0
v8.13.0
Comments
cnasikas
added
bug
|
Pinging @elastic/response-ops-cases (Feature:Cases) |
|
Pinging @elastic/appex-sharedux (Team:SharedUX) |
|
This looks similar to the issue fixed for Reporting in #153158 |
|
Fix confirmed. The same file provided was used to following the steps outlined in the video attached to this issue, and the preview content is visible. |
|
@eokoneyo Which PR fixed the issue? Thanks! |
|
Update: Following up with @cnasikas over slack the thing to note here is the file name relates to the issue, and I had previously used the provided file in the issue as is, which didn't have a file naming issue. |
eokoneyo
added a commit
that referenced
this issue
Feb 19, 2024
…ownloads (#176822) ## Summary closes; #173138 Looking into this, it turns out this issue was happening because the header value for `content-disposition` contained invalid characters given we were using the filename as is. See Screenshot resulting from debugging the request; <img width="846" alt="Screenshot 2024-02-13 at 13 38 53" src="https://github.com/elastic/kibana/assets/7893459/c1fbc09c-53c3-4d5b-8ba9-8752a56a9a6b"> To fix this, I've opted to leverage the ~package [content-disposition](https://github.com/jshttp/content-disposition), in place of some custom approach to fix this~ `res.file` handler which correctly handles computation for content-disposition in place of `res.ok` ~and providing our own computation of the value for content-disposition~. ## Verifying the fix: - Navigate to cases, (found in the the nav menu for stack management) - create a new case, if there isn't one you can readily use - click the files tab and grab an image you'd like to upload, before you do rename said image to `Screenshot 2023-12-11 at 1 29 07 PM` keeping it's extension - on image upload complete, you should be able to view the preview for the just uploaded image. <!-- ### Checklist Delete any items that are not applicable to this PR. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) -->
fkanout
pushed a commit
to fkanout/kibana
that referenced
this issue
Mar 4, 2024
…ownloads (elastic#176822) ## Summary closes; elastic#173138 Looking into this, it turns out this issue was happening because the header value for `content-disposition` contained invalid characters given we were using the filename as is. See Screenshot resulting from debugging the request; <img width="846" alt="Screenshot 2024-02-13 at 13 38 53" src="https://github.com/elastic/kibana/assets/7893459/c1fbc09c-53c3-4d5b-8ba9-8752a56a9a6b"> To fix this, I've opted to leverage the ~package [content-disposition](https://github.com/jshttp/content-disposition), in place of some custom approach to fix this~ `res.file` handler which correctly handles computation for content-disposition in place of `res.ok` ~and providing our own computation of the value for content-disposition~. ## Verifying the fix: - Navigate to cases, (found in the the nav menu for stack management) - create a new case, if there isn't one you can readily use - click the files tab and grab an image you'd like to upload, before you do rename said image to `Screenshot 2023-12-11 at 1 29 07 PM` keeping it's extension - on image upload complete, you should be able to view the preview for the just uploaded image. <!-- ### Checklist Delete any items that are not applicable to this PR. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Cases use the Kibana File Service to upload files to a case. For some filenames, for example
Screenshot 2023-12-11 at 1 29 07 PM, the previewer does not work. Theapi/files/files<kind_id>/<file_id>/blobendpoint returns a500error.Steps to reproduce the bug:
https://github.com/elastic/kibana/assets/7871006/564abab0-d126-4f42-a36f-5e80825b196a
Image to use for upload:
The text was updated successfully, but these errors were encountered: