Using ext bundle instead of hard-coded v2 templates (#3391) (#3467)

VpOfEngineering · khkh-ms · web-flow · commit ae1d0f7bc6d9 · 2023-09-25T16:20:28.000-05:00
* Using ext bundle instead of hard-coded v2 templates

* The blueprint append fix.

* minor fix

* Removed an unused variable.

* We don't have fall back templates. Naren confirmed.

Co-authored-by: Khuram Khan &lt;64149947+khkh-ms@users.noreply.github.com&gt;
diff --git a/build/BuildSteps.cs b/build/BuildSteps.cs
@@ -286,6 +286,17 @@ public static void AddTemplatesJson()
                     File.Copy(templatesJsonPath, Path.Combine(Settings.OutputDir, runtime, "templates", "templates.json"));
                 }
             }
+
+            string templatesv2JsonPath = Path.Combine(tempDirectoryPath, "templates-v2", "templates.json");
+            string userPromptsv2JsonPath = Path.Combine(tempDirectoryPath, "bindings-v2", "userPrompts.json");
+            if (File.Exists(templatesv2JsonPath) && File.Exists(userPromptsv2JsonPath))
+            {
+                foreach (var runtime in Settings.TargetRuntimes)
+                {
+                    File.Copy(templatesv2JsonPath, Path.Combine(Settings.OutputDir, runtime, "templates-v2", "templates.json"));
+                    File.Copy(userPromptsv2JsonPath, Path.Combine(Settings.OutputDir, runtime, "templates-v2", "userPrompts.json"));
+                }
+            }
         }
 
         public static void Test()
diff --git a/src/Azure.Functions.Cli/Actions/LocalActions/CreateFunctionAction.cs b/src/Azure.Functions.Cli/Actions/LocalActions/CreateFunctionAction.cs
@@ -157,31 +157,37 @@ public async override Task RunAsync()
                     }
                 }
 
-                var variables = new Dictionary<string, string>();
+                var providedInputs = new Dictionary<string, string>() { { GetFunctionNameParamId, FunctionName } };
                 var jobName = "appendToFile";
                 if (FileName != PySteinFunctionAppPy)
                 {
                     var filePath = Path.Combine(Environment.CurrentDirectory, FileName);
-                    jobName = !FileUtility.FileExists(filePath) ? "CreateNewBlueprint" : "AppendToBlueprint";
-                    variables["$(BLUEPRINT_FILENAME)"] = FileName;
-                    FileName = FileName[..^Path.GetExtension(FileName).Length];
+                    if (FileUtility.FileExists(filePath))
+                    {
+                        jobName = "AppendToBlueprint";
+                        providedInputs[GetBluePrintExistingFileNameParamId] = FileName;
+                    }
+                    else
+                    {
+                        jobName = "CreateNewBlueprint";
+                        providedInputs[GetBluePrintFileNameParamId] = FileName;
+                    }
                 }
                 else
                 {
-                    variables["$(SELECTED_FILEPATH)"] = FileName;
+                    providedInputs[GetFileNameParamId] = FileName;
                 }
 
                 var template = _newTemplates.Value.FirstOrDefault(t => string.Equals(t.Name, TemplateName, StringComparison.CurrentCultureIgnoreCase) && string.Equals(t.Language, Language, StringComparison.CurrentCultureIgnoreCase));
                 var templateJob = template.Jobs.Single(x => x.Type.Equals(jobName, StringComparison.OrdinalIgnoreCase));
-                var providedInputs = new Dictionary<string, string>() { { GetFunctionNameParamId, FunctionName } };
 
+                var variables = new Dictionary<string, string>();
                 _userInputHandler.RunUserInputActions(providedInputs, templateJob.Inputs, variables);
 
                 if (string.IsNullOrEmpty(FunctionName))
                 {
                     FunctionName = providedInputs[GetFunctionNameParamId];
                 }
-
                 
                 await _templatesManager.Deploy(templateJob, template, variables);
             }
diff --git a/src/Azure.Functions.Cli/Actions/UserInputHandler.cs b/src/Azure.Functions.Cli/Actions/UserInputHandler.cs
@@ -86,7 +86,8 @@ public void RunUserInputActions(IDictionary<string, string> providedValues, ILis
                 }
 
                 var variableName = theInput.AssignTo;
-                variables.Add(variableName, response);
+
+                variables[variableName] = response;
             }
         }
 
diff --git a/src/Azure.Functions.Cli/Common/Constants.cs b/src/Azure.Functions.Cli/Common/Constants.cs
@@ -71,9 +71,13 @@ internal static class Constants
         public const string OldCoreToolsVersionMessage = "You are using an old Core Tools version. Please upgrade to the latest version.";
         public const string GetFunctionNameParamId = "trigger-functionName";
         public const string GetFileNameParamId = "app-selectedFileName";
+        public const string GetBluePrintFileNameParamId = "blueprint-fileName";
+        public const string GetBluePrintExistingFileNameParamId = "blueprint-existingFileName";
         public const string UserPromptBooleanType = "boolean";
         public const string UserPromptEnumType = "enum";
         public const string UserInputActionType = "UserInput";
+        public const string UserPromptExtensionBundleFileName = "userPrompts.json";
+        public const string TemplatesExtensionBundleFileName = "templates.json";
         public const string ShowMarkdownPreviewActionType = "ShowMarkdownPreview";
         public const string FunctionBodyTargetFileName = "FUNCTION_BODY_TARGET_FILE_NAME";
         public const string PythonProgrammingModelFunctionBodyFileKey = "function_body.py";
diff --git a/src/Azure.Functions.Cli/Common/TemplatesManager.cs b/src/Azure.Functions.Cli/Common/TemplatesManager.cs
@@ -12,6 +12,8 @@
 using Microsoft.AspNetCore.Routing.Constraints;
 using Microsoft.CodeAnalysis;
 using System.IO.Abstractions;
+using Microsoft.Azure.WebJobs.Script;
+using static Azure.Functions.Cli.Common.OutputTheme;
 
 namespace Azure.Functions.Cli.Common
 {
@@ -32,6 +34,22 @@ public Task<IEnumerable<Template>> Templates
             }
         }
 
+        public async Task<string> GetExtensionBundleFileContent(string path)
+        {
+            var extensionBundleManager = ExtensionBundleHelper.GetExtensionBundleManager();
+            var bundlePath = await extensionBundleManager.GetExtensionBundlePath();
+            string contentFilePath = Path.Combine(bundlePath, path);
+
+            if (FileSystemHelpers.FileExists(contentFilePath))
+            {
+                return await FileSystemHelpers.ReadAllTextFromFileAsync(contentFilePath);
+            }
+            else
+            {
+                return null;
+            }
+        }
+
         private static async Task<IEnumerable<Template>> GetTemplates()
         {
             var extensionBundleManager = ExtensionBundleHelper.GetExtensionBundleManager();
@@ -64,6 +82,28 @@ private static string GetTemplatesJson()
             return FileSystemHelpers.ReadAllTextFromFile(templatesLocation);
         }
 
+        private static async Task<string> GetV2TemplatesJson()
+        {
+            var templatesLocation = Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "templates-v2", "templates.json");
+            if (!FileSystemHelpers.FileExists(templatesLocation))
+            {
+                throw new CliException($"Can't find v2 templates location. Looked at '{templatesLocation}'");
+            }
+
+            return await FileSystemHelpers.ReadAllTextFromFileAsync(templatesLocation);
+        }
+
+        private static async Task<string> GetV2UserPromptsJson()
+        {
+            var userPrompotsLocation = Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "templates-v2", "userPrompts.json");
+            if (!FileSystemHelpers.FileExists(userPrompotsLocation))
+            {
+                throw new CliException($"Can't find v2 user prompts location. Looked at '{userPrompotsLocation}'");
+            }
+
+            return await FileSystemHelpers.ReadAllTextFromFileAsync(userPrompotsLocation);
+        }
+
         private static async Task<IEnumerable<Template>> GetNodeV4TemplatesJson()
         {
             var staticTemplateJson = await StaticResources.GetValue($"node-v4-templates.json");
@@ -221,34 +261,50 @@ public Task<IEnumerable<NewTemplate>> NewTemplates
         {
             get
             {
-                return GetStaticV2Templates();
+                return GetV2Templates();
             }
         }
 
-        private static async Task<IEnumerable<NewTemplate>> GetStaticV2Templates()
+        public async Task<IEnumerable<NewTemplate>> GetV2Templates()
         {
-            var staticTemplateJson = await StaticResources.GetValue($"templatesv2.json");
-            return JsonConvert.DeserializeObject<IEnumerable<NewTemplate>>(staticTemplateJson);
+            
+            var extensionBundleManager = ExtensionBundleHelper.GetExtensionBundleManager();
+            string templateJson;
+            if (extensionBundleManager.IsExtensionBundleConfigured())
+            {
+                templateJson = await GetExtensionBundleFileContent(Path.Combine("StaticContent", "v2", "templates", Constants.TemplatesExtensionBundleFileName));
+            }
+            else
+            {
+                templateJson = await GetV2TemplatesJson();
+            }
+
+            return JsonConvert.DeserializeObject<IEnumerable<NewTemplate>>(templateJson);
         }
 
         public Task<IEnumerable<UserPrompt>> UserPrompts
         {
             get
             {
-                return GetUserPrompts();
+                return GetV2UserPrompts();
             }
         }
 
-        public async Task<IEnumerable<UserPrompt>> GetUserPrompts()
+        public async Task<IEnumerable<UserPrompt>> GetV2UserPrompts()
         {
-            return await GetNewTemplateUserPrompts();
-        }
+            var extensionBundleManager = ExtensionBundleHelper.GetExtensionBundleManager();
 
-        private static async Task<IEnumerable<UserPrompt>> GetNewTemplateUserPrompts()
-        {
-            var userPromptStr = await StaticResources.GetValue(Constants.UserPromptFileName);
-            var userPromptList = JsonConvert.DeserializeObject<UserPrompt[]>(userPromptStr);
-            return userPromptList;
+            string userPromptJson;
+            if (extensionBundleManager.IsExtensionBundleConfigured())
+            {
+                userPromptJson = await GetExtensionBundleFileContent(Path.Combine("StaticContent", "v2", "bindings", Constants.UserPromptExtensionBundleFileName));
+            }
+            else
+            {
+                userPromptJson = await GetV2UserPromptsJson();
+            }
+            
+            return JsonConvert.DeserializeObject<UserPrompt[]>(userPromptJson);
         }
 
         private async Task RunTemplateActionAction(NewTemplate template, TemplateAction action, IDictionary<string, string> variables)

Original file line number	Diff line number	Diff line change
`@@ -286,6 +286,17 @@ public static void AddTemplatesJson()`
`286`	`286`	`File.Copy(templatesJsonPath, Path.Combine(Settings.OutputDir, runtime, "templates", "templates.json"));`
`287`	`287`	`}`
`288`	`288`	`}`
	`289`	`+`
	`290`	`+ string templatesv2JsonPath = Path.Combine(tempDirectoryPath, "templates-v2", "templates.json");`
	`291`	`+ string userPromptsv2JsonPath = Path.Combine(tempDirectoryPath, "bindings-v2", "userPrompts.json");`
	`292`	`+ if (File.Exists(templatesv2JsonPath) && File.Exists(userPromptsv2JsonPath))`
	`293`	`+ {`
	`294`	`+ foreach (var runtime in Settings.TargetRuntimes)`
	`295`	`+ {`
	`296`	`+ File.Copy(templatesv2JsonPath, Path.Combine(Settings.OutputDir, runtime, "templates-v2", "templates.json"));`
	`297`	`+ File.Copy(userPromptsv2JsonPath, Path.Combine(Settings.OutputDir, runtime, "templates-v2", "userPrompts.json"));`
	`298`	`+ }`
	`299`	`+ }`
`289`	`300`	`}`
`290`	`301`
`291`	`302`	`public static void Test()`
Original file line number	Diff line number	Diff line change
`@@ -157,31 +157,37 @@ public async override Task RunAsync()`
`157`	`157`	`}`
`158`	`158`	`}`
`159`	`159`
`160`		`- var variables = new Dictionary<string, string>();`
	`160`	`+ var providedInputs = new Dictionary<string, string>() { { GetFunctionNameParamId, FunctionName } };`
`161`	`161`	`var jobName = "appendToFile";`
`162`	`162`	`if (FileName != PySteinFunctionAppPy)`
`163`	`163`	`{`
`164`	`164`	`var filePath = Path.Combine(Environment.CurrentDirectory, FileName);`
`165`		`- jobName = !FileUtility.FileExists(filePath) ? "CreateNewBlueprint" : "AppendToBlueprint";`
`166`		`- variables["$(BLUEPRINT_FILENAME)"] = FileName;`
`167`		`- FileName = FileName[..^Path.GetExtension(FileName).Length];`
	`165`	`+ if (FileUtility.FileExists(filePath))`
	`166`	`+ {`
	`167`	`+ jobName = "AppendToBlueprint";`
	`168`	`+ providedInputs[GetBluePrintExistingFileNameParamId] = FileName;`
	`169`	`+ }`
	`170`	`+ else`
	`171`	`+ {`
	`172`	`+ jobName = "CreateNewBlueprint";`
	`173`	`+ providedInputs[GetBluePrintFileNameParamId] = FileName;`
	`174`	`+ }`
`168`	`175`	`}`
`169`	`176`	`else`
`170`	`177`	`{`
`171`		`- variables["$(SELECTED_FILEPATH)"] = FileName;`
	`178`	`+ providedInputs[GetFileNameParamId] = FileName;`
`172`	`179`	`}`
`173`	`180`
`174`	`181`	`var template = _newTemplates.Value.FirstOrDefault(t => string.Equals(t.Name, TemplateName, StringComparison.CurrentCultureIgnoreCase) && string.Equals(t.Language, Language, StringComparison.CurrentCultureIgnoreCase));`
`175`	`182`	`var templateJob = template.Jobs.Single(x => x.Type.Equals(jobName, StringComparison.OrdinalIgnoreCase));`
`176`		`- var providedInputs = new Dictionary<string, string>() { { GetFunctionNameParamId, FunctionName } };`
`177`	`183`
	`184`	`+ var variables = new Dictionary<string, string>();`
`178`	`185`	`_userInputHandler.RunUserInputActions(providedInputs, templateJob.Inputs, variables);`
`179`	`186`
`180`	`187`	`if (string.IsNullOrEmpty(FunctionName))`
`181`	`188`	`{`
`182`	`189`	`FunctionName = providedInputs[GetFunctionNameParamId];`
`183`	`190`	`}`
`184`		`-`
`185`	`191`
`186`	`192`	`await _templatesManager.Deploy(templateJob, template, variables);`
`187`	`193`	`}`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,8 @@ public void RunUserInputActions(IDictionary<string, string> providedValues, ILis`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`var variableName = theInput.AssignTo;`
`89`		`- variables.Add(variableName, response);`
	`89`	`+`
	`90`	`+ variables[variableName] = response;`
`90`	`91`	`}`
`91`	`92`	`}`
`92`	`93`