Fix autocomplete triggering on URL tokens#168956
Merged
sakurai-youhei merged 6 commits intoelastic:mainfrom Oct 23, 2023
Merged
Fix autocomplete triggering on URL tokens#168956sakurai-youhei merged 6 commits intoelastic:mainfrom
sakurai-youhei merged 6 commits intoelastic:mainfrom
Conversation
yuliacech
reviewed
Oct 16, 2023
Contributor
yuliacech
left a comment
There was a problem hiding this comment.
Hi @sakurai-youhei, I tested locally and still seeing the issue: autocomplete suggestions are not immediately displayed. I clarified more and added a screen recording in this comment.
Member
Author
|
@elasticmachine merge upstream |
Member
Author
|
Hi @yuliacech I have revised this PR accordingly. The key points are:
Here are diffs between v8.10.4/v7.17.14 and this branch for your reference. v8.10.4..fix-autocomplete-on-url-parameters$ git diff v8.10.4..fix-autocomplete-on-url-parameters -- src/plugins/console/public/lib/autocomplete/autocomplete.tsdiff --git a/src/plugins/console/public/lib/autocomplete/autocomplete.ts b/src/plugins/console/public/lib/autocomplete/autocomplete.ts
index 71cca789264..ec543a1663d 100644
--- a/src/plugins/console/public/lib/autocomplete/autocomplete.ts
+++ b/src/plugins/console/public/lib/autocomplete/autocomplete.ts
@@ -1077,22 +1128,18 @@ export default function ({
nextToken.position.lineNumber = pos.lineNumber;
lastEvaluatedToken = nextToken;
}
+ tracer('not starting autocomplete due to empty current token');
return;
}
if (!lastEvaluatedToken) {
lastEvaluatedToken = currentToken;
+ tracer('not starting autocomplete due to invalid last evaluated token');
return; // wait for the next typing.
}
- // if the column or the line number have not changed for the last token and
- // user did not provided a new value, then we should not show autocomplete
- // this guards against triggering autocomplete when clicking around the editor
- if (
- (lastEvaluatedToken.position.column !== currentToken.position.column ||
- lastEvaluatedToken.position.lineNumber !== currentToken.position.lineNumber) &&
- lastEvaluatedToken.value === currentToken.value
- ) {
+ if (!looksLikeTypingIn(lastEvaluatedToken, currentToken, editor)) {
+ tracer('not starting autocomplete', lastEvaluatedToken, '->', currentToken);
// not on the same place or nothing changed, cache and wait for the next time
lastEvaluatedToken = currentToken;
return;v7.17.14..fix-autocomplete-on-url-parameters$ git diff v7.17.14..fix-autocomplete-on-url-parameters -- src/plugins/console/public/lib/autocomplete/autocomplete.tsdiff --git a/src/plugins/console/public/lib/autocomplete/autocomplete.ts b/src/plugins/console/public/lib/autocomplete/autocomplete.ts
index d89a9f3d2e5..ec543a1663d 100644
--- a/src/plugins/console/public/lib/autocomplete/autocomplete.ts
+++ b/src/plugins/console/public/lib/autocomplete/autocomplete.ts
@@ -921,19 +1128,18 @@ export default function ({
nextToken.position.lineNumber = pos.lineNumber;
lastEvaluatedToken = nextToken;
}
+ tracer('not starting autocomplete due to empty current token');
return;
}
if (!lastEvaluatedToken) {
lastEvaluatedToken = currentToken;
+ tracer('not starting autocomplete due to invalid last evaluated token');
return; // wait for the next typing.
}
- if (
- lastEvaluatedToken.position.column !== currentToken.position.column ||
- lastEvaluatedToken.position.lineNumber !== currentToken.position.lineNumber ||
- lastEvaluatedToken.value === currentToken.value
- ) {
+ if (!looksLikeTypingIn(lastEvaluatedToken, currentToken, editor)) {
+ tracer('not starting autocomplete', lastEvaluatedToken, '->', currentToken);
// not on the same place or nothing changed, cache and wait for the next time
lastEvaluatedToken = currentToken;
return; |
Member
Author
|
Find I didn't make this PR ready for review. EDIT: And I apologize for the post-ready code changes. |
💔 Build FailedFailed CI Steps
Metrics [docs]Module Count
Async chunks
History
To update your PR or re-run it, just comment with: |
Contributor
|
Pinging @elastic/platform-deployment-management (Team:Deployment Management) |
yuliacech
approved these changes
Oct 23, 2023
Contributor
yuliacech
left a comment
There was a problem hiding this comment.
Thanks a lot for fixing this issue, @sakurai-youhei!
I tested locally and the regression is not reproducible, I also haven't noticed any other issues. Code changes LGTM too, thanks for adding the tests.
Contributor
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
to kibanamachine/kibana
that referenced
this pull request
Oct 23, 2023
## Summary This PR fixes autocomplete triggering on URL tokens ~~for url parameters to work with a single character~~. Fixes elastic#168017 (which is a regression introduced by elastic#163233)  ### Checklist - [x] [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 ### Notes - No functional tests are added because they would also go flaky. - ~~No unit tests are added because of the lack of existing unit tests.~~ - ~~The change is kept minimal by accepting the growing if-else block.~~ ### For maintainers - [x] 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) --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 8fe2e1a)
Contributor
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
Member
Author
|
Thank you for your review, @yuliacech ! |
kibanamachine
added a commit
that referenced
this pull request
Oct 24, 2023
# Backport This will backport the following commits from `main` to `8.11`: - [Fix autocomplete triggering on URL tokens (#168956)](#168956) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Youhei Sakurai","email":"youhei.sakurai@elastic.co"},"sourceCommit":{"committedDate":"2023-10-23T22:42:30Z","message":"Fix autocomplete triggering on URL tokens (#168956)\n\n## Summary\r\n\r\nThis PR fixes autocomplete triggering on URL tokens ~~for url parameters\r\nto work with a single character~~.\r\n\r\nFixes #168017 (which is a regression introduced by #163233)\r\n\r\n\r\n\r\n\r\n### Checklist\r\n\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n\r\n### Notes\r\n\r\n- No functional tests are added because they would also go flaky.\r\n- ~~No unit tests are added because of the lack of existing unit\r\ntests.~~\r\n- ~~The change is kept minimal by accepting the growing if-else block.~~\r\n\r\n### For maintainers\r\n\r\n- [x] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>","sha":"8fe2e1ac687678e0fe5558ca61853614b287adc0","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","Feature:Console","Team:Deployment Management","release_note:skip","v8.11.0","v8.12.0"],"number":168956,"url":"https://github.com/elastic/kibana/pull/168956","mergeCommit":{"message":"Fix autocomplete triggering on URL tokens (#168956)\n\n## Summary\r\n\r\nThis PR fixes autocomplete triggering on URL tokens ~~for url parameters\r\nto work with a single character~~.\r\n\r\nFixes #168017 (which is a regression introduced by #163233)\r\n\r\n\r\n\r\n\r\n### Checklist\r\n\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n\r\n### Notes\r\n\r\n- No functional tests are added because they would also go flaky.\r\n- ~~No unit tests are added because of the lack of existing unit\r\ntests.~~\r\n- ~~The change is kept minimal by accepting the growing if-else block.~~\r\n\r\n### For maintainers\r\n\r\n- [x] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>","sha":"8fe2e1ac687678e0fe5558ca61853614b287adc0"}},"sourceBranch":"main","suggestedTargetBranches":["8.11"],"targetPullRequestStates":[{"branch":"8.11","label":"v8.11.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/168956","number":168956,"mergeCommit":{"message":"Fix autocomplete triggering on URL tokens (#168956)\n\n## Summary\r\n\r\nThis PR fixes autocomplete triggering on URL tokens ~~for url parameters\r\nto work with a single character~~.\r\n\r\nFixes #168017 (which is a regression introduced by #163233)\r\n\r\n\r\n\r\n\r\n### Checklist\r\n\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n\r\n### Notes\r\n\r\n- No functional tests are added because they would also go flaky.\r\n- ~~No unit tests are added because of the lack of existing unit\r\ntests.~~\r\n- ~~The change is kept minimal by accepting the growing if-else block.~~\r\n\r\n### For maintainers\r\n\r\n- [x] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>","sha":"8fe2e1ac687678e0fe5558ca61853614b287adc0"}}]}] BACKPORT--> Co-authored-by: Youhei Sakurai <youhei.sakurai@elastic.co>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR fixes autocomplete triggering on URL tokens
for url parameters to work with a single character.Fixes #168017 (which is a regression introduced by #163233)
Checklist
Notes
No unit tests are added because of the lack of existing unit tests.The change is kept minimal by accepting the growing if-else block.For maintainers