jets 1.7.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d4b8b6547644c895f4b9f86ea9c58d1732f89bd68cc3f71a73cf4d2a6733eb0
-  data.tar.gz: e6447ef5b8099c9c405be40315cf9aa2dc711958158a79a86f578c1f0258117d
+  metadata.gz: 22ccf0e1b4f1fe6841677f5e80a47d28420176db2b89d0e66852d71841feac32
+  data.tar.gz: 0dff68b46ad8f254a1fc8ffe71d95d52b58cc21b1ccd4cf78ec0e62c212d4ed6
 SHA512:
-  metadata.gz: 5a90c4010311c435bc32714738dd83ece60822a8c34cb9d848c198bd0d8d9518129a764c5edf3ea873747f3ff38d3630ec991a907f5afd9acf6befabada4fd58
-  data.tar.gz: b2013f481f5be249ee7798bb746306d25e52ff9f1515020b28c3e7e7583511ea3796666734a202c3514235d0d6816ce28e677ef397238c88531a44116f0cbbb7
+  metadata.gz: 3facb23a28890cea9a9627808198e7499975ad1874ffb4371fa14a757ff45b3f74e1daa853d51ca966c170450ee7e2b0d6e48a3dea621aad62936cf8f1b98312
+  data.tar.gz: 46369c376727ebc86de017043ff079abbd077f2a1c090193ad0cebd728528e3e2794df003b1d9c8667cd333dec8880673cb92e60d8eeee929790f88c4f3978c5

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [1.8.0]
+- #191 Email Support via ActionMailer
+- #192 S3 Event Support
+- Turbine after_initializer
+- Improve Jets.boot ordering
+
 ## [1.7.2]
 - #189: spec_helpers: `get` request now converts dangling params to query params. `query` keyword can be used to do the same thing explicitly.
 - #190 SNS Event Lambda Trigger Support

data/README.md

@@ -31,7 +31,7 @@ Jets supports writing AWS Lambda functions with Ruby. You define them in the `ap
 app/functions/simple.rb:
 
 ```ruby
-def handler_function(event:, context:)
+def lambda_handler(event:, context:)
   puts "hello world"
   {hello: "world"}
 end

data/jets.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
 
   # spec.add_dependency "actionpack", "~> 5.2.1" # using vendor/rails version
   # spec.add_dependency "actionview", "~> 5.2.1" # using vendor/rails version
+  spec.add_dependency "actionmailer", "~> 5.2.1"
   spec.add_dependency "activerecord", "~> 5.2.1"
   spec.add_dependency "activesupport", "~> 5.2.1"
   spec.add_dependency "aws-sdk-apigateway"
@@ -39,6 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "aws-sdk-s3"
   spec.add_dependency "aws-sdk-sns"
   spec.add_dependency "aws-sdk-sqs"
+  spec.add_dependency "cfnresponse"
   spec.add_dependency "dotenv"
   spec.add_dependency "gems" # jets-gems dependency
   spec.add_dependency "hashie"

data/lib/jets.rb

@@ -36,6 +36,7 @@ module Jets
   autoload :Klass, 'jets/klass'
   autoload :Lambda, 'jets/lambda'
   autoload :Logger, "jets/logger"
+  autoload :Mailer, "jets/mailer"
   autoload :Mega, "jets/mega"
   autoload :Middleware, "jets/middleware"
   autoload :Naming, 'jets/naming'

data/lib/jets/application.rb

@@ -12,13 +12,33 @@ class Jets::Application
   end
 
   def setup!
-    load_configs
+    load_default_config
+    setup_auto_load_paths
+  end
+
+  def configs!
+    load_environments_config
+    load_db_config
+    set_iam_policy # relies on dependent values, must be called afterwards
+    normalize_env_vars!
+  end
+
+  # After the mimimal template gets build, we need to reload it for the full stack
+  # creation. This allows us to reference IAM policies configs that depend on the
+  # creation of the s3 bucket.
+  def reload_configs!
+    # Tricky: reset only the things that depends on the minimal stack
+    @config.iam_policy = nil
+    configs!
   end
 
   def finish!
+    deprecated_configs_message
     load_inflections
-    setup_auto_load_paths
     load_routes
+    # Load libraries at the end to trigger onload so we can defined options in any order.
+    # Only action_mailer library have been used properly this way so far.
+    require 'action_mailer'
   end
 
   def load_inflections
@@ -98,6 +118,26 @@ class Jets::Application
     config.encoding = ActiveSupport::OrderedOptions.new
     config.encoding.default = "utf-8"
 
+    config.s3_event = ActiveSupport::OrderedOptions.new
+    # These notification_configuration properties correspond to the ruby aws-sdk
+    #   s3.put_bucket_notification_configuration
+    # in jets/s3_bucket_config.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
+    config.s3_event.configure_bucket = true
+    config.s3_event.notification_configuration = {
+      topic_configurations: [
+        {
+          events: ["s3:ObjectCreated:*"],
+          topic_arn: "!Ref SnsTopic", # must use this logical id
+        },
+      ],
+    }
+
+    # So tried to defined this in the jets/mailer.rb Turbine only but jets new requires it
+    # config.action_mailer = ActiveSupport::OrderedOptions.new
+
     config
   end
 
@@ -116,14 +156,11 @@ class Jets::Application
     project_name_line.gsub(/.*=/,'').strip.gsub(/["']/,'') # project_name
   end
 
-  def load_app_config
+  def load_default_config
     @config = default_config
     set_dependent_configs! # things like project_namespace that need project_name
     eval_app_config # this overwrites Jets.config.project_name
     Jets.config.project_name = parse_project_name # Must set again because JETS_PROJECT_NAME is possible
-
-    set_iam_policy # relies on dependent values, must be called afterwards
-    normalize_env_vars!
   end
 
   def eval_app_config
@@ -131,13 +168,6 @@ class Jets::Application
     load app_config # use load instead of require so reload_configs! works
   end
 
-  # After the mimimal template gets build, we need to reload it for the full stack
-  # creation. This allows us to reference IAM policies configs that depend on the
-  # creation of the s3 bucket.
-  def reload_configs!
-    load_configs
-  end
-
   def load_environments_config
     env_file = "#{Jets.root}/config/environments/#{Jets.env}.rb"
     if File.exist?(env_file)
@@ -146,13 +176,6 @@ class Jets::Application
     end
   end
 
-  def load_configs
-    load_app_config
-    load_db_config
-    load_environments_config
-    deprecated_configs_message
-  end
-
   def deprecated_configs_message
     unless config.ruby.lazy_load.nil?
       puts "Detected config.ruby.lazy_load = #{config.ruby.lazy_load.inspect}".color(:yellow)
@@ -195,8 +218,9 @@ class Jets::Application
     internal = File.expand_path("../internal", __FILE__)
     paths = %w[
       app/controllers
-      app/models
+      app/helpers
       app/jobs
+      app/models
     ]
     paths.map { |path| "#{internal}/#{path}" }
   end

data/lib/jets/aws_services.rb

@@ -10,6 +10,8 @@ require "aws-sdk-sqs"
 
 module Jets::AwsServices
   autoload :StackStatus, 'jets/aws_services/stack_status'
+  autoload :S3Bucket, 'jets/aws_services/s3_bucket'
+
   include StackStatus
   extend Memoist
 

data/lib/jets/aws_services/s3_bucket.rb

@@ -0,0 +1,26 @@
+module Jets::AwsServices
+  class S3Bucket
+    include Jets::AwsServices
+
+    def self.ensure_exists(bucket_name)
+      new(bucket_name).ensure_exists
+    end
+
+    def initialize(name)
+      @name = name
+    end
+
+    def ensure_exists
+      s3.create_bucket(bucket: @name) unless exists?
+    end
+
+    def exists?
+      begin
+        s3.head_bucket(bucket: @name)
+        true
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/jets/booter.rb

@@ -10,11 +10,19 @@ class Jets::Booter
       Jets::Dotenv.load!
 
       Jets.application.setup!
+      # eager_load_jets is called to ensure that internal Turbines get loaded after auto_load paths configured in setup!
+      eager_load_jets
+      run_turbines(:initializers)
+      # Load configs after Turbine initializers so Turbines can defined some config options
+      # and they are available in user's project environment configs.
+      Jets.application.configs!
       app_initializers
-      turbine_initializers
+      run_turbines(:after_initializers)
       Jets.application.finish!
 
-      Jets.eager_load!
+      # Eager load project code. Rather have user find out early than late.
+      eager_load_app
+
       setup_db
       # build_middleware_stack # TODO: figure out how to build middleware during Jets.boot without breaking jets new and webpacker:install
 
@@ -51,6 +59,17 @@ class Jets::Booter
       end
     end
 
+    # run_turbines(:initializers)
+    # run_turbines(:after_initializers)
+    def run_turbines(name)
+      Jets::Turbine.subclasses.each do |subclass|
+        hooks = subclass.send(name) || []
+        hooks.each do |label, block|
+          block.call(Jets.application)
+        end
+      end
+    end
+
     # require_bundle_gems called when environment boots up via Jets.boot.  It
     # also useful for when to loading Rake tasks in
     # Jets::Commands::RakeTasks.load!
@@ -127,5 +146,66 @@ class Jets::Booter
         exit 1
       end
     end
+
+    # Eager load jet's lib and classes
+    def eager_load_jets
+      lib_jets = File.expand_path(".", File.dirname(__FILE__))
+      Dir.glob("#{lib_jets}/**/*.rb").select do |path|
+        next if !File.file?(path)
+        next if skip_eager_load_paths?(path)
+
+        path = path.sub("#{lib_jets}/","jets/")
+        class_name = path
+                      .sub(/\.rb$/,'') # remove .rb
+                      .sub(/^\.\//,'') # remove ./
+                      .sub(/app\/\w+\//,'') # remove app/controllers or app/jobs etc
+                      .camelize
+        # special class mappings
+        class_name = class_mappings(class_name)
+        class_name.constantize # use constantize instead of require so dont have to worry about order.
+      end
+    end
+
+    # Skip these paths because eager loading doesnt work for them.
+    # Scope to /jets as much as possible in case it collides with a user path
+    def skip_eager_load_paths?(path)
+      path =~ %r{/jets/builders/rackup_wrappers} ||
+      path =~ %r{/jets/builders/reconfigure_rails} ||
+      path =~ %r{/jets/cli} ||
+      path =~ %r{/jets/commands/templates/webpacker} ||
+      path =~ %r{/jets/controller/middleware/webpacker_setup} ||
+      path =~ %r{/jets/core_ext} ||
+      path =~ %r{/jets/internal/app} ||
+      path =~ %r{/jets/overrides} ||
+      path =~ %r{/jets/spec} ||
+      path =~ %r{/jets/stack} ||
+      path =~ %r{/jets/turbo/project/} ||
+      path =~ %r{/jets/version} ||
+      path =~ %r{/templates/}
+    end
+
+    def class_mappings(class_name)
+      map = {
+        "Jets::Io" => "Jets::IO",
+      }
+      map[class_name] || class_name
+    end
+
+    # Eager load user's application
+    def eager_load_app
+      Dir.glob("#{Jets.root}/app/**/*.rb").select do |path|
+        next if !File.file?(path) or path =~ %r{/javascript/} or path =~ %r{/views/}
+        next if path.include?('app/functions') || path.include?('app/shared/functions') || path.include?('app/internal/functions')
+
+        class_name = path
+                      .sub(/\.rb$/,'') # remove .rb
+                      .sub(%{^\./},'') # remove ./
+                      .sub("#{Jets.root}/",'')
+                      .sub(%r{app/shared/\w+/},'') # remove shared/resources or shared/extensions
+                      .sub(%r{app/\w+/},'') # remove app/controllers or app/jobs etc
+        class_name = class_name.classify
+        class_name.constantize # use constantize instead of require so dont have to worry about order.
+      end
+    end
   end
 end

data/lib/jets/builders/code_builder.rb

@@ -53,7 +53,7 @@ class Jets::Builders
       Md5.compute! # populates Md5.checksums hash
     end
 
-    def generate_node_shims
+    def generate_shims
       headline "Generating shims in the handlers folder."
       # Crucial that the Dir.pwd is in the tmp_code because for
       # Jets::Builders::app_files because Jets.boot set ups
@@ -97,8 +97,8 @@ class Jets::Builders
 
       # Code prep and zipping
       check_code_size!
-      calculate_md5s # must be called before generate_node_shims and create_zip_files
-      generate_node_shims
+      calculate_md5s # must be called before generate_shims and create_zip_files
+      generate_shims
       create_zip_files
     end
 
@@ -106,16 +106,29 @@ class Jets::Builders
       CodeSize.check!
     end
 
-    # We copy the files into the project because we cannot require simple functions
-    # directly since they are wrapped by an anonymous class.
-    # TODO: Do this with the other files we required the same way.
+    # Materialized internal code into actually user Jets app as part of the deploy process.
+    # Examples of things that we might materialize:
+    #
+    #   Views
+    #   Simple Functions
+    #
+    # For functions,  We copy the files into the project because we cannot require
+    # simple functions directly since they are wrapped by an anonymous class.
     def copy_internal_jets_code
       files = []
+
+      mailers_controller = Jets::Router.has_controller?("Jets::MailersController")
+      if mailers_controller
+        files << "app/controllers/jets/mailers_controller.rb"
+        files << "app/views/jets/mailers"
+        files << "app/helpers/jets/mailers_helper.rb"
+      end
+
       files.each do |relative_path|
         src = File.expand_path("../internal/#{relative_path}", File.dirname(__FILE__))
         dest = "#{"#{stage_area}/code"}/#{relative_path}"
         FileUtils.mkdir_p(File.dirname(dest))
-        FileUtils.cp(src, dest)
+        FileUtils.cp_r(src, dest)
       end
     end
 

data/lib/jets/builders/handler_generator.rb

@@ -96,20 +96,31 @@ class Jets::Builders
 
     def internal_shims
       jets_base_path if Jets.custom_domain?
+      s3_bucket_config if Jets.s3_event?
     end
 
     def jets_base_path
-      path = "jets/base_path.rb"
+      copy_function_template("functions/jets/base_path.rb", stage_name: Jets::Resource::ApiGateway::Deployment.stage_name)
+    end
+
+    def s3_bucket_config
+      copy_function_template("shared/functions/jets/s3_bucket_config.rb")
+    end
+
+    # Copy code from internal folder to materialized app code
+    def copy_function_template(path, vars={})
       internal = File.expand_path("../internal", File.dirname(__FILE__))
-      src = "#{internal}/app/functions/#{path}"
-      result = Jets::Erb.result(src, stage_name: Jets::Resource::ApiGateway::Deployment.stage_name)
-      dest = "#{tmp_code}/handlers/functions/#{path}"
+      src = "#{internal}/app/#{path}"
+      result = Jets::Erb.result(src, vars)
+      dest = "#{tmp_code}/handlers/#{path}"
       FileUtils.mkdir_p(File.dirname(dest))
       IO.write(dest, result)
     end
 
     # app/shared/functions/kevin.py => /tmp/jets/demo/app_root/handlers/shared/functions/kevin.py
     def copy_source_as_handler(fun)
+      return if fun.internal?
+
       source_path = fun.source_file
       unless source_path
         attributes = fun.template.values.first
@@ -140,8 +151,11 @@ class Jets::Builders
     end
 
     def shared_ruby_shim(fun)
-      vars = Jets::Builders::ShimVars::Shared.new(fun)
-      generate_handler(vars)
+      # Cant use native_function because that requires task. Just re-implement
+      dest_path = fun.handler_dest
+      source_path = dest_path.sub(/^handlers/,'app')
+      FileUtils.mkdir_p(File.dirname(dest_path))
+      FileUtils.cp(source_path, dest_path)
     end
 
     def common_base_shim

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

@@ -27,29 +27,17 @@ class Jets::Cfn::Builders
         add_parameter(k, Description: k)
       end
 
-      depends_on_params.each do |logical_id, desc|
-        add_parameter(logical_id, Description: desc)
+      depends_on_params.each do |output_key, output_value|
+        desc = output_value.gsub("!GetAtt ", "") # desc doesnt allow !GetAtt
+        add_parameter(output_key, Description: desc)
       end
     end
 
     def depends_on_params
       return {} unless @app_class.depends_on
 
-      params = {}
-      @app_class.depends_on.each do |shared_stack|
-        dependency = shared_stack.to_s.camelize # logical_id
-        dependency_outputs(dependency).each do |output|
-          dependency_class = dependency.to_s.classify
-          desc = "From #{dependency_class}.Outputs.#{output}"
-          # key: logical_id , value: description
-          params[output] = desc
-        end
-      end
-      params
-    end
-
-    def dependency_outputs(dependency)
-      dependency.to_s.classify.constantize.output_keys
+      depends = Jets::Stack::Depends.new(@app_class.depends_on)
+      depends.params
     end
 
     def add_functions