forked from discourse/message_bus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCHANGELOG
377 lines (265 loc) · 11.5 KB
/
CHANGELOG
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
30-04-2019
- Version 2.2.1
- FIX: No longer handles exceptions raised in downstream middleware via `on_middleware_error`
28-01-2019
- Version 2.2.0
- FIX: Ruby HTTP Client not backing off polling on error.
11-12-2018
- Version 2.2.0.pre.2
- FEATURE: Re-wrote diagnostics UI using React
- FEATURE: MessageBus HTTP Ruby Client
30-11-2018
- Version 2.2.0.pre.1
- FIX: diagnostics stopped working cause a private method was invoked on self
30-11-2018
- Version 2.2.0.pre
- FIX: In redis backend we now expire the key used to track channel id this can cause a redis key leak
with large amounts of subscriptions that go away
- FEATURE: Much extra implementation documentation, and some improvements to usage documentation.
- FEATURE: Improvements to development workflow:
- Fully docker-based development and testing, with no other dependencies.
- More stringent Rubocop enforcement and greater compliance.
- Testing supported Ruby versions
- Better test coverage of some features
- Improved testing and assertion of the differences between backends
- More stable tests - now pass pretty much every run
- Documentation syntax is verified as part of testing
- FEATURE: Ruby 2.2.0 is no longer supported as it is EOL
- FEATURE: Better feature parity between backends:
- Adds support for backlog expiry to memory backend
- Support setting backlog expiry on publication w/ Postgres
- Supports setting backlog size on publication for memory/postgres
- FEATURE: `MessageBus.off` now prevents the server subscription from starting up.
- FEATURE: Trims unused parts of the public API:
- Methods removed:
* ConnectionManager#stats (never used and the ConnectionManager is not exposed to application code)
* Client#cancel (effectively duplicate of Client#close and the Client is only available via the ConnectionManager, thus not available to application code)
- Methods made private:
* MessageBus::Implementation#encode_channel_name
* MessageBus::Implementation#decode_channel_name
* Client#in_async?
* Client#ensure_closed!
* ConnectionManager#subscribe_client
* Diagnostics.full_process_path
* Diagnostics.hostname
* MessageBus::Rack::Diagnostics#js_asset
* MessageBus::Rack::Diagnostics#generate_script_tag
* MessageBus::Rack::Diagnostics#file_hash
* MessageBus::Rack::Diagnostics#asset_contents
* MessageBus::Rack::Diagnostics#asset_path
* MessageBus::Rack::Diagnostics#index
* MessageBus::Rack::Diagnostics#translate_handlebars
* MessageBus::Rack::Diagnostics#indent
* MessageBus::Rack::Middleware#start_listener
* MessageBus::Rack::Middleware#close_db_connection!
* MessageBus::Rack::Middleware#add_client_with_timeout
- Methods switched from protected to private:
* MessageBus::Implementation#global?
* MessageBus::Implementation#decode_message!
* MessageBus::Implementation#replay_backlog
* MessageBus::Implementation#subscribe_impl
* MessageBus::Implementation#unsubscribe_impl
* MessageBus::Implementation#ensure_subscriber_thread
* MessageBus::Implementation#new_subscriber_thread
* MessageBus::Implementation#global_subscribe_thread
* MessageBus::Implementation#multi_each
* Client#write_headers
* Client#write_chunk
* Client#write_and_close
* Client#messages_to_json
15-10-2018
- Version 2.1.6
- FEATURE: `MesssageBus.publish` accepts option `site_id` to publish to a site
- FEATURE: Added MessageBus::DistributedCache for cross process caching
- PERF: Use monotonic times in timer thread
- FEATURE: min poll interval is now configurable client side
16-05-2018
- Version 2.1.5
- FIX: In some cases a 30 second initial delay could happen cause client lost info about long poller
20-04-2018
- Version 2.1.4
- FIX: Subtle issue where poll timeout may not be cleared causing multiple concurrent polls
- FIX: Add extra protection for poller to ensure there is never a case where multiple ajax happens concurrently
09-01-2018
- Version 2.1.2
- FEATURE: minHiddenPollInterval set to 1500ms out of the box, ensures we never do hidden tab
polls at a high rate if tons of tabs are open
- FEATURE: added random 500ms to delayed polls to increase tab entropy
18-12-2017
- Version 2.1.1
- FEATURE: allow setting of max_backlog_size and max_backlog_age on publish for redis provider
18-12-2017
- Version 2.1.0
- FEATURE: you can now lookup last N messages on channel on subscribe from JavaScript
Subscribe at position (-1 - numberOfMessages) from the client
24-11-2017
- Version 2.0.9
- PERF: faster serialization of messages
- FEATURE: on backend flush web clients will resume and continue to get all new messages
06-10-2017
- Version 2.0.8
- Fix: Make redis readonly detection more robust
02-10-2017
- Version 2.0.7
- Fix/Feature: use LUA script for publishing to bus, this eliminates a race condition
and ensures that we are never stuck in a multi transaction by mistake
29-09-2017
- Version 2.0.6
- Fix: correct after_fork so it correctly disconnnects redis
- Fix: correct message_bus #destroy used in tests to clean up spec (deadlock)
- Fix: deliver backlog unconditionally when polling (and not long polling)
16-08-2017
- Version 2.0.5
- Quick fix, build on earlier version of Ruby cause https://github.com/rubygems/rubygems/issues/1448 is still open
- Version 2.0.3
- Fix: broken MessageBus.redis_config
- Perf: publish status message for filtered messages
- Perf: add frozen strings to save on memory
- Feature: improved logging when messages are dropped
- Fix: handle missing actiondispatch flash
25-08-2016
- Version 2.0.2
- Feature: Add on_middleware_error callback for remapping middleware errors to HTTP results
25-07-2016
- Feature: Add JavaScript MessageBus.status() function
21-06-2016
- Version 2.0.1
- Fix: build using old ruby cause new ruby breaks stuff @sam
21-06-2016
- Version 2.0.0
- Fix: forked process terminates parent more cleanly (does not kill -9 parent if already terminated) @uri
- Fix: add async true explicitly on ajax reqs to ensure it always works even if disabled by globally @washu
11-05-2016
- Version 2.0.0.beta.11
- Fix: for https://github.com/rubygems/rubygems/issues/1448 which is still broken, build under Ruby 2.0
11-05-2016
- Version 2.0.0.beta.10
- Fix: for https://github.com/rubygems/rubygems/issues/1448
11-05-2016
- Version 2.0.0.beta.9
- Fix: requests without content type were erroring out, breaks CORS
27-04-2016
- Version 2.0.0.beta.8
- Fix: exception raised sometimes when subscribing at a particular position
26-04-2016
- Version 2.0.0.beta.7
- Feature: Support custom HTTP headers without depending on jQuery @nathanstitt
- Feature: Allow subscribe at a particular position from server side @sam
29-02-2016
- Version 2.0.0.beta.6
- Feature: Support standalone opertion without depending on jQuery @nathanstitt
- Feature: Support a noconflict mode @nathanstitt
- Feature: Support JSON POST payload @nathanstitt
29-02-2016
- Version 2.0.0.beta.5
- Fix: JavaScript unsubscribe was not updating publicly visible MessageBus.callbacks @sam
- Fix: When MessageBus is talking to a readonly redis buffering may cause a infinite loop @tgxworld
- Version 2.0.0.beta.4
- Feature: allow verbose redis logging by specifying `enable_redis_logger` in config, default disabled
- Version 2.0.0.beta.3
- Feature: Postgresql backend @jeremyevans
- Breaking Change: Configuration API changed see Readme for details @jeremyevans
- Breaking Change: Remove runtime dependency on Redis @jeremyevans
- Dev: Convert all specs to minitest @jeremyevans
- Feature: Support passing channels to Rack middleware via env['message_bus.channels'] via @jeremyevans
03-01-2016
- Version 2.0.0.beta.2
- Fix: Remove stray console.log
- Version 2.0.0.beta.1
- Feature: add support for chunked encoding transport, this significnatlly improves long polling performance
- Feature: strip around_filters and client filters, which were speculative
- Fix: Message delivery race condition when a message was published just as long poll started. Ben Langfeld
- Feature: strip support for message_handlers, speculative feature that was not used
09-12-2015
- Version 1.1.1
- Fix: In multisite config there was no way to specify site for last_id or backlog
to resolve overrides were added to #last_id and #backlog, MessageBus::Client now
uses the new overrides
07-12-2015
- Version 1.1.0
- Fix: keep track of client sequence on server, abandon old subscribes
- Fix: rare concurrency issue when subscribing concurrently
- Fature: remove most jQuery dependency from message-bus.js
09-07-2015
- Version 1.0.16
- Fix: correct edge cases around keepalive checks on bus
09-07-2015
- Version 1.0.15
- Feature: MessageBus.reliable_pub_sub.max_backlog_age (in secs) configurable (default to 7 days)
- Fix: API for MessageBus.backlog("/bla") was returning global backlog by mistake
- Change: Max global backlog size reduced to 2000 elements
08-06-2015
- Version 1.0.14
- Fix: we can not use Thread#kill best keepalive can do is terminate process cleanly
- Feature: you can opt-out of keepalive with MessageBus.keepalive_timeout = 0
08-06-2015
- Version 1.0.13
- Fix: on global subscribe reconnect replay missed messages
- Feature: keepalive tests for global subscribe, catches hung redis connections
28-05-2015
- Version 1.0.12
- Feature: Support client_id targetted message
06-05-2015
- Version 1.0.11
- Fix: race condition in TimerThread
01-05-2015
- Version: 1.0.10
- Feature: no longer depends on EventMachine (only used for Thin backend)
- Feature: realiable pub sub will queue messages in memory if redis is readonly, configurable
- Fix: if redis is flushed we will continue to deliver messages
23-03-2015
- Version 1.0.9
- Fix: inherit off StandardError not Exception for all exceptions raised
20-03-2015
- Version 1.0.8
- Fix: aggressive short polling in background
16-03-2015
- Version 1.0.7
- Feature: added pause and resume methods
03-02-2015
- Version 1.0.6
- Fix: global backlog not truncating correctly
23-09-2014
- Version 1.0.5
- Fix: missing custom headers from long polls
23-09-2014
- Version 1.0.4
- Change: MessageBus.access_control_allow_origin_lookup to extra_response_headers_lookup
23-09-2014
- Version 1.0.3
- Change: MessageBus.access_control_allow_origin to MessageBus.access_control_allow_origin_lookup
23-09-2014
- Version 1.0.2
- Feature: MessageBus.access_control_allow_origin to control origin header
23-09-2014
- Version 1.0.1
- Feature: $.ajax dependency can be passed in.
- Feature: unsubscribe accepts a second param for the function to unsubscribe.
22-09-2014
- Version 1.0.0
- Feature: add backgroundCallbackInterval - interval to send polls when page is in the background
- Feature: issue a long poll as soon as page moves into the foreground
11-08-2014
- Version 0.9.5
- Fix: release db connection a lot earlier for long polling (rails defer closes)
13-01-2014
- Version 0.9.4
- Added support for /global/ channel to publish messages across a multisite
- Cleaned up test harness so it uses local bus as opposed to global
- Fix bug where we could subscribe to a channel but miss starting messages
- Added method for destroying a local MessageBus instance
- ensure_reactor could say the reactor is running, but it was not, on first call
06-12-2013
- Version 0.9.3.2
- Fix permissions in gem
05-12-2013
- Version 0.9.3.1
- Add MessageBus.diagnostics() for diagnosing bus issues client side
- Add more robustness to JavaScript, if callbacks used to fail they would halt the chain
03-12-2013
- Version 0.9.3
- Remove thin dependency
- Improve robustness under failure conditions
30-09-2013
- Fix failures in Ruby 1.9
- Set up rack hijack by default in light of passengers new setting