dalli 5.0.5 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +172 -0
- data/README.md +6 -1
- data/lib/dalli/client.rb +274 -48
- data/lib/dalli/options.rb +1 -1
- data/lib/dalli/pipelined_deleter.rb +41 -17
- data/lib/dalli/pipelined_getter.rb +57 -8
- data/lib/dalli/pipelined_setter.rb +15 -3
- data/lib/dalli/protocol/base.rb +62 -5
- data/lib/dalli/protocol/connection_manager.rb +34 -10
- data/lib/dalli/protocol/key_regularizer.rb +25 -9
- data/lib/dalli/protocol/meta.rb +100 -90
- data/lib/dalli/protocol/request_formatter.rb +166 -27
- data/lib/dalli/protocol/response_buffer.rb +21 -22
- data/lib/dalli/protocol/response_processor.rb +64 -17
- data/lib/dalli/socket.rb +47 -32
- data/lib/dalli/version.rb +2 -2
- metadata +2 -3
- data/lib/dalli/pid_cache.rb +0 -40
data/lib/dalli/client.rb
CHANGED
|
@@ -68,6 +68,7 @@ module Dalli
|
|
|
68
68
|
# Get the value associated with the key.
|
|
69
69
|
# If a value is not found, then +nil+ is returned.
|
|
70
70
|
def get(key, req_options = nil)
|
|
71
|
+
validate_routing_tokens!(req_options)
|
|
71
72
|
perform(:get, key, req_options)
|
|
72
73
|
end
|
|
73
74
|
|
|
@@ -75,8 +76,9 @@ module Dalli
|
|
|
75
76
|
# Gat (get and touch) fetch an item and simultaneously update its expiration time.
|
|
76
77
|
#
|
|
77
78
|
# If a value is not found, then +nil+ is returned.
|
|
78
|
-
def gat(key, ttl = nil)
|
|
79
|
-
|
|
79
|
+
def gat(key, ttl = nil, req_options = nil)
|
|
80
|
+
validate_routing_tokens!(req_options)
|
|
81
|
+
perform(:gat, key, ttl_or_default(ttl), req_options)
|
|
80
82
|
end
|
|
81
83
|
|
|
82
84
|
##
|
|
@@ -91,8 +93,9 @@ module Dalli
|
|
|
91
93
|
##
|
|
92
94
|
# Get the value and CAS ID associated with the key. If a block is provided,
|
|
93
95
|
# value and CAS will be passed to the block.
|
|
94
|
-
def get_cas(key)
|
|
95
|
-
(
|
|
96
|
+
def get_cas(key, req_options = nil)
|
|
97
|
+
validate_routing_tokens!(req_options)
|
|
98
|
+
(value, cas) = perform(:cas, key, req_options)
|
|
96
99
|
return [value, cas] unless block_given?
|
|
97
100
|
|
|
98
101
|
yield value, cas
|
|
@@ -106,17 +109,23 @@ module Dalli
|
|
|
106
109
|
# - :return_cas [Boolean] return the CAS value (default: true)
|
|
107
110
|
# - :return_hit_status [Boolean] return whether item was previously accessed
|
|
108
111
|
# - :return_last_access [Boolean] return seconds since last access
|
|
112
|
+
# - :return_ttl_remaining [Boolean] return seconds of TTL remaining (-1 if no TTL)
|
|
109
113
|
# - :skip_lru_bump [Boolean] don't bump LRU or update access stats
|
|
110
114
|
#
|
|
111
115
|
# @return [Hash] containing:
|
|
112
116
|
# - :value - the cached value (or nil on miss)
|
|
113
117
|
# - :cas - the CAS value
|
|
118
|
+
# - :miss - true when the key does not exist. Always present. Prefer it
|
|
119
|
+
# over a nil :value, which cannot distinguish a miss from a stored nil
|
|
120
|
+
# under cache_nils
|
|
114
121
|
# - :hit_before - true/false if previously accessed (only if return_hit_status: true)
|
|
115
122
|
# - :last_access - seconds since last access (only if return_last_access: true)
|
|
123
|
+
# - :ttl_remaining - seconds of TTL remaining, -1 when the item has no
|
|
124
|
+
# expiry (only if return_ttl_remaining: true)
|
|
116
125
|
#
|
|
117
126
|
# @example Get with hit status
|
|
118
127
|
# result = client.get_with_metadata('key', return_hit_status: true)
|
|
119
|
-
# # => { value: "data", cas: 123, hit_before: true }
|
|
128
|
+
# # => { value: "data", cas: 123, miss: false, hit_before: true }
|
|
120
129
|
#
|
|
121
130
|
# @example Get with all metadata without affecting LRU
|
|
122
131
|
# result = client.get_with_metadata('key',
|
|
@@ -127,6 +136,7 @@ module Dalli
|
|
|
127
136
|
# # => { value: "data", cas: 123, hit_before: true, last_access: 42 }
|
|
128
137
|
#
|
|
129
138
|
def get_with_metadata(key, options = {})
|
|
139
|
+
validate_routing_tokens!(options)
|
|
130
140
|
key = key.to_s
|
|
131
141
|
key = @key_manager.validate_key(key)
|
|
132
142
|
|
|
@@ -144,32 +154,98 @@ module Dalli
|
|
|
144
154
|
# Fetch multiple keys efficiently.
|
|
145
155
|
# If a block is given, yields key/value pairs one at a time.
|
|
146
156
|
# Otherwise returns a hash of { 'key' => 'value', 'key2' => 'value1' }
|
|
157
|
+
#
|
|
158
|
+
# `req_options` accepts :p_token/:l_token, applied to every key in the batch.
|
|
159
|
+
#
|
|
160
|
+
# A transient network error is retried automatically. If a server remains
|
|
161
|
+
# unreachable after retrying, raises Dalli::NetworkError rather than
|
|
162
|
+
# silently omitting that server's keys from the result.
|
|
163
|
+
#
|
|
164
|
+
# @raise [Dalli::NetworkError] if a server is unreachable after retrying
|
|
147
165
|
# rubocop:disable Style/ExplicitBlockArgument
|
|
148
|
-
def get_multi(*keys)
|
|
166
|
+
def get_multi(*keys, req_options: nil)
|
|
149
167
|
keys.flatten!
|
|
150
168
|
keys.compact!
|
|
151
169
|
return {} if keys.empty?
|
|
152
170
|
|
|
171
|
+
validate_routing_tokens!(req_options)
|
|
172
|
+
|
|
153
173
|
if block_given?
|
|
154
|
-
get_multi_yielding(keys) { |k, v| yield k, v }
|
|
174
|
+
get_multi_yielding(keys, req_options) { |k, v| yield k, v }
|
|
155
175
|
else
|
|
156
|
-
get_multi_hash(keys)
|
|
176
|
+
get_multi_hash(keys, req_options)
|
|
157
177
|
end
|
|
158
178
|
end
|
|
159
179
|
# rubocop:enable Style/ExplicitBlockArgument
|
|
160
180
|
|
|
181
|
+
##
|
|
182
|
+
# Fetch multiple keys efficiently, returning a stale-aware metadata Hash per
|
|
183
|
+
# key. If a block is given, yields key/metadata pairs one at a time.
|
|
184
|
+
#
|
|
185
|
+
# Like #get_multi and #get_multi_cas, keys that were not found are omitted
|
|
186
|
+
# from the result -- absence is the miss. A tombstoned item (see #delete
|
|
187
|
+
# with the meta protocol's invalidate flag) is *not* a miss: it is returned
|
|
188
|
+
# with stale: true, possibly with an empty value, which is the distinction
|
|
189
|
+
# stale-aware callers need.
|
|
190
|
+
#
|
|
191
|
+
# client.get_multi_with_metadata('a', 'b', 'absent')
|
|
192
|
+
# # => { 'a' => { value: 'v', cas: 12, stale: false, miss: false },
|
|
193
|
+
# # 'b' => { value: '', cas: 13, stale: true, miss: false } }
|
|
194
|
+
#
|
|
195
|
+
# Missing keys are `requested - result.keys`.
|
|
196
|
+
#
|
|
197
|
+
# Result key order matches request order only when every key lands on the
|
|
198
|
+
# same server; across multiple servers it follows per-server response
|
|
199
|
+
# order instead, the same as #get_multi.
|
|
200
|
+
#
|
|
201
|
+
# `req_options` accepts :p_token/:l_token, applied to every key in the batch.
|
|
202
|
+
#
|
|
203
|
+
# @param keys [Array<String>] the keys to fetch
|
|
204
|
+
# @param req_options [Hash, nil] routing-token options
|
|
205
|
+
# @return [Hash] key => { value:, cas:, stale:, miss: }
|
|
206
|
+
def get_multi_with_metadata(*keys, req_options: nil, &block)
|
|
207
|
+
keys.flatten!
|
|
208
|
+
keys.compact!
|
|
209
|
+
return {} if keys.empty?
|
|
210
|
+
|
|
211
|
+
validate_routing_tokens!(req_options)
|
|
212
|
+
|
|
213
|
+
results = Instrumentation.trace('get_multi_with_metadata',
|
|
214
|
+
multi_trace_attrs('get_multi_with_metadata', keys.size, keys)) do
|
|
215
|
+
if ring.servers.size == 1
|
|
216
|
+
single_server_get_multi_with_metadata(keys, req_options)
|
|
217
|
+
else
|
|
218
|
+
pipelined_getter.process_with_metadata(keys, req_options)
|
|
219
|
+
end
|
|
220
|
+
end
|
|
221
|
+
|
|
222
|
+
if block
|
|
223
|
+
results.each(&block)
|
|
224
|
+
# Matches get_multi/get_multi_cas: nil when a block is given, so
|
|
225
|
+
# callers can't come to depend on a return value that block-form
|
|
226
|
+
# get_multi never provided.
|
|
227
|
+
return nil
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
results
|
|
231
|
+
end
|
|
232
|
+
|
|
161
233
|
##
|
|
162
234
|
# Fetch multiple keys efficiently, including available metadata such as CAS.
|
|
163
235
|
# If a block is given, yields key/data pairs one a time. Data is an array:
|
|
164
236
|
# [value, cas_id]
|
|
165
237
|
# If no block is given, returns a hash of
|
|
166
238
|
# { 'key' => [value, cas_id] }
|
|
167
|
-
|
|
239
|
+
#
|
|
240
|
+
# `req_options` accepts :p_token/:l_token, applied to every key in the batch.
|
|
241
|
+
def get_multi_cas(*keys, req_options: nil)
|
|
242
|
+
validate_routing_tokens!(req_options)
|
|
243
|
+
|
|
168
244
|
if block_given?
|
|
169
|
-
pipelined_getter.process(keys) { |*args| yield(*args) }
|
|
245
|
+
pipelined_getter.process(keys, req_options) { |*args| yield(*args) }
|
|
170
246
|
else
|
|
171
247
|
{}.tap do |hash|
|
|
172
|
-
pipelined_getter.process(keys) { |k, data| hash[k] = data }
|
|
248
|
+
pipelined_getter.process(keys, req_options) { |k, data| hash[k] = data }
|
|
173
249
|
end
|
|
174
250
|
end
|
|
175
251
|
end
|
|
@@ -225,6 +301,7 @@ module Dalli
|
|
|
225
301
|
def fetch_with_lock(key, ttl: nil, lock_ttl: 30, recache_threshold: nil, req_options: nil, &block)
|
|
226
302
|
raise ArgumentError, 'Block is required for fetch_with_lock' unless block_given?
|
|
227
303
|
|
|
304
|
+
validate_routing_tokens!(req_options)
|
|
228
305
|
key = key.to_s
|
|
229
306
|
key = @key_manager.validate_key(key)
|
|
230
307
|
|
|
@@ -300,16 +377,24 @@ module Dalli
|
|
|
300
377
|
# This method is more efficient than calling set() in a loop because
|
|
301
378
|
# it batches requests by server and uses quiet mode.
|
|
302
379
|
#
|
|
380
|
+
# A transient network error is retried automatically. If a server remains
|
|
381
|
+
# unreachable after retrying, raises Dalli::NetworkError; keys already
|
|
382
|
+
# sent to other servers before the error are not rolled back.
|
|
383
|
+
#
|
|
303
384
|
# @param hash [Hash] key-value pairs to set
|
|
304
385
|
# @param ttl [Integer] time-to-live in seconds (optional, uses default if not provided)
|
|
305
|
-
# @param req_options [Hash] options passed to each set operation
|
|
386
|
+
# @param req_options [Hash] options passed to each set operation; accepts
|
|
387
|
+
# :p_token/:l_token, applied to every key in the batch
|
|
306
388
|
# @return [void]
|
|
389
|
+
# @raise [Dalli::NetworkError] if a server is unreachable after retrying
|
|
307
390
|
#
|
|
308
391
|
# Example:
|
|
309
392
|
# client.set_multi({ 'key1' => 'value1', 'key2' => 'value2' }, 300)
|
|
310
393
|
def set_multi(hash, ttl = nil, req_options = nil)
|
|
311
394
|
return if hash.empty?
|
|
312
395
|
|
|
396
|
+
validate_routing_tokens!(req_options)
|
|
397
|
+
|
|
313
398
|
Instrumentation.trace('set_multi', multi_trace_attrs('set_multi', hash.size, hash.keys)) do
|
|
314
399
|
if ring.servers.size == 1
|
|
315
400
|
single_server_set_multi(hash, ttl_or_default(ttl), req_options)
|
|
@@ -323,6 +408,7 @@ module Dalli
|
|
|
323
408
|
# Set the key-value pair, verifying existing CAS.
|
|
324
409
|
# Returns the resulting CAS value if succeeded, and falsy otherwise.
|
|
325
410
|
def set_cas(key, value, cas, ttl = nil, req_options = nil)
|
|
411
|
+
validate_routing_tokens!(req_options)
|
|
326
412
|
perform(:set, key, value, ttl_or_default(ttl), cas, req_options)
|
|
327
413
|
end
|
|
328
414
|
|
|
@@ -330,6 +416,7 @@ module Dalli
|
|
|
330
416
|
# Conditionally add a key/value pair, if the key does not already exist
|
|
331
417
|
# on the server. Returns truthy if the operation succeeded.
|
|
332
418
|
def add(key, value, ttl = nil, req_options = nil)
|
|
419
|
+
validate_routing_tokens!(req_options)
|
|
333
420
|
perform(:add, key, value, ttl_or_default(ttl), req_options)
|
|
334
421
|
end
|
|
335
422
|
|
|
@@ -345,17 +432,49 @@ module Dalli
|
|
|
345
432
|
# key already exists on the server. Returns the new CAS value if the
|
|
346
433
|
# operation succeeded, or falsy otherwise.
|
|
347
434
|
def replace_cas(key, value, cas, ttl = nil, req_options = nil)
|
|
435
|
+
validate_routing_tokens!(req_options)
|
|
348
436
|
perform(:replace, key, value, ttl_or_default(ttl), cas, req_options)
|
|
349
437
|
end
|
|
350
438
|
|
|
351
439
|
# Delete a key/value pair, verifying existing CAS.
|
|
352
440
|
# Returns true if succeeded, and falsy otherwise.
|
|
353
|
-
|
|
354
|
-
|
|
441
|
+
# Delete a key, optionally with a CAS check.
|
|
442
|
+
#
|
|
443
|
+
# `req_options` accepts the same meta-delete options as #delete.
|
|
444
|
+
def delete_cas(key, cas = 0, req_options = nil)
|
|
445
|
+
validate_delete_options!(req_options)
|
|
446
|
+
validate_routing_tokens!(req_options)
|
|
447
|
+
perform(:delete, key, cas, req_options)
|
|
355
448
|
end
|
|
356
449
|
|
|
357
|
-
|
|
358
|
-
|
|
450
|
+
##
|
|
451
|
+
# Delete a key.
|
|
452
|
+
#
|
|
453
|
+
# `req_options` may include the memcached meta-delete options:
|
|
454
|
+
#
|
|
455
|
+
# - `:invalidate` (Boolean) — mark the item stale instead of removing it.
|
|
456
|
+
# This is the tombstone: readers see `stale: true` from
|
|
457
|
+
# #get_with_metadata and #get_multi_with_metadata, and the existing value
|
|
458
|
+
# is still readable unless `:drop_value` is also set. A tombstoned key is
|
|
459
|
+
# *not* a miss, which lets a reader tell "another process is repopulating
|
|
460
|
+
# this" apart from "this was never here".
|
|
461
|
+
# - `:tombstone_ttl` (Integer seconds) — how long the stale marker lives.
|
|
462
|
+
# Requires `:invalidate`; memcached only honors the TTL on a delete when
|
|
463
|
+
# it accompanies the invalidate flag, so passing it alone raises
|
|
464
|
+
# ArgumentError rather than sending a request the server would treat
|
|
465
|
+
# differently than intended. Once it elapses, reads see a miss.
|
|
466
|
+
# - `:drop_value` (Boolean) — remove the item's value but leave the item, so
|
|
467
|
+
# a tombstone need not retain the old payload. On its own it is not a
|
|
468
|
+
# tombstone: reads are an ordinary hit with an empty value.
|
|
469
|
+
# - `:p_token`/`:l_token` (String) — opaque routing tokens for an
|
|
470
|
+
# intermediate proxy or router; see #get.
|
|
471
|
+
#
|
|
472
|
+
# dc.delete('key', invalidate: true, tombstone_ttl: 30, drop_value: true)
|
|
473
|
+
#
|
|
474
|
+
# @param key [String] the key to delete
|
|
475
|
+
# @param req_options [Hash, nil] meta-delete options
|
|
476
|
+
def delete(key, req_options = nil)
|
|
477
|
+
delete_cas(key, 0, req_options)
|
|
359
478
|
end
|
|
360
479
|
|
|
361
480
|
##
|
|
@@ -363,19 +482,35 @@ module Dalli
|
|
|
363
482
|
# This method is more efficient than calling delete() in a loop because
|
|
364
483
|
# it batches requests by server and uses quiet mode.
|
|
365
484
|
#
|
|
485
|
+
# `req_options` accepts the same meta-delete options as #delete and applies
|
|
486
|
+
# them to every key in the batch.
|
|
487
|
+
#
|
|
366
488
|
# @param keys [Array<String>] keys to delete
|
|
367
|
-
# @
|
|
489
|
+
# @param req_options [Hash, nil] meta-delete options
|
|
490
|
+
# @return [Integer] the number of keys the server found and acted on. Only a
|
|
491
|
+
# key that did not exist decrements this count, so with `:invalidate` it
|
|
492
|
+
# reports how many keys were tombstoned rather than removed -- the action
|
|
493
|
+
# is whichever one the caller asked for. This is best-effort: a transient
|
|
494
|
+
# network error is retried automatically, and keys handled before the
|
|
495
|
+
# error are not recounted, so the result may under-report when a retry
|
|
496
|
+
# occurs. If a server remains unreachable after retrying, raises
|
|
497
|
+
# Dalli::NetworkError.
|
|
498
|
+
# @raise [Dalli::NetworkError] if a server is unreachable after retrying
|
|
368
499
|
#
|
|
369
500
|
# Example:
|
|
370
501
|
# client.delete_multi(['key1', 'key2', 'key3'])
|
|
371
|
-
|
|
372
|
-
|
|
502
|
+
# client.delete_multi(%w[key1 key2], invalidate: true, tombstone_ttl: 30)
|
|
503
|
+
def delete_multi(keys, req_options = nil)
|
|
504
|
+
return 0 if keys.empty?
|
|
505
|
+
|
|
506
|
+
validate_delete_options!(req_options)
|
|
507
|
+
validate_routing_tokens!(req_options)
|
|
373
508
|
|
|
374
509
|
Instrumentation.trace('delete_multi', multi_trace_attrs('delete_multi', keys.size, keys)) do
|
|
375
510
|
if ring.servers.size == 1
|
|
376
|
-
single_server_delete_multi(keys)
|
|
511
|
+
single_server_delete_multi(keys, req_options)
|
|
377
512
|
else
|
|
378
|
-
pipelined_deleter.process(keys)
|
|
513
|
+
pipelined_deleter.process(keys, req_options)
|
|
379
514
|
end
|
|
380
515
|
end
|
|
381
516
|
end
|
|
@@ -383,15 +518,17 @@ module Dalli
|
|
|
383
518
|
##
|
|
384
519
|
# Append value to the value already stored on the server for 'key'.
|
|
385
520
|
# Appending only works for values stored with :raw => true.
|
|
386
|
-
def append(key, value)
|
|
387
|
-
|
|
521
|
+
def append(key, value, req_options = nil)
|
|
522
|
+
validate_routing_tokens!(req_options)
|
|
523
|
+
perform(:append, key, value.to_s, req_options)
|
|
388
524
|
end
|
|
389
525
|
|
|
390
526
|
##
|
|
391
527
|
# Prepend value to the value already stored on the server for 'key'.
|
|
392
528
|
# Prepending only works for values stored with :raw => true.
|
|
393
|
-
def prepend(key, value)
|
|
394
|
-
|
|
529
|
+
def prepend(key, value, req_options = nil)
|
|
530
|
+
validate_routing_tokens!(req_options)
|
|
531
|
+
perform(:prepend, key, value.to_s, req_options)
|
|
395
532
|
end
|
|
396
533
|
|
|
397
534
|
##
|
|
@@ -407,10 +544,11 @@ module Dalli
|
|
|
407
544
|
# #cas.
|
|
408
545
|
#
|
|
409
546
|
# If the value already exists, it must have been set with raw: true
|
|
410
|
-
def incr(key, amt = 1, ttl = nil, default = nil)
|
|
547
|
+
def incr(key, amt = 1, ttl = nil, default = nil, req_options = nil)
|
|
411
548
|
check_positive!(amt)
|
|
549
|
+
validate_routing_tokens!(req_options)
|
|
412
550
|
|
|
413
|
-
perform(:incr, key, amt.to_i, ttl_or_default(ttl), default)
|
|
551
|
+
perform(:incr, key, amt.to_i, ttl_or_default(ttl), default, req_options)
|
|
414
552
|
end
|
|
415
553
|
|
|
416
554
|
##
|
|
@@ -429,10 +567,11 @@ module Dalli
|
|
|
429
567
|
# #cas.
|
|
430
568
|
#
|
|
431
569
|
# If the value already exists, it must have been set with raw: true
|
|
432
|
-
def decr(key, amt = 1, ttl = nil, default = nil)
|
|
570
|
+
def decr(key, amt = 1, ttl = nil, default = nil, req_options = nil)
|
|
433
571
|
check_positive!(amt)
|
|
572
|
+
validate_routing_tokens!(req_options)
|
|
434
573
|
|
|
435
|
-
perform(:decr, key, amt.to_i, ttl_or_default(ttl), default)
|
|
574
|
+
perform(:decr, key, amt.to_i, ttl_or_default(ttl), default, req_options)
|
|
436
575
|
end
|
|
437
576
|
|
|
438
577
|
##
|
|
@@ -509,6 +648,30 @@ module Dalli
|
|
|
509
648
|
|
|
510
649
|
private
|
|
511
650
|
|
|
651
|
+
# Raised before the request reaches a server: RequestFormatter enforces the
|
|
652
|
+
# same rule, but reaching it means unwinding through Protocol::Base#request,
|
|
653
|
+
# which logs the failure as unexpected and closes the connection. A caller
|
|
654
|
+
# passing the wrong options should get a clean ArgumentError and keep its
|
|
655
|
+
# connection.
|
|
656
|
+
def validate_delete_options!(req_options)
|
|
657
|
+
return unless req_options.is_a?(Hash)
|
|
658
|
+
|
|
659
|
+
tombstone_ttl = req_options[:tombstone_ttl]
|
|
660
|
+
return unless tombstone_ttl
|
|
661
|
+
|
|
662
|
+
raise ArgumentError, 'tombstone_ttl requires invalidate: true' unless req_options[:invalidate]
|
|
663
|
+
|
|
664
|
+
# tombstone_kwargs coerces this with Integer(), deep inside the request
|
|
665
|
+
# path; validated here first so a bad value raises cleanly instead of
|
|
666
|
+
# unwinding through Protocol::Base#request, which would close the
|
|
667
|
+
# connection on the ArgumentError Integer() raises.
|
|
668
|
+
begin
|
|
669
|
+
Integer(tombstone_ttl)
|
|
670
|
+
rescue ArgumentError, TypeError
|
|
671
|
+
raise ArgumentError, "tombstone_ttl must be an integer, got #{tombstone_ttl.inspect}"
|
|
672
|
+
end
|
|
673
|
+
end
|
|
674
|
+
|
|
512
675
|
def record_hit_miss_metrics(span, key_count, hit_count)
|
|
513
676
|
return unless span
|
|
514
677
|
|
|
@@ -516,10 +679,10 @@ module Dalli
|
|
|
516
679
|
'db.memcached.miss_count' => key_count - hit_count)
|
|
517
680
|
end
|
|
518
681
|
|
|
519
|
-
def get_multi_yielding(keys)
|
|
682
|
+
def get_multi_yielding(keys, req_options = nil)
|
|
520
683
|
Instrumentation.trace_with_result('get_multi', get_multi_attributes(keys)) do |span|
|
|
521
684
|
hit_count = 0
|
|
522
|
-
pipelined_getter.process(keys) do |k, data|
|
|
685
|
+
pipelined_getter.process(keys, req_options) do |k, data|
|
|
523
686
|
hit_count += 1
|
|
524
687
|
yield k, data.first
|
|
525
688
|
end
|
|
@@ -528,13 +691,13 @@ module Dalli
|
|
|
528
691
|
end
|
|
529
692
|
end
|
|
530
693
|
|
|
531
|
-
def get_multi_hash(keys)
|
|
694
|
+
def get_multi_hash(keys, req_options = nil)
|
|
532
695
|
Instrumentation.trace_with_result('get_multi', get_multi_attributes(keys)) do |span|
|
|
533
696
|
hash = if ring.servers.size == 1
|
|
534
|
-
single_server_get_multi(keys)
|
|
697
|
+
single_server_get_multi(keys, req_options)
|
|
535
698
|
else
|
|
536
699
|
{}.tap do |h|
|
|
537
|
-
pipelined_getter.process(keys) { |k, data| h[k] = data.first }
|
|
700
|
+
pipelined_getter.process(keys, req_options) { |k, data| h[k] = data.first }
|
|
538
701
|
end
|
|
539
702
|
end
|
|
540
703
|
record_hit_miss_metrics(span, keys.size, hash.size)
|
|
@@ -547,11 +710,33 @@ module Dalli
|
|
|
547
710
|
server if server&.alive?
|
|
548
711
|
end
|
|
549
712
|
|
|
550
|
-
|
|
713
|
+
# The three single_server_* fast-path methods below share one contract,
|
|
714
|
+
# matching the pipelined multi-server path they stand in for: a transient
|
|
715
|
+
# RetryableNetworkError is retried (bounded implicitly by the server's own
|
|
716
|
+
# socket_max_failures, same as the pipelined path's retry), and a hard
|
|
717
|
+
# NetworkError -- the server genuinely unreachable, not just blipping --
|
|
718
|
+
# propagates to the caller rather than being swallowed into a silently
|
|
719
|
+
# wrong result. Only server_for_key/single_server finding no live server
|
|
720
|
+
# to route to at all is still silent, matching Ring#keys_grouped_by_server
|
|
721
|
+
# dropping a key it can't route on both the single- and multi-server paths.
|
|
722
|
+
def single_server_get_multi(keys, req_options = nil)
|
|
723
|
+
keys.map! { |k| @key_manager.validate_key(k.to_s) }
|
|
724
|
+
return {} unless (server = single_server)
|
|
725
|
+
|
|
726
|
+
result = server.request(:read_multi_req, keys, req_options)
|
|
727
|
+
result.transform_keys! { |k| @key_manager.key_without_namespace(k) }
|
|
728
|
+
result
|
|
729
|
+
rescue Dalli::RetryableNetworkError => e
|
|
730
|
+
Dalli.logger.debug { e.inspect }
|
|
731
|
+
Dalli.logger.debug { 'retrying single-server get_multi because of network error' }
|
|
732
|
+
retry
|
|
733
|
+
end
|
|
734
|
+
|
|
735
|
+
def single_server_get_multi_with_metadata(keys, req_options = nil)
|
|
551
736
|
keys.map! { |k| @key_manager.validate_key(k.to_s) }
|
|
552
737
|
return {} unless (server = single_server)
|
|
553
738
|
|
|
554
|
-
result = server.request(:
|
|
739
|
+
result = server.request(:read_multi_with_metadata_req, keys, req_options)
|
|
555
740
|
result.transform_keys! { |k| @key_manager.key_without_namespace(k) }
|
|
556
741
|
result
|
|
557
742
|
rescue Dalli::NetworkError
|
|
@@ -563,17 +748,21 @@ module Dalli
|
|
|
563
748
|
return unless (server = single_server)
|
|
564
749
|
|
|
565
750
|
server.request(:write_multi_req, pairs, ttl, req_options)
|
|
566
|
-
rescue Dalli::
|
|
567
|
-
|
|
751
|
+
rescue Dalli::RetryableNetworkError => e
|
|
752
|
+
Dalli.logger.debug { e.inspect }
|
|
753
|
+
Dalli.logger.debug { 'retrying single-server set_multi because of network error' }
|
|
754
|
+
retry
|
|
568
755
|
end
|
|
569
756
|
|
|
570
|
-
def single_server_delete_multi(keys)
|
|
757
|
+
def single_server_delete_multi(keys, req_options = nil)
|
|
571
758
|
validated_keys = keys.map { |k| @key_manager.validate_key(k.to_s) }
|
|
572
|
-
return unless (server = single_server)
|
|
759
|
+
return 0 unless (server = single_server)
|
|
573
760
|
|
|
574
|
-
server.request(:delete_multi_req, validated_keys)
|
|
575
|
-
rescue Dalli::
|
|
576
|
-
|
|
761
|
+
server.request(:delete_multi_req, validated_keys, req_options)
|
|
762
|
+
rescue Dalli::RetryableNetworkError => e
|
|
763
|
+
Dalli.logger.debug { e.inspect }
|
|
764
|
+
Dalli.logger.debug { 'retrying single-server delete_multi because of network error' }
|
|
765
|
+
retry
|
|
577
766
|
end
|
|
578
767
|
|
|
579
768
|
def get_multi_attributes(keys)
|
|
@@ -607,8 +796,33 @@ module Dalli
|
|
|
607
796
|
raise ArgumentError, "Positive values only: #{amt}" if amt.negative?
|
|
608
797
|
end
|
|
609
798
|
|
|
799
|
+
# Validated here, before the request reaches Protocol::Base#request, rather
|
|
800
|
+
# than only at the RequestFormatter level. Reaching only the formatter's
|
|
801
|
+
# check means unwinding through Protocol::Base#request, which logs the
|
|
802
|
+
# failure as unexpected and closes the connection -- a caller passing a
|
|
803
|
+
# bad token should get a clean ArgumentError and keep its connection.
|
|
804
|
+
ROUTING_TOKEN_FORBIDDEN = /[\r\n\0]/
|
|
805
|
+
private_constant :ROUTING_TOKEN_FORBIDDEN
|
|
806
|
+
|
|
807
|
+
def validate_routing_tokens!(req_options)
|
|
808
|
+
return unless req_options.is_a?(Hash)
|
|
809
|
+
|
|
810
|
+
validate_routing_token!(:p_token, req_options[:p_token])
|
|
811
|
+
validate_routing_token!(:l_token, req_options[:l_token])
|
|
812
|
+
end
|
|
813
|
+
|
|
814
|
+
def validate_routing_token!(name, value)
|
|
815
|
+
# Only an empty *String* is a no-op; see the matching comment in
|
|
816
|
+
# RequestFormatter#routing_tokens for why respond_to?(:empty?) is wrong
|
|
817
|
+
# here (it would also excuse [] / {} from the type check below).
|
|
818
|
+
return if value.nil? || (value.is_a?(String) && value.empty?)
|
|
819
|
+
raise ArgumentError, "#{name} must be a String, got #{value.class}" unless value.is_a?(String)
|
|
820
|
+
raise ArgumentError, "#{name} must not contain CRLF or null bytes" if value.match?(ROUTING_TOKEN_FORBIDDEN)
|
|
821
|
+
end
|
|
822
|
+
|
|
610
823
|
def cas_core(key, always_set, ttl = nil, req_options = nil)
|
|
611
|
-
(
|
|
824
|
+
validate_routing_tokens!(req_options)
|
|
825
|
+
(value, cas) = perform(:cas, key, req_options)
|
|
612
826
|
return if value.nil? && !always_set
|
|
613
827
|
|
|
614
828
|
newvalue = yield(value)
|
|
@@ -617,7 +831,13 @@ module Dalli
|
|
|
617
831
|
|
|
618
832
|
def fetch_with_lock_request(key, ttl, lock_ttl, recache_threshold, req_options)
|
|
619
833
|
server = ring.server_for_key(key)
|
|
620
|
-
|
|
834
|
+
# req_options is the base, not the override: fetch_with_lock's own
|
|
835
|
+
# lock_ttl/recache_threshold parameters must always win, even if a
|
|
836
|
+
# caller's req_options happened to contain :vivify_ttl/:recache_ttl.
|
|
837
|
+
meta_options = req_options.is_a?(Hash) ? req_options.dup : {}
|
|
838
|
+
meta_options[:vivify_ttl] = lock_ttl
|
|
839
|
+
meta_options[:recache_ttl] = recache_threshold
|
|
840
|
+
result = server.request(:meta_get, key, meta_options)
|
|
621
841
|
|
|
622
842
|
return result[:value] unless result[:won_recache]
|
|
623
843
|
|
|
@@ -651,7 +871,7 @@ module Dalli
|
|
|
651
871
|
# operation times out.
|
|
652
872
|
##
|
|
653
873
|
# rubocop:disable Naming/MethodParameterName
|
|
654
|
-
def perform(op, key,
|
|
874
|
+
def perform(op, key, ...)
|
|
655
875
|
# rubocop:enable Naming/MethodParameterName
|
|
656
876
|
return yield if block_given?
|
|
657
877
|
|
|
@@ -659,8 +879,14 @@ module Dalli
|
|
|
659
879
|
key = @key_manager.validate_key(key)
|
|
660
880
|
|
|
661
881
|
server = ring.server_for_key(key)
|
|
662
|
-
|
|
663
|
-
|
|
882
|
+
|
|
883
|
+
if Instrumentation.enabled?
|
|
884
|
+
op_name = op.name
|
|
885
|
+
Instrumentation.trace(op_name, trace_attrs(op_name, key, server)) do
|
|
886
|
+
server.request(op, key, ...)
|
|
887
|
+
end
|
|
888
|
+
else
|
|
889
|
+
server.request(op, key, ...)
|
|
664
890
|
end
|
|
665
891
|
rescue RetryableNetworkError => e
|
|
666
892
|
Dalli.logger.debug { e.inspect }
|
data/lib/dalli/options.rb
CHANGED
|
@@ -15,17 +15,27 @@ module Dalli
|
|
|
15
15
|
##
|
|
16
16
|
# Deletes multiple keys from memcached.
|
|
17
17
|
#
|
|
18
|
+
# `req_options` is applied to every delete in the batch (see
|
|
19
|
+
# Dalli::Client#delete for the supported meta-delete keys).
|
|
20
|
+
#
|
|
18
21
|
# @param keys [Array<String>] keys to delete
|
|
19
|
-
# @return [
|
|
22
|
+
# @return [Integer] the number of keys the server found and acted on. Only
|
|
23
|
+
# a key that did not exist decrements this count, so with
|
|
24
|
+
# `req_options: {invalidate: true}` it reports how many keys were
|
|
25
|
+
# tombstoned rather than removed. This is best-effort: a transient
|
|
26
|
+
# network error is retried automatically, and keys handled before the
|
|
27
|
+
# error are not recounted, so the result may under-report when a retry
|
|
28
|
+
# occurs. If a server remains unreachable after retrying, raises
|
|
29
|
+
# Dalli::NetworkError.
|
|
20
30
|
##
|
|
21
|
-
def process(keys)
|
|
22
|
-
return if keys.empty?
|
|
31
|
+
def process(keys, req_options = nil)
|
|
32
|
+
return 0 if keys.empty?
|
|
23
33
|
|
|
24
34
|
@ring.lock do
|
|
25
|
-
|
|
26
|
-
finish_requests(
|
|
35
|
+
groups = setup_requests(keys, req_options)
|
|
36
|
+
finish_requests(groups)
|
|
27
37
|
end
|
|
28
|
-
rescue
|
|
38
|
+
rescue Dalli::RetryableNetworkError => e
|
|
29
39
|
Dalli.logger.debug { e.inspect }
|
|
30
40
|
Dalli.logger.debug { 'retrying pipelined deletes because of network error' }
|
|
31
41
|
retry
|
|
@@ -33,36 +43,50 @@ module Dalli
|
|
|
33
43
|
|
|
34
44
|
private
|
|
35
45
|
|
|
36
|
-
def setup_requests(keys)
|
|
46
|
+
def setup_requests(keys, req_options = nil)
|
|
37
47
|
groups = groups_for_keys(keys)
|
|
38
|
-
make_delete_requests(groups)
|
|
39
|
-
groups
|
|
48
|
+
make_delete_requests(groups, req_options)
|
|
49
|
+
groups
|
|
40
50
|
end
|
|
41
51
|
|
|
42
52
|
##
|
|
43
53
|
# Loop through the server-grouped sets of keys, writing
|
|
44
54
|
# the corresponding quiet delete requests to the appropriate servers
|
|
45
55
|
##
|
|
46
|
-
|
|
56
|
+
# NetworkError (which RetryableNetworkError subclasses) must propagate: the
|
|
57
|
+
# top-level rescue in #process retries the whole pipelined delete on it. A
|
|
58
|
+
# combined `rescue DalliError, NetworkError` would silently swallow
|
|
59
|
+
# RetryableNetworkError too -- since NetworkError < DalliError -- dropping
|
|
60
|
+
# this server's keys on a transient hiccup instead of retrying. Only a
|
|
61
|
+
# non-network DalliError should be swallowed here.
|
|
62
|
+
def make_delete_requests(groups, req_options = nil)
|
|
47
63
|
groups.each do |server, keys_for_server|
|
|
48
|
-
keys_for_server.
|
|
49
|
-
server.request(:pipelined_delete, key)
|
|
50
|
-
|
|
64
|
+
keys_for_server.select! do |key|
|
|
65
|
+
server.request(:pipelined_delete, key, req_options)
|
|
66
|
+
true
|
|
67
|
+
rescue Dalli::NetworkError
|
|
68
|
+
raise
|
|
69
|
+
rescue DalliError => e
|
|
51
70
|
Dalli.logger.debug { e.inspect }
|
|
52
71
|
Dalli.logger.debug { "unable to delete key #{key} for server #{server.name}" }
|
|
72
|
+
false
|
|
53
73
|
end
|
|
54
74
|
end
|
|
55
75
|
end
|
|
56
76
|
|
|
57
77
|
##
|
|
58
78
|
# Sends noop to each server to flush responses and ensure all deletes complete.
|
|
79
|
+
# Returns the total successful deletes across servers.
|
|
59
80
|
##
|
|
60
|
-
def finish_requests(
|
|
61
|
-
|
|
62
|
-
server.request(:
|
|
63
|
-
rescue
|
|
81
|
+
def finish_requests(groups)
|
|
82
|
+
groups.sum do |server, keys_for_server|
|
|
83
|
+
server.request(:finish_pipelined_delete, keys_for_server.size)
|
|
84
|
+
rescue Dalli::NetworkError
|
|
85
|
+
raise
|
|
86
|
+
rescue DalliError => e
|
|
64
87
|
Dalli.logger.debug { e.inspect }
|
|
65
88
|
Dalli.logger.debug { "unable to complete pipelined delete on server #{server.name}" }
|
|
89
|
+
0
|
|
66
90
|
end
|
|
67
91
|
end
|
|
68
92
|
|