private/Test-TokenExpired.ps1
|
<#
.SYNOPSIS Checks if the Fabric token is expired and logs appropriate messages. .DESCRIPTION The `Test-TokenExpired` function checks the expiration status of the Fabric token stored in the `$FabricConfig.TokenExpiresOn` variable. If the token is expired, it logs an error message and provides guidance for refreshing the token. Otherwise, it logs that the token is still valid. .PARAMETER FabricConfig The configuration object containing the token expiration details. .EXAMPLE Test-TokenExpired -FabricConfig $config Checks the token expiration status using the provided `$config` object. .NOTES - Ensure the `FabricConfig` object includes a valid `TokenExpiresOn` property of type `DateTimeOffset`. - Requires the `Write-Message` function for logging. .AUTHOR Tiago Balabuch #> function Test-TokenExpired { [CmdletBinding()] param () Confirm-FabricAuthToken | Out-Null Write-Message -Message "Validating token..." -Level Debug try { # Ensure required properties have valid values if ([string]::IsNullOrWhiteSpace($FabricConfig.TenantIdGlobal) -or [string]::IsNullOrWhiteSpace($FabricConfig.TokenExpiresOn)) { Write-Message -Message "Token details are missing. Please run 'Set-FabricApiHeaders' to configure them." -Level Error throw "MissingTokenDetailsException: Token details are missing." } # Convert the TokenExpiresOn value to a DateTime object if ($FabricConfig.TokenExpiresOn.GetType() -eq [datetimeoffset]) { $tokenExpiryDate = $FabricConfig.TokenExpiresOn } else { $tokenExpiryDate = [datetimeoffset]::Parse($FabricConfig.TokenExpiresOn) } # Check if the token is expired if ($tokenExpiryDate -le [datetimeoffset]::Now) { Write-Message -Message "Your authentication token has expired. Please sign in again to refresh your session." -Level Warning #throw "TokenExpiredException: Token has expired." #Set-FabricApiHeaders -tenantId $FabricConfig.TenantIdGlobal } # Log valid token status Write-Message -Message "Token is still valid. Expiry time: $($tokenExpiryDate.ToString("u"))" -Level Debug } catch [System.FormatException] { Write-Message -Message "Invalid 'TokenExpiresOn' format in the FabricConfig object. Ensure it is a valid datetime string." -Level Error throw "FormatException: Invalid TokenExpiresOn value." } catch { # Log unexpected errors with details Write-Message -Message "An unexpected error occurred: $_" -Level Error throw $_ } Write-Message -Message "Token validation completed." -Level Debug } |