Add tests for field dataload: shortcuts

Author: rmosolgo

lib/graphql/schema/field.rb

@@ -197,6 +197,7 @@ def method_conflict_warning?
       # @param resolve_batch [Symbol, true, nil] Used by {Schema.execute_next} map `objects` to a same-sized Array of results. Called on the owner type class with `objects, context, **arguments`.
       # @param resolve_each [Symbol, true, nil] Used by {Schema.execute_next} to get a value value for each item. Called on the owner type class with `object, context, **arguments`.
       # @param resolve_legacy_instance_method [Symbol, true, nil] Used by {Schema.execute_next} to get a value value for each item. Calls an instance method on the object type class.
+      # @param dataload [Class, Hash] Shorthand for making dataloader calls
       # @param max_page_size [Integer, nil] For connections, the maximum number of items to return from this field, or `nil` to allow unlimited results.
       # @param default_page_size [Integer, nil] For connections, the default number of items to return from this field, or `nil` to return unlimited results.
       # @param introspection [Boolean] If true, this field will be marked as `#introspection?` and the name may begin with `__`
@@ -219,7 +220,7 @@ def method_conflict_warning?
       # @param relay_nodes_field [Boolean] (Private, used by GraphQL-Ruby)
       # @param extras [Array<:ast_node, :parent, :lookahead, :owner, :execution_errors, :graphql_name, :argument_details, Symbol>] Extra arguments to be injected into the resolver for this field
       # @param definition_block [Proc] an additional block for configuring the field. Receive the field as a block param, or, if no block params are defined, then the block is `instance_eval`'d on the new {Field}.
-      def initialize(type: nil, name: nil, owner: nil, null: nil, description: NOT_CONFIGURED, comment: NOT_CONFIGURED, deprecation_reason: nil, method: nil, resolve_legacy_instance_method: nil, resolve_static: nil, resolve_each: nil, resolve_batch: nil, hash_key: nil, dig: nil, resolver_method: nil, connection: nil, max_page_size: NOT_CONFIGURED, default_page_size: NOT_CONFIGURED, scope: nil, introspection: false, camelize: true, trace: nil, complexity: nil, ast_node: nil, extras: EMPTY_ARRAY, extensions: EMPTY_ARRAY, connection_extension: self.class.connection_extension, resolver_class: nil, subscription_scope: nil, relay_node_field: false, relay_nodes_field: false, method_conflict_warning: true, broadcastable: NOT_CONFIGURED, arguments: EMPTY_HASH, directives: EMPTY_HASH, validates: EMPTY_ARRAY, fallback_value: NOT_CONFIGURED, dynamic_introspection: false, &definition_block)
+      def initialize(type: nil, name: nil, owner: nil, null: nil, description: NOT_CONFIGURED, comment: NOT_CONFIGURED, deprecation_reason: nil, method: nil, resolve_legacy_instance_method: nil, resolve_static: nil, resolve_each: nil, resolve_batch: nil, hash_key: nil, dig: nil, resolver_method: nil, connection: nil, max_page_size: NOT_CONFIGURED, default_page_size: NOT_CONFIGURED, scope: nil, introspection: false, camelize: true, trace: nil, complexity: nil, dataload: nil, ast_node: nil, extras: EMPTY_ARRAY, extensions: EMPTY_ARRAY, connection_extension: self.class.connection_extension, resolver_class: nil, subscription_scope: nil, relay_node_field: false, relay_nodes_field: false, method_conflict_warning: true, broadcastable: NOT_CONFIGURED, arguments: EMPTY_HASH, directives: EMPTY_HASH, validates: EMPTY_ARRAY, fallback_value: NOT_CONFIGURED, dynamic_introspection: false, &definition_block)
         if name.nil?
           raise ArgumentError, "missing first `name` argument or keyword `name:`"
         end
@@ -289,6 +290,9 @@ def initialize(type: nil, name: nil, owner: nil, null: nil, description: NOT_CON
         elsif resolve_legacy_instance_method
           @execution_next_mode = :resolve_legacy_instance_method
           @execution_next_mode_key = resolve_legacy_instance_method == true ? @method_sym : resolve_legacy_instance_method
+        elsif dataload
+          @execution_next_mode = :dataload
+          @execution_next_mode_key = dataload
         else
           @execution_next_mode = :direct_send
           @execution_next_mode_key = @method_sym

lib/graphql/schema/member/has_fields.rb

@@ -48,6 +48,7 @@ module HasFields
         # @option kwargs [Boolean] :dynamic_introspection (Private, used by GraphQL-Ruby)
         # @option kwargs [Boolean] :relay_node_field (Private, used by GraphQL-Ruby)
         # @option kwargs [Boolean] :relay_nodes_field (Private, used by GraphQL-Ruby)
+        # @option kwargs [Class, Hash] :dataload Shorthand for dataloader lookups
         # @option kwargs [Array<:ast_node, :parent, :lookahead, :owner, :execution_errors, :graphql_name, :argument_details, Symbol>] :extras Extra arguments to be injected into the resolver for this field
         # @param kwargs [Hash] Keywords for defining the field. Any not documented here will be passed to your base field class where they must be handled.
         # @param definition_block [Proc] an additional block for configuring the field. Receive the field as a block param, or, if no block params are defined, then the block is `instance_eval`'d on the new {Field}.

spec/graphql/dataloader/active_record_association_source_spec.rb

@@ -3,50 +3,7 @@
 
 describe GraphQL::Dataloader::ActiveRecordAssociationSource do
   if testing_rails?
-    class VulfpeckSchema < GraphQL::Schema
-      class Album < GraphQL::Schema::Object
-        field :name, String
-      end
-      class Band < GraphQL::Schema::Object
-        field :albums, [Album] do
-          argument :genre, String, required: false
-          argument :reverse, Boolean, required: false, default_value: false
-          argument :unscoped, Boolean, required: false, default_value: false
-        end
-
-        def albums(genre: nil, reverse:, unscoped:)
-          if unscoped
-            scope = nil
-          else
-            scope = ::Album
-            if genre
-              scope = scope.where(band_genre: genre)
-            end
-
-            scope = if reverse
-              scope.order(name: :desc)
-            else
-              scope.order(:name)
-            end
-          end
-          dataload_association(:albums, scope: scope)
-        end
-      end
-
-      class Query < GraphQL::Schema::Object
-        field :band, Band do
-          argument :name, String
-        end
-
-        def band(name:)
-          ::Band.find_by(name: name)
-        end
-      end
-
-      query(Query)
-      use GraphQL::Dataloader
-    end
-
+    include VulfpeckSchemaHelpers
     it "works with different scopes on the same object at runtime" do
       query_str = <<~GRAPHQL
         {
@@ -67,13 +24,30 @@ def band(name:)
         }
       GRAPHQL
 
-      result = VulfpeckSchema.execute(query_str)
+      result = exec_query(query_str)
       assert_equal ["Mit Peck", "My First Car"], result["data"]["band"]["allAlbums"].map { |a| a["name"] }
       assert_equal ["Mit Peck", "My First Car"], result["data"]["band"]["unscopedAlbums"].map { |a| a["name"] }
       assert_equal ["My First Car", "Mit Peck"], result["data"]["band"]["reverseAlbums"].map { |a| a["name"] }
       assert_equal [], result["data"]["band"]["countryAlbums"]
     end
 
+    it "works with field shorthands" do
+      skip("NOT IMPLEMENTED") unless TESTING_EXEC_NEXT
+      result = exec_query <<-GRAPHQL
+        {
+          band(name: "Vulfpeck") {
+            allAlbums {
+              name
+              band { name }
+            }
+          }
+        }
+      GRAPHQL
+
+      assert_equal ["Mit Peck", "My First Car"], result["data"]["band"]["allAlbums"].map { |a| a["name"] }
+      assert_equal ["Vulfpeck", "Vulfpeck"], result["data"]["band"]["allAlbums"].map { |a| a["band"]["name"] }
+    end
+
     it_dataloads "queries for associated records when the association isn't already loaded" do |d|
       my_first_car = ::Album.find(2)
       homey = ::Album.find(4)

spec/graphql/dataloader/active_record_source_spec.rb

@@ -3,6 +3,14 @@
 
 describe GraphQL::Dataloader::ActiveRecordSource do
   if testing_rails?
+    include VulfpeckSchemaHelpers
+    it "works with field config shorthands" do
+      skip("Not implemented") unless TESTING_EXEC_NEXT
+      query_str = "{ rootBand { name } }"
+      assert_equal "Wilco", exec_query(query_str, root_value: OpenStruct.new(band_name: "Wilco"))["data"]["rootBand"]["name"]
+      assert_equal "Chon", exec_query(query_str, root_value: OpenStruct.new(band_name: "Chon"))["data"]["rootBand"]["name"]
+    end
+
     describe "finding by ID" do
       it_dataloads "loads once, then returns from a cache when available" do |d|
         log = with_active_record_log(colorize: false) do

spec/graphql/dataloader/source_spec.rb

@@ -8,6 +8,18 @@ def fetch(keys)
     end
   end
 
+  if testing_rails?
+    describe "with field configuration shorthands" do
+      include VulfpeckSchemaHelpers
+      it "calls the configured source" do
+        skip("Not implemented") unless TESTING_EXEC_NEXT
+        result = exec_query("{ bandsCount albumsCount }")
+        assert_equal 4, result["data"]["bandsCount"]
+        assert_equal 6, result["data"]["albumsCount"]
+      end
+    end
+  end
+
   it "raises an error when it tries too many times to sync" do
     dl = GraphQL::Dataloader.new
     dl.append_job { dl.with(FailsToLoadSource).load(1) }

spec/support/active_record_setup.rb

@@ -163,6 +163,80 @@ class CompositeBand < Band
   c.albums.create!(id: 4, name: "Homey")
   c.albums.create!(id: 5, name: "Chon")
   w.albums.create!(id: 6, name: "Summerteeth")
+
+  module VulfpeckSchemaHelpers
+    class VulfpeckSchema < GraphQL::Schema
+      class ModelCountSource < GraphQL::Dataloader::Source
+        def initialize(model)
+          @model = model
+        end
+
+        def fetch(objects)
+          result = @model.count
+          Array.new(objects.size, result)
+        end
+      end
+
+      class Album < GraphQL::Schema::Object
+        field :name, String
+        field :band, "VulfpeckSchemaHelpers::VulfpeckSchema::Band", dataload: { association: true }
+      end
+      class Band < GraphQL::Schema::Object
+        field :name, String
+        field :albums, [Album], resolve_legacy_instance_method: true do
+          argument :genre, String, required: false
+          argument :reverse, Boolean, required: false, default_value: false
+          argument :unscoped, Boolean, required: false, default_value: false
+        end
+
+        def albums(genre: nil, reverse:, unscoped:)
+          if unscoped
+            scope = nil
+          else
+            scope = ::Album
+            if genre
+              scope = scope.where(band_genre: genre)
+            end
+
+            scope = if reverse
+              scope.order(name: :desc)
+            else
+              scope.order(:name)
+            end
+          end
+          dataload_association(:albums, scope: scope)
+        end
+
+        field :all_albums, [Album], dataload: { association: :albums }
+      end
+
+      class Query < GraphQL::Schema::Object
+        field :band, Band, resolve_legacy_instance_method: true do
+          argument :name, String
+        end
+
+        def band(name:)
+          ::Band.find_by(name: name)
+        end
+
+        field :root_band, Band, dataload: { model: ::Band, using: :band_name, find_by: :name }
+        field :bands_count, Integer, dataload: { with: ModelCountSource, by: [::Band]}
+        field :albums_count, Integer, dataload: { with: ModelCountSource, by: [::Album]}
+      end
+
+      query(Query)
+      use GraphQL::Dataloader
+      use GraphQL::Execution::Next
+    end
+
+    def exec_query(...)
+      if TESTING_EXEC_NEXT
+        VulfpeckSchema.execute_next(...)
+      else
+        VulfpeckSchema.execute(...)
+      end
+    end
+  end
   class Author < ActiveRecord::Base
     has_many :books