🩹 [Patch]: Optimize Connect-GitHubApp and use parallel processing of access tokens

.github/PSModule.yml

@@ -1,17 +1,17 @@
 Test:
   CodeCoverage:
     PercentTarget: 50
-#   TestResults:
-#     Skip: true
-#   SourceCode:
-#     Skip: true
-#   PSModule:
-#     Skip: true
-#   Module:
-#     Windows:
-#       Skip: true
-#     MacOS:
-#       Skip: true
-# Build:
-#   Docs:
-#     Skip: true
+  TestResults:
+    Skip: true
+  SourceCode:
+    Skip: true
+  PSModule:
+    Skip: true
+  Module:
+    Windows:
+      Skip: true
+    MacOS:
+      Skip: true
+Build:
+  Docs:
+    Skip: true

src/functions/public/Auth/Connect-GitHubApp.ps1

@@ -5,6 +5,7 @@
 
         .DESCRIPTION
         Connects to GitHub using a GitHub App to generate installation access tokens and create contexts for targets.
+        This function supports recursive processing and parallel connections to multiple installations.
 
         Available target types:
         - User
@@ -14,7 +15,7 @@
         .EXAMPLE
         Connect-GitHubApp
 
-        Connects to GitHub as all available targets using the logged in GitHub App.
+        Connects to GitHub as all available targets using the logged in GitHub App in parallel.
 
         .EXAMPLE
         Connect-GitHubApp -User 'octocat'
@@ -31,6 +32,16 @@
 
         Connects to GitHub as the enterprise 'msx' using the logged in GitHub App.
 
+        .EXAMPLE
+        Get-GitHubAppInstallation | Connect-GitHubApp -ThrottleLimit 4
+
+        Gets all app installations and connects to them in parallel with a maximum of 4 concurrent connections.
+
+        .EXAMPLE
+        Connect-GitHubApp -User '*', -Organization 'psmodule', 'github' -ThrottleLimit 8
+
+        Connects to all users and the specified organizations in parallel with a maximum of 8 concurrent connections.
+
         .NOTES
         [Authenticating to the REST API](https://docs.github.com/rest/overview/other-authentication-methods#authenticating-for-saml-sso)
 
@@ -41,23 +52,32 @@
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Justification = 'Is the CLI part of the module.')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '',
         Justification = 'The tokens are received as clear text. Mitigating exposure by removing variables and performing garbage collection.')]
-    [CmdletBinding(DefaultParameterSetName = '__AllParameterSets')]
+    [CmdletBinding(DefaultParameterSetName = 'All Installations')]
     param(
         # The user account to connect to.
-        [Parameter(ParameterSetName = 'Filtered')]
+        [Parameter(ParameterSetName = 'Filtered', ValueFromPipelineByPropertyName)]
         [SupportsWildcards()]
         [string[]] $User,
 
         # The organization to connect to.
-        [Parameter(ParameterSetName = 'Filtered')]
+        [Parameter(ParameterSetName = 'Filtered', ValueFromPipelineByPropertyName)]
         [SupportsWildcards()]
         [string[]] $Organization,
 
         # The enterprise to connect to.
-        [Parameter(ParameterSetName = 'Filtered')]
+        [Parameter(ParameterSetName = 'Filtered', ValueFromPipelineByPropertyName)]
         [SupportsWildcards()]
         [string[]] $Enterprise,
 
+        # Installation objects from pipeline for parallel processing.
+        [Parameter(Mandatory, ParameterSetName = 'Installation', ValueFromPipeline)]
+        [GitHubAppInstallation[]] $Installation,
+
+        # The maximum number of parallel operations to run at once.
+        [Parameter(ParameterSetName = 'Filtered')]
+        [Parameter(ParameterSetName = 'Installation')]
+        [uint] $ThrottleLimit = ([Environment]::ProcessorCount * 2),
+
         # Passes the context object to the pipeline.
         [Parameter()]
         [switch] $PassThru,
@@ -82,14 +102,100 @@
         Write-Debug "[$stackPath] - Start"
         $Context = Resolve-GitHubContext -Context $Context
         Assert-GitHubContext -Context $Context -AuthType App
+        $selectedInstallations = @()
     }
 
     process {
-        $installations = Get-GitHubAppInstallation -Context $Context
-        $selectedInstallations = @()
-        Write-Verbose "Found [$($installations.Count)] installations."
         switch ($PSCmdlet.ParameterSetName) {
+            'Installation' {
+                if ($Installation.Count -eq 1) {
+                    Write-Verbose "Processing installation [$($Installation.Target.Name)] [$($Installation.ID)]"
+                    $token = New-GitHubAppInstallationAccessToken -Context $Context -ID $Installation.ID
+
+                    $contextParams = @{
+                        AuthType         = [string]'IAT'
+                        TokenType        = [string]'ghs'
+                        DisplayName      = [string]$Context.DisplayName
+                        ApiBaseUri       = [string]$Context.ApiBaseUri
+                        ApiVersion       = [string]$Context.ApiVersion
+                        HostName         = [string]$Context.HostName
+                        HttpVersion      = [string]$Context.HttpVersion
+                        PerPage          = [int]$Context.PerPage
+                        ClientID         = [string]$Context.ClientID
+                        InstallationID   = [string]$Installation.ID
+                        Permissions      = [GitHubPermission[]]$Installation.Permissions
+                        Events           = [string[]]$Installation.Events
+                        InstallationType = [string]$Installation.Type
+                        Token            = [securestring]$token.Token
+                        TokenExpiresAt   = [datetime]$token.ExpiresAt
+                    }
+
+                    switch ($Installation.Type) {
+                        'User' {
+                            $contextParams['InstallationName'] = [string]$installation.Target.Name
+                            $contextParams['Owner'] = [string]$installation.Target.Name
+                        }
+                        'Organization' {
+                            $contextParams['InstallationName'] = [string]$installation.Target.Name
+                            $contextParams['Owner'] = [string]$installation.Target.Name
+                        }
+                        'Enterprise' {
+                            $contextParams['InstallationName'] = [string]$installation.Target.Name
+                            $contextParams['Enterprise'] = [string]$installation.Target.Name
+                        }
+                    }
+                    Write-Verbose 'Logging in using a managed installation access token...'
+                    $contextParams | Format-Table | Out-String -Stream | ForEach-Object { Write-Verbose $_ }
+                    while ($true) {
+                        try {
+                            $contextObj = [GitHubAppInstallationContext]::new((Set-GitHubContext -Context $contextParams.Clone() -PassThru -Default:$Default))
+                        } catch {
+                            if ($attempts -lt 3) {
+                                $attempts++
+                                Write-Warning "Failed to create context. Retrying... [$attempts]"
+                                Start-Sleep -Seconds (1 * $attempts)
+                            } else {
+                                throw $_
+                            }
+                        }
+                    }
+                    $contextObj | Format-List | Out-String -Stream | ForEach-Object { Write-Verbose $_ }
+                    if (-not $Silent) {
+                        $name = $contextObj.Name
+                        if ($script:IsGitHubActions) {
+                            $green = $PSStyle.Foreground.Green
+                            $reset = $PSStyle.Reset
+                            Write-Host "$green✓$reset Connected $name!"
+                        } else {
+                            Write-Host '✓ ' -ForegroundColor Green -NoNewline
+                            Write-Host "Connected $name!"
+                        }
+                    }
+                    if ($PassThru) {
+                        Write-Debug "Passing context [$contextObj] to the pipeline."
+                        Write-Output $contextObj
+                    }
+                    return
+                }
+
+                $Installation | ForEach-Object -ThrottleLimit $ThrottleLimit -UseNewRunspace -Parallel {
+                    Write-Host "Using GitHub $($script:PSModuleInfo.ModuleVersion)"
+                    Import-Module -Name 'GitHub' -RequiredVersion $script:PSModuleInfo.ModuleVersion
+                    $params = @{
+                        Installation = $_
+                        Context      = $using:Context
+                        PassThru     = $using:PassThru
+                        Silent       = $using:Silent
+                        Default      = $using:Default
+                    }
+                    Connect-GitHubApp @params
+                }
+                return
+            }
             'Filtered' {
+                $installations = Get-GitHubAppInstallation -Context $Context
+                Write-Verbose "Found [$($installations.Count)] installations."
+
                 $User | ForEach-Object {
                     $userItem = $_
                     Write-Verbose "User filter:         [$userItem]."
@@ -111,73 +217,36 @@
                         $_.Type -eq 'Enterprise' -and $_.Target.Name -like $enterpriseItem
                     }
                 }
-            }
-            default {
-                Write-Verbose 'No target specified. Connecting to all installations.'
-                $selectedInstallations = $installations
-            }
-        }
-
-        Write-Verbose "Found [$($selectedInstallations.Count)] installations for the target."
-        $selectedInstallations | ForEach-Object {
-            $installation = $_
-            Write-Verbose "Processing installation [$($installation.Target.Name)] [$($installation.id)]"
-            $token = New-GitHubAppInstallationAccessToken -Context $Context -ID $installation.id
-
-            $contextParams = @{
-                AuthType         = [string]'IAT'
-                TokenType        = [string]'ghs'
-                DisplayName      = [string]$Context.DisplayName
-                ApiBaseUri       = [string]$Context.ApiBaseUri
-                ApiVersion       = [string]$Context.ApiVersion
-                HostName         = [string]$Context.HostName
-                HttpVersion      = [string]$Context.HttpVersion
-                PerPage          = [int]$Context.PerPage
-                ClientID         = [string]$Context.ClientID
-                InstallationID   = [string]$installation.ID
-                Permissions      = [GitHubPermission[]]$installation.Permissions
-                Events           = [string[]]$installation.Events
-                InstallationType = [string]$installation.Type
-                Token            = [securestring]$token.Token
-                TokenExpiresAt   = [datetime]$token.ExpiresAt
-            }
-
-            switch ($installation.Type) {
-                'User' {
-                    $contextParams['InstallationName'] = [string]$installation.Target.Name
-                    $contextParams['Owner'] = [string]$installation.Target.Name
-                }
-                'Organization' {
-                    $contextParams['InstallationName'] = [string]$installation.Target.Name
-                    $contextParams['Owner'] = [string]$installation.Target.Name
-                }
-                'Enterprise' {
-                    $contextParams['InstallationName'] = [string]$installation.Target.Name
-                    $contextParams['Enterprise'] = [string]$installation.Target.Name
+                $selectedInstallations | ForEach-Object -ThrottleLimit $ThrottleLimit -UseNewRunspace -Parallel {
+                    Import-Module -Name 'GitHub' -RequiredVersion $script:PSModuleInfo.ModuleVersion -Force
+                    $params = @{
+                        Installation = $_
+                        Context      = $using:Context
+                        PassThru     = $using:PassThru
+                        Silent       = $using:Silent
+                        Default      = $using:Default
+                    }
+                    Connect-GitHubApp @params
                 }
+                return
             }
-            Write-Verbose 'Logging in using a managed installation access token...'
-            $contextParams | Format-Table | Out-String -Stream | ForEach-Object { Write-Verbose $_ }
-            $contextObj = [GitHubAppInstallationContext]::new((Set-GitHubContext -Context $contextParams.Clone() -PassThru -Default:$Default))
-            $contextObj | Format-List | Out-String -Stream | ForEach-Object { Write-Verbose $_ }
-            if (-not $Silent) {
-                $name = $contextObj.Name
-                if ($script:IsGitHubActions) {
-                    $green = $PSStyle.Foreground.Green
-                    $reset = $PSStyle.Reset
-                    Write-Host "$green✓$reset Connected $name!"
-                } else {
-                    Write-Host '✓ ' -ForegroundColor Green -NoNewline
-                    Write-Host "Connected $name!"
+            'All Installations' {
+                Write-Verbose 'No target specified. Connecting to all installations.'
+                $selectedInstallations = Get-GitHubAppInstallation -Context $Context
+                $selectedInstallations | ForEach-Object -ThrottleLimit $ThrottleLimit -UseNewRunspace -Parallel {
+                    Import-Module -Name 'GitHub' -RequiredVersion $script:PSModuleInfo.ModuleVersion -Force
+                    $params = @{
+                        Installation = $_
+                        Context      = $using:Context
+                        PassThru     = $using:PassThru
+                        Silent       = $using:Silent
+                        Default      = $using:Default
+                    }
+                    Connect-GitHubApp @params
                 }
+                return
             }
-            if ($PassThru) {
-                Write-Debug "Passing context [$contextObj] to the pipeline."
-                Write-Output $contextObj
-            }
-            $contextParams.Clear()
         }
-
     }
 
     end {