remove input and output bindings

remove bindingpath
more unit tests

Author: Tom Laird-McConnell

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive/Actions/BaseInvokeDialog.cs

@@ -17,7 +17,7 @@ public abstract class BaseInvokeDialog : DialogAction
         // Expression for dialogId to call (allowing dynamic expression)
         private string dialogIdToCall;
 
-        public BaseInvokeDialog(string dialogIdToCall = null, string property = null, IDictionary<string, string> bindingOptions = null)
+        public BaseInvokeDialog(string dialogIdToCall = null, IDictionary<string, string> bindingOptions = null)
             : base()
         {
             this.dialogIdToCall = dialogIdToCall;
@@ -26,11 +26,6 @@ public BaseInvokeDialog(string dialogIdToCall = null, string property = null, ID
             {
                 this.Options = bindingOptions;
             }
-
-            if (!string.IsNullOrEmpty(property))
-            {
-                Property = property;
-            }
         }
 
         /// <summary>
@@ -46,26 +41,6 @@ public BaseInvokeDialog(string dialogIdToCall = null, string property = null, ID
         /// </summary>
         public Dialog Dialog { get; set; }
 
-        /// <summary>
-        /// Gets or sets the property from memory to pass to the calling dialog and to set the return value to.
-        /// </summary>
-        /// <value>
-        /// The property from memory to pass to the calling dialog and to set the return value to.
-        /// </value>
-        public string Property
-        {
-            get
-            {
-                return InputBindings.TryGetValue(DialogPath.VALUE, out string value) ? value : null;
-            }
-
-            set
-            {
-                InputBindings[DialogPath.VALUE] = value;
-                OutputBinding = value;
-            }
-        }
-
         public override IEnumerable<Dialog> GetDependencies()
         {
             if (Dialog != null)
@@ -78,7 +53,7 @@ public override IEnumerable<Dialog> GetDependencies()
 
         protected override string OnComputeId()
         {
-            return $"{this.GetType().Name}[{Dialog?.Id ?? this.dialogIdToCall}:{this.BindingPath()}]";
+            return $"{this.GetType().Name}[{Dialog?.Id ?? this.dialogIdToCall}]";
         }
 
         protected Dialog ResolveDialog(DialogContext dc)

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive/Actions/BeginDialog.cs

@@ -16,12 +16,17 @@ namespace Microsoft.Bot.Builder.Dialogs.Adaptive.Actions
     public class BeginDialog : BaseInvokeDialog
     {
         [JsonConstructor]
-        public BeginDialog(string dialogIdToCall = null, string property = null, IDictionary<string, string> options = null, [CallerFilePath] string callerPath = "", [CallerLineNumber] int callerLine = 0)
-            : base(dialogIdToCall, property, options)
+        public BeginDialog(string dialogIdToCall = null, IDictionary<string, string> options = null, [CallerFilePath] string callerPath = "", [CallerLineNumber] int callerLine = 0)
+            : base(dialogIdToCall, options)
         {
             this.RegisterSourceLocation(callerPath, callerLine);
         }
 
+        /// <summary>
+        /// Gets or sets the property path to store the dialog result in
+        /// </summary>
+        public string ResultProperty { get; set; }
+
         protected async override Task<DialogTurnResult> OnRunCommandAsync(DialogContext dc, object options = null, CancellationToken cancellationToken = default(CancellationToken))
         {
             if (options is CancellationToken)
@@ -37,5 +42,16 @@ public BeginDialog(string dialogIdToCall = null, string property = null, IDictio
             // start dialog with bound options passed in as the options
             return await dc.BeginDialogAsync(dialog.Id, options: boundOptions, cancellationToken: cancellationToken).ConfigureAwait(false);
         }
+
+        public async override Task<DialogTurnResult> ResumeDialogAsync(DialogContext dc, DialogReason reason, object result = null, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            if (this.ResultProperty != null)
+            {
+                dc.State.SetValue(this.ResultProperty, result);
+            }
+
+            // By default just end the current dialog and return result to parent.
+            return await dc.EndDialogAsync(result, cancellationToken).ConfigureAwait(false);
+        }
     }
 }

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive/Actions/CancelAllDialogs.cs

@@ -5,6 +5,7 @@
 using System.Runtime.CompilerServices;
 using System.Threading;
 using System.Threading.Tasks;
+using Microsoft.Bot.Builder.Expressions.Parser;
 using Newtonsoft.Json;
 
 namespace Microsoft.Bot.Builder.Dialogs.Adaptive.Actions
@@ -24,17 +25,11 @@ public CancelAllDialogs([CallerFilePath] string callerPath = "", [CallerLineNumb
         /// <summary>
         /// Gets or sets event name. 
         /// </summary>
-        /// <value>
-        /// Event name. 
-        /// </value>
         public string EventName { get; set; }
 
         /// <summary>
-        /// Gets or sets event value.
+        /// Gets or sets value expression for EventValue
         /// </summary>
-        /// <value>
-        /// Event value.
-        /// </value>
         public string EventValue { get; set; }
 
         protected override async Task<DialogTurnResult> OnRunCommandAsync(DialogContext dc, object options = null, CancellationToken cancellationToken = default(CancellationToken))
@@ -44,12 +39,13 @@ public CancelAllDialogs([CallerFilePath] string callerPath = "", [CallerLineNumb
                 throw new ArgumentException($"{nameof(options)} cannot be a cancellation token");
             }
 
-            return await CancelAllParentDialogsAsync(dc, eventName: EventName ?? "cancelDialog", eventValue: EventValue, cancellationToken: cancellationToken).ConfigureAwait(false);
-        }
+            object eventValue = null;
+            if (this.EventValue != null)
+            {
+                eventValue = new ExpressionEngine().Parse(this.EventValue).TryEvaluate(dc.State);
+            }
 
-        protected override string OnComputeId()
-        {
-            return "CancelDialog()";
+            return await CancelAllParentDialogsAsync(dc, eventName: EventName ?? "cancelDialog", eventValue: eventValue, cancellationToken: cancellationToken).ConfigureAwait(false);
         }
     }
 }

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive/Actions/Case.cs

@@ -25,18 +25,12 @@ public Case(string value = null, IEnumerable<Dialog> actions = null)
         /// <summary>
         /// Gets or sets value expression to be compared against condition.
         /// </summary>
-        /// <value>
-        /// Value expression to be compared against condition.
-        /// </value>
         [JsonProperty("value")]
         public string Value { get; set; }
 
         /// <summary>
         /// Gets or sets set of actions to be executed given that the condition of the switch matches the value of this case.
         /// </summary>
-        /// <value>
-        /// Set of actions to be executed given that the condition of the switch matches the value of this case.
-        /// </value>
         [JsonProperty("actions")]
         public List<Dialog> Actions { get; set; } = new List<Dialog>();
 

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive/Actions/CodeAction.cs

@@ -33,7 +33,7 @@ public CodeAction(CodeActionHandler codeHandler, [CallerFilePath] string callerP
 
         protected override string OnComputeId()
         {
-            return $"CodeAction({codeHandler.ToString()})";
+            return $"{this.GetType().Name}({codeHandler.ToString()})";
         }
     }
 }

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive/Actions/DeleteProperty.cs

@@ -32,11 +32,11 @@ public DeleteProperty(string property, [CallerFilePath] string callerPath = "",
         }
 
         /// <summary>
-        /// Gets or sets property to path to remove Example: user.age will remove "age" from "user".
+        /// Gets or sets property path to remove.
         /// </summary>
-        /// <value>
-        /// Property to path to remove Example: user.age will remove "age" from "user".
-        /// </value>
+        /// <example>
+        /// user.age will remove "age" from "user".
+        /// </example>
         public string Property { get; set; }
 
         protected override async Task<DialogTurnResult> OnRunCommandAsync(DialogContext dc, object options = null, CancellationToken cancellationToken = default(CancellationToken))

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive/Actions/EditActions.cs

@@ -84,7 +84,7 @@ public override IEnumerable<Dialog> GetDependencies()
         protected override string OnComputeId()
         {
             var idList = Actions.Select(s => s.Id);
-            return $"{nameof(EditActions)}({this.ChangeType}|{string.Join(",", idList)})";
+            return $"{this.GetType().Name}[{this.ChangeType}|{string.Join(",", idList)}]";
         }
     }
 }

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive/Actions/EditArray.cs

@@ -20,7 +20,7 @@ namespace Microsoft.Bot.Builder.Dialogs.Adaptive.Actions
     public class EditArray : DialogAction
     {
         private Expression value;
-        private Expression arrayProperty;
+        private Expression itemsProperty;
         private Expression resultProperty;
 
         /// <summary>
@@ -37,7 +37,7 @@ public EditArray(ArrayChangeType changeType, string arrayProperty = null, string
 
             if (!string.IsNullOrEmpty(arrayProperty))
             {
-                this.ArrayProperty = arrayProperty;
+                this.ItemsProperty = arrayProperty;
             }
 
             switch (changeType)
@@ -100,24 +100,18 @@ public enum ArrayChangeType
         public ArrayChangeType ChangeType { get; set; }
 
         /// <summary>
-        /// Gets or sets memory expression of the array to manipulate.
+        /// Gets or sets property path expression to the collection of items.
         /// </summary>
-        /// <value>
-        /// Memory expression of the array to manipulate.
-        /// </value>Edit
-        [JsonProperty("arrayProperty")]
-        public string ArrayProperty
+        [JsonProperty("itemsProperty")]
+        public string ItemsProperty
         {
-            get { return arrayProperty?.ToString(); }
-            set { this.arrayProperty = (value != null) ? new ExpressionEngine().Parse(value) : null; }
+            get { return itemsProperty?.ToString(); }
+            set { this.itemsProperty = (value != null) ? new ExpressionEngine().Parse(value) : null; }
         }
 
         /// <summary>
-        /// Gets or sets the result of the action.
+        /// Gets or sets the path expression to store the result of the action.
         /// </summary>
-        /// <value>
-        /// The result of the action.
-        /// </value>
         [JsonProperty("resultProperty")]
         public string ResultProperty
         {
@@ -126,11 +120,8 @@ public string ResultProperty
         }
 
         /// <summary>
-        /// Gets or sets the expression of the item to put onto the array.
+        /// Gets or sets the expression of the value to put onto the array.
         /// </summary>
-        /// <value>
-        /// The expression of the item to put onto the array.
-        /// </value>
         [JsonProperty("value")]
         public string Value
         {
@@ -140,7 +131,7 @@ public string Value
 
         protected override string OnComputeId()
         {
-            return $"array[{ChangeType + ": " + ArrayProperty}]";
+            return $"{this.GetType().Name}[{ChangeType + ": " + ItemsProperty}]";
         }
 
         protected override async Task<DialogTurnResult> OnRunCommandAsync(DialogContext dc, object options = null, CancellationToken cancellationToken = default(CancellationToken))
@@ -150,12 +141,12 @@ protected override string OnComputeId()
                 throw new ArgumentException($"{nameof(options)} cannot be a cancellation token");
             }
 
-            if (string.IsNullOrEmpty(ArrayProperty))
+            if (string.IsNullOrEmpty(ItemsProperty))
             {
                 throw new Exception($"EditArray: \"{ChangeType}\" operation couldn't be performed because the arrayProperty wasn't specified.");
             }
 
-            var array = dc.State.GetValue<JArray>(this.ArrayProperty, () => new JArray());
+            var array = dc.State.GetValue<JArray>(this.ItemsProperty, () => new JArray());
 
             object item = null;
             object result = null;
@@ -210,7 +201,7 @@ protected override string OnComputeId()
                     break;
             }
 
-            dc.State.SetValue(this.ArrayProperty, array);
+            dc.State.SetValue(this.ItemsProperty, array);
 
             if (ResultProperty != null)
             {
@@ -224,7 +215,7 @@ private void EnsureValue()
         {
             if (Value == null)
             {
-                throw new Exception($"EditArray: \"{ChangeType}\" operation couldn't be performed for array \"{ArrayProperty}\" because a value wasn't specified.");
+                throw new Exception($"EditArray: \"{ChangeType}\" operation couldn't be performed for array \"{ItemsProperty}\" because a value wasn't specified.");
             }
         }
     }

libraries/Microsoft.Bot.Builder.Dialogs.Adaptive/Actions/EmitEvent.cs

@@ -8,6 +8,9 @@
 
 namespace Microsoft.Bot.Builder.Dialogs.Adaptive.Actions
 {
+    /// <summary>
+    /// Action which emits an event declaratively
+    /// </summary>
     public class EmitEvent : DialogAction
     {
         private const string EventValuePropertyValue = "eventValue";
@@ -22,44 +25,36 @@ public EmitEvent(string eventName = null, object eventValue = null, bool bubble
             this.BubbleEvent = bubble;
         }
 
+        /// <summary>
+        /// Gets or sets the name of the event to emit
+        /// </summary>
         public string EventName { get; set; }
 
-        public object EventValue { get; set; }
+        /// <summary>
+        /// Gets or sets the object to send with the event
+        /// </summary>
+        public string EventValue { get; set; }
 
+        /// <summary>
+        /// Gets or sets whether the event should bubble or not
+        /// </summary>
         public bool BubbleEvent { get; set; }
 
-        public string EventValueProperty
-        {
-            get
-            {
-                if (InputBindings.ContainsKey(EventValuePropertyValue))
-                {
-                    return InputBindings[EventValuePropertyValue];
-                }
-
-                return string.Empty;
-            }
-
-            set
-            {
-                InputBindings[EventValuePropertyValue] = value;
-            }
-        }
-
         protected override async Task<DialogTurnResult> OnRunCommandAsync(DialogContext dc, object options = null, CancellationToken cancellationToken = default(CancellationToken))
         {
             if (options is CancellationToken)
             {
                 throw new ArgumentException($"{nameof(options)} cannot be a cancellation token");
             }
 
-            var handled = await dc.EmitEventAsync(EventName, EventValue, BubbleEvent, false, cancellationToken).ConfigureAwait(false);
+            var eventValue = (this.EventValue != null) ? dc.State.GetValue<object>(this.EventValue) : null;
+            var handled = await dc.EmitEventAsync(EventName, eventValue, BubbleEvent, false, cancellationToken).ConfigureAwait(false);
             return await dc.EndDialogAsync(handled, cancellationToken).ConfigureAwait(false);
         }
 
         protected override string OnComputeId()
         {
-            return $"EmitEvent[{EventName ?? string.Empty}]";
+            return $"{this.GetType().Name}[{EventName ?? string.Empty}]";
         }
     }
 }