activerecord-spanner-adapter 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ff8fa6b4d8ed65a702bde98a87cd0c8f2297d66
-  data.tar.gz: bfce942a21417f01f4aec9c211c7c27fc7a5b278
+  metadata.gz: 98b65b0b5292ed6027d2dd1305a9794565438374
+  data.tar.gz: ff0fc0355000390592dd1c916d8eaedfdb4c24e9
 SHA512:
-  metadata.gz: 54da92b648a12aa2f8add6dc52f03c1255fd529c178aadfcfb112520d8f6c918095bcdd6c33907f848da124edcf6a390e5c39133c0ebc35ce2baf9b53fb6effd
-  data.tar.gz: 88072ff07c34f9d9d2a3314a0c8b258bc3bb34433e811c6a825775ffa663852ca3a01bf30e992c94ce2e029ce4c2ec87f1967175532c34af4231787459f1b5a8
+  metadata.gz: 25ec93d1aa400524c5feb62efbb0bf1dce21468fdee84c5ba8d701cdeedd55b91880ff27880e46c6a19f5bd6d5791d289458a623a675d1089b1c99e1b892b92c
+  data.tar.gz: 83cd0c3ecec42157a2f0675c1c77900045c74dee42ba83a44474ce966e0dab83b1b5f8fbfb57a8d9eab60b0bf8ebdac3d1177ba4a81faf2734ebb9e62c20142d

data/Gemfile

@@ -3,6 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in activerecord-spanner-adapter.gemspec
 gemspec
 
-gem 'google-cloud-spanner', path: 'vendor/gcloud-ruby/google-cloud-spanner'
 gem 'pry'
 gem 'pry-byebug'

data/Rakefile

@@ -1,10 +1,6 @@
 require "bundler/gem_tasks"
-require "rake/testtask"
+require "rspec/core/rake_task"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
-end
+RSpec::Core::RakeTask.new("spec")
+task :default => :spec
 
-task :default => :test

data/activerecord-spanner-adapter.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'activerecord', "~> 5.0"
-  spec.add_dependency 'google-cloud-spanner'
+  spec.add_dependency 'google-cloud-spanner', "~> 0.23"
   spec.add_dependency 'google-gax', '~> 0.8'
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rspec", "~> 3.6.0"
 end

data/lib/active_record/connection_adapters/spanner/client.rb

@@ -0,0 +1,190 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module Spanner
+      # raised on unsupported operations in a certain transaction state.
+      class TransactionStateError < ActiveRecordError
+      end
+
+      class InitialPhaseClient
+        def initialize(client)
+          @client = client
+          @next = self
+        end
+
+        attr_reader :next
+
+        delegate :insert, :update, :delete, :execute, :close, to: :client
+
+        def begin_transaction
+          @next = ReadWriteTransactionClient.begin(client)
+        end
+
+        def begin_snapshot(**options)
+          @next = SnapshotClient.begin(client, **options)
+        end
+
+        %w[ commit rollback ].each do |name|
+          class_eval(<<-"EOS", __FILE__, __LINE__+1)
+            def #{name}
+              raise TransactionStateError, 'not in a transaction'
+            end
+          EOS
+        end
+
+        private
+        attr_reader :client
+      end
+
+      class ReadWriteTransactionClient
+        def initialize(client, tx, commit_op, rollback_op)
+          @next = self
+          @client = client
+          @tx = tx
+
+          @commit_op = commit_op
+          @rollback_op = rollback_op
+        end
+
+        class << self
+          def begin(client)
+            enum = enum_for(:transaction, client, deadline: 0)
+            closer = ->{
+              begin
+                enum.next
+              rescue StopIteration => stop
+                stop.result
+              end
+            }
+
+            begin
+              tx, rollback_op = enum.next
+              on_rollback = ->{
+                begin
+                  rollback_op.call
+                ensure
+                  closer.call
+                end
+              }
+              return ReadPhaseClient.new(client, tx, closer, on_rollback)
+            rescue
+              closer.call
+              raise
+            end
+          end
+
+          private
+          def transaction(client, *args)
+            client.transaction(*args) do |tx|
+              rollbacked = false
+              yield tx, ->{ rollbacked = true }
+              raise Google::Cloud::Spanner::Rollback if rollbacked
+            end
+          end
+        end
+
+        attr_reader :next
+
+        delegate :close, to: :client
+        delegate :execute, :insert, :update, :delete, to: :tx
+
+        def commit
+          result = @commit_op.call
+          result.tap do
+            @next = InitialPhaseClient.new(@client)
+          end
+        end
+
+        def rollback
+          @rollback_op.call.tap do
+            @next = InitialPhaseClient.new(@client)
+          end
+        end
+
+        %w[ begin_transaction begin_snapshot ].each do |name|
+          class_eval(<<-"EOS", __FILE__, __LINE__+1)
+            def #{name}(*args)
+              raise TransactionStateError, 'already in a transaction'
+            end
+          EOS
+        end
+
+        private
+        attr_reader :client, :tx  # :nodoc:
+      end
+
+      class ReadPhaseClient < ReadWriteTransactionClient
+        %w[ insert update delete ].each do |name|
+          class_eval(<<-"EOS", __FILE__, __LINE__+1)
+            def #{name}(*args)
+              super.tap { transit_to_write_phase }
+            end
+          EOS
+        end
+
+        private
+        def transit_to_write_phase
+          @next = WritePhaseClient.new(@client, @tx, @commit_op, @rollback_op)
+        end
+      end
+
+      class WritePhaseClient < ReadWriteTransactionClient
+        def execute(*args)
+          raise TransactionStateError, "cannot read after write within a transaction"
+        end
+      end
+
+      class SnapshotClient
+        def initialize(client, **options)
+          @client = client
+
+          enum = client.enum_for(:snapshot, **options)
+          @snapshot, @closer = enum.next, ->{ loop { enum.next } }
+          @next = self
+        end
+
+        class << self
+          alias begin new
+        end
+
+        attr_reader :next
+
+        delegate :close, to: :client
+        delegate :execute, to: :snapshot
+
+        %w[ insert update delete ].each do |name|
+          class_eval(<<-"EOS", __FILE__, __LINE__+1)
+            def #{name}(*)
+              raise TransactionStateError, "cannot write within a read-only transaction"
+            end
+          EOS
+        end
+
+        %w[ commit rollback ].each do |name|
+          class_eval(<<-"EOS", __FILE__, __LINE__+1)
+            def #{name}
+              terminate_phase
+              true
+            end
+          EOS
+        end
+
+        %w[ begin_transaction begin_snapshot ].each do |name|
+          class_eval(<<-"EOS", __FILE__, __LINE__+1)
+            def #{name}(*args)
+              raise TransactionStateError, 'already in a transaction'
+            end
+          EOS
+        end
+
+        private
+        attr_reader :client, :snapshot
+
+        def terminate_phase
+          @next = InitialPhaseClient.new(@client)
+        ensure
+          @closer.call
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/spanner/database_statements.rb

@@ -207,16 +207,14 @@ module ActiveRecord
           }
 
           log(fake_sql, name) do
-            session.commit do |c|
-              c.insert table, row
-            end
+            with_phase_transition {|client| client.insert(table, row) }
           end
 
           id_value
         end
 
         def update(arel, name = nil, binds = [])
-          raise NotImplementedError, "DELETE in raw SQL is not supported" unless arel.respond_to?(:ast)
+          raise NotImplementedError, "UPDATE statement in raw SQL is not supported" unless arel.respond_to?(:ast)
 
           type_casted_binds = binds.map {|attr| type_cast(attr.value_for_database) }
           table, target, values = MutationVisitor.new(self, type_casted_binds.dup).accept(arel.ast)
@@ -236,16 +234,13 @@ module ActiveRecord
           rows = target.map {|id| row.merge(pk => id) }
 
           log(fake_sql, name, binds) do
-            session.commit do |c|
-              c.update(table, rows)
-            end
+            with_phase_transition {|client| client.update(table, rows) }
           end
-
-          true
+          target.size
         end
 
         def delete(arel, name, binds)
-          raise NotImplementedError, "DELETE in raw SQL is not supported" unless arel.respond_to?(:ast)
+          raise NotImplementedError, "DELETE statement in raw SQL is not supported" unless arel.respond_to?(:ast)
 
           type_casted_binds = binds.map {|attr| type_cast(attr.value_for_database) }
           table, target, wheres = MutationVisitor.new(self, type_casted_binds.dup).accept(arel.ast)
@@ -272,9 +267,7 @@ module ActiveRecord
           end
 
           log(fake_sql, name, binds) do
-            session.commit do |c|
-              c.delete(table, keyset)
-            end
+            with_phase_transition {|client| client.delete(table, keyset) }
           end
 
           keyset.size
@@ -305,14 +298,36 @@ module ActiveRecord
           end
 
           log(sql, name, binds) do
-            results = session.execute(sql, params: spanner_binds, streaming: false) 
-            columns = results.types.map(&:first)
-            rows = results.rows.map {|row|
-              columns.map {|col| row[col] }
-            }
+            executor = client
+            executor = raw_client if name == 'SCHEMA'
+            results = executor.execute(sql, params: spanner_binds) 
+            columns = results.fields.keys
+            rows = results.rows.map(&:to_a)
             ActiveRecord::Result.new(columns.map(&:to_s), rows)
           end
         end
+
+        def begin_db_transaction
+          with_phase_transition {|client| client.begin_transaction }
+        end
+
+        def begin_isolated_db_transaction(isolation)
+          with_phase_transition {|client| client.begin_snapshot(**isolation) }
+        end
+
+        def commit_db_transaction
+          with_phase_transition {|client| client.commit }
+        end
+
+        def exec_rollback_db_transaction
+          with_phase_transition {|client| client.rollback }
+        end
+
+        def with_phase_transition
+          result = yield client
+          @client = client.next
+          result
+        end
       end
     end
   end

data/lib/active_record/connection_adapters/spanner/schema_creation.rb

@@ -5,10 +5,16 @@ module ActiveRecord
 
       class SchemaCreation < AbstractAdapter::SchemaCreation
         def visit_TableDefinition(o)
-          pk = o.columns.find {|c| c.type == :primary_key }
+          pk = o.columns.find {|c| c.options[:primary_key] }
           ddl = "#{super} PRIMARY KEY (#{quote_column_name(pk.name)})"
           DDL.new(ddl)
         end
+
+        def add_column_options!(sql, options)
+          if options[:null] == false
+            sql << " NOT NULL"
+          end
+        end
       end
     end
   end

data/lib/active_record/connection_adapters/spanner/schema_statements.rb

@@ -119,16 +119,14 @@ module ActiveRecord
         end
 
         def create_database(name, instance_id: nil, statements: [])
-          service = instance.service
-          job = service.create_database(instance_id || instance.instance_id, name,
-                                        statements: statements)
+          job = conn.create_database(instance_id || @instance_id, name,
+                                     statements: statements)
           job.wait_until_done! unless job.done?
           raise_on_error(job)
         end
 
         def drop_database(name, instance_id: nil)
-          service = instance.service
-          service.drop_database(instance_id || instance.instance_id, name)
+          conn.service.drop_database(instance_id || @instance_id, name)
         end
 
         def drop_table(name, options = {})

data/lib/active_record/connection_adapters/spanner_adapter.rb

@@ -1,10 +1,12 @@
 require 'google/cloud/spanner'
 
 require 'active_record/connection_adapters/abstract_adapter'
+require 'active_record/connection_adapters/spanner/client'
 require 'active_record/connection_adapters/spanner/database_statements'
 require 'active_record/connection_adapters/spanner/schema_creation'
 require 'active_record/connection_adapters/spanner/schema_statements'
 require 'active_record/connection_adapters/spanner/quoting'
+require 'grpc'
 
 module ActiveRecord
   module ConnectionHandling
@@ -28,9 +30,9 @@ module ActiveRecord
       include Spanner::Quoting
 
       def initialize(connection, logger, config)
-        super(connection, logger, config)
         conn_params = config.symbolize_keys.slice(*ADAPTER_OPTS)
         connect(conn_params)
+        super(connection, logger, config)
       end
 
       def schema_creation # :nodoc:
@@ -42,19 +44,22 @@ module ActiveRecord
       end
 
       def active?
-        !!@client
-        # TODO(yugui) Check db.service.channel.connectivity_state once it is fixed?
+        [
+          ::GRPC::Core::ConnectivityStates::IDLE,
+          ::GRPC::Core::ConnectivityStates::READY,
+        ].include?(@conn.service.channel.connectivity_state)
       end
 
       def connect(params)
         client_params = params.slice(*CLIENT_PARAMS)
-        @client = Google::Cloud::Spanner.new(**client_params)
+        @conn = Google::Cloud::Spanner.new(**client_params)
         @instance_id = params[:instance]
         @database_id = params[:database]
       end
 
       def disconnect!
-        invalidate_session
+        super
+        release_client!
       end
 
       def prefetch_primary_key?(table_name = nil)
@@ -67,7 +72,7 @@ module ActiveRecord
       end
 
       private
-      attr_reader :client
+      attr_reader :conn
 
       def initialize_type_map(m) # :nodoc:
         register_class_with_limit m, %r(STRING)i, Type::String
@@ -82,9 +87,8 @@ module ActiveRecord
         # TODO(yugui) Support array and struct
       end
 
-
       def instance
-        @instance ||= client.instance(@instance_id)
+        @instance ||= conn.instance(@instance_id)
         raise ActiveRecord::NoDatabaseError unless @instance
 
         @instance
@@ -101,15 +105,22 @@ module ActiveRecord
         @db
       end
 
-      def session
-        @session ||= database.session
+      def raw_client
+        @raw_client ||= conn.client(@instance_id, @database_id)
       end
 
-      def invalidate_session
-        @session&.delete_session
-        @session = nil
+      def client
+        @client ||= ConnectionAdapters::Spanner::InitialPhaseClient.new(raw_client)
       end
+
+      def release_client!
+        @client&.close
+        @client = nil
+      end
+
+      #def reset_transaction
+      #  # @transaction_manager = Spanner::TransactionManager.new(self, client)
+      #end
     end
   end
 end
-

data/lib/activerecord-spanner-adapter/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordSpannerAdapter
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-spanner-adapter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yuki Yugui Sonoda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-09 00:00:00.000000000 Z
+date: 2017-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -28,16 +28,16 @@ dependencies:
   name: google-cloud-spanner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.23'
 - !ruby/object:Gem::Dependency
   name: google-gax
   requirement: !ruby/object:Gem::Requirement
@@ -81,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 3.6.0
 description: Connection Adapter of Google Cloud Spanner to ActiveRecord O/R mapper
   library
 email:
@@ -103,7 +103,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".gitmodules"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -113,6 +112,7 @@ files:
 - bin/console
 - bin/setup
 - lib/active_record/connection_adapters/spanner.rb
+- lib/active_record/connection_adapters/spanner/client.rb
 - lib/active_record/connection_adapters/spanner/database_statements.rb
 - lib/active_record/connection_adapters/spanner/quoting.rb
 - lib/active_record/connection_adapters/spanner/schema_creation.rb
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Adapts Google Cloud Spanner to ActiveRecord

data/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "gcloud-ruby"]
-	path = vendor/gcloud-ruby
-	url = https://github.com/GoogleCloudPlatform/google-cloud-ruby