lambda_punch 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7efb456be5902ca1efefb893af810b03b2f6f0590f2eb894c7ed89c8d4a2b277
-  data.tar.gz: 81141dbc0db7a3f26fa9bdd0407d8b582ea8f5868919b7bc914a687ef6d46885
+  metadata.gz: eb70c0a40e9a90e863ea43325168469cfefb1a1c6825a9eced81de68314674c6
+  data.tar.gz: d31d67d900e3021aec70b88ce46fd119f11a1ee5e7b7f14f0c7fcee58a57a053
 SHA512:
-  metadata.gz: 4ae480c414a1be271caf1340c5ccc4b10c57dc1c5dad7fa38dc35009caba6b1c3e63477b271e1a9b751eacccfc38ac72e7dea776c502b9ae19cc3224a611b572
-  data.tar.gz: 92d293001511ad47ba906fe796470fbef185f90c151efb0312574beaace8d80229fabc4b72d73a74219e5d49bcc9076546d308c7ea240d5d04f6032c69c19e4c
+  metadata.gz: d92d93bd3e0dc94f80b73409181ee1702f44d3b4b77161861da63d10852134413de9e137f33e4848b3cbb83a0ca457a2d84de79643461a3fe8ecb42b3f4a95ed
+  data.tar.gz: e374f48513db58003daa361352cdbfa499048e5006b578cf36d97d043a3973dd0f7410e18a668afc2d7f03d683b562a867d69e0ea0ec90c3041491808e2afc4e

data/.gitignore

@@ -1,5 +1,5 @@
 /.bundle/*
-/vendor/bunlde/*
+/vendor/bundle
 /.yardoc
 /_yardoc/
 /coverage/
@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## [1.0.0] - 2021-07-05
+
+### Added
+
+- Rails ActiveJob support.
+
+## [0.0.8] - 2021-06-28
+
+- Guard against early notifier.
+
+## [0.0.7] - 2021-06-28
+
+- Fix queue logger.
+
+## [0.0.6] - 2021-06-28
+
+- Ensure Queue is always callable.
+- Change default log level to `error`.
+
+## [0.0.5] - 2021-06-28
+
+- Ensure Queue is always present.
+
 ## [0.0.4] - 2021-06-28
 
 - Fix install rake bug. Non-Rails rake doc.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lambda_punch (0.0.4)
+    lambda_punch (1.0.0)
       concurrent-ruby
       rake
       rb-inotify
@@ -10,13 +10,142 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4)
+      actionpack (= 6.1.4)
+      activejob (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4)
+      actionpack (= 6.1.4)
+      actionview (= 6.1.4)
+      activejob (= 6.1.4)
+      activesupport (= 6.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4)
+      actionview (= 6.1.4)
+      activesupport (= 6.1.4)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4)
+      actionpack (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4)
+      activesupport (= 6.1.4)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activestorage (6.1.4)
+      actionpack (= 6.1.4)
+      activejob (= 6.1.4)
+      activerecord (= 6.1.4)
+      activesupport (= 6.1.4)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    coderay (1.1.3)
     concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    erubi (1.10.0)
     ffi (1.15.3)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    loofah (2.10.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.1)
+    method_source (1.0.0)
+    mini_mime (1.1.0)
     minitest (5.14.4)
+    minitest-focus (1.3.1)
+      minitest (>= 4, < 6)
+    nio4r (2.5.7)
+    nokogiri (1.11.7-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.11.7-x86_64-linux)
+      racc (~> 1.4)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4)
+      actioncable (= 6.1.4)
+      actionmailbox (= 6.1.4)
+      actionmailer (= 6.1.4)
+      actionpack (= 6.1.4)
+      actiontext (= 6.1.4)
+      actionview (= 6.1.4)
+      activejob (= 6.1.4)
+      activemodel (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
     rake (13.0.3)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
     timeout (0.1.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   x86_64-darwin-19
@@ -25,6 +154,9 @@ PLATFORMS
 DEPENDENCIES
   lambda_punch!
   minitest
+  minitest-focus
+  pry
+  rails
   rake
 
 BUNDLED WITH

data/README.md

@@ -72,7 +72,11 @@ end
 
 ### ActiveJob
 
-🚧 COMING SOON 🚧 - A simple ActiveJob adapter...
+You can use LambdaPunch with Rails' ActiveJob. **For a more robust background job solution, please consider using AWS SQS with the [Lambdakiq](https://github.com/customink/lambdakiq) gem.**
+
+```ruby
+config.active_job.queue_adapter = :lambda_punch
+```
 
 ### Timeouts
 
@@ -80,11 +84,11 @@ Your function's timeout is the max amount to handle the request and process all
 
 If your application integrates with API Gateway (which has a 30 second timeout) then it is possible your function can be set with a higher timeout to perform background work. Since work is done after each invoke, the LambdaPunch queue should be empty when your function receives the `SHUTDOWN` event. If jobs are in the queue when this happens they will have two seconds max to work them down before being lost.
 
-**For a more robust background job solution, please consider using AWS SQS with the [Lambdakiq](https://github.com/customink/lambdakiq) gem. A drop-in replacement for [Sidekiq](https://github.com/mperham/sidekiq) when running Rails in AWS Lambda using the [Lamby](https://lamby.custominktech.com/) gem.**
+**For a more robust background job solution, please consider using AWS SQS with the [Lambdakiq](https://github.com/customink/lambdakiq) gem.**
 
 ### Logging
 
-The default log level is `fatal`, so you will not see any LambdaPunch lines in your logs. However, if you want some low level debugging information on how LambdaPunch is working, you can use this environment variable to change the log level.
+The default log level is `error`, so you will not see any LambdaPunch lines in your logs. However, if you want some low level debugging information on how LambdaPunch is working, you can use this environment variable to change the log level.
 
 ```yaml
 Environment:
@@ -92,6 +96,14 @@ Environment:
     LAMBDA_PUNCH_LOG_LEVEL: debug
 ```
 
+### Errors
+
+As jobs are worked off the queue, all job errors are simply logged. If you want to customize this, you can set your own error handler.
+
+```ruby
+LambdaPunch.error_handler = lambda { |e| ... }
+```
+
 ## 📊 CloudWatch Metrics
 
 When using Extensions, your function's CloudWatch `Duration` metrics will be the sum of your response time combined with your extension's execution time. For example, if your request takes `200ms` to respond but your background task takes `1000ms` your duration will be a combined `1200ms`. For more details see the _"Performance impact and extension overhead"_ section of the [Lambda Extensions API

data/Rakefile

@@ -4,7 +4,7 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList["test/cases/*_test.rb"]
 end
 
 task default: :test

data/lambda_punch.gemspec

@@ -22,4 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rake"
   spec.add_dependency "rb-inotify"
   spec.add_dependency "timeout"
+  spec.add_development_dependency "minitest-focus"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rails"
 end

data/lib/lambda_punch.rb

@@ -13,7 +13,10 @@ require 'lambda_punch/server'
 require 'lambda_punch/worker'
 require 'lambda_punch/version'
 require 'lambda_punch/notifier'
-require 'lambda_punch/railtie' if defined?(Rails)
+if defined?(Rails)
+  require 'lambda_punch/railtie'
+  require 'lambda_punch/rails/active_job'
+end
 
 module LambdaPunch
   
@@ -45,6 +48,16 @@ module LambdaPunch
     Notifier.handled!(context)
   end
 
+  def error_handler
+    @error_handler ||= lambda do |e| 
+      logger.error "Queue#call::error => #{e.message}"
+    end
+  end
+
+  def error_handler=(func)
+    @error_handler = func
+  end
+
   extend self
 
 end

data/lib/lambda_punch/logger.rb

@@ -1,23 +1,23 @@
 module LambdaPunch
   class Logger
 
+    attr_reader :level
+
+    def initialize
+      @level = (ENV['LAMBDA_PUNCH_LOG_LEVEL'] || 'error').upcase.to_sym
+    end
+
     def logger
       @logger ||= ::Logger.new(STDOUT).tap do |l| 
-        l.level = level
+        l.level = logger_level
         l.formatter = proc { |_s, _d, _p, m| "[LambdaPunch] #{m}\n" }
       end
     end
 
-    def level=(value)
-      @level = value.to_s
-      @logger = nil
-    end
-
     private
 
-    def level
-      l = (@level || ENV['LAMBDA_PUNCH_LOG_LEVEL'] || 'fatal').upcase.to_sym
-      ::Logger.const_defined?(l) ? ::Logger.const_get(l) : ::Logger::FATAL
+    def logger_level
+      ::Logger.const_defined?(@level) ? ::Logger.const_get(@level) : ::Logger::ERROR
     end
 
   end

data/lib/lambda_punch/queue.rb

@@ -18,8 +18,7 @@ module LambdaPunch
         begin
           job.call
         rescue => e
-          logger.error "Queue#call::error => #{e.message}"
-          # ...
+          LambdaPunch.error_handler.call(e)
         end
       end
       true
@@ -33,9 +32,5 @@ module LambdaPunch
       self.class.jobs
     end
 
-    def logger
-      LambdaPunch.logger
-    end
-    
   end
 end

data/lib/lambda_punch/rails/active_job.rb

@@ -0,0 +1,16 @@
+module ActiveJob
+  module QueueAdapters
+    class LambdaPunchAdapter
+
+      def enqueue(job, options = {})
+        job_data = job.serialize
+        LambdaPunch.push { ActiveJob::Base.execute(job_data) }
+      end
+
+      def enqueue_at(job, timestamp)
+        enqueue(job)
+      end
+
+    end
+  end
+end

data/lib/lambda_punch/railtie.rb

@@ -1,6 +1,7 @@
 require 'rails'
 require 'rails/engine'
-
+require 'active_job'
+  
 module LambdaPunch
   class Railtie < Rails::Railtie
     railtie_name :lambda_punch

data/lib/lambda_punch/version.rb

@@ -1,3 +1,3 @@
 module LambdaPunch
-  VERSION = "0.0.4"
+  VERSION = "1.0.0"
 end

data/lib/lambda_punch/worker.rb

@@ -16,7 +16,7 @@ module LambdaPunch
         require 'timeout'
         require 'rb-inotify'
         DRb.start_service
-        @queue = DRbObject.new_with_uri(Server.uri)
+        new_drb_queue
       end
 
       # Creates a new instance of this object with the event payload from the `LambdaPunch::Api#invoke` 
@@ -26,6 +26,18 @@ module LambdaPunch
         new(event_payload).call
       end
 
+      # A safe and resilient way to call the remote queue.
+      # 
+      def call_queue
+        queue.call
+      rescue DRb::DRbConnError
+        LambdaPunch.logger.error "Worker#call_queue => DRb::DRbConnError"
+        new_drb_queue
+        queue.call
+      end
+
+      private
+
       # The `@queue` object is the local process' reference to the application `LambdaPunch::Queue`
       # instance which does all the work in the applciation's scope.
       # 
@@ -33,6 +45,10 @@ module LambdaPunch
         @queue
       end
 
+      def new_drb_queue
+        @queue = DRbObject.new_with_uri(Server.uri)
+      end
+
     end
 
     def initialize(event_payload)
@@ -48,22 +64,23 @@ module LambdaPunch
     # also ensures any clean up is done. For example, closing file notifications.
     #
     def call
-      Timeout.timeout(timeout) { @notifier.process }
+      timeout { @notifier.process unless invoked? }
     rescue Timeout::Error
-      logger.debug "Worker#call => Function timeout reached."
+      logger.error "Worker#call => Function timeout reached."
     ensure
       @notifier.close
-      self.class.queue.call
+      self.class.call_queue
     end
 
     private
 
     # The Notifier's watch handler would set this instance variable to `true`. We also return `true`
     # if the extension's invoke palyload event has a `requestId` matching what the handler has written
-    # to the `LambdaPunch::Notifier` file location. See also `request_ids_match?` method.
+    # to the `LambdaPunch::Notifier` file location. See also `request_ids_match?` method. Lastly if 
+    # the timeout 
     #
     def invoked?
-      @invoked || request_ids_match?
+      @invoked || request_ids_match? || timed_out?
     end
 
     # The unique AWS reqeust id that both the extension and handler receive for each invoke. This one
@@ -86,13 +103,29 @@ module LambdaPunch
       request_id_payload == (request_id_notifier || Notifier.request_id)
     end
 
-    # The function's timeout in seconds using the `INVOKE` event payload's `deadlineMs` value.
+    # A safe timeout method which accounts for a 0 or negative timeout value.
     # 
     def timeout
+      @timeout = timeout_seconds
+      if timed_out?
+        yield
+      else
+        Timeout.timeout(@timeout) { yield }
+      end
+    end
+
+    # Helps guard for deadline milliseconds in the past.
+    # 
+    def timed_out?
+      @timeout == 0 || @timeout < 0
+    end
+
+    # The function's timeout in seconds using the `INVOKE` event payload's `deadlineMs` value.
+    # 
+    def timeout_seconds
       deadline_milliseconds = @event_payload['deadlineMs']
       deadline = Time.at(deadline_milliseconds / 1000.0)
-      deadline_timeout = deadline - Time.now
-      deadline_timeout > 0 ? deadline_timeout : 0
+      deadline - Time.now
     end
 
     # Our `LambdaPunch::Notifier` instance callback.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lambda_punch
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Ken Collins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -66,6 +66,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: 'LambdaPunch: Async Processing using Lambda Extensions'
 email:
 - ken@metaskills.net
@@ -99,6 +141,7 @@ files:
 - lib/lambda_punch/logger.rb
 - lib/lambda_punch/notifier.rb
 - lib/lambda_punch/queue.rb
+- lib/lambda_punch/rails/active_job.rb
 - lib/lambda_punch/railtie.rb
 - lib/lambda_punch/server.rb
 - lib/lambda_punch/tasks/install.rake