cassanity 0.4.0 → 0.5.0

data/lib/cassanity/connection.rb

@@ -42,16 +42,12 @@ module Cassanity
     #
     # Returns Array of Cassanity::Keyspace instances.
     def keyspaces
-      rows = @executor.call({
+      @executor.call({
         command: :keyspaces,
-      })
-
-      rows.map { |row|
-        Keyspace.new({
-          name: row['name'],
+        transformer_arguments: {
           executor: @executor,
-        })
-      }
+        },
+      })
     end
 
     # Public: Get a keyspace instance

data/lib/cassanity/error.rb

@@ -1,5 +1,5 @@
 module Cassanity
-  class Error < Exception
+  class Error < StandardError
     # Public: The original error this exception is wrapping.
     attr_reader :original
 
@@ -10,19 +10,26 @@ module Cassanity
     #
     # Returns the duplicated String.
     def initialize(args = {})
-      @original = args.fetch(:original) { $! }
-      @message = args.fetch(:message) {
-        if @original
-          "Original Exception: #{@original.class}: #{@original.message}"
-        else
-          "Something truly horrible went wrong"
-        end
-      }
+      if args.is_a?(String)
+        @message = args
+      else
+        @original = args.fetch(:original) { $! }
+        @message = args.fetch(:message) {
+          if @original
+            "Original Exception: #{@original.class}: #{@original.message}"
+          else
+            "Something truly horrible went wrong"
+          end
+        }
+      end
 
       super @message
     end
   end
 
-  class UnknownCommand < Error
-  end
+  # Raised when an argument generator is asked to perform an unknown command.
+  UnknownCommand = Class.new(Error)
+
+  # Raised when a migration operation is attempted that is not supported.
+  MigrationOperationNotSupported = Class.new(Error)
 end

data/lib/cassanity/executors/cassandra_cql.rb

@@ -18,8 +18,14 @@ require 'cassanity/argument_generators/column_family_alter'
 require 'cassanity/argument_generators/index_create'
 require 'cassanity/argument_generators/index_drop'
 require 'cassanity/argument_generators/batch'
+require 'cassanity/argument_generators/columns'
 require 'cassanity/result_transformers/result_to_array'
+require 'cassanity/result_transformers/keyspaces'
+require 'cassanity/result_transformers/column_families'
+require 'cassanity/result_transformers/columns'
 require 'cassanity/result_transformers/mirror'
+require 'cassanity/retry_strategies/retry_n_times'
+require 'cassanity/retry_strategies/exponential_backoff'
 
 module Cassanity
   module Executors
@@ -27,40 +33,45 @@ module Cassanity
       extend Forwardable
 
       # Private: Hash of commands to related argument generators.
-      ArgumentGenerators = {
-        keyspaces: Cassanity::ArgumentGenerators::Keyspaces.new,
-        keyspace_create: Cassanity::ArgumentGenerators::KeyspaceCreate.new,
-        keyspace_drop: Cassanity::ArgumentGenerators::KeyspaceDrop.new,
-        keyspace_use: Cassanity::ArgumentGenerators::KeyspaceUse.new,
-        column_families: Cassanity::ArgumentGenerators::ColumnFamilies.new,
-        column_family_create: Cassanity::ArgumentGenerators::ColumnFamilyCreate.new,
-        column_family_drop: Cassanity::ArgumentGenerators::ColumnFamilyDrop.new,
-        column_family_truncate: Cassanity::ArgumentGenerators::ColumnFamilyTruncate.new,
-        column_family_select: Cassanity::ArgumentGenerators::ColumnFamilySelect.new,
-        column_family_insert: Cassanity::ArgumentGenerators::ColumnFamilyInsert.new,
-        column_family_update: Cassanity::ArgumentGenerators::ColumnFamilyUpdate.new,
-        column_family_delete: Cassanity::ArgumentGenerators::ColumnFamilyDelete.new,
-        column_family_alter: Cassanity::ArgumentGenerators::ColumnFamilyAlter.new,
-        index_create: Cassanity::ArgumentGenerators::IndexCreate.new,
-        index_drop: Cassanity::ArgumentGenerators::IndexDrop.new,
-        batch: Cassanity::ArgumentGenerators::Batch.new,
+      DefaultArgumentGenerators = {
+        keyspaces: ArgumentGenerators::Keyspaces.new,
+        keyspace_create: ArgumentGenerators::KeyspaceCreate.new,
+        keyspace_drop: ArgumentGenerators::KeyspaceDrop.new,
+        keyspace_use: ArgumentGenerators::KeyspaceUse.new,
+        column_families: ArgumentGenerators::ColumnFamilies.new,
+        column_family_create: ArgumentGenerators::ColumnFamilyCreate.new,
+        column_family_drop: ArgumentGenerators::ColumnFamilyDrop.new,
+        column_family_truncate: ArgumentGenerators::ColumnFamilyTruncate.new,
+        column_family_select: ArgumentGenerators::ColumnFamilySelect.new,
+        column_family_insert: ArgumentGenerators::ColumnFamilyInsert.new,
+        column_family_update: ArgumentGenerators::ColumnFamilyUpdate.new,
+        column_family_delete: ArgumentGenerators::ColumnFamilyDelete.new,
+        column_family_alter: ArgumentGenerators::ColumnFamilyAlter.new,
+        index_create: ArgumentGenerators::IndexCreate.new,
+        index_drop: ArgumentGenerators::IndexDrop.new,
+        batch: ArgumentGenerators::Batch.new,
+        columns: ArgumentGenerators::Columns.new,
       }
 
       # Private: Hash of commands to related result transformers.
-      ResultTransformers = {
-        keyspaces: Cassanity::ResultTransformers::ResultToArray.new,
-        column_families: Cassanity::ResultTransformers::ResultToArray.new,
-        column_family_select: Cassanity::ResultTransformers::ResultToArray.new,
+      DefaultResultTransformers = {
+        keyspaces: ResultTransformers::Keyspaces.new,
+        column_families: ResultTransformers::ColumnFamilies.new,
+        column_family_select: ResultTransformers::ResultToArray.new,
+        columns: ResultTransformers::Columns.new,
       }
 
+      # Private: Default retry strategy to retry N times.
+      DefaultRetryStrategy = RetryStrategies::RetryNTimes.new
+
       # Private: Default result transformer for commands that do not have one.
-      Mirror = Cassanity::ResultTransformers::Mirror.new
+      Mirror = ResultTransformers::Mirror.new
 
       # Private: Forward #instrument to instrumenter.
       def_delegator :@instrumenter, :instrument
 
       # Private
-      attr_reader :client
+      attr_reader :driver
 
       # Private
       attr_reader :argument_generators
@@ -71,10 +82,13 @@ module Cassanity
       # Private: What should be used to instrument all the things.
       attr_reader :instrumenter
 
+      # Private: What strategy to use when retrying Cassandra commands
+      attr_reader :retry_strategy
+
       # Internal: Initializes a cassandra-cql based CQL executor.
       #
       # args - The Hash of arguments.
-      #        :client - The CassandraCQL::Database connection instance.
+      #        :driver - The CassandraCQL::Database connection instance.
       #        :instrumenter - What should be used to instrument all the things
       #                        (default: Cassanity::Instrumenters::Noop).
       #        :argument_generators - A Hash where each key is a command name
@@ -85,17 +99,21 @@ module Cassanity
       #                               and each value is the related result
       #                               transformer that responds to `call`
       #                               (optional).
+      #        :retry_strategy      - What retry strategy to use on failed
+      #                               CassandraCQL calls
+      #                               (default: Cassanity::Instrumenters::RetryNTimes)
       #
       # Examples
       #
-      #   client = CassandraCQL::Database.new('host', cql_version: '3.0.0')
-      #   Cassanity::Executors::CassandraCql.new(client: client)
+      #   driver = CassandraCQL::Database.new('host', cql_version: '3.0.0')
+      #   Cassanity::Executors::CassandraCql.new(driver: driver)
       #
       def initialize(args = {})
-        @client = args.fetch(:client)
+        @driver = args.fetch(:driver)
         @instrumenter = args[:instrumenter] || Instrumenters::Noop
-        @argument_generators = args.fetch(:argument_generators) { ArgumentGenerators }
-        @result_transformers = args.fetch(:result_transformers) { ResultTransformers }
+        @argument_generators = args.fetch(:argument_generators, DefaultArgumentGenerators)
+        @result_transformers = args.fetch(:result_transformers, DefaultResultTransformers)
+        @retry_strategy = args[:retry_strategy] || DefaultRetryStrategy
       end
 
       # Internal: Execute a CQL query.
@@ -112,42 +130,53 @@ module Cassanity
       #
       #   call({
       #     command: :keyspace_create,
-      #     arguments: {name: 'analytics'},
+      #     arguments: {keyspace_name: 'analytics'},
       #   })
       #
       # Returns the result of execution.
       # Raises Cassanity::Error if anything goes wrong during execution.
       def call(args = {})
-        instrument('cql.cassanity', {}) do |payload|
-          command = args.fetch(:command)
-          generator = @argument_generators.fetch(command)
-          arguments = args[:arguments]
-          execute_arguments = generator.call(arguments)
+        instrument('cql.cassanity') do |payload|
+          begin
+            command = args.fetch(:command)
+            payload[:command] = command
+            generator = @argument_generators.fetch(command)
+          rescue KeyError => e
+            raise Cassanity::UnknownCommand
+          end
 
-          result = @client.execute(*execute_arguments)
-
-          transformer = @result_transformers.fetch(command) { Mirror }
-          transformed_result = transformer.call(result)
+          arguments = args[:arguments]
 
-          payload[:command] = command
-          payload[:generator] = generator
-          payload[:arguments] = arguments
-          payload[:execute_arguments] = execute_arguments
-          payload[:result] = result
-          payload[:transformer] = transformer
+          if arguments
+            if (keyspace_name = arguments[:keyspace_name])
+              payload[:keyspace_name] = keyspace_name
+            end
+
+            if (column_family_name = arguments[:column_family_name])
+              payload[:column_family_name] = column_family_name
+            end
+          end
+
+          begin
+            execute_arguments = generator.call(arguments)
+            payload[:cql] = execute_arguments[0]
+            payload[:cql_variables] = execute_arguments[1..-1]
+            result = @retry_strategy.execute(payload) { @driver.execute(*execute_arguments) }
+            transformer = @result_transformers.fetch(command, Mirror)
+            transformed_result = transformer.call(result, args[:transformer_arguments])
+            payload[:result] = transformed_result
+          rescue StandardError => e
+            raise Cassanity::Error
+          end
 
           transformed_result
         end
-      rescue KeyError
-        raise Cassanity::UnknownCommand
-      rescue Exception => e
-        raise Cassanity::Error
       end
 
       # Public
       def inspect
         attributes = [
-          "client=#{@client.inspect}",
+          "driver=#{@driver.inspect}",
         ]
         "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
       end

data/lib/cassanity/instrumentation/log_subscriber.rb

@@ -10,13 +10,12 @@ module Cassanity
 
         name = '%s (%.1fms)' % ["CQL Query", event.duration]
 
-        # execute arguments are always an array where the first element is the
-        # cql string and the rest are the bound variables.
-        cql, *args = event.payload[:execute_arguments]
-        arguments = args.map { |arg| arg.inspect }.join(', ')
+        cql = event.payload[:cql]
+        vars = event.payload[:cql_variables] || []
+        variables = vars.map { |var| var.inspect }.join(', ')
 
         query = "#{cql}"
-        query += " (#{arguments})" unless arguments.empty?
+        query += " (#{variables})" unless variables.empty?
 
         debug "  #{color(name, CYAN, true)}  [ #{query} ]"
       end

data/lib/cassanity/instrumentation/metriks.rb

@@ -0,0 +1,6 @@
+require 'securerandom'
+require 'active_support/notifications'
+require 'cassanity/instrumentation/metriks_subscriber'
+
+ActiveSupport::Notifications.subscribe 'cql.cassanity',
+  Cassanity::Instrumentation::MetriksSubscriber

data/lib/cassanity/instrumentation/metriks_subscriber.rb

@@ -0,0 +1,16 @@
+# Note: You should never need to require this file directly if you are using
+# ActiveSupport::Notifications. Instead, you should require the metriks file
+# that lives in the same directory as this file. The benefit is that it
+# subscribes to the correct events and does everything for your.
+require 'cassanity/instrumentation/subscriber'
+require 'metriks'
+
+module Cassanity
+  module Instrumentation
+    class MetriksSubscriber < Subscriber
+      def update_timer(metric)
+        Metriks.timer(metric).update(@duration)
+      end
+    end
+  end
+end

data/lib/cassanity/instrumentation/statsd.rb

@@ -0,0 +1,6 @@
+require 'securerandom'
+require 'active_support/notifications'
+require 'cassanity/instrumentation/statsd_subscriber'
+
+ActiveSupport::Notifications.subscribe 'cql.cassanity',
+  Cassanity::Instrumentation::StatsdSubscriber

data/lib/cassanity/instrumentation/statsd_subscriber.rb

@@ -0,0 +1,22 @@
+# Note: You should never need to require this file directly if you are using
+# ActiveSupport::Notifications. Instead, you should require the metriks file
+# that lives in the same directory as this file. The benefit is that it
+# subscribes to the correct events and does everything for your.
+require 'cassanity/instrumentation/subscriber'
+require 'statsd'
+
+module Cassanity
+  module Instrumentation
+    class StatsdSubscriber < Subscriber
+      class << self
+        attr_accessor :client
+      end
+
+      def update_timer(metric)
+        if self.class.client
+          self.class.client.timing metric, (@duration * 1_000).round
+        end
+      end
+    end
+  end
+end

data/lib/cassanity/instrumentation/subscriber.rb

@@ -0,0 +1,58 @@
+module Cassanity
+  module Instrumentation
+    class Subscriber
+      # Public: Use this as the subscribed block.
+      def self.call(name, start, ending, transaction_id, payload)
+        new(name, start, ending, transaction_id, payload).update
+      end
+
+      # Private: Initializes a new event processing instance.
+      def initialize(name, start, ending, transaction_id, payload)
+        @name = name
+        @start = start
+        @ending = ending
+        @payload = payload
+        @duration = ending - start
+        @transaction_id = transaction_id
+
+        @command_name = @payload[:command]
+        @keyspace_name = @payload[:keyspace_name]
+        @column_family_name = @payload[:column_family_name]
+      end
+
+      # Public: Actually update all the metriks timers for the event.
+      #
+      # Returns nothing.
+      def update
+        update_timer 'cassanity.cql'
+
+        if command_name?
+          update_timer "cassanity.command.#{@command_name}.cql"
+        end
+
+        if column_family_name?
+          update_timer "cassanity.column_family.#{@column_family_name}.cql"
+        end
+
+        if column_family_name? && command_name?
+          update_timer "cassanity.column_family.#{@column_family_name}.#{@command_name}.cql"
+        end
+      end
+
+      # Internal: Override in subclass.
+      def update_timer(metric)
+        raise 'not implemented'
+      end
+
+      # Private: Returns true if command name present else false.
+      def command_name?
+        @command_name_present ||= !@command_name.nil? && !@command_name.empty?
+      end
+
+      # Private: Returns true if column family name present else false.
+      def column_family_name?
+        @column_family_name_present ||= !@column_family_name.nil? && !@column_family_name.empty?
+      end
+    end
+  end
+end

data/lib/cassanity/instrumenters/memory.rb

@@ -19,7 +19,6 @@ module Cassanity
         end
 
         @events << Event.new(name, payload, result)
-
         result
       end
     end

data/lib/cassanity/keyspace.rb

@@ -25,7 +25,7 @@ module Cassanity
     #                            creating keyspace.
     #
     def initialize(args = {})
-      @name = args.fetch(:name)
+      @name = args.fetch(:name).to_sym
       @executor = args.fetch(:executor)
       @strategy_class = args[:strategy_class]
       @strategy_options = args[:strategy_options]
@@ -36,8 +36,12 @@ module Cassanity
     #
     # Returns true if keyspace exists, false if it does not.
     def exists?
-      rows = @executor.call(command: :keyspaces)
-      rows.any? { |row| row['name'].to_s == name.to_s }
+      @executor.call({
+        command: :keyspaces,
+        transformer_arguments: {
+          executor: @executor,
+        },
+      }).any? { |keyspace| keyspace.name == @name }
     end
 
     alias_method :exist?, :exists?
@@ -125,12 +129,10 @@ module Cassanity
         arguments: {
           keyspace_name: @name,
         },
-      }).map { |row|
-        ColumnFamily.new({
-          name: row['columnfamily'],
+        transformer_arguments: {
           keyspace: self,
-        })
-      }
+        }
+      })
     end
 
     # Public: Get a column family instance