This repository has been archived by the owner on Nov 6, 2023. It is now read-only.
forked from slackapi/node-slack-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
data-store.js
463 lines (344 loc) · 10.1 KB
/
data-store.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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
/* eslint no-unused-vars: 0 */
/**
* Interface for creating a data store object for caching information from the Slack APIs.
*/
var bind = require('lodash').bind;
var forEach = require('lodash').forEach;
var isUndefined = require('lodash').isUndefined;
var RTM_API_EVENTS = require('../clients/events/rtm').EVENTS;
var getLogger = require('../helpers').getLogger;
var makeMessageEventWithSubtype = require('../clients/events/utils').makeMessageEventWithSubtype;
var messageHandlers = require('./message-handlers');
var models = require('../models');
/**
*
* @param {Object} opts
* @param {string=} opts.logLevel The log level for the logger.
* @param {Function=} opts.logger Function to use for log calls, takes (logLevel, logString) params.
* @constructor
*/
function SlackDataStore(opts) {
var dataStoreOpts = opts || {};
/**
* The logger function attached to this client.
* @type {Function}
*/
this.logger = dataStoreOpts.logger || getLogger(dataStoreOpts.logLevel);
forEach(messageHandlers, bind(function anonRegisterMessageHandler(handler, event) {
this.registerMessageHandler(event, handler);
}, this));
}
/**
* @type {Object}
* @private
*/
SlackDataStore.prototype._messageHandlers = {};
/**
* Sets a handler to save RTM event data to the data-store.
* @param {string} event
* @param {function} handler
*/
SlackDataStore.prototype.registerMessageHandler = function registerMessageHandler(event, handler) {
this._messageHandlers[event] = handler;
};
/**
* Clears the data store and re-sets it to the required starting state.
*/
SlackDataStore.prototype.clear = function clear() {
};
// ###############################################
// Getters
// ###############################################
/**
* Returns the User object matching the supplied id.
* @param {string} userId
* @returns {Object}
*/
SlackDataStore.prototype.getUserById = function getUserById(userId) {
};
/**
* Returns the User object matching the supplied name.
* @param {string} name
* @returns {Object}
*/
SlackDataStore.prototype.getUserByName = function getUserByName(name) {
};
/**
* Returns the User object matching the supplied email.
* @param {string} email
* @returns {Object}
*/
SlackDataStore.prototype.getUserByEmail = function getUserByEmail(email) {
};
/**
* Returns the User object matching the supplied bot ID.
* @param {string} botId
* @returns {Object}
*/
SlackDataStore.prototype.getUserByBotId = function getUserByBotId(botId) {
};
/**
* Returns the Channel object matching the supplied id.
* @param channelId
* @returns {Object}
*/
SlackDataStore.prototype.getChannelById = function getChannelById(channelId) {
};
/**
* Returns the Channel object matching the supplied name.
* @param name
* @returns {Object}
*/
SlackDataStore.prototype.getChannelByName = function getChannelByName(name) {
};
/**
* Returns the Group object matching the supplied id.
* @param groupId
* @returns {Object}
*/
SlackDataStore.prototype.getGroupById = function getGroupById(groupId) {
};
/**
* Returns the Group object matching the supplied name.
* @param name
* @returns {Object}
*/
SlackDataStore.prototype.getGroupByName = function getGroupByName(name) {
};
/**
* Returns the DM object matching the supplied id.
* @param dmId
* @returns {Object}
*/
SlackDataStore.prototype.getDMById = function getDMById(dmId) {
};
/**
* Returns the DM object between the registered user and the user with the supplied name.
* @param name
* @return {Object}
*/
SlackDataStore.prototype.getDMByName = function getDMByName(name) {
};
/**
* Returns the DM object between the registered user and the user with the supplied id.
* @param id
* @return {Object}
*/
SlackDataStore.prototype.getDMByUserId = function getDMByName(userId) {
};
/**
* Returns the bot object matching the supplied id.
* @param botId
* @returns {Object}
*/
SlackDataStore.prototype.getBotById = function getBotById(botId) {
};
/**
* Returns the bot object matching the supplied name.
* @param {string} name
* @returns {Object}
*/
SlackDataStore.prototype.getBotByName = function getBotByName(name) {
};
/**
* Returns the bot object matching the supplied user ID.
* @param userId
* @returns {Object}
*/
SlackDataStore.prototype.getBotByUserId = function getBotByUserId(userId) {
};
/**
* Returns the bot object matching the supplied name.
* @param {string} name
* @returns {Object}
*/
SlackDataStore.prototype.getTeamById = function getTeamById(name) {
};
/**
* Returns the unread count for all objects: channels, groups etc.
*/
SlackDataStore.prototype.getUnreadCount = function getUnreadCount() {
};
// ###############################################
// Setters
// ###############################################
/**
* Stores a channel object in the data store.
* @param {Object} channel
*/
SlackDataStore.prototype.setChannel = function setChannel(channel) {
};
/**
*
* @param {Object} group
*/
SlackDataStore.prototype.setGroup = function setGroup(group) {
};
/**
*
* @param {Object} dm
*/
SlackDataStore.prototype.setDM = function setDM(dm) {
};
/**
*
* @param {Object} user
*/
SlackDataStore.prototype.setUser = function setUser(user) {
};
/**
*
* @param {Object} bot
*/
SlackDataStore.prototype.setBot = function setBot(bot) {
};
/**
* @param {Object} team
*/
SlackDataStore.prototype.setTeam = function setTeam(team) {
};
// ###############################################
// Upserts
// ###############################################
/** @param channel */
SlackDataStore.prototype.upsertChannel = function upsertChannel(channel) {
};
/** @param group */
SlackDataStore.prototype.upsertGroup = function upsertGroup(group) {
};
/** @param dm */
SlackDataStore.prototype.upsertDM = function upsertDM(dm) {
};
/** @param user */
SlackDataStore.prototype.upsertUser = function upsertUser(user) {
};
/** @param bot */
SlackDataStore.prototype.upsertBot = function upsertBot(bot) {
};
/** @param team */
SlackDataStore.prototype.upsertTeam = function upsertTeam(team) {
};
// ###############################################
// Deletion methods
// ###############################################
SlackDataStore.prototype.removeChannel = function removeChannel(channelId) {
};
SlackDataStore.prototype.removeGroup = function removeGroup(groupId) {
};
SlackDataStore.prototype.removeDM = function removeDM(dmId) {
};
SlackDataStore.prototype.removeUser = function removeUser(userId) {
};
SlackDataStore.prototype.removeBot = function removeBot(botId) {
};
SlackDataStore.prototype.removeTeam = function removeTeam(teamId) {
};
// ###############################################
// Helpers
// ###############################################
/**
*
* @param id
* @param obj
*/
SlackDataStore.prototype.upsertChannelGroupOrDMById = function upsertChannelGroupOrDMById(id, obj) {
var firstChar = id.substring(0, 1);
if (firstChar === 'C') {
this.upsertChannel(obj);
} else if (firstChar === 'G') {
this.upsertGroup(obj);
} else if (firstChar === 'D') {
this.upsertDM(obj);
}
};
/**
* Returns the channel, group or DM object matching the supplied Id.
* @param objId
* @returns {Object}
*/
SlackDataStore.prototype.getChannelGroupOrDMById = function getChannelGroupOrDMById(objId) {
var ret;
var firstChar = objId.substring(0, 1);
if (firstChar === 'C') {
ret = this.getChannelById(objId);
} else if (firstChar === 'G') {
ret = this.getGroupById(objId);
} else if (firstChar === 'D') {
ret = this.getDMById(objId);
}
return ret;
};
/**
* Returns the channel or group object matching name, finding by channel, then group then DM.
* @param objId
* @returns {Object}
*/
SlackDataStore.prototype.getChannelOrGroupByName = function getChannelOrGroupByName(name) {
var channel = this.getChannelByName(name);
return channel || this.getGroupByName(name);
};
// ###############################################
// Web API response handlers
// ###############################################
/**
* Caches an {@link https://api.slack.com/methods/rtm.start|rtm.start} response to the datastore.
* @param {Object} data
*/
SlackDataStore.prototype.cacheRtmStart = function cacheRtmStart(data) {
this.clear();
forEach(data.users || [], bind(function cacheRtmUser(user) {
this.setUser(new models.User(user));
}, this));
forEach(data.channels || [], bind(function cacheRtmChannel(channel) {
this.setChannel(new models.Channel(channel));
}, this));
forEach(data.ims || [], bind(function cacheRtmDM(dm) {
this.setDM(new models.DM(dm));
}, this));
forEach(data.groups || [], bind(function cacheRtmGroup(group) {
this.setGroup(new models.Group(group));
}, this));
forEach(data.bots || [], bind(function cacheRtmBot(bot) {
// Bots don't have a separate type currently, so treat them as simple objects
this.setBot(bot);
}, this));
this.getUserById(data.self.id).update(data.self);
this.setTeam(data.team);
};
// ###############################################
// RTM Message handlers
// ###############################################
/**
*
* @param {string} activeUserId
* @param {string} activeTeamId
* @param {string} messageType
* @param {Object} message
*/
SlackDataStore.prototype.handleRtmMessage = function handleRtmMessage(
activeUserId, activeTeamId, messageType, message) {
var handler;
if (messageType === RTM_API_EVENTS.MESSAGE && !isUndefined(message.subtype)) {
handler = this._messageHandlers[makeMessageEventWithSubtype(message.subtype)];
// If there's a custom handler for the message subtype, use that, otherwise default to adding
// the message to the base channel history
handler = handler || this._messageHandlers[
makeMessageEventWithSubtype('rtm_client_add_message')];
} else {
handler = this._messageHandlers[messageType];
}
if (!isUndefined(handler)) {
try {
// Some handlers require the active user / team id, so support providing it as needed
if (handler.length === 4) {
handler(activeUserId, activeTeamId, this, message);
} else {
handler(this, message);
}
} catch (err) {
// TODO(leah): Do something more here?
this.logger('debug', err);
}
}
};
module.exports = SlackDataStore;