riak-client 1.0.0.beta → 1.0.0

data/lib/riak/robject.rb

@@ -50,14 +50,29 @@ module Riak
     # @see http://wiki.basho.com/display/RIAK/REST+API#RESTAPI-Storeaneworexistingobjectwithakey Riak Rest API Docs
     attr_accessor :prevent_stale_writes
 
+    # Defines a callback to be invoked when there is conflict.
+    #
+    # @yield The conflict callback.
+    # @yieldparam [RObject] robject The conflicted RObject
+    # @yieldreturn [RObject, nil] Either the resolved RObject or nil if your
+    #                             callback cannot resolve it. The next registered
+    #                             callback will be given the chance to resolve it.
+    #
+    # @note Ripple registers its own document-level conflict handler, so if you're
+    #       using ripple, you will probably want to use that instead.
     def self.on_conflict(&conflict_hook)
       on_conflict_hooks << conflict_hook
     end
 
+    # @return [Array<Proc>] the list of registered conflict callbacks.
     def self.on_conflict_hooks
       @on_conflict_hooks ||= []
     end
 
+    # Attempts to resolve conflict using the registered conflict callbacks.
+    #
+    # @return [RObject] the RObject
+    # @note There is no guarantee the returned RObject will have been resolved
     def attempt_conflict_resolution
       return self unless conflict?
 
@@ -195,9 +210,10 @@ module Riak
 
     # Returns sibling objects when in conflict.
     # @return [Array<RObject>] an array of conflicting sibling objects for this key
-    # @return [self] this object when not in conflict
+    # @return [Array<self>] a single-element array containing object when not
+    # in conflict
     def siblings
-      return self unless conflict?
+      return [self] unless conflict?
       @siblings
     end
 
@@ -244,7 +260,7 @@ module Riak
     # @param [Array<Hash,WalkSpec>] link specifications for the query
     def walk(*params)
       specs = WalkSpec.normalize(*params)
-      @bucket.client.http.link_walk(self, specs)
+      @bucket.client.link_walk(self, specs)
     end
 
     # Converts the object to a link suitable for linking other objects

data/lib/riak/serializers.rb

@@ -22,7 +22,7 @@ module Riak
     private
 
     def serializer_for(content_type)
-      serializers.fetch(content_type) do
+      serializers.fetch(content_type[/^[^;\s]+/]) do
         raise NotImplementedError.new(t('serializer_not_implemented', :content_type => content_type.inspect))
       end
     end

data/lib/riak/test_server.rb

@@ -17,7 +17,6 @@ module Riak
       configuration[:env] ||= {}
       configuration[:env][:riak_kv] ||= {}
       (configuration[:env][:riak_kv][:add_paths] ||= []) << File.expand_path("../../../erl_src", __FILE__)
-      configuration[:env][:riak_kv][:storage_backend] = :riak_kv_test_backend
       configuration[:env][:riak_search] ||= {}
       configuration[:env][:riak_search][:search_backend] = :riak_search_test_backend
       super configuration
@@ -52,7 +51,7 @@ module Riak
     def drop
       begin
         maybe_attach
-        @console.command "riak_kv_test_backend:reset()."
+        @console.command "#{kv_backend}:reset()."
         @console.command "riak_search_test_backend:reset()."
       rescue IOError
         retry
@@ -71,5 +70,14 @@ module Riak
     def open?
       @console && @console.open?
     end
+
+    def configure_data
+      super
+      if version < "1.0.0"
+        env[:riak_kv][:storage_backend] = :riak_kv_test014_backend
+      else
+        env[:riak_kv][:storage_backend] = :riak_kv_test_backend
+      end
+    end
   end
 end

data/lib/riak/version.rb

@@ -1,3 +1,3 @@
 module Riak
-  VERSION = "1.0.0.beta"
+  VERSION = "1.0.0"
 end

data/riak-client.gemspec

@@ -8,15 +8,15 @@ Gem::Specification.new do |gem|
   gem.summary = %Q{riak-client is a rich client for Riak, the distributed database by Basho.}
   gem.description = %Q{riak-client is a rich client for Riak, the distributed database by Basho. It supports the full HTTP and Protocol Buffers interfaces including storage operations, bucket configuration, link-walking, secondary indexes and map-reduce.}
   gem.email = ["sean@basho.com"]
-  gem.homepage = "http://seancribbs.github.com/ripple"
+  gem.homepage = "http://github.com/basho/riak-ruby-client"
   gem.authors = ["Sean Cribbs"]
 
   # Deps
-  gem.add_development_dependency "rspec", "~>2.6.0"
+  gem.add_development_dependency "rspec", "~>2.8.0"
   gem.add_development_dependency "fakeweb", ">=1.2"
   gem.add_development_dependency "rack", ">=1.0"
   gem.add_development_dependency "excon", "~>0.6.1"
-  gem.add_development_dependency 'rake', '~> 0.8.7'
+  gem.add_development_dependency 'rake'
   gem.add_runtime_dependency "i18n", ">=0.4.0"
   gem.add_runtime_dependency "builder", ">= 2.1.2"
   gem.add_runtime_dependency "beefcake", "~>0.3.7"

data/spec/failover/failover.rb

@@ -0,0 +1,59 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib')
+require 'riak'
+
+# This is not a formal spec yet. It's designed to be run agains a local dev
+# cluster while you bring nodes up and down.
+[
+  {:protocol => 'pbc', :protobuffs_backend => :Beefcake},
+  {:protocol => 'http', :http_backend => :NetHTTP},
+  {:protocol => 'http', :http_backend => :Excon}
+].each do |opts|
+  @client = Riak::Client.new(
+    {
+      :nodes => (1..3).map { |i|
+        {
+          :http_port => 8090 + i,
+          :pb_port => 8080 + i
+        }
+      }
+    }.merge(opts)
+  )
+
+  errors = []
+  p opts
+
+  n = 10
+  c = 1000
+
+  (0...n).map do |t|
+    Thread.new do
+      # Generate a stream of put reqs. Put a . for each success, an X for
+      # each failure.
+      c.times do |i|
+        begin
+          o = @client['test'].new("#{t}:#{i}")
+          o.content_type = 'text/plain'
+          o.data = i.to_s
+          o.store
+          o2 = @client['test'].get("#{t}:#{i}")
+          o2.data == i.to_s or raise "wrong data"
+          print '.'
+        rescue => e
+          print 'X'
+          errors << e
+        end
+      end
+    end
+  end.each do |thread|
+    thread.join
+  end
+
+  # Put errors
+  puts
+  errors.each do |e|
+    puts e.inspect
+    puts e.backtrace.map { |x| "  #{x}" }.join("\n")
+  end
+
+  puts "\n\n"
+end

data/spec/integration/riak/http_backends_spec.rb

@@ -11,7 +11,7 @@ describe "HTTP" do
     if bklass.configured?
       describe klass.to_s do
         before do
-          @backend = bklass.new(@client)
+          @backend = bklass.new(@client, @client.node)
         end
 
         it_should_behave_like "Unified backend API"
@@ -34,7 +34,7 @@ describe "HTTP" do
   end
 
   describe 'NetHTTPBackend' do
-    subject { Riak::Client::NetHTTPBackend.new(@client) }
+    subject { Riak::Client::NetHTTPBackend.new(@client, @client.node) }
     let(:file) { File.open(__FILE__) }
     let(:sized) { Reader.new(["foo", "bar", "baz"]) }
     let(:sizeless) { SizelessReader.new(["foo", "bar", "baz"]) }

data/spec/integration/riak/node_spec.rb

@@ -4,34 +4,26 @@ require 'yaml'
 
 describe Riak::Node, :test_server => false, :slow => true do
   let(:test_server_config){ YAML.load_file("spec/support/test_server.yml") }
-  subject { described_class.new(:root => ".ripplenode", :source => test_server_config['source']) }
-  after { subject.stop if subject.started? }
-  after(:all) { subject.destroy }
+  let(:node){ described_class.new(:root => ".ripplenode", :source => test_server_config['source']) }
+  subject { node }
+  after { node.stop if node.started? }
+  after(:all) { node.destroy }
+
+  context "finding the base_dir and version" do
+    its(:base_dir) { should be_directory }
+    its(:version) { should match /^\d+.\d+.\d+$/ }
+
+    context "when the base directory is missing" do
+      before { Pathname.any_instance.stub(:each_line).and_return([]) }
+      its(:base_dir) { should be_nil }
+      its(:version)  { should be_nil }
+    end
+  end
 
   context "creation" do
     before { subject.create }
     after { subject.destroy }
 
-    describe "finding the base_dir and version" do
-      it "should return a valid directory for base_dir" do
-        subject.base_dir.should be_exist
-      end
-
-      it "should read a version from the releases directory" do
-        subject.version.should match /\d+.\d+.\d+/
-      end
-
-      it "should return nil for base_dir if RUNNER_BASE_DIR is not found" do
-        Pathname.any_instance.stub(:readlines).and_return([])
-        subject.base_dir.should be_nil
-      end
-
-      it "should return nil for version if base_dir is nil" do
-        Pathname.any_instance.stub(:readlines).and_return([])
-        subject.version.should be_nil
-      end
-    end
-
     describe "generating the manifest" do
       it "should store the configuration manifest in the node directory" do
         (subject.root + '.node.yml').should be_exist
@@ -175,7 +167,7 @@ describe Riak::Node, :test_server => false, :slow => true do
     it "should read the console log" do
       if subject.version >= "1.0.0"
         subject.read_console_log(:debug, :info, :notice).should_not be_empty
-        subject.read_console_log(:debug..:emergency).should_not be_empty
+        subject.read_console_log('debug'..'emergency').should_not be_empty
         subject.read_console_log(:info).should_not be_empty
         subject.read_console_log(:foo).should be_empty
       end

data/spec/integration/riak/protobuffs_backends_spec.rb

@@ -11,7 +11,7 @@ describe "Protocol Buffers" do
     if bklass.configured?
       describe klass.to_s do
         before do
-          @backend = bklass.new(@client)
+          @backend = bklass.new(@client, @client.node)
         end
 
         it_should_behave_like "Unified backend API"

data/spec/integration/riak/test_server_spec.rb

@@ -12,9 +12,10 @@ describe Riak::TestServer do
   end
 
   it "should use the KV test backend" do
-    subject.kv_backend.should == :riak_kv_test_backend
-    subject.env[:riak_kv][:storage_backend].should == :riak_kv_test_backend
-    app_config.should include("{storage_backend, riak_kv_test_backend}")
+    backend = subject.version < "1.0.0" ? :riak_kv_test014_backend : :riak_kv_test_backend
+    subject.kv_backend.should == backend
+    subject.env[:riak_kv][:storage_backend].should == backend
+    app_config.should include("{storage_backend, #{backend}}")
   end
 
   it "should use the Search test backend" do

data/spec/integration/riak/threading_spec.rb

@@ -0,0 +1,193 @@
+require 'spec_helper'
+
+describe "Multithreaded client", :test_server => true do
+  class Synchronizer
+    def initialize(n)
+      @mutex = Mutex.new
+      @n = n
+      @waiting = Set.new
+    end
+
+    def sync
+      stop = false
+      @mutex.synchronize do
+        @waiting << Thread.current
+
+        if @waiting.size >= @n
+          # All threads are waiting.
+          @waiting.each do |t|
+            t.run
+          end
+        else
+          stop = true
+        end
+      end
+
+      if stop
+        Thread.stop
+      end
+    end
+  end
+
+  def threads(n, opts = {})
+    if opts[:synchronize]
+      s1 = Synchronizer.new n
+      s2 = Synchronizer.new n
+    end
+
+    threads = (0...n).map do |i|
+      Thread.new do
+        if opts[:synchronize]
+          s1.sync
+        end
+
+        yield i
+
+        if opts[:synchronize]
+          s2.sync
+        end
+      end
+    end
+
+    threads.each do |t|
+      t.join
+    end
+  end
+
+  [
+   {:protocol => 'pbc', :protobuffs_backend => :Beefcake},
+   {:protocol => 'http', :http_backend => :NetHTTP},
+   {:protocol => 'http', :http_backend => :Excon}
+  ].each do |opts|
+    describe opts.inspect do
+      before do
+        @pb_port ||= $test_server.pb_port
+        @http_port ||= $test_server.http_port
+        @client = Riak::Client.new({
+                                     :pb_port => @pb_port,
+                                     :http_port => @http_port
+                                   }.merge(opts))
+      end
+
+      it 'should get in parallel' do
+        data = "the gun is good"
+        ro = @client['test'].new('test')
+        ro.content_type = "application/json"
+        ro.data = [data]
+        ro.store
+
+        threads 10, :synchronize => true do
+          x = @client['test']['test']
+          x.content_type.should == "application/json"
+          x.data.should == [data]
+        end
+      end
+
+      it 'should put in parallel' do
+        data = "the tabernacle is indestructible and everlasting"
+
+        n = 10
+        threads n, :synchronize => true do |i|
+          x = @client['test'].new("test-#{i}")
+          x.content_type = "application/json"
+          x.data = ["#{data}-#{i}"]
+          x.store
+        end
+
+        (0...n).each do |i|
+          read = @client['test']["test-#{i}"]
+          read.content_type.should == "application/json"
+          read.data.should == ["#{data}-#{i}"]
+        end
+      end
+
+      # This is a 1.0+ spec because putting with the same client ID
+      # will not create siblings on 0.14 in the same way. This will
+      # also likely fail for nodes with vnode_vclocks = false.
+      it 'should put conflicts in parallel', :version => "1.0.0" do
+        @client['test'].allow_mult = true
+        @client['test'].allow_mult.should == true
+
+        init = @client['test'].new('test')
+        init.content_type = "application/json"
+        init.data = ''
+        init.store
+
+        # Create conflicting writes
+        n = 10
+        s = Synchronizer.new n
+        threads n, :synchronize => true do |i|
+          x = @client['test']["test"]
+          s.sync
+          x.data = [i]
+          x.store
+        end
+
+        read = @client['test']["test"]
+        read.conflict?.should == true
+        read.siblings.map do |sibling|
+          sibling.data.first
+        end.to_set.should == (0...n).to_set
+      end
+
+      it 'should list-keys and get in parallel', :slow => true do
+        count = 100
+        threads = 2
+
+        # Create items
+        count.times do |i|
+          o = @client['test'].new("#{i}")
+          o.content_type = 'application/json'
+          o.data = [i]
+          o.store
+        end
+
+        threads(threads) do
+          set = Set.new
+          @client['test'].keys do |stream|
+            stream.each do |key|
+              set.merge @client['test'][key].data
+            end
+          end
+          set.should == (0...count).to_set
+        end
+      end
+
+      sometimes 'should mapreduce in parallel' do
+        if ("1.0.0"..."1.1.0").include?(test_server.version)
+          # On a fresh node, this module might not have been loaded yet
+          # and the mapred test exposes a race condition in riak_pipe_v
+          # when verifying function validity. This race condition is
+          # fixed in 1.1.
+          test_server.with_console do |console|
+            console.command 'code:load(riak_kv_pipe_get), ok.'
+            console.command 'code:load(riak_kv_mrc_map), ok.'
+          end
+        end
+
+        count = 10
+        threads = 10
+
+        # Create items
+        count.times do |i|
+          o = @client['test'].new("#{i}")
+          o.content_type = 'application/json'
+          o.data = i
+          o.store
+        end
+
+        # Ze mapreduce
+        threads(threads) do
+          # Mapreduce
+          (0...count).inject(Riak::MapReduce.new(@client)) do |mr, i|
+            mr.add('test', i.to_s)
+          end.map(%{function(v) {
+            return [v.key];
+          }}, :keep => true).run.map do |s|
+            s.to_i
+          end.to_set.should == (0...count).to_set
+        end
+      end
+    end
+  end
+end