PASopa for modern controls (#670)

microsoft · Jun 14, 2024 · 97a7fef · 97a7fef
1 parent 929a800
commit 97a7fef
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 7 deletions.
diff --git a/src/PAModel/CanvasDocument.cs b/src/PAModel/CanvasDocument.cs
@@ -350,7 +350,7 @@ internal void ApplyAfterMsAppLoadTransforms(ErrorContainer errors)
         var templateDefaults = new Dictionary<string, ControlTemplate>();
         foreach (var template in _templates.UsedTemplates)
         {
-            if (!ControlTemplateParser.TryParseTemplate(_templateStore, template.Template, _properties.DocumentAppType, templateDefaults, out _, out _))
+            if (!ControlTemplateParser.TryParseTemplate(_templateStore, template.Template, _properties.DocumentAppType, templateDefaults, out _, out _, template.Name))
             {
                 errors.GenericError($"Unable to parse template file {template.Name}");
                 throw new DocumentException();
@@ -405,7 +405,7 @@ internal void ApplyBeforeMsAppWriteTransforms(ErrorContainer errors)
         var templateDefaults = new Dictionary<string, ControlTemplate>();
         foreach (var template in _templates.UsedTemplates)
         {
-            if (!ControlTemplateParser.TryParseTemplate(_templateStore, template.Template, _properties.DocumentAppType, templateDefaults, out _, out _))
+            if (!ControlTemplateParser.TryParseTemplate(_templateStore, template.Template, _properties.DocumentAppType, templateDefaults, out _, out _, template.Name))
             {
                 errors.GenericError($"Unable to parse template file {template.Name}");
                 throw new DocumentException();

diff --git a/src/PAModel/ControlTemplates/ControlTemplateParser.cs b/src/PAModel/ControlTemplates/ControlTemplateParser.cs
@@ -13,10 +13,10 @@ internal class ControlTemplateParser
     internal static Regex _reservedIdentifierRegex = new(@"%([a-zA-Z]*)\.RESERVED%");
 
     [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "<Pending>")]
-    internal static bool TryParseTemplate(TemplateStore templateStore, string templateString, AppType type, Dictionary<string, ControlTemplate> loadedTemplates, out ControlTemplate template, out string name)
+    internal static bool TryParseTemplate(TemplateStore templateStore, string templateString, AppType type, Dictionary<string, ControlTemplate> loadedTemplates, out ControlTemplate template, out string name, string templateName = null)
     {
         template = null;
-        name = string.Empty;
+        name = templateName;
         try
         {
             var manifest = XDocument.Parse(templateString);
@@ -26,7 +26,8 @@ internal static bool TryParseTemplate(TemplateStore templateStore, string templa
             if (widget.Name != ControlMetadataXNames.WidgetTag)
                 return false;
 
-            name = widget.Attribute(ControlMetadataXNames.NameAttribute).Value;
+            name ??= widget.Attribute(ControlMetadataXNames.NameAttribute).Value;
+
             var id = widget.Attribute(ControlMetadataXNames.IdAttribute).Value;
             var version = widget.Attribute(ControlMetadataXNames.VersionAttribute).Value;
 

diff --git a/src/PAModel/Serializers/SourceSerializer.cs b/src/PAModel/Serializers/SourceSerializer.cs
@@ -310,7 +310,8 @@ private static void LoadTemplateFiles(ErrorContainer errors, CanvasDocument app,
         foreach (var file in new DirectoryReader(packagesPath).EnumerateFiles(string.Empty, "*.xml", searchSubdirectories: false))
         {
             var xmlContents = file.GetContents();
-            if (!ControlTemplateParser.TryParseTemplate(new TemplateStore(), xmlContents, app._properties.DocumentAppType, loadedTemplates, out var parsedTemplate, out var templateName))
+            var templateNameFromFile = file._relativeName.Substring(0, file._relativeName.LastIndexOf('_'));
+            if (!ControlTemplateParser.TryParseTemplate(new TemplateStore(), xmlContents, app._properties.DocumentAppType, loadedTemplates, out var parsedTemplate, out var templateName, templateNameFromFile))
             {
                 errors.GenericError($"Unable to parse template file {file._relativeName}");
                 throw new DocumentException();
@@ -523,7 +524,7 @@ public static void SaveAsSource(CanvasDocument app, string directory2, ErrorCont
         {
             var filename = $"{template.Name}_{template.Version}.xml";
             dir.WriteAllXML(PackagesDir, new FilePath(filename), template.Template);
-            if (!ControlTemplateParser.TryParseTemplate(app._templateStore, template.Template, app._properties.DocumentAppType, templateDefaults, out _, out _))
+            if (!ControlTemplateParser.TryParseTemplate(app._templateStore, template.Template, app._properties.DocumentAppType, templateDefaults, out _, out _, template.Name))
                 throw new NotSupportedException($"Unable to parse template file {template.Name}");
         }
 

diff --git a/src/PAModelTests/Apps/ComboboxDropdown.msapp b/src/PAModelTests/Apps/ComboboxDropdown.msapp
diff --git a/src/PAModelTests/TemplateStoreTests.cs b/src/PAModelTests/TemplateStoreTests.cs
@@ -44,4 +44,31 @@ public void TestHostControlInstancesWithHostType(string appName)
             Assert.IsTrue(MsAppTest.Compare(root, tempFile.FullPath, Console.Out));
         }
     }
+
+    // Validate a modern control that has a dynamic template.
+    // The template has a valid template name, but makes reference to another template.
+    // This example app has two modern controls (combobox and dropdown) that make reference to the same template.
+    [DataTestMethod]
+    [DataRow("ComboboxDropdown.msapp")]
+    public void TestModernControlWithDynamicTemplate(string appName)
+    {
+        //arrange
+        var root = Path.Combine(Environment.CurrentDirectory, "Apps", appName);
+        Assert.IsTrue(File.Exists(root), "MSAPP not found");
+
+        //act
+        (var msapp, var errors) = CanvasDocument.LoadFromMsapp(root);
+        errors.ThrowOnErrors();
+
+        //assert
+        Assert.IsTrue(msapp._templateStore.Contents.ContainsKey("PowerApps_CoreControls_DropdownCanvasTemplate_dataField"));
+        Assert.IsTrue(msapp._templateStore.Contents.ContainsKey("PowerApps_CoreControls_ComboboxCanvasTemplate_dataField"));
+
+        // Repack the app and validate it matches the initial msapp
+        using (var tempFile = new TempFile())
+        {
+            MsAppSerializer.SaveAsMsApp(msapp, tempFile.FullPath, new ErrorContainer());
+            Assert.IsTrue(MsAppTest.Compare(root, tempFile.FullPath, Console.Out));
+        }
+    }
 }