Merge pull request #34264 from TharushiJay/fix-33861

Improve the sorting order of completion items in from clause context
ballerina-platform · Dec 13, 2021 · 9cde357 · 9cde357
2 parents b3c5f95 + 2711d30
commit 9cde357
Show file tree

Hide file tree

Showing 11 changed files with 894 additions and 219 deletions.
diff --git a/...ava/org/ballerinalang/langserver/completions/providers/context/FromClauseNodeContext.java b/...ava/org/ballerinalang/langserver/completions/providers/context/FromClauseNodeContext.java
@@ -16,6 +16,8 @@
 package org.ballerinalang.langserver.completions.providers.context;
 
 import io.ballerina.compiler.api.symbols.Symbol;
+import io.ballerina.compiler.api.symbols.TypeDescKind;
+import io.ballerina.compiler.api.symbols.TypeSymbol;
 import io.ballerina.compiler.syntax.tree.BindingPatternNode;
 import io.ballerina.compiler.syntax.tree.FromClauseNode;
 import io.ballerina.compiler.syntax.tree.Node;
@@ -26,13 +28,19 @@
 import io.ballerina.compiler.syntax.tree.TypeDescriptorNode;
 import io.ballerina.compiler.syntax.tree.TypedBindingPatternNode;
 import org.ballerinalang.annotation.JavaSPIService;
+import org.ballerinalang.langserver.common.utils.CommonUtil;
+import org.ballerinalang.langserver.common.utils.SymbolUtil;
 import org.ballerinalang.langserver.common.utils.completion.QNameReferenceUtil;
 import org.ballerinalang.langserver.commons.BallerinaCompletionContext;
 import org.ballerinalang.langserver.commons.completion.LSCompletionItem;
 import org.ballerinalang.langserver.completions.SnippetCompletionItem;
+import org.ballerinalang.langserver.completions.SymbolCompletionItem;
 import org.ballerinalang.langserver.completions.util.Snippet;
+import org.ballerinalang.langserver.completions.util.SortingUtil;
+import org.eclipse.lsp4j.CompletionItemKind;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;
 
@@ -108,6 +116,47 @@ public List<LSCompletionItem> getCompletions(BallerinaCompletionContext context,
     public boolean onPreValidation(BallerinaCompletionContext context, FromClauseNode node) {
         return !node.fromKeyword().isMissing();
     }
+
+    @Override
+    public void sort(BallerinaCompletionContext context,
+                     FromClauseNode node,
+                     List<LSCompletionItem> completionItems) {
+
+        completionItems.forEach(lsCItem -> {
+            if (isIterableCompletionItem(lsCItem)) {
+                lsCItem.getCompletionItem().setSortText(SortingUtil.genSortText(1)
+                        + SortingUtil.genSortText(SortingUtil.toRank(context, lsCItem)));
+                return;
+            } else if (lsCItem.getType() == LSCompletionItem.CompletionItemType.SYMBOL &&
+                    lsCItem.getCompletionItem().getKind() == CompletionItemKind.Function) {
+                lsCItem.getCompletionItem().setSortText(SortingUtil.genSortText(2));
+                return;
+            }
+            lsCItem.getCompletionItem().setSortText(SortingUtil.genSortText(3) +
+                    SortingUtil.genSortText(SortingUtil.toRank(context, lsCItem)));
+        });
+    }
+
+    private boolean isIterableCompletionItem(LSCompletionItem lsCItem) {
+
+        if (lsCItem.getType() != LSCompletionItem.CompletionItemType.SYMBOL) {
+            return false;
+        }
+
+        Symbol symbol = ((SymbolCompletionItem) lsCItem).getSymbol().orElse(null);
+        Optional<TypeSymbol> typeDesc = SymbolUtil.getTypeDescriptor(symbol);
+
+        List<TypeDescKind> iterables = Arrays.asList(
+                TypeDescKind.STRING, TypeDescKind.ARRAY,
+                TypeDescKind.MAP, TypeDescKind.TABLE,
+                TypeDescKind.STREAM, TypeDescKind.XML);
+
+        if (typeDesc.isPresent()) {
+            TypeSymbol rawType = CommonUtil.getRawType(typeDesc.get());
+            return iterables.contains(rawType.typeKind());
+        }
+        return false;
+    }
 
     private boolean onTypedBindingPatternContext(BallerinaCompletionContext context, FromClauseNode node) {
         int cursor = context.getCursorPositionInTree();

diff --git a/...r-core/src/test/resources/completion/query_expression/config/query_expr_ctx_config12.json b/...r-core/src/test/resources/completion/query_expression/config/query_expr_ctx_config12.json
@@ -9,7 +9,7 @@
       "label": "in",
       "kind": "Keyword",
       "detail": "Keyword",
-      "sortText": "Q",
+      "sortText": "CQ",
       "filterText": "in",
       "insertText": "in ",
       "insertTextFormat": "Snippet"

diff --git a/...r-core/src/test/resources/completion/query_expression/config/query_expr_ctx_config13.json b/...r-core/src/test/resources/completion/query_expression/config/query_expr_ctx_config13.json
@@ -9,7 +9,7 @@
       "label": "in",
       "kind": "Keyword",
       "detail": "Keyword",
-      "sortText": "Q",
+      "sortText": "CQ",
       "filterText": "in",
       "insertText": "in ",
       "insertTextFormat": "Snippet"