Merge pull request #727 from PowershellFrameworkCollective/caching

1.14.438

Author: FriedrichWeinmann

PSFramework/PSFramework.psd1

@@ -4,7 +4,7 @@
 	RootModule = 'PSFramework.psm1'
 
 	# Version number of this module.
-	ModuleVersion = '1.13.426'
+	ModuleVersion = '1.14.438'
 
 	# ID used to uniquely identify this module
 	GUID = '8028b914-132b-431f-baa9-94a6952f21ff'
@@ -98,6 +98,7 @@
 		'Invoke-PSFFilter'
 		'Invoke-PSFRunspace'
 		'Join-PSFPath'
+		'New-PSFCache'
 		'New-PSFFilter'
 		'New-PSFFilterCondition'
 		'New-PSFFilterConditionSet'

PSFramework/bin/PSFramework.dll

@@ -11,7 +11,10 @@ catch {
     throw
 }
 try {
+	$lock = [PSFramework.Runspace.RunspaceHost]::GetRunspaceLock('PSFramework.Types')
+	$lock.Open()
     Update-TypeData -AppendPath "$script:ModuleRoot\xml\PSFramework.Types.ps1xml" -ErrorAction Stop
+	$lock.Close()
 }
 catch {
     Write-Warning "Failed to load PSFramework type extensions! Unable to import module."

PSFramework/bin/PSFramework.pdb

@@ -1,5 +1,20 @@
 # CHANGELOG
 
+## 1.14.438 (2026-05-31)
+
+- New: New-PSFCache - creates a configurable in-memory cache.
+- New: Config validation urihttp - Validates http uris (#719)
+- Ipd: Disable-PSFLoggingProvider - now accepts input from pipeline from Get-PSFLoggingProviderInstance
+- Upd: PSFDateTime - Now tracking what time the object was created at (`InstantiationTime`)
+- Upd: PSFDateTime - Now tracking the resolved relative time provided (`Delta`)
+- Upd: PSFDateTime - new method `Reverse()` to reverse relative time between positive and negative.
+- Upd: PSFDateTime - new method `Past()` to make sure relative-provided time points to the past
+- Upd: PSFDateTime - new method `Future()` to make sure relative-provided time points to the future
+- Fix: Write-PSFHostColor - Fails when trying to colorize special regex characters (#721)
+- Fix: Error loading PSFramework concurrently
+- Fix: Config Validation uriabsolute - accepts hostless stump (#719)
+- Fix: Disable-PSFConsoleInterrupt - fails in contexts that do not have a console window handle such as remoting. (#724, @Mr-Kappelmann)
+
 ## 1.13.426 (2026-01-13)
 
 - Fix: Write-PSFHostColor - Ignores the `-NoNewLine` parameter

PSFramework/bin/PSFramework.xml

@@ -0,0 +1,72 @@
+function New-PSFCache {
+	<#
+	.SYNOPSIS
+		Create a new Cache object.
+	
+	.DESCRIPTION
+		Create a new Cache object.
+	
+	.PARAMETER MaxItems
+		The maximum number of items allowed in the cache.
+	
+	.PARAMETER Lifetime
+		The maximum age for values in the cache.
+	
+	.PARAMETER TryDispose
+		When expiring values from the cache, should we try to explicitly dispose them?
+	
+	.PARAMETER Collector
+		When asking for a value that hasn't been cached yet, retrieve the value using this logic.
+		Note: If this script fails, the retrieval errors.
+	
+	.PARAMETER CollectNull
+		When executing the collector scriptblock, should we consider an empty / null return valid and cache it?
+		This prevents repeated requests to the same key triggering the Collector script, which may save time.
+		It also prevents it from noticing if something changed.
+	
+	.EXAMPLE
+		PS C:\> New-PSFCache -MaxItems 50000
+
+		Creates a cache that will retain the last 50000 items.
+
+	.EXAMPLE
+		PS C:\> New-PSFCache -Lifetime 30m
+
+		Creates a cache that will retain values for 30 minutes.
+
+	.EXAMPLE
+		PS C:\> New-PSFCache -MaxItems 50000 -Collector { Get-ADGroup -Identity $_ }
+
+		Creates a cache that will retain the last 50000 items, looking up Active Directory groups when asked for an entry it doesn't know yet.
+	#>
+	[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
+	[OutputType([PSFramework.Caching.CacheMemoryConcurrent])]
+	[CmdletBinding()]
+	param (
+		[long]
+		$MaxItems,
+
+		[PsfTimeSpan]
+		$Lifetime,
+
+		[switch]
+		$TryDispose,
+
+		[PsfScriptBlock]
+		$Collector,
+
+		[switch]
+		$CollectNull
+	)
+	process {
+		$cache = [PSFramework.Caching.CacheMemoryConcurrent]::new()
+
+		if ($MaxItems) { $cache.SetMaxItems($MaxItems) }
+		if ($Lifetime) { $cache.SetLifetime($Lifetime) }
+		if ($TryDispose) { $cache.SetTryDispose($TryDispose) }
+		if ($Collector) { $cache.SetCollector($Collector) }
+		if ($CollectNull) { $cache.SetCacheNull($CollectNull) }
+
+		$cache
+	}
+}

PSFramework/bin/assembly.ps1

@@ -16,6 +16,9 @@
 	.PARAMETER InstanceName
 		Name of the instance of the logging provider to disable.
 		Defaults to: Default
+
+	.PARAMETER InstanceObject
+		A full Logging Provider Instance object, as return by Get-PSFLoggingProviderInstance
 	
 	.PARAMETER NoFinalizeWait
 		Do not wait for the logging to conclude or the final events shutting down the provider instance to finish.
@@ -43,34 +46,59 @@
 
 		Disables the "mytask" instance of the logfile provider, then waits until all applicable logs are processed
 		but not for the logfile to be released (which will happen soon after, in most cases).
+
+	.EXAMPLE
+		PS C:\> Get-PSFLoggingProviderInstance | Disable-PSFLoggingProvider
+
+		Disables all active logging provider instacnes
 	#>
-	[CmdletBinding()]
+	[CmdletBinding(DefaultParameterSetName = 'ByName')]
 	param (
-		[Parameter(Mandatory = $true)]
+		[Parameter(Mandatory = $true, ParameterSetName = 'ByName')]
 		[PsfArgumentCompleter('PSFramework-logging-provider')]
 		[ValidateNotNullOrEmpty()]
 		[Alias('Provider', 'ProviderName')]
 		[string]
 		$Name,
 
+		[Parameter(ParameterSetName = 'ByName')]
 		[PsfArgumentCompleter('PSFramework-logging-instance-name2')]
 		[string]
 		$InstanceName = 'Default',
 
+		[Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = 'ByObject')]
+		[PSFramework.Logging.ProviderInstance[]]
+		$InstanceObject,
+
 		[switch]
 		$NoFinalizeWait
 	)
 
-	process {
+	begin {
+		$inInstances = [System.Collections.ArrayList]@()
 		$limit = Get-Date
-		$instances = Get-PSFLoggingProviderInstance -ProviderName $Name -Name $InstanceName
-
-		foreach ($instance in $instances) {
-			$instance.NotAfter = $limit
+	}
+	process {
+		if ($Name) {
+			$instances = Get-PSFLoggingProviderInstance -ProviderName $Name -Name $InstanceName
+			
+			foreach ($instance in $instances) {
+				$instance.NotAfter = $limit
+			}
+			
+			foreach ($instance in $instances) {
+				$instance.Drain((-not $NoFinalizeWait))
+			}
 		}
 
-		foreach ($instance in $instances) {
-			$instance.Drain((-not $NoFinalizeWait))
+		foreach ($instance in $InstanceObject) {
+			$instance.NotAfter = $limit
+			$null = $inInstances.Add($instance)
 		}
 	}
+	end {
+		foreach ($instance in $inInstances) {
+				$instance.Drain((-not $NoFinalizeWait))
+			}
+	}
 }

PSFramework/changelog.md

@@ -126,7 +126,7 @@
 				$match = ($row | Select-String '<c=["''](.*?)["'']>(.*?)</c>' -AllMatches).Matches
 				if ($useAnsi) {
 					foreach ($entry in $match) {
-						$row = $row -replace $entry.Groups[0].Value, "$($escape)$($colorMap[$entry.Groups[1].Value])m$($entry.Groups[2].Value)$($escape)$($defaultCode)m"
+						$row = $row -replace ([regex]::Escape($entry.Groups[0].Value)), "$($escape)$($colorMap[$entry.Groups[1].Value])m$($entry.Groups[2].Value)$($escape)$($defaultCode)m"
 					}
 					Microsoft.PowerShell.Utility\Write-Host -Object $row -ForegroundColor $DefaultColor -NoNewline:$NoNewLine
 					continue

PSFramework/functions/Caching/New-PSFCache.ps1

@@ -72,7 +72,7 @@
 
 		[Parameter(Mandatory = $true, ParameterSetName = 'Value')]
 		[AllowNull()]
-		$Value = $null,
+		$Value,
 
 		[Parameter(Mandatory = $true, ParameterSetName = 'Queue')]
 		[switch]