jets 3.1.0 → 4.0.0

data/lib/jets/cfn/builders/base_child_builder.rb

@@ -18,7 +18,7 @@ module Jets::Cfn::Builders
 
     # template_path is an interface method for Interface module
     def template_path
-      Jets::Naming.app_template_path(@app_class)
+      Jets::Names.app_template_path(@app_class)
     end
 
     def add_common_parameters
@@ -40,6 +40,7 @@ module Jets::Cfn::Builders
     end
 
     def add_functions
+      validate_function_names!
       add_class_iam_policy
       @app_class.tasks.each do |task|
         add_function(task)
@@ -65,5 +66,23 @@ module Jets::Cfn::Builders
       resource = Jets::Resource::Iam::FunctionRole.new(task)
       add_resource(resource)
     end
+
+    def validate_function_names!
+      invalids = @app_class.tasks.reject do |task|
+        task.meth.to_s =~ /^[a-zA-Z][a-zA-Z0-9_]/
+      end
+      return if invalids.empty?
+      list = invalids.map do |task|
+        "    #{task.class_name}##{task.meth}" # IE: PostsController#index
+      end.join("\n")
+      puts "ERROR: Detected invalid AWS Lambda function names".color(:red)
+      puts <<~EOL
+        Lambda function names must start with a letter and can only contain letters, numbers, and underscores.
+        Invalid function names:
+
+        #{list}
+      EOL
+      exit 1
+    end
   end
 end

data/lib/jets/cfn/builders/interface.rb

@@ -88,8 +88,27 @@ module Jets::Cfn::Builders
       end
     end
 
+    # Note: Jets::Resource::Iam classes are special treated. They are the only resources that result
+    # in creating 2 CloudFormation resources: Iam::Policy and Iam::Role.
+    # This allows the user to refer to the Lambda Function name in the IAM Policy itself.
+    # We need separate resources to avoid CloudFormation erroring with a circular dependency.
+    # Using separate IAM::Policy and IAM::Role resources allows us avoid the circular dependency error.
+    #
+    # Handling logic here also centralizes code for this special behavior.
+    # Also important to note, this does not change the user-facing interface.
+    # IE: Users still uses code like:
+    #
+    #    iam_policy("s3", "sns")
+    #
+    # and be none-the-wiser about the special behavior.
     def add_resource(resource)
       add_template_resource(resource.logical_id, resource.type, resource.attributes)
+
+      if resource.class.to_s.include?("Jets::Resource::Iam")
+        role = resource # for clarity: resource is a Iam::*Role class
+        iam_policy = Jets::Resource::Iam::Policy.new(role)
+        add_template_resource(iam_policy.logical_id, iam_policy.type, iam_policy.attributes)
+      end
     end
 
     # The add_resource method can take an options Hash with both with either

data/lib/jets/cfn/builders/page_builder.rb

@@ -0,0 +1,80 @@
+module Jets::Cfn::Builders
+  class PageBuilder
+    extend Memoist
+    cattr_reader :pages
+
+    # Build page slices
+    def build
+      map = build_map
+      pages = []
+      map.each do |path, existing_page|
+        if existing_page
+          pages[existing_page] ||= []
+          pages[existing_page] << path
+        end
+      end
+
+      # Remove existing paths from map. Leave behind new paths
+      pages.each do |page|
+        page.each do |i|
+          map.delete(i)
+        end
+      end
+
+      # Fill up available space in each page so all existing pages are full
+      keys = map.keys
+      pages.each do |page|
+        break if keys.empty?
+        while page.size < page_limit
+          path = keys.shift
+          break if path.nil?
+          page << path
+        end
+      end
+
+      # Add remaining slices to new additional pages
+      pages += keys.each_slice(page_limit).to_a
+
+      @@pages = pages
+
+      pages
+    end
+
+    # Build map that has paths as keys and page number as value
+    # Example: {"a1"=>0, "a2"=>0, "b1"=>1, "b2"=>1, "c1"=>2, "c2"=>2}
+    def build_map
+      map = {}
+      new_paths.each do |path|
+         map[path] = find_page_index(path)
+      end
+      map
+    end
+
+    def find_page_index(new_path)
+      pages = old_pages || []
+      pages.each_with_index do |slice, i|
+        slice.find do |old_path|
+          return i if old_path == new_path
+        end
+      end
+      nil
+    end
+
+    def old_pages
+      state = Jets::Router::State.new
+      state.load("pages")
+    end
+    memoize :old_pages
+
+    def new_paths
+      Jets::Router.all_paths.reject { |p| p == '' }
+    end
+
+    # Relevant is CloudFormation Outputs limit is 200
+    # JETS_APIGW_PAGE_LIMIT is based on that
+    # https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html
+    def page_limit
+      Integer(ENV['JETS_APIGW_PAGE_LIMIT'] || 200)
+    end
+  end
+end

data/lib/jets/cfn/builders/parent_builder.rb

@@ -19,14 +19,33 @@ module Jets::Cfn::Builders
 
     # template_path is an interface method
     def template_path
-      Jets::Naming.parent_template_path
+      Jets::Names.parent_template_path
     end
 
     def build_minimal_resources
       add_description("Jets: #{Jets.version} Code: #{Util::Source.version}")
 
       # Initial s3 bucket, used to store code zipfile and templates Jets generates
+      #
+      # AWS changed the default behavior of s3 buckets to block public access
+      #   https://aws.amazon.com/blogs/aws/amazon-s3-block-public-access-another-layer-of-protection-for-your-accounts-and-buckets/
+      #   https://github.com/aws-amplify/amplify-cli/issues/12503
+      #
+      # Jets uploads assets to s3 bucket with acl: "public-read" here
+      #   https://github.com/boltops-tools/jets/blob/c5858ec2706a606665a92c3ada3f16ae4c753372/lib/jets/cfn/upload.rb#L97
+      #
+      # Use minimal s3 bucket policy to allow public read access to assets.
+      # Leave the other options as comments to help document the default behavior.
       resource = Jets::Resource::S3::Bucket.new(logical_id: "s3_bucket",
+        PublicAccessBlockConfiguration: {
+          BlockPublicAcls: false,
+          # BlockPublicPolicy: false,
+          # IgnorePublicAcls: false,
+          # RestrictPublicBuckets: false
+        },
+        OwnershipControls: {
+          Rules: [{ObjectOwnership: "ObjectWriter"}]
+        },
         bucket_encryption: {
           server_side_encryption_configuration: [
             server_side_encryption_by_default: {
@@ -71,7 +90,7 @@ module Jets::Cfn::Builders
     #    #{Jets.build_root}/templates/demo-dev-2-app-comments_controller.yml
     #    #{Jets.build_root}/templates/demo-dev-2-authorizers-main_authorizer.yml
     def for_each_path(type)
-      expression = "#{Jets::Naming.template_path_prefix}-#{type}-*"
+      expression = "#{Jets::Names.template_path_prefix}-#{type}-*"
       Dir.glob(expression).each do |path|
         next unless File.file?(path)
         yield(path)
@@ -104,7 +123,7 @@ module Jets::Cfn::Builders
     end
 
     def add_api_resources
-      expression = "#{Jets::Naming.template_path_prefix}-api-resources-*"
+      expression = "#{Jets::Names.template_path_prefix}-api-resources-*"
       # IE: path: #{Jets.build_root}/templates/demo-dev-2-api-resources-1.yml"
       Dir.glob(expression).sort.each do |path|
         next unless File.file?(path)

data/lib/jets/cfn/builders/shared_builder.rb

@@ -8,7 +8,7 @@ module Jets::Cfn::Builders
 
     # template_path is an interface method for Interface module
     def template_path
-      Jets::Naming.shared_template_path(@app_class)
+      Jets::Names.shared_template_path(@app_class)
     end
   end
 end

data/lib/jets/cfn/built_template.rb

@@ -7,7 +7,7 @@ module Jets::Cfn
         if @@cache[path]
           @@cache[path] # using cache
         else
-          @@cache[path] = YAML.load_file(path) # setting and using cache
+          @@cache[path] = Jets::Util::Yamler.load_file(path) # setting and using cache
         end
       end
     end

data/lib/jets/cfn/ship.rb

@@ -5,7 +5,7 @@ module Jets::Cfn
 
     def initialize(options)
       @options = options
-      @parent_stack_name = Jets::Naming.parent_stack_name
+      @parent_stack_name = Jets::Names.parent_stack_name
     end
 
     def run
@@ -42,6 +42,7 @@ module Jets::Cfn
         exit 1
       end
 
+      save_apigw_state
       prewarm
       clean_deploy_logs
       show_api_endpoint
@@ -80,7 +81,7 @@ module Jets::Cfn
     end
 
     def template
-      @template ||= TemplateSource.new(Jets::Naming.parent_template_path, @options)
+      @template ||= TemplateSource.new(Jets::Names.parent_template_path, @options)
     end
 
     # check for /(_COMPLETE|_FAILED)$/ status
@@ -88,6 +89,12 @@ module Jets::Cfn
       Jets::Cfn::Status.new(@options).wait
     end
 
+    def save_apigw_state
+      state = Jets::Router::State.new
+      state.save("pages", Jets::Cfn::Builders::PageBuilder.pages)
+      state.save("routes", Jets::Router.routes)
+    end
+
     def prewarm
       if ENV['SKIP_PREWARMING']
         puts "Skipping prewarming" # useful for testing

data/lib/jets/cfn/status.rb

@@ -3,7 +3,7 @@ require 'cfn_status'
 module Jets::Cfn
   class Status < CfnStatus
     def initialize(options={})
-      @stack_name = Jets::Naming.parent_stack_name
+      @stack_name = Jets::Names.parent_stack_name
       super(@stack_name, options)
     end
   end

data/lib/jets/cfn/upload.rb

@@ -21,7 +21,7 @@ module Jets::Cfn
 
     def upload_cfn_templates
       puts "Uploading CloudFormation templates to S3."
-      expression = "#{Jets::Naming.template_path_prefix}-*"
+      expression = "#{Jets::Names.template_path_prefix}-*"
       Dir.glob(expression).each do |path|
         next unless File.file?(path)
 
@@ -93,7 +93,7 @@ module Jets::Cfn
       key = s3_key(full_path)
       obj = s3_resource.bucket(bucket_name).object(key)
       content_type = content_type_headers(full_path)
-      puts "Uploading and setting content type for s3://#{bucket_name}/#{key} content_type #{content_type[:content_type].inspect}"
+      Jets.logger.debug "Uploading and setting content type for s3://#{bucket_name}/#{key} content_type #{content_type[:content_type].inspect}"
       obj.upload_file(full_path, { acl: "public-read", cache_control: cache_control }.merge(content_type))
     end
 

data/lib/jets/cli.rb

@@ -63,7 +63,8 @@ class Jets::CLI
     # Pretty tricky, we need to use the raw @given_args as thor_args eventually calls Commands::Base#eager_load!
     # which uses Jets.env before we get a chance to override ENV['JETS_ENV']
     command, env = @given_args[0..1]
-    return unless %w[deploy delete].include?(command)
+
+    return unless %w[deploy delete console c].include?(command)
     env = nil if env&.starts_with?('-')
     return unless env
     ENV['JETS_ENV'] = env ? env : 'development'
@@ -136,10 +137,16 @@ class Jets::CLI
     end
 
     return unless jets_project?
-    rake_task_found = Jets::Commands::RakeCommand.namespaced_commands.include?(full_command)
-    if rake_task_found
-      return Jets::Commands::RakeCommand
-    end
+
+    Jets::Commands::RakeCommand if rake_task_found
+  end
+
+  def rake_task_found
+    return false unless full_command # can be nil for subcommands and would break jets help without this check
+    bracket_regex = /\[.*/ # matches everything after the first [
+    command = full_command.sub(bracket_regex, '') # remove everything after the first [
+    namespaced_commands = Jets::Commands::RakeCommand.namespaced_commands.map {|x| x.sub(bracket_regex, '') }
+    namespaced_commands.include?(command)
   end
 
   def jets_project?

data/lib/jets/commands/call/base_guesser.rb

@@ -56,7 +56,7 @@ class Jets::Commands::Call
 
     @@parent_stack = nil
     def parent_stack
-      @@parent_stack ||= cfn.describe_stacks(stack_name: Jets::Naming.parent_stack_name).stacks.first
+      @@parent_stack ||= cfn.describe_stacks(stack_name: Jets::Names.parent_stack_name).stacks.first
     end
   end
 end

data/lib/jets/commands/clean/log.rb

@@ -4,7 +4,7 @@
 #   /aws/lambda/demo-dev-2-jets-preheat_job-warm
 #   /aws/lambda/demo-dev-2-jets-public_controller-show
 #
-# We're doing this because JETS_ENV_EXTRA environments can create additional matching
+# We're doing this because Jets.extra environments can create additional matching
 # log groups and we don't want to overly-aggressively delete them.
 #
 # The `keep_prefixes(log_group_names)` method calcuates the log groups to keep.
@@ -49,7 +49,7 @@ class Jets::Commands::Clean
 
   private
     def prefix_guess
-      Jets::Naming.parent_stack_name
+      Jets::Names.parent_stack_name
     end
 
     def log_groups
@@ -78,7 +78,7 @@ class Jets::Commands::Clean
 
     # Check for the prefixes to keep. The slightly tricky thing to watch for is
     # for the prefix matching addiitonal log groups that belong to other
-    # JETS_ENV_EXTRA=xxx created environments.
+    # JETS_EXTRA=xxx created environments.
     #
     # We find and store the prefixes to keep so we don't over aggressively delete
     # log groups.

data/lib/jets/commands/configure.rb

@@ -16,7 +16,7 @@ module Jets::Commands
 
     def load_yaml
       if File.exist?(path)
-        YAML.load_file(path)
+        Jets::Util::Yamler.load_file(path)
       else
         {}
       end

data/lib/jets/commands/console.rb

@@ -1,5 +1,11 @@
 class Jets::Commands::Console
-  def self.run
+  attr_reader :environment
+
+  def initialize(environment)
+    @environment = environment
+  end
+
+  def run
     puts Jets::Booter.message
 
     # Thanks: https://mutelight.org/bin-console

data/lib/jets/commands/delete.rb

@@ -90,7 +90,7 @@ class Jets::Commands::Delete
   end
 
   def parent_stack_name
-    Jets::Naming.parent_stack_name
+    Jets::Names.parent_stack_name
   end
 
   def are_you_sure?

data/lib/jets/commands/deploy.rb

@@ -81,7 +81,7 @@ module Jets::Commands
     memoize :status
 
     def stack_name
-      Jets::Naming.parent_stack_name
+      Jets::Names.parent_stack_name
     end
 
     # Checks for a few things before deciding to delete the parent stack
@@ -117,7 +117,7 @@ module Jets::Commands
     def exit_unless_updateable!
       return if ENV['JETS_FORCE_UPDATEABLE'] # useful for debugging if stack stack updating
 
-      stack_name = Jets::Naming.parent_stack_name
+      stack_name = Jets::Names.parent_stack_name
       exists = stack_exists?(stack_name)
       return unless exists # continue because stack could be updating
 

data/lib/jets/commands/main.rb

@@ -61,10 +61,13 @@ module Jets::Commands
       Jets::Router.validate_routes!
     end
 
-    desc "console", "REPL console with Jets environment loaded"
+    desc "console [environment]", "REPL console with Jets environment loaded"
     long_desc Help.text(:console)
-    def console
-      Console.run
+    # Note the environment is here to trick the Thor parser to allowing an
+    # environment parameter. It is not actually set here.  It is set earlier
+    # in cli.rb: set_jets_env_from_cli_arg!
+    def console(environment=nil)
+      Console.new(options).run
     end
 
     desc "runner", "Run Ruby code in the context of Jets app non-interactively"

data/lib/jets/commands/stack_info.rb

@@ -25,6 +25,6 @@ module Jets::Commands::StackInfo
   end
 
   def parent_stack_name
-    Jets::Naming.parent_stack_name
+    Jets::Names.parent_stack_name
   end
 end

data/lib/jets/commands/templates/skeleton/Gemfile.tt

@@ -18,7 +18,7 @@ gem "mysql2", "~> 0.5.3"
 <% unless options[:mode] == 'job' -%>
 gem "dynomite"
 <% end -%>
-gem "zeitwerk", "~> 2.5.0"
+gem "zeitwerk", ">= 2.5.0"
 
 # development and test groups are not bundled as part of the deployment
 group :development, :test do

data/lib/jets/commands/templates/skeleton/config/application.rb.tt

@@ -11,7 +11,7 @@ Jets.application.configure do
   # config.prewarm.public_ratio = 3 # default is 3
 <% end -%>
 
-  # config.env_extra = 2 # can also set this with JETS_ENV_EXTRA
+  # config.extra = 2 # can also set this with JETS_EXTRA
   # config.autoload_paths = []
 
   # config.asset_base_url = 'https://cloudfront.domain.com/assets' # example
@@ -35,6 +35,7 @@ Jets.application.configure do
   #   security_group_ids: %w[sg-1 sg-2],
   #   subnet_ids: %w[subnet-1 subnet-2],
   # }
+  # config.function.ephemeral_storage = { size: 1536 }
   # The config.function settings to the CloudFormation Lambda Function properties.
   # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html
   # Underscored format can be used for keys to make it look more ruby-ish.

data/lib/jets/commands/url.rb

@@ -7,7 +7,7 @@ module Jets::Commands
     end
 
     def display
-      stack_name = Jets::Naming.parent_stack_name
+      stack_name = Jets::Names.parent_stack_name
       unless stack_exists?(stack_name)
         puts "Stack for #{Jets.config.project_name.color(:green)} project for environment #{Jets.env.color(:green)}.  Couldn't find #{stack_name.color(:green)} stack."
         exit

data/lib/jets/core.rb

@@ -32,7 +32,19 @@ module Jets::Core
   end
   memoize :env
 
-  def build_root
+  @@extra_warning_shown = false
+  def extra
+    # Keep for backwards compatibility
+    unless ENV['JETS_ENV_EXTRA'].blank?
+      puts "DEPRECATION WARNING: JETS_ENV_EXTRA is deprecated. Use JETS_EXTRA instead.".color(:yellow) unless @@extra_warning_shown
+      @@extra_warning_shown = true
+      extra = ENV['JETS_ENV_EXTRA']
+    end
+    extra = ENV['JETS_EXTRA'] unless ENV['JETS_EXTRA'].blank?
+    extra
+  end
+
+def build_root
     "/tmp/jets/#{config.project_name}".freeze
   end
   memoize :build_root
@@ -76,7 +88,7 @@ module Jets::Core
   end
 
   def project_namespace
-    [config.project_name, config.short_env, config.env_extra].compact.join('-').gsub('_','-')
+    [config.project_name, config.short_env, config.extra].compact.join('-').gsub('_','-')
   end
 
   def rack?

data/lib/jets/core_ext/file.rb

@@ -0,0 +1,9 @@
+class File
+  class << self
+    # Ruby 3.2 removed File.exists?
+    # aws_config/store.rb uses it
+    # https://github.com/a2ikm/aws_config/blob/ef9cdd0eda116577f7d358bc421afd8e2f1eb1d3/lib/aws_config/store.rb#L6
+    # Probably a bunch of other libraries still use File.exists? also
+    alias_method :exists?, :exist?
+  end
+end

data/lib/jets/dotenv.rb

@@ -36,8 +36,8 @@ class Jets::Dotenv
       (root.join(".env.#{Jets.env}.local") unless @remote),
     ]
     files << root.join(".env.#{Jets.env}.remote") if @remote
-    if ENV["JETS_ENV_EXTRA"]
-      files << root.join(".env.#{Jets.env}.#{ENV["JETS_ENV_EXTRA"]}")
+    if Jets.extra
+      files << root.join(".env.#{Jets.env}.#{Jets.extra}")
     end
     files.compact
   end

data/lib/jets/erb.rb

@@ -12,7 +12,7 @@ class Jets::Erb
       set_template_variables(variables)
       template = IO.read(path)
       begin
-        ERB.new(template, nil, "-").result(binding)
+        ERB.new(template, trim_mode: '-').result(binding)
       rescue Exception => e
         puts e
         puts e.backtrace if ENV['JETS_DEBUG']

data/lib/jets/inflections.rb

@@ -25,7 +25,7 @@ module Jets
       # User defined custom inflections
       def custom
         path = "#{Jets.root}/config/inflections.yml"
-        File.exist?(path) ? YAML.load_file(path) : {}
+        File.exist?(path) ? Jets::Util::Yamler.load_file(path) : {}
       end
     end
   end

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

@@ -10,7 +10,7 @@ private
   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 = Jets::Controller::Rack::Adapter.new(event, context)
     adapter.convert_to_api_gateway(status, headers, body)
   end
 end