cassandra-schema 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 646b6d54404b35f5f4925709947d873dc7bf2880
-  data.tar.gz: 5550c316d8f6fa5460f7db981654344e347a5252
+  metadata.gz: c1df802181e12870f46be28f9ffb5a0520d6ba0a
+  data.tar.gz: 2b0492a941204bf66ed2a78a9b4a803bf5df34e2
 SHA512:
-  metadata.gz: c4a88f2462cafff564678761264402e76da9574f9d1b6df02ce008363a51cc96b7af3d06ceb0354e7de61b2e4d90e94d51354b75b9f9a41325463ade1bd5298f
-  data.tar.gz: c64a715befaed5b60ff833ad8a61a4ef07ac67e50a842d94fc3595c9f9e5d3ef7c14966f25373b990bc9671f6163668f6ef2e5d7afeae973179520e9f5bbe16f
+  metadata.gz: 6f45ca854b3faaa1efa1ead0692e58bc809b06e912d6b133e385b53efe3824d70075cbe4b388864910b100d9bdbc94f85642d73eccef791eaab39abf74fe3534
+  data.tar.gz: 3ad6a515d4290b1c6766d39e7b65ddc46740d65cb711d27e2375c65e5a86af00b584e689d5e196385c06c1c03919f1c34abf6a59bfd81fea681e13941a0ca0a7

data/README.md

@@ -4,6 +4,11 @@ Simple reversible schema migrations for cassandra.
 
 ## Changelog
 
+### Version `0.4.0`
+
+- Add `query_delay` option to configure sleep time between schema changes. Default `0`.
+- Add `lock_retry` option to retry migration if schema is locked. Default `[]`
+
 ### Version `0.3.0`
 
 - Add `query_timeout` option for running migration commands. Default 30 seconds.
@@ -91,11 +96,13 @@ CassandraSchema tracks which migrations you have already run.
 
 ### Options
 
-name | default | description
----- | ------- | -----------
-lock | true    | whether the Migrator must lock the schema before running migrations
-lock_timeout | 30 | number of seconds for auto-unlocking schema
-query_timeout | 30 | number of seconds after which to time out the command if it hasn’t completed
+name | default | description | example
+---- | ------- | ----------- | -------
+lock | true    | whether the Migrator must lock the schema before running migrations |
+lock_timeout | 30 | number of seconds for auto-unlocking schema |
+lock_retry | [] | array of retries. The size of the array is the max number of retries. Each item of the array is the number of seconds to wait until the next retry. | [1, 1, 2, 3, 5, 8]
+query_timeout | 30 | number of seconds after which to time out the command if it hasn’t completed |
+query_delay | 0 | number of millisenconds to wait after each schema change |
 
 ## Installation
 

data/cassandra-schema.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "cassandra-schema"
-  s.version = "0.3.0"
+  s.version = "0.4.0"
   s.summary = "Cassandra schema migrations"
   s.license = "MIT"
   s.description = "Simple reversible schema migrations for Cassandra."

data/lib/cassandra-schema/migrator.rb

@@ -7,7 +7,9 @@ module CassandraSchema
     DEFAULT_OPTIONS = {
       lock:          true,
       lock_timeout:  30,
+      lock_retry:    [],
       query_timeout: 30,
+      query_delay:   0,
     }
 
     def initialize(connection:, migrations:, logger: Logger.new(STDOUT), options: {})
@@ -20,7 +22,17 @@ module CassandraSchema
     end
 
     def migrate(target = nil)
-      if @options.fetch(:lock) && !lock_schema
+      lock_retry = @options.fetch(:lock_retry).dup
+
+      begin
+        raise if @options.fetch(:lock) && !lock_schema
+      rescue
+        if wait = lock_retry.shift
+          @logger.info "Schema is locked; retrying in #{wait} seconds"
+          sleep wait
+          retry
+        end
+
         @logger.info "Can't run migrations. Schema is locked."
         return
       end
@@ -195,8 +207,18 @@ module CassandraSchema
     end
 
     def execute_command(command, options)
+      query_delay = @options.fetch(:query_delay)
+
       begin
         @connection.execute command, options
+
+        # There is a Cassandra bug, where schema changes executed in quick succession
+        # can result in internal corruption:
+        #
+        # https://stackoverflow.com/questions/29030661/creating-new-table-with-cqlsh-on-existing-keyspace-column-family-id-mismatch#answer
+        # https://issues.apache.org/jira/browse/CASSANDRA-5025
+        delay(query_delay / 1000.0) if query_delay > 0
+
         true
       rescue => ex
         @logger.error ex.message
@@ -204,5 +226,8 @@ module CassandraSchema
       end
     end
 
+    private def delay(delay_time)
+      sleep(delay_time)
+    end
   end
 end

data/lib/cassandra-schema/version.rb

@@ -1,3 +1,3 @@
 module CassandraSchema
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/test/migrator_test.rb

@@ -100,7 +100,7 @@ describe "CassandraSchema::Migrator" do
   end
 
   it "initializes schema_information table if not exists" do
-    migrator = CassandraSchema::Migrator.new(
+    CassandraSchema::Migrator.new(
       connection: CONN,
       migrations: {},
       logger: @fake_logger,
@@ -187,6 +187,43 @@ describe "CassandraSchema::Migrator" do
       assert_equal "Nothing to migrate.", logger_b.stdout.pop
     end
 
+    it "retries if schema is locked" do
+      migrator = CassandraSchema::Migrator.new(
+        connection: CONN,
+        migrations: CassandraSchema.migrations,
+        logger:     @fake_logger,
+        options:    { lock_retry: [1, 1, 2, 3] },
+      )
+
+      migrator.expects(:lock_schema).times(4).returns(false, false, false, true)
+
+      migrator.migrate
+
+      assert_equal "Schema is locked; retrying in 1 seconds", @fake_logger.stdout.shift
+      assert_equal "Schema is locked; retrying in 1 seconds", @fake_logger.stdout.shift
+      assert_equal "Schema is locked; retrying in 2 seconds", @fake_logger.stdout.shift
+      assert_equal "Running migrations...", @fake_logger.stdout.shift
+
+      assert_equal 2, migrator.current_version
+    end
+
+    it "fails if schema is locked after retring" do
+      migrator = CassandraSchema::Migrator.new(
+        connection: CONN,
+        migrations: CassandraSchema.migrations,
+        logger:     @fake_logger,
+        options:    { lock_retry: [1, 1] },
+      )
+
+      migrator.expects(:lock_schema).times(3).returns(false, false, false)
+
+      migrator.migrate
+
+      assert_equal "Schema is locked; retrying in 1 seconds", @fake_logger.stdout.shift
+      assert_equal "Schema is locked; retrying in 1 seconds", @fake_logger.stdout.shift
+      assert_equal "Can't run migrations. Schema is locked.", @fake_logger.stdout.shift
+    end
+
     it "runs commands with custom timeout" do
       migrator = CassandraSchema::Migrator.new(
         connection: CONN,
@@ -205,6 +242,26 @@ describe "CassandraSchema::Migrator" do
 
       migrator.migrate
     end
+
+    it "runs commands with custom delay" do
+      migrator = CassandraSchema::Migrator.new(
+        connection: CONN,
+        migrations: CassandraSchema.migrations,
+        logger:     @fake_logger,
+        options:    {
+          query_delay: 500,
+        },
+      )
+
+      migrator.expects(:delay).times(4).with(0.5)
+
+      migrator.expects(:lock_schema).returns(true)
+      migrator.expects(:get_current_version).returns(0)
+      migrator.expects(:update_version).times(2)
+      migrator.expects(:renew_lock).times(2)
+
+      migrator.migrate
+    end
   end
 
   describe "migrating down" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cassandra-schema
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Lautaro Orazi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-09 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies: []
 description: Simple reversible schema migrations for Cassandra.
 email: