elasticgraph-support 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4385b468e82bf7dbfc35f5ea06cb1a3e7249f3db6a45f3eec13e181304c21eae
-  data.tar.gz: c949877479f1f6370a2cdccd9602d20fe1bacf6e6c28795a175287c0314bdab8
+  metadata.gz: fdd7d18e2d13299ff5246ab37ea242654bb8be5eded1f13ea0f9732f1df3f4a7
+  data.tar.gz: d2166983bf06daa7b8e060ec4c943dd5a51b7de987c2c8790ae39612f2aeff1a
 SHA512:
-  metadata.gz: 0cc21f5f3b52d1d74f0f25f67147ed79de1b8c6ec4f5a9d59365b6a52e63b03bd8ac236a7247e7e2dcbe35225aa34842398ff6d41251e0831c48f9e0a8034038
-  data.tar.gz: f5318376302d6dab15ca81942f5716dfd2a9983469bfe863ea40d2517baaff1a0425c1c54457be313b3e1050a67164e1c03afac2ef93b6907f9632de58671b29
+  metadata.gz: 6c77c47ce1914a3828ef6ee3041d51ddc54450d3c210cdbd8a2a2493c64c0ea05d926d7f6096e8bbad142b479bdad7923f2b16bef6ae03b3fedd04cbf3ac2264
+  data.tar.gz: '097f7b5a51df6761ec612f10f4502c994e6a48c0f9014f49c3ed23a08c5ec6a08ea1fd457cc291553519d9c57ee8c43c730c53bb55a9df6f356593b9d286bc83'

data/lib/elastic_graph/constants.rb

@@ -36,6 +36,10 @@ module ElasticGraph
   # @private
   TIMEOUT_MS_HEADER = "ElasticGraph-Request-Timeout-Ms"
 
+  # HTTP header used on datastore requests to identify the caller and request shape.
+  # @private
+  OPAQUE_ID_HEADER = "X-Opaque-Id"
+
   # Min/max values for the `Int` type.
   # Based on the GraphQL spec:
   #

data/lib/elastic_graph/support/config.rb

@@ -45,10 +45,46 @@ module ElasticGraph
       #    end
       def self.define(*attrs, &block)
         ::Data.define(*attrs) do
-          # @implements ::Data
+          # @implements ConfigData
           alias_method :__data_initialize, :initialize
           extend ClassMethods
-          include InstanceMethods
+
+          # On JRuby 10.0.4.0, `include`-ing a module in a Data.define block causes
+          # subclass instances to have nil fields in certain call patterns. Define the
+          # instance methods directly instead of using `include InstanceMethods`.
+          # See: https://github.com/jruby/jruby/issues/9327
+
+          # Overrides `initialize` to apply JSON schema validation.
+          def initialize(**config)
+            klass = (_ = self.class) # : ClassMethods[::Data]
+            validator = klass.validator
+            config = validator.merge_defaults(config)
+
+            if (error = validator.validate_with_error_message(config))
+              klass.raise_invalid_config(error)
+            end
+
+            config = config.transform_keys(&:to_sym)
+            __skip__ = super(**convert_values(**config))
+          end
+
+          # Overrides `#with` to bypass the normal JSON schema validation that applies in `#initialize`.
+          # This is required so that `config.with(...)` can be used on config classes that use the
+          # `convert_values` hook to convert JSON data to some custom Ruby type. The custom Ruby type
+          # won't pass JSON schema validation, and if we didn't override `with` then we'd get validation
+          # failures due to the converted values failing validation.
+          def with(**updates)
+            (_ = self.class).new_without_validation(**to_h.merge(updates))
+          end
+
+          private
+
+          # Default implementation of a hook that allows config values to be converted during initialization.
+          def convert_values(**values)
+            values
+          end
+
+          public
 
           class_exec(&(_ = block)) if block
         end
@@ -148,39 +184,6 @@ module ElasticGraph
           instance
         end
       end
-
-      # @private
-      module InstanceMethods
-        # Overrides `initialize` to apply JSON schema validation.
-        def initialize(**config)
-          klass = (_ = self.class) # : ClassMethods[::Data]
-          validator = klass.validator
-          config = validator.merge_defaults(config)
-
-          if (error = validator.validate_with_error_message(config))
-            klass.raise_invalid_config(error)
-          end
-
-          config = config.transform_keys(&:to_sym)
-          __skip__ = super(**convert_values(**config))
-        end
-
-        # Overrides `#with` to bypass the normal JSON schema validation that applies in `#initialize`.
-        # This is required so that `config.with(...)` can be used on config classes that use the
-        # `convert_values` hook to convert JSON data to some custom Ruby type. The custom Ruby type
-        # won't pass JSON schema validation, and if we didn't override `with` then we'd get validation
-        # failures due to the converted values failing validation.
-        def with(**updates)
-          (_ = self.class).new_without_validation(**to_h.merge(updates))
-        end
-
-        private
-
-        # Default implementation of a hook that allows config values to be converted during initialization.
-        def convert_values(**values)
-          values
-        end
-      end
     end
   end
 end

data/lib/elastic_graph/support/graphql_gem_loader.rb

@@ -0,0 +1,49 @@
+# Copyright 2024 - 2026 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 Support
+    # Helper module to load the graphql gem and optionally graphql-c_parser for better performance.
+    # Prints a yellow warning to stderr when c_parser is unavailable (except on JRuby where C extensions don't work).
+    #
+    # @private
+    module GraphQLGemLoader
+      # ANSI escape code for yellow text
+      YELLOW = "\e[33m"
+      RESET = "\e[0m"
+
+      @warning_printed = false # : bool
+
+      # Loads the graphql gem and attempts to load graphql/c_parser.
+      # If c_parser is unavailable, prints a warning once (unless on JRuby).
+      def self.load
+        require "graphql"
+
+        begin
+          require "graphql/c_parser"
+        rescue LoadError
+          print_warning_once
+        end
+      end
+
+      def self.print_warning_once
+        return if @warning_printed || RUBY_ENGINE == "jruby"
+
+        @warning_printed = true
+        warn "#{YELLOW}[ElasticGraph] For better performance, add `graphql-c_parser` to your Gemfile. See: https://graphql-ruby.org/language_tools/c_parser.html#{RESET}"
+      end
+
+      # Resets warning state; only intended for use in tests.
+      def self.reset_warning_state!
+        @warning_printed = false
+      end
+
+      private_class_method :print_warning_once, :reset_warning_state!
+    end
+  end
+end

data/lib/elastic_graph/support/opaque_id.rb

@@ -0,0 +1,30 @@
+# Copyright 2024 - 2026 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 Support
+    # Builds `X-Opaque-Id` header values from a finite set of readable parts.
+    module OpaqueID
+      # Builds an `X-Opaque-Id` header value from the provided opaque-id parts.
+      #
+      # @param parts [Array<String, nil>] opaque-id parts to normalize and join.
+      # @return [String, nil] a semicolon-delimited opaque-id header value, or `nil` if no
+      #   meaningful opaque-id parts remain after normalization.
+      def self.build_header(parts)
+        header = parts.filter_map do |part|
+          normalized = part.to_s.strip
+          next if normalized.empty?
+
+          normalized.gsub(/[;\r\n]/, ",")
+        end.join(";")
+
+        header.empty? ? nil : header
+      end
+    end
+  end
+end

data/lib/elastic_graph/support/threading.rb

@@ -10,33 +10,38 @@ module ElasticGraph
   module Support
     # @private
     module Threading
-      # Like Enumerable#map, but performs the map in parallel using one thread per list item.
+      # Like Enumerable#map, but performs the map in parallel using one thread per list item
+      # when there are multiple items.
       # Exceptions that happen in the threads will propagate to the caller at the end.
       # Due to Ruby's GVL, this will never be helpful for pure computation, but can be
       # quite helpful when dealing with blocking I/O. However, the cost of threads is
       # such that this method should not be used when you have a large list of items to
       # map over (say, hundreds or thousands of items or more).
       def self.parallel_map(items)
-        threads = _ = items.map do |item|
-          ::Thread.new do
-            # Disable reporting of exceptions. We use `value` at the end of this method, which
-            # propagates any exception that happened in the thread to the calling thread. If
-            # this is true (the default), then the exception is also printed to $stderr which
-            # is quite noisy.
-            ::Thread.current.report_on_exception = false
+        return _ = items.map { |item| yield item } if items.size < 2
 
-            yield item
+        begin
+          threads = _ = items.map do |item|
+            ::Thread.new do
+              # Disable reporting of exceptions. We use `value` at the end of this method, which
+              # propagates any exception that happened in the thread to the calling thread. If
+              # this is true (the default), then the exception is also printed to $stderr which
+              # is quite noisy.
+              ::Thread.current.report_on_exception = false
+
+              yield item
+            end
           end
-        end
 
-        # `value` here either returns the value of the final expression in the thread, or raises
-        # whatever exception happened in the thread. `join` doesn't propagate the exception in
-        # the same way, so we always want to use `Thread#value` even if we are just using threads
-        # for side effects.
-        threads.map(&:value)
-      rescue => e
-        e.set_backtrace(e.backtrace + caller)
-        raise e
+          # `value` here either returns the value of the final expression in the thread, or raises
+          # whatever exception happened in the thread. `join` doesn't propagate the exception in
+          # the same way, so we always want to use `Thread#value` even if we are just using threads
+          # for side effects.
+          threads.map(&:value)
+        rescue => e
+          e.set_backtrace(e.backtrace + caller)
+          raise e
+        end
       end
     end
   end

data/lib/elastic_graph/version.rb

@@ -8,7 +8,7 @@
 
 module ElasticGraph
   # The version of all ElasticGraph gems.
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 
   # Steep weirdly expects this here...
   # @dynamic self.define_schema

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticgraph-support
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Myron Marston
@@ -46,6 +46,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -53,6 +56,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
 email:
 - myron@squareup.com
 executables: []
@@ -68,6 +74,7 @@ files:
 - lib/elastic_graph/support/faraday_middleware/support_timeouts.rb
 - lib/elastic_graph/support/from_yaml_file.rb
 - lib/elastic_graph/support/graphql_formatter.rb
+- lib/elastic_graph/support/graphql_gem_loader.rb
 - lib/elastic_graph/support/hash_util.rb
 - lib/elastic_graph/support/json_schema/meta_schema_validator.rb
 - lib/elastic_graph/support/json_schema/validator.rb
@@ -75,6 +82,7 @@ files:
 - lib/elastic_graph/support/logger.rb
 - lib/elastic_graph/support/memoizable_data.rb
 - lib/elastic_graph/support/monotonic_clock.rb
+- lib/elastic_graph/support/opaque_id.rb
 - lib/elastic_graph/support/threading.rb
 - lib/elastic_graph/support/time_set.rb
 - lib/elastic_graph/support/time_util.rb
@@ -85,10 +93,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/block/elasticgraph/issues
-  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.1.0
-  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.1.0/
+  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.2.0
+  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.2.0/
   homepage_uri: https://block.github.io/elasticgraph/
-  source_code_uri: https://github.com/block/elasticgraph/tree/v1.1.0/elasticgraph-support
+  source_code_uri: https://github.com/block/elasticgraph/tree/v1.2.0/elasticgraph-support
   gem_category: core
 rdoc_options: []
 require_paths:
@@ -107,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Provides support utilities for other ElasticGraph gems.
 test_files: []