fix: completion in FragmentDefinition (#567)

Author: voicis

packages/xml-views-completion/src/providers/elementName/classes.ts

@@ -15,6 +15,7 @@ import {
   getUI5AggregationByXMLElement,
   splitQNameByNamespace,
   resolveXMLNSFromPrefix,
+  xmlToFQN,
 } from "@ui5-language-assistant/logic-utils";
 import { UI5ClassesInXMLTagNameCompletion } from "../../../api";
 import { UI5ElementNameCompletionOptions } from "./index";
@@ -99,15 +100,28 @@ function computeClassSuggestionContext({
   model: UI5SemanticModel;
 }): classSuggestionContext | null {
   const parentXMLElement = xmlElement.parent;
+
   // top level class suggestions, it is kind of like an implicit aggregation
   if (parentXMLElement.type === "XMLDocument") {
+    // an xml fragment can contain single control element at a top level
+    // https://sapui5.hana.ondemand.com/#/topic/2c677b574ea2486a8d5f5414d15e21c5
     return {
-      // TODO: in a fragment xml view an element may possibly be at the top level?
       allowedType: model.classes["sap.ui.core.Control"],
       cardinality: "0..1",
     };
   }
 
+  const parentFullyQualifiedName = xmlToFQN(parentXMLElement);
+  if (parentFullyQualifiedName === "sap.ui.core.FragmentDefinition") {
+    // wrapper for multiple fragment elements
+    // sap.ui.core.FragmentDefinition does not exist in api.json,
+    // so we need custom handling here
+    return {
+      allowedType: model.classes["sap.ui.core.Control"],
+      cardinality: "0..n",
+      parentXMLTag: parentXMLElement,
+    };
+  }
   // If the parent tag is a class this is an implicit (default) aggregation
   const parentUI5Class = getUI5ClassByXMLElement(parentXMLElement, model);
   if (parentUI5Class !== undefined) {

packages/xml-views-completion/test/providers/elementName/classes-spec.ts

@@ -104,6 +104,72 @@ describe("The ui5-language-assistant xml-views-completion", () => {
         });
       });
 
+      context("sap.ui.core.FragmentDefinition content", () => {
+        context("no prefix", () => {
+          it("will suggest **all** Controls", () => {
+            const xmlSnippet = `
+            <core:FragmentDefinition xmlns:core="sap.ui.core">
+              <⇶
+            </core:FragmentDefinition>
+            `;
+
+            testSuggestionsScenario({
+              context: appContext,
+              xmlText: xmlSnippet,
+              providers: {
+                elementName: [classesSuggestions],
+              },
+              assertion: (suggestions) => {
+                const baseControl = ui5Model.classes["sap.ui.core.Control"];
+                expect(suggestions).to.have.length.greaterThan(200);
+                forEach(suggestions, (_) => {
+                  expect(_.ui5Node.kind).to.equal("UI5Class");
+                  const superClasses = getSuperClasses(_.ui5Node as UI5Class);
+                  // Chai's `.include` is super slow, we must implement it ourselves...
+                  const doesSuggestionExtendsControl =
+                    find(superClasses, baseControl) !== undefined;
+                  expect(
+                    doesSuggestionExtendsControl || _.ui5Node === baseControl
+                  ).to.be.true;
+                });
+              },
+            });
+          });
+        });
+        context("multiple children", () => {
+          it("will suggest **all** Controls", () => {
+            const xmlSnippet = `
+            <core:FragmentDefinition xmlns:core="sap.ui.core" xmlns="sap.m">
+              <Button></Button>
+              <⇶
+            </core:FragmentDefinition>
+            `;
+
+            testSuggestionsScenario({
+              context: appContext,
+              xmlText: xmlSnippet,
+              providers: {
+                elementName: [classesSuggestions],
+              },
+              assertion: (suggestions) => {
+                const baseControl = ui5Model.classes["sap.ui.core.Control"];
+                expect(suggestions).to.have.length.greaterThan(200);
+                forEach(suggestions, (_) => {
+                  expect(_.ui5Node.kind).to.equal("UI5Class");
+                  const superClasses = getSuperClasses(_.ui5Node as UI5Class);
+                  // Chai's `.include` is super slow, we must implement it ourselves...
+                  const doesSuggestionExtendsControl =
+                    find(superClasses, baseControl) !== undefined;
+                  expect(
+                    doesSuggestionExtendsControl || _.ui5Node === baseControl
+                  ).to.be.true;
+                });
+              },
+            });
+          });
+        });
+      });
+
       context("classes under (implicit) default aggregations", () => {
         context("no prefix", () => {
           it("will suggest **all** classes matching the type of the default aggregation", () => {