dalli 2.7.8 → 3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c031a1c9cb46cdd1c12b7f52d123de5edd393c8061353cb7842b3106b97d13f
-  data.tar.gz: 43a26b17146ebb001fb073df967c5f77c04660f3f71d791c3bf67d05b9a10425
+  metadata.gz: f0ef39f4ff4e9e465b2522707f3c4eea85a94373ba0d3de4b9d940830001b118
+  data.tar.gz: 35cb362ec6075818f062106769481e92c90752936ecaf9a00fae25725ee4ea94
 SHA512:
-  metadata.gz: 22a104d5ebc991e0a28dc44315328a4526dfa7b217284c9b7bfbc2d8b1478daf1d473541799fc46b81afac1e28d1c2f7fa10cfceaea7eb330d3a6738b061e037
-  data.tar.gz: e03f4510b72135c59bda4c50f9737a933beb8e791b7a6baa8d1ab4909e297e3a5c73f0b2f1c879f830b92807b5b714b8a379b8e2a53921ec787ec92c458b0121
+  metadata.gz: 0c6b2b205551fb10fb2e49ab7c3c3eba3c552c0bc4b8132783b51f6cdc7a9ddd4c272bd24ed13f9d78e29353e3b84daec001b2691ad630bdfd517bb7af86fd54
+  data.tar.gz: 6ef9f6733d8e6d5f8a6bf8fb7d782e99c450494e03d4e5fe46037b77665682df63eaa9a3eb05007d1720b175564c8e91524c0df92d0856dc1f68066501732a06

data/{History.md → CHANGELOG.md}

@@ -1,6 +1,174 @@
 Dalli Changelog
 =====================
 
+Unreleased
+==========
+
+3.2.3
+==========
+
+- Sanitize CAS inputs to ensure additional commands are not passed to memcached (xhzeem / petergoldstein)
+- Sanitize input to flush command to ensure additional commands are not passed to memcached (xhzeem / petergoldstein)
+- Namespaces passed as procs are now evaluated every time, as opposed to just on initialization (nrw505)
+- Fix missing require of uri in ServerConfigParser (adam12)
+- Fix link to the CHANGELOG.md file in README.md (rud)
+
+3.2.2
+==========
+
+- Ensure apps are resilient against old session ids (kbrock)
+
+3.2.1
+==========
+
+- Fix null replacement bug on some SASL-authenticated services (veritas1)
+
+3.2.0
+==========
+
+- BREAKING CHANGE: Remove protocol_implementation client option (petergoldstein)
+- Add protocol option with meta implementation (petergoldstein)
+
+3.1.6
+==========
+
+- Fix bug with cas/cas! with "Not found" value (petergoldstein)
+- Add Ruby 3.1 to CI (petergoldstein)
+- Replace reject(&:nil?) with compact (petergoldstein)
+
+3.1.5
+==========
+
+- Fix bug with get_cas key with "Not found" value (petergoldstein)
+- Replace should return nil, not raise error, on miss (petergoldstein)
+
+3.1.4
+==========
+
+- Improve response parsing performance (casperisfine)
+- Reorganize binary protocol parsing a bit (petergoldstein)
+- Fix handling of non-ASCII keys in get_multi (petergoldstein)
+
+3.1.3
+==========
+
+- Restore falsey behavior on delete/delete_cas for nonexistent key (petergoldstein)
+
+3.1.2
+==========
+
+- Make quiet? / multi? public on Dalli::Protocol::Binary (petergoldstein)
+
+3.1.1
+==========
+
+- Add quiet support for incr, decr, append, depend, and flush (petergoldstein)
+- Additional refactoring to allow reuse of connection behavior (petergoldstein)
+- Fix issue in flush such that it wasn't passing the delay argument to memcached (petergoldstein)
+
+3.1.0
+==========
+
+- BREAKING CHANGE: Update Rack::Session::Dalli to inherit from Abstract::PersistedSecure.  This will invalidate existing sessions (petergoldstein)
+- BREAKING CHANGE: Use of unsupported operations in a multi block now raise an error. (petergoldstein)
+- Extract PipelinedGetter from Dalli::Client (petergoldstein)
+- Fix SSL socket so that it works with pipelined gets (petergoldstein)
+- Additional refactoring to split classes (petergoldstein)
+
+3.0.6
+==========
+
+- Fix regression in SASL authentication response parsing (petergoldstein)
+
+3.0.5
+==========
+
+- Add Rubocop and fix most outstanding issues (petergoldstein)
+- Extract a number of classes, to simplify the largest classes (petergoldstein)
+- Ensure against socket corruption if an error occurs in a multi block (petergoldstein)
+
+3.0.4
+==========
+
+- Clean connections and retry after NetworkError in get_multi (andrejbl)
+- Internal refactoring and cleanup (petergoldstein)
+
+3.0.3
+==========
+
+- Restore ability for `compress` to be disabled on a per request basis (petergoldstein)
+- Fix broken image in README (deining)
+- Use bundler-cache in CI (olleolleolle)
+- Remove the OpenSSL extensions dependency (petergoldstein)
+- Add Memcached 1.5.x to the CI matrix
+- Updated compression documentation (petergoldstein)
+
+3.0.2
+==========
+
+- Restore Windows compatibility (petergoldstein)
+- Add JRuby to CI and make requisite changes (petergoldstein)
+- Clarify documentation for supported rubies (petergoldstein)
+
+3.0.1
+==========
+
+- Fix syntax error that prevented inclusion of Dalli::Server (ryanfb)
+- Restore with method required by ActiveSupport::Cache::MemCacheStore
+
+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.
+  * When using namespaces, the algorithm for calculating truncated keys was
+    changed.  Non-truncated keys and truncated keys for the non-namespace
+    case were left unchanged.
+
+- 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)

data/Gemfile

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
-gem 'kgio', :platform => :mri
+group :test do
+  gem 'ruby-prof', platform: :mri
+end

data/README.md

@@ -1,246 +1,50 @@
-Dalli [![Build Status](https://secure.travis-ci.org/petergoldstein/dalli.svg)](http://travis-ci.org/petergoldstein/dalli) [![Dependency Status](https://gemnasium.com/petergoldstein/dalli.svg)](https://gemnasium.com/petergoldstein/dalli) [![Code Climate](https://codeclimate.com/github/petergoldstein/dalli.svg)](https://codeclimate.com/github/petergoldstein/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.
+Dalli is a high performance pure Ruby client for accessing memcached servers.
 
-The name is a variant of Salvador Dali for his famous painting [The Persistence of Memory](http://en.wikipedia.org/wiki/The_Persistence_of_Memory).
-
-![Persistence of Memory](http://www.virtualdali.com/assets/paintings/31PersistenceOfMemory.jpg)
-
-Dalli's initial development was sponsored by [CouchBase](http://www.couchbase.com/).  Many thanks to them!
-
-
-Design
-------------
-
-Mike Perham 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
-------------------------------------------------
-
-Dalli should work identically on:
-
- * JRuby 1.6+
- * Ruby 1.9.3+
- * Rubinius 2.0
-
-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 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
-
-On Ubuntu you can install it by running:
-
-    apt-get install memcached
-
-You can verify your installation using this piece of code:
-
-```bash
-gem install dalli
-```
-
-```ruby
-require 'dalli'
-options = { :namespace => "app_v1", :compress => true }
-dc = Dalli::Client.new('localhost:11211', options)
-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:11211:2',
-  { :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true }
-```
-
-You can specify a port and a weight by appending to the server name. You may wish to increase the weight of a server with more memory configured.  (e.g. to specify port 11211 and a weight of 2, append `:11211:2` ) 
-
-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
-```
+Dalli supports:
 
-For Rails 3.x:
+* Simple and complex memcached configurations
+* Failover between memcached instances
+* Fine-grained control of data serialization and compression
+* Thread-safe operation (either through use of a connection pool, or by using the Dalli client in threadsafe mode)
+* SSL/TLS connections to memcached
+* SASL authentication
 
-```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:
-
-```ruby
-config.cache_store = :dalli_store, 'cache-1.example.com', { :pool_size => 5 }
-```
-
-You can then use the Rails cache as normal and Rails.cache will use the pool transparently under the covers, or you can 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
-```
-
-
-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.
-
-**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.  Set to false at your own peril.
-
-**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. 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.
-
-**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`
-
-**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 0.5.
-
-**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.
-
-**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 60 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.
-
-**sndbuf**: In bytes, set the socket SO_SNDBUF. Defaults to operating system default.
-
-**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.
-
-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
-socket.
+The name is a variant of Salvador Dali for his famous painting [The Persistence of Memory](http://en.wikipedia.org/wiki/The_Persistence_of_Memory).
 
-Note that Dalli does not require ActiveSupport or Rails.  You can safely use it in your own Ruby projects.
+![Persistence of Memory](https://upload.wikimedia.org/wikipedia/en/d/dd/The_Persistence_of_Memory.jpg)
 
-[View the Client API](http://www.rubydoc.info/github/mperham/dalli/Dalli/Client)
 
-Helping Out
--------------
+## Documentation and Information
 
-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.
+* [User Documentation](https://github.com/petergoldstein/dalli/wiki) - The documentation is maintained in the repository's wiki.  
+* [Announcements](https://github.com/petergoldstein/dalli/discussions/categories/announcements) - Announcements of interest to the Dalli community will be posted here.
+* [Bug Reports](https://github.com/petergoldstein/dalli/issues) - If you discover a problem with Dalli, please submit a bug report in the tracker.
+* [Forum](https://github.com/petergoldstein/dalli/discussions/categories/q-a) - If you have questions about Dalli, please post them here.
+* [Client API](https://rubydoc.info/github/petergoldstein/dalli/Dalli/Client) - Ruby documentation for the `Dalli::Client` API
 
-We're not accepting new compressors. They are trivial to add in an initializer. See #385 (LZ4), #406 (Snappy)
+## Contributing
 
-Thanks
-------------
+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 the [changelog](CHANGELOG.md) with a one sentence description of your fix so you get credit as a contributor.
 
-Mike Perham - for originally authoring the Dalli project and serving as maintainer and primary contributor
+## Appreciation
 
-Eric Wong - for help using his [kgio](http://bogomips.org/kgio/) library.
+Dalli would not exist in its current form without the contributions of many people.  But special thanks go to several individuals and organizations:
 
-Brian Mitchell - for his remix-stash project which was helpful when implementing and testing the binary protocol support.
+* Mike Perham - for originally authoring the Dalli project and serving as maintainer and primary contributor for many years
+* 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 sponsorship of the original development
 
-[CouchBase](http://couchbase.com) - for their project sponsorship
 
-Authors
-----------
+## Authors
 
 * [Peter M. Goldstein](https://github.com/petergoldstein) - current maintainer
 * [Mike Perham](https://github.com/mperham) and contributors
 
 
-Copyright
------------
+## Copyright
 
 Copyright (c) Mike Perham, Peter M. Goldstein. See LICENSE for details.

data/lib/dalli/cas/client.rb

@@ -1,59 +1,3 @@
 # frozen_string_literal: true
-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'."