rack-graphql 1.2.5 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbb7b5de3d2e500fee04bf1820a5c37ffc64ad0a16abfae3055ec1e8aec3b2c3
-  data.tar.gz: 17d62e7a1b6649cdb5abce402401a18ba7ba44b1f12aeee1bcf8263f3e4c05a6
+  metadata.gz: 6598f80d99758463e5b906b46793eb99e00a4289d575e4a9947049a1a365cad2
+  data.tar.gz: d255f35c7dae31102576f2c20024b3627c5cfe47f41f6c84e91d2d284c297ea9
 SHA512:
-  metadata.gz: ec64d07ae37fe8fbefa7060a0602d47d7a45f3f66c0e71100e9c604825271d8b81be2d98fb0efd3aa4b5c68be467d46991cccd4a7061a245843b820aec45e557
-  data.tar.gz: 6bdf228ad21ddc91ff1a1ebc2eb966d797ea274d1e893e695f783a304ad497028b76384a764841bb57e99614cc9f61cbd07a9cd527968e041d875134cc862da2
+  metadata.gz: ccfe829dc5cb515d817d670ed2f41a414c089cbd959f24c71db11f3ff2aeaa00b365ef2e3db429921db80bf872ed36c3e27fd0915b9645281eb2c383138f79ca
+  data.tar.gz: f10803e7f9fc3db00ba5b6fdbce23b7d52d023d5e8aeafb8201fa1880c5f25f9517fea2ab452ff82b0889a070316f9c8892022d935e95c1ba14d58d2b0cb5472

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

@@ -1,7 +1,7 @@
-# automatically approve PRs submitted by Dependabot
+# automatically approve PRs submitted by Dependabot or Renofidev
 # this will allow Dependabot to automatically merge dependency update PRs where CI passes
 # from: https://github.com/hmarr/auto-approve-action
-name: Auto approve Dependabot PRs
+name: Auto approve dependency upgrades PRs
 
 on:
   pull_request
@@ -11,6 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: hmarr/auto-approve-action@v2.0.0
-      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]'
+      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]' || github.actor == 'renofidev'
       with:
         github-token: "${{ secrets.GITHUB_TOKEN }}"

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# CHANGELOG
+
+## 2.2.0 - 2020-09-14
+
+- Add `source_app` to error payload.
+
+## 2.1.0 - 2020-09-14
+
+- Add `log_exception_backtrace` option to `RackGraphql::Application`
+
+## 2.0.0 - 2020-09-14
+
+- Catch all exceptions raised by the app respond with 500 status codea and json content type
+- Add ability to not log exception backtrace with `RackGraphql.log_exception_backtrace = false`

data/Gemfile.lock

@@ -1,20 +1,21 @@
 PATH
   remote: .
   specs:
-    rack-graphql (1.2.5)
-      graphql (~> 1.9)
+    rack-graphql (2.2.0)
+      graphql (~> 1.11)
       oj
-      rack (~> 2.0)
+      rack (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.1)
+    awesome_print (1.8.0)
     coderay (1.1.3)
     diff-lcs (1.4.4)
     graphql (1.11.4)
     method_source (1.0.0)
-    oj (3.10.13)
+    oj (3.10.14)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
@@ -52,8 +53,8 @@ GEM
       unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-ast (0.3.0)
       parser (>= 2.7.1.4)
-    rubocop-performance (1.7.1)
-      rubocop (>= 0.82.0)
+    rubocop-performance (1.8.0)
+      rubocop (>= 0.87.0)
     rubocop-rspec (1.43.2)
       rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
@@ -63,6 +64,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print
   bundler
   pry
   rack-graphql!

data/README.md

@@ -23,10 +23,12 @@ 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
-  health_route: true,                         # optional, true 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, `true` default
+  health_route: true,                             # optional, true by default
+  logger: A9n.logger,                            # optional, not set by default
 )
 ```
 
@@ -69,6 +71,14 @@ class GraphqlContextHandler
 end
 ```
 
+### Logging exception backtrace
+
+RackGraphql catches all errors and respond with 500 code. By default it adds exception backtrace to the response body. If you don't want to have the backtrace in the response set:
+
+```
+RackGraphql.log_exception_backtrace = false
+```
+
 ## 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/Rakefile

@@ -5,4 +5,4 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task default: %i[rubocop:auto_correct spec]
+task default: %i[spec rubocop:auto_correct]

data/lib/rack_graphql.rb

@@ -7,3 +7,11 @@ require 'rack_graphql/exceptions'
 require 'rack_graphql/health_response_builder'
 require 'rack_graphql/middleware'
 require 'rack_graphql/application'
+
+module RackGraphql
+  class << self
+    attr_accessor :log_exception_backtrace
+  end
+
+  self.log_exception_backtrace = true
+end

data/lib/rack_graphql/application.rb

@@ -1,11 +1,24 @@
 module RackGraphql
   class Application
-    def self.call(schema:, app_name: 'rack-graphql-service', logger: nil, context_handler: nil,
-      health_route: true, health_response_builder: RackGraphql::HealthResponseBuilder)
+    def self.call(
+      schema:,
+      app_name: 'rack-graphql-service',
+      logger: nil,
+      context_handler: nil,
+      log_exception_backtrace: RackGraphql.log_exception_backtrace,
+      health_route: true,
+      health_response_builder: RackGraphql::HealthResponseBuilder
+    )
 
       ::Rack::Builder.new do
         map '/graphql' do
-          run RackGraphql::Middleware.new(schema: schema, context_handler: context_handler, logger: logger)
+          run RackGraphql::Middleware.new(
+            app_name: app_name,
+            schema: schema,
+            context_handler: context_handler,
+            logger: logger,
+            log_exception_backtrace: log_exception_backtrace,
+          )
         end
 
         if health_route

data/lib/rack_graphql/middleware.rb

@@ -1,9 +1,11 @@
 module RackGraphql
   class Middleware
-    def initialize(schema:, logger: nil, context_handler: nil)
+    def initialize(schema:, app_name: nil, context_handler: nil, logger: nil, log_exception_backtrace: RackGraphql.log_exception_backtrace)
       @schema = schema
-      @logger = logger
+      @app_name = app_name
       @context_handler = context_handler || ->(_) {}
+      @logger = logger
+      @log_exception_backtrace = log_exception_backtrace
     end
 
     def call(env)
@@ -20,17 +22,40 @@ module RackGraphql
       log("Executing with params: #{params.inspect}, operationName: #{operation_name}, variables: #{variables.inspect}")
       result = execute(params: params, operation_name: operation_name, variables: variables, context: context)
 
-      [200, response_headers(result), [response_body(result)]]
+      [
+        200,
+        response_headers(result),
+        [response_body(result)]
+      ]
     rescue AmbiguousParamError => e
-      log("Responded with #{e.class} because of #{e.message}")
-      [400, { 'Content-Type' => 'application/json' }, [Oj.dump({})]]
+      exception_string = dump_exception(e)
+      log(exception_string)
+      env[Rack::RACK_ERRORS].puts(exception_string)
+      env[Rack::RACK_ERRORS].flush
+      [
+        400,
+        { 'Content-Type' => 'application/json' },
+        [Oj.dump({})]
+      ]
+    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.
+      exception_string = dump_exception(e)
+      log(exception_string)
+      env[Rack::RACK_ERRORS].puts(exception_string)
+      env[Rack::RACK_ERRORS].flush
+      [
+        500,
+        { 'Content-Type' => 'application/json' },
+        [Oj.dump('errors' => [exception_hash(e)])]
+      ]
     ensure
       ActiveRecord::Base.clear_active_connections! if defined?(ActiveRecord::Base)
     end
 
     private
 
-    attr_reader :schema, :logger, :context_handler
+    attr_reader :schema, :app_name, :logger, :context_handler, :log_exception_backtrace
 
     def post_request?(env)
       env['REQUEST_METHOD'] == 'POST'
@@ -124,5 +149,20 @@ module RackGraphql
       return unless logger
       logger.debug("[rack-graphql] #{message}")
     end
+
+    # Based on https://github.com/rack/rack/blob/master/lib/rack/show_exceptions.rb
+    def dump_exception(exception)
+      string = "#{exception.class}: #{exception.message}\n"
+      string << exception.backtrace.map { |l| "\t#{l}" }.join("\n") if log_exception_backtrace
+      string
+    end
+
+    def exception_hash(exception)
+      {
+        'source_app' => app_name,
+        'message' => "#{exception.class}: #{exception.message}",
+        'backtrace' => log_exception_backtrace ? exception.backtrace : "[FILTERED]"
+      }
+    end
   end
 end

data/lib/rack_graphql/version.rb

@@ -1,3 +1,3 @@
 module RackGraphql
-  VERSION = '1.2.5'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/rack-graphql.gemspec

@@ -24,10 +24,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.6'
 
-  spec.add_dependency 'graphql', '~> 1.9'
+  spec.add_dependency 'graphql', '~> 1.11'
   spec.add_dependency 'oj'
-  spec.add_dependency 'rack', '~> 2.0'
+  spec.add_dependency 'rack', '~> 2.2'
 
+  spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rack-test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-graphql
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 2.2.0
 platform: ruby
 authors:
 - Krzysztof Knapik
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -45,14 +45,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +196,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE