jets 4.0.10 → 5.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8612274c29e1e3f75b05e46d4d6e47571abc9b3dbd76322486a2cb6626c0f5a
-  data.tar.gz: 9282f2d3543c0b9a02718e8078a276797104f1798d65d8a6617d08210c08361e
+  metadata.gz: 4381b93c9ea3d4e8a1f44bbe065e85fc0c6da59cc1d59ef7cc3deb29411b107f
+  data.tar.gz: 6afa841f9b10dcf4526179ddfe5dd9d211ce38d9117f2442b092bb1f8d2bc424
 SHA512:
-  metadata.gz: dd5f0ef934488eadaa573f00f693687eb352d18d46bffd927b5d3afaebc5010fcf0d04ef6622bc38af05501aa7d9eea4dccbdca8bc6d2ba64f25bb8ec88cc818
-  data.tar.gz: b661cc6ec392586322e2cf0f0cec81d186b9522545e9fb63f9335035411e8bb7937431da73614f44c963ddbb7d7582c4a5978226f5eaf9d7398d52b686ba5271
+  metadata.gz: 64cc06c217190f64c0e5e446bd6aad780048c5673f64f6611bc3871ecfc295083440be55d98d222d5955d19285ba3252cb371043f679d48e74b6a676541ce3df
+  data.tar.gz: 8be226ddfa30be1b57dca669eff636b9e07a0ab8bc63e77901a1f398e2c9ab7cbc7a9f6589a6e98135f4abffc5492777e0cda9543d5c598fda1d77dbcfb0658a

data/.gitignore

@@ -7,6 +7,7 @@
 _yardoc
 coverage
 doc/
+docs/
 InstalledFiles
 lib/bundler/man
 pkg
@@ -15,10 +16,13 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+node_modules
 
 .codebuild/definitions
 /html
 /demo
 Gemfile.lock
-spec/fixtures/apps/franky/dynamodb/migrate
+spec/fixtures/demo/dynamodb/migrate
+spec/fixtures/demo/public/assets
 spec/fixtures/project/handlers
+yarn.lock

data/CHANGELOG.md

@@ -3,13 +3,62 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
 
-## [4.0.10] - 2023-12-04
-- [#678](https://github.com/boltops-tools/jets/pull/678) handle option method or http_method from route state
+## [5.0.0] - Unreleased
+Single Lambda Function for Controllers
+* For controllers, a single Lambda function is deployed going forward.
+* APIGW serves as proxy endpoint for requests to the single Lambda function. Techniquely, there are 2 APIGW endpoints.
+* Jobs and other classes still create a discrete lambda function per Ruby method.
+
+Jets Engines support
+* Jets Engines closely resemble Rails engines.
+* Use as many Rails middlewares as possible
+
+Jets Controllers are "ActionController and ActionView compatible."
+* View Scope has first-class citizens access to Jets Controller instances.
+* Breaking Change: `resources :posts` and `delete` route method routes to controller `destroy` method like rails instead of `delete` method.
+
+Jets Controllers now support:
+* around filters
+* cache control and etag caching support
+* content security policy
+* cookies support via actionpack
+* flash support
+* forgery protection improvements
+* importmap support
+* i18n support
+
+New Jets CLI structure that
+* Close to Rails CLI structure
+
+Jets Pro support
+* deploys, release history, rollback support
+* use jets-api gem
+
+Refactor CloudFormation Builders
+* Use CamelCase properties internally
+* Short name template filenames and class names without the _builder.
+* Fully qualify LambdaFunction logical id.
+
+Misc
+* Remove afterburner turbo and mega mode to prepare for container-based Rails support.
+* Autoloaders refactor. gem (Jets internal), main (user app), once (user app)
+* CORS via with middleware only.
+* Improve ActionMailer integration. Improve preview support.
+* logger active support logger and tagged logging support
+* dynamodb event conventional table namespace
+* enable iot rule by default bug fix
+* create named route methods for all CRUD actions
+* Jets.cache support
+
+Breaking changes:
+* Pass request.headers straight without downcase. IE: `X-Amzn-Trace-Id`. Introduce request.downcase_headers instead.
+* Jets.config.prewarm.concurrency option removed.
+* dynomite decoupling and integration improvements
+
 
 ## [4.0.9] - 2023-12-03
 - [#674](https://github.com/boltops-tools/jets/pull/674) Fix broken --mode jobs new project generation
 - [#675](https://github.com/boltops-tools/jets/pull/675) Add resource tags to CloudFormation stack
-
 ## [4.0.8] - 2023-12-03
 - [#677](https://github.com/boltops-tools/jets/pull/677) pin dynomite 1.2.7
 
@@ -28,6 +77,7 @@ This project *loosely tries* to adhere to [Semantic Versioning](http://semver.or
 
 ## [4.0.3] - 2023-08-03
 - [#657](https://github.com/boltops-tools/jets/pull/657) [Fix] ApiGateway for local Middleware: fix query_string_parameters
+Breaking Changes:
 
 ## [4.0.2] - 2023-08-03
 - [#660](https://github.com/boltops-tools/jets/pull/660) Fix prewarming

data/Gemfile

@@ -4,11 +4,7 @@ source "https://rubygems.org"
 gemspec
 
 # required here for specs
-# TODO: Only require webpacker in Gemfile of project if possible.
-# Need both because of jets/application.rb and jets/webpacker/middleware_setup.rb
 group :development, :test do
   gem "mysql2", "~> 0.5.2"
-  gem "dynomite"
-  gem "jetpacker"
-  gem "rspec_junit_formatter"
+  gem "dynomite", "~> 2.0.0"
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2021 Tung Nguyen
+Copyright (c) Tung Nguyen
 
 MIT License
 

data/Rakefile

@@ -8,10 +8,11 @@ task :default => :spec
 RSpec::Core::RakeTask.new
 
 require_relative "lib/jets"
+
 desc "Generates cli reference docs as markdown"
 task :docs do
-  Jets::Autoloaders.once.eager_load
-  Jets::Commands::Markdown::Creator.create_all
+  require "cli_markdown_jets"
+  CliMarkdown::Creator.new.create_all
 end
 
 # Thanks: https://docs.ruby-lang.org/en/2.1.0/RDoc/Task.html
@@ -21,4 +22,3 @@ require 'jets/rdoc'
 RDoc::Task.new do |rdoc|
   rdoc.options += Jets::Rdoc.options
 end
-

data/engines/internal/app/controllers/jets/application_controller.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Jets::ApplicationController < Jets::Controller::Base # :nodoc:
+  prepend_view_path File.expand_path("../../../app/views", __dir__)
+  layout "application"
+
+  before_action :disable_content_security_policy_nonce!
+
+  content_security_policy do |policy|
+    policy.script_src :self, :unsafe_inline
+    policy.style_src :self, :unsafe_inline
+  end
+
+  private
+    def require_local!
+      unless local_request?
+        render html: "<p>For security purposes, this information is only available to local requests.</p>".html_safe, status: :forbidden
+      end
+    end
+
+    def local_request?
+      Jets.application.config.consider_all_requests_local || request.local?
+    end
+
+    def disable_content_security_policy_nonce!
+      request.content_security_policy_nonce_generator = nil
+    end
+end

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

@@ -0,0 +1,6 @@
+# Parent class for MountController
+class Jets::BareController < Jets::Controller::Base
+  layout false
+  abstract!
+  skip_forgery_protection
+end

data/engines/internal/app/controllers/jets/health_controller.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Jets
+  # Built-in Health Check Endpoint
+  #
+  # \Jets also comes with a built-in health check endpoint that is reachable at
+  # the +/up+ path. This endpoint will return a 200 status code if the app has
+  # booted with no exceptions, and a 500 status code otherwise.
+  #
+  # In production, many applications are required to report their status upstream,
+  # whether it's to an uptime monitor that will page an engineer when things go
+  # wrong, or a load balancer or Kubernetes controller used to determine a pod's
+  # health. This health check is designed to be a one-size fits all that will work
+  # in many situations.
+  #
+  # While any newly generated \Jets applications will have the health check at
+  # +/up+, you can configure the path to be anything you'd like in your
+  # <tt>"config/routes.rb"</tt>:
+  #
+  #   Jets.application.routes.draw do
+  #     get "healthz" => "jets/health#show", as: :jets_health_check
+  #   end
+  #
+  # The health check will now be accessible via the +/healthz+ path.
+  #
+  # NOTE: This endpoint does not reflect the status of all of your application's
+  # dependencies, such as the database or redis cluster. Replace
+  # <tt>"jets/health#show"</tt> with your own controller action if you have
+  # application specific needs.
+  #
+  # Think carefully about what you want to check as it can lead to situations
+  # where your application is being restarted due to a third-party service going
+  # bad. Ideally, you should design your application to handle those outages
+  # gracefully.
+  class HealthController < Jets::Controller::Base
+    rescue_from(Exception) { render_down }
+
+    def show
+      render_up
+    end
+
+    private
+      def render_up
+        render html: html_status(color: "green")
+      end
+
+      def render_down
+        render html: html_status(color: "red"), status: 500
+      end
+
+      def html_status(color:)
+        %(<!DOCTYPE html><html><body style="background-color: #{color}"></body></html>).html_safe
+      end
+  end
+end

data/engines/internal/app/controllers/jets/info_controller.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class Jets::InfoController < Jets::ApplicationController # :nodoc:
+  prepend_view_path ActionDispatch::DebugView::RESCUES_TEMPLATE_PATH
+  layout -> { request.xhr? ? false : "application" }
+
+  before_action :require_local!
+
+  def index
+    redirect_to action: :routes
+  end
+
+  def properties
+    @info = Jets::Info.to_html
+    @page_title = "Properties"
+  end
+
+  def routes
+    if path = params[:path]
+      path = URI::DEFAULT_PARSER.escape path
+      normalized_path = with_leading_slash path
+      render json: {
+        exact: match_route { |it| it.match normalized_path },
+        fuzzy: match_route { |it| it.spec.to_s.match path }
+      }
+    else
+      @routes_table = routes_table
+      @page_title = "Routes"
+    end
+  end
+
+  private
+    def routes_table
+      text = Jets::Router::Help.new(format: "markdown").text
+      Kramdown::Document.new(text).to_html
+    end
+
+    def match_route
+      _routes.routes.filter_map { |route| route.path.spec.to_s if yield route.path }
+    end
+
+    def with_leading_slash(path)
+      ("/" + path).squeeze("/")
+    end
+end

data/{lib/jets → engines}/internal/app/controllers/jets/mailers_controller.rb

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
 
 class Jets::MailersController < Jets::Controller::Base # :nodoc:
+  around_action :set_locale, only: :preview
   before_action :find_preview, only: [:preview]
-  before_action :set_locale, only: [:preview]
-  # TODO: allow multiple actions
-  # before_action :find_preview, :set_locale, only: :preview
+  before_action :require_local!, unless: :show_previews?
 
-  # TODO: add helper_method support
-  # helper_method :part_query, :locale_query
+  helper_method :part_query, :locale_query
 
-  # TODO: content_security_policy
-  # content_security_policy(false)
+  content_security_policy(false)
 
   def index
     @previews = ActionMailer::Preview.all
@@ -20,25 +17,26 @@ class Jets::MailersController < Jets::Controller::Base # :nodoc:
   def preview
     if params[:path] == @preview.preview_name
       @page_title = "Mailer Previews for #{@preview.preview_name}"
-      render :mailer
+      render action: "mailer"
     else
       @email_action = File.basename(params[:path])
 
       if @preview.email_exists?(@email_action)
+        @page_title = "Mailer Preview for #{@preview.preview_name}##{@email_action}"
         @email = @preview.call(@email_action, params)
 
         if params[:part]
           part_type = Mime::Type.lookup(params[:part])
 
           if part = find_part(part_type)
-            response.headers["Content-Type"] = params[:part]
+            response.content_type = part_type
             render plain: part.respond_to?(:decoded) ? part.decoded : part
           else
             raise AbstractController::ActionNotFound, "Email part '#{part_type}' not found in #{@preview.name}##{@email_action}"
           end
         else
-          @part = find_preferred_part(Mime[:html], Mime[:text])
-          render :email, layout: false, formats: %w[html]
+          @part = find_preferred_part(request.format, Mime[:html], Mime[:text])
+          render action: "email", layout: false, formats: [:html]
         end
       else
         raise AbstractController::ActionNotFound, "Email '#{@email_action}' not found in #{@preview.name}"
@@ -53,7 +51,7 @@ class Jets::MailersController < Jets::Controller::Base # :nodoc:
 
     def find_preview # :doc:
       candidates = []
-      params[:path].to_s.scan(%r{/|$}) { candidates << $` } # ` # hack to fix syntax highlighting
+      params[:path].to_s.scan(%r{/|$}) { candidates << $` }
       preview = candidates.detect { |candidate| ActionMailer::Preview.exists?(candidate) }
 
       if preview
@@ -91,7 +89,7 @@ class Jets::MailersController < Jets::Controller::Base # :nodoc:
       request.query_parameters.merge(locale: locale).to_query
     end
 
-    def set_locale
-      I18n.locale = params[:locale] || I18n.default_locale
+    def set_locale(&block)
+      I18n.with_locale(params[:locale] || I18n.default_locale, &block)
     end
 end

data/{lib/jets → engines}/internal/app/controllers/jets/mount_controller.rb

@@ -15,11 +15,8 @@ class Jets::MountController < Jets::BareController
 
     status, headers, io = mount_class.call(env)
     body = read_body(io)
-    render(
-      status: status,
-      headers: headers,
-      body: body,
-    )
+    self.headers.merge!(headers)
+    render body: body, status: status
   end
 
 private
@@ -32,15 +29,14 @@ private
     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.
+  # Locally Jets::Router::Matcher gets called in Jets::Controller::Middleware::Mimic
+  # On Lambda, Jets::Router::Matcher in handlers.
   def find_route
-    Jets::Router::Finder.new(event["path"], "ANY").run
+    Jets::Router::Matcher.new.find_by_request(request, "ANY")
   end
 
   def build_env(path)
-    env = Jets::Controller::Rack::Env.new(event, context, adapter: true).convert
+    env = Jets::Controller::RackAdapter::Env.new(event, context, adapter: true).convert
     # remap path info
     mount_at = mount_at(path)
     path_info = env["PATH_INFO"]

data/{lib/jets → engines}/internal/app/controllers/jets/public_controller.rb

@@ -3,7 +3,6 @@ require "mini_mime"
 
 class Jets::PublicController < Jets::Controller::Base
   layout false
-  internal true
 
   def show
     catchall = params[:catchall].blank? ? 'index.html' : params[:catchall]
@@ -25,7 +24,12 @@ class Jets::PublicController < Jets::Controller::Base
         render file: catchall_path, content_type: content_type
       end
     else
-      render file: "#{public_path}/404", status: 404
+      not_found_path = "#{public_path}/404.html"
+      if File.exist?(not_found_path)
+        render file: not_found_path, status: 404
+      else
+        render plain: "404 Not Found", status: 404
+      end
     end
   end
 end

data/engines/internal/app/controllers/jets/welcome_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Jets::WelcomeController < Jets::ApplicationController # :nodoc:
+  skip_forgery_protection
+  layout false
+
+  def index
+  end
+end

data/{lib/jets → engines}/internal/app/functions/jets/base_path.rb

@@ -3,7 +3,8 @@ begin
   # When require bundler/setup fails, AWS Lambda won't be able to load base_path_mapping
   # So we'll require base_path_mapping within begin/rescue block so that it does not also
   # fail the entire lambda function.
-  require 'jets/internal/app/functions/jets/base_path_mapping'
+  # require 'jets/internal/app/functions/jets/base_path_mapping'
+  require_relative "base_path_mapping"
 rescue Exception => e
   # Note: rescue LoadError is not enough in AWS Lambda environment
   # Actual exceptions:

data/{lib/jets → engines}/internal/app/functions/jets/base_path_mapping.rb

@@ -66,6 +66,7 @@ class BasePathMapping
     }
     puts "BasePathMapping delete options #{options.inspect}"
     apigateway.delete_base_path_mapping(options)
+    wait_for_delete
     puts "BasePathMapping delete complete"
   # https://github.com/tongueroo/jets/issues/255
   # Used to return: Aws::APIGateway::Errors::NotFoundException
@@ -75,6 +76,24 @@ class BasePathMapping
     raise(e) unless fail_silently
   end
 
+  # Wait for deletion to complete
+  # Otherwise, CloudFormation continues too fast during a `jets delete`
+  # and the initially fails deletion. CloudFormaton then retries until it's successfully.
+  # The stack ultimately finishes deleting successfully but the error messages
+  # are confusing to the user.
+  def wait_for_delete
+    loop do
+      resp = apigateway.get_base_path_mapping(
+        domain_name: domain_name,
+        base_path: base_path.empty? ? '(none)' : base_path,
+      )
+      break if resp.nil? || resp.empty?
+      sleep(5)
+    end
+  rescue Aws::APIGateway::Errors::NotFoundException
+    nil
+  end
+
   def create
     puts "BasePathMapping create"
     options = {
@@ -113,8 +132,8 @@ class BasePathMapping
     raise(e)
   end
 
-  def deployment_stack
-    @deployment_stack ||= cfn.describe_stacks(stack_name: @event['StackId']).stacks.first
+  def mapping_stack
+    @mapping_stack ||= cfn.describe_stacks(stack_name: @event['StackId']).stacks.first
   end
 
   def rest_api_id
@@ -130,7 +149,8 @@ class BasePathMapping
   end
 
   def parameter_value(parameter_key)
-    param = deployment_stack[:parameters].find { |p| p.parameter_key == parameter_key }
+    puts "mapping_stack #{mapping_stack.inspect}"
+    param = mapping_stack[:parameters].find { |p| p.parameter_key == parameter_key }
     param&.parameter_value # possible for this to be nil when removing the config: IE: config.domain.name = nil
   end
 
@@ -140,7 +160,7 @@ class BasePathMapping
   end
 
   def parent_stack_name
-    deployment_stack[:root_id]
+    mapping_stack[:root_id]
   end
 
   def apigateway
@@ -166,6 +186,6 @@ end
 
 if __FILE__ == $0
   event = JSON.load(File.read(ARGV[0]))
-  context = nil # stub out
-  BasePathMapping.new(event, context).update
+  stage_name = 'dev' # change to test
+  BasePathMapping.new(event, stage_name).update
 end

data/engines/internal/app/jobs/jets/preheat_job.rb

@@ -0,0 +1,67 @@
+class Jets::PreheatJob < Jets::Job::Base
+  include Jets::AwsServices
+
+  class_timeout 30
+  class_memory 1024
+  class_iam_policy([
+    {
+      Sid: "Statement1",
+      Action: ["logs:*"],
+      Effect: "Allow",
+      Resource: [{
+        "Fn::Sub": "arn:aws:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/lambda/${JetsPreheatJobWarmLambdaFunction}"
+      }]
+    },
+    {
+      Sid: "Statement2",
+      Action: ["lambda:InvokeFunction", "lambda:InvokeAsync"],
+      Effect: "Allow",
+      Resource: [{
+        "Fn::Sub": "arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:#{Jets.project_namespace}-*"
+      }]
+    }
+  ])
+
+  def warm
+    options = call_options(event[:quiet])
+    Jets::Preheat.warm_all(options)
+    "Finished prewarming your application."
+  end
+
+  class << self
+    # Can use this to prewarm post deploy
+    def prewarm!
+      perform_now(:warn, quiet: true)
+    end
+  end
+
+private
+  # Usually: jets-preheat_job-warm unless JETS_RESET=1, in that case need to lookup the function name
+  def warm_function_name
+    # Return early to avoid lookup call normally
+    return "jets-preheat_job-warm" unless ENV['JETS_RESET'] == "1"
+
+    parent_stack = cfn.describe_stack_resources(stack_name: Jets::Names.parent_stack_name)
+    preheat_stack = parent_stack.stack_resources.find do |resource|
+      resource.logical_resource_id =~ /JetsPreheatJob/
+    end
+
+    resp = cfn.describe_stack_resources(stack_name: preheat_stack.physical_resource_id)
+    resources = resp.stack_resources
+    warm_function = resources.find do |resource|
+      resource.logical_resource_id =~ /WarmLambdaFunction/
+    end
+    warm_function.physical_resource_id # IE: jets-preheat_job-warm
+  end
+
+  def call_options(quiet)
+    options = {}
+    options.merge!(mute: true, mute_output: true) if quiet
+    # All the methods in this Job class leads to Jets::Commands::Call.
+    # This is true for the Jets::Preheat.warm_all also.
+    # These jobs delegate out to Lambda function calls. We do not need/want
+    # the invocation type: RequestResponse in this case.
+    options.merge!(invocation_type: "Event")
+    options
+  end
+end

data/engines/internal/app/views/jets/info/properties.html.erb

@@ -0,0 +1 @@
+<%= @info.html_safe %>

data/engines/internal/app/views/jets/info/routes.html.erb

@@ -0,0 +1,10 @@
+<h2>
+  Routes
+</h2>
+
+<p>
+  Routes match in priority from top to bottom
+</p>
+
+<%# @routes_inspector.format(ActionDispatch::Routing::HtmlTableFormatter.new(self)) %>
+<%= raw @routes_table %>