em-pg-client-helper 0.5.0 → 0.5.1

data/lib/em-pg-client-helper/deferrable_group.rb

@@ -10,10 +10,10 @@ class PG::EM::Client::Helper::DeferrableGroup
 	# Create a new deferrable group.
 	#
 	def initialize
-		@failed = false
-		@finished = false
-		@first_failure = nil
+		@closed      = false
+		@failure     = nil
 		@outstanding = []
+
 		yield(self) if block_given?
 	end
 
@@ -24,19 +24,34 @@ class PG::EM::Client::Helper::DeferrableGroup
 	# @return [EM::Deferrable] the same deferrable.
 	#
 	# @raise [RuntimeError] if you attempt to add a deferrable after the
-	#   group has already "completed" (that is, all deferrables that were
-	#   previously added to the group have finished).
+	#   group has been closed (that is, the `#close` method has been called),
+	#   indicating that the deferrable group doesn't have any more deferrables
+	#   to add.
 	#
 	def add(df)
-		if @finished
+		if @closed
 			raise RuntimeError,
-			      "This deferrable group has already completed."
+			      "This deferrable group is closed."
 		end
 
 		@outstanding << df
 		df.callback { completed(df) }.errback { |ex| failed(df, ex) }
 	end
 
+	# Tell the group that no further deferrables are to be added
+	#
+	# If all the deferrables in a group are complete, the group can't be sure
+	# whether further deferrables may be added in the future.  By requiring
+	# an explicit `#close` call before the group completes, this ambiguity is
+	# avoided.  It does, however, mean that if you forget to close the
+	# deferrable group, your code is going to hang.  Such is the risk of
+	# async programming.
+	#
+	def close
+		@closed = true
+		maybe_done
+	end
+
 	# Mark a deferrable as having been completed.
 	#
 	# If this is the last deferrable in the group, then the callback/errback
@@ -58,8 +73,7 @@ class PG::EM::Client::Helper::DeferrableGroup
 	# will unfortunately be eaten by a grue.
 	#
 	def failed(df, ex)
-		@first_failure ||= ex
-		@failed = true
+		@failure ||= ex
 		completed(df)
 	end
 
@@ -67,10 +81,9 @@ class PG::EM::Client::Helper::DeferrableGroup
 	# Called every time a deferrable finishes, just in case we're ready to
 	# trigger our callbacks.
 	def maybe_done
-		if @outstanding.empty?
-			@finished = true
-			if @failed
-				fail(@first_failure)
+		if @closed and @outstanding.empty?
+			if @failure
+				fail(@failure)
 			else
 				succeed
 			end

data/lib/em-pg-client-helper/transaction.rb

@@ -7,12 +7,15 @@ class PG::EM::Client::Helper::Transaction
 	def initialize(conn, opts, &blk)
 		@conn       = conn
 		@opts       = opts
-		@active     = true
+		# This can be `nil` if the txn is in progress, or it will be
+		# true or false to indicate success/failure of the txn
+		@committed  = nil
 
 		DeferrableGroup.new do |dg|
 			@dg = dg
 
-			conn.exec_defer("BEGIN").callback do
+			trace_query("BEGIN")
+			@conn.exec_defer("BEGIN").callback do
 				begin
 					blk.call(self)
 				rescue StandardError => ex
@@ -20,9 +23,10 @@ class PG::EM::Client::Helper::Transaction
 				end
 			end.errback { |ex| rollback(ex) }.tap { |df| @dg.add(df) }
 		end.callback do
-			rollback(RuntimeError.new("txn.commit was not called")) if @active
+			rollback(RuntimeError.new("txn.commit was not called")) unless @committed
+			self.succeed
 		end.errback do |ex|
-			rollback(ex)
+			self.fail(ex)
 		end
 	end
 
@@ -33,11 +37,16 @@ class PG::EM::Client::Helper::Transaction
 	# exception will be raised.
 	#
 	def commit
-		if @active
-			@conn.exec_defer("COMMIT").callback do
-				@active = false
-				self.succeed
-			end.errback { |ex| rollback(ex) }.tap { |df| @dg.add(df) }
+		if @committed.nil?
+			trace_query("COMMIT")
+			@conn.exec_defer("COMMIT").tap do |df|
+				@dg.add(df)
+			end.callback do
+				@committed = true
+				@dg.close
+			end.errback do |ex|
+				rollback(ex)
+			end
 		end
 	end
 
@@ -47,11 +56,15 @@ class PG::EM::Client::Helper::Transaction
 	# event of a database error or other exception.
 	#
 	def rollback(ex)
-		if @active
-			@conn.exec_defer("ROLLBACK") do
-				@active = false
-				self.fail(ex)
-			end.tap { |df| @dg.add(df) }
+		if @committed.nil?
+			trace_query("ROLLBACK")
+			@conn.exec_defer("ROLLBACK").tap do |df|
+				@dg.add(df)
+			end.callback do
+				@committed = false
+				@dg.fail(ex)
+				@dg.close
+			end
 		end
 	end
 
@@ -74,15 +87,22 @@ class PG::EM::Client::Helper::Transaction
 	#   specific query finishes.
 	#
 	def exec(sql, values=[], &blk)
-		unless @active
+		unless @committed.nil?
 			raise RuntimeError,
 			      "Cannot execute a query in a transaction that has been closed"
 		end
 
+		trace_query(sql, values)
 		@conn.exec_defer(sql, values).tap do |df|
 			@dg.add(df)
 			df.callback(&blk) if blk
+		end.errback do |ex|
+			rollback(ex)
 		end
 	end
 	alias_method :exec_defer, :exec
+
+	def trace_query(q, v=nil)
+		$stderr.puts "#{@conn.inspect}: #{q} #{v.inspect}" if ENV['EM_PG_TXN_TRACE']
+	end
 end

data/spec/db_transaction_spec.rb

@@ -16,11 +16,6 @@ describe "PG::EM::Client::Helper#db_transaction" do
 		  and_return(df).
 		  ordered
 
-		# Rollback expects a yield
-		if q == "ROLLBACK"
-			ex.and_yield()
-		end
-
 		EM.add_timer(exec_time) do
 			df.__send__(disposition)
 		end
@@ -32,7 +27,7 @@ describe "PG::EM::Client::Helper#db_transaction" do
 
 	def in_em
 		EM.run do
-			EM.add_timer(1) { EM.stop; raise "test timeout" }
+			EM.add_timer(0.5) { EM.stop; raise "test timeout" }
 			yield
 		end
 	end
@@ -41,8 +36,8 @@ describe "PG::EM::Client::Helper#db_transaction" do
 		in_em do
 			expect_query("BEGIN")
 			expect_query("COMMIT")
-			in_transaction do
-				# Nothing
+			in_transaction do |txn|
+				txn.commit
 			end
 		end
 	end
@@ -51,8 +46,8 @@ describe "PG::EM::Client::Helper#db_transaction" do
 		in_em do
 			expect_query_failure("BEGIN")
 			expect_query("ROLLBACK")
-			in_transaction do
-				# Nothing
+			in_transaction do |txn|
+				txn.commit
 			end
 		end
 	end
@@ -62,8 +57,8 @@ describe "PG::EM::Client::Helper#db_transaction" do
 			expect_query("BEGIN")
 			expect_query_failure("COMMIT")
 			expect_query("ROLLBACK")
-			in_transaction do
-				# Nothing
+			in_transaction do |txn|
+				txn.commit
 			end
 		end
 	end
@@ -74,7 +69,9 @@ describe "PG::EM::Client::Helper#db_transaction" do
 			expect_query('INSERT INTO "foo" ("bar") VALUES ($1)', ["baz"])
 			expect_query("COMMIT")
 			in_transaction do |txn|
-				txn.insert("foo", :bar => 'baz')
+				txn.insert("foo", :bar => 'baz') do
+					txn.commit
+				end
 			end
 		end
 	end
@@ -85,7 +82,9 @@ describe "PG::EM::Client::Helper#db_transaction" do
 			expect_query_failure('INSERT INTO "foo" ("bar") VALUES ($1)', ["baz"])
 			expect_query("ROLLBACK")
 			in_transaction do |txn|
-				txn.insert("foo", :bar => 'baz')
+				txn.insert("foo", :bar => 'baz') do
+					txn.commit
+				end
 			end
 		end
 	end
@@ -101,7 +100,9 @@ describe "PG::EM::Client::Helper#db_transaction" do
 			in_transaction do |txn|
 				txn.insert("foo", :bar => 'baz') do
 					txn.insert("foo", :bar => 'wombat') do
-						txn.insert("foo", :bar => 'quux')
+						txn.insert("foo", :bar => 'quux') do
+							txn.commit
+						end
 					end
 				end
 			end
@@ -124,7 +125,9 @@ describe "PG::EM::Client::Helper#db_transaction" do
 			in_transaction do |txn|
 				txn.insert("foo", :bar => 'baz') do
 					txn.insert("foo", :bar => 'wombat') do
-						txn.insert("foo", :bar => 'quux')
+						txn.insert("foo", :bar => 'quux') do
+							txn.commit
+						end
 					end
 				end
 			end
@@ -137,8 +140,9 @@ describe "PG::EM::Client::Helper#db_transaction" do
 			expect_query('INSERT INTO "foo" ("bar") VALUES ($1)', ["baz"])
 			expect_query("ROLLBACK")
 			in_transaction do |txn|
-				txn.insert("foo", :bar => 'baz')
-				txn.rollback("Because I can")
+				txn.insert("foo", :bar => 'baz') do
+					txn.rollback("Because I can")
+				end
 			end
 		end
 	end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-pg-client-helper
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -261,7 +261,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 472890837169152565
+      hash: -4325502789198036899
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -270,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 472890837169152565
+      hash: -4325502789198036899
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23