Optimize search external cmdlets by not always retrieving the ExternalConnection (#4556)

KoenZomers · gautamdsheth · web-flow · commit c75562cf45e4 · 2024-11-19T16:06:14.000+02:00
* Changing retrieval of ExternalConnection through the pipebind, which adds an extra call and requires ExternalConnection permissions

* Applied optimization to more places

---------

Co-authored-by: Gautam Sheth &lt;gautamdsheth@outlook.com&gt;
diff --git a/src/Commands/Base/PipeBinds/SearchExternalConnectionPipeBind.cs b/src/Commands/Base/PipeBinds/SearchExternalConnectionPipeBind.cs
@@ -23,6 +23,11 @@ public SearchExternalConnectionPipeBind(string identity)
             _identity = identity;
         }
 
+        public string GetExternalConnectionId(PSCmdlet cmdlet, PnPConnection connection, string accessToken)
+        {
+            return _identity ?? _searchExternalConnection?.Id ?? GetExternalConnection(cmdlet, connection, accessToken)?.Id;
+        }
+
         public Model.Graph.MicrosoftSearch.ExternalConnection GetExternalConnection(PSCmdlet cmdlet, PnPConnection connection, string accessToken)
         {
             if(_searchExternalConnection != null)
diff --git a/src/Commands/Search/GetSearchExternalConnection.cs b/src/Commands/Search/GetSearchExternalConnection.cs
@@ -13,7 +13,7 @@ namespace PnP.PowerShell.Commands.Search
     [OutputType(typeof(Model.Graph.MicrosoftSearch.ExternalConnection))]
     public class GetSearchExternalConnection : PnPGraphCmdlet
     {
-        [Parameter(Mandatory = false)]
+        [Parameter(Mandatory = false, Position = 0, ValueFromPipeline = true)]
         public string Identity;
 
         protected override void ExecuteCmdlet()
diff --git a/src/Commands/Search/GetSearchExternalItem.cs b/src/Commands/Search/GetSearchExternalItem.cs
@@ -25,7 +25,7 @@ public class GetSearchExternalItem : PnPGraphCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var externalConnection = ConnectionId.GetExternalConnection(this, Connection, AccessToken);
+            var externalConnectionId = ConnectionId.GetExternalConnectionId(this, Connection, AccessToken) ?? throw new PSArgumentException("No valid external connection specified", nameof(ConnectionId));
 
             var searchQuery = new Model.Graph.MicrosoftSearch.SearchRequests
             {
@@ -39,7 +39,7 @@ protected override void ExecuteCmdlet()
                         ],
                         ContentSources =
                         [
-                            $"/external/connections/{externalConnection.Id}"
+                            $"/external/connections/{externalConnectionId}"
                         ],
                         Query = new Model.Graph.MicrosoftSearch.SearchRequestQuery
                         {
@@ -59,11 +59,11 @@ protected override void ExecuteCmdlet()
 
             if(hits == null || hits.Count == 0)
             {
-                WriteVerbose($"No external items found{(ParameterSpecified(nameof(Identity)) ? $" with the identity '{Identity}'" : "")} on external connection '{externalConnection.Id}'");
+                WriteVerbose($"No external items found{(ParameterSpecified(nameof(Identity)) ? $" with the identity '{Identity}'" : "")} on external connection '{externalConnectionId}'");
                 return;
             }
 
-            WriteVerbose($"Found {hits.Count} external item{(hits.Count != 1 ? "s" : "")}{(ParameterSpecified(nameof(Identity)) ? $" with the identity '{Identity}'" : "")} on external connection '{externalConnection.Id}'");
+            WriteVerbose($"Found {hits.Count} external item{(hits.Count != 1 ? "s" : "")}{(ParameterSpecified(nameof(Identity)) ? $" with the identity '{Identity}'" : "")} on external connection '{externalConnectionId}'");
 
             var externalItems = hits.Select(s => new Model.Graph.MicrosoftSearch.ExternalItem {  
                 Id = s.Resource.Properties["fileID"].ToString()[(s.Resource.Properties["fileID"].ToString().LastIndexOf(',') + 1)..],
diff --git a/src/Commands/Search/GetSearchExternalSchema.cs b/src/Commands/Search/GetSearchExternalSchema.cs
@@ -15,8 +15,8 @@ public class GetSearchExternalSchema : PnPGraphCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var searchExternalConnection = ConnectionId.GetExternalConnection(this, Connection, AccessToken);
-            var graphApiUrl = $"v1.0/external/connections/{searchExternalConnection.Id}/schema";
+            var externalConnectionId = ConnectionId.GetExternalConnectionId(this, Connection, AccessToken) ?? throw new PSArgumentException("No valid external connection specified", nameof(ConnectionId));
+            var graphApiUrl = $"v1.0/external/connections/{externalConnectionId}/schema";
             var result = Utilities.REST.GraphHelper.Get<Model.Graph.MicrosoftSearch.ExternalSchema>(this, Connection, graphApiUrl, AccessToken, additionalHeaders: new System.Collections.Generic.Dictionary<string, string> { { "Prefer", "include-unknown-enum-members" } });
             WriteObject(result, false);
         }
diff --git a/src/Commands/Search/RemoveSearchExternalConnection.cs b/src/Commands/Search/RemoveSearchExternalConnection.cs
@@ -14,8 +14,8 @@ public class RemoveSearchExternalConnection : PnPGraphCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var externalConnection = Identity.GetExternalConnection(this, Connection, AccessToken);
-            Utilities.REST.GraphHelper.Delete(this, Connection, $"v1.0/external/connections/{externalConnection.Id}", AccessToken);
+            var externalConnectionId = Identity.GetExternalConnectionId(this, Connection, AccessToken) ?? throw new PSArgumentException("No valid external connection specified", nameof(Identity));
+            Utilities.REST.GraphHelper.Delete(this, Connection, $"v1.0/external/connections/{externalConnectionId}", AccessToken);
         }
     }
 }
diff --git a/src/Commands/Search/RemoveSearchExternalItem.cs b/src/Commands/Search/RemoveSearchExternalItem.cs
@@ -21,16 +21,16 @@ public class RemoveSearchExternalItem : PnPGraphCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var connection = ConnectionId.GetExternalConnection(this, Connection, AccessToken);
+            var externalConnectionId = ConnectionId.GetExternalConnectionId(this, Connection, AccessToken) ?? throw new PSArgumentException("No valid external connection specified", nameof(ConnectionId));
 
             try
             {
-                var response = GraphHelper.Delete(this, Connection, $"beta/external/connections/{connection.Id}/items/{ItemId}", AccessToken);
-                WriteVerbose($"External item with ID '{ItemId}' successfully removed from external connection '{connection.Id}'");
+                var response = GraphHelper.Delete(this, Connection, $"beta/external/connections/{externalConnectionId}/items/{ItemId}", AccessToken);
+                WriteVerbose($"External item with ID '{ItemId}' successfully removed from external connection '{externalConnectionId}'");
             }
             catch (PSInvalidOperationException ex)
             {
-                throw new PSInvalidOperationException($"Removing external item with ID '{ItemId}' from external connection '{connection.Id}' failed with message '{ex.Message}'", ex);
+                throw new PSInvalidOperationException($"Removing external item with ID '{ItemId}' from external connection '{externalConnectionId}' failed with message '{ex.Message}'", ex);
             }
         }
     }
diff --git a/src/Commands/Search/SetSearchExternalConnection.cs b/src/Commands/Search/SetSearchExternalConnection.cs
@@ -41,8 +41,8 @@ protected override void ExecuteCmdlet()
             var jsonContent = JsonContent.Create(bodyContent, null, new JsonSerializerOptions { DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull });
             WriteVerbose($"Constructed payload: {jsonContent.ReadAsStringAsync().GetAwaiter().GetResult()}");
 
-            var externalConnection = Identity.GetExternalConnection(this, Connection, AccessToken);
-            var graphApiUrl = $"v1.0/external/connections/{externalConnection.Id}";
+            var externalConnectionId = Identity.GetExternalConnectionId(this, Connection, AccessToken) ?? throw new PSArgumentException("No valid external connection specified", nameof(Identity));
+            var graphApiUrl = $"v1.0/external/connections/{externalConnectionId}";
             Utilities.REST.GraphHelper.Patch(this, Connection, AccessToken, jsonContent, graphApiUrl);
         }
     }
diff --git a/src/Commands/Search/SetSearchExternalItem.cs b/src/Commands/Search/SetSearchExternalItem.cs
@@ -105,8 +105,8 @@ protected override void ExecuteCmdlet()
             var jsonContent = JsonContent.Create(bodyContent);
             WriteVerbose($"Constructed payload: {jsonContent.ReadAsStringAsync().GetAwaiter().GetResult()}");
 
-            var searchExternalConnection = ConnectionId.GetExternalConnection(this, Connection, AccessToken);
-            var graphApiUrl = $"v1.0/external/connections/{searchExternalConnection.Id}/items/{ItemId}";
+            var externalConnectionId = ConnectionId.GetExternalConnectionId(this, Connection, AccessToken) ?? throw new PSArgumentException("No valid external connection specified", nameof(ConnectionId));
+            var graphApiUrl = $"v1.0/external/connections/{externalConnectionId}/items/{ItemId}";
             var results = Utilities.REST.GraphHelper.Put<Model.Graph.MicrosoftSearch.ExternalItem>(this, Connection, graphApiUrl, AccessToken, jsonContent);
             WriteObject(results, false);
         }
diff --git a/src/Commands/Search/SetSearchExternalSchema.cs b/src/Commands/Search/SetSearchExternalSchema.cs
@@ -37,7 +37,7 @@ public class SetSearchExternalSchema : PnPGraphCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var searchExternalConnection = ConnectionId.GetExternalConnection(this, Connection, AccessToken);
+            var externalConnectionId = ConnectionId.GetExternalConnectionId(this, Connection, AccessToken) ?? throw new PSArgumentException("No valid external connection specified", nameof(ConnectionId));
 
             switch(ParameterSetName)
             {
@@ -53,7 +53,7 @@ protected override void ExecuteCmdlet()
             var jsonContent = new StringContent(SchemaAsText);
             WriteVerbose($"Constructed payload: {jsonContent.ReadAsStringAsync().GetAwaiter().GetResult()}");
 
-            var graphApiUrl = $"v1.0/external/connections/{searchExternalConnection.Id}/schema";
+            var graphApiUrl = $"v1.0/external/connections/{externalConnectionId}/schema";
             var results = Utilities.REST.GraphHelper.Patch(this, Connection, AccessToken, jsonContent, graphApiUrl);
             
             WriteVerbose("Trying to retrieve location header from response which can be used to poll for the status of the schema operation");

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,11 @@ public SearchExternalConnectionPipeBind(string identity)`
`23`	`23`	`_identity = identity;`
`24`	`24`	`}`
`25`	`25`
	`26`	`+ public string GetExternalConnectionId(PSCmdlet cmdlet, PnPConnection connection, string accessToken)`
	`27`	`+ {`
	`28`	`+ return _identity ?? _searchExternalConnection?.Id ?? GetExternalConnection(cmdlet, connection, accessToken)?.Id;`
	`29`	`+ }`
	`30`	`+`
`26`	`31`	`public Model.Graph.MicrosoftSearch.ExternalConnection GetExternalConnection(PSCmdlet cmdlet, PnPConnection connection, string accessToken)`
`27`	`32`	`{`
`28`	`33`	`if(_searchExternalConnection != null)`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ namespace PnP.PowerShell.Commands.Search`
`13`	`13`	`[OutputType(typeof(Model.Graph.MicrosoftSearch.ExternalConnection))]`
`14`	`14`	`public class GetSearchExternalConnection : PnPGraphCmdlet`
`15`	`15`	`{`
`16`		`- [Parameter(Mandatory = false)]`
	`16`	`+ [Parameter(Mandatory = false, Position = 0, ValueFromPipeline = true)]`
`17`	`17`	`public string Identity;`
`18`	`18`
`19`	`19`	`protected override void ExecuteCmdlet()`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public class GetSearchExternalItem : PnPGraphCmdlet`
`25`	`25`
`26`	`26`	`protected override void ExecuteCmdlet()`
`27`	`27`	`{`
`28`		`- var externalConnection = ConnectionId.GetExternalConnection(this, Connection, AccessToken);`
	`28`	`+ var externalConnectionId = ConnectionId.GetExternalConnectionId(this, Connection, AccessToken) ?? throw new PSArgumentException("No valid external connection specified", nameof(ConnectionId));`
`29`	`29`
`30`	`30`	`var searchQuery = new Model.Graph.MicrosoftSearch.SearchRequests`
`31`	`31`	`{`
`@@ -39,7 +39,7 @@ protected override void ExecuteCmdlet()`
`39`	`39`	`],`
`40`	`40`	`ContentSources =`
`41`	`41`	`[`
`42`		`- $"/external/connections/{externalConnection.Id}"`
	`42`	`+ $"/external/connections/{externalConnectionId}"`
`43`	`43`	`],`
`44`	`44`	`Query = new Model.Graph.MicrosoftSearch.SearchRequestQuery`
`45`	`45`	`{`
`@@ -59,11 +59,11 @@ protected override void ExecuteCmdlet()`
`59`	`59`
`60`	`60`	`if(hits == null \|\| hits.Count == 0)`
`61`	`61`	`{`
`62`		`- WriteVerbose($"No external items found{(ParameterSpecified(nameof(Identity)) ? $" with the identity '{Identity}'" : "")} on external connection '{externalConnection.Id}'");`
	`62`	`+ WriteVerbose($"No external items found{(ParameterSpecified(nameof(Identity)) ? $" with the identity '{Identity}'" : "")} on external connection '{externalConnectionId}'");`
`63`	`63`	`return;`
`64`	`64`	`}`
`65`	`65`
`66`		`- WriteVerbose($"Found {hits.Count} external item{(hits.Count != 1 ? "s" : "")}{(ParameterSpecified(nameof(Identity)) ? $" with the identity '{Identity}'" : "")} on external connection '{externalConnection.Id}'");`
	`66`	`+ WriteVerbose($"Found {hits.Count} external item{(hits.Count != 1 ? "s" : "")}{(ParameterSpecified(nameof(Identity)) ? $" with the identity '{Identity}'" : "")} on external connection '{externalConnectionId}'");`
`67`	`67`
`68`	`68`	`var externalItems = hits.Select(s => new Model.Graph.MicrosoftSearch.ExternalItem {`
`69`	`69`	`Id = s.Resource.Properties["fileID"].ToString()[(s.Resource.Properties["fileID"].ToString().LastIndexOf(',') + 1)..],`
Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,8 @@ public class GetSearchExternalSchema : PnPGraphCmdlet`
`15`	`15`
`16`	`16`	`protected override void ExecuteCmdlet()`
`17`	`17`	`{`
`18`		`- var searchExternalConnection = ConnectionId.GetExternalConnection(this, Connection, AccessToken);`
`19`		`- var graphApiUrl = $"v1.0/external/connections/{searchExternalConnection.Id}/schema";`
	`18`	`+ var externalConnectionId = ConnectionId.GetExternalConnectionId(this, Connection, AccessToken) ?? throw new PSArgumentException("No valid external connection specified", nameof(ConnectionId));`
	`19`	`+ var graphApiUrl = $"v1.0/external/connections/{externalConnectionId}/schema";`
`20`	`20`	`var result = Utilities.REST.GraphHelper.Get<Model.Graph.MicrosoftSearch.ExternalSchema>(this, Connection, graphApiUrl, AccessToken, additionalHeaders: new System.Collections.Generic.Dictionary<string, string> { { "Prefer", "include-unknown-enum-members" } });`
`21`	`21`	`WriteObject(result, false);`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,8 +14,8 @@ public class RemoveSearchExternalConnection : PnPGraphCmdlet`
`14`	`14`
`15`	`15`	`protected override void ExecuteCmdlet()`
`16`	`16`	`{`
`17`		`- var externalConnection = Identity.GetExternalConnection(this, Connection, AccessToken);`
`18`		`- Utilities.REST.GraphHelper.Delete(this, Connection, $"v1.0/external/connections/{externalConnection.Id}", AccessToken);`
	`17`	`+ var externalConnectionId = Identity.GetExternalConnectionId(this, Connection, AccessToken) ?? throw new PSArgumentException("No valid external connection specified", nameof(Identity));`
	`18`	`+ Utilities.REST.GraphHelper.Delete(this, Connection, $"v1.0/external/connections/{externalConnectionId}", AccessToken);`
`19`	`19`	`}`
`20`	`20`	`}`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,16 +21,16 @@ public class RemoveSearchExternalItem : PnPGraphCmdlet`
`21`	`21`
`22`	`22`	`protected override void ExecuteCmdlet()`
`23`	`23`	`{`
`24`		`- var connection = ConnectionId.GetExternalConnection(this, Connection, AccessToken);`
	`24`	`+ var externalConnectionId = ConnectionId.GetExternalConnectionId(this, Connection, AccessToken) ?? throw new PSArgumentException("No valid external connection specified", nameof(ConnectionId));`
`25`	`25`
`26`	`26`	`try`
`27`	`27`	`{`
`28`		`- var response = GraphHelper.Delete(this, Connection, $"beta/external/connections/{connection.Id}/items/{ItemId}", AccessToken);`
`29`		`- WriteVerbose($"External item with ID '{ItemId}' successfully removed from external connection '{connection.Id}'");`
	`28`	`+ var response = GraphHelper.Delete(this, Connection, $"beta/external/connections/{externalConnectionId}/items/{ItemId}", AccessToken);`
	`29`	`+ WriteVerbose($"External item with ID '{ItemId}' successfully removed from external connection '{externalConnectionId}'");`
`30`	`30`	`}`
`31`	`31`	`catch (PSInvalidOperationException ex)`
`32`	`32`	`{`
`33`		`- throw new PSInvalidOperationException($"Removing external item with ID '{ItemId}' from external connection '{connection.Id}' failed with message '{ex.Message}'", ex);`
	`33`	`+ throw new PSInvalidOperationException($"Removing external item with ID '{ItemId}' from external connection '{externalConnectionId}' failed with message '{ex.Message}'", ex);`
`34`	`34`	`}`
`35`	`35`	`}`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,8 @@ protected override void ExecuteCmdlet()`
`41`	`41`	`var jsonContent = JsonContent.Create(bodyContent, null, new JsonSerializerOptions { DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull });`
`42`	`42`	`WriteVerbose($"Constructed payload: {jsonContent.ReadAsStringAsync().GetAwaiter().GetResult()}");`
`43`	`43`
`44`		`- var externalConnection = Identity.GetExternalConnection(this, Connection, AccessToken);`
`45`		`- var graphApiUrl = $"v1.0/external/connections/{externalConnection.Id}";`
	`44`	`+ var externalConnectionId = Identity.GetExternalConnectionId(this, Connection, AccessToken) ?? throw new PSArgumentException("No valid external connection specified", nameof(Identity));`
	`45`	`+ var graphApiUrl = $"v1.0/external/connections/{externalConnectionId}";`
`46`	`46`	`Utilities.REST.GraphHelper.Patch(this, Connection, AccessToken, jsonContent, graphApiUrl);`
`47`	`47`	`}`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public class SetSearchExternalSchema : PnPGraphCmdlet`
`37`	`37`
`38`	`38`	`protected override void ExecuteCmdlet()`
`39`	`39`	`{`
`40`		`- var searchExternalConnection = ConnectionId.GetExternalConnection(this, Connection, AccessToken);`
	`40`	`+ var externalConnectionId = ConnectionId.GetExternalConnectionId(this, Connection, AccessToken) ?? throw new PSArgumentException("No valid external connection specified", nameof(ConnectionId));`
`41`	`41`
`42`	`42`	`switch(ParameterSetName)`
`43`	`43`	`{`
`@@ -53,7 +53,7 @@ protected override void ExecuteCmdlet()`
`53`	`53`	`var jsonContent = new StringContent(SchemaAsText);`
`54`	`54`	`WriteVerbose($"Constructed payload: {jsonContent.ReadAsStringAsync().GetAwaiter().GetResult()}");`
`55`	`55`
`56`		`- var graphApiUrl = $"v1.0/external/connections/{searchExternalConnection.Id}/schema";`
	`56`	`+ var graphApiUrl = $"v1.0/external/connections/{externalConnectionId}/schema";`
`57`	`57`	`var results = Utilities.REST.GraphHelper.Patch(this, Connection, AccessToken, jsonContent, graphApiUrl);`
`58`	`58`
`59`	`59`	`WriteVerbose("Trying to retrieve location header from response which can be used to poll for the status of the schema operation");`