graphiti_graphql 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3636c8634e8e8798b5faa86fed69735c02be79903ecca7f4fb09418786756f1
-  data.tar.gz: 6ce1f38785202d1fb6972152731ef5f535fd4f3514f8996eb60f1abc13431ea0
+  metadata.gz: 94c56621cb36c796bbefd0e8f626d90e359e2e8740b2cb443a8293e2f98b57df
+  data.tar.gz: dd1d065a140a292adab0f5d3c54e426dfcfa55b3691523f50ceb947fa752fdbd
 SHA512:
-  metadata.gz: 45796a4cde424e1fcec4d8eef45238fb52d4fb4d0980c067dbd8321a9dd1b9e3f5d487a3125d9fe0b50bb0d2a452bf79520e5cee4438ee7f31da229c51b70e98
-  data.tar.gz: c1f7707ea8591be326b7a371b797bd15a969cdf5c115e35892966c310dcb75be656d4a81b408b6c72d83a192a3d0dc69042b91a6006d3220b9fa31a8134eb004
+  metadata.gz: 94886a1ebbed6fee376239b1a10c197c3891cd280aad29973a7a1ce4d6f769e9c1fc3949bb4613dbe98c44d1f584a1b2863955c605798525e24ee1766b136891
+  data.tar.gz: d0ca0298e0e77da84361a1748a2b36457569910d43aed602a94cfd6eb8869c32c8a0db611bca68dbf64382fe0c5cd8dddb8956c105af9ae7819c4e92cce03adc

data/Gemfile

@@ -3,4 +3,4 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in graphiti_graphql.gemspec
 gemspec
 
-gem "graphiti", path: "../graphiti"
+gem "graphiti"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../graphiti
   specs:
-    graphiti (1.2.31)
+    graphiti (1.2.32)
       activesupport (>= 4.1)
       concurrent-ruby (~> 1.0)
       dry-types (>= 0.15.0, < 2.0)
@@ -12,7 +12,7 @@ PATH
 PATH
   remote: .
   specs:
-    graphiti_graphql (0.1.0)
+    graphiti_graphql (0.1.1)
       activesupport (>= 4.1)
       graphql (~> 1.12)
 
@@ -35,7 +35,7 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
-    dry-configurable (0.12.0)
+    dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5.0)
     dry-container (0.7.2)
@@ -47,7 +47,7 @@ GEM
     dry-logic (1.1.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
-    dry-types (1.5.0)
+    dry-types (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
       dry-core (~> 0.5, >= 0.5)

data/README.md

@@ -1,35 +1,159 @@
 # GraphitiGraphql
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/graphiti_graphql`. To experiment with that code, run `bin/console` for an interactive prompt.
+GraphQL (and Apollo Federation) support for Graphiti. Serve traditional Rails JSON, JSON:API or GraphQL with the same codebase.
 
-TODO: Delete this and the text above, and describe your gem
+Currently read-only, but you can add your own Mutations [manually](#blending-with-graphql-ruby).
 
-## Installation
+## Setup
 
-Add this line to your application's Gemfile:
+Add to your `Gemfile`:
+
+```rb
+gem 'graphiti', ">= 1.2.32"
+gem "graphiti_graphql"
+```
+
+Mount the engine:
 
 ```ruby
-gem 'graphiti_graphql'
+# config/routes.rb
+Rails.application.routes.draw do
+  scope path: ApplicationResource.endpoint_namespace, defaults: { format: :jsonapi } do
+    # ... normal graphiti stuff ...
+
+    mount GraphitiGraphQL::Engine, at: "/gql"
+  end
+end
 ```
 
-And then execute:
+For a default Graphiti app, you can now serve GraphQL by POSTing to `/api/v1/gql`.
+
+That's it 🎉!
 
-    $ bundle
+#### GraphiQL
+
+You can add the GraphiQL editor to the project via [graphiql-rails](https://github.com/rmosolgo/graphiql-rails) as normal, but to save you the time here are the steps to make it work when Rails is running in API-only mode:
+
+Add to the Gemfile:
+
+```ruby
+gem "graphiql-rails"
+gem 'sprockets', '~> 3' # https://github.com/rmosolgo/graphiql-rails/issues/53
+```
 
-Or install it yourself as:
+And then in `config/application.rb`:
 
-    $ gem install graphiti_graphql
+```ruby
+# *Uncomment* this line!
+# require "sprockets/railtie"
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Blending with graphql-ruby
+
+Define your Schema and Type classes as normal. Then in an initializer:
 
-## Development
+```ruby
+# config/initializers/graphiti.rb
+GraphitiGraphQL.schema_class = MySchema
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Any pre-existing GraphQL endpoint will continue working as normal. But the GQL endpoint you mounted in `config/routes.rb` will now serve BOTH your low-level `graphql-ruby` schema AND your Graphiti-specific schema. Note these cannot (currently) be served side-by-side on under `query` within the *same request*.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+By default the GraphQL context will be `Graphiti.context[:object]`, which is the controller being called. You might want to customize this so your existing graphql-ruby code continues to expect the same context:
 
-## Contributing
+```ruby
+GraphitiGraphQL.define_context do |controller|
+  { current_user: controller.current_user }
+end
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/graphiti_graphql.
+#### Adding Federation Support
+
+Add to the Gemfile
+
+```ruby
+gem "apollo-federation"
+gem "graphql-batch"
+```
+
+And change the way we require `graphiti_graphql`:
+
+```ruby
+gem "graphiti_graphql", require: "graphiti_graphql/federation"
+```
+
+To create a federated relationship:
+
+```ruby
+# PositionResource
+federated_belongs_to :employee
+```
+
+Or pass `type` and/or `foreign_key` to customize:
+
+```ruby
+# type here is the GraphQL Type
+federated_belongs_to :employee, type: "MyEmployee", foreign_key: :emp_id
+```
+
+For `has_many` it's a slightly different syntax because we're adding the relationship to the ***remote*** type:
+
+```ruby
+federated_type("Employee").has_many :positions # foreign_key: optional
+```
+
+Finally, `has_many` accepts the traditional `params` block that works as normal:
+
+```ruby
+federated_type("Employee").has_many :positions do
+  params do |hash|
+    hash[:filter][:active] = true
+    hash[:sort] = "-title"
+  end
+end
+```
+
+Remember that any time you make a change that affects the schema, you will have to bounce your federation gateway. This is how Apollo Federation works when not in "managed" mode and is unrelated to `graphiti_graphql`.
+
+## Configuration
+
+#### Entrypoints
+
+By default all Graphiti resources will expose their `index` and `show` functionality. IOW `EmployeeResource` now serves a list at `Query#employees` and a single employee at `Query#employee(id: 123)`. To limit the entrypoints:
+
+```ruby
+GraphitiGraphQL::Schema.entrypoints = [
+  EmployeeResource
+]
+```
+
+#### Schema Reloading
+
+You may want to automatically regenerate the GQL schema when when Rails reloads your classes, or you may not want to pay that performance penalty. To turn off the automatic reloading:
+
+```ruby
+# config/initializers/graphiti.rb
+GraphitiGraphQL.config.schema_reloading = false
+```
+
+#### `.graphql_entrypoint`
+
+If the field you want on `Query` can't be inferred from the class name:
+
+```ruby
+class EmployeeResource < ApplicationResource
+  self.graphql_entrypoint = :workers
+end
+```
+
+You can now
+
+```
+query {
+  workers {
+    firstName
+  }
+}
+```

data/graphiti_graphql.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "graphiti", ">= 1.2.33"
   spec.add_dependency "activesupport", ">= 4.1"
   spec.add_dependency "graphql", "~> 1.12"
 

data/lib/graphiti_graphql.rb

@@ -11,38 +11,58 @@ require "graphiti_graphql/schema"
 require "graphiti_graphql/runner"
 require "graphiti_graphql/util"
 
-Graphiti.class_eval do
-  class << self
-    attr_writer :graphql_schema
-  end
+module GraphitiGraphQL
+  class Configuration
+    attr_accessor :schema_reloading
 
-  # TODO probably move these off of Graphiti
-  def self.gql(query, variables)
-    runner = ::GraphitiGraphQL::Runner.new
-    runner.execute(query, variables, graphql_schema.schema)
-  end
+    def initialize
+      self.schema_reloading = true
+    end
 
-  def self.graphql_schema
-    @graphql_schema ||= GraphitiGraphQL::Schema.generate
-  end
+    def define_context(&blk)
+      @define_context = blk
+    end
 
-  def self.graphql_schema?
-    !!@graphql_schema
+    def get_context
+      obj = Graphiti.context[:object]
+      if @define_context
+        @define_context.call(obj)
+      else
+        {object: obj}
+      end
+    end
   end
 
-  def self.graphql_schema!(entrypoint_resources = nil)
-    @graphql_schema = GraphitiGraphQL::Schema.generate(entrypoint_resources)
+  module Runnable
+    def gql(query, variables)
+      runner = ::GraphitiGraphQL::Runner.new
+      runner.execute(query, variables, GraphitiGraphQL.schemas.graphql)
+    end
   end
-end
 
-module GraphitiGraphQL
-  class Error < StandardError; end
+  class SchemaProxy
+    def graphql
+      generated.schema
+    end
 
-  class Configuration
-    attr_accessor :schema_reloading
+    def graphiti
+      generated.graphiti_schema
+    end
 
-    def initialize
-      self.schema_reloading = true
+    def generated
+      @generated ||= GraphitiGraphQL::Schema.generate
+    end
+
+    def generate!(entrypoint_resources = nil)
+      @generated = GraphitiGraphQL::Schema.generate(entrypoint_resources)
+    end
+
+    def generated?
+      !!@generated
+    end
+
+    def clear!
+      @generated = nil
     end
   end
 
@@ -54,20 +74,13 @@ module GraphitiGraphQL
     @config ||= Configuration.new
   end
 
-  def self.define_context(&blk)
-    @define_context = blk
-  end
-
-  def self.get_context
-    obj = Graphiti.context[:object]
-    if @define_context
-      @define_context.call(obj)
-    else
-      {object: obj}
-    end
+  def self.schemas
+    @schemas ||= SchemaProxy.new
   end
 end
 
+Graphiti.extend(GraphitiGraphQL::Runnable)
+
 if defined?(::Rails)
   require "graphiti_graphql/engine"
 end

data/lib/graphiti_graphql/engine.rb

@@ -48,16 +48,6 @@ module GraphitiGraphQL
       end
     end
 
-    # We store a list of all federated relationships
-    # Clear that list when classes are cleared so we don't keep appending
-    initializer "graphiti_graphql.clear_federation" do |app|
-      if defined?(GraphitiGraphQL::Federation)
-        GraphitiGraphQL::Engine.reloader_class.after_class_unload do
-          GraphitiGraphQL::Federation.clear!
-        end
-      end
-    end
-
     initializer "graphiti_graphql.schema_reloading" do |app|
       # Only reload the schema if we ask for it
       # Some may want to avoid the performance penalty
@@ -66,8 +56,8 @@ module GraphitiGraphQL
           # We want to reload the schema when classes change
           # But this way, you only pay the cost (time) when the GraphQL endpoint
           # is actually hit
-          if Graphiti.graphql_schema?
-            Graphiti.graphql_schema = nil
+          if GraphitiGraphQL.schemas.generated?
+            GraphitiGraphQL.schemas.clear!
           end
         end
       end

data/lib/graphiti_graphql/federation.rb

@@ -12,27 +12,28 @@ end
 
 # We don't want to add these as dependencies,
 # but do need to check things don't break
-if Gem::Version.new(ApolloFederation::VERSION) >= Gem::Version.new('2.0.0')
+if Gem::Version.new(ApolloFederation::VERSION) >= Gem::Version.new("2.0.0")
   raise "graphiti_graphql federation is incompatible with apollo-federation >= 2"
 end
 
-if Gem::Version.new(GraphQL::Batch::VERSION) >= Gem::Version.new('1.0.0')
+if Gem::Version.new(GraphQL::Batch::VERSION) >= Gem::Version.new("1.0.0")
   raise "graphiti_graphql federation is incompatible with graphql-batch >= 1"
 end
 
 require "graphiti_graphql"
+require "graphiti_graphql/federation/loaders/has_many"
+require "graphiti_graphql/federation/loaders/belongs_to"
+require "graphiti_graphql/federation/federated_resource"
+require "graphiti_graphql/federation/federated_relationship"
+require "graphiti_graphql/federation/resource_dsl"
+require "graphiti_graphql/federation/apollo_federation_override"
+require "graphiti_graphql/federation/schema_decorator"
 
 module GraphitiGraphQL
   module Federation
-
-    def self.external_resources
-      @external_resources ||= {}
-    end
-
-    def self.clear!
-      @external_resources = {}
-    end
-
+    # * Extend Graphiti::Resource with federated_* macros
+    # * Add apollo-federation modules to graphql-ruby base types
+    # * Mark federation = true for checks down the line
     def self.setup!
       Graphiti::Resource.send(:include, ResourceDSL)
       schema = GraphitiGraphQL::Schema
@@ -50,214 +51,5 @@ module GraphitiGraphQL
       schema.base_interface.field_class(schema.base_field)
       GraphitiGraphQL::Schema.federation = true
     end
-
-    class HasManyLoader < GraphQL::Batch::Loader
-      def initialize(resource_class, params, foreign_key)
-        @resource_class = resource_class
-        @params = params
-        @foreign_key = foreign_key
-      end
-
-      def perform(ids)
-        @params[:filter] ||= {}
-        @params[:filter].merge!(@foreign_key => { eq: ids.join(",") })
-
-        if ids.length > 1 && @params[:page]
-          raise Graphiti::Errors::UnsupportedPagination
-        elsif !@params[:page]
-          @params[:page] = { size: 999 }
-        end
-
-        Util.with_gql_context do
-          records = @resource_class.all(@params).as_json[:data]
-          fk = ->(record) { record[@foreign_key].to_s }
-          map = records.group_by(&fk)
-          ids.each do |id|
-            fulfill(id, (map[id] || []))
-          end
-        end
-      end
-    end
-
-    class BelongsToLoader < GraphQL::Batch::Loader
-      def initialize(resource_class, fields)
-        @resource_class = resource_class
-        @fields = fields
-      end
-
-      def perform(ids)
-        Util.with_gql_context do
-          params = { filter: { id: { eq: ids.join(",") } } }
-          params[:fields] = { @resource_class.type => @fields.join(",") }
-          records = @resource_class.all(params).as_json[:data]
-          pk = ->(record) { record[:id].to_s }
-          map = records.index_by(&pk)
-          ids.each { |id| fulfill(id, map[id]) }
-        end
-      end
-    end
-
-    class ExternalRelationship
-      attr_reader :name, :local_resource_class, :foreign_key
-
-      def initialize(kind, name, local_resource_class, foreign_key)
-        @kind = kind
-        @name = name
-        @local_resource_class = local_resource_class
-        @foreign_key = foreign_key
-      end
-
-      def has_many?
-        @kind == :has_many
-      end
-
-      def belongs_to?
-        @kind == :belongs_to
-      end
-    end
-
-    class ExternalResource
-      attr_reader :type_name, :relationships
-
-      def initialize(type_name)
-        @type_name = type_name
-        @relationships = {}
-      end
-
-      def add_relationship(
-        kind,
-        name,
-        local_resource_class,
-        foreign_key
-      )
-        @relationships[name] = ExternalRelationship
-          .new(kind, name, local_resource_class, foreign_key)
-      end
-    end
-
-    class TypeProxy
-      def initialize(caller, type_name)
-        @caller = caller
-        @type_name = type_name
-      end
-
-      def has_many(relationship_name, foreign_key: nil)
-        @caller.federated_has_many relationship_name,
-          type: @type_name,
-          foreign_key: foreign_key
-      end
-    end
-
-    module ResourceDSL
-      extend ActiveSupport::Concern
-
-      class_methods do
-        def federated_type(type_name)
-          TypeProxy.new(self, type_name)
-        end
-
-        # TODO: raise error if belongs_to doesn't have corresponding filter (on schema gen)
-        # TODO: hang these on the resource classes themselves
-        def federated_has_many(name, type:, foreign_key: nil)
-          foreign_key ||= :"#{type.underscore}_id"
-          resource = GraphitiGraphQL::Federation.external_resources[type] ||=
-            ExternalResource.new(type)
-          resource.add_relationship(:has_many, name, self, foreign_key)
-
-          attribute = attributes.find do |name, config|
-            name.to_sym == foreign_key && !!config[:readable] && !!config[:filterable]
-          end
-          has_filter = filters.key?(foreign_key)
-          if !attribute && !has_filter
-            attribute foreign_key, :integer,
-              only: [:readable, :filterable],
-              schema: false,
-              readable: :gql?,
-              filterable: :gql?
-          elsif has_filter && !attribute
-            prior = filters[foreign_key]
-            attribute foreign_key, prior[:type],
-              only: [:readable, :filterable],
-              schema: false,
-              readable: :gql?
-            filters[foreign_key] = prior
-          elsif attribute && !has_filter
-            filter foreign_key, attribute[:type]
-          end
-        end
-
-        def federated_belongs_to(name, type: nil, foreign_key: nil)
-          type ||= name.to_s.camelize
-          foreign_key ||= :"#{name.to_s.underscore}_id"
-          resource = GraphitiGraphQL::Federation.external_resources[type] ||=
-            ExternalResource.new(type)
-          resource.add_relationship(:belongs_to, name, self, foreign_key)
-
-          attribute name, :hash, readable: :gql?, only: [:readable], schema: false do
-            fk = if prc = self.class.attribute_blocks[foreign_key]
-              instance_eval(&prc)
-            else
-              @object.send(foreign_key)
-            end
-            {
-              __typename: type,
-              id: fk.to_s
-            }
-          end
-        end
-      end
-
-      def gql?
-        Graphiti.context[:graphql]
-      end
-    end
-  end
-end
-
-# Hacky sack!
-# All we're doing here is adding extras: [:lookahead] to the _entities field
-# And passing to to the .resolve_reference method when arity is 3
-# This way we can request only fields the user wants when resolving the reference
-# Important because we blow up when a field is guarded, and the guard fails
-ApolloFederation::EntitiesField::ClassMethods.module_eval do
-  alias_method :define_entities_field_without_override, :define_entities_field
-  def define_entities_field(*args)
-    result = define_entities_field_without_override(*args)
-    extras = fields["_entities"].extras
-    extras |= [:lookahead]
-    fields["_entities"].instance_variable_set(:@extras, extras)
-    result
-  end
-end
-
-module EntitiesFieldOverride
-  def _entities(representations:, lookahead:) # accept the lookahead as argument
-    representations.map do |reference|
-      typename = reference[:__typename]
-      type = context.warden.get_type(typename)
-      if type.nil? || type.kind != GraphQL::TypeKinds::OBJECT
-        raise "The _entities resolver tried to load an entity for type \"#{typename}\"," \
-              ' but no object type of that name was found in the schema'
-      end
-
-      type_class = type.is_a?(GraphQL::ObjectType) ? type.metadata[:type_class] : type
-      if type_class.respond_to?(:resolve_reference)
-        meth = type_class.method(:resolve_reference)
-        # ** THIS IS OUR EDIT **
-        result = if meth.arity == 3
-          type_class.resolve_reference(reference, context, lookahead)
-        else
-          type_class.resolve_reference(reference, context)
-        end
-      else
-        result = reference
-      end
-
-      context.schema.after_lazy(result) do |resolved_value|
-        context[resolved_value] = type
-        resolved_value
-      end
-    end
   end
 end
-ApolloFederation::EntitiesField.send :prepend, EntitiesFieldOverride