better-graphql-detect-invalid-id-field 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5e5b5448ac015f65f160b4f2fe10c11bea05999b62418616a31bdb44aff293da
+  data.tar.gz: 30ab5b7c59e7db294e9b23668a8cb3e6ebb0d9fd81f62fba85326f9350232388
+SHA512:
+  metadata.gz: f10d9a316501b99e5e8b4cfcfb32ed1951ec9ed0367069462584d05776ccecb9a1982105804ed39e83ef2cf6d65e462c51be06f8214652763a04e3e966b972b2
+  data.tar.gz: 907b60adac34c295fd925171044d146c6e295b375e79845af725c8f2f9f477089c3ca1b2463fda7fa0e3bd2d5a7f7c1b869fb971fad7bcbddde77cce8151c803

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+Layout/LineLength:
+  Max: 200
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in better-graphql-detect-invalid-id-field.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    better-graphql-detect-invalid-id-field (0.1.0)
+      graphql (>= 1.11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.4.4)
+    graphql (1.11.6)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    regexp_parser (2.0.0)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.6.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-shopify (1.0.7)
+      rubocop (~> 1.4)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  better-graphql-detect-invalid-id-field!
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.4)
+  rubocop-shopify (~> 1.0.7)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 gtkatakura
+
+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,50 @@
+[![Build Status](https://travis-ci.com/gtkatakura/better-graphql-detect-invalid-id-field.svg?branch=master)](https://travis-ci.com/gtkatakura/better-graphql-detect-invalid-id-field)
+
+# BetterGraphQL::DetectInvalidIdField
+
+Detect invalid id field for GraphQL types by detecting divergent fields between nodes representing the same object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'better-graphql-detect-invalid-id-field'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install better-graphql-detect-invalid-id-field
+
+## Usage
+
+Add to your schema:
+
+```ruby
+class YourSchema < GraphQL::Schema
+  query(QueryType)
+
+  if Rails.env.test? || Rails.env.development?
+    require 'better_graphql/detect_invalid_id_field'
+    use ::BetterGraphQL::DetectInvalidIdField
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/gtkatakura/better-graphql-detect-invalid-id-field.
+
+## 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,7 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/better-graphql-detect-invalid-id-field.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require_relative 'lib/better_graphql/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'better-graphql-detect-invalid-id-field'
+  spec.version = BetterGraphQL::VERSION
+  spec.authors = ['gtkatakura']
+  spec.email = ['gt.katakura@gmail.com']
+
+  spec.summary = 'Detect invalid id field for GraphQL types'
+  spec.description = 'Detect invalid id field for GraphQL types by detecting divergent fields between nodes representing the same object'
+  spec.homepage = 'http://github.com/gtkatakura/better-graphql-detect-invalid-id-field'
+  spec.license = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'http://github.com/gtkatakura/better-graphql-detect-invalid-id-field'
+    spec.metadata['changelog_uri'] = 'http://github.com/gtkatakura/better-graphql-detect-invalid-id-field/blob/main/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    %x(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.add_development_dependency('bundler', '~> 1.17')
+  spec.add_development_dependency('rake', '~> 10.0')
+  spec.add_development_dependency('rspec', '~> 3.0')
+  spec.add_development_dependency('rubocop', '~> 1.4')
+  spec.add_development_dependency('rubocop-shopify', '~> 1.0.7')
+
+  spec.add_runtime_dependency('graphql', '>= 1.11')
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'better_graphql/detect_invalid_id_field'
+
+# 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/lib/better_graphql.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require 'better_graphql/version'
+require 'better_graphql/detect_invalid_id_field/version'
+
+module BetterGraphQL
+end

data/lib/better_graphql/detect_invalid_id_field.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+module BetterGraphQL
+  class DetectInvalidIdField
+    def self.use(schema)
+      tracer = new
+      schema.tracer(tracer)
+    end
+
+    def initialize
+      @cache = {}
+    end
+
+    def trace(key, data)
+      @cache = {} if key == 'parse'
+
+      return yield if key != 'execute_field'
+
+      yield.tap do |resolved_value|
+        next unless comparable?(resolved_value)
+
+        if data[:context]
+          parent_type = data[:context].parent_type
+          field = data[:context].field
+          path = data[:context].path
+        else
+          parent_type = data[:owner]
+          field = data[:field]
+          path = data[:path]
+        end
+
+        cache_by_type = cache[parent_type] ||= {}
+        nodes_by_path = cache_by_type[:nodes_by_path] ||= {}
+        nodes_by_id = cache_by_type[:nodes_by_id] ||= {}
+
+        field_name = field.name.to_sym
+        parent_path = path[0..-2]
+
+        resolving_object = nodes_by_path[parent_path] ||= {
+          __metadata__: { parent_path: parent_path },
+        }
+
+        resolving_object[field_name] = resolved_value
+
+        if field_name == :id
+          nodes_by_id[resolved_value] ||= []
+          nodes_by_id[resolved_value] << resolving_object
+          next
+        end
+
+        if resolving_object.key?(:id)
+          all_nodes_with_same_id = nodes_by_id[resolving_object[:id]]
+
+          other_nodes_with_same_id = all_nodes_with_same_id - [resolving_object]
+
+          other_nodes_with_same_id.each do |another_node|
+            next unless another_node[field_name] != resolved_value
+            raise StandardError,
+              "The field #{parent_type.graphql_name}#id must be unique across the graph." \
+              ' You have two nodes representing the same object in the graph, but they are returning different values for the same field.' \
+              " #{parent_type.graphql_name}#id = #{resolving_object[:id]}." \
+              " Divergence: #{(another_node[:__metadata__][:parent_path] + [field_name]).join('.')} = #{another_node[field_name].to_json} and #{path.join('.')} = #{resolved_value.to_json}"
+          end
+        end
+      end
+    end
+
+    private
+
+    attr_reader :cache
+
+    def comparable?(value)
+      value.is_a?(Numeric) ||
+        value.is_a?(String) ||
+        value.is_a?(Date) ||
+        value.is_a?(DateTime) ||
+        value.is_a?(Time) ||
+        value.is_a?(TrueClass) ||
+        value.is_a?(FalseClass) ||
+        value.is_a?(NilClass) ||
+        value.is_a?(Hash)
+    end
+  end
+end

data/lib/better_graphql/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module BetterGraphQL
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: better-graphql-detect-invalid-id-field
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- gtkatakura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+description: Detect invalid id field for GraphQL types by detecting divergent fields
+  between nodes representing the same object
+email:
+- gt.katakura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- better-graphql-detect-invalid-id-field.gemspec
+- bin/console
+- bin/setup
+- lib/better_graphql.rb
+- lib/better_graphql/detect_invalid_id_field.rb
+- lib/better_graphql/version.rb
+homepage: http://github.com/gtkatakura/better-graphql-detect-invalid-id-field
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: http://github.com/gtkatakura/better-graphql-detect-invalid-id-field
+  source_code_uri: http://github.com/gtkatakura/better-graphql-detect-invalid-id-field
+  changelog_uri: http://github.com/gtkatakura/better-graphql-detect-invalid-id-field/blob/main/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Detect invalid id field for GraphQL types
+test_files: []