🩹 [Patch]: Add a dynamically format property for GitHubContext (#449)

MariusStorhaug · web-flow · commit 1b4773a55f30 · 2025-07-01T20:05:02.000+02:00
## Description This pull request introduces a new `Remaining` property to GitHub context types and updates the display format to show the time remaining until token expiration. The changes improve the clarity and usability of token expiration information by providing both textual and color-coded visual indicators. ### Enhancements to GitHub context display: * **Added a new column for `Remaining` in the table display**: - Updated `src/formats/GitHubContext.Format.ps1xml` to include a `Remaining` column header and display logic for the time remaining until token expiration. The display uses a color-coded system based on the ratio of remaining time to the maximum allowed duration, enhancing visual clarity. [[1]](diffhunk://#diff-c7dd80cd4c4440ccbe24930842a2e172614dbfd79d31393d68852200eacc2c74R29-R31) [[2]](diffhunk://#diff-c7dd80cd4c4440ccbe24930842a2e172614dbfd79d31393d68852200eacc2c74R55-R97) ### GitHub context types improvements: * **Introduced the `Remaining` property for token expiration**: - Added a `Remaining` script property to both `InstallationGitHubContext` and `UserGitHubContext` types in `src/types/GitHubContext.Types.ps1xml`. This property calculates the time span between the current date and the token expiration date, enabling the new display functionality. ## Type of change  - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [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/classes/public/Context/GitHubContext.ps1 b/src/classes/public/Context/GitHubContext.ps1
@@ -62,9 +62,29 @@
     # The default value for the 'per_page' API parameter used in 'GET' functions that support paging.
     [int] $PerPage
 
-    # Simple parameterless constructor
     GitHubContext() {}
 
+    GitHubContext([pscustomobject]$Object) {
+        $this.ID = $Object.ID
+        $this.Name = $Object.Name
+        $this.DisplayName = $Object.DisplayName
+        $this.Type = $Object.Type
+        $this.HostName = $Object.HostName
+        $this.ApiBaseUri = $Object.ApiBaseUri
+        $this.ApiVersion = $Object.ApiVersion
+        $this.AuthType = $Object.AuthType
+        $this.NodeID = $Object.NodeID
+        $this.DatabaseID = $Object.DatabaseID
+        $this.UserName = $Object.UserName
+        $this.Token = $Object.Token
+        $this.TokenType = $Object.TokenType
+        $this.Enterprise = $Object.Enterprise
+        $this.Owner = $Object.Owner
+        $this.Repository = $Object.Repository
+        $this.HttpVersion = $Object.HttpVersion
+        $this.PerPage = $Object.PerPage
+    }
+
     [string] ToString() {
         return $this.Name
     }
diff --git a/src/classes/public/Context/GitHubContext/AppGitHubContext.ps1 b/src/classes/public/Context/GitHubContext/AppGitHubContext.ps1
@@ -14,20 +14,31 @@
     # 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) {
-            $this.$Property = $Properties.$Property
-        }
-    }
-
-    # Creates a context object from a PSCustomObject.
-    AppGitHubContext([PSCustomObject]$Object) {
-        $Object.PSObject.Properties | ForEach-Object {
-            $this.($_.Name) = $_.Value
-        }
+    AppGitHubContext([pscustomobject]$Object) {
+        $this.ID = $Object.ID
+        $this.Name = $Object.Name
+        $this.DisplayName = $Object.DisplayName
+        $this.Type = $Object.Type
+        $this.HostName = $Object.HostName
+        $this.ApiBaseUri = $Object.ApiBaseUri
+        $this.ApiVersion = $Object.ApiVersion
+        $this.AuthType = $Object.AuthType
+        $this.NodeID = $Object.NodeID
+        $this.DatabaseID = $Object.DatabaseID
+        $this.UserName = $Object.UserName
+        $this.Token = $Object.Token
+        $this.TokenType = $Object.TokenType
+        $this.Enterprise = $Object.Enterprise
+        $this.Owner = $Object.Owner
+        $this.Repository = $Object.Repository
+        $this.HttpVersion = $Object.HttpVersion
+        $this.PerPage = $Object.PerPage
+        $this.ClientID = $Object.ClientID
+        $this.OwnerName = $Object.OwnerName
+        $this.OwnerType = $Object.OwnerType
+        $this.Permissions = $Object.Permissions
+        $this.Events = $Object.Events
     }
 }
diff --git a/src/classes/public/Context/GitHubContext/InstallationGitHubContext.ps1 b/src/classes/public/Context/GitHubContext/InstallationGitHubContext.ps1
@@ -4,10 +4,10 @@
 
     # The token expiration date.
     # 2024-01-01-00:00:00
-    [datetime] $TokenExpirationDate
+    [System.Nullable[datetime]] $TokenExpirationDate
 
     # The installation ID.
-    [uint64] $InstallationID
+    [System.Nullable[uint64]] $InstallationID
 
     # The permissions that the app is requesting on the target
     [pscustomobject] $Permissions
@@ -21,20 +21,33 @@
     # The target login or slug of the installation.
     [string] $InstallationName
 
-    # Simple parameterless constructor
     InstallationGitHubContext() {}
 
-    # Creates a context object from a hashtable of key-vaule pairs.
-    InstallationGitHubContext([hashtable]$Properties) {
-        foreach ($Property in $Properties.Keys) {
-            $this.$Property = $Properties.$Property
-        }
-    }
-
-    # Creates a context object from a PSCustomObject.
-    InstallationGitHubContext([PSCustomObject]$Object) {
-        $Object.PSObject.Properties | ForEach-Object {
-            $this.($_.Name) = $_.Value
-        }
+    InstallationGitHubContext([pscustomobject]$Object) {
+        $this.ID = $Object.ID
+        $this.Name = $Object.Name
+        $this.DisplayName = $Object.DisplayName
+        $this.Type = $Object.Type
+        $this.HostName = $Object.HostName
+        $this.ApiBaseUri = $Object.ApiBaseUri
+        $this.ApiVersion = $Object.ApiVersion
+        $this.AuthType = $Object.AuthType
+        $this.NodeID = $Object.NodeID
+        $this.DatabaseID = $Object.DatabaseID
+        $this.UserName = $Object.UserName
+        $this.Token = $Object.Token
+        $this.TokenType = $Object.TokenType
+        $this.Enterprise = $Object.Enterprise
+        $this.Owner = $Object.Owner
+        $this.Repository = $Object.Repository
+        $this.HttpVersion = $Object.HttpVersion
+        $this.PerPage = $Object.PerPage
+        $this.ClientID = $Object.ClientID
+        $this.TokenExpirationDate = $Object.TokenExpirationDate
+        $this.InstallationID = $Object.InstallationID
+        $this.Permissions = $Object.Permissions
+        $this.Events = $Object.Events
+        $this.InstallationType = $Object.InstallationType
+        $this.InstallationName = $Object.InstallationName
     }
 }
diff --git a/src/classes/public/Context/GitHubContext/UserGitHubContext.ps1 b/src/classes/public/Context/GitHubContext/UserGitHubContext.ps1
@@ -13,29 +13,41 @@
 
     # The token expiration date.
     # 2024-01-01-00:00:00
-    [datetime] $TokenExpirationDate
+    [System.Nullable[datetime]] $TokenExpirationDate
 
     # The refresh token.
     [securestring] $RefreshToken
 
     # The refresh token expiration date.
     # 2024-01-01-00:00:00
-    [datetime] $RefreshTokenExpirationDate
+    [System.Nullable[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) {
-            $this.$Property = $Properties.$Property
-        }
-    }
-
-    # Creates a context object from a PSCustomObject.
     UserGitHubContext([PSCustomObject]$Object) {
-        $Object.PSObject.Properties | ForEach-Object {
-            $this.($_.Name) = $_.Value
-        }
+        $this.ID = $Object.ID
+        $this.Name = $Object.Name
+        $this.DisplayName = $Object.DisplayName
+        $this.Type = $Object.Type
+        $this.HostName = $Object.HostName
+        $this.ApiBaseUri = $Object.ApiBaseUri
+        $this.ApiVersion = $Object.ApiVersion
+        $this.AuthType = $Object.AuthType
+        $this.NodeID = $Object.NodeID
+        $this.DatabaseID = $Object.DatabaseID
+        $this.UserName = $Object.UserName
+        $this.Token = $Object.Token
+        $this.TokenType = $Object.TokenType
+        $this.Enterprise = $Object.Enterprise
+        $this.Owner = $Object.Owner
+        $this.Repository = $Object.Repository
+        $this.HttpVersion = $Object.HttpVersion
+        $this.PerPage = $Object.PerPage
+        $this.AuthClientID = $Object.AuthClientID
+        $this.DeviceFlowType = $Object.DeviceFlowType
+        $this.Scope = $Object.Scope
+        $this.TokenExpirationDate = $Object.TokenExpirationDate
+        $this.RefreshToken = $Object.RefreshToken
+        $this.RefreshTokenExpirationDate = $Object.RefreshTokenExpirationDate
     }
 }
diff --git a/src/formats/GitHubContext.Format.ps1xml b/src/formats/GitHubContext.Format.ps1xml
@@ -26,6 +26,9 @@
                     <TableColumnHeader>
                         <Label>TokenExpirationDate</Label>
                     </TableColumnHeader>
+                    <TableColumnHeader>
+                        <Label>Remaining</Label>
+                    </TableColumnHeader>
                 </TableHeaders>
                 <TableRowEntries>
                     <TableRowEntry>
@@ -49,6 +52,51 @@
                             <TableColumnItem>
                                 <PropertyName>TokenExpirationDate</PropertyName>
                             </TableColumnItem>
+                            <TableColumnItem>
+                                <ScriptBlock>
+                                    if ($null -eq $_.Remaining) {
+                                    return
+                                    }
+
+                                    if ($_.Remaining -lt 0) {
+                                    $text = "Expired"
+                                    } else {
+                                    $text = "$($_.Remaining.Hours)h $($_.Remaining.Minutes)m $($_.Remaining.Seconds)s"
+                                    }
+
+                                    if ($Host.UI.SupportsVirtualTerminal -and
+                                    ($env:GITHUB_ACTIONS -ne 'true')) {
+                                    switch ($_.AuthType) {
+                                    'UAT' {
+                                    $MaxValue = [TimeSpan]::FromHours(8)
+                                    }
+                                    'IAT' {
+                                    $MaxValue = [TimeSpan]::FromHours(1)
+                                    }
+                                    }
+                                    $ratio = [Math]::Min(($_.Remaining / $MaxValue), 1)
+
+                                    if ($ratio -ge 1) {
+                                    $r = 0
+                                    $g = 255
+                                    } elseif ($ratio -le 0) {
+                                    $r = 255
+                                    $g = 0
+                                    } elseif ($ratio -ge 0.5) {
+                                    $r = [Math]::Round(255 * (2 - 2 * $ratio))
+                                    $g = 255
+                                    } else {
+                                    $r = 255
+                                    $g = [Math]::Round(255 * (2 * $ratio))
+                                    }
+                                    $b = 0
+                                    $color = $PSStyle.Foreground.FromRgb($r, $g, $b)
+                                    "$color$text$($PSStyle.Reset)"
+                                    } else {
+                                    $text
+                                    }
+                                </ScriptBlock>
+                            </TableColumnItem>
                         </TableColumnItems>
                     </TableRowEntry>
                 </TableRowEntries>
diff --git a/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 b/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1
@@ -45,10 +45,12 @@
         Write-Verbose "Anonymous: [$Anonymous]"
         if ($Anonymous -or $Context -eq 'Anonymous') {
             Write-Verbose 'Returning Anonymous context.'
-            return [GitHubContext]@{
-                Name     = 'Anonymous'
-                AuthType = 'Anonymous'
-            }
+            return [GitHubContext]::new(
+                [pscustomobject]@{
+                    Name     = 'Anonymous'
+                    AuthType = 'Anonymous'
+                }
+            )
         }
 
         if ($Context -is [string]) {
diff --git a/src/functions/public/Auth/Context/Get-GitHubContext.ps1 b/src/functions/public/Auth/Context/Get-GitHubContext.ps1
@@ -73,13 +73,13 @@
             Write-Verbose "Converting to: [$($contextObj.Type)GitHubContext]"
             switch ($contextObj.Type) {
                 'User' {
-                    [UserGitHubContext]::new($contextObj)
+                    [UserGitHubContext]::new([pscustomobject]$contextObj)
                 }
                 'App' {
-                    [AppGitHubContext]::new($contextObj)
+                    [AppGitHubContext]::new([pscustomobject]$contextObj)
                 }
                 'Installation' {
-                    [InstallationGitHubContext]::new($contextObj)
+                    [InstallationGitHubContext]::new([pscustomobject]$contextObj)
                 }
                 default {
                     throw "Unknown context type: [$($contextObj.Type)]"
diff --git a/src/types/GitHubContext.Types.ps1xml b/src/types/GitHubContext.Types.ps1xml
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Types>
+    <Type>
+        <Name>UserGitHubContext</Name>
+        <Members>
+            <ScriptProperty>
+                <Name>Remaining</Name>
+                <GetScriptBlock>
+                    if ($null -eq $this.TokenExpirationDate) { return }
+                    New-TimeSpan -Start (Get-Date) -End $this.TokenExpirationDate
+                </GetScriptBlock>
+            </ScriptProperty>
+        </Members>
+    </Type>
+    <Type>
+        <Name>InstallationGitHubContext</Name>
+        <Members>
+            <ScriptProperty>
+                <Name>Remaining</Name>
+                <GetScriptBlock>
+                    if ($null -eq $this.TokenExpirationDate) { return }
+                    New-TimeSpan -Start (Get-Date) -End $this.TokenExpirationDate
+                </GetScriptBlock>
+            </ScriptProperty>
+        </Members>
+    </Type>
+</Types>

Original file line number	Diff line number	Diff line change
`@@ -73,13 +73,13 @@`
`73`	`73`	`Write-Verbose "Converting to: [$($contextObj.Type)GitHubContext]"`
`74`	`74`	`switch ($contextObj.Type) {`
`75`	`75`	`'User' {`
`76`		`- [UserGitHubContext]::new($contextObj)`
	`76`	`+ [UserGitHubContext]::new([pscustomobject]$contextObj)`
`77`	`77`	`}`
`78`	`78`	`'App' {`
`79`		`- [AppGitHubContext]::new($contextObj)`
	`79`	`+ [AppGitHubContext]::new([pscustomobject]$contextObj)`
`80`	`80`	`}`
`81`	`81`	`'Installation' {`
`82`		`- [InstallationGitHubContext]::new($contextObj)`
	`82`	`+ [InstallationGitHubContext]::new([pscustomobject]$contextObj)`
`83`	`83`	`}`
`84`	`84`	`default {`
`85`	`85`	`throw "Unknown context type: [$($contextObj.Type)]"`