jets 1.5.9 → 1.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 139636b38cc75e1677d5590c3ed58b2aa62615d8eb0ab2881e10617a7ecbcf42
-  data.tar.gz: e319b191d08ed15475f644c8348edac60e8a55c9e21f9b4aa8b3605a12fa6f10
+  metadata.gz: 39b6cde7b66e43e4c253e0f055952680298287d9e7c534c4a465ca075b3dfb62
+  data.tar.gz: d3312104416979ca67bd31cebd3a7c2ba604185349c2c368de438d50a68914ef
 SHA512:
-  metadata.gz: e1dbcc0bf66eb73a9d2ff93b1ba95044d4026734beff95bf16ead0ff3f2c5d2461738cf3ff82fc0f116729024a4a7c4ffb49d5bf7babe6469be6145610ca55c8
-  data.tar.gz: 3f6987b22c59c6dfdd294cfd81ce1de23eec5e386ec7b82b91c698c9a6956874f479a5bb31274790b511953329eca208a98eab7a98b33b7483448229ddc772bd
+  metadata.gz: 1b670d6b6a2c0189fd608d4a7ba61a02206a4ddf78d2c8eda2c4f06d8c4c1beddb2588b417211e697ea0b24f8c426975c9ab08819a56fc3da41f6c959fb272ca
+  data.tar.gz: c84383ea55a03f9b0576fb5ea7c4a895a9e5ae818bd79df008a9e7f621f93ce2d5e4e189d7f4aa9a9a2c0fef12ae7a668747308b263785de0b8d0c46da8330f7

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.
 
+## [1.5.10]
+- #157 Improve Route Change Detection: Path Variables
+
 ## [1.5.9]
 - #154 from tongueroo/variable-collision raise error on multiple sibling variable paths collision
 - #156 from konnected-io/master: don't prewarm jobs, only prewarm controllers

data/Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    jets (1.5.9)
+    jets (1.5.10)
       activerecord (~> 5.2.1)
       activesupport (~> 5.2.1)
       aws-sdk-apigateway
@@ -66,7 +66,7 @@ GEM
       tzinfo (~> 1.1)
     arel (9.0.0)
     aws-eventstream (1.0.1)
-    aws-partitions (1.132.0)
+    aws-partitions (1.133.0)
     aws-sdk-apigateway (1.23.0)
       aws-sdk-core (~> 3, >= 3.39.0)
       aws-sigv4 (~> 1.0)
@@ -87,7 +87,7 @@ GEM
     aws-sdk-kms (1.13.0)
       aws-sdk-core (~> 3, >= 3.39.0)
       aws-sigv4 (~> 1.0)
-    aws-sdk-lambda (1.16.0)
+    aws-sdk-lambda (1.17.0)
       aws-sdk-core (~> 3, >= 3.39.0)
       aws-sigv4 (~> 1.0)
     aws-sdk-s3 (1.30.1)

data/lib/jets/commands/new.rb

@@ -134,6 +134,7 @@ JS
 
           Scaffold example:
             jets generate scaffold Post title:string body:text published:boolean
+            jets db:create db:migrate
 
           To deploy to AWS Lambda, edit your .env.development.remote and add a DATABASE_URL endpoint.
           Then run:

data/lib/jets/resource/api_gateway/base_path/role.rb

@@ -55,7 +55,7 @@ module Jets::Resource::ApiGateway::BasePath
     # Duplicated in rest_api/change_detection.rb, base_path/role.rb, rest_api/routes.rb
     def rest_api_id
       stack_name = Jets::Naming.parent_stack_name
-      return default unless stack_exists?(stack_name)
+      return "RestApi" unless stack_exists?(stack_name)
 
       stack = cfn.describe_stacks(stack_name: stack_name).stacks.first
 

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

@@ -6,7 +6,6 @@ class Jets::Resource::ApiGateway::RestApi
     def get
       return default unless stack_exists?(parent_stack_name) && api_gateway_exists?
 
-
       if changed?
         new_id
       else

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

@@ -1,114 +1,12 @@
 # Detects route changes
 class Jets::Resource::ApiGateway::RestApi::Routes
-  class Change < Base
-    def changed?
-      deployed_routes.each do |deployed_route|
-        new_route = find_comparable_route(deployed_route)
-        if new_route && new_route.to != deployed_route.to
-          # change in already deployed route has been detected, requires bluegreen deploy
-          return true
-        end
-      end
-      false # Reaching here means no routes have been changed in a way that requires a bluegreen deploy
-    end
-
-    # Build up deployed routes from the existing CloudFormation resources.
-    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,
-        )
-        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)
+  class Change
+    autoload :Base, 'jets/resource/api_gateway/rest_api/routes/change/base'
+    autoload :To, 'jets/resource/api_gateway/rest_api/routes/change/to'
+    autoload :Variable, 'jets/resource/api_gateway/rest_api/routes/change/variable'
 
-          # 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::Route.new(path: path, method: method, to: to)
-          routes << route
-        end
-      end
-      routes
-    end
-    memoize :deployed_routes
-
-    # Find a route that has the same path and method. This is a comparable route
-    # Then we will compare the to or controller action to see if an already
-    # deployed route has been changed.
-    def find_comparable_route(deployed_route)
-      new_routes.find do |new_route|
-        new_route.path == deployed_route.path &&
-        new_route.method == deployed_route.method
-      end
-    end
-
-    def recreate_path(path)
-      path = path.gsub(%r{^/},'')
-      path = path.sub(/{(.*)\+}/, '*\1')
-      path.sub(/{(.*)}/, ':\1')
-    end
-
-    def to(resource_id, http_method)
-      uri = method_uri(resource_id, http_method)
-      recreate_to(uri) unless uri.nil?
-    end
-
-    def method_uri(resource_id, http_method)
-      resp = apigateway.get_method(
-        rest_api_id: rest_api_id,
-        resource_id: resource_id,
-        http_method: http_method
-      )
-      resp.method_integration.uri
-    end
-
-    # Parses method uri and recreates a Route to argument.
-    # So:
-    #   "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:112233445566:function:demo-test-posts_controller-new/invocations"
-    # Returns:
-    #   posts#new
-    def recreate_to(method_uri)
-      md = method_uri.match(/function:(.*)\//)
-      function_name = md[1] # IE: demo-dev-posts_controller-new
-      controller_action = function_name.sub("#{Jets.project_namespace}-", '')
-      md = controller_action.match(/(.*)_controller-(.*)/)
-      controller = md[1]
-      controller = controller.gsub('-','/')
-      action = md[2]
-      "#{controller}##{action}" # IE: posts#new
-    end
-
-    # Duplicated in rest_api/change_detection.rb, base_path/role.rb, rest_api/routes.rb
-    def rest_api_id
-      stack_name = Jets::Naming.parent_stack_name
-      return default unless stack_exists?(stack_name)
-
-      stack = cfn.describe_stacks(stack_name: stack_name).stacks.first
-
-      api_gateway_stack_arn = lookup(stack[:outputs], "ApiGateway")
-
-      # resources = cfn.describe_stack_resources(stack_name: api_gateway_stack_arn).stack_resources
-      stack = cfn.describe_stacks(stack_name: api_gateway_stack_arn).stacks.first
-      lookup(stack[:outputs], "RestApi") # rest_api_id
+    def changed?
+      To.changed? || Variable.changed? || ENV['JETS_REPLACE_API']
     end
-    memoize :rest_api_id
   end
 end

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

@@ -0,0 +1,100 @@
+class Jets::Resource::ApiGateway::RestApi::Routes::Change
+  class Base
+    extend Memoist
+    include Jets::AwsServices
+
+    # Build up deployed routes from the existing CloudFormation resources.
+    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,
+        )
+        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::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.sub(/{(.*)\+}/, '*\1')
+      path.sub(/{(.*)}/, ':\1')
+    end
+
+    def to(resource_id, http_method)
+      uri = method_uri(resource_id, http_method)
+      recreate_to(uri) unless uri.nil?
+    end
+
+    def method_uri(resource_id, http_method)
+      resp = apigateway.get_method(
+        rest_api_id: rest_api_id,
+        resource_id: resource_id,
+        http_method: http_method
+      )
+      resp.method_integration.uri
+    end
+
+    # Parses method uri and recreates a Route to argument.
+    # So:
+    #   "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:112233445566:function:demo-test-posts_controller-new/invocations"
+    # Returns:
+    #   posts#new
+    def recreate_to(method_uri)
+      md = method_uri.match(/function:(.*)\//)
+      function_name = md[1] # IE: demo-dev-posts_controller-new
+      controller_action = function_name.sub("#{Jets.project_namespace}-", '')
+      md = controller_action.match(/(.*)_controller-(.*)/)
+      controller = md[1]
+      controller = controller.gsub('-','/')
+      action = md[2]
+      "#{controller}##{action}" # IE: posts#new
+    end
+
+    # Duplicated in rest_api/change_detection.rb, base_path/role.rb, rest_api/routes.rb
+    def rest_api_id
+      stack_name = Jets::Naming.parent_stack_name
+      return "RestApi" unless stack_exists?(stack_name)
+
+      stack = cfn.describe_stacks(stack_name: stack_name).stacks.first
+
+      api_gateway_stack_arn = lookup(stack[:outputs], "ApiGateway")
+
+      # resources = cfn.describe_stack_resources(stack_name: api_gateway_stack_arn).stack_resources
+      stack = cfn.describe_stacks(stack_name: api_gateway_stack_arn).stacks.first
+      lookup(stack[:outputs], "RestApi") # rest_api_id
+    end
+    memoize :rest_api_id
+
+    def new_routes
+      Jets::Router.routes
+    end
+    memoize :new_routes
+  end
+end

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

@@ -0,0 +1,29 @@
+# Detects route to changes
+class Jets::Resource::ApiGateway::RestApi::Routes::Change
+  class To < Base
+    def self.changed?
+      new.changed?
+    end
+
+    def changed?
+      deployed_routes.each do |deployed_route|
+        new_route = find_comparable_route(deployed_route)
+        if new_route && new_route.to != deployed_route.to
+          # change in already deployed route has been detected, requires bluegreen deploy
+          return true
+        end
+      end
+      false # Reaching here means no routes have been changed in a way that requires a bluegreen deploy
+    end
+
+    # Find a route that has the same path and method. This is a comparable route
+    # Then we will compare the to or controller action to see if an already
+    # deployed route has been changed.
+    def find_comparable_route(deployed_route)
+      new_routes.find do |new_route|
+        new_route.path == deployed_route.path &&
+        new_route.method == deployed_route.method
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# Detects route variable changes
+class Jets::Resource::ApiGateway::RestApi::Routes::Change
+  class Variable < Base
+    def self.changed?
+      new.changed?
+    end
+
+    def changed?
+      changed = false
+      deployed_routes.each do |deployed_route|
+        parent = collision.variable_parent(deployed_route.path)
+        parent_variables = collision.parent_variables(parent, [deployed_route.path])
+        new_parent_variables = collision.parent_variables(parent, new_paths)
+
+        changed = parent_variables.size > 0 && new_parent_variables.size > 0 &&
+                  parent_variables != new_parent_variables
+        break if changed
+      end
+      changed
+    end
+
+    # Only consider paths with variables
+    def new_paths
+      new_routes.map(&:path).select {|p| p.include?(':')}.uniq
+    end
+
+    # Only consider deployed routes with variables
+    def deployed_routes
+      deployed_routes = super
+      deployed_routes.select do |route|
+        route.path.include?(':')
+      end
+    end
+
+    def collision
+      @collision ||= Jets::Resource::ApiGateway::RestApi::Routes::Collision.new
+    end
+  end
+end

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

@@ -1,16 +1,15 @@
 # Detects path variable collisions
 class Jets::Resource::ApiGateway::RestApi::Routes
-  class Collision < Base
+  class Collision
     autoload :VariableException, 'jets/resource/api_gateway/rest_api/routes/collision/variable_exception'
 
     attr_reader :collisions
-    def initialize(routes)
-      @routes = routes
+    def initialize
       @collisions = []
     end
 
-    def collision?
-      paths = paths_with_variables(@routes.map(&:path))
+    def collision?(paths)
+      paths = paths_with_variables(paths)
       parents = variable_parents(paths)
 
       collide = false
@@ -21,7 +20,11 @@ class Jets::Resource::ApiGateway::RestApi::Routes
     end
 
     def exception
-      collision_message = <<~EOL
+      VariableException.new(collision_message)
+    end
+
+    def collision_message
+      <<~EOL
         There are routes with sibling variables under the same parent that collide.
 
         Collisions:
@@ -34,7 +37,6 @@ class Jets::Resource::ApiGateway::RestApi::Routes
         Please check your `config/routes.rb` and remove the colliding routes.
         More info: http://rubyonjets.com/docs/considerations-api-gateway/
       EOL
-      VariableException.new(collision_message)
     end
 
     def variable_collision_exists?(parent, paths)
@@ -88,13 +90,9 @@ class Jets::Resource::ApiGateway::RestApi::Routes
       parents.uniq.sort
     end
 
-    def paths_with_variables(paths)
-      paths.select { |p| p.include?(':') }.uniq
-    end
-
     # Strips the path down until only the leaf node part is a variable
     # Example: users/:user_id/posts/:post_id/edit
-    # Returns: users/:user_id/posts/:post_id
+    # Returns: users/:user_id/posts
     def variable_parent(path)
       path = variable_leaf(path)
       # drop last variable to leave behind the parent
@@ -105,7 +103,7 @@ class Jets::Resource::ApiGateway::RestApi::Routes
     # Example: users/:user_id/posts/:post_id/edit
     # Returns: users/:user_id/posts
     def variable_leaf(path)
-      return unless path.include?(':')
+      return '' unless path.include?(':')
 
       parts = path.split('/')
       is_variable = parts.last.include?(':')
@@ -115,5 +113,9 @@ class Jets::Resource::ApiGateway::RestApi::Routes
       end
       parts[0..-1].join('/') # parent
     end
+
+    def paths_with_variables(paths)
+      paths.select { |p| p.include?(':') }.uniq
+    end
   end
 end

data/lib/jets/router.rb

@@ -16,8 +16,9 @@ module Jets
 
     # Validate routes that deployable
     def check_collision!
-      collision = Jets::Resource::ApiGateway::RestApi::Routes::Collision.new(self.routes)
-      collide = collision.collision?
+      paths = self.routes.map(&:path)
+      collision = Jets::Resource::ApiGateway::RestApi::Routes::Collision.new
+      collide = collision.collision?(paths)
       raise collision.exception if collide
     end
 

data/lib/jets/version.rb

@@ -1,3 +1,3 @@
 module Jets
-  VERSION = "1.5.9"
+  VERSION = "1.5.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jets
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.5.10
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2019-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -704,8 +704,10 @@ files:
 - lib/jets/resource/api_gateway/rest_api/change_detection.rb
 - lib/jets/resource/api_gateway/rest_api/logical_id.rb
 - lib/jets/resource/api_gateway/rest_api/routes.rb
-- lib/jets/resource/api_gateway/rest_api/routes/base.rb
 - lib/jets/resource/api_gateway/rest_api/routes/change.rb
+- lib/jets/resource/api_gateway/rest_api/routes/change/base.rb
+- lib/jets/resource/api_gateway/rest_api/routes/change/to.rb
+- lib/jets/resource/api_gateway/rest_api/routes/change/variable.rb
 - lib/jets/resource/api_gateway/rest_api/routes/collision.rb
 - lib/jets/resource/api_gateway/rest_api/routes/collision/variable_exception.rb
 - lib/jets/resource/associated.rb

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

@@ -1,11 +0,0 @@
-class Jets::Resource::ApiGateway::RestApi::Routes
-  class Base
-    extend Memoist
-    include Jets::AwsServices
-
-    def new_routes
-      Jets::Router.routes
-    end
-    memoize :new_routes
-  end
-end