lambda_punch 0.0.8 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cec6cd5684a1a7ff22f75898d909f3189337f981d965c71d06cc53f447f2dda1
-  data.tar.gz: 9825e8239cea26f6b2affe8b5387a1e12f377fa0ffb6a3371bbc6a7bcc5f3910
+  metadata.gz: 806b9121fb13c00ae8a5e38e39a48cb2f8609aad192f5f3bc32b857032cfd0fa
+  data.tar.gz: 8426e0efa1a7c5f44d79445ea025054f8346f4264983878fc608f91efbcca387
 SHA512:
-  metadata.gz: ac0557df20c73e7ff75b082a14d63e8f96e57dc1bbd288a4670e11fb1f4d402688fa17a01f9215fee5db5798b371b73d9f6fe9dfe692b5c4e8bb6c59d9577240
-  data.tar.gz: cea1aa8e78d416966a7d876e1035f12026e3b442cad4f95dd0935d145b012eef766a7c1a1a11332680fde1bf87af3e89023dae657130f487e00c849e2cf610f6
+  metadata.gz: 0ec52eb4a0f53d3958080a34ed8b5d07e0f0f93e326d1e6e78dad7167ba8c87b5c60074e49d3a7219903d764ff9569b4f94ff3948f5e546e74a380b338025d94
+  data.tar.gz: a8c0b72ccc54367fd683996a0b24d586632e934be647b1f000f8c2bb83e31aac6c14f6c31b539356ae94eb14a55aa06fe9d1698d40a1123336b927fe3e40b164

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,25 @@
+## [1.0.3] - 2021-10-27
+
+### Added
+
+-
+
+### Changed
+
+- Remove timeout version lock.
+
+## [1.0.2] - 2021-07-24
+
+### Changed
+
+- Lazy initialization of Notifier's temp file.
+
+## [1.0.0] - 2021-07-05
+
+### Added
+
+- Rails ActiveJob support.
+
 ## [0.0.8] - 2021-06-28
 
 - Guard against early notifier.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lambda_punch (0.0.8)
+    lambda_punch (1.0.3)
       concurrent-ruby
       rake
       rb-inotify
@@ -10,22 +10,151 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      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.1)
+      actionpack (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activestorage (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.1)
+      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)
-    ffi (1.15.3)
+    crass (1.0.6)
+    erubi (1.10.0)
+    ffi (1.15.4)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    loofah (2.12.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
     minitest (5.14.4)
-    rake (13.0.3)
+    minitest-focus (1.3.1)
+      minitest (>= 4, < 6)
+    nio4r (2.5.8)
+    nokogiri (1.12.5-x86_64-linux)
+      racc (~> 1.4)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4.1)
+      actioncable (= 6.1.4.1)
+      actionmailbox (= 6.1.4.1)
+      actionmailer (= 6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actiontext (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rake (13.0.6)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    timeout (0.1.1)
+    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.2.0)
+    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.5.1)
 
 PLATFORMS
-  x86_64-darwin-19
   x86_64-linux
 
 DEPENDENCIES
   lambda_punch!
   minitest
+  minitest-focus
+  pry
+  rails
   rake
 
 BUNDLED WITH
-   2.2.21
+   2.2.30

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,7 +84,7 @@ 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
 
@@ -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/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'] || 'error').upcase.to_sym
-      ::Logger.const_defined?(l) ? ::Logger.const_get(l) : ::Logger::ERROR
+    def logger_level
+      ::Logger.const_defined?(@level) ? ::Logger.const_get(@level) : ::Logger::ERROR
     end
 
   end

data/lib/lambda_punch/notifier.rb

@@ -2,7 +2,6 @@ module LambdaPunch
   class Notifier
 
     FILE = "#{Dir.tmpdir}/lambdapunch-handled"
-    File.open(FILE, 'w') { |f| f.write('') }
 
     class << self
 
@@ -16,10 +15,15 @@ module LambdaPunch
         File.read(FILE)
       end
 
+      def tmp_file
+        FILE
+      end
+
     end
 
     def initialize
       @notifier = INotify::Notifier.new
+      File.open(FILE, 'w') { |f| f.write('') } unless File.exist?(FILE)
     end
 
     def watch

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/tasks/install.rake

@@ -1,3 +1,5 @@
+require 'rake'
+
 namespace :lambda_punch do
 
   desc "Install the LambdaPunch Lambda Extension."

data/lib/lambda_punch/version.rb

@@ -1,3 +1,3 @@
 module LambdaPunch
-  VERSION = "0.0.8"
+  VERSION = "1.0.3"
 end

data/lib/lambda_punch/worker.rb

@@ -64,7 +64,7 @@ module LambdaPunch
     # also ensures any clean up is done. For example, closing file notifications.
     #
     def call
-      Timeout.timeout(timeout) { @notifier.process unless invoked? }
+      timeout { @notifier.process unless invoked? }
     rescue Timeout::Error
       logger.error "Worker#call => Function timeout reached."
     ensure
@@ -76,10 +76,11 @@ module LambdaPunch
 
     # 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
@@ -102,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.

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,20 @@ 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
+
+  def tmp_file
+    Notifier.tmp_file
+  end
+
   extend self
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lambda_punch
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 1.0.3
 platform: ruby
 authors:
 - Ken Collins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2021-10-28 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