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

[Index Management] Index details page doesn't work for indices with special characters #166100

Closed
yuliacech opened this issue Sep 8, 2023 · 2 comments · Fixed by #166882
Closed

[Index Management] Index details page doesn't work for indices with special characters #166100

yuliacech opened this issue Sep 8, 2023 · 2 comments · Fixed by #166882
Assignees
@yuliacech
Labels
bug Fixes for quality problems that affect the customer experience Feature:Index Management Index and index templates UI Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more

Comments

@yuliacech
Copy link
Contributor

The new index details page is not working when the index name contains special characters, for example %.
To reproduce

  1. Start Kibana with details page enabled in the config/kibana.dev.yml file: xpack.index_management.dev.enableIndexDetailsPage: true
  2. Create an index in Dev Tools Console PUT test_index%
  3. Navigate to Index Management and click the index name to open the index details page

The page should be displayed correctly and all tabs should be working. Currently, the page is not loading.
@yuliacech yuliacech added bug Fixes for quality problems that affect the customer experience Feature:Index Management Index and index templates UI Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more labels Sep 8, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/platform-deployment-management (Team:Deployment Management)

@alisonelizabeth
Copy link
Contributor

Including related issues for reference:

@yuliacech yuliacech self-assigned this Sep 18, 2023
This was referenced Sep 20, 2023
Merged
Open
yuliacech added a commit that referenced this issue Sep 22, 2023
@yuliacech @kibanamachine @alisonelizabeth
[Index Management] Fix encoding issue on index details page (#166882)
213ef56 
## Summary
Fixes #166100

This PR adds a workaround fix for the new index details page when
opening for index names with special characters, for example
`test_index%`. Because of how encoding/decoding works, we can't use the
index name as a part of the url like `/indices/${indexName}` (see for
more details). Instead we have to pass the index name in a query
parameter like `/indices/index_details?indexName=${indexName}. The
downside of this workaround is that the url semantics doesn't reflect
that the index name is mandatory for the page to work. Once
#132600 is resolved, we should
revert this workaround and use the index name as a url segment again.

Note for reviewers: The jest tests for this fix are part of
#165705

### How to test
1. Add `xpack.index_management.dev.enableIndexDetailsPage: true` to the
file `config/kibana.dev.yml` to enable the new index details page
2. Navigate to Index Management and use the "create index" button 
3. Type a name with special characters, for example `test%`
4. Click the new index name in the list and check that the details page
and all tabs work
5. Also reload the page completely and check that the page still loads
correctly

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
joemcelroy pushed a commit to joemcelroy/kibana that referenced this issue Sep 25, 2023
@yuliacech @kibanamachine
@alisonelizabeth @joemcelroy
[Index Management] Fix encoding issue on index details page (elastic#…
7a4eea8 
…166882)

## Summary
Fixes elastic#166100

This PR adds a workaround fix for the new index details page when
opening for index names with special characters, for example
`test_index%`. Because of how encoding/decoding works, we can't use the
index name as a part of the url like `/indices/${indexName}` (see for
more details). Instead we have to pass the index name in a query
parameter like `/indices/index_details?indexName=${indexName}. The
downside of this workaround is that the url semantics doesn't reflect
that the index name is mandatory for the page to work. Once
elastic#132600 is resolved, we should
revert this workaround and use the index name as a url segment again.

Note for reviewers: The jest tests for this fix are part of
elastic#165705

### How to test
1. Add `xpack.index_management.dev.enableIndexDetailsPage: true` to the
file `config/kibana.dev.yml` to enable the new index details page
2. Navigate to Index Management and use the "create index" button 
3. Type a name with special characters, for example `test%`
4. Click the new index name in the list and check that the details page
and all tabs work
5. Also reload the page completely and check that the page still loads
correctly

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yuliacech yuliacech

Labels
bug Fixes for quality problems that affect the customer experience Feature:Index Management Index and index templates UI Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Index Management] Fix encoding issue on index details page yuliacech/kibana
3 participants
@alisonelizabeth @yuliacech @elasticmachine