rack-graphql 2.3.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19eaa68b6aad14dfbfe885f5853e1697a81549d278508ea3ba997894b160f686
-  data.tar.gz: 68e94bab40fbf24668dd55074698128e3f8014208a1fa8e6fa82330584bc4a29
+  metadata.gz: 845b505da7e26dbe5a9e5065514f0420de0c0394f09692afb6d49a134a35dcc2
+  data.tar.gz: 570b9ce45188d4371f18dd371468f77341535e54f574e06cc184e4e2aaf97adc
 SHA512:
-  metadata.gz: a349fc1e92684778a146af524b4e179cf10abbbe156b5a7f28b44d8860a008c7b18b2159f59327b9bbe4de20c2caa5eed7ecc908031e71b175a7ba850a01cfc6
-  data.tar.gz: 3d6ad7f221c8606175778807a7c5d09f3a534c9131eea1d8bf350552146fdec1517a3499cb073dc1295738fa849bc6721285101769e7c01049ea713ac32ab88b
+  metadata.gz: cbc0bbdad9edd52702b4bf7ad70dc46cf592a39e5a47fdb4031f87d1fcb29ca846555a8e05fa0e9620eb198f30212a17169444c6fe53be0a7083941bb8563a83
+  data.tar.gz: 11e95a8121612f0cd206cea8ac3109e02c5cc30a24524b1032b9d378926e0314a8c474b49e6c494a26d489e14f1e444b240c1f61ee330d5784d1d7c29639846e

data/.github/workflows/auto-merge.yml

@@ -0,0 +1,19 @@
+name: automerge
+on:
+  pull_request_review:
+    types:
+      - submitted
+  check_suite:
+    types:
+      - completed
+  status: {}
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    steps:
+      - name: automerge
+        uses: "pascalgn/automerge-action@v0.12.0"
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          MERGE_METHOD: squash
+          MERGE_DELETE_BRANCH: true

data/.travis.yml

@@ -5,6 +5,7 @@ cache: bundler
 rvm:
   - 2.6
   - 2.7
+  - 3.0
 before_install: gem install bundler
 script:
   - bundle exec rake rubocop

data/CHANGELOG.md

@@ -1,8 +1,26 @@
 # CHANGELOG
 
+## 2.6.0 - 2021-01-14
+
+- Add ability to re-raise exception (`re_raise_exceptions` option)
+
+## 2.5.1 - 2020-11-19
+
+- respond with http status `400` when UTF null byte is passed as a part of the input
+
+## 2.5.0 - 2020-11-18
+
+- make `log_exception_backtrace` false by default and allow to be controlled by `RACK_GRAPHQL_LOG_EXCEPTION_BACKTRACE` env var
+
+## 2.4.0 - 2020-09-39
+
+- Use `http_status` from `ExecutionError` for http response
+
 ## 2.3.0 - 2020-09-39
 
-- Add `error_status_code_map` option to `RackGraphql::Application`. It allows for return custom http code when specific errors are raised.
+- Add `error_status_code_map` option to `RackGraphql::Application`.
+
+  `error_status_code_map` allows for return custom http code when specific errors are raised.
 
 ## 2.2.1 - 2020-09-14
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-graphql (2.3.0)
+    rack-graphql (2.6.0)
       graphql (~> 1.11)
       oj
       rack (~> 2.2)
@@ -13,11 +13,11 @@ GEM
     awesome_print (1.8.0)
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    graphql (1.11.4)
+    graphql (1.11.6)
     method_source (1.0.0)
-    oj (3.10.14)
-    parallel (1.19.2)
-    parser (2.7.1.5)
+    oj (3.11.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -26,43 +26,44 @@ GEM
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.8.1)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.92.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.8.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.5.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.7.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.0)
       parser (>= 2.7.1.5)
-    rubocop-performance (1.8.1)
-      rubocop (>= 0.87.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rspec (1.43.2)
-      rubocop (~> 0.87)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.7.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.1.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   awesome_print
@@ -73,8 +74,8 @@ DEPENDENCIES
   rake
   rspec
   rubocop
-  rubocop-performance
+  rubocop-rake
   rubocop-rspec
 
 BUNDLED WITH
-   2.1.4
+   2.2.4

data/README.md

@@ -23,12 +23,15 @@ Add following to your `config.ru` file:
 
 ```ruby
 run RackGraphql::Application.call(
-  schema: YourGraqphqlSchema,                    # required
-  app_name: 'your-service-name',                 # optional, used for health endpoint content
-  context_handler: YourGraphqlContextHandler,    # optional, empty `proc` by default
-  log_exception_backtrace: !A9n.env.production?, # optional, `true` default
-  health_route: true,                             # optional, true by default
-  logger: A9n.logger,                            # optional, not set by default
+  schema: YourGraqphqlSchema,                       # required
+  app_name: 'your-service-name',                    # optional, used for health endpoint content
+  context_handler: YourGraphqlContextHandler,       # optional, empty `proc` by default
+  log_exception_backtrace: !A9n.env.production?,    # optional, `false` default
+  # `true` when `RACK_GRAPHQL_LOG_EXCEPTION_BACKTRACE` env var is set to `'1'` or `'true'`
+  health_route: true,                               # optional, true by default
+  logger: A9n.logger,                               # optional, not set by default
+  error_status_code_map: { IamTeapotError => 418 }, # optional
+  re_raise_exceptions: true,                        # optional, false by default
 )
 ```
 
@@ -79,6 +82,39 @@ RackGraphql catches all errors and respond with 500 code. By default it adds exc
 RackGraphql.log_exception_backtrace = false
 ```
 
+### Error tracking/reporting
+
+To respect the graphql spec, all errors need to be returned as json and `rack-graphql` catches all exceptions and does NOT re-raise them. You can change this behavior via `re_raise_exceptions` argument.
+Because of this, using error tracking middleware (`use Sentry::Rack::CaptureExceptions`, `use Raven::Rack`) does not take any effect for graphql requests.
+
+To use Sentry or other reporting tool for graphql queries, you can use `GraphQL::Schema` middleware:
+
+```ruby
+class GraphqlErrorTrackerMiddleware
+  def self.call(parent_type, parent_object, field_definition, field_args, query_context)
+    yield
+  rescue StandardError => e
+    extra = {
+      parent_type: parent_type.inspect,
+      parent_object: parent_object.inspect,
+      field_definition: field_definition.to_s,
+      field_args: field_args&.to_h,
+      query_context: query_context&.to_h
+    }
+    Sentry.capture_exception(e, extra: extra)
+    raise
+  end
+end
+
+# MySchema.middleware GraphqlErrorTrackerMiddleware
+# or
+# GraphQL::Schema.middleware GraphqlErrorTrackerMiddleware
+# or
+# class MySchema < GraphQL::Schema
+#   middleware GraphqlErrorTrackerMiddleware
+# end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/RenoFi/rack-graphql. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/rack_graphql.rb

@@ -10,8 +10,12 @@ require 'rack_graphql/application'
 
 module RackGraphql
   class << self
-    attr_accessor :log_exception_backtrace
-  end
+    def log_exception_backtrace
+      return @log_exception_backtrace unless @log_exception_backtrace.nil?
+
+      %w[1 true].include?(ENV['RACK_GRAPHQL_LOG_EXCEPTION_BACKTRACE'].to_s)
+    end
 
-  self.log_exception_backtrace = true
+    attr_writer :log_exception_backtrace
+  end
 end

data/lib/rack_graphql/application.rb

@@ -5,6 +5,7 @@ module RackGraphql
       app_name: 'rack-graphql-service',
       logger: nil,
       context_handler: nil,
+      re_raise_exceptions: false,
       log_exception_backtrace: RackGraphql.log_exception_backtrace,
       health_route: true,
       health_response_builder: RackGraphql::HealthResponseBuilder,
@@ -17,6 +18,7 @@ module RackGraphql
             app_name: app_name,
             schema: schema,
             context_handler: context_handler,
+            re_raise_exceptions: re_raise_exceptions,
             logger: logger,
             log_exception_backtrace: log_exception_backtrace,
             error_status_code_map: error_status_code_map,

data/lib/rack_graphql/middleware.rb

@@ -1,6 +1,8 @@
 module RackGraphql
   class Middleware
+    DEFAULT_STATUS_CODE = 200
     DEFAULT_ERROR_STATUS_CODE = 500
+    NULL_BYTE = '\u0000'.freeze
 
     def initialize(
       schema:,
@@ -8,6 +10,7 @@ module RackGraphql
       context_handler: nil,
       logger: nil,
       log_exception_backtrace: RackGraphql.log_exception_backtrace,
+      re_raise_exceptions: false,
       error_status_code_map: {}
     )
 
@@ -16,6 +19,7 @@ module RackGraphql
       @context_handler = context_handler || ->(_) {}
       @logger = logger
       @log_exception_backtrace = log_exception_backtrace
+      @re_raise_exceptions = re_raise_exceptions
       @error_status_code_map = error_status_code_map
     end
 
@@ -34,7 +38,7 @@ module RackGraphql
       result = execute(params: params, operation_name: operation_name, variables: variables, context: context)
 
       [
-        200,
+        response_status(result),
         response_headers(result),
         [response_body(result)]
       ]
@@ -50,9 +54,14 @@ module RackGraphql
       ]
     rescue StandardError, LoadError, SyntaxError => e
       # To respect the graphql spec, all errors need to be returned as json.
-      # It needs to take Rack::ShowExceptions role of catching all exceptions raised by the app.
+      # By default exceptions are not re-raised,
+      # so they cannot be caught by error tracking rack middlewares.
+      # You can change this behavior via `re_raise_exceptions` argument.
       exception_string = dump_exception(e)
       log(exception_string)
+
+      raise e if re_raise_exceptions
+
       env[Rack::RACK_ERRORS].puts(exception_string)
       env[Rack::RACK_ERRORS].flush
       [
@@ -66,14 +75,18 @@ module RackGraphql
 
     private
 
-    attr_reader :schema, :app_name, :logger, :context_handler, :log_exception_backtrace, :error_status_code_map
+    attr_reader :schema, :app_name, :logger, :context_handler,
+      :log_exception_backtrace, :error_status_code_map, :re_raise_exceptions
 
     def post_request?(env)
       env['REQUEST_METHOD'] == 'POST'
     end
 
     def post_data(env)
-      ::Oj.load(env['rack.input'].gets.to_s)
+      payload = env['rack.input'].read.to_s
+      return nil if payload.index(NULL_BYTE)
+
+      ::Oj.load(payload)
     rescue Oj::ParseError
       nil
     end
@@ -136,6 +149,13 @@ module RackGraphql
       end
     end
 
+    def response_status(result)
+      return DEFAULT_STATUS_CODE if result.is_a?(Array)
+
+      errors = result.to_h["errors"] || []
+      errors.map { |e| e["http_status"] }.compact.first || DEFAULT_STATUS_CODE
+    end
+
     def response_body(result = nil)
       if result_subscription?(result)
         body = result.to_h

data/lib/rack_graphql/version.rb

@@ -1,3 +1,3 @@
 module RackGraphql
-  VERSION = '2.3.0'.freeze
+  VERSION = '2.6.0'.freeze
 end

data/rack-graphql.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = 'https://github.com/RenoFi/rack-graphql'
   spec.metadata['source_code_uri'] = 'https://github.com/RenoFi/rack-graphql'
+  spec.metadata['changelog_uri'] = 'https://github.com/RenoFi/rack-graphql/blob/master/CHANGELOG.md'
 
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin/|spec/|\.rub)}) }
@@ -35,6 +36,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-graphql
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Krzysztof Knapik
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -152,7 +152,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,6 +193,7 @@ files:
 - ".github/ISSUE_TEMPLATE/story.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/auto-approve.yml"
+- ".github/workflows/auto-merge.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -216,6 +217,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/RenoFi/rack-graphql
   source_code_uri: https://github.com/RenoFi/rack-graphql
+  changelog_uri: https://github.com/RenoFi/rack-graphql/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -231,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Rack middleware implementing graphql endpoint.