Skip to content

Add suspend-resume support for durable client #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/AzureFunctions.PowerShell.Durable.SDK.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@
'Get-DurableStatus',
'New-DurableOrchestrationCheckStatusResponse',
'Send-DurableExternalEvent',
'Start-DurableOrchestration'
'Stop-DurableOrchestration'
'Start-DurableOrchestration',
'Stop-DurableOrchestration',
'Suspend-DurableOrchestration',
'Resume-DurableOrchestration'
)

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
Expand Down
58 changes: 58 additions & 0 deletions src/AzureFunctions.PowerShell.Durable.SDK.psm1
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,64 @@ function Stop-DurableOrchestration {
Invoke-RestMethod -Uri $requestUrl -Method 'POST'
}

function Suspend-DurableOrchestration {
[CmdletBinding()]
param(
[Parameter(
Mandatory = $true,
Position = 0,
ValueFromPipelineByPropertyName = $true)]
[ValidateNotNullOrEmpty()]
[string] $InstanceId,

[Parameter(
Mandatory = $true,
Position = 1,
ValueFromPipelineByPropertyName = $true)]
[ValidateNotNullOrEmpty()]
[string] $Reason
)

$ErrorActionPreference = 'Stop'

if ($null -eq $DurableClient) {
$DurableClient = GetDurableClientFromModulePrivateData
}

$requestUrl = "$($DurableClient.BaseUrl)/instances/$InstanceId/suspend?reason=$([System.Web.HttpUtility]::UrlEncode($Reason))"

Invoke-RestMethod -Uri $requestUrl -Method 'POST'
}

function Resume-DurableOrchestration {
[CmdletBinding()]
param(
[Parameter(
Mandatory = $true,
Position = 0,
ValueFromPipelineByPropertyName = $true)]
[ValidateNotNullOrEmpty()]
[string] $InstanceId,

[Parameter(
Mandatory = $true,
Position = 1,
ValueFromPipelineByPropertyName = $true)]
[ValidateNotNullOrEmpty()]
[string] $Reason
)

$ErrorActionPreference = 'Stop'

if ($null -eq $DurableClient) {
$DurableClient = GetDurableClientFromModulePrivateData
}

$requestUrl = "$($DurableClient.BaseUrl)/instances/$InstanceId/resume?reason=$([System.Web.HttpUtility]::UrlEncode($Reason))"

Invoke-RestMethod -Uri $requestUrl -Method 'POST'
}

function IsValidUrl([uri]$Url) {
$Url.IsAbsoluteUri -and ($Url.Scheme -in 'http', 'https')
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -227,5 +227,35 @@ await ValidateDurableWorkflowResults(
Assert.Equal("Terminated intentionally", (string)finalStatusResponseBody.output);
});
}

[Fact]
public async Task DurableClientSuspendOrchestration()
{
var initialResponse = await Utilities.GetHttpStartResponse(
orchestratorName: "SendDurableExternalEventOrchestrator",
clientRoute: "suspendingOrchestrators");
Assert.Equal(HttpStatusCode.Accepted, initialResponse.StatusCode);

await ValidateDurableWorkflowResults(
initialResponse,
validateIntermediateResponse: (dynamic intermediateStatusResponseBody) =>
{
Assert.Equal("Suspended", (string)intermediateStatusResponseBody.runtimeStatus);
Assert.Equal("Suspend orchestrator", (string)intermediateStatusResponseBody.output);
});

await ValidateDurableWorkflowResults(
initialResponse,
validateIntermediateResponse: (dynamic intermediateStatusResponseBody) =>
{
Assert.Equal("Running", (string)intermediateStatusResponseBody.runtimeStatus);
},
validateFinalResponse: (dynamic finalStatusResponseBody) =>
{
Assert.Equal("Completed", (string)finalStatusResponseBody.runtimeStatus);
Assert.Equal("FirstTimeout", finalStatusResponseBody.output[0].ToString());
Assert.Equal("SecondExternalEvent", finalStatusResponseBody.output[1].ToString());
});
}
}
}
25 changes: 25 additions & 0 deletions test/E2E/durableApp/DurableClientSuspending/function.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"bindings": [
{
"authLevel": "function",
"name": "Request",
"type": "httpTrigger",
"direction": "in",
"route": "suspendingOrchestrators/{FunctionName}",
"methods": [
"post",
"get"
]
},
{
"type": "http",
"direction": "out",
"name": "Response"
},
{
"name": "starter",
"type": "durableClient",
"direction": "in"
}
]
}
23 changes: 23 additions & 0 deletions test/E2E/durableApp/DurableClientSuspending/run.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
param($Request, $TriggerMetadata)
$ErrorActionPreference = 'Stop'

Write-Host "DurableClientSuspending started"

$OrchestratorInputs = @{ FirstDuration = 5; SecondDuration = 60 }

$FunctionName = $Request.Params.FunctionName
$InstanceId = Start-DurableOrchestration -FunctionName $FunctionName -InputObject $OrchestratorInputs
Write-Host "Started orchestration with ID = '$InstanceId'"

Start-Sleep -Seconds 5
Suspend-DurableOrchestration -InstanceId $InstanceId -Reason 'Suspend orchestrator'

$SuspendResponse = New-DurableOrchestrationCheckStatusResponse -Request $Request -InstanceId $InstanceId
Push-OutputBinding -Name Response -Value $SuspendResponse

Start-Sleep -Seconds 10
Resume-DurableOrchestration -InstanceId $InstanceId -Reason 'Resume orchestrator'

Send-DurableExternalEvent -InstanceId $InstanceId -EventName "SecondExternalEvent"

Write-Host "DurableClientSuspending completed"