Move schema mount login into separate class

mcelicalderon · mcelicalderon · commit 510ac1e5506b · 2020-06-07T21:03:29.000-05:00
diff --git a/config/routes.rb b/config/routes.rb
@@ -12,5 +12,7 @@
     GraphqlDevise::Schema.query(GraphqlDevise::Types::QueryType)
 
     GraphqlDevise.load_schema
+
+    Devise.mailer.helper(GraphqlDevise::MailerHelper)
   end
 end
diff --git a/lib/graphql_devise.rb b/lib/graphql_devise.rb
@@ -18,12 +18,21 @@ def self.load_schema
     @schema_loaded = true
   end
 
-  def self.mount_resource(resource)
-    @mounted_resources << resource
+  def self.resource_mounted?(mapping_name)
+    @mounted_resources.include?(mapping_name)
   end
 
-  def self.resource_mounted?(resource)
-    @mounted_resources.include?(resource)
+  def self.mount_resource(mapping_name)
+    @mounted_resources << mapping_name
+  end
+
+  def self.add_mapping(mapping_name, resource)
+    return if Devise.mappings.key?(mapping_name)
+
+    Devise.add_mapping(
+      mapping_name.to_s.pluralize.to_sym,
+      module: :devise, class_name: resource
+    )
   end
 end
 
@@ -47,3 +56,6 @@ def self.resource_mounted?(resource)
 require 'graphql_devise/mount_method/options_validator'
 require 'graphql_devise/mount_method/operation_preparer'
 require 'graphql_devise/mount_method/operation_sanitizer'
+
+require 'graphql_devise/resource_loader'
+require 'graphql_devise/schema_plugin'
diff --git a/lib/graphql_devise/mount_method/operation_preparer.rb b/lib/graphql_devise/mount_method/operation_preparer.rb
@@ -8,10 +8,10 @@
 module GraphqlDevise
   module MountMethod
     class OperationPreparer
-      def initialize(resource:, selected_operations:, preparer:, custom:, additional_operations:)
+      def initialize(mapping_name:, selected_operations:, preparer:, custom:, additional_operations:)
         @selected_operations   = selected_operations
         @preparer              = preparer
-        @mapping_name          = resource.underscore.tr('/', '_')
+        @mapping_name          = mapping_name
         @custom                = custom
         @additional_operations = additional_operations
       end
diff --git a/lib/graphql_devise/mount_method/operation_preparers/resource_name_setter.rb b/lib/graphql_devise/mount_method/operation_preparers/resource_name_setter.rb
@@ -7,7 +7,7 @@ def initialize(name)
         end
 
         def call(operation)
-          operation.instance_variable_set(:@resource_name, @name.to_sym)
+          operation.instance_variable_set(:@resource_name, @name)
 
           operation
         end
diff --git a/lib/graphql_devise/rails/routes.rb b/lib/graphql_devise/rails/routes.rb
@@ -1,80 +1,13 @@
 module ActionDispatch::Routing
   class Mapper
-    DEVISE_OPERATIONS = [
-      :sessions,
-      :registrations,
-      :passwords,
-      :confirmations,
-      :omniauth_callbacks,
-      :unlocks,
-      :invitations
-    ].freeze
-
     def mount_graphql_devise_for(resource, options = {})
-      default_operations = GraphqlDevise::DefaultOperations::MUTATIONS.merge(GraphqlDevise::DefaultOperations::QUERIES)
-
-      # clean_options responds to all keys defined in GraphqlDevise::MountMethod::SUPPORTED_OPTIONS
-      clean_options = GraphqlDevise::MountMethod::OptionSanitizer.new(options).call!
-
-      GraphqlDevise::MountMethod::OptionsValidator.new(
-        [
-          GraphqlDevise::MountMethod::OptionValidators::SkipOnlyValidator.new(options: clean_options),
-          GraphqlDevise::MountMethod::OptionValidators::ProvidedOperationsValidator.new(
-            options: clean_options, supported_operations: default_operations
-          )
-        ]
-      ).validate!
-
-      devise_for(
-        resource.pluralize.underscore.tr('/', '_').to_sym,
-        module:     :devise,
-        class_name: resource,
-        skip:       DEVISE_OPERATIONS
+      clean_options = GraphqlDevise::ResourceLoader.new(resource, options, true).call(
+        GraphqlDevise::Types::QueryType,
+        GraphqlDevise::Types::MutationType
       )
 
-      devise_scope resource.underscore.tr('/', '_').to_sym do
-        post clean_options.at, to: 'graphql_devise/graphql#auth'
-        get  clean_options.at, to: 'graphql_devise/graphql#auth'
-      end
-
-      # Avoid routes reload done by Devise
-      return if GraphqlDevise.resource_mounted?(resource)
-
-      authenticatable_type = clean_options.authenticatable_type.presence ||
-                             "Types::#{resource}Type".safe_constantize ||
-                             GraphqlDevise::Types::AuthenticatableType
-
-      prepared_mutations = GraphqlDevise::MountMethod::OperationPreparer.new(
-        resource:              resource,
-        custom:                clean_options.operations,
-        additional_operations: clean_options.additional_mutations,
-        preparer:              GraphqlDevise::MountMethod::OperationPreparers::MutationFieldSetter.new(authenticatable_type),
-        selected_operations:   GraphqlDevise::MountMethod::OperationSanitizer.call(
-          default: GraphqlDevise::DefaultOperations::MUTATIONS, only: clean_options.only, skipped: clean_options.skip
-        )
-      ).call
-
-      prepared_mutations.each do |action, mutation|
-        GraphqlDevise::Types::MutationType.field(action, mutation: mutation)
-      end
-
-      prepared_queries = GraphqlDevise::MountMethod::OperationPreparer.new(
-        resource:              resource,
-        custom:                clean_options.operations,
-        additional_operations: clean_options.additional_queries,
-        preparer:              GraphqlDevise::MountMethod::OperationPreparers::ResolverTypeSetter.new(authenticatable_type),
-        selected_operations:   GraphqlDevise::MountMethod::OperationSanitizer.call(
-          default: GraphqlDevise::DefaultOperations::QUERIES, only: clean_options.only, skipped: clean_options.skip
-        )
-      ).call
-
-      prepared_queries.each do |action, resolver|
-        GraphqlDevise::Types::QueryType.field(action, resolver: resolver)
-      end
-
-      Devise.mailer.helper(GraphqlDevise::MailerHelper)
-
-      GraphqlDevise.mount_resource(resource)
+      post clean_options.at, to: 'graphql_devise/graphql#auth'
+      get  clean_options.at, to: 'graphql_devise/graphql#auth'
     end
   end
 end
diff --git a/lib/graphql_devise/resource_loader.rb b/lib/graphql_devise/resource_loader.rb
@@ -0,0 +1,83 @@
+module GraphqlDevise
+  class ResourceLoader
+    def initialize(resource, options, routing = false)
+      @resource           = resource
+      @options            = options
+      @routing            = routing
+      @default_operations = GraphqlDevise::DefaultOperations::MUTATIONS.merge(GraphqlDevise::DefaultOperations::QUERIES)
+    end
+
+    def call(query, mutation)
+      mapping_name = @resource.to_s.underscore.tr('/', '_').to_sym
+
+      # clean_options responds to all keys defined in GraphqlDevise::MountMethod::SUPPORTED_OPTIONS
+      clean_options = GraphqlDevise::MountMethod::OptionSanitizer.new(@options).call!
+
+      return clean_options if GraphqlDevise.resource_mounted?(mapping_name) && @routing
+
+      validate_options!(clean_options)
+
+      authenticatable_type = clean_options.authenticatable_type.presence ||
+                             "Types::#{@resource}Type".safe_constantize ||
+                             GraphqlDevise::Types::AuthenticatableType
+
+      prepared_mutations = prepare_mutations(mapping_name, clean_options, authenticatable_type)
+
+      if prepared_mutations.any? && mutation.blank?
+        raise GraphqlDevise::Error, 'You need to provide a mutation type unless all mutations are skipped'
+      end
+
+      prepared_mutations.each do |action, prepared_mutation|
+        mutation.field(action, mutation: prepared_mutation)
+      end
+
+      prepared_resolvers = prepare_resolvers(mapping_name, clean_options, authenticatable_type)
+
+      prepared_resolvers.each do |action, resolver|
+        query.field(action, resolver: resolver)
+      end
+
+      GraphqlDevise.add_mapping(mapping_name, @resource)
+      GraphqlDevise.mount_resource(mapping_name) if @routing
+
+      clean_options
+    end
+
+    private
+
+    def prepare_resolvers(mapping_name, clean_options, authenticatable_type)
+      GraphqlDevise::MountMethod::OperationPreparer.new(
+        mapping_name:          mapping_name,
+        custom:                clean_options.operations,
+        additional_operations: clean_options.additional_queries,
+        preparer:              GraphqlDevise::MountMethod::OperationPreparers::ResolverTypeSetter.new(authenticatable_type),
+        selected_operations:   GraphqlDevise::MountMethod::OperationSanitizer.call(
+          default: GraphqlDevise::DefaultOperations::QUERIES, only: clean_options.only, skipped: clean_options.skip
+        )
+      ).call
+    end
+
+    def prepare_mutations(mapping_name, clean_options, authenticatable_type)
+      GraphqlDevise::MountMethod::OperationPreparer.new(
+        mapping_name:          mapping_name,
+        custom:                clean_options.operations,
+        additional_operations: clean_options.additional_mutations,
+        preparer:              GraphqlDevise::MountMethod::OperationPreparers::MutationFieldSetter.new(authenticatable_type),
+        selected_operations:   GraphqlDevise::MountMethod::OperationSanitizer.call(
+          default: GraphqlDevise::DefaultOperations::MUTATIONS, only: clean_options.only, skipped: clean_options.skip
+        )
+      ).call
+    end
+
+    def validate_options!(clean_options)
+      GraphqlDevise::MountMethod::OptionsValidator.new(
+        [
+          GraphqlDevise::MountMethod::OptionValidators::SkipOnlyValidator.new(options: clean_options),
+          GraphqlDevise::MountMethod::OptionValidators::ProvidedOperationsValidator.new(
+            options: clean_options, supported_operations: @default_operations
+          )
+        ]
+      ).validate!
+    end
+  end
+end
diff --git a/lib/graphql_devise/schema_plugin.rb b/lib/graphql_devise/schema_plugin.rb
@@ -0,0 +1,22 @@
+module GraphqlDevise
+  class SchemaPlugin
+    def initialize(query:, mutation: nil, resource_loaders: [])
+      @query            = query
+      @mutation         = mutation
+      @resource_loaders = resource_loaders
+
+      # Must happen on initialize so operations are loaded before the types are added to the schema on GQL < 1.10
+      load_fields
+    end
+
+    private
+
+    def load_fields
+      @resource_loaders.each do |resource_loader|
+        raise Error, 'Invalid resource loader instance' unless resource_loader.instance_of?(GraphqlDevise::ResourceLoader)
+
+        resource_loader.call(@query, @mutation, false)
+      end
+    end
+  end
+end
diff --git a/spec/services/mount_method/operation_preparer_spec.rb b/spec/services/mount_method/operation_preparer_spec.rb
@@ -4,7 +4,7 @@
   describe '#call' do
     subject(:prepared_operations) do
       described_class.new(
-        resource:              resource,
+        mapping_name:          mapping,
         selected_operations:   selected,
         preparer:              preparer,
         custom:                custom,
@@ -13,7 +13,7 @@
     end
 
     let(:logout_class) { Class.new(GraphQL::Schema::Resolver) }
-    let(:resource)     { 'User' }
+    let(:mapping)      { :user }
     let(:selected)     { { login: double(:login_default), logout: logout_class } }
     let(:preparer)     { double(:preparer, call: logout_class) }
     let(:custom)       { { login: double(:custom_login, graphql_name: nil) } }
diff --git a/spec/services/mount_method/operation_preparers/custom_operation_preparer_spec.rb b/spec/services/mount_method/operation_preparers/custom_operation_preparer_spec.rb
@@ -6,7 +6,7 @@
 
     let(:login_operation)  { double(:confirm_operation, graphql_name: nil) }
     let(:logout_operation) { double(:sign_up_operation, graphql_name: nil) }
-    let(:mapping_name)     { 'user' }
+    let(:mapping_name)     { :user }
     let(:operations)       { { login: login_operation, logout: logout_operation, invalid: double(:invalid) } }
     let(:selected_keys)    { [:login, :logout, :sign_up, :confirm] }
 
diff --git a/spec/services/mount_method/operation_preparers/default_operation_preparer_spec.rb b/spec/services/mount_method/operation_preparers/default_operation_preparer_spec.rb
@@ -9,7 +9,7 @@
     let(:sign_up_operation) { double(:sign_up_operation, graphql_name: nil) }
     let(:login_operation)   { double(:confirm_operation, graphql_name: nil) }
     let(:logout_operation)  { double(:sign_up_operation, graphql_name: nil) }
-    let(:mapping_name)      { 'user' }
+    let(:mapping_name)      { :user }
     let(:preparer)          { double(:preparer) }
     let(:operations)        { { login: login_operation, logout: logout_operation, sign_up: sign_up_operation, confirm: confirm_operation } }
     let(:custom_keys)       { [:login, :logout] }
diff --git a/spec/services/mount_method/operation_preparers/resource_name_setter_spec.rb b/spec/services/mount_method/operation_preparers/resource_name_setter_spec.rb
@@ -5,7 +5,7 @@
     subject(:prepared_operation) { described_class.new(mapping_name).call(operation) }
 
     let(:operation)    { double(:operation) }
-    let(:mapping_name) { 'user' }
+    let(:mapping_name) { :user }
 
     it 'sets a gql name to the operation' do
       expect(prepared_operation.instance_variable_get(:@resource_name)).to eq(:user)
diff --git a/spec/services/resource_loader_spec.rb b/spec/services/resource_loader_spec.rb
@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+RSpec.describe GraphqlDevise::ResourceLoader do
+  describe '#call' do
+    subject(:loader) { described_class.new(resource, options, routing).call(query, mutation) }
+
+    let(:query)    { class_double(GraphQL::Schema::Object) }
+    let(:mutation) { class_double(GraphQL::Schema::Object) }
+    let(:routing)  { false }
+    let(:resource) { 'User' }
+    let(:options)  { { only: [:login, :confirm_account] } }
+
+    before { allow(GraphqlDevise).to receive(:add_mapping).with(:user, resource) }
+
+    it 'loads operations into the provided types' do
+      expect(query).to             receive(:field).with(:user_confirm_account, resolver: instance_of(Class))
+      expect(mutation).to          receive(:field).with(:user_login, mutation: instance_of(Class))
+      expect(GraphqlDevise).to     receive(:add_mapping).with(:user, resource)
+      expect(GraphqlDevise).not_to receive(:mount_resource)
+
+      returned = loader
+
+      expect(returned).to be_a(Struct)
+    end
+
+    context 'when mutation is nil' do
+      let(:mutation) { nil }
+
+      it 'raises an error' do
+        expect { loader }.to raise_error(
+          GraphqlDevise::Error,
+          'You need to provide a mutation type unless all mutations are skipped'
+        )
+      end
+    end
+
+    context 'when invoked from router' do
+      let(:routing) { true }
+
+      before do
+        allow(query).to    receive(:field)
+        allow(mutation).to receive(:field)
+      end
+
+      it 'adds mappings' do
+        expect(GraphqlDevise).to receive(:add_mapping).with(:user, resource)
+        expect(GraphqlDevise).to receive(:mount_resource).with(:user)
+
+        loader
+      end
+
+      context 'when resource was already mounted' do
+        before { allow(GraphqlDevise).to receive(:resource_mounted?).with(:user).and_return(true) }
+
+        it 'skips schema loading' do
+          expect(query).not_to         receive(:field).with(:user_confirm_account, resolver: instance_of(Class))
+          expect(mutation).not_to      receive(:field).with(:user_login, mutation: instance_of(Class))
+          expect(GraphqlDevise).not_to receive(:add_mapping).with(:user, resource)
+          expect(GraphqlDevise).not_to receive(:mount_resource)
+        end
+      end
+    end
+  end
+end
diff --git a/spec/services/schema_plugin_spec.rb b/spec/services/schema_plugin_spec.rb
@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+RSpec.describe GraphqlDevise::SchemaPlugin do
+  describe '#call' do
+    subject(:plugin) { described_class.new(query: query, mutation: mutation, resource_loaders: loaders) }
+
+    let(:query)    { instance_double(GraphQL::Schema::Object) }
+    let(:mutation) { instance_double(GraphQL::Schema::Object) }
+
+    context 'when loaders are not provided' do
+      let(:loaders) { [] }
+
+      it 'does not fail' do
+        expect { plugin }.not_to raise_error
+      end
+    end
+
+    context 'when a loaders is not an instance of loader' do
+      let(:loaders) { ['not a loader instance'] }
+
+      it 'raises an error' do
+        expect { plugin }.to raise_error(GraphqlDevise::Error, 'Invalid resource loader instance')
+      end
+    end
+  end
+end
