hq-graphql 2.0.7 → 2.1.1

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "hq/graphql/enum"
+
+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,10 @@
+# frozen_string_literal: true
+
+require "hq/graphql/enum"
+
+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,23 @@
-# 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
+        @klass_or_string = klass
+      end
+
+      def scope(&block)
+        if block
+          @scope = block
+        else
+          @scope
+        end
       end
 
       def authorized?(object, ctx)
@@ -19,14 +26,8 @@ module HQ
           ::HQ::GraphQL.authorize_field(authorize_action, self, object, ctx)
       end
 
-      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
-        else
-          super
-        end
+      def klass
+        @klass ||= @klass_or_string.is_a?(String) ? @klass_or_string.constantize : @klass_or_string
       end
     end
   end

data/lib/hq/graphql/field_extension/association_loader_extension.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "hq/graphql/association_loader"
+
+module HQ
+  module GraphQL
+    module FieldExtension
+      class AssociationLoaderExtension < ::GraphQL::Schema::FieldExtension
+        def resolve(object:, **_kwargs)
+          AssociationLoader.for(options[:klass], field.original_name).load(object.object)
+        end
+      end
+    end
+  end
+end

data/lib/hq/graphql/field_extension/paginated_arguments.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "hq/graphql/enum/sort_by"
+require "hq/graphql/enum/sort_order"
+
+module HQ
+  module GraphQL
+    module FieldExtension
+      class PaginatedArguments < ::GraphQL::Schema::FieldExtension
+        def apply
+          field.argument :offset, Integer, required: false
+          field.argument :limit, Integer, required: false
+          field.argument :sort_order, Enum::SortOrder, required: false
+
+          resource = ::HQ::GraphQL.lookup_resource(options[:klass])
+          enum = resource ? resource.sort_fields_enum : ::HQ::GraphQL::Enum::SortBy
+          field.argument :sort_by, enum, required: false
+        end
+      end
+    end
+  end
+end

data/lib/hq/graphql/field_extension/paginated_loader.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "hq/graphql/paginated_association_loader"
+
+module HQ
+  module GraphQL
+    module FieldExtension
+      class PaginatedLoader < ::GraphQL::Schema::FieldExtension
+        def resolve(object:, arguments:, **_options)
+          limit       = arguments[:limit]
+          offset      = arguments[:offset]
+          sort_by     = arguments[:sort_by]
+          sort_order  = arguments[:sort_order]
+          scope       = field.scope.call(**arguments.except(:limit, :offset, :sort_by, :sort_order)) if field.scope
+          loader      = PaginatedAssociationLoader.for(
+            klass,
+            association,
+            internal_association: internal_association,
+            scope:                scope,
+            limit:                limit,
+            offset:               offset,
+            sort_by:              sort_by,
+            sort_order:           sort_order
+          )
+
+          loader.load(object.object)
+        end
+
+        private
+
+        def association
+          options[:association]
+        end
+
+        def internal_association
+          options[:internal_association]
+        end
+
+        def klass
+          options[:klass]
+        end
+      end
+    end
+  end
+end

data/lib/hq/graphql/input_object.rb

@@ -1,10 +1,12 @@
-# typed: true
 # frozen_string_literal: true
 
+require "hq/graphql/active_record_extensions"
+require "hq/graphql/inputs"
+require "hq/graphql/types"
+
 module HQ
   module GraphQL
     class InputObject < ::GraphQL::Schema::InputObject
-      extend T::Sig
       include Scalars
       include ::HQ::GraphQL::ActiveRecordExtensions
 
@@ -30,11 +32,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 +64,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,13 +1,21 @@
-# typed: true
 # frozen_string_literal: true
 
+require "hq/graphql/active_record_extensions"
+require "hq/graphql/field"
+require "hq/graphql/field_extension/association_loader_extension"
+require "hq/graphql/field_extension/paginated_arguments"
+require "hq/graphql/field_extension/paginated_loader"
+require "hq/graphql/object_association"
+require "hq/graphql/types"
+
 module HQ
   module GraphQL
     class Object < ::GraphQL::Schema::Object
       include Scalars
-      include ::HQ::GraphQL::ActiveRecordExtensions
+      include ActiveRecordExtensions
+      extend ObjectAssociation
 
-      field_class ::HQ::GraphQL::Field
+      field_class Field
 
       def self.authorize_action(action)
         self.authorized_action = action
@@ -17,10 +25,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|
@@ -28,8 +37,15 @@ module HQ
           end
 
           model_associations.each do |association|
+            next if resource_reflections[association.name.to_s]
             field_from_association(association, auto_nil: auto_nil)
           end
+
+          resource_reflections.values.each do |resource_reflection|
+            reflection = resource_reflection.reflection(model_klass)
+            next unless reflection
+            field_from_association(reflection, auto_nil: auto_nil, internal_association: true, &resource_reflection.block)
+          end
         end
       end
 
@@ -46,21 +62,36 @@ module HQ
           @authorized_action ||= :read
         end
 
-        def field_from_association(association, auto_nil:)
-          type = ::HQ::GraphQL::Types[association.klass]
-          name = association.name
+        def field_from_association(association, auto_nil:, internal_association: false, &block)
+          # The PaginationAssociationLoader doesn't support through associations yet
+          return if association.through_reflection? && ::HQ::GraphQL.use_experimental_associations?
+
+          association_klass = association.klass
+          name              = association.name
+          klass             = model_klass
+          type              = Types[association_klass]
           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?
+                extension FieldExtension::PaginatedArguments, klass: association_klass
+                extension FieldExtension::PaginatedLoader, klass: klass, association: name, internal_association: internal_association
+              else
+                extension FieldExtension::AssociationLoaderExtension, klass: klass
+              end
+              instance_eval(&block) if block
+            end
           else
-            field name, type, null: !auto_nil || !association_required?(association), klass: model_name
+            field name, type, null: !auto_nil || !association_required?(association), klass: model_name do
+              extension FieldExtension::AssociationLoaderExtension, klass: klass
+            end
           end
-        rescue ::HQ::GraphQL::Types::Error
+        rescue Types::Error
           nil
         end
 
         def field_from_column(column, auto_nil:)
-          field column.name, ::HQ::GraphQL::Types.type_from_column(column), null: !auto_nil || column.null
+          field column.name, Types.type_from_column(column), null: !auto_nil || column.null
         end
 
         def association_required?(association)

data/lib/hq/graphql/object_association.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module HQ
+  module GraphQL
+    module ObjectAssociation
+      class ResourceReflection
+        attr_reader :name, :scope, :options, :macro, :block
+
+        def initialize(name, scope, options, macro, block)
+          @name = name
+          @scope = scope
+          @options = options
+          @macro = macro
+          @block = block
+        end
+
+        def reflection(model_klass)
+          if macro == :has_many
+            ::ActiveRecord::Associations::Builder::HasMany.create_reflection(model_klass, name, scope, options)
+          elsif macro == :belongs_to
+            ::ActiveRecord::Associations::Builder::BelongsTo.create_reflection(model_klass, name, scope, options)
+          end
+        end
+      end
+
+      def reflect_on_association(association)
+        resource_reflections[association.to_s]&.reflection(model_klass)
+      end
+
+      def belongs_to(name, scope = nil, **options, &block)
+        add_reflection(name, scope, options, :belongs_to, block)
+      end
+
+      def has_many(name, scope = nil, through: nil, **options, &block)
+        raise TypeError, "has_many through is unsupported" if through
+        add_reflection(name, scope, options, :has_many, block)
+      end
+
+      private
+
+      def resource_reflections
+        @resource_reflections ||= {}
+      end
+
+      def add_reflection(name, scope, options, macro, block)
+        resource_reflections[name.to_s] = ResourceReflection.new(name, scope, options, macro, block)
+      end
+    end
+  end
+end

data/lib/hq/graphql/paginated_association_loader.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require "hq/graphql/types"
+
+module HQ
+  module GraphQL
+    class PaginatedAssociationLoader < ::GraphQL::Batch::Loader
+      def self.for(*args, scope: nil, **kwargs)
+        if scope
+          raise TypeError, "scope must be an ActiveRecord::Relation" unless scope.is_a?(::ActiveRecord::Relation)
+          executor = ::GraphQL::Batch::Executor.current
+          loader_key = loader_key_for(*args, **kwargs, scope: scope.to_sql)
+          executor.loader(loader_key) { new(*args, **kwargs, scope: scope) }
+        else
+          super
+        end
+      end
+
+      def initialize(model, association_name, internal_association: false, limit: nil, offset: nil, scope: nil, sort_by: nil, sort_order: nil)
+        @model                = model
+        @association_name     = association_name
+        @internal_association = internal_association
+        @limit                = [0, limit].max if limit
+        @offset               = [0, offset].max if offset
+        @scope                = scope
+        @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 = scope.merge(@scope) if @scope
+        scope
+      end
+
+      def belongs_to?
+        association.macro == :belongs_to
+      end
+
+      def has_many?
+        association.macro == :has_many
+      end
+
+      def association
+        if @internal_association
+          Types[@model].reflect_on_association(@association_name)
+        else
+          @model.reflect_on_association(@association_name)
+        end
+      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