Kyled/waterfall cancel telemetry

libraries/botbuilder-dialogs/src/waterfallDialog.ts

@@ -245,7 +245,7 @@ export class WaterfallDialog<O extends object = {}> extends Dialog<O> {
                 'InstanceId': instanceId,
             }});
         } else if (reason === DialogReason.cancelCalled) {
-            var index = instance.state[state.stepIndex];
+            var index = state.stepIndex;
             var stepName = this.waterfallStepName(index);
             this.telemetryClient.trackEvent({name: 'WaterfallCancel', properties: {
                 'DialogId': this.id,

libraries/botbuilder-dialogs/tests/waterfallDialog.test.js

@@ -1,5 +1,5 @@
 const { ActivityTypes, ConversationState, MemoryStorage, TestAdapter } = require('botbuilder-core');
-const { Dialog, DialogSet, WaterfallDialog, DialogTurnStatus } = require('../');
+const { Dialog, DialogReason, DialogSet, DialogTurnStatus, WaterfallDialog } = require('../');
 
 const assert = require('assert');
 
@@ -29,7 +29,6 @@ class MyWaterfall extends WaterfallDialog {
     }
 }
 
-
 describe('WaterfallDialog', function () {
     this.timeout(5000);
 
@@ -614,4 +613,25 @@ describe('WaterfallDialog', function () {
             .assertReply('done.')
             .startTest();
     });
+
+    it('should record the correct step name when cancelled.', async function() {
+        const id = 'waterfall';
+        const index = 1;
+        const dialog = new MyWaterfall(id);
+        var trackEventCalled;
+        dialog.telemetryClient = {
+            trackEvent(telemetry) {
+                assert(telemetry.properties.StepName == dialog.steps[index].name, `telemetry contains incorrect step name: "${telemetry.properties.StepName}"`);
+                trackEventCalled = true;
+            }
+        };
+        await dialog.endDialog({}, {
+            id,
+            state: {
+                stepIndex: index,
+                values: { instanceId: '(guid)' }
+            }
+        }, DialogReason.cancelCalled);
+        assert(trackEventCalled, 'trackEvent was never called.');
+    });
 });