Implement ActiveRecord test polygon; Reproduce bug with association cache

Author: ssnickolay

Gemfile.lock

@@ -7,20 +7,34 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activerecord (6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
     appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
     codeclimate-test-reporter (1.0.9)
       simplecov (<= 0.13)
     coderay (1.1.2)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
     docile (1.1.5)
     graphql (1.9.3)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
     json (2.2.0)
     method_source (0.9.2)
     mini_cache (1.1.0)
-    promise.rb (0.7.4)
+    minitest (5.13.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -46,16 +60,20 @@ GEM
     simplecov-html (0.10.2)
     sqlite3 (1.4.0)
     thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord
   appraisal
   codeclimate-test-reporter
   graphql-cache!
   mini_cache
-  promise.rb
   pry
   rake (~> 10.0)
   rspec (~> 3.0)

graphql-cache.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake',    '~> 10.0'
   s.add_development_dependency 'rspec',   '~> 3.0'
   s.add_development_dependency 'sequel'
+  s.add_development_dependency 'activerecord'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'sqlite3'
 

spec/features/connections_spec.rb

@@ -1,9 +1,5 @@
 require 'spec_helper'
 
-def execute(query, context = {})
-  CacheSchema.execute(query, context: context)
-end
-
 RSpec.describe 'caching connection fields' do
   class StubLogger < Logger
     def initialize
@@ -19,7 +15,7 @@ def messages
   let(:query) do
     %Q{
       {
-        customer(id: #{Customer.last.id}) {
+        customer(id: #{customer.id}) {
           orders {
             edges {
               node {
@@ -35,31 +31,71 @@ def messages
   let(:sql_logger) do
     StubLogger.new.tap do |logger|
       logger.formatter = proc do |_severity, _datetime, _progname, msg|
-        raw_sql = msg.match(/\(.*\)\s(?<sql>.*)/)["sql"]
+        raw_sql = msg.match(/.*(?<sql>SELECT .*)/)["sql"]
 
         "#{raw_sql}\n"
       end
     end
   end
 
-  before { DB.logger = sql_logger }
+  shared_examples "be a correct cold and warm" do
+    let(:reference) do
+      {"data" => {"customer" => {"orders" => {"edges" => [{"node" => {"id" =>1 }}, {"node" => {"id" => 2}}, {"node" => {"id" => 3}}]}}}}
+    end
+
+    it 'produces the same result on miss or hit' do
+      cold_results = execute(query)
+      warm_results = execute(query)
+
+      expect(cold_results).to eq(reference)
+      expect(cold_results).to eq warm_results
+    end
+  end
+
+  describe 'Seqeul' do
+    def execute(query, context = {})
+      CacheSchema.execute(query, context: context)
+    end
+    let(:customer) { Customer.last }
+
+    before { DB.logger = sql_logger }
+
+    it_behaves_like "be a correct cold and warm"
 
-  it 'produces the same result on miss or hit' do
-    cold_results = execute(query)
-    warm_results = execute(query)
+    it 'calls sql engine only one time per cached field' do
+      5.times { execute(query) }
 
-    expect(cold_results).to eq warm_results
+      expect(sql_logger.messages).to eq(
+        <<~SQL
+          SELECT * FROM `customers` ORDER BY `id` DESC LIMIT 1
+          SELECT * FROM `customers` WHERE `id` = '1'
+          SELECT * FROM `orders` WHERE (`orders`.`customer_id` = 1)
+        SQL
+      )
+    end
   end
 
-  it 'calls sql engine only one time per cached field' do
-    5.times { execute(query) }
+  describe 'ActiveRecord' do
+    def execute(query, context = {})
+      AR::CacheSchema.execute(query, context: context)
+    end
+
+    let(:customer) { AR::Customer.last }
 
-    expect(sql_logger.messages).to eq(
-      <<~SQL
-        SELECT * FROM `customers` ORDER BY `id` DESC LIMIT 1
-        SELECT * FROM `customers` WHERE `id` = '1'
-        SELECT * FROM `orders` WHERE (`orders`.`customer_id` = 1)
-      SQL
-    )
+    before { ActiveRecord::Base.logger = sql_logger }
+
+    it_behaves_like "be a correct cold and warm"
+
+    it 'calls sql engine only one time per cached field' do
+      5.times { execute(query) }
+
+      expect(sql_logger.messages).to eq(
+        <<~SQL
+          SELECT "customers".* FROM "customers" ORDER BY "customers"."id" DESC LIMIT ?  [["LIMIT", 1]]
+          SELECT "customers".* FROM "customers" WHERE "customers"."id" = ? LIMIT ?  [["id", 1], ["LIMIT", 1]]
+          SELECT "orders".* FROM "orders" WHERE "orders"."customer_id" = ?  [["customer_id", 1]]
+        SQL
+      )
+    end
   end
 end

spec/spec_helper.rb

@@ -1,3 +1,4 @@
+require 'active_record' # should be before graphql-ruby
 require 'bundler/setup'
 require 'pry'
 
@@ -36,6 +37,7 @@
   # required after GraphQL::Cache initialization because dev
   # schema uses cache and logger objects from it.
   require_relative '../test_schema'
+  require_relative '../test_schema/active_record/init'
 
   config.include TestMacros
   config.extend  TestMacros::ClassMethods

spec/support/test_cache.rb

@@ -2,11 +2,12 @@
 
 class TestCache
   def write(key, doc, opts={})
-    cache[key] = doc
+    # we duplicate the value to get rid of ruby object level caching
+    cache[key] = ::Marshal.load(::Marshal.dump(doc))
   end
 
   def read(key)
-    cache[key]
+    ::Marshal.load(::Marshal.dump(cache[key]))
   end
 
   def cache

test_schema/active_record/factories.rb

@@ -0,0 +1,18 @@
+module AR
+  class Factories
+    def self.bootstrap
+      customer = AR::Customer.create(
+        display_name: 'Michael',
+        email: 'michael@example.com'
+      )
+
+      AR::Order.create(customer_id: customer.id, number: new_num, total_price_cents: 1399)
+      AR::Order.create(customer_id: customer.id, number: new_num, total_price_cents: 1399)
+      AR::Order.create(customer_id: customer.id, number: new_num, total_price_cents: 1399)
+    end
+
+    def self.new_num
+      AR::Order.count + 1000
+    end
+  end
+end

test_schema/active_record/graphql_schema.rb

@@ -0,0 +1,23 @@
+require 'benchmark'
+
+module AR
+  class BaseType < ::BaseType; end
+  class OrderType < ::OrderType; end
+
+  class CustomerType < ::CustomerType; end
+
+  class QueryType < ::QueryType
+    def customer(id:)
+      AR::Customer.find(id)
+    end
+  end
+
+  class CacheSchema < ::CacheSchema
+    query AR::QueryType
+    use GraphQL::Cache
+
+    def self.resolve_type(_type, obj, _ctx)
+      "AR::#{obj.class.name}Type"
+    end
+  end
+end

test_schema/active_record/init.rb

@@ -0,0 +1,9 @@
+require 'logger'
+
+require_relative './schema'
+require_relative './models'
+require_relative './graphql_schema'
+require_relative './factories'
+
+ActiveRecord::Base.logger = GraphQL::Cache.logger
+AR::Factories.bootstrap

test_schema/active_record/models.rb

@@ -0,0 +1,9 @@
+module AR
+  class Order < ActiveRecord::Base
+    belongs_to :customer
+  end
+
+  class Customer < ActiveRecord::Base
+    has_many :orders
+  end
+end

test_schema/active_record/schema.rb

@@ -0,0 +1,20 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :schema_migrations, force: true
+
+  create_table :customers, force: true do |t|
+    t.string :display_name
+    t.string :email
+  end
+
+  create_table :orders, force: true do |t|
+    t.integer :customer_id
+    t.integer :number
+    t.integer :total_price_cents
+  end
+end

test_schema/factories.rb

@@ -1,4 +1,4 @@
-module Factories
+class Factories
   def self.bootstrap
     customer = Customer.create(
       display_name: 'Michael',