Add suspend-resume support for durable client (#72)

As titled.

Author: nytian

src/AzureFunctions.PowerShell.Durable.SDK.psd1

@@ -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.

src/AzureFunctions.PowerShell.Durable.SDK.psm1

@@ -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')
 }

test/E2E/AzureFunctions.PowerShell.Durable.SDK.E2E/DurableClientTests.cs

@@ -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());
+                });
+        }
     }
 }

test/E2E/durableApp/DurableClientSuspending/function.json

@@ -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"
+    }    
+  ]
+}

test/E2E/durableApp/DurableClientSuspending/run.ps1

@@ -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"