dalli 2.7.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e3197932a3392dbaf7e6c59789506a28a61e3ace
-  data.tar.gz: f4d9b560f4294773b1555beee774c94def079f81
+SHA256:
+  metadata.gz: 48a2e02ec2d89d9304b68d36ed3827f4677398043a875f10c78a47f0517f579b
+  data.tar.gz: f2f365d5bc6d353fed61fd72866460c2e2929de9097018639f78687d96dae320
 SHA512:
-  metadata.gz: 07c253819a5a2f40002b48f44439bc4eaa784cf0154cf769d852b28ec26657e24696bc97832fe47f6c34ffcb81a4dbdeb643f53bca491085d298053d77c3098e
-  data.tar.gz: 5da4300af76b9899673044ee73fbd011cfe5ce2962028692f9e47a983a0bceaeee60493a91464be44f3b05f28409f163d5d9801aa73f81e395e3f041ae61e3fd
+  metadata.gz: 732930e9654c116fbf3769bac8091126f831eb22d795ed8f7d70479ab3a15591576b9e88d150fc5a79590dbec309249d144de909698c010284bbb30b585c5180
+  data.tar.gz: 54aa18fc3808423e74507f1a3934afbbc60b78c080fc3e5bf790a1daf7832af9a8481f77c5dc8fcb428ca9743ec3f5eb3cb0258517d7cb126e5dd3c749e8f56f

data/Gemfile

@@ -1,12 +1,10 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'rake'
-gem 'kgio', :platform => :mri
-gem 'appraisal'
-gem 'connection_pool'
-
 group :test do
-  gem 'simplecov'
+  gem "minitest"
+  gem "rake"
+  gem "simplecov"
+  gem "ruby-prof", platform: :mri
 end

data/History.md

@@ -1,6 +1,113 @@
 Dalli Changelog
 =====================
 
+3.0.0
+==========
+- BREAKING CHANGES:
+
+- Removes :dalli_store.
+  Use Rails' official :mem_cache_store instead.
+  https://guides.rubyonrails.org/caching_with_rails.html
+- Attempting to store a larger value than allowed by memcached used to
+  print a warning and truncate the value. This now raises an error to
+  prevent silent data corruption.
+- Compression now defaults to `true` for large values (greater than 4KB).
+  This is intended to minimize errors due to the previous note.
+- Errors marshalling values now raise rather than just printing an error.
+- The Rack session adapter has been refactored to remove support for thread-unsafe
+  configurations. You will need to include the `connection_pool` gem in
+  your Gemfile to ensure session operations are thread-safe.
+
+- Raise NetworkError when multi response gets into corrupt state (mervync, #783)
+- Validate servers argument (semaperepelitsa, petergoldstein, #776)
+- Enable SSL support (bdunne, #775)
+- Add gat operation (tbeauvais, #769)
+- Removes inline native code, use Ruby 2.3+ support for bsearch instead. (mperham)
+- Switch repo to Github Actions and upgrade Ruby versions (petergoldstein, bdunne, Fryguy)
+- Update benchmark test for Rubyprof changes (nateberkopec)
+- Remove support for the `kgio` gem, it is not relevant in Ruby 2.3+. (mperham)
+- Remove inline native code, use Ruby 2.3+ support for bsearch instead. (mperham)
+
+
+2.7.11
+==========
+- DEPRECATION: :dalli_store will be removed in Dalli 3.0.
+  Use Rails' official :mem_cache_store instead.
+  https://guides.rubyonrails.org/caching_with_rails.html
+- Add new `digest_class` option to Dalli::Client [#724]
+- Don't treat NameError as a network error [#728]
+- Handle nested comma separated server strings (sambostock)
+
+2.7.10
+==========
+- Revert frozen string change (schneems)
+- Advertise supports_cached_versioning? in DalliStore (schneems)
+- Better detection of fork support, to allow specs to run under Truffle Ruby (deepj)
+- Update logging for over max size to log as error (aeroastro)
+
+2.7.9
+==========
+- Fix behavior for Rails 5.2+ cache_versioning (GriwMF)
+- Ensure fetch provides the key to the fallback block as an argument (0exp)
+- Assorted performance improvements (schneems)
+
+2.7.8
+==========
+- Rails 5.2 compatibility (pbougie)
+- Fix Session Cache compatibility (pixeltrix)
+
+2.7.7
+==========
+- Support large cache keys on fetch multi (sobrinho)
+- Not found checks no longer trigger the result's equality method (dannyfallon)
+- Use SVG build badges (olleolleolle)
+- Travis updates (junaruga, tiarly, petergoldstein)
+- Update default down_retry_delay (jaredhales)
+- Close kgio socket after IO.select timeouts
+- Documentation updates (tipair)
+- Instrument DalliStore errors with instrument_errors configuration option. (btatnall)
+
+2.7.6
+==========
+- Rails 5.0.0.beta2 compatibility (yui-knk, petergoldstein)
+- Add cas!, a variant of the #cas method that yields to the block whether or not the key already exist (mwpastore)
+- Performance improvements (nateberkopec)
+- Add Ruby 2.3.0 to support matrix (tricknotes)
+
+2.7.5
+==========
+
+- Support rcvbuff and sndbuff byte configuration. (btatnall)
+- Add `:cache_nils` option to support nil values in `DalliStore#fetch` and `Dalli::Client#fetch` (wjordan, #559)
+- Log retryable server errors with 'warn' instead of 'info' (phrinx)
+- Fix timeout issue with Dalli::Client#get_multi_yielder (dspeterson)
+- Escape namespaces with special regexp characters (Steven Peckins)
+- Ensure LocalCache supports the `:raw` option and Entry unwrapping (sj26)
+- Ensure bad ttl values don't cause Dalli::RingError (eagletmt, petergoldstein)
+- Always pass namespaced key to instrumentation API (kaorimatz)
+- Replace use of deprecated TimeoutError with Timeout::Error (eagletmt)
+- Clean up gemspec, and use Bundler for loading (grosser)
+- Dry up local cache testing (grosser)
+
+2.7.4
+==========
+
+- Restore Windows compatibility (dfens, #524)
+
+2.7.3
+==========
+
+- Assorted spec improvements
+- README changes to specify defaults for failover and compress options (keen99, #470)
+- SASL authentication changes to deal with Unicode characters (flypiggy, #477)
+- Call to_i on ttl to accomodate ActiveSupport::Duration (#494)
+- Change to implicit blocks for performance (glaucocustodio, #495)
+- Change to each_key for performance (jastix, #496)
+- Support stats settings - (dterei, #500)
+- Raise DallError if hostname canno be parsed (dannyfallon, #501)
+- Fix instrumentation for falsey values (AlexRiedler, #514)
+- Support UNIX socket configurations (r-stu31, #515)
+
 2.7.2
 ==========
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) Mike Perham
+Copyright (c) Peter M. Goldstein, Mike Perham
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,4 @@
-Dalli [![Build Status](https://secure.travis-ci.org/mperham/dalli.png)](http://travis-ci.org/mperham/dalli) [![Dependency Status](https://gemnasium.com/mperham/dalli.png)](https://gemnasium.com/mperham/dalli) [![Code Climate](https://codeclimate.com/github/mperham/dalli.png)](https://codeclimate.com/github/mperham/dalli)
+Dalli [![Tests](https://github.com/petergoldstein/dalli/actions/workflows/tests.yml/badge.svg)](https://github.com/petergoldstein/dalli/actions/workflows/tests.yml)
 =====
 
 Dalli is a high performance pure Ruby client for accessing memcached servers.  It works with memcached 1.4+ only as it uses the newer binary protocol.  It should be considered a replacement for the memcache-client gem.
@@ -9,26 +9,6 @@ The name is a variant of Salvador Dali for his famous painting [The Persistence
 
 Dalli's initial development was sponsored by [CouchBase](http://www.couchbase.com/).  Many thanks to them!
 
-
-Design
-------------
-
-I decided to write Dalli after maintaining memcache-client for two years for a few specific reasons:
-
- 0. The code is mostly old and gross.  The bulk of the code is a single 1000 line .rb file.
- 1. It has a lot of options that are infrequently used which complicate the codebase.
- 2. The implementation has no single point to attach monitoring hooks.
- 3. Uses the old text protocol, which hurts raw performance.
-
-So a few notes.  Dalli:
-
- 0. uses the exact same algorithm to choose a server so existing memcached clusters with TBs of data will work identically to memcache-client.
- 1. is approximately 20% faster than memcache-client (which itself was heavily optimized) in Ruby 1.9.2.
- 2. contains explicit "chokepoint" methods which handle all requests; these can be hooked into by monitoring tools (NewRelic, Rack::Bug, etc) to track memcached usage.
- 3. supports SASL for use in managed environments, e.g. Heroku.
- 4. provides proper failover with recovery and adjustable timeouts
-
-
 Supported Ruby versions and implementations
 ------------------------------------------------
 
@@ -44,7 +24,7 @@ If you have problems, please enter an issue.
 Installation and Usage
 ------------------------
 
-Remember, Dalli **requires** memcached 1.4+. You can check the version with `memcached -h`. Please note that memcached that Mac OS X Snow Leopard ships with is 1.2.8 and won't work. Install 1.4.x using Homebrew with
+Remember, Dalli **requires** memcached 1.4+. You can check the version with `memcached -h`. Please note that the memcached version that *Mac OS X Snow Leopard* ships with is 1.2.8 and it won't work. Install memcached 1.4.x using Homebrew with
 
     brew install memcached
 
@@ -66,126 +46,84 @@ dc.set('abc', 123)
 value = dc.get('abc')
 ```
 
-The test suite requires memcached 1.4.3+ with SASL enabled (brew install memcached --enable-sasl ; mv /usr/bin/memcached /usr/bin/memcached.old).  Currently only supports the PLAIN mechanism.
-
-Dalli has no runtime dependencies and never will.  You can optionally install the 'kgio' gem to
-give Dalli a 20-30% performance boost.
-
-
-Usage with Rails 3.x and 4.x
----------------------------
-
-In your Gemfile:
-
-```ruby
-gem 'dalli'
-```
-
-In `config/environments/production.rb`:
-
-```ruby
-config.cache_store = :dalli_store
-```
-
-Here's a more comprehensive example that sets a reasonable default for maximum cache entry lifetime (one day), enables compression for large values and namespaces all entries for this rails app.  Remove the namespace if you have multiple apps which share cached values.
-
-```ruby
-config.cache_store = :dalli_store, 'cache-1.example.com', 'cache-2.example.com',
-  { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true }
-```
-
-If your servers are specified in `ENV["MEMCACHE_SERVERS"]` (e.g. on Heroku when using a third-party hosted addon), simply provide `nil` for the servers:
-
-```ruby
-config.cache_store = :dalli_store, nil, { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true }
-```
-
-To use Dalli for Rails session storage that times out after 20 minutes, in `config/initializers/session_store.rb`:
-
-For Rails >= 3.2.4:
-
-```ruby
-Rails.application.config.session_store ActionDispatch::Session::CacheStore, :expire_after => 20.minutes
-```
-
-For Rails 3.x:
-
-```ruby
-require 'action_dispatch/middleware/session/dalli_store'
-Rails.application.config.session_store :dalli_store, :memcache_server => ['host1', 'host2'], :namespace => 'sessions', :key => '_foundation_session', :expire_after => 20.minutes
-```
-
-Dalli does not support Rails 2.x.
-
-
-Multithreading and Rails
---------------------------
-
-If you use Puma or another threaded app server, as of Dalli 2.7, you can use a pool
-of Dalli clients with Rails to ensure the `Rails.cache` singleton does not become a
-source of thread contention.  You must add `gem 'connection_pool'` to your Gemfile and
-add :pool\_size to your `dalli_store` config:
-
+With SSL enabled:
 ```ruby
-config.cache_store = :dalli_store, 'cache-1.example.com', { :pool_size => 5 }
+require 'dalli'
+ssl_context = OpenSSL::SSL::SSLContext.new
+ssl_context.ca_file = "./myCA.pem"
+ssl_context.ssl_version = :SSLv23
+ssl_context.verify_hostname = true
+ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+dc = Dalli::Client.new("memcached:11212", :ssl_context => ssl_context)
+dc.set("abc", 123)
+value = dc.get("abc")
 ```
 
-You can then use the Rails cache as normal or check out a Dalli client directly from the pool:
-
-```ruby
-Rails.cache.fetch('foo', :expires_in => 300) do
-  'bar'
-end
-
-Rails.cache.dalli.with do |client|
-  # client is a Dalli::Client instance which you can
-  # use ONLY within this block
-end
-```
+The test suite requires memcached 1.4.3+ with SASL enabled (`brew install memcached --enable-sasl ; mv /usr/bin/memcached /usr/bin/memcached.old`).  Currently only supports the PLAIN mechanism.
 
+Dalli has no runtime dependencies.
 
 Configuration
 ------------------------
 
+**servers**: An Array of "host:port:weight" where weight allows you to distribute cache unevenly.
+
 Dalli::Client accepts the following options. All times are in seconds.
 
 **expires_in**: Global default for key TTL.  Default is 0, which means no expiry.
 
-**failover**: Boolean, if true Dalli will failover to another server if the main server for a key is down.
+**namespace**: If specified, prepends each key with this value to provide simple namespacing.  Default is nil.
+
+**failover**: Boolean, if true Dalli will failover to another server if the main server for a key is down.  Default is true.
+
+**threadsafe**: Boolean.  If true Dalli ensures that only one thread is using a socket at a given time. Default is true. You can set to false if you are using the Client within a thread-safe connection pool.
+
+**serializer**: The serializer to use for objects being stored (ex. JSON).
+Default is Marshal.
 
-**compress**: Boolean, if true Dalli will gzip-compress values larger than 1K.
+**compress**: Boolean, if true Dalli will gzip-compress values larger than 1K. Default is false.
 
 **compression_min_size**: Minimum value byte size for which to attempt compression. Default is 1K.
 
 **compression_max_size**: Maximum value byte size for which to attempt compression. Default is unlimited.
 
-**serializer**: The serializer to use for objects being stored (ex. JSON).
-Default is Marshal.
+**compressor**: The compressor to use for objects being stored.
+Default is zlib, implemented under `Dalli::Compressor`.
+If serving compressed data using nginx's HttpMemcachedModule, set `memcached_gzip_flag 2` and use `Dalli::GzipCompressor`
 
-**socket_timeout**: Timeout for all socket operations (connect, read, write). Default is 0.5.
+**keepalive**: Boolean. If true, Dalli will enable keep-alive for socket connections.  Default is true.
+
+**socket_timeout**: Timeout for all socket operations (connect, read, write). Default is 1.
 
 **socket_max_failures**: When a socket operation fails after socket_timeout, the same operation is retried. This is to not immediately mark a server down when there's a very slight network problem. Default is 2.
 
-**socket_failure_delay**: Before retrying a socket operation, the process sleeps for this amount of time. Default is 0.01.  Set to nil for no delay.
+**socket_failure_delay**: Before retrying a socket operation, the process sleeps for this amount of time. Default is 0.1.  Set to nil for no delay.
 
-**down_retry_delay**: When a server has been marked down due to many failures, the server will be checked again for being alive only after this amount of time. Don't set this value to low, otherwise each request which tries the failed server might hang for the maximum **socket_timeout**. Default is 1 second.
+**down_retry_delay**: When a server has been marked down due to many failures, the server will be checked again for being alive only after this amount of time. Don't set this value too low, otherwise each request which tries the failed server might hang for the maximum **socket_timeout**. Default is 30 seconds.
 
 **value_max_bytes**: The maximum size of a value in memcached.  Defaults to 1MB, this can be increased with memcached's -I parameter.  You must also configure Dalli to allow the larger size here.
 
+**error_when_over_max_size**: Boolean. If true, Dalli will throw a Dalli::ValueOverMaxSize exception when trying to store data larger than **value_max_bytes**. Defaults to false, meaning only a warning is logged.
+
 **username**: The username to use for authenticating this client instance against a SASL-enabled memcached server.  Heroku users should not need to use this normally.
 
 **password**: The password to use for authenticating this client instance against a SASL-enabled memcached server.  Heroku users should not need to use this normally.
 
-**keepalive**: Boolean. If true, Dalli will enable keep-alive for socket connections.  Default is true.
+**sndbuf**: In bytes, set the socket SO_SNDBUF. Defaults to operating system default.
 
-**compressor**: The compressor to use for objects being stored.
-Default is zlib, implemented under `Dalli::Compressor`.
-If serving compressed data using nginx's HttpMemcachedModule, set `memcached_gzip_flag 2` and use `Dalli::GzipCompressor`
+**rcvbuf**: In bytes, set the socket SO_RCVBUF. Defaults to operating system default.
+
+**cache_nils**: Boolean. If true Dalli will not treat cached `nil` values as 'not found' for `#fetch` operations. Default is false.
+
+**raise_errors**: Boolean. When true DalliStore will reraise Dalli:DalliError instead swallowing the error. Default is false.
+
+**instrument_errors**: Boolean. When true DalliStore will send notification of Dalli::DalliError via a 'cache_error.active_support' event. Default is false.
 
 Features and Changes
 ------------------------
 
-By default, Dalli is thread-safe.  Disable thread-safety at your own peril.
+By default, Dalli is thread-safe. Disable thread-safety at your own peril.
 
 Dalli does not need anything special in Unicorn/Passenger since 2.0.4.
 It will detect sockets shared with child processes and gracefully reopen the
@@ -198,27 +136,29 @@ Note that Dalli does not require ActiveSupport or Rails.  You can safely use it
 Helping Out
 -------------
 
-If you have a fix you wish to provide, please fork the code, fix in your local project and then send a pull request on github.  Please ensure that you include a test which verifies your fix and update History.md with a one sentence description of your fix so you get credit as a contributor.
+If you have a fix you wish to provide, please fork the code, fix in your local project and then send a pull request on github.  Please ensure that you include a test which verifies your fix and update `History.md` with a one sentence description of your fix so you get credit as a contributor.
 
 We're not accepting new compressors. They are trivial to add in an initializer. See #385 (LZ4), #406 (Snappy)
 
 Thanks
 ------------
 
-Eric Wong - for help using his [kgio](http://unicorn.bogomips.org/kgio/index.html) library.
+Mike Perham - for originally authoring the Dalli project and serving as maintainer and primary contributor
+
+Eric Wong - for help using his [kgio](http://bogomips.org/kgio/) library.
 
 Brian Mitchell - for his remix-stash project which was helpful when implementing and testing the binary protocol support.
 
 [CouchBase](http://couchbase.com) - for their project sponsorship
 
-
-Author
+Authors
 ----------
 
-Mike Perham, [mikeperham.com](http://mikeperham.com), [@mperham](http://twitter.com/mperham)
+* [Peter M. Goldstein](https://github.com/petergoldstein) - current maintainer
+* [Mike Perham](https://github.com/mperham) and contributors
 
 
 Copyright
 -----------
 
-Copyright (c) Mike Perham. See LICENSE for details.
+Copyright (c) Mike Perham, Peter M. Goldstein. See LICENSE for details.

data/lib/dalli/cas/client.rb

@@ -1,58 +1 @@
-require 'dalli/client'
-
-module Dalli
-  class Client
-    ##
-    # Get the value and CAS ID associated with the key.  If a block is provided,
-    # value and CAS will be passed to the block.
-    def get_cas(key)
-      (value, cas) = perform(:cas, key)
-      value = (!value || value == 'Not found') ? nil : value
-      if block_given?
-        yield value, cas
-      else
-        [value, cas]
-      end
-    end
-
-    ##
-    # Fetch multiple keys efficiently, including available metadata such as CAS.
-    # If a block is given, yields key/data pairs one a time.  Data is an array:
-    # [value, cas_id]
-    # If no block is given, returns a hash of
-    #   { 'key' => [value, cas_id] }
-    def get_multi_cas(*keys)
-      if block_given?
-        get_multi_yielder(keys) {|*args| yield(*args)}
-      else
-        Hash.new.tap do |hash|
-          get_multi_yielder(keys) {|k, data| hash[k] = data}
-        end
-      end
-    end
-
-    ##
-    # Set the key-value pair, verifying existing CAS.
-    # Returns the resulting CAS value if succeeded, and falsy otherwise.
-    def set_cas(key, value, cas, ttl=nil, options=nil)
-      ttl ||= @options[:expires_in].to_i
-      perform(:set, key, value, ttl, cas, options)
-    end
-
-    ##
-    # Conditionally add a key/value pair, verifying existing CAS, only if the
-    # key already exists on the server.  Returns the new CAS value if the
-    # operation succeeded, or falsy otherwise.
-    def replace_cas(key, value, cas, ttl=nil, options=nil)
-      ttl ||= @options[:expires_in].to_i
-      perform(:replace, key, value, ttl, cas, options)
-    end
-
-    # Delete a key/value pair, verifying existing CAS.
-    # Returns true if succeeded, and falsy otherwise.
-    def delete_cas(key, cas=0)
-      perform(:delete, key, cas)
-    end
-
-  end
-end
+puts "You can remove `require 'dalli/cas/client'` as this code has been rolled into the standard 'dalli/client'.