graphiti 2.0.0.beta.7 → 2.0.0.beta.9

data/lib/graphiti/scope.rb

@@ -31,6 +31,28 @@ module Graphiti
       end
     end
 
+    POOL_THREAD = :__graphiti_pool_thread
+    private_constant :POOL_THREAD
+
+    # A pool thread that waits on the pool deadlocks, since the task it waits for cannot start until the waiting thread frees its slot.
+    def self.resolve_synchronously?
+      !Graphiti.config.concurrency || on_pool_thread?
+    end
+
+    # TODO: move to Fiber[] once the floor is Ruby 3.2
+    def self.on_pool_thread?
+      Thread.current[POOL_THREAD] == true
+    end
+
+    # Restores rather than clears because :caller_runs may have run the task on a request thread.
+    def self.marking_pool_thread
+      previous = Thread.current[POOL_THREAD]
+      Thread.current[POOL_THREAD] = true
+      yield
+    ensure
+      Thread.current[POOL_THREAD] = previous
+    end
+
     def initialize(object, resource, query, opts = {})
       @object = object
       @resource = resource
@@ -43,24 +65,24 @@ module Graphiti
     end
 
     def resolve(&blk)
-      # When concurrency is disabled, take a synchronous path that mirrors the
-      # pre-1.8 semantics. This avoids allocating Concurrent::Promises futures,
-      # Thread/Fiber storage snapshots, and Rails executor wrappers on every
-      # request purely to drive a thread pool that is intentionally synchronous.
+      # The caller blocks on .value! either way, so concurrency only benefits parallel sideloads
       # See https://github.com/graphiti-api/graphiti/issues/505
-      if Graphiti.config.concurrency
-        future_resolve(&blk).value!
-      else
+      if self.class.resolve_synchronously? || !applicable_sideloads?
         sync_resolve(&blk)
+      else
+        future_resolve(&blk).value!
       end
     end
 
     def resolve_sideloads(results)
-      if Graphiti.config.concurrency
-        future_resolve_sideloads(results).value!
-      else
+      if self.class.resolve_synchronously?
         sync_resolve_sideloads(results)
+      else
+        future_resolve_sideloads(results).value!
       end
+
+      # Never return the sideloads hash, a caller mutating it would mess up the cache key
+      nil
     end
 
     def future_resolve(&blk)
@@ -138,10 +160,6 @@ module Graphiti
         Graphiti.config.before_sideload&.call(Graphiti.context)
         sideload.resolve(results, sideload_query, @resource)
       end
-
-      # Match pre-1.8 semantics: the non-concurrent resolve_sideloads returned
-      # nil (not the sideloads Hash). Callers don't rely on the return value.
-      nil
     end
 
     # Resolve this scope's own data: run hooks, resolve the resource, and
@@ -165,14 +183,36 @@ module Graphiti
     # canonical instance. The resource class in the key keeps two resources
     # serving the same model from sharing an instance and a serializer.
     def deduplicate_entities!(resolved)
+      return unless deduplicable?
+
+      # Nested maps are built once, a composite key meant a new array for every record
+      by_model = @query.entity_map.compute_if_absent(@resource.class) { Concurrent::Map.new }
+
       resolved.map! do |record|
         next record unless record.respond_to?(:id) && !record.id.nil?
 
-        key = [@resource.class, record.class, record.id]
-        @query.entity_map.compute_if_absent(key) { record }
+        by_id = by_model.compute_if_absent(record.class) { Concurrent::Map.new }
+        by_id.compute_if_absent(record.id) { record }
       end
     end
 
+    # A customized sideload can load a record another path would not, so it keeps its own instances.
+    def deduplicable?
+      sideload = @opts[:sideload]
+      return true unless sideload
+
+      sideload.scope_proc.nil? &&
+        sideload.params_proc.nil? &&
+        !sideload.customized_base_scope? &&
+        sideload.primary_key == :id
+    end
+
+    # Nothing to post to the pool means the future would wrap work already done.
+    def applicable_sideloads?
+      each_applicable_sideload { return true }
+      false
+    end
+
     def each_applicable_sideload
       @query.sideloads.each_pair do |name, sideload_query|
         sideload = @resource.class.sideload(name)
@@ -194,6 +234,8 @@ module Graphiti
         sideload_promises << promise.flat
       end
 
+      return sideload_promises.first if sideload_promises.one?
+
       Concurrent::Promises.zip_futures_on(self.class.global_thread_pool_executor, *sideload_promises)
         .rescue_on(self.class.global_thread_pool_executor) do |*reasons|
           first_error = reasons.find { |r| r.is_a?(Exception) }
@@ -202,7 +244,10 @@ module Graphiti
     end
 
     def future_with_context(*args)
+      # TODO: we only need Fiber.storage after Ruby 3.2 is the floor
       thread_storage = Thread.current.keys.each_with_object({}) do |key, memo|
+        next if key == POOL_THREAD
+
         memo[key] = Thread.current[key]
       end
       fiber_storage =
@@ -215,11 +260,13 @@ module Graphiti
       Concurrent::Promises.future_on(
         self.class.global_thread_pool_executor, Thread.current.object_id, thread_storage, fiber_storage, *args
       ) do |thread_id, thread_storage, fiber_storage, *args|
-        wrap_in_rails_executor do
-          with_thread_locals(thread_storage) do
-            with_fiber_locals(fiber_storage) do
-              Graphiti.broadcast(:global_thread_pool_task_run, self.class.global_thread_pool_stats) do
-                yield(*args)
+        self.class.marking_pool_thread do
+          wrap_in_rails_executor do
+            with_thread_locals(thread_storage) do
+              with_fiber_locals(fiber_storage) do
+                Graphiti.broadcast(:global_thread_pool_task_run, self.class.global_thread_pool_stats) do
+                  yield(*args)
+                end
               end
             end
           end

data/lib/graphiti/scoping/filter.rb

@@ -82,7 +82,7 @@ module Graphiti
       if is_array
         @resource.typecast(name, value, :filterable)
       else
-        value = value.nil? || value.is_a?(Hash) ? [value] : Array(value)
+        value = (value.nil? || value.is_a?(Hash)) ? [value] : Array(value)
         value.map { |v| @resource.typecast(name, v, :filterable) }
       end
     end
@@ -100,7 +100,7 @@ module Graphiti
 
       param_value.map do |operator, value|
         if type == :hash
-          value, operator = \
+          value, operator =
             parse_hash_value(filter, param_value, value, operator)
         end
 
@@ -209,7 +209,9 @@ module Graphiti
     end
 
     def parse_string_null(filter, value)
-      return if value == "null" && filter[:allow_nil]
+      return value unless filter[:allow_nil]
+      return value.map { |item| (item == "null") ? nil : item } if value.is_a?(Array)
+      return if value == "null"
 
       value
     end

data/lib/graphiti/scoping/paginate.rb

@@ -61,7 +61,7 @@ module Graphiti
     end
 
     def page_param
-      @page_param ||= (query_hash[:page] || {})
+      @page_param ||= query_hash[:page] || {}
     end
 
     def offset

data/lib/graphiti/scoping/sort.rb

@@ -75,7 +75,7 @@ module Graphiti
     end
 
     def sort_hash(attr)
-      value = attr[0] == "-" ? :desc : :asc
+      value = (attr[0] == "-") ? :desc : :asc
       key = attr.sub("-", "").to_sym
 
       {key => value}

data/lib/graphiti/sideload/has_many.rb

@@ -2,7 +2,7 @@ class Graphiti::Sideload::HasMany < Graphiti::Sideload
   def initialize(name, opts)
     @inverse_filter = opts[:inverse_filter]
 
-    super(name, opts)
+    super
   end
 
   def type

data/lib/graphiti/sideload/polymorphic_belongs_to.rb

@@ -108,10 +108,10 @@ class Graphiti::Sideload::PolymorphicBelongsTo < Graphiti::Sideload::BelongsTo
   end
 
   def resolve(parents, query, graph_parent)
-    if Graphiti.config.concurrency
-      future_resolve(parents, query, graph_parent).value!
-    else
+    if ::Graphiti::Scope.resolve_synchronously?
       sync_resolve(parents, query, graph_parent)
+    else
+      future_resolve(parents, query, graph_parent).value!
     end
   end
 
@@ -120,7 +120,14 @@ class Graphiti::Sideload::PolymorphicBelongsTo < Graphiti::Sideload::BelongsTo
     each_resolvable_group(parents, query) do |child, group, child_query|
       promises << child.future_resolve(group, child_query, graph_parent)
     end
-    Concurrent::Promises.zip(*promises)
+    return promises.first if promises.one?
+
+    executor = ::Graphiti::Scope.global_thread_pool_executor
+    Concurrent::Promises.zip_futures_on(executor, *promises)
+      .rescue_on(executor) do |*reasons|
+        first_error = reasons.find { |reason| reason.is_a?(Exception) }
+        raise first_error
+      end
   end
 
   private

data/lib/graphiti/sideload.rb

@@ -280,9 +280,11 @@ module Graphiti
     end
 
     def load(parents, query, graph_parent)
-      return build_resource_proxy(parents, query, graph_parent).to_a unless Graphiti.config.concurrency
-
-      future_load(parents, query, graph_parent).value!
+      if Scope.resolve_synchronously?
+        build_resource_proxy(parents, query, graph_parent).to_a
+      else
+        future_load(parents, query, graph_parent).value!
+      end
     end
 
     # Override in subclass
@@ -333,10 +335,10 @@ module Graphiti
     end
 
     def resolve(parents, query, graph_parent)
-      if Graphiti.config.concurrency
-        future_resolve(parents, query, graph_parent).value!
-      else
+      if Scope.resolve_synchronously?
         sync_resolve(parents, query, graph_parent)
+      else
+        future_resolve(parents, query, graph_parent).value!
       end
     end
 

data/lib/graphiti/spec_helpers/errors_proxy.rb

@@ -62,7 +62,7 @@ module Graphiti
 
       def method_missing(id, *args, &blk)
         matches = @errors.select { |e| e.attribute.to_sym == id }
-        matches.length == 1 ? matches[0] : matches
+        (matches.length == 1) ? matches[0] : matches
       end
 
       # Any name is answered: an attribute with no matching error yields an empty

data/lib/graphiti/spec_helpers/matchers.rb

@@ -73,7 +73,7 @@ module Graphiti
         attr_reader :target, :opts, :resource
 
         def assert_opt(opt)
-          asserted_opt = opt == :resource ? :resource_class : opt
+          asserted_opt = (opt == :resource) ? :resource_class : opt
           return true if config.send(asserted_opt) == opts[opt]
 
           @opt_failures << opt_failure_message(opt, opts[opt], config.send(asserted_opt))

data/lib/graphiti/types.rb

@@ -82,6 +82,10 @@ module Graphiti
       Dry::Types["params.hash"][input]
     }
 
+    ParamArray = Dry::Types["strict.array"].constructor { |input|
+      input.is_a?(String) ? [input] : input
+    }
+
     REQUIRED_KEYS = [:params, :read, :write, :kind, :description]
 
     def self.map
@@ -193,7 +197,7 @@ module Graphiti
 
           arrays[:"array_of_#{name.to_s.pluralize}"] = {
             canonical_name: name,
-            params: Dry::Types["strict.array"].of(map[:params]),
+            params: ParamArray.of(map[:params]),
             read: Dry::Types["strict.array"].of(map[:read]),
             test: Dry::Types["strict.array"].of(map[:test]),
             write: Dry::Types["strict.array"].of(map[:write]),

data/lib/graphiti/util/cache_debug.rb

@@ -28,7 +28,7 @@ module Graphiti
           expires_in: proxy.cache_expires_in,
           etag: proxy.etag,
           miss_count: last_version[:miss_count].to_i + (changed_key? ? 1 : 0),
-          hit_count: last_version[:hit_count].to_i + (!changed_key? && !new_key? ? 1 : 0),
+          hit_count: last_version[:hit_count].to_i + ((!changed_key? && !new_key?) ? 1 : 0),
           request_count: last_version[:request_count].to_i + (last_version.present? ? 1 : 0)
         }
       end
@@ -76,8 +76,8 @@ module Graphiti
       end
 
       def changes
-        sub_keys_old = last_version[:cache_key]&.scan(/\w+\/query-[a-z0-9-]+\/args-[a-z0-9-]+/).to_a || []
-        sub_keys_new = current_version[:cache_key]&.scan(/\w+\/query-[a-z0-9-]+\/args-[a-z0-9-]+/).to_a || []
+        sub_keys_old = last_version[:cache_key]&.scan(/\w+\/query-[a-z0-9-]+\/args-[a-z0-9-]+/).to_a
+        sub_keys_new = current_version[:cache_key]&.scan(/\w+\/query-[a-z0-9-]+\/args-[a-z0-9-]+/).to_a
 
         [sub_keys_old, sub_keys_new]
       end

data/lib/graphiti/util/hash.rb

@@ -43,7 +43,7 @@ module Graphiti
       # @return [Hash] the merged hash
       # @api private
       def self.deep_merge!(hash, other)
-        merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+        merger = proc { |key, v1, v2| (Hash === v1 && Hash === v2) ? v1.merge(v2, &merger) : v2 }
         hash.merge!(other, &merger)
       end
 

data/lib/graphiti/util/persistence.rb

@@ -156,12 +156,12 @@ class Graphiti::Util::Persistence
 
   def persist_object(method, attributes)
     case method
-      when :destroy
-        call_resource_method(:destroy, attributes[:id], @caller_model)
-      when :update, nil, :disassociate
-        call_resource_method(:update, attributes, @caller_model)
-      else
-        call_resource_method(:create, attributes, @caller_model)
+    when :destroy
+      call_resource_method(:destroy, attributes[:id], @caller_model)
+    when :update, nil, :disassociate
+      call_resource_method(:update, attributes, @caller_model)
+    else
+      call_resource_method(:create, attributes, @caller_model)
     end
   end
 

data/lib/graphiti/util/serializer_relationships.rb

@@ -57,6 +57,7 @@ module Graphiti
       def block
         link_ref = link?
         sideload_ref = @sideload
+        resource_class_ref = @resource_class
         data_proc_ref = data_proc
         self_ref = self
         validate_link! if eagerly_validate_links?
@@ -71,7 +72,15 @@ module Graphiti
           if sideload_ref.resource_ids_from_foreign_key? &&
               !self_ref.send(:included_anywhere?, @proxy.query.include_hash, sideload_ref.name)
             linkage always: sideload_ref.render_resource_ids? do
-              foreign_key = @object.public_send(sideload_ref.foreign_key)
+              foreign_key = begin
+                @object.public_send(sideload_ref.foreign_key)
+              rescue NoMethodError => error
+                raise unless defined?(ActiveModel::MissingAttributeError) &&
+                  error.is_a?(ActiveModel::MissingAttributeError)
+
+                raise Errors::UnselectedForeignKey
+                  .new(resource_class_ref, sideload_ref, @object)
+              end
 
               unless foreign_key.nil?
                 {
@@ -173,7 +182,7 @@ module Graphiti
       def validate_link_for_sideload!(sideload)
         return if sideload.resource.remote?
 
-        action = sideload.type == :belongs_to ? :show : :index
+        action = (sideload.type == :belongs_to) ? :show : :index
         cache_key = :"#{@sideload.object_id}-#{action}"
         return if self.class.validated_link_cache.include?(cache_key)
         prc = Graphiti.config.context_for_endpoint

data/lib/graphiti/version.rb

@@ -1,3 +1,3 @@
 module Graphiti
-  VERSION = "2.0.0.beta.7"
+  VERSION = "2.0.0.beta.9"
 end

data/lib/graphiti.rb

@@ -33,7 +33,7 @@ require "jsonapi/serializable"
 # either way, whichever copy wins.
 {
   "graphiti_spec_helpers" => 'The "graphiti_spec_helpers/rspec" require and the GraphitiSpecHelpers namespace are unchanged.',
-  "graphiti-rails" => 'Graphiti::Rails and its config.graphiti options are unchanged. Drop the "graphiti-rails" require if you have one.',
+  "graphiti-rails" => 'Graphiti::Rails and its config.graphiti options are unchanged. Drop the "graphiti-rails" require if you have one, and add `include Graphiti::Rails::Controller` to controllers serving Graphiti resources. graphiti-rails installed that on every controller automatically. See graphiti.dev/upgrading.',
   "graphiti_errors" => "Exception handling now goes through rescue_registry. Remove `include GraphitiErrors` from your controllers — Graphiti registers its own handlers, and you can add yours with `register_exception`."
 }.each do |gem_name, guidance|
   next unless Gem.loaded_specs.key?(gem_name)

data/lib/tasks/graphiti.rake

@@ -20,7 +20,7 @@ namespace :graphiti do
   task audit: [:environment] do
     helpers.setup_rails!
     rows = Graphiti::Audit.run
-    puts Graphiti::Audit::Report.new(rows).to_s
+    puts Graphiti::Audit::Report.new(rows)
 
     exit 1 if rows.any?(&:error?)
   end

data/package-lock.json

@@ -10,6 +10,7 @@
       "license": "MIT",
       "devDependencies": {
         "@semantic-release/changelog": "^7.0.0",
+        "@semantic-release/exec": "^7.1.0",
         "@semantic-release/git": "^11.0.1",
         "semantic-release": "^25.0.8",
         "semantic-release-rubygem": "^1.2.0"
@@ -394,6 +395,119 @@
         "node": ">=18"
       }
     },
+    "node_modules/@semantic-release/exec": {
+      "version": "7.1.0",
+      "resolved": "https://registry.npmjs.org/@semantic-release/exec/-/exec-7.1.0.tgz",
+      "integrity": "sha512-4ycZ2atgEUutspPZ2hxO6z8JoQt4+y/kkHvfZ1cZxgl9WKJId1xPj+UadwInj+gMn2Gsv+fLnbrZ4s+6tK2TFQ==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "@semantic-release/error": "^4.0.0",
+        "aggregate-error": "^3.0.0",
+        "debug": "^4.0.0",
+        "execa": "^9.0.0",
+        "lodash-es": "^4.17.21",
+        "parse-json": "^8.0.0"
+      },
+      "engines": {
+        "node": ">=20.8.1"
+      },
+      "peerDependencies": {
+        "semantic-release": ">=24.1.0"
+      }
+    },
+    "node_modules/@semantic-release/exec/node_modules/aggregate-error": {
+      "version": "3.1.0",
+      "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz",
+      "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "clean-stack": "^2.0.0",
+        "indent-string": "^4.0.0"
+      },
+      "engines": {
+        "node": ">=8"
+      }
+    },
+    "node_modules/@semantic-release/exec/node_modules/clean-stack": {
+      "version": "2.2.0",
+      "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz",
+      "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=6"
+      }
+    },
+    "node_modules/@semantic-release/exec/node_modules/execa": {
+      "version": "9.6.1",
+      "resolved": "https://registry.npmjs.org/execa/-/execa-9.6.1.tgz",
+      "integrity": "sha512-9Be3ZoN4LmYR90tUoVu2te2BsbzHfhJyfEiAVfz7N5/zv+jduIfLrV2xdQXOHbaD6KgpGdO9PRPM1Y4Q9QkPkA==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "@sindresorhus/merge-streams": "^4.0.0",
+        "cross-spawn": "^7.0.6",
+        "figures": "^6.1.0",
+        "get-stream": "^9.0.0",
+        "human-signals": "^8.0.1",
+        "is-plain-obj": "^4.1.0",
+        "is-stream": "^4.0.1",
+        "npm-run-path": "^6.0.0",
+        "pretty-ms": "^9.2.0",
+        "signal-exit": "^4.1.0",
+        "strip-final-newline": "^4.0.0",
+        "yoctocolors": "^2.1.1"
+      },
+      "engines": {
+        "node": "^18.19.0 || >=20.5.0"
+      },
+      "funding": {
+        "url": "https://github.com/sindresorhus/execa?sponsor=1"
+      }
+    },
+    "node_modules/@semantic-release/exec/node_modules/indent-string": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz",
+      "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==",
+      "dev": true,
+      "license": "MIT",
+      "engines": {
+        "node": ">=8"
+      }
+    },
+    "node_modules/@semantic-release/exec/node_modules/parse-json": {
+      "version": "8.3.0",
+      "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-8.3.0.tgz",
+      "integrity": "sha512-ybiGyvspI+fAoRQbIPRddCcSTV9/LsJbf0e/S85VLowVGzRmokfneg2kwVW/KU5rOXrPSbF1qAKPMgNTqqROQQ==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "@babel/code-frame": "^7.26.2",
+        "index-to-position": "^1.1.0",
+        "type-fest": "^4.39.1"
+      },
+      "engines": {
+        "node": ">=18"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
+    "node_modules/@semantic-release/exec/node_modules/type-fest": {
+      "version": "4.41.0",
+      "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.41.0.tgz",
+      "integrity": "sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA==",
+      "dev": true,
+      "license": "(MIT OR CC0-1.0)",
+      "engines": {
+        "node": ">=16"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
     "node_modules/@semantic-release/git": {
       "version": "11.0.1",
       "resolved": "https://registry.npmjs.org/@semantic-release/git/-/git-11.0.1.tgz",

data/package.json

@@ -18,7 +18,8 @@
     "semantic-release-rubygem": "^1.2.0",
     "semantic-release": "^25.0.8",
     "@semantic-release/changelog": "^7.0.0",
-    "@semantic-release/git": "^11.0.1"
+    "@semantic-release/git": "^11.0.1",
+    "@semantic-release/exec": "^7.1.0"
   },
   "release": {
     "branches": [
@@ -132,13 +133,25 @@
         }
       ],
       "semantic-release-rubygem",
-      "@semantic-release/github",
+      [
+        "@semantic-release/github",
+        {
+          "successCommentCondition": "<% return !branch.prerelease; %>"
+        }
+      ],
+      [
+        "@semantic-release/exec",
+        {
+          "prepareCmd": "bundle exec ruby spec/performance/measure_releases.rb --pending v${nextRelease.version}"
+        }
+      ],
       [
         "@semantic-release/git",
         {
           "assets": [
             "CHANGELOG.md",
-            "lib/graphiti/version.rb"
+            "lib/graphiti/version.rb",
+            "spec/performance/performance_history.tsv"
           ],
           "message": "${nextRelease.version} CHANGELOG [skip ci]\n\n${nextRelease.notes}"
         }