hq-graphql 2.0.6 → 2.1.0

data/lib/hq/graphql/enum/sort_by.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module HQ
+  class GraphQL::Enum::SortBy < ::HQ::GraphQL::Enum
+    value "CreatedAt", value: :created_at
+    value "UpdatedAt", value: :updated_at
+  end
+end

data/lib/hq/graphql/enum/sort_order.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module HQ
+  class GraphQL::Enum::SortOrder < ::HQ::GraphQL::Enum
+    value "ASC", value: :asc
+    value "DESC", value: :desc
+  end
+end

data/lib/hq/graphql/field.rb

@@ -1,16 +1,15 @@
-# typed: false
 # frozen_string_literal: true
 
 module HQ
   module GraphQL
     class Field < ::GraphQL::Schema::Field
-      attr_reader :authorize_action, :authorize, :klass
+      attr_reader :authorize_action, :authorize
 
       def initialize(*args, authorize_action: :read, authorize: nil, klass: nil, **options, &block)
         super(*args, **options, &block)
         @authorize_action = authorize_action
         @authorize = authorize
-        @klass = klass
+        @class_name = klass
       end
 
       def authorized?(object, ctx)
@@ -21,13 +20,34 @@ module HQ
 
       def resolve_field(object, args, ctx)
         if klass.present? && !!::GraphQL::Batch::Executor.current && object.object
-          Loaders::Association.for(klass.constantize, original_name).load(object.object).then do
-            super
-          end
+          loader =
+            if ::HQ::GraphQL.use_experimental_associations?
+              limit       = args[:limit]
+              offset      = args[:offset]
+              sort_by     = args[:sortBy]
+              sort_order  = args[:sortOrder]
+
+              PaginatedAssociationLoader.for(
+                klass,
+                original_name,
+                limit: limit,
+                offset: offset,
+                sort_by: sort_by,
+                sort_order: sort_order
+              )
+            else
+              AssociationLoader.for(klass, original_name)
+            end
+
+          loader.load(object.object)
         else
           super
         end
       end
+
+      def klass
+        @klass ||= @class_name&.constantize
+      end
     end
   end
 end

data/lib/hq/graphql/input_object.rb

@@ -1,10 +1,8 @@
-# typed: true
 # frozen_string_literal: true
 
 module HQ
   module GraphQL
     class InputObject < ::GraphQL::Schema::InputObject
-      extend T::Sig
       include Scalars
       include ::HQ::GraphQL::ActiveRecordExtensions
 
@@ -30,11 +28,11 @@ module HQ
       end
 
       #### Class Methods ####
-      sig { params(model_name: String, attributes: T::Boolean, associations: T::Boolean).void }
-      def self.with_model(model_name, attributes: true, associations: false)
+      def self.with_model(model_name, attributes: true, associations: false, enums: true)
         self.model_name = model_name
         self.auto_load_attributes = attributes
         self.auto_load_associations = associations
+        self.auto_load_enums = enums
 
         lazy_load do
           model_columns.each do |column|
@@ -62,16 +60,19 @@ module HQ
         private
 
         def argument_from_association(association)
-          input = ::HQ::GraphQL::Inputs[association.klass]
+          is_enum = is_enum?(association)
+          input_or_type = is_enum ? ::HQ::GraphQL::Types[association.klass] : ::HQ::GraphQL::Inputs[association.klass]
           name = association.name
 
           case association.macro
           when :has_many
-            argument name, [input], required: false
+            argument name, [input_or_type], required: false
           else
-            argument name, input, required: false
+            argument name, input_or_type, required: false
           end
 
+          return if is_enum
+
           if !model_klass.nested_attributes_options.key?(name.to_sym)
             model_klass.accepts_nested_attributes_for name, allow_destroy: true
           end

data/lib/hq/graphql/inputs.rb

@@ -1,4 +1,3 @@
-# typed: true
 # frozen_string_literal: true
 
 module HQ
@@ -25,8 +24,10 @@ module HQ
 
         def klass_for(klass_or_string)
           klass = klass_or_string.is_a?(String) ? klass_or_string.constantize : klass_or_string
-          ::HQ::GraphQL.types.detect { |t| t.model_klass == klass }&.input_klass ||
-             raise(Error, Error::MISSING_TYPE_MSG % { klass: klass.name })
+          resource = ::HQ::GraphQL.lookup_resource(klass)
+
+          raise(Error, Error::MISSING_TYPE_MSG % { klass: klass.name }) if !resource
+          resource.input_klass
         end
       end
     end

data/lib/hq/graphql/mutation.rb

@@ -1,4 +1,3 @@
-# typed: true
 # frozen_string_literal: true
 
 module HQ

data/lib/hq/graphql/object.rb

@@ -1,4 +1,3 @@
-# typed: true
 # frozen_string_literal: true
 
 module HQ
@@ -17,10 +16,11 @@ module HQ
         super && ::HQ::GraphQL.authorized?(authorized_action, object, context)
       end
 
-      def self.with_model(model_name, attributes: true, associations: true, auto_nil: true)
+      def self.with_model(model_name, attributes: true, associations: true, auto_nil: true, enums: true)
         self.model_name = model_name
         self.auto_load_attributes = attributes
         self.auto_load_associations = associations
+        self.auto_load_enums = enums
 
         lazy_load do
           model_columns.each do |column|
@@ -47,11 +47,22 @@ module HQ
         end
 
         def field_from_association(association, auto_nil:)
-          type = ::HQ::GraphQL::Types[association.klass]
+          # The PaginationAssociationLoader doesn't support through associations yet
+          return if association.through_reflection? && ::HQ::GraphQL.use_experimental_associations?
+
+          association_klass = association.klass
+          type = ::HQ::GraphQL::Types[association_klass]
           name = association.name
           case association.macro
           when :has_many
-            field name, [type], null: false, klass: model_name
+            field name, [type], null: false, klass: model_name do
+              if ::HQ::GraphQL.use_experimental_associations? && (resource = ::HQ::GraphQL.lookup_resource(association_klass))
+                argument :offset, Integer, required: false
+                argument :limit, Integer, required: false
+                argument :sort_by, resource.sort_fields_enum, required: false
+                argument :sort_order, Enum::SortOrder, required: false
+              end
+            end
           else
             field name, type, null: !auto_nil || !association_required?(association), klass: model_name
           end

data/lib/hq/graphql/paginated_association_loader.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module HQ
+  module GraphQL
+    class PaginatedAssociationLoader < ::GraphQL::Batch::Loader
+      def initialize(model, association_name, limit: nil, offset: nil, sort_by: nil, sort_order: nil)
+        @model            = model
+        @association_name = association_name
+        @limit            = [0, limit].max if limit
+        @offset           = [0, offset].max if offset
+        @sort_by          = sort_by || :updated_at
+        @sort_order       = normalize_sort_order(sort_order)
+
+        validate!
+      end
+
+      def load(record)
+        raise TypeError, "#{@model} loader can't load association for #{record.class}" unless record.is_a?(@model)
+        super
+      end
+
+      def cache_key(record)
+        record.send(primary_key)
+      end
+
+      def perform(records)
+        scope =
+          if @limit || @offset
+            # If a limit or offset is added, then we need to transform the query
+            # into a lateral join so that we can limit on groups of data.
+            #
+            # > SELECT * FROM addresses WHERE addresses.user_id IN ($1, $2, ..., $N) ORDER BY addresses.created_at DESC;
+            # ...becomes
+            # > SELECT DISTINCT a_top.*
+            # > FROM addresses
+            # > INNER JOIN LATERAL (
+            # >   SELECT inner.*
+            # >   FROM addresses inner
+            # >   WHERE inner.user_id = addresses.user_id
+            # >   ORDER BY inner.created_at DESC
+            # >   LIMIT 1
+            # > ) a_top ON TRUE
+            # > WHERE addresses.user_id IN ($1, $2, ..., $N)
+            # > ORDER BY a_top.created_at DESC
+            inner_table       = association_class.arel_table
+            association_table = inner_table.alias("outer")
+
+            inside_scope = default_scope.
+              select(inner_table[::Arel.star]).
+              from(inner_table).
+              where(inner_table[association_key].eq(association_table[association_key])).
+              reorder(arel_order(inner_table)).
+              limit(@limit).
+              offset(@offset)
+
+            outside_table = ::Arel::Table.new("top")
+            association_class.
+              select(outside_table[::Arel.star]).distinct.
+              from(association_table).
+              joins("INNER JOIN LATERAL (#{inside_scope.to_sql}) #{outside_table.name} ON TRUE").
+              where(association_table[association_key].in(records.map { |r| join_value(r) })).
+              reorder(arel_order(outside_table))
+          else
+            default_scope.
+              reorder(arel_order(association_class.arel_table)).
+              where(association_key => records.map { |r| join_value(r) })
+          end
+
+        results = scope.to_a
+        records.each do |record|
+          fulfill(record, association_value(record, results)) unless fulfilled?(record)
+        end
+      end
+
+      private
+
+      def association_key
+        belongs_to? ? association.association_primary_key : association.foreign_key
+      end
+
+      def association_value(record, results)
+        enumerator = has_many? ? :select : :detect
+        results.send(enumerator) { |r| r.send(association_key) == join_value(record) }
+      end
+
+      def join_key
+        belongs_to? ? association.foreign_key : association.association_primary_key
+      end
+
+      def join_value(record)
+        record.send(join_key)
+      end
+
+      def default_scope
+        scope = association_class
+        scope = association.scopes.reduce(scope, &:merge)
+        scope = association_class.default_scopes.reduce(scope, &:merge)
+        scope
+      end
+
+      def belongs_to?
+        association.macro == :belongs_to
+      end
+
+      def has_many?
+        association.macro == :has_many
+      end
+
+      def association
+        @model.reflect_on_association(@association_name)
+      end
+
+      def association_class
+        association.klass
+      end
+
+      def primary_key
+        @model.primary_key
+      end
+
+      def arel_order(table)
+        table[@sort_by].send(@sort_order)
+      end
+
+      def normalize_sort_order(input)
+        if input.to_s.casecmp("asc").zero?
+          :asc
+        else
+          :desc
+        end
+      end
+
+      def validate!
+        raise ArgumentError, "No association #{@association_name} on #{@model}" unless association
+      end
+    end
+  end
+end

data/lib/hq/graphql/resource.rb

@@ -1,23 +1,41 @@
-# typed: false
 # frozen_string_literal: true
 
-require "hq/graphql/resource/mutation"
+require "hq/graphql/resource/auto_mutation"
 
 module HQ
   module GraphQL
     module Resource
-      extend T::Helpers
-
       def self.included(base)
         super
-        ::HQ::GraphQL.types << base
+        ::HQ::GraphQL.resources << base
         base.include Scalars
         base.include ::GraphQL::Types
+        base.extend ClassMethods
       end
 
       module ClassMethods
+        include AutoMutation
+
         attr_writer :graphql_name, :model_name
 
+        def sort_fields(*fields)
+          self.sort_fields_enum = fields
+        end
+
+        def sort_fields_enum
+          @sort_fields_enum || ::HQ::GraphQL::Enum::SortBy
+        end
+
+        def sort_fields_enum=(fields)
+          @sort_fields_enum ||= Class.new(::HQ::GraphQL::Enum::SortBy).tap do |c|
+            c.graphql_name "#{graphql_name}Sort"
+          end
+
+          Array(fields).each do |field|
+            @sort_fields_enum.value field.to_s.classify, value: field
+          end
+        end
+
         def scope(context)
           scope = model_klass
           scope = ::HQ::GraphQL.default_scope(scope, context)
@@ -39,7 +57,7 @@ module HQ
         end
 
         def model_name
-          @model_name || name.demodulize
+          @model_name || ::HQ::GraphQL.extract_class(self)
         end
 
         def model_klass
@@ -73,144 +91,10 @@ module HQ
         end
 
         def mutations(create: true, copy: true, update: true, destroy: true)
-          scoped_graphql_name = graphql_name
-          scoped_model_name = model_name
-          scoped_self = self
-
-          if create
-            create_mutation = ::HQ::GraphQL::Resource::Mutation.build(model_name, action: :create, graphql_name: "#{scoped_graphql_name}Create") do
-              define_method(:resolve) do |**args|
-                resource = scoped_self.new_record(context)
-                resource.assign_attributes(args[:attributes].format_nested_attributes)
-                if resource.save
-                  {
-                    resource: resource,
-                    errors: {},
-                  }
-                else
-                  {
-                    resource: nil,
-                    errors: errors_from_resource(resource)
-                  }
-                end
-              end
-
-              lazy_load do
-                argument :attributes, ::HQ::GraphQL::Inputs[scoped_model_name], required: true
-              end
-            end
-
-            mutation_klasses["create_#{scoped_graphql_name.underscore}"] = create_mutation
-          end
-
-          if copy
-            copy_mutation = ::HQ::GraphQL::Resource::Mutation.build(
-              model_name,
-              action: :copy,
-              graphql_name: "#{scoped_graphql_name}Copy",
-              require_primary_key: true,
-              nil_klass: true
-            ) do
-              define_method(:resolve) do |**args|
-                resource = scoped_self.find_record(args, context)
-
-                if resource
-                  copy = resource.copy
-                  if copy.save
-                    {
-                      resource: copy,
-                      errors: {},
-                    }
-                  else
-                    {
-                      resource: copy,
-                      errors: errors_from_resource(copy)
-                    }
-                  end
-                else
-                  {
-                    resource: nil,
-                    errors: { resource: "Unable to find #{scoped_graphql_name}" }
-                  }
-                end
-              end
-            end
-
-            mutation_klasses["copy_#{scoped_graphql_name.underscore}"] = copy_mutation
-          end
-
-          if update
-            update_mutation = ::HQ::GraphQL::Resource::Mutation.build(
-              model_name,
-              action: :update,
-              graphql_name: "#{scoped_graphql_name}Update",
-              require_primary_key: true
-            ) do
-              define_method(:resolve) do |**args|
-                resource = scoped_self.find_record(args, context)
-
-                if resource
-                  resource.assign_attributes(args[:attributes].format_nested_attributes)
-                  if resource.save
-                    {
-                      resource: resource,
-                      errors: {},
-                    }
-                  else
-                    {
-                      resource: nil,
-                      errors: errors_from_resource(resource)
-                    }
-                  end
-                else
-                  {
-                    resource: nil,
-                    errors: { resource: "Unable to find #{scoped_graphql_name}" }
-                  }
-                end
-              end
-
-              lazy_load do
-                argument :attributes, ::HQ::GraphQL::Inputs[scoped_model_name], required: true
-              end
-            end
-
-            mutation_klasses["update_#{scoped_graphql_name.underscore}"] = update_mutation
-          end
-
-          if destroy
-            destroy_mutation = ::HQ::GraphQL::Resource::Mutation.build(
-              model_name,
-              action: :destroy,
-              graphql_name: "#{scoped_graphql_name}Destroy",
-              require_primary_key: true
-            ) do
-              define_method(:resolve) do |**attrs|
-                resource = scoped_self.find_record(attrs, context)
-
-                if resource
-                  if resource.destroy
-                    {
-                      resource: resource,
-                      errors: {},
-                    }
-                  else
-                    {
-                      resource: nil,
-                      errors: errors_from_resource(resource)
-                    }
-                  end
-                else
-                  {
-                    resource: nil,
-                    errors: { resource: "Unable to find #{scoped_graphql_name}" }
-                  }
-                end
-              end
-            end
-
-            mutation_klasses["destroy_#{scoped_graphql_name.underscore}"] = destroy_mutation
-          end
+          mutation_klasses["create_#{graphql_name.underscore}"] = build_create if create
+          mutation_klasses["copy_#{graphql_name.underscore}"] = build_copy if copy
+          mutation_klasses["update_#{graphql_name.underscore}"] = build_update if update
+          mutation_klasses["destroy_#{graphql_name.underscore}"] = build_destroy if destroy
         end
 
         def query(**options, &block)
@@ -218,10 +102,10 @@ module HQ
         end
 
         def def_root(field_name, is_array: false, null: true, &block)
-          graphql = self
+          resource = self
           resolver = -> {
             Class.new(::GraphQL::Schema::Resolver) do
-              type = is_array ? [graphql.query_klass] : graphql.query_klass
+              type = is_array ? [resource.query_klass] : resource.query_klass
               type type, null: null
               class_eval(&block) if block
             end
@@ -231,7 +115,7 @@ module HQ
           }
         end
 
-        def root_query(find_one: true, find_all: true, pagination: false, per_page_max: 250)
+        def root_query(find_one: true, find_all: true, pagination: true, limit_max: 250)
           field_name = graphql_name.underscore
           scoped_self = self
 
@@ -250,18 +134,27 @@ module HQ
 
           if find_all
             def_root field_name.pluralize, is_array: true, null: false do
-              argument :page, Integer, required: false
-              argument :per_page, Integer, required: false
+              if pagination
+                argument :offset, Integer, required: false
+                argument :limit, Integer, required: false
+              end
+              argument :sort_by, scoped_self.sort_fields_enum, required: false
+              argument :sort_order, Enum::SortOrder, required: false
 
-              define_method(:resolve) do |page: nil, per_page: nil, **_attrs|
+              define_method(:resolve) do |limit: nil, offset: nil, sort_by: nil, sort_order: nil, **_attrs|
                 scope = scoped_self.scope(context).all
 
-                if pagination || page || per_page
-                  page ||= 0
-                  limit = [per_page_max, *per_page].min
-                  scope = scope.limit(limit).offset(page * limit)
+                if pagination || page || limit
+                  offset = [0, *offset].max
+                  limit = [[limit_max, *limit].min, 0].max
+                  scope = scope.limit(limit).offset(offset)
                 end
 
+                sort_by ||= :updated_at
+                sort_order ||= :desc
+                # There should be no risk for SQL injection since an enum is being used for both sort_by and sort_order
+                scope = scope.reorder(sort_by => sort_order)
+
                 scope
               end
             end
@@ -294,8 +187,6 @@ module HQ
           end
         end
       end
-
-      mixes_in_class_methods(ClassMethods)
     end
   end
 end