Deprecate authenticating resources inside the GQL schema

Author: mcelicalderon

app/controllers/graphql_devise/concerns/set_user_by_token.rb

@@ -42,14 +42,25 @@ def set_resource_by_token(resource)
         set_user_by_token(resource)
       end
 
-      def graphql_context(resource_name)
-        context = {
-          resource_name: resource_name,
-          controller:    self
-        }
-        context[:current_resource] = @resource if @resource.present?
+      def graphql_context(resource_name = nil)
+        if !resource_name.nil?
+          ActiveSupport::Deprecation.warn(<<-DEPRECATION.strip_heredoc, caller)
+            Providing an argument to `graphql_context` is deprecated and will be removed in a future version
+            of this gem.
+            Use `set_resource_by_model` in your controller and the pass `graphql_context` as part of the GQL context.
 
-        context
+            EXAMPLE
+            include GraphqlDevise::Concerns::SetUserByToken
+
+            set_resource_by_model User
+            DummySchema.execute(params[:query], context: graphql_context)
+          DEPRECATION
+        end
+
+        { controller: self }.merge(
+          current_resource: @resource.presence,
+          resource_name:    resource_name.presence
+        )
       end
 
       def build_redirect_headers(access_token, client, redirect_header_options = {})

lib/graphql_devise.rb

@@ -33,7 +33,7 @@ def self.add_mapping(mapping_name, resource)
 
     Devise.add_mapping(
       mapping_name.to_s.pluralize.to_sym,
-      module: :devise, class_name: resource
+      module: :devise, class_name: resource.to_s
     )
   end
 

lib/graphql_devise/resource_loader.rb

@@ -13,7 +13,21 @@ def call(query, mutation)
       # clean_options responds to all keys defined in GraphqlDevise::MountMethod::SUPPORTED_OPTIONS
       clean_options = GraphqlDevise::MountMethod::OptionSanitizer.new(@options).call!
 
-      model = @resource.is_a?(String) ? @resource.constantize : @resource
+      model = if @resource.is_a?(String)
+        ActiveSupport::Deprecation.warn(<<-DEPRECATION.strip_heredoc, caller)
+          Providing a String as the model you want to mount is deprecated and will be removed in a future version of
+          this gem. Please use the actual model constant instead.
+
+          EXAMPLE
+
+          GraphqlDevise::ResourceLoader.new(User) # instead of GraphqlDevise::ResourceLoader.new('User')
+
+          mount_graphql_devise_for User # instead of mount_graphql_devise_for 'User'
+        DEPRECATION
+        @resource.constantize
+      else
+        @resource
+      end
 
       return clean_options if GraphqlDevise.resource_mounted?(model) && @routing
 

lib/graphql_devise/schema_plugin.rb

@@ -30,6 +30,22 @@ def trace(event, trace_data)
       auth_required = authenticate_option(field, trace_data)
       context       = context_from_data(trace_data)
 
+      if context.key?(:resource_name)
+        ActiveSupport::Deprecation.warn(<<-DEPRECATION.strip_heredoc, caller)
+          Providing `resource_name` as part of the GQL context, or doing so by using the `graphql_context(resource_name)`
+          method on your controller is deprecated and will be removed in a future version of this gem.
+          Please use `set_resource_by_model` in you controller and send `graphql_context` without arguments
+          to the GQL context instead.
+
+          EXAMPLE
+          include GraphqlDevise::Concerns::SetUserByToken
+
+          set_resource_by_model User
+
+          DummySchema.execute(params[:query], context: graphql_context)
+        DEPRECATION
+      end
+
       if auth_required && !(public_introspection && introspection_field?(field))
         context = set_current_resource(context)
         raise_on_missing_resource(context, field)