Adding initialization logic

Author: Friedrich Weinmann

PSFramework/internal/scripts/environment.ps1

@@ -87,4 +87,7 @@ if (($PSVersionTable.PSVersion.Major -ge 6) -and ($PSVersionTable.OS -notlike "*
 
 if (-not ([PSFramework.Message.LogHost]::LoggingPath)) { [PSFramework.Message.LogHost]::LoggingPath = $script:path_Logging }
 
-[PSFramework.PSFCore.PSFCoreHost]::ModuleRoot = $script:ModuleRoot
+[PSFramework.PSFCore.PSFCoreHost]::ModuleRoot = $script:ModuleRoot
+# Run the library initialization logic
+# Needed before the configuration system loads
+[PSFramework.PSFCore.PSFCoreHost]::Initialize()

PSFramework/internal/scripts/removalEvent.ps1

@@ -4,6 +4,7 @@ $PSF_OnRemoveScript = {
 	if ([runspace]::DefaultRunspace.Id -eq 1)
 	{
 		Get-PSFRunspace | Stop-PSFRunspace
+		[PSFramework.PSFCore.PSFCoreHost]::Uninitialize()
 	}
 
 	# Properly disconnect all remote sessions still held open

PSFramework/internal/tepp/scripts/input.ps1

@@ -19,14 +19,17 @@
 		if ($pipelineAst.PipelineElements[$inputIndex].CommandElements)
 		{
 			# Resolve command and fail if it breaks
-			$command = Get-Command $pipelineAst.PipelineElements[$inputIndex].CommandElements[0].Value -ErrorAction Ignore
+			$commandString = $pipelineAst.PipelineElements[$inputIndex].CommandElements[0].Value
+			if ($commandString -eq "?") { $commandString = (Get-Alias -Name "?").ResolvedCommand.Name }
+			$command = Get-Command $commandString -ErrorAction Ignore
 			if ($command -is [System.Management.Automation.AliasInfo]) { $command = $command.ResolvedCommand }
 			if (-not $command) { break }
 
 			switch ($command.Name)
 			{
 				'Where-Object' { $inputIndex = $inputIndex - 1; continue main }
 				'Tee-Object' { $inputIndex = $inputIndex - 1; continue main }
+				'Sort-Object' { $inputIndex = $inputIndex - 1; continue main }
 				#region Select-Object
 				'Select-Object'
 				{

library/PSFramework/PSFCore/PSFCoreHost.cs

@@ -29,5 +29,33 @@ public static string ModuleRoot
             }
         }
         private static string _ModuleRoot;
+
+        /// <summary>
+        /// Initializes the PSFramework library.
+        /// Required for some components to work correctly.
+        /// </summary>
+        public static void Initialize()
+        {
+            if (_Initialized)
+                return;
+            _Initialized = true;
+
+            // Initialization logic goes here
+        }
+        private static bool _Initialized = false;
+
+        /// <summary>
+        /// Reverses the initialization of the PSFramework library.
+        /// Should be called when destroying the main runspace
+        /// </summary>
+        public static void Uninitialize()
+        {
+            if (!_Initialized)
+                return;
+
+            // De-Initiialization logic goes here
+
+            _Initialized = false;
+        }
     }
 }

library/PSFramework/Runspace/RunspaceBoundValue.cs

@@ -1,4 +1,5 @@
-using System;
+using PSFramework.Utility;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Management.Automation.Runspaces;
@@ -10,7 +11,7 @@ namespace PSFramework.Runspace
     /// <summary>
     /// Wrapper class that offers the tools to make Values runspace specific
     /// </summary>
-    public class RunspaceBoundValue
+    public class RunspaceBoundValue : IDisposable
     {
         /// <summary>
         /// Whether the defautl value should be offered when asking from a runspace without custom settings
@@ -49,9 +50,63 @@ public object Value
             }
         }
 
+        /// <summary>
+        /// Removes all value entries whose corresponding Runspace has been destroyed
+        /// </summary>
         public void PurgeExpired()
         {
-            System.Management.Automation.Runspaces.Runspace.GetRunspaces(null);
+            // Store IDs first, so parallel access is not an issue and a new value gets accidentally discarded
+            Guid[] IDs = Values.Keys.ToArray();
+            ICollection<System.Management.Automation.Runspaces.Runspace> runspaces = UtilityHost.GetRunspaces();
+            ICollection<Guid> runspaceIDs = (ICollection<Guid>)runspaces.Select(o => o.InstanceId);
+
+            foreach (Guid ID in IDs)
+                if (!runspaceIDs.Contains(ID))
+                    Values.Remove(ID);
+        }
+
+        /// <summary>
+        /// Destruction logic, eliminating all data stored in the object.
+        /// Since handles to this object are automatically stored and maintained, it is impossible to otherwise guarantee releasing the object's data for the GC.
+        /// </summary>
+        public void Dispose()
+        {
+            Values = new Dictionary<Guid, object>();
+            DefaultValue = null;
+            RunspaceHost._RunspaceBoundValues.Remove(this);
+        }
+
+        /// <summary>
+        /// Create an empty runspace bound value object
+        /// </summary>
+        public RunspaceBoundValue()
+            : this(null, true)
+        {
+
+        }
+
+        /// <summary>
+        /// Create a runspace bound value object with its initial value
+        /// </summary>
+        /// <param name="Value">The object to set as the initial value</param>
+        public RunspaceBoundValue(object Value)
+            : this(Value, true)
+        {
+
+        }
+
+        /// <summary>
+        /// Create a runspace bound value object with its initial value
+        /// </summary>
+        /// <param name="Value">The object to set as the initial value</param>
+        /// <param name="OfferDefaultValue">Whether the initial / default value should be offered when accessed from runspaces that do not have a runspace-local value</param>
+        public RunspaceBoundValue(object Value, bool OfferDefaultValue)
+        {
+            this.Value = Value;
+            this.OfferDefaultValue = OfferDefaultValue;
+
+            // Add to central list of runspacebound values
+            RunspaceHost._RunspaceBoundValues.Add(this);
         }
     }
 }

library/PSFramework/Runspace/RunspaceHost.cs

@@ -16,5 +16,10 @@ public static class RunspaceHost
         /// The dictionary containing the definitive list of unique Runspace
         /// </summary>
         public static Dictionary<string, RunspaceContainer> Runspaces = new Dictionary<string, RunspaceContainer>();
+
+        /// <summary>
+        /// List of all runspace bound values in use
+        /// </summary>
+        internal static List<RunspaceBoundValue> _RunspaceBoundValues = new List<RunspaceBoundValue>();
     }
 }

library/PSFramework/Utility/UtilityHost.cs

@@ -235,6 +235,17 @@ public static object GetExecutionContextFromTLS()
             return method.Invoke(null, BindingFlags.NonPublic | BindingFlags.Static, null, null, System.Globalization.CultureInfo.CurrentCulture);
         }
 
+        /// <summary>
+        /// Returns the list of runspaces available in the process
+        /// </summary>
+        /// <returns>The lists of currently known runspaces</returns>
+        public static ICollection<System.Management.Automation.Runspaces.Runspace> GetRunspaces()
+        {
+            Type runspaceType = typeof(System.Management.Automation.Runspaces.Runspace);
+            MethodInfo method = runspaceType.GetMethod("get_RunspaceList", BindingFlags.Static | BindingFlags.NonPublic);
+            return (ICollection < System.Management.Automation.Runspaces.Runspace > )method.Invoke(null, null);
+        }
+
         /// <summary>
         /// Removes an alias from the global list of aliases
         /// </summary>