jets-rails 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c47cd2b1a0fa72eec799b7d25df47ddde8df183ae3f82b81ba653c65eb5139a2
-  data.tar.gz: c168d9ac40131cfe97861a04f1a3e3ca49723ba3ff9e12418413f4792447e340
+  metadata.gz: 536f98adce430371ad8e7a31424b866b3ae44f99f45094485304ad8186e47979
+  data.tar.gz: 3c843ab9189c8f85608fc7de03c94b9881055d852bc9404cbdfe85339f0455bd
 SHA512:
-  metadata.gz: 428d0b35d8c1199542a4c2e21992b84d5c30fa0e58b9f4d1ef75b77a93bec9797414cbeccda274b43c583858e51c9c8977504618a8d8a83ca249d3d1790aa327
-  data.tar.gz: 0a288e9b1e889f3ecd51b3005c9c06dd3680849d1d6e5b58b8d75da7286ce782fa16a14e6c23da4b04b96bb6bba2e4c76f844c41f36f3a03e359c7447c178d32
+  metadata.gz: 71aa7434ee9332a6a823875e1572569b2f0399a3110aa3a556e9c07e6bc6f3baab144845f47ecd5d850728e434c2e5fdb2830066a07462b730ede955d23eecef
+  data.tar.gz: b16d8e88d3832a7e1bb492bc270b8c93a1a33511e9bfaa3f5067c328f622aabb3d48e8a0e3ea48956e944e7983fbf9b9cc8efefea93d3cd291ca8803e0fc816e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
+
+## [1.0.0] - 2024-05-20
+
+* jets 6 plugin: activejob jets_job adapter, engine
+* activejob support jets_job adapter
+* autoloader app/extensions and shared/extensions autoload paths
+* before_configuration jets boot
+* remove 0.3 code full rewrite
+
+## [0.3.0] - 2018-10-28
+
+- allow for rails 4
+
+## [0.1.0] - 2018-10-27
+
+- Initial release

data/{MIT-LICENSE → LICENSE.txt}

@@ -1,4 +1,6 @@
-Copyright 2018 Tung Nguyen
+Copyright (c) Tung Nguyen
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,16 +1,13 @@
-# Jets Rails for Mega Mode
+# Jets Rails Support
 
-This gem works in conjuction with Jets to allow you to run a Rails application on AWS Lambda. This gem is not meant to be used standalone.  Instead, jets automatically adds this gem to a Rails application as part of [Mega Mode Rails Support](http://rubyonjets.com/docs/rails-support/).
+[![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
 
-## Usage
-
-This gem is not meant to be used standalone. You can enable it though by adding to your Rails Gemfile and setting the `JETS_MEGA=1` env var.
+A [Jets Plugin](https://docs.rubyonjets.com/docs/plugins/) for Rails and [Jets](http://rubyonjets.com/).
 
-## More Info
+## Usage
 
-For more information about Jets and Rails Support refer to:
+Add gem to your Gemfile, bundle, and deploy
 
-* [Ruby on Jets](http://rubyonjets.com)
-* [AWS Lambda Ruby Support at Native Speed with Jets](https://blog.boltops.com/2018/09/02/aws-lambda-ruby-support-at-native-speed-with-jets)
-* [Jets Rails Support](http://rubyonjets.com/docs/rails-support/)
-* [Toronto Serverless Presentation: Jets Framework on AWS Lambda](https://blog.boltops.com/2018/09/25/toronto-serverless-presentation-jets-framework-on-aws-lambda)
+    bundle add "jets-rails"
+    jets init
+    jets deploy

data/Rakefile

@@ -1,27 +1,8 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
+# frozen_string_literal: true
 
-require 'rdoc/task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'JetsRails'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+RSpec::Core::RakeTask.new(:spec)
 
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-task default: :test
+task default: :spec

data/lib/active_job/queue_adapters/jets_job_adapter.rb

@@ -0,0 +1,13 @@
+require "active_job"
+
+module ActiveJob::QueueAdapters
+  class JetsJobAdapter
+    def enqueue(job)
+      Jets::Rails::Job::Queue.new(job).enqueue
+    end
+
+    def enqueue_at(job, timestamp)
+      Jets::Rails::Job::Queue.new(job, timestamp).enqueue
+    end
+  end
+end

data/lib/jets/rails/autoloader.rb

@@ -0,0 +1,25 @@
+require "zeitwerk"
+
+module Jets
+  module Rails
+    class Autoloader
+      class Inflector < Zeitwerk::Inflector
+        def camelize(basename, _abspath)
+          map = {cli: "CLI", version: "VERSION"}
+          map[basename.to_sym] || super
+        end
+      end
+
+      class << self
+        def setup
+          loader = Zeitwerk::Loader.new
+          loader.inflector = Inflector.new
+          lib = File.expand_path("../..", __dir__) # lib
+          loader.push_dir(lib)
+          loader.ignore("#{lib}/jets-rails.rb")
+          loader.setup
+        end
+      end
+    end
+  end
+end

data/lib/jets/rails/engine.rb

@@ -0,0 +1,28 @@
+require "rails/engine"
+
+module Jets::Rails
+  class Engine < Rails::Engine
+    # Need to use before_configuration for dotenv
+    # so env values can be used in config/initializers
+    config.before_configuration do
+      Jets.boot # sets up autoloader
+    end
+
+    # Let Jets handle these autoload paths
+    #
+    # Jets.project.config.all_load_paths example:
+    #
+    #     app/events
+    #     app/extensions
+    #     shared/resources
+    #     shared/extensions
+    #     app/functions
+    #     shared/functions
+    #
+    config.before_initialize do
+      Jets.project.config.all_load_paths.each do |path|
+        Rails.autoloaders.main.ignore(Rails.root.join(path))
+      end
+    end
+  end
+end

data/lib/jets/rails/job/executer.rb

@@ -0,0 +1,15 @@
+require "active_job"
+
+module Jets::Rails::Job
+  class Executer
+    extend Memoist
+
+    def initialize(job_data)
+      @job_data = job_data
+    end
+
+    def execute
+      ActiveJob::Base.execute(@job_data)
+    end
+  end
+end

data/lib/jets/rails/job/queue/check.rb

@@ -0,0 +1,32 @@
+class Jets::Rails::Job::Queue
+  class Check
+    class Error < StandardError; end
+
+    class << self
+      include Jets::Util::Logging
+
+      @@error_message = "ERROR: Unable to get queue url".color(:red)
+      def exist!
+        job_enable!
+        existance!
+      end
+
+      def existance!
+        return if Url.queue_url
+
+        log.error @@error_message
+        raise Error, "Are you sure you have deployed with Jets.project.config.job.enable = true ?"
+      rescue Jets::Api::Error::NotFound
+        log.error @@error_message
+        raise Error, "It does not look like the stack has successfully deployed. Please deploy first."
+      end
+
+      def job_enable!
+        return if Url.queue_url
+
+        log.error @@error_message
+        raise Error, "Are you sure that config.job.enable = true ?"
+      end
+    end
+  end
+end

data/lib/jets/rails/job/queue/url.rb

@@ -0,0 +1,18 @@
+class Jets::Rails::Job::Queue
+  class Url
+    class << self
+      extend Memoist
+
+      def queue_url
+        # JETS_JOB_QUEUE_URL must be set when on AWS Lambda
+        # to avoid the API call to retrieve the queue_url
+        return ENV["JETS_JOB_QUEUE_URL"] if ENV["JETS_JOB_QUEUE_URL"]
+        # 1. can be nil
+        # 2. can raise NotFound error
+        resp = Jets::Api::Release.retrieve("latest")
+        resp.queue_url
+      end
+      memoize :queue_url
+    end
+  end
+end

data/lib/jets/rails/job/queue.rb

@@ -0,0 +1,78 @@
+require "aws-sdk-sqs"
+
+module Jets::Rails::Job
+  class Queue
+    class Error < StandardError; end
+
+    extend Memoist
+    include Jets::Util::Logging
+    delegate :queue_url, to: Url
+
+    attr_reader :job, :timestamp
+    def initialize(job, timestamp = nil)
+      @job = job
+      @timestamp = timestamp
+    end
+
+    def enqueue
+      Check.exist!
+
+      params = {
+        queue_url: queue_url,
+        message_body: JSON.dump(job.serialize)
+      }
+      if fifo?
+        params.merge!(fifo_params)
+      else
+        params.merge!(standard_params)
+      end
+      log.info "Enqueueing job to #{queue_url}"
+      log.debug "  with params: #{params.inspect}"
+      sqs.send_message(params)
+    end
+
+    def fifo?
+      queue_url.include?(".fifo")
+    end
+
+    def fifo_params
+      options = {}
+      options[:message_deduplication_id] = message_deduplication_id
+
+      message_group_id = @job.message_group_id if @job.respond_to?(:message_group_id)
+      message_group_id ||= "jets"
+
+      options[:message_group_id] = message_group_id
+      options
+    end
+
+    # Note that `job_id` is NOT included in deduplication keys because it is unique for
+    # each initialization of the job, and the run-once behavior must be guaranteed for ActiveJob retries.
+    # Even without setting job_id, it is implicitly excluded from deduplication keys.
+    def message_deduplication_id
+      ex_dedup_keys = @job.excluded_deduplication_keys if @job.respond_to?(:excluded_deduplication_keys)
+      ex_dedup_keys ||= []
+      ex_dedup_keys += ["job_id"]
+      body = @job.serialize
+      deduplication_body = body.except(*ex_dedup_keys)
+      Digest::SHA256.hexdigest(JSON.dump(deduplication_body))
+    end
+
+    def standard_params
+      @timestamp ? {delay_seconds: delay_seconds} : {}
+    end
+
+    def delay_seconds
+      delay = (@timestamp - Time.now.to_f).floor
+      delay = 0 if delay.negative?
+      raise ArgumentError, "Unable to queue a job with a delay greater than 15 minutes" if delay > 15.minutes
+
+      delay
+    end
+
+    def sqs
+      Aws::SQS::Client.new
+    end
+    memoize :sqs
+  end
+end

data/lib/jets/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jets
+  module Rails
+    VERSION = "1.0.0"
+  end
+end

data/lib/jets/rails.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+$:.unshift(File.expand_path("..", __dir__))
+require "active_job/queue_adapters/jets_job_adapter"
+
+require "jets/rails/autoloader"
+Jets::Rails::Autoloader.setup
+
+require "memoist"
+require "rainbow/ext/string"
+
+module Jets
+  module Rails
+    class Error < StandardError; end
+  end
+end
+
+require "jets/rails/engine" if defined?(Rails::Railtie)

data/lib/jets-rails.rb

@@ -1 +1 @@
-require_relative "jets_rails"
+require_relative "jets/rails"

metadata

@@ -1,67 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: jets-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-28 00:00:00.000000000 Z
+date: 2024-05-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sqs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '5'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Reconfigures the Rails application and injects the necessary changes
-  to run the rack application on AWS Lambda. Meant to be used in conjunction with
-  Jets. Not meant to be used standalone.
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
 email:
 - tongueroo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
 - README.md
 - Rakefile
+- lib/active_job/queue_adapters/jets_job_adapter.rb
 - lib/jets-rails.rb
-- lib/jets_rails.rb
-- lib/jets_rails/core_ext/kernel.rb
-- lib/jets_rails/logger.rb
-- lib/jets_rails/railtie.rb
-- lib/jets_rails/stage_middleware.rb
-- lib/jets_rails/version.rb
-- lib/tasks/jets_rails_tasks.rake
-homepage: https://github.com/tongueroo/jets-rails
-licenses:
-- MIT
-metadata: {}
+- lib/jets/rails.rb
+- lib/jets/rails/autoloader.rb
+- lib/jets/rails/engine.rb
+- lib/jets/rails/job/executer.rb
+- lib/jets/rails/job/queue.rb
+- lib/jets/rails/job/queue/check.rb
+- lib/jets/rails/job/queue/url.rb
+- lib/jets/rails/version.rb
+homepage: https://github.com/rubyonjets/jets-rails
+licenses: []
+metadata:
+  homepage_uri: https://github.com/rubyonjets/jets-rails
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -70,16 +142,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
-summary: Jets Mega Mode Rails Support
+summary: Jets Rails Support
 test_files: []

data/lib/jets_rails/core_ext/kernel.rb

@@ -1,35 +0,0 @@
-# With this implementation we write to disk immedaitely. This simplifies the
-# implementation because we do not have to flush to io buffer by passing signals
-# back and forth from the jets ruby server process to the rack server process.
-module Kernel
-  # List from https://ruby-doc.org/core-2.5.1/Kernel.html
-  # Note, will lose pp format in the @io_buffer but looks like a lot of work to keep the pp format.
-  # Must override stdout which can be messy quick: https://www.ruby-forum.com/topic/43725
-  OVERRIDE_METHODS = %w[
-    p
-    pp
-    print
-    printf
-    putc
-    puts
-  ]
-  # NOTE adding sprintf produces #<%s: %s:%s/%s> with puma? So not including sprintf
-  OVERRIDE_METHODS.each do |meth|
-    # Example of generated code:
-    #
-    #   alias_method :original_puts, :puts
-    #   def puts(*args, &block)
-    #     original_puts(*args, &block)
-    #   end
-    #
-    class_eval <<~CODE
-      alias_method :original_#{meth}, :#{meth}
-      def #{meth}(*args, &block)
-        # Write immediately for debugging
-        message = "Rails: " + args.first.to_s + "\n"
-        IO.write("/tmp/jets-output.log", message, mode: 'a')
-        original_#{meth}(*args, &block)
-      end
-    CODE
-  end
-end

data/lib/jets_rails/logger.rb

@@ -1,14 +0,0 @@
-require 'active_support'
-
-# Tap into rails logging to show logs in CloudWatch eventually.
-#
-# Overriding Rails SimpleFormatter directly is pretty simple approach.
-# The definition is short.
-class ActiveSupport::Logger::SimpleFormatter
-  # This method is invoked when a log event occurs
-  def call(severity, timestamp, progname, msg)
-    result = "#{String === msg ? msg : msg.inspect}\n"
-    IO.write("/tmp/jets-output.log", "Rails: #{result}", mode: 'a')
-    result
-  end
-end

data/lib/jets_rails/railtie.rb

@@ -1,7 +0,0 @@
-module JetsRails
-  class Railtie < ::Rails::Railtie
-    initializer "jets_rails.configure_middleware" do
-      Rails.application.middleware.insert_before(Rack::Sendfile, StageMiddleware)
-    end
-  end
-end

data/lib/jets_rails/stage_middleware.rb

@@ -1,26 +0,0 @@
-module JetsRails
-  class StageMiddleware
-    def initialize(app)
-      @app = app
-    end
-
-    def call(env)
-      add_stage_name(env) if on_aws?(env)
-      status, headers, body = @app.call(env)
-      [status, headers, body]
-    end
-
-  private
-    # Add API Gateway Stage Name
-    def add_stage_name(env)
-      # changes links that Rails generates
-      env[Rack::SCRIPT_NAME] = "/#{JetsRails.stage}"
-    end
-
-    def on_aws?(env)
-      return true if ENV['JETS_ON_AWS'] # for local testing
-      host = env['HTTP_X_FORWARDED_HOST'] # from Jets::Rack::Request#set_headers!
-      host&.include?("amazonaws.com")
-    end
-  end
-end

data/lib/jets_rails/version.rb

@@ -1,3 +0,0 @@
-module JetsRails
-  VERSION = '0.2.0'
-end

data/lib/jets_rails.rb

@@ -1,24 +0,0 @@
-# JETS_MEGA is set in the bin/rackup wrapper
-# We do this check so we can include jets-rails in the Gemfile and allow users
-# to check to see if the bundle install will work though this is not activated
-# logically without JETS_MEGA set.
-return unless ENV['JETS_MEGA']
-
-# = Configuration
-#
-# Configure with Rails initializer. Example:
-#
-# config/initializer/jets.rb:
-#
-#   JetsRails.stage = ENV['JETS_STAGE'] || 'dev'
-#
-module JetsRails
-  cattr_accessor :stage
-  self.stage = "dev" # default. should be set to in Rails initializer
-
-  autoload :StageMiddleware, 'jets_rails/stage_middleware'
-end
-
-require "jets_rails/core_ext/kernel"
-require "jets_rails/logger" # eager load rails override
-require "jets_rails/railtie"

data/lib/tasks/jets_rails_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :jets_rails do
-#   # Task goes here
-# end