| | | 1 | | <# |
| | | 2 | | .SYNOPSIS |
| | | 3 | | Enables Kestrun server configuration and starts the server. |
| | | 4 | | .DESCRIPTION |
| | | 5 | | This function applies the configuration to the Kestrun server and starts it. |
| | | 6 | | .PARAMETER Server |
| | | 7 | | The Kestrun server instance to configure and start. This parameter is mandatory. |
| | | 8 | | .PARAMETER ExcludeVariables |
| | | 9 | | An array of variable names to exclude from the runspaces. |
| | | 10 | | .PARAMETER ExcludeFunctions |
| | | 11 | | An array of function name patterns to exclude from the runspaces. |
| | | 12 | | .PARAMETER Quiet |
| | | 13 | | If specified, suppresses output messages during the configuration and startup process. |
| | | 14 | | .PARAMETER PassThru |
| | | 15 | | If specified, the cmdlet will return the modified server instance after applying the configuration. |
| | | 16 | | .EXAMPLE |
| | | 17 | | Enable-KrConfiguration -Server $server |
| | | 18 | | Applies the configuration to the specified Kestrun server instance and starts it. |
| | | 19 | | .NOTES |
| | | 20 | | This function is designed to be used after the server has been configured with routes, listeners, |
| | | 21 | | and other middleware components. |
| | | 22 | | #> |
| | | 23 | | function Enable-KrConfiguration { |
| | | 24 | | [KestrunRuntimeApi('Definition')] |
| | | 25 | | [CmdletBinding()] |
| | | 26 | | [OutputType([Kestrun.Hosting.KestrunHost])] |
| | | 27 | | [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '')] |
| | | 28 | | param( |
| | | 29 | | [Parameter(Mandatory = $false, ValueFromPipeline = $true)] |
| | | 30 | | [Kestrun.Hosting.KestrunHost]$Server, |
| | | 31 | | [Parameter()] |
| | | 32 | | [string[]]$ExcludeVariables, |
| | | 33 | | [Parameter()] |
| | | 34 | | [string[]]$ExcludeFunctions, |
| | | 35 | | [Parameter()] |
| | | 36 | | [switch]$Quiet, |
| | | 37 | | [Parameter()] |
| | | 38 | | [switch]$PassThru |
| | | 39 | | ) |
| | | 40 | | begin { |
| | | 41 | | # Ensure the server instance is resolved |
| | 0 | 42 | | $Server = Resolve-KestrunServer -Server $Server |
| | | 43 | | } |
| | | 44 | | process { |
| | | 45 | | # Collect assigned variables from the parent scope, resolving their values |
| | 0 | 46 | | $variables = Get-KrAssignedVariable -FromParent -ResolveValues -IncludeSetVariable -ExcludeVariables $ExcludeVar |
| | | 47 | | |
| | 0 | 48 | | Write-KrLog -Level Debug -Logger $Server.Logger -Message 'Collected {VarCount} user-defined variables for server |
| | | 49 | | |
| | | 50 | | # AUTO: determine caller script path to filter session-defined functions |
| | 0 | 51 | | $callerPath = [Kestrun.KestrunHostManager]::EntryScriptPath |
| | 0 | 52 | | if ([string]::IsNullOrEmpty($callerPath)) { |
| | 0 | 53 | | throw 'KestrunHostManager is not properly initialized. EntryScriptPath is not set.' |
| | | 54 | | } |
| | | 55 | | # AUTO: collect session-defined functions present now |
| | 0 | 56 | | $fx = @( Get-Command -CommandType Function | Where-Object { -not $_.Module } ) |
| | | 57 | | |
| | 0 | 58 | | if ($callerPath) { |
| | 0 | 59 | | $fx = $fx | Where-Object { |
| | 0 | 60 | | $_.ScriptBlock.File -and |
| | 0 | 61 | | ((Resolve-Path -LiteralPath $_.ScriptBlock.File -ErrorAction SilentlyContinue)?.ProviderPath) -eq $calle |
| | | 62 | | } |
| | 0 | 63 | | $fx = @($fx) # normalize again |
| | | 64 | | } |
| | | 65 | | |
| | | 66 | | # Exclude functions by name patterns if specified |
| | 0 | 67 | | if ($ExcludeFunctions) { |
| | 0 | 68 | | $fx = $fx | Where-Object { |
| | 0 | 69 | | $n = $_.Name |
| | 0 | 70 | | -not ($ExcludeFunctions | Where-Object { $n -like $_ }).Count |
| | | 71 | | } |
| | 0 | 72 | | $fx = @($fx) # normalize again |
| | | 73 | | } |
| | | 74 | | |
| | | 75 | | # Create a dictionary of function names to their definitions |
| | | 76 | | # NOTE: exclude OpenAPI metadata functions (OpenApiPath/OpenApiWebhook/OpenApiCallback) |
| | | 77 | | # from the general function map; they are handled separately. |
| | 0 | 78 | | $fxMap = $null |
| | 0 | 79 | | if ($fx -and $fx.Count -gt 0) { |
| | 0 | 80 | | $fxUser = @($fx | Where-Object { -not (Test-KrFunctionHasAttribute -Command $_ -AttributeNameRegex 'OpenApi( |
| | 0 | 81 | | $fxMap = [System.Collections.Generic.Dictionary[string, string]]::new([System.StringComparer]::OrdinalIgnore |
| | 0 | 82 | | foreach ($f in $fxUser) { $fxMap[$f.Name] = $f.Definition } |
| | | 83 | | } |
| | | 84 | | |
| | | 85 | | # Create a dictionary of OpenAPI callback function names to their definitions |
| | 0 | 86 | | $fxCallBack = $null |
| | 0 | 87 | | if ($fx -and $fx.Count -gt 0) { |
| | 0 | 88 | | $cb = @($fx | Where-Object { Test-KrFunctionHasAttribute -Command $_ -AttributeNameRegex 'OpenApiCallback' } |
| | 0 | 89 | | if ($cb -and $cb.Count -gt 0) { |
| | 0 | 90 | | $fxCallBack = [System.Collections.Generic.Dictionary[string, string]]::new([System.StringComparer]::Ordi |
| | 0 | 91 | | foreach ($f in $cb) { $fxCallBack[$f.Name] = $f.Definition } |
| | | 92 | | } |
| | | 93 | | } |
| | | 94 | | |
| | 0 | 95 | | if ($Server.Logger -and $Server.Logger.IsEnabled([Serilog.Events.LogEventLevel]::Debug)) { |
| | 0 | 96 | | $callbackNames = @() |
| | 0 | 97 | | if ($fxCallBack) { |
| | 0 | 98 | | $callbackNames = @($fxCallBack.Keys) |
| | 0 | 99 | | [System.Array]::Sort($callbackNames, [System.StringComparer]::OrdinalIgnoreCase) |
| | | 100 | | } |
| | 0 | 101 | | Write-KrLog -Level Debug -Logger $Server.Logger -Message 'Detected {CallbackCount} OpenAPI callback function |
| | | 102 | | } |
| | | 103 | | |
| | 0 | 104 | | Write-KrLog -Level Debug -Logger $Server.Logger -Message 'Enabling Kestrun server configuration with {VarCount} |
| | | 105 | | # Apply the configuration to the server |
| | | 106 | | # Set the user-defined variables in the server configuration |
| | 0 | 107 | | $Server.EnableConfiguration($variables, $fxMap, $fxCallBack) | Out-Null |
| | | 108 | | |
| | 0 | 109 | | Write-KrLog -Level Information -Logger $Server.Logger -Message 'Kestrun server configuration enabled successfull |
| | | 110 | | |
| | 0 | 111 | | if (-not $Quiet.IsPresent) { |
| | 0 | 112 | | Write-Host 'Kestrun server configuration enabled successfully.' |
| | 0 | 113 | | Write-Host "Server Name: $($Server.Options.ApplicationName)" |
| | | 114 | | } |
| | | 115 | | |
| | 0 | 116 | | if ($PassThru.IsPresent) { |
| | | 117 | | # if the PassThru switch is specified, return the modified server instance |
| | 0 | 118 | | return $Server |
| | | 119 | | } |
| | | 120 | | } |
| | | 121 | | } |