graphql-persisted_queries 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c766b357d35d1bda4dfba34a5a633260a0dfe3593189f1d60b35d5973b5c18a4
+  data.tar.gz: 6182e3cdb5ce2ed6194b7ee4eef87ad2c3194299904bd1ecaf29fc5179c1358e
+SHA512:
+  metadata.gz: 6ee805aae51f2ecf5c055eb5c3d02b20873369a990498f0b2e75348ab62cf8192945b9716d87c616772e2c07b000fd8b73a238e45124cd7e849e3d3041e41cf6
+  data.tar.gz: 49b7cbe475f09c7f4ec6e4b11a1dbcb3d86a03fcd6d63ef4acf977e59aff6c6e223e858d24f96f6895d8ccee9495f0ffbd623a28e48eec89ccd895fa284cd4d0

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  Include:
+    - 'lib/**/*.rb'
+    - 'spec/**/*.rb'
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/**/*'
+    - 'gemfiles/**/*.gemfile'
+    - 'gemfiles/vendor/**/*'
+    - 'Rakefile'
+    - 'Gemfile'
+    - '*.gemspec'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/NumericLiterals:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+cache: bundler
+
+sudo: false
+
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - ruby-head
+
+gemfile:
+  - gemfiles/graphql_1_8.gemfile
+  - gemfiles/graphql_1_9.gemfile
+  - gemfiles/graphql_master.gemfile
+
+
+notifications:
+  email: false
+
+matrix:
+  fast_finish: true

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change log
+
+## master
+
+## 0.1.0 (2019-10-21)
+
+- Initial version ([@DmitryTsepelev][])
+
+[@DmitryTsepelev]: https://github.com/DmitryTsepelev

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in graphql-persisted_queries.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 DmitryTsepelev
+
+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,100 @@
+# GraphQL::PersistedQueries [![Build Status](https://travis-ci.org/DmitryTsepelev/graphql-ruby-persisted_queries.svg?branch=master)](https://travis-ci.org/DmitryTsepelev/graphql-ruby-persisted_queries)
+
+
+`GraphQL::PersistedQueries` is the implementation of [persisted queries](https://github.com/apollographql/apollo-link-persisted-queries) for [graphql-ruby](https://github.com/rmosolgo/graphql-ruby). With this plugin your backend will cache all the queries, while frontend will send the full query only when it's not found at the backend storage.
+
+- 🗑**Heavy query parameter will be omitted in most of cases** – network requests will become less heavy
+- 🤝**Clients share cached queries** – it's enough to miss cache only once for each unique query
+- 🎅**Works for clients without persisted query support**
+
+
+<p align="center">
+  <a href="https://evilmartians.com/?utm_source=graphql-ruby-persisted_queries">
+    <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+  </a>
+</p>
+
+## Installation
+
+1. Add the gem to your Gemfile `gem 'graphql-persisted_queries'`
+
+2. Install and configure [apollo-link-persisted-queries](https://github.com/apollographql/apollo-link-persisted-queries):
+
+```js
+import { createPersistedQueryLink } from "apollo-link-persisted-queries";
+import { createHttpLink } from "apollo-link-http";
+import { InMemoryCache } from "apollo-cache-inmemory";
+import ApolloClient from "apollo-client";
+
+
+// use this with Apollo Client
+const link = createPersistedQueryLink().concat(createHttpLink({ uri: "/graphql" }));
+const client = new ApolloClient({
+  cache: new InMemoryCache(),
+  link: link,
+});
+```
+
+3. Add plugin to the schema:
+
+```ruby
+class GraphqlSchema < GraphQL::Schema
+  use GraphQL::PersistedQueries
+end
+```
+
+4. Pass `:extensions` argument to all calls of `GraphqlSchema#execute` (start with `GraphqlController` and `GraphqlChannel`)
+
+```ruby
+GraphqlSchema.execute(
+  params[:query],
+  variables: ensure_hash(params[:variables]),
+  context: {},
+  operation_name: params[:operationName],
+  extensions: ensure_hash(params[:extensions])
+)
+```
+
+5. Run the app! 🔥
+
+## Alternative stores
+
+All the queries are stored in memory by default, but you can easily switch to _redis_:
+
+```ruby
+class GraphqlSchema < GraphQL::Schema
+  use GraphQL::PersistedQueries, store: :redis, redis_url: ENV["MY_REDIS_URL"]
+end
+```
+
+If you have `ENV["REDIS_URL"]` configured – you don't need to pass it explicitly. Also, you can pass `:redis_host`, `:redis_port` and `:redis_db_name` to build the URL from scratch or configure Redis client as you want and pass it as the `:client` option.
+
+## Alternative hash functions
+
+[apollo-link-persisted-queries](https://github.com/apollographql/apollo-link-persisted-queries) uses _SHA256_ by default so this gem uses it as a default too, but if you want to override it – you can use `:hash_generator` option:
+
+```ruby
+class GraphqlSchema < GraphQL::Schema
+  use GraphQL::PersistedQueries, hash_generator: :md5
+end
+```
+
+If string or symbol is passed – the gem would try to find the class in the `Digest` namespace. Altenatively, you  can pass a lambda, e.g.:
+
+```ruby
+class GraphqlSchema < GraphQL::Schema
+  use GraphQL::PersistedQueries, hash_generator: proc { |_value| "super_safe_hash!!!" }
+end
+```
+
+## GET requests and HTTP cache
+
+Using `GET` requests for persisted queries allows you to enable HTTP caching (e.g., turn on CDN). In order to make it work you should change the way link is initialized on front-end side (`createPersistedQueryLink({ useGETForHashedQueries: true })`) and register a new route `get "/graphql", to: "graphql#execute"`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DmitryTsepelev/graphql-persisted_queries.
+
+## 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,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql/persisted_queries"
+
+# 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/gemfiles/graphql_1_8.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "graphql", "~> 1.8"
+
+gemspec path: "../"

data/gemfiles/graphql_1_9.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "graphql", "~> 1.9"
+
+gemspec path: "../"

data/gemfiles/graphql_master.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "graphql", github: "rmosolgo/graphql-ruby"
+
+gemspec path: ".."

data/graphql-persisted_queries.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "graphql/persisted_queries/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-persisted_queries"
+  spec.version       = GraphQL::PersistedQueries::VERSION
+  spec.authors       = ["DmitryTsepelev"]
+  spec.email         = ["dmitry.a.tsepelev@gmail.com"]
+
+  spec.summary       = "Persisted queries for graphql-ruby"
+  spec.description   = "Persisted queries for graphql-ruby"
+  spec.homepage      = "https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.required_ruby_version = ">= 2.3"
+
+  spec.add_dependency "graphql", ">= 1.8"
+
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rubocop", "0.75"
+  spec.add_development_dependency "redis"
+end

data/lib/graphql/persisted_queries.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "graphql/persisted_queries/schema_patch"
+require "graphql/persisted_queries/store_adapters"
+require "graphql/persisted_queries/version"
+
+module GraphQL
+  # Plugin definition
+  module PersistedQueries
+    def self.use(schema_defn, store: :memory, hash_generator: :sha256, **options)
+      schema_defn.target.singleton_class.prepend(SchemaPatch)
+      schema_defn.target.hash_generator = hash_generator
+      schema_defn.target.configure_persisted_query_store(store, options)
+    end
+  end
+end

data/lib/graphql/persisted_queries/hash_generator_builder.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module GraphQL
+  module PersistedQueries
+    # Builds hash generator
+    class HashGeneratorBuilder
+      def initialize(generator)
+        @generator = generator
+      end
+
+      def build
+        if @generator.is_a?(Proc)
+          build_from_proc
+        else
+          build_from_name
+        end
+      end
+
+      private
+
+      def build_from_proc
+        if @generator.arity != 1
+          raise ArgumentError, "proc passed to :hash_generator should have exactly one argument"
+        end
+
+        @generator
+      end
+
+      def build_from_name
+        upcased_name = @generator.to_s.upcase
+        digest_class = Digest.const_get(upcased_name)
+        proc { |value| digest_class.hexdigest(value) }
+      rescue LoadError => e
+        raise NameError, "digest class for :#{@generator} haven't been found", e.backtrace
+      end
+    end
+  end
+end

data/lib/graphql/persisted_queries/resolver.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module PersistedQueries
+    # Fetches or stores query string in the storage
+    class Resolver
+      # Raised when persisted query is not found in the storage
+      class NotFound < StandardError
+        def message
+          "PersistedQueryNotFound"
+        end
+      end
+
+      # Raised when provided hash is not matched with query
+      class WrongHash < StandardError
+        def message
+          "Wrong hash was passed"
+        end
+      end
+
+      def initialize(extensions, store, hash_generator_proc)
+        @extensions = extensions
+        @store = store
+        @hash_generator_proc = hash_generator_proc
+      end
+
+      def resolve(query_str)
+        return query_str if hash.nil?
+
+        if query_str
+          persist_query(query_str)
+        else
+          query_str = @store.fetch_query(hash)
+          raise NotFound if query_str.nil?
+        end
+
+        query_str
+      end
+
+      private
+
+      def persist_query(query_str)
+        raise WrongHash if @hash_generator_proc.call(query_str) != hash
+
+        @store.save_query(hash, query_str)
+      end
+
+      def hash
+        @hash ||= @extensions.dig("persistedQuery", "sha256Hash")
+      end
+    end
+  end
+end

data/lib/graphql/persisted_queries/schema_patch.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "graphql/persisted_queries/hash_generator_builder"
+require "graphql/persisted_queries/resolver"
+
+module GraphQL
+  module PersistedQueries
+    # Patches GraphQL::Schema to support persisted queries
+    module SchemaPatch
+      attr_reader :persisted_query_store, :hash_generator_proc
+
+      def configure_persisted_query_store(store, options)
+        @persisted_query_store = StoreAdapters.build(store, options)
+      end
+
+      def hash_generator=(hash_generator)
+        @hash_generator_proc = HashGeneratorBuilder.new(hash_generator).build
+      end
+
+      def execute(query_str = nil, **kwargs)
+        if (extensions = kwargs.delete(:extensions))
+          resolver = Resolver.new(extensions, persisted_query_store, hash_generator_proc)
+          query_str = resolver.resolve(query_str)
+        end
+
+        super
+      rescue Resolver::NotFound, Resolver::WrongHash => e
+        { errors: [{ message: e.message }] }
+      end
+    end
+  end
+end

data/lib/graphql/persisted_queries/store_adapters.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "graphql/persisted_queries/store_adapters/base_store_adapter"
+require "graphql/persisted_queries/store_adapters/memory_store_adapter"
+require "graphql/persisted_queries/store_adapters/redis_store_adapter"
+
+module GraphQL
+  module PersistedQueries
+    # Contains factory methods for store adapters
+    module StoreAdapters
+      def self.build(adapter, options = nil)
+        if adapter.is_a?(StoreAdapters::BaseStoreAdapter)
+          adapter
+        else
+          build_by_name(adapter, options)
+        end
+      end
+
+      def self.build_by_name(name, options)
+        camelized_adapter = name.to_s.split("_").map(&:capitalize).join
+        adapter_class_name = "#{camelized_adapter}StoreAdapter"
+        StoreAdapters.const_get(adapter_class_name).new(options || {})
+      rescue NameError => e
+        raise e.class, "Persisted query store adapter for :#{name} haven't been found", e.backtrace
+      end
+    end
+  end
+end

data/lib/graphql/persisted_queries/store_adapters/base_store_adapter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module PersistedQueries
+    module StoreAdapters
+      # Base class for all store adapters
+      class BaseStoreAdapter
+        def initialize(_options); end
+
+        def fetch_query(_hash)
+          raise NotImplementedError
+        end
+
+        def save_query(_hash, _query)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/graphql/persisted_queries/store_adapters/memory_store_adapter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module PersistedQueries
+    module StoreAdapters
+      # Memory adapter for storing persisted queries
+      class MemoryStoreAdapter < BaseStoreAdapter
+        def initialize(_options)
+          @storage = {}
+        end
+
+        def fetch_query(hash)
+          @storage[hash]
+        end
+
+        def save_query(hash, query)
+          @storage[hash] = query
+        end
+      end
+    end
+  end
+end

data/lib/graphql/persisted_queries/store_adapters/redis_store_adapter.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module PersistedQueries
+    module StoreAdapters
+      # Redis adapter for storing persisted queries
+      class RedisStoreAdapter < BaseStoreAdapter
+        attr_reader :storage
+
+        def initialize(client: nil, **options)
+          require "redis"
+
+          if client && options.any?
+            raise ArgumentError, "client cannot be passed along with redis_url, redis_host" \
+                                 ", redis_port or redis_db_name options"
+          end
+
+          @storage = client || configure_redis_client(options)
+        rescue LoadError => e
+          msg = "Could not load the 'redis' gem, please add it to your gemfile or " \
+                "configure a different adapter, e.g. use GraphQL::PersistedQueries, store: :memory"
+          raise e.class, msg, e.backtrace
+        end
+
+        def fetch_query(hash)
+          storage.get(key_for(hash))
+        end
+
+        def save_query(hash, query)
+          storage.set(key_for(hash), query)
+        end
+
+        private
+
+        def key_for(hash)
+          "persisted-query-#{hash}"
+        end
+
+        # rubocop:disable Metrics/LineLength
+        def configure_redis_client(redis_url: nil, redis_host: nil, redis_port: nil, redis_db_name: nil)
+          if redis_url && (redis_host || redis_port || redis_db_name)
+            raise ArgumentError, "redis_url cannot be passed along with redis_host, redis_port " \
+                                 "or redis_db_name options"
+          end
+
+          redis_url ||= build_redis_url(
+            redis_host: redis_host,
+            redis_port: redis_port,
+            redis_db_name: redis_db_name
+          )
+
+          Redis.new(url: redis_url)
+        end
+        # rubocop:enable Metrics/LineLength
+
+        DEFAULT_REDIS_DB = "0"
+
+        def build_redis_url(redis_host: nil, redis_port: nil, redis_db_name: nil)
+          redis_db_name ||= DEFAULT_REDIS_DB
+          redis_base_url = ENV["REDIS_URL"] || "redis://#{redis_host}:#{redis_port}"
+          URI.join(redis_base_url, redis_db_name).to_s
+        end
+      end
+    end
+  end
+end

data/lib/graphql/persisted_queries/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module PersistedQueries
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: graphql-persisted_queries
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- DmitryTsepelev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.75'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.75'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Persisted queries for graphql-ruby
+email:
+- dmitry.a.tsepelev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/graphql_1_8.gemfile
+- gemfiles/graphql_1_9.gemfile
+- gemfiles/graphql_master.gemfile
+- graphql-persisted_queries.gemspec
+- lib/graphql/persisted_queries.rb
+- lib/graphql/persisted_queries/hash_generator_builder.rb
+- lib/graphql/persisted_queries/resolver.rb
+- lib/graphql/persisted_queries/schema_patch.rb
+- lib/graphql/persisted_queries/store_adapters.rb
+- lib/graphql/persisted_queries/store_adapters/base_store_adapter.rb
+- lib/graphql/persisted_queries/store_adapters/memory_store_adapter.rb
+- lib/graphql/persisted_queries/store_adapters/redis_store_adapter.rb
+- lib/graphql/persisted_queries/version.rb
+homepage: https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Persisted queries for graphql-ruby
+test_files: []