async-job 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44a092dcad8310e5301d4c273e08c21a5eb046b530ff27cce0320fd56ccd3f8f
-  data.tar.gz: 11c40eb020b847b46a933d8ff2b1f27bb015edf781e4d4ca3a4579269140a8cb
+  metadata.gz: 1e330cf8c0430796e25264e8c892f70423f1fa0ffbc645a19198774f51ef4893
+  data.tar.gz: 3c1ac69a6bde193876717c65dace5e97803b66ab9471d5baeffc33bb1762701a
 SHA512:
-  metadata.gz: 69d052fe00161a40300410b95aea22dde2a4b6eb41bc320d915e72327324bad175b0c1ca1dd4953287e069cbc6755d222fe2de5346acda3b34ff5f9818b9606a
-  data.tar.gz: 8087a4c82be53394574b1ab70affcdf3c5355a1db0c24f022ea012c771cc290d9a04d173e49cd10edd6b54d8a8aba1f0b78bc392124f9d401e6940452013d45f
+  metadata.gz: 956e76aadce5f21fd099ba72d38914f4a4a6981a1d4382eee34a7bc37a0d79cb7bedb6b93000146a752fdc829945a93c72ef873fc3012acda5f6ea50d58128ae
+  data.tar.gz: 8fb1c37bc2f065c08a08dbdc25f04dbfe2aab5d67eb57c297a50fb5665e9840014fe1c3bd7257fc2dfa463919507fdf450dcaa71d1c17dc5cde0441b949c108b

data/lib/async/job/backend/inline/server.rb

@@ -3,25 +3,26 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
+require_relative '../../coder'
+
 module Async
 	module Job
 		module Backend
 			module Inline
 				class Server
-					def initialize(handler)
-						@handler = handler
-					end
-					
-					def enqueue(job)
-						Async do
-							@handler.call(job)
-						end
+					def initialize(delegate)
+						@delegate = delegate
 					end
 					
-					def schedule(job, timestamp)
+					def call(job)
+						scheduled_at = Coder::Time(job["scheduled_at"])
+						
 						Async do
-							sleep(timestamp - Time.now)
-							@handler.call(job)
+							if scheduled_at
+								sleep(scheduled_at - Time.now)
+							end
+							
+							@delegate.call(job)
 						end
 					end
 				end

data/lib/async/job/backend/inline.rb

@@ -9,8 +9,8 @@ module Async
 	module Job
 		module Backend
 			module Inline
-				def self.new(handler)
-					return Server.new(handler)
+				def self.new(delegate)
+					return Server.new(delegate)
 				end
 			end
 		end

data/lib/async/job/backend/redis/server.rb

@@ -9,18 +9,21 @@ require_relative 'processing_queue'
 require_relative 'ready_queue'
 
 require 'securerandom'
+require_relative '../../coder'
 
 module Async
 	module Job
 		module Backend
 			module Redis
 				class Server
-					def initialize(handler, client, prefix)
-						@handler = handler
+					def initialize(delegate, client, prefix: 'async-job', coder: Coder::DEFAULT, resolution: 10)
+						@delegate = delegate
 						
 						@id = SecureRandom.uuid
 						@client = client
 						@prefix = prefix
+						@coder = coder
+						@resolution = resolution
 						
 						@job_store = JobStore.new(@client, "#{@prefix}:jobs")
 						
@@ -33,7 +36,7 @@ module Async
 					def start
 						Console.info(self, "Starting server...")
 						# Start the delayed queue, which will move jobs to the ready queue when they are ready:
-						@delayed_queue.start(@ready_queue)
+						@delayed_queue.start(@ready_queue, resolution: @resolution)
 						
 						# Start the processing queue, which will move jobs to the ready queue when they are abandoned:
 						@processing_queue.start
@@ -43,12 +46,14 @@ module Async
 						end
 					end
 					
-					def enqueue(job)
-						@ready_queue.add(job, @job_store)
-					end
-					
-					def schedule(job, timestamp)
-						@delayed_queue.add(job, timestamp, @job_store)
+					def call(job)
+						scheduled_at = Coder::Time(job["scheduled_at"])
+						
+						if scheduled_at
+							@delayed_queue.add(@coder.dump(job), scheduled_at, @job_store)
+						else
+							@ready_queue.add(@coder.dump(job), @job_store)
+						end
 					end
 					
 					protected
@@ -56,8 +61,8 @@ module Async
 					def dequeue
 						id = @processing_queue.fetch
 						begin
-							job = @job_store.get(id)
-							@handler.call(job)
+							job = @coder.load(@job_store.get(id))
+							@delegate.call(job)
 							@processing_queue.complete(id)
 						rescue => error
 							@processing_queue.retry(id)

data/lib/async/job/backend/redis.rb

@@ -10,9 +10,9 @@ module Async
 	module Job
 		module Backend
 			module Redis
-				def self.new(handler, endpoint: Async::Redis.local_endpoint, prefix: "async:job")
+				def self.new(delegate, endpoint: Async::Redis.local_endpoint, **options)
 					client = Async::Redis::Client.new(endpoint)
-					return Server.new(handler, client, prefix)
+					return Server.new(delegate, client, **options)
 				end
 			end
 		end

data/lib/async/job/buffer.rb

@@ -1,16 +1,23 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
 require 'async/queue'
 
 module Async
 	module Job
 		class Buffer
-			def initialize
+			def initialize(delegate = nil)
 				@jobs = Async::Queue.new
+				@delegate = delegate
 			end
 			
 			attr :jobs
 			
 			def call(job)
 				@jobs.enqueue(job)
+				@delegate&.call(job)
 			end
 			
 			def pop

data/lib/async/job/builder.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+module Async
+	module Job
+		class Builder
+			Pipeline = Struct.new(:producer, :consumer, :delegate)
+			
+			def self.build(delegate = nil, &block)
+				builder = self.new(delegate)
+				
+				builder.instance_eval(&block)
+				
+				return builder.build
+			end
+			
+			def initialize(delegate = nil)
+				@enqueue = []
+				@dequeue = []
+				@delegate = delegate
+				
+				@queue = nil
+			end
+			
+			def enqueue(middleware)
+				@enqueue << middleware
+			end
+			
+			def queue(queue, *arguments, **options)
+				# The delegate is the output side of the queue, e.g. a Queuedelegate or similar wrapper.
+				# The queue itself is instantiated with the delegate.
+				@queue = ->(delegate){queue.new(delegate, *arguments, **options)}
+			end
+			
+			def dequeue(middleware)
+				@dequeue << middleware
+			end
+			
+			def delegate(delegate)
+				@delegate = delegate
+			end
+			
+			def build(&block)
+				# To construct the queue, we need the delegate.
+				delegate = @delegate
+				
+				# We then wrap the delegate with the middleware in reverse order:
+				@dequeue.reverse_each do |middleware|
+					delegate = middleware.new(delegate)
+				end
+				
+				# We can now construct the queue with the delegate:
+				producer = consumer = @queue.call(delegate)
+				
+				# We now construct the queue producer:
+				@enqueue.reverse_each do |middleware|
+					producer = middleware.new(queue)
+				end
+				
+				if block_given?
+					producer = yield(producer)
+				end
+				
+				return Pipeline.new(producer, consumer, @delegate)
+			end
+		end
+	end
+end

data/lib/async/job/coder/json.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require 'json'
+
+module Async
+	module Job
+		module Coder
+			class JSON
+				def initialize
+				end
+				
+				def dump(job)
+					::JSON.dump(job)
+				end
+				
+				def load(data)
+					::JSON.parse(data, symbolize_names: true)
+				end
+				
+				DEFAULT = self.new
+			end
+		end
+	end
+end

data/lib/async/job/coder/marshal.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require 'msgpack'
+
+module Async
+	module Job
+		module Coder
+			class Marshal
+				def dump(job)
+					::Marshal.dump(job)
+				end
+				
+				def load(data)
+					::Marshal.load(data)
+				end
+				
+				DEFAULT = self.new
+			end
+		end
+	end
+end

data/lib/async/job/coder/message_pack.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require 'msgpack'
+
+module Async
+	module Job
+		module Coder
+			class MessagePack
+				def initialize
+					@factory = ::MessagePack::Factory.new
+					
+					@factory.register_type(0x01, Symbol)
+					
+					@factory.register_type(0x02, Time,
+						packer: ::MessagePack::Time::Packer,
+						unpacker: ::MessagePack::Time::Unpacker
+					)
+				end
+				
+				def dump(job)
+					@factory.pack(job)
+				end
+				
+				def load(data)
+					@factory.unpack(data)
+				end
+				
+				DEFAULT = self.new
+			end
+		end
+	end
+end

data/lib/async/job/coder.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require_relative 'coder/json'
+
+module Async
+	module Job
+		module Coder
+			DEFAULT = JSON::DEFAULT
+			
+			# Type-cast for time values. See <https://bugs.ruby-lang.org/issues/20298> for background.
+			# @parameter value [Time || Integer || String || nil]
+			def self.Time(value)
+				case value
+				when ::Time
+					value
+				when Integer
+					::Time.at(value)
+				when String
+					::Time.new(value)
+				when nil
+					nil
+				else
+					value.to_time
+				end
+			end
+		end
+	end
+end

data/lib/async/job/generic.rb

@@ -10,13 +10,13 @@ module Async
 				self.new(...).enqueue
 			end
 			
-			def initialize(id, perform_at: nil)
+			def initialize(id, scheduled_at: nil)
 				@id = id
-				@perform_at = perform_at
+				@scheduled_at = scheduled_at
 			end
 			
 			attr :id
-			attr :perform_at
+			attr :scheduled_at
 			
 			def serialize
 				raise NotImplementedError

data/lib/async/job/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module Job
-		VERSION = "0.3.0"
+		VERSION = "0.4.0"
 	end
 end

data/lib/async/job.rb

@@ -5,3 +5,4 @@
 
 require_relative 'job/version'
 require_relative 'job/backend'
+require_relative 'job/builder'

data/readme.md

@@ -6,7 +6,11 @@ Provides an asynchronous job server.
 
 ## Usage
 
-The current implementation is incomplete, but with `redis` running on localhost, you can run several instances of `client.rb` and `server.rb` to show the general operation.
+Please see the [project documentation](https://socketry.github.io/async-job/) for more details.
+
+  - [Getting Started](https://socketry.github.io/async-job/guides/getting-started/index) - This guide gives you an overview of the `async-job` gem and explains the core concepts.
+
+  - [Redis Backend](https://socketry.github.io/async-job/guides/redis-backend/index) - This guide gives a brief overview of the implementation of the Redis backend.
 
 ## Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-job
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2024-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -84,6 +84,11 @@ files:
 - lib/async/job/backend/redis/ready_queue.rb
 - lib/async/job/backend/redis/server.rb
 - lib/async/job/buffer.rb
+- lib/async/job/builder.rb
+- lib/async/job/coder.rb
+- lib/async/job/coder/json.rb
+- lib/async/job/coder/marshal.rb
+- lib/async/job/coder/message_pack.rb
 - lib/async/job/generic.rb
 - lib/async/job/version.rb
 - license.md
@@ -92,7 +97,7 @@ homepage:
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://socketry.github.io/async-job
+  documentation_uri: https://socketry.github.io/async-job/
 post_install_message:
 rdoc_options: []
 require_paths: