cacheql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: edd0f07beea907b403ceae1832e967d3f1a01aee
+  data.tar.gz: b3cae9fa387ee21cd4ea3349e843bc2eea1a314f
+SHA512:
+  metadata.gz: ef17ab966525e39a38e8c4968d99e44541d4e6fd0cea8735f6abf5279b40b7129af6a74c7be510654f1f7c6316684046c81f416a40965c6a95125b02e7a6670b
+  data.tar.gz: 3065ca7f8150a353a7895c528494dcee87283a2c3687f4903930e45c10c42d820437b4d6edaa9a0ef3ee86c78f28e34b61316ee64c878bb693e908856e764992

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0.pre.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cacheql.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    cacheql (0.1.0)
+      graphql-batch (~> 0.3.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    erubi (1.7.1)
+    graphql (1.7.14)
+    graphql-batch (0.3.9)
+      graphql (>= 0.8, < 2)
+      promise.rb (~> 0.7.2)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    promise.rb (0.7.4)
+    rack (2.0.4)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.0)
+      actionpack (= 5.2.0)
+      activesupport (= 5.2.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.0)
+  activesupport (~> 5.0)
+  bundler (~> 1.16.a)
+  cacheql!
+  minitest (~> 5.0)
+  railties (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.0.pre.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Chatterbug, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# CacheQL
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cacheql`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cacheql'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cacheql
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chatterbugapp/cacheql.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cacheql"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cacheql.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cacheql/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cacheql"
+  spec.version       = CacheQL::VERSION
+  spec.authors       = ["Nick Quaranto"]
+  spec.email         = ["nick@quaran.to"]
+
+  spec.summary       = %q{Various GraphQL caching / instrumentation tools}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/chatterbug/cacheql"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "graphql-batch", "~> 0.3.9"
+
+  spec.add_development_dependency "activesupport", "~> 5.0"
+  spec.add_development_dependency "activerecord", "~> 5.0"
+  spec.add_development_dependency "railties", "~> 5.0"
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/cacheql.rb

@@ -0,0 +1,38 @@
+require "digest"
+
+require "graphql"
+require "graphql/batch"
+
+require "cacheql/version"
+require "cacheql/resolve_wrapper"
+require_relative "./cacheql/railtie" if defined? Rails::Railtie
+
+# Wrap a resolve function to store its value in Rails.cache
+# This requires `cache_key` as an instance method on the object (usually on ActiveRecord's or scopes),
+module CacheQL
+  # Query-level caching, for any cacheable_fields
+  def self.fetch(cacheable_fields, query, variables, &block)
+    document = GraphQL.parse(query)
+    cacheables = document.definitions.map { |definition| definition.selections.map(&:name) }.flatten & cacheable_fields
+
+    if cacheables.present?
+      cache_key = [
+        CacheQL::Railtie.config.global_key,
+        'result',
+        Digest::SHA256.hexdigest(document.to_query_string + variables.to_s)
+      ]
+      CacheQL::Railtie.config.cache.fetch(cache_key, expires_in: CacheQL::Railtie.config.expires_range.sample.minutes) do
+        block.call(document)
+      end
+    else
+      block.call(document)
+    end
+  end
+end
+
+# Always a hack, but looks nice
+# Wrap a resolve func with:
+# resolve CacheQL -> { |obj, args, ctx| obj.do_stuff }
+def CacheQL(resolver_func)
+  CacheQL::ResolveWrapper.new(resolver_func)
+end

data/lib/cacheql/association_loader.rb

@@ -0,0 +1,51 @@
+# https://github.com/Shopify/graphql-batch/blob/master/examples/association_loader.rb
+module CacheQL
+  class AssociationLoader < GraphQL::Batch::Loader
+    def self.validate(model, association_name)
+      new(model, association_name)
+      nil
+    end
+
+    def initialize(model, association_name)
+      @model = model
+      @association_name = association_name
+      validate
+    end
+
+    def load(record)
+      raise TypeError, "#{@model} loader can't load association for #{record.class}" unless record.is_a?(@model)
+      return Promise.resolve(read_association(record)) if association_loaded?(record)
+      super
+    end
+
+    # We want to load the associations on all records, even if they have the same id
+    def cache_key(record)
+      record.object_id
+    end
+
+    def perform(records)
+      preload_association(records)
+      records.each { |record| fulfill(record, read_association(record)) }
+    end
+
+    private
+
+    def validate
+      unless @model.reflect_on_association(@association_name)
+        raise ArgumentError, "No association #{@association_name} on #{@model}"
+      end
+    end
+
+    def preload_association(records)
+      ::ActiveRecord::Associations::Preloader.new.preload(records, @association_name)
+    end
+
+    def read_association(record)
+      record.public_send(@association_name)
+    end
+
+    def association_loaded?(record)
+      record.association(@association_name).loaded?
+    end
+  end
+end

data/lib/cacheql/field_instrumentation.rb

@@ -0,0 +1,61 @@
+# https://github.com/rmosolgo/graphql-ruby/blob/master/lib/graphql/tracing/scout_tracing.rb
+# https://github.com/rmosolgo/graphql-ruby/blob/master/guides/fields/instrumentation.md
+# http://help.apm.scoutapp.com/#ruby-custom-instrumentation
+module CacheQL
+  class FieldInstrumentation
+    NAME = "graphql.field".freeze
+
+    # For use in an around_action call to log all fields. For example:
+    #
+    # around_action :log_field_instrumentation
+    #
+    # def log_field_instrumentation(&block)
+    #   CacheQL::FieldInstrumentation.log(&block)
+    # end
+    def self.log(&block)
+      field_instruments = Hash.new(0)
+      ActiveSupport::Notifications.subscribe(NAME) do |*args|
+        event = ActiveSupport::Notifications::Event.new(*args)
+        field_instruments[event.payload[:label]] += event.duration
+      end
+
+      block.call
+
+      ActiveSupport::Notifications.unsubscribe(NAME)
+      field_instruments.sort_by(&:last).reverse.each do |field, ms|
+        CacheQL::Railtie.config.logger.info "[CacheQL::Tracing] #{field} took #{ms.round(3)}ms"
+      end
+    end
+
+    # instrumenter must respond to #instrument
+    # See ScoutApm::Tracer for example
+    def initialize(instrumenter)
+      @instrumenter = instrumenter
+    end
+
+    # Track timing for all fields
+    def instrument(type, field)
+      # Ignore internal GraphQL types
+      if type.name.starts_with?("__")
+        field
+      else
+        label = "#{type.name}.#{field.name}"
+        old_resolve_proc = field.resolve_proc
+
+        new_resolve_proc = -> (obj, args, ctx) {
+          ActiveSupport::Notifications.instrument(NAME, label: label) do
+            @instrumenter.instrument("GraphQL", label) do
+              resolved = old_resolve_proc.call(obj, args, ctx)
+              resolved
+            end
+          end
+        }
+
+        # Return a copy of `field`, with a new resolve proc
+        field.redefine do
+          resolve(new_resolve_proc)
+        end
+      end
+    end
+  end
+end

data/lib/cacheql/polymorphic_key_loader.rb

@@ -0,0 +1,22 @@
+# Based on https://github.com/rmosolgo/graphql-batch-example/blob/master/good_schema/polymorphic_key_loader.rb
+module CacheQL
+  class PolymorphicKeyLoader < GraphQL::Batch::Loader
+    def initialize(model, polymorphic_key)
+      @model = model
+      @polymorphic_key = polymorphic_key
+    end
+
+    def perform(polymorphic_value_sets)
+      polymorphic_values = polymorphic_value_sets.flatten.uniq
+      records = @model.where(@polymorphic_key => polymorphic_values).to_a
+
+      polymorphic_value_sets.each do |polymorphic_value_set|
+        matching_records = records.select do |record|
+          polymorphic_value_set.id == record.public_send("#{@polymorphic_key}_id") &&
+          polymorphic_value_set.class.name == record.public_send("#{@polymorphic_key}_type")
+        end
+        fulfill(polymorphic_value_set, matching_records)
+      end
+    end
+  end
+end

data/lib/cacheql/railtie.rb

@@ -0,0 +1,25 @@
+module CacheQL
+  class Railtie < Rails::Railtie
+    # Bump to bust all GraphQL caches!
+    config.global_key = "CacheQL/v1"
+
+    # Expire caches within this minute range
+    config.expires_range = (90..120).to_a.freeze
+
+    initializer "cacheql.initialize" do
+      # Bring over some rails default
+      config.cache = Rails.cache
+      config.logger = Rails.logger
+
+      require "cacheql/field_instrumentation"
+      require "cacheql/polymorphic_key_loader"
+      require "cacheql/record_loader"
+    end
+
+    initializer "cacheql.initialize_ar" do
+      ActiveSupport.on_load(:active_record) do
+        require "cacheql/association_loader"
+      end
+    end
+  end
+end

data/lib/cacheql/record_loader.rb

@@ -0,0 +1,29 @@
+# Via https://github.com/Shopify/graphql-batch/blob/master/examples/record_loader.rb
+# And https://github.com/rmosolgo/graphql-batch-example/blob/master/good_schema/find_loader.rb
+module CacheQL
+  class RecordLoader < GraphQL::Batch::Loader
+    def initialize(model, column: model.primary_key, where: nil)
+      @model = model
+      @column = column.to_s
+      @column_type = model.type_for_attribute(@column)
+      @where = where
+    end
+
+    def load(key)
+      super(@column_type.cast(key))
+    end
+
+    def perform(keys)
+      query(keys).each { |record| fulfill(record.public_send(@column), record) }
+      keys.each { |key| fulfill(key, nil) unless fulfilled?(key) }
+    end
+
+    private
+
+    def query(keys)
+      scope = @model
+      scope = scope.where(@where) if @where
+      scope.where(@column => keys)
+    end
+  end
+end

data/lib/cacheql/resolve_wrapper.rb

@@ -0,0 +1,20 @@
+module CacheQL
+  class ResolveWrapper
+    def initialize(resolver_func)
+      @resolver_func = resolver_func
+    end
+
+    def __getobj__
+      @resolver_func
+    end
+
+    # Resolve function level caching!
+    def call(obj, args, ctx)
+      cache_key = [CacheQL::Railtie.config.global_key, obj.cache_key, ctx.field.name]
+      CacheQL::Railtie.config.cache.fetch(cache_key,
+        expires_in: CacheQL::Railtie.config.expires_range.sample.minutes) do
+        @resolver_func.call(obj, args, ctx)
+      end
+    end
+  end
+end

data/lib/cacheql/version.rb

@@ -0,0 +1,3 @@
+module CacheQL
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: cacheql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Quaranto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql-batch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.9
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Various GraphQL caching / instrumentation tools
+email:
+- nick@quaran.to
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cacheql.gemspec
+- lib/cacheql.rb
+- lib/cacheql/association_loader.rb
+- lib/cacheql/field_instrumentation.rb
+- lib/cacheql/polymorphic_key_loader.rb
+- lib/cacheql/railtie.rb
+- lib/cacheql/record_loader.rb
+- lib/cacheql/resolve_wrapper.rb
+- lib/cacheql/version.rb
+homepage: https://github.com/chatterbug/cacheql
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Various GraphQL caching / instrumentation tools
+test_files: []