Add RetryOptions alias, add Get-DurableTaskResult + E2E test (#45)

Author: davidmrdavid

src/AzureFunctions.PowerShell.Durable.SDK.psd1

@@ -73,13 +73,14 @@
     CmdletsToExport = @(
        'Invoke-DurableActivity',
        'Invoke-DurableSubOrchestrator',
-       'New-DurableRetryOptionsE',
+       'New-DurableRetryPolicy',
        'Set-DurableCustomStatus',
        'Set-FunctionInvocationContext',
        'Start-DurableExternalEventListener'
        'Start-DurableTimer',
        'Stop-DurableTimerTask',
-       'Wait-DurableTask'
+       'Wait-DurableTask',
+       'Get-DurableTaskResult'
     )
 
     # Variables to export from this module
@@ -90,7 +91,8 @@
         'Invoke-ActivityFunction',
         'New-OrchestrationCheckStatusResponse',
         'Start-NewOrchestration',
-        'Wait-ActivityFunction'
+        'Wait-ActivityFunction',
+        'New-DurableRetryOptions'
     )
 
     # DSC resources to export from this module

src/AzureFunctions.PowerShell.Durable.SDK.psm1

@@ -10,11 +10,12 @@ Set-Alias -Name Wait-ActivityFunction -Value Wait-DurableTask
 Set-Alias -Name Invoke-ActivityFunction -Value Invoke-DurableActivity
 Set-Alias -Name New-OrchestrationCheckStatusResponse -Value New-DurableOrchestrationCheckStatusResponse
 Set-Alias -Name Start-NewOrchestration -Value Start-DurableOrchestration
+Set-Alias -Name New-DurableRetryOptions -Value New-DurableRetryPolicy
 
 function GetDurableClientFromModulePrivateData {
     $PrivateData = $PSCmdlet.MyInvocation.MyCommand.Module.PrivateData
     if ($null -eq $PrivateData -or $null -eq $PrivateData['DurableClient']) {
-        throw "No binding of the type 'durableClient' was defined."
+        throw "Could not find `DurableClient` private data. This can occur when you have not set application setting 'ExternalDurablePowerShellSDK' to 'true' or if you're using a DurableClient CmdLet but have no DurableClient binding declared in `function.json`."
     }
     else {
         $PrivateData['DurableClient']

src/DurableEngine/Actions/CallActivityWithRetryAction.cs

@@ -28,12 +28,12 @@ internal class CallActivityWithRetryAction : OrchestrationAction
         /// </summary>
         public readonly Dictionary<string, object> RetryOptions;
 
-        internal CallActivityWithRetryAction(string functionName, object input, RetryOptions retryOptions)
+        internal CallActivityWithRetryAction(string functionName, object input, RetryPolicy retryOptions)
             : base(ActionType.CallActivityWithRetry)
         {
             FunctionName = functionName;
             Input = input;
-            RetryOptions = retryOptions.RetryOptionsDictionary;
+            RetryOptions = retryOptions.RetryPolicyDictionary;
         }  
     }
 }

src/DurableEngine/Actions/CallSubOrchestratorWithRetryAction.cs

@@ -29,13 +29,13 @@ internal class CallSubOrchestratorWithRetryAction : OrchestrationAction
         /// </summary>
         public readonly Dictionary<string, object> RetryOptions;
 
-        internal CallSubOrchestratorWithRetryAction(string functionName, object input, string instanceId, RetryOptions retryOptions)
+        internal CallSubOrchestratorWithRetryAction(string functionName, object input, string instanceId, RetryPolicy retryOptions)
             : base(ActionType.CallSubOrchestratorWithRetry)
         {
             FunctionName = functionName;
             InstanceId = instanceId;
             Input = input;
-            RetryOptions = retryOptions.RetryOptionsDictionary;
+            RetryOptions = retryOptions.RetryPolicyDictionary;
         }
     }
 }

src/DurableEngine/RetryOptions.cs

@@ -14,12 +14,12 @@ namespace DurableEngine
     /// <summary>
     /// Defines retry policies that can be passed as parameters to various operations.
     /// </summary>
-    public class RetryOptions : RetryPolicy
+    public class RetryPolicy : Microsoft.DurableTask.RetryPolicy
     {
-        internal Dictionary<string, object> RetryOptionsDictionary { get; set; }
+        internal Dictionary<string, object> RetryPolicyDictionary { get; set; }
 
         /// <inheritdoc/>
-        public RetryOptions(
+        public RetryPolicy(
             int maxNumberOfAttempts,
             TimeSpan firstRetryInterval,
             double backoffCoefficient,
@@ -40,14 +40,14 @@ public RetryOptions(
             // defaults for the optional MaxRetryInterval and RetryTimeOut parameters. Furthermore,
             // of RetryOptions cannot be modified after construction, so it is safe to do this eager
             // serialization in the constructor.
-            RetryOptionsDictionary = new Dictionary<string, object>()
+            RetryPolicyDictionary = new Dictionary<string, object>()
                             {
                                 { "firstRetryIntervalInMilliseconds", ToIntMilliseconds(firstRetryInterval) },
                                 { "maxNumberOfAttempts", maxNumberOfAttempts },
                                 { "backoffCoefficient", backoffCoefficient }
                             };
-            AddOptionalValue(RetryOptionsDictionary, "maxRetryIntervalInMilliseconds", maxRetryInterval, ToIntMilliseconds);
-            AddOptionalValue(RetryOptionsDictionary, "maxRetryIntervalInMilliseconds", retryTimeout, ToIntMilliseconds);
+            AddOptionalValue(RetryPolicyDictionary, "maxRetryIntervalInMilliseconds", maxRetryInterval, ToIntMilliseconds);
+            AddOptionalValue(RetryPolicyDictionary, "maxRetryIntervalInMilliseconds", retryTimeout, ToIntMilliseconds);
         }
 
         private static void AddOptionalValue<T>(

src/DurableEngine/Tasks/ActivityInvocationTask.cs

@@ -22,12 +22,12 @@ public class ActivityInvocationTask : DurableTask
 
         internal object Input { get; }
 
-        private RetryOptions RetryOptions { get; }
+        private DurableEngine.RetryPolicy RetryOptions { get; }
 
         public ActivityInvocationTask(
             string functionName,
             object functionInput,
-            RetryOptions retryOptions,
+            DurableEngine.RetryPolicy retryOptions,
             SwitchParameter noWait,
             Hashtable privateData) : base(noWait, privateData)
         {

src/DurableEngine/Tasks/DurableTask.cs

@@ -3,6 +3,7 @@
 using System.Collections;
 using System.Management.Automation;
 using System.Threading.Tasks;
+using static System.Collections.Specialized.BitVector32;
 
 namespace DurableEngine.Tasks
 {
@@ -17,6 +18,17 @@ public DurableTask(SwitchParameter noWait, Hashtable privateData)
             OrchestrationContext = (OrchestrationContext)privateData[OrchestrationInvoker.ContextKey];
         }
 
+        private OrchestrationAction action;
+
+        internal OrchestrationAction GetOrCreateAction()
+        {
+            if (this.action == null)
+            {
+                this.action = this.CreateOrchestrationAction();
+            }
+            return this.action;
+        }
+
         /// <summary>
         /// The orchestrator context.
         /// </summary>
@@ -49,7 +61,13 @@ public void Execute(Action<object> write, Action<ErrorRecord> writeErr)
             {
                 // Flag this task as the current "task-to-await"
                 OrchestrationContext.SharedMemory.currTask = task;
-                OrchestrationContext.SharedMemory.Add(task.CreateOrchestrationAction());
+
+                // DF APIs only generate an action once, otherwise we'll get duplicate executions
+                if (task.action == null)
+                {
+                    // generate and cache action
+                    OrchestrationContext.SharedMemory.Add(task.GetOrCreateAction());
+                }
 
                 // Signal orchestration thread to await the Task.
                 // This is necessary for DTFx to determine if a result exists for the Task.

src/DurableEngine/Tasks/SubOrchestratorTask.cs

@@ -18,13 +18,13 @@ public class SubOrchestratorTask : DurableTask
 
         internal object Input { get; }
 
-        private RetryOptions RetryOptions { get; }
+        private RetryPolicy RetryOptions { get; }
 
         public SubOrchestratorTask(
             string functionName,
             string instanceId,
             object functionInput,
-            RetryOptions retryOptions,
+            RetryPolicy retryOptions,
             SwitchParameter noWait,
             Hashtable privateData) : base(noWait, privateData)
         {

src/DurableEngine/Tasks/WhenAllTask.cs

@@ -43,7 +43,7 @@ internal override Task CreateDTFxTask()
 
         internal override OrchestrationAction CreateOrchestrationAction()
         {
-            var compoundActions = Tasks.Select((task) => task.CreateOrchestrationAction()).ToArray();
+            var compoundActions = Tasks.Select((task) => task.GetOrCreateAction()).ToArray();
             var orchestrationAction = new WhenAllAction(compoundActions);
             return orchestrationAction;
         }

src/DurableEngine/Tasks/WhenAnyTask.cs

@@ -41,7 +41,7 @@ internal override Task CreateDTFxTask()
 
         internal override OrchestrationAction CreateOrchestrationAction()
         {
-            var compoundActions = Tasks.Select((task) => task.CreateOrchestrationAction()).ToArray();
+            var compoundActions = Tasks.Select((task) => task.GetOrCreateAction()).ToArray();
             var action = new WhenAnyAction(compoundActions);
             return action;
         }