jets 3.1.0 → 5.0.10

data/engines/internal/lib/internal/turbines/routes_helpers.rb

@@ -0,0 +1,42 @@
+# Rails implements with abstract_controller/turbines/routes_helpers.rb
+#
+# It's implement it this way by Rails so that the controller class _routes
+# definition points at the namespace engine routes correctly.
+#
+# This _routes controller class method used in ActionView::Rendering to create a
+# view_context_class that includes the routes url_helpers and mounted_helpers.
+#
+require "active_support/core_ext/module/introspection"
+
+module JetsTurbines
+  module RoutesHelpers
+    def self.with(routes, include_path_helpers = true)
+      Module.new do
+        define_method(:inherited) do |klass|
+          super(klass)
+
+          namespace = klass.module_parents.detect { |m| m.respond_to?(:turbine_routes_url_helpers) }
+          actual_routes = namespace ? namespace.turbine_routes_url_helpers._routes : routes
+
+          if namespace
+            klass.include(namespace.turbine_routes_url_helpers(include_path_helpers))
+          else
+            klass.include(routes.url_helpers(include_path_helpers))
+          end
+
+          # In the case that we have ex.
+          #   class A::Foo < ApplicationController
+          #   class Bar < A::Foo
+          # We will need to redefine _routes because it will not be correct
+          # via inheritance.
+          unless klass._routes.equal?(actual_routes)
+            klass.redefine_singleton_method(:_routes) { actual_routes }
+            klass.include(Module.new do
+              define_method(:_routes) { @_routes || actual_routes }
+            end)
+          end
+        end
+      end
+    end
+  end
+end

data/exe/jets

@@ -1,14 +1,5 @@
 #!/usr/bin/env ruby
 
-# traps: INT - ^C
-['INT', 'TERM', 'QUIT'].each do |signal|
-  trap(signal) do
-    puts "Detected stop signal"
-    sleep 0.2
-    exit
-  end
-end
-
 $:.unshift(File.expand_path("../../lib", __FILE__))
 require "jets"
-Jets::CLI.start
+require "jets/cli"

data/jets.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://rubyonjets.com"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = '~> 2.5'
+  spec.required_ruby_version = ['>= 2.7.0']
   spec.rdoc_options += Jets::Rdoc.options
 
   vendor_files       = Dir.glob("vendor/**/*")
@@ -27,11 +27,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "actionmailer", "~> 6.1.0"
-  spec.add_dependency "actionpack", "~> 6.1.0"
-  spec.add_dependency "actionview", "~> 6.1.0"
-  spec.add_dependency "activerecord", "~> 6.1.0"
-  spec.add_dependency "activesupport", "~> 6.1.0"
+  spec.add_dependency "actionmailer", "~> 7.0.8"
+  spec.add_dependency "actionpack", "~> 7.0.8"
+  spec.add_dependency "actionview", "~> 7.0.8"
+  spec.add_dependency "activerecord", "~> 7.0.8"
+  spec.add_dependency "activesupport", "~> 7.0.8"
+  spec.add_dependency "railties", "~> 7.0.8" # for ActiveRecord database_tasks.rb
+
+  spec.add_dependency "aws-logs"
   spec.add_dependency "aws-mfa-secure", "~> 0.4.0"
   spec.add_dependency "aws-sdk-apigateway"
   spec.add_dependency "aws-sdk-cloudformation"
@@ -43,25 +46,26 @@ Gem::Specification.new do |spec|
   spec.add_dependency "aws-sdk-sns"
   spec.add_dependency "aws-sdk-sqs"
   spec.add_dependency "aws-sdk-ssm"
-  spec.add_dependency "cfn-status"
-  spec.add_dependency "cfn_camelizer", "~> 0.4.6"
+  spec.add_dependency "cfn_camelizer", ">= 0.4.9"
   spec.add_dependency "cfn_response"
+  spec.add_dependency "cfn-status", ">= 0.5.0"
+  spec.add_dependency "cli-format", ">= 0.4.0"
   spec.add_dependency "dotenv"
-  spec.add_dependency "gems" # jets-gems dependency
+  spec.add_dependency "dsl_evaluator", ">= 0.3.0" # for DslEvaluator.print_code
+  spec.add_dependency "gems"
   spec.add_dependency "hashie"
+  spec.add_dependency "jets-api", ">= 0.1.4"
+  spec.add_dependency "jets-git"
   spec.add_dependency "jets-html-sanitizer"
   spec.add_dependency "kramdown"
   spec.add_dependency "memoist"
   spec.add_dependency "mini_mime"
   spec.add_dependency "rack"
-  spec.add_dependency "railties", "~> 6.1.0" # for ActiveRecord database_tasks.rb
   spec.add_dependency "rainbow"
   spec.add_dependency "recursive-open-struct"
-  spec.add_dependency "serverlessgems", "~> 0.1.4"
-  spec.add_dependency "shotgun"
   spec.add_dependency "text-table"
   spec.add_dependency "thor"
-  spec.add_dependency "zeitwerk", "~> 2.5.0"
+  spec.add_dependency "zeitwerk", ">= 2.6.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

data/lib/jets/app_loader.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "jets/version"
+
+module Jets
+  module AppLoader # :nodoc:
+    extend self
+
+    RUBY = Gem.ruby
+    EXECUTABLES = ["bin/jets", "script/jets"]
+    BUNDLER_WARNING = <<EOS
+Beginning in Jets 5, Jets ships with a `jets` binstub at ./bin/jets that
+should be used instead of the Bundler-generated `jets` binstub.
+
+If you are seeing this message, your binstub at ./bin/jets was generated by
+Bundler instead of Jets.
+
+You might need to regenerate your `jets` binstub locally and add it to source
+control:
+
+ jets app:update:bin           # Bear in mind this generates other binstubs
+                               # too that you may or may not want (like yarn)
+
+If you already have Jets binstubs in source control, you might be
+inadvertently overwriting them during deployment by using bundle install
+with the --binstubs option.
+
+If your application was created prior to Jets 4, here's how to upgrade:
+
+  bundle config --delete bin    # Turn off Bundler's stub generator
+  jets app:update:bin          # Use the new Jets executables
+  git add bin                   # Add bin/ to source control
+
+You may need to remove bin/ from your .gitignore as well.
+
+When you install a gem whose executable you want to use in your app,
+generate it and add it to source control:
+
+  bundle binstubs some-gem-name
+  git add bin/new-executable
+
+EOS
+
+    def exec_app
+      original_cwd = Dir.pwd
+
+      loop do
+        if exe = find_executable
+          contents = File.read(exe)
+
+          if /(APP|ENGINE)_PATH/.match?(contents)
+            exec RUBY, exe, *ARGV
+            break # non reachable, hack to be able to stub exec in the test suite
+          elsif exe.end_with?("bin/jets") && contents.include?("This file was generated by Bundler")
+            $stderr.puts(BUNDLER_WARNING)
+            Object.const_set(:APP_PATH, File.expand_path("config/application", Dir.pwd))
+            # Do not run Jets.boot here else -e option is not respected. IE: jets console -e production
+            require "jets/commands"
+            break
+          end
+        end
+
+        # If we exhaust the search there is no executable, this could be a
+        # call to generate a new application, so restore the original cwd.
+        Dir.chdir(original_cwd) && return if Pathname.new(Dir.pwd).root?
+
+        # Otherwise keep moving upwards in search of an executable.
+        Dir.chdir("..")
+      end
+    end
+
+    def find_executable
+      EXECUTABLES.find { |exe| File.file?(exe) }
+    end
+  end
+end

data/lib/jets/application/bootstrap.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "active_support/notifications"
+require "active_support/dependencies"
+require "active_support/descendants_tracker"
+require "jets/secrets"
+
+module Jets
+  class Application
+    module Bootstrap
+      include Initializable
+
+      initializer :load_environment_hook, group: :all do end
+
+      initializer :load_active_support, group: :all do
+        ENV["JETS_DISABLE_DEPRECATED_TO_S_CONVERSION"] = "true" if config.active_support.disable_to_s_conversion
+        require "active_support/all" unless config.active_support.bare
+      end
+
+      initializer :set_eager_load, group: :all do
+        if config.eager_load.nil?
+          warn <<~INFO
+            config.eager_load is set to nil. Please update your config/environments/*.rb files accordingly:
+
+              * development - set it to false
+              * test - set it to false (unless you use a tool that preloads your test environment)
+              * production - set it to true
+
+          INFO
+          config.eager_load = config.cache_classes
+        end
+      end
+
+      # Initialize the logger early in the stack in case we need to log some deprecation.
+      initializer :initialize_logger, group: :all do
+        Jets.logger ||= config.logger || begin
+          logger = ActiveSupport::Logger.new(config.default_log_file)
+          logger.formatter = config.log_formatter
+          logger = ActiveSupport::TaggedLogging.new(logger)
+          logger
+        rescue StandardError
+          path = config.paths["log"].first
+          logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDERR))
+          logger.level = ActiveSupport::Logger::WARN
+          logger.warn(
+            "Jets Error: Unable to access log file. Please ensure that #{path} exists and is writable " \
+            "(i.e. make it writable for user and group: chmod 0664 #{path}). " \
+            "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed."
+          )
+          logger
+        end
+        Jets.logger.level = ActiveSupport::Logger.const_get(config.log_level.to_s.upcase)
+
+        unless config.consider_all_requests_local
+          Jets.error.logger = Jets.logger
+        end
+      end
+
+      # Initialize cache early in the stack so turbines can make use of it.
+      initializer :initialize_cache, group: :all do
+        cache_format_version = config.active_support.delete(:cache_format_version)
+        ActiveSupport.cache_format_version = cache_format_version if cache_format_version
+
+        unless Jets.cache
+          Jets.cache = ActiveSupport::Cache.lookup_store(*config.cache_store)
+
+          if Jets.cache.respond_to?(:middleware)
+            config.middleware.insert_before(::Rack::Runtime, Jets.cache.middleware)
+          end
+        end
+      end
+
+      # We setup the once autoloader this early so that engines and applications
+      # are able to autoload from these paths during initialization.
+      initializer :setup_once_autoloader, after: :set_eager_load_paths, before: :bootstrap_hook do
+        autoloader = Jets.autoloaders.once
+
+        ActiveSupport::Dependencies.autoload_once_paths.freeze
+        ActiveSupport::Dependencies.autoload_once_paths.uniq.each do |path|
+          # Zeitwerk only accepts existing directories in `push_dir`.
+          next unless File.directory?(path)
+
+          autoloader.push_dir(path)
+          autoloader.do_not_eager_load(path) unless ActiveSupport::Dependencies.eager_load?(path)
+        end
+
+        autoloader.setup
+      end
+
+      initializer :bootstrap_hook, group: :all do |app|
+        ActiveSupport.run_load_hooks(:before_initialize, app)
+      end
+
+      initializer :set_secrets_root, group: :all do
+        Jets::Secrets.root = root
+      end
+    end
+  end
+end

data/lib/jets/application/configuration/defaults.rb

@@ -0,0 +1,256 @@
+class Jets::Application::Configuration < ::Jets::Engine::Configuration
+  # These are Jets specific defaults. The other defaults in Configuration come from using Rails components.
+  module Defaults
+    extend ActiveSupport::Concern
+
+    attr_accessor :api,
+                  :api_mode,
+                  :app,
+                  :build,
+                  :cfn,
+                  :controllers,
+                  :default_iam_policy,
+                  :deploy,
+                  :domain,
+                  :environment,
+                  :events,
+                  :filter_parameters,
+                  :function,
+                  :gems,  # deprecated
+                  :helpers_paths,
+                  :helpers,
+                  :iam_policy,
+                  :ignore_paths,
+                  :inflections,
+                  :lambda,
+                  :logger,
+                  :logging,
+                  :managed_iam_policy,
+                  :managed_policy_definitions,
+                  :mode,
+                  :prewarm,
+                  :pro,
+                  :routes,
+                  :s3_event,
+                  :webpacker # deprecated
+
+    def initialize(*)
+      Jets::Dotenv.load!
+      super
+      @api = ActiveSupport::OrderedOptions.new
+      @api.api_key_required = false # Turn off API key required
+      @api.authorization_type = "NONE"
+      @api.authorizers = ActiveSupport::OrderedOptions.new
+      @api.authorizers.default_token_source = "Auth" # method.request.header.Auth
+      @api.auto_replace = nil # https://github.com/boltops-tools/jets/issues/391
+      @api.binary_media_types = ['multipart/form-data']
+
+      @api.cors = default_cors
+      @api.endpoint_policy = nil # required when endpoint_type is EDGE
+      @api.endpoint_type = 'EDGE' # PRIVATE, EDGE, REGIONAL
+      @api.vpc_endpoint_ids = nil
+
+      @api_mode = nil
+
+      @app = ActiveSupport::OrderedOptions.new
+      @app.domain = nil
+
+      @build = ActiveSupport::OrderedOptions.new
+      @build.prebundle_copy = []
+
+      @cfn = ActiveSupport::OrderedOptions.new
+      @cfn.build = ActiveSupport::OrderedOptions.new
+      @cfn.build.controllers = "one_lambda_for_all_controllers" # also: one_lambda_per_controller one_lambda_for_all_controllers
+      @cfn.build.resource_tags = {} # tags to add to all resources
+      @cfn.build.routes = "one_apigw_method_for_all_routes" # also: one_apigw_method_per_route
+
+      @controllers = ActiveSupport::OrderedOptions.new
+      @controllers.default_protect_from_forgery = nil
+
+      @deploy = ActiveSupport::OrderedOptions.new
+      @deploy.stagger = ActiveSupport::OrderedOptions.new
+      @deploy.stagger.enabled = false
+      @deploy.stagger.batch_size = 10
+
+      # @domain.name = "#{Jets.project_namespace}.coolapp.com" # Default is nil
+      # @domain.cert_arn = "..."
+      # @domain.route53 controls whether or not to create the managed route53 record.
+      # Useful to disable this when user wants to manage the route themself like pointing
+      # it to CloudFront for blue-green deployments instead.
+      @domain = ActiveSupport::OrderedOptions.new
+      @domain.base_path = '' # empty path represents root
+      @domain.endpoint_type = "REGIONAL" # EDGE or REGIONAL. Default to EDGE because CloudFormation update is faster
+      @domain.route53 = true
+
+      @environment = ActiveSupport::OrderedOptions.new
+
+      @events = ActiveSupport::OrderedOptions.new
+
+      @events.dynamodb = ActiveSupport::OrderedOptions.new
+      @events.dynamodb.table_namespace = true # true will use Jets.table_name
+      @events.dynamodb.table_namespace_separator = '_'
+
+      @events.s3 = ActiveSupport::OrderedOptions.new
+      @events.s3.configure_bucket = true
+      # These notification_configuration properties correspond to the ruby aws-sdk
+      #   s3.put_bucket_notification_configuration
+      # in jets/s3_bucket.rb, not the CloudFormation Bucket properties. The CloudFormation
+      # bucket properties have a similiar structure but is slightly different so it can be confusing.
+      #
+      #   Ruby aws-sdk S3 Docs: https://amzn.to/2N7m5Lr
+      @events.s3.notification_configuration = {
+        topic_configurations: [
+          {
+            events: ["s3:ObjectCreated:*"],
+            topic_arn: "!Ref SnsTopic", # must use this logical id
+          },
+        ],
+      }
+
+      # Deprecated: Use @events.s3.configure_bucket instead
+      # Leaving in as a comment for now. Will remove comment in the future
+      # Already print a deprecation warning in jets/stack/s3_event.rb
+      @s3_event = ActiveSupport::OrderedOptions.new
+      # @s3_event.configure_bucket = true
+      # @s3_event.notification_configuration = {
+      #   topic_configurations: [
+      #     {
+      #       events: ["s3:ObjectCreated:*"],
+      #       topic_arn: "!Ref SnsTopic", # must use this logical id
+      #     },
+      #   ],
+      # }
+
+      @filter_parameters = []
+
+      # default function.memory_size memory setting based on:
+      # https://medium.com/epsagon/how-to-make-lambda-faster-memory-performance-benchmark-be6ebc41f0fc
+      @function = ActiveSupport::OrderedOptions.new
+      @function.ephemeral_storage = { size: 512 } # megabytes
+      @function.memory_size = 1536
+      @function.timeout = 30
+
+      # Old deprecated
+      @gems = ActiveSupport::OrderedOptions.new
+      @gems.clean = false
+      @gems.disable = false
+      @gems.source = "https://api.serverlessgems.com/api/v1"
+      # New
+      @pro = ActiveSupport::OrderedOptions.new
+      @pro.disable = false
+
+      @helpers = ActiveSupport::OrderedOptions.new
+      @helpers.host = nil # nil by default. Other examples: https://myurl.com:8888
+      @helpers_paths = []
+
+      @inflections = ActiveSupport::OrderedOptions.new
+      @inflections.irregular = {}
+
+      # Custom user lambda layers
+      @lambda = ActiveSupport::OrderedOptions.new
+      @lambda.layers = []
+
+      @logger = ActiveSupport::Logger.new($stderr)
+      @logger.formatter = ActiveSupport::Logger::SimpleFormatter.new # jets v5 default: no timestamps
+      @logger.level = :debug # Logger::DEBUG - default to debug for development mode and to see ActionMailer logs
+
+      @logging = ActiveSupport::OrderedOptions.new
+      @logging.event = false # jets v5 behavior
+
+      @mode = nil # job api html
+
+      @prewarm = ActiveSupport::OrderedOptions.new
+      @prewarm.enable = true
+      @prewarm.public_ratio = 3
+      @prewarm.rate = '30 minutes'
+
+      @routes = ActiveSupport::OrderedOptions.new
+      @routes.allow_sibling_conflicts = true # users/:id and users/:user_id/articles
+
+      @default_iam_policy = self.class.default_iam_policy
+      @managed_policy_definitions = []
+      @managed_iam_policy = []
+    end
+
+    # IAM policies must run lazily because they depend on @function.vpc_config
+    # Need the if Jets.application check because commands like
+    #   jets generate kingsman:controllers -h
+    # will load Rails for generators and that will directly use a
+    # Jets config that does not call Jest.boot
+    # See: Jets::Generator
+    def iam_policy
+      return [] unless Jets.application
+
+      if @default_iam_policy.nil? && @iam_policy.nil?
+        return self.class.default_iam_policy
+      end
+
+      policy = []
+      policy << @default_iam_policy
+      if @function.vpc_config
+        policy << vpc_iam_policy_statement
+      end
+      policy << @iam_policy
+      policy.flatten.compact
+    end
+
+    def vpc_iam_policy_statement
+      {
+        Action: %w[
+          ec2:CreateNetworkInterface
+          ec2:DeleteNetworkInterface
+          ec2:DescribeNetworkInterfaces
+          ec2:DescribeVpcs
+          ec2:DescribeSubnets
+          ec2:DescribeSecurityGroups
+        ],
+        Effect: "Allow",
+        Resource: "*",
+      }
+    end
+
+    def default_cors
+      !!Gem.loaded_specs.detect do |gem_name, spec|
+        gem_name == "rack-cors"
+      end
+    end
+
+    class_methods do
+      def default_iam_policy
+        project_namespace = Jets.project_namespace
+        logs = {
+          Action: ["logs:*"],
+          Effect: "Allow",
+          Resource: "arn:aws:logs:#{Jets.aws.region}:#{Jets.aws.account}:log-group:/aws/lambda/#{project_namespace}-*",
+        }
+        s3_readonly = {
+          Action: ["s3:Get*", "s3:List*", "s3:HeadBucket"],
+          Effect: "Allow",
+          Resource: "arn:aws:s3:::#{Jets.aws.s3_bucket}*",
+        }
+        policies = [logs, s3_readonly]
+
+        cloudformation = {
+          Action: ["cloudformation:DescribeStacks", "cloudformation:DescribeStackResources"],
+          Effect: "Allow",
+          Resource: "arn:aws:cloudformation:#{Jets.aws.region}:#{Jets.aws.account}:stack/#{project_namespace}*",
+        }
+        policies << cloudformation
+
+        policies
+      end
+    end
+
+    def load_defaults(target_version)
+      load_rails_defaults "7.0"
+
+      case target_version.to_s
+      when "5.0"
+        @host_authorization = { exclude: ->(request) do
+            request.host =~ /localhost/ || request.domain == "amazonaws.com"
+          end
+        }
+      end
+    end
+  end
+end