Restore-DbaDatabase - Fix ErrorBrokerConversations restore handling (review of #10253)

potatoqualitee · Copilot · potatoqualitee · commit 34d47dfb1ea5 · 2026-04-10T09:17:30.000+02:00
Co-authored-by: Copilot &lt;223556219+Copilot@users.noreply.github.com&gt;
diff --git a/docs/trackers/features/commit-bug-review-TRACKER.md b/docs/trackers/features/commit-bug-review-TRACKER.md
@@ -74,7 +74,7 @@ Find real bugs (logic errors, null refs, incorrect behavior) and fix them. Skip
 | 232395207 | Set-DbaPrivilege, Get-DbaPrivilege - Add CreateGlobalObjects privilege support (#10235) | DONE | Fixed empty privilege-entry updates so Set-DbaPrivilege still grants rights when secedit exports a blank line; added unit regression test. |
 | 099624061 | Get-DbaDbRestoreHistory - Add BackupStartDate, StopAt, and LastRestorePoint columns (#10249) | DONE | Fixed LastRestorePoint so StopAt is used whenever specified; added unit regression test. |
 | 4f1e56ce4 | New-DbaDbMailAccount, Set-DbaDbMailAccount - Add Port, SSL, and authentication parameters (#10257) | DONE | Added validation to reject conflicting SMTP authentication modes and incomplete credential pairs; added unit regression tests. |
-| 8218d327e | Restore-DbaDatabase, Invoke-DbaAdvancedRestore - Add ErrorBrokerConversations parameter (#10253) | PENDING | |
+| 8218d327e | Restore-DbaDatabase, Invoke-DbaAdvancedRestore - Add ErrorBrokerConversations parameter (#10253) | DONE | Fixed missing ExecuteAs script prefix and added NoRecovery/Standby validation; added regression tests. |
 | 9a4e4bacb | Connect-DbaInstance - Set NonPooledConnection on ServerConnection (#10260) | PENDING | |
 | a0ab78a66 | Get-DbaCmObject - Apply CimOperationTimeout to all CIM connections (#10252) | PENDING | |
 | fbdb47053 | Import-DbaXESessionTemplate - Add event_file target when TargetFilePath specified (#10250) | PENDING | |
diff --git a/public/Invoke-DbaAdvancedRestore.ps1 b/public/Invoke-DbaAdvancedRestore.ps1
@@ -262,10 +262,14 @@ function Invoke-DbaAdvancedRestore {
             Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $SqlInstance
             return
         }
-        if ($KeepCDC -and ($NoRecovery -or ('' -ne $StandbyDirectory))) {
+        if ($KeepCDC -and ($NoRecovery -or ("" -ne $StandbyDirectory))) {
             Stop-Function -Category InvalidArgument -Message "KeepCDC cannot be specified with Norecovery or Standby as it needs recovery to work"
             return
         }
+        if ($ErrorBrokerConversations -and ($NoRecovery -or ("" -ne $StandbyDirectory))) {
+            Stop-Function -Category InvalidArgument -Message "ErrorBrokerConversations cannot be specified with Norecovery or Standby as it needs recovery to work"
+            return
+        }
 
         if ($null -ne $PageRestore) {
             Write-Message -Message "Doing Page Recovery" -Level Verbose
@@ -424,15 +428,22 @@ function Invoke-DbaAdvancedRestore {
                 if ($Pscmdlet.ShouldProcess($SqlInstance, "Restoring $database to $SqlInstance based on these files: $($backup.FullName -join ', ')")) {
                     try {
                         $restoreComplete = $true
+                        $executeAsLogin = $null
+                        if ($ExecuteAs -ne "" -and $BackupCnt -eq 1) {
+                            $executeAsLogin = $ExecuteAs.Replace("'", "''")
+                        }
                         if (($KeepCDC -or $ErrorBrokerConversations) -and $restore.NoRecovery -eq $false) {
                             $script = $restore.Script($server)
                             $withOptions = @()
-                            if ($KeepCDC) { $withOptions += 'KEEP_CDC' }
-                            if ($ErrorBrokerConversations) { $withOptions += 'ERROR_BROKER_CONVERSATIONS' }
-                            if ($script -like '*WITH*') {
-                                $script = $script.TrimEnd() + ' , ' + ($withOptions -join ' , ')
+                            if ($KeepCDC) { $withOptions += "KEEP_CDC" }
+                            if ($ErrorBrokerConversations) { $withOptions += "ERROR_BROKER_CONVERSATIONS" }
+                            if ($script -like "*WITH*") {
+                                $script = $script.TrimEnd() + " , " + ($withOptions -join " , ")
                             } else {
-                                $script = $script.TrimEnd() + ' WITH ' + ($withOptions -join ' , ')
+                                $script = $script.TrimEnd() + " WITH " + ($withOptions -join " , ")
+                            }
+                            if ($null -ne $executeAsLogin) {
+                                $script = "EXECUTE AS LOGIN='$executeAsLogin'; " + $script
                             }
                             if ($true -ne $OutputScriptOnly) {
                                 Write-Progress -id 1 -activity "Restoring $database to $SqlInstance - Backup $BackupCnt of $($Backups.count)" -percentcomplete 0 -status ([System.String]::Format("Progress: {0} %", 0))
@@ -449,8 +460,8 @@ function Invoke-DbaAdvancedRestore {
                             }
                         } elseif ($OutputScriptOnly) {
                             $script = $restore.Script($server)
-                            if ($ExecuteAs -ne '' -and $BackupCnt -eq 1) {
-                                $script = "EXECUTE AS LOGIN='$ExecuteAs'; " + $script
+                            if ($null -ne $executeAsLogin) {
+                                $script = "EXECUTE AS LOGIN='$executeAsLogin'; " + $script
                             }
                         } elseif ($VerifyOnly) {
                             Write-Message -Message "VerifyOnly restore" -Level Verbose
@@ -473,9 +484,9 @@ function Invoke-DbaAdvancedRestore {
                             }
                             Write-Progress -id 2 -ParentId 1 -Activity "Restore $($backup.FullName -Join ',')" -percentcomplete 0
                             $script = $restore.Script($server)
-                            if ($ExecuteAs -ne '' -and $BackupCnt -eq 1) {
+                            if ($null -ne $executeAsLogin) {
                                 Write-Progress -id 1 -activity "Restoring $database to $SqlInstance - Backup $BackupCnt of $($Backups.count)" -percentcomplete 0 -status ([System.String]::Format("Progress: {0} %", 0))
-                                $script = "EXECUTE AS LOGIN='$ExecuteAs'; " + $script
+                                $script = "EXECUTE AS LOGIN='$executeAsLogin'; " + $script
                                 $null = $server.ConnectionContext.ExecuteNonQuery($script)
                                 Write-Progress -id 1 -activity "Restoring $database to $SqlInstance - Backup $BackupCnt of $($Backups.count)" -status "Complete" -Completed
                             } else {
diff --git a/public/Restore-DbaDatabase.ps1 b/public/Restore-DbaDatabase.ps1
@@ -634,10 +634,14 @@ function Restore-DbaDatabase {
                     return
                 }
             }
-            if ($KeepCDC -and ($NoRecovery -or ('' -ne $StandbyDirectory))) {
+            if ($KeepCDC -and ($NoRecovery -or ("" -ne $StandbyDirectory))) {
                 Stop-Function -Category InvalidArgument -Message "KeepCDC cannot be specified with Norecovery or Standby as it needs recovery to work"
                 return
             }
+            if ($ErrorBrokerConversations -and ($NoRecovery -or ("" -ne $StandbyDirectory))) {
+                Stop-Function -Category InvalidArgument -Message "ErrorBrokerConversations cannot be specified with Norecovery or Standby as it needs recovery to work"
+                return
+            }
             if ($Continue) {
                 Write-Message -Message "Called with continue, so assume we have an existing db in norecovery"
                 $WithReplace = $True
diff --git a/tests/Invoke-DbaAdvancedRestore.Tests.ps1 b/tests/Invoke-DbaAdvancedRestore.Tests.ps1
@@ -1,6 +1,6 @@
 #Requires -Module @{ ModuleName="Pester"; ModuleVersion="5.0" }
 param(
-    $ModuleName  = "dbatools",
+    $ModuleName = "dbatools",
     $CommandName = "Invoke-DbaAdvancedRestore",
     $PSDefaultParameterValues = $TestConfig.Defaults
 )
@@ -41,6 +41,117 @@ Describe $CommandName -Tag UnitTests {
             Compare-Object -ReferenceObject $expectedParameters -DifferenceObject $hasParameters | Should -BeNullOrEmpty
         }
     }
+
+    InModuleScope dbatools {
+        Context "ErrorBrokerConversations behavior" {
+            BeforeAll {
+                function Add-TeppCacheItem { }
+                function New-MockRestore {
+                    $restore = [PSCustomObject]@{
+                        NoRecovery              = $false
+                        StandbyFile             = $null
+                        Database                = $null
+                        ReplaceDatabase         = $false
+                        MaxTransferSize         = $null
+                        BufferCount             = $null
+                        Blocksize               = $null
+                        Checksum                = $false
+                        Restart                 = $false
+                        KeepReplication         = $false
+                        Action                  = $null
+                        FileNumber              = $null
+                        ToPointInTime           = $null
+                        StopBeforeMarkName      = $null
+                        StopAtMarkName          = $null
+                        StopBeforeMarkAfterDate = $null
+                        StopAtMarkAfterDate     = $null
+                        RelocateFiles           = (New-Object System.Collections.ArrayList)
+                        Devices                 = (New-Object System.Collections.ArrayList)
+                    }
+                    Add-Member -InputObject $restore -Name Script -MemberType ScriptMethod -Value {
+                        param($Server)
+                        "RESTORE DATABASE [$($this.Database)] FROM DISK = 'C:\backups\test.bak' WITH REPLACE"
+                    } -Force
+                    $restore
+                }
+
+                $script:mockServer = [PSCustomObject]@{
+                    Databases             = @()
+                    DatabaseEngineEdition = "SqlServer"
+                    ConnectionContext     = [PSCustomObject]@{
+                        TrueLogin = "dbatoolsci"
+                        exists    = $false
+                    }
+                }
+                Add-Member -InputObject $script:mockServer.ConnectionContext -Name ExecuteNonQuery -MemberType ScriptMethod -Value {
+                    param($Query)
+                    $null
+                } -Force
+                Add-Member -InputObject $script:mockServer.ConnectionContext -Name Disconnect -MemberType ScriptMethod -Value { } -Force
+
+                $script:backupHistory = [PSCustomObject]@{
+                    Database      = "RestoreAsDb"
+                    Type          = "1"
+                    FirstLsn      = 1
+                    RestoreTime   = (Get-Date).AddMinutes(-5)
+                    RecoveryModel = "Full"
+                    FileList      = @(
+                        [PSCustomObject]@{
+                            LogicalName  = "RestoreAsDb"
+                            PhysicalName = "C:\restore\RestoreAsDb.mdf"
+                        }
+                    )
+                    FullName      = @("C:\backups\RestoreAsDb.bak")
+                    Position      = 1
+                }
+
+                function Test-FunctionInterrupt { $false }
+                function Write-Message { }
+            }
+
+            BeforeEach {
+                Mock Connect-DbaInstance { $script:mockServer }
+                Mock New-Object {
+                    New-MockRestore
+                } -ParameterFilter {
+                    $TypeName -eq "Microsoft.SqlServer.Management.Smo.Restore"
+                }
+                Mock New-Object {
+                    [PSCustomObject]@{
+                        LogicalFileName  = $null
+                        PhysicalFileName = $null
+                    }
+                } -ParameterFilter {
+                    $TypeName -eq "Microsoft.SqlServer.Management.Smo.RelocateFile"
+                }
+                Mock New-Object {
+                    [PSCustomObject]@{
+                        Name       = $null
+                        devicetype = $null
+                    }
+                } -ParameterFilter {
+                    $TypeName -eq "Microsoft.SqlServer.Management.Smo.BackupDeviceItem"
+                }
+            }
+
+            It "Should call Stop-Function when ErrorBrokerConversations is combined with NoRecovery" {
+                Mock Stop-Function {
+                    throw $Message
+                }
+
+                { Invoke-DbaAdvancedRestore -BackupHistory $script:backupHistory -SqlInstance "sql1" -NoRecovery -ErrorBrokerConversations } | Should -Throw "*ErrorBrokerConversations cannot be specified with Norecovery or Standby as it needs recovery to work*"
+            }
+
+            It "Should prefix OutputScriptOnly with Execute As when ErrorBrokerConversations is specified" {
+                Mock Stop-Function { }
+                $output = Invoke-DbaAdvancedRestore -BackupHistory $script:backupHistory -SqlInstance "sql1" -OutputScriptOnly -ErrorBrokerConversations -ExecuteAs "RestoreAs"
+                $scriptOutput = $output | Select-Object -Last 1
+
+                $scriptOutput | Should -BeLike "EXECUTE AS LOGIN='RestoreAs'*ERROR_BROKER_CONVERSATIONS*"
+                Should -Invoke Stop-Function -Times 0
+            }
+        }
+    }
 }
 <#
     Integration test should appear below and are custom to the command you are writing.
diff --git a/tests/Restore-DbaDatabase.Tests.ps1 b/tests/Restore-DbaDatabase.Tests.ps1
@@ -1,6 +1,6 @@
 #Requires -Module @{ ModuleName="Pester"; ModuleVersion="5.0" }
 param(
-    $ModuleName  = "dbatools",
+    $ModuleName = "dbatools",
     $CommandName = "Restore-DbaDatabase",
     $PSDefaultParameterValues = $TestConfig.Defaults
 )
@@ -70,6 +70,34 @@ Describe $CommandName -Tag UnitTests {
             Compare-Object -ReferenceObject $expectedParameters -DifferenceObject $hasParameters | Should -BeNullOrEmpty
         }
     }
+
+    InModuleScope dbatools {
+        Context "ErrorBrokerConversations validation" {
+            BeforeAll {
+                function Write-Message { }
+            }
+
+            BeforeEach {
+                Mock Connect-DbaInstance {
+                    [PSCustomObject]@{
+                        DatabaseEngineEdition = "SqlServer"
+                        VersionMajor          = 16
+                        ConnectionContext     = [PSCustomObject]@{
+                            StatementTimeout = 0
+                        }
+                    }
+                }
+            }
+
+            It "Should call Stop-Function when ErrorBrokerConversations is combined with NoRecovery" {
+                Mock Stop-Function {
+                    throw $Message
+                }
+
+                { Restore-DbaDatabase -SqlInstance "sql1" -Path "C:\backups\test.bak" -ErrorBrokerConversations -NoRecovery } | Should -Throw "*ErrorBrokerConversations cannot be specified with Norecovery or Standby as it needs recovery to work*"
+            }
+        }
+    }
 }
 
 Describe $CommandName -Tag IntegrationTests {
@@ -723,6 +751,41 @@ Describe $CommandName -Tag IntegrationTests {
     }
 
 
+    Context "Checking ErrorBrokerConversations parameter " {
+        BeforeAll {
+            $databaseName = "testErrorBrokerConversations"
+            $server = Connect-DbaInstance -SqlInstance $TestConfig.InstanceSingle -SqlCredential $TestConfig.SqlCredential -EnableException
+            $executeAsLogin = $server.ConnectionContext.TrueLogin
+            $escapedExecuteAsLogin = $executeAsLogin.Replace("'", "''")
+            $server.ConnectionContext.Disconnect()
+        }
+
+        It "Should have ERROR_BROKER_CONVERSATIONS in the SQL" {
+            $output = Restore-DbaDatabase -SqlInstance $TestConfig.InstanceSingle -Path "$($TestConfig.appveyorlabrepo)\singlerestore\singlerestore.bak" -DatabaseName $databaseName -OutputScriptOnly -ErrorBrokerConversations -WithReplace
+            $output | Should -BeLike "*ERROR_BROKER_CONVERSATIONS*"
+        }
+
+        It "Should prefix the script with the Execute As statement when ErrorBrokerConversations is specified" {
+            $output = Restore-DbaDatabase -SqlInstance $TestConfig.InstanceSingle -Path "$($TestConfig.appveyorlabrepo)\singlerestore\singlerestore.bak" -DatabaseName $databaseName -OutputScriptOnly -ErrorBrokerConversations -WithReplace -ExecuteAs $executeAsLogin
+            $output | Should -BeLike "EXECUTE AS LOGIN='$escapedExecuteAsLogin'*ERROR_BROKER_CONVERSATIONS*"
+        }
+
+        It "Should not output, and warn if Norecovery and ErrorBrokerConversations specified" {
+            $WarnVar = $null
+            $output = Restore-DbaDatabase -SqlInstance $TestConfig.InstanceSingle -Path "$($TestConfig.appveyorlabrepo)\singlerestore\singlerestore.bak" -DatabaseName $databaseName -OutputScriptOnly -ErrorBrokerConversations -WithReplace -NoRecovery -WarningAction SilentlyContinue
+            $WarnVar | Should -BeLike "*ErrorBrokerConversations cannot be specified with Norecovery or Standby as it needs recovery to work"
+            $output | Should -Be $null
+        }
+
+        It "Should not output, and warn if StandbyDirectory and ErrorBrokerConversations specified" {
+            $WarnVar = $null
+            $output = Restore-DbaDatabase -SqlInstance $TestConfig.InstanceSingle -Path "$($TestConfig.appveyorlabrepo)\singlerestore\singlerestore.bak" -DatabaseName $databaseName -OutputScriptOnly -ErrorBrokerConversations -WithReplace -StandbyDirectory $backupPath -WarningAction SilentlyContinue
+            $WarnVar | Should -BeLike "*ErrorBrokerConversations cannot be specified with Norecovery or Standby as it needs recovery to work"
+            $output | Should -Be $null
+        }
+    }
+
+
     Context "Page level restores" {
         BeforeAll {
             $null = Get-DbaDatabase -SqlInstance $TestConfig.InstanceSingle -ExcludeSystem | Remove-DbaDatabase

Original file line number	Diff line number	Diff line change
`@@ -634,10 +634,14 @@ function Restore-DbaDatabase {`
`634`	`634`	`return`
`635`	`635`	`}`
`636`	`636`	`}`
`637`		`- if ($KeepCDC -and ($NoRecovery -or ('' -ne $StandbyDirectory))) {`
	`637`	`+ if ($KeepCDC -and ($NoRecovery -or ("" -ne $StandbyDirectory))) {`
`638`	`638`	`Stop-Function -Category InvalidArgument -Message "KeepCDC cannot be specified with Norecovery or Standby as it needs recovery to work"`
`639`	`639`	`return`
`640`	`640`	`}`
	`641`	`+ if ($ErrorBrokerConversations -and ($NoRecovery -or ("" -ne $StandbyDirectory))) {`
	`642`	`+ Stop-Function -Category InvalidArgument -Message "ErrorBrokerConversations cannot be specified with Norecovery or Standby as it needs recovery to work"`
	`643`	`+ return`
	`644`	`+ }`
`641`	`645`	`if ($Continue) {`
`642`	`646`	`Write-Message -Message "Called with continue, so assume we have an existing db in norecovery"`
`643`	`647`	`$WithReplace = $True`