jets 5.0.14 → 6.0.0.beta1

data/lib/jets/cfn/builder/api/deployment.rb

@@ -1,46 +0,0 @@
-module Jets::Cfn::Builder::Api
-  class Deployment < Base
-    # interface method
-    def compose
-      deployment = Jets::Cfn::Resource::ApiGateway::Deployment.new
-      add_resource(deployment)
-      add_parameters(deployment.parameters)
-      add_outputs(deployment.outputs)
-    end
-
-    # Because Jets generates a new timestamped logical id for the API Deployment
-    # resource it also creates a new root base path mapping and fails.  Additionally,
-    # the base path mapping depends on the API Deploy for the stage name.
-    #
-    # We resolve this by using a custom resource that does an in-place update.
-    #
-    # Note, also tried to change the domain name of to something like demo-dev-[random].mydomain.com
-    # but that does not work because the domain name has to match the route53 record exactly.
-    #
-    def add_base_path_mapping
-      return unless Jets.custom_domain?
-
-      function = Jets::Cfn::Resource::ApiGateway::BasePath::Function.new
-      add_resource(function)
-      add_outputs(function.outputs)
-
-      mapping = Jets::Cfn::Resource::ApiGateway::BasePath::Mapping.new
-      add_resource(mapping)
-      add_outputs(mapping.outputs)
-
-      iam_role = Jets::Cfn::Resource::ApiGateway::BasePath::Role.new
-      add_resource(iam_role)
-      add_outputs(iam_role.outputs)
-    end
-
-    # interface method
-    def template_path
-      Jets::Names.api_deployment_template_path
-    end
-
-    # do not write a template if routes are empty
-    def write
-      super unless Jets::Router.no_routes?
-    end
-  end
-end

data/lib/jets/cfn/builder/api/gateway.rb

@@ -1,104 +0,0 @@
-module Jets::Cfn::Builder::Api
-  class Gateway < Base
-    # interface method
-    def compose
-      add_gateway_rest_api # changes parent template
-      add_custom_domain    # changes parent template
-    end
-
-    # interface method
-    def template_path
-      Jets::Names.api_gateway_template_path
-    end
-
-    # do write a template if routes are empty
-    def write
-      super unless Jets::Router.no_routes?
-    end
-
-    # If the are routes in config/routes.rb add Gateway API in parent stack
-    def add_gateway_rest_api
-      rest_api = Jets::Cfn::Resource::ApiGateway::RestApi.new
-      add_resource(rest_api)
-      add_outputs(rest_api.outputs)
-
-      deployment = Jets::Cfn::Resource::ApiGateway::Deployment.new
-      outputs = deployment.outputs(true)
-      add_output(:RestApiUrl, Value: outputs[:RestApiUrl])
-    end
-
-    def add_custom_domain
-      return unless Jets.custom_domain?
-      add_domain_name
-      add_route53_dns if Jets.config.domain.route53
-    end
-
-    def add_domain_name
-      add_outputs(create_domain_name)
-    end
-
-    def add_route53_dns
-      dns = Jets::Cfn::Resource::Route53::RecordSet.new
-      if !existing_domain_name?(dns.domain_name) or existing_dns_record_on_stack?
-        add_resource(dns)
-        add_outputs(dns.outputs)
-      end
-    end
-
-    def create_domain_name
-      resource = Jets::Cfn::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
-
-    def existing_domain_name?(resource)
-      apigateway.get_domain_name(
-        domain_name: resource.domain_name
-      )
-      true
-    # IE: Aws::APIGateway::Errors::NotFoundException Invalid domain name identifier specified
-    rescue Aws::APIGateway::Errors::NotFoundException
-      false
-    end
-    memoize :existing_domain_name?
-
-    def existing_domain_name_on_stack?
-      cfn.describe_stack_resource(
-        stack_name: api_gateway_physical_resource_id,
-        logical_resource_id: "DomainName"
-      )
-      true
-    # IE: Aws::CloudFormation::Errors::ValidationError (Resource DomainName does not exist for stack demo-dev)
-    rescue Aws::CloudFormation::Errors::ValidationError
-      false
-    end
-
-    def existing_dns_record_on_stack?
-      cfn.describe_stack_resource(
-        stack_name: api_gateway_physical_resource_id,
-        logical_resource_id: "DnsRecord"
-      )
-      true
-    # IE: Aws::CloudFormation::Errors::ValidationError (Resource DnsRecord does not exist for stack demo-dev)
-    rescue Aws::CloudFormation::Errors::ValidationError
-      false
-    end
-
-    def api_gateway_physical_resource_id
-      resp = cfn.describe_stack_resource(
-        stack_name: Jets::Names.parent_stack_name,
-        logical_resource_id: "ApiGateway"
-      )
-      resp&.stack_resource_detail&.physical_resource_id
-    # IE: Aws::CloudFormation::Errors::ValidationError (Resource ApiGateway does not exist for stack demo-dev)
-    rescue Aws::CloudFormation::Errors::ValidationError
-      nil
-    end
-    memoize :api_gateway_physical_resource_id
-  end
-end

data/lib/jets/cfn/builder/api/mapping.rb

@@ -1,54 +0,0 @@
-module Jets::Cfn::Builder::Api
-  class Mapping < Base
-    # interface method
-    def compose
-      add_parameters(parameters)
-      add_base_path_mapping
-    end
-
-    def parameters
-      p = {
-        GemLayer: "GemLayer",
-        IamRole: "IamRole",
-        RestApi: "RestApi",
-        S3Bucket: "S3Bucket",
-      }
-      p[:DomainName] = "DomainName" if Jets.custom_domain?
-      p[:BasePath] = "BasePath"
-      p
-    end
-
-    # Because Jets generates a new timestamped logical id for the API Deployment
-    # resource it also creates a new root base path mapping and fails.  Additionally,
-    # the base path mapping depends on the API Deploy for the stage name.
-    #
-    # We resolve this by using a custom resource that does an in-place update.
-    #
-    # Note, also tried to change the domain name of to something like demo-dev-[random].mydomain.com
-    # but that does not work because the domain name has to match the route53 record exactly.
-    #
-    def add_base_path_mapping
-      function = Jets::Cfn::Resource::ApiGateway::BasePath::Function.new
-      add_resource(function)
-      add_outputs(function.outputs)
-
-      mapping = Jets::Cfn::Resource::ApiGateway::BasePath::Mapping.new
-      add_resource(mapping)
-      add_outputs(mapping.outputs)
-
-      iam_role = Jets::Cfn::Resource::ApiGateway::BasePath::Role.new
-      add_resource(iam_role)
-      add_outputs(iam_role.outputs)
-    end
-
-    # interface method
-    def template_path
-      Jets::Names.api_mapping_template_path
-    end
-
-    # do not write a template unless custom domain is used
-    def write
-      super if Jets.custom_domain?
-    end
-  end
-end

data/lib/jets/cfn/builder/api/methods.rb

@@ -1,72 +0,0 @@
-module Jets::Cfn::Builder::Api
-  class Methods < Paged
-    # interface method
-    def compose
-      return if routes.empty?
-      add_api_methods
-      add_api_gateway_parameters
-    end
-
-    # Resources Example (only showing keys we care about):
-    #
-    #   UpIndexGetApiMethod:
-    #     Type: AWS::ApiGateway::Method
-    #     Properties:
-    #       ResourceId: !Ref UpApiResource
-    #       RestApiId: !Ref RestApi
-    #       Integration:
-    #         Uri: !Sub arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${UpControllerIndexLambdaFunction}/invocations
-    #
-    def add_api_methods
-      routes.each_with_index do |route, i|
-        method = Jets::Cfn::Resource::ApiGateway::Method.new(route)
-        add_resource(method)
-      end
-    end
-
-    def add_api_gateway_parameters
-      api_methods = Jets::Cfn::Params::Api::Methods.new(template: @template)
-      api_methods.params.each do |key, _|
-        add_parameter(key)
-      end
-    end
-
-    def routes
-      ensure_one_apigw_method_proxy_routes!
-      @items.map do |uid|
-        Jets::Router.routes.find do |route|
-          route.path == "/" && route.path == uid.split('|').last || # root route. any http method works
-          "#{route.http_method}|#{route.path}" == uid # Match the method and path. IE: GET|posts/:id
-        end
-      end.compact
-    end
-    memoize :routes
-
-    # Only add missing root route with one_apigw_method_for_all_routes setting.
-    # Add the root route because that's how it works locally.
-    # With one_apigw_method_for_all_routes, it all goes to one lambda function
-    # and routing is determined by config/routes.rb
-    def ensure_one_apigw_method_proxy_routes!
-      return unless Jets.config.cfn.build.routes == "one_apigw_method_for_all_routes"
-
-      # find before modifications
-      catchall_route = Jets::Router.routes.find { |route| route.path =~ /^\/\*/ }
-      root_route = Jets::Router.routes.find { |route| route.http_method == "GET" && route.path == "/" }
-
-      # modifications
-      unless catchall_route
-        # Note: catchall to route does not matter. In one_apigw_method_for_all_routes mode it all goes to one lambda function
-        # and then gets routed by config/routes.rb
-        Jets::Router.routes << Jets::Router::Route.new(path: '/*catchall', http_method: 'ANY', to: 'jets/public#show')
-      end
-      if !root_route && catchall_route
-        Jets::Router.routes << Jets::Router::Route.new(path: '/', http_method: 'GET', to: catchall_route.to)
-      end
-    end
-
-    # template_path is an interface method
-    def template_path
-      Jets::Names.api_methods_template_path(@page_number)
-    end
-  end
-end

data/lib/jets/cfn/builder/api/paged.rb

@@ -1,30 +0,0 @@
-module Jets::Cfn::Builder::Api
-  class Paged < Base
-    class << self
-      def build_pages(options={})
-        # IE: Pages::Methods.pages Pages::Resources.pages
-        pages_class.pages.each do |page|
-          # Key builder here:
-          #   Jets::Cfn::Builder::Api::Methods
-          #   Jets::Cfn::Builder::Api::Resources
-          new(options.merge(page: page)).build
-        end
-      end
-
-      # Examples:
-      #   Pages::Methods.new(options)
-      #   Pages::Resources.new(options)
-      def pages_class
-        class_name = self.to_s.gsub(/.*::Api::/, '') # IE: Methods or Resources
-        "Jets::Cfn::Builder::Api::Pages::#{class_name}".constantize
-      end
-    end
-
-    def initialize(options={})
-      super
-      @page = options[:page]
-      @items = @page.items        # interface method: Cors: paths, Resources: paths, Methods: routes
-      @page_number = @page.number # interface method
-    end
-  end
-end

data/lib/jets/cfn/builder/api/pages/base.rb

@@ -1,105 +0,0 @@
-module Jets::Cfn::Builder::Api::Pages
-  class Base
-    class_attribute :pages
-    @@pages = {}
-
-    class << self
-      extend Memoist
-
-      # Returns: Array<Page>
-      def pages
-        return @@pages[self.name] if @@pages[self.name]
-
-        pages = []
-        uids_map = build_uids_map
-        uids_map.each do |uid, existing_page|
-          if existing_page
-            pages[existing_page] ||= []
-            pages[existing_page] << uid
-          end
-        end
-        pages.compact! # not using page 0 so need to compact to remove the first nil element
-
-        # Remove existing uids from uids_map. Leave behind new uids
-        pages.each do |page|
-          page.each do |i|
-            uids_map.delete(i)
-          end
-        end
-
-        # Fill up available space in each page so all existing pages are full
-        keys = uids_map.keys
-        pages.each do |page|
-          break if keys.empty?
-          while page.size < page_limit
-            uid = keys.shift
-            break if uid.nil?
-            page << uid
-          end
-        end
-
-        # Add remaining slices to new additional pages
-        pages += keys.each_slice(page_limit).to_a
-
-        @@pages[self.name] = []
-        pages.each_with_index do |uids, i|
-          # Note: page number starts at 1
-          # Because of this we need to do a pages.compact! above to remove the first nil element. Feel this is easier for follow for us humans.
-          @@pages[self.name] << Page.new(items: uids, number: i+1)
-        end
-
-        @@pages[self.name]
-      end
-
-      # Build map that has uids as keys and page number as value
-      # For Resources, the uid is the path
-      #   Example: {"a1"=>0, "a2"=>0, "b1"=>1, "b2"=>1, "c1"=>2, "c2"=>2}
-      # For Methods, the uid is the method|path
-      #   Example: {"GET|a1"=>0, "GET|a2"=>0, "GET|b1"=>1, "GET|b2"=>1, "GET|c1"=>2, "GET|c2"=>2}
-      def build_uids_map
-        map = {}
-        # uids is interface method
-        uids.each do |uid|
-          map[uid] = find_page_index(uid)
-        end
-        map
-      end
-
-      def find_page_index(new_uid)
-        slices = previously_deployed || []
-        slices.each_with_index do |slice, page_number|
-          items = slice["items"]
-          items.find do |old_uid|
-            return page_number if old_uid == new_uid # found
-          end
-        end
-        nil # not found
-      end
-
-      def previously_deployed
-        state = Jets::Router::State.new
-        name = self.to_s.split('::').last.downcase
-        deployed = state.load(name) # IE: state.load("resources") or state.load("methods")
-        deployed
-      end
-      memoize :previously_deployed
-
-      # Relevant CloudFormation limits:
-      #    Resources 500
-      #    Parameters 200
-      #    Outputs 200
-      # For API Gateway Methods template,
-      # Lambda Functions and APIGW Resources are passed in as parameters.
-      # Each APIGW Method can use 2 parameters.
-      # So use page limit of 100 to provide a buffer.
-      # Technically, can use a different limit for Resources and Cors templates,
-      # but keeping all at 100 for consistency.
-      #
-      # JETS_API_PAGE_LIMIT is based on that
-      # https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html
-      def page_limit
-        Integer(ENV['JETS_API_PAGE_LIMIT'] || 100)
-      end
-    end
-  end
-end

data/lib/jets/cfn/builder/api/pages/methods.rb

@@ -1,17 +0,0 @@
-module Jets::Cfn::Builder::Api::Pages
-  class Methods < Base
-    class << self
-      # interface method
-      def uids
-        if Jets.config.cfn.build.routes == "one_apigw_method_for_all_routes"
-          return ['ANY|/', 'ANY|/*catchall']
-        end
-
-        routes = Jets::Router.routes
-        routes.map do |route|
-          "#{route.http_method}|#{route.path}"  # IE: GET|posts/:id
-        end
-      end
-    end
-  end
-end

data/lib/jets/cfn/builder/api/pages/page.rb

@@ -1,19 +0,0 @@
-module Jets::Cfn::Builder::Api::Pages
-  # Note: Do not use, it behaves differently in Ruby 2 v Ruby 3
-  # Page = Struct.new(:items, :number)
-  #
-  # In Ruby 2, assigning an Array to items creates an extra :items key in the structure
-  #
-  #    #<struct Page items={:items=>["*catchall", "posts"],
-  #
-  # In Ruby 3, assigning an Array to items.
-  #
-  #    #<struct Page items=["*catchall", "posts"], number=1>
-  #
-  class Page
-    attr_accessor :items, :number
-    def initialize(items:, number:)
-      @items, @number = items, number
-    end
-  end
-end

data/lib/jets/cfn/builder/api/pages/resources.rb

@@ -1,21 +0,0 @@
-module Jets::Cfn::Builder::Api::Pages
-  class Resources < Base
-    class << self
-      # interface method
-      def uids
-        if Jets.config.cfn.build.routes == "one_apigw_method_for_all_routes"
-          return ['/', '/*catchall']
-        end
-
-        # Note: Do not use
-        #     Jets::Router.routes.map(&:path)
-        # It does not include all the top of the leaves.  Example:
-        #   admin is not included
-        #   admin/new is included
-        # Also, do not include the root/homepage path. It's already created
-        # in api-gateway.yml
-        Jets::Router.all_paths.reject { |p| p.blank? }
-      end
-    end
-  end
-end

data/lib/jets/cfn/builder/api/resources.rb

@@ -1,40 +0,0 @@
-module Jets::Cfn::Builder::Api
-  class Resources < Paged
-    # interface method
-    def compose
-      add_gateway_resources
-      add_rest_api_parameter
-    end
-
-    # interface method
-    def template_path
-      Jets::Names.api_resources_template_path(@page_number)
-    end
-
-    def add_rest_api_parameter
-      add_parameter(:RestApi)
-    end
-
-    def add_gateway_resources
-      @items.each do |path|
-        # IE: resource = Jets::Cfn::Resource::ApiGateway::Resource.new(path)
-        next if path == '/' || path == '' # skip root path
-        resource = api_gateway_resource_class.new(path)
-        add_resource(resource)
-        add_outputs(resource.outputs)
-
-        parent_path = resource.parent_path_parameter
-        add_parameter(parent_path) unless part_of_template?(parent_path)
-      end
-    end
-
-    # interface method
-    def api_gateway_resource_class
-      Jets::Cfn::Resource::ApiGateway::Resource
-    end
-
-    def part_of_template?(parent_path)
-      @template[:Resources].key?(parent_path)
-    end
-  end
-end

data/lib/jets/cfn/builder/authorizer.rb

@@ -1,64 +0,0 @@
-class Jets::Cfn::Builder
-  class Authorizer < Nested
-    include Interface
-    include Jets::AwsServices
-
-    def initialize(path)
-      @path = path # IE: app/authorizers/main_authorizer.rb
-      @app_class = Jets::Klass.from_path(path)
-      @template = ActiveSupport::HashWithIndifferentAccess.new(Resources: {})
-    end
-
-    # interface method
-    def compose
-      add_common_parameters
-      add_api_gateway_parameters
-      add_functions
-      add_resources
-      add_outputs
-      # These dont have lambda functions associated with them
-      add_cognito_authorizers
-      add_cognito_outputs
-    end
-
-    # interface method
-    def template_path
-      Jets::Names.authorizer_template_path(@path)
-    end
-
-    def add_cognito_authorizers
-      @app_class.cognito_authorizers.each do |authorizer|
-        resource = Jets::Cfn::Resource.new(authorizer[:definition], authorizer[:replacements])
-        add_resource(resource)
-      end
-    end
-
-    def add_outputs
-      # IE: @app_class = MainAuthorizer
-      # The associated resource is the Jets::Cfn::Resource::ApiGateway::Authorizer definition built during evaluation
-      # of the user defined Authorizer class. We'll use it to compute the logical id.
-      @app_class.definitions.each do |definition|
-        authorizer = definition.associated_resources.first
-        next unless authorizer
-
-        resource = Jets::Cfn::Resource.new(authorizer.definition, definition.replacements)
-        logical_id = resource.logical_id
-        add_output(logical_id, value: "!Ref #{logical_id}")
-      end
-    end
-
-    def add_cognito_outputs
-      @app_class.cognito_authorizers.each do |authorizer|
-        resource = Jets::Cfn::Resource.new(authorizer[:definition], authorizer[:replacements])
-        logical_id = resource.logical_id
-        add_output(logical_id, value: "!Ref #{logical_id}")
-      end
-    end
-
-    def add_api_gateway_parameters
-      return if Jets::Router.no_routes?
-
-      add_parameter(:RestApi)
-    end
-  end
-end

data/lib/jets/cfn/builder/controller.rb

@@ -1,28 +0,0 @@
-class Jets::Cfn::Builder
-  class Controller < Nested
-    # interface method
-    def compose
-      add_common_parameters
-      add_api_gateway_parameters
-      add_functions
-      add_resources
-      add_outputs
-    end
-
-    def add_outputs
-      outputs = {}
-      @template[:Resources].each do |logical_id, resource|
-        next unless resource[:Type] == "AWS::Lambda::Function"
-        outputs.merge!(logical_id => {
-          Value: "!GetAtt #{logical_id}.Arn"
-        })
-      end
-      @template[:Outputs] = outputs
-    end
-
-    def add_api_gateway_parameters
-      return if Jets::Router.no_routes?
-      add_parameter(:RestApi)
-    end
-  end
-end

data/lib/jets/cfn/builder/function.rb

@@ -1,9 +0,0 @@
-class Jets::Cfn::Builder
-  class Function < Nested
-    # interface method
-    def compose
-      add_common_parameters
-      add_functions
-    end
-  end
-end

data/lib/jets/cfn/builder/job.rb

@@ -1,10 +0,0 @@
-class Jets::Cfn::Builder
-  class Job < Nested
-    # interface method
-    def compose
-      add_common_parameters
-      add_functions
-      add_resources
-    end
-  end
-end