🪲 [Fix]: GitHub App Installations load failure

Coverage.md

@@ -5,19 +5,19 @@
 <table>
     <tr>
         <td>Available functions</td>
-        <td>985</td>
+        <td>980</td>
     </tr>
     <tr>
         <td>Covered functions</td>
         <td>155</td>
     </tr>
     <tr>
         <td>Missing functions</td>
-        <td>830</td>
+        <td>825</td>
     </tr>
     <tr>
         <td>Coverage</td>
-        <td>15.74%</td>
+        <td>15.82%</td>
     </tr>
 </table>
 
@@ -52,13 +52,8 @@
 | `/codes_of_conduct`                                                                                                       |                    | :x:                |                    |                    |                    |
 | `/codes_of_conduct/{key}`                                                                                                 |                    | :x:                |                    |                    |                    |
 | `/emojis`                                                                                                                 |                    | :white_check_mark: |                    |                    |                    |
-| `/enterprises/{enterprise}/copilot/billing/seats`                                                                         |                    | :x:                |                    |                    |                    |
-| `/enterprises/{enterprise}/copilot/metrics`                                                                               |                    | :x:                |                    |                    |                    |
-| `/enterprises/{enterprise}/copilot/usage`                                                                                 |                    | :x:                |                    |                    |                    |
 | `/enterprises/{enterprise}/dependabot/alerts`                                                                             |                    | :x:                |                    |                    |                    |
 | `/enterprises/{enterprise}/secret-scanning/alerts`                                                                        |                    | :x:                |                    |                    |                    |
-| `/enterprises/{enterprise}/team/{team_slug}/copilot/metrics`                                                              |                    | :x:                |                    |                    |                    |
-| `/enterprises/{enterprise}/team/{team_slug}/copilot/usage`                                                                |                    | :x:                |                    |                    |                    |
 | `/events`                                                                                                                 |                    | :x:                |                    |                    |                    |
 | `/feeds`                                                                                                                  |                    | :x:                |                    |                    |                    |
 | `/gists`                                                                                                                  |                    | :x:                |                    | :x:                |                    |

src/classes/public/Context/GitHubContext/AppGitHubContext.ps1

@@ -9,11 +9,14 @@
     [string] $OwnerType
 
     # The permissions that the app is requesting on the target
-    [string[]] $Permissions
+    [pscustomobject] $Permissions
 
     # The events that the app is subscribing to once installed
     [string[]] $Events
 
+    # Simple parameterless constructor
+    AppGitHubContext() {}
+
     # Creates a context object from a hashtable of key-vaule pairs.
     AppGitHubContext([hashtable]$Properties) {
         foreach ($Property in $Properties.Keys) {

src/classes/public/Context/GitHubContext/InstallationGitHubContext.ps1

@@ -10,7 +10,7 @@
     [int] $InstallationID
 
     # The permissions that the app is requesting on the target
-    [string[]] $Permissions
+    [pscustomobject] $Permissions
 
     # The events that the app is subscribing to once installed
     [string[]] $Events
@@ -21,6 +21,9 @@
     # The target login of the installation.
     [string] $TargetName
 
+    # Simple parameterless constructor
+    InstallationGitHubContext() {}
+
     # Creates a context object from a hashtable of key-vaule pairs.
     InstallationGitHubContext([hashtable]$Properties) {
         foreach ($Property in $Properties.Keys) {

src/classes/public/Context/GitHubContext/UserGitHubContext.ps1

@@ -22,6 +22,9 @@
     # 2024-01-01-00:00:00
     [datetime] $RefreshTokenExpirationDate
 
+    # Simple parameterless constructor
+    UserGitHubContext() {}
+
     # Creates a context object from a hashtable of key-vaule pairs.
     UserGitHubContext([hashtable]$Properties) {
         foreach ($Property in $Properties.Keys) {

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

@@ -103,17 +103,11 @@
         )]
         [string] $PrivateKey,
 
-        # Skip loading GitHub App contexts.
+        # Automatically load installations for the GitHub App.
         [Parameter(
             ParameterSetName = 'App'
         )]
-        [switch] $SkipAppAutoload,
-
-        # Do not load credentials for the GitHub App Installations, just metadata.
-        [Parameter(
-            ParameterSetName = 'App'
-        )]
-        [switch] $Shallow,
+        [switch] $AutoloadInstallations,
 
         # The default enterprise to use in commands.
         [Parameter()]
@@ -181,19 +175,6 @@
                 if (-not $customTokenProvided -and $gitHubTokenPresent) {
                     $authType = 'Token'
                     $Token = $gitHubToken
-                    $gitHubEvent = Get-Content -Path $env:GITHUB_EVENT_PATH -Raw | ConvertFrom-Json
-                    'Enterprise:            ' + $gitHubEvent.enterprise.slug
-                    'Organization:          ' + $gitHubEvent.organization.login
-                    'Repository:            ' + $gitHubEvent.repository.name
-                    'Repository Owner:      ' + $gitHubEvent.repository.owner.login
-                    'Repository Owner Type: ' + $gitHubEvent.repository.owner.type
-                    'Sender:                ' + $gitHubEvent.sender.login
-
-                    $Enterprise = [string]$gitHubEvent.enterprise.slug
-                    $TargetType = [string]$gitHubEvent.repository.owner.type
-                    $TargetName = [string]$gitHubEvent.repository.owner.login
-                    $Owner = [string]$gitHubEvent.repository.owner.login
-                    $Repo = [string]$gitHubEvent.repository.name
                 }
             }
 
@@ -299,10 +280,8 @@
                         'ghs' {
                             Write-Verbose 'Logging in using an installation access token...'
                             $context += @{
-                                Token      = ConvertTo-SecureString -AsPlainText $Token
-                                TokenType  = $tokenType
-                                TargetType = $TargetType
-                                TargetName = $TargetName
+                                Token     = ConvertTo-SecureString -AsPlainText $Token
+                                TokenType = $tokenType
                             }
                             $context['AuthType'] = 'IAT'
                         }
@@ -322,9 +301,9 @@
                 Write-Host "Logged in as $name!"
             }
 
-            if ($authType -eq 'App' -and -not $SkipAppAutoload) {
-                Write-Verbose 'Loading GitHub App contexts...'
-                Connect-GitHubApp -Shallow:$Shallow
+            if ($authType -eq 'App' -and $AutoloadInstallations) {
+                Write-Verbose 'Loading GitHub App Installation contexts...'
+                Connect-GitHubApp
             }
 
         } catch {

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

@@ -64,96 +64,86 @@
         # The context to run the command in. Used to get the details for the API call.
         # Can be either a string or a GitHubContext object.
         [Parameter()]
-        [object] $Context = (Get-GitHubContext),
-
-        # Do not load credentials for the GitHub App Installations, just metadata.
-        [Parameter()]
-        [switch] $Shallow
+        [object] $Context = (Get-GitHubContext)
     )
 
-    $commandName = $MyInvocation.MyCommand.Name
-    Write-Verbose "[$commandName] - Start"
+    begin {
+        $commandName = $MyInvocation.MyCommand.Name
+        Write-Verbose "[$commandName] - Start"
+    }
 
-    $Context = $Context | Resolve-GitHubContext
-    $Context | Assert-GitHubContext -AuthType 'App'
+    process {
+        try {
+            $Context = $Context | Resolve-GitHubContext
+            $Context | Assert-GitHubContext -AuthType 'App'
 
-    try {
-        $defaultContextData = @{
-            ApiBaseUri = $Context.ApiBaseUri
-            ApiVersion = $Context.ApiVersion
-            HostName   = $Context.HostName
-            ClientID   = $Context.ClientID
-            AuthType   = 'IAT'
-            TokenType  = 'ghs'
-        }
-
-        $installations = Get-GitHubAppInstallation
-        Write-Verbose "Found [$($installations.Count)] installations."
-        switch ($PSCmdlet.ParameterSetName) {
-            'User' {
-                Write-Verbose "Filtering installations for user [$User]."
-                $installations = $installations | Where-Object { $_.target_type -eq 'User' -and $_.account.login -in $User }
-            }
-            'Organization' {
-                Write-Verbose "Filtering installations for organization [$Organization]."
-                $installations = $installations | Where-Object { $_.target_type -eq 'Organization' -and $_.account.login -in $Organization }
-            }
-            'Enterprise' {
-                Write-Verbose "Filtering installations for enterprise [$Enterprise]."
-                $installations = $installations | Where-Object { $_.target_type -eq 'Enterprise' -and $_.account.slug -in $Enterprise }
-            }
-        }
-
-        Write-Verbose "Found [$($installations.Count)] installations for the target type."
-        $installations | ForEach-Object {
-            $installation = $_
-            $contextParams = @{} + $defaultContextData.Clone()
-            if ($Shallow) {
-                $token = [PSCustomObject]@{
-                    Token     = [securestring]::new()
-                    ExpiresAt = [datetime]::MinValue
-                }
-            } else {
-                $token = New-GitHubAppInstallationAccessToken -InstallationID $installation.id
-            }
-            $contextParams += @{
-                InstallationID      = $installation.id
-                Token               = $token.Token
-                TokenExpirationDate = $token.ExpiresAt
-                Permissions         = $installation.permissions
-                Events              = $installation.events
-                TargetType          = $installation.target_type
-            }
-            switch ($installation.target_type) {
+            $installations = Get-GitHubAppInstallation -Context $Context
+            Write-Verbose "Found [$($installations.Count)] installations."
+            switch ($PSCmdlet.ParameterSetName) {
                 'User' {
-                    $contextParams += @{
-                        TargetName = $installation.account.login
-                    }
+                    Write-Verbose "Filtering installations for user [$User]."
+                    $installations = $installations | Where-Object { $_.target_type -eq 'User' -and $_.account.login -in $User }
                 }
                 'Organization' {
-                    $contextParams += @{
-                        TargetName = $installation.account.login
-                    }
+                    Write-Verbose "Filtering installations for organization [$Organization]."
+                    $installations = $installations | Where-Object { $_.target_type -eq 'Organization' -and $_.account.login -in $Organization }
                 }
                 'Enterprise' {
-                    $contextParams += @{
-                        TargetName = $installation.account.slug
-                    }
+                    Write-Verbose "Filtering installations for enterprise [$Enterprise]."
+                    $installations = $installations | Where-Object { $_.target_type -eq 'Enterprise' -and $_.account.slug -in $Enterprise }
                 }
             }
-            Write-Verbose 'Logging in using an installation access token...'
-            Write-Verbose ($contextParams | Format-Table | Out-String)
-            $tmpContext = [InstallationGitHubContext]::new((Set-GitHubContext -Context $contextParams -PassThru))
-            Write-Verbose ($tmpContext | Format-List | Out-String)
-            if (-not $Silent) {
-                $name = $tmpContext.name
-                Write-Host "Connected $name"
+
+            Write-Verbose "Found [$($installations.Count)] installations for the target."
+            $installations | ForEach-Object {
+                $installation = $_
+                Write-Verbose "Processing installation [$($installation.account.login)] [$($installation.id)]"
+                $token = New-GitHubAppInstallationAccessToken -Context $Context -InstallationID $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
+                    ClientID            = [string]$Context.ClientID
+                    InstallationID      = [string]$installation.id
+                    Permissions         = [pscustomobject]$installation.permissions
+                    Events              = [string[]]$installation.events
+                    TargetType          = [string]$installation.target_type
+                    Token               = [securestring]$token.Token
+                    TokenExpirationDate = [string]$token.ExpiresAt
+                }
+
+                switch ($installation.target_type) {
+                    'User' {
+                        $contextParams['TargetName'] = $installation.account.login
+                    }
+                    'Organization' {
+                        $contextParams['TargetName'] = $installation.account.login
+                    }
+                    'Enterprise' {
+                        $contextParams['TargetName'] = $installation.account.slug
+                    }
+                }
+                Write-Verbose 'Logging in using a managed installation access token...'
+                Write-Verbose ($contextParams | Format-Table | Out-String)
+                $tmpContext = [InstallationGitHubContext]::new((Set-GitHubContext -Context $contextParams.Clone() -PassThru))
+                Write-Verbose ($tmpContext | Format-List | Out-String)
+                if (-not $Silent) {
+                    $name = $tmpContext.name
+                    Write-Host "Connected $name"
+                }
+                $contextParams.Clear()
             }
+        } catch {
+            Write-Error $_
+            Write-Error (Get-PSCallStack | Format-Table | Out-String)
+            throw 'Failed to connect to GitHub using a GitHub App.'
         }
-    } catch {
-        Write-Error $_
-        Write-Error (Get-PSCallStack | Format-Table | Out-String)
-        throw 'Failed to connect to GitHub using a GitHub App.'
     }
-    Write-Verbose "[$commandName] - End"
+    end {
+        Write-Verbose "[$commandName] - End"
+    }
 }