Final commit after refactoring and updating documentation

Author: NishkalankBezawada

documentation/Import-PnPFlow.md

@@ -26,7 +26,7 @@ Import-PnPFlow [-Environment <PowerAutomateEnvironmentPipeBind>] [-PackagePath <
 ```
 
 ## DESCRIPTION
-This cmdlet Imports a Microsoft Power Automate Flow from a zip package.
+This cmdlet imports a Microsoft Power Automate Flow from a ZIP package. At present, only flows originating from the same tenant are supported.
 
 Many times Importing a Microsoft Power Automate Flow will not be possible due to various reasons such as connections having gone stale, SharePoint sites referenced no longer existing or other configuration errors in the Flow. To display these errors when trying to Import a Flow, provide the -Verbose flag with your Import request. If not provided, these errors will silently be ignored.
 

src/Commands/Model/PowerPlatform/PowerAutomate/ImportFlowResult.cs

@@ -0,0 +1,22 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace PnP.PowerShell.Commands.Model.PowerPlatform.PowerAutomate
+{
+    public class ImportFlowResult
+    {
+        public string Name { get; set; }
+        public string Status { get; set; }
+        public ImportFlowDetails Details { get; set; }
+    }
+
+    public class ImportFlowDetails
+    {
+        public string DisplayName { get; set; }
+        public string Description { get; set; }
+        public DateTime CreatedTime { get; set; }
+    }
+}

src/Commands/PowerPlatform/PowerAutomate/ImportFlow.cs

@@ -30,23 +30,8 @@ protected override void ExecuteCmdlet()
         {
             var environmentName = GetEnvironmentName();
             string baseUrl = PowerPlatformUtility.GetBapEndpoint(Connection.AzureEnvironment);
-            var sasUrl = ImportFlowUtility.GenerateSasUrl(Connection.HttpClient, AccessToken, baseUrl, environmentName);
-            var blobUri = ImportFlowUtility.BuildBlobUri(sasUrl, PackagePath);
-            ImportFlowUtility.UploadPackageToBlob(blobUri, PackagePath);
-            var importParametersResponse = ImportFlowUtility.GetImportParameters(Connection.HttpClient, AccessToken, baseUrl, environmentName, blobUri);
-            var importOperationsData = ImportFlowUtility.GetImportOperations(Connection.HttpClient, AccessToken, importParametersResponse.Location.ToString()); 
-            var propertiesElement = ImportFlowUtility.GetPropertiesElement(importOperationsData);
-
-            ImportFlowUtility.ValidateProperties(propertiesElement);
-            var resourcesObject = ImportFlowUtility.ParseResources(propertiesElement);
-            var resource = ImportFlowUtility.TransformResources(resourcesObject, Name);
-            var validatePackagePayload = ImportFlowUtility.CreateImportObject(propertiesElement, resourcesObject);
-            var validateResponseData = ImportFlowUtility.ValidateImportPackage(Connection.HttpClient, AccessToken, baseUrl, environmentName, validatePackagePayload);
-            var importPackagePayload = ImportFlowUtility.CreateImportObject(validateResponseData);
-            var importResult = ImportFlowUtility.ImportPackage(Connection.HttpClient, AccessToken, baseUrl, environmentName, importPackagePayload);
-            var importStatus = ImportFlowUtility.WaitForImportCompletion(Connection.HttpClient, AccessToken, importResult.Location.ToString());
-
-            WriteObject($"Import {importStatus}");
+            var importStatus = ImportFlowUtility.ExecuteImportFlow(Connection.HttpClient,AccessToken,baseUrl,environmentName,PackagePath,Name);
+            WriteObject(importStatus);
         }
 
         private string GetEnvironmentName()

src/Commands/Utilities/ImportFlowUtility.cs

@@ -6,14 +6,33 @@
 using PnP.Framework.Diagnostics;
 using System.Net.Http;
 using System.Text.Json.Nodes;
+using PnP.PowerShell.Commands.Model.PowerPlatform.PowerAutomate;
+using System.Threading;
 
 namespace PnP.PowerShell.Commands.Utilities
 {
     internal static class ImportFlowUtility
     {
+        public static ImportFlowResult ExecuteImportFlow(HttpClient httpClient, string accessToken, string baseUrl, string environmentName, string packagePath, string name)
+        {
+            var sasUrl = GenerateSasUrl(httpClient, accessToken, baseUrl, environmentName);
+            var blobUri = BuildBlobUri(sasUrl, packagePath);
+            UploadPackageToBlob(blobUri, packagePath);
+            var importParametersResponse = GetImportParameters(httpClient, accessToken, baseUrl, environmentName, blobUri);
+            var importOperationsData = GetImportOperations(httpClient, accessToken, importParametersResponse.Location.ToString());
+            var propertiesElement = GetPropertiesElement(importOperationsData);
+            ValidateProperties(propertiesElement);
+            var resourcesObject = ParseResources(propertiesElement);
+            var resource = TransformResources(resourcesObject, name);
+            var validatePackagePayload = CreateImportObject(propertiesElement, resourcesObject);
+            var validateResponseData = ValidateImportPackage(httpClient, accessToken, baseUrl, environmentName, validatePackagePayload);
+            var importPackagePayload = CreateImportObject(validateResponseData);
+            var importResult = ImportPackage(httpClient, accessToken, baseUrl, environmentName, importPackagePayload);
+            return WaitForImportCompletion(httpClient, accessToken, importResult.Location.ToString());
+        }
         public static string GenerateSasUrl(HttpClient httpClient, string accessToken, string baseUrl, string environmentName)
         {
-            var response = RestHelper.Post(PnPConnection.Current.HttpClient, $"{baseUrl}/providers/Microsoft.BusinessAppPlatform/environments/{environmentName}/generateResourceStorage?api-version=2016-11-01", accessToken);
+            var response = RestHelper.Post(httpClient, $"{baseUrl}/providers/Microsoft.BusinessAppPlatform/environments/{environmentName}/generateResourceStorage?api-version=2016-11-01", accessToken);
             var data = JsonSerializer.Deserialize<JsonElement>(response);
             return data.GetProperty("sharedAccessSignature").GetString();
         }
@@ -187,19 +206,20 @@ public static System.Net.Http.Headers.HttpResponseHeaders ImportPackage(HttpClie
             return importResult;
         }
 
-        public static string WaitForImportCompletion(HttpClient httpClient, string accessToken, string importPackageResponseUrl)
+        public static ImportFlowResult WaitForImportCompletion(HttpClient httpClient,string accessToken,string importPackageResponseUrl)
         {
-            string status;
+            string status = null;
             int retryCount = 0;
+            JsonElement importResultDataElement = default;
 
             do
             {
-                System.Threading.Thread.Sleep(2500);
+                Thread.Sleep(2500);
                 var importResultData = RestHelper.Get(httpClient, importPackageResponseUrl, accessToken, accept: "application/json");
-                var importResultDataElement = JsonSerializer.Deserialize<JsonElement>(importResultData);
+                importResultDataElement = JsonSerializer.Deserialize<JsonElement>(importResultData);
 
-                if (importResultDataElement.TryGetProperty("properties", out JsonElement importResultPropertiesElement) &&
-                    importResultPropertiesElement.TryGetProperty("status", out JsonElement statusElement))
+                if (importResultDataElement.TryGetProperty("properties", out JsonElement propertiesElement) &&
+                    propertiesElement.TryGetProperty("status", out JsonElement statusElement))
                 {
                     status = statusElement.GetString();
                 }
@@ -209,31 +229,30 @@ public static string WaitForImportCompletion(HttpClient httpClient, string acces
                     throw new Exception("Import status could not be determined.");
                 }
 
-
                 if (status == "Running")
                 {
                     Log.Debug("ImportFlowUtility", "Import is still running. Waiting for completion...");
                     retryCount++;
                 }
                 else if (status == "Failed")
                 {
-                    ThrowImportError(importResultData);
+                    ThrowImportError(importResultDataElement);
                 }
+
             } while (status == "Running" && retryCount < 5);
 
             if (status == "Running")
             {
                 throw new Exception("Import failed to complete after 5 attempts.");
             }
-
-            return status;
+            return MapToImportFlowResult(importResultDataElement);
         }
 
-        public static void ThrowImportError(string importResultData)
+
+        public static void ThrowImportError(JsonElement importErrorResultData)
         {
-            var importErrorResultData = JsonSerializer.Deserialize<JsonElement>(importResultData);
-            if (importErrorResultData.TryGetProperty("properties", out JsonElement importErrorResultPropertiesElement) &&
-                importErrorResultPropertiesElement.TryGetProperty("resources", out JsonElement resourcesElement))
+            if (importErrorResultData.TryGetProperty("properties", out JsonElement propertiesElement) &&
+                propertiesElement.TryGetProperty("resources", out JsonElement resourcesElement))
             {
                 foreach (var resource in resourcesElement.EnumerateObject())
                 {
@@ -244,15 +263,45 @@ public static void ThrowImportError(string importResultData)
                             : errorElement.TryGetProperty("code", out JsonElement codeElement)
                                 ? codeElement.GetString()
                                 : "Unknown error";
+
                         throw new Exception($"Import failed: {errorMessage}");
                     }
                 }
                 throw new Exception("Import failed: No error details found in resources.");
             }
-            else
+
+            throw new Exception("Import failed: Unknown error.");
+        }
+
+
+        private static ImportFlowResult MapToImportFlowResult(JsonElement importResultDataElement)
+        {
+            var result = new ImportFlowResult();
+
+            if (importResultDataElement.TryGetProperty("name", out var nameElement))
             {
-                throw new Exception("Import failed: Unknown error.");
+                result.Name = nameElement.GetString();
             }
+
+            if (importResultDataElement.TryGetProperty("properties", out var propertiesElement))
+            {
+                if (propertiesElement.TryGetProperty("status", out var statusElement))
+                {
+                    result.Status = statusElement.GetString();
+                }
+
+                var details = new ImportFlowDetails();
+                if (propertiesElement.TryGetProperty("details", out var detailsElement))
+                {
+                    details.DisplayName = detailsElement.GetProperty("displayName").GetString();
+                    details.Description = detailsElement.GetProperty("description").GetString();
+                    details.CreatedTime = detailsElement.GetProperty("createdTime").GetDateTime();
+                }
+                result.Details = details;
+            }
+
+            return result;
         }
+
     }
 }