jets 2.2.5 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f191f33dde592fc0b2aaa7b5959d2955c277ac428ebce5041e1e37133555f6be
-  data.tar.gz: 195760363e6602d1d983d361371455b2085987fe10255889b410ea72d7e0a173
+  metadata.gz: 80c5f0edcf627cb62ec53f7db4daac61b8b6f917d455e7c89c232fdb9c3dcfb9
+  data.tar.gz: bba8a0fd1a5d236142183032b4831ccfaaad6f13d54da14a17523ddb594131c5
 SHA512:
-  metadata.gz: e8e191c328450dd8b50fce323579ce9fe1859fcb688188eb26b01e48d67117a62f0bf0b29f50b2782bc1f1805bd151453ac904e81c36d95f2c9e05124e442b38
-  data.tar.gz: 408768c1d40e76ea4a40a6c5cbaf7447c5c5900ce429b91de626b8f8afac2d83ffe36fa79a13252d4c64bfb7979b5ca94f90422872577cfdeb78f0bd0b02d769
+  metadata.gz: 799c0964c8c2dca73780688ca0fd648ce659aa23882918694504151d340d0a499dceb8850b91d5ff007c712dbdce830c5857763bf991d4a7a0075a35e4c0bf48
+  data.tar.gz: 0c3197ba7f2914a12e4fa919dd08d629b56bc3c08d56942a4c372c53373441a632e0223810719f34d90d0a41bae0c8adbf36eb5173d86c0fc2e15df8bfc4f708

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
 
+## [2.3.0]
+- #377 routes mount support
+
 ## [2.2.5]
 - #374 fix rspec execution for projects with no database
 - #375 add jets dotenv:show command

data/backers.md

@@ -13,4 +13,5 @@ Funds donated via Patreon go directly to support Tung Nguyen's full-time work on
 <!--10 start-->
 - Erlend Finvåg
 - Nate Clark
+- Hirokatsu Endo
 <!--10 end-->

data/lib/jets/aws_info.rb

@@ -57,6 +57,8 @@ module Jets
         sts.get_caller_identity.account
       rescue Aws::Errors::MissingCredentialsError, Aws::Errors::NoSuchEndpointError
         puts "INFO: You're missing AWS credentials. Only local services are currently available"
+      rescue Seahorse::Client::NetworkingError
+        puts "INFO: No internet connection available. Only local services are currently available"
       end
     end
     memoize :account

data/lib/jets/aws_services/stack_status.rb

@@ -4,6 +4,7 @@ module Jets::AwsServices
     @@stack_exists_cache = [] # helps with CloudFormation rate limit
     def stack_exists?(stack_name)
       return false if ENV['TEST']
+      return true if ENV['JETS_BUILD_NO_INTERNET']
       return true if @@stack_exists_cache.include?(stack_name)
 
       exist = nil
@@ -60,4 +61,4 @@ module Jets::AwsServices
       out&.output_value
     end
   end
-end
+end

data/lib/jets/commands/build.rb

@@ -131,8 +131,8 @@ module Jets::Commands
       # how project classes are loaded.
       # TODO: rework code so that Dir.pwd does not have to be in tmp_code for build to work.
       #
-      # app_files method is mainly used to determine what templates to build.
-      # app_files method is also used to determine what handlers to build.
+      # app_files used to determine what CloudFormation templates to build.
+      # app_files also used to determine what handlers to build.
       def app_files
         paths = []
         expression = "#{Jets.root}/app/**/**/*.rb"
@@ -224,25 +224,25 @@ module Jets::Commands
       # The copying of other internal files like views is done in builders/code_builder.rb copy_internal_jets_code
       def internal_app_files
         paths = []
-        controllers = File.expand_path("../../internal/app/controllers/jets", __FILE__)
+        internal = File.expand_path("../internal", __dir__)
 
-        public_catchall = Jets::Router.has_controller?("Jets::PublicController")
-        paths << "#{controllers}/public_controller.rb" if public_catchall
-
-        rack_catchall = Jets::Router.has_controller?("Jets::RackController")
-        paths << "#{controllers}/rack_controller.rb" if rack_catchall
-
-        mailer_controller = Jets::Router.has_controller?("Jets::MailersController")
-        paths << "#{controllers}/mailers_controller.rb" if mailer_controller
+        controllers = "#{internal}/app/controllers/jets"
+        paths << "#{controllers}/public_controller.rb" if router_has?("Jets::PublicController")
+        paths << "#{controllers}/rack_controller.rb" if router_has?("Jets::RackController")
+        paths << "#{controllers}/mailers_controller.rb" if router_has?("Jets::MailersController")
+        paths << "#{controllers}/mount_controller.rb" if router_has?("Jets::MountController")
 
         if Jets.config.prewarm.enable
-          jobs = File.expand_path("../../internal/app/jobs/jets", __FILE__)
-          paths << "#{jobs}/preheat_job.rb"
+          paths << "#{internal}/app/jobs/jets/preheat_job.rb"
         end
 
         paths
       end
 
+      def router_has?(controller)
+        Jets::Router.has_controller?(controller)
+      end
+
       def tmp_code(full_build_path=false)
         full_build_path ? "#{Jets.build_root}/stage/code" : "stage/code"
       end

data/lib/jets/commands/stack_info.rb

@@ -11,8 +11,8 @@ module Jets::Commands::StackInfo
 
   def s3_bucket
     return @s3_bucket if @s3_bucket
-
     return nil if first_run?
+    return "fake-bucket" if ENV['JETS_BUILD_NO_INTERNET']
 
     resp = cfn.describe_stacks(stack_name: parent_stack_name)
     output = resp.stacks[0].outputs.find {|o| o.output_key == 'S3Bucket'}

data/lib/jets/controller/base.rb

@@ -31,6 +31,7 @@ class Jets::Controller
       # it doesnt create a lambda function.  It's doesnt matter what scope process!
       # is in Controller::Base because Jets lambda functions inheritance doesnt
       # include methods in Controller::Base.
+      # TODO: Can process! be a protected method to avoid this?
       controller.send(:process!)
     end
 
@@ -49,11 +50,30 @@ class Jets::Controller
         'lambda.event' => event,
         'lambda.meth' => meth,
       )
-      # adapter.process ultimately calls app controller action at the very last
-      # middleware stack.
+
+      # adapter.process calls
+      #
+      #     Jets.application.call(env)
+      #
+      # and that goes through the middleware stacks. The last middleware stack is Jets::Controller::Middleware::Main
+      #
+      #     class Jets::Controller::Middleware::Main
+      #       def call!
+      #         setup
+      #         @controller.dispatch! # Returns triplet
+      #       end
+      #     end
+      #
       adapter.process # Returns API Gateway hash structure
     end
 
+    # One key difference between process! vs dispatch!
+    #
+    #    process! - takes the request through the middleware stack
+    #    dispatch! - does not
+    #
+    # dispatch! is useful for megamode or mounted applications
+    #
     def dispatch!
       t1 = Time.now
       log_info_start

data/lib/jets/controller/middleware/local.rb

@@ -30,9 +30,10 @@ module Jets::Controller::Middleware
         status, headers, body = @controller.dispatch! # jets/rack_controller
         headers.delete "transfer-encoding"
         [status, headers, body]
+      elsif route.to == 'jets/mount#call' # mount route
+        status, headers, body = @controller.dispatch! # jets/mount_controller
+        [status, headers, body]
       elsif polymorphic_function?
-        # Will never hit when calling polymorphic function on AWS Lambda.
-        # This can only really get called with the local server.
         run_polymophic_function
       else # Normal Jets request
         mimic_aws_lambda!(env, mimic.vars) unless on_aws?(env)
@@ -40,7 +41,9 @@ module Jets::Controller::Middleware
       end
     end
 
+    # Never hit when calling polymorphic function on AWS Lambda. Can only get called with the local server.
     def polymorphic_function?
+      return false if ENV['_HANDLER'] # slight speed improvement on Lambda
       polymorphic_function.task.lang != :ruby
     end
 

data/lib/jets/core_ext/kernel.rb

@@ -7,7 +7,7 @@ module Kernel
   def require(path)
     # Hack to prevent Rails const from being defined
     # Actionview requires "rails-html-sanitizer" and that creates a Rails module
-    path = "jets-html-sanitizer" if path == "rails-html-sanitizer"
+    path = "jets-html-sanitizer" if path == "rails-html-sanitizer" && !ENV['JETS_RAILS_CONST']
     jets_original_require(path)
   end
 end

data/lib/jets/dotenv/ssm.rb

@@ -32,6 +32,8 @@ class Jets::Dotenv
     end
 
     def fetch_ssm_value(key, value)
+      return "fake-ssm-value" if ENV['JETS_BUILD_NO_INTERNET']
+
       name = value.start_with?("/") ? value :
         "/#{Jets.config.project_name}/#{Jets.env}/#{value}"
       response = ssm.get_parameter(name: name, with_decryption: true)
@@ -45,4 +47,4 @@ class Jets::Dotenv
       @ssm ||= Aws::SSM::Client.new
     end
   end
-end
+end

data/lib/jets/internal/app/controllers/jets/bare_controller.rb

@@ -0,0 +1,16 @@
+# Parent class for MountController and RackController
+class Jets::BareController < Jets::Controller::Base
+  layout false
+  internal true
+  skip_forgery_protection
+
+private
+  # Override process! so it doesnt go through the complete Jets project middleware stack which could interfer with
+  # the mounted Rack app.
+  def process!
+    status, headers, body = dispatch!
+    # Use the adapter only to convert the Rack triplet to a API Gateway hash structure
+    adapter = Jets::Controller::Rack::Adapter.new(event, context, meth)
+    adapter.convert_to_api_gateway(status, headers, body)
+  end
+end

data/lib/jets/internal/app/controllers/jets/mount_controller.rb

@@ -0,0 +1,56 @@
+# routes mount support
+class Jets::MountController < Jets::BareController
+  def call
+    route = find_route
+    # On Lambda, the route should always be found so this check on lambda is not needed.
+    # But this is useful when we're testing locally with the shim directly.
+    unless route
+      render json: {status: "route not found"}, status: 404
+      return
+    end
+
+    # The reason we look up the route is because it contains mounted class info
+    mount_class = route.mount_class # IE: RackApp
+    env = build_env(route.path)
+
+    status, headers, io = mount_class.call(env)
+    body = read_body(io)
+    render(
+      status: status,
+      headers: headers,
+      body: body,
+    )
+  end
+
+private
+  # Rack response will return an IO object that responds to each. Sometimes this a Rack::BodyProxy
+  # Found this to be the case in Rails and Grape.
+  # Doing an IO#read may not work. So we'll always use the IO#each method
+  def read_body(io)
+    result = []
+    io.each { |body| result << body }
+    result.join
+  end
+
+  # Locally Jets::Router::Finder gets called twice because it also gets called in Jets::Controller::Middleware::Local
+  # On Lambda, Jets::Router::Finder only gets called once.
+  # TODO: Maybe add caching improvement.
+  def find_route
+    Jets::Router::Finder.new(event["path"], "ANY").run
+  end
+
+  def build_env(path)
+    env = Jets::Controller::Rack::Env.new(event, context, adapter: true).convert
+    # remap path info
+    mount_at = mount_at(path)
+    path_info = env["PATH_INFO"]
+    env["PATH_INFO"] = path_info.sub(mount_at,'')
+    env["ORIGINAL_PATH_INFO"] = path_info
+    env
+  end
+
+  # Removes the wildcard: rack/*path => rack
+  def mount_at(path)
+    path.gsub(/\*.*/,'')
+  end
+end

data/lib/jets/internal/app/controllers/jets/rack_controller.rb

@@ -1,8 +1,4 @@
-class Jets::RackController < Jets::Controller::Base
-  layout false
-  internal true
-  skip_forgery_protection
-
+class Jets::RackController < Jets::BareController
   # Megamode
   def process
     resp = mega_request
@@ -10,16 +6,6 @@ class Jets::RackController < Jets::Controller::Base
   end
 
 private
-  # Override process! so it doesnt go through middleware adapter and hits
-  # process logic directly. This handles the case for AWS Lambda.
-  # For local server, we adjust the Middleware::Local logic.
-  def process!
-    status, headers, body = dispatch!
-    # Use the adapter only to convert the Rack triplet to a API Gateway hash structure
-    adapter = Jets::Controller::Rack::Adapter.new(event, context, meth)
-    adapter.convert_to_api_gateway(status, headers, body)
-  end
-
   def mega_request
     Jets::Mega::Request.new(event, self).proxy
   end

data/lib/jets/overrides/rails/action_controller.rb

@@ -1,6 +1,7 @@
 ActiveSupport.on_load :action_controller do
   class ActionController::Base
     class << self
+      @@_prefixes = nil
       def _prefixes
         @@_prefixes
       end

data/lib/jets/resource/api_gateway/rest_api/logical_id.rb

@@ -4,6 +4,7 @@ class Jets::Resource::ApiGateway::RestApi
     include Jets::AwsServices
 
     def get
+      return default if ENV['JETS_BUILD_NO_INTERNET']
       return default unless stack_exists?(parent_stack_name) && api_gateway_exists?
 
       if changed?

data/lib/jets/router/dsl.rb

@@ -1,5 +1,7 @@
 class Jets::Router
   module Dsl
+    include Mount
+
     # Methods supported by API Gateway
     %w[any delete get head options patch post put].each do |method_name|
       define_method method_name do |path, options={}|

data/lib/jets/router/dsl/mount.rb

@@ -0,0 +1,12 @@
+module Jets::Router::Dsl
+  module Mount
+    # The mounted class must be a Rack compatiable class
+    def mount(klass, at:)
+      options = {to: "jets/mount#call", mount_class: klass}
+      at_wildcard = at.blank? ? "*path" : "#{at}/*path"
+
+      any at, options
+      any at_wildcard, options
+    end
+  end
+end

data/lib/jets/router/route.rb

@@ -30,7 +30,9 @@ class Jets::Router
       prefix = account_scope(prefix)
       prefix = account_on(prefix)
 
-      [prefix, @options[:path]].compact.join('/')
+      path = [prefix, @options[:path]].compact.join('/')
+      path = path[1..-1] if path.starts_with?('/') # be more forgiving if / accidentally included
+      path
     end
 
     def account_scope(prefix)
@@ -185,6 +187,10 @@ class Jets::Router
       end.to_h
     end
 
+    def mount_class
+      @options[:mount_class]
+    end
+
   private
     def ensure_jets_format(path)
       path.split('/').map do |s|

data/lib/jets/version.rb

@@ -1,3 +1,3 @@
 module Jets
-  VERSION = "2.2.5"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jets
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 2.3.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2019-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -802,7 +802,9 @@ files:
 - lib/jets/generator/templates/rails/scaffold_controller/api_controller.rb
 - lib/jets/generator/templates/rails/scaffold_controller/controller.rb
 - lib/jets/inflections.rb
+- lib/jets/internal/app/controllers/jets/bare_controller.rb
 - lib/jets/internal/app/controllers/jets/mailers_controller.rb
+- lib/jets/internal/app/controllers/jets/mount_controller.rb
 - lib/jets/internal/app/controllers/jets/public_controller.rb
 - lib/jets/internal/app/controllers/jets/rack_controller.rb
 - lib/jets/internal/app/functions/jets/base_path.rb
@@ -925,6 +927,7 @@ files:
 - lib/jets/resource/standardizer.rb
 - lib/jets/router.rb
 - lib/jets/router/dsl.rb
+- lib/jets/router/dsl/mount.rb
 - lib/jets/router/error.rb
 - lib/jets/router/finder.rb
 - lib/jets/router/helpers.rb