funktor 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70f99a435a3ace385ee1dc3741517b03994a57fdd87e167299ef9407793cee18
-  data.tar.gz: b510965d08f62dab3891a33921da4d17e9bfcf2d5ee671dffea6ee3b2ef4e0d0
+  metadata.gz: 25d6a36d1e21a09dda03678f7b81742dfec17ceb95c1220254a04690a3933d12
+  data.tar.gz: e43d8a4640ca2bced4c5d6e687a1f3b878016108790afeb7b502c0680e334363
 SHA512:
-  metadata.gz: 5cabd0e3283726d5880fb2d29aeba2277a33fb5daac978843721aac9c6fbf1f94fcc3947755c9d35db42b98291a8c1465cbd03a2fa112dbdca8f44a421b69b0a
-  data.tar.gz: 2265f5459d090e444727338d7e5691dfcffd65c1b777456017b4a1b577ebae65fc52b07956fb78de949ac9c6e6aac4b174fa0e9991dab5427b1b661d859a3c7d
+  metadata.gz: c14ed21535c212873b4bddec9744467f6aa1ca25125aae1c4ea115a88e89ffc0dbc683916507400562c38c3041d15bcda9711265047bbcbc001195256dcf7543
+  data.tar.gz: 213dd13516d536fb9e253e6b2a59bee33771e5e1a90d1702f56de5c16c3aab5384641d0361df221f5c012bd25439e3bec5a26cc865c3321637604ffb0f86dd7a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    funktor (0.3.0)
+    funktor (0.3.1)
       activesupport
       aws-sdk-sqs (~> 1.37)
       thor
@@ -9,6 +9,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activejob (6.1.4)
+      activesupport (= 6.1.4)
+      globalid (>= 0.3.6)
     activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
@@ -18,27 +21,38 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     aws-eventstream (1.1.1)
-    aws-partitions (1.473.0)
-    aws-sdk-core (3.115.0)
+    aws-partitions (1.481.0)
+    aws-sdk-core (3.118.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-sqs (1.40.0)
-      aws-sdk-core (~> 3, >= 3.112.0)
+    aws-sdk-sqs (1.41.0)
+      aws-sdk-core (~> 3, >= 3.118.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.2.3)
+    aws-sigv4 (1.2.4)
       aws-eventstream (~> 1, >= 1.0.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
     concurrent-ruby (1.1.9)
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
     docile (1.3.5)
+    globalid (0.5.1)
+      activesupport (>= 5.0)
     hashdiff (1.0.1)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     jmespath (1.4.0)
+    method_source (1.0.0)
     minitest (5.14.4)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
     public_suffix (4.0.6)
     rake (12.3.3)
     rexml (3.2.5)
@@ -74,7 +88,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activejob (>= 5.1.5)
   funktor!
+  pry-byebug
   rake (~> 12.0)
   rspec (~> 3.0)
   simplecov

data/funktor.gemspec

@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport" # TODO - Can we build our own verison of cattr_accessor to avoid this?
   spec.add_dependency "thor" # Thor drives the CLI
 
+  spec.add_development_dependency 'activejob', '>= 5.1.5'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'pry-byebug'
 end

data/lib/active_job/queue_adapters/funktor_adapter.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'active_job'
+
+module ActiveJob
+  module QueueAdapters
+    # == Funktor adapter for Active Job
+    #
+    # To use Funktor set the queue_adapter config to +:funktor+.
+    #
+    #   Rails.application.config.active_job.queue_adapter = :funktor
+    class FunktorAdapter
+      def enqueue(job) # :nodoc:
+        job.provider_job_id = Funktor.job_pusher.push({
+          "worker"  => JobWrapper.to_s,
+          "wrapped" => job.class,
+          "queue"   => job.class.work_queue,
+          "worker_params"    => [ job.serialize ]
+        })
+      end
+
+      def enqueue_at(job, timestamp) # :nodoc:
+        job.provider_job_id = Funktor.job_pusher.push({
+          "worker"  => JobWrapper.to_s,
+          "wrapped" => job.class,
+          "queue"   => job.class.work_queue,
+          "worker_params"    => [ job.serialize ],
+          "at"      => timestamp
+        })
+      end
+
+      class JobWrapper #:nodoc:
+        include Funktor::Worker
+
+        def perform(job_data)
+          Base.execute job_data.first
+        end
+      end
+    end
+  end
+
+  class Base
+    include Funktor::Worker::FunktorOptions
+  end
+end

data/lib/funktor.rb

@@ -3,6 +3,7 @@ require 'funktor/aws/sqs/event'
 require 'funktor/aws/sqs/record'
 require 'funktor/counter'
 require 'funktor/job'
+require 'funktor/job_pusher'
 require 'funktor/logger'
 require 'funktor/worker'
 require 'funktor/middleware_chain'
@@ -22,6 +23,10 @@ module Funktor
     yield self
   end
 
+  def self.job_pusher
+    @job_pusher ||= JobPusher.new
+  end
+
   def self.job_pusher_middleware
     @job_pusher_chain ||= MiddlewareChain.new
     yield @job_pusher_chain if block_given?
@@ -98,3 +103,5 @@ end
 require 'funktor/middleware/metrics'
 require 'funktor/error_handler'
 require 'funktor/active_job_handler'
+
+require 'funktor/rails' if defined?(::Rails::Engine)

data/lib/funktor/cli/templates/funktor_config/environment.yml

@@ -1,4 +1,5 @@
 BUNDLE_WITHOUT: development:test
+SERVERLESS_STAGE: ${self:custom.stage}
 FUNKTOR_APP_NAME: <%= app_name %>
 FUNKTOR_INCOMING_JOB_QUEUE:
   Ref: IncomingJobQueue

data/lib/funktor/fake_job_queue.rb

@@ -1,7 +1,10 @@
+require "active_support/core_ext/hash/indifferent_access"
+
 module Funktor
   module FakeJobQueue
-    def self.push(worker, payload)
-      jobs[worker.name].push({worker: worker, payload: payload})
+    def self.push(payload)
+      payload = payload.with_indifferent_access
+      jobs[payload["worker"].to_s].push(payload)
     end
 
     def self.jobs

data/lib/funktor/job_pusher.rb

@@ -0,0 +1,31 @@
+require 'aws-sdk-sqs'
+
+module Funktor
+  class JobPusher
+
+    def push(payload)
+      puts "payload ============"
+      pp payload
+      job_id = SecureRandom.uuid
+      payload[:job_id] = job_id
+
+      Funktor.job_pusher_middleware.invoke(payload) do
+        client.send_message({
+          queue_url: queue_url(payload),
+          message_body: Funktor.dump_json(payload)
+        })
+        return job_id
+      end
+    end
+
+    private
+
+    def client
+      @client ||= ::Aws::SQS::Client.new
+    end
+
+    def queue_url(payload)
+      payload[:incoming_job_queue_url] || ENV['FUNKTOR_INCOMING_JOB_QUEUE']
+    end
+  end
+end

data/lib/funktor/rails.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Funktor
+  class Rails < ::Rails::Engine
+    # This hook happens after `Rails::Application` is inherited within
+    # config/application.rb and before config is touched, usually within the
+    # class block. Definitely before config/environments/*.rb and
+    # config/initializers/*.rb.
+    config.before_configuration do
+      if defined?(::ActiveJob)
+        require "sidekiq/worker"
+        require 'active_job/queue_adapters/funktor_adapter'
+      end
+    end
+  end if defined?(::Rails)
+
+  if defined?(::Rails) && ::Rails::VERSION::MAJOR < 5
+    raise "🚫 ERROR: Funktor does not support Rails versions under 5.x"
+  end
+end

data/lib/funktor/testing.rb

@@ -17,9 +17,9 @@ module Funktor
 
       def work_all_jobs
         while jobs.any?
-          job_data = jobs.shift
-          worker = job_data[:worker]
-          worker_params = job_data[:payload][:worker_params]
+          job_data = jobs.shift.with_indifferent_access
+          worker = Object.const_get job_data[:worker]
+          worker_params = job_data[:worker_params]
           worker.new.perform(worker_params)
         end
       end
@@ -56,14 +56,16 @@ module Funktor
   end
 
   class InlineJobPusherMiddleware
-    def call(worker, payload)
-      worker.new.perform(*payload[:worker_params])
+    def call(payload)
+      payload = payload.with_indifferent_access
+      worker = Object.const_get payload["worker"]
+      worker.new.perform(*payload["worker_params"])
     end
   end
 
   class FakeJobPusherMiddleware
-    def call(worker, payload)
-      Funktor::FakeJobQueue.push(worker, payload)
+    def call(payload)
+      Funktor::FakeJobQueue.push(payload)
     end
   end
 end

data/lib/funktor/version.rb

@@ -1,3 +1,3 @@
 module Funktor
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/funktor/worker.rb

@@ -1,6 +1,6 @@
 require 'securerandom'
-require 'aws-sdk-sqs'
 require "active_support"
+require 'funktor/worker/funktor_options'
 
 module Funktor
   class DelayTooLongError < StandardError; end
@@ -9,34 +9,10 @@ end
 module Funktor::Worker
   def self.included(base)
     base.extend ClassMethods
-    base.class_eval do
-      cattr_accessor :funktor_options_hash
-      #alias_method :perform_later, :perform_async
-    end
+    base.include(Funktor::Worker::FunktorOptions)
   end
 
   module ClassMethods
-    def funktor_options(options = {})
-      self.funktor_options_hash = options
-    end
-
-    def get_funktor_options
-      self.funktor_options_hash || {}
-    end
-
-    def custom_queue_url
-      get_funktor_options[:queue_url]
-    end
-
-    def custom_queue
-      get_funktor_options[:queue]
-    end
-
-    def queue_url
-      # TODO : Should this default to FUNKTOR_ACTIVE_JOB_QUEUE?
-      # Depends how e handle this in pro...?
-      custom_queue_url || ENV['FUNKTOR_INCOMING_JOB_QUEUE']
-    end
 
     def perform_async(*worker_params)
       self.perform_in(0, *worker_params)
@@ -54,39 +30,24 @@ module Funktor::Worker
       if delay > max_delay
         raise Funktor::DelayTooLongError.new("The delay can't be longer than #{max_delay} seconds. This is a limitation of SQS. Funktor Pro has mechanisms to work around this limitation.")
       end
-      self.push_to_incoming_job_queue(delay, *worker_params)
+      self.push(delay, *worker_params)
     end
 
-    def push_to_incoming_job_queue(delay, *worker_params)
-      job_id = SecureRandom.uuid
-      payload = build_job_payload(job_id, delay, *worker_params)
-
-      Funktor.job_pusher_middleware.invoke(self, payload) do
-        client.send_message({
-          queue_url: queue_url,
-          message_body: Funktor.dump_json(payload)
-        })
-      end
+    def push(delay, *worker_params)
+      payload = build_job_payload(delay, *worker_params)
+      Funktor.job_pusher.push(payload)
     end
 
     def max_delay
       900
     end
 
-    def client
-      @client ||= Aws::SQS::Client.new
-    end
-
-    def work_queue
-      (self.custom_queue || 'default').to_s
-    end
-
-    def build_job_payload(job_id, delay, *worker_params)
+    def build_job_payload(delay, *worker_params)
       {
         worker: self.name,
         worker_params: worker_params,
         queue: self.work_queue,
-        job_id: job_id,
+        incoming_job_queue_url: self.queue_url,
         delay: delay,
         funktor_options: get_funktor_options
       }

data/lib/funktor/worker/funktor_options.rb

@@ -0,0 +1,37 @@
+module Funktor
+  module Worker
+    module FunktorOptions
+      def self.included(base)
+        base.extend ClassMethods
+        base.class_eval do
+          cattr_accessor :funktor_options_hash
+        end
+      end
+      module ClassMethods
+        def funktor_options(options = {})
+          self.funktor_options_hash = options
+        end
+
+        def get_funktor_options
+          self.funktor_options_hash || {}
+        end
+
+        def custom_queue_url
+          get_funktor_options[:queue_url]
+        end
+
+        def custom_queue
+          get_funktor_options[:queue]
+        end
+
+        def queue_url
+          custom_queue_url
+        end
+
+        def work_queue
+          (self.custom_queue || 'default').to_s
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: funktor
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jeremy Green
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-29 00:00:00.000000000 Z
+date: 2021-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.5
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Background processing in AWS Lambda.
 email:
 - jeremy@octolabs.com
@@ -104,6 +132,7 @@ files:
 - exe/funktor
 - exe/funktor-deploy
 - funktor.gemspec
+- lib/active_job/queue_adapters/funktor_adapter.rb
 - lib/funktor.rb
 - lib/funktor/active_job_handler.rb
 - lib/funktor/aws/sqs/event.rb
@@ -141,12 +170,15 @@ files:
 - lib/funktor/fake_job_queue.rb
 - lib/funktor/incoming_job_handler.rb
 - lib/funktor/job.rb
+- lib/funktor/job_pusher.rb
 - lib/funktor/logger.rb
 - lib/funktor/middleware/metrics.rb
 - lib/funktor/middleware_chain.rb
+- lib/funktor/rails.rb
 - lib/funktor/testing.rb
 - lib/funktor/version.rb
 - lib/funktor/worker.rb
+- lib/funktor/worker/funktor_options.rb
 homepage: https://github.com/Octo-Labs/funktor
 licenses:
 - MIT
@@ -168,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.24
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Background processing in AWS Lambda.