rservicebus 0.1.57 → 0.1.58

data/lib/rservicebus/Message.rb

@@ -1,17 +1,19 @@
 module RServiceBus
     
-    require 'zlib'
-    
+    require "zlib"
+    require "yaml"
+    require "uuidtools"
+
     #This is the top level message that is passed around the bus
     class Message
         
-        attr_reader :returnAddress, :msgId, :remoteQueueName, :remoteHostName, :lastErrorSourceQueue, :lastErrorString
+        attr_reader :returnAddress, :msgId, :remoteQueueName, :remoteHostName, :lastErrorSourceQueue, :lastErrorString, :correlationId
         
         # Constructor
         #
         # @param [Object] msg The msg to be sent
         # @param [Object] returnAddress A queue to which the destination message handler can send replies
-        def initialize( msg, returnAddress )
+        def initialize( msg, returnAddress, correlationId=nil )
             if ENV["RSBMSG_COMPRESS"].nil? then
                 @compressed = false
                 @_msg=YAML::dump(msg)
@@ -20,6 +22,7 @@ module RServiceBus
                 @_msg=Zlib::Deflate.deflate(YAML::dump(msg))
             end
             
+            @correlationId = correlationId
             @returnAddress=returnAddress
             
             @createdAt = DateTime.now

data/lib/rservicebus/Monitor/CsvDir.rb

@@ -27,8 +27,8 @@ module RServiceBus
             
             return false
         end
-        
-        
+
+
         def ProcessToHash( payload )
             headLine = payload.shift
             newPayload = Array.new

data/lib/rservicebus/ResourceManager.rb

@@ -0,0 +1,72 @@
+module RServiceBus
+    
+    #Co0ordinate Transactions across resources, handlers, and Sagas
+    class ResourceManager
+
+        # Constructor
+        #
+        def initialize( stateManager, sagaStorage )
+            @appResources = Hash.new
+            @currentResources = Hash.new
+            @stateManager = stateManager
+            @sagaStorage = sagaStorage
+        end
+
+        def add( name, res )
+            @appResources[name] = res
+        end
+
+        def getAll
+            return @appResources
+        end
+
+        def Begin
+            @currentResources = Hash.new
+            @stateManager.Begin
+            @sagaStorage.Begin
+        end
+
+        def get( name )
+            if @currentResources[name].nil? then
+                r = @appResources[name]
+                r._connect
+                r.Begin
+                RServiceBus.rlog "Preparing resource: #{resourceName}. Begin"
+            end
+            @currentResources[name] = @appResources[name]
+            return @appResources[name]
+        end
+
+        def Commit( msgName )
+            @stateManager.Commit
+            @sagaStorage.Commit
+            RServiceBus.rlog "HandlerManager.commitResourcesUsedToProcessMsg, #{msgName}"
+            @currentResources.each do |k,v|
+                RServiceBus.rlog "Commit resource, #{v.class.name}"
+                v.Commit
+                v.finished
+            end
+            
+        end
+
+        def Rollback( msgName )
+            @sagaStorage.Rollback
+            RServiceBus.rlog "HandlerManager.rollbackResourcesUsedToProcessMsg, #{msgName}"
+            @currentResources.each do |k,v|
+                begin
+                    RServiceBus.rlog "Rollback resource, #{v.class.name}"
+                    v.Rollback
+                    v.finished
+                    rescue Exception => e1
+                    @host.log "Caught nested exception rolling back, #{v.class.name}, for msg, #{msgName}"
+                    @host.log "****"
+                    @host.log e1.message
+                    @host.log e1.backtrace
+                    @host.log "****"
+                end
+            end
+            
+        end
+        
+    end
+end

data/lib/rservicebus/Saga/Base.rb

@@ -0,0 +1,22 @@
+module RServiceBus
+
+
+class Saga_Base
+	attr_accessor :data
+
+    def initialize
+        @finished = false
+    end
+
+	def sendTimeout( msg, milliseconds )
+	end
+
+    def finish
+        @data.finished = true
+    end
+
+end
+
+
+end
+

data/lib/rservicebus/Saga/Data.rb

@@ -0,0 +1,25 @@
+module RServiceBus
+    
+    
+    class Saga_Data
+        attr_reader :correlationId, :sagaClassName
+        attr_accessor :finished
+
+        def initialize( saga )
+            @createdAt = DateTime.now
+            @correlationId = UUIDTools::UUID.random_create
+            @sagaClassName = saga.class.name
+            @finished = false
+            
+            @hash = {}
+        end
+        
+        def method_missing(name, *args, &block)
+            @hash.send(name, *args, &block)
+        end
+        
+    end
+    
+    
+end
+

data/lib/rservicebus/Saga/Manager.rb

@@ -0,0 +1,135 @@
+module RServiceBus
+
+
+class Saga_Manager
+    
+	def initialize( host, resourceManager, sagaStorage )
+		@handler = Hash.new
+		@startWith = Hash.new
+		@saga = Hash.new
+
+		@host = host
+ 
+        @resourceManager = resourceManager
+        @resourceListBySagaName = Hash.new
+        
+        @sagaStorage = sagaStorage
+	end
+
+
+	def GetMethodsByPrefix( saga, prefix )
+        list = []
+        saga.instance_methods.each do |name|
+            list.push name.to_s.sub( prefix, "" ) if name.to_s.slice( 0,prefix.length ) == prefix
+        end
+        
+        return list
+	end
+    
+	def GetStartWithMethodNames( saga )
+		return self.GetMethodsByPrefix( saga, "StartWith_" )
+	end
+    
+    # setBusAttributeIfRequested
+    #
+    # @param [RServiceBus::Saga] saga
+    def setBusAttributeIfRequested( saga )
+        if defined?( saga.Bus ) then
+            saga.Bus = @host
+            RServiceBus.log "Bus attribute set for: " + saga.class.name
+        end
+        
+        return self
+    end
+    
+    def interrogateSagaForAppResources( saga )
+        RServiceBus.rlog "Checking app resources for: #{saga.class.name}"
+        RServiceBus.rlog "If your attribute is not getting set, check that it is in the 'attr_accessor' list"
+        
+        @resourceListBySagaName[saga.class.name] = Array.new
+        @resourceManager.getAll.each do |k,v|
+            if saga.class.method_defined?( k ) then
+                @resourceListBySagaName[saga.class.name] << k
+                RServiceBus.log "Resource attribute, #{k}, found for: " + saga.class.name
+            end
+        end
+
+        return self
+    end
+
+
+	def RegisterSaga( saga )
+        s = saga.new
+        self.setBusAttributeIfRequested( s )
+
+		self.GetStartWithMethodNames( saga ).each do |msgName|
+            @startWith[msgName] = Array.new if @startWith[msgName].nil?
+            @startWith[msgName] << s
+
+            RServiceBus.log "Registered, #{saga.name}, to StartWith, #{msgName}"
+        end
+
+		@saga[saga.name] = s
+	end
+
+    
+    def prepSaga( saga )
+        if !@resourceListBySagaName[saga.class.name].nil? then
+            @resourceListBySagaName[saga.class.name].each do |k,v|
+                saga.instance_variable_set( "@#{k}", resourceManager.get(k).getResource() )
+                RServiceBus.rlog "App resource attribute, #{k}, set for: " + saga.class.name
+            end
+        end
+
+    end
+
+    def Handle( rmsg )
+        @resourcesUsed = Hash.new
+        handled = false
+        msg = rmsg.msg
+
+        RServiceBus.log "SagaManager, started processing, #{msg.class.name}", true
+        if !@startWith[msg.class.name].nil? then
+            @startWith[msg.class.name].each do |saga|
+                data = Saga_Data.new( saga )
+                @sagaStorage.Set( data )
+
+                methodName = "StartWith_#{msg.class.name}"
+                self.ProcessMsg( saga, data, methodName, msg )
+                
+                handled = true
+            end
+        end
+        return handled if handled == true
+
+
+        data = @sagaStorage.Get( rmsg.correlationId )
+        return handled if data.nil?
+        methodName = "Handle_#{msg.class.name}"
+        saga = @saga[data.sagaClassName];
+        self.ProcessMsg( saga, data, methodName, msg );
+
+
+        return true
+    end
+
+    def ProcessMsg( saga, data, methodName, msg )
+        @host.sagaData = data
+        saga.data = data
+
+        if saga.class.method_defined?( methodName ) then
+            saga.send methodName, msg
+        end
+
+        if data.finished == true then
+            @sagaStorage.Delete data.correlationId
+        end
+
+        @host.sagaData = nil
+        #Save Data
+    end
+end
+
+
+end
+

data/lib/rservicebus/SagaLoader.rb

@@ -0,0 +1,130 @@
+module RServiceBus
+
+#Given a directory, this class is responsible loading Sagas
+class SagaLoader
+
+	attr_reader :sagaList
+
+    @listOfLoadedPaths
+
+# Constructor
+#
+# @param [RServiceBus::Host] host instance
+# @param [Hash] appResources As hash[k,v] where k is the name of a resource, and v is the resource
+	def initialize( host, sagaManager )
+        @host = host
+        
+		@sagaManager = sagaManager
+        
+        @listOfLoadedPaths = Hash.new
+	end
+
+# Cleans the given path to ensure it can be used for as a parameter for the require statement.
+#
+# @param [String] filePath the path to be cleaned
+	def getRequirePath( filePath )
+		if !filePath.start_with?( "/" ) then
+			filePath = "./" + filePath
+		end
+		
+		if File.exists?( filePath ) then
+			return filePath.sub( ".rb", "")
+		end		
+
+		abort( "Filepath, " + filePath + ", given for Saga require doesn't exist" );
+	end
+
+# Instantiate the saga named in sagaName from the file name in filePath
+# Exceptions will be raised if encountered when loading sagas. This is a load time activity,
+# so sagas should load correctly. As much information as possible is returned
+# to enable the saga to be fixed, or configuration corrected.
+#
+# @param [String] sagaName name of the saga to instantiate
+# @param [String] filePath the path to the file to be loaded
+# @return [RServiceBus::Saga] the loader
+	def loadSagaFromFile( sagaName, filePath )
+		requirePath = self.getRequirePath( filePath )
+
+		require requirePath
+		begin
+			saga = Object.const_get(sagaName);
+		rescue Exception => e
+			puts "Expected class name: " + sagaName + ", not found after require: " +  requirePath
+			puts "**** Check in " + filePath + " that the class is named : " + sagaName
+			puts "( In case its not that )"
+			raise e
+		end
+
+		return saga
+	end
+	
+# Wrapper function
+#
+# @param [String] filePath
+# @param [String] sagaName
+# @returns [RServiceBus::Saga] saga
+	def loadSaga(filePath, sagaName)
+        if @listOfLoadedPaths.has_key?( filePath ) then
+            RServiceBus.log "Not reloading, #{filePath}"
+            return
+        end
+
+		begin
+			RServiceBus.rlog "filePath: " + filePath
+			RServiceBus.rlog "sagaName: " + sagaName
+
+			saga = self.loadSagaFromFile( sagaName, filePath )
+			RServiceBus.log "Loaded Saga: " + sagaName
+
+            @sagaManager.RegisterSaga( saga )
+
+            @listOfLoadedPaths[filePath] = 1
+		rescue Exception => e
+			puts "Exception loading saga from file: " + filePath
+			puts e.message
+			puts e.backtrace[0]
+
+			abort()
+		end
+
+	end
+
+#This method is overloaded for unit tests
+#
+# @param [String] path directory to check
+# @return [Array] a list of paths to files found in the given path
+	def getListOfFilesForDir( path )
+		return Dir[path + "/*"];
+	end
+
+#Extract the top level dir or file name as it is the msg name
+#
+# @param [String] filePath path to check - this can be a directory or file
+	def getSagaName( filePath )
+		baseName = File.basename( filePath )
+		extName = File.extname( baseName )
+		
+        sagaName = baseName.sub( extName, "" )
+		
+		return sagaName
+	end
+
+
+#Entry point for loading Sagas
+#
+# @param [String] baseDir directory to check - should not have trailing slash
+	def loadSagasFromPath(baseDir)
+		self.getListOfFilesForDir(baseDir).each do |filePath|
+			if !filePath.end_with?( "." ) then
+                
+				sagaName = self.getSagaName( filePath )
+                self.loadSaga( filePath, sagaName )
+			end
+		end
+        
+		return self
+	end
+
+end
+
+end

data/lib/rservicebus/SagaStorage.rb

@@ -0,0 +1,21 @@
+module RServiceBus
+    
+    class SagaStorage
+        
+        def SagaStorage.Get( uri )
+            case uri.scheme
+                when "dir"
+                require "rservicebus/SagaStorage/Dir"
+                return SagaStorage_Dir.new( uri )
+                when "inmem"
+                require "rservicebus/SagaStorage/InMemory"
+                return SagaStorage_InMemory.new( uri )
+                else
+                abort("Scheme, #{uri.scheme}, not recognised when configuring SagaStorage, #{uri.to_s}");
+            end
+            
+        end
+        
+    end
+    
+end