elasticgraph-lambda_support 0.18.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1164c6db4dc8da39c3040750fb7be0001762d123fe8f230e83d1947faa46ed2
+  data.tar.gz: b71fcfe9119a84a692ba9fc71195a3dec33c5a154fb5efb1048c1a078464ea04
+SHA512:
+  metadata.gz: 875e927d312b89019252b074f08ce749cbdc5a401ae4f439adc240c23ab33d9825c34a3bf959943367f3cd71a11f49f2100564a8d41397574b725a64a7018aeb
+  data.tar.gz: 2c74f0d9b95b5189899ce91b6d72017fe9571c9d9fae70f0b31917bd718b89c4b8ceb8e20c97e8433ba71ffc4446aee2b7659195b419ffe82ee6d615dc4cce98

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Block, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,6 @@
+# ElasticGraph::LambdaSupport
+
+This gem contains common lambda support logic that is used by all ElasticGraph
+lambdas, such as lambda logging and OpenSearch connection support.
+
+It is not meant to be used directly by end users of ElasticGraph.

data/elasticgraph-lambda_support.gemspec

@@ -0,0 +1,33 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require_relative "../gemspec_helper"
+
+ElasticGraphGemspecHelper.define_elasticgraph_gem(gemspec_file: __FILE__, category: :lambda) do |spec, eg_version|
+  spec.summary = "ElasticGraph gem that supports running ElasticGraph using AWS Lambda."
+
+  spec.add_dependency "elasticgraph-opensearch", eg_version
+  spec.add_dependency "faraday_middleware-aws-sigv4", "~> 1.0"
+
+  # Logger 1.6.0 is currently incompatible with AWS lambda due to how the lambda Ruby runtime monkey patches the Logger class:
+  #
+  # https://github.com/aws/aws-lambda-ruby-runtime-interface-client/issues/33
+  # https://github.com/ruby/logger/issues/99
+  #
+  # We don't actually need the logger gem but faraday 2.10 pulls it in as a dependency, and to avoid getting boot-time errors
+  # we need to prevent logger >= 1.6.0 from getting pulled in.
+  #
+  # Once the AWS lambda runtime issue is resolved, we can remove this dependency.
+  spec.add_dependency "logger", "< 1.6.0"
+
+  spec.add_development_dependency "elasticgraph-admin", eg_version
+  spec.add_development_dependency "elasticgraph-graphql", eg_version
+  spec.add_development_dependency "elasticgraph-indexer", eg_version
+  spec.add_development_dependency "elasticgraph-indexer_autoscaler_lambda", eg_version
+  spec.add_development_dependency "httpx", ">= 1.2.6", "< 2.0"
+end

data/lib/elastic_graph/lambda_support/json_aware_lambda_log_formatter.rb

@@ -0,0 +1,51 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "json"
+require "logger"
+
+module ElasticGraph
+  module LambdaSupport
+    # A log formatter that supports JSON logging, without requiring _all_ logs to be emitted as JSON.
+    #
+    # If the `message` is a hash of JSON data, it will produce a JSON-formatted log message combining the
+    # standard bits of metadata the AWS Lambda logger already includes in every log message with the passed data.
+    #
+    # If it is not a hash of JSON data, it will just delegate to the default formatter used by AWS Lambda.
+    #
+    # This is particularly useful to support cloudwatch metric filtering:
+    # https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html#metric-filters-extract-json
+    class JSONAwareLambdaLogFormatter < ::Logger::Formatter
+      # Copied from:
+      # https://github.com/aws/aws-lambda-ruby-runtime-interface-client/blob/2.0.0/lib/aws_lambda_ric/lambda_log_formatter.rb#L8
+      FORMAT = "%<sev>s, [%<datetime>s #%<process>d] %<severity>5s %<request_id>s -- %<progname>s: %<msg>s"
+
+      def call(severity, time, progname, msg)
+        metadata = {
+          # These bits of metadata come from the standard AWS Lambda log formatter:
+          # https://github.com/aws/aws-lambda-ruby-runtime-interface-client/blob/2.0.0/lib/aws_lambda_ric/lambda_log_formatter.rb#L11-L12
+          sev: severity[0..0],
+          datetime: format_datetime(time),
+          process: $$,
+          severity: severity,
+          # standard:disable Style/GlobalVars -- don't have a choice here; this is what the AWS Lambda runtime sets.
+          request_id: $_global_aws_request_id,
+          # standard:enable Style/GlobalVars
+          progname: progname
+        }
+
+        if msg.is_a?(::Hash)
+          ::JSON.generate(msg.merge(metadata), space: " ")
+        else
+          # See https://github.com/aws/aws-lambda-ruby-runtime-interface-client/blob/2.0.0/lib/aws_lambda_ric/lambda_log_formatter.rb
+          (FORMAT % metadata.merge({msg: msg2str(msg)})).encode!("UTF-8")
+        end
+      end
+    end
+  end
+end

data/lib/elastic_graph/lambda_support/lambda_function.rb

@@ -0,0 +1,69 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/support/monotonic_clock"
+
+module ElasticGraph
+  module LambdaSupport
+    # Mixin that can be used to define a lambda function, with common cross-cutting concerns
+    # handled automatically for you:
+    #
+    #   - The amount of time it takes to boot the lambda is logged.
+    #   - An error handling hook is provided which applies both to boot-time logic and request handling.
+    #
+    # It is designed to be prepending onto a class, like so:
+    #
+    # class DoSomething
+    #   prepend LambdaFunction
+    #
+    #   def initialize
+    #     require 'my_application'
+    #     @application = MyApplication.new(ENV[...])
+    #   end
+    #
+    #   def handle_request(event:, context:)
+    #     @application.handle_request(event: event, context: context)
+    #   end
+    # end
+    #
+    # Using `prepend` is necessary so that it can wrap `initialize` and `handle_request` with error handling.
+    # It is recommended that `require`s be put in `initialize` instead of at the top of the lambda function
+    # file so that the error handler can handle any errors that happen while loading dependencies.
+    #
+    # `handle_exceptions` can also be overridden in order to provide error handling.
+    module LambdaFunction
+      def initialize(output: $stdout, monotonic_clock: Support::MonotonicClock.new)
+        handle_exceptions do
+          log_duration(output, monotonic_clock, "Booting the lambda function") do
+            super()
+          end
+        end
+      end
+
+      def handle_request(event:, context:)
+        handle_exceptions { super }
+      end
+
+      private
+
+      # By default we just allow exceptions to bubble up. This is provided so that there is an exception handling hook that can be overridden.
+      def handle_exceptions
+        yield
+      end
+
+      def log_duration(output, monotonic_clock, description)
+        start_ms = monotonic_clock.now_in_ms
+        yield
+        stop_ms = monotonic_clock.now_in_ms
+        duration_ms = stop_ms - start_ms
+
+        output.puts "#{description} took #{duration_ms} milliseconds."
+      end
+    end
+  end
+end

data/lib/elastic_graph/lambda_support.rb

@@ -0,0 +1,74 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/lambda_support/json_aware_lambda_log_formatter"
+require "faraday_middleware/aws_sigv4"
+require "json"
+
+module ElasticGraph
+  module LambdaSupport
+    # Helper method for building ElasticGraph components from our lambda ENV vars.
+    # `klass` is expected to be `ElasticGraph::Admin`, `ElasticGraph::GraphQL`, or `ElasticGraph::Indexer`.
+    #
+    # This is meant to only deal with ENV vars and config that are common across all ElasticGraph
+    # components (e.g. logging and OpenSearch clients). ENV vars that are specific to one component
+    # should be handled elsewhere. This accepts a block which can further customize configuration as
+    # needed.
+    def self.build_from_env(klass)
+      klass.from_yaml_file(
+        ENV.fetch("ELASTICGRAPH_YAML_CONFIG"),
+        datastore_client_customization_block: ->(faraday) { configure_datastore_client(faraday) }
+      ) do |settings|
+        settings = settings.merge(
+          "logger" => override_logger_config(settings.fetch("logger")),
+          "datastore" => override_datastore_config(settings.fetch("datastore"))
+        )
+
+        settings = yield(settings) if block_given?
+        settings
+      end
+    end
+
+    private
+
+    def self.override_datastore_config(datastore_config)
+      env_urls_by_cluster = ::JSON.parse(ENV.fetch("OPENSEARCH_CLUSTER_URLS"))
+      file_settings_by_cluster = datastore_config.fetch("clusters").transform_values { |v| v["settings"] }
+
+      datastore_config.merge(
+        "clusters" => env_urls_by_cluster.to_h do |cluster_name, url|
+          cluster_def = {
+            "url" => url,
+            "backend" => "opensearch",
+            "settings" => file_settings_by_cluster[cluster_name] || {}
+          }
+
+          [cluster_name, cluster_def]
+        end
+      )
+    end
+
+    def self.override_logger_config(logger_config)
+      logger_config.merge({
+        "level" => ENV["ELASTICGRAPH_LOG_LEVEL"],
+        "formatter" => JSONAwareLambdaLogFormatter.name
+      }.compact)
+    end
+
+    def self.configure_datastore_client(faraday)
+      faraday.request :aws_sigv4,
+        service: "es",
+        region: ENV.fetch("AWS_REGION"), # assumes the lambda and OpenSearch cluster live in the same region.
+        access_key_id: ENV.fetch("AWS_ACCESS_KEY_ID"),
+        secret_access_key: ENV.fetch("AWS_SECRET_ACCESS_KEY"),
+        session_token: ENV["AWS_SESSION_TOKEN"] # optional
+    end
+
+    private_class_method :override_datastore_config, :override_logger_config, :configure_datastore_client
+  end
+end

metadata

@@ -0,0 +1,348 @@
+--- !ruby/object:Gem::Specification
+name: elasticgraph-lambda_support
+version: !ruby/object:Gem::Version
+  version: 0.18.0.0
+platform: ruby
+authors:
+- Myron Marston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: flatware-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: super_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: aws_lambda_ric
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-opensearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware-aws-sigv4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-indexer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-indexer_autoscaler_lambda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: httpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- myron@squareup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- elasticgraph-lambda_support.gemspec
+- lib/elastic_graph/lambda_support.rb
+- lib/elastic_graph/lambda_support/json_aware_lambda_log_formatter.rb
+- lib/elastic_graph/lambda_support/lambda_function.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  gem_category: lambda
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key: 
+specification_version: 4
+summary: ElasticGraph gem that supports running ElasticGraph using AWS Lambda.
+test_files: []