elasticgraph-support 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8825e2c5d0469e98e6be7f6de6eb9d9779d8db74beae886ef4a81ec52beeb3e9
-  data.tar.gz: 12869c23b1f40c76a7b46c5b2f4a4bc949a65f86d02fd55352dad46c0fa4e6fc
+  metadata.gz: 4385b468e82bf7dbfc35f5ea06cb1a3e7249f3db6a45f3eec13e181304c21eae
+  data.tar.gz: c949877479f1f6370a2cdccd9602d20fe1bacf6e6c28795a175287c0314bdab8
 SHA512:
-  metadata.gz: 8b632c88f11738eb683c0714a9a9c5ab5fb14f481bf8cbbe3cc391604ab229239d1a6e1de8efe29cedb255c06fb9eb8cd301aa84758a457a430e7a55caf3fc25
-  data.tar.gz: f76d61a4134fed52bffa316b9a64143a7a0c63414b77942c3da2e22bbbd985aec2511fe58b64ba8276ead1f8dd107cb2a4b6a4ffd40233271ef443f084f060ab
+  metadata.gz: 0cc21f5f3b52d1d74f0f25f67147ed79de1b8c6ec4f5a9d59365b6a52e63b03bd8ac236a7247e7e2dcbe35225aa34842398ff6d41251e0831c48f9e0a8034038
+  data.tar.gz: f5318376302d6dab15ca81942f5716dfd2a9983469bfe863ea40d2517baaff1a0425c1c54457be313b3e1050a67164e1c03afac2ef93b6907f9632de58671b29

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 - 2025 Block, Inc.
+Copyright (c) 2024 - 2026 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

data/README.md

@@ -57,6 +57,9 @@ graph LR;
     elasticgraph-schema_definition["elasticgraph-schema_definition"];
     elasticgraph-schema_definition --> elasticgraph-support;
     class elasticgraph-schema_definition otherEgGemStyle;
+    elasticgraph-warehouse["elasticgraph-warehouse"];
+    elasticgraph-warehouse --> elasticgraph-support;
+    class elasticgraph-warehouse otherEgGemStyle;
     click logger href "https://rubygems.org/gems/logger" "Open on RubyGems.org" _blank;
     click json_schemer href "https://rubygems.org/gems/json_schemer" "Open on RubyGems.org" _blank;
 ```

data/lib/elastic_graph/constants.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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
@@ -6,6 +6,8 @@
 #
 # frozen_string_literal: true
 
+require "securerandom"
+
 # Root namespace for all ElasticGraph code.
 module ElasticGraph
   # Here we enumerate constants that are used from multiple places in the code.
@@ -20,6 +22,15 @@ module ElasticGraph
   # @private
   DATASTORE_DATE_TIME_FORMAT = "strict_date_time"
 
+  # The precision (number of decimal places) used when formatting DateTime values.
+  # A precision of 3 means millisecond precision (e.g., "2025-12-19T04:15:47.530Z").
+  #
+  # Consistent precision is critical for min/max value tracking which uses string comparison.
+  # Without it, string comparison produces incorrect results (e.g., "47.53Z" > "47.531Z"
+  # because 'Z' (ASCII 90) > '1' (ASCII 49)).
+  # @private
+  DATE_TIME_PRECISION = 3
+
   # HTTP header that ElasticGraph HTTP implementations (e.g. elasticgraph-rack, elasticgraph-lambda)
   # look at to determine a client-specified request timeout.
   # @private
@@ -249,6 +260,33 @@ module ElasticGraph
   # @private
   VISIBILITY_PROFILE = :main
 
+  # Value used as the missing value placeholder for subaggregation on enum fields.
+  # This never collides with any real enum value since GraphQL enum values cannot contain `*` characters.
+  # @private
+  MISSING_ENUM_PLACEHOLDER = "**missing**"
+
+  # This is a placeholder for the actual placeholder value used for string types (keyword, text).
+  # When a type is configured with this placeholder value then in the graphql query layer
+  # we use the random valued MISSING_STRING_PLACEHOLDER_VALUE instead.
+  # @private
+  MISSING_STRING_PLACEHOLDER = "$SECURE_RANDOM_VALUE"
+
+  # A random 18 byte (24 character) base64 string used as the missing value placeholder
+  # for subaggregation on string fields. UUID are generally consider safe to use without
+  # risk of collision and since this has more random bits than a UUID it should have even
+  # less risk of collision. This uses a value generated randomly at runtime instead
+  # of using a hard-coded value in order to avoid intentional collision attacks.
+  # @private
+  MISSING_STRING_PLACEHOLDER_VALUE = SecureRandom.urlsafe_base64(18)
+
+  # Value used as the missing value placeholder for subaggregation on numeric fields.
+  # This never collides with any numeric values in the datastore because JSON, ElasticSearch,
+  # and OpenSearch aren't capable of storing NaN.
+  # NaN works as a placeholder for missing numeric values, but it does have the side-effect of coercing
+  # integers to floats so we only use it on types limited to the the JsonSafeLong range.
+  # @private
+  MISSING_NUMERIC_PLACEHOLDER = "NaN"
+
   # TODO(steep): it complains about `define_schema` not being defined but it is defined
   # in another file; I shouldn't have to say it's dynamic here. For now this works though.
   # @dynamic self.define_schema

data/lib/elastic_graph/errors.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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

data/lib/elastic_graph/support/config.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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

data/lib/elastic_graph/support/faraday_middleware/msearch_using_get_instead_of_post.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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
@@ -20,8 +20,14 @@ module ElasticGraph
       # did for years.
       #
       # For more info, see: https://github.com/elastic/elasticsearch-ruby/issues/1005
+      # @private
       MSearchUsingGetInsteadOfPost = ::Data.define(:app) do
         # @implements MSearchUsingGetInsteadOfPost
+
+        # Processes a Faraday request, converting `_msearch` POST requests to GET requests.
+        #
+        # @param env [Faraday::Env] the Faraday request environment
+        # @return [Faraday::Response] the response from the next middleware in the stack
         def call(env)
           env.method = :get if env.url.path.to_s.end_with?("/_msearch")
           app.call(env)

data/lib/elastic_graph/support/faraday_middleware/support_timeouts.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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
@@ -20,8 +20,16 @@ module ElasticGraph
       #
       # This middleware helps us work around this deficiency by looking for the TIMEOUT_MS_HEADER. If present, it deletes
       # it from the headers and instead sets it as the request timeout.
+      # @private
       SupportTimeouts = ::Data.define(:app) do
         # @implements SupportTimeouts
+
+        # Processes a Faraday request, extracting timeout from headers and applying it to the request.
+        # Converts {TIMEOUT_MS_HEADER} from request headers into a Faraday request timeout setting.
+        #
+        # @param env [Faraday::Env] the Faraday request environment
+        # @return [Faraday::Response] the response from the next middleware in the stack
+        # @raise [Errors::RequestExceededDeadlineError] if the request times out
         def call(env)
           if (timeout_ms = env.request_headers.delete(TIMEOUT_MS_HEADER))
             env.request.timeout = Integer(timeout_ms) / 1000.0

data/lib/elastic_graph/support/from_yaml_file.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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
@@ -43,7 +43,7 @@ module ElasticGraph
             rescue => e
               raise <<~EOS
                 Failed to load `#{component_class}` with `#{yaml_file}`. This can happen if the schema artifacts are out of date.
-                Run `rake schema_artifacts:dump` and try again.
+                Run `bundle exec rake schema_artifacts:dump` and try again.
 
                 #{e.class}: #{e.message}
               EOS

data/lib/elastic_graph/support/graphql_formatter.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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

data/lib/elastic_graph/support/hash_util.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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

data/lib/elastic_graph/support/json_schema/meta_schema_validator.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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

data/lib/elastic_graph/support/json_schema/validator.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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

data/lib/elastic_graph/support/json_schema/validator_factory.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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

data/lib/elastic_graph/support/logger.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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

data/lib/elastic_graph/support/memoizable_data.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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

data/lib/elastic_graph/support/monotonic_clock.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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

data/lib/elastic_graph/support/threading.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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

data/lib/elastic_graph/support/time_set.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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

data/lib/elastic_graph/support/time_util.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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

data/lib/elastic_graph/support/untyped_encoder.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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
@@ -25,15 +25,7 @@ module ElasticGraph
       # Encodes the given untyped value to a String so it can be indexed in a Elasticsearch/OpenSearch `keyword` field.
       def self.encode(value)
         return nil if value.nil?
-        # Note: we use `fast_generate` here instead of `generate`. They basically act the same, except
-        # `generate` includes an extra check for self-referential data structures. `value` here ultimately
-        # comes out of a parsed JSON document (e.g. either from an ElasticGraph event at indexing time, or
-        # as a GraphQL query variable at search time), and JSON cannot express self-referential data
-        # structures, so we do not have to worry about that happening.
-        #
-        # ...but even if it did, we would get an error either way: `JSON.generate` would raise
-        # `JSON::NestingError` whereas `:JSON.fast_generate` would give us a `SystemStackError`.
-        ::JSON.fast_generate(canonicalize(value))
+        ::JSON.generate(canonicalize(value))
       end
 
       # Decodes a previously encoded Untyped value, returning its original value.

data/lib/elastic_graph/version.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 - 2025 Block, Inc.
+# 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
@@ -8,7 +8,7 @@
 
 module ElasticGraph
   # The version of all ElasticGraph gems.
-  VERSION = "1.0.2"
+  VERSION = "1.1.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.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Myron Marston
@@ -31,34 +31,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.13.4
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.13.4
+        version: '2.14'
 email:
 - myron@squareup.com
 executables: []
@@ -91,10 +85,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/block/elasticgraph/issues
-  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.2
-  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.2/
+  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.1.0
+  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.1.0/
   homepage_uri: https://block.github.io/elasticgraph/
-  source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.2/elasticgraph-support
+  source_code_uri: https://github.com/block/elasticgraph/tree/v1.1.0/elasticgraph-support
   gem_category: core
 rdoc_options: []
 require_paths:
@@ -106,14 +100,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.4'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3.5'
+      version: '4.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Provides support utilities for other ElasticGraph gems.
 test_files: []