languages/dart-sdk
languages/dart-sdk
1
0
Fork 0
mirror of https://github.com/dart-lang/sdk synced 2024-11-02 08:44:27 +00:00
Code Issues Projects Releases Packages Wiki Activity

[analyzer] Fix a bug with completion ranking for items with 0 relevance in LSP

Browse source 
Change-Id: Ic4ef390ba4bdc627e075ae9dade8ced5a307a8ec
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/196667
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com>
This commit is contained in:
Danny Tuppeny 2021-04-24 18:13:32 +00:00 committed by commit-bot@chromium.org
parent 1ad68b9b16
commit 8a0897c165
2 changed files with 34 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
pkg/analysis_server/lib/src/lsp/mapping.dart
View file

@ -364,12 +364,7 @@ lsp.CompletionItem declarationToCompletionItem(
supportsDeprecatedFlag || supportsDeprecatedTag),
deprecated:
supportsDeprecatedFlag && declaration.isDeprecated ? true : null,
// Relevance is a number, highest being best. LSP does text sort so subtract
// from a large number so that a text sort will result in the correct order.
// 555 -> 999455
// 10 -> 999990
// 1 -> 999999
sortText: (1000000 - itemRelevance).toString(),
sortText: relevanceToSortText(itemRelevance),
filterText: completion != label
? completion
: null, // filterText uses label if not set
@ -776,6 +771,22 @@ lsp.DiagnosticSeverity pluginToDiagnosticSeverity(
}
}
/// Converts a numeric relevance to a sortable string.
///
/// The servers relevance value is a number with highest being best. LSP uses a
/// a string sort on the `sortText` field. Subtracting the relevance from a large
/// number will produce text that will sort correctly.
///
/// Relevance can be 0, so it's important to subtract from a number like 999
/// and not 1000 or the 0 relevance items will sort at the top instead of the
/// bottom.
///
/// 555 -> 9999999 - 555 -> 9 999 444
/// 10 -> 9999999 - 10 -> 9 999 989
/// 1 -> 9999999 - 1 -> 9 999 998
/// 0 -> 9999999 - 0 -> 9 999 999
String relevanceToSortText(int relevance) => (9999999 - relevance).toString();
lsp.Location? searchResultToLocation(
server.SearchResult result, server.LineInfo? lineInfo) {
final location = result.location;
@ -957,12 +968,7 @@ lsp.CompletionItem toCompletionItem(
deprecated: supportsCompletionDeprecatedFlag && suggestion.isDeprecated
? true
: null,
// Relevance is a number, highest being best. LSP does text sort so subtract
// from a large number so that a text sort will result in the correct order.
// 555 -> 999455
// 10 -> 999990
// 1 -> 999999
sortText: (1000000 - suggestion.relevance).toString(),
sortText: relevanceToSortText(suggestion.relevance),
filterText: filterText != label
? filterText
: null, // filterText uses label if not set

16
pkg/analysis_server/test/lsp/mapping_test.dart
View file

@ -72,6 +72,22 @@ class MappingTest extends AbstractLspAnalysisServerTest {
expect(result, isNull);
}
void test_relevanceToSortText() {
// The expected order is the same as from the highest relevance.
final expectedOrder =
[999999, 1000, 100, 1, 0].map(lsp.relevanceToSortText).toList();
// Test with inputs in both directions to ensure the results are actually
// unique and sorted.
final results1 =
[999999, 1000, 100, 1, 0].map(lsp.relevanceToSortText).toList()..sort();
final results2 =
[0, 1, 100, 1000, 999999].map(lsp.relevanceToSortText).toList()..sort();
expect(results1, equals(expectedOrder));
expect(results2, equals(expectedOrder));
}
Future<void> test_tabStopsInSnippets_contains() async {
var result = lsp.buildSnippetStringWithTabStops('a, b, c', [3, 1]);
expect(result, equals(r'a, ${0:b}, c'));