-
Notifications
You must be signed in to change notification settings - Fork 7
/
dialog.js
251 lines (206 loc) · 6.92 KB
/
dialog.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
var series = require('async-series');
var util = require('util');
var EventEmitter = require('events');
function toRegExp(s) {
if (s instanceof RegExp)
return s;
else
if (typeof s === 'string' || s instanceof String)
{
// create a regex to parse a regex, hopefully without creating an infinite space-time vortex
var regex = new RegExp('^/(.+)/(.*)$');
var match = s.match(regex);
if (match) {
return new RegExp(match[1], match[2]);
}
}
return new RegExp(s.toString());
};
/**
* Starts a new dialog with a user
* @param {Conversation} switchBoard
* @param {Hubot.Response} msg
* @param {Array} messageOptions - refer to docs in index.js `Conversation.prototype.start`
* @api private
*/
function Dialog(switchBoard, msg, messageOptions, robot) {
EventEmitter.call(this);
this.dialog = switchBoard.startDialog(msg, messageOptions.timeout ? messageOptions.timeout : Dialog.TIMEOUT, messageOptions.onTimeoutMessage);
this.msg = msg;
this.messageOptions = messageOptions;
this.robot = robot;
this.data = {
source: '',
dateTime: null,
answers: [],
aborted: false
};
this.data.source = msg.envelope.user;
this.data.robot = { name: robot.name, alias: robot.alias };
}
util.inherits(Dialog, EventEmitter);
/**
* Strip the bot's name from the description text
* @param {String} text
* @return {String}
* Implemented from https://github.com/timkinnane/hubot-rocketchat-announcement/blob/master/src/rocketchat-announcement.coffee#L46-L54
*/
Dialog.prototype._stripBotName = function (text) {
var match = text.match(new RegExp("^(@?(?:"+ this.robot.name + "|" + this.robot.alias + "|hubot):?)?(.*)", "i"));
return match[2].trim();
};
Dialog.prototype.updateAnswers = function (message, key, value) {
var currAnswer = {
question: message.question,
response: {
type: message.answer.type
}
};
currAnswer.response[key] = value;
this.data.answers.push(currAnswer);
};
Dialog.prototype.addSkip = function (message, done) {
var self = this;
if (!message.required)
{
skipKeyword = self.messageOptions.skipKeyword || /\bskip\b$/i; // because we need a default 'skip' keyword
self.dialog.addChoice(toRegExp(skipKeyword), function (dialogMessage) {
self.msg = dialogMessage;
done();
});
}
};
Dialog.prototype.addAbort = function (done) {
var self = this;
if (self.messageOptions.abortKeyword) {
self.dialog.addChoice(toRegExp(this.messageOptions.abortKeyword), function (dialogMessage) {
self.msg = dialogMessage;
self.data.aborted = true;
if (self.messageOptions.onAbortMessage)
self.msg.sendDirect(self.messageOptions.onAbortMessage);
done(new Error('Aborted'));
});
}
};
/**
* Invoke a dialog message with the user and collect the response into the data
* @param {Object} message It holds the message model
* eg. {
* question: 'Do you have any trouble',
* answer: {
* type: 'text'
* },
* required: false,
* error: 'Sorry, did not understand response'
* }
* @param {Function} done The function provided by async-series to call the next dialog message
* @return {null}
* @api private
*/
Dialog.prototype._invokeDialog = function (message, done) {
var self = this;
var question = message.question;
var code = question.charCodeAt(question.length - 1);
if (message.required === false)
{
skipMessage = self.messageOptions.skipMessage || '(or say [skip] to continue)';
question += ' ' + skipMessage;
}
self.msg.sendDirect(question);
self.addSkip(message, done);
self.addAbort(done);
if (message.answer.type === 'choice') self.addChoiceQuestion(message, done);
if (message.answer.type === 'text') self.addTextQuestion(message, done);
if (message.answer.type === 'attachment') self.addAttachmentQuestion(message, done);
};
Dialog.prototype.addAttachmentQuestion = function (message, done) {
var self = this;
self.dialog.addChoice(/.*/, function (dialogMessage) {
if (dialogMessage.message.attachment && dialogMessage.message.attachment.type === 'image') {
self.updateAnswers(message, 'value', dialogMessage.message.attachment.link);
self.msg = dialogMessage;
return done();
}
dialogMessage.sendDirect(message.error);
self.addSkip(message, done);
self.addAbort(done);
self.addAttachmentQuestion(message, done);
});
};
Dialog.prototype.addTextQuestion = function (message, done) {
var self = this;
self.dialog.addChoice(/^(?!\s*$).+/i, function (dialogMessage) {
self.updateAnswers(message, 'value', self._stripBotName(dialogMessage.message.text));
self.msg = dialogMessage;
done();
});
};
Dialog.prototype.addChoiceQuestion = function (message, done) {
var self = this;
for (var j = 0, len = message.answer.options.length; j < len; j++) {
(function choiceRunner(choiceIndex) {
var option = message.answer.options[choiceIndex];
self.dialog.addChoice(toRegExp(option.match), function (dialogMessage) {
if (option.response)
dialogMessage.sendDirect(option.response);
self.updateAnswers(message, 'value', self._stripBotName(dialogMessage.message.text));
if (!option.valid) {
return done(new Error('User provided an invalid response'));
}
self.msg = dialogMessage;
done();
});
})(j);
}
self.dialog.addChoice(/(.*)/i, function (dialogMessage) {
dialogMessage.sendDirect(message.error);
self.msg = dialogMessage;
self.addSkip(message, done);
self.addAbort(done);
self.addChoiceQuestion(message, done);
});
};
/**
* Gets the data for the dialog
* @return {Object} The object that describes the dialog
* @api public
*/
Dialog.prototype.fetch = function () {
return this.data;
};
/**
* Starts the dialog with the user
* @return {null}
* @api public
*/
Dialog.prototype.start = function () {
var self = this;
var cbs = [];
// set all the dialog messages as callback functions that will be run in series
// that means the next question won't be asked until the previous one has been
// dealt with
for (var i = 0, l = self.messageOptions.conversation.length; i < l; i++) {
(function (currIndex) {
var message = self.messageOptions.conversation[currIndex];
cbs.push(function (done) {
self._invokeDialog(message, done);
});
})(i);
}
// if (self.messageOptions.abortKeyword) self.msg.sendDirect('You can cancel this conversation with [' + self.messageOptions.abortKeyword + '].');
// call the callbacks in series
// emit 'end' when all is done or an error occurs
series(cbs, function (err) {
self.data.dateTime = new Date();
if (!self.data.aborted && self.messageOptions.onCompleteMessage)
self.msg.sendDirect(self.messageOptions.onCompleteMessage);
return self.emit('end', err, self.msg);
});
};
Dialog.TIMEOUT = 3 * 60 * 1000; // 3 minute timeout
/**
* Module exports
* @type {Dialog}
* @public
*/
module.exports = Dialog;