jets 3.1.5 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc8976a98ceaa55f97512b3b0e78cec5f28e1d0ade29d23270894cbcfa1ef5c3
-  data.tar.gz: 149caed9e86daea3f45e745e6f32c28aa0a15b6b938237305e41bc85c774adc4
+  metadata.gz: 8fedba281ee9d6ac31a44184b49bbc8fe15d309a3f4d58142cfa25c4ddebc153
+  data.tar.gz: e73ee950202ea1786c881b43abc95c03bc4c3e7ef44b04265997eca2f4b9211b
 SHA512:
-  metadata.gz: e9a49470b973e8b927c5921a5e373f18d66141d2af0c288fa6a2d0cac4f59fa7a534e1e52bf949d56482f8987843b9f5628d3699f0c27cf4c9cc9f271d6a33c8
-  data.tar.gz: 43e8734b1f3e7b2a7cfb16a1c4d74957fac5e4c1deb090d816d003655775374a8e3c03d473dbd7bc2166a05412562d74f811fe6dbe944237a958c9428f76167a
+  metadata.gz: 57070368542b8a767fbf8553f0c627b36432e691ae07f1f41488a0d8af830bffd1ed84a71633fe971df6b45bcf79ff8862f2d4513d22e4a1981b633f36cbb8bd
+  data.tar.gz: 32ba83eb4d4e87a8c92b5d7ec8d573ae2b36ff558fedbae7bb33f1ebe5dbcb36baf2f64b89b2a05d2e56e52bcd2145964a0770f7a56efdb48d1a925498c7f177

data/.ruby-version

@@ -1 +1 @@
-2.7.5
+2.7.7

data/CHANGELOG.md

@@ -3,6 +3,21 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
 
+## [3.2.1] - 2023-05-03
+- [#637](https://github.com/boltops-tools/jets/pull/637) Readme: Replace "splat out" with "had" a baby
+- [#638](https://github.com/boltops-tools/jets/pull/638) feature: update an array of reserved variables in aws lambda
+- [#639](https://github.com/boltops-tools/jets/pull/639) fix assets upload during deploy
+
+## [3.2.0] - 2022-12-03
+- [#631](https://github.com/boltops-tools/jets/pull/631) Implement vpc_endpoint_ids configuration
+- [#634](https://github.com/boltops-tools/jets/pull/634) Custom domain messaging
+- [#635](https://github.com/boltops-tools/jets/pull/635) smarter apigw routes paging calculation
+- Introduce the storage of APIGW routes state in the jets managed s3 bucket under path jets/state/apigw/pages.json and jets/state/apigw/routes.json
+- This speeds up deployment for apps with a large number of routes. Depending on the internet connection this can be minutes faster.
+- Update internationalization.md
+- fix domain.name check when APIGW changes
+- improve change apigw endpoint change messaging
+
 ## [3.1.5] - 2022-08-08
 - [#628](https://github.com/boltops-tools/jets/pull/628) Multiple Databases
 - [#629](https://github.com/boltops-tools/jets/pull/629) loosen zeitwerk dependency in generated project Gemfile

data/README.md

@@ -2,7 +2,7 @@
   <a href="http://rubyonjets.com"><img src="http://rubyonjets.com/img/logos/jets-logo-full.png" /></a>
 </div>
 
-Ruby and Lambda splat out a baby and that child's name is [Jets](http://rubyonjets.com/).
+Ruby and Lambda had a baby and that child's name is [Jets](http://rubyonjets.com/).
 
 ![Build Status](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiZ08vK2hjOHczQUVoUDhSYnBNNUU4T0gxQWJuOTlLaXpwVGQ1NjJ3NnVDY1dSdFVXQ3d2VXVSQzRFcU1qd1JPMndFZlByRktIcTUrZm5GWlM5dHpjM1ZrPSIsIml2UGFyYW1ldGVyU3BlYyI6Imluc1Qrd25GanhUdHlidjUiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)
 [![CircleCI](https://circleci.com/gh/boltops-tools/jets.svg?style=svg)](https://circleci.com/gh/boltops-tools/jets)
@@ -16,10 +16,6 @@ Please **watch/star** this repo to help grow and support the project.
 
 **Upgrading**: If you are upgrading Jets, please check on the [Upgrading Notes](http://rubyonjets.com/docs/extras/upgrading/).
 
-## Sponsors
-
-[![](https://img.boltops.com/boltops/tools/jets/sponsors/arist.png)](https://arist.co/)
-
 ## What is Ruby on 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.

data/backers.md

@@ -11,10 +11,5 @@ Funds donated via Patreon go directly to support Tung Nguyen's full-time work on
 <h2 align="center">Backers via Patreon</h2>
 
 <!--10 start-->
-- Erlend Finvåg
-- Nate Clark
-- Hirokatsu Endo
-- Michael Choi
-- Phan Lam
 - Theron Welch
 <!--10 end-->

data/lib/jets/application/defaults.rb

@@ -99,6 +99,7 @@ class Jets::Application
       config.api.cors_authorization_type = nil # nil so ApiGateway::Cors#cors_authorization_type handles
       config.api.endpoint_policy = nil # required when endpoint_type is EDGE
       config.api.endpoint_type = 'EDGE' # PRIVATE, EDGE, REGIONAL
+      config.api.vpc_endpoint_ids = nil
 
       config.api.authorizers = ActiveSupport::OrderedOptions.new
       config.api.authorizers.default_token_source = "Auth" # method.request.header.Auth

data/lib/jets/aws_services.rb

@@ -86,10 +86,18 @@ module Jets::AwsServices
       retry_limit: 7, # default: 3
       retry_base_delay: 0.6, # default: 0.3
     }
+    # See debug logger. Noisy.
+    # Example:
+    #     D, [2022-12-02T13:18:55.298788 #26182] DEBUG -- : [Aws::APIGateway::Client 200 0.030837 0 retries] get_method(rest_api_id:"mke40eh6l0",resource_id:"zf8w2m",http_method:"GET")
     options.merge!(
       log_level: :debug,
       logger: Logger.new($stdout),
     ) if ENV['JETS_DEBUG_AWS_SDK']
+    # https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/debugging.html to enable http_wire_trace
+    # See the HTTP headers and JSON responses. Super noisy.
+    options.merge!(
+      http_wire_trace: true,
+    ) if ENV['JETS_DEBUG_AWS_SDK_HTTP_WIRE_TRACE']
     options
   end
 end

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

@@ -49,7 +49,7 @@ module Jets::Cfn::Builders
 
     def add_route53_dns
       dns = Jets::Resource::Route53::RecordSet.new
-      if !existing_domain_name?(dns.domain_name) or existing_dns_record_on_stack? 
+      if !existing_domain_name?(dns.domain_name) or existing_dns_record_on_stack?
         add_resource(dns)
         add_outputs(dns.outputs)
       end
@@ -57,11 +57,11 @@ module Jets::Cfn::Builders
 
     def create_domain_name()
       resource = Jets::Resource::ApiGateway::DomainName.new
-      
+
       return {
         "DomainName" => resource.domain_name
       } if (existing_domain_name?(resource) and !existing_domain_name_on_stack?)
-      
+
       add_resource(resource)
       return resource.outputs
     end
@@ -114,8 +114,9 @@ module Jets::Cfn::Builders
     def add_gateway_routes
       # Reject homepage. Otherwise we have 200 - 1 resources on the first page.
       # There's a next call in ApiResources.add_gateway_resources to skip the homepage.
-      all_paths = Jets::Router.all_paths.reject { |p| p == '' }
-      all_paths.each_slice(PAGE_LIMIT).each_with_index do |paths, i|
+      page_builder = Jets::Cfn::Builders::PageBuilder.new
+      pages = page_builder.build
+      pages.each_with_index do |paths, i|
         ApiResourcesBuilder.new(@options, paths, i+1).build
       end
     end

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

@@ -26,7 +26,26 @@ module Jets::Cfn::Builders
       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: {

data/lib/jets/cfn/ship.rb

@@ -42,6 +42,7 @@ module Jets::Cfn
         exit 1
       end
 
+      save_apigw_state
       prewarm
       clean_deploy_logs
       show_api_endpoint
@@ -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/resource/api_gateway/rest_api/logical_id/message.rb

@@ -8,8 +8,7 @@ class Jets::Resource::ApiGateway::RestApi::LogicalId
     end
 
     def custom_domain
-      api = Jets::Resource::ApiGateway::DomainName.new
-      domain_name = api.domain_name
+      domain_name = Jets.config.domain.name
       if domain_name
         <<~EOL
         It looks like you have already set up a custom domain.
@@ -25,7 +24,18 @@ class Jets::Resource::ApiGateway::RestApi::LogicalId
         More info: custom domain docs: https://rubyonjets.com/docs/routing/custom-domain/
         EOL
       else
-        "Please set up a custom domain https://rubyonjets.com/docs/routing/custom-domain/"
+        <<~EOL
+        To avoid this prompt in the future, you can configure:
+
+        config/application.rb
+
+            config.api.auto_replace = true
+
+        However, you should also set up a custom domain for a "stable" endpoint.
+
+        https://rubyonjets.com/docs/routing/custom-domain/
+
+        EOL
       end
     end
 

data/lib/jets/resource/api_gateway/rest_api/routes/change/base.rb

@@ -7,51 +7,22 @@ class Jets::Resource::ApiGateway::RestApi::Routes::Change
       new.changed?
     end
 
-    # Build up deployed routes from the existing CloudFormation resources.
+    # Recreate routes from previously deployed stored state in s3
     def deployed_routes
-      routes = []
-
-      resources, position = [], true
-      while position
-        position = nil if position == true # start of loop
-        resp = apigateway.get_resources(
-          rest_api_id: rest_api_id,
-          position: position,
-          limit: 500, # default: 25 max: 500
+      state = Jets::Router::State.new
+      data = state.load("routes")
+      return [] if data.nil?
+
+      data.map do |item|
+        Jets::Router::Route.new(
+          path: item['path'],
+          method: item['options']['method'],
+          to: item['to'],
         )
-        resources += resp.items
-        position = resp.position
-      end
-
-      resources.each do |resource|
-        resource_methods = resource.resource_methods
-        next if resource_methods.nil?
-
-        resource_methods.each do |http_verb, resource_method|
-          # puts "#{http_verb} #{resource.path} | resource.id #{resource.id}"
-          # puts to(resource.id, http_verb)
-
-          # Test changing config.cors and CloudFormation does an in-place update
-          # on the resource. So no need to do bluegreen deployments for OPTIONS.
-          next if http_verb == "OPTIONS"
-
-          path = recreate_path(resource.path)
-          method = http_verb.downcase.to_sym
-          to = to(resource.id, http_verb)
-          route = Jets::Router::Route.new(path: path, method: method, to: to)
-          routes << route
-        end
       end
-      routes
     end
     memoize :deployed_routes
 
-    def recreate_path(path)
-      path = path.gsub(%r{^/},'')
-      path = path.gsub(/{([^}]*)\+}/, '*\1')
-      path.gsub(/{([^}]*)}/, ':\1')
-    end
-
     def to(resource_id, http_method)
       uri = method_uri(resource_id, http_method)
       recreate_to(uri) unless uri.nil?

data/lib/jets/resource/api_gateway/rest_api.rb

@@ -5,6 +5,7 @@ module Jets::Resource::ApiGateway
         name: Jets::Naming.gateway_api_name,
         endpoint_configuration: { types: endpoint_types }
       }
+      properties[:endpoint_configuration][:vpc_endpoint_ids] = vpce_ids if vpce_ids
       properties[:binary_media_types] = binary_media_types if binary_media_types
       properties[:policy] = endpoint_policy if endpoint_policy
 
@@ -60,5 +61,14 @@ module Jets::Resource::ApiGateway
 
       endpoint_policy
     end
+
+    private
+
+    def vpce_ids
+      ids = Jets.config.api.vpc_endpoint_ids
+      return nil if ids.nil? || ids.empty?
+
+      ids
+    end
   end
-end
+end

data/lib/jets/resource/lambda/function/environment.rb

@@ -36,21 +36,23 @@ class Jets::Resource::Lambda::Function
       exit 1
     end
 
-    # https://docs.aws.amazon.com/lambda/latest/dg/current-supported-versions.html#lambda-environment-variables
+    # https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html
     def reserved_variables
       %w[
         _HANDLER
+        AWS_DEFAULT_REGION
         AWS_REGION
         AWS_EXECUTION_ENV
         AWS_LAMBDA_FUNCTION_NAME
         AWS_LAMBDA_FUNCTION_MEMORY_SIZE
         AWS_LAMBDA_FUNCTION_VERSION
+        AWS_LAMBDA_INITIALIZATION_TYPE
         AWS_LAMBDA_LOG_GROUP_NAME
         AWS_LAMBDA_LOG_STREAM_NAME
+        AWS_ACCESS_KEY
         AWS_ACCESS_KEY_ID
         AWS_SECRET_ACCESS_KEY
         AWS_SESSION_TOKEN
-        TZ
         LAMBDA_TASK_ROOT
         LAMBDA_RUNTIME_DIR
         AWS_LAMBDA_RUNTIME_API

data/lib/jets/router/route.rb

@@ -191,6 +191,10 @@ class Jets::Router
       @options[:mount_class]
     end
 
+    def to_h
+      JSON.load(to_json)
+    end
+
   private
     def ensure_jets_format(path)
       path.split('/').map do |s|

data/lib/jets/router/state.rb

@@ -0,0 +1,47 @@
+class Jets::Router
+  class State
+    extend Memoist
+    include Jets::AwsServices
+
+    def load(filename)
+      resp = s3.get_object(
+        bucket: Jets.aws.s3_bucket,
+        key: s3_storage_path(filename),
+      )
+      text = resp.body.read
+      JSON.load(text)
+    rescue
+    end
+    memoize :load
+
+    # Save previously deployed APIGW routes state
+    def save(filename, data)
+      # body = Jets::Router.routes.to_json
+      # body = JSON.generate(Jets::Cfn::Builders::PageBuilder.pages)
+      body = data.respond_to?(:to_json) ? data.to_json : JSON.generate(data)
+      s3.put_object(
+        body: body,
+        bucket: Jets.aws.s3_bucket,
+        key: s3_storage_path(filename),
+      )
+    end
+
+    # Examples:
+    #
+    #   jets/state/apigw/pages.json
+    #   jets/state/apigw/routes.json
+    #
+    # Fetch or loaded in:
+    #
+    #   pages.json: Jets::Cfn::Builders::PageBuilder#old_pages
+    #   routes.json: Jets::Resource::ApiGateway::RestApi::Routes::Change::Base#deployed_routes
+    #
+    # Saved in:
+    #
+    #   Jets::Cfn::Ship#save_apigw_state
+    #
+    def s3_storage_path(filename)
+      "jets/state/apigw/#{filename}.json"
+    end
+  end
+end

data/lib/jets/router.rb

@@ -134,6 +134,18 @@ module Jets
         drawn_router.routes
       end
 
+      # So we can save state in s3 post deploy. Example of structure.
+      #
+      #   [
+      #     {"scope"=>{"options"=>{"as"=>"posts", "prefix"=>"posts", "param"=>nil, "from"=>"resources"}, "parent"=>{"options"=>{}, "parent"=>nil, "level"=>1}, "level"=>2}, "options"=>{"to"=>"posts#index", "from_scope"=>true, "path"=>"posts", "method"=>"get"}, "path"=>"posts", "to"=>"posts#index", "as"=>"posts"},
+      #     {"scope"=>{"options"=>{"as"=>"posts", "prefix"=>"posts", "param"=>nil, "from"=>"resources"}, "parent"=>{"options"=>{}, "parent"=>nil, "level"=>1}, "level"=>2}, "options"=>{"to"=>"posts#new", "from_scope"=>true, "path"=>"posts/new", "method"=>"get"}, "path"=>"posts/new", "to"=>"posts#new", "as"=>"new_post"},
+      #     ...
+      #   ]
+      #
+      def to_json
+        JSON.dump(routes.map(&:to_h))
+      end
+
       # Returns all paths including subpaths.
       # Example:
       # Input: ["posts/:id/edit"]

data/lib/jets/version.rb

@@ -1,3 +1,3 @@
 module Jets
-  VERSION = "3.1.5"
+  VERSION = "3.2.1"
 end

data/lib/jets.rb

@@ -17,6 +17,7 @@ require "active_support/ordered_options"
 require "cfn_camelizer"
 require "cfn_status"
 require "fileutils"
+require "json"
 require "memoist"
 require "rainbow/ext/string"
 require "serverlessgems"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jets
 version: !ruby/object:Gem::Version
-  version: 3.1.5
+  version: 3.2.1
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -661,6 +661,7 @@ files:
 - lib/jets/cfn/builders/function_builder.rb
 - lib/jets/cfn/builders/interface.rb
 - lib/jets/cfn/builders/job_builder.rb
+- lib/jets/cfn/builders/page_builder.rb
 - lib/jets/cfn/builders/parent_builder.rb
 - lib/jets/cfn/builders/parent_builder/stagger.rb
 - lib/jets/cfn/builders/rule_builder.rb
@@ -986,6 +987,7 @@ files:
 - lib/jets/router/route.rb
 - lib/jets/router/route/authorizer.rb
 - lib/jets/router/scope.rb
+- lib/jets/router/state.rb
 - lib/jets/router/util.rb
 - lib/jets/rule/base.rb
 - lib/jets/rule/dsl.rb
@@ -1101,7 +1103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.10
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby Serverless Framework