Replace throw with ThrowTerminatingError in exception handling (#179)

dan-hughes · web-flow · commit 903f6f05a99a · 2025-09-24T19:13:48.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+
+- New-*Exception
+  - Use `ThrowTerminatingError` instead of `throw`. Fixes [#177](https://github.com/dsccommunity/DscResource.Common/issues/177).
+
 ## [0.24.2] - 2025-08-27
 
 ### Changed
diff --git a/source/Private/Clear-ZeroedEnumPropertyValue.ps1 b/source/Private/Clear-ZeroedEnumPropertyValue.ps1
@@ -21,7 +21,8 @@ function Clear-ZeroedEnumPropertyValue
 {
     [CmdletBinding()]
     [OutputType([System.Collections.Hashtable])]
-    param (
+    param
+    (
         [Parameter(Mandatory = $true, ValueFromPipeline = $true)]
         [System.Collections.Hashtable]
         $InputObject
diff --git a/source/Public/Get-LocalizedDataForInvariantCulture.ps1 b/source/Public/Get-LocalizedDataForInvariantCulture.ps1
@@ -132,7 +132,14 @@ function Get-LocalizedDataForInvariantCulture
 
         if ([string]::IsNullOrEmpty($languageFile))
         {
-            throw ($script:localizedData.Get_LocalizedDataForInvariantCulture_FileNotFoundInFolder -f ($localizedFileNamesToTry -join ','), $localizedFolder)
+            $message = ($script:localizedData.Get_LocalizedDataForInvariantCulture_FileNotFoundInFolder -f ($localizedFileNamesToTry -join ','), $localizedFolder)
+            $errorSplat = @{
+                Exception     = [System.IO.FileNotFoundException]::new($message)
+                ErrorId       = 'MachineStateIncorrect'
+                ErrorCategory = [System.Management.Automation.ErrorCategory]::ObjectNotFound
+            }
+
+            $PSCmdlet.ThrowTerminatingError((New-ErrorRecord @errorSplat))
         }
         else
         {
@@ -201,7 +208,7 @@ function Get-LocalizedDataForInvariantCulture
             }
             catch
             {
-                throw $_
+                $PSCmdlet.ThrowTerminatingError($_)
             }
 
             # Check for non-terminating errors.
diff --git a/source/Public/New-InvalidDataException.ps1 b/source/Public/New-InvalidDataException.ps1
@@ -42,5 +42,5 @@ function New-InvalidDataException
         ErrorCategory = [System.Management.Automation.ErrorCategory]::InvalidData
     }
 
-    throw (New-ErrorRecord @errorSplat)
+    $PSCmdlet.ThrowTerminatingError((New-ErrorRecord @errorSplat))
 }
diff --git a/source/Public/New-InvalidOperationException.ps1 b/source/Public/New-InvalidOperationException.ps1
@@ -16,7 +16,7 @@
         The error record containing the exception that is causing this terminating error.
 
     .PARAMETER PassThru
-        If specified, returns the error record instead of throwing it.
+        If specified, returns the exception instead of throwing it.
 
     .EXAMPLE
         try
@@ -60,19 +60,25 @@ function New-InvalidOperationException
 
     if ($null -eq $ErrorRecord)
     {
-        $invalidOperationException = [System.InvalidOperationException]::new($Message)
+        $exception = [System.InvalidOperationException]::new($Message)
     }
     else
     {
-        $invalidOperationException = [System.InvalidOperationException]::new($Message, $ErrorRecord.Exception)
+        $exception = [System.InvalidOperationException]::new($Message, $ErrorRecord.Exception)
     }
 
     if ($PassThru.IsPresent)
     {
-        return $invalidOperationException
+        return $exception
     }
     else
     {
-        throw (New-ErrorRecord -Exception $invalidOperationException.ToString() -ErrorId 'MachineStateIncorrect' -ErrorCategory 'InvalidOperation')
+        $errorSplat = @{
+            Exception     = $exception.ToString()
+            ErrorId       = 'MachineStateIncorrect'
+            ErrorCategory = [System.Management.Automation.ErrorCategory]::InvalidOperation
+        }
+
+        $PSCmdlet.ThrowTerminatingError((New-ErrorRecord @errorSplat))
     }
 }
diff --git a/source/Public/New-InvalidResultException.ps1 b/source/Public/New-InvalidResultException.ps1
@@ -55,5 +55,11 @@ function New-InvalidResultException
 
     $exception = New-Exception @PSBoundParameters
 
-    throw (New-ErrorRecord -Exception $exception.ToString() -ErrorId 'MachineStateIncorrect' -ErrorCategory 'InvalidResult')
+    $errorSplat = @{
+        Exception     = $exception.ToString()
+        ErrorId       = 'MachineStateIncorrect'
+        ErrorCategory = [System.Management.Automation.ErrorCategory]::InvalidResult
+    }
+
+    $PSCmdlet.ThrowTerminatingError((New-ErrorRecord @errorSplat))
 }
diff --git a/source/Public/New-NotImplementedException.ps1 b/source/Public/New-NotImplementedException.ps1
@@ -12,7 +12,7 @@
         The error record containing the exception that is causing this terminating error.
 
     .PARAMETER PassThru
-        If specified, returns the error record instead of throwing it.
+        If specified, returns the exception instead of throwing it.
 
     .OUTPUTS
         None
@@ -57,19 +57,25 @@ function New-NotImplementedException
 
     if ($null -eq $ErrorRecord)
     {
-        $notImplementedException = [System.NotImplementedException]::new($Message)
+        $exception = [System.NotImplementedException]::new($Message)
     }
     else
     {
-        $notImplementedException = [System.NotImplementedException]::new($Message, $ErrorRecord.Exception)
+        $exception = [System.NotImplementedException]::new($Message, $ErrorRecord.Exception)
     }
 
     if ($PassThru.IsPresent)
     {
-        return $notImplementedException
+        return $exception
     }
     else
     {
-        throw (New-ErrorRecord -Exception $notImplementedException.ToString() -ErrorId 'MachineStateIncorrect' -ErrorCategory 'NotImplemented')
+        $errorSplat = @{
+            Exception     = $exception.ToString()
+            ErrorId       = 'MachineStateIncorrect'
+            ErrorCategory = [System.Management.Automation.ErrorCategory]::NotImplemented
+        }
+
+        $PSCmdlet.ThrowTerminatingError((New-ErrorRecord @errorSplat))
     }
 }
diff --git a/source/Public/New-ObjectNotFoundException.ps1 b/source/Public/New-ObjectNotFoundException.ps1
@@ -49,5 +49,11 @@ function New-ObjectNotFoundException
 
     $exception = New-Exception @PSBoundParameters
 
-    throw (New-ErrorRecord -Exception $exception.ToString() -ErrorId 'MachineStateIncorrect' -ErrorCategory 'ObjectNotFound')
+    $errorSplat = @{
+        Exception     = $exception.ToString()
+        ErrorId       = 'MachineStateIncorrect'
+        ErrorCategory = [System.Management.Automation.ErrorCategory]::ObjectNotFound
+    }
+
+    $PSCmdlet.ThrowTerminatingError((New-ErrorRecord @errorSplat))
 }
diff --git a/tests/Unit/Public/New-InvalidDataException.Tests.ps1 b/tests/Unit/Public/New-InvalidDataException.Tests.ps1
@@ -55,7 +55,7 @@ Describe 'New-InvalidDataException' {
                 Should -Throw -PassThru
 
             $exception.CategoryInfo.Category | Should -Be 'InvalidData'
-            $exception.FullyQualifiedErrorId | Should -Be $mockErrorId
+            $exception.FullyQualifiedErrorId | Should -BeLike ($mockErrorId + '*')
             $exception.Exception.Message | Should -Be $mockErrorMessage
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,14 @@ function Get-LocalizedDataForInvariantCulture`
`132`	`132`
`133`	`133`	`if ([string]::IsNullOrEmpty($languageFile))`
`134`	`134`	`{`
`135`		`- throw ($script:localizedData.Get_LocalizedDataForInvariantCulture_FileNotFoundInFolder -f ($localizedFileNamesToTry -join ','), $localizedFolder)`
	`135`	`+ $message = ($script:localizedData.Get_LocalizedDataForInvariantCulture_FileNotFoundInFolder -f ($localizedFileNamesToTry -join ','), $localizedFolder)`
	`136`	`+ $errorSplat = @{`
	`137`	`+ Exception = [System.IO.FileNotFoundException]::new($message)`
	`138`	`+ ErrorId = 'MachineStateIncorrect'`
	`139`	`+ ErrorCategory = [System.Management.Automation.ErrorCategory]::ObjectNotFound`
	`140`	`+ }`
	`141`	`+`
	`142`	`+ $PSCmdlet.ThrowTerminatingError((New-ErrorRecord @errorSplat))`
`136`	`143`	`}`
`137`	`144`	`else`
`138`	`145`	`{`
`@@ -201,7 +208,7 @@ function Get-LocalizedDataForInvariantCulture`
`201`	`208`	`}`
`202`	`209`	`catch`
`203`	`210`	`{`
`204`		`- throw $_`
	`211`	`+ $PSCmdlet.ThrowTerminatingError($_)`
`205`	`212`	`}`
`206`	`213`
`207`	`214`	`# Check for non-terminating errors.`
Original file line number	Diff line number	Diff line change
`@@ -42,5 +42,5 @@ function New-InvalidDataException`
`42`	`42`	`ErrorCategory = [System.Management.Automation.ErrorCategory]::InvalidData`
`43`	`43`	`}`
`44`	`44`
`45`		`- throw (New-ErrorRecord @errorSplat)`
	`45`	`+ $PSCmdlet.ThrowTerminatingError((New-ErrorRecord @errorSplat))`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`The error record containing the exception that is causing this terminating error.`
`17`	`17`
`18`	`18`	`.PARAMETER PassThru`
`19`		`- If specified, returns the error record instead of throwing it.`
	`19`	`+ If specified, returns the exception instead of throwing it.`
`20`	`20`
`21`	`21`	`.EXAMPLE`
`22`	`22`	`try`
`@@ -60,19 +60,25 @@ function New-InvalidOperationException`
`60`	`60`
`61`	`61`	`if ($null -eq $ErrorRecord)`
`62`	`62`	`{`
`63`		`- $invalidOperationException = [System.InvalidOperationException]::new($Message)`
	`63`	`+ $exception = [System.InvalidOperationException]::new($Message)`
`64`	`64`	`}`
`65`	`65`	`else`
`66`	`66`	`{`
`67`		`- $invalidOperationException = [System.InvalidOperationException]::new($Message, $ErrorRecord.Exception)`
	`67`	`+ $exception = [System.InvalidOperationException]::new($Message, $ErrorRecord.Exception)`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`if ($PassThru.IsPresent)`
`71`	`71`	`{`
`72`		`- return $invalidOperationException`
	`72`	`+ return $exception`
`73`	`73`	`}`
`74`	`74`	`else`
`75`	`75`	`{`
`76`		`- throw (New-ErrorRecord -Exception $invalidOperationException.ToString() -ErrorId 'MachineStateIncorrect' -ErrorCategory 'InvalidOperation')`
	`76`	`+ $errorSplat = @{`
	`77`	`+ Exception = $exception.ToString()`
	`78`	`+ ErrorId = 'MachineStateIncorrect'`
	`79`	`+ ErrorCategory = [System.Management.Automation.ErrorCategory]::InvalidOperation`
	`80`	`+ }`
	`81`	`+`
	`82`	`+ $PSCmdlet.ThrowTerminatingError((New-ErrorRecord @errorSplat))`
`77`	`83`	`}`
`78`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`The error record containing the exception that is causing this terminating error.`
`13`	`13`
`14`	`14`	`.PARAMETER PassThru`
`15`		`- If specified, returns the error record instead of throwing it.`
	`15`	`+ If specified, returns the exception instead of throwing it.`
`16`	`16`
`17`	`17`	`.OUTPUTS`
`18`	`18`	`None`
`@@ -57,19 +57,25 @@ function New-NotImplementedException`
`57`	`57`
`58`	`58`	`if ($null -eq $ErrorRecord)`
`59`	`59`	`{`
`60`		`- $notImplementedException = [System.NotImplementedException]::new($Message)`
	`60`	`+ $exception = [System.NotImplementedException]::new($Message)`
`61`	`61`	`}`
`62`	`62`	`else`
`63`	`63`	`{`
`64`		`- $notImplementedException = [System.NotImplementedException]::new($Message, $ErrorRecord.Exception)`
	`64`	`+ $exception = [System.NotImplementedException]::new($Message, $ErrorRecord.Exception)`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`if ($PassThru.IsPresent)`
`68`	`68`	`{`
`69`		`- return $notImplementedException`
	`69`	`+ return $exception`
`70`	`70`	`}`
`71`	`71`	`else`
`72`	`72`	`{`
`73`		`- throw (New-ErrorRecord -Exception $notImplementedException.ToString() -ErrorId 'MachineStateIncorrect' -ErrorCategory 'NotImplemented')`
	`73`	`+ $errorSplat = @{`
	`74`	`+ Exception = $exception.ToString()`
	`75`	`+ ErrorId = 'MachineStateIncorrect'`
	`76`	`+ ErrorCategory = [System.Management.Automation.ErrorCategory]::NotImplemented`
	`77`	`+ }`
	`78`	`+`
	`79`	`+ $PSCmdlet.ThrowTerminatingError((New-ErrorRecord @errorSplat))`
`74`	`80`	`}`
`75`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ Describe 'New-InvalidDataException' {`
`55`	`55`	`Should -Throw -PassThru`
`56`	`56`
`57`	`57`	`$exception.CategoryInfo.Category \| Should -Be 'InvalidData'`
`58`		`- $exception.FullyQualifiedErrorId \| Should -Be $mockErrorId`
	`58`	`+ $exception.FullyQualifiedErrorId \| Should -BeLike ($mockErrorId + '*')`
`59`	`59`	`$exception.Exception.Message \| Should -Be $mockErrorMessage`
`60`	`60`	`}`
`61`	`61`	`}`