Public/Start-RSJob.ps1

Function Start-RSJob {
    <#
        .SYNOPSIS
            Starts a background job using runspaces.
 
        .DESCRIPTION
            This will run a command in the background, leaving your console available to perform other tasks. This uses
            runspaces in runspacepools which allows for throttling of running jobs. As the jobs are finished, they will automatically
            dispose of each runspace and allow other runspace jobs in queue to begin based on the throttling of the runspacepool.
 
            This is available on PowerShell V3 and above. By doing this, you can use the $Using: variable to take variables
            in the local scope and apply those directly into the scriptblock of the background runspace job.
 
        .PARAMETER ScriptBlock
            The scriptblock that holds all of the commands which will be run in the background runspace. You must specify
            at least one Parameter in the Param() to account for the item that is being piped into Start-Job.
 
        .PARAMETER FilePath
            This is the path to a file containing code that will be run in the background runspace job.
 
        .PARAMETER InputObject
            The object being piped into Start-RSJob or applied via the parameter.
 
        .PARAMETER Name
            The name of a background runspace job
 
        .PARAMETER Batch
            Name of the batch of RSJobs that will be run
 
        .PARAMETER ArgumentList
            List of values that will be applied at the end of the argument list in the Param() statement.
 
        .PARAMETER Throttle
            Number of concurrent running runspace jobs which are allowed at a time.
 
        .PARAMETER ModulesToImport
            A collection of modules that will be imported into the background runspace job.
 
        .PARAMETER PSSnapinsToImport
            A collection of PSSnapins that will be imported into the background runspace job.
 
        .PARAMETER FunctionsToImport
            A collection of functions that will be imported for use with a background runspace job.
 
        .NOTES
            Name: Start-RSJob
            Author: Boe Prox
 
        .EXAMPLE
            Get-ChildItem -Directory | Start-RSjob -Name {$_.Name} -ScriptBlock {
                Param($Directory)
                Write-Verbose $_
                $Sum = (Get-ChildItem $Directory.FullName -Recurse -Force -ErrorAction SilentlyContinue |
                Measure-Object -Property Length -Sum).Sum
                [pscustomobject]@{
                    Name = $Directory.Name
                    SizeMB = ([math]::round(($Sum/1MB),2))
                }
            }
             
            Id Name State HasMoreData HasErrors Command
            -- ---- ----- ----------- --------- -------
            13 Contacts Running False False ...
            14 Desktop Running False False ...
            15 Documents Running False False ...
            16 Downloads Running False False ...
            17 Favorites Running False False ...
            18 Links Running False False ...
            19 Music Running False False ...
            20 OneDrive Running False False ...
            21 Pictures Running False False ...
            22 Saved Games Running False False ...
            23 Searches Running False False ...
            24 Videos Running False False ...
 
            Get-RSJob | Receive-RSJob
 
            Name SizeMB
            ---- ------
            Contacts 0
            Desktop 7.24
            Documents 83.99
            Downloads 10259.6
            Favorites 0
            Links 0
            Music 16691.89
            OneDrive 1485.24
            Pictures 1734.91
            Saved Games 0
            Searches 0
            Videos 17.19
 
            Description
            -----------
            Starts a background runspace job that looks at the total size of each folder. Using Get-RSJob | Recieve-RSJob shows
            the results when the State is Completed.
 
        .EXAMPLE
            $Test = 'test'
            $Something = 1..10
            1..5|start-rsjob -Name {$_} -ScriptBlock {
                Param($Object) [pscustomobject]@{
                    Result=($Object*2)
                    Test=$Using:Test
                    Something=$Using:Something
                }
            }
 
            Id Name State HasMoreData HasErrors Command
            -- ---- ----- ----------- --------- -------
            76 1 Completed True False ...
            77 2 Running False False ...
            78 3 Running False False ...
            79 4 Completed False False ...
            80 5 Completed False False ...
             
            Get-RSjob | Receive-RSJob
 
            Result Test Something
            ------ ---- ---------
                 2 test {1, 2, 3, 4...}
                 4 test {1, 2, 3, 4...}
                 6 test {1, 2, 3, 4...}
                 8 test {1, 2, 3, 4...}
                10 test {1, 2, 3, 4...}
             
            Description
            -----------
            Shows an example of the $Using: variable being used in the scriptblock.
 
        .EXAMPLE
            $Test = 42
            $AnotherTest = 7
            $String = 'SomeString'
            $ProcName = 'powershell_ise'
            $ScriptBlock = {
                Param($y,$z)
                [pscustomobject] @{
                    Test = $y
                    Proc = (Get-Process -Name $Using:ProcName)
                    String = $Using:String
                    AnotherTest = ($z+$_)
                    PipedObject = $_
                }
            }
 
            1..5|Start-RSJob $ScriptBlock -ArgumentList $test, $anothertest
             
            Description
            -----------
            Shows an example of the $Using: variable being used in the scriptblock as well as $_ and multiple -ArgumentList parameters.
 
    #>

    [OutputType('PoshRS.PowerShell.RSJob')]
    [cmdletbinding(
        DefaultParameterSetName = 'ScriptBlock'
    )]
    Param (
        [parameter(Mandatory=$True,Position=0,ParameterSetName = 'ScriptBlock')]
        [ScriptBlock]$ScriptBlock,
        [parameter(Position=0,ParameterSetName = 'ScriptPath')]
        [string]$FilePath,
        [parameter(ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True)]
        [object]$InputObject,
        [parameter()]
        [object]$Name,
        [parameter()]
        [string]$Batch,
        [parameter()]
        $ArgumentList,
        [parameter()]
        [int]$Throttle = 5,
        [parameter()]
        [string[]]$ModulesToImport,
        [parameter()]
        [string[]]$PSSnapinsToImport,
        [parameter()]
        [string[]]$FunctionsToLoad
    )
    Begin {               
        If ($PSBoundParameters['Debug']) {
            $DebugPreference = 'Continue'
        } 
        Write-Debug "[BEGIN]"   
        If ($PSBoundParameters.ContainsKey('Verbose')) {
            Write-Verbose "Displaying PSBoundParameters"
            $PSBoundParameters.GetEnumerator() | ForEach {
                Write-Verbose $_
            }
        }
        If ($PSBoundParameters.ContainsKey('Name')) {
            If ($Name -isnot [scriptblock]) {
                $JobName = [scriptblock]::Create("Write-Output $Name")
            } 
            Else {
                $JobName = [scriptblock]::Create( ($Name -replace '\$_','$Item'))
            }
        } 
        Else {
            Write-Verbose "Creating default Job Name"
            $JobName = [scriptblock]::Create('Write-Output Job$($Id)')
        }              
        $InitialSessionState = [System.Management.Automation.Runspaces.InitialSessionState]::CreateDefault()
        If ($PSBoundParameters['ModulesToImport']) {
            [void]$InitialSessionState.ImportPSModule($ModulesToImport)
        }
        If ($PSBoundParameters['PSSnapinsToImport']) {
            ForEach ($PSSnapin in $PSSnapinsToImport) {
                [void]$InitialSessionState.ImportPSSnapIn($PSSnapin,[ref]$Null)
            }
        }
        If ($PSBoundParameters['FunctionsToLoad']) {
            Write-Verbose "Loading custom functions: $($FunctionsToLoad -join '; ')"
            ForEach ($Function in $FunctionsToLoad) {
                Try {
                    RegisterScriptScopeFunction -Name $Function
                    $Definition = Get-Content Function:\$Function -ErrorAction Stop
                    Write-Debug "Definition: $($Definition)"
                    $SessionStateFunction = New-Object System.Management.Automation.Runspaces.SessionStateFunctionEntry -ArgumentList $Function, $Definition
                    $InitialSessionState.Commands.Add($SessionStateFunction) 
                } 
                Catch {
                    Write-Warning "$($Function): $($_.Exception.Message)"
                }
            }           
        }
        If ($PSBoundParameters.ContainsKey('ArgumentList')) {
            If (@($ArgumentList).count -match '0|1') {
                $SingleArgument = $True
            } 
            Else {
                $SingleArgument = $False
            }
        }
        If ($PSBoundParameters['FilePath']) {
            $ScriptBlock = [scriptblock]::Create((Get-Content $FilePath | Out-String))
        }

        $Script:List = New-Object System.Collections.ArrayList
        If ($PSBoundParameters.ContainsKey('InputObject')) {            
            [void]$list.AddRange(@($InputObject))    
            $IsPipeline = $True
            $IgnoreProcess = $True
        } 
        ElseIf ($PSCmdlet.SessionState.PSVariable.Get('_')) {
            Write-Debug '$_ found from ForEach loop'
            $IsPipeline = $True
            $IgnoreProcess = $False
            #[void]$list.AddRange(@($PSCmdlet.SessionState.PSVariable.Get('_') | Select-Object -ExpandProperty Value))
            $InputObject = $PSBoundParameters['InputObject'] = @($PSCmdlet.SessionState.PSVariable.Get('_') | Select-Object -ExpandProperty Value)
        }
        Else {
            $IsPipeline = $True
            $IgnoreProcess = $False
        }
    }
    Process {
        Write-Debug "[PROCESS]"       
        If ($IsPipeline -AND $PSBoundParameters.ContainsKey('InputObject') -AND -NOT $IgnoreProcess) {
            [void]$List.Add($InputObject)
        } 
        ElseIf ($IgnoreProcess) {
            $IsPipeline = $True
        }
        Else {
            $IsPipeline = $True
        }
    }
    End { 
        Write-Debug "[END]"        
        $SBParamCount = @(GetParamVariable -ScriptBlock $ScriptBlock).Count
        $ArgumentCount = If ($ArgumentList.count -eq $Null) {
            0
        } 
        Else {
            $ArgumentList.count
        }
        If ($PSBoundParameters.ContainsKey('InputObject')) {
            If ($ArgumentCount -gt 0) {
                $SBParamCount++
            } 
            Else {
                $SBParamCount--
            }
        }
        Write-Debug ("ArgumentCount: $ArgumentCount | SBParamCount: $SBParamCount | IsPipeline: $IsPipeline")
        If ($ArgumentCount -ne $SBParamCount -AND $IsPipeline) {
            Write-Verbose 'Will use $_ in Param() Block'
            $Script:Add_ = $True
        } 
        Else {
            $Script:Add_ = $False
        }
        #region Convert ScriptBlock for $Using:
        $PreviousErrorAction = $ErrorActionPreference
        $ErrorActionPreference = 'Stop'
        Write-Verbose "PowerShell Version: $($PSVersionTable.PSVersion.Major)"
        Switch ($PSVersionTable.PSVersion.Major) {
            2 {
                Write-Verbose "Using PSParser with PowerShell V2"
                $UsingVariables = @(GetUsingVariablesV2 -ScriptBlock $ScriptBlock)                
                Write-Verbose "Using Count: $($UsingVariables.count)"
                Write-Verbose "$($UsingVariables|Out-String)"
                Write-Verbose "CommandOrigin: $($MyInvocation.CommandOrigin)"
                If ($UsingVariables.count -gt 0) {
                    $UsingVariableValues = @($UsingVariables | ForEach {
                        $Name = $_.Content -replace 'Using:'
                        Try {
                            If ($MyInvocation.CommandOrigin -eq 'Runspace') {
                                $Value = (Get-Variable -Name $Name).Value
                            } 
                            Else {
                                $Value = $PSCmdlet.SessionState.PSVariable.Get($Name).Value
                                If ([string]::IsNullOrEmpty($Value)) {
                                    Throw 'No value!'
                                }
                            }
                            New-Object PoshRS.PowerShell.V2UsingVariable -Property @{
                                Name = $Name
                                NewName = '$__using_{0}' -f $Name
                                Value = $Value
                                NewVarName = ('__using_{0}') -f $Name
                            }
                        } 
                        Catch {
                            Throw "Start-RSJob : The value of the using variable '$($Var.SubExpression.Extent.Text)' cannot be retrieved because it has not been set in the local session."                        
                        }
                    })

                    Write-Verbose ("Found {0} `$Using: variables!" -f $UsingVariableValues.count)
                }
                If ($UsingVariables.count -gt 0 -OR $Script:Add_) {
                    $NewScriptBlock = ConvertScriptBlockV2 $ScriptBlock -UsingVariable $UsingVariables -UsingVariableValue $UsingVariableValues           
                } 
                Else {
                    $NewScriptBlock = $ScriptBlock
                }                
            }
            Default {
                Write-Debug "Using AST with PowerShell V3+"
                $UsingVariables = @(GetUsingVariables $ScriptBlock | Group SubExpression | ForEach {
                    $_.Group | Select -First 1
                })    
                #region Get Variable Values
                If ($UsingVariables.count -gt 0) {
                    $UsingVar = $UsingVariables | Group SubExpression | ForEach {$_.Group | Select -First 1}  
                    Write-Debug "CommandOrigin: $($MyInvocation.CommandOrigin)"      
                    $UsingVariableValues = @(ForEach ($Var in $UsingVar) {
                        Try {
                            If ($MyInvocation.CommandOrigin -eq 'Runspace') {
                                $Value = Get-Variable -Name $Var.SubExpression.VariablePath.UserPath
                            } 
                            Else {
                                $Value = ($PSCmdlet.SessionState.PSVariable.Get($Var.SubExpression.VariablePath.UserPath))
                                If ([string]::IsNullOrEmpty($Value)) {
                                    Throw 'No value!'
                                }
                            }
                            [pscustomobject]@{
                                Name = $Var.SubExpression.Extent.Text
                                Value = $Value.Value
                                NewName = ('$__using_{0}' -f $Var.SubExpression.VariablePath.UserPath)
                                NewVarName = ('__using_{0}' -f $Var.SubExpression.VariablePath.UserPath)
                            }
                        } 
                        Catch {
                            Throw "Start-RSJob : The value of the using variable '$($Var.SubExpression.Extent.Text)' cannot be retrieved because it has not been set in the local session."
                        }
                    })
                    #endregion Get Variable Values
                    Write-Verbose ("Found {0} `$Using: variables!" -f $UsingVariableValues.count)
                }
                If ($UsingVariables.count -gt 0 -OR $Script:Add_) {
                    $NewScriptBlock = ConvertScript $ScriptBlock            
                } 
                Else {
                    $NewScriptBlock = $ScriptBlock
                }
            }
        }
        $ErrorActionPreference = $PreviousErrorAction
        #endregion Convert ScriptBlock for $Using:

        Write-Debug "ScriptBlock: $($NewScriptBlock)"

        #region RunspacePool Creation
        If (-NOT $PSBoundParameters.ContainsKey('Batch')) {
            If ($PoshRS_RunspacePools.Count -gt 0) {
                [System.Threading.Monitor]::Enter($PoshRS_RunspacePools.syncroot) 
                $RSPObject = $PoshRS_RunspacePools[0]
                $Batch = $RSPObject.RunspacePoolID
                Write-Verbose "Using current runspacepool <$($__RSPObject.RunspacePoolID)>"
                #Update LastActivity so it doesn't get removed prematurely; runspacepool cleanup will update once it detects running jobs
                $RSPObject.LastActivity = $RSPObject.LastActivity.AddMinutes(5)
                [System.Threading.Monitor]::Exit($PoshRS_RunspacePools.syncroot)
            }
            Else {
                $Batch = $RunspacePoolID = [guid]::NewGuid().ToString()
                Write-Verbose "Creating new runspacepool <$Batch>"
                $RunspacePool = [runspacefactory]::CreateRunspacePool($InitialSessionState)
                Try {
                    #ApartmentState doesn't exist in Nano Server
                    $RunspacePool.ApartmentState = 'STA'
                } 
                Catch {}
                [void]$RunspacePool.SetMaxRunspaces($Throttle)
                If ($PSVersionTable.PSVersion.Major -gt 2) {
                    $RunspacePool.CleanupInterval = [timespan]::FromMinutes(5)    
                }
                $RunspacePool.Open()
                $RSPObject = New-Object PoshRS.PowerShell.RSRunspacePool -Property @{
                    RunspacePool = $RunspacePool
                    MaxJobs = $RunspacePool.GetMaxRunspaces()
                    RunspacePoolID = $RunspacePoolID
                }
                [System.Threading.Monitor]::Enter($PoshRS_RunspacePools.syncroot) 
                [void]$PoshRS_RunspacePools.Add($RSPObject)
                [System.Threading.Monitor]::Exit($PoshRS_RunspacePools.syncroot)
            }
        }
        Else {            
            [System.Threading.Monitor]::Enter($PoshRS_RunspacePools.syncroot) 
            $__RSPObject = $PoshRS_RunspacePools | Where {
                $_.RunspacePoolID -eq $Batch
            }
            If ($__RSPObject) {
                Write-Verbose "Using current runspacepool <$($__RSPObject.RunspacePoolID)>"
                $RSPObject = $__RSPObject
                $RSPObject.LastActivity = $RSPObject.LastActivity.AddMinutes(5)
            }
            Else {
                Write-Verbose "Creating new runspacepool <$Batch>"
                $RunspacePoolID = $Batch
                $RunspacePool = [runspacefactory]::CreateRunspacePool($InitialSessionState)
                Try {
                    #ApartmentState doesn't exist in Nano Server
                    $RunspacePool.ApartmentState = 'STA'
                } 
                Catch {}
                [void]$RunspacePool.SetMaxRunspaces($Throttle)
                If ($PSVersionTable.PSVersion.Major -gt 2) {
                    $RunspacePool.CleanupInterval = [timespan]::FromMinutes(2)    
                }
                $RunspacePool.Open()
                $RSPObject = New-Object PoshRS.PowerShell.RSRunspacePool -Property @{
                    RunspacePool = $RunspacePool
                    MaxJobs = $RunspacePool.GetMaxRunspaces()
                    RunspacePoolID = $RunspacePoolID
                }
                [void]$PoshRS_RunspacePools.Add($RSPObject)
            }
            [System.Threading.Monitor]::Exit($PoshRS_RunspacePools.syncroot)            
        }
        #endregion RunspacePool Creation

        If ($List.Count -gt 0) {
            Write-Debug "InputObject"
            Write-Debug "ListCount: $($list.count)"
            ForEach ($Item in $list) {
                $ID = Increment                    
                Write-Verbose "Using $($Item) as pipeline variable"
                $PowerShell = [powershell]::Create().AddScript($NewScriptBlock)
                $PowerShell.RunspacePool = $RSPObject.RunspacePool
                [void]$PowerShell.AddArgument($Item)
                Write-Verbose "Checking for Using: variables"
                If ($UsingVariableValues.count -gt 0) {
                    For ($i=0;$i -lt $UsingVariableValues.count;$i++) {
                        Write-Verbose "Adding Param: $($UsingVariableValues[$i].Name) Value: $($UsingVariableValues[$i].Value)"
                        [void]$PowerShell.AddParameter($UsingVariableValues[$i].NewVarName,$UsingVariableValues[$i].Value)
                    }
                }
                Write-Verbose "Checking for ArgumentList"
                If ($PSBoundParameters.ContainsKey('ArgumentList')) {
                    If ($SingleArgument) {                        
                        ,$ArgumentList | ForEach {
                            Write-Verbose "Adding Argument: $($_) <$($_.GetType().Fullname)>"
                            [void]$PowerShell.AddArgument($_) 
                        }
                    } 
                    Else {
                        ForEach ($Argument in $ArgumentList) {
                            Write-Verbose "Adding Argument: $($Argument) <$($Argument.GetType().Fullname)>"
                            [void]$PowerShell.AddArgument($Argument)    
                        }
                    }
                }
                Write-Verbose "Invoking Runspace"
                $Handle = $PowerShell.BeginInvoke()
                Write-Verbose "Determining Job Name"
                $_JobName = If ($PSVersionTable.PSVersion.Major -eq 2) {
                    $JobName.Invoke()
                } 
                Else {
                    $JobName.InvokeReturnAsIs()
                }
                $Object = New-Object PoshRS.PowerShell.RSJob -Property @{
                    Name = $_JobName
                    InstanceID = [guid]::NewGuid().ToString()
                    ID = $ID  
                    Handle = $Handle
                    InnerJob = $PowerShell
                    Runspace = $PowerShell.Runspace
                    Finished = $handle.IsCompleted
                    Command  = $ScriptBlock.ToString()
                    RunspacePoolID = $RunSpacePoolID
                    Batch = $Batch
                    State = [System.Management.Automation.PSInvocationState]::Running
                }
                
                $RSPObject.LastActivity = Get-Date
                Write-Verbose "Adding RSJob to Jobs queue"
                [System.Threading.Monitor]::Enter($PoshRS_Jobs.syncroot) 
                [void]$PoshRS_Jobs.Add($Object)
                [System.Threading.Monitor]::Exit($PoshRS_Jobs.syncroot) 
                Write-Verbose "Display RSJob"
                $Object            
            }
        } 
        Else {
            Write-Debug "No InputObject"
            $ID = Increment                    
            $PowerShell = [powershell]::Create().AddScript($NewScriptBlock)
            $PowerShell.RunspacePool = $RSPObject.RunspacePool
            If ($UsingVariableValues) {
                For ($i=0;$i -lt $UsingVariableValues.count;$i++) {
                    Write-Verbose "Adding Param: $($UsingVariableValues[$i].Name) Value: $($UsingVariableValues[$i].Value)"
                    [void]$PowerShell.AddParameter($UsingVariableValues[$i].NewVarName,$UsingVariableValues[$i].Value)
                }
            }
            If ($PSBoundParameters.ContainsKey('ArgumentList')) {
                If ($SingleArgument) {
                    ,$ArgumentList | ForEach {
                        Write-Verbose "Adding Argument: $($_) <$($_.GetType().Fullname)>"
                        [void]$PowerShell.AddArgument($_) 
                    }
                } 
                Else {
                    ForEach ($Argument in $ArgumentList) {
                        Write-Verbose "Adding Argument: $($Argument) <$($Argument.GetType().Fullname)>"
                        [void]$PowerShell.AddArgument($Argument)    
                    }
                }
            }
            $Handle = $PowerShell.BeginInvoke()
            $_JobName = If ($PSVersionTable.PSVersion.Major -eq 2) {
                $JobName.Invoke()
            } 
            Else {
                $JobName.InvokeReturnAsIs()
            }
            $Object = New-Object PoshRS.PowerShell.RSJob -Property @{
                Name = $_JobName
                InstanceID = [guid]::NewGuid().ToString()
                ID = $ID  
                Handle = $Handle
                InnerJob = $PowerShell
                Runspace = $PowerShell.Runspace
                Finished = $handle.RSWaitHandle
                Command  = $ScriptBlock.ToString()
                RunspacePoolID = $RunSpacePoolID
                Batch = $Batch
                State = [System.Management.Automation.PSInvocationState]::Running
            }
            
            $RSPObject.LastActivity = Get-Date
            [System.Threading.Monitor]::Enter($PoshRS_Jobs.syncroot) 
            [void]$PoshRS_Jobs.Add($Object)
            [System.Threading.Monitor]::Exit($PoshRS_Jobs.syncroot) 
            $Object        
        }      
    }
}