File: redis_test.rb

package info (click to toggle)
ruby-redis-rack 2.1.2-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 176 kB
  • sloc: ruby: 558; makefile: 3
file content (414 lines) | stat: -rw-r--r-- 14,197 bytes parent folder | download
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
require 'test_helper'
require 'rack/mock'
require 'thread'
require 'connection_pool'

describe Rack::Session::Redis do
  session_key = Rack::Session::Redis::DEFAULT_OPTIONS[:key]
  session_match = /#{session_key}=([0-9a-fA-F]+);/
  incrementor = lambda do |env|
    env["rack.session"]["counter"] ||= 0
    env["rack.session"]["counter"] += 1
    Rack::Response.new(env["rack.session"].inspect).to_a
  end
  drop_session = proc do |env|
    env['rack.session.options'][:drop] = true
    incrementor.call(env)
  end
  renew_session = proc do |env|
    env['rack.session.options'][:renew] = true
    incrementor.call(env)
  end
  defer_session = proc do |env|
    env['rack.session.options'][:defer] = true
    incrementor.call(env)
  end
  skip_session = proc do |env|
    env['rack.session.options'][:skip] = true
    incrementor.call(env)
  end

  # # test Redis connection
  # Rack::Session::Redis.new(incrementor)
  #
  # it "faults on no connection" do
  #   lambda{
  #     Rack::Session::Redis.new(incrementor, :redis_server => 'nosuchserver')
  #   }.must_raise(Exception)
  # end

  it "can create it's own pool" do
    session_store = Rack::Session::Redis.new(incrementor, pool_size: 5, pool_timeout: 10)
    conn = session_store.instance_variable_get(:@conn)
    conn.pool.class.must_equal ::ConnectionPool
    conn.pool.instance_variable_get(:@size).must_equal 5
  end

  it "can create it's own pool using default Redis server" do
    session_store = Rack::Session::Redis.new(incrementor, pool_size: 5, pool_timeout: 10)
    session_store.with { |connection| connection.to_s.must_match(/127\.0\.0\.1:6379 against DB 0 with namespace rack:session$/)  }
  end

  it "can create it's own pool using provided Redis server" do
    session_store = Rack::Session::Redis.new(incrementor, redis_server: 'redis://127.0.0.1:6380/1', pool_size: 5, pool_timeout: 10)
    session_store.with { |connection| connection.to_s.must_match(/127\.0\.0\.1:6380 against DB 1$/)  }
  end

  it "can use a supplied pool" do
    session_store = Rack::Session::Redis.new(incrementor, pool: ::ConnectionPool.new(size: 1, timeout: 1) { ::Redis::Store::Factory.create("redis://127.0.0.1:6380/1")})
    conn = session_store.instance_variable_get(:@conn)
    conn.pool.class.must_equal ::ConnectionPool
    conn.pool.instance_variable_get(:@size).must_equal 1
  end

  it "uses the specified Redis store when provided" do
    store = ::Redis::Store::Factory.create('redis://127.0.0.1:6380/1')
    pool = Rack::Session::Redis.new(incrementor, :redis_store => store)
    pool.with do |p|
      p.to_s.must_match(/127\.0\.0\.1:6380 against DB 1$/)
      p.must_equal(store)
    end
  end

  it "uses the default Redis server and namespace when not provided" do
    pool = Rack::Session::Redis.new(incrementor)
    pool.with { |p| p.to_s.must_match(/127\.0\.0\.1:6379 against DB 0 with namespace rack:session$/) }
  end

  it "uses the specified namespace when provided" do
    pool = Rack::Session::Redis.new(incrementor, :redis_server => {:namespace => 'test:rack:session'})
    pool.with { |p| p.to_s.must_match(/namespace test:rack:session$/) }
  end

  it "uses the specified Redis server when provided" do
    pool = Rack::Session::Redis.new(incrementor, :redis_server => 'redis://127.0.0.1:6380/1')
    pool.with { |p| p.to_s.must_match(/127\.0\.0\.1:6380 against DB 1$/) }
  end

  it "is threadsafe by default" do
    sesion_store = Rack::Session::Redis.new(incrementor)
    sesion_store.threadsafe?.must_equal(true)
  end

  it "does not store a blank session" do
    session_store = Rack::Session::Redis.new(incrementor)
    sid = session_store.generate_unique_sid({})
    session_store.with { |c| c.get(sid.private_id).must_be_nil }
  end

  it "locks the store mutex" do
    mutex = Mutex.new
    mutex.expects(:lock).once
    sesion_store = Rack::Session::Redis.new(incrementor)
    sesion_store.instance_variable_set(:@mutex, mutex)
    was_yielded = false
    request = Minitest::Mock.new
    request.expect(:multithread?, true)
    sesion_store.with_lock(request) { was_yielded = true}
    was_yielded.must_equal(true)
  end

  describe "threadsafe disabled" do
    it "can have the global lock disabled" do
      sesion_store = Rack::Session::Redis.new(incrementor, :threadsafe => false)
      sesion_store.threadsafe?.must_equal(false)
    end

    it "does not lock the store mutex" do
      mutex = Mutex.new
      mutex.expects(:lock).never
      sesion_store = Rack::Session::Redis.new(incrementor, :threadsafe => false)
      sesion_store.instance_variable_set(:@mutex, mutex)
      was_yielded = false
      request = Minitest::Mock.new
      request.expect(:multithread?, true)
      sesion_store.with_lock(request) { was_yielded = true}
      was_yielded.must_equal(true)
    end
  end

  it "creates a new cookie" do
    with_pool_management(incrementor) do |pool|
      res = Rack::MockRequest.new(pool).get("/")
      res["Set-Cookie"].must_include("#{session_key}=")
      res.body.must_equal('{"counter"=>1}')
    end
  end

  it "determines session from a cookie" do
    with_pool_management(incrementor) do |pool|
      req = Rack::MockRequest.new(pool)
      res = req.get("/")
      cookie = res["Set-Cookie"]
      req.get("/", "HTTP_COOKIE" => cookie).
        body.must_equal('{"counter"=>2}')
      req.get("/", "HTTP_COOKIE" => cookie).
        body.must_equal('{"counter"=>3}')
    end
  end

  it "determines session only from a cookie by default" do
    with_pool_management(incrementor) do |pool|
      req = Rack::MockRequest.new(pool)
      res = req.get("/")
      sid = res["Set-Cookie"][session_match, 1]
      req.get("/?rack.session=#{sid}").
        body.must_equal('{"counter"=>1}')
      req.get("/?rack.session=#{sid}").
        body.must_equal('{"counter"=>1}')
    end
  end

  it "determines session from params" do
    with_pool_management(incrementor, :cookie_only => false) do |pool|
      req = Rack::MockRequest.new(pool)
      res = req.get("/")
      sid = res["Set-Cookie"][session_match, 1]
      req.get("/?rack.session=#{sid}").
        body.must_equal('{"counter"=>2}')
      req.get("/?rack.session=#{sid}").
        body.must_equal('{"counter"=>3}')
    end
  end

  it "survives nonexistant cookies" do
    bad_cookie = "rack.session=blarghfasel"
    with_pool_management(incrementor) do |pool|
      res = Rack::MockRequest.new(pool).
        get("/", "HTTP_COOKIE" => bad_cookie)
      res.body.must_equal('{"counter"=>1}')
      cookie = res["Set-Cookie"][session_match]
      cookie.wont_match(/#{bad_cookie}/)
    end
  end

  it "maintains freshness" do
    with_pool_management(incrementor, :expire_after => 3) do |pool|
      res = Rack::MockRequest.new(pool).get('/')
      res.body.must_include('"counter"=>1')
      cookie = res["Set-Cookie"]
      sid = cookie[session_match, 1]
      res = Rack::MockRequest.new(pool).get('/', "HTTP_COOKIE" => cookie)
      res["Set-Cookie"][session_match, 1].must_equal(sid)
      res.body.must_include('"counter"=>2')
      puts 'Sleeping to expire session' if $DEBUG
      sleep 4
      res = Rack::MockRequest.new(pool).get('/', "HTTP_COOKIE" => cookie)
      res["Set-Cookie"][session_match, 1].wont_equal(sid)
      res.body.must_include('"counter"=>1')
    end
  end

  it "does not send the same session id if it did not change" do
    with_pool_management(incrementor) do |pool|
      req = Rack::MockRequest.new(pool)

      res0 = req.get("/")
      cookie = res0["Set-Cookie"]
      res0.body.must_equal('{"counter"=>1}')

      res1 = req.get("/", "HTTP_COOKIE" => cookie)
      res1["Set-Cookie"].must_be_nil
      res1.body.must_equal('{"counter"=>2}')

      res2 = req.get("/", "HTTP_COOKIE" => cookie)
      res2["Set-Cookie"].must_be_nil
      res2.body.must_equal('{"counter"=>3}')
    end
  end

  it "deletes cookies with :drop option" do
    with_pool_management(incrementor) do |pool|
      req = Rack::MockRequest.new(pool)
      drop = Rack::Utils::Context.new(pool, drop_session)
      dreq = Rack::MockRequest.new(drop)

      res1 = req.get("/")
      session = (cookie = res1["Set-Cookie"])[session_match]
      res1.body.must_equal('{"counter"=>1}')

      res2 = dreq.get("/", "HTTP_COOKIE" => cookie)
      res2["Set-Cookie"].must_be_nil
      res2.body.must_equal('{"counter"=>2}')

      res3 = req.get("/", "HTTP_COOKIE" => cookie)
      res3["Set-Cookie"][session_match].wont_equal(session)
      res3.body.must_equal('{"counter"=>1}')
    end
  end

  it "provides new session id with :renew option" do
    with_pool_management(incrementor) do |pool|
      req = Rack::MockRequest.new(pool)
      renew = Rack::Utils::Context.new(pool, renew_session)
      rreq = Rack::MockRequest.new(renew)

      res1 = req.get("/")
      session = (cookie = res1["Set-Cookie"])[session_match]
      res1.body.must_equal('{"counter"=>1}')

      res2 = rreq.get("/", "HTTP_COOKIE" => cookie)
      new_cookie = res2["Set-Cookie"]
      new_session = new_cookie[session_match]
      new_session.wont_equal(session)
      res2.body.must_equal('{"counter"=>2}')

      res3 = req.get("/", "HTTP_COOKIE" => new_cookie)
      res3.body.must_equal('{"counter"=>3}')

      # Old cookie was deleted
      res4 = req.get("/", "HTTP_COOKIE" => cookie)
      res4.body.must_equal('{"counter"=>1}')
    end
  end

  it "omits cookie with :defer option" do
    with_pool_management(incrementor) do |pool|
      defer = Rack::Utils::Context.new(pool, defer_session)
      dreq = Rack::MockRequest.new(defer)

      res0 = dreq.get("/")
      res0["Set-Cookie"].must_be_nil
      res0.body.must_equal('{"counter"=>1}')
    end
  end

  it "does not hit with :skip option" do
    with_pool_management(incrementor) do |session_store|
      skip = Rack::Utils::Context.new(session_store, skip_session)
      sreq = Rack::MockRequest.new(skip)

      res0 = sreq.get("/")
      res0.body.must_equal('{"counter"=>1}')
    end
  end

  it "updates deep hashes correctly" do
    hash_check = proc do |env|
      session = env['rack.session']
      unless session.include? 'test'
        session.update :a => :b, :c => { :d => :e },
          :f => { :g => { :h => :i} }, 'test' => true
      else
        session[:f][:g][:h] = :j
      end
      [200, {}, [session.inspect]]
    end
    with_pool_management(hash_check) do |pool|
      req = Rack::MockRequest.new(pool)

      res0 = req.get("/")
      session_id = (cookie = res0["Set-Cookie"])[session_match, 1]
      sid = Rack::Session::SessionId.new(session_id)
      ses0 = pool.with { |c| c.get(sid.private_id) }

      req.get("/", "HTTP_COOKIE" => cookie)
      ses1 = pool.with { |c| c.get(sid.private_id) }

      ses1.wont_equal(ses0)
    end
  end

  # anyone know how to do this better?
  it "cleanly merges sessions when multithreaded" do
    unless $DEBUG
      1.must_equal(1) # fake assertion to appease the mighty bacon
      next
    end
    warn 'Running multithread test for Session::Redis'
    with_pool_management(incrementor) do |pool|
      req = Rack::MockRequest.new(pool)

      res = req.get('/')
      res.body.must_equal('{"counter"=>1}')
      cookie = res["Set-Cookie"]
      session_id = cookie[session_match, 1]
      sid = Rack::Session::SessionId.new(session_id)

      delta_incrementor = lambda do |env|
        # emulate disconjoinment of threading
        env['rack.session'] = env['rack.session'].dup
        Thread.stop
        env['rack.session'][(Time.now.usec*rand).to_i] = true
        incrementor.call(env)
      end
      tses = Rack::Utils::Context.new pool, delta_incrementor
      treq = Rack::MockRequest.new(tses)
      tnum = rand(7).to_i+5
      r = Array.new(tnum) do
        Thread.new(treq) do |run|
          run.get('/', "HTTP_COOKIE" => cookie, 'rack.multithread' => true)
        end
      end.reverse.map{|t| t.run.join.value }
      r.each do |request|
        request['Set-Cookie'].must_equal(cookie)
        request.body.must_include('"counter"=>2')
      end

      session = pool.with { |c| c.get(sid.private_id) }
      session.size.must_equal(tnum+1) # counter
      session['counter'].must_equal(2) # meeeh

      tnum = rand(7).to_i+5
      r = Array.new(tnum) do |i|
        app = Rack::Utils::Context.new pool, time_delta
        req = Rack::MockRequest.new app
        Thread.new(req) do |run|
          run.get('/', "HTTP_COOKIE" => cookie, 'rack.multithread' => true)
        end
      end.reverse.map{|t| t.run.join.value }
      r.each do |request|
        request['Set-Cookie'].must_equal(cookie)
        request.body.must_include('"counter"=>3')
      end

      session = pool.with { |c| c.get(sid.private_id) }
      session.size.must_equal(tnum+1)
      session['counter'].must_equal(3)

      drop_counter = proc do |env|
        env['rack.session'].delete 'counter'
        env['rack.session']['foo'] = 'bar'
        [200, {'Content-Type'=>'text/plain'}, env['rack.session'].inspect]
      end
      tses = Rack::Utils::Context.new pool, drop_counter
      treq = Rack::MockRequest.new(tses)
      tnum = rand(7).to_i+5
      r = Array.new(tnum) do
        Thread.new(treq) do |run|
          run.get('/', "HTTP_COOKIE" => cookie, 'rack.multithread' => true)
        end
      end.reverse.map{|t| t.run.join.value }
      r.each do |request|
        request['Set-Cookie'].must_equal(cookie)
        request.body.must_include('"foo"=>"bar"')
      end

      session = pool.with { |c| c.get(sid.private_id) }
      session.size.must_equal(r.size+1)
      session['counter'].must_be_nil
      session['foo'].must_equal('bar')
    end
  end

  private
    def with_pool_management(*args)
      yield simple(*args)
      yield pooled(*args)
      yield external_pooled(*args)
    end

    def simple(app, options = {})
      Rack::Session::Redis.new(app, options)
    end

    def pooled(app, options = {})
      Rack::Session::Redis.new(app, options)
      Rack::Session::Redis.new(app, options.merge(pool_size: 5, pool_timeout: 10))
    end

    def external_pooled(app, options = {})
      Rack::Session::Redis.new(app, options.merge(pool: ::ConnectionPool.new(size: 1, timeout: 1) { ::Redis::Store::Factory.create("redis://127.0.0.1:6380/1") }))
    end

end