hutch-schedule 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90c31b8f2f324f07f2e2bc3c8dcd071ce129e2bf
-  data.tar.gz: 784b5b1690b8beccbbf76a4cec009c8539f4b15b
+  metadata.gz: fb70893978620f96f7701d003b06812d0b1de18c
+  data.tar.gz: 739355b288a4be2a3e54cc116a3193ec7edddff1
 SHA512:
-  metadata.gz: 8feccd2adb36ca1864132c5be689162a88ab5a1072d758c4661183f29e103336be13d4001167b6dfbc2002db87eccdd2d3d2d6b8ee6fb86ee5038086b3cb4439
-  data.tar.gz: 03bc493d5ebed1b273e34cc59ab758a91e8fd5a6d88ef9b9b7689e6162442c4f140d9825f114d5dcd9aabebd84123d13f7e701b4488e05a35a7a523c2e84783f
+  metadata.gz: dda680d37cf8846741fa624db5e0b3d656f2dc3e7a2f1d14a347b04185f648bf81dfaf7e57b37df6a22507815c547a837efb1fabaf5e31600d7deb03652844f0
+  data.tar.gz: 32afd0caa0ff7b1510c4158344b1e164576eb4971e4778b5f3568410dd7d04fdc1bfaad6822229ca43883e5ee59c11a4b6140dcd800abe27e3701dfa471fee67

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-为了能够初始化这个项目, 需要在合适的地方设置 Hutch 的 setup_proc 用于初始化 Hutch::Schedule
+Use the code below to initialize the Hutch::Schedule
 
 ```ruby
 Hutch::Config.setup_procs  << -> {
@@ -28,11 +28,12 @@ Hutch::Config.setup_procs  << -> {
 }
 ```
 
-提供了如下的功能支持:
-1. 在 RabbitMQ 中自动创建了一个 <hutch>.schedule 的 topic exchange 用于专门转发需要延迟的 Message
-2. 在 RabbitMQ 中自动创建了一个 <hutch>_schedule_queue 的 queue 带有:
-   - dlx 到 <hutch> 的 topic exchange
-   - 以及避免任务一直挤压的 30 天的 ttl
+They will do something below:
+
+1. Declear an topic exchange called `<hutch>.schedule` just for routing message to schedule_queue.
+2. Declear an queue named `<hutch>_schedule_queue` and with some params:
+  - Set `x-dead-letter-exchange: <hutch>`: let queue republish message to default <hutch> exchange.
+  - Set `x-message-ttl: <30.days>`: to avoid the queue is to large, because there is no consumer with this queue.
 
 ## Development
 

data/lib/active_job/queue_adapters/hutch_adapter.rb

@@ -4,54 +4,59 @@ module ActiveJob
   module QueueAdapters
     # == Hutch adapter for Active Job
     #
-    # 简单高效的消息服务方案, Hutch 以多线程的方式处理 RabbitMQ 中的不同 Queue 的 Message.
-    #
     # Read more about Hutch {here}[https://github.com/gocardless/hutch].
     #
     #   Rails.application.config.active_job.queue_adapter = :hutch
     class HutchAdapter
-      # 需要将 activejob 使用的队列全部 routing 到一个 rabbitmq 的 queue 中
+      # All activejob Message will routing to one RabbitMQ Queue.
+      # Because Hutch will one Consumer per Queue
       AJ_ROUTING_KEY = "active_job"
 
       def initialize
         @monitor = Monitor.new
       end
 
-      # 不适用 Consumer 的 enqueue, 无需每次重复计算
       def enqueue(job) #:nodoc:
         @monitor.synchronize do
-          # 将整个 job 的 data 变为 hash 发布出去
-          Hutch.publish(routing_key(job), job.serialize)
+          # publish all job data to hutch
+          Hutch.publish(HutchAdapter.routing_key(job), job.serialize)
         end
       end
 
       def enqueue_at(job, timestamp) #:nodoc:
         interval = [(timestamp - Time.now.utc.to_i), 1.second].max
-        enqueue_in(interval, job.serialize, routing_key(job))
+        enqueue_in(interval, job.serialize, HutchAdapter.routing_key(job))
       end
 
-      # 不适用 Consumer 的 enqueue, 无需每次重复计算
       def enqueue_in(interval, message, routing_key)
         @monitor.synchronize do
-          # 必须是 integer
+          # must be integer
           props = { expiration: interval.in_milliseconds.to_i }
           Hutch::Schedule.publish(routing_key, message, props)
         end
       end
 
-      # 计算 routing_key
-      def routing_key(job)
+      # Get an routing_key
+      def self.routing_key(job)
         "#{AJ_ROUTING_KEY}.#{job.queue_name}"
       end
 
-      class JobWrapper #:nodoc:
-        include Hutch::Consumer
-        # 给 ActiveJob 使用的一个大队列
-        consume "#{HutchAdapter::AJ_ROUTING_KEY}.#"
+      # Register all ActiveJob Class to Hutch. (per queue per consumer)
+      def self.register_actice_job_classes
+        Dir.glob(Rails.root.join('app/jobs/**/*.rb')).each { |x| require_dependency x }
+        ActiveJob::Base.descendants.each do |job|
+          Hutch.consumers << Class.new do
+            extend Hutch::Consumer::ClassMethods
+
+            attr_accessor :broker, :delivery_info
+
+            queue_name job.queue_name
+            consume HutchAdapter.routing_key(job)
 
-        def process(job_data)
-          # 执行 ActiveJob 的 Base, 将整个 job 的 data 传过去, 让其进行反序列化, 组织成参数等等
-          Base.execute job_data
+            define_method :process do |job_data|
+              ActiveJob::Base.execute(job_data)
+            end
+          end
         end
       end
     end

data/lib/hutch/enqueue.rb

@@ -3,33 +3,34 @@ require 'active_support/core_ext/numeric/time'
 require 'hutch/schedule'
 
 module Hutch
-  # 如果需要增加让 Consumer Enqueue 的动作, 那么则 include 这个 Module
+  # If consumer need `enqueue`, just include this module
   module Enqueue
     extend ActiveSupport::Concern
 
     # Add Consumer methods
     class_methods do
-      # 正常的发布 consumer 对应 routing key 的消息
+      # Publish the message to this consumer with one routing_key
       def enqueue(message)
         Hutch.publish(enqueue_routing_key, message)
       end
 
       # publish message at a delay times
-      # interval: 推迟的时间
-      # message: 具体的消息
+      # interval: delay interval
+      # message: publish message
       def enqueue_in(interval, message)
         props = { expiration: interval.in_milliseconds.to_i }
         Hutch::Schedule.publish(enqueue_routing_key, message, props)
       end
 
-      # 延期在某一个时间点执行
+      # delay at exatly time point
       def enqueue_at(time, message)
-        # 如果 time 比当前时间还早, 那么就延迟 1s 钟执行
+        # if time is early then now then just delay 1 second
         interval = [(time.utc - Time.now.utc), 1.second].max
         enqueue_in(interval, message)
       end
 
-      # routing_key: 目的为将 Message 发送给 RabbitMQ 那么使用其监听的任何一个 routing_key 都可以发送
+      # routing_key: the purpose is to send message to hutch exchange and then routing to the correct queue,
+      # so can use any of them routing_key that the consumer is consuming.
       def enqueue_routing_key
         raise "Routing Keys is not set!" if routing_keys.size < 1
         routing_keys.to_a.last

data/lib/hutch/error_handlers/max_retry.rb

@@ -0,0 +1,44 @@
+require 'hutch/logging'
+
+module Hutch
+  module ErrorHandlers
+    class MaxRetry
+      include Logging
+
+      # TODO: Need to be implement.
+      # 1. 获取 hutch 本身记录的 x-death 中的错误次数
+      # 2. 从每一个 consumer 身上寻找 max_retry 的次数, 不超过则进行延迟重试
+      # 3. 根据错误次数计算类似 active_job 的 exponentially_longer 延迟时间
+      #
+      # properties.headers example:
+      # {
+      #   "x-death": [
+      #     {
+      #       "count": 7,
+      #       "exchange": "hutch.topic",
+      #       "queue": "retry_queue",
+      #       "reason": "expired",
+      #       "routing-keys": [
+      #         "plan"
+      #       ],
+      #       "time": "2017-05-13 23:37:15 +0800"
+      #     },
+      #     {
+      #       "count": 7,
+      #       "exchange": "hutch",
+      #       "original-expiration": "3000",
+      #       "queue": "plan_consumer",
+      #       "reason": "rejected",
+      #       "routing-keys": [
+      #         "plan"
+      #       ],
+      #       "time": "2017-05-13 23:37:05 +0800"
+      #     }
+      #   ]
+      # }
+      def handle(properties, payload, consumer, ex)
+        raise "Not implement"
+      end
+    end
+  end
+end

data/lib/hutch/schedule/core.rb

@@ -3,7 +3,6 @@ require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/numeric'
 require 'active_support/core_ext/module/delegation'
 
-# 共享 Hutch::Broker 实例的所有东西
 module Hutch
   module Schedule
     class Core
@@ -12,18 +11,17 @@ module Hutch
 
       delegate :channel, :connection, :logger, to: :broker
 
-      # 初始化 schedule
       def initialize(broker)
         raise "Broker can`t be nil" if broker.blank?
         @broker = broker
       end
 
-      # 获取 Hutch 上的 Config
+      # Use the config with Hutch::Broker instance
       def config
         broker.instance_variable_get(:@config)
       end
 
-      # Core 的连接, 注意连接是有顺序的, 必须先将 exchange 初始化好
+      # Becareful with the sequence of initialize
       def connect!
         declare_exchange!
         declare_publisher!
@@ -34,17 +32,15 @@ module Hutch
         @publisher = Hutch::Publisher.new(connection, channel, exchange, config)
       end
 
-      # 申明 schedule 使用的 ex
+      # The exchange used by Hutch::Schedule
       def declare_exchange!
         @exchange = declare_exchange
       end
 
       def declare_exchange(ch = channel)
         exchange_name    = "#{config[:mq_exchange]}.schedule"
-        # TODO: 检查 mq_exchange_options 中的信息, 确保不会覆盖 x-dead-letter-exchange 的参数
-        exchange_options = {
-          durable:                  true,
-          'x-dead-letter-exchange': config[:mq_exchange] }.merge(config[:mq_exchange_options])
+        # TODO: Check mq_exchange_options info, ensure they won`t override x-dead-letter-exchange params
+        exchange_options = { durable: true }.merge(config[:mq_exchange_options])
         logger.info "using topic exchange(schedule) '#{exchange_name}'"
 
         broker.send(:with_bunny_precondition_handler, 'schedule exchange') do
@@ -52,18 +48,19 @@ module Hutch
         end
       end
 
-      # 申明 schedule 使用的 queue
+      # The queue used by Hutch::Schedule
       def setup_queue!
+        # TODO: extract the ttl to config params
         props = { 'x-message-ttl': 30.days.in_milliseconds, 'x-dead-letter-exchange': config[:mq_exchange] }
         queue = broker.queue("#{config[:mq_exchange]}_schedule_queue", props)
 
-        # TODO: 可以考虑将这个抽取成为参数
+        # TODO: consider extract this routing_key params to config params
         # routing all to this queue
         queue.unbind(exchange, routing_key: '#')
         queue.bind(exchange, routing_key: '#')
       end
 
-      # Schedule broker 自己的 publish 方法
+      # Schedule`s publisher, publish the message to schedule topic exchange
       def publish(*args)
         @publisher.publish(*args)
       end

data/lib/hutch/schedule/version.rb

@@ -1,5 +1,5 @@
 module Hutch
   module Schedule
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/hutch/schedule.rb

@@ -4,20 +4,22 @@ require 'hutch'
 require 'hutch/enqueue'
 require 'hutch/schedule/core'
 
-# 引入了 active_job 则引入 adapter
+# If ActiveJob is requried then required the adapter
 if defined?(ActiveJob)
   require 'active_job/queue_adapters/hutch_adapter'
 end
 
-# gem 的核心入口文件
 module Hutch
-  # 在 Hutch 下的独立的 Schedule module, 负责与 schedule 相关的 publish
+  # Hutch::Schedule, just an addon to deal with the schedule exchange.
+  # If you want use it, just do `Hutch::Schedule.connect(Hutch.broker)` to initialize it
+  # and then just use like Hutch to publish message `Hutch::Schedule.publish`
   module Schedule
 
-    def self.connect(broker)
+    def self.connect(broker = Hutch.broker)
       return if core.present?
       @core = Hutch::Schedule::Core.new(broker)
       @core.connect!
+      ActiveJob::QueueAdapters::HutchAdapter.register_actice_job_classes if defined?(ActiveJob::QueueAdapters::HutchAdapter)
     end
 
     def self.core

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hutch-schedule
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - wyatt pan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-15 00:00:00.000000000 Z
+date: 2017-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hutch
@@ -114,6 +114,7 @@ files:
 - lib/active_job/queue_adapters/hutch_adapter.rb
 - lib/hutch-schedule.rb
 - lib/hutch/enqueue.rb
+- lib/hutch/error_handlers/max_retry.rb
 - lib/hutch/schedule.rb
 - lib/hutch/schedule/core.rb
 - lib/hutch/schedule/version.rb