graphql 2.6.9 → 2.6.14

data/lib/graphql/railtie.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
+# typed: true
 
 module GraphQL
-  # Support {GraphQL::Parser::Cache} and {GraphQL.eager_load!}
+  # Support [GraphQL::Language::Cache](rdoc-ref:GraphQL::Language::Cache) and [GraphQL.eager_load!](rdoc-ref:GraphQL.eager_load!)
   #
-  # @example Enable the parser cache with default directory
+  # **Examples**
   #
-  #   config.graphql.parser_cache = true
+  # **Example: Enable the parser cache with default directory**
   #
+  # ```ruby
+  # config.graphql.parser_cache = true
+  # ```
   class Railtie < Rails::Railtie
     config.graphql = ActiveSupport::OrderedOptions.new
     config.graphql.parser_cache = false

data/lib/graphql/rake_task/validate.rb

@@ -1,21 +1,83 @@
 # frozen_string_literal: true
+# typed: true
+require "digest/sha2"
+require "net/http"
+require "erb"
 
 module GraphQL
   class RakeTask
     extend Rake::DSL
 
+    # Helpers for `graphql:pro:validate`.
+    # Credentials are never passed to a subprocess, so they can't leak into the process list or logs.
+    module Validate
+      CREDENTIALS_PATTERN = /\A[a-z0-9]{11}:[a-z0-9]{11}\z/
+      DIGEST_PATTERN = /\A\h{128}\z/
+
+      module_function
+
+      # Returns a normalized version string, or `nil` if `version` isn't a valid gem version.
+      def normalize_version(version)
+        # `Gem::Version.correct?` accepts `nil` and `""`, so check those first
+        if !version.is_a?(String) || version.strip.empty? || !Gem::Version.correct?(version)
+          nil
+        else
+          # Strips surrounding whitespace, leaving only `[0-9a-zA-Z.]`
+          Gem::Version.new(version).to_s
+        end
+      end
+
+      # Returns `user:pass` for gems.graphql.pro, or `nil` if it isn't configured.
+      def credentials
+        creds = if defined?(Bundler) && Bundler.respond_to?(:settings)
+          Bundler.settings["gems.graphql.pro"]
+        end
+        if creds.nil?
+          # Array form doesn't use a shell, and no secrets are in the arguments
+          output = IO.popen(["bundle", "config", "get", "gems.graphql.pro", "--parseable"], err: File::NULL, &:read)
+          creds = output[/[a-z0-9]{11}:[a-z0-9]{11}/]
+        end
+        creds = creds&.strip
+        creds && creds.match?(CREDENTIALS_PATTERN) ? creds : nil
+      rescue SystemCallError
+        nil
+      end
+
+      # Returns the SHA512 hex digest of the downloaded gem, or `nil` if the download failed.
+      def fetch_gem_digest(version, creds)
+        user, pass = creds.split(":", 2)
+        uri = URI.parse("https://gems.graphql.pro/gems/graphql-pro-#{version}.gem")
+        req = Net::HTTP::Get.new(uri)
+        req.basic_auth(user, pass)
+        res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
+        res.is_a?(Net::HTTPSuccess) ? Digest::SHA512.hexdigest(res.body.to_s) : nil
+      end
+
+      # Returns the published digest at `uri`, or `nil` if it couldn't be fetched.
+      def fetch_published_digest(uri)
+        res = Net::HTTP.get_response(uri)
+        return nil unless res.is_a?(Net::HTTPSuccess)
+        # Remove final newline from .txt file
+        digest = res.body.to_s.strip
+        digest.match?(DIGEST_PATTERN) ? digest : nil
+      end
+    end
+
     desc "Get the checksum of a graphql-pro version and compare it to published versions on GitHub and graphql-ruby.org"
     task "graphql:pro:validate", [:gem_version] do |t, args|
-      version = args[:gem_version]
-      if version.nil?
+      if args[:gem_version].nil?
         raise ArgumentError, "A specific version is required, eg `rake graphql:pro:validate[1.12.0]`"
       end
+      version = Validate.normalize_version(args[:gem_version])
+      if version.nil?
+        raise ArgumentError, "Invalid version #{args[:gem_version].inspect}, expected a gem version like `rake graphql:pro:validate[1.12.0]`"
+      end
       check = "\e[32m✓\e[0m"
       ex = "\e[31m✘\e[0m"
       puts "Validating graphql-pro v#{version}"
       puts "  - Checking for graphql-pro credentials..."
 
-      creds = `bundle config gems.graphql.pro --parseable`[/[a-z0-9]{11}:[a-z0-9]{11}/]
+      creds = Validate.credentials
       if creds.nil?
         puts "    #{ex} failed, please set with `bundle config gems.graphql.pro $MY_CREDENTIALS`"
         exit(1)
@@ -24,8 +86,8 @@ module GraphQL
       end
 
       puts "  - Fetching the gem..."
-      fetch_result = `gem fetch graphql-pro -v #{version} --source https://#{creds}@gems.graphql.pro`
-      if fetch_result.empty?
+      gem_digest = Validate.fetch_gem_digest(version, creds)
+      if gem_digest.nil?
         puts "    #{ex} failed to fetch v#{version}"
         exit(1)
       else
@@ -33,15 +95,8 @@ module GraphQL
       end
 
       puts "  - Validating digest..."
-      require "digest/sha2"
-      gem_digest = Digest::SHA512.new.hexdigest(File.read("graphql-pro-#{version}.gem"))
-      require "net/http"
-      github_uri = URI("https://raw.githubusercontent.com/rmosolgo/graphql-ruby/master/guides/pro/checksums/graphql-pro-#{version}.txt")
-      # Remove final newline from .txt file
-      github_digest = Net::HTTP.get(github_uri).chomp
-
-      docs_uri = URI("https://graphql-ruby.org/pro/checksums/graphql-pro-#{version}.txt")
-      docs_digest = Net::HTTP.get(docs_uri).chomp
+      github_digest = Validate.fetch_published_digest(URI("https://raw.githubusercontent.com/rmosolgo/graphql-ruby/master/guides/pro/checksums/graphql-pro-#{version}.txt"))
+      docs_digest = Validate.fetch_published_digest(URI("https://graphql-ruby.org/pro/checksums/graphql-pro-#{version}.txt"))
 
       if docs_digest == gem_digest && github_digest == gem_digest
         puts "    #{check} validated from GitHub"
@@ -49,11 +104,11 @@ module GraphQL
       else
         puts "    #{ex} SHA mismatch:"
         puts "      Downloaded:       #{gem_digest}"
-        puts "      GitHub:           #{github_digest}"
-        puts "      graphql-ruby.org: #{docs_digest}"
+        puts "      GitHub:           #{github_digest || "(not found)"}"
+        puts "      graphql-ruby.org: #{docs_digest || "(not found)"}"
         puts ""
         puts "      This download of graphql-pro is invalid, please open an issue:"
-        puts "      https://github.com/rmosolgo/graphql-ruby/issues/new?title=graphql-pro%20digest%20mismatch%20(#{version})"
+        puts "      https://github.com/rmosolgo/graphql-ruby/issues/new?title=#{ERB::Util.url_encode("graphql-pro digest mismatch (#{version})")}"
         exit(1)
       end
 

data/lib/graphql/rake_task.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 require "fileutils"
 require "rake"
 require "graphql/rake_task/validate"
@@ -11,21 +12,32 @@ module GraphQL
   #
   # Use `load_context:` and `visible?` to dump schemas under certain visibility constraints.
   #
-  # @example Dump a Schema to .graphql + .json files
-  #   require "graphql/rake_task"
-  #   GraphQL::RakeTask.new(schema_name: "MySchema")
+  # **Examples**
   #
-  #   # $ rake graphql:schema:dump
-  #   # Schema IDL dumped to ./schema.graphql
-  #   # Schema JSON dumped to ./schema.json
+  # **Example: Dump a Schema to .graphql + .json files**
   #
-  # @example Invoking the task from Ruby
-  #   require "rake"
-  #   Rake::Task["graphql:schema:dump"].invoke
+  # ```ruby
+  # require "graphql/rake_task"
+  # GraphQL::RakeTask.new(schema_name: "MySchema")
   #
-  # @example Providing arguments to build the introspection query
-  #   require "graphql/rake_task"
-  #   GraphQL::RakeTask.new(schema_name: "MySchema", include_is_one_of: true)
+  # # $ rake graphql:schema:dump
+  # # Schema IDL dumped to ./schema.graphql
+  # # Schema JSON dumped to ./schema.json
+  # ```
+  #
+  # **Example: Invoking the task from Ruby**
+  #
+  # ```ruby
+  # require "rake"
+  # Rake::Task["graphql:schema:dump"].invoke
+  # ```
+  #
+  # **Example: Providing arguments to build the introspection query**
+  #
+  # ```ruby
+  # require "graphql/rake_task"
+  # GraphQL::RakeTask.new(schema_name: "MySchema", include_is_one_of: true)
+  # ```
   class RakeTask
     include Rake::DSL
 
@@ -45,37 +57,57 @@ module GraphQL
       include_is_one_of: false
     }
 
-    # @return [String] Namespace for generated tasks
+    # **Returns**
+    #
+    # - `String` — Namespace for generated tasks
     attr_writer :namespace
 
     def rake_namespace
       @namespace
     end
 
-    # @return [Array<String>]
+    # **Returns**
+    #
+    # - `Array<String>`
     attr_accessor :dependencies
 
-    # @return [String] By default, used to find the schema as a constant.
-    # @see {#load_schema} for loading a schema another way
+    # See [load_schema](rdoc-ref:#load_schema) for loading a schema another way
+    #
+    # **Returns**
+    #
+    # - `String` — By default, used to find the schema as a constant.
     attr_accessor :schema_name
 
-    # @return [<#call(task)>] A proc for loading the target GraphQL schema
+    # **Returns**
+    #
+    # - `<#call(task)>` — A proc for loading the target GraphQL schema
     attr_accessor :load_schema
 
-    # @return [<#call(task)>] A callable for loading the query context
+    # **Returns**
+    #
+    # - `<#call(task)>` — A callable for loading the query context
     attr_accessor :load_context
 
-    # @return [String] target for IDL task
+    # **Returns**
+    #
+    # - `String` — target for IDL task
     attr_accessor :idl_outfile
 
-    # @return [String] target for JSON task
+    # **Returns**
+    #
+    # - `String` — target for JSON task
     attr_accessor :json_outfile
 
-    # @return [String] directory for IDL & JSON files
+    # **Returns**
+    #
+    # - `String` — directory for IDL & JSON files
     attr_accessor :directory
 
-    # @return [Boolean] Options for additional fields in the introspection query JSON response
-    # @see GraphQL::Schema.as_json
+    # See [GraphQL::Schema.as_json](rdoc-ref:GraphQL::Schema.as_json).
+    #
+    # **Returns**
+    #
+    # - `Boolean` — Options for additional fields in the introspection query JSON response
     attr_accessor :include_deprecated_args, :include_schema_description, :include_is_repeatable, :include_specified_by_url, :include_is_one_of
 
     # Set the parameters of this task by passing keyword arguments

data/lib/graphql/relay/range_add.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   module Relay
     # This provides some isolation from `GraphQL::Relay` internals.
@@ -8,32 +9,42 @@ module GraphQL
     # The connection doesn't receive outside arguments, so the list of items
     # should be ordered and paginated before providing it here.
     #
-    # @example Adding a comment to list of comments
-    #   post = Post.find(args[:post_id])
-    #   comments = post.comments
-    #   new_comment = comments.build(body: args[:body])
-    #   new_comment.save!
+    # **Examples**
     #
-    #   range_add = GraphQL::Relay::RangeAdd.new(
-    #     parent: post,
-    #     collection: comments,
-    #     item: new_comment,
-    #     context: context,
-    #   )
+    # **Example: Adding a comment to list of comments**
     #
-    #   response = {
-    #     post: post,
-    #     comments_connection: range_add.connection,
-    #     new_comment_edge: range_add.edge,
-    #   }
+    # ```ruby
+    # post = Post.find(args[:post_id])
+    # comments = post.comments
+    # new_comment = comments.build(body: args[:body])
+    # new_comment.save!
+    #
+    # range_add = GraphQL::Relay::RangeAdd.new(
+    #   parent: post,
+    #   collection: comments,
+    #   item: new_comment,
+    #   context: context,
+    # )
+    #
+    # response = {
+    #   post: post,
+    #   comments_connection: range_add.connection,
+    #   new_comment_edge: range_add.edge,
+    # }
+    # ```
     class RangeAdd
       attr_reader :edge, :connection, :parent
 
-      # @param collection [Object] The list of items to wrap in a connection
-      # @param item [Object] The newly-added item (will be wrapped in `edge_class`)
-      # @param context [GraphQL::Query::Context] The surrounding `ctx`, will be passed to the connection
-      # @param parent [Object] The owner of `collection`, will be passed to the connection if provided
-      # @param edge_class [Class] The class to wrap `item` with (defaults to the connection's edge class)
+      # **Parameters**
+      #
+      # - `collection` (`Object`) — The list of items to wrap in a connection
+      # - `item` (`Object`) — The newly-added item (will be wrapped in `edge_class`)
+      # - `context` (`GraphQL::Query::Context`) — The surrounding `ctx`, will be passed to the connection
+      # - `parent` (`Object`) — The owner of `collection`, will be passed to the connection if provided
+      # - `edge_class` (`Class`) — The class to wrap `item` with (defaults to the connection's edge class)
+      #
+      # :call-seq:
+      #   initialize(Object collection:, Object item:, GraphQL::Query::Context context:, Object parent:, Class edge_class:)
       def initialize(collection:, item:, context:, parent: nil, edge_class: nil)
         conn_class = context.schema.connections.wrapper_for(collection)
         # The rest will be added by ConnectionExtension

data/lib/graphql/relay.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
+# typed: true
 
 require 'graphql/relay/range_add'

data/lib/graphql/rubocop/graphql/base_cop.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 require "rubocop"
 
 module GraphQL

data/lib/graphql/rubocop/graphql/default_null_true.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 require_relative "base_cop"
 
 module GraphQL
@@ -11,15 +12,17 @@ module GraphQL
       # to non-null fields (`null: false`) without a breaking change. (The opposite change, from `null: false`
       # to `null: true`, change.)
       #
-      # @example
-      #   # Both of these define `name: String` in GraphQL:
+      # **Examples**
       #
-      #   # bad
-      #   field :name, String, null: true
+      # **Example: # Both of these define `name: String` in GraphQL:**
       #
-      #   # good
-      #   field :name, String
+      # ```ruby
+      # # bad
+      # field :name, String, null: true
       #
+      # # good
+      # field :name, String
+      # ```
       class DefaultNullTrue < BaseCop
         MSG = "`null: true` is the default and can be removed."
 

data/lib/graphql/rubocop/graphql/default_required_true.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 require_relative "./base_cop"
 
 module GraphQL
@@ -11,15 +12,17 @@ module GraphQL
       # to optional arguments (`required: false`) without a breaking change. (The opposite change, from `required: false`
       # to `required: true`, change.)
       #
-      # @example
-      #   # Both of these define `id: ID!` in GraphQL:
+      # **Examples**
       #
-      #   # bad
-      #   argument :id, ID, required: true
+      # **Example: # Both of these define `id: ID!` in GraphQL:**
       #
-      #   # good
-      #   argument :id, ID
+      # ```ruby
+      # # bad
+      # argument :id, ID, required: true
       #
+      # # good
+      # argument :id, ID
+      # ```
       class DefaultRequiredTrue < BaseCop
         MSG = "`required: true` is the default and can be removed."
 

data/lib/graphql/rubocop/graphql/field_type_in_block.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 require_relative "./base_cop"
 
 module GraphQL
@@ -7,15 +8,18 @@ module GraphQL
       # Identify (and auto-correct) any field whose type configuration isn't given
       # in the configuration block.
       #
-      # @example
-      #   # bad, immediately causes Rails to load `app/graphql/types/thing.rb`
-      #   field :thing, Types::Thing
+      # **Examples**
       #
-      #   # good, defers loading until the file is needed
-      #   field :thing do
-      #     type(Types::Thing)
-      #   end
+      # **Example: # bad, immediately causes Rails to load `app/graphql/types/thing.rb`**
       #
+      # ```ruby
+      # field :thing, Types::Thing
+      #
+      # # good, defers loading until the file is needed
+      # field :thing do
+      #   type(Types::Thing)
+      # end
+      # ```
       class FieldTypeInBlock < BaseCop
         MSG = "type configuration can be moved to a block to defer loading the type's file"
 
@@ -133,7 +137,7 @@ module GraphQL
             field_indent << " "
             indent_test_idx -= 1
             if indent_test_idx == 0
-              raise "Invariant: somehow backtracted to beginning of class when looking for field indent (source: #{node_source.inspect})"
+              raise "Invariant: somehow backtracted to beginning of class when looking for field indent (source: #{type_defn_source.inspect})"
             end
           end
           field_indent

data/lib/graphql/rubocop/graphql/root_types_in_block.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 require_relative "./base_cop"
 
 module GraphQL
@@ -6,13 +7,16 @@ module GraphQL
     module GraphQL
       # Identify (and auto-correct) any root types in your schema file.
       #
-      # @example
-      #   # bad, immediately causes Rails to load `app/graphql/types/query.rb`
-      #   query Types::Query
+      # **Examples**
       #
-      #   # good, defers loading until the file is needed
-      #   query { Types::Query }
+      # **Example: # bad, immediately causes Rails to load `app/graphql/types/query.rb`**
       #
+      # ```ruby
+      # query Types::Query
+      #
+      # # good, defers loading until the file is needed
+      # query { Types::Query }
+      # ```
       class RootTypesInBlock < BaseCop
         MSG = "type configuration can be moved to a block to defer loading the type's file"
 

data/lib/graphql/rubocop.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 require "graphql/rubocop/graphql/default_null_true"
 require "graphql/rubocop/graphql/default_required_true"

data/lib/graphql/runtime_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   class RuntimeError < Error
     include GraphQL::Execution::Finalizer

data/lib/graphql/runtime_type_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 module GraphQL
   class RuntimeTypeError < GraphQL::Error
   end