File: event_source_spec.rb

package info (click to toggle)
libnginx-mod-http-push-stream 0.6.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,272 kB
  • sloc: ruby: 7,101; ansic: 6,048; javascript: 2,121; sh: 53; makefile: 16
file content (435 lines) | stat: -rw-r--r-- 15,541 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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
require 'spec_helper'

describe "Subscriber Event Source" do
  let(:config) do
    {
      :subscriber_mode => 'eventsource',
      :header_template => nil,
      :message_template => nil,
      :footer_template => nil,
      :ping_message_interval => nil
    }
  end

  it "should use content type as 'event stream'" do
    channel = 'ch_test_content_type_should_be_event_stream'

    nginx_run_server(config.merge(:header_template => "header")) do |conf|
      EventMachine.run do
        source = EventMachine::EventSource.new(nginx_address + '/sub/' + channel.to_s)
        source.open do
          EventMachine.stop
        end

        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          expect(sub.response_header["CONTENT_TYPE"]).to eql("text/event-stream; charset=utf-8")
          source.start
        end
      end
    end
  end

  it "should split header lines and prefix them by a colon" do
    channel = 'ch_test_each_line_on_header_template_should_be_prefixed_by_a_colon'

    nginx_run_server(config.merge(:header_template => "header line 1\nheader line 2\rheader line 3\r\nheader line 4")) do |conf|
      EventMachine.run do
        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          expect(chunk).to eql(": header line 1\n: header line 2\n: header line 3\n: header line 4\n")
          EventMachine.stop
        end
      end
    end
  end

  it "should treat escaped new lines on header as single lines" do
    channel = 'ch_test_escaped_new_lines_on_header_template_should_be_treated_as_single_line'

    nginx_run_server(config.merge(:header_template => "header line 1\\\\nheader line 2")) do |conf|
      EventMachine.run do
        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          expect(chunk).to eql(": header line 1\\nheader line 2\n")
          EventMachine.stop
        end
      end
    end
  end

  it "should split footer lines and prefix them by a colon" do
    channel = 'ch_test_each_line_on_footer_template_should_be_prefixed_by_a_colon'
    response = ''

    nginx_run_server(config.merge(:subscriber_connection_ttl => '1s', :footer_template => "footer line 1\nfooter line 2\rfooter line 3\r\nfooter line 4")) do |conf|
      EventMachine.run do
        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          response += chunk
        end
        sub.callback do
          expect(response).to eql(": \n: footer line 1\n: footer line 2\n: footer line 3\n: footer line 4\n")
          EventMachine.stop
        end
      end
    end
  end

  it "should treat escaped new lines on footer as single lines" do
    channel = 'ch_test_escaped_new_lines_on_footer_template_should_be_treated_as_single_line'
    response = ''

    nginx_run_server(config.merge(:subscriber_connection_ttl => '1s', :footer_template => "footer line 1\\\\nfooter line 2")) do |conf|
      EventMachine.run do
        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          response += chunk
        end
        sub.callback do
          expect(response).to eql(": \n: footer line 1\\nfooter line 2\n")
          EventMachine.stop
        end
      end
    end
  end

  it "should use default message template without event id" do
    body = 'test message'
    channel = 'ch_test_default_message_template_without_event_id'
    response = ''

    nginx_run_server(config) do |conf|
      EventMachine.run do
        source = EventMachine::EventSource.new(nginx_address + '/sub/_' + channel.to_s)
        source.message do |message|
          expect(message).to eql(body)
          publish_message_inline(channel, headers, body)
        end
        source.start

        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          response += chunk
          if response.include?("data: ")
            expect(response).to eql(": \ndata: #{body}\n\n")
            EventMachine.stop
          end
        end

        publish_message_inline("_#{channel}", headers, body)
      end
    end
  end

  it "should use default message template without event type" do
    body = 'test message'
    channel = 'ch_test_default_message_template_without_event_type'
    response = ''

    nginx_run_server(config) do |conf|
      EventMachine.run do
        source = EventMachine::EventSource.new(nginx_address + '/sub/_' + channel.to_s)
        source.message do |message|
          expect(message).to eql(body)
          publish_message_inline(channel, headers, body)
        end
        source.start

        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          response += chunk
          if response.include?("data: ")
            expect(response).to eql(": \ndata: #{body}\n\n")
            EventMachine.stop
          end
        end

        publish_message_inline("_#{channel}", headers, body)
      end
    end
  end

  it "should use default message template with event id" do
    event_id = 'event_id_with_generic_text_01'
    body = 'test message'
    channel = 'ch_test_default_message_template_with_event_id'
    response = ''

    nginx_run_server(config) do |conf|
      EventMachine.run do
        source = EventMachine::EventSource.new(nginx_address + '/sub/_' + channel.to_s)
        source.message do |message|
          expect(message).to eql(body)
          expect(source.last_event_id).to eql(event_id)
          publish_message_inline(channel, headers.merge('Event-Id' => event_id), body)
        end
        source.start

        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          response += chunk
          if response.include?("data: ")
            expect(response).to eql(": \nid: #{event_id}\ndata: #{body}\n\n")
            EventMachine.stop
          end
        end

        publish_message_inline("_#{channel}", headers.merge('Event-Id' => event_id), body)
      end
    end
  end

  it "should use default message template with event type" do
    event_type = 'event_type_with_generic_text_01'
    body = 'test message'
    channel = 'ch_test_default_message_template_with_event_type'
    response = ''

    nginx_run_server(config) do |conf|
      EventMachine.run do
        source = EventMachine::EventSource.new(nginx_address + '/sub/_' + channel.to_s)
        source.on event_type do |message|
          expect(message).to eql(body)
          publish_message_inline(channel, headers.merge('Event-type' => event_type), body)
        end
        source.start

        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          response += chunk
          if response.include?("data: ")
            expect(response).to eql(": \nevent: #{event_type}\ndata: #{body}\n\n")
            EventMachine.stop
          end
        end

        publish_message_inline("_#{channel}", headers.merge('Event-type' => event_type), body)
      end
    end
  end

  it "should use custom message template without event id" do
    body = 'test message'
    channel = 'ch_test_custom_message_template_without_event_id'
    response = ''

    nginx_run_server(config.merge(:message_template => '{\"id\":\"~id~\", \"message\":\"~text~\"}')) do |conf|
      EventMachine.run do
        source = EventMachine::EventSource.new(nginx_address + '/sub/_' + channel.to_s)
        source.message do |message|
          expect(message).to eql(%({"id":"1", "message":"#{body}"}))
          publish_message_inline(channel, headers, body)
        end
        source.start

        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          response += chunk
          if response.include?("data: ")
            expect(response).to eql(%(: \ndata: {"id":"1", "message":"#{body}"}\n\n))
            EventMachine.stop
          end
        end

        publish_message_inline("_#{channel}", headers, body)
      end
    end
  end

  it "should use custom message template without event type" do
    body = 'test message'
    channel = 'ch_test_custom_message_template_without_event_type'
    response = ''

    nginx_run_server(config.merge(:message_template => '{\"id\":\"~id~\", \"message\":\"~text~\"}')) do |conf|
      EventMachine.run do
        source = EventMachine::EventSource.new(nginx_address + '/sub/_' + channel.to_s)
        source.message do |message|
          expect(message).to eql(%({"id":"1", "message":"#{body}"}))
          publish_message_inline(channel, headers, body)
        end
        source.start

        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          response += chunk
          if response.include?("data: ")
            expect(response).to eql(%(: \ndata: {"id":"1", "message":"#{body}"}\n\n))
            EventMachine.stop
          end
        end

        publish_message_inline("_#{channel}", headers, body)
      end
    end
  end

  it "should use custom message template with event id" do
    event_id = 'event_id_with_generic_text_01'
    body = 'test message'
    channel = 'ch_test_custom_message_template_with_event_id'
    response = ''

    nginx_run_server(config.merge(:message_template => '{\"id\":\"~id~\", \"message\":\"~text~\"}')) do |conf|
      EventMachine.run do
        source = EventMachine::EventSource.new(nginx_address + '/sub/_' + channel.to_s)
        source.message do |message|
          expect(message).to eql(%({"id":"1", "message":"#{body}"}))
          expect(source.last_event_id).to eql(event_id)
          publish_message_inline(channel, headers.merge('Event-Id' => event_id), body)
        end
        source.start

        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          response += chunk
          if response.include?("data: ")
            expect(response).to eql(%(: \nid: #{event_id}\ndata: {"id":"1", "message":"#{body}"}\n\n))
            EventMachine.stop
          end
        end

        publish_message_inline("_#{channel}", headers.merge('Event-Id' => event_id), body)
      end
    end
  end

  it "should use custom message template with event type" do
    event_type = 'event_type_with_generic_text_01'
    body = 'test message'
    channel = 'ch_test_custom_message_template_with_event_type'
    response = ''

    nginx_run_server(config.merge(:message_template => '{\"id\":\"~id~\", \"message\":\"~text~\"}')) do |conf|
      EventMachine.run do
        source = EventMachine::EventSource.new(nginx_address + '/sub/_' + channel.to_s)
        source.on event_type do |message|
          expect(message).to eql(%({"id":"1", "message":"#{body}"}))
          publish_message_inline(channel, headers.merge('Event-type' => event_type), body)
        end
        source.start

        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          response += chunk
          if response.include?("data: ")
            expect(response).to eql(%(: \nevent: #{event_type}\ndata: {"id":"1", "message":"#{body}"}\n\n))
            EventMachine.stop
          end
        end

        publish_message_inline("_#{channel}", headers.merge('Event-type' => event_type), body)
      end
    end
  end

  it "should apply the message template to each line on posted message" do
    body = "line 1\nline 2\rline 3\r\nline 4"
    channel = 'ch_test_each_line_on_posted_message_should_be_applied_to_template'

    nginx_run_server(config) do |conf|
      EventMachine.run do
        source = EventMachine::EventSource.new(nginx_address + '/sub/_' + channel.to_s)
        source.message do |message|
          expect(message).to eql("line 1\nline 2\nline 3\nline 4")
          publish_message_inline(channel, headers, body)
        end
        source.start

        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          if chunk.include?("line 4")
            expect(chunk).to eql("data: line 1\ndata: line 2\ndata: line 3\ndata: line 4\n\n")
            EventMachine.stop
          end
        end

        publish_message_inline("_#{channel}", headers, body)
      end
    end
  end

  it "should treat escaped new lines on posted message as single lines" do
    body = "line 1\\nline 2"
    channel = 'ch_test_escaped_new_lines_on_posted_message_should_be_treated_as_single_line'

    nginx_run_server(config) do |conf|
      EventMachine.run do
        source = EventMachine::EventSource.new(nginx_address + '/sub/_' + channel.to_s)
        source.message do |message|
          expect(message).to eql(body)
          publish_message_inline(channel, headers, body)
        end
        source.start

        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          if chunk.include?("line 2")
            expect(chunk).to eql("data: line 1\\nline 2\n\n")
            EventMachine.stop
          end
        end

        publish_message_inline("_#{channel}", headers, body)
      end
    end
  end

  it "should receive ping message" do
    channel = 'ch_test_ping_message_on_event_source'

    nginx_run_server(config.merge(:ping_message_interval => '1s', :message_template => '{\"id\":\"~id~\", \"message\":\"~text~\"}')) do |conf|
      EventMachine.run do
        sub = EventMachine::HttpRequest.new(nginx_address + '/sub/' + channel.to_s).get
        sub.stream do |chunk|
          if chunk.include?("-1")
            expect(chunk).to eql(": -1\n")
            EventMachine.stop
          end
        end
      end
    end
  end

  it "should not reaplly formatter to header, message or footer template when inside an if" do
    channel = 'ch_test_not_reaplly_formatter_on_header_message_footer_template'
    body = 'test message'
    response = ''
    extra_location = %(
      location ~ /ev/(.*) {
        push_stream_subscriber "eventsource";
        push_stream_channels_path "$1";
        if ($arg_tests = "on") {
          push_stream_channels_path "test_$1";
        }
      }
    )

    nginx_run_server(config.merge(:extra_location => extra_location, :header_template => "header", :message_template => "msg ~text~", :footer_template => "footer", :subscriber_connection_ttl => '1s')) do |conf|
      EventMachine.run do
        sub = EventMachine::HttpRequest.new(nginx_address + '/ev/' + channel.to_s).get
        sub.stream do |chunk|
          response += chunk
          if response.include?("footer")
            expect(response).to eql(": header\ndata: msg #{body}\n\n: footer\n")

            response = ''
            sub_1 = EventMachine::HttpRequest.new(nginx_address + '/ev/' + channel.to_s + '?tests=on').get
            sub_1.stream do |chunk_1|
              response += chunk_1
              if response.include?("footer")
                expect(response).to eql(": header\ndata: msg #{body}\n\n: footer\n")
                EventMachine.stop
              end
            end

            publish_message_inline("test_" + channel, headers, body)
          end
        end

        publish_message_inline(channel, headers, body)
      end
    end
  end
end