🪲 [Fix]: Get-GitHubContext no longer fails when there are no contexts to return (#402)

MariusStorhaug · web-flow · commit 63c95b37299f · 2025-06-09T22:52:33.000+02:00
## Description This pull request includes improvements to `Get-GitHubContext`, replacing a thrown exception with a warning, causing it not error out if there are no contexts to return. ### Error Handling Improvements: * Replaced the thrown exception for missing default GitHub context with a warning message and an early return. This prevents the script from terminating unexpectedly. * Added a new test case to verify that `Get-GitHubContext` does not throw an exception when no contexts are available and returns an empty result. ## Type of change  - [ ] 📖 [Docs] - [x] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
diff --git a/src/functions/public/Auth/Context/Get-GitHubContext.ps1 b/src/functions/public/Auth/Context/Get-GitHubContext.ps1
@@ -57,7 +57,9 @@
                 Write-Debug 'Getting default context.'
                 $ID = $script:GitHub.Config.DefaultContext
                 if ([string]::IsNullOrEmpty($ID)) {
-                    throw "No default GitHub context found. Please run 'Switch-GitHubContext' or 'Connect-GitHub' to configure a GitHub context."
+                    $msg = "No default GitHub context found. Please run 'Switch-GitHubContext' or 'Connect-GitHub' to configure a GitHub context."
+                    Write-Warning $msg
+                    return
                 }
             }
         }
diff --git a/tests/GitHub.Tests.ps1 b/tests/GitHub.Tests.ps1
@@ -122,6 +122,13 @@ Describe 'Auth' {
             Get-GitHubContext -ListAvailable | Disconnect-GitHubAccount -Silent
             (Get-GitHubContext -ListAvailable).count | Should -Be 0
         }
+
+        It 'Get-GitHubContext - Does not fail when there are 0 contexts' {
+            Get-GitHubContext -ListAvailable | Disconnect-GitHubAccount -Silent
+            { Get-GitHubContext } | Should -Not -Throw
+            $contexts = Get-GitHubContext
+            $contexts | Should -BeNullOrEmpty
+        }
     }
 }
 
@@ -750,7 +757,7 @@ Describe 'Webhooks' {
 
 Describe 'Anonymous - Functions that can run anonymously' {
     It 'Get-GithubRateLimit - Using -Anonymous' {
-        $rateLimit = Get-GitHubRateLimit -Anonymous -Debug -Verbose
+        $rateLimit = Get-GitHubRateLimit -Anonymous
         LogGroup 'Rate Limit' {
             Write-Host ($rateLimit | Format-Table | Out-String)
         }
@@ -764,7 +771,7 @@ Describe 'Anonymous - Functions that can run anonymously' {
         $rateLimit | Should -Not -BeNullOrEmpty
     }
     It 'Get-GithubRateLimit - Using -Context Anonymous' {
-        $rateLimit = Get-GitHubRateLimit -Context Anonymous -Debug -Verbose
+        $rateLimit = Get-GitHubRateLimit -Context Anonymous
         LogGroup 'Rate Limit' {
             Write-Host ($rateLimit | Format-List | Out-String)
         }

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,9 @@`
`57`	`57`	`Write-Debug 'Getting default context.'`
`58`	`58`	`$ID = $script:GitHub.Config.DefaultContext`
`59`	`59`	`if ([string]::IsNullOrEmpty($ID)) {`
`60`		`- throw "No default GitHub context found. Please run 'Switch-GitHubContext' or 'Connect-GitHub' to configure a GitHub context."`
	`60`	`+ $msg = "No default GitHub context found. Please run 'Switch-GitHubContext' or 'Connect-GitHub' to configure a GitHub context."`
	`61`	`+ Write-Warning $msg`
	`62`	`+ return`
`61`	`63`	`}`
`62`	`64`	`}`
`63`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,13 @@ Describe 'Auth' {`
`122`	`122`	`Get-GitHubContext -ListAvailable \| Disconnect-GitHubAccount -Silent`
`123`	`123`	`(Get-GitHubContext -ListAvailable).count \| Should -Be 0`
`124`	`124`	`}`
	`125`	`+`
	`126`	`+ It 'Get-GitHubContext - Does not fail when there are 0 contexts' {`
	`127`	`+ Get-GitHubContext -ListAvailable \| Disconnect-GitHubAccount -Silent`
	`128`	`+ { Get-GitHubContext } \| Should -Not -Throw`
	`129`	`+ $contexts = Get-GitHubContext`
	`130`	`+ $contexts \| Should -BeNullOrEmpty`
	`131`	`+ }`
`125`	`132`	`}`
`126`	`133`	`}`
`127`	`134`
`@@ -750,7 +757,7 @@ Describe 'Webhooks' {`
`750`	`757`
`751`	`758`	`Describe 'Anonymous - Functions that can run anonymously' {`
`752`	`759`	`It 'Get-GithubRateLimit - Using -Anonymous' {`
`753`		`- $rateLimit = Get-GitHubRateLimit -Anonymous -Debug -Verbose`
	`760`	`+ $rateLimit = Get-GitHubRateLimit -Anonymous`
`754`	`761`	`LogGroup 'Rate Limit' {`
`755`	`762`	`Write-Host ($rateLimit \| Format-Table \| Out-String)`
`756`	`763`	`}`
`@@ -764,7 +771,7 @@ Describe 'Anonymous - Functions that can run anonymously' {`
`764`	`771`	`$rateLimit \| Should -Not -BeNullOrEmpty`
`765`	`772`	`}`
`766`	`773`	`It 'Get-GithubRateLimit - Using -Context Anonymous' {`
`767`		`- $rateLimit = Get-GitHubRateLimit -Context Anonymous -Debug -Verbose`
	`774`	`+ $rateLimit = Get-GitHubRateLimit -Context Anonymous`
`768`	`775`	`LogGroup 'Rate Limit' {`
`769`	`776`	`Write-Host ($rateLimit \| Format-List \| Out-String)`
`770`	`777`	`}`