aerospike 2.5.1 → 2.6.0

data/lib/aerospike/cluster/create_connection.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Aerospike, Inc.
+#
+# Portions may be licensed to Aerospike, Inc. under one or more contributor
+# license agreements.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+module Aerospike
+  class Cluster
+    # Create connection based on cluster config and authenticate if needed
+    module CreateConnection
+      class << self
+        def call(cluster, host)
+          ::Aerospike::Connection::Create.(
+            host.name,
+            host.port,
+            tls_name: host.tls_name,
+            timeout: cluster.connection_timeout,
+            ssl_options: cluster.ssl_options
+          ).tap do |conn|
+            if cluster.credentials_given?
+              # Authenticate will raise and close connection if invalid credentials
+              Connection::Authenticate.(conn, cluster.user, cluster.password)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aerospike/cluster/find_node.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Aerospike, Inc.
+#
+# Portions may be licensed to Aerospike, Inc. under one or more contributor
+# license agreements.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+module Aerospike
+  class Cluster
+    # Find node in cluster by name
+    module FindNode
+      class << self
+        def call(cluster, peers, node_name)
+          node = cluster.find_node_by_name(node_name) || peers.find_node_by_name(node_name)
+          return if node.nil?
+          node.tap do |n|
+            n.increase_reference_count!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aerospike/connection/authenticate.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Aerospike, Inc.
+#
+# Portions may be licensed to Aerospike, Inc. under one or more contributor
+# license agreements.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+module Aerospike
+  module Connection # :nodoc:
+    module Authenticate
+      class << self
+        def call(conn, user, password)
+          command = AdminCommand.new
+          command.authenticate(conn, user, password)
+          true
+        rescue ::Aerospike::Exceptions::Aerospike
+          conn.close if conn
+          raise ::Aerospike::Exceptions::InvalidCredentials
+        end
+      end
+    end
+  end
+end

data/lib/aerospike/connection/create.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright 2014-2018 Aerospike, Inc.
+#
+# Portions may be licensed to Aerospike, Inc. under one or more contributor
+# license agreements.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+module Aerospike
+  module Connection # :nodoc:
+    module Create
+      class << self
+        def call(host, port, timeout: 30, tls_name: nil, ssl_options: nil)
+          if !ssl_options.nil? && ssl_options[:enable] != false
+            ::Aerospike::Socket::SSL.connect(
+              host, port, timeout, tls_name, ssl_options
+            )
+          else
+            ::Aerospike::Socket::TCP.connect(host, port, timeout)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aerospike/host.rb

@@ -1,12 +1,14 @@
 # encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2018 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may not
 # use this file except in compliance with the License. You may obtain a copy of
-# the License at http://www.apache.org/licenses/LICENSE-2.0
+# the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
@@ -18,11 +20,12 @@ module Aerospike
 
   class Host
 
-    attr_accessor :name, :port
+    attr_accessor :name, :port, :tls_name
 
-    def initialize(host_name, host_port)
+    def initialize(host_name, host_port, tls_name = nil)
       @name = host_name
       @port = host_port
+      @tls_name = tls_name
     end
 
     def to_s

data/lib/aerospike/host/parse.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Aerospike, Inc.
+#
+# Portions may be licensed to Aerospike, Inc. under one or more contributor
+# license agreements.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+module Aerospike
+  class Host
+    module Parse
+      INTEGER_REGEX = /\A\d+\z/
+
+      class << self
+        # Parse hosts from string format: hostname1[:tlsname1][:port1],...
+        def call(hosts, default_port = 3000)
+          case hosts
+          when Host
+            [hosts]
+          when Array
+            hosts
+          when String
+            hosts.split(?,).map { |host|
+              addr, tls_name, port = host.split(?:)
+              if port.nil? && tls_name && tls_name.match(INTEGER_REGEX)
+                port = tls_name
+                tls_name = nil
+              end
+              port ||= default_port
+              Host.new(addr, port.to_i, tls_name)
+            }
+          else
+            fail TypeError, "hosts should be a Host object, an Array of Host objects, or a String"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aerospike/node.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+# Copyright 2014-2018 Aerospike, Inc.
+#
+# Portions may be licensed to Aerospike, Inc. under one or more contributor
+# license agreements.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'aerospike/atomic/atomic'
+
+module Aerospike
+  class Node
+
+    attr_reader :reference_count, :responded, :name, :features, :cluster_name, :partition_generation, :peers_generation, :failures, :cluster, :peers_count, :host
+
+    PARTITIONS = 4096
+    FULL_HEALTH = 100
+
+    # Initialize server node with connection parameters.
+    def initialize(cluster, nv)
+      @cluster = cluster
+      @name = nv.name
+      @aliases = Atomic.new(nv.aliases)
+      @host = nv.host
+      @use_new_info = Atomic.new(nv.use_new_info)
+      @features = nv.features
+      @cluster_name = nv.cluster_name
+
+      # TODO: Re-use connection from node validator
+      @tend_connection = nil
+
+      # Assign host to first IP alias because the server identifies nodes
+      # by IP address (not hostname).
+      @host = nv.aliases[0]
+      @health = Atomic.new(FULL_HEALTH)
+      @peers_count = Atomic.new(0)
+      @peers_generation = ::Aerospike::Node::Generation.new
+      @partition_generation = ::Aerospike::Node::Generation.new
+      @reference_count = Atomic.new(0)
+      @responded = Atomic.new(false)
+      @active = Atomic.new(true)
+      @failures = Atomic.new(0)
+
+      @connections = Pool.new(@cluster.connection_queue_size)
+
+      # TODO: put in separate methods
+      @connections.create_block = Proc.new do
+        conn = nil
+        loop do
+          conn = Cluster::CreateConnection.(cluster, host)
+          break if conn.connected?
+        end
+        conn
+      end
+
+      @connections.cleanup_block = Proc.new { |conn| conn.close if conn }
+    end
+
+    # Get a connection to the node. If no cached connection is not available,
+    # a new connection will be created
+    def get_connection(timeout)
+      loop do
+        conn = @connections.poll
+        if conn.connected?
+          conn.timeout = timeout.to_f
+          return conn
+        end
+      end
+    end
+
+    # Put back a connection to the cache. If cache is full, the connection will be
+    # closed and discarded
+    def put_connection(conn)
+      conn.close if !active?
+      @connections.offer(conn)
+    end
+
+    # Separate connection for refreshing
+    def tend_connection
+      if @tend_connection.nil? || @tend_connection.closed?
+        @tend_connection = Cluster::CreateConnection.(cluster, host)
+      end
+      @tend_connection
+    end
+
+    # Mark the node as healthy
+    def restore_health
+      # There can be cases where health is full, but active is false.
+      # Once a node has been marked inactive, it stays inactive.
+      @health.value = FULL_HEALTH
+    end
+
+    # Decrease node Health as a result of bad connection or communication
+    def decrease_health
+      @health.update { |v| v - 1 }
+    end
+
+    # Check if the node is unhealthy
+    def unhealthy?
+      @health.value <= 0
+    end
+
+    # Retrieves host for the node
+    def get_host
+      @host
+    end
+
+    # Sets node as active
+    def active!
+      @active.update { |_| true }
+    end
+
+    # Sets node as inactive
+    def inactive!
+      @active.update { |_| false }
+    end
+
+    # Checks if the node is active
+    def active?
+      @active.value
+    end
+
+    def increase_reference_count!
+      @reference_count.update { |v| v + 1 }
+    end
+
+    def reset_reference_count!
+      @reference_count.value = 0
+    end
+
+    def responded!
+      @responded.value = true
+    end
+
+    def responded?
+      @responded.value == true
+    end
+
+    def reset_responded!
+      @responded.value = false
+    end
+
+    def has_peers?
+      @peers_count.value > 0
+    end
+
+    def failed?
+      @failures.value > 0
+    end
+
+    def failed!
+      @failures.update { |v| v + 1 }
+    end
+
+    def reset_failures!
+      @failures.value = 0
+    end
+
+    def aliases
+      @aliases.value
+    end
+
+    # Marks node as inactice and closes all cached connections
+    def close
+      inactive!
+      close_connections
+    end
+
+    def supports_feature?(feature)
+      @features.include?(feature.to_s)
+    end
+
+    def ==(other)
+      other && other.is_a?(Node) && (@name == other.name)
+    end
+    alias eql? ==
+
+    def use_new_info?
+      @use_new_info.value
+    end
+
+    def hash
+      @name.hash
+    end
+
+    def inspect
+      "#<Aerospike::Node: @name=#{@name}, @host=#{@host}>"
+    end
+
+    ##
+    # Convenience wrappers for applying refresh operations to a node
+    ##
+
+    def refresh_info(peers)
+      Node::Refresh::Info.(self, peers)
+    end
+
+    def refresh_partitions(peers)
+      Node::Refresh::Partitions.(self, peers)
+    end
+
+    def refresh_peers(peers)
+      Node::Refresh::Peers.(self, peers)
+    end
+
+    def refresh_reset
+      Node::Refresh::Reset.(self)
+    end
+
+    private
+
+    def close_connections
+      @tend_connection.close if @tend_connection
+      # drain connections and close all of them
+      # non-blocking, does not call create_block when passed false
+      while conn = @connections.poll(false)
+        conn.close if conn
+      end
+    end
+  end # class Node
+end # module