jets 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 662007ebe84e8e8ce5d9a773a4ec6905ed8a1da7caecf8870de788d60e5d337c
-  data.tar.gz: e2a21d607b931d356fda5b743a578534466f65890a38ea7db942c2985eb30570
+  metadata.gz: 61d62ec1deed884ea8ccccd1b6f6cafdbccf8f9778b9ddfb9bc80d827c3b8f2d
+  data.tar.gz: 4edc9600af70c32b175ba077a5d75b55575c030807aa1c1ad26b96914b0c372b
 SHA512:
-  metadata.gz: d5b1d727e2717b042774729a72aa889d35a98759299e3a6e3644527a6774fec05dbaa5669cc91ec92d082444cc980c464e5d887e74e055d273fecd3a27e2cf12
-  data.tar.gz: b625070b21854521ccd111c06190cdc03703a3f336c48ea9370b51e675d21c028068319115cbc3f81a320431b4e480084b9b214fc4853ad89a1688b8aba64a5b
+  metadata.gz: 1ec1dcbb1c0a6a977dcdabbc2138178d43687d1257f40239e2e379400a435f84301f5b5105fb59d36860c9e4a8051c64547770963be63b6ea5a33c0ce4ffc142
+  data.tar.gz: 1e15d436ecf7fa3dea5852023afb2db0544ca56fc21c76c80d8554b8acffd1d98a20acceb1416038257a233bddeac95a3896ceddd4aceee62c505a55370742de

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/), even before v1.0.
 
+## [0.9.2]
+- s3 assets support: Merge pull request #44 from tongueroo/s3-assets
+
 ## [0.9.1]
 - add upgrading notes
 - fix iam policies: flatten

data/Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    jets (0.9.1)
+    jets (0.9.2)
       actionpack (>= 5.2.1)
       actionview (>= 5.2.1)
       activerecord (>= 5.2.1)

data/README.md

@@ -8,6 +8,8 @@ Ruby and Lambda splat out a baby and that child's name is [Jets](http://rubyonje
 [![CircleCI](https://circleci.com/gh/tongueroo/jets.svg?style=svg)](https://circleci.com/gh/tongueroo/jets)
 [![Gem Version](https://badge.fury.io/rb/jets.svg)](https://badge.fury.io/rb/jets)
 
+**Upgrading**: If you are upgrading Jets, please check on the [Upgrading Notes](http://rubyonjets.com/docs/upgrading/).
+
 ## What is Jets?
 
 Jets is a Ruby Serverless Framework.  Jets allows you to create serverless applications with a beautiful language: Ruby.  It includes everything required to build an application and deploy it to AWS Lambda.
@@ -19,8 +21,6 @@ It is key to understand AWS Lambda and API Gateway to understand Jets conceptual
 
 The official documentation is at: [Ruby on Jets](http://rubyonjets.com).
 
-**Upgrading Note**: If you are upgrading Jets, please check on the [Upgrading Notes](http://rubyonjets.com/docs/upgrading/).
-
 Refer to the official docs for more info, but here's a quick intro.
 
 ### Jets Controllers

data/lib/jets/application.rb

@@ -21,6 +21,7 @@ class Jets::Application
     Jets::Inflections.load!
   end
 
+  # Default config
   def config
     config = ActiveSupport::OrderedOptions.new
 
@@ -28,7 +29,7 @@ class Jets::Application
     config.prewarm.enable = true
     config.prewarm.rate = '30 minutes'
     config.prewarm.concurrency = 2
-    config.prewarm.public_ratio = 10
+    config.prewarm.public_ratio = 3
 
     config.lambdagems = ActiveSupport::OrderedOptions.new
     config.lambdagems.sources = [
@@ -38,6 +39,12 @@ class Jets::Application
     config.inflections = ActiveSupport::OrderedOptions.new
     config.inflections.irregular = {}
 
+    config.assets = ActiveSupport::OrderedOptions.new
+    config.assets.folders = %w[packs images assets]
+    config.assets.base_url = nil # IE: https://cloudfront.com/my/base/path
+    config.assets.max_age = 3600
+    config.assets.cache_control = nil # IE: public, max-age=3600 , max_age is a shorter way to set cache_control.
+
     config
   end
   memoize :config

data/lib/jets/builders/code_builder.rb

@@ -53,6 +53,7 @@ class Jets::Builders
   class CodeBuilder
     include Jets::Timing
     include ActionView::Helpers::NumberHelper # number_to_human_size
+    include Jets::AwsServices
 
     attr_reader :full_project_path
     def initialize
@@ -103,9 +104,34 @@ class Jets::Builders
       setup_bundle_config
       extract_ruby
       extract_gems
+      store_s3_base_url
     end
     time :finish_app_root_setup
 
+    # At this point the minimal stack exists.
+    def store_s3_base_url
+      IO.write("#{full(tmp_app_root)}/config/s3_base_url.txt", s3_base_url)
+    end
+
+    def s3_base_url
+      # Allow user to set assets.base_url
+      #
+      #   Jets.application.configure do
+      #     config.assets.base_url = "https://cloudfront.com/my/base/path"
+      #   end
+      #
+      return Jets.config.assets.base_url if Jets.config.assets.base_url
+
+      resp = cfn.describe_stacks(stack_name: Jets::Naming.parent_stack_name)
+      stack = resp.stacks.first
+      output = stack["outputs"].find { |o| o["output_key"] == "S3Bucket" }
+      bucket_name = output["output_value"] # s3_bucket
+      region = Jets.aws.region
+
+      asset_base_url = "https://s3-#{region}.amazonaws.com"
+      "#{asset_base_url}/#{bucket_name}/jets/public" # s3_base_url
+    end
+
     def lambdagem_options
       {
         s3: "lambdagems",

data/lib/jets/cfn/ship.rb

@@ -143,8 +143,17 @@ class Jets::Cfn
     def upload_to_s3
       raise "Did not specify @options[:s3_bucket] #{@options[:s3_bucket].inspect}" unless @options[:s3_bucket]
 
-      bucket_name = @options[:s3_bucket]
+      upload_cfn_templates
+      upload_code
+      upload_assets
+    end
+    time :upload_to_s3
+
+    def bucket_name
+      @options[:s3_bucket]
+    end
 
+    def upload_cfn_templates
       puts "Uploading child CloudFormation templates to S3"
       expression = "#{Jets::Naming.template_path_prefix}-*"
       Dir.glob(expression).each do |path|
@@ -154,7 +163,9 @@ class Jets::Cfn
         obj = s3_resource.bucket(bucket_name).object(key)
         obj.upload_file(path)
       end
+    end
 
+    def upload_code
       md5_code_zipfile = Jets::Naming.md5_code_zipfile
       file_size = number_to_human_size(File.size(md5_code_zipfile))
 
@@ -165,7 +176,60 @@ class Jets::Cfn
       obj.upload_file(md5_code_zipfile)
       puts "Time to upload code to s3: #{pretty_time(Time.now-start_time).colorize(:green)}"
     end
-    time :upload_to_s3
+
+    def upload_assets
+      puts "Uploading public assets"
+      start_time = Time.now
+      asset_folders = Jets.config.assets.folders
+      asset_folders.each do |folder|
+        upload_asset_folder(folder)
+      end
+      puts "Time to upload public assets to s3: #{pretty_time(Time.now-start_time).colorize(:green)}"
+    end
+
+    def upload_asset_folder(folder)
+      expression = "#{Jets.root}public/#{folder}/**/*"
+      group_size = 10
+      Dir.glob(expression).each_slice(group_size) do |paths|
+        threads = []
+        paths.each do |path|
+          next unless File.file?(path)
+
+          regexp = Regexp.new(".*/#{folder}/")
+          relative_path = path.sub(regexp,'')
+          file = "#{folder}/#{relative_path}"
+
+          threads << Thread.new do
+            upload_asset_file(file)
+          end
+        end
+        threads.each(&:join)
+      end
+    end
+
+    def upload_asset_file(file)
+      path = "#{Jets.root}public/#{file}"
+      key = "jets/public/#{file}"
+      puts "Uploading s3://#{bucket_name}/#{key}" # uncomment to see and debug
+      obj = s3_resource.bucket(bucket_name).object(key)
+      obj.upload_file(path, acl: "public-read", cache_control: cache_control)
+    end
+
+    # If cache_control is provided, then it will set the entire cache-control header.
+    # If only max_age is provided, then we'll generate a cache_control header.
+    # Using max_age is the shorter and simply way of setting the cache_control header.
+    def cache_control
+      cache_control = Jets.config.assets.cache_control
+      unless cache_control
+        max_age = Jets.config.assets.max_age # defaults to 3600 in jets/application.rb
+        cache_control = "public, max-age=#{max_age}"
+      end
+      cache_control
+    end
+
+    def s3_bucket
+      @options[:s3_bucket]
+    end
 
     # http://stackoverflow.com/questions/4175733/convert-duration-to-hoursminutesseconds-or-similar-in-rails-3-or-ruby
     def pretty_time(total_seconds)

data/lib/jets/commands/deploy.rb

@@ -14,26 +14,29 @@ module Jets::Commands
       return if @options[:noop]
 
       check_dev_mode
-      build_code
       validate_routes!
 
       # Delete existing rollback stack from previous bad minimal deploy
-      if minimal_rollback_complete?
-        puts "Existing stack is in ROLLBACK_COMPLETE state from a previous failed minimal deploy. Deleting stack and continuing."
-        cfn.delete_stack(stack_name: stack_name)
-        status.wait
-        status.reset
-      end
+      delete_minimal_stack if minimal_rollback_complete?
+      exit_unless_updateable! # Stack could be in a weird rollback state or in progress state
+      ship(stack_type: :minimal) if first_run?
 
-      # Stack could be in a weird rollback state or in progress state
-      exit_unless_updateable!
+      # Build code after the minimal stack because need s3 bucket for assets
+      # on_aws? and s3_base_url logic
+      build_code
 
-      ship(stack_type: :minimal) if first_run?
       # deploy full nested stack when stack already exists
       ship(stack_type: :full, s3_bucket: s3_bucket)
     end
     time :run
 
+    def delete_minimal_stack
+      puts "Existing stack is in ROLLBACK_COMPLETE state from a previous failed minimal deploy. Deleting stack and continuing."
+      cfn.delete_stack(stack_name: stack_name)
+      status.wait
+      status.reset
+    end
+
     def check_dev_mode
       if File.exist?("#{Jets.root}dev.mode")
         puts "The dev.mode file exists. Please removed it and run bundle update before you deploy.".colorize(:red)

data/lib/jets/commands/templates/skeleton/app/views/layouts/application.html.erb.tt

@@ -8,6 +8,7 @@
   <title>Jets App</title>
   <%%= javascript_pack_tag "application" %>
   <%%= stylesheet_pack_tag "theme" %>
+  <link rel="shortcut icon" href="<%%= asset_path("/images/favicon.ico") %>">
 </head>
 <body>
 <section class="starter">

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

@@ -5,11 +5,13 @@ Jets.application.configure do
   # config.prewarm.enable = true # default is true
   # config.prewarm.rate = '30 minutes' # default is '30 minutes'
   # config.prewarm.concurrency = 2 # default is 2
-  # config.prewarm.public_ratio = 10 # default is 10
+  # config.prewarm.public_ratio = 3 # default is 3
 
   # config.env_extra = 2 # can also set this with JETS_ENV_EXTRA
   # config.extra_autoload_paths = []
 
+  # config.asset_base_url = 'https://cloudfront.domain.com/assets' # example
+
   config.cors = true # for '*''
   # config.cors = '*.mydomain.com' # for specific domain
 
@@ -30,4 +32,10 @@ Jets.application.configure do
   # 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.
+
+  # Assets settings
+  # config.assets.folders = %w[packs images assets] # default packs images assets
+  # config.assets.base_url = nil # IE: https://cloudfront.com/my/base/path , defaults to use s3
+  # config.assets.max_age = 3600 # when to expire assets
+  # config.assets.cache_control = nil # IE: public, max-age=3600 , max_age is a shorter way to set cache_control.
 end

data/lib/jets/preheat.rb

@@ -29,6 +29,7 @@ module Jets
     def warm_all
       threads = []
       all_functions.each do |function_name|
+        next if function_name.include?('jets-public_controller') # handled by warm_public_controller_more
         threads << Thread.new do
           warm(function_name)
         end

data/lib/jets/rails_overrides/asset_tag_helper.rb

@@ -1,17 +1,56 @@
 # Override to prepend stage name when on AWS.
 module Jets::AssetTagHelper
+  extend Memoist
   include Jets::CommonMethods
+  include Jets::AwsServices
 
   def javascript_include_tag(*sources, **options)
-    sources = sources.map { |s| stage_name_asset_url(s, :javascripts) }
+    sources = sources.map { |s| s3_asset_url(s, :javascripts) }
     super
   end
 
   def stylesheet_link_tag(*sources, **options)
-    sources = sources.map { |s| stage_name_asset_url(s, :stylesheets) }
+    sources = sources.map { |s| s3_asset_url(s, :stylesheets) }
     super
   end
 
+  # Locally:
+  #
+  #   image_tag("jets.png") => /images/jets.png
+  #   image_tag("/images/jets.png") => /images/jets.png
+  #
+  # Remotely:
+  #
+  #   image_tag("jets.png") => https://s3-us-west-2.amazonaws.com/demo-dev-s3bucket-1kih4n2te0n66/jets/public/images/jets.png
+  def image_tag(source, options = {})
+    # mimic original behavior to get /images in source
+    source = "/images/#{source}" unless source.starts_with?('/')
+    if on_aws?(source)
+      source = "#{s3_base_url}#{source}"
+    end
+
+    super
+  end
+
+  def asset_path(source, options = {})
+    if on_aws?(source) && asset_folder?(source)
+      # mimic original behavior to get /images in source
+      source = "/images/#{source}" unless source.starts_with?('/')
+      source = "#{s3_base_url}#{source}"
+    end
+
+    super
+  end
+
+private
+  # Whatever is configured in Jets.config.assets.folders
+  # Example: packs, images, assets
+  def asset_folder?(url)
+    Jets.config.assets.folders.detect do |folder|
+      url.include?(folder)
+    end
+  end
+
   # User can use:
   #  javascript_include_tag "assets/test"
   #
@@ -30,12 +69,25 @@ module Jets::AssetTagHelper
   # If there's a / in front then rails will not add the "javascript":
   # So we can add the javascript ourselves and then add the stag with a
   # / in front.
-  def stage_name_asset_url(url, asset_type)
+  def s3_asset_url(url, asset_type)
     unless url.starts_with?('/') or url.starts_with?('http')
       url = "/#{asset_type}/#{url}" # /javascript/asset/test
     end
-    url = add_stage_name(url)
-    url
+    add_s3_base_url(url)
+  end
+
+  # Example:
+  # Url: /packs/application-e7654c50abd78161b641.js
+  # Returns: https://s3-us-west-2.amazonaws.com/demo-dev-s3bucket-1jg5o076egkk4/jets/public/packs/application-e7654c50abd78161b641.js
+  def add_s3_base_url(url)
+    return url unless on_aws?(url)
+    "#{s3_base_url}#{url}"
+  end
+
+  def s3_base_url
+    # s3_base_url.txt is created as part of the build process
+    IO.read("#{Jets.root}config/s3_base_url.txt").strip
   end
+  memoize :s3_base_url
 end
 ActionView::Helpers.send(:include, Jets::AssetTagHelper)

data/lib/jets/rails_overrides/common_methods.rb

@@ -1,13 +1,13 @@
 module Jets::CommonMethods
   # Add API Gateway Stage Name
   def add_stage_name(url)
-    if request.host.include?("amazonaws.com") &&
-            url.starts_with?('/') &&
-            !url.starts_with?('http')
-      stage_name = Jets::Resource::ApiGateway::Deployment.stage_name
-      url = "/#{stage_name}#{url}"
-    end
+    return url unless on_aws?(url)
 
-    url
+    stage_name = Jets::Resource::ApiGateway::Deployment.stage_name
+    "/#{stage_name}#{url}"
+  end
+
+  def on_aws?(url)
+    request.host.include?("amazonaws.com") && url.starts_with?('/')
   end
 end

data/lib/jets/rails_overrides/url_helper.rb

@@ -19,8 +19,7 @@ module Jets::UrlHelper
             raise ArgumentError, "Please provided a String to link_to as the the second argument. The Jets link_to helper takes as the second argument."
           end
 
-    url = add_stage_name(url)
-    url
+    add_stage_name(url)
   end
 end # UrlHelper
 ActionView::Helpers.send(:include, Jets::UrlHelper)

data/lib/jets/version.rb

@@ -1,3 +1,3 @@
 module Jets
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jets
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-25 00:00:00.000000000 Z
+date: 2018-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -541,7 +541,7 @@ files:
 - lib/jets/commands/templates/skeleton/public/404.html
 - lib/jets/commands/templates/skeleton/public/422.html
 - lib/jets/commands/templates/skeleton/public/500.html
-- lib/jets/commands/templates/skeleton/public/favicon.ico
+- lib/jets/commands/templates/skeleton/public/images/favicon.ico
 - lib/jets/commands/templates/skeleton/public/index.html.tt
 - lib/jets/commands/templates/skeleton/spec/controllers/posts_controller_spec.rb
 - lib/jets/commands/templates/skeleton/spec/fixtures/payloads/posts-index.json