UserSessionsManagerTests.coffee 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581
  1. sinon = require('sinon')
  2. chai = require('chai')
  3. should = chai.should()
  4. expect = chai.expect
  5. modulePath = "../../../../app/js/Features/User/UserSessionsManager.js"
  6. SandboxedModule = require('sandboxed-module')
  7. Async = require('async')
  8. describe 'UserSessionsManager', ->
  9. beforeEach ->
  10. @user =
  11. _id: "abcd"
  12. email: "user@example.com"
  13. @sessionId = 'some_session_id'
  14. @rclient =
  15. multi: sinon.stub()
  16. exec: sinon.stub()
  17. get: sinon.stub()
  18. del: sinon.stub()
  19. sadd: sinon.stub()
  20. srem: sinon.stub()
  21. smembers: sinon.stub()
  22. mget: sinon.stub()
  23. expire: sinon.stub()
  24. @rclient.multi.returns(@rclient)
  25. @rclient.get.returns(@rclient)
  26. @rclient.del.returns(@rclient)
  27. @rclient.sadd.returns(@rclient)
  28. @rclient.srem.returns(@rclient)
  29. @rclient.smembers.returns(@rclient)
  30. @rclient.expire.returns(@rclient)
  31. @rclient.exec.callsArgWith(0, null)
  32. @redis =
  33. client: () => @rclient
  34. @logger =
  35. err: sinon.stub()
  36. error: sinon.stub()
  37. log: sinon.stub()
  38. @settings =
  39. redis:
  40. web: {}
  41. @UserSessionsManager = SandboxedModule.require modulePath, requires:
  42. "logger-sharelatex": @logger
  43. "settings-sharelatex": @settings
  44. './UserSessionsRedis': @redis
  45. 'async': Async
  46. describe '_sessionSetKey', ->
  47. it 'should build the correct key', ->
  48. result = @UserSessionsManager._sessionSetKey(@user)
  49. result.should.equal 'UserSessions:{abcd}'
  50. describe '_sessionKey', ->
  51. it 'should build the correct key', ->
  52. result = @UserSessionsManager._sessionKey(@sessionId)
  53. result.should.equal 'sess:some_session_id'
  54. describe 'trackSession', ->
  55. beforeEach ->
  56. @call = (callback) =>
  57. @UserSessionsManager.trackSession @user, @sessionId, callback
  58. @rclient.exec.callsArgWith(0, null)
  59. @_checkSessions = sinon.stub(@UserSessionsManager, '_checkSessions').returns(null)
  60. afterEach ->
  61. @_checkSessions.restore()
  62. it 'should not produce an error', (done) ->
  63. @call (err) =>
  64. expect(err).to.not.be.instanceof Error
  65. done()
  66. it 'should call the appropriate redis methods', (done) ->
  67. @call (err) =>
  68. @rclient.multi.callCount.should.equal 1
  69. @rclient.sadd.callCount.should.equal 1
  70. @rclient.expire.callCount.should.equal 1
  71. @rclient.exec.callCount.should.equal 1
  72. done()
  73. it 'should call _checkSessions', (done) ->
  74. @call (err) =>
  75. @_checkSessions.callCount.should.equal 1
  76. done()
  77. describe 'when rclient produces an error', ->
  78. beforeEach ->
  79. @rclient.exec.callsArgWith(0, new Error('woops'))
  80. it 'should produce an error', (done) ->
  81. @call (err) =>
  82. expect(err).to.be.instanceof Error
  83. done()
  84. it 'should not call _checkSessions', (done) ->
  85. @call (err) =>
  86. @_checkSessions.callCount.should.equal 0
  87. done()
  88. describe 'when no user is supplied', ->
  89. beforeEach ->
  90. @call = (callback) =>
  91. @UserSessionsManager.trackSession null, @sessionId, callback
  92. it 'should not produce an error', (done) ->
  93. @call (err) =>
  94. expect(err).to.not.be.instanceof Error
  95. expect(err).to.equal null
  96. done()
  97. it 'should not call the appropriate redis methods', (done) ->
  98. @call (err) =>
  99. @rclient.multi.callCount.should.equal 0
  100. @rclient.sadd.callCount.should.equal 0
  101. @rclient.expire.callCount.should.equal 0
  102. @rclient.exec.callCount.should.equal 0
  103. done()
  104. it 'should not call _checkSessions', (done) ->
  105. @call (err) =>
  106. @_checkSessions.callCount.should.equal 0
  107. done()
  108. describe 'when no sessionId is supplied', ->
  109. beforeEach ->
  110. @call = (callback) =>
  111. @UserSessionsManager.trackSession @user, null, callback
  112. it 'should not produce an error', (done) ->
  113. @call (err) =>
  114. expect(err).to.not.be.instanceof Error
  115. expect(err).to.equal null
  116. done()
  117. it 'should not call the appropriate redis methods', (done) ->
  118. @call (err) =>
  119. @rclient.multi.callCount.should.equal 0
  120. @rclient.sadd.callCount.should.equal 0
  121. @rclient.expire.callCount.should.equal 0
  122. @rclient.exec.callCount.should.equal 0
  123. done()
  124. it 'should not call _checkSessions', (done) ->
  125. @call (err) =>
  126. @_checkSessions.callCount.should.equal 0
  127. done()
  128. describe 'untrackSession', ->
  129. beforeEach ->
  130. @call = (callback) =>
  131. @UserSessionsManager.untrackSession @user, @sessionId, callback
  132. @rclient.exec.callsArgWith(0, null)
  133. @_checkSessions = sinon.stub(@UserSessionsManager, '_checkSessions').returns(null)
  134. afterEach ->
  135. @_checkSessions.restore()
  136. it 'should not produce an error', (done) ->
  137. @call (err) =>
  138. expect(err).to.not.be.instanceof Error
  139. expect(err).to.equal undefined
  140. done()
  141. it 'should call the appropriate redis methods', (done) ->
  142. @call (err) =>
  143. @rclient.multi.callCount.should.equal 1
  144. @rclient.srem.callCount.should.equal 1
  145. @rclient.expire.callCount.should.equal 1
  146. @rclient.exec.callCount.should.equal 1
  147. done()
  148. it 'should call _checkSessions', (done) ->
  149. @call (err) =>
  150. @_checkSessions.callCount.should.equal 1
  151. done()
  152. describe 'when rclient produces an error', ->
  153. beforeEach ->
  154. @rclient.exec.callsArgWith(0, new Error('woops'))
  155. it 'should produce an error', (done) ->
  156. @call (err) =>
  157. expect(err).to.be.instanceof Error
  158. done()
  159. it 'should not call _checkSessions', (done) ->
  160. @call (err) =>
  161. @_checkSessions.callCount.should.equal 0
  162. done()
  163. describe 'when no user is supplied', ->
  164. beforeEach ->
  165. @call = (callback) =>
  166. @UserSessionsManager.untrackSession null, @sessionId, callback
  167. it 'should not produce an error', (done) ->
  168. @call (err) =>
  169. expect(err).to.not.be.instanceof Error
  170. expect(err).to.equal null
  171. done()
  172. it 'should not call the appropriate redis methods', (done) ->
  173. @call (err) =>
  174. @rclient.multi.callCount.should.equal 0
  175. @rclient.srem.callCount.should.equal 0
  176. @rclient.expire.callCount.should.equal 0
  177. @rclient.exec.callCount.should.equal 0
  178. done()
  179. it 'should not call _checkSessions', (done) ->
  180. @call (err) =>
  181. @_checkSessions.callCount.should.equal 0
  182. done()
  183. describe 'when no sessionId is supplied', ->
  184. beforeEach ->
  185. @call = (callback) =>
  186. @UserSessionsManager.untrackSession @user, null, callback
  187. it 'should not produce an error', (done) ->
  188. @call (err) =>
  189. expect(err).to.not.be.instanceof Error
  190. expect(err).to.equal null
  191. done()
  192. it 'should not call the appropriate redis methods', (done) ->
  193. @call (err) =>
  194. @rclient.multi.callCount.should.equal 0
  195. @rclient.srem.callCount.should.equal 0
  196. @rclient.expire.callCount.should.equal 0
  197. @rclient.exec.callCount.should.equal 0
  198. done()
  199. it 'should not call _checkSessions', (done) ->
  200. @call (err) =>
  201. @_checkSessions.callCount.should.equal 0
  202. done()
  203. describe 'revokeAllUserSessions', ->
  204. beforeEach ->
  205. @sessionKeys = ['sess:one', 'sess:two']
  206. @retain = []
  207. @rclient.smembers.callsArgWith(1, null, @sessionKeys)
  208. @rclient.del = sinon.stub().callsArgWith(1, null)
  209. @rclient.srem = sinon.stub().callsArgWith(2, null)
  210. @call = (callback) =>
  211. @UserSessionsManager.revokeAllUserSessions @user, @retain, callback
  212. it 'should not produce an error', (done) ->
  213. @call (err) =>
  214. expect(err).to.not.be.instanceof Error
  215. expect(err).to.equal null
  216. done()
  217. it 'should call the appropriate redis methods', (done) ->
  218. @call (err) =>
  219. @rclient.smembers.callCount.should.equal 1
  220. @rclient.del.callCount.should.equal 2
  221. expect(@rclient.del.firstCall.args[0]).to.deep.equal @sessionKeys[0]
  222. expect(@rclient.del.secondCall.args[0]).to.deep.equal @sessionKeys[1]
  223. @rclient.srem.callCount.should.equal 1
  224. expect(@rclient.srem.firstCall.args[1]).to.deep.equal @sessionKeys
  225. done()
  226. describe 'when a session is retained', ->
  227. beforeEach ->
  228. @sessionKeys = ['sess:one', 'sess:two', 'sess:three', 'sess:four']
  229. @retain = ['two']
  230. @rclient.smembers.callsArgWith(1, null, @sessionKeys)
  231. @rclient.del = sinon.stub().callsArgWith(1, null)
  232. @call = (callback) =>
  233. @UserSessionsManager.revokeAllUserSessions @user, @retain, callback
  234. it 'should not produce an error', (done) ->
  235. @call (err) =>
  236. expect(err).to.not.be.instanceof Error
  237. expect(err).to.equal null
  238. done()
  239. it 'should call the appropriate redis methods', (done) ->
  240. @call (err) =>
  241. @rclient.smembers.callCount.should.equal 1
  242. @rclient.del.callCount.should.equal @sessionKeys.length - 1
  243. @rclient.srem.callCount.should.equal 1
  244. done()
  245. it 'should remove all sessions except for the retained one', (done) ->
  246. @call (err) =>
  247. expect(@rclient.del.firstCall.args[0]).to.deep.equal('sess:one')
  248. expect(@rclient.del.secondCall.args[0]).to.deep.equal('sess:three')
  249. expect(@rclient.del.thirdCall.args[0]).to.deep.equal('sess:four')
  250. expect(@rclient.srem.firstCall.args[1]).to.deep.equal(['sess:one', 'sess:three', 'sess:four'])
  251. done()
  252. describe 'when rclient produces an error', ->
  253. beforeEach ->
  254. @rclient.del = sinon.stub().callsArgWith(1, new Error('woops'))
  255. it 'should produce an error', (done) ->
  256. @call (err) =>
  257. expect(err).to.be.instanceof Error
  258. done()
  259. it 'should not call rclient.srem', (done) ->
  260. @call (err) =>
  261. @rclient.srem.callCount.should.equal 0
  262. done()
  263. describe 'when no user is supplied', ->
  264. beforeEach ->
  265. @call = (callback) =>
  266. @UserSessionsManager.revokeAllUserSessions null, @retain, callback
  267. it 'should not produce an error', (done) ->
  268. @call (err) =>
  269. expect(err).to.not.be.instanceof Error
  270. expect(err).to.equal null
  271. done()
  272. it 'should not call the appropriate redis methods', (done) ->
  273. @call (err) =>
  274. @rclient.smembers.callCount.should.equal 0
  275. @rclient.del.callCount.should.equal 0
  276. @rclient.srem.callCount.should.equal 0
  277. done()
  278. describe 'when there are no keys to delete', ->
  279. beforeEach ->
  280. @rclient.smembers.callsArgWith(1, null, [])
  281. it 'should not produce an error', (done) ->
  282. @call (err) =>
  283. expect(err).to.not.be.instanceof Error
  284. expect(err).to.equal null
  285. done()
  286. it 'should not do the delete operation', (done) ->
  287. @call (err) =>
  288. @rclient.smembers.callCount.should.equal 1
  289. @rclient.del.callCount.should.equal 0
  290. @rclient.srem.callCount.should.equal 0
  291. done()
  292. describe 'touch', ->
  293. beforeEach ->
  294. @rclient.expire.callsArgWith(2, null)
  295. @call = (callback) =>
  296. @UserSessionsManager.touch @user, callback
  297. it 'should not produce an error', (done) ->
  298. @call (err) =>
  299. expect(err).to.not.be.instanceof Error
  300. expect(err).to.equal null
  301. done()
  302. it 'should call rclient.expire', (done) ->
  303. @call (err) =>
  304. @rclient.expire.callCount.should.equal 1
  305. done()
  306. describe 'when rclient produces an error', ->
  307. beforeEach ->
  308. @rclient.expire.callsArgWith(2, new Error('woops'))
  309. it 'should produce an error', (done) ->
  310. @call (err) =>
  311. expect(err).to.be.instanceof Error
  312. done()
  313. describe 'when no user is supplied', ->
  314. beforeEach ->
  315. @call = (callback) =>
  316. @UserSessionsManager.touch null, callback
  317. it 'should not produce an error', (done) ->
  318. @call (err) =>
  319. expect(err).to.not.be.instanceof Error
  320. expect(err).to.equal null
  321. done()
  322. it 'should not call expire', (done) ->
  323. @call (err) =>
  324. @rclient.expire.callCount.should.equal 0
  325. done()
  326. describe 'getAllUserSessions', ->
  327. beforeEach ->
  328. @sessionKeys = ['sess:one', 'sess:two', 'sess:three']
  329. @sessions = [
  330. '{"user": {"ip_address": "a", "session_created": "b"}}',
  331. '{"passport": {"user": {"ip_address": "c", "session_created": "d"}}}'
  332. ]
  333. @exclude = ['two']
  334. @rclient.smembers.callsArgWith(1, null, @sessionKeys)
  335. @rclient.get = sinon.stub()
  336. @rclient.get.onCall(0).callsArgWith(1, null, @sessions[0])
  337. @rclient.get.onCall(1).callsArgWith(1, null, @sessions[1])
  338. @call = (callback) =>
  339. @UserSessionsManager.getAllUserSessions @user, @exclude, callback
  340. it 'should not produce an error', (done) ->
  341. @call (err, sessions) =>
  342. expect(err).to.equal null
  343. done()
  344. it 'should get sessions', (done) ->
  345. @call (err, sessions) =>
  346. expect(sessions).to.deep.equal [
  347. { ip_address: 'a', session_created: 'b' },
  348. { ip_address: 'c', session_created: 'd' }
  349. ]
  350. done()
  351. it 'should have called rclient.smembers', (done) ->
  352. @call (err, sessions) =>
  353. @rclient.smembers.callCount.should.equal 1
  354. done()
  355. it 'should have called rclient.get', (done) ->
  356. @call (err, sessions) =>
  357. @rclient.get.callCount.should.equal @sessionKeys.length - 1
  358. done()
  359. describe 'when there are no other sessions', ->
  360. beforeEach ->
  361. @sessionKeys = ['sess:two']
  362. @rclient.smembers.callsArgWith(1, null, @sessionKeys)
  363. it 'should not produce an error', (done) ->
  364. @call (err, sessions) =>
  365. expect(err).to.equal null
  366. done()
  367. it 'should produce an empty list of sessions', (done) ->
  368. @call (err, sessions) =>
  369. expect(sessions).to.deep.equal []
  370. done()
  371. it 'should have called rclient.smembers', (done) ->
  372. @call (err, sessions) =>
  373. @rclient.smembers.callCount.should.equal 1
  374. done()
  375. it 'should not have called rclient.mget', (done) ->
  376. @call (err, sessions) =>
  377. @rclient.mget.callCount.should.equal 0
  378. done()
  379. describe 'when smembers produces an error', ->
  380. beforeEach ->
  381. @rclient.smembers.callsArgWith(1, new Error('woops'))
  382. it 'should produce an error', (done) ->
  383. @call (err, sessions) =>
  384. expect(err).to.not.equal null
  385. expect(err).to.be.instanceof Error
  386. done()
  387. it 'should not have called rclient.mget', (done) ->
  388. @call (err, sessions) =>
  389. @rclient.mget.callCount.should.equal 0
  390. done()
  391. describe 'when get produces an error', ->
  392. beforeEach ->
  393. @rclient.get = sinon.stub().callsArgWith(1, new Error('woops'))
  394. it 'should produce an error', (done) ->
  395. @call (err, sessions) =>
  396. expect(err).to.not.equal null
  397. expect(err).to.be.instanceof Error
  398. done()
  399. describe '_checkSessions', ->
  400. beforeEach ->
  401. @call = (callback) =>
  402. @UserSessionsManager._checkSessions @user, callback
  403. @sessionKeys = ['one', 'two']
  404. @rclient.smembers.callsArgWith(1, null, @sessionKeys)
  405. @rclient.get.callsArgWith(1, null, 'some-value')
  406. @rclient.srem.callsArgWith(2, null, {})
  407. it 'should not produce an error', (done) ->
  408. @call (err) =>
  409. expect(err).to.not.be.instanceof Error
  410. expect(err).to.equal undefined
  411. done()
  412. it 'should call the appropriate redis methods', (done) ->
  413. @call (err) =>
  414. @rclient.smembers.callCount.should.equal 1
  415. @rclient.get.callCount.should.equal 2
  416. @rclient.srem.callCount.should.equal 0
  417. done()
  418. describe 'when one of the keys is not present in redis', ->
  419. beforeEach ->
  420. @rclient.get.onCall(0).callsArgWith(1, null, 'some-val')
  421. @rclient.get.onCall(1).callsArgWith(1, null, null)
  422. it 'should not produce an error', (done) ->
  423. @call (err) =>
  424. expect(err).to.not.be.instanceof Error
  425. expect(err).to.equal undefined
  426. done()
  427. it 'should remove that key from the set', (done) ->
  428. @call (err) =>
  429. @rclient.smembers.callCount.should.equal 1
  430. @rclient.get.callCount.should.equal 2
  431. @rclient.srem.callCount.should.equal 1
  432. @rclient.srem.firstCall.args[1].should.equal 'two'
  433. done()
  434. describe 'when no user is supplied', ->
  435. beforeEach ->
  436. @call = (callback) =>
  437. @UserSessionsManager._checkSessions null, callback
  438. it 'should not produce an error', (done) ->
  439. @call (err) =>
  440. expect(err).to.not.be.instanceof Error
  441. expect(err).to.equal null
  442. done()
  443. it 'should not call redis methods', (done) ->
  444. @call (err) =>
  445. @rclient.smembers.callCount.should.equal 0
  446. @rclient.get.callCount.should.equal 0
  447. done()
  448. describe 'when one of the get operations produces an error', ->
  449. beforeEach ->
  450. @rclient.get.onCall(0).callsArgWith(1, new Error('woops'), null)
  451. @rclient.get.onCall(1).callsArgWith(1, null, null)
  452. it 'should produce an error', (done) ->
  453. @call (err) =>
  454. expect(err).to.be.instanceof Error
  455. done()
  456. it 'should call the right redis methods, bailing out early', (done) ->
  457. @call (err) =>
  458. @rclient.smembers.callCount.should.equal 1
  459. @rclient.get.callCount.should.equal 1
  460. @rclient.srem.callCount.should.equal 0
  461. done()