elasticgraph-query_interceptor 0.18.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcd371ef8748406bce58e08d51a6290db092b9bf3e85fdf37d060e8a1976d918
+  data.tar.gz: e4f38da27953ca3a88a9781ee94762aa10d5dcfa87c40219e5ed58a886ae02c6
+SHA512:
+  metadata.gz: a9ee19636384e1e334e51641815535bec5aee0094cfc0e89f45e42e6536bb5569e26bd0a4b4aeebe5dc0396d5ffe48dc23b41d6b0eef485f9fbd8ab1046b3edf
+  data.tar.gz: 2527e2aa119caee3ceab406a140df68786964a890c0ff45fcffae0593607a3e3d6181166fed4047d678f6fb2c76def99a3cb7b41285cde87b67676594f5c7c85

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,48 @@
+# ElasticGraph::QueryInterceptor
+
+An ElasticGraph extension library that lets you intercept datastore
+queries before they are submitted in order to customize/modify them some
+how.
+
+## Setup
+
+First, add `elasticgraph-query_interceptor` to your `Gemfile`:
+
+``` ruby
+gem "elasticgraph-query_interceptor"
+```
+
+Next, configure this library in your ElasticGraph config YAML files.
+An optional "config" dictionary can be provided to pass in values to
+your interceptor when it is initialized.
+
+``` yaml
+extension_modules:
+- require_path: elastic_graph/query_interceptor/graphql_extension
+  extension_name: ElasticGraph::QueryInterceptor::GraphQLExtension
+query_interceptor:
+  interceptors:
+  - require_path: ./my_app/example_interceptor
+    extension_name: MyApp::ExampleInterceptor
+    config: # Optional
+      foo: bar
+```
+
+Define your interceptors at the configured paths. Each interceptor must
+implement this interface:
+
+``` ruby
+module YourApp
+  class ExampleInterceptor
+    def initialize(elasticgraph_graphql:, config:)
+      # elasticgraph_graphql is the `ElasticGraph::GraphQL` instance and has access
+      # to things like the datastore client in case you need it in your interceptor.
+    end
+
+    def intercept(query, field:, args:, http_request:, context:)
+      # Call `query.merge_with(...)` as desired to merge in query overrides like filters.
+      # This method must return a query.
+    end
+  end
+end
+```

data/elasticgraph-query_interceptor.gemspec

@@ -0,0 +1,20 @@
+# 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: :extension) do |spec, eg_version|
+  spec.summary = "An ElasticGraph extension for intercepting datastore queries."
+
+  spec.add_dependency "elasticgraph-graphql", eg_version
+  spec.add_dependency "elasticgraph-schema_artifacts", eg_version
+
+  spec.add_development_dependency "elasticgraph-elasticsearch", eg_version
+  spec.add_development_dependency "elasticgraph-opensearch", eg_version
+  spec.add_development_dependency "elasticgraph-schema_definition", eg_version
+end

data/lib/elastic_graph/query_interceptor/config.rb

@@ -0,0 +1,61 @@
+# 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/schema_artifacts/runtime_metadata/extension_loader"
+
+module ElasticGraph
+  module QueryInterceptor
+    # Defines configuration for elasticgraph-query_interceptor
+    class Config < ::Data.define(:interceptors)
+      # Builds Config from parsed YAML config.
+      def self.from_parsed_yaml(parsed_config_hash, parsed_runtime_metadata_hashes: [])
+        interceptor_hashes = parsed_runtime_metadata_hashes.flat_map { |h| h["interceptors"] || [] }
+
+        if (extension_config = parsed_config_hash["query_interceptor"])
+          extra_keys = extension_config.keys - EXPECTED_KEYS
+
+          unless extra_keys.empty?
+            raise ConfigError, "Unknown `query_interceptor` config settings: #{extra_keys.join(", ")}"
+          end
+
+          interceptor_hashes += extension_config.fetch("interceptors")
+        end
+
+        loader = SchemaArtifacts::RuntimeMetadata::ExtensionLoader.new(InterceptorInterface)
+
+        interceptors = interceptor_hashes.map do |hash|
+          empty_config = {}  # : ::Hash[::Symbol, untyped]
+          ext = loader.load(hash.fetch("extension_name"), from: hash.fetch("require_path"), config: empty_config)
+          config = hash["config"] || {} # : ::Hash[::String, untyped]
+          InterceptorData.new(klass: ext.extension_class, config: config)
+        end
+
+        new(interceptors)
+      end
+
+      DEFAULT = new([])
+      EXPECTED_KEYS = members.map(&:to_s)
+
+      # Defines a data structure to hold interceptor klass and config
+      InterceptorData = ::Data.define(:klass, :config)
+
+      # Defines the interceptor interface, which our extension loader will validate against.
+      class InterceptorInterface
+        def initialize(elasticgraph_graphql:, config:)
+          # must be defined, but nothing to do
+        end
+
+        def intercept(query, field:, args:, http_request:, context:)
+          # :nocov: -- must return a query to satisfy Steep type checking but never called
+          query
+          # :nocov:
+        end
+      end
+    end
+  end
+end

data/lib/elastic_graph/query_interceptor/datastore_query_adapter.rb

@@ -0,0 +1,28 @@
+# 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
+
+module ElasticGraph
+  module QueryInterceptor
+    class DatastoreQueryAdapter
+      # @dynamic interceptors
+      attr_reader :interceptors
+
+      def initialize(interceptors)
+        @interceptors = interceptors
+      end
+
+      def call(query:, args:, lookahead:, field:, context:)
+        http_request = context[:http_request]
+
+        interceptors.reduce(query) do |accum, interceptor|
+          interceptor.intercept(accum, field: field, args: args, http_request: http_request, context: context)
+        end
+      end
+    end
+  end
+end

data/lib/elastic_graph/query_interceptor/graphql_extension.rb

@@ -0,0 +1,32 @@
+# 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/query_interceptor/config"
+require "elastic_graph/query_interceptor/datastore_query_adapter"
+require "elastic_graph/support/hash_util"
+
+module ElasticGraph
+  module QueryInterceptor
+    module GraphQLExtension
+      def datastore_query_adapters
+        @datastore_query_adapters ||= begin
+          runtime_metadata_configs = runtime_metadata.graphql_extension_modules.filter_map do |ext_mod|
+            Support::HashUtil.stringify_keys(ext_mod.extension_config) if ext_mod.extension_class == GraphQLExtension
+          end
+
+          interceptors = Config
+            .from_parsed_yaml(config.extension_settings, parsed_runtime_metadata_hashes: runtime_metadata_configs)
+            .interceptors
+            .map { |data| data.klass.new(elasticgraph_graphql: self, config: data.config) }
+
+          super + [DatastoreQueryAdapter.new(interceptors)]
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,286 @@
+--- !ruby/object:Gem::Specification
+name: elasticgraph-query_interceptor
+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: elasticgraph-graphql
+  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: elasticgraph-schema_artifacts
+  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: elasticgraph-elasticsearch
+  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-opensearch
+  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-schema_definition
+  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
+description: 
+email:
+- myron@squareup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- elasticgraph-query_interceptor.gemspec
+- lib/elastic_graph/query_interceptor/config.rb
+- lib/elastic_graph/query_interceptor/datastore_query_adapter.rb
+- lib/elastic_graph/query_interceptor/graphql_extension.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  gem_category: extension
+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: An ElasticGraph extension for intercepting datastore queries.
+test_files: []