From d62334fd583fa7c2d6c612bdba52b3ac2c6e502c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yulia=20=C4=8Cech?= <6585477+yuliacech@users.noreply.github.com> Date: Mon, 29 Jul 2024 18:39:09 +0200 Subject: [PATCH] [Console] Fix documentation link (#188977) ## Summary Fixes https://github.com/elastic/kibana/issues/186639 This PR changes the helper function that parses a line and return url path tokens and url params tokens that are used in the autocomplete system as input. This PR adds a filter to remove any empty tokens from the results. This should make the function work for urls starting with a slash, for example `/_search`. e2e tests for the documenation action are currently skipped as flaky, the fix for the tests is in #186641 ### 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) --- .../editor/monaco/utils/autocomplete_utils.ts | 12 +++++------- .../containers/editor/monaco/utils/constants.ts | 2 +- .../editor/monaco/utils/tokens_utils.test.ts | 16 +++++++++++++++- .../editor/monaco/utils/tokens_utils.ts | 6 +++--- 4 files changed, 24 insertions(+), 12 deletions(-) diff --git a/src/plugins/console/public/application/containers/editor/monaco/utils/autocomplete_utils.ts b/src/plugins/console/public/application/containers/editor/monaco/utils/autocomplete_utils.ts index 2eaf183058f75..3f23c4cce2418 100644 --- a/src/plugins/console/public/application/containers/editor/monaco/utils/autocomplete_utils.ts +++ b/src/plugins/console/public/application/containers/editor/monaco/utils/autocomplete_utils.ts @@ -43,10 +43,6 @@ export const getDocumentationLinkFromAutocomplete = ( ) => { // get the url parts from the request url const { urlPathTokens } = parseUrl(request.url); - // remove the last token, if it's empty - if (!urlPathTokens[urlPathTokens.length - 1]) { - urlPathTokens.pop(); - } // add the end of url token urlPathTokens.push(END_OF_URL_TOKEN); const { endpoint } = populateContextForMethodAndUrl(request.method, urlPathTokens); @@ -127,9 +123,11 @@ export const getUrlPathCompletionItems = ( // get the method and previous url parts for context const { method, urlPathTokens } = parseLine(lineContent); - // remove the last token that is either empty if the url has like "_search/" as the last char - // or it's a word that need to be replaced with autocomplete suggestions like "_search/s" - urlPathTokens.pop(); + // if the line ends with /, then we use all url path tokens for autocomplete suggestions + // otherwise, we want to ignore the last token + if (!lineContent.trim().endsWith('/')) { + urlPathTokens.pop(); + } const { autoCompleteSet } = populateContextForMethodAndUrl(method, urlPathTokens); const wordUntilPosition = model.getWordUntilPosition(position); diff --git a/src/plugins/console/public/application/containers/editor/monaco/utils/constants.ts b/src/plugins/console/public/application/containers/editor/monaco/utils/constants.ts index 1a83b1b17f045..5d6088653f243 100644 --- a/src/plugins/console/public/application/containers/editor/monaco/utils/constants.ts +++ b/src/plugins/console/public/application/containers/editor/monaco/utils/constants.ts @@ -15,7 +15,7 @@ export const SELECTED_REQUESTS_CLASSNAME = 'console__monaco_editor__selectedRequ export const whitespacesRegex = /\s+/; export const newLineRegex = /\n/; -export const slashRegex = /\//; +export const slashesRegex = /\/+/; export const ampersandRegex = /&/; export const equalsSignRegex = /=/; export const questionMarkRegex = /\?/; diff --git a/src/plugins/console/public/application/containers/editor/monaco/utils/tokens_utils.test.ts b/src/plugins/console/public/application/containers/editor/monaco/utils/tokens_utils.test.ts index e31864e4c05c6..702b9a589e662 100644 --- a/src/plugins/console/public/application/containers/editor/monaco/utils/tokens_utils.test.ts +++ b/src/plugins/console/public/application/containers/editor/monaco/utils/tokens_utils.test.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { parseBody, removeTrailingWhitespaces } from './tokens_utils'; +import { parseBody, removeTrailingWhitespaces, parseUrl } from './tokens_utils'; describe('tokens_utils', () => { describe('removeTrailingWhitespaces', () => { @@ -136,4 +136,18 @@ describe('tokens_utils', () => { }); } }); + + describe('parseUrl', () => { + it('groups more than 1 slashes together when splitting', () => { + const url = '_search//test'; + const result = parseUrl(url); + expect(result.urlPathTokens).toEqual(['_search', 'test']); + }); + + it('filters out empty tokens', () => { + const url = '/_search/test/'; + const result = parseUrl(url); + expect(result.urlPathTokens).toEqual(['_search', 'test']); + }); + }); }); diff --git a/src/plugins/console/public/application/containers/editor/monaco/utils/tokens_utils.ts b/src/plugins/console/public/application/containers/editor/monaco/utils/tokens_utils.ts index 2ff755b12af1d..2615bd2c45d74 100644 --- a/src/plugins/console/public/application/containers/editor/monaco/utils/tokens_utils.ts +++ b/src/plugins/console/public/application/containers/editor/monaco/utils/tokens_utils.ts @@ -12,7 +12,7 @@ import { newLineRegex, numberStartRegex, questionMarkRegex, - slashRegex, + slashesRegex, whitespacesRegex, } from './constants'; @@ -48,9 +48,9 @@ export const parseUrl = ( const urlParts = url.split(questionMarkRegex); // 1st part is the url path const urlPath = urlParts[0]; - // try to parse into url path tokens (split on slash) + // try to parse into url path tokens (split on slashes, only keep non-empty tokens) if (urlPath) { - urlPathTokens = urlPath.split(slashRegex); + urlPathTokens = urlPath.split(slashesRegex).filter(Boolean); } // 2nd part is the url params const urlParams = urlParts[1];