graphiti 1.3.9 → 1.7.5

data/lib/graphiti/resource_proxy.rb

@@ -2,20 +2,31 @@ module Graphiti
   class ResourceProxy
     include Enumerable
 
-    attr_reader :resource, :query, :scope, :payload
+    attr_reader :resource, :query, :scope, :payload, :cache_expires_in, :cache
 
     def initialize(resource, scope, query,
       payload: nil,
       single: false,
-      raise_on_missing: false)
+      raise_on_missing: false,
+      cache: nil,
+      cache_expires_in: nil)
+
       @resource = resource
       @scope = scope
       @query = query
       @payload = payload
       @single = single
       @raise_on_missing = raise_on_missing
+      @cache = cache
+      @cache_expires_in = cache_expires_in
+    end
+
+    def cache?
+      !!@cache
     end
 
+    alias_method :cached?, :cache?
+
     def single?
       !!@single
     end
@@ -74,6 +85,7 @@ module Graphiti
       end
     end
     alias_method :to_a, :data
+    alias_method :resolve_data, :data
 
     def meta
       @meta ||= data.respond_to?(:meta) ? data.meta : {}
@@ -136,7 +148,7 @@ module Graphiti
     end
 
     def destroy
-      data
+      resolve_data
       transaction_response = @resource.transaction do
         metadata = {method: :destroy}
         model = @resource.destroy(@query.filters[:id], metadata)
@@ -153,11 +165,13 @@ module Graphiti
       success
     end
 
-    def update_attributes
-      data
+    def update
+      resolve_data
       save(action: :update)
     end
 
+    alias update_attributes update # standard:disable Style/Alias
+
     def include_hash
       @include_hash ||= begin
         base = @payload ? @payload.include_hash : {}
@@ -177,6 +191,22 @@ module Graphiti
       query.debug_requested?
     end
 
+    def updated_at
+      @scope.updated_at
+    end
+
+    def etag
+      "W/#{ActiveSupport::Digest.hexdigest(cache_key_with_version.to_s)}"
+    end
+
+    def cache_key
+      ActiveSupport::Cache.expand_cache_key([@scope.cache_key, @query.cache_key])
+    end
+
+    def cache_key_with_version
+      ActiveSupport::Cache.expand_cache_key([@scope.cache_key_with_version, @query.cache_key])
+    end
+
     private
 
     def persist

data/lib/graphiti/runner.rb

@@ -71,7 +71,9 @@ module Graphiti
         query,
         payload: deserialized_payload,
         single: opts[:single],
-        raise_on_missing: opts[:raise_on_missing]
+        raise_on_missing: opts[:raise_on_missing],
+        cache: opts[:cache],
+        cache_expires_in: opts[:cache_expires_in]
     end
   end
 end

data/lib/graphiti/schema.rb

@@ -42,7 +42,7 @@ module Graphiti
 
     def generate_types
       {}.tap do |types|
-        Graphiti::Types.map.each_pair do |name, config|
+        Graphiti::Types.map.sort.each_entry do |name, config|
           types[name] = config.slice(:kind, :description)
         end
       end

data/lib/graphiti/scope.rb

@@ -43,6 +43,7 @@ module Graphiti
         parent_resource = @resource
         graphiti_context = Graphiti.context
         resolve_sideload = -> {
+          Graphiti.config.before_sideload&.call(graphiti_context)
           Graphiti.context = graphiti_context
           sideload.resolve(results, q, parent_resource)
           @resource.adapter.close if concurrent
@@ -66,14 +67,72 @@ module Graphiti
       end
     end
 
+    def parent_resource
+      @resource
+    end
+
+    def cache_key
+      # This is the combined cache key for the base query and the query for all sideloads
+      # Changing the query will yield a different cache key
+
+      cache_keys = sideload_resource_proxies.map { |proxy| proxy.try(:cache_key) }
+
+      cache_keys << @object.try(:cache_key) # this is what calls into the ORM (ActiveRecord, most likely)
+      ActiveSupport::Cache.expand_cache_key(cache_keys.flatten.compact)
+    end
+
+    def cache_key_with_version
+      # This is the combined and versioned cache key for the base query and the query for all sideloads
+      # If any returned model's updated_at changes, this key will change
+
+      cache_keys = sideload_resource_proxies.map { |proxy| proxy.try(:cache_key_with_version) }
+
+      cache_keys << @object.try(:cache_key_with_version) # this is what calls into ORM (ActiveRecord, most likely)
+      ActiveSupport::Cache.expand_cache_key(cache_keys.flatten.compact)
+    end
+
+    def updated_at
+      updated_time = nil
+      begin
+        updated_ats = sideload_resource_proxies.map(&:updated_at)
+        updated_ats << @object.maximum(:updated_at)
+        updated_time = updated_ats.compact.max
+      rescue => e
+        Graphiti.log(["error calculating last_modified_at for #{@resource.class}", :red])
+        Graphiti.log(e)
+      end
+
+      updated_time || Time.now
+    end
+    alias_method :last_modified_at, :updated_at
+
     private
 
+    def sideload_resource_proxies
+      @sideload_resource_proxies ||= begin
+        @object = @resource.before_resolve(@object, @query)
+        results = @resource.resolve(@object)
+
+        [].tap do |proxies|
+          unless @query.sideloads.empty?
+            @query.sideloads.each_pair do |name, q|
+              sideload = @resource.class.sideload(name)
+              next if sideload.nil? || sideload.shared_remote?
+
+              proxies << sideload.build_resource_proxy(results, q, parent_resource)
+            end
+          end
+        end.flatten
+      end
+    end
+
     def broadcast_data
       opts = {
         resource: @resource,
-        params: @opts[:params],
+        params: @opts[:params] || @query.params,
         sideload: @opts[:sideload],
-        parent: @opts[:parent]
+        parent: @opts[:parent],
+        action: @query.action
         # Set once data is resolved within block
         #   results: ...
       }

data/lib/graphiti/scoping/filter.rb

@@ -193,14 +193,14 @@ module Graphiti
       # Find the quoted strings
       quotes = value.scan(/{{.*?}}/)
       # remove them from the rest
-      quotes.each { |q| value.gsub!(q, "") }
+      non_quotes = quotes.inject(value) { |v, q| v.gsub(q, "") }
       # remove the quote characters from the quoted strings
       quotes.each { |q| q.gsub!("{{", "").gsub!("}}", "") }
       # merge everything back together into an array
       value = if singular_filter
-        Array(value) + quotes
+        Array(non_quotes) + quotes
       else
-        Array(value.split(",")) + quotes
+        Array(non_quotes.split(",")) + quotes
       end
       # remove any blanks that are left
       value.reject! { |v| v.length.zero? }

data/lib/graphiti/serializer.rb

@@ -71,9 +71,9 @@ module Graphiti
     end
 
     # Allow access to resource methods
-    def method_missing(id, *args, &blk)
+    def method_missing(id, ...)
       if @resource.respond_to?(id, true)
-        @resource.send(id, *args, &blk)
+        @resource.send(id, ...)
       else
         super
       end
@@ -99,7 +99,7 @@ module Graphiti
 
     def strip_relationships?
       return false unless Graphiti.config.links_on_demand
-      params = Graphiti.context[:object].params || {}
+      params = Graphiti.context[:object]&.params || {}
       [false, nil, "false"].include?(params[:links])
     end
   end

data/lib/graphiti/sideload/polymorphic_belongs_to.rb

@@ -41,7 +41,7 @@ class Graphiti::Sideload::PolymorphicBelongsTo < Graphiti::Sideload::BelongsTo
     end
 
     def on(name, &blk)
-      group = Group.new(name)
+      group = Group.new(name.to_sym)
       @groups << group
       group
     end

data/lib/graphiti/sideload.rb

@@ -209,13 +209,16 @@ module Graphiti
       end
     end
 
-    def load(parents, query, graph_parent)
-      params, opts, proxy = nil, nil, nil
+    def build_resource_proxy(parents, query, graph_parent)
+      params = nil
+      opts = nil
+      proxy = nil
 
       with_error_handling Errors::SideloadParamsError do
         params = load_params(parents, query)
         params_proc&.call(params, parents, context)
         return [] if blank_query?(params)
+
         opts = load_options(parents, query)
         opts[:sideload] = self
         opts[:parent] = graph_parent
@@ -228,7 +231,11 @@ module Graphiti
         pre_load_proc&.call(proxy, parents)
       end
 
-      proxy.to_a
+      proxy
+    end
+
+    def load(parents, query, graph_parent)
+      build_resource_proxy(parents, query, graph_parent).to_a
     end
 
     # Override in subclass

data/lib/graphiti/util/cache_debug.rb

@@ -0,0 +1,88 @@
+module Graphiti
+  module Util
+    class CacheDebug
+      attr_reader :proxy
+
+      def initialize(proxy)
+        @proxy = proxy
+      end
+
+      def last_version
+        @last_version ||= Graphiti.cache.read(key) || {}
+      end
+
+      def name
+        "#{Graphiti.context[:object]&.request&.method} #{Graphiti.context[:object]&.request&.url}"
+      end
+
+      def key
+        "graphiti:debug/#{name}"
+      end
+
+      def current_version
+        @current_version ||= {
+          cache_key: proxy.cache_key_with_version,
+          version: proxy.updated_at,
+          expires_in: proxy.cache_expires_in,
+          etag: proxy.etag,
+          miss_count: last_version[:miss_count].to_i + (changed_key? ? 1 : 0),
+          hit_count: last_version[:hit_count].to_i + (!changed_key? && !new_key? ? 1 : 0),
+          request_count: last_version[:request_count].to_i + (last_version.present? ? 1 : 0)
+        }
+      end
+
+      def analyze
+        yield self
+        save
+      end
+
+      def request_count
+        current_version[:request_count]
+      end
+
+      def miss_count
+        current_version[:miss_count]
+      end
+
+      def hit_count
+        current_version[:hit_count]
+      end
+
+      def change_percentage
+        return 0 if request_count == 0
+        (miss_count.to_i / request_count.to_f * 100).round(1)
+      end
+
+      def volatile?
+        change_percentage > 50
+      end
+
+      def new_key?
+        last_version[:cache_key].blank? && proxy.cache_key_with_version
+      end
+
+      def changed_key?
+        last_version[:cache_key] != proxy.cache_key_with_version && !new_key?
+      end
+
+      def removed_segments
+        changes[1] - changes[0]
+      end
+
+      def added_segments
+        changes[0] - changes[1]
+      end
+
+      def changes
+        sub_keys_old = last_version[:cache_key]&.scan(/\w+\/query-[a-z0-9-]+\/args-[a-z0-9-]+/).to_a || []
+        sub_keys_new = current_version[:cache_key]&.scan(/\w+\/query-[a-z0-9-]+\/args-[a-z0-9-]+/).to_a || []
+
+        [sub_keys_old, sub_keys_new]
+      end
+
+      def save
+        Graphiti.cache.write(key, current_version)
+      end
+    end
+  end
+end

data/lib/graphiti/util/link.rb

@@ -48,6 +48,7 @@ module Graphiti
 
       def on_demand_links(url)
         return url unless Graphiti.config.links_on_demand
+        return unless url
 
         url << if url.include?("?")
           "&links=true"

data/lib/graphiti/util/serializer_relationships.rb

@@ -118,7 +118,7 @@ module Graphiti
         cache_key = :"#{@sideload.object_id}-#{action}"
         return if self.class.validated_link_cache.include?(cache_key)
         prc = Graphiti.config.context_for_endpoint
-        unless prc.call(sideload.resource.endpoint[:full_path], action)
+        unless prc.call(sideload.resource.endpoint[:full_path].to_s, action)
           raise Errors::InvalidLink.new(@resource_class, sideload, action)
         end
         self.class.validated_link_cache << cache_key

data/lib/graphiti/version.rb

@@ -1,3 +1,3 @@
 module Graphiti
-  VERSION = "1.3.9"
+  VERSION = "1.7.5"
 end

data/lib/graphiti.rb

@@ -1,12 +1,17 @@
 require "json"
 require "forwardable"
+require "uri"
+require "ostruct" unless defined?(::OpenStruct)
+
+require "active_support/version"
+require "active_support/deprecation"
+require "active_support/deprecator" if ::ActiveSupport.version >= Gem::Version.new("7.1")
 require "active_support/core_ext/string"
 require "active_support/core_ext/enumerable"
 require "active_support/core_ext/class/attribute"
 require "active_support/core_ext/hash/conversions" # to_xml
 require "active_support/concern"
 require "active_support/time"
-require "active_support/deprecation"
 
 require "dry-types"
 require "graphiti_errors"
@@ -83,7 +88,12 @@ module Graphiti
   end
 
   def self.log(msg, color = :white, bold = false)
-    colored = ActiveSupport::LogSubscriber.new.send(:color, msg, color, bold)
+    colored = if ::ActiveSupport.version >= Gem::Version.new("7.1")
+      ActiveSupport::LogSubscriber.new.send(:color, msg, color, bold: bold)
+    else
+      ActiveSupport::LogSubscriber.new.send(:color, msg, color, bold)
+    end
+
     logger.debug(colored)
   end
 
@@ -100,6 +110,14 @@ module Graphiti
       r.apply_sideloads_to_serializer
     end
   end
+
+  def self.cache=(val)
+    @cache = val
+  end
+
+  def self.cache
+    @cache
+  end
 end
 
 require "graphiti/version"
@@ -131,7 +149,6 @@ require "graphiti/resource_proxy"
 require "graphiti/request_validator"
 require "graphiti/request_validators/validator"
 require "graphiti/request_validators/update_validator"
-require "graphiti/query"
 require "graphiti/scope"
 require "graphiti/deserializer"
 require "graphiti/renderer"
@@ -170,7 +187,9 @@ require "graphiti/extensions/extra_attribute"
 require "graphiti/extensions/boolean_attribute"
 require "graphiti/extensions/temp_id"
 require "graphiti/serializer"
+require "graphiti/query"
 require "graphiti/debugger"
+require "graphiti/util/cache_debug"
 
 if defined?(ActiveRecord)
   require "graphiti/adapters/active_record"

data/package.json

@@ -0,0 +1,111 @@
+{
+  "name": "graphiti",
+  "version": "1.4.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/graphiti-api/graphiti.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/graphiti-api/graphiti/issues"
+  },
+  "homepage": "https://graphiti.dev",
+  "scripts": {
+    "semantic-release": "semantic-release"
+  },
+  "devDependencies": {
+    "semantic-release-rubygem": "^1.2.0",
+    "semantic-release": "^19.0.3",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/git": "^10.0.1" 
+  },
+  "release": {
+    "branches": [
+      "master",
+      {
+        "name": "beta",
+        "prerelease": true
+      },
+      {
+        "name": "alpha",
+        "prerelease": true
+      }
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "releaseRules": [
+            {
+              "type": "*!",
+              "release": "major"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "build",
+              "release": "patch"
+            },
+            {
+              "type": "ci",
+              "release": "patch"
+            },
+            {
+              "type": "chore",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "refactor",
+              "release": "patch"
+            },
+            {
+              "type": "style",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            }
+          ],
+          "parserOpts": {
+            "noteKeywords": [
+              "BREAKING CHANGE",
+              "BREAKING CHANGES",
+              "BREAKING",
+              "BREAKING CHANGE!",
+              "BREAKING CHANGES!",
+              "BREAKING!"
+            ]
+          }
+        }
+      ],
+      "@semantic-release/release-notes-generator",
+      [
+        "@semantic-release/changelog",
+        {
+          "changelogTitle": "graphiti changelog",
+          "changelogFile": "CHANGELOG.md"
+        }
+      ],
+      "semantic-release-rubygem",
+      "@semantic-release/github",
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "CHANGELOG.md"
+          ],
+          "message": "${nextRelease.version} CHANGELOG [skip ci]\n\n${nextRelease.notes}"
+        }
+      ]
+    ],
+    "debug": true,
+    "dryRun": false
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphiti
 version: !ruby/object:Gem::Version
-  version: 1.3.9
+  version: 1.7.5
 platform: ruby
 authors:
 - Lee Richmond
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2024-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializable
@@ -204,7 +204,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.0.beta.4
-description:
+description: 
 email:
 - richmolj@gmail.com
 executables:
@@ -212,7 +212,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/probots.yml"
 - ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".standard.yml"
@@ -251,6 +253,8 @@ files:
 - gemfiles/rails_6.gemfile
 - gemfiles/rails_6_graphiti_rails.gemfile
 - gemfiles/rails_7.gemfile
+- gemfiles/rails_7_1.gemfile
+- gemfiles/rails_7_1_graphiti_rails.gemfile
 - gemfiles/rails_7_graphiti_rails.gemfile
 - graphiti.gemspec
 - lib/graphiti.rb
@@ -320,6 +324,7 @@ files:
 - lib/graphiti/stats/payload.rb
 - lib/graphiti/types.rb
 - lib/graphiti/util/attribute_check.rb
+- lib/graphiti/util/cache_debug.rb
 - lib/graphiti/util/class.rb
 - lib/graphiti/util/field_params.rb
 - lib/graphiti/util/hash.rb
@@ -336,11 +341,12 @@ files:
 - lib/graphiti/util/transaction_hooks_recorder.rb
 - lib/graphiti/util/validation_response.rb
 - lib/graphiti/version.rb
+- package.json
 homepage: https://github.com/graphiti-api/graphiti
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -348,15 +354,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.3.27
+signing_key: 
 specification_version: 4
 summary: Easily build jsonapi.org-compatible APIs
 test_files: []